Do not report error on device disconnected

A device disconnection (when the adb connection is closed) makes the
read() on the "receiver" socket fail.

Since commit 063a8339ed, this is reported
as an error. As a consequence, scrcpy fails with:

    ERROR: Controller error

instead of:

    WARN: Device disconnected

To fix the issue, report a device disconnection in that case.

PR #5044 <https://github.com/Genymobile/scrcpy/pull/5044>

README.md

@@ -2,7 +2,7 @@
 source for the project. Do not download releases from random websites, even if
 their name contains `scrcpy`.**
 
-# scrcpy (v2.4)
+# scrcpy (v2.5)
 
 <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", "2.4"
+      VALUE "ProductVersion", "2.5"
     END
   END
   BLOCK "VarFileInfo"

app/src/controller.c

@@ -7,12 +7,13 @@
 #define SC_CONTROL_MSG_QUEUE_MAX 64
 
 static void
-sc_controller_receiver_on_error(struct sc_receiver *receiver, void *userdata) {
+sc_controller_receiver_on_ended(struct sc_receiver *receiver, bool error,
+                                void *userdata) {
     (void) receiver;
 
     struct sc_controller *controller = userdata;
     // Forward the event to the controller listener
-    controller->cbs->on_error(controller, controller->cbs_userdata);
+    controller->cbs->on_ended(controller, error, controller->cbs_userdata);
 }
 
 bool
@@ -27,7 +28,7 @@ sc_controller_init(struct sc_controller *controller, sc_socket control_socket,
     }
 
     static const struct sc_receiver_callbacks receiver_cbs = {
-        .on_error = sc_controller_receiver_on_error,
+        .on_ended = sc_controller_receiver_on_ended,
     };
 
     ok = sc_receiver_init(&controller->receiver, control_socket, &receiver_cbs,
@@ -55,7 +56,7 @@ sc_controller_init(struct sc_controller *controller, sc_socket control_socket,
     controller->control_socket = control_socket;
     controller->stopped = false;
 
-    assert(cbs && cbs->on_error);
+    assert(cbs && cbs->on_ended);
     controller->cbs = cbs;
     controller->cbs_userdata = cbs_userdata;
 
@@ -110,21 +111,30 @@ sc_controller_push_msg(struct sc_controller *controller,
 
 static bool
 process_msg(struct sc_controller *controller,
-            const struct sc_control_msg *msg) {
+            const struct sc_control_msg *msg, bool *eos) {
     static uint8_t serialized_msg[SC_CONTROL_MSG_MAX_SIZE];
     size_t length = sc_control_msg_serialize(msg, serialized_msg);
     if (!length) {
+        *eos = false;
         return false;
     }
+
     ssize_t w =
         net_send_all(controller->control_socket, serialized_msg, length);
-    return (size_t) w == length;
+    if ((size_t) w != length) {
+        *eos = true;
+        return false;
+    }
+
+    return true;
 }
 
 static int
 run_controller(void *data) {
     struct sc_controller *controller = data;
 
+    bool error = false;
+
     for (;;) {
         sc_mutex_lock(&controller->mutex);
         while (!controller->stopped
@@ -134,6 +144,7 @@ run_controller(void *data) {
         if (controller->stopped) {
             // stop immediately, do not process further msgs
             sc_mutex_unlock(&controller->mutex);
+            LOGD("Controller stopped");
             break;
         }
 
@@ -141,20 +152,21 @@ run_controller(void *data) {
         struct sc_control_msg msg = sc_vecdeque_pop(&controller->queue);
         sc_mutex_unlock(&controller->mutex);
 
-        bool ok = process_msg(controller, &msg);
+        bool eos;
+        bool ok = process_msg(controller, &msg, &eos);
         sc_control_msg_destroy(&msg);
         if (!ok) {
-            LOGD("Could not write msg to socket");
-            goto error;
+            if (eos) {
+                LOGD("Controller stopped (socket closed)");
+            } // else error already logged
+            error = !eos;
+            break;
         }
     }
 
+    controller->cbs->on_ended(controller, error, controller->cbs_userdata);
+
     return 0;
-
-error:
-    controller->cbs->on_error(controller, controller->cbs_userdata);
-
-    return 1; // ignored
 }
 
 bool

app/src/controller.h

@@ -28,7 +28,8 @@ struct sc_controller {
 };
 
 struct sc_controller_callbacks {
-    void (*on_error)(struct sc_controller *controller, void *userdata);
+    void (*on_ended)(struct sc_controller *controller, bool error,
+                     void *userdata);
 };
 
 bool

app/src/receiver.c

@@ -21,7 +21,7 @@ sc_receiver_init(struct sc_receiver *receiver, sc_socket control_socket,
     receiver->acksync = NULL;
     receiver->uhid_devices = NULL;
 
-    assert(cbs && cbs->on_error);
+    assert(cbs && cbs->on_ended);
     receiver->cbs = cbs;
     receiver->cbs_userdata = cbs_userdata;
 
@@ -134,12 +134,15 @@ run_receiver(void *data) {
     static uint8_t buf[DEVICE_MSG_MAX_SIZE];
     size_t head = 0;
 
+    bool error = false;
+
     for (;;) {
         assert(head < DEVICE_MSG_MAX_SIZE);
         ssize_t r = net_recv(receiver->control_socket, buf + head,
                              DEVICE_MSG_MAX_SIZE - head);
         if (r <= 0) {
             LOGD("Receiver stopped");
+            // device disconnected: keep error=false
             break;
         }
 
@@ -147,6 +150,7 @@ run_receiver(void *data) {
         ssize_t consumed = process_msgs(receiver, buf, head);
         if (consumed == -1) {
             // an error occurred
+            error = true;
             break;
         }
 
@@ -157,7 +161,7 @@ run_receiver(void *data) {
         }
     }
 
-    receiver->cbs->on_error(receiver, receiver->cbs_userdata);
+    receiver->cbs->on_ended(receiver, error, receiver->cbs_userdata);
 
     return 0;
 }

app/src/receiver.h

@@ -25,7 +25,7 @@ struct sc_receiver {
 };
 
 struct sc_receiver_callbacks {
-    void (*on_error)(struct sc_receiver *receiver, void *userdata);
+    void (*on_ended)(struct sc_receiver *receiver, bool error, void *userdata);
 };
 
 bool

app/src/scrcpy.c

@@ -269,13 +269,18 @@ sc_audio_demuxer_on_ended(struct sc_demuxer *demuxer,
 }
 
 static void
-sc_controller_on_error(struct sc_controller *controller, void *userdata) {
+sc_controller_on_ended(struct sc_controller *controller, bool error,
+                       void *userdata) {
     // Note: this function may be called twice, once from the controller thread
     // and once from the receiver thread
     (void) controller;
     (void) userdata;
 
-    PUSH_EVENT(SC_EVENT_CONTROLLER_ERROR);
+    if (error) {
+        PUSH_EVENT(SC_EVENT_CONTROLLER_ERROR);
+    } else {
+        PUSH_EVENT(SC_EVENT_DEVICE_DISCONNECTED);
+    }
 }
 
 static void
@@ -567,7 +572,7 @@ scrcpy(struct scrcpy_options *options) {
 
     if (options->control) {
         static const struct sc_controller_callbacks controller_cbs = {
-            .on_error = sc_controller_on_error,
+            .on_ended = sc_controller_on_ended,
         };
 
         if (!sc_controller_init(&s->controller, s->server.control_socket,
@@ -730,23 +735,20 @@ scrcpy(struct scrcpy_options *options) {
             .start_fps_counter = options->start_fps_counter,
         };
 
-        struct sc_frame_source *src;
-        if (options->video_playback) {
-            src = &s->video_decoder.frame_source;
-            if (options->display_buffer) {
-                sc_delay_buffer_init(&s->display_buffer,
-                                     options->display_buffer, true);
-                sc_frame_source_add_sink(src, &s->display_buffer.frame_sink);
-                src = &s->display_buffer.frame_source;
-            }
-        }
-
         if (!sc_screen_init(&s->screen, &screen_params)) {
             goto end;
         }
         screen_initialized = true;
 
         if (options->video_playback) {
+            struct sc_frame_source *src = &s->video_decoder.frame_source;
+            if (options->display_buffer) {
+                sc_delay_buffer_init(&s->display_buffer,
+                                     options->display_buffer, true);
+                sc_frame_source_add_sink(src, &s->display_buffer.frame_sink);
+                src = &s->display_buffer.frame_source;
+            }
+
             sc_frame_source_add_sink(src, &s->screen.frame_sink);
         }
     }

doc/audio.md

@@ -42,7 +42,7 @@ scrcpy --no-window
 # interrupt with Ctrl+C
 ```
 
-Without video, the audio latency is typically not criticial, so it might be
+Without video, the audio latency is typically not critical, so it might be
 interesting to add [buffering](#buffering) to minimize glitches:
 
 ```

doc/build.md

@@ -94,7 +94,7 @@ This is the preferred method (and the way the release is built).
 From _Debian_, install _mingw_:
 
 ```bash
-sudo apt install mingw-w64 mingw-w64-tools
+sudo apt install mingw-w64 mingw-w64-tools libz-mingw-w64-dev
 ```
 
 You also need the JDK to build the server:
@@ -233,10 +233,10 @@ install` must be run as root)._
 
 #### Option 2: Use prebuilt server
 
- - [`scrcpy-server-v2.4`][direct-scrcpy-server]  
-   <sub>SHA-256: `93c272b7438605c055e127f7444064ed78fa9ca49f81156777fd201e79ce7ba3`</sub>
+ - [`scrcpy-server-v2.5`][direct-scrcpy-server]  
+   <sub>SHA-256: `1488b1105d6aff534873a26bf610cd2aea06ee867dd7a4d9c6bb2c091396eb15`</sub>
 
-[direct-scrcpy-server]: https://github.com/Genymobile/scrcpy/releases/download/v2.4/scrcpy-server-v2.4
+[direct-scrcpy-server]: https://github.com/Genymobile/scrcpy/releases/download/v2.5/scrcpy-server-v2.5
 
 Download the prebuilt server somewhere, and specify its path during the Meson
 configuration:

doc/linux.md

@@ -6,7 +6,7 @@
 
 Scrcpy is packaged in several distributions and package managers:
 
- - Debian/Ubuntu: `apt install scrcpy`
+ - Debian/Ubuntu: ~~`apt install scrcpy`~~ _(obsolete version)_
  - Arch Linux: `pacman -S scrcpy`
  - Fedora: `dnf copr enable zeno/scrcpy && dnf install scrcpy`
  - Gentoo: `emerge scrcpy`

doc/windows.md

@@ -4,24 +4,18 @@
 
 Download the [latest release]:
 
- - [`scrcpy-win64-v2.4.zip`][direct-win64] (64-bit)  
-   <sub>SHA-256: `9dc56f21bfa455352ec0c58b40feaf2fb02d67372910a4235e298ece286ff3a9`</sub>
- - [`scrcpy-win32-v2.4.zip`][direct-win32] (32-bit)  
-   <sub>SHA-256: `cf92acc45eef37c6ee2db819f92e420ced3bc50f1348dd57f7d6ca1fc80f6116`</sub>
+ - [`scrcpy-win64-v2.5.zip`][direct-win64] (64-bit)  
+   <sub>SHA-256: `345cf04a66a9144281dce72ca4e82adfd2c3092463196e586051df4c69e1507b`</sub>
+ - [`scrcpy-win32-v2.5.zip`][direct-win32] (32-bit)  
+   <sub>SHA-256: `d56312a92471565fa4f3a6b94e8eb07717c4c90f2c0f05b03ba444e1001806ec`</sub>
 
 [latest release]: https://github.com/Genymobile/scrcpy/releases/latest
-[direct-win64]: https://github.com/Genymobile/scrcpy/releases/download/v2.4/scrcpy-win64-v2.4.zip
-[direct-win32]: https://github.com/Genymobile/scrcpy/releases/download/v2.4/scrcpy-win32-v2.4.zip
+[direct-win64]: https://github.com/Genymobile/scrcpy/releases/download/v2.5/scrcpy-win64-v2.5.zip
+[direct-win32]: https://github.com/Genymobile/scrcpy/releases/download/v2.5/scrcpy-win32-v2.5.zip
 
 and extract it.
 
-Alternatively, you could install it from packages manager, like [Winget]:
-
-```bash
-winget install scrcpy
-```
-
-or [Chocolatey]:
+Alternatively, you could install it from packages manager, like [Chocolatey]:
 
 ```bash
 choco install scrcpy

install_release.sh

@@ -2,8 +2,8 @@
 set -e
 
 BUILDDIR=build-auto
-PREBUILT_SERVER_URL=https://github.com/Genymobile/scrcpy/releases/download/v2.4/scrcpy-server-v2.4
-PREBUILT_SERVER_SHA256=93c272b7438605c055e127f7444064ed78fa9ca49f81156777fd201e79ce7ba3
+PREBUILT_SERVER_URL=https://github.com/Genymobile/scrcpy/releases/download/v2.5/scrcpy-server-v2.5
+PREBUILT_SERVER_SHA256=1488b1105d6aff534873a26bf610cd2aea06ee867dd7a4d9c6bb2c091396eb15
 
 echo "[scrcpy] Downloading prebuilt server..."
 wget "$PREBUILT_SERVER_URL" -O scrcpy-server

meson.build

@@ -1,5 +1,5 @@
 project('scrcpy', 'c',
-        version: '2.4',
+        version: '2.5',
         meson_version: '>= 0.48',
         default_options: [
             'c_std=c11',

server/build.gradle

@@ -7,8 +7,8 @@ android {
         applicationId "com.genymobile.scrcpy"
         minSdkVersion 21
         targetSdkVersion 34
-        versionCode 20400
-        versionName "2.4"
+        versionCode 20500
+        versionName "2.5"
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
     }
     buildTypes {

server/build_without_gradle.sh

@@ -12,7 +12,7 @@
 set -e
 
 SCRCPY_DEBUG=false
-SCRCPY_VERSION_NAME=2.4
+SCRCPY_VERSION_NAME=2.5
 
 PLATFORM=${ANDROID_PLATFORM:-34}
 BUILD_TOOLS=${ANDROID_BUILD_TOOLS:-34.0.0}