mlpdec.c 48.1 KB
Newer Older
Ramiro Polla's avatar
Ramiro Polla committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*
 * MLP decoder
 * Copyright (c) 2007-2008 Ian Caulfield
 *
 * 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
 */

/**
23
 * @file
Ramiro Polla's avatar
Ramiro Polla committed
24 25 26
 * MLP decoder
 */

27 28
#include <stdint.h>

Ramiro Polla's avatar
Ramiro Polla committed
29
#include "avcodec.h"
30
#include "libavutil/internal.h"
Ramiro Polla's avatar
Ramiro Polla committed
31
#include "libavutil/intreadwrite.h"
32
#include "libavutil/channel_layout.h"
33
#include "get_bits.h"
34
#include "internal.h"
Ramiro Polla's avatar
Ramiro Polla committed
35 36 37
#include "libavutil/crc.h"
#include "parser.h"
#include "mlp_parser.h"
38
#include "mlpdsp.h"
39
#include "mlp.h"
40
#include "config.h"
Ramiro Polla's avatar
Ramiro Polla committed
41

Diego Biurrun's avatar
Diego Biurrun committed
42
/** number of bits used for VLC lookup - longest Huffman code is 9 */
43
#if ARCH_ARM
44 45 46
#define VLC_BITS            5
#define VLC_STATIC_SIZE     64
#else
Ramiro Polla's avatar
Ramiro Polla committed
47
#define VLC_BITS            9
48 49
#define VLC_STATIC_SIZE     512
#endif
Ramiro Polla's avatar
Ramiro Polla committed
50 51

typedef struct SubStream {
52
    /// Set if a valid restart header has been read. Otherwise the substream cannot be decoded.
Ramiro Polla's avatar
Ramiro Polla committed
53 54 55 56
    uint8_t     restart_seen;

    //@{
    /** restart header data */
57
    /// The type of noise to be used in the rematrix stage.
Ramiro Polla's avatar
Ramiro Polla committed
58 59
    uint16_t    noise_type;

60
    /// The index of the first channel coded in this substream.
Ramiro Polla's avatar
Ramiro Polla committed
61
    uint8_t     min_channel;
62
    /// The index of the last channel coded in this substream.
Ramiro Polla's avatar
Ramiro Polla committed
63
    uint8_t     max_channel;
64
    /// The number of channels input into the rematrix stage.
Ramiro Polla's avatar
Ramiro Polla committed
65
    uint8_t     max_matrix_channel;
66
    /// For each channel output by the matrix, the output channel to map it to
67
    uint8_t     ch_assign[MAX_CHANNELS];
68 69
    /// The channel layout for this substream
    uint64_t    ch_layout;
70 71
    /// The matrix encoding mode for this substream
    enum AVMatrixEncoding matrix_encoding;
Ramiro Polla's avatar
Ramiro Polla committed
72

73
    /// Channel coding parameters for channels in the substream
74 75
    ChannelParams channel_params[MAX_CHANNELS];

76
    /// The left shift applied to random noise in 0x31ea substreams.
Ramiro Polla's avatar
Ramiro Polla committed
77
    uint8_t     noise_shift;
78
    /// The current seed value for the pseudorandom noise generator(s).
Ramiro Polla's avatar
Ramiro Polla committed
79 80
    uint32_t    noisegen_seed;

81
    /// Set if the substream contains extra info to check the size of VLC blocks.
Ramiro Polla's avatar
Ramiro Polla committed
82 83
    uint8_t     data_check_present;

84
    /// Bitmask of which parameter sets are conveyed in a decoding parameter block.
Ramiro Polla's avatar
Ramiro Polla committed
85 86 87 88 89 90 91 92
    uint8_t     param_presence_flags;
#define PARAM_BLOCKSIZE     (1 << 7)
#define PARAM_MATRIX        (1 << 6)
#define PARAM_OUTSHIFT      (1 << 5)
#define PARAM_QUANTSTEP     (1 << 4)
#define PARAM_FIR           (1 << 3)
#define PARAM_IIR           (1 << 2)
#define PARAM_HUFFOFFSET    (1 << 1)
93
#define PARAM_PRESENCE      (1 << 0)
Ramiro Polla's avatar
Ramiro Polla committed
94 95 96 97 98
    //@}

    //@{
    /** matrix data */

99
    /// Number of matrices to be applied.
Ramiro Polla's avatar
Ramiro Polla committed
100 101
    uint8_t     num_primitive_matrices;

102
    /// matrix output channel
Ramiro Polla's avatar
Ramiro Polla committed
103 104
    uint8_t     matrix_out_ch[MAX_MATRICES];

105
    /// Whether the LSBs of the matrix output are encoded in the bitstream.
Ramiro Polla's avatar
Ramiro Polla committed
106
    uint8_t     lsb_bypass[MAX_MATRICES];
107
    /// Matrix coefficients, stored as 2.14 fixed point.
108
    DECLARE_ALIGNED(32, int32_t, matrix_coeff)[MAX_MATRICES][MAX_CHANNELS];
109
    /// Left shift to apply to noise values in 0x31eb substreams.
Ramiro Polla's avatar
Ramiro Polla committed
110 111 112
    uint8_t     matrix_noise_shift[MAX_MATRICES];
    //@}

113
    /// Left shift to apply to Huffman-decoded residuals.
Ramiro Polla's avatar
Ramiro Polla committed
114 115
    uint8_t     quant_step_size[MAX_CHANNELS];

116
    /// number of PCM samples in current audio block
Ramiro Polla's avatar
Ramiro Polla committed
117
    uint16_t    blocksize;
118
    /// Number of PCM samples decoded so far in this frame.
Ramiro Polla's avatar
Ramiro Polla committed
119 120
    uint16_t    blockpos;

121
    /// Left shift to apply to decoded PCM values to get final 24-bit output.
Ramiro Polla's avatar
Ramiro Polla committed
122 123
    int8_t      output_shift[MAX_CHANNELS];

124
    /// Running XOR of all output samples.
Ramiro Polla's avatar
Ramiro Polla committed
125 126 127 128 129 130 131
    int32_t     lossless_check_data;

} SubStream;

typedef struct MLPDecodeContext {
    AVCodecContext *avctx;

132
    /// Current access unit being read has a major sync.
133 134
    int         is_major_sync_unit;

135 136 137
    /// Size of the major sync unit, in bytes
    int         major_sync_header_size;

138
    /// Set if a valid major sync block has been read. Otherwise no decoding is possible.
Ramiro Polla's avatar
Ramiro Polla committed
139 140
    uint8_t     params_valid;

141
    /// Number of substreams contained within this stream.
Ramiro Polla's avatar
Ramiro Polla committed
142 143
    uint8_t     num_substreams;

144
    /// Index of the last substream to decode - further substreams are skipped.
Ramiro Polla's avatar
Ramiro Polla committed
145 146
    uint8_t     max_decoded_substream;

147
    /// Stream needs channel reordering to comply with FFmpeg's channel order
148 149
    uint8_t     needs_reordering;

150
    /// number of PCM samples contained in each frame
Ramiro Polla's avatar
Ramiro Polla committed
151
    int         access_unit_size;
152
    /// next power of two above the number of samples in each frame
Ramiro Polla's avatar
Ramiro Polla committed
153 154 155 156
    int         access_unit_size_pow2;

    SubStream   substream[MAX_SUBSTREAMS];

157 158 159
    int         matrix_changed;
    int         filter_changed[MAX_CHANNELS][NUM_FILTERS];

Ramiro Polla's avatar
Ramiro Polla committed
160 161
    int8_t      noise_buffer[MAX_BLOCKSIZE_POW2];
    int8_t      bypassed_lsbs[MAX_BLOCKSIZE][MAX_CHANNELS];
162
    DECLARE_ALIGNED(32, int32_t, sample_buffer)[MAX_BLOCKSIZE][MAX_CHANNELS];
163

164
    MLPDSPContext dsp;
Ramiro Polla's avatar
Ramiro Polla committed
165 166
} MLPDecodeContext;

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
static const uint64_t thd_channel_order[] = {
    AV_CH_FRONT_LEFT, AV_CH_FRONT_RIGHT,                     // LR
    AV_CH_FRONT_CENTER,                                      // C
    AV_CH_LOW_FREQUENCY,                                     // LFE
    AV_CH_SIDE_LEFT, AV_CH_SIDE_RIGHT,                       // LRs
    AV_CH_TOP_FRONT_LEFT, AV_CH_TOP_FRONT_RIGHT,             // LRvh
    AV_CH_FRONT_LEFT_OF_CENTER, AV_CH_FRONT_RIGHT_OF_CENTER, // LRc
    AV_CH_BACK_LEFT, AV_CH_BACK_RIGHT,                       // LRrs
    AV_CH_BACK_CENTER,                                       // Cs
    AV_CH_TOP_CENTER,                                        // Ts
    AV_CH_SURROUND_DIRECT_LEFT, AV_CH_SURROUND_DIRECT_RIGHT, // LRsd
    AV_CH_WIDE_LEFT, AV_CH_WIDE_RIGHT,                       // LRw
    AV_CH_TOP_FRONT_CENTER,                                  // Cvh
    AV_CH_LOW_FREQUENCY_2,                                   // LFE2
};

