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