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):   M. Neuendorf, N. Rettelbach, M. Multrus
98 
99    Description: PS Parameter extraction, encoding
100 
101 *******************************************************************************/
102 
103 /*!
104   \file
105   \brief  PS parameter extraction, encoding functions $Revision: 92790 $
106 */
107 
108 #ifndef PS_ENCODE_H
109 #define PS_ENCODE_H
110 
111 #include "ps_const.h"
112 #include "ps_bitenc.h"
113 
114 #define IID_SCALE_FT (64.f) /* maxVal in Quant tab is +/- 50 */
115 #define IID_SCALE 6         /* maxVal in Quant tab is +/- 50 */
116 #define IID_MAXVAL (1 << IID_SCALE)
117 
118 #define PS_QUANT_SCALE_FT \
119   (64.f) /* error smaller (64-25)/64 * 20 bands * 4 env -> QuantScale 64 */
120 #define PS_QUANT_SCALE \
121   6 /* error smaller (64-25)/64 * 20 bands * 4 env -> QuantScale 6 bit */
122 
123 #define QMF_GROUPS_LO_RES 12
124 #define SUBQMF_GROUPS_LO_RES 10
125 #define QMF_GROUPS_HI_RES 18
126 #define SUBQMF_GROUPS_HI_RES 30
127 
128 typedef struct T_PS_DATA {
129   INT iidEnable;
130   INT iidEnableLast;
131   INT iidQuantMode;
132   INT iidQuantModeLast;
133   INT iidDiffMode[PS_MAX_ENVELOPES];
134   INT iidIdx[PS_MAX_ENVELOPES][PS_MAX_BANDS];
135   INT iidIdxLast[PS_MAX_BANDS];
136 
137   INT iccEnable;
138   INT iccEnableLast;
139   INT iccQuantMode;
140   INT iccQuantModeLast;
141   INT iccDiffMode[PS_MAX_ENVELOPES];
142   INT iccIdx[PS_MAX_ENVELOPES][PS_MAX_BANDS];
143   INT iccIdxLast[PS_MAX_BANDS];
144 
145   INT nEnvelopesLast;
146 
147   INT headerCnt;
148   INT iidTimeCnt;
149   INT iccTimeCnt;
150   INT noEnvCnt;
151 
152 } PS_DATA, *HANDLE_PS_DATA;
153 
154 typedef struct T_PS_ENCODE {
155   PS_DATA psData;
156 
157   PS_BANDS psEncMode;
158   INT nQmfIidGroups;
159   INT nSubQmfIidGroups;
160   INT iidGroupBorders[QMF_GROUPS_HI_RES + SUBQMF_GROUPS_HI_RES + 1];
161   INT subband2parameterIndex[QMF_GROUPS_HI_RES + SUBQMF_GROUPS_HI_RES];
162   UCHAR iidGroupWidthLd[QMF_GROUPS_HI_RES + SUBQMF_GROUPS_HI_RES];
163   FIXP_DBL iidQuantErrorThreshold;
164 
165   UCHAR psBandNrgScale[PS_MAX_BANDS];
166 
167 } PS_ENCODE;
168 
169 typedef struct T_PS_ENCODE *HANDLE_PS_ENCODE;
170 
171 FDK_PSENC_ERROR FDKsbrEnc_CreatePSEncode(HANDLE_PS_ENCODE *phPsEncode);
172 
173 FDK_PSENC_ERROR FDKsbrEnc_InitPSEncode(HANDLE_PS_ENCODE hPsEncode,
174                                        const PS_BANDS psEncMode,
175                                        const FIXP_DBL iidQuantErrorThreshold);
176 
177 FDK_PSENC_ERROR FDKsbrEnc_DestroyPSEncode(HANDLE_PS_ENCODE *phPsEncode);
178 
179 FDK_PSENC_ERROR FDKsbrEnc_PSEncode(
180     HANDLE_PS_ENCODE hPsEncode, HANDLE_PS_OUT hPsOut, UCHAR *dynBandScale,
181     UINT maxEnvelopes,
182     FIXP_DBL *hybridData[HYBRID_FRAMESIZE][MAX_PS_CHANNELS][2],
183     const INT frameSize, const INT sendHeader);
184 
185 #endif
186