ref: 53eedc9b3a3144d021559244c1d30f1fe2bae207
parent: 73513b951f661c0bd4d38782c56935fc3159353b
author: Matthew Wang <mjw7@princeton.edu>
date: Thu Dec 17 12:18:37 EST 2020
updating docs
--- a/leaf/Inc/leaf-delay.h
+++ b/leaf/Inc/leaf-delay.h
@@ -35,7 +35,7 @@
@{
@fn void tDelay_init (tDelay* const, uint32_t delay, uint32_t maxDelay, LEAF* const leaf)
- @brief
+ @brief Initialize a tDelay to the default mempool of a LEAF instance.
@param delay A pointer to the tDelay to initialize.
@param initalLength
@param maxLength
@@ -42,7 +42,7 @@
@param leaf A pointer to the leaf instance.
@fn void tDelay_initToPool (tDelay* const, uint32_t delay, uint32_t maxDelay, tMempool* const)
- @brief
+ @brief Initialize a tDelay to a specified mempool.
@param delay A pointer to the tDelay to initialize.
@param initalLength
@param maxLength
@@ -143,7 +143,7 @@
@{
@fn void tLinearDelay_init (tLinearDelay* const, float delay, uint32_t maxDelay, LEAF* const leaf)
- @brief
+ @brief Initialize a tLinearDelay to the default mempool of a LEAF instance.
@param delay A pointer to the tLinearDelay to initialize.
@param initialLength
@param maxLength
@@ -150,7 +150,7 @@
@param leaf A pointer to the leaf instance.
@fn void tLinearDelay_initToPool (tLinearDelay* const, float delay, uint32_t maxDelay, tMempool* const)
- @brief
+ @brief Initialize a tLinearDelay to a specified mempool.
@param delay A pointer to the tLinearDelay to initialize.
@param initialLength
@param maxLength
@@ -210,7 +210,6 @@
typedef struct _tLinearDelay
{
-
tMempool mempool;
float gain;
@@ -257,7 +256,7 @@
@{
@fn void tHermiteDelay_init (tHermiteDelay* const dl, float delay, uint32_t maxDelay, LEAF* const leaf)
- @brief
+ @brief Initialize a tHermiteDelay to the default mempool of a LEAF instance.
@param delay A pointer to the tHermiteDelay to initialize.
@param initialLength
@param maxLength
@@ -264,7 +263,7 @@
@param leaf A pointer to the leaf instance.
@fn void tHermiteDelay_initToPool (tHermiteDelay* const dl, float delay, uint32_t maxDelay, tMempool* const mp)
- @brief
+ @brief Initialize a tHermiteDelay to a specified mempool.
@param delay A pointer to the tHermiteDelay to initialize.
@param initialLength
@param maxLength
@@ -394,54 +393,54 @@
@{
@fn void tAllpassDelay_init (tAllpassDelay* const, float delay, uint32_t maxDelay, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tAllpassDelay to the default mempool of a LEAF instance.
+ @param delay A pointer to the tAllpassDelay to initialize.
@param leaf A pointer to the leaf instance.
@fn void tAllpassDelay_initToPool (tAllpassDelay* const, float delay, uint32_t maxDelay, tMempool* const)
- @brief
- @param
+ @brief Initialize a tAllpassDelay to a specified mempool.
+ @param delay A pointer to the tAllpassDelay to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tAllpassDelay_free (tAllpassDelay* const)
@brief Free a tAllpassDelay from its mempool.
- @param
+ @param delay A pointer to the tAllpassDelay to free.
@fn void tAllpassDelay_clear (tAllpassDelay* const)
@brief
- @param
+ @param delay A pointer to the relevant tAllpassDelay.
@fn int tAllpassDelay_setDelay (tAllpassDelay* const, float delay)
@brief
- @param
+ @param delay A pointer to the relevant tAllpassDelay.
@fn float tAllpassDelay_getDelay (tAllpassDelay* const)
@brief
- @param
+ @param delay A pointer to the relevant tAllpassDelay.
@fn void tAllpassDelay_tapIn (tAllpassDelay* const, float in, uint32_t tapDelay)
@brief
- @param
+ @param delay A pointer to the relevant tAllpassDelay.
@fn float tAllpassDelay_tapOut (tAllpassDelay* const, uint32_t tapDelay)
@brief
- @param
+ @param delay A pointer to the relevant tAllpassDelay.
@fn float tAllpassDelay_addTo (tAllpassDelay* const, float value, uint32_t tapDelay)
@brief
- @param
+ @param delay A pointer to the relevant tAllpassDelay.
@fn float tAllpassDelay_tick (tAllpassDelay* const, float sample)
@brief
- @param
+ @param delay A pointer to the relevant tAllpassDelay.
@fn float tAllpassDelay_getLastOut (tAllpassDelay* const)
@brief
- @param
+ @param delay A pointer to the relevant tAllpassDelay.
@fn float tAllpassDelay_getLastIn (tAllpassDelay* const)
@brief
- @param
+ @param delay A pointer to the relevant tAllpassDelay.

@} */
@@ -492,64 +491,63 @@
@{
@fn void tTapeDelay_init (tTapeDelay* const, float delay, uint32_t maxDelay, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tTapeDelay to the default mempool of a LEAF instance.
+ @param delay A pointer to the tTapeDelay to initialize.
@param leaf A pointer to the leaf instance.
@fn void tTapeDelay_initToPool (tTapeDelay* const, float delay, uint32_t maxDelay, tMempool* const)
- @brief
- @param
+ @brief Initialize a tTapeDelay to a specified mempool.
+ @param delay A pointer to the tTapeDelay to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tTapeDelay_free (tTapeDelay* const)
@brief Free a tTapeDelay from its mempool.
- @param
+ @param delay A pointer to the tTapeDelay to free.
@fn void tTapeDelay_clear (tTapeDelay* const)
- @brief
- @param
+ @brief
+ @param delay A pointer to the relevant tTapeDelay.
@fn void tTapeDelay_setDelay (tTapeDelay* const, float delay)
@brief
- @param
+ @param delay A pointer to the relevant tTapeDelay.
@fn float tTapeDelay_getDelay (tTapeDelay* const)
@brief
- @param
+ @param delay A pointer to the relevant tTapeDelay.
@fn void tTapeDelay_tapIn (tTapeDelay* const, float in, uint32_t tapDelay)
@brief
- @param
+ @param delay A pointer to the relevant tTapeDelay.
@fn float tTapeDelay_tapOut (tTapeDelay* const d, float tapDelay)
@brief
- @param
+ @param delay A pointer to the relevant tTapeDelay.
@fn float tTapeDelay_addTo (tTapeDelay* const, float value, uint32_t tapDelay)
@brief
- @param
+ @param delay A pointer to the relevant tTapeDelay.
@fn float tTapeDelay_tick (tTapeDelay* const, float sample)
@brief
- @param
+ @param delay A pointer to the relevant tTapeDelay.
@fn void tTapeDelay_incrementInPoint(tTapeDelay* const dl)
@brief
- @param
+ @param delay A pointer to the relevant tTapeDelay.
@fn float tTapeDelay_getLastOut (tTapeDelay* const)
@brief
- @param
+ @param delay A pointer to the relevant tTapeDelay.
@fn float tTapeDelay_getLastIn (tTapeDelay* const)
@brief
- @param
+ @param delay A pointer to the relevant tTapeDelay.

@} */
typedef struct _tTapeDelay
{
-
tMempool mempool;
float gain;
@@ -593,42 +591,42 @@
@{
@fn void tRingBuffer_init (tRingBuffer* const ring, int size, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tRingBuffer to the default mempool of a LEAF instance.
+ @param delay A pointer to the tRingbuffer to initialize.
@param leaf A pointer to the leaf instance.
@fn void tRingBuffer_initToPool (tRingBuffer* const ring, int size, tMempool* const mempool)
- @brief
- @param
+ @brief Initialize a tRingBuffer to a specified mempool.
+ @param delay A pointer to the tRingbuffer to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tRingBuffer_free (tRingBuffer* const ring)
@brief Free a tRingBuffer from its mempool.
- @param
+ @param delay A pointer to the tRingBuffer to free.
@fn void tRingBuffer_push (tRingBuffer* const ring, float val)
@brief
- @param
+ @param delay A pointer to the relevant tRingBuffer.
@fn float tRingBuffer_getNewest (tRingBuffer* const ring)
@brief
- @param
+ @param delay A pointer to the relevant tRingBuffer.
@fn float tRingBuffer_getOldest (tRingBuffer* const ring)
@brief
- @param
+ @param delay A pointer to the relevant tRingBuffer.
@fn float tRingBuffer_get (tRingBuffer* const ring, int index)
@brief
- @param
+ @param delay A pointer to the relevant tRingBuffer.
@fn float tRingBuffer_clear (tRingBuffer* const ring)
@brief
- @param
+ @param delay A pointer to the relevant tRingBuffer.
@fn int tRingBuffer_getSize (tRingBuffer* const ring)
@brief
- @param
+ @param delay A pointer to the relevant tRingBuffer.

@} */
typedef struct _tRingBuffer
--- a/leaf/Inc/leaf-distortion.h
+++ b/leaf/Inc/leaf-distortion.h
@@ -36,26 +36,26 @@
@{
@fn void tSampleReducer_init (tSampleReducer* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tSampleReducer to the default mempool of a LEAF instance.
+ @param reducer A pointer to the tSampleReducer to initialize.
@param leaf A pointer to the leaf instance.
@fn void tSampleReducer_initToPool (tSampleReducer* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tSampleReducer to a specified mempool.
+ @param reducer A pointer to the tSampleReducer to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tSampleReducer_free (tSampleReducer* const)
@brief Free a tSampleReducer from its mempool.
- @param
+ @param reducer A pointer to the tSampleReducer to free.
@fn float tSampleReducer_tick (tSampleReducer* const, float input)
@brief
- @param
+ @param reducer A pointer to the relevant tSampleReducer.
@fn void tSampleReducer_setRatio (tSampleReducer* const, float ratio)
@brief
- @param
+ @param reducer A pointer to the relevant tSampleReducer.

@} */
@@ -86,34 +86,34 @@
@{
@fn void tOversampler_init (tOversampler* const, int order, int extraQuality, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tOversampler to the default mempool of a LEAF instance.
+ @param oversampler A pointer to the tOversampler to initialize.
@param leaf A pointer to the leaf instance.
@fn void tOversampler_initToPool (tOversampler* const, int order, int extraQuality, tMempool* const)
- @brief
- @param
+ @brief Initialize a tOversampler to a specified mempool.
+ @param oversampler A pointer to the tOversampler to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tOversampler_free (tOversampler* const)
@brief Free a tOversampler from its mempool.
- @param
+ @param oversampler A pointer to the tOversampler to free.
@fn void tOversampler_upsample (tOversampler* const, float input, float* output)
@brief
- @param
+ @param oversampler A pointer to the relevant tOversampler.
@fn float tOversampler_downsample (tOversampler* const os, float* input)
@brief
- @param
+ @param oversampler A pointer to the relevant tOversampler.
@fn float tOversampler_tick (tOversampler* const, float input, float* oversample, float (*effectTick)(float))
@brief
- @param
+ @param oversampler A pointer to the relevant tOversampler.
@fn int tOversampler_getLatency (tOversampler* const os)
@brief
- @param
+ @param oversampler A pointer to the relevant tOversampler.

@} */
@@ -149,22 +149,22 @@
@{
@fn void tLockhartWavefolder_init (tLockhartWavefolder* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tLockhartWavefolder to the default mempool of a LEAF instance.
+ @param wavefolder A pointer to the tLockhartWavefolder to initialize.
@param leaf A pointer to the leaf instance.
@fn void tLockhartWavefolder_initToPool (tLockhartWavefolder* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tLockhartWavefolder to a specified mempool.
+ @param wavefolder A pointer to the tLockhartWavefolder to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tLockhartWavefolder_free (tLockhartWavefolder* const)
@brief Free a tLockhartWavefolder from its mempool.
- @param
+ @param wavefolder A pointer to the tLockhartWavefolder to free.
@fn float tLockhartWavefolder_tick (tLockhartWavefolder* const, float samp)
@brief
- @param
+ @param wavefolder A pointer to the relevant tLockhartWavefolder.

@} */
@@ -217,37 +217,41 @@
@{
@fn void tCrusher_init (tCrusher* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tCrusher to the default mempool of a LEAF instance.
+ @param crusher A pointer to the tCrusher to initialize.
@param leaf A pointer to the leaf instance.f
@fn void tCrusher_initToPool (tCrusher* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tCrusher to a specified mempool.
+ @param crusher A pointer to the tCrusher to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tCrusher_free (tCrusher* const)
@brief Free a tCrusher from its mempool.
- @param
+ @param crusher A pointer to the tCrusher to free.
@fn float tCrusher_tick (tCrusher* const, float input)
@brief
- @param
+ @param crusher A pointer to the relevant tCrusher.
@fn void tCrusher_setOperation (tCrusher* const, float op)
@brief
- @param 0.0 - 1.0
+ @param crusher A pointer to the relevant tCrusher.
+ @param operation 0.0 - 1.0
@fn void tCrusher_setQuality (tCrusher* const, float val)
@brief
- @param 0.0 - 1.0
+ @param crusher A pointer to the relevant tCrusher.
+ @param quality 0.0 - 1.0
@fn void tCrusher_setRound (tCrusher* const, float rnd)
@brief
+ @param crusher A pointer to the relevant tCrusher.
@param what division to round to
@fn void tCrusher_setSamplingRatio (tCrusher* const, float ratio)
@brief
+ @param crusher A pointer to the relevant tCrusher.
@param sampling ratio

@} */
--- a/leaf/Inc/leaf-dynamics.h
+++ b/leaf/Inc/leaf-dynamics.h
@@ -38,22 +38,22 @@
@{
@fn void tCompressor_init (tCompressor* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tCompressor to the default mempool of a LEAF instance.
+ @param compressor A pointer to the tCompressor to initialize.
@param leaf A pointer to the leaf instance.
@fn void tCompressor_initToPool (tCompressor* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tCompressor to a specified mempool.
+ @param compressor A pointer to the tCompressor to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tCompressor_free (tCompressor* const)
@brief Free a tCompressor from its mempool.
- @param
+ @param compressor A pointer to the tCompressor to free.
@fn float tCompressor_tick (tCompressor* const, float input)
@brief
- @param
+ @param compressor A pointer to the relevant tCompressor.

@} */
@@ -84,46 +84,47 @@
@defgroup tfeedbackleveler tFeedbackLeveler
@ingroup dynamics
@brief An auto VCA that you put into a feedback circuit to make it stay at the same level.
- @detail An auto VCA that you put into a feedback circuit to make it stay at the same level. It can enforce level bidirectionally (amplifying and attenuating as needed) or just attenutating. The former option allows for infinite sustain strings, for example, while The latter option allows for decaying strings, which can never exceed a specific level.
+ @detail An auto VCA that you put into a feedback circuit to make it stay at the same level. It can enforce level bidirectionally (amplifying and attenuating as needed) or just attenutating. The former option allows for infinite sustain strings, for example, while the latter option allows for decaying strings, which can never exceed a specific level.
@{
@fn void tFeedbackLeveler_init (tFeedbackLeveler* const, float targetLevel, float factor, float strength, int mode, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tFeedbackLeveler to the default mempool of a LEAF instance.
+ @param leveler A pointer to the tFeedbackLeveler to initialize.
@param leaf A pointer to the leaf instance.
@fn void tFeedbackLeveler_initToPool (tFeedbackLeveler* const, float targetLevel, float factor, float strength, int mode, tMempool* const)
- @brief
- @param
+ @brief Initialize a tFeedbackLeveler to a specified mempool.
+ @param leveler A pointer to the tFeedbackLeveler to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tFeedbackLeveler_free (tFeedbackLeveler* const)
@brief Free a tFeedbackLeveler from its mempool.
- @param
+ @param leveler A pointer to the tFeedbackLeveler to free.
@fn float tFeedbackLeveler_tick (tFeedbackLeveler* const, float input)
@brief
- @param
+ @param leveler A pointer to the relevant tFeedbackLeveler.
@fn float tFeedbackLeveler_sample (tFeedbackLeveler* const)
@brief
- @param
+ @param leveler A pointer to the relevant tFeedbackLeveler.
@fn void tFeedbackLeveler_setTargetLevel (tFeedbackLeveler* const, float TargetLevel)
@brief
- @param
+ @param leveler A pointer to the relevant tFeedbackLeveler.
@fn void tFeedbackLeveler_setFactor (tFeedbackLeveler* const, float factor)
@brief
- @param
+ @param leveler A pointer to the relevant tFeedbackLeveler.
@fn void tFeedbackLeveler_setMode (tFeedbackLeveler* const, int mode)
@brief
- @param 0 for upwards limiting only, 1 for biderctional limiting
+ @param leveler A pointer to the relevant tFeedbackLeveler.
+ @param mode 0 for upwards limiting only, 1 for biderctional limiting
@fn void tFeedbackLeveler_setStrength (tFeedbackLeveler* const, float strength)
@brief
- @param
+ @param leveler A pointer to the relevant tFeedbackLeveler.

@} */
@@ -163,30 +164,30 @@
@{
@fn void tThreshold_init (tThreshold* const, float low, float high, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tThreshold to the default mempool of a LEAF instance.
+ @param threshold A pointer to the tThreshold to initialize.
@param leaf A pointer to the leaf instance.
@fn void tThreshold_initToPool (tThreshold* const, float low, float high, tMempool* const)
- @brief
- @param
+ @brief Initialize a tThreshold to a specified mempool.
+ @param threshold A pointer to the tThreshold to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tThreshold_free (tThreshold* const)
@brief Free a tThreshold from its mempool.
- @param
+ @param threshold A pointer to the tThreshold to free.
@fn int tThreshold_tick (tThreshold* const, float input)
@brief
- @param
+ @param threshold A pointer to the relevant tThreshold.
@fn void tThreshold_setLow (tThreshold* const, float low)
@brief
- @param
+ @param threshold A pointer to the relevant tThreshold.
@fn void tThreshold_setHigh (tThreshold* const, float high)
@brief
- @param
+ @param threshold A pointer to the relevant tThreshold.
@} */
@@ -204,7 +205,7 @@
void tThreshold_initToPool (tThreshold* const, float low, float high, tMempool* const);
void tThreshold_free (tThreshold* const);
- int tThreshold_tick (tThreshold* const, float input);
+ int tThreshold_tick (tThreshold* const, float input);
void tThreshold_setLow (tThreshold* const, float low);
void tThreshold_setHigh (tThreshold* const, float high);
--- a/leaf/Inc/leaf-effects.h
+++ b/leaf/Inc/leaf-effects.h
@@ -31,62 +31,62 @@
@{
@fn void tTalkbox_init (tTalkbox* const, int bufsize, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tTalkbox to the default mempool of a LEAF instance.
+ @param talkbox A pointer to the tTalkbox to initialize.
@param leaf A pointer to the leaf instance.
@fn void tTalkbox_initToPool (tTalkbox* const, int bufsize, tMempool* const)
- @brief
- @param
+ @brief Initialize a tTalkbox to a specified mempool.
+ @param talkbox A pointer to the tTalkbox to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tTalkbox_free (tTalkbox* const)
@brief Free a tTalkbox from its mempool.
- @param
+ @param talkbox A pointer to the tTalkbox to free.
@fn float tTalkbox_tick (tTalkbox* const, float synth, float voice)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkbox.
@fn float tTalkbox_tickFrozen (tTalkbox* const voc, float synth, float voice)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkbox.
@fn void tTalkbox_update (tTalkbox* const)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkbox.
@fn void tTalkbox_suspend (tTalkbox* const)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkbox.
@fn void tTalkbox_lpcDurbin (float *r, int p, float *k, float *g)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkbox.
@fn void tTalkbox_lpc (float *buf, float *car, double* dl, double* Rt, int32_t n, int32_t o, float warp, int warpOn, float *k, int freeze, float *G)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkbox.
@fn void tTalkbox_setQuality (tTalkbox* const, float quality)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkbox.
@fn void tTalkbox_setWarpFactor (tTalkbox* const voc, float warp)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkbox.
@fn void tTalkbox_setWarpOn (tTalkbox* const voc, float warpOn)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkbox.
@fn void tTalkbox_setFreeze (tTalkbox* const voc, float freeze)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkbox.
@fn void tTalkbox_warpedAutocorrelate (float * x, double* dl, double* Rt, unsigned int L, float * R, unsigned int P, float lambda)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkbox.
@} */
@@ -150,62 +150,62 @@
@{
@fn void tTalkboxFloat_init (tTalkboxFloat* const, int bufsize, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tTalkboxFloat to the default mempool of a LEAF instance.
+ @param talkbox A pointer to the tTalkboxFloat to initialize.
@param leaf A pointer to the leaf instance.
@fn void tTalkboxFloat_initToPool (tTalkboxFloat* const, int bufsize, tMempool* const)
- @brief
- @param
+ @brief Initialize a tTalkboxFloat to a specified mempool.
+ @param talkbox A pointer to the tTalkboxFloat to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tTalkboxFloat_free (tTalkboxFloat* const)
@brief Free a tTalkboxFloat from its mempool.
- @param
+ @param talkbox A pointer to the tTalkboxFloat to free.
@fn float tTalkboxFloat_tick (tTalkboxFloat* const, float synth, float voice)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkboxFloat.
@fn float tTalkboxFloat_tickFrozen (tTalkboxFloat* const voc, float synth, float voice)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkboxFloat.
@fn void tTalkboxFloat_update (tTalkboxFloat* const)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkboxFloat.
@fn void tTalkboxFloat_suspend (tTalkboxFloat* const)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkboxFloat.
@fn void tTalkboxFloat_lpcDurbin (float *r, int p, float *k, float *g)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkboxFloat.
@fn void tTalkboxFloat_lpc (float *buf, float *car, float* dl, float* Rt, int32_t n, int32_t o, float warp, int warpOn, float *k, int freeze, float *G)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkboxFloat.
@fn void tTalkboxFloat_setQuality (tTalkboxFloat* const, float quality)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkboxFloat.
@fn void tTalkboxFloat_setWarpFactor (tTalkboxFloat* const voc, float warp)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkboxFloat.
@fn void tTalkboxFloat_setWarpOn (tTalkboxFloat* const voc, float warpOn)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkboxFloat.
@fn void tTalkboxFloat_setFreeze (tTalkboxFloat* const voc, float freeze)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkboxFloat.
@fn void tTalkboxFloat_warpedAutocorrelate (float * x, float* dl, float* Rt, unsigned int L, float * R, unsigned int P, float lambda)
@brief
- @param
+ @param talkbox A pointer to the relevant tTalkboxFloat.
@} */
@@ -264,30 +264,30 @@
@{
@fn void tVocoder_init (tVocoder* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tVocoder to the default mempool of a LEAF instance.
+ @param vocoder A pointer to the tVocoder to initialize.
@param leaf A pointer to the leaf instance.
@fn void tVocoder_initToPool (tVocoder* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tVocoder to a specified mempool.
+ @param vocoder A pointer to the tVocoder to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tVocoder_free (tVocoder* const)
@brief Free a tVocoder from its mempool.
- @param
+ @param vocoder A pointer to the tVocoder to free.
@fn float tVocoder_tick (tVocoder* const, float synth, float voice)
@brief
- @param
+ @param vocoder A pointer to the relevant tVocoder.
@fn void tVocoder_update (tVocoder* const)
@brief
- @param
+ @param vocoder A pointer to the relevant tVocoder.
@fn void tVocoder_suspend (tVocoder* const)
@brief
- @param
+ @param vocoder A pointer to the relevant tVocoder.
@} */
@@ -331,42 +331,42 @@
@{
@fn void tRosenbergGlottalPulse_init (tRosenbergGlottalPulse* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tRosenbergGlottalPulse to the default mempool of a LEAF instance.
+ @param pulse A pointer to the tRosenbergGlottalPulse to initialize.
@param leaf A pointer to the leaf instance.
@fn void tRosenbergGlottalPulse_initToPool (tRosenbergGlottalPulse* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tRosenbergGlottalPulse to a specified mempool.
+ @param pulse A pointer to the tRosenbergGlottalPulse to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tRosenbergGlottalPulse_free (tRosenbergGlottalPulse* const)
@brief Free a tRosenbergGlottalPulse from its mempool.
- @param
+ @param pulse A pointer to the tRosenbergGlottalPulse to free.
@fn float tRosenbergGlottalPulse_tick (tRosenbergGlottalPulse* const)
@brief
- @param
+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
@fn float tRosenbergGlottalPulse_tickHQ (tRosenbergGlottalPulse* const gp)
@brief
- @param
+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
@fn void tRosenbergGlottalPulse_setFreq (tRosenbergGlottalPulse* const, float freq)
@brief
- @param
+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
@fn void tRosenbergGlottalPulse_setOpenLength (tRosenbergGlottalPulse* const, float openLength)
@brief
- @param
+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
@fn void tRosenbergGlottalPulse_setPulseLength (tRosenbergGlottalPulse* const, float pulseLength)
@brief
- @param
+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
@fn void tRosenbergGlottalPulse_setOpenLengthAndPulseLength (tRosenbergGlottalPulse* const gp, float openLength, float pulseLength)
@brief
- @param
+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
@} */
@@ -405,38 +405,38 @@
@{
@fn void tSOLAD_init (tSOLAD* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tSOLAD to the default mempool of a LEAF instance.
+ @param solad A pointer to the tSOLAD to initialize.
@param leaf A pointer to the leaf instance.
@fn void tSOLAD_initToPool (tSOLAD* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tSOLAD to a specified mempool.
+ @param solad A pointer to the tSOLAD to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tSOLAD_free (tSOLAD* const)
@brief Free a tSOLAD from its mempool.
- @param
+ @param solad A pointer to the tSOLAD to free.
@fn void tSOLAD_ioSamples (tSOLAD *w, float* in, float* out, int blocksize)
- @brief send one block of input samples, receive one block of output samples
- @param
+ @brief Send one block of input samples, receive one block of output samples
+ @param solad A pointer to the relevant tSOLAD.
@fn void tSOLAD_setPeriod (tSOLAD *w, float period)
- @brief set periodicity analysis data
- @param
+ @brief Set periodicity analysis data
+ @param solad A pointer to the relevant tSOLAD.
@fn void tSOLAD_setPitchFactor (tSOLAD *w, float pitchfactor)
- @brief set pitch factor between 0.25 and 4
- @param
+ @brief Set pitch factor between 0.25 and 4
+ @param solad A pointer to the relevant tSOLAD.
@fn void tSOLAD_setReadLag (tSOLAD *w, float readlag)
- @brief force readpointer lag
- @param
+ @brief Force readpointer lag
+ @param solad A pointer to the relevant tSOLAD.
@fn void tSOLAD_resetState (tSOLAD *w)
- @brief reset state variables
- @param
+ @brief Reset state variables
+ @param solad A pointer to the relevant tSOLAD.
@} */
@@ -492,34 +492,34 @@
@{
@fn void tPitchShift_init (tPitchShift* const, tPeriodDetection* const, float* out, int bufSize, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tPitchShift to the default mempool of a LEAF instance.
+ @param pitchshift A pointer to the tPitchShift to initialize.
@param leaf A pointer to the leaf instance.
@fn void tPitchShift_initToPool (tPitchShift* const, tPeriodDetection* const, float* out, int bufSize, tMempool* const)
- @brief
- @param
+ @brief Initialize a tPitchShift to a specified mempool.
+ @param pitchshift A pointer to the tPitchShift to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tPitchShift_free (tPitchShift* const)
@brief Free a tPitchShift from its mempool.
- @param
+ @param pitchshift A pointer to the tPitchShift to free.
@fn float tPitchShift_shift (tPitchShift* const)
@brief
- @param
+ @param pitchshift A pointer to the relevant tPitchShift.
@fn float tPitchShift_shiftToFunc (tPitchShift* const, float (*fun)(float))
@brief
- @param
+ @param pitchshift A pointer to the relevant tPitchShift.
@fn float tPitchShift_shiftToFreq (tPitchShift* const, float freq)
@brief
- @param
+ @param pitchshift A pointer to the relevant tPitchShift.
@fn void tPitchShift_setPitchFactor (tPitchShift* const, float pf)
@brief
- @param
+ @param pitchshift A pointer to the relevant tPitchShift.
@} */
@@ -556,34 +556,34 @@
@{
@fn void tSimpleRetune_init (tSimpleRetune* const, int numVoices, int bufSize, int frameSize, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tSimpleRetune to the default mempool of a LEAF instance.
+ @param retune A pointer to the tSimpleRetune to initialize.
@param leaf A pointer to the leaf instance.
@fn void tSimpleRetune_initToPool (tSimpleRetune* const, int numVoices, int bufSize, int frameSize, tMempool* const)
- @brief
- @param
+ @brief Initialize a tSimpleRetune to a specified mempool.
+ @param retune A pointer to the tSimpleRetune to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tSimpleRetune_free (tSimpleRetune* const)
@brief Free a tSimpleRetune from its mempool.
- @param
+ @param retune A pointer to the tSimpleRetune to free.
@fn float* tSimpleRetune_tick (tSimpleRetune* const, float sample)
@brief
- @param
+ @param retune A pointer to the relevant tSimpleRetune.
@fn void tSimpleRetune_setNumVoices (tSimpleRetune* const, int numVoices)
@brief
- @param
+ @param retune A pointer to the relevant tSimpleRetune.
@fn void tSimpleRetune_tuneVoices (tSimpleRetune* const, float f)
@brief
- @param
+ @param retune A pointer to the relevant tSimpleRetune.
@fn void tSimpleRetune_tuneVoice (tSimpleRetune* const, float f, int voice)
@brief
- @param
+ @param retune A pointer to the relevant tSimpleRetune.
@} */
@@ -628,34 +628,34 @@
@{
@fn void tRetune_init (tRetune* const, int numVoices, int bufSize, int frameSize, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tRetune to the default mempool of a LEAF instance.
+ @param retune A pointer to the tRetune to initialize.
@param leaf A pointer to the leaf instance.
@fn void tRetune_initToPool (tRetune* const, int numVoices, int bufSize, int frameSize, tMempool* const)
- @brief
- @param
+ @brief Initialize a tRetune to a specified mempool.
+ @param retune A pointer to the tRetune to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tRetune_free (tRetune* const)
@brief Free a tRetune from its mempool.
- @param
+ @param retune A pointer to the tRetune to free.
@fn float* tRetune_tick (tRetune* const, float sample)
@brief
- @param
+ @param retune A pointer to the relevant tRetune.
@fn void tRetune_setNumVoices (tRetune* const, int numVoices)
@brief
- @param
+ @param retune A pointer to the relevant tRetune.
@fn void tRetune_setPitchFactors (tRetune* const, float pf)
@brief
- @param
+ @param retune A pointer to the relevant tRetune.
@fn void tRetune_setPitchFactor (tRetune* const, float pf, int voice)
@brief
- @param
+ @param retune A pointer to the relevant tRetune.
@} */
@@ -705,42 +705,42 @@
@{
@fn void tFormantShifter_init (tFormantShifter* const, int order, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tFormantShifter to the default mempool of a LEAF instance.
+ @param formant A pointer to the tFormantShifter to initialize.
@param leaf A pointer to the leaf instance.
@fn void tFormantShifter_initToPool (tFormantShifter* const, int order, tMempool* const)
- @brief
- @param
+ @brief Initialize a tFormantShifter to a specified mempool.
+ @param formant A pointer to the tFormantShifter to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tFormantShifter_free (tFormantShifter* const)
@brief Free a tFormantShifter from its mempool.
- @param
+ @param formant A pointer to the tFormantShifter to free.
@fn float tFormantShifter_tick (tFormantShifter* const, float input)
@brief
- @param
+ @param formant A pointer to the relevant tFormantShifter.
@fn float tFormantShifter_remove (tFormantShifter* const, float input)
@brief
- @param
+ @param formant A pointer to the relevant tFormantShifter.
@fn float tFormantShifter_add (tFormantShifter* const, float input)
@brief
- @param
+ @param formant A pointer to the relevant tFormantShifter.
@fn void tFormantShifter_ioSamples (tFormantShifter* const, float* in, float* out, int size, float fwarp)
@brief
- @param
+ @param formant A pointer to the relevant tFormantShifter.
@fn void tFormantShifter_setShiftFactor (tFormantShifter* const, float shiftFactor)
@brief
- @param
+ @param formant A pointer to the relevant tFormantShifter.
@fn void tFormantShifter_setIntensity (tFormantShifter* const, float intensity)
@brief
- @param
+ @param formant A pointer to the relevant tFormantShifter.
@} */
--- a/leaf/Inc/leaf-electrical.h
+++ b/leaf/Inc/leaf-electrical.h
@@ -35,59 +35,59 @@
@{@fn void tWDF_init (tWDF* const, WDFComponentType type, float value, tWDF* const rL, tWDF* const rR, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tWDF to the default mempool of a LEAF instance.
+ @param wdf A pointer to the tWDF to initialize.
@param leaf A pointer to the leaf instance.
@fn void tWDF_initToPool (tWDF* const, WDFComponentType type, float value, tWDF* const rL, tWDF* const rR, tMempool* const)
- @brief
- @param
+ @brief Initialize a tWDF to a specified mempool.
+ @param wdf A pointer to the tWDF to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tWDF_free (tWDF* const)
@brief Free a tWDF from its mempool.
- @param
+ @param wdf A pointer to the tWDF to free.
@fn float tWDF_tick (tWDF* const, float sample, tWDF* const outputPoint, uint8_t paramsChanged)
@brief
- @param
+ @param wdf A pointer to the relevant tWDF.
@fn void tWDF_setValue (tWDF* const, float value)
@brief
- @param
+ @param wdf A pointer to the relevant tWDF.
@fn void tWDF_setSampleRate (tWDF* const, float sample_rate)
@brief
- @param
+ @param wdf A pointer to the relevant tWDF.
@fn uint8_t tWDF_isLeaf (tWDF* const)
@brief
- @param
+ @param wdf A pointer to the relevant tWDF.
@fn float tWDF_getPortResistance (tWDF* const)
@brief
- @param
+ @param wdf A pointer to the relevant tWDF.
@fn float tWDF_getReflectedWaveUp (tWDF* const, float input)
@brief
- @param
+ @param wdf A pointer to the relevant tWDF.
@fn float tWDF_getReflectedWaveDown (tWDF* const, float input, float incident_wave)
@brief
- @param
+ @param wdf A pointer to the relevant tWDF.
@fn void tWDF_setIncidentWave (tWDF* const, float incident_wave, float input)
@brief
- @param
+ @param wdf A pointer to the relevant tWDF.
@fn float tWDF_getVoltage (tWDF* const)
@brief
- @param
+ @param wdf A pointer to the relevant tWDF.
@fn float tWDF_getCurrent (tWDF* const)
@brief
- @param
-
+ @param wdf A pointer to the relevant tWDF.
+
@} */
typedef enum WDFComponentType
--- a/leaf/Inc/leaf-envelopes.h
+++ b/leaf/Inc/leaf-envelopes.h
@@ -41,38 +41,38 @@
@{
@fn void tEnvelope_init (tEnvelope* const, float attack, float decay, int loop, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tEnvelope to the default mempool of a LEAF instance.
+ @param envelope A pointer to the tEnvelope to initialize.
@param leaf A pointer to the leaf instance.
@fn void tEnvelope_initToPool (tEnvelope* const, float attack, float decay, int loop, tMempool* const)
- @brief
- @param
+ @brief Initialize a tEnvelope to a specified mempool.
+ @param envelope A pointer to the tEnvelope to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tEnvelope_free (tEnvelope* const)
@brief Free a tEnvelope from its mempool.
- @param
+ @param envelope A pointer to the tEnvelope to free.
@fn float tEnvelope_tick (tEnvelope* const)
@brief
- @param
+ @param envelope A pointer to the relevant tEnvelope.
@fn void tEnvelope_setAttack (tEnvelope* const, float attack)
@brief
- @param
+ @param envelope A pointer to the relevant tEnvelope.
@fn void tEnvelope_setDecay (tEnvelope* const, float decay)
@brief
- @param
+ @param envelope A pointer to the relevant tEnvelope.
@fn void tEnvelope_loop (tEnvelope* const, int loop)
@brief
- @param
+ @param envelope A pointer to the relevant tEnvelope.
@fn void tEnvelope_on (tEnvelope* const, float velocity)
@brief
- @param
+ @param envelope A pointer to the relevant tEnvelope.
@} */
@@ -121,42 +121,42 @@
@{
@fn void tExpSmooth_init (tExpSmooth* const, float val, float factor, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tExpSmooth to the default mempool of a LEAF instance.
+ @param smooth A pointer to the tExpSmooth to initialize.
@param leaf A pointer to the leaf instance.
@fn void tExpSmooth_initToPool (tExpSmooth* const, float val, float factor, tMempool* const)
- @brief
- @param
+ @brief Initialize a tExpSmooth to a specified mempool.
+ @param smooth A pointer to the tExpSmooth to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tExpSmooth_free (tExpSmooth* const)
@brief Free a tExpSmooth from its mempool.
- @param
+ @param smooth A pointer to the tExpSmooth to free.
@fn float tExpSmooth_tick (tExpSmooth* const)
@brief
- @param
+ @param smooth A pointer to the relevant tExpSmooth.
@fn float tExpSmooth_sample (tExpSmooth* const)
@brief
- @param
+ @param smooth A pointer to the relevant tExpSmooth.
@fn void tExpSmooth_setFactor (tExpSmooth* const, float factor)
@brief
- @param
+ @param smooth A pointer to the relevant tExpSmooth.
@fn void tExpSmooth_setDest (tExpSmooth* const, float dest)
@brief
- @param
+ @param smooth A pointer to the relevant tExpSmooth.
@fn void tExpSmooth_setVal (tExpSmooth* const, float val)
@brief
- @param
+ @param smooth A pointer to the relevant tExpSmooth.
@fn void tExpSmooth_setValAndDest(tExpSmooth* const expsmooth, float val)
@brief
- @param
+ @param smooth A pointer to the relevant tExpSmooth.
@} */
@@ -193,50 +193,50 @@
@{
@fn void tADSR_init (tADSR* const adsrenv, float attack, float decay, float sustain, float release, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tADSR to the default mempool of a LEAF instance.
+ @param adsr A pointer to the tADSR to initialize.
@param leaf A pointer to the leaf instance.
@fn void tADSR_initToPool (tADSR* const adsrenv, float attack, float decay, float sustain, float release, tMempool* const mp)
- @brief
- @param
+ @brief Initialize a tADSR to a specified mempool.
+ @param adsr A pointer to the tADSR to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tADSR_free (tADSR* const)
@brief Free a tADSR from its mempool.
- @param
+ @param adsr A pointer to the tADSR to free.
@fn float tADSR_tick (tADSR* const)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR.
@fn void tADSR_setAttack (tADSR* const, float attack)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR.
@fn void tADSR_setDecay (tADSR* const, float decay)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR.
@fn void tADSR_setSustain (tADSR* const, float sustain)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR.
@fn void tADSR_setRelease (tADSR* const, float release)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR.
@fn void tADSR_setLeakFactor (tADSR* const, float leakFactor)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR.
@fn void tADSR_on (tADSR* const, float velocity)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR.
@fn void tADSR_off (tADSR* const)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR.
@} */
@@ -287,50 +287,50 @@
@{
@fn void tADSR2_init (tADSR2* const, float attack, float decay, float sustain, float release, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tADSR2 to the default mempool of a LEAF instance.
+ @param adsr A pointer to the tADSR2 to initialize.
@param leaf A pointer to the leaf instance.
@fn void tADSR2_initToPool (tADSR2* const, float attack, float decay, float sustain, float release, tMempool* const)
- @brief
- @param
+ @brief Initialize a tADSR2 to a specified mempool.
+ @param adsr A pointer to the tADSR2 to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tADSR2_free (tADSR2* const)
@brief Free a tADSR2 from its mempool.
- @param
+ @param adsr A pointer to the tADSR2 to free.
@fn float tADSR2_tick (tADSR2* const)
@brief
- @param
-
+ @param adsr A pointer to the relevant tADSR2.
+
@fn void tADSR2_setAttack (tADSR2* const, float attack)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR2.
@fn void tADSR2_setDecay (tADSR2* const, float decay)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR2.
@fn void tADSR2_setSustain (tADSR2* const, float sustain)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR2.
@fn void tADSR2_setRelease (tADSR2* const, float release)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR2.
@fn void tADSR2_setLeakFactor (tADSR2* const, float leakFactor)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR2.
@fn void tADSR2_on (tADSR2* const, float velocity)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR2.
@fn void tADSR2_off (tADSR2* const)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR2.
@} */
@@ -383,50 +383,50 @@
@{
@fn void tADSR3_init (tADSR3* const, float attack, float decay, float sustain, float release, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tADSR3 to the default mempool of a LEAF instance.
+ @param adsr A pointer to the tADSR3 to initialize.
@param leaf A pointer to the leaf instance.
@fn void tADSR3_initToPool (tADSR3* const, float attack, float decay, float sustain, float release, tMempool* const)
- @brief
- @param
+ @brief Initialize a tADSR3 to a specified mempool.
+ @param adsr A pointer to the tADSR3 to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tADSR3_free (tADSR3* const)
@brief Free a tADSR3 from its mempool.
- @param
+ @param adsr A pointer to the tADSR3 to free.
@fn float tADSR3_tick (tADSR3* const)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR3.
@fn void tADSR3_setAttack (tADSR3* const, float attack)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR3.
@fn void tADSR3_setDecay (tADSR3* const, float decay)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR3.
@fn void tADSR3_setSustain (tADSR3* const, float sustain)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR3.
@fn void tADSR3_setRelease (tADSR3* const, float release)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR3.
@fn void tADSR3_setLeakFactor (tADSR3* const, float leakFactor)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR3.
@fn void tADSR3_on (tADSR3* const, float velocity)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR3.
@fn void tADSR3_off (tADSR3* const)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR3.
@} */
@@ -490,54 +490,54 @@
@{
@fn void tADSR4_init (tADSR4* const, float attack, float decay, float sustain, float release, float* expBuffer, int bufferSize, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tADSR4 to the default mempool of a LEAF instance.
+ @param adsr A pointer to the tADSR4 to initialize.
@param leaf A pointer to the leaf instance.
@fn void tADSR4_initToPool (tADSR4* const, float attack, float decay, float sustain, float release, float* expBuffer, int bufferSize, tMempool* const)
- @brief
- @param
+ @brief Initialize a tADSR4 to a specified mempool.
+ @param adsr A pointer to the tADSR4 to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tADSR4_free (tADSR4* const)
@brief Free a tADSR4 from its mempool.
- @param
+ @param adsr A pointer to the tADSR4 to free.
@fn float tADSR4_tick (tADSR4* const)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR4.
@fn float tADSR4_tickNoInterp (tADSR4* const adsrenv)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR4.
@fn void tADSR4_setAttack (tADSR4* const, float attack)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR4.
@fn void tADSR4_setDecay (tADSR4* const, float decay)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR4.
@fn void tADSR4_setSustain (tADSR4* const, float sustain)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR4.
@fn void tADSR4_setRelease (tADSR4* const, float release)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR4.
@fn void tADSR4_setLeakFactor (tADSR4* const, float leakFactor)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR4.
@fn void tADSR4_on (tADSR4* const, float velocity)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR4.
@fn void tADSR4_off (tADSR4* const)
@brief
- @param
+ @param adsr A pointer to the relevant tADSR4.
@} */
@@ -587,38 +587,38 @@
@{
@fn void tRamp_init (tRamp* const, float time, int samplesPerTick, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tRamp to the default mempool of a LEAF instance.
+ @param ramp A pointer to the tRamp to initialize.
@param leaf A pointer to the leaf instance.
@fn void tRamp_initToPool (tRamp* const, float time, int samplesPerTick, tMempool* const)
- @brief
- @param
+ @brief Initialize a tRamp to a specified mempool.
+ @param ramp A pointer to the tRamp to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tRamp_free (tRamp* const)
@brief Free a tRamp from its mempool.
- @param
+ @param ramp A pointer to the tRamp to free.
@fn float tRamp_tick (tRamp* const)
@brief
- @param
+ @param ramp A pointer to the relevant tRamp.
@fn float tRamp_sample (tRamp* const)
@brief
- @param
+ @param ramp A pointer to the relevant tRamp.
@fn void tRamp_setTime (tRamp* const, float time)
@brief
- @param
+ @param ramp A pointer to the relevant tRamp.
@fn void tRamp_setDest (tRamp* const, float dest)
@brief
- @param
+ @param ramp A pointer to the relevant tRamp.
@fn void tRamp_setVal (tRamp* const, float val)
@brief
- @param
+ @param ramp A pointer to the relevant tRamp.
@} */
@@ -654,42 +654,42 @@
@{
@fn void tRampUpDown_init (tRampUpDown* const, float upTime, float downTime, int samplesPerTick, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tRampUpDown to the default mempool of a LEAF instance.
+ @param ramp A pointer to the tRampUpDown to initialize.
@param leaf A pointer to the leaf instance.
@fn void tRampUpDown_initToPool (tRampUpDown* const, float upTime, float downTime, int samplesPerTick, tMempool* const)
- @brief
- @param
+ @brief Initialize a tRampUpDown to a specified mempool.
+ @param ramp A pointer to the tRampUpDown to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tRampUpDown_free (tRampUpDown* const)
@brief Free a tRampUpDown from its mempool.
- @param
+ @param ramp A pointer to the tRampUpDown to free.
@fn float tRampUpDown_tick (tRampUpDown* const)
@brief
- @param
+ @param ramp A pointer to the relevant tRampUpDown.
@fn float tRampUpDown_sample (tRampUpDown* const)
@brief
- @param
+ @param ramp A pointer to the relevant tRampUpDown.
@fn void tRampUpDown_setUpTime (tRampUpDown* const, float upTime)
@brief
- @param
+ @param ramp A pointer to the relevant tRampUpDown.
@fn void tRampUpDown_setDownTime (tRampUpDown* const, float downTime)
@brief
- @param
+ @param ramp A pointer to the relevant tRampUpDown.
@fn void tRampUpDown_setDest (tRampUpDown* const, float dest)
@brief
- @param
+ @param ramp A pointer to the relevant tRampUpDown.
@fn void tRampUpDown_setVal (tRampUpDown* const, float val)
@brief
- @param
+ @param ramp A pointer to the relevant tRampUpDown.
@} */
@@ -729,38 +729,38 @@
@{
@fn void tSlide_init (tSlide* const, float upSlide, float downSlide, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tSlide to the default mempool of a LEAF instance.
+ @param slide A pointer to the tSlide to initialize.
@param leaf A pointer to the leaf instance.
@fn void tSlide_initToPool (tSlide* const, float upSlide, float downSlide, tMempool* const)
- @brief
- @param
+ @brief Initialize a tSlide to a specified mempool.
+ @param slide A pointer to the tSlide to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tSlide_free (tSlide* const)
@brief Free a tSlide from its mempool.
- @param
+ @param slide A pointer to the tSlide to free.
@fn float tSlide_tick (tSlide* const, float in)
@brief
- @param
+ @param slide A pointer to the relevant tSlide.
@fn float tSlide_tickNoInput (tSlide* const sl)
@brief
- @param
+ @param slide A pointer to the relevant tSlide.
@fn void tSlide_setUpSlide (tSlide* const sl, float upSlide)
@brief
- @param
+ @param slide A pointer to the relevant tSlide.
@fn void tSlide_setDownSlide (tSlide* const sl, float downSlide)
@brief
- @param
+ @param slide A pointer to the relevant tSlide.
@fn void tSlide_setDest (tSlide* const sl, float dest)
@brief
- @param
+ @param slide A pointer to the relevant tSlide.
@} */
--- a/leaf/Inc/leaf-filters.h
+++ b/leaf/Inc/leaf-filters.h
@@ -37,30 +37,30 @@
@{
@fn void tAllpass_init (tAllpass* const, float initDelay, uint32_t maxDelay, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tAllpass to the default mempool of a LEAF instance.
+ @param filter A pointer to the tAllpass to initialize.
@param leaf A pointer to the leaf instance.
@fn void tAllpass_initToPool (tAllpass* const, float initDelay, uint32_t maxDelay, tMempool* const)
- @brief
- @param
+ @brief Initialize a tAllpass to a specified mempool.
+ @param filter A pointer to the tAllpass to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tAllpass_free (tAllpass* const)
@brief Free a tAllpass from its mempool.
- @param
+ @param filter A pointer to the tAllpass to free.
@fn float tAllpass_tick (tAllpass* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tAllpass.
@fn void tAllpass_setGain (tAllpass* const, float gain)
@brief
- @param
+ @param filter A pointer to the relevant tAllpass.
@fn void tAllpass_setDelay (tAllpass* const, float delay)
@brief
- @param
+ @param filter A pointer to the relevant tAllpass.

@} */
@@ -96,46 +96,46 @@
@{
@fn void tOnePole_init (tOnePole* const, float thePole, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tOnePole to the default mempool of a LEAF instance.
+ @param filter A pointer to the tOnePole to initialize.
@param leaf A pointer to the leaf instance.
@fn void tOnePole_initToPool (tOnePole* const, float thePole, tMempool* const)
- @brief
- @param
+ @brief Initialize a tOnePole to a specified mempool.
+ @param filter A pointer to the tOnePole to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tOnePole_free (tOnePole* const)
@brief Free a tOnePole from its mempool.
- @param
+ @param filter A pointer to the tOnePole to free.
@fn float tOnePole_tick (tOnePole* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tOnePole.
@fn void tOnePole_setB0 (tOnePole* const, float b0)
@brief
- @param
+ @param filter A pointer to the relevant tOnePole.
@fn void tOnePole_setA1 (tOnePole* const, float a1)
@brief
- @param
+ @param filter A pointer to the relevant tOnePole.
@fn void tOnePole_setPole (tOnePole* const, float thePole)
@brief
- @param
+ @param filter A pointer to the relevant tOnePole.
@fn void tOnePole_setFreq (tOnePole* const, float freq)
@brief
- @param
+ @param filter A pointer to the relevant tOnePole.
@fn void tOnePole_setCoefficients(tOnePole* const, float b0, float a1)
@brief
- @param
+ @param filter A pointer to the relevant tOnePole.
@fn void tOnePole_setGain (tOnePole* const, float gain)
@brief
- @param
+ @param filter A pointer to the relevant tOnePole.

@} */
@@ -172,46 +172,46 @@
@{
@fn void tTwoPole_init (tTwoPole* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tTwoPole to the default mempool of a LEAF instance.
+ @param filter A pointer to the tTwoPole to initialize.
@param leaf A pointer to the leaf instance.
@fn void tTwoPole_initToPool (tTwoPole* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tTwoPole to a specified mempool.
+ @param filter A pointer to the tTwoPole to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tTwoPole_free (tTwoPole* const)
@brief Free a tTwoPole from its mempool.
- @param
+ @param filter A pointer to the tTwoPole to free.
@fn float tTwoPole_tick (tTwoPole* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tTwoPole.
@fn void tTwoPole_setB0 (tTwoPole* const, float b0)
@brief
- @param
+ @param filter A pointer to the relevant tTwoPole.
@fn void tTwoPole_setA1 (tTwoPole* const, float a1)
@brief
- @param
+ @param filter A pointer to the relevant tTwoPole.
@fn void tTwoPole_setA2 (tTwoPole* const, float a2)
@brief
- @param
+ @param filter A pointer to the relevant tTwoPole.
@fn void tTwoPole_setResonance (tTwoPole* const, float freq, float radius, int normalize)
@brief
- @param
+ @param filter A pointer to the relevant tTwoPole.
@fn void tTwoPole_setCoefficients(tTwoPole* const, float b0, float a1, float a2)
@brief
- @param
+ @param filter A pointer to the relevant tTwoPole.
@fn void tTwoPole_setGain (tTwoPole* const, float gain)
@brief
- @param
+ @param filter A pointer to the relevant tTwoPole.

@} */
@@ -253,46 +253,46 @@
@{
@fn void tOneZero_init (tOneZero* const, float theZero, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tOneZero to the default mempool of a LEAF instance.
+ @param filter A pointer to the tSlide to initialize.
@param leaf A pointer to the leaf instance.
@fn void tOneZero_initToPool (tOneZero* const, float theZero, tMempool* const)
- @brief
- @param
+ @brief Initialize a tOneZero to a specified mempool.
+ @param filter A pointer to the tOneZero to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tOneZero_free (tOneZero* const)
@brief Free a tOneZero from its mempool.
- @param
+ @param filter A pointer to the tOneZero to free.
@fn float tOneZero_tick (tOneZero* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tOneZero.
@fn void tOneZero_setB0 (tOneZero* const, float b0)
@brief
- @param
+ @param filter A pointer to the relevant tOneZero.
@fn void tOneZero_setB1 (tOneZero* const, float b1)
@brief
- @param
+ @param filter A pointer to the relevant tOneZero.
@fn void tOneZero_setZero (tOneZero* const, float theZero)
@brief
- @param
+ @param filter A pointer to the relevant tOneZero.
@fn void tOneZero_setCoefficients(tOneZero* const, float b0, float b1)
@brief
- @param
+ @param filter A pointer to the relevant tOneZero.
@fn void tOneZero_setGain (tOneZero* const, float gain)
@brief
- @param
+ @param filter A pointer to the relevant tOneZero.
@fn float tOneZero_getPhaseDelay (tOneZero *f, float frequency)
@brief
- @param
+ @param filter A pointer to the relevant tOneZero.

@} */
@@ -328,46 +328,46 @@
@{
@fn void tTwoZero_init (tTwoZero* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tTwoZero to the default mempool of a LEAF instance.
+ @param filter A pointer to the tTwoZero to initialize.
@param leaf A pointer to the leaf instance.
@fn void tTwoZero_initToPool (tTwoZero* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tTwoZero to a specified mempool.
+ @param filter A pointer to the tTwoZero to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tTwoZero_free (tTwoZero* const)
@brief Free a tTwoZero from its mempool.
- @param
+ @param filter A pointer to the tTwoZero to free.
@fn float tTwoZero_tick (tTwoZero* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tTwoZero.
@fn void tTwoZero_setB0 (tTwoZero* const, float b0)
@brief
- @param
+ @param filter A pointer to the relevant tTwoZero.
@fn void tTwoZero_setB1 (tTwoZero* const, float b1)
@brief
- @param
+ @param filter A pointer to the relevant tTwoZero.
@fn void tTwoZero_setB2 (tTwoZero* const, float b2)
@brief
- @param
+ @param filter A pointer to the relevant tTwoZero.
@fn void tTwoZero_setNotch (tTwoZero* const, float frequency, float radius)
@brief
- @param
+ @param filter A pointer to the relevant tTwoZero.
@fn void tTwoZero_setCoefficients(tTwoZero* const, float b0, float b1, float b2)
@brief
- @param
+ @param filter A pointer to the relevant tTwoZero.
@fn void tTwoZero_setGain (tTwoZero* const, float gain)
@brief
- @param
+ @param filter A pointer to the relevant tTwoZero.

@} */
@@ -408,51 +408,51 @@
@{
@fn void tPoleZero_init (tPoleZero* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tPoleZero to the default mempool of a LEAF instance.
+ @param filter A pointer to the tPoleZero to initialize.
@param leaf A pointer to the leaf instance.
@fn void tPoleZero_initToPool (tPoleZero* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tPoleZero to a specified mempool.
+ @param filter A pointer to the tPoleZero to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tPoleZero_free (tPoleZero* const)
@brief Free a tPoleZero from its mempool.
- @param
+ @param filter A pointer to the tPoleZero to free.
@fn float tPoleZero_tick (tPoleZero* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tPoleZero.
@fn void tPoleZero_setB0 (tPoleZero* const, float b0)
@brief
- @param
+ @param filter A pointer to the relevant tPoleZero.
@fn void tPoleZero_setB1 (tPoleZero* const, float b1)
@brief
- @param
+ @param filter A pointer to the relevant tPoleZero.
@fn void tPoleZero_setA1 (tPoleZero* const, float a1)
@brief
- @param
+ @param filter A pointer to the relevant tPoleZero.
@fn void tPoleZero_setCoefficients (tPoleZero* const, float b0, float b1, float a1)
@brief
- @param
+ @param filter A pointer to the relevant tPoleZero.
@fn void tPoleZero_setAllpass (tPoleZero* const, float coeff)
@brief
- @param
+ @param filter A pointer to the relevant tPoleZero.
@fn void tPoleZero_setBlockZero (tPoleZero* const, float thePole)
@brief
- @param
+ @param filter A pointer to the relevant tPoleZero.
@fn void tPoleZero_setGain (tPoleZero* const, float gain)
@brief
- @param
+ @param filter A pointer to the relevant tPoleZero.

@} */
@@ -493,59 +493,59 @@
@{
@fn void tBiQuad_init (tBiQuad* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tBiQuad to the default mempool of a LEAF instance.
+ @param filter A pointer to the tBiQuad to initialize.
@param leaf A pointer to the leaf instance.
@fn void tBiQuad_initToPool (tBiQuad* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tBiQuad to a specified mempool.
+ @param filter A pointer to the tBiQuad to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tBiQuad_free (tBiQuad* const)
@brief Free a tBiQuad from its mempool.
- @param
+ @param filter A pointer to the tBiQuad to free.
@fn float tBiQuad_tick (tBiQuad* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tBiQuad.
@fn void tBiQuad_setB0 (tBiQuad* const, float b0)
@brief
- @param
+ @param filter A pointer to the relevant tBiQuad.
@fn void tBiQuad_setB1 (tBiQuad* const, float b1)
@brief
- @param
+ @param filter A pointer to the relevant tBiQuad.
@fn void tBiQuad_setB2 (tBiQuad* const, float b2)
@brief
- @param
+ @param filter A pointer to the relevant tBiQuad.
@fn void tBiQuad_setA1 (tBiQuad* const, float a1)
@brief
- @param
+ @param filter A pointer to the relevant tBiQuad.
@fn void tBiQuad_setA2 (tBiQuad* const, float a2)
@brief
- @param
+ @param filter A pointer to the relevant tBiQuad.
@fn void tBiQuad_setNotch (tBiQuad* const, float freq, float radius)
@brief
- @param
+ @param filter A pointer to the relevant tBiQuad.
@fn void tBiQuad_setResonance (tBiQuad* const, float freq, float radius, int normalize)
@brief
- @param
+ @param filter A pointer to the relevant tBiQuad.
@fn void tBiQuad_setCoefficients(tBiQuad* const, float b0, float b1, float b2, float a1, float a2)
@brief
- @param
+ @param filter A pointer to the relevant tBiQuad.
@fn void tBiQuad_setGain (tBiQuad* const, float gain)
@brief
- @param
+ @param filter A pointer to the relevant tBiQuad.

@} */
@@ -592,34 +592,34 @@
@{
@fn void tSVF_init (tSVF* const, SVFType type, float freq, float Q, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tSVF to the default mempool of a LEAF instance.
+ @param filter A pointer to the tSVF to initialize.
@param leaf A pointer to the leaf instance.
@fn void tSVF_initToPool (tSVF* const, SVFType type, float freq, float Q, tMempool* const)
- @brief
- @param
+ @brief Initialize a tSVF to a specified mempool.
+ @param filter A pointer to the tSVF to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tSVF_free (tSVF* const)
@brief Free a tSVF from its mempool.
- @param
+ @param filter A pointer to the tSVF to free.
@fn float tSVF_tick (tSVF* const, float v0)
-
@brief
- @param
+ @param filter A pointer to the relevant tSVF.
+
@fn void tSVF_setFreq (tSVF* const, float freq)
@brief
- @param
+ @param filter A pointer to the relevant tSVF.
@fn void tSVF_setQ (tSVF* const, float Q)
@brief
- @param
+ @param filter A pointer to the relevant tSVF.
@fn void tSVF_setFreqAndQ (tSVF* const svff, float freq, float Q)
@brief
- @param
+ @param filter A pointer to the relevant tSVF.

@} */
@@ -664,30 +664,30 @@
@{
@fn void tEfficientSVF_init (tEfficientSVF* const, SVFType type, uint16_t input, float Q, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tEfficientSVF to the default mempool of a LEAF instance.
+ @param filter A pointer to the tEfficientSVF to initialize.
@param leaf A pointer to the leaf instance.
@fn void tEfficientSVF_initToPool (tEfficientSVF* const, SVFType type, uint16_t input, float Q, tMempool* const)
- @brief
- @param
+ @brief Initialize a tEfficientSVF to a specified mempool.
+ @param filter A pointer to the tEfficientSVF to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tEfficientSVF_free (tEfficientSVF* const)
@brief Free a tEfficientSVF from its mempool.
- @param
+ @param filter A pointer to the tEfficientSVF to free.
@fn float tEfficientSVF_tick (tEfficientSVF* const, float v0)
@brief
- @param
+ @param filter A pointer to the relevant tEfficientSVF.
@fn void tEfficientSVF_setFreq (tEfficientSVF* const, uint16_t controlFreq)
@brief
- @param
+ @param filter A pointer to the relevant tEfficientSVF.
@fn void tEfficientSVF_setQ (tEfficientSVF* const, float Q)
@brief
- @param
+ @param filter A pointer to the relevant tEfficientSVF.

@} */
@@ -720,30 +720,30 @@
@{
@fn void tHighpass_init (tHighpass* const, float freq, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tHighpass to the default mempool of a LEAF instance.
+ @param filter A pointer to the tHighpass to initialize.
@param leaf A pointer to the leaf instance.
@fn void tHighpass_initToPool (tHighpass* const, float freq, tMempool* const)
- @brief
- @param
+ @brief Initialize a tHighpass to a specified mempool.
+ @param filter A pointer to the tHighpass to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tHighpass_free (tHighpass* const)
@brief Free a tHighpass from its mempool.
- @param
+ @param filter A pointer to the tHighpass to free.
@fn float tHighpass_tick (tHighpass* const, float x)
@brief
- @param
+ @param filter A pointer to the relevant tHighpass.
@fn void tHighpass_setFreq (tHighpass* const, float freq)
@brief
- @param
+ @param filter A pointer to the relevant tHighpass.
@fn float tHighpass_getFreq (tHighpass* const)
@brief
- @param
+ @param filter A pointer to the relevant tHighpass.

@} */
@@ -774,34 +774,34 @@
@{
@fn void tButterworth_init (tButterworth* const, int N, float f1, float f2, LEAF* const leaf, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tButterworth to the default mempool of a LEAF instance.
+ @param filter A pointer to the tButterworth to initialize.
@param leaf A pointer to the leaf instance.
@fn void tButterworth_initToPool (tButterworth* const, int N, float f1, float f2, tMempool* const)
- @brief
- @param
+ @brief Initialize a tButterworth to a specified mempool.
+ @param filter A pointer to the tButterworth to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tButterworth_free (tButterworth* const)
@brief Free a tButterworth from its mempool.
- @param
+ @param filter A pointer to the tButterworth to free.
@fn float tButterworth_tick (tButterworth* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tButterworth.
@fn void tButterworth_setF1 (tButterworth* const, float in)
@brief
- @param
+ @param filter A pointer to the relevant tButterworth.
@fn void tButterworth_setF2 (tButterworth* const, float in)
@brief
- @param
+ @param filter A pointer to the relevant tButterworth.
@fn void tButterworth_setFreqs (tButterworth* const, float f1, float f2)
@brief
- @param
+ @param filter A pointer to the relevant tButterworth.

@} */
@@ -841,22 +841,22 @@
@{
@fn void tFIR_init (tFIR* const, float* coeffs, int numTaps, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tFIR to the default mempool of a LEAF instance.
+ @param filter A pointer to the tFIR to initialize.
@param leaf A pointer to the leaf instance.
@fn void tFIR_initToPool (tFIR* const, float* coeffs, int numTaps, tMempool* const)
- @brief
- @param
+ @brief Initialize a tFIR to a specified mempool.
+ @param filter A pointer to the tFIR to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tFIR_free (tFIR* const)
@brief Free a tFIR from its mempool.
- @param
+ @param filter A pointer to the tFIR to free.
@fn float tFIR_tick (tFIR* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tFIR.

@} */
@@ -887,22 +887,22 @@
@{
@fn void tMedianFilter_init (tMedianFilter* const, int size, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tMedianFilter to the default mempool of a LEAF instance.
+ @param filter A pointer to the tMedianFilter to initialize.
@param leaf A pointer to the leaf instance.f
@fn void tMedianFilter_initToPool (tMedianFilter* const, int size, tMempool* const)
- @brief
- @param
+ @brief Initialize a tMedianFilter to a specified mempool.
+ @param filter A pointer to the tMedianFilter to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tMedianFilter_free (tMedianFilter* const)
@brief Free a tMedianFilter from its mempool.
- @param
+ @param filter A pointer to the tMedianFilter to free.
@fn float tMedianFilter_tick (tMedianFilter* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tMedianFilter.

@} */
@@ -935,56 +935,58 @@
@{
@fn void tVZFilter_init (tVZFilter* const, VZFilterType type, float freq, float Q, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tVZFilter to the default mempool of a LEAF instance.
+ @param filter A pointer to the tVZFilter to initialize.
@param leaf A pointer to the leaf instance.
@fn void tVZFilter_initToPool (tVZFilter* const, VZFilterType type, float freq, float Q, tMempool* const)
- @brief
- @param
+ @brief Initialize a tVZFilter to a specified mempool.
+ @param filter A pointer to the tVZFilter to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tVZFilter_free (tVZFilter* const)
@brief Free a tVZFilter from its mempool.
- @param
+ @param filter A pointer to the tVZFilter to free.
@fn void tVZFilter_setSampleRate (tVZFilter* const, float sampleRate)
@brief
- @param
+ @param filter A pointer to the relevant tVZFilter.
@fn float tVZFilter_tick (tVZFilter* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tVZFilter.
@fn float tVZFilter_tickEfficient (tVZFilter* const vf, float in)
@brief
- @param
+ @param filter A pointer to the relevant tVZFilter.
@fn void tVZFilter_calcCoeffs (tVZFilter* const)
@brief
- @param
+ @param filter A pointer to the relevant tVZFilter.
@fn void tVZFilter_setBandwidth (tVZFilter* const, float bandWidth)
@brief
- @param
+ @param filter A pointer to the relevant tVZFilter.
@fn void tVZFilter_setFreq (tVZFilter* const, float freq)
@brief
- @param
+ @param filter A pointer to the relevant tVZFilter.
@fn void tVZFilter_setFreqAndBandwidth (tVZFilter* const vf, float freq, float bw)
@brief
- @param
+ @param filter A pointer to the relevant tVZFilter.
+
@fn void tVZFilter_setGain (tVZFilter* const, float gain)
@brief
- @param
+ @param filter A pointer to the relevant tVZFilter.
+
@fn void tVZFilter_setType (tVZFilter* const, VZFilterType type)
@brief
- @param
+ @param filter A pointer to the relevant tVZFilter.
@fn float tVZFilter_BandwidthToR (tVZFilter* const vf, float B)
@brief
- @param
+ @param filter A pointer to the relevant tVZFilter.

@} */
@@ -1058,30 +1060,30 @@
@{
@fn void tDiodeFilter_init (tDiodeFilter* const, float freq, float Q, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tDiodeFilter to the default mempool of a LEAF instance.
+ @param filter A pointer to the tDiodeFilter to initialize.
@param leaf A pointer to the leaf instance.
@fn void tDiodeFilter_initToPool (tDiodeFilter* const, float freq, float Q, tMempool* const)
- @brief
- @param
+ @brief Initialize a tDiodeFilter to a specified mempool.
+ @param filter A pointer to the tDiodeFilter to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tDiodeFilter_free (tDiodeFilter* const)
@brief Free a tDiodeFilter from its mempool.
- @param
+ @param filter A pointer to the tDiodeFilter to free.
@fn float tDiodeFilter_tick (tDiodeFilter* const, float input)
@brief
- @param
+ @param filter A pointer to the relevant tDiodeFilter.
@fn void tDiodeFilter_setFreq (tDiodeFilter* const vf, float cutoff)
@brief
- @param
+ @param filter A pointer to the relevant tDiodeFilter.
@fn void tDiodeFilter_setQ (tDiodeFilter* const vf, float resonance)
@brief
- @param
+ @param filter A pointer to the relevant tDiodeFilter.

@} */
--- a/leaf/Inc/leaf-global.h
+++ b/leaf/Inc/leaf-global.h
@@ -19,7 +19,7 @@
/*!
* @ingroup leaf
- * @brief The struct of the global LEAF instance `leaf`. Contains global variables and settings.
+ * @brief Struct for an instance of LEAF.
*/
struct LEAF
--- a/leaf/Inc/leaf-instruments.h
+++ b/leaf/Inc/leaf-instruments.h
@@ -38,50 +38,50 @@
@{
@fn void t808Cowbell_init (t808Cowbell* const, int useStick, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a t808Cowbell to the default mempool of a LEAF instance.
+ @param cowbell A pointer to the t808Cowbell to initialize.
@param leaf A pointer to the leaf instance.
@fn void t808Cowbell_initToPool (t808Cowbell* const, int useStick, tMempool* const)
- @brief
- @param
+ @brief Initialize a t808Cowbell to a specified mempool.
+ @param cowbell A pointer to the t808Cowbell to initialize.
@param mempool A pointer to the tMempool to use.
@fn void t808Cowbell_free (t808Cowbell* const)
@brief Free a t808Cowbell from its mempool.
- @param
+ @param cowbell A pointer to the t808Cowbell to free.
@fn float t808Cowbell_tick (t808Cowbell* const)
@brief
- @param
+ @param cowbell A pointer to the relevant t808Cowbell.
@fn void t808Cowbell_on (t808Cowbell* const, float vel)
@brief
- @param
+ @param cowbell A pointer to the relevant t808Cowbell.
@fn void t808Cowbell_setDecay (t808Cowbell* const, float decay)
@brief
- @param
+ @param cowbell A pointer to the relevant t808Cowbell.
@fn void t808Cowbell_setHighpassFreq (t808Cowbell* const, float freq)
@brief
- @param
+ @param cowbell A pointer to the relevant t808Cowbell.
@fn void t808Cowbell_setBandpassFreq (t808Cowbell* const, float freq)
@brief
- @param
+ @param cowbell A pointer to the relevant t808Cowbell.
@fn void t808Cowbell_setFreq (t808Cowbell* const, float freq)
@brief
- @param
+ @param cowbell A pointer to the relevant t808Cowbell.
@fn void t808Cowbell_setOscMix (t808Cowbell* const, float oscMix)
@brief
- @param
+ @param cowbell A pointer to the relevant t808Cowbell.
@fn void t808Cowbell_setStick (t808Cowbell* const, int useStick)
@brief
- @param
+ @param cowbell A pointer to the relevant t808Cowbell.
@} */
@@ -125,66 +125,66 @@
@{
@fn void t808Hihat_init (t808Hihat* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a t808Hihat to the default mempool of a LEAF instance.
+ @param hihat A pointer to the t808Hihat to initialize.
@param leaf A pointer to the leaf instance.
@fn void t808Hihat_initToPool (t808Hihat* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a t808Hihat to a specified mempool.
+ @param hihat A pointer to the t808Hihat to initialize.
@param mempool A pointer to the tMempool to use.
@fn void t808Hihat_free (t808Hihat* const)
@brief Free a t808Hihat from its mempool.
- @param
+ @param hihat A pointer to the t808Hihat to free.
@fn float t808Hihat_tick (t808Hihat* const)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@fn void t808Hihat_on (t808Hihat* const, float vel)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@fn void t808Hihat_setOscNoiseMix (t808Hihat* const, float oscNoiseMix)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@fn void t808Hihat_setDecay (t808Hihat* const, float decay)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@fn void t808Hihat_setHighpassFreq (t808Hihat* const, float freq)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@fn void t808Hihat_setOscBandpassFreq (t808Hihat* const, float freq)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@fn void t808Hihat_setOscBandpassQ (t808Hihat* const hihat, float Q)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@fn void t808Hihat_setStickBandPassFreq (t808Hihat* const, float freq)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@fn void t808Hihat_setStickBandPassQ (t808Hihat* const hihat, float Q)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@fn void t808Hihat_setOscFreq (t808Hihat* const, float freq)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@fn void t808Hihat_setStretch (t808Hihat* const hihat, float stretch)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@fn void t808Hihat_setFM (t808Hihat* const hihat, float FM_amount)
@brief
- @param
+ @param hihat A pointer to the relevant t808Hihat.
@} */
@@ -237,58 +237,58 @@
@{
@fn void t808Snare_init (t808Snare* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a t808Snare to the default mempool of a LEAF instance.
+ @param snare A pointer to the t808Snare to initialize.
@param leaf A pointer to the leaf instance.
@fn void t808Snare_initToPool (t808Snare* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a t808Snare to a specified mempool.
+ @param snare A pointer to the t808Snare to initialize.
@param mempool A pointer to the tMempool to use.
@fn void t808Snare_free (t808Snare* const)
@brief Free a t808Snare from its mempool.
- @param
+ @param snare A pointer to the t808Snare to free.
@fn float t808Snare_tick (t808Snare* const)
@brief
- @param
+ @param snare A pointer to the relevant t808Snare.
@fn void t808Snare_on (t808Snare* const, float vel)
@brief
- @param
+ @param snare A pointer to the relevant t808Snare.
@fn void t808Snare_setTone1Freq (t808Snare* const, float freq)
@brief
- @param
+ @param snare A pointer to the relevant t808Snare.
@fn void t808Snare_setTone2Freq (t808Snare* const, float freq)
@brief
- @param
+ @param snare A pointer to the relevant t808Snare.
@fn void t808Snare_setTone1Decay (t808Snare* const, float decay)
@brief
- @param
+ @param snare A pointer to the relevant t808Snare.
@fn void t808Snare_setTone2Decay (t808Snare* const, float decay)
@brief
- @param
+ @param snare A pointer to the relevant t808Snare.
@fn void t808Snare_setNoiseDecay (t808Snare* const, float decay)
@brief
- @param
+ @param snare A pointer to the relevant t808Snare.
@fn void t808Snare_setToneNoiseMix (t808Snare* const, float toneNoiseMix)
@brief
- @param
+ @param snare A pointer to the relevant t808Snare.
@fn void t808Snare_setNoiseFilterFreq (t808Snare* const, float noiseFilterFreq)
@brief
- @param
+ @param snare A pointer to the relevant t808Snare.
@fn void t808Snare_setNoiseFilterQ (t808Snare* const, float noiseFilterQ)
@brief
- @param
+ @param snare A pointer to the relevant t808Snare.
@} */
@@ -343,58 +343,58 @@
@{
@fn void t808Kick_init (t808Kick* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a t808Kick to the default mempool of a LEAF instance.
+ @param kick A pointer to the t808Kick to initialize.
@param leaf A pointer to the leaf instance.
@fn void t808Kick_initToPool (t808Kick* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a t808Kick to a specified mempool.
+ @param kick A pointer to the t808Kick to initialize.
@param mempool A pointer to the tMempool to use.
@fn void t808Kick_free (t808Kick* const)
@brief Free a t808Kick from its mempool.
- @param
+ @param kick A pointer to the t808Kick to free.
@fn float t808Kick_tick (t808Kick* const)
@brief
- @param
+ @param kick A pointer to the relevant t808Kick.
@fn void t808Kick_on (t808Kick* const, float vel)
@brief
- @param
+ @param kick A pointer to the relevant t808Kick.
@fn void t808Kick_setToneFreq (t808Kick* const, float freq)
@brief
- @param
+ @param kick A pointer to the relevant t808Kick.
@fn void t808Kick_setToneDecay (t808Kick* const, float decay)
@brief
- @param
+ @param kick A pointer to the relevant t808Kick.
@fn void t808Kick_setNoiseDecay (t808Kick* const, float decay)
@brief
- @param
+ @param kick A pointer to the relevant t808Kick.
@fn void t808Kick_setSighAmount (t808Kick* const, float sigh)
@brief
- @param
+ @param kick A pointer to the relevant t808Kick.
@fn void t808Kick_setChirpAmount (t808Kick* const, float chirp)
@brief
- @param
+ @param kick A pointer to the relevant t808Kick.
@fn void t808Kick_setToneNoiseMix (t808Kick* const, float toneNoiseMix)
@brief
- @param
+ @param kick A pointer to the relevant t808Kick.
@fn void t808Kick_setNoiseFilterFreq (t808Kick* const, float noiseFilterFreq)
@brief
- @param
+ @param kick A pointer to the relevant t808Kick.
@fn void t808Kick_setNoiseFilterQ (t808Kick* const, float noiseFilterQ)
@brief
- @param
+ @param kick A pointer to the relevant t808Kick.
@} */
--- a/leaf/Inc/leaf-mempool.h
+++ b/leaf/Inc/leaf-mempool.h
@@ -94,6 +94,7 @@
@param pool A pointer to the tMempool to initialize.
@param memory A pointer to the chunk of memory to be used as a mempool.
@param size The size of the chunk of memory to be used as a mempool.
+ @param leaf A pointer to the leaf instance.
*/
void tMempool_init (tMempool* const pool, char* memory, size_t size, LEAF* const leaf);
@@ -112,7 +113,7 @@
@param size The size of the chuck of memory to be used as a mempool.
@param poolTo A pointer to the tMempool to which this tMempool should be initialized.
*/
- void tMempool_initToPool (tMempool* const mp, char* memory, size_t size, tMempool* const mem, LEAF* const leaf);
+ void tMempool_initToPool (tMempool* const mp, char* memory, size_t size, tMempool* const mem);
/*!
@} */
--- a/leaf/Inc/leaf-oscillators.h
+++ b/leaf/Inc/leaf-oscillators.h
@@ -34,7 +34,7 @@
@brief A general wavetable oscillator.
@{
- @fn void tTable_init (tTable* const osc, float* table, int size, LEAF* const leaf)
+ @fn void tTable_init (tTable* const osc, float* table, int size, LEAF* const leaf)
@brief Initialize a tTable to the default mempool of a LEAF instance.
@param osc A pointer to the tTable to initialize.
@param table A pointer to the wave table data.
@@ -312,30 +312,30 @@
@{
@fn void tTri_init (tTri* const osc, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tTri to the default mempool of a LEAF instance.
+ @param osc A pointer to the tTri to initialize.
@param leaf A pointer to the leaf instance.
@fn void tTri_initToPool (tTri* const osc, tMempool* const mempool)
- @brief
- @param
+ @brief Initialize a tTri to a specified mempool.
+ @param osc A pointer to the tTri to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tTri_free (tTri* const osc)
@brief Free a tTri from its mempool.
- @param
+ @param osc A pointer to the tTri to free.
@fn float tTri_tick (tTri* const osc)
@brief
- @param
+ @param osc A pointer to the relevant tTri.
@fn void tTri_setFreq (tTri* const osc, float freq)
@brief
- @param
+ @param osc A pointer to the relevant tTri.
@fn void tTri_setSkew (tTri* const osc, float skew)
@brief
- @param
+ @param osc A pointer to the relevant tTri.

@} */
@@ -368,30 +368,30 @@
@{
@fn void tPulse_init (tPulse* const osc, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tPulse to the default mempool of a LEAF instance.
+ @param osc A pointer to the tPulse to initialize.
@param leaf A pointer to the leaf instance.
@fn void tPulse_initToPool (tPulse* const osc, tMempool* const)
- @brief
- @param
+ @brief Initialize a tPulse to a specified mempool.
+ @param osc A pointer to the tPulse to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tPulse_free (tPulse* const osc)
@brief Free a tPulse from its mempool.
- @param
+ @param osc A pointer to the tPulse to free.
@fn float tPulse_tick (tPulse* const osc)
@brief
- @param
+ @param osc A pointer to the relevant tPulse.
@fn void tPulse_setFreq (tPulse* const osc, float freq)
@brief
- @param
+ @param osc A pointer to the relevant tPulse.
@fn void tPulse_setWidth (tPulse* const osc, float width)
@brief
- @param
+ @param osc A pointer to the relevant tPulse.

@} */
@@ -423,26 +423,26 @@
@{
@fn void tSaw_init (tSaw* const osc, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tSaw to the default mempool of a LEAF instance.
+ @param osc A pointer to the tSaw to initialize.
@param leaf A pointer to the leaf instance.
@fn void tSaw_initToPool (tSaw* const osc, tMempool* const mempool)
- @brief
- @param
+ @brief Initialize a tSaw to a specified mempool.
+ @param osc A pointer to the tSaw to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tSaw_free (tSaw* const osc)
@brief Free a tSaw from its mempool.
- @param
+ @param osc A pointer to the tSaw to free.
@fn float tSaw_tick (tSaw* const osc)
@brief
- @param
+ @param osc A pointer to the relevant tSaw.
@fn void tSaw_setFreq (tSaw* const osc, float freq)
@brief
- @param
+ @param osc A pointer to the relevant tSaw.

@} */
@@ -472,26 +472,26 @@
@{
@fn void tPhasor_init (tPhasor* const osc, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tPhasor to the default mempool of a LEAF instance.
+ @param osc A pointer to the tPhasor to initialize.
@param leaf A pointer to the leaf instance.
@fn void tPhasor_initToPool (tPhasor* const osc, tMempool* const)
- @brief
- @param
+ @brief Initialize a tPhasor to a specified mempool.
+ @param osc A pointer to the tPhasor to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tPhasor_free (tPhasor* const osc)
@brief Free a tPhasor from its mempool.
- @param
+ @param osc A pointer to the tPhasor to free.
@fn float tPhasor_tick (tPhasor* const osc)
@brief
- @param
+ @param osc A pointer to the relevant tPhasor.
@fn void tPhasor_setFreq (tPhasor* const osc, float freq)
@brief
- @param
+ @param osc A pointer to the relevant tPhasor.

@} */
@@ -522,22 +522,22 @@
@{
@fn void tNoise_init (tNoise* const noise, NoiseType type, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tNoise to the default mempool of a LEAF instance.
+ @param noise A pointer to the tNoise to initialize.
@param leaf A pointer to the leaf instance.
@fn void tNoise_initToPool (tNoise* const noise, NoiseType type, tMempool* const)
- @brief
- @param
+ @brief Initialize a tNoise to a specified mempool.
+ @param noise A pointer to the tNoise to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tNoise_free (tNoise* const noise)
@brief Free a tNoise from its mempool.
- @param
+ @param noise A pointer to the tNoise to free.
@fn float tNoise_tick (tNoise* const noise)
@brief
- @param
+ @param noise A pointer to the relevant tNoise.
*/
/* tNoise. WhiteNoise, PinkNoise. */
@@ -720,36 +720,36 @@
@{
@fn void tMBPulse_init(tMBPulse* const osc, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tMBPulse to the default mempool of a LEAF instance.
+ @param osc A pointer to the tMBPulse to initialize.
@fn void tMBPulse_initToPool(tMBPulse* const osc, tMempool* const mempool)
- @brief
- @param
+ @brief Initialize a tMBPulse to a specified mempool.
+ @param osc A pointer to the tMBPulse to initialize.
@fn void tMBPulse_free(tMBPulse* const osc)
- @brief
- @param
+ @brief Free a tMBPulse from its mempool.
+ @param osc A pointer to the tMBPulse to free.
@fn float tMBPulse_tick(tMBPulse* const osc)
@brief
- @param
+ @param osc A pointer to the relevant tMBPulse.
@fn void tMBPulse_setFreq(tMBPulse* const osc, float f)
@brief
- @param
+ @param osc A pointer to the relevant tMBPulse.
@fn void tMBPulse_setWidth(tMBPulse* const osc, float w)
@brief
- @param
+ @param osc A pointer to the relevant tMBPulse.
@fn void tMBPulse_syncIn(tMBPulse* const osc, float sync)
@brief
- @param
+ @param osc A pointer to the relevant tMBPulse.
@fn float tMBPulse_syncOut(tMBPulse* const osc)
@brief
- @param
+ @param osc A pointer to the relevant tMBPulse.

@} */
@@ -789,36 +789,36 @@
@{
@fn void tMBTriangle_init(tMBTriangle* const osc, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tMBTriangle to the default mempool of a LEAF instance.
+ @param osc A pointer to the tMBTriangle to initialize.
@fn void tMBTriangle_initToPool(tMBTriangle* const osc, tMempool* const mempool)
- @brief
- @param
+ @brief Initialize a tMBTriangle to a specified mempool.
+ @param osc A pointer to the tMBTriangle to initialize.
@fn void tMBTriangle_free(tMBTriangle* const osc)
- @brief
- @param
+ @brief Free a tMBTriangle from its mempool.
+ @param osc A pointer to the tMBTriangle to free.
@fn float tMBTriangle_tick(tMBTriangle* const osc)
@brief
- @param
+ @param osc A pointer to the relevant tMBTriangle.
@fn void tMBTriangle_setFreq(tMBTriangle* const osc, float f)
@brief
- @param
+ @param osc A pointer to the relevant tMBTriangle.
@fn void tMBTriangle_setWidth(tMBTriangle* const osc, float w)
@brief
- @param
+ @param osc A pointer to the relevant tMBTriangle.
@fn void tMBTriangle_syncIn(tMBTriangle* const osc, float sync)
@brief
- @param
+ @param osc A pointer to the relevant tMBTriangle.
@fn float tMBTriangle_syncOut(tMBTriangle* const osc)
@brief
- @param
+ @param osc A pointer to the relevant tMBTriangle.

@} */
@@ -859,32 +859,32 @@
@{
@fn void tMBSaw_init(tMBSaw* const osc, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tMBSaw to the default mempool of a LEAF instance.
+ @param osc A pointer to the tMBSaw to initialize.
@fn void tMBSaw_initToPool(tMBSaw* const osc, tMempool* const mempool)
- @brief
- @param
+ @brief Initialize a tMBSaw to a specified mempool.
+ @param osc A pointer to the tMBSaw to initialize.
@fn void tMBSaw_free(tMBSaw* const osc)
- @brief
- @param
+ @brief Free a tMBSaw from its mempool.
+ @param osc A pointer to the tMBSaw to free.
@fn float tMBSaw_tick(tMBSaw* const osc)
@brief
- @param
+ @param osc A pointer to the relevant tMBSaw.
@fn void tMBSaw_setFreq(tMBSaw* const osc, float f)
@brief
- @param
+ @param osc A pointer to the relevant tMBSaw.
@fn void tMBSaw_syncIn(tMBSaw* const osc, float sync)
@brief
- @param
+ @param osc A pointer to the relevant tMBSaw.
@fn float tMBSaw_syncOut(tMBSaw* const osc)
@brief
- @param
+ @param osc A pointer to the relevant tMBSaw.

@} */
--- a/leaf/Inc/leaf-physical.h
+++ b/leaf/Inc/leaf-physical.h
@@ -43,46 +43,46 @@
@{
@fn void tPluck_init (tPluck* const, float lowestFrequency, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tPluck to the default mempool of a LEAF instance.
+ @param string A pointer to the tPluck to initialize.
@param leaf A pointer to the leaf instance.
@fn void tPluck_initToPool (tPluck* const, float lowestFrequency, tMempool* const)
- @brief
- @param
+ @brief Initialize a tPluck to a specified mempool.
+ @param string A pointer to the tPluck to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tPluck_free (tPluck* const)
@brief Free a tPluck from its mempool.
- @param
+ @param string A pointer to the tPluck to free.
@fn float tPluck_tick (tPluck* const)
@brief
- @param
+ @param string A pointer to the relevant tPluck.
@fn void tPluck_pluck (tPluck* const, float amplitude)
@brief Pluck the string.
- @param
+ @param string A pointer to the relevant tPluck.
@fn void tPluck_noteOn (tPluck* const, float frequency, float amplitude )
@brief Start a note with the given frequency and amplitude.
- @param
+ @param string A pointer to the relevant tPluck.
@fn void tPluck_noteOff (tPluck* const, float amplitude )
@brief Stop a note with the given amplitude (speed of decay)
- @param
+ @param string A pointer to the relevant tPluck.
@fn void tPluck_setFrequency (tPluck* const, float frequency )
@brief Set instrument parameters for a particular frequency.
- @param
+ @param string A pointer to the relevant tPluck.
@fn void tPluck_controlChange (tPluck* const, int number, float value)
@brief Perform the control change specified by \e number and \e value (0.0 - 128.0).
- @param
+ @param string A pointer to the relevant tPluck.
@fn float tPluck_getLastOut (tPluck* const)
@brief
- @param
+ @param string A pointer to the relevant tPluck.
@} */
@@ -126,58 +126,58 @@
@{
@fn void tKarplusStrong_init (tKarplusStrong* const, float lowestFrequency, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tKarplusStrong to the default mempool of a LEAF instance.
+ @param string A pointer to the tKarplusStrong to initialize.
@param leaf A pointer to the leaf instance.
@fn void tKarplusStrong_initToPool (tKarplusStrong* const, float lowestFrequency, tMempool* const)
- @brief
- @param
+ @brief Initialize a tKarplusStrong to a specified mempool.
+ @param string A pointer to the tKarplusStrong to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tKarplusStrong_free (tKarplusStrong* const)
@brief Free a tKarplusStrong from its mempool.
- @param
+ @param string A pointer to the tKarplusStrong to free.
@fn float tKarplusStrong_tick (tKarplusStrong* const)
@brief
- @param
+ @param string A pointer to the relevant tKarplusStrong.
@fn void tKarplusStrong_pluck (tKarplusStrong* const, float amplitude)
@brief Pluck the string.
- @param
+ @param string A pointer to the relevant tKarplusStrong.
@fn void tKarplusStrong_noteOn (tKarplusStrong* const, float frequency, float amplitude)
@brief Start a note with the given frequency and amplitude.
- @param
+ @param string A pointer to the relevant tKarplusStrong.
@fn void tKarplusStrong_noteOff (tKarplusStrong* const, float amplitude)
@brief Stop a note with the given amplitude (speed of decay).
- @param
+ @param string A pointer to the relevant tKarplusStrong.
@fn void tKarplusStrong_setFrequency (tKarplusStrong* const, float frequency)
@brief Set instrument parameters for a particular frequency.
- @param
+ @param string A pointer to the relevant tKarplusStrong.
@fn void tKarplusStrong_controlChange (tKarplusStrong* const, SKControlType type, float value)
@brief Perform the control change specified by \e number and \e value (0.0 - 128.0). Use SKPickPosition, SKStringDamping, or SKDetune for type.
- @param
+ @param string A pointer to the relevant tKarplusStrong.
@fn void tKarplusStrong_setStretch (tKarplusStrong* const, float stretch)
@brief Set the stretch "factor" of the string (0.0 - 1.0).
- @param
+ @param string A pointer to the relevant tKarplusStrong.
@fn void tKarplusStrong_setPickupPosition (tKarplusStrong* const, float position)
@brief Set the pluck or "excitation" position along the string (0.0 - 1.0).
- @param
+ @param string A pointer to the relevant tKarplusStrong.
@fn void tKarplusStrong_setBaseLoopGain (tKarplusStrong* const, float aGain )
@brief Set the base loop gain.
- @param
+ @param string A pointer to the relevant tKarplusStrong.
@fn float tKarplusStrong_getLastOut (tKarplusStrong* const)
@brief
- @param
+ @param string A pointer to the relevant tKarplusStrong.
@} */
@@ -238,58 +238,58 @@
@{
@fn void tSimpleLivingString_init (tSimpleLivingString* const, float freq, float dampFreq, float decay, float targetLev, float levSmoothFactor, float levStrength, int levMode, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tSimpleLivingString to the default mempool of a LEAF instance.
+ @param string A pointer to the tSimpleLivingString to initialize.
@param leaf A pointer to the leaf instance.
@fn void tSimpleLivingString_initToPool (tSimpleLivingString* const, float freq, float dampFreq, float decay, float targetLev, float levSmoothFactor, float levStrength, int levMode, tMempool* const)
- @brief
- @param
+ @brief Initialize a tSimpleLivingString to a specified mempool.
+ @param string A pointer to the tSimpleLivingString to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tSimpleLivingString_free (tSimpleLivingString* const)
@brief Free a tSimpleLivingString from its mempool.
- @param
+ @param string A pointer to the tSimpleLivingString to free.
@fn float tSimpleLivingString_tick (tSimpleLivingString* const, float input)
@brief
- @param
+ @param string A pointer to the relevant tSimpleLivingString.
@fn float tSimpleLivingString_sample (tSimpleLivingString* const)
@brief
- @param
+ @param string A pointer to the relevant tSimpleLivingString.
@fn void tSimpleLivingString_setFreq (tSimpleLivingString* const, float freq)
@brief
- @param
+ @param string A pointer to the relevant tSimpleLivingString.
@fn void tSimpleLivingString_setWaveLength (tSimpleLivingString* const, float waveLength)
@brief
- @param
+ @param string A pointer to the relevant tSimpleLivingString.
@fn void tSimpleLivingString_setDampFreq (tSimpleLivingString* const, float dampFreq)
@brief
- @param
+ @param string A pointer to the relevant tSimpleLivingString.
@fn void tSimpleLivingString_setDecay (tSimpleLivingString* const, float decay)
@brief
- @param
+ @param string A pointer to the relevant tSimpleLivingString.
@fn void tSimpleLivingString_setTargetLev (tSimpleLivingString* const, float targetLev)
@brief
- @param
+ @param string A pointer to the relevant tSimpleLivingString.
@fn void tSimpleLivingString_setLevSmoothFactor (tSimpleLivingString* const, float levSmoothFactor)
@brief
- @param
+ @param string A pointer to the relevant tSimpleLivingString.
@fn void tSimpleLivingString_setLevStrength (tSimpleLivingString* const, float levStrength)
@brief
- @param
+ @param string A pointer to the relevant tSimpleLivingString.
@fn void tSimpleLivingString_setLevMode (tSimpleLivingString* const, int levMode)
@brief
- @param
+ @param string A pointer to the relevant tSimpleLivingString.
@} */
@@ -339,66 +339,66 @@
@{
@fn void tLivingString_init (tLivingString* const, float freq, float pickPos, float prepIndex, float dampFreq, float decay, float targetLev, float levSmoothFactor, float levStrength, int levMode, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tLivingString to the default mempool of a LEAF instance.
+ @param string A pointer to the tLivingString to initialize.
@param leaf A pointer to the leaf instance.
@fn void tLivingString_initToPool (tLivingString* const, float freq, float pickPos, float prepIndex, float dampFreq, float decay, float targetLev, float levSmoothFactor, float levStrength, int levMode, tMempool* const)
- @brief
- @param
+ @brief Initialize a tLivingString to a specified mempool.
+ @param string A pointer to the tLivingString to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tLivingString_free (tLivingString* const)
@brief Free a tLivingString from its mempool.
- @param
+ @param string A pointer to the tLivingString to free.
@fn float tLivingString_tick (tLivingString* const, float input)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@fn float tLivingString_sample (tLivingString* const)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@fn void tLivingString_setFreq (tLivingString* const, float freq)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@fn void tLivingString_setWaveLength (tLivingString* const, float waveLength)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@fn void tLivingString_setPickPos (tLivingString* const, float pickPos)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@fn void tLivingString_setPrepIndex (tLivingString* const, float prepIndex)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@fn void tLivingString_setDampFreq (tLivingString* const, float dampFreq)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@fn void tLivingString_setDecay (tLivingString* const, float decay)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@fn void tLivingString_setTargetLev (tLivingString* const, float targetLev)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@fn void tLivingString_setLevSmoothFactor (tLivingString* const, float levSmoothFactor)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@fn void tLivingString_setLevStrength (tLivingString* const, float levStrength)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@fn void tLivingString_setLevMode (tLivingString* const, int levMode)
@brief
- @param
+ @param string A pointer to the relevant tLivingString.
@} */
@@ -454,70 +454,70 @@
@{
@fn void tComplexLivingString_init (tComplexLivingString* const, float freq, float pickPos, float prepPos, float prepIndex, float dampFreq, float decay, float targetLev, float levSmoothFactor, float levStrength, int levMode, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tComplexLivingString to the default mempool of a LEAF instance.
+ @param string A pointer to the tComplexLivingString to initialize.
@param leaf A pointer to the leaf instance.
@fn void tComplexLivingString_initToPool (tComplexLivingString* const, float freq, float pickPos, float prepPos, float prepIndex, float dampFreq, float decay, float targetLev, float levSmoothFactor, float levStrength, int levMode, tMempool* const)
- @brief
- @param
+ @brief Initialize a tComplexLivingString to a specified mempool.
+ @param string A pointer to the tComplexLivingString to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tComplexLivingString_free (tComplexLivingString* const)
@brief Free a tComplexLivingString from its mempool.
- @param
+ @param string A pointer to the tComplexLivingString to free.
@fn float tComplexLivingString_tick (tComplexLivingString* const, float input)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn float tComplexLivingString_sample (tComplexLivingString* const)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn void tComplexLivingString_setFreq (tComplexLivingString* const, float freq)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn void tComplexLivingString_setWaveLength (tComplexLivingString* const, float waveLength)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn void tComplexLivingString_setPickPos (tComplexLivingString* const, float pickPos)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn void tComplexLivingString_setPrepPos (tComplexLivingString* const, float prepPos)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn void tComplexLivingString_setPrepIndex (tComplexLivingString* const, float prepIndex)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn void tComplexLivingString_setDampFreq (tComplexLivingString* const, float dampFreq)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn void tComplexLivingString_setDecay (tComplexLivingString* const, float decay)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn void tComplexLivingString_setTargetLev (tComplexLivingString* const, float targetLev)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn void tComplexLivingString_setLevSmoothFactor (tComplexLivingString* const, float levSmoothFactor)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn void tComplexLivingString_setLevStrength (tComplexLivingString* const, float levStrength)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@fn void tComplexLivingString_setLevMode (tComplexLivingString* const, int levMode)
@brief
- @param
+ @param string A pointer to the relevant tComplexLivingString.
@} */
@@ -577,34 +577,34 @@
@{
@fn void tReedTable_init (tReedTable* const, float offset, float slope, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tReedTable to the default mempool of a LEAF instance.
+ @param reed A pointer to the tReedTable to initialize.
@param leaf A pointer to the leaf instance.
@fn void tReedTable_initToPool (tReedTable* const, float offset, float slope, tMempool* const)
- @brief
- @param
+ @brief Initialize a tReedTable to a specified mempool.
+ @param reed A pointer to the tReedTable to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tReedTable_free (tReedTable* const)
@brief Free a tReedTable from its mempool.
- @param
+ @param reed A pointer to the tReedTable to free.
@fn float tReedTable_tick (tReedTable* const, float input)
@brief
- @param
+ @param reed A pointer to the relevant tReedTable.
@fn float tReedTable_tanh_tick (tReedTable* const, float input)
@brief
- @param
+ @param reed A pointer to the relevant tReedTable.
@fn void tReedTable_setOffset (tReedTable* const, float offset)
@brief
- @param
+ @param reed A pointer to the relevant tReedTable.
@fn void tReedTable_setSlope (tReedTable* const, float slope)
@brief
- @param
+ @param reed A pointer to the relevant tReedTable.
@} */
--- a/leaf/Inc/leaf-reverb.h
+++ b/leaf/Inc/leaf-reverb.h
@@ -39,34 +39,34 @@
@{
@fn void tPRCReverb_init (tPRCReverb* const, float t60, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tPRCReverb to the default mempool of a LEAF instance.
+ @param reverb A pointer to the tPRCReverb to initialize.
@param leaf A pointer to the leaf instance.
@fn void tPRCReverb_initToPool (tPRCReverb* const, float t60, tMempool* const)
- @brief
- @param
+ @brief Initialize a tPRCReverb to a specified mempool.
+ @param reverb A pointer to the tPRCReverb to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tPRCReverb_free (tPRCReverb* const)
@brief Free a tPRCReverb from its mempool.
- @param
+ @param reverb A pointer to the tPRCReverb to free.
@fn void tPRCReverb_clear (tPRCReverb* const)
@brief
- @param
+ @param reverb A pointer to the relevant tPRCReverb.
@fn float tPRCReverb_tick (tPRCReverb* const, float input)
@brief
- @param
+ @param reverb A pointer to the relevant tPRCReverb.
@fn void tPRCReverb_setT60 (tPRCReverb* const, float t60)
@brief Set reverb time in seconds.
- @param
+ @param reverb A pointer to the relevant tPRCReverb.
@fn void tPRCReverb_setMix (tPRCReverb* const, float mix)
@brief Set mix between dry input and wet output signal.
- @param
+ @param reverb A pointer to the relevant tPRCReverb.
@} */
@@ -107,39 +107,39 @@
@{
@fn void tNReverb_init (tNReverb* const, float t60, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tNReverb to the default mempool of a LEAF instance.
+ @param reverb A pointer to the tNReverb to initialize.
@param leaf A pointer to the leaf instance.
@fn void tNReverb_initToPool (tNReverb* const, float t60, tMempool* const)
- @brief
- @param
+ @brief Initialize a tNReverb to a specified mempool.
+ @param reverb A pointer to the tNReverb to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tNReverb_free (tNReverb* const)
@brief Free a tNReverb from its mempool.
- @param
+ @param reverb A pointer to the tNReverb to free.
@fn void tNReverb_clear (tNReverb* const)
@brief
- @param
+ @param reverb A pointer to the relevant tNReverb.
@fn float tNReverb_tick (tNReverb* const, float input)
@brief
- @param
+ @param reverb A pointer to the relevant tNReverb.
@fn void tNReverb_tickStereo (tNReverb* const rev, float input, float* output)
- @brief
- @param
+ @brief
+ @param reverb A pointer to the relevant tNReverb.
@fn void tNReverb_setT60 (tNReverb* const, float t60)
@brief Set reverb time in seconds.
- @param
+ @param reverb A pointer to the relevant tNReverb.
@fn void tNReverb_setMix (tNReverb* const, float mix)
@brief Set mix between dry input and wet output signal.
- @param
-
+ @param reverb A pointer to the relevant tNReverb.
+
@} */
typedef struct _tNReverb
@@ -181,62 +181,62 @@
@{
@fn void tDattorroReverb_init (tDattorroReverb* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tDattorroReverb to the default mempool of a LEAF instance.
+ @param reverb A pointer to the tDattorroReverb to initialize.
@param leaf A pointer to the leaf instance.
@fn void tDattorroReverb_initToPool (tDattorroReverb* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tDattorroReverb to a specified mempool.
+ @param reverb A pointer to the tDattorroReverb to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tDattorroReverb_free (tDattorroReverb* const)
@brief Free a tDattorroReverb from its mempool.
- @param
+ @param reverb A pointer to the tDattorroReverb to free.
@fn void tDattorroReverb_clear (tDattorroReverb* const)
@brief
- @param
+ @param reverb A pointer to the relevant tDattorroReverb.
@fn float tDattorroReverb_tick (tDattorroReverb* const, float input)
@brief
- @param
+ @param reverb A pointer to the relevant tDattorroReverb.
@fn void tDattorroReverb_tickStereo (tDattorroReverb* const rev, float input, float* output)
@brief
- @param
+ @param reverb A pointer to the relevant tDattorroReverb.
@fn void tDattorroReverb_setMix (tDattorroReverb* const, float mix)
@brief
- @param
+ @param reverb A pointer to the relevant tDattorroReverb.
@fn void tDattorroReverb_setFreeze (tDattorroReverb* const rev, uint32_t freeze)
@brief
- @param
+ @param reverb A pointer to the relevant tDattorroReverb.
@fn void tDattorroReverb_setHP (tDattorroReverb* const, float freq)
@brief
- @param
+ @param reverb A pointer to the relevant tDattorroReverb.
@fn void tDattorroReverb_setSize (tDattorroReverb* const, float size)
@brief
- @param
+ @param reverb A pointer to the relevant tDattorroReverb.
@fn void tDattorroReverb_setInputDelay (tDattorroReverb* const, float preDelay)
@brief
- @param
+ @param reverb A pointer to the relevant tDattorroReverb.
@fn void tDattorroReverb_setInputFilter (tDattorroReverb* const, float freq)
@brief
- @param
+ @param reverb A pointer to the relevant tDattorroReverb.
@fn void tDattorroReverb_setFeedbackFilter (tDattorroReverb* const, float freq)
@brief
- @param
+ @param reverb A pointer to the relevant tDattorroReverb.
@fn void tDattorroReverb_setFeedbackGain (tDattorroReverb* const, float gain)
@brief
- @param
+ @param reverb A pointer to the relevant tDattorroReverb.
@} */
--- a/leaf/Inc/leaf-sampling.h
+++ b/leaf/Inc/leaf-sampling.h
@@ -40,70 +40,70 @@
@{
@fn void tBuffer_init (tBuffer* const, uint32_t length, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tBuffer to the default mempool of a LEAF instance.
+ @param sampler A pointer to the tBuffer to initialize.
@param leaf A pointer to the leaf instance.
@fn void tBuffer_initToPool (tBuffer* const, uint32_t length, tMempool* const)
- @brief
- @param
+ @brief Initialize a tBuffer to a specified mempool.
+ @param sampler A pointer to the tBuffer to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tBuffer_free (tBuffer* const)
@brief Free a tBuffer from its mempool.
- @param
+ @param sampler A pointer to the tBuffer to free.
@fn void tBuffer_tick (tBuffer* const, float sample)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn void tBuffer_read (tBuffer* const, float* buff, uint32_t len)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn float tBuffer_get (tBuffer* const, int idx)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn void tBuffer_record (tBuffer* const)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn void tBuffer_stop (tBuffer* const)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn int tBuffer_getRecordPosition (tBuffer* const)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn void tBuffer_setRecordPosition (tBuffer* const, int pos)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn void tBuffer_setRecordMode (tBuffer* const, RecordMode mode)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn void tBuffer_clear (tBuffer* const)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn uint32_t tBuffer_getBufferLength (tBuffer* const)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn uint32_t tBuffer_getRecordedLength (tBuffer* const sb)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn void tBuffer_setRecordedLength (tBuffer* const sb, int length)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@fn int tBuffer_isActive (tBuffer* const sb)
@brief
- @param
+ @param sampler A pointer to the relevant tBuffer.
@} */
@@ -161,58 +161,58 @@
@{
@fn void tSampler_init (tSampler* const, tBuffer* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tSampler to the default mempool of a LEAF instance.
+ @param sampler A pointer to the tSampler to initialize.
@param leaf A pointer to the leaf instance.
@fn void tSampler_initToPool (tSampler* const, tBuffer* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tSampler to a specified mempool.
+ @param sampler A pointer to the tSampler to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tSampler_free (tSampler* const)
@brief Free a tSampler from its mempool.
- @param
+ @param sampler A pointer to the tSampler to free.
@fn float tSampler_tick (tSampler* const)
@brief
- @param
+ @param sampler A pointer to the relevant tSampler.
@fn void tSampler_setSample (tSampler* const, tBuffer* const)
@brief
- @param
+ @param sampler A pointer to the relevant tSampler.
@fn void tSampler_setMode (tSampler* const, PlayMode mode)
@brief
- @param
+ @param sampler A pointer to the relevant tSampler.
@fn void tSampler_play (tSampler* const)
@brief
- @param
+ @param sampler A pointer to the relevant tSampler.
@fn void tSampler_stop (tSampler* const)
@brief
- @param
+ @param sampler A pointer to the relevant tSampler.
@fn void tSampler_setStart (tSampler* const, int32_t start)
@brief
- @param
+ @param sampler A pointer to the relevant tSampler.
@fn void tSampler_setEnd (tSampler* const, int32_t end)
@brief
- @param
+ @param sampler A pointer to the relevant tSampler.
@fn void tSampler_setLength (tSampler* const, int32_t length)
@brief
- @param
+ @param sampler A pointer to the relevant tSampler.
@fn void tSampler_setCrossfadeLength (tSampler* const sp, uint32_t length)
@brief
- @param
+ @param sampler A pointer to the relevant tSampler.
@fn void tSampler_setRate (tSampler* const, float rate)
@brief
- @param
+ @param sampler A pointer to the relevant tSampler.
@} */
@@ -291,54 +291,54 @@
@{
@fn void tAutoSampler_init (tAutoSampler* const, tBuffer* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tAutoSampler to the default mempool of a LEAF instance.
+ @param sampler A pointer to the tAutoSampler to initialize.
@param leaf A pointer to the leaf instance.
@fn void tAutoSampler_initToPool (tAutoSampler* const, tBuffer* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tAutoSampler to a specified mempool.
+ @param sampler A pointer to the tAutoSampler to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tAutoSampler_free (tAutoSampler* const)
@brief Free a tAutoSampler from its mempool.
- @param
+ @param sampler A pointer to the tAutoSampler to free.
@fn float tAutoSampler_tick (tAutoSampler* const, float input)
@brief
- @param
+ @param sampler A pointer to the relevant tAutoSampler.
@fn void tAutoSampler_setBuffer (tAutoSampler* const, tBuffer* const)
@brief
- @param
+ @param sampler A pointer to the relevant tAutoSampler.
@fn void tAutoSampler_setMode (tAutoSampler* const, PlayMode mode)
@brief
- @param
+ @param sampler A pointer to the relevant tAutoSampler.
@fn void tAutoSampler_play (tAutoSampler* const)
@brief
- @param
+ @param sampler A pointer to the relevant tAutoSampler.
@fn void tAutoSampler_stop (tAutoSampler* const)
@brief
- @param
+ @param sampler A pointer to the relevant tAutoSampler.
@fn void tAutoSampler_setThreshold (tAutoSampler* const, float thresh)
@brief
- @param
+ @param sampler A pointer to the relevant tAutoSampler.
@fn void tAutoSampler_setWindowSize (tAutoSampler* const, uint32_t size)
@brief
- @param
+ @param sampler A pointer to the relevant tAutoSampler.
@fn void tAutoSampler_setCrossfadeLength (tAutoSampler* const, uint32_t length)
@brief
- @param
+ @param sampler A pointer to the relevant tAutoSampler.
@fn void tAutoSampler_setRate (tAutoSampler* const, float rate)
@brief
- @param
+ @param sampler A pointer to the relevant tAutoSampler.
@} */
@@ -380,58 +380,58 @@
@{
@fn void tMBSampler_init (tMBSampler* const, tBuffer* const, LEAF* const leaf)
- @brief
- @param
+ @brief Initialize a tMBSampler to the default mempool of a LEAF instance.
+ @param sampler A pointer to the tMBSampler to initialize.
@param leaf A pointer to the leaf instance.
@fn void tMBSampler_initToPool (tMBSampler* const, tBuffer* const, tMempool* const)
- @brief
- @param
+ @brief Initialize a tMBSampler to a specified mempool.
+ @param sampler A pointer to the tMBSampler to initialize.
@param mempool A pointer to the tMempool to use.
@fn void tMBSampler_free (tMBSampler* const)
@brief Free a tMBSampler from its mempool.
- @param
+ @param sampler A pointer to the tMBSampler to free.
@fn float tMBSampler_tick (tMBSampler* const)
@brief
- @param
+ @param sampler A pointer to the relevant tMBSampler.
@fn void tMBSampler_setSample (tMBSampler* const, tBuffer* const)
@brief
- @param
+ @param sampler A pointer to the relevant tMBSampler.
@fn void tMBSampler_setMode (tMBSampler* const, PlayMode mode)
@brief
- @param
+ @param sampler A pointer to the relevant tMBSampler.
@fn void tMBSampler_play (tMBSampler* const)
@brief
- @param
+ @param sampler A pointer to the relevant tMBSampler.
@fn void tMBSampler_stop (tMBSampler* const)
@brief
- @param
+ @param sampler A pointer to the relevant tMBSampler.
@fn void tMBSampler_setStart (tMBSampler* const, int32_t start)
@brief
- @param
+ @param sampler A pointer to the relevant tMBSampler.
@fn void tMBSampler_setEnd (tMBSampler* const, int32_t end)
@brief
- @param
+ @param sampler A pointer to the relevant tMBSampler.
@fn void tMBSampler_setLength (tMBSampler* const, int32_t length)
@brief
- @param
+ @param sampler A pointer to the relevant tMBSampler.
@fn void tMBSampler_setCrossfadeLength (tMBSampler* const sp, uint32_t length)
@brief
- @param
+ @param sampler A pointer to the relevant tMBSampler.
@fn void tMBSampler_setRate (tMBSampler* const, float rate)
@brief
- @param
+ @param sampler A pointer to the relevant tMBSampler.
@} */
--- a/leaf/Src/leaf-mempool.c
+++ b/leaf/Src/leaf-mempool.c
@@ -409,7 +409,7 @@
void tMempool_init(tMempool* const mp, char* memory, size_t size, LEAF* const leaf)
{
- tMempool_initToPool(mp, memory, size, &leaf->mempool, leaf);
+ tMempool_initToPool(mp, memory, size, &leaf->mempool);
}
void tMempool_free(tMempool* const mp)
@@ -419,7 +419,7 @@
mpool_free((char*)m, m->mempool);
}
-void tMempool_initToPool (tMempool* const mp, char* memory, size_t size, tMempool* const mem, LEAF* const leaf)
+void tMempool_initToPool (tMempool* const mp, char* memory, size_t size, tMempool* const mem)
{
_tMempool* mm = *mem;
_tMempool* m = *mp = (_tMempool*) mpool_alloc(sizeof(_tMempool), mm);
--- a/leaf/Src/leaf-oscillators.c
+++ b/leaf/Src/leaf-oscillators.c
@@ -76,7 +76,6 @@
samp1 = c->waveTable[intPart];
return (samp0 + (samp1 - samp0) * fracPart);
-
}
void tTableSampleRateChanged(tTable* const cy)