Make invisible emulation behave more as expected.

Author: SuuperW

Assets/Lua/GBA/SonicAdvance_CamHack.lua

@@ -25,6 +25,8 @@ local function seek_frame(frame)
 	if pause then client.pause() end
 end
 
+event.onexit(function() client.invisibleemulation(false) end)
+
 while true do
 	client.invisibleemulation(true)
 	local memorystate = memorysavestate.savecorestate()
@@ -46,6 +48,5 @@ while true do
 	client.invisibleemulation(true)
 	memorysavestate.loadcorestate(memorystate)
 	memorysavestate.removestate(memorystate)
---	client.invisibleemulation(false)
 	emu.frameadvance()
 end

src/BizHawk.Client.Common/Api/Classes/EmuClientApi.cs

@@ -135,7 +135,7 @@ public void FrameSkip(int numFrames)
 		public int GetWindowSize()
 			=> _config.GetWindowScaleFor(Emulator.SystemId);
 
-		public void InvisibleEmulation(bool invisible) => _mainForm.InvisibleEmulation = invisible;
+		public void InvisibleEmulation(bool invisible) => _mainForm.InvisibleEmulateNextFrame = invisible;
 
 		public bool IsPaused() => _mainForm.EmulatorPaused;
 

src/BizHawk.Client.Common/IMainFormForApi.cs

@@ -17,7 +17,7 @@ public interface IMainFormForApi
 		bool EmulatorPaused { get; }
 
 		/// <remarks>only referenced from <see cref="EmuClientApi"/></remarks>
-		bool InvisibleEmulation { get; set; }
+		bool InvisibleEmulateNextFrame { get; set; }
 
 		/// <remarks>only referenced from <see cref="EmuClientApi"/></remarks>
 		bool IsSeeking { get; }

src/BizHawk.Client.EmuHawk/IMainFormForTools.cs

@@ -25,7 +25,7 @@ public interface IMainFormForTools : IDialogController
 		bool HoldFrameAdvance { get; set; }
 
 		/// <remarks>only referenced from <see cref="BasicBot"/></remarks>
-		bool InvisibleEmulation { get; set; }
+		bool InvisibleEmulateNextFrame { get; set; }
 
 		/// <remarks>only referenced from <see cref="TAStudio"/></remarks>
 		bool IsFastForwarding { get; }

src/BizHawk.Client.EmuHawk/MainForm.cs

@@ -1002,8 +1002,12 @@ public int ProgramRunLoop()
 				Tools.GeneralUpdateActiveExtTools();
 
 				StepRunLoop_Core();
-				Render();
-				StepRunLoop_Throttle();
+
+				if (!_invisibleEmulation)
+				{
+					Render();
+					StepRunLoop_Throttle();
+				}
 
 				// HACK: RAIntegration might peek at memory during messages
 				// we need this to allow memory access here, otherwise it will deadlock
@@ -1145,7 +1149,9 @@ private void OnPauseToggle(bool newPauseState)
 		/// <item><description><see cref="ClientLuaLibrary.InvisibleEmulation(bool)"/></description></item>
 		/// </list>
 		/// </summary>
-		public bool InvisibleEmulation { get; set; }
+		public bool InvisibleEmulateNextFrame { get; set; }
+
+		private bool _invisibleEmulation;
 
 		private long MouseWheelTracker;
 
@@ -1170,7 +1176,7 @@ private void OnPauseToggle(bool newPauseState)
 
 		public bool IsSeeking => PauseOnFrame.HasValue;
 		private bool IsTurboSeeking => PauseOnFrame.HasValue && Config.TurboSeek;
-		public bool IsTurboing => InputManager.ClientControls["Turbo"] || IsTurboSeeking || InvisibleEmulation;
+		public bool IsTurboing => InputManager.ClientControls["Turbo"] || IsTurboSeeking || _invisibleEmulation;
 		public bool IsFastForwarding => InputManager.ClientControls["Fast Forward"] || IsTurboing;
 		public bool IsRewinding { get; private set; }
 
@@ -2976,11 +2982,11 @@ private void StepRunLoop_Core(bool force = false)
 
 			_runloopFrameAdvance = frameAdvance;
 
+			bool unpaused = !EmulatorPaused || _invisibleEmulation;
 #if BIZHAWKBUILD_SUPERHAWK
