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 /**************************** AAC encoder library ******************************
96 
97    Author(s):   Alex Groeschel
98 
99    Description: Temporal noise shaping
100 
101 *******************************************************************************/
102 
103 #ifndef AACENC_TNS_H
104 #define AACENC_TNS_H
105 
106 #include "common_fix.h"
107 
108 #include "psy_const.h"
109 
110 #ifndef PI
111 #define PI 3.1415926535897931f
112 #endif
113 
114 /**
115  * TNS_ENABLE_MASK
116  * This bitfield defines which TNS features are enabled
117  *   The TNS mask is composed of 4 bits.
118  *   tnsMask |= 0x1; activate TNS short blocks
119  *   tnsMask |= 0x2; activate TNS for long blocks
120  *   tnsMask |= 0x4; activate TNS PEAK tool for short blocks
121  *   tnsMask |= 0x8; activate TNS PEAK tool for long blocks
122  */
123 #define TNS_ENABLE_MASK 0xf
124 
125 /* TNS max filter order for Low Complexity MPEG4 profile */
126 #define TNS_MAX_ORDER 12
127 
128 #define MAX_NUM_OF_FILTERS 2
129 
130 #define HIFILT 0 /* index of higher filter   */
131 #define LOFILT 1 /* index of lower filter    */
132 
133 typedef struct { /* stuff that is tabulated dependent on bitrate etc. */
134   INT filterEnabled[MAX_NUM_OF_FILTERS];
135   INT threshOn[MAX_NUM_OF_FILTERS];        /* min. prediction gain for using tns
136                                               TABUL*/
137   INT filterStartFreq[MAX_NUM_OF_FILTERS]; /* lowest freq for lpc TABUL*/
138   INT tnsLimitOrder[MAX_NUM_OF_FILTERS];   /* Limit for TNS order TABUL*/
139   INT tnsFilterDirection[MAX_NUM_OF_FILTERS]; /* Filtering direction, 0=up,
140                                                  1=down TABUL */
141   INT acfSplit[MAX_NUM_OF_FILTERS];
142   FIXP_DBL tnsTimeResolution[MAX_NUM_OF_FILTERS]; /* TNS max. time resolution
143                                                      TABUL. Should be fract but
144                                                      MSVC won't compile then */
145   INT seperateFiltersAllowed;
146 } TNS_PARAMETER_TABULATED;
147 
148 typedef struct { /*assigned at InitTime*/
149   TNS_PARAMETER_TABULATED confTab;
150   INT isLowDelay;
151   INT tnsActive;
152   INT maxOrder; /* max. order of tns filter */
153   INT coefRes;
154   FIXP_DBL acfWindow[MAX_NUM_OF_FILTERS][TNS_MAX_ORDER + 3 + 1];
155   /* now some things that only probably can be done at Init time;
156      could be they have to be split up for each individual (short) window or
157      even filter.  */
158   INT lpcStartBand[MAX_NUM_OF_FILTERS];
159   INT lpcStartLine[MAX_NUM_OF_FILTERS];
160   INT lpcStopBand;
161   INT lpcStopLine;
162 
163 } TNS_CONFIG;
164 
165 typedef struct {
166   INT tnsActive[MAX_NUM_OF_FILTERS];
167   INT predictionGain[MAX_NUM_OF_FILTERS];
168 } TNS_SUBBLOCK_INFO;
169 
170 typedef struct { /*changed at runTime*/
171   TNS_SUBBLOCK_INFO subBlockInfo[TRANS_FAC];
172   FIXP_DBL ratioMultTable[TRANS_FAC][MAX_SFB_SHORT];
173 } TNS_DATA_SHORT;
174 
175 typedef struct { /*changed at runTime*/
176   TNS_SUBBLOCK_INFO subBlockInfo;
177   FIXP_DBL ratioMultTable[MAX_SFB_LONG];
178 } TNS_DATA_LONG;
179 
180 /* can be implemented as union */
181 typedef shouldBeUnion {
182   TNS_DATA_LONG Long;
183   TNS_DATA_SHORT Short;
184 }
185 TNS_DATA_RAW;
186 
187 typedef struct {
188   INT numOfSubblocks;
189   TNS_DATA_RAW dataRaw;
190   INT tnsMaxScaleSpec;
191   INT filtersMerged;
192 } TNS_DATA;
193 
194 typedef struct {
195   INT numOfFilters[TRANS_FAC];
196   INT coefRes[TRANS_FAC];
197   INT length[TRANS_FAC][MAX_NUM_OF_FILTERS];
198   INT order[TRANS_FAC][MAX_NUM_OF_FILTERS];
199   INT direction[TRANS_FAC][MAX_NUM_OF_FILTERS];
200   INT coefCompress[TRANS_FAC][MAX_NUM_OF_FILTERS];
201   /* for Long: length TNS_MAX_ORDER (12 for LC) is required -> 12 */
202   /* for Short: length TRANS_FAC*TNS_MAX_ORDER (only 5 for short LC) is required
203    * -> 8*5=40 */
204   /* Currently TRANS_FAC*TNS_MAX_ORDER = 8*12 = 96 (for LC) is used (per
205    * channel)! Memory could be saved here! */
206   INT coef[TRANS_FAC][MAX_NUM_OF_FILTERS][TNS_MAX_ORDER];
207 } TNS_INFO;
208 
209 INT FDKaacEnc_FreqToBandWidthRounding(const INT freq, const INT fs,
210                                       const INT numOfBands,
211                                       const INT *bandStartOffset);
212 
213 #endif /* AACENC_TNS_H */
214