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):   M. Lohwasser, M. Gayer
98 
99    Description:
100 
101 *******************************************************************************/
102 
103 /*!
104   \file
105   \brief  Memory layout
106   \author Markus Lohwasser
107 */
108 
109 #include "aacEnc_ram.h"
110 
111 C_AALLOC_MEM(AACdynamic_RAM, FIXP_DBL, AAC_ENC_DYN_RAM_SIZE / sizeof(FIXP_DBL))
112 
113 /*
114   Static memory areas, must not be overwritten in other sections of the decoder
115   !
116 */
117 
118 /*
119  The structure AacEncoder contains all Encoder structures.
120 */
121 
122 C_ALLOC_MEM(Ram_aacEnc_AacEncoder, struct AAC_ENC, 1)
123 
124 /*
125    The structure PSY_INTERNAl contains all psych configuration and data pointer.
126    * PsyStatic holds last and current Psych data.
127    * PsyInputBuffer contains time input. Signal is needed at the beginning of
128    Psych. Memory can be reused after signal is in time domain.
129    * PsyData contains spectral, nrg and threshold information. Necessary data
130    are copied into PsyOut, so memory is available after leaving psych.
131    * TnsData, ChaosMeasure, PnsData are temporarily necessary, e.g. use memory
132    from PsyInputBuffer.
133 */
134 
135 C_ALLOC_MEM2(Ram_aacEnc_PsyElement, PSY_ELEMENT, 1, ((8)))
136 
137 C_ALLOC_MEM(Ram_aacEnc_PsyInternal, PSY_INTERNAL, 1)
138 C_ALLOC_MEM2(Ram_aacEnc_PsyStatic, PSY_STATIC, 1, (8))
139 
140 C_ALLOC_MEM2(Ram_aacEnc_PsyInputBuffer, INT_PCM, MAX_INPUT_BUFFER_SIZE, (8))
141 
142 PSY_DYNAMIC *GetRam_aacEnc_PsyDynamic(int n, UCHAR *dynamic_RAM) {
143   FDK_ASSERT(dynamic_RAM != 0);
144   /* The reinterpret_cast is used to suppress a compiler warning. We know that
145    * (dynamic_RAM + P_BUF_1 + n*sizeof(PSY_DYNAMIC)) is sufficiently aligned, so
146    * the cast is safe */
147   return reinterpret_cast<PSY_DYNAMIC *>(reinterpret_cast<void *>(
148       dynamic_RAM + P_BUF_1 + n * sizeof(PSY_DYNAMIC)));
149 }
150 
151 /*
152    The structure PSY_OUT holds all psychoaccoustic data needed
153    in quantization module
154 */
155 C_ALLOC_MEM2(Ram_aacEnc_PsyOut, PSY_OUT, 1, (1))
156 
157 C_ALLOC_MEM2(Ram_aacEnc_PsyOutElements, PSY_OUT_ELEMENT, 1, (1) * ((8)))
158 C_ALLOC_MEM2(Ram_aacEnc_PsyOutChannel, PSY_OUT_CHANNEL, 1, (1) * (8))
159 
160 /*
161    The structure QC_STATE contains preinitialized settings and quantizer
162    structures.
163    * AdjustThreshold structure contains element-wise settings.
164    * ElementBits contains elemnt-wise bit consumption settings.
165    * When CRC is active, lookup table is necessary for fast crc calculation.
166    * Bitcounter contains buffer to find optimal codebooks and minimal bit
167    consumption. Values are temporarily, so dynamic memory can be used.
168 */
169 
170 C_ALLOC_MEM(Ram_aacEnc_QCstate, QC_STATE, 1)
171 C_ALLOC_MEM(Ram_aacEnc_AdjustThreshold, ADJ_THR_STATE, 1)
172 
173 C_ALLOC_MEM2(Ram_aacEnc_AdjThrStateElement, ATS_ELEMENT, 1, ((8)))
174 C_ALLOC_MEM2(Ram_aacEnc_ElementBits, ELEMENT_BITS, 1, ((8)))
175 C_ALLOC_MEM(Ram_aacEnc_BitCntrState, struct BITCNTR_STATE, 1)
176 
177 INT *GetRam_aacEnc_BitLookUp(int n, UCHAR *dynamic_RAM) {
178   FDK_ASSERT(dynamic_RAM != 0);
179   /* The reinterpret_cast is used to suppress a compiler warning. We know that
180    * (dynamic_RAM + P_BUF_1) is sufficiently aligned, so the cast is safe */
181   return reinterpret_cast<INT *>(
182       reinterpret_cast<void *>(dynamic_RAM + P_BUF_1));
183 }
184 INT *GetRam_aacEnc_MergeGainLookUp(int n, UCHAR *dynamic_RAM) {
185   FDK_ASSERT(dynamic_RAM != 0);
186   /* The reinterpret_cast is used to suppress a compiler warning. We know that
187    * (dynamic_RAM + P_BUF_1 + sizeof(INT)*(MAX_SFB_LONG*(CODE_BOOK_ESC_NDX+1)))
188    * is sufficiently aligned, so the cast is safe */
189   return reinterpret_cast<INT *>(reinterpret_cast<void *>(
190       dynamic_RAM + P_BUF_1 +
191       sizeof(INT) * (MAX_SFB_LONG * (CODE_BOOK_ESC_NDX + 1))));
192 }
193 
194 /*
195    The structure QC_OUT contains settings and structures holding all necessary
196    information needed in bitstreamwriter.
197 */
198 
199 C_ALLOC_MEM2(Ram_aacEnc_QCout, QC_OUT, 1, (1))
200 C_ALLOC_MEM2(Ram_aacEnc_QCelement, QC_OUT_ELEMENT, 1, (1) * ((8)))
201 QC_OUT_CHANNEL *GetRam_aacEnc_QCchannel(int n, UCHAR *dynamic_RAM) {
202   FDK_ASSERT(dynamic_RAM != 0);
203   /* The reinterpret_cast is used to suppress a compiler warning. We know that
204    * (dynamic_RAM + P_BUF_0 + n*sizeof(QC_OUT_CHANNEL)) is sufficiently aligned,
205    * so the cast is safe */
206   return reinterpret_cast<QC_OUT_CHANNEL *>(reinterpret_cast<void *>(
207       dynamic_RAM + P_BUF_0 + n * sizeof(QC_OUT_CHANNEL)));
208 }
209