dca: Split code for handling the EXSS extension off into a separate file
[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 /** DCA syncwords, also used for bitstream type detection */
39 #define DCA_MARKER_RAW_BE 0x7FFE8001
40 #define DCA_MARKER_RAW_LE 0xFE7F0180
41 #define DCA_MARKER_14B_BE 0x1FFFE800
42 #define DCA_MARKER_14B_LE 0xFF1F00E8
43
44 /** DCA-HD specific block starts with this marker. */
45 #define DCA_HD_MARKER     0x64582025
46
47 #define DCA_PRIM_CHANNELS_MAX  (7)
48 #define DCA_ABITS_MAX         (32)      /* Should be 28 */
49 #define DCA_SUBSUBFRAMES_MAX   (4)
50 #define DCA_SUBFRAMES_MAX     (16)
51 #define DCA_BLOCKS_MAX        (16)
52 #define DCA_LFE_MAX            (3)
53
54 #define DCA_MAX_FRAME_SIZE       16384
55 #define DCA_MAX_EXSS_HEADER_SIZE  4096
56
57 #define DCA_BUFFER_PADDING_SIZE   1024
58
59 enum DCAExtensionMask {
60     DCA_EXT_CORE       = 0x001, ///< core in core substream
61     DCA_EXT_XXCH       = 0x002, ///< XXCh channels extension in core substream
62     DCA_EXT_X96        = 0x004, ///< 96/24 extension in core substream
63     DCA_EXT_XCH        = 0x008, ///< XCh channel extension in core substream
64     DCA_EXT_EXSS_CORE  = 0x010, ///< core in ExSS (extension substream)
65     DCA_EXT_EXSS_XBR   = 0x020, ///< extended bitrate extension in ExSS
66     DCA_EXT_EXSS_XXCH  = 0x040, ///< XXCh channels extension in ExSS
67     DCA_EXT_EXSS_X96   = 0x080, ///< 96/24 extension in ExSS
68     DCA_EXT_EXSS_LBR   = 0x100, ///< low bitrate component in ExSS
69     DCA_EXT_EXSS_XLL   = 0x200, ///< lossless extension in ExSS
70 };
71
72 typedef struct DCAContext {
73     AVClass *class;             ///< class for AVOptions
74     AVCodecContext *avctx;
75     /* Frame header */
76     int frame_type;             ///< type of the current frame
77     int samples_deficit;        ///< deficit sample count
78     int crc_present;            ///< crc is present in the bitstream
79     int sample_blocks;          ///< number of PCM sample blocks
80     int frame_size;             ///< primary frame byte size
81     int amode;                  ///< audio channels arrangement
82     int sample_rate;            ///< audio sampling rate
83     int bit_rate;               ///< transmission bit rate
84     int bit_rate_index;         ///< transmission bit rate index
85
86     int dynrange;               ///< embedded dynamic range flag
87     int timestamp;              ///< embedded time stamp flag
88     int aux_data;               ///< auxiliary data flag
89     int hdcd;                   ///< source material is mastered in HDCD
90     int ext_descr;              ///< extension audio descriptor flag
91     int ext_coding;             ///< extended coding flag
92     int aspf;                   ///< audio sync word insertion flag
93     int lfe;                    ///< low frequency effects flag
94     int predictor_history;      ///< predictor history flag
95     int header_crc;             ///< header crc check bytes
96     int multirate_inter;        ///< multirate interpolator switch
97     int version;                ///< encoder software revision
98     int copy_history;           ///< copy history
99     int source_pcm_res;         ///< source pcm resolution
100     int front_sum;              ///< front sum/difference flag
101     int surround_sum;           ///< surround sum/difference flag
102     int dialog_norm;            ///< dialog normalisation parameter
103
104     /* Primary audio coding header */
105     int subframes;              ///< number of subframes
106     int total_channels;         ///< number of channels including extensions
107     int prim_channels;          ///< number of primary audio channels
108     int subband_activity[DCA_PRIM_CHANNELS_MAX];    ///< subband activity count
109     int vq_start_subband[DCA_PRIM_CHANNELS_MAX];    ///< high frequency vq start subband
110     int joint_intensity[DCA_PRIM_CHANNELS_MAX];     ///< joint intensity coding index
111     int transient_huffman[DCA_PRIM_CHANNELS_MAX];   ///< transient mode code book
112     int scalefactor_huffman[DCA_PRIM_CHANNELS_MAX]; ///< scale factor code book
113     int bitalloc_huffman[DCA_PRIM_CHANNELS_MAX];    ///< bit allocation quantizer select
114     int quant_index_huffman[DCA_PRIM_CHANNELS_MAX][DCA_ABITS_MAX]; ///< quantization index codebook select
115     float scalefactor_adj[DCA_PRIM_CHANNELS_MAX][DCA_ABITS_MAX];   ///< scale factor adjustment
116
117     /* Primary audio coding side information */
118     int subsubframes[DCA_SUBFRAMES_MAX];                         ///< number of subsubframes
119     int partial_samples[DCA_SUBFRAMES_MAX];                      ///< partial subsubframe samples count
120     int prediction_mode[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS];    ///< prediction mode (ADPCM used or not)
121     int prediction_vq[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS];      ///< prediction VQ coefs
122     int bitalloc[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS];           ///< bit allocation index
123     int transition_mode[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS];    ///< transition mode (transients)
124     int32_t scale_factor[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS][2];///< scale factors (2 if transient)
125     int joint_huff[DCA_PRIM_CHANNELS_MAX];                       ///< joint subband scale factors codebook
126     int joint_scale_factor[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS]; ///< joint subband scale factors
127     float downmix_coef[DCA_PRIM_CHANNELS_MAX + 1][2];            ///< stereo downmix coefficients
128     int dynrange_coef;                                           ///< dynamic range coefficient
129
130     /* Core substream's embedded downmix coefficients (cf. ETSI TS 102 114 V1.4.1)
131      * Input:  primary audio channels (incl. LFE if present)
132      * Output: downmix audio channels (up to 4, no LFE) */
133     uint8_t  core_downmix;                                       ///< embedded downmix coefficients available
134     uint8_t  core_downmix_amode;                                 ///< audio channel arrangement of embedded downmix
135     uint16_t core_downmix_codes[DCA_PRIM_CHANNELS_MAX + 1][4];   ///< embedded downmix coefficients (9-bit codes)
136
137     int32_t  high_freq_vq[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS];  ///< VQ encoded high frequency subbands
138
139     float lfe_data[2 * DCA_LFE_MAX * (DCA_BLOCKS_MAX + 4)];      ///< Low frequency effect data
140     int lfe_scale_factor;
141
142     /* Subband samples history (for ADPCM) */
143     DECLARE_ALIGNED(16, float, subband_samples_hist)[DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS][4];
144     DECLARE_ALIGNED(32, float, subband_fir_hist)[DCA_PRIM_CHANNELS_MAX][512];
145     DECLARE_ALIGNED(32, float, subband_fir_noidea)[DCA_PRIM_CHANNELS_MAX][32];
146     int hist_index[DCA_PRIM_CHANNELS_MAX];
147     DECLARE_ALIGNED(32, float, raXin)[32];
148
149     int output;                 ///< type of output
150
151     DECLARE_ALIGNED(32, float, subband_samples)[DCA_BLOCKS_MAX][DCA_PRIM_CHANNELS_MAX][DCA_SUBBANDS][8];
152     float *samples_chanptr[DCA_PRIM_CHANNELS_MAX + 1];
153     float *extra_channels[DCA_PRIM_CHANNELS_MAX + 1];
154     uint8_t *extra_channels_buffer;
155     unsigned int extra_channels_buffer_size;
156
157     uint8_t dca_buffer[DCA_MAX_FRAME_SIZE + DCA_MAX_EXSS_HEADER_SIZE + DCA_BUFFER_PADDING_SIZE];
158     int dca_buffer_size;        ///< how much data is in the dca_buffer
159
160     const int8_t *channel_order_tab;  ///< channel reordering table, lfe and non lfe
161     GetBitContext gb;
162     /* Current position in DCA frame */
163     int current_subframe;
164     int current_subsubframe;
165
166     int core_ext_mask;          ///< present extensions in the core substream
167
168     /* XCh extension information */
169     int xch_present;            ///< XCh extension present and valid
170     int xch_base_channel;       ///< index of first (only) channel containing XCH data
171     int xch_disable;            ///< whether the XCh extension should be decoded or not
172
173     /* ExSS header parser */
174     int static_fields;          ///< static fields present
175     int mix_metadata;           ///< mixing metadata present
176     int num_mix_configs;        ///< number of mix out configurations
177     int mix_config_num_ch[4];   ///< number of channels in each mix out configuration
178
179     int profile;
180
181     int debug_flag;             ///< used for suppressing repeated error messages output
182     AVFloatDSPContext fdsp;
183     FFTContext imdct;
184     SynthFilterContext synth;
185     DCADSPContext dcadsp;
186     FmtConvertContext fmt_conv;
187 } DCAContext;
188
189 extern av_export const uint32_t avpriv_dca_sample_rates[16];
190
191 /**
192  * Convert bitstream to one representation based on sync marker
193  */
194 int ff_dca_convert_bitstream(const uint8_t *src, int src_size, uint8_t *dst,
195                              int max_size);
196
197 #endif /* AVCODEC_DCA_H */