1 /*
2 * QCELP decoder
3 * Copyright (c) 2007 Reynaldo H. Verdejo Pinochet
4 *
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 /**
23 * @file
24 * QCELP decoder
25 * @author Reynaldo H. Verdejo Pinochet
26 * @remark FFmpeg merging spearheaded by Kenan Gillet
27 * @remark Development mentored by Benjamin Larson
28 */
29
30 #include <stddef.h>
31
43
45 I_F_Q = -1,
/**< insufficient frame quality */
52
57
61 float predictor_lspf[10];
/**< LSP predictor for RATE_OCTAVE and I_F_Q */
62 float pitch_synthesis_filter_mem[303];
63 float pitch_pre_filter_mem[303];
64 float rnd_fir_filter_mem[180];
65 float formant_mem[170];
73
74 /* postfilter */
75 float postfilter_synth_mem[10];
79
80 /**
81 * Initialize the speech codec according to the specification.
82 *
83 * TIA/EIA/IS-733 2.4.9
84 */
86 {
88 int i;
89
93
94 for (i = 0; i < 10; i++)
96
97 return 0;
98 }
99
100 /**
101 * Decode the 10 quantized LSP frequencies from the LSPV/LSP
102 * transmission codes of any bitrate and check for badly received packets.
103 *
104 * @param q the context
105 * @param lspf line spectral pair frequencies
106 *
107 * @return 0 on success, -1 if the packet is badly received
108 *
109 * TIA/EIA/IS-733 2.4.3.2.6.2-2, 2.4.8.7.3
110 */
112 {
113 int i;
114 float tmp_lspf, smooth, erasure_coeff;
115 const float *predictors;
116
121
124
125 for (i = 0; i < 10; i++) {
131 }
133 } else {
135
137
140
141 for (i = 0; i < 10; i++) {
143 lspf[i] = (i + 1) * (1 - erasure_coeff) / 11 +
144 erasure_coeff * predictors[i];
145 }
146 smooth = 0.125;
147 }
148
149 // Check the stability of the LSP frequencies.
151 for (i = 1; i < 10; i++)
153
155 for (i = 9; i > 0; i--)
157
158 // Low-pass filter the LSP frequencies.
160 } else {
162
163 tmp_lspf = 0.0;
164 for (i = 0; i < 5; i++) {
167 }
168
169 // Check for badly received packets.
171 if (lspf[9] <= .70 || lspf[9] >= .97)
172 return -1;
173 for (i = 3; i < 10; i++)
174 if (fabs(lspf[i] - lspf[i - 2]) < .08)
175 return -1;
176 } else {
177 if (lspf[9] <= .66 || lspf[9] >= .985)
178 return -1;
179 for (i = 4; i < 10; i++)
180 if (fabs(lspf[i] - lspf[i - 4]) < .0931)
181 return -1;
182 }
183 }
184 return 0;
185 }
186
187 /**
188 * Convert codebook transmission codes to GAIN and INDEX.
189 *
190 * @param q the context
191 * @param gain array holding the decoded gain
192 *
193 * TIA/EIA/IS-733 2.4.6.2
194 */
196 {
197 int i, subframes_count, g1[16];
198 float slope;
199
202 case RATE_FULL: subframes_count = 16;
break;
203 case RATE_HALF: subframes_count = 4;
break;
204 default: subframes_count = 5;
205 }
206 for (i = 0; i < subframes_count; i++) {
209 g1[i] += av_clip((g1[i - 1] + g1[i - 2] + g1[i - 3]) / 3 - 6, 0, 32);
210 }
211
213
215 gain[i] = -gain[i];
217 }
218 }
219
223
225 // Provide smoothing of the unvoiced excitation energy.
226 gain[7] = gain[4];
227 gain[6] = 0.4 * gain[3] + 0.6 * gain[4];
228 gain[5] = gain[3];
229 gain[4] = 0.8 * gain[2] + 0.2 * gain[3];
230 gain[3] = 0.2 * gain[1] + 0.8 * gain[2];
231 gain[2] = gain[1];
232 gain[1] = 0.6 * gain[0] + 0.4 * gain[1];
233 }
238 subframes_count = 8;
239 } else {
241
244 case 1 : break;
245 case 2 : g1[0] -= 1; break;
246 case 3 : g1[0] -= 2; break;
247 default: g1[0] -= 6;
248 }
249 if (g1[0] < 0)
250 g1[0] = 0;
251 subframes_count = 4;
252 }
253 // This interpolation is done to produce smoother background noise.
255 for (i = 1; i <= subframes_count; i++)
257
261 }
262 }
263
264 /**
265 * If the received packet is Rate 1/4 a further sanity check is made of the
266 * codebook gain.
267 *
268 * @param cbgain the unpacked cbgain array
269 * @return -1 if the sanity check fails, 0 otherwise
270 *
271 * TIA/EIA/IS-733 2.4.8.7.3
272 */
274 {
275 int i, diff, prev_diff = 0;
276
277 for (i = 1; i < 5; i++) {
278 diff = cbgain[i] - cbgain[i-1];
279 if (
FFABS(diff) > 10)
280 return -1;
281 else if (
FFABS(diff - prev_diff) > 12)
282 return -1;
283 prev_diff = diff;
284 }
285 return 0;
286 }
287
288 /**
289 * Compute the scaled codebook vector Cdn From INDEX and GAIN
290 * for all rates.
291 *
292 * The specification lacks some information here.
293 *
294 * TIA/EIA/IS-733 has an omission on the codebook index determination
295 * formula for RATE_FULL and RATE_HALF frames at section 2.4.8.1.1. It says
296 * you have to subtract the decoded index parameter from the given scaled
297 * codebook vector index 'n' to get the desired circular codebook index, but
298 * it does not mention that you have to clamp 'n' to [0-9] in order to get
299 * RI-compliant results.
300 *
301 * The reason for this mistake seems to be the fact they forgot to mention you
302 * have to do these calculations per codebook subframe and adjust given
303 * equation values accordingly.
304 *
305 * @param q the context
306 * @param gain array holding the 4 pitch subframe gain values
307 * @param cdn_vector array for the generated scaled codebook vector
308 */
310 float *cdn_vector)
311 {
312 int i, j, k;
313 uint16_t cbseed, cindex;
314 float *rnd, tmp_gain, fir_filter_value;
315
318 for (i = 0; i < 16; i++) {
321 for (j = 0; j < 10; j++)
323 }
324 break;
326 for (i = 0; i < 4; i++) {
329 for (j = 0; j < 40; j++)
331 }
332 break;
334 cbseed = (0x0003 & q->
frame.
lspv[4]) << 14 |
340 for (i = 0; i < 8; i++) {
342 for (k = 0; k < 20; k++) {
343 cbseed = 521 * cbseed + 259;
344 *rnd = (int16_t) cbseed;
345
346 // FIR filter
347 fir_filter_value = 0.0;
348 for (j = 0; j < 10; j++)
350 (rnd[-j] + rnd[-20+j]);
351
353 *cdn_vector++ = tmp_gain * fir_filter_value;
354 rnd++;
355 }
356 }
358 20 * sizeof(float));
359 break;
362 for (i = 0; i < 8; i++) {
364 for (j = 0; j < 20; j++) {
365 cbseed = 521 * cbseed + 259;
366 *cdn_vector++ = tmp_gain * (int16_t) cbseed;
367 }
368 }
369 break;
371 cbseed = -44; // random codebook index
372 for (i = 0; i < 4; i++) {
374 for (j = 0; j < 40; j++)
376 }
377 break;
379 memset(cdn_vector, 0, 160 * sizeof(float));
380 break;
381 }
382 }
383
384 /**
385 * Apply generic gain control.
386 *
387 * @param v_out output vector
388 * @param v_in gain-controlled vector
389 * @param v_ref vector to control gain of
390 *
391 * TIA/EIA/IS-733 2.4.8.3, 2.4.8.6
392 */
394 {
395 int i;
396
397 for (i = 0; i < 160; i += 40) {
400 }
401 }
402
403 /**
404 * Apply filter in pitch-subframe steps.
405 *
406 * @param memory buffer for the previous state of the filter
407 * - must be able to contain 303 elements
408 * - the 143 first elements are from the previous state
409 * - the next 160 are for output
410 * @param v_in input filter vector
411 * @param gain per-subframe gain array, each element is between 0.0 and 2.0
412 * @param lag per-subframe lag array, each element is
413 * - between 16 and 143 if its corresponding pfrac is 0,
414 * - between 16 and 139 otherwise
415 * @param pfrac per-subframe boolean array, 1 if the lag is fractional, 0
416 * otherwise
417 *
418 * @return filter output vector
419 */
421 const float gain[4],
const uint8_t *lag,
423 {
424 int i, j;
425 float *v_lag, *v_out;
426 const float *v_len;
427
428 v_out = memory + 143; // Output vector starts at memory[143].
429
430 for (i = 0; i < 4; i++) {
431 if (gain[i]) {
432 v_lag = memory + 143 + 40 * i - lag[i];
433 for (v_len = v_in + 40; v_in < v_len; v_in++) {
434 if (pfrac[i]) { // If it is a fractional lag...
435 for (j = 0, *v_out = 0.0; j < 4; j++)
437 } else
438 *v_out = *v_lag;
439
440 *v_out = *v_in + gain[i] * *v_out;
441
442 v_lag++;
443 v_out++;
444 }
445 } else {
446 memcpy(v_out, v_in, 40 * sizeof(float));
447 v_in += 40;
448 v_out += 40;
449 }
450 }
451
452 memmove(memory, memory + 160, 143 * sizeof(float));
453 return memory + 143;
454 }
455
456 /**
457 * Apply pitch synthesis filter and pitch prefilter to the scaled codebook vector.
458 * TIA/EIA/IS-733 2.4.5.2, 2.4.8.7.2
459 *
460 * @param q the context
461 * @param cdn_vector the scaled codebook vector
462 */
464 {
465 int i;
466 const float *v_synthesis_filtered, *v_pre_filtered;
467
470
472 // Compute gain & lag for the whole frame.
473 for (i = 0; i < 4; i++) {
475
477 }
478 } else {
479 float max_pitch_gain;
480
484 else
485 max_pitch_gain = 0.0;
486 } else {
488 max_pitch_gain = 1.0;
489 }
490 for (i = 0; i < 4; i++)
492
494 }
495
496 // pitch synthesis filter
500
501 // pitch prefilter update
502 for (i = 0; i < 4; i++)
504
506 v_synthesis_filtered,
509
511 } else {
516 }
517 }
518
519 /**
520 * Reconstruct LPC coefficients from the line spectral pair frequencies
521 * and perform bandwidth expansion.
522 *
523 * @param lspf line spectral pair frequencies
524 * @param lpc linear predictive coding coefficients
525 *
526 * @note: bandwidth_expansion_coeff could be precalculated into a table
527 * but it seems to be slower on x86
528 *
529 * TIA/EIA/IS-733 2.4.3.3.5
530 */
531 static void lspf2lpc(
const float *lspf,
float *lpc)
532 {
533 double lsp[10];
535 int i;
536
537 for (i = 0; i < 10; i++)
538 lsp[i] = cos(
M_PI * lspf[i]);
539
541
542 for (i = 0; i < 10; i++) {
543 lpc[i] *= bandwidth_expansion_coeff;
545 }
546 }
547
548 /**
549 * Interpolate LSP frequencies and compute LPC coefficients
550 * for a given bitrate & pitch subframe.
551 *
552 * TIA/EIA/IS-733 2.4.3.3.4, 2.4.8.7.2
553 *
554 * @param q the context
555 * @param curr_lspf LSP frequencies vector of the current frame
556 * @param lpc float vector for the resulting LPC
557 * @param subframe_num frame number in decoded stream
558 */
560 float *lpc, const int subframe_num)
561 {
562 float interpolated_lspf[10];
564
566 weight = 0.25 * (subframe_num + 1);
568 weight = 0.625;
569 else
570 weight = 1.0;
571
572 if (weight != 1.0) {
574 weight, 1.0 - weight, 10);
581 }
582
584 {
585 switch (buf_size) {
591 }
592
594 }
595
596 /**
597 * Determine the bitrate from the frame size and/or the first byte of the frame.
598 *
599 * @param avctx the AV codec context
600 * @param buf_size length of the buffer
601 * @param buf the bufffer
602 *
603 * @return the bitrate on success,
604 * I_F_Q if the bitrate cannot be satisfactorily determined
605 *
606 * TIA/EIA/IS-733 2.4.8.7.1
607 */
609 const int buf_size,
611 {
613
615 if (bitrate > **buf) {
619 "Claimed bitrate and buffer size mismatch.\n");
621 }
623 } else if (bitrate < **buf) {
625 "Buffer is too small for the claimed bitrate.\n");
627 }
628 (*buf)++;
631 "Bitrate byte is missing, guessing the bitrate from packet size.\n");
632 } else
634
636 // FIXME: Remove this warning when tested with samples.
638 }
639 return bitrate;
640 }
641
643 const char *message)
644 {
647 }
648
650 {
651 static const float pow_0_775[10] = {
652 0.775000, 0.600625, 0.465484, 0.360750, 0.279582,
653 0.216676, 0.167924, 0.130141, 0.100859, 0.078166
654 }, pow_0_625[10] = {
655 0.625000, 0.390625, 0.244141, 0.152588, 0.095367,
656 0.059605, 0.037253, 0.023283, 0.014552, 0.009095
657 };
658 float lpc_s[10], lpc_p[10], pole_out[170], zero_out[160];
660
661 for (n = 0; n < 10; n++) {
662 lpc_s[
n] = lpc[
n] * pow_0_625[
n];
663 lpc_p[
n] = lpc[
n] * pow_0_775[
n];
664 }
665
671
673
677 160),
679 }
680
682 int *got_frame_ptr,
AVPacket *avpkt)
683 {
685 int buf_size = avpkt->
size;
688 float *outbuffer;
690 float quantized_lspf[10], lpc[10];
691 float gain[16];
692 float *formant_mem;
693
694 /* get output buffer */
698 outbuffer = (
float *)frame->
data[0];
699
702 goto erasure;
703 }
704
708 goto erasure;
709 }
710
716
718
720
721 for (; bitmaps < bitmaps_end; bitmaps++)
723
724 // Check for erasures/blanks on rates 1, 1/4 and 1/8.
727 goto erasure;
728 }
732 goto erasure;
733 }
734
736 for (i = 0; i < 4; i++) {
739 goto erasure;
740 }
741 }
742 }
743 }
744
747
750 goto erasure;
751 }
752
754
756 erasure:
763 } else
765
767 for (i = 0; i < 4; i++) {
770 formant_mem += 40;
771 }
772
773 // postfilter, as per TIA/EIA/IS-733 2.4.8.6
775
777
780
781 *got_frame_ptr = 1;
782
783 return buf_size;
784 }
785
795 };