Merge branch 'master' into awhitening
[aubio.git] / src / onset / onset.c
index ae73965..cdd539a 100644 (file)
 /*
-   Copyright (C) 2006 Paul Brossier
+  Copyright (C) 2006-2013 Paul Brossier <piem@aubio.org>
 
-   This program is free software; you can redistribute it and/or modify
-   it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
-   (at your option) any later version.
+  This file is part of aubio.
 
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   GNU General Public License for more details.
+  aubio is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
 
-   You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+  aubio is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with aubio.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 #include "aubio_priv.h"
 #include "fvec.h"
 #include "cvec.h"
-#include "onset/onsetdetection.h"
+#include "spectral/specdesc.h"
 #include "spectral/phasevoc.h"
-#include "onset/peakpick.h"
+#include "spectral/awhitening.h"
+#include "onset/peakpicker.h"
 #include "mathutils.h"
 #include "onset/onset.h"
 
+void aubio_onset_default_parameters (aubio_onset_t *o, char_t * method);
+
 /** structure to store object state */
 struct _aubio_onset_t {
   aubio_pvoc_t * pv;            /**< phase vocoder */
-  aubio_onsetdetection_t * od;  /**< onset detection */ 
-  aubio_pickpeak_t * pp;        /**< peak picker */
+  aubio_specdesc_t * od;        /**< spectral descriptor */
+  aubio_peakpicker_t * pp;      /**< peak picker */
   cvec_t * fftgrain;            /**< phase vocoder output */
-  fvec_t * of;                  /**< onset detection function */
-  smpl_t threshold;             /**< onset peak picking threshold */
+  fvec_t * desc;                /**< spectral description */
   smpl_t silence;               /**< silence threhsold */
   uint_t minioi;                /**< minimum inter onset interval */
-  uint_t wasonset;              /**< number of frames since last onset */
+  uint_t delay;                 /**< constant delay, in samples, removed from detected onset times */
+  uint_t samplerate;            /**< sampling rate of the input signal */
+  uint_t hop_size;              /**< number of samples between two runs */
+
+  uint_t total_frames;          /**< total number of frames processed since the beginning */
+  uint_t last_onset;            /**< last detected onset location, in frames */
+
+  uint_t apply_adaptive_whitening;
+  aubio_spectral_whitening_t *spectral_whitening;
 };
 
 /* execute onset detection function on iput buffer */
-void aubio_onset(aubio_onset_t *o, fvec_t * input, fvec_t * onset)
+void aubio_onset_do (aubio_onset_t *o, const fvec_t * input, fvec_t * onset)
 {
-  uint_t isonset = 0;
-  uint_t wasonset = o->wasonset;
+  smpl_t isonset = 0;
   aubio_pvoc_do (o->pv,input, o->fftgrain);
-  aubio_onsetdetection(o->od,o->fftgrain, o->of);
-  /*if (usedoubled) {
-    aubio_onsetdetection(o2,fftgrain, onset2);
-    onset->data[0][0] *= onset2->data[0][0];
-  }*/
-  isonset = aubio_peakpicker_do(o->pp, o->of);
+  /*
+  if (apply_filtering) {
+  }
+  if (apply_compression) {
+  }
+  */
+  if (o->apply_adaptive_whitening) {
+    aubio_spectral_whitening_do(o->spectral_whitening, o->fftgrain);
+  }
+  aubio_specdesc_do (o->od, o->fftgrain, o->desc);
+  aubio_peakpicker_do(o->pp, o->desc, onset);
+  isonset = onset->data[0];
   if (isonset > 0.) {
     if (aubio_silence_detection(input, o->silence)==1) {
+      //AUBIO_DBG ("silent onset, not marking as onset\n");
       isonset  = 0;
-      wasonset++;
     } else {
-      if (wasonset > o->minioi) {
-        wasonset = 0;
+      uint_t new_onset = o->total_frames + (uint_t)ROUND(isonset * o->hop_size);
+      if (o->last_onset + o->minioi < new_onset) {
+        //AUBIO_DBG ("accepted detection, marking as onset\n");
+        o->last_onset = new_onset;
       } else {
+        //AUBIO_DBG ("doubled onset, not marking as onset\n");
         isonset  = 0;
-        wasonset++;
       }
     }
   } else {
-    wasonset++;
+    // we are at the beginning of the file
+    if (o->total_frames <= o->delay) {
+      // and we don't find silence
+      if (aubio_silence_detection(input, o->silence) == 0) {
+        uint_t new_onset = o->total_frames;
+        if (o->total_frames == 0 || o->last_onset + o->minioi < new_onset) {
+          isonset = o->delay / o->hop_size;
+          o->last_onset = o->total_frames + o->delay;
+        }
+      }
+    }
   }
-  o->wasonset = wasonset;
-  onset->data[0][0] = isonset;
+  onset->data[0] = isonset;
+  o->total_frames += o->hop_size;
   return;
 }
 
-void aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence) {
+uint_t aubio_onset_get_last (const aubio_onset_t *o)
+{
+  return o->last_onset - o->delay;
+}
+
+smpl_t aubio_onset_get_last_s (const aubio_onset_t *o)
+{
+  return aubio_onset_get_last (o) / (smpl_t) (o->samplerate);
+}
+
+smpl_t aubio_onset_get_last_ms (const aubio_onset_t *o)
+{
+  return aubio_onset_get_last_s (o) * 1000.;
+}
+
+uint_t aubio_onset_set_adaptive_whitening (aubio_onset_t *o, uint_t apply_adaptive_whitening)
+{
+  o->apply_adaptive_whitening = apply_adaptive_whitening;
+  return AUBIO_OK;
+}
+
+uint_t aubio_onset_get_adaptive_whitening (aubio_onset_t *o)
+{
+  return o->apply_adaptive_whitening;
+}
+
+uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence) {
   o->silence = silence;
-  return;
+  return AUBIO_OK;
 }
 
