src/onset/onset.{c,h}: minimum inter-onset-interval in millisecond
[aubio.git] / src / onset / onset.c
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 #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/peakpick.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;  /**< onset detection */ 
34   aubio_peakpicker_t * pp;      /**< peak picker */
35   cvec_t * fftgrain;            /**< phase vocoder output */
36   fvec_t * of;                  /**< onset detection function */
37   smpl_t threshold;             /**< onset peak picking threshold */
38   smpl_t silence;               /**< silence threhsold */
39   uint_t minioi;                /**< minimum inter onset interval */
40   fvec_t * wasonset;            /**< number of frames since last onset */
41   uint_t samplerate;            /**< sampling rate of the input signal */
42 };
43
44 /* execute onset detection function on iput buffer */
45 void aubio_onset_do (aubio_onset_t *o, fvec_t * input, fvec_t * onset)
46 {
47   smpl_t isonset = 0;
48   smpl_t wasonset = 0;
49   uint_t i;
50   aubio_pvoc_do (o->pv,input, o->fftgrain);
51   aubio_specdesc_do (o->od,o->fftgrain, o->of);
52   /*if (usedoubled) {
53     aubio_specdesc_do (o2,fftgrain, onset2);
54     onset->data[0][0] *= onset2->data[0][0];
55   }*/
56   aubio_peakpicker_do(o->pp, o->of, onset);
57   for (i = 0; i < input->channels; i++) {
58   isonset = onset->data[i][0];
59   wasonset = o->wasonset->data[i][0];
60   if (isonset > 0.) {
61     if (aubio_silence_detection(input, o->silence)==1) {
62       isonset  = 0;
63       wasonset++;
64     } else {
65       if (wasonset > o->minioi) {
66         wasonset = 0;
67       } else {
68         isonset  = 0;
69         wasonset++;
70       }
71     }
72   } else {
73     wasonset++;
74   }
75   o->wasonset->data[i][0] = wasonset;
76   onset->data[i][0] = isonset;
77   }
78   return;
79 }
80
81 uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence) {
82   o->silence = silence;
83   return AUBIO_OK;
84 }
85
86 uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold) {
87   o->threshold = threshold;
88   aubio_peakpicker_set_threshold(o->pp, o->threshold);
89   return AUBIO_OK;
90 }
91
92 uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi) {
93   o->minioi = FLOOR(minioi / 1000. * o->samplerate / o->hop_size);
94   return AUBIO_OK;
95 }
96
97 /* Allocate memory for an onset detection */
98 aubio_onset_t * new_aubio_onset (char_t * onset_mode, 
99     uint_t buf_size, uint_t hop_size, uint_t channels, uint_t samplerate)
100 {
101   aubio_onset_t * o = AUBIO_NEW(aubio_onset_t);
102   /** set some default parameter */
103   o->threshold = 0.3;
104   o->minioi    = 4;
105   o->silence   = -70;
106   o->wasonset  = new_fvec(1, channels);
107   o->samplerate = samplerate;
108   o->pv = new_aubio_pvoc(buf_size, hop_size, channels);
109   o->pp = new_aubio_peakpicker(channels);
110   aubio_peakpicker_set_threshold (o->pp, o->threshold);
111   o->od = new_aubio_specdesc(onset_mode,buf_size,channels);
112   o->fftgrain = new_cvec(buf_size,channels);
113   o->of = new_fvec(1, channels);
114   /*if (usedoubled)    {
115     o2 = new_aubio_specdesc(onset_type2,buffer_size,channels);
116     onset2 = new_fvec(1 , channels);
117   }*/
118   return o;
119 }
120
121 void del_aubio_onset (aubio_onset_t *o)
122 {
123   del_aubio_specdesc(o->od);
124   del_aubio_peakpicker(o->pp);
125   del_aubio_pvoc(o->pv);
126   del_fvec(o->of);
127   del_fvec(o->wasonset);
128   del_cvec(o->fftgrain);
129   AUBIO_FREE(o);
130 }