Extract device connection to a separate doc page

Create a new "Connection" documentation page.

README.md

@@ -5,7 +5,7 @@
 _pronounced "**scr**een **c**o**py**"_
 
 This application mirrors Android devices (video and audio) connected via
-USB or [over TCP/IP](doc/connection.md#tcpip-wireless), and allows to control the
+USB or [over TCP/IP](doc/device.md#tcpip-wireless), and allows to control the
 device with the keyboard and the mouse of the computer. It does not require any
 _root_ access. It works on _Linux_, _Windows_ and _macOS_.
 

app/data/bash-completion/scrcpy

@@ -44,8 +44,6 @@ _scrcpy() {
         --no-video-playback
         --otg
         -p --port=
-        --pause-on-exit
-        --pause-on-exit=
         --power-off-on-close
         --prefer-text
         --print-fps
@@ -99,10 +97,6 @@ _scrcpy() {
             COMPREPLY=($(compgen -W 'unlocked initial 0 1 2 3' -- "$cur"))
             return
             ;;
-        --pause-on-exit)
-            COMPREPLY=($(compgen -W 'true false if-error' -- "$cur"))
-            return
-            ;;
         -r|--record)
             COMPREPLY=($(compgen -f -- "$cur"))
             return

app/data/scrcpy-console.bat

@@ -1,2 +1,4 @@
 @echo off
-scrcpy.exe --pause-on-exit=if-error %*
+scrcpy.exe %*
+:: if the exit code is >= 1, then pause
+if errorlevel 1 pause

app/data/scrcpy-console.desktop

@@ -5,7 +5,7 @@ Comment=Display and control your Android device
 # For some users, the PATH or ADB environment variables are set from the shell
 # startup file, like .bashrc or .zshrc… Run an interactive shell to get
 # environment correctly initialized.
-Exec=/bin/sh -c "\"\\$SHELL\" -i -c scrcpy --pause-on-exit=if-error"
+Exec=/bin/bash --norc --noprofile -i -c "\"\\$SHELL\" -i -c scrcpy || read -p 'Press Enter to quit...'"
 Icon=scrcpy
 Terminal=true
 Type=Application

app/data/zsh-completion/_scrcpy

@@ -50,7 +50,6 @@ arguments=(
     '--no-video-playback[Disable video playback]'
     '--otg[Run in OTG mode \(simulating physical keyboard and mouse\)]'
     {-p,--port=}'[\[port\[\:port\]\] Set the TCP port \(range\) used by the client to listen]'
-    '--pause-on-exit=[Make scrcpy pause before exiting]:mode:(true false if-error)'
     '--power-off-on-close[Turn the device screen off when closing scrcpy]'
     '--prefer-text[Inject alpha characters and space as text events instead of key events]'
     '--print-fps[Start FPS counter, to print frame logs to the console]'

app/scrcpy.1

@@ -267,16 +267,6 @@ Set the TCP port (range) used by the client to listen.
 
 Default is 27183:27199.
 
-.TP
-\fB\-\-pause\-on\-exit\fR[=\fImode\fR]
-Configure pause on exit. Possible values are "true" (always pause on exit), "false" (never pause on exit) and "if-error" (pause only if an error occured).
-
-This is useful to prevent the terminal window from automatically closing, so that error messages can be read.
-
-Default is "false".
-
-Passing the option without argument is equivalent to passing "true".
-
 .TP
 .B \-\-power\-off\-on\-close
 Turn the device screen off when closing scrcpy.

app/src/cli.c

@@ -79,7 +79,6 @@ enum {
     OPT_AUDIO_SOURCE,
     OPT_KILL_ADB_ON_CLOSE,
     OPT_TIME_LIMIT,
-    OPT_PAUSE_ON_EXIT,
 };
 
 struct sc_option {
@@ -464,20 +463,6 @@ static const struct sc_option options[] = {
                 "Default is " STR(DEFAULT_LOCAL_PORT_RANGE_FIRST) ":"
                               STR(DEFAULT_LOCAL_PORT_RANGE_LAST) ".",
     },
-    {
-        .longopt_id = OPT_PAUSE_ON_EXIT,
-        .longopt = "pause-on-exit",
-        .argdesc = "mode",
-        .optional_arg = true,
-        .text = "Configure pause on exit. Possible values are \"true\" (always "
-                "pause on exit), \"false\" (never pause on exit) and "
-                "\"if-error\" (pause only if an error occured).\n"
-                "This is useful to prevent the terminal window from "
-                "automatically closing, so that error messages can be read.\n"
-                "Default is \"false\".\n"
-                "Passing the option without argument is equivalent to passing "
-                "\"true\".",
-    },
     {
         .longopt_id = OPT_POWER_OFF_ON_CLOSE,
         .longopt = "power-off-on-close",
@@ -1652,29 +1637,6 @@ parse_time_limit(const char *s, sc_tick *tick) {
     return true;
 }
 
-static bool
-parse_pause_on_exit(const char *s, enum sc_pause_on_exit *pause_on_exit) {
-    if (!s || !strcmp(s, "true")) {
-        *pause_on_exit = SC_PAUSE_ON_EXIT_TRUE;
-        return true;
-    }
-
-    if (!strcmp(s, "false")) {
-        *pause_on_exit = SC_PAUSE_ON_EXIT_FALSE;
-        return true;
-    }
-
-    if (!strcmp(s, "if-error")) {
-        *pause_on_exit = SC_PAUSE_ON_EXIT_IF_ERROR;
-        return true;
-    }
-
-    LOGE("Unsupported pause on exit mode: %s "
-         "(expected true, false or if-error)", optarg);
-    return false;
-
-}
-
 static bool
 parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
                        const char *optstring, const struct option *longopts) {
@@ -2015,11 +1977,6 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
                     return false;
                 }
                 break;
-            case OPT_PAUSE_ON_EXIT:
-                if (!parse_pause_on_exit(optarg, &args->pause_on_exit)) {
-                    return false;
-                }
-                break;
             default:
                 // getopt prints the error message on stderr
                 return false;
@@ -2065,6 +2022,12 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
         opts->audio_playback = false;
     }
 
+    if (!opts->video_playback && !otg) {
+        // If video playback is disabled and OTG are disabled, then there is
+        // no way to control the device.
+        opts->control = false;
+    }
+
     if (opts->video && !opts->video_playback && !opts->record_filename
             && !v4l2) {
         LOGI("No video playback, no recording, no V4L2 sink: video disabled");
@@ -2233,37 +2196,6 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
     return true;
 }
 
-static enum sc_pause_on_exit
-sc_get_pause_on_exit(int argc, char *argv[]) {
-    // Read arguments backwards so that the last --pause-on-exit is considered
-    // (same behavior as getopt())
-    for (int i = argc - 1; i >= 1; --i) {
-        const char *arg = argv[i];
-        // Starts with "--pause-on-exit"
-        if (!strncmp("--pause-on-exit", arg, 15)) {
-            if (arg[15] == '\0') {
-                // No argument
-                return SC_PAUSE_ON_EXIT_TRUE;
-            }
-            if (arg[15] != '=') {
-                // Invalid parameter, ignore
-                return SC_PAUSE_ON_EXIT_FALSE;
-            }
-            const char *value = &arg[16];
-            if (!strcmp(value, "true")) {
-                return SC_PAUSE_ON_EXIT_TRUE;
-            }
-            if (!strcmp(value, "if-error")) {
-                return SC_PAUSE_ON_EXIT_IF_ERROR;
-            }
-            // Set to false, inclusing when the value is invalid
-            return SC_PAUSE_ON_EXIT_FALSE;
-        }
-    }
-
-    return false;
-}
-
 bool
 scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
     struct sc_getopt_adapter adapter;
@@ -2277,11 +2209,5 @@ scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
 
     sc_getopt_adapter_destroy(&adapter);
 
-    if (!ret && args->pause_on_exit == SC_PAUSE_ON_EXIT_FALSE) {
-        // Check if "--pause-on-exit" is present in the arguments list, because
-        // it must be taken into account even if command line parsing failed
-        args->pause_on_exit = sc_get_pause_on_exit(argc, argv);
-    }
-
     return ret;
 }

app/src/cli.h

@@ -7,17 +7,10 @@
 
 #include "options.h"
 
-enum sc_pause_on_exit {
-    SC_PAUSE_ON_EXIT_TRUE,
-    SC_PAUSE_ON_EXIT_FALSE,
-    SC_PAUSE_ON_EXIT_IF_ERROR,
-};
-
 struct scrcpy_cli_args {
     struct scrcpy_options opts;
     bool help;
     bool version;
-    enum sc_pause_on_exit pause_on_exit;
 };
 
 void

app/src/display.c

@@ -53,7 +53,7 @@ sc_display_init(struct sc_display *display, SDL_Window *window, bool mipmaps) {
                 display->mipmaps = true;
             } else {
                 LOGW("Trilinear filtering disabled "
-                     "(OpenGL 3.0+ or ES 2.0+ required)");
+                     "(OpenGL 3.0+ or ES 2.0+ required");
             }
         } else {
             LOGI("Trilinear filtering disabled");

app/src/main.c

@@ -39,32 +39,26 @@ main_scrcpy(int argc, char *argv[]) {
         .opts = scrcpy_options_default,
         .help = false,
         .version = false,
-        .pause_on_exit = SC_PAUSE_ON_EXIT_FALSE,
     };
 
 #ifndef NDEBUG
     args.opts.log_level = SC_LOG_LEVEL_DEBUG;
 #endif
 
-    enum scrcpy_exit_code ret;
-
     if (!scrcpy_parse_args(&args, argc, argv)) {
-        ret = SCRCPY_EXIT_FAILURE;
+        return SCRCPY_EXIT_FAILURE;
-        goto end;
     }
 
     sc_set_log_level(args.opts.log_level);
 
     if (args.help) {
         scrcpy_print_usage(argv[0]);
-        ret = SCRCPY_EXIT_SUCCESS;
+        return SCRCPY_EXIT_SUCCESS;
-        goto end;
     }
 
     if (args.version) {
         scrcpy_print_version();
-        ret = SCRCPY_EXIT_SUCCESS;
+        return SCRCPY_EXIT_SUCCESS;
-        goto end;
     }
 
 #ifdef SCRCPY_LAVF_REQUIRES_REGISTER_ALL
@@ -78,26 +72,18 @@ main_scrcpy(int argc, char *argv[]) {
 #endif
 
     if (!net_init()) {
-        ret = SCRCPY_EXIT_FAILURE;
+        return SCRCPY_EXIT_FAILURE;
-        goto end;
     }
 
     sc_log_configure();
 
 #ifdef HAVE_USB
-    ret = args.opts.otg ? scrcpy_otg(&args.opts) : scrcpy(&args.opts);
+    enum scrcpy_exit_code ret = args.opts.otg ? scrcpy_otg(&args.opts)
+                                              : scrcpy(&args.opts);
 #else
-    ret = scrcpy(&args.opts);
+    enum scrcpy_exit_code ret = scrcpy(&args.opts);
 #endif
 
-end:
-    if (args.pause_on_exit == SC_PAUSE_ON_EXIT_TRUE ||
-            (args.pause_on_exit == SC_PAUSE_ON_EXIT_IF_ERROR &&
-                ret != SCRCPY_EXIT_SUCCESS)) {
-        printf("Press Enter to continue...\n");
-        getchar();
-    }
-
     return ret;
 }
 

app/src/scrcpy.c

@@ -252,9 +252,7 @@ sc_audio_demuxer_on_ended(struct sc_demuxer *demuxer,
 
     // Contrary to the video demuxer, keep mirroring if only the audio fails
     // (unless --require-audio is set).
-    if (status == SC_DEMUXER_STATUS_EOS) {
+    if (status == SC_DEMUXER_STATUS_ERROR
-        PUSH_EVENT(SC_EVENT_DEVICE_DISCONNECTED);
-    } else if (status == SC_DEMUXER_STATUS_ERROR
             || (status == SC_DEMUXER_STATUS_DISABLED
                 && options->require_audio)) {
         PUSH_EVENT(SC_EVENT_DEMUXER_ERROR);
@@ -450,7 +448,9 @@ scrcpy(struct scrcpy_options *options) {
 
     struct sc_file_pusher *fp = NULL;
 
-    if (options->video_playback && options->control) {
+    // control implies video playback
+    assert(!options->control || options->video_playback);
+    if (options->control) {
         if (!sc_file_pusher_init(&s->file_pusher, serial,
                                  options->push_target)) {
             goto end;

doc/audio.md

@@ -77,13 +77,6 @@ In particular, if you get the following error:
 
 then your device has no Opus encoder: try `scrcpy --audio-codec=aac`.
 
-For advanced usage, to pass arbitrary parameters to the [`MediaFormat`],
-check `--audio-codec-options` in the manpage or in `scrcpy --help`.
-
-[`MediaFormat`]: https://developer.android.com/reference/android/media/MediaFormat
-
-
-## Encoder
 
 Several encoders may be available on the device. They can be listed by:
 
@@ -93,10 +86,15 @@ scrcpy --list-encoders
 
 To select a specific encoder:
 
-```bash
+```
 scrcpy --audio-codec=opus --audio-encoder='c2.android.opus.encoder'
 ```
 
+For advanced usage, to pass arbitrary parameters to the [`MediaFormat`],
+check `--audio-codec-options` in the manpage or in `scrcpy --help`.
+
+[`MediaFormat`]: https://developer.android.com/reference/android/media/MediaFormat
+
 
 ## Bit rate
 

doc/device.md

@@ -1,7 +1,23 @@
 # Device
 
-Some command line arguments perform actions on the device itself while scrcpy is
+## Display
-running.
+
+If several displays are available on the Android device, it is possible to
+select the display to mirror:
+
+```bash
+scrcpy --display=1
+```
+
+The list of display ids can be retrieved by:
+
+```bash
+scrcpy --list-displays
+```
+
+A secondary display may only be controlled if the device runs at least Android
+10 (otherwise it is mirrored as read-only).
+
 
 ## Stay awake
 
@@ -78,3 +94,4 @@ By default, on start, the device is powered on. To prevent this behavior:
 ```bash
 scrcpy --no-power-on
 ```
+

doc/video.md

@@ -66,14 +66,6 @@ scrcpy --video-codec=av1
 H265 may provide better quality, but H264 should provide lower latency.
 AV1 encoders are not common on current Android devices.
 
-For advanced usage, to pass arbitrary parameters to the [`MediaFormat`],
-check `--video-codec-options` in the manpage or in `scrcpy --help`.
-
-[`MediaFormat`]: https://developer.android.com/reference/android/media/MediaFormat
-
-
-## Encoder
-
 Several encoders may be available on the device. They can be listed by:
 
 ```bash
@@ -87,6 +79,11 @@ try another one:
 scrcpy --video-codec=h264 --video-encoder='OMX.qcom.video.encoder.avc'
 ```
 
+For advanced usage, to pass arbitrary parameters to the [`MediaFormat`],
+check `--video-codec-options` in the manpage or in `scrcpy --help`.
+
+[`MediaFormat`]: https://developer.android.com/reference/android/media/MediaFormat
+
 
 ## Rotation
 
@@ -137,25 +134,6 @@ phone, landscape for a tablet).
 If `--max-size` is also specified, resizing is applied after cropping.
 
 
-## Display
-
-If several displays are available on the Android device, it is possible to
-select the display to mirror:
-
-```bash
-scrcpy --display=1
-```
-
-The list of display ids can be retrieved by:
-
-```bash
-scrcpy --list-displays
-```
-
-A secondary display may only be controlled if the device runs at least Android
-10 (otherwise it is mirrored as read-only).
-
-
 ## Buffering
 
 By default, there is no video buffering, to get the lowest possible latency.

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

@@ -154,7 +154,7 @@ public final class Workarounds {
         }
     }
 
-    private static void fillBaseContext() {
+    public static void fillBaseContext() {
         try {
             fillActivityThread();
 

server/src/main/java/com/genymobile/scrcpy/wrappers/ActivityManager.java

@@ -17,7 +17,7 @@ import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 
 @SuppressLint("PrivateApi,DiscouragedPrivateApi")
-public final class ActivityManager {
+public class ActivityManager {
 
     private final IInterface manager;
     private Method getContentProviderExternalMethod;

server/src/main/java/com/genymobile/scrcpy/wrappers/ClipboardManager.java

@@ -11,7 +11,7 @@ import android.os.IInterface;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 
-public final class ClipboardManager {
+public class ClipboardManager {
     private final IInterface manager;
     private Method getPrimaryClipMethod;
     private Method setPrimaryClipMethod;

server/src/main/java/com/genymobile/scrcpy/wrappers/ContentProvider.java

@@ -14,7 +14,7 @@ import java.io.Closeable;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 
-public final class ContentProvider implements Closeable {
+public class ContentProvider implements Closeable {
 
     public static final String TABLE_SYSTEM = "system";
     public static final String TABLE_SECURE = "secure";

server/src/main/java/com/genymobile/scrcpy/wrappers/StatusBarManager.java

@@ -7,7 +7,7 @@ import android.os.IInterface;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 
-public final class StatusBarManager {
+public class StatusBarManager {
 
     private final IInterface manager;
     private Method expandNotificationsPanelMethod;