pixelset.h

Go to the documentation of this file.

#pragma once
 
 
#include "fl/stl/compiler_control.h"
#include "fl/gfx/colorutils.h"
#include "fl/math/math.h"
 
#include "fl/gfx/fill.h"
#include "fl/gfx/blur.h"
 
#include "fl/system/fastled.h"
#include "fl/stl/span.h"
#include "fl/stl/noexcept.h"
 
#define FUNCTION_FILL_RAINBOW(a,b,c,d) fl::fill_rainbow(a,b,c,d)
#define FUNCTION_NAPPLY_GAMMA(a,b,c) fl::napplyGamma_video(a,b,c)
#define FUNCTION_NAPPLY_GAMMA_RGB(a,b,c,d,e) fl::napplyGamma_video(a,b,c,d,e)
#define FUNCTION_BLUR1D(a,b,c) fl::blur1d(a,b,c)
#define FUNCTION_FILL_GRADIENT(a,b,c,d,e) fl::fill_gradient(a,b,c,d,e)
#define FUNCTION_FILL_GRADIENT3(a,b,c,d,e,f) fl::fill_gradient(a,b,c,d,e,f)
#define FUNCTION_FILL_GRADIENT4(a,b,c,d,e,f,g) fl::fill_gradient(a,b,c,d,e,f,g)
#define FUNCTION_NBLEND(a,b,c) fl::nblend(a,b,c)
#define FUNCTION_FILL_GRADIENT_RGB(a,b,c,d) fl::fill_gradient_RGB(a,b,c,d)
#define FUNCTION_FILL_GRADIENT_RGB3(a,b,c,d,e) fl::fill_gradient_RGB(a,b,c,d,e)
#define FUNCTION_FILL_GRADIENT_RGB4(a,b,c,d,e,f) fl::fill_gradient_RGB(a,b,c,d,e,f)
 
 
template<class PIXEL_TYPE>
class CPixelView;

typedef CPixelView<CRGB> CRGBSet;

FASTLED_FORCE_INLINE
CRGB *operator+(const CRGBSet & pixels, int offset) FL_NO_EXCEPT;
 

 


template<class PIXEL_TYPE>
class CPixelView {
public:
    const fl::i8 dir;             
    const int len;                
    PIXEL_TYPE * const leds;      
    PIXEL_TYPE * const end_pos;   
 
public:
    inline CPixelView(const CPixelView & other) FL_NO_EXCEPT : dir(other.dir), len(other.len), leds(other.leds), end_pos(other.end_pos) {}

    inline CPixelView(PIXEL_TYPE *_leds, int _len) FL_NO_EXCEPT : dir(_len < 0 ? -1 : 1), len(_len), leds(_leds), end_pos(_leds + _len) {}

    inline CPixelView(PIXEL_TYPE *_leds, int _start, int _end) FL_NO_EXCEPT : dir(((_end-_start)<0) ? -1 : 1), len((_end - _start) + dir), leds(_leds + _start), end_pos(_leds + _start + len) {}

    int size() const FL_NO_EXCEPT { return fl::abs(len); }

    bool reversed() FL_NO_EXCEPT { return len < 0; }

    bool operator==(const CPixelView & rhs) const FL_NO_EXCEPT { return leds == rhs.leds && len == rhs.len && dir == rhs.dir; }

    bool operator!=(const CPixelView & rhs) const FL_NO_EXCEPT { return leds != rhs.leds || len != rhs.len || dir != rhs.dir; }

    inline PIXEL_TYPE & operator[](int x) const FL_NO_EXCEPT { if(dir & 0x80) { return leds[-x]; } else { return leds[x]; } }

    inline CPixelView operator()(int start, int end) FL_NO_EXCEPT { if(dir & 0x80) { return CPixelView(leds+len+1, -len-start-1, -len-end-1); } else { return CPixelView(leds, start, end); } }
 
    // Access an inclusive subset of the LEDs in this set, starting from the first.
    // @param end the last element for the new subset
    // @todo Not sure i want this? inline CPixelView operator()(int end) { return CPixelView(leds, 0, end); }

    inline CPixelView operator-() FL_NO_EXCEPT { return CPixelView(leds, len - dir, 0); }

    inline operator PIXEL_TYPE* () const FL_NO_EXCEPT { return leds; }

