Hot reload resources (#5443)

* Fix ResPath CanonPath

Apparently this is supposed to standardise to / but this isn't always the case. Alternatively we could just assert for performance reasons I'm good with either. The comment as written says this should happen.

* Fixes

* change

* assert

* Fix bad respath input

* Buffer

* Merge conflicts

* review

* Fix

Robust.Client/Audio/AudioManager.Public.cs

@@ -84,6 +84,19 @@ public void SetRotation(Angle angle)
         AL.Listener(ALListenerfv.Orientation, ref at, ref up);
     }
 
+    void IAudioInternal.Remove(AudioStream stream)
+    {
+        if (stream.ClydeHandle == null)
+            return;
+
+        if (!_audioSampleBuffers.Remove(stream.BufferId))
+        {
+            return;
+        }
+
+        AL.DeleteBuffer(stream.BufferId);
+    }
+
     /// <inheritdoc/>
     public AudioStream LoadAudioOggVorbis(Stream stream, string? name = null)
     {
@@ -120,9 +133,9 @@ public AudioStream LoadAudioOggVorbis(Stream stream, string? name = null)
         _checkAlError();
 
         var handle = new ClydeHandle(_audioSampleBuffers.Count);
-        _audioSampleBuffers.Add(new LoadedAudioSample(buffer));
+        _audioSampleBuffers.Add(buffer, new LoadedAudioSample(buffer));
         var length = TimeSpan.FromSeconds(vorbis.TotalSamples / (double) vorbis.SampleRate);
-        return new AudioStream(handle, length, (int) vorbis.Channels, name, vorbis.Title, vorbis.Artist);
+        return new AudioStream(this, buffer, handle, length, (int) vorbis.Channels, name, vorbis.Title, vorbis.Artist);
     }
 
     /// <inheritdoc/>
@@ -179,9 +192,9 @@ public AudioStream LoadAudioWav(Stream stream, string? name = null)
         _checkAlError();
 
         var handle = new ClydeHandle(_audioSampleBuffers.Count);
-        _audioSampleBuffers.Add(new LoadedAudioSample(buffer));
+        _audioSampleBuffers.Add(buffer, new LoadedAudioSample(buffer));
         var length = TimeSpan.FromSeconds(wav.Data.Length / (double) wav.BlockAlign / wav.SampleRate);
-        return new AudioStream(handle, length, wav.NumChannels, name);
+        return new AudioStream(this, buffer, handle, length, wav.NumChannels, name);
     }
 
     /// <inheritdoc/>
@@ -210,8 +223,8 @@ public AudioStream LoadAudioRaw(ReadOnlySpan<short> samples, int channels, int s
 
         var handle = new ClydeHandle(_audioSampleBuffers.Count);
         var length = TimeSpan.FromSeconds((double) samples.Length / channels / sampleRate);
-        _audioSampleBuffers.Add(new LoadedAudioSample(buffer));
-        return new AudioStream(handle, length, channels, name);
+        _audioSampleBuffers.Add(buffer, new LoadedAudioSample(buffer));
+        return new AudioStream(this, buffer, handle, length, channels, name);
     }
 
     public void SetMasterGain(float newGain)
@@ -293,7 +306,7 @@ internal void RemoveBufferedAudioSource(int handle)
 
         // ReSharper disable once PossibleInvalidOperationException
         // TODO: This really shouldn't be indexing based on the ClydeHandle...
-        AL.Source(source, ALSourcei.Buffer, _audioSampleBuffers[(int) stream.ClydeHandle!.Value].BufferHandle);
+        AL.Source(source, ALSourcei.Buffer, _audioSampleBuffers[stream.BufferId].BufferHandle);
 
         var audioSource = new AudioSource(this, source, stream);
         _audioSources.Add(source, new WeakReference<BaseAudioSource>(audioSource));
@@ -370,5 +383,12 @@ public void DisposeAllAudio()
         }
 
         _bufferedAudioSources.Clear();
+
+        foreach (var buffer in _audioSampleBuffers.Values)
+        {
+            DeleteAudioBufferOnMainThread(buffer.BufferHandle);
+        }
+
+        _audioSampleBuffers.Clear();
     }
 }

Robust.Client/Audio/AudioManager.cs

