michael@0: #ifndef KISS_FFT_H
michael@0: #define KISS_FFT_H
michael@0: 
michael@0: #include <stdlib.h>
michael@0: #include <stdio.h>
michael@0: #include <math.h>
michael@0: #include <string.h>
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: extern "C" {
michael@0: #endif
michael@0: 
michael@0: /*
michael@0:  ATTENTION!
michael@0:  If you would like a :
michael@0:  -- a utility that will handle the caching of fft objects
michael@0:  -- real-only (no imaginary time component ) FFT
michael@0:  -- a multi-dimensional FFT
michael@0:  -- a command-line utility to perform ffts
michael@0:  -- a command-line utility to perform fast-convolution filtering
michael@0: 
michael@0:  Then see kfc.h kiss_fftr.h kiss_fftnd.h fftutil.c kiss_fastfir.c
michael@0:   in the tools/ directory.
michael@0: */
michael@0: 
michael@0: #ifdef USE_SIMD
michael@0: # include <xmmintrin.h>
michael@0: # define kiss_fft_scalar __m128
michael@0: #define KISS_FFT_MALLOC(nbytes) _mm_malloc(nbytes,16)
michael@0: #define KISS_FFT_FREE _mm_free
michael@0: #else	
michael@0: #define KISS_FFT_MALLOC malloc
michael@0: #define KISS_FFT_FREE free
michael@0: #endif	
michael@0: 
michael@0: 
michael@0: #ifdef FIXED_POINT
michael@0: #include <sys/types.h>	
michael@0: # if (FIXED_POINT == 32)
michael@0: #  define kiss_fft_scalar int32_t
michael@0: # else	
michael@0: #  define kiss_fft_scalar int16_t
michael@0: # endif
michael@0: #else
michael@0: # ifndef kiss_fft_scalar
michael@0: /*  default is float */
michael@0: #   define kiss_fft_scalar float
michael@0: # endif
michael@0: #endif
michael@0: 
michael@0: typedef struct {
michael@0:     kiss_fft_scalar r;
michael@0:     kiss_fft_scalar i;
michael@0: }kiss_fft_cpx;
michael@0: 
michael@0: typedef struct kiss_fft_state* kiss_fft_cfg;
michael@0: 
michael@0: /* 
michael@0:  *  kiss_fft_alloc
michael@0:  *  
michael@0:  *  Initialize a FFT (or IFFT) algorithm's cfg/state buffer.
michael@0:  *
michael@0:  *  typical usage:      kiss_fft_cfg mycfg=kiss_fft_alloc(1024,0,NULL,NULL);
michael@0:  *
michael@0:  *  The return value from fft_alloc is a cfg buffer used internally
michael@0:  *  by the fft routine or NULL.
michael@0:  *
michael@0:  *  If lenmem is NULL, then kiss_fft_alloc will allocate a cfg buffer using malloc.
michael@0:  *  The returned value should be free()d when done to avoid memory leaks.
michael@0:  *  
michael@0:  *  The state can be placed in a user supplied buffer 'mem':
michael@0:  *  If lenmem is not NULL and mem is not NULL and *lenmem is large enough,
michael@0:  *      then the function places the cfg in mem and the size used in *lenmem
michael@0:  *      and returns mem.
michael@0:  *  
michael@0:  *  If lenmem is not NULL and ( mem is NULL or *lenmem is not large enough),
michael@0:  *      then the function returns NULL and places the minimum cfg 
michael@0:  *      buffer size in *lenmem.
michael@0:  * */
michael@0: 
michael@0: kiss_fft_cfg kiss_fft_alloc(int nfft,int inverse_fft,void * mem,size_t * lenmem); 
michael@0: 
michael@0: /*
michael@0:  * kiss_fft(cfg,in_out_buf)
michael@0:  *
michael@0:  * Perform an FFT on a complex input buffer.
michael@0:  * for a forward FFT,
michael@0:  * fin should be  f[0] , f[1] , ... ,f[nfft-1]
michael@0:  * fout will be   F[0] , F[1] , ... ,F[nfft-1]
michael@0:  * Note that each element is complex and can be accessed like
michael@0:     f[k].r and f[k].i
michael@0:  * */
michael@0: void kiss_fft(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
michael@0: 
michael@0: /*
michael@0:  A more generic version of the above function. It reads its input from every Nth sample.
michael@0:  * */
michael@0: void kiss_fft_stride(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int fin_stride);
michael@0: 
michael@0: /* If kiss_fft_alloc allocated a buffer, it is one contiguous 
michael@0:    buffer and can be simply free()d when no longer needed*/
michael@0: #define kiss_fft_free free
michael@0: 
michael@0: /*
michael@0:  Cleans up some memory that gets managed internally. Not necessary to call, but it might clean up 
michael@0:  your compiler output to call this before you exit.
michael@0: */
michael@0: void kiss_fft_cleanup(void);
michael@0: 	
michael@0: 
michael@0: /*
michael@0:  * Returns the smallest integer k, such that k>=n and k has only "fast" factors (2,3,5)
michael@0:  */
michael@0: int kiss_fft_next_fast_size(int n);
michael@0: 
michael@0: /* for real ffts, we need an even size */
michael@0: #define kiss_fftr_next_fast_size_real(n) \
michael@0:         (kiss_fft_next_fast_size( ((n)+1)>>1)<<1)
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: } 
michael@0: #endif
michael@0: 
michael@0: #endif