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