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