src/onset/onset.h

   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 /** \file
  22
  23   Onset detection object
  24
  25   The following routines compute the onset detection function and detect peaks
  26   in these functions. When onsets are found above a given silence threshold,
  27   and after a minimum inter-onset interval, the output vector returned by
  28   aubio_onset_do() is filled with `1`. Otherwise, the output vector remains
  29   `0`.
  30
  31   The peak-picking threshold, the silence threshold, and the minimum
  32   inter-onset interval can be adjusted during the execution of the
  33   aubio_onset_do routine using the corresponding functions.
  34
  35   \example onset/test-onset.c
  36   \example examples/aubioonset.c
  37   \example examples/aubionotes.c
  38
  39 */
  40
  41
  42 #ifndef AUBIO_ONSET_H
  43 #define AUBIO_ONSET_H
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 /** onset detection object */
  50 typedef struct _aubio_onset_t aubio_onset_t;
  51
  52 /** create onset detection object
  53
  54   \param method onset detection type as specified in specdesc.h
  55   \param buf_size buffer size for phase vocoder
  56   \param hop_size hop size for phase vocoder
  57   \param samplerate sampling rate of the input signal
  58
  59   \return newly created ::aubio_onset_t
  60
  61 */
  62 aubio_onset_t * new_aubio_onset (const char_t * method,
  63     uint_t buf_size, uint_t hop_size, uint_t samplerate);
  64
  65 /** execute onset detection
  66
  67   \param o onset detection object as returned by new_aubio_onset()
  68   \param input new audio vector of length hop_size
  69   \param onset output vector of length 1, containing 0 if no onset was found,
  70   and a value equal or greater than 1 otherwise
  71
  72   When no onset was detected, the first element of the output vector `onset`
  73   is set to 0.
  74
  75   When an onset is found, the first element of the output vector `onset` is set
  76   to `offset = 1 + a` where `a` is a number in the range`[0, 1]`.
  77
  78   The final onset detection time, in samples, can be obtained with
  79   aubio_onset_get_last(). It can also be derived from `offset` as
  80   follows:
  81
  82   \code
  83     t = total_frames + offset * hop_size - delay
  84   \endcode
  85
  86   where `total_frames` is the total number of frames processed so far, and
  87   `delay` is the current delay of the onset object, as returned by
  88   aubio_onset_get_delay().
  89
  90 */
  91 void aubio_onset_do (aubio_onset_t *o, const fvec_t * input, fvec_t * onset);
  92
  93 /** get the time of the latest onset detected, in samples
  94
  95   \param o onset detection object as returned by new_aubio_onset()
  96
  97   \return onset detection timestamps (in samples)
  98
  99 */
 100 uint_t aubio_onset_get_last (const aubio_onset_t *o);
 101
 102 /** get the time of the latest onset detected, in seconds
 103
 104   \param o onset detection object as returned by new_aubio_onset()
 105
 106   \return onset detection timestamps (in seconds)
 107
 108 */
 109 smpl_t aubio_onset_get_last_s (const aubio_onset_t *o);
 110
 111 /** get the time of the latest onset detected, in milliseconds
 112
 113   \param o onset detection object as returned by new_aubio_onset()
 114
 115   \return onset detection timestamps (in milliseconds)
 116
 117 */
 118 smpl_t aubio_onset_get_last_ms (const aubio_onset_t *o);
 119
 120 /** set onset detection adaptive whitening
 121
 122   \param o onset detection object as returned by new_aubio_onset()
 123   \param enable 1 to enable, 0 to disable
 124
 125   \return 0 if successful, 1 otherwise
 126
 127 */
 128 uint_t aubio_onset_set_awhitening(aubio_onset_t * o, uint_t enable);
 129
 130 /** get onset detection adaptive whitening
 131
 132   \param o onset detection object as returned by new_aubio_onset()
 133
 134   \return 1 if enabled, 0 otherwise
 135
 136 */
 137 smpl_t aubio_onset_get_awhitening(aubio_onset_t * o);
 138
 139 /** set or disable log compression
 140
 141   \param o onset detection object as returned by new_aubio_onset()
 142   \param lambda logarithmic compression factor
 143
 144   \return 0 if successful, 1 otherwise
 145
 146  */
 147 uint_t aubio_onset_set_logmag_compression(aubio_onset_t *o, smpl_t lambda);
 148
 149 /** get onset detection log compression
 150  */
 151 smpl_t aubio_onset_get_logmag_compression(aubio_onset_t *o);
 152
 153 /** set onset detection silence threshold
 154
 155   \param o onset detection object as returned by new_aubio_onset()
 156   \param silence new silence detection threshold
 157
 158 */
 159 uint_t aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence);
 160
 161 /** get onset detection silence threshold
 162
 163   \param o onset detection object as returned by new_aubio_onset()
 164
 165   \return current silence threshold
 166
 167 */
 168 smpl_t aubio_onset_get_silence(const aubio_onset_t * o);
 169
 170 /** get onset detection function
 171
 172   \param o onset detection object as returned by new_aubio_onset()
 173   \return the current value of the descriptor
 174
 175 */
 176 smpl_t aubio_onset_get_descriptor (const aubio_onset_t *o);
 177
 178 /** get thresholded onset detection function
 179
 180   \param o onset detection object as returned by new_aubio_onset()
 181   \return the value of the thresholded descriptor
 182
 183 */
 184 smpl_t aubio_onset_get_thresholded_descriptor (const aubio_onset_t *o);
 185
 186 /** set onset detection peak picking threshold
 187
 188   \param o onset detection object as returned by new_aubio_onset()
 189   \param threshold new peak-picking threshold
 190
 191 */
 192 uint_t aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold);
 193
 194 /** set minimum inter onset interval in samples
 195
 196   \param o onset detection object as returned by new_aubio_onset()
 197   \param minioi minimum interval between two consecutive onsets (in
 198   samples)
 199
 200 */
 201 uint_t aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi);
 202
 203 /** set minimum inter onset interval in seconds
 204
 205   \param o onset detection object as returned by new_aubio_onset()
 206   \param minioi minimum interval between two consecutive onsets (in
 207   seconds)
 208
 209 */
 210 uint_t aubio_onset_set_minioi_s(aubio_onset_t * o, smpl_t minioi);
 211
 212 /** set minimum inter onset interval in milliseconds
 213
 214   \param o onset detection object as returned by new_aubio_onset()
 215   \param minioi minimum interval between two consecutive onsets (in
 216   milliseconds)
 217
 218 */
 219 uint_t aubio_onset_set_minioi_ms(aubio_onset_t * o, smpl_t minioi);
 220
 221 /** set delay in samples
 222
 223   \param o onset detection object as returned by new_aubio_onset()
 224   \param delay constant system delay to take back from detection time
 225   (in samples)
 226
 227 */
 228 uint_t aubio_onset_set_delay(aubio_onset_t * o, uint_t delay);
 229
 230 /** set delay in seconds
 231
 232   \param o onset detection object as returned by new_aubio_onset()
 233   \param delay constant system delay to take back from detection time
 234   (in seconds)
 235
 236 */
 237 uint_t aubio_onset_set_delay_s(aubio_onset_t * o, smpl_t delay);
 238
 239 /** set delay in milliseconds
 240
 241   \param o onset detection object as returned by new_aubio_onset()
 242   \param delay constant system delay to take back from detection time
 243   (in milliseconds)
 244
 245 */
 246 uint_t aubio_onset_set_delay_ms(aubio_onset_t * o, smpl_t delay);
 247
 248 /** get minimum inter onset interval in samples
 249
 250   \param o onset detection object as returned by new_aubio_onset()
 251   \return minimum interval between two consecutive onsets (in
 252   samples)
 253
 254 */
 255 uint_t aubio_onset_get_minioi(const aubio_onset_t * o);
 256
 257 /** get minimum inter onset interval in seconds
 258
 259   \param o onset detection object as returned by new_aubio_onset()
 260   \return minimum interval between two consecutive onsets (in
 261   seconds)
 262
 263 */
 264 smpl_t aubio_onset_get_minioi_s(const aubio_onset_t * o);
 265
 266 /** get minimum inter onset interval in milliseconds
 267
 268   \param o onset detection object as returned by new_aubio_onset()
 269   \return minimum interval between two consecutive onsets (in
 270   milliseconds)
 271
 272 */
 273 smpl_t aubio_onset_get_minioi_ms(const aubio_onset_t * o);
 274
 275 /** get delay in samples
 276
 277   \param o onset detection object as returned by new_aubio_onset()
 278   \return constant system delay to take back from detection time
 279   (in samples)
 280
 281 */
 282 uint_t aubio_onset_get_delay(const aubio_onset_t * o);
 283
 284 /** get delay in seconds
 285
 286   \param o onset detection object as returned by new_aubio_onset()
 287   \return constant system delay to take back from detection time
 288   (in seconds)
 289
 290 */
 291 smpl_t aubio_onset_get_delay_s(const aubio_onset_t * o);
 292
 293 /** get delay in milliseconds
 294
 295   \param o onset detection object as returned by new_aubio_onset()
 296   \return constant system delay to take back from detection time
 297   (in milliseconds)
 298
 299 */
 300 smpl_t aubio_onset_get_delay_ms(const aubio_onset_t * o);
 301
 302 /** get onset peak picking threshold
 303
 304   \param o onset detection object as returned by new_aubio_onset()
 305   \return current onset detection threshold
 306
 307 */
 308 smpl_t aubio_onset_get_threshold(const aubio_onset_t * o);
 309
 310 /** set default parameters
 311
 312   \param o onset detection object as returned by new_aubio_onset()
 313   \param onset_mode detection mode to adjust
 314
 315   This function is called at the end of new_aubio_onset().
 316
 317  */
 318 uint_t aubio_onset_set_default_parameters (aubio_onset_t * o, const char_t * onset_mode);
 319
 320 /** reset onset detection
 321
 322   \param o onset detection object as returned by new_aubio_onset()
 323
 324   Reset current time and last onset to 0.
 325
 326   This function is called at the end of new_aubio_onset().
 327
 328  */
 329 void aubio_onset_reset(aubio_onset_t * o);
 330
 331 /** delete onset detection object
 332
 333   \param o onset detection object to delete
 334
 335 */
 336 void del_aubio_onset(aubio_onset_t * o);
 337
 338 #ifdef __cplusplus
 339 }
 340 #endif
 341
 342 #endif /* AUBIO_ONSET_H */