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