cosmetics: Fix spelling mistakes
[ffmpeg.git] / libavcodec / wma.c
1 /*
2  * WMA compatible codec
3  * Copyright (c) 2002-2007 The Libav Project
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 #include "libavutil/attributes.h"
23
24 #include "avcodec.h"
25 #include "internal.h"
26 #include "sinewin.h"
27 #include "wma.h"
28 #include "wma_common.h"
29 #include "wma_freqs.h"
30 #include "wmadata.h"
31
32 /* XXX: use same run/length optimization as mpeg decoders */
33 // FIXME maybe split decode / encode or pass flag
34 static av_cold int init_coef_vlc(VLC *vlc, uint16_t **prun_table,
35                                  float **plevel_table, uint16_t **pint_table,
36                                  const CoefVLCTable *vlc_table)
37 {
38     int n                        = vlc_table->n;
39     const uint8_t  *table_bits   = vlc_table->huffbits;
40     const uint32_t *table_codes  = vlc_table->huffcodes;
41     const uint16_t *levels_table = vlc_table->levels;
42     uint16_t *run_table, *level_table, *int_table;
43     float *flevel_table;
44     int i, l, j, k, level;
45
46     init_vlc(vlc, VLCBITS, n, table_bits, 1, 1, table_codes, 4, 4, 0);
47
48     run_table    = av_malloc(n * sizeof(uint16_t));
49     level_table  = av_malloc(n * sizeof(uint16_t));
50     flevel_table = av_malloc(n * sizeof(*flevel_table));
51     int_table    = av_malloc(n * sizeof(uint16_t));
52     if (!run_table || !level_table || !flevel_table || !int_table) {
53         av_freep(&run_table);
54         av_freep(&level_table);
55         av_freep(&flevel_table);
56         av_freep(&int_table);
57         return AVERROR(ENOMEM);
58     }
59     i            = 2;
60     level        = 1;
61     k            = 0;
62     while (i < n) {
63         int_table[k] = i;
64         l            = levels_table[k++];
65         for (j = 0; j < l; j++) {
66             run_table[i]    = j;
67             level_table[i]  = level;
68             flevel_table[i] = level;
69             i++;
70         }
71         level++;
72     }
73     *prun_table   = run_table;
74     *plevel_table = flevel_table;
75     *pint_table   = int_table;
76     av_free(level_table);
77
78     return 0;
79 }
80
81 av_cold int ff_wma_init(AVCodecContext *avctx, int flags2)
82 {
83     WMACodecContext *s = avctx->priv_data;
84     int i, ret;
85     float bps1, high_freq;
86     volatile float bps;
87     int sample_rate1;
88     int coef_vlc_table;
89
90     if (avctx->sample_rate <= 0 || avctx->sample_rate > 50000 ||
91         avctx->channels    <= 0 || avctx->channels    > 2     ||
92         avctx->bit_rate    <= 0)
93         return -1;
94
95     avpriv_float_dsp_init(&s->fdsp, avctx->flags & AV_CODEC_FLAG_BITEXACT);
96
97     if (avctx->codec->id == AV_CODEC_ID_WMAV1)
98         s->version = 1;
99     else
100         s->version = 2;
101
102     /* compute MDCT block size */
103     s->frame_len_bits = ff_wma_get_frame_len_bits(avctx->sample_rate,
104                                                   s->version, 0);
105     s->next_block_len_bits = s->frame_len_bits;
106     s->prev_block_len_bits = s->frame_len_bits;
107     s->block_len_bits      = s->frame_len_bits;
108
109     s->frame_len = 1 << s->frame_len_bits;
110     if (s->use_variable_block_len) {
111         int nb_max, nb;
112         nb = ((flags2 >> 3) & 3) + 1;
113         if ((avctx->bit_rate / avctx->channels) >= 32000)
114             nb += 2;
115         nb_max = s->frame_len_bits - BLOCK_MIN_BITS;
116         if (nb > nb_max)
117             nb = nb_max;
118         s->nb_block_sizes = nb + 1;
119     } else
120         s->nb_block_sizes = 1;
121
122     /* init rate dependent parameters */
123     s->use_noise_coding = 1;
124     high_freq           = avctx->sample_rate * 0.5;
125
126     /* if version 2, then the rates are normalized */
127     sample_rate1 = avctx->sample_rate;
128     if (s->version == 2) {
129         if (sample_rate1 >= 44100)
130             sample_rate1 = 44100;
131         else if (sample_rate1 >= 22050)
132             sample_rate1 = 22050;
133         else if (sample_rate1 >= 16000)
134             sample_rate1 = 16000;
135         else if (sample_rate1 >= 11025)
136             sample_rate1 = 11025;
137         else if (sample_rate1 >= 8000)
138             sample_rate1 = 8000;
139     }
140
141     bps                 = (float) avctx->bit_rate /
142                           (float) (avctx->channels * avctx->sample_rate);
143     s->byte_offset_bits = av_log2((int) (bps * s->frame_len / 8.0 + 0.5)) + 2;
144
145     /* compute high frequency value and choose if noise coding should
146      * be activated */
147     bps1 = bps;
148     if (avctx->channels == 2)
149         bps1 = bps * 1.6;
150     if (sample_rate1 == 44100) {
151         if (bps1 >= 0.61)
152             s->use_noise_coding = 0;
153         else
154             high_freq = high_freq * 0.4;
155     } else if (sample_rate1 == 22050) {
156         if (bps1 >= 1.16)
157             s->use_noise_coding = 0;
158         else if (bps1 >= 0.72)
159             high_freq = high_freq * 0.7;
160         else
161             high_freq = high_freq * 0.6;
162     } else if (sample_rate1 == 16000) {
163         if (bps > 0.5)
164             high_freq = high_freq * 0.5;
165         else
166             high_freq = high_freq * 0.3;
167     } else if (sample_rate1 == 11025)
168         high_freq = high_freq * 0.7;
169     else if (sample_rate1 == 8000) {
170         if (bps <= 0.625)
171             high_freq = high_freq * 0.5;
172         else if (bps > 0.75)
173             s->use_noise_coding = 0;
174         else
175             high_freq = high_freq * 0.65;
176     } else {
177         if (bps >= 0.8)
178             high_freq = high_freq * 0.75;
179         else if (bps >= 0.6)
180             high_freq = high_freq * 0.6;
181         else
182             high_freq = high_freq * 0.5;
183     }
184     ff_dlog(s->avctx, "flags2=0x%x\n", flags2);
185     ff_dlog(s->avctx, "version=%d channels=%d sample_rate=%d bitrate=%d block_align=%d\n",
186             s->version, avctx->channels, avctx->sample_rate, avctx->bit_rate,
187             avctx->block_align);
188     ff_dlog(s->avctx, "bps=%f bps1=%f high_freq=%f bitoffset=%d\n",
189             bps, bps1, high_freq, s->byte_offset_bits);
190     ff_dlog(s->avctx, "use_noise_coding=%d use_exp_vlc=%d nb_block_sizes=%d\n",
191             s->use_noise_coding, s->use_exp_vlc, s->nb_block_sizes);
192
193     /* compute the scale factor band sizes for each MDCT block size */
194     {
195         int a, b, pos, lpos, k, block_len, i, j, n;
196         const uint8_t *table;
197
198         if (s->version == 1)
199             s->coefs_start = 3;
200         else
201             s->coefs_start = 0;
202         for (k = 0; k < s->nb_block_sizes; k++) {
203             block_len = s->frame_len >> k;
204
205             if (s->version == 1) {
206                 lpos = 0;
207                 for (i = 0; i < 25; i++) {
208                     a   = ff_wma_critical_freqs[i];
209                     b   = avctx->sample_rate;
210                     pos = ((block_len * 2 * a) + (b >> 1)) / b;
211                     if (pos > block_len)
212                         pos = block_len;
213                     s->exponent_bands[0][i] = pos - lpos;
214                     if (pos >= block_len) {
215                         i++;
216                         break;
217                     }
218                     lpos = pos;
219                 }
220                 s->exponent_sizes[0] = i;
221             } else {
222                 /* hardcoded tables */
223                 table = NULL;
224                 a     = s->frame_len_bits - BLOCK_MIN_BITS - k;
225                 if (a < 3) {
226                     if (avctx->sample_rate >= 44100)
227                         table = exponent_band_44100[a];
228                     else if (avctx->sample_rate >= 32000)
229                         table = exponent_band_32000[a];
230                     else if (avctx->sample_rate >= 22050)
231                         table = exponent_band_22050[a];
232                 }
233                 if (table) {
234                     n = *table++;
235                     for (i = 0; i < n; i++)
236                         s->exponent_bands[k][i] = table[i];
237                     s->exponent_sizes[k] = n;
238                 } else {
239                     j    = 0;
240                     lpos = 0;
241                     for (i = 0; i < 25; i++) {
242                         a     = ff_wma_critical_freqs[i];
243                         b     = avctx->sample_rate;
244                         pos   = ((block_len * 2 * a) + (b << 1)) / (4 * b);
245                         pos <<= 2;
246                         if (pos > block_len)
247                             pos = block_len;
248                         if (pos > lpos)
249                             s->exponent_bands[k][j++] = pos - lpos;
250                         if (pos >= block_len)
251                             break;
252                         lpos = pos;
253                     }
254                     s->exponent_sizes[k] = j;
255                 }
256             }
257
258             /* max number of coefs */
259             s->coefs_end[k] = (s->frame_len - ((s->frame_len * 9) / 100)) >> k;
260             /* high freq computation */
261             s->high_band_start[k] = (int) ((block_len * 2 * high_freq) /
262                                            avctx->sample_rate + 0.5);
263             n   = s->exponent_sizes[k];
264             j   = 0;
265             pos = 0;
266             for (i = 0; i < n; i++) {
267                 int start, end;
268                 start = pos;
269                 pos  += s->exponent_bands[k][i];
270                 end   = pos;
271                 if (start < s->high_band_start[k])
272                     start = s->high_band_start[k];
273                 if (end > s->coefs_end[k])
274                     end = s->coefs_end[k];
275                 if (end > start)
276                     s->exponent_high_bands[k][j++] = end - start;
277             }
278             s->exponent_high_sizes[k] = j;
279 #if 0
280             ff_tlog(s->avctx, "%5d: coefs_end=%d high_band_start=%d nb_high_bands=%d: ",
281                     s->frame_len >> k,
282                     s->coefs_end[k],
283                     s->high_band_start[k],
284                     s->exponent_high_sizes[k]);
285             for (j = 0; j < s->exponent_high_sizes[k]; j++)
286                 ff_tlog(s->avctx, " %d", s->exponent_high_bands[k][j]);
287             ff_tlog(s->avctx, "\n");
288 #endif /* 0 */
289         }
290     }
291
292 #ifdef TRACE
293     {
294         int i, j;
295         for (i = 0; i < s->nb_block_sizes; i++) {
296             ff_tlog(s->avctx, "%5d: n=%2d:",
297                     s->frame_len >> i,
298                     s->exponent_sizes[i]);
299             for (j = 0; j < s->exponent_sizes[i]; j++)
300                 ff_tlog(s->avctx, " %d", s->exponent_bands[i][j]);
301             ff_tlog(s->avctx, "\n");
302         }
303     }
304 #endif /* TRACE */
305
306     /* init MDCT windows : simple sine window */
307     for (i = 0; i < s->nb_block_sizes; i++) {
308         ff_init_ff_sine_windows(s->frame_len_bits - i);
309         s->windows[i] = ff_sine_windows[s->frame_len_bits - i];
310     }
311
312     s->reset_block_lengths = 1;
313
314     if (s->use_noise_coding) {
315         /* init the noise generator */
316         if (s->use_exp_vlc)
317             s->noise_mult = 0.02;
318         else
319             s->noise_mult = 0.04;
320
321 #ifdef TRACE
322         for (i = 0; i < NOISE_TAB_SIZE; i++)
323             s->noise_table[i] = 1.0 * s->noise_mult;
324 #else
325         {
326             unsigned int seed;
327             float norm;
328             seed = 1;
329             norm = (1.0 / (float) (1LL << 31)) * sqrt(3) * s->noise_mult;
330             for (i = 0; i < NOISE_TAB_SIZE; i++) {
331                 seed              = seed * 314159 + 1;
332                 s->noise_table[i] = (float) ((int) seed) * norm;
333             }
334         }
335 #endif /* TRACE */
336     }
337
338     /* choose the VLC tables for the coefficients */
339     coef_vlc_table = 2;
340     if (avctx->sample_rate >= 32000) {
341         if (bps1 < 0.72)
342             coef_vlc_table = 0;
343         else if (bps1 < 1.16)
344             coef_vlc_table = 1;
345     }
346     s->coef_vlcs[0] = &coef_vlcs[coef_vlc_table * 2];
347     s->coef_vlcs[1] = &coef_vlcs[coef_vlc_table * 2 + 1];
348     ret = init_coef_vlc(&s->coef_vlc[0], &s->run_table[0], &s->level_table[0],
349                         &s->int_table[0], s->coef_vlcs[0]);
350     if (ret < 0)
351         return ret;
352
353     return init_coef_vlc(&s->coef_vlc[1], &s->run_table[1], &s->level_table[1],
354                          &s->int_table[1], s->coef_vlcs[1]);
355 }
356
357 int ff_wma_total_gain_to_bits(int total_gain)
358 {
359     if (total_gain < 15)
360         return 13;
361     else if (total_gain < 32)
362         return 12;
363     else if (total_gain < 40)
364         return 11;
365     else if (total_gain < 45)
366         return 10;
367     else
368         return  9;
369 }
370
371 int ff_wma_end(AVCodecContext *avctx)
372 {
373     WMACodecContext *s = avctx->priv_data;
374     int i;
375
376     for (i = 0; i < s->nb_block_sizes; i++)
377         ff_mdct_end(&s->mdct_ctx[i]);
378
379     if (s->use_exp_vlc)
380         ff_free_vlc(&s->exp_vlc);
381     if (s->use_noise_coding)
382         ff_free_vlc(&s->hgain_vlc);
383     for (i = 0; i < 2; i++) {
384         ff_free_vlc(&s->coef_vlc[i]);
385         av_free(s->run_table[i]);
386         av_free(s->level_table[i]);
387         av_free(s->int_table[i]);
388     }
389
390     return 0;
391 }
392
393 /**
394  * Decode an uncompressed coefficient.
395  * @param gb GetBitContext
396  * @return the decoded coefficient
397  */
398 unsigned int ff_wma_get_large_val(GetBitContext *gb)
399 {
400     /** consumes up to 34 bits */
401     int n_bits = 8;
402     /** decode length */
403     if (get_bits1(gb)) {
404         n_bits += 8;
405         if (get_bits1(gb)) {
406             n_bits += 8;
407             if (get_bits1(gb))
408                 n_bits += 7;
409         }
410     }
411     return get_bits_long(gb, n_bits);
412 }
413
414 /**
415  * Decode run level compressed coefficients.
416  * @param avctx codec context
417  * @param gb bitstream reader context
418  * @param vlc vlc table for get_vlc2
419  * @param level_table level codes
420  * @param run_table run codes
421  * @param version 0 for wma1,2 1 for wmapro
422  * @param ptr output buffer
423  * @param offset offset in the output buffer
424  * @param num_coefs number of input coefficients
425  * @param block_len input buffer length (2^n)
426  * @param frame_len_bits number of bits for escaped run codes
427  * @param coef_nb_bits number of bits for escaped level codes
428  * @return 0 on success, -1 otherwise
429  */
430 int ff_wma_run_level_decode(AVCodecContext *avctx, GetBitContext *gb,
431                             VLC *vlc, const float *level_table,
432                             const uint16_t *run_table, int version,
433                             WMACoef *ptr, int offset, int num_coefs,
434                             int block_len, int frame_len_bits,
435                             int coef_nb_bits)
436 {
437     int code, level, sign;
438     const uint32_t *ilvl = (const uint32_t *) level_table;
439     uint32_t *iptr = (uint32_t *) ptr;
440     const unsigned int coef_mask = block_len - 1;
441     for (; offset < num_coefs; offset++) {
442         code = get_vlc2(gb, vlc->table, VLCBITS, VLCMAX);
443         if (code > 1) {
444             /** normal code */
445             offset                  += run_table[code];
446             sign                     = get_bits1(gb) - 1;
447             iptr[offset & coef_mask] = ilvl[code] ^ sign << 31;
448         } else if (code == 1) {
449             /** EOB */
450             break;
451         } else {
452             /** escape */
453             if (!version) {
454                 level = get_bits(gb, coef_nb_bits);
455                 /** NOTE: this is rather suboptimal. reading
456                  *  block_len_bits would be better */
457                 offset += get_bits(gb, frame_len_bits);
458             } else {
459                 level = ff_wma_get_large_val(gb);
460                 /** escape decode */
461                 if (get_bits1(gb)) {
462                     if (get_bits1(gb)) {
463                         if (get_bits1(gb)) {
464                             av_log(avctx, AV_LOG_ERROR,
465                                    "broken escape sequence\n");
466                             return -1;
467                         } else
468                             offset += get_bits(gb, frame_len_bits) + 4;
469                     } else
470                         offset += get_bits(gb, 2) + 1;
471                 }
472             }
473             sign                    = get_bits1(gb) - 1;
474             ptr[offset & coef_mask] = (level ^ sign) - sign;
475         }
476     }
477     /** NOTE: EOB can be omitted */
478     if (offset > num_coefs) {
479         av_log(avctx, AV_LOG_ERROR, "overflow in spectral RLE, ignoring\n");
480         return -1;
481     }
482
483     return 0;
484 }