source: src/pitch/pitchyin.h @ 5284e0d

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

src/pitch: start adding confidence

  • Property mode set to 100644
File size: 2.5 KB
Line 
1/*
2  Copyright (C) 2003-2009 Paul Brossier <piem@aubio.org>
3
4  This file is part of aubio.
5
6  aubio is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10
11  aubio is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  GNU General Public License for more details.
15
16  You should have received a copy of the GNU General Public License
17  along with aubio.  If not, see <http://www.gnu.org/licenses/>.
18
19*/
20
21/** \file
22
23  Pitch detection using the YIN algorithm
24
25  This algorithm was developped by A. de Cheveigne and H. Kawahara and
26  published in:
27
28  De Cheveigné, A., Kawahara, H. (2002) "YIN, a fundamental frequency
29  estimator for speech and music", J. Acoust. Soc. Am. 111, 1917-1930.
30
31  see http://recherche.ircam.fr/equipes/pcm/pub/people/cheveign.html
32
33  \example pitch/test-pitchyin.c
34
35*/
36
37#ifndef PITCHYIN_H
38#define PITCHYIN_H
39
40#ifdef __cplusplus
41extern "C" {
42#endif
43
44/** pitch detection object */
45typedef struct _aubio_pitchyin_t aubio_pitchyin_t;
46
47/** creation of the pitch detection object
48
49  \param buf_size size of the input buffer to analyse
50
51*/
52aubio_pitchyin_t *new_aubio_pitchyin (uint_t buf_size);
53
54/** deletion of the pitch detection object
55
56  \param o pitch detection object as returned by new_aubio_pitchyin()
57
58*/
59void del_aubio_pitchyin (aubio_pitchyin_t * o);
60
61/** execute pitch detection an input buffer
62
63  \param o pitch detection object as returned by new_aubio_pitchyin()
64  \param samples_in input signal vector (length as specified at creation time)
65  \param cands_out pitch period candidates, in samples
66
67*/
68void aubio_pitchyin_do (aubio_pitchyin_t * o, fvec_t * samples_in, fvec_t * cands_out);
69
70
71/** set tolerance parameter for YIN algorithm
72
73  \param o YIN pitch detection object
74  \param tol tolerance parameter for minima selection [default 0.15]
75
76*/
77uint_t aubio_pitchyin_set_tolerance (aubio_pitchyin_t * o, smpl_t tol);
78
79/** get tolerance parameter for YIN algorithm
80
81  \param o YIN pitch detection object
82  \return tolerance parameter for minima selection [default 0.15]
83
84*/
85smpl_t aubio_pitchyin_get_tolerance (aubio_pitchyin_t * o);
86
87/** get current confidence of YIN algorithm
88
89  \param o YIN pitch detection object
90  \return confidence parameter
91
92*/
93smpl_t aubio_pitchyin_get_confidence (aubio_pitchyin_t * o);
94
95#ifdef __cplusplus
96}
97#endif
98
99#endif /*PITCHYIN_H*/
Note: See TracBrowser for help on using the repository browser.