Implement audio via SDL3_mixer

.gitignore

@@ -17,6 +17,7 @@ comparer-config.toml
 
 #ignore cmake cache
 /build-*/
+/build_*/
 .vscode/tasks.json
 
 # Extra files in the source distribution (see make_src_dist.py)

3rdParty/SDL3_mixer/CMakeLists.txt

@@ -27,7 +27,7 @@ set(SDLMIXER_VORBIS_TREMOR OFF)
 set(SDLMIXER_WAVPACK OFF)
 
 FetchContent_Declare_ExcludeFromAll(SDL_mixer
-  URL https://github.com/libsdl-org/SDL_mixer/archive/7d37755016f0952c32c9483c556d8608da7ee82f.tar.gz
-  URL_HASH SHA256=2fa63f1eb623e3acd0012a461771eb93332e2026205f9487da3a3a75bc790111
+  URL https://github.com/libsdl-org/SDL_mixer/archive/refs/tags/release-3.2.0.tar.gz
+  URL_HASH SHA256=1077fef4a6e9513027da0a08e6f1b8645f8c88c8bef001c17befeb52b129b5dd
 )
 FetchContent_MakeAvailable_ExcludeFromAll(SDL_mixer)

Source/engine/sound.cpp

@@ -16,12 +16,12 @@
 #include <utility>
 
 #ifdef USE_SDL3
-#include <SDL3/SDL_audio.h>
 #include <SDL3/SDL_error.h>
 #include <SDL3/SDL_timer.h>
+#include <SDL3_mixer/SDL_mixer.h>
 #else
 #include <Aulib/Stream.h>
 #include <SDL.h>
 #endif
 #include <expected.hpp>
 
