source: src/peakpick.h @ 5316012

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

add some documentation
add some documentation

  • Property mode set to 100644
File size: 2.2 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 * peak picking utilities function
22 *
23 * \todo check/fix peak picking
24 */
25
26#ifndef PEAKPICK_H
27#define PEAKPICK_H
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33/** function pointer to thresholding function */
34typedef smpl_t (*aubio_thresholdfn_t)(fvec_t *input);
35/** function pointer to peak-picking function */
36typedef uint_t (*aubio_pickerfn_t)(fvec_t *input, uint_t pos);
37/** peak-picker structure */
38typedef struct _aubio_pickpeak_t aubio_pickpeak_t;
39
40/** peak-picker creation function */
41aubio_pickpeak_t * new_aubio_peakpicker(smpl_t threshold);
42/** real time peak picking function */
43uint_t aubio_peakpick_pimrt(fvec_t * DF, aubio_pickpeak_t * p);
44/** function added by Miguel Ramirez to return the onset detection amplitude in peakval */
45uint_t aubio_peakpick_pimrt_wt( fvec_t* DF, aubio_pickpeak_t* p, smpl_t* peakval );
46/** get current peak value */
47smpl_t aubio_peakpick_pimrt_getval(aubio_pickpeak_t * p);
48/** destroy peak picker structure */
49void del_aubio_peakpicker(aubio_pickpeak_t * p);
50
51/** set peak picking threshold */
52void aubio_peakpicker_set_threshold(aubio_pickpeak_t * p, smpl_t threshold);
53/** get peak picking threshold */
54smpl_t aubio_peakpicker_get_threshold(aubio_pickpeak_t * p);
55/** set peak picker thresholding function */
56void aubio_peakpicker_set_thresholdfn(aubio_pickpeak_t * p, aubio_thresholdfn_t thresholdfn);
57/** get peak picker thresholding function */
58aubio_thresholdfn_t aubio_peakpicker_get_thresholdfn(aubio_pickpeak_t * p);
59
60#ifdef __cplusplus
61}
62#endif
63
64#endif /* PEAKPICK_H */
Note: See TracBrowser for help on using the repository browser.