cled_controller.h

Go to the documentation of this file.

#pragma once

 
#include "color.h"
 
#include "fl/stl/compiler_control.h"
#include "dither_mode.h"
#include "fl/system/engine_events.h"
#include "fl/math/screenmap.h"
#include "fl/stl/int.h"
#include "fl/stl/bit_cast.h"
#include "fl/channels/options.h"
#include "fl/stl/span.h"
#include "fl/stl/noexcept.h"

//
// LED Controller interface definition
//

 
namespace fl {
 
class CLEDController {
protected:
    friend class CFastLED;
    fl::span<CRGB> mLeds;     
    CLEDController *mPNext = nullptr;   
    ChannelOptions mSettings;  
    bool mEnabled = true;
    static CLEDController *mPHead;  
    static CLEDController *mPTail;  

    enum class RegistrationMode {
        AutoRegister,   
        DeferRegister   
    };

    CLEDController(RegistrationMode mode) FL_NOEXCEPT;
 
public:
    void addToList() FL_NOEXCEPT;

    bool isInList() const FL_NOEXCEPT;

    virtual void showColor(const CRGB & data, int nLeds, fl::u8 brightness) FL_NOEXCEPT = 0;

    virtual void show(const CRGB *data, int nLeds, fl::u8 brightness) FL_NOEXCEPT = 0;
 
    CLEDController& setRgbw(const Rgbw& arg = RgbwDefault::value()) FL_NOEXCEPT {
        // Note that at this time (Sept 13th, 2024) this is only implemented in the ESP32 driver
        // directly. For an emulated version please see RGBWEmulatedController in chipsets.h
        //
        // (#2558) mSettings.mWhiteCfg is now a fl::variant<Empty, Rgbw, Rgbww>;
        // assigning Rgbw selects the 4-channel alternative. The legacy
        // "setRgbw(RgbwInvalid::value()) → disable" semantics are preserved
        // by translating an inactive Rgbw into Empty so observers see the
        // same "no white channel" state they did before the variant migration.
        if (!arg.active()) {
            mSettings.mWhiteCfg.reset();
        } else {
            mSettings.mWhiteCfg = arg;
        }
        return *this;  // builder pattern.
    }

    CLEDController& setRgbww(const Rgbww& arg = RgbwwDefault::value()) FL_NOEXCEPT {
        if (!arg.active()) {
            mSettings.mWhiteCfg.reset();
        } else {
            mSettings.mWhiteCfg = arg;
        }
        return *this;
    }

    CLEDController& clearWhiteChannel() FL_NOEXCEPT {
        mSettings.mWhiteCfg.reset();
        return *this;
    }
 
    void setEnabled(bool enabled) FL_NOEXCEPT { mEnabled = enabled; }
    bool getEnabled() FL_NOEXCEPT { return mEnabled; }
 
    CLEDController() FL_NOEXCEPT;
    // If we added virtual to the AVR boards then we are going to add 600 bytes of memory to the binary
    // flash size. This is because the virtual destructor pulls in malloc and free, which are the largest
    // Testing shows that this virtual destructor adds a 600 bytes to the binary on
    // attiny85 and about 1k for the teensy 4.X series.
    // Attiny85:
    //   With CLEDController destructor virtual: 11018 bytes to binary.
    //   Without CLEDController destructor virtual: 10666 bytes to binary.
    VIRTUAL_IF_NOT_AVR ~CLEDController() FL_NOEXCEPT;

    Rgbw getRgbw() const FL_NOEXCEPT { return mSettings.rgbw(); }

    Rgbww getRgbww() const FL_NOEXCEPT { return mSettings.rgbww(); }

    virtual void init() FL_NOEXCEPT = 0;

    VIRTUAL_IF_NOT_AVR void clearLeds(int nLeds = -1) FL_NOEXCEPT {
        clearLedDataInternal(nLeds);
        showLeds(0);
    }
 
    // Compatibility with the 3.8.x codebase.
    VIRTUAL_IF_NOT_AVR void showLeds(fl::u8 brightness) FL_NOEXCEPT {
#if FASTLED_HAS_ENGINE_EVENTS
        fl::EngineEvents::onBeginFrame();
#endif
        void* data = beginShowLeds(mLeds.size());
        showLedsInternal(brightness);
        endShowLeds(data);
#if FASTLED_HAS_ENGINE_EVENTS
        fl::EngineEvents::onEndFrame();
        fl::EngineEvents::onEndShowLeds();
#endif
    }
 
    ColorAdjustment getAdjustmentData(fl::u8 brightness) FL_NOEXCEPT;

    void showInternal(const CRGB *data, int nLeds, fl::u8 brightness) FL_NOEXCEPT {
        if (mEnabled) {
           show(data, nLeds,brightness);
        }
    }

    void showColorInternal(const CRGB &data, int nLeds, fl::u8 brightness) FL_NOEXCEPT {
        if (mEnabled) {
            showColor(data, nLeds, brightness);
        }
    }

    void showLedsInternal(fl::u8 brightness) FL_NOEXCEPT {
        if (mEnabled) {
            show(mLeds.data(), mLeds.size(), brightness);
        }
    }

