Cleanup, de-inlining some math functions
[opus.git] / libcelt / mathops.h
1 /* Copyright (c) 2002-2008 Jean-Marc Valin
2    Copyright (c) 2007-2008 CSIRO
3    Copyright (c) 2007-2009 Xiph.Org Foundation
4    Written by Jean-Marc Valin */
5 /**
6    @file mathops.h
7    @brief Various math functions
8 */
9 /*
10    Redistribution and use in source and binary forms, with or without
11    modification, are permitted provided that the following conditions
12    are met:
13    
14    - Redistributions of source code must retain the above copyright
15    notice, this list of conditions and the following disclaimer.
16    
17    - Redistributions in binary form must reproduce the above copyright
18    notice, this list of conditions and the following disclaimer in the
19    documentation and/or other materials provided with the distribution.
20    
21    - Neither the name of the Xiph.org Foundation nor the names of its
22    contributors may be used to endorse or promote products derived from
23    this software without specific prior written permission.
24    
25    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
29    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 */
37
38 #ifndef MATHOPS_H
39 #define MATHOPS_H
40
41 #include "arch.h"
42 #include "entcode.h"
43 #include "os_support.h"
44
45 /* Multiplies two 16-bit fractional values. Bit-exactness of this macro is important */
46 #define FRAC_MUL16(a,b) ((16384+((celt_int32)(celt_int16)(a)*(celt_int16)(b)))>>15)
47
48
49 #ifndef FIXED_POINT
50
51 #define celt_sqrt(x) ((float)sqrt(x))
52 #define celt_rsqrt(x) (1.f/celt_sqrt(x))
53 #define celt_rsqrt_norm(x) (celt_rsqrt(x))
54 #define celt_acos acos
55 #define celt_exp exp
56 #define celt_cos_norm(x) (cos((.5f*M_PI)*(x)))
57 #define celt_atan atan
58 #define celt_rcp(x) (1.f/(x))
59 #define celt_div(a,b) ((a)/(b))
60 #define frac_div32(a,b) ((float)(a)/(b))
61
62 #ifdef FLOAT_APPROX
63
64 /* Note: This assumes radix-2 floating point with the exponent at bits 23..30 and an offset of 127
65          denorm, +/- inf and NaN are *not* handled */
66
67 /** Base-2 log approximation (log2(x)). */
68 static inline float celt_log2(float x)
69 {
70    int integer;
71    float frac;
72    union {
73       float f;
74       celt_uint32 i;
75    } in;
76    in.f = x;
77    integer = (in.i>>23)-127;
78    in.i -= integer<<23;
79    frac = in.f - 1.5f;
80    frac = -0.41445418f + frac*(0.95909232f
81           + frac*(-0.33951290f + frac*0.16541097f));
82    return 1+integer+frac;
83 }
84
85 /** Base-2 exponential approximation (2^x). */
86 static inline float celt_exp2(float x)
87 {
88    int integer;
89    float frac;
90    union {
91       float f;
92       celt_uint32 i;
93    } res;
94    integer = floor(x);
95    if (integer < -50)
96       return 0;
97    frac = x-integer;
98    /* K0 = 1, K1 = log(2), K2 = 3-4*log(2), K3 = 3*log(2) - 2 */
99    res.f = 0.99992522f + frac * (0.69583354f
100            + frac * (0.22606716f + 0.078024523f*frac));
101    res.i = (res.i + (integer<<23)) & 0x7fffffff;
102    return res.f;
103 }
104
105 #else
106 #define celt_log2(x) (1.442695040888963387*log(x))
107 #define celt_exp2(x) (exp(0.6931471805599453094*(x)))
108 #endif
109
110 #endif
111
112
113
114 #ifdef FIXED_POINT
115
116 #include "os_support.h"
117
118 #ifndef OVERRIDE_CELT_ILOG2
119 /** Integer log in base2. Undefined for zero and negative numbers */
120 static inline celt_int16 celt_ilog2(celt_int32 x)
121 {
122    celt_assert2(x>0, "celt_ilog2() only defined for strictly positive numbers");
123    return EC_ILOG(x)-1;
124 }
125 #endif
126
127
128 #ifndef OVERRIDE_CELT_MAXABS16
129 static inline celt_word16 celt_maxabs16(celt_word16 *x, int len)
130 {
131    int i;
132    celt_word16 maxval = 0;
133    for (i=0;i<len;i++)
134       maxval = MAX16(maxval, ABS16(x[i]));
135    return maxval;
136 }
137 #endif
138
139 /** Integer log in base2. Defined for zero, but not for negative numbers */
140 static inline celt_int16 celt_zlog2(celt_word32 x)
141 {
142    return x <= 0 ? 0 : celt_ilog2(x);
143 }
144
145 celt_word16 celt_rsqrt_norm(celt_word32 x);
146
147 celt_word32 celt_sqrt(celt_word32 x);
148
149 celt_word16 celt_cos_norm(celt_word32 x);
150
151
152 static inline celt_word16 celt_log2(celt_word32 x)
153 {
154    int i;
155    celt_word16 n, frac;
156    /* -0.41509302963303146, 0.9609890551383969, -0.31836011537636605,
157        0.15530808010959576, -0.08556153059057618 */
158    static const celt_word16 C[5] = {-6801+(1<<13-DB_SHIFT), 15746, -5217, 2545, -1401};
159    if (x==0)
160       return -32767;
161    i = celt_ilog2(x);
162    n = VSHR32(x,i-15)-32768-16384;
163    frac = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, C[4]))))))));
164    return SHL16(i-13,DB_SHIFT)+SHR16(frac,14-DB_SHIFT);
165 }
166
167 /*
168  K0 = 1
169  K1 = log(2)
170  K2 = 3-4*log(2)
171  K3 = 3*log(2) - 2
172 */
173 #define D0 16383
174 #define D1 22804
175 #define D2 14819
176 #define D3 10204
177 /** Base-2 exponential approximation (2^x). (Q11 input, Q16 output) */
178 static inline celt_word32 celt_exp2(celt_word16 x)
179 {
180    int integer;
181    celt_word16 frac;
182    integer = SHR16(x,11);
183    if (integer>14)
184       return 0x7f000000;
185    else if (integer < -15)
186       return 0;
187    frac = SHL16(x-SHL16(integer,11),3);
188    frac = ADD16(D0, MULT16_16_Q15(frac, ADD16(D1, MULT16_16_Q15(frac, ADD16(D2 , MULT16_16_Q15(D3,frac))))));
189    return VSHR32(EXTEND32(frac), -integer-2);
190 }
191
192 celt_word32 celt_rcp(celt_word32 x);
193
194 #define celt_div(a,b) MULT32_32_Q31((celt_word32)(a),celt_rcp(b))
195
196 celt_word32 frac_div32(celt_word32 a, celt_word32 b);
197
198 #define M1 32767
199 #define M2 -21
200 #define M3 -11943
201 #define M4 4936
202
203 /* Atan approximation using a 4th order polynomial. Input is in Q15 format
204    and normalized by pi/4. Output is in Q15 format */
205 static inline celt_word16 celt_atan01(celt_word16 x)
206 {
207    return MULT16_16_P15(x, ADD32(M1, MULT16_16_P15(x, ADD32(M2, MULT16_16_P15(x, ADD32(M3, MULT16_16_P15(M4, x)))))));
208 }
209
210 #undef M1
211 #undef M2
212 #undef M3
213 #undef M4
214
215 /* atan2() approximation valid for positive input values */
216 static inline celt_word16 celt_atan2p(celt_word16 y, celt_word16 x)
217 {
218    if (y < x)
219    {
220       celt_word32 arg;
221       arg = celt_div(SHL32(EXTEND32(y),15),x);
222       if (arg >= 32767)
223          arg = 32767;
224       return SHR16(celt_atan01(EXTRACT16(arg)),1);
225    } else {
226       celt_word32 arg;
227       arg = celt_div(SHL32(EXTEND32(x),15),y);
228       if (arg >= 32767)
229          arg = 32767;
230       return 25736-SHR16(celt_atan01(EXTRACT16(arg)),1);
231    }
232 }
233
234 #endif /* FIXED_POINT */
235
236
237 #endif /* MATHOPS_H */