tracker: add a button for setting aethervr as the openxr runtime

Author: chnoblouch

tracker/aethervr/camera_capture.py

@@ -16,7 +16,7 @@ def __init__(self, on_frame):
 
     def capture_images(self):
         capture = cv2.VideoCapture(0, cv2.CAP_DSHOW)
-        capture.set(cv2.CAP_PROP_FRAME_WIDTH, 960)
+        capture.set(cv2.CAP_PROP_FRAME_WIDTH, 860)
         capture.set(cv2.CAP_PROP_FRAME_HEIGHT, 720)
 
         if not capture.isOpened():

tracker/aethervr/gui.py

@@ -13,9 +13,10 @@
     QComboBox,
     QFormLayout,
     QGroupBox,
+    QMessageBox,
 )
 
-from PySide6.QtCore import QEvent, Qt, QSize, QEvent, QRect
+from PySide6.QtCore import QEvent, Qt, QSize, QEvent, QRect, QTimer
 from PySide6.QtGui import QPaintEvent, QColor, QPainter, QBrush, QImage
 from mediapipe import solutions
 import numpy as np
@@ -25,6 +26,7 @@
 from aethervr.tracking_state import TrackingState
 from aethervr.input_state import ControllerButton
 from aethervr.runtime_connection import RuntimeConnection
