make savestates on markers optional, per marker

Author: SuuperW

src/BizHawk.Client.Common/movie/tasproj/TasMovie.cs

@@ -326,7 +326,7 @@ public bool IsReserved(int frame)
 			// Why the frame before?
 			// because we always navigate to the frame before and emulate 1 frame so that we ensure a proper frame buffer on the screen
 			// users want instant navigation to markers, so to do this, we need to reserve the frame before the marker, not the marker itself
-			return Markers.Exists(m => m.Frame - 1 == frame)
+			return Markers.Exists(m => m.WantsState && m.Frame - 1 == frame)
 				|| Branches.Any(b => b.Frame == frame); // Branches should already be in the reserved list, but it doesn't hurt to check
 		}
 

src/BizHawk.Client.Common/movie/tasproj/TasMovieMarker.cs

@@ -26,14 +26,17 @@ public TasMovieMarker(string line)
 		{
 			var split = line.Split('\t');
 			Frame = int.Parse(split[0]);
-			Message = split[1];
+			WantsState = bool.Parse(split[1]);
+			Message = split[2];
 		}
 
 		public int Frame { get; private set; }
 
 		public string Message { get; set; }
 
-		public override string ToString() => Frame.ToString() + '\t' + Message;
+		public bool WantsState { get; set; } = true;
+
+		public override string ToString() => $"{Frame}\t{WantsState}\t{Message}";
 
 		public override int GetHashCode() => Frame.GetHashCode();
 

src/BizHawk.Client.EmuHawk/tools/TAStudio/MarkerControl.Designer.cs

@@ -1,15 +1,18 @@
-using System.ComponentModel;
+using System.ComponentModel;
 using System.Drawing;
 using System.Linq;
 using System.Windows.Forms;
 
 using BizHawk.Client.Common;
 using BizHawk.Client.EmuHawk.Properties;
+using BizHawk.Emulation.Common;
 
 namespace BizHawk.Client.EmuHawk
 {
 	public partial class MarkerControl : UserControl, IDialogParent
 	{
+		private static string SAVESTATE_COL_NAME = "Savestate";
+
 		public TAStudio Tastudio { get; set; }
 		public TasMovieMarkerList Markers => Tastudio.CurrentTasMovie.Markers;
 
@@ -50,6 +53,7 @@ private void SetupColumns()
 		{
 			MarkerView.AllColumns.Clear();
 			MarkerView.AllColumns.Add(new(name: "FrameColumn", widthUnscaled: 52, text: "Frame"));
+			MarkerView.AllColumns.Add(new(name: SAVESTATE_COL_NAME, widthUnscaled: 24, text: "State"));
 			MarkerView.AllColumns.Add(new(name: "LabelColumn", widthUnscaled: 125, text: string.Empty));
 		}
 
@@ -72,16 +76,16 @@ private void MarkerView_QueryItemBkColor(InputRoll sender, int index, RollColumn
 			}
 			else if (Tastudio.CurrentTasMovie.LagLog[marker.Frame + 1] is bool lagged)
 			{
-				if (lagged)
+				if (column.Name == "FrameColumn")
 				{
-					color = column.Name == "FrameColumn"
+					color = lagged
 						? Tastudio.Palette.LagZone_FrameCol
-						: Tastudio.Palette.LagZone_InputLog;
+						: Tastudio.Palette.GreenZone_FrameCol;
 				}
 				else
 				{
-					color = column.Name == "LabelColumn"
-						? Tastudio.Palette.GreenZone_FrameCol
+					color = lagged
+						? Tastudio.Palette.LagZone_InputLog
 						: Tastudio.Palette.GreenZone_InputLog;
 				}
 			}
@@ -97,13 +101,26 @@ private void MarkerView_QueryItemText(InputRoll sender, int index, RollColumn co
 				return;
 			}
 
+			TasMovieMarker marker = Markers[index];
 			if (column.Name == "FrameColumn")
 			{
-				text = Markers[index].Frame.ToString();
+				text = marker.Frame.ToString();
 			}
 			else if (column.Name == "LabelColumn")
 			{
-				text = Markers[index].Message;
+				text = marker.Message;
+			}
+			else if (column.Name == SAVESTATE_COL_NAME)
+			{
+				if (marker.WantsState)
+				{
+					bool hasState = marker.Frame == 0 || Tastudio.CurrentTasMovie.TasStateManager.HasState(marker.Frame - 1);
+					text = hasState ? "✔" : "!";
+				}
+				else
+				{
+					text = "";
+				}
 			}
 		}
 
@@ -188,6 +205,7 @@ public void AddMarker(int frame, bool editText = false)
 			{
 				marker = new TasMovieMarker(frame);
 			}
+			marker.WantsState = Tastudio.Settings.StatesForMarkers;
 
 			UpdateValues();
 			Markers.Add(marker);
@@ -285,5 +303,24 @@ private void MarkerView_MouseDoubleClick(object sender, EventArgs e)
 		{
 			if (MarkerView.AnyRowsSelected) Tastudio.GoToFrame(FirstSelectedMarker.Frame);
 		}
+
+		private void MarkerView_MouseDown(object sender, MouseEventArgs e)
+		{
+			Cell cell = MarkerView.CurrentCell;
+			if (cell == null || cell.RowIndex < 0 || cell.RowIndex >= Markers.Count) return;
+			if (cell.Column.Name != SAVESTATE_COL_NAME) return;
+
+			TasMovieMarker marker = Markers[cell.RowIndex.Value];
+			marker.WantsState = !marker.WantsState;
+			if (!marker.WantsState)
+			{
+				Tastudio.CurrentTasMovie.TasStateManager.Unreserve(marker.Frame - 1);
+			}
+			else if (Tastudio.Emulator.Frame == marker.Frame - 1)
+			{
+				Tastudio.CurrentTasMovie.TasStateManager.Capture(marker.Frame - 1, Tastudio.Emulator.AsStatable());
+			}
+			Tastudio.RefreshDialog();
+		}
 	}
 }

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

