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
  */
 
faf340f6
 #include "libavutil/channel_layout.h"
c0d3f516
 #include "avcodec.h"
aaf47bcd
 #define BITSTREAM_READER_LE
c0d3f516
 #include "get_bits.h"
0aded948
 #include "dct.h"
 #include "rdft.h"
fe2ff6d2
 #include "fmtconvert.h"
594d4d5d
 #include "internal.h"
c591d457
 #include "wma.h"
3383a53e
 #include "libavutil/intfloat.h"
1429224b
 
add7b114
 static float quant_table[96];
9f48039a
 
c0d3f516
 #define MAX_CHANNELS 2
 #define BINK_BLOCK_MAX_SIZE (MAX_CHANNELS << 11)
 
 typedef struct {
     GetBitContext gb;
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];
7bfd1766
     float previous[MAX_CHANNELS][BINK_BLOCK_MAX_SIZE / 16];  ///< coeffs from previous audio block
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;
 
     /* 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;
     }
 
824a6975
     if (avctx->channels < 1 || avctx->channels > MAX_CHANNELS) {
         av_log(avctx, AV_LOG_ERROR, "invalid number of channels: %d\n", avctx->channels);
         return AVERROR_INVALIDDATA;
c0d3f516
     }
faf340f6
     avctx->channel_layout = avctx->channels == 1 ? AV_CH_LAYOUT_MONO :
                                                    AV_CH_LAYOUT_STEREO;
c0d3f516
 
c2dd01c1
     s->version_b = avctx->extradata_size >= 4 && avctx->extradata[3] == 'b';
4913af0c
 
36ef5369
     if (avctx->codec->id == AV_CODEC_ID_BINKAUDIO_RDFT) {
c0d3f516
         // audio is already interleaved for the RDFT format variant
7bfd1766
         avctx->sample_fmt = AV_SAMPLE_FMT_FLT;
c0d3f516
         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;
7bfd1766
         avctx->sample_fmt = AV_SAMPLE_FMT_FLTP;
c0d3f516
     }
 
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;
0801b597
     if (avctx->codec->id == AV_CODEC_ID_BINKAUDIO_RDFT)
7bfd1766
         s->root = 2.0 / (sqrt(s->frame_len) * 32768.0);
0801b597
     else
7bfd1766
         s->root = s->frame_len / (sqrt(s->frame_len) * 32768.0);
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;
 
36ef5369
     if (CONFIG_BINKAUDIO_RDFT_DECODER && avctx->codec->id == AV_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
 
     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
 };
 
 /**
  * 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
  */
7bfd1766
 static int decode_block(BinkAudioContext *s, float **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++) {
7bfd1766
         FFTSample *coeffs = out[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 {
ee90119e
                 int v = get_bits1(gb);
101ef19e
                 if (v) {
ee90119e
                     v = get_bits(gb, 4);
101ef19e
                     j = i + rle_length_tab[v] * 8;
                 } else {
                     j = i + 8;
                 }
c0d3f516
             }
 
             j = FFMIN(j, s->frame_len);
 
ee90119e
             width = get_bits(gb, 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++];
ee90119e
                     coeff = get_bits(gb, width);
c0d3f516
                     if (coeff) {
101ef19e
                         int v;
ee90119e
                         v = get_bits1(gb);
101ef19e
                         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
         }
e0ae3591
         else if (CONFIG_BINKAUDIO_RDFT_DECODER)
26f548bb
             s->trans.rdft.rdft_calc(&s->trans.rdft, coeffs);
c0d3f516
     }
 
7bfd1766
     for (ch = 0; ch < s->channels; ch++) {
         int j;
c0d3f516
         int count = s->overlap_len * s->channels;
7bfd1766
         if (!s->first) {
             j = ch;
             for (i = 0; i < s->overlap_len; i++, j += s->channels)
                 out[ch][i] = (s->previous[ch][i] * (count - j) +
                                       out[ch][i] *          j) / count;
c0d3f516
         }
7bfd1766
         memcpy(s->previous[ch], &out[ch][s->frame_len - s->overlap_len],
                s->overlap_len * sizeof(*s->previous[ch]));
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);
36ef5369
     if (CONFIG_BINKAUDIO_RDFT_DECODER && avctx->codec->id == AV_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;
5cc0bd2c
     AVFrame *frame      = data;
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);
07728a11
         memset(buf + avpkt->size, 0, FF_INPUT_BUFFER_PADDING_SIZE);
4f4e1948
         s->packet_buffer = buf;
         memcpy(s->packet_buffer, avpkt->data, avpkt->size);
1de8dfcb
         if ((ret = init_get_bits8(gb, s->packet_buffer, avpkt->size)) < 0)
             return ret;
4f4e1948
         consumed = avpkt->size;
 
         /* skip reported size */
         skip_bits_long(gb, 32);
101ef19e
     }
c0d3f516
 
0eea2129
     /* get output buffer */
5cc0bd2c
     frame->nb_samples = s->frame_len;
1ec94b0f
     if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
0eea2129
         return ret;
c0d3f516
 
5cc0bd2c
     if (decode_block(s, (float **)frame->extended_data,
7bfd1766
                      avctx->codec->id == AV_CODEC_ID_BINKAUDIO_DCT)) {
4f4e1948
         av_log(avctx, AV_LOG_ERROR, "Incomplete packet\n");
         return AVERROR_INVALIDDATA;
c0d3f516
     }
4f4e1948
     get_bits_align32(gb);
c0d3f516
 
5cc0bd2c
     frame->nb_samples = s->block_size / avctx->channels;
     *got_frame_ptr    = 1;
0eea2129
 
4f4e1948
     return consumed;
c0d3f516
 }
 
e7e2df27
 AVCodec ff_binkaudio_rdft_decoder = {
ec6402b7
     .name           = "binkaudio_rdft",
b2bed932
     .long_name      = NULL_IF_CONFIG_SMALL("Bink Audio (RDFT)"),
ec6402b7
     .type           = AVMEDIA_TYPE_AUDIO,
36ef5369
     .id             = AV_CODEC_ID_BINKAUDIO_RDFT,
ec6402b7
     .priv_data_size = sizeof(BinkAudioContext),
     .init           = decode_init,
     .close          = decode_end,
     .decode         = decode_frame,
0eea2129
     .capabilities   = CODEC_CAP_DELAY | CODEC_CAP_DR1,
c0d3f516
 };
 
e7e2df27
 AVCodec ff_binkaudio_dct_decoder = {
ec6402b7
     .name           = "binkaudio_dct",
b2bed932
     .long_name      = NULL_IF_CONFIG_SMALL("Bink Audio (DCT)"),
ec6402b7
     .type           = AVMEDIA_TYPE_AUDIO,
36ef5369
     .id             = AV_CODEC_ID_BINKAUDIO_DCT,
ec6402b7
     .priv_data_size = sizeof(BinkAudioContext),
     .init           = decode_init,
     .close          = decode_end,
     .decode         = decode_frame,
0eea2129
     .capabilities   = CODEC_CAP_DELAY | CODEC_CAP_DR1,
c0d3f516
 };