Remove useless define
[ffmpeg.git] / libavcodec / ra144.c
1 /*
2  * Real Audio 1.0 (14.4K)
3  * Copyright (c) 2003 the ffmpeg project
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 #include "avcodec.h"
23 #include "bitstream.h"
24 #include "ra144.h"
25
26 #define NBLOCKS         4       /* number of segments within a block */
27 #define BLOCKSIZE       40      /* (quarter) block size in 16-bit words (80 bytes) */
28 #define BUFFERSIZE      146     /* for do_output */
29
30
31 typedef struct {
32     unsigned int     old_energy;        ///< previous frame energy
33
34     /* the swapped buffers */
35     unsigned int     lpc_tables[2][10];
36     unsigned int    *lpc_coef;          ///< LPC coefficients
37     unsigned int    *lpc_coef_old;      ///< previous frame LPC coefficients
38     unsigned int     lpc_refl_rms;
39     unsigned int     lpc_refl_rms_old;
40
41     /** the current subblock padded by the last 10 values of the previous one*/
42     int16_t curr_sblock[50];
43
44     uint16_t adapt_cb[148];             ///< adaptive codebook
45 } RA144Context;
46
47 static int ra144_decode_init(AVCodecContext * avctx)
48 {
49     RA144Context *ractx = avctx->priv_data;
50
51     ractx->lpc_coef     = ractx->lpc_tables[0];
52     ractx->lpc_coef_old = ractx->lpc_tables[1];
53
54     return 0;
55 }
56
57 /**
58  * Evaluate sqrt(x << 24). x must fit in 20 bits. This value is evaluated in an
59  * odd way to make the output identical to the binary decoder.
60  */
61 static int t_sqrt(unsigned int x)
62 {
63     int s = 2;
64     while (x > 0xfff) {
65         s++;
66         x = x >> 2;
67     }
68
69     return ff_sqrt(x << 20) << s;
70 }
71
72 /**
73  * Evaluate the LPC filter coefficients from the reflection coefficients.
74  * Does the inverse of the eval_refl() function.
75  */
76 static void eval_coefs(const int *refl, int *coefs)
77 {
78     int buffer[10];
79     int *b1 = buffer;
80     int *b2 = coefs;
81     int x, y;
82
83     for (x=0; x < 10; x++) {
84         b1[x] = refl[x] << 4;
85
86         for (y=0; y < x; y++)
87             b1[y] = ((refl[x] * b2[x-y-1]) >> 12) + b2[y];
88
89         FFSWAP(int *, b1, b2);
90     }
91
92     for (x=0; x < 10; x++)
93         coefs[x] >>= 4;
94 }
95
96 /**
97  * Copy the last offset values of *source to *target. If those values are not
98  * enough to fill the target buffer, fill it with another copy of those values.
99  */
100 static void copy_and_dup(const int16_t *source, int16_t *target, int offset)
101 {
102     source += BUFFERSIZE - offset;
103
104     if (offset > BLOCKSIZE) {
105         memcpy(target, source, BLOCKSIZE*sizeof(*target));
106     } else {
107         memcpy(target, source, offset*sizeof(*target));
108         memcpy(target + offset, source, (BLOCKSIZE - offset)*sizeof(*target));
109     }
110 }
111
112 /* inverse root mean square */
113 static int irms(const int16_t *data, int factor)
114 {
115     unsigned int i, sum = 0;
116
117     for (i=0; i < BLOCKSIZE; i++)
118         sum += data[i] * data[i];
119
120     if (sum == 0)
121         return 0; /* OOPS - division by zero */
122
123     return (0x20000000 / (t_sqrt(sum) >> 8)) * factor;
124 }
125
126 /* multiply/add wavetable */
127 static void add_wav(int n, int skip_first, int *m, const int16_t *s1,
128                     const int8_t *s2, const int8_t *s3, int16_t *dest)
129 {
130     int i;
131     int v[3];
132
133     v[0] = 0;
134     for (i=!skip_first; i<3; i++)
135         v[i] = (gain_val_tab[n][i] * m[i]) >> (gain_exp_tab[n][i] + 1);
136
137     for (i=0; i < BLOCKSIZE; i++)
138         dest[i] = ((*(s1++))*v[0] + (*(s2++))*v[1] + (*(s3++))*v[2]) >> 12;
139 }
140
141 /**
142  * LPC Filter. Each output value is predicted from the 10 previous computed
143  * ones. It overwrites the input with the output.
144  *
145  * @param in the input of the filter. It should be an array of size len + 10.
146  * The 10 first input values are used to evaluate the first filtered one.
147  */
148 static void lpc_filter(const int16_t *lpc_coefs, uint16_t *in, int len)
149 {
150     int x, i;
151     int16_t *ptr = in;
152
153     for (i=0; i<len; i++) {
154         int sum = 0;
155         int new_val;
156
157         for(x=0; x<10; x++)
158             sum += lpc_coefs[9-x] * ptr[x];
159
160         sum >>= 12;
161
162         new_val = ptr[10] - sum;
163
164         if (new_val < -32768 || new_val > 32767) {
165             memset(in, 0, 100);
166             return;
167         }
168
169         ptr[10] = new_val;
170         ptr++;
171     }
172 }
173
174 static unsigned int rescale_rms(int rms, int energy)
175 {
176     return (rms * energy) >> 10;
177 }
178
179 static unsigned int rms(const int *data)
180 {
181     int x;
182     unsigned int res = 0x10000;
183     int b = 0;
184
185     for (x=0; x<10; x++) {
186         res = (((0x1000000 - (*data) * (*data)) >> 12) * res) >> 12;
187
188         if (res == 0)
189             return 0;
190
191         while (res <= 0x3fff) {
192             b++;
193             res <<= 2;
194         }
195         data++;
196     }
197
198     if (res > 0)
199         res = t_sqrt(res);
200
201     res >>= (b + 10);
202     return res;
203 }
204
205 /* do quarter-block output */
206 static void do_output_subblock(RA144Context *ractx,
207                                const uint16_t  *lpc_coefs, unsigned int gval,
208                                GetBitContext *gb)
209 {
210     uint16_t buffer_a[40];
211     uint16_t *block;
212     int cba_idx = get_bits(gb, 7); // index of the adaptive CB, 0 if none
213     int gain    = get_bits(gb, 8);
214     int cb1_idx = get_bits(gb, 7);
215     int cb2_idx = get_bits(gb, 7);
216     int m[3];
217
218     if (cba_idx) {
219         cba_idx += BLOCKSIZE/2 - 1;
220         copy_and_dup(ractx->adapt_cb, buffer_a, cba_idx);
221         m[0] = irms(buffer_a, gval) >> 12;
222     } else {
223         m[0] = 0;
224     }
225
226     m[1] = ((cb1_base[cb1_idx] >> 4) * gval) >> 8;
227     m[2] = ((cb2_base[cb2_idx] >> 4) * gval) >> 8;
228
229     memmove(ractx->adapt_cb, ractx->adapt_cb + BLOCKSIZE,
230             (BUFFERSIZE - BLOCKSIZE) * 2);
231
232     block = ractx->adapt_cb + BUFFERSIZE - BLOCKSIZE;
233
234     add_wav(gain, cba_idx, m, buffer_a, cb1_vects[cb1_idx], cb2_vects[cb2_idx],
235             block);
236
237     memcpy(ractx->curr_sblock, ractx->curr_sblock + 40,
238            10*sizeof(*ractx->curr_sblock));
239     memcpy(ractx->curr_sblock + 10, block,
240            BLOCKSIZE*sizeof(*ractx->curr_sblock));
241
242     lpc_filter(lpc_coefs, ractx->curr_sblock, BLOCKSIZE);
243 }
244
245 static void int_to_int16(int16_t *out, const int *inp)
246 {
247     int i;
248
249     for (i=0; i<30; i++)
250         *(out++) = *(inp++);
251 }
252
253 /**
254  * Evaluate the reflection coefficients from the filter coefficients.
255  * Does the inverse of the eval_coefs() function.
256  *
257  * @return 1 if one of the reflection coefficients is of magnitude greater than
258  *         4095, 0 if not.
259  */
260 static int eval_refl(const int16_t *coefs, int *refl, RA144Context *ractx)
261 {
262     int retval = 0;
263     int b, c, i;
264     unsigned int u;
265     int buffer1[10];
266     int buffer2[10];
267     int *bp1 = buffer1;
268     int *bp2 = buffer2;
269
270     for (i=0; i < 10; i++)
271         buffer2[i] = coefs[i];
272
273     u = refl[9] = bp2[9];
274
275     if (u + 0x1000 > 0x1fff) {
276         av_log(ractx, AV_LOG_ERROR, "Overflow. Broken sample?\n");
277         return 0;
278     }
279
280     for (c=8; c >= 0; c--) {
281         if (u == 0x1000)
282             u++;
283
284         if (u == 0xfffff000)
285             u--;
286
287         b = 0x1000-((u * u) >> 12);
288
289         if (b == 0)
290             b++;
291
292         for (u=0; u<=c; u++)
293             bp1[u] = ((bp2[u] - ((refl[c+1] * bp2[c-u]) >> 12)) * (0x1000000 / b)) >> 12;
294
295         refl[c] = u = bp1[c];
296
297         if ((u + 0x1000) > 0x1fff)
298             retval = 1;
299
300         FFSWAP(int *, bp1, bp2);
301     }
302     return retval;
303 }
304
305 static int interp(RA144Context *ractx, int16_t *out, int block_num,
306                   int copynew, int energy)
307 {
308     int work[10];
309     int a = block_num + 1;
310     int b = NBLOCKS - a;
311     int x;
312
313     // Interpolate block coefficients from the this frame forth block and
314     // last frame forth block
315     for (x=0; x<30; x++)
316         out[x] = (a * ractx->lpc_coef[x] + b * ractx->lpc_coef_old[x])>> 2;
317
318     if (eval_refl(out, work, ractx)) {
319         // The interpolated coefficients are unstable, copy either new or old
320         // coefficients
321         if (copynew) {
322             int_to_int16(out, ractx->lpc_coef);
323             return rescale_rms(ractx->lpc_refl_rms, energy);
324         } else {
325             int_to_int16(out, ractx->lpc_coef_old);
326             return rescale_rms(ractx->lpc_refl_rms_old, energy);
327         }
328     } else {
329         return rescale_rms(rms(work), energy);
330     }
331 }
332
333 /* Uncompress one block (20 bytes -> 160*2 bytes) */
334 static int ra144_decode_frame(AVCodecContext * avctx,
335                               void *vdata, int *data_size,
336                               const uint8_t * buf, int buf_size)
337 {
338     static const uint8_t sizes[10] = {6, 5, 5, 4, 4, 3, 3, 3, 3, 2};
339     unsigned int refl_rms[4];    // RMS of the reflection coefficients
340     uint16_t block_coefs[4][30]; // LPC coefficients of each sub-block
341     unsigned int lpc_refl[10];   // LPC reflection coefficients of the frame
342     int i, c;
343     int16_t *data = vdata;
344     unsigned int energy;
345
346     RA144Context *ractx = avctx->priv_data;
347     GetBitContext gb;
348
349     if(buf_size < 20) {
350         av_log(avctx, AV_LOG_ERROR,
351                "Frame too small (%d bytes). Truncated file?\n", buf_size);
352         *data_size = 0;
353         return buf_size;
354     }
355     init_get_bits(&gb, buf, 20 * 8);
356
357     for (i=0; i<10; i++)
358         // "<< 1"? Doesn't this make one value out of two of the table useless?
359         lpc_refl[i] = lpc_refl_cb[i][get_bits(&gb, sizes[i]) << 1];
360
361     eval_coefs(lpc_refl, ractx->lpc_coef);
362     ractx->lpc_refl_rms = rms(lpc_refl);
363
364     energy = energy_tab[get_bits(&gb, 5) << 1]; // Useless table entries?
365
366     refl_rms[0] = interp(ractx, block_coefs[0], 0, 0, ractx->old_energy);
367     refl_rms[1] = interp(ractx, block_coefs[1], 1, energy > ractx->old_energy,
368                     t_sqrt(energy*ractx->old_energy) >> 12);
369     refl_rms[2] = interp(ractx, block_coefs[2], 2, 1, energy);
370     refl_rms[3] = rescale_rms(ractx->lpc_refl_rms, energy);
371
372     int_to_int16(block_coefs[3], ractx->lpc_coef);
373
374     /* do output */
375     for (c=0; c<4; c++) {
376         do_output_subblock(ractx, block_coefs[c], refl_rms[c], &gb);
377
378         for (i=0; i<BLOCKSIZE; i++)
379             *data++ = av_clip_int16(ractx->curr_sblock[i + 10] << 2);
380     }
381
382     ractx->old_energy = energy;
383     ractx->lpc_refl_rms_old = ractx->lpc_refl_rms;
384
385     FFSWAP(unsigned int *, ractx->lpc_coef_old, ractx->lpc_coef);
386
387     *data_size = 2*160;
388     return 20;
389 }
390
391 AVCodec ra_144_decoder =
392 {
393     "real_144",
394     CODEC_TYPE_AUDIO,
395     CODEC_ID_RA_144,
396     sizeof(RA144Context),
397     ra144_decode_init,
398     NULL,
399     NULL,
400     ra144_decode_frame,
401     .long_name = NULL_IF_CONFIG_SMALL("RealAudio 1.0 (14.4K)"),
402 };