com.adrenak.univoice 4.4.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. Note that only Client and Server modes are currently supported. Host mode is not.  
+        - Mirror networking
 
   * 🎤 __Configurable Audio Input__: 
     - UniVoice is audio input agnostic. You can change the source of outgoing audio by implementing the `IAudioInput` interface.  
@@ -65,7 +65,7 @@ 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.
   
-> 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. Also note that the Host mode is not supported, your server should be in Server mode only.
+> 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/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

@@ -117,7 +117,7 @@ namespace Adrenak.UniVoice.Samples {
             // ---- 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} your peers are {string.Join(", ", peerIds)}");
+                Debug.unityLogger.Log(LogType.Log, TAG, $"You are Peer ID {id}");
             };
 
             client.OnLeft += () => {

package/package.json

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