selkies_gstreamer support for evdev joystick interposer

Author: danisla

addons/js-interposer/Makefile

@@ -7,10 +7,10 @@ deps:
 	@sudo apt-get install -y build-essential evtest strace joystick libsdl2-dev gcc-multilib libevdev-dev
 
 build:
-	gcc -shared -fPIC -o selkies_joystick_interposer.so joystick_interposer.c -ldl
+	gcc -shared -fPIC -o selkies_joystick_interposer.so joystick_interposer.c -ldl -Wall
 
 build32:
-	gcc -m32 -shared -fPIC -o selkies_joystick_interposer_i386.so joystick_interposer.c -ldl
+	gcc -m32 -shared -fPIC -o selkies_joystick_interposer_i386.so joystick_interposer.c -ldl -Wall
 
 install: build
 	mkdir -p $(PREFIX)/lib/$(gcc -print-multiarch | sed -e 's/i.*86/i386/')

addons/js-interposer/joystick_interposer.c

@@ -14,7 +14,7 @@ file, You can obtain one at https://mozilla.org/MPL/2.0/.
     The ioctl() SYSCALL is interposed to fake the behavior of a input event character device.
     These ioctl requests were mostly reverse engineered from the joystick.h source and using the jstest command to test.
 
-    Note that some applications list the /dev/input/* directory to discover JS devices, to solve for this, create empty files at the following paths:
+    Note that some applications list the /dev/input/ directory to discover JS devices, to solve for this, create empty files at the following paths:
         sudo mkdir -pm1777 /dev/input
         sudo touch /dev/input/{js0,js1,js2,js3,event1000,event1001,event1002,event1003}
         sudo chmod 777 /dev/input/js* /dev/input/event*
@@ -487,8 +487,8 @@ int intercept_ev_ioctl(js_interposer_t *interposer, int fd, unsigned long reques
     va_end(args);
 
     struct input_absinfo *absinfo;
+    struct input_id *id;
     int fake_version = 0x010100;
-    char name[256] = "JS Interposer";
     int len;
 
     /* The EVIOCGABS(key) is a request to get the calibration values for the ABS type axes.
@@ -583,7 +583,7 @@ int intercept_ev_ioctl(js_interposer_t *interposer, int fd, unsigned long reques
         return 0;
 
     case 0x02: /* Handle EVIOCGID: device ID request. */
-        struct input_id *id = (struct input_id *)arg;
+        id = (struct input_id *)arg;
         // Populate the fake input_id for a joystick device
         id->bustype = BUS_VIRTUAL; // Example bus type (Virtual)
         id->vendor = 0x045E;       // Fake vendor ID (e.g., Microsoft)

src/selkies_gstreamer/gamepad.py

@@ -116,42 +116,6 @@
 ABS_MIN = -32767
 ABS_MAX = 32767
 
-# Joystick event struct
-# https://www.kernel.org/doc/Documentation/input/joystick-api.txt
-# struct js_event {
-#    __u32 time;     /* event timestamp in milliseconds */
-#    __s16 value;    /* value */
-#    __u8 type;      /* event type */
-#    __u8 number;    /* axis/button number */
-# };
-
-def get_btn_event(btn_num, btn_val):
-    ts = int((time.time() * 1000) % 1000000000)
-
-    # see js_event struct definition above.
-    # https://docs.python.org/3/library/struct.html
-    struct_format = 'IhBB'
-    event = struct.pack(struct_format, ts, btn_val,
-                        JS_EVENT_BUTTON, btn_num)
-
-    logger.debug(struct.unpack(struct_format, event))
-
-    return event
-
-
-def get_axis_event(axis_num, axis_val):
-    ts = int((time.time() * 1000) % 1000000000)
-
-    # see js_event struct definition above.
-    # https://docs.python.org/3/library/struct.html
-    struct_format = 'IhBB'
-    event = struct.pack(struct_format, ts, axis_val,
-                        JS_EVENT_AXIS, axis_num)
-
-    logger.debug(struct.unpack(struct_format, event))
-
-    return event
-
 def detect_gamepad_config(name):
     # TODO switch mapping based on name.
     return STANDARD_XPAD_CONFIG
@@ -173,8 +137,8 @@ def normalize_axis_val(val):
 def normalize_trigger_val(val):
     return round(val * (ABS_MAX - ABS_MIN)) + ABS_MIN
 
-class SelkiesGamepad:
-    def __init__(self, socket_path, loop):
+class SelkiesGamepadBase:
+    def __init__(self, socket_path, loop, gamepad_mapper_class):
         self.socket_path = socket_path
         self.loop = loop
 
@@ -197,11 +161,17 @@ def __init__(self, socket_path, loop):
 
         # flag indicating that loop is running.
         self.running = False
+
+        # class used for mapping gamepad events
+        self.gamepad_mapper_class = gamepad_mapper_class
+
+    def get_gamepad_mapper(self, config, name, num_btns, num_axes):
+        raise Exception("get_gamepad_mapper must be overriden")
 
     def set_config(self, name, num_btns, num_axes):
         self.name = name
         self.config = detect_gamepad_config(name)
