Custom Background Enhancements Part 1

CollapseLauncher/Classes/GameManagement/GameSettings/Genshin/Settings.cs

@@ -32,14 +32,15 @@ public override void ReloadSettings()
             InitializeSettings();
         } 
 
+        #nullable enable
         public override void SaveSettings()
         {
             // Save Settings
             base.SaveSettings();
-            SettingsScreen.Save();
-            SettingsGeneralData.Save();
-            SettingVisibleBackground.Save();
-            SettingsWindowsHDR.Save();
+            SettingsScreen?.Save();
+            SettingsGeneralData?.Save();
+            SettingVisibleBackground?.Save();
+            SettingsWindowsHDR?.Save();
         }
 
         public override IGameSettingsUniversal AsIGameSettingsUniversal() => this;

CollapseLauncher/Classes/GameManagement/GameSettings/StarRail/RegistryClass/Model.cs

@@ -1,5 +1,6 @@
 using CollapseLauncher.GameSettings.StarRail.Context;
 using CollapseLauncher.Interfaces;
+using CollapseLauncher.Pages;
 using Hi3Helper;
 using Hi3Helper.EncTool;
 using Microsoft.Win32;
@@ -329,6 +330,13 @@ public void Save()
             try
             {
                 if (RegistryRoot == null) throw new NullReferenceException($"Cannot save {_ValueName} since RegistryKey is unexpectedly not initialized!");
+
+                if (StarRailGameSettingsPage.CheckAbTest())
+                {
+                    LogWriteLine("[StarRailGameSettings::Model] Graphics settings could not be saved due to A/B test flag is found!",
+                                 LogType.Error, true);
+                    return;
+                }
 
                 RegistryRoot.SetValue(_GraphicsQuality, Quality.Custom, RegistryValueKind.DWord);
 

CollapseLauncher/Classes/GameManagement/GameSettings/StarRail/Settings.cs

@@ -41,18 +41,19 @@ public override void ReloadSettings()
             InitializeSettings();
         } 
 
+        #nullable enable
         public override void SaveSettings()
         {
             // Save Settings
             base.SaveSettings();
-            GraphicsSettings.Save();
-            SettingsScreen.Save();
-            AudioSettings_BGM.Save();
-            AudioSettings_Master.Save();
-            AudioSettings_SFX.Save();
-            AudioSettings_VO.Save();
-            AudioLanguage.Save();
-            TextLanguage.Save();
+            GraphicsSettings?.Save();
+            SettingsScreen?.Save();
+            AudioSettings_BGM?.Save();
+            AudioSettings_Master?.Save();
+            AudioSettings_SFX?.Save();
+            AudioSettings_VO?.Save();
+            AudioLanguage?.Save();
+            TextLanguage?.Save();
         }
 
         public override IGameSettingsUniversal AsIGameSettingsUniversal() => this;

CollapseLauncher/Classes/GameManagement/GameSettings/Universal/RegistryClass/CollapseMiscSetting.cs

@@ -17,6 +17,8 @@
         private const string _ValueName = "CollapseLauncher_Misc";
 
         private bool _UseCustomArguments = true;
+
+        private bool _UseCustomRegionBG  = false;
 
         private static bool _IsDeserializing;
         #endregion
@@ -88,10 +90,30 @@
         /// Use mobile layout. Currently only available for Genshin and StarRail.
         /// </summary>
         public bool LaunchMobileMode { get; set; } = false;
+
+        /// <summary>
+        /// Set custom background for given region for given game.
+        /// </summary>
+        public bool UseCustomRegionBG
+        {
+            get => _UseCustomRegionBG;
+            set
+            {
+                _UseCustomRegionBG = value;
+                if (!_IsDeserializing) Save();
+            }
+        }
+
+#nullable enable
+        /// <summary>
+        /// The path of the custom BG for each region
+        /// </summary>
+        public string? CustomRegionBGPath { get; set; }
+
         #endregion
 
         #region Methods
 #nullable enable
         public static CollapseMiscSetting Load()
         {
             try

CollapseLauncher/Classes/Helper/Background/BackgroundMediaUtility.cs

@@ -48,7 +48,7 @@ internal enum MediaType
         private Grid? _parentBgImageBackgroundGrid;
         private Grid? _parentBgMediaPlayerBackgroundGrid;
 
-        internal MediaType CurrentAppliedMediaType = MediaType.Unknown;
+        internal static MediaType CurrentAppliedMediaType = MediaType.Unknown;
 
         private CancellationTokenSourceWrapper? _cancellationToken;
         private IBackgroundMediaLoader?         _loaderStillImage;
@@ -150,8 +150,6 @@ public void Dispose()
             _alternativeFileStream?.Dispose();
             _alternativeFileStream = null;
 
-            CurrentAppliedMediaType = MediaType.Unknown;
-
             _isCurrentRegistered = false;
             GC.SuppressFinalize(this);
         }
