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