SoundStage.hpp

Go to the documentation of this file.

#ifndef DONUT_AUDIO_SOUND_STAGE_HPP
#define DONUT_AUDIO_SOUND_STAGE_HPP
 
#include <donut/Time.hpp>
#include <donut/UniqueHandle.hpp>
#include <donut/audio/Listener.hpp>
#include <donut/math.hpp>
 
namespace donut::audio {
 
class Sound; // Forward declaration, to avoid including Sound.hpp.
 
struct SoundStageOptions {
    float volume = 1.0f;
 
    float speedOfSound = 343.3f;
 
    unsigned maxSimultaneousSounds = 32u;
};
 
class SoundStage {
public:
    using SoundInstanceId = unsigned;
 
    explicit SoundStage(const SoundStageOptions& options = {});
 
    void update(Time<float> deltaTime, const Listener& listener);
 
    SoundInstanceId playSound(const Sound& sound, float volume = -1.0f, vec3 position = {0.0f, 0.0f, 0.0f}, vec3 velocity = {0.0f, 0.0f, 0.0f});
 
    SoundInstanceId playSoundInBackground(const Sound& sound, float volume = -1.0f);
 
    SoundInstanceId createPausedSoundInBackground(const Sound& sound, float volume = -1.0f);
 
    [[nodiscard]] bool isSoundPaused(SoundInstanceId id) const noexcept;
 
    [[nodiscard]] bool isSoundStopped(SoundInstanceId id) const noexcept;
 
    void stopSound(SoundInstanceId id);
 
    void pauseSound(SoundInstanceId id);
 
    void resumeSound(SoundInstanceId id);
 
    void scheduleSoundStop(SoundInstanceId id, Time<float> timePointInSound);
 
    void scheduleSoundPause(SoundInstanceId id, Time<float> timePointInSound);
 
    void seekToSoundTime(SoundInstanceId id, Time<float> timePointInSound);
 
    void setSoundPosition(SoundInstanceId id, vec3 newPosition);
 
    void setSoundVelocity(SoundInstanceId id, vec3 newVelocity);
 
    void setSoundPositionAndVelocity(SoundInstanceId id, vec3 newPosition, vec3 newVelocity);
 
    void setSoundVolume(SoundInstanceId id, float volume);
 
    void fadeSoundVolume(SoundInstanceId id, float targetVolume, float fadeDuration);
 
    void setSoundPlaybackSpeed(SoundInstanceId id, float playbackSpeed);
 
    void fadeSoundPlaybackSpeed(SoundInstanceId id, float targetPlaybackSpeed, float fadeDuration);
 
    void setVolume(float volume);
 
    void fadeVolume(float targetVolume, float fadeDuration);
 
    void setSpeedOfSound(float speedOfSound);
 
    void setMaxSimultaneousSounds(unsigned maxSimultaneousSounds);
 
private:
    struct EngineDeleter {
        void operator()(void* handle) const noexcept;
    };
 
    UniqueHandle<void*, EngineDeleter> engine{};
    Time<float> time{};
};
 
} // namespace donut::audio
 
#endif