ra144enc: remove unneeded sample_fmt check
[ffmpeg.git] / libavcodec / ra144enc.c
1 /*
2  * Real Audio 1.0 (14.4K) encoder
3  * Copyright (c) 2010 Francesco Lavra <francescolavra@interfree.it>
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; 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  * Real Audio 1.0 (14.4K) encoder
25  * @author Francesco Lavra <francescolavra@interfree.it>
26  */
27
28 #include <float.h>
29
30 #include "avcodec.h"
31 #include "put_bits.h"
32 #include "celp_filters.h"
33 #include "ra144.h"
34
35
36 static av_cold int ra144_encode_init(AVCodecContext * avctx)
37 {
38     RA144Context *ractx;
39     int ret;
40
41     if (avctx->channels != 1) {
42         av_log(avctx, AV_LOG_ERROR, "invalid number of channels: %d\n",
43                avctx->channels);
44         return -1;
45     }
46     avctx->frame_size = NBLOCKS * BLOCKSIZE;
47     avctx->bit_rate = 8000;
48     ractx = avctx->priv_data;
49     ractx->lpc_coef[0] = ractx->lpc_tables[0];
50     ractx->lpc_coef[1] = ractx->lpc_tables[1];
51     ractx->avctx = avctx;
52     ret = ff_lpc_init(&ractx->lpc_ctx, avctx->frame_size, LPC_ORDER,
53                       FF_LPC_TYPE_LEVINSON);
54     return ret;
55 }
56
57
58 static av_cold int ra144_encode_close(AVCodecContext *avctx)
59 {
60     RA144Context *ractx = avctx->priv_data;
61     ff_lpc_end(&ractx->lpc_ctx);
62     return 0;
63 }
64
65
66 /**
67  * Quantize a value by searching a sorted table for the element with the
68  * nearest value
69  *
70  * @param value value to quantize
71  * @param table array containing the quantization table
72  * @param size size of the quantization table
73  * @return index of the quantization table corresponding to the element with the
74  *         nearest value
75  */
76 static int quantize(int value, const int16_t *table, unsigned int size)
77 {
78     unsigned int low = 0, high = size - 1;
79
80     while (1) {
81         int index = (low + high) >> 1;
82         int error = table[index] - value;
83
84         if (index == low)
85             return table[high] + error > value ? low : high;
86         if (error > 0) {
87             high = index;
88         } else {
89             low = index;
90         }
91     }
92 }
93
94
95 /**
96  * Orthogonalize a vector to another vector
97  *
98  * @param v vector to orthogonalize
99  * @param u vector against which orthogonalization is performed
100  */
101 static void orthogonalize(float *v, const float *u)
102 {
103     int i;
104     float num = 0, den = 0;
105
106     for (i = 0; i < BLOCKSIZE; i++) {
107         num += v[i] * u[i];
108         den += u[i] * u[i];
109     }
110     num /= den;
111     for (i = 0; i < BLOCKSIZE; i++)
112         v[i] -= num * u[i];
113 }
114
115
116 /**
117  * Calculate match score and gain of an LPC-filtered vector with respect to
118  * input data, possibly othogonalizing it to up to 2 other vectors
119  *
120  * @param work array used to calculate the filtered vector
121  * @param coefs coefficients of the LPC filter
122  * @param vect original vector
123  * @param ortho1 first vector against which orthogonalization is performed
124  * @param ortho2 second vector against which orthogonalization is performed
125  * @param data input data
126  * @param score pointer to variable where match score is returned
127  * @param gain pointer to variable where gain is returned
128  */
129 static void get_match_score(float *work, const float *coefs, float *vect,
130                             const float *ortho1, const float *ortho2,
131                             const float *data, float *score, float *gain)
132 {
133     float c, g;
134     int i;
135
136     ff_celp_lp_synthesis_filterf(work, coefs, vect, BLOCKSIZE, LPC_ORDER);
137     if (ortho1)
138         orthogonalize(work, ortho1);
139     if (ortho2)
140         orthogonalize(work, ortho2);
141     c = g = 0;
142     for (i = 0; i < BLOCKSIZE; i++) {
143         g += work[i] * work[i];
144         c += data[i] * work[i];
145     }
146     if (c <= 0) {
147         *score = 0;
148         return;
149     }
150     *gain = c / g;
151     *score = *gain * c;
152 }
153
154
155 /**
156  * Create a vector from the adaptive codebook at a given lag value
157  *
158  * @param vect array where vector is stored
159  * @param cb adaptive codebook
160  * @param lag lag value
161  */
162 static void create_adapt_vect(float *vect, const int16_t *cb, int lag)
163 {
164     int i;
165
166     cb += BUFFERSIZE - lag;
167     for (i = 0; i < FFMIN(BLOCKSIZE, lag); i++)
168         vect[i] = cb[i];
169     if (lag < BLOCKSIZE)
170         for (i = 0; i < BLOCKSIZE - lag; i++)
171             vect[lag + i] = cb[i];
172 }
173
174
175 /**
176  * Search the adaptive codebook for the best entry and gain and remove its
177  * contribution from input data
178  *
179  * @param adapt_cb array from which the adaptive codebook is extracted
180  * @param work array used to calculate LPC-filtered vectors
181  * @param coefs coefficients of the LPC filter
182  * @param data input data
183  * @return index of the best entry of the adaptive codebook
184  */
185 static int adaptive_cb_search(const int16_t *adapt_cb, float *work,
186                               const float *coefs, float *data)
187 {
188     int i, best_vect;
189     float score, gain, best_score, best_gain;
190     float exc[BLOCKSIZE];
191
192     gain = best_score = 0;
193     for (i = BLOCKSIZE / 2; i <= BUFFERSIZE; i++) {
194         create_adapt_vect(exc, adapt_cb, i);
195         get_match_score(work, coefs, exc, NULL, NULL, data, &score, &gain);
196         if (score > best_score) {
197             best_score = score;
198             best_vect = i;
199             best_gain = gain;
200         }
201     }
202     if (!best_score)
203         return 0;
204
205     /**
206      * Re-calculate the filtered vector from the vector with maximum match score
207      * and remove its contribution from input data.
208      */
209     create_adapt_vect(exc, adapt_cb, best_vect);
210     ff_celp_lp_synthesis_filterf(work, coefs, exc, BLOCKSIZE, LPC_ORDER);
211     for (i = 0; i < BLOCKSIZE; i++)
212         data[i] -= best_gain * work[i];
213     return best_vect - BLOCKSIZE / 2 + 1;
214 }
215
216
217 /**
218  * Find the best vector of a fixed codebook by applying an LPC filter to
219  * codebook entries, possibly othogonalizing them to up to 2 other vectors and
220  * matching the results with input data
221  *
222  * @param work array used to calculate the filtered vectors
223  * @param coefs coefficients of the LPC filter
224  * @param cb fixed codebook
225  * @param ortho1 first vector against which orthogonalization is performed
226  * @param ortho2 second vector against which orthogonalization is performed
227  * @param data input data
228  * @param idx pointer to variable where the index of the best codebook entry is
229  *        returned
230  * @param gain pointer to variable where the gain of the best codebook entry is
231  *        returned
232  */
233 static void find_best_vect(float *work, const float *coefs,
234                            const int8_t cb[][BLOCKSIZE], const float *ortho1,
235                            const float *ortho2, float *data, int *idx,
236                            float *gain)
237 {
238     int i, j;
239     float g, score, best_score;
240     float vect[BLOCKSIZE];
241
242     *idx = *gain = best_score = 0;
243     for (i = 0; i < FIXED_CB_SIZE; i++) {
244         for (j = 0; j < BLOCKSIZE; j++)
245             vect[j] = cb[i][j];
246         get_match_score(work, coefs, vect, ortho1, ortho2, data, &score, &g);
247         if (score > best_score) {
248             best_score = score;
249             *idx = i;
250             *gain = g;
251         }
252     }
253 }
254
255
256 /**
257  * Search the two fixed codebooks for the best entry and gain
258  *
259  * @param work array used to calculate LPC-filtered vectors
260  * @param coefs coefficients of the LPC filter
261  * @param data input data
262  * @param cba_idx index of the best entry of the adaptive codebook
263  * @param cb1_idx pointer to variable where the index of the best entry of the
264  *        first fixed codebook is returned
265  * @param cb2_idx pointer to variable where the index of the best entry of the
266  *        second fixed codebook is returned
267  */
268 static void fixed_cb_search(float *work, const float *coefs, float *data,
269                             int cba_idx, int *cb1_idx, int *cb2_idx)
270 {
271     int i, ortho_cb1;
272     float gain;
273     float cba_vect[BLOCKSIZE], cb1_vect[BLOCKSIZE];
274     float vect[BLOCKSIZE];
275
276     /**
277      * The filtered vector from the adaptive codebook can be retrieved from
278      * work, because this function is called just after adaptive_cb_search().
279      */
280     if (cba_idx)
281         memcpy(cba_vect, work, sizeof(cba_vect));
282
283     find_best_vect(work, coefs, ff_cb1_vects, cba_idx ? cba_vect : NULL, NULL,
284                    data, cb1_idx, &gain);
285
286     /**
287      * Re-calculate the filtered vector from the vector with maximum match score
288      * and remove its contribution from input data.
289      */
290     if (gain) {
291         for (i = 0; i < BLOCKSIZE; i++)
292             vect[i] = ff_cb1_vects[*cb1_idx][i];
293         ff_celp_lp_synthesis_filterf(work, coefs, vect, BLOCKSIZE, LPC_ORDER);
294         if (cba_idx)
295             orthogonalize(work, cba_vect);
296         for (i = 0; i < BLOCKSIZE; i++)
297             data[i] -= gain * work[i];
298         memcpy(cb1_vect, work, sizeof(cb1_vect));
299         ortho_cb1 = 1;
300     } else
301         ortho_cb1 = 0;
302
303     find_best_vect(work, coefs, ff_cb2_vects, cba_idx ? cba_vect : NULL,
304                    ortho_cb1 ? cb1_vect : NULL, data, cb2_idx, &gain);
305 }
306
307
308 /**
309  * Encode a subblock of the current frame
310  *
311  * @param ractx encoder context
312  * @param sblock_data input data of the subblock
313  * @param lpc_coefs coefficients of the LPC filter
314  * @param rms RMS of the reflection coefficients
315  * @param pb pointer to PutBitContext of the current frame
316  */
317 static void ra144_encode_subblock(RA144Context *ractx,
318                                   const int16_t *sblock_data,
319                                   const int16_t *lpc_coefs, unsigned int rms,
320                                   PutBitContext *pb)
321 {
322     float data[BLOCKSIZE], work[LPC_ORDER + BLOCKSIZE];
323     float coefs[LPC_ORDER];
324     float zero[BLOCKSIZE], cba[BLOCKSIZE], cb1[BLOCKSIZE], cb2[BLOCKSIZE];
325     int16_t cba_vect[BLOCKSIZE];
326     int cba_idx, cb1_idx, cb2_idx, gain;
327     int i, n, m[3];
328     float g[3];
329     float error, best_error;
330
331     for (i = 0; i < LPC_ORDER; i++) {
332         work[i] = ractx->curr_sblock[BLOCKSIZE + i];
333         coefs[i] = lpc_coefs[i] * (1/4096.0);
334     }
335
336     /**
337      * Calculate the zero-input response of the LPC filter and subtract it from
338      * input data.
339      */
340     memset(data, 0, sizeof(data));
341     ff_celp_lp_synthesis_filterf(work + LPC_ORDER, coefs, data, BLOCKSIZE,
342                                  LPC_ORDER);
343     for (i = 0; i < BLOCKSIZE; i++) {
344         zero[i] = work[LPC_ORDER + i];
345         data[i] = sblock_data[i] - zero[i];
346     }
347
348     /**
349      * Codebook search is performed without taking into account the contribution
350      * of the previous subblock, since it has been just subtracted from input
351      * data.
352      */
353     memset(work, 0, LPC_ORDER * sizeof(*work));
354
355     cba_idx = adaptive_cb_search(ractx->adapt_cb, work + LPC_ORDER, coefs,
356                                  data);
357     if (cba_idx) {
358         /**
359          * The filtered vector from the adaptive codebook can be retrieved from
360          * work, see implementation of adaptive_cb_search().
361          */
362         memcpy(cba, work + LPC_ORDER, sizeof(cba));
363
364         ff_copy_and_dup(cba_vect, ractx->adapt_cb, cba_idx + BLOCKSIZE / 2 - 1);
365         m[0] = (ff_irms(cba_vect) * rms) >> 12;
366     }
367     fixed_cb_search(work + LPC_ORDER, coefs, data, cba_idx, &cb1_idx, &cb2_idx);
368     for (i = 0; i < BLOCKSIZE; i++) {
369         cb1[i] = ff_cb1_vects[cb1_idx][i];
370         cb2[i] = ff_cb2_vects[cb2_idx][i];
371     }
372     ff_celp_lp_synthesis_filterf(work + LPC_ORDER, coefs, cb1, BLOCKSIZE,
373                                  LPC_ORDER);
374     memcpy(cb1, work + LPC_ORDER, sizeof(cb1));
375     m[1] = (ff_cb1_base[cb1_idx] * rms) >> 8;
376     ff_celp_lp_synthesis_filterf(work + LPC_ORDER, coefs, cb2, BLOCKSIZE,
377                                  LPC_ORDER);
378     memcpy(cb2, work + LPC_ORDER, sizeof(cb2));
379     m[2] = (ff_cb2_base[cb2_idx] * rms) >> 8;
380     best_error = FLT_MAX;
381     gain = 0;
382     for (n = 0; n < 256; n++) {
383         g[1] = ((ff_gain_val_tab[n][1] * m[1]) >> ff_gain_exp_tab[n]) *
384                (1/4096.0);
385         g[2] = ((ff_gain_val_tab[n][2] * m[2]) >> ff_gain_exp_tab[n]) *
386                (1/4096.0);
387         error = 0;
388         if (cba_idx) {
389             g[0] = ((ff_gain_val_tab[n][0] * m[0]) >> ff_gain_exp_tab[n]) *
390                    (1/4096.0);
391             for (i = 0; i < BLOCKSIZE; i++) {
392                 data[i] = zero[i] + g[0] * cba[i] + g[1] * cb1[i] +
393                           g[2] * cb2[i];
394                 error += (data[i] - sblock_data[i]) *
395                          (data[i] - sblock_data[i]);
396             }
397         } else {
398             for (i = 0; i < BLOCKSIZE; i++) {
399                 data[i] = zero[i] + g[1] * cb1[i] + g[2] * cb2[i];
400                 error += (data[i] - sblock_data[i]) *
401                          (data[i] - sblock_data[i]);
402             }
403         }
404         if (error < best_error) {
405             best_error = error;
406             gain = n;
407         }
408     }
409     put_bits(pb, 7, cba_idx);
410     put_bits(pb, 8, gain);
411     put_bits(pb, 7, cb1_idx);
412     put_bits(pb, 7, cb2_idx);
413     ff_subblock_synthesis(ractx, lpc_coefs, cba_idx, cb1_idx, cb2_idx, rms,
414                           gain);
415 }
416
417
418 static int ra144_encode_frame(AVCodecContext *avctx, uint8_t *frame,
419                               int buf_size, void *data)
420 {
421     static const uint8_t sizes[LPC_ORDER] = {64, 32, 32, 16, 16, 8, 8, 8, 8, 4};
422     static const uint8_t bit_sizes[LPC_ORDER] = {6, 5, 5, 4, 4, 3, 3, 3, 3, 2};
423     RA144Context *ractx;
424     PutBitContext pb;
425     int32_t lpc_data[NBLOCKS * BLOCKSIZE];
426     int32_t lpc_coefs[LPC_ORDER][MAX_LPC_ORDER];
427     int shift[LPC_ORDER];
428     int16_t block_coefs[NBLOCKS][LPC_ORDER];
429     int lpc_refl[LPC_ORDER];    /**< reflection coefficients of the frame */
430     unsigned int refl_rms[NBLOCKS]; /**< RMS of the reflection coefficients */
431     int energy = 0;
432     int i, idx;
433
434     if (buf_size < FRAMESIZE) {
435         av_log(avctx, AV_LOG_ERROR, "output buffer too small\n");
436         return 0;
437     }
438     ractx = avctx->priv_data;
439
440     /**
441      * Since the LPC coefficients are calculated on a frame centered over the
442      * fourth subframe, to encode a given frame, data from the next frame is
443      * needed. In each call to this function, the previous frame (whose data are
444      * saved in the encoder context) is encoded, and data from the current frame
445      * are saved in the encoder context to be used in the next function call.
446      */
447     for (i = 0; i < (2 * BLOCKSIZE + BLOCKSIZE / 2); i++) {
448         lpc_data[i] = ractx->curr_block[BLOCKSIZE + BLOCKSIZE / 2 + i];
449         energy += (lpc_data[i] * lpc_data[i]) >> 4;
450     }
451     for (i = 2 * BLOCKSIZE + BLOCKSIZE / 2; i < NBLOCKS * BLOCKSIZE; i++) {
452         lpc_data[i] = *((int16_t *)data + i - 2 * BLOCKSIZE - BLOCKSIZE / 2) >>
453                       2;
454         energy += (lpc_data[i] * lpc_data[i]) >> 4;
455     }
456     energy = ff_energy_tab[quantize(ff_t_sqrt(energy >> 5) >> 10, ff_energy_tab,
457                                     32)];
458
459     ff_lpc_calc_coefs(&ractx->lpc_ctx, lpc_data, NBLOCKS * BLOCKSIZE, LPC_ORDER,
460                       LPC_ORDER, 16, lpc_coefs, shift, FF_LPC_TYPE_LEVINSON,
461                       0, ORDER_METHOD_EST, 12, 0);
462     for (i = 0; i < LPC_ORDER; i++)
463         block_coefs[NBLOCKS - 1][i] = -(lpc_coefs[LPC_ORDER - 1][i] <<
464                                         (12 - shift[LPC_ORDER - 1]));
465
466     /**
467      * TODO: apply perceptual weighting of the input speech through bandwidth
468      * expansion of the LPC filter.
469      */
470
471     if (ff_eval_refl(lpc_refl, block_coefs[NBLOCKS - 1], avctx)) {
472         /**
473          * The filter is unstable: use the coefficients of the previous frame.
474          */
475         ff_int_to_int16(block_coefs[NBLOCKS - 1], ractx->lpc_coef[1]);
476         if (ff_eval_refl(lpc_refl, block_coefs[NBLOCKS - 1], avctx)) {
477             /* the filter is still unstable. set reflection coeffs to zero. */
478             memset(lpc_refl, 0, sizeof(lpc_refl));
479         }
480     }
481     init_put_bits(&pb, frame, buf_size);
482     for (i = 0; i < LPC_ORDER; i++) {
483         idx = quantize(lpc_refl[i], ff_lpc_refl_cb[i], sizes[i]);
484         put_bits(&pb, bit_sizes[i], idx);
485         lpc_refl[i] = ff_lpc_refl_cb[i][idx];
486     }
487     ractx->lpc_refl_rms[0] = ff_rms(lpc_refl);
488     ff_eval_coefs(ractx->lpc_coef[0], lpc_refl);
489     refl_rms[0] = ff_interp(ractx, block_coefs[0], 1, 1, ractx->old_energy);
490     refl_rms[1] = ff_interp(ractx, block_coefs[1], 2,
491                             energy <= ractx->old_energy,
492                             ff_t_sqrt(energy * ractx->old_energy) >> 12);
493     refl_rms[2] = ff_interp(ractx, block_coefs[2], 3, 0, energy);
494     refl_rms[3] = ff_rescale_rms(ractx->lpc_refl_rms[0], energy);
495     ff_int_to_int16(block_coefs[NBLOCKS - 1], ractx->lpc_coef[0]);
496     put_bits(&pb, 5, quantize(energy, ff_energy_tab, 32));
497     for (i = 0; i < NBLOCKS; i++)
498         ra144_encode_subblock(ractx, ractx->curr_block + i * BLOCKSIZE,
499                               block_coefs[i], refl_rms[i], &pb);
500     flush_put_bits(&pb);
501     ractx->old_energy = energy;
502     ractx->lpc_refl_rms[1] = ractx->lpc_refl_rms[0];
503     FFSWAP(unsigned int *, ractx->lpc_coef[0], ractx->lpc_coef[1]);
504     for (i = 0; i < NBLOCKS * BLOCKSIZE; i++)
505         ractx->curr_block[i] = *((int16_t *)data + i) >> 2;
506     return FRAMESIZE;
507 }
508
509
510 AVCodec ff_ra_144_encoder = {
511     .name           = "real_144",
512     .type           = AVMEDIA_TYPE_AUDIO,
513     .id             = CODEC_ID_RA_144,
514     .priv_data_size = sizeof(RA144Context),
515     .init           = ra144_encode_init,
516     .encode         = ra144_encode_frame,
517     .close          = ra144_encode_close,
518     .sample_fmts    = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
519                                                      AV_SAMPLE_FMT_NONE },
520     .long_name      = NULL_IF_CONFIG_SMALL("RealAudio 1.0 (14.4K)"),
521 };