Handle mouse integer scrolling locally

Do not rely on SDL to expose integer scroll values, as they are not
available in all versions.

It was reimplemented in SDL 3.2.12 by this commit:
<0447c2f3c3>

Refs #6156 <https://github.com/Genymobile/scrcpy/issues/6156>

README.md

@@ -2,7 +2,7 @@
 source for the project. Do not download releases from random websites, even if
 their name contains `scrcpy`.**
 
-# scrcpy (v3.3)
+# scrcpy (v3.3.1)
 
 <img src="app/data/icon.svg" width="128" height="128" alt="scrcpy" align="right" />
 

app/scrcpy-windows.rc

@@ -13,7 +13,7 @@ BEGIN
       VALUE "LegalCopyright", "Romain Vimont, Genymobile"
       VALUE "OriginalFilename", "scrcpy.exe"
       VALUE "ProductName", "scrcpy"
-      VALUE "ProductVersion", "3.3"
+      VALUE "ProductVersion", "3.3.1"
     END
   END
   BLOCK "VarFileInfo"

app/src/control_msg.c

@@ -127,10 +127,14 @@ sc_control_msg_serialize(const struct sc_control_msg *msg, uint8_t *buf) {
             return 32;
         case SC_CONTROL_MSG_TYPE_INJECT_SCROLL_EVENT:
             write_position(&buf[1], &msg->inject_scroll_event.position);
-            int16_t hscroll =
-                sc_float_to_i16fp(msg->inject_scroll_event.hscroll);
-            int16_t vscroll =
-                sc_float_to_i16fp(msg->inject_scroll_event.vscroll);
+            // Accept values in the range [-16, 16].
+            // Normalize to [-1, 1] in order to use sc_float_to_i16fp().
+            float hscroll_norm = msg->inject_scroll_event.hscroll / 16;
+            hscroll_norm = CLAMP(hscroll_norm, -1, 1);
+            float vscroll_norm = msg->inject_scroll_event.vscroll / 16;
+            vscroll_norm = CLAMP(vscroll_norm, -1, 1);
+            int16_t hscroll = sc_float_to_i16fp(hscroll_norm);
+            int16_t vscroll = sc_float_to_i16fp(vscroll_norm);
             sc_write16be(&buf[13], (uint16_t) hscroll);
             sc_write16be(&buf[15], (uint16_t) vscroll);
             sc_write32be(&buf[17], msg->inject_scroll_event.buttons);

app/src/hid/hid_mouse.c

@@ -3,8 +3,8 @@
 #include <stdint.h>
 
 // 1 byte for buttons + padding, 1 byte for X position, 1 byte for Y position,
-// 1 byte for wheel motion
-#define SC_HID_MOUSE_INPUT_SIZE 4
+// 1 byte for wheel motion, 1 byte for hozizontal scrolling
+#define SC_HID_MOUSE_INPUT_SIZE 5
 
 /**
  * Mouse descriptor from the specification:
@@ -75,6 +75,21 @@ static const uint8_t SC_HID_MOUSE_REPORT_DESC[] = {
     // Input (Data, Variable, Relative): 3 position bytes (X, Y, Wheel)
     0x81, 0x06,
 
+    // Usage Page (Consumer Page)
+    0x05, 0x0C,
+    // Usage(AC Pan)
+    0x0A, 0x38, 0x02,
+    // Logical Minimum (-127)
+    0x15, 0x81,
+    // Logical Maximum (127)
+    0x25, 0x7F,
+    // Report Size (8)
+    0x75, 0x08,
+    // Report Count (1)
+    0x95, 0x01,
+    // Input (Data, Variable, Relative): 1 byte (AC Pan)
+    0x81, 0x06,
+
     // End Collection
     0xC0,
 
@@ -151,6 +166,12 @@ sc_hid_buttons_from_buttons_state(uint8_t buttons_state) {
     return c;
 }
 
+void
+sc_hid_mouse_init(struct sc_hid_mouse *hid) {
+    hid->residual_hscroll = 0;
+    hid->residual_vscroll = 0;
+}
+
 void
 sc_hid_mouse_generate_input_from_motion(struct sc_hid_input *hid_input,
                                     const struct sc_mouse_motion_event *event) {
@@ -160,7 +181,8 @@ sc_hid_mouse_generate_input_from_motion(struct sc_hid_input *hid_input,
     data[0] = sc_hid_buttons_from_buttons_state(event->buttons_state);
     data[1] = CLAMP(event->xrel, -127, 127);
     data[2] = CLAMP(event->yrel, -127, 127);
-    data[3] = 0; // wheel coordinates only used for scrolling
+    data[3] = 0; // no vertical scrolling
+    data[4] = 0; // no horizontal scrolling
 }
 
 void
@@ -172,22 +194,42 @@ sc_hid_mouse_generate_input_from_click(struct sc_hid_input *hid_input,
     data[0] = sc_hid_buttons_from_buttons_state(event->buttons_state);
     data[1] = 0; // no x motion
     data[2] = 0; // no y motion
-    data[3] = 0; // wheel coordinates only used for scrolling
+    data[3] = 0; // no vertical scrolling
+    data[4] = 0; // no horizontal scrolling
 }
 
-void
-sc_hid_mouse_generate_input_from_scroll(struct sc_hid_input *hid_input,
+static int8_t
+consume_scroll_integer(float *scroll) {
+    float value = CLAMP(*scroll, -127, 127);
+    int8_t consume = value; // truncate towards 0
+    float residual = value - consume;
+    *scroll = residual;
+    return consume;
+}
+
+bool
+sc_hid_mouse_generate_input_from_scroll(struct sc_hid_mouse *hid,
+                                        struct sc_hid_input *hid_input,
                                     const struct sc_mouse_scroll_event *event) {
     sc_hid_mouse_input_init(hid_input);
 
+    hid->residual_hscroll += event->hscroll;
+    hid->residual_vscroll += event->vscroll;
+    int8_t hscroll = consume_scroll_integer(&hid->residual_hscroll);
+    int8_t vscroll = consume_scroll_integer(&hid->residual_vscroll);
+
+    if (!hscroll && !vscroll) {
+        // Not enough scrolling to inject a scroll event
+        return false;
+    }
+
     uint8_t *data = hid_input->data;
     data[0] = 0; // buttons state irrelevant (and unknown)
     data[1] = 0; // no x motion
     data[2] = 0; // no y motion
-    // In practice, vscroll is always -1, 0 or 1, but in theory other values
-    // are possible
-    data[3] = CLAMP(event->vscroll, -127, 127);
-    // Horizontal scrolling ignored
+    data[3] = vscroll;
+    data[4] = hscroll;
+    return true;
 }
 
 void sc_hid_mouse_generate_open(struct sc_hid_open *hid_open) {

app/src/hid/hid_mouse.h

@@ -8,6 +8,13 @@
 
 #define SC_HID_ID_MOUSE 2
 
+struct sc_hid_mouse {
+    float residual_hscroll;
+    float residual_vscroll;
+};
+
+void sc_hid_mouse_init(struct sc_hid_mouse *hid);
+
 void
 sc_hid_mouse_generate_open(struct sc_hid_open *hid_open);
 
@@ -22,8 +29,9 @@ void
 sc_hid_mouse_generate_input_from_click(struct sc_hid_input *hid_input,
                                     const struct sc_mouse_click_event *event);
 
-void
-sc_hid_mouse_generate_input_from_scroll(struct sc_hid_input *hid_input,
+bool
+sc_hid_mouse_generate_input_from_scroll(struct sc_hid_mouse *hid,
+                                        struct sc_hid_input *hid_input,
                                     const struct sc_mouse_scroll_event *event);
 
 #endif

app/src/mouse_sdk.c

@@ -113,8 +113,8 @@ sc_mouse_processor_process_mouse_scroll(struct sc_mouse_processor *mp,
         .type = SC_CONTROL_MSG_TYPE_INJECT_SCROLL_EVENT,
         .inject_scroll_event = {
             .position = event->position,
-            .hscroll = CLAMP(event->hscroll, -1, 1),
-            .vscroll = CLAMP(event->vscroll, -1, 1),
+            .hscroll = event->hscroll,
+            .vscroll = event->vscroll,
             .buttons = convert_mouse_buttons(event->buttons_state),
         },
     };

app/src/uhid/mouse_uhid.c

@@ -55,7 +55,10 @@ sc_mouse_processor_process_mouse_scroll(struct sc_mouse_processor *mp,
     struct sc_mouse_uhid *mouse = DOWNCAST(mp);
 
     struct sc_hid_input hid_input;
-    sc_hid_mouse_generate_input_from_scroll(&hid_input, event);
+    if (!sc_hid_mouse_generate_input_from_scroll(&mouse->hid, &hid_input,
+                                                 event)) {
+        return;
+    }
 
     sc_mouse_uhid_send_input(mouse, &hid_input, "mouse scroll");
 }
@@ -63,6 +66,8 @@ sc_mouse_processor_process_mouse_scroll(struct sc_mouse_processor *mp,
 bool
 sc_mouse_uhid_init(struct sc_mouse_uhid *mouse,
                    struct sc_controller *controller) {
+    sc_hid_mouse_init(&mouse->hid);
+
     mouse->controller = controller;
 
     static const struct sc_mouse_processor_ops ops = {

app/src/uhid/mouse_uhid.h

@@ -4,11 +4,13 @@
 #include <stdbool.h>
 
 #include "controller.h"
+#include "hid/hid_mouse.h"
 #include "trait/mouse_processor.h"
 
 struct sc_mouse_uhid {
     struct sc_mouse_processor mouse_processor; // mouse processor trait
 
+    struct sc_hid_mouse hid;
     struct sc_controller *controller;
 };
 

app/src/usb/mouse_aoa.c

@@ -42,7 +42,10 @@ sc_mouse_processor_process_mouse_scroll(struct sc_mouse_processor *mp,
     struct sc_mouse_aoa *mouse = DOWNCAST(mp);
 
     struct sc_hid_input hid_input;
-    sc_hid_mouse_generate_input_from_scroll(&hid_input, event);
+    if (!sc_hid_mouse_generate_input_from_scroll(&mouse->hid, &hid_input,
+                                                 event)) {
+        return;
+    }
 
     if (!sc_aoa_push_input(mouse->aoa, &hid_input)) {
         LOGW("Could not push AOA HID input (mouse scroll)");
@@ -62,6 +65,8 @@ sc_mouse_aoa_init(struct sc_mouse_aoa *mouse, struct sc_aoa *aoa) {
         return false;
     }
 
+    sc_hid_mouse_init(&mouse->hid);
+
     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,

app/src/usb/mouse_aoa.h

@@ -6,11 +6,13 @@
 #include <stdbool.h>
 
 #include "usb/aoa_hid.h"
+#include "hid/hid_mouse.h"
 #include "trait/mouse_processor.h"
 
 struct sc_mouse_aoa {
     struct sc_mouse_processor mouse_processor; // mouse processor trait
 
+    struct sc_hid_mouse hid;
     struct sc_aoa *aoa;
 };
 

app/src/usb/screen_otg.c

@@ -164,8 +164,13 @@ sc_screen_otg_process_mouse_wheel(struct sc_screen_otg *screen,
 
     struct sc_mouse_scroll_event evt = {
         // .position not used for HID events
+#if SDL_VERSION_ATLEAST(2, 0, 18)
+        .hscroll = event->preciseX,
+        .vscroll = event->preciseY,
+#else
         .hscroll = event->x,
         .vscroll = event->y,
+#endif
         .buttons_state = sc_mouse_buttons_state_from_sdl(sdl_buttons_state),
     };
 

app/tests/test_control_msg_serialize.c

@@ -127,8 +127,8 @@ static void test_serialize_inject_scroll_event(void) {
                     .height = 1920,
                 },
             },
-            .hscroll = 1,
-            .vscroll = -1,
+            .hscroll = 16,
+            .vscroll = -16,
             .buttons = 1,
         },
     };
@@ -141,8 +141,8 @@ static void test_serialize_inject_scroll_event(void) {
         SC_CONTROL_MSG_TYPE_INJECT_SCROLL_EVENT,
         0x00, 0x00, 0x01, 0x04, 0x00, 0x00, 0x04, 0x02, // 260 1026
         0x04, 0x38, 0x07, 0x80, // 1080 1920
-        0x7F, 0xFF, // 1 (float encoded as i16)
-        0x80, 0x00, // -1 (float encoded as i16)
+        0x7F, 0xFF, // 16 (float encoded as i16 in the range [-16, 16])
+        0x80, 0x00, // -16 (float encoded as i16 in the range [-16, 16])
         0x00, 0x00, 0x00, 0x01, // 1
     };
     assert(!memcmp(buf, expected, sizeof(expected)));

doc/build.md

@@ -233,10 +233,10 @@ install` must be run as root)._
 
 #### Option 2: Use prebuilt server
 
- - [`scrcpy-server-v3.3`][direct-scrcpy-server]  
-   <sub>SHA-256: `351cb2edc7e4c2c75f09a7933fdabcf137be52e2602df154f24ec02db46e9e51`</sub>
+ - [`scrcpy-server-v3.3.1`][direct-scrcpy-server]  
+   <sub>SHA-256: `a0f70b20aa4998fbf658c94118cd6c8dab6abbb0647a3bdab344d70bc1ebcbb8`</sub>
 
-[direct-scrcpy-server]: https://github.com/Genymobile/scrcpy/releases/download/v3.3/scrcpy-server-v3.3
+[direct-scrcpy-server]: https://github.com/Genymobile/scrcpy/releases/download/v3.3.1/scrcpy-server-v3.3.1
 
 Download the prebuilt server somewhere, and specify its path during the Meson
 configuration:

doc/linux.md

@@ -6,11 +6,11 @@
 
 Download a static build of the [latest release]:
 
- - [`scrcpy-linux-x86_64-v3.3.tar.gz`][direct-linux-x86_64] (x86_64)  
-   <sub>SHA-256: `a0abf37003c3c47a53c1b2a12420296a2b0ee323cf3610fd6fbf9d9bab9d99f3`</sub>
+ - [`scrcpy-linux-x86_64-v3.3.1.tar.gz`][direct-linux-x86_64] (x86_64)  
+   <sub>SHA-256: `bbfe54c6b178adafeaffbbfbbc1548a74486553170c63e63bdd41863ad123422`</sub>
 
 [latest release]: https://github.com/Genymobile/scrcpy/releases/latest
-[direct-linux-x86_64]: https://github.com/Genymobile/scrcpy/releases/download/v3.3/scrcpy-linux-x86_64-v3.3.tar.gz
+[direct-linux-x86_64]: https://github.com/Genymobile/scrcpy/releases/download/v3.3.1/scrcpy-linux-x86_64-v3.3.1.tar.gz
 
 and extract it.
 

doc/macos.md

@@ -6,15 +6,15 @@
 
 Download a static build of the [latest release]:
 
- - [`scrcpy-macos-aarch64-v3.3.tar.gz`][direct-macos-aarch64] (aarch64)  
-   <sub>SHA-256: `7a4cdaeb8ba74593edda278c000ddedc8d70a51263a80b16a6345475d42ac21e`</sub>
+ - [`scrcpy-macos-aarch64-v3.3.1.tar.gz`][direct-macos-aarch64] (aarch64)  
+   <sub>SHA-256: `907b925900ebd8499c1e47acc9689a95bd3a6f9930eb1d7bdfbca8375ae4f139`</sub>
 
- - [`scrcpy-macos-x86_64-v3.3.tar.gz`][direct-macos-x86_64] (x86_64)  
-   <sub>SHA-256: `bb3c13aac166b92539371883a8781aa861a7cd18e3e6077e570ab7a1f562f774`</sub>
+ - [`scrcpy-macos-x86_64-v3.3.1.tar.gz`][direct-macos-x86_64] (x86_64)  
+   <sub>SHA-256: `69772491dad718eea82fc65c8e89febff7d41c4ce6faff02f4789a588d10fd7d`</sub>
 
 [latest release]: https://github.com/Genymobile/scrcpy/releases/latest
-[direct-macos-aarch64]: https://github.com/Genymobile/scrcpy/releases/download/v3.3/scrcpy-macos-aarch64-v3.3.tar.gz
-[direct-macos-x86_64]: https://github.com/Genymobile/scrcpy/releases/download/v3.3/scrcpy-macos-x86_64-v3.3.tar.gz
+[direct-macos-aarch64]: https://github.com/Genymobile/scrcpy/releases/download/v3.3.1/scrcpy-macos-aarch64-v3.3.1.tar.gz
+[direct-macos-x86_64]: https://github.com/Genymobile/scrcpy/releases/download/v3.3.1/scrcpy-macos-x86_64-v3.3.1.tar.gz
 
 and extract it.
 

doc/windows.md

@@ -6,14 +6,14 @@
 
 Download the [latest release]:
 
- - [`scrcpy-win64-v3.3.zip`][direct-win64] (64-bit)  
-   <sub>SHA-256: `a120cb4be7cde2891af38e83d2008173a0b6b6b5e344b2dfe668d0f892999933`</sub>
- - [`scrcpy-win32-v3.3.zip`][direct-win32] (32-bit)  
-   <sub>SHA-256: `e409ab83f8c57bd6ac741d652635cab7699fcf3d384e233833872f117b993ca6`</sub>
+ - [`scrcpy-win64-v3.3.1.zip`][direct-win64] (64-bit)  
+   <sub>SHA-256: `4fcad494772a3ae5de9a133149f8856d2fc429b41795f7cf7c754e0c1bb6fbc0`</sub>
+ - [`scrcpy-win32-v3.3.1.zip`][direct-win32] (32-bit)  
+   <sub>SHA-256: `ccdf1b4f5d19dfe760446a107e55b0a010a00e097d46533a161499c9333a20a6`</sub>
 
 [latest release]: https://github.com/Genymobile/scrcpy/releases/latest
-[direct-win64]: https://github.com/Genymobile/scrcpy/releases/download/v3.3/scrcpy-win64-v3.3.zip
-[direct-win32]: https://github.com/Genymobile/scrcpy/releases/download/v3.3/scrcpy-win32-v3.3.zip
+[direct-win64]: https://github.com/Genymobile/scrcpy/releases/download/v3.3.1/scrcpy-win64-v3.3.1.zip
+[direct-win32]: https://github.com/Genymobile/scrcpy/releases/download/v3.3.1/scrcpy-win32-v3.3.1.zip
 
 and extract it.
 

install_release.sh

@@ -2,8 +2,8 @@
 set -e
 
 BUILDDIR=build-auto
-PREBUILT_SERVER_URL=https://github.com/Genymobile/scrcpy/releases/download/v3.3/scrcpy-server-v3.3
-PREBUILT_SERVER_SHA256=351cb2edc7e4c2c75f09a7933fdabcf137be52e2602df154f24ec02db46e9e51
+PREBUILT_SERVER_URL=https://github.com/Genymobile/scrcpy/releases/download/v3.3.1/scrcpy-server-v3.3.1
+PREBUILT_SERVER_SHA256=a0f70b20aa4998fbf658c94118cd6c8dab6abbb0647a3bdab344d70bc1ebcbb8
 
 echo "[scrcpy] Downloading prebuilt server..."
 wget "$PREBUILT_SERVER_URL" -O scrcpy-server

meson.build

@@ -1,5 +1,5 @@
 project('scrcpy', 'c',
-        version: '3.3',
+        version: '3.3.1',
         meson_version: '>= 0.49',
         default_options: [
             'c_std=c11',

server/build.gradle

@@ -7,8 +7,8 @@ android {
         applicationId "com.genymobile.scrcpy"
         minSdkVersion 21
         targetSdkVersion 35
-        versionCode 30300
-        versionName "3.3"
+        versionCode 30301
+        versionName "3.3.1"
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
     }
     buildTypes {

server/build_without_gradle.sh

@@ -12,7 +12,7 @@
 set -e
 
 SCRCPY_DEBUG=false
-SCRCPY_VERSION_NAME=3.3
+SCRCPY_VERSION_NAME=3.3.1
 
 PLATFORM=${ANDROID_PLATFORM:-35}
 BUILD_TOOLS=${ANDROID_BUILD_TOOLS:-35.0.0}

server/src/main/java/com/genymobile/scrcpy/control/ControlMessageReader.java

@@ -112,8 +112,9 @@ public class ControlMessageReader {
 
     private ControlMessage parseInjectScrollEvent() throws IOException {
         Position position = parsePosition();
-        float hScroll = Binary.i16FixedPointToFloat(dis.readShort());
-        float vScroll = Binary.i16FixedPointToFloat(dis.readShort());
+        // Binary.i16FixedPointToFloat() decodes values assuming the full range is [-1, 1], but the actual range is [-16, 16].
+        float hScroll = Binary.i16FixedPointToFloat(dis.readShort()) * 16;
+        float vScroll = Binary.i16FixedPointToFloat(dis.readShort()) * 16;
         int buttons = dis.readInt();
         return ControlMessage.createInjectScrollEvent(position, hScroll, vScroll, buttons);
     }

server/src/test/java/com/genymobile/scrcpy/control/ControlMessageReaderTest.java

@@ -125,7 +125,7 @@ public class ControlMessageReaderTest {
         dos.writeShort(1080);
         dos.writeShort(1920);
         dos.writeShort(0); // 0.0f encoded as i16
-        dos.writeShort(0x8000); // -1.0f encoded as i16
+        dos.writeShort(0x8000); // -16.0f encoded as i16 (the range is [-16, 16])
         dos.writeInt(1);
         byte[] packet = bos.toByteArray();
 
@@ -139,7 +139,7 @@ public class ControlMessageReaderTest {
         Assert.assertEquals(1080, event.getPosition().getScreenSize().getWidth());
         Assert.assertEquals(1920, event.getPosition().getScreenSize().getHeight());
         Assert.assertEquals(0f, event.getHScroll(), 0f);
-        Assert.assertEquals(-1f, event.getVScroll(), 0f);
+        Assert.assertEquals(-16f, event.getVScroll(), 0f);
         Assert.assertEquals(1, event.getButtons());
 
         Assert.assertEquals(-1, bis.read()); // EOS