source: src/onset/onset.h @ 155cc10

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchsampler
Last change on this file since 155cc10 was 155cc10, checked in by Paul Brossier <piem@piem.org>, 2 years ago

Merge branch 'master' into awhitening

  • Property mode set to 100644
File size: 8.5 KB
Line 
1/*
2  Copyright (C) 2006-2013 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  \example examples/aubioonset.c
37  \example examples/aubionotes.c
38
39*/
40
41
42#ifndef AUBIO_ONSET_H
43#define AUBIO_ONSET_H
44
45#ifdef __cplusplus
46extern "C" {
47#endif
48
49/** onset detection object */
50typedef struct _aubio_onset_t aubio_onset_t;
51
52/** create onset detection object
53
54  \param method onset detection type as specified in specdesc.h
55  \param buf_size buffer size for phase vocoder
56  \param hop_size hop size for phase vocoder
57  \param samplerate sampling rate of the input signal
58
59  \return newly created ::aubio_onset_t
60
61*/
62aubio_onset_t * new_aubio_onset (const char_t * method,
63    uint_t buf_size, uint_t hop_size, uint_t samplerate);
64
65/** execute onset detection
66
67  \param o onset detection object as returned by new_aubio_onset()
68  \param input new audio vector of length hop_size
69  \param onset output vector of length 1, containing 0 if no onset was found,
70  and a value equal or greater than 1 otherwise
71
72  When no onset was detected, the first element of the output vector `onset`
73  is set to 0.
74
75  When an onset is found, the first element of the output vector `onset` is set
76  to `offset = 1 + a` where `a` is a number in the range`[0, 1]`.
77
78  The final onset detection time, in samples, can be obtained with
79  aubio_onset_get_last(). It can also be derived from `offset` as
80  follows:
81
82  \code
83    t = total_frames + offset * hop_size - delay
84  \endcode
85
86  where `total_frames` is the total number of frames processed so far, and
87  `delay` is the current delay of the onset object, as returned by
88  aubio_onset_get_delay().
89
90*/
91void aubio_onset_do (aubio_onset_t *o, const fvec_t * input, fvec_t * onset);
92
93/** get the time of the latest onset detected, in samples
94
95  \param o onset detection object as returned by new_aubio_onset()
96
97  \return onset detection timestamps (in samples)
98
99*/
100uint_t aubio_onset_get_last (const aubio_onset_t *o);
101
102/** get the time of the latest onset detected, in seconds
103
104  \param o onset detection object as returned by new_aubio_onset()
105
106  \return onset detection timestamps (in seconds)
107
108*/
109smpl_t aubio_onset_get_last_s (const aubio_onset_t *o);
110
111/** get the time of the latest onset detected, in milliseconds
112
113  \param o onset detection object as returned by new_aubio_onset()
114
115  \return onset detection timestamps (in milliseconds)
116
117*/
118smpl_t aubio_onset_get_last_ms (const aubio_onset_t *o);
119
120/** set onset detection adaptive whitening
121
122  \param o onset detection object as returned by new_aubio_onset()
123  \param apply_adaptive_whitening 1 to enable, 0 to disable
124
125*/
126uint_t aubio_onset_set_adaptive_whitening(aubio_onset_t * o, uint_t apply_adaptive_whitening);
127
128/** get onset detection silence threshold
129
130  \param o onset detection object as returned by new_aubio_onset()
131
132  \return adaptive whitening mode, 1 if enabled, 0 otherwise
133
134*/
135uint_t aubio_onset_get_adaptive_whitening(aubio_onset_t * o);
136
137/** set onset detection silence threshold
138
139  \param o onset detection object as returned by new_aubio_onset()
140  \param silence new silence detection threshold
141
142*/
143uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence);
144
145/** get onset detection silence threshold
146
147  \param o onset detection object as returned by new_aubio_onset()
148
149  \return current silence threshold
150
151*/
152smpl_t aubio_onset_get_silence(const aubio_onset_t * o);
153
154/** get onset detection function
155
156  \param o onset detection object as returned by new_aubio_onset()
157  \return the current value of the descriptor
158
159*/
160smpl_t aubio_onset_get_descriptor (const aubio_onset_t *o);
161
162/** get thresholded onset detection function
163
164  \param o onset detection object as returned by new_aubio_onset()
165  \return the value of the thresholded descriptor
166
167*/
168smpl_t aubio_onset_get_thresholded_descriptor (const aubio_onset_t *o);
169
170/** set onset detection peak picking threshold
171
172  \param o onset detection object as returned by new_aubio_onset()
173  \param threshold new peak-picking threshold
174
175*/
176uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold);
177
178/** set minimum inter onset interval in samples
179
180  \param o onset detection object as returned by new_aubio_onset()
181  \param minioi minimum interval between two consecutive onsets (in
182  samples)
183
184*/
185uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi);
186
187/** set minimum inter onset interval in seconds
188
189  \param o onset detection object as returned by new_aubio_onset()
190  \param minioi minimum interval between two consecutive onsets (in
191  seconds)
192
193*/
194uint_t aubio_onset_set_minioi_s(aubio_onset_t * o, smpl_t minioi);
195
196/** set minimum inter onset interval in milliseconds
197
198  \param o onset detection object as returned by new_aubio_onset()
199  \param minioi minimum interval between two consecutive onsets (in
200  milliseconds)
201
202*/
203uint_t aubio_onset_set_minioi_ms(aubio_onset_t * o, smpl_t minioi);
204
205/** set delay in samples
206
207  \param o onset detection object as returned by new_aubio_onset()
208  \param delay constant system delay to take back from detection time
209  (in samples)
210
211*/
212uint_t aubio_onset_set_delay(aubio_onset_t * o, uint_t delay);
213
214/** set delay in seconds
215
216  \param o onset detection object as returned by new_aubio_onset()
217  \param delay constant system delay to take back from detection time
218  (in seconds)
219
220*/
221uint_t aubio_onset_set_delay_s(aubio_onset_t * o, smpl_t delay);
222
223/** set delay in milliseconds
224
225  \param o onset detection object as returned by new_aubio_onset()
226  \param delay constant system delay to take back from detection time
227  (in milliseconds)
228
229*/
230uint_t aubio_onset_set_delay_ms(aubio_onset_t * o, smpl_t delay);
231
232/** get minimum inter onset interval in samples
233
234  \param o onset detection object as returned by new_aubio_onset()
235  \return minimum interval between two consecutive onsets (in
236  samples)
237
238*/
239uint_t aubio_onset_get_minioi(const aubio_onset_t * o);
240
241/** get minimum inter onset interval in seconds
242
243  \param o onset detection object as returned by new_aubio_onset()
244  \return minimum interval between two consecutive onsets (in
245  seconds)
246
247*/
248smpl_t aubio_onset_get_minioi_s(const aubio_onset_t * o);
249
250/** get minimum inter onset interval in milliseconds
251
252  \param o onset detection object as returned by new_aubio_onset()
253  \return minimum interval between two consecutive onsets (in
254  milliseconds)
255
256*/
257smpl_t aubio_onset_get_minioi_ms(const aubio_onset_t * o);
258
259/** get delay in samples
260
261  \param o onset detection object as returned by new_aubio_onset()
262  \return constant system delay to take back from detection time
263  (in samples)
264
265*/
266uint_t aubio_onset_get_delay(const aubio_onset_t * o);
267
268/** get delay in seconds
269
270  \param o onset detection object as returned by new_aubio_onset()
271  \return constant system delay to take back from detection time
272  (in seconds)
273
274*/
275smpl_t aubio_onset_get_delay_s(const aubio_onset_t * o);
276
277/** get delay in milliseconds
278
279  \param o onset detection object as returned by new_aubio_onset()
280  \return constant system delay to take back from detection time
281  (in milliseconds)
282
283*/
284smpl_t aubio_onset_get_delay_ms(const aubio_onset_t * o);
285
286/** get onset peak picking threshold
287
288  \param o onset detection object as returned by new_aubio_onset()
289  \return current onset detection threshold
290
291*/
292smpl_t aubio_onset_get_threshold(const aubio_onset_t * o);
293
294/** delete onset detection object
295
296  \param o onset detection object to delete
297
298*/
299void del_aubio_onset(aubio_onset_t * o);
300
301#ifdef __cplusplus
302}
303#endif
304
305#endif /* AUBIO_ONSET_H */
Note: See TracBrowser for help on using the repository browser.