Block more stuffs during invisible emulation, especially to make it work better with TAStudio.

Author: SuuperW

Assets/Lua/GBA/SonicAdvance_CamHack.lua

@@ -6,25 +6,6 @@ local addr_offY = 0x5B98
 local addr_camX = 0x59D0
 local addr_camY = 0x59D2
 
--- Seek forward to a given frame.
--- This will unpause emulation, and restore the users' desired pause state when seeking is completed.
-local function seek_frame(frame)
-	local pause = client.unpause()
-	while emu.framecount() < frame do
-		-- The user may pause mid-seek, perhaps even by accident.
-		-- In this case, we will unpause but remember that the user wants to pause at the end.
-		if client.ispaused() then
-			pause = true
-			client.unpause()
-		end
-		-- Yield, not frameadvance. With frameadvance we cannot detect pauses, since frameadvance would not return.
-		-- This is true even if we have just called client.unpause.
-		emu.yield()
-	end
-	
-	if pause then client.pause() end
-end
-
 event.onexit(function() client.invisibleemulation(false) end)
 
 while true do
@@ -42,9 +23,9 @@ while true do
 	mainmemory.write_u16_le(addr_camX, Xval)
 	mainmemory.write_u16_le(addr_camY, Yval)
 
-	seek_frame(emu.framecount()+1)
+	emu.frameadvance()
 	client.invisibleemulation(false)
-	seek_frame(emu.framecount()+1)
+	emu.frameadvance()
 	client.invisibleemulation(true)
 	memorysavestate.loadcorestate(memorystate)
 	memorysavestate.removestate(memorystate)

Assets/Lua/seek.lua

@@ -0,0 +1,26 @@
+-- Seek forward to a given frame.
+-- This will unpause emulation, and restore the users' desired pause state when seeking is completed.
+-- Note that this may interfere with TAStudio's seeking behavior.
+local function force_seek_frame(frame)
+	local pause = client.unpause()
+	while emu.framecount() < frame do
+		-- The user may pause mid-seek, perhaps even by accident.
+		-- In this case, we will unpause but remember that the user wants to pause at the end.
+		if client.ispaused() then
+			pause = true
+			client.unpause()
+		end
+		-- Yield, not frameadvance. With frameadvance we cannot detect pauses, since frameadvance would not return.
+		-- This is true even if we have just called client.unpause.
+		emu.yield()
+	end
+	
+	if pause then client.pause() end
+end
+
+-- Seek but without touching the pause state. Function will not return if the given frame is never reached due to the user manaully pausing/rewinding.
+local function seek_frame(frame)
+	while emu.framecount() < frame do
+		emu.frameadvance()
+	end
+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.InvisibleEmulateNextFrame = invisible;
+		public void InvisibleEmulation(bool invisible) => _mainForm.InvisibleEmulation = 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 InvisibleEmulateNextFrame { get; set; }
+		bool InvisibleEmulation { 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 InvisibleEmulateNextFrame { get; set; }
+		bool InvisibleEmulation { get; set; }
 
 		/// <remarks>only referenced from <see cref="TAStudio"/></remarks>
 		bool IsFastForwarding { get; }

src/BizHawk.Client.EmuHawk/MainForm.cs

@@ -1149,9 +1149,11 @@ private void OnPauseToggle(bool newPauseState)
 		/// <item><description><see cref="ClientLuaLibrary.InvisibleEmulation(bool)"/></description></item>
 		/// </list>
 		/// </summary>
-		public bool InvisibleEmulateNextFrame { get; set; }
+		public bool InvisibleEmulation { get => _invisibleUpdate; set => _invisibleEmulateNextFrame = value; }
 
+		private bool _invisibleEmulateNextFrame;
 		private bool _invisibleEmulation;
+		private bool _invisibleUpdate;
 
 		private long MouseWheelTracker;
 
@@ -1176,7 +1178,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 || _invisibleUpdate;
 		public bool IsFastForwarding => InputManager.ClientControls["Fast Forward"] || IsTurboing;
 		public bool IsRewinding { get; private set; }
 
@@ -3000,7 +3002,7 @@ 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;
+				_invisibleEmulation = _invisibleEmulateNextFrame;
 
 				var isFastForwarding = IsFastForwarding;
 				var isFastForwardingOrRewinding = isFastForwarding || isRewinding || Config.Unthrottled;
@@ -3066,7 +3068,7 @@ private void StepRunLoop_Core(bool force = false)
 
 				RA?.OnFrameAdvance();
 
-				if (Config.AutosaveSaveRAM)
+				if (Config.AutosaveSaveRAM && !_invisibleEmulation)
 				{
 					AutoFlushSaveRamIn--;
 					if (AutoFlushSaveRamIn <= 0)
@@ -3087,7 +3089,7 @@ private void StepRunLoop_Core(bool force = false)
 				bool render = !_invisibleEmulation && (!_throttle.skipNextFrame || _currAviWriter?.UsesVideo is true || atTurboSeekEnd);
 				bool newFrame = Emulator.FrameAdvance(InputManager.ControllerOutput, render, renderSound);
 
-				MovieSession.HandleFrameAfter(ToolBypassingMovieEndAction is not null);
+				if (!_invisibleUpdate) MovieSession.HandleFrameAfter(ToolBypassingMovieEndAction is not null);
 
 				if (returnToRecording)
 				{
@@ -3124,6 +3126,7 @@ private void StepRunLoop_Core(bool force = false)
 						UpdateToolsAfter();
 					}
 				}
+				_invisibleUpdate = _invisibleEmulation;
 
 				if (!PauseAvi && newFrame && !_invisibleEmulation)
 				{
@@ -4411,6 +4414,8 @@ private bool Rewind(ref bool runFrame, long currentTimestamp, out bool returnToR
 
 			returnToRecording = false;
 
+			if (_invisibleEmulation) return false;
+
 			if (ToolControllingRewind is { } rewindTool)
 			{
 				if (InputManager.ClientControls["Rewind"] || PressRewind)

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

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

src/BizHawk.Client.EmuHawk/tools/TAStudio/TAStudio.IToolForm.cs

@@ -71,7 +71,7 @@ protected override void GeneralUpdate()
 
 		protected override void UpdateAfter()
 		{
-			if (!IsHandleCreated || IsDisposed || CurrentTasMovie == null)
+			if (!IsHandleCreated || IsDisposed || CurrentTasMovie == null || MainForm.InvisibleEmulation)
 			{
 				return;
 			}
@@ -109,6 +109,8 @@ protected override void UpdateAfter()
 
 		protected override void FastUpdateAfter()
 		{
+			if (MainForm.InvisibleEmulation) return;
+
 			if (_seekingTo != -1 && Emulator.Frame >= _seekingTo)
 			{
 				bool smga = _shouldMoveGreenArrow;