static uint64_t thd_channel_layout_extract_channel(uint64_t channel_layout,
                                                   int index)
{
    int i;

    if (av_get_channel_layout_nb_channels(channel_layout) <= index)
        return 0;

    for (i = 0; i < FF_ARRAY_ELEMS(thd_channel_order); i++)
        if (channel_layout & thd_channel_order[i] && !index--)
            return thd_channel_order[i];
    return 0;
}

Ramiro Polla's avatar
Ramiro Polla committed
197 198 199 200
static VLC huff_vlc[3];

/** Initialize static data, constant between all invocations of the codec. */

201
static av_cold void init_static(void)
Ramiro Polla's avatar
Ramiro Polla committed
202
{
203
    if (!huff_vlc[0].bits) {
Ramiro Polla's avatar
Ramiro Polla committed
204 205
        INIT_VLC_STATIC(&huff_vlc[0], VLC_BITS, 18,
                    &ff_mlp_huffman_tables[0][0][1], 2, 1,
206
                    &ff_mlp_huffman_tables[0][0][0], 2, 1, VLC_STATIC_SIZE);
Ramiro Polla's avatar
Ramiro Polla committed
207 208
        INIT_VLC_STATIC(&huff_vlc[1], VLC_BITS, 16,
                    &ff_mlp_huffman_tables[1][0][1], 2, 1,
209
                    &ff_mlp_huffman_tables[1][0][0], 2, 1, VLC_STATIC_SIZE);
Ramiro Polla's avatar
Ramiro Polla committed
210 211
        INIT_VLC_STATIC(&huff_vlc[2], VLC_BITS, 15,
                    &ff_mlp_huffman_tables[2][0][1], 2, 1,
212
                    &ff_mlp_huffman_tables[2][0][0], 2, 1, VLC_STATIC_SIZE);
213
    }
Ramiro Polla's avatar
Ramiro Polla committed
214

215
    ff_mlp_init_crc();
Ramiro Polla's avatar
Ramiro Polla committed
216 217 218 219 220 221
}

static inline int32_t calculate_sign_huff(MLPDecodeContext *m,
                                          unsigned int substr, unsigned int ch)
{
    SubStream *s = &m->substream[substr];
222
    ChannelParams *cp = &s->channel_params[ch];
223 224 225
    int lsb_bits = cp->huff_lsbs - s->quant_step_size[ch];
    int sign_shift = lsb_bits + (cp->codebook ? 2 - cp->codebook : -1);
    int32_t sign_huff_offset = cp->huff_offset;
Ramiro Polla's avatar
Ramiro Polla committed
226

227
    if (cp->codebook > 0)
Ramiro Polla's avatar
Ramiro Polla committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
        sign_huff_offset -= 7 << lsb_bits;

    if (sign_shift >= 0)
        sign_huff_offset -= 1 << sign_shift;

    return sign_huff_offset;
}

/** Read a sample, consisting of either, both or neither of entropy-coded MSBs
 *  and plain LSBs. */

static inline int read_huff_channels(MLPDecodeContext *m, GetBitContext *gbp,
                                     unsigned int substr, unsigned int pos)
{
    SubStream *s = &m->substream[substr];
    unsigned int mat, channel;

    for (mat = 0; mat < s->num_primitive_matrices; mat++)
        if (s->lsb_bypass[mat])
            m->bypassed_lsbs[pos + s->blockpos][mat] = get_bits1(gbp);

    for (channel = s->min_channel; channel <= s->max_channel; channel++) {
250
        ChannelParams *cp = &s->channel_params[channel];
251
        int codebook = cp->codebook;
Ramiro Polla's avatar
Ramiro Polla committed
252
        int quant_step_size = s->quant_step_size[channel];
253
        int lsb_bits = cp->huff_lsbs - quant_step_size;
Ramiro Polla's avatar
Ramiro Polla committed
254 255 256 257 258 259 260
        int result = 0;

        if (codebook > 0)
            result = get_vlc2(gbp, huff_vlc[codebook-1].table,
                            VLC_BITS, (9 + VLC_BITS - 1) / VLC_BITS);

        if (result < 0)
261
            return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
262 263 264 265

        if (lsb_bits > 0)
            result = (result << lsb_bits) + get_bits(gbp, lsb_bits);

266
        result  += cp->sign_huff_offset;
267
        result *= 1 << quant_step_size;
Ramiro Polla's avatar
Ramiro Polla committed
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283

        m->sample_buffer[pos + s->blockpos][channel] = result;
    }

    return 0;
}

static av_cold int mlp_decode_init(AVCodecContext *avctx)
{
    MLPDecodeContext *m = avctx->priv_data;
    int substr;

    init_static();
    m->avctx = avctx;
    for (substr = 0; substr < MAX_SUBSTREAMS; substr++)
        m->substream[substr].lossless_check_data = 0xffffffff;
284
    ff_mlpdsp_init(&m->dsp);
285

Ramiro Polla's avatar
Ramiro Polla committed
286 287 288 289 290 291 292 293 294 295 296
    return 0;
}

/** Read a major sync info header - contains high level information about
 *  the stream - sample rate, channel arrangement etc. Most of this
 *  information is not actually necessary for decoding, only for playback.
 */

