04553e7a46ed9982a30d94cc5e0bc7d043ca9c4c
[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 FFmpeg.
7  *
8  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 #ifndef USE_FIXED
34 #define USE_FIXED 0
35 #endif
36
37 #if USE_FIXED
38
39 #include "libavutil/softfloat.h"
40
41 #define FFT_FLOAT    0
42 #define FFT_FIXED_32 1
43
44 #define Q30(x)              (int)((x)*1073741824.0 + 0.5)
45 #define Q31(x)              (int)((x)*2147483648.0 + 0.5)
46
47 #else
48
49 #define FFT_FLOAT    1
50 #define FFT_FIXED_32 0
51
52 #define Q30(x)              x
53 #define Q31(x)              x
54 #endif /* USE_FIXED */
55
56 #include "libavutil/float_dsp.h"
57 #include "avcodec.h"
58 #include "imdct15.h"
59 #include "fft.h"
60 #include "mpeg4audio.h"
61 #include "sbr.h"
62
63 #include <stdint.h>
64
65 #define MAX_CHANNELS 64
66 #define MAX_ELEM_ID 16
67
68 #define TNS_MAX_ORDER 20
69 #define MAX_LTP_LONG_SFB 40
70
71 enum RawDataBlockType {
72     TYPE_SCE,
73     TYPE_CPE,
74     TYPE_CCE,
75     TYPE_LFE,
76     TYPE_DSE,
77     TYPE_PCE,
78     TYPE_FIL,
79     TYPE_END,
80 };
81
82 enum ExtensionPayloadID {
83     EXT_FILL,
84     EXT_FILL_DATA,
85     EXT_DATA_ELEMENT,
86     EXT_DYNAMIC_RANGE = 0xb,
87     EXT_SBR_DATA      = 0xd,
88     EXT_SBR_DATA_CRC  = 0xe,
89 };
90
91 enum WindowSequence {
92     ONLY_LONG_SEQUENCE,
93     LONG_START_SEQUENCE,
94     EIGHT_SHORT_SEQUENCE,
95     LONG_STOP_SEQUENCE,
96 };
97
98 enum BandType {
99     ZERO_BT        = 0,     ///< Scalefactors and spectral data are all zero.
100     FIRST_PAIR_BT  = 5,     ///< This and later band types encode two values (rather than four) with one code word.
101     ESC_BT         = 11,    ///< Spectral data are coded with an escape sequence.
102     RESERVED_BT    = 12,    ///< Band types following are encoded differently from others.
103     NOISE_BT       = 13,    ///< Spectral data are scaled white noise not coded in the bitstream.
104     INTENSITY_BT2  = 14,    ///< Scalefactor data are intensity stereo positions (out of phase).
105     INTENSITY_BT   = 15,    ///< Scalefactor data are intensity stereo positions (in phase).
106 };
107
108 #define IS_CODEBOOK_UNSIGNED(x) (((x) - 1) & 10)
109
110 enum ChannelPosition {
111     AAC_CHANNEL_OFF   = 0,
112     AAC_CHANNEL_FRONT = 1,
113     AAC_CHANNEL_SIDE  = 2,
114     AAC_CHANNEL_BACK  = 3,
115     AAC_CHANNEL_LFE   = 4,
116     AAC_CHANNEL_CC    = 5,
117 };
118
119 /**
120  * The point during decoding at which channel coupling is applied.
121  */
122 enum CouplingPoint {
123     BEFORE_TNS,
124     BETWEEN_TNS_AND_IMDCT,
125     AFTER_IMDCT = 3,
126 };
127
128 /**
129  * Output configuration status
130  */
131 enum OCStatus {
132     OC_NONE,        ///< Output unconfigured
133     OC_TRIAL_PCE,   ///< Output configuration under trial specified by an inband PCE
134     OC_TRIAL_FRAME, ///< Output configuration under trial specified by a frame header
135     OC_GLOBAL_HDR,  ///< Output configuration set in a global header but not yet locked
136     OC_LOCKED,      ///< Output configuration locked in place
137 };
138
139 typedef struct OutputConfiguration {
140     MPEG4AudioConfig m4ac;
141     uint8_t layout_map[MAX_ELEM_ID*4][3];
142     int layout_map_tags;
143     int channels;
144     uint64_t channel_layout;
145     enum OCStatus status;
146 } OutputConfiguration;
147
148 /**
149  * Predictor State
150  */
151 typedef struct PredictorState {
152     float cor0;
153     float cor1;
154     float var0;
155     float var1;
156     float r0;
157     float r1;
158 } PredictorState;
159
160 #define MAX_PREDICTORS 672
161
162 #define SCALE_DIV_512    36    ///< scalefactor difference that corresponds to scale difference in 512 times
163 #define SCALE_ONE_POS   140    ///< scalefactor index that corresponds to scale=1.0
164 #define SCALE_MAX_POS   255    ///< scalefactor index maximum value
165 #define SCALE_MAX_DIFF   60    ///< maximum scalefactor difference allowed by standard
166 #define SCALE_DIFF_ZERO  60    ///< codebook index corresponding to zero scalefactor indices difference
167
168 #define NOISE_PRE       256    ///< preamble for NOISE_BT, put in bitstream with the first noise band
169 #define NOISE_PRE_BITS    9    ///< length of preamble
170 #define NOISE_OFFSET     90    ///< subtracted from global gain, used as offset for the preamble
171
172 /**
173  * Long Term Prediction
174  */
175 typedef struct LongTermPrediction {
176     int8_t present;
177     int16_t lag;
178     float coef;
179     int8_t used[MAX_LTP_LONG_SFB];
180 } LongTermPrediction;
181
182 /**
183  * Individual Channel Stream
184  */
185 typedef struct IndividualChannelStream {
186     uint8_t max_sfb;            ///< number of scalefactor bands per group
187     enum WindowSequence window_sequence[2];
188     uint8_t use_kb_window[2];   ///< If set, use Kaiser-Bessel window, otherwise use a sine window.
189     int num_window_groups;
190     uint8_t group_len[8];
191     LongTermPrediction ltp;
192     const uint16_t *swb_offset; ///< table of offsets to the lowest spectral coefficient of a scalefactor band, sfb, for a particular window
193     const uint8_t *swb_sizes;   ///< table of scalefactor band sizes for a particular window
194     int num_swb;                ///< number of scalefactor window bands
195     int num_windows;
196     int tns_max_bands;
197     int predictor_present;
198     int predictor_initialized;
199     int predictor_reset_group;
200     uint8_t prediction_used[41];
201 } IndividualChannelStream;
202
203 /**
204  * Temporal Noise Shaping
205  */
206 typedef struct TemporalNoiseShaping {
207     int present;
208     int n_filt[8];
209     int length[8][4];
210     int direction[8][4];
211     int order[8][4];
212     float coef[8][4][TNS_MAX_ORDER];
213 } TemporalNoiseShaping;
214
215 /**
216  * Dynamic Range Control - decoded from the bitstream but not processed further.
217  */
218 typedef struct DynamicRangeControl {
219     int pce_instance_tag;                           ///< Indicates with which program the DRC info is associated.
220     int dyn_rng_sgn[17];                            ///< DRC sign information; 0 - positive, 1 - negative
221     int dyn_rng_ctl[17];                            ///< DRC magnitude information
222     int exclude_mask[MAX_CHANNELS];                 ///< Channels to be excluded from DRC processing.
223     int band_incr;                                  ///< Number of DRC bands greater than 1 having DRC info.
224     int interpolation_scheme;                       ///< Indicates the interpolation scheme used in the SBR QMF domain.
225     int band_top[17];                               ///< Indicates the top of the i-th DRC band in units of 4 spectral lines.
226     int prog_ref_level;                             /**< A reference level for the long-term program audio level for all
227                                                      *   channels combined.
228                                                      */
229 } DynamicRangeControl;
230
231 typedef struct Pulse {
232     int num_pulse;
233     int start;
234     int pos[4];
235     int amp[4];
236 } Pulse;
237
238 /**
239  * coupling parameters
240  */
241 typedef struct ChannelCoupling {
242     enum CouplingPoint coupling_point;  ///< The point during decoding at which coupling is applied.
243     int num_coupled;       ///< number of target elements
244     enum RawDataBlockType type[8];   ///< Type of channel element to be coupled - SCE or CPE.
245     int id_select[8];      ///< element id
246     int ch_select[8];      /**< [0] shared list of gains; [1] list of gains for right channel;
247                             *   [2] list of gains for left channel; [3] lists of gains for both channels
248                             */
249     float gain[16][120];
250 } ChannelCoupling;
251
252 /**
253  * Single Channel Element - used for both SCE and LFE elements.
254  */
255 typedef struct SingleChannelElement {
256     IndividualChannelStream ics;
257     TemporalNoiseShaping tns;
258     Pulse pulse;
259     enum BandType band_type[128];                   ///< band types
260     int band_type_run_end[120];                     ///< band type run end points
261     float sf[120];                                  ///< scalefactors
262     int sf_idx[128];                                ///< scalefactor indices (used by encoder)
263     uint8_t zeroes[128];                            ///< band is not coded (used by encoder)
264     float  is_ener[128];                            ///< Intensity stereo pos (used by encoder)
265     float pns_ener[128];                            ///< Noise energy values (used by encoder)
266     DECLARE_ALIGNED(32, float,   pcoeffs)[1024];    ///< coefficients for IMDCT, pristine
267     DECLARE_ALIGNED(32, float,   coeffs)[1024];     ///< coefficients for IMDCT, maybe processed
268     DECLARE_ALIGNED(32, float,   saved)[1536];      ///< overlap
269     DECLARE_ALIGNED(32, float,   ret_buf)[2048];    ///< PCM output buffer
270     DECLARE_ALIGNED(16, float,   ltp_state)[3072];  ///< time signal for LTP
271     PredictorState predictor_state[MAX_PREDICTORS];
272     float *ret;                                     ///< PCM output
273 } SingleChannelElement;
274
275 /**
276  * channel element - generic struct for SCE/CPE/CCE/LFE
277  */
278 typedef struct ChannelElement {
279     int present;
280     // CPE specific
281     int common_window;        ///< Set if channels share a common 'IndividualChannelStream' in bitstream.
282     int     ms_mode;          ///< Signals mid/side stereo flags coding mode (used by encoder)
283     uint8_t is_mode;          ///< Set if any bands have been encoded using intensity stereo (used by encoder)
284     uint8_t ms_mask[128];     ///< Set if mid/side stereo is used for each scalefactor window band
285     uint8_t is_mask[128];     ///< Set if intensity stereo is used (used by encoder)
286     // shared
287     SingleChannelElement ch[2];
288     // CCE specific
289     ChannelCoupling coup;
290     SpectralBandReplication sbr;
291 } ChannelElement;
292
293 /**
294  * main AAC context
295  */
296 struct AACContext {
297     AVClass        *class;
298     AVCodecContext *avctx;
299     AVFrame *frame;
300
301     int is_saved;                 ///< Set if elements have stored overlap from previous frame.
302     DynamicRangeControl che_drc;
303
304     /**
305      * @name Channel element related data
306      * @{
307      */
308     ChannelElement          *che[4][MAX_ELEM_ID];
309     ChannelElement  *tag_che_map[4][MAX_ELEM_ID];
310     int tags_mapped;
311     int warned_remapping_once;
312     /** @} */
313
314     /**
315      * @name temporary aligned temporary buffers
316      * (We do not want to have these on the stack.)
317      * @{
318      */
319     DECLARE_ALIGNED(32, float, buf_mdct)[1024];
320     /** @} */
321
322     /**
323      * @name Computed / set up during initialization
324      * @{
325      */
326     FFTContext mdct;
327     FFTContext mdct_small;
328     FFTContext mdct_ld;
329     FFTContext mdct_ltp;
330     IMDCT15Context *mdct480;
331     AVFloatDSPContext *fdsp;
332     int random_state;
333     /** @} */
334
335     /**
336      * @name Members used for output
337      * @{
338      */
339     SingleChannelElement *output_element[MAX_CHANNELS]; ///< Points to each SingleChannelElement
340     /** @} */
341
342
343     /**
344      * @name Japanese DTV specific extension
345      * @{
346      */
347     int force_dmono_mode;///< 0->not dmono, 1->use first channel, 2->use second channel
348     int dmono_mode;      ///< 0->not dmono, 1->use first channel, 2->use second channel
349     /** @} */
350
351     DECLARE_ALIGNED(32, float, temp)[128];
352
353     OutputConfiguration oc[2];
354     int warned_num_aac_frames;
355
356     /* aacdec functions pointers */
357     void (*imdct_and_windowing)(AACContext *ac, SingleChannelElement *sce);
358     void (*apply_ltp)(AACContext *ac, SingleChannelElement *sce);
359     void (*apply_tns)(float coef[1024], TemporalNoiseShaping *tns,
360                       IndividualChannelStream *ics, int decode);
361     void (*windowing_and_mdct_ltp)(AACContext *ac, float *out,
362                                    float *in, IndividualChannelStream *ics);
363     void (*update_ltp)(AACContext *ac, SingleChannelElement *sce);
364
365 };
366
367 void ff_aacdec_init_mips(AACContext *c);
368
369 #endif /* AVCODEC_AAC_H */