source: src/tempo.h @ fff2bee

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

add some documentation
add some documentation

  • Property mode set to 100644
File size: 1.6 KB
Line 
1/*
2   Copyright (C) 2006 Paul Brossier
3
4   This program is free software; you can redistribute it and/or modify
5   it under the terms of the GNU General Public License as published by
6   the Free Software Foundation; either version 2 of the License, or
7   (at your option) any later version.
8
9   This program is distributed in the hope that it will be useful,
10   but WITHOUT ANY WARRANTY; without even the implied warranty of
11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12   GNU General Public License for more details.
13
14   You should have received a copy of the GNU General Public License
15   along with this program; if not, write to the Free Software
16   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18*/
19
20/** \file
21 
22  Tempo detection driver
23
24  This object stores all the memory required for tempo detection algorithm
25  and returns the estimated beat locations.
26
27*/
28
29#ifndef TEMPO_H
30#define TEMPO_H
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
36/** tempo detection structure */
37typedef struct _aubio_tempo_t aubio_tempo_t;
38
39/** create tempo detection object */
40aubio_tempo_t * new_aubio_tempo (aubio_onsetdetection_type type_onset, 
41    uint_t buf_size, uint_t hop_size, uint_t channels);
42
43/** execute tempo detection */
44void aubio_tempo(aubio_tempo_t *o, fvec_t * input, fvec_t * tempo);
45
46/** set tempo detection silence threshold  */
47void aubio_tempo_set_silence(aubio_tempo_t * o, smpl_t silence);
48
49/** set tempo detection peak picking threshold  */
50void aubio_tempo_set_threshold(aubio_tempo_t * o, smpl_t threshold);
51
52/** delete tempo detection object */
53void del_aubio_tempo(aubio_tempo_t * o);
54
55#ifdef __cplusplus
56}
57#endif
58
59#endif /* TEMPO_H */
Note: See TracBrowser for help on using the repository browser.