04002ff857d39673109e67efe06580b01c475a94
[aubio.git] / src / onset / onset.c
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 #include "aubio_priv.h"
22 #include "fvec.h"
23 #include "cvec.h"
24 #include "spectral/specdesc.h"
25 #include "spectral/phasevoc.h"
26 #include "onset/peakpicker.h"
27 #include "mathutils.h"
28 #include "onset/onset.h"
29
30 /** structure to store object state */
31 struct _aubio_onset_t {
32   aubio_pvoc_t * pv;            /**< phase vocoder */
33   aubio_specdesc_t * od;        /**< spectral descriptor */
34   aubio_peakpicker_t * pp;      /**< peak picker */
35   cvec_t * fftgrain;            /**< phase vocoder output */
36   fvec_t * desc;                /**< spectral description */
37   smpl_t silence;               /**< silence threhsold */
38   uint_t minioi;                /**< minimum inter onset interval */
39   uint_t delay;                 /**< constant delay, in samples, removed from detected onset times */
40   uint_t samplerate;            /**< sampling rate of the input signal */
41   uint_t hop_size;              /**< number of samples between two runs */
42
43   uint_t total_frames;          /**< total number of frames processed since the beginning */
44   uint_t last_onset;            /**< last detected onset location, in frames */
45 };
46
47 /* execute onset detection function on iput buffer */
48 void aubio_onset_do (aubio_onset_t *o, fvec_t * input, fvec_t * onset)
49 {
50   smpl_t isonset = 0;
51   aubio_pvoc_do (o->pv,input, o->fftgrain);
52   aubio_specdesc_do (o->od, o->fftgrain, o->desc);
53   aubio_peakpicker_do(o->pp, o->desc, onset);
54   isonset = onset->data[0];
55   if (isonset > 0.) {
56     if (aubio_silence_detection(input, o->silence)==1) {
57       //AUBIO_DBG ("silent onset, not marking as onset\n");
58       isonset  = 0;
59     } else {
60       uint_t new_onset = o->total_frames + (uint_t)ROUND(isonset * o->hop_size);
61       if (o->last_onset + o->minioi < new_onset) {
62         //AUBIO_DBG ("accepted detection, marking as onset\n");
63         o->last_onset = new_onset;
64       } else {
65         //AUBIO_DBG ("doubled onset, not marking as onset\n");
66         isonset  = 0;
67       }
68     }
69   } else {
70     // we are at the beginning of the file, and we don't find silence
71     if (o->total_frames <= o->delay && o->last_onset < o ->minioi && aubio_silence_detection(input, o->silence) == 0) {
72       //AUBIO_DBG ("beginning of file is not silent, marking as onset\n");
73       isonset = o->delay / o->hop_size;
74       o->last_onset = o->delay;
75     }
76   }
77   onset->data[0] = isonset;
78   o->total_frames += o->hop_size;
79   return;
80 }
81
82 uint_t aubio_onset_get_last (aubio_onset_t *o)
83 {
84   return o->last_onset - o->delay;
85 }
86
87 smpl_t aubio_onset_get_last_s (aubio_onset_t *o)
88 {
89   return aubio_onset_get_last (o) / (smpl_t) (o->samplerate);
90 }
91
92 smpl_t aubio_onset_get_last_ms (aubio_onset_t *o)
93 {
94   return aubio_onset_get_last_s (o) * 1000.;
95 }
96
97 uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence) {
98   o->silence = silence;
99   return AUBIO_OK;
100 }
101
102 uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold) {
103   aubio_peakpicker_set_threshold(o->pp, threshold);
104   return AUBIO_OK;
105 }
106
107 smpl_t aubio_onset_get_threshold(aubio_onset_t * o) {
108   return aubio_peakpicker_get_threshold(o->pp);
109 }
110
111 uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi) {
112   o->minioi = minioi;
113   return AUBIO_OK;
114 }
115
116 uint_t aubio_onset_get_minioi(aubio_onset_t * o) {
117   return o->minioi;
118 }
119
120 uint_t aubio_onset_set_minioi_s(aubio_onset_t * o, smpl_t minioi) {
121   return aubio_onset_set_minioi (o, minioi * o->samplerate);
122 }
123
124 smpl_t aubio_onset_get_minioi_s(aubio_onset_t * o) {
125   return aubio_onset_get_minioi (o) / (smpl_t) o->samplerate;
126 }
127
128 uint_t aubio_onset_set_minioi_ms(aubio_onset_t * o, smpl_t minioi) {
129   return aubio_onset_set_minioi_s (o, minioi / 1000.);
130 }
131
132 smpl_t aubio_onset_get_minioi_ms(aubio_onset_t * o) {
133   return aubio_onset_get_minioi_s (o) * 1000.;
134 }
135
136 uint_t aubio_onset_set_delay(aubio_onset_t * o, uint_t delay) {
137   o->delay = delay;
138   return AUBIO_OK;
139 }
140
141 uint_t aubio_onset_get_delay(aubio_onset_t * o) {
142   return o->delay;
143 }
144
145 uint_t aubio_onset_set_delay_s(aubio_onset_t * o, smpl_t delay) {
146   return aubio_onset_set_delay (o, delay * o->samplerate);
147 }
148
149 smpl_t aubio_onset_get_delay_s(aubio_onset_t * o) {
150   return aubio_onset_get_delay (o) / (smpl_t) o->samplerate;
151 }
152
153 uint_t aubio_onset_set_delay_ms(aubio_onset_t * o, smpl_t delay) {
154   return aubio_onset_set_delay_s (o, delay / 1000.);
155 }
156
157 smpl_t aubio_onset_get_delay_ms(aubio_onset_t * o) {
158   return aubio_onset_get_delay_s (o) * 1000.;
159 }
160
161 smpl_t aubio_onset_get_descriptor(aubio_onset_t * o) {
162   return o->desc->data[0];
163 }
164
165 smpl_t aubio_onset_get_thresholded_descriptor(aubio_onset_t * o) {
166   fvec_t * thresholded = aubio_peakpicker_get_thresholded_input(o->pp);
167   return thresholded->data[0];
168 }
169
170 /* Allocate memory for an onset detection */
171 aubio_onset_t * new_aubio_onset (char_t * onset_mode, 
172     uint_t buf_size, uint_t hop_size, uint_t samplerate)
173 {
174   aubio_onset_t * o = AUBIO_NEW(aubio_onset_t);
175   /* store creation parameters */
176   o->samplerate = samplerate;
177   o->hop_size = hop_size;
178
179   /* allocate memory */
180   o->pv = new_aubio_pvoc(buf_size, o->hop_size);
181   o->pp = new_aubio_peakpicker();
182   o->od = new_aubio_specdesc(onset_mode,buf_size);
183   o->fftgrain = new_cvec(buf_size);
184   o->desc = new_fvec(1);
185
186   /* set some default parameter */
187   aubio_onset_set_threshold (o, 0.3);
188   aubio_onset_set_delay(o, 4.3 * hop_size);
189   aubio_onset_set_minioi_ms(o, 20.);
190   aubio_onset_set_silence(o, -70.);
191
192   /* initialize internal variables */
193   o->last_onset = 0;
194   o->total_frames = 0;
195   return o;
196 }
197
198 void del_aubio_onset (aubio_onset_t *o)
199 {
200   del_aubio_specdesc(o->od);
201   del_aubio_peakpicker(o->pp);
202   del_aubio_pvoc(o->pv);
203   del_fvec(o->desc);
204   del_cvec(o->fftgrain);
205   AUBIO_FREE(o);
206 }