source: src/pitch/pitchyin.h @ 6f42c16

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

src/: change c header identifiers (see #35)

  • Property mode set to 100644
File size: 2.7 KB
Line 
1/*
2  Copyright (C) 2003-2013 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 developed 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      http://recherche.ircam.fr/equipes/pcm/cheveign/ps/2002_JASA_YIN_proof.pdf
33
34  \example pitch/test-pitchyin.c
35
36*/
37
38#ifndef AUBIO_PITCHYIN_H
39#define AUBIO_PITCHYIN_H
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45/** pitch detection object */
46typedef struct _aubio_pitchyin_t aubio_pitchyin_t;
47
48/** creation of the pitch detection object
49
50  \param buf_size size of the input buffer to analyse
51
52*/
53aubio_pitchyin_t *new_aubio_pitchyin (uint_t buf_size);
54
55/** deletion of the pitch detection object
56
57  \param o pitch detection object as returned by new_aubio_pitchyin()
58
59*/
60void del_aubio_pitchyin (aubio_pitchyin_t * o);
61
62/** execute pitch detection an input buffer
63
64  \param o pitch detection object as returned by new_aubio_pitchyin()
65  \param samples_in input signal vector (length as specified at creation time)
66  \param cands_out pitch period candidates, in samples
67
68*/
69void aubio_pitchyin_do (aubio_pitchyin_t * o, const fvec_t * samples_in, fvec_t * cands_out);
70
71
72/** set tolerance parameter for YIN algorithm
73
74  \param o YIN pitch detection object
75  \param tol tolerance parameter for minima selection [default 0.15]
76
77*/
78uint_t aubio_pitchyin_set_tolerance (aubio_pitchyin_t * o, smpl_t tol);
79
80/** get tolerance parameter for YIN algorithm
81
82  \param o YIN pitch detection object
83  \return tolerance parameter for minima selection [default 0.15]
84
85*/
86smpl_t aubio_pitchyin_get_tolerance (aubio_pitchyin_t * o);
87
88/** get current confidence of YIN algorithm
89
90  \param o YIN pitch detection object
91  \return confidence parameter
92
93*/
94smpl_t aubio_pitchyin_get_confidence (aubio_pitchyin_t * o);
95
96#ifdef __cplusplus
97}
98#endif
99
100#endif /* AUBIO_PITCHYIN_H */
Note: See TracBrowser for help on using the repository browser.