Remove an unreachable block in silk/float/pitch_analysis_core_FLP.c
[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,                     /* io   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 opus_int silk_LPC_inverse_pred_gain_FLP( /* O:   returns 1 if unstable, otherwise 0    */
54     silk_float            *invGain,      /* O:   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 /* Pitch estimator */
87 #define SigProc_PE_MIN_COMPLEX        0
88 #define SigProc_PE_MID_COMPLEX        1
89 #define SigProc_PE_MAX_COMPLEX        2
90
91 opus_int silk_pitch_analysis_core_FLP(   /* O voicing estimate: 0 voiced, 1 unvoiced                         */
92     const silk_float *signal,            /* I signal of length PE_FRAME_LENGTH_MS*Fs_kHz                     */
93     opus_int         *pitch_out,         /* O 4 pitch lag values                                             */
94     opus_int16       *lagIndex,          /* O lag Index                                                      */
95     opus_int8        *contourIndex,      /* O pitch contour Index                                            */
96     silk_float       *LTPCorr,           /* I/O normalized correlation; input: value from previous frame     */
97     opus_int         prevLag,            /* I last lag of previous frame; set to zero is unvoiced            */
98     const silk_float search_thres1,      /* I first stage threshold for lag candidates 0 - 1                 */
99     const silk_float search_thres2,      /* I final threshold for lag candidates 0 - 1                       */
100     const opus_int   Fs_kHz,             /* I sample frequency (kHz)                                         */
101     const opus_int   complexity,         /* I Complexity setting, 0-2, where 2 is highest                    */
102     const opus_int   nb_subfr            /* I    number of 5 ms subframes                                    */
103 );
104
105 #define PI               (3.1415926536f)
106
107 void silk_insertion_sort_decreasing_FLP(
108     silk_float            *a,            /* I/O:  Unsorted / Sorted vector                */
109     opus_int              *idx,          /* O:    Index vector for the sorted elements    */
110     const opus_int        L,             /* I:    Vector length                           */
111     const opus_int        K              /* I:    Number of correctly sorted positions    */
112 );
113
114 /* Compute reflection coefficients from input signal */
115 silk_float silk_burg_modified_FLP(           /* O    returns residual energy                                         */
116     silk_float           A[],                /* O    prediction coefficients (length order)                          */
117     const silk_float     x[],                /* I    input signal, length: nb_subfr*(D+L_sub)                        */
118     const opus_int       subfr_length,       /* I    input signal subframe length (including D preceeding samples)   */
119     const opus_int       nb_subfr,           /* I    number of subframes stacked in x                                */
120     const silk_float     WhiteNoiseFrac,     /* I    fraction added to zero-lag autocorrelation                      */
121     const opus_int       D                   /* I    order                                                           */
122 );
123
124 /* multiply a vector by a constant */
125 void silk_scale_vector_FLP(
126     silk_float           *data1,
127     silk_float           gain,
128     opus_int             dataSize
129 );
130
131 /* copy and multiply a vector by a constant */
132 void silk_scale_copy_vector_FLP(
133     silk_float           *data_out,
134     const silk_float     *data_in,
135     silk_float           gain,
136     opus_int             dataSize
137 );
138
139 /* inner product of two silk_float arrays, with result as double */
140 double silk_inner_product_FLP(
141     const silk_float     *data1,
142     const silk_float     *data2,
143     opus_int             dataSize
144 );
145
146 /* sum of squares of a silk_float array, with result as double */
147 double silk_energy_FLP(
148     const silk_float     *data,
149     opus_int             dataSize
150 );
151
152 /********************************************************************/
153 /*                                MACROS                                */
154 /********************************************************************/
155
156 #define silk_min_float(a, b)            (((a) < (b)) ? (a) :  (b))
157 #define silk_max_float(a, b)            (((a) > (b)) ? (a) :  (b))
158 #define silk_abs_float(a)            ((silk_float)fabs(a))
159
160 #define silk_LIMIT_float( a, limit1, limit2)    ((limit1) > (limit2) ? ((a) > (limit1) ? (limit1) : ((a) < (limit2) ? (limit2) : (a))) \
161                                                                  : ((a) > (limit2) ? (limit2) : ((a) < (limit1) ? (limit1) : (a))))
162
163 /* sigmoid function */
164 static inline silk_float silk_sigmoid(silk_float x)
165 {
166     return (silk_float)(1.0 / (1.0 + exp(-x)));
167 }
168
169 /* floating-point to integer conversion (rounding) */
170 static inline opus_int32 silk_float2int(double x)
171 {
172 #ifdef _WIN32
173     double t = x + 6755399441055744.0;
174     return *((opus_int32 *)( &t ));
175 #else
176     return (opus_int32)( ( x > 0 ) ? x + 0.5 : x - 0.5 );
177 #endif
178 }
179
180 /* floating-point to integer conversion (rounding) */
181 static inline void silk_float2short_array(
182     opus_int16       *out,
183     const silk_float *in,
184     opus_int32       length
185 )
186 {
187     opus_int32 k;
188     for (k = length-1; k >= 0; k--) {
189 #ifdef _WIN32
190         double t = in[k] + 6755399441055744.0;
191         out[k] = (opus_int16)silk_SAT16(*(( opus_int32 * )( &t )));
192 #else
193         double x = in[k];
194         out[k] = (opus_int16)silk_SAT16( ( x > 0 ) ? x + 0.5 : x - 0.5 );
195 #endif
196     }
197 }
198
199 /* integer to floating-point conversion */
200 static inline void silk_short2float_array(
201     silk_float       *out,
202     const opus_int16 *in,
203     opus_int32       length
204 )
205 {
206     opus_int32 k;
207     for (k = length-1; k >= 0; k--) {
208         out[k] = (silk_float)in[k];
209     }
210 }
211
212 /* using log2() helps the fixed-point conversion */
213 static inline silk_float silk_log2( double x ) { return ( silk_float )( 3.32192809488736 * log10( x ) ); }
214
215 #ifdef  __cplusplus
216 }
217 #endif
218
219 #endif