source: src/onset/onset.h @ 8b884ef

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

src/onset/: rename get_last_onset to get_last

  • Property mode set to 100644
File size: 7.4 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 of length 1, containing 0 if no onset was found,
66  and a value equal or greater than 1 otherwise
67
68  When no onset was detected, the first element of the output vector `onset`
69  is set to 0.
70
71  When an onset is found, the first element of the output vector `onset` is set
72  to `offset = 1 + a` where `a` is a number in the range`[0, 1]`.
73
74  The final onset detection time, in samples, can be obtained with
75  ::aubio_onset_get_last_onset. It can also be derived from `offset` as
76  follows:
77
78  \code
79    t = total_frames + offset * hop_size - delay
80  \endcode
81
82  where `total_frames` is the total number of frames processed so far, and
83  `delay` is the current delay of the onset object, as returned by
84  ::aubio_onset_get_delay.
85
86*/
87void aubio_onset_do (aubio_onset_t *o, fvec_t * input, fvec_t * onset);
88
89/** get the time of the latest onset detected, in samples
90
91  \param o onset detection object as returned by ::new_aubio_onset
92
93*/
94uint_t aubio_onset_get_last (aubio_onset_t *o);
95
96/** get the time of the latest onset detected, in seconds
97
98  \param o onset detection object as returned by ::new_aubio_onset
99
100*/
101smpl_t aubio_onset_get_last_s (aubio_onset_t *o);
102
103/** get the time of the latest onset detected, in milliseconds
104
105  \param o onset detection object as returned by ::new_aubio_onset
106
107*/
108smpl_t aubio_onset_get_last_ms (aubio_onset_t *o);
109
110/** set onset detection silence threshold
111
112  \param o onset detection object as returned by ::new_aubio_onset
113  \param silence new silence detection threshold
114
115*/
116uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence);
117
118/** get onset detection function
119
120  \param o onset detection object as returned by ::new_aubio_onset
121  \return the current value of the descriptor
122
123*/
124smpl_t aubio_onset_get_descriptor ( aubio_onset_t *o);
125
126/** get thresholded onset detection function
127
128  \param o onset detection object as returned by ::new_aubio_onset
129  \return the value of the thresholded descriptor
130
131*/
132smpl_t aubio_onset_get_thresholded_descriptor ( aubio_onset_t *o);
133
134/** set onset detection peak picking threshold
135
136  \param o onset detection object as returned by ::new_aubio_onset
137  \param threshold new peak-picking threshold
138
139*/
140uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold);
141
142/** set minimum inter onset interval in samples
143
144  \param o onset detection object as returned by ::new_aubio_onset
145  \param minioi minimum interval between two consecutive onsets (in
146  samples)
147
148*/
149uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi);
150
151/** set minimum inter onset interval in seconds
152
153  \param o onset detection object as returned by ::new_aubio_onset
154  \param minioi minimum interval between two consecutive onsets (in
155  seconds)
156
157*/
158uint_t aubio_onset_set_minioi_s(aubio_onset_t * o, smpl_t minioi);
159
160/** set minimum inter onset interval in milliseconds
161
162  \param o onset detection object as returned by ::new_aubio_onset
163  \param minioi minimum interval between two consecutive onsets (in
164  milliseconds)
165
166*/
167uint_t aubio_onset_set_minioi_ms(aubio_onset_t * o, smpl_t minioi);
168
169/** set minimum inter onset interval in samples
170
171  \param o onset detection object as returned by ::new_aubio_onset
172  \param delay constant system delay to take back from detection time
173  (in samples)
174
175*/
176uint_t aubio_onset_set_delay(aubio_onset_t * o, uint_t delay);
177
178/** set minimum inter onset interval in seconds
179
180  \param o onset detection object as returned by ::new_aubio_onset
181  \param delay constant system delay to take back from detection time
182  (in seconds)
183
184*/
185uint_t aubio_onset_set_delay_s(aubio_onset_t * o, smpl_t delay);
186
187/** set minimum inter onset interval in milliseconds
188
189  \param o onset detection object as returned by ::new_aubio_onset
190  \param delay constant system delay to take back from detection time
191  (in milliseconds)
192
193*/
194uint_t aubio_onset_set_delay_ms(aubio_onset_t * o, smpl_t delay);
195
196/** get minimum inter onset interval in samples
197
198  \param o onset detection object as returned by ::new_aubio_onset
199  \return minimum interval between two consecutive onsets (in
200  samples)
201
202*/
203uint_t aubio_onset_get_minioi(aubio_onset_t * o);
204
205/** get minimum inter onset interval in seconds
206
207  \param o onset detection object as returned by ::new_aubio_onset
208  \return minimum interval between two consecutive onsets (in
209  seconds)
210
211*/
212smpl_t aubio_onset_get_minioi_s(aubio_onset_t * o);
213
214/** get minimum inter onset interval in milliseconds
215
216  \param o onset detection object as returned by ::new_aubio_onset
217  \return minimum interval between two consecutive onsets (in
218  milliseconds)
219
220*/
221smpl_t aubio_onset_get_minioi_ms(aubio_onset_t * o);
222
223/** get minimum inter onset interval in samples
224
225  \param o onset detection object as returned by ::new_aubio_onset
226  \return constant system delay to take back from detection time
227  (in samples)
228
229*/
230uint_t aubio_onset_get_delay(aubio_onset_t * o);
231
232/** get minimum inter onset interval in seconds
233
234  \param o onset detection object as returned by ::new_aubio_onset
235  \return constant system delay to take back from detection time
236  (in seconds)
237
238*/
239smpl_t aubio_onset_get_delay_s(aubio_onset_t * o);
240
241/** get minimum inter onset interval in milliseconds
242
243  \param o onset detection object as returned by ::new_aubio_onset
244  \return constant system delay to take back from detection time
245  (in milliseconds)
246
247*/
248smpl_t aubio_onset_get_delay_ms(aubio_onset_t * o);
249
250/** delete onset detection object
251
252  \param o onset detection object to delete
253
254*/
255void del_aubio_onset(aubio_onset_t * o);
256
257#ifdef __cplusplus
258}
259#endif
260
261#endif /* ONSET_H */
Note: See TracBrowser for help on using the repository browser.