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