SILK update with LBRR and some bugfixes
[opus.git] / src_SigProc_FLP / SKP_Silk_SigProc_FLP.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 \r
29 #ifndef _SKP_SILK_SIGPROC_FLP_H_\r
30 #define _SKP_SILK_SIGPROC_FLP_H_\r
31 \r
32 #include "SKP_Silk_SigProc_FIX.h"\r
33 #include "float_cast.h"\r
34 #include <math.h>\r
35 \r
36 #ifdef  __cplusplus\r
37 extern "C"\r
38 {\r
39 #endif\r
40 \r
41 /********************************************************************/\r
42 /*                    SIGNAL PROCESSING FUNCTIONS                   */\r
43 /********************************************************************/\r
44 \r
45 /* Chirp (bw expand) LP AR filter */\r
46 void SKP_Silk_bwexpander_FLP( \r
47     SKP_float *ar,                     /* io   AR filter to be expanded (without leading 1)    */\r
48     const SKP_int d,                   /* i     length of ar                                       */\r
49     const SKP_float chirp              /* i     chirp factor (typically in range (0..1) )          */\r
50 );\r
51 \r
52 /* compute inverse of LPC prediction gain, and                                                  */\r
53 /* test if LPC coefficients are stable (all poles within unit circle)   */\r
54 /* this code is based on SKP_Silk_FLP_a2k()                                                             */\r
55 SKP_int SKP_Silk_LPC_inverse_pred_gain_FLP( /* O:   returns 1 if unstable, otherwise 0    */\r
56     SKP_float            *invGain,      /* O:   inverse prediction gain, energy domain    */\r
57     const SKP_float      *A,            /* I:   prediction coefficients [order]           */\r
58     SKP_int32            order          /* I:   prediction order                          */\r
59 );\r
60 \r
61 SKP_float SKP_Silk_schur_FLP(           /* O    returns residual energy                     */\r
62     SKP_float       refl_coef[],        /* O    reflection coefficients (length order)      */\r
63     const SKP_float auto_corr[],        /* I    autocorrelation sequence (length order+1)   */\r
64     SKP_int         order               /* I    order                                       */\r
65 );\r
66 \r
67 void SKP_Silk_k2a_FLP(\r
68     SKP_float           *A,             /* O:   prediction coefficients [order]           */\r
69     const SKP_float     *rc,            /* I:   reflection coefficients [order]           */\r
70     SKP_int32           order           /* I:   prediction order                          */\r
71 );\r
72 \r
73 /* Solve the normal equations using the Levinson-Durbin recursion */\r
74 SKP_float SKP_Silk_levinsondurbin_FLP(  /* O    prediction error energy                                         */\r
75         SKP_float               A[],                            /* O    prediction coefficients [order]                         */\r
76         const SKP_float corr[],                         /* I    input auto-correlations [order + 1]                     */\r
77         const SKP_int   order                           /* I    prediction order                                                        */\r
78 );\r
79 \r
80 /* compute autocorrelation */\r
81 void SKP_Silk_autocorrelation_FLP( \r
82     SKP_float *results,                 /* o    result (length correlationCount)            */\r
83     const SKP_float *inputData,         /* i    input data to correlate                     */\r
84     SKP_int inputDataSize,              /* i    length of input                             */\r
85     SKP_int correlationCount            /* i    number of correlation taps to compute       */\r
86 );\r
87 \r
88 /* Pitch estimator */\r
89 #define SigProc_PE_MIN_COMPLEX        0\r
90 #define SigProc_PE_MID_COMPLEX        1\r
91 #define SigProc_PE_MAX_COMPLEX        2\r
92 \r
93 SKP_int SKP_Silk_pitch_analysis_core_FLP( /* O voicing estimate: 0 voiced, 1 unvoiced                       */\r
94     const SKP_float *signal,            /* I signal of length PE_FRAME_LENGTH_MS*Fs_kHz                     */\r
95     SKP_int         *pitch_out,         /* O 4 pitch lag values                                             */\r
96     SKP_int16       *lagIndex,          /* O lag Index                                                      */\r
97     SKP_int8        *contourIndex,      /* O pitch contour Index                                            */\r
98     SKP_float       *LTPCorr,           /* I/O normalized correlation; input: value from previous frame     */\r
99     SKP_int         prevLag,            /* I last lag of previous frame; set to zero is unvoiced            */\r
100     const SKP_float search_thres1,      /* I first stage threshold for lag candidates 0 - 1                 */\r
101     const SKP_float search_thres2,      /* I final threshold for lag candidates 0 - 1                       */\r
102     const SKP_int   Fs_kHz,             /* I sample frequency (kHz)                                         */\r
103     const SKP_int   complexity,         /* I Complexity setting, 0-2, where 2 is highest                    */\r
104     const SKP_int   nb_subfr            /* I    number of 5 ms subframes                                    */\r
105 );\r
106 \r
107 #define PI               (3.1415926536f)\r
108 \r
109 void SKP_Silk_insertion_sort_decreasing_FLP(\r
110     SKP_float            *a,          /* I/O:  Unsorted / Sorted vector                */\r
111     SKP_int              *index,      /* O:    Index vector for the sorted elements    */\r
112     const SKP_int        L,           /* I:    Vector length                           */\r
113     const SKP_int        K            /* I:    Number of correctly sorted positions    */\r
114 );\r
115 \r
116 void SKP_Silk_insertion_sort_increasing_FLP(\r
117     SKP_float            *a,          /* I/O:  Unsorted / Sorted vector                */\r
118     SKP_int              *index,      /* O:    Index vector for the sorted elements    */\r
119     const SKP_int        L,           /* I:    Vector length                           */\r
120     const SKP_int        K            /* I:    Number of correctly sorted positions    */\r
121 );\r
122 \r
123 /* Laroia low complexity NLSF weights */\r
124 void SKP_Silk_NLSF_VQ_weights_laroia_FLP(       \r
125     SKP_float            *pXW,           /* 0: Pointer to input vector weights                [D x 1]    */\r
126     const SKP_float      *pX,            /* I: Pointer to input vector                        [D x 1]    */ \r
127     const SKP_int        D               /* I: Input vector dimension                                    */\r
128 );\r
129 \r
130 /* Compute reflection coefficients from input signal */\r
131 SKP_float SKP_Silk_burg_modified_FLP(       /* O    returns residual energy                                         */\r
132     SKP_float           A[],                /* O    prediction coefficients (length order)                          */\r
133     const SKP_float     x[],                /* I    input signal, length: nb_subfr*(D+L_sub)                        */\r
134     const SKP_int       subfr_length,       /* I    input signal subframe length (including D preceeding samples)   */\r
135     const SKP_int       nb_subfr,           /* I    number of subframes stacked in x                                */\r
136     const SKP_float     WhiteNoiseFrac,     /* I    fraction added to zero-lag autocorrelation                      */\r
137     const SKP_int       D                   /* I    order                                                           */\r
138 );\r
139 \r
140 /* multiply a vector by a constant */\r
141 void SKP_Silk_scale_vector_FLP( \r
142     SKP_float           *data1,\r
143     SKP_float           gain, \r
144     SKP_int             dataSize\r
145 );\r
146 \r
147 /* copy and multiply a vector by a constant */\r
148 void SKP_Silk_scale_copy_vector_FLP( \r
149     SKP_float           *data_out, \r
150     const SKP_float     *data_in, \r
151     SKP_float           gain, \r
152     SKP_int             dataSize\r
153 );\r
154 \r
155 /* inner product of two SKP_float arrays, with result as double */\r
156 double SKP_Silk_inner_product_FLP( \r
157     const SKP_float     *data1, \r
158     const SKP_float     *data2, \r
159     SKP_int             dataSize\r
160 );\r
161 \r
162 /* sum of squares of a SKP_float array, with result as double */\r
163 double SKP_Silk_energy_FLP( \r
164     const SKP_float     *data, \r
165     SKP_int             dataSize\r
166 );\r
167 \r
168 /********************************************************************/\r
169 /*                                MACROS                                */\r
170 /********************************************************************/\r
171 \r
172 #define SKP_min_float(a, b)                     (((a) < (b)) ? (a) :  (b)) \r
173 #define SKP_max_float(a, b)                     (((a) > (b)) ? (a) :  (b)) \r
174 #define SKP_abs_float(a)                        ((SKP_float)fabs(a))\r
175 \r
176 #define SKP_LIMIT_float( a, limit1, limit2)     ((limit1) > (limit2) ? ((a) > (limit1) ? (limit1) : ((a) < (limit2) ? (limit2) : (a))) \\r
177                                                                                                                              : ((a) > (limit2) ? (limit2) : ((a) < (limit1) ? (limit1) : (a))))\r
178 \r
179 /* sigmoid function */\r
180 SKP_INLINE SKP_float SKP_sigmoid(SKP_float x)\r
181 {\r
182     return (SKP_float)(1.0 / (1.0 + exp(-x)));\r
183 }\r
184 \r
185 /* floating-point to integer conversion (rounding) */\r
186 #if 1\r
187 /* use implementation in float_cast.h */\r
188 #define SKP_float2int(x)   float2int(x)\r
189 #else\r
190 SKP_INLINE SKP_int32 SKP_float2int(SKP_float x) \r
191 {\r
192     double y = x;\r
193     return (SKP_int32)( ( y > 0 ) ? y + 0.5 : y - 0.5 );\r
194 }\r
195 #endif\r
196 \r
197 /* floating-point to integer conversion (rounding) */\r
198 SKP_INLINE void SKP_float2short_array(\r
199     SKP_int16       *out, \r
200     const SKP_float *in, \r
201     SKP_int32       length\r
202\r
203 {\r
204     SKP_int32 k;\r
205     for (k = length-1; k >= 0; k--) {\r
206         out[k] = (SKP_int16)SKP_SAT16( float2int( in[k] ) );\r
207     }\r
208 }\r
209 \r
210 /* integer to floating-point conversion */\r
211 SKP_INLINE void SKP_short2float_array(\r
212     SKP_float       *out, \r
213     const SKP_int16 *in, \r
214     SKP_int32       length\r
215\r
216 {\r
217     SKP_int32 k;\r
218     for (k = length-1; k >= 0; k--) {\r
219         out[k] = (SKP_float)in[k];\r
220     }\r
221 }\r
222 \r
223 #define SKP_round(x)            (SKP_float)((x)>=0 ? (SKP_int64)((x)+0.5) : (SKP_int64)((x)-0.5))\r
224 \r
225 #ifdef  __cplusplus\r
226 }\r
227 #endif\r
228 \r
229 #endif\r