animation.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 "../animatorApp.h"
#include <array>
 
#include "../curves/animatedValue.h"
 
namespace friz
{
 
class AnimationType
{
public:
    enum class Status
    {
        processing, 
        finished    
    };
 
    AnimationType (int id)
    : animationId { id }
    , preDelay { 0 }
    {
        // only allow positive animation IDs.
        jassert (id >= 0);
    }
 
    virtual ~AnimationType () = default;
 
    int getId () const { return animationId; }
 
    void setDelay (int delay) { preDelay = std::max (0, delay); }
 
    virtual bool setValue (size_t /*index*/, std::unique_ptr<AnimatedValue> /*value*/)
    {
        jassertfalse;
        return false;
    }
 
    virtual Status gotoTime (juce::int64 timeInMs) = 0;
 
    virtual void cancel (bool moveToEndPosition) = 0;
 
    virtual bool isFinished () = 0;
 
    virtual bool isReady () const = 0;
 
    virtual AnimatedValue* getValue (size_t index) = 0;
    using CompletionFn = std::function<void (int, bool)>;
    void onCompletion (CompletionFn complete) { completionFn = complete; }
 
public:
    CompletionFn completionFn;
 
protected:
    int animationId { 0 };
 
    int preDelay { 0 };
};
 
template <std::size_t ValueCount> class UpdateSource
{
public:
    UpdateSource () = default;
    using ValueList = std::array<float, ValueCount>;
    using UpdateFn  = std::function<void (int, const ValueList&)>;
    void onUpdate (UpdateFn update) { updateFn = update; }
 
    UpdateFn updateFn;
};
 
template <std::size_t ValueCount>
class Animation : public AnimationType,
                  public UpdateSource<ValueCount>
{
public:
    using SourceList = std::array<std::unique_ptr<AnimatedValue>, ValueCount>;
    using ValueList  = typename UpdateSource<ValueCount>::ValueList;
 
    Animation (int id = 0)
    : AnimationType { id }
    {
    }
 
    Animation (SourceList&& sources, int id = 0)
    : AnimationType { id }
    , sources { std::move (sources) }
    {
    }
 
    bool setValue (size_t index, std::unique_ptr<AnimatedValue> value) override
    {
        if (index >= ValueCount)
        {
            jassertfalse;
            return false;
        }
 
        sources[index] = std::move (value);
        return true;
    }
 
    AnimatedValue* getValue (size_t index) override
    {
        if (index < ValueCount)
            return sources[index].get ();
 
        jassertfalse;
        return nullptr;
    }
 
    Status gotoTime (juce::int64 timeInMs) override
    {
        if (finished)
        {
            if (completionFn != nullptr)
                completionFn (getId (), false);
            return Status::finished;
        }
 
        juce::int64 deltaTime;
        // if this is the first time we're being executed, perform some setup:
        if (startTime < 0)
        {
            startTime = lastTime = timeInMs;
            deltaTime            = 0;
        }
        else
        {
            deltaTime = timeInMs - lastTime;
            lastTime  = timeInMs;
        }
 
        const auto totalElapsed { timeInMs - startTime };
 
        // if we're still delaying, just return.
        if (totalElapsed < preDelay)
            return Status::processing;
 
        // recalculate the elapsed and delta times to account for an
        // expired delay
        const auto effectElapsed { totalElapsed - preDelay };
        deltaTime = std::min (deltaTime, totalElapsed);
 
        // loop through our value generators and update:
        ValueList values;
        int completeCount { 0 };
 
        for (int i = 0; i < ValueCount; ++i)
        {
            auto& val = sources[i];
            if (val != nullptr)
            {
                // values[i] = val->GetNextValue ();
                values[i] = val->getNextValue (static_cast<int> (effectElapsed),
                                               static_cast<int> (deltaTime));
                completeCount += (val->isFinished ()) ? 1 : 0;
            }
            else
                jassertfalse;
        }
 
        if (this->updateFn != nullptr)
            this->updateFn (getId (), values);
 
        if (completeCount == ValueCount)
            finished = true;
 
        return Status::processing;
    }
 
    void cancel (bool moveToEndPosition) override
    {
        for (auto& val : sources)
        {
            if (val != nullptr)
                val->cancel (moveToEndPosition);
        }
 
        if (moveToEndPosition && this->updateFn != nullptr)
        {
            // send one more update where all of the individual values
            // have snapped to their end states.
            ValueList values;
            for (int i = 0; i < ValueCount; ++i)
            {
                auto& val = sources[i];
                jassert (val != nullptr);
                if (val != nullptr)
                    values[i] = val->getEndValue ();
            }
            this->updateFn (getId (), values);
        }
 
        // notify that the effect is complete.
        if (completionFn != nullptr)
            completionFn (getId (), true);
        finished = true;
    }
 
    bool isFinished () override { return finished; }
 
    bool isReady () const override
    {
        for (auto& src : sources)
        {
            if (nullptr == src.get ())
                return false;
        }
        return true;
    }
 
public:
private:
    juce::int64 startTime { -1 };
    juce::int64 lastTime { -1 };
 
    bool finished { false };
 
    SourceList sources;
};
 
template <class T, int ValueCount, class... Args>
std::unique_ptr<Animation<ValueCount>> makeAnimation (
    int id, std::array<float, ValueCount>&& from, std::array<float, ValueCount>&& to,
    Args... args)
{
    // make sure we're trying to create an animation object.
    static_assert (std::is_base_of<AnimatedValue, T>::value);
 
    auto animation { std::make_unique<Animation<ValueCount>> (id) };
 
    for (int i { 0 }; i < ValueCount; ++i)
    {
        auto curve { std::make_unique<T> (from[i], to[i], std::forward<Args> (args)...) };
        animation->setValue (i, std::move (curve));
    }
 
    return animation;
}
 
template <class T, class... Args>
std::unique_ptr<Animation<1>> makeAnimation (int id, float from, float to, Args... args)
{
    return makeAnimation<T, 1> (id, { from }, { to }, std::forward<Args> (args)...);
}
 
} // namespace friz