-void aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold) {
-  o->threshold = threshold;
-  aubio_peakpicker_set_threshold(o->pp, o->threshold);
-  return;
+smpl_t aubio_onset_get_silence(const aubio_onset_t * o) {
+  return o->silence;
+}
+
+uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold) {
+  aubio_peakpicker_set_threshold(o->pp, threshold);
+  return AUBIO_OK;
 }
 
-void aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi) {
+smpl_t aubio_onset_get_threshold(const aubio_onset_t * o) {
+  return aubio_peakpicker_get_threshold(o->pp);
+}
+
+uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi) {
   o->minioi = minioi;
-  return;
+  return AUBIO_OK;
+}
+
+uint_t aubio_onset_get_minioi(const aubio_onset_t * o) {
+  return o->minioi;
+}
+
+uint_t aubio_onset_set_minioi_s(aubio_onset_t * o, smpl_t minioi) {
+  return aubio_onset_set_minioi (o, (uint_t)ROUND(minioi * o->samplerate));
+}
+
+smpl_t aubio_onset_get_minioi_s(const aubio_onset_t * o) {
+  return aubio_onset_get_minioi (o) / (smpl_t) o->samplerate;
+}
+
+uint_t aubio_onset_set_minioi_ms(aubio_onset_t * o, smpl_t minioi) {
+  return aubio_onset_set_minioi_s (o, minioi / 1000.);
+}
+
+smpl_t aubio_onset_get_minioi_ms(const aubio_onset_t * o) {
+  return aubio_onset_get_minioi_s (o) * 1000.;
+}
+
+uint_t aubio_onset_set_delay(aubio_onset_t * o, uint_t delay) {
+  o->delay = delay;
+  return AUBIO_OK;
+}
+
+uint_t aubio_onset_get_delay(const aubio_onset_t * o) {
+  return o->delay;
+}
+
+uint_t aubio_onset_set_delay_s(aubio_onset_t * o, smpl_t delay) {
+  return aubio_onset_set_delay (o, delay * o->samplerate);
+}
+
+smpl_t aubio_onset_get_delay_s(const aubio_onset_t * o) {
+  return aubio_onset_get_delay (o) / (smpl_t) o->samplerate;
+}
+
+uint_t aubio_onset_set_delay_ms(aubio_onset_t * o, smpl_t delay) {
+  return aubio_onset_set_delay_s (o, delay / 1000.);
+}
+
+smpl_t aubio_onset_get_delay_ms(const aubio_onset_t * o) {
+  return aubio_onset_get_delay_s (o) * 1000.;
+}
+
+smpl_t aubio_onset_get_descriptor(const aubio_onset_t * o) {
+  return o->desc->data[0];
+}
+
+smpl_t aubio_onset_get_thresholded_descriptor(const aubio_onset_t * o) {
+  fvec_t * thresholded = aubio_peakpicker_get_thresholded_input(o->pp);
+  return thresholded->data[0];
 }
 
 /* Allocate memory for an onset detection */
