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 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 * 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 33 #include "ac3.h" 34 #include "ac3dsp.h" 35 #include "avcodec.h" 36 #include "fft.h" 37 #include "mathops.h" 38 #include "me_cmp.h" 39 #include "put_bits.h" 40 #include "audiodsp.h" 41 42 #ifndef AC3ENC_FLOAT 43 #define AC3ENC_FLOAT 0 44 #endif 45 46 #if AC3ENC_FLOAT 47 #include "libavutil/float_dsp.h" 48 #define AC3_NAME(x) ff_ac3_float_ ## x 49 #define MAC_COEF(d,a,b) ((d)+=(a)*(b)) 50 #define COEF_MIN (-16777215.0/16777216.0) 51 #define COEF_MAX ( 16777215.0/16777216.0) 52 #define NEW_CPL_COORD_THRESHOLD 0.03 53 typedef float SampleType; 54 typedef float CoefType; 55 typedef float CoefSumType; 56 #else 57 #include "libavutil/fixed_dsp.h" 58 #define AC3_NAME(x) ff_ac3_fixed_ ## x 59 #define MAC_COEF(d,a,b) MAC64(d,a,b) 60 #define COEF_MIN -16777215 61 #define COEF_MAX 16777215 62 #define NEW_CPL_COORD_THRESHOLD 503317 63 typedef int32_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 2 75 #define AC3ENC_OPT_MODE_OFF 1 76 #define AC3ENC_OPT_DSUREX_DPLIIZ 3 77 78 /* specific option values */ 79 #define AC3ENC_OPT_LARGE_ROOM 1 80 #define AC3ENC_OPT_SMALL_ROOM 2 81 #define AC3ENC_OPT_DOWNMIX_LTRT 1 82 #define AC3ENC_OPT_DOWNMIX_LORO 2 83 #define AC3ENC_OPT_DOWNMIX_DPLII 3 // reserved value in A/52, but used by encoders to indicate DPL2 84 #define AC3ENC_OPT_ADCONV_STANDARD 0 85 #define AC3ENC_OPT_ADCONV_HDCD 1 86 87 88 /** 89 * Encoding Options used by AVOption. 90 */ 91 typedef struct AC3EncOptions { 92 /* AC-3 metadata options*/ 93 int dialogue_level; 94 int bitstream_mode; 95 float center_mix_level; 96 float surround_mix_level; 97 int dolby_surround_mode; 98 int audio_production_info; 99 int mixing_level; 100 int room_type; 101 int copyright; 102 int original; 103 int extended_bsi_1; 104 int preferred_stereo_downmix; 105 float ltrt_center_mix_level; 106 float ltrt_surround_mix_level; 107 float loro_center_mix_level; 108 float loro_surround_mix_level; 109 int extended_bsi_2; 110 int dolby_surround_ex_mode; 111 int dolby_headphone_mode; 112 int ad_converter_type; 113 int eac3_mixing_metadata; 114 int eac3_info_metadata; 115 116 /* other encoding options */ 117 int allow_per_frame_metadata; 118 int stereo_rematrixing; 119 int channel_coupling; 120 int cpl_start; 121 } AC3EncOptions; 122 123 /** 124 * Data for a single audio block. 125 */ 126 typedef struct AC3Block { 127 CoefType **mdct_coef; ///< MDCT coefficients 128 int32_t **fixed_coef; ///< fixed-point MDCT coefficients 129 uint8_t **exp; ///< original exponents 130 uint8_t **grouped_exp; ///< grouped exponents 131 int16_t **psd; ///< psd per frequency bin 132 int16_t **band_psd; ///< psd per critical band 133 int16_t **mask; ///< masking curve 134 uint16_t **qmant; ///< quantized mantissas 135 uint8_t **cpl_coord_exp; ///< coupling coord exponents (cplcoexp) 136 uint8_t **cpl_coord_mant; ///< coupling coord mantissas (cplcomant) 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 AudioDSPContext adsp; 160 #if AC3ENC_FLOAT 161 AVFloatDSPContext *fdsp; 162 #else 163 AVFixedDSPContext *fdsp; 164 #endif 165 MECmpContext mecc; 166 AC3DSPContext ac3dsp; ///< AC-3 optimized functions 167 FFTContext mdct; ///< FFT context for MDCT calculation 168 const SampleType *mdct_window; ///< MDCT window function array 169 170 AC3Block blocks[AC3_MAX_BLOCKS]; ///< per-block info 171 172 int fixed_point; ///< indicates if fixed-point encoder is being used 173 int eac3; ///< indicates if this is E-AC-3 vs. AC-3 174 int bitstream_id; ///< bitstream id (bsid) 175 int bitstream_mode; ///< bitstream mode (bsmod) 176 177 int bit_rate; ///< target bit rate, in bits-per-second 178 int sample_rate; ///< sampling frequency, in Hz 179 180 int num_blks_code; ///< number of blocks code (numblkscod) 181 int num_blocks; ///< number of blocks per frame 182 int frame_size_min; ///< minimum frame size in case rounding is necessary 183 int frame_size; ///< current frame size in bytes 184 int frame_size_code; ///< frame size code (frmsizecod) 185 uint16_t crc_inv[2]; 186 int64_t bits_written; ///< bit count (used to avg. bitrate) 187 int64_t samples_written; ///< sample count (used to avg. bitrate) 188 189 int fbw_channels; ///< number of full-bandwidth channels (nfchans) 190 int channels; ///< total number of channels (nchans) 191 int lfe_on; ///< indicates if there is an LFE channel (lfeon) 192 int lfe_channel; ///< channel index of the LFE channel 193 int has_center; ///< indicates if there is a center channel 194 int has_surround; ///< indicates if there are one or more surround channels 195 int channel_mode; ///< channel mode (acmod) 196 const uint8_t *channel_map; ///< channel map used to reorder channels 197 198 int center_mix_level; ///< center mix level code 199 int surround_mix_level; ///< surround mix level code 200 int ltrt_center_mix_level; ///< Lt/Rt center mix level code 201 int ltrt_surround_mix_level; ///< Lt/Rt surround mix level code 202 int loro_center_mix_level; ///< Lo/Ro center mix level code 203 int loro_surround_mix_level; ///< Lo/Ro surround mix level code 204 205 int cutoff; ///< user-specified cutoff frequency, in Hz 206 int bandwidth_code; ///< bandwidth code (0 to 60) (chbwcod) 207 int start_freq[AC3_MAX_CHANNELS]; ///< start frequency bin (strtmant) 208 int cpl_end_freq; ///< coupling channel end frequency bin 209 210 int cpl_on; ///< coupling turned on for this frame 211 int cpl_enabled; ///< coupling enabled for all frames 212 int num_cpl_subbands; ///< number of coupling subbands (ncplsubnd) 213 int num_cpl_bands; ///< number of coupling bands (ncplbnd) 214 uint8_t cpl_band_sizes[AC3_MAX_CPL_BANDS]; ///< number of coeffs in each coupling band 215 216 int rematrixing_enabled; ///< stereo rematrixing enabled 217 218 /* bitrate allocation control */ 219 int slow_gain_code; ///< slow gain code (sgaincod) 220 int slow_decay_code; ///< slow decay code (sdcycod) 221 int fast_decay_code; ///< fast decay code (fdcycod) 222 int db_per_bit_code; ///< dB/bit code (dbpbcod) 223 int floor_code; ///< floor code (floorcod) 224 AC3BitAllocParameters bit_alloc; ///< bit allocation parameters 225 int coarse_snr_offset; ///< coarse SNR offsets (csnroffst) 226 int fast_gain_code[AC3_MAX_CHANNELS]; ///< fast gain codes (signal-to-mask ratio) (fgaincod) 227 int fine_snr_offset[AC3_MAX_CHANNELS]; ///< fine SNR offsets (fsnroffst) 228 int frame_bits_fixed; ///< number of non-coefficient bits for fixed parameters 229 int frame_bits; ///< all frame bits except exponents and mantissas 230 int exponent_bits; ///< number of bits used for exponents 231 232 SampleType *windowed_samples; 233 SampleType **planar_samples; 234 uint8_t *bap_buffer; 235 uint8_t *bap1_buffer; 236 CoefType *mdct_coef_buffer; 237 int32_t *fixed_coef_buffer; 238 uint8_t *exp_buffer; 239 uint8_t *grouped_exp_buffer; 240 int16_t *psd_buffer; 241 int16_t *band_psd_buffer; 242 int16_t *mask_buffer; 243 int16_t *qmant_buffer; 244 uint8_t *cpl_coord_exp_buffer; 245 uint8_t *cpl_coord_mant_buffer; 246 247 uint8_t exp_strategy[AC3_MAX_CHANNELS][AC3_MAX_BLOCKS]; ///< exponent strategies 248 uint8_t frame_exp_strategy[AC3_MAX_CHANNELS]; ///< frame exp strategy index 249 int use_frame_exp_strategy; ///< indicates use of frame exp strategy 250 uint8_t exp_ref_block[AC3_MAX_CHANNELS][AC3_MAX_BLOCKS]; ///< reference blocks for EXP_REUSE 251 uint8_t *ref_bap [AC3_MAX_CHANNELS][AC3_MAX_BLOCKS]; ///< bit allocation pointers (bap) 252 int ref_bap_set; ///< indicates if ref_bap pointers have been set 253 254 int warned_alternate_bitstream; 255 256 /* fixed vs. float function pointers */ 257 void (*mdct_end)(struct AC3EncodeContext *s); 258 int (*mdct_init)(struct AC3EncodeContext *s); 259 260 /* fixed vs. float templated function pointers */ 261 int (*allocate_sample_buffers)(struct AC3EncodeContext *s); 262 263 /* AC-3 vs. E-AC-3 function pointers */ 264 void (*output_frame_header)(struct AC3EncodeContext *s); 265 } AC3EncodeContext; 266 267 268 extern const uint64_t ff_ac3_channel_layouts[19]; 269 extern const AVOption ff_ac3_enc_options[]; 270 extern const AVCodecDefault ff_ac3_enc_defaults[]; 271 272 int ff_ac3_encode_init(AVCodecContext *avctx); 273 int ff_ac3_float_encode_init(AVCodecContext *avctx); 274 275 int ff_ac3_encode_close(AVCodecContext *avctx); 276 277 int ff_ac3_validate_metadata(AC3EncodeContext *s); 278 279 void ff_ac3_adjust_frame_size(AC3EncodeContext *s); 280 281 void ff_ac3_compute_coupling_strategy(AC3EncodeContext *s); 282 283 int ff_ac3_encode_frame_common_end(AVCodecContext *avctx, AVPacket *avpkt, 284 const AVFrame *frame, int *got_packet_ptr); 285 286 /* prototypes for functions in ac3enc_template.c */ 287 288 int ff_ac3_fixed_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, 289 const AVFrame *frame, int *got_packet_ptr); 290 int ff_ac3_float_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, 291 const AVFrame *frame, int *got_packet_ptr); 292 293 #endif /* AVCODEC_AC3ENC_H */ 294