Updates and fixes for Beat Saber 1.39.0

BeatSaberCinema/BeatSaberCinema.csproj

@@ -36,7 +36,11 @@
 		<Reference Include="AdditionalContentModel.Interfaces" Publicize="true">
 			<HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\AdditionalContentModel.Interfaces.dll</HintPath>
 		</Reference>
-		<Reference Include="BeatmapCore" Publicize="true">
+        <Reference Include="BeatSaber.BeatmapEditor" Publicize="true">
+            <HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\BeatSaber.BeatmapEditor.dll</HintPath>
+            <Private>false</Private>
+        </Reference>
+        <Reference Include="BeatmapCore" Publicize="true">
 			<HintPath>$(BeatSaberDir)\Beat Saber_Data\Managed\BeatmapCore.dll</HintPath>
 			<Private>False</Private>
 		</Reference>

BeatSaberCinema/Environment/EnvironmentController.cs

@@ -161,7 +161,7 @@ private static void Reset()
 				PlaybackController.Instance.VideoPlayer.screenController.Screens.RemoveRange(1, PlaybackController.Instance.VideoPlayer.screenController.Screens.Count - 1);
 
 
-				if (Util.IsModInstalled("_Heck"))
+				if (InstalledMods.Heck)
 				{
 					var types = new[] {"Chroma.GameObjectTrackController", "Chroma.Lighting.EnvironmentEnhancement.GameObjectTrackController"};
 

BeatSaberCinema/Harmony/Patches/WaitForChromaPatch.cs

@@ -28,14 +28,7 @@ private static IEnumerator WaitThenStart()
 
 			//Turns out CustomPlatforms runs even later and undoes some of the scene modifications Cinema does. Waiting for a specific duration is more of a temporary fix.
 			//TODO Find a better way to implement this. The problematic coroutine in CustomPlatforms is CustomFloorPlugin.EnvironmentHider+<InternalHideObjectsForPlatform>
-			if (Util.IsModInstalled("CustomPlatforms"))
-			{
-				yield return new WaitForSeconds(0.75f);
-			}
-			else
-			{
-				yield return new WaitForSeconds(0.05f);
-			}
+			yield return new WaitForSeconds(InstalledMods.CustomPlatforms ? 0.75f : 0.05f);
 
 			EnvironmentController.ModifyGameScene(PlaybackController.Instance.VideoConfig);
 		}

BeatSaberCinema/Plugin.cs

@@ -50,14 +50,16 @@ public void OnApplicationStart()
 		private static void OnMenuSceneLoadedFresh(ScenesTransitionSetupDataSO scenesTransition)
 		{
 			PlaybackController.Create();
-			VideoMenu.AddTab();
-			SettingsUI.CreateMenu();
-			SongPreviewPlayerController.Init();
 
-			if (Util.IsModInstalled("BetterSongList", "0.3.2") && !_filterAdded)
+			if (VideoMenu.Instance != null)
 			{
-				AddBetterSongListFilter();
+				VideoMenu.RemoveTab();
 			}
+			VideoMenu.AddTab();
+
+			SettingsUI.CreateMenu();
+			SongPreviewPlayerController.Init();
+			AddBetterSongListFilter();
 		}
 
 		[OnEnable]
@@ -76,7 +78,7 @@ public void OnEnable()
 			}
 
 			//No need to index maps if the filter isn't going to be applied anyway
-			if (Util.IsModInstalled("BetterSongList", "0.3.2"))
+			if (InstalledMods.BetterSongList)
 			{
 				Loader.SongsLoadedEvent += VideoLoader.IndexMaps;
 			}
@@ -96,7 +98,7 @@ public void OnDisable()
 			//TODO Destroying and re-creating the PlaybackController messes up the VideoMenu without any exceptions in the log. Investigate.
 			//PlaybackController.Destroy();
 
-			VideoMenu.Instance?.RemoveTab();
+			VideoMenu.RemoveTab();
 			EnvironmentController.Disable();
 			VideoLoader.StopFileSystemWatcher();
 			Collections.DeregisterCapability(CAPABILITY);
