Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src_SigProc_FIX / SKP_Silk_SigProc_FIX.h
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, 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 #ifndef _SKP_SILK_SIGPROC_FIX_H_\r
30 #define _SKP_SILK_SIGPROC_FIX_H_\r
31 \r
32 #ifdef  __cplusplus\r
33 extern "C"\r
34 {\r
35 #endif\r
36 \r
37 //#define SKP_MACRO_COUNT /* Used to enable WMOPS counting */\r
38 \r
39 #define SKP_Silk_MAX_ORDER_LPC            16                    /* max order of the LPC analysis in schur() and k2a()    */\r
40 #define SKP_Silk_MAX_CORRELATION_LENGTH   640                   /* max input length to the correlation                    */\r
41 #include "SKP_Silk_typedef.h"\r
42 #include <string.h>\r
43 #include <stdlib.h>                                            /* for abs() */\r
44 #include "SKP_Silk_resampler_structs.h"\r
45 \r
46 #       include "SKP_Silk_macros.h"\r
47 \r
48 \r
49 \r
50 /********************************************************************/\r
51 /*                    SIGNAL PROCESSING FUNCTIONS                   */\r
52 /********************************************************************/\r
53 \r
54 /*!\r
55  * Initialize/reset the resampler state for a given pair of input/output sampling rates \r
56 */\r
57 SKP_int SKP_Silk_resampler_init( \r
58         SKP_Silk_resampler_state_struct *S,                 /* I/O: Resampler state                     */\r
59         SKP_int32                                                       Fs_Hz_in,       /* I:   Input sampling rate (Hz)        */\r
60         SKP_int32                                                       Fs_Hz_out       /* I:   Output sampling rate (Hz)       */\r
61 );\r
62 \r
63 \r
64 /*!\r
65  * Clear the states of all resampling filters, without resetting sampling rate ratio \r
66  */\r
67 SKP_int SKP_Silk_resampler_clear( \r
68         SKP_Silk_resampler_state_struct *S                  /* I/O: Resampler state                     */\r
69 );\r
70 \r
71 /*!\r
72  * Resampler: convert from one sampling rate to another\r
73  */\r
74 SKP_int SKP_Silk_resampler( \r
75         SKP_Silk_resampler_state_struct *S,                 /* I/O: Resampler state                     */\r
76         SKP_int16                                                       out[],      /* O:       Output signal                           */\r
77         const SKP_int16                                         in[],       /* I:       Input signal                            */\r
78         SKP_int32                                                       inLen       /* I:       Number of input samples         */\r
79 );\r
80 \r
81 /*!\r
82  Upsample 2x, low quality \r
83  */\r
84 void SKP_Silk_resampler_up2(\r
85     SKP_int32                           *S,         /* I/O: State vector [ 2 ]          */\r
86     SKP_int16                           *out,       /* O:   Output signal [ 2 * len ]   */\r
87     const SKP_int16                     *in,        /* I:   Input signal [ len ]        */\r
88     SKP_int32                           len         /* I:   Number of INPUT samples     */\r
89 );\r
90 \r
91 /*!\r
92 * Downsample 2x, mediocre quality \r
93 */\r
94 void SKP_Silk_resampler_down2(\r
95     SKP_int32                           *S,         /* I/O: State vector [ 2 ]          */\r
96     SKP_int16                           *out,       /* O:   Output signal [ len ]       */\r
97     const SKP_int16                     *in,        /* I:   Input signal [ 2 * len ]    */\r
98     SKP_int32                           len         /* I:   Number of OUTPUT samples    */\r
99 );\r
100 \r
101 \r
102 /*!\r
103  * Downsample by a factor 2/3, low quality\r
104 */\r
105 void SKP_Silk_resampler_down2_3(\r
106     SKP_int32                           *S,         /* I/O: State vector [ 6 ]                  */\r
107     SKP_int16                           *out,       /* O:   Output signal [ floor(2*inLen/3) ]  */\r
108     const SKP_int16                     *in,        /* I:   Input signal [ inLen ]              */\r
109     SKP_int32                           inLen       /* I:   Number of input samples             */\r
110 );\r
111 \r
112 /*!\r
113  * Downsamples by a factor 3, low quality\r
114 */\r
115 void SKP_Silk_resampler_down3(\r
116     SKP_int32                           *S,         /* I/O: State vector [ 8 ]                  */\r
117     SKP_int16                           *out,       /* O:   Output signal [ floor(inLen/3) ]    */\r
118     const SKP_int16                     *in,        /* I:   Input signal [ inLen ]              */\r
119     SKP_int32                           inLen       /* I:   Number of input samples             */\r
120 );\r
121 \r
122 /*! \r
123  * First order low-pass filter, with input as SKP_int16, running at 48 kHz \r
124  */\r
125 void SKP_Silk_lowpass_short(\r
126     const SKP_int16      *in,           /* I:   Q15 48 kHz signal; [len]    */\r
127     SKP_int32            *S,            /* I/O: Q25 state; length = 1       */\r
128     SKP_int32            *out,          /* O:   Q25 48 kHz signal; [len]    */\r
129     const SKP_int32      len            /* O:   Signal length               */\r
130 );\r
131 \r
132 /*! \r
133  * First order low-pass filter, with input as SKP_int32, running at 48 kHz \r
134  */\r
135 void SKP_Silk_lowpass_int(\r
136     const SKP_int32      *in,           /* I:   Q25 48 kHz signal; length = len  */\r
137     SKP_int32            *S,            /* I/O: Q25 state; length = 1            */\r
138     SKP_int32            *out,          /* O:   Q25 48 kHz signal; length = len  */\r
139     const SKP_int32      len            /* I:   Number of samples                */\r
140 );\r
141 \r
142 /*! \r
143  * First-order allpass filter \r
144  */\r
145 void SKP_Silk_allpass_int(\r
146     const SKP_int32      *in,          /* I:   Q25 input signal [len]               */\r
147     SKP_int32            *S,           /* I/O: Q25 state [1]                        */\r
148     SKP_int              A,            /* I:   Q15 coefficient    (0 <= A < 32768)  */\r
149     SKP_int32            *out,         /* O:   Q25 output signal [len]              */\r
150     const SKP_int32      len           /* I:   Number of samples                    */\r
151 );\r
152 \r
153 /*! \r
154  * second order ARMA filter\r
155  * can handle (slowly) varying coefficients \r
156  */\r
157 void SKP_Silk_biquad(\r
158     const SKP_int16      *in,          /* I:   input signal                */\r
159     const SKP_int16      *B,           /* I:   MA coefficients, Q13 [3]    */\r
160     const SKP_int16      *A,           /* I:   AR coefficients, Q13 [2]    */\r
161           SKP_int32      *S,           /* I/O: state vector [2]            */\r
162           SKP_int16      *out,         /* O:   output signal               */\r
163     const SKP_int32      len           /* I:   signal length               */\r
164 );\r
165 /*!\r
166  * second order ARMA filter; \r
167  * slower than biquad() but uses more precise coefficients\r
168  * can handle (slowly) varying coefficients \r
169  */\r
170 void SKP_Silk_biquad_alt(\r
171     const SKP_int16     *in,           /* I:    input signal                 */\r
172     const SKP_int32     *B_Q28,        /* I:    MA coefficients [3]          */\r
173     const SKP_int32     *A_Q28,        /* I:    AR coefficients [2]          */\r
174     SKP_int32           *S,            /* I/O: state vector [2]              */\r
175     SKP_int16           *out,          /* O:    output signal                */\r
176     const SKP_int32     len            /* I:    signal length (must be even) */\r
177 );\r
178 \r
179 /*! \r
180  * variable order MA filter. Prediction error filter implementation. Coeficients negated and starting with coef to x[n - 1]\r
181  */\r
182 void SKP_Silk_MA_Prediction(\r
183     const SKP_int16      *in,          /* I:   Input signal                                */\r
184     const SKP_int16      *B,           /* I:   MA prediction coefficients, Q12 [order]     */\r
185     SKP_int32            *S,           /* I/O: State vector [order]                        */\r
186     SKP_int16            *out,         /* O:   Output signal                               */\r
187     const SKP_int32      len,          /* I:   Signal length                               */\r
188     const SKP_int32      order         /* I:  Filter order                                 */\r
189 );\r
190 \r
191 void SKP_Silk_MA_Prediction_Q13(\r
192     const SKP_int16      *in,          /* I:   input signal                                */\r
193     const SKP_int16      *B,           /* I:   MA prediction coefficients, Q13 [order]     */\r
194     SKP_int32            *S,           /* I/O: state vector [order]                        */\r
195     SKP_int16            *out,         /* O:   output signal                               */\r
196     SKP_int32            len,          /* I:   signal length                               */\r
197     SKP_int32            order         /* I:   filter order                                */\r
198 );\r
199 \r
200 /*!\r
201  * 16th order AR filter for LPC synthesis, coefficients are in Q12\r
202  */\r
203 void SKP_Silk_LPC_synthesis_order16(\r
204     const SKP_int16      *in,          /* I:   excitation signal                            */\r
205     const SKP_int16      *A_Q12,       /* I:   AR coefficients [16], between -8_Q0 and 8_Q0 */\r
206     const SKP_int32      Gain_Q26,     /* I:   gain                                         */\r
207           SKP_int32      *S,           /* I/O: state vector [16]                            */\r
208           SKP_int16      *out,         /* O:   output signal                                */\r
209     const SKP_int32      len           /* I:   signal length, must be multiple of 16        */\r
210 );\r
211 \r
212 /* variable order MA prediction error filter. */\r
213 /* Inverse filter of SKP_Silk_LPC_synthesis_filter */\r
214 void SKP_Silk_LPC_analysis_filter(\r
215     const SKP_int16      *in,          /* I:   Input signal                                */\r
216     const SKP_int16      *B,           /* I:   MA prediction coefficients, Q12 [order]     */\r
217     SKP_int16            *S,           /* I/O: State vector [order]                        */\r
218     SKP_int16            *out,         /* O:   Output signal                               */\r
219     const SKP_int32      len,          /* I:   Signal length                               */\r
220     const SKP_int32      Order         /* I:   Filter order                                */\r
221 );\r
222 \r
223 /* even order AR filter */\r
224 void SKP_Silk_LPC_synthesis_filter(\r
225     const SKP_int16      *in,          /* I:   excitation signal                               */\r
226     const SKP_int16      *A_Q12,       /* I:   AR coefficients [Order], between -8_Q0 and 8_Q0 */\r
227     const SKP_int32      Gain_Q26,     /* I:   gain                                            */\r
228     SKP_int32            *S,           /* I/O: state vector [Order]                            */\r
229     SKP_int16            *out,         /* O:   output signal                                   */\r
230     const SKP_int32      len,          /* I:   signal length                                   */\r
231     const SKP_int        Order         /* I:   filter order, must be even                      */\r
232 );\r
233 \r
234 /* Chirp (bandwidth expand) LP AR filter */\r
235 void SKP_Silk_bwexpander( \r
236     SKP_int16            *ar,          /* I/O  AR filter to be expanded (without leading 1)    */\r
237     const SKP_int        d,            /* I    Length of ar                                    */\r
238     SKP_int32            chirp_Q16     /* I    Chirp factor (typically in the range 0 to 1)    */\r
239 );\r
240 \r
241 /* Chirp (bandwidth expand) LP AR filter */\r
242 void SKP_Silk_bwexpander_32( \r
243     SKP_int32            *ar,          /* I/O  AR filter to be expanded (without leading 1)    */\r
244     const SKP_int        d,            /* I    Length of ar                                    */\r
245     SKP_int32            chirp_Q16     /* I    Chirp factor in Q16                             */\r
246 );\r
247 \r
248 /* Compute inverse of LPC prediction gain, and                           */\r
249 /* test if LPC coefficients are stable (all poles within unit circle)    */\r
250 SKP_int SKP_Silk_LPC_inverse_pred_gain( /* O:  Returns 1 if unstable, otherwise 0          */\r
251     SKP_int32            *invGain_Q30,  /* O:  Inverse prediction gain, Q30 energy domain  */\r
252     const SKP_int16      *A_Q12,        /* I:  Prediction coefficients, Q12 [order]        */\r
253     const SKP_int        order          /* I:  Prediction order                            */\r
254 );\r
255 \r
256 SKP_int SKP_Silk_LPC_inverse_pred_gain_Q24( /* O:   Returns 1 if unstable, otherwise 0      */\r
257     SKP_int32           *invGain_Q30,   /* O:   Inverse prediction gain, Q30 energy domain  */\r
258     const SKP_int32     *A_Q24,         /* I:   Prediction coefficients, Q24 [order]        */\r
259     const SKP_int       order           /* I:   Prediction order                            */\r
260 );\r
261 \r
262 /* split signal in two decimated bands using first-order allpass filters */\r
263 void SKP_Silk_ana_filt_bank_1(\r
264     const SKP_int16      *in,           /* I:   Input signal [N]        */\r
265     SKP_int32            *S,            /* I/O: State vector [2]        */\r
266     SKP_int16            *outL,         /* O:   Low band [N/2]          */\r
267     SKP_int16            *outH,         /* O:   High band [N/2]         */\r
268     SKP_int32            *scratch,      /* I:   Scratch memory [3*N/2]  */\r
269     const SKP_int32      N              /* I:   Number of input samples */\r
270 );\r
271 \r
272 /********************************************************************/\r
273 /*                        SCALAR FUNCTIONS                            */\r
274 /********************************************************************/\r
275 \r
276 /* approximation of 128 * log2() (exact inverse of approx 2^() below) */\r
277 /* convert input to a log scale    */\r
278 SKP_int32 SKP_Silk_lin2log(const SKP_int32 inLin);        /* I: input in linear scale        */\r
279 \r
280 /* Approximation of a sigmoid function */\r
281 SKP_int SKP_Silk_sigm_Q15(SKP_int in_Q5);\r
282 \r
283 /* approximation of 2^() (exact inverse of approx log2() above) */\r
284 /* convert input to a linear scale    */ \r
285 SKP_int32 SKP_Silk_log2lin(const SKP_int32 inLog_Q7);    /* I: input on log scale */ \r
286 \r
287 /* Function that returns the maximum absolut value of the input vector */\r
288 SKP_int16 SKP_Silk_int16_array_maxabs(  /* O   Maximum absolute value, max: 2^15-1   */\r
289     const SKP_int16     *vec,           /* I   Input vector  [len]                   */ \r
290     const SKP_int32     len             /* I   Length of input vector                */\r
291 );\r
292 \r
293 /* Compute number of bits to right shift the sum of squares of a vector    */\r
294 /* of int16s to make it fit in an int32                                    */\r
295 void SKP_Silk_sum_sqr_shift(\r
296     SKP_int32           *energy,        /* O   Energy of x, after shifting to the right            */\r
297     SKP_int             *shift,         /* O   Number of bits right shift applied to energy        */\r
298     const SKP_int16     *x,             /* I   Input vector                                        */\r
299     SKP_int             len             /* I   Length of input vector                              */\r
300 );\r
301 \r
302 /* Calculates the reflection coefficients from the correlation sequence    */\r
303 /* Faster than schur64(), but much less accurate.                          */\r
304 /* Uses SMLAWB(), requiring armv5E and higher.                             */\r
305 void SKP_Silk_schur(\r
306     SKP_int16           *rc_Q15,        /* O:  reflection coefficients [order] Q15         */\r
307     const SKP_int32     *c,             /* I:  correlations [order+1]                      */\r
308     const SKP_int32     order           /* I:  prediction order                            */\r
309 );\r
310 \r
311 /* Calculates the reflection coefficients from the correlation sequence    */\r
312 /* Slower than schur(), but more accurate.                                 */\r
313 /* Uses SMULL(), available on armv4                                        */\r
314 SKP_int32 SKP_Silk_schur64(             /* O:  returns residual energy                     */\r
315     SKP_int32           rc_Q16[],       /* O:  Reflection coefficients [order] Q16         */\r
316     const SKP_int32     c[],            /* I:  Correlations [order+1]                      */\r
317     SKP_int32           order           /* I:  Prediction order                            */\r
318 );\r
319 \r
320 /* Step up function, converts reflection coefficients to prediction coefficients */\r
321 void SKP_Silk_k2a(\r
322     SKP_int32           *A_Q24,         /* O:  Prediction coefficients [order] Q24         */\r
323     const SKP_int16     *rc_Q15,        /* I:  Reflection coefficients [order] Q15         */\r
324     const SKP_int32     order           /* I:  Prediction order                            */\r
325 );\r
326 \r
327 /* Step up function, converts reflection coefficients to prediction coefficients */\r
328 void SKP_Silk_k2a_Q16(\r
329     SKP_int32           *A_Q24,         /* O:  Prediction coefficients [order] Q24         */\r
330     const SKP_int32     *rc_Q16,        /* I:  Reflection coefficients [order] Q16         */\r
331     const SKP_int32     order           /* I:  Prediction order                            */\r
332 );\r
333 \r
334 /* Apply sine window to signal vector.                                      */\r
335 /* Window types:                                                            */\r
336 /*    0 -> sine window from 0 to pi                                         */\r
337 /*    1 -> sine window from 0 to pi/2                                       */\r
338 /*    2 -> sine window from pi/2 to pi                                      */\r
339 /* every other sample of window is linearly interpolated, for speed         */\r
340 void SKP_Silk_apply_sine_window(\r
341     SKP_int16           px_win[],       /* O  Pointer to windowed signal                  */\r
342     const SKP_int16     px[],           /* I  Pointer to input signal                     */\r
343     const SKP_int       win_type,       /* I  Selects a window type                       */\r
344     const SKP_int       length          /* I  Window length, multiple of 4                */\r
345 );\r
346 \r
347 /* Compute autocorrelation */\r
348 void SKP_Silk_autocorr( \r
349     SKP_int32           *results,       /* O  Result (length correlationCount)            */\r
350     SKP_int             *scale,         /* O  Scaling of the correlation vector           */\r
351     const SKP_int16     *inputData,     /* I  Input data to correlate                     */\r
352     const SKP_int       inputDataSize,  /* I  Length of input                             */\r
353     const SKP_int       correlationCount /* I  Number of correlation taps to compute      */\r
354 );\r
355 \r
356 /* Pitch estimator */\r
357 #define SKP_Silk_PE_MIN_COMPLEX        0\r
358 #define SKP_Silk_PE_MID_COMPLEX        1\r
359 #define SKP_Silk_PE_MAX_COMPLEX        2\r
360 \r
361 void SKP_Silk_decode_pitch(\r
362     SKP_int         lagIndex,                        /* I                             */\r
363     SKP_int         contourIndex,                    /* O                             */\r
364     SKP_int         pitch_lags[],                    /* O 4 pitch values              */\r
365     const SKP_int   Fs_kHz,                          /* I sampling frequency (kHz)    */\r
366     const SKP_int   nb_subfr                         /* I number of sub frames        */\r
367 );\r
368 \r
369 SKP_int SKP_Silk_pitch_analysis_core(  /* O    Voicing estimate: 0 voiced, 1 unvoiced                        */\r
370     const SKP_int16  *signal,            /* I    Signal of length PE_FRAME_LENGTH_MS*Fs_kHz           */\r
371     SKP_int          *pitch_out,         /* O    4 pitch lag values                                          */\r
372     SKP_int          *lagIndex,          /* O    Lag Index                                                   */\r
373     SKP_int          *contourIndex,      /* O    Pitch contour Index                                         */\r
374     SKP_int          *LTPCorr_Q15,       /* I/O  Normalized correlation; input: value from previous frame    */\r
375     SKP_int          prevLag,            /* I    Last lag of previous frame; set to zero is unvoiced         */\r
376     const SKP_int32  search_thres1_Q16,  /* I    First stage threshold for lag candidates 0 - 1              */\r
377     const SKP_int    search_thres2_Q15,  /* I    Final threshold for lag candidates 0 - 1                    */\r
378     const SKP_int    Fs_kHz,             /* I    Sample frequency (kHz)                                      */\r
379     const SKP_int    complexity,         /* I    Complexity setting, 0-2, where 2 is highest                 */\r
380     const SKP_int    nb_subfr            /* I    number of 5 ms subframes                                    */\r
381 );\r
382 \r
383 /* parameter defining the size and accuracy of the piecewise linear    */\r
384 /* cosine approximatin table.                                        */\r
385 \r
386 #define LSF_COS_TAB_SZ_FIX      128\r
387 /* rom table with cosine values */\r
388 extern const SKP_int SKP_Silk_LSFCosTab_FIX_Q12[ LSF_COS_TAB_SZ_FIX + 1 ];\r
389 \r
390 void SKP_Silk_LPC_fit(\r
391           SKP_int16    *a_QQ,            /* O    stabilized LPC vector, Q(24-rshift) [L]         */\r
392           SKP_int32    *a_Q24,           /* I    LPC vector [L]                                  */\r
393     const SKP_int      QQ,               /* I    Q domain of output LPC vector                   */\r
394     const SKP_int      L                 /* I    Number of LPC parameters in the input vector    */\r
395 );\r
396 \r
397 /* Compute Normalized Line Spectral Frequencies (NLSFs) from whitening filter coefficients        */\r
398 /* If not all roots are found, the a_Q16 coefficients are bandwidth expanded until convergence.    */\r
399 void SKP_Silk_A2NLSF(\r
400     SKP_int            *NLSF,            /* O    Normalized Line Spectral Frequencies, Q15 (0 - (2^15-1)), [d] */\r
401     SKP_int32          *a_Q16,           /* I/O  Monic whitening filter coefficients in Q16 [d]                */\r
402     const SKP_int      d                 /* I    Filter order (must be even)                                   */\r
403 );\r
404 \r
405 /* compute whitening filter coefficients from normalized line spectral frequencies */\r
406 void SKP_Silk_NLSF2A(\r
407     SKP_int16          *a,               /* o    monic whitening filter coefficients in Q12,  [d]    */\r
408     const SKP_int      *NLSF,            /* i    normalized line spectral frequencies in Q15, [d]    */\r
409     const SKP_int      d                 /* i    filter order (should be even)                       */\r
410 );\r
411 \r
412 void SKP_Silk_insertion_sort_increasing(\r
413     SKP_int32            *a,            /* I/O   Unsorted / Sorted vector                */\r
414     SKP_int              *index,        /* O:    Index vector for the sorted elements    */\r
415     const SKP_int        L,             /* I:    Vector length                           */\r
416     const SKP_int        K              /* I:    Number of correctly sorted positions    */\r
417 );\r
418 \r
419 void SKP_Silk_insertion_sort_decreasing(\r
420     SKP_int              *a,            /* I/O:  Unsorted / Sorted vector                */\r
421     SKP_int              *index,        /* O:    Index vector for the sorted elements    */\r
422     const SKP_int        L,             /* I:    Vector length                           */\r
423     const SKP_int        K              /* I:    Number of correctly sorted positions    */\r
424 );\r
425 \r
426 void SKP_Silk_insertion_sort_decreasing_int16(\r
427     SKP_int16            *a,            /* I/O:  Unsorted / Sorted vector                */\r
428     SKP_int              *index,        /* O:    Index vector for the sorted elements    */\r
429     const SKP_int        L,             /* I:    Vector length                           */\r
430     const SKP_int        K              /* I:    Number of correctly sorted positions    */\r
431 );\r
432 \r
433 void SKP_Silk_insertion_sort_increasing_all_values(\r
434      SKP_int             *a,            /* I/O:  Unsorted / Sorted vector                */\r
435      const SKP_int       L              /* I:    Vector length                           */\r
436 );\r
437 \r
438 /* NLSF stabilizer, for a single input data vector */\r
439 void SKP_Silk_NLSF_stabilize(\r
440           SKP_int        *NLSF_Q15,      /* I/O:  Unstable/stabilized normalized LSF vector in Q15 [L]                    */\r
441     const SKP_int        *NDeltaMin_Q15, /* I:    Normalized delta min vector in Q15, NDeltaMin_Q15[L] must be >= 1 [L+1] */\r
442     const SKP_int        L               /* I:    Number of NLSF parameters in the input vector                           */\r
443 );\r
444 \r
445 /* NLSF stabilizer, over multiple input column data vectors */\r
446 void SKP_Silk_NLSF_stabilize_multi(\r
447           SKP_int        *NLSF_Q15,      /* I/O:  Unstable/stabilized normalized LSF vectors in Q15 [LxN]                 */\r
448     const SKP_int        *NDeltaMin_Q15, /* I:    Normalized delta min vector in Q15, NDeltaMin_Q15[L] must be >= 1 [L+1] */\r
449     const SKP_int        N,              /* I:    Number of input vectors to be stabilized                                */\r
450     const SKP_int        L               /* I:    NLSF vector dimension                                                   */\r
451 );\r
452 \r
453 /* Laroia low complexity NLSF weights */\r
454 void SKP_Silk_NLSF_VQ_weights_laroia(\r
455     SKP_int              *pNLSFW_Q6,     /* O:    Pointer to input vector weights            [D x 1]       */\r
456     const SKP_int        *pNLSF_Q15,     /* I:    Pointer to input vector                    [D x 1]       */\r
457     const SKP_int        D               /* I:    Input vector dimension (even)                            */\r
458 );\r
459 \r
460 /* Compute reflection coefficients from input signal */\r
461 void SKP_Silk_burg_modified(        \r
462     SKP_int32            *res_nrg,           /* O   residual energy                                                 */\r
463     SKP_int              *res_nrgQ,          /* O   residual energy Q value                                         */\r
464     SKP_int32            A_Q16[],            /* O   prediction coefficients (length order)                          */\r
465     const SKP_int16      x[],                /* I   input signal, length: nb_subfr * ( D + subfr_length )           */\r
466     const SKP_int        subfr_length,       /* I   input signal subframe length (including D preceeding samples)   */\r
467     const SKP_int        nb_subfr,           /* I   number of subframes stacked in x                                */\r
468     const SKP_int32      WhiteNoiseFrac_Q32, /* I   fraction added to zero-lag autocorrelation                      */\r
469     const SKP_int        D                   /* I   order                                                           */\r
470 );\r
471 \r
472 /* Multiply a vector by a constant */\r
473 void SKP_Silk_scale_vector16_Q14( \r
474     SKP_int16            *data1, \r
475     SKP_int              gain_Q14,           /* Gain in Q14 */ \r
476     SKP_int              dataSize\r
477 );\r
478 \r
479 /* Copy and multiply a vector by a constant */\r
480 void SKP_Silk_scale_copy_vector16( \r
481     SKP_int16            *data_out, \r
482     const SKP_int16      *data_in, \r
483     SKP_int32            gain_Q16,           /* I:   gain in Q16   */\r
484     const SKP_int        dataSize            /* I:   length        */\r
485 );\r
486 \r
487 void SKP_Silk_scale_vector32_16_Q14( \r
488     SKP_int32            *data1,             /* I/O: Q0/Q0         */\r
489     SKP_int              gain_Q14,           /* I:   Q14           */\r
490     SKP_int              dataSize            /* I:   length        */\r
491 );\r
492 \r
493 /* Multiply a vector by a constant, does not saturate output data */\r
494 void SKP_Silk_scale_vector32_Q16( \r
495     SKP_int32            *data1,             /* I/O: Q0/Q0         */\r
496     SKP_int32            gain_Q16,           /* I:   gain in Q16 ( SKP_int16_MIN <= gain_Q16 <= SKP_int16_MAX + 65536 ) */\r
497     const SKP_int        dataSize            /* I:   length        */\r
498 );\r
499 \r
500 /* Some for the LTP related function requires Q26 to work.*/\r
501 void SKP_Silk_scale_vector32_Q26_lshift_18( \r
502     SKP_int32            *data1,             /* I/O: Q0/Q18        */\r
503     SKP_int32            gain_Q26,           /* I:   Q26           */\r
504     SKP_int              dataSize            /* I:   length        */\r
505 );\r
506 \r
507 /********************************************************************/\r
508 /*                        INLINE ARM MATH                             */\r
509 /********************************************************************/\r
510 \r
511 /*    return sum(inVec1[i]*inVec2[i])    */\r
512 /*    inVec1 and inVec2 should be increasing ordered, and starting address should be 4 byte aligned. (a factor of 4)*/\r
513 SKP_int32 SKP_Silk_inner_prod_aligned(\r
514     const SKP_int16* const inVec1,           /* I   input vector 1    */ \r
515     const SKP_int16* const inVec2,           /* I   input vector 2    */\r
516     const SKP_int          len               /* I   vector lengths    */\r
517 );\r
518 \r
519 SKP_int32 SKP_Silk_inner_prod16_aligned_sat(\r
520     const SKP_int16* const inVec1,           /* I   input vector 1  */\r
521     const SKP_int16* const inVec2,           /* I   input vector 2  */\r
522     const SKP_int          len               /* I   vector lengths  */\r
523 );\r
524 \r
525 SKP_int64 SKP_Silk_inner_prod_aligned_64(\r
526     const SKP_int32        *inVec1,          /* I   input vector 1    */\r
527     const SKP_int32        *inVec2,          /* I   input vector 2    */\r
528     const SKP_int          len               /* I   vector lengths    */\r
529 );\r
530 \r
531 SKP_int64 SKP_Silk_inner_prod16_aligned_64(\r
532     const SKP_int16        *inVec1,          /* I   input vector 1    */\r
533     const SKP_int16        *inVec2,          /* I   input vector 2    */\r
534     const SKP_int          len               /* I   vector lengths    */\r
535 );\r
536 /********************************************************************/\r
537 /*                                MACROS                            */\r
538 /********************************************************************/\r
539 \r
540 /* Rotate a32 right by 'rot' bits. Negative rot values result in rotating\r
541    left. Output is 32bit int.\r
542    Note: contemporary compilers recognize the C expression below and\r
543    compile it into a 'ror' instruction if available. No need for inline ASM! */\r
544 SKP_INLINE SKP_int32 SKP_ROR32( SKP_int32 a32, SKP_int rot )\r
545 {\r
546     SKP_uint32 x = (SKP_uint32) a32;\r
547     SKP_uint32 r = (SKP_uint32) rot;\r
548     SKP_uint32 m = (SKP_uint32) -rot;\r
549     if(rot <= 0)\r
550         return (SKP_int32) ((x << m) | (x >> (32 - m)));\r
551     else\r
552         return (SKP_int32) ((x << (32 - r)) | (x >> r));\r
553 }\r
554 \r
555 /* Define 4-byte aligned array of SKP_int16 */\r
556 #define SKP_array_of_int16_4_byte_aligned( arrayName, nElements )    \\r
557     SKP_int32 dummy_int32 ## arrayName;                                \\r
558     SKP_int16 arrayName[ (nElements) ]\r
559 \r
560 /* Useful Macros that can be adjusted to other platforms */\r
561 #define SKP_memcpy(a, b, c)                memcpy((a), (b), (c))    /* Dest, Src, ByteCount */\r
562 #define SKP_memset(a, b, c)                memset((a), (b), (c))    /* Dest, value, ByteCount */\r
563 #define SKP_memmove(a, b, c)               memmove((a), (b), (c))    /* Dest, Src, ByteCount */\r
564 /* fixed point macros */\r
565 \r
566 // (a32 * b32) output have to be 32bit int\r
567 #define SKP_MUL(a32, b32)                  ((a32) * (b32))\r
568 \r
569 // (a32 * b32) output have to be 32bit uint\r
570 #define SKP_MUL_uint(a32, b32)             SKP_MUL(a32, b32)\r
571 \r
572 // a32 + (b32 * c32) output have to be 32bit int\r
573 #define SKP_MLA(a32, b32, c32)             SKP_ADD32((a32),((b32) * (c32)))\r
574 \r
575 // a32 + (b32 * c32) output have to be 32bit uint\r
576 #define SKP_MLA_uint(a32, b32, c32)        SKP_MLA(a32, b32, c32)\r
577 \r
578 // ((a32 >> 16)  * (b32 >> 16)) output have to be 32bit int\r
579 #define SKP_SMULTT(a32, b32)               (((a32) >> 16) * ((b32) >> 16))\r
580 \r
581 // a32 + ((a32 >> 16)  * (b32 >> 16)) output have to be 32bit int\r
582 #define SKP_SMLATT(a32, b32, c32)          SKP_ADD32((a32),((b32) >> 16) * ((c32) >> 16))\r
583 \r
584 #define SKP_SMLALBB(a64, b16, c16)         SKP_ADD64((a64),(SKP_int64)((SKP_int32)(b16) * (SKP_int32)(c16)))\r
585 \r
586 // (a32 * b32)\r
587 #define SKP_SMULL(a32, b32)                ((SKP_int64)(a32) * /*(SKP_int64)*/(b32))\r
588 \r
589 // multiply-accumulate macros that allow overflow in the addition (ie, no asserts in debug mode)\r
590 #define SKP_MLA_ovflw(a32, b32, c32)       SKP_MLA(a32, b32, c32)\r
591 #ifndef SKP_SMLABB_ovflw\r
592 #    define SKP_SMLABB_ovflw(a32, b32, c32)    SKP_SMLABB(a32, b32, c32)\r
593 #endif\r
594 #define SKP_SMLABT_ovflw(a32, b32, c32)    SKP_SMLABT(a32, b32, c32)\r
595 #define SKP_SMLATT_ovflw(a32, b32, c32)    SKP_SMLATT(a32, b32, c32)\r
596 #define SKP_SMLAWB_ovflw(a32, b32, c32)    SKP_SMLAWB(a32, b32, c32)\r
597 #define SKP_SMLAWT_ovflw(a32, b32, c32)    SKP_SMLAWT(a32, b32, c32)\r
598 \r
599 #define SKP_DIV64_32(a64, b32)             ((a64)/(b32))        /* TODO: rewrite it as a set of SKP_DIV32.*/\r
600 \r
601 #define SKP_DIV32_16(a32, b16)             ((SKP_int32)((a32) / (b16)))\r
602 #define SKP_DIV32(a32, b32)                ((SKP_int32)((a32) / (b32)))\r
603 \r
604 // These macros enables checking for overflow in SKP_Silk_API_Debug.h\r
605 #define SKP_ADD16(a, b)                    ((a) + (b))\r
606 #define SKP_ADD32(a, b)                    ((a) + (b))\r
607 #define SKP_ADD64(a, b)                    ((a) + (b))\r
608 \r
609 #define SKP_SUB16(a, b)                    ((a) - (b))\r
610 #define SKP_SUB32(a, b)                    ((a) - (b))\r
611 #define SKP_SUB64(a, b)                    ((a) - (b))\r
612 \r
613 #define SKP_SAT8(a)                        ((a) > SKP_int8_MAX ? SKP_int8_MAX  : \\r
614                                            ((a) < SKP_int8_MIN ? SKP_int8_MIN  : (a)))\r
615 #define SKP_SAT16(a)                       ((a) > SKP_int16_MAX ? SKP_int16_MAX : \\r
616                                            ((a) < SKP_int16_MIN ? SKP_int16_MIN : (a)))\r
617 #define SKP_SAT32(a)                       ((a) > SKP_int32_MAX ? SKP_int32_MAX : \\r
618                                            ((a) < SKP_int32_MIN ? SKP_int32_MIN : (a)))\r
619 \r
620 #define SKP_CHECK_FIT8(a)                  (a)\r
621 #define SKP_CHECK_FIT16(a)                 (a)\r
622 #define SKP_CHECK_FIT32(a)                 (a)\r
623 \r
624 #define SKP_ADD_SAT16(a, b)                (SKP_int16)SKP_SAT16( SKP_ADD32( (SKP_int32)(a), (b) ) )\r
625 #define SKP_ADD_SAT64(a, b)                ((((a) + (b)) & 0x8000000000000000LL) == 0 ?                            \\r
626                                            ((((a) & (b)) & 0x8000000000000000LL) != 0 ? SKP_int64_MIN : (a)+(b)) :    \\r
627                                            ((((a) | (b)) & 0x8000000000000000LL) == 0 ? SKP_int64_MAX : (a)+(b)) )\r
628 \r
629 #define SKP_SUB_SAT16(a, b)                (SKP_int16)SKP_SAT16( SKP_SUB32( (SKP_int32)(a), (b) ) )\r
630 #define SKP_SUB_SAT64(a, b)                ((((a)-(b)) & 0x8000000000000000LL) == 0 ?                                                    \\r
631                                            (( (a) & ((b)^0x8000000000000000LL) & 0x8000000000000000LL) ? SKP_int64_MIN : (a)-(b)) :    \\r
632                                            ((((a)^0x8000000000000000LL) & (b)  & 0x8000000000000000LL) ? SKP_int64_MAX : (a)-(b)) )\r
633 \r
634 /* Saturation for positive input values */ \r
635 #define SKP_POS_SAT32(a)                   ((a) > SKP_int32_MAX ? SKP_int32_MAX : (a))\r
636 \r
637 /* Add with saturation for positive input values */ \r
638 #define SKP_ADD_POS_SAT8(a, b)             ((((a)+(b)) & 0x80)                 ? SKP_int8_MAX  : ((a)+(b)))\r
639 #define SKP_ADD_POS_SAT16(a, b)            ((((a)+(b)) & 0x8000)               ? SKP_int16_MAX : ((a)+(b)))\r
640 #define SKP_ADD_POS_SAT32(a, b)            ((((a)+(b)) & 0x80000000)           ? SKP_int32_MAX : ((a)+(b)))\r
641 #define SKP_ADD_POS_SAT64(a, b)            ((((a)+(b)) & 0x8000000000000000LL) ? SKP_int64_MAX : ((a)+(b)))\r
642 \r
643 #define SKP_LSHIFT8(a, shift)              ((a)<<(shift))                // shift >= 0, shift < 8\r
644 #define SKP_LSHIFT16(a, shift)             ((a)<<(shift))                // shift >= 0, shift < 16\r
645 #define SKP_LSHIFT32(a, shift)             ((a)<<(shift))                // shift >= 0, shift < 32\r
646 #define SKP_LSHIFT64(a, shift)             ((a)<<(shift))                // shift >= 0, shift < 64\r
647 #define SKP_LSHIFT(a, shift)               SKP_LSHIFT32(a, shift)        // shift >= 0, shift < 32\r
648 \r
649 #define SKP_RSHIFT8(a, shift)              ((a)>>(shift))                // shift >= 0, shift < 8\r
650 #define SKP_RSHIFT16(a, shift)             ((a)>>(shift))                // shift >= 0, shift < 16\r
651 #define SKP_RSHIFT32(a, shift)             ((a)>>(shift))                // shift >= 0, shift < 32\r
652 #define SKP_RSHIFT64(a, shift)             ((a)>>(shift))                // shift >= 0, shift < 64\r
653 #define SKP_RSHIFT(a, shift)               SKP_RSHIFT32(a, shift)        // shift >= 0, shift < 32\r
654 \r
655 /* saturates before shifting */\r
656 #define SKP_LSHIFT_SAT16(a, shift)         (SKP_LSHIFT16( SKP_LIMIT( (a), SKP_RSHIFT16( SKP_int16_MIN, (shift) ),    \\r
657                                                                           SKP_RSHIFT16( SKP_int16_MAX, (shift) ) ), (shift) ))\r
658 #define SKP_LSHIFT_SAT32(a, shift)         (SKP_LSHIFT32( SKP_LIMIT( (a), SKP_RSHIFT32( SKP_int32_MIN, (shift) ),    \\r
659                                                                           SKP_RSHIFT32( SKP_int32_MAX, (shift) ) ), (shift) ))\r
660 \r
661 #define SKP_LSHIFT_ovflw(a, shift)        ((a)<<(shift))        // shift >= 0, allowed to overflow\r
662 #define SKP_LSHIFT_uint(a, shift)         ((a)<<(shift))        // shift >= 0\r
663 #define SKP_RSHIFT_uint(a, shift)         ((a)>>(shift))        // shift >= 0\r
664 \r
665 #define SKP_ADD_LSHIFT(a, b, shift)       ((a) + SKP_LSHIFT((b), (shift)))            // shift >= 0\r
666 #define SKP_ADD_LSHIFT32(a, b, shift)     SKP_ADD32((a), SKP_LSHIFT32((b), (shift)))    // shift >= 0\r
667 #define SKP_ADD_LSHIFT_uint(a, b, shift)  ((a) + SKP_LSHIFT_uint((b), (shift)))        // shift >= 0\r
668 #define SKP_ADD_RSHIFT(a, b, shift)       ((a) + SKP_RSHIFT((b), (shift)))            // shift >= 0\r
669 #define SKP_ADD_RSHIFT32(a, b, shift)     SKP_ADD32((a), SKP_RSHIFT32((b), (shift)))    // shift >= 0\r
670 #define SKP_ADD_RSHIFT_uint(a, b, shift)  ((a) + SKP_RSHIFT_uint((b), (shift)))        // shift >= 0\r
671 #define SKP_SUB_LSHIFT32(a, b, shift)     SKP_SUB32((a), SKP_LSHIFT32((b), (shift)))    // shift >= 0\r
672 #define SKP_SUB_RSHIFT32(a, b, shift)     SKP_SUB32((a), SKP_RSHIFT32((b), (shift)))    // shift >= 0\r
673 \r
674 /* Requires that shift > 0 */\r
675 #define SKP_RSHIFT_ROUND(a, shift)        ((shift) == 1 ? ((a) >> 1) + ((a) & 1) : (((a) >> ((shift) - 1)) + 1) >> 1)\r
676 #define SKP_RSHIFT_ROUND64(a, shift)      ((shift) == 1 ? ((a) >> 1) + ((a) & 1) : (((a) >> ((shift) - 1)) + 1) >> 1)\r
677 \r
678 /* Number of rightshift required to fit the multiplication */\r
679 #define SKP_NSHIFT_MUL_32_32(a, b)        ( -(31- (32-SKP_Silk_CLZ32(SKP_abs(a)) + (32-SKP_Silk_CLZ32(SKP_abs(b))))) )\r
680 #define SKP_NSHIFT_MUL_16_16(a, b)        ( -(15- (16-SKP_Silk_CLZ16(SKP_abs(a)) + (16-SKP_Silk_CLZ16(SKP_abs(b))))) )\r
681 \r
682 \r
683 #define SKP_min(a, b)                     (((a) < (b)) ? (a) : (b)) \r
684 #define SKP_max(a, b)                     (((a) > (b)) ? (a) : (b))\r
685 \r
686 /* Macro to convert floating-point constants to fixed-point */\r
687 #define SKP_FIX_CONST( C, Q )             ((SKP_int32)((C) * (1 << (Q)) + 0.5))\r
688 \r
689 /* SKP_min() versions with typecast in the function call */\r
690 SKP_INLINE SKP_int SKP_min_int(SKP_int a, SKP_int b)\r
691 {\r
692     return (((a) < (b)) ? (a) : (b));\r
693 }\r
694 SKP_INLINE SKP_int16 SKP_min_16(SKP_int16 a, SKP_int16 b)\r
695 {\r
696     return (((a) < (b)) ? (a) : (b));\r
697 }\r
698 SKP_INLINE SKP_int32 SKP_min_32(SKP_int32 a, SKP_int32 b)\r
699 {\r
700     return (((a) < (b)) ? (a) : (b));\r
701 }\r
702 SKP_INLINE SKP_int64 SKP_min_64(SKP_int64 a, SKP_int64 b)\r
703 {\r
704     return (((a) < (b)) ? (a) : (b));\r
705 }\r
706 \r
707 /* SKP_min() versions with typecast in the function call */\r
708 SKP_INLINE SKP_int SKP_max_int(SKP_int a, SKP_int b)\r
709 {\r
710     return (((a) > (b)) ? (a) : (b));\r
711 }\r
712 SKP_INLINE SKP_int16 SKP_max_16(SKP_int16 a, SKP_int16 b)\r
713 {\r
714     return (((a) > (b)) ? (a) : (b));\r
715 }\r
716 SKP_INLINE SKP_int32 SKP_max_32(SKP_int32 a, SKP_int32 b)\r
717 {\r
718     return (((a) > (b)) ? (a) : (b));\r
719 }\r
720 SKP_INLINE SKP_int64 SKP_max_64(SKP_int64 a, SKP_int64 b)\r
721 {\r
722     return (((a) > (b)) ? (a) : (b));\r
723 }\r
724 \r
725 #define SKP_LIMIT( a, limit1, limit2)    ((limit1) > (limit2) ? ((a) > (limit1) ? (limit1) : ((a) < (limit2) ? (limit2) : (a))) \\r
726                                                              : ((a) > (limit2) ? (limit2) : ((a) < (limit1) ? (limit1) : (a))))\r
727 \r
728 #define SKP_LIMIT_int SKP_LIMIT\r
729 #define SKP_LIMIT_16 SKP_LIMIT\r
730 #define SKP_LIMIT_32 SKP_LIMIT\r
731 \r
732 //#define SKP_non_neg(a)                 ((a) & ((-(a)) >> (8 * sizeof(a) - 1)))   /* doesn't seem faster than SKP_max(0, a);\r
733 \r
734 #define SKP_abs(a)                       (((a) >  0)  ? (a) : -(a))            // Be careful, SKP_abs returns wrong when input equals to SKP_intXX_MIN\r
735 #define SKP_abs_int(a)                   (((a) ^ ((a) >> (8 * sizeof(a) - 1))) - ((a) >> (8 * sizeof(a) - 1)))\r
736 #define SKP_abs_int32(a)                 (((a) ^ ((a) >> 31)) - ((a) >> 31))\r
737 #define SKP_abs_int64(a)                 (((a) >  0)  ? (a) : -(a))    \r
738 \r
739 #define SKP_sign(a)                      ((a) > 0 ? 1 : ( (a) < 0 ? -1 : 0 ))\r
740 \r
741 #define SKP_sqrt(a)                      (sqrt(a)) \r
742 \r
743 /* PSEUDO-RANDOM GENERATOR                                                          */\r
744 /* Make sure to store the result as the seed for the next call (also in between     */\r
745 /* frames), otherwise result won't be random at all. When only using some of the    */\r
746 /* bits, take the most significant bits by right-shifting. Do not just mask off     */\r
747 /* the lowest bits.                                                                 */\r
748 #define SKP_RAND(seed)                   (SKP_MLA_ovflw(907633515, (seed), 196314165))\r
749 \r
750 // Add some multiplication functions that can be easily mapped to ARM.\r
751 \r
752 //    SKP_SMMUL: Signed top word multiply. \r
753 //        ARMv6        2 instruction cycles. \r
754 //        ARMv3M+        3 instruction cycles. use SMULL and ignore LSB registers.(except xM) \r
755 //#define SKP_SMMUL(a32, b32)            (SKP_int32)SKP_RSHIFT(SKP_SMLAL(SKP_SMULWB((a32), (b32)), (a32), SKP_RSHIFT_ROUND((b32), 16)), 16)\r
756 // the following seems faster on x86\r
757 #define SKP_SMMUL(a32, b32)              (SKP_int32)SKP_RSHIFT64(SKP_SMULL((a32), (b32)), 32)\r
758 \r
759 #include "SKP_Silk_Inlines.h"\r
760 #include "SKP_Silk_MacroCount.h"\r
761 #include "SKP_Silk_MacroDebug.h"\r
762 \r
763 #ifdef  __cplusplus\r
764 }\r
765 #endif\r
766 \r
767 #endif\r