778d2f271c7bec262dd584dae0ff6052bc12bbfb
[opus.git] / libcelt / kiss_fft.h
1 /*
2 Copyright (c) 2003-2004, Mark Borgerding
3 Lots of modifications by Jean-Marc Valin
4 Copyright (c) 2005-2007, Xiph.Org Foundation
5 Copyright (c) 2008,      Xiph.Org Foundation, CSIRO
6
7 All rights reserved.
8
9 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
10
11     * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
12     * 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.
13
14 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.
15 */
16
17
18 #ifndef KISS_FFT_H
19 #define KISS_FFT_H
20
21 #include <stdlib.h>
22 #include <math.h>
23 #include "arch.h"
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 /*
30  ATTENTION!
31  If you would like a :
32  -- a utility that will handle the caching of fft objects
33  -- real-only (no imaginary time component ) FFT
34  -- a multi-dimensional FFT
35  -- a command-line utility to perform ffts
36  -- a command-line utility to perform fast-convolution filtering
37
38  Then see kfc.h kiss_fftr.h kiss_fftnd.h fftutil.c kiss_fastfir.c
39   in the tools/ directory.
40 */
41
42 #ifdef USE_SIMD
43 # include <xmmintrin.h>
44 # define kiss_fft_scalar __m128
45 #define KISS_FFT_MALLOC(nbytes) memalign(16,nbytes)
46 #else   
47 #define KISS_FFT_MALLOC celt_alloc
48 #endif  
49
50
51 #ifdef FIXED_POINT
52 #include "arch.h"       
53 #define DOUBLE_PRECISION
54
55 #ifdef DOUBLE_PRECISION
56 #  define kiss_fft_scalar opus_int32
57 #  define kiss_twiddle_scalar opus_int16
58 #  define KF_SUFFIX _celt_double
59 #else
60 #  define kiss_fft_scalar opus_int16
61 #  define kiss_twiddle_scalar opus_int16
62 #  define KF_SUFFIX _celt_single
63 #endif
64 #else
65 # ifndef kiss_fft_scalar
66 /*  default is float */
67 #   define kiss_fft_scalar float
68 #   define kiss_twiddle_scalar float
69 #   define KF_SUFFIX _celt_single
70 # endif
71 #endif
72
73 #if 0
74 /* This adds a suffix to all the kiss_fft functions so we
75    can easily link with more than one copy of the fft */
76 #define CAT_SUFFIX(a,b) a ## b
77 #define SUF(a,b) CAT_SUFFIX(a, b)
78
79 #define kiss_fft_alloc_twiddles SUF(kiss_fft_alloc_twiddles,KF_SUFFIX)
80 #define kiss_fft_alloc SUF(kiss_fft_alloc,KF_SUFFIX)
81 #define kiss_fft SUF(kiss_fft,KF_SUFFIX)
82 #define kiss_ifft SUF(kiss_ifft,KF_SUFFIX)
83 #define kiss_fft_stride SUF(kiss_fft_stride,KF_SUFFIX)
84 #define kiss_ifft_stride SUF(kiss_ifft_stride,KF_SUFFIX)
85 #define kiss_fft_free SUF(kiss_fft_free,KF_SUFFIX)
86
87 #endif
88
89 typedef struct {
90     kiss_fft_scalar r;
91     kiss_fft_scalar i;
92 }kiss_fft_cpx;
93
94 typedef struct {
95    kiss_twiddle_scalar r;
96    kiss_twiddle_scalar i;
97 }kiss_twiddle_cpx;
98
99 #define MAXFACTORS 8
100 /* e.g. an fft of length 128 has 4 factors
101  as far as kissfft is concerned
102  4*4*4*2
103  */
104
105 typedef struct kiss_fft_state{
106     int nfft;
107 #ifndef FIXED_POINT
108     kiss_fft_scalar scale;
109 #endif
110     int shift;
111     opus_int16 factors[2*MAXFACTORS];
112     const opus_int16 *bitrev;
113     const kiss_twiddle_cpx *twiddles;
114 } kiss_fft_state;
115
116 //typedef struct kiss_fft_state* kiss_fft_cfg;
117
118 /** 
119  *  kiss_fft_alloc
120  *  
121  *  Initialize a FFT (or IFFT) algorithm's cfg/state buffer.
122  *
123  *  typical usage:      kiss_fft_cfg mycfg=kiss_fft_alloc(1024,0,NULL,NULL);
124  *
125  *  The return value from fft_alloc is a cfg buffer used internally
126  *  by the fft routine or NULL.
127  *
128  *  If lenmem is NULL, then kiss_fft_alloc will allocate a cfg buffer using malloc.
129  *  The returned value should be free()d when done to avoid memory leaks.
130  *  
131  *  The state can be placed in a user supplied buffer 'mem':
132  *  If lenmem is not NULL and mem is not NULL and *lenmem is large enough,
133  *      then the function places the cfg in mem and the size used in *lenmem
134  *      and returns mem.
135  *  
136  *  If lenmem is not NULL and ( mem is NULL or *lenmem is not large enough),
137  *      then the function returns NULL and places the minimum cfg 
138  *      buffer size in *lenmem.
139  * */
140
141 kiss_fft_state *kiss_fft_alloc_twiddles(int nfft,void * mem,size_t * lenmem, const kiss_fft_state *base);
142
143 kiss_fft_state *kiss_fft_alloc(int nfft,void * mem,size_t * lenmem);
144
145 /**
146  * kiss_fft(cfg,in_out_buf)
147  *
148  * Perform an FFT on a complex input buffer.
149  * for a forward FFT,
150  * fin should be  f[0] , f[1] , ... ,f[nfft-1]
151  * fout will be   F[0] , F[1] , ... ,F[nfft-1]
152  * Note that each element is complex and can be accessed like
153     f[k].r and f[k].i
154  * */
155 void kiss_fft(const kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
156 void kiss_ifft(const kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
157
158 void kiss_fft_free(const kiss_fft_state *cfg);
159
160
161 #ifdef __cplusplus
162
163 #endif
164
165 #endif