Rename LEDMatrix to LEDOutput

Author: pschatzmann

examples/tests/fft/fft-ledmatrix/fft-ledmatrix.ino

@@ -1,7 +1,7 @@
 #include "AudioTools.h"
 #include "AudioLibs/AudioKit.h"
 #include "AudioLibs/AudioRealFFT.h" // or AudioKissFFT
-#include "AudioLibs/LEDMatrix.h"
+#include "AudioLibs/LEDOutput.h"
 
 #define PIN_LEDS 22
 #define LED_X 32
@@ -10,7 +10,7 @@
 AudioKitStream kit;  // Audio source
 AudioRealFFT fft; // or AudioKissFFT
 StreamCopy copier(fft, kit);  // copy mic to fft
-LEDMatrix led(fft); // output to LED matrix
+LEDOutput led(fft); // output to LED matrix
 
 void setup() {
   Serial.begin(115200);
@@ -33,7 +33,7 @@ void setup() {
   lcfg.y = LED_Y;
   led.begin(lcfg);
 
-  // addLeds
+  // add LEDs
   FastLED.addLeds<WS2812B, PIN_LEDS, GRB>(led.ledData(), led.ledCount());
 }
 

src/AudioLibs/LEDMatrix.h renamed to src/AudioLibs/LEDOutput.h

@@ -3,38 +3,49 @@
 #include "AudioLibs/AudioFFT.h"
 
 namespace audio_tools {
+class LEDOutput;
+struct LEDOutputConfig;
 
-void *selfLEDMatrix=nullptr;
+LEDOutput *selfLEDOutput=nullptr;
+// default callback function which implements led update
+void updateLEDOutput(LEDOutputConfig*cfg, LEDOutput *matrix, int  max_y);
 
 /**
  * LED Matrix Configuration. Provide the number of leds in x and y direction and
  * the data pin.
  */
-struct LEDMatrixConfig {
+struct LEDOutputConfig {
+  /// Number of leds in x direction
   int x = 0;
+  /// Number of leds in y direction
   int y = 0;
+  /// Default color
   int color = CRGB::Blue;
+  /// optinal custom logic to select color
   int (*get_color)(int x, int y, int magnitude) = nullptr;
+  /// Custom callback logic to update the LEDs - by default we use updateLEDOutput()
+  void (*update)(LEDOutputConfig*cfg, LEDOutput *matrix, int  max_y) = updateLEDOutput;
+  /// Update the leds only ever nth call
   int update_frequency = 1; // update every call
 };
 
 /**
- * LEDMatrix using the FastLED library. You write the data to the FFT Stream.
+ * LEDOutput using the FastLED library. You write the data to the FFT Stream.
  * This displays the result of the FFT to a LED matrix.
  */
-class LEDMatrix {
+class LEDOutput {
 public:
-  LEDMatrixConfig defaultConfig() { return cfg; }
+  LEDOutputConfig defaultConfig() { return cfg; }
 
-  LEDMatrix(AudioFFTBase &fft) {
-    selfLEDMatrix = this;
+  LEDOutput(AudioFFTBase &fft) {
+    selfLEDOutput = this;
     p_fft = &fft;
     AudioFFTConfig &fft_cfg = p_fft->config();
     fft_cfg.callback = fftCallback;
   }
 
   /// Setup Led matrix
-  bool begin(LEDMatrixConfig config) {
+  bool begin(LEDOutputConfig config) {
     cfg = config;
     if (!*p_fft) {
       LOGE("fft not started");
@@ -51,6 +62,8 @@ class LEDMatrix {
 
     // number of bins
     magnitudes.resize(p_fft->size());
+
+    return true;
   }
 
   // Provides the number of LEDs: call begin() first!
@@ -71,42 +84,20 @@ class LEDMatrix {
   }
 
   /// Updates the display: call this method in your loop
-  void update() {
+  virtual void update() {
     if (count++ % cfg.update_frequency == 0) {
-      for (int x = 0; x < cfg.x; x++) {
-        // max y determined by magnitude
-        int maxY = mapFloat(getMagnitude(x), 0.0f, max_y, 0.0f,
-                            static_cast<float>(cfg.y));
-        // update horizontal bar
-        for (int y = 0; y < maxY; y++) {
-          int color = cfg.color;
-          if (cfg.get_color != nullptr) {
-            color = cfg.get_color(x, y, maxY);
-          }
-          xyLed(x, y) = color;
-        }
-      }
-      FastLED.show();
+      // use custom update logic defined in config
+      cfg.update(&cfg, this, max_y);
     }
   }
 
-protected:
-  friend class AudioFFTBase;
-  Vector<CRGB> leds{0};
-  Vector<float> magnitudes{0};
-  LEDMatrixConfig cfg;
-  int magnitude_div = 1;
-  AudioFFTBase *p_fft = nullptr;
-  float max_y = 1000.0f;
-  uint64_t count = 0;
-
-  // determine index of the led with the help of the x and y pos
+  /// Determine the led with the help of the x and y pos
   CRGB &xyLed(uint8_t x, uint8_t y) {
     int index = (y * cfg.x) + x;
     return leds[index];
   }
 
-  /// @brief  returns the magnitude for the indicated led x position. We might
+  /// Returns the magnitude for the indicated led x position. We might
   /// need to combine values from the magnitudes array if this is much bigger.
   float getMagnitude(int x) {
     float total = 0;
@@ -119,23 +110,50 @@ class LEDMatrix {
       total += magnitudes[x];
     }
     // determine max y to scale output
-    LEDMatrix* self = static_cast<LEDMatrix*>(selfLEDMatrix);
-    if (self->max_y > total) {
-      self->max_y = total;
+    if (selfLEDOutput->max_y > total) {
+      selfLEDOutput->max_y = total;
     }
     return total;
   }
 
+protected:
+  friend class AudioFFTBase;
+  Vector<CRGB> leds{0};
+  Vector<float> magnitudes{0};
+  LEDOutputConfig cfg;
+  int magnitude_div = 1;
+  AudioFFTBase *p_fft = nullptr;
+  float max_y = 1000.0f;
+  uint64_t count = 0;
+
+
   /// callback method which provides updated data from fft
   static void fftCallback(AudioFFTBase &fft) {
     // just save magnitudes to be displayed
-    LEDMatrix* self = static_cast<LEDMatrix*>(selfLEDMatrix);
-
     for (int j = 0; j < fft.size(); j++) {
       float value = fft.magnitude(j);
-      self->magnitudes[j] = value;
+      selfLEDOutput->magnitudes[j] = value;
     }
   };
 };
 
+
+void updateLEDOutput(LEDOutputConfig*cfg, LEDOutput *matrix, int  max_y){
+  for (int x = 0; x < cfg->x; x++) {
+    // max y determined by magnitude
+    int maxY = mapFloat(matrix->getMagnitude(x), 0.0f, max_y, 0.0f,
+                        static_cast<float>(cfg->y));
+    // update horizontal bar
+    for (int y = 0; y < maxY; y++) {
+      int color = cfg->color;
+      if (cfg->get_color != nullptr) {
+        color = cfg->get_color(x, y, maxY);
+      }
+      matrix->xyLed(x, y) = color;
+    }
+  }
+  FastLED.show();
+}
+
+
 } // namespace audio_tools