869 lines
36 KiB
C++
869 lines
36 KiB
C++
/*
|
|
WS2812FX.h - Library for WS2812 LED effects.
|
|
Harm Aldick - 2016
|
|
www.aldick.org
|
|
LICENSE
|
|
The MIT License (MIT)
|
|
Copyright (c) 2016 Harm Aldick
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
|
|
Modified for WLED
|
|
*/
|
|
|
|
#ifndef WS2812FX_h
|
|
#define WS2812FX_h
|
|
|
|
#include <vector>
|
|
|
|
#include "const.h"
|
|
|
|
#define FASTLED_INTERNAL //remove annoying pragma messages
|
|
#define USE_GET_MILLISECOND_TIMER
|
|
#include "FastLED.h"
|
|
|
|
#define DEFAULT_BRIGHTNESS (uint8_t)127
|
|
#define DEFAULT_MODE (uint8_t)0
|
|
#define DEFAULT_SPEED (uint8_t)128
|
|
#define DEFAULT_INTENSITY (uint8_t)128
|
|
#define DEFAULT_COLOR (uint32_t)0xFFAA00
|
|
#define DEFAULT_C1 (uint8_t)128
|
|
#define DEFAULT_C2 (uint8_t)128
|
|
#define DEFAULT_C3 (uint8_t)128
|
|
|
|
#ifndef MIN
|
|
#define MIN(a,b) ((a)<(b)?(a):(b))
|
|
#endif
|
|
#ifndef MAX
|
|
#define MAX(a,b) ((a)>(b)?(a):(b))
|
|
#endif
|
|
|
|
//color mangling macros
|
|
#ifndef RGBW32
|
|
#define RGBW32(r,g,b,w) (uint32_t((byte(w) << 24) | (byte(r) << 16) | (byte(g) << 8) | (byte(b))))
|
|
#endif
|
|
|
|
/* Not used in all effects yet */
|
|
#define WLED_FPS 42
|
|
#define FRAMETIME_FIXED (1000/WLED_FPS)
|
|
//#define FRAMETIME _frametime
|
|
#define FRAMETIME strip.getFrameTime()
|
|
|
|
/* each segment uses 52 bytes of SRAM memory, so if you're application fails because of
|
|
insufficient memory, decreasing MAX_NUM_SEGMENTS may help */
|
|
#ifdef ESP8266
|
|
#define MAX_NUM_SEGMENTS 16
|
|
/* How much data bytes all segments combined may allocate */
|
|
#define MAX_SEGMENT_DATA 5120
|
|
#else
|
|
#ifndef MAX_NUM_SEGMENTS
|
|
#define MAX_NUM_SEGMENTS 32
|
|
#endif
|
|
#define MAX_SEGMENT_DATA 32767
|
|
#endif
|
|
|
|
/* How much data bytes each segment should max allocate to leave enough space for other segments,
|
|
assuming each segment uses the same amount of data. 256 for ESP8266, 640 for ESP32. */
|
|
#define FAIR_DATA_PER_SEG (MAX_SEGMENT_DATA / strip.getMaxSegments())
|
|
|
|
#define MIN_SHOW_DELAY (_frametime < 16 ? 8 : 15)
|
|
|
|
#define NUM_COLORS 3 /* number of colors per segment */
|
|
#define SEGMENT strip._segments[strip.getCurrSegmentId()]
|
|
#define SEGENV strip._segments[strip.getCurrSegmentId()]
|
|
//#define SEGCOLOR(x) strip._segments[strip.getCurrSegmentId()].currentColor(x, strip._segments[strip.getCurrSegmentId()].colors[x])
|
|
//#define SEGLEN strip._segments[strip.getCurrSegmentId()].virtualLength()
|
|
#define SEGCOLOR(x) strip.segColor(x) /* saves us a few kbytes of code */
|
|
#define SEGPALETTE strip._currentPalette
|
|
#define SEGLEN strip._virtualSegmentLength /* saves us a few kbytes of code */
|
|
#define SPEED_FORMULA_L (5U + (50U*(255U - SEGMENT.speed))/SEGLEN)
|
|
|
|
// some common colors
|
|
#define RED (uint32_t)0xFF0000
|
|
#define GREEN (uint32_t)0x00FF00
|
|
#define BLUE (uint32_t)0x0000FF
|
|
#define WHITE (uint32_t)0xFFFFFF
|
|
#define BLACK (uint32_t)0x000000
|
|
#define YELLOW (uint32_t)0xFFFF00
|
|
#define CYAN (uint32_t)0x00FFFF
|
|
#define MAGENTA (uint32_t)0xFF00FF
|
|
#define PURPLE (uint32_t)0x400080
|
|
#define ORANGE (uint32_t)0xFF3000
|
|
#define PINK (uint32_t)0xFF1493
|
|
#define ULTRAWHITE (uint32_t)0xFFFFFFFF
|
|
|
|
// options
|
|
// bit 7: segment is in transition mode
|
|
// bits 4-6: TBD
|
|
// bit 3: mirror effect within segment
|
|
// bit 2: segment is on
|
|
// bit 1: reverse segment
|
|
// bit 0: segment is selected
|
|
#define NO_OPTIONS (uint16_t)0x0000
|
|
#define TRANSPOSED (uint16_t)0x0400 // rotated 90deg & reversed
|
|
#define REVERSE_Y_2D (uint16_t)0x0200
|
|
#define MIRROR_Y_2D (uint16_t)0x0100
|
|
#define TRANSITIONAL (uint16_t)0x0080
|
|
#define MIRROR (uint16_t)0x0008
|
|
#define SEGMENT_ON (uint16_t)0x0004
|
|
#define REVERSE (uint16_t)0x0002
|
|
#define SELECTED (uint16_t)0x0001
|
|
|
|
#define FX_MODE_STATIC 0
|
|
#define FX_MODE_BLINK 1
|
|
#define FX_MODE_BREATH 2
|
|
#define FX_MODE_COLOR_WIPE 3
|
|
#define FX_MODE_COLOR_WIPE_RANDOM 4
|
|
#define FX_MODE_RANDOM_COLOR 5
|
|
#define FX_MODE_COLOR_SWEEP 6
|
|
#define FX_MODE_DYNAMIC 7
|
|
#define FX_MODE_RAINBOW 8
|
|
#define FX_MODE_RAINBOW_CYCLE 9
|
|
#define FX_MODE_SCAN 10
|
|
#define FX_MODE_DUAL_SCAN 11
|
|
#define FX_MODE_FADE 12
|
|
#define FX_MODE_THEATER_CHASE 13
|
|
#define FX_MODE_THEATER_CHASE_RAINBOW 14
|
|
#define FX_MODE_RUNNING_LIGHTS 15
|
|
#define FX_MODE_SAW 16
|
|
#define FX_MODE_TWINKLE 17
|
|
#define FX_MODE_DISSOLVE 18
|
|
#define FX_MODE_DISSOLVE_RANDOM 19
|
|
#define FX_MODE_SPARKLE 20
|
|
#define FX_MODE_FLASH_SPARKLE 21
|
|
#define FX_MODE_HYPER_SPARKLE 22
|
|
#define FX_MODE_STROBE 23
|
|
#define FX_MODE_STROBE_RAINBOW 24
|
|
#define FX_MODE_MULTI_STROBE 25
|
|
#define FX_MODE_BLINK_RAINBOW 26
|
|
#define FX_MODE_ANDROID 27
|
|
#define FX_MODE_CHASE_COLOR 28
|
|
#define FX_MODE_CHASE_RANDOM 29
|
|
#define FX_MODE_CHASE_RAINBOW 30
|
|
#define FX_MODE_CHASE_FLASH 31
|
|
#define FX_MODE_CHASE_FLASH_RANDOM 32
|
|
#define FX_MODE_CHASE_RAINBOW_WHITE 33
|
|
#define FX_MODE_COLORFUL 34
|
|
#define FX_MODE_TRAFFIC_LIGHT 35
|
|
#define FX_MODE_COLOR_SWEEP_RANDOM 36
|
|
#define FX_MODE_RUNNING_COLOR 37
|
|
#define FX_MODE_AURORA 38
|
|
#define FX_MODE_RUNNING_RANDOM 39
|
|
#define FX_MODE_LARSON_SCANNER 40
|
|
#define FX_MODE_COMET 41
|
|
#define FX_MODE_FIREWORKS 42
|
|
#define FX_MODE_RAIN 43
|
|
#define FX_MODE_TETRIX 44 //was Merry Christmas prior to 0.12.0 (use "Chase 2" with Red/Green)
|
|
#define FX_MODE_FIRE_FLICKER 45
|
|
#define FX_MODE_GRADIENT 46
|
|
#define FX_MODE_LOADING 47
|
|
//#define FX_MODE_POLICE 48 // candidate for removal (after below three)
|
|
#define FX_MODE_WAVESINS 48 // was Police prior to 0.14 (use Two Dots with Red/Blue)
|
|
#define FX_MODE_FAIRY 49 //was Police All prior to 0.13.0-b6 (use "Two Dots" with Red/Blue and full intensity)
|
|
#define FX_MODE_TWO_DOTS 50
|
|
#define FX_MODE_FAIRYTWINKLE 51 //was Two Areas prior to 0.13.0-b6 (use "Two Dots" with full intensity)
|
|
#define FX_MODE_RUNNING_DUAL 52
|
|
//#define FX_MODE_HALLOWEEN 53 // candidate for removal
|
|
#define FX_MODE_PERLINMOVE 53 // was Halloween prior to 0.14 (use Cahse 2 with Purple/Orange)
|
|
#define FX_MODE_TRICOLOR_CHASE 54
|
|
#define FX_MODE_TRICOLOR_WIPE 55
|
|
#define FX_MODE_TRICOLOR_FADE 56
|
|
#define FX_MODE_LIGHTNING 57
|
|
#define FX_MODE_ICU 58
|
|
#define FX_MODE_MULTI_COMET 59
|
|
#define FX_MODE_DUAL_LARSON_SCANNER 60
|
|
#define FX_MODE_RANDOM_CHASE 61
|
|
#define FX_MODE_OSCILLATE 62
|
|
#define FX_MODE_PRIDE_2015 63
|
|
#define FX_MODE_JUGGLE 64
|
|
#define FX_MODE_PALETTE 65
|
|
#define FX_MODE_FIRE_2012 66
|
|
#define FX_MODE_COLORWAVES 67
|
|
#define FX_MODE_BPM 68
|
|
#define FX_MODE_FILLNOISE8 69
|
|
#define FX_MODE_NOISE16_1 70
|
|
#define FX_MODE_NOISE16_2 71
|
|
#define FX_MODE_NOISE16_3 72
|
|
#define FX_MODE_NOISE16_4 73
|
|
#define FX_MODE_COLORTWINKLE 74
|
|
#define FX_MODE_LAKE 75
|
|
#define FX_MODE_METEOR 76
|
|
#define FX_MODE_METEOR_SMOOTH 77
|
|
#define FX_MODE_RAILWAY 78
|
|
#define FX_MODE_RIPPLE 79
|
|
#define FX_MODE_TWINKLEFOX 80
|
|
#define FX_MODE_TWINKLECAT 81
|
|
#define FX_MODE_HALLOWEEN_EYES 82
|
|
#define FX_MODE_STATIC_PATTERN 83
|
|
#define FX_MODE_TRI_STATIC_PATTERN 84
|
|
#define FX_MODE_SPOTS 85
|
|
#define FX_MODE_SPOTS_FADE 86
|
|
#define FX_MODE_GLITTER 87
|
|
#define FX_MODE_CANDLE 88
|
|
#define FX_MODE_STARBURST 89
|
|
#define FX_MODE_EXPLODING_FIREWORKS 90
|
|
#define FX_MODE_BOUNCINGBALLS 91
|
|
#define FX_MODE_SINELON 92
|
|
#define FX_MODE_SINELON_DUAL 93
|
|
#define FX_MODE_SINELON_RAINBOW 94
|
|
#define FX_MODE_POPCORN 95
|
|
#define FX_MODE_DRIP 96
|
|
#define FX_MODE_PLASMA 97
|
|
#define FX_MODE_PERCENT 98
|
|
#define FX_MODE_RIPPLE_RAINBOW 99
|
|
#define FX_MODE_HEARTBEAT 100
|
|
#define FX_MODE_PACIFICA 101
|
|
#define FX_MODE_CANDLE_MULTI 102
|
|
#define FX_MODE_SOLID_GLITTER 103
|
|
#define FX_MODE_SUNRISE 104
|
|
#define FX_MODE_PHASED 105
|
|
#define FX_MODE_TWINKLEUP 106
|
|
#define FX_MODE_NOISEPAL 107
|
|
#define FX_MODE_SINEWAVE 108
|
|
#define FX_MODE_PHASEDNOISE 109
|
|
#define FX_MODE_FLOW 110
|
|
#define FX_MODE_CHUNCHUN 111
|
|
#define FX_MODE_DANCING_SHADOWS 112
|
|
#define FX_MODE_WASHING_MACHINE 113
|
|
//#define FX_MODE_CANDY_CANE 114 // candidate for removal
|
|
#define FX_MODE_FLOWSTRIPE 114 // was Cany Cane prior to 0.14 (use Cahse 2 with Red/White)
|
|
#define FX_MODE_BLENDS 115
|
|
#define FX_MODE_TV_SIMULATOR 116
|
|
#define FX_MODE_DYNAMIC_SMOOTH 117
|
|
// new 2D effects
|
|
#define FX_MODE_2DSPACESHIPS 118
|
|
#define FX_MODE_2DCRAZYBEES 119
|
|
#define FX_MODE_2DGHOSTRIDER 120
|
|
#define FX_MODE_2DBLOBS 121
|
|
#define FX_MODE_2DSCROLLTEXT 122
|
|
#define FX_MODE_2DDRIFTROSE 123
|
|
// WLED-SR effects (non SR compatible IDs)
|
|
#define FX_MODE_2DBLACKHOLE 124 // non audio
|
|
#define FX_MODE_2DDNASPIRAL 125 // non audio
|
|
#define FX_MODE_2DHIPHOTIC 126 // non audio
|
|
#define FX_MODE_2DPLASMABALL 127 // non audio
|
|
#define FX_MODE_2DSINDOTS 128 // non audio
|
|
#define FX_MODE_2DFRIZZLES 129 // non audio
|
|
#define FX_MODE_2DLISSAJOUS 130 // non audio
|
|
#define FX_MODE_2DPOLARLIGHTS 131 // non audio
|
|
#define FX_MODE_2DTARTAN 132 // non audio
|
|
#define FX_MODE_2DGAMEOFLIFE 133 // non audio
|
|
#define FX_MODE_2DJULIA 134 // non audio
|
|
#define FX_MODE_2DCOLOREDBURSTS 135 // non audio
|
|
#define FX_MODE_2DSUNRADIATION 136 // non audio
|
|
#define FX_MODE_2DNOISE 137 // non audio
|
|
#define FX_MODE_2DFIRENOISE 138 // non audio
|
|
#define FX_MODE_2DSQUAREDSWIRL 139 // non audio
|
|
#define FX_MODE_2DDNA 140 // non audio
|
|
#define FX_MODE_2DMATRIX 141 // non audio
|
|
#define FX_MODE_2DMETABALLS 142 // non audio
|
|
#define FX_MODE_2DPULSER 143 // non audio
|
|
#define FX_MODE_2DDRIFT 144 // non audio
|
|
#define FX_MODE_2DWAVERLY 145 // audio enhanced
|
|
#define FX_MODE_2DSWIRL 146 // audio enhanced
|
|
#define FX_MODE_2DAKEMI 147 // audio enhanced
|
|
#define FX_MODE_PIXELWAVE 160 // audio enhanced
|
|
#define FX_MODE_JUGGLES 161 // audio enhanced
|
|
#define FX_MODE_MATRIPIX 162 // audio enhanced
|
|
#define FX_MODE_GRAVIMETER 163 // audio enhanced
|
|
#define FX_MODE_PLASMOID 164 // audio enhanced
|
|
#define FX_MODE_PUDDLES 165 // audio enhanced
|
|
#define FX_MODE_MIDNOISE 166 // audio enhanced
|
|
#define FX_MODE_NOISEMETER 167 // audio enhanced
|
|
#define FX_MODE_NOISEFIRE 168 // audio enhanced
|
|
#define FX_MODE_PUDDLEPEAK 169 // audio enhanced
|
|
#define FX_MODE_RIPPLEPEAK 170 // audio enhanced
|
|
#define FX_MODE_GRAVCENTER 171 // audio enhanced
|
|
#define FX_MODE_GRAVCENTRIC 172 // audio enhanced
|
|
|
|
#ifndef USERMOD_AUDIOREACTIVE
|
|
|
|
#define MODE_COUNT 173
|
|
|
|
#else
|
|
|
|
#define FX_MODE_PIXELS 173
|
|
// #define FX_MODE_PIXELWAVE 129 // audio enhanced
|
|
// #define FX_MODE_JUGGLES 130 // audio enhanced
|
|
// #define FX_MODE_MATRIPIX 131 // audio enhanced
|
|
// #define FX_MODE_GRAVIMETER 132 // audio enhanced
|
|
// #define FX_MODE_PLASMOID 133 // audio enhanced
|
|
// #define FX_MODE_PUDDLES 134 // audio enhanced
|
|
// #define FX_MODE_MIDNOISE 135 // audio enhanced
|
|
// #define FX_MODE_NOISEMETER 136 // audio enhanced
|
|
#define FX_MODE_FREQWAVE 174
|
|
#define FX_MODE_FREQMATRIX 175
|
|
#define FX_MODE_2DGEQ 148
|
|
#define FX_MODE_WATERFALL 176
|
|
#define FX_MODE_FREQPIXELS 177
|
|
#define FX_MODE_BINMAP 178
|
|
// #define FX_MODE_NOISEFIRE 143 // audio enhanced
|
|
// #define FX_MODE_PUDDLEPEAK 144 // audio enhanced
|
|
#define FX_MODE_NOISEMOVE 179
|
|
// #define FX_MODE_2DNOISE 146 // non audio
|
|
//#define FX_MODE_PERLINMOVE 147 // moved to 53
|
|
// #define FX_MODE_RIPPLEPEAK 148 // audio enhanced
|
|
// #define FX_MODE_2DFIRENOISE 149 // non audio
|
|
// #define FX_MODE_2DSQUAREDSWIRL 150 // non audio
|
|
//#define FX_MODE_2DFIRE2012 151 // implemented in native Fire2012
|
|
// #define FX_MODE_2DDNA 152 // non audio
|
|
// #define FX_MODE_2DMATRIX 153 // non audio
|
|
// #define FX_MODE_2DMETABALLS 154 // non audio
|
|
#define FX_MODE_FREQMAP 180
|
|
// #define FX_MODE_GRAVCENTER 156 // audio enhanced
|
|
// #define FX_MODE_GRAVCENTRIC 157 // audio enhanced
|
|
#define FX_MODE_GRAVFREQ 181
|
|
#define FX_MODE_DJLIGHT 182
|
|
#define FX_MODE_2DFUNKYPLANK 149
|
|
//#define FX_MODE_2DCENTERBARS 161 // obsolete by X & Y mirroring
|
|
// #define FX_MODE_2DPULSER 162 // non audio
|
|
#define FX_MODE_BLURZ 183
|
|
// #define FX_MODE_2DDRIFT 164 // non audio
|
|
// #define FX_MODE_2DWAVERLY 165 // audio enhanced
|
|
// #define FX_MODE_2DSUNRADIATION 166 // non audio
|
|
// #define FX_MODE_2DCOLOREDBURSTS 167 // non audio
|
|
// #define FX_MODE_2DJULIA 168 // non audio
|
|
#define FX_MODE_2DPOOLNOISE 150 // reserved in JSON_mode_names
|
|
#define FX_MODE_2DTWISTER 151 // reserved in JSON_mode_names
|
|
#define FX_MODE_2DCAELEMENTATY 152 // reserved in JSON_mode_names
|
|
// #define FX_MODE_2DGAMEOFLIFE 172 // non audio
|
|
// #define FX_MODE_2DTARTAN 173 // non audio
|
|
// #define FX_MODE_2DPOLARLIGHTS 174 // non audio
|
|
// #define FX_MODE_2DSWIRL 175 // audio enhanced
|
|
// #define FX_MODE_2DLISSAJOUS 176 // non audio
|
|
// #define FX_MODE_2DFRIZZLES 177 // non audio
|
|
// #define FX_MODE_2DPLASMABALL 178 // non audio
|
|
//#define FX_MODE_FLOWSTRIPE 179 // moved to 114
|
|
// #define FX_MODE_2DHIPHOTIC 180 // non audio
|
|
// #define FX_MODE_2DSINDOTS 181 // non audio
|
|
// #define FX_MODE_2DDNASPIRAL 182 // non audio
|
|
// #define FX_MODE_2DBLACKHOLE 183 // non audio
|
|
//#define FX_MODE_WAVESINS 184 // moved to 48
|
|
#define FX_MODE_ROCKTAVES 184
|
|
// #define FX_MODE_2DAKEMI 186 // audio enhanced
|
|
//#define FX_MODE_CUSTOMEFFECT 187 //WLEDSR Custom Effects
|
|
|
|
#define MODE_COUNT 185
|
|
#endif
|
|
|
|
typedef enum mapping1D2D {
|
|
M12_Pixels = 0,
|
|
M12_VerticalBar = 1,
|
|
M12_Circle = 2,
|
|
M12_Block = 3
|
|
} mapping1D2D_t;
|
|
|
|
// segment, 68 (92 in memory) bytes
|
|
typedef struct Segment {
|
|
public:
|
|
uint16_t start; // start index / start X coordinate 2D (left)
|
|
uint16_t stop; // stop index / stop X coordinate 2D (right); segment is invalid if stop == 0
|
|
uint16_t offset;
|
|
uint8_t speed;
|
|
uint8_t intensity;
|
|
uint8_t palette;
|
|
uint8_t mode;
|
|
union {
|
|
uint16_t options; //bit pattern: msb first: [transposed mirrorY reverseY] transitional (tbd) paused needspixelstate mirrored on reverse selected
|
|
struct {
|
|
bool selected : 1; // 0 : selected
|
|
bool reverse : 1; // 1 : reversed
|
|
bool on : 1; // 2 : is On
|
|
bool mirror : 1; // 3 : mirrored
|
|
bool pxs : 1; // 4 : indicates that the effect does not use FRAMETIME or needs getPixelColor (?)
|
|
bool freeze : 1; // 5 : paused/frozen
|
|
bool reset : 1; // 6 : indicates that Segment runtime requires reset
|
|
bool transitional: 1; // 7 : transitional (there is transition occuring)
|
|
bool reverse_y : 1; // 8 : reversed Y (2D)
|
|
bool mirror_y : 1; // 9 : mirrored Y (2D)
|
|
bool transpose : 1; // 10 : transposed (2D, swapped X & Y)
|
|
uint8_t map1D2D : 2; // 11-12 : mapping for 1D effect on 2D (0-strip, 1-expand vertically, 2-circular, 3-rectangular)
|
|
uint8_t soundSim : 3; // 13-15 : 0-7 sound simulation types
|
|
};
|
|
};
|
|
uint8_t grouping, spacing;
|
|
uint8_t opacity;
|
|
uint32_t colors[NUM_COLORS];
|
|
uint8_t cct; //0==1900K, 255==10091K
|
|
uint8_t custom1, custom2, custom3; // custom FX parameters
|
|
uint16_t startY; // start Y coodrinate 2D (top)
|
|
uint16_t stopY; // stop Y coordinate 2D (bottom)
|
|
char *name;
|
|
|
|
// runtime data
|
|
unsigned long next_time; // millis() of next update
|
|
uint32_t step; // custom "step" var
|
|
uint32_t call; // call counter
|
|
uint16_t aux0; // custom var
|
|
uint16_t aux1; // custom var
|
|
byte* data;
|
|
|
|
private:
|
|
union {
|
|
uint8_t _capabilities;
|
|
struct {
|
|
bool _isRGB : 1;
|
|
bool _hasW : 1;
|
|
bool _isCCT : 1;
|
|
bool _manualW : 1;
|
|
uint8_t _reserved : 4;
|
|
};
|
|
};
|
|
uint16_t _dataLen;
|
|
static uint16_t _usedSegmentData;
|
|
|
|
// transition data, valid only if getOption(SEG_OPTION_TRANSITIONAL)==true, holds values during transition
|
|
struct Transition {
|
|
uint32_t _colorT[NUM_COLORS];
|
|
uint8_t _briT; // temporary brightness
|
|
uint8_t _cctT; // temporary CCT
|
|
CRGBPalette16 _palT; // temporary palette
|
|
//uint8_t _modeP; // previous mode/effect (transitioning effects is way more complex than this)
|
|
uint32_t _start;
|
|
uint16_t _dur;
|
|
Transition(uint16_t dur=750) : _briT(255), _cctT(127), _palT(CRGBPalette16(CRGB::Black)), /*_modeP(FX_MODE_STATIC),*/ _start(millis()), _dur(dur) {}
|
|
Transition(uint16_t d, uint8_t b, uint8_t c, const uint32_t *o) : _briT(b), _cctT(c), _palT(CRGBPalette16(CRGB::Black)), /*_modeP(FX_MODE_STATIC),*/ _start(millis()), _dur(d) {
|
|
for (size_t i=0; i<NUM_COLORS; i++) _colorT[i] = o[i];
|
|
}
|
|
} *_t; // this struct will bootloop ESP
|
|
|
|
public:
|
|
|
|
Segment(uint16_t sStart=0, uint16_t sStop=30) :
|
|
start(sStart),
|
|
stop(sStop),
|
|
offset(0),
|
|
speed(DEFAULT_SPEED),
|
|
intensity(DEFAULT_INTENSITY),
|
|
palette(0),
|
|
mode(DEFAULT_MODE),
|
|
options(SELECTED | SEGMENT_ON),
|
|
grouping(1),
|
|
spacing(0),
|
|
opacity(255),
|
|
colors{DEFAULT_COLOR,BLACK,BLACK},
|
|
cct(127),
|
|
custom1(DEFAULT_C1),
|
|
custom2(DEFAULT_C2),
|
|
custom3(DEFAULT_C3),
|
|
startY(0),
|
|
stopY(1),
|
|
name(nullptr),
|
|
next_time(0),
|
|
step(0),
|
|
call(0),
|
|
aux0(0),
|
|
aux1(0),
|
|
data(nullptr),
|
|
_capabilities(0),
|
|
_dataLen(0),
|
|
_t(nullptr)
|
|
{
|
|
refreshLightCapabilities();
|
|
}
|
|
|
|
Segment(uint16_t sStartX, uint16_t sStopX, uint16_t sStartY, uint16_t sStopY) : Segment(sStartX, sStopX) {
|
|
startY = sStartY;
|
|
stopY = sStopY;
|
|
}
|
|
|
|
Segment(const Segment &orig); // copy constructor
|
|
Segment(Segment &&orig) noexcept; // move constructor
|
|
|
|
~Segment() {
|
|
#ifdef WLED_DEBUG
|
|
Serial.print(F("Destroying segment."));
|
|
if (name) Serial.printf(" %s (%p)", name, name);
|
|
if (data) Serial.printf(" %p", data);
|
|
Serial.println();
|
|
#endif
|
|
if (name) delete[] name;
|
|
if (_t) delete _t;
|
|
deallocateData();
|
|
}
|
|
|
|
Segment& operator= (const Segment &orig); // copy assignment
|
|
Segment& operator= (Segment &&orig) noexcept; // move assignment
|
|
|
|
inline bool getOption(uint8_t n) { return ((options >> n) & 0x01); }
|
|
inline bool isSelected(void) { return getOption(0); }
|
|
inline bool isActive(void) { return stop > start; }
|
|
inline bool is2D(void) { return !(startY == 0 && stopY == 1); }
|
|
inline uint16_t width(void) { return stop - start; } // segment width in physical pixels (length if 1D)
|
|
inline uint16_t height(void) { return stopY - startY; } // segment height (if 2D) in physical pixels
|
|
inline uint16_t length(void) { return width() * height(); } // segment length (count) in physical pixels
|
|
inline uint16_t groupLength(void) { return grouping + spacing; }
|
|
inline uint8_t getLightCapabilities(void) { return _capabilities; }
|
|
|
|
static uint16_t getUsedSegmentData(void) { return _usedSegmentData; }
|
|
static void addUsedSegmentData(int len) { _usedSegmentData += len; }
|
|
|
|
bool setColor(uint8_t slot, uint32_t c); //returns true if changed
|
|
void setCCT(uint16_t k);
|
|
void setOpacity(uint8_t o);
|
|
void setOption(uint8_t n, bool val);
|
|
uint8_t differs(Segment& b);
|
|
void refreshLightCapabilities(void);
|
|
|
|
// runtime data functions
|
|
inline uint16_t dataSize(void) { return _dataLen; }
|
|
bool allocateData(size_t len);
|
|
void deallocateData(void);
|
|
void resetIfRequired(void);
|
|
/**
|
|
* Flags that before the next effect is calculated,
|
|
* the internal segment state should be reset.
|
|
* Call resetIfRequired before calling the next effect function.
|
|
* Safe to call from interrupts and network requests.
|
|
*/
|
|
inline void markForReset(void) { reset = true; } // setOption(SEG_OPTION_RESET, true)
|
|
|
|
// transition functions
|
|
void startTransition(uint16_t dur); // transition has to start before actual segment values change
|
|
void handleTransition(void);
|
|
uint16_t progress(void); //transition progression between 0-65535
|
|
uint8_t currentBri(uint8_t briNew, bool useCct = false);
|
|
uint32_t currentColor(uint8_t slot, uint32_t colorNew);
|
|
CRGBPalette16 &loadPalette(CRGBPalette16 &tgt, uint8_t pal);
|
|
CRGBPalette16 ¤tPalette(CRGBPalette16 &tgt, uint8_t paletteID);
|
|
|
|
// 1D strip
|
|
uint16_t virtualLength(void);
|
|
void setPixelColor(int n, uint32_t c); // set relative pixel within segment with color
|
|
void setPixelColor(int n, byte r, byte g, byte b, byte w = 0) { setPixelColor(n, RGBW32(r,g,b,w)); } // automatically inline
|
|
void setPixelColor(int n, CRGB c) { setPixelColor(n, c.red, c.green, c.blue); } // automatically inline
|
|
void setPixelColor(float i, uint32_t c, bool aa = true);
|
|
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); }
|
|
void setPixelColor(float i, CRGB c, bool aa = true) { setPixelColor(i, c.red, c.green, c.blue, 0, aa); }
|
|
uint32_t getPixelColor(uint16_t i);
|
|
// 1D support functions (some implement 2D as well)
|
|
void blur(uint8_t);
|
|
void fill(uint32_t c);
|
|
void fade_out(uint8_t r);
|
|
void fadeToBlackBy(uint8_t fadeBy);
|
|
void blendPixelColor(uint16_t n, uint32_t color, uint8_t blend);
|
|
void addPixelColor(uint16_t n, uint32_t color);
|
|
uint8_t get_random_wheel_index(uint8_t pos);
|
|
uint32_t color_from_palette(uint16_t, bool mapping, bool wrap, uint8_t mcol, uint8_t pbri = 255);
|
|
uint32_t color_wheel(uint8_t pos);
|
|
|
|
// 2D matrix
|
|
uint16_t virtualWidth(void);
|
|
uint16_t virtualHeight(void);
|
|
uint16_t XY(uint16_t x, uint16_t y); // support function to get relative index within segment (for leds[])
|
|
void setPixelColorXY(int x, int y, uint32_t c); // set relative pixel within segment with color
|
|
void setPixelColorXY(int x, int y, byte r, byte g, byte b, byte w = 0) { setPixelColorXY(x, y, RGBW32(r,g,b,w)); } // automatically inline
|
|
void setPixelColorXY(int x, int y, CRGB c) { setPixelColorXY(x, y, c.red, c.green, c.blue); } // automatically inline
|
|
void setPixelColorXY(float x, float y, uint32_t c, bool aa = true);
|
|
void setPixelColorXY(float x, float y, byte r, byte g, byte b, byte w = 0, bool aa = true) { setPixelColorXY(x, y, RGBW32(r,g,b,w), aa); }
|
|
void setPixelColorXY(float x, float y, CRGB c, bool aa = true) { setPixelColorXY(x, y, c.red, c.green, c.blue, 0, aa); }
|
|
uint32_t getPixelColorXY(uint16_t x, uint16_t y);
|
|
// 2D support functions
|
|
void blendPixelColorXY(uint16_t x, uint16_t y, uint32_t color, uint8_t blend);
|
|
void addPixelColorXY(uint16_t x, uint16_t y, uint32_t color);
|
|
void addPixelColorXY(uint16_t x, uint16_t y, byte r, byte g, byte b, byte w = 0) { addPixelColorXY(x, y, RGBW32(r,g,b,w)); } // automatically inline
|
|
void addPixelColorXY(uint16_t x, uint16_t y, CRGB c) { addPixelColorXY(x, y, c.red, c.green, c.blue); } // automatically inline
|
|
void blur1d(CRGB* leds, fract8 blur_amount);
|
|
void blur1d(uint16_t i, bool vertical, fract8 blur_amount, CRGB* leds=nullptr); // 1D box blur (with weight)
|
|
void blur2d(CRGB* leds, fract8 blur_amount);
|
|
void blurRow(uint16_t row, fract8 blur_amount, CRGB* leds=nullptr);
|
|
void blurCol(uint16_t col, fract8 blur_amount, CRGB* leds=nullptr);
|
|
void moveX(CRGB *leds, int8_t delta);
|
|
void moveY(CRGB *leds, int8_t delta);
|
|
void move(uint8_t dir, uint8_t delta, CRGB *leds=nullptr);
|
|
void fill_solid(CRGB* leds, CRGB c);
|
|
void fill_circle(CRGB* leds, uint16_t cx, uint16_t cy, uint8_t radius, CRGB c);
|
|
void fadeToBlackBy(CRGB* leds, uint8_t fadeBy);
|
|
void nscale8(CRGB* leds, uint8_t scale);
|
|
void drawLine(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, CRGB c, CRGB *leds = nullptr);
|
|
void drawCharacter(unsigned char chr, int16_t x, int16_t y, uint8_t w, uint8_t h, CRGB color, CRGB *leds = nullptr);
|
|
void wu_pixel(CRGB *leds, uint32_t x, uint32_t y, CRGB c);
|
|
inline void drawLine(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, uint32_t c) { drawLine(x0, y0, x1, y1, CRGB(byte(c>>16), byte(c>>8), byte(c))); }
|
|
inline void drawCharacter(unsigned char chr, int16_t x, int16_t y, uint8_t w, uint8_t h, uint32_t c) { drawCharacter(chr, x, y, w, h, CRGB(byte(c>>16), byte(c>>8), byte(c))); }
|
|
} segment;
|
|
//static int i = sizeof(Segment);
|
|
|
|
// main "strip" class
|
|
class WS2812FX { // 96 bytes
|
|
typedef uint16_t (*mode_ptr)(void); // pointer to mode function
|
|
typedef void (*show_callback)(void); // pre show callback
|
|
typedef struct ModeData {
|
|
uint8_t _id; // mode (effect) id
|
|
mode_ptr _fcn; // mode (effect) function
|
|
const char *_data; // mode (effect) name and its UI control data
|
|
ModeData(uint8_t id, uint16_t (*fcn)(void), const char *data) : _id(id), _fcn(fcn), _data(data) {}
|
|
} mode_data_t;
|
|
|
|
static WS2812FX* instance;
|
|
|
|
public:
|
|
|
|
// FastLED array, so we can refer to leds[i] instead of getPixel() and setPixel()
|
|
CRGB *leds = nullptr ; //See FX_fcn.cpp for init (wip).
|
|
|
|
WS2812FX() :
|
|
gammaCorrectBri(false),
|
|
gammaCorrectCol(true),
|
|
paletteFade(0),
|
|
paletteBlend(0),
|
|
milliampsPerLed(55),
|
|
cctBlending(0),
|
|
ablMilliampsMax(ABL_MILLIAMPS_DEFAULT),
|
|
currentMilliamps(0),
|
|
now(millis()),
|
|
timebase(0),
|
|
isMatrix(false),
|
|
#ifndef WLED_DISABLE_2D
|
|
hPanels(1),
|
|
vPanels(1),
|
|
panelH(8),
|
|
panelW(8),
|
|
matrixWidth(DEFAULT_LED_COUNT),
|
|
matrixHeight(1),
|
|
matrix{0,0,0,0},
|
|
panel{{0,0,0,0}},
|
|
#endif
|
|
// semi-private (just obscured) used in effect functions through macros
|
|
_currentPalette(CRGBPalette16(CRGB::Black)),
|
|
_colors_t{0,0,0},
|
|
_virtualSegmentLength(0),
|
|
// true private variables
|
|
_length(DEFAULT_LED_COUNT),
|
|
_brightness(DEFAULT_BRIGHTNESS),
|
|
_transitionDur(750),
|
|
_targetFps(WLED_FPS),
|
|
_frametime(FRAMETIME_FIXED),
|
|
_cumulativeFps(2),
|
|
_isServicing(false),
|
|
_isOffRefreshRequired(false),
|
|
_hasWhiteChannel(false),
|
|
_triggered(false),
|
|
_modeCount(MODE_COUNT),
|
|
_callback(nullptr),
|
|
customMappingTable(nullptr),
|
|
customMappingSize(0),
|
|
_lastShow(0),
|
|
_segment_index(0),
|
|
_mainSegment(0)
|
|
{
|
|
WS2812FX::instance = this;
|
|
_mode.reserve(_modeCount); // allocate memory to prevent initial fragmentation
|
|
_modeData.reserve(_modeCount); // allocate memory to prevent initial fragmentation
|
|
if (_mode.capacity() <= 1 || _modeData.capacity() <= 1) _modeCount = 1;
|
|
else setupEffectData();
|
|
}
|
|
|
|
~WS2812FX() {
|
|
if (customMappingTable) delete[] customMappingTable;
|
|
_mode.clear();
|
|
_modeData.clear();
|
|
_segments.clear();
|
|
customPalettes.clear();
|
|
}
|
|
|
|
static WS2812FX* getInstance(void) { return instance; }
|
|
|
|
void
|
|
finalizeInit(),
|
|
service(void),
|
|
setMode(uint8_t segid, uint8_t m),
|
|
setColor(uint8_t slot, uint8_t r, uint8_t g, uint8_t b, uint8_t w = 0),
|
|
setColor(uint8_t slot, uint32_t c),
|
|
setCCT(uint16_t k),
|
|
setBrightness(uint8_t b, bool direct = false),
|
|
setRange(uint16_t i, uint16_t i2, uint32_t col),
|
|
setTransitionMode(bool t),
|
|
purgeSegments(void),
|
|
setSegment(uint8_t n, uint16_t start, uint16_t stop, uint8_t grouping = 1, uint8_t spacing = 0, uint16_t offset = UINT16_MAX, uint16_t startY=0, uint16_t stopY=1),
|
|
setMainSegmentId(uint8_t n),
|
|
restartRuntime(),
|
|
resetSegments(),
|
|
makeAutoSegments(bool forceReset = false),
|
|
fixInvalidSegments(),
|
|
setPixelColor(int n, uint32_t c),
|
|
show(void),
|
|
setTargetFps(uint8_t fps),
|
|
deserializeMap(uint8_t n=0);
|
|
|
|
void fill(uint32_t c) { for (int i = 0; i < _length; i++) setPixelColor(i, c); } // fill whole strip with color (inline)
|
|
void addEffect(uint8_t id, mode_ptr mode_fn, const char *mode_name); // add effect to the list; defined in FX.cpp
|
|
void setupEffectData(void); // add default effects to the list; defined in FX.cpp
|
|
|
|
// outsmart the compiler :) by correctly overloading
|
|
inline void setPixelColor(int n, uint8_t r, uint8_t g, uint8_t b, uint8_t w = 0) { setPixelColor(n, RGBW32(r,g,b,w)); }
|
|
inline void setPixelColor(int n, CRGB c) { setPixelColor(n, c.red, c.green, c.blue); }
|
|
inline void trigger(void) { _triggered = true; } // Forces the next frame to be computed on all active segments.
|
|
inline void setShowCallback(show_callback cb) { _callback = cb; }
|
|
inline void setTransition(uint16_t t) { _transitionDur = t; }
|
|
inline void appendSegment(const Segment &seg = Segment()) { _segments.push_back(seg); }
|
|
|
|
bool
|
|
gammaCorrectBri,
|
|
gammaCorrectCol,
|
|
checkSegmentAlignment(void),
|
|
hasRGBWBus(void),
|
|
hasCCTBus(void),
|
|
// return true if the strip is being sent pixel updates
|
|
isUpdating(void),
|
|
useLedsArray = true;
|
|
|
|
inline bool isServicing(void) { return _isServicing; }
|
|
inline bool hasWhiteChannel(void) {return _hasWhiteChannel;}
|
|
inline bool isOffRefreshRequired(void) {return _isOffRefreshRequired;}
|
|
|
|
uint8_t
|
|
paletteFade,
|
|
paletteBlend,
|
|
milliampsPerLed,
|
|
cctBlending,
|
|
getActiveSegmentsNum(void),
|
|
getFirstSelectedSegId(void),
|
|
getLastActiveSegmentId(void),
|
|
setPixelSegment(uint8_t n);
|
|
|
|
inline uint8_t getBrightness(void) { return _brightness; }
|
|
inline uint8_t getMaxSegments(void) { return MAX_NUM_SEGMENTS; } // returns maximum number of supported segments (fixed value)
|
|
inline uint8_t getSegmentsNum(void) { return _segments.size(); } // returns currently present segments
|
|
inline uint8_t getCurrSegmentId(void) { return _segment_index; }
|
|
inline uint8_t getMainSegmentId(void) { return _mainSegment; }
|
|
inline uint8_t getPaletteCount() { return 13 + GRADIENT_PALETTE_COUNT; }
|
|
inline uint8_t getTargetFps() { return _targetFps; }
|
|
inline uint8_t getModeCount() { return _modeCount; }
|
|
|
|
uint16_t
|
|
ablMilliampsMax,
|
|
currentMilliamps,
|
|
getLengthPhysical(void),
|
|
getFps();
|
|
|
|
inline uint16_t getFrameTime(void) { return _frametime; }
|
|
inline uint16_t getMinShowDelay(void) { return MIN_SHOW_DELAY; }
|
|
inline uint16_t getLengthTotal(void) { return _length; }
|
|
inline uint16_t getTransition(void) { return _transitionDur; }
|
|
|
|
uint32_t
|
|
now,
|
|
timebase,
|
|
currentColor(uint32_t colorNew, uint8_t tNr),
|
|
getPixelColor(uint16_t);
|
|
|
|
inline uint32_t getLastShow(void) { return _lastShow; }
|
|
inline uint32_t segColor(uint8_t i) { return _colors_t[i]; }
|
|
|
|
const char *
|
|
getModeData(uint8_t id = 0) { return (id && id<_modeCount) ? _modeData[id] : PSTR("Solid"); }
|
|
|
|
const char **
|
|
getModeDataSrc(void) { return &(_modeData[0]); } // vectors use arrays for underlying data
|
|
|
|
Segment& getSegment(uint8_t id);
|
|
inline Segment& getFirstSelectedSeg(void) { return _segments[getFirstSelectedSegId()]; }
|
|
inline Segment& getMainSegment(void) { return _segments[getMainSegmentId()]; }
|
|
inline Segment* getSegments(void) { return &(_segments[0]); }
|
|
|
|
// 2D support (panels)
|
|
bool
|
|
isMatrix;
|
|
|
|
#ifndef WLED_DISABLE_2D
|
|
#define WLED_MAX_PANELS 64
|
|
uint8_t
|
|
hPanels,
|
|
vPanels;
|
|
|
|
uint16_t
|
|
panelH,
|
|
panelW,
|
|
matrixWidth,
|
|
matrixHeight;
|
|
|
|
typedef struct panel_bitfield_t {
|
|
unsigned char
|
|
bottomStart : 1, // starts at bottom?
|
|
rightStart : 1, // starts on right?
|
|
vertical : 1, // is vertical?
|
|
serpentine : 1; // is serpentine?
|
|
} Panel;
|
|
Panel
|
|
matrix,
|
|
panel[WLED_MAX_PANELS];
|
|
#endif
|
|
|
|
void
|
|
setUpMatrix(),
|
|
setPixelColorXY(int x, int y, uint32_t c);
|
|
|
|
// outsmart the compiler :) by correctly overloading
|
|
// inline void setPixelColorXY(int x, int y, byte r, byte g, byte b, byte w = 0) { setPixelColorXY(x, y, RGBW32(r,g,b,w)); } // automatically inline
|
|
// inline void setPixelColorXY(int x, int y, CRGB c) { setPixelColorXY(x, y, c.red, c.green, c.blue); }
|
|
|
|
uint32_t
|
|
getPixelColorXY(uint16_t, uint16_t);
|
|
|
|
// end 2D support
|
|
|
|
void loadCustomPalettes(void); // loads custom palettes from JSON
|
|
CRGBPalette16 _currentPalette; // palette used for current effect (includes transition)
|
|
std::vector<CRGBPalette16> customPalettes; // TODO: move custom palettes out of WS2812FX class
|
|
|
|
// using public variables to reduce code size increase due to inline function getSegment() (with bounds checking)
|
|
// and color transitions
|
|
uint32_t _colors_t[3]; // color used for effect (includes transition)
|
|
uint16_t _virtualSegmentLength;
|
|
|
|
std::vector<segment> _segments;
|
|
friend class Segment;
|
|
|
|
private:
|
|
uint16_t _length;
|
|
uint8_t _brightness;
|
|
uint16_t _transitionDur;
|
|
|
|
uint8_t _targetFps;
|
|
uint16_t _frametime;
|
|
uint16_t _cumulativeFps;
|
|
|
|
// will require only 1 byte
|
|
struct {
|
|
bool _isServicing : 1;
|
|
bool _isOffRefreshRequired : 1; //periodic refresh is required for the strip to remain off.
|
|
bool _hasWhiteChannel : 1;
|
|
bool _triggered : 1;
|
|
};
|
|
|
|
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
|
|
|
|
show_callback _callback;
|
|
|
|
uint16_t* customMappingTable;
|
|
uint16_t customMappingSize;
|
|
|
|
uint32_t _lastShow;
|
|
|
|
uint8_t _segment_index;
|
|
uint8_t _mainSegment;
|
|
|
|
void
|
|
estimateCurrentAndLimitBri(void);
|
|
};
|
|
|
|
extern const char JSON_mode_names[];
|
|
extern const char JSON_palette_names[];
|
|
|
|
#endif
|