static int read_major_sync(MLPDecodeContext *m, GetBitContext *gb)
{
    MLPHeaderInfo mh;
297
    int substr, ret;
Ramiro Polla's avatar
Ramiro Polla committed
298

299 300
    if ((ret = ff_mlp_read_major_sync(m->avctx, &mh, gb)) != 0)
        return ret;
Ramiro Polla's avatar
Ramiro Polla committed
301 302

    if (mh.group1_bits == 0) {
Diego Biurrun's avatar
Diego Biurrun committed
303
        av_log(m->avctx, AV_LOG_ERROR, "invalid/unknown bits per sample\n");
304
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
305 306 307
    }
    if (mh.group2_bits > mh.group1_bits) {
        av_log(m->avctx, AV_LOG_ERROR,
Diego Biurrun's avatar
Diego Biurrun committed
308
               "Channel group 2 cannot have more bits per sample than group 1.\n");
309
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
310 311 312 313
    }

    if (mh.group2_samplerate && mh.group2_samplerate != mh.group1_samplerate) {
        av_log(m->avctx, AV_LOG_ERROR,
Diego Biurrun's avatar
Diego Biurrun committed
314
               "Channel groups with differing sample rates are not currently supported.\n");
315
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
316 317 318
    }

    if (mh.group1_samplerate == 0) {
Diego Biurrun's avatar
Diego Biurrun committed
319
        av_log(m->avctx, AV_LOG_ERROR, "invalid/unknown sampling rate\n");
320
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
321 322 323
    }
    if (mh.group1_samplerate > MAX_SAMPLERATE) {
        av_log(m->avctx, AV_LOG_ERROR,
Diego Biurrun's avatar
Diego Biurrun committed
324
               "Sampling rate %d is greater than the supported maximum (%d).\n",
Ramiro Polla's avatar
Ramiro Polla committed
325
               mh.group1_samplerate, MAX_SAMPLERATE);
326
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
327 328 329
    }
    if (mh.access_unit_size > MAX_BLOCKSIZE) {
        av_log(m->avctx, AV_LOG_ERROR,
Diego Biurrun's avatar
Diego Biurrun committed
330
               "Block size %d is greater than the supported maximum (%d).\n",
Ramiro Polla's avatar
Ramiro Polla committed
331
               mh.access_unit_size, MAX_BLOCKSIZE);
332
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
333 334 335
    }
    if (mh.access_unit_size_pow2 > MAX_BLOCKSIZE_POW2) {
        av_log(m->avctx, AV_LOG_ERROR,
Diego Biurrun's avatar
Diego Biurrun committed
336
               "Block size pow2 %d is greater than the supported maximum (%d).\n",
Ramiro Polla's avatar
Ramiro Polla committed
337
               mh.access_unit_size_pow2, MAX_BLOCKSIZE_POW2);
338
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
339 340 341
    }

    if (mh.num_substreams == 0)
342
        return AVERROR_INVALIDDATA;
343
    if (m->avctx->codec_id == AV_CODEC_ID_MLP && mh.num_substreams > 2) {
344
        av_log(m->avctx, AV_LOG_ERROR, "MLP only supports up to 2 substreams.\n");
345
        return AVERROR_INVALIDDATA;
346
    }
Ramiro Polla's avatar
Ramiro Polla committed
347
    if (mh.num_substreams > MAX_SUBSTREAMS) {
348 349 350 351
        avpriv_request_sample(m->avctx,
                              "%d substreams (more than the "
                              "maximum supported by the decoder)",
                              mh.num_substreams);
352
        return AVERROR_PATCHWELCOME;
Ramiro Polla's avatar
Ramiro Polla committed
353 354
    }

355 356
    m->major_sync_header_size = mh.header_size;

Ramiro Polla's avatar
Ramiro Polla committed
357 358 359 360
    m->access_unit_size      = mh.access_unit_size;
    m->access_unit_size_pow2 = mh.access_unit_size_pow2;

    m->num_substreams        = mh.num_substreams;
361 362 363

    /* limit to decoding 3 substreams, as the 4th is used by Dolby Atmos for non-audio data */
    m->max_decoded_substream = FFMIN(m->num_substreams - 1, 2);
Ramiro Polla's avatar
Ramiro Polla committed
364 365 366 367

    m->avctx->sample_rate    = mh.group1_samplerate;
    m->avctx->frame_size     = mh.access_unit_size;

368
    m->avctx->bits_per_raw_sample = mh.group1_bits;
369
    if (mh.group1_bits > 16)
370
        m->avctx->sample_fmt = AV_SAMPLE_FMT_S32;
371
    else
372
        m->avctx->sample_fmt = AV_SAMPLE_FMT_S16;
373 374 375 376
    m->dsp.mlp_pack_output = m->dsp.mlp_select_pack_output(m->substream[m->max_decoded_substream].ch_assign,
                                                           m->substream[m->max_decoded_substream].output_shift,
                                                           m->substream[m->max_decoded_substream].max_matrix_channel,
                                                           m->avctx->sample_fmt == AV_SAMPLE_FMT_S32);
Ramiro Polla's avatar
Ramiro Polla committed
377 378 379 380 381

    m->params_valid = 1;
    for (substr = 0; substr < MAX_SUBSTREAMS; substr++)
        m->substream[substr].restart_seen = 0;

382 383 384 385
    /* Set the layout for each substream. When there's more than one, the first
     * substream is Stereo. Subsequent substreams' layouts are indicated in the
     * major sync. */
    if (m->avctx->codec_id == AV_CODEC_ID_MLP) {
386 387 388 389 390 391
        if (mh.stream_type != 0xbb) {
            avpriv_request_sample(m->avctx,
                        "unexpected stream_type %X in MLP",
                        mh.stream_type);
            return AVERROR_PATCHWELCOME;
        }
392 393 394 395
        if ((substr = (mh.num_substreams > 1)))
            m->substream[0].ch_layout = AV_CH_LAYOUT_STEREO;
        m->substream[substr].ch_layout = mh.channel_layout_mlp;
    } else {
396 397 398 399 400 401
        if (mh.stream_type != 0xba) {
            avpriv_request_sample(m->avctx,
                        "unexpected stream_type %X in !MLP",
                        mh.stream_type);
            return AVERROR_PATCHWELCOME;
        }
402 403 404 405 406 407 408 409
        if ((substr = (mh.num_substreams > 1)))
            m->substream[0].ch_layout = AV_CH_LAYOUT_STEREO;
        if (mh.num_substreams > 2)
            if (mh.channel_layout_thd_stream2)
                m->substream[2].ch_layout = mh.channel_layout_thd_stream2;
            else
                m->substream[2].ch_layout = mh.channel_layout_thd_stream1;
        m->substream[substr].ch_layout = mh.channel_layout_thd_stream1;
410 411 412 413 414 415 416

        if (m->avctx->channels<=2 && m->substream[substr].ch_layout == AV_CH_LAYOUT_MONO && m->max_decoded_substream == 1) {
            av_log(m->avctx, AV_LOG_DEBUG, "Mono stream with 2 substreams, ignoring 2nd\n");
            m->max_decoded_substream = 0;
            if (m->avctx->channels==2)
                m->avctx->channel_layout = AV_CH_LAYOUT_STEREO;
        }
417 418
    }

419
    m->needs_reordering = mh.channel_arrangement >= 18 && mh.channel_arrangement <= 20;
420

421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
    /* Parse the TrueHD decoder channel modifiers and set each substream's
     * AVMatrixEncoding accordingly.
     *
     * The meaning of the modifiers depends on the channel layout:
     *
     * - THD_CH_MODIFIER_LTRT, THD_CH_MODIFIER_LBINRBIN only apply to 2-channel
     *
     * - THD_CH_MODIFIER_MONO applies to 1-channel or 2-channel (dual mono)
     *
     * - THD_CH_MODIFIER_SURROUNDEX, THD_CH_MODIFIER_NOTSURROUNDEX only apply to
     *   layouts with an Ls/Rs channel pair
     */
    for (substr = 0; substr < MAX_SUBSTREAMS; substr++)
        m->substream[substr].matrix_encoding = AV_MATRIX_ENCODING_NONE;
    if (m->avctx->codec_id == AV_CODEC_ID_TRUEHD) {
        if (mh.num_substreams > 2 &&
            mh.channel_layout_thd_stream2 & AV_CH_SIDE_LEFT &&
            mh.channel_layout_thd_stream2 & AV_CH_SIDE_RIGHT &&
            mh.channel_modifier_thd_stream2 == THD_CH_MODIFIER_SURROUNDEX)
            m->substream[2].matrix_encoding = AV_MATRIX_ENCODING_DOLBYEX;

        if (mh.num_substreams > 1 &&
            mh.channel_layout_thd_stream1 & AV_CH_SIDE_LEFT &&
            mh.channel_layout_thd_stream1 & AV_CH_SIDE_RIGHT &&
            mh.channel_modifier_thd_stream1 == THD_CH_MODIFIER_SURROUNDEX)
            m->substream[1].matrix_encoding = AV_MATRIX_ENCODING_DOLBYEX;

        if (mh.num_substreams > 0)
            switch (mh.channel_modifier_thd_stream0) {
            case THD_CH_MODIFIER_LTRT:
                m->substream[0].matrix_encoding = AV_MATRIX_ENCODING_DOLBY;
                break;
            case THD_CH_MODIFIER_LBINRBIN:
                m->substream[0].matrix_encoding = AV_MATRIX_ENCODING_DOLBYHEADPHONE;
                break;
            default:
                break;
            }
    }

Ramiro Polla's avatar
Ramiro Polla committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
    return 0;
}

/** Read a restart header from a block in a substream. This contains parameters
 *  required to decode the audio that do not change very often. Generally
 *  (always) present only in blocks following a major sync. */

