Some changes to audio effect stack processing.

SineVector241 · SineVector241 · commit 3c66c2a11cdf · 2026-05-13T12:02:16.000+10:00
diff --git a/VoiceCraft.Network/Audio/Effects/DirectionalEffect.cs b/VoiceCraft.Network/Audio/Effects/DirectionalEffect.cs
@@ -15,7 +15,7 @@ public class DirectionalEffect : IAudioEffect
         [JsonIgnore]
         public ushort Bitmask { get; set; }
         
-        public event Action? OnDisposed;
+        public event Action<IAudioEffect>? OnDisposed;
         
         public float WetDry
         {
@@ -45,7 +45,7 @@ public void Dispose()
         {
             try
             {
-                OnDisposed?.Invoke();
+                OnDisposed?.Invoke(this);
             }
             finally
             {
diff --git a/VoiceCraft.Network/Audio/Effects/EchoEffect.cs b/VoiceCraft.Network/Audio/Effects/EchoEffect.cs
@@ -15,7 +15,7 @@ public class EchoEffect : IAudioEffect
     [JsonIgnore]
     public ushort Bitmask { get; set; }
     
-    public event Action? OnDisposed;
+    public event Action<IAudioEffect>? OnDisposed;
 
     public float Delay
     {
@@ -68,7 +68,7 @@ public void Dispose()
     {
         try
         {
-            OnDisposed?.Invoke();
+            OnDisposed?.Invoke(this);
         }
         finally
         {
diff --git a/VoiceCraft.Network/Audio/Effects/MuffleEffect.cs b/VoiceCraft.Network/Audio/Effects/MuffleEffect.cs
@@ -15,7 +15,7 @@ public class MuffleEffect : IAudioEffect
         [JsonIgnore]
         public ushort Bitmask { get; set; }
         
-        public event Action? OnDisposed;
+        public event Action<IAudioEffect>? OnDisposed;
         
         public float WetDry
         {
@@ -45,7 +45,7 @@ public void Dispose()
         {
             try
             {
-                OnDisposed?.Invoke();
+                OnDisposed?.Invoke(this);
             }
             finally
             {
diff --git a/VoiceCraft.Network/Audio/Effects/ProximityEchoEffect.cs b/VoiceCraft.Network/Audio/Effects/ProximityEchoEffect.cs
@@ -15,7 +15,7 @@ public class ProximityEchoEffect : IAudioEffect
         [JsonIgnore]
         public ushort Bitmask { get; set; }
         
-        public event Action? OnDisposed;
+        public event Action<IAudioEffect>? OnDisposed;
 
         public float Delay
         {
@@ -68,7 +68,7 @@ public void Dispose()
         {
             try
             {
-                OnDisposed?.Invoke();
+                OnDisposed?.Invoke(this);
             }
             finally
             {
diff --git a/VoiceCraft.Network/Audio/Effects/ProximityEffect.cs b/VoiceCraft.Network/Audio/Effects/ProximityEffect.cs
@@ -18,7 +18,7 @@ public class ProximityEffect : IAudioEffect, IVisible
         [JsonIgnore]
         public ushort Bitmask { get; set; }
         
-        public event Action? OnDisposed;
+        public event Action<IAudioEffect>? OnDisposed;
 
         public float MinRange { get; set; }
         public float MaxRange { get; set; }
@@ -65,7 +65,7 @@ public void Dispose()
         {
             try
             {
-                OnDisposed?.Invoke();
+                OnDisposed?.Invoke(this);
             }
             finally
             {
diff --git a/VoiceCraft.Network/Audio/Effects/ProximityMuffleEffect.cs b/VoiceCraft.Network/Audio/Effects/ProximityMuffleEffect.cs
@@ -1,10 +1,7 @@
 using System;
-using System.Collections.Generic;
 using System.Text.Json.Serialization;
 using LiteNetLib.Utils;
 using VoiceCraft.Core;
-using VoiceCraft.Core.Audio;
-using VoiceCraft.Core.World;
 using VoiceCraft.Network.Interfaces;
 
 namespace VoiceCraft.Network.Audio.Effects
@@ -18,7 +15,7 @@ public class ProximityMuffleEffect : IAudioEffect
         [JsonIgnore]
         public ushort Bitmask { get; set; }
         
-        public event Action? OnDisposed;
+        public event Action<IAudioEffect>? OnDisposed;
 
         public float WetDry
         {
@@ -48,7 +45,7 @@ public void Dispose()
         {
             try
             {
-                OnDisposed?.Invoke();
+                OnDisposed?.Invoke(this);
             }
             finally
             {
diff --git a/VoiceCraft.Network/Audio/Effects/VisibilityEffect.cs b/VoiceCraft.Network/Audio/Effects/VisibilityEffect.cs
@@ -14,7 +14,7 @@ public class VisibilityEffect : IAudioEffect, IVisible
         [JsonIgnore]
         public ushort Bitmask { get; set; }
         
-        public event Action? OnDisposed;
+        public event Action<IAudioEffect>? OnDisposed;
         
         public void Update(IAudioEffect audioEffect)
         {
@@ -44,7 +44,7 @@ public void Dispose()
         {
             try
             {
-                OnDisposed?.Invoke();
+                OnDisposed?.Invoke(this);
             }
             finally
             {
diff --git a/VoiceCraft.Network/Clients/VoiceCraftClient.cs b/VoiceCraft.Network/Clients/VoiceCraftClient.cs
@@ -589,12 +589,6 @@ private void HandleSetEntityVisibilityRequestPacket(VcSetEntityVisibilityRequest
 
     private void HandleOnEffectUpdatedPacket(VcOnEffectUpdatedPacket packet)
     {
-        if (packet.EffectType == EffectType.None)
-        {
-            AudioEffectSystem.SetEffect(packet.Bitmask, null);
-            return;
-        }
-
         AudioEffectSystem.SetEffect(packet.Bitmask, packet.Effect);
     }
 
diff --git a/VoiceCraft.Network/Interfaces/IAudioEffect.cs b/VoiceCraft.Network/Interfaces/IAudioEffect.cs
@@ -9,7 +9,7 @@ public interface IAudioEffect : INetSerializable, IDisposable
     {
         EffectType EffectType { get; }
         ushort Bitmask { get; set; }
-        event Action? OnDisposed;
+        event Action<IAudioEffect>? OnDisposed;
         void Update(IAudioEffect audioEffect);
 
         public static IAudioEffect? FromJsonElement(JsonElement element)
diff --git a/VoiceCraft.Network/Interfaces/IAudioEffectProcessor.cs b/VoiceCraft.Network/Interfaces/IAudioEffectProcessor.cs
@@ -3,8 +3,9 @@
 
 namespace VoiceCraft.Network.Interfaces;
 
-public interface IAudioEffectProcessor<T> : IDisposable where T : IAudioEffect
+public interface IAudioEffectProcessor : IDisposable
 {
-    T AudioEffect { get; }
+    IAudioEffect Effect { get; }
+    event Action<IAudioEffectProcessor>? OnDisposed;
     void Process(VoiceCraftEntity to, Span<float> buffer);
 }
diff --git a/VoiceCraft.Network/Systems/AudioEffectSystem.cs b/VoiceCraft.Network/Systems/AudioEffectSystem.cs
@@ -12,9 +12,10 @@ public class AudioEffectSystem : IDisposable
 {
     private readonly OrderedDictionary<ushort, IAudioEffect> _audioEffects = new();
     private OrderedDictionary<ushort, IAudioEffect> _defaultAudioEffects = new();
+
     private volatile ImmutableList<KeyValuePair<ushort, IAudioEffect>> _audioEffectsSnapshot =
         ImmutableList<KeyValuePair<ushort, IAudioEffect>>.Empty;
-    
+
     private readonly Lock _lock = new();
 
     public ImmutableList<KeyValuePair<ushort, IAudioEffect>> AudioEffects => _audioEffectsSnapshot;
@@ -50,8 +51,9 @@ public void SetEffect(ushort bitmask, IAudioEffect? effect)
             switch (effect)
             {
                 case null when _audioEffects.Remove(bitmask, out var audioEffect):
-                    audioEffect.Dispose();
                     _audioEffectsSnapshot = _audioEffects.ToImmutableList();
+                    audioEffect.OnDisposed -= RemoveEffect; //Unsubscribe from effect dispose as it has been removed.
+                    audioEffect.Dispose();
                     OnEffectSet?.Invoke(bitmask, null);
                     return;
                 case null:
@@ -67,11 +69,25 @@ public void SetEffect(ushort bitmask, IAudioEffect? effect)
                 return;
             }
 
-            oldEffect?.Dispose(); //Dispose previous effect.
+            effect.OnDisposed += RemoveEffect; //Subscribe to new effect.
             _audioEffects[bitmask] = effect;
             _audioEffectsSnapshot = _audioEffects.ToImmutableList();
+            oldEffect?.Dispose(); //Dispose old effect if it exists.
             OnEffectSet?.Invoke(bitmask, effect);
         }
+
+        return;
+
+        void RemoveEffect(IAudioEffect audioEffect)
+        {
+            lock (_lock)
+            {
+                audioEffect.OnDisposed -= RemoveEffect;
+                if (_audioEffects.Remove(bitmask, out _))
+                    //Update Snapshot if successfully removed.
+                    _audioEffectsSnapshot = _audioEffects.ToImmutableList();
+            }
+        }
     }
 
     public bool TryGetEffect(ushort bitmask, [NotNullWhen(true)] out IAudioEffect? effect)
diff --git a/VoiceCraft.Network/World/VoiceCraftClientEntity.cs b/VoiceCraft.Network/World/VoiceCraftClientEntity.cs
@@ -1,28 +1,34 @@
 using System;
+using System.Collections.Generic;
+using System.Threading;
 using System.Threading.Tasks;
 using VoiceCraft.Core;
 using VoiceCraft.Core.Audio;
 using VoiceCraft.Core.Interfaces;
 using VoiceCraft.Core.World;
 using VoiceCraft.Network.Audio;
+using VoiceCraft.Network.Interfaces;
 
 namespace VoiceCraft.Network.World;
 
 public class VoiceCraftClientEntity : VoiceCraftEntity
 {
     private readonly IAudioDecoder _decoder;
     private readonly JitterBuffer _jitterBuffer = new(TimeSpan.FromMilliseconds(100));
-
     private readonly SampleBufferProvider<float> _outputBuffer = new(Constants.OutputBufferSize)
         { PrefillSize = Constants.PrefillBufferSize };
-
     private DateTime _lastPacket = DateTime.MinValue;
+    private readonly Dictionary<ushort, IAudioEffectProcessor> _effectProcessors = new();
+
+    private readonly Lock _lock = new(); // For packet decoding.
+    private readonly Lock _audioLock = new(); // For reading, writing or changing effect processor stack.
 
     public VoiceCraftClientEntity(int id, IAudioDecoder decoder) : base(id)
     {
         _decoder = decoder;
         Task.Run(TaskLogicAsync);
     }
+    
 
     public bool IsVisible
     {
@@ -78,6 +84,39 @@ public bool Speaking
     public event Action<VoiceCraftClientEntity>? OnStartedSpeaking;
     public event Action<VoiceCraftClientEntity>? OnStoppedSpeaking;
 
+    public void SetEffectProcessor(ushort bitmask, IAudioEffectProcessor? processor)
+    {
+        lock (_audioLock)
+        {
+            switch (processor)
+            {
+                case null when _effectProcessors.Remove(bitmask, out var effectProcessor):
+                    effectProcessor.OnDisposed -= RemoveEffect; //Unsubscribe from effect dispose as it has been removed.
+                    effectProcessor.Dispose();
+                    return;
+                case null:
+                    return;
+            }
+
+            if (!_effectProcessors.TryGetValue(bitmask, out var oldProcessor))
+                processor.OnDisposed += RemoveEffect; //Subscribe to effect dispose if it's a new effect.
+            _effectProcessors[bitmask] = processor;
+            
+            //Dispose old processor if it exists.
+            oldProcessor?.Dispose();
+        }
+        return;
+        
+        void RemoveEffect(IAudioEffectProcessor effectProcessor)
+        {
+            lock (_audioLock)
+            {
+                effectProcessor.OnDisposed -= RemoveEffect;
+                _effectProcessors.Remove(bitmask, out _);
+            }
+        }
+    }
+
     public int Read(Span<float> buffer)
     {
         var read = 0;
@@ -87,7 +126,7 @@ public int Read(Span<float> buffer)
             return read;
         }
 
-        lock (_outputBuffer)
+        lock (_audioLock)
             read = _outputBuffer.Read(buffer);
         
         if (read <= 0)
@@ -102,7 +141,7 @@ public int Read(Span<float> buffer)
 
     public override void ReceiveAudio(byte[] buffer, ushort timestamp, float frameLoudness)
     {
-        lock (_jitterBuffer)
+        lock (_lock)
         {
             var packet = new JitterPacket(timestamp, buffer);
             _jitterBuffer.Add(packet);
@@ -113,8 +152,7 @@ public override void ReceiveAudio(byte[] buffer, ushort timestamp, float frameLo
 
     public override void Destroy()
     {
-        lock (_decoder)
-        lock (_jitterBuffer)
+        lock(_lock)
         {
             _jitterBuffer.Reset();
             _decoder.Dispose();
@@ -131,8 +169,7 @@ public override void Destroy()
 
     private void ClearBuffer()
     {
-        lock (_jitterBuffer)
-        lock (_outputBuffer)
+        lock (_lock)
         {
             _outputBuffer.Reset();
             _jitterBuffer.Reset(); //Also reset the jitter buffer.
@@ -144,7 +181,7 @@ private int GetNextPacket(Span<float> buffer)
         if (buffer.Length < Constants.FrameSize)
             return 0;
 
-        lock (_jitterBuffer)
+        lock (_lock)
         {
             try
             {
@@ -181,7 +218,7 @@ private async Task TaskLogicAsync()
                 Array.Clear(readBuffer); //Clear Read Buffer.
                 var read = GetNextPacket(readBuffer);
                 if (read <= 0 || UserMuted) continue;
-                lock (_outputBuffer)
+                lock (_audioLock)
                     _outputBuffer.Write(readBuffer.AsSpan(0, read));
             }
             catch

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public class DirectionalEffect : IAudioEffect`
`15`	`15`	`[JsonIgnore]`
`16`	`16`	`public ushort Bitmask { get; set; }`
`17`	`17`
`18`		`- public event Action? OnDisposed;`
	`18`	`+ public event Action<IAudioEffect>? OnDisposed;`
`19`	`19`
`20`	`20`	`public float WetDry`
`21`	`21`	`{`
`@@ -45,7 +45,7 @@ public void Dispose()`
`45`	`45`	`{`
`46`	`46`	`try`
`47`	`47`	`{`
`48`		`- OnDisposed?.Invoke();`
	`48`	`+ OnDisposed?.Invoke(this);`
`49`	`49`	`}`
`50`	`50`	`finally`
`51`	`51`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public class EchoEffect : IAudioEffect`
`15`	`15`	`[JsonIgnore]`
`16`	`16`	`public ushort Bitmask { get; set; }`
`17`	`17`
`18`		`- public event Action? OnDisposed;`
	`18`	`+ public event Action<IAudioEffect>? OnDisposed;`
`19`	`19`
`20`	`20`	`public float Delay`
`21`	`21`	`{`
`@@ -68,7 +68,7 @@ public void Dispose()`
`68`	`68`	`{`
`69`	`69`	`try`
`70`	`70`	`{`
`71`		`- OnDisposed?.Invoke();`
	`71`	`+ OnDisposed?.Invoke(this);`
`72`	`72`	`}`
`73`	`73`	`finally`
`74`	`74`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public class MuffleEffect : IAudioEffect`
`15`	`15`	`[JsonIgnore]`
`16`	`16`	`public ushort Bitmask { get; set; }`
`17`	`17`
`18`		`- public event Action? OnDisposed;`
	`18`	`+ public event Action<IAudioEffect>? OnDisposed;`
`19`	`19`
`20`	`20`	`public float WetDry`
`21`	`21`	`{`
`@@ -45,7 +45,7 @@ public void Dispose()`
`45`	`45`	`{`
`46`	`46`	`try`
`47`	`47`	`{`
`48`		`- OnDisposed?.Invoke();`
	`48`	`+ OnDisposed?.Invoke(this);`
`49`	`49`	`}`
`50`	`50`	`finally`
`51`	`51`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public class ProximityEchoEffect : IAudioEffect`
`15`	`15`	`[JsonIgnore]`
`16`	`16`	`public ushort Bitmask { get; set; }`
`17`	`17`
`18`		`- public event Action? OnDisposed;`
	`18`	`+ public event Action<IAudioEffect>? OnDisposed;`
`19`	`19`
`20`	`20`	`public float Delay`
`21`	`21`	`{`
`@@ -68,7 +68,7 @@ public void Dispose()`
`68`	`68`	`{`
`69`	`69`	`try`
`70`	`70`	`{`
`71`		`- OnDisposed?.Invoke();`
	`71`	`+ OnDisposed?.Invoke(this);`
`72`	`72`	`}`
`73`	`73`	`finally`
`74`	`74`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public class ProximityEffect : IAudioEffect, IVisible`
`18`	`18`	`[JsonIgnore]`
`19`	`19`	`public ushort Bitmask { get; set; }`
`20`	`20`
`21`		`- public event Action? OnDisposed;`
	`21`	`+ public event Action<IAudioEffect>? OnDisposed;`
`22`	`22`
`23`	`23`	`public float MinRange { get; set; }`
`24`	`24`	`public float MaxRange { get; set; }`
`@@ -65,7 +65,7 @@ public void Dispose()`
`65`	`65`	`{`
`66`	`66`	`try`
`67`	`67`	`{`
`68`		`- OnDisposed?.Invoke();`
	`68`	`+ OnDisposed?.Invoke(this);`
`69`	`69`	`}`
`70`	`70`	`finally`
`71`	`71`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,7 @@`
`1`	`1`	`using System;`
`2`		`-using System.Collections.Generic;`
`3`	`2`	`using System.Text.Json.Serialization;`
`4`	`3`	`using LiteNetLib.Utils;`
`5`	`4`	`using VoiceCraft.Core;`
`6`		`-using VoiceCraft.Core.Audio;`
`7`		`-using VoiceCraft.Core.World;`
`8`	`5`	`using VoiceCraft.Network.Interfaces;`
`9`	`6`
`10`	`7`	`namespace VoiceCraft.Network.Audio.Effects`
`@@ -18,7 +15,7 @@ public class ProximityMuffleEffect : IAudioEffect`
`18`	`15`	`[JsonIgnore]`
`19`	`16`	`public ushort Bitmask { get; set; }`
`20`	`17`
`21`		`- public event Action? OnDisposed;`
	`18`	`+ public event Action<IAudioEffect>? OnDisposed;`
`22`	`19`
`23`	`20`	`public float WetDry`
`24`	`21`	`{`
`@@ -48,7 +45,7 @@ public void Dispose()`
`48`	`45`	`{`
`49`	`46`	`try`
`50`	`47`	`{`
`51`		`- OnDisposed?.Invoke();`
	`48`	`+ OnDisposed?.Invoke(this);`
`52`	`49`	`}`
`53`	`50`	`finally`
`54`	`51`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public class VisibilityEffect : IAudioEffect, IVisible`
`14`	`14`	`[JsonIgnore]`
`15`	`15`	`public ushort Bitmask { get; set; }`
`16`	`16`
`17`		`- public event Action? OnDisposed;`
	`17`	`+ public event Action<IAudioEffect>? OnDisposed;`
`18`	`18`
`19`	`19`	`public void Update(IAudioEffect audioEffect)`
`20`	`20`	`{`
`@@ -44,7 +44,7 @@ public void Dispose()`
`44`	`44`	`{`
`45`	`45`	`try`
`46`	`46`	`{`
`47`		`- OnDisposed?.Invoke();`
	`47`	`+ OnDisposed?.Invoke(this);`
`48`	`48`	`}`
`49`	`49`	`finally`
`50`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -589,12 +589,6 @@ private void HandleSetEntityVisibilityRequestPacket(VcSetEntityVisibilityRequest`
`589`	`589`
`590`	`590`	`private void HandleOnEffectUpdatedPacket(VcOnEffectUpdatedPacket packet)`
`591`	`591`	`{`
`592`		`- if (packet.EffectType == EffectType.None)`
`593`		`- {`
`594`		`- AudioEffectSystem.SetEffect(packet.Bitmask, null);`
`595`		`- return;`
`596`		`- }`
`597`		`-`
`598`	`592`	`AudioEffectSystem.SetEffect(packet.Bitmask, packet.Effect);`
`599`	`593`	`}`
`600`	`594`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ public interface IAudioEffect : INetSerializable, IDisposable`
`9`	`9`	`{`
`10`	`10`	`EffectType EffectType { get; }`
`11`	`11`	`ushort Bitmask { get; set; }`
`12`		`- event Action? OnDisposed;`
	`12`	`+ event Action<IAudioEffect>? OnDisposed;`
`13`	`13`	`void Update(IAudioEffect audioEffect);`
`14`	`14`
`15`	`15`	`public static IAudioEffect? FromJsonElement(JsonElement element)`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,9 @@`
`3`	`3`
`4`	`4`	`namespace VoiceCraft.Network.Interfaces;`
`5`	`5`
`6`		`-public interface IAudioEffectProcessor<T> : IDisposable where T : IAudioEffect`
	`6`	`+public interface IAudioEffectProcessor : IDisposable`
`7`	`7`	`{`
`8`		`- T AudioEffect { get; }`
	`8`	`+ IAudioEffect Effect { get; }`
	`9`	`+ event Action<IAudioEffectProcessor>? OnDisposed;`
`9`	`10`	`void Process(VoiceCraftEntity to, Span<float> buffer);`
`10`	`11`	`}`