src/tempo/beattracking.h

   1 /*
   2   Copyright (C) 2003 Matthew Davies and Paul Brossier
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8
   9   This program is distributed in the hope that it will be useful,
  10   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12   GNU General Public License for more details.
  13
  14   You should have received a copy of the GNU General Public License
  15   along with this program; if not, write to the Free Software
  16   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** \file
  21
  22   Beat tracking using a context dependant model
  23
  24   This file implement the causal beat tracking algorithm designed by Matthew
  25   Davies and described in the following articles:
  26
  27   Matthew E. P. Davies and Mark D. Plumbley. Causal tempo tracking of audio.
  28   In Proceedings of the International Symposium on Music Information Retrieval
  29   (ISMIR), pages 164169, Barcelona, Spain, 2004.
  30
  31   Matthew E. P. Davies, Paul Brossier, and Mark D. Plumbley. Beat tracking
  32   towards automatic musical accompaniment. In Proceedings of the Audio
  33   Engeeniring Society 118th Convention, Barcelona, Spain, May 2005.
  34
  35 */
  36 #ifndef BEATTRACKING_H
  37 #define BEATTRACKING_H
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /** beat tracking object */
  44 typedef struct _aubio_beattracking_t aubio_beattracking_t;
  45
  46 /** create beat tracking object
  47
  48   \param winlen: frame size [512]
  49   \param channels number (not functionnal) [1]
  50
  51 */
  52 aubio_beattracking_t * new_aubio_beattracking(uint_t winlen, uint_t channels);
  53 /** track the beat
  54
  55   \param bt beat tracking object
  56   \param dfframes current input detection function frame, smoothed by
  57   adaptive median threshold.
  58   \param out stored detected beat locations
  59
  60 */
  61 void aubio_beattracking_do(aubio_beattracking_t * bt, fvec_t * dfframes, fvec_t * out);
  62 /** get current tempo in bpm
  63
  64   \param bt beat tracking object
  65
  66   Returns the currently observed tempo, in beats per minutes, or 0 if no
  67   consistent value is found.
  68
  69 */
  70 smpl_t aubio_beattracking_get_bpm(aubio_beattracking_t * bt);
  71 /** get current tempo confidence
  72
  73   \param bt beat tracking object
  74
  75   Returns the confidence with which the tempo has been observed, 0 if no
  76   consistent value is found.
  77
  78 */
  79 smpl_t aubio_beattracking_get_confidence(aubio_beattracking_t * bt);
  80 /** delete beat tracking object
  81
  82   \param p beat tracking object
  83
  84 */
  85 void del_aubio_beattracking(aubio_beattracking_t * p);
  86
  87 #ifdef __cplusplus
  88 }
  89 #endif
  90
  91 #endif /* BEATTRACKING_H */