Fixes a bug where transient frames would use previous spreading
[opus.git] / celt / 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    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
25    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 */
33
34 #ifndef MATHOPS_H
35 #define MATHOPS_H
36
37 #include "arch.h"
38 #include "entcode.h"
39 #include "os_support.h"
40
41 /* Multiplies two 16-bit fractional values. Bit-exactness of this macro is important */
42 #define FRAC_MUL16(a,b) ((16384+((opus_int32)(opus_int16)(a)*(opus_int16)(b)))>>15)
43
44 unsigned isqrt32(opus_uint32 _val);
45
46 #ifndef OVERRIDE_CELT_MAXABS16
47 static inline opus_val16 celt_maxabs16(const opus_val16 *x, int len)
48 {
49    int i;
50    opus_val16 maxval = 0;
51    for (i=0;i<len;i++)
52       maxval = MAX16(maxval, ABS16(x[i]));
53    return maxval;
54 }
55 #endif
56
57 #ifndef OVERRIDE_CELT_MAXABS32
58 #ifdef FIXED_POINT
59 static inline opus_val32 celt_maxabs32(const opus_val32 *x, int len)
60 {
61    int i;
62    opus_val32 maxval = 0;
63    for (i=0;i<len;i++)
64       maxval = MAX32(maxval, ABS32(x[i]));
65    return maxval;
66 }
67 #else
68 #define celt_maxabs32(x,len) celt_maxabs16(x,len)
69 #endif
70 #endif
71
72
73 #ifndef FIXED_POINT
74
75 #define PI 3.141592653f
76 #define celt_sqrt(x) ((float)sqrt(x))
77 #define celt_rsqrt(x) (1.f/celt_sqrt(x))
78 #define celt_rsqrt_norm(x) (celt_rsqrt(x))
79 #define celt_cos_norm(x) ((float)cos((.5f*PI)*(x)))
80 #define celt_rcp(x) (1.f/(x))
81 #define celt_div(a,b) ((a)/(b))
82 #define frac_div32(a,b) ((float)(a)/(b))
83
84 #ifdef FLOAT_APPROX
85
86 /* Note: This assumes radix-2 floating point with the exponent at bits 23..30 and an offset of 127
87          denorm, +/- inf and NaN are *not* handled */
88
89 /** Base-2 log approximation (log2(x)). */
90 static inline float celt_log2(float x)
91 {
92    int integer;
93    float frac;
94    union {
95       float f;
96       opus_uint32 i;
97    } in;
98    in.f = x;
99    integer = (in.i>>23)-127;
100    in.i -= integer<<23;
101    frac = in.f - 1.5f;
102    frac = -0.41445418f + frac*(0.95909232f
103           + frac*(-0.33951290f + frac*0.16541097f));
104    return 1+integer+frac;
105 }
106
107 /** Base-2 exponential approximation (2^x). */
108 static inline float celt_exp2(float x)
109 {
110    int integer;
111    float frac;
112    union {
113       float f;
114       opus_uint32 i;
115    } res;
116    integer = floor(x);
117    if (integer < -50)
118       return 0;
119    frac = x-integer;
120    /* K0 = 1, K1 = log(2), K2 = 3-4*log(2), K3 = 3*log(2) - 2 */
121    res.f = 0.99992522f + frac * (0.69583354f
122            + frac * (0.22606716f + 0.078024523f*frac));
123    res.i = (res.i + (integer<<23)) & 0x7fffffff;
124    return res.f;
125 }
126
127 #else
128 #define celt_log2(x) ((float)(1.442695040888963387*log(x)))
129 #define celt_exp2(x) ((float)exp(0.6931471805599453094*(x)))
130 #endif
131
132 #endif
133
134 #ifdef FIXED_POINT
135
136 #include "os_support.h"
137
138 #ifndef OVERRIDE_CELT_ILOG2
139 /** Integer log in base2. Undefined for zero and negative numbers */
140 static inline opus_int16 celt_ilog2(opus_int32 x)
141 {
142    celt_assert2(x>0, "celt_ilog2() only defined for strictly positive numbers");
143    return EC_ILOG(x)-1;
144 }
145 #endif
146
147
148 /** Integer log in base2. Defined for zero, but not for negative numbers */
149 static inline opus_int16 celt_zlog2(opus_val32 x)
150 {
151    return x <= 0 ? 0 : celt_ilog2(x);
152 }
153
154 opus_val16 celt_rsqrt_norm(opus_val32 x);
155
156 opus_val32 celt_sqrt(opus_val32 x);
157
158 opus_val16 celt_cos_norm(opus_val32 x);
159
160 static inline opus_val16 celt_log2(opus_val32 x)
161 {
162    int i;
163    opus_val16 n, frac;
164    /* -0.41509302963303146, 0.9609890551383969, -0.31836011537636605,
165        0.15530808010959576, -0.08556153059057618 */
166    static const opus_val16 C[5] = {-6801+(1<<(13-DB_SHIFT)), 15746, -5217, 2545, -1401};
167    if (x==0)
168       return -32767;
169    i = celt_ilog2(x);
170    n = VSHR32(x,i-15)-32768-16384;
171    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]))))))));
172    return SHL16(i-13,DB_SHIFT)+SHR16(frac,14-DB_SHIFT);
173 }
174
175 /*
176  K0 = 1
177  K1 = log(2)
178  K2 = 3-4*log(2)
179  K3 = 3*log(2) - 2
180 */
181 #define D0 16383
182 #define D1 22804
183 #define D2 14819
184 #define D3 10204
185 /** Base-2 exponential approximation (2^x). (Q10 input, Q16 output) */
186 static inline opus_val32 celt_exp2(opus_val16 x)
187 {
188    int integer;
189    opus_val16 frac;
190    integer = SHR16(x,10);
191    if (integer>14)
192       return 0x7f000000;
193    else if (integer < -15)
194       return 0;
195    frac = SHL16(x-SHL16(integer,10),4);
196    frac = ADD16(D0, MULT16_16_Q15(frac, ADD16(D1, MULT16_16_Q15(frac, ADD16(D2 , MULT16_16_Q15(D3,frac))))));
197    return VSHR32(EXTEND32(frac), -integer-2);
198 }
199
200 opus_val32 celt_rcp(opus_val32 x);
201
202 #define celt_div(a,b) MULT32_32_Q31((opus_val32)(a),celt_rcp(b))
203
204 opus_val32 frac_div32(opus_val32 a, opus_val32 b);
205
206 #define M1 32767
207 #define M2 -21
208 #define M3 -11943
209 #define M4 4936
210
211 /* Atan approximation using a 4th order polynomial. Input is in Q15 format
212    and normalized by pi/4. Output is in Q15 format */
213 static inline opus_val16 celt_atan01(opus_val16 x)
214 {
215    return MULT16_16_P15(x, ADD32(M1, MULT16_16_P15(x, ADD32(M2, MULT16_16_P15(x, ADD32(M3, MULT16_16_P15(M4, x)))))));
216 }
217
218 #undef M1
219 #undef M2
220 #undef M3
221 #undef M4
222
223 /* atan2() approximation valid for positive input values */
224 static inline opus_val16 celt_atan2p(opus_val16 y, opus_val16 x)
225 {
226    if (y < x)
227    {
228       opus_val32 arg;
229       arg = celt_div(SHL32(EXTEND32(y),15),x);
230       if (arg >= 32767)
231          arg = 32767;
232       return SHR16(celt_atan01(EXTRACT16(arg)),1);
233    } else {
234       opus_val32 arg;
235       arg = celt_div(SHL32(EXTEND32(x),15),y);
236       if (arg >= 32767)
237          arg = 32767;
238       return 25736-SHR16(celt_atan01(EXTRACT16(arg)),1);
239    }
240 }
241
242 #endif /* FIXED_POINT */
243 #endif /* MATHOPS_H */