Add IMovieApi.PlayFromStart/movie.play_from_start (resolves #384)

Author: YoshiRulz

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

@@ -100,6 +100,31 @@ public IReadOnlyList<string> GetSubtitles()
 
 		public string Mode() => (_movieSession.Movie?.Mode ?? MovieMode.Inactive).ToString().ToUpper();
 
+		public bool PlayFromStart(string path = "")
+		{
+			if (string.IsNullOrEmpty(path))
+			{
+				try
+				{
+					return _mainForm.RestartMovie();
+				}
+				catch (Exception e)
+				{
+					LogCallback($"caught {e.GetType().Name} while trying to restart movie: {e.Message}");
+					return false;
+				}
+			}
+			try
+			{
+				return _mainForm.LoadMovie(filename: path);
+			}
+			catch (Exception e)
+			{
+				LogCallback($"caught {e.GetType().Name} while trying to load movie: {e.Message}");
+				return false;
+			}
+		}
+
 		public void SetReadOnly(bool readOnly) => _movieSession.ReadOnly = readOnly;
 
 		public void SetRerecordCount(ulong count) => _movieSession.Movie.Rerecords = count;

src/BizHawk.Client.Common/Api/Interfaces/IMovieApi.cs

@@ -15,6 +15,14 @@ public interface IMovieApi : IExternalApi
 		bool IsLoaded();
 		int Length();
 		string Mode();
+
+		/// <summary>
+		/// Resets the core to frame 0 with the currently loaded movie in playback mode.
+		/// If <paramref name="path"/> is specified, attempts to load it, then continues with playback if it was successful.
+		/// </summary>
+		/// <returns>true iff successful</returns>
+		bool PlayFromStart(string path = "");
+
 		void Save(string filename = "");
 		void SetReadOnly(bool readOnly);
 		void SetRerecordCount(ulong count);

src/BizHawk.Client.Common/IMainFormForApi.cs

@@ -60,6 +60,14 @@ public interface IMainFormForApi
 		/// <remarks>only referenced from <see cref="EmuClientApi"/></remarks>
 		int GetApproxFramerate();
 
+		/// <summary>
+		/// essentially <c>return MainForm.StartNewMovie(MovieSession.Get(filename), record: false);</c>,
+		/// but also ensures a rom is loaded, and defers to TAStudio
+		/// </summary>
+		/// <param name="archive">unused</param>
+		/// <remarks>only referenced from <see cref="MovieApi"/></remarks>
+		bool LoadMovie(string filename, string archive = null);
+
 		/// <remarks>only referenced from <see cref="SaveStateApi"/></remarks>
 		void LoadQuickSave(string quickSlotName, bool suppressOSD = false);
 
@@ -77,6 +85,9 @@ public interface IMainFormForApi
 		/// <remarks>only referenced from <c>EmuClientApi</c></remarks>
 		void Render();
 
+		/// <remarks>only referenced from <see cref="MovieApi"/></remarks>
+		bool RestartMovie();
+
 		/// <remarks>only referenced from <see cref="SaveStateApi"/></remarks>
 		void SaveQuickSave(string quickSlotName, bool fromLua = false, bool suppressOSD = false);
 

src/BizHawk.Client.Common/lua/CommonLibs/MovieLuaLibrary.cs

@@ -72,6 +72,16 @@ public int Length()
 		public string Mode()
 			=> APIs.Movie.Mode();
 
+		[LuaMethodExample(@"movie.play_from_start(""C:\\moviename.ext"");")]
+		[LuaMethod("play_from_start", "Resets the core to frame 0 with the currently loaded movie in playback mode. If a path to a movie is specified, attempts to load it, then continues with playback if it was successful. Returns true iff successful.")]
+		public bool PlayFromStart([LuaArbitraryStringParam] string path = "")
+		{
+			_luaLibsImpl.IsRebootingCore = true;
+			var success = APIs.Movie.PlayFromStart(path);
+			_luaLibsImpl.IsRebootingCore = false;
+			return success;
+		}
+
 		[LuaMethodExample("movie.save( \"C:\\moviename.ext\" );")]
 		[LuaMethod("save", "Saves the current movie to the disc. If the filename is provided (no extension or path needed), the movie is saved under the specified name to the current movie directory. The filename may contain a subdirectory, it will be created if it doesn't exist. Existing files won't get overwritten.")]
 		public void Save([LuaArbitraryStringParam] string filename = "")

src/BizHawk.Client.EmuHawk/MainForm.FileLoader.cs

@@ -87,7 +87,7 @@ private void LoadLuaSession(string filename, string archive = null)
 			}
 		}
 
-		private bool LoadMovie(string filename, string archive = null)
+		public bool LoadMovie(string filename, string archive = null)
 		{
 			if (Emulator.IsNull())
 			{

src/BizHawk.Client.EmuHawk/MainForm.Movie.cs

@@ -99,7 +99,7 @@ public void StopMovie(bool saveChanges = true)
 			}
 		}
 
-		private bool RestartMovie()
+		public bool RestartMovie()
 		{
 			if (IsSlave && Master.WantsToControlRestartMovie) return Master.RestartMovie();
 			if (!MovieSession.Movie.IsActive()) return false;