avcodec/aacsbr: check that the element type matches before applying SBR
[ffmpeg.git] / libavcodec / sbr.h
1 /*
2  * Spectral Band Replication definitions and structures
3  * Copyright (c) 2008-2009 Robert Swain ( rob opendot cl )
4  * Copyright (c) 2010      Alex Converse <alex.converse@gmail.com>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * Spectral Band Replication definitions and structures
26  * @author Robert Swain ( rob opendot cl )
27  */
28
29 #ifndef AVCODEC_SBR_H
30 #define AVCODEC_SBR_H
31
32 #include <stdint.h>
33 #include "fft.h"
34 #include "aacps.h"
35 #include "sbrdsp.h"
36
37 typedef struct AACContext AACContext;
38
39 /**
40  * Spectral Band Replication header - spectrum parameters that invoke a reset if they differ from the previous header.
41  */
42 typedef struct SpectrumParameters {
43     uint8_t bs_start_freq;
44     uint8_t bs_stop_freq;
45     uint8_t bs_xover_band;
46
47     /**
48      * @name Variables associated with bs_header_extra_1
49      * @{
50      */
51     uint8_t bs_freq_scale;
52     uint8_t bs_alter_scale;
53     uint8_t bs_noise_bands;
54     /** @} */
55 } SpectrumParameters;
56
57 #define SBR_SYNTHESIS_BUF_SIZE ((1280-128)*2)
58
59 /**
60  * Spectral Band Replication per channel data
61  */
62 typedef struct SBRData {
63     /**
64      * @name Main bitstream data variables
65      * @{
66      */
67     unsigned           bs_frame_class;
68     unsigned           bs_add_harmonic_flag;
69     unsigned           bs_num_env;
70     uint8_t            bs_freq_res[7];
71     unsigned           bs_num_noise;
72     uint8_t            bs_df_env[5];
73     uint8_t            bs_df_noise[2];
74     uint8_t            bs_invf_mode[2][5];
75     uint8_t            bs_add_harmonic[48];
76     unsigned           bs_amp_res;
77     /** @} */
78
79     /**
80      * @name State variables
81      * @{
82      */
83     DECLARE_ALIGNED(32, float, synthesis_filterbank_samples)[SBR_SYNTHESIS_BUF_SIZE];
84     DECLARE_ALIGNED(32, float, analysis_filterbank_samples) [1312];
85     int                synthesis_filterbank_samples_offset;
86     ///l_APrev and l_A
87     int                e_a[2];
88     ///Chirp factors
89     float              bw_array[5];
90     ///QMF values of the original signal
91     float              W[2][32][32][2];
92     ///QMF output of the HF adjustor
93     int                Ypos;
94     DECLARE_ALIGNED(16, float, Y)[2][38][64][2];
95     DECLARE_ALIGNED(16, float, g_temp)[42][48];
96     float              q_temp[42][48];
97     uint8_t            s_indexmapped[8][48];
98     ///Envelope scalefactors
99     float              env_facs[6][48];
100     ///Noise scalefactors
101     float              noise_facs[3][5];
102     ///Envelope time borders
103     uint8_t            t_env[8];
104     ///Envelope time border of the last envelope of the previous frame
105     uint8_t            t_env_num_env_old;
106     ///Noise time borders
107     uint8_t            t_q[3];
108     unsigned           f_indexnoise;
109     unsigned           f_indexsine;
110     /** @} */
111 } SBRData;
112
113 typedef struct SpectralBandReplication SpectralBandReplication;
114
115 /**
116  * aacsbr functions pointers
117  */
118 typedef struct AACSBRContext {
119     int (*sbr_lf_gen)(AACContext *ac, SpectralBandReplication *sbr,
120                       float X_low[32][40][2], const float W[2][32][32][2],
121                       int buf_idx);
122     void (*sbr_hf_assemble)(float Y1[38][64][2],
123                             const float X_high[64][40][2],
124                             SpectralBandReplication *sbr, SBRData *ch_data,
125                             const int e_a[2]);
126     int (*sbr_x_gen)(SpectralBandReplication *sbr, float X[2][38][64],
127                      const float Y0[38][64][2], const float Y1[38][64][2],
128                      const float X_low[32][40][2], int ch);
129     void (*sbr_hf_inverse_filter)(SBRDSPContext *dsp,
130                                   float (*alpha0)[2], float (*alpha1)[2],
131                                   const float X_low[32][40][2], int k0);
132 } AACSBRContext;
133
134 /**
135  * Spectral Band Replication
136  */
137 struct SpectralBandReplication {
138     int                sample_rate;
139     int                start;
140     int                id_aac;
141     int                reset;
142     SpectrumParameters spectrum_params;
143     int                bs_amp_res_header;
144     /**
145      * @name Variables associated with bs_header_extra_2
146      * @{
147      */
148     unsigned           bs_limiter_bands;
149     unsigned           bs_limiter_gains;
150     unsigned           bs_interpol_freq;
151     unsigned           bs_smoothing_mode;
152     /** @} */
153     unsigned           bs_coupling;
154     unsigned           k[5]; ///< k0, k1, k2
155     ///kx', and kx respectively, kx is the first QMF subband where SBR is used.
156     ///kx' is its value from the previous frame
157     unsigned           kx[2];
158     ///M' and M respectively, M is the number of QMF subbands that use SBR.
159     unsigned           m[2];
160     unsigned           kx_and_m_pushed;
161     ///The number of frequency bands in f_master
162     unsigned           n_master;
163     SBRData            data[2];
164     PSContext          ps;
165     ///N_Low and N_High respectively, the number of frequency bands for low and high resolution
166     unsigned           n[2];
167     ///Number of noise floor bands
168     unsigned           n_q;
169     ///Number of limiter bands
170     unsigned           n_lim;
171     ///The master QMF frequency grouping
172     uint16_t           f_master[49];
173     ///Frequency borders for low resolution SBR
174     uint16_t           f_tablelow[25];
175     ///Frequency borders for high resolution SBR
176     uint16_t           f_tablehigh[49];
177     ///Frequency borders for noise floors
178     uint16_t           f_tablenoise[6];
179     ///Frequency borders for the limiter
180     uint16_t           f_tablelim[30];
181     unsigned           num_patches;
182     uint8_t            patch_num_subbands[6];
183     uint8_t            patch_start_subband[6];
184     ///QMF low frequency input to the HF generator
185     DECLARE_ALIGNED(16, float, X_low)[32][40][2];
186     ///QMF output of the HF generator
187     DECLARE_ALIGNED(16, float, X_high)[64][40][2];
188     ///QMF values of the reconstructed signal
189     DECLARE_ALIGNED(16, float, X)[2][2][38][64];
190     ///Zeroth coefficient used to filter the subband signals
191     DECLARE_ALIGNED(16, float, alpha0)[64][2];
192     ///First coefficient used to filter the subband signals
193     DECLARE_ALIGNED(16, float, alpha1)[64][2];
194     ///Dequantized envelope scalefactors, remapped
195     float              e_origmapped[7][48];
196     ///Dequantized noise scalefactors, remapped
197     float              q_mapped[7][48];
198     ///Sinusoidal presence, remapped
199     uint8_t            s_mapped[7][48];
200     ///Estimated envelope
201     float              e_curr[7][48];
202     ///Amplitude adjusted noise scalefactors
203     float              q_m[7][48];
204     ///Sinusoidal levels
205     float              s_m[7][48];
206     float              gain[7][48];
207     DECLARE_ALIGNED(32, float, qmf_filter_scratch)[5][64];
208     FFTContext         mdct_ana;
209     FFTContext         mdct;
210     SBRDSPContext      dsp;
211     AACSBRContext      c;
212 };
213
214 #endif /* AVCODEC_SBR_H */