Add workaround for compatibility issue between Unity's WebRTC and Ocu…

…lus/OpenXR SDK
UCL-VR · Jan 26, 2024 · 2ca2da6 · 2ca2da6
1 parent f262fdc
commit 2ca2da6
Show file tree

Hide file tree

Showing 17 changed files with 152 additions and 33 deletions.
diff --git a/Unity/Assets/Editor/Packaging.meta b/Unity/Assets/Editor/Packaging.meta
diff --git a/Unity/Assets/Editor/Packaging/AddPackageWebRTC.cs b/Unity/Assets/Editor/Packaging/AddPackageWebRTC.cs
@@ -0,0 +1,66 @@
+#if !UNITY_WEBRTC_NO_VULKAN_HOOK && !UBIQ_SKIPCHECK_WEBRTCCOMPATIBILITY
+using UnityEngine;
+using UnityEditor;
+using UnityEditor.PackageManager;
+using UnityEditor.PackageManager.Requests;
+
+namespace Ubiq.Samples.Demo.Editor
+{
+    [InitializeOnLoad]
+    public class AddPackageWebRTC
+    {
+        private const string FORK_URL = "https://github.com/UCL-VR/unity-webrtc-no-vulkan-hook.git";
+#if UNITY_WEBRTC
+        AddAndRemoveRequest request;
+#else
+        AddRequest request;
+#endif
+        AddAndRemoveRequest foo;
+
+        static AddPackageWebRTC()
+        {
+            Debug.Log("Ubiq attempting to add WebRTC to project requirements." +
+                " Please wait...");
+            var instance = new AddPackageWebRTC();
+#if UNITY_WEBRTC
+            Debug.LogWarning("Ubiq has detected an existing com.unity.webrtc" +
+                " package. This package has compatibility issues with the" +
+                " Oculus/OpenXR SDK. Ubiq will remove this package and" +
+                " replace it with a modified fork which is compatible. If you" +
+                " would prefer to skip this check and prevent this behaviour," +
+                " add the string UBIQ_SKIPCHECK_WEBRTCCOMPATIBILITY to your" +
+                " scripting define symbols.");
+            instance.request = Client.AddAndRemove(
+                packagesToAdd : new string[] {FORK_URL},
+                packagesToRemove : new string[] {"com.unity.webrtc"}
+            );
+#else
+            instance.request = Client.Add(FORK_URL);
+#endif
+            EditorApplication.update += instance.Update;
+        }
+
+        void Update()
+        {
+            if (request == null)
+            {
+                EditorApplication.update -= Update;
+            }
+
+            if (request.Status == StatusCode.Failure)
+            {
+                var error = request.Error != null ? request.Error.message : "None specified";
+                Debug.LogError($"Ubiq was unable to add WebRTC to project requirements. Error: {error}");
+                EditorApplication.update -= Update;
+            }
+
+            if (request.Status == StatusCode.Success)
+            {
+                EditorApplication.update -= Update;
+                Debug.Log("Ubiq added WebRTC to project requirements.");
+                AssetDatabase.Refresh();
+            }
+        }
+    }
+}
+#endif
diff --git a/Unity/Assets/Editor/Packaging/AddPackageWebRTC.cs.meta b/Unity/Assets/Editor/Packaging/AddPackageWebRTC.cs.meta
diff --git a/Unity/Assets/Editor/Ubiq.Editor.asmdef b/Unity/Assets/Editor/Ubiq.Editor.asmdef
@@ -1,5 +1,6 @@
 {
     "name": "Ubiq.Editor",
+    "rootNamespace": "",
     "references": [
         "GUID:ab979a98ba0be4546bceb48f770b11c8",
         "GUID:4be54a12296e0404db7080c914e17b05"
@@ -13,6 +14,17 @@
     "precompiledReferences": [],
     "autoReferenced": true,
     "defineConstraints": [],
-    "versionDefines": [],
+    "versionDefines": [
+        {
+            "name": "com.unity.webrtc",
+            "expression": "0.0.0",
+            "define": "UNITY_WEBRTC"
+        },
+        {
+            "name": "com.unity.webrtc-no-vulkan-hook",
+            "expression": "0.0.0",
+            "define": "UNITY_WEBRTC_NO_VULKAN_HOOK"
+        }
+    ],
     "noEngineReferences": false
 }
diff --git a/Unity/Assets/Runtime/Voip/Implementations/Null/Ubiq.Voip.Implementations.Null.asmdef b/Unity/Assets/Runtime/Voip/Implementations/Null/Ubiq.Voip.Implementations.Null.asmdef
@@ -14,14 +14,15 @@
         "iOS",
         "LinuxStandalone64",
         "CloudRendering",
-        "Lumin",
         "macOSStandalone",
         "PS4",
         "PS5",
+        "QNX",
         "Stadia",
         "Switch",
         "tvOS",
         "WSA",
+        "VisionOS",
         "WebGL",
         "WindowsStandalone32",
         "WindowsStandalone64",

diff --git a/...mplementations/Null/PeerConnectionImpl.cs → ...Implementations/NullPeerConnectionImpl.cs b/...mplementations/Null/PeerConnectionImpl.cs → ...Implementations/NullPeerConnectionImpl.cs
@@ -1,18 +1,14 @@
+using System;
 using System.Collections.Generic;
 using UnityEngine;
 
-namespace Ubiq.Voip.Implementations.Null
+namespace Ubiq.Voip.Implementations
 {
-    public class PeerConnectionImpl : IPeerConnectionImpl
+    public class NullPeerConnectionImpl : IPeerConnectionImpl
     {
-#pragma warning disable CS0067
-        public event IceConnectionStateChangedDelegate iceConnectionStateChanged;
-        public event PeerConnectionStateChangedDelegate peerConnectionStateChanged;
-#pragma warning restore CS0067
         public void Dispose() {}
-        public PlaybackStats GetLastFramePlaybackStats() => new PlaybackStats();
         public void ProcessSignalingMessage(string json) {}
-        public void Setup(IPeerConnectionContext context, bool polite, List<IceServerDetails> iceServers)
+        public void Setup(IPeerConnectionContext context, bool polite, List<IceServerDetails> iceServers, Action<AudioStats> playbackStatsPushed, Action<AudioStats> recordStatsPushed, Action<IceConnectionState> iceConnectionStateChanged, Action<PeerConnectionState> peerConnectionStateChanged)
         {
             // Pretend we are connected to silence/hide warnings
             if (iceConnectionStateChanged != null)

diff --git a/...entations/Null/PeerConnectionImpl.cs.meta → ...mentations/NullPeerConnectionImpl.cs.meta b/...entations/Null/PeerConnectionImpl.cs.meta → ...mentations/NullPeerConnectionImpl.cs.meta
diff --git a/Unity/Assets/Runtime/Voip/Implementations/Unity/AudioStatsFilter.cs b/Unity/Assets/Runtime/Voip/Implementations/Unity/AudioStatsFilter.cs
@@ -1,3 +1,4 @@
+#if UNITY_WEBRTC || UNITY_WEBRTC_NO_VULKAN_HOOK
 using System;
 using UnityEngine;
 using System.Collections.Concurrent;
@@ -70,4 +71,5 @@ private void OnAudioFilterRead(float[] data, int channels)
             statsQueue.Enqueue(new AudioStats(length,volumeSum,0));
         }
     }
-}
+}
+#endif
diff --git a/Unity/Assets/Runtime/Voip/Implementations/Unity/PeerConnectionImpl.cs b/Unity/Assets/Runtime/Voip/Implementations/Unity/PeerConnectionImpl.cs
@@ -1,3 +1,4 @@
+#if UNITY_WEBRTC || UNITY_WEBRTC_NO_VULKAN_HOOK
 using System;
 using System.Collections;
 using System.Collections.Generic;
