mxvk::VK_Mixer Class Reference

SDL3_mixer-based audio manager. More...

#include <mxvk/include/mxvk/mxvk_sound.hpp>

Public Member Functions
void	cleanup ()
	Free all loaded audio chunks and music tracks.
void	init ()
	Open the audio device (called automatically by constructor).
bool	isMusicPlaying (int id) const
	Query whether a loaded music track is currently playing.
bool	isPlaying (int channel) const
	Query whether a sound track is currently playing.
int	loadMusic (const std::string &filename)
	Load an audio file as streaming background music.
int	loadWav (const std::string &filename)
	Load a WAV file as a sound effect chunk.
VK_Mixer &	operator= (const VK_Mixer &)=delete
VK_Mixer &	operator= (VK_Mixer &&)=delete
int	playMusic (int id, int value=0)
	Start playing a previously loaded music track.
int	playWav (int id, int value=0, int channel=-1)
	Play a previously loaded WAV chunk.
void	stopMusic ()
	Stop background music playback immediately.
	VK_Mixer ()
	Initialise SDL3_mixer and open the audio device.
	VK_Mixer (const VK_Mixer &)=delete
	VK_Mixer (VK_Mixer &&)=delete
	~VK_Mixer () noexcept
	Halt all playback and free all loaded audio resources.

Detailed Description

SDL3_mixer-based audio manager.

Provides facilities for loading WAV sound chunks and streamed music tracks, playing them, and querying playback state. Only available when the library is built with MIXER enabled.

Definition at line 27 of file mxvk_sound.hpp.

Constructor & Destructor Documentation

VK_Mixer() [1/3]

mxvk::VK_Mixer::VK_Mixer

(

)

Initialise SDL3_mixer and open the audio device.

Definition at line 19 of file mxvk_sound.cpp.

{ init(); }

~VK_Mixer()

mxvk::VK_Mixer::~VK_Mixer ( )

noexcept

Halt all playback and free all loaded audio resources.

Definition at line 21 of file mxvk_sound.cpp.

{ cleanup(); }

VK_Mixer() [2/3]

mxvk::VK_Mixer::VK_Mixer ( const VK_Mixer & )

delete

VK_Mixer() [3/3]

mxvk::VK_Mixer::VK_Mixer ( VK_Mixer && )

delete

Member Function Documentation

cleanup()

void mxvk::VK_Mixer::cleanup

(

)

Free all loaded audio chunks and music tracks.

Definition at line 190 of file mxvk_sound.cpp.

                           {
        if (!initialized) {
            return;
        }
 
        stopMusic();
        music_tracks.clear();
        wav_tracks.clear();
        music_files.clear();
        wav_files.clear();
        mixer.reset();
        MIX_Quit();
        initialized = false;
    }

init()

void mxvk::VK_Mixer::init

(

)

Open the audio device (called automatically by constructor).

Definition at line 23 of file mxvk_sound.cpp.

                        {
        if (initialized) {
            return;
        }
 
        if (!MIX_Init()) {
            throw mxvk::Exception("Could not initialize SDL3_mixer: " + std::string(SDL_GetError()));
        }
 
        SDL_AudioSpec spec{};
        spec.freq = 44100;
        spec.format = SDL_AUDIO_S16;
        spec.channels = 2;
 
        MIX_Mixer *raw_mixer = MIX_CreateMixerDevice(SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK, &spec);
        if (raw_mixer == nullptr) {
            MIX_Quit();
            throw mxvk::Exception("Could not create mixer device: " + std::string(SDL_GetError()));
        }
 
        mixer.reset(raw_mixer);
        initialized = true;
    }

isMusicPlaying()

bool mxvk::VK_Mixer::isMusicPlaying ( int id ) const

nodiscard

Query whether a loaded music track is currently playing.

Parameters

id	Music index returned by loadMusic().

Returns

true if the music track is active.

Definition at line 165 of file mxvk_sound.cpp.

                                                            {
        if (!initialized || id < 0 || id >= static_cast<int>(music_tracks.size())) {
            return false;
        }
 
        MIX_Track *track = music_tracks[toIndex(id)].get();
        if (track == nullptr) {
            return false;
        }
        return MIX_TrackPlaying(track);
    }

isPlaying()

bool mxvk::VK_Mixer::isPlaying ( int channel ) const

nodiscard

Query whether a sound track is currently playing.

Parameters

channel

Track index.

Returns

true if the channel is active.

Definition at line 153 of file mxvk_sound.cpp.

                                                            {
        if (!initialized || channel < 0 || channel >= static_cast<int>(wav_tracks.size())) {
            return false;
        }
 
        MIX_Track *track = wav_tracks[toIndex(channel)].get();
        if (track == nullptr) {
            return false;
        }
        return MIX_TrackPlaying(track);
    }

loadMusic()

int mxvk::VK_Mixer::loadMusic

(

const std::string &

filename

)

Load an audio file as streaming background music.

Parameters

filename

Path to the music file (OGG, MP3, WAV, etc.).

Returns

Index used to reference this track in playMusic().

