git.maemo.org Git - tunertool/blob - src/kiss_fft.h

   1 #ifndef KISS_FFT_H
   2 #define KISS_FFT_H
   3
   4 #include <stdlib.h>
   5 #include <stdio.h>
   6 #include <math.h>
   7 #include <memory.h>
   8 #include <malloc.h>
   9
  10 #ifdef __cplusplus
  11 extern "C"
  12 {
  13 #endif
  14
  15 /*
  16  ATTENTION!
  17  If you would like a :
  18  -- a utility that will handle the caching of fft objects
  19  -- real-only (no imaginary time component ) FFT
  20  -- a multi-dimensional FFT
  21  -- a command-line utility to perform ffts
  22  -- a command-line utility to perform fast-convolution filtering
  23
  24  Then see kfc.h kiss_fftr.h kiss_fftnd.h fftutil.c kiss_fastfir.c
  25   in the tools/ directory.
  26 */
  27
  28 #ifdef USE_SIMD
  29 # include <xmmintrin.h>
  30 # define kiss_fft_scalar __m128
  31 #define KISS_FFT_MALLOC(nbytes) memalign(16,nbytes)
  32 #else
  33 #define KISS_FFT_MALLOC malloc
  34 #endif
  35
  36
  37 #ifdef FIXED_POINT
  38 #include <sys/types.h>
  39 # if (FIXED_POINT == 32)
  40 #  define kiss_fft_scalar int32_t
  41 # else
  42 #  define kiss_fft_scalar int16_t
  43 # endif
  44 #else
  45 # ifndef kiss_fft_scalar
  46 /*  default is float */
  47 #   define kiss_fft_scalar float
  48 # endif
  49 #endif
  50
  51   typedef struct
  52   {
  53     kiss_fft_scalar r;
  54     kiss_fft_scalar i;
  55   } kiss_fft_cpx;
  56
  57   typedef struct kiss_fft_state *kiss_fft_cfg;
  58
  59 /*
  60  *  kiss_fft_alloc
  61  *
  62  *  Initialize a FFT (or IFFT) algorithm's cfg/state buffer.
  63  *
  64  *  typical usage:      kiss_fft_cfg mycfg=kiss_fft_alloc(1024,0,NULL,NULL);
  65  *
  66  *  The return value from fft_alloc is a cfg buffer used internally
  67  *  by the fft routine or NULL.
  68  *
  69  *  If lenmem is NULL, then kiss_fft_alloc will allocate a cfg buffer using malloc.
  70  *  The returned value should be free()d when done to avoid memory leaks.
  71  *
  72  *  The state can be placed in a user supplied buffer 'mem':
  73  *  If lenmem is not NULL and mem is not NULL and *lenmem is large enough,
  74  *      then the function places the cfg in mem and the size used in *lenmem
  75  *      and returns mem.
  76  *
  77  *  If lenmem is not NULL and ( mem is NULL or *lenmem is not large enough),
  78  *      then the function returns NULL and places the minimum cfg
  79  *      buffer size in *lenmem.
  80  * */
  81
  82   kiss_fft_cfg kiss_fft_alloc (int nfft, int inverse_fft, void *mem,
  83       size_t * lenmem);
  84
  85 /*
  86  * kiss_fft(cfg,in_out_buf)
  87  *
  88  * Perform an FFT on a complex input buffer.
  89  * for a forward FFT,
  90  * fin should be  f[0] , f[1] , ... ,f[nfft-1]
  91  * fout will be   F[0] , F[1] , ... ,F[nfft-1]
  92  * Note that each element is complex and can be accessed like
  93     f[k].r and f[k].i
  94  * */
  95   void kiss_fft (kiss_fft_cfg cfg, const kiss_fft_cpx * fin,
  96       kiss_fft_cpx * fout);
  97
  98 /*
  99  A more generic version of the above function. It reads its input from every Nth sample.
 100  * */
 101   void kiss_fft_stride (kiss_fft_cfg cfg, const kiss_fft_cpx * fin,
 102       kiss_fft_cpx * fout, int fin_stride);
 103
 104 /* If kiss_fft_alloc allocated a buffer, it is one contiguous
 105    buffer and can be simply free()d when no longer needed*/
 106 #define kiss_fft_free free
 107
 108 /*
 109  Cleans up some memory that gets managed internally. Not necessary to call, but it might clean up
 110  your compiler output to call this before you exit.
 111 */
 112   void kiss_fft_cleanup (void);
 113
 114
 115 /*
 116  * Returns the smallest integer k, such that k>=n and k has only "fast" factors (2,3,5)
 117  */
 118   int kiss_fft_next_fast_size (int n);
 119
 120 #ifdef __cplusplus
 121 }
 122 #endif
 123
 124 #endif