Squashed commit of the following:
[opus.git] / silk / float / SKP_Silk_pitch_analysis_core_FLP.c
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 /*****************************************************************************\r
29 *\r
30 * Pitch analyser function\r
31 *\r
32 ******************************************************************************/\r
33 #include "SKP_Silk_SigProc_FLP.h"\r
34 #include "SKP_Silk_SigProc_FIX.h"\r
35 #include "SKP_Silk_pitch_est_defines.h"\r
36 \r
37 #define SCRATCH_SIZE    22\r
38 \r
39 /************************************************************/\r
40 /* Definitions                                              */\r
41 /************************************************************/\r
42 #define eps                     1.192092896e-07f\r
43 \r
44 /* using log2() helps the fixed-point conversion */\r
45 SKP_INLINE SKP_float SKP_P_log2(double x) { return (SKP_float)(3.32192809488736 * log10(x)); }\r
46 \r
47 /************************************************************/\r
48 /* Internally used functions                                */\r
49 /************************************************************/\r
50 static void SKP_P_Ana_calc_corr_st3(\r
51     SKP_float cross_corr_st3[ PE_MAX_NB_SUBFR ][ PE_NB_CBKS_STAGE3_MAX ][ PE_NB_STAGE3_LAGS ], /* O 3 DIM correlation array */\r
52     const SKP_float signal[],           /* I vector to correlate                                            */\r
53     SKP_int         start_lag,          /* I start lag                                                      */\r
54     SKP_int         sf_length,          /* I sub frame length                                               */\r
55     SKP_int         nb_subfr,           /* I number of subframes                                            */\r
56     SKP_int         complexity          /* I Complexity setting                                             */\r
57 );\r
58 \r
59 static void SKP_P_Ana_calc_energy_st3(\r
60     SKP_float energies_st3[ PE_MAX_NB_SUBFR ][ PE_NB_CBKS_STAGE3_MAX ][ PE_NB_STAGE3_LAGS ], /* O 3 DIM correlation array */\r
61     const SKP_float signal[],           /* I vector to correlate                                            */\r
62     SKP_int         start_lag,          /* I start lag                                                      */\r
63     SKP_int         sf_length,          /* I sub frame length                                               */\r
64     SKP_int         nb_subfr,           /* I number of subframes                                            */\r
65     SKP_int         complexity          /* I Complexity setting                                             */\r
66 );\r
67 \r
68 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
69 //%             CORE PITCH ANALYSIS FUNCTION                %\r
70 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%\r
71 SKP_int SKP_Silk_pitch_analysis_core_FLP( /* O voicing estimate: 0 voiced, 1 unvoiced                       */\r
72     const SKP_float *signal,            /* I signal of length PE_FRAME_LENGTH_MS*Fs_kHz                     */\r
73     SKP_int         *pitch_out,         /* O 4 pitch lag values                                             */\r
74     SKP_int16        *lagIndex,         /* O lag Index                                                      */\r
75     SKP_int8        *contourIndex,      /* O pitch contour Index                                            */\r
76     SKP_float       *LTPCorr,           /* I/O normalized correlation; input: value from previous frame     */\r
77     SKP_int         prevLag,            /* I last lag of previous frame; set to zero is unvoiced            */\r
78     const SKP_float search_thres1,      /* I first stage threshold for lag candidates 0 - 1                 */\r
79     const SKP_float search_thres2,      /* I final threshold for lag candidates 0 - 1                       */\r
80     const SKP_int   Fs_kHz,             /* I sample frequency (kHz)                                         */\r
81     const SKP_int   complexity,         /* I Complexity setting, 0-2, where 2 is highest                    */\r
82     const SKP_int   nb_subfr            /* I    number of 5 ms subframes                                    */\r
83 )\r
84 {\r
85     SKP_int   i, k, d, j;\r
86     SKP_float signal_8kHz[  PE_MAX_FRAME_LENGTH_MS * 8 ];\r
87     SKP_float signal_4kHz[  PE_MAX_FRAME_LENGTH_MS * 4 ];\r
88     SKP_int16 signal_8_FIX[ PE_MAX_FRAME_LENGTH_MS * 8 ];\r
89     SKP_int16 signal_4_FIX[ PE_MAX_FRAME_LENGTH_MS * 4 ];\r
90     SKP_int32 filt_state[ 6 ];\r
91     SKP_float threshold, contour_bias;\r
92     SKP_float C[ PE_MAX_NB_SUBFR][ (PE_MAX_LAG >> 1) + 5 ];\r
93     SKP_float CC[ PE_NB_CBKS_STAGE2_EXT ];\r
94     const SKP_float *target_ptr, *basis_ptr;\r
95     double    cross_corr, normalizer, energy, energy_tmp;\r
96     SKP_int   d_srch[ PE_D_SRCH_LENGTH ];\r
97     SKP_int16 d_comp[ (PE_MAX_LAG >> 1) + 5 ];\r
98     SKP_int   length_d_srch, length_d_comp;\r
99     SKP_float Cmax, CCmax, CCmax_b, CCmax_new_b, CCmax_new;\r
100     SKP_int   CBimax, CBimax_new, lag, start_lag, end_lag, lag_new;\r
101     SKP_int   cbk_size;\r
102     SKP_float lag_log2, prevLag_log2, delta_lag_log2_sqr;\r
103     SKP_float energies_st3[ PE_MAX_NB_SUBFR ][ PE_NB_CBKS_STAGE3_MAX ][ PE_NB_STAGE3_LAGS ];\r
104     SKP_float cross_corr_st3[ PE_MAX_NB_SUBFR ][ PE_NB_CBKS_STAGE3_MAX ][ PE_NB_STAGE3_LAGS ];\r
105     SKP_int   lag_counter;\r
106     SKP_int   frame_length, frame_length_8kHz, frame_length_4kHz;\r
107     SKP_int   sf_length, sf_length_8kHz, sf_length_4kHz;\r
108     SKP_int   min_lag, min_lag_8kHz, min_lag_4kHz;\r
109     SKP_int   max_lag, max_lag_8kHz, max_lag_4kHz;\r
110     SKP_int   nb_cbk_search;\r
111     const SKP_int8 *Lag_CB_ptr;\r
112 \r
113     /* Check for valid sampling frequency */\r
114     SKP_assert( Fs_kHz == 8 || Fs_kHz == 12 || Fs_kHz == 16 );\r
115 \r
116     /* Check for valid complexity setting */\r
117     SKP_assert( complexity >= SigProc_PE_MIN_COMPLEX );\r
118     SKP_assert( complexity <= SigProc_PE_MAX_COMPLEX );\r
119 \r
120     SKP_assert( search_thres1 >= 0.0f && search_thres1 <= 1.0f );\r
121     SKP_assert( search_thres2 >= 0.0f && search_thres2 <= 1.0f );\r
122 \r
123     /* Setup frame lengths max / min lag for the sampling frequency */\r
124     frame_length      = ( PE_LTP_MEM_LENGTH_MS + nb_subfr * PE_SUBFR_LENGTH_MS ) * Fs_kHz;\r
125     frame_length_4kHz = ( PE_LTP_MEM_LENGTH_MS + nb_subfr * PE_SUBFR_LENGTH_MS ) * 4;\r
126     frame_length_8kHz = ( PE_LTP_MEM_LENGTH_MS + nb_subfr * PE_SUBFR_LENGTH_MS ) * 8;\r
127     sf_length         = PE_SUBFR_LENGTH_MS * Fs_kHz;\r
128     sf_length_4kHz    = PE_SUBFR_LENGTH_MS * 4;\r
129     sf_length_8kHz    = PE_SUBFR_LENGTH_MS * 8;\r
130     min_lag           = PE_MIN_LAG_MS * Fs_kHz;\r
131     min_lag_4kHz      = PE_MIN_LAG_MS * 4;\r
132     min_lag_8kHz      = PE_MIN_LAG_MS * 8;\r
133     max_lag           = PE_MAX_LAG_MS * Fs_kHz - 1;\r
134     max_lag_4kHz      = PE_MAX_LAG_MS * 4;\r
135     max_lag_8kHz      = PE_MAX_LAG_MS * 8 - 1;\r
136 \r
137     SKP_memset(C, 0, sizeof(SKP_float) * nb_subfr * ((PE_MAX_LAG >> 1) + 5));\r
138     \r
139     /* Resample from input sampled at Fs_kHz to 8 kHz */\r
140     if( Fs_kHz == 16 ) {\r
141         /* Resample to 16 -> 8 khz */\r
142         SKP_int16 signal_16_FIX[ 16 * PE_MAX_FRAME_LENGTH_MS ];\r
143         SKP_float2short_array( signal_16_FIX, signal, frame_length );\r
144         SKP_memset( filt_state, 0, 2 * sizeof( SKP_int32 ) );\r
145         SKP_Silk_resampler_down2( filt_state, signal_8_FIX, signal_16_FIX, frame_length );\r
146         SKP_short2float_array( signal_8kHz, signal_8_FIX, frame_length_8kHz );\r
147     } else if( Fs_kHz == 12 ) {\r
148         /* Resample to 12 -> 8 khz */\r
149         SKP_int16 signal_12_FIX[ 12 * PE_MAX_FRAME_LENGTH_MS ];\r
150         SKP_float2short_array( signal_12_FIX, signal, frame_length );\r
151         SKP_memset( filt_state, 0, 6 * sizeof( SKP_int32 ) );\r
152         SKP_Silk_resampler_down2_3( filt_state, signal_8_FIX, signal_12_FIX, frame_length );\r
153         SKP_short2float_array( signal_8kHz, signal_8_FIX, frame_length_8kHz );\r
154     } else {\r
155         SKP_assert( Fs_kHz == 8 );\r
156         SKP_float2short_array( signal_8_FIX, signal, frame_length_8kHz );\r
157     }\r
158 \r
159     /* Decimate again to 4 kHz */\r
160     SKP_memset( filt_state, 0, 2 * sizeof( SKP_int32 ) );\r
161     SKP_Silk_resampler_down2( filt_state, signal_4_FIX, signal_8_FIX, frame_length_8kHz );\r
162     SKP_short2float_array( signal_4kHz, signal_4_FIX, frame_length_4kHz );\r
163 \r
164     /* Low-pass filter */\r
165     for( i = frame_length_4kHz - 1; i > 0; i-- ) {\r
166         signal_4kHz[ i ] += signal_4kHz[ i - 1 ];\r
167     }\r
168 \r
169     /******************************************************************************\r
170     * FIRST STAGE, operating in 4 khz\r
171     ******************************************************************************/\r
172     target_ptr = &signal_4kHz[ SKP_LSHIFT( sf_length_4kHz, 2 ) ];\r
173     for( k = 0; k < nb_subfr >> 1; k++ ) {\r
174         /* Check that we are within range of the array */\r
175         SKP_assert( target_ptr >= signal_4kHz );\r
176         SKP_assert( target_ptr + sf_length_8kHz <= signal_4kHz + frame_length_4kHz );\r
177 \r
178         basis_ptr = target_ptr - min_lag_4kHz;\r
179 \r
180         /* Check that we are within range of the array */\r
181         SKP_assert( basis_ptr >= signal_4kHz );\r
182         SKP_assert( basis_ptr + sf_length_8kHz <= signal_4kHz + frame_length_4kHz );\r
183 \r
184         /* Calculate first vector products before loop */\r
185         cross_corr = SKP_Silk_inner_product_FLP( target_ptr, basis_ptr, sf_length_8kHz );\r
186         normalizer = SKP_Silk_energy_FLP( basis_ptr, sf_length_8kHz ) + sf_length_8kHz * 4000.0f;\r
187 \r
188         C[ 0 ][ min_lag_4kHz ] += (SKP_float)(cross_corr / sqrt(normalizer));\r
189 \r
190         /* From now on normalizer is computed recursively */\r
191         for(d = min_lag_4kHz + 1; d <= max_lag_4kHz; d++) {\r
192             basis_ptr--;\r
193 \r
194             /* Check that we are within range of the array */\r
195             SKP_assert( basis_ptr >= signal_4kHz );\r
196             SKP_assert( basis_ptr + sf_length_8kHz <= signal_4kHz + frame_length_4kHz );\r
197 \r
198             cross_corr = SKP_Silk_inner_product_FLP(target_ptr, basis_ptr, sf_length_8kHz);\r
199 \r
200             /* Add contribution of new sample and remove contribution from oldest sample */\r
201             normalizer +=\r
202                 basis_ptr[ 0 ] * basis_ptr[ 0 ] - \r
203                 basis_ptr[ sf_length_8kHz ] * basis_ptr[ sf_length_8kHz ];\r
204             C[ 0 ][ d ] += (SKP_float)(cross_corr / sqrt( normalizer ));\r
205         }\r
206         /* Update target pointer */\r
207         target_ptr += sf_length_8kHz;\r
208     }\r
209 \r
210     /* Apply short-lag bias */\r
211     for( i = max_lag_4kHz; i >= min_lag_4kHz; i-- ) {\r
212         C[ 0 ][ i ] -= C[ 0 ][ i ] * i / 4096.0f;\r
213     }\r
214 \r
215     /* Sort */\r
216     length_d_srch = 4 + 2 * complexity;\r
217     SKP_assert( 3 * length_d_srch <= PE_D_SRCH_LENGTH );\r
218     SKP_Silk_insertion_sort_decreasing_FLP( &C[ 0 ][ min_lag_4kHz ], d_srch, max_lag_4kHz - min_lag_4kHz + 1, length_d_srch );\r
219 \r
220     /* Escape if correlation is very low already here */\r
221     Cmax = C[ 0 ][ min_lag_4kHz ];\r
222     target_ptr = &signal_4kHz[ SKP_SMULBB( sf_length_4kHz, nb_subfr ) ];\r
223     energy = 1000.0f;\r
224     for( i = 0; i < SKP_LSHIFT( sf_length_4kHz, 2 ); i++ ) {\r
225         energy += target_ptr[i] * target_ptr[i];\r
226     }\r
227     threshold = Cmax * Cmax; \r
228     if( energy / 16.0f > threshold ) {\r
229         SKP_memset( pitch_out, 0, nb_subfr * sizeof( SKP_int ) );\r
230         *LTPCorr      = 0.0f;\r
231         *lagIndex     = 0;\r
232         *contourIndex = 0;\r
233         return 1;\r
234     }\r
235 \r
236     threshold = search_thres1 * Cmax;\r
237     for( i = 0; i < length_d_srch; i++ ) {\r
238         /* Convert to 8 kHz indices for the sorted correlation that exceeds the threshold */\r
239         if( C[ 0 ][ min_lag_4kHz + i ] > threshold ) {\r
240             d_srch[ i ] = SKP_LSHIFT( d_srch[ i ] + min_lag_4kHz, 1 );\r
241         } else {\r
242             length_d_srch = i;\r
243             break;\r
244         }\r
245     }\r
246     SKP_assert( length_d_srch > 0 );\r
247 \r
248     for( i = min_lag_8kHz - 5; i < max_lag_8kHz + 5; i++ ) {\r
249         d_comp[ i ] = 0;\r
250     }\r
251     for( i = 0; i < length_d_srch; i++ ) {\r
252         d_comp[ d_srch[ i ] ] = 1;\r
253     }\r
254 \r
255     /* Convolution */\r
256     for( i = max_lag_8kHz + 3; i >= min_lag_8kHz; i-- ) {\r
257         d_comp[ i ] += d_comp[ i - 1 ] + d_comp[ i - 2 ];\r
258     }\r
259 \r
260     length_d_srch = 0;\r
261     for( i = min_lag_8kHz; i < max_lag_8kHz + 1; i++ ) {    \r
262         if( d_comp[ i + 1 ] > 0 ) {\r
263             d_srch[ length_d_srch ] = i;\r
264             length_d_srch++;\r
265         }\r
266     }\r
267 \r
268     /* Convolution */\r
269     for( i = max_lag_8kHz + 3; i >= min_lag_8kHz; i-- ) {\r
270         d_comp[ i ] += d_comp[ i - 1 ] + d_comp[ i - 2 ] + d_comp[ i - 3 ];\r
271     }\r
272 \r
273     length_d_comp = 0;\r
274     for( i = min_lag_8kHz; i < max_lag_8kHz + 4; i++ ) {    \r
275         if( d_comp[ i ] > 0 ) {\r
276             d_comp[ length_d_comp ] = i - 2;\r
277             length_d_comp++;\r
278         }\r
279     }\r
280 \r
281     /**********************************************************************************\r
282     ** SECOND STAGE, operating at 8 kHz, on lag sections with high correlation\r
283     *************************************************************************************/\r
284     /********************************************************************************* \r
285     * Find energy of each subframe projected onto its history, for a range of delays\r
286     *********************************************************************************/\r
287     SKP_memset( C, 0, PE_MAX_NB_SUBFR*((PE_MAX_LAG >> 1) + 5) * sizeof(SKP_float)); // Is this needed?\r
288     \r
289     if( Fs_kHz == 8 ) {\r
290         target_ptr = &signal[ PE_LTP_MEM_LENGTH_MS * 8 ];\r
291     } else {\r
292         target_ptr = &signal_8kHz[ PE_LTP_MEM_LENGTH_MS * 8 ];\r
293     }\r
294     for( k = 0; k < nb_subfr; k++ ) {\r
295         energy_tmp = SKP_Silk_energy_FLP( target_ptr, sf_length_8kHz );\r
296         for( j = 0; j < length_d_comp; j++ ) {\r
297             d = d_comp[ j ];\r
298             basis_ptr = target_ptr - d;\r
299             cross_corr = SKP_Silk_inner_product_FLP( basis_ptr, target_ptr, sf_length_8kHz );\r
300             energy     = SKP_Silk_energy_FLP( basis_ptr, sf_length_8kHz );\r
301             if (cross_corr > 0.0f) {\r
302                 C[ k ][ d ] = (SKP_float)(cross_corr * cross_corr / (energy * energy_tmp + eps));\r
303             } else {\r
304                 C[ k ][ d ] = 0.0f;\r
305             }\r
306         }\r
307         target_ptr += sf_length_8kHz;\r
308     }\r
309 \r
310     /* search over lag range and lags codebook */\r
311     /* scale factor for lag codebook, as a function of center lag */\r
312 \r
313     CCmax   = 0.0f; /* This value doesn't matter */\r
314     CCmax_b = -1000.0f;\r
315 \r
316     CBimax = 0; /* To avoid returning undefined lag values */\r
317     lag = -1;   /* To check if lag with strong enough correlation has been found */\r
318 \r
319     if( prevLag > 0 ) {\r
320         if( Fs_kHz == 12 ) {\r
321             prevLag = SKP_LSHIFT( prevLag, 1 ) / 3;\r
322         } else if( Fs_kHz == 16 ) {\r
323             prevLag = SKP_RSHIFT( prevLag, 1 );\r
324         }\r
325         prevLag_log2 = SKP_P_log2((SKP_float)prevLag);\r
326     } else {\r
327         prevLag_log2 = 0;\r
328     }\r
329 \r
330     /* Setup stage 2 codebook based on number of subframes */\r
331     if( nb_subfr == PE_MAX_NB_SUBFR ) {\r
332         cbk_size   = PE_NB_CBKS_STAGE2_EXT;\r
333         Lag_CB_ptr = &SKP_Silk_CB_lags_stage2[ 0 ][ 0 ];\r
334         if( Fs_kHz == 8 && complexity > SigProc_PE_MIN_COMPLEX ) {\r
335             /* If input is 8 khz use a larger codebook here because it is last stage */\r
336             nb_cbk_search = PE_NB_CBKS_STAGE2_EXT;\r
337         } else {\r
338             nb_cbk_search = PE_NB_CBKS_STAGE2;\r
339         }\r
340     } else {\r
341         cbk_size       = PE_NB_CBKS_STAGE2_10MS;\r
342         Lag_CB_ptr     = &SKP_Silk_CB_lags_stage2_10_ms[ 0 ][ 0 ];\r
343         nb_cbk_search  = PE_NB_CBKS_STAGE2_10MS;\r
344     }\r
345 \r
346     for( k = 0; k < length_d_srch; k++ ) {\r
347         d = d_srch[ k ];\r
348         for( j = 0; j < nb_cbk_search; j++ ) {\r
349             CC[j] = 0.0f;\r
350             for( i = 0; i < nb_subfr; i++ ) {\r
351                 /* Try all codebooks */\r
352                 CC[ j ] += C[ i ][ d + matrix_ptr( Lag_CB_ptr, i, j, cbk_size )];\r
353             }\r
354         }\r
355         /* Find best codebook */\r
356         CCmax_new  = -1000.0f;\r
357         CBimax_new = 0;\r
358         for( i = 0; i < nb_cbk_search; i++ ) {\r
359             if( CC[ i ] > CCmax_new ) {\r
360                 CCmax_new = CC[ i ];\r
361                 CBimax_new = i;\r
362             }\r
363         }\r
364         CCmax_new = SKP_max_float(CCmax_new, 0.0f); /* To avoid taking square root of negative number later */\r
365         CCmax_new_b = CCmax_new;\r
366 \r
367         /* Bias towards shorter lags */\r
368         lag_log2 = SKP_P_log2((SKP_float)d);\r
369         CCmax_new_b -= PE_SHORTLAG_BIAS * nb_subfr * lag_log2;\r
370 \r
371         /* Bias towards previous lag */\r
372         if ( prevLag > 0 ) {\r
373             delta_lag_log2_sqr = lag_log2 - prevLag_log2;\r
374             delta_lag_log2_sqr *= delta_lag_log2_sqr;\r
375             CCmax_new_b -= PE_PREVLAG_BIAS * nb_subfr * (*LTPCorr) * delta_lag_log2_sqr / (delta_lag_log2_sqr + 0.5f);\r
376         }\r
377 \r
378         if ( CCmax_new_b > CCmax_b                                      && /* Find maximum biased correlation                  */\r
379              CCmax_new > nb_subfr * search_thres2 * search_thres2       && /* Correlation needs to be high enough to be voiced */\r
380              SKP_Silk_CB_lags_stage2[ 0 ][ CBimax_new ] <= min_lag_8kHz    /* Lag must be in range                             */\r
381             ) {\r
382             CCmax_b = CCmax_new_b;\r
383             CCmax   = CCmax_new;\r
384             lag     = d;\r
385             CBimax  = CBimax_new;\r
386         }\r
387     }\r
388 \r
389     if( lag == -1 ) {\r
390         /* No suitable candidate found */\r
391         SKP_memset( pitch_out, 0, PE_MAX_NB_SUBFR * sizeof(SKP_int) );\r
392         *LTPCorr      = 0.0f;\r
393         *lagIndex     = 0;\r
394         *contourIndex = 0;\r
395         return 1;\r
396     }\r
397 \r
398     if( Fs_kHz > 8 ) {\r
399         /* Search in original signal */\r
400 \r
401         /* Compensate for decimation */\r
402         SKP_assert( lag == SKP_SAT16( lag ) );\r
403         if( Fs_kHz == 12 ) {\r
404             lag = SKP_RSHIFT_ROUND( SKP_SMULBB( lag, 3 ), 1 );\r
405         } else if( Fs_kHz == 16 ) {\r
406             lag = SKP_LSHIFT( lag, 1 );\r
407         } else {\r
408             lag = SKP_SMULBB( lag, 3 );\r
409         }\r
410 \r
411         lag = SKP_LIMIT_int( lag, min_lag, max_lag );\r
412         start_lag = SKP_max_int( lag - 2, min_lag );\r
413         end_lag   = SKP_min_int( lag + 2, max_lag );\r
414         lag_new   = lag;                                    /* to avoid undefined lag */\r
415         CBimax    = 0;                                      /* to avoid undefined lag */\r
416         SKP_assert( CCmax >= 0.0f ); \r
417         *LTPCorr = (SKP_float)sqrt( CCmax / nb_subfr );     /* Output normalized correlation */\r
418 \r
419         CCmax = -1000.0f;\r
420 \r
421         /* Calculate the correlations and energies needed in stage 3 */\r
422         SKP_P_Ana_calc_corr_st3( cross_corr_st3, signal, start_lag, sf_length, nb_subfr, complexity );\r
423         SKP_P_Ana_calc_energy_st3( energies_st3, signal, start_lag, sf_length, nb_subfr, complexity );\r
424 \r
425         lag_counter = 0;\r
426         SKP_assert( lag == SKP_SAT16( lag ) );\r
427         contour_bias = PE_FLATCONTOUR_BIAS / lag;\r
428 \r
429         /* Setup cbk parameters acording to complexity setting and frame length */\r
430         if( nb_subfr == PE_MAX_NB_SUBFR ) {\r
431             nb_cbk_search = (SKP_int)SKP_Silk_nb_cbk_searchs_stage3[ complexity ];\r
432             cbk_size      = PE_NB_CBKS_STAGE3_MAX;\r
433             Lag_CB_ptr    = &SKP_Silk_CB_lags_stage3[ 0 ][ 0 ];\r
434         } else {\r
435             nb_cbk_search = PE_NB_CBKS_STAGE3_10MS;\r
436             cbk_size      = PE_NB_CBKS_STAGE3_10MS;\r
437             Lag_CB_ptr    = &SKP_Silk_CB_lags_stage3_10_ms[ 0 ][ 0 ];\r
438         }\r
439 \r
440         for( d = start_lag; d <= end_lag; d++ ) {\r
441             for( j = 0; j < nb_cbk_search; j++ ) {\r
442                 cross_corr = 0.0;\r
443                 energy = eps;\r
444                 for( k = 0; k < nb_subfr; k++ ) {\r
445                     energy     +=   energies_st3[ k ][ j ][ lag_counter ];\r
446                     cross_corr += cross_corr_st3[ k ][ j ][ lag_counter ];\r
447                 }\r
448                 if( cross_corr > 0.0 ) {\r
449                     CCmax_new = (SKP_float)(cross_corr * cross_corr / energy);\r
450                     /* Reduce depending on flatness of contour */\r
451                     CCmax_new *= 1.0f - contour_bias * j;\r
452                 } else {\r
453                     CCmax_new = 0.0f;               \r
454                 }\r
455 \r
456                 if( CCmax_new > CCmax &&\r
457                    ( d + (SKP_int)SKP_Silk_CB_lags_stage3[ 0 ][ j ] ) <= max_lag  \r
458                    ) {\r
459                     CCmax   = CCmax_new;\r
460                     lag_new = d;\r
461                     CBimax  = j;\r
462                 }\r
463             }\r
464             lag_counter++;\r
465         }\r
466 \r
467         for( k = 0; k < nb_subfr; k++ ) {\r
468             pitch_out[ k ] = lag_new + matrix_ptr( Lag_CB_ptr, k, CBimax, cbk_size );\r
469         }\r
470         *lagIndex = (SKP_int16)( lag_new - min_lag );\r
471         *contourIndex = (SKP_int8)CBimax;\r
472     } else {\r
473         /* Save Lags and correlation */\r
474         SKP_assert( CCmax >= 0.0f );\r
475         *LTPCorr = (SKP_float)sqrt( CCmax / nb_subfr ); /* Output normalized correlation */\r
476         for( k = 0; k < nb_subfr; k++ ) {\r
477             pitch_out[ k ] = lag + matrix_ptr( Lag_CB_ptr, k, CBimax, cbk_size );\r
478         }\r
479         *lagIndex = (SKP_int16)( lag - min_lag );\r
480         *contourIndex = (SKP_int8)CBimax;\r
481     }\r
482     SKP_assert( *lagIndex >= 0 );\r
483     /* return as voiced */\r
484     return 0;\r
485 }\r
486 \r
487 static void SKP_P_Ana_calc_corr_st3(\r
488     SKP_float cross_corr_st3[ PE_MAX_NB_SUBFR ][ PE_NB_CBKS_STAGE3_MAX ][ PE_NB_STAGE3_LAGS ], /* O 3 DIM correlation array */\r
489     const SKP_float signal[],           /* I vector to correlate                                            */\r
490     SKP_int         start_lag,          /* I start lag                                                      */\r
491     SKP_int         sf_length,          /* I sub frame length                                               */\r
492     SKP_int         nb_subfr,           /* I number of subframes                                            */\r
493     SKP_int         complexity          /* I Complexity setting                                             */\r
494 )\r
495     /***********************************************************************\r
496      Calculates the correlations used in stage 3 search. In order to cover \r
497      the whole lag codebook for all the searched offset lags (lag +- 2), \r
498      the following correlations are needed in each sub frame:\r
499 \r
500      sf1: lag range [-8,...,7] total 16 correlations\r
501      sf2: lag range [-4,...,4] total 9 correlations\r
502      sf3: lag range [-3,....4] total 8 correltions\r
503      sf4: lag range [-6,....8] total 15 correlations\r
504 \r
505      In total 48 correlations. The direct implementation computed in worst case \r
506      4*12*5 = 240 correlations, but more likely around 120. \r
507      **********************************************************************/\r
508 {\r
509     const SKP_float *target_ptr, *basis_ptr;\r
510     SKP_int   i, j, k, lag_counter, lag_low, lag_high;\r
511     SKP_int   nb_cbk_search, delta, idx, cbk_size;\r
512     SKP_float scratch_mem[ SCRATCH_SIZE ];\r
513     const SKP_int8 *Lag_range_ptr, *Lag_CB_ptr;\r
514 \r
515     SKP_assert( complexity >= SigProc_PE_MIN_COMPLEX );\r
516     SKP_assert( complexity <= SigProc_PE_MAX_COMPLEX );\r
517 \r
518     if( nb_subfr == PE_MAX_NB_SUBFR ){\r
519         Lag_range_ptr = &SKP_Silk_Lag_range_stage3[ complexity ][ 0 ][ 0 ];\r
520         Lag_CB_ptr    = &SKP_Silk_CB_lags_stage3[ 0 ][ 0 ];\r
521         nb_cbk_search = SKP_Silk_nb_cbk_searchs_stage3[ complexity ];\r
522         cbk_size      = PE_NB_CBKS_STAGE3_MAX;\r
523     } else {\r
524         SKP_assert( nb_subfr == PE_MAX_NB_SUBFR >> 1);\r
525         Lag_range_ptr = &SKP_Silk_Lag_range_stage3_10_ms[ 0 ][ 0 ];\r
526         Lag_CB_ptr    = &SKP_Silk_CB_lags_stage3_10_ms[ 0 ][ 0 ];\r
527         nb_cbk_search = PE_NB_CBKS_STAGE3_10MS;\r
528         cbk_size      = PE_NB_CBKS_STAGE3_10MS;\r
529     }\r
530 \r
531     target_ptr = &signal[ SKP_LSHIFT( sf_length, 2 ) ]; /* Pointer to middle of frame */\r
532     for( k = 0; k < nb_subfr; k++ ) {\r
533         lag_counter = 0;\r
534 \r
535         /* Calculate the correlations for each subframe */\r
536         lag_low  = matrix_ptr( Lag_range_ptr, k, 0, 2 );\r
537         lag_high = matrix_ptr( Lag_range_ptr, k, 1, 2 );\r
538         for( j = lag_low; j <= lag_high; j++ ) {\r
539             basis_ptr = target_ptr - ( start_lag + j );\r
540             SKP_assert( lag_counter < SCRATCH_SIZE );\r
541             scratch_mem[ lag_counter ] = (SKP_float)SKP_Silk_inner_product_FLP( target_ptr, basis_ptr, sf_length );\r
542             lag_counter++;\r
543         }\r
544 \r
545         delta = matrix_ptr( Lag_range_ptr, k, 0, 2 );\r
546         for( i = 0; i < nb_cbk_search; i++ ) { \r
547             /* Fill out the 3 dim array that stores the correlations for */\r
548             /* each code_book vector for each start lag */\r
549             idx = matrix_ptr( Lag_CB_ptr, k, i, cbk_size ) - delta;\r
550             for( j = 0; j < PE_NB_STAGE3_LAGS; j++ ) {\r
551                 SKP_assert( idx + j < SCRATCH_SIZE );\r
552                 SKP_assert( idx + j < lag_counter );\r
553                 cross_corr_st3[ k ][ i ][ j ] = scratch_mem[ idx + j ];\r
554             }\r
555         }\r
556         target_ptr += sf_length;\r
557     }\r
558 }\r
559 \r
560 static void SKP_P_Ana_calc_energy_st3(\r
561     SKP_float energies_st3[ PE_MAX_NB_SUBFR ][ PE_NB_CBKS_STAGE3_MAX ][ PE_NB_STAGE3_LAGS ], /* O 3 DIM correlation array */\r
562     const SKP_float signal[],           /* I vector to correlate                                            */\r
563     SKP_int         start_lag,          /* I start lag                                                      */\r
564     SKP_int         sf_length,          /* I sub frame length                                               */\r
565     SKP_int         nb_subfr,           /* I number of subframes                                            */\r
566     SKP_int         complexity          /* I Complexity setting                                             */\r
567 )\r
568 /****************************************************************\r
569 Calculate the energies for first two subframes. The energies are\r
570 calculated recursively. \r
571 ****************************************************************/\r
572 {\r
573     const SKP_float *target_ptr, *basis_ptr;\r
574     double    energy;\r
575     SKP_int   k, i, j, lag_counter;\r
576     SKP_int   nb_cbk_search, delta, idx, cbk_size, lag_diff;\r
577     SKP_float scratch_mem[ SCRATCH_SIZE ];\r
578     const SKP_int8 *Lag_range_ptr, *Lag_CB_ptr;\r
579 \r
580     SKP_assert( complexity >= SigProc_PE_MIN_COMPLEX );\r
581     SKP_assert( complexity <= SigProc_PE_MAX_COMPLEX );\r
582 \r
583     if( nb_subfr == PE_MAX_NB_SUBFR ){\r
584         Lag_range_ptr = &SKP_Silk_Lag_range_stage3[ complexity ][ 0 ][ 0 ];\r
585         Lag_CB_ptr    = &SKP_Silk_CB_lags_stage3[ 0 ][ 0 ];\r
586         nb_cbk_search = SKP_Silk_nb_cbk_searchs_stage3[ complexity ];\r
587         cbk_size      = PE_NB_CBKS_STAGE3_MAX;\r
588     } else {\r
589         SKP_assert( nb_subfr == PE_MAX_NB_SUBFR >> 1);\r
590         Lag_range_ptr = &SKP_Silk_Lag_range_stage3_10_ms[ 0 ][ 0 ];\r
591         Lag_CB_ptr    = &SKP_Silk_CB_lags_stage3_10_ms[ 0 ][ 0 ];\r
592         nb_cbk_search = PE_NB_CBKS_STAGE3_10MS;\r
593         cbk_size      = PE_NB_CBKS_STAGE3_10MS;\r
594     }\r
595 \r
596     target_ptr = &signal[ SKP_LSHIFT( sf_length, 2 ) ];\r
597     for( k = 0; k < nb_subfr; k++ ) {\r
598         lag_counter = 0;\r
599 \r
600         /* Calculate the energy for first lag */\r
601         basis_ptr = target_ptr - ( start_lag + matrix_ptr( Lag_range_ptr, k, 0, 2 ) );\r
602         energy = SKP_Silk_energy_FLP( basis_ptr, sf_length ) + 1e-3;\r
603         SKP_assert( energy >= 0.0 );\r
604         scratch_mem[lag_counter] = (SKP_float)energy;\r
605         lag_counter++;\r
606 \r
607         lag_diff = ( matrix_ptr( Lag_range_ptr, k, 1, 2 ) -  matrix_ptr( Lag_range_ptr, k, 0, 2 ) + 1 );\r
608         for( i = 1; i < lag_diff; i++ ) {\r
609             /* remove part outside new window */\r
610             energy -= basis_ptr[sf_length - i] * basis_ptr[sf_length - i];\r
611             SKP_assert( energy >= 0.0 );\r
612 \r
613             /* add part that comes into window */\r
614             energy += basis_ptr[ -i ] * basis_ptr[ -i ];\r
615             SKP_assert( energy >= 0.0 );\r
616             SKP_assert( lag_counter < SCRATCH_SIZE );\r
617             scratch_mem[lag_counter] = (SKP_float)energy;\r
618             lag_counter++;\r
619         }\r
620 \r
621         delta = matrix_ptr( Lag_range_ptr, k, 0, 2 );\r
622         for( i = 0; i < nb_cbk_search; i++ ) { \r
623             /* Fill out the 3 dim array that stores the correlations for    */\r
624             /* each code_book vector for each start lag                     */\r
625             idx = matrix_ptr( Lag_CB_ptr, k, i, cbk_size ) - delta;\r
626             for( j = 0; j < PE_NB_STAGE3_LAGS; j++ ) {\r
627                 SKP_assert( idx + j < SCRATCH_SIZE );\r
628                 SKP_assert( idx + j < lag_counter );\r
629                 energies_st3[ k ][ i ][ j ] = scratch_mem[ idx + j ];\r
630                 SKP_assert( energies_st3[ k ][ i ][ j ] >= 0.0f );\r
631             }\r
632         }\r
633         target_ptr += sf_length;\r
634     }\r
635 }\r