bb5820783c034c09d34c4c75e713bad46b0f163c
[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 sqrt
78 #define celt_acos acos
79 #define celt_exp exp
80 #define celt_cos_norm(x) (cos((.5f*M_PI)*(x)))
81 #define celt_atan atan
82 #define celt_rcp(x) (1.f/(x))
83 #define celt_div(a,b) ((a)/(b))
84
85 #endif
86
87
88
89 #ifdef FIXED_POINT
90
91 #include "entcode.h"
92 #include "os_support.h"
93
94 #ifndef OVERRIDE_CELT_ILOG2
95 /** Integer log in base2. Undefined for zero and negative numbers */
96 static inline celt_int16_t celt_ilog2(celt_word32_t x)
97 {
98    celt_assert2(x>0, "celt_ilog2() only defined for strictly positive numbers");
99    return EC_ILOG(x)-1;
100 }
101 #endif
102
103 #ifndef OVERRIDE_CELT_MAXABS16
104 static inline celt_word16_t celt_maxabs16(celt_word16_t *x, int len)
105 {
106    int i;
107    celt_word16_t maxval = 0;
108    for (i=0;i<len;i++)
109       maxval = MAX16(maxval, ABS16(x[i]));
110    return maxval;
111 }
112 #endif
113
114 /** Integer log in base2. Defined for zero, but not for negative numbers */
115 static inline celt_int16_t celt_zlog2(celt_word32_t x)
116 {
117    return EC_ILOG(x)-1;
118 }
119
120 /** Sqrt approximation (QX input, QX/2 output) */
121 static inline celt_word32_t celt_sqrt(celt_word32_t x)
122 {
123    int k;
124    celt_word16_t n;
125    celt_word32_t rt;
126    const celt_word16_t C[5] = {23174, 11584, -3011, 1570, -557};
127    if (x==0)
128       return 0;
129    k = (celt_ilog2(x)>>1)-7;
130    x = VSHR32(x, (k<<1));
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,7-k);
135    return rt;
136 }
137
138
139 #define L1 32767
140 #define L2 -7651
141 #define L3 8277
142 #define L4 -626
143
144 static inline celt_word16_t _celt_cos_pi_2(celt_word16_t x)
145 {
146    celt_word16_t x2;
147    
148    x2 = MULT16_16_P15(x,x);
149    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
150                                                                                 ))))))));
151 }
152
153 #undef L1
154 #undef L2
155 #undef L3
156 #undef L4
157
158 static inline celt_word16_t celt_cos_norm(celt_word32_t x)
159 {
160    x = x&0x0001ffff;
161    if (x>SHL32(EXTEND32(1), 16))
162       x = SUB32(SHL32(EXTEND32(1), 17),x);
163    if (x&0x00007fff)
164    {
165       if (x<SHL32(EXTEND32(1), 15))
166       {
167          return _celt_cos_pi_2(EXTRACT16(x));
168       } else {
169          return NEG32(_celt_cos_pi_2(EXTRACT16(65536-x)));
170       }
171    } else {
172       if (x&0x0000ffff)
173          return 0;
174       else if (x&0x0001ffff)
175          return -32767;
176       else
177          return 32767;
178    }
179 }
180
181 static inline celt_word16_t celt_log2(celt_word32_t x)
182 {
183    int i;
184    celt_word16_t n, frac;
185    /*-0.41446   0.96093  -0.33981   0.15600 */
186    const celt_word16_t C[4] = {-6791, 7872, -1392, 319};
187    if (x==0)
188       return -32767;
189    i = celt_ilog2(x);
190    n = VSHR32(x,i-15)-32768-16384;
191    frac = ADD16(C[0], MULT16_16_Q14(n, ADD16(C[1], MULT16_16_Q14(n, ADD16(C[2], MULT16_16_Q14(n, (C[3])))))));
192    /*printf ("%d %d %d %d\n", x, n, ret, SHL16(i-13,8)+SHR16(ret,14-8));*/
193    return SHL16(i-13,8)+SHR16(frac,14-8);
194 }
195
196 /*
197  K0 = 1
198  K1 = log(2)
199  K2 = 3-4*log(2)
200  K3 = 3*log(2) - 2
201 */
202 #define D0 16384
203 #define D1 11356
204 #define D2 3726
205 #define D3 1301
206 /** Base-2 exponential approximation (2^x). (Q11 input, Q16 output) */
207 static inline celt_word32_t celt_exp2(celt_word16_t x)
208 {
209    int integer;
210    celt_word16_t frac;
211    integer = SHR16(x,11);
212    if (integer>14)
213       return 0x7fffffff;
214    else if (integer < -15)
215       return 0;
216    frac = SHL16(x-SHL16(integer,11),3);
217    frac = ADD16(D0, MULT16_16_Q14(frac, ADD16(D1, MULT16_16_Q14(frac, ADD16(D2 , MULT16_16_Q14(D3,frac))))));
218    return VSHR32(EXTEND32(frac), -integer-2);
219 }
220
221 /** Reciprocal approximation (Q15 input, Q16 output) */
222 static inline celt_word32_t celt_rcp(celt_word32_t x)
223 {
224    int i;
225    celt_word16_t n, frac;
226    const celt_word16_t C[5] = {21848, -7251, 2403, -934, 327};
227    celt_assert2(x>0, "celt_rcp() only defined for positive values");
228    i = celt_ilog2(x);
229    n = VSHR32(x,i-16)-SHL32(EXTEND32(3),15);
230    frac = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
231                 MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
232    return VSHR32(EXTEND32(frac),i-16);
233 }
234
235 #define celt_div(a,b) MULT32_32_Q31((celt_word32_t)(a),celt_rcp(b))
236
237 #endif /* FIXED_POINT */
238
239
240 #endif /* MATHOPS_H */