Cleaner way to take into account the prediction for stereo width
[opus.git] / silk / Inlines.h
1 /***********************************************************************
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3 Redistribution and use in source and binary forms, with or without
4 modification, (subject to the limitations in the disclaimer below)
5 are permitted provided that the following conditions are met:
6 - Redistributions of source code must retain the above copyright notice,
7 this list of conditions and the following disclaimer.
8 - Redistributions in binary form must reproduce the above copyright
9 notice, this list of conditions and the following disclaimer in the
10 documentation and/or other materials provided with the distribution.
11 - Neither the name of Skype Limited, nor the names of specific
12 contributors, may be used to endorse or promote products derived from
13 this software without specific prior written permission.
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 ***********************************************************************/
27
28 /*! \file silk_Inlines.h
29  *  \brief silk_Inlines.h defines inline signal processing functions.
30  */
31
32 #ifndef _SILK_FIX_INLINES_H_
33 #define _SILK_FIX_INLINES_H_
34
35 #ifdef  __cplusplus
36 extern "C"
37 {
38 #endif
39
40 /* count leading zeros of opus_int64 */
41 static inline opus_int32 silk_CLZ64(opus_int64 in)
42 {
43     opus_int32 in_upper;
44
45     in_upper = (opus_int32)silk_RSHIFT64(in, 32);
46     if (in_upper == 0) {
47         /* Search in the lower 32 bits */
48         return 32 + silk_CLZ32( (opus_int32) in );
49     } else {
50         /* Search in the upper 32 bits */
51         return silk_CLZ32( in_upper );
52     }
53 }
54
55 /* get number of leading zeros and fractional part (the bits right after the leading one */
56 static inline void silk_CLZ_FRAC(opus_int32 in,            /* I: input */
57                                     opus_int32 *lz,           /* O: number of leading zeros */
58                                     opus_int32 *frac_Q7)      /* O: the 7 bits right after the leading one */
59 {
60     opus_int32 lzeros = silk_CLZ32(in);
61
62     * lz = lzeros;
63     * frac_Q7 = silk_ROR32(in, 24 - lzeros) & 0x7f;
64 }
65
66 /* Approximation of square root                                          */
67 /* Accuracy: < +/- 10%  for output values > 15                           */
68 /*           < +/- 2.5% for output values > 120                          */
69 static inline opus_int32 silk_SQRT_APPROX(opus_int32 x)
70 {
71     opus_int32 y, lz, frac_Q7;
72
73     if( x <= 0 ) {
74         return 0;
75     }
76
77     silk_CLZ_FRAC(x, &lz, &frac_Q7);
78
79     if( lz & 1 ) {
80         y = 32768;
81     } else {
82         y = 46214;        /* 46214 = sqrt(2) * 32768 */
83     }
84
85     /* get scaling right */
86     y >>= silk_RSHIFT(lz, 1);
87
88     /* increment using fractional part of input */
89     y = silk_SMLAWB(y, y, silk_SMULBB(213, frac_Q7));
90
91     return y;
92 }
93
94 /* Divide two int32 values and return result as int32 in a given Q-domain */
95 static inline opus_int32 silk_DIV32_varQ(    /* O    returns a good approximation of "(a32 << Qres) / b32" */
96     const opus_int32     a32,            /* I    numerator (Q0)                  */
97     const opus_int32     b32,            /* I    denominator (Q0)                */
98     const opus_int       Qres            /* I    Q-domain of result (>= 0)       */
99 )
100 {
101     opus_int   a_headrm, b_headrm, lshift;
102     opus_int32 b32_inv, a32_nrm, b32_nrm, result;
103
104     silk_assert( b32 != 0 );
105     silk_assert( Qres >= 0 );
106
107     /* Compute number of bits head room and normalize inputs */
108     a_headrm = silk_CLZ32( silk_abs(a32) ) - 1;
109     a32_nrm = silk_LSHIFT(a32, a_headrm);                                    /* Q: a_headrm                    */
110     b_headrm = silk_CLZ32( silk_abs(b32) ) - 1;
111     b32_nrm = silk_LSHIFT(b32, b_headrm);                                    /* Q: b_headrm                    */
112
113     /* Inverse of b32, with 14 bits of precision */
114     b32_inv = silk_DIV32_16( silk_int32_MAX >> 2, silk_RSHIFT(b32_nrm, 16) );  /* Q: 29 + 16 - b_headrm        */
115
116     /* First approximation */
117     result = silk_SMULWB(a32_nrm, b32_inv);                                  /* Q: 29 + a_headrm - b_headrm    */
118
119     /* Compute residual by subtracting product of denominator and first approximation */
120     a32_nrm -= silk_LSHIFT( silk_SMMUL(b32_nrm, result), 3 );           /* Q: a_headrm                    */
121
122     /* Refinement */
123     result = silk_SMLAWB(result, a32_nrm, b32_inv);                          /* Q: 29 + a_headrm - b_headrm    */
124
125     /* Convert to Qres domain */
126     lshift = 29 + a_headrm - b_headrm - Qres;
127     if( lshift < 0 ) {
128         return silk_LSHIFT_SAT32(result, -lshift);
129     } else {
130         if( lshift < 32){
131             return silk_RSHIFT(result, lshift);
132         } else {
133             /* Avoid undefined result */
134             return 0;
135         }
136     }
137 }
138
139 /* Invert int32 value and return result as int32 in a given Q-domain */
140 static inline opus_int32 silk_INVERSE32_varQ(    /* O    returns a good approximation of "(1 << Qres) / b32" */
141     const opus_int32     b32,                /* I    denominator (Q0)                */
142     const opus_int       Qres                /* I    Q-domain of result (> 0)        */
143 )
144 {
145     opus_int   b_headrm, lshift;
146     opus_int32 b32_inv, b32_nrm, err_Q32, result;
147
148     silk_assert( b32 != 0 );
149     silk_assert( Qres > 0 );
150
151     /* Compute number of bits head room and normalize input */
152     b_headrm = silk_CLZ32( silk_abs(b32) ) - 1;
153     b32_nrm = silk_LSHIFT(b32, b_headrm);                                    /* Q: b_headrm                */
154
155     /* Inverse of b32, with 14 bits of precision */
156     b32_inv = silk_DIV32_16( silk_int32_MAX >> 2, silk_RSHIFT(b32_nrm, 16) );  /* Q: 29 + 16 - b_headrm    */
157
158     /* First approximation */
159     result = silk_LSHIFT(b32_inv, 16);                                       /* Q: 61 - b_headrm            */
160
161     /* Compute residual by subtracting product of denominator and first approximation from one */
162     err_Q32 = silk_LSHIFT( (1<<29) - silk_SMULWB(b32_nrm, b32_inv), 3 );         /* Q32                        */
163
164     /* Refinement */
165     result = silk_SMLAWW(result, err_Q32, b32_inv);                          /* Q: 61 - b_headrm            */
166
167     /* Convert to Qres domain */
168     lshift = 61 - b_headrm - Qres;
169     if( lshift <= 0 ) {
170         return silk_LSHIFT_SAT32(result, -lshift);
171     } else {
172         if( lshift < 32){
173             return silk_RSHIFT(result, lshift);
174         }else{
175             /* Avoid undefined result */
176             return 0;
177         }
178     }
179 }
180
181 #ifdef  __cplusplus
182 }
183 #endif
184
185 #endif /*_SILK_FIX_INLINES_H_*/