com.adrenak.univoice 4.3.0 → 4.5.0

package/README.md

@@ -10,7 +10,7 @@ Some features of UniVoice:
   * 🌐 __Configurable Network__: 
     - UniVoice is networking agnostic. Implement the `IAudioClient` and `IAudioServer` interfaces using the networking plugin of your choice to have it send audio data over any networking solution. 
     - Built-in support for:
-        - Mirror networking.  
+        - Mirror networking
 
   * 🎤 __Configurable Audio Input__: 
     - UniVoice is audio input agnostic. You can change the source of outgoing audio by implementing the `IAudioInput` interface.  
@@ -50,13 +50,22 @@ Ensure you have the NPM registry in the `manifest.json` file of your Unity proje
 ```
 Then add `com.adrenak.univoice:x.y.z` to the `dependencies` in your `manifest.json` file (where x.y.z is the version you wish to install). The list of versions is available on [the UniVoice NPM page](https://www.npmjs.com/package/com.adrenak.univoice?activeTab=versions).
 
-## Docs
-API reference is available here: http://www.vatsalambastha.com/univoice
+## Useful links
+* API reference is available here: http://www.vatsalambastha.com/univoice
+* UniVoice blog: https://blog.vatsalambastha.com/search/label/univoice
+* Discord server: https://discord.gg/Un6Y2sQqqe
+
+## Integration
+UniVoice isn't currently very drag-and-drop/low-code. The best way to integrate is to have some code perform a one time setup when your app starts and provides access to relevant objects that you can use throughout the rest of the apps runtime.
+
+An example of this is the `UniVoiceMirrorSetupSample.cs` file that gives you access to an AudioServer that you can use in your server code and a ClientSession that you can use in your client code. For more see the "Samples" section below.
 
 ## Samples
-This repository contains a sample scene for the Mirror network, which is the best place to see how UniVoice can be integrated into your project.  
+This repository contains two samples:
+* `UniVoiceMirrorSetupSample.cs` is a drag and drop component, a simple integration sample script. You can add it to your Mirror NetworkManager to get voice chat to work. No code required, it's as simple as that! It'll work as long as you have setup your project properly. For more instructions see the top of the `UniVoiceMirrorSetupSample.cs` file.
+* A sample scene that shows the other clients in a UI as well as allows you to mute yourself/them. This sample is also Mirror based.
   
-> The sample relies on Mirror networking to work. Follow the instructions below for enabling Mirror in your project before trying it out.
+> UniVoice currently only supports Mirror out of the box. All the samples rely on Mirror networking to work. Follow the instructions in the "Activating non-packaged dependencies" section below for enabling Mirror in your project before trying it out. 
   
 ## Dependencies
 [com.adrenak.brw](https://www.github.com/adrenak/brw) for reading and writing messages for communication. See `MirrorServer.cs` and `MirrorClient.cs` where they're used.  

package/Runtime/Impl/Inputs/EmptyAudioInput.cs

@@ -0,0 +1,22 @@
+using System;
+
+namespace Adrenak.UniVoice {
+    /// <summary>
+    /// An audio input implementation that doesn't do anything.
+    /// Use this when the device doesn't have any input mode. 
+    /// This is especially useful when setting up the ClientSession
+    /// object on a dedicated server that likely isn't going to have 
+    /// and mic or other audio capture devices.
+    /// </summary>
+    public class EmptyAudioInput : IAudioInput {
+        public int Frequency => 1;
+
+        public int ChannelCount => 1;
+
+        public int SegmentRate => 1;
+
+        public event Action<AudioFrame> OnFrameReady;
+
+        public void Dispose() { }
+    }
+}

package/Runtime/Impl/Inputs/EmptyAudioInput.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: f1db3d25938d78548877be424a98cdd5
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Impl/Networks/Mirror/MirrorClient.cs

@@ -29,27 +29,40 @@ namespace Adrenak.UniVoice.Networks {
         public event Action<int> OnPeerLeft;
         public event Action<int, AudioFrame> OnReceivedPeerAudioFrame;
 
+        readonly MirrorModeObserver mirrorEvents;
+
         public MirrorClient() {
             PeerIDs = new List<int>();
             YourVoiceSettings = new VoiceSettings();
 
-            NetworkManager.singleton.transport.OnClientConnected += OnClientConnected;
-            NetworkManager.singleton.transport.OnClientDisconnected += OnClientDisconnected;
+            mirrorEvents = MirrorModeObserver.New("for MirrorClient");
+            mirrorEvents.ModeChanged += OnModeChanged;
+
             NetworkClient.RegisterHandler<MirrorMessage>(OnReceivedMessage, false);
         }
 
         public void Dispose() {
-            NetworkManager.singleton.transport.OnClientConnected -= OnClientConnected;
-            NetworkManager.singleton.transport.OnClientDisconnected -= OnClientDisconnected;
-            NetworkClient.UnregisterHandler<MirrorMessage>();
+            PeerIDs.Clear();
         }
 
-        void OnClientConnected() {
+        void OnModeChanged(NetworkManagerMode oldMode, NetworkManagerMode newMode) {
+            // For some reason, handlers don't always work as expected when the connection mode changes
             NetworkClient.ReplaceHandler<MirrorMessage>(OnReceivedMessage);
+
+            bool clientOnlyToOffline = newMode == NetworkManagerMode.Offline && oldMode == NetworkManagerMode.ClientOnly;
+            bool hostToServerOnlyOrOffline = oldMode == NetworkManagerMode.Host;
+
+            if (clientOnlyToOffline || hostToServerOnlyOrOffline) {
+                // We unregister the handler only when the device was a client.
+                // If it was a Host that's now a ServerOnly, we still need the handler as it's used in MirrorServer
+                if (clientOnlyToOffline)
+                    NetworkClient.UnregisterHandler<MirrorMessage>();
+                
+                OnClientDisconnected();
+            }
         }
 
         void OnClientDisconnected() {
-            NetworkClient.ReplaceHandler<MirrorMessage>(OnReceivedMessage);
             YourVoiceSettings = new VoiceSettings();
             var oldPeerIds = PeerIDs;
             PeerIDs.Clear();
@@ -59,7 +72,6 @@ namespace Adrenak.UniVoice.Networks {
             OnLeft?.Invoke();
         }
 
-
         void OnReceivedMessage(MirrorMessage msg) {
             var reader = new BytesReader(msg.data);
             var tag = reader.ReadString();
@@ -69,13 +81,16 @@ namespace Adrenak.UniVoice.Networks {
                 // peers that are already connected to the server
                 case MirrorMessageTags.PEER_INIT:
                     ID = reader.ReadInt();
-                    Debug.unityLogger.Log(LogType.Log, TAG,
-                        $"Initialized with ID {ID}");
-                    OnJoined?.Invoke(ID, PeerIDs);
                     PeerIDs = reader.ReadIntArray().ToList();
-                    if(PeerIDs.Count > 0)
-                        Debug.unityLogger.Log(LogType.Log, TAG,
-                            $"Peers {string.Join(", ", PeerIDs)}");
+
+                    string log = $"Initialized with ID {ID}. ";
+                    if (PeerIDs.Count > 0)
+                        log += $"Peer list: {string.Join(", ", PeerIDs)}";
+                    else
+                        log += "There are currently no peers.";
+                    Debug.unityLogger.Log(LogType.Log, TAG, log);
+
+                    OnJoined?.Invoke(ID, PeerIDs);
                     foreach (var peerId in PeerIDs)
                         OnPeerJoined?.Invoke(peerId);
                     break;
@@ -84,9 +99,9 @@ namespace Adrenak.UniVoice.Networks {
                 case MirrorMessageTags.PEER_JOINED:
                     var newPeerID = reader.ReadInt();
                     if (!PeerIDs.Contains(newPeerID)) {
-                        Debug.unityLogger.Log(LogType.Log, TAG,
-                            $"Peer {newPeerID} has joined");
                         PeerIDs.Add(newPeerID);
+                        Debug.unityLogger.Log(LogType.Log, TAG,
+                            $"Peer {newPeerID} joined. Peer list is now {string.Join(", ", PeerIDs)}");
                         OnPeerJoined?.Invoke(newPeerID);
                     }
                     break;
@@ -95,9 +110,14 @@ namespace Adrenak.UniVoice.Networks {
                 case MirrorMessageTags.PEER_LEFT:
                     var leftPeerID = reader.ReadInt();
                     if (PeerIDs.Contains(leftPeerID)) {
-                        Debug.unityLogger.Log(LogType.Log, TAG,
-                            $"Peer {leftPeerID} has left");
                         PeerIDs.Remove(leftPeerID);
+                        string log2 = $"Peer {leftPeerID} left. ";
+                        if (PeerIDs.Count == 0)
+                            log2 += "There are no peers anymore.";
+                        else
+                            log2 += $"Peer list is now {string.Join(", ", PeerIDs)}";
+
+                        Debug.unityLogger.Log(LogType.Log, TAG, log2);
                         OnPeerLeft?.Invoke(leftPeerID);
                     }
                     break;

package/Runtime/Impl/Networks/Mirror/MirrorModeObserver.cs

@@ -11,6 +11,8 @@ namespace Adrenak.UniVoice.Networks {
     /// when it changes
     /// </summary>
     public class MirrorModeObserver : MonoBehaviour {
+        const string TAG = "[MirrorModeObserver]";
+
         /// <summary>
         /// Event fired when the Mirror NetworkManager changes the mode
         /// </summary>
@@ -25,8 +27,8 @@ namespace Adrenak.UniVoice.Networks {
         /// Creates a new instance of this class on a GameObject
         /// </summary>
         /// <returns></returns>
-        public static MirrorModeObserver New() {
-            var go = new GameObject("MirrorEventProvider");
+        public static MirrorModeObserver New(string name = "") {
+            var go = new GameObject($"MirrorEventProvider {name}");
             DontDestroyOnLoad(go);
             return go.AddComponent<MirrorModeObserver>();
         }
@@ -34,7 +36,12 @@ namespace Adrenak.UniVoice.Networks {
         void Update() {
             var newMode = NetworkManager.singleton.mode;
             if (lastMode != newMode) {
-                ModeChanged?.Invoke(lastMode, newMode);
+                try {
+                    ModeChanged?.Invoke(lastMode, newMode);
+                }
+                catch (Exception e) {
+                    Debug.Log(LogType.Error, TAG, "Exception while handling Mirror Mode change: " + e);
+                }
                 lastMode = newMode;
             }
         }

package/Runtime/Impl/Networks/Mirror/MirrorServer.cs

@@ -40,43 +40,64 @@ namespace Adrenak.UniVoice.Networks {
             ClientIDs = new List<int>();
             ClientVoiceSettings = new Dictionary<int, VoiceSettings>();
 
-            mirrorEvents = MirrorModeObserver.New();
+            mirrorEvents = MirrorModeObserver.New("for MirrorServer");
             mirrorEvents.ModeChanged += OnModeChanged;
 
             NetworkServer.RegisterHandler<MirrorMessage>(OnReceivedMessage, false);
+        }
+        
+        public void Dispose() {
+            mirrorEvents.ModeChanged -= OnModeChanged;
+            NetworkServer.UnregisterHandler<MirrorMessage>();
+            OnServerShutdown();
+        }
 
+        void OnServerStarted() {
 #if MIRROR_89_OR_NEWER
             NetworkManager.singleton.transport.OnServerConnectedWithAddress += OnServerConnected;
 #else
             NetworkManager.singleton.transport.OnServerConnected += OnServerConnected;
 #endif
             NetworkManager.singleton.transport.OnServerDisconnected += OnServerDisconnected;
+            OnServerStart?.Invoke();
         }
-        
-        void IDisposable.Dispose() {
-            mirrorEvents.ModeChanged -= OnModeChanged;
-
-            NetworkServer.UnregisterHandler<MirrorMessage>();
 
+        void OnServerShutdown() {
 #if MIRROR_89_OR_NEWER
             NetworkManager.singleton.transport.OnServerConnectedWithAddress -= OnServerConnected;
 #else
             NetworkManager.singleton.transport.OnServerConnected -= OnServerConnected;
-#endif
+#endif            
             NetworkManager.singleton.transport.OnServerDisconnected -= OnServerDisconnected;
+            ClientIDs.Clear();
+            ClientVoiceSettings.Clear();
+            OnServerStop?.Invoke();
         }
 
         void OnModeChanged(NetworkManagerMode oldMode, NetworkManagerMode newMode) {
+            // For some reason, handlers don't always work as expected when the connection mode changes
             NetworkServer.ReplaceHandler<MirrorMessage>(OnReceivedMessage, false);
 
-            if((newMode == NetworkManagerMode.ServerOnly || newMode == NetworkManagerMode.Host)
-            && (oldMode != NetworkManagerMode.ServerOnly && oldMode != NetworkManagerMode.Host)) {
-                OnServerStart?.Invoke();
+            // If in Host mode, the server and internal client have both started and the client connects immediately.
+            // The host client seems to have ID 0 always, so we trigger a new client connection using id 0.
+            if(newMode == NetworkManagerMode.Host) {
+                OnServerStarted();
+                OnServerConnected(0, "localhost");
+            }
+            else if(newMode == NetworkManagerMode.ServerOnly) {
+                // If a Host changes to ServerOnly, we disconnect the internal client
+                if (oldMode == NetworkManagerMode.Host)
+                    OnServerDisconnected(0);
+                // But if this machine is going from Offline to ServerOnly, only the server is starting
+                else if(oldMode == NetworkManagerMode.Offline)
+                    OnServerStarted();
             }
-            else if(newMode == NetworkManagerMode.Offline) {
-                ClientIDs.Clear();
-                ClientVoiceSettings.Clear();
-                OnServerStop?.Invoke();
+            // If a Host or ServerOnly goes offline 
+            else if(newMode == NetworkManagerMode.Offline && (oldMode == NetworkManagerMode.ServerOnly || oldMode == NetworkManagerMode.Host)) {
+                // We check if it was a Host before and disconnect the internal client
+                if (oldMode == NetworkManagerMode.Host)
+                    OnServerDisconnected(0);
+                OnServerShutdown();
             }
         }
 
@@ -146,6 +167,7 @@ namespace Adrenak.UniVoice.Networks {
 #else
         void OnServerConnected(int connId) {
 #endif
+            // Not sure if this needs to be done, but being extra cautious here
             NetworkServer.ReplaceHandler<MirrorMessage>(OnReceivedMessage, false);
 
             Debug.unityLogger.Log(LogType.Log, TAG, $"Client {connId} connected");
@@ -172,9 +194,10 @@ namespace Adrenak.UniVoice.Networks {
                     // required but I faced some issues with immediate initialization earlier.
                     SendToClientDelayed(connId, newClientPacket.Bytes, Channels.Reliable, 100);
 
-                    string peerListString = string.Join(", ", otherPeerIDs);
-                    Debug.unityLogger.Log(LogType.Log, TAG, 
-                        $"Initializing new client with ID {connId} and peer list {peerListString}");
+                    string log = $"Initializing new client with ID {connId}";
+                    if (otherPeerIDs.Length > 0)
+                        log += $" and peer list {string.Join(", ", otherPeerIDs)}";
+                    Debug.unityLogger.Log(LogType.Log, TAG, log);
                 }
                 // To the already existing peers, we let them know a new peer has joined
                 // by sending the new peer ID to them.
@@ -191,11 +214,11 @@ namespace Adrenak.UniVoice.Networks {
         }
 
         void OnServerDisconnected(int connId) {
+            // Not sure if this needs to be done, but being extra cautious here
             NetworkServer.ReplaceHandler<MirrorMessage>(OnReceivedMessage, false);
 
             ClientIDs.Remove(connId);
-            Debug.unityLogger.Log(LogType.Log, TAG,
-                $"Client {connId} disconnected");
+            Debug.unityLogger.Log(LogType.Log, TAG, $"Client {connId} disconnected");
 
             // Notify all remaining peers that a peer has left 
             foreach (var peerId in ClientIDs) {

package/Samples~/Basic Setup Scripts/UniVoiceMirrorSetupSample.cs

@@ -0,0 +1,199 @@
+using UnityEngine;
+
+using Adrenak.UniMic;
+using Adrenak.UniVoice.Networks;
+using Adrenak.UniVoice.Outputs;
+using Adrenak.UniVoice.Inputs;
+using Adrenak.UniVoice.Filters;
+
+namespace Adrenak.UniVoice.Samples {
+    /// <summary>
+    /// To get this setup sample to work, ensure that you have done the following:
+    /// - Import Mirror and add the UNIVOICE_NETWORK_MIRROR compilation symbol to your project
+    /// - If you want to use RNNoise filter, import RNNoise4Unity into your project and add UNIVOICE_FILTER_RNNOISE4UNITY
+    /// - Add this component to the first scene of your Unity project
+    /// 
+    /// *** More info on adding and activating non packaged dependencies is here: https://github.com/adrenak/univoice?tab=readme-ov-file#activating-non-packaged-dependencies ***
+    /// 
+    /// This is a basic integration script that uses the following to setup UniVoice:
+    /// - <see cref="MirrorServer"/>, an implementation of <see cref="IAudioServer{T}"/> 
+    /// - <see cref="MirrorClient"/>, an implementation of <see cref="IAudioClient{T}"/> 
+    /// - <see cref="UniMicInput"/>, an implementation of <see cref="IAudioInput"/> that captures audio from a mic
+    /// - <see cref="EmptyAudioInput"/>, an implementation of <see cref="IAudioInput"/> that is basically
+    /// an idle audio input used when there is no input device
+    /// - <see cref="RNNoiseFilter"/>, an implementation of <see cref="IAudioFilter"/> that removes noise from
+    /// captured audio. 
+    /// - <see cref="ConcentusEncodeFilter"/>, an implementation of <see cref="IAudioFilter"/> that encodes captured audio
+    /// using Concentus (C# Opus) to reduce the size of audio frames
+    /// - <see cref="ConcentusDecodeFilter"/>, an implementation of <see cref="IAudioFilter"/> that decodes incoming audio
+    /// using Concentus to decode and make the audio frame playable.
+    /// </summary>
+    public class UniVoiceMirrorSetupSample : MonoBehaviour {
+        const string TAG = "[BasicUniVoiceSetupSample]";
+
+        /// <summary>
+        /// Whether UniVoice has been setup successfully. This field will return true if the setup was successful.
+        /// It runs on both server and client.
+        /// </summary>
+        public static bool HasSetUp { get; private set; }
+
+        /// <summary>
+        /// The server object.
+        /// </summary>
+        public static IAudioServer<int> AudioServer { get; private set; }
+
+        /// <summary>
+        /// The client session.
+        /// </summary>
+        public static ClientSession<int> ClientSession { get; private set; }
+
+        [SerializeField] bool useRNNoise4UnityIfAvailable = true;
+
+        [SerializeField] bool useConcentusEncodeAndDecode = true;
+
+        void Start() {
+            if (HasSetUp) {
+                Debug.unityLogger.Log(LogType.Log, TAG, "UniVoice is already set up. Ignoring...");
+                return;
+            }
+            HasSetUp = Setup();
+        }
+
+        bool Setup() {
+            Debug.unityLogger.Log(LogType.Log, TAG, "Trying to setup UniVoice");
+
+            bool failed = false;
+
+            // Set setup the AudioServer and ClientSession on ALL builds. This means that you'd
+            // have a ClientSession on a dedicated server, even though there's not much you can do with it.
+            // Similarly, a client would also have an AudioServer object. But it would just be inactive.
+            // This sample is for ease of use and to get something working quickly, so we don't bother
+            // with these minor details. Note that doing so does not have any performance implications
+            // so you can do this, so you could keep this approach without any tradeoffs.
+            var createdAudioServer = SetupAudioServer();
+            if (!createdAudioServer) {
+                Debug.unityLogger.Log(LogType.Error, TAG, "Could not setup UniVoice server.");
+                failed = true;
+            }
+
+            var setupAudioClient = SetupClientSession();
+            if (!setupAudioClient) {
+                Debug.unityLogger.Log(LogType.Error, TAG, "Could not setup UniVoice client.");
+                failed = true;
+            }
+
+            if (!failed)
+                Debug.unityLogger.Log(LogType.Log, TAG, "UniVoice successfully setup!");
+            else
+                Debug.unityLogger.Log(LogType.Error, TAG, $"Refer to the notes on top of {typeof(UniVoiceMirrorSetupSample).Name}.cs for setup instructions.");
+            return !failed;
+        }
+
+        bool SetupAudioServer() {
+#if UNIVOICE_NETWORK_MIRROR
+            // ---- CREATE AUDIO SERVER AND SUBSCRIBE TO EVENTS TO PRINT LOGS ----
+            // We create a server. If this code runs in server mode, MirrorServer will take care
+            // or automatically handling all incoming messages. On a device connecting as a client,
+            // this code doesn't do anything.
+            AudioServer = new MirrorServer();
+            Debug.unityLogger.Log(LogType.Log, TAG, "Created MirrorServer object");
+
+            AudioServer.OnServerStart += () => {
+                Debug.unityLogger.Log(LogType.Log, TAG, "Server started");
+            };
+
+            AudioServer.OnServerStop += () => {
+                Debug.unityLogger.Log(LogType.Log, TAG, "Server stopped");
+            };
+            return true;
+#else
+            Debug.unityLogger.Log(LogType.Error, TAG, "MirrorServer implementation not found!");
+            return false;
+#endif
+        }
+
+        bool SetupClientSession() {
+#if UNIVOICE_NETWORK_MIRROR
+            // ---- CREATE AUDIO CLIENT AND SUBSCRIBE TO EVENTS ----
+            IAudioClient<int> client = new MirrorClient();
+            client.OnJoined += (id, peerIds) => {
+                Debug.unityLogger.Log(LogType.Log, TAG, $"You are Peer ID {id}");
+            };
+
+            client.OnLeft += () => {
+                Debug.unityLogger.Log(LogType.Log, TAG, "You left the chatroom");
+            };
+
+            // When a peer joins, we instantiate a new peer view 
+            client.OnPeerJoined += id => {
+                Debug.unityLogger.Log(LogType.Log, TAG, $"Peer {id} joined");
+            };
+
+            // When a peer leaves, destroy the UI representing them
+            client.OnPeerLeft += id => {
+                Debug.unityLogger.Log(LogType.Log, TAG, $"Peer {id} left");
+            };
+
+            Debug.unityLogger.Log(LogType.Log, TAG, "Created MirrorClient object");
+
+            // ---- CREATE AUDIO INPUT ----
+            IAudioInput input;
+            // Since in this sample we use microphone input via UniMic, we first check if there
+            // are any mic devices available.
+            Mic.Init(); // Must do this to use the Mic class
+            if (Mic.AvailableDevices.Count == 0) {
+                Debug.unityLogger.Log(LogType.Log, TAG, "Device has no microphones." +
+                "Will only be able to hear other clients, cannot send any audio.");
+                input = new EmptyAudioInput();
+                Debug.unityLogger.Log(LogType.Log, TAG, "Created EmptyAudioInput");
+            }
+            else {
+                // Get the first recording device that we have available and start it.
+                // Then we create a UniMicInput instance that requires the mic object
+                // For more info on UniMic refer to https://www.github.com/adrenak/unimic
+                var mic = Mic.AvailableDevices[0];
+                mic.StartRecording(60);
+                Debug.unityLogger.Log(LogType.Log, TAG, "Started recording with Mic device named." +
+                mic.Name + $" at frequency {mic.SamplingFrequency} with frame duration {mic.FrameDurationMS} ms.");
+                input = new UniMicInput(mic);
+                Debug.unityLogger.Log(LogType.Log, TAG, "Created UniMicInput");
+            }
+
+            // ---- CREATE AUDIO OUTPUT FACTORY ----
+            IAudioOutputFactory outputFactory;
+            // We want the incoming audio from peers to be played via the StreamedAudioSourceOutput
+            // implementation of IAudioSource interface. So we get the factory for it.
+            outputFactory = new StreamedAudioSourceOutput.Factory();
+            Debug.unityLogger.Log(LogType.Log, TAG, "Using StreamedAudioSourceOutput.Factory as output factory");
+
+            // ---- CREATE CLIENT SESSION AND ADD FILTERS TO IT ----
+            // With the client, input and output factory ready, we create create the client session
+            ClientSession = new ClientSession<int>(client, input, outputFactory);
+            Debug.unityLogger.Log(LogType.Log, TAG, "Created session");
+
+#if UNIVOICE_FILTER_RNNOISE4UNITY
+            if(useRNNoise4UnityIfAvailable) {
+                // RNNoiseFilter to remove noise from captured audio
+                session.InputFilters.Add(new RNNoiseFilter());
+                Debug.unityLogger.Log(LogType.Log, TAG, "Registered RNNoiseFilter as an input filter");
+            }
+#endif
+
+            if (useConcentusEncodeAndDecode) {
+                // ConcentureEncoder filter to encode captured audio that reduces the audio frame size
+                ClientSession.InputFilters.Add(new ConcentusEncodeFilter());
+                Debug.unityLogger.Log(LogType.Log, TAG, "Registered ConcentusEncodeFilter as an input filter");
+
+                // For incoming audio register the ConcentusDecodeFilter to decode the encoded audio received from other clients 
+                ClientSession.OutputFilters.Add(new ConcentusDecodeFilter());
+                Debug.unityLogger.Log(LogType.Log, TAG, "Registered ConcentusDecodeFilter as an output filter");
+            }
+
+            return true;
+#else
+            Debug.unityLogger.Log(LogType.Error, TAG, "MirrorClient implementation not found!");
+            return false;
+#endif
+        }
+    }
+}

package/Samples~/Basic Setup Scripts/UniVoiceMirrorSetupSample.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: d0dec1d2df214b44f8cb106b071695ce
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Samples~/Basic Setup Scripts/UniVoiceMirrorSetupSample.unity

@@ -0,0 +1,435 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!29 &1
+OcclusionCullingSettings:
+  m_ObjectHideFlags: 0
+  serializedVersion: 2
+  m_OcclusionBakeSettings:
+    smallestOccluder: 5
+    smallestHole: 0.25
+    backfaceThreshold: 100
+  m_SceneGUID: 00000000000000000000000000000000
+  m_OcclusionCullingData: {fileID: 0}
+--- !u!104 &2
+RenderSettings:
+  m_ObjectHideFlags: 0
+  serializedVersion: 9
+  m_Fog: 0
+  m_FogColor: {r: 0.5, g: 0.5, b: 0.5, a: 1}
+  m_FogMode: 3
+  m_FogDensity: 0.01
+  m_LinearFogStart: 0
+  m_LinearFogEnd: 300
+  m_AmbientSkyColor: {r: 0.212, g: 0.227, b: 0.259, a: 1}
+  m_AmbientEquatorColor: {r: 0.114, g: 0.125, b: 0.133, a: 1}
+  m_AmbientGroundColor: {r: 0.047, g: 0.043, b: 0.035, a: 1}
+  m_AmbientIntensity: 1
+  m_AmbientMode: 0
+  m_SubtractiveShadowColor: {r: 0.42, g: 0.478, b: 0.627, a: 1}
+  m_SkyboxMaterial: {fileID: 10304, guid: 0000000000000000f000000000000000, type: 0}
+  m_HaloStrength: 0.5
+  m_FlareStrength: 1
+  m_FlareFadeSpeed: 3
+  m_HaloTexture: {fileID: 0}
+  m_SpotCookie: {fileID: 10001, guid: 0000000000000000e000000000000000, type: 0}
+  m_DefaultReflectionMode: 0
+  m_DefaultReflectionResolution: 128
+  m_ReflectionBounces: 1
+  m_ReflectionIntensity: 1
+  m_CustomReflection: {fileID: 0}
+  m_Sun: {fileID: 0}
+  m_IndirectSpecularColor: {r: 0.44657874, g: 0.49641275, b: 0.5748172, a: 1}
+  m_UseRadianceAmbientProbe: 0
+--- !u!157 &3
+LightmapSettings:
+  m_ObjectHideFlags: 0
+  serializedVersion: 12
+  m_GIWorkflowMode: 1
+  m_GISettings:
+    serializedVersion: 2
+    m_BounceScale: 1
+    m_IndirectOutputScale: 1
+    m_AlbedoBoost: 1
+    m_EnvironmentLightingMode: 0
+    m_EnableBakedLightmaps: 1
+    m_EnableRealtimeLightmaps: 0
+  m_LightmapEditorSettings:
+    serializedVersion: 12
+    m_Resolution: 2
+    m_BakeResolution: 40
+    m_AtlasSize: 1024
+    m_AO: 0
+    m_AOMaxDistance: 1
+    m_CompAOExponent: 1
+    m_CompAOExponentDirect: 0
+    m_ExtractAmbientOcclusion: 0
+    m_Padding: 2
+    m_LightmapParameters: {fileID: 0}
+    m_LightmapsBakeMode: 1
+    m_TextureCompression: 1
+    m_FinalGather: 0
+    m_FinalGatherFiltering: 1
+    m_FinalGatherRayCount: 256
+    m_ReflectionCompression: 2
+    m_MixedBakeMode: 2
+    m_BakeBackend: 1
+    m_PVRSampling: 1
+    m_PVRDirectSampleCount: 32
+    m_PVRSampleCount: 512
+    m_PVRBounces: 2
+    m_PVREnvironmentSampleCount: 256
+    m_PVREnvironmentReferencePointCount: 2048
+    m_PVRFilteringMode: 1
+    m_PVRDenoiserTypeDirect: 1
+    m_PVRDenoiserTypeIndirect: 1
+    m_PVRDenoiserTypeAO: 1
+    m_PVRFilterTypeDirect: 0
+    m_PVRFilterTypeIndirect: 0
+    m_PVRFilterTypeAO: 0
+    m_PVREnvironmentMIS: 1
+    m_PVRCulling: 1
+    m_PVRFilteringGaussRadiusDirect: 1
+    m_PVRFilteringGaussRadiusIndirect: 5
+    m_PVRFilteringGaussRadiusAO: 2
+    m_PVRFilteringAtrousPositionSigmaDirect: 0.5
+    m_PVRFilteringAtrousPositionSigmaIndirect: 2
+    m_PVRFilteringAtrousPositionSigmaAO: 1
+    m_ExportTrainingData: 0
+    m_TrainingDataDestination: TrainingData
+    m_LightProbeSampleCountMultiplier: 4
+  m_LightingDataAsset: {fileID: 0}
+  m_LightingSettings: {fileID: 0}
+--- !u!196 &4
+NavMeshSettings:
+  serializedVersion: 2
+  m_ObjectHideFlags: 0
+  m_BuildSettings:
+    serializedVersion: 2
+    agentTypeID: 0
+    agentRadius: 0.5
+    agentHeight: 2
+    agentSlope: 45
+    agentClimb: 0.4
+    ledgeDropHeight: 0
+    maxJumpAcrossDistance: 0
+    minRegionArea: 2
+    manualCellSize: 0
+    cellSize: 0.16666667
+    manualTileSize: 0
+    tileSize: 256
+    accuratePlacement: 0
+    maxJobWorkers: 0
+    preserveTilesOutsideBounds: 0
+    debug:
+      m_Flags: 0
+  m_NavMeshData: {fileID: 0}
+--- !u!1 &169645566
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 169645568}
+  - component: {fileID: 169645567}
+  m_Layer: 0
+  m_Name: Directional Light
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!108 &169645567
+Light:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 169645566}
+  m_Enabled: 1
+  serializedVersion: 10
+  m_Type: 1
+  m_Shape: 0
+  m_Color: {r: 1, g: 0.95686275, b: 0.8392157, a: 1}
+  m_Intensity: 1
+  m_Range: 10
+  m_SpotAngle: 30
+  m_InnerSpotAngle: 21.80208
+  m_CookieSize: 10
+  m_Shadows:
+    m_Type: 2
+    m_Resolution: -1
+    m_CustomResolution: -1
+    m_Strength: 1
+    m_Bias: 0.05
+    m_NormalBias: 0.4
+    m_NearPlane: 0.2
+    m_CullingMatrixOverride:
+      e00: 1
+      e01: 0
+      e02: 0
+      e03: 0
+      e10: 0
+      e11: 1
+      e12: 0
+      e13: 0
+      e20: 0
+      e21: 0
+      e22: 1
+      e23: 0
+      e30: 0
+      e31: 0
+      e32: 0
+      e33: 1
+    m_UseCullingMatrixOverride: 0
+  m_Cookie: {fileID: 0}
+  m_DrawHalo: 0
+  m_Flare: {fileID: 0}
+  m_RenderMode: 0
+  m_CullingMask:
+    serializedVersion: 2
+    m_Bits: 4294967295
+  m_RenderingLayerMask: 1
+  m_Lightmapping: 4
+  m_LightShadowCasterMode: 0
+  m_AreaSize: {x: 1, y: 1}
+  m_BounceIntensity: 1
+  m_ColorTemperature: 6570
+  m_UseColorTemperature: 0
+  m_BoundingSphereOverride: {x: 0, y: 0, z: 0, w: 0}
+  m_UseBoundingSphereOverride: 0
+  m_UseViewFrustumForShadowCasterCull: 1
+  m_ShadowRadius: 0
+  m_ShadowAngle: 0
+--- !u!4 &169645568
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 169645566}
+  m_LocalRotation: {x: 0.40821788, y: -0.23456968, z: 0.10938163, w: 0.8754261}
+  m_LocalPosition: {x: 0, y: 3, z: 0}
+  m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
+  m_Children: []
+  m_Father: {fileID: 0}
+  m_RootOrder: 1
+  m_LocalEulerAnglesHint: {x: 50, y: -30, z: 0}
+--- !u!1 &419491085
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 419491088}
+  - component: {fileID: 419491087}
+  - component: {fileID: 419491086}
+  m_Layer: 0
+  m_Name: Main Camera
+  m_TagString: MainCamera
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!81 &419491086
+AudioListener:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 419491085}
+  m_Enabled: 1
+--- !u!20 &419491087
+Camera:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 419491085}
+  m_Enabled: 1
+  serializedVersion: 2
+  m_ClearFlags: 1
+  m_BackGroundColor: {r: 0.19215687, g: 0.3019608, b: 0.4745098, a: 0}
+  m_projectionMatrixMode: 1
+  m_GateFitMode: 2
+  m_FOVAxisMode: 0
+  m_SensorSize: {x: 36, y: 24}
+  m_LensShift: {x: 0, y: 0}
+  m_FocalLength: 50
+  m_NormalizedViewPortRect:
+    serializedVersion: 2
+    x: 0
+    y: 0
+    width: 1
+    height: 1
+  near clip plane: 0.3
+  far clip plane: 1000
+  field of view: 60
+  orthographic: 0
+  orthographic size: 5
+  m_Depth: -1
+  m_CullingMask:
+    serializedVersion: 2
+    m_Bits: 4294967295
+  m_RenderingPath: -1
+  m_TargetTexture: {fileID: 0}
+  m_TargetDisplay: 0
+  m_TargetEye: 3
+  m_HDR: 1
+  m_AllowMSAA: 1
+  m_AllowDynamicResolution: 0
+  m_ForceIntoRT: 0
+  m_OcclusionCulling: 1
+  m_StereoConvergence: 10
+  m_StereoSeparation: 0.022
+--- !u!4 &419491088
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 419491085}
+  m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
+  m_LocalPosition: {x: 0, y: 1, z: -10}
+  m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
+  m_Children: []
+  m_Father: {fileID: 0}
+  m_RootOrder: 0
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
+--- !u!1 &1902381426
+GameObject:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  serializedVersion: 6
+  m_Component:
+  - component: {fileID: 1902381428}
+  - component: {fileID: 1902381427}
+  - component: {fileID: 1902381429}
+  - component: {fileID: 1902381430}
+  - component: {fileID: 1902381431}
+  m_Layer: 0
+  m_Name: NetworkManager
+  m_TagString: Untagged
+  m_Icon: {fileID: 0}
+  m_NavMeshLayer: 0
+  m_StaticEditorFlags: 0
+  m_IsActive: 1
+--- !u!114 &1902381427
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1902381426}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 8aab4c8111b7c411b9b92cf3dbc5bd4e, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  dontDestroyOnLoad: 1
+  runInBackground: 1
+  headlessStartMode: 1
+  editorAutoStart: 0
+  sendRate: 60
+  offlineScene: 
+  onlineScene: 
+  offlineSceneLoadDelay: 0
+  transport: {fileID: 1902381429}
+  networkAddress: localhost
+  maxConnections: 100
+  disconnectInactiveConnections: 0
+  disconnectInactiveTimeout: 60
+  authenticator: {fileID: 0}
+  playerPrefab: {fileID: 0}
+  autoCreatePlayer: 0
+  playerSpawnMethod: 0
+  spawnPrefabs: []
+  exceptionsDisconnect: 1
+  snapshotSettings:
+    bufferTimeMultiplier: 2
+    bufferLimit: 32
+    catchupNegativeThreshold: -1
+    catchupPositiveThreshold: 1
+    catchupSpeed: 0.019999999552965164
+    slowdownSpeed: 0.03999999910593033
+    driftEmaDuration: 1
+    dynamicAdjustment: 1
+    dynamicAdjustmentTolerance: 1
+    deliveryTimeEmaDuration: 2
+  evaluationMethod: 0
+  evaluationInterval: 3
+  timeInterpolationGui: 0
+--- !u!4 &1902381428
+Transform:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1902381426}
+  m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
+  m_LocalPosition: {x: 0, y: 0, z: 0}
+  m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
+  m_Children: []
+  m_Father: {fileID: 0}
+  m_RootOrder: 2
+  m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
+--- !u!114 &1902381429
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1902381426}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: c7424c1070fad4ba2a7a96b02fbeb4bb, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  port: 7777
+  NoDelay: 1
+  SendTimeout: 5000
+  ReceiveTimeout: 30000
+  serverMaxMessageSize: 16384
+  serverMaxReceivesPerTick: 10000
+  serverSendQueueLimitPerConnection: 10000
+  serverReceiveQueueLimitPerConnection: 10000
+  clientMaxMessageSize: 16384
+  clientMaxReceivesPerTick: 1000
+  clientSendQueueLimit: 10000
+  clientReceiveQueueLimit: 10000
+--- !u!114 &1902381430
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1902381426}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: d0dec1d2df214b44f8cb106b071695ce, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  useRNNoise4UnityIfAvailable: 1
+  useConcentusEncodeAndDecode: 1
+--- !u!114 &1902381431
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1902381426}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 6442dc8070ceb41f094e44de0bf87274, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  offsetX: 0
+  offsetY: 0

package/Samples~/Basic Setup Scripts/UniVoiceMirrorSetupSample.unity.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: e2397deac1a1ddc489d2e846a22708fa
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Samples~/Basic Setup Scripts.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 7974694d7a30f894db7efac8d8d46573
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "com.adrenak.univoice",
-    "version": "4.3.0",
+    "version": "4.5.0",
     "displayName": "Adrenak.UniVoice",
     "description": "Voice chat/VoIP framework for Unity.",
     "unity": "2021.2",