Transition styles

platformio.ini

@@ -310,7 +310,7 @@ platform = ${common.platform_wled_default}
 platform_packages = ${common.platform_packages}
 board_build.ldscript = ${common.ldscript_4m1m}
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP8266 #-DWLED_DISABLE_2D
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP8266 -DWLEDISABLE_TRANSITION_STYLES #-DWLED_DISABLE_2D
 lib_deps = ${esp8266.lib_deps}
 monitor_filters = esp8266_exception_decoder
 

wled00/FX.h

@@ -321,6 +321,21 @@
 
 #define MODE_COUNT                     187
 
+#define TRANSITION_STYLE_FADE            0
+#define TRANSITION_STYLE_SWIPE_RIGHT     1
+#define TRANSITION_STYLE_SWIPE_LEFT      2
+#define TRANSITION_STYLE_SWIPE_UP        3
+#define TRANSITION_STYLE_SWIPE_DOWN      4
+#define TRANSITION_STYLE_PUSH_RIGHT      5
+#define TRANSITION_STYLE_PUSH_LEFT       6
+#define TRANSITION_STYLE_PUSH_UP         7
+#define TRANSITION_STYLE_PUSH_DOWN       8
+#define TRANSITION_STYLE_OUTSIDE_IN      9
+#define TRANSITION_STYLE_INSIDE_OUT      10
+#define TRANSITION_STYLE_FAIRY_DUST      11
+
+#define TRANSITION_STYLE_COUNT           12
+
 typedef enum mapping1D2D {
   M12_Pixels = 0,
   M12_pBar = 1,
@@ -378,6 +393,10 @@ typedef struct Segment {
     uint16_t aux1;  // custom var
     byte     *data; // effect data pointer
     static uint16_t maxWidth, maxHeight;  // these define matrix width & height (max. segment dimensions)
+    #ifndef WLED_DISABLE_TRANSITION_STYLES
+    uint32_t *buffer1;
+    uint32_t *buffer2;
+    #endif
 
     typedef struct TemporarySegmentData {
       uint16_t _optionsT;
@@ -424,6 +443,10 @@ typedef struct Segment {
     static uint16_t _lastPaletteBlend;        // blend palette according to set Transition Delay in millis()%0xFFFF
     #ifndef WLED_DISABLE_MODE_BLEND
     static bool          _modeBlend;          // mode/effect blending semaphore
+    #ifndef WLED_DISABLE_TRANSITION_STYLES
+    static uint32_t*     _activeBuffer;       // pointer to the buffer where the mode should be rendered to
+    uint16_t             _bufferSize;
+    #endif
     #endif
 
     // transition data, valid only if transitional==true, holds values during transition (72 bytes)
@@ -449,7 +472,6 @@ typedef struct Segment {
     } *_t;
 
   public:
-
     Segment(uint16_t sStart=0, uint16_t sStop=30) :
       start(sStart),
       stop(sStop),
@@ -479,8 +501,15 @@ typedef struct Segment {
       aux0(0),
       aux1(0),
       data(nullptr),
+#ifndef WLED_DISABLE_TRANSITION_STYLES
+      buffer1(nullptr),
+      buffer2(nullptr),
+#endif
       _capabilities(0),
       _dataLen(0),
+#ifndef WLED_DISABLE_TRANSITION_STYLES
+      _bufferSize(0),
+#endif
       _t(nullptr)
     {
       #ifdef WLED_DEBUG
@@ -504,13 +533,22 @@ typedef struct Segment {
       //Serial.println();
       #endif
       if (name) { delete[] name; name = nullptr; }
+      #ifndef WLED_DISABLE_TRANSITION_STYLES
+      if (buffer1) { delete[] buffer1; buffer1 = nullptr; }
+      if (buffer2) { delete[] buffer2; buffer2 = nullptr; }
+      #endif
       stopTransition();
       deallocateData();
     }
 
     Segment& operator= (const Segment &orig); // copy assignment
     Segment& operator= (Segment &&orig) noexcept; // move assignment
 
+#ifndef WLED_DISABLE_TRANSITION_STYLES
+    void allocateBuffers();
+    void savePixelsToBuffer(uint32_t* buffer);
+#endif
+
 #ifdef WLED_DEBUG
     size_t getSize() const { return sizeof(Segment) + (data?_dataLen:0) + (name?strlen(name):0) + (_t?sizeof(Transition):0); }
 #endif
@@ -533,6 +571,9 @@ typedef struct Segment {
     static void     addUsedSegmentData(int len) { _usedSegmentData += len; }
     #ifndef WLED_DISABLE_MODE_BLEND
     static void     modeBlend(bool blend)       { _modeBlend = blend; }
+    #ifndef WLED_DISABLE_TRANSITION_STYLES
+    static void     renderToBuffer(uint32_t* buffer) { _activeBuffer = buffer; }
+    #endif
     #endif
     static void     handleRandomPalette();
 
@@ -584,6 +625,7 @@ typedef struct Segment {
     inline void setPixelColor(float i, uint8_t r, uint8_t g, uint8_t b, uint8_t w = 0, bool aa = true) { setPixelColor(i, RGBW32(r,g,b,w), aa); }
     inline void setPixelColor(float i, CRGB c, bool aa = true)                                         { setPixelColor(i, RGBW32(c.r,c.g,c.b,0), aa); }
     uint32_t getPixelColor(int i);
+    int getPixelIndex(int i);
     // 1D support functions (some implement 2D as well)
     void blur(uint8_t);
     void fill(uint32_t c);
@@ -680,6 +722,10 @@ class WS2812FX {  // 96 bytes
     ModeData(uint8_t id, uint16_t (*fcn)(void), const char *data) : _id(id), _fcn(fcn), _data(data) {}
   } mode_data_t;
 
+#ifndef WLED_DISABLE_TRANSITION_STYLES
+  typedef void (*transition_ptr)(void); // pointer to transition function
+#endif
+
   static WS2812FX* instance;
 
   public:
@@ -711,6 +757,9 @@ class WS2812FX {  // 96 bytes
       _hasWhiteChannel(false),
       _triggered(false),
       _modeCount(MODE_COUNT),
+#ifndef WLED_DISABLE_TRANSITION_STYLES
+      _transitionStyleCount(TRANSITION_STYLE_COUNT),
+#endif
       _callback(nullptr),
       customMappingTable(nullptr),
       customMappingSize(0),
@@ -731,12 +780,21 @@ class WS2812FX {  // 96 bytes
       _modeData.reserve(_modeCount); // allocate memory to prevent initial fragmentation (does not increase size())
       if (_mode.capacity() <= 1 || _modeData.capacity() <= 1) _modeCount = 1; // memory allocation failed only show Solid
       else setupEffectData();
+
+#ifndef WLED_DISABLE_TRANSITION_STYLES
+      _transitionStyles.reserve(_transitionStyleCount); // allocate memory to prevent initial fragmentation (does not increase size())
+      if (_mode.capacity() <= 1 || _modeData.capacity() <= 1) _transitionStyleCount = 0; // memory allocation failed, disable transition styles
+      else setupTransitionStyleData();
+#endif
     }
 
     ~WS2812FX() {
       if (customMappingTable) delete[] customMappingTable;
       _mode.clear();
       _modeData.clear();
+#ifndef WLED_DISABLE_TRANSITION_STYLES
+      _transitionStyles.clear();
+#endif
       _segments.clear();
 #ifndef WLED_DISABLE_2D
       panel.clear();
@@ -769,6 +827,11 @@ class WS2812FX {  // 96 bytes
       addEffect(uint8_t id, mode_ptr mode_fn, const char *mode_name), // add effect to the list; defined in FX.cpp
       setupEffectData(void);                      // add default effects to the list; defined in FX.cpp
 
+#ifndef WLED_DISABLE_TRANSITION_STYLES
+    void setupTransitionStyleData();
+    void addTransitionStyle(uint8_t id, transition_ptr func, const char *name, bool only2D); // add transition style to the list
+#endif
+
     inline void restartRuntime()          { for (Segment &seg : _segments) seg.markForReset(); }
     inline void setTransitionMode(bool t) { for (Segment &seg : _segments) seg.startTransition(t ? _transitionDur : 0); }
     inline void setColor(uint8_t slot, uint8_t r, uint8_t g, uint8_t b, uint8_t w = 0)    { setColor(slot, RGBW32(r,g,b,w)); }
@@ -813,6 +876,9 @@ class WS2812FX {  // 96 bytes
     inline uint8_t getPaletteCount()      { return 13 + GRADIENT_PALETTE_COUNT; }  // will only return built-in palette count
     inline uint8_t getTargetFps()         { return _targetFps; }        // returns rough FPS value for las 2s interval
     inline uint8_t getModeCount()         { return _modeCount; }        // returns number of registered modes/effects
+#ifndef WLED_DISABLE_TRANSITION_STYLES
+    inline uint8_t getTransitionStyleCount() { return _transitionStyleCount; }
+#endif
 
     uint16_t
       getLengthPhysical(void),
@@ -838,6 +904,11 @@ class WS2812FX {  // 96 bytes
 
     const char **
       getModeDataSrc(void) { return &(_modeData[0]); } // vectors use arrays for underlying data
+
+#ifndef WLED_DISABLE_TRANSITION_STYLES
+    const char* getTransitionStyleName(uint8_t id) { return (id && id<_transitionStyleCount) ? _transitionStyles[id]._name : PSTR("Fade"); }
+    bool isTransitionStyle2DOnly(uint8_t id) { return (id && id<_transitionStyleCount) ? _transitionStyles[id]._only2D : false; }
+#endif
 
     Segment&        getSegment(uint8_t id);
     inline Segment& getFirstSelectedSeg(void) { return _segments[getFirstSelectedSegId()]; }  // returns reference to first segment that is "selected"
@@ -923,6 +994,22 @@ class WS2812FX {  // 96 bytes
     uint8_t                  _modeCount;
     std::vector<mode_ptr>    _mode;     // SRAM footprint: 4 bytes per element
     std::vector<const char*> _modeData; // mode (effect) name and its slider control data array
+#ifndef WLED_DISABLE_TRANSITION_STYLES
+    uint8_t                  _transitionStyleCount;
+
+    struct TransitionStyleData {
+      TransitionStyleData() : _name("RSVD"), _only2D(false) {}
+      TransitionStyleData(transition_ptr func, const char* name, bool only2D)
+        : _func(func),
+          _name(name),
+          _only2D(only2D) {}
+
+      transition_ptr _func;
+      const char* _name;
+      bool _only2D;
+    };
+    std::vector<TransitionStyleData> _transitionStyles; // transition style names
+#endif
 
     show_callback _callback;
 

wled00/FX_2Dfcn.cpp

@@ -181,6 +181,13 @@ void IRAM_ATTR Segment::setPixelColorXY(int x, int y, uint32_t col)
     col = RGBW32(r, g, b, w);
   }
 
+  #ifndef WLED_DISABLE_TRANSITION_STYLES
+  if (_activeBuffer) {
+    _activeBuffer[y * virtualWidth() + x] = col;
+    return;
+  }
+  #endif
+
   if (reverse  ) x = virtualWidth()  - x - 1;
   if (reverse_y) y = virtualHeight() - y - 1;
   if (transpose) { uint16_t t = x; x = y; y = t; } // swap X & Y if segment transposed
@@ -195,7 +202,7 @@ void IRAM_ATTR Segment::setPixelColorXY(int x, int y, uint32_t col)
       uint16_t xX = (x+g), yY = (y+j);
       if (xX >= width() || yY >= height()) continue; // we have reached one dimension's end
 
-#ifndef WLED_DISABLE_MODE_BLEND
+#if ! defined(WLED_DISABLE_MODE_BLEND) && defined(WLED_DISABLE_TRANSITION_STYLES)
       // if blending modes, blend with underlying pixel
       if (_modeBlend) tmpCol = color_blend(strip.getPixelColorXY(start + xX, startY + yY), col, 0xFFFFU - progress(), true);
 #endif
@@ -265,6 +272,12 @@ void Segment::setPixelColorXY(float x, float y, uint32_t col, bool aa)
 uint32_t IRAM_ATTR Segment::getPixelColorXY(uint16_t x, uint16_t y) {
   if (!isActive()) return 0; // not active
   if (x >= virtualWidth() || y >= virtualHeight() || x<0 || y<0) return 0;  // if pixel would fall out of virtual segment just exit
+  #ifndef WLED_DISABLE_TRANSITION_STYLES
+  if (_activeBuffer) {
+    return _activeBuffer[y * virtualWidth() + x];
+  }
+  #endif
+
   if (reverse  ) x = virtualWidth()  - x - 1;
   if (reverse_y) y = virtualHeight() - y - 1;
   if (transpose) { uint16_t t = x; x = y; y = t; } // swap X & Y if segment transposed