static int read_restart_header(MLPDecodeContext *m, GetBitContext *gbp,
                               const uint8_t *buf, unsigned int substr)
{
    SubStream *s = &m->substream[substr];
    unsigned int ch;
    int sync_word, tmp;
    uint8_t checksum;
    uint8_t lossless_check;
    int start_count = get_bits_count(gbp);
477 478 479 480
    int min_channel, max_channel, max_matrix_channel;
    const int std_max_matrix_channel = m->avctx->codec_id == AV_CODEC_ID_MLP
                                     ? MAX_MATRIX_CHANNEL_MLP
                                     : MAX_MATRIX_CHANNEL_TRUEHD;
Ramiro Polla's avatar
Ramiro Polla committed
481 482 483

    sync_word = get_bits(gbp, 13);

484
    if (sync_word != 0x31ea >> 1) {
Ramiro Polla's avatar
Ramiro Polla committed
485
        av_log(m->avctx, AV_LOG_ERROR,
Diego Biurrun's avatar
Diego Biurrun committed
486
               "restart header sync incorrect (got 0x%04x)\n", sync_word);
487
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
488 489
    }

490 491
    s->noise_type = get_bits1(gbp);

492
    if (m->avctx->codec_id == AV_CODEC_ID_MLP && s->noise_type) {
493
        av_log(m->avctx, AV_LOG_ERROR, "MLP must have 0x31ea sync word.\n");
494
        return AVERROR_INVALIDDATA;
495 496
    }

Ramiro Polla's avatar
Ramiro Polla committed
497 498
    skip_bits(gbp, 16); /* Output timestamp */

499 500 501
    min_channel        = get_bits(gbp, 4);
    max_channel        = get_bits(gbp, 4);
    max_matrix_channel = get_bits(gbp, 4);
Ramiro Polla's avatar
Ramiro Polla committed
502

503
    if (max_matrix_channel > std_max_matrix_channel) {
504 505
        av_log(m->avctx, AV_LOG_ERROR,
               "Max matrix channel cannot be greater than %d.\n",
506
               std_max_matrix_channel);
507
        return AVERROR_INVALIDDATA;
508 509
    }

510
    if (max_channel != max_matrix_channel) {
511 512
        av_log(m->avctx, AV_LOG_ERROR,
               "Max channel must be equal max matrix channel.\n");
513
        return AVERROR_INVALIDDATA;
514 515
    }

516 517
    /* This should happen for TrueHD streams with >6 channels and MLP's noise
     * type. It is not yet known if this is allowed. */
518
    if (max_channel > MAX_MATRIX_CHANNEL_MLP && !s->noise_type) {
519 520 521
        avpriv_request_sample(m->avctx,
                              "%d channels (more than the "
                              "maximum supported by the decoder)",
522
                              max_channel + 2);
523
        return AVERROR_PATCHWELCOME;
524 525
    }

526
    if (min_channel > max_channel) {
Ramiro Polla's avatar
Ramiro Polla committed
527 528
        av_log(m->avctx, AV_LOG_ERROR,
               "Substream min channel cannot be greater than max channel.\n");
529
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
530 531
    }

532 533 534
    s->min_channel        = min_channel;
    s->max_channel        = max_channel;
    s->max_matrix_channel = max_matrix_channel;
535

536
    if (m->avctx->request_channel_layout && (s->ch_layout & m->avctx->request_channel_layout) ==
537
        m->avctx->request_channel_layout && m->max_decoded_substream > substr) {
538 539 540 541 542
        av_log(m->avctx, AV_LOG_DEBUG,
               "Extracting %d-channel downmix (0x%"PRIx64") from substream %d. "
               "Further substreams will be skipped.\n",
               s->max_channel + 1, s->ch_layout, substr);
        m->max_decoded_substream = substr;
Ramiro Polla's avatar
Ramiro Polla committed
543 544 545 546 547 548 549 550 551 552 553
    }

    s->noise_shift   = get_bits(gbp,  4);
    s->noisegen_seed = get_bits(gbp, 23);

    skip_bits(gbp, 19);

    s->data_check_present = get_bits1(gbp);
    lossless_check = get_bits(gbp, 8);
    if (substr == m->max_decoded_substream
        && s->lossless_check_data != 0xffffffff) {
554
        tmp = xor_32_to_8(s->lossless_check_data);
Ramiro Polla's avatar
Ramiro Polla committed
555 556
        if (tmp != lossless_check)
            av_log(m->avctx, AV_LOG_WARNING,
Diego Biurrun's avatar
Diego Biurrun committed
557
                   "Lossless check failed - expected %02x, calculated %02x.\n",
Ramiro Polla's avatar
Ramiro Polla committed
558 559 560 561 562
                   lossless_check, tmp);
    }

    skip_bits(gbp, 16);

563 564
    memset(s->ch_assign, 0, sizeof(s->ch_assign));

Ramiro Polla's avatar
Ramiro Polla committed
565 566
    for (ch = 0; ch <= s->max_matrix_channel; ch++) {
        int ch_assign = get_bits(gbp, 6);
567 568 569 570 571 572
        if (m->avctx->codec_id == AV_CODEC_ID_TRUEHD) {
            uint64_t channel = thd_channel_layout_extract_channel(s->ch_layout,
                                                                  ch_assign);
            ch_assign = av_get_channel_layout_channel_index(s->ch_layout,
                                                            channel);
        }
573
        if (ch_assign < 0 || ch_assign > s->max_matrix_channel) {
574 575 576
            avpriv_request_sample(m->avctx,
                                  "Assignment of matrix channel %d to invalid output channel %d",
                                  ch, ch_assign);
577
            return AVERROR_PATCHWELCOME;
Ramiro Polla's avatar
Ramiro Polla committed
578
        }
579
        s->ch_assign[ch_assign] = ch;
Ramiro Polla's avatar
Ramiro Polla committed
580 581
    }

582
    checksum = ff_mlp_restart_checksum(buf, get_bits_count(gbp) - start_count);
Ramiro Polla's avatar
Ramiro Polla committed
583 584

    if (checksum != get_bits(gbp, 8))
Diego Biurrun's avatar
Diego Biurrun committed
585
        av_log(m->avctx, AV_LOG_ERROR, "restart header checksum error\n");
Ramiro Polla's avatar
Ramiro Polla committed
586

Diego Biurrun's avatar
Diego Biurrun committed
587
    /* Set default decoding parameters. */
Ramiro Polla's avatar
Ramiro Polla committed
588 589 590 591 592 593 594 595 596
    s->param_presence_flags   = 0xff;
    s->num_primitive_matrices = 0;
    s->blocksize              = 8;
    s->lossless_check_data    = 0;

    memset(s->output_shift   , 0, sizeof(s->output_shift   ));
    memset(s->quant_step_size, 0, sizeof(s->quant_step_size));

    for (ch = s->min_channel; ch <= s->max_channel; ch++) {
597
        ChannelParams *cp = &s->channel_params[ch];
598 599 600 601
        cp->filter_params[FIR].order = 0;
        cp->filter_params[IIR].order = 0;
        cp->filter_params[FIR].shift = 0;
        cp->filter_params[IIR].shift = 0;
Ramiro Polla's avatar
Ramiro Polla committed
602

Diego Biurrun's avatar
Diego Biurrun committed
603
        /* Default audio coding is 24-bit raw PCM. */
604
        cp->huff_offset      = 0;
605
        cp->sign_huff_offset = -(1 << 23);
606 607
        cp->codebook         = 0;
        cp->huff_lsbs        = 24;
Ramiro Polla's avatar
Ramiro Polla committed
608 609
    }

610 611 612
    if (substr == m->max_decoded_substream) {
        m->avctx->channels       = s->max_matrix_channel + 1;
        m->avctx->channel_layout = s->ch_layout;
613 614 615 616
        m->dsp.mlp_pack_output = m->dsp.mlp_select_pack_output(s->ch_assign,
                                                               s->output_shift,
                                                               s->max_matrix_channel,
                                                               m->avctx->sample_fmt == AV_SAMPLE_FMT_S32);
617 618 619 620 621 622 623 624 625 626 627 628 629 630

        if (m->avctx->codec_id == AV_CODEC_ID_MLP && m->needs_reordering) {
            if (m->avctx->channel_layout == (AV_CH_LAYOUT_QUAD|AV_CH_LOW_FREQUENCY) ||
                m->avctx->channel_layout == AV_CH_LAYOUT_5POINT0_BACK) {
                int i = s->ch_assign[4];
                s->ch_assign[4] = s->ch_assign[3];
                s->ch_assign[3] = s->ch_assign[2];
                s->ch_assign[2] = i;
            } else if (m->avctx->channel_layout == AV_CH_LAYOUT_5POINT1_BACK) {
                FFSWAP(int, s->ch_assign[2], s->ch_assign[4]);
                FFSWAP(int, s->ch_assign[3], s->ch_assign[5]);
            }
        }

631
    }
Ramiro Polla's avatar
Ramiro Polla committed
632 633 634 635 636 637 638

    return 0;
}

/** Read parameters for one of the prediction filters. */

static int read_filter_params(MLPDecodeContext *m, GetBitContext *gbp,
639 640
                              unsigned int substr, unsigned int channel,
                              unsigned int filter)
