renames the libcelt/ directory to celt/
[opus.git] / celt / kiss_fft.h
1 /*Copyright (c) 2003-2004, Mark Borgerding
2   Lots of modifications by Jean-Marc Valin
3   Copyright (c) 2005-2007, Xiph.Org Foundation
4   Copyright (c) 2008,      Xiph.Org Foundation, CSIRO
5
6   All rights reserved.
7
8   Redistribution and use in source and binary forms, with or without
9    modification, are permitted provided that the following conditions are met:
10
11     * Redistributions of source code must retain the above copyright notice,
12        this list of conditions and the following disclaimer.
13     * Redistributions in binary form must reproduce the above copyright notice,
14        this list of conditions and the following disclaimer in the
15        documentation and/or other materials provided with the distribution.
16
17   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27   POSSIBILITY OF SUCH DAMAGE.*/
28
29 #ifndef KISS_FFT_H
30 #define KISS_FFT_H
31
32 #include <stdlib.h>
33 #include <math.h>
34 #include "arch.h"
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 /*
41  ATTENTION!
42  If you would like a :
43  -- a utility that will handle the caching of fft objects
44  -- real-only (no imaginary time component ) FFT
45  -- a multi-dimensional FFT
46  -- a command-line utility to perform ffts
47  -- a command-line utility to perform fast-convolution filtering
48
49  Then see kfc.h kiss_fftr.h kiss_fftnd.h fftutil.c kiss_fastfir.c
50   in the tools/ directory.
51 */
52
53 #ifdef USE_SIMD
54 # include <xmmintrin.h>
55 # define kiss_fft_scalar __m128
56 #define KISS_FFT_MALLOC(nbytes) memalign(16,nbytes)
57 #else   
58 #define KISS_FFT_MALLOC opus_alloc
59 #endif  
60
61 #ifdef FIXED_POINT
62 #include "arch.h"       
63
64 #  define kiss_fft_scalar opus_int32
65 #  define kiss_twiddle_scalar opus_int16
66
67
68 #else
69 # ifndef kiss_fft_scalar
70 /*  default is float */
71 #   define kiss_fft_scalar float
72 #   define kiss_twiddle_scalar float
73 #   define KF_SUFFIX _celt_single
74 # endif
75 #endif
76
77 typedef struct {
78     kiss_fft_scalar r;
79     kiss_fft_scalar i;
80 }kiss_fft_cpx;
81
82 typedef struct {
83    kiss_twiddle_scalar r;
84    kiss_twiddle_scalar i;
85 }kiss_twiddle_cpx;
86
87 #define MAXFACTORS 8
88 /* e.g. an fft of length 128 has 4 factors
89  as far as kissfft is concerned
90  4*4*4*2
91  */
92
93 typedef struct kiss_fft_state{
94     int nfft;
95 #ifndef FIXED_POINT
96     kiss_fft_scalar scale;
97 #endif
98     int shift;
99     opus_int16 factors[2*MAXFACTORS];
100     const opus_int16 *bitrev;
101     const kiss_twiddle_cpx *twiddles;
102 } kiss_fft_state;
103
104 /*typedef struct kiss_fft_state* kiss_fft_cfg;*/
105
106 /**
107  *  opus_fft_alloc
108  *
109  *  Initialize a FFT (or IFFT) algorithm's cfg/state buffer.
110  *
111  *  typical usage:      kiss_fft_cfg mycfg=opus_fft_alloc(1024,0,NULL,NULL);
112  *
113  *  The return value from fft_alloc is a cfg buffer used internally
114  *  by the fft routine or NULL.
115  *
116  *  If lenmem is NULL, then opus_fft_alloc will allocate a cfg buffer using malloc.
117  *  The returned value should be free()d when done to avoid memory leaks.
118  *
119  *  The state can be placed in a user supplied buffer 'mem':
120  *  If lenmem is not NULL and mem is not NULL and *lenmem is large enough,
121  *      then the function places the cfg in mem and the size used in *lenmem
122  *      and returns mem.
123  *
124  *  If lenmem is not NULL and ( mem is NULL or *lenmem is not large enough),
125  *      then the function returns NULL and places the minimum cfg
126  *      buffer size in *lenmem.
127  * */
128
129 kiss_fft_state *opus_fft_alloc_twiddles(int nfft,void * mem,size_t * lenmem, const kiss_fft_state *base);
130
131 kiss_fft_state *opus_fft_alloc(int nfft,void * mem,size_t * lenmem);
132
133 /**
134  * opus_fft(cfg,in_out_buf)
135  *
136  * Perform an FFT on a complex input buffer.
137  * for a forward FFT,
138  * fin should be  f[0] , f[1] , ... ,f[nfft-1]
139  * fout will be   F[0] , F[1] , ... ,F[nfft-1]
140  * Note that each element is complex and can be accessed like
141     f[k].r and f[k].i
142  * */
143 void opus_fft(const kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
144 void opus_ifft(const kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
145
146 void opus_fft_free(const kiss_fft_state *cfg);
147
148 #ifdef __cplusplus
149 }
150 #endif
151
152 #endif