1 
2 /* -----------------------------------------------------------------------------------------------------------
3 Software 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
9 The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
10 the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
11 This FDK AAC Codec software is intended to be used on a wide variety of Android devices.
12 
13 AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
14 audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
15 independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
16 of the MPEG specifications.
17 
18 Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
19 may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
20 individually for the purpose of encoding or decoding bit streams in products that are compliant with
21 the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
22 these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
23 software may already be covered under those patent licenses when it is used for those licensed purposes only.
24 
25 Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
26 are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
27 applications information and documentation.
28 
29 2.    COPYRIGHT LICENSE
30 
31 Redistribution and use in source and binary forms, with or without modification, are permitted without
32 payment of copyright license fees provided that you satisfy the following conditions:
33 
34 You must retain the complete text of this software license in redistributions of the FDK AAC Codec or
35 your modifications thereto in source code form.
36 
37 You must retain the complete text of this software license in the documentation and/or other materials
38 provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
39 You must make available free of charge copies of the complete source code of the FDK AAC Codec and your
40 modifications thereto to recipients of copies in binary form.
41 
42 The name of Fraunhofer may not be used to endorse or promote products derived from this library without
43 prior written permission.
44 
45 You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
46 software or your modifications thereto.
47 
48 Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
49 and 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 
53 3.    NO PATENT LICENSE
54 
55 NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
56 ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
57 respect to this software.
58 
59 You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
60 by appropriate patent licenses.
61 
62 4.    DISCLAIMER
63 
64 This 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
66 of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
67 CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
68 including but not limited to procurement of substitute goods or services; loss of use, data, or profits,
69 or business interruption, however caused and on any theory of liability, whether in contract, strict
70 liability, or tort (including negligence), arising in any way out of the use of this software, even if
71 advised of the possibility of such damage.
72 
73 5.    CONTACT INFORMATION
74 
75 Fraunhofer Institute for Integrated Circuits IIS
76 Attention: Audio and Multimedia Departments - FDK AAC LL
77 Am Wolfsmantel 33
78 91058 Erlangen, Germany
79 
80 www.iis.fraunhofer.de/amm
81 amm-info@iis.fraunhofer.de
82 ----------------------------------------------------------------------------------------------------------- */
83 
84 /******************************************************************************
85 
86    Initial authors:      M. Lohwasser, M. Gayer
87    Contents/description:
88 
89 ******************************************************************************/
90 
91 /*!
92   \file
93   \brief  Memory layout
94   \author Markus Lohwasser
95 */
96 
97 #ifndef AAC_ENC_RAM_H
98 #define AAC_ENC_RAM_H
99 
100 #include "common_fix.h"
101 
102 #include "aacenc.h"
103 #include "psy_data.h"
104 #include "interface.h"
105 #include "psy_main.h"
106 #include "bitenc.h"
107 #include "bit_cnt.h"
108 #include "psy_const.h"
109 
110   #define  OUTPUTBUFFER_SIZE    (8192)  /*!< Output buffer size has to be at least 6144 bits per channel (768 bytes). FDK bitbuffer implementation expects buffer of size 2^n. */
111 
112 
113 /*
114   Moved AAC_ENC struct definition from aac_enc.cpp into aacEnc_ram.h to get size and respective
115   static memory in aacEnc_ram.cpp.
116   aac_enc.h is the outward visible header file and putting the struct into would cause necessity
117   of additional visible header files outside library.
118 */
119 
120 /* define hBitstream size: max AAC framelength is 6144 bits/channel */
121 /*#define BUFFER_BITSTR_SIZE ((6400*(8)/bbWordSize)    +((bbWordSize - 1) / bbWordSize))*/
122 
123 struct AAC_ENC {
124 
125   AACENC_CONFIG    *config;
126 
127   INT               ancillaryBitsPerFrame;              /* ancillary bits per frame calculated from ancillary rate */
128 
129   CHANNEL_MAPPING   channelMapping;
130 
131   QC_STATE         *qcKernel;
132   QC_OUT           *qcOut[(1)];
133 
134   PSY_OUT          *psyOut[(1)];
135   PSY_INTERNAL     *psyKernel;
136 
137   /* lifetime vars */
138 
139   CHANNEL_MODE encoderMode;
140   INT bandwidth90dB;
141   AACENC_BITRATE_MODE bitrateMode;
142 
143   INT    dontWriteAdif;      /* use: write ADIF header only before 1st frame */
144 
145   FIXP_DBL  *dynamic_RAM;
146 
147 
148   INT maxChannels;           /* used while allocation */
149   INT maxElements;
150   INT maxFrames;
151 
152   AUDIO_OBJECT_TYPE aot;    /* AOT to be used while encoding.  */
153 
154 } ;
155 
156 #define maxSize(a,b) ( ((a)>(b)) ? (a) : (b) )
157 
158 #define BIT_LOOK_UP_SIZE         ( sizeof(INT)*(MAX_SFB_LONG*(CODE_BOOK_ESC_NDX+1)) )
159 #define MERGE_GAIN_LOOK_UP_SIZE  ( sizeof(INT)*MAX_SFB_LONG )
160 
161 
162 
163 /* Dynamic RAM - Allocation */
164 /*
165  ++++++++++++++++++++++++++++++++++++++++++++
166  |   P_BUF_0   |         P_BUF_1            |
167  ++++++++++++++++++++++++++++++++++++++++++++
168  |  QC_OUT_CH  |         PSY_DYN            |
169  ++++++++++++++++++++++++++++++++++++++++++++
170  |             | BitLookUp+MergeGainLookUp  |
171  ++++++++++++++++++++++++++++++++++++++++++++
172  |             |  Bitstream output buffer   |
173  ++++++++++++++++++++++++++++++++++++++++++++
174 */
175 
176 #define BUF_SIZE_0       ( ALIGN_SIZE(sizeof(QC_OUT_CHANNEL)*(8)) )
177 #define BUF_SIZE_1       ( ALIGN_SIZE(maxSize(sizeof(PSY_DYNAMIC), \
178                                       (BIT_LOOK_UP_SIZE+MERGE_GAIN_LOOK_UP_SIZE))) )
179 
180 #define P_BUF_0          ( 0 )
181 #define P_BUF_1          ( P_BUF_0 + BUF_SIZE_0 )
182 
183 #define AAC_ENC_DYN_RAM_SIZE  ( BUF_SIZE_0 + BUF_SIZE_1 )
184 
185 
186   H_ALLOC_MEM (AACdynamic_RAM, FIXP_DBL)
187 /*
188  ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
189 END - Dynamic RAM - Allocation */
190 
191 /*
192   See further Memory Allocation details in aacEnc_ram.cpp
193 */
194   H_ALLOC_MEM (Ram_aacEnc_AacEncoder, AAC_ENC)
195 
196   H_ALLOC_MEM (Ram_aacEnc_PsyElement, PSY_ELEMENT)
197 
198   H_ALLOC_MEM (Ram_aacEnc_PsyInternal, PSY_INTERNAL)
199   H_ALLOC_MEM (Ram_aacEnc_PsyStatic, PSY_STATIC)
200   H_ALLOC_MEM (Ram_aacEnc_PsyInputBuffer, INT_PCM)
201 
202   PSY_DYNAMIC *GetRam_aacEnc_PsyDynamic (int n, UCHAR* dynamic_RAM);
203   H_ALLOC_MEM (Ram_bsOutbuffer, UCHAR)
204 
205   H_ALLOC_MEM (Ram_aacEnc_PsyOutChannel, PSY_OUT_CHANNEL)
206 
207   H_ALLOC_MEM (Ram_aacEnc_PsyOut, PSY_OUT)
208   H_ALLOC_MEM (Ram_aacEnc_PsyOutElements, PSY_OUT_ELEMENT)
209 
210   H_ALLOC_MEM (Ram_aacEnc_QCstate, QC_STATE)
211   H_ALLOC_MEM (Ram_aacEnc_AdjustThreshold, ADJ_THR_STATE)
212 
213   H_ALLOC_MEM (Ram_aacEnc_AdjThrStateElement, ATS_ELEMENT)
214   H_ALLOC_MEM (Ram_aacEnc_ElementBits, ELEMENT_BITS)
215   H_ALLOC_MEM (Ram_aacEnc_BitCntrState, BITCNTR_STATE)
216 
217   INT *GetRam_aacEnc_BitLookUp(int n, UCHAR* dynamic_RAM);
218   INT *GetRam_aacEnc_MergeGainLookUp(int n, UCHAR* dynamic_RAM);
219   QC_OUT_CHANNEL *GetRam_aacEnc_QCchannel (int n, UCHAR* dynamic_RAM);
220 
221   H_ALLOC_MEM (Ram_aacEnc_QCout, QC_OUT)
222   H_ALLOC_MEM (Ram_aacEnc_QCelement, QC_OUT_ELEMENT)
223 
224 
225 #endif /* #ifndef AAC_ENC_RAM_H */
226 
227