Add version and input support via protobuf

Author: Erimelowo

README.md

@@ -58,6 +58,6 @@ To update vcpkg packages set the vcpkg registry submodule to a newer commit and
 
 ### Updating protobuf messages
 
-You can modify the protobuf messages for communication between the server and this driver at [src\bridge\ProtobufMessages.proto](src\bridge\ProtobufMessages.proto)
+You can modify the protobuf messages for communication between the server and this driver in [src\bridge\ProtobufMessages.proto](src\bridge\ProtobufMessages.proto). Please update PROTOCOL_VERSION in [src\bridge\BridgeClient.hpp](src\bridge\BridgeClient.hpp)
 
 To update the protobuf messages on the server, you will need to install [protoc](https://protobuf.dev/installation/) (we use version 4.31.1), then make sure that your SlimeVR-Server and SlimeVR-OpenVR-Driver repositories are in the same parent directory and run `protobuf_update.bat` located at `SlimeVR-Server\server\desktop`

src/TrackerDevice.cpp

@@ -1,12 +1,12 @@
 #include "TrackerDevice.hpp"
 
-SlimeVRDriver::TrackerDevice::TrackerDevice(std::string serial, int device_id, TrackerRole tracker_role, bool fingertracking_enabled):
+SlimeVRDriver::TrackerDevice::TrackerDevice(std::string serial, int device_id, TrackerRole tracker_role):
     serial_(serial),
     tracker_role_(tracker_role),
     device_id_(device_id),
     is_left_hand_(tracker_role_ == TrackerRole::LEFT_CONTROLLER || tracker_role_ == TrackerRole::LEFT_HAND),
     is_right_hand_(tracker_role_ == TrackerRole::RIGHT_CONTROLLER || tracker_role_ == TrackerRole::RIGHT_HAND),
-    fingertracking_enabled_real_(fingertracking_enabled && (is_left_hand_ || is_right_hand_)),
+    fingertracking_enabled_(is_left_hand_ || is_right_hand_),
     is_controller_(tracker_role_ == TrackerRole::LEFT_CONTROLLER || tracker_role_ == TrackerRole::RIGHT_CONTROLLER),
     last_pose_(MakeDefaultPose()),
     last_pose_atomic_(MakeDefaultPose())
@@ -75,12 +75,28 @@ void SlimeVRDriver::TrackerDevice::PositionMessage(messages::Position &position)
     }
 
     if (is_controller_) {
+        bool tap = false;
+        bool double_tap = false;
+        bool triple_tap = false;
+
+        // Get inputs from protobuf
+        for (int i = 0; i < position.input_size(); ++i) {
+            if (position.input(i).type() == messages::Input_InputType_TAP) {
+                tap = true;
+            } else if (position.input(i).type() == messages::Input_InputType_DOUBLE_TAP) {
+                double_tap = true;
+            } else if (position.input(i).type() == messages::Input_InputType_TRIPLE_TAP) {
+                triple_tap = true;
+            }
+        }
+
         // Set inputs
-        // TODO
-        //GetDriver()->GetInput()->UpdateBooleanComponent(this->tap_component_, false, 0);
+        GetDriver()->GetInput()->UpdateBooleanComponent(this->tap_component_, tap, 0);
+        GetDriver()->GetInput()->UpdateBooleanComponent(this->double_tap_component_, double_tap, 0);
+        GetDriver()->GetInput()->UpdateBooleanComponent(this->triple_tap_component_, triple_tap, 0);
     }
 
-    if (fingertracking_enabled_real_) {
+    if (fingertracking_enabled_) {
         // Set finger rotations
         vr::VRBoneTransform_t finger_skeleton_[31]{};
         for (int i = 0; i < position.finger_bone_rotations_size(); i++)
@@ -99,7 +115,7 @@ void SlimeVRDriver::TrackerDevice::PositionMessage(messages::Position &position)
             };
         }
 
-        // Update the finger skeleton for this hand. With and without controller are the same.
+        // Update the finger skeleton for this hand. With and without controller have the same pose.
         vr::VRDriverInput()->UpdateSkeletonComponent(skeletal_component_handle_, vr::VRSkeletalMotionRange_WithController, finger_skeleton_, 31);
         vr::VRDriverInput()->UpdateSkeletonComponent(skeletal_component_handle_, vr::VRSkeletalMotionRange_WithoutController, finger_skeleton_, 31);
     }
