aac.h 12.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*
 * AAC definitions and structures
 * Copyright (c) 2005-2006 Oded Shimon ( ods15 ods15 dyndns org )
 * Copyright (c) 2006-2007 Maxim Gavrilov ( maxim.gavrilov gmail com )
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
24
 * @file
25 26 27 28 29
 * AAC definitions and structures
 * @author Oded Shimon  ( ods15 ods15 dyndns org )
 * @author Maxim Gavrilov ( maxim.gavrilov gmail com )
 */

30 31
#ifndef AVCODEC_AAC_H
#define AVCODEC_AAC_H
32

33

34
#include "aac_defines.h"
35
#include "libavutil/float_dsp.h"
36
#include "libavutil/fixed_dsp.h"
37
#include "avcodec.h"
38
#if !USE_FIXED
39
#include "imdct15.h"
40
#endif
41
#include "fft.h"
42
#include "mpeg4audio.h"
43
#include "sbr.h"
44 45 46

#include <stdint.h>

47
#define MAX_CHANNELS 64
48
#define MAX_ELEM_ID 16
49

50
#define TNS_MAX_ORDER 20
51
#define MAX_LTP_LONG_SFB 40
52

53 54
#define CLIP_AVOIDANCE_FACTOR 0.95f

55 56 57 58 59 60 61 62 63 64 65
enum RawDataBlockType {
    TYPE_SCE,
    TYPE_CPE,
    TYPE_CCE,
    TYPE_LFE,
    TYPE_DSE,
    TYPE_PCE,
    TYPE_FIL,
    TYPE_END,
};

66 67 68 69 70 71 72 73 74
enum ExtensionPayloadID {
    EXT_FILL,
    EXT_FILL_DATA,
    EXT_DATA_ELEMENT,
    EXT_DYNAMIC_RANGE = 0xb,
    EXT_SBR_DATA      = 0xd,
    EXT_SBR_DATA_CRC  = 0xe,
};

75 76 77 78 79 80 81
enum WindowSequence {
    ONLY_LONG_SEQUENCE,
    LONG_START_SEQUENCE,
    EIGHT_SHORT_SEQUENCE,
    LONG_STOP_SEQUENCE,
};

82 83 84 85
enum BandType {
    ZERO_BT        = 0,     ///< Scalefactors and spectral data are all zero.
    FIRST_PAIR_BT  = 5,     ///< This and later band types encode two values (rather than four) with one code word.
    ESC_BT         = 11,    ///< Spectral data are coded with an escape sequence.
86
    RESERVED_BT    = 12,    ///< Band types following are encoded differently from others.
87
    NOISE_BT       = 13,    ///< Spectral data are scaled white noise not coded in the bitstream.
88 89
    INTENSITY_BT2  = 14,    ///< Scalefactor data are intensity stereo positions (out of phase).
    INTENSITY_BT   = 15,    ///< Scalefactor data are intensity stereo positions (in phase).
90 91
};

92
#define IS_CODEBOOK_UNSIGNED(x) (((x) - 1) & 10)
93 94

enum ChannelPosition {
95
    AAC_CHANNEL_OFF   = 0,
96 97 98 99 100 101 102
    AAC_CHANNEL_FRONT = 1,
    AAC_CHANNEL_SIDE  = 2,
    AAC_CHANNEL_BACK  = 3,
    AAC_CHANNEL_LFE   = 4,
    AAC_CHANNEL_CC    = 5,
};

103 104 105 106 107 108 109 110 111
/**
 * The point during decoding at which channel coupling is applied.
 */
enum CouplingPoint {
    BEFORE_TNS,
    BETWEEN_TNS_AND_IMDCT,
    AFTER_IMDCT = 3,
};

112 113 114 115
/**
 * Output configuration status
 */
