Converting allocation table to 1/32 bit/sample resolution.
[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 /* Multiplies two 16-bit fractional values. Bit-exactness of this macro is important */
46 #define FRAC_MUL16(a,b) ((16384+((celt_int32)(celt_int16)(a)*(celt_int16)(b)))>>15)
47
48 unsigned isqrt32(celt_uint32 _val);
49
50 #ifndef FIXED_POINT
51
52 #define celt_sqrt(x) ((float)sqrt(x))
53 #define celt_rsqrt(x) (1.f/celt_sqrt(x))
54 #define celt_rsqrt_norm(x) (celt_rsqrt(x))
55 #define celt_acos acos
56 #define celt_exp exp
57 #define celt_cos_norm(x) ((float)cos((.5f*M_PI)*(x)))
58 #define celt_atan atan
59 #define celt_rcp(x) (1.f/(x))
60 #define celt_div(a,b) ((a)/(b))
61 #define frac_div32(a,b) ((float)(a)/(b))
62
63 #ifdef FLOAT_APPROX
64
65 /* Note: This assumes radix-2 floating point with the exponent at bits 23..30 and an offset of 127
66          denorm, +/- inf and NaN are *not* handled */
67
68 /** Base-2 log approximation (log2(x)). */
69 static inline float celt_log2(float x)
70 {
71    int integer;
72    float frac;
73    union {
74       float f;
75       celt_uint32 i;
76    } in;
77    in.f = x;
78    integer = (in.i>>23)-127;
79    in.i -= integer<<23;
80    frac = in.f - 1.5f;
81    frac = -0.41445418f + frac*(0.95909232f
82           + frac*(-0.33951290f + frac*0.16541097f));
83    return 1+integer+frac;
84 }
85
86 /** Base-2 exponential approximation (2^x). */
87 static inline float celt_exp2(float x)
88 {
89    int integer;
90    float frac;
91    union {
92       float f;
93       celt_uint32 i;
94    } res;
95    integer = floor(x);
96    if (integer < -50)
97       return 0;
98    frac = x-integer;
99    /* K0 = 1, K1 = log(2), K2 = 3-4*log(2), K3 = 3*log(2) - 2 */
100    res.f = 0.99992522f + frac * (0.69583354f
101            + frac * (0.22606716f + 0.078024523f*frac));
102    res.i = (res.i + (integer<<23)) & 0x7fffffff;
103    return res.f;
104 }
105
106 #else
107 #define celt_log2(x) ((float)(1.442695040888963387*log(x)))
108 #define celt_exp2(x) ((float)exp(0.6931471805599453094*(x)))
109 #endif
110
111 #endif
112
113
114
115 #ifdef FIXED_POINT
116
117 #include "os_support.h"
118
119 #ifndef OVERRIDE_CELT_ILOG2
120 /** Integer log in base2. Undefined for zero and negative numbers */
121 static inline celt_int16 celt_ilog2(celt_int32 x)
122 {
123    celt_assert2(x>0, "celt_ilog2() only defined for strictly positive numbers");
124    return EC_ILOG(x)-1;
125 }
126 #endif
127
128
129 #ifndef OVERRIDE_CELT_MAXABS16
130 static inline celt_word16 celt_maxabs16(celt_word16 *x, int len)
131 {
132    int i;
133    celt_word16 maxval = 0;
134    for (i=0;i<len;i++)
135       maxval = MAX16(maxval, ABS16(x[i]));
136    return maxval;
137 }
138 #endif
139
140 /** Integer log in base2. Defined for zero, but not for negative numbers */
141 static inline celt_int16 celt_zlog2(celt_word32 x)
142 {
143    return x <= 0 ? 0 : celt_ilog2(x);
144 }
145
146 celt_word16 celt_rsqrt_norm(celt_word32 x);
147
148 celt_word32 celt_sqrt(celt_word32 x);
149
150 celt_word16 celt_cos_norm(celt_word32 x);
151
152
153 static inline celt_word16 celt_log2(celt_word32 x)
154 {
155    int i;
156    celt_word16 n, frac;
157    /* -0.41509302963303146, 0.9609890551383969, -0.31836011537636605,
158        0.15530808010959576, -0.08556153059057618 */
159    static const celt_word16 C[5] = {-6801+(1<<13-DB_SHIFT), 15746, -5217, 2545, -1401};
160    if (x==0)
161       return -32767;
162    i = celt_ilog2(x);
163    n = VSHR32(x,i-15)-32768-16384;
164    frac = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, C[4]))))))));
165    return SHL16(i-13,DB_SHIFT)+SHR16(frac,14-DB_SHIFT);
166 }
167
168 /*
169  K0 = 1
170  K1 = log(2)
171  K2 = 3-4*log(2)
172  K3 = 3*log(2) - 2
173 */
174 #define D0 16383
175 #define D1 22804
176 #define D2 14819
177 #define D3 10204
178 /** Base-2 exponential approximation (2^x). (Q11 input, Q16 output) */
179 static inline celt_word32 celt_exp2(celt_word16 x)
180 {
181    int integer;
182    celt_word16 frac;
183    integer = SHR16(x,11);
184    if (integer>14)
185       return 0x7f000000;
186    else if (integer < -15)
187       return 0;
188    frac = SHL16(x-SHL16(integer,11),3);
189    frac = ADD16(D0, MULT16_16_Q15(frac, ADD16(D1, MULT16_16_Q15(frac, ADD16(D2 , MULT16_16_Q15(D3,frac))))));
190    return VSHR32(EXTEND32(frac), -integer-2);
191 }
192
193 celt_word32 celt_rcp(celt_word32 x);
194
195 #define celt_div(a,b) MULT32_32_Q31((celt_word32)(a),celt_rcp(b))
196
197 celt_word32 frac_div32(celt_word32 a, celt_word32 b);
198
199 #define M1 32767
200 #define M2 -21
201 #define M3 -11943
202 #define M4 4936
203
204 /* Atan approximation using a 4th order polynomial. Input is in Q15 format
205    and normalized by pi/4. Output is in Q15 format */
206 static inline celt_word16 celt_atan01(celt_word16 x)
207 {
208    return MULT16_16_P15(x, ADD32(M1, MULT16_16_P15(x, ADD32(M2, MULT16_16_P15(x, ADD32(M3, MULT16_16_P15(M4, x)))))));
209 }
210
211 #undef M1
212 #undef M2
213 #undef M3
214 #undef M4
215
216 /* atan2() approximation valid for positive input values */
217 static inline celt_word16 celt_atan2p(celt_word16 y, celt_word16 x)
218 {
219    if (y < x)
220    {
221       celt_word32 arg;
222       arg = celt_div(SHL32(EXTEND32(y),15),x);
223       if (arg >= 32767)
224          arg = 32767;
225       return SHR16(celt_atan01(EXTRACT16(arg)),1);
226    } else {
227       celt_word32 arg;
228       arg = celt_div(SHL32(EXTEND32(x),15),y);
229       if (arg >= 32767)
230          arg = 32767;
231       return 25736-SHR16(celt_atan01(EXTRACT16(arg)),1);
232    }
233 }
234
235 #endif /* FIXED_POINT */
236
237
238 #endif /* MATHOPS_H */