2 Copyright (C) 2003-2015 Matthew Davies and Paul Brossier <piem@aubio.org>
4 This file is part of aubio.
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.
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.
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/>.
23 Beat tracking using a context dependant model
25 This file implements the causal beat tracking algorithm designed by Matthew
26 Davies and described in the following articles:
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.
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.
36 \example tempo/test-beattracking.c
39 #ifndef _AUBIO_BEATTRACKING_H
40 #define _AUBIO_BEATTRACKING_H
46 /** beat tracking object */
47 typedef struct _aubio_beattracking_t aubio_beattracking_t;
49 /** create beat tracking object
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
56 aubio_beattracking_t * new_aubio_beattracking(uint_t winlen, uint_t hop_size,
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
67 void aubio_beattracking_do (aubio_beattracking_t * bt, const fvec_t * dfframes,
70 /** get current beat period in samples
72 \param bt beat tracking object
74 Returns the currently observed period, in samples, or 0 if no consistent
78 smpl_t aubio_beattracking_get_period (const aubio_beattracking_t * bt);
80 /** get current beat period in seconds
82 \param bt beat tracking object
84 Returns the currently observed period, in seconds, or 0 if no consistent
88 smpl_t aubio_beattracking_get_period_s (const aubio_beattracking_t * bt);
90 /** get current tempo in bpm
92 \param bt beat tracking object
94 Returns the currently observed tempo, in beats per minutes, or 0 if no
95 consistent value is found.
98 smpl_t aubio_beattracking_get_bpm(const aubio_beattracking_t * bt);
100 /** get current tempo confidence
102 \param bt beat tracking object
104 Returns the confidence with which the tempo has been observed, 0 if no
105 consistent value is found.
108 smpl_t aubio_beattracking_get_confidence(const aubio_beattracking_t * bt);
110 /** delete beat tracking object
112 \param p beat tracking object
115 void del_aubio_beattracking(aubio_beattracking_t * p);
121 #endif /* _AUBIO_BEATTRACKING_H */