source: src/tempo/beattracking.h @ 6f42c16

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchpitchshiftsamplertimestretchyinfft+
Last change on this file since 6f42c16 was 6f42c16, checked in by Paul Brossier <piem@piem.org>, 3 years ago

src/: change c header identifiers (see #35)

  • Property mode set to 100644
File size: 3.3 KB
Line 
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 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  \example tempo/test-beattracking.c
37
38*/
39#ifndef AUBIO_BEATTRACKING_H
40#define AUBIO_BEATTRACKING_H
41
42#ifdef __cplusplus
43extern "C" {
44#endif
45
46/** beat tracking object */
47typedef 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*/
56aubio_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*/
67void aubio_beattracking_do (aubio_beattracking_t * bt, const fvec_t * dfframes,
68    fvec_t * out);
69
70/** get current beat period in samples
71
72  \param bt beat tracking object
73
74  Returns the currently observed period, in samples, or 0 if no consistent
75  value is found.
76
77*/
78smpl_t aubio_beattracking_get_period (const aubio_beattracking_t * bt);
79
80/** get current beat period in seconds
81
82  \param bt beat tracking object
83
84  Returns the currently observed period, in seconds, or 0 if no consistent
85  value is found.
86
87*/
88smpl_t aubio_beattracking_get_period_s (const aubio_beattracking_t * bt);
89
90/** get current tempo in bpm
91
92  \param bt beat tracking object
93
94  Returns the currently observed tempo, in beats per minutes, or 0 if no
95  consistent value is found.
96
97*/
98smpl_t aubio_beattracking_get_bpm(const aubio_beattracking_t * bt);
99
100/** get current tempo confidence
101
102  \param bt beat tracking object
103
104  Returns the confidence with which the tempo has been observed, 0 if no
105  consistent value is found.
106
107*/
108smpl_t aubio_beattracking_get_confidence(const aubio_beattracking_t * bt);
109
110/** delete beat tracking object
111
112  \param p beat tracking object
113
114*/
115void del_aubio_beattracking(aubio_beattracking_t * p);
116
117#ifdef __cplusplus
118}
119#endif
120
121#endif /* AUBIO_BEATTRACKING_H */
Note: See TracBrowser for help on using the repository browser.