Changeset 69b11d8


Ignore:
Timestamp:
Mar 3, 2013, 4:44:18 AM (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:
b173ca1
Parents:
f72364d
Message:

src/*/*.h: add link to examples, remove trailing spaces, improve documentation

Location:
src
Files:
11 edited

Legend:

Unmodified
Added
Removed
  • src/io/sink.h

    rf72364d r69b11d8  
    3030  Media sink
    3131
     32  \example io/test-sink.c
     33
    3234*/
    3335
  • src/onset/onset.h

    rf72364d r69b11d8  
    2121/** \file
    2222 
    23   Onset detection driver
     23  Onset detection object
    2424
    2525  The following routines compute the onset detection function and detect peaks
    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 0.
     28  ::aubio_onset_do is filled with `1`. Otherwise, the output vector remains
     29  `0`.
    2930
    3031  The peak-picking threshold, the silence threshold, and the minimum
    3132  inter-onset interval can be adjusted during the execution of the
    3233  aubio_onset_do routine using the corresponding functions.
     34
     35  \example onset/test-onset.c
    3336
    3437*/
  • src/onset/peakpicker.h

    rf72364d r69b11d8  
    2222 
    2323  Peak picking utilities function
     24
     25  \example onset/test-peakpicker.c
    2426 
    2527*/
  • src/pitch/pitch.h

    rf72364d r69b11d8  
    3232  This file creates the objects required for the computation of the selected
    3333  pitch detection algorithm and output the results, in midi note or Hz.
     34
     35  \example pitch/test-pitch.c
    3436
    3537*/
  • src/pitch/pitchfcomb.h

    rf72364d r69b11d8  
    2828   This file was derived from the tuneit project, written by Mario Lang to
    2929   detect the fundamental frequency of a sound.
    30    
    31    see http://delysid.org/tuneit.html
     30
     31   See http://delysid.org/tuneit.html
     32
     33   \example pitch/test-pitchfcomb.c
    3234
    3335*/
     
    4345typedef struct _aubio_pitchfcomb_t aubio_pitchfcomb_t;
    4446
    45 /** execute pitch detection on an input buffer 
    46  
     47/** execute pitch detection on an input buffer
     48
    4749  \param p pitch detection object as returned by new_aubio_pitchfcomb
    48   \param input input signal window (length as specified at creation time) 
     50  \param input input signal window (length as specified at creation time)
    4951  \param output pitch candidates in bins
    50  
     52
    5153*/
    5254void aubio_pitchfcomb_do (aubio_pitchfcomb_t * p, fvec_t * input,
     
    5456
    5557/** creation of the pitch detection object
    56  
    57   \param buf_size size of the input buffer to analyse 
    58   \param hop_size step size between two consecutive analysis instant 
    59  
     58
     59  \param buf_size size of the input buffer to analyse
     60  \param hop_size step size between two consecutive analysis instant
     61
    6062*/
    6163aubio_pitchfcomb_t *new_aubio_pitchfcomb (uint_t buf_size, uint_t hop_size);
    6264
    6365/** deletion of the pitch detection object
    64  
     66
    6567  \param p pitch detection object as returned by new_aubio_pitchfcomb
    66  
     68
    6769*/
    6870void del_aubio_pitchfcomb (aubio_pitchfcomb_t * p);
  • src/pitch/pitchmcomb.h

    rf72364d r69b11d8  
    2424
    2525  This fundamental frequency estimation algorithm implements spectral
    26   flattening, multi-comb filtering and peak histogramming. 
     26  flattening, multi-comb filtering and peak histogramming.
    2727
    2828  This method was designed by Juan P. Bello and described in:
     
    3131  Music''.  PhD thesis, Centre for Digital Music, Queen Mary University of
    3232  London, London, UK, 2003.
     33
     34  \example pitch/test-pitchmcomb.c
    3335
    3436*/
     
    4547
    4648/** execute pitch detection on an input spectral frame
    47  
     49
    4850  \param p pitch detection object as returned by new_aubio_pitchmcomb
    49   \param fftgrain input signal spectrum as computed by aubio_pvoc_do
    50  
     51  \param in_fftgrain input signal spectrum as computed by aubio_pvoc_do
     52  \param out_cands pitch candidate frequenciess, in bins
     53
    5154*/
    52 void aubio_pitchmcomb_do (aubio_pitchmcomb_t * p, cvec_t * fftgrain,
    53     fvec_t * output);
     55void aubio_pitchmcomb_do (aubio_pitchmcomb_t * p, cvec_t * in_fftgrain,
     56    fvec_t * out_cands);
    5457
    5558/** creation of the pitch detection object
    56  
    57   \param buf_size size of the input buffer to analyse
    58   \param hop_size step size between two consecutive analysis instant
    59   \param samplerate sampling rate of the signal
    60  
     59
     60  \param buf_size size of the input buffer to analyse
     61  \param hop_size step size between two consecutive analysis instant
     62
    6163*/
    6264aubio_pitchmcomb_t *new_aubio_pitchmcomb (uint_t buf_size, uint_t hop_size);
    6365
    6466/** deletion of the pitch detection object
    65  
     67
    6668  \param p pitch detection object as returned by new_aubio_pitchfcomb
    67  
     69
    6870*/
    6971void del_aubio_pitchmcomb (aubio_pitchmcomb_t * p);
     
    7375#endif
    7476
    75 #endif/*PITCHMCOMB_H*/
     77#endif /* PITCHMCOMB_H */
  • src/pitch/pitchschmitt.h

    rf72364d r69b11d8  
    1919*/
    2020
    21 /** \file 
     21/** \file
    2222
    23    Pitch detection using a Schmitt trigger 
    24  
     23   Pitch detection using a Schmitt trigger
     24
    2525   This pitch extraction method implements a Schmitt trigger to estimate the
    2626   period of a signal.
     
    2828   This file was derived from the tuneit project, written by Mario Lang to
    2929   detect the fundamental frequency of a sound.
    30    
    31    see http://delysid.org/tuneit.html
     30
     31   See http://delysid.org/tuneit.html
     32
     33   \example pitch/test-pitchschmitt.c
    3234
    3335*/
     
    4345typedef struct _aubio_pitchschmitt_t aubio_pitchschmitt_t;
    4446
    45 /** execute pitch detection on an input buffer 
    46  
    47   \param p pitch detection object as returned by new_aubio_pitchschmitt 
    48   \param input input signal window (length as specified at creation time)
    49   \param output pitch period estimates, in samples
    50  
     47/** execute pitch detection on an input buffer
     48
     49  \param p pitch detection object as returned by new_aubio_pitchschmitt
     50  \param samples_in input signal vector (length as specified at creation time)
     51  \param cands_out pitch period estimates, in samples
     52
    5153*/
    52 void aubio_pitchschmitt_do (aubio_pitchschmitt_t * p, fvec_t * in,
    53     fvec_t * out);
     54void aubio_pitchschmitt_do (aubio_pitchschmitt_t * p, fvec_t * samples_in,
     55    fvec_t * cands_out);
    5456
    5557/** creation of the pitch detection object
    56  
    57   \param buf_size size of the input buffer to analyse 
    58  
     58
     59  \param buf_size size of the input buffer to analyse
     60
    5961*/
    6062aubio_pitchschmitt_t *new_aubio_pitchschmitt (uint_t buf_size);
    6163
    6264/** deletion of the pitch detection object
    63  
    64   \param p pitch detection object as returned by new_aubio_pitchschmitt 
    65  
     65
     66  \param p pitch detection object as returned by new_aubio_pitchschmitt
     67
    6668*/
    6769void del_aubio_pitchschmitt (aubio_pitchschmitt_t * p);
  • src/pitch/pitchyin.h

    rf72364d r69b11d8  
    1919*/
    2020
    21 /** \file 
    22  
     21/** \file
     22
    2323  Pitch detection using the YIN algorithm
    24  
     24
    2525  This algorithm was developped by A. de Cheveigne and H. Kawahara and
    2626  published in:
    27  
     27
    2828  De Cheveigné, A., Kawahara, H. (2002) "YIN, a fundamental frequency
    29   estimator for speech and music", J. Acoust. Soc. Am. 111, 1917-1930. 
    30  
     29  estimator for speech and music", J. Acoust. Soc. Am. 111, 1917-1930.
     30
    3131  see http://recherche.ircam.fr/equipes/pcm/pub/people/cheveign.html
    3232
     
    4444
    4545/** creation of the pitch detection object
    46  
    47   \param buf_size size of the input buffer to analyse 
    48  
     46
     47  \param buf_size size of the input buffer to analyse
     48
    4949*/
    5050aubio_pitchyin_t *new_aubio_pitchyin (uint_t buf_size);
    5151
    5252/** deletion of the pitch detection object
    53  
    54   \param p pitch detection object as returned by new_aubio_pitchyin()
    55  
     53
     54  \param o pitch detection object as returned by new_aubio_pitchyin()
     55
    5656*/
    5757void del_aubio_pitchyin (aubio_pitchyin_t * o);
    5858
    59 /** execute pitch detection on an input buffer
    60  
    61   \param p pitch detection object as returned by new_aubio_pitchyin()
    62   \param input input signal window (length as specified at creation time)
    63   \param tol tolerance parameter for minima selection [default 0.85]
    64  
     59/** execute pitch detection an input buffer
     60
     61  \param o pitch detection object as returned by new_aubio_pitchyin()
     62  \param samples_in input signal vector (length as specified at creation time)
     63  \param cands_out pitch period candidates, in samples
     64
    6565*/
    66 void aubio_pitchyin_do (aubio_pitchyin_t * o, fvec_t * in, fvec_t * out);
     66void aubio_pitchyin_do (aubio_pitchyin_t * o, fvec_t * samples_in, fvec_t * cands_out);
    6767
    6868
    69 /** set tolerance parameter for YIN algorithm 
    70  
    71   \param o YIN pitch detection object 
     69/** set tolerance parameter for YIN algorithm
     70
     71  \param o YIN pitch detection object
    7272  \param tol tolerance parameter for minima selection [default 0.15]
    7373
     
    7575uint_t aubio_pitchyin_set_tolerance (aubio_pitchyin_t * o, smpl_t tol);
    7676
    77 /** get tolerance parameter for YIN algorithm 
    78  
    79   \param o YIN pitch detection object 
     77/** get tolerance parameter for YIN algorithm
     78
     79  \param o YIN pitch detection object
    8080  \return tolerance parameter for minima selection [default 0.15]
    8181
     
    8787#endif
    8888
    89 #endif /*PITCHYIN_H*/ 
     89#endif /*PITCHYIN_H*/
  • src/pitch/pitchyinfft.h

    rf72364d r69b11d8  
    4646/** execute pitch detection on an input buffer
    4747 
    48   \param p pitch detection object as returned by new_aubio_pitchyinfft
    49   \param input input signal window (length as specified at creation time)
    50   \param output pitch period candidates, in samples
     48  \param o pitch detection object as returned by new_aubio_pitchyinfft
     49  \param samples_in input signal vector (length as specified at creation time)
     50  \param cands_out pitch period candidates, in samples
    5151 
    5252*/
    53 void aubio_pitchyinfft_do (aubio_pitchyinfft_t * p, fvec_t * in, fvec_t * out);
     53void aubio_pitchyinfft_do (aubio_pitchyinfft_t * o, fvec_t * samples_in, fvec_t * cands_out);
    5454/** creation of the pitch detection object
    5555 
     
    6060/** deletion of the pitch detection object
    6161 
    62   \param p pitch detection object as returned by new_aubio_pitchyinfft()
     62  \param o pitch detection object as returned by new_aubio_pitchyinfft()
    6363 
    6464*/
    65 void del_aubio_pitchyinfft (aubio_pitchyinfft_t * p);
     65void del_aubio_pitchyinfft (aubio_pitchyinfft_t * o);
    6666
    6767/** get tolerance parameter for YIN algorithm
     
    7272
    7373*/
    74 smpl_t aubio_pitchyinfft_get_tolerance (aubio_pitchyinfft_t * p);
     74smpl_t aubio_pitchyinfft_get_tolerance (aubio_pitchyinfft_t * o);
    7575
    7676/** set tolerance parameter for YIN algorithm
     
    8080
    8181*/
    82 uint_t aubio_pitchyinfft_set_tolerance (aubio_pitchyinfft_t * p, smpl_t tol);
     82uint_t aubio_pitchyinfft_set_tolerance (aubio_pitchyinfft_t * o, smpl_t tol);
    8383
    8484#ifdef __cplusplus
  • src/tempo/tempo.h

    rf72364d r69b11d8  
    2525  This object stores all the memory required for tempo detection algorithm
    2626  and returns the estimated beat locations.
     27
     28  \example tempo/test-tempo.h
    2729
    2830*/
  • src/temporal/biquad.h

    rf72364d r69b11d8  
    3636  biquad filter</a> on wikipedia.
    3737
     38  \example temporal/test-biquad.c
     39
    3840*/
    3941
     
    5557    lsmp_t b2, lsmp_t a1, lsmp_t a2);
    5658
    57 /** create new biquad filter
     59/** create biquad filter with `b0`, `b1`, `b2`, `a1`, `a2` coeffs
    5860
    5961  \param b0 forward filter coefficient
Note: See TracChangeset for help on using the changeset viewer.