ac3enc: dynamically allocate AC3EncodeContext fields windowed_samples and mdct
[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 #if CONFIG_AC3ENC_FLOAT
44 #define MAC_COEF(d,a,b) ((d)+=(a)*(b))
45 typedef float SampleType;
46 typedef float CoefType;
47 typedef float CoefSumType;
48 #else
49 #define MAC_COEF(d,a,b) MAC64(d,a,b)
50 typedef int16_t SampleType;
51 typedef int32_t CoefType;
52 typedef int64_t CoefSumType;
53 #endif
54
55 typedef struct AC3MDCTContext {
56     const SampleType *window;           ///< MDCT window function
57     FFTContext fft;                     ///< FFT context for MDCT calculation
58 } AC3MDCTContext;
59
60 /**
61  * Encoding Options used by AVOption.
62  */
63 typedef struct AC3EncOptions {
64     /* AC-3 metadata options*/
65     int dialogue_level;
66     int bitstream_mode;
67     float center_mix_level;
68     float surround_mix_level;
69     int dolby_surround_mode;
70     int audio_production_info;
71     int mixing_level;
72     int room_type;
73     int copyright;
74     int original;
75     int extended_bsi_1;
76     int preferred_stereo_downmix;
77     float ltrt_center_mix_level;
78     float ltrt_surround_mix_level;
79     float loro_center_mix_level;
80     float loro_surround_mix_level;
81     int extended_bsi_2;
82     int dolby_surround_ex_mode;
83     int dolby_headphone_mode;
84     int ad_converter_type;
85
86     /* other encoding options */
87     int allow_per_frame_metadata;
88     int stereo_rematrixing;
89     int channel_coupling;
90     int cpl_start;
91 } AC3EncOptions;
92
93 /**
94  * Data for a single audio block.
95  */
96 typedef struct AC3Block {
97     CoefType **mdct_coef;                       ///< MDCT coefficients
98     int32_t  **fixed_coef;                      ///< fixed-point MDCT coefficients
99     uint8_t  **exp;                             ///< original exponents
100     uint8_t  **grouped_exp;                     ///< grouped exponents
101     int16_t  **psd;                             ///< psd per frequency bin
102     int16_t  **band_psd;                        ///< psd per critical band
103     int16_t  **mask;                            ///< masking curve
104     uint16_t **qmant;                           ///< quantized mantissas
105     uint8_t  **cpl_coord_exp;                   ///< coupling coord exponents           (cplcoexp)
106     uint8_t  **cpl_coord_mant;                  ///< coupling coord mantissas           (cplcomant)
107     uint8_t  coeff_shift[AC3_MAX_CHANNELS];     ///< fixed-point coefficient shift values
108     uint8_t  new_rematrixing_strategy;          ///< send new rematrixing flags in this block
109     int      num_rematrixing_bands;             ///< number of rematrixing bands
110     uint8_t  rematrixing_flags[4];              ///< rematrixing flags
111     int      new_cpl_strategy;                  ///< send new coupling strategy
112     int      cpl_in_use;                        ///< coupling in use for this block     (cplinu)
113     uint8_t  channel_in_cpl[AC3_MAX_CHANNELS];  ///< channel in coupling                (chincpl)
114     int      num_cpl_channels;                  ///< number of channels in coupling
115     uint8_t  new_cpl_coords;                    ///< send new coupling coordinates      (cplcoe)
116     uint8_t  cpl_master_exp[AC3_MAX_CHANNELS];  ///< coupling coord master exponents    (mstrcplco)
117     int      new_snr_offsets;                   ///< send new SNR offsets
118     int      new_cpl_leak;                      ///< send new coupling leak info
119     int      end_freq[AC3_MAX_CHANNELS];        ///< end frequency bin                  (endmant)
120 } AC3Block;
121
122 /**
123  * AC-3 encoder private context.
124  */
125 typedef struct AC3EncodeContext {
126     AVClass *av_class;                      ///< AVClass used for AVOption
127     AC3EncOptions options;                  ///< encoding options
128     PutBitContext pb;                       ///< bitstream writer context
129     DSPContext dsp;
130     AC3DSPContext ac3dsp;                   ///< AC-3 optimized functions
131     AC3MDCTContext *mdct;                   ///< MDCT context
132
133     AC3Block blocks[AC3_MAX_BLOCKS];        ///< per-block info
134
135     int eac3;                               ///< indicates if this is E-AC-3 vs. AC-3
136     int bitstream_id;                       ///< bitstream id                           (bsid)
137     int bitstream_mode;                     ///< bitstream mode                         (bsmod)
138
139     int bit_rate;                           ///< target bit rate, in bits-per-second
140     int sample_rate;                        ///< sampling frequency, in Hz
141
142     int frame_size_min;                     ///< minimum frame size in case rounding is necessary
143     int frame_size;                         ///< current frame size in bytes
144     int frame_size_code;                    ///< frame size code                        (frmsizecod)
145     uint16_t crc_inv[2];
146     int64_t bits_written;                   ///< bit count    (used to avg. bitrate)
147     int64_t samples_written;                ///< sample count (used to avg. bitrate)
148
149     int fbw_channels;                       ///< number of full-bandwidth channels      (nfchans)
150     int channels;                           ///< total number of channels               (nchans)
151     int lfe_on;                             ///< indicates if there is an LFE channel   (lfeon)
152     int lfe_channel;                        ///< channel index of the LFE channel
153     int has_center;                         ///< indicates if there is a center channel
154     int has_surround;                       ///< indicates if there are one or more surround channels
155     int channel_mode;                       ///< channel mode                           (acmod)
156     const uint8_t *channel_map;             ///< channel map used to reorder channels
157
158     int center_mix_level;                   ///< center mix level code
159     int surround_mix_level;                 ///< surround mix level code
160     int ltrt_center_mix_level;              ///< Lt/Rt center mix level code
161     int ltrt_surround_mix_level;            ///< Lt/Rt surround mix level code
162     int loro_center_mix_level;              ///< Lo/Ro center mix level code
163     int loro_surround_mix_level;            ///< Lo/Ro surround mix level code
164
165     int cutoff;                             ///< user-specified cutoff frequency, in Hz
166     int bandwidth_code;                     ///< bandwidth code (0 to 60)               (chbwcod)
167     int start_freq[AC3_MAX_CHANNELS];       ///< start frequency bin                    (strtmant)
168     int cpl_end_freq;                       ///< coupling channel end frequency bin
169
170     int cpl_on;                             ///< coupling turned on for this frame
171     int cpl_enabled;                        ///< coupling enabled for all frames
172     int num_cpl_subbands;                   ///< number of coupling subbands            (ncplsubnd)
173     int num_cpl_bands;                      ///< number of coupling bands               (ncplbnd)
174     uint8_t cpl_band_sizes[AC3_MAX_CPL_BANDS];  ///< number of coeffs in each coupling band
175
176     int rematrixing_enabled;                ///< stereo rematrixing enabled
177
178     /* bitrate allocation control */
179     int slow_gain_code;                     ///< slow gain code                         (sgaincod)
180     int slow_decay_code;                    ///< slow decay code                        (sdcycod)
181     int fast_decay_code;                    ///< fast decay code                        (fdcycod)
182     int db_per_bit_code;                    ///< dB/bit code                            (dbpbcod)
183     int floor_code;                         ///< floor code                             (floorcod)
184     AC3BitAllocParameters bit_alloc;        ///< bit allocation parameters
185     int coarse_snr_offset;                  ///< coarse SNR offsets                     (csnroffst)
186     int fast_gain_code[AC3_MAX_CHANNELS];   ///< fast gain codes (signal-to-mask ratio) (fgaincod)
187     int fine_snr_offset[AC3_MAX_CHANNELS];  ///< fine SNR offsets                       (fsnroffst)
188     int frame_bits_fixed;                   ///< number of non-coefficient bits for fixed parameters
189     int frame_bits;                         ///< all frame bits except exponents and mantissas
190     int exponent_bits;                      ///< number of bits used for exponents
191
192     SampleType *windowed_samples;
193     SampleType **planar_samples;
194     uint8_t *bap_buffer;
195     uint8_t *bap1_buffer;
196     CoefType *mdct_coef_buffer;
197     int32_t *fixed_coef_buffer;
198     uint8_t *exp_buffer;
199     uint8_t *grouped_exp_buffer;
200     int16_t *psd_buffer;
201     int16_t *band_psd_buffer;
202     int16_t *mask_buffer;
203     uint16_t *qmant_buffer;
204     uint8_t *cpl_coord_exp_buffer;
205     uint8_t *cpl_coord_mant_buffer;
206
207     uint8_t exp_strategy[AC3_MAX_CHANNELS][AC3_MAX_BLOCKS]; ///< exponent strategies
208     uint8_t exp_ref_block[AC3_MAX_CHANNELS][AC3_MAX_BLOCKS]; ///< reference blocks for EXP_REUSE
209     uint8_t *ref_bap     [AC3_MAX_CHANNELS][AC3_MAX_BLOCKS]; ///< bit allocation pointers (bap)
210     int ref_bap_set;                                         ///< indicates if ref_bap pointers have been set
211
212     void (*output_frame_header)(struct AC3EncodeContext *s);
213 } AC3EncodeContext;
214
215 #endif /* AVCODEC_AC3ENC_H */