Fixes some compiler warnings
[opus.git] / silk / silk_Inlines.h
1 /***********************************************************************\r
2 Copyright (c) 2006-2011, 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 silk_Inlines.h\r
29  *  \brief silk_Inlines.h defines inline signal processing functions.\r
30  */\r
31 \r
32 #ifndef _SILK_FIX_INLINES_H_\r
33 #define _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 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 + silk_CLZ32( (SKP_int32) in );\r
49     } else {\r
50         /* Search in the upper 32 bits */\r
51         return 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 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 = silk_CLZ32(in);\r
61 \r
62     * lz = lzeros;\r
63     * frac_Q7 = silk_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 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     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 /* Divide two int32 values and return result as int32 in a given Q-domain */\r
95 SKP_INLINE SKP_int32 silk_DIV32_varQ(    /* O    returns a good approximation of "(a32 << Qres) / b32" */\r
96     const SKP_int32     a32,            /* I    numerator (Q0)                  */\r
97     const SKP_int32     b32,            /* I    denominator (Q0)                */\r
98     const SKP_int       Qres            /* I    Q-domain of result (>= 0)       */\r
99 )\r
100 {\r
101     SKP_int   a_headrm, b_headrm, lshift;\r
102     SKP_int32 b32_inv, a32_nrm, b32_nrm, result;\r
103 \r
104     SKP_assert( b32 != 0 );\r
105     SKP_assert( Qres >= 0 );\r
106 \r
107     /* Compute number of bits head room and normalize inputs */\r
108     a_headrm = silk_CLZ32( SKP_abs(a32) ) - 1;\r
109     a32_nrm = SKP_LSHIFT(a32, a_headrm);                                    /* Q: a_headrm                    */\r
110     b_headrm = silk_CLZ32( SKP_abs(b32) ) - 1;\r
111     b32_nrm = SKP_LSHIFT(b32, b_headrm);                                    /* Q: b_headrm                    */\r
112 \r
113     /* Inverse of b32, with 14 bits of precision */\r
114     b32_inv = SKP_DIV32_16( SKP_int32_MAX >> 2, SKP_RSHIFT(b32_nrm, 16) );  /* Q: 29 + 16 - b_headrm        */\r
115 \r
116     /* First approximation */\r
117     result = SKP_SMULWB(a32_nrm, b32_inv);                                  /* Q: 29 + a_headrm - b_headrm    */\r
118 \r
119     /* Compute residual by subtracting product of denominator and first approximation */\r
120     a32_nrm -= SKP_LSHIFT_ovflw( SKP_SMMUL(b32_nrm, result), 3 );           /* Q: a_headrm                    */\r
121 \r
122     /* Refinement */\r
123     result = SKP_SMLAWB(result, a32_nrm, b32_inv);                          /* Q: 29 + a_headrm - b_headrm    */\r
124 \r
125     /* Convert to Qres domain */\r
126     lshift = 29 + a_headrm - b_headrm - Qres;\r
127     if( lshift < 0 ) {\r
128         return SKP_LSHIFT_SAT32(result, -lshift);\r
129     } else {\r
130         if( lshift < 32){\r
131             return SKP_RSHIFT(result, lshift);\r
132         } else {\r
133             /* Avoid undefined result */\r
134             return 0;\r
135         }\r
136     }\r
137 }\r
138 \r
139 /* Invert int32 value and return result as int32 in a given Q-domain */\r
140 SKP_INLINE SKP_int32 silk_INVERSE32_varQ(    /* O    returns a good approximation of "(1 << Qres) / b32" */\r
141     const SKP_int32     b32,                /* I    denominator (Q0)                */\r
142     const SKP_int       Qres                /* I    Q-domain of result (> 0)        */\r
143 )\r
144 {\r
145     SKP_int   b_headrm, lshift;\r
146     SKP_int32 b32_inv, b32_nrm, err_Q32, result;\r
147 \r
148     SKP_assert( b32 != 0 );\r
149     SKP_assert( Qres > 0 );\r
150 \r
151     /* Compute number of bits head room and normalize input */\r
152     b_headrm = silk_CLZ32( SKP_abs(b32) ) - 1;\r
153     b32_nrm = SKP_LSHIFT(b32, b_headrm);                                    /* Q: b_headrm                */\r
154 \r
155     /* Inverse of b32, with 14 bits of precision */\r
156     b32_inv = SKP_DIV32_16( SKP_int32_MAX >> 2, SKP_RSHIFT(b32_nrm, 16) );  /* Q: 29 + 16 - b_headrm    */\r
157 \r
158     /* First approximation */\r
159     result = SKP_LSHIFT(b32_inv, 16);                                       /* Q: 61 - b_headrm            */\r
160 \r
161     /* Compute residual by subtracting product of denominator and first approximation from one */\r
162     err_Q32 = SKP_LSHIFT_ovflw( -SKP_SMULWB(b32_nrm, b32_inv), 3 );         /* Q32                        */\r
163 \r
164     /* Refinement */\r
165     result = SKP_SMLAWW(result, err_Q32, b32_inv);                          /* Q: 61 - b_headrm            */\r
166 \r
167     /* Convert to Qres domain */\r
168     lshift = 61 - b_headrm - Qres;\r
169     if( lshift <= 0 ) {\r
170         return SKP_LSHIFT_SAT32(result, -lshift);\r
171     } else {\r
172         if( lshift < 32){\r
173             return SKP_RSHIFT(result, lshift);\r
174         }else{\r
175             /* Avoid undefined result */\r
176             return 0;\r
177         }\r
178     }\r
179 }\r
180 \r
181 #ifdef  __cplusplus\r
182 }\r
183 #endif\r
184 \r
185 #endif //_SILK_FIX_INLINES_H_\r