-        self.mapper = GamepadMapper(self.config, name, num_btns, num_axes)
+        self.mapper = self.gamepad_mapper_class(self.config, name, num_btns, num_axes)
 
     def __make_config(self):
         '''
@@ -238,7 +208,7 @@ async def __send_events(self):
                 await asyncio.sleep(0.001)
                 continue
             while self.running and not self.events.empty():
-                await self.send_event(self.events.get())
+                await self.__send_event(self.events.get())
 
     def send_btn(self, btn_num, btn_val):
         if not self.mapper:
@@ -256,7 +226,7 @@ def send_axis(self, axis_num, axis_val):
         if event is not None:
             self.events.put(event)
 
-    async def send_event(self, event):
+    async def __send_event(self, event):
         if len(self.clients) < 1:
             return
 
@@ -274,7 +244,7 @@ async def send_event(self, event):
         for fd in closed_clients:
             del self.clients[fd]
 
-    async def setup_client(self, client):
+    async def __setup_client(self, client):
         logger.info("Sending config to client with fd: %d" % client.fileno())
         try:
             config_data = self.__make_config()
@@ -321,7 +291,7 @@ async def run_server(self):
                 logger.info("Client connected with fd: %d" % fd)
 
                 # Send client the joystick configuration
-                await self.setup_client(client)
+                await self.__setup_client(client)
 
                 # Add client to dictionary to receive events.
                 self.clients[fd] = client
@@ -342,13 +312,48 @@ def stop_server(self):
         except:
             pass
 
-class GamepadMapper:
+class SelkiesGamepad:
+    def __init__(self, js_socket_path, ev_socket_path, loop):
+        self.js_socket_path = js_socket_path
+        self.ev_socket_path = ev_socket_path
+        self.loop = loop
+
+        self.js_gamepad = SelkiesJSGamepad(js_socket_path, loop)
+        self.ev_gamepad = SelkiesEVGamepad(ev_socket_path, loop)
+
+    def set_config(self, name, num_btns, num_axes):
+        self.js_gamepad.set_config(name, num_btns, num_axes)
+        self.ev_gamepad.set_config(name, num_btns, num_axes)
+
+    def send_btn(self, btn_num, btn_val):
+        self.js_gamepad.send_btn(btn_num, btn_val)
+        self.ev_gamepad.send_btn(btn_num, btn_val)
+
+    def send_axis(self, axis_num, axis_val):
+        self.js_gamepad.send_axis(axis_num, axis_val)
+        self.ev_gamepad.send_axis(axis_num, axis_val)
+
+    def run_server(self):
+        asyncio.ensure_future(self.js_gamepad.run_server(), loop=self.loop)
+        asyncio.ensure_future(self.ev_gamepad.run_server(), loop=self.loop)
+
+    def stop_server(self):
+        self.js_gamepad.run_server()
+        self.ev_gamepad.run_server()
+
+class GamepadMapperBase:
     def __init__(self, config, name, num_btns, num_axes):
         self.config = config
         self.input_name = name
         self.input_num_btns = num_btns
         self.input_num_axes = num_axes
-    
+
+    def get_btn_event(self, btn_num, btn_val):
+        raise Exception("get_btn_event not implemented")
+
+    def get_axis_event(self, axis_num, axis_val):
+        raise Exception("get_axis_event not implemented")
+
     def get_mapped_btn(self, btn_num, btn_val):
         '''
         return either a button or axis event based on mapping. 
@@ -373,7 +378,7 @@ def get_mapped_btn(self, btn_num, btn_val):
                 # Normalize to full range for input between 0 and 1.
                 axis_val = normalize_trigger_val(btn_val)
 
-            return get_axis_event(axis_num, axis_val)
+            return self.get_axis_event(axis_num, axis_val)
 
         # Perform button mapping.
         mapped_btn = self.config["mapping"]["btns"].get(btn_num, btn_num)
@@ -382,7 +387,7 @@ def get_mapped_btn(self, btn_num, btn_val):
                 mapped_btn, len(self.config["btn_map"]) - 1))
             return None
 
-        return get_btn_event(mapped_btn, int(btn_val))
+        return self.get_btn_event(mapped_btn, int(btn_val))
 
     def get_mapped_axis(self, axis_num, axis_val):
         mapped_axis = self.config["mapping"]["axes"].get(axis_num, axis_num)
@@ -392,4 +397,97 @@ def get_mapped_axis(self, axis_num, axis_val):
             return None
 
         # Normalize axis value to be within range.
