Changeset 479adba


Ignore:
Timestamp:
Dec 7, 2013, 6:30:22 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:
ce1d788
Parents:
2b6139e7
Message:

src/onset/onset.h: improve documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/onset/onset.h

    r2b6139e7 r479adba  
    2626  in these functions. When onsets are found above a given silence threshold,
    2727  and after a minimum inter-onset interval, the output vector returned by
    28   ::aubio_onset_do is filled with `1`. Otherwise, the output vector remains
     28  aubio_onset_do() is filled with `1`. Otherwise, the output vector remains
    2929  `0`.
    3030
     
    5555  \param samplerate sampling rate of the input signal
    5656
     57  \return newly created ::aubio_onset_t
     58
    5759*/
    5860aubio_onset_t * new_aubio_onset (char_t * method,
     
    6163/** execute onset detection
    6264
    63   \param o onset detection object as returned by ::new_aubio_onset
     65  \param o onset detection object as returned by new_aubio_onset()
    6466  \param input new audio vector of length hop_size
    6567  \param onset output vector of length 1, containing 0 if no onset was found,
     
    7375
    7476  The final onset detection time, in samples, can be obtained with
    75   ::aubio_onset_get_last_onset. It can also be derived from `offset` as
     77  aubio_onset_get_last(). It can also be derived from `offset` as
    7678  follows:
    7779
     
    8284  where `total_frames` is the total number of frames processed so far, and
    8385  `delay` is the current delay of the onset object, as returned by
    84   ::aubio_onset_get_delay.
     86  aubio_onset_get_delay().
    8587
    8688*/
     
    8991/** get the time of the latest onset detected, in samples
    9092
    91   \param o onset detection object as returned by ::new_aubio_onset
     93  \param o onset detection object as returned by new_aubio_onset()
     94
     95  \return onset detection timestamps (in samples)
    9296
    9397*/
     
    96100/** get the time of the latest onset detected, in seconds
    97101
    98   \param o onset detection object as returned by ::new_aubio_onset
     102  \param o onset detection object as returned by new_aubio_onset()
     103
     104  \return onset detection timestamps (in seconds)
    99105
    100106*/
     
    103109/** get the time of the latest onset detected, in milliseconds
    104110
    105   \param o onset detection object as returned by ::new_aubio_onset
     111  \param o onset detection object as returned by new_aubio_onset()
     112
     113  \return onset detection timestamps (in milliseconds)
    106114
    107115*/
     
    110118/** set onset detection silence threshold
    111119
    112   \param o onset detection object as returned by ::new_aubio_onset
     120  \param o onset detection object as returned by new_aubio_onset()
    113121  \param silence new silence detection threshold
    114122
     
    118126/** get onset detection function
    119127
    120   \param o onset detection object as returned by ::new_aubio_onset
     128  \param o onset detection object as returned by new_aubio_onset()
    121129  \return the current value of the descriptor
    122130
     
    126134/** get thresholded onset detection function
    127135
    128   \param o onset detection object as returned by ::new_aubio_onset
     136  \param o onset detection object as returned by new_aubio_onset()
    129137  \return the value of the thresholded descriptor
    130138
     
    134142/** set onset detection peak picking threshold
    135143
    136   \param o onset detection object as returned by ::new_aubio_onset
     144  \param o onset detection object as returned by new_aubio_onset()
    137145  \param threshold new peak-picking threshold
    138146
     
    142150/** set minimum inter onset interval in samples
    143151
    144   \param o onset detection object as returned by ::new_aubio_onset
     152  \param o onset detection object as returned by new_aubio_onset()
    145153  \param minioi minimum interval between two consecutive onsets (in
    146154  samples)
     
    151159/** set minimum inter onset interval in seconds
    152160
    153   \param o onset detection object as returned by ::new_aubio_onset
     161  \param o onset detection object as returned by new_aubio_onset()
    154162  \param minioi minimum interval between two consecutive onsets (in
    155163  seconds)
     
    160168/** set minimum inter onset interval in milliseconds
    161169
    162   \param o onset detection object as returned by ::new_aubio_onset
     170  \param o onset detection object as returned by new_aubio_onset()
    163171  \param minioi minimum interval between two consecutive onsets (in
    164172  milliseconds)
     
    169177/** set minimum inter onset interval in samples
    170178
    171   \param o onset detection object as returned by ::new_aubio_onset
     179  \param o onset detection object as returned by new_aubio_onset()
    172180  \param delay constant system delay to take back from detection time
    173181  (in samples)
     
    178186/** set minimum inter onset interval in seconds
    179187
    180   \param o onset detection object as returned by ::new_aubio_onset
     188  \param o onset detection object as returned by new_aubio_onset()
    181189  \param delay constant system delay to take back from detection time
    182190  (in seconds)
     
    187195/** set minimum inter onset interval in milliseconds
    188196
    189   \param o onset detection object as returned by ::new_aubio_onset
     197  \param o onset detection object as returned by new_aubio_onset()
    190198  \param delay constant system delay to take back from detection time
    191199  (in milliseconds)
     
    196204/** get minimum inter onset interval in samples
    197205
    198   \param o onset detection object as returned by ::new_aubio_onset
     206  \param o onset detection object as returned by new_aubio_onset()
    199207  \return minimum interval between two consecutive onsets (in
    200208  samples)
     
    205213/** get minimum inter onset interval in seconds
    206214
    207   \param o onset detection object as returned by ::new_aubio_onset
     215  \param o onset detection object as returned by new_aubio_onset()
    208216  \return minimum interval between two consecutive onsets (in
    209217  seconds)
     
    214222/** get minimum inter onset interval in milliseconds
    215223
    216   \param o onset detection object as returned by ::new_aubio_onset
     224  \param o onset detection object as returned by new_aubio_onset()
    217225  \return minimum interval between two consecutive onsets (in
    218226  milliseconds)
     
    223231/** get minimum inter onset interval in samples
    224232
    225   \param o onset detection object as returned by ::new_aubio_onset
     233  \param o onset detection object as returned by new_aubio_onset()
    226234  \return constant system delay to take back from detection time
    227235  (in samples)
     
    232240/** get minimum inter onset interval in seconds
    233241
    234   \param o onset detection object as returned by ::new_aubio_onset
     242  \param o onset detection object as returned by new_aubio_onset()
    235243  \return constant system delay to take back from detection time
    236244  (in seconds)
     
    241249/** get minimum inter onset interval in milliseconds
    242250
    243   \param o onset detection object as returned by ::new_aubio_onset
     251  \param o onset detection object as returned by new_aubio_onset()
    244252  \return constant system delay to take back from detection time
    245253  (in milliseconds)
Note: See TracChangeset for help on using the changeset viewer.