fixed-point: playing it safe. SHL32() now automatically casts input to 32-bit
[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 FIXED_POINT
41
42 #define celt_sqrt sqrt
43 #define celt_acos acos
44 #define celt_exp exp
45 #define celt_cos_norm(x) (cos((.5f*M_PI)*(x)))
46 #define celt_atan atan
47 #define celt_rcp(x) (1.f/(x))
48
49 #endif
50
51
52
53 #ifdef FIXED_POINT
54
55 #include "entcode.h"
56
57 /** Integer log in base2. Undefined for zero and negative numbers */
58 static inline celt_int16_t celt_ilog2(celt_word32_t x)
59 {
60    return EC_ILOG(x)-1;
61 }
62
63 /** Sqrt approximation (QX input, QX/2 output) */
64 static inline celt_word32_t celt_sqrt(celt_word32_t x)
65 {
66    int k;
67    celt_word16_t n;
68    celt_word32_t rt;
69    const celt_word16_t C[5] = {23174, 11584, -3011, 1570, -557};
70    if (x==0)
71       return 0;
72    k = (celt_ilog2(x)>>1)-7;
73    x = VSHR32(x, (k<<1));
74    n = x-32768;
75    rt = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
76               MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
77    rt = VSHR32(rt,7-k);
78    return rt;
79 }
80
81
82 #define L1 32767
83 #define L2 -7651
84 #define L3 8277
85 #define L4 -626
86
87 static inline celt_word16_t _celt_cos_pi_2(celt_word16_t x)
88 {
89    celt_word16_t x2;
90    
91    x2 = MULT16_16_P15(x,x);
92    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
93                                                                                 ))))))));
94 }
95
96 #undef L1
97 #undef L2
98 #undef L3
99 #undef L4
100
101 static inline celt_word16_t celt_cos_norm(celt_word32_t x)
102 {
103    x = x&0x0001ffff;
104    if (x>SHL32(EXTEND32(1), 16))
105       x = SUB32(SHL32(EXTEND32(1), 17),x);
106    if (x&0x00007fff)
107    {
108       if (x<SHL32(EXTEND32(1), 15))
109       {
110          return _celt_cos_pi_2(EXTRACT16(x));
111       } else {
112          return NEG32(_celt_cos_pi_2(EXTRACT16(65536-x)));
113       }
114    } else {
115       if (x&0x0000ffff)
116          return 0;
117       else if (x&0x0001ffff)
118          return -32767;
119       else
120          return 32767;
121    }
122 }
123
124 static inline celt_word16_t celt_log2(celt_word32_t x)
125 {
126    int i;
127    celt_word16_t n, frac;
128    /*-0.41446   0.96093  -0.33981   0.15600 */
129    const celt_word16_t C[4] = {-6791, 7872, -1392, 319};
130    if (x==0)
131       return -32767;
132    i = celt_ilog2(x);
133    n = VSHR32(x,i-15)-32768-16384;
134    frac = ADD16(C[0], MULT16_16_Q14(n, ADD16(C[1], MULT16_16_Q14(n, ADD16(C[2], MULT16_16_Q14(n, (C[3])))))));
135    /*printf ("%d %d %d %d\n", x, n, ret, SHL16(i-13,8)+SHR16(ret,14-8));*/
136    return SHL16(i-13,8)+SHR16(frac,14-8);
137 }
138
139 /*
140  K0 = 1
141  K1 = log(2)
142  K2 = 3-4*log(2)
143  K3 = 3*log(2) - 2
144 */
145 #define D0 16384
146 #define D1 11356
147 #define D2 3726
148 #define D3 1301
149 /** Base-2 exponential approximation (2^x). (Q11 input, Q16 output) */
150 static inline celt_word32_t celt_exp2(celt_word16_t x)
151 {
152    int integer;
153    celt_word16_t frac;
154    integer = SHR16(x,11);
155    if (integer>14)
156       return 0x7fffffff;
157    else if (integer < -15)
158       return 0;
159    frac = SHL16(x-SHL16(integer,11),3);
160    frac = ADD16(D0, MULT16_16_Q14(frac, ADD16(D1, MULT16_16_Q14(frac, ADD16(D2 , MULT16_16_Q14(D3,frac))))));
161    return VSHR32(EXTEND32(frac), -integer-2);
162 }
163
164 /** Reciprocal approximation (Q15 input, Q16 output) */
165 static inline celt_word32_t celt_rcp(celt_word32_t x)
166 {
167    int i, neg=0;
168    celt_word16_t n, frac;
169    const celt_word16_t C[5] = {21848, -7251, 2403, -934, 327};
170    if (x<0)
171    {
172       neg = 1;
173       x = NEG16(x);
174    }
175    i = celt_ilog2(x);
176    n = VSHR32(x,i-16)-SHL32(EXTEND32(3),15);
177    frac = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2], 
178                 MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
179    if (neg)
180       frac = -frac;
181    return VSHR32(EXTEND32(frac),i-16);
182 }
183
184 #endif /* FIXED_POINT */
185
186
187 #endif /* MATHOPS_H */