Document --no-{video,audio}-playback

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

app/data/bash-completion/scrcpy

@@ -29,15 +29,17 @@ _scrcpy() {
         -M --hid-mouse
         -m --max-size=
         --no-audio
+        --no-audio-playback
         --no-cleanup
         --no-clipboard-autosync
         --no-downsize-on-error
         -n --no-control
-        -N --no-mirror
+        -N --no-playback
         --no-key-repeat
         --no-mipmaps
         --no-power-on
         --no-video
+        --no-video-playback
         --otg
         -p --port=
         --power-off-on-close

app/data/zsh-completion/_scrcpy

@@ -35,15 +35,17 @@ arguments=(
     {-M,--hid-mouse}'[Simulate a physical mouse by using HID over AOAv2]'
     {-m,--max-size=}'[Limit both the width and height of the video to value]'
     '--no-audio[Disable audio forwarding]'
+    '--no-audio-playback[Disable audio playback]'
     '--no-cleanup[Disable device cleanup actions on exit]'
     '--no-clipboard-autosync[Disable automatic clipboard synchronization]'
     '--no-downsize-on-error[Disable lowering definition on MediaCodec error]'
     {-n,--no-control}'[Disable device control \(mirror the device in read only\)]'
-    {-N,--no-mirror}'[Do not mirror device \(only when recording or V4L2 sink is enabled\)]'
+    {-N,--no-playback}'[Disable video and audio playback]'
     '--no-key-repeat[Do not forward repeated key events when a key is held down]'
     '--no-mipmaps[Disable the generation of mipmaps]'
     '--no-power-on[Do not power on the device on start]'
     '--no-video[Disable video forwarding]'
+    '--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]'
     '--power-off-on-close[Turn the device screen off when closing scrcpy]'

app/scrcpy.1

@@ -187,6 +187,10 @@ Also see \fB\-\-hid\-keyboard\fR.
 .B \-\-no\-audio
 Disable audio forwarding.
 
+.TP
+.B \-\-no\-audio\-playback
+Disable audio playback on the computer.
+
 .TP
 .B \-\-no\-cleanup
 By default, scrcpy removes the server binary from the device and restores the device state (show touches, stay awake and power mode) on exit.
@@ -210,8 +214,8 @@ This option disables this behavior.
 Disable device control (mirror the device in read\-only).
 
 .TP
-.B \-N, \-\-no\-mirror
-Do not mirror device video or audio on the computer (only when recording or V4L2 sink is enabled).
+.B \-N, \-\-no\-playback
+Disable video and audio playback on the computer (equivalent to --no-video-playback --no-audio-playback).
 
 .TP
 .B \-\-no\-key\-repeat
@@ -229,6 +233,10 @@ Do not power on the device on start.
 .B \-\-no\-video
 Disable video forwarding.
 
+.TP
+.B \-\-no\-video\-playback
+Disable video playback on the computer.
+
 .TP
 .B \-\-otg
 Run in OTG mode: simulate physical keyboard and mouse, as if the computer keyboard and mouse were plugged directly to the device via an OTG cable.

app/src/cli.c

@@ -74,6 +74,8 @@ enum {
     OPT_AUDIO_OUTPUT_BUFFER,
     OPT_NO_DISPLAY,
     OPT_NO_VIDEO,
+    OPT_NO_AUDIO_PLAYBACK,
+    OPT_NO_VIDEO_PLAYBACK,
 };
 
 struct sc_option {
@@ -351,6 +353,11 @@ static const struct sc_option options[] = {
         .longopt = "no-audio",
         .text = "Disable audio forwarding.",
     },
+    {
+        .longopt_id = OPT_NO_AUDIO_PLAYBACK,
+        .longopt = "no-audio-playback",
+        .text = "Disable audio playback on the computer.",
+    },
     {
         .longopt_id = OPT_NO_CLEANUP,
         .longopt = "no-cleanup",
@@ -382,9 +389,9 @@ static const struct sc_option options[] = {
     },
     {
         .shortopt = 'N',
-        .longopt = "no-mirror",
-        .text = "Do not mirror device video or audio on the computer (only "
-                "when recording or V4L2 sink is enabled).",
+        .longopt = "no-playback",
+        .text = "Disable video and audio playback on the computer (equivalent "
+                "to --no-video-playback --no-audio-playback).",
     },
     {
         // deprecated
@@ -413,6 +420,11 @@ static const struct sc_option options[] = {
         .longopt = "no-video",
         .text = "Disable video forwarding.",
     },
+    {
+        .longopt_id = OPT_NO_VIDEO_PLAYBACK,
+        .longopt = "no-video-playback",
+        .text = "Disable video playback on the computer.",
+    },
     {
         .longopt_id = OPT_OTG,
         .longopt = "otg",
@@ -1671,10 +1683,17 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
                 opts->control = false;
                 break;
             case OPT_NO_DISPLAY:
-                LOGW("--no-display is deprecated, use --no-mirror instead.");
+                LOGW("--no-display is deprecated, use --no-playback instead.");
                 // fall through
             case 'N':
-                opts->mirror = false;
+                opts->video_playback = false;
+                opts->audio_playback = false;
+                break;
+            case OPT_NO_VIDEO_PLAYBACK:
+                opts->video_playback = false;
+                break;
+            case OPT_NO_AUDIO_PLAYBACK:
+                opts->audio_playback = false;
                 break;
             case 'p':
                 if (!parse_port_range(optarg, &opts->port_range)) {
@@ -1872,7 +1891,8 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
                 }
                 break;
 #else
-                LOGE("V4L2 (--v4l2-buffer) is only available on Linux.");
+                LOGE("V4L2 (--v4l2-buffer) is disabled (or unsupported on this "
+                     "platform).");
                 return false;
 #endif
             case OPT_LIST_ENCODERS:
@@ -1923,14 +1943,52 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
         return false;
     }
 
+    bool otg = false;
+    bool v4l2 = false;
+#ifdef HAVE_USB
+    otg = opts->otg;
+#endif
 #ifdef HAVE_V4L2
-    if (!opts->mirror && !opts->record_filename && !opts->v4l2_device) {
-        LOGE("-N/--no-mirror requires either screen recording (-r/--record)"
-             " or sink to v4l2loopback device (--v4l2-sink)");
+    v4l2 = !!opts->v4l2_device;
+#endif
+
+    if (!opts->video) {
+        opts->video_playback = false;
+    }
+
+    if (!opts->audio) {
+        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");
+        opts->video = false;
+    }
+
+    if (opts->audio && !opts->audio_playback && !opts->record_filename) {
+        LOGI("No audio playback, no recording: audio disabled");
+        opts->audio = false;
+    }
+
+    if (!opts->video && !opts->audio && !otg) {
+        LOGE("No video, no audio, no OTG: nothing to do");
         return false;
     }
 
-    if (opts->v4l2_device) {
+    if (!opts->video && !otg) {
+        // If video is disabled, then scrcpy must exit on audio failure.
+        opts->require_audio = true;
+    }
+
+#ifdef HAVE_V4L2
+    if (v4l2) {
         if (opts->lock_video_orientation ==
                 SC_LOCK_VIDEO_ORIENTATION_UNLOCKED) {
             LOGI("Video orientation is locked for v4l2 sink. "
@@ -1948,18 +2006,8 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
         LOGE("V4L2 buffer value without V4L2 sink\n");
         return false;
     }
-#else
-    if (!opts->mirror && !opts->record_filename) {
-        LOGE("-N/--no-mirror requires screen recording (-r/--record)");
-        return false;
-    }
 #endif
 
-    if (opts->audio && !opts->mirror && !opts->record_filename) {
-        LOGI("No mirror and no recording: audio disabled");
-        opts->audio = false;
-    }
-
     if ((opts->tunnel_host || opts->tunnel_port) && !opts->force_adb_forward) {
         LOGI("Tunnel host/port is set, "
              "--force-adb-forward automatically enabled.");
@@ -2039,11 +2087,9 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
         }
     }
 
-#ifdef HAVE_USB
-
 # ifdef _WIN32
-    if (!opts->otg && (opts->keyboard_input_mode == SC_KEYBOARD_INPUT_MODE_HID
-                    || opts->mouse_input_mode == SC_MOUSE_INPUT_MODE_HID)) {
+    if (!otg && (opts->keyboard_input_mode == SC_KEYBOARD_INPUT_MODE_HID
+                || opts->mouse_input_mode == SC_MOUSE_INPUT_MODE_HID)) {
         LOGE("On Windows, it is not possible to open a USB device already open "
              "by another process (like adb).");
         LOGE("Therefore, -K/--hid-keyboard and -M/--hid-mouse may only work in "
@@ -2052,7 +2098,7 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
     }
 # endif
 
-    if (opts->otg) {
+    if (otg) {
         // OTG mode is compatible with only very few options.
         // Only report obvious errors.
         if (opts->record_filename) {
@@ -2079,28 +2125,10 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
             LOGE("OTG mode: could not select display");
             return false;
         }
-# ifdef HAVE_V4L2
-        if (opts->v4l2_device) {
+        if (v4l2) {
             LOGE("OTG mode: could not sink to V4L2 device");
             return false;
         }
-# endif
-    }
-#endif
-
-#ifdef HAVE_USB
-    if (!(opts->mirror && opts->video) && !opts->otg) {
-#else
-    if (!(opts->mirror && opts->video)) {
-#endif
-        // If video mirroring is disabled and OTG are disabled, then there is
-        // no way to control the device.
-        opts->control = false;
-    }
-
-    if (!opts->video) {
-        // If video is disabled, then scrcpy must exit on audio failure.
-        opts->require_audio = true;
     }
 
     return true;

app/src/options.c

@@ -11,9 +11,6 @@ const struct scrcpy_options scrcpy_options_default = {
     .audio_codec_options = NULL,
     .video_encoder = NULL,
     .audio_encoder = NULL,
-#ifdef HAVE_V4L2
-    .v4l2_device = NULL,
-#endif
     .log_level = SC_LOG_LEVEL_INFO,
     .video_codec = SC_CODEC_H264,
     .audio_codec = SC_CODEC_OPUS,
@@ -42,9 +39,12 @@ const struct scrcpy_options scrcpy_options_default = {
     .window_height = 0,
     .display_id = 0,
     .display_buffer = 0,
-    .v4l2_buffer = 0,
     .audio_buffer = SC_TICK_FROM_MS(50),
     .audio_output_buffer = SC_TICK_FROM_MS(5),
+#ifdef HAVE_V4L2
+    .v4l2_device = NULL,
+    .v4l2_buffer = 0,
+#endif
 #ifdef HAVE_USB
     .otg = false,
 #endif
@@ -52,7 +52,8 @@ const struct scrcpy_options scrcpy_options_default = {
     .fullscreen = false,
     .always_on_top = false,
     .control = true,
-    .mirror = true,
+    .video_playback = true,
+    .audio_playback = true,
     .turn_screen_off = false,
     .key_inject_mode = SC_KEY_INJECT_MODE_MIXED,
     .window_borderless = false,

app/src/options.h

@@ -112,9 +112,6 @@ struct scrcpy_options {
     const char *audio_codec_options;
     const char *video_encoder;
     const char *audio_encoder;
-#ifdef HAVE_V4L2
-    const char *v4l2_device;
-#endif
     enum sc_log_level log_level;
     enum sc_codec video_codec;
     enum sc_codec audio_codec;
@@ -137,9 +134,12 @@ struct scrcpy_options {
     uint16_t window_height;
     uint32_t display_id;
     sc_tick display_buffer;
-    sc_tick v4l2_buffer;
     sc_tick audio_buffer;
     sc_tick audio_output_buffer;
+#ifdef HAVE_V4L2
+    const char *v4l2_device;
+    sc_tick v4l2_buffer;
+#endif
 #ifdef HAVE_USB
     bool otg;
 #endif
@@ -147,7 +147,8 @@ struct scrcpy_options {
     bool fullscreen;
     bool always_on_top;
     bool control;
-    bool mirror;
+    bool video_playback;
+    bool audio_playback;
     bool turn_screen_off;
     enum sc_key_inject_mode key_inject_mode;
     bool window_borderless;

app/src/scrcpy.c

@@ -137,7 +137,7 @@ sdl_set_hints(const char *render_driver) {
 }
 
 static void
-sdl_configure(bool mirror, bool disable_screensaver) {
+sdl_configure(bool video_playback, bool disable_screensaver) {
 #ifdef _WIN32
     // Clean up properly on Ctrl+C on Windows
     bool ok = SetConsoleCtrlHandler(windows_ctrl_handler, TRUE);
@@ -146,7 +146,7 @@ sdl_configure(bool mirror, bool disable_screensaver) {
     }
 #endif // _WIN32
 
-    if (!mirror) {
+    if (!video_playback) {
         return;
     }
 
@@ -386,22 +386,26 @@ scrcpy(struct scrcpy_options *options) {
         goto end;
     }
 
-    if (options->mirror) {
-        sdl_set_hints(options->render_driver);
+    // playback implies capture
+    assert(!options->video_playback || options->video);
+    assert(!options->audio_playback || options->audio);
 
-        // Initialize SDL video and audio in addition if mirroring is enabled
-        if (options->video && SDL_Init(SDL_INIT_VIDEO)) {
+    if (options->video_playback) {
+        sdl_set_hints(options->render_driver);
+        if (SDL_Init(SDL_INIT_VIDEO)) {
             LOGE("Could not initialize SDL video: %s", SDL_GetError());
             goto end;
         }
+    }
 
-        if (options->audio && SDL_Init(SDL_INIT_AUDIO)) {
+    if (options->audio_playback) {
+        if (SDL_Init(SDL_INIT_AUDIO)) {
             LOGE("Could not initialize SDL audio: %s", SDL_GetError());
             goto end;
         }
     }
 
-    sdl_configure(options->mirror, options->disable_screensaver);
+    sdl_configure(options->video_playback, options->disable_screensaver);
 
     // Await for server without blocking Ctrl+C handling
     bool connected;
@@ -427,7 +431,8 @@ scrcpy(struct scrcpy_options *options) {
 
     struct sc_file_pusher *fp = NULL;
 
-    assert(!options->control || options->mirror); // control implies mirror
+    // 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)) {
@@ -453,8 +458,8 @@ scrcpy(struct scrcpy_options *options) {
                         &audio_demuxer_cbs, options);
     }
 
-    bool needs_video_decoder = options->mirror && options->video;
-    bool needs_audio_decoder = options->mirror && options->audio;
+    bool needs_video_decoder = options->video_playback;
+    bool needs_audio_decoder = options->audio_playback;
 #ifdef HAVE_V4L2
     needs_video_decoder |= !!options->v4l2_device;
 #endif
@@ -650,7 +655,7 @@ aoa_hid_end:
     // There is a controller if and only if control is enabled
     assert(options->control == !!controller);
 
-    if (options->mirror) {
+    if (options->video_playback) {
         const char *window_title =
             options->window_title ? options->window_title : info->device_name;
 
@@ -684,21 +689,19 @@ aoa_hid_end:
             src = &s->display_buffer.frame_source;
         }
 
-        if (options->video) {
-            if (!sc_screen_init(&s->screen, &screen_params)) {
-                goto end;
-            }
-            screen_initialized = true;
-
-            sc_frame_source_add_sink(src, &s->screen.frame_sink);
+        if (!sc_screen_init(&s->screen, &screen_params)) {
+            goto end;
         }
+        screen_initialized = true;
 
-        if (options->audio) {
-            sc_audio_player_init(&s->audio_player, options->audio_buffer,
-                                 options->audio_output_buffer);
-            sc_frame_source_add_sink(&s->audio_decoder.frame_source,
-                                     &s->audio_player.frame_sink);
-        }
+        sc_frame_source_add_sink(src, &s->screen.frame_sink);
+    }
+
+    if (options->audio_playback) {
+        sc_audio_player_init(&s->audio_player, options->audio_buffer,
+                             options->audio_output_buffer);
+        sc_frame_source_add_sink(&s->audio_decoder.frame_source,
+                                 &s->audio_player.frame_sink);
     }
 
 #ifdef HAVE_V4L2

app/tests/test_cli.c

@@ -53,7 +53,7 @@ static void test_options(void) {
         "--max-size", "1024",
         "--lock-video-orientation=2", // optional arguments require '='
         // "--no-control" is not compatible with "--turn-screen-off"
-        // "--no-mirror" is not compatible with "--fulscreen"
+        // "--no-playback" is not compatible with "--fulscreen"
         "--port", "1234:1236",
         "--push-target", "/sdcard/Movies",
         "--record", "file",
@@ -108,8 +108,8 @@ static void test_options2(void) {
     char *argv[] = {
         "scrcpy",
         "--no-control",
-        "--no-mirror",
-        "--record", "file.mp4", // cannot enable --no-mirror without recording
+        "--no-playback",
+        "--record", "file.mp4", // cannot enable --no-playback without recording
     };
 
     bool ok = scrcpy_parse_args(&args, ARRAY_LEN(argv), argv);
@@ -117,7 +117,8 @@ static void test_options2(void) {
 
     const struct scrcpy_options *opts = &args.opts;
     assert(!opts->control);
-    assert(!opts->mirror);
+    assert(!opts->video_playback);
+    assert(!opts->audio_playback);
     assert(!strcmp(opts->record_filename, "file.mp4"));
     assert(opts->record_format == SC_RECORD_FORMAT_MP4);
 }

doc/audio.md

@@ -24,6 +24,8 @@ To disable audio:
 scrcpy --no-audio
 ```
 
+To disable only the audio playback, see [no playback](video.md#no-playback).
+
 ## Audio only
 
 To play audio only, disable the video:

doc/recording.md

@@ -21,10 +21,10 @@ scrcpy --no-video --audio-codec=aac --record-file=file.aac
 # .m4a/.mp4 and .mka/.mkv are also supported for both opus and aac
 ```
 
-To disable mirroring while recording:
+To disable playback while recording:
 
 ```bash
-scrcpy --no-mirror --record=file.mp4
+scrcpy --no-playback --record=file.mp4
 scrcpy -Nr file.mkv
 # interrupt recording with Ctrl+C
 ```

doc/v4l2.md

@@ -35,7 +35,7 @@ To start `scrcpy` using a v4l2 sink:
 
 ```bash
 scrcpy --v4l2-sink=/dev/videoN
-scrcpy --v4l2-sink=/dev/videoN --no-mirror  # disable mirroring window
+scrcpy --v4l2-sink=/dev/videoN --no-video-playback  # disable playback window
 ```
 
 (replace `N` with the device ID, check with `ls /dev/video*`)

doc/video.md

@@ -159,15 +159,25 @@ scrcpy --display-buffer=50 --v4l2-buffer=300
 ```
 
 
-## No mirror
+## No playback
 
-It is possible to capture an Android device without displaying a mirroring
-window. This option is available if either [recording](recording.md) or
+It is possible to capture an Android device without playing video or audio on
+the computer. This option is useful when [recording](recording.md) or when
 [v4l2](#video4linux) is enabled:
 
 ```bash
-scrcpy --v4l2-sink=/dev/video2 --no-mirror
-scrcpy --record=file.mkv --no-mirror
+scrcpy --v4l2-sink=/dev/video2 --no-playback
+scrcpy --record=file.mkv --no-playback
+```
+
+It is also possible to disable video and audio playback separately:
+
+```bash
+# Send video to V4L2 sink without playing it, but keep audio playback
+scrcpy --v4l2-sink=/dev/video2 --no-video-playback
+
+# Record both video and audio, but only play video
+scrcpy --record=file.mkv --no-audio-playback
 ```