@@ -114,13 +116,16 @@ private void RemoveHarmonyPatches()
 
 		private static void AddBetterSongListFilter()
 		{
-			var filter = new HasVideoFilter();
-			var success = BetterSongList.FilterMethods.Register(filter);
-			if (success)
+			if (!InstalledMods.BetterSongList || _filterAdded)
 			{
-				_filterAdded = true;
-				Log.Debug($"Registered {nameof(HasVideoFilter)}");
+				return;
+			}
 
+			_filterAdded = BetterSongList.FilterMethods.Register(new HasVideoFilter());
+
+			if (_filterAdded)
+			{
+				Log.Debug($"Registered {nameof(HasVideoFilter)}");
 			}
 			else
 			{

BeatSaberCinema/Util/InstalledMods.cs

@@ -0,0 +1,25 @@
+using System.Linq;
+using IPA.Loader;
+using HiveVersion = Hive.Versioning.Version;
+
+namespace BeatSaberCinema
+{
+	/// <summary>
+	/// Declares a set of soft dependencies by whether they are installed.
+	///	true: is installed / false: is not installed
+	/// </summary>
+	internal static class InstalledMods
+	{
+		public static bool BetterSongList { get; } = IsModInstalled("BetterSongList", "0.3.2");
+		public static bool BeatSaberPlaylistsLib { get; } = IsModInstalled("BeatSaberPlaylistsLib", "1.7.0");
+		public static bool CustomPlatforms { get; } = IsModInstalled("CustomPlatforms");
+		public static bool MusicVideoPlayer { get; } = IsModInstalled("Music Video Player");
+		public static bool Heck { get; } = IsModInstalled("_Heck");
+
+		private static bool IsModInstalled(string modId, string? minimumVersion = null)
+		{
+			return minimumVersion == null ? PluginManager.EnabledPlugins.Any(x => x.Id == modId)
+				: PluginManager.EnabledPlugins.Any(x => x.Id == modId && x.HVersion >= new HiveVersion(minimumVersion));
+		}
+	}
+}

BeatSaberCinema/Util/PlaylistSongUtils.cs

@@ -0,0 +1,69 @@
+using System;
+using BeatSaberPlaylistsLib.Types;
+using Newtonsoft.Json;
+
+namespace BeatSaberCinema
+{
+	public static class PlaylistSongUtils
+	{
+		/// <summary>
+		/// Do not call this method without checking if BeatSaberPlaylistsLib is installed with <see cref="InstalledMods"/>
+		/// </summary>
+		public static bool IsPlaylistLevel(this BeatmapLevel? beatmapLevel)
+		{
+			return beatmapLevel is PlaylistLevel;
+		}
+
+		/// <summary>
+		/// Do not call this method without checking if BeatSaberPlaylistsLib is installed with <see cref="InstalledMods"/>
+		/// </summary>
+		public static BeatmapLevel? GetLevelFromPlaylistIfAvailable(this BeatmapLevel? beatmapLevel)
+		{
+			return beatmapLevel is PlaylistLevel playlistLevel ? playlistLevel.playlistSong.BeatmapLevel ?? beatmapLevel : beatmapLevel;
+		}
+
+		/// <summary>
+		/// Do not call this method without checking if BeatSaberPlaylistsLib is installed with <see cref="InstalledMods"/>
+		/// </summary>
+		public static bool TryGetPlaylistLevelConfig(this BeatmapLevel? beatmapLevel, string levelPath, out VideoConfig? videoConfig)
+		{
+			return (videoConfig = beatmapLevel is PlaylistLevel playlistLevel ? playlistLevel.TryLoadConfig(levelPath) : null) != null;
+		}
+
+		/// <summary>
+		/// Do not call this method without checking if BeatSaberPlaylistsLib is installed with <see cref="InstalledMods"/>
+		/// </summary>
+		public static VideoConfig? TryLoadConfig(this PlaylistLevel playlistLevel, string levelPath)
+		{
+			var playlistSong = playlistLevel.playlistSong;
+			if (playlistSong.TryGetCustomData("cinema", out var cinemaData))
+			{
+				VideoConfig? videoConfig;
+				try
+				{
+					var json = JsonConvert.SerializeObject(cinemaData);
+					videoConfig = JsonConvert.DeserializeObject<VideoConfig>(json);
+				}
+				catch (Exception e)
+				{
+					Log.Error($"Error parsing video json {playlistSong.Name}:");
+					Log.Error(e);
+					return null;
+				}
+
+				if (videoConfig == null)
+				{
+					Log.Warn($"Deserializing video config for {playlistSong.Name} failed");
+					return null;
+				}
+				videoConfig.LevelDir = levelPath;
+				videoConfig.UpdateDownloadState();
+
+				return videoConfig;
+			}
+
+			Log.Error($"No config exists for {playlistSong.Name}:");
+			return null;
+		}
+	}
+}

BeatSaberCinema/Util/Util.cs

@@ -79,11 +79,6 @@ public static string ShortenFilename(string path, string s)
 			return s;
 		}
 
-		public static bool IsModInstalled(string modName, string? minimumVersion = null)
-		{
-			return IPA.Loader.PluginManager.EnabledPlugins.Any(x => x.Id == modName && (minimumVersion == null || x.HVersion >= new Hive.Versioning.Version(minimumVersion)));
-		}
-
 		public static Texture? LoadPNGFromResources(string resourcePath)
 		{
 			var fileData = BeatSaberMarkupLanguage.Utilities.GetResource(Assembly.GetExecutingAssembly(), resourcePath);

BeatSaberCinema/Video/VideoLoader.cs

@@ -10,7 +10,6 @@
 using System.Threading;
 using System.Threading.Tasks;
 using BeatmapEditor3D.DataModels;
-using BeatSaberPlaylistsLib.Types;
 using IPA.Utilities.Async;
 using Newtonsoft.Json;
 using SongCore;
@@ -25,7 +24,6 @@ public static class VideoLoader
 		internal const string WIP_MAPS_FOLDER = "CustomWIPLevels";
 		private const string CONFIG_FILENAME = "cinema-video.json";
 		private const string CONFIG_FILENAME_MVP = "video.json";
-		private const string MOD_ID_MVP = "Music Video Player";
 
 		private static FileSystemWatcher? _fileSystemWatcher;
 		public static event Action<VideoConfig?>? ConfigChanged;
@@ -196,6 +194,7 @@ public static void RemoveConfigFromCache(BeatmapLevel level)
 
 			config.LevelDir = GetLevelPath(level);
 			config.bundledConfig = true;
+			Log.Debug("Loaded from bundled configs");
 			return config;
 		}
 
@@ -333,15 +332,14 @@ public static async Task<EntitlementStatus> GetEntitlementForLevel(BeatmapLevel
 			return videoConfig;
 		}
 
-		public static VideoConfig? GetConfigForLevel(BeatmapLevel? level, bool isPlaylistSong = false)
+		public static VideoConfig? GetConfigForLevel(BeatmapLevel? level)
 		{
-			var playlistSong = level;
-			if (isPlaylistSong)
+			if (InstalledMods.BeatSaberPlaylistsLib)
 			{
-				level = GetBeatmapLevelFromPlaylistSong(level);
+				level = level.GetLevelFromPlaylistIfAvailable();
 			}
 
-			if (playlistSong == null || level == null)
+			if (level == null)
 			{
 				return null;
 			}
@@ -361,7 +359,7 @@ public static async Task<EntitlementStatus> GetEntitlementForLevel(BeatmapLevel
 			if (Directory.Exists(levelPath))
 			{
 				videoConfig = LoadConfig(GetConfigPath(levelPath));
-				if (videoConfig == null && !Util.IsModInstalled(MOD_ID_MVP))
+				if (videoConfig == null && !InstalledMods.MusicVideoPlayer)
 				{
 					//Back compatiblity with MVP configs, but only if MVP is not installed
 					videoConfig = LoadConfig(Path.Combine(levelPath, CONFIG_FILENAME_MVP));
@@ -372,39 +370,12 @@ public static async Task<EntitlementStatus> GetEntitlementForLevel(BeatmapLevel
 				Log.Debug($"Path does not exist: {levelPath}");
 			}
 
-			if (videoConfig == null && isPlaylistSong && PlaylistSongHasConfig(playlistSong))
+			if (InstalledMods.BeatSaberPlaylistsLib && videoConfig == null && level.TryGetPlaylistLevelConfig(levelPath, out var playlistConfig))
 			{
-				videoConfig = LoadConfigFromPlaylistSong(playlistSong, levelPath);
+				videoConfig = playlistConfig;
 			}
 
-			if (videoConfig == null)
-			{
-				videoConfig = GetConfigFromBundledConfigs(level);
-				if (videoConfig == null)
-				{
-					return videoConfig;
-				}
-				Log.Debug("Loaded from bundled configs");
-			}
-
-			return videoConfig;
-		}
-
-		private static bool PlaylistSongHasConfig(BeatmapLevel level)
-		{
-			var playlistLevel = level as PlaylistLevel;
-			return playlistLevel?.playlistSong.TryGetCustomData("cinema", out _) ?? false;
-		}
-
-		public static BeatmapLevel? GetBeatmapLevelFromPlaylistSong(BeatmapLevel? level)
-		{
-			BeatmapLevel? unwrappedLevel = null!;
-			if (level is PlaylistLevel playlistLevel)
-			{
-				unwrappedLevel = playlistLevel.playlistSong.BeatmapLevel;
-			}
-
-			return unwrappedLevel ?? level;
+			return videoConfig ?? GetConfigFromBundledConfigs(level);
 		}
 
 		[Obsolete("Obsolete")]
@@ -573,44 +544,6 @@ public static bool DeleteConfig(VideoConfig videoConfig, BeatmapLevel level)
 			return videoConfig;
 		}
 
-		private static VideoConfig? LoadConfigFromPlaylistSong(BeatmapLevel beatmapLevel, string levelPath)
-		{
-			if (!(beatmapLevel is PlaylistLevel playlistLevel))
-			{
-				return null;
-			}
-
-			var playlistSong = playlistLevel.playlistSong;
-			if (playlistSong.TryGetCustomData("cinema", out var cinemaData))
-			{
-				VideoConfig? videoConfig;
-				try
-				{
-					var json = JsonConvert.SerializeObject(cinemaData);
-					videoConfig = JsonConvert.DeserializeObject<VideoConfig>(json);
-				}
-				catch (Exception e)
-				{
-					Log.Error($"Error parsing video json {playlistSong.Name}:");
-					Log.Error(e);
-					return null;
-				}
-
-				if (videoConfig == null)
-				{
-					Log.Warn($"Deserializing video config for {playlistSong.Name} failed");
-					return null;
-				}
-				videoConfig.LevelDir = levelPath;
-				videoConfig.UpdateDownloadState();
-
-				return videoConfig;
-			}
-
-			Log.Error($"No config exists for {playlistSong.Name}:");
-			return null;
-		}
-
 		private static IEnumerable<BundledConfig> LoadBundledConfigs()
 		{
 			var buffer = BeatSaberMarkupLanguage.Utilities.GetResource(Assembly.GetExecutingAssembly(), "BeatSaberCinema.Resources.configs.json");