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