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