fix: Dispatch callbacks to main thread.

Author: freezy

VisualPinball.Engine.PinMAME.Unity/Runtime/PinMameGamelogicEngine.cs

@@ -84,6 +84,8 @@ public GamelogicEngineLamp[] AvailableLamps {
 		private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
 		private static readonly Color Tint = new Color(1, 0.18f, 0);
 
+		private readonly Queue<Action> _dispatchQueue = new Queue<Action>();
+
 		private void Start()
 		{
 			UpdateCaches();
@@ -96,7 +98,7 @@ public void OnInit(Player player, TableApi tableApi, BallManager ballManager)
 				OnLampChanged?.Invoke(this, new LampEventArgs(lamp.Id, 0));
 			}
 
-			_pinMame = PinMame.PinMame.Instance();
+			_pinMame = PinMame.PinMame.Instance(48000, @"C:\Games\Visual Pinball\VPinMAME");
 			_pinMame.OnGameStarted += GameStarted;
 			_pinMame.OnGameEnded += GameEnded;
 			_pinMame.OnDisplayUpdate += DisplayUpdated;
@@ -117,6 +119,31 @@ private void GameStarted(object sender, EventArgs e)
 			_isRunning = true;
 		}
 
+		private void Update()
+		{
+			if (_pinMame == null || !_isRunning) {
+				return;
+			}
+
+			lock (_dispatchQueue) {
+				while (_dispatchQueue.Count > 0) {
+					_dispatchQueue.Dequeue().Invoke();
+				}
+			}
+
+			// lamps
+			var changedLamps = _pinMame.GetChangedLamps();
+			for (var i = 0; i < changedLamps.Length; i += 2) {
+				var internalId = changedLamps[i];
+				var val = changedLamps[i + 1];
+
+				if (_lamps.ContainsKey(internalId)) {
+					//Logger.Info($"[PinMAME] <= lamp {id}: {val}");
+					OnLampChanged?.Invoke(this, new LampEventArgs(_lamps[internalId].Id, val));
+				}
+			}
+		}
+
 		private void DisplayUpdated(object sender, EventArgs e, int index, IntPtr framePtr, PinMameDisplayLayout displayLayout)
 		{
 			if ((displayLayout.type & PinMameDisplayType.DMD) > 0) {
@@ -135,7 +162,12 @@ private void UpdateSegDisp(int index, PinMameDisplayLayout displayLayout, IntPtr
 		private void UpdateDmd(int index, PinMameDisplayLayout displayLayout, IntPtr framePtr)
 		{
 			if (!_sizeAnnounced) {
-				OnDisplaysAvailable?.Invoke(this, new AvailableDisplays(new DisplayConfig(DisplayDmd, displayLayout.width, displayLayout.height)));
+				lock (_dispatchQueue) {
+					_dispatchQueue.Enqueue(() =>
+						OnDisplaysAvailable?.Invoke(this, new AvailableDisplays(
+							new DisplayConfig(DisplayDmd, displayLayout.width, displayLayout.height))));
+				}
+
 				_sizeAnnounced = true;
 				_frameBuffer = new byte[displayLayout.width * displayLayout.height];
 			}
@@ -151,25 +183,21 @@ private void UpdateDmd(int index, PinMameDisplayLayout displayLayout, IntPtr fra
 				}
 			}
 
-			OnDisplayFrame?.Invoke(this, new DisplayFrameData(DisplayDmd, GetDisplayType(displayLayout.type), _frameBuffer));
-		}
-
-		private Dictionary<byte, byte> GetMap(PinMameDisplayLayout displayLayout)
-		{
-			if (displayLayout.depth == 2) {
-				return DmdMap2Bit;
+			lock (_dispatchQueue) {
+				_dispatchQueue.Enqueue(() => OnDisplayFrame?.Invoke(this,
+					new DisplayFrameData(DisplayDmd, GetDisplayType(displayLayout.type), _frameBuffer)));
 			}
-
-			return (_pinMame.GetHardwareGen() & (PinMameHardwareGen.SAM | PinMameHardwareGen.SPA)) > 0
-				? DmdMapSam
-				: DmdMapGts;
 		}
 
 		private void SolenoidChanged(object sender, EventArgs e, int internalId, bool isActive)
 		{
 			if (_coils.ContainsKey(internalId)) {
 				Logger.Info($"[PinMAME] <= coil {_coils[internalId].Id} ({internalId}): {isActive} | {_coils[internalId].Description}");
-				OnCoilChanged?.Invoke(this, new CoilEventArgs(_coils[internalId].Id, isActive));
+
+				lock (_dispatchQueue) {
+					_dispatchQueue.Enqueue(() =>
+						OnCoilChanged?.Invoke(this, new CoilEventArgs(_coils[internalId].Id, isActive)));
+				}
 
 			} else {
 				Logger.Warn($"[PinMAME] <= coil UNMAPPED {internalId}: {isActive}");
@@ -199,25 +227,6 @@ public void SendInitialSwitches()
 			}
 		}
 
-		private void Update()
-		{
-			if (_pinMame == null || !_isRunning) {
-				return;
-			}
-
-			// lamps
-			var changedLamps = _pinMame.GetChangedLamps();
-			for (var i = 0; i < changedLamps.Length; i += 2) {
-				var internalId = changedLamps[i];
-				var val = changedLamps[i + 1];
-
-				if (_lamps.ContainsKey(internalId)) {
-					//Logger.Info($"[PinMAME] <= lamp {id}: {val}");
-					OnLampChanged?.Invoke(this, new LampEventArgs(_lamps[internalId].Id, val));
-				}
-			}
-		}
-
 		private void UpdateCaches()
 		{
 			if (_game == null) {
@@ -257,6 +266,18 @@ public void Switch(string id, bool isClosed)
 			}
 		}
 
+
+		private Dictionary<byte, byte> GetMap(PinMameDisplayLayout displayLayout)
+		{
+			if (displayLayout.depth == 2) {
+				return DmdMap2Bit;
+			}
+
+			return (_pinMame.GetHardwareGen() & (PinMameHardwareGen.SAM | PinMameHardwareGen.SPA)) > 0
+				? DmdMapSam
+				: DmdMapGts;
+		}
+
 		private static DisplayFrameFormat GetDisplayType(PinMameDisplayType dp)
 		{
 			switch (dp) {