• 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 /**************************** AAC encoder library ******************************
96 
97    Author(s):   M. Lohwasser, M. Gayer
98 
99    Description:
100 
101 *******************************************************************************/
102 
103 /*!
104   \file
105   \brief  Memory layout
106   \author Markus Lohwasser
107 */
108 
109 #ifndef AACENC_RAM_H
110 #define AACENC_RAM_H
111 
112 #include "common_fix.h"
113 
114 #include "aacenc.h"
115 #include "psy_data.h"
116 #include "interface.h"
117 #include "psy_main.h"
118 #include "bitenc.h"
119 #include "bit_cnt.h"
120 #include "psy_const.h"
121 
122 #define OUTPUTBUFFER_SIZE                                                 \
123   (8192) /*!< Output buffer size has to be at least 6144 bits per channel \
124             (768 bytes). FDK bitbuffer implementation expects buffer of   \
125             size 2^n. */
126 
127 /*
128   Moved AAC_ENC struct definition from aac_enc.cpp into aacEnc_ram.h to get size
129   and respective static memory in aacEnc_ram.cpp. aac_enc.h is the outward
130   visible header file and putting the struct into would cause necessity of
131   additional visible header files outside library.
132 */
133 
134 /* define hBitstream size: max AAC framelength is 6144 bits/channel */
135 /*#define BUFFER_BITSTR_SIZE ((6400*(8)/bbWordSize)    +((bbWordSize - 1) /
136  * bbWordSize))*/
137 
138 struct AAC_ENC {
139   AACENC_CONFIG *config;
140 
141   INT ancillaryBitsPerFrame; /* ancillary bits per frame calculated from
142                                 ancillary rate */
143 
144   CHANNEL_MAPPING channelMapping;
145 
146   QC_STATE *qcKernel;
147   QC_OUT *qcOut[(1)];
148 
149   PSY_OUT *psyOut[(1)];
150   PSY_INTERNAL *psyKernel;
151 
152   /* lifetime vars */
153 
154   CHANNEL_MODE encoderMode;
155   INT bandwidth90dB;
156   AACENC_BITRATE_MODE bitrateMode;
157 
158   INT dontWriteAdif; /* use: write ADIF header only before 1st frame */
159 
160   FIXP_DBL *dynamic_RAM;
161 
162   INT maxChannels; /* used while allocation */
163   INT maxElements;
164   INT maxFrames;
165 
166   AUDIO_OBJECT_TYPE aot; /* AOT to be used while encoding.  */
167 };
168 
169 #define maxSize(a, b) (((a) > (b)) ? (a) : (b))
170 
171 #define BIT_LOOK_UP_SIZE \
172   (sizeof(INT) * (MAX_SFB_LONG * (CODE_BOOK_ESC_NDX + 1)))
173 #define MERGE_GAIN_LOOK_UP_SIZE (sizeof(INT) * MAX_SFB_LONG)
174 
175 /* Size of AhFlag buffer in function FDKaacEnc_adaptThresholdsToPe() */
176 #define ADJ_THR_AH_FLAG_SIZE (sizeof(UCHAR) * ((8)) * (2) * MAX_GROUPED_SFB)
177 /* Size of ThrExp buffer in function FDKaacEnc_adaptThresholdsToPe() */
178 #define ADJ_THR_THR_EXP_SIZE (sizeof(FIXP_DBL) * ((8)) * (2) * MAX_GROUPED_SFB)
179 /* Size of sfbNActiveLinesLdData buffer in function FDKaacEnc_correctThresh() */
180 #define ADJ_THR_ACT_LIN_LD_DATA_SIZE \
181   (sizeof(FIXP_DBL) * ((8)) * (2) * MAX_GROUPED_SFB)
182 /* Total amount of dynamic buffer needed in adjust thresholds functionality */
183 #define ADJ_THR_SIZE \
184   (ADJ_THR_AH_FLAG_SIZE + ADJ_THR_THR_EXP_SIZE + ADJ_THR_ACT_LIN_LD_DATA_SIZE)
185 
186 /* Dynamic RAM - Allocation */
187 /*
188  +++++++++++++++++++++++++++++++++++++++++++++++++++++
189  |   P_BUF_0   |               P_BUF_1               |
190  +++++++++++++++++++++++++++++++++++++++++++++++++++++
191  |  QC_OUT_CH  |               PSY_DYN               |
192  +++++++++++++++++++++++++++++++++++++++++++++++++++++
193  |             |       BitLookUp+MergeGainLookUp     |
194  +++++++++++++++++++++++++++++++++++++++++++++++++++++
195  |             | AH_FLAG | THR_EXP | ACT_LIN_LD_DATA |
196  +++++++++++++++++++++++++++++++++++++++++++++++++++++
197  |             |       Bitstream output buffer       |
198  +++++++++++++++++++++++++++++++++++++++++++++++++++++
199 */
200 
201 #define BUF_SIZE_0 (ALIGN_SIZE(sizeof(QC_OUT_CHANNEL)) * (8))
202 #define BUF_SIZE_1                                                           \
203   (ALIGN_SIZE(maxSize(maxSize(sizeof(PSY_DYNAMIC),                           \
204                               (BIT_LOOK_UP_SIZE + MERGE_GAIN_LOOK_UP_SIZE)), \
205                       ADJ_THR_SIZE)))
206 
207 #define P_BUF_0 (0)
208 #define P_BUF_1 (P_BUF_0 + BUF_SIZE_0)
209 
210 #define AAC_ENC_DYN_RAM_SIZE (BUF_SIZE_0 + BUF_SIZE_1)
211 
212 H_ALLOC_MEM(AACdynamic_RAM, FIXP_DBL)
213 /*
214  ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
215 END - Dynamic RAM - Allocation */
216 
217 /*
218   See further Memory Allocation details in aacEnc_ram.cpp
219 */
220 H_ALLOC_MEM(Ram_aacEnc_AacEncoder, AAC_ENC)
221 
222 H_ALLOC_MEM(Ram_aacEnc_PsyElement, PSY_ELEMENT)
223 
224 H_ALLOC_MEM(Ram_aacEnc_PsyInternal, PSY_INTERNAL)
225 H_ALLOC_MEM(Ram_aacEnc_PsyStatic, PSY_STATIC)
226 H_ALLOC_MEM(Ram_aacEnc_PsyInputBuffer, INT_PCM)
227 
228 PSY_DYNAMIC *GetRam_aacEnc_PsyDynamic(int n, UCHAR *dynamic_RAM);
229 
230 H_ALLOC_MEM(Ram_aacEnc_PsyOutChannel, PSY_OUT_CHANNEL)
231 
232 H_ALLOC_MEM(Ram_aacEnc_PsyOut, PSY_OUT)
233 H_ALLOC_MEM(Ram_aacEnc_PsyOutElements, PSY_OUT_ELEMENT)
234 
235 H_ALLOC_MEM(Ram_aacEnc_QCstate, QC_STATE)
236 H_ALLOC_MEM(Ram_aacEnc_AdjustThreshold, ADJ_THR_STATE)
237 
238 H_ALLOC_MEM(Ram_aacEnc_AdjThrStateElement, ATS_ELEMENT)
239 H_ALLOC_MEM(Ram_aacEnc_ElementBits, ELEMENT_BITS)
240 H_ALLOC_MEM(Ram_aacEnc_BitCntrState, BITCNTR_STATE)
241 
242 INT *GetRam_aacEnc_BitLookUp(int n, UCHAR *dynamic_RAM);
243 INT *GetRam_aacEnc_MergeGainLookUp(int n, UCHAR *dynamic_RAM);
244 QC_OUT_CHANNEL *GetRam_aacEnc_QCchannel(int n, UCHAR *dynamic_RAM);
245 
246 H_ALLOC_MEM(Ram_aacEnc_QCout, QC_OUT)
247 H_ALLOC_MEM(Ram_aacEnc_QCelement, QC_OUT_ELEMENT)
248 
249 #endif /* #ifndef AACENC_RAM_H */
250