channel_events.h

Go to the documentation of this file.

#pragma once
 
#include "fl/stl/function.h"
#include "fl/stl/noexcept.h"
#include "fl/stl/string.h"  // IWYU pragma: keep
#include "fl/stl/stdint.h"
 
namespace fl {
 
class IChannel;
class IChannelDriver;  // IWYU pragma: keep
class ChannelData;
struct ChannelConfig;
enum class ColorProfileStatus : u8;
enum class ColorProfileWarning : u8 { ProfileClearedByLegacy, LegacyClearedByProfile };
struct ColorProfileEvent {
    i32 channelId;
    ColorProfileStatus status;
    ColorProfileWarning warning;
};

#if defined(FASTLED_DISABLE_CHANNEL_EVENTS) && FASTLED_DISABLE_CHANNEL_EVENTS
 
namespace detail {
struct NoOpChannelEvent {
    template <typename... Args>
    void operator()(Args&&...) const FL_NO_EXCEPT {}
 
    template <typename F>
    int add(F&& /*f*/, int /*priority*/ = 0) const FL_NO_EXCEPT { return -1; }
 
    void remove(int /*id*/) const FL_NO_EXCEPT {}
};
}  // namespace detail
 
struct ChannelEvents {
    static ChannelEvents& instance() FL_NO_EXCEPT {
        static ChannelEvents s;
        return s;
    }
 
    detail::NoOpChannelEvent onChannelCreated;
    detail::NoOpChannelEvent onChannelBeginDestroy;
    detail::NoOpChannelEvent onChannelAdded;
    detail::NoOpChannelEvent onChannelRemoved;
    detail::NoOpChannelEvent onChannelConfigured;
    detail::NoOpChannelEvent onColorProfileFallback;
    detail::NoOpChannelEvent onColorProfileWarning;
    detail::NoOpChannelEvent onChannelDataEncoded;
    detail::NoOpChannelEvent onChannelEnqueued;
};
 
#else
 
struct ChannelEvents {
    static ChannelEvents& instance() FL_NO_EXCEPT;
 
    // -- Lifecycle events --

    fl::function_list<void(const IChannel&)> onChannelCreated;

    fl::function_list<void(const IChannel&)> onChannelBeginDestroy;
 
    // -- FastLED list events --

    fl::function_list<void(const IChannel&)> onChannelAdded;

    fl::function_list<void(const IChannel&)> onChannelRemoved;
 
    // -- Configuration events --

    fl::function_list<void(const IChannel&, const ChannelConfig&)> onChannelConfigured;
    fl::function_list<void(const ColorProfileEvent&)> onColorProfileFallback;
    fl::function_list<void(const ColorProfileEvent&)> onColorProfileWarning;
 
    // -- Rendering events --

    fl::function_list<void(const IChannel&, const ChannelData&)> onChannelDataEncoded;

    fl::function_list<void(const IChannel&, const fl::string& driverName)> onChannelEnqueued;
};
 
#endif  // FASTLED_DISABLE_CHANNEL_EVENTS
 
}  // namespace fl