implement a rudimentary multitrack recording feature

Author: SuuperW

src/BizHawk.Client.Common/inputAdapters/MultitrackAdapter.cs

@@ -0,0 +1,58 @@
+#nullable enable
+
+using System.Collections.Generic;
+using BizHawk.Emulation.Common;
+
+namespace BizHawk.Client.Common
+{
+	/// <summary>
+	/// Used to enable recording a subset of a controller's buttons, while keeping the existing inputs for the other buttons.
+	/// Also used to allow TAStudio to clear (or otherwise edit) a subset of input columns.
+	/// </summary>
+	internal class MultitrackAdapter : IController
+	{
+		/// <summary>
+		/// Input states in this definition will come from <see cref="ActiveSource"/>. All others will come from <see cref="BackingSource"/>.
+		/// </summary>
+		public ControllerDefinition ActiveDefinition { get; set; }
+
+		public IController ActiveSource { get; set; }
+
+		public IController BackingSource { get; set; }
+
+		public ControllerDefinition Definition => BackingSource.Definition;
+
+		public MultitrackAdapter(IController active, IController backing, ControllerDefinition activeDefinition)
+		{
+			ActiveSource = active;
+			BackingSource = backing;
+			ActiveDefinition = activeDefinition;
+		}
+
+		public bool IsPressed(string button)
+		{
+			if (ActiveDefinition.BoolButtons.Contains(button))
+			{
+				return ActiveSource.IsPressed(button);
+			}
+			else
+			{
+				return BackingSource.IsPressed(button);
+			}
+		}
+		public int AxisValue(string name)
+		{
+			if (ActiveDefinition.Axes.ContainsKey(name))
+			{
+				return ActiveSource.AxisValue(name);
+			}
+			else
+			{
+				return BackingSource.AxisValue(name);
+			}
+		}
+
+		public IReadOnlyCollection<(string Name, int Strength)> GetHapticsSnapshot() => throw new NotImplementedException(); // don't use this
+		public void SetHapticChannelStrength(string name, int strength) => throw new NotImplementedException(); // don't use this
+	}
+}

src/BizHawk.Client.Common/movie/bk2/Bk2Movie.cs

@@ -5,7 +5,16 @@ namespace BizHawk.Client.Common
 {
 	public partial class Bk2Movie : BasicMovieInfo, IMovie
 	{
-		private Bk2Controller _adapter;
+		private IController _defaultValueController;
+		protected IController DefaultValueController
+		{
+			get
+			{
+				// LogKey isn't available at construction time, so we have to create this instance when it is accessed.
+				_defaultValueController ??= new Bk2Controller(Session.MovieController.Definition, LogKey);
+				return _defaultValueController;
+			}
+		}
 
 		public Bk2Movie(IMovieSession session, string filename) : base(filename)
 		{
@@ -18,6 +27,17 @@ public virtual void Attach(IEmulator emulator)
 			Emulator = emulator;
 		}
 
+		private ControllerDefinition/*?*/ _activeControllerInputs = null;
+		public ControllerDefinition/*?*/ ActiveControllerInputs
+		{
+			get => _activeControllerInputs;
+			set
+			{
+				value?.AssertImmutable();
+				_activeControllerInputs = value;
+			}
+		}
+
 		protected bool IsAttached() => Emulator != null;
 
 		public IEmulator Emulator { get; private set; }
@@ -48,6 +68,11 @@ public void CopyLog(IEnumerable<string> log)
 
 		public void AppendFrame(IController source)
 		{
+			if (ActiveControllerInputs != null)
+			{
+				source = new MultitrackAdapter(source, new Bk2Controller(Session.MovieController.Definition, LogKey), ActiveControllerInputs);
+			}
+
 			Log.Add(Bk2LogEntryGenerator.GenerateLogEntry(source));
 			Changes = true;
 		}
@@ -62,15 +87,24 @@ public virtual void RecordFrame(int frame, IController source)
 				}
 			}
 