@@ -143,6 +143,7 @@ public TAStudioSettings()
 			public int RewindStep { get; set; } = 1;
 			public int RewindStepFast { get; set; } = 4;
 			public bool ScrollSync { get; set; } = true;
+			public bool StatesForMarkers { get; set; } = true;
 			public PatternPaintModeEnum PatternPaintMode { get; set; } = TAStudioSettings.PatternPaintModeEnum.Never;
 			public PatternSelectionEnum PatternSelection { get; set; } = TAStudioSettings.PatternSelectionEnum.Hold;
 			public Font TasViewFont { get; set; } = new Font("Arial", 8.25F, FontStyle.Bold, GraphicsUnit.Point, 0);

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

@@ -101,6 +101,7 @@ private void TAStudioSettingsForm_Load(object sender, EventArgs e)
 			RewindNum.Value = _settings.GeneralClientSettings.RewindStep;
 			FastRewindNum.Value = _settings.GeneralClientSettings.RewindStepFast;
 			ScrollSpeedNum.Value = _settings.GeneralClientSettings.ScrollSpeed;
+			StatesForMarkersCheckbox.Checked = _settings.GeneralClientSettings.StatesForMarkers;
 
 			// patterns
 			foreach (var button in _controllerDef.BoolButtons)
@@ -502,6 +503,7 @@ private void ApplyButton_Click(object sender, EventArgs e)
 			_settings.GeneralClientSettings.MaxUndoSteps = (int)UndoCountNum.Value;
 			_settings.GeneralClientSettings.RewindStep = (int)RewindNum.Value;
 			_settings.GeneralClientSettings.RewindStepFast = (int)FastRewindNum.Value;
+			_settings.GeneralClientSettings.StatesForMarkers = StatesForMarkersCheckbox.Checked;
 
 			if (ScrollToViewRadio.Checked) _settings.GeneralClientSettings.FollowCursorScrollMethod = "near";
 			else if (ScrollToTopRadio.Checked) _settings.GeneralClientSettings.FollowCursorScrollMethod = "top";

src/BizHawk.Client.EmuHawk/tools/TAStudio/TAStudioSettingsForm.Designer.cs

@@ -124,6 +124,13 @@ And when "Recording mode" is on, the movie will be truncated at the branch frame
   <metadata name="toolTip1.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
     <value>17, 17</value>
   </metadata>
+  <data name="StatesForMarkersCheckbox.ToolTip" xml:space="preserve">
+    <value>TAStudio can automatically keep savestates for each marker.
+If this is enabled, new markers will have savestates enabled by default.
+Note: The savestate needs to be on the frame before the marker, so TAStudio
+can run 1 frame after loading the state to get a video frame. Thus, making a
+marker on the current frame will not automatically create a state.</value>
+  </data>
   <data name="EditInvisibleColumnsCheckbox.ToolTip" xml:space="preserve">
     <value>When disabled, inputs that are not visible on the active input roll cannot be edited.
 This allows you to, for example, insert and delete frames on a roll with player 1's inputs