movie input refactoring

BizHawk.MultiClient/BizHawk.MultiClient.csproj

@@ -179,6 +179,7 @@
     <Compile Include="movie\MovieConvert.cs" />
     <Compile Include="movie\MovieHeader.cs" />
     <Compile Include="movie\MovieLog.cs" />
+    <Compile Include="movie\MovieSession.cs" />
     <Compile Include="movie\MultitrackRecording.cs" />
     <Compile Include="movie\Subtitle.cs" />
     <Compile Include="movie\SubtitleList.cs" />

BizHawk.MultiClient/Global.cs

@@ -22,22 +22,29 @@ namespace BizHawk.MultiClient
 		public static Controller GBControls;
 		public static Controller NullControls;
 
-		//TODO should have one of these per movie!!!! should not be global.
+		//the movie will be spliced inbetween these if it is present
-		public static MovieControllerAdapter MovieControllerAdapter = new MovieControllerAdapter();
 		public static CopyControllerAdapter MovieInputSourceAdapter = new CopyControllerAdapter();
+		public static CopyControllerAdapter MovieOutputAdapter = new CopyControllerAdapter();
 
+		/// <summary>
+		/// the global MovieSession can use this to deal with multitrack player remapping (should this be here? maybe it should be in MovieSession)
+		/// </summary>
 		public static MultitrackRewiringControllerAdapter MultitrackRewiringControllerAdapter = new MultitrackRewiringControllerAdapter();
 
+
+		public static MovieSession MovieSession = new MovieSession();
+
+
 		//dont take my word for it, since the final word is actually in RewireInputChain, but here is a guide...
 		//user -> Input -> ActiveController -> UDLR -> StickyXORPlayerInputAdapter -> TurboAdapter(TBD) -> Lua(?TBD?) -> ..
-		//.. -> MultitrackRewiringControllerAdapter -> MovieInputSourceAdapter -> MovieInputController -> ControllerOutput(1) -> Game
+		//.. -> MultitrackRewiringControllerAdapter -> MovieInputSourceAdapter -> (MovieSession) -> MovieOutputAdapter -> ControllerOutput(1) -> Game
 		//(1)->Input Display
 		
 		//the original source controller, bound to the user, sort of the "input" port for the chain, i think
 		public static Controller ActiveController;
 		
 		//the "output" port for the controller chain. 
-		public static IController ControllerOutput;
+		public static CopyControllerAdapter ControllerOutput = new CopyControllerAdapter();
 
 		//input state which has been destined for game controller inputs are coalesced here
 		public static InputCoalescer ControllerInputCoalescer = new InputCoalescer();
@@ -56,6 +63,8 @@ namespace BizHawk.MultiClient
 		/// </summary>
 		public static ClickyVirtualPadController ClickyVirtualPadController = new ClickyVirtualPadController();
 
+		public static SimpleController MovieOutputController = new SimpleController();
+
 		public static Controller ClientControls;
 
 		public static string GetOutputControllersAsMnemonic()
@@ -68,6 +77,8 @@ namespace BizHawk.MultiClient
 		//TODO - wtf is this being used for
 		public static bool MovieMode;
 
+
+
 		public static CoreAccessor PsxCoreLibrary = new CoreAccessor(new Win32LibAccessor("PsxHawk.Core.dll"));
 
 	}

BizHawk.MultiClient/Input/Input.cs

@@ -164,7 +164,14 @@ namespace BizHawk.MultiClient
 		ModifierKey _Modifiers;
 		List<InputEvent> _NewEvents = new List<InputEvent>();
 
-		//TODO - maybe need clearevents for various purposes. perhaps when returning from modal dialogs?
+		//do we need this?
+		public void ClearEvents()
+		{
+			lock (this)
+			{
+				InputEvents.Clear();
+			}
+		}
 
 		Queue<InputEvent> InputEvents = new Queue<InputEvent>();
 		public InputEvent DequeueEvent()
@@ -211,7 +218,7 @@ namespace BizHawk.MultiClient
 						HandleButton(jname + "B" + (b + 1), pad.Buttons[b]);
 				}
 