Ramiro Polla's avatar
Ramiro Polla committed
641
{
642 643
    SubStream *s = &m->substream[substr];
    FilterParams *fp = &s->channel_params[channel].filter_params[filter];
644
    const int max_order = filter ? MAX_IIR_ORDER : MAX_FIR_ORDER;
Ramiro Polla's avatar
Ramiro Polla committed
645 646 647
    const char fchar = filter ? 'I' : 'F';
    int i, order;

Diego Biurrun's avatar
Diego Biurrun committed
648
    // Filter is 0 for FIR, 1 for IIR.
649
    av_assert0(filter < 2);
Ramiro Polla's avatar
Ramiro Polla committed
650

651 652
    if (m->filter_changed[channel][filter]++ > 1) {
        av_log(m->avctx, AV_LOG_ERROR, "Filters may change only once per access unit.\n");
653
        return AVERROR_INVALIDDATA;
654
    }
655

Ramiro Polla's avatar
Ramiro Polla committed
656
    order = get_bits(gbp, 4);
657
    if (order > max_order) {
Ramiro Polla's avatar
Ramiro Polla committed
658
        av_log(m->avctx, AV_LOG_ERROR,
Diego Biurrun's avatar
Diego Biurrun committed
659
               "%cIR filter order %d is greater than maximum %d.\n",
660
               fchar, order, max_order);
661
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
662
    }
663
    fp->order = order;
Ramiro Polla's avatar
Ramiro Polla committed
664 665

    if (order > 0) {
666
        int32_t *fcoeff = s->channel_params[channel].coeff[filter];
Ramiro Polla's avatar
Ramiro Polla committed
667 668
        int coeff_bits, coeff_shift;

669
        fp->shift = get_bits(gbp, 4);
Ramiro Polla's avatar
Ramiro Polla committed
670 671 672 673 674

        coeff_bits  = get_bits(gbp, 5);
        coeff_shift = get_bits(gbp, 3);
        if (coeff_bits < 1 || coeff_bits > 16) {
            av_log(m->avctx, AV_LOG_ERROR,
Diego Biurrun's avatar
Diego Biurrun committed
675
                   "%cIR filter coeff_bits must be between 1 and 16.\n",
Ramiro Polla's avatar
Ramiro Polla committed
676
                   fchar);
677
            return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
678 679 680
        }
        if (coeff_bits + coeff_shift > 16) {
            av_log(m->avctx, AV_LOG_ERROR,
Diego Biurrun's avatar
Diego Biurrun committed
681
                   "Sum of coeff_bits and coeff_shift for %cIR filter must be 16 or less.\n",
Ramiro Polla's avatar
Ramiro Polla committed
682
                   fchar);
683
            return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
684 685 686
        }

        for (i = 0; i < order; i++)
687
            fcoeff[i] = get_sbits(gbp, coeff_bits) * (1 << coeff_shift);
Ramiro Polla's avatar
Ramiro Polla committed
688 689 690 691 692 693

        if (get_bits1(gbp)) {
            int state_bits, state_shift;

            if (filter == FIR) {
                av_log(m->avctx, AV_LOG_ERROR,
Diego Biurrun's avatar
Diego Biurrun committed
694
                       "FIR filter has state data specified.\n");
695
                return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
696 697 698 699 700
            }

            state_bits  = get_bits(gbp, 4);
            state_shift = get_bits(gbp, 4);

Diego Biurrun's avatar
Diego Biurrun committed
701
            /* TODO: Check validity of state data. */
Ramiro Polla's avatar
Ramiro Polla committed
702 703

            for (i = 0; i < order; i++)
704
                fp->state[i] = state_bits ? get_sbits(gbp, state_bits) * (1 << state_shift) : 0;
Ramiro Polla's avatar
Ramiro Polla committed
705 706 707 708 709 710
        }
    }

    return 0;
}

711 712
/** Read parameters for primitive matrices. */

713
static int read_matrix_params(MLPDecodeContext *m, unsigned int substr, GetBitContext *gbp)
714
{
715
    SubStream *s = &m->substream[substr];
716
    unsigned int mat, ch;
717
    const int max_primitive_matrices = m->avctx->codec_id == AV_CODEC_ID_MLP
718 719
                                     ? MAX_MATRICES_MLP
                                     : MAX_MATRICES_TRUEHD;
720

721 722
    if (m->matrix_changed++ > 1) {
        av_log(m->avctx, AV_LOG_ERROR, "Matrices may change only once per access unit.\n");
723
        return AVERROR_INVALIDDATA;
724 725
    }

726 727
    s->num_primitive_matrices = get_bits(gbp, 4);

728 729 730 731
    if (s->num_primitive_matrices > max_primitive_matrices) {
        av_log(m->avctx, AV_LOG_ERROR,
               "Number of primitive matrices cannot be greater than %d.\n",
               max_primitive_matrices);
732
        goto error;
733 734
    }

735 736 737 738 739 740
    for (mat = 0; mat < s->num_primitive_matrices; mat++) {
        int frac_bits, max_chan;
        s->matrix_out_ch[mat] = get_bits(gbp, 4);
        frac_bits             = get_bits(gbp, 4);
        s->lsb_bypass   [mat] = get_bits1(gbp);

741
        if (s->matrix_out_ch[mat] > s->max_matrix_channel) {
742 743 744
            av_log(m->avctx, AV_LOG_ERROR,
                    "Invalid channel %d specified as output from matrix.\n",
                    s->matrix_out_ch[mat]);
745
            goto error;
746 747 748 749
        }
        if (frac_bits > 14) {
            av_log(m->avctx, AV_LOG_ERROR,
                    "Too many fractional bits specified.\n");
750
            goto error;
751 752 753 754 755 756 757 758 759 760 761
        }

        max_chan = s->max_matrix_channel;
        if (!s->noise_type)
            max_chan+=2;

        for (ch = 0; ch <= max_chan; ch++) {
            int coeff_val = 0;
            if (get_bits1(gbp))
                coeff_val = get_sbits(gbp, frac_bits + 2);

762
            s->matrix_coeff[mat][ch] = coeff_val * (1 << (14 - frac_bits));
763 764 765 766 767 768 769 770 771
        }

        if (s->noise_type)
            s->matrix_noise_shift[mat] = get_bits(gbp, 4);
        else
            s->matrix_noise_shift[mat] = 0;
    }

    return 0;
772 773 774 775 776
error:
    s->num_primitive_matrices = 0;
    memset(s->matrix_out_ch, 0, sizeof(s->matrix_out_ch));

    return AVERROR_INVALIDDATA;
777 778
}

779 780 781 782 783
/** Read channel parameters. */

static int read_channel_params(MLPDecodeContext *m, unsigned int substr,
                               GetBitContext *gbp, unsigned int ch)
{
784 785
    SubStream *s = &m->substream[substr];
    ChannelParams *cp = &s->channel_params[ch];
786 787
    FilterParams *fir = &cp->filter_params[FIR];
    FilterParams *iir = &cp->filter_params[IIR];
788
    int ret;
789 790 791

    if (s->param_presence_flags & PARAM_FIR)
        if (get_bits1(gbp))
792 793
            if ((ret = read_filter_params(m, gbp, substr, ch, FIR)) < 0)
                return ret;
794 795 796

    if (s->param_presence_flags & PARAM_IIR)
        if (get_bits1(gbp))
797 798
            if ((ret = read_filter_params(m, gbp, substr, ch, IIR)) < 0)
                return ret;
799

800 801
    if (fir->order + iir->order > 8) {
        av_log(m->avctx, AV_LOG_ERROR, "Total filter orders too high.\n");
802
        return AVERROR_INVALIDDATA;
803 804
    }

805 806 807 808
    if (fir->order && iir->order &&
        fir->shift != iir->shift) {
        av_log(m->avctx, AV_LOG_ERROR,
                "FIR and IIR filters must use the same precision.\n");
809
        return AVERROR_INVALIDDATA;
810 811
    }
    /* The FIR and IIR filters must have the same precision.
812 813 814 815
     * To simplify the filtering code, only the precision of the
     * FIR filter is considered. If only the IIR filter is employed,
     * the FIR filter precision is set to that of the IIR filter, so
     * that the filtering code can use it. */
816 817 818 819 820 821 822 823 824 825
    if (!fir->order && iir->order)
        fir->shift = iir->shift;

    if (s->param_presence_flags & PARAM_HUFFOFFSET)
        if (get_bits1(gbp))
            cp->huff_offset = get_sbits(gbp, 15);

    cp->codebook  = get_bits(gbp, 2);
    cp->huff_lsbs = get_bits(gbp, 5);

826 827
    if (cp->huff_lsbs > 24) {
        av_log(m->avctx, AV_LOG_ERROR, "Invalid huff_lsbs.\n");
828
        cp->huff_lsbs = 0;
829
        return AVERROR_INVALIDDATA;
830
    }
831 832 833 834

    return 0;
}

Ramiro Polla's avatar
Ramiro Polla committed
835 836 837 838 839 840 841
/** Read decoding parameters that change more often than those in the restart
 *  header. */

