2 * COOK compatible decoder
3 * Copyright (c) 2003 Sascha Sommer
4 * Copyright (c) 2005 Benjamin Larsson
6 * This file is part of Libav.
8 * Libav 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.
13 * Libav 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.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with Libav; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
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.
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).
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
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
49 #include "libavutil/lfg.h"
50 #include "libavutil/random_seed.h"
54 #include "bytestream.h"
56 #include "libavutil/audioconvert.h"
61 /* the different Cook versions */
62 #define MONO 0x1000001
63 #define STEREO 0x1000002
64 #define JOINT_STEREO 0x1000003
65 #define MC_COOK 0x2000000 //multichannel Cook, not supported
67 #define SUBBAND_SIZE 20
68 #define MAX_SUBPACKETS 5
80 int samples_per_frame;
84 int samples_per_channel;
85 int log2_numvector_size;
86 unsigned int channel_mask;
87 VLC ccpl; ///< channel coupling
89 int bits_per_subpacket;
92 int numvector_size; ///< 1 << log2_numvector_size;
94 float mono_previous_buffer1[1024];
95 float mono_previous_buffer2[1024];
105 typedef struct cook {
107 * The following 5 functions provide the lowlevel arithmetic on
108 * the internal audio buffers.
110 void (* scalar_dequant)(struct cook *q, int index, int quant_index,
111 int* subband_coef_index, int* subband_coef_sign,
114 void (* decouple) (struct cook *q,
118 float *decode_buffer,
119 float *mlt_buffer1, float *mlt_buffer2);
121 void (* imlt_window) (struct cook *q, float *buffer1,
122 cook_gains *gains_ptr, float *previous_buffer);
124 void (* interpolate) (struct cook *q, float* buffer,
125 int gain_index, int gain_index_next);
127 void (* saturate_output) (struct cook *q, int chan, int16_t *out);
129 AVCodecContext* avctx;
136 int samples_per_channel;
145 VLC envelope_quant_index[13];
146 VLC sqvh[7]; //scalar quantization
148 /* generatable tables and related variables */
149 int gain_size_factor;
150 float gain_table[23];
154 uint8_t* decoded_bytes_buffer;
155 DECLARE_ALIGNED(32, float, mono_mdct_output)[2048];
156 float decode_buffer_1[1024];
157 float decode_buffer_2[1024];
158 float decode_buffer_0[1060]; /* static allocation for joint decode */
160 const float *cplscales[5];
162 COOKSubpacket subpacket[MAX_SUBPACKETS];
165 static float pow2tab[127];
166 static float rootpow2tab[127];
168 /*************** init functions ***************/
170 /* table generator */
171 static av_cold void init_pow2table(void){
173 for (i=-63 ; i<64 ; i++){
174 pow2tab[63+i]= pow(2, i);
175 rootpow2tab[63+i]=sqrt(pow(2, i));
179 /* table generator */
180 static av_cold void init_gain_table(COOKContext *q) {
182 q->gain_size_factor = q->samples_per_channel/8;
183 for (i=0 ; i<23 ; i++) {
184 q->gain_table[i] = pow(pow2tab[i+52] ,
185 (1.0/(double)q->gain_size_factor));
190 static av_cold int init_cook_vlc_tables(COOKContext *q) {
194 for (i=0 ; i<13 ; i++) {
195 result |= init_vlc (&q->envelope_quant_index[i], 9, 24,
196 envelope_quant_index_huffbits[i], 1, 1,
197 envelope_quant_index_huffcodes[i], 2, 2, 0);
199 av_log(q->avctx,AV_LOG_DEBUG,"sqvh VLC init\n");
200 for (i=0 ; i<7 ; i++) {
201 result |= init_vlc (&q->sqvh[i], vhvlcsize_tab[i], vhsize_tab[i],
202 cvh_huffbits[i], 1, 1,
203 cvh_huffcodes[i], 2, 2, 0);
206 for(i=0;i<q->num_subpackets;i++){
207 if (q->subpacket[i].joint_stereo==1){
208 result |= init_vlc (&q->subpacket[i].ccpl, 6, (1<<q->subpacket[i].js_vlc_bits)-1,
209 ccpl_huffbits[q->subpacket[i].js_vlc_bits-2], 1, 1,
210 ccpl_huffcodes[q->subpacket[i].js_vlc_bits-2], 2, 2, 0);
211 av_log(q->avctx,AV_LOG_DEBUG,"subpacket %i Joint-stereo VLC used.\n",i);
215 av_log(q->avctx,AV_LOG_DEBUG,"VLC tables initialized.\n");
219 static av_cold int init_cook_mlt(COOKContext *q) {
221 int mlt_size = q->samples_per_channel;
223 if ((q->mlt_window = av_malloc(sizeof(float)*mlt_size)) == 0)
226 /* Initialize the MLT window: simple sine window. */
227 ff_sine_window_init(q->mlt_window, mlt_size);
228 for(j=0 ; j<mlt_size ; j++)
229 q->mlt_window[j] *= sqrt(2.0 / q->samples_per_channel);
231 /* Initialize the MDCT. */
232 if (ff_mdct_init(&q->mdct_ctx, av_log2(mlt_size)+1, 1, 1.0)) {
233 av_free(q->mlt_window);
236 av_log(q->avctx,AV_LOG_DEBUG,"MDCT initialized, order = %d.\n",
237 av_log2(mlt_size)+1);
242 static const float *maybe_reformat_buffer32 (COOKContext *q, const float *ptr, int n)
248 static av_cold void init_cplscales_table (COOKContext *q) {
251 q->cplscales[i] = maybe_reformat_buffer32 (q, cplscales[i], (1<<(i+2))-1);
254 /*************** init functions end ***********/
256 #define DECODE_BYTES_PAD1(bytes) (3 - ((bytes)+3) % 4)
257 #define DECODE_BYTES_PAD2(bytes) ((bytes) % 4 + DECODE_BYTES_PAD1(2 * (bytes)))
260 * Cook indata decoding, every 32 bits are XORed with 0x37c511f2.
261 * Why? No idea, some checksum/error detection method maybe.
263 * Out buffer size: extra bytes are needed to cope with
264 * padding/misalignment.
265 * Subpackets passed to the decoder can contain two, consecutive
266 * half-subpackets, of identical but arbitrary size.
267 * 1234 1234 1234 1234 extraA extraB
268 * Case 1: AAAA BBBB 0 0
269 * Case 2: AAAA ABBB BB-- 3 3
270 * Case 3: AAAA AABB BBBB 2 2
271 * Case 4: AAAA AAAB BBBB BB-- 1 5
273 * Nice way to waste CPU cycles.
275 * @param inbuffer pointer to byte array of indata
276 * @param out pointer to byte array of outdata
277 * @param bytes number of bytes
280 static inline int decode_bytes(const uint8_t* inbuffer, uint8_t* out, int bytes){
284 uint32_t* obuf = (uint32_t*) out;
285 /* FIXME: 64 bit platforms would be able to do 64 bits at a time.
286 * I'm too lazy though, should be something like
287 * for(i=0 ; i<bitamount/64 ; i++)
288 * (int64_t)out[i] = 0x37c511f237c511f2^av_be2ne64(int64_t)in[i]);
289 * Buffer alignment needs to be checked. */
291 off = (intptr_t)inbuffer & 3;
292 buf = (const uint32_t*) (inbuffer - off);
293 c = av_be2ne32((0x37c511f2 >> (off*8)) | (0x37c511f2 << (32-(off*8))));
295 for (i = 0; i < bytes/4; i++)
296 obuf[i] = c ^ buf[i];
305 static av_cold int cook_decode_close(AVCodecContext *avctx)
308 COOKContext *q = avctx->priv_data;
309 av_log(avctx,AV_LOG_DEBUG, "Deallocating memory.\n");
311 /* Free allocated memory buffers. */
312 av_free(q->mlt_window);
313 av_free(q->decoded_bytes_buffer);
315 /* Free the transform. */
316 ff_mdct_end(&q->mdct_ctx);
318 /* Free the VLC tables. */
319 for (i=0 ; i<13 ; i++) {
320 free_vlc(&q->envelope_quant_index[i]);
322 for (i=0 ; i<7 ; i++) {
323 free_vlc(&q->sqvh[i]);
325 for (i=0 ; i<q->num_subpackets ; i++) {
326 free_vlc(&q->subpacket[i].ccpl);
329 av_log(avctx,AV_LOG_DEBUG,"Memory deallocated.\n");
335 * Fill the gain array for the timedomain quantization.
337 * @param gb pointer to the GetBitContext
338 * @param gaininfo array[9] of gain indexes
341 static void decode_gain_info(GetBitContext *gb, int *gaininfo)
345 while (get_bits1(gb)) {}
346 n = get_bits_count(gb) - 1; //amount of elements*2 to update
350 int index = get_bits(gb, 3);
351 int gain = get_bits1(gb) ? get_bits(gb, 4) - 7 : -1;
353 while (i <= index) gaininfo[i++] = gain;
355 while (i <= 8) gaininfo[i++] = 0;
359 * Create the quant index table needed for the envelope.
361 * @param q pointer to the COOKContext
362 * @param quant_index_table pointer to the array
365 static void decode_envelope(COOKContext *q, COOKSubpacket *p, int* quant_index_table) {
368 quant_index_table[0]= get_bits(&q->gb,6) - 6; //This is used later in categorize
370 for (i=1 ; i < p->total_subbands ; i++){
372 if (i >= p->js_subband_start * 2) {
373 vlc_index-=p->js_subband_start;
376 if(vlc_index < 1) vlc_index = 1;
378 if (vlc_index>13) vlc_index = 13; //the VLC tables >13 are identical to No. 13
380 j = get_vlc2(&q->gb, q->envelope_quant_index[vlc_index-1].table,
381 q->envelope_quant_index[vlc_index-1].bits,2);
382 quant_index_table[i] = quant_index_table[i-1] + j - 12; //differential encoding
387 * Calculate the category and category_index vector.
389 * @param q pointer to the COOKContext
390 * @param quant_index_table pointer to the array
391 * @param category pointer to the category array
392 * @param category_index pointer to the category_index array
395 static void categorize(COOKContext *q, COOKSubpacket *p, int* quant_index_table,
396 int* category, int* category_index){
397 int exp_idx, bias, tmpbias1, tmpbias2, bits_left, num_bits, index, v, i, j;
401 int tmp_categorize_array[128*2];
402 int tmp_categorize_array1_idx=p->numvector_size;
403 int tmp_categorize_array2_idx=p->numvector_size;
405 bits_left = p->bits_per_subpacket - get_bits_count(&q->gb);
407 if(bits_left > q->samples_per_channel) {
408 bits_left = q->samples_per_channel +
409 ((bits_left - q->samples_per_channel)*5)/8;
410 //av_log(q->avctx, AV_LOG_ERROR, "bits_left = %d\n",bits_left);
413 memset(&exp_index1,0,102*sizeof(int));
414 memset(&exp_index2,0,102*sizeof(int));
415 memset(&tmp_categorize_array,0,128*2*sizeof(int));
420 for (i=32 ; i>0 ; i=i/2){
423 for (j=p->total_subbands ; j>0 ; j--){
424 exp_idx = av_clip((i - quant_index_table[index] + bias) / 2, 0, 7);
426 num_bits+=expbits_tab[exp_idx];
428 if(num_bits >= bits_left - 32){
433 /* Calculate total number of bits. */
435 for (i=0 ; i<p->total_subbands ; i++) {
436 exp_idx = av_clip((bias - quant_index_table[i]) / 2, 0, 7);
437 num_bits += expbits_tab[exp_idx];
438 exp_index1[i] = exp_idx;
439 exp_index2[i] = exp_idx;
441 tmpbias1 = tmpbias2 = num_bits;
443 for (j = 1 ; j < p->numvector_size ; j++) {
444 if (tmpbias1 + tmpbias2 > 2*bits_left) { /* ---> */
447 for (i=0 ; i<p->total_subbands ; i++){
448 if (exp_index1[i] < 7) {
449 v = (-2*exp_index1[i]) - quant_index_table[i] + bias;
457 tmp_categorize_array[tmp_categorize_array1_idx++] = index;
458 tmpbias1 -= expbits_tab[exp_index1[index]] -
459 expbits_tab[exp_index1[index]+1];
464 for (i=0 ; i<p->total_subbands ; i++){
465 if(exp_index2[i] > 0){
466 v = (-2*exp_index2[i])-quant_index_table[i]+bias;
473 if(index == -1)break;
474 tmp_categorize_array[--tmp_categorize_array2_idx] = index;
475 tmpbias2 -= expbits_tab[exp_index2[index]] -
476 expbits_tab[exp_index2[index]-1];
481 for(i=0 ; i<p->total_subbands ; i++)
482 category[i] = exp_index2[i];
484 for(i=0 ; i<p->numvector_size-1 ; i++)
485 category_index[i] = tmp_categorize_array[tmp_categorize_array2_idx++];
491 * Expand the category vector.
493 * @param q pointer to the COOKContext
494 * @param category pointer to the category array
495 * @param category_index pointer to the category_index array
498 static inline void expand_category(COOKContext *q, int* category,
499 int* category_index){
501 for(i=0 ; i<q->num_vectors ; i++){
502 ++category[category_index[i]];
507 * The real requantization of the mltcoefs
509 * @param q pointer to the COOKContext
511 * @param quant_index quantisation index
512 * @param subband_coef_index array of indexes to quant_centroid_tab
513 * @param subband_coef_sign signs of coefficients
514 * @param mlt_p pointer into the mlt buffer
517 static void scalar_dequant_float(COOKContext *q, int index, int quant_index,
518 int* subband_coef_index, int* subband_coef_sign,
523 for(i=0 ; i<SUBBAND_SIZE ; i++) {
524 if (subband_coef_index[i]) {
525 f1 = quant_centroid_tab[index][subband_coef_index[i]];
526 if (subband_coef_sign[i]) f1 = -f1;
528 /* noise coding if subband_coef_index[i] == 0 */
529 f1 = dither_tab[index];
530 if (av_lfg_get(&q->random_state) < 0x80000000) f1 = -f1;
532 mlt_p[i] = f1 * rootpow2tab[quant_index+63];
536 * Unpack the subband_coef_index and subband_coef_sign vectors.
538 * @param q pointer to the COOKContext
539 * @param category pointer to the category array
540 * @param subband_coef_index array of indexes to quant_centroid_tab
541 * @param subband_coef_sign signs of coefficients
544 static int unpack_SQVH(COOKContext *q, COOKSubpacket *p, int category, int* subband_coef_index,
545 int* subband_coef_sign) {
547 int vlc, vd ,tmp, result;
549 vd = vd_tab[category];
551 for(i=0 ; i<vpr_tab[category] ; i++){
552 vlc = get_vlc2(&q->gb, q->sqvh[category].table, q->sqvh[category].bits, 3);
553 if (p->bits_per_subpacket < get_bits_count(&q->gb)){
557 for(j=vd-1 ; j>=0 ; j--){
558 tmp = (vlc * invradix_tab[category])/0x100000;
559 subband_coef_index[vd*i+j] = vlc - tmp * (kmax_tab[category]+1);
562 for(j=0 ; j<vd ; j++){
563 if (subband_coef_index[i*vd + j]) {
564 if(get_bits_count(&q->gb) < p->bits_per_subpacket){
565 subband_coef_sign[i*vd+j] = get_bits1(&q->gb);
568 subband_coef_sign[i*vd+j]=0;
571 subband_coef_sign[i*vd+j]=0;
580 * Fill the mlt_buffer with mlt coefficients.
582 * @param q pointer to the COOKContext
583 * @param category pointer to the category array
584 * @param quant_index_table pointer to the array
585 * @param mlt_buffer pointer to mlt coefficients
589 static void decode_vectors(COOKContext* q, COOKSubpacket* p, int* category,
590 int *quant_index_table, float* mlt_buffer){
591 /* A zero in this table means that the subband coefficient is
592 random noise coded. */
593 int subband_coef_index[SUBBAND_SIZE];
594 /* A zero in this table means that the subband coefficient is a
595 positive multiplicator. */
596 int subband_coef_sign[SUBBAND_SIZE];
600 for(band=0 ; band<p->total_subbands ; band++){
601 index = category[band];
602 if(category[band] < 7){
603 if(unpack_SQVH(q, p, category[band], subband_coef_index, subband_coef_sign)){
605 for(j=0 ; j<p->total_subbands ; j++) category[band+j]=7;
609 memset(subband_coef_index, 0, sizeof(subband_coef_index));
610 memset(subband_coef_sign, 0, sizeof(subband_coef_sign));
612 q->scalar_dequant(q, index, quant_index_table[band],
613 subband_coef_index, subband_coef_sign,
614 &mlt_buffer[band * SUBBAND_SIZE]);
617 if(p->total_subbands*SUBBAND_SIZE >= q->samples_per_channel){
619 } /* FIXME: should this be removed, or moved into loop above? */
624 * function for decoding mono data
626 * @param q pointer to the COOKContext
627 * @param mlt_buffer pointer to mlt coefficients
630 static void mono_decode(COOKContext *q, COOKSubpacket *p, float* mlt_buffer) {
632 int category_index[128];
633 int quant_index_table[102];
636 memset(&category, 0, 128*sizeof(int));
637 memset(&category_index, 0, 128*sizeof(int));
639 decode_envelope(q, p, quant_index_table);
640 q->num_vectors = get_bits(&q->gb,p->log2_numvector_size);
641 categorize(q, p, quant_index_table, category, category_index);
642 expand_category(q, category, category_index);
643 decode_vectors(q, p, category, quant_index_table, mlt_buffer);
648 * the actual requantization of the timedomain samples
650 * @param q pointer to the COOKContext
651 * @param buffer pointer to the timedomain buffer
652 * @param gain_index index for the block multiplier
653 * @param gain_index_next index for the next block multiplier
656 static void interpolate_float(COOKContext *q, float* buffer,
657 int gain_index, int gain_index_next){
660 fc1 = pow2tab[gain_index+63];
662 if(gain_index == gain_index_next){ //static gain
663 for(i=0 ; i<q->gain_size_factor ; i++){
667 } else { //smooth gain
668 fc2 = q->gain_table[11 + (gain_index_next-gain_index)];
669 for(i=0 ; i<q->gain_size_factor ; i++){
678 * Apply transform window, overlap buffers.
680 * @param q pointer to the COOKContext
681 * @param inbuffer pointer to the mltcoefficients
682 * @param gains_ptr current and previous gains
683 * @param previous_buffer pointer to the previous buffer to be used for overlapping
686 static void imlt_window_float (COOKContext *q, float *inbuffer,
687 cook_gains *gains_ptr, float *previous_buffer)
689 const float fc = pow2tab[gains_ptr->previous[0] + 63];
691 /* The weird thing here, is that the two halves of the time domain
692 * buffer are swapped. Also, the newest data, that we save away for
693 * next frame, has the wrong sign. Hence the subtraction below.
694 * Almost sounds like a complex conjugate/reverse data/FFT effect.
697 /* Apply window and overlap */
698 for(i = 0; i < q->samples_per_channel; i++){
699 inbuffer[i] = inbuffer[i] * fc * q->mlt_window[i] -
700 previous_buffer[i] * q->mlt_window[q->samples_per_channel - 1 - i];
705 * The modulated lapped transform, this takes transform coefficients
706 * and transforms them into timedomain samples.
707 * Apply transform window, overlap buffers, apply gain profile
708 * and buffer management.
710 * @param q pointer to the COOKContext
711 * @param inbuffer pointer to the mltcoefficients
712 * @param gains_ptr current and previous gains
713 * @param previous_buffer pointer to the previous buffer to be used for overlapping
716 static void imlt_gain(COOKContext *q, float *inbuffer,
717 cook_gains *gains_ptr, float* previous_buffer)
719 float *buffer0 = q->mono_mdct_output;
720 float *buffer1 = q->mono_mdct_output + q->samples_per_channel;
723 /* Inverse modified discrete cosine transform */
724 q->mdct_ctx.imdct_calc(&q->mdct_ctx, q->mono_mdct_output, inbuffer);
726 q->imlt_window (q, buffer1, gains_ptr, previous_buffer);
728 /* Apply gain profile */
729 for (i = 0; i < 8; i++) {
730 if (gains_ptr->now[i] || gains_ptr->now[i + 1])
731 q->interpolate(q, &buffer1[q->gain_size_factor * i],
732 gains_ptr->now[i], gains_ptr->now[i + 1]);
735 /* Save away the current to be previous block. */
736 memcpy(previous_buffer, buffer0, sizeof(float)*q->samples_per_channel);
741 * function for getting the jointstereo coupling information
743 * @param q pointer to the COOKContext
744 * @param decouple_tab decoupling array
748 static void decouple_info(COOKContext *q, COOKSubpacket *p, int* decouple_tab){
751 if(get_bits1(&q->gb)) {
752 if(cplband[p->js_subband_start] > cplband[p->subbands-1]) return;
754 length = cplband[p->subbands-1] - cplband[p->js_subband_start] + 1;
755 for (i=0 ; i<length ; i++) {
756 decouple_tab[cplband[p->js_subband_start] + i] = get_vlc2(&q->gb, p->ccpl.table, p->ccpl.bits, 2);
761 if(cplband[p->js_subband_start] > cplband[p->subbands-1]) return;
763 length = cplband[p->subbands-1] - cplband[p->js_subband_start] + 1;
764 for (i=0 ; i<length ; i++) {
765 decouple_tab[cplband[p->js_subband_start] + i] = get_bits(&q->gb, p->js_vlc_bits);
771 * function decouples a pair of signals from a single signal via multiplication.
773 * @param q pointer to the COOKContext
774 * @param subband index of the current subband
775 * @param f1 multiplier for channel 1 extraction
776 * @param f2 multiplier for channel 2 extraction
777 * @param decode_buffer input buffer
778 * @param mlt_buffer1 pointer to left channel mlt coefficients
779 * @param mlt_buffer2 pointer to right channel mlt coefficients
781 static void decouple_float (COOKContext *q,
785 float *decode_buffer,
786 float *mlt_buffer1, float *mlt_buffer2)
789 for (j=0 ; j<SUBBAND_SIZE ; j++) {
790 tmp_idx = ((p->js_subband_start + subband)*SUBBAND_SIZE)+j;
791 mlt_buffer1[SUBBAND_SIZE*subband + j] = f1 * decode_buffer[tmp_idx];
792 mlt_buffer2[SUBBAND_SIZE*subband + j] = f2 * decode_buffer[tmp_idx];
797 * function for decoding joint stereo data
799 * @param q pointer to the COOKContext
800 * @param mlt_buffer1 pointer to left channel mlt coefficients
801 * @param mlt_buffer2 pointer to right channel mlt coefficients
804 static void joint_decode(COOKContext *q, COOKSubpacket *p, float* mlt_buffer1,
805 float* mlt_buffer2) {
807 int decouple_tab[SUBBAND_SIZE];
808 float *decode_buffer = q->decode_buffer_0;
811 const float* cplscale;
813 memset(decouple_tab, 0, sizeof(decouple_tab));
814 memset(decode_buffer, 0, sizeof(decode_buffer));
816 /* Make sure the buffers are zeroed out. */
817 memset(mlt_buffer1,0, 1024*sizeof(float));
818 memset(mlt_buffer2,0, 1024*sizeof(float));
819 decouple_info(q, p, decouple_tab);
820 mono_decode(q, p, decode_buffer);
822 /* The two channels are stored interleaved in decode_buffer. */
823 for (i=0 ; i<p->js_subband_start ; i++) {
824 for (j=0 ; j<SUBBAND_SIZE ; j++) {
825 mlt_buffer1[i*20+j] = decode_buffer[i*40+j];
826 mlt_buffer2[i*20+j] = decode_buffer[i*40+20+j];
830 /* When we reach js_subband_start (the higher frequencies)
831 the coefficients are stored in a coupling scheme. */
832 idx = (1 << p->js_vlc_bits) - 1;
833 for (i=p->js_subband_start ; i<p->subbands ; i++) {
834 cpl_tmp = cplband[i];
835 idx -=decouple_tab[cpl_tmp];
836 cplscale = q->cplscales[p->js_vlc_bits-2]; //choose decoupler table
837 f1 = cplscale[decouple_tab[cpl_tmp]];
838 f2 = cplscale[idx-1];
839 q->decouple (q, p, i, f1, f2, decode_buffer, mlt_buffer1, mlt_buffer2);
840 idx = (1 << p->js_vlc_bits) - 1;
845 * First part of subpacket decoding:
846 * decode raw stream bytes and read gain info.
848 * @param q pointer to the COOKContext
849 * @param inbuffer pointer to raw stream data
850 * @param gains_ptr array of current/prev gain pointers
854 decode_bytes_and_gain(COOKContext *q, COOKSubpacket *p, const uint8_t *inbuffer,
855 cook_gains *gains_ptr)
859 offset = decode_bytes(inbuffer, q->decoded_bytes_buffer,
860 p->bits_per_subpacket/8);
861 init_get_bits(&q->gb, q->decoded_bytes_buffer + offset,
862 p->bits_per_subpacket);
863 decode_gain_info(&q->gb, gains_ptr->now);
865 /* Swap current and previous gains */
866 FFSWAP(int *, gains_ptr->now, gains_ptr->previous);
870 * Saturate the output signal to signed 16bit integers.
872 * @param q pointer to the COOKContext
873 * @param chan channel to saturate
874 * @param out pointer to the output vector
877 saturate_output_float (COOKContext *q, int chan, int16_t *out)
880 float *output = q->mono_mdct_output + q->samples_per_channel;
881 /* Clip and convert floats to 16 bits.
883 for (j = 0; j < q->samples_per_channel; j++) {
884 out[chan + q->nb_channels * j] =
885 av_clip_int16(lrintf(output[j]));
890 * Final part of subpacket decoding:
891 * Apply modulated lapped transform, gain compensation,
892 * clip and convert to integer.
894 * @param q pointer to the COOKContext
895 * @param decode_buffer pointer to the mlt coefficients
896 * @param gains_ptr array of current/prev gain pointers
897 * @param previous_buffer pointer to the previous buffer to be used for overlapping
898 * @param out pointer to the output buffer
899 * @param chan 0: left or single channel, 1: right channel
903 mlt_compensate_output(COOKContext *q, float *decode_buffer,
904 cook_gains *gains_ptr, float *previous_buffer,
905 int16_t *out, int chan)
907 imlt_gain(q, decode_buffer, gains_ptr, previous_buffer);
908 q->saturate_output (q, chan, out);
913 * Cook subpacket decoding. This function returns one decoded subpacket,
914 * usually 1024 samples per channel.
916 * @param q pointer to the COOKContext
917 * @param inbuffer pointer to the inbuffer
918 * @param outbuffer pointer to the outbuffer
920 static void decode_subpacket(COOKContext *q, COOKSubpacket* p, const uint8_t *inbuffer, int16_t *outbuffer) {
921 int sub_packet_size = p->size;
923 // for (i=0 ; i<sub_packet_size ; i++) {
924 // av_log(q->avctx, AV_LOG_ERROR, "%02x", inbuffer[i]);
926 // av_log(q->avctx, AV_LOG_ERROR, "\n");
927 memset(q->decode_buffer_1,0,sizeof(q->decode_buffer_1));
928 decode_bytes_and_gain(q, p, inbuffer, &p->gains1);
930 if (p->joint_stereo) {
931 joint_decode(q, p, q->decode_buffer_1, q->decode_buffer_2);
933 mono_decode(q, p, q->decode_buffer_1);
935 if (p->num_channels == 2) {
936 decode_bytes_and_gain(q, p, inbuffer + sub_packet_size/2, &p->gains2);
937 mono_decode(q, p, q->decode_buffer_2);
941 mlt_compensate_output(q, q->decode_buffer_1, &p->gains1,
942 p->mono_previous_buffer1, outbuffer, p->ch_idx);
944 if (p->num_channels == 2) {
945 if (p->joint_stereo) {
946 mlt_compensate_output(q, q->decode_buffer_2, &p->gains1,
947 p->mono_previous_buffer2, outbuffer, p->ch_idx + 1);
949 mlt_compensate_output(q, q->decode_buffer_2, &p->gains2,
950 p->mono_previous_buffer2, outbuffer, p->ch_idx + 1);
958 * Cook frame decoding
960 * @param avctx pointer to the AVCodecContext
963 static int cook_decode_frame(AVCodecContext *avctx,
964 void *data, int *data_size,
966 const uint8_t *buf = avpkt->data;
967 int buf_size = avpkt->size;
968 COOKContext *q = avctx->priv_data;
973 if (buf_size < avctx->block_align)
976 /* estimate subpacket sizes */
977 q->subpacket[0].size = avctx->block_align;
979 for(i=1;i<q->num_subpackets;i++){
980 q->subpacket[i].size = 2 * buf[avctx->block_align - q->num_subpackets + i];
981 q->subpacket[0].size -= q->subpacket[i].size + 1;
982 if (q->subpacket[0].size < 0) {
983 av_log(avctx,AV_LOG_DEBUG,"frame subpacket size total > avctx->block_align!\n");
988 /* decode supbackets */
990 for(i=0;i<q->num_subpackets;i++){
991 q->subpacket[i].bits_per_subpacket = (q->subpacket[i].size*8)>>q->subpacket[i].bits_per_subpdiv;
992 q->subpacket[i].ch_idx = chidx;
993 av_log(avctx,AV_LOG_DEBUG,"subpacket[%i] size %i js %i %i block_align %i\n",i,q->subpacket[i].size,q->subpacket[i].joint_stereo,offset,avctx->block_align);
994 decode_subpacket(q, &q->subpacket[i], buf + offset, (int16_t*)data);
995 offset += q->subpacket[i].size;
996 chidx += q->subpacket[i].num_channels;
997 av_log(avctx,AV_LOG_DEBUG,"subpacket[%i] %i %i\n",i,q->subpacket[i].size * 8,get_bits_count(&q->gb));
999 *data_size = sizeof(int16_t) * q->nb_channels * q->samples_per_channel;
1001 /* Discard the first two frames: no valid audio. */
1002 if (avctx->frame_number < 2) *data_size = 0;
1004 return avctx->block_align;
1008 static void dump_cook_context(COOKContext *q)
1011 #define PRINT(a,b) av_log(q->avctx,AV_LOG_ERROR," %s = %d\n", a, b);
1012 av_log(q->avctx,AV_LOG_ERROR,"COOKextradata\n");
1013 av_log(q->avctx,AV_LOG_ERROR,"cookversion=%x\n",q->subpacket[0].cookversion);
1014 if (q->subpacket[0].cookversion > STEREO) {
1015 PRINT("js_subband_start",q->subpacket[0].js_subband_start);
1016 PRINT("js_vlc_bits",q->subpacket[0].js_vlc_bits);
1018 av_log(q->avctx,AV_LOG_ERROR,"COOKContext\n");
1019 PRINT("nb_channels",q->nb_channels);
1020 PRINT("bit_rate",q->bit_rate);
1021 PRINT("sample_rate",q->sample_rate);
1022 PRINT("samples_per_channel",q->subpacket[0].samples_per_channel);
1023 PRINT("samples_per_frame",q->subpacket[0].samples_per_frame);
1024 PRINT("subbands",q->subpacket[0].subbands);
1025 PRINT("js_subband_start",q->subpacket[0].js_subband_start);
1026 PRINT("log2_numvector_size",q->subpacket[0].log2_numvector_size);
1027 PRINT("numvector_size",q->subpacket[0].numvector_size);
1028 PRINT("total_subbands",q->subpacket[0].total_subbands);
1032 static av_cold int cook_count_channels(unsigned int mask){
1035 for(i = 0;i<32;i++){
1043 * Cook initialization
1045 * @param avctx pointer to the AVCodecContext
1048 static av_cold int cook_decode_init(AVCodecContext *avctx)
1050 COOKContext *q = avctx->priv_data;
1051 const uint8_t *edata_ptr = avctx->extradata;
1052 const uint8_t *edata_ptr_end = edata_ptr + avctx->extradata_size;
1053 int extradata_size = avctx->extradata_size;
1055 unsigned int channel_mask = 0;
1058 /* Take care of the codec specific extradata. */
1059 if (extradata_size <= 0) {
1060 av_log(avctx,AV_LOG_ERROR,"Necessary extradata missing!\n");
1063 av_log(avctx,AV_LOG_DEBUG,"codecdata_length=%d\n",avctx->extradata_size);
1065 /* Take data from the AVCodecContext (RM container). */
1066 q->sample_rate = avctx->sample_rate;
1067 q->nb_channels = avctx->channels;
1068 q->bit_rate = avctx->bit_rate;
1070 /* Initialize RNG. */
1071 av_lfg_init(&q->random_state, 0);
1073 while(edata_ptr < edata_ptr_end){
1074 /* 8 for mono, 16 for stereo, ? for multichannel
1075 Swap to right endianness so we don't need to care later on. */
1076 if (extradata_size >= 8){
1077 q->subpacket[s].cookversion = bytestream_get_be32(&edata_ptr);
1078 q->subpacket[s].samples_per_frame = bytestream_get_be16(&edata_ptr);
1079 q->subpacket[s].subbands = bytestream_get_be16(&edata_ptr);
1080 extradata_size -= 8;
1082 if (avctx->extradata_size >= 8){
1083 bytestream_get_be32(&edata_ptr); //Unknown unused
1084 q->subpacket[s].js_subband_start = bytestream_get_be16(&edata_ptr);
1085 q->subpacket[s].js_vlc_bits = bytestream_get_be16(&edata_ptr);
1086 extradata_size -= 8;
1089 /* Initialize extradata related variables. */
1090 q->subpacket[s].samples_per_channel = q->subpacket[s].samples_per_frame / q->nb_channels;
1091 q->subpacket[s].bits_per_subpacket = avctx->block_align * 8;
1093 /* Initialize default data states. */
1094 q->subpacket[s].log2_numvector_size = 5;
1095 q->subpacket[s].total_subbands = q->subpacket[s].subbands;
1096 q->subpacket[s].num_channels = 1;
1098 /* Initialize version-dependent variables */
1100 av_log(avctx,AV_LOG_DEBUG,"subpacket[%i].cookversion=%x\n",s,q->subpacket[s].cookversion);
1101 q->subpacket[s].joint_stereo = 0;
1102 switch (q->subpacket[s].cookversion) {
1104 if (q->nb_channels != 1) {
1105 av_log_ask_for_sample(avctx, "Container channels != 1.\n");
1108 av_log(avctx,AV_LOG_DEBUG,"MONO\n");
1111 if (q->nb_channels != 1) {
1112 q->subpacket[s].bits_per_subpdiv = 1;
1113 q->subpacket[s].num_channels = 2;
1115 av_log(avctx,AV_LOG_DEBUG,"STEREO\n");
1118 if (q->nb_channels != 2) {
1119 av_log_ask_for_sample(avctx, "Container channels != 2.\n");
1122 av_log(avctx,AV_LOG_DEBUG,"JOINT_STEREO\n");
1123 if (avctx->extradata_size >= 16){
1124 q->subpacket[s].total_subbands = q->subpacket[s].subbands + q->subpacket[s].js_subband_start;
1125 q->subpacket[s].joint_stereo = 1;
1126 q->subpacket[s].num_channels = 2;
1128 if (q->subpacket[s].samples_per_channel > 256) {
1129 q->subpacket[s].log2_numvector_size = 6;
1131 if (q->subpacket[s].samples_per_channel > 512) {
1132 q->subpacket[s].log2_numvector_size = 7;
1136 av_log(avctx,AV_LOG_DEBUG,"MULTI_CHANNEL\n");
1137 if(extradata_size >= 4)
1138 channel_mask |= q->subpacket[s].channel_mask = bytestream_get_be32(&edata_ptr);
1140 if(cook_count_channels(q->subpacket[s].channel_mask) > 1){
1141 q->subpacket[s].total_subbands = q->subpacket[s].subbands + q->subpacket[s].js_subband_start;
1142 q->subpacket[s].joint_stereo = 1;
1143 q->subpacket[s].num_channels = 2;
1144 q->subpacket[s].samples_per_channel = q->subpacket[s].samples_per_frame >> 1;
1146 if (q->subpacket[s].samples_per_channel > 256) {
1147 q->subpacket[s].log2_numvector_size = 6;
1149 if (q->subpacket[s].samples_per_channel > 512) {
1150 q->subpacket[s].log2_numvector_size = 7;
1153 q->subpacket[s].samples_per_channel = q->subpacket[s].samples_per_frame;
1157 av_log_ask_for_sample(avctx, "Unknown Cook version.\n");
1161 if(s > 1 && q->subpacket[s].samples_per_channel != q->samples_per_channel) {
1162 av_log(avctx,AV_LOG_ERROR,"different number of samples per channel!\n");
1165 q->samples_per_channel = q->subpacket[0].samples_per_channel;
1168 /* Initialize variable relations */
1169 q->subpacket[s].numvector_size = (1 << q->subpacket[s].log2_numvector_size);
1171 /* Try to catch some obviously faulty streams, othervise it might be exploitable */
1172 if (q->subpacket[s].total_subbands > 53) {
1173 av_log_ask_for_sample(avctx, "total_subbands > 53\n");
1177 if ((q->subpacket[s].js_vlc_bits > 6) || (q->subpacket[s].js_vlc_bits < 0)) {
1178 av_log(avctx,AV_LOG_ERROR,"js_vlc_bits = %d, only >= 0 and <= 6 allowed!\n",q->subpacket[s].js_vlc_bits);
1182 if (q->subpacket[s].subbands > 50) {
1183 av_log_ask_for_sample(avctx, "subbands > 50\n");
1186 q->subpacket[s].gains1.now = q->subpacket[s].gain_1;
1187 q->subpacket[s].gains1.previous = q->subpacket[s].gain_2;
1188 q->subpacket[s].gains2.now = q->subpacket[s].gain_3;
1189 q->subpacket[s].gains2.previous = q->subpacket[s].gain_4;
1191 q->num_subpackets++;
1193 if (s > MAX_SUBPACKETS) {
1194 av_log_ask_for_sample(avctx, "Too many subpackets > 5\n");
1198 /* Generate tables */
1201 init_cplscales_table(q);
1203 if (init_cook_vlc_tables(q) != 0)
1207 if(avctx->block_align >= UINT_MAX/2)
1210 /* Pad the databuffer with:
1211 DECODE_BYTES_PAD1 or DECODE_BYTES_PAD2 for decode_bytes(),
1212 FF_INPUT_BUFFER_PADDING_SIZE, for the bitstreamreader. */
1213 q->decoded_bytes_buffer =
1214 av_mallocz(avctx->block_align
1215 + DECODE_BYTES_PAD1(avctx->block_align)
1216 + FF_INPUT_BUFFER_PADDING_SIZE);
1217 if (q->decoded_bytes_buffer == NULL)
1220 /* Initialize transform. */
1221 if ( init_cook_mlt(q) != 0 )
1224 /* Initialize COOK signal arithmetic handling */
1226 q->scalar_dequant = scalar_dequant_float;
1227 q->decouple = decouple_float;
1228 q->imlt_window = imlt_window_float;
1229 q->interpolate = interpolate_float;
1230 q->saturate_output = saturate_output_float;
1233 /* Try to catch some obviously faulty streams, othervise it might be exploitable */
1234 if ((q->samples_per_channel == 256) || (q->samples_per_channel == 512) || (q->samples_per_channel == 1024)) {
1236 av_log_ask_for_sample(avctx,
1237 "unknown amount of samples_per_channel = %d\n",
1238 q->samples_per_channel);
1242 avctx->sample_fmt = AV_SAMPLE_FMT_S16;
1244 avctx->channel_layout = channel_mask;
1246 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
1249 dump_cook_context(q);
1255 AVCodec ff_cook_decoder =
1258 .type = AVMEDIA_TYPE_AUDIO,
1259 .id = CODEC_ID_COOK,
1260 .priv_data_size = sizeof(COOKContext),
1261 .init = cook_decode_init,
1262 .close = cook_decode_close,
1263 .decode = cook_decode_frame,
1264 .long_name = NULL_IF_CONFIG_SMALL("COOK"),