-				bool swallow = (Global.Config.AcceptBackgroundInput == false && Form.ActiveForm == null);
+				bool swallow = !Global.MainForm.AllowInput;
 
 				foreach (var ie in _NewEvents)
 				{

BizHawk.MultiClient/MainForm.Movie.cs

@@ -15,8 +15,11 @@ namespace BizHawk.MultiClient
 
 		public void StartNewMovie(Movie m, bool record)
 		{
+			Global.MovieSession = new MovieSession();
+			Global.MovieSession.Movie = m;
+			UserMovie = m; //TODO - maybe get rid of UserMovie?
+			RewireInputChain();
 
-			UserMovie = m;
 			LoadRom(Global.MainForm.CurrentlyOpenRom);
 			UserMovie.LoadMovie();
 			Global.Config.RecentMovies.Add(m.Filename);

BizHawk.MultiClient/MainForm.cs

@@ -791,9 +791,16 @@ namespace BizHawk.MultiClient
 
 			Global.MultitrackRewiringControllerAdapter.Source = Global.StickyXORAdapter;
 			Global.MovieInputSourceAdapter.Source = Global.MultitrackRewiringControllerAdapter;
-			Global.MovieControllerAdapter.SetSource(Global.MovieInputSourceAdapter);
+			Global.ControllerOutput.Source = Global.MovieOutputAdapter;
-			Global.ControllerOutput = Global.MovieControllerAdapter;
 			Global.Emulator.Controller = Global.ControllerOutput;
+
+			Global.MovieSession.MovieControllerAdapter.Type = Global.MovieInputSourceAdapter.Type;
+
+			//splice the movie session before MovieOutputAdapter if it is doing anything
+			if (Global.MovieSession.Movie != null)
+				Global.MovieOutputAdapter.Source = Global.MovieSession.MovieControllerAdapter;
+			else
+				Global.MovieOutputAdapter.Source = Global.MovieInputSourceAdapter;
 		}
 
 		public bool LoadRom(string path)
@@ -1039,6 +1046,27 @@ namespace BizHawk.MultiClient
 			UpdateStatusSlots(); 
 		}
 
