STKEffects and flush cleanup

Author: pschatzmann

src/AudioConfig.h

@@ -447,9 +447,5 @@ typedef uint32_t eps32_i2s_sample_rate_type;
 
 #ifdef IS_DESKTOP
 #define USE_URL_ARDUINO
-#define FLUSH_OVERRIDE override
 #endif
 
-#ifndef FLUSH_OVERRIDE
-#define FLUSH_OVERRIDE 
-#endif

src/AudioEffects/AudioEffects.h

@@ -6,9 +6,6 @@
 #ifdef  USE_EFFECTS_SUITE
 #include "AudioEffects/AudioEffectsSuite.h"
 #endif
-#ifdef  USE_STK
-#include "AudioEffects/STKEffects.h"
-#endif
 
 namespace audio_tools {
 

src/AudioEffects/STKEffects.h

@@ -2,6 +2,7 @@
 
 #include "AudioConfig.h"
 #include "Arduino.h"
+#include "AudioEffects/AudioEffect.h"
 #ifdef ESP32
 #  include "freertos/FreeRTOS.h"
 #endif
@@ -105,6 +106,153 @@ class STKStream : public GeneratedSoundStream<int16_t> {
 
 };
 
+/**
+ * @brief Use any effect from the STK framework: e.g. Chorus, Echo, FreeVerb, JCRev,
+ * PitShift... https://github.com/pschatzmann/Arduino-STK
+ *
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
+class STKEffect : public AudioEffect {
+public:
+  STKEffect(stk::Effect &stkEffect) { p_effect = &stkEffect; }
+
+  virtual effect_t process(effect_t in) {
+    // just convert between int16 and float
+    float value = static_cast<float>(in) / 32767.0;
+    return p_effect->tick(value) * 32767.0;
+  }
+
+protected:
+  stk::Effect *p_effect = nullptr;
+};
+
+/**
+ * @brief Chorus Effect
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
+class STKChorus : public AudioEffect, public stk::Chorus {
+public:
+  STKChorus(float baseDelay = 6000) : stk::Chorus(baseDelay) {}
+
+  virtual effect_t process(effect_t in) {
+    // just convert between int16 and float
+    float value = static_cast<float>(in) / 32767.0;
+    return tick(value) * 32767.0;
+  }
+};
+
+/**
+ * @brief Echo Effect
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
+class STKEcho : public AudioEffect, public stk::Echo {
+public:
+  STKEcho(unsigned long maximumDelay = (unsigned long)Stk::sampleRate())
+      : stk::Echo(maximumDelay) {}
+
+  virtual effect_t process(effect_t in) {
+    // just convert between int16 and float
+    float value = static_cast<float>(in) / 32767.0;
+    return tick(value) * 32767.0;
+  }
+};
+
+/**
+ * @brief Jezar at Dreampoint's FreeVerb, implemented in STK.
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
+class STKFreeVerb : public AudioEffect, public stk::FreeVerb {
+public:
+  STKFreeVerb() = default;
+  virtual effect_t process(effect_t in) {
+    // just convert between int16 and float
+    float value = static_cast<float>(in) / 32767.0;
+    return tick(value) * 32767.0;
+  }
+};
+
+/**
+ * @brief John Chowning's reverberator class.
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
+class STKChowningReverb : public AudioEffect, public stk::JCRev {
+public:
+  STKChowningReverb() = default;
+
+  virtual effect_t process(effect_t in) {
+    // just convert between int16 and float
+    float value = static_cast<float>(in) / 32767.0;
+    return tick(value) * 32767.0;
+  }
+};
+
+/**
+ * @brief CCRMA's NRev reverberator class.
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
+class STKNReverb : public AudioEffect, public stk::NRev {
+public:
+  STKNReverb(float t60 = 1.0) : NRev(t60) {}
+  virtual effect_t process(effect_t in) {
+    // just convert between int16 and float
+    float value = static_cast<float>(in) / 32767.0;
+    return tick(value) * 32767.0;
+  }
+};
+
+/**
+ * @brief Perry's simple reverberator class
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
+class STKPerryReverb : public AudioEffect, public stk::PRCRev {
+public:
+  STKPerryReverb(float t60 = 1.0) : PRCRev(t60) {}
+  virtual effect_t process(effect_t in) {
+    // just convert between int16 and float
+    float value = static_cast<float>(in) / 32767.0;
+    return tick(value) * 32767.0;
+  }
+};
+
+/**
+ * @brief Pitch shifter effect class based on the Lent algorithm
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
+class STKLentPitShift : public AudioEffect, public stk::LentPitShift {
+public:
+  STKLentPitShift(float periodRatio = 1.0, int tMax = 512)
+      : stk::LentPitShift(periodRatio, tMax) {}
+
+  virtual effect_t process(effect_t in) {
+    // just convert between int16 and float
+    float value = static_cast<float>(in) / 32767.0;
+    return tick(value) * 32767.0;
+  }
+};
+
+/**
+ * @brief Pitch shifter effect class based on the Lent algorithm
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
+class STKPitShift : public AudioEffect, public stk::PitShift {
+public:
+  STKPitShift() = default;
+  virtual effect_t process(effect_t in) {
+    // just convert between int16 and float
+    float value = static_cast<float>(in) / 32767.0;
+    return tick(value) * 32767.0;
+  }
+};
+
 
 }
 

src/AudioLibs/AudioSTK.h

@@ -32,7 +32,7 @@ class AudioPrint : public Print, public AudioBaseInfoDependent, public AudioBase
             return 0;
         }
 
-        void flush() FLUSH_OVERRIDE {
+        void flush()  {
             write((const uint8_t*)tmp, tmpPos-1);
             tmpPos=0;
         }

src/AudioTools/AudioOutput.h

@@ -66,6 +66,8 @@ class AudioStream : public Stream, public AudioBaseInfoDependent, public AudioBa
     return info;
   }
 
+  virtual void flush() {}
+
  protected:
   AudioBaseInfoDependent *p_notify=nullptr;
   AudioBaseInfo info;
@@ -92,7 +94,6 @@ class AudioStreamX : public AudioStream {
 
   virtual int read() override { return not_supported(-1); }
   virtual int peek() override { return not_supported(-1); }
-  virtual void flush() FLUSH_OVERRIDE {}
 };
 
 /**