src/tempo/beattracking.h

   1 /*
   2   Copyright (C) 2003-2015 Matthew Davies and 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   Beat tracking using a context dependant model
  24
  25   This file implements the causal beat tracking algorithm designed by Matthew
  26   Davies and described in the following articles:
  27
  28   Matthew E. P. Davies and Mark D. Plumbley. Causal tempo tracking of audio.
  29   In Proceedings of the International Symposium on Music Information Retrieval
  30   (ISMIR), pages 164169, Barcelona, Spain, 2004.
  31
  32   Matthew E. P. Davies, Paul Brossier, and Mark D. Plumbley. Beat tracking
  33   towards automatic musical accompaniment. In Proceedings of the Audio
  34   Engeeniring Society 118th Convention, Barcelona, Spain, May 2005.
  35
  36   \example tempo/test-beattracking.c
  37
  38 */
  39 #ifndef _AUBIO_BEATTRACKING_H
  40 #define _AUBIO_BEATTRACKING_H
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 /** beat tracking object */
  47 typedef struct _aubio_beattracking_t aubio_beattracking_t;
  48
  49 /** create beat tracking object
  50
  51   \param winlen length of the onset detection window
  52   \param hop_size number of onset detection samples [512]
  53   \param samplerate samplerate of the input signal
  54
  55 */
  56 aubio_beattracking_t * new_aubio_beattracking(uint_t winlen, uint_t hop_size,
  57     uint_t samplerate);
  58
  59 /** track the beat
  60
  61   \param bt beat tracking object
  62   \param dfframes current input detection function frame, smoothed by
  63   adaptive median threshold.
  64   \param out stored detected beat locations
  65
  66 */
  67 void aubio_beattracking_do (aubio_beattracking_t * bt, fvec_t * dfframes,
  68     fvec_t * out);
  69
  70 /** get current tempo in bpm
  71
  72   \param bt beat tracking object
  73
  74   Returns the currently observed tempo, in beats per minutes, or 0 if no
  75   consistent value is found.
  76
  77 */
  78 smpl_t aubio_beattracking_get_bpm(aubio_beattracking_t * bt);
  79
  80 /** get current tempo confidence
  81
  82   \param bt beat tracking object
  83
  84   Returns the confidence with which the tempo has been observed, 0 if no
  85   consistent value is found.
  86
  87 */
  88 smpl_t aubio_beattracking_get_confidence(aubio_beattracking_t * bt);
  89
  90 /** delete beat tracking object
  91
  92   \param p beat tracking object
  93
  94 */
  95 void del_aubio_beattracking(aubio_beattracking_t * p);
  96
  97 #ifdef __cplusplus
  98 }
  99 #endif
 100
 101 #endif /* _AUBIO_BEATTRACKING_H */