• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* -----------------------------------------------------------------------------
2 Software License for The Fraunhofer FDK AAC Codec Library for Android
3 
4 © Copyright  1995 - 2019 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-D DRC decoder library **************************
96 
97    Author(s):
98 
99    Description:
100 
101 *******************************************************************************/
102 
103 #ifndef DRCDEC_GAINDECODER_H
104 #define DRCDEC_GAINDECODER_H
105 
106 #include "drcDecoder.h"
107 
108 /* Definitions common to gainDecoder submodule */
109 
110 #define NUM_LNB_FRAMES                                                         \
111   5 /* previous frame + this frame + one frame for DM_REGULAR_DELAY + (maximum \
112        delaySamples)/frameSize */
113 
114 /* QMF64 */
115 #define SUBBAND_NUM_BANDS_QMF64 64
116 #define SUBBAND_DOWNSAMPLING_FACTOR_QMF64 64
117 #define SUBBAND_ANALYSIS_DELAY_QMF64 320
118 
119 /* QMF71 (according to ISO/IEC 23003-1:2007) */
120 #define SUBBAND_NUM_BANDS_QMF71 71
121 #define SUBBAND_DOWNSAMPLING_FACTOR_QMF71 64
122 #define SUBBAND_ANALYSIS_DELAY_QMF71 320 + 384
123 
124 /* STFT256 (according to ISO/IEC 23008-3:2015/AMD3) */
125 #define SUBBAND_NUM_BANDS_STFT256 256
126 #define SUBBAND_DOWNSAMPLING_FACTOR_STFT256 256
127 #define SUBBAND_ANALYSIS_DELAY_STFT256 256
128 
129 typedef enum {
130   GAIN_DEC_DRC1,
131   GAIN_DEC_DRC1_DRC2,
132   GAIN_DEC_DRC2,
133   GAIN_DEC_DRC3,
134   GAIN_DEC_DRC2_DRC3
135 } GAIN_DEC_LOCATION;
136 
137 typedef enum { GAIN_DEC_FRAME_SIZE, GAIN_DEC_SAMPLE_RATE } GAIN_DEC_PARAM;
138 
139 typedef struct {
140   FIXP_DBL gainLin; /* e = 7 */
141   SHORT time;
142 } NODE_LIN;
143 
144 typedef struct {
145   GAIN_INTERPOLATION_TYPE gainInterpolationType;
146   int nNodes[NUM_LNB_FRAMES]; /* number of nodes, saturated to 16 */
147   NODE_LIN linearNode[NUM_LNB_FRAMES][16];
148 } LINEAR_NODE_BUFFER;
149 
150 typedef struct {
151   int lnbPointer;
152   LINEAR_NODE_BUFFER linearNodeBuffer[12];
153   LINEAR_NODE_BUFFER dummyLnb;
154   FIXP_DBL channelGain[8][NUM_LNB_FRAMES]; /* e = 8 */
155 } DRC_GAIN_BUFFERS;
156 
157 typedef struct {
158   int activeDrcOffset;
159   DRC_INSTRUCTIONS_UNI_DRC* pInst;
160   DRC_COEFFICIENTS_UNI_DRC* pCoef;
161 
162   DUCKING_MODIFICATION duckingModificationForChannelGroup[8];
163   SCHAR channelGroupForChannel[8];
164 
165   UCHAR bandCountForChannelGroup[8];
166   UCHAR gainElementForGroup[8];
167   UCHAR channelGroupIsParametricDrc[8];
168   UCHAR gainElementCount; /* number of different DRC gains inluding all DRC
169                              bands */
170   int lnbIndexForChannel[8][NUM_LNB_FRAMES];
171   int subbandGainsReady;
172 } ACTIVE_DRC;
173 
174 typedef struct {
175   int deltaTminDefault;
176   INT frameSize;
177   FIXP_DBL loudnessNormalisationGainDb;
178   DELAY_MODE delayMode;
179 
180   int nActiveDrcs;
181   ACTIVE_DRC activeDrc[MAX_ACTIVE_DRCS];
182   int multiBandActiveDrcIndex;
183   int channelGainActiveDrcIndex;
184   FIXP_DBL channelGain[8]; /* e = 8 */
185 
186   DRC_GAIN_BUFFERS drcGainBuffers;
187   FIXP_DBL subbandGains[12][4 * 1024 / 256];
188   FIXP_DBL dummySubbandGains[4 * 1024 / 256];
189 
190   int status;
191   int timeDomainSupported;
192   SUBBAND_DOMAIN_MODE subbandDomainSupported;
193 } DRC_GAIN_DECODER, *HANDLE_DRC_GAIN_DECODER;
194 
195 /* init functions */
196 DRC_ERROR
197 drcDec_GainDecoder_Open(HANDLE_DRC_GAIN_DECODER* phGainDec);
198 
199 DRC_ERROR
200 drcDec_GainDecoder_Init(HANDLE_DRC_GAIN_DECODER hGainDec);
201 
202 DRC_ERROR
203 drcDec_GainDecoder_SetParam(HANDLE_DRC_GAIN_DECODER hGainDec,
204                             const GAIN_DEC_PARAM paramType,
205                             const int paramValue);
206 
207 DRC_ERROR
208 drcDec_GainDecoder_SetCodecDependentParameters(
209     HANDLE_DRC_GAIN_DECODER hGainDec, const DELAY_MODE delayMode,
210     const int timeDomainSupported,
211     const SUBBAND_DOMAIN_MODE subbandDomainSupported);
212 
213 DRC_ERROR
214 drcDec_GainDecoder_Config(HANDLE_DRC_GAIN_DECODER hGainDec,
215                           HANDLE_UNI_DRC_CONFIG hUniDrcConfig,
216                           const UCHAR numSelectedDrcSets,
217                           const SCHAR* selectedDrcSetIds,
218                           const UCHAR* selectedDownmixIds);
219 
220 /* close functions */
221 DRC_ERROR
222 drcDec_GainDecoder_Close(HANDLE_DRC_GAIN_DECODER* phGainDec);
223 
224 /* process functions */
225 
226 /* call drcDec_GainDecoder_Preprocess first */
227 DRC_ERROR
228 drcDec_GainDecoder_Preprocess(HANDLE_DRC_GAIN_DECODER hGainDec,
229                               HANDLE_UNI_DRC_GAIN hUniDrcGain,
230                               const FIXP_DBL loudnessNormalizationGainDb,
231                               const FIXP_SGL boost, const FIXP_SGL compress);
232 
233 /* Then call one of drcDec_GainDecoder_ProcessTimeDomain or
234  * drcDec_GainDecoder_ProcessSubbandDomain */
235 DRC_ERROR
236 drcDec_GainDecoder_ProcessTimeDomain(
237     HANDLE_DRC_GAIN_DECODER hGainDec, const int delaySamples,
238     const GAIN_DEC_LOCATION drcLocation, const int channelOffset,
239     const int drcChannelOffset, const int numChannelsProcessed,
240     const int timeDataChannelOffset, FIXP_DBL* audioIOBuffer);
241 
242 DRC_ERROR
243 drcDec_GainDecoder_ProcessSubbandDomain(
244     HANDLE_DRC_GAIN_DECODER hGainDec, const int delaySamples,
245     GAIN_DEC_LOCATION drcLocation, const int channelOffset,
246     const int drcChannelOffset, const int numChannelsProcessed,
247     const int processSingleTimeslot, FIXP_DBL* audioIOBufferReal[],
248     FIXP_DBL* audioIOBufferImag[]);
249 
250 DRC_ERROR
251 drcDec_GainDecoder_Conceal(HANDLE_DRC_GAIN_DECODER hGainDec,
252                            HANDLE_UNI_DRC_CONFIG hUniDrcConfig,
253                            HANDLE_UNI_DRC_GAIN hUniDrcGain);
254 
255 DRC_ERROR
256 drcDec_GainDecoder_SetLoudnessNormalizationGainDb(
257     HANDLE_DRC_GAIN_DECODER hGainDec, FIXP_DBL loudnessNormalizationGainDb);
258 
259 int drcDec_GainDecoder_GetFrameSize(HANDLE_DRC_GAIN_DECODER hGainDec);
260 
261 int drcDec_GainDecoder_GetDeltaTminDefault(HANDLE_DRC_GAIN_DECODER hGainDec);
262 
263 void drcDec_GainDecoder_SetChannelGains(HANDLE_DRC_GAIN_DECODER hGainDec,
264                                         const int numChannels,
265                                         const int frameSize,
266                                         const FIXP_DBL* channelGainDb,
267                                         const int audioBufferChannelOffset,
268                                         FIXP_DBL* audioBuffer);
269 
270 #endif
271