8d3a311bfc0ae4f9a16b944ea27716f8d0a9d881
[ffmpeg.git] / libavcodec / ac3dec.h
1 /*
2  * Common code between the AC-3 and E-AC-3 decoders
3  * Copyright (c) 2007 Bartlomiej Wolowiec <bartek.wolowiec@gmail.com>
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * Common code between the AC-3 and E-AC-3 decoders.
25  *
26  * Summary of MDCT Coefficient Grouping:
27  * The individual MDCT coefficient indices are often referred to in the
28  * (E-)AC-3 specification as frequency bins.  These bins are grouped together
29  * into subbands of 12 coefficients each.  The subbands are grouped together
30  * into bands as defined in the bitstream by the band structures, which
31  * determine the number of bands and the size of each band.  The full spectrum
32  * of 256 frequency bins is divided into 1 DC bin + 21 subbands = 253 bins.
33  * This system of grouping coefficients is used for channel bandwidth, stereo
34  * rematrixing, channel coupling, enhanced coupling, and spectral extension.
35  *
36  * +-+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+-+
37  * |1|  |12|  |  [12|12|12|12]  |  |  |  |  |  |  |  |  |  |  |  |  |3|
38  * +-+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+-+
39  * ~~~  ~~~~     ~~~~~~~~~~~~~                                      ~~~
40  *  |     |            |                                             |
41  *  |     |            |                    3 unused frequency bins--+
42  *  |     |            |
43  *  |     |            +--1 band containing 4 subbands
44  *  |     |
45  *  |     +--1 subband of 12 frequency bins
46  *  |
47  *  +--DC frequency bin
48  */
49
50 #ifndef AVCODEC_AC3DEC_H
51 #define AVCODEC_AC3DEC_H
52
53 #include "libavutil/float_dsp.h"
54 #include "libavutil/lfg.h"
55 #include "ac3.h"
56 #include "ac3dsp.h"
57 #include "get_bits.h"
58 #include "dsputil.h"
59 #include "fft.h"
60 #include "fmtconvert.h"
61
62 #define AC3_OUTPUT_LFEON  8
63
64 #define SPX_MAX_BANDS    17
65
66 /** Large enough for maximum possible frame size when the specification limit is ignored */
67 #define AC3_FRAME_BUFFER_SIZE 32768
68
69 typedef struct AC3DecodeContext {
70     AVClass        *class;                  ///< class for AVOptions
71     AVCodecContext *avctx;                  ///< parent context
72     AVFrame frame;                          ///< AVFrame for decoded output
73     GetBitContext gbc;                      ///< bitstream reader
74
75 ///@name Bit stream information
76 ///@{
77     int frame_type;                         ///< frame type                             (strmtyp)
78     int substreamid;                        ///< substream identification
79     int frame_size;                         ///< current frame size, in bytes
80     int bit_rate;                           ///< stream bit rate, in bits-per-second
81     int sample_rate;                        ///< sample frequency, in Hz
82     int num_blocks;                         ///< number of audio blocks
83     int bitstream_mode;                     ///< bitstream mode                         (bsmod)
84     int channel_mode;                       ///< channel mode                           (acmod)
85     int channel_layout;                     ///< channel layout
86     int lfe_on;                             ///< lfe channel in use
87     int channel_map;                        ///< custom channel map
88     int center_mix_level;                   ///< Center mix level index
89     int surround_mix_level;                 ///< Surround mix level index
90     int eac3;                               ///< indicates if current frame is E-AC-3
91 ///@}
92
93 ///@name Frame syntax parameters
94     int snr_offset_strategy;                ///< SNR offset strategy                    (snroffststr)
95     int block_switch_syntax;                ///< block switch syntax enabled            (blkswe)
96     int dither_flag_syntax;                 ///< dither flag syntax enabled             (dithflage)
97     int bit_allocation_syntax;              ///< bit allocation model syntax enabled    (bamode)
98     int fast_gain_syntax;                   ///< fast gain codes enabled                (frmfgaincode)
99     int dba_syntax;                         ///< delta bit allocation syntax enabled    (dbaflde)
100     int skip_syntax;                        ///< skip field syntax enabled              (skipflde)
101  ///@}
102
103 ///@name Standard coupling
104     int cpl_in_use[AC3_MAX_BLOCKS];         ///< coupling in use                        (cplinu)
105     int cpl_strategy_exists[AC3_MAX_BLOCKS];///< coupling strategy exists               (cplstre)
106     int channel_in_cpl[AC3_MAX_CHANNELS];   ///< channel in coupling                    (chincpl)
107     int phase_flags_in_use;                 ///< phase flags in use                     (phsflginu)
108     int phase_flags[AC3_MAX_CPL_BANDS];     ///< phase flags                            (phsflg)
109     int num_cpl_bands;                      ///< number of coupling bands               (ncplbnd)
110     uint8_t cpl_band_sizes[AC3_MAX_CPL_BANDS]; ///< number of coeffs in each coupling band
111     int firstchincpl;                       ///< first channel in coupling
112     int first_cpl_coords[AC3_MAX_CHANNELS]; ///< first coupling coordinates states      (firstcplcos)
113     int cpl_coords[AC3_MAX_CHANNELS][AC3_MAX_CPL_BANDS]; ///< coupling coordinates      (cplco)
114 ///@}
115
116 ///@name Spectral extension
117 ///@{
118     int spx_in_use;                             ///< spectral extension in use              (spxinu)
119     uint8_t channel_uses_spx[AC3_MAX_CHANNELS]; ///< channel uses spectral extension        (chinspx)
120     int8_t spx_atten_code[AC3_MAX_CHANNELS];    ///< spx attenuation code                   (spxattencod)
121     int spx_src_start_freq;                     ///< spx start frequency bin
122     int spx_dst_end_freq;                       ///< spx end frequency bin
123     int spx_dst_start_freq;                     ///< spx starting frequency bin for copying (copystartmant)
124                                                 ///< the copy region ends at the start of the spx region.
125     int num_spx_bands;                          ///< number of spx bands                    (nspxbnds)
126     uint8_t spx_band_sizes[SPX_MAX_BANDS];      ///< number of bins in each spx band
127     uint8_t first_spx_coords[AC3_MAX_CHANNELS]; ///< first spx coordinates states           (firstspxcos)
128     float spx_noise_blend[AC3_MAX_CHANNELS][SPX_MAX_BANDS]; ///< spx noise blending factor  (nblendfact)
129     float spx_signal_blend[AC3_MAX_CHANNELS][SPX_MAX_BANDS];///< spx signal blending factor (sblendfact)
130 ///@}
131
132 ///@name Adaptive hybrid transform
133     int channel_uses_aht[AC3_MAX_CHANNELS];                         ///< channel AHT in use (chahtinu)
134     int pre_mantissa[AC3_MAX_CHANNELS][AC3_MAX_COEFS][AC3_MAX_BLOCKS];  ///< pre-IDCT mantissas
135 ///@}
136
137 ///@name Channel
138     int fbw_channels;                           ///< number of full-bandwidth channels
139     int channels;                               ///< number of total channels
140     int lfe_ch;                                 ///< index of LFE channel
141     float downmix_coeffs[AC3_MAX_CHANNELS][2];  ///< stereo downmix coefficients
142     int downmixed;                              ///< indicates if coeffs are currently downmixed
143     int output_mode;                            ///< output channel configuration
144     int out_channels;                           ///< number of output channels
145 ///@}
146
147 ///@name Dynamic range
148     float dynamic_range[2];                 ///< dynamic range
149     float drc_scale;                        ///< percentage of dynamic range compression to be applied
150 ///@}
151
152 ///@name Bandwidth
153     int start_freq[AC3_MAX_CHANNELS];       ///< start frequency bin                    (strtmant)
154     int end_freq[AC3_MAX_CHANNELS];         ///< end frequency bin                      (endmant)
155 ///@}
156
157 ///@name Rematrixing
158     int num_rematrixing_bands;              ///< number of rematrixing bands            (nrematbnd)
159     int rematrixing_flags[4];               ///< rematrixing flags                      (rematflg)
160 ///@}
161
162 ///@name Exponents
163     int num_exp_groups[AC3_MAX_CHANNELS];           ///< Number of exponent groups      (nexpgrp)
164     int8_t dexps[AC3_MAX_CHANNELS][AC3_MAX_COEFS];  ///< decoded exponents
165     int exp_strategy[AC3_MAX_BLOCKS][AC3_MAX_CHANNELS]; ///< exponent strategies        (expstr)
166 ///@}
167
168 ///@name Bit allocation
169     AC3BitAllocParameters bit_alloc_params;         ///< bit allocation parameters
170     int first_cpl_leak;                             ///< first coupling leak state      (firstcplleak)
171     int snr_offset[AC3_MAX_CHANNELS];               ///< signal-to-noise ratio offsets  (snroffst)
172     int fast_gain[AC3_MAX_CHANNELS];                ///< fast gain values/SMR's         (fgain)
173     uint8_t bap[AC3_MAX_CHANNELS][AC3_MAX_COEFS];   ///< bit allocation pointers
174     int16_t psd[AC3_MAX_CHANNELS][AC3_MAX_COEFS];   ///< scaled exponents
175     int16_t band_psd[AC3_MAX_CHANNELS][AC3_CRITICAL_BANDS]; ///< interpolated exponents
176     int16_t mask[AC3_MAX_CHANNELS][AC3_CRITICAL_BANDS];     ///< masking curve values
177     int dba_mode[AC3_MAX_CHANNELS];                 ///< delta bit allocation mode
178     int dba_nsegs[AC3_MAX_CHANNELS];                ///< number of delta segments
179     uint8_t dba_offsets[AC3_MAX_CHANNELS][8];       ///< delta segment offsets
180     uint8_t dba_lengths[AC3_MAX_CHANNELS][8];       ///< delta segment lengths
181     uint8_t dba_values[AC3_MAX_CHANNELS][8];        ///< delta values for each segment
182 ///@}
183
184 ///@name Zero-mantissa dithering
185     int dither_flag[AC3_MAX_CHANNELS];      ///< dither flags                           (dithflg)
186     AVLFG dith_state;                       ///< for dither generation
187 ///@}
188
189 ///@name IMDCT
190     int block_switch[AC3_MAX_CHANNELS];     ///< block switch flags                     (blksw)
191     FFTContext imdct_512;                   ///< for 512 sample IMDCT
192     FFTContext imdct_256;                   ///< for 256 sample IMDCT
193 ///@}
194
195 ///@name Optimization
196     DSPContext dsp;                         ///< for optimization
197     AVFloatDSPContext fdsp;
198     AC3DSPContext ac3dsp;
199     FmtConvertContext fmt_conv;             ///< optimized conversion functions
200 ///@}
201
202     float *outptr[AC3_MAX_CHANNELS];
203     float *xcfptr[AC3_MAX_CHANNELS];
204     float *dlyptr[AC3_MAX_CHANNELS];
205
206 ///@name Aligned arrays
207     DECLARE_ALIGNED(16, int,   fixed_coeffs)[AC3_MAX_CHANNELS][AC3_MAX_COEFS];       ///< fixed-point transform coefficients
208     DECLARE_ALIGNED(32, float, transform_coeffs)[AC3_MAX_CHANNELS][AC3_MAX_COEFS];   ///< transform coefficients
209     DECLARE_ALIGNED(32, float, delay)[AC3_MAX_CHANNELS][AC3_BLOCK_SIZE];             ///< delay - added to the next block
210     DECLARE_ALIGNED(32, float, window)[AC3_BLOCK_SIZE];                              ///< window coefficients
211     DECLARE_ALIGNED(32, float, tmp_output)[AC3_BLOCK_SIZE];                          ///< temporary storage for output before windowing
212     DECLARE_ALIGNED(32, float, output)[AC3_MAX_CHANNELS][AC3_BLOCK_SIZE];            ///< output after imdct transform and windowing
213     DECLARE_ALIGNED(32, uint8_t, input_buffer)[AC3_FRAME_BUFFER_SIZE + FF_INPUT_BUFFER_PADDING_SIZE]; ///< temp buffer to prevent overread
214 ///@}
215 } AC3DecodeContext;
216
217 /**
218  * Parse the E-AC-3 frame header.
219  * This parses both the bit stream info and audio frame header.
220  */
221 int ff_eac3_parse_header(AC3DecodeContext *s);
222
223 /**
224  * Decode mantissas in a single channel for the entire frame.
225  * This is used when AHT mode is enabled.
226  */
227 void ff_eac3_decode_transform_coeffs_aht_ch(AC3DecodeContext *s, int ch);
228
229 /**
230  * Apply spectral extension to each channel by copying lower frequency
231  * coefficients to higher frequency bins and applying side information to
232  * approximate the original high frequency signal.
233  */
234 void ff_eac3_apply_spectral_extension(AC3DecodeContext *s);
235
236 #endif /* AVCODEC_AC3DEC_H */