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