+		/// <summary>
+		/// Controls whether the app generates input events. should be turned off for most modal dialogs
+		/// </summary>
+		public bool AllowInput
+		{
+			get
+			{
+				//the main form gets input
+				if (Form.ActiveForm == this) return true;
+				
+				//modals that need to capture input for binding purposes get input, of course
+				if (Form.ActiveForm is InputConfig) return true;
+				if (Form.ActiveForm is tools.HotkeyWindow) return true;
+				
+				//if no form is active on this process, then the background input setting applies
+				if (Form.ActiveForm == null && Global.Config.AcceptBackgroundInput) return true;
+
+				return false;
+			}
+		}
+
 		public void ProcessInput()
 		{
 			for(;;)
@@ -1093,6 +1121,7 @@ namespace BizHawk.MultiClient
 				bool handled = false;
 				if (ie.EventType == Input.InputEventType.Press)
 				{
+					Console.WriteLine(ie);
 					foreach (var trigger in triggers)
 					{
 						handled |= CheckHotkey(trigger);
@@ -1244,52 +1273,52 @@ namespace BizHawk.MultiClient
 
 				case "Toggle MultiTrack":
 					{
-						Global.MainForm.UserMovie.MultiTrack.IsActive = !Global.MainForm.UserMovie.MultiTrack.IsActive;
+						Global.MovieSession.MultiTrack.IsActive = !Global.MovieSession.MultiTrack.IsActive;
-						if (Global.MainForm.UserMovie.MultiTrack.IsActive)
+						if (Global.MovieSession.MultiTrack.IsActive)
 						{
 							Global.RenderPanel.AddMessage("MultiTrack Enabled");
 							Global.RenderPanel.MT = "Recording None";
 						}
 						else
 						Global.RenderPanel.AddMessage("MultiTrack Disabled");
-						Global.MainForm.UserMovie.MultiTrack.RecordAll = false;
+						Global.MovieSession.MultiTrack.RecordAll = false;
-						Global.MainForm.UserMovie.MultiTrack.CurrentPlayer = 0;
+						Global.MovieSession.MultiTrack.CurrentPlayer = 0;
 						break;
 					}
 				case "Increment Player":
 					{
-						Global.MainForm.UserMovie.MultiTrack.CurrentPlayer++;
+						Global.MovieSession.MultiTrack.CurrentPlayer++;
-						Global.MainForm.UserMovie.MultiTrack.RecordAll = false;
+						Global.MovieSession.MultiTrack.RecordAll = false;
-						if (Global.MainForm.UserMovie.MultiTrack.CurrentPlayer > 5) //TODO: Replace with console's maximum or current maximum players??!
+						if (Global.MovieSession.MultiTrack.CurrentPlayer > 5) //TODO: Replace with console's maximum or current maximum players??!
 						{
-							Global.MainForm.UserMovie.MultiTrack.CurrentPlayer = 1;
+							Global.MovieSession.MultiTrack.CurrentPlayer = 1;
 						}
-						Global.RenderPanel.MT = "Recording Player " + Global.MainForm.UserMovie.MultiTrack.CurrentPlayer.ToString();  
+						Global.RenderPanel.MT = "Recording Player " + Global.MovieSession.MultiTrack.CurrentPlayer.ToString();  
 						break;
 					}
 
 				case "Decrement Player":
 					{
-						Global.MainForm.UserMovie.MultiTrack.CurrentPlayer--;
+						Global.MovieSession.MultiTrack.CurrentPlayer--;
-						Global.MainForm.UserMovie.MultiTrack.RecordAll = false;
+						Global.MovieSession.MultiTrack.RecordAll = false;
-						if (Global.MainForm.UserMovie.MultiTrack.CurrentPlayer < 1) 
+						if (Global.MovieSession.MultiTrack.CurrentPlayer < 1) 
 						{
-							Global.MainForm.UserMovie.MultiTrack.CurrentPlayer = 5;//TODO: Replace with console's maximum or current maximum players??! 
+							Global.MovieSession.MultiTrack.CurrentPlayer = 5;//TODO: Replace with console's maximum or current maximum players??! 
 						}
-						Global.RenderPanel.MT = "Recording Player " + Global.MainForm.UserMovie.MultiTrack.CurrentPlayer.ToString();  
+						Global.RenderPanel.MT = "Recording Player " + Global.MovieSession.MultiTrack.CurrentPlayer.ToString();  
 						break;
 					}
 				case "Record All":
 					{
-						Global.MainForm.UserMovie.MultiTrack.CurrentPlayer = 0;
+						Global.MovieSession.MultiTrack.CurrentPlayer = 0;
-						Global.MainForm.UserMovie.MultiTrack.RecordAll = true;
+						Global.MovieSession.MultiTrack.RecordAll = true;
 						Global.RenderPanel.MT = "Recording All";
 						break;
 					}
 				case "Record None":
 					{
-						Global.MainForm.UserMovie.MultiTrack.CurrentPlayer = 0;
+						Global.MovieSession.MultiTrack.CurrentPlayer = 0;
-						Global.MainForm.UserMovie.MultiTrack.RecordAll = false;
+						Global.MovieSession.MultiTrack.RecordAll = false;
 						Global.RenderPanel.MT = "Recording None"; 
 						break;
 					}
@@ -1312,6 +1341,7 @@ namespace BizHawk.MultiClient
 			throttle.Step(true, -1);
 		}
 
+	
 		void StepRunLoop_Core()
 		{
 			bool runFrame = false;
@@ -1407,27 +1437,35 @@ namespace BizHawk.MultiClient
 				else if (!Global.Config.MuteFrameAdvance)
 					genSound = true;
 
+				MovieSession session = Global.MovieSession;
+
+				if (UserMovie.Mode == MOVIEMODE.FINISHED)
+				{
+					//todo - a better way of ending
+					StopMovie();
+				}
+
 				if (UserMovie.Mode != MOVIEMODE.INACTIVE)
 				{
-					UserMovie.LatchInputFromLog();
+					session.LatchInputFromLog();
 				}
 
 				if (UserMovie.Mode == MOVIEMODE.RECORD)
 				{
-					if (UserMovie.MultiTrack.IsActive)
+					if (session.MultiTrack.IsActive)
 					{
-						UserMovie.LatchMultitrackPlayerInput();
+						session.LatchMultitrackPlayerInput(Global.MovieInputSourceAdapter, Global.MultitrackRewiringControllerAdapter);
 					}
 					else
 					{
-						UserMovie.LatchInputFromPlayer();
+						session.LatchInputFromPlayer(Global.MovieInputSourceAdapter);
 					}
-					UserMovie.CommitFrame();
+					session.Movie.CommitFrame(Global.Emulator.Frame, Global.MovieInputSourceAdapter);
 				}
 
 				if (UserMovie.Mode == MOVIEMODE.INACTIVE)
 				{
-					UserMovie.LatchInputFromPlayer();
+					session.LatchInputFromPlayer(Global.MovieInputSourceAdapter);
 				}
 				
 				if (UserMovie.Mode == MOVIEMODE.PLAY)
@@ -1439,22 +1477,22 @@ namespace BizHawk.MultiClient
 					}
 				}
 
-				if (UserMovie.Mode == MOVIEMODE.FINISHED)
-				{
-					if (UserMovie.Length() > Global.Emulator.Frame)
-					{
-						UserMovie.StartPlayback();
-						Global.MovieControllerAdapter.SetControllersAsMnemonic(UserMovie.GetInputFrame(Global.Emulator.Frame));
-					}
-				}
-				if (UserMovie.Mode == MOVIEMODE.RECORD && UserMovie.MultiTrack.IsActive)
-				{					
-					Global.MovieControllerAdapter.SetControllersAsMnemonic(UserMovie.GetInputFrame(Global.Emulator.Frame-1));
-					Console.WriteLine("Out: " + UserMovie.GetInputFrame(Global.Emulator.Frame));
-				}
 
-				//TODO multitrack
+				//TODO ZERO - I DONT LIKE THIS. INSPECT IT LATER.
 
+				//if (UserMovie.Mode == MOVIEMODE.FINISHED)
+				//{
+				//    if (UserMovie.Length() > Global.Emulator.Frame)
+				//    {
+				//        UserMovie.StartPlayback();
+				//        Global.MovieSession.MovieControllerAdapter.SetControllersAsMnemonic(UserMovie.GetInputFrame(Global.Emulator.Frame));
+				//    }
+				//}
+				//if (UserMovie.Mode == MOVIEMODE.RECORD && Global.MovieSession.MultiTrack.IsActive)
+				//{					
+				//    Global.MovieSession.MovieControllerAdapter.SetControllersAsMnemonic(UserMovie.GetInputFrame(Global.Emulator.Frame-1));
+				//    Console.WriteLine("Out: " + UserMovie.GetInputFrame(Global.Emulator.Frame));
+				//}
 
 				//=======================================
 				Global.Emulator.FrameAdvance(!throttle.skipnextframe);
@@ -1611,7 +1649,8 @@ namespace BizHawk.MultiClient
 				}
 				else
 				{
-					UserMovie.StartNewRecording();
+					//QUESTIONABLE - control whether the movie gets truncated here?
+					UserMovie.StartNewRecording(!Global.MovieSession.MultiTrack.IsActive);
 					SetMainformMovieInfo();
 					Global.MovieMode = false;
 					UserMovie.LoadLogFromSavestateText(reader);

BizHawk.MultiClient/RenderPanel.cs

@@ -351,7 +351,7 @@ namespace BizHawk.MultiClient
 				MessageFont.DrawString(null, input, x + 1, y + 1, Color.Black);
 				MessageFont.DrawString(null, input, x, y, c);
 			}
