source: src/onset/onset.h @ ae81726

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

src/onset/onset.{c,h}: added get_descriptor and get_thresholded_descriptor

  • Property mode set to 100644
File size: 3.3 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 driver
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 0.
29
30  The peak-picking threshold, the silence threshold, and the minimum
31  inter-onset interval can be adjusted during the execution of the
32  aubio_onset_do routine using the corresponding functions.
33
34*/
35
36
37#ifndef ONSET_H
38#define ONSET_H
39
40#ifdef __cplusplus
41extern "C" {
42#endif
43
44/** onset detection object */
45typedef struct _aubio_onset_t aubio_onset_t;
46
47/** create onset detection object
48 
49  \param method onset detection type as specified in specdesc.h
50  \param buf_size buffer size for phase vocoder
51  \param hop_size hop size for phase vocoder
52  \param samplerate sampling rate of the input signal
53
54*/
55aubio_onset_t * new_aubio_onset (char_t * method, 
56    uint_t buf_size, uint_t hop_size, uint_t samplerate);
57
58/** execute onset detection
59
60  \param o onset detection object as returned by new_aubio_onset
61  \param input new audio vector of length hop_size
62  \param onset output vector, 1 if onset is found, 0 otherwise
63
64*/
65void aubio_onset_do (aubio_onset_t *o, fvec_t * input, fvec_t * onset);
66
67/** set onset detection silence threshold
68
69  \param o onset detection object as returned by new_aubio_onset
70  \param silence new silence detection threshold
71
72*/
73uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence);
74
75/** get onset detection function
76
77  \param o onset detection object as returned by new_aubio_onset
78  \return the current value of the descriptor
79
80*/
81smpl_t aubio_onset_get_descriptor ( aubio_onset_t *o);
82
83/** get thresholded onset detection function
84
85  \param o onset detection object as returned by new_aubio_onset
86  \return the value of the thresholded descriptor
87
88*/
89smpl_t aubio_onset_get_thresholded_descriptor ( aubio_onset_t *o);
90
91/** set onset detection peak picking threshold
92
93  \param o onset detection object as returned by new_aubio_onset
94  \param threshold new peak-picking threshold
95
96*/
97uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold);
98
99/** set minimum inter onset interval
100
101  \param o onset detection object as returned by new_aubio_onset
102  \param minioi minimum interval between two consecutive onsets (in
103  milliseconds)
104
105*/
106uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi);
107
108/** delete onset detection object
109
110  \param o onset detection object to delete
111
112*/
113void del_aubio_onset(aubio_onset_t * o);
114
115#ifdef __cplusplus
116}
117#endif
118
119#endif /* ONSET_H */
Note: See TracBrowser for help on using the repository browser.