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