f57ec4fd2a1bb88b190f8f825c1c00110b639dcd
[ffmpeg.git] / libavcodec / sipr.c
1 /*
2  * SIPR / ACELP.NET decoder
3  *
4  * Copyright (c) 2008 Vladimir Voroshilov
5  * Copyright (c) 2009 Vitor Sessak
6  *
7  * This file is part of Libav.
8  *
9  * Libav is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * Libav is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with Libav; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23
24 #include <math.h>
25 #include <stdint.h>
26 #include <string.h>
27
28 #include "libavutil/mathematics.h"
29 #include "avcodec.h"
30 #define ALT_BITSTREAM_READER_LE
31 #include "get_bits.h"
32 #include "dsputil.h"
33
34 #include "lsp.h"
35 #include "celp_math.h"
36 #include "acelp_vectors.h"
37 #include "acelp_pitch_delay.h"
38 #include "acelp_filters.h"
39 #include "celp_filters.h"
40
41 #define MAX_SUBFRAME_COUNT   5
42
43 #include "sipr.h"
44 #include "siprdata.h"
45
46 typedef struct {
47     const char *mode_name;
48     uint16_t bits_per_frame;
49     uint8_t subframe_count;
50     uint8_t frames_per_packet;
51     float pitch_sharp_factor;
52
53     /* bitstream parameters */
54     uint8_t number_of_fc_indexes;
55     uint8_t ma_predictor_bits;  ///< size in bits of the switched MA predictor
56
57     /** size in bits of the i-th stage vector of quantizer */
58     uint8_t vq_indexes_bits[5];
59
60     /** size in bits of the adaptive-codebook index for every subframe */
61     uint8_t pitch_delay_bits[5];
62
63     uint8_t gp_index_bits;
64     uint8_t fc_index_bits[10]; ///< size in bits of the fixed codebook indexes
65     uint8_t gc_index_bits;     ///< size in bits of the gain  codebook indexes
66 } SiprModeParam;
67
68 static const SiprModeParam modes[MODE_COUNT] = {
69     [MODE_16k] = {
70         .mode_name          = "16k",
71         .bits_per_frame     = 160,
72         .subframe_count     = SUBFRAME_COUNT_16k,
73         .frames_per_packet  = 1,
74         .pitch_sharp_factor = 0.00,
75
76         .number_of_fc_indexes = 10,
77         .ma_predictor_bits    = 1,
78         .vq_indexes_bits      = {7, 8, 7, 7, 7},
79         .pitch_delay_bits     = {9, 6},
80         .gp_index_bits        = 4,
81         .fc_index_bits        = {4, 5, 4, 5, 4, 5, 4, 5, 4, 5},
82         .gc_index_bits        = 5
83     },
84
85     [MODE_8k5] = {
86         .mode_name          = "8k5",
87         .bits_per_frame     = 152,
88         .subframe_count     = 3,
89         .frames_per_packet  = 1,
90         .pitch_sharp_factor = 0.8,
91
92         .number_of_fc_indexes = 3,
93         .ma_predictor_bits    = 0,
94         .vq_indexes_bits      = {6, 7, 7, 7, 5},
95         .pitch_delay_bits     = {8, 5, 5},
96         .gp_index_bits        = 0,
97         .fc_index_bits        = {9, 9, 9},
98         .gc_index_bits        = 7
99     },
100
101     [MODE_6k5] = {
102         .mode_name          = "6k5",
103         .bits_per_frame     = 232,
104         .subframe_count     = 3,
105         .frames_per_packet  = 2,
106         .pitch_sharp_factor = 0.8,
107
108         .number_of_fc_indexes = 3,
109         .ma_predictor_bits    = 0,
110         .vq_indexes_bits      = {6, 7, 7, 7, 5},
111         .pitch_delay_bits     = {8, 5, 5},
112         .gp_index_bits        = 0,
113         .fc_index_bits        = {5, 5, 5},
114         .gc_index_bits        = 7
115     },
116
117     [MODE_5k0] = {
118         .mode_name          = "5k0",
119         .bits_per_frame     = 296,
120         .subframe_count     = 5,
121         .frames_per_packet  = 2,
122         .pitch_sharp_factor = 0.85,
123
124         .number_of_fc_indexes = 1,
125         .ma_predictor_bits    = 0,
126         .vq_indexes_bits      = {6, 7, 7, 7, 5},
127         .pitch_delay_bits     = {8, 5, 8, 5, 5},
128         .gp_index_bits        = 0,
129         .fc_index_bits        = {10},
130         .gc_index_bits        = 7
131     }
132 };
133
134 const float ff_pow_0_5[] = {
135     1.0/(1 <<  1), 1.0/(1 <<  2), 1.0/(1 <<  3), 1.0/(1 <<  4),
136     1.0/(1 <<  5), 1.0/(1 <<  6), 1.0/(1 <<  7), 1.0/(1 <<  8),
137     1.0/(1 <<  9), 1.0/(1 << 10), 1.0/(1 << 11), 1.0/(1 << 12),
138     1.0/(1 << 13), 1.0/(1 << 14), 1.0/(1 << 15), 1.0/(1 << 16)
139 };
140
141 static void dequant(float *out, const int *idx, const float *cbs[])
142 {
143     int i;
144     int stride  = 2;
145     int num_vec = 5;
146
147     for (i = 0; i < num_vec; i++)
148         memcpy(out + stride*i, cbs[i] + stride*idx[i], stride*sizeof(float));
149
150 }
151
152 static void lsf_decode_fp(float *lsfnew, float *lsf_history,
153                           const SiprParameters *parm)
154 {
155     int i;
156     float lsf_tmp[LP_FILTER_ORDER];
157
158     dequant(lsf_tmp, parm->vq_indexes, lsf_codebooks);
159
160     for (i = 0; i < LP_FILTER_ORDER; i++)
161         lsfnew[i] = lsf_history[i] * 0.33 + lsf_tmp[i] + mean_lsf[i];
162
163     ff_sort_nearly_sorted_floats(lsfnew, LP_FILTER_ORDER - 1);
164
165     /* Note that a minimum distance is not enforced between the last value and
166        the previous one, contrary to what is done in ff_acelp_reorder_lsf() */
167     ff_set_min_dist_lsf(lsfnew, LSFQ_DIFF_MIN, LP_FILTER_ORDER - 1);
168     lsfnew[9] = FFMIN(lsfnew[LP_FILTER_ORDER - 1], 1.3 * M_PI);
169
170     memcpy(lsf_history, lsf_tmp, LP_FILTER_ORDER * sizeof(*lsf_history));
171
172     for (i = 0; i < LP_FILTER_ORDER - 1; i++)
173         lsfnew[i] = cos(lsfnew[i]);
174     lsfnew[LP_FILTER_ORDER - 1] *= 6.153848 / M_PI;
175 }
176
177 /** Apply pitch lag to the fixed vector (AMR section 6.1.2). */
178 static void pitch_sharpening(int pitch_lag_int, float beta,
179                              float *fixed_vector)
180 {
181     int i;
182
183     for (i = pitch_lag_int; i < SUBFR_SIZE; i++)
184         fixed_vector[i] += beta * fixed_vector[i - pitch_lag_int];
185 }
186
187 /**
188  * Extract decoding parameters from the input bitstream.
189  * @param parms          parameters structure
190  * @param pgb            pointer to initialized GetBitContext structure
191  */
192 static void decode_parameters(SiprParameters* parms, GetBitContext *pgb,
193                               const SiprModeParam *p)
194 {
195     int i, j;
196
197     parms->ma_pred_switch           = get_bits(pgb, p->ma_predictor_bits);
198
199     for (i = 0; i < 5; i++)
200         parms->vq_indexes[i]        = get_bits(pgb, p->vq_indexes_bits[i]);
201
202     for (i = 0; i < p->subframe_count; i++) {
203         parms->pitch_delay[i]       = get_bits(pgb, p->pitch_delay_bits[i]);
204         parms->gp_index[i]          = get_bits(pgb, p->gp_index_bits);
205
206         for (j = 0; j < p->number_of_fc_indexes; j++)
207             parms->fc_indexes[i][j] = get_bits(pgb, p->fc_index_bits[j]);
208
209         parms->gc_index[i]          = get_bits(pgb, p->gc_index_bits);
210     }
211 }
212
213 static void sipr_decode_lp(float *lsfnew, const float *lsfold, float *Az,
214                            int num_subfr)
215 {
216     double lsfint[LP_FILTER_ORDER];
217     int i,j;
218     float t, t0 = 1.0 / num_subfr;
219
220     t = t0 * 0.5;
221     for (i = 0; i < num_subfr; i++) {
222         for (j = 0; j < LP_FILTER_ORDER; j++)
223             lsfint[j] = lsfold[j] * (1 - t) + t * lsfnew[j];
224
225         ff_amrwb_lsp2lpc(lsfint, Az, LP_FILTER_ORDER);
226         Az += LP_FILTER_ORDER;
227         t += t0;
228     }
229 }
230
231 /**
232  * Evaluate the adaptive impulse response.
233  */
234 static void eval_ir(const float *Az, int pitch_lag, float *freq,
235                     float pitch_sharp_factor)
236 {
237     float tmp1[SUBFR_SIZE+1], tmp2[LP_FILTER_ORDER+1];
238     int i;
239
240     tmp1[0] = 1.;
241     for (i = 0; i < LP_FILTER_ORDER; i++) {
242         tmp1[i+1] = Az[i] * ff_pow_0_55[i];
243         tmp2[i  ] = Az[i] * ff_pow_0_7 [i];
244     }
245     memset(tmp1 + 11, 0, 37 * sizeof(float));
246
247     ff_celp_lp_synthesis_filterf(freq, tmp2, tmp1, SUBFR_SIZE,
248                                  LP_FILTER_ORDER);
249
250     pitch_sharpening(pitch_lag, pitch_sharp_factor, freq);
251 }
252
253 /**
254  * Evaluate the convolution of a vector with a sparse vector.
255  */
256 static void convolute_with_sparse(float *out, const AMRFixed *pulses,
257                                   const float *shape, int length)
258 {
259     int i, j;
260
261     memset(out, 0, length*sizeof(float));
262     for (i = 0; i < pulses->n; i++)
263         for (j = pulses->x[i]; j < length; j++)
264             out[j] += pulses->y[i] * shape[j - pulses->x[i]];
265 }
266
267 /**
268  * Apply postfilter, very similar to AMR one.
269  */
270 static void postfilter_5k0(SiprContext *ctx, const float *lpc, float *samples)
271 {
272     float buf[SUBFR_SIZE + LP_FILTER_ORDER];
273     float *pole_out = buf + LP_FILTER_ORDER;
274     float lpc_n[LP_FILTER_ORDER];
275     float lpc_d[LP_FILTER_ORDER];
276     int i;
277
278     for (i = 0; i < LP_FILTER_ORDER; i++) {
279         lpc_d[i] = lpc[i] * ff_pow_0_75[i];
280         lpc_n[i] = lpc[i] * ff_pow_0_5 [i];
281     };
282
283     memcpy(pole_out - LP_FILTER_ORDER, ctx->postfilter_mem,
284            LP_FILTER_ORDER*sizeof(float));
285
286     ff_celp_lp_synthesis_filterf(pole_out, lpc_d, samples, SUBFR_SIZE,
287                                  LP_FILTER_ORDER);
288
289     memcpy(ctx->postfilter_mem, pole_out + SUBFR_SIZE - LP_FILTER_ORDER,
290            LP_FILTER_ORDER*sizeof(float));
291
292     ff_tilt_compensation(&ctx->tilt_mem, 0.4, pole_out, SUBFR_SIZE);
293
294     memcpy(pole_out - LP_FILTER_ORDER, ctx->postfilter_mem5k0,
295            LP_FILTER_ORDER*sizeof(*pole_out));
296
297     memcpy(ctx->postfilter_mem5k0, pole_out + SUBFR_SIZE - LP_FILTER_ORDER,
298            LP_FILTER_ORDER*sizeof(*pole_out));
299
300     ff_celp_lp_zero_synthesis_filterf(samples, lpc_n, pole_out, SUBFR_SIZE,
301                                       LP_FILTER_ORDER);
302
303 }
304
305 static void decode_fixed_sparse(AMRFixed *fixed_sparse, const int16_t *pulses,
306                                 SiprMode mode, int low_gain)
307 {
308     int i;
309
310     switch (mode) {
311     case MODE_6k5:
312         for (i = 0; i < 3; i++) {
313             fixed_sparse->x[i] = 3 * (pulses[i] & 0xf) + i;
314             fixed_sparse->y[i] = pulses[i] & 0x10 ? -1 : 1;
315         }
316         fixed_sparse->n = 3;
317         break;
318     case MODE_8k5:
319         for (i = 0; i < 3; i++) {
320             fixed_sparse->x[2*i    ] = 3 * ((pulses[i] >> 4) & 0xf) + i;
321             fixed_sparse->x[2*i + 1] = 3 * ( pulses[i]       & 0xf) + i;
322
323             fixed_sparse->y[2*i    ] = (pulses[i] & 0x100) ? -1.0: 1.0;
324
325             fixed_sparse->y[2*i + 1] =
326                 (fixed_sparse->x[2*i + 1] < fixed_sparse->x[2*i]) ?
327                 -fixed_sparse->y[2*i    ] : fixed_sparse->y[2*i];
328         }
329
330         fixed_sparse->n = 6;
331         break;
332     case MODE_5k0:
333     default:
334         if (low_gain) {
335             int offset = (pulses[0] & 0x200) ? 2 : 0;
336             int val = pulses[0];
337
338             for (i = 0; i < 3; i++) {
339                 int index = (val & 0x7) * 6 + 4 - i*2;
340
341                 fixed_sparse->y[i] = (offset + index) & 0x3 ? -1 : 1;
342                 fixed_sparse->x[i] = index;
343
344                 val >>= 3;
345             }
346             fixed_sparse->n = 3;
347         } else {
348             int pulse_subset = (pulses[0] >> 8) & 1;
349
350             fixed_sparse->x[0] = ((pulses[0] >> 4) & 15) * 3 + pulse_subset;
351             fixed_sparse->x[1] = ( pulses[0]       & 15) * 3 + pulse_subset + 1;
352
353             fixed_sparse->y[0] = pulses[0] & 0x200 ? -1 : 1;
354             fixed_sparse->y[1] = -fixed_sparse->y[0];
355             fixed_sparse->n = 2;
356         }
357         break;
358     }
359 }
360
361 static void decode_frame(SiprContext *ctx, SiprParameters *params,
362                          float *out_data)
363 {
364     int i, j;
365     int subframe_count = modes[ctx->mode].subframe_count;
366     int frame_size = subframe_count * SUBFR_SIZE;
367     float Az[LP_FILTER_ORDER * MAX_SUBFRAME_COUNT];
368     float *excitation;
369     float ir_buf[SUBFR_SIZE + LP_FILTER_ORDER];
370     float lsf_new[LP_FILTER_ORDER];
371     float *impulse_response = ir_buf + LP_FILTER_ORDER;
372     float *synth = ctx->synth_buf + 16; // 16 instead of LP_FILTER_ORDER for
373                                         // memory alignment
374     int t0_first = 0;
375     AMRFixed fixed_cb;
376
377     memset(ir_buf, 0, LP_FILTER_ORDER * sizeof(float));
378     lsf_decode_fp(lsf_new, ctx->lsf_history, params);
379
380     sipr_decode_lp(lsf_new, ctx->lsp_history, Az, subframe_count);
381
382     memcpy(ctx->lsp_history, lsf_new, LP_FILTER_ORDER * sizeof(float));
383
384     excitation = ctx->excitation + PITCH_DELAY_MAX + L_INTERPOL;
385
386     for (i = 0; i < subframe_count; i++) {
387         float *pAz = Az + i*LP_FILTER_ORDER;
388         float fixed_vector[SUBFR_SIZE];
389         int T0,T0_frac;
390         float pitch_gain, gain_code, avg_energy;
391
392         ff_decode_pitch_lag(&T0, &T0_frac, params->pitch_delay[i], t0_first, i,
393                             ctx->mode == MODE_5k0, 6);
394
395         if (i == 0 || (i == 2 && ctx->mode == MODE_5k0))
396             t0_first = T0;
397
398         ff_acelp_interpolatef(excitation, excitation - T0 + (T0_frac <= 0),
399                               ff_b60_sinc, 6,
400                               2 * ((2 + T0_frac)%3 + 1), LP_FILTER_ORDER,
401                               SUBFR_SIZE);
402
403         decode_fixed_sparse(&fixed_cb, params->fc_indexes[i], ctx->mode,
404                             ctx->past_pitch_gain < 0.8);
405
406         eval_ir(pAz, T0, impulse_response, modes[ctx->mode].pitch_sharp_factor);
407
408         convolute_with_sparse(fixed_vector, &fixed_cb, impulse_response,
409                               SUBFR_SIZE);
410
411         avg_energy =
412             (0.01 + ff_dot_productf(fixed_vector, fixed_vector, SUBFR_SIZE))/
413                 SUBFR_SIZE;
414
415         ctx->past_pitch_gain = pitch_gain = gain_cb[params->gc_index[i]][0];
416
417         gain_code = ff_amr_set_fixed_gain(gain_cb[params->gc_index[i]][1],
418                                           avg_energy, ctx->energy_history,
419                                           34 - 15.0/(0.05*M_LN10/M_LN2),
420                                           pred);
421
422         ff_weighted_vector_sumf(excitation, excitation, fixed_vector,
423                                 pitch_gain, gain_code, SUBFR_SIZE);
424
425         pitch_gain *= 0.5 * pitch_gain;
426         pitch_gain = FFMIN(pitch_gain, 0.4);
427
428         ctx->gain_mem = 0.7 * ctx->gain_mem + 0.3 * pitch_gain;
429         ctx->gain_mem = FFMIN(ctx->gain_mem, pitch_gain);
430         gain_code *= ctx->gain_mem;
431
432         for (j = 0; j < SUBFR_SIZE; j++)
433             fixed_vector[j] = excitation[j] - gain_code * fixed_vector[j];
434
435         if (ctx->mode == MODE_5k0) {
436             postfilter_5k0(ctx, pAz, fixed_vector);
437
438             ff_celp_lp_synthesis_filterf(ctx->postfilter_syn5k0 + LP_FILTER_ORDER + i*SUBFR_SIZE,
439                                          pAz, excitation, SUBFR_SIZE,
440                                          LP_FILTER_ORDER);
441         }
442
443         ff_celp_lp_synthesis_filterf(synth + i*SUBFR_SIZE, pAz, fixed_vector,
444                                      SUBFR_SIZE, LP_FILTER_ORDER);
445
446         excitation += SUBFR_SIZE;
447     }
448
449     memcpy(synth - LP_FILTER_ORDER, synth + frame_size - LP_FILTER_ORDER,
450            LP_FILTER_ORDER * sizeof(float));
451
452     if (ctx->mode == MODE_5k0) {
453         for (i = 0; i < subframe_count; i++) {
454             float energy = ff_dot_productf(ctx->postfilter_syn5k0 + LP_FILTER_ORDER + i*SUBFR_SIZE,
455                                            ctx->postfilter_syn5k0 + LP_FILTER_ORDER + i*SUBFR_SIZE,
456                                            SUBFR_SIZE);
457             ff_adaptive_gain_control(&synth[i * SUBFR_SIZE],
458                                      &synth[i * SUBFR_SIZE], energy,
459                                      SUBFR_SIZE, 0.9, &ctx->postfilter_agc);
460         }
461
462         memcpy(ctx->postfilter_syn5k0, ctx->postfilter_syn5k0 + frame_size,
463                LP_FILTER_ORDER*sizeof(float));
464     }
465     memmove(ctx->excitation, excitation - PITCH_DELAY_MAX - L_INTERPOL,
466            (PITCH_DELAY_MAX + L_INTERPOL) * sizeof(float));
467
468     ff_acelp_apply_order_2_transfer_function(out_data, synth,
469                                              (const float[2]) {-1.99997   , 1.000000000},
470                                              (const float[2]) {-1.93307352, 0.935891986},
471                                              0.939805806,
472                                              ctx->highpass_filt_mem,
473                                              frame_size);
474 }
475
476 static av_cold int sipr_decoder_init(AVCodecContext * avctx)
477 {
478     SiprContext *ctx = avctx->priv_data;
479     int i;
480
481     if      (avctx->bit_rate > 12200) ctx->mode = MODE_16k;
482     else if (avctx->bit_rate > 7500 ) ctx->mode = MODE_8k5;
483     else if (avctx->bit_rate > 5750 ) ctx->mode = MODE_6k5;
484     else                              ctx->mode = MODE_5k0;
485
486     av_log(avctx, AV_LOG_DEBUG, "Mode: %s\n", modes[ctx->mode].mode_name);
487
488     if (ctx->mode == MODE_16k)
489         ff_sipr_init_16k(ctx);
490
491     for (i = 0; i < LP_FILTER_ORDER; i++)
492         ctx->lsp_history[i] = cos((i+1) * M_PI / (LP_FILTER_ORDER + 1));
493
494     for (i = 0; i < 4; i++)
495         ctx->energy_history[i] = -14;
496
497     avctx->sample_fmt = AV_SAMPLE_FMT_FLT;
498
499     return 0;
500 }
501
502 static int sipr_decode_frame(AVCodecContext *avctx, void *datap,
503                              int *data_size, AVPacket *avpkt)
504 {
505     SiprContext *ctx = avctx->priv_data;
506     const uint8_t *buf=avpkt->data;
507     SiprParameters parm;
508     const SiprModeParam *mode_par = &modes[ctx->mode];
509     GetBitContext gb;
510     float *data = datap;
511     int subframe_size = ctx->mode == MODE_16k ? L_SUBFR_16k : SUBFR_SIZE;
512     int i, out_size;
513
514     ctx->avctx = avctx;
515     if (avpkt->size < (mode_par->bits_per_frame >> 3)) {
516         av_log(avctx, AV_LOG_ERROR,
517                "Error processing packet: packet size (%d) too small\n",
518                avpkt->size);
519
520         *data_size = 0;
521         return -1;
522     }
523
524     out_size = mode_par->frames_per_packet * subframe_size *
525                mode_par->subframe_count *
526                av_get_bytes_per_sample(avctx->sample_fmt);
527     if (*data_size < out_size) {
528         av_log(avctx, AV_LOG_ERROR,
529                "Error processing packet: output buffer (%d) too small\n",
530                *data_size);
531
532         *data_size = 0;
533         return -1;
534     }
535
536     init_get_bits(&gb, buf, mode_par->bits_per_frame);
537
538     for (i = 0; i < mode_par->frames_per_packet; i++) {
539         decode_parameters(&parm, &gb, mode_par);
540
541         if (ctx->mode == MODE_16k)
542             ff_sipr_decode_frame_16k(ctx, &parm, data);
543         else
544             decode_frame(ctx, &parm, data);
545
546         data += subframe_size * mode_par->subframe_count;
547     }
548
549     *data_size = out_size;
550
551     return mode_par->bits_per_frame >> 3;
552 }
553
554 AVCodec ff_sipr_decoder = {
555     .name           = "sipr",
556     .type           = AVMEDIA_TYPE_AUDIO,
557     .id             = CODEC_ID_SIPR,
558     .priv_data_size = sizeof(SiprContext),
559     .init           = sipr_decoder_init,
560     .decode         = sipr_decode_frame,
561     .long_name = NULL_IF_CONFIG_SMALL("RealAudio SIPR / ACELP.NET"),
562 };