libavcodec/binkaudio.c
c0d3f516
 /*
  * Bink Audio decoder
4913af0c
  * Copyright (c) 2007-2011 Peter Ross (pross@xvid.org)
c0d3f516
  * Copyright (c) 2009 Daniel Verkamp (daniel@drv.nu)
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
ba87f080
  * @file
c0d3f516
  * Bink Audio decoder
  *
  * Technical details here:
  *  http://wiki.multimedia.cx/index.php?title=Bink_Audio
  */
 
 #include "avcodec.h"
aaf47bcd
 #define BITSTREAM_READER_LE
c0d3f516
 #include "get_bits.h"
 #include "dsputil.h"
0aded948
 #include "dct.h"
 #include "rdft.h"
fe2ff6d2
 #include "fmtconvert.h"
3383a53e
 #include "libavutil/intfloat.h"
1429224b
 
c0d3f516
 extern const uint16_t ff_wma_critical_freqs[25];
 
add7b114
 static float quant_table[96];
9f48039a
 
c0d3f516
 #define MAX_CHANNELS 2
 #define BINK_BLOCK_MAX_SIZE (MAX_CHANNELS << 11)
 
 typedef struct {
0eea2129
     AVFrame frame;
c0d3f516
     GetBitContext gb;
     DSPContext dsp;
fe2ff6d2
     FmtConvertContext fmt_conv;
4913af0c
     int version_b;          ///< Bink version 'b'
c0d3f516
     int first;
     int channels;
     int frame_len;          ///< transform size (samples)
     int overlap_len;        ///< overlap size (samples)
     int block_size;
     int num_bands;
     unsigned int *bands;
     float root;
9d35fa52
     DECLARE_ALIGNED(32, FFTSample, coeffs)[BINK_BLOCK_MAX_SIZE];
425a8435
     DECLARE_ALIGNED(16, int16_t, previous)[BINK_BLOCK_MAX_SIZE / 16];  ///< coeffs from previous audio block
eaddd29e
     DECLARE_ALIGNED(16, int16_t, current)[BINK_BLOCK_MAX_SIZE / 16];
c0d3f516
     float *coeffs_ptr[MAX_CHANNELS]; ///< pointers to the coeffs arrays for float_to_int16_interleave
eaddd29e
     float *prev_ptr[MAX_CHANNELS];   ///< pointers to the overlap points in the coeffs array
4f4e1948
     uint8_t *packet_buffer;
c0d3f516
     union {
         RDFTContext rdft;
         DCTContext dct;
     } trans;
 } BinkAudioContext;
 
 
 static av_cold int decode_init(AVCodecContext *avctx)
 {
     BinkAudioContext *s = avctx->priv_data;
     int sample_rate = avctx->sample_rate;
     int sample_rate_half;
     int i;
     int frame_len_bits;
 
9cf0841e
     ff_dsputil_init(&s->dsp, avctx);
fe2ff6d2
     ff_fmt_convert_init(&s->fmt_conv, avctx);
c0d3f516
 
     /* determine frame length */
     if (avctx->sample_rate < 22050) {
         frame_len_bits = 9;
     } else if (avctx->sample_rate < 44100) {
         frame_len_bits = 10;
     } else {
         frame_len_bits = 11;
     }
 
13690156
     if (avctx->channels > MAX_CHANNELS) {
c4c9fb46
         av_log(avctx, AV_LOG_ERROR, "too many channels: %d\n", avctx->channels);
c0d3f516
         return -1;
     }
 
df64da3b
     s->version_b = avctx->extradata && avctx->extradata[3] == 'b';
4913af0c
 
c0d3f516
     if (avctx->codec->id == CODEC_ID_BINKAUDIO_RDFT) {
         // audio is already interleaved for the RDFT format variant
         sample_rate  *= avctx->channels;
         s->channels = 1;
4913af0c
         if (!s->version_b)
             frame_len_bits += av_log2(avctx->channels);
c0d3f516
     } else {
         s->channels = avctx->channels;
     }
 
8d09fc19
     s->frame_len     = 1 << frame_len_bits;
c0d3f516
     s->overlap_len   = s->frame_len / 16;
     s->block_size    = (s->frame_len - s->overlap_len) * s->channels;
     sample_rate_half = (sample_rate + 1) / 2;
     s->root          = 2.0 / sqrt(s->frame_len);
add7b114
     for (i = 0; i < 96; i++) {
9f48039a
         /* constant is result of 0.066399999/log10(M_E) */
         quant_table[i] = expf(i * 0.15289164787221953823f) * s->root;
     }
c0d3f516
 
     /* calculate number of bands */
     for (s->num_bands = 1; s->num_bands < 25; s->num_bands++)
         if (sample_rate_half <= ff_wma_critical_freqs[s->num_bands - 1])
             break;
 
     s->bands = av_malloc((s->num_bands + 1) * sizeof(*s->bands));
     if (!s->bands)
         return AVERROR(ENOMEM);
 
     /* populate bands data */
23d82139
     s->bands[0] = 2;
c0d3f516
     for (i = 1; i < s->num_bands; i++)
23d82139
         s->bands[i] = (ff_wma_critical_freqs[i - 1] * s->frame_len / sample_rate_half) & ~1;
     s->bands[s->num_bands] = s->frame_len;
c0d3f516
 
     s->first = 1;
5d6e4c16
     avctx->sample_fmt = AV_SAMPLE_FMT_S16;
c0d3f516
 
eaddd29e
     for (i = 0; i < s->channels; i++) {
c0d3f516
         s->coeffs_ptr[i] = s->coeffs + i * s->frame_len;
eaddd29e
         s->prev_ptr[i]   = s->coeffs_ptr[i] + s->frame_len - s->overlap_len;
     }
c0d3f516
 
e0ae3591
     if (CONFIG_BINKAUDIO_RDFT_DECODER && avctx->codec->id == CODEC_ID_BINKAUDIO_RDFT)
41ea18fb
         ff_rdft_init(&s->trans.rdft, frame_len_bits, DFT_C2R);
e0ae3591
     else if (CONFIG_BINKAUDIO_DCT_DECODER)
c2b774a0
         ff_dct_init(&s->trans.dct, frame_len_bits, DCT_III);
e0ae3591
     else
         return -1;
c0d3f516
 
0eea2129
     avcodec_get_frame_defaults(&s->frame);
     avctx->coded_frame = &s->frame;
 
c0d3f516
     return 0;
 }
 
 static float get_float(GetBitContext *gb)
 {
     int power = get_bits(gb, 5);
     float f = ldexpf(get_bits_long(gb, 23), power - 23);
     if (get_bits1(gb))
         f = -f;
     return f;
 }
 
 static const uint8_t rle_length_tab[16] = {
     2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 32, 64
 };
 
