Add an option to forward all clicks

Add --forward-all-clicks to disable mouse shortcuts and forward middle
and right clicks to the device instead.

Fixes #1302 <https://github.com/Genymobile/scrcpy/issues/1302>
Fixes #1613 <https://github.com/Genymobile/scrcpy/issues/1613>

README.md

@@ -595,6 +595,16 @@ scrcpy --no-key-repeat
 ```
 
 
+#### Right-click and middle-click
+
+By default, right-click triggers BACK (or POWER on) and middle-click triggers
+HOME. To disable these shortcuts and forward the clicks to the device instead:
+
+```bash
+scrcpy --forward-all-clicks
+```
+
+
 ### File drop
 
 #### Install APK

app/scrcpy.1

@@ -60,6 +60,10 @@ Default is 0.
 .B \-\-force\-adb\-forward
 Do not attempt to use "adb reverse" to connect to the device.
 
+.TP
+.B \-\-forward\-all\-clicks
+By default, right-click triggers BACK (or POWER on) and middle-click triggers HOME. This option disables these shortcuts and forward the clicks to the device instead.
+
 .TP
 .B \-f, \-\-fullscreen
 Start in fullscreen.
@@ -92,14 +96,14 @@ Disable device control (mirror the device in read\-only).
 .B \-N, \-\-no\-display
 Do not display device (only when screen recording is enabled).
 
-.TP
-.B \-\-no\-mipmaps
-If the renderer is OpenGL 3.0+ or OpenGL ES 2.0+, then mipmaps are automatically generated to improve downscaling quality. This option disables the generation of mipmaps.
-
 .TP
 .B \-\-no\-key\-repeat
 Do not forward repeated key events when a key is held down.
 
+.TP
+.B \-\-no\-mipmaps
+If the renderer is OpenGL 3.0+ or OpenGL ES 2.0+, then mipmaps are automatically generated to improve downscaling quality. This option disables the generation of mipmaps.
+
 .TP
 .BI "\-p, \-\-port " port[:port]
 Set the TCP port (range) used by the client to listen.

app/src/cli.c

@@ -57,6 +57,11 @@ scrcpy_print_usage(const char *arg0) {
         "        Do not attempt to use \"adb reverse\" to connect to the\n"
         "        the device.\n"
         "\n"
+        "    --forward-all-clicks\n"
+        "        By default, right-click triggers BACK (or POWER on) and\n"
+        "        middle-click triggers HOME. This option disables these\n"
+        "        shortcuts and forward the clicks to the device instead.\n"
+        "\n"
         "    -f, --fullscreen\n"
         "        Start in fullscreen.\n"
         "\n"
@@ -87,14 +92,14 @@ scrcpy_print_usage(const char *arg0) {
         "        Do not display device (only when screen recording is\n"
         "        enabled).\n"
         "\n"
+        "    --no-key-repeat\n"
+        "        Do not forward repeated key events when a key is held down.\n"
+        "\n"
         "    --no-mipmaps\n"
         "        If the renderer is OpenGL 3.0+ or OpenGL ES 2.0+, then\n"
         "        mipmaps are automatically generated to improve downscaling\n"
         "        quality. This option disables the generation of mipmaps.\n"
         "\n"
-        "    --no-key-repeat\n"
-        "        Do not forward repeated key events when a key is held down.\n"
-        "\n"
         "    -p, --port port[:port]\n"
         "        Set the TCP port (range) used by the client to listen.\n"
         "        Default is %d:%d.\n"
@@ -651,6 +656,7 @@ guess_record_format(const char *filename) {
 #define OPT_DISABLE_SCREENSAVER    1020
 #define OPT_SHORTCUT_MOD           1021
 #define OPT_NO_KEY_REPEAT          1022
+#define OPT_FORWARD_ALL_CLICKS     1023
 
 bool
 scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
@@ -664,6 +670,8 @@ scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
         {"display",                required_argument, NULL, OPT_DISPLAY_ID},
         {"force-adb-forward",      no_argument,       NULL,
                                                   OPT_FORCE_ADB_FORWARD},
+        {"forward-all-clicks",     no_argument,       NULL,
+                                                  OPT_FORWARD_ALL_CLICKS},
         {"fullscreen",             no_argument,       NULL, 'f'},
         {"help",                   no_argument,       NULL, 'h'},
         {"lock-video-orientation", required_argument, NULL,
@@ -672,8 +680,8 @@ scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
         {"max-size",               required_argument, NULL, 'm'},
         {"no-control",             no_argument,       NULL, 'n'},
         {"no-display",             no_argument,       NULL, 'N'},
-        {"no-mipmaps",             no_argument,       NULL, OPT_NO_MIPMAPS},
         {"no-key-repeat",          no_argument,       NULL, OPT_NO_KEY_REPEAT},
+        {"no-mipmaps",             no_argument,       NULL, OPT_NO_MIPMAPS},
         {"port",                   required_argument, NULL, 'p'},
         {"prefer-text",            no_argument,       NULL, OPT_PREFER_TEXT},
         {"push-target",            required_argument, NULL, OPT_PUSH_TARGET},
@@ -856,6 +864,9 @@ scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
                     return false;
                 }
                 break;
+            case OPT_FORWARD_ALL_CLICKS:
+                opts->forward_all_clicks = true;
+                break;
             default:
                 // getopt prints the error message on stderr
                 return false;

app/src/input_manager.c

@@ -60,6 +60,7 @@ input_manager_init(struct input_manager *im,
     im->control = options->control;
     im->forward_key_repeat = options->forward_key_repeat;
     im->prefer_text = options->prefer_text;
+    im->forward_all_clicks = options->forward_all_clicks;
 
     const struct sc_shortcut_mods *shortcut_mods = &options->shortcut_mods;
     assert(shortcut_mods->count);
@@ -629,7 +630,7 @@ input_manager_process_mouse_button(struct input_manager *im,
     }
 
     bool down = event->type == SDL_MOUSEBUTTONDOWN;
-    if (down) {
+    if (!im->forward_all_clicks && down) {
         if (control && event->button == SDL_BUTTON_RIGHT) {
             press_back_or_turn_screen_on(im->controller);
             return;

app/src/input_manager.h

@@ -25,6 +25,7 @@ struct input_manager {
     bool control;
     bool forward_key_repeat;
     bool prefer_text;
+    bool forward_all_clicks;
 
     struct {
         unsigned data[SC_MAX_SHORTCUT_MODS];

app/src/main.c

@@ -100,7 +100,7 @@ main(int argc, char *argv[]) {
 
 #if defined (__WINDOWS__) && ! defined (WINDOWS_NOCONSOLE)
     if (res != 0) {
-        fprintf(stderr, "Press any key to continue...\n");
+        fprintf(stderr, "Press Enter to continue...\n");
         getchar();
     }
 #endif

app/src/recorder.c

@@ -361,12 +361,14 @@ recorder_push(struct recorder *recorder, const AVPacket *packet) {
 
     if (recorder->failed) {
         // reject any new packet (this will stop the stream)
+        mutex_unlock(recorder->mutex);
         return false;
     }
 
     struct record_packet *rec = record_packet_new(packet);
     if (!rec) {
         LOGC("Could not allocate record packet");
+        mutex_unlock(recorder->mutex);
         return false;
     }
 

app/src/scrcpy.h

@@ -79,6 +79,7 @@ struct scrcpy_options {
     bool force_adb_forward;
     bool disable_screensaver;
     bool forward_key_repeat;
+    bool forward_all_clicks;
 };
 
 #define SCRCPY_OPTIONS_DEFAULT { \
@@ -123,6 +124,7 @@ struct scrcpy_options {
     .force_adb_forward = false, \
     .disable_screensaver = false, \
     .forward_key_repeat = true, \
+    .forward_all_clicks = false, \
 }
 
 bool

app/src/stream.h

@@ -14,7 +14,6 @@ struct video_buffer;
 
 struct stream {
     socket_t socket;
-    struct video_buffer *video_buffer;
     SDL_Thread *thread;
     struct decoder *decoder;
     struct recorder *recorder;

prebuilt-deps/prepare-dep

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -e
 url="$1"
 sum="$2"

run

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # Run scrcpy generated in the specified BUILDDIR.
 #
 # This provides the same feature as "ninja run", except that it is possible to

scripts/run-scrcpy.sh

@@ -1,2 +1,2 @@
-#!/bin/bash
+#!/usr/bin/env bash
 SCRCPY_SERVER_PATH="$MESON_BUILD_ROOT/server/scrcpy-server" "$MESON_BUILD_ROOT/app/scrcpy"

server/build.gradle

@@ -1,11 +1,11 @@
 apply plugin: 'com.android.application'
 
 android {
-    compileSdkVersion 29
+    compileSdkVersion 30
     defaultConfig {
         applicationId "com.genymobile.scrcpy"
         minSdkVersion 21
-        targetSdkVersion 29
+        targetSdkVersion 30
         versionCode 19
         versionName "1.16"
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"

server/build_without_gradle.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 #
 # This script generates the scrcpy binary "manually" (without gradle).
 #
@@ -14,8 +14,8 @@ set -e
 SCRCPY_DEBUG=false
 SCRCPY_VERSION_NAME=1.16
 
-PLATFORM=${ANDROID_PLATFORM:-29}
+PLATFORM=${ANDROID_PLATFORM:-30}
-BUILD_TOOLS=${ANDROID_BUILD_TOOLS:-29.0.2}
+BUILD_TOOLS=${ANDROID_BUILD_TOOLS:-30.0.0}
 
 BUILD_DIR="$(realpath ${BUILD_DIR:-build_manual})"
 CLASSES_DIR="$BUILD_DIR/classes"

server/scripts/build-wrapper.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # Wrapper script to invoke gradle from meson
 set -e
 

server/src/main/java/com/genymobile/scrcpy/Controller.java

@@ -205,9 +205,13 @@ public class Controller {
             }
         }
 
+        // Right-click and middle-click only work if the source is a mouse
+        boolean nonPrimaryButtonPressed = (buttons & ~MotionEvent.BUTTON_PRIMARY) != 0;
+        int source = nonPrimaryButtonPressed ? InputDevice.SOURCE_MOUSE : InputDevice.SOURCE_TOUCHSCREEN;
+
         MotionEvent event = MotionEvent
-                .obtain(lastTouchDown, now, action, pointerCount, pointerProperties, pointerCoords, 0, buttons, 1f, 1f, DEVICE_ID_VIRTUAL, 0,
+                .obtain(lastTouchDown, now, action, pointerCount, pointerProperties, pointerCoords, 0, buttons, 1f, 1f, DEVICE_ID_VIRTUAL, 0, source,
-                        InputDevice.SOURCE_TOUCHSCREEN, 0);
+                        0);
         return device.injectEvent(event);
     }