source: src/tempo/tempo.h @ e6a78ea

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

src: update all headers to GPLv3

  • Property mode set to 100644
File size: 2.0 KB
Line 
1/*
2  Copyright (C) 2006-2009 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  Tempo detection driver
24
25  This object stores all the memory required for tempo detection algorithm
26  and returns the estimated beat locations.
27
28*/
29
30#ifndef TEMPO_H
31#define TEMPO_H
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37/** tempo detection structure */
38typedef struct _aubio_tempo_t aubio_tempo_t;
39
40/** create tempo detection object */
41aubio_tempo_t * new_aubio_tempo (char_t * mode, 
42    uint_t buf_size, uint_t hop_size, uint_t channels, uint_t samplerate);
43
44/** execute tempo detection */
45void aubio_tempo_do (aubio_tempo_t *o, fvec_t * input, fvec_t * tempo);
46
47/** set tempo detection silence threshold  */
48uint_t aubio_tempo_set_silence(aubio_tempo_t * o, smpl_t silence);
49
50/** set tempo detection peak picking threshold  */
51uint_t aubio_tempo_set_threshold(aubio_tempo_t * o, smpl_t threshold);
52
53/** get current tempo
54
55  \param bt beat tracking object
56
57  Returns the currently observed tempo, or 0 if no consistent value is found
58
59*/
60smpl_t aubio_tempo_get_bpm(aubio_tempo_t * bt);
61
62/** get current tempo confidence
63
64  \param bt beat tracking object
65
66  Returns the confidence with which the tempo has been observed, 0 if no
67  consistent value is found.
68
69*/
70smpl_t aubio_tempo_get_confidence(aubio_tempo_t * bt);
71
72/** delete tempo detection object */
73void del_aubio_tempo(aubio_tempo_t * o);
74
75#ifdef __cplusplus
76}
77#endif
78
79#endif /* TEMPO_H */
Note: See TracBrowser for help on using the repository browser.