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