Changeset d88ea06 for src


Ignore:
Timestamp:
Sep 29, 2006, 4:50:37 PM (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:
366f811
Parents:
3b3ec6c
Message:

add some documentation
add some documentation

Location:
src
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • src/fft.h

    r3b3ec6c rd88ea06  
    3939#else
    4040#if FFTW3F_SUPPORT
     41/** fft data type */
    4142#define FFTW_TYPE float
    4243#else
     44/** fft data type */
    4345#define FFTW_TYPE double
    4446#endif
    … …  
    4951#endif
    5052
     53/** fft data type */
    5154typedef FFTW_TYPE fft_data_t;
    5255

  • src/filter.h

    r3b3ec6c rd88ea06  
    6767/** create new IIR filter
    6868
    69   \param b vector of forward coefficients
    70   \param a vector of feedback coefficients
     69  \param samplerate signal sampling rate
    7170  \param order order of the filter (number of coefficients)
    7271

  • src/hist.h

    r3b3ec6c rd88ea06  
    4343/** histogram deletion */
    4444void del_aubio_hist(aubio_hist_t *s);
     45/** compute the histogram */
    4546void aubio_hist_do(aubio_hist_t *s, fvec_t * input);
     47/** compute the histogram ignoring null elements */
    4648void aubio_hist_do_notnull(aubio_hist_t *s, fvec_t * input);
     49/** compute the mean of the histogram */
    4750smpl_t aubio_hist_mean(aubio_hist_t *s);
     51/** weight the histogram */
    4852void aubio_hist_weigth(aubio_hist_t *s);
     53/** compute dynamic histogram for non-null elements */
    4954void aubio_hist_dyn_notnull (aubio_hist_t *s, fvec_t *input);
    5055

  • src/mathutils.h

    r3b3ec6c rd88ea06  
    119119 */
    120120smpl_t vec_alpha_norm(fvec_t * DF, smpl_t alpha);
    121 /*  dc(min) removal */
     121/**  dc(min) removal */
    122122void vec_dc_removal(fvec_t * mag);
    123123/**  alpha normalisation */
    124124void vec_alpha_normalise(fvec_t * mag, uint_t alpha);
    125 
     125/** add a constant to all members of a vector */
    126126void vec_add(fvec_t * mag, smpl_t threshold);
    127127
     128/** compute adaptive threshold of input vector */
    128129void vec_adapt_thres(fvec_t * vec, fvec_t * tmp,
    129130    uint_t win_post, uint_t win_pre);
    … …  
    182183uint_t vec_peakpick(fvec_t * input, uint_t pos);
    183184
     185/** convert frequency bin to midi value */
    184186smpl_t aubio_bintomidi(smpl_t bin, smpl_t samplerate, smpl_t fftsize);
     187/** convert midi value to frequency bin */
    185188smpl_t aubio_miditobin(smpl_t midi, smpl_t samplerate, smpl_t fftsize);
     189/** convert frequency bin to frequency (Hz) */
    186190smpl_t aubio_bintofreq(smpl_t bin, smpl_t samplerate, smpl_t fftsize);
     191/** convert frequency (Hz) to frequency bin */
    187192smpl_t aubio_freqtobin(smpl_t freq, smpl_t samplerate, smpl_t fftsize);
     193/** convert frequency (Hz) to midi value (0-128) */
    188194smpl_t aubio_freqtomidi(smpl_t freq);
     195/** convert midi value (0-128) to frequency (Hz) */
    189196smpl_t aubio_miditofreq(smpl_t midi);
    190197
     198/** check if current buffer level is under a given threshold */
    191199uint_t aubio_silence_detection(fvec_t * ibuf, smpl_t threshold);
     200/** get the current buffer level */
    192201smpl_t aubio_level_detection(fvec_t * ibuf, smpl_t threshold);
    193202/**

  • src/peakpick.h

    r3b3ec6c rd88ea06  
    3131#endif
    3232
     33/** function pointer to thresholding function */
    3334typedef smpl_t (*aubio_thresholdfn_t)(fvec_t *input);
     35/** function pointer to peak-picking function */
    3436typedef uint_t (*aubio_pickerfn_t)(fvec_t *input, uint_t pos);
     37/** peak-picker structure */
    3538typedef struct _aubio_pickpeak_t aubio_pickpeak_t;
    3639
     40/** peak-picker creation function */
    3741aubio_pickpeak_t * new_aubio_peakpicker(smpl_t threshold);
     42/** real time peak picking function */
    3843uint_t aubio_peakpick_pimrt(fvec_t * DF, aubio_pickpeak_t * p);
    3944/** function added by Miguel Ramirez to return the onset detection amplitude in peakval */
    4045uint_t aubio_peakpick_pimrt_wt( fvec_t* DF, aubio_pickpeak_t* p, smpl_t* peakval );
     46/** get current peak value */
    4147smpl_t aubio_peakpick_pimrt_getval(aubio_pickpeak_t * p);
     48/** destroy peak picker structure */
    4249void del_aubio_peakpicker(aubio_pickpeak_t * p);
    4350
     51/** set peak picking threshold */
    4452void aubio_peakpicker_set_threshold(aubio_pickpeak_t * p, smpl_t threshold);
     53/** get peak picking threshold */
    4554smpl_t aubio_peakpicker_get_threshold(aubio_pickpeak_t * p);
     55/** set peak picker thresholding function */
    4656void aubio_peakpicker_set_thresholdfn(aubio_pickpeak_t * p, aubio_thresholdfn_t thresholdfn);
     57/** get peak picker thresholding function */
    4758aubio_thresholdfn_t aubio_peakpicker_get_thresholdfn(aubio_pickpeak_t * p);
    4859

  • src/pitchmcomb.h

    r3b3ec6c rd88ea06  
    5050*/
    5151smpl_t aubio_pitchmcomb_detect(aubio_pitchmcomb_t * p, cvec_t * fftgrain);
     52/** select the best candidates */
    5253uint_t aubio_pitch_cands(aubio_pitchmcomb_t * p, cvec_t * fftgrain, smpl_t * cands);
    5354/** creation of the pitch detection object

  • src/tempo.h

    r3b3ec6c rd88ea06  
    1818*/
    1919
     20/** \file
     21 
     22  Tempo detection driver
     23
     24  This object stores all the memory required for tempo detection algorithm
     25  and returns the estimated beat locations.
     26
     27*/
     28
    2029#ifndef TEMPO_H
    2130#define TEMPO_H
    … …  
    2534#endif
    2635
     36/** tempo detection structure */
    2737typedef struct _aubio_tempo_t aubio_tempo_t;
    2838
Note: See TracChangeset for help on using the changeset viewer.