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