source: src/pitchfcomb.h @ 6ebcb08

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 6ebcb08 was 7f3ccc5e, checked in by Paul Brossier <piem@altern.org>, 18 years ago

update pitch method comments
update pitch method comments

  • Property mode set to 100644
File size: 2.1 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 a fast harmonic comb filter
23
24   This pitch extraction method implements a fast harmonic comb filter to
25   determine the fundamental frequency of a harmonic sound.
26
27   This file was derived from the tuneit project, written by Mario Lang to
28   detect the fundamental frequency of a sound.
29   
30   see http://delysid.org/tuneit.html
31
32*/
33
34#ifndef _PITCHFCOMB_H
35#define _PITCHFCOMB_H
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/** pitch detection object */
42typedef struct _aubio_pitchfcomb_t aubio_pitchfcomb_t;
43
44/** execute pitch detection on an input buffer
45 
46  \param p pitch detection object as returned by new_aubio_pitchfcomb
47  \param input input signal window (length as specified at creation time)
48 
49*/
50smpl_t aubio_pitchfcomb_detect (aubio_pitchfcomb_t *p, fvec_t * input);
51/** creation of the pitch detection object
52 
53  \param bufsize size of the input buffer to analyse
54  \param hopsize step size between two consecutive analysis instant
55  \param samplerate sampling rate of the signal
56 
57*/
58aubio_pitchfcomb_t * new_aubio_pitchfcomb (uint_t bufsize, uint_t hopsize, uint_t samplerate);
59/** deletion of the pitch detection object
60 
61  \param p pitch detection object as returned by new_aubio_pitchfcomb
62 
63*/
64void del_aubio_pitchfcomb (aubio_pitchfcomb_t *p);
65
66
67#ifdef __cplusplus
68}
69#endif
70
71#endif /* _PITCHFCOMB_H */
72
73
Note: See TracBrowser for help on using the repository browser.