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