Changeset 7efeffd for src/tempo


Ignore:
Timestamp:
Mar 22, 2013, 6:55:12 PM (7 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
100add6
Parents:
bea5389
Message:

src/tempo/tempo.h: add some documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/tempo/tempo.h

    rbea5389 r7efeffd  
    1919*/
    2020
    21 /** \file 
    22  
     21/** \file
     22
    2323  Tempo detection object
    2424
     
    4040typedef struct _aubio_tempo_t aubio_tempo_t;
    4141
    42 /** create tempo detection object */
    43 aubio_tempo_t * new_aubio_tempo (char_t * method,
     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,
    4452    uint_t buf_size, uint_t hop_size, uint_t samplerate);
    4553
    46 /** execute tempo detection */
     54/** execute tempo detection
     55
     56  \param o beat tracking object
     57  \param input new samples
     58  \param tempo output beats
     59
     60*/
    4761void aubio_tempo_do (aubio_tempo_t *o, fvec_t * input, fvec_t * tempo);
    4862
    49 /** set tempo detection silence threshold  */
     63/** set tempo detection silence threshold
     64
     65  \param o beat tracking object
     66  \param threshold new silence threshold, in dB
     67
     68  \return `0` if successful, non-zero otherwise
     69
     70*/
    5071uint_t aubio_tempo_set_silence(aubio_tempo_t * o, smpl_t silence);
    5172
    52 /** set tempo detection peak picking threshold  */
     73/** set tempo detection peak picking threshold
     74
     75  \param o beat tracking object
     76  \param threshold new threshold
     77
     78  \return `0` if successful, non-zero otherwise
     79
     80*/
    5381uint_t aubio_tempo_set_threshold(aubio_tempo_t * o, smpl_t threshold);
    5482
    5583/** get current tempo
    5684
    57   \param bt beat tracking object
     85  \param o beat tracking object
    5886
    59   Returns the currently observed tempo, or 0 if no consistent value is found
     87  \return the currently observed tempo, or `0` if no consistent value is found
    6088
    6189*/
    62 smpl_t aubio_tempo_get_bpm(aubio_tempo_t * bt);
     90smpl_t aubio_tempo_get_bpm(aubio_tempo_t * o);
    6391
    6492/** get current tempo confidence
    6593
    66   \param bt beat tracking object
     94  \param o beat tracking object
    6795
    68   Returns the confidence with which the tempo has been observed, 0 if no
     96  \return confidence with which the tempo has been observed, `0` if no
    6997  consistent value is found.
    7098
    7199*/
    72 smpl_t aubio_tempo_get_confidence(aubio_tempo_t * bt);
     100smpl_t aubio_tempo_get_confidence(aubio_tempo_t * o);
    73101
    74 /** delete tempo detection object */
     102/** delete tempo detection object
     103
     104  \param o beat tracking object
     105
     106*/
    75107void del_aubio_tempo(aubio_tempo_t * o);
    76108
Note: See TracChangeset for help on using the changeset viewer.