source: src/tempo/beattracking.h @ 5d1f716

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 5d1f716 was d207300, checked in by Paul Brossier <piem@piem.org>, 15 years ago

src/tempo: switch to mono

  • Property mode set to 100644
File size: 2.6 KB
Line 
1/*
2  Copyright (C) 2003-2009 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 164­169, 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*/
37#ifndef BEATTRACKING_H
38#define BEATTRACKING_H
39
40#ifdef __cplusplus
41extern "C" {
42#endif
43
44/** beat tracking object */
45typedef struct _aubio_beattracking_t aubio_beattracking_t;
46
47/** create beat tracking object
48
49  \param hop_size number of onset detection samples [512]
50
51*/
52aubio_beattracking_t * new_aubio_beattracking(uint_t hop_size);
53
54/** track the beat
55
56  \param bt beat tracking object
57  \param dfframes current input detection function frame, smoothed by
58  adaptive median threshold.
59  \param out stored detected beat locations
60
61*/
62void aubio_beattracking_do (aubio_beattracking_t * bt, fvec_t * dfframes,
63    fvec_t * out);
64
65/** get current tempo in bpm
66
67  \param bt beat tracking object
68
69  Returns the currently observed tempo, in beats per minutes, or 0 if no
70  consistent value is found.
71
72*/
73smpl_t aubio_beattracking_get_bpm(aubio_beattracking_t * bt);
74
75/** get current tempo confidence
76
77  \param bt beat tracking object
78
79  Returns the confidence with which the tempo has been observed, 0 if no
80  consistent value is found.
81
82*/
83smpl_t aubio_beattracking_get_confidence(aubio_beattracking_t * bt);
84
85/** delete beat tracking object
86
87  \param p beat tracking object
88
89*/
90void del_aubio_beattracking(aubio_beattracking_t * p);
91
92#ifdef __cplusplus
93}
94#endif
95
96#endif /* BEATTRACKING_H */
Note: See TracBrowser for help on using the repository browser.