-aubio_onset_t * new_aubio_onset (aubio_onsetdetection_type type_onset, 
-    uint_t buf_size, uint_t hop_size, uint_t channels)
+aubio_onset_t * new_aubio_onset (const char_t * onset_mode,
+    uint_t buf_size, uint_t hop_size, uint_t samplerate)
 {
   aubio_onset_t * o = AUBIO_NEW(aubio_onset_t);
-  /** set some default parameter */
-  o->threshold = 0.3;
-  o->minioi    = 4;
-  o->silence   = -70;
-  o->wasonset  = 0;
-  o->pv = new_aubio_pvoc(buf_size, hop_size, channels);
-  o->pp = new_aubio_peakpicker(o->threshold);
-  o->od = new_aubio_onsetdetection(type_onset,buf_size,channels);
-  o->fftgrain = new_cvec(buf_size,channels);
-  o->of = new_fvec(1, channels);
-  /*if (usedoubled)    {
-    o2 = new_aubio_onsetdetection(type_onset2,buffer_size,channels);
-    onset2 = new_fvec(1 , channels);
-  }*/
+
+  /* check parameters are valid */
+  if ((sint_t)hop_size < 1) {
+    AUBIO_ERR("onset: got hop_size %d, but can not be < 1\n", hop_size);
+    goto beach;
+  } else if ((sint_t)buf_size < 2) {
+    AUBIO_ERR("onset: got buffer_size %d, but can not be < 2\n", buf_size);
+    goto beach;
+  } else if (buf_size < hop_size) {
+    AUBIO_ERR("onset: hop size (%d) is larger than win size (%d)\n", hop_size, buf_size);
+    goto beach;
+  } else if ((sint_t)samplerate < 1) {
+    AUBIO_ERR("onset: samplerate (%d) can not be < 1\n", samplerate);
+    goto beach;
+  }
+
+  /* store creation parameters */
+  o->samplerate = samplerate;
+  o->hop_size = hop_size;
+
+  /* allocate memory */
+  o->pv = new_aubio_pvoc(buf_size, o->hop_size);
+  o->pp = new_aubio_peakpicker();
+  o->od = new_aubio_specdesc(onset_mode,buf_size);
+  if (o->od == NULL) goto beach_specdesc;
+  o->fftgrain = new_cvec(buf_size);
+  o->desc = new_fvec(1);
+
+  o->spectral_whitening = new_aubio_spectral_whitening(buf_size, hop_size, samplerate);
+
+  aubio_onset_default_parameters (o, onset_mode);
+
+  /* initialize internal variables */
+  o->last_onset = 0;
+  o->total_frames = 0;
   return o;
+
+beach_specdesc:
+  del_aubio_peakpicker(o->pp);
+  del_aubio_pvoc(o->pv);
+beach:
+  AUBIO_FREE(o);
+  return NULL;
+}
+
+void aubio_onset_default_parameters (aubio_onset_t * o, char_t * onset_mode)
+{
+  /* set some default parameter */
+  aubio_onset_set_threshold (o, 0.3);
+  aubio_onset_set_delay (o, 4.3 * o->hop_size);
+  aubio_onset_set_minioi_ms (o, 50.);
+  aubio_onset_set_silence (o, -70.);
+  aubio_onset_set_adaptive_whitening (o, 1);
+
+  /* method specific optimisations */
+  if (strcmp (onset_mode, "energy") == 0) {
+  } else if (strcmp (onset_mode, "hfc") == 0 || strcmp (onset_mode, "default") == 0) {
+    aubio_onset_set_adaptive_whitening (o, 0);
+  } else if (strcmp (onset_mode, "complexdomain") == 0
+             || strcmp (onset_mode, "complex") == 0) {
+    aubio_onset_set_delay (o, 4.6 * o->hop_size);
+    aubio_onset_set_threshold (o, 0.15);
+  } else if (strcmp (onset_mode, "phase") == 0) {
+    aubio_onset_set_adaptive_whitening (o, 0);
+  } else if (strcmp (onset_mode, "mkl") == 0) {
+    aubio_onset_set_threshold (o, 0.05);
+  } else if (strcmp (onset_mode, "kl") == 0) {
+    aubio_onset_set_threshold (o, 0.35);
+  } else if (strcmp (onset_mode, "specflux") == 0) {
+    aubio_onset_set_threshold (o, 0.4);
+  } else if (strcmp (onset_mode, "specdiff") == 0) {
+  } else {
+    AUBIO_ERR ("onset: unknown spectral descriptor type %s, "
+               "using default parameters.\n", onset_mode);
+  }
 }
 
 void del_aubio_onset (aubio_onset_t *o)
 {
-  del_aubio_onsetdetection(o->od);
+  del_aubio_spectral_whitening(o->spectral_whitening);
+  del_aubio_specdesc(o->od);
   del_aubio_peakpicker(o->pp);
   del_aubio_pvoc(o->pv);
-  del_fvec(o->of);
+  del_fvec(o->desc);
   del_cvec(o->fftgrain);
   AUBIO_FREE(o);
 }