From b4a8cfe53b3e3422e6da6683a83f89116331e47d Mon Sep 17 00:00:00 2001 From: antisvin Date: Sat, 6 Feb 2021 17:32:23 +0300 Subject: [PATCH] DaisySP docs --- DaisySP/README.md | 25 +++++++++++++++++++++++++ README.md | 1 + 2 files changed, 26 insertions(+) create mode 100644 DaisySP/README.md diff --git a/DaisySP/README.md b/DaisySP/README.md new file mode 100644 index 0000000..3a05f3c --- /dev/null +++ b/DaisySP/README.md @@ -0,0 +1,25 @@ +# DaisySP + +OWL patches in C++ can use objects from the [DaisySP library](https://electro-smith.github.io/DaisySP/index.html) directly. While it was written to run on Daisy platform, there's nothing preventing compatibility with OWL patches in its code. + + +## DaisySP patch structure + +Integrating DaisySP into an OWL patch takes just a few simple steps: + +1. Import main library header by adding `#include "daisysp.h"` + +2. Import libray namespace into current patch with `using namespace daisysp;` statement + +3. Add required objects as patch members. It's also possible to use object pointer and create objects dynamically in constructor to delay memory allocation. + +4. Call each object's `::Init()` method in patch constructor. Most objects require passing sample rate, so it becomes something like `object.Init(getSampleRate());` + +5. Update object parameters with `object.Set*()` calls inside your patch's `processAudio(...)` method + +6. Generate object audio by calling `object.Process(...);` inside a for-loop once for every sample. + + +## Example patch + +[Filthy kick](https://www.rebeltech.org/patch-library/patch/FilthyKick) shows how to use all of the above. diff --git a/README.md b/README.md index 32204c4..7000676 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ The OWL platform is actively developed by [Rebel Technology](https://www.rebelte * [Max Gen](MaxGen) * [SOUL](Soul) * [Maximilian](Maximilian) +* [DaisySP](DaisySP) ## Legacy This documentation project is a work in progress. For additional and legacy information please try the [Wayback Machine](https://web.archive.org/web/20161004214151/https://hoxtonowl.com/mediawiki/index.php/Main_Page) or the [OWL Digital Legacy](OWL_Digital/Legacy/) resources.