adding SOUL patch compilation support

Author: Martin Klang

Makefile

@@ -44,6 +44,15 @@ else ifdef TEST
 PATCHNAME   ?= $(TEST)
 PATCHCLASS  ?= $(PATCHNAME)Patch
 PATCHFILE   ?= $(PATCHNAME)Patch.hpp
+else ifdef SOUL
+# options for SOUL patch compilation
+PATCHNAME   ?= $(SOUL)
+PATCHCLASS  ?= SoulPatch
+PATCHFILE   ?= SoulPatch.hpp
+SOULCLASS   ?= $(SOUL)
+SOULFILE    ?= $(SOUL).soul
+SOULHPP     ?= $(SOUL).hpp
+DEPS        += soul
 else
 # options for C++ compilation
 PATCHNAME   ?= "Template"
@@ -65,14 +74,15 @@ export BUILD BUILDROOT TARGET
 export PATCHNAME PATCHCLASS PATCHSOURCE 
 export PATCHFILE PATCHIN PATCHOUT
 export HEAVYTOKEN HEAVYSERVICETOKEN  HEAVY
+export SOUL SOULCLASS SOULFILE SOULHPP
 export LDSCRIPT CPPFLAGS EMCCFLAGS ASFLAGS
 export CONFIG PLATFORM
 
 DEPS += $(BUILD)/registerpatch.cpp $(BUILD)/registerpatch.h $(BUILD)/Source/startup.s 
 
 all: patch
 
-.PHONY: .FORCE clean realclean run store docs help
+.PHONY: .FORCE patch libs faust gen heavy web minify clean realclean run store docs help
 
 .FORCE:
 	@mkdir -p $(BUILD)/Source
@@ -114,6 +124,9 @@ heavy: .FORCE
 gen: .FORCE
 	@$(MAKE) -s -f gen.mk gen
 
+soul: .FORCE
+	@$(MAKE) -s -f soul.mk soul
+
 sysex: patch $(BUILD)/$(TARGET).syx ## package patch binary as MIDI sysex
 	@echo Built sysex $(PATCHNAME) in $(BUILD)/$(TARGET).syx
 

README.md

