source: src/tempo/tempo.h @ 3f27a98

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

src/tempo/tempo.c: add get_last functions

  • Property mode set to 100644
File size: 3.1 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 object
24
25  This object stores all the memory required for tempo detection algorithm
26  and returns the estimated beat locations.
27
28  \example tempo/test-tempo.c
29
30*/
31
32#ifndef TEMPO_H
33#define TEMPO_H
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39/** tempo detection structure */
40typedef struct _aubio_tempo_t aubio_tempo_t;
41
42/** create tempo detection object
43
44  \param buf_size length of FFT
45  \param hop_size number of frames between two consecutive runs
46  \param samplerate sampling rate of the signal to analyze
47
48  \return newly created ::aubio_tempo_t if successful, `NULL` otherwise
49
50*/
51aubio_tempo_t * new_aubio_tempo (char_t * method,
52    uint_t buf_size, uint_t hop_size, uint_t samplerate);
53
54/** execute tempo detection
55
56  \param o beat tracking object
57  \param input new samples
58  \param tempo output beats
59
60*/
61void aubio_tempo_do (aubio_tempo_t *o, fvec_t * input, fvec_t * tempo);
62
63/** get the time of the latest beat detected, in samples
64
65  \param o tempo detection object as returned by ::new_aubio_tempo
66
67*/
68uint_t aubio_tempo_get_last (aubio_tempo_t *o);
69
70/** get the time of the latest beat detected, in seconds
71
72  \param o tempo detection object as returned by ::new_aubio_tempo
73
74*/
75smpl_t aubio_tempo_get_last_s (aubio_tempo_t *o);
76
77/** get the time of the latest beat detected, in milliseconds
78
79  \param o tempo detection object as returned by ::new_aubio_tempo
80
81*/
82smpl_t aubio_tempo_get_last_ms (aubio_tempo_t *o);
83
84/** set tempo detection silence threshold
85
86  \param o beat tracking object
87  \param threshold new silence threshold, in dB
88
89  \return `0` if successful, non-zero otherwise
90
91*/
92uint_t aubio_tempo_set_silence(aubio_tempo_t * o, smpl_t silence);
93
94/** set tempo detection peak picking threshold
95
96  \param o beat tracking object
97  \param threshold new threshold
98
99  \return `0` if successful, non-zero otherwise
100
101*/
102uint_t aubio_tempo_set_threshold(aubio_tempo_t * o, smpl_t threshold);
103
104/** get current tempo
105
106  \param o beat tracking object
107
108  \return the currently observed tempo, or `0` if no consistent value is found
109
110*/
111smpl_t aubio_tempo_get_bpm(aubio_tempo_t * o);
112
113/** get current tempo confidence
114
115  \param o beat tracking object
116
117  \return confidence with which the tempo has been observed, `0` if no
118  consistent value is found.
119
120*/
121smpl_t aubio_tempo_get_confidence(aubio_tempo_t * o);
122
123/** delete tempo detection object
124
125  \param o beat tracking object
126
127*/
128void del_aubio_tempo(aubio_tempo_t * o);
129
130#ifdef __cplusplus
131}
132#endif
133
134#endif /* TEMPO_H */
Note: See TracBrowser for help on using the repository browser.