refactor Screen to remove PLATFORM dependency

Author: Martin Klang

LibSource/Patch.cpp

@@ -75,31 +75,6 @@ int Patch::getElapsedCycles(){
   return *DWT_CYCCNT;
 }
 
-#ifdef USE_SCREEN
-  void drawMessage(ScreenBuffer& screen){
-    ProgramVector* pv = getProgramVector();
-    if(pv->message != NULL){
-      screen.setTextSize(1);
-      screen.setTextWrap(true);
-      screen.print(0, 26, pv->message);
-    }    
-  }
-  void drawTitle(const char* title, ScreenBuffer& screen){
-    // draw title
-    screen.setTextSize(2);
-    screen.print(0, 16, title);
-  }
-void Patch::processScreen(ScreenBuffer& screen){
-  // screen.clear();
-  const char* title = getInitialisingPatchProcessor()->getPatchName();
-  drawTitle(title, screen);
-  drawMessage(screen);
-  // const char title[] = "KickBox";
-  // screen.setTextSize(2);
-  // screen.print(0, 16, title);
-}
-#endif /* USE_SCREEN */
-
 #ifdef USE_MIDI_CALLBACK
 void Patch::processMidi(MidiMessage msg){}
 

LibSource/Patch.h

@@ -7,9 +7,6 @@
 #include "PatchParameter.h"
 #include "SmoothValue.h"
 #include "OpenWareMidiControl.h"
-#ifdef USE_SCREEN
-#include "ScreenBuffer.h"
-#endif /* USE_SCREEN */
 
 #ifdef USE_MIDI_CALLBACK
 #include "MidiMessage.h"
