device/vr/openxr/openxr_hand_tracker.cc

// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "device/vr/openxr/openxr_hand_tracker.h"

#include <optional>
#include <vector>

#include "base/command_line.h"
#include "base/compiler_specific.h"
#include "base/containers/flat_set.h"
#include "base/no_destructor.h"
#include "base/strings/string_util.h"
#include "base/trace_event/trace_event.h"
#include "device/vr/openxr/openxr_extension_helper.h"
#include "device/vr/openxr/openxr_hand_utils.h"
#include "device/vr/openxr/openxr_interaction_profiles.h"
#include "device/vr/openxr/openxr_util.h"
#include "device/vr/public/cpp/switches.h"
#include "device/vr/public/mojom/xr_hand_tracking_data.mojom.h"
#include "device/vr/public/mojom/xr_session.mojom-shared.h"
#include "third_party/openxr/src/include/openxr/openxr.h"

namespace device {

OpenXrHandTracker::AnonymizationStrategy
OpenXrHandTracker::GetAnonymizationStrategy() {
  auto* command_line = base::CommandLine::ForCurrentProcess();
  if (!command_line->HasSwitch(switches::kWebXrHandAnonymizationStrategy)) {
    return OpenXrHandTracker::AnonymizationStrategy::kDefault;
  }

  const auto& strategy_str = command_line->GetSwitchValueASCII(
      switches::kWebXrHandAnonymizationStrategy);

  if (base::CompareCaseInsensitiveASCII(
          strategy_str, switches::kWebXrHandAnonymizationStrategyRuntime) ==
      0) {
    return OpenXrHandTracker::AnonymizationStrategy::kRuntime;
  }

  if (base::CompareCaseInsensitiveASCII(
          strategy_str, switches::kWebXrHandAnonymizationStrategyFallback) ==
      0) {
    return OpenXrHandTracker::AnonymizationStrategy::kFallback;
  }

  if (base::CompareCaseInsensitiveASCII(
          strategy_str, switches::kWebXrHandAnonymizationStrategyNone) == 0) {
    return OpenXrHandTracker::AnonymizationStrategy::kNone;
  }

  // Use the default strategy for unknown values.
  return OpenXrHandTracker::AnonymizationStrategy::kDefault;
}

OpenXrHandTracker::OpenXrHandTracker(
    const OpenXrExtensionHelper& extension_helper,
    XrSession session,
    OpenXrHandednessType type)
    : extension_helper_(extension_helper),
      session_(session),
      type_(type),
      mesh_scale_enabled_(
          extension_helper_->ExtensionEnumeration()->ExtensionSupported(
              XR_FB_HAND_TRACKING_MESH_EXTENSION_NAME)),
      anonymization_strategy_(GetAnonymizationStrategy()) {
  locations_.jointCount = joint_locations_buffer_.size();
  locations_.jointLocations = joint_locations_buffer_.data();

  // This is only used if mesh_scale_enabled_ is true, but it doesn't hurt to
  // initialize it anyway.
  // Setting `overrideHandScale` to true and `overrideValueInput` to 1 will
  // scale the hands to the size of the "standard" hand mesh per:
  // https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XrHandTrackingScaleFB
  mesh_scale_.overrideHandScale = true;
  mesh_scale_.overrideValueInput = 1.0f;
}

OpenXrHandTracker::~OpenXrHandTracker() {
  if (hand_tracker_ != XR_NULL_HANDLE) {
    extension_helper_->ExtensionMethods().xrDestroyHandTrackerEXT(
        hand_tracker_);
  }
}

bool OpenXrHandTracker::UseRuntimeAnonymization() const {
  return anonymization_strategy_ == AnonymizationStrategy::kDefault ||
         anonymization_strategy_ == AnonymizationStrategy::kRuntime;
}

bool OpenXrHandTracker::NeedsFallbackAnonymization() const {
  return anonymization_strategy_ == AnonymizationStrategy::kFallback ||
         (anonymization_strategy_ == AnonymizationStrategy::kDefault &&
          !mesh_scale_enabled_);
}

XrResult OpenXrHandTracker::Update(XrSpace base_space,
                                   XrTime predicted_display_time) {
  // Lazy init hand tracking as we only need it if the app requests it.
  if (hand_tracker_ == XR_NULL_HANDLE) {
    RETURN_IF_XR_FAILED(InitializeHandTracking());
  }

  XrHandJointsLocateInfoEXT locate_info{XR_TYPE_HAND_JOINTS_LOCATE_INFO_EXT};
  locate_info.baseSpace = base_space;
  locate_info.time = predicted_display_time;

  void** next = &locations_.next;
  if (mesh_scale_enabled_ && UseRuntimeAnonymization()) {
    *next = &mesh_scale_;
    next = &mesh_scale_.next;
  }

  ExtendHandTrackingNextChain(next);

  XrResult result = extension_helper_->ExtensionMethods().xrLocateHandJointsEXT(
      hand_tracker_, &locate_info, &locations_);
  if (XR_FAILED(result)) {
    locations_.isActive = false;
  }

  return result;
}

mojom::XRHandTrackingDataPtr OpenXrHandTracker::GetHandTrackingData() const {
  if (!IsDataValid()) {
    return nullptr;
  }

  // If the anonymization strategy is required to force runtime anonymization
  // and mesh scale isn't enabled, then we can't anonymize the data and must
  // return nullptr.
  if (anonymization_strategy_ == AnonymizationStrategy::kRuntime &&
      !mesh_scale_enabled_) {
    return nullptr;
  }
  TRACE_EVENT1("xr", "GetHandTrackingData", "XrHandedness", type_);

  mojom::XRHandTrackingDataPtr hand_tracking_data =
      device::mojom::XRHandTrackingData::New();
  hand_tracking_data->hand_joint_data =
      std::vector<mojom::XRHandJointDataPtr>{};

  hand_tracking_data->hand_joint_data.reserve(kNumWebXRJoints);
  for (uint32_t i = 0; i < XR_HAND_JOINT_COUNT_EXT; i++) {
    // We skip the palm joint as WebXR does not support it. All other joints are
    // supported
    if (i == XR_HAND_JOINT_PALM_EXT) {
      continue;
    }

    mojom::XRHandJointDataPtr joint_data =
        device::mojom::XRHandJointData::New();
    joint_data->joint =
        OpenXRHandJointToMojomJoint(static_cast<XrHandJointEXT>(i));
    joint_data->mojo_from_joint =
        XrPoseToGfxTransform(joint_locations_buffer_[i].pose);
    joint_data->radius = joint_locations_buffer_[i].radius;
    hand_tracking_data->hand_joint_data.push_back(std::move(joint_data));
  }

  // If we need to perform fallback anonymization and it fails, then return
  // nullptr. Otherwise, further anonymization is either not needed or
  // succeeded and we can return the data.
  if (NeedsFallbackAnonymization() &&
      !AnonymizeHand(base::span(hand_tracking_data->hand_joint_data))) {
    return nullptr;
  }

  return hand_tracking_data;
}

const OpenXrHandController* OpenXrHandTracker::controller() const {
  return nullptr;
}

XrResult OpenXrHandTracker::InitializeHandTracking() {
  XrHandTrackerCreateInfoEXT create_info{XR_TYPE_HAND_TRACKER_CREATE_INFO_EXT};
  create_info.hand = type_ == OpenXrHandednessType::kRight ? XR_HAND_RIGHT_EXT
                                                           : XR_HAND_LEFT_EXT;
  create_info.handJointSet = XR_HAND_JOINT_SET_DEFAULT_EXT;
  return extension_helper_->ExtensionMethods().xrCreateHandTrackerEXT(
      session_, &create_info, &hand_tracker_);
}

bool OpenXrHandTracker::IsDataValid() const {
  return hand_tracker_ != XR_NULL_HANDLE && locations_.isActive;
}

std::optional<gfx::Transform> OpenXrHandTracker::GetBaseFromPalmTransform()
    const {
  if (!IsDataValid()) {
    return std::nullopt;
  }

  return XrPoseToGfxTransform(
      joint_locations_buffer_[XR_HAND_JOINT_PALM_EXT].pose);
}

OpenXrHandTrackerFactory::OpenXrHandTrackerFactory() = default;
OpenXrHandTrackerFactory::~OpenXrHandTrackerFactory() = default;

const base::flat_set<std::string_view>&
OpenXrHandTrackerFactory::GetRequestedExtensions() const {
  static base::NoDestructor<base::flat_set<std::string_view>> kExtensions(
      {XR_EXT_HAND_TRACKING_EXTENSION_NAME,
       XR_EXT_HAND_INTERACTION_EXTENSION_NAME,
       XR_MSFT_HAND_INTERACTION_EXTENSION_NAME,
       XR_FB_HAND_TRACKING_MESH_EXTENSION_NAME});
  return *kExtensions;
}

std::set<device::mojom::XRSessionFeature>
OpenXrHandTrackerFactory::GetSupportedFeatures() const {
  if (!IsEnabled()) {
    return {};
  }

  return {device::mojom::XRSessionFeature::HAND_INPUT};
}

void OpenXrHandTrackerFactory::CheckAndUpdateEnabledState(
    const OpenXrExtensionEnumeration* extension_enum,
    XrInstance instance,
    XrSystemId system) {
  // Our list of requested extensions is a "base" extension that provides
  // the default hand joint data and a set of "targeting" extensions that give
  // the rest of the data that let us represent the hand as a controller. We
  // need both the "base" and at least one "targeting" extension to be supported
  // in order to support the hand tracker.
  bool base_extension_supported =
      extension_enum->ExtensionSupported(XR_EXT_HAND_TRACKING_EXTENSION_NAME);
  bool targeting_extension_supported = std::ranges::any_of(
      GetRequestedExtensions(), [&extension_enum](std::string_view extension) {
        return UNSAFE_TODO(strcmp(extension.data(),
                                  XR_EXT_HAND_TRACKING_EXTENSION_NAME)) != 0 &&
               extension_enum->ExtensionSupported(extension.data());
      });
  SetEnabled(base_extension_supported && targeting_extension_supported);
}

std::unique_ptr<OpenXrHandTracker> OpenXrHandTrackerFactory::CreateHandTracker(
    const OpenXrExtensionHelper& extension_helper,
    XrSession session,
    OpenXrHandednessType type) const {
  bool is_supported = IsEnabled();
  DVLOG(2) << __func__ << " is_supported=" << is_supported;
  if (is_supported) {
    return std::make_unique<OpenXrHandTracker>(extension_helper, session, type);
  }

  return nullptr;
}

}  // namespace device