Adds 3rd clause to CELT license
[opus.git] / celt / 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 Internet Society, IETF or IETF Trust, nor the
22    names of specific contributors, may be used to endorse or promote
23    products derived from this software without specific prior written
24    permission.
25
26    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
30    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 */
38
39 #ifndef MATHOPS_H
40 #define MATHOPS_H
41
42 #include "arch.h"
43 #include "entcode.h"
44 #include "os_support.h"
45
46 /* Multiplies two 16-bit fractional values. Bit-exactness of this macro is important */
47 #define FRAC_MUL16(a,b) ((16384+((opus_int32)(opus_int16)(a)*(opus_int16)(b)))>>15)
48
49 unsigned isqrt32(opus_uint32 _val);
50
51 #ifndef FIXED_POINT
52
53 #define PI 3.141592653f
54 #define celt_sqrt(x) ((float)sqrt(x))
55 #define celt_rsqrt(x) (1.f/celt_sqrt(x))
56 #define celt_rsqrt_norm(x) (celt_rsqrt(x))
57 #define celt_cos_norm(x) ((float)cos((.5f*PI)*(x)))
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       opus_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       opus_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) ((float)(1.442695040888963387*log(x)))
107 #define celt_exp2(x) ((float)exp(0.6931471805599453094*(x)))
108 #endif
109
110 #endif
111
112 #ifdef FIXED_POINT
113
114 #include "os_support.h"
115
116 #ifndef OVERRIDE_CELT_ILOG2
117 /** Integer log in base2. Undefined for zero and negative numbers */
118 static inline opus_int16 celt_ilog2(opus_int32 x)
119 {
120    celt_assert2(x>0, "celt_ilog2() only defined for strictly positive numbers");
121    return EC_ILOG(x)-1;
122 }
123 #endif
124
125 #ifndef OVERRIDE_CELT_MAXABS16
126 static inline opus_val16 celt_maxabs16(opus_val16 *x, int len)
127 {
128    int i;
129    opus_val16 maxval = 0;
130    for (i=0;i<len;i++)
131       maxval = MAX16(maxval, ABS16(x[i]));
132    return maxval;
133 }
134 #endif
135
136 /** Integer log in base2. Defined for zero, but not for negative numbers */
137 static inline opus_int16 celt_zlog2(opus_val32 x)
138 {
139    return x <= 0 ? 0 : celt_ilog2(x);
140 }
141
142 opus_val16 celt_rsqrt_norm(opus_val32 x);
143
144 opus_val32 celt_sqrt(opus_val32 x);
145
146 opus_val16 celt_cos_norm(opus_val32 x);
147
148 static inline opus_val16 celt_log2(opus_val32 x)
149 {
150    int i;
151    opus_val16 n, frac;
152    /* -0.41509302963303146, 0.9609890551383969, -0.31836011537636605,
153        0.15530808010959576, -0.08556153059057618 */
154    static const opus_val16 C[5] = {-6801+(1<<(13-DB_SHIFT)), 15746, -5217, 2545, -1401};
155    if (x==0)
156       return -32767;
157    i = celt_ilog2(x);
158    n = VSHR32(x,i-15)-32768-16384;
159    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]))))))));
160    return SHL16(i-13,DB_SHIFT)+SHR16(frac,14-DB_SHIFT);
161 }
162
163 /*
164  K0 = 1
165  K1 = log(2)
166  K2 = 3-4*log(2)
167  K3 = 3*log(2) - 2
168 */
169 #define D0 16383
170 #define D1 22804
171 #define D2 14819
172 #define D3 10204
173 /** Base-2 exponential approximation (2^x). (Q10 input, Q16 output) */
174 static inline opus_val32 celt_exp2(opus_val16 x)
175 {
176    int integer;
177    opus_val16 frac;
178    integer = SHR16(x,10);
179    if (integer>14)
180       return 0x7f000000;
181    else if (integer < -15)
182       return 0;
183    frac = SHL16(x-SHL16(integer,10),4);
184    frac = ADD16(D0, MULT16_16_Q15(frac, ADD16(D1, MULT16_16_Q15(frac, ADD16(D2 , MULT16_16_Q15(D3,frac))))));
185    return VSHR32(EXTEND32(frac), -integer-2);
186 }
187
188 opus_val32 celt_rcp(opus_val32 x);
189
190 #define celt_div(a,b) MULT32_32_Q31((opus_val32)(a),celt_rcp(b))
191
192 opus_val32 frac_div32(opus_val32 a, opus_val32 b);
193
194 #define M1 32767
195 #define M2 -21
196 #define M3 -11943
197 #define M4 4936
198
199 /* Atan approximation using a 4th order polynomial. Input is in Q15 format
200    and normalized by pi/4. Output is in Q15 format */
201 static inline opus_val16 celt_atan01(opus_val16 x)
202 {
203    return MULT16_16_P15(x, ADD32(M1, MULT16_16_P15(x, ADD32(M2, MULT16_16_P15(x, ADD32(M3, MULT16_16_P15(M4, x)))))));
204 }
205
206 #undef M1
207 #undef M2
208 #undef M3
209 #undef M4
210
211 /* atan2() approximation valid for positive input values */
212 static inline opus_val16 celt_atan2p(opus_val16 y, opus_val16 x)
213 {
214    if (y < x)
215    {
216       opus_val32 arg;
217       arg = celt_div(SHL32(EXTEND32(y),15),x);
218       if (arg >= 32767)
219          arg = 32767;
220       return SHR16(celt_atan01(EXTRACT16(arg)),1);
221    } else {
222       opus_val32 arg;
223       arg = celt_div(SHL32(EXTEND32(x),15),y);
224       if (arg >= 32767)
225          arg = 32767;
226       return 25736-SHR16(celt_atan01(EXTRACT16(arg)),1);
227    }
228 }
229
230 #endif /* FIXED_POINT */
231 #endif /* MATHOPS_H */