git.sesse.net Git - kdenlive/blob - src/lib/external/kiss_fft/kiss_fft.h

   1 #ifndef KISS_FFT_H
   2 #define KISS_FFT_H
   3
   4 /*
   5 Copyright (c) 2003-2010, Mark Borgerding
   6
   7 All rights reserved.
   8
   9 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
  10
  11     * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  12     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  13     * Neither the author nor the names of any contributors may be used to endorse or promote products derived from this software without specific prior written permission.
  14
  15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16 */
  17
  18 #include "config-kdenlive.h"
  19
  20 #include <stdlib.h>
  21 #include <stdio.h>
  22 #include <math.h>
  23 #include <string.h>
  24 #ifdef HAVE_MALLOC_H
  25 #include <malloc.h>
  26 #endif
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /*
  33  ATTENTION!
  34  If you would like a :
  35  -- a utility that will handle the caching of fft objects
  36  -- real-only (no imaginary time component ) FFT
  37  -- a multi-dimensional FFT
  38  -- a command-line utility to perform ffts
  39  -- a command-line utility to perform fast-convolution filtering
  40
  41  Then see kfc.h kiss_fftr.h kiss_fftnd.h fftutil.c kiss_fastfir.c
  42   in the tools/ directory.
  43 */
  44
  45 #ifdef USE_SIMD
  46 # include <xmmintrin.h>
  47 # define kiss_fft_scalar __m128
  48 #define KISS_FFT_MALLOC(nbytes) _mm_malloc(nbytes,16)
  49 #define KISS_FFT_FREE _mm_free
  50 #else
  51 #define KISS_FFT_MALLOC malloc
  52 #define KISS_FFT_FREE free
  53 #endif
  54
  55
  56 #ifdef FIXED_POINT
  57 #include <sys/types.h>
  58 # if (FIXED_POINT == 32)
  59 #  define kiss_fft_scalar int32_t
  60 # else
  61 #  define kiss_fft_scalar int16_t
  62 # endif
  63 #else
  64 # ifndef kiss_fft_scalar
  65 /*  default is float */
  66 #   define kiss_fft_scalar float
  67 # endif
  68 #endif
  69
  70 typedef struct {
  71     kiss_fft_scalar r;
  72     kiss_fft_scalar i;
  73 }kiss_fft_cpx;
  74
  75 typedef struct kiss_fft_state* kiss_fft_cfg;
  76
  77 /*
  78  *  kiss_fft_alloc
  79  *
  80  *  Initialize a FFT (or IFFT) algorithm's cfg/state buffer.
  81  *
  82  *  typical usage:      kiss_fft_cfg mycfg=kiss_fft_alloc(1024,0,NULL,NULL);
  83  *
  84  *  The return value from fft_alloc is a cfg buffer used internally
  85  *  by the fft routine or NULL.
  86  *
  87  *  If lenmem is NULL, then kiss_fft_alloc will allocate a cfg buffer using malloc.
  88  *  The returned value should be free()d when done to avoid memory leaks.
  89  *
  90  *  The state can be placed in a user supplied buffer 'mem':
  91  *  If lenmem is not NULL and mem is not NULL and *lenmem is large enough,
  92  *      then the function places the cfg in mem and the size used in *lenmem
  93  *      and returns mem.
  94  *
  95  *  If lenmem is not NULL and ( mem is NULL or *lenmem is not large enough),
  96  *      then the function returns NULL and places the minimum cfg
  97  *      buffer size in *lenmem.
  98  * */
  99
 100 kiss_fft_cfg kiss_fft_alloc(int nfft,int inverse_fft,void * mem,size_t * lenmem);
 101
 102 /*
 103  * kiss_fft(cfg,in_out_buf)
 104  *
 105  * Perform an FFT on a complex input buffer.
 106  * for a forward FFT,
 107  * fin should be  f[0] , f[1] , ... ,f[nfft-1]
 108  * fout will be   F[0] , F[1] , ... ,F[nfft-1]
 109  * Note that each element is complex and can be accessed like
 110     f[k].r and f[k].i
 111  * */
 112 void kiss_fft(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
 113
 114 /*
 115  A more generic version of the above function. It reads its input from every Nth sample.
 116  * */
 117 void kiss_fft_stride(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int fin_stride);
 118
 119 /* If kiss_fft_alloc allocated a buffer, it is one contiguous
 120    buffer and can be simply free()d when no longer needed*/
 121 #define kiss_fft_free free
 122
 123 /*
 124  Cleans up some memory that gets managed internally. Not necessary to call, but it might clean up
 125  your compiler output to call this before you exit.
 126 */
 127 void kiss_fft_cleanup(void);
 128
 129
 130 /*
 131  * Returns the smallest integer k, such that k>=n and k has only "fast" factors (2,3,5)
 132  */
 133 int kiss_fft_next_fast_size(int n);
 134
 135 /* for real ffts, we need an even size */
 136 #define kiss_fftr_next_fast_size_real(n) \
 137         (kiss_fft_next_fast_size( ((n)+1)>>1)<<1)
 138
 139 #ifdef __cplusplus
 140 }
 141 #endif
 142
 143 #endif