sound.h

Go to the documentation of this file.

 
 
#ifndef ASW_SOUND_H
#define ASW_SOUND_H
 
#include <cstdint>
 
#include "./geometry.h"
#include "./types.h"
 
namespace asw::sound {
 
enum class Bus : uint8_t {
    Sfx,
    Music,
    Ambient,
    Ui,
    Voice,
    Count,
};
 
enum class Rolloff : uint8_t {
    Linear,
    Inverse,
    InverseSquare,
};
 
enum class SpatialMode : uint8_t {
    Stereo,
    Surround,
};
 
struct Attenuation {
    float min_distance { 100.0F };
 
    float max_distance { 1000.0F };
 
    Rolloff rolloff { Rolloff::Inverse };
};
 
struct PlayOptions {
    float volume { 1.0F };
 
    float pan { 0.0F };
 
    bool loop { false };
 
    float pitch { 1.0F };
 
    float pitch_variation { 0.0F };
 
    float volume_variation { 0.0F };
 
    Bus bus { Bus::Sfx };
 
    int priority { 0 };
 
    float fade_in_s { 0.0F };
 
    Attenuation attenuation {};
};
 
struct HandleAccess;
 
class SoundHandle {
public:
    SoundHandle() = default;
 
    bool is_playing() const;
 
    void stop(float fade_out_s = 0.0F) const;
 
    void pause() const;
 
    void resume() const;
 
    void set_volume(float volume) const;
 
    void set_pitch(float pitch) const;
 
    void set_pan(float pan) const;
 
    void set_position(const Vec2<float>& position) const;
 
    void set_velocity(const Vec2<float>& velocity) const;
 
    void set_occlusion(float amount) const;
 
    void set_attenuation(const Attenuation& attenuation) const;
 
private:
    friend struct HandleAccess;
 
    SoundHandle(int voice, uint32_t generation);
 
    int voice { -1 };
    uint32_t generation { 0 };
};
 
bool _init();
 
void _update();
 
void _shutdown();
 
MIX_Mixer* get_mixer();
 
uint32_t _get_session();
 
SoundHandle play(
    const asw::Sample& sample, float volume = 1.0F, float pan = 0.0F, bool loop = false);
 
SoundHandle play(const asw::Sample& sample, const PlayOptions& options);
 
SoundHandle play_positional(
    const asw::Sample& sample, const Vec2<float>& position, const PlayOptions& options = {});
 
SoundHandle play_at(const asw::Sample& sample, float x, float volume = 1.0F);
 
SoundHandle play_at(const asw::Sample& sample, float x, const PlayOptions& options);
 
void set_listener(const Vec2<float>& position, const Vec2<float>& velocity = { 0.0F, 0.0F });
 
Vec2<float> get_listener();
 
void set_spatial_mode(SpatialMode mode);
 
void set_doppler(float factor, float speed_of_sound = 3000.0F);
 
void set_bus_volume(Bus bus, float volume);
 
float get_bus_volume(Bus bus);
 
void duck(Bus bus, float gain, float hold_s, float fade_s = 0.2F);
 
void play_music(const asw::Music& sample, float volume = 1.0F, float fade_in_s = 0.0F);
 
void stop_music(float fade_out_s = 0.0F);
 
void pause_music();
 
void resume_music();
 
bool is_music_playing();
 
bool is_music_paused();
 
void set_master_volume(float volume);
 
void set_sfx_volume(float volume);
 
void set_music_volume(float volume);
 
float get_master_volume();
 
float get_sfx_volume();
 
float get_music_volume();
 
} // namespace asw::sound
 
#endif // ASW_SOUND_H