source: src/spectral/filterbank.h @ 554e286

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

src/spectral/filterbank.h: improve documentation

  • Property mode set to 100644
File size: 2.2 KB
Line 
1/*
2  Copyright (C) 2007-2009 Paul Brossier <piem@aubio.org>
3                      and Amaury Hazan <ahazan@iua.upf.edu>
4
5  This file is part of aubio.
6
7  aubio is free software: you can redistribute it and/or modify
8  it under the terms of the GNU General Public License as published by
9  the Free Software Foundation, either version 3 of the License, or
10  (at your option) any later version.
11
12  aubio is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  GNU General Public License for more details.
16
17  You should have received a copy of the GNU General Public License
18  along with aubio.  If not, see <http://www.gnu.org/licenses/>.
19
20*/
21
22/** \file
23
24  Filterbank object
25
26  General-purpose spectral filterbank object.
27
28*/
29
30#ifndef FILTERBANK_H
31#define FILTERBANK_H
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38/** filterbank object */
39typedef struct _aubio_filterbank_t aubio_filterbank_t;
40
41/** create filterbank object
42
43  \param n_filters number of filters to create
44  \param win_s size of analysis buffer (and length the FFT transform)
45
46*/
47aubio_filterbank_t *new_aubio_filterbank (uint_t n_filters, uint_t win_s);
48
49/** destroy filterbank object
50
51  \param fb filterbank, as returned by new_aubio_filterbank() method
52
53*/
54void del_aubio_filterbank (aubio_filterbank_t * fb);
55
56/** compute filterbank
57
58  \param fb filterbank containing     nfilt x win_s filter coefficients
59  \param in input spectrum containing chans x win_s spectrum
60  \param out output vector containing chans x nfilt output values
61
62*/
63void aubio_filterbank_do (aubio_filterbank_t * fb, cvec_t * in, fvec_t * out);
64
65/** return a pointer to the fvec object containing all filter coefficients
66
67  \param f filterbank object to get coefficients from
68
69 */
70fvec_t *aubio_filterbank_get_coeffs (aubio_filterbank_t * f);
71
72/** copy filter coefficients to the filterbank
73
74  \param f filterbank object to set coefficients
75  \param filters filter bank coefficients to copy from
76
77 */
78uint_t aubio_filterbank_set_coeffs (aubio_filterbank_t * f, fvec_t * filters);
79
80#ifdef __cplusplus
81}
82#endif
83
84#endif                          // FILTERBANK_H
Note: See TracBrowser for help on using the repository browser.