Queue script events calling to avoid unsynchronized multi-thread acce…

…ss to the parser
Silver-Ore-Team · Jul 1, 2023 · 1e87f13 · 1e87f13
1 parent d4cdce7
commit 1e87f13
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 41 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.25)
-set(PROJECT_VERSION "0.0.8")
+set(PROJECT_VERSION "0.0.9")
 if(DEFINED ENV{PROJECT_VERSION})
 	set(PROJECT_VERSION "$ENV{PROJECT_VERSION}")
 endif()

diff --git a/_externals/BassMusic.d b/_externals/BassMusic.d
@@ -54,19 +54,19 @@ func void BassMusic_OnChangeEvent(var func callback) {};
 func void BassMusic_SetFullScriptControl(var int active) {};
 
 // ---------------------------------------------------------------
-// BassMuisc_Opt_TransitionTime: Set TransitionTime option value.
+// BassMusic_Opt_TransitionTime: Set TransitionTime option value.
 // @param var float time: Transition time in miliseconds
 // ---------------------------------------------------------------
-func void BassMuisc_Opt_TransitionTime(var float time) {};
+func void BassMusic_Opt_TransitionTime(var float time) {};
 
 // ---------------------------------------------------------------
-// BassMuisc_Opt_ForceDisableReverb: Set ForceDisableReverb option value.
+// BassMusic_Opt_ForceDisableReverb: Set ForceDisableReverb option value.
 // @param var int enabled: Boolean value
 // ---------------------------------------------------------------
-func void BassMuisc_Opt_ForceDisableReverb(var int enabled) {};
+func void BassMusic_Opt_ForceDisableReverb(var int enabled) {};
 
 // ---------------------------------------------------------------
-// BassMuisc_Opt_ForceFadeTransition: Set ForceFadeTransition option value.
+// BassMusic_Opt_ForceFadeTransition: Set ForceFadeTransition option value.
 // @param var int enabled: Boolean value
 // ---------------------------------------------------------------
-func void BassMuisc_Opt_ForceFadeTransition(var int enabled) {};
+func void BassMusic_Opt_ForceFadeTransition(var int enabled) {};
diff --git a/docs/scriptable-interface.md b/docs/scriptable-interface.md
@@ -60,22 +60,22 @@ func void BassMusic_OnChangeEvent(var func callback) {};
 func void BassMusic_SetFullScriptControl(var int active) {};
 
 // ---------------------------------------------------------------
-// BassMuisc_Opt_TransitionTime: Set TransitionTime option value.
+// BassMusic_Opt_TransitionTime: Set TransitionTime option value.
 // @param var float time: Transition time in miliseconds
 // ---------------------------------------------------------------
-func void BassMuisc_Opt_TransitionTime(var float time) {};
+func void BassMusic_Opt_TransitionTime(var float time) {};
 
 // ---------------------------------------------------------------
-// BassMuisc_Opt_ForceDisableReverb: Set ForceDisableReverb option value.
+// BassMusic_Opt_ForceDisableReverb: Set ForceDisableReverb option value.
 // @param var int enabled: Boolean value
 // ---------------------------------------------------------------
-func void BassMuisc_Opt_ForceDisableReverb(var int enabled) {};
+func void BassMusic_Opt_ForceDisableReverb(var int enabled) {};
 
 // ---------------------------------------------------------------
-// BassMuisc_Opt_ForceFadeTransition: Set ForceFadeTransition option value.
+// BassMusic_Opt_ForceFadeTransition: Set ForceFadeTransition option value.
 // @param var int enabled: Boolean value
 // ---------------------------------------------------------------
