Changeset 2b6139e7


Ignore:
Timestamp:
Dec 7, 2013, 6:10:37 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:
479adba
Parents:
4b7a740
Message:

src/synth/{wavetable,sampler}.h: improve documentation

Location:
src/synth
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • src/synth/sampler.h

    r4b7a740 r2b6139e7  
    4545
    4646  \param samplerate the sampling rate of the new sampler
     47  \param hop_size the block size of the new sampler
    4748
    4849  \return the newly created ::aubio_sampler_t
     
    5354/** load source in sampler
    5455
    55   \param o sampler, created by ::new_aubio_sampler
     56  \param o sampler, created by new_aubio_sampler()
    5657  \param uri the uri of the source to load
    5758
     
    6364/** process sampler function
    6465
    65   \param o sampler, created by ::new_aubio_sampler
     66  \param o sampler, created by new_aubio_sampler()
    6667  \param input input of the sampler, to be added to the output
    6768  \param output output of the sampler
    6869
    69 This function adds the new samples from the playing sample to the output.
     70This function adds the new samples from the playing source to the output.
    7071
    7172If `input` is not NULL and different from `output`, then the samples from `input`
     
    7778/** process sampler function, multiple channels
    7879
    79   \param o sampler, created by ::new_aubio_sampler
     80  \param o sampler, created by new_aubio_sampler()
    8081  \param input input of the sampler, to be added to the output
    8182  \param output output of the sampler
    8283
    83 This function adds the new samples from the playing sample to the output.
     84This function adds the new samples from the playing source to the output.
    8485
    8586If `input` is not NULL and different from `output`, then the samples from `input`
     
    9192/** get current playing state
    9293
    93   \param o sampler, created by ::new_aubio_sampler
     94  \param o sampler, created by new_aubio_sampler()
    9495
    9596  \return 0 if not playing, 1 if playing
     
    100101/** set current playing state
    101102
    102   \param o sampler, created by ::new_aubio_sampler
     103  \param o sampler, created by new_aubio_sampler()
    103104  \param playing 0 for not playing, 1 for playing
    104105
     
    110111/** play sample from start
    111112
    112   \param o sampler, created by ::new_aubio_sampler
    113   \param playing 0 for not playing, 1 for playing
     113  \param o sampler, created by new_aubio_sampler()
    114114
    115115  \return 0 if successful, 1 otherwise
     
    118118uint_t aubio_sampler_play ( aubio_sampler_t * o );
    119119
    120 /** stop sample from start
     120/** stop sample
    121121
    122   \param o sampler, created by ::new_aubio_sampler
    123   \param playing 0 for not playing, 1 for playing
     122  \param o sampler, created by new_aubio_sampler()
    124123
    125124  \return 0 if successful, 1 otherwise
     
    130129/** destroy ::aubio_sampler_t object
    131130
    132   \param o sampler, created by ::new_aubio_sampler
     131  \param o sampler, created by new_aubio_sampler()
    133132
    134133*/
  • src/synth/wavetable.h

    r4b7a740 r2b6139e7  
    2424/** \file
    2525
    26   Load and play sound files.
     26  Wavetable synthesis.
    2727
    28   This file loads a sample and gets ready to play it.
     28  This file creates a wavetable and plays it at different frequency.
    2929
    3030  The `_do` function adds the new samples to the input, and write the result as
     
    4545
    4646  \param samplerate the sampling rate of the new wavetable
     47  \param hop_size the block size of the new wavetable
    4748
    48   \return the newly created ::aubio_wavetable_t
     49  \return the newly created aubio_wavetable_t
    4950
    5051*/
     
    5354/** load source in wavetable
    5455
    55   \param o wavetable, created by ::new_aubio_wavetable
     56  \param o wavetable, created by new_aubio_wavetable()
    5657  \param uri the uri of the source to load
    5758
     
    6364/** process wavetable function
    6465
    65   \param o wavetable, created by ::new_aubio_wavetable
     66  \param o wavetable, created by new_aubio_wavetable()
    6667  \param input input of the wavetable, to be added to the output
    6768  \param output output of the wavetable
    6869
    69 This function adds the new samples from the playing sample to the output.
     70This function adds the new samples from the playing wavetable to the output.
    7071
    7172If `input` is not NULL and different from `output`, then the samples from `input`
     
    7778/** process wavetable function, multiple channels
    7879
    79   \param o wavetable, created by ::new_aubio_wavetable
     80  \param o wavetable, created by new_aubio_wavetable()
    8081  \param input input of the wavetable, to be added to the output
    8182  \param output output of the wavetable
    8283
    83 This function adds the new samples from the playing sample to the output.
     84This function adds the new samples from the playing wavetable to the output.
    8485
    8586If `input` is not NULL and different from `output`, then the samples from `input`
     
    9192/** get current playing state
    9293
    93   \param o wavetable, created by ::new_aubio_wavetable
     94  \param o wavetable, created by new_aubio_wavetable()
    9495
    9596  \return 0 if not playing, 1 if playing
     
    100101/** set current playing state
    101102
    102   \param o wavetable, created by ::new_aubio_wavetable
     103  \param o wavetable, created by new_aubio_wavetable()
    103104  \param playing 0 for not playing, 1 for playing
    104105
     
    110111/** play sample from start
    111112
    112   \param o wavetable, created by ::new_aubio_wavetable
     113  \param o wavetable, created by new_aubio_wavetable()
    113114
    114115  \return 0 if successful, 1 otherwise
     
    117118uint_t aubio_wavetable_play ( aubio_wavetable_t * o );
    118119
    119 /** stop sample
     120/** stop wavetable
    120121
    121   \param o wavetable, created by ::new_aubio_wavetable
     122  \param o wavetable, created by new_aubio_wavetable()
    122123
    123124  \return 0 if successful, 1 otherwise
     
    128129/** set wavetable frequency
    129130
    130   \param o wavetable, created by ::new_aubio_wavetable
     131  \param o wavetable, created by new_aubio_wavetable()
    131132  \param freq new frequency value for the wavetable
    132133
     
    138139/** get wavetable frequency
    139140
    140   \param o wavetable, created by ::new_aubio_wavetable
     141  \param o wavetable, created by new_aubio_wavetable()
    141142
    142143  \return current frequency, in Hz
     
    147148/** set wavetable amplitude
    148149
    149   \param o wavetable, created by ::new_aubio_wavetable
     150  \param o wavetable, created by new_aubio_wavetable()
    150151  \param amp new amplitude value for the wavetable
    151152
     
    157158/** get wavetable amplitude
    158159
    159   \param o wavetable, created by ::new_aubio_wavetable
     160  \param o wavetable, created by new_aubio_wavetable()
    160161
    161162  \return current amplitude
     
    164165smpl_t aubio_wavetable_get_amp ( aubio_wavetable_t * o);
    165166
    166 /** destroy ::aubio_wavetable_t object
     167/** destroy aubio_wavetable_t object
    167168
    168   \param o wavetable, created by ::new_aubio_wavetable
     169  \param o wavetable, created by new_aubio_wavetable()
    169170
    170171*/
Note: See TracChangeset for help on using the changeset viewer.