Adds 3rd clause to CELT license
[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    - Neither the name of Internet Society, IETF or IETF Trust, nor the
18    names of specific contributors, may be used to endorse or promote
19    products derived from this software without specific prior written
20    permission.
21
22   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32   POSSIBILITY OF SUCH DAMAGE.*/
33
34 #ifndef KISS_FFT_H
35 #define KISS_FFT_H
36
37 #include <stdlib.h>
38 #include <math.h>
39 #include "arch.h"
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 #ifdef USE_SIMD
46 # include <xmmintrin.h>
47 # define kiss_fft_scalar __m128
48 #define KISS_FFT_MALLOC(nbytes) memalign(16,nbytes)
49 #else
50 #define KISS_FFT_MALLOC opus_alloc
51 #endif
52
53 #ifdef FIXED_POINT
54 #include "arch.h"
55
56 #  define kiss_fft_scalar opus_int32
57 #  define kiss_twiddle_scalar opus_int16
58
59
60 #else
61 # ifndef kiss_fft_scalar
62 /*  default is float */
63 #   define kiss_fft_scalar float
64 #   define kiss_twiddle_scalar float
65 #   define KF_SUFFIX _celt_single
66 # endif
67 #endif
68
69 typedef struct {
70     kiss_fft_scalar r;
71     kiss_fft_scalar i;
72 }kiss_fft_cpx;
73
74 typedef struct {
75    kiss_twiddle_scalar r;
76    kiss_twiddle_scalar i;
77 }kiss_twiddle_cpx;
78
79 #define MAXFACTORS 8
80 /* e.g. an fft of length 128 has 4 factors
81  as far as kissfft is concerned
82  4*4*4*2
83  */
84
85 typedef struct kiss_fft_state{
86     int nfft;
87 #ifndef FIXED_POINT
88     kiss_fft_scalar scale;
89 #endif
90     int shift;
91     opus_int16 factors[2*MAXFACTORS];
92     const opus_int16 *bitrev;
93     const kiss_twiddle_cpx *twiddles;
94 } kiss_fft_state;
95
96 /*typedef struct kiss_fft_state* kiss_fft_cfg;*/
97
98 /**
99  *  opus_fft_alloc
100  *
101  *  Initialize a FFT (or IFFT) algorithm's cfg/state buffer.
102  *
103  *  typical usage:      kiss_fft_cfg mycfg=opus_fft_alloc(1024,0,NULL,NULL);
104  *
105  *  The return value from fft_alloc is a cfg buffer used internally
106  *  by the fft routine or NULL.
107  *
108  *  If lenmem is NULL, then opus_fft_alloc will allocate a cfg buffer using malloc.
109  *  The returned value should be free()d when done to avoid memory leaks.
110  *
111  *  The state can be placed in a user supplied buffer 'mem':
112  *  If lenmem is not NULL and mem is not NULL and *lenmem is large enough,
113  *      then the function places the cfg in mem and the size used in *lenmem
114  *      and returns mem.
115  *
116  *  If lenmem is not NULL and ( mem is NULL or *lenmem is not large enough),
117  *      then the function returns NULL and places the minimum cfg
118  *      buffer size in *lenmem.
119  * */
120
121 kiss_fft_state *opus_fft_alloc_twiddles(int nfft,void * mem,size_t * lenmem, const kiss_fft_state *base);
122
123 kiss_fft_state *opus_fft_alloc(int nfft,void * mem,size_t * lenmem);
124
125 /**
126  * opus_fft(cfg,in_out_buf)
127  *
128  * Perform an FFT on a complex input buffer.
129  * for a forward FFT,
130  * fin should be  f[0] , f[1] , ... ,f[nfft-1]
131  * fout will be   F[0] , F[1] , ... ,F[nfft-1]
132  * Note that each element is complex and can be accessed like
133     f[k].r and f[k].i
134  * */
135 void opus_fft(const kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
136 void opus_ifft(const kiss_fft_state *cfg,const kiss_fft_cpx *fin,kiss_fft_cpx *fout);
137
138 void opus_fft_free(const kiss_fft_state *cfg);
139
140 #ifdef __cplusplus
141 }
142 #endif
143
144 #endif