marvin_DelayLine.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_DELAYLINE_H
#define MARVIN_DELAYLINE_H
#include "marvin/library/marvin_Concepts.h"
#include <vector>
namespace marvin::dsp {
    enum class DelayLineInterpolationType {
        None,
        Linear,
        Lagrange3rd
    };

    template <FloatType SampleType, DelayLineInterpolationType InterpolationType = DelayLineInterpolationType::Linear>
    class DelayLine {
    public:
        DelayLine();
        explicit DelayLine(int maximumDelayInSamples);
        void setDelay(SampleType newDelayInSamples);
        [[nodiscard]] SampleType getDelay() const noexcept;
        void initialise(double sampleRate);
        void setMaximumDelayInSamples(int maxDelayInSamples);
        [[nodiscard]] int getMaximumDelayInSamples() const noexcept;
        void reset();
        void pushSample(SampleType sample);
        [[nodiscard]] SampleType popSample(SampleType delayInSamples = -1, bool updateReadPointer = true);

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

        [[nodiscard]] int getWritePos() const noexcept;
 
    private:
        [[nodiscard]] SampleType interpolateSample();
        void updateInternalVariables();
        double m_sampleRate{};
        std::vector<SampleType> m_bufferData{};
        int m_writePos{ 0 }, m_readPos{ 0 };
        SampleType m_delay{ 0.0 };
        SampleType m_delayFrac{ 0.0 };
        int m_delayInt{ 0 };
        int m_totalSize{ 4 };
    };
 
} // namespace marvin::dsp
#endif