+from aethervr.system_openxr_config import SystemOpenXRConfig
 
 
 STYLESHEET = """
@@ -45,15 +47,16 @@
 
 class Window(QMainWindow):
 
-    def __init__(self, config: Config, connection: RuntimeConnection):
+    def __init__(self, config: Config, connection: RuntimeConnection, system_openxr_config: SystemOpenXRConfig):
         super().__init__()
         self.config = config
         self.connection = connection
+        self.system_openxr_config = system_openxr_config
 
         self.camera_view = None
 
         self.setWindowTitle("AetherVR Tracker")
-        self.resize(QSize(1080, 720))
+        self.resize(QSize(1280, 720))
 
         layout = QVBoxLayout()
         layout.setContentsMargins(0, 0, 0, 0)
@@ -77,16 +80,12 @@ def create_horizontal_widget(self):
         layout = QHBoxLayout()
         layout.setContentsMargins(0, 0, 0, 0)
         layout.setSpacing(0)
-        layout.addWidget(ConfigPanel(self.config))
+        layout.addWidget(ConfigPanel(self.config, self.system_openxr_config))
         layout.addWidget(separator)
         layout.addWidget(self.camera_view)
         widget.setLayout(layout)
 
-        size_policy = QSizePolicy(
-            QSizePolicy.Policy.Preferred,
-            QSizePolicy.Policy.Preferred,
-        )
-
+        size_policy = QSizePolicy(QSizePolicy.Policy.Preferred, QSizePolicy.Policy.Preferred)
         size_policy.setHorizontalStretch(1)
         size_policy.setVerticalStretch(1)
         widget.setSizePolicy(size_policy)
@@ -102,11 +101,12 @@ def update_camera_overlay(self, tracking_state: TrackingState):
 
 class ConfigPanel(QWidget):
 
-    def __init__(self, config: Config):
+    def __init__(self, config: Config, system_openxr_config: SystemOpenXRConfig):
         super().__init__()
         self.config = config
 
         layout = QVBoxLayout()
+        layout.addWidget(OpenXRConfigGroup(system_openxr_config))
         layout.addWidget(self.build_controller_group("Left Controller", config.left_controller_config))
         layout.addWidget(self.build_controller_group("Right Controller", config.right_controller_config))
         layout.setAlignment(Qt.AlignmentFlag.AlignTop)
@@ -126,6 +126,47 @@ def build_controller_group(self, label: str, config: ControllerConfig):
         return group
 
 
+class OpenXRConfigGroup(QGroupBox):
+
+    def __init__(self, system_openxr_config: SystemOpenXRConfig):
+        super().__init__("OpenXR")
+        self.system_openxr_config = system_openxr_config
+
+        self.current_label = QLabel()
+
+        self.set_button = QPushButton("Set AetherVR as OpenXR Runtime")
+        self.set_button.clicked.connect(self._activate_aethervr)
+
+        layout = QFormLayout()
+        layout.addRow(QLabel("Current OpenXR Runtime:"), self.current_label)
+        layout.addRow(self.set_button)
+        self.setLayout(layout)
+
+        self.timer = QTimer(self)
+        self.timer.timeout.connect(self._refresh)
+        self.timer.start(2000)
+
+        self._refresh()
+
+    def _activate_aethervr(self):
+        if self.system_openxr_config.activate_aethervr():
+            self._refresh()
+        else:
+            QMessageBox.critical(
+                self,
+                "Error",
+                "Failed to set AetherVR as the system OpenXR runtime. "
+                + "Please make sure you're running AetherVR as an administrator.",
+            )
+
+    def _refresh(self):
+        active_runtime = self.system_openxr_config.active_runtime_name()
+        is_aethervr = self.system_openxr_config.is_aethervr(active_runtime)
+
+        self.current_label.setText("None" if active_runtime is None else active_runtime)
+        self.set_button.setEnabled(not is_aethervr)
+
+
 class ButtonBindingDropdown(QComboBox):
 
     def __init__(self, config: ControllerConfig, gesture: Gesture):
@@ -275,11 +316,11 @@ def set_state(self, connected: bool):
 
 class GUI:
 
-    def __init__(self, config: Config, connection: RuntimeConnection):
+    def __init__(self, config: Config, connection: RuntimeConnection, system_openxr_config: SystemOpenXRConfig):
         self.app = QApplication(sys.argv)
         self.app.setStyleSheet(STYLESHEET)
 
-        self.window = Window(config, connection)
+        self.window = Window(config, connection, system_openxr_config)
         self.window.show()
 
     def update_camera_frame(self, frame):

tracker/aethervr/system_openxr_config.py

@@ -0,0 +1,50 @@
+from pathlib import Path
+import winreg
+import json
+import sys
+
+
+class SystemOpenXRConfig:
+    _REG_KEY_NAME = "SOFTWARE\\Khronos\\OpenXR\\1"
+    _REG_VALUE_NAME = "ActiveRuntime"
+    _AETHERVR_MANIFEST_NAME = "openxr_runtime.json"
+
+    def active_runtime_name(self):
+        try:
+            reg = winreg.ConnectRegistry(None, winreg.HKEY_LOCAL_MACHINE)
+            key = winreg.OpenKeyEx(reg, SystemOpenXRConfig._REG_KEY_NAME, 0, winreg.KEY_QUERY_VALUE)
+            current_manifest_path, _ = winreg.QueryValueEx(key, SystemOpenXRConfig._REG_VALUE_NAME)
+            winreg.CloseKey(key)
+
+            with open(current_manifest_path) as f:
+                current_manifest = json.load(f)
+
+            return current_manifest["runtime"]["name"]
+        except Exception:
+            return None
+
+    def is_aethervr(self, runtime_name):
+        return runtime_name == "AetherVR"
+
+    def activate_aethervr(self):
+        path = self._path_to_aethervr_manifest()
+
+        try:
+            reg = winreg.ConnectRegistry(None, winreg.HKEY_LOCAL_MACHINE)
+            key = winreg.CreateKeyEx(reg, SystemOpenXRConfig._REG_KEY_NAME, 0, winreg.KEY_SET_VALUE)
+            winreg.SetValueEx(key, SystemOpenXRConfig._REG_VALUE_NAME, 0, winreg.REG_SZ, str(path))
+            winreg.CloseKey(key)
+            winreg.CloseKey(reg)
+
+            return True
+        except Exception:
+            return False
+
+    def _path_to_aethervr_manifest(self):
+        if getattr(sys, "frozen", False):
+            package_root = Path(sys.executable).parent
+            return package_root / SystemOpenXRConfig._AETHERVR_MANIFEST_NAME
+        else:
+            project_root = Path(__file__).parents[2]
+            build_dir = project_root / "openxr_runtime" / "out" / "x86_64-windows-msvc-debug"
+            return project_root / build_dir / SystemOpenXRConfig._AETHERVR_MANIFEST_NAME

tracker/aethervr_tracker.py

@@ -7,7 +7,7 @@
 from aethervr.input_state import InputState
 from aethervr.gesture_detector import GestureDetector
 from aethervr.config import Config, ControllerConfig
-import numpy as np
+from aethervr.system_openxr_config import SystemOpenXRConfig
 import time
 
 
@@ -25,23 +25,16 @@ def __init__(self):
         self.camera_capture = CameraCapture(self.on_frame)
         self.connection = RuntimeConnection(38057)
 
-        self.head_tracker = HeadTracker(
-            self.on_head_tracking_results,
-        )
-
-        self.hand_tracker = HandTracker(
-            self.head_tracker,
-            self.on_hand_tracking_results,
-        )
-
-        self.gesture_detector = GestureDetector(
-            self.config, self.tracking_state, self.input_state
-        )
+        self.head_tracker = HeadTracker(self.on_head_tracking_results)
+        self.hand_tracker = HandTracker(self.head_tracker, self.on_hand_tracking_results)
+        self.gesture_detector = GestureDetector(self.config, self.tracking_state, self.input_state)
 
         self.last_head_tracking_result = time.time()
         self.last_hand_tracking_result = time.time()
 
-        self.gui = GUI(self.config, self.connection)
+        self.system_openxr_config = SystemOpenXRConfig()
+
+        self.gui = GUI(self.config, self.connection, self.system_openxr_config)
         self.gui.run()
 
     def on_frame(self, frame):
@@ -63,7 +56,7 @@ def on_head_tracking_results(self, state: HeadState):
         self.input_state.headset_state.position = state.position
         self.input_state.headset_state.pitch = state.pitch
         self.input_state.headset_state.yaw = state.yaw
-        
+
         self.connection.update_headset_state(self.input_state.headset_state)
 
     def on_hand_tracking_results(self, left_state: HandState, right_state: HandState):
@@ -72,7 +65,7 @@ def on_hand_tracking_results(self, left_state: HandState, right_state: HandState
 
         left_controller_state = self.input_state.left_controller_state
         right_controller_state = self.input_state.right_controller_state
-        
+
         if left_state.visible:
             left_controller_state.position = left_state.position
             left_controller_state.orientation = left_state.orientation