-			if (Global.MainForm.UserMovie.MultiTrack.IsActive)
+			if (Global.MovieSession.MultiTrack.IsActive)
 			{
 				MessageFont.DrawString(null, MT, Global.Config.DispFPSx + 1, //TODO: Multitrack position variables
 				   Global.Config.DispFPSy + 1, new Color4(Color.Black));

BizHawk.MultiClient/movie/InputAdapters.cs

@@ -384,23 +384,15 @@ namespace BizHawk.MultiClient
 			//OutputController = new ForceControllerAdapter();
 		}
 
-		IController Source;
-
-		public void SetSource(IController source)
-		{
-			//OutputController.Controller = source;
-			Source = source;
-		}
-
 		//IController implementation:
-		public ControllerDefinition Type { get { return Source.Type; } }
+		public ControllerDefinition Type { get; set; }
 		public bool this[string button] { get { return MyBoolButtons[button]; } }
 		public bool IsPressed(string button) { return MyBoolButtons[button]; }
-		public float GetFloat(string name) { return Source.GetFloat(name); }
+		public float GetFloat(string name) { return 0; }
-		public void UpdateControls(int frame) { Source.UpdateControls(frame); }
+		public void UpdateControls(int frame) {  }
 		//--------
 
-		Dictionary<string, bool> MyBoolButtons = new Dictionary<string, bool>();
+		WorkingDictionary<string, bool> MyBoolButtons = new WorkingDictionary<string, bool>();
 
 		void Force(string button, bool state)	
 		{
@@ -426,29 +418,31 @@ namespace BizHawk.MultiClient
 		/// <summary>
 		/// latches one player from the source
 		/// </summary>
-		public void LatchPlayerFromSource(int playerNum)
+		public void LatchPlayerFromSource(IController playerSource, int playerNum)
 		{
-			foreach (string button in Source.Type.BoolButtons)
+			foreach (string button in playerSource.Type.BoolButtons)
 			{
 				ButtonNameParser bnp = ButtonNameParser.Parse(button);
 				if (bnp == null) continue;
 				if (bnp.PlayerNum != playerNum) continue;
-				bool val = Source[button];
+				bool val = playerSource[button];
 				MyBoolButtons[button] = val;
 			}
 		}
 
+
 		/// <summary>
-		/// latches all buttons from the upstream source
+		/// latches all buttons from the provided source
 		/// </summary>
-		public void LatchFromSource()
+		public void LatchFromSource(IController source)
 		{
 			foreach (string button in Type.BoolButtons)
 			{
-				MyBoolButtons[button] = Source[button];
+				MyBoolButtons[button] = source[button];
 			}
 		}
 
+
 		/// <summary>
 		/// latches all buttons from the supplied mnemonic string
 		/// </summary>

BizHawk.MultiClient/movie/Movie.cs

@@ -14,7 +14,6 @@ namespace BizHawk.MultiClient
 
 		public MovieHeader Header = new MovieHeader();
 		public SubtitleList Subtitles = new SubtitleList();
-		public MultitrackRecording MultiTrack = new MultitrackRecording();
 		public bool MakeBackup = true; //make backup before altering movie
 
 		public bool IsText { get; private set; }
@@ -91,7 +90,8 @@ namespace BizHawk.MultiClient
 			Mode = MOVIEMODE.INACTIVE;
 		}
 
