Cleanup, de-inlining some math functions
[opus.git] / libcelt / mathops.c
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 #ifdef HAVE_CONFIG_H
39 #include "config.h"
40 #endif
41
42 #include "mathops.h"
43
44 #ifdef FIXED_POINT
45
46 celt_word32 frac_div32(celt_word32 a, celt_word32 b)
47 {
48    celt_word16 rcp;
49    celt_word32 result, rem;
50    int shift = 30-celt_ilog2(b);
51    a = SHL32(a,shift);
52    b = SHL32(b,shift);
53
54    /* 16-bit reciprocal */
55    rcp = ROUND16(celt_rcp(ROUND16(b,16)),2);
56    result = SHL32(MULT16_32_Q15(rcp, a),1);
57    rem = a-MULT32_32_Q31(result, b);
58    result += SHL32(MULT16_32_Q15(rcp, rem),1);
59    return result;
60 }
61
62 /** Reciprocal sqrt approximation in the range [0.25,1) (Q16 in, Q14 out) */
63 celt_word16 celt_rsqrt_norm(celt_word32 x)
64 {
65    celt_word16 n;
66    celt_word16 r;
67    celt_word16 r2;
68    celt_word16 y;
69    /* Range of n is [-16384,32767] ([-0.5,1) in Q15). */
70    n = x-32768;
71    /* Get a rough initial guess for the root.
72       The optimal minimax quadratic approximation (using relative error) is
73        r = 1.437799046117536+n*(-0.823394375837328+n*0.4096419668459485).
74       Coefficients here, and the final result r, are Q14.*/
75    r = ADD16(23557, MULT16_16_Q15(n, ADD16(-13490, MULT16_16_Q15(n, 6713))));
76    /* We want y = x*r*r-1 in Q15, but x is 32-bit Q16 and r is Q14.
77       We can compute the result from n and r using Q15 multiplies with some
78        adjustment, carefully done to avoid overflow.
79       Range of y is [-1564,1594]. */
80    r2 = MULT16_16_Q15(r, r);
81    y = SHL16(SUB16(ADD16(MULT16_16_Q15(r2, n), r2), 16384), 1);
82    /* Apply a 2nd-order Householder iteration: r += r*y*(y*0.375-0.5).
83       This yields the Q14 reciprocal square root of the Q16 x, with a maximum
84        relative error of 1.04956E-4, a (relative) RMSE of 2.80979E-5, and a
85        peak absolute error of 2.26591/16384. */
86    return ADD16(r, MULT16_16_Q15(r, MULT16_16_Q15(y,
87               SUB16(MULT16_16_Q15(y, 12288), 16384))));
88 }
89
90 /** Sqrt approximation (QX input, QX/2 output) */
91 celt_word32 celt_sqrt(celt_word32 x)
92 {
93    int k;
94    celt_word16 n;
95    celt_word32 rt;
96    static const celt_word16 C[5] = {23175, 11561, -3011, 1699, -664};
97    if (x==0)
98       return 0;
99    k = (celt_ilog2(x)>>1)-7;
100    x = VSHR32(x, (k<<1));
101    n = x-32768;
102    rt = ADD16(C[0], MULT16_16_Q15(n, ADD16(C[1], MULT16_16_Q15(n, ADD16(C[2],
103               MULT16_16_Q15(n, ADD16(C[3], MULT16_16_Q15(n, (C[4])))))))));
104    rt = VSHR32(rt,7-k);
105    return rt;
106 }
107
108 #define L1 32767
109 #define L2 -7651
110 #define L3 8277
111 #define L4 -626
112
113 static inline celt_word16 _celt_cos_pi_2(celt_word16 x)
114 {
115    celt_word16 x2;
116
117    x2 = MULT16_16_P15(x,x);
118    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
119                                                                                 ))))))));
120 }
121
122 #undef L1
123 #undef L2
124 #undef L3
125 #undef L4
126
127 celt_word16 celt_cos_norm(celt_word32 x)
128 {
129    x = x&0x0001ffff;
130    if (x>SHL32(EXTEND32(1), 16))
131       x = SUB32(SHL32(EXTEND32(1), 17),x);
132    if (x&0x00007fff)
133    {
134       if (x<SHL32(EXTEND32(1), 15))
135       {
136          return _celt_cos_pi_2(EXTRACT16(x));
137       } else {
138          return NEG32(_celt_cos_pi_2(EXTRACT16(65536-x)));
139       }
140    } else {
141       if (x&0x0000ffff)
142          return 0;
143       else if (x&0x0001ffff)
144          return -32767;
145       else
146          return 32767;
147    }
148 }
149
150 /** Reciprocal approximation (Q15 input, Q16 output) */
151 celt_word32 celt_rcp(celt_word32 x)
152 {
153    int i;
154    celt_word16 n;
155    celt_word16 r;
156    celt_assert2(x>0, "celt_rcp() only defined for positive values");
157    i = celt_ilog2(x);
158    /* n is Q15 with range [0,1). */
159    n = VSHR32(x,i-15)-32768;
160    /* Start with a linear approximation:
161       r = 1.8823529411764706-0.9411764705882353*n.
162       The coefficients and the result are Q14 in the range [15420,30840].*/
163    r = ADD16(30840, MULT16_16_Q15(-15420, n));
164    /* Perform two Newton iterations:
165       r -= r*((r*n)-1.Q15)
166          = r*((r*n)+(r-1.Q15)). */
167    r = SUB16(r, MULT16_16_Q15(r,
168              ADD16(MULT16_16_Q15(r, n), ADD16(r, -32768))));
169    /* We subtract an extra 1 in the second iteration to avoid overflow; it also
170        neatly compensates for truncation error in the rest of the process. */
171    r = SUB16(r, ADD16(1, MULT16_16_Q15(r,
172              ADD16(MULT16_16_Q15(r, n), ADD16(r, -32768)))));
173    /* r is now the Q15 solution to 2/(n+1), with a maximum relative error
174        of 7.05346E-5, a (relative) RMSE of 2.14418E-5, and a peak absolute
175        error of 1.24665/32768. */
176    return VSHR32(EXTEND32(r),i-16);
177 }
178
179 #endif