cosmetics: use better (and shared) macro names for some constant values
[ffmpeg.git] / libavcodec / ac3.h
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 #include "ac3tab.h"
31
32 #define AC3_MAX_CODED_FRAME_SIZE 3840 /* in bytes */
33 #define AC3_MAX_CHANNELS 6 /* including LFE channel */
34
35 #define AC3_MAX_COEFS   256
36 #define AC3_BLOCK_SIZE  256
37 #define AC3_MAX_BLOCKS    6
38 #define AC3_FRAME_SIZE (AC3_MAX_BLOCKS * 256)
39
40 /* exponent encoding strategy */
41 #define EXP_REUSE 0
42 #define EXP_NEW   1
43
44 #define EXP_D15   1
45 #define EXP_D25   2
46 #define EXP_D45   3
47
48 /** Delta bit allocation strategy */
49 typedef enum {
50     DBA_REUSE = 0,
51     DBA_NEW,
52     DBA_NONE,
53     DBA_RESERVED
54 } AC3DeltaStrategy;
55
56 /** Channel mode (audio coding mode) */
57 typedef enum {
58     AC3_CHMODE_DUALMONO = 0,
59     AC3_CHMODE_MONO,
60     AC3_CHMODE_STEREO,
61     AC3_CHMODE_3F,
62     AC3_CHMODE_2F1R,
63     AC3_CHMODE_3F1R,
64     AC3_CHMODE_2F2R,
65     AC3_CHMODE_3F2R
66 } AC3ChannelMode;
67
68 typedef struct AC3BitAllocParameters {
69     int sr_code;
70     int sr_shift;
71     int slow_gain, slow_decay, fast_decay, db_per_bit, floor;
72     int cpl_fast_leak, cpl_slow_leak;
73 } AC3BitAllocParameters;
74
75 /**
76  * @struct AC3HeaderInfo
77  * Coded AC-3 header values up to the lfeon element, plus derived values.
78  */
79 typedef struct {
80     /** @defgroup coded Coded elements
81      * @{
82      */
83     uint16_t sync_word;
84     uint16_t crc1;
85     uint8_t sr_code;
86     uint8_t bitstream_id;
87     uint8_t channel_mode;
88     uint8_t lfe_on;
89     uint8_t frame_type;
90     int substreamid;                        ///< substream identification
91     int center_mix_level;                   ///< Center mix level index
92     int surround_mix_level;                 ///< Surround mix level index
93     uint16_t channel_map;
94     int num_blocks;                         ///< number of audio blocks
95     /** @} */
96
97     /** @defgroup derived Derived values
98      * @{
99      */
100     uint8_t sr_shift;
101     uint16_t sample_rate;
102     uint32_t bit_rate;
103     uint8_t channels;
104     uint16_t frame_size;
105     int64_t channel_layout;
106     /** @} */
107 } AC3HeaderInfo;
108
109 typedef enum {
110     EAC3_FRAME_TYPE_INDEPENDENT = 0,
111     EAC3_FRAME_TYPE_DEPENDENT,
112     EAC3_FRAME_TYPE_AC3_CONVERT,
113     EAC3_FRAME_TYPE_RESERVED
114 } EAC3FrameType;
115
116 void ac3_common_init(void);
117
118 /**
119  * Calculate the log power-spectral density of the input signal.
120  * This gives a rough estimate of signal power in the frequency domain by using
121  * the spectral envelope (exponents).  The psd is also separately grouped
122  * into critical bands for use in the calculating the masking curve.
123  * 128 units in psd = -6 dB.  The dbknee parameter in AC3BitAllocParameters
124  * determines the reference level.
125  *
126  * @param[in]  exp        frequency coefficient exponents
127  * @param[in]  start      starting bin location
128  * @param[in]  end        ending bin location
129  * @param[out] psd        signal power for each frequency bin
130  * @param[out] band_psd   signal power for each critical band
131  */
132 void ff_ac3_bit_alloc_calc_psd(int8_t *exp, int start, int end, int16_t *psd,
133                                int16_t *band_psd);
134
135 /**
136  * Calculate the masking curve.
137  * First, the excitation is calculated using parameters in s and the signal
138  * power in each critical band.  The excitation is compared with a predefined
139  * hearing threshold table to produce the masking curve.  If delta bit
140  * allocation information is provided, it is used for adjusting the masking
141  * curve, usually to give a closer match to a better psychoacoustic model.
142  *
143  * @param[in]  s            adjustable bit allocation parameters
144  * @param[in]  band_psd     signal power for each critical band
145  * @param[in]  start        starting bin location
146  * @param[in]  end          ending bin location
147  * @param[in]  fast_gain    fast gain (estimated signal-to-mask ratio)
148  * @param[in]  is_lfe       whether or not the channel being processed is the LFE
149  * @param[in]  dba_mode     delta bit allocation mode (none, reuse, or new)
150  * @param[in]  dba_nsegs    number of delta segments
151  * @param[in]  dba_offsets  location offsets for each segment
152  * @param[in]  dba_lengths  length of each segment
153  * @param[in]  dba_values   delta bit allocation for each segment
154  * @param[out] mask         calculated masking curve
155  * @return returns 0 for success, non-zero for error
156  */
157 int ff_ac3_bit_alloc_calc_mask(AC3BitAllocParameters *s, int16_t *band_psd,
158                                int start, int end, int fast_gain, int is_lfe,
159                                int dba_mode, int dba_nsegs, uint8_t *dba_offsets,
160                                uint8_t *dba_lengths, uint8_t *dba_values,
161                                int16_t *mask);
162
163 /**
164  * Calculate bit allocation pointers.
165  * The SNR is the difference between the masking curve and the signal.  AC-3
166  * uses this value for each frequency bin to allocate bits.  The snroffset
167  * parameter is a global adjustment to the SNR for all bins.
168  *
169  * @param[in]  mask       masking curve
170  * @param[in]  psd        signal power for each frequency bin
171  * @param[in]  start      starting bin location
172  * @param[in]  end        ending bin location
173  * @param[in]  snr_offset SNR adjustment
174  * @param[in]  floor      noise floor
175  * @param[in]  bap_tab    look-up table for bit allocation pointers
176  * @param[out] bap        bit allocation pointers
177  */
178 void ff_ac3_bit_alloc_calc_bap(int16_t *mask, int16_t *psd, int start, int end,
179                                int snr_offset, int floor,
180                                const uint8_t *bap_tab, uint8_t *bap);
181
182 void ac3_parametric_bit_allocation(AC3BitAllocParameters *s, uint8_t *bap,
183                                    int8_t *exp, int start, int end,
184                                    int snr_offset, int fast_gain, int is_lfe,
185                                    int dba_mode, int dba_nsegs,
186                                    uint8_t *dba_offsets, uint8_t *dba_lengths,
187                                    uint8_t *dba_values);
188
189 #endif /* AVCODEC_AC3_H */