indeo3: ensure that decoded cell data is in 7-bit range as presumed by decoder
[ffmpeg.git] / libavcodec / aac.h
1 /*
2  * AAC definitions and structures
3  * Copyright (c) 2005-2006 Oded Shimon ( ods15 ods15 dyndns org )
4  * Copyright (c) 2006-2007 Maxim Gavrilov ( maxim.gavrilov gmail com )
5  *
6  * This file is part of Libav.
7  *
8  * Libav is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * Libav is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with Libav; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * AAC definitions and structures
26  * @author Oded Shimon  ( ods15 ods15 dyndns org )
27  * @author Maxim Gavrilov ( maxim.gavrilov gmail com )
28  */
29
30 #ifndef AVCODEC_AAC_H
31 #define AVCODEC_AAC_H
32
33 #include "avcodec.h"
34 #include "dsputil.h"
35 #include "fft.h"
36 #include "mpeg4audio.h"
37 #include "sbr.h"
38 #include "fmtconvert.h"
39
40 #include <stdint.h>
41
42 #define MAX_CHANNELS 64
43 #define MAX_ELEM_ID 16
44
45 #define TNS_MAX_ORDER 20
46 #define MAX_LTP_LONG_SFB 40
47
48 enum RawDataBlockType {
49     TYPE_SCE,
50     TYPE_CPE,
51     TYPE_CCE,
52     TYPE_LFE,
53     TYPE_DSE,
54     TYPE_PCE,
55     TYPE_FIL,
56     TYPE_END,
57 };
58
59 enum ExtensionPayloadID {
60     EXT_FILL,
61     EXT_FILL_DATA,
62     EXT_DATA_ELEMENT,
63     EXT_DYNAMIC_RANGE = 0xb,
64     EXT_SBR_DATA      = 0xd,
65     EXT_SBR_DATA_CRC  = 0xe,
66 };
67
68 enum WindowSequence {
69     ONLY_LONG_SEQUENCE,
70     LONG_START_SEQUENCE,
71     EIGHT_SHORT_SEQUENCE,
72     LONG_STOP_SEQUENCE,
73 };
74
75 enum BandType {
76     ZERO_BT        = 0,     ///< Scalefactors and spectral data are all zero.
77     FIRST_PAIR_BT  = 5,     ///< This and later band types encode two values (rather than four) with one code word.
78     ESC_BT         = 11,    ///< Spectral data are coded with an escape sequence.
79     NOISE_BT       = 13,    ///< Spectral data are scaled white noise not coded in the bitstream.
80     INTENSITY_BT2  = 14,    ///< Scalefactor data are intensity stereo positions.
81     INTENSITY_BT   = 15,    ///< Scalefactor data are intensity stereo positions.
82 };
83
84 #define IS_CODEBOOK_UNSIGNED(x) ((x - 1) & 10)
85
86 enum ChannelPosition {
87     AAC_CHANNEL_OFF   = 0,
88     AAC_CHANNEL_FRONT = 1,
89     AAC_CHANNEL_SIDE  = 2,
90     AAC_CHANNEL_BACK  = 3,
91     AAC_CHANNEL_LFE   = 4,
92     AAC_CHANNEL_CC    = 5,
93 };
94
95 /**
96  * The point during decoding at which channel coupling is applied.
97  */
98 enum CouplingPoint {
99     BEFORE_TNS,
100     BETWEEN_TNS_AND_IMDCT,
101     AFTER_IMDCT = 3,
102 };
103
104 /**
105  * Output configuration status
106  */
107 enum OCStatus {
108     OC_NONE,        ///< Output unconfigured
109     OC_TRIAL_PCE,   ///< Output configuration under trial specified by an inband PCE
110     OC_TRIAL_FRAME, ///< Output configuration under trial specified by a frame header
111     OC_GLOBAL_HDR,  ///< Output configuration set in a global header but not yet locked
112     OC_LOCKED,      ///< Output configuration locked in place
113 };
114
115 typedef struct {
116     MPEG4AudioConfig m4ac;
117     uint8_t layout_map[MAX_ELEM_ID*4][3];
118     int layout_map_tags;
119     int channels;
120     uint64_t channel_layout;
121     enum OCStatus status;
122 } OutputConfiguration;
123
124 /**
125  * Predictor State
126  */
127 typedef struct {
128     float cor0;
129     float cor1;
130     float var0;
131     float var1;
132     float r0;
133     float r1;
134 } PredictorState;
135
136 #define MAX_PREDICTORS 672
137
138 #define SCALE_DIV_512    36    ///< scalefactor difference that corresponds to scale difference in 512 times
139 #define SCALE_ONE_POS   140    ///< scalefactor index that corresponds to scale=1.0
140 #define SCALE_MAX_POS   255    ///< scalefactor index maximum value
141 #define SCALE_MAX_DIFF   60    ///< maximum scalefactor difference allowed by standard
142 #define SCALE_DIFF_ZERO  60    ///< codebook index corresponding to zero scalefactor indices difference
143 #define POW_SF2_ZERO    200    ///< ff_aac_pow2sf_tab index corresponding to pow(2, 0);
144
145 /**
146  * Long Term Prediction
147  */
148 typedef struct {
149     int8_t present;
150     int16_t lag;
151     float coef;
152     int8_t used[MAX_LTP_LONG_SFB];
153 } LongTermPrediction;
154
155 /**
156  * Individual Channel Stream
157  */
158 typedef struct {
159     uint8_t max_sfb;            ///< number of scalefactor bands per group
160     enum WindowSequence window_sequence[2];
161     uint8_t use_kb_window[2];   ///< If set, use Kaiser-Bessel window, otherwise use a sinus window.
162     int num_window_groups;
163     uint8_t group_len[8];
164     LongTermPrediction ltp;
165     const uint16_t *swb_offset; ///< table of offsets to the lowest spectral coefficient of a scalefactor band, sfb, for a particular window
166     const uint8_t *swb_sizes;   ///< table of scalefactor band sizes for a particular window
167     int num_swb;                ///< number of scalefactor window bands
168     int num_windows;
169     int tns_max_bands;
170     int predictor_present;
171     int predictor_initialized;
172     int predictor_reset_group;
173     uint8_t prediction_used[41];
174 } IndividualChannelStream;
175
176 /**
177  * Temporal Noise Shaping
178  */
179 typedef struct {
180     int present;
181     int n_filt[8];
182     int length[8][4];
183     int direction[8][4];
184     int order[8][4];
185     float coef[8][4][TNS_MAX_ORDER];
186 } TemporalNoiseShaping;
187
188 /**
189  * Dynamic Range Control - decoded from the bitstream but not processed further.
190  */
191 typedef struct {
192     int pce_instance_tag;                           ///< Indicates with which program the DRC info is associated.
193     int dyn_rng_sgn[17];                            ///< DRC sign information; 0 - positive, 1 - negative
194     int dyn_rng_ctl[17];                            ///< DRC magnitude information
195     int exclude_mask[MAX_CHANNELS];                 ///< Channels to be excluded from DRC processing.
196     int band_incr;                                  ///< Number of DRC bands greater than 1 having DRC info.
197     int interpolation_scheme;                       ///< Indicates the interpolation scheme used in the SBR QMF domain.
198     int band_top[17];                               ///< Indicates the top of the i-th DRC band in units of 4 spectral lines.
199     int prog_ref_level;                             /**< A reference level for the long-term program audio level for all
200                                                      *   channels combined.
201                                                      */
202 } DynamicRangeControl;
203
204 typedef struct {
205     int num_pulse;
206     int start;
207     int pos[4];
208     int amp[4];
209 } Pulse;
210
211 /**
212  * coupling parameters
213  */
214 typedef struct {
215     enum CouplingPoint coupling_point;  ///< The point during decoding at which coupling is applied.
216     int num_coupled;       ///< number of target elements
217     enum RawDataBlockType type[8];   ///< Type of channel element to be coupled - SCE or CPE.
218     int id_select[8];      ///< element id
219     int ch_select[8];      /**< [0] shared list of gains; [1] list of gains for right channel;
220                             *   [2] list of gains for left channel; [3] lists of gains for both channels
221                             */
222     float gain[16][120];
223 } ChannelCoupling;
224
225 /**
226  * Single Channel Element - used for both SCE and LFE elements.
227  */
228 typedef struct {
229     IndividualChannelStream ics;
230     TemporalNoiseShaping tns;
231     Pulse pulse;
232     enum BandType band_type[128];                   ///< band types
233     int band_type_run_end[120];                     ///< band type run end points
234     float sf[120];                                  ///< scalefactors
235     int sf_idx[128];                                ///< scalefactor indices (used by encoder)
236     uint8_t zeroes[128];                            ///< band is not coded (used by encoder)
237     DECLARE_ALIGNED(32, float,   coeffs)[1024];     ///< coefficients for IMDCT
238     DECLARE_ALIGNED(32, float,   saved)[1024];      ///< overlap
239     DECLARE_ALIGNED(32, float,   ret)[2048];        ///< PCM output
240     DECLARE_ALIGNED(16, float,   ltp_state)[3072];  ///< time signal for LTP
241     PredictorState predictor_state[MAX_PREDICTORS];
242 } SingleChannelElement;
243
244 /**
245  * channel element - generic struct for SCE/CPE/CCE/LFE
246  */
247 typedef struct {
248     // CPE specific
249     int common_window;        ///< Set if channels share a common 'IndividualChannelStream' in bitstream.
250     int     ms_mode;          ///< Signals mid/side stereo flags coding mode (used by encoder)
251     uint8_t ms_mask[128];     ///< Set if mid/side stereo is used for each scalefactor window band
252     // shared
253     SingleChannelElement ch[2];
254     // CCE specific
255     ChannelCoupling coup;
256     SpectralBandReplication sbr;
257 } ChannelElement;
258
259 /**
260  * main AAC context
261  */
262 typedef struct {
263     AVCodecContext *avctx;
264     AVFrame frame;
265
266     int is_saved;                 ///< Set if elements have stored overlap from previous frame.
267     DynamicRangeControl che_drc;
268
269     /**
270      * @name Channel element related data
271      * @{
272      */
273     ChannelElement          *che[4][MAX_ELEM_ID];
274     ChannelElement  *tag_che_map[4][MAX_ELEM_ID];
275     int tags_mapped;
276     /** @} */
277
278     /**
279      * @name temporary aligned temporary buffers
280      * (We do not want to have these on the stack.)
281      * @{
282      */
283     DECLARE_ALIGNED(32, float, buf_mdct)[1024];
284     /** @} */
285
286     /**
287      * @name Computed / set up during initialization
288      * @{
289      */
290     FFTContext mdct;
291     FFTContext mdct_small;
292     FFTContext mdct_ltp;
293     DSPContext dsp;
294     FmtConvertContext fmt_conv;
295     int random_state;
296     /** @} */
297
298     /**
299      * @name Members used for output interleaving
300      * @{
301      */
302     float *output_data[MAX_CHANNELS];                 ///< Points to each element's 'ret' buffer (PCM output).
303     /** @} */
304
305     DECLARE_ALIGNED(32, float, temp)[128];
306
307     OutputConfiguration oc[2];
308 } AACContext;
309
310 #endif /* AVCODEC_AAC_H */