mgl_audio_voice.h

[詳解]

// SPDX-License-Identifier: Zlib
/* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
 
#ifndef INCGUARD_MGL_AUDIO_VOICE_H_1610732115
#define INCGUARD_MGL_AUDIO_VOICE_H_1610732115
 
#include <mgl/audio/mgl_audio_defs.h>
#include <mgl/mgl_environment.h>
#include <mgl/stl/mgl_stl_memory.h>
 
#include <atomic>
 
namespace MGL::Audio
{
class Voice
{
public:
    enum class Status : uint8_t
    {
        None,       
        Loading,    
        Error,      
        Ready,      
        Remove      
    };
 
    enum class Type : uint8_t
    {
        Static,    
        Dynamic    
    };
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    constexpr Voice(VoiceKey key, Type type) noexcept
        : _key(key)
        , _type(type)
        , _status(Status::None)
        , _volume(1.0f)
    {
    }
 
    virtual ~Voice() noexcept = default;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual bool Load() noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual bool GetSample([[maybe_unused]] float &outDataL, [[maybe_unused]] float &outDataR, [[maybe_unused]] uint32_t trackIndex, [[maybe_unused]] size_t sampleFrame) const noexcept
    {
        return false;
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual bool GetSample([[maybe_unused]] float &outDataL, [[maybe_unused]] float &outDataR) noexcept
    {
        return false;
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual bool Start([[maybe_unused]] uint32_t trackIndex, [[maybe_unused]] LoopType loopType) noexcept
    {
        return true;
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    virtual void Stop() noexcept
    {
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    [[nodiscard]] virtual uint32_t GetTotalFrame(uint32_t trackIndex) const noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    [[nodiscard]] virtual bool IsLoop(uint32_t trackIndex) const noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    [[nodiscard]] virtual uint32_t GetLoopFrame(uint32_t trackIndex) const noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    [[nodiscard]] constexpr VoiceKey GetKey() const noexcept
    {
        return _key;
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    void RemoveRequests() noexcept
    {
        switch (_status)
        {
            case Status::Ready:
                _status = Status::Remove;
                break;
 
            default:
                break;
        }
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    [[nodiscard]] Status GetStatus() const noexcept
    {
        return _status;
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    [[nodiscard]] constexpr Type GetType() const noexcept
    {
        return _type;
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    [[nodiscard]] virtual uint32_t GetTrackCount() const noexcept = 0;
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    void SetVolume(float volume) noexcept
    {
        _volume = volume;
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    [[nodiscard]] float GetVolume() const noexcept
    {
        return _volume;
    }
 
protected:
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    void SetStatus(Status status) noexcept
    {
        _status = status;
    }
 
private:
    VoiceKey _key;
    Type _type;
    std::atomic<Status> _status;
    std::atomic<float> _volume;
};
 
using SharedVoice = std::shared_ptr<Voice>;
 
}    // namespace MGL::Audio
#endif    // INCGUARD_MGL_AUDIO_VOICE_H_1610732115
 
// vim: et ts=4 sw=4 sts=4