• 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 /**************************** SBR encoder library ******************************
96 
97    Author(s):
98 
99    Description:
100 
101 *******************************************************************************/
102 
103 /*!
104   \file
105   \brief  SBR main definitions $Revision: 92790 $
106 */
107 #ifndef SBR_DEF_H
108 #define SBR_DEF_H
109 
110 #include "common_fix.h"
111 
112 #define noError 0
113 #define HANDLE_ERROR_INFO INT
114 #define ERROR(a, b) 1
115 
116 /* #define SBR_ENV_STATISTICS_BITRATE */
117 #undef SBR_ENV_STATISTICS_BITRATE
118 
119 /* #define SBR_ENV_STATISTICS */
120 #undef SBR_ENV_STATISTICS
121 
122 /* #define SBR_PAYLOAD_MONITOR */
123 #undef SBR_PAYLOAD_MONITOR
124 
125 #define SWAP(a, b) tempr = a, a = b, b = tempr
126 #define TRUE 1
127 #define FALSE 0
128 
129 /* Constants */
130 #define EPS 1e-12
131 #define LOG2 0.69314718056f /* natural logarithm of 2 */
132 #define ILOG2 1.442695041f  /* 1/LOG2 */
133 #define RELAXATION_FLOAT (1e-6f)
134 #define RELAXATION (FL2FXCONST_DBL(RELAXATION_FLOAT))
135 #define RELAXATION_FRACT \
136   (FL2FXCONST_DBL(0.524288f)) /* 0.524288f is fractional part of RELAXATION */
137 #define RELAXATION_SHIFT (19)
138 #define RELAXATION_LD64                                 \
139   (FL2FXCONST_DBL(0.31143075889f)) /* (ld64(RELAXATION) \
140                                     */
141 
142 /************  Definitions ***************/
143 #define SBR_COMP_MODE_DELTA 0
144 #define SBR_COMP_MODE_CTS 1
145 #define SBR_MAX_ENERGY_VALUES 5
146 #define SBR_GLOBAL_TONALITY_VALUES 2
147 
148 #define MAX_NUM_CHANNELS 2
149 
150 #define MAX_NOISE_ENVELOPES 2
151 #define MAX_NUM_NOISE_COEFFS 5
152 #define MAX_NUM_NOISE_VALUES (MAX_NUM_NOISE_COEFFS * MAX_NOISE_ENVELOPES)
153 
154 #define MAX_NUM_ENVELOPE_VALUES (MAX_ENVELOPES * MAX_FREQ_COEFFS)
155 #define MAX_ENVELOPES 5
156 #define MAX_FREQ_COEFFS 48
157 
158 #define MAX_FREQ_COEFFS_FS44100 35
159 #define MAX_FREQ_COEFFS_FS48000 32
160 
161 #define NO_OF_ESTIMATES_LC 4
162 #define NO_OF_ESTIMATES_LD 3
163 #define MAX_NO_OF_ESTIMATES 4
164 
165 #define NOISE_FLOOR_OFFSET 6
166 #define NOISE_FLOOR_OFFSET_64 (FL2FXCONST_DBL(0.09375f))
167 
168 #define LOW_RES 0
169 #define HIGH_RES 1
170 
171 #define LO 0
172 #define HI 1
173 
174 #define LENGTH_SBR_FRAME_INFO 35 /* 19 */
175 
176 #define SBR_NSFB_LOW_RES 9   /*  8 */
177 #define SBR_NSFB_HIGH_RES 18 /* 16 */
178 
179 #define SBR_XPOS_CTRL_DEFAULT 2
180 
181 #define SBR_FREQ_SCALE_DEFAULT 2
182 #define SBR_ALTER_SCALE_DEFAULT 1
183 #define SBR_NOISE_BANDS_DEFAULT 2
184 
185 #define SBR_LIMITER_BANDS_DEFAULT 2
186 #define SBR_LIMITER_GAINS_DEFAULT 2
187 #define SBR_LIMITER_GAINS_INFINITE 3
188 #define SBR_INTERPOL_FREQ_DEFAULT 1
189 #define SBR_SMOOTHING_LENGTH_DEFAULT 0
190 
191 /* sbr_header */
192 #define SI_SBR_AMP_RES_BITS 1
193 #define SI_SBR_COUPLING_BITS 1
194 #define SI_SBR_START_FREQ_BITS 4
195 #define SI_SBR_STOP_FREQ_BITS 4
196 #define SI_SBR_XOVER_BAND_BITS 3
197 #define SI_SBR_RESERVED_BITS 2
198 #define SI_SBR_DATA_EXTRA_BITS 1
199 #define SI_SBR_HEADER_EXTRA_1_BITS 1
200 #define SI_SBR_HEADER_EXTRA_2_BITS 1
201 
202 /* sbr_header extra 1 */
203 #define SI_SBR_FREQ_SCALE_BITS 2
204 #define SI_SBR_ALTER_SCALE_BITS 1
205 #define SI_SBR_NOISE_BANDS_BITS 2
206 
207 /* sbr_header extra 2 */
208 #define SI_SBR_LIMITER_BANDS_BITS 2
209 #define SI_SBR_LIMITER_GAINS_BITS 2
210 #define SI_SBR_INTERPOL_FREQ_BITS 1
211 #define SI_SBR_SMOOTHING_LENGTH_BITS 1
212 
213 /* sbr_grid */
214 #define SBR_CLA_BITS 2    /*!< size of bs_frame_class */
215 #define SBR_CLA_BITS_LD 1 /*!< size of bs_frame_class */
216 #define SBR_ENV_BITS 2    /*!< size of bs_num_env_raw */
217 #define SBR_ABS_BITS 2    /*!< size of bs_abs_bord_raw for HE-AAC */
218 #define SBR_NUM_BITS 2    /*!< size of bs_num_rel */
219 #define SBR_REL_BITS 2    /*!< size of bs_rel_bord_raw */
220 #define SBR_RES_BITS 1    /*!< size of bs_freq_res_flag */
221 #define SBR_DIR_BITS 1    /*!< size of bs_df_flag */
222 
223 /* sbr_data */
224 #define SI_SBR_INVF_MODE_BITS 2
225 
226 #define SI_SBR_START_ENV_BITS_AMP_RES_3_0 6
227 #define SI_SBR_START_ENV_BITS_BALANCE_AMP_RES_3_0 5
228 #define SI_SBR_START_NOISE_BITS_AMP_RES_3_0 5
229 #define SI_SBR_START_NOISE_BITS_BALANCE_AMP_RES_3_0 5
230 
231 #define SI_SBR_START_ENV_BITS_AMP_RES_1_5 7
232 #define SI_SBR_START_ENV_BITS_BALANCE_AMP_RES_1_5 6
233 
234 #define SI_SBR_EXTENDED_DATA_BITS 1
235 #define SI_SBR_EXTENSION_SIZE_BITS 4
236 #define SI_SBR_EXTENSION_ESC_COUNT_BITS 8
237 #define SI_SBR_EXTENSION_ID_BITS 2
238 
239 #define SBR_EXTENDED_DATA_MAX_CNT (15 + 255)
240 
241 #define EXTENSION_ID_PS_CODING 2
242 
243 /* Envelope coding constants */
244 #define FREQ 0
245 #define TIME 1
246 
247 /* qmf data scaling */
248 #define QMF_SCALE_OFFSET 7
249 
250 /* huffman tables */
251 #define CODE_BOOK_SCF_LAV00 60
252 #define CODE_BOOK_SCF_LAV01 31
253 #define CODE_BOOK_SCF_LAV10 60
254 #define CODE_BOOK_SCF_LAV11 31
255 #define CODE_BOOK_SCF_LAV_BALANCE11 12
256 #define CODE_BOOK_SCF_LAV_BALANCE10 24
257 
258 typedef enum { SBR_AMP_RES_1_5 = 0, SBR_AMP_RES_3_0 } AMP_RES;
259 
260 typedef enum {
261   XPOS_MDCT,
262   XPOS_MDCT_CROSS,
263   XPOS_LC,
264   XPOS_RESERVED,
265   XPOS_SWITCHED /* not a real choice but used here to control behaviour */
266 } XPOS_MODE;
267 
268 typedef enum {
269   INVF_OFF = 0,
270   INVF_LOW_LEVEL,
271   INVF_MID_LEVEL,
272   INVF_HIGH_LEVEL,
273   INVF_SWITCHED /* not a real choice but used here to control behaviour */
274 } INVF_MODE;
275 
276 #endif
277