2 Copyright (C) 2006-2013 Paul Brossier <piem@aubio.org>
4 This file is part of aubio.
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.
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.
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/>.
23 Onset detection object
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
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.
35 \example onset/test-onset.c
36 \example examples/aubioonset.c
37 \example examples/aubionotes.c
42 #ifndef _AUBIO_ONSET_H
43 #define _AUBIO_ONSET_H
49 /** onset detection object */
50 typedef struct _aubio_onset_t aubio_onset_t;
52 /** create onset detection object
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
59 \return newly created ::aubio_onset_t
62 aubio_onset_t * new_aubio_onset (char_t * method,
63 uint_t buf_size, uint_t hop_size, uint_t samplerate);
65 /** execute onset detection
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
72 When no onset was detected, the first element of the output vector `onset`
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]`.
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
83 t = total_frames + offset * hop_size - delay
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().
91 void aubio_onset_do (aubio_onset_t *o, fvec_t * input, fvec_t * onset);
93 /** get the time of the latest onset detected, in samples
95 \param o onset detection object as returned by new_aubio_onset()
97 \return onset detection timestamps (in samples)
100 uint_t aubio_onset_get_last (aubio_onset_t *o);
102 /** get the time of the latest onset detected, in seconds
104 \param o onset detection object as returned by new_aubio_onset()
106 \return onset detection timestamps (in seconds)
109 smpl_t aubio_onset_get_last_s (aubio_onset_t *o);
111 /** get the time of the latest onset detected, in milliseconds
113 \param o onset detection object as returned by new_aubio_onset()
115 \return onset detection timestamps (in milliseconds)
118 smpl_t aubio_onset_get_last_ms (aubio_onset_t *o);
120 /** set onset detection silence threshold
122 \param o onset detection object as returned by new_aubio_onset()
123 \param silence new silence detection threshold
126 uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence);
128 /** get onset detection function
130 \param o onset detection object as returned by new_aubio_onset()
131 \return the current value of the descriptor
134 smpl_t aubio_onset_get_descriptor ( aubio_onset_t *o);
136 /** get thresholded onset detection function
138 \param o onset detection object as returned by new_aubio_onset()
139 \return the value of the thresholded descriptor
142 smpl_t aubio_onset_get_thresholded_descriptor ( aubio_onset_t *o);
144 /** set onset detection peak picking threshold
146 \param o onset detection object as returned by new_aubio_onset()
147 \param threshold new peak-picking threshold
150 uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold);
152 /** set minimum inter onset interval in samples
154 \param o onset detection object as returned by new_aubio_onset()
155 \param minioi minimum interval between two consecutive onsets (in
159 uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi);
161 /** set minimum inter onset interval in seconds
163 \param o onset detection object as returned by new_aubio_onset()
164 \param minioi minimum interval between two consecutive onsets (in
168 uint_t aubio_onset_set_minioi_s(aubio_onset_t * o, smpl_t minioi);
170 /** set minimum inter onset interval in milliseconds
172 \param o onset detection object as returned by new_aubio_onset()
173 \param minioi minimum interval between two consecutive onsets (in
177 uint_t aubio_onset_set_minioi_ms(aubio_onset_t * o, smpl_t minioi);
179 /** set minimum inter onset interval in samples
181 \param o onset detection object as returned by new_aubio_onset()
182 \param delay constant system delay to take back from detection time
186 uint_t aubio_onset_set_delay(aubio_onset_t * o, uint_t delay);
188 /** set minimum inter onset interval in seconds
190 \param o onset detection object as returned by new_aubio_onset()
191 \param delay constant system delay to take back from detection time
195 uint_t aubio_onset_set_delay_s(aubio_onset_t * o, smpl_t delay);
197 /** set minimum inter onset interval in milliseconds
199 \param o onset detection object as returned by new_aubio_onset()
200 \param delay constant system delay to take back from detection time
204 uint_t aubio_onset_set_delay_ms(aubio_onset_t * o, smpl_t delay);
206 /** get minimum inter onset interval in samples
208 \param o onset detection object as returned by new_aubio_onset()
209 \return minimum interval between two consecutive onsets (in
213 uint_t aubio_onset_get_minioi(aubio_onset_t * o);
215 /** get minimum inter onset interval in seconds
217 \param o onset detection object as returned by new_aubio_onset()
218 \return minimum interval between two consecutive onsets (in
222 smpl_t aubio_onset_get_minioi_s(aubio_onset_t * o);
224 /** get minimum inter onset interval in milliseconds
226 \param o onset detection object as returned by new_aubio_onset()
227 \return minimum interval between two consecutive onsets (in
231 smpl_t aubio_onset_get_minioi_ms(aubio_onset_t * o);
233 /** get minimum inter onset interval in samples
235 \param o onset detection object as returned by new_aubio_onset()
236 \return constant system delay to take back from detection time
240 uint_t aubio_onset_get_delay(aubio_onset_t * o);
242 /** get minimum inter onset interval in seconds
244 \param o onset detection object as returned by new_aubio_onset()
245 \return constant system delay to take back from detection time
249 smpl_t aubio_onset_get_delay_s(aubio_onset_t * o);
251 /** get minimum inter onset interval in milliseconds
253 \param o onset detection object as returned by new_aubio_onset()
254 \return constant system delay to take back from detection time
258 smpl_t aubio_onset_get_delay_ms(aubio_onset_t * o);
260 /** delete onset detection object
262 \param o onset detection object to delete
265 void del_aubio_onset(aubio_onset_t * o);
271 #endif /* _AUBIO_ONSET_H */