2 * COOK compatible decoder
3 * Copyright (c) 2003 Sascha Sommer
4 * Copyright (c) 2005 Benjamin Larsson
6 * This file is part of FFmpeg.
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.
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.
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
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/channel_layout.h"
46 #include "libavutil/lfg.h"
51 #include "bytestream.h"
59 /* the different Cook versions */
60 #define MONO 0x1000001
61 #define STEREO 0x1000002
62 #define JOINT_STEREO 0x1000003
63 #define MC_COOK 0x2000000
65 #define SUBBAND_SIZE 20
66 #define MAX_SUBPACKETS 5
68 #define QUANT_VLC_BITS 9
69 #define COUPLING_VLC_BITS 6
71 typedef struct cook_gains {
76 typedef struct COOKSubpacket {
84 int samples_per_channel;
85 int log2_numvector_size;
86 unsigned int channel_mask;
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, float *out);
129 AVCodecContext* avctx;
130 AudioDSPContext adsp;
134 int samples_per_channel;
137 int discarded_packets;
144 VLC envelope_quant_index[13];
145 VLC sqvh[7]; // scalar quantization
147 /* generate tables and related variables */
148 int gain_size_factor;
149 float gain_table[31];
153 uint8_t* decoded_bytes_buffer;
154 DECLARE_ALIGNED(32, float, mono_mdct_output)[2048];
155 float decode_buffer_1[1024];
156 float decode_buffer_2[1024];
157 float decode_buffer_0[1060]; /* static allocation for joint decode */
159 const float *cplscales[5];
161 COOKSubpacket subpacket[MAX_SUBPACKETS];
164 static float pow2tab[127];
165 static float rootpow2tab[127];
167 /*************** init functions ***************/
169 /* table generator */
170 static av_cold void init_pow2table(void)
172 /* fast way of computing 2^i and 2^(0.5*i) for -63 <= i < 64 */
174 static const float exp2_tab[2] = {1, M_SQRT2};
175 float exp2_val = powf(2, -63);
176 float root_val = powf(2, -32);
177 for (i = -63; i < 64; i++) {
180 pow2tab[63 + i] = exp2_val;
181 rootpow2tab[63 + i] = root_val * exp2_tab[i & 1];
186 /* table generator */
187 static av_cold void init_gain_table(COOKContext *q)
190 q->gain_size_factor = q->samples_per_channel / 8;
191 for (i = 0; i < 31; i++)
192 q->gain_table[i] = pow(pow2tab[i + 48],
193 (1.0 / (double) q->gain_size_factor));
196 static av_cold int build_vlc(VLC *vlc, int nb_bits, const uint8_t counts[16],
197 const void *syms, int symbol_size, int offset,
200 uint8_t lens[MAX_COOK_VLC_ENTRIES];
203 for (int i = 0; i < 16; i++)
204 for (unsigned count = num + counts[i]; num < count; num++)
207 return ff_init_vlc_from_lengths(vlc, nb_bits, num, lens, 1,
208 syms, symbol_size, symbol_size,
212 static av_cold int init_cook_vlc_tables(COOKContext *q)
217 for (i = 0; i < 13; i++) {
218 result |= build_vlc(&q->envelope_quant_index[i], QUANT_VLC_BITS,
219 envelope_quant_index_huffcounts[i],
220 envelope_quant_index_huffsyms[i], 1, -12, q->avctx);
222 av_log(q->avctx, AV_LOG_DEBUG, "sqvh VLC init\n");
223 for (i = 0; i < 7; i++) {
224 int sym_size = 1 + (i == 3);
225 result |= build_vlc(&q->sqvh[i], vhvlcsize_tab[i],
227 cvh_huffsyms[i], sym_size, 0, q->avctx);
230 for (i = 0; i < q->num_subpackets; i++) {
231 if (q->subpacket[i].joint_stereo == 1) {
232 result |= build_vlc(&q->subpacket[i].channel_coupling, COUPLING_VLC_BITS,
233 ccpl_huffcounts[q->subpacket[i].js_vlc_bits - 2],
234 ccpl_huffsyms[q->subpacket[i].js_vlc_bits - 2], 1,
236 av_log(q->avctx, AV_LOG_DEBUG, "subpacket %i Joint-stereo VLC used.\n", i);
240 av_log(q->avctx, AV_LOG_DEBUG, "VLC tables initialized.\n");
244 static av_cold int init_cook_mlt(COOKContext *q)
247 int mlt_size = q->samples_per_channel;
249 if ((q->mlt_window = av_malloc_array(mlt_size, sizeof(*q->mlt_window))) == 0)
250 return AVERROR(ENOMEM);
252 /* Initialize the MLT window: simple sine window. */
253 ff_sine_window_init(q->mlt_window, mlt_size);
254 for (j = 0; j < mlt_size; j++)
255 q->mlt_window[j] *= sqrt(2.0 / q->samples_per_channel);
257 /* Initialize the MDCT. */
258 if ((ret = ff_mdct_init(&q->mdct_ctx, av_log2(mlt_size) + 1, 1, 1.0 / 32768.0))) {
259 av_freep(&q->mlt_window);
262 av_log(q->avctx, AV_LOG_DEBUG, "MDCT initialized, order = %d.\n",
263 av_log2(mlt_size) + 1);
268 static av_cold void init_cplscales_table(COOKContext *q)
271 for (i = 0; i < 5; i++)
272 q->cplscales[i] = cplscales[i];
275 /*************** init functions end ***********/
277 #define DECODE_BYTES_PAD1(bytes) (3 - ((bytes) + 3) % 4)
278 #define DECODE_BYTES_PAD2(bytes) ((bytes) % 4 + DECODE_BYTES_PAD1(2 * (bytes)))
281 * Cook indata decoding, every 32 bits are XORed with 0x37c511f2.
282 * Why? No idea, some checksum/error detection method maybe.
284 * Out buffer size: extra bytes are needed to cope with
285 * padding/misalignment.
286 * Subpackets passed to the decoder can contain two, consecutive
287 * half-subpackets, of identical but arbitrary size.
288 * 1234 1234 1234 1234 extraA extraB
289 * Case 1: AAAA BBBB 0 0
290 * Case 2: AAAA ABBB BB-- 3 3
291 * Case 3: AAAA AABB BBBB 2 2
292 * Case 4: AAAA AAAB BBBB BB-- 1 5
294 * Nice way to waste CPU cycles.
296 * @param inbuffer pointer to byte array of indata
297 * @param out pointer to byte array of outdata
298 * @param bytes number of bytes
300 static inline int decode_bytes(const uint8_t *inbuffer, uint8_t *out, int bytes)
302 static const uint32_t tab[4] = {
303 AV_BE2NE32C(0x37c511f2u), AV_BE2NE32C(0xf237c511u),
304 AV_BE2NE32C(0x11f237c5u), AV_BE2NE32C(0xc511f237u),
309 uint32_t *obuf = (uint32_t *) out;
310 /* FIXME: 64 bit platforms would be able to do 64 bits at a time.
311 * I'm too lazy though, should be something like
312 * for (i = 0; i < bitamount / 64; i++)
313 * (int64_t) out[i] = 0x37c511f237c511f2 ^ av_be2ne64(int64_t) in[i]);
314 * Buffer alignment needs to be checked. */
316 off = (intptr_t) inbuffer & 3;
317 buf = (const uint32_t *) (inbuffer - off);
320 for (i = 0; i < bytes / 4; i++)
321 obuf[i] = c ^ buf[i];
326 static av_cold int cook_decode_close(AVCodecContext *avctx)
329 COOKContext *q = avctx->priv_data;
330 av_log(avctx, AV_LOG_DEBUG, "Deallocating memory.\n");
332 /* Free allocated memory buffers. */
333 av_freep(&q->mlt_window);
334 av_freep(&q->decoded_bytes_buffer);
336 /* Free the transform. */
337 ff_mdct_end(&q->mdct_ctx);
339 /* Free the VLC tables. */
340 for (i = 0; i < 13; i++)
341 ff_free_vlc(&q->envelope_quant_index[i]);
342 for (i = 0; i < 7; i++)
343 ff_free_vlc(&q->sqvh[i]);
344 for (i = 0; i < q->num_subpackets; i++)
345 ff_free_vlc(&q->subpacket[i].channel_coupling);
347 av_log(avctx, AV_LOG_DEBUG, "Memory deallocated.\n");
353 * Fill the gain array for the timedomain quantization.
355 * @param gb pointer to the GetBitContext
356 * @param gaininfo array[9] of gain indexes
358 static void decode_gain_info(GetBitContext *gb, int *gaininfo)
362 n = get_unary(gb, 0, get_bits_left(gb)); // amount of elements*2 to update
366 int index = get_bits(gb, 3);
367 int gain = get_bits1(gb) ? get_bits(gb, 4) - 7 : -1;
370 gaininfo[i++] = gain;
377 * Create the quant index table needed for the envelope.
379 * @param q pointer to the COOKContext
380 * @param quant_index_table pointer to the array
382 static int decode_envelope(COOKContext *q, COOKSubpacket *p,
383 int *quant_index_table)
387 quant_index_table[0] = get_bits(&q->gb, 6) - 6; // This is used later in categorize
389 for (i = 1; i < p->total_subbands; i++) {
391 if (i >= p->js_subband_start * 2) {
392 vlc_index -= p->js_subband_start;
399 vlc_index = 13; // the VLC tables >13 are identical to No. 13
401 j = get_vlc2(&q->gb, q->envelope_quant_index[vlc_index - 1].table,
403 quant_index_table[i] = quant_index_table[i - 1] + j; // differential encoding
404 if (quant_index_table[i] > 63 || quant_index_table[i] < -63) {
405 av_log(q->avctx, AV_LOG_ERROR,
406 "Invalid quantizer %d at position %d, outside [-63, 63] range\n",
407 quant_index_table[i], i);
408 return AVERROR_INVALIDDATA;
416 * Calculate the category and category_index vector.
418 * @param q pointer to the COOKContext
419 * @param quant_index_table pointer to the array
420 * @param category pointer to the category array
421 * @param category_index pointer to the category_index array
423 static void categorize(COOKContext *q, COOKSubpacket *p, const int *quant_index_table,
424 int *category, int *category_index)
426 int exp_idx, bias, tmpbias1, tmpbias2, bits_left, num_bits, index, v, i, j;
427 int exp_index2[102] = { 0 };
428 int exp_index1[102] = { 0 };
430 int tmp_categorize_array[128 * 2] = { 0 };
431 int tmp_categorize_array1_idx = p->numvector_size;
432 int tmp_categorize_array2_idx = p->numvector_size;
434 bits_left = p->bits_per_subpacket - get_bits_count(&q->gb);
436 if (bits_left > q->samples_per_channel)
437 bits_left = q->samples_per_channel +
438 ((bits_left - q->samples_per_channel) * 5) / 8;
443 for (i = 32; i > 0; i = i / 2) {
446 for (j = p->total_subbands; j > 0; j--) {
447 exp_idx = av_clip_uintp2((i - quant_index_table[index] + bias) / 2, 3);
449 num_bits += expbits_tab[exp_idx];
451 if (num_bits >= bits_left - 32)
455 /* Calculate total number of bits. */
457 for (i = 0; i < p->total_subbands; i++) {
458 exp_idx = av_clip_uintp2((bias - quant_index_table[i]) / 2, 3);
459 num_bits += expbits_tab[exp_idx];
460 exp_index1[i] = exp_idx;
461 exp_index2[i] = exp_idx;
463 tmpbias1 = tmpbias2 = num_bits;
465 for (j = 1; j < p->numvector_size; j++) {
466 if (tmpbias1 + tmpbias2 > 2 * bits_left) { /* ---> */
469 for (i = 0; i < p->total_subbands; i++) {
470 if (exp_index1[i] < 7) {
471 v = (-2 * exp_index1[i]) - quant_index_table[i] + bias;
480 tmp_categorize_array[tmp_categorize_array1_idx++] = index;
481 tmpbias1 -= expbits_tab[exp_index1[index]] -
482 expbits_tab[exp_index1[index] + 1];
487 for (i = 0; i < p->total_subbands; i++) {
488 if (exp_index2[i] > 0) {
489 v = (-2 * exp_index2[i]) - quant_index_table[i] + bias;
498 tmp_categorize_array[--tmp_categorize_array2_idx] = index;
499 tmpbias2 -= expbits_tab[exp_index2[index]] -
500 expbits_tab[exp_index2[index] - 1];
505 for (i = 0; i < p->total_subbands; i++)
506 category[i] = exp_index2[i];
508 for (i = 0; i < p->numvector_size - 1; i++)
509 category_index[i] = tmp_categorize_array[tmp_categorize_array2_idx++];
514 * Expand the category vector.
516 * @param q pointer to the COOKContext
517 * @param category pointer to the category array
518 * @param category_index pointer to the category_index array
520 static inline void expand_category(COOKContext *q, int *category,
524 for (i = 0; i < q->num_vectors; i++)
526 int idx = category_index[i];
527 if (++category[idx] >= FF_ARRAY_ELEMS(dither_tab))
533 * The real requantization of the mltcoefs
535 * @param q pointer to the COOKContext
537 * @param quant_index quantisation index
538 * @param subband_coef_index array of indexes to quant_centroid_tab
539 * @param subband_coef_sign signs of coefficients
540 * @param mlt_p pointer into the mlt buffer
542 static void scalar_dequant_float(COOKContext *q, int index, int quant_index,
543 int *subband_coef_index, int *subband_coef_sign,
549 for (i = 0; i < SUBBAND_SIZE; i++) {
550 if (subband_coef_index[i]) {
551 f1 = quant_centroid_tab[index][subband_coef_index[i]];
552 if (subband_coef_sign[i])
555 /* noise coding if subband_coef_index[i] == 0 */
556 f1 = dither_tab[index];
557 if (av_lfg_get(&q->random_state) < 0x80000000)
560 mlt_p[i] = f1 * rootpow2tab[quant_index + 63];
564 * Unpack the subband_coef_index and subband_coef_sign vectors.
566 * @param q pointer to the COOKContext
567 * @param category pointer to the category array
568 * @param subband_coef_index array of indexes to quant_centroid_tab
569 * @param subband_coef_sign signs of coefficients
571 static int unpack_SQVH(COOKContext *q, COOKSubpacket *p, int category,
572 int *subband_coef_index, int *subband_coef_sign)
575 int vlc, vd, tmp, result;
577 vd = vd_tab[category];
579 for (i = 0; i < vpr_tab[category]; i++) {
580 vlc = get_vlc2(&q->gb, q->sqvh[category].table, q->sqvh[category].bits, 3);
581 if (p->bits_per_subpacket < get_bits_count(&q->gb)) {
585 for (j = vd - 1; j >= 0; j--) {
586 tmp = (vlc * invradix_tab[category]) / 0x100000;
587 subband_coef_index[vd * i + j] = vlc - tmp * (kmax_tab[category] + 1);
590 for (j = 0; j < vd; j++) {
591 if (subband_coef_index[i * vd + j]) {
592 if (get_bits_count(&q->gb) < p->bits_per_subpacket) {
593 subband_coef_sign[i * vd + j] = get_bits1(&q->gb);
596 subband_coef_sign[i * vd + j] = 0;
599 subband_coef_sign[i * vd + j] = 0;
608 * Fill the mlt_buffer with mlt coefficients.
610 * @param q pointer to the COOKContext
611 * @param category pointer to the category array
612 * @param quant_index_table pointer to the array
613 * @param mlt_buffer pointer to mlt coefficients
615 static void decode_vectors(COOKContext *q, COOKSubpacket *p, int *category,
616 int *quant_index_table, float *mlt_buffer)
618 /* A zero in this table means that the subband coefficient is
619 random noise coded. */
620 int subband_coef_index[SUBBAND_SIZE];
621 /* A zero in this table means that the subband coefficient is a
622 positive multiplicator. */
623 int subband_coef_sign[SUBBAND_SIZE];
627 for (band = 0; band < p->total_subbands; band++) {
628 index = category[band];
629 if (category[band] < 7) {
630 if (unpack_SQVH(q, p, category[band], subband_coef_index, subband_coef_sign)) {
632 for (j = 0; j < p->total_subbands; j++)
633 category[band + j] = 7;
637 memset(subband_coef_index, 0, sizeof(subband_coef_index));
638 memset(subband_coef_sign, 0, sizeof(subband_coef_sign));
640 q->scalar_dequant(q, index, quant_index_table[band],
641 subband_coef_index, subband_coef_sign,
642 &mlt_buffer[band * SUBBAND_SIZE]);
645 /* FIXME: should this be removed, or moved into loop above? */
646 if (p->total_subbands * SUBBAND_SIZE >= q->samples_per_channel)
651 static int mono_decode(COOKContext *q, COOKSubpacket *p, float *mlt_buffer)
653 int category_index[128] = { 0 };
654 int category[128] = { 0 };
655 int quant_index_table[102];
658 if ((res = decode_envelope(q, p, quant_index_table)) < 0)
660 q->num_vectors = get_bits(&q->gb, p->log2_numvector_size);
661 categorize(q, p, quant_index_table, category, category_index);
662 expand_category(q, category, category_index);
663 for (i=0; i<p->total_subbands; i++) {
665 return AVERROR_INVALIDDATA;
667 decode_vectors(q, p, category, quant_index_table, mlt_buffer);
674 * the actual requantization of the timedomain samples
676 * @param q pointer to the COOKContext
677 * @param buffer pointer to the timedomain buffer
678 * @param gain_index index for the block multiplier
679 * @param gain_index_next index for the next block multiplier
681 static void interpolate_float(COOKContext *q, float *buffer,
682 int gain_index, int gain_index_next)
686 fc1 = pow2tab[gain_index + 63];
688 if (gain_index == gain_index_next) { // static gain
689 for (i = 0; i < q->gain_size_factor; i++)
691 } else { // smooth gain
692 fc2 = q->gain_table[15 + (gain_index_next - gain_index)];
693 for (i = 0; i < q->gain_size_factor; i++) {
701 * Apply transform window, overlap buffers.
703 * @param q pointer to the COOKContext
704 * @param inbuffer pointer to the mltcoefficients
705 * @param gains_ptr current and previous gains
706 * @param previous_buffer pointer to the previous buffer to be used for overlapping
708 static void imlt_window_float(COOKContext *q, float *inbuffer,
709 cook_gains *gains_ptr, float *previous_buffer)
711 const float fc = pow2tab[gains_ptr->previous[0] + 63];
713 /* The weird thing here, is that the two halves of the time domain
714 * buffer are swapped. Also, the newest data, that we save away for
715 * next frame, has the wrong sign. Hence the subtraction below.
716 * Almost sounds like a complex conjugate/reverse data/FFT effect.
719 /* Apply window and overlap */
720 for (i = 0; i < q->samples_per_channel; i++)
721 inbuffer[i] = inbuffer[i] * fc * q->mlt_window[i] -
722 previous_buffer[i] * q->mlt_window[q->samples_per_channel - 1 - i];
726 * The modulated lapped transform, this takes transform coefficients
727 * and transforms them into timedomain samples.
728 * Apply transform window, overlap buffers, apply gain profile
729 * and buffer management.
731 * @param q pointer to the COOKContext
732 * @param inbuffer pointer to the mltcoefficients
733 * @param gains_ptr current and previous gains
734 * @param previous_buffer pointer to the previous buffer to be used for overlapping
736 static void imlt_gain(COOKContext *q, float *inbuffer,
737 cook_gains *gains_ptr, float *previous_buffer)
739 float *buffer0 = q->mono_mdct_output;
740 float *buffer1 = q->mono_mdct_output + q->samples_per_channel;
743 /* Inverse modified discrete cosine transform */
744 q->mdct_ctx.imdct_calc(&q->mdct_ctx, q->mono_mdct_output, inbuffer);
746 q->imlt_window(q, buffer1, gains_ptr, previous_buffer);
748 /* Apply gain profile */
749 for (i = 0; i < 8; i++)
750 if (gains_ptr->now[i] || gains_ptr->now[i + 1])
751 q->interpolate(q, &buffer1[q->gain_size_factor * i],
752 gains_ptr->now[i], gains_ptr->now[i + 1]);
754 /* Save away the current to be previous block. */
755 memcpy(previous_buffer, buffer0,
756 q->samples_per_channel * sizeof(*previous_buffer));
761 * function for getting the jointstereo coupling information
763 * @param q pointer to the COOKContext
764 * @param decouple_tab decoupling array
766 static int decouple_info(COOKContext *q, COOKSubpacket *p, int *decouple_tab)
769 int vlc = get_bits1(&q->gb);
770 int start = cplband[p->js_subband_start];
771 int end = cplband[p->subbands - 1];
772 int length = end - start + 1;
778 for (i = 0; i < length; i++)
779 decouple_tab[start + i] = get_vlc2(&q->gb,
780 p->channel_coupling.table,
781 COUPLING_VLC_BITS, 3);
783 for (i = 0; i < length; i++) {
784 int v = get_bits(&q->gb, p->js_vlc_bits);
785 if (v == (1<<p->js_vlc_bits)-1) {
786 av_log(q->avctx, AV_LOG_ERROR, "decouple value too large\n");
787 return AVERROR_INVALIDDATA;
789 decouple_tab[start + i] = v;
795 * function decouples a pair of signals from a single signal via multiplication.
797 * @param q pointer to the COOKContext
798 * @param subband index of the current subband
799 * @param f1 multiplier for channel 1 extraction
800 * @param f2 multiplier for channel 2 extraction
801 * @param decode_buffer input buffer
802 * @param mlt_buffer1 pointer to left channel mlt coefficients
803 * @param mlt_buffer2 pointer to right channel mlt coefficients
805 static void decouple_float(COOKContext *q,
809 float *decode_buffer,
810 float *mlt_buffer1, float *mlt_buffer2)
813 for (j = 0; j < SUBBAND_SIZE; j++) {
814 tmp_idx = ((p->js_subband_start + subband) * SUBBAND_SIZE) + j;
815 mlt_buffer1[SUBBAND_SIZE * subband + j] = f1 * decode_buffer[tmp_idx];
816 mlt_buffer2[SUBBAND_SIZE * subband + j] = f2 * decode_buffer[tmp_idx];
821 * function for decoding joint stereo data
823 * @param q pointer to the COOKContext
824 * @param mlt_buffer1 pointer to left channel mlt coefficients
825 * @param mlt_buffer2 pointer to right channel mlt coefficients
827 static int joint_decode(COOKContext *q, COOKSubpacket *p,
828 float *mlt_buffer_left, float *mlt_buffer_right)
831 int decouple_tab[SUBBAND_SIZE] = { 0 };
832 float *decode_buffer = q->decode_buffer_0;
835 const float *cplscale;
837 memset(decode_buffer, 0, sizeof(q->decode_buffer_0));
839 /* Make sure the buffers are zeroed out. */
840 memset(mlt_buffer_left, 0, 1024 * sizeof(*mlt_buffer_left));
841 memset(mlt_buffer_right, 0, 1024 * sizeof(*mlt_buffer_right));
842 if ((res = decouple_info(q, p, decouple_tab)) < 0)
844 if ((res = mono_decode(q, p, decode_buffer)) < 0)
846 /* The two channels are stored interleaved in decode_buffer. */
847 for (i = 0; i < p->js_subband_start; i++) {
848 for (j = 0; j < SUBBAND_SIZE; j++) {
849 mlt_buffer_left[i * 20 + j] = decode_buffer[i * 40 + j];
850 mlt_buffer_right[i * 20 + j] = decode_buffer[i * 40 + 20 + j];
854 /* When we reach js_subband_start (the higher frequencies)
855 the coefficients are stored in a coupling scheme. */
856 idx = (1 << p->js_vlc_bits) - 1;
857 for (i = p->js_subband_start; i < p->subbands; i++) {
858 cpl_tmp = cplband[i];
859 idx -= decouple_tab[cpl_tmp];
860 cplscale = q->cplscales[p->js_vlc_bits - 2]; // choose decoupler table
861 f1 = cplscale[decouple_tab[cpl_tmp] + 1];
863 q->decouple(q, p, i, f1, f2, decode_buffer,
864 mlt_buffer_left, mlt_buffer_right);
865 idx = (1 << p->js_vlc_bits) - 1;
872 * First part of subpacket decoding:
873 * decode raw stream bytes and read gain info.
875 * @param q pointer to the COOKContext
876 * @param inbuffer pointer to raw stream data
877 * @param gains_ptr array of current/prev gain pointers
879 static inline void decode_bytes_and_gain(COOKContext *q, COOKSubpacket *p,
880 const uint8_t *inbuffer,
881 cook_gains *gains_ptr)
885 offset = decode_bytes(inbuffer, q->decoded_bytes_buffer,
886 p->bits_per_subpacket / 8);
887 init_get_bits(&q->gb, q->decoded_bytes_buffer + offset,
888 p->bits_per_subpacket);
889 decode_gain_info(&q->gb, gains_ptr->now);
891 /* Swap current and previous gains */
892 FFSWAP(int *, gains_ptr->now, gains_ptr->previous);
896 * Saturate the output signal and interleave.
898 * @param q pointer to the COOKContext
899 * @param out pointer to the output vector
901 static void saturate_output_float(COOKContext *q, float *out)
903 q->adsp.vector_clipf(out, q->mono_mdct_output + q->samples_per_channel,
904 FFALIGN(q->samples_per_channel, 8), -1.0f, 1.0f);
909 * Final part of subpacket decoding:
910 * Apply modulated lapped transform, gain compensation,
911 * clip and convert to integer.
913 * @param q pointer to the COOKContext
914 * @param decode_buffer pointer to the mlt coefficients
915 * @param gains_ptr array of current/prev gain pointers
916 * @param previous_buffer pointer to the previous buffer to be used for overlapping
917 * @param out pointer to the output buffer
919 static inline void mlt_compensate_output(COOKContext *q, float *decode_buffer,
920 cook_gains *gains_ptr, float *previous_buffer,
923 imlt_gain(q, decode_buffer, gains_ptr, previous_buffer);
925 q->saturate_output(q, out);
930 * Cook subpacket decoding. This function returns one decoded subpacket,
931 * usually 1024 samples per channel.
933 * @param q pointer to the COOKContext
934 * @param inbuffer pointer to the inbuffer
935 * @param outbuffer pointer to the outbuffer
937 static int decode_subpacket(COOKContext *q, COOKSubpacket *p,
938 const uint8_t *inbuffer, float **outbuffer)
940 int sub_packet_size = p->size;
943 memset(q->decode_buffer_1, 0, sizeof(q->decode_buffer_1));
944 decode_bytes_and_gain(q, p, inbuffer, &p->gains1);
946 if (p->joint_stereo) {
947 if ((res = joint_decode(q, p, q->decode_buffer_1, q->decode_buffer_2)) < 0)
950 if ((res = mono_decode(q, p, q->decode_buffer_1)) < 0)
953 if (p->num_channels == 2) {
954 decode_bytes_and_gain(q, p, inbuffer + sub_packet_size / 2, &p->gains2);
955 if ((res = mono_decode(q, p, q->decode_buffer_2)) < 0)
960 mlt_compensate_output(q, q->decode_buffer_1, &p->gains1,
961 p->mono_previous_buffer1,
962 outbuffer ? outbuffer[p->ch_idx] : NULL);
964 if (p->num_channels == 2) {
966 mlt_compensate_output(q, q->decode_buffer_2, &p->gains1,
967 p->mono_previous_buffer2,
968 outbuffer ? outbuffer[p->ch_idx + 1] : NULL);
970 mlt_compensate_output(q, q->decode_buffer_2, &p->gains2,
971 p->mono_previous_buffer2,
972 outbuffer ? outbuffer[p->ch_idx + 1] : NULL);
979 static int cook_decode_frame(AVCodecContext *avctx, void *data,
980 int *got_frame_ptr, AVPacket *avpkt)
982 AVFrame *frame = data;
983 const uint8_t *buf = avpkt->data;
984 int buf_size = avpkt->size;
985 COOKContext *q = avctx->priv_data;
986 float **samples = NULL;
991 if (buf_size < avctx->block_align)
994 /* get output buffer */
995 if (q->discarded_packets >= 2) {
996 frame->nb_samples = q->samples_per_channel;
997 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
999 samples = (float **)frame->extended_data;
1002 /* estimate subpacket sizes */
1003 q->subpacket[0].size = avctx->block_align;
1005 for (i = 1; i < q->num_subpackets; i++) {
1006 q->subpacket[i].size = 2 * buf[avctx->block_align - q->num_subpackets + i];
1007 q->subpacket[0].size -= q->subpacket[i].size + 1;
1008 if (q->subpacket[0].size < 0) {
1009 av_log(avctx, AV_LOG_DEBUG,
1010 "frame subpacket size total > avctx->block_align!\n");
1011 return AVERROR_INVALIDDATA;
1015 /* decode supbackets */
1016 for (i = 0; i < q->num_subpackets; i++) {
1017 q->subpacket[i].bits_per_subpacket = (q->subpacket[i].size * 8) >>
1018 q->subpacket[i].bits_per_subpdiv;
1019 q->subpacket[i].ch_idx = chidx;
1020 av_log(avctx, AV_LOG_DEBUG,
1021 "subpacket[%i] size %i js %i %i block_align %i\n",
1022 i, q->subpacket[i].size, q->subpacket[i].joint_stereo, offset,
1023 avctx->block_align);
1025 if ((ret = decode_subpacket(q, &q->subpacket[i], buf + offset, samples)) < 0)
1027 offset += q->subpacket[i].size;
1028 chidx += q->subpacket[i].num_channels;
1029 av_log(avctx, AV_LOG_DEBUG, "subpacket[%i] %i %i\n",
1030 i, q->subpacket[i].size * 8, get_bits_count(&q->gb));
1033 /* Discard the first two frames: no valid audio. */
1034 if (q->discarded_packets < 2) {
1035 q->discarded_packets++;
1037 return avctx->block_align;
1042 return avctx->block_align;
1045 static void dump_cook_context(COOKContext *q)
1048 #define PRINT(a, b) ff_dlog(q->avctx, " %s = %d\n", a, b);
1049 ff_dlog(q->avctx, "COOKextradata\n");
1050 ff_dlog(q->avctx, "cookversion=%x\n", q->subpacket[0].cookversion);
1051 if (q->subpacket[0].cookversion > STEREO) {
1052 PRINT("js_subband_start", q->subpacket[0].js_subband_start);
1053 PRINT("js_vlc_bits", q->subpacket[0].js_vlc_bits);
1055 ff_dlog(q->avctx, "COOKContext\n");
1056 PRINT("nb_channels", q->avctx->channels);
1057 PRINT("bit_rate", (int)q->avctx->bit_rate);
1058 PRINT("sample_rate", q->avctx->sample_rate);
1059 PRINT("samples_per_channel", q->subpacket[0].samples_per_channel);
1060 PRINT("subbands", q->subpacket[0].subbands);
1061 PRINT("js_subband_start", q->subpacket[0].js_subband_start);
1062 PRINT("log2_numvector_size", q->subpacket[0].log2_numvector_size);
1063 PRINT("numvector_size", q->subpacket[0].numvector_size);
1064 PRINT("total_subbands", q->subpacket[0].total_subbands);
1068 * Cook initialization
1070 * @param avctx pointer to the AVCodecContext
1072 static av_cold int cook_decode_init(AVCodecContext *avctx)
1074 COOKContext *q = avctx->priv_data;
1077 unsigned int channel_mask = 0;
1078 int samples_per_frame = 0;
1082 /* Take care of the codec specific extradata. */
1083 if (avctx->extradata_size < 8) {
1084 av_log(avctx, AV_LOG_ERROR, "Necessary extradata missing!\n");
1085 return AVERROR_INVALIDDATA;
1087 av_log(avctx, AV_LOG_DEBUG, "codecdata_length=%d\n", avctx->extradata_size);
1089 bytestream2_init(&gb, avctx->extradata, avctx->extradata_size);
1091 /* Take data from the AVCodecContext (RM container). */
1092 if (!avctx->channels) {
1093 av_log(avctx, AV_LOG_ERROR, "Invalid number of channels\n");
1094 return AVERROR_INVALIDDATA;
1097 if (avctx->block_align >= INT_MAX / 8)
1098 return AVERROR(EINVAL);
1100 /* Initialize RNG. */
1101 av_lfg_init(&q->random_state, 0);
1103 ff_audiodsp_init(&q->adsp);
1105 while (bytestream2_get_bytes_left(&gb)) {
1106 if (s >= FFMIN(MAX_SUBPACKETS, avctx->block_align)) {
1107 avpriv_request_sample(avctx, "subpackets > %d", FFMIN(MAX_SUBPACKETS, avctx->block_align));
1108 return AVERROR_PATCHWELCOME;
1110 /* 8 for mono, 16 for stereo, ? for multichannel
1111 Swap to right endianness so we don't need to care later on. */
1112 q->subpacket[s].cookversion = bytestream2_get_be32(&gb);
1113 samples_per_frame = bytestream2_get_be16(&gb);
1114 q->subpacket[s].subbands = bytestream2_get_be16(&gb);
1115 bytestream2_get_be32(&gb); // Unknown unused
1116 q->subpacket[s].js_subband_start = bytestream2_get_be16(&gb);
1117 if (q->subpacket[s].js_subband_start >= 51) {
1118 av_log(avctx, AV_LOG_ERROR, "js_subband_start %d is too large\n", q->subpacket[s].js_subband_start);
1119 return AVERROR_INVALIDDATA;
1121 q->subpacket[s].js_vlc_bits = bytestream2_get_be16(&gb);
1123 /* Initialize extradata related variables. */
1124 q->subpacket[s].samples_per_channel = samples_per_frame / avctx->channels;
1125 q->subpacket[s].bits_per_subpacket = avctx->block_align * 8;
1127 /* Initialize default data states. */
1128 q->subpacket[s].log2_numvector_size = 5;
1129 q->subpacket[s].total_subbands = q->subpacket[s].subbands;
1130 q->subpacket[s].num_channels = 1;
1132 /* Initialize version-dependent variables */
1134 av_log(avctx, AV_LOG_DEBUG, "subpacket[%i].cookversion=%x\n", s,
1135 q->subpacket[s].cookversion);
1136 q->subpacket[s].joint_stereo = 0;
1137 switch (q->subpacket[s].cookversion) {
1139 if (avctx->channels != 1) {
1140 avpriv_request_sample(avctx, "Container channels != 1");
1141 return AVERROR_PATCHWELCOME;
1143 av_log(avctx, AV_LOG_DEBUG, "MONO\n");
1146 if (avctx->channels != 1) {
1147 q->subpacket[s].bits_per_subpdiv = 1;
1148 q->subpacket[s].num_channels = 2;
1150 av_log(avctx, AV_LOG_DEBUG, "STEREO\n");
1153 if (avctx->channels != 2) {
1154 avpriv_request_sample(avctx, "Container channels != 2");
1155 return AVERROR_PATCHWELCOME;
1157 av_log(avctx, AV_LOG_DEBUG, "JOINT_STEREO\n");
1158 if (avctx->extradata_size >= 16) {
1159 q->subpacket[s].total_subbands = q->subpacket[s].subbands +
1160 q->subpacket[s].js_subband_start;
1161 q->subpacket[s].joint_stereo = 1;
1162 q->subpacket[s].num_channels = 2;
1164 if (q->subpacket[s].samples_per_channel > 256) {
1165 q->subpacket[s].log2_numvector_size = 6;
1167 if (q->subpacket[s].samples_per_channel > 512) {
1168 q->subpacket[s].log2_numvector_size = 7;
1172 av_log(avctx, AV_LOG_DEBUG, "MULTI_CHANNEL\n");
1173 channel_mask |= q->subpacket[s].channel_mask = bytestream2_get_be32(&gb);
1175 if (av_get_channel_layout_nb_channels(q->subpacket[s].channel_mask) > 1) {
1176 q->subpacket[s].total_subbands = q->subpacket[s].subbands +
1177 q->subpacket[s].js_subband_start;
1178 q->subpacket[s].joint_stereo = 1;
1179 q->subpacket[s].num_channels = 2;
1180 q->subpacket[s].samples_per_channel = samples_per_frame >> 1;
1182 if (q->subpacket[s].samples_per_channel > 256) {
1183 q->subpacket[s].log2_numvector_size = 6;
1185 if (q->subpacket[s].samples_per_channel > 512) {
1186 q->subpacket[s].log2_numvector_size = 7;
1189 q->subpacket[s].samples_per_channel = samples_per_frame;
1193 avpriv_request_sample(avctx, "Cook version %d",
1194 q->subpacket[s].cookversion);
1195 return AVERROR_PATCHWELCOME;
1198 if (s > 1 && q->subpacket[s].samples_per_channel != q->samples_per_channel) {
1199 av_log(avctx, AV_LOG_ERROR, "different number of samples per channel!\n");
1200 return AVERROR_INVALIDDATA;
1202 q->samples_per_channel = q->subpacket[0].samples_per_channel;
1205 /* Initialize variable relations */
1206 q->subpacket[s].numvector_size = (1 << q->subpacket[s].log2_numvector_size);
1208 /* Try to catch some obviously faulty streams, otherwise it might be exploitable */
1209 if (q->subpacket[s].total_subbands > 53) {
1210 avpriv_request_sample(avctx, "total_subbands > 53");
1211 return AVERROR_PATCHWELCOME;
1214 if ((q->subpacket[s].js_vlc_bits > 6) ||
1215 (q->subpacket[s].js_vlc_bits < 2 * q->subpacket[s].joint_stereo)) {
1216 av_log(avctx, AV_LOG_ERROR, "js_vlc_bits = %d, only >= %d and <= 6 allowed!\n",
1217 q->subpacket[s].js_vlc_bits, 2 * q->subpacket[s].joint_stereo);
1218 return AVERROR_INVALIDDATA;
1221 if (q->subpacket[s].subbands > 50) {
1222 avpriv_request_sample(avctx, "subbands > 50");
1223 return AVERROR_PATCHWELCOME;
1225 if (q->subpacket[s].subbands == 0) {
1226 avpriv_request_sample(avctx, "subbands = 0");
1227 return AVERROR_PATCHWELCOME;
1229 q->subpacket[s].gains1.now = q->subpacket[s].gain_1;
1230 q->subpacket[s].gains1.previous = q->subpacket[s].gain_2;
1231 q->subpacket[s].gains2.now = q->subpacket[s].gain_3;
1232 q->subpacket[s].gains2.previous = q->subpacket[s].gain_4;
1234 if (q->num_subpackets + q->subpacket[s].num_channels > q->avctx->channels) {
1235 av_log(avctx, AV_LOG_ERROR, "Too many subpackets %d for channels %d\n", q->num_subpackets, q->avctx->channels);
1236 return AVERROR_INVALIDDATA;
1239 q->num_subpackets++;
1243 /* Try to catch some obviously faulty streams, otherwise it might be exploitable */
1244 if (q->samples_per_channel != 256 && q->samples_per_channel != 512 &&
1245 q->samples_per_channel != 1024) {
1246 avpriv_request_sample(avctx, "samples_per_channel = %d",
1247 q->samples_per_channel);
1248 return AVERROR_PATCHWELCOME;
1251 /* Generate tables */
1254 init_cplscales_table(q);
1256 if ((ret = init_cook_vlc_tables(q)))
1259 /* Pad the databuffer with:
1260 DECODE_BYTES_PAD1 or DECODE_BYTES_PAD2 for decode_bytes(),
1261 AV_INPUT_BUFFER_PADDING_SIZE, for the bitstreamreader. */
1262 q->decoded_bytes_buffer =
1263 av_mallocz(avctx->block_align
1264 + DECODE_BYTES_PAD1(avctx->block_align)
1265 + AV_INPUT_BUFFER_PADDING_SIZE);
1266 if (!q->decoded_bytes_buffer)
1267 return AVERROR(ENOMEM);
1269 /* Initialize transform. */
1270 if ((ret = init_cook_mlt(q)))
1273 /* Initialize COOK signal arithmetic handling */
1275 q->scalar_dequant = scalar_dequant_float;
1276 q->decouple = decouple_float;
1277 q->imlt_window = imlt_window_float;
1278 q->interpolate = interpolate_float;
1279 q->saturate_output = saturate_output_float;
1282 avctx->sample_fmt = AV_SAMPLE_FMT_FLTP;
1284 avctx->channel_layout = channel_mask;
1286 avctx->channel_layout = (avctx->channels == 2) ? AV_CH_LAYOUT_STEREO : AV_CH_LAYOUT_MONO;
1289 dump_cook_context(q);
1294 AVCodec ff_cook_decoder = {
1296 .long_name = NULL_IF_CONFIG_SMALL("Cook / Cooker / Gecko (RealAudio G2)"),
1297 .type = AVMEDIA_TYPE_AUDIO,
1298 .id = AV_CODEC_ID_COOK,
1299 .priv_data_size = sizeof(COOKContext),
1300 .init = cook_decode_init,
1301 .close = cook_decode_close,
1302 .decode = cook_decode_frame,
1303 .capabilities = AV_CODEC_CAP_DR1,
1304 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
1305 .sample_fmts = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_FLTP,
1306 AV_SAMPLE_FMT_NONE },