101ef19e
 #define GET_BITS_SAFE(out, nbits) do {  \
     if (get_bits_left(gb) < nbits)      \
         return AVERROR_INVALIDDATA;     \
     out = get_bits(gb, nbits);          \
 } while (0)
 
c0d3f516
 /**
  * Decode Bink Audio block
  * @param[out] out Output buffer (must contain s->block_size elements)
101ef19e
  * @return 0 on success, negative error code on failure
c0d3f516
  */
425a8435
 static int decode_block(BinkAudioContext *s, int16_t *out, int use_dct)
c0d3f516
 {
     int ch, i, j, k;
     float q, quant[25];
     int width, coeff;
     GetBitContext *gb = &s->gb;
 
     if (use_dct)
         skip_bits(gb, 2);
 
     for (ch = 0; ch < s->channels; ch++) {
         FFTSample *coeffs = s->coeffs_ptr[ch];
4913af0c
         if (s->version_b) {
101ef19e
             if (get_bits_left(gb) < 64)
                 return AVERROR_INVALIDDATA;
3383a53e
             coeffs[0] = av_int2float(get_bits_long(gb, 32)) * s->root;
             coeffs[1] = av_int2float(get_bits_long(gb, 32)) * s->root;
4913af0c
         } else {
101ef19e
             if (get_bits_left(gb) < 58)
                 return AVERROR_INVALIDDATA;
4913af0c
             coeffs[0] = get_float(gb) * s->root;
             coeffs[1] = get_float(gb) * s->root;
         }
c0d3f516
 
101ef19e
         if (get_bits_left(gb) < s->num_bands * 8)
             return AVERROR_INVALIDDATA;
c0d3f516
         for (i = 0; i < s->num_bands; i++) {
             int value = get_bits(gb, 8);
9f48039a
             quant[i]  = quant_table[FFMIN(value, 95)];
c0d3f516
         }
 
408ee5a9
         k = 0;
         q = quant[0];
c0d3f516
 
         // parse coefficients
         i = 2;
         while (i < s->frame_len) {
4913af0c
             if (s->version_b) {
                 j = i + 16;
c0d3f516
             } else {
101ef19e
                 int v;
                 GET_BITS_SAFE(v, 1);
                 if (v) {
                     GET_BITS_SAFE(v, 4);
                     j = i + rle_length_tab[v] * 8;
                 } else {
                     j = i + 8;
                 }
c0d3f516
             }
 
             j = FFMIN(j, s->frame_len);
 
101ef19e
             GET_BITS_SAFE(width, 4);
c0d3f516
             if (width == 0) {
                 memset(coeffs + i, 0, (j - i) * sizeof(*coeffs));
                 i = j;
23d82139
                 while (s->bands[k] < i)
c0d3f516
                     q = quant[k++];
             } else {
                 while (i < j) {
23d82139
                     if (s->bands[k] == i)
c0d3f516
                         q = quant[k++];
101ef19e
                     GET_BITS_SAFE(coeff, width);
c0d3f516
                     if (coeff) {
101ef19e
                         int v;
                         GET_BITS_SAFE(v, 1);
                         if (v)
c0d3f516
                             coeffs[i] = -q * coeff;
                         else
                             coeffs[i] =  q * coeff;
                     } else {
                         coeffs[i] = 0.0f;
                     }
                     i++;
                 }
             }
         }
 
54063e37
         if (CONFIG_BINKAUDIO_DCT_DECODER && use_dct) {
             coeffs[0] /= 0.5;
26f548bb
             s->trans.dct.dct_calc(&s->trans.dct,  coeffs);
54063e37
             s->dsp.vector_fmul_scalar(coeffs, coeffs, s->frame_len / 2, s->frame_len);
         }
e0ae3591
         else if (CONFIG_BINKAUDIO_RDFT_DECODER)
26f548bb
             s->trans.rdft.rdft_calc(&s->trans.rdft, coeffs);
c0d3f516
     }
 
eaddd29e
     s->fmt_conv.float_to_int16_interleave(s->current,
                                           (const float **)s->prev_ptr,
                                           s->overlap_len, s->channels);
fe2ff6d2
     s->fmt_conv.float_to_int16_interleave(out, (const float **)s->coeffs_ptr,
eaddd29e
                                           s->frame_len - s->overlap_len,
                                           s->channels);
c0d3f516
 
     if (!s->first) {
         int count = s->overlap_len * s->channels;
         int shift = av_log2(count);
         for (i = 0; i < count; i++) {
             out[i] = (s->previous[i] * (count - i) + out[i] * i) >> shift;
         }
     }
 
eaddd29e
     memcpy(s->previous, s->current,
            s->overlap_len * s->channels * sizeof(*s->previous));
c0d3f516
 
     s->first = 0;
101ef19e
 
     return 0;
c0d3f516
 }
 
 static av_cold int decode_end(AVCodecContext *avctx)
 {
     BinkAudioContext * s = avctx->priv_data;
     av_freep(&s->bands);
4f4e1948
     av_freep(&s->packet_buffer);
e0ae3591
     if (CONFIG_BINKAUDIO_RDFT_DECODER && avctx->codec->id == CODEC_ID_BINKAUDIO_RDFT)
c0d3f516
         ff_rdft_end(&s->trans.rdft);
e0ae3591
     else if (CONFIG_BINKAUDIO_DCT_DECODER)
c0d3f516
         ff_dct_end(&s->trans.dct);
0eea2129
 
c0d3f516
     return 0;
 }
 
 static void get_bits_align32(GetBitContext *s)
 {
     int n = (-get_bits_count(s)) & 31;
     if (n) skip_bits(s, n);
 }
 