    inline CPixelView & operator=(const PIXEL_TYPE & color) FL_NO_EXCEPT {
        for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel) = color; }
        return *this;
    }

    void dump() const FL_NO_EXCEPT {
    }

    inline CPixelView & operator=(const CPixelView & rhs) FL_NO_EXCEPT {
        for(iterator pixel = begin(), rhspixel = rhs.begin(), _end = end(), rhs_end = rhs.end(); (pixel != _end) && (rhspixel != rhs_end); ++pixel, ++rhspixel) {
            (*pixel) = (*rhspixel);
        }
        return *this;
    }


    inline CPixelView & addToRGB(fl::u8 inc) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel) += inc; } return *this; }
    inline CPixelView & operator+=(CPixelView & rhs) FL_NO_EXCEPT { for(iterator pixel = begin(), rhspixel = rhs.begin(), _end = end(), rhs_end = rhs.end(); (pixel != _end) && (rhspixel != rhs_end); ++pixel, ++rhspixel) { (*pixel) += (*rhspixel); } return *this; }

    inline CPixelView & subFromRGB(fl::u8 inc) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel) -= inc; } return *this; }
    inline CPixelView & operator-=(CPixelView & rhs) FL_NO_EXCEPT { for(iterator pixel = begin(), rhspixel = rhs.begin(), _end = end(), rhs_end = rhs.end(); (pixel != _end) && (rhspixel != rhs_end); ++pixel, ++rhspixel) { (*pixel) -= (*rhspixel); } return *this; }

    inline CPixelView & operator++() FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel)++; } return *this; }
    inline CPixelView & operator++(int DUMMY_ARG) FL_NO_EXCEPT {
        FASTLED_UNUSED(DUMMY_ARG);
        for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) {
            (*pixel)++;
        }
        return *this;
    }

    inline CPixelView & operator--() FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel)--; } return *this; }
    inline CPixelView & operator--(int DUMMY_ARG) FL_NO_EXCEPT {
        FASTLED_UNUSED(DUMMY_ARG);
        for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) {
            (*pixel)--;
        }
        return *this;
    }

    inline CPixelView & operator/=(fl::u8 d) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel) /= d; } return *this; }
    inline CPixelView & operator>>=(fl::u8 d) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel) >>= d; } return *this; }
    inline CPixelView & operator*=(fl::u8 d) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel) *= d; } return *this; }

    inline CPixelView & nscale8_video(fl::u8 scaledown) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel).nscale8_video(scaledown); } return *this;}
    inline CPixelView & operator%=(fl::u8 scaledown) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel).nscale8_video(scaledown); } return *this; }
    inline CPixelView & fadeLightBy(fl::u8 fadefactor) FL_NO_EXCEPT { return nscale8_video(255 - fadefactor); }

    inline CPixelView & nscale8(fl::u8 scaledown) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel).nscale8(scaledown); } return *this; }
    inline CPixelView & nscale8(PIXEL_TYPE & scaledown) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel).nscale8(scaledown); } return *this; }
    inline CPixelView & nscale8(CPixelView & rhs) FL_NO_EXCEPT { for(iterator pixel = begin(), rhspixel = rhs.begin(), _end = end(), rhs_end = rhs.end(); (pixel != _end) && (rhspixel != rhs_end); ++pixel, ++rhspixel) { (*pixel).nscale8((*rhspixel)); } return *this; }

    inline CPixelView & fadeToBlackBy(fl::u8 fade) FL_NO_EXCEPT { return nscale8(255 - fade); }

    inline CPixelView & operator|=(const PIXEL_TYPE & rhs) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel) |= rhs; } return *this; }
    inline CPixelView & operator|=(const CPixelView & rhs) FL_NO_EXCEPT { for(iterator pixel = begin(), rhspixel = rhs.begin(), _end = end(), rhs_end = rhs.end(); (pixel != _end) && (rhspixel != rhs_end); ++pixel, ++rhspixel) { (*pixel) |= (*rhspixel); } return *this; }
    inline CPixelView & operator|=(fl::u8 d) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel) |= d; } return *this; }

    inline CPixelView & operator&=(const PIXEL_TYPE & rhs) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel) &= rhs; } return *this; }
    inline CPixelView & operator&=(const CPixelView & rhs) FL_NO_EXCEPT { for(iterator pixel = begin(), rhspixel = rhs.begin(), _end = end(), rhs_end = rhs.end(); (pixel != _end) && (rhspixel != rhs_end); ++pixel, ++rhspixel) { (*pixel) &= (*rhspixel); } return *this; }
    inline CPixelView & operator&=(fl::u8 d) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { (*pixel) &= d; } return *this; }

 

    inline operator bool() FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { if((*pixel)) return true; } return false; }
 


    inline CPixelView & fill_solid(const PIXEL_TYPE & color) FL_NO_EXCEPT { *this = color; return *this; }
    inline CPixelView & fill_solid(const CHSV & color) FL_NO_EXCEPT { *this = color; return *this; }

    inline CPixelView & fill_rainbow(fl::u8 initialhue, fl::u8 deltahue=5) FL_NO_EXCEPT {
        if(dir >= 0) {
            FUNCTION_FILL_RAINBOW(leds,len,initialhue,deltahue);
        } else {
            FUNCTION_FILL_RAINBOW(leds + len + 1, -len, initialhue - deltahue * (len+1), -deltahue);
        }
        return *this;
    }

    inline CPixelView & fill_gradient(const CHSV & startcolor, const CHSV & endcolor, TGradientDirectionCode directionCode  = fl::SHORTEST_HUES) FL_NO_EXCEPT {
        if(dir >= 0) {
            FUNCTION_FILL_GRADIENT(leds,len,startcolor, endcolor, directionCode);
        } else {
            FUNCTION_FILL_GRADIENT(leds + len + 1, (-len), endcolor, startcolor, directionCode);
        }
        return *this;
    }

    inline CPixelView & fill_gradient(const CHSV & c1, const CHSV & c2, const CHSV &  c3, TGradientDirectionCode directionCode = fl::SHORTEST_HUES) FL_NO_EXCEPT {
        if(dir >= 0) {
            FUNCTION_FILL_GRADIENT3(leds, len, c1, c2, c3, directionCode);
        } else {
            FUNCTION_FILL_GRADIENT3(leds + len + 1, -len, c3, c2, c1, directionCode);
        }
        return *this;
    }

    inline CPixelView & fill_gradient(const CHSV & c1, const CHSV & c2, const CHSV & c3, const CHSV & c4, TGradientDirectionCode directionCode = fl::SHORTEST_HUES) FL_NO_EXCEPT {
        if(dir >= 0) {
            FUNCTION_FILL_GRADIENT4(leds, len, c1, c2, c3, c4, directionCode);
        } else {
            FUNCTION_FILL_GRADIENT4(leds + len + 1, -len, c4, c3, c2, c1, directionCode);
        }
        return *this;
    }

    inline CPixelView & fill_gradient_RGB(const PIXEL_TYPE & startcolor, const PIXEL_TYPE & endcolor, TGradientDirectionCode directionCode  = fl::SHORTEST_HUES) FL_NO_EXCEPT {
        FASTLED_UNUSED(directionCode); // TODO: why is this not used?
        if(dir >= 0) {
            FUNCTION_FILL_GRADIENT_RGB(leds,len,startcolor, endcolor);
        } else {
            FUNCTION_FILL_GRADIENT_RGB(leds + len + 1, (-len), endcolor, startcolor);
        }
        return *this;
    }

    inline CPixelView & fill_gradient_RGB(const PIXEL_TYPE & c1, const PIXEL_TYPE & c2, const PIXEL_TYPE &  c3) FL_NO_EXCEPT {
        if(dir >= 0) {
            FUNCTION_FILL_GRADIENT_RGB3(leds, len, c1, c2, c3);
        } else {
            FUNCTION_FILL_GRADIENT_RGB3(leds + len + 1, -len, c3, c2, c1);
        }
        return *this;
    }

    inline CPixelView & fill_gradient_RGB(const PIXEL_TYPE & c1, const PIXEL_TYPE & c2, const PIXEL_TYPE & c3, const PIXEL_TYPE & c4) FL_NO_EXCEPT {
        if(dir >= 0) {
            FUNCTION_FILL_GRADIENT_RGB4(leds, len, c1, c2, c3, c4);
        } else {
            FUNCTION_FILL_GRADIENT_RGB4(leds + len + 1, -len, c4, c3, c2, c1);
        }
        return *this;
    }

    inline CPixelView & nblend(const PIXEL_TYPE & overlay, fract8 amountOfOverlay) FL_NO_EXCEPT { for(iterator pixel = begin(), _end = end(); pixel != _end; ++pixel) { FUNCTION_NBLEND((*pixel), overlay, amountOfOverlay); } return *this; }

    inline CPixelView & nblend(const CPixelView & rhs, fract8 amountOfOverlay) FL_NO_EXCEPT { for(iterator pixel = begin(), rhspixel = rhs.begin(), _end = end(), rhs_end = rhs.end(); (pixel != _end) && (rhspixel != rhs_end); ++pixel, ++rhspixel) { FUNCTION_NBLEND((*pixel), (*rhspixel), amountOfOverlay); } return *this; }

    inline CPixelView & blur1d(fract8 blur_amount) FL_NO_EXCEPT {
        if(dir >= 0) {
            FUNCTION_BLUR1D(leds, len, blur_amount);
        } else {
            FUNCTION_BLUR1D(leds + len + 1, -len, blur_amount);
        }
        return *this;
    }

    inline CPixelView & napplyGamma_video(float gamma) FL_NO_EXCEPT {
        if(dir >= 0) {
            FUNCTION_NAPPLY_GAMMA(leds, len, gamma);
        } else {
            FUNCTION_NAPPLY_GAMMA(leds + len + 1, -len, gamma);
        }
        return *this;
    }

    inline CPixelView & napplyGamma_video(float gammaR, float gammaG, float gammaB) FL_NO_EXCEPT {
        if(dir >= 0) {
            FUNCTION_NAPPLY_GAMMA_RGB(leds, len, gammaR, gammaG, gammaB);
        } else {
            FUNCTION_NAPPLY_GAMMA_RGB(leds + len + 1, -len, gammaR, gammaG, gammaB);
        }
        return *this;
    }

 


    template <class T>
    class pixelset_iterator_base {
        T * leds;          
        const fl::i8 dir;  
 
    public:
        FASTLED_FORCE_INLINE pixelset_iterator_base(const pixelset_iterator_base & rhs) FL_NO_EXCEPT : leds(rhs.leds), dir(rhs.dir) {}

        FASTLED_FORCE_INLINE pixelset_iterator_base(T * _leds, const char _dir) FL_NO_EXCEPT : leds(_leds), dir(_dir) {}
 
        FASTLED_FORCE_INLINE pixelset_iterator_base& operator++() FL_NO_EXCEPT { leds += dir; return *this; }  
        FASTLED_FORCE_INLINE pixelset_iterator_base operator++(int) FL_NO_EXCEPT { pixelset_iterator_base tmp(*this); leds += dir; return tmp; }  
 
        // `const &`, not `&`: taking a mutable lvalue reference meant these
        // could not bind a temporary, so the idiomatic
        // `for (it = s.begin(); it != s.end(); ++it)` failed to compile
        // against the rvalue returned by end(). Every loop in this file works
        // around that by hoisting `end()` into a named variable first. #822.
        FASTLED_FORCE_INLINE bool operator==(const pixelset_iterator_base & other) const FL_NO_EXCEPT { return leds == other.leds; /* && set==other.set; */ }    
        FASTLED_FORCE_INLINE bool operator!=(const pixelset_iterator_base & other) const FL_NO_EXCEPT { return leds != other.leds; /* || set != other.set; */ }  
 
        FASTLED_FORCE_INLINE PIXEL_TYPE& operator*() const FL_NO_EXCEPT { return *leds; }  
    };
 
    typedef pixelset_iterator_base<PIXEL_TYPE> iterator;              
    typedef pixelset_iterator_base<const PIXEL_TYPE> const_iterator;  
 
    iterator begin() FL_NO_EXCEPT { return iterator(leds, dir); }   
    iterator end() FL_NO_EXCEPT { return iterator(end_pos, dir); }  
 
    iterator begin() const FL_NO_EXCEPT { return iterator(leds, dir); }   
    iterator end() const FL_NO_EXCEPT { return iterator(end_pos, dir); }  
 
    const_iterator cbegin() const FL_NO_EXCEPT { return const_iterator(leds, dir); }   
    const_iterator cend() const FL_NO_EXCEPT { return const_iterator(end_pos, dir); }  

};
 
