celt_ilog2() is only used in fixed-point mode
[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 #ifndef OVERRIDE_FIND_MAX16
46 static inline int find_max16(celt_word16 *x, int len)
47 {
48    celt_word16 max_corr=-VERY_LARGE16;
49    int i, id = 0;
50    for (i=0;i<len;i++)
51    {
52       if (x[i] > max_corr)
53       {
54          id = i;
55          max_corr = x[i];
56       }
57    }
58    return id;
59 }
60 #endif
61
62 #ifndef OVERRIDE_FIND_MAX32
63 static inline int find_max32(celt_word32 *x, int len)
64 {
65    celt_word32 max_corr=-VERY_LARGE32;
66    int i, id = 0;
67    for (i=0;i<len;i++)
68    {
69       if (x[i] > max_corr)
70       {
71          id = i;
72          max_corr = x[i];
73       }
74    }
75    return id;
76 }
77 #endif
78
79 #define FRAC_MUL16(a,b) ((16384+((celt_int32)(celt_int16)(a)*(celt_int16)(b)))>>15)
80 static inline celt_int16 bitexact_cos(celt_int16 x)
81 {
82    celt_int32 tmp;
83    celt_int16 x2;
84    tmp = (4096+((celt_int32)(x)*(x)))>>13;
85    if (tmp > 32767)
86       tmp = 32767;
87    x2 = tmp;
88    x2 = (32767-x2) + FRAC_MUL16(x2, (-7651 + FRAC_MUL16(x2, (8277 + FRAC_MUL16(-626, x2)))));
89    if (x2 > 32766)
90       x2 = 32766;
91    return 1+x2;
92 }
93
94
95 #ifndef FIXED_POINT
96
97 #define celt_sqrt(x) ((float)sqrt(x))
98 #define celt_psqrt(x) ((float)sqrt(x))
99 #define celt_rsqrt(x) (1.f/celt_sqrt(x))
100 #define celt_rsqrt_norm(x) (celt_rsqrt(x))
101 #define celt_acos acos
102 #define celt_exp exp
103 #define celt_cos_norm(x) (cos((.5f*M_PI)*(x)))
104 #define celt_atan atan
105 #define celt_rcp(x) (1.f/(x))
106 #define celt_div(a,b) ((a)/(b))
107
108 #ifdef FLOAT_APPROX
109
110 /* Note: This assumes radix-2 floating point with the exponent at bits 23..30 and an offset of 127
111          denorm, +/- inf and NaN are *not* handled */
112
113 /** Base-2 log approximation (log2(x)). */
114 static inline float celt_log2(float x)
115 {
116    int integer;
117    float frac;
118    union {
119       float f;
120       celt_uint32 i;
121    } in;
122    in.f = x;
123    integer = (in.i>>23)-127;
124    in.i -= integer<<23;
125    frac = in.f - 1.5f;
126    frac = -0.41445418f + frac*(0.95909232f
127           + frac*(-0.33951290f + frac*0.16541097f));
128    return 1+integer+frac;
129 }
130
131 /** Base-2 exponential approximation (2^x). */
132 static inline float celt_exp2(float x)
133 {
134    int integer;
135    float frac;
136    union {
137       float f;
138       celt_uint32 i;
139    } res;
140    integer = floor(x);
141    if (integer < -50)
142       return 0;
143    frac = x-integer;
144    /* K0 = 1, K1 = log(2), K2 = 3-4*log(2), K3 = 3*log(2) - 2 */
145    res.f = 0.99992522f + frac * (0.69583354f
146            + frac * (0.22606716f + 0.078024523f*frac));
147    res.i = (res.i + (integer<<23)) & 0x7fffffff;
148    return res.f;
149 }
150
151 #else
152 #define celt_log2(x) (1.442695040888963387*log(x))
153 #define celt_exp2(x) (exp(0.6931471805599453094*(x)))
154 #endif
155
156 #endif
157
158
159
160 #ifdef FIXED_POINT
161
162 #include "os_support.h"
163
164 #ifndef OVERRIDE_CELT_ILOG2
165 /** Integer log in base2. Undefined for zero and negative numbers */
166 static inline celt_int16 celt_ilog2(celt_int32 x)
167 {
168    celt_assert2(x>0, "celt_ilog2() only defined for strictly positive numbers");
169    return EC_ILOG(x)-1;
170 }
171 #endif
172
173
174 #ifndef OVERRIDE_CELT_MAXABS16
175 static inline celt_word16 celt_maxabs16(celt_word16 *x, int len)
176 {
177    int i;
178    celt_word16 maxval = 0;
179    for (i=0;i<len;i++)
180       maxval = MAX16(maxval, ABS16(x[i]));
181    return maxval;
182 }
183 #endif
184
185 /** Integer log in base2. Defined for zero, but not for negative numbers */
186 static inline celt_int16 celt_zlog2(celt_word32 x)
187 {
188    return x <= 0 ? 0 : celt_ilog2(x);
189 }
190
191 /** Reciprocal sqrt approximation in the range [0.25,1) (Q16 in, Q14 out) */
192 static inline celt_word16 celt_rsqrt_norm(celt_word32 x)
193 {
194    celt_word16 n;
195    celt_word16 r;
196    celt_word16 r2;
197    celt_word16 y;
198    /* Range of n is [-16384,32767] ([-0.5,1) in Q15). */
199    n = x-32768;
200    /* Get a rough initial guess for the root.
201       The optimal minimax quadratic approximation (using relative error) is
202        r = 1.437799046117536+n*(-0.823394375837328+n*0.4096419668459485).
203       Coefficients here, and the final result r, are Q14.*/
204    r = ADD16(23557, MULT16_16_Q15(n, ADD16(-13490, MULT16_16_Q15(n, 6713))));
205    /* We want y = x*r*r-1 in Q15, but x is 32-bit Q16 and r is Q14.
206       We can compute the result from n and r using Q15 multiplies with some
207        adjustment, carefully done to avoid overflow.
208       Range of y is [-1564,1594]. */
209    r2 = MULT16_16_Q15(r, r);
210    y = SHL16(SUB16(ADD16(MULT16_16_Q15(r2, n), r2), 16384), 1);
211    /* Apply a 2nd-order Householder iteration: r += r*y*(y*0.375-0.5).
212       This yields the Q14 reciprocal square root of the Q16 x, with a maximum
213        relative error of 1.04956E-4, a (relative) RMSE of 2.80979E-5, and a
214        peak absolute error of 2.26591/16384. */
215    return ADD16(r, MULT16_16_Q15(r, MULT16_16_Q15(y,
216               SUB16(MULT16_16_Q15(y, 12288), 16384))));
217 }
218
219 /** Reciprocal sqrt approximation (Q30 input, Q0 output or equivalent) */
220 static inline celt_word32 celt_rsqrt(celt_word32 x)
221 {
222    int k;
223    k = celt_ilog2(x)>>1;
224    x = VSHR32(x, (k-7)<<1);
225    return PSHR32(celt_rsqrt_norm(x), k);
226 }
227
228 /** Sqrt approximation (QX input, QX/2 output) */
229 static inline celt_word32 celt_sqrt(celt_word32 x)
230 {
231    int k;
232    celt_word16 n;
233    celt_word32 rt;
234    const celt_word16 C[5] = {23175, 11561, -3011, 1699, -664};
235    if (x==0)
236       return 0;
237    k = (celt_ilog2(x)>>1)-7;
238    x = VSHR32(x, (k<<1));
239    n = x-32768;
240    rt = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
241               MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
242    rt = VSHR32(rt,7-k);
243    return rt;
244 }
245
246 /** Sqrt approximation (QX input, QX/2 output) that assumes that the input is
247     strictly positive */
248 static inline celt_word32 celt_psqrt(celt_word32 x)
249 {
250    int k;
251    celt_word16 n;
252    celt_word32 rt;
253    const celt_word16 C[5] = {23175, 11561, -3011, 1699, -664};
254    k = (celt_ilog2(x)>>1)-7;
255    x = VSHR32(x, (k<<1));
256    n = x-32768;
257    rt = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
258               MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
259    rt = VSHR32(rt,7-k);
260    return rt;
261 }
262
263 #define L1 32767
264 #define L2 -7651
265 #define L3 8277
266 #define L4 -626
267
268 static inline celt_word16 _celt_cos_pi_2(celt_word16 x)
269 {
270    celt_word16 x2;
271    
272    x2 = MULT16_16_P15(x,x);
273    return ADD16(1,MIN16(32766,ADD32(SUB16(L1,x2), MULT16_16_P15(x2, ADD32(L2, MULT16_16_P15(x2, ADD32(L3, MULT16_16_P15(L4, x2
274                                                                                 ))))))));
275 }
276
277 #undef L1
278 #undef L2
279 #undef L3
280 #undef L4
281
282 static inline celt_word16 celt_cos_norm(celt_word32 x)
283 {
284    x = x&0x0001ffff;
285    if (x>SHL32(EXTEND32(1), 16))
286       x = SUB32(SHL32(EXTEND32(1), 17),x);
287    if (x&0x00007fff)
288    {
289       if (x<SHL32(EXTEND32(1), 15))
290       {
291          return _celt_cos_pi_2(EXTRACT16(x));
292       } else {
293          return NEG32(_celt_cos_pi_2(EXTRACT16(65536-x)));
294       }
295    } else {
296       if (x&0x0000ffff)
297          return 0;
298       else if (x&0x0001ffff)
299          return -32767;
300       else
301          return 32767;
302    }
303 }
304
305 static inline celt_word16 celt_log2(celt_word32 x)
306 {
307    int i;
308    celt_word16 n, frac;
309    /*-0.41446   0.96093  -0.33981   0.15600 */
310    /* -0.4144541824871411+32/16384, 0.9590923197873218, -0.3395129038105771,
311        0.16541096501128538 */
312    const celt_word16 C[4] = {-6758, 15715, -5563, 2708};
313    if (x==0)
314       return -32767;
315    i = celt_ilog2(x);
316    n = VSHR32(x,i-15)-32768-16384;
317    frac = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], MULT16_16_Q15(n, (C[3])))))));
318    return SHL16(i-13,8)+SHR16(frac,14-8);
319 }
320
321 /*
322  K0 = 1
323  K1 = log(2)
324  K2 = 3-4*log(2)
325  K3 = 3*log(2) - 2
326 */
327 #define D0 16383
328 #define D1 22804
329 #define D2 14819
330 #define D3 10204
331 /** Base-2 exponential approximation (2^x). (Q11 input, Q16 output) */
332 static inline celt_word32 celt_exp2(celt_word16 x)
333 {
334    int integer;
335    celt_word16 frac;
336    integer = SHR16(x,11);
337    if (integer>14)
338       return 0x7f000000;
339    else if (integer < -15)
340       return 0;
341    frac = SHL16(x-SHL16(integer,11),3);
342    frac = ADD16(D0, MULT16_16_Q15(frac, ADD16(D1, MULT16_16_Q15(frac, ADD16(D2 , MULT16_16_Q15(D3,frac))))));
343    return VSHR32(EXTEND32(frac), -integer-2);
344 }
345
346 /** Reciprocal approximation (Q15 input, Q16 output) */
347 static inline celt_word32 celt_rcp(celt_word32 x)
348 {
349    int i;
350    celt_word16 n;
351    celt_word16 r;
352    celt_assert2(x>0, "celt_rcp() only defined for positive values");
353    i = celt_ilog2(x);
354    /* n is Q15 with range [0,1). */
355    n = VSHR32(x,i-15)-32768;
356    /* Start with a linear approximation:
357       r = 1.8823529411764706-0.9411764705882353*n.
358       The coefficients and the result are Q14 in the range [15420,30840].*/
359    r = ADD16(30840, MULT16_16_Q15(-15420, n));
360    /* Perform two Newton iterations:
361       r -= r*((r*n)-1.Q15)
362          = r*((r*n)+(r-1.Q15)). */
363    r = SUB16(r, MULT16_16_Q15(r,
364              ADD16(MULT16_16_Q15(r, n), ADD16(r, -32768))));
365    /* We subtract an extra 1 in the second iteration to avoid overflow; it also
366        neatly compensates for truncation error in the rest of the process. */
367    r = SUB16(r, ADD16(1, MULT16_16_Q15(r,
368              ADD16(MULT16_16_Q15(r, n), ADD16(r, -32768)))));
369    /* r is now the Q15 solution to 2/(n+1), with a maximum relative error
370        of 7.05346E-5, a (relative) RMSE of 2.14418E-5, and a peak absolute
371        error of 1.24665/32768. */
372    return VSHR32(EXTEND32(r),i-16);
373 }
374
375 #define celt_div(a,b) MULT32_32_Q31((celt_word32)(a),celt_rcp(b))
376
377
378 #define M1 32767
379 #define M2 -21
380 #define M3 -11943
381 #define M4 4936
382
383 static inline celt_word16 celt_atan01(celt_word16 x)
384 {
385    return MULT16_16_P15(x, ADD32(M1, MULT16_16_P15(x, ADD32(M2, MULT16_16_P15(x, ADD32(M3, MULT16_16_P15(M4, x)))))));
386 }
387
388 #undef M1
389 #undef M2
390 #undef M3
391 #undef M4
392
393 static inline celt_word16 celt_atan2p(celt_word16 y, celt_word16 x)
394 {
395    if (y < x)
396    {
397       celt_word32 arg;
398       arg = celt_div(SHL32(EXTEND32(y),15),x);
399       if (arg >= 32767)
400          arg = 32767;
401       return SHR16(celt_atan01(EXTRACT16(arg)),1);
402    } else {
403       celt_word32 arg;
404       arg = celt_div(SHL32(EXTEND32(x),15),y);
405       if (arg >= 32767)
406          arg = 32767;
407       return 25736-SHR16(celt_atan01(EXTRACT16(arg)),1);
408    }
409 }
410
411 #endif /* FIXED_POINT */
412
413
414 #endif /* MATHOPS_H */