controller.h

/*
    Copyright (c) 2019-2023 Brett g Porter
 
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
*/
 
#pragma once
 
#include <juce_gui_basics/juce_gui_basics.h>
#include <juce_gui_extra/juce_gui_extra.h>
 
#if JUCE_VERSION >= (7 << 16)
#define FRIZ_VBLANK_ENABLED 1
#else
#define FRIZ_VBLANK_ENABLED 0
#endif
namespace friz
{
class Animator;
class FrameRateCalculator
{
public:
    FrameRateCalculator () = default;
 
    void update (juce::int64 timeInMs);
 
    float get () const;
 
    void clear ();
 
private:
    juce::int64 lastUpdate { -1 };
    static constexpr int frameCount { 24 };
    std::array<int, frameCount> memory;
    std::atomic<int> sum { 0 };
    std::atomic<int> updateCount { 0 };
    int index { 0 };
};
 
class Controller
{
public:
    Controller ()                             = default;
    virtual ~Controller ()                    = default;
    Controller (const Controller&)            = delete;
    Controller& operator= (const Controller&) = delete;
    Controller (Controller&&)                 = delete;
    Controller& operator= (Controller&&)      = delete;
 
    void setAnimator (Animator* animator_) { animator = animator_; }
 
    virtual bool setFrameRate (int /*frameRate*/) { return false; }
 
    virtual float getFrameRate () const { return 0.f; }
 
    virtual void start () = 0;
 
    virtual void stop () = 0;
 
    virtual bool isRunning () const = 0;
 
    static juce::int64 getCurrentTime ();
 
protected:
    Animator* animator;
};
 
class TimeController : public Controller,
                       public juce::Timer
{
public:
    bool setFrameRate (int frameRate_) override
    {
        jassert (frameRate_ > 0);
        frameRate = frameRate_;
        return true;
    }
 
    float getFrameRate () const override { return isRunning () ? frameRate : 0.f; }
 
    void start () override
    {
        jassert (animator != nullptr);
        startTimerHz (frameRate);
    }
 
    void stop () override { stopTimer (); }
 
    bool isRunning () const override { return isTimerRunning (); }
 
private:
    void timerCallback () override;
 
private:
    int frameRate { 30 };
};
 
#if FRIZ_VBLANK_ENABLED
class DisplaySyncController : public Controller
{
public:
    DisplaySyncController (juce::Component* syncSource_)
    : syncSource { syncSource_ }
    {
    }
 
    virtual float getFrameRate () const override
    {
        return isRunning () ? frameRate.get () : 0.f;
    }
 
    virtual void start () override;
 
    virtual void stop () override
    {
        running = false;
        sync    = {};
    }
 
    virtual bool isRunning () const override
    {
        // if/when JUCE makes this isEmpty() call const-qualified,
        // we can remove the separate boolean to track whether we're
        // running or not.
        // return !sync.isEmpty ();
        return running;
    }
 
private:
    juce::Component* syncSource;
 
    juce::VBlankAttachment sync;
 
    FrameRateCalculator frameRate;
    bool running { false };
};
#endif
class AsyncController : public Controller
{
public:
    AsyncController () = default;
 
    virtual float getFrameRate () const override { return frameRate.get (); }
 
    void start () override { running = true; }
 
    void stop () override { running = false; }
 
    bool isRunning () const override { return running; }
 
    bool gotoTime (juce::int64 timeInMs);
 
private:
    FrameRateCalculator frameRate;
    bool running { false };
    juce::int64 lastTime { 0 };
};
 
} // namespace friz