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