FFmpeg  4.4.8
mlpdec.c
Go to the documentation of this file.
1 /*
2  * MLP decoder
3  * Copyright (c) 2007-2008 Ian Caulfield
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 /**
23  * @file
24  * MLP decoder
25  */
26 
27 #include <stdint.h>
28 
29 #include "avcodec.h"
30 #include "libavutil/internal.h"
31 #include "libavutil/intreadwrite.h"
33 #include "libavutil/mem_internal.h"
34 #include "libavutil/thread.h"
35 #include "get_bits.h"
36 #include "internal.h"
37 #include "libavutil/crc.h"
38 #include "parser.h"
39 #include "mlp_parse.h"
40 #include "mlpdsp.h"
41 #include "mlp.h"
42 #include "config.h"
43 
44 /** number of bits used for VLC lookup - longest Huffman code is 9 */
45 #if ARCH_ARM
46 #define VLC_BITS 5
47 #define VLC_STATIC_SIZE 64
48 #else
49 #define VLC_BITS 9
50 #define VLC_STATIC_SIZE 512
51 #endif
52 
53 typedef struct SubStream {
54  /// Set if a valid restart header has been read. Otherwise the substream cannot be decoded.
56 
57  //@{
58  /** restart header data */
59  /// The type of noise to be used in the rematrix stage.
60  uint16_t noise_type;
61 
62  /// The index of the first channel coded in this substream.
64  /// The index of the last channel coded in this substream.
66  /// The number of channels input into the rematrix stage.
68  /// For each channel output by the matrix, the output channel to map it to
70  /// The channel layout for this substream
71  uint64_t mask;
72  /// The matrix encoding mode for this substream
74 
75  /// Channel coding parameters for channels in the substream
77 
78  /// The left shift applied to random noise in 0x31ea substreams.
80  /// The current seed value for the pseudorandom noise generator(s).
81  uint32_t noisegen_seed;
82 
83  /// Set if the substream contains extra info to check the size of VLC blocks.
85 
86  /// Bitmask of which parameter sets are conveyed in a decoding parameter block.
88 #define PARAM_BLOCKSIZE (1 << 7)
89 #define PARAM_MATRIX (1 << 6)
90 #define PARAM_OUTSHIFT (1 << 5)
91 #define PARAM_QUANTSTEP (1 << 4)
92 #define PARAM_FIR (1 << 3)
93 #define PARAM_IIR (1 << 2)
94 #define PARAM_HUFFOFFSET (1 << 1)
95 #define PARAM_PRESENCE (1 << 0)
96  //@}
97 
98  //@{
99  /** matrix data */
100 
101  /// Number of matrices to be applied.
103 
104  /// matrix output channel
106 
107  /// Whether the LSBs of the matrix output are encoded in the bitstream.
109  /// Matrix coefficients, stored as 2.14 fixed point.
111  /// Left shift to apply to noise values in 0x31eb substreams.
113  //@}
114 
115  /// Left shift to apply to Huffman-decoded residuals.
117 
118  /// number of PCM samples in current audio block
119  uint16_t blocksize;
120  /// Number of PCM samples decoded so far in this frame.
121  uint16_t blockpos;
122 
123  /// Left shift to apply to decoded PCM values to get final 24-bit output.
125 
126  /// Running XOR of all output samples.
128 
129 } SubStream;
130 
131 typedef struct MLPDecodeContext {
133 
134  /// Current access unit being read has a major sync.
136 
137  /// Size of the major sync unit, in bytes
139 
140  /// Set if a valid major sync block has been read. Otherwise no decoding is possible.
142 
143  /// Number of substreams contained within this stream.
145 
146  /// Index of the last substream to decode - further substreams are skipped.
148 
149  /// Stream needs channel reordering to comply with FFmpeg's channel order
151 
152  /// number of PCM samples contained in each frame
154  /// next power of two above the number of samples in each frame
156 
158 
161 
165 
168 
169 static const uint64_t thd_channel_order[] = {
171  AV_CH_FRONT_CENTER, // C
172  AV_CH_LOW_FREQUENCY, // LFE
177  AV_CH_BACK_CENTER, // Cs
178  AV_CH_TOP_CENTER, // Ts
181  AV_CH_TOP_FRONT_CENTER, // Cvh
182  AV_CH_LOW_FREQUENCY_2, // LFE2
183 };
184 
185 static int mlp_channel_layout_subset(uint64_t channel_layout, uint64_t mask)
186 {
187  return channel_layout && ((channel_layout & mask) == channel_layout);
188 }
189 
190 static uint64_t thd_channel_layout_extract_channel(uint64_t channel_layout,
191  int index)
192 {
193  int i;
194 
195  if (av_get_channel_layout_nb_channels(channel_layout) <= index)
196  return 0;
197 
198  for (i = 0; i < FF_ARRAY_ELEMS(thd_channel_order); i++)
199  if (channel_layout & thd_channel_order[i] && !index--)
200  return thd_channel_order[i];
201  return 0;
202 }
203 
204 static VLC huff_vlc[3];
205 
206 /** Initialize static data, constant between all invocations of the codec. */
207 
208 static av_cold void init_static(void)
209 {
210  for (int i = 0; i < 3; i++) {
211  static VLC_TYPE vlc_buf[3 * VLC_STATIC_SIZE][2];
214  init_vlc(&huff_vlc[i], VLC_BITS, 18,
215  &ff_mlp_huffman_tables[i][0][1], 2, 1,
217  }
218 
219  ff_mlp_init_crc();
220 }
221 
223  unsigned int substr, unsigned int ch)
224 {
225  SubStream *s = &m->substream[substr];
226  ChannelParams *cp = &s->channel_params[ch];
227  int lsb_bits = cp->huff_lsbs - s->quant_step_size[ch];
228  int sign_shift = lsb_bits + (cp->codebook ? 2 - cp->codebook : -1);
229  int32_t sign_huff_offset = cp->huff_offset;
230 
231  if (cp->codebook > 0)
232  sign_huff_offset -= 7 << lsb_bits;
233 
234  if (sign_shift >= 0)
235  sign_huff_offset -= 1 << sign_shift;
236 
237  return sign_huff_offset;
238 }
239 
240 /** Read a sample, consisting of either, both or neither of entropy-coded MSBs
241  * and plain LSBs. */
242 
244  unsigned int substr, unsigned int pos)
245 {
246  SubStream *s = &m->substream[substr];
247  unsigned int mat, channel;
248 
249  for (mat = 0; mat < s->num_primitive_matrices; mat++)
250  if (s->lsb_bypass[mat])
251  m->bypassed_lsbs[pos + s->blockpos][mat] = get_bits1(gbp);
252 
253  for (channel = s->min_channel; channel <= s->max_channel; channel++) {
254  ChannelParams *cp = &s->channel_params[channel];
255  int codebook = cp->codebook;
256  int quant_step_size = s->quant_step_size[channel];
257  int lsb_bits = cp->huff_lsbs - quant_step_size;
258  int result = 0;
259 
260  if (codebook > 0)
261  result = get_vlc2(gbp, huff_vlc[codebook-1].table,
262  VLC_BITS, (9 + VLC_BITS - 1) / VLC_BITS);
263 
264  if (result < 0)
265  return AVERROR_INVALIDDATA;
266 
267  if (lsb_bits > 0)
268  result = (result << lsb_bits) + get_bits_long(gbp, lsb_bits);
269 
270  result += cp->sign_huff_offset;
271  result *= 1 << quant_step_size;
272 
273  m->sample_buffer[pos + s->blockpos][channel] = result;
274  }
275 
276  return 0;
277 }
278 
280 {
281  static AVOnce init_static_once = AV_ONCE_INIT;
282  MLPDecodeContext *m = avctx->priv_data;
283  int substr;
284 
285  m->avctx = avctx;
286  for (substr = 0; substr < MAX_SUBSTREAMS; substr++)
287  m->substream[substr].lossless_check_data = 0xffffffff;
288  ff_mlpdsp_init(&m->dsp);
289 
290  ff_thread_once(&init_static_once, init_static);
291 
292  return 0;
293 }
294 
295 /** Read a major sync info header - contains high level information about
296  * the stream - sample rate, channel arrangement etc. Most of this
297  * information is not actually necessary for decoding, only for playback.
298  */
299 
301 {
303  int substr, ret;
304 
305  if ((ret = ff_mlp_read_major_sync(m->avctx, &mh, gb)) != 0)
306  return ret;
307 
308  if (mh.group1_bits == 0) {
309  av_log(m->avctx, AV_LOG_ERROR, "invalid/unknown bits per sample\n");
310  return AVERROR_INVALIDDATA;
311  }
312  if (mh.group2_bits > mh.group1_bits) {
314  "Channel group 2 cannot have more bits per sample than group 1.\n");
315  return AVERROR_INVALIDDATA;
316  }
317 
318  if (mh.group2_samplerate && mh.group2_samplerate != mh.group1_samplerate) {
320  "Channel groups with differing sample rates are not currently supported.\n");
321  return AVERROR_INVALIDDATA;
322  }
323 
324  if (mh.group1_samplerate == 0) {
325  av_log(m->avctx, AV_LOG_ERROR, "invalid/unknown sampling rate\n");
326  return AVERROR_INVALIDDATA;
327  }
328  if (mh.group1_samplerate > MAX_SAMPLERATE) {
330  "Sampling rate %d is greater than the supported maximum (%d).\n",
331  mh.group1_samplerate, MAX_SAMPLERATE);
332  return AVERROR_INVALIDDATA;
333  }
334  if (mh.access_unit_size > MAX_BLOCKSIZE) {
336  "Block size %d is greater than the supported maximum (%d).\n",
337  mh.access_unit_size, MAX_BLOCKSIZE);
338  return AVERROR_INVALIDDATA;
339  }
340  if (mh.access_unit_size_pow2 > MAX_BLOCKSIZE_POW2) {
342  "Block size pow2 %d is greater than the supported maximum (%d).\n",
343  mh.access_unit_size_pow2, MAX_BLOCKSIZE_POW2);
344  return AVERROR_INVALIDDATA;
345  }
346 
347  if (mh.num_substreams == 0)
348  return AVERROR_INVALIDDATA;
349  if (m->avctx->codec_id == AV_CODEC_ID_MLP && mh.num_substreams > 2) {
350  av_log(m->avctx, AV_LOG_ERROR, "MLP only supports up to 2 substreams.\n");
351  return AVERROR_INVALIDDATA;
352  }
353  if (mh.num_substreams > MAX_SUBSTREAMS) {
355  "%d substreams (more than the "
356  "maximum supported by the decoder)",
357  mh.num_substreams);
358  return AVERROR_PATCHWELCOME;
359  }
360 
361  m->major_sync_header_size = mh.header_size;
362 
363  m->access_unit_size = mh.access_unit_size;
364  m->access_unit_size_pow2 = mh.access_unit_size_pow2;
365 
366  m->num_substreams = mh.num_substreams;
367 
368  /* limit to decoding 3 substreams, as the 4th is used by Dolby Atmos for non-audio data */
370 
371  m->avctx->sample_rate = mh.group1_samplerate;
372  m->avctx->frame_size = mh.access_unit_size;
373 
374  m->avctx->bits_per_raw_sample = mh.group1_bits;
375  if (mh.group1_bits > 16)
377  else
383 
384  m->params_valid = 1;
385  for (substr = 0; substr < MAX_SUBSTREAMS; substr++)
386  m->substream[substr].restart_seen = 0;
387 
388  /* Set the layout for each substream. When there's more than one, the first
389  * substream is Stereo. Subsequent substreams' layouts are indicated in the
390  * major sync. */
391  if (m->avctx->codec_id == AV_CODEC_ID_MLP) {
392  if (mh.stream_type != 0xbb) {
394  "unexpected stream_type %X in MLP",
395  mh.stream_type);
396  return AVERROR_PATCHWELCOME;
397  }
398  if ((substr = (mh.num_substreams > 1)))
400  m->substream[substr].mask = mh.channel_layout_mlp;
401  } else {
402  if (mh.stream_type != 0xba) {
404  "unexpected stream_type %X in !MLP",
405  mh.stream_type);
406  return AVERROR_PATCHWELCOME;
407  }
408  if ((substr = (mh.num_substreams > 1)))
410  if (mh.num_substreams > 2)
411  if (mh.channel_layout_thd_stream2)
412  m->substream[2].mask = mh.channel_layout_thd_stream2;
413  else
414  m->substream[2].mask = mh.channel_layout_thd_stream1;
415  m->substream[substr].mask = mh.channel_layout_thd_stream1;
416 
417  if (m->avctx->channels<=2 && m->substream[substr].mask == AV_CH_LAYOUT_MONO && m->max_decoded_substream == 1) {
418  av_log(m->avctx, AV_LOG_DEBUG, "Mono stream with 2 substreams, ignoring 2nd\n");
419  m->max_decoded_substream = 0;
420  if (m->avctx->channels==2)
422  }
423  }
424 
425  m->needs_reordering = mh.channel_arrangement >= 18 && mh.channel_arrangement <= 20;
426 
427  /* Parse the TrueHD decoder channel modifiers and set each substream's
428  * AVMatrixEncoding accordingly.
429  *
430  * The meaning of the modifiers depends on the channel layout:
431  *
432  * - THD_CH_MODIFIER_LTRT, THD_CH_MODIFIER_LBINRBIN only apply to 2-channel
433  *
434  * - THD_CH_MODIFIER_MONO applies to 1-channel or 2-channel (dual mono)
435  *
436  * - THD_CH_MODIFIER_SURROUNDEX, THD_CH_MODIFIER_NOTSURROUNDEX only apply to
437  * layouts with an Ls/Rs channel pair
438  */
439  for (substr = 0; substr < MAX_SUBSTREAMS; substr++)
442  if (mh.num_substreams > 2 &&
443  mh.channel_layout_thd_stream2 & AV_CH_SIDE_LEFT &&
444  mh.channel_layout_thd_stream2 & AV_CH_SIDE_RIGHT &&
445  mh.channel_modifier_thd_stream2 == THD_CH_MODIFIER_SURROUNDEX)
447 
448  if (mh.num_substreams > 1 &&
449  mh.channel_layout_thd_stream1 & AV_CH_SIDE_LEFT &&
450  mh.channel_layout_thd_stream1 & AV_CH_SIDE_RIGHT &&
451  mh.channel_modifier_thd_stream1 == THD_CH_MODIFIER_SURROUNDEX)
453 
454  if (mh.num_substreams > 0)
455  switch (mh.channel_modifier_thd_stream0) {
458  break;
461  break;
462  default:
463  break;
464  }
465  }
466 
467  return 0;
468 }
469 
470 /** Read a restart header from a block in a substream. This contains parameters
471  * required to decode the audio that do not change very often. Generally
472  * (always) present only in blocks following a major sync. */
473 
475  const uint8_t *buf, unsigned int substr)
476 {
477  SubStream *s = &m->substream[substr];
478  unsigned int ch;
479  int sync_word, tmp;
481  uint8_t lossless_check;
482  int start_count = get_bits_count(gbp);
483  int min_channel, max_channel, max_matrix_channel, noise_type;
484  const int std_max_matrix_channel = m->avctx->codec_id == AV_CODEC_ID_MLP
487 
488  sync_word = get_bits(gbp, 13);
489 
490  if (sync_word != 0x31ea >> 1) {
492  "restart header sync incorrect (got 0x%04x)\n", sync_word);
493  return AVERROR_INVALIDDATA;
494  }
495 
496  noise_type = get_bits1(gbp);
497 
498  if (m->avctx->codec_id == AV_CODEC_ID_MLP && noise_type) {
499  av_log(m->avctx, AV_LOG_ERROR, "MLP must have 0x31ea sync word.\n");
500  return AVERROR_INVALIDDATA;
501  }
502 
503  skip_bits(gbp, 16); /* Output timestamp */
504 
505  min_channel = get_bits(gbp, 4);
506  max_channel = get_bits(gbp, 4);
507  max_matrix_channel = get_bits(gbp, 4);
508 
509  if (max_matrix_channel > std_max_matrix_channel) {
511  "Max matrix channel cannot be greater than %d.\n",
512  std_max_matrix_channel);
513  return AVERROR_INVALIDDATA;
514  }
515 
516  if (max_channel != max_matrix_channel) {
518  "Max channel must be equal max matrix channel.\n");
519  return AVERROR_INVALIDDATA;
520  }
521 
522  /* This should happen for TrueHD streams with >6 channels and MLP's noise
523  * type. It is not yet known if this is allowed. */
524  if (max_matrix_channel > MAX_MATRIX_CHANNEL_MLP && !noise_type) {
526  "%d channels (more than the "
527  "maximum supported by the decoder)",
528  max_channel + 2);
529  return AVERROR_PATCHWELCOME;
530  }
531 
532  if (min_channel > max_channel) {
534  "Substream min channel cannot be greater than max channel.\n");
535  return AVERROR_INVALIDDATA;
536  }
537 
538  if (max_channel + 1 > MAX_CHANNELS || max_channel + 1 < min_channel)
539  return AVERROR_INVALIDDATA;
540 
541 
542  s->min_channel = min_channel;
543  s->max_channel = max_channel;
544  s->max_matrix_channel = max_matrix_channel;
545  s->noise_type = noise_type;
546 
548  m->max_decoded_substream > substr) {
550  "Extracting %d-channel downmix (0x%"PRIx64") from substream %d. "
551  "Further substreams will be skipped.\n",
552  s->max_channel + 1, s->mask, substr);
553  m->max_decoded_substream = substr;
554  }
555 
556  s->noise_shift = get_bits(gbp, 4);
557  s->noisegen_seed = get_bits(gbp, 23);
558 
559  skip_bits(gbp, 19);
560 
561  s->data_check_present = get_bits1(gbp);
562  lossless_check = get_bits(gbp, 8);
563  if (substr == m->max_decoded_substream
564  && s->lossless_check_data != 0xffffffff) {
565  tmp = xor_32_to_8(s->lossless_check_data);
566  if (tmp != lossless_check)
568  "Lossless check failed - expected %02x, calculated %02x.\n",
569  lossless_check, tmp);
570  }
571 
572  skip_bits(gbp, 16);
573 
574  memset(s->ch_assign, 0, sizeof(s->ch_assign));
575 
576  for (ch = 0; ch <= s->max_matrix_channel; ch++) {
577  int ch_assign = get_bits(gbp, 6);
578  if (m->avctx->codec_id == AV_CODEC_ID_TRUEHD) {
580  ch_assign);
581  ch_assign = av_get_channel_layout_channel_index(s->mask,
582  channel);
583  }
584  if (ch_assign < 0 || ch_assign > s->max_matrix_channel) {
586  "Assignment of matrix channel %d to invalid output channel %d",
587  ch, ch_assign);
588  return AVERROR_PATCHWELCOME;
589  }
590  s->ch_assign[ch_assign] = ch;
591  }
592 
593  checksum = ff_mlp_restart_checksum(buf, get_bits_count(gbp) - start_count);
594 
595  if (checksum != get_bits(gbp, 8))
596  av_log(m->avctx, AV_LOG_ERROR, "restart header checksum error\n");
597 
598  /* Set default decoding parameters. */
599  s->param_presence_flags = 0xff;
600  s->num_primitive_matrices = 0;
601  s->blocksize = 8;
602  s->lossless_check_data = 0;
603 
604  memset(s->output_shift , 0, sizeof(s->output_shift ));
605  memset(s->quant_step_size, 0, sizeof(s->quant_step_size));
606 
607  for (ch = s->min_channel; ch <= s->max_channel; ch++) {
608  ChannelParams *cp = &s->channel_params[ch];
609  cp->filter_params[FIR].order = 0;
610  cp->filter_params[IIR].order = 0;
611  cp->filter_params[FIR].shift = 0;
612  cp->filter_params[IIR].shift = 0;
613 
614  /* Default audio coding is 24-bit raw PCM. */
615  cp->huff_offset = 0;
616  cp->sign_huff_offset = -(1 << 23);
617  cp->codebook = 0;
618  cp->huff_lsbs = 24;
619  }
620 
621  if (substr == m->max_decoded_substream) {
622  m->avctx->channels = s->max_matrix_channel + 1;
623  m->avctx->channel_layout = s->mask;
624  m->dsp.mlp_pack_output = m->dsp.mlp_select_pack_output(s->ch_assign,
625  s->output_shift,
626  s->max_matrix_channel,
628 
629  if (m->avctx->codec_id == AV_CODEC_ID_MLP && m->needs_reordering) {
632  int i = s->ch_assign[4];
633  s->ch_assign[4] = s->ch_assign[3];
634  s->ch_assign[3] = s->ch_assign[2];
635  s->ch_assign[2] = i;
636  } else if (m->avctx->channel_layout == AV_CH_LAYOUT_5POINT1_BACK) {
637  FFSWAP(int, s->ch_assign[2], s->ch_assign[4]);
638  FFSWAP(int, s->ch_assign[3], s->ch_assign[5]);
639  }
640  }
641 
642  }
643 
644  return 0;
645 }
646 
647 /** Read parameters for one of the prediction filters. */
648 
650  unsigned int substr, unsigned int channel,
651  unsigned int filter)
652 {
653  SubStream *s = &m->substream[substr];
654  FilterParams *fp = &s->channel_params[channel].filter_params[filter];
655  const int max_order = filter ? MAX_IIR_ORDER : MAX_FIR_ORDER;
656  const char fchar = filter ? 'I' : 'F';
657  int i, order;
658 
659  // Filter is 0 for FIR, 1 for IIR.
660  av_assert0(filter < 2);
661 
662  if (m->filter_changed[channel][filter]++ > 1) {
663  av_log(m->avctx, AV_LOG_ERROR, "Filters may change only once per access unit.\n");
664  return AVERROR_INVALIDDATA;
665  }
666 
667  order = get_bits(gbp, 4);
668  if (order > max_order) {
670  "%cIR filter order %d is greater than maximum %d.\n",
671  fchar, order, max_order);
672  return AVERROR_INVALIDDATA;
673  }
674  fp->order = order;
675 
676  if (order > 0) {
677  int32_t *fcoeff = s->channel_params[channel].coeff[filter];
678  int coeff_bits, coeff_shift;
679 
680  fp->shift = get_bits(gbp, 4);
681 
682  coeff_bits = get_bits(gbp, 5);
683  coeff_shift = get_bits(gbp, 3);
684  if (coeff_bits < 1 || coeff_bits > 16) {
686  "%cIR filter coeff_bits must be between 1 and 16.\n",
687  fchar);
688  return AVERROR_INVALIDDATA;
689  }
690  if (coeff_bits + coeff_shift > 16) {
692  "Sum of coeff_bits and coeff_shift for %cIR filter must be 16 or less.\n",
693  fchar);
694  return AVERROR_INVALIDDATA;
695  }
696 
697  for (i = 0; i < order; i++)
698  fcoeff[i] = get_sbits(gbp, coeff_bits) * (1 << coeff_shift);
699 
700  if (get_bits1(gbp)) {
701  int state_bits, state_shift;
702 
703  if (filter == FIR) {
705  "FIR filter has state data specified.\n");
706  return AVERROR_INVALIDDATA;
707  }
708 
709  state_bits = get_bits(gbp, 4);
710  state_shift = get_bits(gbp, 4);
711 
712  /* TODO: Check validity of state data. */
713 
714  for (i = 0; i < order; i++)
715  fp->state[i] = state_bits ? get_sbits(gbp, state_bits) * (1 << state_shift) : 0;
716  }
717  }
718 
719  return 0;
720 }
721 
722 /** Read parameters for primitive matrices. */
723 
724 static int read_matrix_params(MLPDecodeContext *m, unsigned int substr, GetBitContext *gbp)
725 {
726  SubStream *s = &m->substream[substr];
727  unsigned int mat, ch;
728  const int max_primitive_matrices = m->avctx->codec_id == AV_CODEC_ID_MLP
731 
732  if (m->matrix_changed++ > 1) {
733  av_log(m->avctx, AV_LOG_ERROR, "Matrices may change only once per access unit.\n");
734  return AVERROR_INVALIDDATA;
735  }
736 
737  s->num_primitive_matrices = get_bits(gbp, 4);
738 
739  if (s->num_primitive_matrices > max_primitive_matrices) {
741  "Number of primitive matrices cannot be greater than %d.\n",
742  max_primitive_matrices);
743  goto error;
744  }
745 
746  for (mat = 0; mat < s->num_primitive_matrices; mat++) {
747  int frac_bits, max_chan;
748  s->matrix_out_ch[mat] = get_bits(gbp, 4);
749  frac_bits = get_bits(gbp, 4);
750  s->lsb_bypass [mat] = get_bits1(gbp);
751 
752  if (s->matrix_out_ch[mat] > s->max_matrix_channel) {
754  "Invalid channel %d specified as output from matrix.\n",
755  s->matrix_out_ch[mat]);
756  goto error;
757  }
758  if (frac_bits > 14) {
760  "Too many fractional bits specified.\n");
761  goto error;
762  }
763 
764  max_chan = s->max_matrix_channel;
765  if (!s->noise_type)
766  max_chan+=2;
767 
768  for (ch = 0; ch <= max_chan; ch++) {
769  int coeff_val = 0;
770  if (get_bits1(gbp))
771  coeff_val = get_sbits(gbp, frac_bits + 2);
772 
773  s->matrix_coeff[mat][ch] = coeff_val * (1 << (14 - frac_bits));
774  }
775 
776  if (s->noise_type)
777  s->matrix_noise_shift[mat] = get_bits(gbp, 4);
778  else
779  s->matrix_noise_shift[mat] = 0;
780  }
781 
782  return 0;
783 error:
784  s->num_primitive_matrices = 0;
785  memset(s->matrix_out_ch, 0, sizeof(s->matrix_out_ch));
786 
787  return AVERROR_INVALIDDATA;
788 }
789 
790 /** Read channel parameters. */
791 
792 static int read_channel_params(MLPDecodeContext *m, unsigned int substr,
793  GetBitContext *gbp, unsigned int ch)
794 {
795  SubStream *s = &m->substream[substr];
796  ChannelParams *cp = &s->channel_params[ch];
797  FilterParams *fir = &cp->filter_params[FIR];
798  FilterParams *iir = &cp->filter_params[IIR];
799  int ret;
800 
801  if (s->param_presence_flags & PARAM_FIR)
802  if (get_bits1(gbp))
803  if ((ret = read_filter_params(m, gbp, substr, ch, FIR)) < 0)
804  return ret;
805 
806  if (s->param_presence_flags & PARAM_IIR)
807  if (get_bits1(gbp))
808  if ((ret = read_filter_params(m, gbp, substr, ch, IIR)) < 0)
809  return ret;
810 
811  if (fir->order + iir->order > 8) {
812  av_log(m->avctx, AV_LOG_ERROR, "Total filter orders too high.\n");
813  return AVERROR_INVALIDDATA;
814  }
815 
816  if (fir->order && iir->order &&
817  fir->shift != iir->shift) {
819  "FIR and IIR filters must use the same precision.\n");
820  return AVERROR_INVALIDDATA;
821  }
822  /* The FIR and IIR filters must have the same precision.
823  * To simplify the filtering code, only the precision of the
824  * FIR filter is considered. If only the IIR filter is employed,
825  * the FIR filter precision is set to that of the IIR filter, so
826  * that the filtering code can use it. */
827  if (!fir->order && iir->order)
828  fir->shift = iir->shift;
829 
830  if (s->param_presence_flags & PARAM_HUFFOFFSET)
831  if (get_bits1(gbp))
832  cp->huff_offset = get_sbits(gbp, 15);
833 
834  cp->codebook = get_bits(gbp, 2);
835  cp->huff_lsbs = get_bits(gbp, 5);
836 
837  if (cp->codebook > 0 && cp->huff_lsbs > 24) {
838  av_log(m->avctx, AV_LOG_ERROR, "Invalid huff_lsbs.\n");
839  cp->huff_lsbs = 0;
840  return AVERROR_INVALIDDATA;
841  }
842 
843  return 0;
844 }
845 
846 /** Read decoding parameters that change more often than those in the restart
847  * header. */
848 
850  unsigned int substr)
851 {
852  SubStream *s = &m->substream[substr];
853  unsigned int ch;
854  int ret = 0;
855  unsigned recompute_sho = 0;
856 
857  if (s->param_presence_flags & PARAM_PRESENCE)
858  if (get_bits1(gbp))
859  s->param_presence_flags = get_bits(gbp, 8);
860 
861  if (s->param_presence_flags & PARAM_BLOCKSIZE)
862  if (get_bits1(gbp)) {
863  s->blocksize = get_bits(gbp, 9);
864  if (s->blocksize < 8 || s->blocksize > m->access_unit_size) {
865  av_log(m->avctx, AV_LOG_ERROR, "Invalid blocksize.\n");
866  s->blocksize = 0;
867  return AVERROR_INVALIDDATA;
868  }
869  }
870 
871  if (s->param_presence_flags & PARAM_MATRIX)
872  if (get_bits1(gbp))
873  if ((ret = read_matrix_params(m, substr, gbp)) < 0)
874  return ret;
875 
876  if (s->param_presence_flags & PARAM_OUTSHIFT)
877  if (get_bits1(gbp)) {
878  for (ch = 0; ch <= s->max_matrix_channel; ch++) {
879  s->output_shift[ch] = get_sbits(gbp, 4);
880  if (s->output_shift[ch] < 0) {
881  avpriv_request_sample(m->avctx, "Negative output_shift");
882  s->output_shift[ch] = 0;
883  }
884  }
885  if (substr == m->max_decoded_substream)
886  m->dsp.mlp_pack_output = m->dsp.mlp_select_pack_output(s->ch_assign,
887  s->output_shift,
888  s->max_matrix_channel,
890  }
891 
892  if (s->param_presence_flags & PARAM_QUANTSTEP)
893  if (get_bits1(gbp))
894  for (ch = 0; ch <= s->max_channel; ch++) {
895  s->quant_step_size[ch] = get_bits(gbp, 4);
896 
897  recompute_sho |= 1<<ch;
898  }
899 
900  for (ch = s->min_channel; ch <= s->max_channel; ch++)
901  if (get_bits1(gbp)) {
902  recompute_sho |= 1<<ch;
903  if ((ret = read_channel_params(m, substr, gbp, ch)) < 0)
904  goto fail;
905  }
906 
907 
908 fail:
909  for (ch = 0; ch <= s->max_channel; ch++) {
910  if (recompute_sho & (1<<ch)) {
911  ChannelParams *cp = &s->channel_params[ch];
912 
913  if (cp->codebook > 0 && cp->huff_lsbs < s->quant_step_size[ch]) {
914  if (ret >= 0) {
915  av_log(m->avctx, AV_LOG_ERROR, "quant_step_size larger than huff_lsbs\n");
916  ret = AVERROR_INVALIDDATA;
917  }
918  s->quant_step_size[ch] = 0;
919  }
920 
921  cp->sign_huff_offset = calculate_sign_huff(m, substr, ch);
922  }
923  }
924  return ret;
925 }
926 
927 #define MSB_MASK(bits) (-1u << (bits))
928 
929 /** Generate PCM samples using the prediction filters and residual values
930  * read from the data stream, and update the filter state. */
931 
932 static void filter_channel(MLPDecodeContext *m, unsigned int substr,
933  unsigned int channel)
934 {
935  SubStream *s = &m->substream[substr];
936  const int32_t *fircoeff = s->channel_params[channel].coeff[FIR];
938  int32_t *firbuf = state_buffer[FIR] + MAX_BLOCKSIZE;
939  int32_t *iirbuf = state_buffer[IIR] + MAX_BLOCKSIZE;
940  FilterParams *fir = &s->channel_params[channel].filter_params[FIR];
941  FilterParams *iir = &s->channel_params[channel].filter_params[IIR];
942  unsigned int filter_shift = fir->shift;
943  int32_t mask = MSB_MASK(s->quant_step_size[channel]);
944 
945  memcpy(firbuf, fir->state, MAX_FIR_ORDER * sizeof(int32_t));
946  memcpy(iirbuf, iir->state, MAX_IIR_ORDER * sizeof(int32_t));
947 
948  m->dsp.mlp_filter_channel(firbuf, fircoeff,
949  fir->order, iir->order,
950  filter_shift, mask, s->blocksize,
951  &m->sample_buffer[s->blockpos][channel]);
952 
953  memcpy(fir->state, firbuf - s->blocksize, MAX_FIR_ORDER * sizeof(int32_t));
954  memcpy(iir->state, iirbuf - s->blocksize, MAX_IIR_ORDER * sizeof(int32_t));
955 }
956 
957 /** Read a block of PCM residual data (or actual if no filtering active). */
958 
960  unsigned int substr)
961 {
962  SubStream *s = &m->substream[substr];
963  unsigned int i, ch, expected_stream_pos = 0;
964  int ret;
965 
966  if (s->data_check_present) {
967  expected_stream_pos = get_bits_count(gbp);
968  expected_stream_pos += get_bits(gbp, 16);
970  "Substreams with VLC block size check info");
971  }
972 
973  if (s->blockpos + s->blocksize > m->access_unit_size) {
974  av_log(m->avctx, AV_LOG_ERROR, "too many audio samples in frame\n");
975  return AVERROR_INVALIDDATA;
976  }
977 
978  memset(&m->bypassed_lsbs[s->blockpos][0], 0,
979  s->blocksize * sizeof(m->bypassed_lsbs[0]));
980 
981  for (i = 0; i < s->blocksize; i++)
982  if ((ret = read_huff_channels(m, gbp, substr, i)) < 0)
983  return ret;
984 
985  for (ch = s->min_channel; ch <= s->max_channel; ch++)
986  filter_channel(m, substr, ch);
987 
988  s->blockpos += s->blocksize;
989 
990  if (s->data_check_present) {
991  if (get_bits_count(gbp) != expected_stream_pos)
992  av_log(m->avctx, AV_LOG_ERROR, "block data length mismatch\n");
993  skip_bits(gbp, 8);
994  }
995 
996  return 0;
997 }
998 
999 /** Data table used for TrueHD noise generation function. */
1000 
1001 static const int8_t noise_table[256] = {
1002  30, 51, 22, 54, 3, 7, -4, 38, 14, 55, 46, 81, 22, 58, -3, 2,
1003  52, 31, -7, 51, 15, 44, 74, 30, 85, -17, 10, 33, 18, 80, 28, 62,
1004  10, 32, 23, 69, 72, 26, 35, 17, 73, 60, 8, 56, 2, 6, -2, -5,
1005  51, 4, 11, 50, 66, 76, 21, 44, 33, 47, 1, 26, 64, 48, 57, 40,
1006  38, 16, -10, -28, 92, 22, -18, 29, -10, 5, -13, 49, 19, 24, 70, 34,
1007  61, 48, 30, 14, -6, 25, 58, 33, 42, 60, 67, 17, 54, 17, 22, 30,
1008  67, 44, -9, 50, -11, 43, 40, 32, 59, 82, 13, 49, -14, 55, 60, 36,
1009  48, 49, 31, 47, 15, 12, 4, 65, 1, 23, 29, 39, 45, -2, 84, 69,
1010  0, 72, 37, 57, 27, 41, -15, -16, 35, 31, 14, 61, 24, 0, 27, 24,
1011  16, 41, 55, 34, 53, 9, 56, 12, 25, 29, 53, 5, 20, -20, -8, 20,
1012  13, 28, -3, 78, 38, 16, 11, 62, 46, 29, 21, 24, 46, 65, 43, -23,
1013  89, 18, 74, 21, 38, -12, 19, 12, -19, 8, 15, 33, 4, 57, 9, -8,
1014  36, 35, 26, 28, 7, 83, 63, 79, 75, 11, 3, 87, 37, 47, 34, 40,
1015  39, 19, 20, 42, 27, 34, 39, 77, 13, 42, 59, 64, 45, -1, 32, 37,
1016  45, -5, 53, -6, 7, 36, 50, 23, 6, 32, 9, -21, 18, 71, 27, 52,
1017  -25, 31, 35, 42, -1, 68, 63, 52, 26, 43, 66, 37, 41, 25, 40, 70,
1018 };
1019 
1020 /** Noise generation functions.
1021  * I'm not sure what these are for - they seem to be some kind of pseudorandom
1022  * sequence generators, used to generate noise data which is used when the
1023  * channels are rematrixed. I'm not sure if they provide a practical benefit
1024  * to compression, or just obfuscate the decoder. Are they for some kind of
1025  * dithering? */
1026 
1027 /** Generate two channels of noise, used in the matrix when
1028  * restart sync word == 0x31ea. */
1029 
1030 static void generate_2_noise_channels(MLPDecodeContext *m, unsigned int substr)
1031 {
1032  SubStream *s = &m->substream[substr];
1033  unsigned int i;
1034  uint32_t seed = s->noisegen_seed;
1035  unsigned int maxchan = s->max_matrix_channel;
1036 
1037  for (i = 0; i < s->blockpos; i++) {
1038  uint16_t seed_shr7 = seed >> 7;
1039  m->sample_buffer[i][maxchan+1] = ((int8_t)(seed >> 15)) * (1 << s->noise_shift);
1040  m->sample_buffer[i][maxchan+2] = ((int8_t) seed_shr7) * (1 << s->noise_shift);
1041 
1042  seed = (seed << 16) ^ seed_shr7 ^ (seed_shr7 << 5);
1043  }
1044 
1045  s->noisegen_seed = seed;
1046 }
1047 
1048 /** Generate a block of noise, used when restart sync word == 0x31eb. */
1049 
1050 static void fill_noise_buffer(MLPDecodeContext *m, unsigned int substr)
1051 {
1052  SubStream *s = &m->substream[substr];
1053  unsigned int i;
1054  uint32_t seed = s->noisegen_seed;
1055 
1056  for (i = 0; i < m->access_unit_size_pow2; i++) {
1057  uint8_t seed_shr15 = seed >> 15;
1058  m->noise_buffer[i] = noise_table[seed_shr15];
1059  seed = (seed << 8) ^ seed_shr15 ^ (seed_shr15 << 5);
1060  }
1061 
1062  s->noisegen_seed = seed;
1063 }
1064 
1065 /** Write the audio data into the output buffer. */
1066 
1067 static int output_data(MLPDecodeContext *m, unsigned int substr,
1068  AVFrame *frame, int *got_frame_ptr)
1069 {
1070  AVCodecContext *avctx = m->avctx;
1071  SubStream *s = &m->substream[substr];
1072  unsigned int mat;
1073  unsigned int maxchan;
1074  int ret;
1075  int is32 = (m->avctx->sample_fmt == AV_SAMPLE_FMT_S32);
1076 
1077  if (m->avctx->channels != s->max_matrix_channel + 1) {
1078  av_log(m->avctx, AV_LOG_ERROR, "channel count mismatch\n");
1079  return AVERROR_INVALIDDATA;
1080  }
1081 
1082  if (!s->blockpos) {
1083  av_log(avctx, AV_LOG_ERROR, "No samples to output.\n");
1084  return AVERROR_INVALIDDATA;
1085  }
1086 
1087  maxchan = s->max_matrix_channel;
1088  if (!s->noise_type) {
1089  generate_2_noise_channels(m, substr);
1090  maxchan += 2;
1091  } else {
1092  fill_noise_buffer(m, substr);
1093  }
1094 
1095  /* Apply the channel matrices in turn to reconstruct the original audio
1096  * samples. */
1097  for (mat = 0; mat < s->num_primitive_matrices; mat++) {
1098  unsigned int dest_ch = s->matrix_out_ch[mat];
1099  m->dsp.mlp_rematrix_channel(&m->sample_buffer[0][0],
1100  s->matrix_coeff[mat],
1101  &m->bypassed_lsbs[0][mat],
1102  m->noise_buffer,
1103  s->num_primitive_matrices - mat,
1104  dest_ch,
1105  s->blockpos,
1106  maxchan,
1107  s->matrix_noise_shift[mat],
1109  MSB_MASK(s->quant_step_size[dest_ch]));
1110  }
1111 
1112  /* get output buffer */
1113  frame->nb_samples = s->blockpos;
1114  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
1115  return ret;
1116  s->lossless_check_data = m->dsp.mlp_pack_output(s->lossless_check_data,
1117  s->blockpos,
1118  m->sample_buffer,
1119  frame->data[0],
1120  s->ch_assign,
1121  s->output_shift,
1122  s->max_matrix_channel,
1123  is32);
1124 
1125  /* Update matrix encoding side data */
1126  if ((ret = ff_side_data_update_matrix_encoding(frame, s->matrix_encoding)) < 0)
1127  return ret;
1128 
1129  *got_frame_ptr = 1;
1130 
1131  return 0;
1132 }
1133 
1134 /** Read an access unit from the stream.
1135  * @return negative on error, 0 if not enough data is present in the input stream,
1136  * otherwise the number of bytes consumed. */
1137 
1138 static int read_access_unit(AVCodecContext *avctx, void* data,
1139  int *got_frame_ptr, AVPacket *avpkt)
1140 {
1141  const uint8_t *buf = avpkt->data;
1142  int buf_size = avpkt->size;
1143  MLPDecodeContext *m = avctx->priv_data;
1144  GetBitContext gb;
1145  unsigned int length, substr;
1146  unsigned int substream_start;
1147  unsigned int header_size = 4;
1148  unsigned int substr_header_size = 0;
1149  uint8_t substream_parity_present[MAX_SUBSTREAMS];
1150  uint16_t substream_data_len[MAX_SUBSTREAMS];
1151  uint8_t parity_bits;
1152  int ret;
1153 
1154  if (buf_size < 4)
1155  return AVERROR_INVALIDDATA;
1156 
1157  length = (AV_RB16(buf) & 0xfff) * 2;
1158 
1159  if (length < 4 || length > buf_size)
1160  return AVERROR_INVALIDDATA;
1161 
1162  init_get_bits(&gb, (buf + 4), (length - 4) * 8);
1163 
1164  m->is_major_sync_unit = 0;
1165  if (show_bits_long(&gb, 31) == (0xf8726fba >> 1)) {
1166  if (read_major_sync(m, &gb) < 0)
1167  goto error;
1168  m->is_major_sync_unit = 1;
1169  header_size += m->major_sync_header_size;
1170  }
1171 
1172  if (!m->params_valid) {
1174  "Stream parameters not seen; skipping frame.\n");
1175  *got_frame_ptr = 0;
1176  return length;
1177  }
1178 
1179  substream_start = 0;
1180 
1181  for (substr = 0; substr < m->num_substreams; substr++) {
1182  int extraword_present, checkdata_present, end, nonrestart_substr;
1183 
1184  extraword_present = get_bits1(&gb);
1185  nonrestart_substr = get_bits1(&gb);
1186  checkdata_present = get_bits1(&gb);
1187  skip_bits1(&gb);
1188 
1189  end = get_bits(&gb, 12) * 2;
1190 
1191  substr_header_size += 2;
1192 
1193  if (extraword_present) {
1194  if (m->avctx->codec_id == AV_CODEC_ID_MLP) {
1195  av_log(m->avctx, AV_LOG_ERROR, "There must be no extraword for MLP.\n");
1196  goto error;
1197  }
1198  skip_bits(&gb, 16);
1199  substr_header_size += 2;
1200  }
1201 
1202  if (length < header_size + substr_header_size) {
1203  av_log(m->avctx, AV_LOG_ERROR, "Insufficient data for headers\n");
1204  goto error;
1205  }
1206 
1207  if (!(nonrestart_substr ^ m->is_major_sync_unit)) {
1208  av_log(m->avctx, AV_LOG_ERROR, "Invalid nonrestart_substr.\n");
1209  goto error;
1210  }
1211 
1212  if (end + header_size + substr_header_size > length) {
1214  "Indicated length of substream %d data goes off end of "
1215  "packet.\n", substr);
1216  end = length - header_size - substr_header_size;
1217  }
1218 
1219  if (end < substream_start) {
1220  av_log(avctx, AV_LOG_ERROR,
1221  "Indicated end offset of substream %d data "
1222  "is smaller than calculated start offset.\n",
1223  substr);
1224  goto error;
1225  }
1226 
1227  if (substr > m->max_decoded_substream)
1228  continue;
1229 
1230  substream_parity_present[substr] = checkdata_present;
1231  substream_data_len[substr] = end - substream_start;
1232  substream_start = end;
1233  }
1234 
1235  parity_bits = ff_mlp_calculate_parity(buf, 4);
1236  parity_bits ^= ff_mlp_calculate_parity(buf + header_size, substr_header_size);
1237 
1238  if ((((parity_bits >> 4) ^ parity_bits) & 0xF) != 0xF) {
1239  av_log(avctx, AV_LOG_ERROR, "Parity check failed.\n");
1240  goto error;
1241  }
1242 
1243  buf += header_size + substr_header_size;
1244 
1245  for (substr = 0; substr <= m->max_decoded_substream; substr++) {
1246  SubStream *s = &m->substream[substr];
1247  init_get_bits(&gb, buf, substream_data_len[substr] * 8);
1248 
1249  m->matrix_changed = 0;
1250  memset(m->filter_changed, 0, sizeof(m->filter_changed));
1251 
1252  s->blockpos = 0;
1253  do {
1254  if (get_bits1(&gb)) {
1255  if (get_bits1(&gb)) {
1256  /* A restart header should be present. */
1257  if (read_restart_header(m, &gb, buf, substr) < 0)
1258  goto next_substr;
1259  s->restart_seen = 1;
1260  }
1261 
1262  if (!s->restart_seen)
1263  goto next_substr;
1264  if (read_decoding_params(m, &gb, substr) < 0)
1265  goto next_substr;
1266  }
1267 
1268  if (!s->restart_seen)
1269  goto next_substr;
1270 
1271  if ((ret = read_block_data(m, &gb, substr)) < 0)
1272  return ret;
1273 
1274  if (get_bits_count(&gb) >= substream_data_len[substr] * 8)
1275  goto substream_length_mismatch;
1276 
1277  } while (!get_bits1(&gb));
1278 
1279  skip_bits(&gb, (-get_bits_count(&gb)) & 15);
1280 
1281  if (substream_data_len[substr] * 8 - get_bits_count(&gb) >= 32) {
1282  int shorten_by;
1283 
1284  if (get_bits(&gb, 16) != 0xD234)
1285  return AVERROR_INVALIDDATA;
1286 
1287  shorten_by = get_bits(&gb, 16);
1288  if (m->avctx->codec_id == AV_CODEC_ID_TRUEHD && shorten_by & 0x2000)
1289  s->blockpos -= FFMIN(shorten_by & 0x1FFF, s->blockpos);
1290  else if (m->avctx->codec_id == AV_CODEC_ID_MLP && shorten_by != 0xD234)
1291  return AVERROR_INVALIDDATA;
1292 
1293  if (substr == m->max_decoded_substream)
1294  av_log(m->avctx, AV_LOG_INFO, "End of stream indicated.\n");
1295  }
1296 
1297  if (substream_parity_present[substr]) {
1299 
1300  if (substream_data_len[substr] * 8 - get_bits_count(&gb) != 16)
1301  goto substream_length_mismatch;
1302 
1303  parity = ff_mlp_calculate_parity(buf, substream_data_len[substr] - 2);
1304  checksum = ff_mlp_checksum8 (buf, substream_data_len[substr] - 2);
1305 
1306  if ((get_bits(&gb, 8) ^ parity) != 0xa9 )
1307  av_log(m->avctx, AV_LOG_ERROR, "Substream %d parity check failed.\n", substr);
1308  if ( get_bits(&gb, 8) != checksum)
1309  av_log(m->avctx, AV_LOG_ERROR, "Substream %d checksum failed.\n" , substr);
1310  }
1311 
1312  if (substream_data_len[substr] * 8 != get_bits_count(&gb))
1313  goto substream_length_mismatch;
1314 
1315 next_substr:
1316  if (!s->restart_seen)
1318  "No restart header present in substream %d.\n", substr);
1319 
1320  buf += substream_data_len[substr];
1321  }
1322 
1323  if ((ret = output_data(m, m->max_decoded_substream, data, got_frame_ptr)) < 0)
1324  return ret;
1325 
1326  return length;
1327 
1328 substream_length_mismatch:
1329  av_log(m->avctx, AV_LOG_ERROR, "substream %d length mismatch\n", substr);
1330  return AVERROR_INVALIDDATA;
1331 
1332 error:
1333  m->params_valid = 0;
1334  return AVERROR_INVALIDDATA;
1335 }
1336 
1337 #if CONFIG_MLP_DECODER
1339  .name = "mlp",
1340  .long_name = NULL_IF_CONFIG_SMALL("MLP (Meridian Lossless Packing)"),
1341  .type = AVMEDIA_TYPE_AUDIO,
1342  .id = AV_CODEC_ID_MLP,
1343  .priv_data_size = sizeof(MLPDecodeContext),
1344  .init = mlp_decode_init,
1346  .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_CHANNEL_CONF,
1347  .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,
1348 };
1349 #endif
1350 #if CONFIG_TRUEHD_DECODER
1352  .name = "truehd",
1353  .long_name = NULL_IF_CONFIG_SMALL("TrueHD"),
1354  .type = AVMEDIA_TYPE_AUDIO,
1355  .id = AV_CODEC_ID_TRUEHD,
1356  .priv_data_size = sizeof(MLPDecodeContext),
1357  .init = mlp_decode_init,
1359  .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_CHANNEL_CONF,
1360  .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,
1361 };
1362 #endif /* CONFIG_TRUEHD_DECODER */
#define MAX_CHANNELS
Definition: aac.h:48
AVCodec ff_truehd_decoder
AVCodec ff_mlp_decoder
#define av_cold
Definition: attributes.h:88
uint8_t
int32_t
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
Libavcodec external API header.
#define AV_RB16
Definition: intreadwrite.h:53
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:31
#define s(width, name)
Definition: cbs_vp9.c:257
static av_always_inline void filter(int16_t *output, ptrdiff_t out_stride, const int16_t *low, ptrdiff_t low_stride, const int16_t *high, ptrdiff_t high_stride, int len, int clip)
Definition: cfhddsp.c:27
static const unsigned codebook[256][2]
Definition: cfhdenc.c:42
audio channel layout utility functions
#define fail()
Definition: checkasm.h:133
static VLC_TYPE vlc_buf[16716][2]
Definition: clearvideo.c:86
#define FFSWAP(type, a, b)
Definition: common.h:108
#define FFMIN(a, b)
Definition: common.h:105
Public header for CRC hash function implementation.
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1900
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:71
static AVFrame * frame
channel
Use these values when setting the channel map with ebur128_set_channel().
Definition: ebur128.h:39
bitstream reader API header.
static unsigned int show_bits_long(GetBitContext *s, int n)
Show 0-32 bits.
Definition: get_bits.h:602
static unsigned int get_bits_long(GetBitContext *s, int n)
Read 0-32 bits.
Definition: get_bits.h:546
static int get_sbits(GetBitContext *s, int n)
Definition: get_bits.h:359
static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE(*table)[2], int bits, int max_depth)
Parse a vlc code.
Definition: get_bits.h:797
static unsigned int get_bits1(GetBitContext *s)
Definition: get_bits.h:498
static void skip_bits(GetBitContext *s, int n)
Definition: get_bits.h:467
static int get_bits_count(const GetBitContext *s)
Definition: get_bits.h:219
static void skip_bits1(GetBitContext *s)
Definition: get_bits.h:538
static unsigned int get_bits(GetBitContext *s, int n)
Read 1-25 bits.
Definition: get_bits.h:379
static int init_get_bits(GetBitContext *s, const uint8_t *buffer, int bit_size)
Initialize GetBitContext.
Definition: get_bits.h:659
int av_get_channel_layout_channel_index(uint64_t channel_layout, uint64_t channel)
Get the index of a channel in channel_layout.
#define AV_CH_LAYOUT_QUAD
#define AV_CH_LAYOUT_MONO
#define AV_CH_LAYOUT_5POINT0_BACK
#define AV_CH_LAYOUT_STEREO
AVMatrixEncoding
int av_get_channel_layout_nb_channels(uint64_t channel_layout)
Return the number of channels in the channel layout.
#define AV_CH_LAYOUT_5POINT1_BACK
@ AV_MATRIX_ENCODING_NONE
@ AV_MATRIX_ENCODING_DOLBY
@ AV_MATRIX_ENCODING_DOLBYEX
@ AV_MATRIX_ENCODING_DOLBYHEADPHONE
#define AV_CH_SIDE_LEFT
#define AV_CH_SURROUND_DIRECT_RIGHT
#define AV_CH_WIDE_LEFT
#define AV_CH_WIDE_RIGHT
#define AV_CH_TOP_FRONT_LEFT
#define AV_CH_FRONT_RIGHT
#define AV_CH_FRONT_RIGHT_OF_CENTER
#define AV_CH_BACK_CENTER
#define AV_CH_TOP_FRONT_CENTER
#define AV_CH_FRONT_LEFT_OF_CENTER
#define AV_CH_LOW_FREQUENCY_2
#define AV_CH_BACK_RIGHT
#define AV_CH_FRONT_CENTER
#define AV_CH_TOP_CENTER
#define AV_CH_SIDE_RIGHT
#define AV_CH_BACK_LEFT
#define AV_CH_LOW_FREQUENCY
#define AV_CH_TOP_FRONT_RIGHT
#define AV_CH_FRONT_LEFT
#define AV_CH_SURROUND_DIRECT_LEFT
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
#define AV_CODEC_CAP_CHANNEL_CONF
Codec should fill in channel configuration and samplerate instead of container.
Definition: codec.h:104
@ AV_CODEC_ID_TRUEHD
Definition: codec_id.h:468
@ AV_CODEC_ID_MLP
Definition: codec_id.h:453
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:62
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:215
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:200
#define AV_LOG_INFO
Standard information.
Definition: log.h:205
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:194
#define DECLARE_ALIGNED(n, t, v)
Declare a variable that is aligned in memory.
Definition: mem.h:117
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
@ AV_SAMPLE_FMT_S32
signed 32 bits
Definition: samplefmt.h:62
@ AV_SAMPLE_FMT_S16
signed 16 bits
Definition: samplefmt.h:61
int index
Definition: gxfenc.c:89
static const float quant_step_size[]
Definition: hca_data.h:125
int i
Definition: input.c:407
#define MAX_BLOCKSIZE
Definition: diracdec.c:55
int ff_side_data_update_matrix_encoding(AVFrame *frame, enum AVMatrixEncoding matrix_encoding)
Add or update AV_FRAME_DATA_MATRIXENCODING side data.
Definition: utils.c:114
#define FF_CODEC_CAP_INIT_THREADSAFE
The codec does not modify any global variables in the init function, allowing to call the init functi...
Definition: internal.h:41
#define PARAM_PRESENCE
Definition: mlpdec.c:95
static const int8_t noise_table[256]
Data table used for TrueHD noise generation function.
Definition: mlpdec.c:1001
static av_cold int mlp_decode_init(AVCodecContext *avctx)
Definition: mlpdec.c:279
static int read_filter_params(MLPDecodeContext *m, GetBitContext *gbp, unsigned int substr, unsigned int channel, unsigned int filter)
Read parameters for one of the prediction filters.
Definition: mlpdec.c:649
static int read_huff_channels(MLPDecodeContext *m, GetBitContext *gbp, unsigned int substr, unsigned int pos)
Read a sample, consisting of either, both or neither of entropy-coded MSBs and plain LSBs.
Definition: mlpdec.c:243
static int read_access_unit(AVCodecContext *avctx, void *data, int *got_frame_ptr, AVPacket *avpkt)
Read an access unit from the stream.
Definition: mlpdec.c:1138
#define VLC_STATIC_SIZE
Definition: mlpdec.c:50
static void filter_channel(MLPDecodeContext *m, unsigned int substr, unsigned int channel)
Generate PCM samples using the prediction filters and residual values read from the data stream,...
Definition: mlpdec.c:932
#define PARAM_HUFFOFFSET
Definition: mlpdec.c:94
static int mlp_channel_layout_subset(uint64_t channel_layout, uint64_t mask)
Definition: mlpdec.c:185
static VLC huff_vlc[3]
Definition: mlpdec.c:204
static uint64_t thd_channel_layout_extract_channel(uint64_t channel_layout, int index)
Definition: mlpdec.c:190
static const uint64_t thd_channel_order[]
Definition: mlpdec.c:169
#define PARAM_FIR
Definition: mlpdec.c:92
static int read_restart_header(MLPDecodeContext *m, GetBitContext *gbp, const uint8_t *buf, unsigned int substr)
Read a restart header from a block in a substream.
Definition: mlpdec.c:474
static void fill_noise_buffer(MLPDecodeContext *m, unsigned int substr)
Generate a block of noise, used when restart sync word == 0x31eb.
Definition: mlpdec.c:1050
#define PARAM_MATRIX
Definition: mlpdec.c:89
static int read_major_sync(MLPDecodeContext *m, GetBitContext *gb)
Read a major sync info header - contains high level information about the stream - sample rate,...
Definition: mlpdec.c:300
#define PARAM_QUANTSTEP
Definition: mlpdec.c:91
#define MSB_MASK(bits)
Definition: mlpdec.c:927
static int32_t calculate_sign_huff(MLPDecodeContext *m, unsigned int substr, unsigned int ch)
Definition: mlpdec.c:222
static int output_data(MLPDecodeContext *m, unsigned int substr, AVFrame *frame, int *got_frame_ptr)
Write the audio data into the output buffer.
Definition: mlpdec.c:1067
static void generate_2_noise_channels(MLPDecodeContext *m, unsigned int substr)
Noise generation functions.
Definition: mlpdec.c:1030
static int read_decoding_params(MLPDecodeContext *m, GetBitContext *gbp, unsigned int substr)
Read decoding parameters that change more often than those in the restart header.
Definition: mlpdec.c:849
#define VLC_BITS
number of bits used for VLC lookup - longest Huffman code is 9
Definition: mlpdec.c:49
#define PARAM_IIR
Definition: mlpdec.c:93
#define PARAM_OUTSHIFT
Definition: mlpdec.c:90
static av_cold void init_static(void)
Initialize static data, constant between all invocations of the codec.
Definition: mlpdec.c:208
#define PARAM_BLOCKSIZE
Definition: mlpdec.c:88
static int read_matrix_params(MLPDecodeContext *m, unsigned int substr, GetBitContext *gbp)
Read parameters for primitive matrices.
Definition: mlpdec.c:724
static int read_block_data(MLPDecodeContext *m, GetBitContext *gbp, unsigned int substr)
Read a block of PCM residual data (or actual if no filtering active).
Definition: mlpdec.c:959
static int read_channel_params(MLPDecodeContext *m, unsigned int substr, GetBitContext *gbp, unsigned int ch)
Read channel parameters.
Definition: mlpdec.c:792
common internal API header
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
#define AVOnce
Definition: thread.h:172
static int ff_thread_once(char *control, void(*routine)(void))
Definition: thread.h:175
#define AV_ONCE_INIT
Definition: thread.h:173
static const uint16_t mask[17]
Definition: lzw.c:38
const uint8_t ff_mlp_huffman_tables[3][18][2]
Tables defining the Huffman codes.
Definition: mlp.c:29
uint8_t ff_mlp_restart_checksum(const uint8_t *buf, unsigned int bit_size)
Calculate an 8-bit checksum over a restart header – a non-multiple-of-8 number of bits,...
Definition: mlp.c:104
av_cold void ff_mlp_init_crc(void)
Definition: mlp.c:82
uint8_t ff_mlp_calculate_parity(const uint8_t *buf, unsigned int buf_size)
XOR together all the bytes of a buffer.
Definition: mlp.c:123
uint8_t ff_mlp_checksum8(const uint8_t *buf, unsigned int buf_size)
MLP uses checksums that seem to be based on the standard CRC algorithm, but are not (in implementatio...
Definition: mlp.c:97
#define NUM_FILTERS
number of allowed filters
Definition: mlp.h:61
#define MAX_SUBSTREAMS
Maximum number of substreams that can be decoded.
Definition: mlp.h:48
#define MAX_BLOCKSIZE_POW2
next power of two greater than MAX_BLOCKSIZE
Definition: mlp.h:58
#define MAX_SAMPLERATE
maximum sample frequency seen in files
Definition: mlp.h:53
#define FIR
Definition: mlp.h:70
#define MAX_MATRICES_MLP
Maximum number of matrices used in decoding; most streams have one matrix per output channel,...
Definition: mlp.h:41
#define IIR
Definition: mlp.h:71
#define MAX_FIR_ORDER
The maximum number of taps in IIR and FIR filters.
Definition: mlp.h:64
#define MAX_MATRICES
Definition: mlp.h:43
#define MAX_MATRIX_CHANNEL_TRUEHD
Definition: mlp.h:31
#define MAX_MATRIX_CHANNEL_MLP
Last possible matrix channel for each codec.
Definition: mlp.h:30
@ THD_CH_MODIFIER_LTRT
Definition: mlp.h:170
@ THD_CH_MODIFIER_SURROUNDEX
Definition: mlp.h:174
@ THD_CH_MODIFIER_LBINRBIN
Definition: mlp.h:171
static uint8_t xor_32_to_8(uint32_t value)
XOR four bytes into one.
Definition: mlp.h:160
#define MAX_MATRICES_TRUEHD
Definition: mlp.h:42
#define MAX_IIR_ORDER
Definition: mlp.h:65
int ff_mlp_read_major_sync(void *log, MLPHeaderInfo *mh, GetBitContext *gb)
Read a major sync info header - contains high level information about the stream - sample rate,...
Definition: mlp_parse.c:86
av_cold void ff_mlpdsp_init(MLPDSPContext *c)
Definition: mlpdsp.c:128
const char data[16]
Definition: mxf.c:142
static const uint16_t table[]
Definition: prosumer.c:206
#define fp
Definition: regdef.h:44
#define FF_ARRAY_ELEMS(a)
unsigned int pos
Definition: spdifenc.c:412
main external API structure.
Definition: avcodec.h:536
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:1204
int bits_per_raw_sample
Bits per sample/pixel of internal libavcodec pixel/sample format.
Definition: avcodec.h:1751
int sample_rate
samples per second
Definition: avcodec.h:1196
uint64_t request_channel_layout
Request decoder to use this channel layout if it can (0 for default)
Definition: avcodec.h:1254
int channels
number of audio channels
Definition: avcodec.h:1197
enum AVCodecID codec_id
Definition: avcodec.h:546
uint64_t channel_layout
Audio channel layout.
Definition: avcodec.h:1247
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:1216
void * priv_data
Definition: avcodec.h:563
AVCodec.
Definition: codec.h:197
const char * name
Name of the codec implementation.
Definition: codec.h:204
This structure describes decoded (raw) audio or video data.
Definition: frame.h:318
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:384
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:332
This structure stores compressed data.
Definition: packet.h:346
int size
Definition: packet.h:370
uint8_t * data
Definition: packet.h:369
sample data coding information
Definition: mlp.h:85
FilterParams filter_params[NUM_FILTERS]
Definition: mlp.h:86
int32_t sign_huff_offset
sign/rounding-corrected version of huff_offset
Definition: mlp.h:90
uint8_t huff_lsbs
Size of residual suffix not encoded using VLC.
Definition: mlp.h:92
int16_t huff_offset
Offset to apply to residual values.
Definition: mlp.h:89
uint8_t codebook
Which VLC codebook to use to read residuals.
Definition: mlp.h:91
filter data
Definition: mlp.h:74
int32_t state[MAX_FIR_ORDER]
Definition: mlp.h:78
uint8_t shift
Right shift to apply to output of filter.
Definition: mlp.h:76
uint8_t order
number of taps in filter
Definition: mlp.h:75
int32_t(* mlp_pack_output)(int32_t lossless_check_data, uint16_t blockpos, int32_t(*sample_buffer)[MAX_CHANNELS], void *data, uint8_t *ch_assign, int8_t *output_shift, uint8_t max_matrix_channel, int is32)
Definition: mlpdsp.h:69
int32_t(*(* mlp_select_pack_output)(uint8_t *ch_assign, int8_t *output_shift, uint8_t max_matrix_channel, int is32))(int32_t
Definition: mlpdsp.h:65
void(* mlp_rematrix_channel)(int32_t *samples, const int32_t *coeffs, const uint8_t *bypassed_lsbs, const int8_t *noise_buffer, int index, unsigned int dest_ch, uint16_t blockpos, unsigned int maxchan, int matrix_noise_shift, int access_unit_size_pow2, int32_t mask)
Definition: mlpdsp.h:54
void(* mlp_filter_channel)(int32_t *state, const int32_t *coeff, int firorder, int iirorder, unsigned int filter_shift, int32_t mask, int blocksize, int32_t *sample_buffer)
Definition: mlpdsp.h:50
int filter_changed[MAX_CHANNELS][NUM_FILTERS]
Definition: mlpdec.c:160
int access_unit_size_pow2
next power of two above the number of samples in each frame
Definition: mlpdec.c:155
uint8_t needs_reordering
Stream needs channel reordering to comply with FFmpeg's channel order.
Definition: mlpdec.c:150
uint8_t params_valid
Set if a valid major sync block has been read. Otherwise no decoding is possible.
Definition: mlpdec.c:141
AVCodecContext * avctx
Definition: mlpdec.c:132
int major_sync_header_size
Size of the major sync unit, in bytes.
Definition: mlpdec.c:138
int8_t bypassed_lsbs[MAX_BLOCKSIZE][MAX_CHANNELS]
Definition: mlpdec.c:163
int8_t noise_buffer[MAX_BLOCKSIZE_POW2]
Definition: mlpdec.c:162
MLPDSPContext dsp
Definition: mlpdec.c:166
uint8_t max_decoded_substream
Index of the last substream to decode - further substreams are skipped.
Definition: mlpdec.c:147
int access_unit_size
number of PCM samples contained in each frame
Definition: mlpdec.c:153
SubStream substream[MAX_SUBSTREAMS]
Definition: mlpdec.c:157
int32_t sample_buffer[MAX_BLOCKSIZE][MAX_CHANNELS]
Definition: mlpdec.c:164
int matrix_changed
Definition: mlpdec.c:159
uint8_t num_substreams
Number of substreams contained within this stream.
Definition: mlpdec.c:144
int is_major_sync_unit
Current access unit being read has a major sync.
Definition: mlpdec.c:135
uint8_t num_primitive_matrices
matrix data
Definition: mlpdec.c:102
int32_t matrix_coeff[MAX_MATRICES][MAX_CHANNELS]
Matrix coefficients, stored as 2.14 fixed point.
Definition: mlpdec.c:110
uint8_t max_channel
The index of the last channel coded in this substream.
Definition: mlpdec.c:65
uint32_t noisegen_seed
The current seed value for the pseudorandom noise generator(s).
Definition: mlpdec.c:81
uint16_t blockpos
Number of PCM samples decoded so far in this frame.
Definition: mlpdec.c:121
uint8_t restart_seen
Set if a valid restart header has been read. Otherwise the substream cannot be decoded.
Definition: mlpdec.c:55
uint8_t matrix_out_ch[MAX_MATRICES]
matrix output channel
Definition: mlpdec.c:105
uint8_t data_check_present
Set if the substream contains extra info to check the size of VLC blocks.
Definition: mlpdec.c:84
uint8_t noise_shift
The left shift applied to random noise in 0x31ea substreams.
Definition: mlpdec.c:79
ChannelParams channel_params[MAX_CHANNELS]
Channel coding parameters for channels in the substream.
Definition: mlpdec.c:76
uint16_t blocksize
number of PCM samples in current audio block
Definition: mlpdec.c:119
uint16_t noise_type
restart header data
Definition: mlpdec.c:60
uint64_t mask
The channel layout for this substream.
Definition: mlpdec.c:71
uint8_t lsb_bypass[MAX_MATRICES]
Whether the LSBs of the matrix output are encoded in the bitstream.
Definition: mlpdec.c:108
int8_t output_shift[MAX_CHANNELS]
Left shift to apply to decoded PCM values to get final 24-bit output.
Definition: mlpdec.c:124
uint8_t param_presence_flags
Bitmask of which parameter sets are conveyed in a decoding parameter block.
Definition: mlpdec.c:87
uint8_t quant_step_size[MAX_CHANNELS]
Left shift to apply to Huffman-decoded residuals.
Definition: mlpdec.c:116
uint8_t matrix_noise_shift[MAX_MATRICES]
Left shift to apply to noise values in 0x31eb substreams.
Definition: mlpdec.c:112
enum AVMatrixEncoding matrix_encoding
The matrix encoding mode for this substream.
Definition: mlpdec.c:73
uint8_t ch_assign[MAX_CHANNELS]
For each channel output by the matrix, the output channel to map it to.
Definition: mlpdec.c:69
uint8_t max_matrix_channel
The number of channels input into the rematrix stage.
Definition: mlpdec.c:67
uint8_t min_channel
The index of the first channel coded in this substream.
Definition: mlpdec.c:63
int32_t lossless_check_data
Running XOR of all output samples.
Definition: mlpdec.c:127
Definition: vlc.h:26
int table_allocated
Definition: vlc.h:29
VLC_TYPE(* table)[2]
code, bits
Definition: vlc.h:28
#define avpriv_request_sample(...)
#define av_log(a,...)
static void error(const char *err)
static volatile int checksum
Definition: adler32.c:30
static uint8_t tmp[11]
Definition: aes_ctr.c:27
#define mh
if(ret< 0)
Definition: vf_mcdeint.c:282
mcdeint parity
Definition: vf_mcdeint.c:277
static unsigned int seed
Definition: videogen.c:78
#define init_vlc(vlc, nb_bits, nb_codes, bits, bits_wrap, bits_size, codes, codes_wrap, codes_size, flags)
Definition: vlc.h:38
#define INIT_VLC_USE_NEW_STATIC
Definition: vlc.h:95
#define VLC_TYPE
Definition: vlc.h:24