@@ -486,4 +487,5 @@ private static void Send(IPeerConnectionContext context, RTCIceCandidate ic)
             )));
         }
     }
-}
+}
+#endif
diff --git a/Unity/Assets/Runtime/Voip/Implementations/Unity/PeerConnectionImplFactory.cs b/Unity/Assets/Runtime/Voip/Implementations/Unity/PeerConnectionImplFactory.cs
@@ -4,7 +4,11 @@ public static class PeerConnectionImplFactory
     {
         public static IPeerConnectionImpl Create()
         {
+#if UNITY_WEBRTC || UNITY_WEBRTC_NO_VULKAN_HOOK
             return new Ubiq.Voip.Implementations.Unity.PeerConnectionImpl();
+#else
+            return new Ubiq.Voip.Implementations.NullPeerConnectionImpl();
+#endif
         }
     }
 }
diff --git a/Unity/Assets/Runtime/Voip/Implementations/Unity/PeerConnectionMicrophone.cs b/Unity/Assets/Runtime/Voip/Implementations/Unity/PeerConnectionMicrophone.cs
@@ -1,3 +1,4 @@
+#if UNITY_WEBRTC || UNITY_WEBRTC_NO_VULKAN_HOOK
 using System;
 using System.Collections;
 using System.Collections.Generic;
@@ -144,4 +145,5 @@ public void RemoveUser(GameObject user)
             users.Remove(user);
         }
     }
-}
+}
+#endif
diff --git a/Unity/Assets/Runtime/Voip/Implementations/Unity/SpatialisationCacheAudioFilter.cs b/Unity/Assets/Runtime/Voip/Implementations/Unity/SpatialisationCacheAudioFilter.cs
@@ -1,3 +1,4 @@
+#if UNITY_WEBRTC || UNITY_WEBRTC_NO_VULKAN_HOOK
 using UnityEngine;
 
 namespace Ubiq.Voip.Implementations.Unity
