1
2/* -----------------------------------------------------------------------------------------------------------
3Software 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
9The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
10the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
11This FDK AAC Codec software is intended to be used on a wide variety of Android devices.
12
13AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
14audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
15independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
16of the MPEG specifications.
17
18Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
19may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
20individually for the purpose of encoding or decoding bit streams in products that are compliant with
21the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
22these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
23software may already be covered under those patent licenses when it is used for those licensed purposes only.
24
25Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
26are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
27applications information and documentation.
28
292.    COPYRIGHT LICENSE
30
31Redistribution and use in source and binary forms, with or without modification, are permitted without
32payment of copyright license fees provided that you satisfy the following conditions:
33
34You must retain the complete text of this software license in redistributions of the FDK AAC Codec or
35your modifications thereto in source code form.
36
37You must retain the complete text of this software license in the documentation and/or other materials
38provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
39You must make available free of charge copies of the complete source code of the FDK AAC Codec and your
40modifications thereto to recipients of copies in binary form.
41
42The name of Fraunhofer may not be used to endorse or promote products derived from this library without
43prior written permission.
44
45You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
46software or your modifications thereto.
47
48Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
49and 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
533.    NO PATENT LICENSE
54
55NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
56ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
57respect to this software.
58
59You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
60by appropriate patent licenses.
61
624.    DISCLAIMER
63
64This 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
66of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
67CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
68including but not limited to procurement of substitute goods or services; loss of use, data, or profits,
69or business interruption, however caused and on any theory of liability, whether in contract, strict
70liability, or tort (including negligence), arising in any way out of the use of this software, even if
71advised of the possibility of such damage.
72
735.    CONTACT INFORMATION
74
75Fraunhofer Institute for Integrated Circuits IIS
76Attention: Audio and Multimedia Departments - FDK AAC LL
77Am Wolfsmantel 33
7891058 Erlangen, Germany
79
80www.iis.fraunhofer.de/amm
81amm-info@iis.fraunhofer.de
82----------------------------------------------------------------------------------------------------------- */
83
84/***************************  Fraunhofer IIS FDK Tools  **********************
85
86   Author(s): Markus Lohwasser
87   Description: FDK Tools Hybrid Filterbank
88
89******************************************************************************/
90
91#ifndef __FDK_HYBRID_H
92#define __FDK_HYBRID_H
93
94
95
96#include "common_fix.h"
97
98/*--------------- enums -------------------------------*/
99
100/**
101 * Hybrid Filterband modes.
102 */
103typedef enum {
104    THREE_TO_TEN,
105    THREE_TO_TWELVE,
106    THREE_TO_SIXTEEN
107
108} FDK_HYBRID_MODE;
109
110
111/*--------------- structure definitions ---------------*/
112typedef struct FDK_HYBRID_SETUP *HANDLE_FDK_HYBRID_SETUP;
113
114typedef struct
115{
116  FIXP_DBL             *bufferLFReal[3];     /*!< LF real filter states. */
117  FIXP_DBL             *bufferLFImag[3];     /*!< LF imag filter states. */
118  FIXP_DBL             *bufferHFReal[13];    /*!< HF real delay lines. */
119  FIXP_DBL             *bufferHFImag[13];    /*!< HF imag delay lines. */
120
121  INT                   bufferLFpos;         /*!< Position to write incoming data into ringbuffer. */
122  INT                   bufferHFpos;         /*!< Delay line positioning. */
123  INT                   nrBands;             /*!< Number of QMF bands. */
124  INT                   cplxBands;           /*!< Number of complex QMF bands.*/
125  UCHAR                 hfMode;              /*!< Flag signalizes treatment of HF bands. */
126
127  FIXP_DBL             *pLFmemory;           /*!< Pointer to LF states buffer. */
128  FIXP_DBL             *pHFmemory;           /*!< Pointer to HF states buffer. */
129
130  UINT                  LFmemorySize;        /*!< Size of LF states buffer. */
131  UINT                  HFmemorySize;        /*!< Size of HF states buffer. */
132
133  HANDLE_FDK_HYBRID_SETUP pSetup;            /*!< Pointer to filter setup. */
134
135} FDK_ANA_HYB_FILTER;
136
137
138typedef struct
139{
140  INT                   nrBands;             /*!< Number of QMF bands. */
141  INT                   cplxBands;           /*!< Number of complex QMF bands.*/
142
143  HANDLE_FDK_HYBRID_SETUP pSetup;            /*!< Pointer to filter setup. */
144
145} FDK_SYN_HYB_FILTER;
146
147typedef FDK_ANA_HYB_FILTER *HANDLE_FDK_ANA_HYB_FILTER;
148typedef FDK_SYN_HYB_FILTER *HANDLE_FDK_SYN_HYB_FILTER;
149
150
151/**
152 * \brief  Create one instance of Hybrid Analyis Filterbank.
153 *
154 * \param hAnalysisHybFilter  Pointer to an outlying allocated Hybrid Analysis Filterbank structure.
155 * \param pLFmemory           Pointer to outlying buffer used LF filtering.
156 * \param LFmemorySize        Size of pLFmemory in bytes.
157 * \param pHFmemory           Pointer to outlying buffer used HF delay line.
158 * \param HFmemorySize        Size of pLFmemory in bytes.
159 *
160 * \return  0 on success.
161 */
162INT FDKhybridAnalysisOpen(
163        HANDLE_FDK_ANA_HYB_FILTER  hAnalysisHybFilter,
164        FIXP_DBL *const            pLFmemory,
165        const UINT                 LFmemorySize,
166        FIXP_DBL *const            pHFmemory,
167        const UINT                 HFmemorySize
168        );
169
170
171/**
172 * \brief  Initialize and configure Hybrdid Analysis Filterbank instance.
173 *
174 * \param hAnalysisHybFilter  A Hybrid Analysis Filterbank handle.
175 * \param mode                Select hybrid filter configuration.
176 * \param qmfBands            Number of qmf bands to be processed.
177 * \param cplxBands           Number of complex qmf bands to be processed.
178 * \param initStatesFlag      Indicates whether the states buffer has to be cleared.
179 *
180 * \return  0 on success.
181 */
182INT FDKhybridAnalysisInit(
183        HANDLE_FDK_ANA_HYB_FILTER  hAnalysisHybFilter,
184        const FDK_HYBRID_MODE      mode,
185        const INT                  qmfBands,
186        const INT                  cplxBands,
187        const INT                  initStatesFlag
188        );
189
190
191/**
192 * \brief  Adjust Hybrdid Analysis Filterbank states.
193 *
194 * \param hAnalysisHybFilter  A Hybrid Analysis Filterbank handle.
195 * \param scalingValue        Scaling value to be applied on filter states.
196 *
197 * \return  0 on success.
198 */
199INT FDKhybridAnalysisScaleStates(
200        HANDLE_FDK_ANA_HYB_FILTER  hAnalysisHybFilter,
201        const INT                  scalingValue
202        );
203
204
205/**
206 * \brief  Apply Hybrid Analysis Filterbank on Qmf input data.
207 *
208 * \param hAnalysisHybFilter  A Hybrid Analysis Filterbank handle.
209 * \param pQmfReal            Qmf input data.
210 * \param pQmfImag            Qmf input data.
211 * \param pHybridReal         Hybrid output data.
212 * \param pHybridImag         Hybrid output data.
213 *
214 * \return  0 on success.
215 */
216INT FDKhybridAnalysisApply(
217        HANDLE_FDK_ANA_HYB_FILTER  hAnalysisHybFilter,
218        const FIXP_DBL *const      pQmfReal,
219        const FIXP_DBL *const      pQmfImag,
220        FIXP_DBL *const            pHybridReal,
221        FIXP_DBL *const            pHybridImag
222        );
223
224
225/**
226 * \brief  Close a Hybrid Analysis Filterbank instance.
227 *
228 * \param hAnalysisHybFilter  Pointer to a Hybrid Analysis Filterbank instance.
229 *
230 * \return  0 on success.
231 */
232INT FDKhybridAnalysisClose(
233        HANDLE_FDK_ANA_HYB_FILTER  hAnalysisHybFilter
234        );
235
236/**
237 * \brief  Initialize and configure Hybrdid Synthesis Filterbank instance.
238 *
239 * \param hSynthesisHybFilter A Hybrid Synthesis Filterbank handle.
240 * \param mode                Select hybrid filter configuration.
241 * \param qmfBands            Number of qmf bands to be processed.
242 * \param cplxBands           Number of complex qmf bands to be processed.
243 *
244 * \return  0 on success.
245 */
246INT FDKhybridSynthesisInit(
247        HANDLE_FDK_SYN_HYB_FILTER  hSynthesisHybFilter,
248        const FDK_HYBRID_MODE      mode,
249        const INT                  qmfBands,
250        const INT                  cplxBands
251        );
252
253/**
254 * \brief  Apply Hybrid Analysis Filterbank on Hybrid data.
255 *
256 * \param hSynthesisHybFilter  A Hybrid Analysis Filterbandk handle.
257 * \param pHybridReal          Hybrid input data.
258 * \param pHybridImag          Hybrid input data.
259 * \param pQmfReal             Qmf output data.
260 * \param pQmfImag             Qmf output data.
261 *
262 * \return  0 on success.
263 */
264INT FDKhybridSynthesisApply(
265        HANDLE_FDK_SYN_HYB_FILTER  hSynthesisHybFilter,
266        const FIXP_DBL *const      pHybridReal,
267        const FIXP_DBL *const      pHybridImag,
268        FIXP_DBL *const            pQmfReal,
269        FIXP_DBL *const            pQmfImag
270        );
271
272
273#endif /* __FDK_HYBRID_H */
274