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