simplify

When the implementation handles all possible input values, it may never
fail.

app/meson.build

@@ -77,7 +77,6 @@ if aoa_hid_support
     src += [
         'src/aoa_hid.c',
         'src/hid_keyboard.c',
-        'src/hid_mouse.c',
     ]
 endif
 

app/src/common.h

@@ -7,7 +7,6 @@
 #define ARRAY_LEN(a) (sizeof(a) / sizeof(a[0]))
 #define MIN(X,Y) (X) < (Y) ? (X) : (Y)
 #define MAX(X,Y) (X) > (Y) ? (X) : (Y)
-#define CLAMP(V,X,Y) MIN( MAX((V),(X)), (Y) )
 
 #define container_of(ptr, type, member) \
     ((type *) (((char *) (ptr)) - offsetof(type, member)))

app/src/hid_keyboard.c

@@ -387,6 +387,15 @@ sc_key_processor_process_key(struct sc_key_processor *kp,
     }
 }
 
+static void
+sc_key_processor_process_text(struct sc_key_processor *kp,
+                              const struct sc_text_event *event) {
+    (void) kp;
+    (void) event;
+
+    // Never forward text input via HID (all the keys are injected separately)
+}
+
 bool
 sc_hid_keyboard_init(struct sc_hid_keyboard *kb, struct sc_aoa *aoa) {
     kb->aoa = aoa;
@@ -406,9 +415,7 @@ sc_hid_keyboard_init(struct sc_hid_keyboard *kb, struct sc_aoa *aoa) {
 
     static const struct sc_key_processor_ops ops = {
         .process_key = sc_key_processor_process_key,
-        // Never forward text input via HID (all the keys are injected
+        .process_text = sc_key_processor_process_text,
-        // separately)
-        .process_text = NULL,
     };
 
     // Clipboard synchronization is requested over the control socket, while HID

app/src/hid_mouse.c

@@ -1,258 +0,0 @@
-#include "hid_mouse.h"
-
-#include <assert.h>
-
-#include "input_events.h"
-#include "util/log.h"
-
-/** Downcast mouse processor to hid_mouse */
-#define DOWNCAST(MP) container_of(MP, struct sc_hid_mouse, mouse_processor)
-
-#define HID_MOUSE_ACCESSORY_ID 2
-
-// 1 byte for buttons + padding, 1 byte for X position, 1 byte for Y position
-#define HID_MOUSE_EVENT_SIZE 4
-
-/**
- * Mouse descriptor from the specification:
- * <https://www.usb.org/sites/default/files/hid1_11.pdf>
- *
- * Appendix E (p71): §E.10 Report Descriptor (Mouse)
- *
- * The usage tags (like Wheel) are listed in "HID Usage Tables":
- * <https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf>
- * §4 Generic Desktop Page (0x01) (p26)
- */
-static const unsigned char mouse_report_desc[]  = {
-    // Usage Page (Generic Desktop)
-    0x05, 0x01,
-    // Usage (Mouse)
-    0x09, 0x02,
-
-    // Collection (Application)
-    0xA1, 0x01,
-
-    // Usage (Pointer)
-    0x09, 0x01,
-
-    // Collection (Physical)
-    0xA1, 0x00,
-
-    // Usage Page (Buttons)
-    0x05, 0x09,
-
-    // Usage Minimum (1)
-    0x19, 0x01,
-     // Usage Maximum (3)
-    0x29, 0x03,
-    // Logical Minimum (0)
-    0x15, 0x00,
-    // Logical Maximum (1)
-    0x25, 0x01,
-    // Report Count (3)
-    0x95, 0x03,
-    // Report Size (1)
-    0x75, 0x01,
-    // Input (Data, Variable, Absolute): 3 buttons bits
-    0x81, 0x02,
-
-    // Report Count (1)
-    0x95, 0x01,
-    // Report Size (5)
-    0x75, 0x05,
-    // Input (Constant): 5 bits padding
-    0x81, 0x01,
-
-    // Usage Page (Generic Desktop)
-    0x05, 0x01,
-    // Usage (X)
-    0x09, 0x30,
-    // Usage (Y)
-    0x09, 0x31,
-    // Usage (Wheel)
-    0x09, 0x38,
-    // Local Minimum (-127)
-    0x15, 0x81,
-    // Local Maximum (127)
-    0x25, 0x7F,
-    // Report Size (8)
-    0x75, 0x08,
-    // Report Count (3)
-    0x95, 0x03,
-    // Input (Data, Variable, Relative): 3 position bytes (X, Y, Wheel)
-    0x81, 0x06,
-
-    // End Collection
-    0xC0,
-
-    // End Collection
-    0xC0,
-};
-
-/**
- * A mouse HID event is 3 bytes long:
- *
- *  - byte 0: buttons state
- *  - byte 1: relative x motion (signed byte from -127 to 127)
- *  - byte 2: relative y motion (signed byte from -127 to 127)
- *
- *                   7 6 5 4 3 2 1 0
- *                  +---------------+
- *         byte 0:  |0 0 0 0 0 . . .| buttons state
- *                  +---------------+
- *                             ^ ^ ^
- *                             | | `- left button
- *                             | `--- right button
- *                             `----- middle button
- *
- *                  +---------------+
- *         byte 1:  |. . . . . . . .| relative x motion
- *                  +---------------+
- *         byte 2:  |. . . . . . . .| relative y motion
- *                  +---------------+
- *         byte 3:  |. . . . . . . .| wheel motion (-1, 0 or 1)
- *                  +---------------+
- *
- * As an example, here is the report for a motion of (x=5, y=-4) with left
- * button pressed:
- *
- *                  +---------------+
- *                  |0 0 0 0 0 0 0 1| left button pressed
- *                  +---------------+
- *                  |0 0 0 0 0 1 0 1| horizontal motion (x = 5)
- *                  +---------------+
- *                  |1 1 1 1 1 1 0 0| relative y motion (y = -4)
- *                  +---------------+
- *                  |0 0 0 0 0 0 0 0| wheel motion
- *                  +---------------+
- */
-
-static bool
-sc_hid_mouse_event_init(struct sc_hid_event *hid_event) {
-    unsigned char *buffer = calloc(1, HID_MOUSE_EVENT_SIZE);
-    if (!buffer) {
-        LOG_OOM();
-        return false;
-    }
-
-    sc_hid_event_init(hid_event, HID_MOUSE_ACCESSORY_ID, buffer,
-                      HID_MOUSE_EVENT_SIZE);
-    return true;
-}
-
-static unsigned char
-buttons_state_to_hid_buttons(uint8_t buttons_state) {
-    unsigned char c = 0;
-    if (buttons_state & SC_MOUSE_BUTTON_LEFT) {
-        c |= 1 << 0;
-    }
-    if (buttons_state & SC_MOUSE_BUTTON_RIGHT) {
-        c |= 1 << 1;
-    }
-    if (buttons_state & SC_MOUSE_BUTTON_MIDDLE) {
-        c |= 1 << 2;
-    }
-    // TODO buttons 4 and 5?
-    return c;
-}
-
-static void
-sc_mouse_processor_process_mouse_motion(struct sc_mouse_processor *mp,
-                                    const struct sc_mouse_motion_event *event) {
-    struct sc_hid_mouse *mouse = DOWNCAST(mp);
-
-    struct sc_hid_event hid_event;
-    if (!sc_hid_mouse_event_init(&hid_event)) {
-        return;
-    }
-
-    unsigned char *buffer = hid_event.buffer;
-    buffer[0] = buttons_state_to_hid_buttons(event->buttons_state);
-    buffer[1] = CLAMP(event->xrel, -127, 127);
-    buffer[2] = CLAMP(event->yrel, -127, 127);
-    buffer[3] = 0; // wheel coordinates only used for scrolling
-
-    if (!sc_aoa_push_hid_event(mouse->aoa, &hid_event)) {
-        sc_hid_event_destroy(&hid_event);
-        LOGW("Could request HID event");
-    }
-}
-
-static void
-sc_mouse_processor_process_mouse_click(struct sc_mouse_processor *mp,
-                                   const struct sc_mouse_click_event *event) {
-    struct sc_hid_mouse *mouse = DOWNCAST(mp);
-
-    struct sc_hid_event hid_event;
-    if (!sc_hid_mouse_event_init(&hid_event)) {
-        return;
-    }
-
-    unsigned char *buffer = hid_event.buffer;
-    buffer[0] = buttons_state_to_hid_buttons(event->buttons_state);
-    buffer[1] = 0; // no x motion
-    buffer[2] = 0; // no y motion
-    buffer[3] = 0; // wheel coordinates only used for scrolling
-
-    if (!sc_aoa_push_hid_event(mouse->aoa, &hid_event)) {
-        sc_hid_event_destroy(&hid_event);
-        LOGW("Could request HID event");
-    }
-}
-
-static void
-sc_mouse_processor_process_mouse_scroll(struct sc_mouse_processor *mp,
-                                    const struct sc_mouse_scroll_event *event) {
-    struct sc_hid_mouse *mouse = DOWNCAST(mp);
-
-    struct sc_hid_event hid_event;
-    if (!sc_hid_mouse_event_init(&hid_event)) {
-        return;
-    }
-
-    unsigned char *buffer = hid_event.buffer;
-    buffer[0] = 0; // buttons state irrelevant (and unknown)
-    buffer[1] = 0; // no x motion
-    buffer[2] = 0; // no y motion
-    // In practice, vscroll is always -1, 0 or 1, but in theory other values
-    // are possible
-    buffer[3] = CLAMP(event->vscroll, -127, 127);
-    // Horizontal scrolling ignored
-
-    if (!sc_aoa_push_hid_event(mouse->aoa, &hid_event)) {
-        sc_hid_event_destroy(&hid_event);
-        LOGW("Could request HID event");
-    }
-}
-
-bool
-sc_hid_mouse_init(struct sc_hid_mouse *mouse, struct sc_aoa *aoa) {
-    mouse->aoa = aoa;
-
-    bool ok = sc_aoa_setup_hid(aoa, HID_MOUSE_ACCESSORY_ID, mouse_report_desc,
-                               ARRAY_LEN(mouse_report_desc));
-    if (!ok) {
-        LOGW("Register HID mouse failed");
-        return false;
-    }
-
-    static const struct sc_mouse_processor_ops ops = {
-        .process_mouse_motion = sc_mouse_processor_process_mouse_motion,
-        .process_mouse_click = sc_mouse_processor_process_mouse_click,
-        .process_mouse_scroll = sc_mouse_processor_process_mouse_scroll,
-        // Touch events not supported (coordinates are not relative)
-        .process_touch = NULL,
-    };
-
-    mouse->mouse_processor.ops = &ops;
-
-    return true;
-}
-
-void
-sc_hid_mouse_destroy(struct sc_hid_mouse *mouse) {
-    bool ok = sc_aoa_unregister_hid(mouse->aoa, HID_MOUSE_ACCESSORY_ID);
-    if (!ok) {
-        LOGW("Could not unregister HID");
-    }
-}

app/src/hid_mouse.h

@@ -1,23 +0,0 @@
-#ifndef HID_MOUSE_H
-#define HID_MOUSE_H
-
-#include "common.h"
-
-#include <stdbool.h>
-
-#include "aoa_hid.h"
-#include "trait/mouse_processor.h"
-
-struct sc_hid_mouse {
-    struct sc_mouse_processor mouse_processor; // mouse processor trait
-
-    struct sc_aoa *aoa;
-};
-
-bool
-sc_hid_mouse_init(struct sc_hid_mouse *mouse, struct sc_aoa *aoa);
-
-void
-sc_hid_mouse_destroy(struct sc_hid_mouse *mouse);
-
-#endif

app/src/input_events.h

@@ -365,8 +365,6 @@ struct sc_mouse_scroll_event {
 
 struct sc_mouse_motion_event {
     struct sc_position position;
-    int32_t xrel;
-    int32_t yrel;
     uint8_t buttons_state; // bitwise-OR of sc_mouse_button values
 };
 

app/src/input_manager.c

@@ -63,19 +63,9 @@ sc_mouse_button_from_sdl(uint8_t button) {
 }
 
 static inline uint8_t
-sc_mouse_buttons_state_from_sdl(uint32_t buttons_state,
+sc_mouse_buttons_state_from_sdl(uint32_t buttons_state) {
-                                bool forward_all_clicks) {
     assert(buttons_state < 0x100); // fits in uint8_t
-
+    return buttons_state;
-    uint8_t mask = SC_MOUSE_BUTTON_LEFT;
-    if (forward_all_clicks) {
-        mask |= SC_MOUSE_BUTTON_RIGHT
-              | SC_MOUSE_BUTTON_MIDDLE
-              | SC_MOUSE_BUTTON_X1
-              | SC_MOUSE_BUTTON_X2;
-    }
-
-    return buttons_state & mask;
 }
 
 #define SC_SDL_SHORTCUT_MODS_MASK (KMOD_CTRL | KMOD_ALT | KMOD_GUI)
@@ -386,11 +376,6 @@ rotate_client_right(struct screen *screen) {
 static void
 input_manager_process_text_input(struct input_manager *im,
                                  const SDL_TextInputEvent *event) {
-    if (!im->kp->ops->process_text) {
-        // The key processor does not support text input
-        return;
-    }
-
     if (is_shortcut_mod(im, SDL_GetModState())) {
         // A shortcut must never generate text events
         return;
@@ -627,22 +612,20 @@ input_manager_process_key(struct input_manager *im,
         .mods_state = sc_mods_state_from_sdl(event->keysym.mod),
     };
 
-    assert(im->kp->ops->process_key);
     im->kp->ops->process_key(im->kp, &evt, ack_to_wait);
 }
 
 static void
 input_manager_process_mouse_motion(struct input_manager *im,
                                    const SDL_MouseMotionEvent *event) {
-
     uint32_t mask = SDL_BUTTON_LMASK;
     if (im->forward_all_clicks) {
         mask |= SDL_BUTTON_MMASK | SDL_BUTTON_RMASK;
     }
-    //if (!(event->state & mask)) {
+    if (!(event->state & mask)) {
-    //    // do not send motion events when no click is pressed
+        // do not send motion events when no click is pressed
-    //    return;
+        return;
-    //}
+    }
     if (event->which == SDL_TOUCH_MOUSEID) {
         // simulated from touch events, so it's a duplicate
         return;
@@ -654,14 +637,9 @@ input_manager_process_mouse_motion(struct input_manager *im,
             .point = screen_convert_window_to_frame_coords(im->screen,
                                                            event->x, event->y),
         },
-        .xrel = event->xrel,
+        .buttons_state = sc_mouse_buttons_state_from_sdl(event->state),
-        .yrel = event->yrel,
-        .buttons_state =
-            sc_mouse_buttons_state_from_sdl(event->state,
-                                            im->forward_all_clicks),
     };
 
-    assert(im->mp->ops->process_mouse_motion);
     im->mp->ops->process_mouse_motion(im->mp, &evt);
 
     if (im->vfinger_down) {
@@ -676,11 +654,6 @@ input_manager_process_mouse_motion(struct input_manager *im,
 static void
 input_manager_process_touch(struct input_manager *im,
                             const SDL_TouchFingerEvent *event) {
-    if (!im->mp->ops->process_touch) {
-        // The mouse processor does not support touch events
-        return;
-    }
-
     int dw;
     int dh;
     SDL_GL_GetDrawableSize(im->screen->window, &dw, &dh);
@@ -769,12 +742,9 @@ input_manager_process_mouse_button(struct input_manager *im,
         },
         .action = sc_action_from_sdl_mousebutton_type(event->type),
         .button = sc_mouse_button_from_sdl(event->button),
-        .buttons_state =
+        .buttons_state = sc_mouse_buttons_state_from_sdl(sdl_buttons_state),
-            sc_mouse_buttons_state_from_sdl(sdl_buttons_state,
-                                            im->forward_all_clicks),
     };
 
-    assert(im->mp->ops->process_mouse_click);
     im->mp->ops->process_mouse_click(im->mp, &evt);
 
     // Pinch-to-zoom simulation.
@@ -806,11 +776,6 @@ input_manager_process_mouse_button(struct input_manager *im,
 static void
 input_manager_process_mouse_wheel(struct input_manager *im,
                                   const SDL_MouseWheelEvent *event) {
-    if (!im->mp->ops->process_mouse_scroll) {
-        // The mouse processor does not support scroll events
-        return;
-    }
-
     // mouse_x and mouse_y are expressed in pixels relative to the window
     int mouse_x;
     int mouse_y;

app/src/mouse_inject.c

@@ -76,6 +76,27 @@ sc_mouse_processor_process_mouse_motion(struct sc_mouse_processor *mp,
     }
 }
 
+static void
+sc_mouse_processor_process_touch(struct sc_mouse_processor *mp,
+                                 const struct sc_touch_event *event) {
+    struct sc_mouse_inject *mi = DOWNCAST(mp);
+
+    struct control_msg msg = {
+        .type = CONTROL_MSG_TYPE_INJECT_TOUCH_EVENT,
+        .inject_touch_event = {
+            .action = convert_touch_action(event->action),
+            .pointer_id = event->pointer_id,
+            .position = event->position,
+            .pressure = event->pressure,
+            .buttons = 0,
+        },
+    };
+
+    if (!controller_push_msg(mi->controller, &msg)) {
+        LOGW("Could not request 'inject touch event'");
+    }
+}
+
 static void
 sc_mouse_processor_process_mouse_click(struct sc_mouse_processor *mp,
                                     const struct sc_mouse_click_event *event) {
@@ -116,27 +137,6 @@ sc_mouse_processor_process_mouse_scroll(struct sc_mouse_processor *mp,
     }
 }
 
-static void
-sc_mouse_processor_process_touch(struct sc_mouse_processor *mp,
-                                 const struct sc_touch_event *event) {
-    struct sc_mouse_inject *mi = DOWNCAST(mp);
-
-    struct control_msg msg = {
-        .type = CONTROL_MSG_TYPE_INJECT_TOUCH_EVENT,
-        .inject_touch_event = {
-            .action = convert_touch_action(event->action),
-            .pointer_id = event->pointer_id,
-            .position = event->position,
-            .pressure = event->pressure,
-            .buttons = 0,
-        },
-    };
-
-    if (!controller_push_msg(mi->controller, &msg)) {
-        LOGW("Could not request 'inject touch event'");
-    }
-}
-
 void
 sc_mouse_inject_init(struct sc_mouse_inject *mi,
                      struct controller *controller) {
@@ -144,9 +144,9 @@ sc_mouse_inject_init(struct sc_mouse_inject *mi,
 
     static const struct sc_mouse_processor_ops ops = {
         .process_mouse_motion = sc_mouse_processor_process_mouse_motion,
+        .process_touch = sc_mouse_processor_process_touch,
         .process_mouse_click = sc_mouse_processor_process_mouse_click,
         .process_mouse_scroll = sc_mouse_processor_process_mouse_scroll,
-        .process_touch = sc_mouse_processor_process_touch,
     };
 
     mi->mouse_processor.ops = &ops;

app/src/scrcpy.c

@@ -20,7 +20,6 @@
 #include "input_manager.h"
 #ifdef HAVE_AOA_HID
 # include "hid_keyboard.h"
-# include "hid_mouse.h"
 #endif
 #include "keyboard_inject.h"
 #include "mouse_inject.h"
@@ -57,12 +56,7 @@ struct scrcpy {
         struct sc_hid_keyboard keyboard_hid;
 #endif
     };
-    union {
+    struct sc_mouse_inject mouse_inject;
-        struct sc_mouse_inject mouse_inject;
-#ifdef HAVE_AOA_HID
-        struct sc_hid_mouse mouse_hid;
-#endif
-    };
     struct input_manager input_manager;
 };
 
@@ -587,9 +581,8 @@ aoa_hid_end:
             kp = &s->keyboard_inject.key_processor;
         }
 
-        //sc_mouse_inject_init(&s->mouse_inject, &s->controller);
+        sc_mouse_inject_init(&s->mouse_inject, &s->controller);
-        sc_hid_mouse_init(&s->mouse_hid, &s->aoa);
+        mp = &s->mouse_inject.mouse_processor;
-        mp = &s->mouse_hid.mouse_processor;
     }
 
     input_manager_init(&s->input_manager, &s->controller, &s->screen, kp, mp,

app/src/screen.c

@@ -485,10 +485,6 @@ screen_init(struct screen *screen, const struct screen_params *params) {
     SDL_AddEventWatch(event_watcher, screen);
 #endif
 
-    if (SDL_SetRelativeMouseMode(true)) {
-        LOGE("Could not set relative mouse mode: %s", SDL_GetError());
-    }
-
     static const struct sc_frame_sink_ops ops = {
         .open = screen_frame_sink_open,
         .close = screen_frame_sink_close,

app/src/trait/key_processor.h

@@ -29,24 +29,17 @@ struct sc_key_processor {
 struct sc_key_processor_ops {
 
     /**
-     * Process a keyboard event
+     * Process the keyboard event
      *
      * The `sequence` number (if different from `SC_SEQUENCE_INVALID`) indicates
      * the acknowledgement number to wait for before injecting this event.
      * This allows to ensure that the device clipboard is set before injecting
      * Ctrl+v on the device.
-     *
-     * This function is mandatory.
      */
     void
     (*process_key)(struct sc_key_processor *kp,
                    const struct sc_key_event *event, uint64_t ack_to_wait);
 
-    /**
-     * Process an input text
-     *
-     * This function is optional.
-     */
     void
     (*process_text)(struct sc_key_processor *kp,
                     const struct sc_text_event *event);

app/src/trait/mouse_processor.h

@@ -19,41 +19,21 @@ struct sc_mouse_processor {
 };
 
 struct sc_mouse_processor_ops {
-    /**
-     * Process a mouse motion event
-     *
-     * This function is mandatory.
-     */
     void
     (*process_mouse_motion)(struct sc_mouse_processor *mp,
                             const struct sc_mouse_motion_event *event);
 
-    /**
+    void
-     * Process a mouse click event
+    (*process_touch)(struct sc_mouse_processor *mp,
-     *
+                     const struct sc_touch_event *event);
-     * This function is mandatory.
+
-     */
     void
     (*process_mouse_click)(struct sc_mouse_processor *mp,
                            const struct sc_mouse_click_event *event);
 
-    /**
-     * Process a mouse scroll event
-     *
-     * This function is optional.
-     */
     void
     (*process_mouse_scroll)(struct sc_mouse_processor *mp,
                             const struct sc_mouse_scroll_event *event);
-
-    /**
-     * Process a touch event
-     *
-     * This function is optional.
-     */
-    void
-    (*process_touch)(struct sc_mouse_processor *mp,
-                     const struct sc_touch_event *event);
 };
 
 #endif