wip

This avoids to pass each option as individual parameter and parse them
manually (it's still "manual" in the Parcelable implementation).

Refs #824 <https://github.com/Genymobile/scrcpy/pull/824#issuecomment-780319422>

Reviewed-by: Yu-Chen Lin <npes87184@gmail.com>

app/src/scrcpy.c

@@ -243,10 +243,6 @@ av_log_callback(void *avcl, int level, const char *fmt, va_list vl) {
 
 bool
 scrcpy(const struct scrcpy_options *options) {
-    if (!server_init(&server)) {
-        return false;
-    }
-
     bool ret = false;
 
     bool server_started = false;
@@ -263,6 +259,7 @@ scrcpy(const struct scrcpy_options *options) {
 
     bool record = !!options->record_filename;
     struct server_params params = {
+        .serial = options->serial,
         .log_level = options->log_level,
         .crop = options->crop,
         .port_range = options->port_range,
@@ -279,7 +276,12 @@ scrcpy(const struct scrcpy_options *options) {
         .force_adb_forward = options->force_adb_forward,
         .power_off_on_close = options->power_off_on_close,
     };
-    if (!server_start(&server, options->serial, &params)) {
+
+    if (!server_init(&server, &params)) {
+        return false;
+    }
+
+    if (!server_start(&server)) {
         goto end;
     }
 
@@ -311,7 +313,7 @@ scrcpy(const struct scrcpy_options *options) {
         fps_counter_initialized = true;
 
         if (options->control) {
-            if (!file_handler_init(&file_handler, server.serial,
+            if (!file_handler_init(&file_handler, options->serial,
                                    options->push_target)) {
                 goto end;
             }

app/src/server.c

@@ -128,9 +128,10 @@ disable_tunnel_forward(const char *serial, uint16_t local_port) {
 static bool
 disable_tunnel(struct server *server) {
     if (server->tunnel_forward) {
-        return disable_tunnel_forward(server->serial, server->local_port);
+        return disable_tunnel_forward(server->params.serial,
+                                      server->local_port);
     }
-    return disable_tunnel_reverse(server->serial);
+    return disable_tunnel_reverse(server->params.serial);
 }
 
 static socket_t
@@ -144,7 +145,7 @@ enable_tunnel_reverse_any_port(struct server *server,
                                struct sc_port_range port_range) {
     uint16_t port = port_range.first;
     for (;;) {
-        if (!enable_tunnel_reverse(server->serial, port)) {
+        if (!enable_tunnel_reverse(server->params.serial, port)) {
             // the command itself failed, it will fail on any port
             return false;
         }
@@ -163,7 +164,7 @@ enable_tunnel_reverse_any_port(struct server *server,
         }
 
         // failure, disable tunnel and try another port
-        if (!disable_tunnel_reverse(server->serial)) {
+        if (!disable_tunnel_reverse(server->params.serial)) {
             LOGW("Could not remove reverse tunnel on port %" PRIu16, port);
         }
 
@@ -191,7 +192,7 @@ enable_tunnel_forward_any_port(struct server *server,
     server->tunnel_forward = true;
     uint16_t port = port_range.first;
     for (;;) {
-        if (enable_tunnel_forward(server->serial, port)) {
+        if (enable_tunnel_forward(server->params.serial, port)) {
             // success
             server->local_port = port;
             return true;
@@ -306,7 +307,7 @@ execute_server(struct server *server, const struct server_params *params) {
     //     Port: 5005
     // Then click on "Debug"
 #endif
-    return adb_execute(server->serial, cmd, sizeof(cmd) / sizeof(cmd[0]));
+    return adb_execute(server->params.serial, cmd, ARRAY_LEN(cmd));
 }
 
 static socket_t
@@ -352,21 +353,75 @@ close_socket(socket_t socket) {
     }
 }
 
+static void
+server_params_destroy(struct server_params *params) {
+    // The server stores a copy of the params provided by the user
+    free((char *) params->crop);
+    free((char *) params->codec_options);
+    free((char *) params->encoder_name);
+}
+
+static bool
+server_params_copy(struct server_params *dst, const struct server_params *src) {
+    // params reference user-allocated memory, so we must copy them to handle
+    // them from a separate thread
+
+    *dst = *src;
+
+    dst->crop = NULL;
+    dst->codec_options = NULL;
+    dst->encoder_name = NULL;
+
+    if (src->crop) {
+        dst->crop = strdup(src->crop);
+        if (!dst->crop) {
+            goto error;
+        }
+    }
+
+    if (src->codec_options) {
+        dst->codec_options = strdup(src->codec_options);
+        if (!dst->codec_options) {
+            goto error;
+        }
+    }
+
+    if (src->encoder_name) {
+        dst->encoder_name = strdup(src->encoder_name);
+        if (!dst->encoder_name) {
+            goto error;
+        }
+    }
+
+    return true;
+
+error:
+    server_params_destroy(dst);
+    return false;
+};
+
+
 bool
-server_init(struct server *server) {
+server_init(struct server *server, const struct server_params *params) {
-    server->serial = NULL;
+    if (!server_params_copy(&server->params, params)) {
+        LOGE("Could not copy server params");
+        return false;
+    }
+
     server->process = PROCESS_NONE;
     atomic_flag_clear_explicit(&server->server_socket_closed,
                                memory_order_relaxed);
 
     bool ok = sc_mutex_init(&server->mutex);
     if (!ok) {
+        server_params_destroy(&server->params);
         return false;
     }
 
     ok = sc_cond_init(&server->process_terminated_cond);
     if (!ok) {
         sc_mutex_destroy(&server->mutex);
+        server_params_destroy(&server->params);
         return false;
     }
 
@@ -406,31 +461,41 @@ run_wait_server(void *data) {
     return 0;
 }
 
-bool
+static int
-server_start(struct server *server, const char *serial,
+run_server(void *data) {
-             const struct server_params *params) {
+    struct server *server = data;
-    if (serial) {
-        server->serial = strdup(serial);
-        if (!server->serial) {
-            return false;
-        }
-    }
 
-    if (!push_server(serial)) {
+    const struct server_params *params = &server->params;
-        goto error1;
+    const struct server_callbacks *cbs = &server->cbs;
+    void *userdata = server->userdata;
+
+    if (!push_server(params->serial)) {
+        cbs->on_connection_failed(server);
+        goto end;
     }
 
     if (!enable_tunnel_any_port(server, params->port_range,
                                 params->force_adb_forward)) {
-        goto error1;
+        cbs->on_connection_failed(server);
+        goto end;
     }
 
     // server will connect to our server socket
     server->process = execute_server(server, params);
     if (server->process == PROCESS_NONE) {
-        goto error2;
+        cbs->on_connection_failed(server);
+        goto end;
     }
 
+    process_wait(server->process, false); // ignore exit code
+
+end:
+    return 0;
+}
+
+bool
+server_start(struct server *server) {
+
     // If the server process dies before connecting to the server socket, then
     // the client will be stuck forever on accept(). To avoid the problem, we
     // must be able to wake up the accept() call when the server dies. To keep
@@ -442,14 +507,14 @@ server_start(struct server *server, const char *serial,
     if (!ok) {
         process_terminate(server->process);
         process_wait(server->process, true); // ignore exit code
-        goto error2;
+        goto error;
     }
 
     server->tunnel_enabled = true;
 
     return true;
 
-error2:
+error:
     if (!server->tunnel_forward) {
         bool was_closed =
             atomic_flag_test_and_set(&server->server_socket_closed);
@@ -459,8 +524,7 @@ error2:
         close_socket(server->server_socket);
     }
     disable_tunnel(server);
-error1:
+
-    free(server->serial);
     return false;
 }
 
@@ -558,4 +622,5 @@ server_destroy(struct server *server) {
     free(server->serial);
     sc_cond_destroy(&server->process_terminated_cond);
     sc_mutex_destroy(&server->mutex);
+    server_params_destroy(&server->params);
 }

app/src/server.h

@@ -13,6 +13,25 @@
 #include "util/net.h"
 #include "util/thread.h"
 
+struct server_params {
+    enum sc_log_level log_level;
+    const char *serial;
+    const char *crop;
+    const char *codec_options;
+    const char *encoder_name;
+    struct sc_port_range port_range;
+    uint16_t max_size;
+    uint32_t bit_rate;
+    uint16_t max_fps;
+    int8_t lock_video_orientation;
+    bool control;
+    uint32_t display_id;
+    bool show_touches;
+    bool stay_awake;
+    bool force_adb_forward;
+    bool power_off_on_close;
+};
+
 struct server {
     char *serial;
     process_t process;
@@ -29,34 +48,29 @@ struct server {
     uint16_t local_port; // selected from port_range
     bool tunnel_enabled;
     bool tunnel_forward; // use "adb forward" instead of "adb reverse"
+
+    // The internal allocated strings are copies owned by the server
+    struct server_params params;
+
+    const struct server_callbacks *cbs;
+    void *userdata;
 };
 
-struct server_params {
+struct server_callbacks {
-    enum sc_log_level log_level;
+    void (*on_connection_failed)(struct server *server);
-    const char *crop;
+    void (*on_connected)(struct server *server, const char *name,
-    const char *codec_options;
+                         struct size size, void *userdata);
-    const char *encoder_name;
+    void (*on_disconnected)(struct server *server, void *userdata);
-    struct sc_port_range port_range;
-    uint16_t max_size;
-    uint32_t bit_rate;
-    uint16_t max_fps;
-    int8_t lock_video_orientation;
-    bool control;
-    uint32_t display_id;
-    bool show_touches;
-    bool stay_awake;
-    bool force_adb_forward;
-    bool power_off_on_close;
 };
 
-// init default values
+// init server fields
 bool
-server_init(struct server *server);
+server_init(struct server *server, const struct server_params *params);
 
 // push, enable tunnel et start the server
 bool
-server_start(struct server *server, const char *serial,
+server_start(struct server *server, const struct server_callbacks *cbs,
-             const struct server_params *params);
+             void *userdata);
 
 // block until the communication with the server is established
 bool

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

@@ -3,6 +3,10 @@ package com.genymobile.scrcpy;
 import com.genymobile.scrcpy.wrappers.ContentProvider;
 import com.genymobile.scrcpy.wrappers.ServiceManager;
 
+import android.os.Parcel;
+import android.os.Parcelable;
+import android.util.Base64;
+
 import java.io.File;
 import java.io.IOException;
 
@@ -15,25 +19,123 @@ public final class CleanUp {
 
     public static final String SERVER_PATH = "/data/local/tmp/scrcpy-server.jar";
 
+    // A simple struct to be passed from the main process to the cleanup process
+    public static class Config implements Parcelable {
+
+        public static final Creator<Config> CREATOR = new Creator<Config>() {
+            @Override
+            public Config createFromParcel(Parcel in) {
+                return new Config(in);
+            }
+
+            @Override
+            public Config[] newArray(int size) {
+                return new Config[size];
+            }
+        };
+
+        private static final int FLAG_DISABLE_SHOW_TOUCHES = 1;
+        private static final int FLAG_RESTORE_NORMAL_POWER_MODE = 2;
+        private static final int FLAG_POWER_OFF_SCREEN = 4;
+
+        private int displayId;
+
+        // Restore the value (between 0 and 7), -1 to not restore
+        // <https://developer.android.com/reference/android/provider/Settings.Global#STAY_ON_WHILE_PLUGGED_IN>
+        private int restoreStayOn = -1;
+
+        private boolean disableShowTouches;
+        private boolean restoreNormalPowerMode;
+        private boolean powerOffScreen;
+
+        public Config() {
+            // Default constructor, the fields are initialized by CleanUp.configure()
+        }
+
+        protected Config(Parcel in) {
+            displayId = in.readInt();
+            restoreStayOn = in.readInt();
+            byte options = in.readByte();
+            disableShowTouches = (options & FLAG_DISABLE_SHOW_TOUCHES) != 0;
+            restoreNormalPowerMode = (options & FLAG_RESTORE_NORMAL_POWER_MODE) != 0;
+            powerOffScreen = (options & FLAG_POWER_OFF_SCREEN) != 0;
+        }
+
+        @Override
+        public void writeToParcel(Parcel dest, int flags) {
+            dest.writeInt(displayId);
+            dest.writeInt(restoreStayOn);
+            byte options = 0;
+            if (disableShowTouches) {
+                options |= FLAG_DISABLE_SHOW_TOUCHES;
+            }
+            if (restoreNormalPowerMode) {
+                options |= FLAG_RESTORE_NORMAL_POWER_MODE;
+            }
+            if (powerOffScreen) {
+                options |= FLAG_POWER_OFF_SCREEN;
+            }
+            dest.writeByte(options);
+        }
+
+        private boolean hasWork() {
+            return disableShowTouches || restoreStayOn != -1 || restoreNormalPowerMode || powerOffScreen;
+        }
+
+        @Override
+        public int describeContents() {
+            return 0;
+        }
+
+        byte[] serialize() {
+            Parcel parcel = Parcel.obtain();
+            writeToParcel(parcel, 0);
+            byte[] bytes = parcel.marshall();
+            parcel.recycle();
+            return bytes;
+        }
+
+        static Config deserialize(byte[] bytes) {
+            Parcel parcel = Parcel.obtain();
+            parcel.unmarshall(bytes, 0, bytes.length);
+            parcel.setDataPosition(0);
+            return CREATOR.createFromParcel(parcel);
+        }
+
+        static Config fromBase64(String base64) {
+            byte[] bytes = Base64.decode(base64, Base64.NO_WRAP);
+            return deserialize(bytes);
+        }
+
+        String toBase64() {
+            byte[] bytes = serialize();
+            return Base64.encodeToString(bytes, Base64.NO_WRAP);
+        }
+    }
+
     private CleanUp() {
         // not instantiable
     }
 
-    public static void configure(boolean disableShowTouches, int restoreStayOn, boolean restoreNormalPowerMode, boolean powerOffScreen, int displayId)
+    public static void configure(int displayId, int restoreStayOn, boolean disableShowTouches, boolean restoreNormalPowerMode, boolean powerOffScreen)
             throws IOException {
-        boolean needProcess = disableShowTouches || restoreStayOn != -1 || restoreNormalPowerMode || powerOffScreen;
+        Config config = new Config();
-        if (needProcess) {
+        config.displayId = displayId;
-            startProcess(disableShowTouches, restoreStayOn, restoreNormalPowerMode, powerOffScreen, displayId);
+        config.disableShowTouches = disableShowTouches;
+        config.restoreStayOn = restoreStayOn;
+        config.restoreNormalPowerMode = restoreNormalPowerMode;
+        config.powerOffScreen = powerOffScreen;
+
+        if (config.hasWork()) {
+            startProcess(config);
         } else {
             // There is no additional clean up to do when scrcpy dies
             unlinkSelf();
         }
     }
 
-    private static void startProcess(boolean disableShowTouches, int restoreStayOn, boolean restoreNormalPowerMode, boolean powerOffScreen,
+    private static void startProcess(Config config) throws IOException {
-            int displayId) throws IOException {
+        String[] cmd = {"app_process", "/", CleanUp.class.getName(), config.toBase64()};
-        String[] cmd = {"app_process", "/", CleanUp.class.getName(), String.valueOf(disableShowTouches), String.valueOf(
-                restoreStayOn), String.valueOf(restoreNormalPowerMode), String.valueOf(powerOffScreen), String.valueOf(displayId)};
 
         ProcessBuilder builder = new ProcessBuilder(cmd);
         builder.environment().put("CLASSPATH", SERVER_PATH);
@@ -60,31 +162,27 @@ public final class CleanUp {
 
         Ln.i("Cleaning up");
 
-        boolean disableShowTouches = Boolean.parseBoolean(args[0]);
+        Config config = Config.fromBase64(args[0]);
-        int restoreStayOn = Integer.parseInt(args[1]);
-        boolean restoreNormalPowerMode = Boolean.parseBoolean(args[2]);
-        boolean powerOffScreen = Boolean.parseBoolean(args[3]);
-        int displayId = Integer.parseInt(args[4]);
 
-        if (disableShowTouches || restoreStayOn != -1) {
+        if (config.disableShowTouches || config.restoreStayOn != -1) {
             ServiceManager serviceManager = new ServiceManager();
             try (ContentProvider settings = serviceManager.getActivityManager().createSettingsProvider()) {
-                if (disableShowTouches) {
+                if (config.disableShowTouches) {
                     Ln.i("Disabling \"show touches\"");
                     settings.putValue(ContentProvider.TABLE_SYSTEM, "show_touches", "0");
                 }
-                if (restoreStayOn != -1) {
+                if (config.restoreStayOn != -1) {
                     Ln.i("Restoring \"stay awake\"");
-                    settings.putValue(ContentProvider.TABLE_GLOBAL, "stay_on_while_plugged_in", String.valueOf(restoreStayOn));
+                    settings.putValue(ContentProvider.TABLE_GLOBAL, "stay_on_while_plugged_in", String.valueOf(config.restoreStayOn));
                 }
             }
         }
 
         if (Device.isScreenOn()) {
-            if (powerOffScreen) {
+            if (config.powerOffScreen) {
                 Ln.i("Power off screen");
-                Device.powerOffScreen(displayId);
+                Device.powerOffScreen(config.displayId);
-            } else if (restoreNormalPowerMode) {
+            } else if (config.restoreNormalPowerMode) {
                 Ln.i("Restoring normal power mode");
                 Device.setScreenPowerMode(Device.POWER_MODE_NORMAL);
             }

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

@@ -50,7 +50,7 @@ public final class Server {
             }
         }
 
-        CleanUp.configure(mustDisableShowTouchesOnCleanUp, restoreStayOn, true, options.getPowerOffScreenOnClose(), options.getDisplayId());
+        CleanUp.configure(options.getDisplayId(), restoreStayOn, mustDisableShowTouchesOnCleanUp, true, options.getPowerOffScreenOnClose());
 
         boolean tunnelForward = options.isTunnelForward();