1/* -----------------------------------------------------------------------------
2Software License for The Fraunhofer FDK AAC Codec Library for Android
3
4© Copyright  1995 - 2018 Fraunhofer-Gesellschaft zur Förderung der angewandten
5Forschung e.V. All rights reserved.
6
7 1.    INTRODUCTION
8The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software
9that implements the MPEG Advanced Audio Coding ("AAC") encoding and decoding
10scheme for digital audio. This FDK AAC Codec software is intended to be used on
11a wide variety of Android devices.
12
13AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient
14general perceptual audio codecs. AAC-ELD is considered the best-performing
15full-bandwidth communications codec by independent studies and is widely
16deployed. AAC has been standardized by ISO and IEC as part of the MPEG
17specifications.
18
19Patent licenses for necessary patent claims for the FDK AAC Codec (including
20those of Fraunhofer) may be obtained through Via Licensing
21(www.vialicensing.com) or through the respective patent owners individually for
22the purpose of encoding or decoding bit streams in products that are compliant
23with the ISO/IEC MPEG audio standards. Please note that most manufacturers of
24Android devices already license these patent claims through Via Licensing or
25directly from the patent owners, and therefore FDK AAC Codec software may
26already be covered under those patent licenses when it is used for those
27licensed purposes only.
28
29Commercially-licensed AAC software libraries, including floating-point versions
30with enhanced sound quality, are also available from Fraunhofer. Users are
31encouraged to check the Fraunhofer website for additional applications
32information and documentation.
33
342.    COPYRIGHT LICENSE
35
36Redistribution and use in source and binary forms, with or without modification,
37are permitted without payment of copyright license fees provided that you
38satisfy the following conditions:
39
40You must retain the complete text of this software license in redistributions of
41the FDK AAC Codec or your modifications thereto in source code form.
42
43You must retain the complete text of this software license in the documentation
44and/or other materials provided with redistributions of the FDK AAC Codec or
45your modifications thereto in binary form. You must make available free of
46charge copies of the complete source code of the FDK AAC Codec and your
47modifications thereto to recipients of copies in binary form.
48
49The name of Fraunhofer may not be used to endorse or promote products derived
50from this library without prior written permission.
51
52You may not charge copyright license fees for anyone to use, copy or distribute
53the FDK AAC Codec software or your modifications thereto.
54
55Your modified versions of the FDK AAC Codec must carry prominent notices stating
56that you changed the software and the date of any change. For modified versions
57of the FDK AAC Codec, the term "Fraunhofer FDK AAC Codec Library for Android"
58must be replaced by the term "Third-Party Modified Version of the Fraunhofer FDK
59AAC Codec Library for Android."
60
613.    NO PATENT LICENSE
62
63NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without
64limitation the patents of Fraunhofer, ARE GRANTED BY THIS SOFTWARE LICENSE.
65Fraunhofer provides no warranty of patent non-infringement with respect to this
66software.
67
68You may use this FDK AAC Codec software or modifications thereto only for
69purposes that are authorized by appropriate patent licenses.
70
714.    DISCLAIMER
72
73This FDK AAC Codec software is provided by Fraunhofer on behalf of the copyright
74holders and contributors "AS IS" and WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
75including but not limited to the implied warranties of merchantability and
76fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
77CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary,
78or consequential damages, including but not limited to procurement of substitute
79goods or services; loss of use, data, or profits, or business interruption,
80however caused and on any theory of liability, whether in contract, strict
81liability, or tort (including negligence), arising in any way out of the use of
82this software, even if advised of the possibility of such damage.
83
845.    CONTACT INFORMATION
85
86Fraunhofer Institute for Integrated Circuits IIS
87Attention: Audio and Multimedia Departments - FDK AAC LL
88Am Wolfsmantel 33
8991058 Erlangen, Germany
90
91www.iis.fraunhofer.de/amm
92amm-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
138struct 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
212H_ALLOC_MEM(AACdynamic_RAM, FIXP_DBL)
213/*
214 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
215END - Dynamic RAM - Allocation */
216
217/*
218  See further Memory Allocation details in aacEnc_ram.cpp
219*/
220H_ALLOC_MEM(Ram_aacEnc_AacEncoder, AAC_ENC)
221
222H_ALLOC_MEM(Ram_aacEnc_PsyElement, PSY_ELEMENT)
223
224H_ALLOC_MEM(Ram_aacEnc_PsyInternal, PSY_INTERNAL)
225H_ALLOC_MEM(Ram_aacEnc_PsyStatic, PSY_STATIC)
226H_ALLOC_MEM(Ram_aacEnc_PsyInputBuffer, INT_PCM)
227
228PSY_DYNAMIC *GetRam_aacEnc_PsyDynamic(int n, UCHAR *dynamic_RAM);
229
230H_ALLOC_MEM(Ram_aacEnc_PsyOutChannel, PSY_OUT_CHANNEL)
231
232H_ALLOC_MEM(Ram_aacEnc_PsyOut, PSY_OUT)
233H_ALLOC_MEM(Ram_aacEnc_PsyOutElements, PSY_OUT_ELEMENT)
234
235H_ALLOC_MEM(Ram_aacEnc_QCstate, QC_STATE)
236H_ALLOC_MEM(Ram_aacEnc_AdjustThreshold, ADJ_THR_STATE)
237
238H_ALLOC_MEM(Ram_aacEnc_AdjThrStateElement, ATS_ELEMENT)
239H_ALLOC_MEM(Ram_aacEnc_ElementBits, ELEMENT_BITS)
240H_ALLOC_MEM(Ram_aacEnc_BitCntrState, BITCNTR_STATE)
241
242INT *GetRam_aacEnc_BitLookUp(int n, UCHAR *dynamic_RAM);
243INT *GetRam_aacEnc_MergeGainLookUp(int n, UCHAR *dynamic_RAM);
244QC_OUT_CHANNEL *GetRam_aacEnc_QCchannel(int n, UCHAR *dynamic_RAM);
245
246H_ALLOC_MEM(Ram_aacEnc_QCout, QC_OUT)
247H_ALLOC_MEM(Ram_aacEnc_QCelement, QC_OUT_ELEMENT)
248
249#endif /* #ifndef AACENC_RAM_H */
250