0eea2129
 static int decode_frame(AVCodecContext *avctx, void *data,
                         int *got_frame_ptr, AVPacket *avpkt)
c0d3f516
 {
     BinkAudioContext *s = avctx->priv_data;
0eea2129
     int16_t *samples;
c0d3f516
     GetBitContext *gb = &s->gb;
0eea2129
     int ret, consumed = 0;
4f4e1948
 
     if (!get_bits_left(gb)) {
         uint8_t *buf;
         /* handle end-of-stream */
         if (!avpkt->size) {
0eea2129
             *got_frame_ptr = 0;
4f4e1948
             return 0;
         }
         if (avpkt->size < 4) {
             av_log(avctx, AV_LOG_ERROR, "Packet is too small\n");
             return AVERROR_INVALIDDATA;
         }
         buf = av_realloc(s->packet_buffer, avpkt->size + FF_INPUT_BUFFER_PADDING_SIZE);
         if (!buf)
             return AVERROR(ENOMEM);
         s->packet_buffer = buf;
         memcpy(s->packet_buffer, avpkt->data, avpkt->size);
         init_get_bits(gb, s->packet_buffer, avpkt->size * 8);
         consumed = avpkt->size;
 
         /* skip reported size */
         skip_bits_long(gb, 32);
101ef19e
     }
c0d3f516
 
0eea2129
     /* get output buffer */
     s->frame.nb_samples = s->block_size / avctx->channels;
     if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
         return ret;
4f4e1948
     }
