AudioResource.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "AudioMetadata.hpp"
 
#include "CeresEngine/Macros.hpp"
 
#include "CeresEngine/Foundation/SmartPtr.hpp"
#include "CeresEngine/Foundation/Container/Vector.hpp"
 
#include "CeresEngine/Resource/Resource.hpp"
 
#include <functional>
#include <system_error>
 
namespace CeresEngine {
 
    class AudioClip;
    class AudioStream;
 
    enum class CE_SCRIPT_EXPORT() AudioResourceType {
        Clip,
 
        Stream
    };
 
    class CE_SCRIPT_EXPORT() AbstractAudioResource {
    public:
        using Sample = unsigned short;
 
        using Samples = Vector<Sample>;
 
        using SampleIndex = unsigned int;
 
        using SampleOffset = int;
 
    public:
        virtual ~AbstractAudioResource() = default;
 
    public:
        [[nodiscard]] virtual const AudioMetadata& getMetadata() const = 0;
 
    public:
        [[nodiscard]] virtual AudioResourceType getType() const = 0;
 
        [[nodiscard]] CE_SCRIPT_EXPORT()
        bool isClip() const;
 
        AudioClip& asClip();
 
        [[nodiscard]] const AudioClip& asClip() const;
 
        [[nodiscard]] CE_SCRIPT_EXPORT()
        bool isStream() const;
 
        AudioStream& asStream();
 
        [[nodiscard]] const AudioStream& asStream() const;
    };
 
    template<typename T> class AudioResource : public AbstractAudioResource {};
 
    class CE_SCRIPT_EXPORT() AudioClip : public AudioResource<AudioClip>, public TResource<AudioClip> {
    public:
        [[nodiscard]] virtual const Samples& getSamples() const = 0;
 
    public:
        [[nodiscard]] AudioResourceType getType() const final;
    };
 
    class CE_SCRIPT_EXPORT() AudioStream : public AudioResource<AudioStream> {
    public:
        using ReadSamplesCallback = std::function<void(
            AudioStream&,
 
            std::error_code,
 
            Samples&)>;
 
    public:
        virtual void readSamples(unsigned int samples, ReadSamplesCallback&& callback) = 0;
 
        virtual void seek(SampleIndex index) = 0;
 
    public:
        [[nodiscard]] AudioResourceType getType() const final;
    };
 
    // ---------------------------------------------------------------------------------------------
 
    class SimpleAudioClip : public AudioClip {
    public:
        AudioMetadata metadata;
 
        Samples samples;
 
    public:
        SimpleAudioClip(AudioMetadata metadata, Samples samples);
 
    public:
        [[nodiscard]] const AudioMetadata& getMetadata() const override;
 
        [[nodiscard]] const Samples& getSamples() const override;
    };
 
} // namespace CeresEngine