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