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 encoder library *************************
96 
97    Author(s):   M. Multrus
98 
99    Description: Parameter Extraction
100 
101 *******************************************************************************/
102 
103 #ifndef SACENC_PARAMEXTRACT_H
104 #define SACENC_PARAMEXTRACT_H
105 
106 /* Includes ******************************************************************/
107 #include "common_fix.h"
108 #include "sacenc_lib.h"
109 #include "sacenc_const.h"
110 #include "sacenc_bitstream.h"
111 
112 /* Defines *******************************************************************/
113 #define MAX_CLD_QUANT_FINE (31)
114 #define MAX_CLD_QUANT_COARSE (15)
115 #define OFFSET_CLD_QUANT_COARSE (7)
116 #define OFFSET_CLD_QUANT_FINE (15)
117 
118 #define MAX_ICC_QUANT_COARSE (4)
119 #define MAX_ICC_QUANT_FINE (8)
120 #define OFFSET_ICC_QUANT_COARSE (0)
121 #define OFFSET_ICC_QUANT_FINE (0)
122 
123 #define MAX_NUM_PARAM_BANDS (28)
124 
125 #define NUM_MAPPED_HYBRID_BANDS (16)
126 
127 /* Data Types ****************************************************************/
128 typedef struct T_TTO_BOX *HANDLE_TTO_BOX;
129 
130 typedef enum {
131   BOX_SUBBANDS_INVALID = 0,
132   BOX_SUBBANDS_4 = 4,
133   BOX_SUBBANDS_5 = 5,
134   BOX_SUBBANDS_7 = 7,
135   BOX_SUBBANDS_9 = 9,
136   BOX_SUBBANDS_12 = 12,
137   BOX_SUBBANDS_15 = 15,
138   BOX_SUBBANDS_23 = 23
139 
140 } BOX_SUBBAND_CONFIG;
141 
142 typedef enum {
143   BOX_QUANTMODE_INVALID = -1,
144   BOX_QUANTMODE_FINE = 0,
145   BOX_QUANTMODE_EBQ1 = 1,
146   BOX_QUANTMODE_EBQ2 = 2,
147   BOX_QUANTMODE_RESERVED3 = 3,
148   BOX_QUANTMODE_RESERVED4 = 4,
149   BOX_QUANTMODE_RESERVED5 = 5,
150   BOX_QUANTMODE_RESERVED6 = 6,
151   BOX_QUANTMODE_RESERVED7 = 7
152 
153 } BOX_QUANTMODE;
154 
155 typedef struct T_TTO_BOX_CONFIG {
156   UCHAR bUseCoarseQuantCld;
157   UCHAR bUseCoarseQuantIcc;
158   UCHAR bUseCoherenceIccOnly;
159 
160   BOX_SUBBAND_CONFIG subbandConfig;
161   BOX_QUANTMODE boxQuantMode;
162 
163   UCHAR nHybridBandsMax;
164 
165   UCHAR bFrameKeep;
166 
167 } TTO_BOX_CONFIG;
168 
169 /* Constants *****************************************************************/
170 
171 /* Function / Class Declarations *********************************************/
172 FDK_SACENC_ERROR fdk_sacenc_createTtoBox(HANDLE_TTO_BOX *hTtoBox);
173 
174 FDK_SACENC_ERROR fdk_sacenc_initTtoBox(HANDLE_TTO_BOX hTtoBox,
175                                        const TTO_BOX_CONFIG *const ttoBoxConfig,
176                                        UCHAR *pParameterBand2HybridBandOffset);
177 
178 FDK_SACENC_ERROR fdk_sacenc_destroyTtoBox(HANDLE_TTO_BOX *hTtoBox);
179 
180 FDK_SACENC_ERROR fdk_sacenc_applyTtoBox(
181     HANDLE_TTO_BOX hTtoBox, const INT nTimeSlots, const INT startTimeSlot,
182     const INT nHybridBands, const FIXP_DPK *const *const ppHybridData1__FDK,
183     const FIXP_DPK *const *const ppHybridData2__FDK, SCHAR *const pIccIdx,
184     UCHAR *const pbIccQuantCoarse, SCHAR *const pCldIdx,
185     UCHAR *const pbCldQuantCoarse, const INT bUseBBCues, INT *scaleCh0,
186     INT *scaleCh1);
187 
188 INT fdk_sacenc_subband2ParamBand(const BOX_SUBBAND_CONFIG boxSubbandConfig,
189                                  const INT nSubband);
190 
191 const INT *fdk_sacenc_getSubbandImagSign();
192 
193 void fdk_sacenc_calcParameterBand2HybridBandOffset(
194     const BOX_SUBBAND_CONFIG subbandConfig, const INT nHybridBands,
195     UCHAR *pParameterBand2HybridBandOffset);
196 
197 /* Function / Class Definition ***********************************************/
fdk_sacenc_getCldQuantOffset(const INT bUseCoarseQuant)198 static inline UCHAR fdk_sacenc_getCldQuantOffset(const INT bUseCoarseQuant) {
199   return ((bUseCoarseQuant) ? OFFSET_CLD_QUANT_COARSE : OFFSET_CLD_QUANT_FINE);
200 }
fdk_sacenc_getIccQuantOffset(const INT bUseCoarseQuant)201 static inline UCHAR fdk_sacenc_getIccQuantOffset(const INT bUseCoarseQuant) {
202   return ((bUseCoarseQuant) ? OFFSET_ICC_QUANT_COARSE : OFFSET_ICC_QUANT_FINE);
203 }
204 
fdk_sacenc_getNumberCldQuantLevels(const INT bUseCoarseQuant)205 static inline UCHAR fdk_sacenc_getNumberCldQuantLevels(
206     const INT bUseCoarseQuant) {
207   return ((bUseCoarseQuant) ? MAX_CLD_QUANT_COARSE : MAX_CLD_QUANT_FINE);
208 }
fdk_sacenc_getNumberIccQuantLevels(const INT bUseCoarseQuant)209 static inline UCHAR fdk_sacenc_getNumberIccQuantLevels(
210     const INT bUseCoarseQuant) {
211   return ((bUseCoarseQuant) ? MAX_ICC_QUANT_COARSE : MAX_ICC_QUANT_FINE);
212 }
213 
214 #endif /* SACENC_PARAMEXTRACT_H */
215