YVR1/2 support (#1455)

Author: muxiaozi

README.md

@@ -14,6 +14,7 @@ This is a fork of [ALVR](https://github.com/polygraphene/ALVR).
 |   Quest 1/2/Pro   |    :heavy_check_mark:     |
 |   Pico 4/Neo 3    |   :heavy_check_mark: *    |
 |   Vive Focus 3    |   :heavy_check_mark: *    |
+|      YVR 1/2      |   :heavy_check_mark: *    |
 | Smartphone/Monado |     :construction: **     |
 |      GearVR       |     :construction: **     |
 |  Google Daydream  | :construction: ** (maybe) |

alvr/client_openxr/Cargo.toml

@@ -89,6 +89,7 @@ actions = ["android.intent.action.MAIN"]
 categories = [
     "android.intent.category.LAUNCHER",
     "com.oculus.intent.category.VR",
+    "com.yvr.intent.category.VR",
     "org.khronos.openxr.intent.category.IMMERSIVE_HMD",
 ]
 
@@ -140,3 +141,8 @@ value = "vr"
 [[package.metadata.android.application.meta_data]]
 name = "handtracking"
 value = "1"
+
+# Yvr entries
+[[package.metadata.android.application.meta_data]]
+name = "com.yvr.intent.category.VR"
+value = "vr_only"

alvr/client_openxr/src/interaction.rs

@@ -33,6 +33,7 @@ pub struct ButtonBindingInfo {
 // popularity, all OpenXR runtimes should support binding to the oculus touch controller.
 const OCULUS_TOUCH_CONTROLLER_PROFILE: &str = "/interaction_profiles/oculus/touch_controller";
 const PICO_CONTROLLER_PROFILE: &str = "/interaction_profiles/pico/neo3_controller";
+const YVR_CONTROLLER_PROFILE: &str = "/interaction_profiles/yvr/touch_controller";
 
 fn get_button_bindings(platform: Platform) -> HashMap<u64, ButtonBindingInfo> {
     let mut list = vec![
@@ -320,6 +321,65 @@ fn get_button_bindings(platform: Platform) -> HashMap<u64, ButtonBindingInfo> {
         ]);
     }
 
+    if platform == Platform::Yvr {
+        list.extend([
+            (
+                *LEFT_SQUEEZE_CLICK_ID,
+                ButtonBindingInfo {
+                    name: "left_squeeze_click".into(),
+                    binding_path: "/user/hand/left/input/squeeze".into(),
+                    binding_type: BindingType::Binary,
+                },
+            ),
+            (
+                *LEFT_TRIGGER_CLICK_ID,
+                ButtonBindingInfo {
+                    name: "left_trigger_click".into(),
+                    binding_path: "/user/hand/left/input/trigger".into(),
+                    binding_type: BindingType::Binary,
+                },
+            ),
+            (
+                *LEFT_THUMBREST_TOUCH_ID,
+                ButtonBindingInfo {
+                    name: "left_thumbrest_touch".into(),
+                    binding_path: LEFT_THUMBREST_TOUCH_PATH.into(),
+                    binding_type: BindingType::Binary,
+                },
+            ),
+            (
+                *RIGHT_SQUEEZE_CLICK_ID,
+                ButtonBindingInfo {
+                    name: "right_squeeze_click".into(),
+                    binding_path: "/user/hand/right/input/squeeze".into(),
+                    binding_type: BindingType::Binary,
+                },
+            ),
+            (
+                *RIGHT_TRIGGER_CLICK_ID,
+                ButtonBindingInfo {
+                    name: "right_trigger_click".into(),
+                    binding_path: "/user/hand/right/input/trigger".into(),
+                    binding_type: BindingType::Binary,
+                },
+            ),
+            (
+                *RIGHT_THUMBREST_TOUCH_ID,
+                ButtonBindingInfo {
+                    name: "right_thumbrest_touch".into(),
+                    binding_path: RIGHT_THUMBREST_TOUCH_PATH.into(),
+                    binding_type: BindingType::Binary,
+                },
+            ),
+        ]);
+
+        let disable_paths = vec![*LEFT_SQUEEZE_VALUE_ID, *RIGHT_SQUEEZE_VALUE_ID];
+        list = list
+            .into_iter()
+            .filter(|x| !disable_paths.contains(&x.0))
+            .collect::<Vec<_>>();
+    }
+
     list.into_iter().collect()
 }
 
@@ -421,10 +481,12 @@ pub fn initialize_streaming_interaction(
 
     // Apply bindings:
 
-    let controller_profile = if platform == Platform::Pico {
-        PICO_CONTROLLER_PROFILE
-    } else {
-        OCULUS_TOUCH_CONTROLLER_PROFILE
+    let controller_profile = match platform {
+        Platform::Quest => OCULUS_TOUCH_CONTROLLER_PROFILE,
+        Platform::Pico => PICO_CONTROLLER_PROFILE,
+        Platform::Vive => OCULUS_TOUCH_CONTROLLER_PROFILE,
+        Platform::Yvr => YVR_CONTROLLER_PROFILE,
+        Platform::Other => OCULUS_TOUCH_CONTROLLER_PROFILE,
     };
 
     xr_instance
@@ -531,7 +593,18 @@ pub fn get_hand_motion(
     }
 }
 
+fn fix_yvr_squeeze_value(action_id: u64, state: bool) {
+    let scalar_value = if state { 1_f32 } else { 0_f32 };
+
+    if action_id == *LEFT_SQUEEZE_CLICK_ID {
+        alvr_client_core::send_button(*LEFT_SQUEEZE_VALUE_ID, ButtonValue::Scalar(scalar_value));
+    } else if action_id == *RIGHT_SQUEEZE_CLICK_ID {
+        alvr_client_core::send_button(*RIGHT_SQUEEZE_VALUE_ID, ButtonValue::Scalar(scalar_value));
+    }
+}
+
 pub fn update_buttons(
+    platform: Platform,
     xr_session: &xr::Session<xr::AnyGraphics>,
     button_actions: &HashMap<u64, ButtonAction>,
 ) -> StrResult {
@@ -542,6 +615,9 @@ pub fn update_buttons(
 
                 if state.changed_since_last_sync {
                     alvr_client_core::send_button(*id, ButtonValue::Binary(state.current_state));
+                    if platform == Platform::Yvr {
+                        fix_yvr_squeeze_value(*id, state.current_state);
+                    }
                 }
             }
             ButtonAction::Scalar(action) => {

alvr/client_openxr/src/lib.rs

@@ -29,6 +29,7 @@ pub enum Platform {
     Quest,
     Pico,
     Vive,
+    Yvr,
     Other,
 }
 
@@ -292,7 +293,11 @@ fn update_streaming_input(ctx: &StreamingInputContext, last_ipd: &mut f32) -> St
         right_hand_skeleton,
     });
 
-    interaction::update_buttons(&ctx.xr_session, &ctx.interaction_context.button_actions)
+    interaction::update_buttons(
+        ctx.platform,
+        &ctx.xr_session,
+        &ctx.interaction_context.button_actions,
+    )
 }
 
 pub fn entry_point() {
@@ -302,6 +307,7 @@ pub fn entry_point() {
         "Oculus" => Platform::Quest,
         "Pico" => Platform::Pico,
         "HTC" => Platform::Vive,
+        "YVR" => Platform::Yvr,
         _ => Platform::Other,
     };
 
@@ -312,6 +318,9 @@ pub fn entry_point() {
         Platform::Pico => unsafe {
             xr::Entry::load_from(Path::new("libopenxr_loader_pico.so")).unwrap()
         },
+        Platform::Yvr => unsafe {
+            xr::Entry::load_from(Path::new("libopenxr_loader_yvr.so")).unwrap()
+        },
         _ => unsafe { xr::Entry::load().unwrap() },
     };
 

alvr/xtask/src/dependencies.rs

@@ -265,6 +265,21 @@ fn get_android_openxr_loaders() {
         destination_dir.join("libopenxr_loader_pico.so"),
     )
     .unwrap();
+    fs::remove_dir_all(&temp_dir).ok();
+
+    // Yvr
+    command::download_and_extract_zip(
+        &sh,
+        "https://developer.yvrdream.com/yvrdoc/sdk/openxr/yvr_openxr_mobile_sdk_1.0.0.zip",
+        &temp_dir,
+    )
+    .unwrap();
+    fs::copy(
+        temp_dir
+            .join("yvr_openxr_mobile_sdk_1.0.0/OpenXR/Libs/Android/arm64-v8a/libopenxr_loader.so"),
+        destination_dir.join("libopenxr_loader_yvr.so"),
+    )
+    .unwrap();
     fs::remove_dir_all(temp_dir).ok();
 }