fixpoint: lowlevel functional abstraction for all buffer arithmetics
[ffmpeg.git] / libavcodec / cook.c
1 /*
2  * COOK compatible decoder
3  * Copyright (c) 2003 Sascha Sommer
4  * Copyright (c) 2005 Benjamin Larsson
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file cook.c
25  * Cook compatible decoder. Bastardization of the G.722.1 standard.
26  * This decoder handles RealNetworks, RealAudio G2 data.
27  * Cook is identified by the codec name cook in RM files.
28  *
29  * To use this decoder, a calling application must supply the extradata
30  * bytes provided from the RM container; 8+ bytes for mono streams and
31  * 16+ for stereo streams (maybe more).
32  *
33  * Codec technicalities (all this assume a buffer length of 1024):
34  * Cook works with several different techniques to achieve its compression.
35  * In the timedomain the buffer is divided into 8 pieces and quantized. If
36  * two neighboring pieces have different quantization index a smooth
37  * quantization curve is used to get a smooth overlap between the different
38  * pieces.
39  * To get to the transformdomain Cook uses a modulated lapped transform.
40  * The transform domain has 50 subbands with 20 elements each. This
41  * means only a maximum of 50*20=1000 coefficients are used out of the 1024
42  * available.
43  */
44
45 #include <math.h>
46 #include <stddef.h>
47 #include <stdio.h>
48
49 #include "avcodec.h"
50 #include "bitstream.h"
51 #include "dsputil.h"
52 #include "bytestream.h"
53 #include "random.h"
54
55 #include "cookdata.h"
56
57 /* the different Cook versions */
58 #define MONO            0x1000001
59 #define STEREO          0x1000002
60 #define JOINT_STEREO    0x1000003
61 #define MC_COOK         0x2000000   //multichannel Cook, not supported
62
63 #define SUBBAND_SIZE    20
64 //#define COOKDEBUG
65
66 typedef struct {
67     int *now;
68     int *previous;
69 } cook_gains;
70
71 typedef struct cook {
72     /*
73      * The following 5 functions provide the lowlevel arithmetic on
74      * the internal audio buffers.
75      */
76     void (* scalar_dequant)(struct cook *q, int index, int quant_index,
77                             int* subband_coef_index, int* subband_coef_sign,
78                             float* mlt_p);
79
80     void (* decouple) (struct cook *q,
81                        int subband,
82                        float f1, float f2,
83                        float *decode_buffer,
84                        float *mlt_buffer1, float *mlt_buffer2);
85
86     void (* imlt_window) (struct cook *q, float *buffer1,
87                           cook_gains *gains_ptr, float *previous_buffer);
88
89     void (* interpolate) (struct cook *q, float* buffer,
90                           int gain_index, int gain_index_next);
91
92     void (* saturate_output) (struct cook *q, int chan, int16_t *out);
93
94     GetBitContext       gb;
95     /* stream data */
96     int                 nb_channels;
97     int                 joint_stereo;
98     int                 bit_rate;
99     int                 sample_rate;
100     int                 samples_per_channel;
101     int                 samples_per_frame;
102     int                 subbands;
103     int                 log2_numvector_size;
104     int                 numvector_size;                //1 << log2_numvector_size;
105     int                 js_subband_start;
106     int                 total_subbands;
107     int                 num_vectors;
108     int                 bits_per_subpacket;
109     int                 cookversion;
110     /* states */
111     AVRandomState       random_state;
112
113     /* transform data */
114     MDCTContext         mdct_ctx;
115     DECLARE_ALIGNED_16(FFTSample, mdct_tmp[1024]);  /* temporary storage for imlt */
116     float*              mlt_window;
117
118     /* gain buffers */
119     cook_gains          gains1;
120     cook_gains          gains2;
121     int                 gain_1[9];
122     int                 gain_2[9];
123     int                 gain_3[9];
124     int                 gain_4[9];
125
126     /* VLC data */
127     int                 js_vlc_bits;
128     VLC                 envelope_quant_index[13];
129     VLC                 sqvh[7];          //scalar quantization
130     VLC                 ccpl;             //channel coupling
131
132     /* generatable tables and related variables */
133     int                 gain_size_factor;
134     float               gain_table[23];
135     float               pow2tab[127];
136     float               rootpow2tab[127];
137
138     /* data buffers */
139
140     uint8_t*            decoded_bytes_buffer;
141     DECLARE_ALIGNED_16(float,mono_mdct_output[2048]);
142     float               mono_previous_buffer1[1024];
143     float               mono_previous_buffer2[1024];
144     float               decode_buffer_1[1024];
145     float               decode_buffer_2[1024];
146     float               decode_buffer_0[1060]; /* static allocation for joint decode */
147 } COOKContext;
148
149 /* debug functions */
150
151 #ifdef COOKDEBUG
152 static void dump_float_table(float* table, int size, int delimiter) {
153     int i=0;
154     av_log(NULL,AV_LOG_ERROR,"\n[%d]: ",i);
155     for (i=0 ; i<size ; i++) {
156         av_log(NULL, AV_LOG_ERROR, "%5.1f, ", table[i]);
157         if ((i+1)%delimiter == 0) av_log(NULL,AV_LOG_ERROR,"\n[%d]: ",i+1);
158     }
159 }
160
161 static void dump_int_table(int* table, int size, int delimiter) {
162     int i=0;
163     av_log(NULL,AV_LOG_ERROR,"\n[%d]: ",i);
164     for (i=0 ; i<size ; i++) {
165         av_log(NULL, AV_LOG_ERROR, "%d, ", table[i]);
166         if ((i+1)%delimiter == 0) av_log(NULL,AV_LOG_ERROR,"\n[%d]: ",i+1);
167     }
168 }
169
170 static void dump_short_table(short* table, int size, int delimiter) {
171     int i=0;
172     av_log(NULL,AV_LOG_ERROR,"\n[%d]: ",i);
173     for (i=0 ; i<size ; i++) {
174         av_log(NULL, AV_LOG_ERROR, "%d, ", table[i]);
175         if ((i+1)%delimiter == 0) av_log(NULL,AV_LOG_ERROR,"\n[%d]: ",i+1);
176     }
177 }
178
179 #endif
180
181 /*************** init functions ***************/
182
183 /* table generator */
184 static void init_pow2table(COOKContext *q){
185     int i;
186     q->pow2tab[63] = 1.0;
187     for (i=1 ; i<64 ; i++){
188         q->pow2tab[63+i]=(float)((uint64_t)1<<i);
189         q->pow2tab[63-i]=1.0/(float)((uint64_t)1<<i);
190     }
191 }
192
193 /* table generator */
194 static void init_rootpow2table(COOKContext *q){
195     int i;
196     q->rootpow2tab[63] = 1.0;
197     for (i=1 ; i<64 ; i++){
198         q->rootpow2tab[63+i]=sqrt((float)((uint64_t)1<<i));
199         q->rootpow2tab[63-i]=sqrt(1.0/(float)((uint64_t)1<<i));
200     }
201 }
202
203 /* table generator */
204 static void init_gain_table(COOKContext *q) {
205     int i;
206     q->gain_size_factor = q->samples_per_channel/8;
207     for (i=0 ; i<23 ; i++) {
208         q->gain_table[i] = pow((double)q->pow2tab[i+52] ,
209                                (1.0/(double)q->gain_size_factor));
210     }
211 }
212
213
214 static int init_cook_vlc_tables(COOKContext *q) {
215     int i, result;
216
217     result = 0;
218     for (i=0 ; i<13 ; i++) {
219         result |= init_vlc (&q->envelope_quant_index[i], 9, 24,
220             envelope_quant_index_huffbits[i], 1, 1,
221             envelope_quant_index_huffcodes[i], 2, 2, 0);
222     }
223     av_log(NULL,AV_LOG_DEBUG,"sqvh VLC init\n");
224     for (i=0 ; i<7 ; i++) {
225         result |= init_vlc (&q->sqvh[i], vhvlcsize_tab[i], vhsize_tab[i],
226             cvh_huffbits[i], 1, 1,
227             cvh_huffcodes[i], 2, 2, 0);
228     }
229
230     if (q->nb_channels==2 && q->joint_stereo==1){
231         result |= init_vlc (&q->ccpl, 6, (1<<q->js_vlc_bits)-1,
232             ccpl_huffbits[q->js_vlc_bits-2], 1, 1,
233             ccpl_huffcodes[q->js_vlc_bits-2], 2, 2, 0);
234         av_log(NULL,AV_LOG_DEBUG,"Joint-stereo VLC used.\n");
235     }
236
237     av_log(NULL,AV_LOG_DEBUG,"VLC tables initialized.\n");
238     return result;
239 }
240
241 static int init_cook_mlt(COOKContext *q) {
242     int j;
243     float alpha;
244     int mlt_size = q->samples_per_channel;
245
246     if ((q->mlt_window = av_malloc(sizeof(float)*mlt_size)) == 0)
247       return -1;
248
249     /* Initialize the MLT window: simple sine window. */
250     alpha = M_PI / (2.0 * (float)mlt_size);
251     for(j=0 ; j<mlt_size ; j++)
252         q->mlt_window[j] = sin((j + 0.5) * alpha) * sqrt(2.0 / q->samples_per_channel);
253
254     /* Initialize the MDCT. */
255     if (ff_mdct_init(&q->mdct_ctx, av_log2(mlt_size)+1, 1)) {
256       av_free(q->mlt_window);
257       return -1;
258     }
259     av_log(NULL,AV_LOG_DEBUG,"MDCT initialized, order = %d.\n",
260            av_log2(mlt_size)+1);
261
262     return 0;
263 }
264
265 /*************** init functions end ***********/
266
267 /**
268  * Cook indata decoding, every 32 bits are XORed with 0x37c511f2.
269  * Why? No idea, some checksum/error detection method maybe.
270  *
271  * Out buffer size: extra bytes are needed to cope with
272  * padding/missalignment.
273  * Subpackets passed to the decoder can contain two, consecutive
274  * half-subpackets, of identical but arbitrary size.
275  *          1234 1234 1234 1234  extraA extraB
276  * Case 1:  AAAA BBBB              0      0
277  * Case 2:  AAAA ABBB BB--         3      3
278  * Case 3:  AAAA AABB BBBB         2      2
279  * Case 4:  AAAA AAAB BBBB BB--    1      5
280  *
281  * Nice way to waste CPU cycles.
282  *
283  * @param inbuffer  pointer to byte array of indata
284  * @param out       pointer to byte array of outdata
285  * @param bytes     number of bytes
286  */
287 #define DECODE_BYTES_PAD1(bytes) (3 - ((bytes)+3) % 4)
288 #define DECODE_BYTES_PAD2(bytes) ((bytes) % 4 + DECODE_BYTES_PAD1(2 * (bytes)))
289
290 static inline int decode_bytes(uint8_t* inbuffer, uint8_t* out, int bytes){
291     int i, off;
292     uint32_t c;
293     uint32_t* buf;
294     uint32_t* obuf = (uint32_t*) out;
295     /* FIXME: 64 bit platforms would be able to do 64 bits at a time.
296      * I'm too lazy though, should be something like
297      * for(i=0 ; i<bitamount/64 ; i++)
298      *     (int64_t)out[i] = 0x37c511f237c511f2^be2me_64(int64_t)in[i]);
299      * Buffer alignment needs to be checked. */
300
301     off = (int)((long)inbuffer & 3);
302     buf = (uint32_t*) (inbuffer - off);
303     c = be2me_32((0x37c511f2 >> (off*8)) | (0x37c511f2 << (32-(off*8))));
304     bytes += 3 + off;
305     for (i = 0; i < bytes/4; i++)
306         obuf[i] = c ^ buf[i];
307
308     return off;
309 }
310
311 /**
312  * Cook uninit
313  */
314
315 static int cook_decode_close(AVCodecContext *avctx)
316 {
317     int i;
318     COOKContext *q = avctx->priv_data;
319     av_log(avctx,AV_LOG_DEBUG, "Deallocating memory.\n");
320
321     /* Free allocated memory buffers. */
322     av_free(q->mlt_window);
323     av_free(q->decoded_bytes_buffer);
324
325     /* Free the transform. */
326     ff_mdct_end(&q->mdct_ctx);
327
328     /* Free the VLC tables. */
329     for (i=0 ; i<13 ; i++) {
330         free_vlc(&q->envelope_quant_index[i]);
331     }
332     for (i=0 ; i<7 ; i++) {
333         free_vlc(&q->sqvh[i]);
334     }
335     if(q->nb_channels==2 && q->joint_stereo==1 ){
336         free_vlc(&q->ccpl);
337     }
338
339     av_log(NULL,AV_LOG_DEBUG,"Memory deallocated.\n");
340
341     return 0;
342 }
343
344 /**
345  * Fill the gain array for the timedomain quantization.
346  *
347  * @param q                 pointer to the COOKContext
348  * @param gaininfo[9]       array of gain indices
349  */
350
351 static void decode_gain_info(GetBitContext *gb, int *gaininfo)
352 {
353     int i, n;
354
355     while (get_bits1(gb)) {}
356     n = get_bits_count(gb) - 1;     //amount of elements*2 to update
357
358     i = 0;
359     while (n--) {
360         int index = get_bits(gb, 3);
361         int gain = get_bits1(gb) ? get_bits(gb, 4) - 7 : -1;
362
363         while (i <= index) gaininfo[i++] = gain;
364     }
365     while (i <= 8) gaininfo[i++] = 0;
366 }
367
368 /**
369  * Create the quant index table needed for the envelope.
370  *
371  * @param q                 pointer to the COOKContext
372  * @param quant_index_table pointer to the array
373  */
374
375 static void decode_envelope(COOKContext *q, int* quant_index_table) {
376     int i,j, vlc_index;
377
378     quant_index_table[0]= get_bits(&q->gb,6) - 6;       //This is used later in categorize
379
380     for (i=1 ; i < q->total_subbands ; i++){
381         vlc_index=i;
382         if (i >= q->js_subband_start * 2) {
383             vlc_index-=q->js_subband_start;
384         } else {
385             vlc_index/=2;
386             if(vlc_index < 1) vlc_index = 1;
387         }
388         if (vlc_index>13) vlc_index = 13;           //the VLC tables >13 are identical to No. 13
389
390         j = get_vlc2(&q->gb, q->envelope_quant_index[vlc_index-1].table,
391                      q->envelope_quant_index[vlc_index-1].bits,2);
392         quant_index_table[i] = quant_index_table[i-1] + j - 12;    //differential encoding
393     }
394 }
395
396 /**
397  * Calculate the category and category_index vector.
398  *
399  * @param q                     pointer to the COOKContext
400  * @param quant_index_table     pointer to the array
401  * @param category              pointer to the category array
402  * @param category_index        pointer to the category_index array
403  */
404
405 static void categorize(COOKContext *q, int* quant_index_table,
406                        int* category, int* category_index){
407     int exp_idx, bias, tmpbias1, tmpbias2, bits_left, num_bits, index, v, i, j;
408     int exp_index2[102];
409     int exp_index1[102];
410
411     int tmp_categorize_array[128*2];
412     int tmp_categorize_array1_idx=q->numvector_size;
413     int tmp_categorize_array2_idx=q->numvector_size;
414
415     bits_left =  q->bits_per_subpacket - get_bits_count(&q->gb);
416
417     if(bits_left > q->samples_per_channel) {
418         bits_left = q->samples_per_channel +
419                     ((bits_left - q->samples_per_channel)*5)/8;
420         //av_log(NULL, AV_LOG_ERROR, "bits_left = %d\n",bits_left);
421     }
422
423     memset(&exp_index1,0,102*sizeof(int));
424     memset(&exp_index2,0,102*sizeof(int));
425     memset(&tmp_categorize_array,0,128*2*sizeof(int));
426
427     bias=-32;
428
429     /* Estimate bias. */
430     for (i=32 ; i>0 ; i=i/2){
431         num_bits = 0;
432         index = 0;
433         for (j=q->total_subbands ; j>0 ; j--){
434             exp_idx = av_clip((i - quant_index_table[index] + bias) / 2, 0, 7);
435             index++;
436             num_bits+=expbits_tab[exp_idx];
437         }
438         if(num_bits >= bits_left - 32){
439             bias+=i;
440         }
441     }
442
443     /* Calculate total number of bits. */
444     num_bits=0;
445     for (i=0 ; i<q->total_subbands ; i++) {
446         exp_idx = av_clip((bias - quant_index_table[i]) / 2, 0, 7);
447         num_bits += expbits_tab[exp_idx];
448         exp_index1[i] = exp_idx;
449         exp_index2[i] = exp_idx;
450     }
451     tmpbias1 = tmpbias2 = num_bits;
452
453     for (j = 1 ; j < q->numvector_size ; j++) {
454         if (tmpbias1 + tmpbias2 > 2*bits_left) {  /* ---> */
455             int max = -999999;
456             index=-1;
457             for (i=0 ; i<q->total_subbands ; i++){
458                 if (exp_index1[i] < 7) {
459                     v = (-2*exp_index1[i]) - quant_index_table[i] + bias;
460                     if ( v >= max) {
461                         max = v;
462                         index = i;
463                     }
464                 }
465             }
466             if(index==-1)break;
467             tmp_categorize_array[tmp_categorize_array1_idx++] = index;
468             tmpbias1 -= expbits_tab[exp_index1[index]] -
469                         expbits_tab[exp_index1[index]+1];
470             ++exp_index1[index];
471         } else {  /* <--- */
472             int min = 999999;
473             index=-1;
474             for (i=0 ; i<q->total_subbands ; i++){
475                 if(exp_index2[i] > 0){
476                     v = (-2*exp_index2[i])-quant_index_table[i]+bias;
477                     if ( v < min) {
478                         min = v;
479                         index = i;
480                     }
481                 }
482             }
483             if(index == -1)break;
484             tmp_categorize_array[--tmp_categorize_array2_idx] = index;
485             tmpbias2 -= expbits_tab[exp_index2[index]] -
486                         expbits_tab[exp_index2[index]-1];
487             --exp_index2[index];
488         }
489     }
490
491     for(i=0 ; i<q->total_subbands ; i++)
492         category[i] = exp_index2[i];
493
494     for(i=0 ; i<q->numvector_size-1 ; i++)
495         category_index[i] = tmp_categorize_array[tmp_categorize_array2_idx++];
496
497 }
498
499
500 /**
501  * Expand the category vector.
502  *
503  * @param q                     pointer to the COOKContext
504  * @param category              pointer to the category array
505  * @param category_index        pointer to the category_index array
506  */
507
508 static inline void expand_category(COOKContext *q, int* category,
509                                    int* category_index){
510     int i;
511     for(i=0 ; i<q->num_vectors ; i++){
512         ++category[category_index[i]];
513     }
514 }
515
516 /**
517  * The real requantization of the mltcoefs
518  *
519  * @param q                     pointer to the COOKContext
520  * @param index                 index
521  * @param quant_index           quantisation index
522  * @param subband_coef_index    array of indexes to quant_centroid_tab
523  * @param subband_coef_sign     signs of coefficients
524  * @param mlt_p                 pointer into the mlt buffer
525  */
526
527 static void scalar_dequant(COOKContext *q, int index, int quant_index,
528                            int* subband_coef_index, int* subband_coef_sign,
529                            float* mlt_p){
530     int i;
531     float f1;
532
533     for(i=0 ; i<SUBBAND_SIZE ; i++) {
534         if (subband_coef_index[i]) {
535             f1 = quant_centroid_tab[index][subband_coef_index[i]];
536             if (subband_coef_sign[i]) f1 = -f1;
537         } else {
538             /* noise coding if subband_coef_index[i] == 0 */
539             f1 = dither_tab[index];
540             if (av_random(&q->random_state) < 0x80000000) f1 = -f1;
541         }
542         mlt_p[i] = f1 * q->rootpow2tab[quant_index+63];
543     }
544 }
545 /**
546  * Unpack the subband_coef_index and subband_coef_sign vectors.
547  *
548  * @param q                     pointer to the COOKContext
549  * @param category              pointer to the category array
550  * @param subband_coef_index    array of indexes to quant_centroid_tab
551  * @param subband_coef_sign     signs of coefficients
552  */
553
554 static int unpack_SQVH(COOKContext *q, int category, int* subband_coef_index,
555                        int* subband_coef_sign) {
556     int i,j;
557     int vlc, vd ,tmp, result;
558
559     vd = vd_tab[category];
560     result = 0;
561     for(i=0 ; i<vpr_tab[category] ; i++){
562         vlc = get_vlc2(&q->gb, q->sqvh[category].table, q->sqvh[category].bits, 3);
563         if (q->bits_per_subpacket < get_bits_count(&q->gb)){
564             vlc = 0;
565             result = 1;
566         }
567         for(j=vd-1 ; j>=0 ; j--){
568             tmp = (vlc * invradix_tab[category])/0x100000;
569             subband_coef_index[vd*i+j] = vlc - tmp * (kmax_tab[category]+1);
570             vlc = tmp;
571         }
572         for(j=0 ; j<vd ; j++){
573             if (subband_coef_index[i*vd + j]) {
574                 if(get_bits_count(&q->gb) < q->bits_per_subpacket){
575                     subband_coef_sign[i*vd+j] = get_bits1(&q->gb);
576                 } else {
577                     result=1;
578                     subband_coef_sign[i*vd+j]=0;
579                 }
580             } else {
581                 subband_coef_sign[i*vd+j]=0;
582             }
583         }
584     }
585     return result;
586 }
587
588
589 /**
590  * Fill the mlt_buffer with mlt coefficients.
591  *
592  * @param q                 pointer to the COOKContext
593  * @param category          pointer to the category array
594  * @param quant_index_table pointer to the array
595  * @param mlt_buffer        pointer to mlt coefficients
596  */
597
598
599 static void decode_vectors(COOKContext* q, int* category,
600                            int *quant_index_table, float* mlt_buffer){
601     /* A zero in this table means that the subband coefficient is
602        random noise coded. */
603     int subband_coef_index[SUBBAND_SIZE];
604     /* A zero in this table means that the subband coefficient is a
605        positive multiplicator. */
606     int subband_coef_sign[SUBBAND_SIZE];
607     int band, j;
608     int index=0;
609
610     for(band=0 ; band<q->total_subbands ; band++){
611         index = category[band];
612         if(category[band] < 7){
613             if(unpack_SQVH(q, category[band], subband_coef_index, subband_coef_sign)){
614                 index=7;
615                 for(j=0 ; j<q->total_subbands ; j++) category[band+j]=7;
616             }
617         }
618         if(index==7) {
619             memset(subband_coef_index, 0, sizeof(subband_coef_index));
620             memset(subband_coef_sign, 0, sizeof(subband_coef_sign));
621         }
622         q->scalar_dequant(q, index, quant_index_table[band],
623                        subband_coef_index, subband_coef_sign,
624                        &mlt_buffer[band * SUBBAND_SIZE]);
625     }
626
627     if(q->total_subbands*SUBBAND_SIZE >= q->samples_per_channel){
628         return;
629     } /* FIXME: should this be removed, or moved into loop above? */
630 }
631
632
633 /**
634  * function for decoding mono data
635  *
636  * @param q                 pointer to the COOKContext
637  * @param mlt_buffer        pointer to mlt coefficients
638  */
639
640 static void mono_decode(COOKContext *q, float* mlt_buffer) {
641
642     int category_index[128];
643     int quant_index_table[102];
644     int category[128];
645
646     memset(&category, 0, 128*sizeof(int));
647     memset(&category_index, 0, 128*sizeof(int));
648
649     decode_envelope(q, quant_index_table);
650     q->num_vectors = get_bits(&q->gb,q->log2_numvector_size);
651     categorize(q, quant_index_table, category, category_index);
652     expand_category(q, category, category_index);
653     decode_vectors(q, category, quant_index_table, mlt_buffer);
654 }
655
656
657 /**
658  * the actual requantization of the timedomain samples
659  *
660  * @param q                 pointer to the COOKContext
661  * @param buffer            pointer to the timedomain buffer
662  * @param gain_index        index for the block multiplier
663  * @param gain_index_next   index for the next block multiplier
664  */
665
666 static void interpolate(COOKContext *q, float* buffer,
667                         int gain_index, int gain_index_next){
668     int i;
669     float fc1, fc2;
670     fc1 = q->pow2tab[gain_index+63];
671
672     if(gain_index == gain_index_next){              //static gain
673         for(i=0 ; i<q->gain_size_factor ; i++){
674             buffer[i]*=fc1;
675         }
676         return;
677     } else {                                        //smooth gain
678         fc2 = q->gain_table[11 + (gain_index_next-gain_index)];
679         for(i=0 ; i<q->gain_size_factor ; i++){
680             buffer[i]*=fc1;
681             fc1*=fc2;
682         }
683         return;
684     }
685 }
686
687 /**
688  * Apply transform window, overlap buffers.
689  *
690  * @param q                 pointer to the COOKContext
691  * @param inbuffer          pointer to the mltcoefficients
692  * @param gains_ptr         current and previous gains
693  * @param previous_buffer   pointer to the previous buffer to be used for overlapping
694  */
695
696 static void imlt_window_float (COOKContext *q, float *buffer1,
697                                cook_gains *gains_ptr, float *previous_buffer)
698 {
699     const float fc = q->pow2tab[gains_ptr->previous[0] + 63];
700     int i;
701     /* The weird thing here, is that the two halves of the time domain
702      * buffer are swapped. Also, the newest data, that we save away for
703      * next frame, has the wrong sign. Hence the subtraction below.
704      * Almost sounds like a complex conjugate/reverse data/FFT effect.
705      */
706
707     /* Apply window and overlap */
708     for(i = 0; i < q->samples_per_channel; i++){
709         buffer1[i] = buffer1[i] * fc * q->mlt_window[i] -
710           previous_buffer[i] * q->mlt_window[q->samples_per_channel - 1 - i];
711     }
712 }
713
714 /**
715  * The modulated lapped transform, this takes transform coefficients
716  * and transforms them into timedomain samples.
717  * Apply transform window, overlap buffers, apply gain profile
718  * and buffer management.
719  *
720  * @param q                 pointer to the COOKContext
721  * @param inbuffer          pointer to the mltcoefficients
722  * @param gains_ptr         current and previous gains
723  * @param previous_buffer   pointer to the previous buffer to be used for overlapping
724  */
725
726 static void imlt_gain(COOKContext *q, float *inbuffer,
727                       cook_gains *gains_ptr, float* previous_buffer)
728 {
729     float *buffer0 = q->mono_mdct_output;
730     float *buffer1 = q->mono_mdct_output + q->samples_per_channel;
731     int i;
732
733     /* Inverse modified discrete cosine transform */
734     q->mdct_ctx.fft.imdct_calc(&q->mdct_ctx, q->mono_mdct_output,
735                                inbuffer, q->mdct_tmp);
736
737     q->imlt_window (q, buffer1, gains_ptr, previous_buffer);
738
739     /* Apply gain profile */
740     for (i = 0; i < 8; i++) {
741         if (gains_ptr->now[i] || gains_ptr->now[i + 1])
742             q->interpolate(q, &buffer1[q->gain_size_factor * i],
743                         gains_ptr->now[i], gains_ptr->now[i + 1]);
744     }
745
746     /* Save away the current to be previous block. */
747     memcpy(previous_buffer, buffer0, sizeof(float)*q->samples_per_channel);
748 }
749
750
751 /**
752  * function for getting the jointstereo coupling information
753  *
754  * @param q                 pointer to the COOKContext
755  * @param decouple_tab      decoupling array
756  *
757  */
758
759 static void decouple_info(COOKContext *q, int* decouple_tab){
760     int length, i;
761
762     if(get_bits1(&q->gb)) {
763         if(cplband[q->js_subband_start] > cplband[q->subbands-1]) return;
764
765         length = cplband[q->subbands-1] - cplband[q->js_subband_start] + 1;
766         for (i=0 ; i<length ; i++) {
767             decouple_tab[cplband[q->js_subband_start] + i] = get_vlc2(&q->gb, q->ccpl.table, q->ccpl.bits, 2);
768         }
769         return;
770     }
771
772     if(cplband[q->js_subband_start] > cplband[q->subbands-1]) return;
773
774     length = cplband[q->subbands-1] - cplband[q->js_subband_start] + 1;
775     for (i=0 ; i<length ; i++) {
776        decouple_tab[cplband[q->js_subband_start] + i] = get_bits(&q->gb, q->js_vlc_bits);
777     }
778     return;
779 }
780
781 /*
782  * function decouples a pair of signals from a single signal via multiplication.
783  *
784  * @param q                 pointer to the COOKContext
785  * @param subband           index of the current subband
786  * @param f1                multiplier for channel 1 extraction
787  * @param f2                multiplier for channel 2 extraction
788  * @param decode_buffer     input buffer
789  * @param mlt_buffer1       pointer to left channel mlt coefficients
790  * @param mlt_buffer2       pointer to right channel mlt coefficients
791  */
792 static void decouple_float (COOKContext *q,
793                             int subband,
794                             float f1, float f2,
795                             float *decode_buffer,
796                             float *mlt_buffer1, float *mlt_buffer2)
797 {
798     int j, tmp_idx;
799     for (j=0 ; j<SUBBAND_SIZE ; j++) {
800         tmp_idx = ((q->js_subband_start + subband)*SUBBAND_SIZE)+j;
801         mlt_buffer1[SUBBAND_SIZE*subband + j] = f1 * decode_buffer[tmp_idx];
802         mlt_buffer2[SUBBAND_SIZE*subband + j] = f2 * decode_buffer[tmp_idx];
803     }
804 }
805
806 /**
807  * function for decoding joint stereo data
808  *
809  * @param q                 pointer to the COOKContext
810  * @param mlt_buffer1       pointer to left channel mlt coefficients
811  * @param mlt_buffer2       pointer to right channel mlt coefficients
812  */
813
814 static void joint_decode(COOKContext *q, float* mlt_buffer1,
815                          float* mlt_buffer2) {
816     int i,j;
817     int decouple_tab[SUBBAND_SIZE];
818     float *decode_buffer = q->decode_buffer_0;
819     int idx, cpl_tmp,tmp_idx;
820     float f1,f2;
821     float* cplscale;
822
823     memset(decouple_tab, 0, sizeof(decouple_tab));
824     memset(decode_buffer, 0, sizeof(decode_buffer));
825
826     /* Make sure the buffers are zeroed out. */
827     memset(mlt_buffer1,0, 1024*sizeof(float));
828     memset(mlt_buffer2,0, 1024*sizeof(float));
829     decouple_info(q, decouple_tab);
830     mono_decode(q, decode_buffer);
831
832     /* The two channels are stored interleaved in decode_buffer. */
833     for (i=0 ; i<q->js_subband_start ; i++) {
834         for (j=0 ; j<SUBBAND_SIZE ; j++) {
835             mlt_buffer1[i*20+j] = decode_buffer[i*40+j];
836             mlt_buffer2[i*20+j] = decode_buffer[i*40+20+j];
837         }
838     }
839
840     /* When we reach js_subband_start (the higher frequencies)
841        the coefficients are stored in a coupling scheme. */
842     idx = (1 << q->js_vlc_bits) - 1;
843     for (i=q->js_subband_start ; i<q->subbands ; i++) {
844         cpl_tmp = cplband[i];
845         idx -=decouple_tab[cpl_tmp];
846         cplscale = (float*)cplscales[q->js_vlc_bits-2];  //choose decoupler table
847         f1 = cplscale[decouple_tab[cpl_tmp]];
848         f2 = cplscale[idx-1];
849         q->decouple (q, i, f1, f2, decode_buffer, mlt_buffer1, mlt_buffer2);
850         idx = (1 << q->js_vlc_bits) - 1;
851     }
852 }
853
854 /**
855  * First part of subpacket decoding:
856  *  decode raw stream bytes and read gain info.
857  *
858  * @param q                 pointer to the COOKContext
859  * @param inbuffer          pointer to raw stream data
860  * @param gain_ptr          array of current/prev gain pointers
861  */
862
863 static inline void
864 decode_bytes_and_gain(COOKContext *q, uint8_t *inbuffer,
865                       cook_gains *gains_ptr)
866 {
867     int offset;
868
869     offset = decode_bytes(inbuffer, q->decoded_bytes_buffer,
870                           q->bits_per_subpacket/8);
871     init_get_bits(&q->gb, q->decoded_bytes_buffer + offset,
872                   q->bits_per_subpacket);
873     decode_gain_info(&q->gb, gains_ptr->now);
874
875     /* Swap current and previous gains */
876     FFSWAP(int *, gains_ptr->now, gains_ptr->previous);
877 }
878
879  /**
880  * Saturate the output signal to signed 16bit integers.
881  *
882  * @param q                 pointer to the COOKContext
883  * @param chan              channel to saturate
884  * @param out               pointer to the output vector
885  */
886 static void
887 saturate_output_float (COOKContext *q, int chan, int16_t *out)
888 {
889     int j;
890     float_t *output = q->mono_mdct_output + q->samples_per_channel;
891     /* Clip and convert floats to 16 bits.
892      */
893     for (j = 0; j < q->samples_per_channel; j++) {
894         out[chan + q->nb_channels * j] =
895           av_clip(lrintf(output[j]), -32768, 32767);
896     }
897 }
898
899 /**
900  * Final part of subpacket decoding:
901  *  Apply modulated lapped transform, gain compensation,
902  *  clip and convert to integer.
903  *
904  * @param q                 pointer to the COOKContext
905  * @param decode_buffer     pointer to the mlt coefficients
906  * @param gain_ptr          array of current/prev gain pointers
907  * @param previous_buffer   pointer to the previous buffer to be used for overlapping
908  * @param out               pointer to the output buffer
909  * @param chan              0: left or single channel, 1: right channel
910  */
911
912 static inline void
913 mlt_compensate_output(COOKContext *q, float *decode_buffer,
914                       cook_gains *gains, float *previous_buffer,
915                       int16_t *out, int chan)
916 {
917     imlt_gain(q, decode_buffer, gains, previous_buffer);
918     q->saturate_output (q, chan, out);
919 }
920
921
922 /**
923  * Cook subpacket decoding. This function returns one decoded subpacket,
924  * usually 1024 samples per channel.
925  *
926  * @param q                 pointer to the COOKContext
927  * @param inbuffer          pointer to the inbuffer
928  * @param sub_packet_size   subpacket size
929  * @param outbuffer         pointer to the outbuffer
930  */
931
932
933 static int decode_subpacket(COOKContext *q, uint8_t *inbuffer,
934                             int sub_packet_size, int16_t *outbuffer) {
935     /* packet dump */
936 //    for (i=0 ; i<sub_packet_size ; i++) {
937 //        av_log(NULL, AV_LOG_ERROR, "%02x", inbuffer[i]);
938 //    }
939 //    av_log(NULL, AV_LOG_ERROR, "\n");
940
941     decode_bytes_and_gain(q, inbuffer, &q->gains1);
942
943     if (q->joint_stereo) {
944         joint_decode(q, q->decode_buffer_1, q->decode_buffer_2);
945     } else {
946         mono_decode(q, q->decode_buffer_1);
947
948         if (q->nb_channels == 2) {
949             decode_bytes_and_gain(q, inbuffer + sub_packet_size/2, &q->gains2);
950             mono_decode(q, q->decode_buffer_2);
951         }
952     }
953
954     mlt_compensate_output(q, q->decode_buffer_1, &q->gains1,
955                           q->mono_previous_buffer1, outbuffer, 0);
956
957     if (q->nb_channels == 2) {
958         if (q->joint_stereo) {
959             mlt_compensate_output(q, q->decode_buffer_2, &q->gains1,
960                                   q->mono_previous_buffer2, outbuffer, 1);
961         } else {
962             mlt_compensate_output(q, q->decode_buffer_2, &q->gains2,
963                                   q->mono_previous_buffer2, outbuffer, 1);
964         }
965     }
966     return q->samples_per_frame * sizeof(int16_t);
967 }
968
969
970 /**
971  * Cook frame decoding
972  *
973  * @param avctx     pointer to the AVCodecContext
974  */
975
976 static int cook_decode_frame(AVCodecContext *avctx,
977             void *data, int *data_size,
978             uint8_t *buf, int buf_size) {
979     COOKContext *q = avctx->priv_data;
980
981     if (buf_size < avctx->block_align)
982         return buf_size;
983
984     *data_size = decode_subpacket(q, buf, avctx->block_align, data);
985
986     /* Discard the first two frames: no valid audio. */
987     if (avctx->frame_number < 2) *data_size = 0;
988
989     return avctx->block_align;
990 }
991
992 #ifdef COOKDEBUG
993 static void dump_cook_context(COOKContext *q)
994 {
995     //int i=0;
996 #define PRINT(a,b) av_log(NULL,AV_LOG_ERROR," %s = %d\n", a, b);
997     av_log(NULL,AV_LOG_ERROR,"COOKextradata\n");
998     av_log(NULL,AV_LOG_ERROR,"cookversion=%x\n",q->cookversion);
999     if (q->cookversion > STEREO) {
1000         PRINT("js_subband_start",q->js_subband_start);
1001         PRINT("js_vlc_bits",q->js_vlc_bits);
1002     }
1003     av_log(NULL,AV_LOG_ERROR,"COOKContext\n");
1004     PRINT("nb_channels",q->nb_channels);
1005     PRINT("bit_rate",q->bit_rate);
1006     PRINT("sample_rate",q->sample_rate);
1007     PRINT("samples_per_channel",q->samples_per_channel);
1008     PRINT("samples_per_frame",q->samples_per_frame);
1009     PRINT("subbands",q->subbands);
1010     PRINT("random_state",q->random_state);
1011     PRINT("js_subband_start",q->js_subband_start);
1012     PRINT("log2_numvector_size",q->log2_numvector_size);
1013     PRINT("numvector_size",q->numvector_size);
1014     PRINT("total_subbands",q->total_subbands);
1015 }
1016 #endif
1017
1018 /**
1019  * Cook initialization
1020  *
1021  * @param avctx     pointer to the AVCodecContext
1022  */
1023
1024 static int cook_decode_init(AVCodecContext *avctx)
1025 {
1026     COOKContext *q = avctx->priv_data;
1027     uint8_t *edata_ptr = avctx->extradata;
1028
1029     /* Take care of the codec specific extradata. */
1030     if (avctx->extradata_size <= 0) {
1031         av_log(avctx,AV_LOG_ERROR,"Necessary extradata missing!\n");
1032         return -1;
1033     } else {
1034         /* 8 for mono, 16 for stereo, ? for multichannel
1035            Swap to right endianness so we don't need to care later on. */
1036         av_log(avctx,AV_LOG_DEBUG,"codecdata_length=%d\n",avctx->extradata_size);
1037         if (avctx->extradata_size >= 8){
1038             q->cookversion = bytestream_get_be32(&edata_ptr);
1039             q->samples_per_frame =  bytestream_get_be16(&edata_ptr);
1040             q->subbands = bytestream_get_be16(&edata_ptr);
1041         }
1042         if (avctx->extradata_size >= 16){
1043             bytestream_get_be32(&edata_ptr);    //Unknown unused
1044             q->js_subband_start = bytestream_get_be16(&edata_ptr);
1045             q->js_vlc_bits = bytestream_get_be16(&edata_ptr);
1046         }
1047     }
1048
1049     /* Take data from the AVCodecContext (RM container). */
1050     q->sample_rate = avctx->sample_rate;
1051     q->nb_channels = avctx->channels;
1052     q->bit_rate = avctx->bit_rate;
1053
1054     /* Initialize RNG. */
1055     av_init_random(1, &q->random_state);
1056
1057     /* Initialize extradata related variables. */
1058     q->samples_per_channel = q->samples_per_frame / q->nb_channels;
1059     q->bits_per_subpacket = avctx->block_align * 8;
1060
1061     /* Initialize default data states. */
1062     q->log2_numvector_size = 5;
1063     q->total_subbands = q->subbands;
1064
1065     /* Initialize version-dependent variables */
1066     av_log(NULL,AV_LOG_DEBUG,"q->cookversion=%x\n",q->cookversion);
1067     q->joint_stereo = 0;
1068     switch (q->cookversion) {
1069         case MONO:
1070             if (q->nb_channels != 1) {
1071                 av_log(avctx,AV_LOG_ERROR,"Container channels != 1, report sample!\n");
1072                 return -1;
1073             }
1074             av_log(avctx,AV_LOG_DEBUG,"MONO\n");
1075             break;
1076         case STEREO:
1077             if (q->nb_channels != 1) {
1078                 q->bits_per_subpacket = q->bits_per_subpacket/2;
1079             }
1080             av_log(avctx,AV_LOG_DEBUG,"STEREO\n");
1081             break;
1082         case JOINT_STEREO:
1083             if (q->nb_channels != 2) {
1084                 av_log(avctx,AV_LOG_ERROR,"Container channels != 2, report sample!\n");
1085                 return -1;
1086             }
1087             av_log(avctx,AV_LOG_DEBUG,"JOINT_STEREO\n");
1088             if (avctx->extradata_size >= 16){
1089                 q->total_subbands = q->subbands + q->js_subband_start;
1090                 q->joint_stereo = 1;
1091             }
1092             if (q->samples_per_channel > 256) {
1093                 q->log2_numvector_size  = 6;
1094             }
1095             if (q->samples_per_channel > 512) {
1096                 q->log2_numvector_size  = 7;
1097             }
1098             break;
1099         case MC_COOK:
1100             av_log(avctx,AV_LOG_ERROR,"MC_COOK not supported!\n");
1101             return -1;
1102             break;
1103         default:
1104             av_log(avctx,AV_LOG_ERROR,"Unknown Cook version, report sample!\n");
1105             return -1;
1106             break;
1107     }
1108
1109     /* Initialize variable relations */
1110     q->numvector_size = (1 << q->log2_numvector_size);
1111
1112     /* Generate tables */
1113     init_rootpow2table(q);
1114     init_pow2table(q);
1115     init_gain_table(q);
1116
1117     if (init_cook_vlc_tables(q) != 0)
1118         return -1;
1119
1120
1121     if(avctx->block_align >= UINT_MAX/2)
1122         return -1;
1123
1124     /* Pad the databuffer with:
1125        DECODE_BYTES_PAD1 or DECODE_BYTES_PAD2 for decode_bytes(),
1126        FF_INPUT_BUFFER_PADDING_SIZE, for the bitstreamreader. */
1127     if (q->nb_channels==2 && q->joint_stereo==0) {
1128         q->decoded_bytes_buffer =
1129           av_mallocz(avctx->block_align/2
1130                      + DECODE_BYTES_PAD2(avctx->block_align/2)
1131                      + FF_INPUT_BUFFER_PADDING_SIZE);
1132     } else {
1133         q->decoded_bytes_buffer =
1134           av_mallocz(avctx->block_align
1135                      + DECODE_BYTES_PAD1(avctx->block_align)
1136                      + FF_INPUT_BUFFER_PADDING_SIZE);
1137     }
1138     if (q->decoded_bytes_buffer == NULL)
1139         return -1;
1140
1141     q->gains1.now      = q->gain_1;
1142     q->gains1.previous = q->gain_2;
1143     q->gains2.now      = q->gain_3;
1144     q->gains2.previous = q->gain_4;
1145
1146     /* Initialize transform. */
1147     if ( init_cook_mlt(q) != 0 )
1148         return -1;
1149
1150     /* Initialize COOK signal arithmetic handling */
1151     if (1) {
1152         q->scalar_dequant  = scalar_dequant;
1153         q->decouple        = decouple_float;
1154         q->imlt_window     = imlt_window_float;
1155         q->interpolate     = interpolate;
1156         q->saturate_output = saturate_output_float;
1157     }
1158
1159     /* Try to catch some obviously faulty streams, othervise it might be exploitable */
1160     if (q->total_subbands > 53) {
1161         av_log(avctx,AV_LOG_ERROR,"total_subbands > 53, report sample!\n");
1162         return -1;
1163     }
1164     if (q->subbands > 50) {
1165         av_log(avctx,AV_LOG_ERROR,"subbands > 50, report sample!\n");
1166         return -1;
1167     }
1168     if ((q->samples_per_channel == 256) || (q->samples_per_channel == 512) || (q->samples_per_channel == 1024)) {
1169     } else {
1170         av_log(avctx,AV_LOG_ERROR,"unknown amount of samples_per_channel = %d, report sample!\n",q->samples_per_channel);
1171         return -1;
1172     }
1173     if ((q->js_vlc_bits > 6) || (q->js_vlc_bits < 0)) {
1174         av_log(avctx,AV_LOG_ERROR,"q->js_vlc_bits = %d, only >= 0 and <= 6 allowed!\n",q->js_vlc_bits);
1175         return -1;
1176     }
1177
1178 #ifdef COOKDEBUG
1179     dump_cook_context(q);
1180 #endif
1181     return 0;
1182 }
1183
1184
1185 AVCodec cook_decoder =
1186 {
1187     .name = "cook",
1188     .type = CODEC_TYPE_AUDIO,
1189     .id = CODEC_ID_COOK,
1190     .priv_data_size = sizeof(COOKContext),
1191     .init = cook_decode_init,
1192     .close = cook_decode_close,
1193     .decode = cook_decode_frame,
1194 };