• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* -----------------------------------------------------------------------------
2 Software License for The Fraunhofer FDK AAC Codec Library for Android
3 
4 © Copyright  1995 - 2018 Fraunhofer-Gesellschaft zur Förderung der angewandten
5 Forschung e.V. All rights reserved.
6 
7  1.    INTRODUCTION
8 The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software
9 that implements the MPEG Advanced Audio Coding ("AAC") encoding and decoding
10 scheme for digital audio. This FDK AAC Codec software is intended to be used on
11 a wide variety of Android devices.
12 
13 AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient
14 general perceptual audio codecs. AAC-ELD is considered the best-performing
15 full-bandwidth communications codec by independent studies and is widely
16 deployed. AAC has been standardized by ISO and IEC as part of the MPEG
17 specifications.
18 
19 Patent licenses for necessary patent claims for the FDK AAC Codec (including
20 those of Fraunhofer) may be obtained through Via Licensing
21 (www.vialicensing.com) or through the respective patent owners individually for
22 the purpose of encoding or decoding bit streams in products that are compliant
23 with the ISO/IEC MPEG audio standards. Please note that most manufacturers of
24 Android devices already license these patent claims through Via Licensing or
25 directly from the patent owners, and therefore FDK AAC Codec software may
26 already be covered under those patent licenses when it is used for those
27 licensed purposes only.
28 
29 Commercially-licensed AAC software libraries, including floating-point versions
30 with enhanced sound quality, are also available from Fraunhofer. Users are
31 encouraged to check the Fraunhofer website for additional applications
32 information and documentation.
33 
34 2.    COPYRIGHT LICENSE
35 
36 Redistribution and use in source and binary forms, with or without modification,
37 are permitted without payment of copyright license fees provided that you
38 satisfy the following conditions:
39 
40 You must retain the complete text of this software license in redistributions of
41 the FDK AAC Codec or your modifications thereto in source code form.
42 
43 You must retain the complete text of this software license in the documentation
44 and/or other materials provided with redistributions of the FDK AAC Codec or
45 your modifications thereto in binary form. You must make available free of
46 charge copies of the complete source code of the FDK AAC Codec and your
47 modifications thereto to recipients of copies in binary form.
48 
49 The name of Fraunhofer may not be used to endorse or promote products derived
50 from this library without prior written permission.
51 
52 You may not charge copyright license fees for anyone to use, copy or distribute
53 the FDK AAC Codec software or your modifications thereto.
54 
55 Your modified versions of the FDK AAC Codec must carry prominent notices stating
56 that you changed the software and the date of any change. For modified versions
57 of the FDK AAC Codec, the term "Fraunhofer FDK AAC Codec Library for Android"
58 must be replaced by the term "Third-Party Modified Version of the Fraunhofer FDK
59 AAC Codec Library for Android."
60 
61 3.    NO PATENT LICENSE
62 
63 NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without
64 limitation the patents of Fraunhofer, ARE GRANTED BY THIS SOFTWARE LICENSE.
65 Fraunhofer provides no warranty of patent non-infringement with respect to this
66 software.
67 
68 You may use this FDK AAC Codec software or modifications thereto only for
69 purposes that are authorized by appropriate patent licenses.
70 
71 4.    DISCLAIMER
72 
73 This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright
74 holders and contributors "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
75 including but not limited to the implied warranties of merchantability and
76 fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
77 CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary,
78 or consequential damages, including but not limited to procurement of substitute
79 goods or services; loss of use, data, or profits, or business interruption,
80 however caused and on any theory of liability, whether in contract, strict
81 liability, or tort (including negligence), arising in any way out of the use of
82 this software, even if advised of the possibility of such damage.
83 
84 5.    CONTACT INFORMATION
85 
86 Fraunhofer Institute for Integrated Circuits IIS
87 Attention: Audio and Multimedia Departments - FDK AAC LL
88 Am Wolfsmantel 33
89 91058 Erlangen, Germany
90 
91 www.iis.fraunhofer.de/amm
92 amm-info@iis.fraunhofer.de
93 ----------------------------------------------------------------------------- */
94 
95 /*********************** MPEG surround decoder library *************************
96 
97    Author(s):
98 
99    Description: SAC Processing
100 
101 *******************************************************************************/
102 
103 /*!
104   \file
105   \brief  Polyphase Filterbank
106 */
107 
108 #ifndef SAC_PROCESS_H
109 #define SAC_PROCESS_H
110 
111 #include "sac_dec.h"
112 
113 void SpatialDecApplyPhase(spatialDec *self, FIXP_SGL alpha,
114                           int lastSlotOfParamSet);
115 
116 /**
117  * \brief  Apply QMF Analysis Filterbank.
118  *
119  * Calculates qmf data on downmix input time data.
120  * Delaylines will be applied if necessaray.
121  *
122  * \param self                A spatial decoder handle.
123  * \param inData              Downmix channel time data as input.
124  * \param ts                  Signals time slot offset for input buffer.
125  * \param qmfReal             Downmix channel qmf output data.
126  * \param qmfImag             Downmix channel qmf output data.
127  *
128  * \return  Error status.
129  */
130 SACDEC_ERROR SpatialDecQMFAnalysis(spatialDec *self, const PCM_MPS *inData,
131                                    const INT ts, const INT bypassMode,
132                                    FIXP_DBL **qmfReal, FIXP_DBL **qmfImag,
133                                    const int numInputChannels);
134 
135 /**
136  * \brief  Feed spatial decoder with external qmf data.
137  *
138  * \param self                A spatial decoder handle.
139  * \param qmfInDataReal       External qmf downmix data as input.
140  * \param qmfInDataImag       External qmf downmix data as input.
141  * \param ts                  Signals time slot in input buffer to process.
142  * \param qmfReal             Downmix channel qmf output data.
143  * \param qmfImag             Downmix channel qmf output data.
144  * \param numInputChannels    Number of input channels. Might differ from
145  * self->numInputChannels.
146  *
147  * \return  Error status.
148  */
149 SACDEC_ERROR SpatialDecFeedQMF(spatialDec *self, FIXP_DBL **qmfInDataReal,
150                                FIXP_DBL **qmfInDataImag, const INT ts,
151                                const INT bypassMode, FIXP_DBL **qmfReal,
152                                FIXP_DBL **qmfImag, const INT numInputChannels);
153 
154 /**
155  * \brief  Apply Hybrdid Analysis Filterbank.
156  *
157  * Calculates hybrid data on downmix input data.
158  * Residual hybrid signals will also be calculated on current slot if available.
159  *
160  * \param self                A spatial decoder handle.
161  * \param qmfInputReal        Downmix channel qmf data as input.
162  * \param qmfInputImag        Downmix channel qmf data as input.
163  * \param hybOutputReal       Downmix channel hybrid output data.
164  * \param hybOutputImag       Downmix channel hybrid output data.
165  * \param ts                  Signals time slot in spatial frame to process.
166  * \param numInputChannels    Number of input channels. Might differ from
167  * self->numInputChannels.
168  *
169  * \return  Error status.
170  */
171 SACDEC_ERROR SpatialDecHybridAnalysis(spatialDec *self, FIXP_DBL **qmfInputReal,
172                                       FIXP_DBL **qmfInputImag,
173                                       FIXP_DBL **hybOutputReal,
174                                       FIXP_DBL **hybOutputImag, const INT ts,
175                                       const INT numInputChannels);
176 
177 /**
178  * \brief  Create X data.
179  *
180  * Returns a pointer list over Xchannels pointing to downmix input channels
181  * and to residual channels when provided.
182  *
183  * \param self                A spatial decoder handle.
184  * \param hybInputReal        Downmix channel hybrid data as input.
185  * \param hybInputImag        Downmix channel hybrid data as input.
186  * \param pxReal              Pointer to hybrid and residual data as output.
187  * \param pxImag              Pointer to hybrid and residual data as output.
188  *
189  * \return  Error status.
190  */
191 SACDEC_ERROR SpatialDecCreateX(spatialDec *self, FIXP_DBL **hybInputReal,
192                                FIXP_DBL **hybInputImag, FIXP_DBL **pxReal,
193                                FIXP_DBL **pxImag);
194 
195 /**
196  * \brief  MPS212 combined version of apply M1 parameters and create wet signal
197  *
198  * \param self                A spatial decoder handle.
199  * \param xReal               Downmix and residual X data as input.
200  * \param xImag               Downmix and residual X data as input.
201  * \param vReal               output data: [0] direct signal (V); [1] wet signal
202  * (W).
203  * \param vImag               output data: [0] direct signal (V); [1] wet signal
204  * (W).
205  *
206  * \return  Error status.
207  */
208 SACDEC_ERROR SpatialDecApplyM1_CreateW_Mode212(
209     spatialDec *self, const SPATIAL_BS_FRAME *frame, FIXP_DBL **xReal,
210     FIXP_DBL **xImag, FIXP_DBL **vReal, FIXP_DBL **vImag);
211 
212 /**
213  * \brief  Apply M2 parameters.
214  *
215  * \param self                A spatial decoder handle.
216  * \param ps                  Signals parameter band from where M2 parameter to
217  * use.
218  * \param alpha               Smoothing factor between current and previous
219  * parameter band. Rangeability between 0.f and 1.f.
220  * \param wReal               Wet input data.
221  * \param wImag               Wet input data.
222  * \param hybOutputRealDry    Dry output data.
223  * \param hybOutputImagDry    Dry output data.
224  * \param hybOutputRealWet    Wet output data.
225  * \param hybOutputImagWet    Wet output data.
226  *
227  * \return  Error status.
228  */
229 SACDEC_ERROR SpatialDecApplyM2(spatialDec *self, INT ps, const FIXP_SGL alpha,
230                                FIXP_DBL **wReal, FIXP_DBL **wImag,
231                                FIXP_DBL **hybOutputRealDry,
232                                FIXP_DBL **hybOutputImagDry,
233                                FIXP_DBL **hybOutputRealWet,
234                                FIXP_DBL **hybOutputImagWet);
235 
236 /**
237  * \brief  Apply M2 parameter for 212 mode with residualCoding and phaseCoding.
238  *
239  * \param self                [i] A spatial decoder handle.
240  * \param ps                  [i] Signals parameter band from where M2 parameter
241  * to use.
242  * \param alpha               [i] Smoothing factor between current and previous
243  * parameter band. Rangeability between 0.f and 1.f.
244  * \param wReal               [i] Wet input data.
245  * \param wImag               [i] Wet input data.
246  * \param hybOutputRealDry    [o] Dry output data.
247  * \param hybOutputImagDry    [o] Dry output data.
248  *
249  * \return error
250  */
251 SACDEC_ERROR SpatialDecApplyM2_Mode212_ResidualsPlusPhaseCoding(
252     spatialDec *self, INT ps, const FIXP_SGL alpha, FIXP_DBL **wReal,
253     FIXP_DBL **wImag, FIXP_DBL **hybOutputRealDry, FIXP_DBL **hybOutputImagDry);
254 
255 /**
256  * \brief  Apply M2 parameter for 212 mode, upmix from mono to stereo.
257  *
258  * \param self                [i] A spatial decoder handle.
259  * \param ps                  [i] Signals parameter band from where M2 parameter
260  * to use.
261  * \param alpha               [i] Smoothing factor between current and previous
262  * parameter band. Rangeability between 0.f and 1.f.
263  * \param wReal               [i] Wet input data.
264  * \param wImag               [i] Wet input data.
265  * \param hybOutputRealDry    [o] Dry output data.
266  * \param hybOutputImagDry    [o] Dry output data.
267  *
268  * \return error
269  */
270 SACDEC_ERROR SpatialDecApplyM2_Mode212(spatialDec *self, INT ps,
271                                        const FIXP_SGL alpha, FIXP_DBL **wReal,
272                                        FIXP_DBL **wImag,
273                                        FIXP_DBL **hybOutputRealDry,
274                                        FIXP_DBL **hybOutputImagDry);
275 
276 /**
277  * \brief  Convert Hybrid input to output audio data.
278  *
279  * \param hSpaceSynthesisQmf  A spatial decoder handle.
280  * \param ts                  Signals time slot in spatial frame to process.
281  * \param hybOutputReal       Hybrid data as input.
282  * \param hybOutputImag       Hybrid data as input.
283  * \param timeOut             audio output data.
284  *
285  * \return  Error status.
286  */
287 SACDEC_ERROR SpatialDecSynthesis(spatialDec *self, const INT ts,
288                                  FIXP_DBL **hybOutputReal,
289                                  FIXP_DBL **hybOutputImag, PCM_MPS *timeOut,
290                                  const INT numInputChannels,
291                                  const FDK_channelMapDescr *const mapDescr);
292 
293 void SpatialDecBufferMatrices(spatialDec *self);
294 
295 FIXP_DBL getChGain(spatialDec *self, UINT ch, INT *scale);
296 
297 #endif
298