Merge commit 'origin/master'
[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 #include "entcode.h"
40 #include "os_support.h"
41
42 #ifndef OVERRIDE_CELT_ILOG2
43 /** Integer log in base2. Undefined for zero and negative numbers */
44 static inline celt_int16_t celt_ilog2(celt_word32_t x)
45 {
46    celt_assert2(x>0, "celt_ilog2() only defined for strictly positive numbers");
47    return EC_ILOG(x)-1;
48 }
49 #endif
50
51 #ifndef OVERRIDE_FIND_MAX16
52 static inline int find_max16(celt_word16_t *x, int len)
53 {
54    celt_word16_t max_corr=-VERY_LARGE16;
55    int i, id = 0;
56    for (i=0;i<len;i++)
57    {
58       if (x[i] > max_corr)
59       {
60          id = i;
61          max_corr = x[i];
62       }
63    }
64    return id;
65 }
66 #endif
67
68 #ifndef OVERRIDE_FIND_MAX32
69 static inline int find_max32(celt_word32_t *x, int len)
70 {
71    celt_word32_t max_corr=-VERY_LARGE32;
72    int i, id = 0;
73    for (i=0;i<len;i++)
74    {
75       if (x[i] > max_corr)
76       {
77          id = i;
78          max_corr = x[i];
79       }
80    }
81    return id;
82 }
83 #endif
84
85 #define FRAC_MUL16(a,b) ((16384+((celt_int32_t)(celt_int16_t)(a)*(celt_int16_t)(b)))>>15)
86 static inline celt_int16_t bitexact_cos(celt_int16_t x)
87 {
88    celt_int32_t tmp;
89    celt_int16_t x2;
90    tmp = (4096+((celt_int32_t)(x)*(x)))>>13;
91    if (tmp > 32767)
92       tmp = 32767;
93    x2 = tmp;
94    x2 = (32767-x2) + FRAC_MUL16(x2, (-7651 + FRAC_MUL16(x2, (8277 + FRAC_MUL16(-626, x2)))));
95    if (x2 > 32766)
96       x2 = 32766;
97    return 1+x2;
98 }
99
100
101 #ifndef FIXED_POINT
102
103 #define celt_sqrt(x) ((float)sqrt(x))
104 #define celt_psqrt(x) ((float)sqrt(x))
105 #define celt_rsqrt(x) (1.f/celt_sqrt(x))
106 #define celt_acos acos
107 #define celt_exp exp
108 #define celt_cos_norm(x) (cos((.5f*M_PI)*(x)))
109 #define celt_atan atan
110 #define celt_rcp(x) (1.f/(x))
111 #define celt_div(a,b) ((a)/(b))
112 #define celt_log2(x) (1.442695*log(x))
113 #define celt_exp2(x) (exp(0.69315*(x)))
114 #endif
115
116
117
118 #ifdef FIXED_POINT
119
120 #include "os_support.h"
121
122 #ifndef OVERRIDE_CELT_MAXABS16
123 static inline celt_word16_t celt_maxabs16(celt_word16_t *x, int len)
124 {
125    int i;
126    celt_word16_t maxval = 0;
127    for (i=0;i<len;i++)
128       maxval = MAX16(maxval, ABS16(x[i]));
129    return maxval;
130 }
131 #endif
132
133 /** Integer log in base2. Defined for zero, but not for negative numbers */
134 static inline celt_int16_t celt_zlog2(celt_word32_t x)
135 {
136    return x <= 0 ? 0 : celt_ilog2(x);
137 }
138
139 /** Reciprocal sqrt approximation (Q30 input, Q0 output or equivalent) */
140 static inline celt_word32_t celt_rsqrt(celt_word32_t x)
141 {
142    int k;
143    celt_word16_t n;
144    celt_word32_t rt;
145    const celt_word16_t C[5] = {23126, -11496, 9812, -9097, 4100};
146    k = celt_ilog2(x)>>1;
147    x = VSHR32(x, (k-7)<<1);
148    /* Range of n is [-16384,32767] */
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,k);
153    return rt;
154 }
155
156 /** Sqrt approximation (QX input, QX/2 output) */
157 static inline celt_word32_t celt_sqrt(celt_word32_t x)
158 {
159    int k;
160    celt_word16_t n;
161    celt_word32_t rt;
162    const celt_word16_t C[5] = {23174, 11584, -3011, 1570, -557};
163    if (x==0)
164       return 0;
165    k = (celt_ilog2(x)>>1)-7;
166    x = VSHR32(x, (k<<1));
167    n = x-32768;
168    rt = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
169               MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
170    rt = VSHR32(rt,7-k);
171    return rt;
172 }
173
174 /** Sqrt approximation (QX input, QX/2 output) that assumes that the input is
175     strictly positive */
176 static inline celt_word32_t celt_psqrt(celt_word32_t x)
177 {
178    int k;
179    celt_word16_t n;
180    celt_word32_t rt;
181    const celt_word16_t C[5] = {23174, 11584, -3011, 1570, -557};
182    k = (celt_ilog2(x)>>1)-7;
183    x = VSHR32(x, (k<<1));
184    n = x-32768;
185    rt = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
186               MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
187    rt = VSHR32(rt,7-k);
188    return rt;
189 }
190
191 #define L1 32767
192 #define L2 -7651
193 #define L3 8277
194 #define L4 -626
195
196 static inline celt_word16_t _celt_cos_pi_2(celt_word16_t x)
197 {
198    celt_word16_t x2;
199    
200    x2 = MULT16_16_P15(x,x);
201    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
202                                                                                 ))))))));
203 }
204
205 #undef L1
206 #undef L2
207 #undef L3
208 #undef L4
209
210 static inline celt_word16_t celt_cos_norm(celt_word32_t x)
211 {
212    x = x&0x0001ffff;
213    if (x>SHL32(EXTEND32(1), 16))
214       x = SUB32(SHL32(EXTEND32(1), 17),x);
215    if (x&0x00007fff)
216    {
217       if (x<SHL32(EXTEND32(1), 15))
218       {
219          return _celt_cos_pi_2(EXTRACT16(x));
220       } else {
221          return NEG32(_celt_cos_pi_2(EXTRACT16(65536-x)));
222       }
223    } else {
224       if (x&0x0000ffff)
225          return 0;
226       else if (x&0x0001ffff)
227          return -32767;
228       else
229          return 32767;
230    }
231 }
232
233 static inline celt_word16_t celt_log2(celt_word32_t x)
234 {
235    int i;
236    celt_word16_t n, frac;
237    /*-0.41446   0.96093  -0.33981   0.15600 */
238    const celt_word16_t C[4] = {-6791, 7872, -1392, 319};
239    if (x==0)
240       return -32767;
241    i = celt_ilog2(x);
242    n = VSHR32(x,i-15)-32768-16384;
243    frac = ADD16(C[0], MULT16_16_Q14(n, ADD16(C[1], MULT16_16_Q14(n, ADD16(C[2], MULT16_16_Q14(n, (C[3])))))));
244    /*printf ("%d %d %d %d\n", x, n, ret, SHL16(i-13,8)+SHR16(ret,14-8));*/
245    return SHL16(i-13,8)+SHR16(frac,14-8);
246 }
247
248 /*
249  K0 = 1
250  K1 = log(2)
251  K2 = 3-4*log(2)
252  K3 = 3*log(2) - 2
253 */
254 #define D0 16384
255 #define D1 11356
256 #define D2 3726
257 #define D3 1301
258 /** Base-2 exponential approximation (2^x). (Q11 input, Q16 output) */
259 static inline celt_word32_t celt_exp2(celt_word16_t x)
260 {
261    int integer;
262    celt_word16_t frac;
263    integer = SHR16(x,11);
264    if (integer>14)
265       return 0x7f000000;
266    else if (integer < -15)
267       return 0;
268    frac = SHL16(x-SHL16(integer,11),3);
269    frac = ADD16(D0, MULT16_16_Q14(frac, ADD16(D1, MULT16_16_Q14(frac, ADD16(D2 , MULT16_16_Q14(D3,frac))))));
270    return VSHR32(EXTEND32(frac), -integer-2);
271 }
272
273 /** Reciprocal approximation (Q15 input, Q16 output) */
274 static inline celt_word32_t celt_rcp(celt_word32_t x)
275 {
276    int i;
277    celt_word16_t n, frac;
278    const celt_word16_t C[5] = {21848, -7251, 2403, -934, 327};
279    celt_assert2(x>0, "celt_rcp() only defined for positive values");
280    i = celt_ilog2(x);
281    n = VSHR32(x,i-16)-SHL32(EXTEND32(3),15);
282    frac = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
283                 MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
284    return VSHR32(EXTEND32(frac),i-16);
285 }
286
287 #define celt_div(a,b) MULT32_32_Q31((celt_word32_t)(a),celt_rcp(b))
288
289
290 #define M1 32767
291 #define M2 -21
292 #define M3 -11943
293 #define M4 4936
294
295 static inline celt_word16_t celt_atan01(celt_word16_t x)
296 {
297    return MULT16_16_P15(x, ADD32(M1, MULT16_16_P15(x, ADD32(M2, MULT16_16_P15(x, ADD32(M3, MULT16_16_P15(M4, x)))))));
298 }
299
300 #undef M1
301 #undef M2
302 #undef M3
303 #undef M4
304
305 static inline celt_word16_t celt_atan2p(celt_word16_t y, celt_word16_t x)
306 {
307    if (y < x)
308    {
309       celt_word32_t arg;
310       arg = celt_div(SHL32(EXTEND32(y),15),x);
311       if (arg >= 32767)
312          arg = 32767;
313       return SHR16(celt_atan01(EXTRACT16(arg)),1);
314    } else {
315       celt_word32_t arg;
316       arg = celt_div(SHL32(EXTEND32(x),15),y);
317       if (arg >= 32767)
318          arg = 32767;
319       return 25736-SHR16(celt_atan01(EXTRACT16(arg)),1);
320    }
321 }
322
323 #endif /* FIXED_POINT */
324
325
326 #endif /* MATHOPS_H */