| @@ -56,10 +56,10 @@ extern "C" { · 55 unmodified lines |
| 56 | 56 | @brief |
| 57 | 57 | @param delay A pointer to the relevant tDelay. |
| 58 | 58 | |
| 59 | | − @fn int tDelay_setDelay (tDelay* const, uint32_t delay) |
| 59 | + @fn void tDelay_setDelay (tDelay* const, uint32_t delay) |
| 60 | 60 | @brief |
| 61 | 61 | @param delay A pointer to the relevant tDelay. |
| 62 | | − @param delayLength |
| 62 | + @param delayLength The new delay length in samples. Cannot be greater than the max delay length given on initialization. |
| 63 | 63 | |
| 64 | 64 | @fn uint32_t tDelay_getDelay (tDelay* const) |
| 65 | 65 | @brief |
| @@ -125,7 +125,7 @@ extern "C" { · 59 unmodified lines |
| 125 | 125 | void tDelay_free (tDelay* const); |
| 126 | 126 | |
| 127 | 127 | void tDelay_clear (tDelay* const); |
| 128 | | − int tDelay_setDelay (tDelay* const, uint32_t delay); |
| 128 | + void tDelay_setDelay (tDelay* const, uint32_t delay); |
| 129 | 129 | uint32_t tDelay_getDelay (tDelay* const); |
| 130 | 130 | void tDelay_tapIn (tDelay* const, float in, uint32_t tapDelay); |
| 131 | 131 | float tDelay_tapOut (tDelay* const, uint32_t tapDelay); |
| @@ -167,7 +167,7 @@ extern "C" { · 35 unmodified lines |
| 167 | 167 | @fn void tLinearDelay_setDelay (tLinearDelay* const, float delay) |
| 168 | 168 | @brief |
| 169 | 169 | @param delay A pointer to the relevant tLinearDelay. |
| 170 | | − @param delayLength |
| 170 | + @param delayLength The new delay length in samples. Cannot be greater than the max delay length given on initialization. |
| 171 | 171 | |
| 172 | 172 | @fn float tLinearDelay_getDelay (tLinearDelay* const) |
| 173 | 173 | @brief |
| @@ -177,34 +177,47 @@ extern "C" { · 3 unmodified lines |
| 177 | 177 | @fn void tLinearDelay_tapIn (tLinearDelay* const, float in, uint32_t tapDelay) |
| 178 | 178 | @brief |
| 179 | 179 | @param delay A pointer to the relevant tLinearDelay. |
| 180 | + @param input |
| 181 | + @param position |
| 180 | 182 | |
| 181 | 183 | @fn float tLinearDelay_tapOut (tLinearDelay* const, uint32_t tapDelay) |
| 182 | 184 | @brief |
| 183 | 185 | @param delay A pointer to the relevant tLinearDelay. |
| 186 | + @param position |
| 187 | + @return |
| 184 | 188 | |
| 185 | 189 | @fn float tLinearDelay_addTo (tLinearDelay* const, float value, uint32_t tapDelay) |
| 186 | 190 | @brief |
| 187 | 191 | @param delay A pointer to the relevant tLinearDelay. |
| 192 | + @param input |
| 193 | + @param position |
| 194 | + @return |
| 188 | 195 | |
| 189 | 196 | @fn float tLinearDelay_tick (tLinearDelay* const, float sample) |
| 190 | 197 | @brief |
| 191 | 198 | @param delay A pointer to the relevant tLinearDelay. |
| 199 | + @param input |
| 200 | + @return |
| 192 | 201 | |
| 193 | 202 | @fn void tLinearDelay_tickIn (tLinearDelay* const, float input) |
| 194 | 203 | @brief |
| 195 | 204 | @param delay A pointer to the relevant tLinearDelay. |
| 205 | + @param input |
| 196 | 206 | |
| 197 | 207 | @fn float tLinearDelay_tickOut (tLinearDelay* const) |
| 198 | 208 | @brief |
| 199 | 209 | @param delay A pointer to the relevant tLinearDelay. |
| 210 | + @return |
| 200 | 211 | |
| 201 | 212 | @fn float tLinearDelay_getLastOut (tLinearDelay* const) |
| 202 | 213 | @brief |
| 203 | 214 | @param delay A pointer to the relevant tLinearDelay. |
| 215 | + @return |
| 204 | 216 | |
| 205 | 217 | @fn float tLinearDelay_getLastIn (tLinearDelay* const) |
| 206 | 218 | @brief |
| 207 | 219 | @param delay A pointer to the relevant tLinearDelay. |
| 220 | + @return |
| 208 | 221 |  |
| 209 | 222 | @} */ |
| 210 | 223 | |
| @@ -293,10 +306,10 @@ extern "C" { · 82 unmodified lines |
| 293 | 306 | @param delay A pointer to the relevant tHermiteDelay. |
| 294 | 307 | @return |
| 295 | 308 | |
| 296 | | − @fn int tHermiteDelay_setDelay (tHermiteDelay* const dl, float delay) |
| 309 | + @fn void tHermiteDelay_setDelay (tHermiteDelay* const dl, float delay) |
| 297 | 310 | @brief |
| 298 | 311 | @param delay A pointer to the relevant tHermiteDelay. |
| 299 | | − @param delayLength |
| 312 | + @param delayLength The new delay length in samples. Cannot be greater than the max delay length given on initialization. |
| 300 | 313 | |
| 301 | 314 | @fn float tHermiteDelay_tapOut (tHermiteDelay* const dl, uint32_t tapDelay) |
| 302 | 315 | @brief |
| @@ -346,7 +359,6 @@ extern "C" { · 43 unmodified lines |
| 346 | 359 | |
| 347 | 360 | typedef struct _tHermiteDelay |
| 348 | 361 | { |
| 349 | | − |
| 350 | 362 | tMempool mempool; |
| 351 | 363 | |
| 352 | 364 | float gain; |
| @@ -365,23 +377,23 @@ extern "C" { · 12 unmodified lines |
| 365 | 377 | |
| 366 | 378 | typedef _tHermiteDelay* tHermiteDelay; |
| 367 | 379 | |
| 368 | | − void tHermiteDelay_init (tHermiteDelay* const dl, float delay, uint32_t maxDelay, LEAF* const leaf); |
| 369 | | − void tHermiteDelay_initToPool (tHermiteDelay* const dl, float delay, uint32_t maxDelay, tMempool* const mp); |
| 370 | | − void tHermiteDelay_free (tHermiteDelay* const dl); |
| 371 | | − |
| 372 | | − void tHermiteDelay_clear (tHermiteDelay* const dl); |
| 373 | | − float tHermiteDelay_tick (tHermiteDelay* const dl, float input); |
| 374 | | − void tHermiteDelay_tickIn (tHermiteDelay* const dl, float input); |
| 375 | | − float tHermiteDelay_tickOut (tHermiteDelay* const dl); |
| 376 | | − int tHermiteDelay_setDelay (tHermiteDelay* const dl, float delay); |
| 377 | | − float tHermiteDelay_tapOut (tHermiteDelay* const dl, uint32_t tapDelay); |
| 378 | | − void tHermiteDelay_tapIn (tHermiteDelay* const dl, float value, uint32_t tapDelay); |
| 379 | | − float tHermiteDelay_addTo (tHermiteDelay* const dl, float value, uint32_t tapDelay); |
| 380 | | − float tHermiteDelay_getDelay (tHermiteDelay* const dl); |
| 381 | | − float tHermiteDelay_getLastOut (tHermiteDelay* const dl); |
| 380 | + void tHermiteDelay_init (tHermiteDelay* const dl, float delay, uint32_t maxDelay, LEAF* const leaf); |
| 381 | + void tHermiteDelay_initToPool (tHermiteDelay* const dl, float delay, uint32_t maxDelay, tMempool* const mp); |
| 382 | + void tHermiteDelay_free (tHermiteDelay* const dl); |
| 383 | + |
| 384 | + void tHermiteDelay_clear (tHermiteDelay* const dl); |
| 385 | + float tHermiteDelay_tick (tHermiteDelay* const dl, float input); |
| 386 | + void tHermiteDelay_tickIn (tHermiteDelay* const dl, float input); |
| 387 | + float tHermiteDelay_tickOut (tHermiteDelay* const dl); |
| 388 | + void tHermiteDelay_setDelay (tHermiteDelay* const dl, float delay); |
| 389 | + float tHermiteDelay_tapOut (tHermiteDelay* const dl, uint32_t tapDelay); |
| 390 | + void tHermiteDelay_tapIn (tHermiteDelay* const dl, float value, uint32_t tapDelay); |
| 391 | + float tHermiteDelay_addTo (tHermiteDelay* const dl, float value, uint32_t tapDelay); |
| 392 | + float tHermiteDelay_getDelay (tHermiteDelay* const dl); |
| 393 | + float tHermiteDelay_getLastOut (tHermiteDelay* const dl); |
| 382 | 394 | float tHermiteDelay_getLastIn (tHermiteDelay* const dl); |
| 383 | | − void tHermiteDelay_setGain (tHermiteDelay* const dl, float gain); |
| 384 | | − float tHermiteDelay_getGain (tHermiteDelay* const dl); |
| 395 | + void tHermiteDelay_setGain (tHermiteDelay* const dl, float gain); |
| 396 | + float tHermiteDelay_getGain (tHermiteDelay* const dl); |
| 385 | 397 | |
| 386 | 398 | |
| 387 | 399 | //============================================================================== |
| @@ -395,11 +407,15 @@ extern "C" { · 7 unmodified lines |
| 395 | 407 | @fn void tAllpassDelay_init (tAllpassDelay* const, float delay, uint32_t maxDelay, LEAF* const leaf) |
| 396 | 408 | @brief Initialize a tAllpassDelay to the default mempool of a LEAF instance. |
| 397 | 409 | @param delay A pointer to the tAllpassDelay to initialize. |
| 410 | + @param initialLength |
| 411 | + @param maxLength |
| 398 | 412 | @param leaf A pointer to the leaf instance. |
| 399 | 413 | |
| 400 | 414 | @fn void tAllpassDelay_initToPool (tAllpassDelay* const, float delay, uint32_t maxDelay, tMempool* const) |
| 401 | 415 | @brief Initialize a tAllpassDelay to a specified mempool. |
| 402 | 416 | @param delay A pointer to the tAllpassDelay to initialize. |
| 417 | + @param initialLength |
| 418 | + @param maxLength |
| 403 | 419 | @param mempool A pointer to the tMempool to use. |
| 404 | 420 | |
| 405 | 421 | @fn void tAllpassDelay_free (tAllpassDelay* const) |
| @@ -410,43 +426,55 @@ extern "C" { · 4 unmodified lines |
| 410 | 426 | @brief |
| 411 | 427 | @param delay A pointer to the relevant tAllpassDelay. |
| 412 | 428 | |
| 413 | | − @fn int tAllpassDelay_setDelay (tAllpassDelay* const, float delay) |
| 429 | + @fn void tAllpassDelay_setDelay (tAllpassDelay* const, float delay) |
| 414 | 430 | @brief |
| 415 | 431 | @param delay A pointer to the relevant tAllpassDelay. |
| 432 | + @param delayLength The new delay length in samples. Cannot be greater than the max delay length given on initialization. |
| 416 | 433 | |
| 417 | 434 | @fn float tAllpassDelay_getDelay (tAllpassDelay* const) |
| 418 | 435 | @brief |
| 419 | 436 | @param delay A pointer to the relevant tAllpassDelay. |
| 437 | + @return The current delay length in samples. |
| 420 | 438 | |
| 421 | 439 | @fn void tAllpassDelay_tapIn (tAllpassDelay* const, float in, uint32_t tapDelay) |
| 422 | 440 | @brief |
| 423 | 441 | @param delay A pointer to the relevant tAllpassDelay. |
| 442 | + @param inptu |
| 443 | + @param position |
| 424 | 444 | |
| 425 | 445 | @fn float tAllpassDelay_tapOut (tAllpassDelay* const, uint32_t tapDelay) |
| 426 | 446 | @brief |
| 427 | 447 | @param delay A pointer to the relevant tAllpassDelay. |
| 448 | + @param position |
| 449 | + @return |
| 428 | 450 | |
| 429 | 451 | @fn float tAllpassDelay_addTo (tAllpassDelay* const, float value, uint32_t tapDelay) |
| 430 | 452 | @brief |
| 431 | 453 | @param delay A pointer to the relevant tAllpassDelay. |
| 454 | + @param input |
| 455 | + @param position |
| 456 | + @return |
| 432 | 457 | |
| 433 | 458 | @fn float tAllpassDelay_tick (tAllpassDelay* const, float sample) |
| 434 | 459 | @brief |
| 435 | 460 | @param delay A pointer to the relevant tAllpassDelay. |
| 461 | + @param input |
| 462 | + @return |
| 436 | 463 | |
| 437 | 464 | @fn float tAllpassDelay_getLastOut (tAllpassDelay* const) |
| 438 | 465 | @brief |
| 439 | 466 | @param delay A pointer to the relevant tAllpassDelay. |
| 467 | + @return |
| 440 | 468 | |
| 441 | 469 | @fn float tAllpassDelay_getLastIn (tAllpassDelay* const) |
| 442 | 470 | @brief |
| 443 | 471 | @param delay A pointer to the relevant tAllpassDelay. |
| 472 | + @return |
| 444 | 473 |  |
| 445 | 474 | @} */ |
| 446 | 475 | |
| 447 | 476 | typedef struct _tAllpassDelay |
| 448 | 477 | { |
| 449 | | − |
| 450 | 478 | tMempool mempool; |
| 451 | 479 | |
| 452 | 480 | float gain; |
| @@ -473,7 +501,7 @@ extern "C" { · 20 unmodified lines |
| 473 | 501 | void tAllpassDelay_free (tAllpassDelay* const); |
| 474 | 502 | |
| 475 | 503 | void tAllpassDelay_clear (tAllpassDelay* const); |
| 476 | | − int tAllpassDelay_setDelay (tAllpassDelay* const, float delay); |
| 504 | + void tAllpassDelay_setDelay (tAllpassDelay* const, float delay); |
| 477 | 505 | float tAllpassDelay_getDelay (tAllpassDelay* const); |
| 478 | 506 | void tAllpassDelay_tapIn (tAllpassDelay* const, float in, uint32_t tapDelay); |
| 479 | 507 | float tAllpassDelay_tapOut (tAllpassDelay* const, uint32_t tapDelay); |
| @@ -493,11 +521,15 @@ extern "C" { · 13 unmodified lines |
| 493 | 521 | @fn void tTapeDelay_init (tTapeDelay* const, float delay, uint32_t maxDelay, LEAF* const leaf) |
| 494 | 522 | @brief Initialize a tTapeDelay to the default mempool of a LEAF instance. |
| 495 | 523 | @param delay A pointer to the tTapeDelay to initialize. |
| 524 | + @param initialLength |
| 525 | + @param maxLength |
| 496 | 526 | @param leaf A pointer to the leaf instance. |
| 497 | 527 | |
| 498 | 528 | @fn void tTapeDelay_initToPool (tTapeDelay* const, float delay, uint32_t maxDelay, tMempool* const) |
| 499 | 529 | @brief Initialize a tTapeDelay to a specified mempool. |
| 500 | 530 | @param delay A pointer to the tTapeDelay to initialize. |
| 531 | + @param initialLength |
| 532 | + @param maxLength |
| 501 | 533 | @param mempool A pointer to the tMempool to use. |
| 502 | 534 | |
| 503 | 535 | @fn void tTapeDelay_free (tTapeDelay* const) |
| @@ -511,26 +543,37 @@ extern "C" { · 7 unmodified lines |
| 511 | 543 | @fn void tTapeDelay_setDelay (tTapeDelay* const, float delay) |
| 512 | 544 | @brief |
| 513 | 545 | @param delay A pointer to the relevant tTapeDelay. |
| 546 | + @param delayLength The new delay length in samples. Cannot be greater than the max delay length given on initialization. |
| 514 | 547 | |
| 515 | 548 | @fn float tTapeDelay_getDelay (tTapeDelay* const) |
| 516 | 549 | @brief |
| 517 | 550 | @param delay A pointer to the relevant tTapeDelay. |
| 551 | + @return |
| 518 | 552 | |
| 519 | 553 | @fn void tTapeDelay_tapIn (tTapeDelay* const, float in, uint32_t tapDelay) |
| 520 | 554 | @brief |
| 521 | 555 | @param delay A pointer to the relevant tTapeDelay. |
| 556 | + @param input |
| 557 | + @param position |
| 522 | 558 | |
| 523 | 559 | @fn float tTapeDelay_tapOut (tTapeDelay* const d, float tapDelay) |
| 524 | 560 | @brief |
| 525 | 561 | @param delay A pointer to the relevant tTapeDelay. |
| 562 | + @param position |
| 563 | + @return |
| 526 | 564 | |
| 527 | 565 | @fn float tTapeDelay_addTo (tTapeDelay* const, float value, uint32_t tapDelay) |
| 528 | 566 | @brief |
| 529 | 567 | @param delay A pointer to the relevant tTapeDelay. |
| 568 | + @param input |
| 569 | + @param position |
| 570 | + @return |
| 530 | 571 | |
| 531 | 572 | @fn float tTapeDelay_tick (tTapeDelay* const, float sample) |
| 532 | 573 | @brief |
| 533 | 574 | @param delay A pointer to the relevant tTapeDelay. |
| 575 | + @param input |
| 576 | + @return |
| 534 | 577 | |
| 535 | 578 | @fn void tTapeDelay_incrementInPoint(tTapeDelay* const dl) |
| 536 | 579 | @brief |
| @@ -539,10 +582,12 @@ extern "C" { · 2 unmodified lines |
| 539 | 582 | @fn float tTapeDelay_getLastOut (tTapeDelay* const) |
| 540 | 583 | @brief |
| 541 | 584 | @param delay A pointer to the relevant tTapeDelay. |
| 585 | + @return |
| 542 | 586 | |
| 543 | 587 | @fn float tTapeDelay_getLastIn (tTapeDelay* const) |
| 544 | 588 | @brief |
| 545 | 589 | @param delay A pointer to the relevant tTapeDelay. |
| 590 | + @return |
| 546 | 591 |  |
| 547 | 592 | @} */ |
| 548 | 593 | |
| @@ -592,41 +637,45 @@ extern "C" { · 43 unmodified lines |
| 592 | 637 | |
| 593 | 638 | @fn void tRingBuffer_init (tRingBuffer* const ring, int size, LEAF* const leaf) |
| 594 | 639 | @brief Initialize a tRingBuffer to the default mempool of a LEAF instance. |
| 595 | | − @param delay A pointer to the tRingbuffer to initialize. |
| 640 | + @param buffer A pointer to the tRingbuffer to initialize. |
| 641 | + @param size Size of the buffer. Should be a power of 2. Will otherwise be adjusted to the nearest greater power of 2. |
| 596 | 642 | @param leaf A pointer to the leaf instance. |
| 597 | 643 | |
| 598 | 644 | @fn void tRingBuffer_initToPool (tRingBuffer* const ring, int size, tMempool* const mempool) |
| 599 | 645 | @brief Initialize a tRingBuffer to a specified mempool. |
| 600 | | − @param delay A pointer to the tRingbuffer to initialize. |
| 646 | + @param buffer A pointer to the tRingbuffer to initialize. |
| 647 | + @param size Size of the buffer. Should be a power of 2. Will otherwise be adjusted to the nearest greater power of 2. |
| 601 | 648 | @param mempool A pointer to the tMempool to use. |
| 602 | 649 | |
| 603 | 650 | @fn void tRingBuffer_free (tRingBuffer* const ring) |
| 604 | 651 | @brief Free a tRingBuffer from its mempool. |
| 605 | | − @param delay A pointer to the tRingBuffer to free. |
| 652 | + @param buffer A pointer to the tRingBuffer to free. |
| 606 | 653 | |
| 607 | 654 | @fn void tRingBuffer_push (tRingBuffer* const ring, float val) |
| 608 | | − @brief |
| 609 | | − @param delay A pointer to the relevant tRingBuffer. |
| 655 | + @brief Push a value to the ring buffer, overwriting the oldest value if the buffer is full. |
| 656 | + @param buffer A pointer to the relevant tRingBuffer. |
| 657 | + @param input The value to push to the buffer. |
| 610 | 658 | |
| 611 | 659 | @fn float tRingBuffer_getNewest (tRingBuffer* const ring) |
| 612 | | − @brief |
| 613 | | − @param delay A pointer to the relevant tRingBuffer. |
| 660 | + @brief Get the newest value in the ring buffer. |
| 661 | + @param buffer A pointer to the relevant tRingBuffer. |
| 662 | + @return The newest value in the ring buffer. |
| 614 | 663 | |
| 615 | 664 | @fn float tRingBuffer_getOldest (tRingBuffer* const ring) |
| 616 | | − @brief |
| 617 | | − @param delay A pointer to the relevant tRingBuffer. |
| 665 | + @brief Get the oldest value in the ring buffer. |
| 666 | + @param buffer A pointer to the relevant tRingBuffer. |
| 667 | + @return The oldest value in the ring buffer. |
| 618 | 668 | |
| 619 | 669 | @fn float tRingBuffer_get (tRingBuffer* const ring, int index) |
| 620 | | − @brief |
| 621 | | − @param delay A pointer to the relevant tRingBuffer. |
| 622 | | − |
| 623 | | − @fn float tRingBuffer_clear (tRingBuffer* const ring) |
| 624 | | − @brief |
| 625 | | − @param delay A pointer to the relevant tRingBuffer. |
| 626 | | − |
| 670 | + @brief Get the value at an index of the buffer. |
| 671 | + @param buffer A pointer to the relevant tRingBuffer. |
| 672 | + @param index The index to access. |
| 673 | + @return The value at the given index. |
| 674 | + |
| 627 | 675 | @fn int tRingBuffer_getSize (tRingBuffer* const ring) |
| 628 | | − @brief |
| 629 | | − @param delay A pointer to the relevant tRingBuffer. |
| 676 | + @brief Get the size of the ring buffer. |
| 677 | + @param buffer A pointer to the relevant tRingBuffer. |
| 678 | + @return The size of the buffer. |
| 630 | 679 |  |
| 631 | 680 | @} */ |
| 632 | 681 | typedef struct _tRingBuffer |
| @@ -650,7 +699,6 @@ extern "C" { · 17 unmodified lines |
| 650 | 699 | float tRingBuffer_getNewest (tRingBuffer* const ring); |
| 651 | 700 | float tRingBuffer_getOldest (tRingBuffer* const ring); |
| 652 | 701 | float tRingBuffer_get (tRingBuffer* const ring, int index); |
| 653 | | − float tRingBuffer_clear (tRingBuffer* const ring); |
| 654 | 702 | int tRingBuffer_getSize (tRingBuffer* const ring); |
| 655 | 703 | |
| 656 | 704 | #ifdef __cplusplus |