@@ -26,4 +27,5 @@ void OnAudioFilterRead(float[] data, int channels)
             }
         }
     }
-}
+}
+#endif
diff --git a/Unity/Assets/Runtime/Voip/Implementations/Unity/SpatialisationRestoreAudioFilter.cs b/Unity/Assets/Runtime/Voip/Implementations/Unity/SpatialisationRestoreAudioFilter.cs
@@ -1,3 +1,4 @@
+#if UNITY_WEBRTC || UNITY_WEBRTC_NO_VULKAN_HOOK
 using UnityEngine;
 
 namespace Ubiq.Voip.Implementations.Unity
@@ -31,4 +32,5 @@ void OnAudioFilterRead(float[] data, int channels)
             }
         }
     }
-}
+}
+#endif
diff --git a/Unity/Assets/Runtime/Voip/Implementations/Unity/Ubiq.Voip.Implementations.Unity.asmdef b/Unity/Assets/Runtime/Voip/Implementations/Unity/Ubiq.Voip.Implementations.Unity.asmdef
@@ -18,6 +18,17 @@
     "precompiledReferences": [],
     "autoReferenced": true,
     "defineConstraints": [],
-    "versionDefines": [],
+    "versionDefines": [
+        {
+            "name": "com.unity.webrtc",
+            "expression": "0.0.0",
+            "define": "UNITY_WEBRTC"
+        },
+        {
+            "name": "com.unity.webrtc-no-vulkan-hook",
+            "expression": "0.0.0",
+            "define": "UNITY_WEBRTC_NO_VULKAN_HOOK"
+        }
+    ],
     "noEngineReferences": false
 }
diff --git a/Unity/Assets/Samples/Demo (XRI)/Demo.unity b/Unity/Assets/Samples/Demo (XRI)/Demo.unity
@@ -677,32 +677,32 @@ PrefabInstance:
     - target: {fileID: 2111886246478503278, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_AnchorMax.y
-      value: 1
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 2111886246478503278, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_AnchorMin.y
-      value: 1
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 2111886246478503278, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_SizeDelta.x
-      value: 30
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 2111886246478503278, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_SizeDelta.y
-      value: 40
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 2111886246478503278, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_AnchoredPosition.x
-      value: 53
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 2111886246478503278, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_AnchoredPosition.y
-      value: -22.5
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 2407431680527197411, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
@@ -982,32 +982,32 @@ PrefabInstance:
     - target: {fileID: 5293975139575421772, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_AnchorMax.y
-      value: 1
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 5293975139575421772, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_AnchorMin.y
-      value: 1
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 5293975139575421772, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_SizeDelta.x
-      value: 30
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 5293975139575421772, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_SizeDelta.y
-      value: 40
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 5293975139575421772, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_AnchoredPosition.x
-      value: 21
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 5293975139575421772, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}
       propertyPath: m_AnchoredPosition.y
-      value: -22.5
+      value: 0
       objectReference: {fileID: 0}
     - target: {fileID: 8225375711087241992, guid: 46c1f5d5a11cf5042886aabd56e7b9d7,
         type: 3}

diff --git a/Unity/Packages/manifest.json b/Unity/Packages/manifest.json
@@ -11,7 +11,7 @@
     "com.unity.timeline": "1.7.6",
     "com.unity.toolchain.win-x86_64-linux-x86_64": "2.0.4",
     "com.unity.ugui": "1.0.0",
-    "com.unity.webrtc": "3.0.0-pre.7",
+    "com.unity.webrtc-no-vulkan-hook": "https://github.com/UCL-VR/unity-webrtc-no-vulkan-hook.git",
     "com.unity.xr.interaction.toolkit": "2.5.2",
     "com.unity.xr.management": "4.4.0",
     "com.unity.xr.oculus": "4.1.2",

diff --git a/Unity/Packages/packages-lock.json b/Unity/Packages/packages-lock.json
@@ -145,16 +145,16 @@
         "com.unity.modules.imgui": "1.0.0"
       }
     },
-    "com.unity.webrtc": {
-      "version": "3.0.0-pre.7",
+    "com.unity.webrtc-no-vulkan-hook": {
+      "version": "https://github.com/UCL-VR/unity-webrtc-no-vulkan-hook.git",
       "depth": 0,
-      "source": "registry",
+      "source": "git",
       "dependencies": {
         "com.unity.modules.jsonserialize": "1.0.0",
         "com.unity.editorcoroutines": "1.0.0",
         "com.unity.modules.audio": "1.0.0"
       },
-      "url": "https://packages.unity.com"
+      "hash": "deac61d7009e3d04bd7f8e1f8d33227bdddac153"
     },
     "com.unity.xr.core-utils": {
       "version": "2.2.3",