-		public void StartNewRecording()
+		public void StartNewRecording() { StartNewRecording(true); }
+		public void StartNewRecording(bool truncate)
 		{
 			Mode = MOVIEMODE.RECORD;
 			if (Global.Config.EnableBackupMovies && MakeBackup && Log.Length() > 0)
@@ -99,7 +99,7 @@ namespace BizHawk.MultiClient
 				WriteBackup();
 				MakeBackup = false;
 			}
-			Log.Clear();
+			if(truncate) Log.Clear();
 		}
 
 		public void StartPlayback()
@@ -107,55 +107,21 @@ namespace BizHawk.MultiClient
 			Mode = MOVIEMODE.PLAY;
 		}
 
-		public void LatchMultitrackPlayerInput()
+		public void CommitFrame(int frameNum, IController source)
 		{
-			if (MultiTrack.IsActive)
+			//if (Global.Emulator.Frame < Log.Length())
-			{
-				Global.MultitrackRewiringControllerAdapter.PlayerSource = 1;
-				Global.MultitrackRewiringControllerAdapter.PlayerTargetMask = 1 << (MultiTrack.CurrentPlayer);
-				if (MultiTrack.RecordAll) Global.MultitrackRewiringControllerAdapter.PlayerTargetMask = unchecked((int)0xFFFFFFFF);
-			}
-			else Global.MultitrackRewiringControllerAdapter.PlayerSource = -1;
-
-			if (MultiTrack.RecordAll)
-				Global.MovieControllerAdapter.LatchFromSource();
-			else
-				Global.MovieControllerAdapter.LatchPlayerFromSource(MultiTrack.CurrentPlayer);
-		}
-
-		public void LatchInputFromPlayer()
-		{
-			Global.MovieControllerAdapter.LatchFromSource();
-		}
-
-		/// <summary>
-		/// latch input from the log, if available
-		/// </summary>
-		public void LatchInputFromLog()
-		{
-			string loggedFrame = GetInputFrame(Global.Emulator.Frame);
-			if(loggedFrame != "")
-				Global.MovieControllerAdapter.SetControllersAsMnemonic(loggedFrame);
-		}
-
-		public void CommitFrame()
-		{
-			//if (MultiTrack.IsActive)
 			//{
-			//}
-			//else
-			//    if (Global.Emulator.Frame < Log.Length())
-			//    {
 			//    Log.Truncate(Global.Emulator.Frame);
-			//    }
+			//}
 
 			//Note: Truncation here instead of loadstate will make VBA style loadstates
 			//(Where an entire movie is loaded then truncated on the next frame
 			//this allows users to restore a movie with any savestate from that "timeline"
 
 			MnemonicsGenerator mg = new MnemonicsGenerator();
-			mg.SetSource(Global.MovieInputSourceAdapter);
+			
-			Log.SetFrameAt(Global.Emulator.Frame, mg.GetControllersAsMnemonic());
+			mg.SetSource(source);
+			Log.SetFrameAt(frameNum, mg.GetControllersAsMnemonic());
 		}
 
 		public string GetInputFrame(int frame)
