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