@@ -68,11 +65,6 @@ class Patch {
   virtual void buttonChanged(PatchButtonId bid, uint16_t value, uint16_t samples){}
   /* virtual void parameterChanged(PatchParameterId pid, float value, int samples){} */
   virtual void processAudio(AudioBuffer& audio) = 0;
-#ifdef USE_SCREEN
-  uint16_t getScreenWidth();
-  uint16_t getScreenHeight();
-  virtual void processScreen(ScreenBuffer& screen);
-#endif /* USE_SCREEN */
 #ifdef USE_MIDI_CALLBACK
   virtual void processMidi(MidiMessage msg);
   virtual void sendMidi(MidiMessage msg);

LibSource/ScreenBuffer.h

@@ -4,13 +4,18 @@
 #include <stdint.h>
 #include "device.h"
 
-#if defined SSD1309
-typedef uint8_t Colour;
-// Color definitions mono
-#define	BLACK           0x00
-#define WHITE           0x01
-#elif defined SSD1331 || defined SEPS114A
-typedef uint16_t Colour;
+enum ScreenDriver {
+   SSD1309 = 0x01,
+   SSD1331 = 0x02
+};
+
+// #if defined SSD1309
+// typedef uint8_t Colour;
+// // Color definitions mono
+// #define	BLACK           0x00
+// #define WHITE           0x01
+// #elif defined SSD1331 || defined SEPS114A
+// typedef uint16_t Colour;
 // Color definitions
 #define	BLACK           0x0000
 #define	BLUE            0x001F
@@ -20,10 +25,11 @@ typedef uint16_t Colour;
 #define MAGENTA         0xF81F
 #define YELLOW          0xFFE0  
 #define WHITE           0xFFFF
-#else
-#error "Invalid configuration"
-#endif
+// #else
+// #define NO_SCREEN
+// #endif
 
+template<ScreenDriver driver, typename Colour>
 class ScreenBuffer {
 private:
   const uint16_t width;
@@ -89,9 +95,4 @@ class ScreenBuffer {
   static ScreenBuffer* create(uint16_t width, uint16_t height);
 };
 
-/* class VideoPatch : public Patch { */
-/* public: */
-/*   virtual void processVideo(ScreenBuffer& video, AudioBuffer& audio) = 0; */
-/* }; */
-
 #endif // __ScreenBuffer_h__

README.md

@@ -73,7 +73,6 @@ Make sure to do a `make clean` before compiling a new patch, or add `clean` to y
 * PATCHOUT: number of output channels, default 2
 * SLOT: user program slot to store patch in, default 0
 * TARGET: changes the output prefix, default 'patch'
-* PLATFORM: Alchemist, Wizard, Prism, Magus, Player, default 'OWL'
 
 If you follow the convention of SimpleDelay then you don't have to specify `PATCHCLASS` and `PATCHFILE`, they will be deduced from `PATCHNAME`.
 t
@@ -122,18 +121,18 @@ 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) for magus platform:
+Compile the puredata file owl_hypersaw.pd[[7]](#ref7):
 
-    make HEAVY=owl_hypersaw PLATFORM=Magus clean patch
+    make HEAVY=owl_hypersaw clean patch
 
 
-Compile puredata file owl_hypersaw.pd for magus platform and send to device to be run immediately:
+Compile puredata file owl_hypersaw.pd and send to device to be run immediately:
 
-    make HEAVY=owl_hypersaw PLATFORM=Magus clean run
+    make HEAVY=owl_hypersaw clean run
 
-Compile KickBox[[8]](#ref8) C++ patch for for magus platform:
+Compile KickBox[[8]](#ref8) C++ patch:
 
-    make PATCHNAME=KickBox PLATFORM=Magus clean patch
+    make PATCHNAME=KickBox clean patch
 
 
 # References

Source/PatchProgram.cpp

@@ -46,16 +46,6 @@ void onButtonChanged(uint8_t id, uint16_t value, uint16_t samples){
     processor.patch->buttonChanged((PatchButtonId)id, value, samples);
 }
 
-#ifdef USE_SCREEN
-void onDrawCallback(uint8_t* pixels, uint16_t width, uint16_t height){
-  if(processor.patch != NULL){
-    ScreenBuffer screen(width, height);
-    screen.setBuffer(pixels);
-    processor.patch->processScreen(screen);
-  }
-}
-#endif /* USE_SCREEN */
-
 #ifdef USE_MIDI_CALLBACK
 void onMidiCallback(uint8_t port, uint8_t status, uint8_t d1, uint8_t d2){
   static MidiMessage msg;
@@ -88,10 +78,6 @@ void registerPatch(const char* name, uint8_t inputs, uint8_t outputs, Patch* pat
 static SampleBuffer* samples;
 void setup(ProgramVector* pv){
   setSystemTables(pv);
-#ifdef USE_SCREEN
-  void* drawArgs[] = {(void*)SYSTEM_FUNCTION_DRAW, (void*)&onDrawCallback};
-  getProgramVector()->serviceCall(OWL_SERVICE_REGISTER_CALLBACK, drawArgs, 2);
-#endif /* USE_SCREEN */
 #ifdef USE_MIDI_CALLBACK
   void* midiRxArgs[] = {(void*)SYSTEM_FUNCTION_MIDI, (void*)&onMidiCallback};
   getProgramVector()->serviceCall(OWL_SERVICE_REGISTER_CALLBACK, midiRxArgs, 2);

Source/ScreenBuffer.cpp

@@ -1,4 +1,7 @@
 #include "ScreenBuffer.h"
+
+#ifndef NO_SCREEN
+
 #include <string.h>
 #include <stddef.h>
 #include "font.c"
@@ -226,3 +229,4 @@ void ScreenBuffer::write(uint8_t c) {
     }
   }
 }
+#endif

Source/device.h

@@ -1,23 +1,5 @@
 #include <inttypes.h>
 
-#if defined OWL_MAGUS
-#define USE_SCREEN
-#define SSD1309
-#define AUDIO_MAX_BLOCK_SIZE         512
-#elif defined OWL_PRISM
-#define USE_SCREEN
-#define SEPS114A
-#define AUDIO_MAX_BLOCK_SIZE         256
-#elif defined OWL_PLAYER
-#define USE_SCREEN
-#define SSD1309
-#define AUDIO_MAX_BLOCK_SIZE         512
-#elif defined OWL_ALCHEMIST
-#define AUDIO_MAX_BLOCK_SIZE         512
-#elif defined OWL_WIZARD
-#define AUDIO_MAX_BLOCK_SIZE         512
-#endif
-
 #define USE_MIDI_CALLBACK
 
 #if !defined OWL_CLASSIC

Source/main.cpp

@@ -69,11 +69,6 @@ int main(void){
     return -1;
   }
 
-  if(pv->audio_blocksize > AUDIO_MAX_BLOCK_SIZE){     
-    error(CONFIGURATION_ERROR_STATUS, "Invalid blocksize");
-    return -1;
-  }
-
   size_t before = xPortGetFreeHeapSize();
   setup(pv);
   pv->heap_bytes_used = before - xPortGetFreeHeapSize();

compile.mk

@@ -10,6 +10,7 @@ CPP_SRC += WavetableOscillator.cpp PolyBlepOscillator.cpp
 CPP_SRC += SmoothValue.cpp PatchParameter.cpp
 CPP_SRC += PatchProgram.cpp 
 # CPP_SRC += ShortPatchProgram.cpp 
+CPP_SRC += ScreenBuffer.cpp ScreenBufferDevice.cpp
 
 SOURCE       = $(BUILDROOT)/Source
 LIBSOURCE    = $(BUILDROOT)/LibSource
@@ -53,21 +54,6 @@ CXXFLAGS = -fno-rtti -fno-exceptions
 
 ifdef HEAVY
 CPPFLAGS    += -D__unix__ -DHV_SIMD_NONE
-else ifeq ($(PLATFORM),Alchemist)
-CPPFLAGS    += -DOWL_ALCHEMIST
-else ifeq ($(PLATFORM),Wizard)
-CPPFLAGS    += -DOWL_WIZARD
-else ifeq ($(PLATFORM),Prism)
-CPPFLAGS    += -DOWL_PRISM
-CPP_SRC     += ScreenBuffer.cpp ScreenBufferDevice.cpp
-else ifeq ($(PLATFORM),Magus)
-CPPFLAGS    += -DOWL_MAGUS
-CPP_SRC     += ScreenBuffer.cpp ScreenBufferDevice.cpp
-else ifeq ($(PLATFORM),Player)
-CPPFLAGS    += -DOWL_PLAYER
-CPP_SRC     += ScreenBuffer.cpp ScreenBufferDevice.cpp
-else
-CPPFLAGS    += -DOWL_CLASSIC
 endif
 
 CC=gcc