source: src/onset/onset.h @ f5e0a54

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since f5e0a54 was f5e0a54, checked in by Paul Brossier <piem@piem.org>, 11 years ago

src/onset/onset.c: add get_last_onset

  • Property mode set to 100644
File size: 3.9 KB
RevLine 
[7524d0b]1/*
[e6a78ea]2  Copyright (C) 2006-2009 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
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
[69b11d8]28  ::aubio_onset_do is filled with `1`. Otherwise, the output vector remains
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
36
[895ad8c]37*/
[0e5326d]38
[895ad8c]39
[7524d0b]40#ifndef ONSET_H
41#define ONSET_H
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
[895ad8c]47/** onset detection object */
[7524d0b]48typedef struct _aubio_onset_t aubio_onset_t;
49
[895ad8c]50/** create onset detection object
51 
[3ac7cb0]52  \param method onset detection type as specified in specdesc.h
[895ad8c]53  \param buf_size buffer size for phase vocoder
54  \param hop_size hop size for phase vocoder
[29808b1]55  \param samplerate sampling rate of the input signal
[895ad8c]56
57*/
[3ac7cb0]58aubio_onset_t * new_aubio_onset (char_t * method, 
[0b9a02a]59    uint_t buf_size, uint_t hop_size, uint_t samplerate);
[7524d0b]60
[895ad8c]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*/
[a72f3f1]68void aubio_onset_do (aubio_onset_t *o, fvec_t * input, fvec_t * onset);
[7524d0b]69
[f5e0a54]70/** get the time of the latest onset detected, in samples
71
72  \param o onset detection object as returned by new_aubio_onset
73
74*/
75smpl_t aubio_onset_get_last_onset (aubio_onset_t *o);
76
77/** get the time of the latest onset detected, in seconds
78
79  \param o onset detection object as returned by new_aubio_onset
80
81*/
82smpl_t aubio_onset_get_last_onset_s (aubio_onset_t *o);
83
84/** get the time of the latest onset detected, in milliseconds
85
86  \param o onset detection object as returned by new_aubio_onset
87
88*/
89smpl_t aubio_onset_get_last_onset_ms (aubio_onset_t *o);
90
[895ad8c]91/** set onset detection silence threshold
92
93  \param o onset detection object as returned by new_aubio_onset
94  \param silence new silence detection threshold
95
96*/
[6338636]97uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence);
[7524d0b]98
[ae81726]99/** get onset detection function
100
101  \param o onset detection object as returned by new_aubio_onset
102  \return the current value of the descriptor
103
104*/
105smpl_t aubio_onset_get_descriptor ( aubio_onset_t *o);
106
107/** get thresholded onset detection function
108
109  \param o onset detection object as returned by new_aubio_onset
110  \return the value of the thresholded descriptor
111
112*/
113smpl_t aubio_onset_get_thresholded_descriptor ( aubio_onset_t *o);
114
[895ad8c]115/** set onset detection peak picking threshold
116
117  \param o onset detection object as returned by new_aubio_onset
118  \param threshold new peak-picking threshold
119
120*/
[6338636]121uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold);
[7524d0b]122
[895ad8c]123/** set minimum inter onset interval
124
125  \param o onset detection object as returned by new_aubio_onset
[0bbdbfd]126  \param minioi minimum interval between two consecutive onsets (in
127  milliseconds)
[895ad8c]128
129*/
[6338636]130uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi);
[7524d0b]131
[895ad8c]132/** delete onset detection object
133
134  \param o onset detection object to delete
135
136*/
[7524d0b]137void del_aubio_onset(aubio_onset_t * o);
138
139#ifdef __cplusplus
140}
141#endif
142
143#endif /* ONSET_H */
Note: See TracBrowser for help on using the repository browser.