source: src/spectral/fft.h @ f3bee79

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchpitchshiftsamplertimestretchyinfft+
Last change on this file since f3bee79 was f3bee79, checked in by Paul Brossier <piem@piem.org>, 11 years ago

src/spectral/fft.{c,h}: move fftw3.h include inside fft.c

  • Property mode set to 100644
File size: 3.7 KB
Line 
1/*
2   Copyright (C) 2003 Paul Brossier
3
4   This program is free software; you can redistribute it and/or modify
5   it under the terms of the GNU General Public License as published by
6   the Free Software Foundation; either version 2 of the License, or
7   (at your option) any later version.
8
9   This program is distributed in the hope that it will be useful,
10   but WITHOUT ANY WARRANTY; without even the implied warranty of
11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12   GNU General Public License for more details.
13
14   You should have received a copy of the GNU General Public License
15   along with this program; if not, write to the Free Software
16   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17   
18*/
19
20/** \file
21
22  Fast Fourier Transform object
23
24*/
25
26#ifndef FFT_H_
27#define FFT_H_
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33/** FFT object
34 
35  This object computes forward and backward FFTs, using the complex type to
36  store the results. The phase vocoder or aubio_mfft_t objects should be
37  preferred to using directly aubio_fft_t. The FFT are computed using FFTW3
38  (although support for another library could be added).
39
40*/
41typedef struct _aubio_fft_t aubio_fft_t;
42
43/** create new FFT computation object
44
45  \param size length of the FFT
46  \param channels number of channels
47
48*/
49aubio_fft_t * new_aubio_fft(uint_t size, uint_t channels);
50/** delete FFT object
51
52  \param s fft object as returned by new_aubio_fft
53
54*/
55void del_aubio_fft(aubio_fft_t * s);
56
57/** compute forward FFT
58
59  \param s fft object as returned by new_aubio_fft
60  \param input input signal
61  \param spectrum output spectrum
62
63*/
64void aubio_fft_do (aubio_fft_t *s, fvec_t * input, cvec_t * spectrum);
65/** compute backward (inverse) FFT
66
67  \param s fft object as returned by new_aubio_fft
68  \param spectrum input spectrum
69  \param output output signal
70
71*/
72void aubio_fft_rdo (aubio_fft_t *s, cvec_t * spectrum, fvec_t * output);
73
74/** compute forward FFT
75
76  \param s fft object as returned by new_aubio_fft
77  \param input real input signal
78  \param compspec complex output fft real/imag
79
80*/
81void aubio_fft_do_complex (aubio_fft_t *s, fvec_t * input, fvec_t * compspec);
82/** compute backward (inverse) FFT from real/imag
83
84  \param s fft object as returned by new_aubio_fft
85  \param compspec real/imag input fft array
86  \param output real output array
87
88*/
89void aubio_fft_rdo_complex (aubio_fft_t *s, fvec_t * compspec, fvec_t * output);
90
91/** convert real/imag spectrum to norm/phas spectrum
92
93  \param compspec real/imag input fft array
94  \param spectrum cvec norm/phas output array
95
96*/
97void aubio_fft_get_spectrum(fvec_t * compspec, cvec_t * spectrum);
98/** convert real/imag spectrum to norm/phas spectrum
99
100  \param compspec real/imag input fft array
101  \param spectrum cvec norm/phas output array
102
103*/
104void aubio_fft_get_realimag(cvec_t * spectrum, fvec_t * compspec);
105
106/** compute phas spectrum from real/imag parts
107
108  \param compspec real/imag input fft array
109  \param spectrum cvec norm/phas output array
110
111*/
112void aubio_fft_get_phas(fvec_t * compspec, cvec_t * spectrum);
113/** compute imaginary part from the norm/phas cvec
114
115  \param spectrum norm/phas input array
116  \param compspec real/imag output fft array
117
118*/
119void aubio_fft_get_imag(cvec_t * spectrum, fvec_t * compspec);
120
121/** compute norm component from real/imag parts
122
123  \param compspec real/imag input fft array
124  \param spectrum cvec norm/phas output array
125
126*/
127void aubio_fft_get_norm(fvec_t * compspec, cvec_t * spectrum);
128/** compute real part from norm/phas components
129
130  \param spectrum norm/phas input array
131  \param compspec real/imag output fft array
132
133*/
134void aubio_fft_get_real(cvec_t * spectrum, fvec_t * compspec);
135
136#ifdef __cplusplus
137}
138#endif
139
140#endif // FFT_H_
Note: See TracBrowser for help on using the repository browser.