enum OCStatus {
116 117 118 119 120
    OC_NONE,        ///< Output unconfigured
    OC_TRIAL_PCE,   ///< Output configuration under trial specified by an inband PCE
    OC_TRIAL_FRAME, ///< Output configuration under trial specified by a frame header
    OC_GLOBAL_HDR,  ///< Output configuration set in a global header but not yet locked
    OC_LOCKED,      ///< Output configuration locked in place
121 122
};

123
typedef struct OutputConfiguration {
124 125 126 127 128 129 130 131
    MPEG4AudioConfig m4ac;
    uint8_t layout_map[MAX_ELEM_ID*4][3];
    int layout_map_tags;
    int channels;
    uint64_t channel_layout;
    enum OCStatus status;
} OutputConfiguration;

132 133 134
/**
 * Predictor State
 */
135
typedef struct PredictorState {
136 137 138 139 140 141
    AAC_FLOAT cor0;
    AAC_FLOAT cor1;
    AAC_FLOAT var0;
    AAC_FLOAT var1;
    AAC_FLOAT r0;
    AAC_FLOAT r1;
142 143
    AAC_FLOAT k1;
    AAC_FLOAT x_est;
144 145 146 147
} PredictorState;

#define MAX_PREDICTORS 672

148 149 150 151 152 153
#define SCALE_DIV_512    36    ///< scalefactor difference that corresponds to scale difference in 512 times
#define SCALE_ONE_POS   140    ///< scalefactor index that corresponds to scale=1.0
#define SCALE_MAX_POS   255    ///< scalefactor index maximum value
#define SCALE_MAX_DIFF   60    ///< maximum scalefactor difference allowed by standard
#define SCALE_DIFF_ZERO  60    ///< codebook index corresponding to zero scalefactor indices difference

154 155
#define NOISE_PRE       256    ///< preamble for NOISE_BT, put in bitstream with the first noise band
#define NOISE_PRE_BITS    9    ///< length of preamble
156
#define NOISE_OFFSET     90    ///< subtracted from global gain, used as offset for the preamble
157

158 159 160
/**
 * Long Term Prediction
 */
161
typedef struct LongTermPrediction {
162 163
    int8_t present;
    int16_t lag;
164
    int coef_idx;
165
    INTFLOAT coef;
166 167 168
    int8_t used[MAX_LTP_LONG_SFB];
} LongTermPrediction;

169 170 171
/**
 * Individual Channel Stream
 */
172
typedef struct IndividualChannelStream {
173 174
    uint8_t max_sfb;            ///< number of scalefactor bands per group
    enum WindowSequence window_sequence[2];
Diego Biurrun's avatar
Diego Biurrun committed
175
    uint8_t use_kb_window[2];   ///< If set, use Kaiser-Bessel window, otherwise use a sine window.
176 177
    int num_window_groups;
    uint8_t group_len[8];
178
    LongTermPrediction ltp;
179
    const uint16_t *swb_offset; ///< table of offsets to the lowest spectral coefficient of a scalefactor band, sfb, for a particular window
180
    const uint8_t *swb_sizes;   ///< table of scalefactor band sizes for a particular window
181 182 183
    int num_swb;                ///< number of scalefactor window bands
    int num_windows;
    int tns_max_bands;
184 185 186
    int predictor_present;
    int predictor_initialized;
    int predictor_reset_group;
187
    int predictor_reset_count[31];  ///< used by encoder to count prediction resets
188
    uint8_t prediction_used[41];
189 190
    uint8_t window_clipping[8]; ///< set if a certain window is near clipping
    float clip_avoidance_factor; ///< set if any window is near clipping to the necessary atennuation factor to avoid it
191
} IndividualChannelStream;
192

193 194 195
/**
 * Temporal Noise Shaping
 */
196
typedef struct TemporalNoiseShaping {
197 198 199 200 201
    int present;
    int n_filt[8];
    int length[8][4];
    int direction[8][4];
    int order[8][4];
202
    int coef_idx[8][4][TNS_MAX_ORDER];
203
    INTFLOAT coef[8][4][TNS_MAX_ORDER];
204 205
} TemporalNoiseShaping;