@@ -30,19 +30,19 @@
 #include "game_mode.hpp"
 #include "options.h"
 #include "utils/log.hpp"
 #include "utils/math.h"
 #include "utils/sdl_mutex.h"
 #include "utils/status_macros.hpp"
 #include "utils/stdcompat/shared_ptr_array.hpp"
 #include "utils/str_cat.hpp"
 #include "utils/stubs.h"
 
 namespace devilution {
 
 bool gbSndInited;
 
 #ifdef USE_SDL3
-SDL_AudioDeviceID CurrentAudioDeviceId;
+MIX_Mixer *CurrentMixer;
 #endif
 
 /** The active background music track id. */
@@ -54,7 +54,7 @@
 
 namespace {
 
 SoundSample music;
 
 std::string GetMp3Path(const char *path)
 {
@@ -68,14 +68,14 @@
 {
 	bool isMp3 = true;
 	std::string foundPath = GetMp3Path(path);
 	AssetRef ref = FindAsset(foundPath.c_str());
 	if (!ref.ok()) {
 		ref = FindAsset(path);
 		foundPath = path;
 		isMp3 = false;
 	}
 	if (!ref.ok()) {
 		return tl::make_unexpected(StrCat("Audio file not found\n", path, "\n", SDL_GetError(), "\n" __FILE__ ":", __LINE__));
 	}
 
 #ifdef STREAM_ALL_AUDIO_MIN_FILE_SIZE
@@ -119,26 +119,24 @@
 
 SoundSample *DuplicateSound(const SoundSample &sound)
 {
-#ifdef USE_SDL3
-	return nullptr;
-#else
 	auto duplicate = std::make_unique<SoundSample>();
 	if (duplicate->DuplicateFrom(sound) != 0)
 		return nullptr;
 	auto *result = duplicate.get();
 	decltype(duplicateSounds.begin()) it;
 	{
 		const std::lock_guard<SdlMutex> lock(*duplicateSoundsMutex);
 		duplicateSounds.push_back(std::move(duplicate));
 		it = duplicateSounds.end();
 		--it;
 	}
+#ifndef USE_SDL3
 	result->SetFinishCallback([it]([[maybe_unused]] Aulib::Stream &stream) {
 		const std::lock_guard<SdlMutex> lock(*duplicateSoundsMutex);
 		duplicateSounds.erase(it);
 	});
-	return result;
 #endif
+	return result;
 }
 
 /** Maps from track ID to track name in spawn. */
@@ -166,12 +164,12 @@
 
 int CapVolume(int volume)
 {
 	return std::clamp(volume, VOLUME_MIN, VOLUME_MAX);
 }
 
 void OptionAudioChanged()
 {
 	effects_cleanup_sfx(false);
 	music_stop();
 	snd_deinit();
 	snd_init();
@@ -263,18 +261,22 @@
 	// 22kHz, the audio format to 16-bit signed, use 2 output channels
 	// (stereo), and a 2KiB output buffer.
 #ifdef USE_SDL3
+	if (!MIX_Init()) {
+		LogError(LogCategory::Audio, "Failed to initialize SDL_mixer: {}", SDL_GetError());
+		return;
+	}
 	const AudioOptions &audioOptions = GetOptions().Audio;
 	SDL_AudioSpec specHint = {};
 	specHint.format = SDL_AUDIO_S16LE;
 	specHint.channels = *audioOptions.channels;
 	specHint.freq = static_cast<int>(*audioOptions.sampleRate);
-	const SDL_AudioDeviceID resolvedId = SDL_OpenAudioDevice(audioOptions.device.id(), &specHint);
-	if (resolvedId == 0) {
-		LogError(LogCategory::Audio, "Failed to open audio device: {}", SDL_GetError());
+	CurrentMixer = MIX_CreateMixerDevice(audioOptions.device.id(), &specHint);
+	if (CurrentMixer == nullptr) {
+		LogError(LogCategory::Audio, "Failed to create mixer device: {}", SDL_GetError());
 		SDL_ClearError();
+		MIX_Quit();
 		return;
 	}
-	CurrentAudioDeviceId = resolvedId;
 #else
 	if (!Aulib::init(*GetOptions().Audio.sampleRate, AUDIO_S16, *GetOptions().Audio.channels, *GetOptions().Audio.bufferSize, *GetOptions().Audio.device)) {
 		LogError(LogCategory::Audio, "Failed to initialize audio (Aulib::init): {}", SDL_GetError());
@@ -291,9 +293,11 @@
 void snd_deinit()
 {
 	if (gbSndInited) {
+		ClearDuplicateSounds();
 #ifdef USE_SDL3
-		const AudioOptions &audioOptions = GetOptions().Audio;
-		SDL_CloseAudioDevice(audioOptions.device.id());
+		MIX_DestroyMixer(CurrentMixer);
+		CurrentMixer = nullptr;
+		MIX_Quit();
 #else
 		Aulib::quit();
 #endif

Source/engine/sound.h

@@ -17,7 +17,7 @@
 
 #ifndef NOSOUND
 #ifdef USE_SDL3
-#include <SDL3/SDL_audio.h>
+struct MIX_Mixer;
 #endif
 
 #include "utils/soundsample.h"
@@ -59,7 +59,7 @@ struct TSnd {
 
 extern bool gbSndInited;
 #ifdef USE_SDL3
-extern SDL_AudioDeviceID CurrentAudioDeviceId;
+extern MIX_Mixer *CurrentMixer;
 #endif
 
 extern _music_id sgnMusicTrack;

Source/storm/storm_svid.cpp

@@ -15,6 +15,7 @@
 
 #ifndef NOSOUND
 #include <SDL3/SDL_audio.h>
+#include <SDL3_mixer/SDL_mixer.h>
 #endif
 #else
 #include <SDL.h>
@@ -30,6 +31,7 @@
 #include "engine/assets.hpp"
 #include "engine/dx.h"
 #include "engine/palette.h"
+#include "engine/sound.h"
 #include "options.h"
 #include "utils/display.h"
 #include "utils/log.hpp"
@@ -313,7 +315,9 @@ void SVidInitAudioStream(const SmackerAudioInfo &audioInfo)
 		SVidAudioStream = nullptr;
 		return;
 	}
-	if (!SDL_BindAudioStream(CurrentAudioDeviceId, SVidAudioStream)) {
+	const SDL_AudioDeviceID deviceId = static_cast<SDL_AudioDeviceID>(
+	    SDL_GetNumberProperty(MIX_GetMixerProperties(CurrentMixer), MIX_PROP_MIXER_DEVICE_NUMBER, 0));
+	if (!SDL_BindAudioStream(deviceId, SVidAudioStream)) {
 		LogError(LogCategory::Audio, "SDL_BindAudioStream (from SVidPlayBegin): {}", SDL_GetError());
 		SDL_ClearError();
 		SDL_DestroyAudioStream(SVidAudioStream);