@@ -349,7 +347,7 @@ private async Task LoadBackgroundInner(string mediaPath,                  bool
                         _loaderMediaPlayer?.Show();
                         break;
                     case MediaType.StillImage:
-                        _loaderStillImage?.Show();
+                        _loaderStillImage?.Show(CurrentAppliedMediaType == MediaType.Media);
                         _loaderMediaPlayer?.Hide();
                         break;
                 }

CollapseLauncher/Classes/Helper/Background/Loaders/IBackgroundMediaLoader.cs

@@ -16,7 +16,7 @@ internal interface IBackgroundMediaLoader : IDisposable
         Task LoadAsync(string filePath, bool isForceRecreateCache = false, bool isRequestInit = false, CancellationToken token = default);
         void Dimm();
         void Undimm();
-        void Show();
+        void Show(bool isForceShow = false);
         void Hide();
         void Mute();
         void Unmute();

CollapseLauncher/Classes/Helper/Background/Loaders/MediaPlayerLoader.cs

@@ -1,10 +1,10 @@
 using CollapseLauncher.Extension;
 using CollapseLauncher.Helper.Animation;
 using CommunityToolkit.WinUI.Animations;
+using Hi3Helper;
 #if USEFFMPEGFORVIDEOBG
 using FFmpegInteropX;
 using Hi3Helper;
-
 #endif
 using Hi3Helper.Shared.Region;
 using Microsoft.UI.Composition;
@@ -18,6 +18,7 @@
 using Windows.Media.Playback;
 using Windows.Storage;
 using Windows.Storage.FileProperties;
+using static Hi3Helper.Logger;
 
 #if USEDYNAMICVIDEOPALETTE
 using CollapseLauncher.Extension;
@@ -101,9 +102,32 @@ public void Dispose()
             CanvasDevice?.Dispose();
             CurrentFrameBitmap?.Dispose();
 #endif
-            CurrentMediaPlayer?.Dispose();
-            InnerCancellationToken?.Dispose();
-            CurrentMediaStream?.Dispose();
+            try
+            {
+                CurrentMediaPlayer?.Dispose();
+            }
+            catch (Exception ex)
+            {
+                LogWriteLine($"Error disposing CurrentMediaPlayer: {ex.Message}", LogType.Error, true);
+            }
+
+            try
+            {
+                InnerCancellationToken?.Dispose();
+            }
+            catch (Exception ex)
+            {
+                LogWriteLine($"Error disposing InnerCancellationToken: {ex.Message}", LogType.Error, true);
+            }
+
+            try
+            {
+                CurrentMediaStream?.Dispose();
+            }
+            catch (Exception ex)
+            {
+                LogWriteLine($"Error disposing CurrentMediaStream: {ex.Message}", LogType.Error, true);
+            }
 
             GC.SuppressFinalize(this);
         }
@@ -387,7 +411,7 @@ await Task.WhenAll(
                 );
         }
 
-        public void Show()
+        public void Show(bool isForceShow = false)
         {
             BackgroundMediaUtility.SharedActionBlockQueue?.Post(ShowInner());
         }

CollapseLauncher/Classes/Helper/Background/Loaders/StillImageLoader.cs

@@ -30,7 +30,12 @@ internal class StillImageLoader : IBackgroundMediaLoader
         private Grid             AcrylicMask         { get; }
         private Grid             OverlayTitleBar     { get; }
         private double           AnimationDuration   { get; }
