source: src/onset/onset.h @ 3e1c482

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/timestretchfix/ffmpeg5
Last change on this file since 3e1c482 was 340f5c7, checked in by Paul Brossier <piem@piem.org>, 7 years ago

src/onset/onset.h: rename logmag_compression to compression

  • Property mode set to 100644
File size: 9.5 KB
RevLine 
[7524d0b]1/*
[b235c0e]2  Copyright (C) 2006-2013 Paul Brossier <piem@aubio.org>
[7524d0b]3
[e6a78ea]4  This file is part of aubio.
[7524d0b]5
[e6a78ea]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.
[7524d0b]10
[e6a78ea]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/>.
[7524d0b]18
19*/
20
[895ad8c]21/** \file
[35f73b8c]22
[69b11d8]23  Onset detection object
[895ad8c]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
[479adba]28  aubio_onset_do() is filled with `1`. Otherwise, the output vector remains
[69b11d8]29  `0`.
[895ad8c]30
31  The peak-picking threshold, the silence threshold, and the minimum
[a72f3f1]32  inter-onset interval can be adjusted during the execution of the
33  aubio_onset_do routine using the corresponding functions.
[895ad8c]34
[69b11d8]35  \example onset/test-onset.c
[a6e2e5f]36  \example examples/aubioonset.c
37  \example examples/aubionotes.c
[69b11d8]38
[895ad8c]39*/
[0e5326d]40
[895ad8c]41
[6f42c16]42#ifndef AUBIO_ONSET_H
43#define AUBIO_ONSET_H
[7524d0b]44
45#ifdef __cplusplus
46extern "C" {
47#endif
48
[895ad8c]49/** onset detection object */
[7524d0b]50typedef struct _aubio_onset_t aubio_onset_t;
51
[895ad8c]52/** create onset detection object
[35f73b8c]53
[3ac7cb0]54  \param method onset detection type as specified in specdesc.h
[895ad8c]55  \param buf_size buffer size for phase vocoder
56  \param hop_size hop size for phase vocoder
[35f73b8c]57  \param samplerate sampling rate of the input signal
[895ad8c]58
[479adba]59  \return newly created ::aubio_onset_t
60
[895ad8c]61*/
[00819aa]62aubio_onset_t * new_aubio_onset (const char_t * method,
[0b9a02a]63    uint_t buf_size, uint_t hop_size, uint_t samplerate);
[7524d0b]64
[895ad8c]65/** execute onset detection
66
[479adba]67  \param o onset detection object as returned by new_aubio_onset()
[895ad8c]68  \param input new audio vector of length hop_size
[35f73b8c]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
[479adba]79  aubio_onset_get_last(). It can also be derived from `offset` as
[35f73b8c]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
[479adba]88  aubio_onset_get_delay().
[895ad8c]89
90*/
[00819aa]91void aubio_onset_do (aubio_onset_t *o, const fvec_t * input, fvec_t * onset);
[7524d0b]92
[f5e0a54]93/** get the time of the latest onset detected, in samples
94
[479adba]95  \param o onset detection object as returned by new_aubio_onset()
96
97  \return onset detection timestamps (in samples)
[f5e0a54]98
99*/
[00819aa]100uint_t aubio_onset_get_last (const aubio_onset_t *o);
[f5e0a54]101
102/** get the time of the latest onset detected, in seconds
103
[479adba]104  \param o onset detection object as returned by new_aubio_onset()
105
106  \return onset detection timestamps (in seconds)
[f5e0a54]107
108*/
[00819aa]109smpl_t aubio_onset_get_last_s (const aubio_onset_t *o);
[f5e0a54]110
111/** get the time of the latest onset detected, in milliseconds
112
[479adba]113  \param o onset detection object as returned by new_aubio_onset()
114
115  \return onset detection timestamps (in milliseconds)
[f5e0a54]116
117*/
[00819aa]118smpl_t aubio_onset_get_last_ms (const aubio_onset_t *o);
[f5e0a54]119
[7ac374d]120/** set onset detection adaptive whitening
121
122  \param o onset detection object as returned by new_aubio_onset()
[40ed6a7]123  \param enable 1 to enable, 0 to disable
124
125  \return 0 if successful, 1 otherwise
[7ac374d]126
127*/
[40ed6a7]128uint_t aubio_onset_set_awhitening(aubio_onset_t * o, uint_t enable);
[7ac374d]129
[40ed6a7]130/** get onset detection adaptive whitening
[7ac374d]131
132  \param o onset detection object as returned by new_aubio_onset()
133
[40ed6a7]134  \return 1 if enabled, 0 otherwise
[7ac374d]135
136*/
[40ed6a7]137smpl_t aubio_onset_get_awhitening(aubio_onset_t * o);
138
139/** set or disable log compression
140
141  \param o onset detection object as returned by new_aubio_onset()
[340f5c7]142  \param lambda logarithmic compression factor, 0 to disable
[40ed6a7]143
144  \return 0 if successful, 1 otherwise
145
146 */
[340f5c7]147uint_t aubio_onset_set_compression(aubio_onset_t *o, smpl_t lambda);
[40ed6a7]148
149/** get onset detection log compression
[340f5c7]150
151  \param o onset detection object as returned by new_aubio_onset()
152
153  \returns 0 if disabled, compression factor otherwise
154
[40ed6a7]155 */
[340f5c7]156smpl_t aubio_onset_get_compression(aubio_onset_t *o);
[7ac374d]157
[895ad8c]158/** set onset detection silence threshold
159
[479adba]160  \param o onset detection object as returned by new_aubio_onset()
[895ad8c]161  \param silence new silence detection threshold
162
163*/
[6338636]164uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence);
[7524d0b]165
[96a96d7]166/** get onset detection silence threshold
167
168  \param o onset detection object as returned by new_aubio_onset()
169
170  \return current silence threshold
171
172*/
[00819aa]173smpl_t aubio_onset_get_silence(const aubio_onset_t * o);
[96a96d7]174
[ae81726]175/** get onset detection function
176
[479adba]177  \param o onset detection object as returned by new_aubio_onset()
[ae81726]178  \return the current value of the descriptor
179
180*/
[00819aa]181smpl_t aubio_onset_get_descriptor (const aubio_onset_t *o);
[ae81726]182
183/** get thresholded onset detection function
184
[479adba]185  \param o onset detection object as returned by new_aubio_onset()
[ae81726]186  \return the value of the thresholded descriptor
187
188*/
[00819aa]189smpl_t aubio_onset_get_thresholded_descriptor (const aubio_onset_t *o);
[ae81726]190
[35f73b8c]191/** set onset detection peak picking threshold
[895ad8c]192
[479adba]193  \param o onset detection object as returned by new_aubio_onset()
[895ad8c]194  \param threshold new peak-picking threshold
195
196*/
[6338636]197uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold);
[7524d0b]198
[35f73b8c]199/** set minimum inter onset interval in samples
[895ad8c]200
[479adba]201  \param o onset detection object as returned by new_aubio_onset()
[0bbdbfd]202  \param minioi minimum interval between two consecutive onsets (in
[35f73b8c]203  samples)
[895ad8c]204
205*/
[6338636]206uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi);
[7524d0b]207
[35f73b8c]208/** set minimum inter onset interval in seconds
209
[479adba]210  \param o onset detection object as returned by new_aubio_onset()
[35f73b8c]211  \param minioi minimum interval between two consecutive onsets (in
212  seconds)
213
214*/
215uint_t aubio_onset_set_minioi_s(aubio_onset_t * o, smpl_t minioi);
216
217/** set minimum inter onset interval in milliseconds
218
[479adba]219  \param o onset detection object as returned by new_aubio_onset()
[35f73b8c]220  \param minioi minimum interval between two consecutive onsets (in
221  milliseconds)
222
223*/
224uint_t aubio_onset_set_minioi_ms(aubio_onset_t * o, smpl_t minioi);
225
[dba9b33]226/** set delay in samples
[35f73b8c]227
[479adba]228  \param o onset detection object as returned by new_aubio_onset()
[35f73b8c]229  \param delay constant system delay to take back from detection time
230  (in samples)
231
232*/
233uint_t aubio_onset_set_delay(aubio_onset_t * o, uint_t delay);
234
[dba9b33]235/** set delay in seconds
[35f73b8c]236
[479adba]237  \param o onset detection object as returned by new_aubio_onset()
[35f73b8c]238  \param delay constant system delay to take back from detection time
239  (in seconds)
240
241*/
242uint_t aubio_onset_set_delay_s(aubio_onset_t * o, smpl_t delay);
243
[dba9b33]244/** set delay in milliseconds
[35f73b8c]245
[479adba]246  \param o onset detection object as returned by new_aubio_onset()
[35f73b8c]247  \param delay constant system delay to take back from detection time
248  (in milliseconds)
249
250*/
251uint_t aubio_onset_set_delay_ms(aubio_onset_t * o, smpl_t delay);
252
253/** get minimum inter onset interval in samples
254
[479adba]255  \param o onset detection object as returned by new_aubio_onset()
[35f73b8c]256  \return minimum interval between two consecutive onsets (in
257  samples)
258
259*/
[00819aa]260uint_t aubio_onset_get_minioi(const aubio_onset_t * o);
[35f73b8c]261
262/** get minimum inter onset interval in seconds
263
[479adba]264  \param o onset detection object as returned by new_aubio_onset()
[35f73b8c]265  \return minimum interval between two consecutive onsets (in
266  seconds)
267
268*/
[00819aa]269smpl_t aubio_onset_get_minioi_s(const aubio_onset_t * o);
[35f73b8c]270
271/** get minimum inter onset interval in milliseconds
272
[479adba]273  \param o onset detection object as returned by new_aubio_onset()
[35f73b8c]274  \return minimum interval between two consecutive onsets (in
275  milliseconds)
276
277*/
[00819aa]278smpl_t aubio_onset_get_minioi_ms(const aubio_onset_t * o);
[35f73b8c]279
[dba9b33]280/** get delay in samples
[35f73b8c]281
[479adba]282  \param o onset detection object as returned by new_aubio_onset()
[35f73b8c]283  \return constant system delay to take back from detection time
284  (in samples)
285
286*/
[00819aa]287uint_t aubio_onset_get_delay(const aubio_onset_t * o);
[35f73b8c]288
[dba9b33]289/** get delay in seconds
[35f73b8c]290
[479adba]291  \param o onset detection object as returned by new_aubio_onset()
[35f73b8c]292  \return constant system delay to take back from detection time
293  (in seconds)
294
295*/
[00819aa]296smpl_t aubio_onset_get_delay_s(const aubio_onset_t * o);
[35f73b8c]297
[dba9b33]298/** get delay in milliseconds
[35f73b8c]299
[479adba]300  \param o onset detection object as returned by new_aubio_onset()
[35f73b8c]301  \return constant system delay to take back from detection time
302  (in milliseconds)
303
304*/
[00819aa]305smpl_t aubio_onset_get_delay_ms(const aubio_onset_t * o);
[35f73b8c]306
[10b11d6]307/** get onset peak picking threshold
308
309  \param o onset detection object as returned by new_aubio_onset()
310  \return current onset detection threshold
311
312*/
[00819aa]313smpl_t aubio_onset_get_threshold(const aubio_onset_t * o);
[10b11d6]314
[fa3edc6]315/** set default parameters
316
317  \param o onset detection object as returned by new_aubio_onset()
318  \param onset_mode detection mode to adjust
319
320  This function is called at the end of new_aubio_onset().
321
322 */
323uint_t aubio_onset_set_default_parameters (aubio_onset_t * o, const char_t * onset_mode);
324
325/** reset onset detection
326
327  \param o onset detection object as returned by new_aubio_onset()
328
329  Reset current time and last onset to 0.
330
331  This function is called at the end of new_aubio_onset().
332
333 */
334void aubio_onset_reset(aubio_onset_t * o);
335
[895ad8c]336/** delete onset detection object
337
[35f73b8c]338  \param o onset detection object to delete
[895ad8c]339
340*/
[7524d0b]341void del_aubio_onset(aubio_onset_t * o);
342
343#ifdef __cplusplus
344}
345#endif
346
[6f42c16]347#endif /* AUBIO_ONSET_H */
Note: See TracBrowser for help on using the repository browser.