221842907682e7c22c87368031ae97ef60ee897b
[opus.git] / libcelt / mathops.h
1 /* Copyright (C) 2002-2008 Jean-Marc Valin */
2 /**
3    @file mathops.h
4    @brief Various math functions
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    
11    - Redistributions of source code must retain the above copyright
12    notice, this list of conditions and the following disclaimer.
13    
14    - Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17    
18    - Neither the name of the Xiph.org Foundation nor the names of its
19    contributors may be used to endorse or promote products derived from
20    this software without specific prior written permission.
21    
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #ifndef MATHOPS_H
36 #define MATHOPS_H
37
38 #include "arch.h"
39
40 #ifndef OVERRIDE_FIND_MAX16
41 static inline int find_max16(celt_word16_t *x, int len)
42 {
43    celt_word16_t max_corr=-VERY_LARGE16;
44    int i, id = 0;
45    for (i=0;i<len;i++)
46    {
47       if (x[i] > max_corr)
48       {
49          id = i;
50          max_corr = x[i];
51       }
52    }
53    return id;
54 }
55 #endif
56
57 #ifndef OVERRIDE_FIND_MAX32
58 static inline int find_max32(celt_word32_t *x, int len)
59 {
60    celt_word32_t max_corr=-VERY_LARGE32;
61    int i, id = 0;
62    for (i=0;i<len;i++)
63    {
64       if (x[i] > max_corr)
65       {
66          id = i;
67          max_corr = x[i];
68       }
69    }
70    return id;
71 }
72 #endif
73
74
75 #ifndef FIXED_POINT
76
77 #define celt_sqrt(x) ((float)sqrt(x))
78 #define celt_rsqrt(x) (1.f/celt_sqrt(x))
79 #define celt_acos acos
80 #define celt_exp exp
81 #define celt_cos_norm(x) (cos((.5f*M_PI)*(x)))
82 #define celt_atan atan
83 #define celt_rcp(x) (1.f/(x))
84 #define celt_div(a,b) ((a)/(b))
85
86 #endif
87
88
89
90 #ifdef FIXED_POINT
91
92 #include "entcode.h"
93 #include "os_support.h"
94
95 #ifndef OVERRIDE_CELT_ILOG2
96 /** Integer log in base2. Undefined for zero and negative numbers */
97 static inline celt_int16_t celt_ilog2(celt_word32_t x)
98 {
99    celt_assert2(x>0, "celt_ilog2() only defined for strictly positive numbers");
100    return EC_ILOG(x)-1;
101 }
102 #endif
103
104 #ifndef OVERRIDE_CELT_MAXABS16
105 static inline celt_word16_t celt_maxabs16(celt_word16_t *x, int len)
106 {
107    int i;
108    celt_word16_t maxval = 0;
109    for (i=0;i<len;i++)
110       maxval = MAX16(maxval, ABS16(x[i]));
111    return maxval;
112 }
113 #endif
114
115 /** Integer log in base2. Defined for zero, but not for negative numbers */
116 static inline celt_int16_t celt_zlog2(celt_word32_t x)
117 {
118    return EC_ILOG(x)-1;
119 }
120
121 /** Reciprocal sqrt approximation (Q30 input, Q0 output or equivalent) */
122 static inline celt_word32_t celt_rsqrt(celt_word32_t x)
123 {
124    int k;
125    celt_word16_t n;
126    celt_word32_t rt;
127    const celt_word16_t C[5] = {23126, -11496, 9812, -9097, 4100};
128    k = celt_ilog2(x)>>1;
129    x = VSHR32(x, (k-7)<<1);
130    /* Range of n is [-16384,32767] */
131    n = x-32768;
132    rt = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
133               MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
134    rt = VSHR32(rt,k);
135    return rt;
136 }
137
138 /** Sqrt approximation (QX input, QX/2 output) */
139 static inline celt_word32_t celt_sqrt(celt_word32_t x)
140 {
141    int k;
142    celt_word16_t n;
143    celt_word32_t rt;
144    const celt_word16_t C[5] = {23174, 11584, -3011, 1570, -557};
145    if (x==0)
146       return 0;
147    k = (celt_ilog2(x)>>1)-7;
148    x = VSHR32(x, (k<<1));
149    n = x-32768;
150    rt = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
151               MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
152    rt = VSHR32(rt,7-k);
153    return rt;
154 }
155
156
157 #define L1 32767
158 #define L2 -7651
159 #define L3 8277
160 #define L4 -626
161
162 static inline celt_word16_t _celt_cos_pi_2(celt_word16_t x)
163 {
164    celt_word16_t x2;
165    
166    x2 = MULT16_16_P15(x,x);
167    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
168                                                                                 ))))))));
169 }
170
171 #undef L1
172 #undef L2
173 #undef L3
174 #undef L4
175
176 static inline celt_word16_t celt_cos_norm(celt_word32_t x)
177 {
178    x = x&0x0001ffff;
179    if (x>SHL32(EXTEND32(1), 16))
180       x = SUB32(SHL32(EXTEND32(1), 17),x);
181    if (x&0x00007fff)
182    {
183       if (x<SHL32(EXTEND32(1), 15))
184       {
185          return _celt_cos_pi_2(EXTRACT16(x));
186       } else {
187          return NEG32(_celt_cos_pi_2(EXTRACT16(65536-x)));
188       }
189    } else {
190       if (x&0x0000ffff)
191          return 0;
192       else if (x&0x0001ffff)
193          return -32767;
194       else
195          return 32767;
196    }
197 }
198
199 static inline celt_word16_t celt_log2(celt_word32_t x)
200 {
201    int i;
202    celt_word16_t n, frac;
203    /*-0.41446   0.96093  -0.33981   0.15600 */
204    const celt_word16_t C[4] = {-6791, 7872, -1392, 319};
205    if (x==0)
206       return -32767;
207    i = celt_ilog2(x);
208    n = VSHR32(x,i-15)-32768-16384;
209    frac = ADD16(C[0], MULT16_16_Q14(n, ADD16(C[1], MULT16_16_Q14(n, ADD16(C[2], MULT16_16_Q14(n, (C[3])))))));
210    /*printf ("%d %d %d %d\n", x, n, ret, SHL16(i-13,8)+SHR16(ret,14-8));*/
211    return SHL16(i-13,8)+SHR16(frac,14-8);
212 }
213
214 /*
215  K0 = 1
216  K1 = log(2)
217  K2 = 3-4*log(2)
218  K3 = 3*log(2) - 2
219 */
220 #define D0 16384
221 #define D1 11356
222 #define D2 3726
223 #define D3 1301
224 /** Base-2 exponential approximation (2^x). (Q11 input, Q16 output) */
225 static inline celt_word32_t celt_exp2(celt_word16_t x)
226 {
227    int integer;
228    celt_word16_t frac;
229    integer = SHR16(x,11);
230    if (integer>14)
231       return 0x7fffffff;
232    else if (integer < -15)
233       return 0;
234    frac = SHL16(x-SHL16(integer,11),3);
235    frac = ADD16(D0, MULT16_16_Q14(frac, ADD16(D1, MULT16_16_Q14(frac, ADD16(D2 , MULT16_16_Q14(D3,frac))))));
236    return VSHR32(EXTEND32(frac), -integer-2);
237 }
238
239 /** Reciprocal approximation (Q15 input, Q16 output) */
240 static inline celt_word32_t celt_rcp(celt_word32_t x)
241 {
242    int i;
243    celt_word16_t n, frac;
244    const celt_word16_t C[5] = {21848, -7251, 2403, -934, 327};
245    celt_assert2(x>0, "celt_rcp() only defined for positive values");
246    i = celt_ilog2(x);
247    n = VSHR32(x,i-16)-SHL32(EXTEND32(3),15);
248    frac = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
249                 MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
250    return VSHR32(EXTEND32(frac),i-16);
251 }
252
253 #define celt_div(a,b) MULT32_32_Q31((celt_word32_t)(a),celt_rcp(b))
254
255 #endif /* FIXED_POINT */
256
257
258 #endif /* MATHOPS_H */