Eliminate some unreachable cases from the cwrs code and fixup the
[opus.git] / libcelt / kiss_fft.h
1 /*
2 Copyright (c) 2003-2004, Mark Borgerding
3 Lots of modifications by Jean-Marc Valin
4 Copyright (c) 2005-2007, Xiph.Org Foundation
5 Copyright (c) 2008,      Xiph.Org Foundation, 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
14 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.
15 */
16
17 #ifndef KISS_FFT_H
18 #define KISS_FFT_H
19
20 #include <stdlib.h>
21 #include <math.h>
22 #include "arch.h"
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 /*
29  ATTENTION!
30  If you would like a :
31  -- a utility that will handle the caching of fft objects
32  -- real-only (no imaginary time component ) FFT
33  -- a multi-dimensional FFT
34  -- a command-line utility to perform ffts
35  -- a command-line utility to perform fast-convolution filtering
36
37  Then see kfc.h kiss_fftr.h kiss_fftnd.h fftutil.c kiss_fastfir.c
38   in the tools/ directory.
39 */
40
41 #ifdef USE_SIMD
42 # include <xmmintrin.h>
43 # define kiss_fft_scalar __m128
44 #define KISS_FFT_MALLOC(nbytes) memalign(16,nbytes)
45 #else   
46 #define KISS_FFT_MALLOC celt_alloc
47 #endif  
48
49 #ifdef FIXED_POINT
50 #include "arch.h"       
51 #define DOUBLE_PRECISION
52
53 #ifdef DOUBLE_PRECISION
54 #  define kiss_fft_scalar opus_int32
55 #  define kiss_twiddle_scalar opus_int16
56 #  define KF_SUFFIX _celt_double
57 #else
58 #  define kiss_fft_scalar opus_int16
59 #  define kiss_twiddle_scalar opus_int16
60 #  define KF_SUFFIX _celt_single
61 #endif
62 #else
63 # ifndef kiss_fft_scalar
64 /*  default is float */
65 #   define kiss_fft_scalar float
66 #   define kiss_twiddle_scalar float
67 #   define KF_SUFFIX _celt_single
68 # endif
69 #endif
70
71 #if 0
72 /* This adds a suffix to all the kiss_fft functions so we
73    can easily link with more than one copy of the fft */
74 #define CAT_SUFFIX(a,b) a ## b
75 #define SUF(a,b) CAT_SUFFIX(a, b)
76
77 #define kiss_fft_alloc_twiddles SUF(kiss_fft_alloc_twiddles,KF_SUFFIX)
78 #define kiss_fft_alloc SUF(kiss_fft_alloc,KF_SUFFIX)
79 #define kiss_fft SUF(kiss_fft,KF_SUFFIX)
80 #define kiss_ifft SUF(kiss_ifft,KF_SUFFIX)
81 #define kiss_fft_stride SUF(kiss_fft_stride,KF_SUFFIX)
82 #define kiss_ifft_stride SUF(kiss_ifft_stride,KF_SUFFIX)
83 #define kiss_fft_free SUF(kiss_fft_free,KF_SUFFIX)
84
85 #endif
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 #define MAXFACTORS 8
98 /* e.g. an fft of length 128 has 4 factors
99  as far as kissfft is concerned
100  4*4*4*2
101  */
102
103 typedef struct kiss_fft_state{
104     int nfft;
105 #ifndef FIXED_POINT
106     kiss_fft_scalar scale;
107 #endif
108     int shift;
109     opus_int16 factors[2*MAXFACTORS];
110     const opus_int16 *bitrev;
111     const kiss_twiddle_cpx *twiddles;
112 } kiss_fft_state;
113
114 /*typedef struct kiss_fft_state* kiss_fft_cfg;*/
115
116 /**
117  *  kiss_fft_alloc
118  *
119  *  Initialize a FFT (or IFFT) algorithm's cfg/state buffer.
120  *
121  *  typical usage:      kiss_fft_cfg mycfg=kiss_fft_alloc(1024,0,NULL,NULL);
122  *
123  *  The return value from fft_alloc is a cfg buffer used internally
124  *  by the fft routine or NULL.
125  *
126  *  If lenmem is NULL, then kiss_fft_alloc will allocate a cfg buffer using malloc.
127  *  The returned value should be free()d when done to avoid memory leaks.
128  *
129  *  The state can be placed in a user supplied buffer 'mem':
130  *  If lenmem is not NULL and mem is not NULL and *lenmem is large enough,
131  *      then the function places the cfg in mem and the size used in *lenmem
132  *      and returns mem.
133  *
134  *  If lenmem is not NULL and ( mem is NULL or *lenmem is not large enough),
135  *      then the function returns NULL and places the minimum cfg
136  *      buffer size in *lenmem.
137  * */
138
139 kiss_fft_state *kiss_fft_alloc_twiddles(int nfft,void * mem,size_t * lenmem, const kiss_fft_state *base);
140
141 kiss_fft_state *kiss_fft_alloc(int nfft,void * mem,size_t * lenmem);
142
143 /**
144  * kiss_fft(cfg,in_out_buf)
145  *
146  * Perform an FFT on a complex input buffer.
147  * for a forward FFT,
148  * fin should be  f[0] , f[1] , ... ,f[nfft-1]
149  * fout will be   F[0] , F[1] , ... ,F[nfft-1]
150  * Note that each element is complex and can be accessed like
151     f[k].r and f[k].i
152  * */
153 void kiss_fft(const kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
154 void kiss_ifft(const kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
155
156 void kiss_fft_free(const kiss_fft_state *cfg);
157
158 #ifdef __cplusplus
159 }
160 #endif
161
162 #endif