source: src/fft.h @ 3b3ec6c

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 3b3ec6c was 3b3ec6c, checked in by Paul Brossier <piem@altern.org>, 18 years ago

use replacement if complex.h not found
use replacement if complex.h not found

  • Property mode set to 100644
File size: 3.8 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/* note that <complex.h> is not included here but only in aubio_priv.h, so that
30 * c++ projects can still use their own complex definition. */
31#include <fftw3.h>
32
33#ifdef HAVE_COMPLEX_H
34#if FFTW3F_SUPPORT
35#define FFTW_TYPE fftwf_complex
36#else
37#define FFTW_TYPE fftw_complex
38#endif
39#else
40#if FFTW3F_SUPPORT
41#define FFTW_TYPE float
42#else
43#define FFTW_TYPE double
44#endif
45#endif
46
47#ifdef __cplusplus
48extern "C" {
49#endif
50
51typedef FFTW_TYPE fft_data_t;
52
53/** FFT object
54 
55  This object computes forward and backward FFTs, using the complex type to
56  store the results. The phase vocoder or aubio_mfft_t objects should be
57  preferred to using directly aubio_fft_t. The FFT are computed using FFTW3
58  (although support for another library could be added).
59
60*/
61typedef struct _aubio_fft_t aubio_fft_t;
62
63/** create new FFT computation object
64
65  \param size length of the FFT
66
67*/
68aubio_fft_t * new_aubio_fft(uint_t size);
69/** delete FFT object
70
71  \param s fft object as returned by new_aubio_fft
72
73*/
74void del_aubio_fft(aubio_fft_t * s);
75/** compute forward FFT
76
77  \param s fft object as returned by new_aubio_fft
78  \param data input signal
79  \param spectrum output spectrum
80  \param size length of the input vector
81
82*/
83void aubio_fft_do (const aubio_fft_t *s, const smpl_t * data,
84    fft_data_t * spectrum, const uint_t size);
85/** compute backward (inverse) FFT
86
87  \param s fft object as returned by new_aubio_fft
88  \param spectrum input spectrum
89  \param data output signal
90  \param size length of the input vector
91
92*/
93void aubio_fft_rdo(const aubio_fft_t *s, const fft_data_t * spectrum,
94    smpl_t * data, const uint_t size);
95/** compute norm vector from input spectrum
96
97  \param norm magnitude vector output
98  \param spectrum spectral data input
99  \param size size of the vectors
100
101*/
102void aubio_fft_getnorm(smpl_t * norm, fft_data_t * spectrum, uint_t size);
103/** compute phase vector from input spectrum
104 
105  \param phase phase vector output
106  \param spectrum spectral data input
107  \param size size of the vectors
108
109*/
110void aubio_fft_getphas(smpl_t * phase, fft_data_t * spectrum, uint_t size);
111
112/** FFT object (using cvec)
113
114  This object works similarly as aubio_fft_t, except the spectral data is
115  stored in a cvec_t as two vectors, magnitude and phase.
116
117*/
118typedef struct _aubio_mfft_t aubio_mfft_t;
119
120/** create new FFT computation object
121
122  \param winsize length of the FFT
123  \param channels number of channels
124
125*/
126aubio_mfft_t * new_aubio_mfft(uint_t winsize, uint_t channels);
127/** compute forward FFT
128
129  \param fft fft object as returned by new_aubio_mfft
130  \param in input signal
131  \param fftgrain output spectrum
132
133*/
134void aubio_mfft_do (aubio_mfft_t * fft,fvec_t * in,cvec_t * fftgrain);
135/** compute backward (inverse) FFT
136
137  \param fft fft object as returned by new_aubio_mfft
138  \param fftgrain input spectrum (cvec)
139  \param out output signal
140
141*/
142void aubio_mfft_rdo(aubio_mfft_t * fft,cvec_t * fftgrain, fvec_t * out);
143/** delete FFT object
144
145  \param fft fft object as returned by new_aubio_mfft
146
147*/
148void del_aubio_mfft(aubio_mfft_t * fft);
149
150
151#ifdef __cplusplus
152}
153#endif
154
155#endif
Note: See TracBrowser for help on using the repository browser.