Adds 3rd clause to CELT license
[opus.git] / celt / _kiss_fft_guts.h
1 /*Copyright (c) 2003-2004, Mark Borgerding
2
3   All rights reserved.
4
5   Redistribution and use in source and binary forms, with or without
6    modification, are permitted provided that the following conditions are met:
7
8     * Redistributions of source code must retain the above copyright notice,
9        this list of conditions and the following disclaimer.
10     * Redistributions in binary form must reproduce the above copyright notice,
11        this list of conditions and the following disclaimer in the
12        documentation and/or other materials provided with the distribution.
13
14    - Neither the name of Internet Society, IETF or IETF Trust, nor the
15    names of specific contributors, may be used to endorse or promote
16    products derived from this software without specific prior written
17    permission.
18
19   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29   POSSIBILITY OF SUCH DAMAGE.*/
30
31 #ifndef KISS_FFT_GUTS_H
32 #define KISS_FFT_GUTS_H
33
34 #define MIN(a,b) ((a)<(b) ? (a):(b))
35 #define MAX(a,b) ((a)>(b) ? (a):(b))
36
37 /* kiss_fft.h
38    defines kiss_fft_scalar as either short or a float type
39    and defines
40    typedef struct { kiss_fft_scalar r; kiss_fft_scalar i; }kiss_fft_cpx; */
41 #include "kiss_fft.h"
42
43 /*
44   Explanation of macros dealing with complex math:
45
46    C_MUL(m,a,b)         : m = a*b
47    C_FIXDIV( c , div )  : if a fixed point impl., c /= div. noop otherwise
48    C_SUB( res, a,b)     : res = a - b
49    C_SUBFROM( res , a)  : res -= a
50    C_ADDTO( res , a)    : res += a
51  * */
52 #ifdef FIXED_POINT
53 #include "arch.h"
54
55
56 # define SAMPPROD long long
57 #define SAMP_MAX 2147483647
58 #define TWID_MAX 32767
59 #define TRIG_UPSCALE 1
60
61 #define SAMP_MIN -SAMP_MAX
62
63
64 #   define S_MUL(a,b) MULT16_32_Q15(b, a)
65
66 #   define C_MUL(m,a,b) \
67       do{ (m).r = SUB32(S_MUL((a).r,(b).r) , S_MUL((a).i,(b).i)); \
68           (m).i = ADD32(S_MUL((a).r,(b).i) , S_MUL((a).i,(b).r)); }while(0)
69
70 #   define C_MULC(m,a,b) \
71       do{ (m).r = ADD32(S_MUL((a).r,(b).r) , S_MUL((a).i,(b).i)); \
72           (m).i = SUB32(S_MUL((a).i,(b).r) , S_MUL((a).r,(b).i)); }while(0)
73
74 #   define C_MUL4(m,a,b) \
75       do{ (m).r = SHR(SUB32(S_MUL((a).r,(b).r) , S_MUL((a).i,(b).i)),2); \
76           (m).i = SHR(ADD32(S_MUL((a).r,(b).i) , S_MUL((a).i,(b).r)),2); }while(0)
77
78 #   define C_MULBYSCALAR( c, s ) \
79       do{ (c).r =  S_MUL( (c).r , s ) ;\
80           (c).i =  S_MUL( (c).i , s ) ; }while(0)
81
82 #   define DIVSCALAR(x,k) \
83         (x) = S_MUL(  x, (TWID_MAX-((k)>>1))/(k)+1 )
84
85 #   define C_FIXDIV(c,div) \
86         do {    DIVSCALAR( (c).r , div);  \
87                 DIVSCALAR( (c).i  , div); }while (0)
88
89 #define  C_ADD( res, a,b)\
90     do {(res).r=ADD32((a).r,(b).r);  (res).i=ADD32((a).i,(b).i); \
91     }while(0)
92 #define  C_SUB( res, a,b)\
93     do {(res).r=SUB32((a).r,(b).r);  (res).i=SUB32((a).i,(b).i); \
94     }while(0)
95 #define C_ADDTO( res , a)\
96     do {(res).r = ADD32((res).r, (a).r);  (res).i = ADD32((res).i,(a).i);\
97     }while(0)
98
99 #define C_SUBFROM( res , a)\
100     do {(res).r = ADD32((res).r,(a).r);  (res).i = SUB32((res).i,(a).i); \
101     }while(0)
102
103 #else  /* not FIXED_POINT*/
104
105 #   define S_MUL(a,b) ( (a)*(b) )
106 #define C_MUL(m,a,b) \
107     do{ (m).r = (a).r*(b).r - (a).i*(b).i;\
108         (m).i = (a).r*(b).i + (a).i*(b).r; }while(0)
109 #define C_MULC(m,a,b) \
110     do{ (m).r = (a).r*(b).r + (a).i*(b).i;\
111         (m).i = (a).i*(b).r - (a).r*(b).i; }while(0)
112
113 #define C_MUL4(m,a,b) C_MUL(m,a,b)
114
115 #   define C_FIXDIV(c,div) /* NOOP */
116 #   define C_MULBYSCALAR( c, s ) \
117     do{ (c).r *= (s);\
118         (c).i *= (s); }while(0)
119 #endif
120
121 #ifndef CHECK_OVERFLOW_OP
122 #  define CHECK_OVERFLOW_OP(a,op,b) /* noop */
123 #endif
124
125 #ifndef C_ADD
126 #define  C_ADD( res, a,b)\
127     do { \
128             CHECK_OVERFLOW_OP((a).r,+,(b).r)\
129             CHECK_OVERFLOW_OP((a).i,+,(b).i)\
130             (res).r=(a).r+(b).r;  (res).i=(a).i+(b).i; \
131     }while(0)
132 #define  C_SUB( res, a,b)\
133     do { \
134             CHECK_OVERFLOW_OP((a).r,-,(b).r)\
135             CHECK_OVERFLOW_OP((a).i,-,(b).i)\
136             (res).r=(a).r-(b).r;  (res).i=(a).i-(b).i; \
137     }while(0)
138 #define C_ADDTO( res , a)\
139     do { \
140             CHECK_OVERFLOW_OP((res).r,+,(a).r)\
141             CHECK_OVERFLOW_OP((res).i,+,(a).i)\
142             (res).r += (a).r;  (res).i += (a).i;\
143     }while(0)
144
145 #define C_SUBFROM( res , a)\
146     do {\
147             CHECK_OVERFLOW_OP((res).r,-,(a).r)\
148             CHECK_OVERFLOW_OP((res).i,-,(a).i)\
149             (res).r -= (a).r;  (res).i -= (a).i; \
150     }while(0)
151 #endif /* C_ADD defined */
152
153 #ifdef FIXED_POINT
154 /*#  define KISS_FFT_COS(phase)  TRIG_UPSCALE*floor(MIN(32767,MAX(-32767,.5+32768 * cos (phase))))
155 #  define KISS_FFT_SIN(phase)  TRIG_UPSCALE*floor(MIN(32767,MAX(-32767,.5+32768 * sin (phase))))*/
156 #  define KISS_FFT_COS(phase)  floor(.5+TWID_MAX*cos (phase))
157 #  define KISS_FFT_SIN(phase)  floor(.5+TWID_MAX*sin (phase))
158 #  define HALF_OF(x) ((x)>>1)
159 #elif defined(USE_SIMD)
160 #  define KISS_FFT_COS(phase) _mm_set1_ps( cos(phase) )
161 #  define KISS_FFT_SIN(phase) _mm_set1_ps( sin(phase) )
162 #  define HALF_OF(x) ((x)*_mm_set1_ps(.5f))
163 #else
164 #  define KISS_FFT_COS(phase) (kiss_fft_scalar) cos(phase)
165 #  define KISS_FFT_SIN(phase) (kiss_fft_scalar) sin(phase)
166 #  define HALF_OF(x) ((x)*.5f)
167 #endif
168
169 #define  kf_cexp(x,phase) \
170         do{ \
171                 (x)->r = KISS_FFT_COS(phase);\
172                 (x)->i = KISS_FFT_SIN(phase);\
173         }while(0)
174
175 #define  kf_cexp2(x,phase) \
176    do{ \
177       (x)->r = TRIG_UPSCALE*celt_cos_norm((phase));\
178       (x)->i = TRIG_UPSCALE*celt_cos_norm((phase)-32768);\
179 }while(0)
180
181 #endif /* KISS_FFT_GUTS_H */