com.adrenak.univoice 4.1.1 → 4.2.0

package/README.md

@@ -4,16 +4,30 @@ 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.  
 
-- ⚙ Peer specific settings. Don't want to listen to a peer? Mute them. Don't want someone listening to you? Mute yourself against them.
+- ⚙ Peer specific settings. Don't want to listen to a peer? Mute them. Don't want someone listening to you? Deafen them.  
  
-- 🎨 Customize your audio input, output and networking layer. 
-  * 🎤 __Configurable Audio Input__: UniVoice is audio input agnostic. It supports mic audio input out of the box and you can change the source of outgoing audio by implementing the `IAudioInput` interrace.  
-    
-  * 🔊 __Configurable Audio Output__:  UniVoice is audio output agnostic. Out of the box is supports playing peer audio using Unity AudioSource. You can divert incoming audio to anywhere you want by implementing the `IAudioOutput` interface.  
+- 🎨 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.  
 
-  * 🌐 __Configurable Network__: UniVoice is network agnostic and supports Mirror out of the box. You can implement the `IAudioClient` and `IAudioServer` interfaces using the networking plugin of your choice to make it compatible with it.
+  * 🎤 __Configurable Audio Input__: 
+    - UniVoice is audio input agnostic. You can change the source of outgoing audio by implementing the `IAudioInput` interface.  
+    - Built-in support for:
+        - Capturing Mic audio as device input.  
+    
+  * 🔊 __Configurable Audio Output__:  
+    - UniVoice is audio output agnostic. You can divert incoming audio to anywhere you want by implementing the `IAudioOutput` interface.
+    - Built-in support for:
+        - Playing incoming audio using Unity AudioSource.  
 