    void showColorInternal(const CRGB & data, fl::u8 brightness) FL_NOEXCEPT {
        if (mEnabled) {
            showColor(data, mLeds.size(), brightness);
        }
    }

    static CLEDController *head() FL_NOEXCEPT { return mPHead; }

    CLEDController *next() FL_NOEXCEPT { return mPNext; }

    template<typename Visitor>
    static void visitControllers(Visitor&& visitor) FL_NOEXCEPT {
        const CLEDController *pCur = head();
        while(pCur) {
            visitor(pCur, fl::span<const CRGB>(pCur->leds(), pCur->size()));
            pCur = pCur->next();
        }
    }

    const CLEDController *next() const FL_NOEXCEPT { return mPNext; }

    CLEDController & setLeds(CRGB *data, int nLeds) FL_NOEXCEPT {
        mLeds = fl::span<CRGB>(data, nLeds);
        return *this;
    }

    CLEDController & setLeds(fl::span<CRGB> leds) FL_NOEXCEPT {
        mLeds = leds;
        return *this;
    }

    void clearLedDataInternal(int nLeds = -1) FL_NOEXCEPT;

    void removeFromDrawList() FL_NOEXCEPT {
        removeFromList(this);
    }

    static void removeFromList(CLEDController* controller) FL_NOEXCEPT;

    virtual int size() const FL_NOEXCEPT { return mLeds.size(); }

    virtual int lanes() FL_NOEXCEPT { return 1; }

    CRGB* leds() FL_NOEXCEPT { return mLeds.data(); }

    const CRGB* leds() const FL_NOEXCEPT { return mLeds.data(); }

    fl::span<CRGB> ledsSpan() FL_NOEXCEPT { return mLeds; }

    CRGB &operator[](int x) FL_NOEXCEPT { return mLeds[x]; }

    inline CLEDController & setDither(fl::u8 ditherMode = BINARY_DITHER) FL_NOEXCEPT { mSettings.mDitherMode = ditherMode; return *this; }
 
    CLEDController& setScreenMap(const fl::XYMap& map, float diameter = -1.f) FL_NOEXCEPT {
        // EngineEvents::onCanvasUiSet(this, map);
        fl::ScreenMap screenmap = map.toScreenMap();
        if (diameter <= 0.0f) {
            screenmap.setDiameter(.15f); // Assume small matrix is being used.
        }
        fl::EngineEvents::onCanvasUiSet(this, screenmap);
        return *this;
    }
 
    CLEDController& setScreenMap(const fl::ScreenMap& map) FL_NOEXCEPT {
        fl::EngineEvents::onCanvasUiSet(this, map);
        return *this;
    }
 
    CLEDController& setScreenMap(fl::u16 width, fl::u16 height, float diameter = -1.f) FL_NOEXCEPT {
        fl::XYMap xymap = fl::XYMap::constructRectangularGrid(width, height);
        return setScreenMap(xymap, diameter);
    }

    inline fl::u8 getDither() FL_NOEXCEPT { return mSettings.mDitherMode; }
 
    virtual void* beginShowLeds(int size) FL_NOEXCEPT {
        FASTLED_UNUSED(size);
        // By default, emit an integer. This integer will, by default, be passed back.
        // If you override beginShowLeds() then
        // you should also override endShowLeds() to match the return state.
        //
        // For async led controllers this should be used as a sync point to block
        // the caller until the leds from the last draw frame have completed drawing.
        // for each controller:
        //   beginShowLeds();
        // for each controller:
        //   showLeds();
        // for each controller:
        //   endShowLeds();
        uintptr_t d = getDither();
        void* out = fl::int_to_ptr<void>(d);
        return out;
    }
 
    virtual void endShowLeds(void* data) FL_NOEXCEPT {
        // By default recieves the integer that beginShowLeds() emitted.
        //For async controllers this should be used to signal the controller
        // to begin transmitting the current frame to the leds.
        uintptr_t d = fl::ptr_to_int(data);
        setDither(static_cast<fl::u8>(d));
    }

    CLEDController & setCorrection(CRGB correction) FL_NOEXCEPT { mSettings.mCorrection = correction; return *this; }

    CLEDController & setCorrection(LEDColorCorrection correction) FL_NOEXCEPT { mSettings.mCorrection = correction; return *this; }

    CRGB getCorrection() FL_NOEXCEPT { return mSettings.mCorrection; }

    CLEDController & setTemperature(CRGB temperature) FL_NOEXCEPT { mSettings.mTemperature = temperature; return *this; }

    CLEDController & setTemperature(ColorTemperature temperature) FL_NOEXCEPT { mSettings.mTemperature = temperature; return *this; }

    CRGB getTemperature() FL_NOEXCEPT { return mSettings.mTemperature; }

    CRGB getAdjustment(fl::u8 scale) FL_NOEXCEPT {
        return CRGB::computeAdjustment(scale, mSettings.mCorrection, mSettings.mTemperature);
    }

    virtual fl::u16 getMaxRefreshRate() const FL_NOEXCEPT { return 0; }
};
 
}  // namespace fl