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