206 207 208
/**
 * Dynamic Range Control - decoded from the bitstream but not processed further.
 */
209
typedef struct DynamicRangeControl {
210 211 212 213 214 215 216 217 218 219 220 221
    int pce_instance_tag;                           ///< Indicates with which program the DRC info is associated.
    int dyn_rng_sgn[17];                            ///< DRC sign information; 0 - positive, 1 - negative
    int dyn_rng_ctl[17];                            ///< DRC magnitude information
    int exclude_mask[MAX_CHANNELS];                 ///< Channels to be excluded from DRC processing.
    int band_incr;                                  ///< Number of DRC bands greater than 1 having DRC info.
    int interpolation_scheme;                       ///< Indicates the interpolation scheme used in the SBR QMF domain.
    int band_top[17];                               ///< Indicates the top of the i-th DRC band in units of 4 spectral lines.
    int prog_ref_level;                             /**< A reference level for the long-term program audio level for all
                                                     *   channels combined.
                                                     */
} DynamicRangeControl;

222
typedef struct Pulse {
223
    int num_pulse;
224
    int start;
225
    int pos[4];
226 227 228 229 230 231
    int amp[4];
} Pulse;

/**
 * coupling parameters
 */
232
typedef struct ChannelCoupling {
233 234 235 236
    enum CouplingPoint coupling_point;  ///< The point during decoding at which coupling is applied.
    int num_coupled;       ///< number of target elements
    enum RawDataBlockType type[8];   ///< Type of channel element to be coupled - SCE or CPE.
    int id_select[8];      ///< element id
237 238
    int ch_select[8];      /**< [0] shared list of gains; [1] list of gains for right channel;
                            *   [2] list of gains for left channel; [3] lists of gains for both channels
239
                            */
240
    INTFLOAT gain[16][120];
241 242 243 244 245
} ChannelCoupling;

/**
 * Single Channel Element - used for both SCE and LFE elements.
 */
246
typedef struct SingleChannelElement {
247 248
    IndividualChannelStream ics;
    TemporalNoiseShaping tns;
249
    Pulse pulse;
250
    enum BandType band_type[128];                   ///< band types
251
    enum BandType band_alt[128];                    ///< alternative band type (used by encoder)
252
    int band_type_run_end[120];                     ///< band type run end points
253
    INTFLOAT sf[120];                               ///< scalefactors
254 255
    int sf_idx[128];                                ///< scalefactor indices (used by encoder)
    uint8_t zeroes[128];                            ///< band is not coded (used by encoder)
256
    uint8_t can_pns[128];                           ///< band is allowed to PNS (informative)
257 258
    float  is_ener[128];                            ///< Intensity stereo pos (used by encoder)
    float pns_ener[128];                            ///< Noise energy values (used by encoder)
259 260 261 262 263
    DECLARE_ALIGNED(32, INTFLOAT, pcoeffs)[1024];   ///< coefficients for IMDCT, pristine
    DECLARE_ALIGNED(32, INTFLOAT, coeffs)[1024];    ///< coefficients for IMDCT, maybe processed
    DECLARE_ALIGNED(32, INTFLOAT, saved)[1536];     ///< overlap
    DECLARE_ALIGNED(32, INTFLOAT, ret_buf)[2048];   ///< PCM output buffer
    DECLARE_ALIGNED(16, INTFLOAT, ltp_state)[3072]; ///< time signal for LTP
264
    DECLARE_ALIGNED(32, AAC_FLOAT, lcoeffs)[1024];  ///< MDCT of LTP coefficients (used by encoder)
265
    DECLARE_ALIGNED(32, AAC_FLOAT, prcoeffs)[1024]; ///< Main prediction coefs (used by encoder)
266
    PredictorState predictor_state[MAX_PREDICTORS];
267
    INTFLOAT *ret;                                  ///< PCM output
268 269 270 271 272
} SingleChannelElement;

/**
 * channel element - generic struct for SCE/CPE/CCE/LFE
 */
