NcAudio.h

Go to the documentation of this file.

 
#pragma once
 
#include "ncengine/audio/AudioSource.h"
#include "ncengine/ecs/EcsFwd.h"
#include "ncengine/ecs/Entity.h"
#include "ncengine/module/Module.h"
#include "ncengine/type/EngineId.h"
#include "ncengine/utility/Signal.h"
 
#include <limits>
 
namespace nc
{
class Transform;
 
namespace config
{
struct AudioSettings;
} // namespace config
 
using AudioDeviceId = uint32_t;
 
constexpr auto DefaultAudioDeviceId = std::numeric_limits<AudioDeviceId>::max();
 
constexpr auto InvalidAudioDeviceId = DefaultAudioDeviceId - 1u;
 
struct AudioDevice
{
    std::string name = "UnknownDevice";
    AudioDeviceId id = InvalidAudioDeviceId;
};
 
struct NcAudio : public Module
{
    explicit NcAudio() noexcept
        : Module{NcAudioId} {}
 
    virtual void RegisterListener(Entity entity) noexcept = 0;
 
    virtual auto GetStreamTime() const noexcept -> double = 0;
 
    virtual void SetStreamTime(double time) noexcept = 0;
 
    virtual auto EnumerateOutputDevices() noexcept -> std::vector<AudioDevice> = 0;
 
    virtual auto GetOutputDevice() const noexcept -> const AudioDevice& = 0;
 
    virtual auto SetOutputDevice(AudioDeviceId deviceId = DefaultAudioDeviceId) noexcept -> bool = 0;
 
    virtual auto OnChangeOutputDevice() noexcept -> Signal<const AudioDevice&>& = 0;
};
 
auto BuildAudioModule(const config::AudioSettings& settings, ecs::ExplicitEcs<Entity, Transform, AudioSource> gameState) -> std::unique_ptr<NcAudio>;
} // namespace nc