static int read_decoding_params(MLPDecodeContext *m, GetBitContext *gbp,
                                unsigned int substr)
{
    SubStream *s = &m->substream[substr];
842
    unsigned int ch;
843 844
    int ret = 0;
    unsigned recompute_sho = 0;
Ramiro Polla's avatar
Ramiro Polla committed
845

846
    if (s->param_presence_flags & PARAM_PRESENCE)
847 848
        if (get_bits1(gbp))
            s->param_presence_flags = get_bits(gbp, 8);
Ramiro Polla's avatar
Ramiro Polla committed
849 850 851 852

    if (s->param_presence_flags & PARAM_BLOCKSIZE)
        if (get_bits1(gbp)) {
            s->blocksize = get_bits(gbp, 9);
853
            if (s->blocksize < 8 || s->blocksize > m->access_unit_size) {
854
                av_log(m->avctx, AV_LOG_ERROR, "Invalid blocksize.\n");
Ramiro Polla's avatar
Ramiro Polla committed
855
                s->blocksize = 0;
856
                return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
857 858 859 860
            }
        }

    if (s->param_presence_flags & PARAM_MATRIX)
861
        if (get_bits1(gbp))
862 863
            if ((ret = read_matrix_params(m, substr, gbp)) < 0)
                return ret;
Ramiro Polla's avatar
Ramiro Polla committed
864 865

    if (s->param_presence_flags & PARAM_OUTSHIFT)
866
        if (get_bits1(gbp)) {
867
            for (ch = 0; ch <= s->max_matrix_channel; ch++) {
868
                s->output_shift[ch] = get_sbits(gbp, 4);
869 870 871 872 873
                if (s->output_shift[ch] < 0) {
                    avpriv_request_sample(m->avctx, "Negative output_shift");
                    s->output_shift[ch] = 0;
                }
            }
874 875 876 877 878 879
            if (substr == m->max_decoded_substream)
                m->dsp.mlp_pack_output = m->dsp.mlp_select_pack_output(s->ch_assign,
                                                                       s->output_shift,
                                                                       s->max_matrix_channel,
                                                                       m->avctx->sample_fmt == AV_SAMPLE_FMT_S32);
        }
Ramiro Polla's avatar
Ramiro Polla committed
880 881 882 883 884 885

    if (s->param_presence_flags & PARAM_QUANTSTEP)
        if (get_bits1(gbp))
            for (ch = 0; ch <= s->max_channel; ch++) {
                s->quant_step_size[ch] = get_bits(gbp, 4);

886
                recompute_sho |= 1<<ch;
Ramiro Polla's avatar
Ramiro Polla committed
887 888 889
            }

    for (ch = s->min_channel; ch <= s->max_channel; ch++)
890 891
        if (get_bits1(gbp)) {
            recompute_sho |= 1<<ch;
892
            if ((ret = read_channel_params(m, substr, gbp, ch)) < 0)
893 894
                goto fail;
        }
Ramiro Polla's avatar
Ramiro Polla committed
895

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913

fail:
    for (ch = 0; ch <= s->max_channel; ch++) {
        if (recompute_sho & (1<<ch)) {
            ChannelParams *cp = &s->channel_params[ch];

            if (cp->codebook > 0 && cp->huff_lsbs < s->quant_step_size[ch]) {
                if (ret >= 0) {
                    av_log(m->avctx, AV_LOG_ERROR, "quant_step_size larger than huff_lsbs\n");
                    ret = AVERROR_INVALIDDATA;
                }
                s->quant_step_size[ch] = 0;
            }

            cp->sign_huff_offset = calculate_sign_huff(m, substr, ch);
        }
    }
    return ret;
Ramiro Polla's avatar
Ramiro Polla committed
914 915
}

916
#define MSB_MASK(bits)  (-1u << (bits))
Ramiro Polla's avatar
Ramiro Polla committed
917 918 919 920 921 922 923 924

/** Generate PCM samples using the prediction filters and residual values
 *  read from the data stream, and update the filter state. */

static void filter_channel(MLPDecodeContext *m, unsigned int substr,
                           unsigned int channel)
{
    SubStream *s = &m->substream[substr];
925
    const int32_t *fircoeff = s->channel_params[channel].coeff[FIR];
926 927 928
    int32_t state_buffer[NUM_FILTERS][MAX_BLOCKSIZE + MAX_FIR_ORDER];
    int32_t *firbuf = state_buffer[FIR] + MAX_BLOCKSIZE;
    int32_t *iirbuf = state_buffer[IIR] + MAX_BLOCKSIZE;
929 930
    FilterParams *fir = &s->channel_params[channel].filter_params[FIR];
    FilterParams *iir = &s->channel_params[channel].filter_params[IIR];
931
    unsigned int filter_shift = fir->shift;
Ramiro Polla's avatar
Ramiro Polla committed
932 933
    int32_t mask = MSB_MASK(s->quant_step_size[channel]);

934 935
    memcpy(firbuf, fir->state, MAX_FIR_ORDER * sizeof(int32_t));
    memcpy(iirbuf, iir->state, MAX_IIR_ORDER * sizeof(int32_t));
Ramiro Polla's avatar
Ramiro Polla committed
936

937 938
    m->dsp.mlp_filter_channel(firbuf, fircoeff,
                              fir->order, iir->order,
939 940
                              filter_shift, mask, s->blocksize,
                              &m->sample_buffer[s->blockpos][channel]);
Ramiro Polla's avatar
Ramiro Polla committed
941

942 943
    memcpy(fir->state, firbuf - s->blocksize, MAX_FIR_ORDER * sizeof(int32_t));
    memcpy(iir->state, iirbuf - s->blocksize, MAX_IIR_ORDER * sizeof(int32_t));
Ramiro Polla's avatar
Ramiro Polla committed
944 945 946 947 948 949 950 951 952
}

/** Read a block of PCM residual data (or actual if no filtering active). */

static int read_block_data(MLPDecodeContext *m, GetBitContext *gbp,
                           unsigned int substr)
{
    SubStream *s = &m->substream[substr];
    unsigned int i, ch, expected_stream_pos = 0;
953
    int ret;
Ramiro Polla's avatar
Ramiro Polla committed
954 955 956 957

    if (s->data_check_present) {
        expected_stream_pos  = get_bits_count(gbp);
        expected_stream_pos += get_bits(gbp, 16);
958 959
        avpriv_request_sample(m->avctx,
                              "Substreams with VLC block size check info");
Ramiro Polla's avatar
Ramiro Polla committed
960 961 962
    }

    if (s->blockpos + s->blocksize > m->access_unit_size) {
Diego Biurrun's avatar
Diego Biurrun committed
963
        av_log(m->avctx, AV_LOG_ERROR, "too many audio samples in frame\n");
964
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
965 966 967 968 969
    }

    memset(&m->bypassed_lsbs[s->blockpos][0], 0,
           s->blocksize * sizeof(m->bypassed_lsbs[0]));

970
    for (i = 0; i < s->blocksize; i++)
971 972
        if ((ret = read_huff_channels(m, gbp, substr, i)) < 0)
            return ret;
Ramiro Polla's avatar
Ramiro Polla committed
973

974
    for (ch = s->min_channel; ch <= s->max_channel; ch++)
Ramiro Polla's avatar
Ramiro Polla committed
975 976 977 978 979 980
        filter_channel(m, substr, ch);

    s->blockpos += s->blocksize;

    if (s->data_check_present) {
        if (get_bits_count(gbp) != expected_stream_pos)
Diego Biurrun's avatar
Diego Biurrun committed
981
            av_log(m->avctx, AV_LOG_ERROR, "block data length mismatch\n");
Ramiro Polla's avatar
Ramiro Polla committed
982 983 984 985 986 987
        skip_bits(gbp, 8);
    }

    return 0;
}

Diego Biurrun's avatar
Diego Biurrun committed
988
/** Data table used for TrueHD noise generation function. */
Ramiro Polla's avatar
Ramiro Polla committed
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027

static const int8_t noise_table[256] = {
     30,  51,  22,  54,   3,   7,  -4,  38,  14,  55,  46,  81,  22,  58,  -3,   2,
     52,  31,  -7,  51,  15,  44,  74,  30,  85, -17,  10,  33,  18,  80,  28,  62,
     10,  32,  23,  69,  72,  26,  35,  17,  73,  60,   8,  56,   2,   6,  -2,  -5,
     51,   4,  11,  50,  66,  76,  21,  44,  33,  47,   1,  26,  64,  48,  57,  40,
     38,  16, -10, -28,  92,  22, -18,  29, -10,   5, -13,  49,  19,  24,  70,  34,
     61,  48,  30,  14,  -6,  25,  58,  33,  42,  60,  67,  17,  54,  17,  22,  30,
     67,  44,  -9,  50, -11,  43,  40,  32,  59,  82,  13,  49, -14,  55,  60,  36,
     48,  49,  31,  47,  15,  12,   4,  65,   1,  23,  29,  39,  45,  -2,  84,  69,
      0,  72,  37,  57,  27,  41, -15, -16,  35,  31,  14,  61,  24,   0,  27,  24,
     16,  41,  55,  34,  53,   9,  56,  12,  25,  29,  53,   5,  20, -20,  -8,  20,
     13,  28,  -3,  78,  38,  16,  11,  62,  46,  29,  21,  24,  46,  65,  43, -23,
     89,  18,  74,  21,  38, -12,  19,  12, -19,   8,  15,  33,   4,  57,   9,  -8,
     36,  35,  26,  28,   7,  83,  63,  79,  75,  11,   3,  87,  37,  47,  34,  40,
     39,  19,  20,  42,  27,  34,  39,  77,  13,  42,  59,  64,  45,  -1,  32,  37,
     45,  -5,  53,  -6,   7,  36,  50,  23,   6,  32,   9, -21,  18,  71,  27,  52,
    -25,  31,  35,  42,  -1,  68,  63,  52,  26,  43,  66,  37,  41,  25,  40,  70,
};

