File Driver.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_CORE_DRIVER_H
#define _AM_CORE_DRIVER_H

#include <SparkyStudios/Audio/Amplitude/Core/Common.h>
#include <SparkyStudios/Audio/Amplitude/Core/Device.h>

#include <map>
#include <memory>
#include <vector>

namespace SparkyStudios::Audio::Amplitude
{
    class AM_API_PUBLIC Driver
    {
    public:
        explicit Driver(AmString name);

        virtual ~Driver();

        virtual bool Open(const DeviceDescription& device) = 0;

        virtual bool Close() = 0;

        virtual bool EnumerateDevices(std::vector<DeviceDescription>& devices) = 0;

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

        [[nodiscard]] const DeviceDescription& GetDeviceDescription() const;

        static void Register(std::shared_ptr<Driver> driver);

        static void Unregister(std::shared_ptr<const Driver> driver);

        static std::shared_ptr<Driver> Default();

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

        static void SetDefault(const AmString& name);

        static void ResetDefault();

        static void LockRegistry();

        static void UnlockRegistry();

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

    protected:
        AmString m_name;

        DeviceDescription m_deviceDescription;
    };
} // namespace SparkyStudios::Audio::Amplitude

#endif // _AM_CORE_DRIVER_H