Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src / SKP_Silk_Inlines.h
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, Skype Limited. All rights reserved. \r
3 Redistribution and use in source and binary forms, with or without \r
4 modification, (subject to the limitations in the disclaimer below) \r
5 are permitted provided that the following conditions are met:\r
6 - Redistributions of source code must retain the above copyright notice,\r
7 this list of conditions and the following disclaimer.\r
8 - Redistributions in binary form must reproduce the above copyright \r
9 notice, this list of conditions and the following disclaimer in the \r
10 documentation and/or other materials provided with the distribution.\r
11 - Neither the name of Skype Limited, nor the names of specific \r
12 contributors, may be used to endorse or promote products derived from \r
13 this software without specific prior written permission.\r
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED \r
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND \r
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,\r
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND \r
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE \r
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \r
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF \r
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON \r
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \r
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE \r
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
26 ***********************************************************************/\r
27 \r
28 /*! \file SKP_Silk_Inlines.h\r
29  *  \brief SigProcFix_Inlines.h defines inline signal processing functions.\r
30  */\r
31 \r
32 #ifndef _SKP_SILK_FIX_INLINES_H_\r
33 #define _SKP_SILK_FIX_INLINES_H_\r
34 \r
35 #ifdef  __cplusplus\r
36 extern "C"\r
37 {\r
38 #endif\r
39 \r
40 /* count leading zeros of SKP_int64 */\r
41 SKP_INLINE SKP_int32 SKP_Silk_CLZ64(SKP_int64 in)\r
42 {\r
43     SKP_int32 in_upper;\r
44 \r
45     in_upper = (SKP_int32)SKP_RSHIFT64(in, 32);\r
46     if (in_upper == 0) {\r
47         /* Search in the lower 32 bits */\r
48         return 32 + SKP_Silk_CLZ32( (SKP_int32) in );\r
49     } else {\r
50         /* Search in the upper 32 bits */\r
51         return SKP_Silk_CLZ32( in_upper );\r
52     }\r
53 }\r
54 \r
55 /* get number of leading zeros and fractional part (the bits right after the leading one */\r
56 SKP_INLINE void SKP_Silk_CLZ_FRAC(SKP_int32 in,            /* I: input */\r
57                                     SKP_int32 *lz,           /* O: number of leading zeros */\r
58                                     SKP_int32 *frac_Q7)      /* O: the 7 bits right after the leading one */\r
59 {\r
60     SKP_int32 leadingZeros;\r
61 \r
62     leadingZeros = SKP_Silk_CLZ32(in);\r
63     *lz = leadingZeros;\r
64     if( leadingZeros < 24 ) { \r
65         *frac_Q7 = SKP_RSHIFT(in, 24 - leadingZeros) & 0x7F;\r
66     } else {\r
67         *frac_Q7 = SKP_LSHIFT(in, leadingZeros - 24) & 0x7F;\r
68     }\r
69 }\r
70 \r
71 /* Approximation of square root                                          */\r
72 /* Accuracy: < +/- 10% for output values > 15                            */\r
73 /*             < +/- 2.5% for output values > 120                        */\r
74 SKP_INLINE SKP_int32 SKP_Silk_SQRT_APPROX(SKP_int32 x)\r
75 {\r
76     SKP_int32 y, lz, frac_Q7;\r
77 \r
78     if( x <= 0 ) {\r
79         return 0;\r
80     }\r
81 \r
82     SKP_Silk_CLZ_FRAC(x, &lz, &frac_Q7);\r
83 \r
84     if( lz & 1 ) {\r
85         y = 32768;\r
86     } else {\r
87         y = 46214;        /* 46214 = sqrt(2) * 32768 */\r
88     }\r
89 \r
90     /* get scaling right */\r
91     y >>= SKP_RSHIFT(lz, 1);\r
92 \r
93     /* increment using fractional part of input */\r
94     y = SKP_SMLAWB(y, y, SKP_SMULBB(213, frac_Q7));\r
95 \r
96     return y;\r
97 }\r
98 \r
99 /* returns the number of left shifts before overflow for a 16 bit number (ITU definition with norm(0)=0) */\r
100 SKP_INLINE SKP_int32 SKP_Silk_norm16(SKP_int16 a) {\r
101 \r
102   SKP_int32 a32;\r
103 \r
104   /* if ((a == 0) || (a == SKP_int16_MIN)) return(0); */\r
105   if ((a << 1) == 0) return(0);\r
106 \r
107   a32 = a;\r
108   /* if (a32 < 0) a32 = -a32 - 1; */\r
109   a32 ^= SKP_RSHIFT(a32, 31);\r
110 \r
111   return SKP_Silk_CLZ32(a32) - 17;\r
112 }\r
113 \r
114 /* returns the number of left shifts before overflow for a 32 bit number (ITU definition with norm(0)=0) */\r
115 SKP_INLINE SKP_int32 SKP_Silk_norm32(SKP_int32 a) {\r
116   \r
117   /* if ((a == 0) || (a == SKP_int32_MIN)) return(0); */\r
118   if ((a << 1) == 0) return(0);\r
119 \r
120   /* if (a < 0) a = -a - 1; */\r
121   a ^= SKP_RSHIFT(a, 31);\r
122 \r
123   return SKP_Silk_CLZ32(a) - 1;\r
124 }\r
125 \r
126 /* Divide two int32 values and return result as int32 in a given Q-domain */\r
127 SKP_INLINE SKP_int32 SKP_DIV32_varQ(    /* O    returns a good approximation of "(a32 << Qres) / b32" */\r
128     const SKP_int32        a32,         /* I    numerator (Q0)                  */\r
129     const SKP_int32        b32,         /* I    denominator (Q0)                */\r
130     const SKP_int        Qres           /* I    Q-domain of result (>= 0)       */\r
131 )\r
132 {\r
133     SKP_int   a_headrm, b_headrm, lshift;\r
134     SKP_int32 b32_inv, a32_nrm, b32_nrm, result;\r
135 \r
136     SKP_assert( b32 != 0 );\r
137     SKP_assert( Qres >= 0 );\r
138 \r
139     /* Compute number of bits head room and normalize inputs */\r
140     a_headrm = SKP_Silk_CLZ32( SKP_abs(a32) ) - 1;\r
141     a32_nrm = SKP_LSHIFT(a32, a_headrm);                                    /* Q: a_headrm                    */\r
142     b_headrm = SKP_Silk_CLZ32( SKP_abs(b32) ) - 1;\r
143     b32_nrm = SKP_LSHIFT(b32, b_headrm);                                    /* Q: b_headrm                    */\r
144 \r
145     /* Inverse of b32, with 14 bits of precision */\r
146     b32_inv = SKP_DIV32_16( SKP_int32_MAX >> 2, SKP_RSHIFT(b32_nrm, 16) );  /* Q: 29 + 16 - b_headrm        */\r
147 \r
148     /* First approximation */\r
149     result = SKP_SMULWB(a32_nrm, b32_inv);                                  /* Q: 29 + a_headrm - b_headrm    */\r
150 \r
151     /* Compute residual by subtracting product of denominator and first approximation */\r
152     a32_nrm -= SKP_LSHIFT_ovflw( SKP_SMMUL(b32_nrm, result), 3 );           /* Q: a_headrm                    */\r
153 \r
154     /* Refinement */\r
155     result = SKP_SMLAWB(result, a32_nrm, b32_inv);                          /* Q: 29 + a_headrm - b_headrm    */\r
156 \r
157     /* Convert to Qres domain */\r
158     lshift = 29 + a_headrm - b_headrm - Qres;\r
159     if( lshift <= 0 ) {\r
160         return SKP_LSHIFT_SAT32(result, -lshift);\r
161     } else {\r
162         if( lshift < 32){\r
163             return SKP_RSHIFT(result, lshift);\r
164         } else {\r
165             /* Avoid undefined result */\r
166             return 0;\r
167         }\r
168     }\r
169 }\r
170 \r
171 /* Invert int32 value and return result as int32 in a given Q-domain */\r
172 SKP_INLINE SKP_int32 SKP_INVERSE32_varQ(    /* O    returns a good approximation of "(1 << Qres) / b32" */\r
173     const SKP_int32        b32,             /* I    denominator (Q0)                */\r
174     const SKP_int        Qres               /* I    Q-domain of result (> 0)        */\r
175 )\r
176 {\r
177     SKP_int   b_headrm, lshift;\r
178     SKP_int32 b32_inv, b32_nrm, err_Q32, result;\r
179 \r
180     SKP_assert( b32 != 0 );\r
181     SKP_assert( Qres > 0 );\r
182 \r
183     /* Compute number of bits head room and normalize input */\r
184     b_headrm = SKP_Silk_CLZ32( SKP_abs(b32) ) - 1;\r
185     b32_nrm = SKP_LSHIFT(b32, b_headrm);                                    /* Q: b_headrm                */\r
186 \r
187     /* Inverse of b32, with 14 bits of precision */\r
188     b32_inv = SKP_DIV32_16( SKP_int32_MAX >> 2, SKP_RSHIFT(b32_nrm, 16) );  /* Q: 29 + 16 - b_headrm    */\r
189 \r
190     /* First approximation */\r
191     result = SKP_LSHIFT(b32_inv, 16);                                       /* Q: 61 - b_headrm            */\r
192 \r
193     /* Compute residual by subtracting product of denominator and first approximation from one */\r
194     err_Q32 = SKP_LSHIFT_ovflw( -SKP_SMULWB(b32_nrm, b32_inv), 3 );         /* Q32                        */\r
195 \r
196     /* Refinement */\r
197     result = SKP_SMLAWW(result, err_Q32, b32_inv);                          /* Q: 61 - b_headrm            */\r
198 \r
199     /* Convert to Qres domain */\r
200     lshift = 61 - b_headrm - Qres;\r
201     if( lshift <= 0 ) {\r
202         return SKP_LSHIFT_SAT32(result, -lshift);\r
203     } else {\r
204         if( lshift < 32){\r
205             return SKP_RSHIFT(result, lshift);\r
206         }else{\r
207             /* Avoid undefined result */\r
208             return 0;\r
209         }\r
210     }\r
211 }\r
212 \r
213 #define SKP_SIN_APPROX_CONST0       (1073735400)\r
214 #define SKP_SIN_APPROX_CONST1        (-82778932)\r
215 #define SKP_SIN_APPROX_CONST2          (1059577)\r
216 #define SKP_SIN_APPROX_CONST3            (-5013)\r
217 \r
218 /* Sine approximation; an input of 65536 corresponds to 2 * pi */\r
219 /* Uses polynomial expansion of the input to the power 0, 2, 4 and 6 */\r
220 /* The relative error is below 1e-5 */\r
221 SKP_INLINE SKP_int32 SKP_Silk_SIN_APPROX_Q24(        /* O    returns approximately 2^24 * sin(x * 2 * pi / 65536) */\r
222     SKP_int32        x\r
223 )\r
224 {\r
225     SKP_int y_Q30;\r
226 \r
227     /* Keep only bottom 16 bits (the function repeats itself with period 65536) */\r
228     x &= 65535;\r
229 \r
230     /* Split range in four quadrants */\r
231     if( x <= 32768 ) {\r
232         if( x < 16384 ) {\r
233             /* Return cos(pi/2 - x) */\r
234             x = 16384 - x;\r
235         } else {\r
236             /* Return cos(x - pi/2) */\r
237             x -= 16384;\r
238         }\r
239         if( x < 1100 ) {\r
240             /* Special case: high accuracy */\r
241             return SKP_SMLAWB( 1 << 24, SKP_MUL( x, x ), -5053 );\r
242         }\r
243         x = SKP_SMULWB( SKP_LSHIFT( x, 8 ), x );        /* contains x^2 in Q20 */\r
244         y_Q30 = SKP_SMLAWB( SKP_SIN_APPROX_CONST2, x, SKP_SIN_APPROX_CONST3 );\r
245         y_Q30 = SKP_SMLAWW( SKP_SIN_APPROX_CONST1, x, y_Q30 );\r
246         y_Q30 = SKP_SMLAWW( SKP_SIN_APPROX_CONST0 + 66, x, y_Q30 );\r
247     } else {\r
248         if( x < 49152 ) {\r
249             /* Return -cos(3*pi/2 - x) */\r
250             x = 49152 - x;\r
251         } else {\r
252             /* Return -cos(x - 3*pi/2) */\r
253             x -= 49152;\r
254         }\r
255         if( x < 1100 ) {\r
256             /* Special case: high accuracy */\r
257             return SKP_SMLAWB( -1 << 24, SKP_MUL( x, x ), 5053 );\r
258         }\r
259         x = SKP_SMULWB( SKP_LSHIFT( x, 8 ), x );        /* contains x^2 in Q20 */\r
260         y_Q30 = SKP_SMLAWB( -SKP_SIN_APPROX_CONST2, x, -SKP_SIN_APPROX_CONST3 );\r
261         y_Q30 = SKP_SMLAWW( -SKP_SIN_APPROX_CONST1, x, y_Q30 );\r
262         y_Q30 = SKP_SMLAWW( -SKP_SIN_APPROX_CONST0, x, y_Q30 );\r
263     }\r
264     return SKP_RSHIFT_ROUND( y_Q30, 6 );\r
265 }\r
266 \r
267 /* Cosine approximation; an input of 65536 corresponds to 2 * pi */\r
268 /* The relative error is below 1e-5 */\r
269 SKP_INLINE SKP_int32 SKP_Silk_COS_APPROX_Q24(        /* O    returns approximately 2^24 * cos(x * 2 * pi / 65536) */\r
270     SKP_int32        x\r
271 )\r
272 {\r
273     return SKP_Silk_SIN_APPROX_Q24( x + 16384 );\r
274 }\r
275 \r
276 #ifdef  __cplusplus\r
277 }\r
278 #endif\r
279 \r
280 #endif //_SKP_SILK_FIX_INLINES_H_\r