com.adrenak.univoice 2.0.1 → 3.0.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.0.2](https://github.com/adrenak/univoice/compare/v2.0.1...v2.0.2) (2022-11-02)
+
+
+### Bug Fixes
+
+* remove comment about possible PeerID in IAudioOutput ([2246bb2](https://github.com/adrenak/univoice/commit/2246bb2bef234b84bdf6cd55a9faf87e09133953))
+
+## [1.2.1](https://github.com/adrenak/univoice/compare/v1.2.0...v1.2.1) (2022-10-10)
+
+
+### Bug Fixes
+
+* PeersOutputs gets filled as peers join, not when they start ([42eaeb9](https://github.com/adrenak/univoice/commit/42eaeb95eef4eea7ee559da9fdbcac78ceb941b4))
+
 # [1.2.0](https://github.com/adrenak/univoice/compare/v1.1.4...v1.2.0) (2022-09-20)
 
 

package/Runtime/ChatroomAgent.cs

@@ -1,12 +1,17 @@
 using System;
 using System.Linq;
 using System.Collections.Generic;
+using System.Diagnostics;
+
+using Debug = UnityEngine.Debug;
 
 namespace Adrenak.UniVoice {
     /// <summary>
     /// Provides the means to host or connect to a chatroom.
     /// </summary>
     public class ChatroomAgent : IDisposable {
+        const string TAG = "ChatroomAgent";
+
         // ====================================================================
         #region PROPERTIES
         // ====================================================================
@@ -33,14 +38,29 @@ namespace Adrenak.UniVoice {
         /// There is a <see cref="IAudioOutput"/> for each peer that gets
         /// created using the provided <see cref="AudioOutputFactory"/>
         /// The <see cref="IAudioOutput"/> instance corresponding to a peer is
-        /// responsible for playing the audio that we receive that peer. 
+        /// responsible for playing the audio that we receive from that peer. 
         /// </summary>
         public Dictionary<short, IAudioOutput> PeerOutputs;
 
+        /// <summary>
+        /// Fired when the <see cref="CurrentMode"/> changes.
+        /// </summary>
+        public Action<ChatroomAgentMode> OnModeChanged;
+
         /// <summary>
         /// The current <see cref="ChatroomAgentMode"/> of this agent
         /// </summary>
-        public ChatroomAgentMode CurrentMode { get; private set; }
+        public ChatroomAgentMode CurrentMode {
+            get => _currentMode;
+            private set {
+                if(_currentMode != value) {
+                    _currentMode = value;
+                    OnModeChanged?.Invoke(value);
+                    Debug.unityLogger.Log(TAG, "Current Mode set to " + value);
+                }
+            }
+        }
+        ChatroomAgentMode _currentMode = ChatroomAgentMode.Unconnected;
 
         /// <summary>
         /// Mutes all the peers. If set to true, no incoming audio from other 
@@ -69,13 +89,14 @@ namespace Adrenak.UniVoice {
         #endregion
 
         // ====================================================================
-        #region CONSTRUCTION / DISPOSAL
+        #region CONSTRUCTION AND DISPOSAL
         // ====================================================================
         /// <summary>
         /// Creates and returns a new agent using the provided dependencies.
+        /// The instance then makes the dependencies work together.
         /// </summary>
         /// 
-        /// <param name="chatroomNetwork">The chatroom network implementation
+        /// <param name="chatroomNetwork">The chatroom network implementation  
         /// for chatroom access and sending data to peers in a chatroom.
         /// </param>
         /// 
@@ -105,7 +126,8 @@ namespace Adrenak.UniVoice {
             PeerSettings = new Dictionary<short, ChatroomPeerSettings>();
             PeerOutputs = new Dictionary<short, IAudioOutput>();
 
-            Init();
+            Debug.unityLogger.Log(TAG, "Created");
+            SetupEventListeners();
         }
 
         /// <summary>
@@ -115,6 +137,7 @@ namespace Adrenak.UniVoice {
         /// instances and/or using them outside this instance.
         /// </summary>
         public void Dispose() {
+            Debug.unityLogger.Log(TAG, "Disposing");
             AudioInput.Dispose();
 
             RemoveAllPeers();
@@ -122,54 +145,62 @@ namespace Adrenak.UniVoice {
             PeerOutputs.Clear();
 
             Network.Dispose();
+            Debug.unityLogger.Log(TAG, "Disposed");
         }
         #endregion
 
         // ====================================================================
         #region INTERNAL 
         // ====================================================================
-        void Init() {
-            // Node server events
-            Network.OnCreatedChatroom += () =>
+        void SetupEventListeners() {
+            Debug.unityLogger.Log(TAG, "Setting up events.");
+
+            // Network events
+            Network.OnCreatedChatroom += () => {
+                Debug.unityLogger.Log(TAG, "Chatroom created.");
                 CurrentMode = ChatroomAgentMode.Host;
+            };
             Network.OnClosedChatroom += () => {
-                CurrentMode = ChatroomAgentMode.Unconnected;
+                Debug.unityLogger.Log(TAG, "Chatroom closed.");
                 RemoveAllPeers();
+                CurrentMode = ChatroomAgentMode.Unconnected;
             };
-
-            // Node client events
             Network.OnJoinedChatroom += id => {
+                Debug.unityLogger.Log(TAG, "Joined chatroom.");
                 CurrentMode = ChatroomAgentMode.Guest;
             };
-            Network.OnLeftChatroom += () =>
+            Network.OnLeftChatroom += () => {
+                Debug.unityLogger.Log(TAG, "Left chatroom.");
                 RemoveAllPeers();
-            Network.OnPeerJoinedChatroom += id => 
+                CurrentMode = ChatroomAgentMode.Unconnected;
+            };
+            Network.OnPeerJoinedChatroom += id => {
+                Debug.unityLogger.Log(TAG, "New peer joined: " + id);
                 AddPeer(id);
-            Network.OnPeerLeftChatroom += id =>
+            };
+            Network.OnPeerLeftChatroom += id => {
+                Debug.unityLogger.Log(TAG, "Peer left: " + id);
                 RemovePeer(id);
+            };
 
             // Stream the incoming audio data using the right peer output
             Network.OnAudioReceived += (peerID, data) => {
-                // if we're muting all, no point continuing.
+                // if we're muting all, do nothing.
                 if (MuteOthers) return;
 
-                var index = data.segmentIndex;
-                var frequency = data.frequency;
-                var channels = data.channelCount;
-                var samples = data.samples;
-
-                if (HasSettingsForPeer(peerID) && !PeerSettings[peerID].muteThem)
-                    PeerOutputs[peerID].Feed(index, frequency, channels, samples);
+                if (AllowIncomingAudioFromPeer(peerID))
+                    PeerOutputs[peerID].Feed(data);
             };
 
             AudioInput.OnSegmentReady += (index, samples) => {
+                if (CurrentMode == ChatroomAgentMode.Unconnected) return;
+                
+                // If we're muting ourselves to all, do nothing.
                 if (MuteSelf) return;
 
                 // Get all the recipients we haven't muted ourselves to
                 var recipients = Network.PeerIDs
-                    .Where(x => {
-                        return HasSettingsForPeer(x) && !PeerSettings[x].muteSelf;
-                    });
+                    .Where(id => AllowOutgoingAudioToPeer(id));
 
                 // Send the audio segment to every deserving recipient
                 foreach (var recipient in recipients)
@@ -180,35 +211,50 @@ namespace Adrenak.UniVoice {
                         samples = samples
                     });
             };
+            Debug.unityLogger.Log(TAG, "Event setup completed.");
         }
 
         void AddPeer(short id) {
-            if (!PeerSettings.ContainsKey(id))
-                PeerSettings.Add(id, new ChatroomPeerSettings());
-            if(!PeerOutputs.ContainsKey(id)) {
-                var output = AudioOutputFactory.Create(
-                    AudioInput.Frequency,
-                    AudioInput.ChannelCount,
-                    AudioInput.Frequency * AudioInput.ChannelCount / AudioInput.SegmentRate
-                );
-                output.ID = id.ToString();
-                PeerOutputs.Add(id, output);
-            }
+            // Ensure no old settings or outputs exist for this ID.
+            RemovePeer(id);
+
+            PeerSettings.Add(id, new ChatroomPeerSettings());
+            
+            var output = AudioOutputFactory.Create(
+                AudioInput.Frequency,
+                AudioInput.ChannelCount,
+                AudioInput.Frequency * AudioInput.ChannelCount / AudioInput.SegmentRate
+            );
+            output.ID = id.ToString();
+            PeerOutputs.Add(id, output);
+            Debug.unityLogger.Log(TAG, "Added peer " + id);
         }
 
         void RemovePeer(short id) {
-            if (PeerSettings.ContainsKey(id))
+            if (PeerSettings.ContainsKey(id)) {
                 PeerSettings.Remove(id);
+                Debug.unityLogger.Log(TAG, "Removed peer settings for ID " + id);
+            }
             if (PeerOutputs.ContainsKey(id)) {
                 PeerOutputs[id].Dispose();
                 PeerOutputs.Remove(id);
+                Debug.unityLogger.Log(TAG, "Removed peer output for ID " + id);
             }
         }
 
-        void RemoveAllPeers() =>
-            PeerSettings.Keys.ToList().ForEach(x => RemovePeer(x));
+        bool AllowIncomingAudioFromPeer(short id) {
+            return PeerSettings.ContainsKey(id) && !PeerSettings[id].muteThem;
+        }
+
+        bool AllowOutgoingAudioToPeer(short id) {
+            return PeerSettings.ContainsKey(id) && !PeerSettings[id].muteSelf;
+        }
 
-        bool HasSettingsForPeer(short id) => PeerSettings.ContainsKey(id);
+        void RemoveAllPeers() {
+            Debug.unityLogger.Log(TAG, "Removing all peers");
+            foreach(var peer in Network.PeerIDs) 
+                RemovePeer(peer);
+        }
         #endregion
     }
 }

package/Runtime/Interfaces/IAudioInput.cs

@@ -26,7 +26,7 @@ namespace Adrenak.UniVoice {
         /// <summary>
         /// The number of segments (a segment is a sequence of audio samples)
         /// that are emitted from the source every second.
-        /// A 16000 Hz source with one channel at a rate of 10 
+        /// Eg. A 16000 Hz source with one channel at a rate of 10 
         /// will output an array of 1600 samples every 100 milliseconds.
         /// A 44000 Hz source with two channels at a rate of 10 
         /// will output an array of 8800 samples every 100 milliseconds.

package/Runtime/Interfaces/IAudioOutput.cs

@@ -5,13 +5,11 @@ namespace Adrenak.UniVoice {
     /// Responsible for playing audio that is sent to it. 
     /// You'd normally want a <see cref="UnityEngine.AudioSource"/> 
     /// based implementation to play the audio in Unity. But this class can 
-    /// be used in other ways just as streaming the received audio to a server
+    /// be used in other ways such as streaming the received audio to a server
     /// or writing it to a local file. It's just an audio output and the 
-    /// destination doesn't matter.
+    /// destination depends on your implementation.
     /// </summary>
     public interface IAudioOutput : IDisposable {
-        // TODO: Maybe introduce a PeerID property?
-
         /// <summary>
         /// An ID associated with this audio output
         /// </summary>
@@ -36,10 +34,12 @@ namespace Adrenak.UniVoice {
         /// <param name="audioSamples">
         /// The audio samples/segment being fed
         /// </param>
-        void Feed(int segmentIndex,
-            int frequency,
-            int channelCount,
-            float[] audioSamples
-        );
+        void Feed(int segmentIndex, int frequency, int channelCount, float[] audioSamples);
+
+        /// <summary>
+        /// Feeds a <see cref="ChatroomAudioSegment"/> object to the audio output.
+        /// </summary>
+        /// <param name="segment">The audio data to be sent.</param>
+        void Feed(ChatroomAudioSegment segment);
     }
 }

package/Runtime/Interfaces/IAudioOutputFactory.cs.meta

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

package/Runtime/Interfaces/IChatroomNetwork.cs

@@ -46,8 +46,10 @@ namespace Adrenak.UniVoice {
         /// <summary>
         /// Fired when a peer joins the chatroom. 
         /// Provides the ID of the peer as event data.
-        /// This action also MUST be called for all previously
-        /// existing peers when we connect to a network.
+        /// NOTE: This action also MUST be called for all previously
+        /// existing peers when a local user connects to a network.
+        /// This allows the local user to know about the users that
+        /// were in the chatroom before they joined.
         /// </summary>
         event Action<short> OnPeerJoinedChatroom;
 
@@ -59,11 +61,15 @@ namespace Adrenak.UniVoice {
 
         /// <summary>
         /// Fired when the network receives audio data from a peer. 
+        /// The first argument is the ID of the user the audio came from.
+        /// The second is the audio segment.
         /// </summary>
         event Action<short, ChatroomAudioSegment> OnAudioReceived;
 
         /// <summary>
         /// Fired when the local user sets audio data to a peer.
+        /// The first argument is the ID of the user the audio was sent to.
+        /// The second is the audio segment.
         /// </summary>
         event Action<short, ChatroomAudioSegment> OnAudioSent;
         #endregion
@@ -77,7 +83,7 @@ namespace Adrenak.UniVoice {
         short OwnID { get; }
 
         /// <summary>
-        /// IDs of all the peers in the current chatroom
+        /// IDs of all the peers in the current chatroom (excluding <see cref="OwnID"/>)
         /// </summary>
         List<short> PeerIDs { get; }
         #endregion
@@ -88,25 +94,25 @@ namespace Adrenak.UniVoice {
         /// <summary>
         /// Creates a chatroom 
         /// </summary>
-        /// <param name="data">Name of the chatroom</param>
+        /// <param name="data">Any arguments for hosting a chatroom</param>
         void HostChatroom(object data = null);
 
         /// <summary>
         /// Closes a chatroom that the local user is hosting
         /// </summary>
-        /// <param name="data">Any arguments for closing the room</param>
+        /// <param name="data">Any arguments used for closing the chatroom</param>
         void CloseChatroom(object data = null);
 
         /// <summary>
         /// Joins a chatroom
         /// </summary>
-        /// <param name="data">The name of the chatroom to join</param>
+        /// <param name="data">Any arguments used to join a chatroom</param>
         void JoinChatroom(object data = null);
 
         /// <summary>
         /// Leaves the chatroom the local user is currently in, if any
         /// </summary>
-        /// <param name="data">Any arguments for leaving the room</param>
+        /// <param name="data">Any arguments used to leave a chatroom</param>
         void LeaveChatroom(object data = null);
 
         /// <summary>

package/Runtime/Types/ChatroomAudioSegment.cs.meta

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

package/package.json

@@ -1,20 +1,29 @@
 {
-  "name": "com.adrenak.univoice",
-  "version": "2.0.1",
-  "displayName": "Adrenak.UniVoice",
-  "description": "Voice chat/VoIP solution for Unity.",
-  "unity": "2019.4",
-  "author": "Vatsal Ambastha <ambastha.vatsal@gmail.com> (http://www.vatsalambastha.com)",
-  "license": "MIT",
-  "keywords": [
-    "Peer To Peer",
-    "WebRTC",
-    "P2P",
-    "Networking",
-    "Voice Chat",
-    "voip"
-  ],
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
-  }
+    "name": "com.adrenak.univoice",
+    "version": "3.0.0",
+    "displayName": "Adrenak.UniVoice",
+    "description": "Voice chat/VoIP solution for Unity.",
+    "unity": "2019.4",
+    "author": {
+        "name": "Vatsal Ambastha",
+        "email": "ambastha.vatsal@gmail.com",
+        "url": "http://www.vatsalambastha.com"
+    },
+    "license": "MIT",
+    "keywords": [
+        "Peer To Peer",
+        "WebRTC",
+        "P2P",
+        "Networking",
+        "Voice Chat",
+        "voip",
+        "Unity",
+        "Unity3d",
+        "VR",
+        "AR",
+        "Metaverse"
+    ],
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org"
+    }
 }

package/Runtime/Extensions.cs

@@ -1,39 +0,0 @@
-using System.Collections.Generic;
-
-using UnityEngine;
-
-namespace Adrenak.UniVoice {
-    public static class Extensions {
-        /// <summary>
-        /// Returns the normalized position of the AudioSource on its AudioClip
-        /// </summary>
-        public static float Position(this AudioSource source) {
-            return (float)source.timeSamples / source.clip.samples;
-        }
-
-        /// <summary>
-        /// Adds the given key to the dictionary with a value if the key
-        /// is not present before.
-        /// </summary>
-        /// <param name="t">The key to check and add</param>
-        /// <param name="k">The value if the key is added</param>
-        public static void EnsureKey<T, K>
-        (this Dictionary<T, K> dict, T t, K k) {
-            if (!dict.ContainsKey(t))
-                dict.Add(t, k);
-        }
-
-        /// <summary>
-        /// Ensures a key and value pair are in the dictionary
-        /// </summary>
-        /// <param name="t">The key to ensure</param>
-        /// <param name="k">The value associated with the key</param>
-        public static void EnsurePair<T, K>
-        (this Dictionary<T, K> dict, T t, K k) {
-            if (dict.ContainsKey(t))
-                dict[t] = k;
-            else
-                dict.Add(t, k);
-        }
-    }
-}

package/Runtime/Extensions.cs.meta

@@ -1,12 +0,0 @@
-fileFormatVersion: 2
-guid: 646602ab062d77543b3742e51d16658f
-timeCreated: 1547895114
-licenseType: Free
-MonoImporter:
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: