Imported Debian version 0.1.3.1
[deb_fdk-aac.git] / libSBRdec / src / sbr_dec.h
1
2 /* -----------------------------------------------------------------------------------------------------------
3 Software License for The Fraunhofer FDK AAC Codec Library for Android
4
5 © Copyright 1995 - 2013 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
6 All rights reserved.
7
8 1. INTRODUCTION
9 The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
10 the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
11 This FDK AAC Codec software is intended to be used on a wide variety of Android devices.
12
13 AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
14 audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
15 independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
16 of the MPEG specifications.
17
18 Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
19 may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
20 individually for the purpose of encoding or decoding bit streams in products that are compliant with
21 the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
22 these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
23 software may already be covered under those patent licenses when it is used for those licensed purposes only.
24
25 Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
26 are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
27 applications information and documentation.
28
29 2. COPYRIGHT LICENSE
30
31 Redistribution and use in source and binary forms, with or without modification, are permitted without
32 payment of copyright license fees provided that you satisfy the following conditions:
33
34 You must retain the complete text of this software license in redistributions of the FDK AAC Codec or
35 your modifications thereto in source code form.
36
37 You must retain the complete text of this software license in the documentation and/or other materials
38 provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
39 You must make available free of charge copies of the complete source code of the FDK AAC Codec and your
40 modifications thereto to recipients of copies in binary form.
41
42 The name of Fraunhofer may not be used to endorse or promote products derived from this library without
43 prior written permission.
44
45 You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
46 software or your modifications thereto.
47
48 Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
49 and the date of any change. For modified versions of the FDK AAC Codec, the term
50 "Fraunhofer FDK AAC Codec Library for Android" must be replaced by the term
51 "Third-Party Modified Version of the Fraunhofer FDK AAC Codec Library for Android."
52
53 3. NO PATENT LICENSE
54
55 NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
56 ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
57 respect to this software.
58
59 You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
60 by appropriate patent licenses.
61
62 4. DISCLAIMER
63
64 This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright holders and contributors
65 "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, including but not limited to the implied warranties
66 of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
67 CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
68 including but not limited to procurement of substitute goods or services; loss of use, data, or profits,
69 or business interruption, however caused and on any theory of liability, whether in contract, strict
70 liability, or tort (including negligence), arising in any way out of the use of this software, even if
71 advised of the possibility of such damage.
72
73 5. CONTACT INFORMATION
74
75 Fraunhofer Institute for Integrated Circuits IIS
76 Attention: Audio and Multimedia Departments - FDK AAC LL
77 Am Wolfsmantel 33
78 91058 Erlangen, Germany
79
80 www.iis.fraunhofer.de/amm
81 amm-info@iis.fraunhofer.de
82 ----------------------------------------------------------------------------------------------------------- */
83
84 /*!
85 \file
86 \brief Sbr decoder
87 */
88 #ifndef __SBR_DEC_H
89 #define __SBR_DEC_H
90
91 #include "sbrdecoder.h"
92
93 #include "lpp_tran.h"
94 #include "qmf.h"
95 #include "env_calc.h"
96 #include "FDK_audio.h"
97
98
99 #include "sbrdec_drc.h"
100
101 #define SACDEC_ALIGNMENT_FIX
102
103 typedef struct
104 {
105 QMF_FILTER_BANK AnalysiscQMF;
106 QMF_FILTER_BANK SynthesisQMF;
107
108 SBR_CALCULATE_ENVELOPE SbrCalculateEnvelope;
109 SBR_LPP_TRANS LppTrans;
110
111 QMF_SCALE_FACTOR sbrScaleFactor;
112 QMF_SCALE_FACTOR sbrScaleFactorRight;
113
114 /*! Delayed spectral data needed for the dynamic framing of SBR. Not required in case of CLDFB */
115 FIXP_DBL * pSbrOverlapBuffer;
116
117 /* References to workbuffers */
118 FIXP_DBL * WorkBuffer1;
119 FIXP_DBL * WorkBuffer2;
120
121 /* QMF filter states */
122 FIXP_QAS anaQmfStates[(320)];
123 FIXP_QSS * pSynQmfStates;
124
125 /* Reference pointer arrays for QMF time slots,
126 mixed among overlap and current slots. */
127 FIXP_DBL * QmfBufferReal[(((1024)/(32))+(6))];
128 FIXP_DBL * QmfBufferImag[(((1024)/(32))+(6))];
129 int useLP;
130
131 /* QMF domain extension time slot reference pointer array */
132
133 SBRDEC_DRC_CHANNEL sbrDrcChannel;
134
135 } SBR_DEC;
136
137 typedef SBR_DEC *HANDLE_SBR_DEC;
138
139
140 typedef struct
141 {
142 SBR_FRAME_DATA frameData[(1)+1];
143 SBR_PREV_FRAME_DATA prevFrameData;
144 SBR_DEC SbrDec;
145 }
146 SBR_CHANNEL;
147
148 typedef SBR_CHANNEL *HANDLE_SBR_CHANNEL;
149
150 void
151 SbrDecodeAndProcess (HANDLE_SBR_DEC hSbrDec,
152 INT_PCM *timeIn,
153 HANDLE_SBR_HEADER_DATA hHeaderData,
154 HANDLE_SBR_FRAME_DATA hFrameData,
155 HANDLE_SBR_PREV_FRAME_DATA hPrevFrameData,
156 int applyProcessing,
157 int channelNr
158 , UCHAR useLP
159 );
160
161
162 void
163 SbrConstructTimeOutput (HANDLE_SBR_DEC hSbrDec, /*!< handle to Decoder channel */
164 INT_PCM *timeOut, /*!< pointer to output time signal */
165 HANDLE_SBR_HEADER_DATA hHeaderData,/*!< Static control data */
166 HANDLE_SBR_PREV_FRAME_DATA hPrevFrameData, /*!< Some control data of last frame */
167 int channelNr
168 ,UCHAR useLP
169 );
170
171
172 void
173 sbr_dec (HANDLE_SBR_DEC hSbrDec, /*!< handle to Decoder channel */
174 INT_PCM *timeIn, /*!< pointer to input time signal */
175 INT_PCM *timeOut, /*!< pointer to output time signal */
176 HANDLE_SBR_DEC hSbrDecRight, /*!< handle to Decoder channel right */
177 INT_PCM *timeOutRight, /*!< pointer to output time signal */
178 const int strideIn, /*!< Time data traversal strideIn */
179 const int strideOut, /*!< Time data traversal strideOut */
180 HANDLE_SBR_HEADER_DATA hHeaderData,/*!< Static control data */
181 HANDLE_SBR_FRAME_DATA hFrameData, /*!< Control data of current frame */
182 HANDLE_SBR_PREV_FRAME_DATA hPrevFrameData, /*!< Some control data of last frame */
183 const int applyProcessing, /*!< Flag for SBR operation */
184 HANDLE_PS_DEC h_ps_d,
185 const UINT flags
186 );
187
188
189
190 SBR_ERROR
191 createSbrDec (SBR_CHANNEL * hSbrChannel,
192 HANDLE_SBR_HEADER_DATA hHeaderData,
193 TRANSPOSER_SETTINGS *pSettings,
194 const int downsampleFac,
195 const UINT qmfFlags,
196 const UINT flags,
197 const int overlap,
198 int chan);
199
200 int
201 deleteSbrDec (SBR_CHANNEL * hSbrChannel);
202
203 SBR_ERROR
204 resetSbrDec (HANDLE_SBR_DEC hSbrDec,
205 HANDLE_SBR_HEADER_DATA hHeaderData,
206 HANDLE_SBR_PREV_FRAME_DATA hPrevFrameData,
207 const int useLP,
208 const int downsampleFac);
209
210 #endif