Definition at line 47 of file mxvk_sound.cpp.

                                                     {
        if (filename.empty()) {
            throw mxvk::Exception("Music filename cannot be empty");
        }
        if (!initialized || mixer == nullptr) {
            throw mxvk::Exception("Audio mixer is not initialized");
        }
 
        MIX_Audio *raw_audio = MIX_LoadAudio(mixer.get(), filename.c_str(), false);
        if (raw_audio == nullptr) {
            throw mxvk::Exception("Error loading music file '" + filename + "': " + std::string(SDL_GetError()));
        }
 
        MIX_Track *raw_track = MIX_CreateTrack(mixer.get());
        if (raw_track == nullptr) {
            MIX_DestroyAudio(raw_audio);
            throw mxvk::Exception("Error creating music track: " + std::string(SDL_GetError()));
        }
        if (!MIX_SetTrackAudio(raw_track, raw_audio)) {
            MIX_DestroyTrack(raw_track);
            MIX_DestroyAudio(raw_audio);
            throw mxvk::Exception("Error assigning music track audio: " + std::string(SDL_GetError()));
        }
 
        music_files.emplace_back(raw_audio, MIX_DestroyAudio);
        music_tracks.emplace_back(raw_track, MIX_DestroyTrack);
        return static_cast<int>(music_files.size() - 1);
    }

loadWav()

int mxvk::VK_Mixer::loadWav

(

const std::string &

filename

)

Load a WAV file as a sound effect chunk.

Parameters

filename

Path to the WAV file.

Returns

Index used to reference this chunk in playWav().

Definition at line 76 of file mxvk_sound.cpp.

                                                   {
        if (filename.empty()) {
            throw mxvk::Exception("WAV filename cannot be empty");
        }
        if (!initialized || mixer == nullptr) {
            throw mxvk::Exception("Audio mixer is not initialized");
        }
 
        MIX_Audio *raw_audio = MIX_LoadAudio(mixer.get(), filename.c_str(), true);
        if (raw_audio == nullptr) {
            throw mxvk::Exception("Error loading WAV file '" + filename + "': " + std::string(SDL_GetError()));
        }
 
        MIX_Track *raw_track = MIX_CreateTrack(mixer.get());
        if (raw_track == nullptr) {
            MIX_DestroyAudio(raw_audio);
            throw mxvk::Exception("Error creating WAV track: " + std::string(SDL_GetError()));
        }
        if (!MIX_SetTrackAudio(raw_track, raw_audio)) {
            MIX_DestroyTrack(raw_track);
            MIX_DestroyAudio(raw_audio);
            throw mxvk::Exception("Error assigning WAV track audio: " + std::string(SDL_GetError()));
        }
 
        wav_files.emplace_back(raw_audio, MIX_DestroyAudio);
        wav_tracks.emplace_back(raw_track, MIX_DestroyTrack);
        return static_cast<int>(wav_files.size() - 1);
    }

operator=() [1/2]

VK_Mixer & mxvk::VK_Mixer::operator= ( const VK_Mixer & )

delete

operator=() [2/2]

VK_Mixer & mxvk::VK_Mixer::operator= ( VK_Mixer && )

delete

playMusic()

int mxvk::VK_Mixer::playMusic	(	int	id,
		int	value = 0 )

Start playing a previously loaded music track.

Parameters

id	Music index returned by loadMusic().
value	Number of additional loops (0 = play once, -1 = infinite).

Returns

0 on success, negative on failure.

Definition at line 105 of file mxvk_sound.cpp.

                                             {
        if (!initialized) {
            return -1;
        }
        if (id < 0 || id >= static_cast<int>(music_tracks.size())) {
            return -1;
        }
 
        MIX_Track *track = music_tracks[toIndex(id)].get();
        if (track == nullptr) {
            return -1;
        }
        if (!MIX_SetTrackLoops(track, value)) {
            return -1;
        }
        return MIX_PlayTrack(track, 0) ? 0 : -1;
    }

playWav()

int mxvk::VK_Mixer::playWav	(	int	id,
		int	value = 0,
		int	channel = -1 )

Play a previously loaded WAV chunk.

Parameters

id	Chunk index returned by loadWav().
value	Number of additional loops (0 = play once).
channel	Track index to use (-1 = use track for id).

Returns

The channel used for playback, or -1 on failure.

Definition at line 123 of file mxvk_sound.cpp.

                                                        {
        if (!initialized) {
            return -1;
        }
        if (id < 0 || id >= static_cast<int>(wav_files.size())) {
            return -1;
        }
 
        int target = id;
        if (channel >= 0) {
            if (channel >= static_cast<int>(wav_tracks.size())) {
                return -1;
            }
            target = channel;
        }
 
        MIX_Track *track = wav_tracks[toIndex(target)].get();
        MIX_Audio *audio = wav_files[toIndex(id)].get();
        if (track == nullptr || audio == nullptr) {
            return -1;
        }
        if (!MIX_SetTrackAudio(track, audio)) {
            return -1;
        }
        if (!MIX_SetTrackLoops(track, value)) {
            return -1;
        }
        return MIX_PlayTrack(track, 0) ? target : -1;
    }

stopMusic()

void mxvk::VK_Mixer::stopMusic

(

)

Stop background music playback immediately.

Definition at line 177 of file mxvk_sound.cpp.

                             {
        if (!initialized || mixer == nullptr) {
            return;
        }
 
        for (const auto &track : music_tracks) {
            if (track != nullptr) {
                MIX_StopTrack(track.get(), 0);
            }
        }
        MIX_StopAllTracks(mixer.get(), 0);
    }

---

The documentation for this class was generated from the following files:

• mxvk/include/mxvk/mxvk_sound.hpp
• mxvk/src/mxvk_sound.cpp