Created an separate kiss_twiddle_cpx type to make it possible to use
[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 typedef struct {
52     kiss_fft_scalar r;
53     kiss_fft_scalar i;
54 }kiss_fft_cpx;
55
56 typedef struct {
57    kiss_twiddle_scalar r;
58    kiss_twiddle_scalar i;
59 }kiss_twiddle_cpx;
60
61 typedef struct kiss_fft_state* kiss_fft_cfg;
62
63 /** 
64  *  kiss_fft_alloc
65  *  
66  *  Initialize a FFT (or IFFT) algorithm's cfg/state buffer.
67  *
68  *  typical usage:      kiss_fft_cfg mycfg=kiss_fft_alloc(1024,0,NULL,NULL);
69  *
70  *  The return value from fft_alloc is a cfg buffer used internally
71  *  by the fft routine or NULL.
72  *
73  *  If lenmem is NULL, then kiss_fft_alloc will allocate a cfg buffer using malloc.
74  *  The returned value should be free()d when done to avoid memory leaks.
75  *  
76  *  The state can be placed in a user supplied buffer 'mem':
77  *  If lenmem is not NULL and mem is not NULL and *lenmem is large enough,
78  *      then the function places the cfg in mem and the size used in *lenmem
79  *      and returns mem.
80  *  
81  *  If lenmem is not NULL and ( mem is NULL or *lenmem is not large enough),
82  *      then the function returns NULL and places the minimum cfg 
83  *      buffer size in *lenmem.
84  * */
85
86 kiss_fft_cfg kiss_fft_alloc(int nfft,void * mem,size_t * lenmem); 
87
88 /**
89  * kiss_fft(cfg,in_out_buf)
90  *
91  * Perform an FFT on a complex input buffer.
92  * for a forward FFT,
93  * fin should be  f[0] , f[1] , ... ,f[nfft-1]
94  * fout will be   F[0] , F[1] , ... ,F[nfft-1]
95  * Note that each element is complex and can be accessed like
96     f[k].r and f[k].i
97  * */
98 void kiss_fft(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
99 void kiss_ifft(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
100
101 /**
102  A more generic version of the above function. It reads its input from every Nth sample.
103  * */
104 void kiss_fft_stride(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int fin_stride);
105 void kiss_ifft_stride(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int fin_stride);
106
107 /** If kiss_fft_alloc allocated a buffer, it is one contiguous 
108    buffer and can be simply free()d when no longer needed*/
109 #define kiss_fft_free celt_free
110
111 /**
112  Cleans up some memory that gets managed internally. Not necessary to call, but it might clean up 
113  your compiler output to call this before you exit.
114 */
115 void kiss_fft_cleanup(void);
116         
117
118 #ifdef __cplusplus
119
120 #endif
121
122 #endif