File Pipeline.h¶

// Copyright (c) 2021-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_MIXER_PIPELINE_H
#define _AM_MIXER_PIPELINE_H

#include <SparkyStudios/Audio/Amplitude/Core/Common.h>
#include <SparkyStudios/Audio/Amplitude/Mixer/Amplimix.h>
#include <SparkyStudios/Audio/Amplitude/Mixer/Node.h>

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

    class AM_API_PUBLIC PipelineInstance
    {
        friend class Pipeline;

    public:
        virtual ~PipelineInstance() = default;

        virtual void Execute(AudioBuffer& in, AudioBuffer& out) = 0;

        virtual void Reset() = 0;

        [[nodiscard]] virtual std::shared_ptr<NodeInstance> GetNode(AmObjectID id) const = 0;

        virtual void Configure(
            AmUInt64 inputFrameCount, AmUInt16 inputChannelCount, AmUInt64 outputFrameCount, AmUInt16 outputChannelCount) = 0;
    };

    class AM_API_PUBLIC Pipeline : public Asset<AmPipelineID>
    {
    public:
        ~Pipeline() override = default;

        virtual std::shared_ptr<PipelineInstance> CreateInstance(const AmplimixLayer* layer) const = 0;
    };
} // namespace SparkyStudios::Audio::Amplitude

#endif // _AM_MIXER_PIPELINE_H