From: Paul Brossier Date: Sat, 7 Dec 2013 17:10:37 +0000 (-0500) Subject: src/synth/{wavetable,sampler}.h: improve documentation X-Git-Tag: 0.4.0-beta1~37 X-Git-Url: https://git.aubio.org/?p=aubio.git;a=commitdiff_plain;h=2b6139e795605d54d1b49d96a66643b88b03d544 src/synth/{wavetable,sampler}.h: improve documentation --- diff --git a/src/synth/sampler.h b/src/synth/sampler.h index b0e63b35..cd9f3748 100644 --- a/src/synth/sampler.h +++ b/src/synth/sampler.h @@ -44,6 +44,7 @@ typedef struct _aubio_sampler_t aubio_sampler_t; /** create new sampler object \param samplerate the sampling rate of the new sampler + \param hop_size the block size of the new sampler \return the newly created ::aubio_sampler_t @@ -52,7 +53,7 @@ aubio_sampler_t * new_aubio_sampler(uint_t samplerate, uint_t hop_size); /** load source in sampler - \param o sampler, created by ::new_aubio_sampler + \param o sampler, created by new_aubio_sampler() \param uri the uri of the source to load \return 0 if successful, non-zero otherwise @@ -62,11 +63,11 @@ uint_t aubio_sampler_load( aubio_sampler_t * o, char_t * uri ); /** process sampler function - \param o sampler, created by ::new_aubio_sampler + \param o sampler, created by new_aubio_sampler() \param input input of the sampler, to be added to the output \param output output of the sampler -This function adds the new samples from the playing sample to the output. +This function adds the new samples from the playing source to the output. If `input` is not NULL and different from `output`, then the samples from `input` are added to the output. @@ -76,11 +77,11 @@ void aubio_sampler_do ( aubio_sampler_t * o, fvec_t * input, fvec_t * output); /** process sampler function, multiple channels - \param o sampler, created by ::new_aubio_sampler + \param o sampler, created by new_aubio_sampler() \param input input of the sampler, to be added to the output \param output output of the sampler -This function adds the new samples from the playing sample to the output. +This function adds the new samples from the playing source to the output. If `input` is not NULL and different from `output`, then the samples from `input` are added to the output. @@ -90,7 +91,7 @@ void aubio_sampler_do_multi ( aubio_sampler_t * o, fmat_t * input, fmat_t * outp /** get current playing state - \param o sampler, created by ::new_aubio_sampler + \param o sampler, created by new_aubio_sampler() \return 0 if not playing, 1 if playing @@ -99,7 +100,7 @@ uint_t aubio_sampler_get_playing ( aubio_sampler_t * o ); /** set current playing state - \param o sampler, created by ::new_aubio_sampler + \param o sampler, created by new_aubio_sampler() \param playing 0 for not playing, 1 for playing \return 0 if successful, 1 otherwise @@ -109,18 +110,16 @@ uint_t aubio_sampler_set_playing ( aubio_sampler_t * o, uint_t playing ); /** play sample from start - \param o sampler, created by ::new_aubio_sampler - \param playing 0 for not playing, 1 for playing + \param o sampler, created by new_aubio_sampler() \return 0 if successful, 1 otherwise */ uint_t aubio_sampler_play ( aubio_sampler_t * o ); -/** stop sample from start +/** stop sample - \param o sampler, created by ::new_aubio_sampler - \param playing 0 for not playing, 1 for playing + \param o sampler, created by new_aubio_sampler() \return 0 if successful, 1 otherwise @@ -129,7 +128,7 @@ uint_t aubio_sampler_stop ( aubio_sampler_t * o ); /** destroy ::aubio_sampler_t object - \param o sampler, created by ::new_aubio_sampler + \param o sampler, created by new_aubio_sampler() */ void del_aubio_sampler( aubio_sampler_t * o ); diff --git a/src/synth/wavetable.h b/src/synth/wavetable.h index 89837245..5543cd7b 100644 --- a/src/synth/wavetable.h +++ b/src/synth/wavetable.h @@ -23,9 +23,9 @@ /** \file - Load and play sound files. + Wavetable synthesis. - This file loads a sample and gets ready to play it. + This file creates a wavetable and plays it at different frequency. The `_do` function adds the new samples to the input, and write the result as the output. @@ -44,15 +44,16 @@ typedef struct _aubio_wavetable_t aubio_wavetable_t; /** create new wavetable object \param samplerate the sampling rate of the new wavetable + \param hop_size the block size of the new wavetable - \return the newly created ::aubio_wavetable_t + \return the newly created aubio_wavetable_t */ aubio_wavetable_t * new_aubio_wavetable(uint_t samplerate, uint_t hop_size); /** load source in wavetable - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() \param uri the uri of the source to load \return 0 if successful, non-zero otherwise @@ -62,11 +63,11 @@ uint_t aubio_wavetable_load( aubio_wavetable_t * o, char_t * uri ); /** process wavetable function - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() \param input input of the wavetable, to be added to the output \param output output of the wavetable -This function adds the new samples from the playing sample to the output. +This function adds the new samples from the playing wavetable to the output. If `input` is not NULL and different from `output`, then the samples from `input` are added to the output. @@ -76,11 +77,11 @@ void aubio_wavetable_do ( aubio_wavetable_t * o, fvec_t * input, fvec_t * output /** process wavetable function, multiple channels - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() \param input input of the wavetable, to be added to the output \param output output of the wavetable -This function adds the new samples from the playing sample to the output. +This function adds the new samples from the playing wavetable to the output. If `input` is not NULL and different from `output`, then the samples from `input` are added to the output. @@ -90,7 +91,7 @@ void aubio_wavetable_do_multi ( aubio_wavetable_t * o, fmat_t * input, fmat_t * /** get current playing state - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() \return 0 if not playing, 1 if playing @@ -99,7 +100,7 @@ uint_t aubio_wavetable_get_playing ( aubio_wavetable_t * o ); /** set current playing state - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() \param playing 0 for not playing, 1 for playing \return 0 if successful, 1 otherwise @@ -109,16 +110,16 @@ uint_t aubio_wavetable_set_playing ( aubio_wavetable_t * o, uint_t playing ); /** play sample from start - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() \return 0 if successful, 1 otherwise */ uint_t aubio_wavetable_play ( aubio_wavetable_t * o ); -/** stop sample +/** stop wavetable - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() \return 0 if successful, 1 otherwise @@ -127,7 +128,7 @@ uint_t aubio_wavetable_stop ( aubio_wavetable_t * o ); /** set wavetable frequency - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() \param freq new frequency value for the wavetable \return 0 if successful, 1 otherwise @@ -137,7 +138,7 @@ uint_t aubio_wavetable_set_freq ( aubio_wavetable_t * o, smpl_t freq ); /** get wavetable frequency - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() \return current frequency, in Hz @@ -146,7 +147,7 @@ smpl_t aubio_wavetable_get_freq ( aubio_wavetable_t * o); /** set wavetable amplitude - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() \param amp new amplitude value for the wavetable \return 0 if successful, 1 otherwise @@ -156,16 +157,16 @@ uint_t aubio_wavetable_set_amp ( aubio_wavetable_t * o, smpl_t amp ); /** get wavetable amplitude - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() \return current amplitude */ smpl_t aubio_wavetable_get_amp ( aubio_wavetable_t * o); -/** destroy ::aubio_wavetable_t object +/** destroy aubio_wavetable_t object - \param o wavetable, created by ::new_aubio_wavetable + \param o wavetable, created by new_aubio_wavetable() */ void del_aubio_wavetable( aubio_wavetable_t * o );