source: src/pitch/pitch.h @ 846330f

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

src/pitch/pitch.h: improve documentation

  • Property mode set to 100644
File size: 3.2 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#ifndef PITCH_H
22#define PITCH_H
23
24#ifdef __cplusplus
25extern "C" {
26#endif
27
28/** \file
29
30  Generic method for pitch detection
31
32  This file creates the objects required for the computation of the selected
33  pitch detection algorithm and output the results, in midi note or Hz.
34
35  \example pitch/test-pitch.c
36
37*/
38
39/** pitch detection object */
40typedef struct _aubio_pitch_t aubio_pitch_t;
41
42/** execute pitch detection on an input signal frame
43
44  \param o pitch detection object as returned by new_aubio_pitch()
45  \param in input signal of size [hop_size]
46  \param out output pitch candidates of size [1]
47
48*/
49void aubio_pitch_do (aubio_pitch_t * o, fvec_t * in, fvec_t * out);
50
51/** change yin or yinfft tolerance threshold
52
53  \param o pitch detection object as returned by new_aubio_pitch()
54  \param tol tolerance default is 0.15 for yin and 0.85 for yinfft
55
56*/
57uint_t aubio_pitch_set_tolerance (aubio_pitch_t * o, smpl_t tol);
58
59/** deletion of the pitch detection object
60
61  \param o pitch detection object as returned by new_aubio_pitch()
62
63*/
64void del_aubio_pitch (aubio_pitch_t * o);
65
66/** creation of the pitch detection object
67
68  \param method set pitch detection algorithm
69  \param buf_size size of the input buffer to analyse
70  \param hop_size step size between two consecutive analysis instant
71  \param samplerate sampling rate of the signal
72
73*/
74aubio_pitch_t *new_aubio_pitch (char_t * method,
75    uint_t buf_size, uint_t hop_size, uint_t samplerate);
76
77/** set the output unit of the pitch detection object
78
79  \param o pitch detection object as returned by new_aubio_pitch()
80  \param mode set pitch units for output
81
82  \return 0 if successfull, non-zero otherwise
83
84*/
85uint_t aubio_pitch_set_unit (aubio_pitch_t * o, char_t * mode);
86
87/** set the silence threshold of the pitch detection object
88
89  \param o pitch detection object as returned by new_aubio_pitch()
90  \param silence level threshold under which pitch should be ignored, in dB
91
92  \return 0 if successfull, non-zero otherwise
93
94*/
95uint_t aubio_pitch_set_silence (aubio_pitch_t * o, smpl_t silence);
96
97/** set the silence threshold of the pitch detection object
98
99  \param o pitch detection object as returned by ::new_aubio_pitch()
100
101  \return level threshold under which pitch should be ignored, in dB
102
103*/
104smpl_t aubio_pitch_get_silence (aubio_pitch_t * o);
105
106/** get the current confidence
107
108  \param o pitch detection object as returned by new_aubio_pitch()
109
110  \return the current confidence of the pitch algorithm
111
112*/
113smpl_t aubio_pitch_get_confidence (aubio_pitch_t * o);
114
115#ifdef __cplusplus
116}
117#endif
118
119#endif /*PITCH_H*/
Note: See TracBrowser for help on using the repository browser.