@@ -5,6 +5,7 @@
 using OpenTK.Audio.OpenAL;
 using OpenTK.Audio.OpenAL.Extensions.Creative.EFX;
 using Robust.Client.Audio.Sources;
+using Robust.Client.ResourceManagement;
 using Robust.Shared;
 using Robust.Shared.Audio;
 using Robust.Shared.Configuration;
@@ -17,13 +18,15 @@ internal sealed partial class AudioManager : IAudioInternal
 {
     [Shared.IoC.Dependency] private readonly IConfigurationManager _cfg = default!;
     [Shared.IoC.Dependency] private readonly ILogManager _logMan = default!;
+    [Shared.IoC.Dependency] private readonly IReloadManager _reload = default!;
+    [Shared.IoC.Dependency] private readonly IResourceCache _cache = default!;
 
     private Thread? _gameThread;
 
     private ALDevice _openALDevice;
     private ALContext _openALContext;
 
-    private readonly List<LoadedAudioSample> _audioSampleBuffers = new();
+    private readonly Dictionary<int, LoadedAudioSample> _audioSampleBuffers = new();
 
     private readonly Dictionary<int, WeakReference<BaseAudioSource>> _audioSources =
         new();
@@ -116,6 +119,22 @@ private void InitializeAudio()
         IsEfxSupported = HasAlDeviceExtension("ALC_EXT_EFX");
 
         _cfg.OnValueChanged(CVars.AudioMasterVolume, SetMasterGain, true);
+
+        _reload.Register("/Audio", "*.ogg");
+        _reload.Register("/Audio", "*.wav");
+
+        _reload.OnChanged += OnReload;
+    }
+
+    private void OnReload(ResPath args)
+    {
+        if (args.Extension != "ogg" &&
+            args.Extension != "wav")
+        {
+            return;
+        }
+
+        _cache.ReloadResource<AudioResource>(args);
     }
 
     internal bool IsMainThread()

Robust.Client/Audio/AudioStream.cs

@@ -6,22 +6,36 @@ namespace Robust.Client.Audio;
 /// <summary>
 /// Has the metadata for a particular audio stream as well as the relevant internal handle to it.
 /// </summary>
-public sealed class AudioStream
+public sealed class AudioStream : IDisposable
 {
+    private IAudioInternal _audio;
+
+    /// <summary>
+    /// Buffer ID for this audio in AL.
+    /// </summary>
+    internal int BufferId { get; }
+
     public TimeSpan Length { get; }
     internal IClydeHandle? ClydeHandle { get; }
     public string? Name { get; }
     public string? Title { get; }
     public string? Artist { get; }
     public int ChannelCount { get; }
 
-    internal AudioStream(IClydeHandle? handle, TimeSpan length, int channelCount, string? name = null, string? title = null, string? artist = null)
+    internal AudioStream(IAudioInternal internalAudio, int bufferId, IClydeHandle? handle, TimeSpan length, int channelCount, string? name = null, string? title = null, string? artist = null)
     {
+        _audio = internalAudio;
+        BufferId = bufferId;
         ClydeHandle = handle;
         Length = length;
         ChannelCount = channelCount;
         Name = name;
         Title = title;
         Artist = artist;
     }
+
+    public void Dispose()
+    {
+        _audio.Remove(this);
+    }
 }

Robust.Client/Audio/HeadlessAudioManager.cs

