aubio  0.4.0
 All Data Structures Files Functions Variables Typedefs Macros
Typedefs | Functions
tempo.h File Reference

Tempo detection object. More...

Go to the source code of this file.

Typedefs

typedef struct _aubio_tempo_t aubio_tempo_t
 tempo detection structure
 

Functions

aubio_tempo_tnew_aubio_tempo (char_t *method, uint_t buf_size, uint_t hop_size, uint_t samplerate)
 create tempo detection object More...
 
void aubio_tempo_do (aubio_tempo_t *o, fvec_t *input, fvec_t *tempo)
 execute tempo detection More...
 
uint_t aubio_tempo_get_last (aubio_tempo_t *o)
 get the time of the latest beat detected, in samples More...
 
smpl_t aubio_tempo_get_last_s (aubio_tempo_t *o)
 get the time of the latest beat detected, in seconds More...
 
smpl_t aubio_tempo_get_last_ms (aubio_tempo_t *o)
 get the time of the latest beat detected, in milliseconds More...
 
uint_t aubio_tempo_set_silence (aubio_tempo_t *o, smpl_t silence)
 set tempo detection silence threshold More...
 
uint_t aubio_tempo_set_threshold (aubio_tempo_t *o, smpl_t threshold)
 set tempo detection peak picking threshold More...
 
smpl_t aubio_tempo_get_bpm (aubio_tempo_t *o)
 get current tempo More...
 
smpl_t aubio_tempo_get_confidence (aubio_tempo_t *o)
 get current tempo confidence More...
 
void del_aubio_tempo (aubio_tempo_t *o)
 delete tempo detection object More...
 

Detailed Description

Tempo detection object.

This object stores all the memory required for tempo detection algorithm and returns the estimated beat locations.

Definition in file tempo.h.

Function Documentation

void aubio_tempo_do ( aubio_tempo_t o,
fvec_t input,
fvec_t tempo 
)

execute tempo detection

Parameters
obeat tracking object
inputnew samples
tempooutput beats
Examples:
examples/aubiotrack.c, and tempo/test-tempo.c.
smpl_t aubio_tempo_get_bpm ( aubio_tempo_t o)

get current tempo

Parameters
obeat tracking object
Returns
the currently observed tempo, or 0 if no consistent value is found
Examples:
tempo/test-tempo.c.
smpl_t aubio_tempo_get_confidence ( aubio_tempo_t o)

get current tempo confidence

Parameters
obeat tracking object
Returns
confidence with which the tempo has been observed, 0 if no consistent value is found.
Examples:
tempo/test-tempo.c.
uint_t aubio_tempo_get_last ( aubio_tempo_t o)

get the time of the latest beat detected, in samples

Parameters
otempo detection object as returned by new_aubio_tempo
Examples:
tempo/test-tempo.c.
smpl_t aubio_tempo_get_last_ms ( aubio_tempo_t o)

get the time of the latest beat detected, in milliseconds

Parameters
otempo detection object as returned by new_aubio_tempo
Examples:
tempo/test-tempo.c.
smpl_t aubio_tempo_get_last_s ( aubio_tempo_t o)

get the time of the latest beat detected, in seconds

Parameters
otempo detection object as returned by new_aubio_tempo
Examples:
examples/aubiotrack.c, and tempo/test-tempo.c.
uint_t aubio_tempo_set_silence ( aubio_tempo_t o,
smpl_t  silence 
)

set tempo detection silence threshold

Parameters
obeat tracking object
silencenew silence threshold, in dB
Returns
0 if successful, non-zero otherwise
uint_t aubio_tempo_set_threshold ( aubio_tempo_t o,
smpl_t  threshold 
)

set tempo detection peak picking threshold

Parameters
obeat tracking object
thresholdnew threshold
Returns
0 if successful, non-zero otherwise
Examples:
examples/aubiotrack.c.
void del_aubio_tempo ( aubio_tempo_t o)

delete tempo detection object

Parameters
obeat tracking object
Examples:
examples/aubiotrack.c, and tempo/test-tempo.c.
aubio_tempo_t* new_aubio_tempo ( char_t method,
uint_t  buf_size,
uint_t  hop_size,
uint_t  samplerate 
)

create tempo detection object

Parameters
methodbeat tracking method, unused for now (use "default")
buf_sizelength of FFT
hop_sizenumber of frames between two consecutive runs
sampleratesampling rate of the signal to analyze
Returns
newly created aubio_tempo_t if successful, NULL otherwise
Examples:
examples/aubiotrack.c, and tempo/test-tempo.c.