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