Add a comment that explains why this header has no multiple inclusion guards.
[mplayer/greg.git] / libfaad2 / ps_dec.h
blobef2e0db16e039d82f0d575a51b1498e68d6125a6
1 /*
2 ** FAAD2 - Freeware Advanced Audio (AAC) Decoder including SBR decoding
3 ** Copyright (C) 2003-2004 M. Bakker, Ahead Software AG, http://www.nero.com
4 **
5 ** This program is free software; you can redistribute it and/or modify
6 ** it under the terms of the GNU General Public License as published by
7 ** the Free Software Foundation; either version 2 of the License, or
8 ** (at your option) any later version.
9 **
10 ** This program is distributed in the hope that it will be useful,
11 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ** GNU General Public License for more details.
14 **
15 ** You should have received a copy of the GNU General Public License
16 ** along with this program; if not, write to the Free Software
17 ** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 ** Any non-GPL usage of this software or parts of this software is strictly
20 ** forbidden.
22 ** Commercial non-GPL licensing of this software is possible.
23 ** For more info contact Ahead Software through Mpeg4AAClicense@nero.com.
25 ** $Id: ps_dec.h,v 1.8 2004/09/04 14:56:28 menno Exp $
26 **/
28 #ifndef __PS_DEC_H__
29 #define __PS_DEC_H__
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
35 #include "bits.h"
37 #define EXTENSION_ID_PS 2
39 #define MAX_PS_ENVELOPES 5
40 #define NO_ALLPASS_LINKS 3
42 typedef struct
44 /* bitstream parameters */
45 uint8_t enable_iid;
46 uint8_t enable_icc;
47 uint8_t enable_ext;
49 uint8_t iid_mode;
50 uint8_t icc_mode;
51 uint8_t nr_iid_par;
52 uint8_t nr_ipdopd_par;
53 uint8_t nr_icc_par;
55 uint8_t frame_class;
56 uint8_t num_env;
58 uint8_t border_position[MAX_PS_ENVELOPES+1];
60 uint8_t iid_dt[MAX_PS_ENVELOPES];
61 uint8_t icc_dt[MAX_PS_ENVELOPES];
63 uint8_t enable_ipdopd;
64 uint8_t ipd_mode;
65 uint8_t ipd_dt[MAX_PS_ENVELOPES];
66 uint8_t opd_dt[MAX_PS_ENVELOPES];
68 /* indices */
69 int8_t iid_index_prev[34];
70 int8_t icc_index_prev[34];
71 int8_t ipd_index_prev[17];
72 int8_t opd_index_prev[17];
73 int8_t iid_index[MAX_PS_ENVELOPES][34];
74 int8_t icc_index[MAX_PS_ENVELOPES][34];
75 int8_t ipd_index[MAX_PS_ENVELOPES][17];
76 int8_t opd_index[MAX_PS_ENVELOPES][17];
78 int8_t ipd_index_1[17];
79 int8_t opd_index_1[17];
80 int8_t ipd_index_2[17];
81 int8_t opd_index_2[17];
83 /* ps data was correctly read */
84 uint8_t ps_data_available;
86 /* a header has been read */
87 uint8_t header_read;
89 /* hybrid filterbank parameters */
90 void *hyb;
91 uint8_t use34hybrid_bands;
93 /**/
94 uint8_t num_groups;
95 uint8_t num_hybrid_groups;
96 uint8_t nr_par_bands;
97 uint8_t nr_allpass_bands;
98 uint8_t decay_cutoff;
100 uint8_t *group_border;
101 uint16_t *map_group2bk;
103 /* filter delay handling */
104 uint8_t saved_delay;
105 uint8_t delay_buf_index_ser[NO_ALLPASS_LINKS];
106 uint8_t num_sample_delay_ser[NO_ALLPASS_LINKS];
107 uint8_t delay_D[64];
108 uint8_t delay_buf_index_delay[64];
110 complex_t delay_Qmf[14][64]; /* 14 samples delay max, 64 QMF channels */
111 complex_t delay_SubQmf[2][32]; /* 2 samples delay max (SubQmf is always allpass filtered) */
112 complex_t delay_Qmf_ser[NO_ALLPASS_LINKS][5][64]; /* 5 samples delay max (table 8.34), 64 QMF channels */
113 complex_t delay_SubQmf_ser[NO_ALLPASS_LINKS][5][32]; /* 5 samples delay max (table 8.34) */
115 /* transients */
116 real_t alpha_decay;
117 real_t alpha_smooth;
119 real_t P_PeakDecayNrg[34];
120 real_t P_prev[34];
121 real_t P_SmoothPeakDecayDiffNrg_prev[34];
123 /* mixing and phase */
124 complex_t h11_prev[50];
125 complex_t h12_prev[50];
126 complex_t h21_prev[50];
127 complex_t h22_prev[50];
128 uint8_t phase_hist;
129 complex_t ipd_prev[20][2];
130 complex_t opd_prev[20][2];
132 } ps_info;
134 /* ps_syntax.c */
135 uint16_t ps_data(ps_info *ps, bitfile *ld, uint8_t *header);
137 /* ps_dec.c */
138 ps_info *ps_init(uint8_t sr_index);
139 void ps_free(ps_info *ps);
141 uint8_t ps_decode(ps_info *ps, qmf_t X_left[38][64], qmf_t X_right[38][64]);
144 #ifdef __cplusplus
146 #endif
147 #endif