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 #ifndef USE_FIXED
55 #define USE_FIXED 0
56 #endif
57 
58 #if USE_FIXED
59 
60 #define FFT_FLOAT 0
61 
62 #define FIXR(a) ((int)((a) * 0 + 0.5))
63 #define FIXR12(a) ((int)((a) * 4096 + 0.5))
64 #define FIXR15(a) ((int)((a) * 32768 + 0.5))
65 #define ROUND15(x) ((x) + 16384) >> 15
66 
67 #define AC3_RENAME(x) x ## _fixed
68 #define AC3_NORM(norm) (1<<24)/(norm)
69 #define AC3_MUL(a,b) ((((int64_t) (a)) * (b))>>12)
70 #define AC3_RANGE(x) ((x)|(((x)&128)<<1))
71 #define AC3_HEAVY_RANGE(x) ((x)<<1)
72 #define AC3_DYNAMIC_RANGE(x) (x)
73 #define AC3_SPX_BLEND(x) (x)
74 #define AC3_DYNAMIC_RANGE1 0
75 
76 typedef int INTFLOAT;
77 typedef int16_t SHORTFLOAT;
78 
79 #else /* USE_FIXED */
80 
81 #define FIXR(x) ((float)(x))
82 #define FIXR12(x) ((float)(x))
83 #define FIXR15(x) ((float)(x))
84 #define ROUND15(x) (x)
85 
86 #define AC3_RENAME(x) x
87 #define AC3_NORM(norm) (1.0f/(norm))
88 #define AC3_MUL(a,b) ((a) * (b))
89 #define AC3_RANGE(x) (dynamic_range_tab[(x)])
90 #define AC3_HEAVY_RANGE(x) (heavy_dynamic_range_tab[(x)])
91 #define AC3_DYNAMIC_RANGE(x) (powf(x, s->drc_scale))
92 #define AC3_SPX_BLEND(x) (x)* (1.0f/32)
93 #define AC3_DYNAMIC_RANGE1 1.0f
94 
95 typedef float INTFLOAT;
96 typedef float SHORTFLOAT;
97 
98 #endif /* USE_FIXED */
99 
100 #define AC3_LEVEL(x) ROUND15((x) * FIXR15(M_SQRT1_2))
101 
102 /* pre-defined gain values */
103 #define LEVEL_PLUS_3DB M_SQRT2
104 #define LEVEL_PLUS_1POINT5DB 1.1892071150027209
105 #define LEVEL_MINUS_1POINT5DB 0.8408964152537145
106 #define LEVEL_MINUS_3DB M_SQRT1_2
107 #define LEVEL_MINUS_4POINT5DB 0.5946035575013605
108 #define LEVEL_MINUS_6DB 0.5000000000000000
109 #define LEVEL_MINUS_9DB 0.3535533905932738
110 #define LEVEL_ZERO 0.0000000000000000
111 #define LEVEL_ONE 1.0000000000000000
112 
113 /** Delta bit allocation strategy */
114 typedef enum {
120 
121 /** Channel mode (audio coding mode) */
122 typedef enum {
132 
133 /** Dolby Surround mode */
134 typedef enum AC3DolbySurroundMode {
140 
141 /** Dolby Surround EX mode */
148 
149 /** Dolby Headphone mode */
150 typedef enum AC3DolbyHeadphoneMode {
156 
157 /** Preferred Stereo Downmix mode */
162  AC3_DMIXMOD_DPLII // reserved value in A/52, but used by encoders to indicate DPL2
164 
165 typedef struct AC3BitAllocParameters {
166  int sr_code;
167  int sr_shift;
171 
172 /**
173  * @struct AC3HeaderInfo
174  * Coded AC-3 header values up to the lfeon element, plus derived values.
175  */
176 typedef struct AC3HeaderInfo {
177  /** @name Coded elements
178  * @{
179  */
180  uint16_t sync_word;
181  uint16_t crc1;
188  int substreamid; ///< substream identification
189  int center_mix_level; ///< Center mix level index
190  int surround_mix_level; ///< Surround mix level index
191  uint16_t channel_map;
192  int num_blocks; ///< number of audio blocks
194  /** @} */
195 
196  /** @name Derived values
197  * @{
198  */
200  uint16_t sample_rate;
201  uint32_t bit_rate;
203  uint16_t frame_size;
204  uint64_t channel_layout;
205  /** @} */
206 } AC3HeaderInfo;
207 
208 typedef enum {
213 } EAC3FrameType;
214 
215 void ff_ac3_common_init(void);
216 
217 /**
218  * Calculate the log power-spectral density of the input signal.
219  * This gives a rough estimate of signal power in the frequency domain by using
220  * the spectral envelope (exponents). The psd is also separately grouped
221  * into critical bands for use in the calculating the masking curve.
222  * 128 units in psd = -6 dB. The dbknee parameter in AC3BitAllocParameters
223  * determines the reference level.
224  *
225  * @param[in] exp frequency coefficient exponents
226  * @param[in] start starting bin location
227  * @param[in] end ending bin location
228  * @param[out] psd signal power for each frequency bin
229  * @param[out] band_psd signal power for each critical band
230  */
231 void ff_ac3_bit_alloc_calc_psd(int8_t *exp, int start, int end, int16_t *psd,
232  int16_t *band_psd);
233 
234 /**
235  * Calculate the masking curve.
236  * First, the excitation is calculated using parameters in s and the signal
237  * power in each critical band. The excitation is compared with a predefined
238  * hearing threshold table to produce the masking curve. If delta bit
239  * allocation information is provided, it is used for adjusting the masking
240  * curve, usually to give a closer match to a better psychoacoustic model.
241  *
242  * @param[in] s adjustable bit allocation parameters
243  * @param[in] band_psd signal power for each critical band
244  * @param[in] start starting bin location
245  * @param[in] end ending bin location
246  * @param[in] fast_gain fast gain (estimated signal-to-mask ratio)
247  * @param[in] is_lfe whether or not the channel being processed is the LFE
248  * @param[in] dba_mode delta bit allocation mode (none, reuse, or new)
249  * @param[in] dba_nsegs number of delta segments
250  * @param[in] dba_offsets location offsets for each segment
251  * @param[in] dba_lengths length of each segment
252  * @param[in] dba_values delta bit allocation for each segment
253  * @param[out] mask calculated masking curve
254  * @return returns 0 for success, non-zero for error
255  */
256 int ff_ac3_bit_alloc_calc_mask(AC3BitAllocParameters *s, int16_t *band_psd,
257  int start, int end, int fast_gain, int is_lfe,
258  int dba_mode, int dba_nsegs, uint8_t *dba_offsets,
259  uint8_t *dba_lengths, uint8_t *dba_values,
260  int16_t *mask);
261 
262 #endif /* AVCODEC_AC3_H */
uint8_t bitstream_mode
Definition: ac3.h:184
uint64_t channel_layout
Definition: ac3.h:204
const char * s
Definition: avisynth_c.h:631
AC3ChannelMode
Channel mode (audio coding mode)
Definition: ac3.h:122
uint16_t crc1
Definition: ac3.h:181
AC3DolbySurroundEXMode
Dolby Surround EX mode.
Definition: ac3.h:142
int ff_ac3_bit_alloc_calc_mask(AC3BitAllocParameters *s, int16_t *band_psd, int start, int end, int fast_gain, int is_lfe, int dba_mode, int dba_nsegs, uint8_t *dba_offsets, uint8_t *dba_lengths, uint8_t *dba_values, int16_t *mask)
Calculate the masking curve.
Definition: ac3.c:118
Definition: ac3.h:115
uint8_t
AVOptions.
uint8_t lfe_on
Definition: ac3.h:186
float SHORTFLOAT
Definition: ac3.h:96
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:90
void ff_ac3_common_init(void)
uint8_t sr_shift
Definition: ac3.h:199
uint8_t bitstream_id
Definition: ac3.h:183
uint16_t sync_word
Definition: ac3.h:180
AC3DolbySurroundMode
Dolby Surround mode.
Definition: ac3.h:134
uint8_t frame_type
Definition: ac3.h:187
static const uint16_t mask[17]
Definition: lzw.c:38
uint8_t sr_code
Definition: ac3.h:182
Definition: ac3.h:116
Coded AC-3 header values up to the lfeon element, plus derived values.
Definition: ac3.h:176
uint16_t sample_rate
Definition: ac3.h:200
int8_t exp
Definition: eval.c:64
void ff_ac3_bit_alloc_calc_psd(int8_t *exp, int start, int end, int16_t *psd, int16_t *band_psd)
Calculate the log power-spectral density of the input signal.
Definition: ac3.c:92
AC3PreferredStereoDownmixMode
Preferred Stereo Downmix mode.
Definition: ac3.h:158
uint32_t bit_rate
Definition: ac3.h:201
uint16_t channel_map
Definition: ac3.h:191
Definition: ac3.h:117
int dolby_surround_mode
Definition: ac3.h:193
Libavcodec external API header.
EAC3FrameType
Definition: ac3.h:208
AC3DolbyHeadphoneMode
Dolby Headphone mode.
Definition: ac3.h:150
uint16_t frame_size
Definition: ac3.h:203
int surround_mix_level
Surround mix level index.
Definition: ac3.h:190
int center_mix_level
Center mix level index.
Definition: ac3.h:189
AC3DeltaStrategy
Delta bit allocation strategy.
Definition: ac3.h:114
int substreamid
substream identification
Definition: ac3.h:188
uint8_t channels
Definition: ac3.h:202
void INT64 start
Definition: avisynth_c.h:553
int num_blocks
number of audio blocks
Definition: ac3.h:192
uint8_t channel_mode
Definition: ac3.h:185
float INTFLOAT
Definition: ac3.h:95