source: src/pitch/pitchyinfft.h @ 916f0929

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

src/pitch/pitchyinfft.h: improve documentation

  • Property mode set to 100644
File size: 2.9 KB
RevLine 
[650e39b]1/*
[e6a78ea]2  Copyright (C) 2003-2009 Paul Brossier <piem@aubio.org>
[650e39b]3
[e6a78ea]4  This file is part of aubio.
[650e39b]5
[e6a78ea]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/>.
[650e39b]18
19*/
20
[7f3ccc5e]21/** \file
22 
23  Pitch detection using a spectral implementation of the YIN algorithm
24 
25  This algorithm was derived from the YIN algorithm (see pitchyin.c). In this
26  implementation, a Fourier transform is used to compute a tapered square
27  difference function, which allows spectral weighting. Because the difference
28  function is tapered, the selection of the period is simplified.
29 
[100add6]30  Paul Brossier, [Automatic annotation of musical audio for interactive
31  systems](http://aubio.org/phd/), Chapter 3, Pitch Analysis, PhD thesis,
32  Centre for Digital music, Queen Mary University of London, London, UK, 2006.
[7f3ccc5e]33
[fbc5544]34  \example pitch/test-pitchyinfft.c
35
[7f3ccc5e]36*/
[650e39b]37
38#ifndef PITCHYINFFT_H
39#define PITCHYINFFT_H
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
[7f3ccc5e]45/** pitch detection object */
[650e39b]46typedef struct _aubio_pitchyinfft_t aubio_pitchyinfft_t;
47
[7f3ccc5e]48/** execute pitch detection on an input buffer
49 
[69b11d8]50  \param o pitch detection object as returned by new_aubio_pitchyinfft
51  \param samples_in input signal vector (length as specified at creation time)
52  \param cands_out pitch period candidates, in samples
[7f3ccc5e]53 
54*/
[69b11d8]55void aubio_pitchyinfft_do (aubio_pitchyinfft_t * o, fvec_t * samples_in, fvec_t * cands_out);
[7f3ccc5e]56/** creation of the pitch detection object
57 
[916f0929]58  \param samplerate samplerate of the input signal
[3ac7cb0]59  \param buf_size size of the input buffer to analyse
[7f3ccc5e]60 
61*/
[9c9202f]62aubio_pitchyinfft_t *new_aubio_pitchyinfft (uint_t samplerate, uint_t buf_size);
[ceed6dc]63/** deletion of the pitch detection object
64 
[69b11d8]65  \param o pitch detection object as returned by new_aubio_pitchyinfft()
[ceed6dc]66 
67*/
[69b11d8]68void del_aubio_pitchyinfft (aubio_pitchyinfft_t * o);
[650e39b]69
[22d33e2]70/** get tolerance parameter for YIN algorithm
71 
72  \param o YIN pitch detection object
73
74  \return tolerance parameter for minima selection [default 0.15]
75
76*/
[69b11d8]77smpl_t aubio_pitchyinfft_get_tolerance (aubio_pitchyinfft_t * o);
[22d33e2]78
79/** set tolerance parameter for YIN algorithm
80 
81  \param o YIN pitch detection object
82  \param tol tolerance parameter for minima selection [default 0.15]
83
84*/
[69b11d8]85uint_t aubio_pitchyinfft_set_tolerance (aubio_pitchyinfft_t * o, smpl_t tol);
[22d33e2]86
[5284e0d]87/** get current confidence of YIN algorithm
88
89  \param o YIN pitch detection object
90  \return confidence parameter
91
92*/
93smpl_t aubio_pitchyinfft_get_confidence (aubio_pitchyinfft_t * o);
94
[650e39b]95#ifdef __cplusplus
96}
97#endif
98
99#endif /*PITCHYINFFT_H*/ 
Note: See TracBrowser for help on using the repository browser.