/** Noise generation functions.
 *  I'm not sure what these are for - they seem to be some kind of pseudorandom
 *  sequence generators, used to generate noise data which is used when the
 *  channels are rematrixed. I'm not sure if they provide a practical benefit
 *  to compression, or just obfuscate the decoder. Are they for some kind of
 *  dithering? */

/** Generate two channels of noise, used in the matrix when
 *  restart sync word == 0x31ea. */

static void generate_2_noise_channels(MLPDecodeContext *m, unsigned int substr)
{
    SubStream *s = &m->substream[substr];
    unsigned int i;
    uint32_t seed = s->noisegen_seed;
    unsigned int maxchan = s->max_matrix_channel;

    for (i = 0; i < s->blockpos; i++) {
        uint16_t seed_shr7 = seed >> 7;
1028 1029
        m->sample_buffer[i][maxchan+1] = ((int8_t)(seed >> 15)) * (1 << s->noise_shift);
        m->sample_buffer[i][maxchan+2] = ((int8_t) seed_shr7)   * (1 << s->noise_shift);
Ramiro Polla's avatar
Ramiro Polla committed
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053

        seed = (seed << 16) ^ seed_shr7 ^ (seed_shr7 << 5);
    }

    s->noisegen_seed = seed;
}

/** Generate a block of noise, used when restart sync word == 0x31eb. */

static void fill_noise_buffer(MLPDecodeContext *m, unsigned int substr)
{
    SubStream *s = &m->substream[substr];
    unsigned int i;
    uint32_t seed = s->noisegen_seed;

    for (i = 0; i < m->access_unit_size_pow2; i++) {
        uint8_t seed_shr15 = seed >> 15;
        m->noise_buffer[i] = noise_table[seed_shr15];
        seed = (seed << 8) ^ seed_shr15 ^ (seed_shr15 << 5);
    }

    s->noisegen_seed = seed;
}

1054
/** Write the audio data into the output buffer. */
Ramiro Polla's avatar
Ramiro Polla committed
1055

1056 1057
static int output_data(MLPDecodeContext *m, unsigned int substr,
                       AVFrame *frame, int *got_frame_ptr)
Ramiro Polla's avatar
Ramiro Polla committed
1058
{
1059
    AVCodecContext *avctx = m->avctx;
Ramiro Polla's avatar
Ramiro Polla committed
1060
    SubStream *s = &m->substream[substr];
1061
    unsigned int mat;
Ramiro Polla's avatar
Ramiro Polla committed
1062
    unsigned int maxchan;
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
    int ret;
    int is32 = (m->avctx->sample_fmt == AV_SAMPLE_FMT_S32);

    if (m->avctx->channels != s->max_matrix_channel + 1) {
        av_log(m->avctx, AV_LOG_ERROR, "channel count mismatch\n");
        return AVERROR_INVALIDDATA;
    }

    if (!s->blockpos) {
        av_log(avctx, AV_LOG_ERROR, "No samples to output.\n");
        return AVERROR_INVALIDDATA;
    }
Ramiro Polla's avatar
Ramiro Polla committed
1075 1076 1077 1078 1079 1080 1081 1082 1083

    maxchan = s->max_matrix_channel;
    if (!s->noise_type) {
        generate_2_noise_channels(m, substr);
        maxchan += 2;
    } else {
        fill_noise_buffer(m, substr);
    }

1084 1085
    /* Apply the channel matrices in turn to reconstruct the original audio
     * samples. */
Ramiro Polla's avatar
Ramiro Polla committed
1086 1087
    for (mat = 0; mat < s->num_primitive_matrices; mat++) {
        unsigned int dest_ch = s->matrix_out_ch[mat];
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
        m->dsp.mlp_rematrix_channel(&m->sample_buffer[0][0],
                                    s->matrix_coeff[mat],
                                    &m->bypassed_lsbs[0][mat],
                                    m->noise_buffer,
                                    s->num_primitive_matrices - mat,
                                    dest_ch,
                                    s->blockpos,
                                    maxchan,
                                    s->matrix_noise_shift[mat],
                                    m->access_unit_size_pow2,
                                    MSB_MASK(s->quant_step_size[dest_ch]));
Ramiro Polla's avatar
Ramiro Polla committed
1099
    }
1100

1101
    /* get output buffer */
1102
    frame->nb_samples = s->blockpos;
1103
    if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
1104
        return ret;
1105 1106 1107 1108 1109 1110 1111 1112
    s->lossless_check_data = m->dsp.mlp_pack_output(s->lossless_check_data,
                                                    s->blockpos,
                                                    m->sample_buffer,
                                                    frame->data[0],
                                                    s->ch_assign,
                                                    s->output_shift,
                                                    s->max_matrix_channel,
                                                    is32);
Ramiro Polla's avatar
Ramiro Polla committed
1113

1114 1115 1116 1117
    /* Update matrix encoding side data */
    if ((ret = ff_side_data_update_matrix_encoding(frame, s->matrix_encoding)) < 0)
        return ret;

1118
    *got_frame_ptr = 1;
Ramiro Polla's avatar
Ramiro Polla committed
1119 1120 1121 1122 1123

    return 0;
}

/** Read an access unit from the stream.
1124 1125
 *  @return negative on error, 0 if not enough data is present in the input stream,
 *  otherwise the number of bytes consumed. */
Ramiro Polla's avatar
Ramiro Polla committed
1126

1127 1128
static int read_access_unit(AVCodecContext *avctx, void* data,
                            int *got_frame_ptr, AVPacket *avpkt)
