Shader translation delay hack (#469)

A workaround to avoid a freeze when translating shaders with the Metal
backend, that would happen after changing version or going from Vulkan
to Metal. 

Adds a delay in milliseconds, configurable in the UI behind the Dirty Hacks mechanism.

---------

Co-authored-by: Evan Husted <greem@greemdev.net>

distribution/linux/appimage/build-appimage.sh

@@ -13,7 +13,7 @@ mkdir -p AppDir/usr/bin
 
 cp distribution/linux/Ryujinx.desktop AppDir/Ryujinx.desktop
 cp distribution/linux/appimage/AppRun AppDir/AppRun
-cp src/Ryujinx.UI.Common/Resources/Logo_Ryujinx.png AppDir/Ryujinx.svg
+cp distribution/misc/Logo.svg AppDir/Ryujinx.svg
 
 
 cp -r "$BUILDDIR"/* AppDir/usr/bin/

src/Ryujinx.Audio/Backends/Dummy/DummyHardwareDeviceDriver.cs

@@ -9,20 +9,12 @@ namespace Ryujinx.Audio.Backends.Dummy
 {
     public class DummyHardwareDeviceDriver : IHardwareDeviceDriver
     {
-        private readonly ManualResetEvent _updateRequiredEvent;
+        private readonly ManualResetEvent _updateRequiredEvent = new(false);
-        private readonly ManualResetEvent _pauseEvent;
+        private readonly ManualResetEvent _pauseEvent = new(true);
 
         public static bool IsSupported => true;
 
-        public float Volume { get; set; }
+        public float Volume { get; set; } = 1f;
-
-        public DummyHardwareDeviceDriver()
-        {
-            _updateRequiredEvent = new ManualResetEvent(false);
-            _pauseEvent = new ManualResetEvent(true);
-
-            Volume = 1f;
-        }
 
         public IHardwareDeviceSession OpenDeviceSession(Direction direction, IVirtualMemoryManager memoryManager, SampleFormat sampleFormat, uint sampleRate, uint channelCount)
         {
@@ -60,7 +52,7 @@ namespace Ryujinx.Audio.Backends.Dummy
             Dispose(true);
         }
 
-        protected virtual void Dispose(bool disposing)
+        private void Dispose(bool disposing)
         {
             if (disposing)
             {

src/Ryujinx.Common/Configuration/DirtyHacks.cs

@@ -13,13 +13,13 @@ namespace Ryujinx.Common.Configuration
 
     public record EnabledDirtyHack(DirtyHacks Hack, int Value)
     {
-        private static readonly byte[] _packedFormat = [8, 32];
+        public static readonly byte[] PackedFormat = [8, 32];
         
-        public ulong Pack() => BitTricks.PackBitFields([(uint)Hack, (uint)Value], _packedFormat);
+        public ulong Pack() => BitTricks.PackBitFields([(uint)Hack, (uint)Value], PackedFormat);
 
-        public static EnabledDirtyHack FromPacked(ulong packedHack)
+        public static EnabledDirtyHack Unpack(ulong packedHack)
         {
-            var unpackedFields = BitTricks.UnpackBitFields(packedHack, _packedFormat);
+            var unpackedFields = BitTricks.UnpackBitFields(packedHack, PackedFormat);
             if (unpackedFields is not [var hack, var value])
                 throw new ArgumentException(nameof(packedHack));
             
@@ -39,12 +39,21 @@ namespace Ryujinx.Common.Configuration
         
         public DirtyHackCollection(ulong[] packedHacks)
         {
-            foreach ((DirtyHacks dirtyHacks, int value) in packedHacks.Select(EnabledDirtyHack.FromPacked))
+            foreach ((DirtyHacks dirtyHacks, int value) in packedHacks.Select(EnabledDirtyHack.Unpack))
             {
                 Add(dirtyHacks, value);
             }
         }
 
+        public ulong[] PackEntries() =>
+            this
+                .Select(it => 
+                    BitTricks.PackBitFields([(uint)it.Key, (uint)it.Value], EnabledDirtyHack.PackedFormat))
+                .ToArray();
+
+        public static implicit operator DirtyHackCollection(EnabledDirtyHack[] hacks) => new(hacks);
+        public static implicit operator DirtyHackCollection(ulong[] packedHacks) => new(packedHacks);
+
         public new int this[DirtyHacks hack] => TryGetValue(hack, out var value) ? value : -1;
 
         public bool IsEnabled(DirtyHacks hack) => ContainsKey(hack);

src/Ryujinx.Graphics.Gpu/Shader/DiskCache/ParallelDiskCacheLoader.cs

@@ -1,3 +1,4 @@
+using Ryujinx.Common.Configuration;
 using Ryujinx.Common.Logging;
 using Ryujinx.Graphics.GAL;
 using Ryujinx.Graphics.Shader;
@@ -366,6 +367,9 @@ namespace Ryujinx.Graphics.Gpu.Shader.DiskCache
         {
             try
             {
+                if (_context.DirtyHacks.IsEnabled(DirtyHacks.ShaderCompilationThreadSleep))
+                    Thread.Sleep(_context.DirtyHacks[DirtyHacks.ShaderCompilationThreadSleep]);
+                
                 AsyncProgramTranslation asyncTranslation = new(guestShaders, specState, programIndex, isCompute);
                 _asyncTranslationQueue.Add(asyncTranslation, _cancellationToken);
             }

src/Ryujinx/UI/ViewModels/SettingsViewModel.cs

@@ -301,6 +301,8 @@ namespace Ryujinx.Ava.UI.ViewModels
             }
         }
 
+        public string ShaderTranslationDelayTooltipText => $"Current value: {ShaderTranslationDelay}"; 
+        
         public int ShaderTranslationDelay
         {
             get => _shaderTranslationSleepDelay;
@@ -308,7 +310,7 @@ namespace Ryujinx.Ava.UI.ViewModels
             {
                 _shaderTranslationSleepDelay = value;
                 
-                OnPropertyChanged();
+                OnPropertiesChanged(nameof(ShaderTranslationDelay), nameof(ShaderTranslationDelayTooltipText));
             }
         }
 

src/Ryujinx/UI/Views/Settings/SettingsHacksView.axaml

@@ -29,7 +29,7 @@
                 <TextBlock
                     Foreground="{DynamicResource SecondaryTextColor}"
                     TextDecorations="Underline"
-                    Text="Game-specific hacks &amp; tricks to alleviate performance issues or crashing. May cause issues." />
+                    Text="Game-specific hacks &amp; tricks to alleviate performance issues or crashing. Will cause issues." />
                 <StackPanel
                     Margin="0,10,0,0"
                     Orientation="Horizontal"
@@ -56,7 +56,7 @@
                 </StackPanel>
                 <Slider HorizontalAlignment="Center" 
                         Value="{Binding ShaderTranslationDelay}"
-                        ToolTip.Tip="{Binding ShaderTranslationDelay}"
+                        ToolTip.Tip="{Binding ShaderTranslationDelayTooltipText}"
                         Width="175"
                         Margin="0,-3,0,0"
                         Height="32"

src/Ryujinx/Utilities/Configuration/ConfigurationState.Migration.cs

@@ -752,11 +752,12 @@ namespace Ryujinx.Ava.Utilities.Configuration
             Hacks.ShowDirtyHacks.Value = configurationFileFormat.ShowDirtyHacks;
 
             {
-                EnabledDirtyHack[] hacks = configurationFileFormat.DirtyHacks.Select(EnabledDirtyHack.FromPacked).ToArray();
+                EnabledDirtyHack[] hacks = (configurationFileFormat.DirtyHacks ?? []).Select(EnabledDirtyHack.Unpack).ToArray();
             
                 Hacks.Xc2MenuSoftlockFix.Value = hacks.Any(it => it.Hack == DirtyHacks.Xc2MenuSoftlockFix);
                 
-                var shaderCompilationThreadSleep = hacks.FirstOrDefault(it => it.Hack == DirtyHacks.ShaderCompilationThreadSleep);
+                var shaderCompilationThreadSleep = hacks.FirstOrDefault(it => 
+                    it.Hack == DirtyHacks.ShaderCompilationThreadSleep);
                 Hacks.EnableShaderCompilationThreadSleep.Value = shaderCompilationThreadSleep != null;
                 Hacks.ShaderCompilationThreadSleepDelay.Value = shaderCompilationThreadSleep?.Value ?? 0;
             }

src/Ryujinx/Utilities/Configuration/ConfigurationState.Model.cs

@@ -10,6 +10,7 @@ using Ryujinx.Common.Logging;
 using Ryujinx.HLE;
 using System.Collections.Generic;
 using System.Linq;
+using RyuLogger = Ryujinx.Common.Logging.Logger;
 
 namespace Ryujinx.Ava.Utilities.Configuration
 {
@@ -644,8 +645,19 @@ namespace Ryujinx.Ava.Utilities.Configuration
 
             private void HackChanged(object sender, ReactiveEventArgs<bool> rxe)
             {
-                Ryujinx.Common.Logging.Logger.Info?.Print(LogClass.Configuration, $"EnabledDirtyHacks set to: [{EnabledHacks.Select(x => x.Hack).JoinToString(", ")}]", "LogValueChange");
+                var newHacks = EnabledHacks.Select(x => x.Hack)
+                    .JoinToString(", ");
+
+                if (newHacks != _lastHackCollection)
+                {
+                    RyuLogger.Info?.Print(LogClass.Configuration, 
+                        $"EnabledDirtyHacks set to: [{_lastHackCollection}]", "LogValueChange");
+
+                    _lastHackCollection = newHacks;
                 }
+            }
+
+            private static string _lastHackCollection;
 
             public EnabledDirtyHack[] EnabledHacks
             {