@@ -13,6 +13,8 @@ namespace Robust.Client.Audio;
 /// </summary>
 internal sealed class HeadlessAudioManager : IAudioInternal
 {
+    private int _audioBuffer;
+
     /// <inheritdoc />
     public void InitializePostWindowing()
     {
@@ -65,6 +67,11 @@ public void SetAttenuation(Attenuation attenuation)
     {
     }
 
+    /// <inheritdoc />
+    public void Remove(AudioStream stream)
+    {
+    }
+
     /// <inheritdoc />
     public void StopAllAudio()
     {
@@ -101,11 +108,11 @@ public AudioStream LoadAudioWav(Stream stream, string? name = null)
     public AudioStream LoadAudioRaw(ReadOnlySpan<short> samples, int channels, int sampleRate, string? name = null)
     {
         var length = TimeSpan.FromSeconds((double) samples.Length / channels / sampleRate);
-        return new AudioStream(null, length, channels, name);
+        return new AudioStream(this, _audioBuffer++, null, length, channels, name);
     }
 
-    private static AudioStream AudioStreamFromMetadata(AudioMetadata metadata, string? name)
+    private AudioStream AudioStreamFromMetadata(AudioMetadata metadata, string? name)
     {
-        return new AudioStream(null, metadata.Length, metadata.ChannelCount, name, metadata.Title, metadata.Artist);
+        return new AudioStream(this, _audioBuffer++, null, metadata.Length, metadata.ChannelCount, name, metadata.Title, metadata.Artist);
     }
 }

Robust.Client/Audio/IAudioInternal.cs

@@ -44,6 +44,8 @@ internal interface IAudioInternal : IAudioManager
 
     void SetAttenuation(Attenuation attenuation);
 
+    void Remove(AudioStream stream);
+
     /// <summary>
     /// Stops all audio from playing.
     /// </summary>

Robust.Client/Audio/IAudioManager.cs

@@ -1,6 +1,5 @@
 using System;
 using System.IO;
-using Robust.Client.Audio.Sources;
 using Robust.Shared.Audio.Sources;
 
 namespace Robust.Client.Audio;
@@ -11,7 +10,7 @@ namespace Robust.Client.Audio;
 public interface IAudioManager
 {
     IAudioSource? CreateAudioSource(AudioStream stream);
-  
+
     AudioStream LoadAudioOggVorbis(Stream stream, string? name = null);
 
     AudioStream LoadAudioWav(Stream stream, string? name = null);

Robust.Client/Audio/Sources/AudioSource.cs

@@ -13,15 +13,15 @@ internal sealed class AudioSource : BaseAudioSource
     /// <summary>
     /// Underlying stream to the audio.
     /// </summary>
-    private readonly AudioStream _sourceStream;
+    internal readonly AudioStream SourceStream;
 
 #if DEBUG
     private bool _didPositionWarning;
 #endif
 
     public AudioSource(AudioManager master, int sourceHandle, AudioStream sourceStream) : base(master, sourceHandle)
     {
-        _sourceStream = sourceStream;
+        SourceStream = sourceStream;
     }
 
     /// <inheritdoc />
@@ -47,13 +47,13 @@ public override Vector2 Position
 #if DEBUG
             // OpenAL doesn't seem to want to play stereo positionally.
             // Log a warning if people try to.
-            if (_sourceStream.ChannelCount > 1 && !_didPositionWarning)
+            if (SourceStream.ChannelCount > 1 && !_didPositionWarning)
             {
                 _didPositionWarning = true;
                 Master.OpenALSawmill.Warning("Attempting to set position on audio source with multiple audio channels! Stream: '{0}'.  Make sure the audio is MONO, not stereo.",
-                    _sourceStream.Name);
+                    SourceStream.Name);
                 // warning isn't enough, people just ignore it :(
-                DebugTools.Assert(false, $"Attempting to set position on audio source with multiple audio channels! Stream: '{_sourceStream.Name}'. Make sure the audio is MONO, not stereo.");
+                DebugTools.Assert(false, $"Attempting to set position on audio source with multiple audio channels! Stream: '{SourceStream.Name}'. Make sure the audio is MONO, not stereo.");
             }
 #endif
 

Robust.Client/ClientIoC.cs

@@ -46,6 +46,7 @@
 using Robust.Shared.Serialization;
 using Robust.Shared.Timing;
 using Robust.Shared.Upload;
+using Robust.Shared.Utility;
 using Robust.Shared.ViewVariables;
 
 namespace Robust.Client
@@ -102,6 +103,7 @@ public static void RegisterIoC(GameController.DisplayMode mode, IDependencyColle
             deps.Register<ProfViewManager>();
             deps.Register<IGamePrototypeLoadManager, GamePrototypeLoadManager>();
             deps.Register<NetworkResourceManager>();
+            deps.Register<IReloadManager, ReloadManager>();
 
             switch (mode)
             {

Robust.Client/GameController/GameController.cs

@@ -93,6 +93,7 @@ internal sealed partial class GameController : IGameControllerInternal
         [Dependency] private readonly IReplayPlaybackManager _replayPlayback = default!;
         [Dependency] private readonly IReplayRecordingManagerInternal _replayRecording = default!;
         [Dependency] private readonly IReflectionManager _reflectionManager = default!;
+        [Dependency] private readonly IReloadManager _reload = default!;
 
         private IWebViewManagerHook? _webViewHook;
 
@@ -185,6 +186,7 @@ internal bool StartupContinue(DisplayMode displayMode)
             // before prototype load.
             ProgramShared.FinishCheckBadFileExtensions(checkBadExtensions);
 
+            _reload.Initialize();
             _reflectionManager.Initialize();
             _prototypeManager.Initialize();
             _prototypeManager.LoadDefaultPrototypes();

Robust.Client/Graphics/Clyde/Clyde.cs

@@ -10,6 +10,7 @@
 using Robust.Client.Map;
 using Robust.Client.ResourceManagement;
 using Robust.Client.UserInterface;
+using Robust.Client.Utility;
 using Robust.Shared;
 using Robust.Shared.Configuration;
 using Robust.Shared.ContentPack;
@@ -23,6 +24,7 @@
 using Robust.Shared.Profiling;
 using Robust.Shared.Prototypes;
 using Robust.Shared.Timing;
+using Robust.Shared.Utility;
 using TextureWrapMode = Robust.Shared.Graphics.TextureWrapMode;
 
 namespace Robust.Client.Graphics.Clyde
@@ -48,6 +50,8 @@ internal sealed partial class Clyde : IClydeInternal, IPostInjectInit, IEntityEv
         [Dependency] private readonly ILocalizationManager _loc = default!;
         [Dependency] private readonly IInputManager _inputManager = default!;
         [Dependency] private readonly ClientEntityManager _entityManager = default!;
+        [Dependency] private readonly IPrototypeManager _proto = default!;
+        [Dependency] private readonly IReloadManager _reloads = default!;
 
         private GLUniformBuffer<ProjViewMatrices> ProjViewUBO = default!;
         private GLUniformBuffer<UniformConstants> UniformConstantsUBO = default!;
@@ -99,6 +103,16 @@ public bool InitializePreWindowing()
             _sawmillOgl = _logManager.GetSawmill("clyde.ogl");
             _sawmillWin = _logManager.GetSawmill("clyde.win");
 
+            _reloads.Register("/Shaders", "*.swsl");
+            _reloads.Register("/Textures/Shaders", "*.swsl");
+            _reloads.Register("/Textures", "*.jpg");
+            _reloads.Register("/Textures", "*.jpeg");
+            _reloads.Register("/Textures", "*.png");
+            _reloads.Register("/Textures", "*.webp");
+
+            _reloads.OnChanged += OnChange;
+            _proto.PrototypesReloaded += OnProtoReload;
+
             _cfg.OnValueChanged(CVars.DisplayOGLCheckErrors, b => _checkGLErrors = b, true);
             _cfg.OnValueChanged(CVars.DisplayVSync, VSyncChanged, true);
             _cfg.OnValueChanged(CVars.DisplayWindowMode, WindowModeChanged, true);
@@ -122,6 +136,38 @@ public bool InitializePreWindowing()
             return InitWindowing();
         }
 
+        private void OnProtoReload(PrototypesReloadedEventArgs obj)
+        {
+            if (!obj.WasModified<ShaderPrototype>())
+                return;
+
+            foreach (var shader in obj.ByType[typeof(ShaderPrototype)].Modified.Keys)
+            {
+                _resourceCache.ReloadResource<ShaderSourceResource>(shader);
+            }
+        }
+
+        private void OnChange(ResPath obj)
+        {
+            if ((obj.TryRelativeTo(new ResPath("/Shaders"), out _) || obj.TryRelativeTo(new ResPath("/Textures/Shaders"), out _)) && obj.Extension == "swsl")
+            {
+                _resourceCache.ReloadResource<ShaderSourceResource>(obj);
+            }
+
+            if (obj.TryRelativeTo(new ResPath("/Textures"), out _) && !obj.TryRelativeTo(new ResPath("/Textures/Tiles"), out _))
+            {
+                if (obj.Extension == "jpg" || obj.Extension == "jpeg" || obj.Extension == "webp")
+                {
+                    _resourceCache.ReloadResource<TextureResource>(obj);
+                }
+
+                if (obj.Extension == "png")
+                {
+                    _resourceCache.ReloadResource<TextureResource>(obj);
+                }
+            }
+        }
+
         public bool InitializePostWindowing()
         {
             _gameThread = Thread.CurrentThread;