-func void BassMuisc_Opt_ForceFadeTransition(var int enabled) {};
+func void BassMusic_Opt_ForceFadeTransition(var int enabled) {};
 ```
 
 ## Full Script Control

diff --git a/plugin/src/Gothic/CMusicSys_Bass.hpp b/plugin/src/Gothic/CMusicSys_Bass.hpp
@@ -2,48 +2,48 @@ namespace GOTHIC_NAMESPACE
 {
 	namespace BassEvent
 	{
-		void Event_OnEnd(const NH::Bass::MusicDef* musicDef, int data, void* userData)
+		void Event_OnEnd(const NH::Bass::MusicDef musicDef, int data, void* userData)
 		{
-			NH::Log::Debug("Event", Union::StringUTF8("Event_OnEnd: ") + Union::StringUTF8(musicDef->Filename.ToChar()));
+			NH::Log::Debug("Event", Union::StringUTF8("Event_OnEnd: ") + Union::StringUTF8(musicDef.Filename.ToChar()));
 
 			for (int i = 0; i < Globals->Event_OnEnd_Functions.GetNumInList(); i++)
 			{
 				const int funcId = Globals->Event_OnEnd_Functions[i];
-				Globals->BassMusic_EventThemeFilename = zSTRING(musicDef->Filename.ToChar());
-				Globals->BassMusic_EventThemeID = zSTRING(musicDef->Name.ToChar());
+				Globals->BassMusic_EventThemeFilename = zSTRING(musicDef.Filename.ToChar());
+				Globals->BassMusic_EventThemeID = zSTRING(musicDef.Name.ToChar());
 				parser->CallFunc(funcId);
 			}
 		}
 
-		void Event_OnTransition(const NH::Bass::MusicDef* musicDef, int data, void* userData)
+		void Event_OnTransition(const NH::Bass::MusicDef musicDef, int data, void* userData)
 		{
-			NH::Log::Debug("Event", Union::StringUTF8("Event_OnTransition: ") + Union::StringUTF8(musicDef->Filename.ToChar())
+			NH::Log::Debug("Event", Union::StringUTF8("Event_OnTransition: ") + Union::StringUTF8(musicDef.Filename.ToChar())
 				+ Union::StringUTF8::Format(", %i ms", data));
 
 			for (int i = 0; i < Globals->Event_OnTransition_Functions.GetNumInList(); i++)
 			{
 				const int funcId = Globals->Event_OnTransition_Functions[i];
-				Globals->BassMusic_EventThemeFilename = zSTRING(musicDef->Filename.ToChar());
-				Globals->BassMusic_EventThemeID = zSTRING(musicDef->Name.ToChar());
+				Globals->BassMusic_EventThemeFilename = zSTRING(musicDef.Filename.ToChar());
+				Globals->BassMusic_EventThemeID = zSTRING(musicDef.Name.ToChar());
 				parser->CallFunc(funcId, data);
 			}
 		}
 
-		void Event_OnChange(const NH::Bass::MusicDef* musicDef, int data, void* userData)
+		void Event_OnChange(const NH::Bass::MusicDef musicDef, int data, void* userData)
 		{
-			NH::Log::Debug("Event", Union::StringUTF8("Event_OnChange: ") + Union::StringUTF8(musicDef->Filename.ToChar()));
+			NH::Log::Debug("Event", Union::StringUTF8("Event_OnChange: ") + Union::StringUTF8(musicDef.Filename.ToChar()));
 
-			zSTRING filename = zSTRING(musicDef->Filename.ToChar());
-			zSTRING name = zSTRING(musicDef->Name.ToChar());
+			zSTRING filename = zSTRING(musicDef.Filename.ToChar());
+			zSTRING name = zSTRING(musicDef.Name.ToChar());
 
 			Globals->BassMusic_ActiveThemeFilename = filename;
 			Globals->BassMusic_ActiveThemeID = name;
 
 			for (int i = 0; i < Globals->Event_OnChange_Functions.GetNumInList(); i++)
 			{
 				const int funcId = Globals->Event_OnChange_Functions[i];
-				Globals->BassMusic_EventThemeFilename = zSTRING(musicDef->Filename.ToChar());
-				Globals->BassMusic_EventThemeID = zSTRING(musicDef->Name.ToChar());
+				Globals->BassMusic_EventThemeFilename = zSTRING(musicDef.Filename.ToChar());
+				Globals->BassMusic_EventThemeID = zSTRING(musicDef.Name.ToChar());
 				parser->CallFunc(funcId);
 			}
 		}

diff --git a/plugin/src/NH/Bass.cpp b/plugin/src/NH/Bass.cpp
@@ -148,7 +148,7 @@ namespace NH
 			BASS_ChannelSetSync(m_FrontChannel.Stream, BASS_SYNC_END, 0, SyncEnd, this);
 			Log::Debug("BassEngine", Union::StringUTF8("SyncEnd set: ") + musicDef.Filename);
 
-			m_EventManager.DispatchEvent(EventType::MUSIC_CHANGE, &m_FrontChannel.Music);
+			m_EventManager.DispatchEvent(EventType::MUSIC_CHANGE, m_FrontChannel.Music);
 		}
 
 		void Engine::Update(const unsigned long time)
@@ -162,7 +162,7 @@ namespace NH
 
 			if (m_FrontChannel.Stream > 0 && m_FrontChannel.Playing)
 			{
-				m_EventManager.DispatchEvent(EventType::MUSIC_ACTIVE, &m_FrontChannel.Music);
+				m_EventManager.DispatchEvent(EventType::MUSIC_ACTIVE,m_FrontChannel.Music);
 			}
 		}
 
@@ -268,7 +268,7 @@ namespace NH
 			const auto self = static_cast<Engine*>(_this);
 			if (self->m_FrontChannel.Stream == channel)
 			{
-				self->GetEM().DispatchEvent(EventType::MUSIC_TRANSITION, &self->m_FrontChannel.Music, self->m_FrontChannel.Music.EndTransition.Duration);
+				self->GetEM().DispatchEvent(EventType::MUSIC_TRANSITION, self->m_FrontChannel.Music, self->m_FrontChannel.Music.EndTransition.Duration);
 			}
 		}
 
@@ -281,7 +281,7 @@ namespace NH
 				{
 					self->m_FrontChannel.Playing = false;
 				}
-				self->GetEM().DispatchEvent(EventType::MUSIC_END, &self->m_FrontChannel.Music);
+				self->GetEM().DispatchEvent(EventType::MUSIC_END, self->m_FrontChannel.Music);
 			}
 		}
 

diff --git a/plugin/src/NH/BassEventManager.cpp b/plugin/src/NH/BassEventManager.cpp
@@ -1,4 +1,5 @@
 #include "BassEventManager.h"
+#include <NH/Union.h>
 
 namespace NH
 {
@@ -21,17 +22,24 @@ namespace NH
 			}
 		}
 
-		EventManager::EventManager()
+		void EventManager::DispatchEvent(const EventType type, const MusicDef musicDef, const int data)
 		{
+			m_EventQueue.emplace_front(Event{type, musicDef, data});
 		}
 
-		void EventManager::DispatchEvent(const EventType type, const MusicDef* musicDef, const int data)
+		void EventManager::Update()
 		{
-			for (const auto s : m_Subscribers)
+			while (!m_EventQueue.empty())
 			{
-				if (s.Type == type)
+				NH::Log::Debug("EM", Union::StringUTF8("Processing events, left: ") + Union::StringUTF8(m_EventQueue.size()));
+				Event event = m_EventQueue.back();
+				m_EventQueue.pop_back();
+				for (const auto s : m_Subscribers)
 				{
-					s.Function(musicDef, data, s.UserData);
+					if (s.Type == event.type)
+					{
+						s.Function(event.music, event.data, s.UserData);
+					}
 				}
 			}
 		}

diff --git a/plugin/src/NH/BassEventManager.h b/plugin/src/NH/BassEventManager.h
@@ -2,12 +2,13 @@
 
 #include <NH/BassTypes.h>
 #include <Union/Array.h>
+#include <deque>
 
 namespace NH
 {
 	namespace Bass
 	{
-		using EventSubscriberFunction = void(*)(const MusicDef*, int data, void*);
+		using EventSubscriberFunction = void(*)(const MusicDef, int data, void*);
 
 		enum class EventType
 		{
@@ -33,19 +34,29 @@ namespace NH
 
 		class EventManager
 		{
+			struct Event
+			{
+				EventType type;
+				MusicDef music;
+				int data;
+			};
+
 			friend Engine;
 
 			Union::Array<EventSubscriber> m_Subscribers{};
+			std::deque<Event> m_EventQueue;
 
 		public:
 			EventSubscriber* AddSubscriber(EventType type, EventSubscriberFunction function, void* userData = nullptr);
 
 			void RemoveSubscriber(const EventSubscriber* subscriber);
 
-		private:
-			EventManager();
+			void DispatchEvent(EventType type, const MusicDef musicDef, int data = 0);
 
-			void DispatchEvent(EventType type, const MusicDef* musicDef, int data = 0);
+			void Update();
+
+		private:
+			EventManager() {};
 		};
 	}
 }
diff --git a/plugin/src/Plugin.cpp b/plugin/src/Plugin.cpp
@@ -24,7 +24,14 @@
 NH::Bass::BassOptions* NH::Bass::Options = new NH::Bass::BassOptions{};
 
 EXTERN_C_START
-__declspec(dllexport) void Game_DefineExternals() {
+__declspec(dllexport) void Game_Loop() 
+{
+	auto* engine = NH::Bass::Engine::Initialize();
+	engine->GetEM().Update();
+}
+
+__declspec(dllexport) void Game_DefineExternals() 
+{
 	NH::Bass::Options->LoggerLevelUnion = "DEBUG";
 	NH::Bass::Options->LoggerLevelZSpy = "DEBUG";