com.adrenak.univoice 4.7.0 → 4.9.0

package/README.md

@@ -1,25 +1,13 @@
 # UniVoice
 UniVoice is a voice chat/VoIP solution for Unity.
   
-Some features of UniVoice:
-- 👥 Group voice chat. Multiple peers can join a chatroom and exchange audio.  
-
-- ⚙ Fine control over audio data flow. 
-    * Don't want to listen to a peer? Mute them. Don't want someone listening to you? Deafen them.  
-    * Group players using tags and control audio flow between them. For example:
-        - "red", "blue" and "spectator" tags for two teams playing against each other.
-            - Red and Blue teams can only hear each other
-            - Spectators can hear everyone
-        - clients with "contestant", "judge" and "audience" tags for a virtual talent show. 
-            - Contestant can be heard by everyone, but don't hear anyone else (for focus) 
-            - Judges can talk to and hear each other for discussions. They can hear the contestant. But not the audience (for less noise)
-            - Audience can hear and talk to each other. They can hear the performer. But they cannot hear the judges.
- 
+Some features of UniVoice: 
 - 🎨 Customize your audio input, output and networking layers. 
   * 🌐 __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](https://mirror-networking.com/)
+        - [Fish Networking](https://fish-networking.gitbook.io/docs)
 
   * 🎤 __Configurable Audio Input__: 
     - UniVoice is audio input agnostic. You can change the source of outgoing audio by implementing the `IAudioInput` interface.  
@@ -37,6 +25,22 @@ Some features of UniVoice:
         - Opus (Concentus) encoding & decoding.
         - RNNoise based noise removal.
         - Gaussian blurring for minor denoising.
+
+- 👥 Easy integration with your existing networking solution
+    - Whether you're using Mirror or FishNet, UniVoice runs in the background in sync with your networking lifecycle
+    - A basic integration involves just initializing it on start.
+    - For advanced usage like teams, chatrooms, lobbies, you can use the UniVoice API to create runtime behaviour.
+
+- ⚙ Fine control over audio data flow. 
+    * Don't want to listen to a peer? Mute them. Don't want someone listening to you? Deafen them.  
+    * Group players using tags and control audio flow between them. For example:
+        - "red", "blue" and "spectator" tags for two teams playing against each other.
+            - Red and Blue teams can only hear each other
+            - Spectators can hear everyone
+        - clients with "contestant", "judge" and "audience" tags for a virtual talent show. 
+            - Contestant can be heard by everyone, but don't hear anyone else (for focus) 
+            - Judges can talk to and hear each other for discussions. They can hear the contestant. But not the audience (for less noise)
+            - Audience can hear and talk to each other. They can hear the performer. But they cannot hear the judges.
   
 ## Installation
 ⚠️ [OpenUPM](https://openupm.com/packages/com.adrenak.univoice/?subPage=versions) may not have up to date releases. Install using NPM registry instead 👇
@@ -62,19 +66,18 @@ Then add `com.adrenak.univoice:x.y.z` to the `dependencies` in your `manifest.js
 ## 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
+* Discord server: https://discord.gg/NGvkEVbdjQ
 
 ## 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 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.
+* `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. 
+* `UniVoiceFishNetSetypSample.cs` is also very similar. Just drag and drop and it should work!
+* A sample scene that shows the other clients in a UI as well as allows you to mute yourself/them. This sample is 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. 
+> UniVoice currently only supports Mirror and FishNetworking out of the box. Follow the instructions in the "Activating non-packaged dependencies" section below before trying it out the samples. 
   
 ## 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.  
@@ -90,19 +93,28 @@ UniVoice includes and installs the dependencies mentioned above along with itsel
 * Mic audio capture input (via UniMic)
 * AudioSource based playback output (via UniMic)
 
-But the following implementations are based on dependencies that you have to install and enable via compilation symbols as they are _not_ UniVoice dependencies and _don't_ get installed along with UniVoice. This is because they are either third party modules or based on native libraries (not plain C#) that can pose build issues.  
-* Mirror network:
-    * To enable, ensure the Mirror package is in your project and add `UNIVOICE_NETWORK_MIRROR` to activate it
+UniVoice has code that uses dependencies that you have to install and sometimes enable via compilation symbols as they are _not_ UniVoice dependencies and _don't_ get installed along with UniVoice. This is because they are either third party modules or based on native libraries (not plain C#) that can pose build issues.  
 * RNNoise Noise removal filter:
     * To enable, ensure the [RNNoise4Unity](https://github.com/adrenak/RNNoise4Unity) package is in your project and add `UNIVOICE_FILTER_RNNOISE4UNITY` to activate it
+* Mirror network:
+    * Just add the Mirror package to your project. UniVoice will detect it.
+* Fish Networking:
+    * Just install FishNet package in your project. UniVoice will detect it.
 
 ## License and Support
 This project is under the [MIT license](https://github.com/adrenak/univoice/blob/master/LICENSE).
 
 Community contributions are welcome.
+
+Commercial engagements with the author can be arranged, subject to schedule and availability.
+
+## Acknowledgements and contributors
+* [@metater](https://github.com/Metater/) for helping make improvements to audio streaming quality. [A related blog post](https://blog.vatsalambastha.com/2025/07/unimic-330-many-streamedaudiosource.html)
+* [@FrantisekHolubec](https://github.com/FrantisekHolubec) for [FishNet support code](https://github.com/adrenak/univoice/commit/fdc3424180d8991c92b3e092b3edb50b6110c863). Here's a [related blog post](https://blog.vatsalambastha.com/2025/09/univoice-480-fishnet-support.html)
+* [Masaryk University](https://www.muni.cz/en) for using UniVoice in their projects and providing helpful feedback 
   
 ## Contact
-The developer can be reached at the following links:
+The author can be reached at the following links:
   
 [Website](http://www.vatsalambastha.com)  
 [LinkedIn](https://www.linkedin.com/in/vatsalAmbastha)  

package/Runtime/Adrenak.UniVoice.Runtime.asmdef

@@ -6,7 +6,8 @@
         "GUID:f87ecb857e752164ab814a3de8eb0262",
         "GUID:b118fd5a40c85ad4e9b38e8c4a42bbb1",
         "GUID:4653938bfdb5cf8409322ce17219d5f7",
-        "GUID:30817c1a0e6d646d99c048fc403f5979"
+        "GUID:30817c1a0e6d646d99c048fc403f5979",
+        "GUID:7c88a4a7926ee5145ad2dfa06f454c67"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],

package/Runtime/Common/WavFileWriter.cs

@@ -0,0 +1,124 @@
+using System;
+using System.IO;
+using System.Text;
+
+/*
+Example script for usage with UniMic. Just add it to a scene,
+play and then quit/exit play mode:
+
+public class WavFileWriterTest : MonoBehaviour {
+    WavFileWriter writer;
+
+    void Start() {
+        string path = string.Empty;
+        if (Application.isEditor)
+            path = Application.dataPath.Replace("Assets", "output.wav");
+        else
+            path = Path.Combine(Application.persistentDataPath, "output.wav");
+
+        writer = new WavFileWriter(path);
+
+        Mic.Init();
+
+        Mic.AvailableDevices[0].OnFrameCollected += OnFrameCollected;
+        Mic.AvailableDevices[0].StartRecording(20);
+    }
+
+    private void OnFrameCollected(int arg1, int arg2, float[] arg3) {
+        writer.Write(arg1, arg2, arg3);
+    }
+
+    private void OnDestroy() {
+        writer.Dispose();
+    }
+}
+*/
+
+namespace Adrenak.UniVoice {
+    /// <summary>
+    /// A utility to write audio samples to a file on disk. 
+    /// Construct using the path you want to store the audio file at.
+    /// Invoke Write with the sampling frequency, channel count and PCM samples
+    /// and it will lazily initialize.
+    /// </summary>
+    public class WavFileWriter : IDisposable {
+        FileStream fileStream;
+        int sampleRate;
+        short channels;
+        readonly short bitsPerSample = 16;
+
+        long dataChunkPos;
+        int totalSampleCount = 0;
+        bool isInitialized = false;
+        readonly string path;
+
+        public WavFileWriter(string path) {
+            this.path = path;
+        }
+
+        public void Write(int frequency, int channelCount, float[] samples) {
+            if (!isInitialized) {
+                sampleRate = frequency;
+                channels = (short)channelCount;
+                fileStream = new FileStream(path, FileMode.Create, FileAccess.Write);
+                WriteWavHeader();
+                isInitialized = true;
+            }
+            else {
+                if (frequency != sampleRate || channelCount != channels)
+                    throw new InvalidOperationException("Inconsistent frequency or channel count between calls.");
+            }
+
+            byte[] buffer = new byte[samples.Length * 2]; // 2 bytes per sample (16-bit PCM)
+            for (int i = 0; i < samples.Length; i++) {
+                short intSample = (short)Math.Clamp(samples[i] * short.MaxValue, short.MinValue, short.MaxValue);
+                buffer[i * 2] = (byte)(intSample & 0xff);
+                buffer[i * 2 + 1] = (byte)((intSample >> 8) & 0xff);
+            }
+
+            fileStream.Write(buffer, 0, buffer.Length);
+            totalSampleCount += samples.Length;
+        }
+
+        void WriteWavHeader() {
+            var writer = new BinaryWriter(fileStream, Encoding.ASCII, true);
+
+            writer.Write(Encoding.ASCII.GetBytes("RIFF"));
+            writer.Write(0); // placeholder for file size
+            writer.Write(Encoding.ASCII.GetBytes("WAVE"));
+
+            // fmt chunk
+            writer.Write(Encoding.ASCII.GetBytes("fmt "));
+            writer.Write(16); // PCM header size
+            writer.Write((short)1); // PCM format
+            writer.Write(channels);
+            writer.Write(sampleRate);
+            int byteRate = sampleRate * channels * bitsPerSample / 8;
+            writer.Write(byteRate);
+            short blockAlign = (short)(channels * bitsPerSample / 8);
+            writer.Write(blockAlign);
+            writer.Write(bitsPerSample);
+
+            // data chunk
+            writer.Write(Encoding.ASCII.GetBytes("data"));
+            dataChunkPos = fileStream.Position;
+            writer.Write(0); // placeholder for data chunk size
+        }
+
+        public void Dispose() {
+            if (!isInitialized) return;
+
+            long dataSize = totalSampleCount * bitsPerSample / 8;
+
+            fileStream.Seek(dataChunkPos, SeekOrigin.Begin);
+            fileStream.Write(BitConverter.GetBytes((int)dataSize), 0, 4);
+
+            fileStream.Seek(4, SeekOrigin.Begin);
+            int fileSize = (int)(fileStream.Length - 8);
+            fileStream.Write(BitConverter.GetBytes(fileSize), 0, 4);
+
+            fileStream.Dispose();
+            isInitialized = false;
+        }
+    }
+}

package/Runtime/Common/WavFileWriter.cs.meta

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

package/Runtime/Impl/Networks/FishNet/FishNetBroadcast.cs

@@ -0,0 +1,22 @@
+#if FISHNET
+using System;
+using FishNet.Broadcast;
+
+namespace Adrenak.UniVoice.Networks
+{
+    /// <summary>
+    /// The messages exchanged between the server and client. 
+    /// To see how the Mirror implementation of UniVoice uses this struct
+    /// find the references to the <see cref="data"/> object in the project.
+    /// The gist is, it uses BRW (https://www.github.com/adrenak/brw) to 
+    /// write and read data. The data always starts with a tag. All the tags
+    /// used for this UniVoice FishNet implementation are available in 
+    /// <see cref="FishNetBroadcastTags"/>
+    /// </summary>
+    [Serializable]
+    public struct FishNetBroadcast : IBroadcast
+    {
+        public byte[] data;
+    }
+}
+#endif

package/Runtime/Impl/Networks/FishNet/FishNetBroadcast.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: f0e5aa417fb8e6249bb05a011a5d7edf

package/Runtime/Impl/Networks/FishNet/FishNetBroadcastTags.cs

@@ -0,0 +1,15 @@
+#if FISHNET
+namespace Adrenak.UniVoice.Networks
+{
+    /// <summary>
+    /// The different types of messages we send over FishNet 
+    /// to implement the <see cref="IAudioClient{T}"/> and <see cref="IAudioServer{T}"/>
+    /// interfaces for FishNet
+    /// </summary>
+    public class FishNetBroadcastTags
+    {
+        public const string AUDIO_FRAME = "AUDIO_FRAME";
+        public const string VOICE_SETTINGS = "VOICE_SETTINGS";
+    }
+}
+#endif

package/Runtime/Impl/Networks/FishNet/FishNetBroadcastTags.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: fa1db30850448a14b840e4974d687a3b

package/Runtime/Impl/Networks/FishNet/FishNetClient.cs

@@ -0,0 +1,197 @@
+#if FISHNET
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Adrenak.BRW;
+using FishNet;
+using FishNet.Managing;
+using FishNet.Transporting;
+using UnityEngine;
+
+namespace Adrenak.UniVoice.Networks
+{
+    /// <summary>
+    /// This is the implementation of <see cref="IAudioClient{T}"/> interface for FishNet.
+    /// It uses the FishNet to send and receive UniVoice data to the server.
+    /// </summary>
+    public class FishNetClient : IAudioClient<int>
+    {
+        private const string TAG = "[FishNetClient]";
+        public int ID { get; private set; } = -1;
+
+        public List<int> PeerIDs { get; private set; }
+        public VoiceSettings YourVoiceSettings { get; private set; }
+
+        public event Action<int, List<int>> OnJoined;
+        public event Action OnLeft;
+        public event Action<int> OnPeerJoined;
+        public event Action<int> OnPeerLeft;
+        public event Action<int, AudioFrame> OnReceivedPeerAudioFrame;
+
+        private NetworkManager _networkManager;
+
+        public FishNetClient()
+        {
+            PeerIDs = new List<int>();
+            YourVoiceSettings = new VoiceSettings();
+            
+            _networkManager = InstanceFinder.NetworkManager;
+            _networkManager.ClientManager.OnClientConnectionState += OnClientConnectionStateChanged;
+            _networkManager.ClientManager.OnAuthenticated += OnClientAuthenticated;
+            _networkManager.ClientManager.OnRemoteConnectionState += OnRemoteConnectionStateChanged;
+            _networkManager.ClientManager.RegisterBroadcast<FishNetBroadcast>(OnReceivedMessage);
+        }
+        
+        public void Dispose()
+        {
+            if (_networkManager)
+            {
+                _networkManager.ClientManager.OnClientConnectionState -= OnClientConnectionStateChanged;
+                _networkManager.ClientManager.OnAuthenticated -= OnClientAuthenticated;
+                _networkManager.ClientManager.OnRemoteConnectionState -= OnRemoteConnectionStateChanged;
+                _networkManager.ClientManager.UnregisterBroadcast<FishNetBroadcast>(OnReceivedMessage);
+            }
+            PeerIDs.Clear();
+        }
+        
+        private void OnRemoteConnectionStateChanged(RemoteConnectionStateArgs args)
+        {
+            // Don't process connection state changes before the client is authenticated
+            if (_networkManager.ClientManager.Connection.ClientId < 0)
+                return;
+            
+            if (args.ConnectionState == RemoteConnectionState.Started)
+            {
+                var newPeerID = args.ConnectionId;
+                if (!PeerIDs.Contains(newPeerID))
+                {
+                    PeerIDs.Add(newPeerID);
+                    Debug.unityLogger.Log(LogType.Log, TAG,
+                        $"Peer {newPeerID} joined. Peer list is now {string.Join(", ", PeerIDs)}");
+                    OnPeerJoined?.Invoke(newPeerID);
+                }
+            }
+            else if (args.ConnectionState == RemoteConnectionState.Stopped)
+            {
+                var leftPeerID = args.ConnectionId;
+                if (PeerIDs.Contains(leftPeerID))
+                {
+                    PeerIDs.Remove(leftPeerID);
+                    var 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);
+                }
+            }
+        }
+        
+        private void OnClientAuthenticated()
+        {
+            // We need to use OnClientAuthenticated to ensure the client does have ClientId set
+            ID = _networkManager.ClientManager.Connection.ClientId;
+            PeerIDs = _networkManager.ClientManager.Clients.Keys.Where(x => x != ID).ToList();
+            
+            var 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);
+        }
+        
+        private void OnClientConnectionStateChanged(ClientConnectionStateArgs args)
+        {
+            // We check only for the stopped state here, as the started state is handled in OnClientAuthenticated
+            if (args.ConnectionState == LocalConnectionState.Stopped)
+            {
+                YourVoiceSettings = new VoiceSettings();
+                var oldPeerIds = PeerIDs.ToList();
+                PeerIDs.Clear();
+                ID = -1;
+                foreach (var peerId in oldPeerIds)
+                    OnPeerLeft?.Invoke(peerId);
+                OnLeft?.Invoke();
+            }
+        }
+
+        private void OnReceivedMessage(FishNetBroadcast msg, Channel channel)
+        {
+            var reader = new BytesReader(msg.data);
+            var tag = reader.ReadString();
+            switch (tag)
+            {
+                // When the server sends audio from a peer meant for this client
+                case FishNetBroadcastTags.AUDIO_FRAME:
+                    var sender = reader.ReadInt();
+                    if (sender == ID || !PeerIDs.Contains(sender))
+                        return;
+                    var frame = new AudioFrame
+                    {
+                        timestamp = reader.ReadLong(),
+                        frequency = reader.ReadInt(),
+                        channelCount = reader.ReadInt(),
+                        samples = reader.ReadByteArray()
+                    };
+                    OnReceivedPeerAudioFrame?.Invoke(sender, frame);
+                    break;
+            }
+        }
+
+        /// <summary>
+        /// Sends an audio frame captured on this client to the server
+        /// </summary>
+        /// <param name="frame"></param>
+        public void SendAudioFrame(AudioFrame frame)
+        {
+            if (ID == -1)
+                return;
+            var writer = new BytesWriter();
+            writer.WriteString(FishNetBroadcastTags.AUDIO_FRAME);
+            writer.WriteInt(ID);
+            writer.WriteLong(frame.timestamp);
+            writer.WriteInt(frame.frequency);
+            writer.WriteInt(frame.channelCount);
+            writer.WriteByteArray(frame.samples);
+
+            var message = new FishNetBroadcast
+            {
+                data = writer.Bytes
+            };
+
+            if (_networkManager.ClientManager.Started) 
+                _networkManager.ClientManager.Broadcast(message, Channel.Unreliable);
+        }
+
+        /// <summary>
+        /// Updates the server with the voice settings of this client
+        /// </summary>
+        public void SubmitVoiceSettings() 
+        {
+            if (ID == -1)
+                return;
+            var writer = new BytesWriter();
+            writer.WriteString(FishNetBroadcastTags.VOICE_SETTINGS);
+            writer.WriteInt(YourVoiceSettings.muteAll ? 1 : 0);
+            writer.WriteIntArray(YourVoiceSettings.mutedPeers.ToArray());
+            writer.WriteInt(YourVoiceSettings.deafenAll ? 1 : 0);
+            writer.WriteIntArray(YourVoiceSettings.deafenedPeers.ToArray());
+            writer.WriteString(string.Join(",", YourVoiceSettings.myTags));
+            writer.WriteString(string.Join(",", YourVoiceSettings.mutedTags));
+            writer.WriteString(string.Join(",", YourVoiceSettings.deafenedTags));
+
+            var message = new FishNetBroadcast() {
+                data = writer.Bytes
+            };
+            _networkManager.ClientManager.Broadcast(message);
+        }
+    }
+}
+#endif

package/Runtime/Impl/Networks/FishNet/FishNetClient.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: e49db0da30bc5fc479ca244d58f82481