Update SILK code using the CELT range coder
[opus.git] / src_SigProc_FIX / 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 SKP_Silk_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 lzeros = SKP_Silk_CLZ32(in);\r
61 \r
62     * lz = lzeros;\r
63     * frac_Q7 = SKP_ROR32(in, 24 - lzeros) & 0x7f;\r
64 }\r
65 \r
66 /* Approximation of square root                                          */\r
67 /* Accuracy: < +/- 10%  for output values > 15                           */\r
68 /*           < +/- 2.5% for output values > 120                          */\r
69 SKP_INLINE SKP_int32 SKP_Silk_SQRT_APPROX(SKP_int32 x)\r
70 {\r
71     SKP_int32 y, lz, frac_Q7;\r
72 \r
73     if( x <= 0 ) {\r
74         return 0;\r
75     }\r
76 \r
77     SKP_Silk_CLZ_FRAC(x, &lz, &frac_Q7);\r
78 \r
79     if( lz & 1 ) {\r
80         y = 32768;\r
81     } else {\r
82         y = 46214;        /* 46214 = sqrt(2) * 32768 */\r
83     }\r
84 \r
85     /* get scaling right */\r
86     y >>= SKP_RSHIFT(lz, 1);\r
87 \r
88     /* increment using fractional part of input */\r
89     y = SKP_SMLAWB(y, y, SKP_SMULBB(213, frac_Q7));\r
90 \r
91     return y;\r
92 }\r
93 \r
94 /* returns the number of left shifts before overflow for a 16 bit number (ITU definition with norm(0)=0) */\r
95 SKP_INLINE SKP_int32 SKP_Silk_norm16(SKP_int16 a) {\r
96 \r
97   SKP_int32 a32;\r
98 \r
99   /* if ((a == 0) || (a == SKP_int16_MIN)) return(0); */\r
100   if ((a << 1) == 0) return(0);\r
101 \r
102   a32 = a;\r
103   /* if (a32 < 0) a32 = -a32 - 1; */\r
104   a32 ^= SKP_RSHIFT(a32, 31);\r
105 \r
106   return SKP_Silk_CLZ32(a32) - 17;\r
107 }\r
108 \r
109 /* returns the number of left shifts before overflow for a 32 bit number (ITU definition with norm(0)=0) */\r
110 SKP_INLINE SKP_int32 SKP_Silk_norm32(SKP_int32 a) {\r
111   \r
112   /* if ((a == 0) || (a == SKP_int32_MIN)) return(0); */\r
113   if ((a << 1) == 0) return(0);\r
114 \r
115   /* if (a < 0) a = -a - 1; */\r
116   a ^= SKP_RSHIFT(a, 31);\r
117 \r
118   return SKP_Silk_CLZ32(a) - 1;\r
119 }\r
120 \r
121 /* Divide two int32 values and return result as int32 in a given Q-domain */\r
122 SKP_INLINE SKP_int32 SKP_DIV32_varQ(    /* O    returns a good approximation of "(a32 << Qres) / b32" */\r
123     const SKP_int32     a32,            /* I    numerator (Q0)                  */\r
124     const SKP_int32     b32,            /* I    denominator (Q0)                */\r
125     const SKP_int       Qres            /* I    Q-domain of result (>= 0)       */\r
126 )\r
127 {\r
128     SKP_int   a_headrm, b_headrm, lshift;\r
129     SKP_int32 b32_inv, a32_nrm, b32_nrm, result;\r
130 \r
131     SKP_assert( b32 != 0 );\r
132     SKP_assert( Qres >= 0 );\r
133 \r
134     /* Compute number of bits head room and normalize inputs */\r
135     a_headrm = SKP_Silk_CLZ32( SKP_abs(a32) ) - 1;\r
136     a32_nrm = SKP_LSHIFT(a32, a_headrm);                                    /* Q: a_headrm                    */\r
137     b_headrm = SKP_Silk_CLZ32( SKP_abs(b32) ) - 1;\r
138     b32_nrm = SKP_LSHIFT(b32, b_headrm);                                    /* Q: b_headrm                    */\r
139 \r
140     /* Inverse of b32, with 14 bits of precision */\r
141     b32_inv = SKP_DIV32_16( SKP_int32_MAX >> 2, SKP_RSHIFT(b32_nrm, 16) );  /* Q: 29 + 16 - b_headrm        */\r
142 \r
143     /* First approximation */\r
144     result = SKP_SMULWB(a32_nrm, b32_inv);                                  /* Q: 29 + a_headrm - b_headrm    */\r
145 \r
146     /* Compute residual by subtracting product of denominator and first approximation */\r
147     a32_nrm -= SKP_LSHIFT_ovflw( SKP_SMMUL(b32_nrm, result), 3 );           /* Q: a_headrm                    */\r
148 \r
149     /* Refinement */\r
150     result = SKP_SMLAWB(result, a32_nrm, b32_inv);                          /* Q: 29 + a_headrm - b_headrm    */\r
151 \r
152     /* Convert to Qres domain */\r
153     lshift = 29 + a_headrm - b_headrm - Qres;\r
154     if( lshift <= 0 ) {\r
155         return SKP_LSHIFT_SAT32(result, -lshift);\r
156     } else {\r
157         if( lshift < 32){\r
158             return SKP_RSHIFT(result, lshift);\r
159         } else {\r
160             /* Avoid undefined result */\r
161             return 0;\r
162         }\r
163     }\r
164 }\r
165 \r
166 /* Invert int32 value and return result as int32 in a given Q-domain */\r
167 SKP_INLINE SKP_int32 SKP_INVERSE32_varQ(    /* O    returns a good approximation of "(1 << Qres) / b32" */\r
168     const SKP_int32     b32,                /* I    denominator (Q0)                */\r
169     const SKP_int       Qres                /* I    Q-domain of result (> 0)        */\r
170 )\r
171 {\r
172     SKP_int   b_headrm, lshift;\r
173     SKP_int32 b32_inv, b32_nrm, err_Q32, result;\r
174 \r
175     SKP_assert( b32 != 0 );\r
176     SKP_assert( Qres > 0 );\r
177 \r
178     /* Compute number of bits head room and normalize input */\r
179     b_headrm = SKP_Silk_CLZ32( SKP_abs(b32) ) - 1;\r
180     b32_nrm = SKP_LSHIFT(b32, b_headrm);                                    /* Q: b_headrm                */\r
181 \r
182     /* Inverse of b32, with 14 bits of precision */\r
183     b32_inv = SKP_DIV32_16( SKP_int32_MAX >> 2, SKP_RSHIFT(b32_nrm, 16) );  /* Q: 29 + 16 - b_headrm    */\r
184 \r
185     /* First approximation */\r
186     result = SKP_LSHIFT(b32_inv, 16);                                       /* Q: 61 - b_headrm            */\r
187 \r
188     /* Compute residual by subtracting product of denominator and first approximation from one */\r
189     err_Q32 = SKP_LSHIFT_ovflw( -SKP_SMULWB(b32_nrm, b32_inv), 3 );         /* Q32                        */\r
190 \r
191     /* Refinement */\r
192     result = SKP_SMLAWW(result, err_Q32, b32_inv);                          /* Q: 61 - b_headrm            */\r
193 \r
194     /* Convert to Qres domain */\r
195     lshift = 61 - b_headrm - Qres;\r
196     if( lshift <= 0 ) {\r
197         return SKP_LSHIFT_SAT32(result, -lshift);\r
198     } else {\r
199         if( lshift < 32){\r
200             return SKP_RSHIFT(result, lshift);\r
201         }else{\r
202             /* Avoid undefined result */\r
203             return 0;\r
204         }\r
205     }\r
206 }\r
207 \r
208 #define SKP_SIN_APPROX_CONST0       (1073735400)\r
209 #define SKP_SIN_APPROX_CONST1        (-82778932)\r
210 #define SKP_SIN_APPROX_CONST2          (1059577)\r
211 #define SKP_SIN_APPROX_CONST3            (-5013)\r
212 \r
213 /* Sine approximation; an input of 65536 corresponds to 2 * pi */\r
214 /* Uses polynomial expansion of the input to the power 0, 2, 4 and 6 */\r
215 /* The relative error is below 1e-5 */\r
216 SKP_INLINE SKP_int32 SKP_Silk_SIN_APPROX_Q24(        /* O    returns approximately 2^24 * sin(x * 2 * pi / 65536) */\r
217     SKP_int32        x\r
218 )\r
219 {\r
220     SKP_int y_Q30;\r
221 \r
222     /* Keep only bottom 16 bits (the function repeats itself with period 65536) */\r
223     x &= 65535;\r
224 \r
225     /* Split range in four quadrants */\r
226     if( x <= 32768 ) {\r
227         if( x < 16384 ) {\r
228             /* Return cos(pi/2 - x) */\r
229             x = 16384 - x;\r
230         } else {\r
231             /* Return cos(x - pi/2) */\r
232             x -= 16384;\r
233         }\r
234         if( x < 1100 ) {\r
235             /* Special case: high accuracy */\r
236             return SKP_SMLAWB( 1 << 24, SKP_MUL( x, x ), -5053 );\r
237         }\r
238         x = SKP_SMULWB( SKP_LSHIFT( x, 8 ), x );        /* contains x^2 in Q20 */\r
239         y_Q30 = SKP_SMLAWB( SKP_SIN_APPROX_CONST2, x, SKP_SIN_APPROX_CONST3 );\r
240         y_Q30 = SKP_SMLAWW( SKP_SIN_APPROX_CONST1, x, y_Q30 );\r
241         y_Q30 = SKP_SMLAWW( SKP_SIN_APPROX_CONST0 + 66, x, y_Q30 );\r
242     } else {\r
243         if( x < 49152 ) {\r
244             /* Return -cos(3*pi/2 - x) */\r
245             x = 49152 - x;\r
246         } else {\r
247             /* Return -cos(x - 3*pi/2) */\r
248             x -= 49152;\r
249         }\r
250         if( x < 1100 ) {\r
251             /* Special case: high accuracy */\r
252             return SKP_SMLAWB( -1 << 24, SKP_MUL( x, x ), 5053 );\r
253         }\r
254         x = SKP_SMULWB( SKP_LSHIFT( x, 8 ), x );        /* contains x^2 in Q20 */\r
255         y_Q30 = SKP_SMLAWB( -SKP_SIN_APPROX_CONST2, x, -SKP_SIN_APPROX_CONST3 );\r
256         y_Q30 = SKP_SMLAWW( -SKP_SIN_APPROX_CONST1, x, y_Q30 );\r
257         y_Q30 = SKP_SMLAWW( -SKP_SIN_APPROX_CONST0, x, y_Q30 );\r
258     }\r
259     return SKP_RSHIFT_ROUND( y_Q30, 6 );\r
260 }\r
261 \r
262 /* Cosine approximation; an input of 65536 corresponds to 2 * pi */\r
263 /* The relative error is below 1e-5 */\r
264 SKP_INLINE SKP_int32 SKP_Silk_COS_APPROX_Q24(        /* O    returns approximately 2^24 * cos(x * 2 * pi / 65536) */\r
265     SKP_int32        x\r
266 )\r
267 {\r
268     return SKP_Silk_SIN_APPROX_Q24( x + 16384 );\r
269 }\r
270 \r
271 #ifdef  __cplusplus\r
272 }\r
273 #endif\r
274 \r
275 #endif //_SKP_SILK_FIX_INLINES_H_\r