annotate ac3.h @ 5230:2a340aea762d libavcodec

simplify ff_copy_bits: merge 2 test branches
author aurel
date Fri, 06 Jul 2007 14:14:41 +0000
parents f8e21b3014f7
children b24bcdd0ae86
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
782
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
1 /*
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
2 * Common code between AC3 encoder and decoder
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
3 * Copyright (c) 2000, 2001, 2002 Fabrice Bellard.
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
4 *
3947
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3036
diff changeset
5 * This file is part of FFmpeg.
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3036
diff changeset
6 *
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3036
diff changeset
7 * FFmpeg is free software; you can redistribute it and/or
782
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
8 * modify it under the terms of the GNU Lesser General Public
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
9 * License as published by the Free Software Foundation; either
3947
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3036
diff changeset
10 * version 2.1 of the License, or (at your option) any later version.
782
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
11 *
3947
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3036
diff changeset
12 * FFmpeg is distributed in the hope that it will be useful,
782
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
15 * Lesser General Public License for more details.
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
16 *
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
17 * You should have received a copy of the GNU Lesser General Public
3947
c8c591fe26f8 Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents: 3036
diff changeset
18 * License along with FFmpeg; if not, write to the Free Software
3036
0b546eab515d Update licensing information: The FSF changed postal address.
diego
parents: 2967
diff changeset
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
782
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
20 */
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
21
1106
1e39f273ecd6 per file doxy
michaelni
parents: 1064
diff changeset
22 /**
1e39f273ecd6 per file doxy
michaelni
parents: 1064
diff changeset
23 * @file ac3.h
1e39f273ecd6 per file doxy
michaelni
parents: 1064
diff changeset
24 * Common code between AC3 encoder and decoder.
1e39f273ecd6 per file doxy
michaelni
parents: 1064
diff changeset
25 */
1e39f273ecd6 per file doxy
michaelni
parents: 1064
diff changeset
26
4940
f8e21b3014f7 avoid multiple inclusion of ac3.h
aurel
parents: 4879
diff changeset
27 #ifndef AC3_H
f8e21b3014f7 avoid multiple inclusion of ac3.h
aurel
parents: 4879
diff changeset
28 #define AC3_H
f8e21b3014f7 avoid multiple inclusion of ac3.h
aurel
parents: 4879
diff changeset
29
4879
60603c9c89d1 move ac3 tables from a .h to a .c
aurel
parents: 4855
diff changeset
30 #include "ac3tab.h"
60603c9c89d1 move ac3 tables from a .h to a .c
aurel
parents: 4855
diff changeset
31
782
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
32 #define AC3_MAX_CODED_FRAME_SIZE 3840 /* in bytes */
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
33 #define AC3_MAX_CHANNELS 6 /* including LFE channel */
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
34
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
35 #define NB_BLOCKS 6 /* number of PCM blocks inside an AC3 frame */
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
36 #define AC3_FRAME_SIZE (NB_BLOCKS * 256)
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
37
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
38 /* exponent encoding strategy */
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
39 #define EXP_REUSE 0
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
40 #define EXP_NEW 1
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
41
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
42 #define EXP_D15 1
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
43 #define EXP_D25 2
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
44 #define EXP_D45 3
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
45
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
46 typedef struct AC3BitAllocParameters {
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
47 int fscod; /* frequency */
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
48 int halfratecod;
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
49 int sgain, sdecay, fdecay, dbknee, floor;
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
50 int cplfleak, cplsleak;
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
51 } AC3BitAllocParameters;
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
52
4648
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
53 /**
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
54 * @struct AC3HeaderInfo
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
55 * Coded AC-3 header values up to the lfeon element, plus derived values.
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
56 */
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
57 typedef struct {
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
58 /** @defgroup coded Coded elements
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
59 * @{
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
60 */
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
61 uint16_t sync_word;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
62 uint16_t crc1;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
63 uint8_t fscod;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
64 uint8_t frmsizecod;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
65 uint8_t bsid;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
66 uint8_t bsmod;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
67 uint8_t acmod;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
68 uint8_t cmixlev;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
69 uint8_t surmixlev;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
70 uint8_t dsurmod;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
71 uint8_t lfeon;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
72 /** @} */
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
73
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
74 /** @defgroup derived Derived values
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
75 * @{
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
76 */
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
77 uint8_t halfratecod;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
78 uint16_t sample_rate;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
79 uint32_t bit_rate;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
80 uint8_t channels;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
81 uint16_t frame_size;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
82 /** @} */
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
83 } AC3HeaderInfo;
5683b496ffbc move AC-3 header parsing to ac3.c
jbr
parents: 4645
diff changeset
84
782
dd7d5748d064 preparing integration of new AC3 decoder
bellard
parents:
diff changeset
85
4197
bbe0bc387a19 revert bad checkin
mru
parents: 4196
diff changeset
86 void ac3_common_init(void);
4684
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
87
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
88 /**
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
89 * Calculates the log power-spectral density of the input signal.
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
90 * This gives a rough estimate of signal power in the frequency domain by using
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
91 * the spectral envelope (exponents). The psd is also separately grouped
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
92 * into critical bands for use in the calculating the masking curve.
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
93 * 128 units in psd = -6 dB. The dbknee parameter in AC3BitAllocParameters
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
94 * determines the reference level.
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
95 *
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
96 * @param[in] exp frequency coefficient exponents
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
97 * @param[in] start starting bin location
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
98 * @param[in] end ending bin location
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
99 * @param[out] psd signal power for each frequency bin
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
100 * @param[out] bndpsd signal power for each critical band
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
101 */
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
102 void ff_ac3_bit_alloc_calc_psd(int8_t *exp, int start, int end, int16_t *psd,
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
103 int16_t *bndpsd);
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
104
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
105 /**
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
106 * Calculates the masking curve.
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
107 * First, the excitation is calculated using parameters in \p s and the signal
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
108 * power in each critical band. The excitation is compared with a predefined
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
109 * hearing threshold table to produce the masking curve. If delta bit
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
110 * allocation information is provided, it is used for adjusting the masking
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
111 * curve, usually to give a closer match to a better psychoacoustic model.
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
112 *
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
113 * @param[in] s adjustable bit allocation parameters
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
114 * @param[in] bndpsd signal power for each critical band
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
115 * @param[in] start starting bin location
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
116 * @param[in] end ending bin location
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
117 * @param[in] fgain fast gain (estimated signal-to-mask ratio)
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
118 * @param[in] is_lfe whether or not the channel being processed is the LFE
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
119 * @param[in] deltbae delta bit allocation exists (none, reuse, or new)
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
120 * @param[in] deltnseg number of delta segments
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
121 * @param[in] deltoffst location offsets for each segment
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
122 * @param[in] deltlen length of each segment
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
123 * @param[in] deltba delta bit allocation for each segment
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
124 * @param[out] mask calculated masking curve
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
125 */
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
126 void ff_ac3_bit_alloc_calc_mask(AC3BitAllocParameters *s, int16_t *bndpsd,
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
127 int start, int end, int fgain, int is_lfe,
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
128 int deltbae, int deltnseg, uint8_t *deltoffst,
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
129 uint8_t *deltlen, uint8_t *deltba,
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
130 int16_t *mask);
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
131
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
132 /**
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
133 * Calculates bit allocation pointers.
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
134 * The SNR is the difference between the masking curve and the signal. AC-3
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
135 * uses this value for each frequency bin to allocate bits. The \p snroffset
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
136 * parameter is a global adjustment to the SNR for all bins.
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
137 *
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
138 * @param[in] mask masking curve
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
139 * @param[in] psd signal power for each frequency bin
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
140 * @param[in] start starting bin location
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
141 * @param[in] end ending bin location
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
142 * @param[in] snroffset SNR adjustment
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
143 * @param[in] floor noise floor
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
144 * @param[out] bap bit allocation pointers
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
145 */
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
146 void ff_ac3_bit_alloc_calc_bap(int16_t *mask, int16_t *psd, int start, int end,
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
147 int snroffset, int floor, uint8_t *bap);
6ec0afffc572 split ac3_parametric_bit_allocation into 3 separate functions
jbr
parents: 4679
diff changeset
148
4197
bbe0bc387a19 revert bad checkin
mru
parents: 4196
diff changeset
149 void ac3_parametric_bit_allocation(AC3BitAllocParameters *s, uint8_t *bap,
bbe0bc387a19 revert bad checkin
mru
parents: 4196
diff changeset
150 int8_t *exp, int start, int end,
bbe0bc387a19 revert bad checkin
mru
parents: 4196
diff changeset
151 int snroffset, int fgain, int is_lfe,
bbe0bc387a19 revert bad checkin
mru
parents: 4196
diff changeset
152 int deltbae,int deltnseg,
bbe0bc387a19 revert bad checkin
mru
parents: 4196
diff changeset
153 uint8_t *deltoffst, uint8_t *deltlen, uint8_t *deltba);
4940
f8e21b3014f7 avoid multiple inclusion of ac3.h
aurel
parents: 4879
diff changeset
154
f8e21b3014f7 avoid multiple inclusion of ac3.h
aurel
parents: 4879
diff changeset
155 #endif /* AC3_H */