FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ac3.h
Go to the documentation of this file.
1 /*
2  * Common code between the AC-3 encoder and decoder
3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
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 /**
23  * @file
24  * Common code between the AC-3 encoder and decoder.
25  */
26 
27 #ifndef AVCODEC_AC3_H
28 #define AVCODEC_AC3_H
29 
30 #define AC3_MAX_CODED_FRAME_SIZE 3840 /* in bytes */
31 #define AC3_MAX_CHANNELS 7 /**< maximum number of channels, including coupling channel */
32 #define CPL_CH 0 /**< coupling channel index */
33 
34 #define AC3_MAX_COEFS 256
35 #define AC3_BLOCK_SIZE 256
36 #define AC3_MAX_BLOCKS 6
37 #define AC3_FRAME_SIZE (AC3_MAX_BLOCKS * 256)
38 #define AC3_WINDOW_SIZE (AC3_BLOCK_SIZE * 2)
39 #define AC3_CRITICAL_BANDS 50
40 #define AC3_MAX_CPL_BANDS 18
41 
42 #include "libavutil/opt.h"
43 #include "avcodec.h"
44 #include "ac3tab.h"
45 
46 /* exponent encoding strategy */
47 #define EXP_REUSE 0
48 #define EXP_NEW 1
49 
50 #define EXP_D15 1
51 #define EXP_D25 2
52 #define EXP_D45 3
53 
54 /* pre-defined gain values */
55 #define LEVEL_PLUS_3DB 1.4142135623730950
56 #define LEVEL_PLUS_1POINT5DB 1.1892071150027209
57 #define LEVEL_MINUS_1POINT5DB 0.8408964152537145
58 #define LEVEL_MINUS_3DB 0.7071067811865476
59 #define LEVEL_MINUS_4POINT5DB 0.5946035575013605
60 #define LEVEL_MINUS_6DB 0.5000000000000000
61 #define LEVEL_MINUS_9DB 0.3535533905932738
62 #define LEVEL_ZERO 0.0000000000000000
63 #define LEVEL_ONE 1.0000000000000000
64 
65 /** Delta bit allocation strategy */
66 typedef enum {
67  DBA_REUSE = 0,
72 
73 /** Channel mode (audio coding mode) */
74 typedef enum {
84 
85 /** Dolby Surround mode */
86 typedef enum AC3DolbySurroundMode {
92 
93 /** Dolby Surround EX mode */
94 typedef enum AC3DolbySurroundEXMode {
100 
101 /** Dolby Headphone mode */
102 typedef enum AC3DolbyHeadphoneMode {
108 
109 /** Preferred Stereo Downmix mode */
114  AC3_DMIXMOD_DPLII // reserved value in A/52, but used by encoders to indicate DPL2
116 
117 typedef struct AC3BitAllocParameters {
118  int sr_code;
119  int sr_shift;
123 
124 /**
125  * @struct AC3HeaderInfo
126  * Coded AC-3 header values up to the lfeon element, plus derived values.
127  */
128 typedef struct AC3HeaderInfo {
129  /** @name Coded elements
130  * @{
131  */
132  uint16_t sync_word;
133  uint16_t crc1;
140  int substreamid; ///< substream identification
141  int center_mix_level; ///< Center mix level index
142  int surround_mix_level; ///< Surround mix level index
143  uint16_t channel_map;
144  int num_blocks; ///< number of audio blocks
145 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
147 #endif
148  /** @} */
149 
150  /** @name Derived values
151  * @{
152  */
154  uint16_t sample_rate;
155  uint32_t bit_rate;
157  uint16_t frame_size;
158  uint64_t channel_layout;
159  /** @} */
160 #if !AV_HAVE_INCOMPATIBLE_LIBAV_ABI
162 #endif
163 } AC3HeaderInfo;
164 
165 typedef enum {
170 } EAC3FrameType;
171 
172 void ff_ac3_common_init(void);
173 
174 /**
175  * Calculate the log power-spectral density of the input signal.
176  * This gives a rough estimate of signal power in the frequency domain by using
177  * the spectral envelope (exponents). The psd is also separately grouped
178  * into critical bands for use in the calculating the masking curve.
179  * 128 units in psd = -6 dB. The dbknee parameter in AC3BitAllocParameters
180  * determines the reference level.
181  *
182  * @param[in] exp frequency coefficient exponents
183  * @param[in] start starting bin location
184  * @param[in] end ending bin location
185  * @param[out] psd signal power for each frequency bin
186  * @param[out] band_psd signal power for each critical band
187  */
188 void ff_ac3_bit_alloc_calc_psd(int8_t *exp, int start, int end, int16_t *psd,
189  int16_t *band_psd);
190 
191 /**
192  * Calculate the masking curve.
193  * First, the excitation is calculated using parameters in s and the signal
194  * power in each critical band. The excitation is compared with a predefined
195  * hearing threshold table to produce the masking curve. If delta bit
196  * allocation information is provided, it is used for adjusting the masking
197  * curve, usually to give a closer match to a better psychoacoustic model.
198  *
199  * @param[in] s adjustable bit allocation parameters
200  * @param[in] band_psd signal power for each critical band
201  * @param[in] start starting bin location
202  * @param[in] end ending bin location
203  * @param[in] fast_gain fast gain (estimated signal-to-mask ratio)
204  * @param[in] is_lfe whether or not the channel being processed is the LFE
205  * @param[in] dba_mode delta bit allocation mode (none, reuse, or new)
206  * @param[in] dba_nsegs number of delta segments
207  * @param[in] dba_offsets location offsets for each segment
208  * @param[in] dba_lengths length of each segment
209  * @param[in] dba_values delta bit allocation for each segment
210  * @param[out] mask calculated masking curve
211  * @return returns 0 for success, non-zero for error
212  */
213 int ff_ac3_bit_alloc_calc_mask(AC3BitAllocParameters *s, int16_t *band_psd,
214  int start, int end, int fast_gain, int is_lfe,
215  int dba_mode, int dba_nsegs, uint8_t *dba_offsets,
216  uint8_t *dba_lengths, uint8_t *dba_values,
217  int16_t *mask);
218 
219 #endif /* AVCODEC_AC3_H */