Revert "use miniaudio as sound engine, removed irrklang (#2681)" (#2726)

This reverts commit 9f0a4bea.

gframe/event_handler.cpp

@@ -1898,14 +1898,12 @@ bool ClientField::OnCommonEvent(const irr::SEvent& event) {
 				return true;
 				break;
 			}
-#ifdef YGOPRO_USE_AUDIO
 			case CHECKBOX_ENABLE_MUSIC: {
 				if(!mainGame->chkEnableMusic->isChecked())
 					soundManager.StopBGM();
 				return true;
 				break;
 			}
-#endif
 			case CHECKBOX_DISABLE_CHAT: {
 				bool show = (mainGame->is_building && !mainGame->is_siding) ? false : !mainGame->chkIgnore1->isChecked();
 				mainGame->wChat->setVisible(show);
@@ -1998,7 +1996,6 @@ bool ClientField::OnCommonEvent(const irr::SEvent& event) {
 				return true;
 				break;
 			}
-#ifdef YGOPRO_USE_AUDIO
 			case SCROLL_VOLUME: {
 				mainGame->gameConf.sound_volume = (double)mainGame->scrSoundVolume->getPos() / 100;
 				mainGame->gameConf.music_volume = (double)mainGame->scrMusicVolume->getPos() / 100;
@@ -2007,7 +2004,6 @@ bool ClientField::OnCommonEvent(const irr::SEvent& event) {
 				return true;
 				break;
 			}
-#endif
 			case SCROLL_TAB_HELPER: {
 				irr::core::rect<irr::s32> pos = mainGame->tabHelper->getRelativePosition();
 				mainGame->tabHelper->setRelativePosition(irr::core::recti(0, mainGame->scrTabHelper->getPos() * -1, pos.LowerRightCorner.X, pos.LowerRightCorner.Y));

gframe/game.cpp

@@ -1414,7 +1414,7 @@ void Game::LoadConfig() {
 			gameConf.window_height = std::strtol(valbuf, nullptr, 10);
 		} else if(!std::strcmp(strbuf, "resize_popup_menu")) {
 			gameConf.resize_popup_menu = std::strtol(valbuf, nullptr, 10) > 0;
-#ifdef YGOPRO_USE_AUDIO
+#ifdef YGOPRO_USE_IRRKLANG
 		} else if(!std::strcmp(strbuf, "enable_sound")) {
 			gameConf.enable_sound = std::strtol(valbuf, nullptr, 10) > 0;
 		} else if(!std::strcmp(strbuf, "sound_volume")) {
@@ -1519,7 +1519,7 @@ void Game::SaveConfig() {
 	std::fprintf(fp, "window_width = %d\n", gameConf.window_width);
 	std::fprintf(fp, "window_height = %d\n", gameConf.window_height);
 	std::fprintf(fp, "resize_popup_menu = %d\n", gameConf.resize_popup_menu ? 1 : 0);
-#ifdef YGOPRO_USE_AUDIO
+#ifdef YGOPRO_USE_IRRKLANG
 	std::fprintf(fp, "enable_sound = %d\n", (chkEnableSound->isChecked() ? 1 : 0));
 	std::fprintf(fp, "enable_music = %d\n", (chkEnableMusic->isChecked() ? 1 : 0));
 	std::fprintf(fp, "#Volume of sound and music, between 0 and 100\n");

gframe/miniaudio/premake5.lua

-project "cminiaudio"
-    kind "StaticLib"
-    files { "*.c", "*.h" }
-
-    filter "action:vs*"
-        forceincludes { "stb_vorbis.h" }
-
-    filter "not action:vs*"
-        forceincludes { "./stb_vorbis.h" }
-
-    filter "system:linux"
-        links { "dl", "pthread", "m" }

gframe/premake5.lua

 include "lzma/."
 include "spmemvfs/."
-if USE_AUDIO then
-    include "miniaudio/."
-end
 
 project "YGOPro"
     kind "WindowedApp"
@@ -13,6 +10,10 @@ project "YGOPro"
     includedirs { "../ocgcore" }
     links { "ocgcore", "clzma", "cspmemvfs", LUA_LIB_NAME, "sqlite3", "irrlicht", "freetype", "event" }
 
+    if BUILD_IKPMP3 then
+        links { "ikpmp3" }
+    end
+
     if BUILD_EVENT then
         includedirs { "../event/include" }
     else
@@ -41,15 +42,29 @@ project "YGOPro"
         libdirs { SQLITE_LIB_DIR }
     end
 
-    if USE_AUDIO then
-        defines { "YGOPRO_USE_AUDIO" }
-        links { "cminiaudio" }
+    if USE_IRRKLANG then
+        defines { "YGOPRO_USE_IRRKLANG" }
+        includedirs { IRRKLANG_INCLUDE_DIR }
+        if not IRRKLANG_PRO then
+            libdirs { IRRKLANG_LIB_DIR }
+        end
     end
 
     filter "system:windows"
         defines { "_IRR_WCHAR_FILESYSTEM" }
         files "ygopro.rc"
         libdirs { "$(DXSDK_DIR)Lib/x86" }
+        if USE_IRRKLANG then
+            links { "irrKlang" }
+            if IRRKLANG_PRO then
+                defines { "IRRKLANG_STATIC" }
+                filter { "not configurations:Debug" }
+                    libdirs { IRRKLANG_PRO_RELEASE_LIB_DIR }
+                filter { "configurations:Debug" }
+                    libdirs { IRRKLANG_PRO_DEBUG_LIB_DIR }
+                filter {}
+            end
+        end
         links { "opengl32", "ws2_32", "winmm", "gdi32", "kernel32", "user32", "imm32" }
     filter "not action:vs*"
         buildoptions { "-fno-rtti" }
@@ -62,5 +77,12 @@ project "YGOPro"
             buildoptions { "--target=arm64-apple-macos12" }
             linkoptions { "-arch arm64" }
         end
+        if USE_IRRKLANG then
+            links { "irrklang" }
+        end
     filter "system:linux"
         links { "GL", "X11", "Xxf86vm" }
+        if USE_IRRKLANG then
+            links { "IrrKlang" }
+            linkoptions{ IRRKLANG_LINK_RPATH }
+        end

gframe/sound_manager.cpp

 #include "sound_manager.h"
 #include "myfilesystem.h"
+#ifdef IRRKLANG_STATIC
+#include "../ikpmp3/ikpMP3.h"
+#endif
 
 namespace ygo {
 
 SoundManager soundManager;
 
 bool SoundManager::Init() {
-#ifdef YGOPRO_USE_AUDIO
+#ifdef YGOPRO_USE_IRRKLANG
 	bgm_scene = -1;
 	RefreshBGMList();
 	rnd.reset((unsigned int)std::time(nullptr));
-	if(ma_engine_init(nullptr, &engineSound) || ma_engine_init(nullptr, &engineMusic)) {
+	engineSound = irrklang::createIrrKlangDevice();
+	engineMusic = irrklang::createIrrKlangDevice();
+	if(!engineSound || !engineMusic) {
 		return false;
 	} else {
+#ifdef IRRKLANG_STATIC
+		irrklang::ikpMP3Init(engineMusic);
+#endif
 		return true;
 	}
-#endif // YGOPRO_USE_AUDIO
+#endif // YGOPRO_USE_IRRKLANG
+	// TODO: Implement other sound engines
 	return false;
 }
 void SoundManager::RefreshBGMList() {
-#ifdef YGOPRO_USE_AUDIO
 	RefershBGMDir(L"", BGM_DUEL);
 	RefershBGMDir(L"duel", BGM_DUEL);
 	RefershBGMDir(L"menu", BGM_MENU);
@@ -28,7 +36,6 @@ void SoundManager::RefreshBGMList() {
 	RefershBGMDir(L"disadvantage", BGM_DISADVANTAGE);
 	RefershBGMDir(L"win", BGM_WIN);
 	RefershBGMDir(L"lose", BGM_LOSE);
-#endif
 }
 void SoundManager::RefershBGMDir(std::wstring path, int scene) {
 	std::wstring search = L"./sound/BGM/" + path;
@@ -41,138 +48,134 @@ void SoundManager::RefershBGMDir(std::wstring path, int scene) {
 	});
 }
 void SoundManager::PlaySoundEffect(int sound) {
+#ifdef YGOPRO_USE_IRRKLANG
 	if(!mainGame->chkEnableSound->isChecked())
 		return;
-	char soundName[32];
+	engineSound->setSoundVolume(mainGame->gameConf.sound_volume);
 	switch(sound) {
 	case SOUND_SUMMON: {
-		strcpy(soundName, "summon");
+		engineSound->play2D("./sound/summon.wav");
 		break;
 	}
 	case SOUND_SPECIAL_SUMMON: {
-		strcpy(soundName, "specialsummon");
+		engineSound->play2D("./sound/specialsummon.wav");
 		break;
 	}
 	case SOUND_ACTIVATE: {
-		strcpy(soundName, "activate");
+		engineSound->play2D("./sound/activate.wav");
 		break;
 	}
 	case SOUND_SET: {
-		strcpy(soundName, "set");
+		engineSound->play2D("./sound/set.wav");
 		break;
 	}
 	case SOUND_FILP: {
-		strcpy(soundName, "flip");
+		engineSound->play2D("./sound/flip.wav");
 		break;
 	}
 	case SOUND_REVEAL: {
-		strcpy(soundName, "reveal");
+		engineSound->play2D("./sound/reveal.wav");
 		break;
 	}
 	case SOUND_EQUIP: {
-		strcpy(soundName, "equip");
+		engineSound->play2D("./sound/equip.wav");
 		break;
 	}
 	case SOUND_DESTROYED: {
-		strcpy(soundName, "destroyed");
+		engineSound->play2D("./sound/destroyed.wav");
 		break;
 	}
 	case SOUND_BANISHED: {
-		strcpy(soundName, "banished");
+		engineSound->play2D("./sound/banished.wav");
 		break;
 	}
 	case SOUND_TOKEN: {
-		strcpy(soundName, "token");
+		engineSound->play2D("./sound/token.wav");
 		break;
 	}
 	case SOUND_ATTACK: {
-		strcpy(soundName, "attack");
+		engineSound->play2D("./sound/attack.wav");
 		break;
 	}
 	case SOUND_DIRECT_ATTACK: {
-		strcpy(soundName, "directattack");
+		engineSound->play2D("./sound/directattack.wav");
 		break;
 	}
 	case SOUND_DRAW: {
-		strcpy(soundName, "draw");
+		engineSound->play2D("./sound/draw.wav");
 		break;
 	}
 	case SOUND_SHUFFLE: {
-		strcpy(soundName, "shuffle");
+		engineSound->play2D("./sound/shuffle.wav");
 		break;
 	}
 	case SOUND_DAMAGE: {
-		strcpy(soundName, "damage");
+		engineSound->play2D("./sound/damage.wav");
 		break;
 	}
 	case SOUND_RECOVER: {
-		strcpy(soundName, "recover");
+		engineSound->play2D("./sound/gainlp.wav");
 		break;
 	}
 	case SOUND_COUNTER_ADD: {
-		strcpy(soundName, "addcounter");
+		engineSound->play2D("./sound/addcounter.wav");
 		break;
 	}
 	case SOUND_COUNTER_REMOVE: {
-		strcpy(soundName, "removecounter");
+		engineSound->play2D("./sound/removecounter.wav");
 		break;
 	}
 	case SOUND_COIN: {
-		strcpy(soundName, "coin");
+		engineSound->play2D("./sound/coinflip.wav");
 		break;
 	}
 	case SOUND_DICE: {
-		strcpy(soundName, "dice");
+		engineSound->play2D("./sound/diceroll.wav");
 		break;
 	}
 	case SOUND_NEXT_TURN: {
-		strcpy(soundName, "nextturn");
+		engineSound->play2D("./sound/nextturn.wav");
 		break;
 	}
 	case SOUND_PHASE: {
-		strcpy(soundName, "phase");
+		engineSound->play2D("./sound/phase.wav");
 		break;
 	}
 	case SOUND_MENU: {
-		strcpy(soundName, "menu");
+		engineSound->play2D("./sound/menu.wav");
 		break;
 	}
 	case SOUND_BUTTON: {
-		strcpy(soundName, "button");
+		engineSound->play2D("./sound/button.wav");
 		break;
 	}
 	case SOUND_INFO: {
-		strcpy(soundName, "info");
+		engineSound->play2D("./sound/info.wav");
 		break;
 	}
 	case SOUND_QUESTION: {
-		strcpy(soundName, "question");
+		engineSound->play2D("./sound/question.wav");
 		break;
 	}
 	case SOUND_CARD_PICK: {
-		strcpy(soundName, "cardpick");
+		engineSound->play2D("./sound/cardpick.wav");
 		break;
 	}
 	case SOUND_CARD_DROP: {
-		strcpy(soundName, "carddrop");
+		engineSound->play2D("./sound/carddrop.wav");
 		break;
 	}
 	case SOUND_PLAYER_ENTER: {
-		strcpy(soundName, "playerenter");
+		engineSound->play2D("./sound/playerenter.wav");
 		break;
 	}
 	case SOUND_CHAT: {
-		strcpy(soundName, "chat");
+		engineSound->play2D("./sound/chatmessage.wav");
 		break;
 	}
 	default:
 		break;
 	}
-	char soundPath[40];
-	std::snprintf(soundPath, 40, "./sound/%s.wav", soundName);
-#ifdef YGOPRO_USE_AUDIO
-	ma_engine_set_volume(&engineSound, mainGame->gameConf.sound_volume);
-	auto res = ma_engine_play_sound(&engineSound, soundPath, nullptr);
 #endif
 }
 void SoundManager::PlayDialogSound(irr::gui::IGUIElement * element) {
@@ -198,39 +201,25 @@ void SoundManager::PlayDialogSound(irr::gui::IGUIElement * element) {
 		PlaySoundEffect(SOUND_QUESTION);
 	}
 }
-bool SoundManager::IsCurrentlyPlaying(char* song) {
-#ifdef YGOPRO_USE_AUDIO
-	return currentPlayingMusic[0] && strcmp(currentPlayingMusic, song) == 0 && ma_sound_is_playing(&soundBGM);
-#endif
-	return false;
-}
 void SoundManager::PlayMusic(char* song, bool loop) {
-#ifdef YGOPRO_USE_AUDIO
+#ifdef YGOPRO_USE_IRRKLANG
 	if(!mainGame->chkEnableMusic->isChecked())
 		return;
-	if(!IsCurrentlyPlaying(song)) {
-		StopBGM();
-		strcpy(currentPlayingMusic, song);
-#ifdef _WIN32
-		wchar_t song_w[1024];
-		BufferIO::DecodeUTF8(song, song_w);
-		ma_sound_init_from_file_w(&engineMusic, song_w, MA_SOUND_FLAG_ASYNC | MA_SOUND_FLAG_STREAM, nullptr, nullptr, &soundBGM);
-#else
-		auto res = ma_sound_init_from_file(&engineMusic, song, MA_SOUND_FLAG_ASYNC | MA_SOUND_FLAG_STREAM, nullptr, nullptr, &soundBGM);
-#endif
-		ma_sound_set_looping(&soundBGM, loop);
-		ma_sound_start(&soundBGM);
+	if(!engineMusic->isCurrentlyPlaying(song)) {
+		engineMusic->stopAllSounds();
+		engineMusic->setSoundVolume(mainGame->gameConf.music_volume);
+		soundBGM = engineMusic->play2D(song, loop, false, true);
 	}
 #endif
 }
 void SoundManager::PlayBGM(int scene) {
-#ifdef YGOPRO_USE_AUDIO
+#ifdef YGOPRO_USE_IRRKLANG
 	if(!mainGame->chkEnableMusic->isChecked())
 		return;
 	if(!mainGame->chkMusicMode->isChecked())
 		scene = BGM_ALL;
 	char BGMName[1024];
-	if(scene != bgm_scene || !IsCurrentlyPlaying(currentPlayingMusic)) {
+	if(scene != bgm_scene || (soundBGM && soundBGM->isFinished())) {
 		int count = BGMList[scene].size();
 		if(count <= 0)
 			return;
@@ -245,21 +234,18 @@ void SoundManager::PlayBGM(int scene) {
 #endif
 }
 void SoundManager::StopBGM() {
-#ifdef YGOPRO_USE_AUDIO
-	if(!currentPlayingMusic[0])
-		return;
-	memset(currentPlayingMusic, 0, sizeof(currentPlayingMusic));
-	ma_sound_uninit(&soundBGM);
+#ifdef YGOPRO_USE_IRRKLANG
+	engineMusic->stopAllSounds();
 #endif
 }
 void SoundManager::SetSoundVolume(double volume) {
-#ifdef YGOPRO_USE_AUDIO
-	ma_engine_set_volume(&engineSound, volume);
+#ifdef YGOPRO_USE_IRRKLANG
+	engineSound->setSoundVolume(volume);
 #endif
 }
 void SoundManager::SetMusicVolume(double volume) {
-#ifdef YGOPRO_USE_AUDIO
-	ma_engine_set_volume(&engineMusic, volume);
+#ifdef YGOPRO_USE_IRRKLANG
+	engineMusic->setSoundVolume(volume);
 #endif
 }
 }

gframe/sound_manager.h

@@ -3,8 +3,8 @@
 
 #include "game.h"
 #include "../ocgcore/mtrandom.h"
-#ifdef YGOPRO_USE_AUDIO
-#include "miniaudio/miniaudio.h"
+#ifdef YGOPRO_USE_IRRKLANG
+#include <irrKlang.h>
 #endif
 
 namespace ygo {
@@ -14,11 +14,10 @@ private:
 	std::vector<std::wstring> BGMList[8];
 	int bgm_scene;
 	mt19937 rnd;
-#ifdef YGOPRO_USE_AUDIO
-	ma_engine engineSound;
-	ma_engine engineMusic;
-	ma_sound soundBGM;
-	char currentPlayingMusic[1024]{};
+#ifdef YGOPRO_USE_IRRKLANG
+	irrklang::ISoundEngine* engineSound;
+	irrklang::ISoundEngine* engineMusic;
+	irrklang::ISound* soundBGM;
 #endif
 	void RefershBGMDir(std::wstring path, int scene);
 
@@ -27,7 +26,6 @@ public:
 	void RefreshBGMList();
 	void PlaySoundEffect(int sound);
 	void PlayDialogSound(irr::gui::IGUIElement * element);
-	bool IsCurrentlyPlaying(char* song);
 	void PlayMusic(char* song, bool loop);
 	void PlayBGM(int scene);
 	void StopBGM();

premake5.lua

@@ -5,6 +5,8 @@ BUILD_EVENT = os.istarget("windows")
 BUILD_FREETYPE = os.istarget("windows")
 BUILD_SQLITE = os.istarget("windows")
 BUILD_IRRLICHT = not os.istarget("macosx")
+USE_IRRKLANG = true
+IRRKLANG_PRO = false
 LUA_LIB_NAME = "lua"
 
 -- read settings from command line or environment variables
@@ -35,6 +37,11 @@ newoption { trigger = "no-build-irrlicht", category = "YGOPro - irrlicht", descr
 newoption { trigger = "irrlicht-include-dir", category = "YGOPro - irrlicht", description = "", value = "PATH" }
 newoption { trigger = "irrlicht-lib-dir", category = "YGOPro - irrlicht", description = "", value = "PATH" }
 
+newoption { trigger = "use-irrklang", category = "YGOPro - irrklang", description = "" }
+newoption { trigger = "no-use-irrklang", category = "YGOPro - irrklang", description = "" }
+newoption { trigger = "irrklang-include-dir", category = "YGOPro - irrklang", description = "", value = "PATH" }
+newoption { trigger = "irrklang-lib-dir", category = "YGOPro - irrklang", description = "", value = "PATH" }
+
 newoption { trigger = "irrklang-pro", category = "YGOPro - irrklang - pro", description = "" }
 newoption { trigger = "no-irrklang-pro", category = "YGOPro - irrklang - pro", description = "" }
 newoption { trigger = "irrklang-pro-release-lib-dir", category = "YGOPro - irrklang - pro", description = "", value = "PATH" }
@@ -106,7 +113,36 @@ if not BUILD_IRRLICHT then
     IRRLICHT_LIB_DIR = GetParam("irrlicht-lib-dir") or "/usr/local/lib"
 end
 
-USE_AUDIO = not GetParam("no-audio")
+if GetParam("use-irrklang") then
+    USE_IRRKLANG = true
+elseif GetParam("no-use-irrklang") then
+    USE_IRRKLANG = false
+end
+if USE_IRRKLANG then
+    IRRKLANG_INCLUDE_DIR = GetParam("irrklang-include-dir") or "../irrklang/include"
+    if os.istarget("windows") then
+        IRRKLANG_LIB_DIR = "../irrklang/lib/Win32-visualStudio"
+    elseif os.istarget("linux") then
+        IRRKLANG_LIB_DIR = "../irrklang/bin/linux-gcc-64"
+        IRRKLANG_LINK_RPATH = "-Wl,-rpath=./irrklang/bin/linux-gcc-64/"
+    elseif os.istarget("macosx") then
+        IRRKLANG_LIB_DIR = "../irrklang/bin/macosx-gcc"
+    end
+    IRRKLANG_LIB_DIR = GetParam("irrklang-lib-dir") or IRRKLANG_LIB_DIR
+end
+
+if GetParam("irrklang-pro") and os.istarget("windows") then
+    IRRKLANG_PRO = true
+elseif GetParam("no-irrklang-pro") then
+    IRRKLANG_PRO = false
+end
+if IRRKLANG_PRO then
+    -- irrklang pro can't use the pro lib to debug
+    IRRKLANG_PRO_RELEASE_LIB_DIR = GetParam("irrklang-pro-release-lib-dir") or "../irrklang/lib/Win32-vs2019"
+    IRRKLANG_PRO_DEBUG_LIB_DIR = GetParam("irrklang-pro-debug-lib-dir") or "../irrklang/lib/Win32-visualStudio-debug"  
+end
+
+BUILD_IKPMP3 = USE_IRRKLANG and (GetParam("build-ikpmp3") or IRRKLANG_PRO)
 
 if GetParam("winxp-support") and os.istarget("windows") then
     WINXP_SUPPORT = true
@@ -196,6 +232,6 @@ workspace "YGOPro"
     if BUILD_SQLITE then
         include "sqlite3"
     end
-    --if BUILD_IKPMP3 then
-    --    include "ikpmp3"
-    --end
+    if BUILD_IKPMP3 then
+        include "ikpmp3"
+    end