Implement forwarding XR_EXT_user_presence from client to server to Steam (#3052)

* Implement forwarding XR_EXT_user_presence from client to server to Steam

* bump -devXX version to 11

* fixup

* alphabetical order

* remove logs

* change enum order

* add c_api event for proximity

* rename user_presence to proximity_state

* rename last occurance of user presence

* fix format

* rename remaining instances of proximity_state to headset_is_worn

* Send initial state of proximity sensor when reconnecting

* undo changes to early hmd initialization

* explicit field name headset_is_worn for messages

* change order

* Revert "Send initial state of proximity sensor when reconnecting"

This reverts commit 0ad0037.

* change user presence log to debug

Author: diekleinekuh

alvr/client_core/src/lib.rs

@@ -223,6 +223,14 @@ impl ClientCoreContext {
         }
     }
 
+    pub fn send_proximity_state(&self, headset_is_worn: bool) {
+        if let Some(sender) = &mut *self.connection_context.control_sender.lock() {
+            sender
+                .send(&ClientControlPacket::ProximityState(headset_is_worn))
+                .ok();
+        }
+    }
+
     pub fn get_total_prediction_offset(&self) -> Duration {
         dbg_client_core!("get_total_prediction_offset");
 

alvr/client_openxr/src/lib.rs

@@ -9,7 +9,7 @@ mod stream;
 use crate::stream::ParsedStreamConfig;
 use alvr_client_core::{ClientCapabilities, ClientCoreContext, ClientCoreEvent};
 use alvr_common::{
-    Fov, HAND_LEFT_ID, Pose, error,
+    Fov, HAND_LEFT_ID, Pose, debug, error,
     glam::{Quat, UVec2, Vec3},
     info,
     parking_lot::RwLock,
@@ -166,6 +166,7 @@ pub fn entry_point() {
     exts.ext_eye_gaze_interaction = available_extensions.ext_eye_gaze_interaction;
     exts.ext_hand_tracking = available_extensions.ext_hand_tracking;
     exts.ext_local_floor = available_extensions.ext_local_floor;
+    exts.ext_user_presence = available_extensions.ext_user_presence;
     exts.fb_body_tracking = available_extensions.fb_body_tracking;
     exts.fb_color_space = available_extensions.fb_color_space;
     exts.fb_composition_layer_settings = available_extensions.fb_composition_layer_settings;
@@ -326,6 +327,7 @@ pub fn entry_point() {
         let mut passthrough_layer = None;
 
         let mut event_storage = xr::EventDataBuffer::new();
+        let mut headset_is_worn = true;
         'render_loop: loop {
             while let Some(event) = xr_instance.poll_event(&mut event_storage).unwrap() {
                 match event {
@@ -384,6 +386,12 @@ pub fn entry_point() {
                     | xr::Event::PassthroughStateChangedFB(_) => {
                         // todo
                     }
+                    xr::Event::UserPresenceChangedEXT(event) => {
+                        debug!("user present: {:?}", event.is_user_present());
+                        headset_is_worn = event.is_user_present();
+
+                        core_context.send_proximity_state(event.is_user_present());
+                    }
                     _ => (),
                 }
             }
@@ -416,6 +424,8 @@ pub fn entry_point() {
                         }
 
                         stream_context = Some(context);
+
+                        core_context.send_proximity_state(headset_is_worn);
                     }
                     ClientCoreEvent::StreamingStopped => {
                         if passthrough_layer.is_none() {

alvr/packets/src/lib.rs

@@ -194,6 +194,7 @@ pub enum ClientControlPacket {
         level: LogSeverity,
         message: String,
     },
+    ProximityState(bool),
     Reserved(String),
     ReservedBuffer(Vec<u8>),
 }

alvr/server_core/src/c_api.rs

@@ -71,6 +71,7 @@ pub enum AlvrEvent {
     CaptureFrame,
     RestartPending,
     ShutdownPending,
+    ProximityState(bool),
 }
 
 #[repr(C)]
@@ -293,6 +294,9 @@ pub unsafe extern "C" fn alvr_poll_event(out_event: *mut AlvrEvent, timeout_ns:
             },
             ServerCoreEvent::GameRenderLatencyFeedback(_)
             | ServerCoreEvent::SetOpenvrProperty { .. } => {} // implementation not needed
+            ServerCoreEvent::ProximityState(headset_is_worn) => unsafe {
+                *out_event = AlvrEvent::ProximityState(headset_is_worn);
+            },
         }
 
         true

alvr/server_core/src/connection.rs

@@ -1309,6 +1309,11 @@ fn connection_pipeline(
                         info!("Client {client_hostname}: [{level:?}] {message}")
                     }
                     ClientControlPacket::KeepAlive | ClientControlPacket::StreamReady => (),
+                    ClientControlPacket::ProximityState(headset_is_worn) => {
+                        ctx.events_sender
+                            .send(ServerCoreEvent::ProximityState(headset_is_worn))
+                            .ok();
+                    }
                     ClientControlPacket::Reserved(_) | ClientControlPacket::ReservedBuffer(_) => (),
                 }
 

alvr/server_core/src/lib.rs

@@ -89,6 +89,7 @@ pub enum ServerCoreEvent {
     GameRenderLatencyFeedback(Duration), // only used for SteamVR
     ShutdownPending,
     RestartPending,
+    ProximityState(bool),
 }
 
 pub struct ConnectionContext {

alvr/server_openvr/cpp/alvr_server/HMD.cpp

@@ -296,6 +296,10 @@ void Hmd::SetViewParams(const FfiViewParams params[2]) {
     );
 }
 
+void Hmd::SetProximityState(bool headsetIsWorn) {
+    vr::VRDriverInput()->UpdateBooleanComponent(m_proximity, headsetIsWorn, 0.0);
+}
+
 void Hmd::GetWindowBounds(int32_t* pnX, int32_t* pnY, uint32_t* pnWidth, uint32_t* pnHeight) {
     Debug(
         "Hmd::GetWindowBounds %dx%d - %dx%d\n",

alvr/server_openvr/cpp/alvr_server/HMD.h

@@ -29,6 +29,7 @@ class Hmd : public TrackedDevice, vr::IVRDisplayComponent {
     void StartStreaming();
     void StopStreaming();
     void SetViewParams(const FfiViewParams params[2]);
+    void SetProximityState(bool headsetIsWorn);
 
 private:
     vr::VRInputComponentHandle_t m_proximity;

alvr/server_openvr/cpp/alvr_server/alvr_server.cpp

@@ -513,6 +513,12 @@ void SetButton(unsigned long long buttonID, FfiButtonValue value) {
     }
 }
 
+void SetProximityState(bool headset_is_worn) {
+    if (g_driver_provider.hmd) {
+        g_driver_provider.hmd->SetProximityState(headset_is_worn);
+    }
+}
+
 void SetChaperoneArea(float areaWidth, float areaHeight) {
     _SetChaperoneArea(areaWidth, areaHeight);
 }

alvr/server_openvr/cpp/alvr_server/bindings.h

@@ -161,6 +161,7 @@ extern "C" void RegisterButton(void* instancePtr, unsigned long long buttonID);
 extern "C" void SetLocalViewParams(const FfiViewParams params[2]);
 extern "C" void SetBattery(unsigned long long deviceID, float gauge_value, bool is_plugged);
 extern "C" void SetButton(unsigned long long buttonID, FfiButtonValue value);
+extern "C" void SetProximityState(bool headset_is_worn);
 
 extern "C" void InitOpenvrClient();
 extern "C" void ShutdownOpenvrClient();