marvin_SmoothedValue.h

Go to the documentation of this file.

// ========================================================================================================
//  _______ _______ ______ ___ ___ _______ _______
// |   |   |   _   |   __ \   |   |_     _|    |  |
// |       |       |      <   |   |_|   |_|       |
// |__|_|__|___|___|___|__|\_____/|_______|__|____|
//
// This file is part of the Marvin open source library and is licensed under the terms of the MIT License.
//
// ========================================================================================================
 
#ifndef MARVIN_LINEARSMOOTHEDVALUE_H
#define MARVIN_LINEARSMOOTHEDVALUE_H
#include "marvin/library/marvin_Concepts.h"
namespace marvin::utils {
    enum class SmoothingType {
        Linear,
        Exponential
    };

    template <FloatType SampleType, SmoothingType Type>
    class SmoothedValue {
    public:
        void reset(int stepsSamples, bool skipRemaining = true);
        void reset(double sampleRate, double timeMs, bool skipRemaining = true);
        void setCurrentAndTargetValue(SampleType newValue);

        void setTargetValue(SampleType newValue);
        [[nodiscard]] SampleType operator()() noexcept;
        [[nodiscard]] bool isSmoothing() const noexcept;

        [[nodiscard]] int getRemainingSamples() const noexcept;

        [[nodiscard]] SampleType getTargetValue() const noexcept;
 
    private:
        int m_duration{ 1 };
        int m_samplesRemaining{ 0 };
        SampleType m_currentValue{ static_cast<SampleType>(0.0) };
        SampleType m_targetValue{ static_cast<SampleType>(0.0) };
        SampleType m_slew{ static_cast<SampleType>(0.0) };
        SampleType m_approxTarget{};
    };
} // namespace marvin::utils
#endif