Skip to content

File Reverb.h

File List > Amplitude > DSP > Reverb.h

Go to the documentation of this file

// Copyright (c) 2026-present Sparky Studios. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#ifndef _AM_DSP_REVERB_H
#define _AM_DSP_REVERB_H

#include <SparkyStudios/Audio/Amplitude/Core/AudioBuffer.h>
#include <SparkyStudios/Audio/Amplitude/Core/Memory.h>

#include <map>
#include <memory>

namespace SparkyStudios::Audio::Amplitude
{
    class Reverb;

    class AM_API_PUBLIC ReverbInstance
    {
    public:
        explicit ReverbInstance(Reverb* parent);

        virtual ~ReverbInstance() = default;

        virtual void Initialize(AmUInt32 sampleRate) = 0;

        virtual void Reset() = 0;

        virtual void SetRoomParameters(AmReal32 roomSize, AmReal32 absorption) = 0;

        virtual void Configure(AmUInt64 frames)
        {}

        virtual void Process(const AudioBuffer& in, AudioBuffer& out, AmUInt64 frames, AmUInt32 sampleRate) = 0;

        [[nodiscard]] Reverb* GetParent() const;

    protected:
        Reverb* _parent;
    };

    class AM_API_PUBLIC Reverb
    {
    public:
        explicit Reverb(AmString name);

        virtual ~Reverb() = default;

        [[nodiscard]] const AmString& GetName() const;

        virtual std::shared_ptr<ReverbInstance> CreateInstance() = 0;

        static void Register(std::shared_ptr<Reverb> reverb);

        static void Unregister(std::shared_ptr<const Reverb> reverb);

        static std::shared_ptr<Reverb> Find(const AmString& name);

        static const std::map<AmString, std::shared_ptr<Reverb>>& GetRegistry();

        static void LockRegistry();

        static void UnlockRegistry();

    protected:
        AmString m_name;
    };
} // namespace SparkyStudios::Audio::Amplitude

#endif // _AM_DSP_REVERB_H