Sharing of the twiddles across multiple FFTs
[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     * 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.
14
15 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.
16 */
17
18
19 #ifndef KISS_FFT_H
20 #define KISS_FFT_H
21
22 #include <stdlib.h>
23 #include <math.h>
24 #include "arch.h"
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 /*
31  ATTENTION!
32  If you would like a :
33  -- a utility that will handle the caching of fft objects
34  -- real-only (no imaginary time component ) FFT
35  -- a multi-dimensional FFT
36  -- a command-line utility to perform ffts
37  -- a command-line utility to perform fast-convolution filtering
38
39  Then see kfc.h kiss_fftr.h kiss_fftnd.h fftutil.c kiss_fastfir.c
40   in the tools/ directory.
41 */
42
43 #ifdef USE_SIMD
44 # include <xmmintrin.h>
45 # define kiss_fft_scalar __m128
46 #define KISS_FFT_MALLOC(nbytes) memalign(16,nbytes)
47 #else   
48 #define KISS_FFT_MALLOC celt_alloc
49 #endif  
50
51
52 #ifdef FIXED_POINT
53 #include "arch.h"       
54 #ifdef DOUBLE_PRECISION
55 #  define kiss_fft_scalar celt_int32
56 #  define kiss_twiddle_scalar celt_int32
57 #  define KF_SUFFIX _celt_double
58 #else
59 #  define kiss_fft_scalar celt_int16
60 #  define kiss_twiddle_scalar celt_int16
61 #  define KF_SUFFIX _celt_single
62 #endif
63 #else
64 # ifndef kiss_fft_scalar
65 /*  default is float */
66 #   define kiss_fft_scalar float
67 #   define kiss_twiddle_scalar float
68 #   define KF_SUFFIX _celt_single
69 # endif
70 #endif
71
72
73 /* This adds a suffix to all the kiss_fft functions so we
74    can easily link with more than one copy of the fft */
75 #define CAT_SUFFIX(a,b) a ## b
76 #define SUF(a,b) CAT_SUFFIX(a, b)
77
78 #define kiss_fft_alloc_twiddles SUF(kiss_fft_alloc_twiddles,KF_SUFFIX)
79 #define kiss_fft_alloc SUF(kiss_fft_alloc,KF_SUFFIX)
80 #define kf_work SUF(kf_work,KF_SUFFIX)
81 #define ki_work SUF(ki_work,KF_SUFFIX)
82 #define kiss_fft SUF(kiss_fft,KF_SUFFIX)
83 #define kiss_ifft SUF(kiss_ifft,KF_SUFFIX)
84 #define kiss_fft_stride SUF(kiss_fft_stride,KF_SUFFIX)
85 #define kiss_ifft_stride SUF(kiss_ifft_stride,KF_SUFFIX)
86 #define kiss_fft_free SUF(kiss_fft_free,KF_SUFFIX)
87
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 typedef struct kiss_fft_state* kiss_fft_cfg;
100
101 /** 
102  *  kiss_fft_alloc
103  *  
104  *  Initialize a FFT (or IFFT) algorithm's cfg/state buffer.
105  *
106  *  typical usage:      kiss_fft_cfg mycfg=kiss_fft_alloc(1024,0,NULL,NULL);
107  *
108  *  The return value from fft_alloc is a cfg buffer used internally
109  *  by the fft routine or NULL.
110  *
111  *  If lenmem is NULL, then kiss_fft_alloc will allocate a cfg buffer using malloc.
112  *  The returned value should be free()d when done to avoid memory leaks.
113  *  
114  *  The state can be placed in a user supplied buffer 'mem':
115  *  If lenmem is not NULL and mem is not NULL and *lenmem is large enough,
116  *      then the function places the cfg in mem and the size used in *lenmem
117  *      and returns mem.
118  *  
119  *  If lenmem is not NULL and ( mem is NULL or *lenmem is not large enough),
120  *      then the function returns NULL and places the minimum cfg 
121  *      buffer size in *lenmem.
122  * */
123
124 kiss_fft_cfg kiss_fft_alloc_twiddles(int nfft,void * mem,size_t * lenmem,  kiss_fft_cfg base);
125
126 kiss_fft_cfg kiss_fft_alloc(int nfft,void * mem,size_t * lenmem); 
127
128 void kf_work(kiss_fft_cpx * Fout,const kiss_fft_cpx * f,size_t fstride,
129              int in_stride,int * factors,const kiss_fft_cfg st,int N,int s2,int m2);
130
131 /** Internal function. Can be useful when you want to do the bit-reversing yourself */
132 void ki_work(kiss_fft_cpx * Fout, const kiss_fft_cpx * f, size_t fstride,
133              int in_stride,int * factors,const kiss_fft_cfg st,int N,int s2,int m2);
134
135 /**
136  * kiss_fft(cfg,in_out_buf)
137  *
138  * Perform an FFT on a complex input buffer.
139  * for a forward FFT,
140  * fin should be  f[0] , f[1] , ... ,f[nfft-1]
141  * fout will be   F[0] , F[1] , ... ,F[nfft-1]
142  * Note that each element is complex and can be accessed like
143     f[k].r and f[k].i
144  * */
145 void kiss_fft(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
146 void kiss_ifft(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
147
148 /**
149  A more generic version of the above function. It reads its input from every Nth sample.
150  * */
151 void kiss_fft_stride(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int fin_stride);
152 void kiss_ifft_stride(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int fin_stride);
153
154 void kiss_fft_free(kiss_fft_cfg cfg);
155
156
157 #ifdef __cplusplus
158
159 #endif
160
161 #endif