source: src/onset/onset.h @ 69b11d8

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

src/*/*.h: add link to examples, remove trailing spaces, improve documentation

  • Property mode set to 100644
File size: 3.3 KB
Line 
1/*
2  Copyright (C) 2006-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/** \file
22 
23  Onset detection object
24
25  The following routines compute the onset detection function and detect peaks
26  in these functions. When onsets are found above a given silence threshold,
27  and after a minimum inter-onset interval, the output vector returned by
28  ::aubio_onset_do is filled with `1`. Otherwise, the output vector remains
29  `0`.
30
31  The peak-picking threshold, the silence threshold, and the minimum
32  inter-onset interval can be adjusted during the execution of the
33  aubio_onset_do routine using the corresponding functions.
34
35  \example onset/test-onset.c
36
37*/
38
39
40#ifndef ONSET_H
41#define ONSET_H
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
47/** onset detection object */
48typedef struct _aubio_onset_t aubio_onset_t;
49
50/** create onset detection object
51 
52  \param method onset detection type as specified in specdesc.h
53  \param buf_size buffer size for phase vocoder
54  \param hop_size hop size for phase vocoder
55  \param samplerate sampling rate of the input signal
56
57*/
58aubio_onset_t * new_aubio_onset (char_t * method, 
59    uint_t buf_size, uint_t hop_size, uint_t samplerate);
60
61/** execute onset detection
62
63  \param o onset detection object as returned by new_aubio_onset
64  \param input new audio vector of length hop_size
65  \param onset output vector, 1 if onset is found, 0 otherwise
66
67*/
68void aubio_onset_do (aubio_onset_t *o, fvec_t * input, fvec_t * onset);
69
70/** set onset detection silence threshold
71
72  \param o onset detection object as returned by new_aubio_onset
73  \param silence new silence detection threshold
74
75*/
76uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence);
77
78/** get onset detection function
79
80  \param o onset detection object as returned by new_aubio_onset
81  \return the current value of the descriptor
82
83*/
84smpl_t aubio_onset_get_descriptor ( aubio_onset_t *o);
85
86/** get thresholded onset detection function
87
88  \param o onset detection object as returned by new_aubio_onset
89  \return the value of the thresholded descriptor
90
91*/
92smpl_t aubio_onset_get_thresholded_descriptor ( aubio_onset_t *o);
93
94/** set onset detection peak picking threshold
95
96  \param o onset detection object as returned by new_aubio_onset
97  \param threshold new peak-picking threshold
98
99*/
100uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold);
101
102/** set minimum inter onset interval
103
104  \param o onset detection object as returned by new_aubio_onset
105  \param minioi minimum interval between two consecutive onsets (in
106  milliseconds)
107
108*/
109uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi);
110
111/** delete onset detection object
112
113  \param o onset detection object to delete
114
115*/
116void del_aubio_onset(aubio_onset_t * o);
117
118#ifdef __cplusplus
119}
120#endif
121
122#endif /* ONSET_H */
Note: See TracBrowser for help on using the repository browser.