optimisation: simplified the "full gain" case of alg_quant() to remove some
[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
41 #ifndef OVERRIDE_CELT_ILOG2
42 /** Integer log in base2. Undefined for zero and negative numbers */
43 static inline celt_int16_t celt_ilog2(celt_word32_t x)
44 {
45    celt_assert2(x>0, "celt_ilog2() only defined for strictly positive numbers");
46    return EC_ILOG(x)-1;
47 }
48 #endif
49
50 #ifndef OVERRIDE_FIND_MAX16
51 static inline int find_max16(celt_word16_t *x, int len)
52 {
53    celt_word16_t max_corr=-VERY_LARGE16;
54    int i, id = 0;
55    for (i=0;i<len;i++)
56    {
57       if (x[i] > max_corr)
58       {
59          id = i;
60          max_corr = x[i];
61       }
62    }
63    return id;
64 }
65 #endif
66
67 #ifndef OVERRIDE_FIND_MAX32
68 static inline int find_max32(celt_word32_t *x, int len)
69 {
70    celt_word32_t max_corr=-VERY_LARGE32;
71    int i, id = 0;
72    for (i=0;i<len;i++)
73    {
74       if (x[i] > max_corr)
75       {
76          id = i;
77          max_corr = x[i];
78       }
79    }
80    return id;
81 }
82 #endif
83
84
85 #ifndef FIXED_POINT
86
87 #define celt_sqrt(x) ((float)sqrt(x))
88 #define celt_psqrt(x) ((float)sqrt(x))
89 #define celt_rsqrt(x) (1.f/celt_sqrt(x))
90 #define celt_acos acos
91 #define celt_exp exp
92 #define celt_cos_norm(x) (cos((.5f*M_PI)*(x)))
93 #define celt_atan atan
94 #define celt_rcp(x) (1.f/(x))
95 #define celt_div(a,b) ((a)/(b))
96
97 #endif
98
99
100
101 #ifdef FIXED_POINT
102
103 #include "os_support.h"
104
105 #ifndef OVERRIDE_CELT_MAXABS16
106 static inline celt_word16_t celt_maxabs16(celt_word16_t *x, int len)
107 {
108    int i;
109    celt_word16_t maxval = 0;
110    for (i=0;i<len;i++)
111       maxval = MAX16(maxval, ABS16(x[i]));
112    return maxval;
113 }
114 #endif
115
116 /** Integer log in base2. Defined for zero, but not for negative numbers */
117 static inline celt_int16_t celt_zlog2(celt_word32_t x)
118 {
119    return x <= 0 ? 0 : celt_ilog2(x);
120 }
121
122 /** Reciprocal sqrt approximation (Q30 input, Q0 output or equivalent) */
123 static inline celt_word32_t celt_rsqrt(celt_word32_t x)
124 {
125    int k;
126    celt_word16_t n;
127    celt_word32_t rt;
128    const celt_word16_t C[5] = {23126, -11496, 9812, -9097, 4100};
129    k = celt_ilog2(x)>>1;
130    x = VSHR32(x, (k-7)<<1);
131    /* Range of n is [-16384,32767] */
132    n = x-32768;
133    rt = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
134               MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
135    rt = VSHR32(rt,k);
136    return rt;
137 }
138
139 /** Sqrt approximation (QX input, QX/2 output) */
140 static inline celt_word32_t celt_sqrt(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] = {23174, 11584, -3011, 1570, -557};
146    if (x==0)
147       return 0;
148    k = (celt_ilog2(x)>>1)-7;
149    x = VSHR32(x, (k<<1));
150    n = x-32768;
151    rt = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
152               MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
153    rt = VSHR32(rt,7-k);
154    return rt;
155 }
156
157 /** Sqrt approximation (QX input, QX/2 output) that assumes that the input is
158     strictly positive */
159 static inline celt_word32_t celt_psqrt(celt_word32_t x)
160 {
161    int k;
162    celt_word16_t n;
163    celt_word32_t rt;
164    const celt_word16_t C[5] = {23174, 11584, -3011, 1570, -557};
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 #define L1 32767
175 #define L2 -7651
176 #define L3 8277
177 #define L4 -626
178
179 static inline celt_word16_t _celt_cos_pi_2(celt_word16_t x)
180 {
181    celt_word16_t x2;
182    
183    x2 = MULT16_16_P15(x,x);
184    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
185                                                                                 ))))))));
186 }
187
188 #undef L1
189 #undef L2
190 #undef L3
191 #undef L4
192
193 static inline celt_word16_t celt_cos_norm(celt_word32_t x)
194 {
195    x = x&0x0001ffff;
196    if (x>SHL32(EXTEND32(1), 16))
197       x = SUB32(SHL32(EXTEND32(1), 17),x);
198    if (x&0x00007fff)
199    {
200       if (x<SHL32(EXTEND32(1), 15))
201       {
202          return _celt_cos_pi_2(EXTRACT16(x));
203       } else {
204          return NEG32(_celt_cos_pi_2(EXTRACT16(65536-x)));
205       }
206    } else {
207       if (x&0x0000ffff)
208          return 0;
209       else if (x&0x0001ffff)
210          return -32767;
211       else
212          return 32767;
213    }
214 }
215
216 static inline celt_word16_t celt_log2(celt_word32_t x)
217 {
218    int i;
219    celt_word16_t n, frac;
220    /*-0.41446   0.96093  -0.33981   0.15600 */
221    const celt_word16_t C[4] = {-6791, 7872, -1392, 319};
222    if (x==0)
223       return -32767;
224    i = celt_ilog2(x);
225    n = VSHR32(x,i-15)-32768-16384;
226    frac = ADD16(C[0], MULT16_16_Q14(n, ADD16(C[1], MULT16_16_Q14(n, ADD16(C[2], MULT16_16_Q14(n, (C[3])))))));
227    /*printf ("%d %d %d %d\n", x, n, ret, SHL16(i-13,8)+SHR16(ret,14-8));*/
228    return SHL16(i-13,8)+SHR16(frac,14-8);
229 }
230
231 /*
232  K0 = 1
233  K1 = log(2)
234  K2 = 3-4*log(2)
235  K3 = 3*log(2) - 2
236 */
237 #define D0 16384
238 #define D1 11356
239 #define D2 3726
240 #define D3 1301
241 /** Base-2 exponential approximation (2^x). (Q11 input, Q16 output) */
242 static inline celt_word32_t celt_exp2(celt_word16_t x)
243 {
244    int integer;
245    celt_word16_t frac;
246    integer = SHR16(x,11);
247    if (integer>14)
248       return 0x7fffffff;
249    else if (integer < -15)
250       return 0;
251    frac = SHL16(x-SHL16(integer,11),3);
252    frac = ADD16(D0, MULT16_16_Q14(frac, ADD16(D1, MULT16_16_Q14(frac, ADD16(D2 , MULT16_16_Q14(D3,frac))))));
253    return VSHR32(EXTEND32(frac), -integer-2);
254 }
255
256 /** Reciprocal approximation (Q15 input, Q16 output) */
257 static inline celt_word32_t celt_rcp(celt_word32_t x)
258 {
259    int i;
260    celt_word16_t n, frac;
261    const celt_word16_t C[5] = {21848, -7251, 2403, -934, 327};
262    celt_assert2(x>0, "celt_rcp() only defined for positive values");
263    i = celt_ilog2(x);
264    n = VSHR32(x,i-16)-SHL32(EXTEND32(3),15);
265    frac = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
266                 MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
267    return VSHR32(EXTEND32(frac),i-16);
268 }
269
270 #define celt_div(a,b) MULT32_32_Q31((celt_word32_t)(a),celt_rcp(b))
271
272 #endif /* FIXED_POINT */
273
274
275 #endif /* MATHOPS_H */