@@ -420,7 +386,7 @@ namespace BizHawk.MultiClient
 		public void LoadLogFromSavestateText(TextReader reader)
 		{
 			//We are in record mode so replace the movie log with the one from the savestate
-			if (!MultiTrack.IsActive)
+			if (!Global.MovieSession.MultiTrack.IsActive)
 			{
 				if (Global.Config.EnableBackupMovies && MakeBackup && Log.Length() > 0)
 				{

BizHawk.MultiClient/movie/MovieSession.cs

@@ -0,0 +1,54 @@
+using System;
+using System.Text;
+using System.Threading;
+using System.Drawing;
+using System.Drawing.Imaging;
+using System.IO;
+using System.Runtime.InteropServices;
+using System.Windows.Forms;
+using BizHawk.Core;
+using BizHawk.Emulation.Consoles.Sega;
+using BizHawk.Emulation.Consoles.TurboGrafx;
+using BizHawk.Emulation.Consoles.Calculator;
+using BizHawk.Emulation.Consoles.Gameboy;
+using BizHawk.Emulation.Consoles.Nintendo;
+
+namespace BizHawk.MultiClient
+{
+
+	public class MovieSession
+	{
+		public MultitrackRecording MultiTrack = new MultitrackRecording();
+		public Movie Movie;
+		public MovieControllerAdapter MovieControllerAdapter = new MovieControllerAdapter();
+
+		public void LatchMultitrackPlayerInput(IController playerSource, MultitrackRewiringControllerAdapter rewiredSource)
+		{
+			if (MultiTrack.IsActive)
+			{
+				rewiredSource.PlayerSource = 1;
+				rewiredSource.PlayerTargetMask = 1 << (MultiTrack.CurrentPlayer);
+				if (MultiTrack.RecordAll) rewiredSource.PlayerTargetMask = unchecked((int)0xFFFFFFFF);
+			}
+			else rewiredSource.PlayerSource = -1;
+
+			MovieControllerAdapter.LatchPlayerFromSource(rewiredSource, MultiTrack.CurrentPlayer);
+		}
+
+		public void LatchInputFromPlayer(IController source)
+		{
+			MovieControllerAdapter.LatchFromSource(source);
+		}
+
+		/// <summary>
+		/// latch input from the input log, if available
+		/// </summary>
+		public void LatchInputFromLog()
+		{
+			string loggedFrame = Movie.GetInputFrame(Global.Emulator.Frame);
+			if (loggedFrame != "")
+				MovieControllerAdapter.SetControllersAsMnemonic(loggedFrame);
+		}
+	}
+
+}