/* * WiVRn VR streaming * Copyright (C) 2022 Guillaume Meunier * Copyright (C) 2022 Patrick Nicolas * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include "application.h" #include "hand_kinematics.h" #include "stream.h" #include "wivrn_packets.h" #include #include #include #ifdef __ANDROID__ #include "android/battery.h" #include "android/jnipp.h" #endif using tid = to_headset::tracking_control::id; static const XrDuration min_tracking_period = 2'000'000; static const XrDuration max_tracking_period = 5'000'000; static from_headset::tracking::pose locate_space(device_id device, XrSpace space, XrSpace reference, XrTime time) { XrSpaceVelocity velocity{ .type = XR_TYPE_SPACE_VELOCITY, }; XrSpaceLocation location{ .type = XR_TYPE_SPACE_LOCATION, .next = &velocity, }; xrLocateSpace(space, reference, time, &location); from_headset::tracking::pose res{ .pose = location.pose, .linear_velocity = velocity.linearVelocity, .angular_velocity = velocity.angularVelocity, .device = device, .flags = 0, }; if (location.locationFlags & XR_SPACE_LOCATION_ORIENTATION_VALID_BIT) res.flags |= from_headset::tracking::orientation_valid; if (location.locationFlags & XR_SPACE_LOCATION_POSITION_VALID_BIT) res.flags |= from_headset::tracking::position_valid; if (velocity.velocityFlags & XR_SPACE_VELOCITY_LINEAR_VALID_BIT) res.flags |= from_headset::tracking::linear_velocity_valid; if (velocity.velocityFlags & XR_SPACE_VELOCITY_ANGULAR_VALID_BIT) res.flags |= from_headset::tracking::angular_velocity_valid; if (location.locationFlags & XR_SPACE_LOCATION_ORIENTATION_TRACKED_BIT) res.flags |= from_headset::tracking::orientation_tracked; if (location.locationFlags & XR_SPACE_LOCATION_POSITION_TRACKED_BIT) res.flags |= from_headset::tracking::position_tracked; return res; } namespace { class timer { xr::instance & instance; XrTime start = instance.now(); public: timer(xr::instance & instance) : instance(instance) {} XrDuration count() { return instance.now() - start; } }; } // namespace static std::optional> locate_hands(xr::hand_tracker & hand, XrSpace space, XrTime time) { auto joints = hand.locate(space, time); if (joints) { std::array poses; for (int i = 0; i < XR_HAND_JOINT_COUNT_EXT; i++) { poses[i] = { .pose = (*joints)[i].first.pose, .linear_velocity = (*joints)[i].second.linearVelocity, .angular_velocity = (*joints)[i].second.angularVelocity, .radius = uint16_t((*joints)[i].first.radius * 10'000), }; if ((*joints)[i].first.locationFlags & XR_SPACE_LOCATION_ORIENTATION_VALID_BIT) poses[i].flags |= from_headset::hand_tracking::orientation_valid; if ((*joints)[i].first.locationFlags & XR_SPACE_LOCATION_POSITION_VALID_BIT) poses[i].flags |= from_headset::hand_tracking::position_valid; if ((*joints)[i].second.velocityFlags & XR_SPACE_VELOCITY_LINEAR_VALID_BIT) poses[i].flags |= from_headset::hand_tracking::linear_velocity_valid; if ((*joints)[i].second.velocityFlags & XR_SPACE_VELOCITY_ANGULAR_VALID_BIT) poses[i].flags |= from_headset::hand_tracking::angular_velocity_valid; if ((*joints)[i].first.locationFlags & XR_SPACE_LOCATION_ORIENTATION_TRACKED_BIT) poses[i].flags |= from_headset::hand_tracking::orientation_tracked; if ((*joints)[i].first.locationFlags & XR_SPACE_LOCATION_POSITION_TRACKED_BIT) poses[i].flags |= from_headset::hand_tracking::position_tracked; } return poses; } else return std::nullopt; } static bool enabled(const to_headset::tracking_control & control, device_id id) { switch (id) { case device_id::HEAD: case device_id::EYE_GAZE: return true; case device_id::LEFT_AIM: return control.enabled[size_t(tid::left_aim)]; case device_id::LEFT_GRIP: return control.enabled[size_t(tid::left_grip)]; case device_id::LEFT_PALM: return control.enabled[size_t(tid::left_palm)]; case device_id::RIGHT_AIM: return control.enabled[size_t(tid::right_aim)]; case device_id::RIGHT_GRIP: return control.enabled[size_t(tid::right_grip)]; case device_id::RIGHT_PALM: return control.enabled[size_t(tid::right_palm)]; default: break; } __builtin_unreachable(); } static void pack_hand_data(std::vector & packed_hands, std::pair & constants, const std::optional> & pose, uint64_t production_timestamp, uint64_t timestamp, from_headset::packed_hand_tracking::hand_id hand_id) { if (!pose) return; hand_kinematics hk; hand_kinematics::pose p; for (auto [i, j]: std::views::zip(*pose, p)) { j.position[0] = i.pose.position.x; j.position[1] = i.pose.position.y; j.position[2] = i.pose.position.z; j.rotation[0] = i.pose.orientation.x; j.rotation[1] = i.pose.orientation.y; j.rotation[2] = i.pose.orientation.z; j.rotation[3] = i.pose.orientation.w; j.linear_velocity[0] = i.linear_velocity.x; j.linear_velocity[1] = i.linear_velocity.y; j.linear_velocity[2] = i.linear_velocity.z; j.angular_velocity[0] = i.angular_velocity.x; j.angular_velocity[1] = i.angular_velocity.y; j.angular_velocity[2] = i.angular_velocity.z; } // TODO average constants over several frames and send them less often auto [consts, packed_pose] = hk.pack(p); hk.apply_ik(consts, packed_pose, p); packed_hands.emplace_back( production_timestamp, timestamp, hand_id, true, packed_pose); // TODO average using floats for (auto [i, j]: std::views::zip(*pose, constants.second.radius)) { j = (i.radius + j * constants.first) / (constants.first + 1); } for (auto [i, j]: std::views::zip(consts, constants.second.constants)) { j = (i + j * constants.first) / (constants.first + 1); } constants.first++; } void scenes::stream::tracking() { #ifdef __ANDROID__ // Runtime may use JNI and needs the thread to be attached application::instance().setup_jni(); XrTime next_battery_check = 0; const XrDuration battery_check_interval = 30'000'000'000; // 30s #endif std::vector> spaces = { {device_id::HEAD, application::space(xr::spaces::view)}, {device_id::LEFT_AIM, application::space(xr::spaces::aim_left)}, {device_id::LEFT_GRIP, application::space(xr::spaces::grip_left)}, {device_id::RIGHT_AIM, application::space(xr::spaces::aim_right)}, {device_id::RIGHT_GRIP, application::space(xr::spaces::grip_right)}}; if (XrSpace palm = application::space(xr::spaces::palm_left)) spaces.emplace_back(device_id::LEFT_PALM, palm); if (XrSpace palm = application::space(xr::spaces::palm_right)) spaces.emplace_back(device_id::RIGHT_PALM, palm); const auto & config = application::get_config(); if (config.check_feature(feature::eye_gaze)) spaces.push_back({device_id::EYE_GAZE, application::space(xr::spaces::eye_gaze)}); XrSpace view_space = application::space(xr::spaces::view); XrSpace world_space = application::space(xr::spaces::world); XrDuration tracking_period = min_tracking_period; XrTime t0 = instance.now(); XrTime last_hand_sample = t0; std::vector tracking; std::vector hands; std::vector packed_hands; std::pair hand_constants_left; std::pair hand_constants_right; int skip_samples = 0; const bool hand_tracking = config.check_feature(feature::hand_tracking); const bool face_tracking = config.check_feature(feature::face_tracking); while (not exiting) { try { tracking.clear(); hands.clear(); packed_hands.clear(); hand_constants_left = std::pair{}; hand_constants_right = std::pair{}; hand_constants_left.second.hand = from_headset::hand_tracking_constants::left; hand_constants_right.second.hand = from_headset::hand_tracking_constants::right; XrTime now = instance.now(); if (now < t0) std::this_thread::sleep_for(std::chrono::nanoseconds(t0 - now)); // If thread can't keep up, skip timestamps t0 = std::max(t0, now); timer t(instance); int samples = 0; to_headset::tracking_control control; { std::lock_guard lock(tracking_control_mutex); control = tracking_control; } XrDuration prediction = std::clamp(control.offset.count(), 0, 80'000'000); auto period = std::max(display_time_period.load(), 1'000'000); for (XrDuration Δt = 0; Δt <= prediction + period / 2; Δt += period, ++samples) { auto & packet = tracking.emplace_back(); packet.production_timestamp = t0; packet.timestamp = t0 + Δt; try { auto [flags, views] = session.locate_views(XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO, t0 + Δt, view_space); assert(views.size() == packet.views.size()); for (auto [i, j]: std::views::zip(views, packet.views)) { j.pose = i.pose; j.fov = i.fov; } packet.view_flags = flags; packet.state_flags = 0; if (recenter_requested.exchange(false)) packet.state_flags = wivrn::from_headset::tracking::recentered; packet.device_poses.clear(); for (auto [device, space]: spaces) { if (enabled(control, device)) packet.device_poses.push_back(locate_space(device, space, world_space, t0 + Δt)); } // Hand tracking data are very large, send fewer samples than other items if (hand_tracking and t0 >= last_hand_sample + period and (Δt == 0 or Δt >= prediction - 2 * period)) { last_hand_sample = t0; if (control.enabled[size_t(tid::left_hand)]) { auto pose = locate_hands(application::get_left_hand(), world_space, t0 + Δt); hands.emplace_back( t0, t0 + Δt, from_headset::hand_tracking::left, pose); pack_hand_data(packed_hands, hand_constants_left, pose, t0, t0 + Δt, from_headset::packed_hand_tracking::left); } if (control.enabled[size_t(tid::right_hand)]) { auto pose = locate_hands(application::get_right_hand(), world_space, t0 + Δt); hands.emplace_back( t0, t0 + Δt, from_headset::hand_tracking::right, pose); pack_hand_data(packed_hands, hand_constants_right, pose, t0, t0 + Δt, from_headset::packed_hand_tracking::right); } } if (face_tracking and control.enabled[size_t(tid::face)]) { application::get_fb_face_tracker2().get_weights(t0 + Δt, packet.face.emplace()); } } catch (const std::system_error & e) { if (e.code().category() != xr::error_category() or e.code().value() != XR_ERROR_TIME_INVALID) throw; } // Make sure predictions are phase-synced with display time if (Δt == 0 and prediction) { Δt = display_time_phase - t0 % period + skip_samples * period; } } XrDuration busy_time = t.count(); // Target: polling between 1 and 5ms, with 20% busy time tracking_period = std::clamp(std::lerp(tracking_period, busy_time * 5, 0.2), min_tracking_period, max_tracking_period); if (samples and busy_time / samples > 2'000'000) { skip_samples = busy_time / 2'000'000; } #ifdef __ANDROID__ if (next_battery_check < now and control.enabled[size_t(tid::battery)]) { timer t2(instance); auto status = get_battery_status(); network_session->send_stream(from_headset::battery{ .charge = status.charge.value_or(-1), .present = status.charge.has_value(), .charging = status.charging, }); next_battery_check = now + battery_check_interval; XrDuration battery_dur = t2.count(); spdlog::info("Battery check took: {}", battery_dur); } #endif std::vector merged_tracking(1); size_t current_size = 0; for (auto & item: tracking) { size_t size = serialized_size(item); if (size + current_size > 1400) { merged_tracking.emplace_back(); current_size = 0; } current_size += size; merged_tracking.back().items.push_back(std::move(item)); } std::vector packets; packets.reserve(merged_tracking.size() + hands.size() + packed_hands.size() + 2); for (const auto & i: merged_tracking) { wivrn_session::stream_socket_t::serialize(packets.emplace_back(), i); } // for (const auto & i: hands) // { // if (i.joints) // wivrn_session::stream_socket_t::serialize(packets.emplace_back(), i); // } if (not packed_hands.empty()) { wivrn_session::stream_socket_t::serialize(packets.emplace_back(), hand_constants_left.second); wivrn_session::stream_socket_t::serialize(packets.emplace_back(), hand_constants_right.second); } for (const auto & i: packed_hands) { wivrn_session::stream_socket_t::serialize(packets.emplace_back(), i); } network_session->send_stream(std::move(packets)); t0 += tracking_period; } catch (std::exception & e) { spdlog::info("Exception in tracking thread, exiting: {}", e.what()); exit(); } } } void scenes::stream::operator()(to_headset::tracking_control && packet) { std::lock_guard lock(tracking_control_mutex); auto m = size_t(to_headset::tracking_control::id::microphone); if (audio_handle) audio_handle->set_mic_sate(packet.enabled[m]); tracking_control = packet; }