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