FASTLED_FORCE_INLINE
CRGB *operator+(const CRGBSet & pixels, int offset) FL_NO_EXCEPT {
    return (CRGB*)pixels + offset;
}
 

template<int SIZE>
class CRGBArray : public CPixelView<CRGB> {
    CRGB rawleds[SIZE] = {0};  
 
public:
    CRGBArray() FL_NO_EXCEPT : CPixelView<CRGB>(rawleds, SIZE) {}
    using CPixelView::operator=;
    CRGB* get() FL_NO_EXCEPT { return &rawleds[0]; }
    const CRGB* get() const FL_NO_EXCEPT {  return &rawleds[0]; }
    size_t size() const FL_NO_EXCEPT { return SIZE; }
    operator fl::span<CRGB>() FL_NO_EXCEPT { return fl::span<CRGB>(rawleds, SIZE); }
    operator fl::span<const CRGB>() const FL_NO_EXCEPT { return fl::span<const CRGB>(rawleds, SIZE); }
};

 
 
 
#undef FUNCTION_FILL_RAINBOW
#undef FUNCTION_NAPPLY_GAMMA
#undef FUNCTION_NAPPLY_GAMMA_RGB
#undef FUNCTION_BLUR1D
#undef FUNCTION_FILL_GRADIENT
#undef FUNCTION_FILL_GRADIENT3
#undef FUNCTION_FILL_GRADIENT4
#undef FUNCTION_NBLEND
#undef FUNCTION_FILL_GRADIENT_RGB
#undef FUNCTION_FILL_GRADIENT_RGB3
#undef FUNCTION_FILL_GRADIENT_RGB4