The internal header libavutil/internal.h should not be used outside libavutil.
[libav.git] / libavcodec / ac3dec.h
CommitLineData
58ce349f 1/*
14b70628 2 * Common code between the AC-3 and E-AC-3 decoders
58ce349f
JR
3 * Copyright (c) 2007 Bartlomiej Wolowiec <bartek.wolowiec@gmail.com>
4 *
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg 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 * FFmpeg 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 FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22/**
bad5537e 23 * @file libavcodec/ac3.h
14b70628 24 * Common code between the AC-3 and E-AC-3 decoders.
58ce349f
JR
25 */
26
98790382
SS
27#ifndef AVCODEC_AC3DEC_H
28#define AVCODEC_AC3DEC_H
58ce349f 29
ec0350c9 30#include "libavutil/lfg.h"
58ce349f 31#include "ac3.h"
9106a698 32#include "get_bits.h"
58ce349f
JR
33#include "dsputil.h"
34
35/* override ac3.h to include coupling channel */
36#undef AC3_MAX_CHANNELS
37#define AC3_MAX_CHANNELS 7
38#define CPL_CH 0
39
40#define AC3_OUTPUT_LFEON 8
41
83ce7ff6
JR
42#define AC3_MAX_COEFS 256
43#define AC3_BLOCK_SIZE 256
54624396 44#define MAX_BLOCKS 6
83ce7ff6 45
58ce349f 46typedef struct {
2c4c2afa
JR
47 AVCodecContext *avctx; ///< parent context
48 GetBitContext gbc; ///< bitstream reader
49 uint8_t *input_buffer; ///< temp buffer to prevent overread
50
51///@defgroup bsi bit stream information
52///@{
be594ae4 53 int frame_type; ///< frame type (strmtyp)
2c4c2afa
JR
54 int substreamid; ///< substream identification
55 int frame_size; ///< current frame size, in bytes
56 int bit_rate; ///< stream bit rate, in bits-per-second
57 int sample_rate; ///< sample frequency, in Hz
58ce349f 58 int num_blocks; ///< number of audio blocks
be594ae4 59 int channel_mode; ///< channel mode (acmod)
bfeca7be 60 int channel_layout; ///< channel layout
2c4c2afa 61 int lfe_on; ///< lfe channel in use
bddadace 62 int channel_map; ///< custom channel map
2c4c2afa
JR
63 int center_mix_level; ///< Center mix level index
64 int surround_mix_level; ///< Surround mix level index
bddadace 65 int eac3; ///< indicates if current frame is E-AC-3
2c4c2afa
JR
66///@}
67
bddadace
JR
68///@defgroup audfrm frame syntax parameters
69 int snr_offset_strategy; ///< SNR offset strategy (snroffststr)
70 int block_switch_syntax; ///< block switch syntax enabled (blkswe)
71 int dither_flag_syntax; ///< dither flag syntax enabled (dithflage)
72 int bit_allocation_syntax; ///< bit allocation model syntax enabled (bamode)
73 int fast_gain_syntax; ///< fast gain codes enabled (frmfgaincode)
74 int dba_syntax; ///< delta bit allocation syntax enabled (dbaflde)
75 int skip_syntax; ///< skip field syntax enabled (skipflde)
76 ///@}
77
2c4c2afa 78///@defgroup cpl standard coupling
54624396 79 int cpl_in_use[MAX_BLOCKS]; ///< coupling in use (cplinu)
bddadace 80 int cpl_strategy_exists[MAX_BLOCKS]; ///< coupling strategy exists (cplstre)
be594ae4
JR
81 int channel_in_cpl[AC3_MAX_CHANNELS]; ///< channel in coupling (chincpl)
82 int phase_flags_in_use; ///< phase flags in use (phsflginu)
83 int phase_flags[18]; ///< phase flags (phsflg)
be594ae4 84 int num_cpl_bands; ///< number of coupling bands (ncplbnd)
0ffea243 85 uint8_t cpl_band_struct[18]; ///< coupling band structure (cplbndstrc)
bddadace
JR
86 int firstchincpl; ///< first channel in coupling
87 int first_cpl_coords[AC3_MAX_CHANNELS]; ///< first coupling coordinates states (firstcplcos)
be594ae4 88 int cpl_coords[AC3_MAX_CHANNELS][18]; ///< coupling coordinates (cplco)
2c4c2afa 89///@}
58ce349f 90
bddadace 91///@defgroup aht adaptive hybrid transform
1db9da52 92 int channel_uses_aht[AC3_MAX_CHANNELS]; ///< channel AHT in use (chahtinu)
a52d8c6b 93 int pre_mantissa[AC3_MAX_CHANNELS][AC3_MAX_COEFS][MAX_BLOCKS]; ///< pre-IDCT mantissas
bddadace
JR
94///@}
95
2c4c2afa 96///@defgroup channel channel
22885960
JR
97 int fbw_channels; ///< number of full-bandwidth channels
98 int channels; ///< number of total channels
99 int lfe_ch; ///< index of LFE channel
2c4c2afa 100 float downmix_coeffs[AC3_MAX_CHANNELS][2]; ///< stereo downmix coefficients
2c4c2afa 101 int downmixed; ///< indicates if coeffs are currently downmixed
22885960
JR
102 int output_mode; ///< output channel configuration
103 int out_channels; ///< number of output channels
2c4c2afa 104///@}
58ce349f 105
2c4c2afa 106///@defgroup dynrng dynamic range
58ce349f 107 float dynamic_range[2]; ///< dynamic range
2c4c2afa
JR
108///@}
109
110///@defgroup bandwidth bandwidth
be594ae4
JR
111 int start_freq[AC3_MAX_CHANNELS]; ///< start frequency bin (strtmant)
112 int end_freq[AC3_MAX_CHANNELS]; ///< end frequency bin (endmant)
2c4c2afa 113///@}
58ce349f 114
2c4c2afa 115///@defgroup rematrixing rematrixing
be594ae4
JR
116 int num_rematrixing_bands; ///< number of rematrixing bands (nrematbnd)
117 int rematrixing_flags[4]; ///< rematrixing flags (rematflg)
2c4c2afa
JR
118///@}
119
120///@defgroup exponents exponents
be594ae4 121 int num_exp_groups[AC3_MAX_CHANNELS]; ///< Number of exponent groups (nexpgrp)
83ce7ff6 122 int8_t dexps[AC3_MAX_CHANNELS][AC3_MAX_COEFS]; ///< decoded exponents
da04be10 123 int exp_strategy[MAX_BLOCKS][AC3_MAX_CHANNELS]; ///< exponent strategies (expstr)
2c4c2afa
JR
124///@}
125
126///@defgroup bitalloc bit allocation
d7a0ae07 127 AC3BitAllocParameters bit_alloc_params; ///< bit allocation parameters
bddadace 128 int first_cpl_leak; ///< first coupling leak state (firstcplleak)
be594ae4
JR
129 int snr_offset[AC3_MAX_CHANNELS]; ///< signal-to-noise ratio offsets (snroffst)
130 int fast_gain[AC3_MAX_CHANNELS]; ///< fast gain values/SMR's (fgain)
83ce7ff6
JR
131 uint8_t bap[AC3_MAX_CHANNELS][AC3_MAX_COEFS]; ///< bit allocation pointers
132 int16_t psd[AC3_MAX_CHANNELS][AC3_MAX_COEFS]; ///< scaled exponents
d7a0ae07
JR
133 int16_t band_psd[AC3_MAX_CHANNELS][50]; ///< interpolated exponents
134 int16_t mask[AC3_MAX_CHANNELS][50]; ///< masking curve values
135 int dba_mode[AC3_MAX_CHANNELS]; ///< delta bit allocation mode
136 int dba_nsegs[AC3_MAX_CHANNELS]; ///< number of delta segments
137 uint8_t dba_offsets[AC3_MAX_CHANNELS][8]; ///< delta segment offsets
138 uint8_t dba_lengths[AC3_MAX_CHANNELS][8]; ///< delta segment lengths
139 uint8_t dba_values[AC3_MAX_CHANNELS][8]; ///< delta values for each segment
2c4c2afa 140///@}
58ce349f 141
2c4c2afa 142///@defgroup dithering zero-mantissa dithering
be594ae4 143 int dither_flag[AC3_MAX_CHANNELS]; ///< dither flags (dithflg)
ec0350c9 144 AVLFG dith_state; ///< for dither generation
2c4c2afa 145///@}
58ce349f 146
2c4c2afa 147///@defgroup imdct IMDCT
be594ae4 148 int block_switch[AC3_MAX_CHANNELS]; ///< block switch flags (blksw)
58ce349f
JR
149 MDCTContext imdct_512; ///< for 512 sample IMDCT
150 MDCTContext imdct_256; ///< for 256 sample IMDCT
2c4c2afa
JR
151///@}
152
153///@defgroup opt optimization
22885960
JR
154 DSPContext dsp; ///< for optimization
155 float add_bias; ///< offset for float_to_int16 conversion
156 float mul_bias; ///< scaling for float_to_int16 conversion
2c4c2afa 157///@}
58ce349f 158
911e21a3 159 DECLARE_ALIGNED_16(int, fixed_coeffs[AC3_MAX_CHANNELS][AC3_MAX_COEFS]); ///> fixed-point transform coefficients
2c4c2afa
JR
160
161///@defgroup arrays aligned arrays
83ce7ff6
JR
162 DECLARE_ALIGNED_16(float, transform_coeffs[AC3_MAX_CHANNELS][AC3_MAX_COEFS]); ///< transform coefficients
163 DECLARE_ALIGNED_16(float, delay[AC3_MAX_CHANNELS][AC3_BLOCK_SIZE]); ///< delay - added to the next block
164 DECLARE_ALIGNED_16(float, window[AC3_BLOCK_SIZE]); ///< window coefficients
916d5d6c 165 DECLARE_ALIGNED_16(float, tmp_output[AC3_BLOCK_SIZE]); ///< temporary storage for output before windowing
83ce7ff6 166 DECLARE_ALIGNED_16(float, output[AC3_MAX_CHANNELS][AC3_BLOCK_SIZE]); ///< output after imdct transform and windowing
2c4c2afa 167///@}
58ce349f
JR
168} AC3DecodeContext;
169
8649e933
JR
170/**
171 * Parse the E-AC-3 frame header.
172 * This parses both the bit stream info and audio frame header.
173 */
174int ff_eac3_parse_header(AC3DecodeContext *s);
175
176/**
177 * Decode mantissas in a single channel for the entire frame.
178 * This is used when AHT mode is enabled.
179 */
180void ff_eac3_decode_transform_coeffs_aht_ch(AC3DecodeContext *s, int ch);
181
98790382 182#endif /* AVCODEC_AC3DEC_H */