libavcodec/ac3enc.h

   1 /*
   2  * AC-3 encoder & E-AC-3 encoder common header
   3  * Copyright (c) 2000 Fabrice Bellard
   4  * Copyright (c) 2006-2010 Justin Ruggles <justin.ruggles@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  * AC-3 encoder & E-AC-3 encoder common header
  26  */
  27
  28 #ifndef AVCODEC_AC3ENC_H
  29 #define AVCODEC_AC3ENC_H
  30
  31 #include <stdint.h>
  32 #include "ac3.h"
  33 #include "ac3dsp.h"
  34 #include "avcodec.h"
  35 #include "dsputil.h"
  36 #include "put_bits.h"
  37 #include "fft.h"
  38
  39 #ifndef CONFIG_AC3ENC_FLOAT
  40 #define CONFIG_AC3ENC_FLOAT 0
  41 #endif
  42
  43 #define OFFSET(param) offsetof(AC3EncodeContext, options.param)
  44 #define AC3ENC_PARAM (AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM)
  45
  46 #define AC3ENC_TYPE_AC3_FIXED   0
  47 #define AC3ENC_TYPE_AC3         1
  48 #define AC3ENC_TYPE_EAC3        2
  49
  50 #if CONFIG_AC3ENC_FLOAT
  51 #define AC3_NAME(x) ff_ac3_float_ ## x
  52 #define MAC_COEF(d,a,b) ((d)+=(a)*(b))
  53 #define COEF_MIN (-16777215.0/16777216.0)
  54 #define COEF_MAX ( 16777215.0/16777216.0)
  55 typedef float SampleType;
  56 typedef float CoefType;
  57 typedef float CoefSumType;
  58 #else
  59 #define AC3_NAME(x) ff_ac3_fixed_ ## x
  60 #define MAC_COEF(d,a,b) MAC64(d,a,b)
  61 #define COEF_MIN -16777215
  62 #define COEF_MAX  16777215
  63 typedef int16_t SampleType;
  64 typedef int32_t CoefType;
  65 typedef int64_t CoefSumType;
  66 #endif
  67
  68 /* common option values */
  69 #define AC3ENC_OPT_NONE            -1
  70 #define AC3ENC_OPT_AUTO            -1
  71 #define AC3ENC_OPT_OFF              0
  72 #define AC3ENC_OPT_ON               1
  73 #define AC3ENC_OPT_NOT_INDICATED    0
  74 #define AC3ENC_OPT_MODE_ON          1
  75 #define AC3ENC_OPT_MODE_OFF         2
  76
  77 /* specific option values */
  78 #define AC3ENC_OPT_LARGE_ROOM       1
  79 #define AC3ENC_OPT_SMALL_ROOM       2
  80 #define AC3ENC_OPT_DOWNMIX_LTRT     1
  81 #define AC3ENC_OPT_DOWNMIX_LORO     2
  82 #define AC3ENC_OPT_ADCONV_STANDARD  0
  83 #define AC3ENC_OPT_ADCONV_HDCD      1
  84
  85
  86 #if 0
  87 /**
  88  * Encoding Options used by AVOption.
  89  */
  90 typedef struct AC3EncOptions {
  91     /* AC-3 metadata options*/
  92     int dialogue_level;
  93     int bitstream_mode;
  94     float center_mix_level;
  95     float surround_mix_level;
  96     int dolby_surround_mode;
  97     int audio_production_info;
  98     int mixing_level;
  99     int room_type;
 100     int copyright;
 101     int original;
 102     int extended_bsi_1;
 103     int preferred_stereo_downmix;
 104     float ltrt_center_mix_level;
 105     float ltrt_surround_mix_level;
 106     float loro_center_mix_level;
 107     float loro_surround_mix_level;
 108     int extended_bsi_2;
 109     int dolby_surround_ex_mode;
 110     int dolby_headphone_mode;
 111     int ad_converter_type;
 112     int eac3_mixing_metadata;
 113     int eac3_info_metadata;
 114
 115     /* other encoding options */
 116     int allow_per_frame_metadata;
 117     int stereo_rematrixing;
 118     int channel_coupling;
 119     int cpl_start;
 120 } AC3EncOptions;
 121 #endif
 122 /**
 123  * Data for a single audio block.
 124  */
 125 typedef struct AC3Block {
 126     CoefType **mdct_coef;                       ///< MDCT coefficients
 127     int32_t  **fixed_coef;                      ///< fixed-point MDCT coefficients
 128     uint8_t  **exp;                             ///< original exponents
 129     uint8_t  **grouped_exp;                     ///< grouped exponents
 130     int16_t  **psd;                             ///< psd per frequency bin
 131     int16_t  **band_psd;                        ///< psd per critical band
 132     int16_t  **mask;                            ///< masking curve
 133     uint16_t **qmant;                           ///< quantized mantissas
 134     uint8_t  **cpl_coord_exp;                   ///< coupling coord exponents           (cplcoexp)
 135     uint8_t  **cpl_coord_mant;                  ///< coupling coord mantissas           (cplcomant)
 136     uint8_t  coeff_shift[AC3_MAX_CHANNELS];     ///< fixed-point coefficient shift values
 137     uint8_t  new_rematrixing_strategy;          ///< send new rematrixing flags in this block
 138     int      num_rematrixing_bands;             ///< number of rematrixing bands
 139     uint8_t  rematrixing_flags[4];              ///< rematrixing flags
 140     int      new_cpl_strategy;                  ///< send new coupling strategy
 141     int      cpl_in_use;                        ///< coupling in use for this block     (cplinu)
 142     uint8_t  channel_in_cpl[AC3_MAX_CHANNELS];  ///< channel in coupling                (chincpl)
 143     int      num_cpl_channels;                  ///< number of channels in coupling
 144     uint8_t  new_cpl_coords[AC3_MAX_CHANNELS];  ///< send new coupling coordinates      (cplcoe)
 145     uint8_t  cpl_master_exp[AC3_MAX_CHANNELS];  ///< coupling coord master exponents    (mstrcplco)
 146     int      new_snr_offsets;                   ///< send new SNR offsets
 147     int      new_cpl_leak;                      ///< send new coupling leak info
 148     int      end_freq[AC3_MAX_CHANNELS];        ///< end frequency bin                  (endmant)
 149 } AC3Block;
 150
 151 /**
 152  * AC-3 encoder private context.
 153  */
 154 typedef struct AC3EncodeContext {
 155     AVClass *av_class;                      ///< AVClass used for AVOption
 156     AC3EncOptions options;                  ///< encoding options
 157     AVCodecContext *avctx;                  ///< parent AVCodecContext
 158     PutBitContext pb;                       ///< bitstream writer context
 159     DSPContext dsp;
 160     AC3DSPContext ac3dsp;                   ///< AC-3 optimized functions
 161     FFTContext mdct;                        ///< FFT context for MDCT calculation
 162     const SampleType *mdct_window;          ///< MDCT window function array
 163
 164     AC3Block blocks[AC3_MAX_BLOCKS];        ///< per-block info
 165
 166     int fixed_point;                        ///< indicates if fixed-point encoder is being used
 167     int eac3;                               ///< indicates if this is E-AC-3 vs. AC-3
 168     int bitstream_id;                       ///< bitstream id                           (bsid)
 169     int bitstream_mode;                     ///< bitstream mode                         (bsmod)
 170
 171     int bit_rate;                           ///< target bit rate, in bits-per-second
 172     int sample_rate;                        ///< sampling frequency, in Hz
 173
 174     int num_blks_code;                      ///< number of blocks code                  (numblkscod)
 175     int num_blocks;                         ///< number of blocks per frame
 176     int frame_size_min;                     ///< minimum frame size in case rounding is necessary
 177     int frame_size;                         ///< current frame size in bytes
 178     int frame_size_code;                    ///< frame size code                        (frmsizecod)
 179     uint16_t crc_inv[2];
 180     int64_t bits_written;                   ///< bit count    (used to avg. bitrate)
 181     int64_t samples_written;                ///< sample count (used to avg. bitrate)
 182
 183     int fbw_channels;                       ///< number of full-bandwidth channels      (nfchans)
 184     int channels;                           ///< total number of channels               (nchans)
 185     int lfe_on;                             ///< indicates if there is an LFE channel   (lfeon)
 186     int lfe_channel;                        ///< channel index of the LFE channel
 187     int has_center;                         ///< indicates if there is a center channel
 188     int has_surround;                       ///< indicates if there are one or more surround channels
 189     int channel_mode;                       ///< channel mode                           (acmod)
 190     const uint8_t *channel_map;             ///< channel map used to reorder channels
 191
 192     int center_mix_level;                   ///< center mix level code
 193     int surround_mix_level;                 ///< surround mix level code
 194     int ltrt_center_mix_level;              ///< Lt/Rt center mix level code
 195     int ltrt_surround_mix_level;            ///< Lt/Rt surround mix level code
 196     int loro_center_mix_level;              ///< Lo/Ro center mix level code
 197     int loro_surround_mix_level;            ///< Lo/Ro surround mix level code
 198
 199     int cutoff;                             ///< user-specified cutoff frequency, in Hz
 200     int bandwidth_code;                     ///< bandwidth code (0 to 60)               (chbwcod)
 201     int start_freq[AC3_MAX_CHANNELS];       ///< start frequency bin                    (strtmant)
 202     int cpl_end_freq;                       ///< coupling channel end frequency bin
 203
 204     int cpl_on;                             ///< coupling turned on for this frame
 205     int cpl_enabled;                        ///< coupling enabled for all frames
 206     int num_cpl_subbands;                   ///< number of coupling subbands            (ncplsubnd)
 207     int num_cpl_bands;                      ///< number of coupling bands               (ncplbnd)
 208     uint8_t cpl_band_sizes[AC3_MAX_CPL_BANDS];  ///< number of coeffs in each coupling band
 209
 210     int rematrixing_enabled;                ///< stereo rematrixing enabled
 211
 212     /* bitrate allocation control */
 213     int slow_gain_code;                     ///< slow gain code                         (sgaincod)
 214     int slow_decay_code;                    ///< slow decay code                        (sdcycod)
 215     int fast_decay_code;                    ///< fast decay code                        (fdcycod)
 216     int db_per_bit_code;                    ///< dB/bit code                            (dbpbcod)
 217     int floor_code;                         ///< floor code                             (floorcod)
 218     AC3BitAllocParameters bit_alloc;        ///< bit allocation parameters
 219     int coarse_snr_offset;                  ///< coarse SNR offsets                     (csnroffst)
 220     int fast_gain_code[AC3_MAX_CHANNELS];   ///< fast gain codes (signal-to-mask ratio) (fgaincod)
 221     int fine_snr_offset[AC3_MAX_CHANNELS];  ///< fine SNR offsets                       (fsnroffst)
 222     int frame_bits_fixed;                   ///< number of non-coefficient bits for fixed parameters
 223     int frame_bits;                         ///< all frame bits except exponents and mantissas
 224     int exponent_bits;                      ///< number of bits used for exponents
 225
 226     SampleType *windowed_samples;
 227     SampleType **planar_samples;
 228     uint8_t *bap_buffer;
 229     uint8_t *bap1_buffer;
 230     CoefType *mdct_coef_buffer;
 231     int32_t *fixed_coef_buffer;
 232     uint8_t *exp_buffer;
 233     uint8_t *grouped_exp_buffer;
 234     int16_t *psd_buffer;
 235     int16_t *band_psd_buffer;
 236     int16_t *mask_buffer;
 237     int16_t *qmant_buffer;
 238     uint8_t *cpl_coord_exp_buffer;
 239     uint8_t *cpl_coord_mant_buffer;
 240
 241     uint8_t exp_strategy[AC3_MAX_CHANNELS][AC3_MAX_BLOCKS]; ///< exponent strategies
 242     uint8_t frame_exp_strategy[AC3_MAX_CHANNELS];           ///< frame exp strategy index
 243     int use_frame_exp_strategy;                             ///< indicates use of frame exp strategy
 244     uint8_t exp_ref_block[AC3_MAX_CHANNELS][AC3_MAX_BLOCKS]; ///< reference blocks for EXP_REUSE
 245     uint8_t *ref_bap     [AC3_MAX_CHANNELS][AC3_MAX_BLOCKS]; ///< bit allocation pointers (bap)
 246     int ref_bap_set;                                         ///< indicates if ref_bap pointers have been set
 247
 248     /* fixed vs. float function pointers */
 249     void (*mdct_end)(struct AC3EncodeContext *s);
 250     int  (*mdct_init)(struct AC3EncodeContext *s);
 251
 252     /* fixed vs. float templated function pointers */
 253     int  (*allocate_sample_buffers)(struct AC3EncodeContext *s);
 254
 255     /* AC-3 vs. E-AC-3 function pointers */
 256     void (*output_frame_header)(struct AC3EncodeContext *s);
 257 } AC3EncodeContext;
 258
 259
 260 int ff_ac3_encode_init(AVCodecContext *avctx);
 261
 262 int ff_ac3_encode_close(AVCodecContext *avctx);
 263
 264 int ff_ac3_validate_metadata(AC3EncodeContext *s);
 265
 266 void ff_ac3_adjust_frame_size(AC3EncodeContext *s);
 267
 268 void ff_ac3_compute_coupling_strategy(AC3EncodeContext *s);
 269
 270 void ff_ac3_apply_rematrixing(AC3EncodeContext *s);
 271
 272 void ff_ac3_process_exponents(AC3EncodeContext *s);
 273
 274 int ff_ac3_compute_bit_allocation(AC3EncodeContext *s);
 275
 276 void ff_ac3_group_exponents(AC3EncodeContext *s);
 277
 278 void ff_ac3_quantize_mantissas(AC3EncodeContext *s);
 279
 280 void ff_ac3_output_frame(AC3EncodeContext *s, unsigned char *frame);
 281
 282
 283 /* prototypes for functions in ac3enc_fixed.c and ac3enc_float.c */
 284
 285 void ff_ac3_fixed_mdct_end(AC3EncodeContext *s);
 286 void ff_ac3_float_mdct_end(AC3EncodeContext *s);
 287
 288 int ff_ac3_fixed_mdct_init(AC3EncodeContext *s);
 289 int ff_ac3_float_mdct_init(AC3EncodeContext *s);
 290
 291
 292 /* prototypes for functions in ac3enc_template.c */
 293
 294 int ff_ac3_fixed_allocate_sample_buffers(AC3EncodeContext *s);
 295 int ff_ac3_float_allocate_sample_buffers(AC3EncodeContext *s);
 296
 297 int ff_ac3_fixed_encode_frame(AVCodecContext *avctx, unsigned char *frame,
 298                               int buf_size, void *data);
 299 int ff_ac3_float_encode_frame(AVCodecContext *avctx, unsigned char *frame,
 300                               int buf_size, void *data);
 301
 302 #endif /* AVCODEC_AC3ENC_H */