Statistics
| Branch: | Revision:

ffmpeg / libavcodec / ac3.h @ 1fda2c10

History | View | Annotate | Download (6.65 KB)

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
#define AC3_WINDOW_SIZE (AC3_BLOCK_SIZE * 2)
40

    
41
/* exponent encoding strategy */
42
#define EXP_REUSE 0
43
#define EXP_NEW   1
44

    
45
#define EXP_D15   1
46
#define EXP_D25   2
47
#define EXP_D45   3
48

    
49
/** Delta bit allocation strategy */
50
typedef enum {
51
    DBA_REUSE = 0,
52
    DBA_NEW,
53
    DBA_NONE,
54
    DBA_RESERVED
55
} AC3DeltaStrategy;
56

    
57
/** Channel mode (audio coding mode) */
58
typedef enum {
59
    AC3_CHMODE_DUALMONO = 0,
60
    AC3_CHMODE_MONO,
61
    AC3_CHMODE_STEREO,
62
    AC3_CHMODE_3F,
63
    AC3_CHMODE_2F1R,
64
    AC3_CHMODE_3F1R,
65
    AC3_CHMODE_2F2R,
66
    AC3_CHMODE_3F2R
67
} AC3ChannelMode;
68

    
69
typedef struct AC3BitAllocParameters {
70
    int sr_code;
71
    int sr_shift;
72
    int slow_gain, slow_decay, fast_decay, db_per_bit, floor;
73
    int cpl_fast_leak, cpl_slow_leak;
74
} AC3BitAllocParameters;
75

    
76
/**
77
 * @struct AC3HeaderInfo
78
 * Coded AC-3 header values up to the lfeon element, plus derived values.
79
 */
80
typedef struct {
81
    /** @defgroup coded Coded elements
82
     * @{
83
     */
84
    uint16_t sync_word;
85
    uint16_t crc1;
86
    uint8_t sr_code;
87
    uint8_t bitstream_id;
88
    uint8_t channel_mode;
89
    uint8_t lfe_on;
90
    uint8_t frame_type;
91
    int substreamid;                        ///< substream identification
92
    int center_mix_level;                   ///< Center mix level index
93
    int surround_mix_level;                 ///< Surround mix level index
94
    uint16_t channel_map;
95
    int num_blocks;                         ///< number of audio blocks
96
    /** @} */
97

    
98
    /** @defgroup derived Derived values
99
     * @{
100
     */
101
    uint8_t sr_shift;
102
    uint16_t sample_rate;
103
    uint32_t bit_rate;
104
    uint8_t channels;
105
    uint16_t frame_size;
106
    int64_t channel_layout;
107
    /** @} */
108
} AC3HeaderInfo;
109

    
110
typedef enum {
111
    EAC3_FRAME_TYPE_INDEPENDENT = 0,
112
    EAC3_FRAME_TYPE_DEPENDENT,
113
    EAC3_FRAME_TYPE_AC3_CONVERT,
114
    EAC3_FRAME_TYPE_RESERVED
115
} EAC3FrameType;
116

    
117
void ac3_common_init(void);
118

    
119
/**
120
 * Calculate the log power-spectral density of the input signal.
121
 * This gives a rough estimate of signal power in the frequency domain by using
122
 * the spectral envelope (exponents).  The psd is also separately grouped
123
 * into critical bands for use in the calculating the masking curve.
124
 * 128 units in psd = -6 dB.  The dbknee parameter in AC3BitAllocParameters
125
 * determines the reference level.
126
 *
127
 * @param[in]  exp        frequency coefficient exponents
128
 * @param[in]  start      starting bin location
129
 * @param[in]  end        ending bin location
130
 * @param[out] psd        signal power for each frequency bin
131
 * @param[out] band_psd   signal power for each critical band
132
 */
133
void ff_ac3_bit_alloc_calc_psd(int8_t *exp, int start, int end, int16_t *psd,
134
                               int16_t *band_psd);
135

    
136
/**
137
 * Calculate the masking curve.
138
 * First, the excitation is calculated using parameters in s and the signal
139
 * power in each critical band.  The excitation is compared with a predefined
140
 * hearing threshold table to produce the masking curve.  If delta bit
141
 * allocation information is provided, it is used for adjusting the masking
142
 * curve, usually to give a closer match to a better psychoacoustic model.
143
 *
144
 * @param[in]  s            adjustable bit allocation parameters
145
 * @param[in]  band_psd     signal power for each critical band
146
 * @param[in]  start        starting bin location
147
 * @param[in]  end          ending bin location
148
 * @param[in]  fast_gain    fast gain (estimated signal-to-mask ratio)
149
 * @param[in]  is_lfe       whether or not the channel being processed is the LFE
150
 * @param[in]  dba_mode     delta bit allocation mode (none, reuse, or new)
151
 * @param[in]  dba_nsegs    number of delta segments
152
 * @param[in]  dba_offsets  location offsets for each segment
153
 * @param[in]  dba_lengths  length of each segment
154
 * @param[in]  dba_values   delta bit allocation for each segment
155
 * @param[out] mask         calculated masking curve
156
 * @return returns 0 for success, non-zero for error
157
 */
158
int ff_ac3_bit_alloc_calc_mask(AC3BitAllocParameters *s, int16_t *band_psd,
159
                               int start, int end, int fast_gain, int is_lfe,
160
                               int dba_mode, int dba_nsegs, uint8_t *dba_offsets,
161
                               uint8_t *dba_lengths, uint8_t *dba_values,
162
                               int16_t *mask);
163

    
164
/**
165
 * Calculate bit allocation pointers.
166
 * The SNR is the difference between the masking curve and the signal.  AC-3
167
 * uses this value for each frequency bin to allocate bits.  The snroffset
168
 * parameter is a global adjustment to the SNR for all bins.
169
 *
170
 * @param[in]  mask       masking curve
171
 * @param[in]  psd        signal power for each frequency bin
172
 * @param[in]  start      starting bin location
173
 * @param[in]  end        ending bin location
174
 * @param[in]  snr_offset SNR adjustment
175
 * @param[in]  floor      noise floor
176
 * @param[in]  bap_tab    look-up table for bit allocation pointers
177
 * @param[out] bap        bit allocation pointers
178
 */
179
void ff_ac3_bit_alloc_calc_bap(int16_t *mask, int16_t *psd, int start, int end,
180
                               int snr_offset, int floor,
181
                               const uint8_t *bap_tab, uint8_t *bap);
182

    
183
void ac3_parametric_bit_allocation(AC3BitAllocParameters *s, uint8_t *bap,
184
                                   int8_t *exp, int start, int end,
185
                                   int snr_offset, int fast_gain, int is_lfe,
186
                                   int dba_mode, int dba_nsegs,
187
                                   uint8_t *dba_offsets, uint8_t *dba_lengths,
188
                                   uint8_t *dba_values);
189

    
190
#endif /* AVCODEC_AC3_H */