Accept positional control events without display

The position of touch and scroll must normally be "resolved" with a
"position mapper" associated to the display.

But to support the injection of such events with scrcpy-server alone
without video, handle the case where there is no display.

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

app/data/scrcpy_static_wrapper.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+cd "$(dirname ${BASH_SOURCE[0]})"
+export ADB="${ADB:-./adb}"
+export SCRCPY_SERVER_PATH="${SCRCPY_SERVER_PATH:-./scrcpy-server}"
+export SCRCPY_ICON_PATH="${SCRCPY_ICON_PATH:-./icon.png}"
+./scrcpy_bin "$@"

app/meson.build

@@ -46,7 +46,6 @@ src = [
     'src/util/acksync.c',
     'src/util/audiobuf.c',
     'src/util/average.c',
-    'src/util/env.c',
     'src/util/file.c',
     'src/util/intmap.c',
     'src/util/intr.c',

app/src/adb/adb.c

@@ -7,7 +7,6 @@
 
 #include "adb_device.h"
 #include "adb_parser.h"
-#include "util/env.h"
 #include "util/file.h"
 #include "util/log.h"
 #include "util/process_intr.h"
@@ -25,45 +24,15 @@
  */
 #define SC_ADB_COMMAND(...) { sc_adb_get_executable(), __VA_ARGS__, NULL }
 
-static char *adb_executable;
-
-bool
-sc_adb_init(void) {
-    adb_executable = sc_get_env("ADB");
-    if (adb_executable) {
-        LOGD("Using adb: %s", adb_executable);
-        return true;
-    }
-
-#if !defined(PORTABLE) || defined(_WIN32)
-    adb_executable = strdup("adb");
-    if (!adb_executable) {
-        LOG_OOM();
-        return false;
-    }
-#else
-    // For portable builds, use the absolute path to the adb executable
-    // in the same directory as scrcpy (except on Windows, where "adb"
-    // is sufficient)
-    adb_executable = sc_file_get_local_path("adb");
-    if (!adb_executable) {
-        // Error already logged
-        return false;
-    }
-
-    LOGD("Using adb (portable): %s", adb_executable);
-#endif
-
-    return true;
-}
-
-void
-sc_adb_destroy(void) {
-    free(adb_executable);
-}
+static const char *adb_executable;
 
 const char *
 sc_adb_get_executable(void) {
+    if (!adb_executable) {
+        adb_executable = getenv("ADB");
+        if (!adb_executable)
+            adb_executable = "adb";
+    }
     return adb_executable;
 }
 

app/src/adb/adb.h

@@ -15,12 +15,6 @@
 
 #define SC_ADB_SILENT (SC_ADB_NO_STDOUT | SC_ADB_NO_STDERR | SC_ADB_NO_LOGERR)
 
-bool
-sc_adb_init(void);
-
-void
-sc_adb_destroy(void);
-
 const char *
 sc_adb_get_executable(void);
 

app/src/icon.c

@@ -9,7 +9,6 @@
 
 #include "config.h"
 #include "compat.h"
-#include "util/env.h"
 #include "util/file.h"
 #include "util/log.h"
 #include "util/str.h"
@@ -20,22 +19,35 @@
 
 static char *
 get_icon_path(void) {
-    char *icon_path = sc_get_env("SCRCPY_ICON_PATH");
-    if (icon_path) {
+#ifdef __WINDOWS__
+    const wchar_t *icon_path_env = _wgetenv(L"SCRCPY_ICON_PATH");
+#else
+    const char *icon_path_env = getenv("SCRCPY_ICON_PATH");
+#endif
+    if (icon_path_env) {
         // if the envvar is set, use it
+#ifdef __WINDOWS__
+        char *icon_path = sc_str_from_wchars(icon_path_env);
+#else
+        char *icon_path = strdup(icon_path_env);
+#endif
+        if (!icon_path) {
+            LOG_OOM();
+            return NULL;
+        }
         LOGD("Using SCRCPY_ICON_PATH: %s", icon_path);
         return icon_path;
     }
 
 #ifndef PORTABLE
     LOGD("Using icon: " SCRCPY_DEFAULT_ICON_PATH);
-    icon_path = strdup(SCRCPY_DEFAULT_ICON_PATH);
+    char *icon_path = strdup(SCRCPY_DEFAULT_ICON_PATH);
     if (!icon_path) {
         LOG_OOM();
         return NULL;
     }
 #else
-    icon_path = sc_file_get_local_path(SCRCPY_PORTABLE_ICON_FILENAME);
+    char *icon_path = sc_file_get_local_path(SCRCPY_PORTABLE_ICON_FILENAME);
     if (!icon_path) {
         LOGE("Could not get icon path");
         return NULL;

app/src/server.c

@@ -9,7 +9,6 @@
 
 #include "adb/adb.h"
 #include "util/binary.h"
-#include "util/env.h"
 #include "util/file.h"
 #include "util/log.h"
 #include "util/net_intr.h"
@@ -26,22 +25,35 @@
 
 static char *
 get_server_path(void) {
-    char *server_path = sc_get_env("SCRCPY_SERVER_PATH");
-    if (server_path) {
+#ifdef __WINDOWS__
+    const wchar_t *server_path_env = _wgetenv(L"SCRCPY_SERVER_PATH");
+#else
+    const char *server_path_env = getenv("SCRCPY_SERVER_PATH");
+#endif
+    if (server_path_env) {
         // if the envvar is set, use it
+#ifdef __WINDOWS__
+        char *server_path = sc_str_from_wchars(server_path_env);
+#else
+        char *server_path = strdup(server_path_env);
+#endif
+        if (!server_path) {
+            LOG_OOM();
+            return NULL;
+        }
         LOGD("Using SCRCPY_SERVER_PATH: %s", server_path);
         return server_path;
     }
 
 #ifndef PORTABLE
     LOGD("Using server: " SC_SERVER_PATH_DEFAULT);
-    server_path = strdup(SC_SERVER_PATH_DEFAULT);
+    char *server_path = strdup(SC_SERVER_PATH_DEFAULT);
     if (!server_path) {
         LOG_OOM();
         return NULL;
     }
 #else
-    server_path = sc_file_get_local_path(SC_SERVER_FILENAME);
+    char *server_path = sc_file_get_local_path(SC_SERVER_FILENAME);
     if (!server_path) {
         LOGE("Could not get local file path, "
              "using " SC_SERVER_FILENAME " from current directory");
@@ -485,21 +497,14 @@ sc_server_init(struct sc_server *server, const struct sc_server_params *params,
     // end of the program
     server->params = *params;
 
-    bool ok = sc_adb_init();
+    bool ok = sc_mutex_init(&server->mutex);
     if (!ok) {
         return false;
     }
 
-    ok = sc_mutex_init(&server->mutex);
-    if (!ok) {
-        sc_adb_destroy();
-        return false;
-    }
-
     ok = sc_cond_init(&server->cond_stopped);
     if (!ok) {
         sc_mutex_destroy(&server->mutex);
-        sc_adb_destroy();
         return false;
     }
 
@@ -507,7 +512,6 @@ sc_server_init(struct sc_server *server, const struct sc_server_params *params,
     if (!ok) {
         sc_cond_destroy(&server->cond_stopped);
         sc_mutex_destroy(&server->mutex);
-        sc_adb_destroy();
         return false;
     }
 
@@ -1149,6 +1153,4 @@ sc_server_destroy(struct sc_server *server) {
     sc_intr_destroy(&server->intr);
     sc_cond_destroy(&server->cond_stopped);
     sc_mutex_destroy(&server->mutex);
-
-    sc_adb_destroy();
 }

app/src/sys/unix/file.c

@@ -6,9 +6,6 @@
 #include <string.h>
 #include <sys/stat.h>
 #include <unistd.h>
-#ifdef __APPLE__
-# include <mach-o/dyld.h> // for _NSGetExecutablePath()
-#endif
 
 #include "util/log.h"
 
@@ -63,22 +60,11 @@ sc_file_get_executable_path(void) {
     }
     buf[len] = '\0';
     return strdup(buf);
-#elif defined(__APPLE__)
-    char buf[PATH_MAX];
-    uint32_t bufsize = PATH_MAX;
-    if (_NSGetExecutablePath(buf, &bufsize) != 0) {
-        LOGE("Executable path buffer too small; need %u bytes", bufsize);
-        return NULL;
-    }
-    return realpath(buf, NULL);
 #else
-    // "_" is often used to store the full path of the command being executed
-    char *path = getenv("_");
-    if (!path) {
-        LOGE("Could not determine executable path");
-        return NULL;
-    }
-    return strdup(path);
+    // in practice, we only need this feature for portable builds, only used on
+    // Windows, so we don't care implementing it for every platform
+    // (it's useful to have a working version on Linux for debugging though)
+    return NULL;
 #endif
 }
 

app/src/usb/scrcpy_otg.c

@@ -95,14 +95,9 @@ scrcpy_otg(struct scrcpy_options *options) {
     // On Windows, only one process could open a USB device
     // <https://github.com/Genymobile/scrcpy/issues/2773>
     LOGI("Killing adb server (if any)...");
-    if (sc_adb_init()) {
-        unsigned flags = SC_ADB_NO_STDOUT | SC_ADB_NO_STDERR | SC_ADB_NO_LOGERR;
-        // uninterruptible (intr == NULL), but in practice it's very quick
-        sc_adb_kill_server(NULL, flags);
-        sc_adb_destroy();
-    } else {
-        LOGW("Could not call adb executable, adb server not killed");
-    }
+    unsigned flags = SC_ADB_NO_STDOUT | SC_ADB_NO_STDERR | SC_ADB_NO_LOGERR;
+    // uninterruptible (intr == NULL), but in practice it's very quick
+    sc_adb_kill_server(NULL, flags);
 #endif
 
     static const struct sc_usb_callbacks cbs = {

app/src/util/env.c

@@ -1,29 +0,0 @@
-#include "env.h"
-
-#include <stdlib.h>
-#include <string.h>
-#include "util/str.h"
-
-char *
-sc_get_env(const char *varname) {
-#ifdef _WIN32
-    wchar_t *w_varname = sc_str_to_wchars(varname);
-    if (!w_varname) {
-         return NULL;
-    }
-    const wchar_t *value = _wgetenv(w_varname);
-    free(w_varname);
-    if (!value) {
-        return NULL;
-    }
-
-    return sc_str_from_wchars(value);
-#else
-    const char *value = getenv(varname);
-    if (!value) {
-        return NULL;
-    }
-
-    return strdup(value);
-#endif
-}

app/src/util/env.h

@@ -1,12 +0,0 @@
-#ifndef SC_ENV_H
-#define SC_ENV_H
-
-#include "common.h"
-
-// Return the value of the environment variable (may be NULL).
-//
-// The returned value must be freed by the caller.
-char *
-sc_get_env(const char *varname);
-
-#endif

app/src/util/net.c

@@ -9,6 +9,8 @@
 #ifdef _WIN32
 # include <ws2tcpip.h>
   typedef int socklen_t;
+  typedef SOCKET sc_raw_socket;
+# define SC_RAW_SOCKET_NONE INVALID_SOCKET
 #else
 # include <sys/types.h>
 # include <sys/socket.h>
@@ -21,6 +23,8 @@
   typedef struct sockaddr_in SOCKADDR_IN;
   typedef struct sockaddr SOCKADDR;
   typedef struct in_addr IN_ADDR;
+  typedef int sc_raw_socket;
+# define SC_RAW_SOCKET_NONE -1
 #endif
 
 bool
@@ -43,26 +47,17 @@ net_cleanup(void) {
 #endif
 }
 
-static inline bool
-sc_raw_socket_close(sc_raw_socket raw_sock) {
-#ifndef _WIN32
-    return !close(raw_sock);
-#else
-    return !closesocket(raw_sock);
-#endif
-}
-
 static inline sc_socket
 wrap(sc_raw_socket sock) {
-#ifdef SC_SOCKET_CLOSE_ON_INTERRUPT
-    if (sock == SC_RAW_SOCKET_NONE) {
+#ifdef _WIN32
+    if (sock == INVALID_SOCKET) {
         return SC_SOCKET_NONE;
     }
 
-    struct sc_socket_wrapper *socket = malloc(sizeof(*socket));
+    struct sc_socket_windows *socket = malloc(sizeof(*socket));
     if (!socket) {
         LOG_OOM();
-        sc_raw_socket_close(sock);
+        closesocket(sock);
         return SC_SOCKET_NONE;
     }
 
@@ -77,9 +72,9 @@ wrap(sc_raw_socket sock) {
 
 static inline sc_raw_socket
 unwrap(sc_socket socket) {
-#ifdef SC_SOCKET_CLOSE_ON_INTERRUPT
+#ifdef _WIN32
     if (socket == SC_SOCKET_NONE) {
-        return SC_RAW_SOCKET_NONE;
+        return INVALID_SOCKET;
     }
 
     return socket->socket;
@@ -88,6 +83,17 @@ unwrap(sc_socket socket) {
 #endif
 }
 
+#ifndef HAVE_SOCK_CLOEXEC // avoid unused-function warning
+static inline bool
+sc_raw_socket_close(sc_raw_socket raw_sock) {
+#ifndef _WIN32
+    return !close(raw_sock);
+#else
+    return !closesocket(raw_sock);
+#endif
+}
+#endif
+
 #ifndef HAVE_SOCK_CLOEXEC
 // If SOCK_CLOEXEC does not exist, the flag must be set manually once the
 // socket is created
@@ -242,9 +248,9 @@ net_interrupt(sc_socket socket) {
 
     sc_raw_socket raw_sock = unwrap(socket);
 
-#ifdef SC_SOCKET_CLOSE_ON_INTERRUPT
+#ifdef _WIN32
     if (!atomic_flag_test_and_set(&socket->closed)) {
-        return sc_raw_socket_close(raw_sock);
+        return !closesocket(raw_sock);
     }
     return true;
 #else
@@ -256,15 +262,15 @@ bool
 net_close(sc_socket socket) {
     sc_raw_socket raw_sock = unwrap(socket);
 
-#ifdef SC_SOCKET_CLOSE_ON_INTERRUPT
+#ifdef _WIN32
     bool ret = true;
     if (!atomic_flag_test_and_set(&socket->closed)) {
-        ret = sc_raw_socket_close(raw_sock);
+        ret = !closesocket(raw_sock);
     }
     free(socket);
     return ret;
 #else
-    return sc_raw_socket_close(raw_sock);
+    return !close(raw_sock);
 #endif
 }
 

app/src/util/net.h

@@ -7,36 +7,21 @@
 #include <stdint.h>
 
 #ifdef _WIN32
+
 # include <winsock2.h>
-  typedef SOCKET sc_raw_socket;
-# define SC_RAW_SOCKET_NONE INVALID_SOCKET
-#else // not _WIN32
-# include <sys/socket.h>
-  typedef int sc_raw_socket;
-# define SC_RAW_SOCKET_NONE -1
-#endif
-
-#if defined(_WIN32) || defined(__APPLE__)
-// On Windows and macOS, shutdown() does not interrupt accept() or read()
-// calls, so net_interrupt() must call close() instead, and net_close() must
-// behave accordingly.
-// This causes a small race condition (once the socket is closed, its
-// handle becomes invalid and may in theory be reassigned before another
-// thread calls accept() or read()), but it is deemed acceptable as a
-// workaround.
-# define SC_SOCKET_CLOSE_ON_INTERRUPT
-#endif
-
-#ifdef SC_SOCKET_CLOSE_ON_INTERRUPT
 # include <stdatomic.h>
 # define SC_SOCKET_NONE NULL
-  typedef struct sc_socket_wrapper {
-      sc_raw_socket socket;
+  typedef struct sc_socket_windows {
+      SOCKET socket;
       atomic_flag closed;
   } *sc_socket;
-#else
+
+#else // not _WIN32
+
+# include <sys/socket.h>
 # define SC_SOCKET_NONE -1
-  typedef sc_raw_socket sc_socket;
+  typedef int sc_socket;
+
 #endif
 
 #define IPV4_LOCALHOST 0x7F000001

release/build_linux.sh

@@ -36,7 +36,8 @@ ninja -C "$LINUX_BUILD_DIR"
 
 # Group intermediate outputs into a 'dist' directory
 mkdir -p "$LINUX_BUILD_DIR/dist"
-cp "$LINUX_BUILD_DIR"/app/scrcpy "$LINUX_BUILD_DIR/dist/"
+cp "$LINUX_BUILD_DIR"/app/scrcpy "$LINUX_BUILD_DIR/dist/scrcpy_bin"
 cp app/data/icon.png "$LINUX_BUILD_DIR/dist/"
+cp app/data/scrcpy_static_wrapper.sh "$LINUX_BUILD_DIR/dist/scrcpy"
 cp app/scrcpy.1 "$LINUX_BUILD_DIR/dist/"
 cp -r "$ADB_INSTALL_DIR"/. "$LINUX_BUILD_DIR/dist/"

release/build_macos.sh

@@ -36,7 +36,8 @@ ninja -C "$MACOS_BUILD_DIR"
 
 # Group intermediate outputs into a 'dist' directory
 mkdir -p "$MACOS_BUILD_DIR/dist"
-cp "$MACOS_BUILD_DIR"/app/scrcpy "$MACOS_BUILD_DIR/dist/"
+cp "$MACOS_BUILD_DIR"/app/scrcpy "$MACOS_BUILD_DIR/dist/scrcpy_bin"
 cp app/data/icon.png "$MACOS_BUILD_DIR/dist/"
+cp app/data/scrcpy_static_wrapper.sh "$MACOS_BUILD_DIR/dist/scrcpy"
 cp app/scrcpy.1 "$MACOS_BUILD_DIR/dist/"
 cp -r "$ADB_INSTALL_DIR"/. "$MACOS_BUILD_DIR/dist/"

release/package_client.sh

@@ -40,7 +40,7 @@ case "$FORMAT" in
         zip -r "$OUTPUT_DIR/$TARGET_DIRNAME.zip" "$TARGET_DIRNAME"
         ;;
     tar.gz)
-        tar cvzf "$OUTPUT_DIR/$TARGET_DIRNAME.tar.gz" "$TARGET_DIRNAME"
+        tar cvf "$OUTPUT_DIR/$TARGET_DIRNAME.tar.gz" "$TARGET_DIRNAME"
         ;;
     *)
         echo "Invalid format (expected zip or tar.gz): $FORMAT" >&2