0eea2129
     samples = (int16_t *)s->frame.data[0];
c0d3f516
 
4f4e1948
     if (decode_block(s, samples, avctx->codec->id == CODEC_ID_BINKAUDIO_DCT)) {
         av_log(avctx, AV_LOG_ERROR, "Incomplete packet\n");
         return AVERROR_INVALIDDATA;
c0d3f516
     }
4f4e1948
     get_bits_align32(gb);
c0d3f516
 
0eea2129
     *got_frame_ptr   = 1;
     *(AVFrame *)data = s->frame;
 
4f4e1948
     return consumed;
c0d3f516
 }
 
e7e2df27
 AVCodec ff_binkaudio_rdft_decoder = {
ec6402b7
     .name           = "binkaudio_rdft",
     .type           = AVMEDIA_TYPE_AUDIO,
     .id             = CODEC_ID_BINKAUDIO_RDFT,
     .priv_data_size = sizeof(BinkAudioContext),
     .init           = decode_init,
     .close          = decode_end,
     .decode         = decode_frame,
0eea2129
     .capabilities   = CODEC_CAP_DELAY | CODEC_CAP_DR1,
00c3b67b
     .long_name      = NULL_IF_CONFIG_SMALL("Bink Audio (RDFT)")
c0d3f516
 };
 
e7e2df27
 AVCodec ff_binkaudio_dct_decoder = {
ec6402b7
     .name           = "binkaudio_dct",
     .type           = AVMEDIA_TYPE_AUDIO,
     .id             = CODEC_ID_BINKAUDIO_DCT,
     .priv_data_size = sizeof(BinkAudioContext),
     .init           = decode_init,
     .close          = decode_end,
     .decode         = decode_frame,
0eea2129
     .capabilities   = CODEC_CAP_DELAY | CODEC_CAP_DR1,
00c3b67b
     .long_name      = NULL_IF_CONFIG_SMALL("Bink Audio (DCT)")
c0d3f516
 };