channel.h

Go to the documentation of this file.

 
#pragma once
 
#include "fl/stl/noexcept.h"
 
#include "cpixel_ledcontroller.h"
#include "fl/channels/bus.h"
#include "fl/channels/ichannel.h"
#include "fl/channels/options.h"
#include "fl/stl/shared_ptr.h"
#include "fl/stl/string.h"
#include "fl/stl/weak_ptr.h"
#include "fl/stl/stdint.h"
#include "fl/channels/config.h"
#include "fl/stl/compiler_control.h"
 
namespace fl {
 
// Forward declarations
class IChannelDriver;
class ChannelData;
struct ChannelOptions;  // IWYU pragma: keep
class Channel;
class XMap;
FASTLED_SHARED_PTR(Channel);
FASTLED_SHARED_PTR(ChannelData);

class Channel: public CPixelLEDController<RGB>, public IChannel {
public:
    static ChannelPtr create(const ChannelConfig& config);

    virtual ~Channel() FL_NOEXCEPT;

    i32 id() const override { return mId; }

    const fl::string& name() const override { return mName; }

    int getPin() const;

    int getClockPin() const;

    Channel& setGamma(float gamma);

    fl::optional<float> getGamma() const;

    const ChipsetTimingConfig& getTiming() const;

    const ChipsetVariant& getChipset() const { return mChipset; }

    EOrder getRgbOrder() const { return mRgbOrder; }

    bool isClockless() const { return mChipset.is<ClocklessChipset>(); }

    bool isSpi() const { return mChipset.is<SpiChipsetConfig>(); }

    void applyConfig(const ChannelConfig& config);
 
    // Re-expose protected base class methods for external access
    void addToDrawList();

    void removeFromDrawList();

    int size() const override;

    void showLeds(u8 brightness = 255) OVERRIDE_IF_NOT_AVR;

    bool isInDrawList() const;

    CLEDController* asController() { return static_cast<CLEDController*>(this); }
    const CLEDController* asController() const { return static_cast<const CLEDController*>(this); }

    fl::span<CRGB> leds();

    fl::span<const CRGB> leds() const;

    CRGB getCorrection();

    CRGB getTemperature();

    u8 getDither();

    Rgbw getRgbw() const;

    fl::string getEngineName() const;

    Channel& setScreenMap(const fl::XYMap& map, float diameter = -1.f);

    Channel& setScreenMap(const fl::ScreenMap& map);

    Channel& setScreenMap(fl::u16 width, fl::u16 height, float diameter = -1.f);

    Channel& setScreenMap(const fl::XMap& map);

    const fl::ScreenMap& getScreenMap() const;

    bool hasScreenMap() const;
 
private:
    template<typename T, typename... Args>
    friend fl::shared_ptr<T> fl::make_shared(Args&&... args) FL_NOEXCEPT;
 
protected:
    // CPixelLEDController interface implementation - protected so subclass delegates
    // (e.g., UCS7604's DelegateController) can call through the base class chain.
    void showPixels(PixelController<RGB, 1, 0xFFFFFFFF>& pixels) override;
    void init() override;
    Channel(const ChipsetVariant& chipset, EOrder rgbOrder, RegistrationMode mode);
 
private:
    FL_NO_INLINE fl::shared_ptr<IChannelDriver> resolveDynamicDriver();
protected:

    void setDriver(fl::shared_ptr<IChannelDriver> driver) FL_NOEXCEPT {
        mDriver = driver;
        mDriverPreBound = true;
    }
 
private:
    Channel(const ChipsetVariant& chipset, fl::span<CRGB> leds,
            EOrder rgbOrder, const ChannelOptions& options);

    Channel(int pin, const ChipsetTimingConfig& timing, fl::span<CRGB> leds,
            EOrder rgbOrder, const ChannelOptions& options);
 
    // Non-copyable, non-movable
    Channel(const Channel&) FL_NOEXCEPT = delete;
    Channel& operator=(const Channel&) FL_NOEXCEPT = delete;
    Channel(Channel&&) FL_NOEXCEPT = delete;
    Channel& operator=(Channel&&) FL_NOEXCEPT = delete;
 
    static i32 nextId();
    static fl::string makeName(i32 id, const fl::optional<fl::string>& configName = fl::optional<fl::string>());
 
    ChipsetVariant mChipset;         // Chipset configuration (clockless or SPI)
    EOrder mRgbOrder;
    fl::weak_ptr<IChannelDriver> mDriver;  // Weak reference to driver (prevents dangling pointers)
    bool mDriverPreBound = false;    // True if setDriver() was called (legacy addLeds<> path).
                                     // When true, showPixels() uses mDriver directly and skips
                                     // ChannelManager::selectDriverForChannel(). When false (the
                                     // default), every showPixels() re-evaluates the manager's
                                     // priority list so users can swap drivers at runtime.
    Bus mBus = Bus::AUTO;            // Typed driver selection (#2459). `Bus::AUTO` falls through
                                     // to `ChannelManager` priority dispatch; any other value
                                     // pins this channel to `busName(mBus)`.
    bool mBusWarned = false;         // One-shot guard for the #2455 FL_ERROR. Flipped on the
                                     // first showPixels() that observes a `mBus` miss (the
                                     // named driver wasn't registered with ChannelManager).
                                     // Subsequent shows on the same channel skip the warn even
                                     // though the priority-dispatch fallback re-runs every frame.
    bool mDisabledDriverWarned = false;  // One-shot guard for the #2517 FL_ERROR. Flipped on the
                                         // first showPixels() that would have enqueued data to a
                                         // driver disabled by `setExclusiveDriver(...)` (or
                                         // `setDriverEnabled(name, false)`). Cleared whenever the
                                         // resolved driver returns to ENABLED so a subsequent
                                         // disable re-emits the diagnostic.
    const i32 mId;
    fl::string mName;               // User-specified or auto-generated name
    ChannelOptions mSettings;           // Per-channel settings (gamma, rgbw, etc.)
    ChannelDataPtr mChannelData;
    fl::ScreenMap mScreenMap;        // Screen map for JS canvas visualization
};

IChannelDriver* getStubChannelEngine();
 
}  // namespace fl