1
2/* -----------------------------------------------------------------------------------------------------------
3Software 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
9The Fraunhofer FDK AAC Codec Library for Android ("FDK AAC Codec") is software that implements
10the MPEG Advanced Audio Coding ("AAC") encoding and decoding scheme for digital audio.
11This FDK AAC Codec software is intended to be used on a wide variety of Android devices.
12
13AAC's HE-AAC and HE-AAC v2 versions are regarded as today's most efficient general perceptual
14audio codecs. AAC-ELD is considered the best-performing full-bandwidth communications codec by
15independent studies and is widely deployed. AAC has been standardized by ISO and IEC as part
16of the MPEG specifications.
17
18Patent licenses for necessary patent claims for the FDK AAC Codec (including those of Fraunhofer)
19may be obtained through Via Licensing (www.vialicensing.com) or through the respective patent owners
20individually for the purpose of encoding or decoding bit streams in products that are compliant with
21the ISO/IEC MPEG audio standards. Please note that most manufacturers of Android devices already license
22these patent claims through Via Licensing or directly from the patent owners, and therefore FDK AAC Codec
23software may already be covered under those patent licenses when it is used for those licensed purposes only.
24
25Commercially-licensed AAC software libraries, including floating-point versions with enhanced sound quality,
26are also available from Fraunhofer. Users are encouraged to check the Fraunhofer website for additional
27applications information and documentation.
28
292.    COPYRIGHT LICENSE
30
31Redistribution and use in source and binary forms, with or without modification, are permitted without
32payment of copyright license fees provided that you satisfy the following conditions:
33
34You must retain the complete text of this software license in redistributions of the FDK AAC Codec or
35your modifications thereto in source code form.
36
37You must retain the complete text of this software license in the documentation and/or other materials
38provided with redistributions of the FDK AAC Codec or your modifications thereto in binary form.
39You must make available free of charge copies of the complete source code of the FDK AAC Codec and your
40modifications thereto to recipients of copies in binary form.
41
42The name of Fraunhofer may not be used to endorse or promote products derived from this library without
43prior written permission.
44
45You may not charge copyright license fees for anyone to use, copy or distribute the FDK AAC Codec
46software or your modifications thereto.
47
48Your modified versions of the FDK AAC Codec must carry prominent notices stating that you changed the software
49and 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
533.    NO PATENT LICENSE
54
55NO EXPRESS OR IMPLIED LICENSES TO ANY PATENT CLAIMS, including without limitation the patents of Fraunhofer,
56ARE GRANTED BY THIS SOFTWARE LICENSE. Fraunhofer provides no warranty of patent non-infringement with
57respect to this software.
58
59You may use this FDK AAC Codec software or modifications thereto only for purposes that are authorized
60by appropriate patent licenses.
61
624.    DISCLAIMER
63
64This 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
66of merchantability and fitness for a particular purpose. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
67CONTRIBUTORS BE LIABLE for any direct, indirect, incidental, special, exemplary, or consequential damages,
68including but not limited to procurement of substitute goods or services; loss of use, data, or profits,
69or business interruption, however caused and on any theory of liability, whether in contract, strict
70liability, or tort (including negligence), arising in any way out of the use of this software, even if
71advised of the possibility of such damage.
72
735.    CONTACT INFORMATION
74
75Fraunhofer Institute for Integrated Circuits IIS
76Attention: Audio and Multimedia Departments - FDK AAC LL
77Am Wolfsmantel 33
7891058 Erlangen, Germany
79
80www.iis.fraunhofer.de/amm
81amm-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
121inline
122FIXP_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
143inline
144FIXP_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
178inline
179void 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