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 "spectral/awhitening.h"
  27 #include "onset/peakpicker.h"
  28 #include "mathutils.h"
  29 #include "onset/onset.h"
  30
  31 void aubio_onset_default_parameters (aubio_onset_t *o, char_t * method);
  32
  33 /** structure to store object state */
  34 struct _aubio_onset_t {
  35   aubio_pvoc_t * pv;            /**< phase vocoder */
  36   aubio_specdesc_t * od;        /**< spectral descriptor */
  37   aubio_peakpicker_t * pp;      /**< peak picker */
  38   cvec_t * fftgrain;            /**< phase vocoder output */
  39   fvec_t * desc;                /**< spectral description */
  40   smpl_t silence;               /**< silence threhsold */
  41   uint_t minioi;                /**< minimum inter onset interval */
  42   uint_t delay;                 /**< constant delay, in samples, removed from detected onset times */
  43   uint_t samplerate;            /**< sampling rate of the input signal */
  44   uint_t hop_size;              /**< number of samples between two runs */
  45
  46   uint_t total_frames;          /**< total number of frames processed since the beginning */
  47   uint_t last_onset;            /**< last detected onset location, in frames */
  48
  49   uint_t apply_adaptive_whitening;
  50   aubio_spectral_whitening_t *spectral_whitening;
  51 };
  52
  53 /* execute onset detection function on iput buffer */
  54 void aubio_onset_do (aubio_onset_t *o, fvec_t * input, fvec_t * onset)
  55 {
  56   smpl_t isonset = 0;
  57   aubio_pvoc_do (o->pv,input, o->fftgrain);
  58   /*
  59   if (apply_filtering) {
  60   }
  61   if (apply_compression) {
  62   }
  63   */
  64   if (o->apply_adaptive_whitening) {
  65     aubio_spectral_whitening_do(o->spectral_whitening, o->fftgrain);
  66   }
  67   aubio_specdesc_do (o->od, o->fftgrain, o->desc);
  68   aubio_peakpicker_do(o->pp, o->desc, onset);
  69   isonset = onset->data[0];
  70   if (isonset > 0.) {
  71     if (aubio_silence_detection(input, o->silence)==1) {
  72       //AUBIO_DBG ("silent onset, not marking as onset\n");
  73       isonset  = 0;
  74     } else {
  75       uint_t new_onset = o->total_frames + (uint_t)ROUND(isonset * o->hop_size);
  76       if (o->last_onset + o->minioi < new_onset) {
  77         //AUBIO_DBG ("accepted detection, marking as onset\n");
  78         o->last_onset = new_onset;
  79       } else {
  80         //AUBIO_DBG ("doubled onset, not marking as onset\n");
  81         isonset  = 0;
  82       }
  83     }
  84   } else {
  85     // we are at the beginning of the file
  86     if (o->total_frames <= o->delay) {
  87       // and we don't find silence
  88       if (aubio_silence_detection(input, o->silence) == 0) {
  89         uint_t new_onset = o->total_frames;
  90         if (o->total_frames == 0 || o->last_onset + o->minioi < new_onset) {
  91           isonset = o->delay / o->hop_size;
  92           o->last_onset = o->total_frames + o->delay;
  93         }
  94       }
  95     }
  96   }
  97   onset->data[0] = isonset;
  98   o->total_frames += o->hop_size;
  99   return;
 100 }
 101
 102 uint_t aubio_onset_get_last (aubio_onset_t *o)
 103 {
 104   return o->last_onset - o->delay;
 105 }
 106
 107 smpl_t aubio_onset_get_last_s (aubio_onset_t *o)
 108 {
 109   return aubio_onset_get_last (o) / (smpl_t) (o->samplerate);
 110 }
 111
 112 smpl_t aubio_onset_get_last_ms (aubio_onset_t *o)
 113 {
 114   return aubio_onset_get_last_s (o) * 1000.;
 115 }
 116
 117 uint_t aubio_onset_set_adaptive_whitening (aubio_onset_t *o, uint_t apply_adaptive_whitening)
 118 {
 119   o->apply_adaptive_whitening = apply_adaptive_whitening;
 120   return AUBIO_OK;
 121 }
 122
 123 uint_t aubio_onset_get_adaptive_whitening (aubio_onset_t *o)
 124 {
 125   return o->apply_adaptive_whitening;
 126 }
 127
 128 uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence) {
 129   o->silence = silence;
 130   return AUBIO_OK;
 131 }
 132
 133 smpl_t aubio_onset_get_silence(aubio_onset_t * o) {
 134   return o->silence;
 135 }
 136
 137 uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold) {
 138   aubio_peakpicker_set_threshold(o->pp, threshold);
 139   return AUBIO_OK;
 140 }
 141
 142 smpl_t aubio_onset_get_threshold(aubio_onset_t * o) {
 143   return aubio_peakpicker_get_threshold(o->pp);
 144 }
 145
 146 uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi) {
 147   o->minioi = minioi;
 148   return AUBIO_OK;
 149 }
 150
 151 uint_t aubio_onset_get_minioi(aubio_onset_t * o) {
 152   return o->minioi;
 153 }
 154
 155 uint_t aubio_onset_set_minioi_s(aubio_onset_t * o, smpl_t minioi) {
 156   return aubio_onset_set_minioi (o, minioi * o->samplerate);
 157 }
 158
 159 smpl_t aubio_onset_get_minioi_s(aubio_onset_t * o) {
 160   return aubio_onset_get_minioi (o) / (smpl_t) o->samplerate;
 161 }
 162
 163 uint_t aubio_onset_set_minioi_ms(aubio_onset_t * o, smpl_t minioi) {
 164   return aubio_onset_set_minioi_s (o, minioi / 1000.);
 165 }
 166
 167 smpl_t aubio_onset_get_minioi_ms(aubio_onset_t * o) {
 168   return aubio_onset_get_minioi_s (o) * 1000.;
 169 }
 170
 171 uint_t aubio_onset_set_delay(aubio_onset_t * o, uint_t delay) {
 172   o->delay = delay;
 173   return AUBIO_OK;
 174 }
 175
 176 uint_t aubio_onset_get_delay(aubio_onset_t * o) {
 177   return o->delay;
 178 }
 179
 180 uint_t aubio_onset_set_delay_s(aubio_onset_t * o, smpl_t delay) {
 181   return aubio_onset_set_delay (o, delay * o->samplerate);
 182 }
 183
 184 smpl_t aubio_onset_get_delay_s(aubio_onset_t * o) {
 185   return aubio_onset_get_delay (o) / (smpl_t) o->samplerate;
 186 }
 187
 188 uint_t aubio_onset_set_delay_ms(aubio_onset_t * o, smpl_t delay) {
 189   return aubio_onset_set_delay_s (o, delay / 1000.);
 190 }
 191
 192 smpl_t aubio_onset_get_delay_ms(aubio_onset_t * o) {
 193   return aubio_onset_get_delay_s (o) * 1000.;
 194 }
 195
 196 smpl_t aubio_onset_get_descriptor(aubio_onset_t * o) {
 197   return o->desc->data[0];
 198 }
 199
 200 smpl_t aubio_onset_get_thresholded_descriptor(aubio_onset_t * o) {
 201   fvec_t * thresholded = aubio_peakpicker_get_thresholded_input(o->pp);
 202   return thresholded->data[0];
 203 }
 204
 205 /* Allocate memory for an onset detection */
 206 aubio_onset_t * new_aubio_onset (char_t * onset_mode,
 207     uint_t buf_size, uint_t hop_size, uint_t samplerate)
 208 {
 209   aubio_onset_t * o = AUBIO_NEW(aubio_onset_t);
 210
 211   /* check parameters are valid */
 212   if ((sint_t)hop_size < 1) {
 213     AUBIO_ERR("onset: got hop_size %d, but can not be < 1\n", hop_size);
 214     goto beach;
 215   } else if ((sint_t)buf_size < 1) {
 216     AUBIO_ERR("onset: got buffer_size %d, but can not be < 1\n", buf_size);
 217     goto beach;
 218   } else if (buf_size < hop_size) {
 219     AUBIO_ERR("onset: hop size (%d) is larger than win size (%d)\n", buf_size, hop_size);
 220     goto beach;
 221   } else if ((sint_t)samplerate < 1) {
 222     AUBIO_ERR("onset: samplerate (%d) can not be < 1\n", samplerate);
 223     goto beach;
 224   }
 225
 226   /* store creation parameters */
 227   o->samplerate = samplerate;
 228   o->hop_size = hop_size;
 229
 230   /* allocate memory */
 231   o->pv = new_aubio_pvoc(buf_size, o->hop_size);
 232   o->pp = new_aubio_peakpicker();
 233   o->od = new_aubio_specdesc(onset_mode,buf_size);
 234   o->fftgrain = new_cvec(buf_size);
 235   o->desc = new_fvec(1);
 236
 237   o->spectral_whitening = new_aubio_spectral_whitening(buf_size, hop_size, samplerate);
 238
 239   aubio_onset_default_parameters (o, onset_mode);
 240
 241   /* initialize internal variables */
 242   o->last_onset = 0;
 243   o->total_frames = 0;
 244   return o;
 245
 246 beach:
 247   AUBIO_FREE(o);
 248   return NULL;
 249 }
 250
 251 void aubio_onset_default_parameters (aubio_onset_t * o, char_t * onset_mode)
 252 {
 253   /* set some default parameter */
 254   aubio_onset_set_threshold (o, 0.3);
 255   aubio_onset_set_delay (o, 4.3 * o->hop_size);
 256   aubio_onset_set_minioi_ms (o, 50.);
 257   aubio_onset_set_silence (o, -70.);
 258   aubio_onset_set_adaptive_whitening (o, 1);
 259
 260   /* method specific optimisations */
 261   if (strcmp (onset_mode, "energy") == 0) {
 262   } else if (strcmp (onset_mode, "hfc") == 0) {
 263     aubio_onset_set_adaptive_whitening (o, 0);
 264   } else if (strcmp (onset_mode, "complexdomain") == 0
 265              || strcmp (onset_mode, "complex") == 0) {
 266     aubio_onset_set_delay (o, 4.6 * o->hop_size);
 267     aubio_onset_set_threshold (o, 0.15);
 268   } else if (strcmp (onset_mode, "phase") == 0) {
 269     aubio_onset_set_adaptive_whitening (o, 0);
 270   } else if (strcmp (onset_mode, "mkl") == 0) {
 271     aubio_onset_set_threshold (o, 0.05);
 272   } else if (strcmp (onset_mode, "kl") == 0) {
 273     aubio_onset_set_threshold (o, 0.35);
 274   } else if (strcmp (onset_mode, "specflux") == 0) {
 275     aubio_onset_set_threshold (o, 0.4);
 276   } else if (strcmp (onset_mode, "specdiff") == 0) {
 277   } else if (strcmp (onset_mode, "default") == 0) {
 278   } else {
 279     AUBIO_ERR ("onset: unknown spectral descriptor type %s, "
 280                "using default parameters.\n", onset_mode);
 281   }
 282 }
 283
 284 void del_aubio_onset (aubio_onset_t *o)
 285 {
 286   del_aubio_spectral_whitening(o->spectral_whitening);
 287   del_aubio_specdesc(o->od);
 288   del_aubio_peakpicker(o->pp);
 289   del_aubio_pvoc(o->pv);
 290   del_fvec(o->desc);
 291   del_cvec(o->fftgrain);
 292   AUBIO_FREE(o);
 293 }