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