move ac3 tables from a .h to a .c
[ffmpeg.git] / libavcodec / ac3.h
1 /*
2  * Common code between AC3 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 ac3.h
24  * Common code between AC3 encoder and decoder.
25  */
26
27 #include "ac3tab.h"
28
29 #define AC3_MAX_CODED_FRAME_SIZE 3840 /* in bytes */
30 #define AC3_MAX_CHANNELS 6 /* including LFE channel */
31
32 #define NB_BLOCKS 6 /* number of PCM blocks inside an AC3 frame */
33 #define AC3_FRAME_SIZE (NB_BLOCKS * 256)
34
35 /* exponent encoding strategy */
36 #define EXP_REUSE 0
37 #define EXP_NEW   1
38
39 #define EXP_D15   1
40 #define EXP_D25   2
41 #define EXP_D45   3
42
43 typedef struct AC3BitAllocParameters {
44     int fscod; /* frequency */
45     int halfratecod;
46     int sgain, sdecay, fdecay, dbknee, floor;
47     int cplfleak, cplsleak;
48 } AC3BitAllocParameters;
49
50 /**
51  * @struct AC3HeaderInfo
52  * Coded AC-3 header values up to the lfeon element, plus derived values.
53  */
54 typedef struct {
55     /** @defgroup coded Coded elements
56      * @{
57      */
58     uint16_t sync_word;
59     uint16_t crc1;
60     uint8_t fscod;
61     uint8_t frmsizecod;
62     uint8_t bsid;
63     uint8_t bsmod;
64     uint8_t acmod;
65     uint8_t cmixlev;
66     uint8_t surmixlev;
67     uint8_t dsurmod;
68     uint8_t lfeon;
69     /** @} */
70
71     /** @defgroup derived Derived values
72      * @{
73      */
74     uint8_t halfratecod;
75     uint16_t sample_rate;
76     uint32_t bit_rate;
77     uint8_t channels;
78     uint16_t frame_size;
79     /** @} */
80 } AC3HeaderInfo;
81
82
83 void ac3_common_init(void);
84
85 /**
86  * Calculates the log power-spectral density of the input signal.
87  * This gives a rough estimate of signal power in the frequency domain by using
88  * the spectral envelope (exponents).  The psd is also separately grouped
89  * into critical bands for use in the calculating the masking curve.
90  * 128 units in psd = -6 dB.  The dbknee parameter in AC3BitAllocParameters
91  * determines the reference level.
92  *
93  * @param[in]  exp        frequency coefficient exponents
94  * @param[in]  start      starting bin location
95  * @param[in]  end        ending bin location
96  * @param[out] psd        signal power for each frequency bin
97  * @param[out] bndpsd     signal power for each critical band
98  */
99 void ff_ac3_bit_alloc_calc_psd(int8_t *exp, int start, int end, int16_t *psd,
100                                int16_t *bndpsd);
101
102 /**
103  * Calculates the masking curve.
104  * First, the excitation is calculated using parameters in \p s and the signal
105  * power in each critical band.  The excitation is compared with a predefined
106  * hearing threshold table to produce the masking curve.  If delta bit
107  * allocation information is provided, it is used for adjusting the masking
108  * curve, usually to give a closer match to a better psychoacoustic model.
109  *
110  * @param[in]  s          adjustable bit allocation parameters
111  * @param[in]  bndpsd     signal power for each critical band
112  * @param[in]  start      starting bin location
113  * @param[in]  end        ending bin location
114  * @param[in]  fgain      fast gain (estimated signal-to-mask ratio)
115  * @param[in]  is_lfe     whether or not the channel being processed is the LFE
116  * @param[in]  deltbae    delta bit allocation exists (none, reuse, or new)
117  * @param[in]  deltnseg   number of delta segments
118  * @param[in]  deltoffst  location offsets for each segment
119  * @param[in]  deltlen    length of each segment
120  * @param[in]  deltba     delta bit allocation for each segment
121  * @param[out] mask       calculated masking curve
122  */
123 void ff_ac3_bit_alloc_calc_mask(AC3BitAllocParameters *s, int16_t *bndpsd,
124                                 int start, int end, int fgain, int is_lfe,
125                                 int deltbae, int deltnseg, uint8_t *deltoffst,
126                                 uint8_t *deltlen, uint8_t *deltba,
127                                 int16_t *mask);
128
129 /**
130  * Calculates bit allocation pointers.
131  * The SNR is the difference between the masking curve and the signal.  AC-3
132  * uses this value for each frequency bin to allocate bits.  The \p snroffset
133  * parameter is a global adjustment to the SNR for all bins.
134  *
135  * @param[in]  mask       masking curve
136  * @param[in]  psd        signal power for each frequency bin
137  * @param[in]  start      starting bin location
138  * @param[in]  end        ending bin location
139  * @param[in]  snroffset  SNR adjustment
140  * @param[in]  floor      noise floor
141  * @param[out] bap        bit allocation pointers
142  */
143 void ff_ac3_bit_alloc_calc_bap(int16_t *mask, int16_t *psd, int start, int end,
144                                int snroffset, int floor, uint8_t *bap);
145
146 void ac3_parametric_bit_allocation(AC3BitAllocParameters *s, uint8_t *bap,
147                                    int8_t *exp, int start, int end,
148                                    int snroffset, int fgain, int is_lfe,
149                                    int deltbae,int deltnseg,
150                                    uint8_t *deltoffst, uint8_t *deltlen, uint8_t *deltba);