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