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 /***************************  Fraunhofer IIS FDK Tools  **********************
85 
86    Author(s):
87    Description: Scaling operations
88 
89 ******************************************************************************/
90 
91 #ifndef SCALE_H
92 #define SCALE_H
93 
94 #include "common_fix.h"
95 #include "genericStds.h"
96 #include "fixminmax.h"
97 
98   #define SCALE_INLINE inline
99 
100 
101 #if defined(__arm__)	/* cppp replaced: elif */
102 #include "arm/scale.h"
103 
104 #elif defined(__mips__)	/* cppp replaced: elif */
105 #include "mips/scale.h"
106 
107 #endif
108 
109 
110 #include "../src/scale.cpp"
111 
112 #ifndef FUNCTION_scaleValue
113 /*!
114  *
115  *  \brief Multiply input by \f$ 2^{scalefactor} \f$
116  *
117  *  \return Scaled input
118  *
119  */
120 #define FUNCTION_scaleValue
121 inline
scaleValue(const FIXP_DBL value,INT scalefactor)122 FIXP_DBL scaleValue(const FIXP_DBL value, /*!< Value */
123                     INT scalefactor   /*!< Scalefactor */
124                    )
125 {
126   if(scalefactor > 0)
127     return (value<<scalefactor);
128   else
129     return (value>>(-scalefactor));
130 }
131 #endif
132 
133 #ifndef FUNCTION_scaleValueSaturate
134 /*!
135  *
136  *  \brief Multiply input by \f$ 2^{scalefactor} \f$
137  *  \param value The value to be scaled.
138  *  \param the shift amount
139  *  \return \f$ value * 2^scalefactor \f$
140  *
141  */
142 #define FUNCTION_scaleValueSaturate
143 inline
scaleValueSaturate(const FIXP_DBL value,INT scalefactor)144 FIXP_DBL scaleValueSaturate(
145         const FIXP_DBL value,
146         INT scalefactor
147         )
148 {
149   if(scalefactor > 0) {
150     if (fNorm(value) < scalefactor && value != (FIXP_DBL)0) {
151       if (value > (FIXP_DBL)0) {
152         return (FIXP_DBL)MAXVAL_DBL;
153       } else {
154         return (FIXP_DBL)MINVAL_DBL;
155       }
156     } else {
157       return (value<<scalefactor);
158     }
159   } else {
160     if (-(DFRACT_BITS-1) > scalefactor) {
161       return (FIXP_DBL)0;
162     } else {
163     return (value>>(-scalefactor));
164     }
165   }
166 }
167 #endif
168 
169 #ifndef FUNCTION_scaleValueInPlace
170 /*!
171  *
172  *  \brief Multiply input by \f$ 2^{scalefactor} \f$ in place
173  *
174  *  \return void
175  *
176  */
177 #define FUNCTION_scaleValueInPlace
178 inline
scaleValueInPlace(FIXP_DBL * value,INT scalefactor)179 void scaleValueInPlace(
180         FIXP_DBL *value, /*!< Value */
181         INT scalefactor   /*!< Scalefactor */
182         )
183 {
184   INT newscale;
185   /* Note: The assignment inside the if conditional allows combining a load with the compare to zero (on ARM and maybe others) */
186   if ((newscale = (scalefactor)) >= 0) {
187     *(value) <<= newscale;
188   } else {
189     *(value) >>= -newscale;
190   }
191 }
192 #endif
193 
194 /*!
195  *
196  *  \brief  Scale input value by 2^{scale} and saturate output to 2^{dBits-1}
197  *  \return scaled and saturated value
198  *
199  *  This macro scales src value right or left and applies saturation to (2^dBits)-1
200  *  maxima output.
201  */
202 
203 #ifndef SATURATE_RIGHT_SHIFT
204   #define SATURATE_RIGHT_SHIFT(src, scale, dBits)                                                      \
205             ( (((LONG)(src)>>(scale)) > (LONG)(((1U)<<((dBits)-1))-1))      ? (LONG)(((1U)<<((dBits)-1))-1)    \
206               : (((LONG)(src)>>(scale)) < ~((LONG)(((1U)<<((dBits)-1))-1))) ? ~((LONG)(((1U)<<((dBits)-1))-1)) \
207               : ((LONG)(src) >> (scale)) )
208 #endif
209 
210 #ifndef SATURATE_LEFT_SHIFT
211   #define SATURATE_LEFT_SHIFT(src, scale, dBits)                                                       \
212             ( ((LONG)(src) > ((LONG)(((1U)<<((dBits)-1))-1)>>(scale)))    ? (LONG)(((1U)<<((dBits)-1))-1)      \
213               : ((LONG)(src) < ~((LONG)(((1U)<<((dBits)-1))-1)>>(scale))) ? ~((LONG)(((1U)<<((dBits)-1))-1))   \
214               : ((LONG)(src) << (scale)) )
215 #endif
216 
217 #ifndef SATURATE_SHIFT
218 #define SATURATE_SHIFT(src, scale, dBits)               \
219      ( ((scale) < 0)                                      \
220       ? SATURATE_LEFT_SHIFT((src), -(scale), (dBits))   \
221       : SATURATE_RIGHT_SHIFT((src), (scale), (dBits)) )
222 #endif
223 
224 /*
225  * Alternative shift and saturate left, saturates to -0.99999 instead of -1.0000
226  * to avoid problems when inverting the sign of the result.
227  */
228 #ifndef SATURATE_LEFT_SHIFT_ALT
229 #define SATURATE_LEFT_SHIFT_ALT(src, scale, dBits)                                                     \
230             ( ((LONG)(src) > ((LONG)(((1U)<<((dBits)-1))-1)>>(scale)))    ? (LONG)(((1U)<<((dBits)-1))-1)      \
231               : ((LONG)(src) < ~((LONG)(((1U)<<((dBits)-1))-2)>>(scale))) ? ~((LONG)(((1U)<<((dBits)-1))-2))   \
232               : ((LONG)(src) << (scale)) )
233 #endif
234 
235 #ifndef SATURATE_RIGHT_SHIFT_ALT
236   #define SATURATE_RIGHT_SHIFT_ALT(src, scale, dBits)                                                  \
237             ( (((LONG)(src)>>(scale)) > (LONG)(((1U)<<((dBits)-1))-1))      ? (LONG)(((1U)<<((dBits)-1))-1)    \
238               : (((LONG)(src)>>(scale)) < ~((LONG)(((1U)<<((dBits)-1))-2))) ? ~((LONG)(((1U)<<((dBits)-1))-2)) \
239               : ((LONG)(src) >> (scale)) )
240 #endif
241 
242 #ifndef SATURATE_INT_PCM_RIGHT_SHIFT
243 #define SATURATE_INT_PCM_RIGHT_SHIFT(src, scale) SATURATE_RIGHT_SHIFT(src, scale, SAMPLE_BITS)
244 #endif
245 
246 #ifndef SATURATE_INT_PCM_LEFT_SHIFT
247 #define SATURATE_INT_PCM_LEFT_SHIFT(src, scale) SATURATE_LEFT_SHIFT(src, scale, SAMPLE_BITS)
248 #endif
249 
250 #endif /* #ifndef SCALE_H */
251