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 /*********************** MPEG surround encoder library *************************
96 
97    Author(s):   Christian Goettlinger
98 
99    Description: Encoder Library Interfac
100                 gain management of the encoder
101 
102 *******************************************************************************/
103 
104 /**************************************************************************/ /**
105    \file
106  ******************************************************************************/
107 
108 #ifndef SACENC_STATICGAIN_H
109 #define SACENC_STATICGAIN_H
110 
111 /* Includes ******************************************************************/
112 #include "common_fix.h"
113 #include "sacenc_lib.h"
114 #include "sacenc_const.h"
115 #include "sacenc_bitstream.h"
116 
117 /* Defines *******************************************************************/
118 #define FIXP_GAIN FIXP_DBL
119 #define MAXVAL_GAIN ((FIXP_DBL)MAXVAL_DBL)
120 
121 /* Data Types ****************************************************************/
122 struct STATIC_GAIN_CONFIG {
123   MP4SPACEENC_MODE encMode;
124   MP4SPACEENC_DMX_GAIN fixedGainDMX;
125   INT preGainFactorDb;
126 };
127 
128 typedef struct STATIC_GAIN_CONFIG *HANDLE_STATIC_GAIN_CONFIG;
129 typedef struct STATIC_GAIN *HANDLE_STATIC_GAIN;
130 
131 /* Constants *****************************************************************/
132 
133 /* Function / Class Declarations *********************************************/
134 
135 /* Initializes Static Gain Computation Config */
136 FDK_SACENC_ERROR fdk_sacenc_staticGain_OpenConfig(
137     HANDLE_STATIC_GAIN_CONFIG *phStaticGainConfig);
138 
139 FDK_SACENC_ERROR fdk_sacenc_staticGain_InitDefaultConfig(
140     HANDLE_STATIC_GAIN_CONFIG hStaticGainConfig);
141 
142 /* Deletes Static Gain Computation Config ~Destructor */
143 FDK_SACENC_ERROR fdk_sacenc_staticGain_CloseConfig(
144     HANDLE_STATIC_GAIN_CONFIG *phStaticGainConfig);
145 
146 /* Initializes Static Gain Computation ~Constructor */
147 FDK_SACENC_ERROR fdk_sacenc_staticGain_Open(HANDLE_STATIC_GAIN *phStaticGain);
148 
149 FDK_SACENC_ERROR fdk_sacenc_staticGain_Init(
150     HANDLE_STATIC_GAIN hStaticGain,
151     const HANDLE_STATIC_GAIN_CONFIG hStaticGainConfig, INT *const scale);
152 
153 /* Deletes Static Gain Computation Infrastucture ~Destructor */
154 FDK_SACENC_ERROR fdk_sacenc_staticGain_Close(HANDLE_STATIC_GAIN *phStaticGain);
155 
156 /* Apply PostGain to the output PCM Downmix-Signal */
157 FDK_SACENC_ERROR fdk_sacenc_staticPostGain_ApplyFDK(
158     const HANDLE_STATIC_GAIN hStaticGain, INT_PCM *const pOutputSamples,
159     const INT nOutputSamples, const INT scale);
160 
161 /* Get Pointer to PreGain-vector */
162 FIXP_GAIN *fdk_sacenc_getPreGainPtrFDK(HANDLE_STATIC_GAIN hStaticGain);
163 
164 /* Get Pointer to PostGain-coef */
165 FIXP_GAIN fdk_sacenc_getPostGainFDK(HANDLE_STATIC_GAIN hStaticGain);
166 
167 FIXEDGAINDMXCONFIG fdk_sacenc_staticGain_GetDmxGain(
168     const HANDLE_STATIC_GAIN hStaticGain);
169 
170 FDK_SACENC_ERROR fdk_sacenc_staticGain_SetDmxGain(
171     HANDLE_STATIC_GAIN_CONFIG hStaticGainCfg,
172     const MP4SPACEENC_DMX_GAIN dmxGain);
173 
174 FDK_SACENC_ERROR fdk_sacenc_staticGain_SetEncMode(
175     HANDLE_STATIC_GAIN_CONFIG hStaticGainCfg, const MP4SPACEENC_MODE encMode);
176 
177 #endif /* SACENC_STATICGAIN_H */
178