-        public  bool             IsBackgroundDimm    { get; set; }
+
+        public bool IsBackgroundDimm
+        {
+            get; 
+            set;
+        }
 
         internal StillImageLoader(
             FrameworkElement parentUI,
@@ -39,6 +44,7 @@ internal StillImageLoader(
             ImageUI?         imageBackCurrent, ImageUI? imageBackLast,
             double           animationDuration = BackgroundMediaUtility.TransitionDuration)
         {
+            GC.SuppressFinalize(this);
             ParentUI          = parentUI;
             CurrentCompositor = parentUI.GetElementCompositor();
 
@@ -56,7 +62,7 @@ internal StillImageLoader(
 
         public void Dispose()
         {
-            GC.SuppressFinalize(this);
+            GC.Collect();
         }
 
         public async Task LoadAsync(string filePath,      bool              isImageLoadForFirstTime,
@@ -85,11 +91,11 @@ await Task.WhenAll(
                                                                         isImageLoadForFirstTime, false),
                                    ApplyAndSwitchImage(AnimationDuration, bitmapImage)
                                   );
+
             }
             finally
             {
                 GC.Collect();
-                GC.WaitForPendingFinalizers();
             }
         }
 
@@ -107,9 +113,11 @@ private async Task ApplyAndSwitchImage(double duration, BitmapImage imageToApply
             await Task.WhenAll(
                                ImageBackCurrent.StartAnimation(timeSpan,
                                                                CurrentCompositor
-                                                                  .CreateScalarKeyFrameAnimation("Opacity", 1, 0)),
+                                                                  .CreateScalarKeyFrameAnimation("Opacity",
+                                                                       1, 0)),
                                ImageBackLast.StartAnimation(timeSpan,
-                                                            CurrentCompositor.CreateScalarKeyFrameAnimation("Opacity",
+                                                            CurrentCompositor
+                                                               .CreateScalarKeyFrameAnimation("Opacity",
                                                                 0, 1, timeSpan * 0.8))
                               );
         }
@@ -124,10 +132,18 @@ public void Undimm()
             BackgroundMediaUtility.SharedActionBlockQueue?.Post(ToggleImageVisibility(false));
         }
 
-        private async Task ToggleImageVisibility(bool hideImage, bool completeInvisible = false)
+        private async Task ToggleImageVisibility(bool hideImage, bool completeInvisible = false, bool isForceShow = false)
         {
-            if (IsBackgroundDimm == hideImage) return;
-            IsBackgroundDimm = hideImage;
+            if (isForceShow)
+            {
+                hideImage = false;
+                completeInvisible = false;
+            }
+            else
+            {
+                if (IsBackgroundDimm == hideImage) return;
+                IsBackgroundDimm = hideImage;
+            }
 
             TimeSpan duration = TimeSpan.FromSeconds(hideImage
                                                          ? BackgroundMediaUtility.TransitionDuration
@@ -141,7 +157,26 @@ private async Task ToggleImageVisibility(bool hideImage, bool completeInvisible
             Vector3 toTranslate = new Vector3(-((float)(ImageBackParentGrid?.ActualWidth ?? 0) * (toScale - 1f) / 2),
                 -((float)(ImageBackParentGrid?.ActualHeight ?? 0) * (toScale - 1f) / 2), 0);
 
-            if (completeInvisible)
+            if (isForceShow)
+            {
+                await Task.WhenAll(
+                    AcrylicMask.StartAnimation(
+                        duration,
+                        CurrentCompositor.CreateScalarKeyFrameAnimation("Opacity", hideImage ? 1f : 0f, hideImage ? 0f : 1f)
+                        ),
+                    OverlayTitleBar.StartAnimation(
+                         duration,
+                         CurrentCompositor.CreateScalarKeyFrameAnimation("Opacity", hideImage ? 0f : 1f, hideImage ? 1f : 0f)
+                        ),
+                    ImageBackParentGrid.StartAnimation(
+                        duration,
+                        CurrentCompositor.CreateVector3KeyFrameAnimation("Scale", new Vector3(hideImage ? toScale : fromScale), new Vector3(!hideImage ? toScale : fromScale)),
+                        CurrentCompositor.CreateVector3KeyFrameAnimation("Translation", hideImage ? toTranslate : fromTranslate, !hideImage ? toTranslate : fromTranslate),
+                        CurrentCompositor.CreateScalarKeyFrameAnimation("Opacity", 1f, 0f)
+                        )
+                );
+            }
+            else if (completeInvisible)
             {
                 await Task.WhenAll(
                     ImageBackParentGrid.StartAnimation(
@@ -170,10 +205,10 @@ await Task.WhenAll(
             }
         }
 
-        public void Show()
+        public void Show(bool isForceShow = false)
         {
             if (ImageBackParentGrid?.Opacity > 0f) return;
-            BackgroundMediaUtility.SharedActionBlockQueue?.Post(ToggleImageVisibility(false, true));
+            BackgroundMediaUtility.SharedActionBlockQueue?.Post(ToggleImageVisibility(false, true, isForceShow));
         }
 
         public void Hide()