potential fix for gradual performance degradation from music sources

Author: pandinocoder

.editorconfig

@@ -143,6 +143,7 @@ resharper_csharp_wrap_before_declaration_rpar = true
 resharper_csharp_wrap_before_invocation_rpar = true
 resharper_csharp_wrap_parameters_style = chop_if_long
 resharper_keep_existing_invocation_parens_arrangement = false
+resharper_keep_existing_primary_constructor_declaration_parens_arrangement = false
 resharper_keep_existing_property_patterns_arrangement = false
 resharper_max_initializer_elements_on_line = 2
 resharper_max_invocation_arguments_on_line = 5

Intersect.Client.Core/Core/Audio.cs

@@ -32,7 +32,7 @@ public static partial class Audio
     //Music
     private static string? sQueuedMusic = string.Empty;
 
-    private static GameAudioInstance? sMyMusic { get; set; }
+    private static GameAudioInstance? _activeMusicSource;
 
     //Init
     public static void Init()
@@ -48,7 +48,7 @@ public static void Init()
 
     public static void UpdateGlobalVolume()
     {
-        sMyMusic?.SetVolume(sMyMusic.GetVolume(), true);
+        _activeMusicSource?.Update();
         for (var i = 0; i < sGameSounds.Count; i++)
         {
             _ = sGameSounds[i].Update();
@@ -62,18 +62,25 @@ public static void UpdateGlobalVolume()
     //Update
     public static void Update()
     {
-        if (sMyMusic != null)
+        if (_activeMusicSource != null)
         {
+            _activeMusicSource.Update();
             var currentTime = Timing.Global.MillisecondsUtc;
             if (sFadeTimer != 0 && sFadeTimer < currentTime)
             {
                 if (sFadingOut)
                 {
-                    sMyMusic.SetVolume(sMyMusic.GetVolume() - 1, true);
-                    if (sMyMusic.GetVolume() <= 1 && !string.IsNullOrEmpty(sQueuedMusic))
+                    if (--_activeMusicSource.Volume < 1)
                     {
                         StopMusic();
-                        PlayMusic(sQueuedMusic, 0, sQueuedFade, sQueuedLoop);
+                        if (!string.IsNullOrEmpty(sQueuedMusic))
+                        {
+                            PlayMusic(sQueuedMusic, 0, sQueuedFade, sQueuedLoop);
+                        }
+                        else
+                        {
+                            sFadeTimer = currentTime + sFadeRate;
+                        }
                     }
                     else
                     {
@@ -82,8 +89,7 @@ public static void Update()
                 }
                 else
                 {
-                    sMyMusic.SetVolume(sMyMusic.GetVolume() + 1, true);
-                    if (sMyMusic.GetVolume() < 100)
+                    if (++_activeMusicSource.Volume < 100)
                     {
                         sFadeTimer = currentTime + sFadeRate;
                     }
@@ -132,12 +138,12 @@ public static void PlayMusic(string filename, int fadeout = 0, int fadein = 0, b
         ClearQueue();
 
         filename = GameContentManager.RemoveExtension(filename);
-        if (sMyMusic != null)
+        if (_activeMusicSource != null)
         {
             if (fadeout == 0 ||
-                sMyMusic.State == GameAudioInstance.AudioInstanceState.Stopped ||
-                sMyMusic.State == GameAudioInstance.AudioInstanceState.Paused ||
-                sMyMusic.GetVolume() == 0)
+                _activeMusicSource.State == GameAudioInstance.AudioInstanceState.Stopped ||
+                _activeMusicSource.State == GameAudioInstance.AudioInstanceState.Paused ||
+                _activeMusicSource.Volume < 1)
             {
                 StopMusic();
                 StartMusic(filename, fadein, loop);
@@ -181,16 +187,16 @@ private static void StartMusic(string filename, int fadein = 0, bool loop = fals
             return;
         }
 
-        if (sMyMusic != null)
+        if (_activeMusicSource != null)
         {
             ApplicationContext.Context.Value?.Logger.LogTrace($"Trying to start '{filename}' without properly closing '{sCurrentSong}'.");
         }
 
-        sMyMusic = music.CreateInstance();
+        _activeMusicSource = music.CreateInstance();
         sCurrentSong = filename;
-        sMyMusic.Play();
-        sMyMusic.SetVolume(0, true);
-        sMyMusic.IsLooping = loop;
+        _activeMusicSource.Play();
+        _activeMusicSource.Volume = 0;
+        _activeMusicSource.IsLooping = loop;
         sFadeRate = fadein / 100;
         sFadeTimer = Timing.Global.MillisecondsUtc + sFadeRate;
         sFadingOut = false;
@@ -202,26 +208,26 @@ private static void StartMusic(string filename, int fadein = 0, bool loop = fals
     /// <param name="fadeout">The time (in ms) it should take to fade out the current music track.</param>
     public static void StopMusic(int fadeout = 0)
     {
-        if (sMyMusic == null)
+        if (_activeMusicSource == null)
         {
             return;
         }
 
         if (fadeout == 0 ||
-            sMyMusic.State == GameAudioInstance.AudioInstanceState.Stopped ||
-            sMyMusic.State == GameAudioInstance.AudioInstanceState.Paused ||
-            sMyMusic.GetVolume() == 0)
+            _activeMusicSource.State == GameAudioInstance.AudioInstanceState.Stopped ||
+            _activeMusicSource.State == GameAudioInstance.AudioInstanceState.Paused ||
+            _activeMusicSource.Volume < 1)
         {
             sCurrentSong = string.Empty;
-            sMyMusic.Stop();
-            sMyMusic.Dispose();
-            sMyMusic = null;
+            _activeMusicSource.Stop();
+            _activeMusicSource.Dispose();
+            _activeMusicSource = null;
             sFadeTimer = 0;
         }
         else
         {
             //Start fadeout
-            sFadeRate = fadeout / sMyMusic.GetVolume();
+            sFadeRate = fadeout / Math.Max(1, _activeMusicSource.Volume);
             sFadeTimer = Timing.Global.MillisecondsUtc + sFadeRate;
             sFadingOut = true;
         }

Intersect.Client.Core/Core/Sounds/MapSound.cs

@@ -39,7 +39,7 @@ public MapSound(
         mY = y;
         mMapId = mapId;
         mEntity = parent;
-        mSound.SetVolume(0);
+        mSound.Volume = 0;
     }
 
     public void UpdatePosition(int x, int y, Guid mapId)
@@ -65,7 +65,10 @@ private void UpdateSoundVolume()
     {
         if (mMapId == Guid.Empty)
         {
-            mSound?.SetVolume(0);
+            if (mSound is { } sound)
+            {
+                sound.Volume = 0;
+            }
             return;
         }
 
@@ -78,23 +81,26 @@ private void UpdateSoundVolume()
 
         if (mX == -1 || mY == -1 || mDistance <= 0)
         {
-            mSound?.SetVolume(100);
+            if (mSound is { } sound)
+            {
+                sound.Volume = 100;
+            }
         }
         else
         {
+            var volume = 0f;
             if (mDistance > 0 && Globals.GridMaps.ContainsKey(mMapId))
             {
-                var volume = 100 - 100 / (mDistance + 1) * CalculateSoundDistance();
+                volume = 100 - 100 / ((mDistance + 1) * CalculateSoundDistance());
                 if (volume < 0)
                 {
                     volume = 0f;
                 }
-
-                mSound?.SetVolume((int)volume);
             }
-            else
+
+            if (mSound is { } sound)
             {
-                mSound?.SetVolume(0);
+                sound.Volume = (int)volume;
             }
         }
     }

Intersect.Client.Core/Core/Sounds/Sound.cs

@@ -40,8 +40,7 @@ public Sound(string filename, bool loop, int loopInterval)
         {
             mSound = sound.CreateInstance();
             mSound.IsLooping = mLoop && mLoopInterval <= 0;
-           
-            mSound.SetVolume(100);
+            mSound.Volume = 100;
             mSound.Play();
             Loaded = true;
         }
@@ -67,6 +66,8 @@ public virtual bool Update()
             return false;
         }
 
+        mSound?.Update();
+
         if (mLoop && mLoopInterval > 0 && mSound?.State == GameAudioInstance.AudioInstanceState.Stopped)
         {
             if (mStoppedTime == -1)
@@ -84,7 +85,8 @@ public virtual bool Update()
 
             return true;
         }
-        else if (mLoop || mSound?.State != GameAudioInstance.AudioInstanceState.Stopped)
+
+        if (mLoop || mSound?.State != GameAudioInstance.AudioInstanceState.Stopped)
         {
             return true;
         }