AudioSource.h

Go to the documentation of this file.

 
#pragma once
 
#include "ncengine/asset/Assets.h"
#include "ncengine/ecs/Component.h"
 
#include <span>
 
namespace nc
{
namespace audio
{
class NcAudioImpl;
} // namespace audio
 
struct AudioSourceFlags
{
    static constexpr uint8_t None    = 0b00000000;
    static constexpr uint8_t Play    = 0b00000001;
    static constexpr uint8_t Loop    = 0b00000010;
    static constexpr uint8_t Spatial = 0b00000100;
};
 
struct AudioSourceProperties
{
    float gain = 1.0f;
    float innerRadius = 1.0f;
    float outerRadius = 15.0f;
    uint8_t flags = AudioSourceFlags::None;
};
 
constexpr auto NullClipIndex = UINT32_MAX;
 
class AudioSource : public ComponentBase
{
    public:
        AudioSource(Entity entity,
                    std::vector<asset::AudioClipView> clips = {},
                    AudioSourceProperties properties = AudioSourceProperties{});
 
        void Play(uint32_t clipIndex = 0ull);
 
        void PlayNext();
 
        auto IsPlaying() const noexcept -> bool { return m_properties.flags & AudioSourceFlags::Play; }
 
        void Queue(uint32_t clipIndex);
 
        auto GetQueuedClipIndex() const noexcept -> uint32_t { return m_currentClipIndex; }
 
        void Stop() noexcept { m_properties.flags &= ~AudioSourceFlags::Play; }
 
        void Resume();
 
        void ResetPlayPosition() { m_currentSampleIndex = 0; }
 
        auto AddClip(const asset::AudioClipView& clip) -> uint32_t;
 
        void SetClip(uint32_t clipIndex, const asset::AudioClipView& clip);
 
        void RemoveClip(uint32_t clipIndex);
 
        auto GetClips()       const noexcept -> const std::vector<asset::AudioClipView>& { return m_clips; }
        auto GetProperties()  const noexcept -> const AudioSourceProperties&             { return m_properties; }
        auto GetGain()        const noexcept -> float                                    { return m_properties.gain; }
        auto GetInnerRadius() const noexcept -> float                                    { return m_properties.innerRadius; }
        auto GetOuterRadius() const noexcept -> float                                    { return m_properties.outerRadius; }
        auto IsSpatial()      const noexcept -> bool                                     { return m_properties.flags & AudioSourceFlags::Spatial; }
        auto IsLooping()      const noexcept -> bool                                     { return m_properties.flags & AudioSourceFlags::Loop; }
 
        void SetProperties(const AudioSourceProperties& properties) noexcept { m_properties = properties; }
        void SetGain(float gain)                                    noexcept { m_properties.gain = gain; }
        void SetInnerRadius(float radius)                           noexcept { m_properties.innerRadius = radius; }
        void SetOuterRadius(float radius)                           noexcept { m_properties.outerRadius = radius; }
 
        void SetSpatial(bool spatialize) noexcept
        {
            m_properties.flags = spatialize
                ? m_properties.flags | AudioSourceFlags::Spatial
                : m_properties.flags & ~AudioSourceFlags::Spatial;
        }
 
        void SetLooping(bool loop) noexcept
        {
            m_properties.flags = loop
                ? m_properties.flags | AudioSourceFlags::Loop
                : m_properties.flags & ~AudioSourceFlags::Loop;
        }
 
    private:
        std::vector<asset::AudioClipView> m_clips;
        uint32_t m_currentClipIndex = NullClipIndex;
        uint32_t m_currentSampleIndex = 0u;
        AudioSourceProperties m_properties;
 
        void SetPlaying() noexcept { m_properties.flags |= AudioSourceFlags::Play; }
        void SetStopped() noexcept { m_properties.flags &= ~AudioSourceFlags::Play; }
        void WriteSpatialSamples(double* buffer, size_t frames, const Vector3& sourcePosition, const Vector3& listenerPosition, const Vector3& rightEar);
        void WriteNonSpatialSamples(double* buffer, size_t frames);
 
        friend class audio::NcAudioImpl;
};
} // namespace nc