License for the kiss-fft headers
[opus.git] / libcelt / kiss_fftr.h
1 /*
2 Original version:
3 Copyright (c) 2003-2004, Mark Borgerding
4 Followed by heavy modifications:
5 Copyright (c) 2007-2008, Jean-Marc Valin
6
7
8 All rights reserved.
9
10 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
11
12     * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
13     * 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.
14     * 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.
15
16 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.
17 */
18
19 #ifndef KISS_FTR_H
20 #define KISS_FTR_H
21
22 #include "kiss_fft.h"
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 #define kiss_fftr_alloc SUF(kiss_fftr_alloc,KF_SUFFIX)
28 #define kiss_fftr_inplace SUF(kiss_fftr_inplace,KF_SUFFIX)
29 #define kiss_fftr_alloc SUF(kiss_fftr_alloc,KF_SUFFIX)
30 #define kiss_fftr_twiddles SUF(kiss_fftr_twiddles,KF_SUFFIX)
31 #define kiss_fftr SUF(kiss_fftr,KF_SUFFIX)
32 #define kiss_fftri SUF(kiss_fftri,KF_SUFFIX)
33
34 /* 
35  
36  Real optimized version can save about 45% cpu time vs. complex fft of a real seq.
37
38  
39  
40  */
41
42 struct kiss_fftr_state{
43       kiss_fft_cfg substate;
44       kiss_twiddle_cpx * super_twiddles;
45 #ifdef USE_SIMD    
46       long pad;
47 #endif    
48    };
49
50 typedef struct kiss_fftr_state *kiss_fftr_cfg;
51
52
53 kiss_fftr_cfg kiss_fftr_alloc(int nfft,void * mem, size_t * lenmem);
54 /*
55  nfft must be even
56
57  If you don't care to allocate space, use mem = lenmem = NULL 
58 */
59
60
61 /*
62  input timedata has nfft scalar points
63  output freqdata has nfft/2+1 complex points, packed into nfft scalar points
64 */
65 void kiss_fftr_twiddles(kiss_fftr_cfg st,kiss_fft_scalar *freqdata);
66
67 void kiss_fftr(kiss_fftr_cfg st,const kiss_fft_scalar *timedata,kiss_fft_scalar *freqdata);
68 void kiss_fftr_inplace(kiss_fftr_cfg st, kiss_fft_scalar *X);
69
70 void kiss_fftri(kiss_fftr_cfg st,const kiss_fft_scalar *freqdata, kiss_fft_scalar *timedata);
71
72 /*
73  input freqdata has  nfft/2+1 complex points, packed into nfft scalar points
74  output timedata has nfft scalar points
75 */
76
77 #define kiss_fftr_free speex_free
78
79 #ifdef __cplusplus
80 }
81 #endif
82 #endif