making codec draft more compliant with IETF submission rules
[opus.git] / libcelt / kiss_fft.h
1 /*
2 Copyright (c) 2003-2004, Mark Borgerding
3 Lots of modifications by JMV
4 Copyright (c) 2005-2007, Jean-Marc Valin
5 Copyright (c) 2008,      Jean-Marc Valin, CSIRO
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
19 #ifndef KISS_FFT_H
20 #define KISS_FFT_H
21
22 #include <stdlib.h>
23 #include <math.h>
24 #include "arch.h"
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 /*
31  ATTENTION!
32  If you would like a :
33  -- a utility that will handle the caching of fft objects
34  -- real-only (no imaginary time component ) FFT
35  -- a multi-dimensional FFT
36  -- a command-line utility to perform ffts
37  -- a command-line utility to perform fast-convolution filtering
38
39  Then see kfc.h kiss_fftr.h kiss_fftnd.h fftutil.c kiss_fastfir.c
40   in the tools/ directory.
41 */
42
43 #ifdef USE_SIMD
44 # include <xmmintrin.h>
45 # define kiss_fft_scalar __m128
46 #define KISS_FFT_MALLOC(nbytes) memalign(16,nbytes)
47 #else   
48 #define KISS_FFT_MALLOC celt_alloc
49 #endif  
50
51
52 #ifdef FIXED_POINT
53 #include "arch.h"       
54 #ifdef DOUBLE_PRECISION
55 #  define kiss_fft_scalar celt_int32_t
56 #  define kiss_twiddle_scalar celt_int32_t
57 #  define KF_SUFFIX _celt_double
58 #else
59 #  define kiss_fft_scalar celt_int16_t
60 #  define kiss_twiddle_scalar celt_int16_t
61 #  define KF_SUFFIX _celt_single
62 #endif
63 #else
64 # ifndef kiss_fft_scalar
65 /*  default is float */
66 #   define kiss_fft_scalar float
67 #   define kiss_twiddle_scalar float
68 #   define KF_SUFFIX _celt_single
69 # endif
70 #endif
71
72
73 /* This adds a suffix to all the kiss_fft functions so we
74    can easily link with more than one copy of the fft */
75 #define CAT_SUFFIX(a,b) a ## b
76 #define SUF(a,b) CAT_SUFFIX(a, b)
77
78 #define kiss_fft_alloc SUF(kiss_fft_alloc,KF_SUFFIX)
79 #define kf_work SUF(kf_work,KF_SUFFIX)
80 #define ki_work SUF(ki_work,KF_SUFFIX)
81 #define kiss_fft SUF(kiss_fft,KF_SUFFIX)
82 #define kiss_ifft SUF(kiss_ifft,KF_SUFFIX)
83 #define kiss_fft_stride SUF(kiss_fft_stride,KF_SUFFIX)
84 #define kiss_ifft_stride SUF(kiss_ifft_stride,KF_SUFFIX)
85
86
87 typedef struct {
88     kiss_fft_scalar r;
89     kiss_fft_scalar i;
90 }kiss_fft_cpx;
91
92 typedef struct {
93    kiss_twiddle_scalar r;
94    kiss_twiddle_scalar i;
95 }kiss_twiddle_cpx;
96
97 typedef struct kiss_fft_state* kiss_fft_cfg;
98
99 /** 
100  *  kiss_fft_alloc
101  *  
102  *  Initialize a FFT (or IFFT) algorithm's cfg/state buffer.
103  *
104  *  typical usage:      kiss_fft_cfg mycfg=kiss_fft_alloc(1024,0,NULL,NULL);
105  *
106  *  The return value from fft_alloc is a cfg buffer used internally
107  *  by the fft routine or NULL.
108  *
109  *  If lenmem is NULL, then kiss_fft_alloc will allocate a cfg buffer using malloc.
110  *  The returned value should be free()d when done to avoid memory leaks.
111  *  
112  *  The state can be placed in a user supplied buffer 'mem':
113  *  If lenmem is not NULL and mem is not NULL and *lenmem is large enough,
114  *      then the function places the cfg in mem and the size used in *lenmem
115  *      and returns mem.
116  *  
117  *  If lenmem is not NULL and ( mem is NULL or *lenmem is not large enough),
118  *      then the function returns NULL and places the minimum cfg 
119  *      buffer size in *lenmem.
120  * */
121
122 kiss_fft_cfg kiss_fft_alloc(int nfft,void * mem,size_t * lenmem); 
123
124 void kf_work(kiss_fft_cpx * Fout,const kiss_fft_cpx * f,const size_t fstride,
125              int in_stride,int * factors,const kiss_fft_cfg st,int N,int s2,int m2);
126
127 /** Internal function. Can be useful when you want to do the bit-reversing yourself */
128 void ki_work(kiss_fft_cpx * Fout, const kiss_fft_cpx * f, const size_t fstride,
129              int in_stride,int * factors,const kiss_fft_cfg st,int N,int s2,int m2);
130
131 /**
132  * kiss_fft(cfg,in_out_buf)
133  *
134  * Perform an FFT on a complex input buffer.
135  * for a forward FFT,
136  * fin should be  f[0] , f[1] , ... ,f[nfft-1]
137  * fout will be   F[0] , F[1] , ... ,F[nfft-1]
138  * Note that each element is complex and can be accessed like
139     f[k].r and f[k].i
140  * */
141 void kiss_fft(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
142 void kiss_ifft(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
143
144 /**
145  A more generic version of the above function. It reads its input from every Nth sample.
146  * */
147 void kiss_fft_stride(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int fin_stride);
148 void kiss_ifft_stride(kiss_fft_cfg cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout,int fin_stride);
149
150 /** If kiss_fft_alloc allocated a buffer, it is one contiguous 
151    buffer and can be simply free()d when no longer needed*/
152 #define kiss_fft_free celt_free
153
154
155 #ifdef __cplusplus
156
157 #endif
158
159 #endif