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. Bastardization of the G.722.1 standard.
  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
 357     quant_index_table[0]= get_bits(&q->gb,6) - 6;       //This is used later in categorize
 358
 359     for (i=1 ; i < q->total_subbands ; i++){
 360         vlc_index=i;
 361         if (i >= q->js_subband_start * 2) {
 362             vlc_index-=q->js_subband_start;
 363         } else {
 364             vlc_index/=2;
 365             if(vlc_index < 1) vlc_index = 1;
 366         }
 367         if (vlc_index>13) vlc_index = 13;           //the VLC tables >13 are identical to No. 13
 368
 369         j = get_vlc2(&q->gb, q->envelope_quant_index[vlc_index-1].table,
 370                      q->envelope_quant_index[vlc_index-1].bits,2);
 371         quant_index_table[i] = quant_index_table[i-1] + j - 12;    //differential encoding
 372     }
 373 }
 374
 375 /**
 376  * Calculate the category and category_index vector.
 377  *
 378  * @param q                     pointer to the COOKContext
 379  * @param quant_index_table     pointer to the array
 380  * @param category              pointer to the category array
 381  * @param category_index        pointer to the category_index array
 382  */
 383
 384 static void categorize(COOKContext *q, int* quant_index_table,
 385                        int* category, int* category_index){
 386     int exp_idx, bias, tmpbias, bits_left, num_bits, index, v, i, j;
 387     int exp_index2[102];
 388     int exp_index1[102];
 389
 390     int tmp_categorize_array1[128];
 391     int tmp_categorize_array1_idx=0;
 392     int tmp_categorize_array2[128];
 393     int tmp_categorize_array2_idx=0;
 394     int category_index_size=0;
 395
 396     bits_left =  q->bits_per_subpacket - get_bits_count(&q->gb);
 397
 398     if(bits_left > q->samples_per_channel) {
 399         bits_left = q->samples_per_channel +
 400                     ((bits_left - q->samples_per_channel)*5)/8;
 401         //av_log(NULL, AV_LOG_ERROR, "bits_left = %d\n",bits_left);
 402     }
 403
 404     memset(&exp_index1,0,102*sizeof(int));
 405     memset(&exp_index2,0,102*sizeof(int));
 406     memset(&tmp_categorize_array1,0,128*sizeof(int));
 407     memset(&tmp_categorize_array2,0,128*sizeof(int));
 408
 409     bias=-32;
 410
 411     /* Estimate bias. */
 412     for (i=32 ; i>0 ; i=i/2){
 413         num_bits = 0;
 414         index = 0;
 415         for (j=q->total_subbands ; j>0 ; j--){
 416             exp_idx = av_clip((i - quant_index_table[index] + bias) / 2, 0, 7);
 417             index++;
 418             num_bits+=expbits_tab[exp_idx];
 419         }
 420         if(num_bits >= bits_left - 32){
 421             bias+=i;
 422         }
 423     }
 424
 425     /* Calculate total number of bits. */
 426     num_bits=0;
 427     for (i=0 ; i<q->total_subbands ; i++) {
 428         exp_idx = av_clip((bias - quant_index_table[i]) / 2, 0, 7);
 429         num_bits += expbits_tab[exp_idx];
 430         exp_index1[i] = exp_idx;
 431         exp_index2[i] = exp_idx;
 432     }
 433     tmpbias = bias = num_bits;
 434
 435     for (j = 1 ; j < q->numvector_size ; j++) {
 436         if (tmpbias + bias > 2*bits_left) {  /* ---> */
 437             int max = -999999;
 438             index=-1;
 439             for (i=0 ; i<q->total_subbands ; i++){
 440                 if (exp_index1[i] < 7) {
 441                     v = (-2*exp_index1[i]) - quant_index_table[i] - 32;
 442                     if ( v >= max) {
 443                         max = v;
 444                         index = i;
 445                     }
 446                 }
 447             }
 448             if(index==-1)break;
 449             tmp_categorize_array1[tmp_categorize_array1_idx++] = index;
 450             tmpbias -= expbits_tab[exp_index1[index]] -
 451                        expbits_tab[exp_index1[index]+1];
 452             ++exp_index1[index];
 453         } else {  /* <--- */
 454             int min = 999999;
 455             index=-1;
 456             for (i=0 ; i<q->total_subbands ; i++){
 457                 if(exp_index2[i] > 0){
 458                     v = (-2*exp_index2[i])-quant_index_table[i];
 459                     if ( v < min) {
 460                         min = v;
 461                         index = i;
 462                     }
 463                 }
 464             }
 465             if(index == -1)break;
 466             tmp_categorize_array2[tmp_categorize_array2_idx++] = index;
 467             tmpbias -= expbits_tab[exp_index2[index]] -
 468                        expbits_tab[exp_index2[index]-1];
 469             --exp_index2[index];
 470         }
 471     }
 472
 473     for(i=0 ; i<q->total_subbands ; i++)
 474         category[i] = exp_index2[i];
 475
 476     /* Concatenate the two arrays. */
 477     for(i=tmp_categorize_array2_idx-1 ; i >= 0; i--)
 478         category_index[category_index_size++] =  tmp_categorize_array2[i];
 479
 480     for(i=0;i<tmp_categorize_array1_idx;i++)
 481         category_index[category_index_size++ ] =  tmp_categorize_array1[i];
 482
 483     /* FIXME: mc_sich_ra8_20.rm triggers this, not sure with what we
 484        should fill the remaining bytes. */
 485     for(i=category_index_size;i<q->numvector_size;i++)
 486         category_index[i]=0;
 487
 488 }
 489
 490
 491 /**
 492  * Expand the category vector.
 493  *
 494  * @param q                     pointer to the COOKContext
 495  * @param category              pointer to the category array
 496  * @param category_index        pointer to the category_index array
 497  */
 498
 499 static inline void expand_category(COOKContext *q, int* category,
 500                                    int* category_index){
 501     int i;
 502     for(i=0 ; i<q->num_vectors ; i++){
 503         ++category[category_index[i]];
 504     }
 505 }
 506
 507 /**
 508  * The real requantization of the mltcoefs
 509  *
 510  * @param q                     pointer to the COOKContext
 511  * @param index                 index
 512  * @param quant_index           quantisation index
 513  * @param subband_coef_index    array of indexes to quant_centroid_tab
 514  * @param subband_coef_sign     signs of coefficients
 515  * @param mlt_p                 pointer into the mlt buffer
 516  */
 517
 518 static void scalar_dequant(COOKContext *q, int index, int quant_index,
 519                            int* subband_coef_index, int* subband_coef_sign,
 520                            float* mlt_p){
 521     int i;
 522     float f1;
 523
 524     for(i=0 ; i<SUBBAND_SIZE ; i++) {
 525         if (subband_coef_index[i]) {
 526             f1 = quant_centroid_tab[index][subband_coef_index[i]];
 527             if (subband_coef_sign[i]) f1 = -f1;
 528         } else {
 529             /* noise coding if subband_coef_index[i] == 0 */
 530             f1 = dither_tab[index];
 531             if (av_random(&q->random_state) < 0x80000000) f1 = -f1;
 532         }
 533         mlt_p[i] = f1 * q->rootpow2tab[quant_index+63];
 534     }
 535 }
 536 /**
 537  * Unpack the subband_coef_index and subband_coef_sign vectors.
 538  *
 539  * @param q                     pointer to the COOKContext
 540  * @param category              pointer to the category array
 541  * @param subband_coef_index    array of indexes to quant_centroid_tab
 542  * @param subband_coef_sign     signs of coefficients
 543  */
 544
 545 static int unpack_SQVH(COOKContext *q, int category, int* subband_coef_index,
 546                        int* subband_coef_sign) {
 547     int i,j;
 548     int vlc, vd ,tmp, result;
 549
 550     vd = vd_tab[category];
 551     result = 0;
 552     for(i=0 ; i<vpr_tab[category] ; i++){
 553         vlc = get_vlc2(&q->gb, q->sqvh[category].table, q->sqvh[category].bits, 3);
 554         if (q->bits_per_subpacket < get_bits_count(&q->gb)){
 555             vlc = 0;
 556             result = 1;
 557         }
 558         for(j=vd-1 ; j>=0 ; j--){
 559             tmp = (vlc * invradix_tab[category])/0x100000;
 560             subband_coef_index[vd*i+j] = vlc - tmp * (kmax_tab[category]+1);
 561             vlc = tmp;
 562         }
 563         for(j=0 ; j<vd ; j++){
 564             if (subband_coef_index[i*vd + j]) {
 565                 if(get_bits_count(&q->gb) < q->bits_per_subpacket){
 566                     subband_coef_sign[i*vd+j] = get_bits1(&q->gb);
 567                 } else {
 568                     result=1;
 569                     subband_coef_sign[i*vd+j]=0;
 570                 }
 571             } else {
 572                 subband_coef_sign[i*vd+j]=0;
 573             }
 574         }
 575     }
 576     return result;
 577 }
 578
 579
 580 /**
 581  * Fill the mlt_buffer with mlt coefficients.
 582  *
 583  * @param q                 pointer to the COOKContext
 584  * @param category          pointer to the category array
 585  * @param quant_index_table pointer to the array
 586  * @param mlt_buffer        pointer to mlt coefficients
 587  */
 588
 589
 590 static void decode_vectors(COOKContext* q, int* category,
 591                            int *quant_index_table, float* mlt_buffer){
 592     /* A zero in this table means that the subband coefficient is
 593        random noise coded. */
 594     int subband_coef_index[SUBBAND_SIZE];
 595     /* A zero in this table means that the subband coefficient is a
 596        positive multiplicator. */
 597     int subband_coef_sign[SUBBAND_SIZE];
 598     int band, j;
 599     int index=0;
 600
 601     for(band=0 ; band<q->total_subbands ; band++){
 602         index = category[band];
 603         if(category[band] < 7){
 604             if(unpack_SQVH(q, category[band], subband_coef_index, subband_coef_sign)){
 605                 index=7;
 606                 for(j=0 ; j<q->total_subbands ; j++) category[band+j]=7;
 607             }
 608         }
 609         if(index==7) {
 610             memset(subband_coef_index, 0, sizeof(subband_coef_index));
 611             memset(subband_coef_sign, 0, sizeof(subband_coef_sign));
 612         }
 613         scalar_dequant(q, index, quant_index_table[band],
 614                        subband_coef_index, subband_coef_sign,
 615                        &mlt_buffer[band * 20]);
 616     }
 617
 618     if(q->total_subbands*SUBBAND_SIZE >= q->samples_per_channel){
 619         return;
 620     } /* FIXME: should this be removed, or moved into loop above? */
 621 }
 622
 623
 624 /**
 625  * function for decoding mono data
 626  *
 627  * @param q                 pointer to the COOKContext
 628  * @param mlt_buffer        pointer to mlt coefficients
 629  */
 630
 631 static void mono_decode(COOKContext *q, float* mlt_buffer) {
 632
 633     int category_index[128];
 634     int quant_index_table[102];
 635     int category[128];
 636
 637     memset(&category, 0, 128*sizeof(int));
 638     memset(&category_index, 0, 128*sizeof(int));
 639
 640     decode_envelope(q, quant_index_table);
 641     q->num_vectors = get_bits(&q->gb,q->log2_numvector_size);
 642     categorize(q, quant_index_table, category, category_index);
 643     expand_category(q, category, category_index);
 644     decode_vectors(q, category, quant_index_table, mlt_buffer);
 645 }
 646
 647
 648 /**
 649  * the actual requantization of the timedomain samples
 650  *
 651  * @param q                 pointer to the COOKContext
 652  * @param buffer            pointer to the timedomain buffer
 653  * @param gain_index        index for the block multiplier
 654  * @param gain_index_next   index for the next block multiplier
 655  */
 656
 657 static void interpolate(COOKContext *q, float* buffer,
 658                         int gain_index, int gain_index_next){
 659     int i;
 660     float fc1, fc2;
 661     fc1 = q->pow2tab[gain_index+63];
 662
 663     if(gain_index == gain_index_next){              //static gain
 664         for(i=0 ; i<q->gain_size_factor ; i++){
 665             buffer[i]*=fc1;
 666         }
 667         return;
 668     } else {                                        //smooth gain
 669         fc2 = q->gain_table[11 + (gain_index_next-gain_index)];
 670         for(i=0 ; i<q->gain_size_factor ; i++){
 671             buffer[i]*=fc1;
 672             fc1*=fc2;
 673         }
 674         return;
 675     }
 676 }
 677
 678
 679 /**
 680  * The modulated lapped transform, this takes transform coefficients
 681  * and transforms them into timedomain samples.
 682  * Apply transform window, overlap buffers, apply gain profile
 683  * and buffer management.
 684  *
 685  * @param q                 pointer to the COOKContext
 686  * @param inbuffer          pointer to the mltcoefficients
 687  * @param gains_ptr         current and previous gains
 688  * @param previous_buffer   pointer to the previous buffer to be used for overlapping
 689  */
 690
 691 static void imlt_gain(COOKContext *q, float *inbuffer,
 692                       cook_gains *gains_ptr, float* previous_buffer)
 693 {
 694     const float fc = q->pow2tab[gains_ptr->previous[0] + 63];
 695     float *buffer0 = q->mono_mdct_output;
 696     float *buffer1 = q->mono_mdct_output + q->samples_per_channel;
 697     int i;
 698
 699     /* Inverse modified discrete cosine transform */
 700     q->mdct_ctx.fft.imdct_calc(&q->mdct_ctx, q->mono_mdct_output,
 701                                inbuffer, q->mdct_tmp);
 702
 703     /* The weird thing here, is that the two halves of the time domain
 704      * buffer are swapped. Also, the newest data, that we save away for
 705      * next frame, has the wrong sign. Hence the subtraction below.
 706      * Almost sounds like a complex conjugate/reverse data/FFT effect.
 707      */
 708
 709     /* Apply window and overlap */
 710     for(i = 0; i < q->samples_per_channel; i++){
 711         buffer1[i] = buffer1[i] * fc * q->mlt_window[i] -
 712           previous_buffer[i] * q->mlt_window[q->samples_per_channel - 1 - i];
 713     }
 714
 715     /* Apply gain profile */
 716     for (i = 0; i < 8; i++) {
 717         if (gains_ptr->now[i] || gains_ptr->now[i + 1])
 718             interpolate(q, &buffer1[q->gain_size_factor * i],
 719                         gains_ptr->now[i], gains_ptr->now[i + 1]);
 720     }
 721
 722     /* Save away the current to be previous block. */
 723     memcpy(previous_buffer, buffer0, sizeof(float)*q->samples_per_channel);
 724 }
 725
 726
 727 /**
 728  * function for getting the jointstereo coupling information
 729  *
 730  * @param q                 pointer to the COOKContext
 731  * @param decouple_tab      decoupling array
 732  *
 733  */
 734
 735 static void decouple_info(COOKContext *q, int* decouple_tab){
 736     int length, i;
 737
 738     if(get_bits1(&q->gb)) {
 739         if(cplband[q->js_subband_start] > cplband[q->subbands-1]) return;
 740
 741         length = cplband[q->subbands-1] - cplband[q->js_subband_start] + 1;
 742         for (i=0 ; i<length ; i++) {
 743             decouple_tab[cplband[q->js_subband_start] + i] = get_vlc2(&q->gb, q->ccpl.table, q->ccpl.bits, 2);
 744         }
 745         return;
 746     }
 747
 748     if(cplband[q->js_subband_start] > cplband[q->subbands-1]) return;
 749
 750     length = cplband[q->subbands-1] - cplband[q->js_subband_start] + 1;
 751     for (i=0 ; i<length ; i++) {
 752        decouple_tab[cplband[q->js_subband_start] + i] = get_bits(&q->gb, q->js_vlc_bits);
 753     }
 754     return;
 755 }
 756
 757
 758 /**
 759  * function for decoding joint stereo data
 760  *
 761  * @param q                 pointer to the COOKContext
 762  * @param mlt_buffer1       pointer to left channel mlt coefficients
 763  * @param mlt_buffer2       pointer to right channel mlt coefficients
 764  */
 765
 766 static void joint_decode(COOKContext *q, float* mlt_buffer1,
 767                          float* mlt_buffer2) {
 768     int i,j;
 769     int decouple_tab[SUBBAND_SIZE];
 770     float decode_buffer[1060];
 771     int idx, cpl_tmp,tmp_idx;
 772     float f1,f2;
 773     float* cplscale;
 774
 775     memset(decouple_tab, 0, sizeof(decouple_tab));
 776     memset(decode_buffer, 0, sizeof(decode_buffer));
 777
 778     /* Make sure the buffers are zeroed out. */
 779     memset(mlt_buffer1,0, 1024*sizeof(float));
 780     memset(mlt_buffer2,0, 1024*sizeof(float));
 781     decouple_info(q, decouple_tab);
 782     mono_decode(q, decode_buffer);
 783
 784     /* The two channels are stored interleaved in decode_buffer. */
 785     for (i=0 ; i<q->js_subband_start ; i++) {
 786         for (j=0 ; j<SUBBAND_SIZE ; j++) {
 787             mlt_buffer1[i*20+j] = decode_buffer[i*40+j];
 788             mlt_buffer2[i*20+j] = decode_buffer[i*40+20+j];
 789         }
 790     }
 791
 792     /* When we reach js_subband_start (the higher frequencies)
 793        the coefficients are stored in a coupling scheme. */
 794     idx = (1 << q->js_vlc_bits) - 1;
 795     for (i=q->js_subband_start ; i<q->subbands ; i++) {
 796         cpl_tmp = cplband[i];
 797         idx -=decouple_tab[cpl_tmp];
 798         cplscale = (float*)cplscales[q->js_vlc_bits-2];  //choose decoupler table
 799         f1 = cplscale[decouple_tab[cpl_tmp]];
 800         f2 = cplscale[idx-1];
 801         for (j=0 ; j<SUBBAND_SIZE ; j++) {
 802             tmp_idx = ((q->js_subband_start + i)*20)+j;
 803             mlt_buffer1[20*i + j] = f1 * decode_buffer[tmp_idx];
 804             mlt_buffer2[20*i + j] = f2 * decode_buffer[tmp_idx];
 805         }
 806         idx = (1 << q->js_vlc_bits) - 1;
 807     }
 808 }
 809
 810 /**
 811  * First part of subpacket decoding:
 812  *  decode raw stream bytes and read gain info.
 813  *
 814  * @param q                 pointer to the COOKContext
 815  * @param inbuffer          pointer to raw stream data
 816  * @param gain_ptr          array of current/prev gain pointers
 817  */
 818
 819 static inline void
 820 decode_bytes_and_gain(COOKContext *q, uint8_t *inbuffer,
 821                       cook_gains *gains_ptr)
 822 {
 823     int offset;
 824
 825     offset = decode_bytes(inbuffer, q->decoded_bytes_buffer,
 826                           q->bits_per_subpacket/8);
 827     init_get_bits(&q->gb, q->decoded_bytes_buffer + offset,
 828                   q->bits_per_subpacket);
 829     decode_gain_info(&q->gb, gains_ptr->now);
 830
 831     /* Swap current and previous gains */
 832     FFSWAP(int *, gains_ptr->now, gains_ptr->previous);
 833 }
 834
 835 /**
 836  * Final part of subpacket decoding:
 837  *  Apply modulated lapped transform, gain compensation,
 838  *  clip and convert to integer.
 839  *
 840  * @param q                 pointer to the COOKContext
 841  * @param decode_buffer     pointer to the mlt coefficients
 842  * @param gain_ptr          array of current/prev gain pointers
 843  * @param previous_buffer   pointer to the previous buffer to be used for overlapping
 844  * @param out               pointer to the output buffer
 845  * @param chan              0: left or single channel, 1: right channel
 846  */
 847
 848 static inline void
 849 mlt_compensate_output(COOKContext *q, float *decode_buffer,
 850                       cook_gains *gains, float *previous_buffer,
 851                       int16_t *out, int chan)
 852 {
 853     float *output = q->mono_mdct_output + q->samples_per_channel;
 854     int j;
 855
 856     imlt_gain(q, decode_buffer, gains, previous_buffer);
 857
 858     /* Clip and convert floats to 16 bits.
 859      */
 860     for (j = 0; j < q->samples_per_channel; j++) {
 861         out[chan + q->nb_channels * j] =
 862           av_clip(lrintf(output[j]), -32768, 32767);
 863     }
 864 }
 865
 866
 867 /**
 868  * Cook subpacket decoding. This function returns one decoded subpacket,
 869  * usually 1024 samples per channel.
 870  *
 871  * @param q                 pointer to the COOKContext
 872  * @param inbuffer          pointer to the inbuffer
 873  * @param sub_packet_size   subpacket size
 874  * @param outbuffer         pointer to the outbuffer
 875  */
 876
 877
 878 static int decode_subpacket(COOKContext *q, uint8_t *inbuffer,
 879                             int sub_packet_size, int16_t *outbuffer) {
 880     /* packet dump */
 881 //    for (i=0 ; i<sub_packet_size ; i++) {
 882 //        av_log(NULL, AV_LOG_ERROR, "%02x", inbuffer[i]);
 883 //    }
 884 //    av_log(NULL, AV_LOG_ERROR, "\n");
 885
 886     decode_bytes_and_gain(q, inbuffer, &q->gains1);
 887
 888     if (q->joint_stereo) {
 889         joint_decode(q, q->decode_buffer_1, q->decode_buffer_2);
 890     } else {
 891         mono_decode(q, q->decode_buffer_1);
 892
 893         if (q->nb_channels == 2) {
 894             decode_bytes_and_gain(q, inbuffer + sub_packet_size/2, &q->gains2);
 895             mono_decode(q, q->decode_buffer_2);
 896         }
 897     }
 898
 899     mlt_compensate_output(q, q->decode_buffer_1, &q->gains1,
 900                           q->mono_previous_buffer1, outbuffer, 0);
 901
 902     if (q->nb_channels == 2) {
 903         if (q->joint_stereo) {
 904             mlt_compensate_output(q, q->decode_buffer_2, &q->gains1,
 905                                   q->mono_previous_buffer2, outbuffer, 1);
 906         } else {
 907             mlt_compensate_output(q, q->decode_buffer_2, &q->gains2,
 908                                   q->mono_previous_buffer2, outbuffer, 1);
 909         }
 910     }
 911     return q->samples_per_frame * sizeof(int16_t);
 912 }
 913
 914
 915 /**
 916  * Cook frame decoding
 917  *
 918  * @param avctx     pointer to the AVCodecContext
 919  */
 920
 921 static int cook_decode_frame(AVCodecContext *avctx,
 922             void *data, int *data_size,
 923             uint8_t *buf, int buf_size) {
 924     COOKContext *q = avctx->priv_data;
 925
 926     if (buf_size < avctx->block_align)
 927         return buf_size;
 928
 929     *data_size = decode_subpacket(q, buf, avctx->block_align, data);
 930
 931     /* Discard the first two frames: no valid audio. */
 932     if (avctx->frame_number < 2) *data_size = 0;
 933
 934     return avctx->block_align;
 935 }
 936
 937 #ifdef COOKDEBUG
 938 static void dump_cook_context(COOKContext *q)
 939 {
 940     //int i=0;
 941 #define PRINT(a,b) av_log(NULL,AV_LOG_ERROR," %s = %d\n", a, b);
 942     av_log(NULL,AV_LOG_ERROR,"COOKextradata\n");
 943     av_log(NULL,AV_LOG_ERROR,"cookversion=%x\n",q->cookversion);
 944     if (q->cookversion > STEREO) {
 945         PRINT("js_subband_start",q->js_subband_start);
 946         PRINT("js_vlc_bits",q->js_vlc_bits);
 947     }
 948     av_log(NULL,AV_LOG_ERROR,"COOKContext\n");
 949     PRINT("nb_channels",q->nb_channels);
 950     PRINT("bit_rate",q->bit_rate);
 951     PRINT("sample_rate",q->sample_rate);
 952     PRINT("samples_per_channel",q->samples_per_channel);
 953     PRINT("samples_per_frame",q->samples_per_frame);
 954     PRINT("subbands",q->subbands);
 955     PRINT("random_state",q->random_state);
 956     PRINT("js_subband_start",q->js_subband_start);
 957     PRINT("log2_numvector_size",q->log2_numvector_size);
 958     PRINT("numvector_size",q->numvector_size);
 959     PRINT("total_subbands",q->total_subbands);
 960 }
 961 #endif
 962
 963 /**
 964  * Cook initialization
 965  *
 966  * @param avctx     pointer to the AVCodecContext
 967  */
 968
 969 static int cook_decode_init(AVCodecContext *avctx)
 970 {
 971     COOKContext *q = avctx->priv_data;
 972     uint8_t *edata_ptr = avctx->extradata;
 973
 974     /* Take care of the codec specific extradata. */
 975     if (avctx->extradata_size <= 0) {
 976         av_log(avctx,AV_LOG_ERROR,"Necessary extradata missing!\n");
 977         return -1;
 978     } else {
 979         /* 8 for mono, 16 for stereo, ? for multichannel
 980            Swap to right endianness so we don't need to care later on. */
 981         av_log(avctx,AV_LOG_DEBUG,"codecdata_length=%d\n",avctx->extradata_size);
 982         if (avctx->extradata_size >= 8){
 983             q->cookversion = bytestream_get_be32(&edata_ptr);
 984             q->samples_per_frame =  bytestream_get_be16(&edata_ptr);
 985             q->subbands = bytestream_get_be16(&edata_ptr);
 986         }
 987         if (avctx->extradata_size >= 16){
 988             bytestream_get_be32(&edata_ptr);    //Unknown unused
 989             q->js_subband_start = bytestream_get_be16(&edata_ptr);
 990             q->js_vlc_bits = bytestream_get_be16(&edata_ptr);
 991         }
 992     }
 993
 994     /* Take data from the AVCodecContext (RM container). */
 995     q->sample_rate = avctx->sample_rate;
 996     q->nb_channels = avctx->channels;
 997     q->bit_rate = avctx->bit_rate;
 998
 999     /* Initialize RNG. */
1000     av_init_random(1, &q->random_state);
1001
1002     /* Initialize extradata related variables. */
1003     q->samples_per_channel = q->samples_per_frame / q->nb_channels;
1004     q->bits_per_subpacket = avctx->block_align * 8;
1005
1006     /* Initialize default data states. */
1007     q->log2_numvector_size = 5;
1008     q->total_subbands = q->subbands;
1009
1010     /* Initialize version-dependent variables */
1011     av_log(NULL,AV_LOG_DEBUG,"q->cookversion=%x\n",q->cookversion);
1012     q->joint_stereo = 0;
1013     switch (q->cookversion) {
1014         case MONO:
1015             if (q->nb_channels != 1) {
1016                 av_log(avctx,AV_LOG_ERROR,"Container channels != 1, report sample!\n");
1017                 return -1;
1018             }
1019             av_log(avctx,AV_LOG_DEBUG,"MONO\n");
1020             break;
1021         case STEREO:
1022             if (q->nb_channels != 1) {
1023                 q->bits_per_subpacket = q->bits_per_subpacket/2;
1024             }
1025             av_log(avctx,AV_LOG_DEBUG,"STEREO\n");
1026             break;
1027         case JOINT_STEREO:
1028             if (q->nb_channels != 2) {
1029                 av_log(avctx,AV_LOG_ERROR,"Container channels != 2, report sample!\n");
1030                 return -1;
1031             }
1032             av_log(avctx,AV_LOG_DEBUG,"JOINT_STEREO\n");
1033             if (avctx->extradata_size >= 16){
1034                 q->total_subbands = q->subbands + q->js_subband_start;
1035                 q->joint_stereo = 1;
1036             }
1037             if (q->samples_per_channel > 256) {
1038                 q->log2_numvector_size  = 6;
1039             }
1040             if (q->samples_per_channel > 512) {
1041                 q->log2_numvector_size  = 7;
1042             }
1043             break;
1044         case MC_COOK:
1045             av_log(avctx,AV_LOG_ERROR,"MC_COOK not supported!\n");
1046             return -1;
1047             break;
1048         default:
1049             av_log(avctx,AV_LOG_ERROR,"Unknown Cook version, report sample!\n");
1050             return -1;
1051             break;
1052     }
1053
1054     /* Initialize variable relations */
1055     q->numvector_size = (1 << q->log2_numvector_size);
1056
1057     /* Generate tables */
1058     init_rootpow2table(q);
1059     init_pow2table(q);
1060     init_gain_table(q);
1061
1062     if (init_cook_vlc_tables(q) != 0)
1063         return -1;
1064
1065
1066     if(avctx->block_align >= UINT_MAX/2)
1067         return -1;
1068
1069     /* Pad the databuffer with:
1070        DECODE_BYTES_PAD1 or DECODE_BYTES_PAD2 for decode_bytes(),
1071        FF_INPUT_BUFFER_PADDING_SIZE, for the bitstreamreader. */
1072     if (q->nb_channels==2 && q->joint_stereo==0) {
1073         q->decoded_bytes_buffer =
1074           av_mallocz(avctx->block_align/2
1075                      + DECODE_BYTES_PAD2(avctx->block_align/2)
1076                      + FF_INPUT_BUFFER_PADDING_SIZE);
1077     } else {
1078         q->decoded_bytes_buffer =
1079           av_mallocz(avctx->block_align
1080                      + DECODE_BYTES_PAD1(avctx->block_align)
1081                      + FF_INPUT_BUFFER_PADDING_SIZE);
1082     }
1083     if (q->decoded_bytes_buffer == NULL)
1084         return -1;
1085
1086     q->gains1.now      = q->gain_1;
1087     q->gains1.previous = q->gain_2;
1088     q->gains2.now      = q->gain_3;
1089     q->gains2.previous = q->gain_4;
1090
1091     /* Initialize transform. */
1092     if ( init_cook_mlt(q) != 0 )
1093         return -1;
1094
1095     /* Try to catch some obviously faulty streams, othervise it might be exploitable */
1096     if (q->total_subbands > 53) {
1097         av_log(avctx,AV_LOG_ERROR,"total_subbands > 53, report sample!\n");
1098         return -1;
1099     }
1100     if (q->subbands > 50) {
1101         av_log(avctx,AV_LOG_ERROR,"subbands > 50, report sample!\n");
1102         return -1;
1103     }
1104     if ((q->samples_per_channel == 256) || (q->samples_per_channel == 512) || (q->samples_per_channel == 1024)) {
1105     } else {
1106         av_log(avctx,AV_LOG_ERROR,"unknown amount of samples_per_channel = %d, report sample!\n",q->samples_per_channel);
1107         return -1;
1108     }
1109     if ((q->js_vlc_bits > 6) || (q->js_vlc_bits < 0)) {
1110         av_log(avctx,AV_LOG_ERROR,"q->js_vlc_bits = %d, only >= 0 and <= 6 allowed!\n",q->js_vlc_bits);
1111         return -1;
1112     }
1113
1114 #ifdef COOKDEBUG
1115     dump_cook_context(q);
1116 #endif
1117     return 0;
1118 }
1119
1120
1121 AVCodec cook_decoder =
1122 {
1123     .name = "cook",
1124     .type = CODEC_TYPE_AUDIO,
1125     .id = CODEC_ID_COOK,
1126     .priv_data_size = sizeof(COOKContext),
1127     .init = cook_decode_init,
1128     .close = cook_decode_close,
1129     .decode = cook_decode_frame,
1130 };