source: src/pitch/pitchmcomb.h @ e5e693e

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

src/pitch/: change all _detect prototypes to _do

  • Property mode set to 100644
File size: 2.3 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  Pitch detection using multiple-comb filter
23
24  This fundamental frequency estimation algorithm implements spectral
25  flattening, multi-comb filtering and peak histogramming.
26
27  This method was designed by Juan P. Bello and described in:
28
29  Juan-Pablo Bello. ``Towards the Automated Analysis of Simple Polyphonic
30  Music''.  PhD thesis, Centre for Digital Music, Queen Mary University of
31  London, London, UK, 2003.
32
33*/
34
35#ifndef PITCHMCOMB_H
36#define PITCHMCOMB_H
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
42/** pitch detection object */
43typedef struct _aubio_pitchmcomb_t aubio_pitchmcomb_t;
44
45/** execute pitch detection on an input spectral frame
46 
47  \param p pitch detection object as returned by new_aubio_pitchmcomb
48  \param fftgrain input signal spectrum as computed by aubio_pvoc_do
49 
50*/
51smpl_t aubio_pitchmcomb_do (aubio_pitchmcomb_t * p, cvec_t * fftgrain);
52/** select the best candidates */
53uint_t aubio_pitch_cands(aubio_pitchmcomb_t * p, cvec_t * fftgrain, smpl_t * cands);
54/** creation of the pitch detection object
55 
56  \param bufsize size of the input buffer to analyse
57  \param hopsize step size between two consecutive analysis instant
58  \param channels number of channels to analyse
59  \param samplerate sampling rate of the signal
60 
61*/
62aubio_pitchmcomb_t * new_aubio_pitchmcomb(uint_t bufsize, uint_t hopsize, uint_t channels, uint_t samplerate);
63/** deletion of the pitch detection object
64 
65  \param p pitch detection object as returned by new_aubio_pitchfcomb
66 
67*/
68void del_aubio_pitchmcomb(aubio_pitchmcomb_t *p);
69
70#ifdef __cplusplus
71}
72#endif
73
74#endif/*PITCHMCOMB_H*/ 
Note: See TracBrowser for help on using the repository browser.