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