removed prefilter
[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, are permitted provided that the following conditions
5 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 Internet Society, IETF or IETF Trust, nor the
12 names of specific contributors, may be used to endorse or promote
13 products derived from this software without specific prior written
14 permission.
15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 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 /* compute autocorrelation */
72 void silk_autocorrelation_FLP(
73     silk_float          *results,           /* O    result (length correlationCount)                            */
74     const silk_float    *inputData,         /* I    input data to correlate                                     */
75     opus_int            inputDataSize,      /* I    length of input                                             */
76     opus_int            correlationCount    /* I    number of correlation taps to compute                       */
77 );
78
79 opus_int silk_pitch_analysis_core_FLP(      /* O    Voicing estimate: 0 voiced, 1 unvoiced                      */
80     const silk_float    *frame,             /* I    Signal of length PE_FRAME_LENGTH_MS*Fs_kHz                  */
81     opus_int            *pitch_out,         /* O    Pitch lag values [nb_subfr]                                 */
82     opus_int16          *lagIndex,          /* O    Lag Index                                                   */
83     opus_int8           *contourIndex,      /* O    Pitch contour Index                                         */
84     silk_float          *LTPCorr,           /* I/O  Normalized correlation; input: value from previous frame    */
85     opus_int            prevLag,            /* I    Last lag of previous frame; set to zero is unvoiced         */
86     const silk_float    search_thres1,      /* I    First stage threshold for lag candidates 0 - 1              */
87     const silk_float    search_thres2,      /* I    Final threshold for lag candidates 0 - 1                    */
88     const opus_int      Fs_kHz,             /* I    sample frequency (kHz)                                      */
89     const opus_int      complexity,         /* I    Complexity setting, 0-2, where 2 is highest                 */
90     const opus_int      nb_subfr,           /* I    Number of 5 ms subframes                                    */
91     int                 arch                /* I    Run-time architecture                                       */
92 );
93
94 void silk_insertion_sort_decreasing_FLP(
95     silk_float          *a,                 /* I/O  Unsorted / Sorted vector                                    */
96     opus_int            *idx,               /* O    Index vector for the sorted elements                        */
97     const opus_int      L,                  /* I    Vector length                                               */
98     const opus_int      K                   /* I    Number of correctly sorted positions                        */
99 );
100
101 /* Compute reflection coefficients from input signal */
102 silk_float silk_burg_modified_FLP(          /* O    returns residual energy                                     */
103     silk_float          A[],                /* O    prediction coefficients (length order)                      */
104     const silk_float    x[],                /* I    input signal, length: nb_subfr*(D+L_sub)                    */
105     const silk_float    minInvGain,         /* I    minimum inverse prediction gain                             */
106     const opus_int      subfr_length,       /* I    input signal subframe length (incl. D preceding samples)    */
107     const opus_int      nb_subfr,           /* I    number of subframes stacked in x                            */
108     const opus_int      D                   /* I    order                                                       */
109 );
110
111 /* multiply a vector by a constant */
112 void silk_scale_vector_FLP(
113     silk_float          *data1,
114     silk_float          gain,
115     opus_int            dataSize
116 );
117
118 /* copy and multiply a vector by a constant */
119 void silk_scale_copy_vector_FLP(
120     silk_float          *data_out,
121     const silk_float    *data_in,
122     silk_float          gain,
123     opus_int            dataSize
124 );
125
126 /* inner product of two silk_float arrays, with result as double */
127 double silk_inner_product_FLP(
128     const silk_float    *data1,
129     const silk_float    *data2,
130     opus_int            dataSize
131 );
132
133 /* sum of squares of a silk_float array, with result as double */
134 double silk_energy_FLP(
135     const silk_float    *data,
136     opus_int            dataSize
137 );
138
139 /********************************************************************/
140 /*                                MACROS                            */
141 /********************************************************************/
142
143 #define PI              (3.1415926536f)
144
145 #define silk_min_float( a, b )                  (((a) < (b)) ? (a) :  (b))
146 #define silk_max_float( a, b )                  (((a) > (b)) ? (a) :  (b))
147 #define silk_abs_float( a )                     ((silk_float)fabs(a))
148
149 /* sigmoid function */
150 static OPUS_INLINE silk_float silk_sigmoid( silk_float x )
151 {
152     return (silk_float)(1.0 / (1.0 + exp(-x)));
153 }
154
155 /* floating-point to integer conversion (rounding) */
156 static OPUS_INLINE opus_int32 silk_float2int( silk_float x )
157 {
158     return (opus_int32)float2int( x );
159 }
160
161 /* floating-point to integer conversion (rounding) */
162 static OPUS_INLINE void silk_float2short_array(
163     opus_int16       *out,
164     const silk_float *in,
165     opus_int32       length
166 )
167 {
168     opus_int32 k;
169     for( k = length - 1; k >= 0; k-- ) {
170         out[k] = silk_SAT16( (opus_int32)float2int( in[k] ) );
171     }
172 }
173
174 /* integer to floating-point conversion */
175 static OPUS_INLINE void silk_short2float_array(
176     silk_float       *out,
177     const opus_int16 *in,
178     opus_int32       length
179 )
180 {
181     opus_int32 k;
182     for( k = length - 1; k >= 0; k-- ) {
183         out[k] = (silk_float)in[k];
184     }
185 }
186
187 /* using log2() helps the fixed-point conversion */
188 static OPUS_INLINE silk_float silk_log2( double x )
189 {
190     return ( silk_float )( 3.32192809488736 * log10( x ) );
191 }
192
193 #ifdef  __cplusplus
194 }
195 #endif
196
197 #endif /* SILK_SIGPROC_FLP_H */