-			if (!EmulatorPaused && (!Config.SuperHawkThrottle || InputManager.ClientControls.AnyInputHeld))
-#else
-			if (!EmulatorPaused)
+			unpaused = unpaused && (!Config.SuperHawkThrottle || InputManager.ClientControls.AnyInputHeld);
 #endif
+			if (unpaused)
 			{
 				runFrame = true;
 			}
@@ -2994,15 +3000,20 @@ private void StepRunLoop_Core(bool force = false)
 			// BlockFrameAdvance (true when input it being editted in TAStudio) supercedes all other frame advance conditions
 			if ((runFrame || force) && !BlockFrameAdvance)
 			{
+				_invisibleEmulation = InvisibleEmulateNextFrame;
+
 				var isFastForwarding = IsFastForwarding;
 				var isFastForwardingOrRewinding = isFastForwarding || isRewinding || Config.Unthrottled;
 
-				if (isFastForwardingOrRewinding != _lastFastForwardingOrRewinding)
+				if (!_invisibleEmulation)
 				{
-					InitializeFpsData();
-				}
+					if (isFastForwardingOrRewinding != _lastFastForwardingOrRewinding)
+					{
+						InitializeFpsData();
+					}
 
-				_lastFastForwardingOrRewinding = isFastForwardingOrRewinding;
+					_lastFastForwardingOrRewinding = isFastForwardingOrRewinding;
+				}
 
 				// client input-related duties
 				OSD.ClearGuiText();
@@ -3022,13 +3033,13 @@ private void StepRunLoop_Core(bool force = false)
 					Tools.UpdateToolsBefore();
 				}
 
-				if (!InvisibleEmulation)
+				if (!_invisibleEmulation)
 				{
 					CaptureRewind(isRewinding);
 				}
 
 				// Set volume, if enabled
-				if (Config.SoundEnabledNormal && !InvisibleEmulation)
+				if (Config.SoundEnabledNormal && !_invisibleEmulation)
 				{
 					atten = Config.SoundVolume / 100.0f;
 
@@ -3073,7 +3084,7 @@ private void StepRunLoop_Core(bool force = false)
 				}
 
 				bool atTurboSeekEnd = IsTurboSeeking && Emulator.Frame == PauseOnFrame.Value - 1;
-				bool render = !InvisibleEmulation && (!_throttle.skipNextFrame || _currAviWriter?.UsesVideo is true || atTurboSeekEnd);
+				bool render = !_invisibleEmulation && (!_throttle.skipNextFrame || _currAviWriter?.UsesVideo is true || atTurboSeekEnd);
 				bool newFrame = Emulator.FrameAdvance(InputManager.ControllerOutput, render, renderSound);
 
 				MovieSession.HandleFrameAfter(ToolBypassingMovieEndAction is not null);
@@ -3114,12 +3125,12 @@ private void StepRunLoop_Core(bool force = false)
 					}
 				}
 
-				if (!PauseAvi && newFrame && !InvisibleEmulation)
+				if (!PauseAvi && newFrame && !_invisibleEmulation)
 				{
 					AvFrameAdvance();
 				}
 
-				if (newFrame)
+				if (newFrame && !_invisibleEmulation)
 				{
 					_framesSinceLastFpsUpdate++;
 

src/BizHawk.Client.EmuHawk/tools/BasicBot/BasicBot.cs

@@ -1047,8 +1047,8 @@ private void StartBot()
 
 			if (InvisibleEmulationCheckBox.Checked)
 			{
-				_previousInvisibleEmulation = MainForm.InvisibleEmulation;
-				MainForm.InvisibleEmulation = true;
+				_previousInvisibleEmulation = MainForm.InvisibleEmulateNextFrame;
+				MainForm.InvisibleEmulateNextFrame = true;
 			}
 
 			UpdateBotStatusIcon();
@@ -1103,7 +1103,7 @@ private void StopBot()
 		private void RestoreConfigFlags()
 		{
 			Config.DisplayMessages = _previousDisplayMessage;
-			MainForm.InvisibleEmulation = _previousInvisibleEmulation;
+			MainForm.InvisibleEmulateNextFrame = _previousInvisibleEmulation;
 			var movie = MovieSession.Movie;
 			if (movie.IsRecording()) movie.IsCountingRerecords = _oldCountingSetting;
 		}