Changeset 895ad8c for src


Ignore:
Timestamp:
Jul 23, 2006, 11:00:14 AM (18 years ago)
Author:
Paul Brossier <piem@altern.org>
Branches:
feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+
Children:
989bf7f
Parents:
b740b96
Message:

complete documentation for onset routines
complete documentation for onset routines

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/onset.h

    rb740b96 r895ad8c  
    1818*/
    1919
     20/** \file
     21 
     22  Onset detection driver
     23
     24  The following routines compute the onset detection function and detect peaks
     25  in these functions. When onsets are found above a given silence threshold,
     26  and after a minimum inter-onset interval, the output vector returned by
     27  aubio_onset is filled with 1. Otherwise, the output vector remains 0.
     28
     29  The peak-picking threshold, the silence threshold, and the minimum
     30  inter-onset interval can be adjusted during the execution of the aubio_onset
     31  routine using the corresponding functions.
     32
     33*/
     34 
     35
    2036#ifndef ONSET_H
    2137#define ONSET_H
     
    2541#endif
    2642
     43/** onset detection object */
    2744typedef struct _aubio_onset_t aubio_onset_t;
    2845
    29 /** create onset detection object */
     46/** create onset detection object
     47 
     48  \param type_onset onset detection type as specified in onsetdetection.h
     49  \param buf_size buffer size for phase vocoder
     50  \param hop_size hop size for phase vocoder
     51  \param channels number of channels
     52
     53*/
    3054aubio_onset_t * new_aubio_onset (aubio_onsetdetection_type type_onset,
    3155    uint_t buf_size, uint_t hop_size, uint_t channels);
    3256
    33 /** execute onset detection */
     57/** execute onset detection
     58
     59  \param o onset detection object as returned by new_aubio_onset
     60  \param input new audio vector of length hop_size
     61  \param onset output vector, 1 if onset is found, 0 otherwise
     62
     63*/
    3464void aubio_onset(aubio_onset_t *o, fvec_t * input, fvec_t * onset);
    3565
    36 /** set onset detection silence threshold  */
     66/** set onset detection silence threshold
     67
     68  \param o onset detection object as returned by new_aubio_onset
     69  \param silence new silence detection threshold
     70
     71*/
    3772void aubio_onset_set_silence(aubio_onset_t * o, smpl_t silence);
    3873
    39 /** set onset detection peak picking threshold  */
     74/** set onset detection peak picking threshold
     75
     76  \param o onset detection object as returned by new_aubio_onset
     77  \param threshold new peak-picking threshold
     78
     79*/
    4080void aubio_onset_set_threshold(aubio_onset_t * o, smpl_t threshold);
    4181
    42 /** set onset detection peak picking threshold  */
     82/** set minimum inter onset interval
     83
     84  \param o onset detection object as returned by new_aubio_onset
     85  \param minioi minimum number of frames between onsets (in multiple of
     86  hop_size/samplerare)
     87
     88*/
    4389void aubio_onset_set_minioi(aubio_onset_t * o, uint_t minioi);
    4490
    45 /** delete onset detection object */
     91/** delete onset detection object
     92
     93  \param o onset detection object to delete
     94
     95*/
    4696void del_aubio_onset(aubio_onset_t * o);
    4797
Note: See TracChangeset for help on using the changeset viewer.