ref: 2b6139e795605d54d1b49d96a66643b88b03d544
parent: 4b7a740dec88b19e245276b47261db6ade864be4
author: Paul Brossier <piem@piem.org>
date: Sat Dec 7 07:10:37 EST 2013
src/synth/{wavetable,sampler}.h: improve documentation
--- a/src/synth/sampler.h
+++ b/src/synth/sampler.h
@@ -44,6 +44,7 @@
/** 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 @@
/** 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 @@
/** 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 @@
/** 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 @@
/** 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 @@
/** 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,8 +110,7 @@
/** 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
@@ -117,10 +117,9 @@
*/
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 @@
/** 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 );
--- 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,8 +44,9 @@
/** 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);
@@ -52,7 +53,7 @@
/** 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 @@
/** 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 @@
/** 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 @@
/** 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 @@
/** 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,7 +110,7 @@
/** 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
@@ -116,9 +117,9 @@
*/
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 @@
/** 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 @@
/** 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 @@
/** 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,7 +157,7 @@
/** get wavetable amplitude
- \param o wavetable, created by ::new_aubio_wavetable
+ \param o wavetable, created by new_aubio_wavetable()
\return current amplitude
@@ -163,9 +164,9 @@
*/
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 );
--
⑨