Rename pred() to eval_lpc_coeffs() and add a doxy comment
[ffmpeg.git] / libavcodec / ra288.c
1 /*
2  * RealAudio 2.0 (28.8K)
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 #define ALT_BITSTREAM_READER_LE
24 #include "bitstream.h"
25 #include "ra288.h"
26
27 typedef struct {
28     float history[8];
29     float output[40];
30     float pr1[36];
31     float pr2[10];
32     int   phase;
33
34     float st1a[111], st1b[37], st1[37];
35     float st2a[38], st2b[11], st2[11];
36     float sb[41];
37     float lhist[10];
38 } Real288_internal;
39
40 static inline float scalar_product_float(const float * v1, const float * v2,
41                                          int size)
42 {
43     float res = 0.;
44
45     while (size--)
46         res += *v1++ * *v2++;
47
48     return res;
49 }
50
51 /* Decode and produce output */
52 static void decode(Real288_internal *glob, float gain, int cb_coef)
53 {
54     int x, y;
55     double sumsum;
56     float sum, buffer[5];
57
58     memmove(glob->sb + 5, glob->sb, 36 * sizeof(*glob->sb));
59
60     for (x=4; x >= 0; x--)
61         glob->sb[x] = -scalar_product_float(glob->sb + x + 1, glob->pr1, 36);
62
63     /* convert log and do rms */
64     sum = 32. - scalar_product_float(glob->pr2, glob->lhist, 10);
65
66     sum = av_clipf(sum, 0, 60);
67
68     sumsum = exp(sum * 0.1151292546497) * gain;    /* pow(10.0,sum/20)*f */
69
70     for (x=0; x < 5; x++)
71         buffer[x] = codetable[cb_coef][x] * sumsum;
72
73     sum = scalar_product_float(buffer, buffer, 5) / 5;
74
75     sum = FFMAX(sum, 1);
76
77     /* shift and store */
78     memmove(glob->lhist, glob->lhist - 1, 10 * sizeof(*glob->lhist));
79
80     *glob->lhist = glob->history[glob->phase] = 10 * log10(sum) - 32;
81
82     for (x=1; x < 5; x++)
83         for (y=x-1; y >= 0; y--)
84             buffer[x] -= glob->pr1[x-y-1] * buffer[y];
85
86     /* output */
87     for (x=0; x < 5; x++) {
88         glob->output[glob->phase*5+x] = glob->sb[4-x] =
89             av_clipf(glob->sb[4-x] + buffer[x], -4095, 4095);
90     }
91 }
92
93 /* column multiply */
94 static void colmult(float *tgt, const float *m1, const float *m2, int n)
95 {
96     while (n--)
97         *(tgt++) = (*(m1++)) * (*(m2++));
98 }
99
100 /**
101  * Converts autocorrelation coefficients to LPC coefficients using the
102  * Levinson-Durbin algorithm. See blocks 37 and 50 of the G.728 specification.
103  *
104  * @return 1 if success, 0 if fail
105  */
106 static int eval_lpc_coeffs(const float *in, float *tgt, int n)
107 {
108     int x, y;
109     double f0, f1, f2;
110
111     if (in[n] == 0)
112         return 0;
113
114     if ((f0 = *in) <= 0)
115         return 0;
116
117     in--; // To avoid a -1 subtraction in the inner loop
118
119     for (x=1; x <= n; x++) {
120         f1 = in[x+1];
121
122         for (y=0; y < x - 1; y++)
123             f1 += in[x-y]*tgt[y];
124
125         tgt[x-1] = f2 = -f1/f0;
126         for (y=0; y < x >> 1; y++) {
127             float temp = tgt[y] + tgt[x-y-2]*f2;
128             tgt[x-y-2] += tgt[y]*f2;
129             tgt[y] = temp;
130         }
131         if ((f0 += f1*f2) < 0)
132             return 0;
133     }
134
135     return 1;
136 }
137
138 /* product sum (lsf) */
139 static void prodsum(float *tgt, const float *src, int len, int n)
140 {
141     for (; n >= 0; n--)
142         tgt[n] = scalar_product_float(src, src - n, len);
143
144 }
145
146 /**
147  * Hybrid window filtering. See blocks 36 and 49 of the G.728 specification.
148  *
149  * @param order   the order of the filter
150  * @param n       the length of the input
151  * @param non_rec the number of non recursive samples
152  * @param out     the filter output
153  * @param in      pointer to the input of the filter
154  * @param hist    pointer to the input history of the filter. It is updated by
155  *                this function.
156  * @param out     pointer to the non recursive part of the output
157  * @param out2    pointer to the recursive part of the output
158  * @param window  pointer to the windowing function table
159  */
160 static void do_hybrid_window(int order, int n, int non_rec, const float *in,
161                              float *out, float *hist, float *out2,
162                              const float *window)
163 {
164     unsigned int x;
165     float buffer1[37];
166     float buffer2[37];
167     float work[111];
168
169     /* update history */
170     memmove(hist                  , hist + n, (order + non_rec)*sizeof(*hist));
171     memcpy (hist + order + non_rec, in      , n                *sizeof(*hist));
172
173     colmult(work, window, hist, order + n + non_rec);
174
175     prodsum(buffer1, work + order    , n      , order);
176     prodsum(buffer2, work + order + n, non_rec, order);
177
178     for (x=0; x <= order; x++) {
179         out2[x] = out2[x] * 0.5625 + buffer1[x];
180         out [x] = out2[x]          + buffer2[x];
181     }
182
183     /* Multiply by the white noise correcting factor (WNCF) */
184     *out *= 257./256.;
185 }
186
187 static void update(Real288_internal *glob)
188 {
189     float buffer1[40], temp1[37];
190     float buffer2[8], temp2[11];
191
192     memcpy(buffer1     , glob->output + 20, 20*sizeof(*buffer1));
193     memcpy(buffer1 + 20, glob->output     , 20*sizeof(*buffer1));
194
195     do_hybrid_window(36, 40, 35, buffer1, temp1, glob->st1a, glob->st1b,
196                      syn_window);
197
198     if (eval_lpc_coeffs(temp1, glob->st1, 36))
199         colmult(glob->pr1, glob->st1, table1a, 36);
200
201     memcpy(buffer2    , glob->history + 4, 4*sizeof(*buffer2));
202     memcpy(buffer2 + 4, glob->history    , 4*sizeof(*buffer2));
203
204     do_hybrid_window(10, 8, 20, buffer2, temp2, glob->st2a, glob->st2b,
205                      gain_window);
206
207     if (eval_lpc_coeffs(temp2, glob->st2, 10))
208         colmult(glob->pr2, glob->st2, table2a, 10);
209 }
210
211 /* Decode a block (celp) */
212 static int ra288_decode_frame(AVCodecContext * avctx, void *data,
213                               int *data_size, const uint8_t * buf,
214                               int buf_size)
215 {
216     int16_t *out = data;
217     int x, y;
218     Real288_internal *glob = avctx->priv_data;
219     GetBitContext gb;
220
221     if (buf_size < avctx->block_align) {
222         av_log(avctx, AV_LOG_ERROR,
223                "Error! Input buffer is too small [%d<%d]\n",
224                buf_size, avctx->block_align);
225         return 0;
226     }
227
228     init_get_bits(&gb, buf, avctx->block_align * 8);
229
230     for (x=0; x < 32; x++) {
231         float gain = amptable[get_bits(&gb, 3)];
232         int cb_coef = get_bits(&gb, 6 + (x&1));
233         glob->phase = x & 7;
234         decode(glob, gain, cb_coef);
235
236         for (y=0; y < 5; y++)
237             *(out++) = 8 * glob->output[glob->phase*5 + y];
238
239         if (glob->phase == 3)
240             update(glob);
241     }
242
243     *data_size = (char *)out - (char *)data;
244     return avctx->block_align;
245 }
246
247 AVCodec ra_288_decoder =
248 {
249     "real_288",
250     CODEC_TYPE_AUDIO,
251     CODEC_ID_RA_288,
252     sizeof(Real288_internal),
253     NULL,
254     NULL,
255     NULL,
256     ra288_decode_frame,
257     .long_name = NULL_IF_CONFIG_SMALL("RealAudio 2.0 (28.8K)"),
258 };