-  * ✏️ __Audio Filters__: Modify outgoing and incoming audio by implementing the `IAudioFilter` interface. Gaussian blurring for denoising and Opus (Concentus) encoding & decoding for lower bandwidth consumption are provided out of the box.
+  * ✏️ __Audio Filters__: 
+    - Modify outgoing and incoming audio by implementing the `IAudioFilter` interface. 
+    - Built-in support for:
+        - Opus (Concentus) encoding & decoding.
+        - RNNoise based noise removal.
+        - Gaussian blurring for minor denoising.
   
 ## Installation
 ⚠️ [OpenUPM](https://openupm.com/packages/com.adrenak.univoice/?subPage=versions) may not have up to date releases. Install using NPM registry instead 👇
@@ -37,12 +51,12 @@ 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
-Am API reference is available: http://www.vatsalambastha.com/univoice
+API reference is available here: http://www.vatsalambastha.com/univoice
 
 ## 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.  
   
-To try the sample, import Mirror and add the `UNIVOICE_MIRROR_NETWORK` compilation symbol to your project.
+> The sample relies on Mirror networking to work. Follow the instructions 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.  
@@ -51,6 +65,19 @@ To try the sample, import Mirror and add the `UNIVOICE_MIRROR_NETWORK` compilati
 
 [com.adrenak.concentus-unity](https://www.github.com/adrenak/concentus-unity) for Opus encoding and decoding. See `ConcentusEncodeFilter.cs` and `ConcentusDecodeFilter.cs` for usage
 
+## Activating non-packaged dependencies
+UniVoice includes and installs the dependencies mentioned above along with itself. The following implementations are available out of the box when you install it:
+* Opus encoding/decoding filter (via Contentus-Unity)
+* GaussianAudioBlur filter (plain C#, no dependencies used)
+* 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
+* 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
+
 ## License and Support
 This project is under the [MIT license](https://github.com/adrenak/univoice/blob/master/LICENSE).
 

package/Runtime/Adrenak.UniVoice.Runtime.asmdef

@@ -2,11 +2,11 @@
     "name": "Adrenak.UniVoice.Runtime",
     "rootNamespace": "",
     "references": [
-        "GUID:f87ecb857e752164ab814a3de8eb0262",
         "GUID:1f776cd02c03a7b4280b6b649d7758e2",
-        "GUID:30817c1a0e6d646d99c048fc403f5979",
-        "GUID:725ee7191c021de4dbf9269590ded755",
-        "GUID:b118fd5a40c85ad4e9b38e8c4a42bbb1"
+        "GUID:f87ecb857e752164ab814a3de8eb0262",
+        "GUID:b118fd5a40c85ad4e9b38e8c4a42bbb1",
+        "GUID:4653938bfdb5cf8409322ce17219d5f7",
+        "GUID:30817c1a0e6d646d99c048fc403f5979"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],

package/Runtime/Impl/Filters/RNNoise/RNNoiseFilter.cs

@@ -0,0 +1,28 @@
+#if UNIVOICE_FILTER_RNNOISE4UNITY
+using System;
+
+using Adrenak.RNNoise4Unity;
+
+namespace Adrenak.UniVoice.Filters {
+    public class RNNoiseFilter : IAudioFilter {
+        readonly Denoiser denoiser;
+
+        public RNNoiseFilter() {
+            denoiser = new Denoiser();
+        }
+
+        public AudioFrame Run(AudioFrame input) {
+            var data = Utils.Bytes.BytesToFloats(input.samples);
+
+            denoiser.Denoise(data.AsSpan(), false);
+
+            return new AudioFrame {
+                timestamp = input.timestamp,
+                channelCount = input.channelCount,
+                frequency = input.frequency,
+                samples = Utils.Bytes.FloatsToBytes(data)
+            };
+        }
+    }
+}
+#endif

package/Runtime/Impl/Filters/RNNoise/RNNoiseFilter.cs.meta

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

package/{Samples.meta → Runtime/Impl/Filters/RNNoise.meta}

@@ -1,5 +1,5 @@
 fileFormatVersion: 2
-guid: dc0b6ac6ddea66b4b8aee68c2ee0e99a
+guid: 046f57b349547674cb5b8c8e31c89467
 folderAsset: yes
 DefaultImporter:
   externalObjects: {}

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

@@ -1,4 +1,4 @@
-#if UNIVOICE_MIRROR_NETWORK
+#if UNIVOICE_MIRROR_NETWORK || UNIVOICE_NETWORK_MIRROR
 using System;
 using System.Linq;
 using System.Collections.Generic;

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

@@ -1,4 +1,4 @@
-#if UNIVOICE_MIRROR_NETWORK
+#if UNIVOICE_MIRROR_NETWORK || UNIVOICE_NETWORK_MIRROR
 using System;
 
 using Mirror;

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

@@ -1,4 +1,4 @@
-#if UNIVOICE_MIRROR_NETWORK
+#if UNIVOICE_MIRROR_NETWORK || UNIVOICE_NETWORK_MIRROR
 namespace Adrenak.UniVoice.Networks {
     /// <summary>
     /// The different types of messages we send over Mirror 

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

@@ -1,4 +1,4 @@
-#if UNIVOICE_MIRROR_NETWORK
+#if UNIVOICE_MIRROR_NETWORK || UNIVOICE_NETWORK_MIRROR
 using Mirror;
 
 using System;

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

@@ -3,7 +3,7 @@
 // https://github.com/MirrorNetworking/Mirror/releases/tag/v89.11.0
 // OnServerConnected no longer seems to work?
 
-#if UNIVOICE_MIRROR_NETWORK
+#if UNIVOICE_MIRROR_NETWORK || UNIVOICE_NETWORK_MIRROR
 using System;
 using System.Linq;
 using System.Threading.Tasks;
@@ -62,7 +62,7 @@ namespace Adrenak.UniVoice.Networks {
             NetworkManager.singleton.transport.OnServerConnectedWithAddress -= OnServerConnected;
 #else
             NetworkManager.singleton.transport.OnServerConnected -= OnServerConnected;
-#endif            
+#endif
             NetworkManager.singleton.transport.OnServerDisconnected -= OnServerDisconnected;
         }
 

package/{Samples → Samples~}/Group Chat Sample/Scripts/GroupVoiceCallMirrorSample.cs

@@ -1,4 +1,4 @@
-#if UNIVOICE_MIRROR_NETWORK
+#if UNIVOICE_MIRROR_NETWORK || UNIVOICE_NETWORK_MIRROR
 using System.Linq;
 using System.Collections;
 using System.Collections.Generic;

package/package.json

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