updating docs

Matthew Wang committed 5 years ago

Commit 53eedc91 parent 73513b916 files · +810 −805Browse files

Unified · Split

16 files

leaf/Inc/leaf-delay.h +47 −49
leaf/Inc/leaf-distortion.h +34 −30
leaf/Inc/leaf-dynamics.h +28 −27
leaf/Inc/leaf-effects.h +104 −104
leaf/Inc/leaf-electrical.h +16 −16
leaf/Inc/leaf-envelopes.h +106 −106
leaf/Inc/leaf-filters.h +156 −154
leaf/Inc/leaf-global.h +1 −1
leaf/Inc/leaf-instruments.h +60 −60
leaf/Inc/leaf-mempool.h +2 −1
leaf/Inc/leaf-oscillators.h +69 −69
leaf/Inc/leaf-physical.h +86 −86
leaf/Inc/leaf-reverb.h +37 −37
leaf/Inc/leaf-sampling.h +62 −62
leaf/Src/leaf-mempool.c +2 −2
leaf/Src/leaf-oscillators.c +0 −1

@@ -35,14 +35,14 @@ extern "C" { · 34 unmodified lines
35	35	@{
36	36
37	37	@fn void tDelay_init (tDelay* const, uint32_t delay, uint32_t maxDelay, LEAF* const leaf)
38		− @brief
	38	+ @brief Initialize a tDelay to the default mempool of a LEAF instance.
39	39	@param delay A pointer to the tDelay to initialize.
40	40	@param initalLength
41	41	@param maxLength
42	42	@param leaf A pointer to the leaf instance.
43	43
44	44	@fn void tDelay_initToPool (tDelay* const, uint32_t delay, uint32_t maxDelay, tMempool* const)
45		− @brief
	45	+ @brief Initialize a tDelay to a specified mempool.
46	46	@param delay A pointer to the tDelay to initialize.
47	47	@param initalLength
48	48	@param maxLength
@@ -143,14 +143,14 @@ extern "C" { · 94 unmodified lines
143	143	@{
144	144
145	145	@fn void tLinearDelay_init (tLinearDelay* const, float delay, uint32_t maxDelay, LEAF* const leaf)
146		− @brief
	146	+ @brief Initialize a tLinearDelay to the default mempool of a LEAF instance.
147	147	@param delay A pointer to the tLinearDelay to initialize.
148	148	@param initialLength
149	149	@param maxLength
150	150	@param leaf A pointer to the leaf instance.
151	151
152	152	@fn void tLinearDelay_initToPool (tLinearDelay* const, float delay, uint32_t maxDelay, tMempool* const)
153		− @brief
	153	+ @brief Initialize a tLinearDelay to a specified mempool.
154	154	@param delay A pointer to the tLinearDelay to initialize.
155	155	@param initialLength
156	156	@param maxLength
@@ -210,7 +210,6 @@ extern "C" { · 53 unmodified lines
210	210
211	211	typedef struct _tLinearDelay
212	212	{
213		−
214	213	tMempool mempool;
215	214
216	215	float gain;
@@ -257,14 +256,14 @@ extern "C" { · 40 unmodified lines
257	256	@{
258	257
259	258	@fn void tHermiteDelay_init (tHermiteDelay* const dl, float delay, uint32_t maxDelay, LEAF* const leaf)
260		− @brief
	259	+ @brief Initialize a tHermiteDelay to the default mempool of a LEAF instance.
261	260	@param delay A pointer to the tHermiteDelay to initialize.
262	261	@param initialLength
263	262	@param maxLength
264	263	@param leaf A pointer to the leaf instance.
265	264
266	265	@fn void tHermiteDelay_initToPool (tHermiteDelay* const dl, float delay, uint32_t maxDelay, tMempool* const mp)
267		− @brief
	266	+ @brief Initialize a tHermiteDelay to a specified mempool.
268	267	@param delay A pointer to the tHermiteDelay to initialize.
269	268	@param initialLength
270	269	@param maxLength
@@ -394,54 +393,54 @@ extern "C" { · 123 unmodified lines
394	393	@{
395	394
396	395	@fn void tAllpassDelay_init (tAllpassDelay* const, float delay, uint32_t maxDelay, LEAF* const leaf)
397		− @brief
398		− @param
	396	+ @brief Initialize a tAllpassDelay to the default mempool of a LEAF instance.
	397	+ @param delay A pointer to the tAllpassDelay to initialize.
399	398	@param leaf A pointer to the leaf instance.
400	399
401	400	@fn void tAllpassDelay_initToPool (tAllpassDelay* const, float delay, uint32_t maxDelay, tMempool* const)
402		− @brief
403		− @param
	401	+ @brief Initialize a tAllpassDelay to a specified mempool.
	402	+ @param delay A pointer to the tAllpassDelay to initialize.
404	403	@param mempool A pointer to the tMempool to use.
405	404
406	405	@fn void tAllpassDelay_free (tAllpassDelay* const)
407	406	@brief Free a tAllpassDelay from its mempool.
408		− @param
	407	+ @param delay A pointer to the tAllpassDelay to free.
409	408
410	409	@fn void tAllpassDelay_clear (tAllpassDelay* const)
411	410	@brief
412		− @param
	411	+ @param delay A pointer to the relevant tAllpassDelay.
413	412
414	413	@fn int tAllpassDelay_setDelay (tAllpassDelay* const, float delay)
415	414	@brief
416		− @param
	415	+ @param delay A pointer to the relevant tAllpassDelay.
417	416
418	417	@fn float tAllpassDelay_getDelay (tAllpassDelay* const)
419	418	@brief
420		− @param
	419	+ @param delay A pointer to the relevant tAllpassDelay.
421	420
422	421	@fn void tAllpassDelay_tapIn (tAllpassDelay* const, float in, uint32_t tapDelay)
423	422	@brief
424		− @param
	423	+ @param delay A pointer to the relevant tAllpassDelay.
425	424
426	425	@fn float tAllpassDelay_tapOut (tAllpassDelay* const, uint32_t tapDelay)
427	426	@brief
428		− @param
	427	+ @param delay A pointer to the relevant tAllpassDelay.
429	428
430	429	@fn float tAllpassDelay_addTo (tAllpassDelay* const, float value, uint32_t tapDelay)
431	430	@brief
432		− @param
	431	+ @param delay A pointer to the relevant tAllpassDelay.
433	432
434	433	@fn float tAllpassDelay_tick (tAllpassDelay* const, float sample)
435	434	@brief
436		− @param
	435	+ @param delay A pointer to the relevant tAllpassDelay.
437	436
438	437	@fn float tAllpassDelay_getLastOut (tAllpassDelay* const)
439	438	@brief
440		− @param
	439	+ @param delay A pointer to the relevant tAllpassDelay.
441	440
442	441	@fn float tAllpassDelay_getLastIn (tAllpassDelay* const)
443	442	@brief
444		− @param
	443	+ @param delay A pointer to the relevant tAllpassDelay.
445	444
446	445	@} */
447	446
@@ -492,64 +491,63 @@ extern "C" { · 44 unmodified lines
492	491	@{
493	492
494	493	@fn void tTapeDelay_init (tTapeDelay* const, float delay, uint32_t maxDelay, LEAF* const leaf)
495		− @brief
496		− @param
	494	+ @brief Initialize a tTapeDelay to the default mempool of a LEAF instance.
	495	+ @param delay A pointer to the tTapeDelay to initialize.
497	496	@param leaf A pointer to the leaf instance.
498	497
499	498	@fn void tTapeDelay_initToPool (tTapeDelay* const, float delay, uint32_t maxDelay, tMempool* const)
500		− @brief
501		− @param
	499	+ @brief Initialize a tTapeDelay to a specified mempool.
	500	+ @param delay A pointer to the tTapeDelay to initialize.
502	501	@param mempool A pointer to the tMempool to use.
503	502
504	503	@fn void tTapeDelay_free (tTapeDelay* const)
505	504	@brief Free a tTapeDelay from its mempool.
506		− @param
	505	+ @param delay A pointer to the tTapeDelay to free.
507	506
508	507	@fn void tTapeDelay_clear (tTapeDelay* const)
509		− @brief
510		− @param
	508	+ @brief
	509	+ @param delay A pointer to the relevant tTapeDelay.
511	510
512	511	@fn void tTapeDelay_setDelay (tTapeDelay* const, float delay)
513	512	@brief
514		− @param
	513	+ @param delay A pointer to the relevant tTapeDelay.
515	514
516	515	@fn float tTapeDelay_getDelay (tTapeDelay* const)
517	516	@brief
518		− @param
	517	+ @param delay A pointer to the relevant tTapeDelay.
519	518
520	519	@fn void tTapeDelay_tapIn (tTapeDelay* const, float in, uint32_t tapDelay)
521	520	@brief
522		− @param
	521	+ @param delay A pointer to the relevant tTapeDelay.
523	522
524	523	@fn float tTapeDelay_tapOut (tTapeDelay* const d, float tapDelay)
525	524	@brief
526		− @param
	525	+ @param delay A pointer to the relevant tTapeDelay.
527	526
528	527	@fn float tTapeDelay_addTo (tTapeDelay* const, float value, uint32_t tapDelay)
529	528	@brief
530		− @param
	529	+ @param delay A pointer to the relevant tTapeDelay.
531	530
532	531	@fn float tTapeDelay_tick (tTapeDelay* const, float sample)
533	532	@brief
534		− @param
	533	+ @param delay A pointer to the relevant tTapeDelay.
535	534
536	535	@fn void tTapeDelay_incrementInPoint(tTapeDelay* const dl)
537	536	@brief
538		− @param
	537	+ @param delay A pointer to the relevant tTapeDelay.
539	538
540	539	@fn float tTapeDelay_getLastOut (tTapeDelay* const)
541	540	@brief
542		− @param
	541	+ @param delay A pointer to the relevant tTapeDelay.
543	542
544	543	@fn float tTapeDelay_getLastIn (tTapeDelay* const)
545	544	@brief
546		− @param
	545	+ @param delay A pointer to the relevant tTapeDelay.
547	546
548	547	@} */
549	548
550	549	typedef struct _tTapeDelay
551	550	{
552		−
553	551	tMempool mempool;
554	552
555	553	float gain;
@@ -593,42 +591,42 @@ extern "C" { · 37 unmodified lines
593	591	@{
594	592
595	593	@fn void tRingBuffer_init (tRingBuffer* const ring, int size, LEAF* const leaf)
596		− @brief
597		− @param
	594	+ @brief Initialize a tRingBuffer to the default mempool of a LEAF instance.
	595	+ @param delay A pointer to the tRingbuffer to initialize.
598	596	@param leaf A pointer to the leaf instance.
599	597
600	598	@fn void tRingBuffer_initToPool (tRingBuffer* const ring, int size, tMempool* const mempool)
601		− @brief
602		− @param
	599	+ @brief Initialize a tRingBuffer to a specified mempool.
	600	+ @param delay A pointer to the tRingbuffer to initialize.
603	601	@param mempool A pointer to the tMempool to use.
604	602
605	603	@fn void tRingBuffer_free (tRingBuffer* const ring)
606	604	@brief Free a tRingBuffer from its mempool.
607		− @param
	605	+ @param delay A pointer to the tRingBuffer to free.
608	606
609	607	@fn void tRingBuffer_push (tRingBuffer* const ring, float val)
610	608	@brief
611		− @param
	609	+ @param delay A pointer to the relevant tRingBuffer.
612	610
613	611	@fn float tRingBuffer_getNewest (tRingBuffer* const ring)
614	612	@brief
615		− @param
	613	+ @param delay A pointer to the relevant tRingBuffer.
616	614
617	615	@fn float tRingBuffer_getOldest (tRingBuffer* const ring)
618	616	@brief
619		− @param
	617	+ @param delay A pointer to the relevant tRingBuffer.
620	618
621	619	@fn float tRingBuffer_get (tRingBuffer* const ring, int index)
622	620	@brief
623		− @param
	621	+ @param delay A pointer to the relevant tRingBuffer.
624	622
625	623	@fn float tRingBuffer_clear (tRingBuffer* const ring)
626	624	@brief
627		− @param
	625	+ @param delay A pointer to the relevant tRingBuffer.
628	626
629	627	@fn int tRingBuffer_getSize (tRingBuffer* const ring)
630	628	@brief
631		− @param
	629	+ @param delay A pointer to the relevant tRingBuffer.
632	630
633	631	@} */
634	632	typedef struct _tRingBuffer

leaf/Inc/leaf-distortion.h+34−30

@@ -36,26 +36,26 @@ extern "C" { · 35 unmodified lines
36	36	@{
37	37
38	38	@fn void tSampleReducer_init (tSampleReducer* const, LEAF* const leaf)
39		− @brief
40		− @param
	39	+ @brief Initialize a tSampleReducer to the default mempool of a LEAF instance.
	40	+ @param reducer A pointer to the tSampleReducer to initialize.
41	41	@param leaf A pointer to the leaf instance.
42	42
43	43	@fn void tSampleReducer_initToPool (tSampleReducer* const, tMempool* const)
44		− @brief
45		− @param
	44	+ @brief Initialize a tSampleReducer to a specified mempool.
	45	+ @param reducer A pointer to the tSampleReducer to initialize.
46	46	@param mempool A pointer to the tMempool to use.
47	47
48	48	@fn void tSampleReducer_free (tSampleReducer* const)
49	49	@brief Free a tSampleReducer from its mempool.
50		− @param
	50	+ @param reducer A pointer to the tSampleReducer to free.
51	51
52	52	@fn float tSampleReducer_tick (tSampleReducer* const, float input)
53	53	@brief
54		− @param
	54	+ @param reducer A pointer to the relevant tSampleReducer.
55	55
56	56	@fn void tSampleReducer_setRatio (tSampleReducer* const, float ratio)
57	57	@brief
58		− @param
	58	+ @param reducer A pointer to the relevant tSampleReducer.
59	59
60	60	@} */
61	61
@@ -86,34 +86,34 @@ extern "C" { · 24 unmodified lines
86	86	@{
87	87
88	88	@fn void tOversampler_init (tOversampler* const, int order, int extraQuality, LEAF* const leaf)
89		− @brief
90		− @param
	89	+ @brief Initialize a tOversampler to the default mempool of a LEAF instance.
	90	+ @param oversampler A pointer to the tOversampler to initialize.
91	91	@param leaf A pointer to the leaf instance.
92	92
93	93	@fn void tOversampler_initToPool (tOversampler* const, int order, int extraQuality, tMempool* const)
94		− @brief
95		− @param
	94	+ @brief Initialize a tOversampler to a specified mempool.
	95	+ @param oversampler A pointer to the tOversampler to initialize.
96	96	@param mempool A pointer to the tMempool to use.
97	97
98	98	@fn void tOversampler_free (tOversampler* const)
99	99	@brief Free a tOversampler from its mempool.
100		− @param
	100	+ @param oversampler A pointer to the tOversampler to free.
101	101
102	102	@fn void tOversampler_upsample (tOversampler* const, float input, float* output)
103	103	@brief
104		− @param
	104	+ @param oversampler A pointer to the relevant tOversampler.
105	105
106	106	@fn float tOversampler_downsample (tOversampler* const os, float* input)
107	107	@brief
108		− @param
	108	+ @param oversampler A pointer to the relevant tOversampler.
109	109
110	110	@fn float tOversampler_tick (tOversampler* const, float input, float* oversample, float (*effectTick)(float))
111	111	@brief
112		− @param
	112	+ @param oversampler A pointer to the relevant tOversampler.
113	113
114	114	@fn int tOversampler_getLatency (tOversampler* const os)
115	115	@brief
116		− @param
	116	+ @param oversampler A pointer to the relevant tOversampler.
117	117
118	118	@} */
119	119
@@ -149,22 +149,22 @@ extern "C" { · 29 unmodified lines
149	149	@{
150	150
151	151	@fn void tLockhartWavefolder_init (tLockhartWavefolder* const, LEAF* const leaf)
152		− @brief
153		− @param
	152	+ @brief Initialize a tLockhartWavefolder to the default mempool of a LEAF instance.
	153	+ @param wavefolder A pointer to the tLockhartWavefolder to initialize.
154	154	@param leaf A pointer to the leaf instance.
155	155
156	156	@fn void tLockhartWavefolder_initToPool (tLockhartWavefolder* const, tMempool* const)
157		− @brief
158		− @param
	157	+ @brief Initialize a tLockhartWavefolder to a specified mempool.
	158	+ @param wavefolder A pointer to the tLockhartWavefolder to initialize.
159	159	@param mempool A pointer to the tMempool to use.
160	160
161	161	@fn void tLockhartWavefolder_free (tLockhartWavefolder* const)
162	162	@brief Free a tLockhartWavefolder from its mempool.
163		− @param
	163	+ @param wavefolder A pointer to the tLockhartWavefolder to free.
164	164
165	165	@fn float tLockhartWavefolder_tick (tLockhartWavefolder* const, float samp)
166	166	@brief
167		− @param
	167	+ @param wavefolder A pointer to the relevant tLockhartWavefolder.
168	168
169	169	@} */
170	170
@@ -217,37 +217,41 @@ extern "C" { · 46 unmodified lines
217	217	@{
218	218
219	219	@fn void tCrusher_init (tCrusher* const, LEAF* const leaf)
220		− @brief
221		− @param
	220	+ @brief Initialize a tCrusher to the default mempool of a LEAF instance.
	221	+ @param crusher A pointer to the tCrusher to initialize.
222	222	@param leaf A pointer to the leaf instance.f
223	223
224	224	@fn void tCrusher_initToPool (tCrusher* const, tMempool* const)
225		− @brief
226		− @param
	225	+ @brief Initialize a tCrusher to a specified mempool.
	226	+ @param crusher A pointer to the tCrusher to initialize.
227	227	@param mempool A pointer to the tMempool to use.
228	228
229	229	@fn void tCrusher_free (tCrusher* const)
230	230	@brief Free a tCrusher from its mempool.
231		− @param
	231	+ @param crusher A pointer to the tCrusher to free.
232	232
233	233	@fn float tCrusher_tick (tCrusher* const, float input)
234	234	@brief
235		− @param
	235	+ @param crusher A pointer to the relevant tCrusher.
236	236
237	237	@fn void tCrusher_setOperation (tCrusher* const, float op)
238	238	@brief
239		− @param 0.0 - 1.0
	239	+ @param crusher A pointer to the relevant tCrusher.
	240	+ @param operation 0.0 - 1.0
240	241
241	242	@fn void tCrusher_setQuality (tCrusher* const, float val)
242	243	@brief
243		− @param 0.0 - 1.0
	244	+ @param crusher A pointer to the relevant tCrusher.
	245	+ @param quality 0.0 - 1.0
244	246
245	247	@fn void tCrusher_setRound (tCrusher* const, float rnd)
246	248	@brief
	249	+ @param crusher A pointer to the relevant tCrusher.
247	250	@param what division to round to
248	251
249	252	@fn void tCrusher_setSamplingRatio (tCrusher* const, float ratio)
250	253	@brief
	254	+ @param crusher A pointer to the relevant tCrusher.
251	255	@param sampling ratio
252	256
253	257	@} */

leaf/Inc/leaf-dynamics.h+28−27

@@ -38,22 +38,22 @@ extern "C" { · 37 unmodified lines
38	38	@{
39	39
40	40	@fn void tCompressor_init (tCompressor* const, LEAF* const leaf)
41		− @brief
42		− @param
	41	+ @brief Initialize a tCompressor to the default mempool of a LEAF instance.
	42	+ @param compressor A pointer to the tCompressor to initialize.
43	43	@param leaf A pointer to the leaf instance.
44	44
45	45	@fn void tCompressor_initToPool (tCompressor* const, tMempool* const)
46		− @brief
47		− @param
	46	+ @brief Initialize a tCompressor to a specified mempool.
	47	+ @param compressor A pointer to the tCompressor to initialize.
48	48	@param mempool A pointer to the tMempool to use.
49	49
50	50	@fn void tCompressor_free (tCompressor* const)
51	51	@brief Free a tCompressor from its mempool.
52		− @param
	52	+ @param compressor A pointer to the tCompressor to free.
53	53
54	54	@fn float tCompressor_tick (tCompressor* const, float input)
55	55	@brief
56		− @param
	56	+ @param compressor A pointer to the relevant tCompressor.
57	57
58	58	@} */
59	59
@@ -84,46 +84,47 @@ extern "C" { · 24 unmodified lines
84	84	@defgroup tfeedbackleveler tFeedbackLeveler
85	85	@ingroup dynamics
86	86	@brief An auto VCA that you put into a feedback circuit to make it stay at the same level.
87		− @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.
	87	+ @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.
88	88	@{
89	89
90	90	@fn void tFeedbackLeveler_init (tFeedbackLeveler* const, float targetLevel, float factor, float strength, int mode, LEAF* const leaf)
91		− @brief
92		− @param
	91	+ @brief Initialize a tFeedbackLeveler to the default mempool of a LEAF instance.
	92	+ @param leveler A pointer to the tFeedbackLeveler to initialize.
93	93	@param leaf A pointer to the leaf instance.
94	94
95	95	@fn void tFeedbackLeveler_initToPool (tFeedbackLeveler* const, float targetLevel, float factor, float strength, int mode, tMempool* const)
96		− @brief
97		− @param
	96	+ @brief Initialize a tFeedbackLeveler to a specified mempool.
	97	+ @param leveler A pointer to the tFeedbackLeveler to initialize.
98	98	@param mempool A pointer to the tMempool to use.
99	99
100	100	@fn void tFeedbackLeveler_free (tFeedbackLeveler* const)
101	101	@brief Free a tFeedbackLeveler from its mempool.
102		− @param
	102	+ @param leveler A pointer to the tFeedbackLeveler to free.
103	103
104	104	@fn float tFeedbackLeveler_tick (tFeedbackLeveler* const, float input)
105	105	@brief
106		− @param
	106	+ @param leveler A pointer to the relevant tFeedbackLeveler.
107	107
108	108	@fn float tFeedbackLeveler_sample (tFeedbackLeveler* const)
109	109	@brief
110		− @param
	110	+ @param leveler A pointer to the relevant tFeedbackLeveler.
111	111
112	112	@fn void tFeedbackLeveler_setTargetLevel (tFeedbackLeveler* const, float TargetLevel)
113	113	@brief
114		− @param
	114	+ @param leveler A pointer to the relevant tFeedbackLeveler.
115	115
116	116	@fn void tFeedbackLeveler_setFactor (tFeedbackLeveler* const, float factor)
117	117	@brief
118		− @param
	118	+ @param leveler A pointer to the relevant tFeedbackLeveler.
119	119
120	120	@fn void tFeedbackLeveler_setMode (tFeedbackLeveler* const, int mode)
121	121	@brief
122		− @param 0 for upwards limiting only, 1 for biderctional limiting
	122	+ @param leveler A pointer to the relevant tFeedbackLeveler.
	123	+ @param mode 0 for upwards limiting only, 1 for biderctional limiting
123	124
124	125	@fn void tFeedbackLeveler_setStrength (tFeedbackLeveler* const, float strength)
125	126	@brief
126		− @param
	127	+ @param leveler A pointer to the relevant tFeedbackLeveler.
127	128
128	129	@} */
129	130
@@ -163,30 +164,30 @@ extern "C" { · 33 unmodified lines
163	164	@{
164	165
165	166	@fn void tThreshold_init (tThreshold* const, float low, float high, LEAF* const leaf)
166		− @brief
167		− @param
	167	+ @brief Initialize a tThreshold to the default mempool of a LEAF instance.
	168	+ @param threshold A pointer to the tThreshold to initialize.
168	169	@param leaf A pointer to the leaf instance.
169	170
170	171	@fn void tThreshold_initToPool (tThreshold* const, float low, float high, tMempool* const)
171		− @brief
172		− @param
	172	+ @brief Initialize a tThreshold to a specified mempool.
	173	+ @param threshold A pointer to the tThreshold to initialize.
173	174	@param mempool A pointer to the tMempool to use.
174	175
175	176	@fn void tThreshold_free (tThreshold* const)
176	177	@brief Free a tThreshold from its mempool.
177		− @param
	178	+ @param threshold A pointer to the tThreshold to free.
178	179
179	180	@fn int tThreshold_tick (tThreshold* const, float input)
180	181	@brief
181		− @param
	182	+ @param threshold A pointer to the relevant tThreshold.
182	183
183	184	@fn void tThreshold_setLow (tThreshold* const, float low)
184	185	@brief
185		− @param
	186	+ @param threshold A pointer to the relevant tThreshold.
186	187
187	188	@fn void tThreshold_setHigh (tThreshold* const, float high)
188	189	@brief
189		− @param
	190	+ @param threshold A pointer to the relevant tThreshold.
190	191
191	192	@} */
192	193
@@ -204,7 +205,7 @@ extern "C" { · 11 unmodified lines
204	205	void tThreshold_initToPool (tThreshold* const, float low, float high, tMempool* const);
205	206	void tThreshold_free (tThreshold* const);
206	207
207		− int tThreshold_tick (tThreshold* const, float input);
	208	+ int tThreshold_tick (tThreshold* const, float input);
208	209	void tThreshold_setLow (tThreshold* const, float low);
209	210	void tThreshold_setHigh (tThreshold* const, float high);
210	211

leaf/Inc/leaf-effects.h+104−104

@@ -31,62 +31,62 @@ extern "C" { · 30 unmodified lines
31	31	@{
32	32
33	33	@fn void tTalkbox_init (tTalkbox* const, int bufsize, LEAF* const leaf)
34		− @brief
35		− @param
	34	+ @brief Initialize a tTalkbox to the default mempool of a LEAF instance.
	35	+ @param talkbox A pointer to the tTalkbox to initialize.
36	36	@param leaf A pointer to the leaf instance.
37	37
38	38	@fn void tTalkbox_initToPool (tTalkbox* const, int bufsize, tMempool* const)
39		− @brief
40		− @param
	39	+ @brief Initialize a tTalkbox to a specified mempool.
	40	+ @param talkbox A pointer to the tTalkbox to initialize.
41	41	@param mempool A pointer to the tMempool to use.
42	42
43	43	@fn void tTalkbox_free (tTalkbox* const)
44	44	@brief Free a tTalkbox from its mempool.
45		− @param
	45	+ @param talkbox A pointer to the tTalkbox to free.
46	46
47	47	@fn float tTalkbox_tick (tTalkbox* const, float synth, float voice)
48	48	@brief
49		− @param
	49	+ @param talkbox A pointer to the relevant tTalkbox.
50	50
51	51	@fn float tTalkbox_tickFrozen (tTalkbox* const voc, float synth, float voice)
52	52	@brief
53		− @param
	53	+ @param talkbox A pointer to the relevant tTalkbox.
54	54
55	55	@fn void tTalkbox_update (tTalkbox* const)
56	56	@brief
57		− @param
	57	+ @param talkbox A pointer to the relevant tTalkbox.
58	58
59	59	@fn void tTalkbox_suspend (tTalkbox* const)
60	60	@brief
61		− @param
	61	+ @param talkbox A pointer to the relevant tTalkbox.
62	62
63	63	@fn void tTalkbox_lpcDurbin (float r, int p, float k, float *g)
64	64	@brief
65		− @param
	65	+ @param talkbox A pointer to the relevant tTalkbox.
66	66
67	67	@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)
68	68	@brief
69		− @param
	69	+ @param talkbox A pointer to the relevant tTalkbox.
70	70
71	71	@fn void tTalkbox_setQuality (tTalkbox* const, float quality)
72	72	@brief
73		− @param
	73	+ @param talkbox A pointer to the relevant tTalkbox.
74	74
75	75	@fn void tTalkbox_setWarpFactor (tTalkbox* const voc, float warp)
76	76	@brief
77		− @param
	77	+ @param talkbox A pointer to the relevant tTalkbox.
78	78
79	79	@fn void tTalkbox_setWarpOn (tTalkbox* const voc, float warpOn)
80	80	@brief
81		− @param
	81	+ @param talkbox A pointer to the relevant tTalkbox.
82	82
83	83	@fn void tTalkbox_setFreeze (tTalkbox* const voc, float freeze)
84	84	@brief
85		− @param
	85	+ @param talkbox A pointer to the relevant tTalkbox.
86	86
87	87	@fn void tTalkbox_warpedAutocorrelate (float * x, double* dl, double* Rt, unsigned int L, float * R, unsigned int P, float lambda)
88	88	@brief
89		− @param
	89	+ @param talkbox A pointer to the relevant tTalkbox.
90	90
91	91	@} */
92	92
@@ -150,62 +150,62 @@ extern "C" { · 57 unmodified lines
150	150	@{
151	151
152	152	@fn void tTalkboxFloat_init (tTalkboxFloat* const, int bufsize, LEAF* const leaf)
153		− @brief
154		− @param
	153	+ @brief Initialize a tTalkboxFloat to the default mempool of a LEAF instance.
	154	+ @param talkbox A pointer to the tTalkboxFloat to initialize.
155	155	@param leaf A pointer to the leaf instance.
156	156
157	157	@fn void tTalkboxFloat_initToPool (tTalkboxFloat* const, int bufsize, tMempool* const)
158		− @brief
159		− @param
	158	+ @brief Initialize a tTalkboxFloat to a specified mempool.
	159	+ @param talkbox A pointer to the tTalkboxFloat to initialize.
160	160	@param mempool A pointer to the tMempool to use.
161	161
162	162	@fn void tTalkboxFloat_free (tTalkboxFloat* const)
163	163	@brief Free a tTalkboxFloat from its mempool.
164		− @param
	164	+ @param talkbox A pointer to the tTalkboxFloat to free.
165	165
166	166	@fn float tTalkboxFloat_tick (tTalkboxFloat* const, float synth, float voice)
167	167	@brief
168		− @param
	168	+ @param talkbox A pointer to the relevant tTalkboxFloat.
169	169
170	170	@fn float tTalkboxFloat_tickFrozen (tTalkboxFloat* const voc, float synth, float voice)
171	171	@brief
172		− @param
	172	+ @param talkbox A pointer to the relevant tTalkboxFloat.
173	173
174	174	@fn void tTalkboxFloat_update (tTalkboxFloat* const)
175	175	@brief
176		− @param
	176	+ @param talkbox A pointer to the relevant tTalkboxFloat.
177	177
178	178	@fn void tTalkboxFloat_suspend (tTalkboxFloat* const)
179	179	@brief
180		− @param
	180	+ @param talkbox A pointer to the relevant tTalkboxFloat.
181	181
182	182	@fn void tTalkboxFloat_lpcDurbin (float r, int p, float k, float *g)
183	183	@brief
184		− @param
	184	+ @param talkbox A pointer to the relevant tTalkboxFloat.
185	185
186	186	@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)
187	187	@brief
188		− @param
	188	+ @param talkbox A pointer to the relevant tTalkboxFloat.
189	189
190	190	@fn void tTalkboxFloat_setQuality (tTalkboxFloat* const, float quality)
191	191	@brief
192		− @param
	192	+ @param talkbox A pointer to the relevant tTalkboxFloat.
193	193
194	194	@fn void tTalkboxFloat_setWarpFactor (tTalkboxFloat* const voc, float warp)
195	195	@brief
196		− @param
	196	+ @param talkbox A pointer to the relevant tTalkboxFloat.
197	197
198	198	@fn void tTalkboxFloat_setWarpOn (tTalkboxFloat* const voc, float warpOn)
199	199	@brief
200		− @param
	200	+ @param talkbox A pointer to the relevant tTalkboxFloat.
201	201
202	202	@fn void tTalkboxFloat_setFreeze (tTalkboxFloat* const voc, float freeze)
203	203	@brief
204		− @param
	204	+ @param talkbox A pointer to the relevant tTalkboxFloat.
205	205
206	206	@fn void tTalkboxFloat_warpedAutocorrelate (float * x, float* dl, float* Rt, unsigned int L, float * R, unsigned int P, float lambda)
207	207	@brief
208		− @param
	208	+ @param talkbox A pointer to the relevant tTalkboxFloat.
209	209
210	210	@} */
211	211
@@ -264,30 +264,30 @@ extern "C" { · 52 unmodified lines
264	264	@{
265	265
266	266	@fn void tVocoder_init (tVocoder* const, LEAF* const leaf)
267		− @brief
268		− @param
	267	+ @brief Initialize a tVocoder to the default mempool of a LEAF instance.
	268	+ @param vocoder A pointer to the tVocoder to initialize.
269	269	@param leaf A pointer to the leaf instance.
270	270
271	271	@fn void tVocoder_initToPool (tVocoder* const, tMempool* const)
272		− @brief
273		− @param
	272	+ @brief Initialize a tVocoder to a specified mempool.
	273	+ @param vocoder A pointer to the tVocoder to initialize.
274	274	@param mempool A pointer to the tMempool to use.
275	275
276	276	@fn void tVocoder_free (tVocoder* const)
277	277	@brief Free a tVocoder from its mempool.
278		− @param
	278	+ @param vocoder A pointer to the tVocoder to free.
279	279
280	280	@fn float tVocoder_tick (tVocoder* const, float synth, float voice)
281	281	@brief
282		− @param
	282	+ @param vocoder A pointer to the relevant tVocoder.
283	283
284	284	@fn void tVocoder_update (tVocoder* const)
285	285	@brief
286		− @param
	286	+ @param vocoder A pointer to the relevant tVocoder.
287	287
288	288	@fn void tVocoder_suspend (tVocoder* const)
289	289	@brief
290		− @param
	290	+ @param vocoder A pointer to the relevant tVocoder.
291	291
292	292	@} */
293	293
@@ -331,42 +331,42 @@ extern "C" { · 37 unmodified lines
331	331	@{
332	332
333	333	@fn void tRosenbergGlottalPulse_init (tRosenbergGlottalPulse* const, LEAF* const leaf)
334		− @brief
335		− @param
	334	+ @brief Initialize a tRosenbergGlottalPulse to the default mempool of a LEAF instance.
	335	+ @param pulse A pointer to the tRosenbergGlottalPulse to initialize.
336	336	@param leaf A pointer to the leaf instance.
337	337
338	338	@fn void tRosenbergGlottalPulse_initToPool (tRosenbergGlottalPulse* const, tMempool* const)
339		− @brief
340		− @param
	339	+ @brief Initialize a tRosenbergGlottalPulse to a specified mempool.
	340	+ @param pulse A pointer to the tRosenbergGlottalPulse to initialize.
341	341	@param mempool A pointer to the tMempool to use.
342	342
343	343	@fn void tRosenbergGlottalPulse_free (tRosenbergGlottalPulse* const)
344	344	@brief Free a tRosenbergGlottalPulse from its mempool.
345		− @param
	345	+ @param pulse A pointer to the tRosenbergGlottalPulse to free.
346	346
347	347	@fn float tRosenbergGlottalPulse_tick (tRosenbergGlottalPulse* const)
348	348	@brief
349		− @param
	349	+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
350	350
351	351	@fn float tRosenbergGlottalPulse_tickHQ (tRosenbergGlottalPulse* const gp)
352	352	@brief
353		− @param
	353	+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
354	354
355	355	@fn void tRosenbergGlottalPulse_setFreq (tRosenbergGlottalPulse* const, float freq)
356	356	@brief
357		− @param
	357	+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
358	358
359	359	@fn void tRosenbergGlottalPulse_setOpenLength (tRosenbergGlottalPulse* const, float openLength)
360	360	@brief
361		− @param
	361	+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
362	362
363	363	@fn void tRosenbergGlottalPulse_setPulseLength (tRosenbergGlottalPulse* const, float pulseLength)
364	364	@brief
365		− @param
	365	+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
366	366
367	367	@fn void tRosenbergGlottalPulse_setOpenLengthAndPulseLength (tRosenbergGlottalPulse* const gp, float openLength, float pulseLength)
368	368	@brief
369		− @param
	369	+ @param pulse A pointer to the relevant tRosenbergGlottalPulse.
370	370
371	371	@} */
372	372
@@ -405,38 +405,38 @@ extern "C" { · 32 unmodified lines
405	405	@{
406	406
407	407	@fn void tSOLAD_init (tSOLAD* const, LEAF* const leaf)
408		− @brief
409		− @param
	408	+ @brief Initialize a tSOLAD to the default mempool of a LEAF instance.
	409	+ @param solad A pointer to the tSOLAD to initialize.
410	410	@param leaf A pointer to the leaf instance.
411	411
412	412	@fn void tSOLAD_initToPool (tSOLAD* const, tMempool* const)
413		− @brief
414		− @param
	413	+ @brief Initialize a tSOLAD to a specified mempool.
	414	+ @param solad A pointer to the tSOLAD to initialize.
415	415	@param mempool A pointer to the tMempool to use.
416	416
417	417	@fn void tSOLAD_free (tSOLAD* const)
418	418	@brief Free a tSOLAD from its mempool.
419		− @param
	419	+ @param solad A pointer to the tSOLAD to free.
420	420
421	421	@fn void tSOLAD_ioSamples (tSOLAD w, float in, float* out, int blocksize)
422		− @brief send one block of input samples, receive one block of output samples
423		− @param
	422	+ @brief Send one block of input samples, receive one block of output samples
	423	+ @param solad A pointer to the relevant tSOLAD.
424	424
425	425	@fn void tSOLAD_setPeriod (tSOLAD *w, float period)
426		− @brief set periodicity analysis data
427		− @param
	426	+ @brief Set periodicity analysis data
	427	+ @param solad A pointer to the relevant tSOLAD.
428	428
429	429	@fn void tSOLAD_setPitchFactor (tSOLAD *w, float pitchfactor)
430		− @brief set pitch factor between 0.25 and 4
431		− @param
	430	+ @brief Set pitch factor between 0.25 and 4
	431	+ @param solad A pointer to the relevant tSOLAD.
432	432
433	433	@fn void tSOLAD_setReadLag (tSOLAD *w, float readlag)
434		− @brief force readpointer lag
435		− @param
	434	+ @brief Force readpointer lag
	435	+ @param solad A pointer to the relevant tSOLAD.
436	436
437	437	@fn void tSOLAD_resetState (tSOLAD *w)
438		− @brief reset state variables
439		− @param
	438	+ @brief Reset state variables
	439	+ @param solad A pointer to the relevant tSOLAD.
440	440
441	441	@} */
442	442
@@ -492,34 +492,34 @@ extern "C" { · 49 unmodified lines
492	492	@{
493	493
494	494	@fn void tPitchShift_init (tPitchShift* const, tPeriodDetection* const, float* out, int bufSize, LEAF* const leaf)
495		− @brief
496		− @param
	495	+ @brief Initialize a tPitchShift to the default mempool of a LEAF instance.
	496	+ @param pitchshift A pointer to the tPitchShift to initialize.
497	497	@param leaf A pointer to the leaf instance.
498	498
499	499	@fn void tPitchShift_initToPool (tPitchShift* const, tPeriodDetection* const, float* out, int bufSize, tMempool* const)
500		− @brief
501		− @param
	500	+ @brief Initialize a tPitchShift to a specified mempool.
	501	+ @param pitchshift A pointer to the tPitchShift to initialize.
502	502	@param mempool A pointer to the tMempool to use.
503	503
504	504	@fn void tPitchShift_free (tPitchShift* const)
505	505	@brief Free a tPitchShift from its mempool.
506		− @param
	506	+ @param pitchshift A pointer to the tPitchShift to free.
507	507
508	508	@fn float tPitchShift_shift (tPitchShift* const)
509	509	@brief
510		− @param
	510	+ @param pitchshift A pointer to the relevant tPitchShift.
511	511
512	512	@fn float tPitchShift_shiftToFunc (tPitchShift* const, float (*fun)(float))
513	513	@brief
514		− @param
	514	+ @param pitchshift A pointer to the relevant tPitchShift.
515	515
516	516	@fn float tPitchShift_shiftToFreq (tPitchShift* const, float freq)
517	517	@brief
518		− @param
	518	+ @param pitchshift A pointer to the relevant tPitchShift.
519	519
520	520	@fn void tPitchShift_setPitchFactor (tPitchShift* const, float pf)
521	521	@brief
522		− @param
	522	+ @param pitchshift A pointer to the relevant tPitchShift.
523	523
524	524	@} */
525	525
@@ -556,34 +556,34 @@ extern "C" { · 30 unmodified lines
556	556	@{
557	557
558	558	@fn void tSimpleRetune_init (tSimpleRetune* const, int numVoices, int bufSize, int frameSize, LEAF* const leaf)
559		− @brief
560		− @param
	559	+ @brief Initialize a tSimpleRetune to the default mempool of a LEAF instance.
	560	+ @param retune A pointer to the tSimpleRetune to initialize.
561	561	@param leaf A pointer to the leaf instance.
562	562
563	563	@fn void tSimpleRetune_initToPool (tSimpleRetune* const, int numVoices, int bufSize, int frameSize, tMempool* const)
564		− @brief
565		− @param
	564	+ @brief Initialize a tSimpleRetune to a specified mempool.
	565	+ @param retune A pointer to the tSimpleRetune to initialize.
566	566	@param mempool A pointer to the tMempool to use.
567	567
568	568	@fn void tSimpleRetune_free (tSimpleRetune* const)
569	569	@brief Free a tSimpleRetune from its mempool.
570		− @param
	570	+ @param retune A pointer to the tSimpleRetune to free.
571	571
572	572	@fn float* tSimpleRetune_tick (tSimpleRetune* const, float sample)
573	573	@brief
574		− @param
	574	+ @param retune A pointer to the relevant tSimpleRetune.
575	575
576	576	@fn void tSimpleRetune_setNumVoices (tSimpleRetune* const, int numVoices)
577	577	@brief
578		− @param
	578	+ @param retune A pointer to the relevant tSimpleRetune.
579	579
580	580	@fn void tSimpleRetune_tuneVoices (tSimpleRetune* const, float f)
581	581	@brief
582		− @param
	582	+ @param retune A pointer to the relevant tSimpleRetune.
583	583
584	584	@fn void tSimpleRetune_tuneVoice (tSimpleRetune* const, float f, int voice)
585	585	@brief
586		− @param
	586	+ @param retune A pointer to the relevant tSimpleRetune.
587	587
588	588	@} */
589	589
@@ -628,34 +628,34 @@ extern "C" { · 38 unmodified lines
628	628	@{
629	629
630	630	@fn void tRetune_init (tRetune* const, int numVoices, int bufSize, int frameSize, LEAF* const leaf)
631		− @brief
632		− @param
	631	+ @brief Initialize a tRetune to the default mempool of a LEAF instance.
	632	+ @param retune A pointer to the tRetune to initialize.
633	633	@param leaf A pointer to the leaf instance.
634	634
635	635	@fn void tRetune_initToPool (tRetune* const, int numVoices, int bufSize, int frameSize, tMempool* const)
636		− @brief
637		− @param
	636	+ @brief Initialize a tRetune to a specified mempool.
	637	+ @param retune A pointer to the tRetune to initialize.
638	638	@param mempool A pointer to the tMempool to use.
639	639
640	640	@fn void tRetune_free (tRetune* const)
641	641	@brief Free a tRetune from its mempool.
642		− @param
	642	+ @param retune A pointer to the tRetune to free.
643	643
644	644	@fn float* tRetune_tick (tRetune* const, float sample)
645	645	@brief
646		− @param
	646	+ @param retune A pointer to the relevant tRetune.
647	647
648	648	@fn void tRetune_setNumVoices (tRetune* const, int numVoices)
649	649	@brief
650		− @param
	650	+ @param retune A pointer to the relevant tRetune.
651	651
652	652	@fn void tRetune_setPitchFactors (tRetune* const, float pf)
653	653	@brief
654		− @param
	654	+ @param retune A pointer to the relevant tRetune.
655	655
656	656	@fn void tRetune_setPitchFactor (tRetune* const, float pf, int voice)
657	657	@brief
658		− @param
	658	+ @param retune A pointer to the relevant tRetune.
659	659
660	660	@} */
661	661
@@ -705,42 +705,42 @@ extern "C" { · 43 unmodified lines
705	705	@{
706	706
707	707	@fn void tFormantShifter_init (tFormantShifter* const, int order, LEAF* const leaf)
708		− @brief
709		− @param
	708	+ @brief Initialize a tFormantShifter to the default mempool of a LEAF instance.
	709	+ @param formant A pointer to the tFormantShifter to initialize.
710	710	@param leaf A pointer to the leaf instance.
711	711
712	712	@fn void tFormantShifter_initToPool (tFormantShifter* const, int order, tMempool* const)
713		− @brief
714		− @param
	713	+ @brief Initialize a tFormantShifter to a specified mempool.
	714	+ @param formant A pointer to the tFormantShifter to initialize.
715	715	@param mempool A pointer to the tMempool to use.
716	716
717	717	@fn void tFormantShifter_free (tFormantShifter* const)
718	718	@brief Free a tFormantShifter from its mempool.
719		− @param
	719	+ @param formant A pointer to the tFormantShifter to free.
720	720
721	721	@fn float tFormantShifter_tick (tFormantShifter* const, float input)
722	722	@brief
723		− @param
	723	+ @param formant A pointer to the relevant tFormantShifter.
724	724
725	725	@fn float tFormantShifter_remove (tFormantShifter* const, float input)
726	726	@brief
727		− @param
	727	+ @param formant A pointer to the relevant tFormantShifter.
728	728
729	729	@fn float tFormantShifter_add (tFormantShifter* const, float input)
730	730	@brief
731		− @param
	731	+ @param formant A pointer to the relevant tFormantShifter.
732	732
733	733	@fn void tFormantShifter_ioSamples (tFormantShifter* const, float* in, float* out, int size, float fwarp)
734	734	@brief
735		− @param
	735	+ @param formant A pointer to the relevant tFormantShifter.
736	736
737	737	@fn void tFormantShifter_setShiftFactor (tFormantShifter* const, float shiftFactor)
738	738	@brief
739		− @param
	739	+ @param formant A pointer to the relevant tFormantShifter.
740	740
741	741	@fn void tFormantShifter_setIntensity (tFormantShifter* const, float intensity)
742	742	@brief
743		− @param
	743	+ @param formant A pointer to the relevant tFormantShifter.
744	744
745	745	@} */
746	746

leaf/Inc/leaf-electrical.h+16−16

@@ -35,59 +35,59 @@ extern "C" { · 34 unmodified lines
35	35	@{
36	36
37	37	@fn void tWDF_init (tWDF* const, WDFComponentType type, float value, tWDF* const rL, tWDF* const rR, LEAF* const leaf)
38		− @brief
39		− @param
	38	+ @brief Initialize a tWDF to the default mempool of a LEAF instance.
	39	+ @param wdf A pointer to the tWDF to initialize.
40	40	@param leaf A pointer to the leaf instance.
41	41
42	42	@fn void tWDF_initToPool (tWDF* const, WDFComponentType type, float value, tWDF* const rL, tWDF* const rR, tMempool* const)
43		− @brief
44		− @param
	43	+ @brief Initialize a tWDF to a specified mempool.
	44	+ @param wdf A pointer to the tWDF to initialize.
45	45	@param mempool A pointer to the tMempool to use.
46	46
47	47	@fn void tWDF_free (tWDF* const)
48	48	@brief Free a tWDF from its mempool.
49		− @param
	49	+ @param wdf A pointer to the tWDF to free.
50	50
51	51	@fn float tWDF_tick (tWDF* const, float sample, tWDF* const outputPoint, uint8_t paramsChanged)
52	52	@brief
53		− @param
	53	+ @param wdf A pointer to the relevant tWDF.
54	54
55	55	@fn void tWDF_setValue (tWDF* const, float value)
56	56	@brief
57		− @param
	57	+ @param wdf A pointer to the relevant tWDF.
58	58
59	59	@fn void tWDF_setSampleRate (tWDF* const, float sample_rate)
60	60	@brief
61		− @param
	61	+ @param wdf A pointer to the relevant tWDF.
62	62
63	63	@fn uint8_t tWDF_isLeaf (tWDF* const)
64	64	@brief
65		− @param
	65	+ @param wdf A pointer to the relevant tWDF.
66	66
67	67	@fn float tWDF_getPortResistance (tWDF* const)
68	68	@brief
69		− @param
	69	+ @param wdf A pointer to the relevant tWDF.
70	70
71	71	@fn float tWDF_getReflectedWaveUp (tWDF* const, float input)
72	72	@brief
73		− @param
	73	+ @param wdf A pointer to the relevant tWDF.
74	74
75	75	@fn float tWDF_getReflectedWaveDown (tWDF* const, float input, float incident_wave)
76	76	@brief
77		− @param
	77	+ @param wdf A pointer to the relevant tWDF.
78	78
79	79	@fn void tWDF_setIncidentWave (tWDF* const, float incident_wave, float input)
80	80	@brief
81		− @param
	81	+ @param wdf A pointer to the relevant tWDF.
82	82
83	83	@fn float tWDF_getVoltage (tWDF* const)
84	84	@brief
85		− @param
	85	+ @param wdf A pointer to the relevant tWDF.
86	86
87	87	@fn float tWDF_getCurrent (tWDF* const)
88	88	@brief
89		− @param
90		−
	89	+ @param wdf A pointer to the relevant tWDF.
	90	+
91	91	@} */
92	92
93	93	typedef enum WDFComponentType

leaf/Inc/leaf-envelopes.h+106−106

@@ -41,38 +41,38 @@ extern "C" { · 40 unmodified lines
41	41	@{
42	42
43	43	@fn void tEnvelope_init (tEnvelope* const, float attack, float decay, int loop, LEAF* const leaf)
44		− @brief
45		− @param
	44	+ @brief Initialize a tEnvelope to the default mempool of a LEAF instance.
	45	+ @param envelope A pointer to the tEnvelope to initialize.
46	46	@param leaf A pointer to the leaf instance.
47	47
48	48	@fn void tEnvelope_initToPool (tEnvelope* const, float attack, float decay, int loop, tMempool* const)
49		− @brief
50		− @param
	49	+ @brief Initialize a tEnvelope to a specified mempool.
	50	+ @param envelope A pointer to the tEnvelope to initialize.
51	51	@param mempool A pointer to the tMempool to use.
52	52
53	53	@fn void tEnvelope_free (tEnvelope* const)
54	54	@brief Free a tEnvelope from its mempool.
55		− @param
	55	+ @param envelope A pointer to the tEnvelope to free.
56	56
57	57	@fn float tEnvelope_tick (tEnvelope* const)
58	58	@brief
59		− @param
	59	+ @param envelope A pointer to the relevant tEnvelope.
60	60
61	61	@fn void tEnvelope_setAttack (tEnvelope* const, float attack)
62	62	@brief
63		− @param
	63	+ @param envelope A pointer to the relevant tEnvelope.
64	64
65	65	@fn void tEnvelope_setDecay (tEnvelope* const, float decay)
66	66	@brief
67		− @param
	67	+ @param envelope A pointer to the relevant tEnvelope.
68	68
69	69	@fn void tEnvelope_loop (tEnvelope* const, int loop)
70	70	@brief
71		− @param
	71	+ @param envelope A pointer to the relevant tEnvelope.
72	72
73	73	@fn void tEnvelope_on (tEnvelope* const, float velocity)
74	74	@brief
75		− @param
	75	+ @param envelope A pointer to the relevant tEnvelope.
76	76
77	77	@} */
78	78
@@ -121,42 +121,42 @@ extern "C" { · 42 unmodified lines
121	121	@{
122	122
123	123	@fn void tExpSmooth_init (tExpSmooth* const, float val, float factor, LEAF* const leaf)
124		− @brief
125		− @param
	124	+ @brief Initialize a tExpSmooth to the default mempool of a LEAF instance.
	125	+ @param smooth A pointer to the tExpSmooth to initialize.
126	126	@param leaf A pointer to the leaf instance.
127	127
128	128	@fn void tExpSmooth_initToPool (tExpSmooth* const, float val, float factor, tMempool* const)
129		− @brief
130		− @param
	129	+ @brief Initialize a tExpSmooth to a specified mempool.
	130	+ @param smooth A pointer to the tExpSmooth to initialize.
131	131	@param mempool A pointer to the tMempool to use.
132	132
133	133	@fn void tExpSmooth_free (tExpSmooth* const)
134	134	@brief Free a tExpSmooth from its mempool.
135		− @param
	135	+ @param smooth A pointer to the tExpSmooth to free.
136	136
137	137	@fn float tExpSmooth_tick (tExpSmooth* const)
138	138	@brief
139		− @param
	139	+ @param smooth A pointer to the relevant tExpSmooth.
140	140
141	141	@fn float tExpSmooth_sample (tExpSmooth* const)
142	142	@brief
143		− @param
	143	+ @param smooth A pointer to the relevant tExpSmooth.
144	144
145	145	@fn void tExpSmooth_setFactor (tExpSmooth* const, float factor)
146	146	@brief
147		− @param
	147	+ @param smooth A pointer to the relevant tExpSmooth.
148	148
149	149	@fn void tExpSmooth_setDest (tExpSmooth* const, float dest)
150	150	@brief
151		− @param
	151	+ @param smooth A pointer to the relevant tExpSmooth.
152	152
153	153	@fn void tExpSmooth_setVal (tExpSmooth* const, float val)
154	154	@brief
155		− @param
	155	+ @param smooth A pointer to the relevant tExpSmooth.
156	156
157	157	@fn void tExpSmooth_setValAndDest(tExpSmooth* const expsmooth, float val)
158	158	@brief
159		− @param
	159	+ @param smooth A pointer to the relevant tExpSmooth.
160	160
161	161	@} */
162	162
@@ -193,50 +193,50 @@ extern "C" { · 30 unmodified lines
193	193	@{
194	194
195	195	@fn void tADSR_init (tADSR* const adsrenv, float attack, float decay, float sustain, float release, LEAF* const leaf)
196		− @brief
197		− @param
	196	+ @brief Initialize a tADSR to the default mempool of a LEAF instance.
	197	+ @param adsr A pointer to the tADSR to initialize.
198	198	@param leaf A pointer to the leaf instance.
199	199
200	200	@fn void tADSR_initToPool (tADSR* const adsrenv, float attack, float decay, float sustain, float release, tMempool* const mp)
201		− @brief
202		− @param
	201	+ @brief Initialize a tADSR to a specified mempool.
	202	+ @param adsr A pointer to the tADSR to initialize.
203	203	@param mempool A pointer to the tMempool to use.
204	204
205	205	@fn void tADSR_free (tADSR* const)
206	206	@brief Free a tADSR from its mempool.
207		− @param
	207	+ @param adsr A pointer to the tADSR to free.
208	208
209	209	@fn float tADSR_tick (tADSR* const)
210	210	@brief
211		− @param
	211	+ @param adsr A pointer to the relevant tADSR.
212	212
213	213	@fn void tADSR_setAttack (tADSR* const, float attack)
214	214	@brief
215		− @param
	215	+ @param adsr A pointer to the relevant tADSR.
216	216
217	217	@fn void tADSR_setDecay (tADSR* const, float decay)
218	218	@brief
219		− @param
	219	+ @param adsr A pointer to the relevant tADSR.
220	220
221	221	@fn void tADSR_setSustain (tADSR* const, float sustain)
222	222	@brief
223		− @param
	223	+ @param adsr A pointer to the relevant tADSR.
224	224
225	225	@fn void tADSR_setRelease (tADSR* const, float release)
226	226	@brief
227		− @param
	227	+ @param adsr A pointer to the relevant tADSR.
228	228
229	229	@fn void tADSR_setLeakFactor (tADSR* const, float leakFactor)
230	230	@brief
231		− @param
	231	+ @param adsr A pointer to the relevant tADSR.
232	232
233	233	@fn void tADSR_on (tADSR* const, float velocity)
234	234	@brief
235		− @param
	235	+ @param adsr A pointer to the relevant tADSR.
236	236
237	237	@fn void tADSR_off (tADSR* const)
238	238	@brief
239		− @param
	239	+ @param adsr A pointer to the relevant tADSR.
240	240
241	241	@} */
242	242
@@ -287,50 +287,50 @@ extern "C" { · 44 unmodified lines
287	287	@{
288	288
289	289	@fn void tADSR2_init (tADSR2* const, float attack, float decay, float sustain, float release, LEAF* const leaf)
290		− @brief
291		− @param
	290	+ @brief Initialize a tADSR2 to the default mempool of a LEAF instance.
	291	+ @param adsr A pointer to the tADSR2 to initialize.
292	292	@param leaf A pointer to the leaf instance.
293	293
294	294	@fn void tADSR2_initToPool (tADSR2* const, float attack, float decay, float sustain, float release, tMempool* const)
295		− @brief
296		− @param
	295	+ @brief Initialize a tADSR2 to a specified mempool.
	296	+ @param adsr A pointer to the tADSR2 to initialize.
297	297	@param mempool A pointer to the tMempool to use.
298	298
299	299	@fn void tADSR2_free (tADSR2* const)
300	300	@brief Free a tADSR2 from its mempool.
301		− @param
	301	+ @param adsr A pointer to the tADSR2 to free.
302	302
303	303	@fn float tADSR2_tick (tADSR2* const)
304	304	@brief
305		− @param
306		−
	305	+ @param adsr A pointer to the relevant tADSR2.
	306	+
307	307	@fn void tADSR2_setAttack (tADSR2* const, float attack)
308	308	@brief
309		− @param
	309	+ @param adsr A pointer to the relevant tADSR2.
310	310
311	311	@fn void tADSR2_setDecay (tADSR2* const, float decay)
312	312	@brief
313		− @param
	313	+ @param adsr A pointer to the relevant tADSR2.
314	314
315	315	@fn void tADSR2_setSustain (tADSR2* const, float sustain)
316	316	@brief
317		− @param
	317	+ @param adsr A pointer to the relevant tADSR2.
318	318
319	319	@fn void tADSR2_setRelease (tADSR2* const, float release)
320	320	@brief
321		− @param
	321	+ @param adsr A pointer to the relevant tADSR2.
322	322
323	323	@fn void tADSR2_setLeakFactor (tADSR2* const, float leakFactor)
324	324	@brief
325		− @param
	325	+ @param adsr A pointer to the relevant tADSR2.
326	326
327	327	@fn void tADSR2_on (tADSR2* const, float velocity)
328	328	@brief
329		− @param
	329	+ @param adsr A pointer to the relevant tADSR2.
330	330
331	331	@fn void tADSR2_off (tADSR2* const)
332	332	@brief
333		− @param
	333	+ @param adsr A pointer to the relevant tADSR2.
334	334
335	335	@} */
336	336
@@ -383,50 +383,50 @@ extern "C" { · 46 unmodified lines
383	383	@{
384	384
385	385	@fn void tADSR3_init (tADSR3* const, float attack, float decay, float sustain, float release, LEAF* const leaf)
386		− @brief
387		− @param
	386	+ @brief Initialize a tADSR3 to the default mempool of a LEAF instance.
	387	+ @param adsr A pointer to the tADSR3 to initialize.
388	388	@param leaf A pointer to the leaf instance.
389	389
390	390	@fn void tADSR3_initToPool (tADSR3* const, float attack, float decay, float sustain, float release, tMempool* const)
391		− @brief
392		− @param
	391	+ @brief Initialize a tADSR3 to a specified mempool.
	392	+ @param adsr A pointer to the tADSR3 to initialize.
393	393	@param mempool A pointer to the tMempool to use.
394	394
395	395	@fn void tADSR3_free (tADSR3* const)
396	396	@brief Free a tADSR3 from its mempool.
397		− @param
	397	+ @param adsr A pointer to the tADSR3 to free.
398	398
399	399	@fn float tADSR3_tick (tADSR3* const)
400	400	@brief
401		− @param
	401	+ @param adsr A pointer to the relevant tADSR3.
402	402
403	403	@fn void tADSR3_setAttack (tADSR3* const, float attack)
404	404	@brief
405		− @param
	405	+ @param adsr A pointer to the relevant tADSR3.
406	406
407	407	@fn void tADSR3_setDecay (tADSR3* const, float decay)
408	408	@brief
409		− @param
	409	+ @param adsr A pointer to the relevant tADSR3.
410	410
411	411	@fn void tADSR3_setSustain (tADSR3* const, float sustain)
412	412	@brief
413		− @param
	413	+ @param adsr A pointer to the relevant tADSR3.
414	414
415	415	@fn void tADSR3_setRelease (tADSR3* const, float release)
416	416	@brief
417		− @param
	417	+ @param adsr A pointer to the relevant tADSR3.
418	418
419	419	@fn void tADSR3_setLeakFactor (tADSR3* const, float leakFactor)
420	420	@brief
421		− @param
	421	+ @param adsr A pointer to the relevant tADSR3.
422	422
423	423	@fn void tADSR3_on (tADSR3* const, float velocity)
424	424	@brief
425		− @param
	425	+ @param adsr A pointer to the relevant tADSR3.
426	426
427	427	@fn void tADSR3_off (tADSR3* const)
428	428	@brief
429		− @param
	429	+ @param adsr A pointer to the relevant tADSR3.
430	430
431	431	@} */
432	432
@@ -490,54 +490,54 @@ extern "C" { · 57 unmodified lines
490	490	@{
491	491
492	492	@fn void tADSR4_init (tADSR4* const, float attack, float decay, float sustain, float release, float* expBuffer, int bufferSize, LEAF* const leaf)
493		− @brief
494		− @param
	493	+ @brief Initialize a tADSR4 to the default mempool of a LEAF instance.
	494	+ @param adsr A pointer to the tADSR4 to initialize.
495	495	@param leaf A pointer to the leaf instance.
496	496
497	497	@fn void tADSR4_initToPool (tADSR4* const, float attack, float decay, float sustain, float release, float* expBuffer, int bufferSize, tMempool* const)
498		− @brief
499		− @param
	498	+ @brief Initialize a tADSR4 to a specified mempool.
	499	+ @param adsr A pointer to the tADSR4 to initialize.
500	500	@param mempool A pointer to the tMempool to use.
501	501
502	502	@fn void tADSR4_free (tADSR4* const)
503	503	@brief Free a tADSR4 from its mempool.
504		− @param
	504	+ @param adsr A pointer to the tADSR4 to free.
505	505
506	506	@fn float tADSR4_tick (tADSR4* const)
507	507	@brief
508		− @param
	508	+ @param adsr A pointer to the relevant tADSR4.
509	509
510	510	@fn float tADSR4_tickNoInterp (tADSR4* const adsrenv)
511	511	@brief
512		− @param
	512	+ @param adsr A pointer to the relevant tADSR4.
513	513
514	514	@fn void tADSR4_setAttack (tADSR4* const, float attack)
515	515	@brief
516		− @param
	516	+ @param adsr A pointer to the relevant tADSR4.
517	517
518	518	@fn void tADSR4_setDecay (tADSR4* const, float decay)
519	519	@brief
520		− @param
	520	+ @param adsr A pointer to the relevant tADSR4.
521	521
522	522	@fn void tADSR4_setSustain (tADSR4* const, float sustain)
523	523	@brief
524		− @param
	524	+ @param adsr A pointer to the relevant tADSR4.
525	525
526	526	@fn void tADSR4_setRelease (tADSR4* const, float release)
527	527	@brief
528		− @param
	528	+ @param adsr A pointer to the relevant tADSR4.
529	529
530	530	@fn void tADSR4_setLeakFactor (tADSR4* const, float leakFactor)
531	531	@brief
532		− @param
	532	+ @param adsr A pointer to the relevant tADSR4.
533	533
534	534	@fn void tADSR4_on (tADSR4* const, float velocity)
535	535	@brief
536		− @param
	536	+ @param adsr A pointer to the relevant tADSR4.
537	537
538	538	@fn void tADSR4_off (tADSR4* const)
539	539	@brief
540		− @param
	540	+ @param adsr A pointer to the relevant tADSR4.
541	541
542	542	@} */
543	543
@@ -587,38 +587,38 @@ extern "C" { · 43 unmodified lines
587	587	@{
588	588
589	589	@fn void tRamp_init (tRamp* const, float time, int samplesPerTick, LEAF* const leaf)
590		− @brief
591		− @param
	590	+ @brief Initialize a tRamp to the default mempool of a LEAF instance.
	591	+ @param ramp A pointer to the tRamp to initialize.
592	592	@param leaf A pointer to the leaf instance.
593	593
594	594	@fn void tRamp_initToPool (tRamp* const, float time, int samplesPerTick, tMempool* const)
595		− @brief
596		− @param
	595	+ @brief Initialize a tRamp to a specified mempool.
	596	+ @param ramp A pointer to the tRamp to initialize.
597	597	@param mempool A pointer to the tMempool to use.
598	598
599	599	@fn void tRamp_free (tRamp* const)
600	600	@brief Free a tRamp from its mempool.
601		− @param
	601	+ @param ramp A pointer to the tRamp to free.
602	602
603	603	@fn float tRamp_tick (tRamp* const)
604	604	@brief
605		− @param
	605	+ @param ramp A pointer to the relevant tRamp.
606	606
607	607	@fn float tRamp_sample (tRamp* const)
608	608	@brief
609		− @param
	609	+ @param ramp A pointer to the relevant tRamp.
610	610
611	611	@fn void tRamp_setTime (tRamp* const, float time)
612	612	@brief
613		− @param
	613	+ @param ramp A pointer to the relevant tRamp.
614	614
615	615	@fn void tRamp_setDest (tRamp* const, float dest)
616	616	@brief
617		− @param
	617	+ @param ramp A pointer to the relevant tRamp.
618	618
619	619	@fn void tRamp_setVal (tRamp* const, float val)
620	620	@brief
621		− @param
	621	+ @param ramp A pointer to the relevant tRamp.
622	622
623	623	@} */
624	624
@@ -654,42 +654,42 @@ extern "C" { · 29 unmodified lines
654	654	@{
655	655
656	656	@fn void tRampUpDown_init (tRampUpDown* const, float upTime, float downTime, int samplesPerTick, LEAF* const leaf)
657		− @brief
658		− @param
	657	+ @brief Initialize a tRampUpDown to the default mempool of a LEAF instance.
	658	+ @param ramp A pointer to the tRampUpDown to initialize.
659	659	@param leaf A pointer to the leaf instance.
660	660
661	661	@fn void tRampUpDown_initToPool (tRampUpDown* const, float upTime, float downTime, int samplesPerTick, tMempool* const)
662		− @brief
663		− @param
	662	+ @brief Initialize a tRampUpDown to a specified mempool.
	663	+ @param ramp A pointer to the tRampUpDown to initialize.
664	664	@param mempool A pointer to the tMempool to use.
665	665
666	666	@fn void tRampUpDown_free (tRampUpDown* const)
667	667	@brief Free a tRampUpDown from its mempool.
668		− @param
	668	+ @param ramp A pointer to the tRampUpDown to free.
669	669
670	670	@fn float tRampUpDown_tick (tRampUpDown* const)
671	671	@brief
672		− @param
	672	+ @param ramp A pointer to the relevant tRampUpDown.
673	673
674	674	@fn float tRampUpDown_sample (tRampUpDown* const)
675	675	@brief
676		− @param
	676	+ @param ramp A pointer to the relevant tRampUpDown.
677	677
678	678	@fn void tRampUpDown_setUpTime (tRampUpDown* const, float upTime)
679	679	@brief
680		− @param
	680	+ @param ramp A pointer to the relevant tRampUpDown.
681	681
682	682	@fn void tRampUpDown_setDownTime (tRampUpDown* const, float downTime)
683	683	@brief
684		− @param
	684	+ @param ramp A pointer to the relevant tRampUpDown.
685	685
686	686	@fn void tRampUpDown_setDest (tRampUpDown* const, float dest)
687	687	@brief
688		− @param
	688	+ @param ramp A pointer to the relevant tRampUpDown.
689	689
690	690	@fn void tRampUpDown_setVal (tRampUpDown* const, float val)
691	691	@brief
692		− @param
	692	+ @param ramp A pointer to the relevant tRampUpDown.
693	693
694	694	@} */
695	695
@@ -729,38 +729,38 @@ extern "C" { · 33 unmodified lines
729	729	@{
730	730
731	731	@fn void tSlide_init (tSlide* const, float upSlide, float downSlide, LEAF* const leaf)
732		− @brief
733		− @param
	732	+ @brief Initialize a tSlide to the default mempool of a LEAF instance.
	733	+ @param slide A pointer to the tSlide to initialize.
734	734	@param leaf A pointer to the leaf instance.
735	735
736	736	@fn void tSlide_initToPool (tSlide* const, float upSlide, float downSlide, tMempool* const)
737		− @brief
738		− @param
	737	+ @brief Initialize a tSlide to a specified mempool.
	738	+ @param slide A pointer to the tSlide to initialize.
739	739	@param mempool A pointer to the tMempool to use.
740	740
741	741	@fn void tSlide_free (tSlide* const)
742	742	@brief Free a tSlide from its mempool.
743		− @param
	743	+ @param slide A pointer to the tSlide to free.
744	744
745	745	@fn float tSlide_tick (tSlide* const, float in)
746	746	@brief
747		− @param
	747	+ @param slide A pointer to the relevant tSlide.
748	748
749	749	@fn float tSlide_tickNoInput (tSlide* const sl)
750	750	@brief
751		− @param
	751	+ @param slide A pointer to the relevant tSlide.
752	752
753	753	@fn void tSlide_setUpSlide (tSlide* const sl, float upSlide)
754	754	@brief
755		− @param
	755	+ @param slide A pointer to the relevant tSlide.
756	756
757	757	@fn void tSlide_setDownSlide (tSlide* const sl, float downSlide)
758	758	@brief
759		− @param
	759	+ @param slide A pointer to the relevant tSlide.
760	760
761	761	@fn void tSlide_setDest (tSlide* const sl, float dest)
762	762	@brief
763		− @param
	763	+ @param slide A pointer to the relevant tSlide.
764	764
765	765	@} */
766	766

leaf/Inc/leaf-filters.h+156−154

@@ -37,30 +37,30 @@ extern "C" { · 36 unmodified lines
37	37	@{
38	38
39	39	@fn void tAllpass_init (tAllpass* const, float initDelay, uint32_t maxDelay, LEAF* const leaf)
40		− @brief
41		− @param
	40	+ @brief Initialize a tAllpass to the default mempool of a LEAF instance.
	41	+ @param filter A pointer to the tAllpass to initialize.
42	42	@param leaf A pointer to the leaf instance.
43	43
44	44	@fn void tAllpass_initToPool (tAllpass* const, float initDelay, uint32_t maxDelay, tMempool* const)
45		− @brief
46		− @param
	45	+ @brief Initialize a tAllpass to a specified mempool.
	46	+ @param filter A pointer to the tAllpass to initialize.
47	47	@param mempool A pointer to the tMempool to use.
48	48
49	49	@fn void tAllpass_free (tAllpass* const)
50	50	@brief Free a tAllpass from its mempool.
51		− @param
	51	+ @param filter A pointer to the tAllpass to free.
52	52
53	53	@fn float tAllpass_tick (tAllpass* const, float input)
54	54	@brief
55		− @param
	55	+ @param filter A pointer to the relevant tAllpass.
56	56
57	57	@fn void tAllpass_setGain (tAllpass* const, float gain)
58	58	@brief
59		− @param
	59	+ @param filter A pointer to the relevant tAllpass.
60	60
61	61	@fn void tAllpass_setDelay (tAllpass* const, float delay)
62	62	@brief
63		− @param
	63	+ @param filter A pointer to the relevant tAllpass.
64	64
65	65	@} */
66	66
@@ -96,46 +96,46 @@ extern "C" { · 29 unmodified lines
96	96	@{
97	97
98	98	@fn void tOnePole_init (tOnePole* const, float thePole, LEAF* const leaf)
99		− @brief
100		− @param
	99	+ @brief Initialize a tOnePole to the default mempool of a LEAF instance.
	100	+ @param filter A pointer to the tOnePole to initialize.
101	101	@param leaf A pointer to the leaf instance.
102	102
103	103	@fn void tOnePole_initToPool (tOnePole* const, float thePole, tMempool* const)
104		− @brief
105		− @param
	104	+ @brief Initialize a tOnePole to a specified mempool.
	105	+ @param filter A pointer to the tOnePole to initialize.
106	106	@param mempool A pointer to the tMempool to use.
107	107
108	108	@fn void tOnePole_free (tOnePole* const)
109	109	@brief Free a tOnePole from its mempool.
110		− @param
	110	+ @param filter A pointer to the tOnePole to free.
111	111
112	112	@fn float tOnePole_tick (tOnePole* const, float input)
113	113	@brief
114		− @param
	114	+ @param filter A pointer to the relevant tOnePole.
115	115
116	116	@fn void tOnePole_setB0 (tOnePole* const, float b0)
117	117	@brief
118		− @param
	118	+ @param filter A pointer to the relevant tOnePole.
119	119
120	120	@fn void tOnePole_setA1 (tOnePole* const, float a1)
121	121	@brief
122		− @param
	122	+ @param filter A pointer to the relevant tOnePole.
123	123
124	124	@fn void tOnePole_setPole (tOnePole* const, float thePole)
125	125	@brief
126		− @param
	126	+ @param filter A pointer to the relevant tOnePole.
127	127
128	128	@fn void tOnePole_setFreq (tOnePole* const, float freq)
129	129	@brief
130		− @param
	130	+ @param filter A pointer to the relevant tOnePole.
131	131
132	132	@fn void tOnePole_setCoefficients(tOnePole* const, float b0, float a1)
133	133	@brief
134		− @param
	134	+ @param filter A pointer to the relevant tOnePole.
135	135
136	136	@fn void tOnePole_setGain (tOnePole* const, float gain)
137	137	@brief
138		− @param
	138	+ @param filter A pointer to the relevant tOnePole.
139	139
140	140	@} */
141	141
@@ -172,46 +172,46 @@ extern "C" { · 30 unmodified lines
172	172	@{
173	173
174	174	@fn void tTwoPole_init (tTwoPole* const, LEAF* const leaf)
175		− @brief
176		− @param
	175	+ @brief Initialize a tTwoPole to the default mempool of a LEAF instance.
	176	+ @param filter A pointer to the tTwoPole to initialize.
177	177	@param leaf A pointer to the leaf instance.
178	178
179	179	@fn void tTwoPole_initToPool (tTwoPole* const, tMempool* const)
180		− @brief
181		− @param
	180	+ @brief Initialize a tTwoPole to a specified mempool.
	181	+ @param filter A pointer to the tTwoPole to initialize.
182	182	@param mempool A pointer to the tMempool to use.
183	183
184	184	@fn void tTwoPole_free (tTwoPole* const)
185	185	@brief Free a tTwoPole from its mempool.
186		− @param
	186	+ @param filter A pointer to the tTwoPole to free.
187	187
188	188	@fn float tTwoPole_tick (tTwoPole* const, float input)
189	189	@brief
190		− @param
	190	+ @param filter A pointer to the relevant tTwoPole.
191	191
192	192	@fn void tTwoPole_setB0 (tTwoPole* const, float b0)
193	193	@brief
194		− @param
	194	+ @param filter A pointer to the relevant tTwoPole.
195	195
196	196	@fn void tTwoPole_setA1 (tTwoPole* const, float a1)
197	197	@brief
198		− @param
	198	+ @param filter A pointer to the relevant tTwoPole.
199	199
200	200	@fn void tTwoPole_setA2 (tTwoPole* const, float a2)
201	201	@brief
202		− @param
	202	+ @param filter A pointer to the relevant tTwoPole.
203	203
204	204	@fn void tTwoPole_setResonance (tTwoPole* const, float freq, float radius, int normalize)
205	205	@brief
206		− @param
	206	+ @param filter A pointer to the relevant tTwoPole.
207	207
208	208	@fn void tTwoPole_setCoefficients(tTwoPole* const, float b0, float a1, float a2)
209	209	@brief
210		− @param
	210	+ @param filter A pointer to the relevant tTwoPole.
211	211
212	212	@fn void tTwoPole_setGain (tTwoPole* const, float gain)
213	213	@brief
214		− @param
	214	+ @param filter A pointer to the relevant tTwoPole.
215	215
216	216	@} */
217	217
@@ -253,46 +253,46 @@ extern "C" { · 35 unmodified lines
253	253	@{
254	254
255	255	@fn void tOneZero_init (tOneZero* const, float theZero, LEAF* const leaf)
256		− @brief
257		− @param
	256	+ @brief Initialize a tOneZero to the default mempool of a LEAF instance.
	257	+ @param filter A pointer to the tSlide to initialize.
258	258	@param leaf A pointer to the leaf instance.
259	259
260	260	@fn void tOneZero_initToPool (tOneZero* const, float theZero, tMempool* const)
261		− @brief
262		− @param
	261	+ @brief Initialize a tOneZero to a specified mempool.
	262	+ @param filter A pointer to the tOneZero to initialize.
263	263	@param mempool A pointer to the tMempool to use.
264	264
265	265	@fn void tOneZero_free (tOneZero* const)
266	266	@brief Free a tOneZero from its mempool.
267		− @param
	267	+ @param filter A pointer to the tOneZero to free.
268	268
269	269	@fn float tOneZero_tick (tOneZero* const, float input)
270	270	@brief
271		− @param
	271	+ @param filter A pointer to the relevant tOneZero.
272	272
273	273	@fn void tOneZero_setB0 (tOneZero* const, float b0)
274	274	@brief
275		− @param
	275	+ @param filter A pointer to the relevant tOneZero.
276	276
277	277	@fn void tOneZero_setB1 (tOneZero* const, float b1)
278	278	@brief
279		− @param
	279	+ @param filter A pointer to the relevant tOneZero.
280	280
281	281	@fn void tOneZero_setZero (tOneZero* const, float theZero)
282	282	@brief
283		− @param
	283	+ @param filter A pointer to the relevant tOneZero.
284	284
285	285	@fn void tOneZero_setCoefficients(tOneZero* const, float b0, float b1)
286	286	@brief
287		− @param
	287	+ @param filter A pointer to the relevant tOneZero.
288	288
289	289	@fn void tOneZero_setGain (tOneZero* const, float gain)
290	290	@brief
291		− @param
	291	+ @param filter A pointer to the relevant tOneZero.
292	292
293	293	@fn float tOneZero_getPhaseDelay (tOneZero *f, float frequency)
294	294	@brief
295		− @param
	295	+ @param filter A pointer to the relevant tOneZero.
296	296
297	297	@} */
298	298
@@ -328,46 +328,46 @@ extern "C" { · 29 unmodified lines
328	328	@{
329	329
330	330	@fn void tTwoZero_init (tTwoZero* const, LEAF* const leaf)
331		− @brief
332		− @param
	331	+ @brief Initialize a tTwoZero to the default mempool of a LEAF instance.
	332	+ @param filter A pointer to the tTwoZero to initialize.
333	333	@param leaf A pointer to the leaf instance.
334	334
335	335	@fn void tTwoZero_initToPool (tTwoZero* const, tMempool* const)
336		− @brief
337		− @param
	336	+ @brief Initialize a tTwoZero to a specified mempool.
	337	+ @param filter A pointer to the tTwoZero to initialize.
338	338	@param mempool A pointer to the tMempool to use.
339	339
340	340	@fn void tTwoZero_free (tTwoZero* const)
341	341	@brief Free a tTwoZero from its mempool.
342		− @param
	342	+ @param filter A pointer to the tTwoZero to free.
343	343
344	344	@fn float tTwoZero_tick (tTwoZero* const, float input)
345	345	@brief
346		− @param
	346	+ @param filter A pointer to the relevant tTwoZero.
347	347
348	348	@fn void tTwoZero_setB0 (tTwoZero* const, float b0)
349	349	@brief
350		− @param
	350	+ @param filter A pointer to the relevant tTwoZero.
351	351
352	352	@fn void tTwoZero_setB1 (tTwoZero* const, float b1)
353	353	@brief
354		− @param
	354	+ @param filter A pointer to the relevant tTwoZero.
355	355
356	356	@fn void tTwoZero_setB2 (tTwoZero* const, float b2)
357	357	@brief
358		− @param
	358	+ @param filter A pointer to the relevant tTwoZero.
359	359
360	360	@fn void tTwoZero_setNotch (tTwoZero* const, float frequency, float radius)
361	361	@brief
362		− @param
	362	+ @param filter A pointer to the relevant tTwoZero.
363	363
364	364	@fn void tTwoZero_setCoefficients(tTwoZero* const, float b0, float b1, float b2)
365	365	@brief
366		− @param
	366	+ @param filter A pointer to the relevant tTwoZero.
367	367
368	368	@fn void tTwoZero_setGain (tTwoZero* const, float gain)
369	369	@brief
370		− @param
	370	+ @param filter A pointer to the relevant tTwoZero.
371	371
372	372
373	373	@} */
@@ -408,51 +408,51 @@ extern "C" { · 34 unmodified lines
408	408	@{
409	409
410	410	@fn void tPoleZero_init (tPoleZero* const, LEAF* const leaf)
411		− @brief
412		− @param
	411	+ @brief Initialize a tPoleZero to the default mempool of a LEAF instance.
	412	+ @param filter A pointer to the tPoleZero to initialize.
413	413	@param leaf A pointer to the leaf instance.
414	414
415	415	@fn void tPoleZero_initToPool (tPoleZero* const, tMempool* const)
416		− @brief
417		− @param
	416	+ @brief Initialize a tPoleZero to a specified mempool.
	417	+ @param filter A pointer to the tPoleZero to initialize.
418	418	@param mempool A pointer to the tMempool to use.
419	419
420	420	@fn void tPoleZero_free (tPoleZero* const)
421	421	@brief Free a tPoleZero from its mempool.
422		− @param
	422	+ @param filter A pointer to the tPoleZero to free.
423	423
424	424
425	425	@fn float tPoleZero_tick (tPoleZero* const, float input)
426	426	@brief
427		− @param
	427	+ @param filter A pointer to the relevant tPoleZero.
428	428
429	429	@fn void tPoleZero_setB0 (tPoleZero* const, float b0)
430	430	@brief
431		− @param
	431	+ @param filter A pointer to the relevant tPoleZero.
432	432
433	433	@fn void tPoleZero_setB1 (tPoleZero* const, float b1)
434	434	@brief
435		− @param
	435	+ @param filter A pointer to the relevant tPoleZero.
436	436
437	437	@fn void tPoleZero_setA1 (tPoleZero* const, float a1)
438	438	@brief
439		− @param
	439	+ @param filter A pointer to the relevant tPoleZero.
440	440
441	441	@fn void tPoleZero_setCoefficients (tPoleZero* const, float b0, float b1, float a1)
442	442	@brief
443		− @param
	443	+ @param filter A pointer to the relevant tPoleZero.
444	444
445	445	@fn void tPoleZero_setAllpass (tPoleZero* const, float coeff)
446	446	@brief
447		− @param
	447	+ @param filter A pointer to the relevant tPoleZero.
448	448
449	449	@fn void tPoleZero_setBlockZero (tPoleZero* const, float thePole)
450	450	@brief
451		− @param
	451	+ @param filter A pointer to the relevant tPoleZero.
452	452
453	453	@fn void tPoleZero_setGain (tPoleZero* const, float gain)
454	454	@brief
455		− @param
	455	+ @param filter A pointer to the relevant tPoleZero.
456	456
457	457
458	458	@} */
@@ -493,59 +493,59 @@ extern "C" { · 34 unmodified lines
493	493	@{
494	494
495	495	@fn void tBiQuad_init (tBiQuad* const, LEAF* const leaf)
496		− @brief
497		− @param
	496	+ @brief Initialize a tBiQuad to the default mempool of a LEAF instance.
	497	+ @param filter A pointer to the tBiQuad to initialize.
498	498	@param leaf A pointer to the leaf instance.
499	499
500	500	@fn void tBiQuad_initToPool (tBiQuad* const, tMempool* const)
501		− @brief
502		− @param
	501	+ @brief Initialize a tBiQuad to a specified mempool.
	502	+ @param filter A pointer to the tBiQuad to initialize.
503	503	@param mempool A pointer to the tMempool to use.
504	504
505	505	@fn void tBiQuad_free (tBiQuad* const)
506	506	@brief Free a tBiQuad from its mempool.
507		− @param
	507	+ @param filter A pointer to the tBiQuad to free.
508	508
509	509
510	510	@fn float tBiQuad_tick (tBiQuad* const, float input)
511	511	@brief
512		− @param
	512	+ @param filter A pointer to the relevant tBiQuad.
513	513
514	514	@fn void tBiQuad_setB0 (tBiQuad* const, float b0)
515	515	@brief
516		− @param
	516	+ @param filter A pointer to the relevant tBiQuad.
517	517
518	518	@fn void tBiQuad_setB1 (tBiQuad* const, float b1)
519	519	@brief
520		− @param
	520	+ @param filter A pointer to the relevant tBiQuad.
521	521
522	522	@fn void tBiQuad_setB2 (tBiQuad* const, float b2)
523	523	@brief
524		− @param
	524	+ @param filter A pointer to the relevant tBiQuad.
525	525
526	526	@fn void tBiQuad_setA1 (tBiQuad* const, float a1)
527	527	@brief
528		− @param
	528	+ @param filter A pointer to the relevant tBiQuad.
529	529
530	530	@fn void tBiQuad_setA2 (tBiQuad* const, float a2)
531	531	@brief
532		− @param
	532	+ @param filter A pointer to the relevant tBiQuad.
533	533
534	534	@fn void tBiQuad_setNotch (tBiQuad* const, float freq, float radius)
535	535	@brief
536		− @param
	536	+ @param filter A pointer to the relevant tBiQuad.
537	537
538	538	@fn void tBiQuad_setResonance (tBiQuad* const, float freq, float radius, int normalize)
539	539	@brief
540		− @param
	540	+ @param filter A pointer to the relevant tBiQuad.
541	541
542	542	@fn void tBiQuad_setCoefficients(tBiQuad* const, float b0, float b1, float b2, float a1, float a2)
543	543	@brief
544		− @param
	544	+ @param filter A pointer to the relevant tBiQuad.
545	545
546	546	@fn void tBiQuad_setGain (tBiQuad* const, float gain)
547	547	@brief
548		− @param
	548	+ @param filter A pointer to the relevant tBiQuad.
549	549
550	550
551	551	@} */
@@ -592,34 +592,34 @@ extern "C" { · 40 unmodified lines
592	592	@{
593	593
594	594	@fn void tSVF_init (tSVF* const, SVFType type, float freq, float Q, LEAF* const leaf)
595		− @brief
596		− @param
	595	+ @brief Initialize a tSVF to the default mempool of a LEAF instance.
	596	+ @param filter A pointer to the tSVF to initialize.
597	597	@param leaf A pointer to the leaf instance.
598	598
599	599	@fn void tSVF_initToPool (tSVF* const, SVFType type, float freq, float Q, tMempool* const)
600		− @brief
601		− @param
	600	+ @brief Initialize a tSVF to a specified mempool.
	601	+ @param filter A pointer to the tSVF to initialize.
602	602	@param mempool A pointer to the tMempool to use.
603	603
604	604	@fn void tSVF_free (tSVF* const)
605	605	@brief Free a tSVF from its mempool.
606		− @param
	606	+ @param filter A pointer to the tSVF to free.
607	607
608	608	@fn float tSVF_tick (tSVF* const, float v0)
609		−
610	609	@brief
611		− @param
	610	+ @param filter A pointer to the relevant tSVF.
	611	+
612	612	@fn void tSVF_setFreq (tSVF* const, float freq)
613	613	@brief
614		− @param
	614	+ @param filter A pointer to the relevant tSVF.
615	615
616	616	@fn void tSVF_setQ (tSVF* const, float Q)
617	617	@brief
618		− @param
	618	+ @param filter A pointer to the relevant tSVF.
619	619
620	620	@fn void tSVF_setFreqAndQ (tSVF* const svff, float freq, float Q)
621	621	@brief
622		− @param
	622	+ @param filter A pointer to the relevant tSVF.
623	623
624	624	@} */
625	625
@@ -664,30 +664,30 @@ extern "C" { · 38 unmodified lines
664	664	@{
665	665
666	666	@fn void tEfficientSVF_init (tEfficientSVF* const, SVFType type, uint16_t input, float Q, LEAF* const leaf)
667		− @brief
668		− @param
	667	+ @brief Initialize a tEfficientSVF to the default mempool of a LEAF instance.
	668	+ @param filter A pointer to the tEfficientSVF to initialize.
669	669	@param leaf A pointer to the leaf instance.
670	670
671	671	@fn void tEfficientSVF_initToPool (tEfficientSVF* const, SVFType type, uint16_t input, float Q, tMempool* const)
672		− @brief
673		− @param
	672	+ @brief Initialize a tEfficientSVF to a specified mempool.
	673	+ @param filter A pointer to the tEfficientSVF to initialize.
674	674	@param mempool A pointer to the tMempool to use.
675	675
676	676	@fn void tEfficientSVF_free (tEfficientSVF* const)
677	677	@brief Free a tEfficientSVF from its mempool.
678		− @param
	678	+ @param filter A pointer to the tEfficientSVF to free.
679	679
680	680	@fn float tEfficientSVF_tick (tEfficientSVF* const, float v0)
681	681	@brief
682		− @param
	682	+ @param filter A pointer to the relevant tEfficientSVF.
683	683
684	684	@fn void tEfficientSVF_setFreq (tEfficientSVF* const, uint16_t controlFreq)
685	685	@brief
686		− @param
	686	+ @param filter A pointer to the relevant tEfficientSVF.
687	687
688	688	@fn void tEfficientSVF_setQ (tEfficientSVF* const, float Q)
689	689	@brief
690		− @param
	690	+ @param filter A pointer to the relevant tEfficientSVF.
691	691
692	692	@} */
693	693
@@ -720,30 +720,30 @@ extern "C" { · 26 unmodified lines
720	720	@{
721	721
722	722	@fn void tHighpass_init (tHighpass* const, float freq, LEAF* const leaf)
723		− @brief
724		− @param
	723	+ @brief Initialize a tHighpass to the default mempool of a LEAF instance.
	724	+ @param filter A pointer to the tHighpass to initialize.
725	725	@param leaf A pointer to the leaf instance.
726	726
727	727	@fn void tHighpass_initToPool (tHighpass* const, float freq, tMempool* const)
728		− @brief
729		− @param
	728	+ @brief Initialize a tHighpass to a specified mempool.
	729	+ @param filter A pointer to the tHighpass to initialize.
730	730	@param mempool A pointer to the tMempool to use.
731	731
732	732	@fn void tHighpass_free (tHighpass* const)
733	733	@brief Free a tHighpass from its mempool.
734		− @param
	734	+ @param filter A pointer to the tHighpass to free.
735	735
736	736	@fn float tHighpass_tick (tHighpass* const, float x)
737	737	@brief
738		− @param
	738	+ @param filter A pointer to the relevant tHighpass.
739	739
740	740	@fn void tHighpass_setFreq (tHighpass* const, float freq)
741	741	@brief
742		− @param
	742	+ @param filter A pointer to the relevant tHighpass.
743	743
744	744	@fn float tHighpass_getFreq (tHighpass* const)
745	745	@brief
746		− @param
	746	+ @param filter A pointer to the relevant tHighpass.
747	747
748	748	@} */
749	749
@@ -774,34 +774,34 @@ extern "C" { · 24 unmodified lines
774	774	@{
775	775
776	776	@fn void tButterworth_init (tButterworth* const, int N, float f1, float f2, LEAF* const leaf, LEAF* const leaf)
777		− @brief
778		− @param
	777	+ @brief Initialize a tButterworth to the default mempool of a LEAF instance.
	778	+ @param filter A pointer to the tButterworth to initialize.
779	779	@param leaf A pointer to the leaf instance.
780	780
781	781	@fn void tButterworth_initToPool (tButterworth* const, int N, float f1, float f2, tMempool* const)
782		− @brief
783		− @param
	782	+ @brief Initialize a tButterworth to a specified mempool.
	783	+ @param filter A pointer to the tButterworth to initialize.
784	784	@param mempool A pointer to the tMempool to use.
785	785
786	786	@fn void tButterworth_free (tButterworth* const)
787	787	@brief Free a tButterworth from its mempool.
788		− @param
	788	+ @param filter A pointer to the tButterworth to free.
789	789
790	790	@fn float tButterworth_tick (tButterworth* const, float input)
791	791	@brief
792		− @param
	792	+ @param filter A pointer to the relevant tButterworth.
793	793
794	794	@fn void tButterworth_setF1 (tButterworth* const, float in)
795	795	@brief
796		− @param
	796	+ @param filter A pointer to the relevant tButterworth.
797	797
798	798	@fn void tButterworth_setF2 (tButterworth* const, float in)
799	799	@brief
800		− @param
	800	+ @param filter A pointer to the relevant tButterworth.
801	801
802	802	@fn void tButterworth_setFreqs (tButterworth* const, float f1, float f2)
803	803	@brief
804		− @param
	804	+ @param filter A pointer to the relevant tButterworth.
805	805
806	806	@} */
807	807
@@ -841,22 +841,22 @@ extern "C" { · 33 unmodified lines
841	841	@{
842	842
843	843	@fn void tFIR_init (tFIR* const, float* coeffs, int numTaps, LEAF* const leaf)
844		− @brief
845		− @param
	844	+ @brief Initialize a tFIR to the default mempool of a LEAF instance.
	845	+ @param filter A pointer to the tFIR to initialize.
846	846	@param leaf A pointer to the leaf instance.
847	847
848	848	@fn void tFIR_initToPool (tFIR* const, float* coeffs, int numTaps, tMempool* const)
849		− @brief
850		− @param
	849	+ @brief Initialize a tFIR to a specified mempool.
	850	+ @param filter A pointer to the tFIR to initialize.
851	851	@param mempool A pointer to the tMempool to use.
852	852
853	853	@fn void tFIR_free (tFIR* const)
854	854	@brief Free a tFIR from its mempool.
855		− @param
	855	+ @param filter A pointer to the tFIR to free.
856	856
857	857	@fn float tFIR_tick (tFIR* const, float input)
858	858	@brief
859		− @param
	859	+ @param filter A pointer to the relevant tFIR.
860	860
861	861	@} */
862	862
@@ -887,22 +887,22 @@ extern "C" { · 24 unmodified lines
887	887	@{
888	888
889	889	@fn void tMedianFilter_init (tMedianFilter* const, int size, LEAF* const leaf)
890		− @brief
891		− @param
	890	+ @brief Initialize a tMedianFilter to the default mempool of a LEAF instance.
	891	+ @param filter A pointer to the tMedianFilter to initialize.
892	892	@param leaf A pointer to the leaf instance.f
893	893
894	894	@fn void tMedianFilter_initToPool (tMedianFilter* const, int size, tMempool* const)
895		− @brief
896		− @param
	895	+ @brief Initialize a tMedianFilter to a specified mempool.
	896	+ @param filter A pointer to the tMedianFilter to initialize.
897	897	@param mempool A pointer to the tMempool to use.
898	898
899	899	@fn void tMedianFilter_free (tMedianFilter* const)
900	900	@brief Free a tMedianFilter from its mempool.
901		− @param
	901	+ @param filter A pointer to the tMedianFilter to free.
902	902
903	903	@fn float tMedianFilter_tick (tMedianFilter* const, float input)
904	904	@brief
905		− @param
	905	+ @param filter A pointer to the relevant tMedianFilter.
906	906
907	907	@} */
908	908
@@ -935,56 +935,58 @@ extern "C" { · 26 unmodified lines
935	935	@{
936	936
937	937	@fn void tVZFilter_init (tVZFilter* const, VZFilterType type, float freq, float Q, LEAF* const leaf)
938		− @brief
939		− @param
	938	+ @brief Initialize a tVZFilter to the default mempool of a LEAF instance.
	939	+ @param filter A pointer to the tVZFilter to initialize.
940	940	@param leaf A pointer to the leaf instance.
941	941
942	942	@fn void tVZFilter_initToPool (tVZFilter* const, VZFilterType type, float freq, float Q, tMempool* const)
943		− @brief
944		− @param
	943	+ @brief Initialize a tVZFilter to a specified mempool.
	944	+ @param filter A pointer to the tVZFilter to initialize.
945	945	@param mempool A pointer to the tMempool to use.
946	946
947	947	@fn void tVZFilter_free (tVZFilter* const)
948	948	@brief Free a tVZFilter from its mempool.
949		− @param
	949	+ @param filter A pointer to the tVZFilter to free.
950	950
951	951	@fn void tVZFilter_setSampleRate (tVZFilter* const, float sampleRate)
952	952	@brief
953		− @param
	953	+ @param filter A pointer to the relevant tVZFilter.
954	954
955	955	@fn float tVZFilter_tick (tVZFilter* const, float input)
956	956	@brief
957		− @param
	957	+ @param filter A pointer to the relevant tVZFilter.
958	958
959	959	@fn float tVZFilter_tickEfficient (tVZFilter* const vf, float in)
960	960	@brief
961		− @param
	961	+ @param filter A pointer to the relevant tVZFilter.
962	962
963	963	@fn void tVZFilter_calcCoeffs (tVZFilter* const)
964	964	@brief
965		− @param
	965	+ @param filter A pointer to the relevant tVZFilter.
966	966
967	967	@fn void tVZFilter_setBandwidth (tVZFilter* const, float bandWidth)
968	968	@brief
969		− @param
	969	+ @param filter A pointer to the relevant tVZFilter.
970	970
971	971	@fn void tVZFilter_setFreq (tVZFilter* const, float freq)
972	972	@brief
973		− @param
	973	+ @param filter A pointer to the relevant tVZFilter.
974	974
975	975	@fn void tVZFilter_setFreqAndBandwidth (tVZFilter* const vf, float freq, float bw)
976	976	@brief
977		− @param
	977	+ @param filter A pointer to the relevant tVZFilter.
	978	+
978	979	@fn void tVZFilter_setGain (tVZFilter* const, float gain)
979	980	@brief
980		− @param
	981	+ @param filter A pointer to the relevant tVZFilter.
	982	+
981	983	@fn void tVZFilter_setType (tVZFilter* const, VZFilterType type)
982	984	@brief
983		− @param
	985	+ @param filter A pointer to the relevant tVZFilter.
984	986
985	987	@fn float tVZFilter_BandwidthToR (tVZFilter* const vf, float B)
986	988	@brief
987		− @param
	989	+ @param filter A pointer to the relevant tVZFilter.
988	990
989	991	@} */
990	992
@@ -1058,30 +1060,30 @@ extern "C" { · 67 unmodified lines
1058	1060	@{
1059	1061
1060	1062	@fn void tDiodeFilter_init (tDiodeFilter* const, float freq, float Q, LEAF* const leaf)
1061		− @brief
1062		− @param
	1063	+ @brief Initialize a tDiodeFilter to the default mempool of a LEAF instance.
	1064	+ @param filter A pointer to the tDiodeFilter to initialize.
1063	1065	@param leaf A pointer to the leaf instance.
1064	1066
1065	1067	@fn void tDiodeFilter_initToPool (tDiodeFilter* const, float freq, float Q, tMempool* const)
1066		− @brief
1067		− @param
	1068	+ @brief Initialize a tDiodeFilter to a specified mempool.
	1069	+ @param filter A pointer to the tDiodeFilter to initialize.
1068	1070	@param mempool A pointer to the tMempool to use.
1069	1071
1070	1072	@fn void tDiodeFilter_free (tDiodeFilter* const)
1071	1073	@brief Free a tDiodeFilter from its mempool.
1072		− @param
	1074	+ @param filter A pointer to the tDiodeFilter to free.
1073	1075
1074	1076	@fn float tDiodeFilter_tick (tDiodeFilter* const, float input)
1075	1077	@brief
1076		− @param
	1078	+ @param filter A pointer to the relevant tDiodeFilter.
1077	1079
1078	1080	@fn void tDiodeFilter_setFreq (tDiodeFilter* const vf, float cutoff)
1079	1081	@brief
1080		− @param
	1082	+ @param filter A pointer to the relevant tDiodeFilter.
1081	1083
1082	1084	@fn void tDiodeFilter_setQ (tDiodeFilter* const vf, float resonance)
1083	1085	@brief
1084		− @param
	1086	+ @param filter A pointer to the relevant tDiodeFilter.
1085	1087
1086	1088	@} */
1087	1089

leaf/Inc/leaf-global.h+1−1

@@ -19,7 +19,7 @@ extern "C" { · 18 unmodified lines
19	19
20	20	/*!
21	21	* @ingroup leaf
22		− * @brief The struct of the global LEAF instance `leaf`. Contains global variables and settings.
	22	+ * @brief Struct for an instance of LEAF.
23	23	*/
24	24
25	25	struct LEAF

leaf/Inc/leaf-instruments.h+60−60

@@ -38,50 +38,50 @@ extern "C" { · 37 unmodified lines
38	38	@{
39	39
40	40	@fn void t808Cowbell_init (t808Cowbell* const, int useStick, LEAF* const leaf)
41		− @brief
42		− @param
	41	+ @brief Initialize a t808Cowbell to the default mempool of a LEAF instance.
	42	+ @param cowbell A pointer to the t808Cowbell to initialize.
43	43	@param leaf A pointer to the leaf instance.
44	44
45	45	@fn void t808Cowbell_initToPool (t808Cowbell* const, int useStick, tMempool* const)
46		− @brief
47		− @param
	46	+ @brief Initialize a t808Cowbell to a specified mempool.
	47	+ @param cowbell A pointer to the t808Cowbell to initialize.
48	48	@param mempool A pointer to the tMempool to use.
49	49
50	50	@fn void t808Cowbell_free (t808Cowbell* const)
51	51	@brief Free a t808Cowbell from its mempool.
52		− @param
	52	+ @param cowbell A pointer to the t808Cowbell to free.
53	53
54	54	@fn float t808Cowbell_tick (t808Cowbell* const)
55	55	@brief
56		− @param
	56	+ @param cowbell A pointer to the relevant t808Cowbell.
57	57
58	58	@fn void t808Cowbell_on (t808Cowbell* const, float vel)
59	59	@brief
60		− @param
	60	+ @param cowbell A pointer to the relevant t808Cowbell.
61	61
62	62	@fn void t808Cowbell_setDecay (t808Cowbell* const, float decay)
63	63	@brief
64		− @param
	64	+ @param cowbell A pointer to the relevant t808Cowbell.
65	65
66	66	@fn void t808Cowbell_setHighpassFreq (t808Cowbell* const, float freq)
67	67	@brief
68		− @param
	68	+ @param cowbell A pointer to the relevant t808Cowbell.
69	69
70	70	@fn void t808Cowbell_setBandpassFreq (t808Cowbell* const, float freq)
71	71	@brief
72		− @param
	72	+ @param cowbell A pointer to the relevant t808Cowbell.
73	73
74	74	@fn void t808Cowbell_setFreq (t808Cowbell* const, float freq)
75	75	@brief
76		− @param
	76	+ @param cowbell A pointer to the relevant t808Cowbell.
77	77
78	78	@fn void t808Cowbell_setOscMix (t808Cowbell* const, float oscMix)
79	79	@brief
80		− @param
	80	+ @param cowbell A pointer to the relevant t808Cowbell.
81	81
82	82	@fn void t808Cowbell_setStick (t808Cowbell* const, int useStick)
83	83	@brief
84		− @param
	84	+ @param cowbell A pointer to the relevant t808Cowbell.
85	85
86	86	@} */
87	87
@@ -125,66 +125,66 @@ extern "C" { · 37 unmodified lines
125	125	@{
126	126
127	127	@fn void t808Hihat_init (t808Hihat* const, LEAF* const leaf)
128		− @brief
129		− @param
	128	+ @brief Initialize a t808Hihat to the default mempool of a LEAF instance.
	129	+ @param hihat A pointer to the t808Hihat to initialize.
130	130	@param leaf A pointer to the leaf instance.
131	131
132	132	@fn void t808Hihat_initToPool (t808Hihat* const, tMempool* const)
133		− @brief
134		− @param
	133	+ @brief Initialize a t808Hihat to a specified mempool.
	134	+ @param hihat A pointer to the t808Hihat to initialize.
135	135	@param mempool A pointer to the tMempool to use.
136	136
137	137	@fn void t808Hihat_free (t808Hihat* const)
138	138	@brief Free a t808Hihat from its mempool.
139		− @param
	139	+ @param hihat A pointer to the t808Hihat to free.
140	140
141	141	@fn float t808Hihat_tick (t808Hihat* const)
142	142	@brief
143		− @param
	143	+ @param hihat A pointer to the relevant t808Hihat.
144	144
145	145	@fn void t808Hihat_on (t808Hihat* const, float vel)
146	146	@brief
147		− @param
	147	+ @param hihat A pointer to the relevant t808Hihat.
148	148
149	149	@fn void t808Hihat_setOscNoiseMix (t808Hihat* const, float oscNoiseMix)
150	150	@brief
151		− @param
	151	+ @param hihat A pointer to the relevant t808Hihat.
152	152
153	153	@fn void t808Hihat_setDecay (t808Hihat* const, float decay)
154	154	@brief
155		− @param
	155	+ @param hihat A pointer to the relevant t808Hihat.
156	156
157	157	@fn void t808Hihat_setHighpassFreq (t808Hihat* const, float freq)
158	158	@brief
159		− @param
	159	+ @param hihat A pointer to the relevant t808Hihat.
160	160
161	161	@fn void t808Hihat_setOscBandpassFreq (t808Hihat* const, float freq)
162	162	@brief
163		− @param
	163	+ @param hihat A pointer to the relevant t808Hihat.
164	164
165	165	@fn void t808Hihat_setOscBandpassQ (t808Hihat* const hihat, float Q)
166	166	@brief
167		− @param
	167	+ @param hihat A pointer to the relevant t808Hihat.
168	168
169	169	@fn void t808Hihat_setStickBandPassFreq (t808Hihat* const, float freq)
170	170	@brief
171		− @param
	171	+ @param hihat A pointer to the relevant t808Hihat.
172	172
173	173	@fn void t808Hihat_setStickBandPassQ (t808Hihat* const hihat, float Q)
174	174	@brief
175		− @param
	175	+ @param hihat A pointer to the relevant t808Hihat.
176	176
177	177	@fn void t808Hihat_setOscFreq (t808Hihat* const, float freq)
178	178	@brief
179		− @param
	179	+ @param hihat A pointer to the relevant t808Hihat.
180	180
181	181	@fn void t808Hihat_setStretch (t808Hihat* const hihat, float stretch)
182	182	@brief
183		− @param
	183	+ @param hihat A pointer to the relevant t808Hihat.
184	184
185	185	@fn void t808Hihat_setFM (t808Hihat* const hihat, float FM_amount)
186	186	@brief
187		− @param
	187	+ @param hihat A pointer to the relevant t808Hihat.
188	188
189	189	@} */
190	190
@@ -237,58 +237,58 @@ extern "C" { · 46 unmodified lines
237	237	@{
238	238
239	239	@fn void t808Snare_init (t808Snare* const, LEAF* const leaf)
240		− @brief
241		− @param
	240	+ @brief Initialize a t808Snare to the default mempool of a LEAF instance.
	241	+ @param snare A pointer to the t808Snare to initialize.
242	242	@param leaf A pointer to the leaf instance.
243	243
244	244	@fn void t808Snare_initToPool (t808Snare* const, tMempool* const)
245		− @brief
246		− @param
	245	+ @brief Initialize a t808Snare to a specified mempool.
	246	+ @param snare A pointer to the t808Snare to initialize.
247	247	@param mempool A pointer to the tMempool to use.
248	248
249	249	@fn void t808Snare_free (t808Snare* const)
250	250	@brief Free a t808Snare from its mempool.
251		− @param
	251	+ @param snare A pointer to the t808Snare to free.
252	252
253	253	@fn float t808Snare_tick (t808Snare* const)
254	254	@brief
255		− @param
	255	+ @param snare A pointer to the relevant t808Snare.
256	256
257	257	@fn void t808Snare_on (t808Snare* const, float vel)
258	258	@brief
259		− @param
	259	+ @param snare A pointer to the relevant t808Snare.
260	260
261	261	@fn void t808Snare_setTone1Freq (t808Snare* const, float freq)
262	262	@brief
263		− @param
	263	+ @param snare A pointer to the relevant t808Snare.
264	264
265	265	@fn void t808Snare_setTone2Freq (t808Snare* const, float freq)
266	266	@brief
267		− @param
	267	+ @param snare A pointer to the relevant t808Snare.
268	268
269	269	@fn void t808Snare_setTone1Decay (t808Snare* const, float decay)
270	270	@brief
271		− @param
	271	+ @param snare A pointer to the relevant t808Snare.
272	272
273	273	@fn void t808Snare_setTone2Decay (t808Snare* const, float decay)
274	274	@brief
275		− @param
	275	+ @param snare A pointer to the relevant t808Snare.
276	276
277	277	@fn void t808Snare_setNoiseDecay (t808Snare* const, float decay)
278	278	@brief
279		− @param
	279	+ @param snare A pointer to the relevant t808Snare.
280	280
281	281	@fn void t808Snare_setToneNoiseMix (t808Snare* const, float toneNoiseMix)
282	282	@brief
283		− @param
	283	+ @param snare A pointer to the relevant t808Snare.
284	284
285	285	@fn void t808Snare_setNoiseFilterFreq (t808Snare* const, float noiseFilterFreq)
286	286	@brief
287		− @param
	287	+ @param snare A pointer to the relevant t808Snare.
288	288
289	289	@fn void t808Snare_setNoiseFilterQ (t808Snare* const, float noiseFilterQ)
290	290	@brief
291		− @param
	291	+ @param snare A pointer to the relevant t808Snare.
292	292
293	293	@} */
294	294
@@ -343,58 +343,58 @@ extern "C" { · 48 unmodified lines
343	343	@{
344	344
345	345	@fn void t808Kick_init (t808Kick* const, LEAF* const leaf)
346		− @brief
347		− @param
	346	+ @brief Initialize a t808Kick to the default mempool of a LEAF instance.
	347	+ @param kick A pointer to the t808Kick to initialize.
348	348	@param leaf A pointer to the leaf instance.
349	349
350	350	@fn void t808Kick_initToPool (t808Kick* const, tMempool* const)
351		− @brief
352		− @param
	351	+ @brief Initialize a t808Kick to a specified mempool.
	352	+ @param kick A pointer to the t808Kick to initialize.
353	353	@param mempool A pointer to the tMempool to use.
354	354
355	355	@fn void t808Kick_free (t808Kick* const)
356	356	@brief Free a t808Kick from its mempool.
357		− @param
	357	+ @param kick A pointer to the t808Kick to free.
358	358
359	359	@fn float t808Kick_tick (t808Kick* const)
360	360	@brief
361		− @param
	361	+ @param kick A pointer to the relevant t808Kick.
362	362
363	363	@fn void t808Kick_on (t808Kick* const, float vel)
364	364	@brief
365		− @param
	365	+ @param kick A pointer to the relevant t808Kick.
366	366
367	367	@fn void t808Kick_setToneFreq (t808Kick* const, float freq)
368	368	@brief
369		− @param
	369	+ @param kick A pointer to the relevant t808Kick.
370	370
371	371	@fn void t808Kick_setToneDecay (t808Kick* const, float decay)
372	372	@brief
373		− @param
	373	+ @param kick A pointer to the relevant t808Kick.
374	374
375	375	@fn void t808Kick_setNoiseDecay (t808Kick* const, float decay)
376	376	@brief
377		− @param
	377	+ @param kick A pointer to the relevant t808Kick.
378	378
379	379	@fn void t808Kick_setSighAmount (t808Kick* const, float sigh)
380	380	@brief
381		− @param
	381	+ @param kick A pointer to the relevant t808Kick.
382	382
383	383	@fn void t808Kick_setChirpAmount (t808Kick* const, float chirp)
384	384	@brief
385		− @param
	385	+ @param kick A pointer to the relevant t808Kick.
386	386
387	387	@fn void t808Kick_setToneNoiseMix (t808Kick* const, float toneNoiseMix)
388	388	@brief
389		− @param
	389	+ @param kick A pointer to the relevant t808Kick.
390	390
391	391	@fn void t808Kick_setNoiseFilterFreq (t808Kick* const, float noiseFilterFreq)
392	392	@brief
393		− @param
	393	+ @param kick A pointer to the relevant t808Kick.
394	394
395	395	@fn void t808Kick_setNoiseFilterQ (t808Kick* const, float noiseFilterQ)
396	396	@brief
397		− @param
	397	+ @param kick A pointer to the relevant t808Kick.
398	398
399	399	@} */
400	400

leaf/Inc/leaf-mempool.h+2−1

@@ -94,6 +94,7 @@ extern "C" { · 93 unmodified lines
94	94	@param pool A pointer to the tMempool to initialize.
95	95	@param memory A pointer to the chunk of memory to be used as a mempool.
96	96	@param size The size of the chunk of memory to be used as a mempool.
	97	+ @param leaf A pointer to the leaf instance.
97	98	*/
98	99	void tMempool_init (tMempool* const pool, char* memory, size_t size, LEAF* const leaf);
99	100
@@ -112,7 +113,7 @@ extern "C" { · 12 unmodified lines
112	113	@param size The size of the chuck of memory to be used as a mempool.
113	114	@param poolTo A pointer to the tMempool to which this tMempool should be initialized.
114	115	*/
115		− void tMempool_initToPool (tMempool* const mp, char* memory, size_t size, tMempool* const mem, LEAF* const leaf);
	116	+ void tMempool_initToPool (tMempool* const mp, char* memory, size_t size, tMempool* const mem);
116	117
117	118	/*!
118	119	@} */

leaf/Inc/leaf-oscillators.h+69−69

@@ -34,7 +34,7 @@ extern "C" { · 33 unmodified lines
34	34	@brief A general wavetable oscillator.
35	35	@{
36	36
37		− @fn void tTable_init (tTable* const osc, float* table, int size, LEAF* const leaf)
	37	+ @fn void tTable_init (tTable* const osc, float* table, int size, LEAF* const leaf)
38	38	@brief Initialize a tTable to the default mempool of a LEAF instance.
39	39	@param osc A pointer to the tTable to initialize.
40	40	@param table A pointer to the wave table data.
@@ -312,30 +312,30 @@ extern "C" { · 271 unmodified lines
312	312	@{
313	313
314	314	@fn void tTri_init (tTri* const osc, LEAF* const leaf)
315		− @brief
316		− @param
	315	+ @brief Initialize a tTri to the default mempool of a LEAF instance.
	316	+ @param osc A pointer to the tTri to initialize.
317	317	@param leaf A pointer to the leaf instance.
318	318
319	319	@fn void tTri_initToPool (tTri* const osc, tMempool* const mempool)
320		− @brief
321		− @param
	320	+ @brief Initialize a tTri to a specified mempool.
	321	+ @param osc A pointer to the tTri to initialize.
322	322	@param mempool A pointer to the tMempool to use.
323	323
324	324	@fn void tTri_free (tTri* const osc)
325	325	@brief Free a tTri from its mempool.
326		− @param
	326	+ @param osc A pointer to the tTri to free.
327	327
328	328	@fn float tTri_tick (tTri* const osc)
329	329	@brief
330		− @param
	330	+ @param osc A pointer to the relevant tTri.
331	331
332	332	@fn void tTri_setFreq (tTri* const osc, float freq)
333	333	@brief
334		− @param
	334	+ @param osc A pointer to the relevant tTri.
335	335
336	336	@fn void tTri_setSkew (tTri* const osc, float skew)
337	337	@brief
338		− @param
	338	+ @param osc A pointer to the relevant tTri.
339	339
340	340	@} */
341	341
@@ -368,30 +368,30 @@ extern "C" { · 26 unmodified lines
368	368	@{
369	369
370	370	@fn void tPulse_init (tPulse* const osc, LEAF* const leaf)
371		− @brief
372		− @param
	371	+ @brief Initialize a tPulse to the default mempool of a LEAF instance.
	372	+ @param osc A pointer to the tPulse to initialize.
373	373	@param leaf A pointer to the leaf instance.
374	374
375	375	@fn void tPulse_initToPool (tPulse* const osc, tMempool* const)
376		− @brief
377		− @param
	376	+ @brief Initialize a tPulse to a specified mempool.
	377	+ @param osc A pointer to the tPulse to initialize.
378	378	@param mempool A pointer to the tMempool to use.
379	379
380	380	@fn void tPulse_free (tPulse* const osc)
381	381	@brief Free a tPulse from its mempool.
382		− @param
	382	+ @param osc A pointer to the tPulse to free.
383	383
384	384	@fn float tPulse_tick (tPulse* const osc)
385	385	@brief
386		− @param
	386	+ @param osc A pointer to the relevant tPulse.
387	387
388	388	@fn void tPulse_setFreq (tPulse* const osc, float freq)
389	389	@brief
390		− @param
	390	+ @param osc A pointer to the relevant tPulse.
391	391
392	392	@fn void tPulse_setWidth (tPulse* const osc, float width)
393	393	@brief
394		− @param
	394	+ @param osc A pointer to the relevant tPulse.
395	395
396	396	@} */
397	397
@@ -423,26 +423,26 @@ extern "C" { · 25 unmodified lines
423	423	@{
424	424
425	425	@fn void tSaw_init (tSaw* const osc, LEAF* const leaf)
426		− @brief
427		− @param
	426	+ @brief Initialize a tSaw to the default mempool of a LEAF instance.
	427	+ @param osc A pointer to the tSaw to initialize.
428	428	@param leaf A pointer to the leaf instance.
429	429
430	430	@fn void tSaw_initToPool (tSaw* const osc, tMempool* const mempool)
431		− @brief
432		− @param
	431	+ @brief Initialize a tSaw to a specified mempool.
	432	+ @param osc A pointer to the tSaw to initialize.
433	433	@param mempool A pointer to the tMempool to use.
434	434
435	435	@fn void tSaw_free (tSaw* const osc)
436	436	@brief Free a tSaw from its mempool.
437		− @param
	437	+ @param osc A pointer to the tSaw to free.
438	438
439	439	@fn float tSaw_tick (tSaw* const osc)
440	440	@brief
441		− @param
	441	+ @param osc A pointer to the relevant tSaw.
442	442
443	443	@fn void tSaw_setFreq (tSaw* const osc, float freq)
444	444	@brief
445		− @param
	445	+ @param osc A pointer to the relevant tSaw.
446	446
447	447	@} */
448	448
@@ -472,26 +472,26 @@ extern "C" { · 23 unmodified lines
472	472	@{
473	473
474	474	@fn void tPhasor_init (tPhasor* const osc, LEAF* const leaf)
475		− @brief
476		− @param
	475	+ @brief Initialize a tPhasor to the default mempool of a LEAF instance.
	476	+ @param osc A pointer to the tPhasor to initialize.
477	477	@param leaf A pointer to the leaf instance.
478	478
479	479	@fn void tPhasor_initToPool (tPhasor* const osc, tMempool* const)
480		− @brief
481		− @param
	480	+ @brief Initialize a tPhasor to a specified mempool.
	481	+ @param osc A pointer to the tPhasor to initialize.
482	482	@param mempool A pointer to the tMempool to use.
483	483
484	484	@fn void tPhasor_free (tPhasor* const osc)
485	485	@brief Free a tPhasor from its mempool.
486		− @param
	486	+ @param osc A pointer to the tPhasor to free.
487	487
488	488	@fn float tPhasor_tick (tPhasor* const osc)
489	489	@brief
490		− @param
	490	+ @param osc A pointer to the relevant tPhasor.
491	491
492	492	@fn void tPhasor_setFreq (tPhasor* const osc, float freq)
493	493	@brief
494		− @param
	494	+ @param osc A pointer to the relevant tPhasor.
495	495
496	496	@} */
497	497
@@ -522,22 +522,22 @@ extern "C" { · 24 unmodified lines
522	522	@{
523	523
524	524	@fn void tNoise_init (tNoise* const noise, NoiseType type, LEAF* const leaf)
525		− @brief
526		− @param
	525	+ @brief Initialize a tNoise to the default mempool of a LEAF instance.
	526	+ @param noise A pointer to the tNoise to initialize.
527	527	@param leaf A pointer to the leaf instance.
528	528
529	529	@fn void tNoise_initToPool (tNoise* const noise, NoiseType type, tMempool* const)
530		− @brief
531		− @param
	530	+ @brief Initialize a tNoise to a specified mempool.
	531	+ @param noise A pointer to the tNoise to initialize.
532	532	@param mempool A pointer to the tMempool to use.
533	533
534	534	@fn void tNoise_free (tNoise* const noise)
535	535	@brief Free a tNoise from its mempool.
536		− @param
	536	+ @param noise A pointer to the tNoise to free.
537	537
538	538	@fn float tNoise_tick (tNoise* const noise)
539	539	@brief
540		− @param
	540	+ @param noise A pointer to the relevant tNoise.
541	541	*/
542	542
543	543	/* tNoise. WhiteNoise, PinkNoise. */
@@ -720,36 +720,36 @@ extern "C" { · 176 unmodified lines
720	720	@{
721	721
722	722	@fn void tMBPulse_init(tMBPulse* const osc, LEAF* const leaf)
723		− @brief
724		− @param
	723	+ @brief Initialize a tMBPulse to the default mempool of a LEAF instance.
	724	+ @param osc A pointer to the tMBPulse to initialize.
725	725
726	726	@fn void tMBPulse_initToPool(tMBPulse* const osc, tMempool* const mempool)
727		− @brief
728		− @param
	727	+ @brief Initialize a tMBPulse to a specified mempool.
	728	+ @param osc A pointer to the tMBPulse to initialize.
729	729
730	730	@fn void tMBPulse_free(tMBPulse* const osc)
731		− @brief
732		− @param
	731	+ @brief Free a tMBPulse from its mempool.
	732	+ @param osc A pointer to the tMBPulse to free.
733	733
734	734	@fn float tMBPulse_tick(tMBPulse* const osc)
735	735	@brief
736		− @param
	736	+ @param osc A pointer to the relevant tMBPulse.
737	737
738	738	@fn void tMBPulse_setFreq(tMBPulse* const osc, float f)
739	739	@brief
740		− @param
	740	+ @param osc A pointer to the relevant tMBPulse.
741	741
742	742	@fn void tMBPulse_setWidth(tMBPulse* const osc, float w)
743	743	@brief
744		− @param
	744	+ @param osc A pointer to the relevant tMBPulse.
745	745
746	746	@fn void tMBPulse_syncIn(tMBPulse* const osc, float sync)
747	747	@brief
748		− @param
	748	+ @param osc A pointer to the relevant tMBPulse.
749	749
750	750	@fn float tMBPulse_syncOut(tMBPulse* const osc)
751	751	@brief
752		− @param
	752	+ @param osc A pointer to the relevant tMBPulse.
753	753
754	754	@} */
755	755
@@ -789,36 +789,36 @@ extern "C" { · 33 unmodified lines
789	789	@{
790	790
791	791	@fn void tMBTriangle_init(tMBTriangle* const osc, LEAF* const leaf)
792		− @brief
793		− @param
	792	+ @brief Initialize a tMBTriangle to the default mempool of a LEAF instance.
	793	+ @param osc A pointer to the tMBTriangle to initialize.
794	794
795	795	@fn void tMBTriangle_initToPool(tMBTriangle* const osc, tMempool* const mempool)
796		− @brief
797		− @param
	796	+ @brief Initialize a tMBTriangle to a specified mempool.
	797	+ @param osc A pointer to the tMBTriangle to initialize.
798	798
799	799	@fn void tMBTriangle_free(tMBTriangle* const osc)
800		− @brief
801		− @param
	800	+ @brief Free a tMBTriangle from its mempool.
	801	+ @param osc A pointer to the tMBTriangle to free.
802	802
803	803	@fn float tMBTriangle_tick(tMBTriangle* const osc)
804	804	@brief
805		− @param
	805	+ @param osc A pointer to the relevant tMBTriangle.
806	806
807	807	@fn void tMBTriangle_setFreq(tMBTriangle* const osc, float f)
808	808	@brief
809		− @param
	809	+ @param osc A pointer to the relevant tMBTriangle.
810	810
811	811	@fn void tMBTriangle_setWidth(tMBTriangle* const osc, float w)
812	812	@brief
813		− @param
	813	+ @param osc A pointer to the relevant tMBTriangle.
814	814
815	815	@fn void tMBTriangle_syncIn(tMBTriangle* const osc, float sync)
816	816	@brief
817		− @param
	817	+ @param osc A pointer to the relevant tMBTriangle.
818	818
819	819	@fn float tMBTriangle_syncOut(tMBTriangle* const osc)
820	820	@brief
821		− @param
	821	+ @param osc A pointer to the relevant tMBTriangle.
822	822
823	823	@} */
824	824
@@ -859,32 +859,32 @@ extern "C" { · 34 unmodified lines
859	859	@{
860	860
861	861	@fn void tMBSaw_init(tMBSaw* const osc, LEAF* const leaf)
862		− @brief
863		− @param
	862	+ @brief Initialize a tMBSaw to the default mempool of a LEAF instance.
	863	+ @param osc A pointer to the tMBSaw to initialize.
864	864
865	865	@fn void tMBSaw_initToPool(tMBSaw* const osc, tMempool* const mempool)
866		− @brief
867		− @param
	866	+ @brief Initialize a tMBSaw to a specified mempool.
	867	+ @param osc A pointer to the tMBSaw to initialize.
868	868
869	869	@fn void tMBSaw_free(tMBSaw* const osc)
870		− @brief
871		− @param
	870	+ @brief Free a tMBSaw from its mempool.
	871	+ @param osc A pointer to the tMBSaw to free.
872	872
873	873	@fn float tMBSaw_tick(tMBSaw* const osc)
874	874	@brief
875		− @param
	875	+ @param osc A pointer to the relevant tMBSaw.
876	876
877	877	@fn void tMBSaw_setFreq(tMBSaw* const osc, float f)
878	878	@brief
879		− @param
	879	+ @param osc A pointer to the relevant tMBSaw.
880	880
881	881	@fn void tMBSaw_syncIn(tMBSaw* const osc, float sync)
882	882	@brief
883		− @param
	883	+ @param osc A pointer to the relevant tMBSaw.
884	884
885	885	@fn float tMBSaw_syncOut(tMBSaw* const osc)
886	886	@brief
887		− @param
	887	+ @param osc A pointer to the relevant tMBSaw.
888	888
889	889	@} */
890	890

leaf/Inc/leaf-physical.h+86−86

@@ -43,46 +43,46 @@ extern "C" { · 42 unmodified lines
43	43	@{
44	44
45	45	@fn void tPluck_init (tPluck* const, float lowestFrequency, LEAF* const leaf)
46		− @brief
47		− @param
	46	+ @brief Initialize a tPluck to the default mempool of a LEAF instance.
	47	+ @param string A pointer to the tPluck to initialize.
48	48	@param leaf A pointer to the leaf instance.
49	49
50	50	@fn void tPluck_initToPool (tPluck* const, float lowestFrequency, tMempool* const)
51		− @brief
52		− @param
	51	+ @brief Initialize a tPluck to a specified mempool.
	52	+ @param string A pointer to the tPluck to initialize.
53	53	@param mempool A pointer to the tMempool to use.
54	54
55	55	@fn void tPluck_free (tPluck* const)
56	56	@brief Free a tPluck from its mempool.
57		− @param
	57	+ @param string A pointer to the tPluck to free.
58	58
59	59	@fn float tPluck_tick (tPluck* const)
60	60	@brief
61		− @param
	61	+ @param string A pointer to the relevant tPluck.
62	62
63	63	@fn void tPluck_pluck (tPluck* const, float amplitude)
64	64	@brief Pluck the string.
65		− @param
	65	+ @param string A pointer to the relevant tPluck.
66	66
67	67	@fn void tPluck_noteOn (tPluck* const, float frequency, float amplitude )
68	68	@brief Start a note with the given frequency and amplitude.
69		− @param
	69	+ @param string A pointer to the relevant tPluck.
70	70
71	71	@fn void tPluck_noteOff (tPluck* const, float amplitude )
72	72	@brief Stop a note with the given amplitude (speed of decay)
73		− @param
	73	+ @param string A pointer to the relevant tPluck.
74	74
75	75	@fn void tPluck_setFrequency (tPluck* const, float frequency )
76	76	@brief Set instrument parameters for a particular frequency.
77		− @param
	77	+ @param string A pointer to the relevant tPluck.
78	78
79	79	@fn void tPluck_controlChange (tPluck* const, int number, float value)
80	80	@brief Perform the control change specified by \e number and \e value (0.0 - 128.0).
81		− @param
	81	+ @param string A pointer to the relevant tPluck.
82	82
83	83	@fn float tPluck_getLastOut (tPluck* const)
84	84	@brief
85		− @param
	85	+ @param string A pointer to the relevant tPluck.
86	86
87	87	@} */
88	88
@@ -126,58 +126,58 @@ extern "C" { · 37 unmodified lines
126	126	@{
127	127
128	128	@fn void tKarplusStrong_init (tKarplusStrong* const, float lowestFrequency, LEAF* const leaf)
129		− @brief
130		− @param
	129	+ @brief Initialize a tKarplusStrong to the default mempool of a LEAF instance.
	130	+ @param string A pointer to the tKarplusStrong to initialize.
131	131	@param leaf A pointer to the leaf instance.
132	132
133	133	@fn void tKarplusStrong_initToPool (tKarplusStrong* const, float lowestFrequency, tMempool* const)
134		− @brief
135		− @param
	134	+ @brief Initialize a tKarplusStrong to a specified mempool.
	135	+ @param string A pointer to the tKarplusStrong to initialize.
136	136	@param mempool A pointer to the tMempool to use.
137	137
138	138	@fn void tKarplusStrong_free (tKarplusStrong* const)
139	139	@brief Free a tKarplusStrong from its mempool.
140		− @param
	140	+ @param string A pointer to the tKarplusStrong to free.
141	141
142	142	@fn float tKarplusStrong_tick (tKarplusStrong* const)
143	143	@brief
144		− @param
	144	+ @param string A pointer to the relevant tKarplusStrong.
145	145
146	146	@fn void tKarplusStrong_pluck (tKarplusStrong* const, float amplitude)
147	147	@brief Pluck the string.
148		− @param
	148	+ @param string A pointer to the relevant tKarplusStrong.
149	149
150	150	@fn void tKarplusStrong_noteOn (tKarplusStrong* const, float frequency, float amplitude)
151	151	@brief Start a note with the given frequency and amplitude.
152		− @param
	152	+ @param string A pointer to the relevant tKarplusStrong.
153	153
154	154	@fn void tKarplusStrong_noteOff (tKarplusStrong* const, float amplitude)
155	155	@brief Stop a note with the given amplitude (speed of decay).
156		− @param
	156	+ @param string A pointer to the relevant tKarplusStrong.
157	157
158	158	@fn void tKarplusStrong_setFrequency (tKarplusStrong* const, float frequency)
159	159	@brief Set instrument parameters for a particular frequency.
160		− @param
	160	+ @param string A pointer to the relevant tKarplusStrong.
161	161
162	162	@fn void tKarplusStrong_controlChange (tKarplusStrong* const, SKControlType type, float value)
163	163	@brief Perform the control change specified by \e number and \e value (0.0 - 128.0). Use SKPickPosition, SKStringDamping, or SKDetune for type.
164		− @param
	164	+ @param string A pointer to the relevant tKarplusStrong.
165	165
166	166	@fn void tKarplusStrong_setStretch (tKarplusStrong* const, float stretch)
167	167	@brief Set the stretch "factor" of the string (0.0 - 1.0).
168		− @param
	168	+ @param string A pointer to the relevant tKarplusStrong.
169	169
170	170	@fn void tKarplusStrong_setPickupPosition (tKarplusStrong* const, float position)
171	171	@brief Set the pluck or "excitation" position along the string (0.0 - 1.0).
172		− @param
	172	+ @param string A pointer to the relevant tKarplusStrong.
173	173
174	174	@fn void tKarplusStrong_setBaseLoopGain (tKarplusStrong* const, float aGain )
175	175	@brief Set the base loop gain.
176		− @param
	176	+ @param string A pointer to the relevant tKarplusStrong.
177	177
178	178	@fn float tKarplusStrong_getLastOut (tKarplusStrong* const)
179	179	@brief
180		− @param
	180	+ @param string A pointer to the relevant tKarplusStrong.
181	181
182	182	@} */
183	183
@@ -238,58 +238,58 @@ extern "C" { · 54 unmodified lines
238	238	@{
239	239
240	240	@fn void tSimpleLivingString_init (tSimpleLivingString* const, float freq, float dampFreq, float decay, float targetLev, float levSmoothFactor, float levStrength, int levMode, LEAF* const leaf)
241		− @brief
242		− @param
	241	+ @brief Initialize a tSimpleLivingString to the default mempool of a LEAF instance.
	242	+ @param string A pointer to the tSimpleLivingString to initialize.
243	243	@param leaf A pointer to the leaf instance.
244	244
245	245	@fn void tSimpleLivingString_initToPool (tSimpleLivingString* const, float freq, float dampFreq, float decay, float targetLev, float levSmoothFactor, float levStrength, int levMode, tMempool* const)
246		− @brief
247		− @param
	246	+ @brief Initialize a tSimpleLivingString to a specified mempool.
	247	+ @param string A pointer to the tSimpleLivingString to initialize.
248	248	@param mempool A pointer to the tMempool to use.
249	249
250	250	@fn void tSimpleLivingString_free (tSimpleLivingString* const)
251	251	@brief Free a tSimpleLivingString from its mempool.
252		− @param
	252	+ @param string A pointer to the tSimpleLivingString to free.
253	253
254	254	@fn float tSimpleLivingString_tick (tSimpleLivingString* const, float input)
255	255	@brief
256		− @param
	256	+ @param string A pointer to the relevant tSimpleLivingString.
257	257
258	258	@fn float tSimpleLivingString_sample (tSimpleLivingString* const)
259	259	@brief
260		− @param
	260	+ @param string A pointer to the relevant tSimpleLivingString.
261	261
262	262	@fn void tSimpleLivingString_setFreq (tSimpleLivingString* const, float freq)
263	263	@brief
264		− @param
	264	+ @param string A pointer to the relevant tSimpleLivingString.
265	265
266	266	@fn void tSimpleLivingString_setWaveLength (tSimpleLivingString* const, float waveLength)
267	267	@brief
268		− @param
	268	+ @param string A pointer to the relevant tSimpleLivingString.
269	269
270	270	@fn void tSimpleLivingString_setDampFreq (tSimpleLivingString* const, float dampFreq)
271	271	@brief
272		− @param
	272	+ @param string A pointer to the relevant tSimpleLivingString.
273	273
274	274	@fn void tSimpleLivingString_setDecay (tSimpleLivingString* const, float decay)
275	275	@brief
276		− @param
	276	+ @param string A pointer to the relevant tSimpleLivingString.
277	277
278	278	@fn void tSimpleLivingString_setTargetLev (tSimpleLivingString* const, float targetLev)
279	279	@brief
280		− @param
	280	+ @param string A pointer to the relevant tSimpleLivingString.
281	281
282	282	@fn void tSimpleLivingString_setLevSmoothFactor (tSimpleLivingString* const, float levSmoothFactor)
283	283	@brief
284		− @param
	284	+ @param string A pointer to the relevant tSimpleLivingString.
285	285
286	286	@fn void tSimpleLivingString_setLevStrength (tSimpleLivingString* const, float levStrength)
287	287	@brief
288		− @param
	288	+ @param string A pointer to the relevant tSimpleLivingString.
289	289
290	290	@fn void tSimpleLivingString_setLevMode (tSimpleLivingString* const, int levMode)
291	291	@brief
292		− @param
	292	+ @param string A pointer to the relevant tSimpleLivingString.
293	293
294	294	@} */
295	295
@@ -339,66 +339,66 @@ extern "C" { · 43 unmodified lines
339	339	@{
340	340
341	341	@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)
342		− @brief
343		− @param
	342	+ @brief Initialize a tLivingString to the default mempool of a LEAF instance.
	343	+ @param string A pointer to the tLivingString to initialize.
344	344	@param leaf A pointer to the leaf instance.
345	345
346	346	@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)
347		− @brief
348		− @param
	347	+ @brief Initialize a tLivingString to a specified mempool.
	348	+ @param string A pointer to the tLivingString to initialize.
349	349	@param mempool A pointer to the tMempool to use.
350	350
351	351	@fn void tLivingString_free (tLivingString* const)
352	352	@brief Free a tLivingString from its mempool.
353		− @param
	353	+ @param string A pointer to the tLivingString to free.
354	354
355	355	@fn float tLivingString_tick (tLivingString* const, float input)
356	356	@brief
357		− @param
	357	+ @param string A pointer to the relevant tLivingString.
358	358
359	359	@fn float tLivingString_sample (tLivingString* const)
360	360	@brief
361		− @param
	361	+ @param string A pointer to the relevant tLivingString.
362	362
363	363	@fn void tLivingString_setFreq (tLivingString* const, float freq)
364	364	@brief
365		− @param
	365	+ @param string A pointer to the relevant tLivingString.
366	366
367	367	@fn void tLivingString_setWaveLength (tLivingString* const, float waveLength)
368	368	@brief
369		− @param
	369	+ @param string A pointer to the relevant tLivingString.
370	370
371	371	@fn void tLivingString_setPickPos (tLivingString* const, float pickPos)
372	372	@brief
373		− @param
	373	+ @param string A pointer to the relevant tLivingString.
374	374
375	375	@fn void tLivingString_setPrepIndex (tLivingString* const, float prepIndex)
376	376	@brief
377		− @param
	377	+ @param string A pointer to the relevant tLivingString.
378	378
379	379	@fn void tLivingString_setDampFreq (tLivingString* const, float dampFreq)
380	380	@brief
381		− @param
	381	+ @param string A pointer to the relevant tLivingString.
382	382
383	383	@fn void tLivingString_setDecay (tLivingString* const, float decay)
384	384	@brief
385		− @param
	385	+ @param string A pointer to the relevant tLivingString.
386	386
387	387	@fn void tLivingString_setTargetLev (tLivingString* const, float targetLev)
388	388	@brief
389		− @param
	389	+ @param string A pointer to the relevant tLivingString.
390	390
391	391	@fn void tLivingString_setLevSmoothFactor (tLivingString* const, float levSmoothFactor)
392	392	@brief
393		− @param
	393	+ @param string A pointer to the relevant tLivingString.
394	394
395	395	@fn void tLivingString_setLevStrength (tLivingString* const, float levStrength)
396	396	@brief
397		− @param
	397	+ @param string A pointer to the relevant tLivingString.
398	398
399	399	@fn void tLivingString_setLevMode (tLivingString* const, int levMode)
400	400	@brief
401		− @param
	401	+ @param string A pointer to the relevant tLivingString.
402	402
403	403	@} */
404	404
@@ -454,70 +454,70 @@ extern "C" { · 49 unmodified lines
454	454	@{
455	455
456	456	@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)
457		− @brief
458		− @param
	457	+ @brief Initialize a tComplexLivingString to the default mempool of a LEAF instance.
	458	+ @param string A pointer to the tComplexLivingString to initialize.
459	459	@param leaf A pointer to the leaf instance.
460	460
461	461	@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)
462		− @brief
463		− @param
	462	+ @brief Initialize a tComplexLivingString to a specified mempool.
	463	+ @param string A pointer to the tComplexLivingString to initialize.
464	464	@param mempool A pointer to the tMempool to use.
465	465
466	466	@fn void tComplexLivingString_free (tComplexLivingString* const)
467	467	@brief Free a tComplexLivingString from its mempool.
468		− @param
	468	+ @param string A pointer to the tComplexLivingString to free.
469	469
470	470	@fn float tComplexLivingString_tick (tComplexLivingString* const, float input)
471	471	@brief
472		− @param
	472	+ @param string A pointer to the relevant tComplexLivingString.
473	473
474	474	@fn float tComplexLivingString_sample (tComplexLivingString* const)
475	475	@brief
476		− @param
	476	+ @param string A pointer to the relevant tComplexLivingString.
477	477
478	478	@fn void tComplexLivingString_setFreq (tComplexLivingString* const, float freq)
479	479	@brief
480		− @param
	480	+ @param string A pointer to the relevant tComplexLivingString.
481	481
482	482	@fn void tComplexLivingString_setWaveLength (tComplexLivingString* const, float waveLength)
483	483	@brief
484		− @param
	484	+ @param string A pointer to the relevant tComplexLivingString.
485	485
486	486	@fn void tComplexLivingString_setPickPos (tComplexLivingString* const, float pickPos)
487	487	@brief
488		− @param
	488	+ @param string A pointer to the relevant tComplexLivingString.
489	489
490	490	@fn void tComplexLivingString_setPrepPos (tComplexLivingString* const, float prepPos)
491	491	@brief
492		− @param
	492	+ @param string A pointer to the relevant tComplexLivingString.
493	493
494	494	@fn void tComplexLivingString_setPrepIndex (tComplexLivingString* const, float prepIndex)
495	495	@brief
496		− @param
	496	+ @param string A pointer to the relevant tComplexLivingString.
497	497
498	498	@fn void tComplexLivingString_setDampFreq (tComplexLivingString* const, float dampFreq)
499	499	@brief
500		− @param
	500	+ @param string A pointer to the relevant tComplexLivingString.
501	501
502	502	@fn void tComplexLivingString_setDecay (tComplexLivingString* const, float decay)
503	503	@brief
504		− @param
	504	+ @param string A pointer to the relevant tComplexLivingString.
505	505
506	506	@fn void tComplexLivingString_setTargetLev (tComplexLivingString* const, float targetLev)
507	507	@brief
508		− @param
	508	+ @param string A pointer to the relevant tComplexLivingString.
509	509
510	510	@fn void tComplexLivingString_setLevSmoothFactor (tComplexLivingString* const, float levSmoothFactor)
511	511	@brief
512		− @param
	512	+ @param string A pointer to the relevant tComplexLivingString.
513	513
514	514	@fn void tComplexLivingString_setLevStrength (tComplexLivingString* const, float levStrength)
515	515	@brief
516		− @param
	516	+ @param string A pointer to the relevant tComplexLivingString.
517	517
518	518	@fn void tComplexLivingString_setLevMode (tComplexLivingString* const, int levMode)
519	519	@brief
520		− @param
	520	+ @param string A pointer to the relevant tComplexLivingString.
521	521
522	522	@} */
523	523
@@ -577,34 +577,34 @@ extern "C" { · 53 unmodified lines
577	577	@{
578	578
579	579	@fn void tReedTable_init (tReedTable* const, float offset, float slope, LEAF* const leaf)
580		− @brief
581		− @param
	580	+ @brief Initialize a tReedTable to the default mempool of a LEAF instance.
	581	+ @param reed A pointer to the tReedTable to initialize.
582	582	@param leaf A pointer to the leaf instance.
583	583
584	584	@fn void tReedTable_initToPool (tReedTable* const, float offset, float slope, tMempool* const)
585		− @brief
586		− @param
	585	+ @brief Initialize a tReedTable to a specified mempool.
	586	+ @param reed A pointer to the tReedTable to initialize.
587	587	@param mempool A pointer to the tMempool to use.
588	588
589	589	@fn void tReedTable_free (tReedTable* const)
590	590	@brief Free a tReedTable from its mempool.
591		− @param
	591	+ @param reed A pointer to the tReedTable to free.
592	592
593	593	@fn float tReedTable_tick (tReedTable* const, float input)
594	594	@brief
595		− @param
	595	+ @param reed A pointer to the relevant tReedTable.
596	596
597	597	@fn float tReedTable_tanh_tick (tReedTable* const, float input)
598	598	@brief
599		− @param
	599	+ @param reed A pointer to the relevant tReedTable.
600	600
601	601	@fn void tReedTable_setOffset (tReedTable* const, float offset)
602	602	@brief
603		− @param
	603	+ @param reed A pointer to the relevant tReedTable.
604	604
605	605	@fn void tReedTable_setSlope (tReedTable* const, float slope)
606	606	@brief
607		− @param
	607	+ @param reed A pointer to the relevant tReedTable.
608	608
609	609	@} */
610	610

leaf/Inc/leaf-reverb.h+37−37

@@ -39,34 +39,34 @@ extern "C" { · 38 unmodified lines
39	39	@{
40	40
41	41	@fn void tPRCReverb_init (tPRCReverb* const, float t60, LEAF* const leaf)
42		− @brief
43		− @param
	42	+ @brief Initialize a tPRCReverb to the default mempool of a LEAF instance.
	43	+ @param reverb A pointer to the tPRCReverb to initialize.
44	44	@param leaf A pointer to the leaf instance.
45	45
46	46	@fn void tPRCReverb_initToPool (tPRCReverb* const, float t60, tMempool* const)
47		− @brief
48		− @param
	47	+ @brief Initialize a tPRCReverb to a specified mempool.
	48	+ @param reverb A pointer to the tPRCReverb to initialize.
49	49	@param mempool A pointer to the tMempool to use.
50	50
51	51	@fn void tPRCReverb_free (tPRCReverb* const)
52	52	@brief Free a tPRCReverb from its mempool.
53		− @param
	53	+ @param reverb A pointer to the tPRCReverb to free.
54	54
55	55	@fn void tPRCReverb_clear (tPRCReverb* const)
56	56	@brief
57		− @param
	57	+ @param reverb A pointer to the relevant tPRCReverb.
58	58
59	59	@fn float tPRCReverb_tick (tPRCReverb* const, float input)
60	60	@brief
61		− @param
	61	+ @param reverb A pointer to the relevant tPRCReverb.
62	62
63	63	@fn void tPRCReverb_setT60 (tPRCReverb* const, float t60)
64	64	@brief Set reverb time in seconds.
65		− @param
	65	+ @param reverb A pointer to the relevant tPRCReverb.
66	66
67	67	@fn void tPRCReverb_setMix (tPRCReverb* const, float mix)
68	68	@brief Set mix between dry input and wet output signal.
69		− @param
	69	+ @param reverb A pointer to the relevant tPRCReverb.
70	70
71	71	@} */
72	72
@@ -107,39 +107,39 @@ extern "C" { · 34 unmodified lines
107	107	@{
108	108
109	109	@fn void tNReverb_init (tNReverb* const, float t60, LEAF* const leaf)
110		− @brief
111		− @param
	110	+ @brief Initialize a tNReverb to the default mempool of a LEAF instance.
	111	+ @param reverb A pointer to the tNReverb to initialize.
112	112	@param leaf A pointer to the leaf instance.
113	113
114	114	@fn void tNReverb_initToPool (tNReverb* const, float t60, tMempool* const)
115		− @brief
116		− @param
	115	+ @brief Initialize a tNReverb to a specified mempool.
	116	+ @param reverb A pointer to the tNReverb to initialize.
117	117	@param mempool A pointer to the tMempool to use.
118	118
119	119	@fn void tNReverb_free (tNReverb* const)
120	120	@brief Free a tNReverb from its mempool.
121		− @param
	121	+ @param reverb A pointer to the tNReverb to free.
122	122
123	123	@fn void tNReverb_clear (tNReverb* const)
124	124	@brief
125		− @param
	125	+ @param reverb A pointer to the relevant tNReverb.
126	126
127	127	@fn float tNReverb_tick (tNReverb* const, float input)
128	128	@brief
129		− @param
	129	+ @param reverb A pointer to the relevant tNReverb.
130	130
131	131	@fn void tNReverb_tickStereo (tNReverb* const rev, float input, float* output)
132		− @brief
133		− @param
	132	+ @brief
	133	+ @param reverb A pointer to the relevant tNReverb.
134	134
135	135	@fn void tNReverb_setT60 (tNReverb* const, float t60)
136	136	@brief Set reverb time in seconds.
137		− @param
	137	+ @param reverb A pointer to the relevant tNReverb.
138	138
139	139	@fn void tNReverb_setMix (tNReverb* const, float mix)
140	140	@brief Set mix between dry input and wet output signal.
141		− @param
142		−
	141	+ @param reverb A pointer to the relevant tNReverb.
	142	+
143	143	@} */
144	144
145	145	typedef struct _tNReverb
@@ -181,62 +181,62 @@ extern "C" { · 35 unmodified lines
181	181	@{
182	182
183	183	@fn void tDattorroReverb_init (tDattorroReverb* const, LEAF* const leaf)
184		− @brief
185		− @param
	184	+ @brief Initialize a tDattorroReverb to the default mempool of a LEAF instance.
	185	+ @param reverb A pointer to the tDattorroReverb to initialize.
186	186	@param leaf A pointer to the leaf instance.
187	187
188	188	@fn void tDattorroReverb_initToPool (tDattorroReverb* const, tMempool* const)
189		− @brief
190		− @param
	189	+ @brief Initialize a tDattorroReverb to a specified mempool.
	190	+ @param reverb A pointer to the tDattorroReverb to initialize.
191	191	@param mempool A pointer to the tMempool to use.
192	192
193	193	@fn void tDattorroReverb_free (tDattorroReverb* const)
194	194	@brief Free a tDattorroReverb from its mempool.
195		− @param
	195	+ @param reverb A pointer to the tDattorroReverb to free.
196	196
197	197	@fn void tDattorroReverb_clear (tDattorroReverb* const)
198	198	@brief
199		− @param
	199	+ @param reverb A pointer to the relevant tDattorroReverb.
200	200
201	201	@fn float tDattorroReverb_tick (tDattorroReverb* const, float input)
202	202	@brief
203		− @param
	203	+ @param reverb A pointer to the relevant tDattorroReverb.
204	204
205	205	@fn void tDattorroReverb_tickStereo (tDattorroReverb* const rev, float input, float* output)
206	206	@brief
207		− @param
	207	+ @param reverb A pointer to the relevant tDattorroReverb.
208	208
209	209	@fn void tDattorroReverb_setMix (tDattorroReverb* const, float mix)
210	210	@brief
211		− @param
	211	+ @param reverb A pointer to the relevant tDattorroReverb.
212	212
213	213	@fn void tDattorroReverb_setFreeze (tDattorroReverb* const rev, uint32_t freeze)
214	214	@brief
215		− @param
	215	+ @param reverb A pointer to the relevant tDattorroReverb.
216	216
217	217	@fn void tDattorroReverb_setHP (tDattorroReverb* const, float freq)
218	218	@brief
219		− @param
	219	+ @param reverb A pointer to the relevant tDattorroReverb.
220	220
221	221	@fn void tDattorroReverb_setSize (tDattorroReverb* const, float size)
222	222	@brief
223		− @param
	223	+ @param reverb A pointer to the relevant tDattorroReverb.
224	224
225	225	@fn void tDattorroReverb_setInputDelay (tDattorroReverb* const, float preDelay)
226	226	@brief
227		− @param
	227	+ @param reverb A pointer to the relevant tDattorroReverb.
228	228
229	229	@fn void tDattorroReverb_setInputFilter (tDattorroReverb* const, float freq)
230	230	@brief
231		− @param
	231	+ @param reverb A pointer to the relevant tDattorroReverb.
232	232
233	233	@fn void tDattorroReverb_setFeedbackFilter (tDattorroReverb* const, float freq)
234	234	@brief
235		− @param
	235	+ @param reverb A pointer to the relevant tDattorroReverb.
236	236
237	237	@fn void tDattorroReverb_setFeedbackGain (tDattorroReverb* const, float gain)
238	238	@brief
239		− @param
	239	+ @param reverb A pointer to the relevant tDattorroReverb.
240	240
241	241	@} */
242	242

leaf/Inc/leaf-sampling.h+62−62

@@ -40,70 +40,70 @@ extern "C" { · 39 unmodified lines
40	40	@{
41	41
42	42	@fn void tBuffer_init (tBuffer* const, uint32_t length, LEAF* const leaf)
43		− @brief
44		− @param
	43	+ @brief Initialize a tBuffer to the default mempool of a LEAF instance.
	44	+ @param sampler A pointer to the tBuffer to initialize.
45	45	@param leaf A pointer to the leaf instance.
46	46
47	47	@fn void tBuffer_initToPool (tBuffer* const, uint32_t length, tMempool* const)
48		− @brief
49		− @param
	48	+ @brief Initialize a tBuffer to a specified mempool.
	49	+ @param sampler A pointer to the tBuffer to initialize.
50	50	@param mempool A pointer to the tMempool to use.
51	51
52	52	@fn void tBuffer_free (tBuffer* const)
53	53	@brief Free a tBuffer from its mempool.
54		− @param
	54	+ @param sampler A pointer to the tBuffer to free.
55	55
56	56	@fn void tBuffer_tick (tBuffer* const, float sample)
57	57	@brief
58		− @param
	58	+ @param sampler A pointer to the relevant tBuffer.
59	59
60	60	@fn void tBuffer_read (tBuffer* const, float* buff, uint32_t len)
61	61	@brief
62		− @param
	62	+ @param sampler A pointer to the relevant tBuffer.
63	63
64	64	@fn float tBuffer_get (tBuffer* const, int idx)
65	65	@brief
66		− @param
	66	+ @param sampler A pointer to the relevant tBuffer.
67	67
68	68	@fn void tBuffer_record (tBuffer* const)
69	69	@brief
70		− @param
	70	+ @param sampler A pointer to the relevant tBuffer.
71	71
72	72	@fn void tBuffer_stop (tBuffer* const)
73	73	@brief
74		− @param
	74	+ @param sampler A pointer to the relevant tBuffer.
75	75
76	76	@fn int tBuffer_getRecordPosition (tBuffer* const)
77	77	@brief
78		− @param
	78	+ @param sampler A pointer to the relevant tBuffer.
79	79
80	80	@fn void tBuffer_setRecordPosition (tBuffer* const, int pos)
81	81	@brief
82		− @param
	82	+ @param sampler A pointer to the relevant tBuffer.
83	83
84	84	@fn void tBuffer_setRecordMode (tBuffer* const, RecordMode mode)
85	85	@brief
86		− @param
	86	+ @param sampler A pointer to the relevant tBuffer.
87	87
88	88	@fn void tBuffer_clear (tBuffer* const)
89	89	@brief
90		− @param
	90	+ @param sampler A pointer to the relevant tBuffer.
91	91
92	92	@fn uint32_t tBuffer_getBufferLength (tBuffer* const)
93	93	@brief
94		− @param
	94	+ @param sampler A pointer to the relevant tBuffer.
95	95
96	96	@fn uint32_t tBuffer_getRecordedLength (tBuffer* const sb)
97	97	@brief
98		− @param
	98	+ @param sampler A pointer to the relevant tBuffer.
99	99
100	100	@fn void tBuffer_setRecordedLength (tBuffer* const sb, int length)
101	101	@brief
102		− @param
	102	+ @param sampler A pointer to the relevant tBuffer.
103	103
104	104	@fn int tBuffer_isActive (tBuffer* const sb)
105	105	@brief
106		− @param
	106	+ @param sampler A pointer to the relevant tBuffer.
107	107
108	108	@} */
109	109
@@ -161,58 +161,58 @@ extern "C" { · 51 unmodified lines
161	161	@{
162	162
163	163	@fn void tSampler_init (tSampler* const, tBuffer* const, LEAF* const leaf)
164		− @brief
165		− @param
	164	+ @brief Initialize a tSampler to the default mempool of a LEAF instance.
	165	+ @param sampler A pointer to the tSampler to initialize.
166	166	@param leaf A pointer to the leaf instance.
167	167
168	168	@fn void tSampler_initToPool (tSampler* const, tBuffer* const, tMempool* const)
169		− @brief
170		− @param
	169	+ @brief Initialize a tSampler to a specified mempool.
	170	+ @param sampler A pointer to the tSampler to initialize.
171	171	@param mempool A pointer to the tMempool to use.
172	172
173	173	@fn void tSampler_free (tSampler* const)
174	174	@brief Free a tSampler from its mempool.
175		− @param
	175	+ @param sampler A pointer to the tSampler to free.
176	176
177	177	@fn float tSampler_tick (tSampler* const)
178	178	@brief
179		− @param
	179	+ @param sampler A pointer to the relevant tSampler.
180	180
181	181	@fn void tSampler_setSample (tSampler* const, tBuffer* const)
182	182	@brief
183		− @param
	183	+ @param sampler A pointer to the relevant tSampler.
184	184
185	185	@fn void tSampler_setMode (tSampler* const, PlayMode mode)
186	186	@brief
187		− @param
	187	+ @param sampler A pointer to the relevant tSampler.
188	188
189	189	@fn void tSampler_play (tSampler* const)
190	190	@brief
191		− @param
	191	+ @param sampler A pointer to the relevant tSampler.
192	192
193	193	@fn void tSampler_stop (tSampler* const)
194	194	@brief
195		− @param
	195	+ @param sampler A pointer to the relevant tSampler.
196	196
197	197	@fn void tSampler_setStart (tSampler* const, int32_t start)
198	198	@brief
199		− @param
	199	+ @param sampler A pointer to the relevant tSampler.
200	200
201	201	@fn void tSampler_setEnd (tSampler* const, int32_t end)
202	202	@brief
203		− @param
	203	+ @param sampler A pointer to the relevant tSampler.
204	204
205	205	@fn void tSampler_setLength (tSampler* const, int32_t length)
206	206	@brief
207		− @param
	207	+ @param sampler A pointer to the relevant tSampler.
208	208
209	209	@fn void tSampler_setCrossfadeLength (tSampler* const sp, uint32_t length)
210	210	@brief
211		− @param
	211	+ @param sampler A pointer to the relevant tSampler.
212	212
213	213	@fn void tSampler_setRate (tSampler* const, float rate)
214	214	@brief
215		− @param
	215	+ @param sampler A pointer to the relevant tSampler.
216	216
217	217	@} */
218	218
@@ -291,54 +291,54 @@ extern "C" { · 72 unmodified lines
291	291	@{
292	292
293	293	@fn void tAutoSampler_init (tAutoSampler* const, tBuffer* const, LEAF* const leaf)
294		− @brief
295		− @param
	294	+ @brief Initialize a tAutoSampler to the default mempool of a LEAF instance.
	295	+ @param sampler A pointer to the tAutoSampler to initialize.
296	296	@param leaf A pointer to the leaf instance.
297	297
298	298	@fn void tAutoSampler_initToPool (tAutoSampler* const, tBuffer* const, tMempool* const)
299		− @brief
300		− @param
	299	+ @brief Initialize a tAutoSampler to a specified mempool.
	300	+ @param sampler A pointer to the tAutoSampler to initialize.
301	301	@param mempool A pointer to the tMempool to use.
302	302
303	303	@fn void tAutoSampler_free (tAutoSampler* const)
304	304	@brief Free a tAutoSampler from its mempool.
305		− @param
	305	+ @param sampler A pointer to the tAutoSampler to free.
306	306
307	307	@fn float tAutoSampler_tick (tAutoSampler* const, float input)
308	308	@brief
309		− @param
	309	+ @param sampler A pointer to the relevant tAutoSampler.
310	310
311	311	@fn void tAutoSampler_setBuffer (tAutoSampler* const, tBuffer* const)
312	312	@brief
313		− @param
	313	+ @param sampler A pointer to the relevant tAutoSampler.
314	314
315	315	@fn void tAutoSampler_setMode (tAutoSampler* const, PlayMode mode)
316	316	@brief
317		− @param
	317	+ @param sampler A pointer to the relevant tAutoSampler.
318	318
319	319	@fn void tAutoSampler_play (tAutoSampler* const)
320	320	@brief
321		− @param
	321	+ @param sampler A pointer to the relevant tAutoSampler.
322	322
323	323	@fn void tAutoSampler_stop (tAutoSampler* const)
324	324	@brief
325		− @param
	325	+ @param sampler A pointer to the relevant tAutoSampler.
326	326
327	327	@fn void tAutoSampler_setThreshold (tAutoSampler* const, float thresh)
328	328	@brief
329		− @param
	329	+ @param sampler A pointer to the relevant tAutoSampler.
330	330
331	331	@fn void tAutoSampler_setWindowSize (tAutoSampler* const, uint32_t size)
332	332	@brief
333		− @param
	333	+ @param sampler A pointer to the relevant tAutoSampler.
334	334
335	335	@fn void tAutoSampler_setCrossfadeLength (tAutoSampler* const, uint32_t length)
336	336	@brief
337		− @param
	337	+ @param sampler A pointer to the relevant tAutoSampler.
338	338
339	339	@fn void tAutoSampler_setRate (tAutoSampler* const, float rate)
340	340	@brief
341		− @param
	341	+ @param sampler A pointer to the relevant tAutoSampler.
342	342
343	343	@} */
344	344
@@ -380,58 +380,58 @@ extern "C" { · 35 unmodified lines
380	380	@{
381	381
382	382	@fn void tMBSampler_init (tMBSampler* const, tBuffer* const, LEAF* const leaf)
383		− @brief
384		− @param
	383	+ @brief Initialize a tMBSampler to the default mempool of a LEAF instance.
	384	+ @param sampler A pointer to the tMBSampler to initialize.
385	385	@param leaf A pointer to the leaf instance.
386	386
387	387	@fn void tMBSampler_initToPool (tMBSampler* const, tBuffer* const, tMempool* const)
388		− @brief
389		− @param
	388	+ @brief Initialize a tMBSampler to a specified mempool.
	389	+ @param sampler A pointer to the tMBSampler to initialize.
390	390	@param mempool A pointer to the tMempool to use.
391	391
392	392	@fn void tMBSampler_free (tMBSampler* const)
393	393	@brief Free a tMBSampler from its mempool.
394		− @param
	394	+ @param sampler A pointer to the tMBSampler to free.
395	395
396	396	@fn float tMBSampler_tick (tMBSampler* const)
397	397	@brief
398		− @param
	398	+ @param sampler A pointer to the relevant tMBSampler.
399	399
400	400	@fn void tMBSampler_setSample (tMBSampler* const, tBuffer* const)
401	401	@brief
402		− @param
	402	+ @param sampler A pointer to the relevant tMBSampler.
403	403
404	404	@fn void tMBSampler_setMode (tMBSampler* const, PlayMode mode)
405	405	@brief
406		− @param
	406	+ @param sampler A pointer to the relevant tMBSampler.
407	407
408	408	@fn void tMBSampler_play (tMBSampler* const)
409	409	@brief
410		− @param
	410	+ @param sampler A pointer to the relevant tMBSampler.
411	411
412	412	@fn void tMBSampler_stop (tMBSampler* const)
413	413	@brief
414		− @param
	414	+ @param sampler A pointer to the relevant tMBSampler.
415	415
416	416	@fn void tMBSampler_setStart (tMBSampler* const, int32_t start)
417	417	@brief
418		− @param
	418	+ @param sampler A pointer to the relevant tMBSampler.
419	419
420	420	@fn void tMBSampler_setEnd (tMBSampler* const, int32_t end)
421	421	@brief
422		− @param
	422	+ @param sampler A pointer to the relevant tMBSampler.
423	423
424	424	@fn void tMBSampler_setLength (tMBSampler* const, int32_t length)
425	425	@brief
426		− @param
	426	+ @param sampler A pointer to the relevant tMBSampler.
427	427
428	428	@fn void tMBSampler_setCrossfadeLength (tMBSampler* const sp, uint32_t length)
429	429	@brief
430		− @param
	430	+ @param sampler A pointer to the relevant tMBSampler.
431	431
432	432	@fn void tMBSampler_setRate (tMBSampler* const, float rate)
433	433	@brief
434		− @param
	434	+ @param sampler A pointer to the relevant tMBSampler.
435	435
436	436	@} */
437	437

leaf/Src/leaf-mempool.c+2−2

@@ -409,7 +409,7 @@ static inline void delink_node(mpool_node_t* node) · 408 unmodified lines
409	409
410	410	void tMempool_init(tMempool* const mp, char* memory, size_t size, LEAF* const leaf)
411	411	{
412		− tMempool_initToPool(mp, memory, size, &leaf->mempool, leaf);
	412	+ tMempool_initToPool(mp, memory, size, &leaf->mempool);
413	413	}
414	414
415	415	void tMempool_free(tMempool* const mp)
@@ -419,7 +419,7 @@ void tMempool_free(tMempool* const mp) · 3 unmodified lines
419	419	mpool_free((char*)m, m->mempool);
420	420	}
421	421
422		−void tMempool_initToPool (tMempool* const mp, char* memory, size_t size, tMempool* const mem, LEAF* const leaf)
	422	+void tMempool_initToPool (tMempool* const mp, char* memory, size_t size, tMempool* const mem)
423	423	{
424	424	_tMempool* mm = *mem;
425	425	_tMempool* m = mp = (_tMempool) mpool_alloc(sizeof(_tMempool), mm);

leaf/Src/leaf-oscillators.c+0−1

@@ -76,7 +76,6 @@ float tTable_tick(tTable* const cy) · 75 unmodified lines
76	76	samp1 = c->waveTable[intPart];
77	77
78	78	return (samp0 + (samp1 - samp0) * fracPart);
79		−
80	79	}
81	80
82	81	void tTableSampleRateChanged(tTable* const cy)

updating docs

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code