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
45 #include "libavutil/lfg.h"
49 #include "bytestream.h"
51 #include "libavutil/audioconvert.h"
56 /* the different Cook versions */
57 #define MONO 0x1000001
58 #define STEREO 0x1000002
59 #define JOINT_STEREO 0x1000003
60 #define MC_COOK 0x2000000 //multichannel Cook, not supported
62 #define SUBBAND_SIZE 20
63 #define MAX_SUBPACKETS 5
75 int samples_per_frame;
79 int samples_per_channel;
80 int log2_numvector_size;
81 unsigned int channel_mask;
82 VLC ccpl; ///< channel coupling
84 int bits_per_subpacket;
87 int numvector_size; ///< 1 << log2_numvector_size;
89 float mono_previous_buffer1[1024];
90 float mono_previous_buffer2[1024];
100 typedef struct cook {
102 * The following 5 functions provide the lowlevel arithmetic on
103 * the internal audio buffers.
105 void (* scalar_dequant)(struct cook *q, int index, int quant_index,
106 int* subband_coef_index, int* subband_coef_sign,
109 void (* decouple) (struct cook *q,
113 float *decode_buffer,
114 float *mlt_buffer1, float *mlt_buffer2);
116 void (* imlt_window) (struct cook *q, float *buffer1,
117 cook_gains *gains_ptr, float *previous_buffer);
119 void (* interpolate) (struct cook *q, float* buffer,
120 int gain_index, int gain_index_next);
122 void (* saturate_output) (struct cook *q, int chan, float *out);
124 AVCodecContext* avctx;
131 int samples_per_channel;
140 VLC envelope_quant_index[13];
141 VLC sqvh[7]; //scalar quantization
143 /* generatable tables and related variables */
144 int gain_size_factor;
145 float gain_table[23];
149 uint8_t* decoded_bytes_buffer;
150 DECLARE_ALIGNED(32, float, mono_mdct_output)[2048];
151 float decode_buffer_1[1024];
152 float decode_buffer_2[1024];
153 float decode_buffer_0[1060]; /* static allocation for joint decode */
155 const float *cplscales[5];
157 COOKSubpacket subpacket[MAX_SUBPACKETS];
160 static float pow2tab[127];
161 static float rootpow2tab[127];
163 /*************** init functions ***************/
165 /* table generator */
166 static av_cold void init_pow2table(void){
168 for (i=-63 ; i<64 ; i++){
169 pow2tab[63+i]= pow(2, i);
170 rootpow2tab[63+i]=sqrt(pow(2, i));
174 /* table generator */
175 static av_cold void init_gain_table(COOKContext *q) {
177 q->gain_size_factor = q->samples_per_channel/8;
178 for (i=0 ; i<23 ; i++) {
179 q->gain_table[i] = pow(pow2tab[i+52] ,
180 (1.0/(double)q->gain_size_factor));
185 static av_cold int init_cook_vlc_tables(COOKContext *q) {
189 for (i=0 ; i<13 ; i++) {
190 result |= init_vlc (&q->envelope_quant_index[i], 9, 24,
191 envelope_quant_index_huffbits[i], 1, 1,
192 envelope_quant_index_huffcodes[i], 2, 2, 0);
194 av_log(q->avctx,AV_LOG_DEBUG,"sqvh VLC init\n");
195 for (i=0 ; i<7 ; i++) {
196 result |= init_vlc (&q->sqvh[i], vhvlcsize_tab[i], vhsize_tab[i],
197 cvh_huffbits[i], 1, 1,
198 cvh_huffcodes[i], 2, 2, 0);
201 for(i=0;i<q->num_subpackets;i++){
202 if (q->subpacket[i].joint_stereo==1){
203 result |= init_vlc (&q->subpacket[i].ccpl, 6, (1<<q->subpacket[i].js_vlc_bits)-1,
204 ccpl_huffbits[q->subpacket[i].js_vlc_bits-2], 1, 1,
205 ccpl_huffcodes[q->subpacket[i].js_vlc_bits-2], 2, 2, 0);
206 av_log(q->avctx,AV_LOG_DEBUG,"subpacket %i Joint-stereo VLC used.\n",i);
210 av_log(q->avctx,AV_LOG_DEBUG,"VLC tables initialized.\n");
214 static av_cold int init_cook_mlt(COOKContext *q) {
216 int mlt_size = q->samples_per_channel;
218 if ((q->mlt_window = av_malloc(mlt_size * sizeof(*q->mlt_window))) == 0)
221 /* Initialize the MLT window: simple sine window. */
222 ff_sine_window_init(q->mlt_window, mlt_size);
223 for(j=0 ; j<mlt_size ; j++)
224 q->mlt_window[j] *= sqrt(2.0 / q->samples_per_channel);
226 /* Initialize the MDCT. */
227 if (ff_mdct_init(&q->mdct_ctx, av_log2(mlt_size)+1, 1, 1.0/32768.0)) {
228 av_free(q->mlt_window);
231 av_log(q->avctx,AV_LOG_DEBUG,"MDCT initialized, order = %d.\n",
232 av_log2(mlt_size)+1);
237 static const float *maybe_reformat_buffer32 (COOKContext *q, const float *ptr, int n)
243 static av_cold void init_cplscales_table (COOKContext *q) {
246 q->cplscales[i] = maybe_reformat_buffer32 (q, cplscales[i], (1<<(i+2))-1);
249 /*************** init functions end ***********/
251 #define DECODE_BYTES_PAD1(bytes) (3 - ((bytes)+3) % 4)
252 #define DECODE_BYTES_PAD2(bytes) ((bytes) % 4 + DECODE_BYTES_PAD1(2 * (bytes)))
255 * Cook indata decoding, every 32 bits are XORed with 0x37c511f2.
256 * Why? No idea, some checksum/error detection method maybe.
258 * Out buffer size: extra bytes are needed to cope with
259 * padding/misalignment.
260 * Subpackets passed to the decoder can contain two, consecutive
261 * half-subpackets, of identical but arbitrary size.
262 * 1234 1234 1234 1234 extraA extraB
263 * Case 1: AAAA BBBB 0 0
264 * Case 2: AAAA ABBB BB-- 3 3
265 * Case 3: AAAA AABB BBBB 2 2
266 * Case 4: AAAA AAAB BBBB BB-- 1 5
268 * Nice way to waste CPU cycles.
270 * @param inbuffer pointer to byte array of indata
271 * @param out pointer to byte array of outdata
272 * @param bytes number of bytes
275 static inline int decode_bytes(const uint8_t* inbuffer, uint8_t* out, int bytes){
279 uint32_t* obuf = (uint32_t*) out;
280 /* FIXME: 64 bit platforms would be able to do 64 bits at a time.
281 * I'm too lazy though, should be something like
282 * for(i=0 ; i<bitamount/64 ; i++)
283 * (int64_t)out[i] = 0x37c511f237c511f2^av_be2ne64(int64_t)in[i]);
284 * Buffer alignment needs to be checked. */
286 off = (intptr_t)inbuffer & 3;
287 buf = (const uint32_t*) (inbuffer - off);
288 c = av_be2ne32((0x37c511f2 >> (off*8)) | (0x37c511f2 << (32-(off*8))));
290 for (i = 0; i < bytes/4; i++)
291 obuf[i] = c ^ buf[i];
300 static av_cold int cook_decode_close(AVCodecContext *avctx)
303 COOKContext *q = avctx->priv_data;
304 av_log(avctx,AV_LOG_DEBUG, "Deallocating memory.\n");
306 /* Free allocated memory buffers. */
307 av_free(q->mlt_window);
308 av_free(q->decoded_bytes_buffer);
310 /* Free the transform. */
311 ff_mdct_end(&q->mdct_ctx);
313 /* Free the VLC tables. */
314 for (i=0 ; i<13 ; i++) {
315 free_vlc(&q->envelope_quant_index[i]);
317 for (i=0 ; i<7 ; i++) {
318 free_vlc(&q->sqvh[i]);
320 for (i=0 ; i<q->num_subpackets ; i++) {
321 free_vlc(&q->subpacket[i].ccpl);
324 av_log(avctx,AV_LOG_DEBUG,"Memory deallocated.\n");
330 * Fill the gain array for the timedomain quantization.
332 * @param gb pointer to the GetBitContext
333 * @param gaininfo array[9] of gain indexes
336 static void decode_gain_info(GetBitContext *gb, int *gaininfo)
340 while (get_bits1(gb)) {}
341 n = get_bits_count(gb) - 1; //amount of elements*2 to update
345 int index = get_bits(gb, 3);
346 int gain = get_bits1(gb) ? get_bits(gb, 4) - 7 : -1;
348 while (i <= index) gaininfo[i++] = gain;
350 while (i <= 8) gaininfo[i++] = 0;
354 * Create the quant index table needed for the envelope.
356 * @param q pointer to the COOKContext
357 * @param quant_index_table pointer to the array
360 static void decode_envelope(COOKContext *q, COOKSubpacket *p, int* quant_index_table) {
363 quant_index_table[0]= get_bits(&q->gb,6) - 6; //This is used later in categorize
365 for (i=1 ; i < p->total_subbands ; i++){
367 if (i >= p->js_subband_start * 2) {
368 vlc_index-=p->js_subband_start;
371 if(vlc_index < 1) vlc_index = 1;
373 if (vlc_index>13) vlc_index = 13; //the VLC tables >13 are identical to No. 13
375 j = get_vlc2(&q->gb, q->envelope_quant_index[vlc_index-1].table,
376 q->envelope_quant_index[vlc_index-1].bits,2);
377 quant_index_table[i] = quant_index_table[i-1] + j - 12; //differential encoding
382 * Calculate the category and category_index vector.
384 * @param q pointer to the COOKContext
385 * @param quant_index_table pointer to the array
386 * @param category pointer to the category array
387 * @param category_index pointer to the category_index array
390 static void categorize(COOKContext *q, COOKSubpacket *p, int* quant_index_table,
391 int* category, int* category_index){
392 int exp_idx, bias, tmpbias1, tmpbias2, bits_left, num_bits, index, v, i, j;
396 int tmp_categorize_array[128*2];
397 int tmp_categorize_array1_idx=p->numvector_size;
398 int tmp_categorize_array2_idx=p->numvector_size;
400 bits_left = p->bits_per_subpacket - get_bits_count(&q->gb);
402 if(bits_left > q->samples_per_channel) {
403 bits_left = q->samples_per_channel +
404 ((bits_left - q->samples_per_channel)*5)/8;
405 //av_log(q->avctx, AV_LOG_ERROR, "bits_left = %d\n",bits_left);
408 memset(&exp_index1, 0, sizeof(exp_index1));
409 memset(&exp_index2, 0, sizeof(exp_index2));
410 memset(&tmp_categorize_array, 0, sizeof(tmp_categorize_array));
415 for (i=32 ; i>0 ; i=i/2){
418 for (j=p->total_subbands ; j>0 ; j--){
419 exp_idx = av_clip((i - quant_index_table[index] + bias) / 2, 0, 7);
421 num_bits+=expbits_tab[exp_idx];
423 if(num_bits >= bits_left - 32){
428 /* Calculate total number of bits. */
430 for (i=0 ; i<p->total_subbands ; i++) {
431 exp_idx = av_clip((bias - quant_index_table[i]) / 2, 0, 7);
432 num_bits += expbits_tab[exp_idx];
433 exp_index1[i] = exp_idx;
434 exp_index2[i] = exp_idx;
436 tmpbias1 = tmpbias2 = num_bits;
438 for (j = 1 ; j < p->numvector_size ; j++) {
439 if (tmpbias1 + tmpbias2 > 2*bits_left) { /* ---> */
442 for (i=0 ; i<p->total_subbands ; i++){
443 if (exp_index1[i] < 7) {
444 v = (-2*exp_index1[i]) - quant_index_table[i] + bias;
452 tmp_categorize_array[tmp_categorize_array1_idx++] = index;
453 tmpbias1 -= expbits_tab[exp_index1[index]] -
454 expbits_tab[exp_index1[index]+1];
459 for (i=0 ; i<p->total_subbands ; i++){
460 if(exp_index2[i] > 0){
461 v = (-2*exp_index2[i])-quant_index_table[i]+bias;
468 if(index == -1)break;
469 tmp_categorize_array[--tmp_categorize_array2_idx] = index;
470 tmpbias2 -= expbits_tab[exp_index2[index]] -
471 expbits_tab[exp_index2[index]-1];
476 for(i=0 ; i<p->total_subbands ; i++)
477 category[i] = exp_index2[i];
479 for(i=0 ; i<p->numvector_size-1 ; i++)
480 category_index[i] = tmp_categorize_array[tmp_categorize_array2_idx++];
486 * Expand the category vector.
488 * @param q pointer to the COOKContext
489 * @param category pointer to the category array
490 * @param category_index pointer to the category_index array
493 static inline void expand_category(COOKContext *q, int* category,
494 int* category_index){
496 for(i=0 ; i<q->num_vectors ; i++){
497 ++category[category_index[i]];
502 * The real requantization of the mltcoefs
504 * @param q pointer to the COOKContext
506 * @param quant_index quantisation index
507 * @param subband_coef_index array of indexes to quant_centroid_tab
508 * @param subband_coef_sign signs of coefficients
509 * @param mlt_p pointer into the mlt buffer
512 static void scalar_dequant_float(COOKContext *q, int index, int quant_index,
513 int* subband_coef_index, int* subband_coef_sign,
518 for(i=0 ; i<SUBBAND_SIZE ; i++) {
519 if (subband_coef_index[i]) {
520 f1 = quant_centroid_tab[index][subband_coef_index[i]];
521 if (subband_coef_sign[i]) f1 = -f1;
523 /* noise coding if subband_coef_index[i] == 0 */
524 f1 = dither_tab[index];
525 if (av_lfg_get(&q->random_state) < 0x80000000) f1 = -f1;
527 mlt_p[i] = f1 * rootpow2tab[quant_index+63];
531 * Unpack the subband_coef_index and subband_coef_sign vectors.
533 * @param q pointer to the COOKContext
534 * @param category pointer to the category array
535 * @param subband_coef_index array of indexes to quant_centroid_tab
536 * @param subband_coef_sign signs of coefficients
539 static int unpack_SQVH(COOKContext *q, COOKSubpacket *p, int category, int* subband_coef_index,
540 int* subband_coef_sign) {
542 int vlc, vd ,tmp, result;
544 vd = vd_tab[category];
546 for(i=0 ; i<vpr_tab[category] ; i++){
547 vlc = get_vlc2(&q->gb, q->sqvh[category].table, q->sqvh[category].bits, 3);
548 if (p->bits_per_subpacket < get_bits_count(&q->gb)){
552 for(j=vd-1 ; j>=0 ; j--){
553 tmp = (vlc * invradix_tab[category])/0x100000;
554 subband_coef_index[vd*i+j] = vlc - tmp * (kmax_tab[category]+1);
557 for(j=0 ; j<vd ; j++){
558 if (subband_coef_index[i*vd + j]) {
559 if(get_bits_count(&q->gb) < p->bits_per_subpacket){
560 subband_coef_sign[i*vd+j] = get_bits1(&q->gb);
563 subband_coef_sign[i*vd+j]=0;
566 subband_coef_sign[i*vd+j]=0;
575 * Fill the mlt_buffer with mlt coefficients.
577 * @param q pointer to the COOKContext
578 * @param category pointer to the category array
579 * @param quant_index_table pointer to the array
580 * @param mlt_buffer pointer to mlt coefficients
584 static void decode_vectors(COOKContext* q, COOKSubpacket* p, int* category,
585 int *quant_index_table, float* mlt_buffer){
586 /* A zero in this table means that the subband coefficient is
587 random noise coded. */
588 int subband_coef_index[SUBBAND_SIZE];
589 /* A zero in this table means that the subband coefficient is a
590 positive multiplicator. */
591 int subband_coef_sign[SUBBAND_SIZE];
595 for(band=0 ; band<p->total_subbands ; band++){
596 index = category[band];
597 if(category[band] < 7){
598 if(unpack_SQVH(q, p, category[band], subband_coef_index, subband_coef_sign)){
600 for(j=0 ; j<p->total_subbands ; j++) category[band+j]=7;
604 memset(subband_coef_index, 0, sizeof(subband_coef_index));
605 memset(subband_coef_sign, 0, sizeof(subband_coef_sign));
607 q->scalar_dequant(q, index, quant_index_table[band],
608 subband_coef_index, subband_coef_sign,
609 &mlt_buffer[band * SUBBAND_SIZE]);
612 if(p->total_subbands*SUBBAND_SIZE >= q->samples_per_channel){
614 } /* FIXME: should this be removed, or moved into loop above? */
619 * function for decoding mono data
621 * @param q pointer to the COOKContext
622 * @param mlt_buffer pointer to mlt coefficients
625 static void mono_decode(COOKContext *q, COOKSubpacket *p, float* mlt_buffer) {
627 int category_index[128];
628 int quant_index_table[102];
631 memset(&category, 0, sizeof(category));
632 memset(&category_index, 0, sizeof(category_index));
634 decode_envelope(q, p, quant_index_table);
635 q->num_vectors = get_bits(&q->gb,p->log2_numvector_size);
636 categorize(q, p, quant_index_table, category, category_index);
637 expand_category(q, category, category_index);
638 decode_vectors(q, p, category, quant_index_table, mlt_buffer);
643 * the actual requantization of the timedomain samples
645 * @param q pointer to the COOKContext
646 * @param buffer pointer to the timedomain buffer
647 * @param gain_index index for the block multiplier
648 * @param gain_index_next index for the next block multiplier
651 static void interpolate_float(COOKContext *q, float* buffer,
652 int gain_index, int gain_index_next){
655 fc1 = pow2tab[gain_index+63];
657 if(gain_index == gain_index_next){ //static gain
658 for(i=0 ; i<q->gain_size_factor ; i++){
662 } else { //smooth gain
663 fc2 = q->gain_table[11 + (gain_index_next-gain_index)];
664 for(i=0 ; i<q->gain_size_factor ; i++){
673 * Apply transform window, overlap buffers.
675 * @param q pointer to the COOKContext
676 * @param inbuffer pointer to the mltcoefficients
677 * @param gains_ptr current and previous gains
678 * @param previous_buffer pointer to the previous buffer to be used for overlapping
681 static void imlt_window_float (COOKContext *q, float *inbuffer,
682 cook_gains *gains_ptr, float *previous_buffer)
684 const float fc = pow2tab[gains_ptr->previous[0] + 63];
686 /* The weird thing here, is that the two halves of the time domain
687 * buffer are swapped. Also, the newest data, that we save away for
688 * next frame, has the wrong sign. Hence the subtraction below.
689 * Almost sounds like a complex conjugate/reverse data/FFT effect.
692 /* Apply window and overlap */
693 for(i = 0; i < q->samples_per_channel; i++){
694 inbuffer[i] = inbuffer[i] * fc * q->mlt_window[i] -
695 previous_buffer[i] * q->mlt_window[q->samples_per_channel - 1 - i];
700 * The modulated lapped transform, this takes transform coefficients
701 * and transforms them into timedomain samples.
702 * Apply transform window, overlap buffers, apply gain profile
703 * and buffer management.
705 * @param q pointer to the COOKContext
706 * @param inbuffer pointer to the mltcoefficients
707 * @param gains_ptr current and previous gains
708 * @param previous_buffer pointer to the previous buffer to be used for overlapping
711 static void imlt_gain(COOKContext *q, float *inbuffer,
712 cook_gains *gains_ptr, float* previous_buffer)
714 float *buffer0 = q->mono_mdct_output;
715 float *buffer1 = q->mono_mdct_output + q->samples_per_channel;
718 /* Inverse modified discrete cosine transform */
719 q->mdct_ctx.imdct_calc(&q->mdct_ctx, q->mono_mdct_output, inbuffer);
721 q->imlt_window (q, buffer1, gains_ptr, previous_buffer);
723 /* Apply gain profile */
724 for (i = 0; i < 8; i++) {
725 if (gains_ptr->now[i] || gains_ptr->now[i + 1])
726 q->interpolate(q, &buffer1[q->gain_size_factor * i],
727 gains_ptr->now[i], gains_ptr->now[i + 1]);
730 /* Save away the current to be previous block. */
731 memcpy(previous_buffer, buffer0,
732 q->samples_per_channel * sizeof(*previous_buffer));
737 * function for getting the jointstereo coupling information
739 * @param q pointer to the COOKContext
740 * @param decouple_tab decoupling array
744 static void decouple_info(COOKContext *q, COOKSubpacket *p, int* decouple_tab){
747 if(get_bits1(&q->gb)) {
748 if(cplband[p->js_subband_start] > cplband[p->subbands-1]) return;
750 length = cplband[p->subbands-1] - cplband[p->js_subband_start] + 1;
751 for (i=0 ; i<length ; i++) {
752 decouple_tab[cplband[p->js_subband_start] + i] = get_vlc2(&q->gb, p->ccpl.table, p->ccpl.bits, 2);
757 if(cplband[p->js_subband_start] > cplband[p->subbands-1]) return;
759 length = cplband[p->subbands-1] - cplband[p->js_subband_start] + 1;
760 for (i=0 ; i<length ; i++) {
761 decouple_tab[cplband[p->js_subband_start] + i] = get_bits(&q->gb, p->js_vlc_bits);
767 * function decouples a pair of signals from a single signal via multiplication.
769 * @param q pointer to the COOKContext
770 * @param subband index of the current subband
771 * @param f1 multiplier for channel 1 extraction
772 * @param f2 multiplier for channel 2 extraction
773 * @param decode_buffer input buffer
774 * @param mlt_buffer1 pointer to left channel mlt coefficients
775 * @param mlt_buffer2 pointer to right channel mlt coefficients
777 static void decouple_float (COOKContext *q,
781 float *decode_buffer,
782 float *mlt_buffer1, float *mlt_buffer2)
785 for (j=0 ; j<SUBBAND_SIZE ; j++) {
786 tmp_idx = ((p->js_subband_start + subband)*SUBBAND_SIZE)+j;
787 mlt_buffer1[SUBBAND_SIZE*subband + j] = f1 * decode_buffer[tmp_idx];
788 mlt_buffer2[SUBBAND_SIZE*subband + j] = f2 * decode_buffer[tmp_idx];
793 * function for decoding joint stereo data
795 * @param q pointer to the COOKContext
796 * @param mlt_buffer1 pointer to left channel mlt coefficients
797 * @param mlt_buffer2 pointer to right channel mlt coefficients
800 static void joint_decode(COOKContext *q, COOKSubpacket *p, float* mlt_buffer1,
801 float* mlt_buffer2) {
803 int decouple_tab[SUBBAND_SIZE];
804 float *decode_buffer = q->decode_buffer_0;
807 const float* cplscale;
809 memset(decouple_tab, 0, sizeof(decouple_tab));
810 memset(decode_buffer, 0, sizeof(q->decode_buffer_0));
812 /* Make sure the buffers are zeroed out. */
813 memset(mlt_buffer1, 0, 1024 * sizeof(*mlt_buffer1));
814 memset(mlt_buffer2, 0, 1024 * sizeof(*mlt_buffer2));
815 decouple_info(q, p, decouple_tab);
816 mono_decode(q, p, decode_buffer);
818 /* The two channels are stored interleaved in decode_buffer. */
819 for (i=0 ; i<p->js_subband_start ; i++) {
820 for (j=0 ; j<SUBBAND_SIZE ; j++) {
821 mlt_buffer1[i*20+j] = decode_buffer[i*40+j];
822 mlt_buffer2[i*20+j] = decode_buffer[i*40+20+j];
826 /* When we reach js_subband_start (the higher frequencies)
827 the coefficients are stored in a coupling scheme. */
828 idx = (1 << p->js_vlc_bits) - 1;
829 for (i=p->js_subband_start ; i<p->subbands ; i++) {
830 cpl_tmp = cplband[i];
831 idx -=decouple_tab[cpl_tmp];
832 cplscale = q->cplscales[p->js_vlc_bits-2]; //choose decoupler table
833 f1 = cplscale[decouple_tab[cpl_tmp]];
834 f2 = cplscale[idx-1];
835 q->decouple (q, p, i, f1, f2, decode_buffer, mlt_buffer1, mlt_buffer2);
836 idx = (1 << p->js_vlc_bits) - 1;
841 * First part of subpacket decoding:
842 * decode raw stream bytes and read gain info.
844 * @param q pointer to the COOKContext
845 * @param inbuffer pointer to raw stream data
846 * @param gains_ptr array of current/prev gain pointers
850 decode_bytes_and_gain(COOKContext *q, COOKSubpacket *p, const uint8_t *inbuffer,
851 cook_gains *gains_ptr)
855 offset = decode_bytes(inbuffer, q->decoded_bytes_buffer,
856 p->bits_per_subpacket/8);
857 init_get_bits(&q->gb, q->decoded_bytes_buffer + offset,
858 p->bits_per_subpacket);
859 decode_gain_info(&q->gb, gains_ptr->now);
861 /* Swap current and previous gains */
862 FFSWAP(int *, gains_ptr->now, gains_ptr->previous);
866 * Saturate the output signal and interleave.
868 * @param q pointer to the COOKContext
869 * @param chan channel to saturate
870 * @param out pointer to the output vector
872 static void saturate_output_float(COOKContext *q, int chan, float *out)
875 float *output = q->mono_mdct_output + q->samples_per_channel;
876 for (j = 0; j < q->samples_per_channel; j++) {
877 out[chan + q->nb_channels * j] = av_clipf(output[j], -1.0, 1.0);
882 * Final part of subpacket decoding:
883 * Apply modulated lapped transform, gain compensation,
884 * clip and convert to integer.
886 * @param q pointer to the COOKContext
887 * @param decode_buffer pointer to the mlt coefficients
888 * @param gains_ptr array of current/prev gain pointers
889 * @param previous_buffer pointer to the previous buffer to be used for overlapping
890 * @param out pointer to the output buffer
891 * @param chan 0: left or single channel, 1: right channel
895 mlt_compensate_output(COOKContext *q, float *decode_buffer,
896 cook_gains *gains_ptr, float *previous_buffer,
897 float *out, int chan)
899 imlt_gain(q, decode_buffer, gains_ptr, previous_buffer);
900 q->saturate_output (q, chan, out);
905 * Cook subpacket decoding. This function returns one decoded subpacket,
906 * usually 1024 samples per channel.
908 * @param q pointer to the COOKContext
909 * @param inbuffer pointer to the inbuffer
910 * @param outbuffer pointer to the outbuffer
912 static void decode_subpacket(COOKContext *q, COOKSubpacket *p,
913 const uint8_t *inbuffer, float *outbuffer)
915 int sub_packet_size = p->size;
917 // for (i=0 ; i<sub_packet_size ; i++) {
918 // av_log(q->avctx, AV_LOG_ERROR, "%02x", inbuffer[i]);
920 // av_log(q->avctx, AV_LOG_ERROR, "\n");
921 memset(q->decode_buffer_1,0,sizeof(q->decode_buffer_1));
922 decode_bytes_and_gain(q, p, inbuffer, &p->gains1);
924 if (p->joint_stereo) {
925 joint_decode(q, p, q->decode_buffer_1, q->decode_buffer_2);
927 mono_decode(q, p, q->decode_buffer_1);
929 if (p->num_channels == 2) {
930 decode_bytes_and_gain(q, p, inbuffer + sub_packet_size/2, &p->gains2);
931 mono_decode(q, p, q->decode_buffer_2);
935 mlt_compensate_output(q, q->decode_buffer_1, &p->gains1,
936 p->mono_previous_buffer1, outbuffer, p->ch_idx);
938 if (p->num_channels == 2) {
939 if (p->joint_stereo) {
940 mlt_compensate_output(q, q->decode_buffer_2, &p->gains1,
941 p->mono_previous_buffer2, outbuffer, p->ch_idx + 1);
943 mlt_compensate_output(q, q->decode_buffer_2, &p->gains2,
944 p->mono_previous_buffer2, outbuffer, p->ch_idx + 1);
952 * Cook frame decoding
954 * @param avctx pointer to the AVCodecContext
957 static int cook_decode_frame(AVCodecContext *avctx,
958 void *data, int *data_size,
960 const uint8_t *buf = avpkt->data;
961 int buf_size = avpkt->size;
962 COOKContext *q = avctx->priv_data;
967 if (buf_size < avctx->block_align)
970 /* estimate subpacket sizes */
971 q->subpacket[0].size = avctx->block_align;
973 for(i=1;i<q->num_subpackets;i++){
974 q->subpacket[i].size = 2 * buf[avctx->block_align - q->num_subpackets + i];
975 q->subpacket[0].size -= q->subpacket[i].size + 1;
976 if (q->subpacket[0].size < 0) {
977 av_log(avctx,AV_LOG_DEBUG,"frame subpacket size total > avctx->block_align!\n");
982 /* decode supbackets */
984 for(i=0;i<q->num_subpackets;i++){
985 q->subpacket[i].bits_per_subpacket = (q->subpacket[i].size*8)>>q->subpacket[i].bits_per_subpdiv;
986 q->subpacket[i].ch_idx = chidx;
987 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);
988 decode_subpacket(q, &q->subpacket[i], buf + offset, data);
989 offset += q->subpacket[i].size;
990 chidx += q->subpacket[i].num_channels;
991 av_log(avctx,AV_LOG_DEBUG,"subpacket[%i] %i %i\n",i,q->subpacket[i].size * 8,get_bits_count(&q->gb));
993 *data_size = q->nb_channels * q->samples_per_channel *
994 av_get_bytes_per_sample(avctx->sample_fmt);
996 /* Discard the first two frames: no valid audio. */
997 if (avctx->frame_number < 2) *data_size = 0;
999 return avctx->block_align;
1003 static void dump_cook_context(COOKContext *q)
1006 #define PRINT(a,b) av_log(q->avctx,AV_LOG_ERROR," %s = %d\n", a, b);
1007 av_log(q->avctx,AV_LOG_ERROR,"COOKextradata\n");
1008 av_log(q->avctx,AV_LOG_ERROR,"cookversion=%x\n",q->subpacket[0].cookversion);
1009 if (q->subpacket[0].cookversion > STEREO) {
1010 PRINT("js_subband_start",q->subpacket[0].js_subband_start);
1011 PRINT("js_vlc_bits",q->subpacket[0].js_vlc_bits);
1013 av_log(q->avctx,AV_LOG_ERROR,"COOKContext\n");
1014 PRINT("nb_channels",q->nb_channels);
1015 PRINT("bit_rate",q->bit_rate);
1016 PRINT("sample_rate",q->sample_rate);
1017 PRINT("samples_per_channel",q->subpacket[0].samples_per_channel);
1018 PRINT("samples_per_frame",q->subpacket[0].samples_per_frame);
1019 PRINT("subbands",q->subpacket[0].subbands);
1020 PRINT("js_subband_start",q->subpacket[0].js_subband_start);
1021 PRINT("log2_numvector_size",q->subpacket[0].log2_numvector_size);
1022 PRINT("numvector_size",q->subpacket[0].numvector_size);
1023 PRINT("total_subbands",q->subpacket[0].total_subbands);
1027 static av_cold int cook_count_channels(unsigned int mask){
1030 for(i = 0;i<32;i++){
1038 * Cook initialization
1040 * @param avctx pointer to the AVCodecContext
1043 static av_cold int cook_decode_init(AVCodecContext *avctx)
1045 COOKContext *q = avctx->priv_data;
1046 const uint8_t *edata_ptr = avctx->extradata;
1047 const uint8_t *edata_ptr_end = edata_ptr + avctx->extradata_size;
1048 int extradata_size = avctx->extradata_size;
1050 unsigned int channel_mask = 0;
1053 /* Take care of the codec specific extradata. */
1054 if (extradata_size <= 0) {
1055 av_log(avctx,AV_LOG_ERROR,"Necessary extradata missing!\n");
1058 av_log(avctx,AV_LOG_DEBUG,"codecdata_length=%d\n",avctx->extradata_size);
1060 /* Take data from the AVCodecContext (RM container). */
1061 q->sample_rate = avctx->sample_rate;
1062 q->nb_channels = avctx->channels;
1063 q->bit_rate = avctx->bit_rate;
1065 /* Initialize RNG. */
1066 av_lfg_init(&q->random_state, 0);
1068 while(edata_ptr < edata_ptr_end){
1069 /* 8 for mono, 16 for stereo, ? for multichannel
1070 Swap to right endianness so we don't need to care later on. */
1071 if (extradata_size >= 8){
1072 q->subpacket[s].cookversion = bytestream_get_be32(&edata_ptr);
1073 q->subpacket[s].samples_per_frame = bytestream_get_be16(&edata_ptr);
1074 q->subpacket[s].subbands = bytestream_get_be16(&edata_ptr);
1075 extradata_size -= 8;
1077 if (avctx->extradata_size >= 8){
1078 bytestream_get_be32(&edata_ptr); //Unknown unused
1079 q->subpacket[s].js_subband_start = bytestream_get_be16(&edata_ptr);
1080 q->subpacket[s].js_vlc_bits = bytestream_get_be16(&edata_ptr);
1081 extradata_size -= 8;
1084 /* Initialize extradata related variables. */
1085 q->subpacket[s].samples_per_channel = q->subpacket[s].samples_per_frame / q->nb_channels;
1086 q->subpacket[s].bits_per_subpacket = avctx->block_align * 8;
1088 /* Initialize default data states. */
1089 q->subpacket[s].log2_numvector_size = 5;
1090 q->subpacket[s].total_subbands = q->subpacket[s].subbands;
1091 q->subpacket[s].num_channels = 1;
1093 /* Initialize version-dependent variables */
1095 av_log(avctx,AV_LOG_DEBUG,"subpacket[%i].cookversion=%x\n",s,q->subpacket[s].cookversion);
1096 q->subpacket[s].joint_stereo = 0;
1097 switch (q->subpacket[s].cookversion) {
1099 if (q->nb_channels != 1) {
1100 av_log_ask_for_sample(avctx, "Container channels != 1.\n");
1103 av_log(avctx,AV_LOG_DEBUG,"MONO\n");
1106 if (q->nb_channels != 1) {
1107 q->subpacket[s].bits_per_subpdiv = 1;
1108 q->subpacket[s].num_channels = 2;
1110 av_log(avctx,AV_LOG_DEBUG,"STEREO\n");
1113 if (q->nb_channels != 2) {
1114 av_log_ask_for_sample(avctx, "Container channels != 2.\n");
1117 av_log(avctx,AV_LOG_DEBUG,"JOINT_STEREO\n");
1118 if (avctx->extradata_size >= 16){
1119 q->subpacket[s].total_subbands = q->subpacket[s].subbands + q->subpacket[s].js_subband_start;
1120 q->subpacket[s].joint_stereo = 1;
1121 q->subpacket[s].num_channels = 2;
1123 if (q->subpacket[s].samples_per_channel > 256) {
1124 q->subpacket[s].log2_numvector_size = 6;
1126 if (q->subpacket[s].samples_per_channel > 512) {
1127 q->subpacket[s].log2_numvector_size = 7;
1131 av_log(avctx,AV_LOG_DEBUG,"MULTI_CHANNEL\n");
1132 if(extradata_size >= 4)
1133 channel_mask |= q->subpacket[s].channel_mask = bytestream_get_be32(&edata_ptr);
1135 if(cook_count_channels(q->subpacket[s].channel_mask) > 1){
1136 q->subpacket[s].total_subbands = q->subpacket[s].subbands + q->subpacket[s].js_subband_start;
1137 q->subpacket[s].joint_stereo = 1;
1138 q->subpacket[s].num_channels = 2;
1139 q->subpacket[s].samples_per_channel = q->subpacket[s].samples_per_frame >> 1;
1141 if (q->subpacket[s].samples_per_channel > 256) {
1142 q->subpacket[s].log2_numvector_size = 6;
1144 if (q->subpacket[s].samples_per_channel > 512) {
1145 q->subpacket[s].log2_numvector_size = 7;
1148 q->subpacket[s].samples_per_channel = q->subpacket[s].samples_per_frame;
1152 av_log_ask_for_sample(avctx, "Unknown Cook version.\n");
1156 if(s > 1 && q->subpacket[s].samples_per_channel != q->samples_per_channel) {
1157 av_log(avctx,AV_LOG_ERROR,"different number of samples per channel!\n");
1160 q->samples_per_channel = q->subpacket[0].samples_per_channel;
1163 /* Initialize variable relations */
1164 q->subpacket[s].numvector_size = (1 << q->subpacket[s].log2_numvector_size);
1166 /* Try to catch some obviously faulty streams, othervise it might be exploitable */
1167 if (q->subpacket[s].total_subbands > 53) {
1168 av_log_ask_for_sample(avctx, "total_subbands > 53\n");
1172 if ((q->subpacket[s].js_vlc_bits > 6) || (q->subpacket[s].js_vlc_bits < 2*q->subpacket[s].joint_stereo)) {
1173 av_log(avctx,AV_LOG_ERROR,"js_vlc_bits = %d, only >= %d and <= 6 allowed!\n",
1174 q->subpacket[s].js_vlc_bits, 2*q->subpacket[s].joint_stereo);
1178 if (q->subpacket[s].subbands > 50) {
1179 av_log_ask_for_sample(avctx, "subbands > 50\n");
1182 q->subpacket[s].gains1.now = q->subpacket[s].gain_1;
1183 q->subpacket[s].gains1.previous = q->subpacket[s].gain_2;
1184 q->subpacket[s].gains2.now = q->subpacket[s].gain_3;
1185 q->subpacket[s].gains2.previous = q->subpacket[s].gain_4;
1187 q->num_subpackets++;
1189 if (s > MAX_SUBPACKETS) {
1190 av_log_ask_for_sample(avctx, "Too many subpackets > 5\n");
1194 /* Generate tables */
1197 init_cplscales_table(q);
1199 if (init_cook_vlc_tables(q) != 0)
1203 if(avctx->block_align >= UINT_MAX/2)
1206 /* Pad the databuffer with:
1207 DECODE_BYTES_PAD1 or DECODE_BYTES_PAD2 for decode_bytes(),
1208 FF_INPUT_BUFFER_PADDING_SIZE, for the bitstreamreader. */
1209 q->decoded_bytes_buffer =
1210 av_mallocz(avctx->block_align
1211 + DECODE_BYTES_PAD1(avctx->block_align)
1212 + FF_INPUT_BUFFER_PADDING_SIZE);
1213 if (q->decoded_bytes_buffer == NULL)
1216 /* Initialize transform. */
1217 if ( init_cook_mlt(q) != 0 )
1220 /* Initialize COOK signal arithmetic handling */
1222 q->scalar_dequant = scalar_dequant_float;
1223 q->decouple = decouple_float;
1224 q->imlt_window = imlt_window_float;
1225 q->interpolate = interpolate_float;
1226 q->saturate_output = saturate_output_float;
1229 /* Try to catch some obviously faulty streams, othervise it might be exploitable */
1230 if ((q->samples_per_channel == 256) || (q->samples_per_channel == 512) || (q->samples_per_channel == 1024)) {
1232 av_log_ask_for_sample(avctx,
1233 "unknown amount of samples_per_channel = %d\n",
1234 q->samples_per_channel);
1238 avctx->sample_fmt = AV_SAMPLE_FMT_FLT;
1240 avctx->channel_layout = channel_mask;
1242 avctx->channel_layout = (avctx->channels==2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
1245 dump_cook_context(q);
1251 AVCodec ff_cook_decoder =
1254 .type = AVMEDIA_TYPE_AUDIO,
1255 .id = CODEC_ID_COOK,
1256 .priv_data_size = sizeof(COOKContext),
1257 .init = cook_decode_init,
1258 .close = cook_decode_close,
1259 .decode = cook_decode_frame,
1260 .long_name = NULL_IF_CONFIG_SMALL("COOK"),