monado/src/xrt/auxiliary/bindings/steamvr_profiles.py
Mario Kleiner 887b770f9e aux/binding: Implement optional "steamvr_controllertypes" for SteamVR input bindings
Add an optional switch -s or --steamvr to steamvr_profiles.py, which enables
a different naming scheme for the "controller_type" field in the generated
SteamVR profile json files.

If the switch is provided and an interaction profile in bindings.json
provides the optional new property "steamvr_controllertype", that property
will be used for the "controller_type" field of the written out .json,
instead of the regular auto-generated name.

This allows to generate json files which use controller_type names normally
used by SteamVR, so Monado provided controllers are mapped to the same
OpenXR interaction profiles that SteamVR would normally map them to.
E.g., the standard controller_type for Oculus touch controllers used by
SteamVR is "oculus_touch" instead of Monado's "monado_oculus_touch_controller".

That in turn allows OpenXR clients to use the SteamVR/OpenXR runtime to
access controllers provided by Monado's SteamVR driver plugin. Without such
compatible json files, only standard OpenVR clients can use controllers
exposed by Monado's SteamVR driver by default, but not OpenXR clients.

Tested with an Oculus Rift CV-1, and shown to now enable OpenXR clients
to make full use of the Oculus touch controllers.

The mappings for controllers other than Oculus Touch are derived from
SteamVR log output, but not actually tested due to lack of suitable hw.

Per discussion for the merge request, we enable this '-s' flag by
default in the make file for SteamVR style naming scheme.

Signed-off-by: Mario Kleiner <mario.kleiner.de@gmail.com>
2023-01-23 16:30:27 +00:00

124 lines
3.4 KiB
Python

#!/usr/bin/env python3
# Copyright 2020, Collabora, Ltd.
# SPDX-License-Identifier: BSL-1.0
"""Generate SteamVR input profiles from a JSON file describing interaction
profiles and bindings."""
from bindings import *
import argparse
import os
import errno
import json
def names(p):
hw_name = str(p.name.split("/")[-1])
vendor_name = str(p.name.split("/")[-2])
fname = vendor_name + "_" + hw_name + "_profile.json"
return hw_name, vendor_name, fname
def open_file(args, fname):
out_dir = str(args.output)
try:
os.makedirs(out_dir)
except OSError as e:
if e.errno != errno.EEXIST:
raise
fname = out_dir + "/" + fname
f = open(fname, "w")
return f
def get_required_components(path_type):
if path_type == "button":
return ["click", "touch"]
if path_type == "trigger":
return ["click", "touch", "value", "force"]
if path_type == "joystick":
return ["click", "touch"]
if path_type == "pose":
return []
if path_type == "vibration":
return []
return []
def main():
"""Handle command line and generate a file."""
parser = argparse.ArgumentParser(description='Bindings generator.')
parser.add_argument(
'bindings', help='Bindings file to use')
parser.add_argument(
'output', type=str, help='Output directory')
parser.add_argument(
'-s', '--steamvr', action='store_true',
help='Use SteamVR standard controller type names')
args = parser.parse_args()
bindings = Bindings.load_and_parse(args.bindings)
for p in bindings.profiles:
device_class = ""
if p.profile_type == "tracked_controller":
device_class = "TrackedDeviceClass_Controller"
else:
# TODO: profile for non-controller hw
continue
profile_type, vendor_name, fname = names(p)
controller_type = "monado_" + vendor_name + "_" + profile_type
if args.steamvr == True and p.steamvr_controller_type is not None:
controller_type = p.steamvr_controller_type
input_source = {}
component: Component
for idx, component in enumerate(p.components):
subpath_name = component.steamvr_path
input_source[subpath_name] = {
"type": component.subpath_type,
"binding_image_point": [0, 0], # TODO
"order": idx
}
for req in get_required_components(component.subpath_type):
input_source[subpath_name][req] = req in component.components_for_subpath
j = {
"json_id": "input_profile",
"controller_type": controller_type,
"device_class": device_class,
"resource_root": "steamvr-monado",
"driver_name": "monado",
# "legacy_binding": None, # TODO
"input_bindingui_mode": "controller_handed",
"should_show_binding_errors": True,
"input_bindingui_left": {
"image": "{indexcontroller}/icons/indexcontroller_left.svg" # TODO
},
"input_bindingui_right": {
"image": "{indexcontroller}/icons/indexcontroller_right.svg" # TODO
},
"input_source": input_source
}
f = open_file(args, fname)
# print("Creating SteamVR input profile", f.name)
json.dump(j, f, indent=2)
f.close()
if __name__ == "__main__":
main()