Ramiro Polla's avatar
Ramiro Polla committed
1129
{
1130 1131
    const uint8_t *buf = avpkt->data;
    int buf_size = avpkt->size;
Ramiro Polla's avatar
Ramiro Polla committed
1132 1133 1134 1135 1136 1137 1138 1139 1140
    MLPDecodeContext *m = avctx->priv_data;
    GetBitContext gb;
    unsigned int length, substr;
    unsigned int substream_start;
    unsigned int header_size = 4;
    unsigned int substr_header_size = 0;
    uint8_t substream_parity_present[MAX_SUBSTREAMS];
    uint16_t substream_data_len[MAX_SUBSTREAMS];
    uint8_t parity_bits;
1141
    int ret;
Ramiro Polla's avatar
Ramiro Polla committed
1142 1143

    if (buf_size < 4)
1144
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
1145 1146 1147

    length = (AV_RB16(buf) & 0xfff) * 2;

1148
    if (length < 4 || length > buf_size)
1149
        return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
1150 1151 1152

    init_get_bits(&gb, (buf + 4), (length - 4) * 8);

1153
    m->is_major_sync_unit = 0;
Ramiro Polla's avatar
Ramiro Polla committed
1154 1155 1156
    if (show_bits_long(&gb, 31) == (0xf8726fba >> 1)) {
        if (read_major_sync(m, &gb) < 0)
            goto error;
1157
        m->is_major_sync_unit = 1;
1158
        header_size += m->major_sync_header_size;
Ramiro Polla's avatar
Ramiro Polla committed
1159 1160 1161 1162
    }

    if (!m->params_valid) {
        av_log(m->avctx, AV_LOG_WARNING,
Diego Biurrun's avatar
Diego Biurrun committed
1163
               "Stream parameters not seen; skipping frame.\n");
1164
        *got_frame_ptr = 0;
Ramiro Polla's avatar
Ramiro Polla committed
1165 1166 1167 1168 1169 1170
        return length;
    }

    substream_start = 0;

    for (substr = 0; substr < m->num_substreams; substr++) {
1171
        int extraword_present, checkdata_present, end, nonrestart_substr;
Ramiro Polla's avatar
Ramiro Polla committed
1172 1173

        extraword_present = get_bits1(&gb);
1174
        nonrestart_substr = get_bits1(&gb);
Ramiro Polla's avatar
Ramiro Polla committed
1175 1176 1177 1178 1179 1180 1181 1182
        checkdata_present = get_bits1(&gb);
        skip_bits1(&gb);

        end = get_bits(&gb, 12) * 2;

        substr_header_size += 2;

        if (extraword_present) {
1183
            if (m->avctx->codec_id == AV_CODEC_ID_MLP) {
1184 1185 1186
                av_log(m->avctx, AV_LOG_ERROR, "There must be no extraword for MLP.\n");
                goto error;
            }
Ramiro Polla's avatar
Ramiro Polla committed
1187 1188 1189 1190
            skip_bits(&gb, 16);
            substr_header_size += 2;
        }

1191 1192 1193 1194 1195
        if (length < header_size + substr_header_size) {
            av_log(m->avctx, AV_LOG_ERROR, "Insuffient data for headers\n");
            goto error;
        }

1196 1197 1198 1199 1200
        if (!(nonrestart_substr ^ m->is_major_sync_unit)) {
            av_log(m->avctx, AV_LOG_ERROR, "Invalid nonrestart_substr.\n");
            goto error;
        }

Ramiro Polla's avatar
Ramiro Polla committed
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
        if (end + header_size + substr_header_size > length) {
            av_log(m->avctx, AV_LOG_ERROR,
                   "Indicated length of substream %d data goes off end of "
                   "packet.\n", substr);
            end = length - header_size - substr_header_size;
        }

        if (end < substream_start) {
            av_log(avctx, AV_LOG_ERROR,
                   "Indicated end offset of substream %d data "
                   "is smaller than calculated start offset.\n",
                   substr);
            goto error;
        }

        if (substr > m->max_decoded_substream)
            continue;

        substream_parity_present[substr] = checkdata_present;
        substream_data_len[substr] = end - substream_start;
        substream_start = end;
    }

1224 1225
    parity_bits  = ff_mlp_calculate_parity(buf, 4);
    parity_bits ^= ff_mlp_calculate_parity(buf + header_size, substr_header_size);
Ramiro Polla's avatar
Ramiro Polla committed
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237

    if ((((parity_bits >> 4) ^ parity_bits) & 0xF) != 0xF) {
        av_log(avctx, AV_LOG_ERROR, "Parity check failed.\n");
        goto error;
    }

    buf += header_size + substr_header_size;

    for (substr = 0; substr <= m->max_decoded_substream; substr++) {
        SubStream *s = &m->substream[substr];
        init_get_bits(&gb, buf, substream_data_len[substr] * 8);

1238 1239 1240
        m->matrix_changed = 0;
        memset(m->filter_changed, 0, sizeof(m->filter_changed));

Ramiro Polla's avatar
Ramiro Polla committed
1241 1242 1243 1244
        s->blockpos = 0;
        do {
            if (get_bits1(&gb)) {
                if (get_bits1(&gb)) {
Diego Biurrun's avatar
Diego Biurrun committed
1245
                    /* A restart header should be present. */
Ramiro Polla's avatar
Ramiro Polla committed
1246 1247 1248 1249 1250
                    if (read_restart_header(m, &gb, buf, substr) < 0)
                        goto next_substr;
                    s->restart_seen = 1;
                }

1251
                if (!s->restart_seen)
Ramiro Polla's avatar
Ramiro Polla committed
1252 1253 1254 1255 1256
                    goto next_substr;
                if (read_decoding_params(m, &gb, substr) < 0)
                    goto next_substr;
            }

1257
            if (!s->restart_seen)
Ramiro Polla's avatar
Ramiro Polla committed
1258 1259
                goto next_substr;

1260 1261
            if ((ret = read_block_data(m, &gb, substr)) < 0)
                return ret;
Ramiro Polla's avatar
Ramiro Polla committed
1262

1263 1264 1265 1266
            if (get_bits_count(&gb) >= substream_data_len[substr] * 8)
                goto substream_length_mismatch;

        } while (!get_bits1(&gb));
Ramiro Polla's avatar
Ramiro Polla committed
1267 1268

        skip_bits(&gb, (-get_bits_count(&gb)) & 15);
1269

1270 1271 1272 1273
        if (substream_data_len[substr] * 8 - get_bits_count(&gb) >= 32) {
            int shorten_by;

            if (get_bits(&gb, 16) != 0xD234)
1274
                return AVERROR_INVALIDDATA;
1275 1276

            shorten_by = get_bits(&gb, 16);
1277
            if      (m->avctx->codec_id == AV_CODEC_ID_TRUEHD && shorten_by  & 0x2000)
1278
                s->blockpos -= FFMIN(shorten_by & 0x1FFF, s->blockpos);
1279
            else if (m->avctx->codec_id == AV_CODEC_ID_MLP    && shorten_by != 0xD234)
1280
                return AVERROR_INVALIDDATA;
1281

Ramiro Polla's avatar
Ramiro Polla committed
1282
            if (substr == m->max_decoded_substream)
Diego Biurrun's avatar
Diego Biurrun committed
1283
                av_log(m->avctx, AV_LOG_INFO, "End of stream indicated.\n");
Ramiro Polla's avatar
Ramiro Polla committed
1284
        }
1285

1286
        if (substream_parity_present[substr]) {
Ramiro Polla's avatar
Ramiro Polla committed
1287 1288
            uint8_t parity, checksum;

1289 1290 1291
            if (substream_data_len[substr] * 8 - get_bits_count(&gb) != 16)
                goto substream_length_mismatch;

1292 1293
            parity   = ff_mlp_calculate_parity(buf, substream_data_len[substr] - 2);
            checksum = ff_mlp_checksum8       (buf, substream_data_len[substr] - 2);
Ramiro Polla's avatar
Ramiro Polla committed
1294

1295 1296 1297 1298
            if ((get_bits(&gb, 8) ^ parity) != 0xa9    )
                av_log(m->avctx, AV_LOG_ERROR, "Substream %d parity check failed.\n", substr);
            if ( get_bits(&gb, 8)           != checksum)
                av_log(m->avctx, AV_LOG_ERROR, "Substream %d checksum failed.\n"    , substr);
Ramiro Polla's avatar
Ramiro Polla committed
1299
        }
1300 1301

        if (substream_data_len[substr] * 8 != get_bits_count(&gb))
1302
            goto substream_length_mismatch;
Ramiro Polla's avatar
Ramiro Polla committed
1303 1304

next_substr:
1305
        if (!s->restart_seen)
1306 1307 1308
            av_log(m->avctx, AV_LOG_ERROR,
                   "No restart header present in substream %d.\n", substr);

Ramiro Polla's avatar
Ramiro Polla committed
1309 1310 1311
        buf += substream_data_len[substr];
    }

1312
    if ((ret = output_data(m, m->max_decoded_substream, data, got_frame_ptr)) < 0)
1313
        return ret;
Ramiro Polla's avatar
Ramiro Polla committed
1314 1315 1316

    return length;

1317 1318
substream_length_mismatch:
    av_log(m->avctx, AV_LOG_ERROR, "substream %d length mismatch\n", substr);
1319
    return AVERROR_INVALIDDATA;
1320

Ramiro Polla's avatar
Ramiro Polla committed
1321 1322
error:
    m->params_valid = 0;
1323
    return AVERROR_INVALIDDATA;
Ramiro Polla's avatar
Ramiro Polla committed
1324 1325
}

1326
#if CONFIG_MLP_DECODER
1327
AVCodec ff_mlp_decoder = {
1328
    .name           = "mlp",
1329
    .long_name      = NULL_IF_CONFIG_SMALL("MLP (Meridian Lossless Packing)"),
1330
    .type           = AVMEDIA_TYPE_AUDIO,
1331
    .id             = AV_CODEC_ID_MLP,
1332 1333 1334
    .priv_data_size = sizeof(MLPDecodeContext),
    .init           = mlp_decode_init,
    .decode         = read_access_unit,
1335
    .capabilities   = AV_CODEC_CAP_DR1,
Ramiro Polla's avatar
Ramiro Polla committed
1336
};
1337
#endif
1338
#if CONFIG_TRUEHD_DECODER
1339
AVCodec ff_truehd_decoder = {
1340
    .name           = "truehd",
1341
    .long_name      = NULL_IF_CONFIG_SMALL("TrueHD"),
1342
    .type           = AVMEDIA_TYPE_AUDIO,
1343
    .id             = AV_CODEC_ID_TRUEHD,
1344 1345 1346
    .priv_data_size = sizeof(MLPDecodeContext),
    .init           = mlp_decode_init,
    .decode         = read_access_unit,
1347
    .capabilities   = AV_CODEC_CAP_DR1,
1348 1349
};
#endif /* CONFIG_TRUEHD_DECODER */