@@ -13,8 +13,9 @@ It is used to build, run and store patches written in PD, FAUST, Max Gen and C++
 * emcc (to make web) [[3]](#ref3)
 * faust2owl (to compile FAUST patches) [[4]](#ref4)
 * The heavy hvcc compiler (to compile PD patches) [[5]](#ref5)
+* The soul compiler (to compile SOUL patches) [[6]](#ref6)
 
-* On Windows, you'll need a MAKE utility [[6]](#ref6).  You'll also need to open common.mk and point TOOLROOT to your gcc installation directory, using a path string without spaces (such as using 8.3 filenames).
+* On Windows, you'll need a MAKE utility [[7]](#ref7).  You'll also need to open common.mk and point TOOLROOT to your gcc installation directory, using a path string without spaces (such as using 8.3 filenames).
 
 ## Preparing the environment
 This has been done on a Ubuntu server 18.04
@@ -36,9 +37,7 @@ to compile puredata patches you need hvcc
 
 compile FirmwareSender 
 
-FirmwareSender makes possible to use `run` and `store` make targets or by 
-invoking it directly to run/store a compiled patch to the device using sysex 
-codes. 
+FirmwareSender makes it possible to use `run` and `store` make targets, or by invoking FirmwareSender directly to run/store a compiled patch to the device using sysex codes. 
 
     $ sudo apt install libasound2-dev libcurl4-openssl-dev pkg-config
     $ git clone https://github.com/pingdynasty/FirmwareSender
@@ -107,8 +106,6 @@ Note: assign OWL parameters with slider metadata: `[OWL:A]`, `[OWL:B]` et c. For
 
 * put your PD patch file (e.g. `Foo.pd`) into `PatchSource`
 * `make HEAVY=Foo run`
-   
-Note: assign OWL parameters with PD receivers called `Channel-A`, `Channel-B`, etc.
 
 ## Building Max Gen patches
 Requires the `.cpp` and `.h` files of a Gen patch generated by Max Gen.
@@ -119,6 +116,11 @@ To compile and run a Gen patch called `Foo`:
 
 Note: use OWL parameters in Gen with parameter names: `A`, `B`, `C`, `D`, `Exp`, and `Push`.
 
+## Building SOUL patches
+
+* put your SOUL patch file (e.g. 'Foo.soul') into `PatchSource`
+* `make SOUL=Foo run`
+
 ## Using FirmwareSender
 
 If you prefer to build the patch first and send it later to the device you can 
@@ -128,16 +130,15 @@ do it like this from the main directory of OwlProgram (this will store in slot 6
 
 # Examples
 
-Compile the puredata file owl_hypersaw.pd[[7]](#ref7):
+Compile the puredata file owl_hypersaw.pd[[8]](#ref8):
 
     make HEAVY=owl_hypersaw clean patch
 
-
 Compile puredata file owl_hypersaw.pd and send to device to be run immediately:
 
     make HEAVY=owl_hypersaw clean run
 
-Compile KickBox[[8]](#ref8) C++ patch:
+Compile KickBox[[9]](#ref9) C++ patch:
 
     make PATCHNAME=KickBox clean patch
 
@@ -153,9 +154,11 @@ Compile KickBox[[8]](#ref8) C++ patch:
 
 <a name="ref5">[5]</a> https://github.com/enzienaudio/hvcc
 
-<a name="ref6">[6]</a> http://sourceforge.net/projects/mingw/
+<a name="ref6">[6]</a> https://github.com/soul-lang/SOUL
+
+<a name="ref7">[7]</a> http://sourceforge.net/projects/mingw/
 
-<a name="ref7">[7]</a> https://www.rebeltech.org/patch-library/patch/4_saw
+<a name="ref8">[8]</a> https://www.rebeltech.org/patch-library/patch/4_saw
 
-<a name="ref8">[8]</a> https://github.com/marsus/MyPatches (AudioDisplay.hpp, BassDrum.hpp, Cymbal.hpp, Drum.hpp, KickBoxPatch.hpp, Oscillators.hpp, Sequence.h, SynthVoice.hpp, bjorklund.h)
+<a name="ref9">[9]</a> https://github.com/marsus/MyPatches (AudioDisplay.hpp, BassDrum.hpp, Cymbal.hpp, Drum.hpp, KickBoxPatch.hpp, Oscillators.hpp, Sequence.h, SynthVoice.hpp, bjorklund.h)
 

SoulSource/SoulPatch.hpp

@@ -0,0 +1,79 @@
+#ifndef __SoulPatch_hpp__
+#define __SoulPatch_hpp__
+
+#include "Patch.h"
+
+#undef min
+#undef max
+#undef sin
+#undef cos
+#undef exp
+#undef sqrt
+#undef pow
+#undef log
+#undef log10
+
+#define SOUL_CPP_ASSERT(x)
+
+#include "soul.hpp"
+
+namespace std {
+  void __throw_bad_alloc (void) { error(PROGRAM_ERROR_STATUS, "bad alloc"); while(1); }
+  void __throw_bad_function_call() { error(PROGRAM_ERROR_STATUS, "bad func"); while(1); }
+  void __throw_length_error (const char *) { error(PROGRAM_ERROR_STATUS, "bad len"); while(1); }
+}
+
+#define MAX_MIDI_MESSAGES 32
+class SoulPatch : public Patch {
+private:
+  SOULPATCH soulpatch;
+  std::vector<SOULPATCH::Parameter> params;
+  AudioBuffer* outputBuffer;
+  SOULPATCH::MIDIMessage midiBuffer[32];
+  size_t numMIDIMessages = 0;
+public:
+  SoulPatch(){
+    soulpatch.init(getSampleRate(), 0);
+    params = soulpatch.createParameterList();
+    for(size_t i=0; i<params.size(); ++i){
+      registerParameter(PatchParameterId(PARAMETER_A+i), params[i].properties.name);
+    }
+    ASSERT(getNumberOfChannels() >= SOULPATCH::numAudioInputChannels, "Too many input channels in SOUL patch");
+    ASSERT(getNumberOfChannels() >= SOULPATCH::numAudioOutputChannels, "Too many output channels in SOUL patch");
+    outputBuffer = AudioBuffer::create(SOULPATCH::numAudioOutputChannels, getBlockSize());
+  }
+  void processMidi(MidiMessage msg){
+    if(numMIDIMessages < MAX_MIDI_MESSAGES){
+      midiBuffer[numMIDIMessages] = {0, msg.data[1], msg.data[2], msg.data[3]};
+      numMIDIMessages++;
+    }
+  }
+  void processAudio(AudioBuffer &buffer){
+    SOULPATCH::RenderContext<float> ctx;
+    for(size_t i=0; i<params.size(); ++i){
+      float min = params[i].properties.minValue;
+      float max = params[i].properties.maxValue;
+      float value = getParameterValue(PatchParameterId(PARAMETER_A+i));      
+      params[i].setValue(value * (max-min) + min);
+    }
+    for(size_t i=0; i<ctx.inputChannels.size(); ++i)
+      ctx.inputChannels[i] = buffer.getSamples(i);
+    for(size_t i=0; i<ctx.outputChannels.size(); ++i){
+      outputBuffer->clear();
+      ctx.outputChannels[i] = outputBuffer->getSamples(i);
+      // ctx.outputChannels[i] = buffer.getSamples(i); // in-place
+    }
+    // debugMessage("xruns", (int)soulpatch.getNumXRuns());
+    ctx.numFrames = buffer.getSize();
+    ctx.incomingMIDI.messages = &midiBuffer[0];
+    // ctx.incomingMIDI.numMessages = 0;
+    ctx.incomingMIDI.numMessages = numMIDIMessages;
+    soulpatch.render(ctx);
+    numMIDIMessages = 0;
+    for(size_t i=0; i<ctx.outputChannels.size(); ++i){
+      buffer.getSamples(i).copyFrom(outputBuffer->getSamples(i));
+    }
+  }
+};
+
+#endif // __SoulPatch_hpp__

gen.mk

@@ -1,6 +1,6 @@
 GENSRC     ?= $(BUILDROOT)/GenSource
 
-.PHONY: .FORCE
+.PHONY: .FORCE gen
 
 $(BUILD)/Source/gen.h: .FORCE
 	@echo "#include \"$(GEN).h\"" > $@

soul.mk

@@ -0,0 +1,17 @@
+SOULSRC ?= $(BUILDROOT)/SoulSource
+SOULCC	?= Tools/soul
+SOULINC = $(BUILD)/Source/soul.hpp
+
+vpath %.soul $(PATCHSOURCE)
+
+.PHONY: .FORCE soul
+
+$(SOULINC): .FORCE
+	@echo "#include \"$(SOULHPP)\"" > $@
+	@echo "#define SOULPATCH $(SOULCLASS)" >> $@
+
+$(BUILD)/Source/$(SOULHPP): $(SOULFILE)
+	@$(SOULCC) generate --cpp $< --output=$@
+
+soul: $(SOULINC) $(BUILD)/Source/$(SOULHPP)
+	@cp $(SOULSRC)/* $(BUILD)/Source