fx_engine.h

Go to the documentation of this file.

#pragma once
 
#include "fl/stl/flat_map.h"
#include "fl/stl/shared_ptr.h"         // For FASTLED_SHARED_PTR macros
#include "fl/stl/vector.h"
#include "fl/audio/audio_frame.h"  // AudioFrame (stored in vectors)
#include "fl/fx/detail/fx_compositor.h"
#include "fl/fx/fx.h"
#include "fl/fx/time.h"
#include "fl/fx/video.h"
#include "fl/stl/stdint.h"
#include "fl/stl/noexcept.h"
 
namespace fl { namespace audio { class Processor; } }
 
// TimeFunction is defined in fx/time.h (fl::TimeFunction)
 
#ifndef FASTLED_FX_ENGINE_MAX_FX
#define FASTLED_FX_ENGINE_MAX_FX 64
#endif
 
namespace fl {

class FxEngine {
  public:
    typedef fl::flat_map<int, FxPtr> IntFxMap;
    FxEngine(u16 numLeds, bool interpolate = true) FL_NO_EXCEPT;

    ~FxEngine() FL_NO_EXCEPT;

    int addFx(FxPtr effect) FL_NO_EXCEPT;

    int addFx(Fx &effect) FL_NO_EXCEPT { return addFx(fl::make_shared_no_tracking(effect)); }

    FxPtr removeFx(int index) FL_NO_EXCEPT;

    FxPtr getFx(int index) FL_NO_EXCEPT;
 
    int getCurrentFxId() const FL_NO_EXCEPT { return mCurrId; }

    bool draw(fl::u32 now, fl::span<CRGB> outputBuffer) FL_NO_EXCEPT;

    bool nextFx(u16 transition_ms = 500) FL_NO_EXCEPT;

    bool setNextFx(int index, u16 duration) FL_NO_EXCEPT;
 
    IntFxMap &_getEffects() FL_NO_EXCEPT { return mEffects; }

    void pushAudioFrame(const AudioFrame &frame) FL_NO_EXCEPT;

    void setAudio(fl::shared_ptr<fl::audio::Processor> proc) FL_NO_EXCEPT;

    void setSpeed(float scale) FL_NO_EXCEPT { mTimeFunction.setSpeed(scale); }
    float getSpeed() const FL_NO_EXCEPT { return mTimeFunction.scale(); }
 
  private:
    int mCounter = 0;
    TimeWarp mTimeFunction;   // FxEngine controls the clock, to allow
                              // "time-bending" effects.
    IntFxMap mEffects;        
    FxCompositor mCompositor; 
    int mCurrId;              
    u16 mDuration = 0;   
    bool mDurationSet =
        false; 
    bool mInterpolate = true;
 
    // Double-buffered audio frame accumulator.
    // mAudioBack: frames pushed between draw() calls (write buffer).
    // mAudioFront: frozen snapshot passed to effects during draw() (read buffer).
    fl::vector<AudioFrame> mAudioFront;
    fl::vector<AudioFrame> mAudioBack;
 
    // Optional auto-polled audio source (set via setAudio()).
    fl::shared_ptr<fl::audio::Processor> mAudioProcessor;
};
 
} // namespace fl