@@ -203,6 +219,7 @@ vr::EVRInitError SlimeVRDriver::TrackerDevice::Activate(uint32_t unObjectId) {
     // Should be treated as controller or as tracker? (Hand = Tracker and Controller = Controller)
     if (is_controller_) {
         vr::VRProperties()->SetInt32Property(props, vr::Prop_DeviceClass_Int32, vr::TrackedDeviceClass_Controller);
+        vr::VRProperties()->SetInt32Property(props, vr::Prop_ControllerHandSelectionPriority_Int32, 2147483647); // Prioritizes our controller over whatever else.
     } else {
         vr::VRProperties()->SetInt32Property(props, vr::Prop_DeviceClass_Int32, vr::TrackedDeviceClass_GenericTracker);
     }
@@ -247,7 +264,7 @@ vr::EVRInitError SlimeVRDriver::TrackerDevice::Activate(uint32_t unObjectId) {
     }
 
     // Setup skeletal input for fingertracking
-    if (fingertracking_enabled_real_) {
+    if (fingertracking_enabled_) {
         vr::VRDriverInput()->CreateSkeletonComponent(
             props,
             is_right_hand_ ? "/input/skeleton/right" : "/input/skeleton/left",

src/TrackerDevice.hpp

@@ -19,7 +19,7 @@
 namespace SlimeVRDriver {
     class TrackerDevice : public IVRDevice {
     public:
-        TrackerDevice(std::string serial, int device_id, TrackerRole tracker_role, bool fingertracking_enabled);
+        TrackerDevice(std::string serial, int device_id, TrackerRole tracker_role);
         ~TrackerDevice() = default;
 
         // Inherited via IVRDevice
@@ -49,7 +49,7 @@ namespace SlimeVRDriver {
 
         int device_id_;
         TrackerRole tracker_role_;
-        bool fingertracking_enabled_real_;
+        bool fingertracking_enabled_;
 
         vr::DriverPose_t last_pose_ = IVRDevice::MakeDefaultPose();
         std::atomic<vr::DriverPose_t> last_pose_atomic_ = IVRDevice::MakeDefaultPose();

src/VRDriver.cpp

@@ -195,7 +195,7 @@ void SlimeVRDriver::VRDriver::OnBridgeMessage(const messages::ProtobufMessage& m
     std::lock_guard<std::mutex> lock(devices_mutex_);
     if (message.has_tracker_added()) {
         messages::TrackerAdded ta = message.tracker_added();
-        AddDevice(std::make_shared<TrackerDevice>(ta.tracker_serial(), ta.tracker_id(), static_cast<TrackerRole>(ta.tracker_role()), ta.fingertracking_enabled()));
+        AddDevice(std::make_shared<TrackerDevice>(ta.tracker_serial(), ta.tracker_id(), static_cast<TrackerRole>(ta.tracker_role())));
     } else if (message.has_position()) {
         messages::Position pos = message.position();
         auto device = devices_by_id_.find(pos.tracker_id());

src/bridge/BridgeClient.cpp

@@ -40,6 +40,7 @@ void BridgeClient::CreateConnection() {
         logger_->Log("[%s] connected", path.c_str());
         connected_ = true;
         last_error_ = std::nullopt;
+        SendVersion();
     });
     connection_handle_->on<uvw::end_event>([this, path](const uvw::end_event&, uvw::pipe_handle&) {
         logger_->Log("[%s] disconnected", path.c_str());
@@ -79,3 +80,12 @@ void BridgeClient::CloseConnectionHandles() {
     if (reconnect_timeout_) reconnect_timeout_->close();
     connected_ = false;
 }
+
+void BridgeClient::SendVersion() {
+    messages::ProtobufMessage* message = google::protobuf::Arena::CreateMessage<messages::ProtobufMessage>(&arena_);
+    messages::Version* version = google::protobuf::Arena::CreateMessage<messages::Version>(&arena_);
+    message->set_allocated_version(version);
+    version->set_protocol_version(PROTOCOL_VERSION);
+    SendBridgeMessage(*message);
+    arena_.Reset();
+}

src/bridge/BridgeClient.hpp

@@ -28,6 +28,8 @@
 
 #include "BridgeTransport.hpp"
 
+#define PROTOCOL_VERSION 1
+
 /**
  * @brief Client implementation for communication with SlimeVR Server using pipes or unix sockets.
  * 
@@ -49,8 +51,11 @@ class BridgeClient: public BridgeTransport {
     void ResetConnection() override;
     void CloseConnectionHandles() override;
     void Reconnect();
+    void SendVersion();
 
     std::optional<std::string> last_error_;
     std::optional<std::string> last_path_;
     std::shared_ptr<uvw::timer_handle> reconnect_timeout_;
+
+    google::protobuf::Arena arena_;
 };

src/bridge/ProtobufMessages.proto

@@ -54,6 +54,10 @@ option optimize_for = LITE_RUNTIME;
 message PingPong {
 }
 
+message Version {
+  int32 protocol_version = 1;
+}
+
 message FingerBoneRotation {
     enum FingerBoneName {
         THUMB_METACARPAL = 0;
@@ -79,6 +83,15 @@ message FingerBoneRotation {
     float w = 5;
 }
 
+message Input {
+    enum InputType {
+        TAP = 0;
+        DOUBLE_TAP = 1;
+        TRIPLE_TAP = 2;
+    }
+    InputType type = 1;
+}
+
 message Position {
     int32 tracker_id = 1;
     optional float x = 2;
@@ -96,6 +109,8 @@ message Position {
     }
     optional DataSource data_source = 9;
     repeated FingerBoneRotation finger_bone_rotations = 10;
+    repeated Input input = 11;
+
 }
 
 message UserAction {
@@ -108,7 +123,6 @@ message TrackerAdded {
     string tracker_serial = 2;
     string tracker_name = 3;
     int32 tracker_role = 4;
-    optional bool fingertracking_enabled = 10;
 }
 
 message TrackerStatus {
@@ -144,5 +158,6 @@ message ProtobufMessage {
         TrackerAdded tracker_added = 3;
         TrackerStatus tracker_status = 4;
         Battery battery = 5;
+        Version version = 6;
     }
 }