273
typedef struct ChannelElement {
274
    int present;
275
    // CPE specific
276 277
    int common_window;        ///< Set if channels share a common 'IndividualChannelStream' in bitstream.
    int     ms_mode;          ///< Signals mid/side stereo flags coding mode (used by encoder)
278
    uint8_t is_mode;          ///< Set if any bands have been encoded using intensity stereo (used by encoder)
279
    uint8_t ms_mask[128];     ///< Set if mid/side stereo is used for each scalefactor window band
280
    uint8_t is_mask[128];     ///< Set if intensity stereo is used (used by encoder)
281 282 283 284
    // shared
    SingleChannelElement ch[2];
    // CCE specific
    ChannelCoupling coup;
285
    SpectralBandReplication sbr;
286
} ChannelElement;
287

288 289 290
/**
 * main AAC context
 */
291
struct AACContext {
292
    AVClass        *class;
Alex Converse's avatar
Alex Converse committed
293
    AVCodecContext *avctx;
294
    AVFrame *frame;
295

296 297 298
    int is_saved;                 ///< Set if elements have stored overlap from previous frame.
    DynamicRangeControl che_drc;

299
    /**
300
     * @name Channel element related data
301 302
     * @{
     */
Alex Converse's avatar
Alex Converse committed
303 304
    ChannelElement          *che[4][MAX_ELEM_ID];
    ChannelElement  *tag_che_map[4][MAX_ELEM_ID];
305
    int tags_mapped;
306
    int warned_remapping_once;
307
    /** @} */
308

309
    /**
310 311
     * @name temporary aligned temporary buffers
     * (We do not want to have these on the stack.)
312 313
     * @{
     */
314
    DECLARE_ALIGNED(32, INTFLOAT, buf_mdct)[1024];
315 316
    /** @} */

317
    /**
318
     * @name Computed / set up during initialization
319 320
     * @{
     */
321 322
    FFTContext mdct;
    FFTContext mdct_small;
323
    FFTContext mdct_ld;
324
    FFTContext mdct_ltp;
325 326 327
#if USE_FIXED
    AVFixedDSPContext *fdsp;
#else
328
    IMDCT15Context *mdct480;
329
    AVFloatDSPContext *fdsp;
330
#endif /* USE_FIXED */
331
    int random_state;
332 333 334
    /** @} */

    /**
335
     * @name Members used for output
336 337
     * @{
     */
338
    SingleChannelElement *output_element[MAX_CHANNELS]; ///< Points to each SingleChannelElement
339 340
    /** @} */

341 342 343 344 345

    /**
     * @name Japanese DTV specific extension
     * @{
     */
346
    int force_dmono_mode;///< 0->not dmono, 1->use first channel, 2->use second channel
347
    int dmono_mode;      ///< 0->not dmono, 1->use first channel, 2->use second channel
348 349
    /** @} */

350
    DECLARE_ALIGNED(32, INTFLOAT, temp)[128];
351

352
    OutputConfiguration oc[2];
353
    int warned_num_aac_frames;
354 355 356 357

    /* aacdec functions pointers */
    void (*imdct_and_windowing)(AACContext *ac, SingleChannelElement *sce);
    void (*apply_ltp)(AACContext *ac, SingleChannelElement *sce);
358
    void (*apply_tns)(INTFLOAT coef[1024], TemporalNoiseShaping *tns,
359
                      IndividualChannelStream *ics, int decode);
360 361
    void (*windowing_and_mdct_ltp)(AACContext *ac, INTFLOAT *out,
                                   INTFLOAT *in, IndividualChannelStream *ics);
362
    void (*update_ltp)(AACContext *ac, SingleChannelElement *sce);
363 364
    void (*vector_pow43)(int *coefs, int len);
    void (*subband_scale)(int *dst, int *src, int scale, int offset, int len);
365 366 367 368

};

void ff_aacdec_init_mips(AACContext *c);
369

370
#endif /* AVCODEC_AAC_H */