fixed-point: done converting quant_bands() and unquant_bands()
[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 #ifndef KISS_FFT_GUTS_H
16 #define KISS_FFT_GUTS_H
17
18 #define MIN(a,b) ((a)<(b) ? (a):(b))
19 #define MAX(a,b) ((a)>(b) ? (a):(b))
20
21 /* kiss_fft.h
22    defines kiss_fft_scalar as either short or a float type
23    and defines
24    typedef struct { kiss_fft_scalar r; kiss_fft_scalar i; }kiss_fft_cpx; */
25 #include "kiss_fft.h"
26
27 #define MAXFACTORS 32
28 /* e.g. an fft of length 128 has 4 factors 
29  as far as kissfft is concerned
30  4*4*4*2
31  */
32
33 struct kiss_fft_state{
34     int nfft;
35 #ifndef FIXED_POINT
36     kiss_fft_scalar scale;
37 #endif
38     int factors[2*MAXFACTORS];
39     int *bitrev;
40     kiss_twiddle_cpx twiddles[1];
41 };
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 #ifdef DOUBLE_PRECISION
56
57 # define FRACBITS 31
58 # define SAMPPROD celt_int64_t 
59 #define SAMP_MAX 2147483647
60 #ifdef MIXED_PRECISION
61 #define TWID_MAX 32767
62 #define TRIG_UPSCALE 1
63 #else
64 #define TRIG_UPSCALE 65536
65 #define TWID_MAX 2147483647
66 #endif
67 #define EXT32(a) (a)
68
69 #else /* DOUBLE_PRECISION */
70
71 # define FRACBITS 15
72 # define SAMPPROD celt_int32_t 
73 #define SAMP_MAX 32767
74 #define TRIG_UPSCALE 1
75 #define EXT32(a) EXTEND32(a)
76
77 #endif /* !DOUBLE_PRECISION */
78
79 #define SAMP_MIN -SAMP_MAX
80
81 #if defined(CHECK_OVERFLOW)
82 #  define CHECK_OVERFLOW_OP(a,op,b)  \
83         if ( (SAMPPROD)(a) op (SAMPPROD)(b) > SAMP_MAX || (SAMPPROD)(a) op (SAMPPROD)(b) < SAMP_MIN ) { \
84                 fprintf(stderr,"WARNING:overflow @ " __FILE__ "(%d): (%d " #op" %d) = %ld\n",__LINE__,(a),(b),(SAMPPROD)(a) op (SAMPPROD)(b) );  }
85 #endif
86
87 #   define smul(a,b) ( (SAMPPROD)(a)*(b) )
88 #   define sround( x )  (kiss_fft_scalar)( ( (x) + ((SAMPPROD)1<<(FRACBITS-1)) ) >> FRACBITS )
89
90 #ifdef MIXED_PRECISION
91
92 #undef MULT16_32_Q15
93 #define MULT16_16SU(a,b) ((celt_word32_t)(celt_word16_t)(a)*(celt_word32_t)(celt_uint16_t)(b))
94 /*#define MULT16_32_Q15(a,b) ADD32(MULT16_16((a),SHR((b),15)), SHR(MULT16_16((a),((b)&0x00007fff)),15))*/
95 #define MULT16_32_Q15(a,b) ADD32(SHL(MULT16_16((a),SHR((b),16)),1), SHR(MULT16_16SU((a),((b)&0x0000ffff)),15))
96
97 #   define S_MUL(a,b) MULT16_32_Q15(b, a)
98
99 #   define C_MUL(m,a,b) \
100       do{ (m).r = S_MUL((a).r,(b).r) - S_MUL((a).i,(b).i); \
101           (m).i = S_MUL((a).r,(b).i) + S_MUL((a).i,(b).r); }while(0)
102
103 #   define C_MULC(m,a,b) \
104       do{ (m).r = S_MUL((a).r,(b).r) + S_MUL((a).i,(b).i); \
105           (m).i = S_MUL((a).i,(b).r) - S_MUL((a).r,(b).i); }while(0)
106
107 #   define C_MUL4(m,a,b) \
108       do{ (m).r = SHR(S_MUL((a).r,(b).r) - S_MUL((a).i,(b).i),2); \
109           (m).i = SHR(S_MUL((a).r,(b).i) + S_MUL((a).i,(b).r),2); }while(0)
110
111 #   define C_MULBYSCALAR( c, s ) \
112       do{ (c).r =  S_MUL( (c).r , s ) ;\
113           (c).i =  S_MUL( (c).i , s ) ; }while(0)
114
115 #   define DIVSCALAR(x,k) \
116         (x) = S_MUL(  x, (TWID_MAX-((k)>>1))/(k)+1 )
117
118 #   define C_FIXDIV(c,div) \
119         do {    DIVSCALAR( (c).r , div);  \
120                 DIVSCALAR( (c).i  , div); }while (0)
121
122 #else /* MIXED_PRECISION */
123 #   define sround4( x )  (kiss_fft_scalar)( ( (x) + ((SAMPPROD)1<<(FRACBITS-1)) ) >> (FRACBITS+2) )
124
125 #   define S_MUL(a,b) sround( smul(a,b) )
126
127 #   define C_MUL(m,a,b) \
128       do{ (m).r = sround( smul((a).r,(b).r) - smul((a).i,(b).i) ); \
129           (m).i = sround( smul((a).r,(b).i) + smul((a).i,(b).r) ); }while(0)
130 #   define C_MULC(m,a,b) \
131       do{ (m).r = sround( smul((a).r,(b).r) + smul((a).i,(b).i) ); \
132           (m).i = sround( smul((a).i,(b).r) - smul((a).r,(b).i) ); }while(0)
133
134 #   define C_MUL4(m,a,b) \
135                do{ (m).r = sround4( smul((a).r,(b).r) - smul((a).i,(b).i) ); \
136                (m).i = sround4( smul((a).r,(b).i) + smul((a).i,(b).r) ); }while(0)
137
138 #   define C_MULBYSCALAR( c, s ) \
139                do{ (c).r =  sround( smul( (c).r , s ) ) ;\
140                (c).i =  sround( smul( (c).i , s ) ) ; }while(0)
141
142 #   define DIVSCALAR(x,k) \
143         (x) = sround( smul(  x, SAMP_MAX/k ) )
144
145 #   define C_FIXDIV(c,div) \
146         do {    DIVSCALAR( (c).r , div);  \
147                 DIVSCALAR( (c).i  , div); }while (0)
148
149 #endif /* !MIXED_PRECISION */
150
151
152
153 #else  /* not FIXED_POINT*/
154
155 #define EXT32(a) (a)
156
157 #   define S_MUL(a,b) ( (a)*(b) )
158 #define C_MUL(m,a,b) \
159     do{ (m).r = (a).r*(b).r - (a).i*(b).i;\
160         (m).i = (a).r*(b).i + (a).i*(b).r; }while(0)
161 #define C_MULC(m,a,b) \
162     do{ (m).r = (a).r*(b).r + (a).i*(b).i;\
163         (m).i = (a).i*(b).r - (a).r*(b).i; }while(0)
164
165 #define C_MUL4(m,a,b) C_MUL(m,a,b)
166
167 #   define C_FIXDIV(c,div) /* NOOP */
168 #   define C_MULBYSCALAR( c, s ) \
169     do{ (c).r *= (s);\
170         (c).i *= (s); }while(0)
171 #endif
172
173 #ifndef CHECK_OVERFLOW_OP
174 #  define CHECK_OVERFLOW_OP(a,op,b) /* noop */
175 #endif
176
177 #define  C_ADD( res, a,b)\
178     do { \
179             CHECK_OVERFLOW_OP((a).r,+,(b).r)\
180             CHECK_OVERFLOW_OP((a).i,+,(b).i)\
181             (res).r=(a).r+(b).r;  (res).i=(a).i+(b).i; \
182     }while(0)
183 #define  C_SUB( res, a,b)\
184     do { \
185             CHECK_OVERFLOW_OP((a).r,-,(b).r)\
186             CHECK_OVERFLOW_OP((a).i,-,(b).i)\
187             (res).r=(a).r-(b).r;  (res).i=(a).i-(b).i; \
188     }while(0)
189 #define C_ADDTO( res , a)\
190     do { \
191             CHECK_OVERFLOW_OP((res).r,+,(a).r)\
192             CHECK_OVERFLOW_OP((res).i,+,(a).i)\
193             (res).r += (a).r;  (res).i += (a).i;\
194     }while(0)
195
196 #define C_SUBFROM( res , a)\
197     do {\
198             CHECK_OVERFLOW_OP((res).r,-,(a).r)\
199             CHECK_OVERFLOW_OP((res).i,-,(a).i)\
200             (res).r -= (a).r;  (res).i -= (a).i; \
201     }while(0)
202
203
204 #ifdef FIXED_POINT
205 /*#  define KISS_FFT_COS(phase)  TRIG_UPSCALE*floor(MIN(32767,MAX(-32767,.5+32768 * cos (phase))))
206 #  define KISS_FFT_SIN(phase)  TRIG_UPSCALE*floor(MIN(32767,MAX(-32767,.5+32768 * sin (phase))))*/
207 #  define KISS_FFT_COS(phase)  floor(.5+TWID_MAX*cos (phase))
208 #  define KISS_FFT_SIN(phase)  floor(.5+TWID_MAX*sin (phase))
209 #  define HALF_OF(x) ((x)>>1)
210 #elif defined(USE_SIMD)
211 #  define KISS_FFT_COS(phase) _mm_set1_ps( cos(phase) )
212 #  define KISS_FFT_SIN(phase) _mm_set1_ps( sin(phase) )
213 #  define HALF_OF(x) ((x)*_mm_set1_ps(.5))
214 #else
215 #  define KISS_FFT_COS(phase) (kiss_fft_scalar) cos(phase)
216 #  define KISS_FFT_SIN(phase) (kiss_fft_scalar) sin(phase)
217 #  define HALF_OF(x) ((x)*.5)
218 #endif
219
220 #define  kf_cexp(x,phase) \
221         do{ \
222                 (x)->r = KISS_FFT_COS(phase);\
223                 (x)->i = KISS_FFT_SIN(phase);\
224         }while(0)
225    
226 #define  kf_cexp2(x,phase) \
227    do{ \
228       (x)->r = TRIG_UPSCALE*celt_cos_norm((phase));\
229       (x)->i = TRIG_UPSCALE*celt_cos_norm((phase)-32768);\
230 }while(0)
231
232 /* a debugging function */
233 #define pcpx(c)\
234     fprintf(stderr,"%g + %gi\n",(double)((c)->r),(double)((c)->i) )
235
236 #endif /* KISS_FFT_GUTS_H */