dds: Fix enum declaration
[ffmpeg.git] / libavcodec / dca.h
1 /*
2  * DCA compatible decoder
3  * Copyright (C) 2004 Gildas Bazin
4  * Copyright (C) 2004 Benjamin Zores
5  * Copyright (C) 2006 Benjamin Larsson
6  * Copyright (C) 2007 Konstantin Shishkov
7  *
8  * This file is part of Libav.
9  *
10  * Libav is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * Libav is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with Libav; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  */
24
25 #ifndef AVCODEC_DCA_H
26 #define AVCODEC_DCA_H
27
28 #include <stdint.h>
29
30 #include "libavutil/float_dsp.h"
31 #include "libavutil/internal.h"
32
33 #include "avcodec.h"
34 #include "dcadsp.h"
35 #include "fmtconvert.h"
36 #include "get_bits.h"
37
38 #define DCA_PRIM_CHANNELS_MAX  (7)
39 #define DCA_ABITS_MAX         (32)      /* Should be 28 */
40 #define DCA_SUBSUBFRAMES_MAX   (4)
41 #define DCA_SUBFRAMES_MAX     (16)
42 #define DCA_BLOCKS_MAX        (16)
43 #define DCA_LFE_MAX            (3)
44
45 #define DCA_PRIM_CHANNELS_MAX  (7)
46 #define DCA_ABITS_MAX         (32)      /* Should be 28 */
47 #define DCA_SUBSUBFRAMES_MAX   (4)
48 #define DCA_SUBFRAMES_MAX     (16)
49 #define DCA_BLOCKS_MAX        (16)
50 #define DCA_LFE_MAX            (3)
51 #define DCA_XLL_FBANDS_MAX     (4)
52 #define DCA_XLL_SEGMENTS_MAX  (16)
53 #define DCA_XLL_CHSETS_MAX    (16)
54 #define DCA_XLL_CHANNELS_MAX  (16)
55 #define DCA_XLL_AORDER_MAX    (15)
56
57 /* Arbitrary limit; not sure what the maximum really is, but much larger. */
58 #define DCA_XLL_DMIX_NCOEFFS_MAX (18)
59
60 #define DCA_MAX_FRAME_SIZE       16384
61 #define DCA_MAX_EXSS_HEADER_SIZE  4096
62
63 #define DCA_BUFFER_PADDING_SIZE   1024
64
65 enum DCAExtensionMask {
66     DCA_EXT_CORE       = 0x001, ///< core in core substream
67     DCA_EXT_XXCH       = 0x002, ///< XXCh channels extension in core substream
68     DCA_EXT_X96        = 0x004, ///< 96/24 extension in core substream
69     DCA_EXT_XCH        = 0x008, ///< XCh channel extension in core substream
70     DCA_EXT_EXSS_CORE  = 0x010, ///< core in ExSS (extension substream)
71     DCA_EXT_EXSS_XBR   = 0x020, ///< extended bitrate extension in ExSS
72     DCA_EXT_EXSS_XXCH  = 0x040, ///< XXCh channels extension in ExSS
73     DCA_EXT_EXSS_X96   = 0x080, ///< 96/24 extension in ExSS
74     DCA_EXT_EXSS_LBR   = 0x100, ///< low bitrate component in ExSS
75     DCA_EXT_EXSS_XLL   = 0x200, ///< lossless extension in ExSS
76 };
77
78 typedef struct XllChSetSubHeader {
79     int channels;               ///< number of channels in channel set, at most 16
80     int residual_encode;        ///< residual channel encoding
81     int bit_resolution;         ///< input sample bit-width
82     int bit_width;              ///< original input sample bit-width
83     int sampling_frequency;     ///< sampling frequency
84     int samp_freq_interp;       ///< sampling frequency interpolation multiplier
85     int replacement_set;        ///< replacement channel set group
86     int active_replace_set;     ///< current channel set is active channel set
87     int primary_ch_set;
88     int downmix_coeff_code_embedded;
89     int downmix_embedded;
90     int downmix_type;
91     int hier_chset;             ///< hierarchical channel set
92     int downmix_ncoeffs;
93     int downmix_coeffs[DCA_XLL_DMIX_NCOEFFS_MAX];
94     int ch_mask_enabled;
95     int ch_mask;
96     int mapping_coeffs_present;
97     int num_freq_bands;
98
99     /* m_nOrigChanOrder */
100     uint8_t orig_chan_order[DCA_XLL_FBANDS_MAX][DCA_XLL_CHANNELS_MAX];
101     uint8_t orig_chan_order_inv[DCA_XLL_FBANDS_MAX][DCA_XLL_CHANNELS_MAX];
102     /* Coefficients for channel pairs (at most 8), m_anPWChPairsCoeffs */
103     int8_t pw_ch_pairs_coeffs[DCA_XLL_FBANDS_MAX][DCA_XLL_CHANNELS_MAX/2];
104     /* m_nCurrHighestLPCOrder */
105     uint8_t adapt_order_max[DCA_XLL_FBANDS_MAX];
106     /* m_pnAdaptPredOrder */
107     uint8_t adapt_order[DCA_XLL_FBANDS_MAX][DCA_XLL_CHANNELS_MAX];
108     /* m_pnFixedPredOrder */
109     uint8_t fixed_order[DCA_XLL_FBANDS_MAX][DCA_XLL_CHANNELS_MAX];
110     /* m_pnLPCReflCoeffsQInd, unsigned version */
111     uint8_t lpc_refl_coeffs_q_ind[DCA_XLL_FBANDS_MAX]
112                                  [DCA_XLL_CHANNELS_MAX][DCA_XLL_AORDER_MAX];
113
114     int lsb_fsize[DCA_XLL_FBANDS_MAX];
115     int8_t scalable_lsbs[DCA_XLL_FBANDS_MAX][DCA_XLL_CHANNELS_MAX];
116     int8_t bit_width_adj_per_ch[DCA_XLL_FBANDS_MAX][DCA_XLL_CHANNELS_MAX];
117 } XllChSetSubHeader;
118
119 typedef struct XllNavi {
120     GetBitContext gb;  // Context for parsing the data segments
121     unsigned band_size[DCA_XLL_FBANDS_MAX];
122     unsigned segment_size[DCA_XLL_FBANDS_MAX][DCA_XLL_SEGMENTS_MAX];
123     unsigned chset_size[DCA_XLL_FBANDS_MAX][DCA_XLL_SEGMENTS_MAX][DCA_XLL_CHSETS_MAX];
124 } XllNavi;
125
126 typedef struct QMF64_table {
127     float dct4_coeff[32][32];
128     float dct2_coeff[32][32];
129     float rcos[32];
130     float rsin[32];
131 } QMF64_table;
132
133 typedef struct DCAContext {
134     AVClass *class;             ///< class for AVOptions
135     AVCodecContext *avctx;
136     /* Frame header */
137     int frame_type;             ///< type of the current frame
138     int samples_deficit;        ///< deficit sample count
139     int crc_present;            ///< crc is present in the bitstream
140     int sample_blocks;          ///< number of PCM sample blocks
141     int frame_size;             ///< primary frame byte size
142     int amode;                  ///< audio channels arrangement
143     int sample_rate;            ///< audio sampling rate
144     int bit_rate;               ///< transmission bit rate
145     int bit_rate_index;         ///< transmission bit rate index
146
147     int dynrange;               ///< embedded dynamic range flag
148     int timestamp;              ///< embedded time stamp flag
149     int aux_data;               ///< auxiliary data flag
150     int hdcd;                   ///< source material is mastered in HDCD
151     int ext_descr;              ///< extension audio descriptor flag
152     int ext_coding;             ///< extended coding flag
153     int aspf;                   ///< audio sync word insertion flag
154     int lfe;                    ///< low frequency effects flag
155     int predictor_history;      ///< predictor history flag
156     int header_crc;             ///< header crc check bytes
157     int multirate_inter;        ///< multirate interpolator switch
158     int version;                ///< encoder software revision
159     int copy_history;           ///< copy history
160     int source_pcm_res;         ///< source pcm resolution
161     int front_sum;              ///< front sum/difference flag
162     int surround_sum;           ///< surround sum/difference flag
163     int dialog_norm;            ///< dialog normalisation parameter
164
165     /* Primary audio coding header */
166     int subframes;              ///< number of subframes
167     int total_channels;         ///< number of channels including extensions
168     int prim_channels;          ///< number of primary audio channels
169     int subband_activity[DCA_PRIM_CHANNELS_MAX];    ///< subband activity count
170     int vq_start_subband[DCA_PRIM_CHANNELS_MAX];    ///< high frequency vq start subband
171     int joint_intensity[DCA_PRIM_CHANNELS_MAX];     ///< joint intensity coding index
172     int transient_huffman[DCA_PRIM_CHANNELS_MAX];   ///< transient mode code book
173     int scalefactor_huffman[DCA_PRIM_CHANNELS_MAX]; ///< scale factor code book
174     int bitalloc_huffman[DCA_PRIM_CHANNELS_MAX];    ///< bit allocation quantizer select
175     int quant_index_huffman[DCA_PRIM_CHANNELS_MAX][DCA_ABITS_MAX]; ///< quantization index codebook select
176     float scalefactor_adj[DCA_PRIM_CHANNELS_MAX][DCA_ABITS_MAX];   ///< scale factor adjustment
177
178     /* Primary audio coding side information */
179     int subsubframes[DCA_SUBFRAMES_MAX];                         ///< number of subsubframes
180     int partial_samples[DCA_SUBFRAMES_MAX];                      ///< partial subsubframe samples count
181     int prediction_mode[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS];    ///< prediction mode (ADPCM used or not)
182     int prediction_vq[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS];      ///< prediction VQ coefs
183     int bitalloc[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS];           ///< bit allocation index
184     int transition_mode[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS];    ///< transition mode (transients)
185     int32_t scale_factor[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS][2];///< scale factors (2 if transient)
186     int joint_huff[DCA_PRIM_CHANNELS_MAX];                       ///< joint subband scale factors codebook
187     int joint_scale_factor[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS]; ///< joint subband scale factors
188     float downmix_coef[DCA_PRIM_CHANNELS_MAX + 1][2];            ///< stereo downmix coefficients
189     int dynrange_coef;                                           ///< dynamic range coefficient
190
191     /* Core substream's embedded downmix coefficients (cf. ETSI TS 102 114 V1.4.1)
192      * Input:  primary audio channels (incl. LFE if present)
193      * Output: downmix audio channels (up to 4, no LFE) */
194     uint8_t  core_downmix;                                       ///< embedded downmix coefficients available
195     uint8_t  core_downmix_amode;                                 ///< audio channel arrangement of embedded downmix
196     uint16_t core_downmix_codes[DCA_PRIM_CHANNELS_MAX + 1][4];   ///< embedded downmix coefficients (9-bit codes)
197
198     int32_t  high_freq_vq[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS];  ///< VQ encoded high frequency subbands
199
200     float lfe_data[2 * DCA_LFE_MAX * (DCA_BLOCKS_MAX + 4)];      ///< Low frequency effect data
201     int lfe_scale_factor;
202
203     /* Subband samples history (for ADPCM) */
204     DECLARE_ALIGNED(16, float, subband_samples_hist)[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS][4];
205     /* Half size is sufficient for core decoding, but for 96 kHz data
206      * we need QMF with 64 subbands and 1024 samples. */
207     DECLARE_ALIGNED(32, float, subband_fir_hist)[DCA_PRIM_CHANNELS_MAX][1024];
208     DECLARE_ALIGNED(32, float, subband_fir_noidea)[DCA_PRIM_CHANNELS_MAX][64];
209     int hist_index[DCA_PRIM_CHANNELS_MAX];
210     DECLARE_ALIGNED(32, float, raXin)[32];
211
212     int output;                 ///< type of output
213
214     DECLARE_ALIGNED(32, float, subband_samples)[DCA_BLOCKS_MAX][DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS][8];
215     float *samples_chanptr[DCA_PRIM_CHANNELS_MAX + 1];
216     float *extra_channels[DCA_PRIM_CHANNELS_MAX + 1];
217     uint8_t *extra_channels_buffer;
218     unsigned int extra_channels_buffer_size;
219
220     uint8_t dca_buffer[DCA_MAX_FRAME_SIZE + DCA_MAX_EXSS_HEADER_SIZE + DCA_BUFFER_PADDING_SIZE];
221     int dca_buffer_size;        ///< how much data is in the dca_buffer
222
223     const int8_t *channel_order_tab;  ///< channel reordering table, lfe and non lfe
224     GetBitContext gb;
225     /* Current position in DCA frame */
226     int current_subframe;
227     int current_subsubframe;
228
229     int core_ext_mask;          ///< present extensions in the core substream
230     int exss_ext_mask;          ///< Non-core extensions
231
232     /* XCh extension information */
233     int xch_present;            ///< XCh extension present and valid
234     int xch_base_channel;       ///< index of first (only) channel containing XCH data
235     int xch_disable;            ///< whether the XCh extension should be decoded or not
236
237     /* XLL extension information */
238     int xll_disable;
239     int xll_nch_sets;           ///< number of channel sets per frame
240     int xll_channels;           ///< total number of channels (in all channel sets)
241     int xll_residual_channels;  ///< number of residual channels
242     int xll_segments;           ///< number of segments per frame
243     int xll_log_smpl_in_seg;    ///< supposedly this is "nBits4SamplLoci"
244     int xll_smpl_in_seg;        ///< samples in segment per one frequency band for the first channel set
245     int xll_bits4seg_size;      ///< number of bits used to read segment size
246     int xll_banddata_crc;       ///< presence of CRC16 within each frequency band
247     int xll_scalable_lsb;
248     int xll_bits4ch_mask;       ///< channel position mask
249     int xll_fixed_lsb_width;
250     XllChSetSubHeader xll_chsets[DCA_XLL_CHSETS_MAX];
251     XllNavi xll_navi;
252     int *xll_sample_buf;
253     unsigned int xll_sample_buf_size;
254
255     /* ExSS header parser */
256     int static_fields;          ///< static fields present
257     int mix_metadata;           ///< mixing metadata present
258     int num_mix_configs;        ///< number of mix out configurations
259     int mix_config_num_ch[4];   ///< number of channels in each mix out configuration
260
261     int profile;
262     int one2one_map_chtospkr;
263
264     int debug_flag;             ///< used for suppressing repeated error messages output
265     AVFloatDSPContext fdsp;
266     FFTContext imdct;
267     SynthFilterContext synth;
268     DCADSPContext dcadsp;
269     QMF64_table *qmf64_table;
270     FmtConvertContext fmt_conv;
271 } DCAContext;
272
273 extern av_export const uint32_t avpriv_dca_sample_rates[16];
274
275 /**
276  * Convert bitstream to one representation based on sync marker
277  */
278 int ff_dca_convert_bitstream(const uint8_t *src, int src_size, uint8_t *dst,
279                              int max_size);
280
281 void ff_dca_exss_parse_header(DCAContext *s);
282
283 int ff_dca_xll_decode_header(DCAContext *s);
284 int ff_dca_xll_decode_navi(DCAContext *s, int asset_end);
285 int ff_dca_xll_decode_audio(DCAContext *s, AVFrame *frame);
286
287 #endif /* AVCODEC_DCA_H */