source: src/spectral/mfcc.h @ a6db140

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

src/spectral/mfcc.{c,h}: add documentation

  • Property mode set to 100644
File size: 1.7 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  Mel-frequency cepstrum coefficients object
25
26*/
27
28#ifndef MFCC_H
29#define MFCC_H
30
31#ifdef __cplusplus
32extern "C"
33{
34#endif
35
36/** mfcc object */
37typedef struct _aubio_mfcc_t aubio_mfcc_t;
38
39/** create mfcc object
40
41  \param win_s size of analysis buffer (and length the FFT transform)
42  \param samplerate audio sampling rate
43  \param n_coefs number of desired coefficients
44  \param n_filters number of desired filters
45
46*/
47aubio_mfcc_t *new_aubio_mfcc (uint_t win_s, uint_t samplerate,
48      uint_t n_filters, uint_t n_coefs);
49
50/** delete mfcc object
51
52  \param mf mfcc object as returned by new_aubio_mfcc
53
54*/
55void del_aubio_mfcc (aubio_mfcc_t * mf);
56
57/** mfcc object processing
58
59  \param mf mfcc object as returned by new_aubio_mfcc
60  \param in input spectrum (win_s long)
61  \param out output mel coefficients buffer (n_coeffs long)
62
63*/
64void aubio_mfcc_do (aubio_mfcc_t * mf, cvec_t * in, fvec_t * out);
65
66#ifdef __cplusplus
67}
68#endif
69
70#endif                          // MFCC_H
Note: See TracBrowser for help on using the repository browser.