FFmpeg
mlp.h
Go to the documentation of this file.
1 /*
2  * MLP codec common header file
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 #ifndef AVCODEC_MLP_H
23 #define AVCODEC_MLP_H
24 
25 #include <stdint.h>
26 
27 /** Last possible matrix channel for each codec */
28 #define MAX_MATRIX_CHANNEL_MLP 5
29 #define MAX_MATRIX_CHANNEL_TRUEHD 7
30 /** Maximum number of channels in a valid stream.
31  * MLP : 5.1 + 2 noise channels -> 8 channels
32  * TrueHD: 7.1 -> 8 channels
33  */
34 #define MAX_CHANNELS 8
35 
36 /** Maximum number of matrices used in decoding; most streams have one matrix
37  * per output channel, but some rematrix a channel (usually 0) more than once.
38  */
39 #define MAX_MATRICES_MLP 6
40 #define MAX_MATRICES_TRUEHD 8
41 #define MAX_MATRICES 8
42 
43 /** Maximum number of substreams that can be decoded.
44  * MLP's limit is 2. TrueHD supports at least up to 3.
45  */
46 #define MAX_SUBSTREAMS 4
47 
48 /** which multiple of 48000 the maximum sample rate is */
49 #define MAX_RATEFACTOR 4
50 /** maximum sample frequency seen in files */
51 #define MAX_SAMPLERATE (MAX_RATEFACTOR * 48000)
52 
53 /** maximum number of audio samples within one access unit */
54 #define MAX_BLOCKSIZE (40 * MAX_RATEFACTOR)
55 /** next power of two greater than MAX_BLOCKSIZE */
56 #define MAX_BLOCKSIZE_POW2 (64 * MAX_RATEFACTOR)
57 
58 /** number of allowed filters */
59 #define NUM_FILTERS 2
60 
61 /** The maximum number of taps in IIR and FIR filters. */
62 #define MAX_FIR_ORDER 8
63 #define MAX_IIR_ORDER 4
64 
65 /** Code that signals end of a stream. */
66 #define END_OF_STREAM 0xd234d234
67 
68 #define FIR 0
69 #define IIR 1
70 
71 /** filter data */
72 typedef struct FilterParams {
73  uint8_t order; ///< number of taps in filter
74  uint8_t shift; ///< Right shift to apply to output of filter.
75 
77 
80 } FilterParams;
81 
82 /** sample data coding information */
83 typedef struct ChannelParams {
86 
87  int16_t huff_offset; ///< Offset to apply to residual values.
88  int32_t sign_huff_offset; ///< sign/rounding-corrected version of huff_offset
89  uint8_t codebook; ///< Which VLC codebook to use to read residuals.
90  uint8_t huff_lsbs; ///< Size of residual suffix not encoded using VLC.
92 
93 /** Tables defining the Huffman codes.
94  * There are three entropy coding methods used in MLP (four if you count
95  * "none" as a method). These use the same sequences for codes starting with
96  * 00 or 01, but have different codes starting with 1.
97  */
98 extern const uint8_t ff_mlp_huffman_tables[3][18][2];
99 
100 typedef struct {
104  uint8_t summary_info;
106 
107 /** Tables defining channel information.
108  *
109  * Possible channel arrangements are:
110  *
111  * (Group 1) C
112  * (Group 1) L, R
113  * (Group 1) Lf, Rf / (Group 2) S
114  * (Group 1) Lf, Rf / (Group 2) Ls, Rs
115  * (Group 1) Lf, Rf / (Group 2) LFE
116  * (Group 1) Lf, Rf / (Group 2) LFE, S
117  * (Group 1) Lf, Rf / (Group 2) LFE, Ls, Rs
118  * (Group 1) Lf, Rf / (Group 2) C
119  * (Group 1) Lf, Rf / (Group 2) C, S
120  * (Group 1) Lf, Rf / (Group 2) C, Ls, Rs
121  * (Group 1) Lf, Rf / (Group 2) C, LFE
122  * (Group 1) Lf, Rf / (Group 2) C, LFE, S
123  * (Group 1) Lf, Rf / (Group 2) C, LFE, Ls, Rs
124  * (Group 1) Lf, Rf C / (Group 2) S
125  * (Group 1) Lf, Rf C / (Group 2) Ls, Rs
126  * (Group 1) Lf, Rf C / (Group 2) LFE
127  * (Group 1) Lf, Rf C / (Group 2) LFE, S
128  * (Group 1) Lf, Rf C / (Group 2) LFE, Ls, Rs
129  * (Group 1) Lf, Rf Ls Rs / (Group 2) LFE
130  * (Group 1) Lf, Rf Ls Rs / (Group 2) C
131  * (Group 1) Lf, Rf, Ls, Rs / (Group 2) C, LFE
132  */
133 extern const ChannelInformation ff_mlp_ch_info[21];
134 
135 extern const uint64_t ff_mlp_channel_layouts[12];
136 
137 /** MLP uses checksums that seem to be based on the standard CRC algorithm, but
138  * are not (in implementation terms, the table lookup and XOR are reversed).
139  * We can implement this behavior using a standard av_crc on all but the
140  * last element, then XOR that with the last element.
141  */
142 uint8_t ff_mlp_checksum8 (const uint8_t *buf, unsigned int buf_size);
143 uint16_t ff_mlp_checksum16(const uint8_t *buf, unsigned int buf_size);
144 
145 /** Calculate an 8-bit checksum over a restart header -- a non-multiple-of-8
146  * number of bits, starting two bits into the first byte of buf.
147  */
148 uint8_t ff_mlp_restart_checksum(const uint8_t *buf, unsigned int bit_size);
149 
150 /** XOR together all the bytes of a buffer.
151  * Does this belong in dspcontext?
152  */
153 uint8_t ff_mlp_calculate_parity(const uint8_t *buf, unsigned int buf_size);
154 
155 void ff_mlp_init_crc(void);
156 
157 /** XOR four bytes into one. */
158 static inline uint8_t xor_32_to_8(uint32_t value)
159 {
160  value ^= value >> 16;
161  value ^= value >> 8;
162  return value;
163 }
164 
165 typedef enum THDChannelModifier {
167  THD_CH_MODIFIER_STEREO = 0x0, // Stereo (not Dolby Surround)
168  THD_CH_MODIFIER_LTRT = 0x1, // Dolby Surround
169  THD_CH_MODIFIER_LBINRBIN = 0x2, // Dolby Headphone
170  THD_CH_MODIFIER_MONO = 0x3, // Mono or Dual Mono
171  THD_CH_MODIFIER_NOTSURROUNDEX = 0x1, // Not Dolby Digital EX
172  THD_CH_MODIFIER_SURROUNDEX = 0x2, // Dolby Digital EX
174 
175 #endif /* AVCODEC_MLP_H */
ChannelInformation::summary_info
uint8_t summary_info
Definition: mlp.h:104
THD_CH_MODIFIER_NOTINDICATED
@ THD_CH_MODIFIER_NOTINDICATED
Definition: mlp.h:166
ff_mlp_huffman_tables
const uint8_t ff_mlp_huffman_tables[3][18][2]
Tables defining the Huffman codes.
Definition: mlp.c:30
ChannelParams::codebook
uint8_t codebook
Which VLC codebook to use to read residuals.
Definition: mlp.h:89
xor_32_to_8
static uint8_t xor_32_to_8(uint32_t value)
XOR four bytes into one.
Definition: mlp.h:158
THD_CH_MODIFIER_SURROUNDEX
@ THD_CH_MODIFIER_SURROUNDEX
Definition: mlp.h:172
ff_mlp_checksum8
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:98
ChannelInformation::group2_channels
uint8_t group2_channels
Definition: mlp.h:103
ff_mlp_ch_info
const ChannelInformation ff_mlp_ch_info[21]
Tables defining channel information.
Definition: mlp.c:46
ChannelParams::filter_params
FilterParams filter_params[NUM_FILTERS]
Definition: mlp.h:84
ChannelParams::huff_lsbs
uint8_t huff_lsbs
Size of residual suffix not encoded using VLC.
Definition: mlp.h:90
ChannelInformation
Definition: mlp.h:100
ff_mlp_checksum16
uint16_t ff_mlp_checksum16(const uint8_t *buf, unsigned int buf_size)
Definition: mlp.c:89
ChannelInformation::group1_channels
uint8_t group1_channels
Definition: mlp.h:102
THD_CH_MODIFIER_LTRT
@ THD_CH_MODIFIER_LTRT
Definition: mlp.h:168
ff_mlp_init_crc
void ff_mlp_init_crc(void)
Definition: mlp.c:83
ChannelParams::coeff
int32_t coeff[NUM_FILTERS][MAX_FIR_ORDER]
Definition: mlp.h:85
THDChannelModifier
THDChannelModifier
Definition: mlp.h:165
THD_CH_MODIFIER_LBINRBIN
@ THD_CH_MODIFIER_LBINRBIN
Definition: mlp.h:169
FilterParams::coeff_shift
int coeff_shift
Definition: mlp.h:79
FilterParams
filter data
Definition: mlp.h:72
FilterParams::coeff_bits
int coeff_bits
Definition: mlp.h:78
NUM_FILTERS
#define NUM_FILTERS
number of allowed filters
Definition: mlp.h:59
FilterParams::order
uint8_t order
number of taps in filter
Definition: mlp.h:73
ChannelParams::huff_offset
int16_t huff_offset
Offset to apply to residual values.
Definition: mlp.h:87
MAX_FIR_ORDER
#define MAX_FIR_ORDER
The maximum number of taps in IIR and FIR filters.
Definition: mlp.h:62
ff_mlp_channel_layouts
const uint64_t ff_mlp_channel_layouts[12]
Definition: mlp.c:60
value
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default value
Definition: writing_filters.txt:86
ChannelParams
sample data coding information
Definition: mlp.h:83
ChannelParams::sign_huff_offset
int32_t sign_huff_offset
sign/rounding-corrected version of huff_offset
Definition: mlp.h:88
ChannelInformation::channel_occupancy
uint8_t channel_occupancy
Definition: mlp.h:101
FilterParams::state
int32_t state[MAX_FIR_ORDER]
Definition: mlp.h:76
THD_CH_MODIFIER_STEREO
@ THD_CH_MODIFIER_STEREO
Definition: mlp.h:167
THD_CH_MODIFIER_NOTSURROUNDEX
@ THD_CH_MODIFIER_NOTSURROUNDEX
Definition: mlp.h:171
ff_mlp_calculate_parity
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:124
int32_t
int32_t
Definition: audioconvert.c:56
FilterParams::shift
uint8_t shift
Right shift to apply to output of filter.
Definition: mlp.h:74
ff_mlp_restart_checksum
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:105
THD_CH_MODIFIER_MONO
@ THD_CH_MODIFIER_MONO
Definition: mlp.h:170