Eliminate function pointers from the resampler.
[opus.git] / silk / SigProc_FIX.h
1 /***********************************************************************
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3 Redistribution and use in source and binary forms, with or without
4 modification, (subject to the limitations in the disclaimer below)
5 are permitted provided that the following conditions are met:
6 - Redistributions of source code must retain the above copyright notice,
7 this list of conditions and the following disclaimer.
8 - Redistributions in binary form must reproduce the above copyright
9 notice, this list of conditions and the following disclaimer in the
10 documentation and/or other materials provided with the distribution.
11 - Neither the name of Skype Limited, nor the names of specific
12 contributors, may be used to endorse or promote products derived from
13 this software without specific prior written permission.
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 ***********************************************************************/
27
28 #ifndef _SILK_SIGPROC_FIX_H_
29 #define _SILK_SIGPROC_FIX_H_
30
31 #ifdef  __cplusplus
32 extern "C"
33 {
34 #endif
35
36 /*#define silk_MACRO_COUNT */          /* Used to enable WMOPS counting */
37
38 #define SILK_MAX_ORDER_LPC            16                        /* max order of the LPC analysis in schur() and k2a()    */
39
40 #include <stdlib.h>                                             /* for abs() */
41 #include <string.h>                                             /* for memset(), memcpy(), memmove() */
42 #include "typedef.h"
43 #include "resampler_structs.h"
44 #include "macros.h"
45
46
47 /********************************************************************/
48 /*                    SIGNAL PROCESSING FUNCTIONS                   */
49 /********************************************************************/
50
51 /*!
52  * Initialize/reset the resampler state for a given pair of input/output sampling rates
53 */
54 opus_int silk_resampler_init(
55     silk_resampler_state_struct            *S,         /* I/O: Resampler state             */
56     opus_int32                            Fs_Hz_in,    /* I:    Input sampling rate (Hz)    */
57     opus_int32                            Fs_Hz_out    /* I:    Output sampling rate (Hz)    */
58 );
59
60 /*!
61  * Clear the states of all resampling filters, without resetting sampling rate ratio
62  */
63 opus_int silk_resampler_clear(
64     silk_resampler_state_struct            *S          /* I/O: Resampler state             */
65 );
66
67 /*!
68  * Resampler: convert from one sampling rate to another
69  */
70 opus_int silk_resampler(
71     silk_resampler_state_struct            *S,         /* I/O: Resampler state             */
72     opus_int16                            out[],        /* O:    Output signal                 */
73     const opus_int16                        in[],        /* I:    Input signal                */
74     opus_int32                            inLen        /* I:    Number of input samples        */
75 );
76
77 /*!
78  Upsample 2x, low quality
79  */
80 void silk_resampler_up2(
81     opus_int32                           *S,         /* I/O: State vector [ 2 ]                  */
82     opus_int16                           *out,       /* O:   Output signal [ 2 * len ]           */
83     const opus_int16                     *in,        /* I:   Input signal [ len ]                */
84     opus_int32                           len         /* I:   Number of input samples             */
85 );
86
87 /*!
88 * Downsample 2x, mediocre quality
89 */
90 void silk_resampler_down2(
91     opus_int32                           *S,         /* I/O: State vector [ 2 ]                  */
92     opus_int16                           *out,       /* O:   Output signal [ len ]               */
93     const opus_int16                     *in,        /* I:   Input signal [ floor(len/2) ]       */
94     opus_int32                           inLen       /* I:   Number of input samples             */
95 );
96
97
98 /*!
99  * Downsample by a factor 2/3, low quality
100 */
101 void silk_resampler_down2_3(
102     opus_int32                           *S,         /* I/O: State vector [ 6 ]                  */
103     opus_int16                           *out,       /* O:   Output signal [ floor(2*inLen/3) ]  */
104     const opus_int16                     *in,        /* I:   Input signal [ inLen ]              */
105     opus_int32                           inLen       /* I:   Number of input samples             */
106 );
107
108 /*!
109  * second order ARMA filter;
110  * slower than biquad() but uses more precise coefficients
111  * can handle (slowly) varying coefficients
112  */
113 void silk_biquad_alt(
114     const opus_int16     *in,           /* I:    input signal                 */
115     const opus_int32     *B_Q28,        /* I:    MA coefficients [3]          */
116     const opus_int32     *A_Q28,        /* I:    AR coefficients [2]          */
117     opus_int32           *S,            /* I/O:  State vector [2]             */
118     opus_int16           *out,          /* O:    output signal                */
119     const opus_int32     len,           /* I:    signal length (must be even) */
120     int stride
121 );
122
123 /* Variable order MA prediction error filter. */
124 void silk_LPC_analysis_filter(
125     opus_int16            *out,         /* O:   Output signal                               */
126     const opus_int16      *in,          /* I:   Input signal                                */
127     const opus_int16      *B,           /* I:   MA prediction coefficients, Q12 [order]     */
128     const opus_int32      len,          /* I:   Signal length                               */
129     const opus_int32      Order         /* I:   Filter order                                */
130 );
131
132 /* Chirp (bandwidth expand) LP AR filter */
133 void silk_bwexpander(
134     opus_int16            *ar,          /* I/O  AR filter to be expanded (without leading 1)    */
135     const opus_int        d,            /* I    Length of ar                                    */
136     opus_int32            chirp_Q16     /* I    Chirp factor (typically in the range 0 to 1)    */
137 );
138
139 /* Chirp (bandwidth expand) LP AR filter */
140 void silk_bwexpander_32(
141     opus_int32            *ar,          /* I/O  AR filter to be expanded (without leading 1)    */
142     const opus_int        d,            /* I    Length of ar                                    */
143     opus_int32            chirp_Q16     /* I    Chirp factor in Q16                             */
144 );
145
146 /* Compute inverse of LPC prediction gain, and                           */
147 /* test if LPC coefficients are stable (all poles within unit circle)    */
148 opus_int silk_LPC_inverse_pred_gain(     /* O:  Returns 1 if unstable, otherwise 0          */
149     opus_int32            *invGain_Q30,  /* O:  Inverse prediction gain, Q30 energy domain  */
150     const opus_int16      *A_Q12,        /* I:  Prediction coefficients, Q12 [order]        */
151     const opus_int        order          /* I:  Prediction order                            */
152 );
153
154 opus_int silk_LPC_inverse_pred_gain_Q24( /* O:   Returns 1 if unstable, otherwise 0      */
155     opus_int32           *invGain_Q30,   /* O:   Inverse prediction gain, Q30 energy domain  */
156     const opus_int32     *A_Q24,         /* I:   Prediction coefficients, Q24 [order]        */
157     const opus_int       order           /* I:   Prediction order                            */
158 );
159
160 /* split signal in two decimated bands using first-order allpass filters */
161 void silk_ana_filt_bank_1(
162     const opus_int16      *in,           /* I:   Input signal [N]        */
163     opus_int32            *S,            /* I/O: State vector [2]        */
164     opus_int16            *outL,         /* O:   Low band [N/2]          */
165     opus_int16            *outH,         /* O:   High band [N/2]         */
166     const opus_int32      N              /* I:   Number of input samples */
167 );
168
169 /********************************************************************/
170 /*                        SCALAR FUNCTIONS                          */
171 /********************************************************************/
172
173 /* approximation of 128 * log2() (exact inverse of approx 2^() below) */
174 /* convert input to a log scale    */
175 opus_int32 silk_lin2log(const opus_int32 inLin);        /* I: input in linear scale        */
176
177 /* Approximation of a sigmoid function */
178 opus_int silk_sigm_Q15(opus_int in_Q5);
179
180 /* approximation of 2^() (exact inverse of approx log2() above) */
181 /* convert input to a linear scale    */
182 opus_int32 silk_log2lin(const opus_int32 inLog_Q7);    /* I: input on log scale */
183
184 /* Function that returns the maximum absolut value of the input vector */
185 opus_int16 silk_int16_array_maxabs(      /* O   Maximum absolute value, max: 2^15-1   */
186     const opus_int16     *vec,           /* I   Input vector  [len]                   */
187     const opus_int32     len             /* I   Length of input vector                */
188 );
189
190 /* Compute number of bits to right shift the sum of squares of a vector    */
191 /* of int16s to make it fit in an int32                                    */
192 void silk_sum_sqr_shift(
193     opus_int32           *energy,        /* O   Energy of x, after shifting to the right            */
194     opus_int             *shift,         /* O   Number of bits right shift applied to energy        */
195     const opus_int16     *x,             /* I   Input vector                                        */
196     opus_int             len             /* I   Length of input vector                              */
197 );
198
199 /* Calculates the reflection coefficients from the correlation sequence    */
200 /* Faster than schur64(), but much less accurate.                          */
201 /* uses SMLAWB(), requiring armv5E and higher.                             */
202 opus_int32 silk_schur(                   /* O:    Returns residual energy                   */
203     opus_int16           *rc_Q15,        /* O:    reflection coefficients [order] Q15       */
204     const opus_int32     *c,             /* I:    correlations [order+1]                    */
205     const opus_int32     order           /* I:    prediction order                          */
206 );
207
208 /* Calculates the reflection coefficients from the correlation sequence    */
209 /* Slower than schur(), but more accurate.                                 */
210 /* Uses SMULL(), available on armv4                                        */
211 opus_int32 silk_schur64(                 /* O:  returns residual energy                     */
212     opus_int32           rc_Q16[],       /* O:  Reflection coefficients [order] Q16         */
213     const opus_int32     c[],            /* I:  Correlations [order+1]                      */
214     opus_int32           order           /* I:  Prediction order                            */
215 );
216
217 /* Step up function, converts reflection coefficients to prediction coefficients */
218 void silk_k2a(
219     opus_int32           *A_Q24,         /* O:  Prediction coefficients [order] Q24         */
220     const opus_int16     *rc_Q15,        /* I:  Reflection coefficients [order] Q15         */
221     const opus_int32     order           /* I:  Prediction order                            */
222 );
223
224 /* Step up function, converts reflection coefficients to prediction coefficients */
225 void silk_k2a_Q16(
226     opus_int32           *A_Q24,         /* O:  Prediction coefficients [order] Q24         */
227     const opus_int32     *rc_Q16,        /* I:  Reflection coefficients [order] Q16         */
228     const opus_int32     order           /* I:  Prediction order                            */
229 );
230
231 /* Apply sine window to signal vector.                                      */
232 /* Window types:                                                            */
233 /*    1 -> sine window from 0 to pi/2                                       */
234 /*    2 -> sine window from pi/2 to pi                                      */
235 /* every other sample of window is linearly interpolated, for speed         */
236 void silk_apply_sine_window(
237     opus_int16           px_win[],       /* O  Pointer to windowed signal                  */
238     const opus_int16     px[],           /* I  Pointer to input signal                     */
239     const opus_int       win_type,       /* I  Selects a window type                       */
240     const opus_int       length          /* I  Window length, multiple of 4                */
241 );
242
243 /* Compute autocorrelation */
244 void silk_autocorr(
245     opus_int32           *results,       /* O  Result (length correlationCount)            */
246     opus_int             *scale,         /* O  Scaling of the correlation vector           */
247     const opus_int16     *inputData,     /* I  Input data to correlate                     */
248     const opus_int       inputDataSize,  /* I  Length of input                             */
249     const opus_int       correlationCount /* I  Number of correlation taps to compute      */
250 );
251
252 /* Pitch estimator */
253 #define SILK_PE_MIN_COMPLEX        0
254 #define SILK_PE_MID_COMPLEX        1
255 #define SILK_PE_MAX_COMPLEX        2
256
257 void silk_decode_pitch(
258     opus_int16       lagIndex,                        /* I                             */
259     opus_int8        contourIndex,                    /* O                             */
260     opus_int         pitch_lags[],                    /* O 4 pitch values              */
261     const opus_int   Fs_kHz,                          /* I sampling frequency (kHz)    */
262     const opus_int   nb_subfr                         /* I number of sub frames        */
263 );
264
265 opus_int silk_pitch_analysis_core(        /* O    Voicing estimate: 0 voiced, 1 unvoiced                     */
266     const opus_int16  *signal,            /* I    Signal of length PE_FRAME_LENGTH_MS*Fs_kHz                 */
267     opus_int          *pitch_out,         /* O    4 pitch lag values                                         */
268     opus_int16        *lagIndex,          /* O    Lag Index                                                  */
269     opus_int8         *contourIndex,      /* O    Pitch contour Index                                        */
270     opus_int          *LTPCorr_Q15,       /* I/O  Normalized correlation; input: value from previous frame   */
271     opus_int          prevLag,            /* I    Last lag of previous frame; set to zero is unvoiced        */
272     const opus_int32  search_thres1_Q16,  /* I    First stage threshold for lag candidates 0 - 1             */
273     const opus_int    search_thres2_Q15,  /* I    Final threshold for lag candidates 0 - 1                   */
274     const opus_int    Fs_kHz,             /* I    Sample frequency (kHz)                                     */
275     const opus_int    complexity,         /* I    Complexity setting, 0-2, where 2 is highest                */
276     const opus_int    nb_subfr            /* I    number of 5 ms subframes                                   */
277 );
278
279 /* Compute Normalized Line Spectral Frequencies (NLSFs) from whitening filter coefficients      */
280 /* If not all roots are found, the a_Q16 coefficients are bandwidth expanded until convergence. */
281 void silk_A2NLSF(
282     opus_int16          *NLSF,            /* O    Normalized Line Spectral Frequencies, Q15 (0 - (2^15-1)), [d] */
283     opus_int32          *a_Q16,           /* I/O  Monic whitening filter coefficients in Q16 [d]                */
284     const opus_int      d                 /* I    Filter order (must be even)                                   */
285 );
286
287 /* compute whitening filter coefficients from normalized line spectral frequencies */
288 void silk_NLSF2A(
289     opus_int16        *a_Q12,            /* O    monic whitening filter coefficients in Q12,  [ d ]  */
290     const opus_int16  *NLSF,             /* I    normalized line spectral frequencies in Q15, [ d ]  */
291     const opus_int    d                  /* I    filter order (should be even)                       */
292 );
293
294 void silk_insertion_sort_increasing(
295     opus_int32            *a,            /* I/O   Unsorted / Sorted vector                */
296     opus_int              *idx,          /* O:    Index vector for the sorted elements    */
297     const opus_int        L,             /* I:    Vector length                           */
298     const opus_int        K              /* I:    Number of correctly sorted positions    */
299 );
300
301 void silk_insertion_sort_decreasing_int16(
302     opus_int16            *a,            /* I/O:  Unsorted / Sorted vector                */
303     opus_int              *idx,          /* O:    Index vector for the sorted elements    */
304     const opus_int        L,             /* I:    Vector length                           */
305     const opus_int        K              /* I:    Number of correctly sorted positions    */
306 );
307
308 void silk_insertion_sort_increasing_all_values_int16(
309      opus_int16           *a,            /* I/O:  Unsorted / Sorted vector                */
310      const opus_int       L              /* I:    Vector length                           */
311 );
312
313 /* NLSF stabilizer, for a single input data vector */
314 void silk_NLSF_stabilize(
315           opus_int16      *NLSF_Q15,      /* I/O:  Unstable/stabilized normalized LSF vector in Q15 [L]                    */
316     const opus_int16      *NDeltaMin_Q15, /* I:    Normalized delta min vector in Q15, NDeltaMin_Q15[L] must be >= 1 [L+1] */
317     const opus_int        L               /* I:    Number of NLSF parameters in the input vector                           */
318 );
319
320 /* Laroia low complexity NLSF weights */
321 void silk_NLSF_VQ_weights_laroia(
322     opus_int16            *pNLSFW_Q_OUT,  /* O:    Pointer to input vector weights            [D x 1]       */
323     const opus_int16      *pNLSF_Q15,     /* I:    Pointer to input vector                    [D x 1]       */
324     const opus_int        D               /* I:    Input vector dimension (even)                            */
325 );
326
327 /* Compute reflection coefficients from input signal */
328 void silk_burg_modified(
329     opus_int32            *res_nrg,           /* O   residual energy                                                 */
330     opus_int              *res_nrgQ,          /* O   residual energy Q value                                         */
331     opus_int32            A_Q16[],            /* O   prediction coefficients (length order)                          */
332     const opus_int16      x[],                /* I   input signal, length: nb_subfr * ( D + subfr_length )           */
333     const opus_int        subfr_length,       /* I   input signal subframe length (including D preceeding samples)   */
334     const opus_int        nb_subfr,           /* I   number of subframes stacked in x                                */
335     const opus_int32      WhiteNoiseFrac_Q32, /* I   fraction added to zero-lag autocorrelation                      */
336     const opus_int        D                   /* I   order                                                           */
337 );
338
339 /* Copy and multiply a vector by a constant */
340 void silk_scale_copy_vector16(
341     opus_int16            *data_out,
342     const opus_int16      *data_in,
343     opus_int32            gain_Q16,           /* I:   gain in Q16   */
344     const opus_int        dataSize            /* I:   length        */
345 );
346
347 /* Some for the LTP related function requires Q26 to work.*/
348 void silk_scale_vector32_Q26_lshift_18(
349     opus_int32            *data1,             /* I/O: Q0/Q18        */
350     opus_int32            gain_Q26,           /* I:   Q26           */
351     opus_int              dataSize            /* I:   length        */
352 );
353
354 /********************************************************************/
355 /*                        INLINE ARM MATH                             */
356 /********************************************************************/
357
358 /*    return sum(inVec1[i]*inVec2[i])    */
359 opus_int32 silk_inner_prod_aligned(
360     const opus_int16 *const  inVec1,     /*    I input vector 1    */
361     const opus_int16 *const  inVec2,     /*    I input vector 2    */
362     const opus_int           len         /*    I vector lengths    */
363 );
364
365 opus_int32 silk_inner_prod_aligned_scale(
366     const opus_int16 *const  inVec1,     /*    I input vector 1          */
367     const opus_int16 *const  inVec2,     /*    I input vector 2          */
368     const opus_int           scale,      /*    I number of bits to shift */
369     const opus_int           len         /*    I vector lengths          */
370 );
371
372 opus_int64 silk_inner_prod16_aligned_64(
373     const opus_int16         *inVec1,    /*    I input vector 1    */
374     const opus_int16         *inVec2,    /*    I input vector 2    */
375     const opus_int           len         /*    I vector lengths    */
376 );
377
378 /********************************************************************/
379 /*                                MACROS                            */
380 /********************************************************************/
381
382 /* Rotate a32 right by 'rot' bits. Negative rot values result in rotating
383    left. Output is 32bit int.
384    Note: contemporary compilers recognize the C expression below and
385    compile it into a 'ror' instruction if available. No need for inline ASM! */
386 static inline opus_int32 silk_ROR32( opus_int32 a32, opus_int rot )
387 {
388     opus_uint32 x = (opus_uint32) a32;
389     opus_uint32 r = (opus_uint32) rot;
390     opus_uint32 m = (opus_uint32) -rot;
391     if (rot==0)
392        return a32;
393     else if(rot < 0)
394         return (opus_int32) ((x << m) | (x >> (32 - m)));
395     else
396         return (opus_int32) ((x << (32 - r)) | (x >> r));
397 }
398
399 /* Allocate opus_int16 alligned to 4-byte memory address */
400 #if EMBEDDED_ARM
401 #define silk_DWORD_ALIGN __attribute__((aligned(4)))
402 #else
403 #define silk_DWORD_ALIGN
404 #endif
405
406 /* Useful Macros that can be adjusted to other platforms */
407 #define silk_memcpy(a, b, c)                memcpy((a), (b), (c))    /* Dest, Src, ByteCount */
408 #define silk_memset(a, b, c)                memset((a), (b), (c))    /* Dest, value, ByteCount */
409 #define silk_memmove(a, b, c)               memmove((a), (b), (c))   /* Dest, Src, ByteCount */
410 /* fixed point macros */
411
412 /* (a32 * b32) output have to be 32bit int */
413 #define silk_MUL(a32, b32)                  ((a32) * (b32))
414
415 /* (a32 * b32) output have to be 32bit uint */
416 #define silk_MUL_uint(a32, b32)             silk_MUL(a32, b32)
417
418 /* a32 + (b32 * c32) output have to be 32bit int */
419 #define silk_MLA(a32, b32, c32)             silk_ADD32((a32),((b32) * (c32)))
420
421 /* a32 + (b32 * c32) output have to be 32bit uint */
422 #define silk_MLA_uint(a32, b32, c32)        silk_MLA(a32, b32, c32)
423
424 /* ((a32 >> 16)  * (b32 >> 16)) output have to be 32bit int */
425 #define silk_SMULTT(a32, b32)               (((a32) >> 16) * ((b32) >> 16))
426
427 /* a32 + ((a32 >> 16)  * (b32 >> 16)) output have to be 32bit int */
428 #define silk_SMLATT(a32, b32, c32)          silk_ADD32((a32),((b32) >> 16) * ((c32) >> 16))
429
430 #define silk_SMLALBB(a64, b16, c16)         silk_ADD64((a64),(opus_int64)((opus_int32)(b16) * (opus_int32)(c16)))
431
432 /* (a32 * b32) */
433 #define silk_SMULL(a32, b32)                ((opus_int64)(a32) * /*(opus_int64)*/(b32))
434
435 /* Adds two signed 32-bit values in a way that can overflow, while not relying on undefined behaviour
436    (just standard two's complement implementation-specific behaviour) */
437 #define silk_ADD32_ovflw(a, b)              ((opus_int32)((opus_uint32)(a) + (opus_uint32)(b)))
438
439 /* Multiply-accumulate macros that allow overflow in the addition (ie, no asserts in debug mode)*/
440 #define silk_MLA_ovflw(a32, b32, c32)       silk_ADD32_ovflw((a32), (opus_uint32)(b32) * (opus_uint32)(c32))
441 #ifndef silk_SMLABB_ovflw
442 #    define silk_SMLABB_ovflw(a32, b32, c32)    silk_ADD32_ovflw((a32), (opus_int32)((opus_int16)(b32)) * (opus_int32)((opus_int16)(c32)))
443 #endif
444
445 #define silk_DIV32_16(a32, b16)             ((opus_int32)((a32) / (b16)))
446 #define silk_DIV32(a32, b32)                ((opus_int32)((a32) / (b32)))
447
448 /* These macros enables checking for overflow in silk_API_Debug.h*/
449 #define silk_ADD16(a, b)                    ((a) + (b))
450 #define silk_ADD32(a, b)                    ((a) + (b))
451 #define silk_ADD64(a, b)                    ((a) + (b))
452
453 #define silk_SUB16(a, b)                    ((a) - (b))
454 #define silk_SUB32(a, b)                    ((a) - (b))
455 #define silk_SUB64(a, b)                    ((a) - (b))
456
457 #define silk_SAT8(a)                        ((a) > silk_int8_MAX ? silk_int8_MAX  : \
458                                            ((a) < silk_int8_MIN ? silk_int8_MIN  : (a)))
459 #define silk_SAT16(a)                       ((a) > silk_int16_MAX ? silk_int16_MAX : \
460                                            ((a) < silk_int16_MIN ? silk_int16_MIN : (a)))
461 #define silk_SAT32(a)                       ((a) > silk_int32_MAX ? silk_int32_MAX : \
462                                            ((a) < silk_int32_MIN ? silk_int32_MIN : (a)))
463
464 #define silk_CHECK_FIT8(a)                  (a)
465 #define silk_CHECK_FIT16(a)                 (a)
466 #define silk_CHECK_FIT32(a)                 (a)
467
468 #define silk_ADD_SAT16(a, b)                (opus_int16)silk_SAT16( silk_ADD32( (opus_int32)(a), (b) ) )
469 #define silk_ADD_SAT64(a, b)                ((((a) + (b)) & 0x8000000000000000LL) == 0 ?                            \
470                                            ((((a) & (b)) & 0x8000000000000000LL) != 0 ? silk_int64_MIN : (a)+(b)) :    \
471                                            ((((a) | (b)) & 0x8000000000000000LL) == 0 ? silk_int64_MAX : (a)+(b)) )
472
473 #define silk_SUB_SAT16(a, b)                (opus_int16)silk_SAT16( silk_SUB32( (opus_int32)(a), (b) ) )
474 #define silk_SUB_SAT64(a, b)                ((((a)-(b)) & 0x8000000000000000LL) == 0 ?                                                    \
475                                            (( (a) & ((b)^0x8000000000000000LL) & 0x8000000000000000LL) ? silk_int64_MIN : (a)-(b)) :    \
476                                            ((((a)^0x8000000000000000LL) & (b)  & 0x8000000000000000LL) ? silk_int64_MAX : (a)-(b)) )
477
478 /* Saturation for positive input values */
479 #define silk_POS_SAT32(a)                   ((a) > silk_int32_MAX ? silk_int32_MAX : (a))
480
481 /* Add with saturation for positive input values */
482 #define silk_ADD_POS_SAT8(a, b)             ((((a)+(b)) & 0x80)                 ? silk_int8_MAX  : ((a)+(b)))
483 #define silk_ADD_POS_SAT16(a, b)            ((((a)+(b)) & 0x8000)               ? silk_int16_MAX : ((a)+(b)))
484 #define silk_ADD_POS_SAT32(a, b)            ((((a)+(b)) & 0x80000000)           ? silk_int32_MAX : ((a)+(b)))
485 #define silk_ADD_POS_SAT64(a, b)            ((((a)+(b)) & 0x8000000000000000LL) ? silk_int64_MAX : ((a)+(b)))
486
487 #define silk_LSHIFT8(a, shift)              ((opus_int8)((opus_uint8)(a)<<(shift)))                /* shift >= 0, shift < 8  */
488 #define silk_LSHIFT16(a, shift)             ((opus_int16)((opus_uint16)(a)<<(shift)))                /* shift >= 0, shift < 16 */
489 #define silk_LSHIFT32(a, shift)             ((opus_int32)((opus_uint32)(a)<<(shift)))                /* shift >= 0, shift < 32 */
490 #define silk_LSHIFT64(a, shift)             ((opus_int64)((opus_uint64)(a)<<(shift)))                /* shift >= 0, shift < 64 */
491 #define silk_LSHIFT(a, shift)               silk_LSHIFT32(a, shift)        /* shift >= 0, shift < 32 */
492
493 #define silk_RSHIFT8(a, shift)              ((a)>>(shift))                /* shift >= 0, shift < 8  */
494 #define silk_RSHIFT16(a, shift)             ((a)>>(shift))                /* shift >= 0, shift < 16 */
495 #define silk_RSHIFT32(a, shift)             ((a)>>(shift))                /* shift >= 0, shift < 32 */
496 #define silk_RSHIFT64(a, shift)             ((a)>>(shift))                /* shift >= 0, shift < 64 */
497 #define silk_RSHIFT(a, shift)               silk_RSHIFT32(a, shift)        /* shift >= 0, shift < 32 */
498
499 /* saturates before shifting */
500 #define silk_LSHIFT_SAT16(a, shift)         (silk_LSHIFT16( silk_LIMIT( (a), silk_RSHIFT16( silk_int16_MIN, (shift) ),    \
501                                                                           silk_RSHIFT16( silk_int16_MAX, (shift) ) ), (shift) ))
502 #define silk_LSHIFT_SAT32(a, shift)         (silk_LSHIFT32( silk_LIMIT( (a), silk_RSHIFT32( silk_int32_MIN, (shift) ),    \
503                                                                           silk_RSHIFT32( silk_int32_MAX, (shift) ) ), (shift) ))
504
505 #define silk_LSHIFT_uint(a, shift)         ((a)<<(shift))        /* shift >= 0 */
506 #define silk_RSHIFT_uint(a, shift)         ((a)>>(shift))        /* shift >= 0 */
507
508 #define silk_ADD_LSHIFT(a, b, shift)       ((a) + silk_LSHIFT((b), (shift)))             /* shift >= 0 */
509 #define silk_ADD_LSHIFT32(a, b, shift)     silk_ADD32((a), silk_LSHIFT32((b), (shift)))   /* shift >= 0 */
510 #define silk_ADD_LSHIFT_uint(a, b, shift)  ((a) + silk_LSHIFT_uint((b), (shift)))        /* shift >= 0 */
511 #define silk_ADD_RSHIFT(a, b, shift)       ((a) + silk_RSHIFT((b), (shift)))             /* shift >= 0 */
512 #define silk_ADD_RSHIFT32(a, b, shift)     silk_ADD32((a), silk_RSHIFT32((b), (shift)))   /* shift >= 0 */
513 #define silk_ADD_RSHIFT_uint(a, b, shift)  ((a) + silk_RSHIFT_uint((b), (shift)))        /* shift >= 0 */
514 #define silk_SUB_LSHIFT32(a, b, shift)     silk_SUB32((a), silk_LSHIFT32((b), (shift)))   /* shift >= 0 */
515 #define silk_SUB_RSHIFT32(a, b, shift)     silk_SUB32((a), silk_RSHIFT32((b), (shift)))   /* shift >= 0 */
516
517 /* Requires that shift > 0 */
518 #define silk_RSHIFT_ROUND(a, shift)        ((shift) == 1 ? ((a) >> 1) + ((a) & 1) : (((a) >> ((shift) - 1)) + 1) >> 1)
519 #define silk_RSHIFT_ROUND64(a, shift)      ((shift) == 1 ? ((a) >> 1) + ((a) & 1) : (((a) >> ((shift) - 1)) + 1) >> 1)
520
521 /* Number of rightshift required to fit the multiplication */
522 #define silk_NSHIFT_MUL_32_32(a, b)        ( -(31- (32-silk_CLZ32(silk_abs(a)) + (32-silk_CLZ32(silk_abs(b))))) )
523 #define silk_NSHIFT_MUL_16_16(a, b)        ( -(15- (16-silk_CLZ16(silk_abs(a)) + (16-silk_CLZ16(silk_abs(b))))) )
524
525
526 #define silk_min(a, b)                     (((a) < (b)) ? (a) : (b))
527 #define silk_max(a, b)                     (((a) > (b)) ? (a) : (b))
528
529 /* Macro to convert floating-point constants to fixed-point */
530 #define SILK_FIX_CONST( C, Q )           ((opus_int32)((C) * ((opus_int64)1 << (Q)) + 0.5))
531
532 /* silk_min() versions with typecast in the function call */
533 static inline opus_int silk_min_int(opus_int a, opus_int b)
534 {
535     return (((a) < (b)) ? (a) : (b));
536 }
537 static inline opus_int16 silk_min_16(opus_int16 a, opus_int16 b)
538 {
539     return (((a) < (b)) ? (a) : (b));
540 }
541 static inline opus_int32 silk_min_32(opus_int32 a, opus_int32 b)
542 {
543     return (((a) < (b)) ? (a) : (b));
544 }
545 static inline opus_int64 silk_min_64(opus_int64 a, opus_int64 b)
546 {
547     return (((a) < (b)) ? (a) : (b));
548 }
549
550 /* silk_min() versions with typecast in the function call */
551 static inline opus_int silk_max_int(opus_int a, opus_int b)
552 {
553     return (((a) > (b)) ? (a) : (b));
554 }
555 static inline opus_int16 silk_max_16(opus_int16 a, opus_int16 b)
556 {
557     return (((a) > (b)) ? (a) : (b));
558 }
559 static inline opus_int32 silk_max_32(opus_int32 a, opus_int32 b)
560 {
561     return (((a) > (b)) ? (a) : (b));
562 }
563 static inline opus_int64 silk_max_64(opus_int64 a, opus_int64 b)
564 {
565     return (((a) > (b)) ? (a) : (b));
566 }
567
568 #define silk_LIMIT( a, limit1, limit2)    ((limit1) > (limit2) ? ((a) > (limit1) ? (limit1) : ((a) < (limit2) ? (limit2) : (a))) \
569                                                              : ((a) > (limit2) ? (limit2) : ((a) < (limit1) ? (limit1) : (a))))
570
571 #define silk_LIMIT_int silk_LIMIT
572 #define silk_LIMIT_16 silk_LIMIT
573 #define silk_LIMIT_32 silk_LIMIT
574
575 /*#define silk_non_neg(a)                 ((a) & ((-(a)) >> (8 * sizeof(a) - 1)))*/   /* doesn't seem faster than silk_max(0, a);*/
576
577 #define silk_abs(a)                       (((a) >  0)  ? (a) : -(a))            /* Be careful, silk_abs returns wrong when input equals to silk_intXX_MIN */
578 #define silk_abs_int(a)                   (((a) ^ ((a) >> (8 * sizeof(a) - 1))) - ((a) >> (8 * sizeof(a) - 1)))
579 #define silk_abs_int32(a)                 (((a) ^ ((a) >> 31)) - ((a) >> 31))
580 #define silk_abs_int64(a)                 (((a) >  0)  ? (a) : -(a))
581
582 #define silk_sign(a)                      ((a) > 0 ? 1 : ( (a) < 0 ? -1 : 0 ))
583
584 #define silk_sqrt(a)                      (sqrt(a))
585
586 /* PSEUDO-RANDOM GENERATOR                                                          */
587 /* Make sure to store the result as the seed for the next call (also in between     */
588 /* frames), otherwise result won't be random at all. When only using some of the    */
589 /* bits, take the most significant bits by right-shifting.                          */
590 #define silk_RAND(seed)                   (silk_MLA_ovflw(907633515, (seed), 196314165))
591
592 /*  Add some multiplication functions that can be easily mapped to ARM. */
593
594 /*    silk_SMMUL: Signed top word multiply.
595           ARMv6        2 instruction cycles.
596           ARMv3M+        3 instruction cycles. use SMULL and ignore LSB registers.(except xM)*/
597 /*#define silk_SMMUL(a32, b32)            (opus_int32)silk_RSHIFT(silk_SMLAL(silk_SMULWB((a32), (b32)), (a32), silk_RSHIFT_ROUND((b32), 16)), 16)*/
598 /* the following seems faster on x86 */
599 #define silk_SMMUL(a32, b32)              (opus_int32)silk_RSHIFT64(silk_SMULL((a32), (b32)), 32)
600
601 #include "Inlines.h"
602 #include "MacroCount.h"
603 #include "MacroDebug.h"
604
605 #ifdef  __cplusplus
606 }
607 #endif
608
609 #endif