-			SetFrameAt(frame, Bk2LogEntryGenerator.GenerateLogEntry(source));
-
-			Changes = true;
+			PokeFrame(frame, source);
 		}
 
 		public virtual void Truncate(int frame)
 		{
 			if (frame < Log.Count)
 			{
+				if (ActiveControllerInputs != null)
+				{
+					for (int i = frame; i < Log.Count; i++)
+						PokeFrame(i, DefaultValueController);
+					string defaultEntry = Bk2LogEntryGenerator.EmptyEntry(DefaultValueController);
+					int firstDefault = Log.Count;
+					while (firstDefault > frame && Log[firstDefault - 1] == defaultEntry)
+						firstDefault--;
+					frame = firstDefault;
+				}
+
 				Log.RemoveRange(frame, Log.Count - frame);
 				Changes = true;
 			}
@@ -80,20 +114,28 @@ public IMovieController GetInputState(int frame)
 		{
 			if (frame < FrameCount && frame >= -1)
 			{
-				_adapter ??= new Bk2Controller(Session.MovieController.Definition, LogKey);
-				_adapter.SetFromMnemonic(frame >= 0 ? Log[frame] : Bk2LogEntryGenerator.EmptyEntry(_adapter));
-				return _adapter;
+				Bk2Controller controller = new(Session.MovieController.Definition, LogKey);
+				controller.SetFromMnemonic(frame >= 0 ? Log[frame] : Bk2LogEntryGenerator.EmptyEntry(controller));
+				return controller;
 			}
 
 			return null;
 		}
 
 		public virtual void PokeFrame(int frame, IController source)
 		{
+			if (ActiveControllerInputs != null)
+			{
+				source = new MultitrackAdapter(source, GetInputState(frame) ?? DefaultValueController, ActiveControllerInputs);
+			}
+
 			SetFrameAt(frame, Bk2LogEntryGenerator.GenerateLogEntry(source));
 			Changes = true;
 		}
 
+		/// <summary>
+		/// Does not use <see cref="ActiveControllerInputs"/>.
+		/// </summary>
 		protected void SetFrameAt(int frameNum, string frame)
 		{
 			if (Log.Count > frameNum)

src/BizHawk.Client.Common/movie/interfaces/IMovie.cs

@@ -33,6 +33,13 @@ public enum MovieMode
 	// TODO: consider other event handlers, switching modes?
 	public interface IMovie : IBasicMovieInfo
 	{
+		/// <summary>
+		/// When not null, methods that edit the movie will only affect buttons or axis values present in this definition,
+		/// with the exceoption of adding or removing default-value frames at the end of the movie.
+		/// The instance must be made immutable before assignment.
+		/// </summary>
+		ControllerDefinition/*?*/ ActiveControllerInputs { get; set; }
+
 		/// <summary>
 		/// Gets the current movie mode
 		/// </summary>
@@ -161,6 +168,7 @@ public interface IMovie : IBasicMovieInfo
 
 		/// <summary>
 		/// Instructs the movie to remove all input from its input log starting with the input at frame.
+		/// If <see cref="ActiveControllerInputs"/> is not null, this might not actually change the length of the movie.
 		/// </summary>
 		/// <param name="frame">The frame at which to truncate</param>
 		void Truncate(int frame);

src/BizHawk.Client.Common/movie/interfaces/ITasMovie.cs

@@ -55,11 +55,12 @@ public interface ITasMovie : IMovie, INotifyPropertyChanged, IDisposable
 
 		/// <summary>
 		/// Remove all frames between removeStart and removeUpTo (excluding removeUpTo).
+		/// If <see cref="IMovie.ActiveControllerInputs"/> is not null, this will not actually change the length of the movie.
 		/// </summary>
 		/// <param name="removeStart">The first frame to remove.</param>
 		/// <param name="removeUpTo">The frame after the last frame to remove.</param>
 		void RemoveFrames(int removeStart, int removeUpTo);
-		void SetFrame(int frame, string source);
+		void PokeFrame(int frame, string source);
 
 		void LoadBranch(TasBranch branch);
 

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

@@ -21,7 +21,7 @@ internal partial class TasMovie
 		public override void RecordFrame(int frame, IController source)
 		{
 			ChangeLog.AddGeneralUndo(frame, frame, $"Record Frame: {frame}");
-			SetFrameAt(frame, Bk2LogEntryGenerator.GenerateLogEntry(source));
+			base.PokeFrame(frame, source);
 			ChangeLog.SetGeneralRedo();
 
 			LagLog[frame] = _inputPollable.IsLagFrame;
@@ -32,7 +32,7 @@ public override void RecordFrame(int frame, IController source)
 
 		public override void Truncate(int frame)
 		{
-			if (frame >= Log.Count - 1) return;
+			if (frame >= Log.Count) return;
 
 			bool endBatch = ChangeLog.BeginNewBatch($"Truncate Movie: {frame}", true);
 
@@ -56,22 +56,17 @@ public override void PokeFrame(int frame, IController source)
 			InvalidateAfter(frame);
 		}
 
-		public void SetFrame(int frame, string source)
+		public void PokeFrame(int frame, string source)
 		{
-			ChangeLog.AddGeneralUndo(frame, frame, $"Set Frame At: {frame}");
-			SetFrameAt(frame, source);
-			ChangeLog.SetGeneralRedo();
-
-			InvalidateAfter(frame);
+			Bk2Controller controller = new(Session.MovieController.Definition, LogKey);
+			controller.SetFromMnemonic(source);
+			PokeFrame(frame, controller);
 		}
 
 		public void ClearFrame(int frame)
 		{
-			string empty = Bk2LogEntryGenerator.EmptyEntry(Session.MovieController);
-			if (GetInputLogEntry(frame) == empty) return;
-
 			ChangeLog.AddGeneralUndo(frame, frame, $"Clear Frame: {frame}");
-			SetFrameAt(frame, empty);
+			base.PokeFrame(frame, DefaultValueController);
 			ChangeLog.SetGeneralRedo();
 
 			InvalidateAfter(frame);
@@ -118,6 +113,7 @@ public void RemoveFrames(ICollection<int> frames)
 
 		public void RemoveFrames(int removeStart, int removeUpTo)
 		{
+			// TODO: column limiting
 			bool endBatch = ChangeLog.BeginNewBatch($"Remove frames {removeStart}-{removeUpTo - 1}", true);
 			if (BindMarkersToInput)
 			{
@@ -133,12 +129,22 @@ public void RemoveFrames(int removeStart, int removeUpTo)
 			// Log.GetRange() might be preferrable, but Log's type complicates that.
 			string[] removedInputs = new string[removeUpTo - removeStart];
 			Log.CopyTo(removeStart, removedInputs, 0, removedInputs.Length);
-			Log.RemoveRange(removeStart, removeUpTo - removeStart);
+
+			if (ActiveControllerInputs == null)
+			{
+				Log.RemoveRange(removeStart, removeUpTo - removeStart);
+			}
+			else
+			{
+				int count = removeUpTo - removeStart;
+				for (int i = removeStart; i < Log.Count; i++)
+					base.PokeFrame(i, GetInputState(i + count) ?? DefaultValueController);
+			}
 
 			ChangeLog.AddRemoveFrames(
 				removeStart,
-				removeUpTo,
 				removedInputs.ToList(),
+				ActiveControllerInputs,
 				BindMarkersToInput
 			);
 			if (endBatch) ChangeLog.EndBatch();
@@ -155,9 +161,29 @@ public void InsertInput(int frame, string inputState)
 		public void InsertInput(int frame, IEnumerable<string> inputLog)
 		{
 			var inputLogCopy = inputLog.ToList();
-			Log.InsertRange(frame, inputLogCopy);
+			if (ActiveControllerInputs == null)
+			{
+				Log.InsertRange(frame, inputLogCopy);
+			}
+			else
+			{
+				int count = inputLogCopy.Count;
+				// add empty frames at the end
+				Log.AddRange(Enumerable.Repeat(Bk2LogEntryGenerator.EmptyEntry(Session.MovieController), count));
+				// shift inputs to future frames
+				for (int i = Log.Count - 1; i >= frame + count; i--)
+					base.PokeFrame(i, GetInputState(i - count));
+				// write the new inputs
+				Bk2Controller controller = new(Session.MovieController.Definition, LogKey);
+				for (int i = 0; i < count; i++)
+				{
+					controller.SetFromMnemonic(inputLogCopy[i]);
+					base.PokeFrame(frame + i, controller);
+				}
+			}
+
 			ShiftBindedMarkers(frame, inputLogCopy.Count);
-			ChangeLog.AddInsertInput(frame, inputLogCopy, BindMarkersToInput, $"Insert {inputLogCopy.Count} frame(s) at {frame}");
+			ChangeLog.AddInsertInput(frame, inputLogCopy, ActiveControllerInputs, BindMarkersToInput, $"Insert {inputLogCopy.Count} frame(s) at {frame}");
 			InvalidateAfter(frame);
 		}
 
@@ -175,6 +201,7 @@ public void InsertInput(int frame, IEnumerable<IController> inputStates)
 
 		public void CopyOverInput(int frame, IEnumerable<IController> inputStates)
 		{
+			// TODO: column limiting
 			var states = inputStates.ToList();
 
 			bool endBatch = ChangeLog.BeginNewBatch($"Copy Over Input: {frame}", true);
@@ -187,7 +214,10 @@ public void CopyOverInput(int frame, IEnumerable<IController> inputStates)
 			ChangeLog.AddGeneralUndo(frame, frame + states.Count - 1, $"Copy Over Input: {frame}");
 			for (int i = 0; i < states.Count; i++)
 			{
-				Log[frame + i] = Bk2LogEntryGenerator.GenerateLogEntry(states[i]);
+				IController controller = states[i];
+				if (ActiveControllerInputs != null)
+					controller = new MultitrackAdapter(controller, GetInputState(frame + i), ActiveControllerInputs);
+				Log[frame + i] = Bk2LogEntryGenerator.GenerateLogEntry(controller);
 			}
 			int firstChangedFrame = ChangeLog.SetGeneralRedo();
 
@@ -203,9 +233,24 @@ public void InsertEmptyFrame(int frame, int count = 1)
 		{
 			frame = Math.Min(frame, Log.Count);
 
-			Log.InsertRange(frame, Enumerable.Repeat(Bk2LogEntryGenerator.EmptyEntry(Session.MovieController), count));
+			if (ActiveControllerInputs == null)
+			{
+				Log.InsertRange(frame, Enumerable.Repeat(Bk2LogEntryGenerator.EmptyEntry(Session.MovieController), count));
+			}
+			else
+			{
+				// add empty frames at the end
+				Log.AddRange(Enumerable.Repeat(Bk2LogEntryGenerator.EmptyEntry(Session.MovieController), count));
+				// shift inputs to future frames
+				for (int i = Log.Count - 1; i >= frame + count; i--)
+					base.PokeFrame(i, GetInputState(i - count));
+				// clear frames
+				for (int i = frame; i < frame + count; i++)
+					base.PokeFrame(i, DefaultValueController);
+			}
+
 			ShiftBindedMarkers(frame, count);
-			ChangeLog.AddInsertFrames(frame, count, BindMarkersToInput, $"Insert {count} empty frame(s) at {frame}");
+			ChangeLog.AddInsertFrames(frame, count, ActiveControllerInputs, BindMarkersToInput, $"Insert {count} empty frame(s) at {frame}");
 
 			InvalidateAfter(frame);
 		}
@@ -214,7 +259,6 @@ private void ExtendMovieForEdit(int numFrames)
 		{
 			int oldLength = InputLogLength;
 
-			// account for autohold TODO: What about auto-fire?
 			string inputs = Bk2LogEntryGenerator.GenerateLogEntry(Session.StickySource);
 			for (int i = 0; i < numFrames; i++)
 			{