-        return get_axis_event(mapped_axis, normalize_axis_val(axis_val))
+        return self.get_axis_event(mapped_axis, normalize_axis_val(axis_val))
+
+
+class JSGamepadMapper(GamepadMapperBase):
+    def __init__(self, config, name, num_btns, num_axes):
+        super().__init__(config, name, num_btns, num_axes)
+
+        # https://www.kernel.org/doc/Documentation/input/joystick-api.txt
+        # struct js_event {
+        #    __u32 time;     /* event timestamp in milliseconds */
+        #    __s16 value;    /* value */
+        #    __u8 type;      /* event type */
+        #    __u8 number;    /* axis/button number */
+        # };
+        self.struct_format = 'IhBB'
+
+    def get_btn_event(self, btn_num, btn_val):
+        ts = int((time.time() * 1000) % 1000000000)
+
+        event = struct.pack(self.struct_format, ts, btn_val,
+                            JS_EVENT_BUTTON, btn_num)
+
+        logger.debug(struct.unpack(self.struct_format, event))
+
+        return event
+
+    def get_axis_event(self, axis_num, axis_val):
+        ts = int((time.time() * 1000) % 1000000000)
+
+        event = struct.pack(self.struct_format, ts, axis_val,
+                            JS_EVENT_AXIS, axis_num)
+
+        logger.debug(struct.unpack(self.struct_format, event))
+
+        return event
+
+class EVGamepadMapper(GamepadMapperBase):
+    def __init__(self, config, name, num_btns, num_axes):
+        super().__init__(config, name, num_btns, num_axes)
+
+        # https://www.kernel.org/doc/Documentation/input/joystick-api.txt
+        # struct input_event {
+        # 	struct timeval time;
+        # 	unsigned short type;
+        # 	unsigned short code;
+        # 	unsigned int value;
+        # };
+
+        # Double the input_event to include sycn, EV_SYN event.
+        self.struct_format = 'llHHillHHi'
+
+    def get_btn_event(self, btn_num, btn_val):
+        now = time.time()
+        ts_sec = int(now)
+        ts_usec = int((now *1e6) % 1e6)
+
+        # evdev expects ev key codes, not button numbers
+        ev_btn = self.config["btn_map"][btn_num]
+
+        # timestamp_sec, timestamp_usec, type, code, value
+        event = struct.pack(self.struct_format,
+            ts_sec, ts_usec, EV_KEY, ev_btn, btn_val,
+            ts_sec, ts_usec, EV_SYN, SYN_REPORT, 0
+        )
+
+        logger.debug(struct.unpack(self.struct_format, event))
+
+        return event
+
+    def get_axis_event(self, axis_num, axis_val):
+        now = time.time()
+        ts_sec = int(now)
+        ts_usec = int((now *1e6) % 1e6)
+
+        # evdev expects ev key codes, not axis numbers
+        ev_axis = self.config["axes_map"][axis_num]
+
+        # timestamp_sec, timestamp_usec, type, code, value
+        event = struct.pack(self.struct_format,
+            ts_sec, ts_usec, EV_ABS, ev_axis, axis_val,
+            ts_sec, ts_usec, EV_SYN, SYN_REPORT, 0
+        )
+
+        logger.debug(struct.unpack(self.struct_format, event))
+
+        return event
+
+class SelkiesJSGamepad(SelkiesGamepadBase):
+    def __init__(self, socket_path, loop):
+        super().__init__(socket_path, loop, JSGamepadMapper)
+
+class SelkiesEVGamepad(SelkiesGamepadBase):
+    def __init__(self, socket_path, loop):
+        super().__init__(socket_path, loop, EVGamepadMapper)

src/selkies_gstreamer/webrtc_input.py

@@ -92,6 +92,7 @@ def __init__(self, uinput_mouse_socket_path="", js_socket_path="", enable_clipbo
 
         # Map of gamepad numbers to socket paths
         self.js_socket_path_map = {i: os.path.join(js_socket_path, "selkies_js%d.sock" % i) for i in range(4)}
+        self.ev_socket_path_map = {i: os.path.join(js_socket_path, "selkies_event%d.sock" % (1000 + i)) for i in range(4)}
 
         # Map of gamepad number to SelkiesGamepad objects
         self.js_map = {}
@@ -172,16 +173,20 @@ def __js_connect(self, js_num, name, num_btns, num_axes):
 
         logger.info("creating selkies gamepad for js%d, name: '%s', buttons: %d, axes: %d" % (js_num, name, num_btns, num_axes))
 
-        socket_path = self.js_socket_path_map.get(js_num, None)
-        if socket_path is None:
+        js_socket_path = self.js_socket_path_map.get(js_num, None)
+        if js_socket_path is None:
             logger.error("failed to connect js%d because socket_path was not found" % js_num)
             return
 
+        ev_socket_path = self.ev_socket_path_map.get(js_num, None)
+        if ev_socket_path is None:
+            logger.error("failed to connect EV joystick %d because socket_path was not found" % js_num)
+            return
+
         # Create the gamepad and button config.
-        js = SelkiesGamepad(socket_path, self.loop)
+        js = SelkiesGamepad(js_socket_path, ev_socket_path, self.loop)
         js.set_config(name, num_btns, num_axes)
-
-        asyncio.ensure_future(js.run_server(), loop=self.loop)
+        js.run_server()
 
         self.js_map[js_num] = js