Compare commits
49 Commits
activity_t
...
pause_on_e
Author | SHA1 | Date | |
---|---|---|---|
1c864a88eb | |||
1650b7c058 | |||
a7c3c9a54c | |||
111d02fca4 | |||
36670dda40 | |||
0983f0a194 | |||
110b3a16f6 | |||
1ee46970e3 | |||
fcdf847dd3 | |||
ad05a01800 | |||
328ed3650d | |||
c14668b177 | |||
637f48f360 | |||
d391fc3b69 | |||
75ad925423 | |||
7e936fa879 | |||
01d785d9a3 | |||
fe6e9acb36 | |||
625934fb1b | |||
85b55b3c4e | |||
7b7076ef85 | |||
808bd14e30 | |||
0049b3ce07 | |||
5764f47fee | |||
2dab1f7024 | |||
744312ec64 | |||
b9315620e2 | |||
ea59d525bd | |||
0ffcfa0f5c | |||
c0f3c080b6 | |||
d046678f85 | |||
fae3fbc934 | |||
5061b7e02c | |||
09009c2aa7 | |||
fb21bbf763 | |||
0f1afff7a6 | |||
4ad7479425 | |||
958f22490b | |||
cb20bcb16f | |||
8f0b38cc4f | |||
a1e8a34001 | |||
00534b0b2d | |||
21df2c240e | |||
2d3059e1ab | |||
478aece68f | |||
55899c091e | |||
d9a644df9c | |||
45717733a1 | |||
6ad037ea04 |
8
FAQ.md
8
FAQ.md
@ -159,6 +159,8 @@ In developer options, enable:
|
|||||||
> **USB debugging (Security settings)**
|
> **USB debugging (Security settings)**
|
||||||
> _Allow granting permissions and simulating input via USB debugging_
|
> _Allow granting permissions and simulating input via USB debugging_
|
||||||
|
|
||||||
|
Rebooting the device is necessary once this option is set.
|
||||||
|
|
||||||
[simulating input]: https://github.com/Genymobile/scrcpy/issues/70#issuecomment-373286323
|
[simulating input]: https://github.com/Genymobile/scrcpy/issues/70#issuecomment-373286323
|
||||||
|
|
||||||
|
|
||||||
@ -168,12 +170,12 @@ The default text injection method is [limited to ASCII characters][text-input].
|
|||||||
A trick allows to also inject some [accented characters][accented-characters],
|
A trick allows to also inject some [accented characters][accented-characters],
|
||||||
but that's all. See [#37].
|
but that's all. See [#37].
|
||||||
|
|
||||||
Since scrcpy v1.20, it is possible to simulate a [physical keyboard][hid] (HID).
|
It is also possible to simulate a [physical keyboard][hid] (HID).
|
||||||
|
|
||||||
[text-input]: https://github.com/Genymobile/scrcpy/issues?q=is%3Aopen+is%3Aissue+label%3Aunicode
|
[text-input]: https://github.com/Genymobile/scrcpy/issues?q=is%3Aopen+is%3Aissue+label%3Aunicode
|
||||||
[accented-characters]: https://blog.rom1v.com/2018/03/introducing-scrcpy/#handle-accented-characters
|
[accented-characters]: https://blog.rom1v.com/2018/03/introducing-scrcpy/#handle-accented-characters
|
||||||
[#37]: https://github.com/Genymobile/scrcpy/issues/37
|
[#37]: https://github.com/Genymobile/scrcpy/issues/37
|
||||||
[hid]: README.md#physical-keyboard-simulation-hid
|
[hid]: doc/hid-otg.md
|
||||||
|
|
||||||
|
|
||||||
## Client issues
|
## Client issues
|
||||||
@ -229,4 +231,4 @@ Translations of this FAQ in other languages are available in the [wiki].
|
|||||||
|
|
||||||
[wiki]: https://github.com/Genymobile/scrcpy/wiki
|
[wiki]: https://github.com/Genymobile/scrcpy/wiki
|
||||||
|
|
||||||
Only this README file is guaranteed to be up-to-date.
|
Only this FAQ file is guaranteed to be up-to-date.
|
||||||
|
22
README.md
22
README.md
@ -1,11 +1,11 @@
|
|||||||
# scrcpy (v2.0)
|
# scrcpy (v2.1.1)
|
||||||
|
|
||||||
<img src="app/data/icon.svg" width="128" height="128" alt="scrcpy" align="right" />
|
<img src="app/data/icon.svg" width="128" height="128" alt="scrcpy" align="right" />
|
||||||
|
|
||||||
_pronounced "**scr**een **c**o**py**"_
|
_pronounced "**scr**een **c**o**py**"_
|
||||||
|
|
||||||
This application mirrors Android devices (video and audio) connected via
|
This application mirrors Android devices (video and audio) connected via
|
||||||
USB or [over TCP/IP](doc/device.md#tcpip-wireless), and allows to control the
|
USB or [over TCP/IP](doc/connection.md#tcpip-wireless), and allows to control the
|
||||||
device with the keyboard and the mouse of the computer. It does not require any
|
device with the keyboard and the mouse of the computer. It does not require any
|
||||||
_root_ access. It works on _Linux_, _Windows_ and _macOS_.
|
_root_ access. It works on _Linux_, _Windows_ and _macOS_.
|
||||||
|
|
||||||
@ -30,7 +30,7 @@ Its features include:
|
|||||||
- mirroring with [Android device screen off](doc/device.md#turn-screen-off)
|
- mirroring with [Android device screen off](doc/device.md#turn-screen-off)
|
||||||
- [copy-paste](doc/control.md#copy-paste) in both directions
|
- [copy-paste](doc/control.md#copy-paste) in both directions
|
||||||
- [configurable quality](doc/video.md)
|
- [configurable quality](doc/video.md)
|
||||||
- Android device [as a webcam (V4L2)](doc/v4l2.md) (Linux-only)
|
- Android device screen [as a webcam (V4L2)](doc/v4l2.md) (Linux-only)
|
||||||
- [physical keyboard/mouse simulation (HID)](doc/hid-otg.md)
|
- [physical keyboard/mouse simulation (HID)](doc/hid-otg.md)
|
||||||
- [OTG mode](doc/hid-otg.md#otg)
|
- [OTG mode](doc/hid-otg.md#otg)
|
||||||
- and more…
|
- and more…
|
||||||
@ -39,7 +39,7 @@ Its features include:
|
|||||||
|
|
||||||
The Android device requires at least API 21 (Android 5.0).
|
The Android device requires at least API 21 (Android 5.0).
|
||||||
|
|
||||||
[Audio forwarding](doc/audio.md) is supported from API 30 (Android 11).
|
[Audio forwarding](doc/audio.md) is supported for API >= 30 (Android 11+).
|
||||||
|
|
||||||
Make sure you [enabled USB debugging][enable-adb] on your device(s).
|
Make sure you [enabled USB debugging][enable-adb] on your device(s).
|
||||||
|
|
||||||
@ -47,10 +47,14 @@ Make sure you [enabled USB debugging][enable-adb] on your device(s).
|
|||||||
|
|
||||||
On some devices, you also need to enable [an additional option][control] `USB
|
On some devices, you also need to enable [an additional option][control] `USB
|
||||||
debugging (Security Settings)` (this is an item different from `USB debugging`)
|
debugging (Security Settings)` (this is an item different from `USB debugging`)
|
||||||
to control it using a keyboard and mouse.
|
to control it using a keyboard and mouse. Rebooting the device is necessary once
|
||||||
|
this option is set.
|
||||||
|
|
||||||
[control]: https://github.com/Genymobile/scrcpy/issues/70#issuecomment-373286323
|
[control]: https://github.com/Genymobile/scrcpy/issues/70#issuecomment-373286323
|
||||||
|
|
||||||
|
Note that USB debugging is not required to run scrcpy in [OTG
|
||||||
|
mode](doc/hid-otg.md#otg).
|
||||||
|
|
||||||
|
|
||||||
## Get the app
|
## Get the app
|
||||||
|
|
||||||
@ -64,10 +68,11 @@ to control it using a keyboard and mouse.
|
|||||||
The application provides a lot of features and configuration options. They are
|
The application provides a lot of features and configuration options. They are
|
||||||
documented in the following pages:
|
documented in the following pages:
|
||||||
|
|
||||||
- [Device](doc/device.md)
|
- [Connection](doc/connection.md)
|
||||||
- [Video](doc/video.md)
|
- [Video](doc/video.md)
|
||||||
- [Audio](doc/audio.md)
|
- [Audio](doc/audio.md)
|
||||||
- [Control](doc/control.md)
|
- [Control](doc/control.md)
|
||||||
|
- [Device](doc/device.md)
|
||||||
- [Window](doc/window.md)
|
- [Window](doc/window.md)
|
||||||
- [Recording](doc/recording.md)
|
- [Recording](doc/recording.md)
|
||||||
- [Tunnels](doc/tunnels.md)
|
- [Tunnels](doc/tunnels.md)
|
||||||
@ -113,7 +118,10 @@ For general questions or discussions, you can also use:
|
|||||||
I'm [@rom1v](https://github.com/rom1v), the author and maintainer of _scrcpy_.
|
I'm [@rom1v](https://github.com/rom1v), the author and maintainer of _scrcpy_.
|
||||||
|
|
||||||
If you appreciate this application, you can [support my open source
|
If you appreciate this application, you can [support my open source
|
||||||
work][donate].
|
work][donate]:
|
||||||
|
- [GitHub Sponsors](https://github.com/sponsors/rom1v)
|
||||||
|
- [Liberapay](https://liberapay.com/rom1v/)
|
||||||
|
- [PayPal](https://paypal.me/rom2v)
|
||||||
|
|
||||||
[donate]: https://blog.rom1v.com/about/#support-my-open-source-work
|
[donate]: https://blog.rom1v.com/about/#support-my-open-source-work
|
||||||
|
|
||||||
|
@ -44,6 +44,8 @@ _scrcpy() {
|
|||||||
--no-video-playback
|
--no-video-playback
|
||||||
--otg
|
--otg
|
||||||
-p --port=
|
-p --port=
|
||||||
|
--pause-on-exit
|
||||||
|
--pause-on-exit=
|
||||||
--power-off-on-close
|
--power-off-on-close
|
||||||
--prefer-text
|
--prefer-text
|
||||||
--print-fps
|
--print-fps
|
||||||
@ -97,6 +99,10 @@ _scrcpy() {
|
|||||||
COMPREPLY=($(compgen -W 'unlocked initial 0 1 2 3' -- "$cur"))
|
COMPREPLY=($(compgen -W 'unlocked initial 0 1 2 3' -- "$cur"))
|
||||||
return
|
return
|
||||||
;;
|
;;
|
||||||
|
--pause-on-exit)
|
||||||
|
COMPREPLY=($(compgen -W 'true false if-error' -- "$cur"))
|
||||||
|
return
|
||||||
|
;;
|
||||||
-r|--record)
|
-r|--record)
|
||||||
COMPREPLY=($(compgen -f -- "$cur"))
|
COMPREPLY=($(compgen -f -- "$cur"))
|
||||||
return
|
return
|
||||||
|
@ -1,4 +1,2 @@
|
|||||||
@echo off
|
@echo off
|
||||||
scrcpy.exe %*
|
scrcpy.exe --pause-on-exit=if-error %*
|
||||||
:: if the exit code is >= 1, then pause
|
|
||||||
if errorlevel 1 pause
|
|
||||||
|
@ -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
|
# 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
|
# startup file, like .bashrc or .zshrc… Run an interactive shell to get
|
||||||
# environment correctly initialized.
|
# environment correctly initialized.
|
||||||
Exec=/bin/bash --norc --noprofile -i -c "\"\\$SHELL\" -i -c scrcpy || read -p 'Press Enter to quit...'"
|
Exec=/bin/sh -c "\"\\$SHELL\" -i -c scrcpy --pause-on-exit=if-error"
|
||||||
Icon=scrcpy
|
Icon=scrcpy
|
||||||
Terminal=true
|
Terminal=true
|
||||||
Type=Application
|
Type=Application
|
||||||
|
@ -50,6 +50,7 @@ arguments=(
|
|||||||
'--no-video-playback[Disable video playback]'
|
'--no-video-playback[Disable video playback]'
|
||||||
'--otg[Run in OTG mode \(simulating physical keyboard and mouse\)]'
|
'--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]'
|
{-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]'
|
'--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]'
|
'--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]'
|
'--print-fps[Start FPS counter, to print frame logs to the console]'
|
||||||
|
@ -6,10 +6,10 @@ cd "$DIR"
|
|||||||
mkdir -p "$PREBUILT_DATA_DIR"
|
mkdir -p "$PREBUILT_DATA_DIR"
|
||||||
cd "$PREBUILT_DATA_DIR"
|
cd "$PREBUILT_DATA_DIR"
|
||||||
|
|
||||||
DEP_DIR=platform-tools-34.0.1
|
DEP_DIR=platform-tools-34.0.3
|
||||||
|
|
||||||
FILENAME=platform-tools_r34.0.1-windows.zip
|
FILENAME=platform-tools_r34.0.3-windows.zip
|
||||||
SHA256SUM=5dd9c2be744c224fa3a7cbe30ba02d2cb378c763bd0f797a7e47e9f3156a5daa
|
SHA256SUM=fce992e93eb786fc9f47df93d83a7b912c46742d45c39d712c02e06d05b72e2b
|
||||||
|
|
||||||
if [[ -d "$DEP_DIR" ]]
|
if [[ -d "$DEP_DIR" ]]
|
||||||
then
|
then
|
||||||
|
@ -6,10 +6,10 @@ cd "$DIR"
|
|||||||
mkdir -p "$PREBUILT_DATA_DIR"
|
mkdir -p "$PREBUILT_DATA_DIR"
|
||||||
cd "$PREBUILT_DATA_DIR"
|
cd "$PREBUILT_DATA_DIR"
|
||||||
|
|
||||||
DEP_DIR=SDL2-2.26.4
|
DEP_DIR=SDL2-2.28.0
|
||||||
|
|
||||||
FILENAME=SDL2-devel-2.26.4-mingw.tar.gz
|
FILENAME=SDL2-devel-2.28.0-mingw.tar.gz
|
||||||
SHA256SUM=fe899c8642caac2f180b1ee6f786857ddcaa0adc1fa82474312b09dd47d74712
|
SHA256SUM=b91ce59eeacd4a9db403f976fd2337d9360b21ada374124417d716065c380e20
|
||||||
|
|
||||||
if [[ -d "$DEP_DIR" ]]
|
if [[ -d "$DEP_DIR" ]]
|
||||||
then
|
then
|
||||||
|
@ -13,7 +13,7 @@ BEGIN
|
|||||||
VALUE "LegalCopyright", "Romain Vimont, Genymobile"
|
VALUE "LegalCopyright", "Romain Vimont, Genymobile"
|
||||||
VALUE "OriginalFilename", "scrcpy.exe"
|
VALUE "OriginalFilename", "scrcpy.exe"
|
||||||
VALUE "ProductName", "scrcpy"
|
VALUE "ProductName", "scrcpy"
|
||||||
VALUE "ProductVersion", "2.0"
|
VALUE "ProductVersion", "2.1.1"
|
||||||
END
|
END
|
||||||
END
|
END
|
||||||
BLOCK "VarFileInfo"
|
BLOCK "VarFileInfo"
|
||||||
|
14
app/scrcpy.1
14
app/scrcpy.1
@ -21,7 +21,7 @@ Make scrcpy window always on top (above other windows).
|
|||||||
|
|
||||||
.TP
|
.TP
|
||||||
.BI "\-\-audio\-bit\-rate " value
|
.BI "\-\-audio\-bit\-rate " value
|
||||||
Encode the audio at the given bit\-rate, expressed in bits/s. Unit suffixes are supported: '\fBK\fR' (x1000) and '\fBM\fR' (x1000000).
|
Encode the audio at the given bit rate, expressed in bits/s. Unit suffixes are supported: '\fBK\fR' (x1000) and '\fBM\fR' (x1000000).
|
||||||
|
|
||||||
Default is 128K (128000).
|
Default is 128K (128000).
|
||||||
|
|
||||||
@ -71,7 +71,7 @@ Default is 5.
|
|||||||
|
|
||||||
.TP
|
.TP
|
||||||
.BI "\-b, \-\-video\-bit\-rate " value
|
.BI "\-b, \-\-video\-bit\-rate " value
|
||||||
Encode the video at the given bit\-rate, expressed in bits/s. Unit suffixes are supported: '\fBK\fR' (x1000) and '\fBM\fR' (x1000000).
|
Encode the video at the given bit rate, expressed in bits/s. Unit suffixes are supported: '\fBK\fR' (x1000) and '\fBM\fR' (x1000000).
|
||||||
|
|
||||||
Default is 8M (8000000).
|
Default is 8M (8000000).
|
||||||
|
|
||||||
@ -267,6 +267,16 @@ Set the TCP port (range) used by the client to listen.
|
|||||||
|
|
||||||
Default is 27183:27199.
|
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
|
.TP
|
||||||
.B \-\-power\-off\-on\-close
|
.B \-\-power\-off\-on\-close
|
||||||
Turn the device screen off when closing scrcpy.
|
Turn the device screen off when closing scrcpy.
|
||||||
|
@ -628,8 +628,8 @@ sc_adb_select_device(struct sc_intr *intr,
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
LOGD("ADB device found:");
|
LOGI("ADB device found:");
|
||||||
sc_adb_devices_log(SC_LOG_LEVEL_DEBUG, vec.data, vec.size);
|
sc_adb_devices_log(SC_LOG_LEVEL_INFO, vec.data, vec.size);
|
||||||
|
|
||||||
// Move devics into out_device (do not destroy device)
|
// Move devics into out_device (do not destroy device)
|
||||||
sc_adb_device_move(out_device, device);
|
sc_adb_device_move(out_device, device);
|
||||||
|
@ -79,6 +79,7 @@ enum {
|
|||||||
OPT_AUDIO_SOURCE,
|
OPT_AUDIO_SOURCE,
|
||||||
OPT_KILL_ADB_ON_CLOSE,
|
OPT_KILL_ADB_ON_CLOSE,
|
||||||
OPT_TIME_LIMIT,
|
OPT_TIME_LIMIT,
|
||||||
|
OPT_PAUSE_ON_EXIT,
|
||||||
};
|
};
|
||||||
|
|
||||||
struct sc_option {
|
struct sc_option {
|
||||||
@ -124,7 +125,7 @@ static const struct sc_option options[] = {
|
|||||||
.longopt_id = OPT_AUDIO_BIT_RATE,
|
.longopt_id = OPT_AUDIO_BIT_RATE,
|
||||||
.longopt = "audio-bit-rate",
|
.longopt = "audio-bit-rate",
|
||||||
.argdesc = "value",
|
.argdesc = "value",
|
||||||
.text = "Encode the audio at the given bit-rate, expressed in bits/s. "
|
.text = "Encode the audio at the given bit rate, expressed in bits/s. "
|
||||||
"Unit suffixes are supported: 'K' (x1000) and 'M' (x1000000).\n"
|
"Unit suffixes are supported: 'K' (x1000) and 'M' (x1000000).\n"
|
||||||
"Default is 128K (128000).",
|
"Default is 128K (128000).",
|
||||||
},
|
},
|
||||||
@ -185,7 +186,7 @@ static const struct sc_option options[] = {
|
|||||||
.shortopt = 'b',
|
.shortopt = 'b',
|
||||||
.longopt = "video-bit-rate",
|
.longopt = "video-bit-rate",
|
||||||
.argdesc = "value",
|
.argdesc = "value",
|
||||||
.text = "Encode the video at the given bit-rate, expressed in bits/s. "
|
.text = "Encode the video at the given bit rate, expressed in bits/s. "
|
||||||
"Unit suffixes are supported: 'K' (x1000) and 'M' (x1000000).\n"
|
"Unit suffixes are supported: 'K' (x1000) and 'M' (x1000000).\n"
|
||||||
"Default is 8M (8000000).",
|
"Default is 8M (8000000).",
|
||||||
},
|
},
|
||||||
@ -463,6 +464,20 @@ static const struct sc_option options[] = {
|
|||||||
"Default is " STR(DEFAULT_LOCAL_PORT_RANGE_FIRST) ":"
|
"Default is " STR(DEFAULT_LOCAL_PORT_RANGE_FIRST) ":"
|
||||||
STR(DEFAULT_LOCAL_PORT_RANGE_LAST) ".",
|
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_id = OPT_POWER_OFF_ON_CLOSE,
|
||||||
.longopt = "power-off-on-close",
|
.longopt = "power-off-on-close",
|
||||||
@ -1637,6 +1652,29 @@ parse_time_limit(const char *s, sc_tick *tick) {
|
|||||||
return true;
|
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
|
static bool
|
||||||
parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
|
parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
|
||||||
const char *optstring, const struct option *longopts) {
|
const char *optstring, const struct option *longopts) {
|
||||||
@ -1977,6 +2015,11 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
|
case OPT_PAUSE_ON_EXIT:
|
||||||
|
if (!parse_pause_on_exit(optarg, &args->pause_on_exit)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
break;
|
||||||
default:
|
default:
|
||||||
// getopt prints the error message on stderr
|
// getopt prints the error message on stderr
|
||||||
return false;
|
return false;
|
||||||
@ -2022,12 +2065,6 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
|
|||||||
opts->audio_playback = false;
|
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
|
if (opts->video && !opts->video_playback && !opts->record_filename
|
||||||
&& !v4l2) {
|
&& !v4l2) {
|
||||||
LOGI("No video playback, no recording, no V4L2 sink: video disabled");
|
LOGI("No video playback, no recording, no V4L2 sink: video disabled");
|
||||||
@ -2196,6 +2233,37 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
|
|||||||
return true;
|
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
|
bool
|
||||||
scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
|
scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
|
||||||
struct sc_getopt_adapter adapter;
|
struct sc_getopt_adapter adapter;
|
||||||
@ -2209,5 +2277,11 @@ scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
|
|||||||
|
|
||||||
sc_getopt_adapter_destroy(&adapter);
|
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;
|
return ret;
|
||||||
}
|
}
|
||||||
|
@ -7,10 +7,17 @@
|
|||||||
|
|
||||||
#include "options.h"
|
#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_cli_args {
|
||||||
struct scrcpy_options opts;
|
struct scrcpy_options opts;
|
||||||
bool help;
|
bool help;
|
||||||
bool version;
|
bool version;
|
||||||
|
enum sc_pause_on_exit pause_on_exit;
|
||||||
};
|
};
|
||||||
|
|
||||||
void
|
void
|
||||||
|
@ -53,7 +53,7 @@ sc_display_init(struct sc_display *display, SDL_Window *window, bool mipmaps) {
|
|||||||
display->mipmaps = true;
|
display->mipmaps = true;
|
||||||
} else {
|
} else {
|
||||||
LOGW("Trilinear filtering disabled "
|
LOGW("Trilinear filtering disabled "
|
||||||
"(OpenGL 3.0+ or ES 2.0+ required");
|
"(OpenGL 3.0+ or ES 2.0+ required)");
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
LOGI("Trilinear filtering disabled");
|
LOGI("Trilinear filtering disabled");
|
||||||
|
@ -39,26 +39,32 @@ main_scrcpy(int argc, char *argv[]) {
|
|||||||
.opts = scrcpy_options_default,
|
.opts = scrcpy_options_default,
|
||||||
.help = false,
|
.help = false,
|
||||||
.version = false,
|
.version = false,
|
||||||
|
.pause_on_exit = SC_PAUSE_ON_EXIT_FALSE,
|
||||||
};
|
};
|
||||||
|
|
||||||
#ifndef NDEBUG
|
#ifndef NDEBUG
|
||||||
args.opts.log_level = SC_LOG_LEVEL_DEBUG;
|
args.opts.log_level = SC_LOG_LEVEL_DEBUG;
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
enum scrcpy_exit_code ret;
|
||||||
|
|
||||||
if (!scrcpy_parse_args(&args, argc, argv)) {
|
if (!scrcpy_parse_args(&args, argc, argv)) {
|
||||||
return SCRCPY_EXIT_FAILURE;
|
ret = SCRCPY_EXIT_FAILURE;
|
||||||
|
goto end;
|
||||||
}
|
}
|
||||||
|
|
||||||
sc_set_log_level(args.opts.log_level);
|
sc_set_log_level(args.opts.log_level);
|
||||||
|
|
||||||
if (args.help) {
|
if (args.help) {
|
||||||
scrcpy_print_usage(argv[0]);
|
scrcpy_print_usage(argv[0]);
|
||||||
return SCRCPY_EXIT_SUCCESS;
|
ret = SCRCPY_EXIT_SUCCESS;
|
||||||
|
goto end;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (args.version) {
|
if (args.version) {
|
||||||
scrcpy_print_version();
|
scrcpy_print_version();
|
||||||
return SCRCPY_EXIT_SUCCESS;
|
ret = SCRCPY_EXIT_SUCCESS;
|
||||||
|
goto end;
|
||||||
}
|
}
|
||||||
|
|
||||||
#ifdef SCRCPY_LAVF_REQUIRES_REGISTER_ALL
|
#ifdef SCRCPY_LAVF_REQUIRES_REGISTER_ALL
|
||||||
@ -72,18 +78,26 @@ main_scrcpy(int argc, char *argv[]) {
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
if (!net_init()) {
|
if (!net_init()) {
|
||||||
return SCRCPY_EXIT_FAILURE;
|
ret = SCRCPY_EXIT_FAILURE;
|
||||||
|
goto end;
|
||||||
}
|
}
|
||||||
|
|
||||||
sc_log_configure();
|
sc_log_configure();
|
||||||
|
|
||||||
#ifdef HAVE_USB
|
#ifdef HAVE_USB
|
||||||
enum scrcpy_exit_code ret = args.opts.otg ? scrcpy_otg(&args.opts)
|
ret = args.opts.otg ? scrcpy_otg(&args.opts) : scrcpy(&args.opts);
|
||||||
: scrcpy(&args.opts);
|
|
||||||
#else
|
#else
|
||||||
enum scrcpy_exit_code ret = scrcpy(&args.opts);
|
ret = scrcpy(&args.opts);
|
||||||
#endif
|
#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;
|
return ret;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -252,7 +252,9 @@ sc_audio_demuxer_on_ended(struct sc_demuxer *demuxer,
|
|||||||
|
|
||||||
// Contrary to the video demuxer, keep mirroring if only the audio fails
|
// Contrary to the video demuxer, keep mirroring if only the audio fails
|
||||||
// (unless --require-audio is set).
|
// (unless --require-audio is set).
|
||||||
if (status == SC_DEMUXER_STATUS_ERROR
|
if (status == SC_DEMUXER_STATUS_EOS) {
|
||||||
|
PUSH_EVENT(SC_EVENT_DEVICE_DISCONNECTED);
|
||||||
|
} else if (status == SC_DEMUXER_STATUS_ERROR
|
||||||
|| (status == SC_DEMUXER_STATUS_DISABLED
|
|| (status == SC_DEMUXER_STATUS_DISABLED
|
||||||
&& options->require_audio)) {
|
&& options->require_audio)) {
|
||||||
PUSH_EVENT(SC_EVENT_DEMUXER_ERROR);
|
PUSH_EVENT(SC_EVENT_DEMUXER_ERROR);
|
||||||
@ -448,9 +450,7 @@ scrcpy(struct scrcpy_options *options) {
|
|||||||
|
|
||||||
struct sc_file_pusher *fp = NULL;
|
struct sc_file_pusher *fp = NULL;
|
||||||
|
|
||||||
// control implies video playback
|
if (options->video_playback && options->control) {
|
||||||
assert(!options->control || options->video_playback);
|
|
||||||
if (options->control) {
|
|
||||||
if (!sc_file_pusher_init(&s->file_pusher, serial,
|
if (!sc_file_pusher_init(&s->file_pusher, serial,
|
||||||
options->push_target)) {
|
options->push_target)) {
|
||||||
goto end;
|
goto end;
|
||||||
|
@ -488,6 +488,7 @@ sc_screen_show_initial_window(struct sc_screen *screen) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
SDL_ShowWindow(screen->window);
|
SDL_ShowWindow(screen->window);
|
||||||
|
sc_screen_update_content_rect(screen);
|
||||||
}
|
}
|
||||||
|
|
||||||
void
|
void
|
||||||
@ -848,6 +849,8 @@ sc_screen_convert_drawable_to_frame_coords(struct sc_screen *screen,
|
|||||||
int32_t w = screen->content_size.width;
|
int32_t w = screen->content_size.width;
|
||||||
int32_t h = screen->content_size.height;
|
int32_t h = screen->content_size.height;
|
||||||
|
|
||||||
|
// screen->rect must be initialized to avoid a division by zero
|
||||||
|
assert(screen->rect.w && screen->rect.h);
|
||||||
|
|
||||||
x = (int64_t) (x - screen->rect.x) * w / screen->rect.w;
|
x = (int64_t) (x - screen->rect.x) * w / screen->rect.w;
|
||||||
y = (int64_t) (y - screen->rect.y) * h / screen->rect.h;
|
y = (int64_t) (y - screen->rect.y) * h / screen->rect.h;
|
||||||
|
@ -533,8 +533,8 @@ sc_server_connect_to(struct sc_server *server, struct sc_server_info *info) {
|
|||||||
if (audio_socket == SC_SOCKET_NONE) {
|
if (audio_socket == SC_SOCKET_NONE) {
|
||||||
goto fail;
|
goto fail;
|
||||||
}
|
}
|
||||||
bool ok = net_connect_intr(&server->intr, audio_socket, tunnel_host,
|
bool ok = net_connect_intr(&server->intr, audio_socket,
|
||||||
tunnel_port);
|
tunnel_host, tunnel_port);
|
||||||
if (!ok) {
|
if (!ok) {
|
||||||
goto fail;
|
goto fail;
|
||||||
}
|
}
|
||||||
|
@ -105,10 +105,6 @@ scrcpy_otg(struct scrcpy_options *options) {
|
|||||||
|
|
||||||
usb_device_initialized = true;
|
usb_device_initialized = true;
|
||||||
|
|
||||||
LOGI("USB device: %s (%04x:%04x) %s %s", usb_device.serial,
|
|
||||||
(unsigned) usb_device.vid, (unsigned) usb_device.pid,
|
|
||||||
usb_device.manufacturer, usb_device.product);
|
|
||||||
|
|
||||||
ok = sc_usb_connect(&s->usb, usb_device.device, &cbs, NULL);
|
ok = sc_usb_connect(&s->usb, usb_device.device, &cbs, NULL);
|
||||||
if (!ok) {
|
if (!ok) {
|
||||||
goto end;
|
goto end;
|
||||||
|
@ -213,8 +213,8 @@ sc_usb_select_device(struct sc_usb *usb, const char *serial,
|
|||||||
assert(sel_count == 1); // sel_idx is valid only if sel_count == 1
|
assert(sel_count == 1); // sel_idx is valid only if sel_count == 1
|
||||||
struct sc_usb_device *device = &vec.data[sel_idx];
|
struct sc_usb_device *device = &vec.data[sel_idx];
|
||||||
|
|
||||||
LOGD("USB device found:");
|
LOGI("USB device found:");
|
||||||
sc_usb_devices_log(SC_LOG_LEVEL_DEBUG, vec.data, vec.size);
|
sc_usb_devices_log(SC_LOG_LEVEL_INFO, vec.data, vec.size);
|
||||||
|
|
||||||
// Move device into out_device (do not destroy device)
|
// Move device into out_device (do not destroy device)
|
||||||
sc_usb_device_move(out_device, device);
|
sc_usb_device_move(out_device, device);
|
||||||
|
@ -17,5 +17,5 @@ endian = 'little'
|
|||||||
|
|
||||||
[properties]
|
[properties]
|
||||||
prebuilt_ffmpeg = 'ffmpeg-6.0-scrcpy-4/win32'
|
prebuilt_ffmpeg = 'ffmpeg-6.0-scrcpy-4/win32'
|
||||||
prebuilt_sdl2 = 'SDL2-2.26.4/i686-w64-mingw32'
|
prebuilt_sdl2 = 'SDL2-2.28.0/i686-w64-mingw32'
|
||||||
prebuilt_libusb = 'libusb-1.0.26/libusb-MinGW-Win32'
|
prebuilt_libusb = 'libusb-1.0.26/libusb-MinGW-Win32'
|
||||||
|
@ -17,5 +17,5 @@ endian = 'little'
|
|||||||
|
|
||||||
[properties]
|
[properties]
|
||||||
prebuilt_ffmpeg = 'ffmpeg-6.0-scrcpy-4/win64'
|
prebuilt_ffmpeg = 'ffmpeg-6.0-scrcpy-4/win64'
|
||||||
prebuilt_sdl2 = 'SDL2-2.26.4/x86_64-w64-mingw32'
|
prebuilt_sdl2 = 'SDL2-2.28.0/x86_64-w64-mingw32'
|
||||||
prebuilt_libusb = 'libusb-1.0.26/libusb-MinGW-x64'
|
prebuilt_libusb = 'libusb-1.0.26/libusb-MinGW-x64'
|
||||||
|
23
doc/audio.md
23
doc/audio.md
@ -71,6 +71,20 @@ scrcpy --audio-codec=aac
|
|||||||
scrcpy --audio-codec=raw
|
scrcpy --audio-codec=raw
|
||||||
```
|
```
|
||||||
|
|
||||||
|
In particular, if you get the following error:
|
||||||
|
|
||||||
|
> Failed to initialize audio/opus, error 0xfffffffe
|
||||||
|
|
||||||
|
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:
|
Several encoders may be available on the device. They can be listed by:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@ -79,19 +93,14 @@ scrcpy --list-encoders
|
|||||||
|
|
||||||
To select a specific encoder:
|
To select a specific encoder:
|
||||||
|
|
||||||
```
|
```bash
|
||||||
scrcpy --audio-codec=opus --audio-encoder='c2.android.opus.encoder'
|
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
|
## Bit rate
|
||||||
|
|
||||||
The default video bit-rate is 128Kbps. To change it:
|
The default audio bit rate is 128Kbps. To change it:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
scrcpy --audio-bit-rate=64K
|
scrcpy --audio-bit-rate=64K
|
||||||
|
@ -77,7 +77,7 @@ pip3 install meson
|
|||||||
sudo dnf install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm
|
sudo dnf install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm
|
||||||
|
|
||||||
# client build dependencies
|
# client build dependencies
|
||||||
sudo dnf install SDL2-devel ffms2-devel libusb-devel meson gcc make
|
sudo dnf install SDL2-devel ffms2-devel libusb1-devel meson gcc make
|
||||||
|
|
||||||
# server build dependencies
|
# server build dependencies
|
||||||
sudo dnf install java-devel
|
sudo dnf install java-devel
|
||||||
@ -233,10 +233,10 @@ install` must be run as root)._
|
|||||||
|
|
||||||
#### Option 2: Use prebuilt server
|
#### Option 2: Use prebuilt server
|
||||||
|
|
||||||
- [`scrcpy-server-v2.0`][direct-scrcpy-server]
|
- [`scrcpy-server-v2.1.1`][direct-scrcpy-server]
|
||||||
<sub>SHA-256: `9e241615f578cd690bb43311000debdecf6a9c50a7082b001952f18f6f21ddc2`</sub>
|
<sub>SHA-256: `9558db6c56743a1dc03b38f59801fb40e91cc891f8fc0c89e5b0b067761f148e`</sub>
|
||||||
|
|
||||||
[direct-scrcpy-server]: https://github.com/Genymobile/scrcpy/releases/download/v2.0/scrcpy-server-v2.0
|
[direct-scrcpy-server]: https://github.com/Genymobile/scrcpy/releases/download/v2.1.1/scrcpy-server-v2.1.1
|
||||||
|
|
||||||
Download the prebuilt server somewhere, and specify its path during the Meson
|
Download the prebuilt server somewhere, and specify its path during the Meson
|
||||||
configuration:
|
configuration:
|
||||||
|
125
doc/connection.md
Normal file
125
doc/connection.md
Normal file
@ -0,0 +1,125 @@
|
|||||||
|
# Connection
|
||||||
|
|
||||||
|
## Selection
|
||||||
|
|
||||||
|
If exactly one device is connected (i.e. listed by `adb devices`), then it is
|
||||||
|
automatically selected.
|
||||||
|
|
||||||
|
However, if there are multiple devices connected, you must specify the one to
|
||||||
|
use in one of 4 ways:
|
||||||
|
- by its serial:
|
||||||
|
```bash
|
||||||
|
scrcpy --serial=0123456789abcdef
|
||||||
|
scrcpy -s 0123456789abcdef # short version
|
||||||
|
|
||||||
|
# the serial is the ip:port if connected over TCP/IP (same behavior as adb)
|
||||||
|
scrcpy --serial=192.168.1.1:5555
|
||||||
|
```
|
||||||
|
- the one connected over USB (if there is exactly one):
|
||||||
|
```bash
|
||||||
|
scrcpy --select-usb
|
||||||
|
scrcpy -d # short version
|
||||||
|
```
|
||||||
|
- the one connected over TCP/IP (if there is exactly one):
|
||||||
|
```bash
|
||||||
|
scrcpy --select-tcpip
|
||||||
|
scrcpy -e # short version
|
||||||
|
```
|
||||||
|
- a device already listening on TCP/IP (see [below](#tcpip-wireless)):
|
||||||
|
```bash
|
||||||
|
scrcpy --tcpip=192.168.1.1:5555
|
||||||
|
scrcpy --tcpip=192.168.1.1 # default port is 5555
|
||||||
|
```
|
||||||
|
|
||||||
|
The serial may also be provided via the environment variable `ANDROID_SERIAL`
|
||||||
|
(also used by `adb`):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# in bash
|
||||||
|
export ANDROID_SERIAL=0123456789abcdef
|
||||||
|
scrcpy
|
||||||
|
```
|
||||||
|
|
||||||
|
```cmd
|
||||||
|
:: in cmd
|
||||||
|
set ANDROID_SERIAL=0123456789abcdef
|
||||||
|
scrcpy
|
||||||
|
```
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
# in PowerShell
|
||||||
|
$env:ANDROID_SERIAL = '0123456789abcdef'
|
||||||
|
scrcpy
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## TCP/IP (wireless)
|
||||||
|
|
||||||
|
_Scrcpy_ uses `adb` to communicate with the device, and `adb` can [connect] to a
|
||||||
|
device over TCP/IP. The device must be connected on the same network as the
|
||||||
|
computer.
|
||||||
|
|
||||||
|
[connect]: https://developer.android.com/studio/command-line/adb.html#wireless
|
||||||
|
|
||||||
|
|
||||||
|
### Automatic
|
||||||
|
|
||||||
|
An option `--tcpip` allows to configure the connection automatically. There are
|
||||||
|
two variants.
|
||||||
|
|
||||||
|
If the device (accessible at 192.168.1.1 in this example) already listens on a
|
||||||
|
port (typically 5555) for incoming _adb_ connections, then run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
scrcpy --tcpip=192.168.1.1 # default port is 5555
|
||||||
|
scrcpy --tcpip=192.168.1.1:5555
|
||||||
|
```
|
||||||
|
|
||||||
|
If _adb_ TCP/IP mode is disabled on the device (or if you don't know the IP
|
||||||
|
address), connect the device over USB, then run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
scrcpy --tcpip # without arguments
|
||||||
|
```
|
||||||
|
|
||||||
|
It will automatically find the device IP address and adb port, enable TCP/IP
|
||||||
|
mode if necessary, then connect to the device before starting.
|
||||||
|
|
||||||
|
|
||||||
|
### Manual
|
||||||
|
|
||||||
|
Alternatively, it is possible to enable the TCP/IP connection manually using
|
||||||
|
`adb`:
|
||||||
|
|
||||||
|
1. Plug the device into a USB port on your computer.
|
||||||
|
2. Connect the device to the same Wi-Fi network as your computer.
|
||||||
|
3. Get your device IP address, in Settings → About phone → Status, or by
|
||||||
|
executing this command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
adb shell ip route | awk '{print $9}'
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Enable `adb` over TCP/IP on your device: `adb tcpip 5555`.
|
||||||
|
5. Unplug your device.
|
||||||
|
6. Connect to your device: `adb connect DEVICE_IP:5555` _(replace `DEVICE_IP`
|
||||||
|
with the device IP address you found)_.
|
||||||
|
7. Run `scrcpy` as usual.
|
||||||
|
8. Run `adb disconnect` once you're done.
|
||||||
|
|
||||||
|
Since Android 11, a [wireless debugging option][adb-wireless] allows to bypass
|
||||||
|
having to physically connect your device directly to your computer.
|
||||||
|
|
||||||
|
[adb-wireless]: https://developer.android.com/studio/command-line/adb#wireless-android11-command-line
|
||||||
|
|
||||||
|
|
||||||
|
## Autostart
|
||||||
|
|
||||||
|
A small tool (by the scrcpy author) allows to run arbitrary commands whenever a
|
||||||
|
new Android device is connected: [AutoAdb]. It can be used to start scrcpy:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
autoadb scrcpy -s '{}'
|
||||||
|
```
|
||||||
|
|
||||||
|
[AutoAdb]: https://github.com/rom1v/autoadb
|
445
doc/develop.md
445
doc/develop.md
@ -9,16 +9,52 @@ This application is composed of two parts:
|
|||||||
The client is responsible to push the server to the device and start its
|
The client is responsible to push the server to the device and start its
|
||||||
execution.
|
execution.
|
||||||
|
|
||||||
Once the client and the server are connected to each other, the server initially
|
The client and the server establish communication using separate sockets for
|
||||||
sends device information (name and initial screen dimensions), then starts to
|
video, audio and controls. Any of them may be disabled (but not all), so
|
||||||
send a raw H.264 video stream of the device screen. The client decodes the video
|
there are 1, 2 or 3 socket(s).
|
||||||
frames, and display them as soon as possible, without buffering, to minimize
|
|
||||||
latency. The client is not aware of the device rotation (which is handled by the
|
|
||||||
server), it just knows the dimensions of the video frames.
|
|
||||||
|
|
||||||
The client captures relevant keyboard and mouse events, that it transmits to the
|
The server initially sends the device name on the first socket (it is used for
|
||||||
server, which injects them to the device.
|
the scrcpy window title), then each socket is used for its own purpose. All
|
||||||
|
reads and writes are performed from a dedicated thread for each socket, both on
|
||||||
|
the client and on the server.
|
||||||
|
|
||||||
|
If video is enabled, then the server sends a raw video stream (H.264 by default)
|
||||||
|
of the device screen, with some additional headers for each packet. The client
|
||||||
|
decodes the video frames, and displays them as soon as possible, without
|
||||||
|
buffering (unless `--display-buffer=delay` is specified) to minimize latency.
|
||||||
|
The client is not aware of the device rotation (which is handled by the server),
|
||||||
|
it just knows the dimensions of the video frames it receives.
|
||||||
|
|
||||||
|
Similarly, if audio is enabled, then the server sends a raw audio stream (OPUS
|
||||||
|
by default) of the device audio output (or the microphone if
|
||||||
|
`--audio-source=mic` is specified), with some additional headers for each
|
||||||
|
packet. The client decodes the stream, attempts to keep a minimal latency by
|
||||||
|
maintaining an average buffering. The [blog post][scrcpy2] of the scrcpy v2.0
|
||||||
|
release gives more details about the audio feature.
|
||||||
|
|
||||||
|
If control is enabled, then the client captures relevant keyboard and mouse
|
||||||
|
events, that it transmits to the server, which injects them to the device. This
|
||||||
|
is the only socket which is used in both direction: input events are sent from
|
||||||
|
the client to the device, and when the device clipboard changes, the new content
|
||||||
|
is sent from the device to the client to support seamless copy-paste.
|
||||||
|
|
||||||
|
[scrcpy2]: https://blog.rom1v.com/2023/03/scrcpy-2-0-with-audio/
|
||||||
|
|
||||||
|
Note that the client-server roles are expressed at the application level:
|
||||||
|
|
||||||
|
- the server _serves_ video and audio streams, and handle requests from the
|
||||||
|
client,
|
||||||
|
- the client _controls_ the device through the server.
|
||||||
|
|
||||||
|
However, by default (when `--force-adb-forward` is not set), the roles are
|
||||||
|
reversed at the network level:
|
||||||
|
|
||||||
|
- the client opens a server socket and listen on a port before starting the
|
||||||
|
server,
|
||||||
|
- the server connects to the client.
|
||||||
|
|
||||||
|
This role inversion guarantees that the connection will not fail due to race
|
||||||
|
conditions without polling.
|
||||||
|
|
||||||
|
|
||||||
## Server
|
## Server
|
||||||
@ -32,15 +68,14 @@ The server is a Java application (with a [`public static void main(String...
|
|||||||
args)`][main] method), compiled against the Android framework, and executed as
|
args)`][main] method), compiled against the Android framework, and executed as
|
||||||
`shell` on the Android device.
|
`shell` on the Android device.
|
||||||
|
|
||||||
[main]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/Server.java#L123
|
[main]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/Server.java#L193
|
||||||
|
|
||||||
To run such a Java application, the classes must be [_dexed_][dex] (typically,
|
To run such a Java application, the classes must be [_dexed_][dex] (typically,
|
||||||
to `classes.dex`). If `my.package.MainClass` is the main class, compiled to
|
to `classes.dex`). If `my.package.MainClass` is the main class, compiled to
|
||||||
`classes.dex`, pushed to the device in `/data/local/tmp`, then it can be run
|
`classes.dex`, pushed to the device in `/data/local/tmp`, then it can be run
|
||||||
with:
|
with:
|
||||||
|
|
||||||
adb shell CLASSPATH=/data/local/tmp/classes.dex \
|
adb shell CLASSPATH=/data/local/tmp/classes.dex app_process / my.package.MainClass
|
||||||
app_process / my.package.MainClass
|
|
||||||
|
|
||||||
_The path `/data/local/tmp` is a good candidate to push the server, since it's
|
_The path `/data/local/tmp` is a good candidate to push the server, since it's
|
||||||
readable and writable by `shell`, but not world-writable, so a malicious
|
readable and writable by `shell`, but not world-writable, so a malicious
|
||||||
@ -49,7 +84,7 @@ application may not replace the server just before the client executes it._
|
|||||||
Instead of a raw _dex_ file, `app_process` accepts a _jar_ containing
|
Instead of a raw _dex_ file, `app_process` accepts a _jar_ containing
|
||||||
`classes.dex` (e.g. an [APK]). For simplicity, and to benefit from the gradle
|
`classes.dex` (e.g. an [APK]). For simplicity, and to benefit from the gradle
|
||||||
build system, the server is built to an (unsigned) APK (renamed to
|
build system, the server is built to an (unsigned) APK (renamed to
|
||||||
`scrcpy-server`).
|
`scrcpy-server.jar`).
|
||||||
|
|
||||||
[dex]: https://en.wikipedia.org/wiki/Dalvik_(software)
|
[dex]: https://en.wikipedia.org/wiki/Dalvik_(software)
|
||||||
[apk]: https://en.wikipedia.org/wiki/Android_application_package
|
[apk]: https://en.wikipedia.org/wiki/Android_application_package
|
||||||
@ -65,42 +100,77 @@ They can be called using reflection though. The communication with hidden
|
|||||||
components is provided by [_wrappers_ classes][wrappers] and [aidl].
|
components is provided by [_wrappers_ classes][wrappers] and [aidl].
|
||||||
|
|
||||||
[hidden]: https://stackoverflow.com/a/31908373/1987178
|
[hidden]: https://stackoverflow.com/a/31908373/1987178
|
||||||
[wrappers]: https://github.com/Genymobile/scrcpy/tree/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/wrappers
|
[wrappers]: https://github.com/Genymobile/scrcpy/tree/master/server/src/main/java/com/genymobile/scrcpy/wrappers
|
||||||
[aidl]: https://github.com/Genymobile/scrcpy/tree/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/aidl/android/view
|
[aidl]: https://github.com/Genymobile/scrcpy/tree/master/server/src/main/aidl
|
||||||
|
|
||||||
|
|
||||||
### Threading
|
|
||||||
|
|
||||||
The server uses 3 threads:
|
### Execution
|
||||||
|
|
||||||
- the **main** thread, encoding and streaming the video to the client;
|
The server is started by the client basically by executing the following
|
||||||
- the **controller** thread, listening for _control messages_ (typically,
|
commands:
|
||||||
keyboard and mouse events) from the client;
|
|
||||||
- the **receiver** thread (managed by the controller), sending _device messages_
|
|
||||||
to the clients (currently, it is only used to send the device clipboard
|
|
||||||
content).
|
|
||||||
|
|
||||||
Since the video encoding is typically hardware, there would be no benefit in
|
```bash
|
||||||
encoding and streaming in two different threads.
|
adb push scrcpy-server /data/local/tmp/scrcpy-server.jar
|
||||||
|
adb forward tcp:27183 localabstract:scrcpy
|
||||||
|
adb shell CLASSPATH=/data/local/tmp/scrcpy-server.jar app_process / com.genymobile.scrcpy.Server 2.1
|
||||||
|
```
|
||||||
|
|
||||||
|
The first argument (`2.1` in the example) is the client scrcpy version. The
|
||||||
|
server fails if the client and the server do not have the exact same version.
|
||||||
|
The protocol between the client and the server may change from version to
|
||||||
|
version (see [protocol](#protocol) below), and there is no backward or forward
|
||||||
|
compatibility (there is no point to use different client and server versions).
|
||||||
|
This check allows to detect misconfiguration (running an older or newer server
|
||||||
|
by mistake).
|
||||||
|
|
||||||
|
It is followed by any number of arguments, in the form of `key=value` pairs.
|
||||||
|
Their order is irrelevant. The possible keys and associated value types can be
|
||||||
|
found in the [server][server-options] and [client][client-options] code.
|
||||||
|
|
||||||
|
[server-options]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/Options.java#L181
|
||||||
|
[client-options]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/app/src/server.c#L226
|
||||||
|
|
||||||
|
For example, if we execute `scrcpy -m1920 --no-audio`, then the server
|
||||||
|
execution will look like this:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# scid is a random number to identify different clients running on the same device
|
||||||
|
adb shell CLASSPATH=/data/local/tmp/scrcpy-server.jar app_process / com.genymobile.scrcpy.Server 2.1 scid=12345678 log_level=info audio=false max_size=1920
|
||||||
|
```
|
||||||
|
|
||||||
|
### Components
|
||||||
|
|
||||||
|
When executed, its [`main()`][main] method is executed (on the "main" thread).
|
||||||
|
It parses the arguments, establishes the connection with the client and starts
|
||||||
|
the other "components":
|
||||||
|
- the **video** streamer: it captures the video screen and send encoded video
|
||||||
|
packets on the _video_ socket (from the _video_ thread).
|
||||||
|
- the **audio** streamer: it uses several threads to capture raw packets,
|
||||||
|
submits them to encoding and retrieve encoded packets, which it sends on the
|
||||||
|
_audio_ socket.
|
||||||
|
- the **controller**: it receives _control messages_ (typically input events)
|
||||||
|
on the _control_ socket from one thread, and sends _device messages_ (e.g. to
|
||||||
|
transmit the device clipboard content to the client) on the same _control
|
||||||
|
socket_ from another thread. Thus, the _control_ socket is used in both
|
||||||
|
directions (contrary to the _video_ and _audio_ sockets).
|
||||||
|
|
||||||
|
|
||||||
### Screen video encoding
|
### Screen video encoding
|
||||||
|
|
||||||
The encoding is managed by [`ScreenEncoder`].
|
The encoding is managed by [`ScreenEncoder`].
|
||||||
|
|
||||||
The video is encoded using the [`MediaCodec`] API. The codec takes its input
|
The video is encoded using the [`MediaCodec`] API. The codec encodes the content
|
||||||
from a [surface] associated to the display, and writes the resulting H.264
|
of a `Surface` associated to the display, and writes the encoding packets to the
|
||||||
stream to the provided output stream (the socket connected to the client).
|
client (on the _video_ socket).
|
||||||
|
|
||||||
[`ScreenEncoder`]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java
|
[`ScreenEncoder`]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java
|
||||||
[`MediaCodec`]: https://developer.android.com/reference/android/media/MediaCodec.html
|
[`MediaCodec`]: https://developer.android.com/reference/android/media/MediaCodec.html
|
||||||
[surface]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java#L68-L69
|
|
||||||
|
|
||||||
On device [rotation], the codec, surface and display are reinitialized, and a
|
On device rotation (or folding), the encoding session is [reset] and restarted.
|
||||||
new video stream is produced.
|
|
||||||
|
|
||||||
New frames are produced only when changes occur on the surface. This is good
|
New frames are produced only when changes occur on the surface. This avoids to
|
||||||
because it avoids to send unnecessary frames, but there are drawbacks:
|
send unnecessary frames, but by default there might be drawbacks:
|
||||||
|
|
||||||
- it does not send any frame on start if the device screen does not change,
|
- it does not send any frame on start if the device screen does not change,
|
||||||
- after fast motion changes, the last frame may have poor quality.
|
- after fast motion changes, the last frame may have poor quality.
|
||||||
@ -108,11 +178,24 @@ because it avoids to send unnecessary frames, but there are drawbacks:
|
|||||||
Both problems are [solved][repeat] by the flag
|
Both problems are [solved][repeat] by the flag
|
||||||
[`KEY_REPEAT_PREVIOUS_FRAME_AFTER`][repeat-flag].
|
[`KEY_REPEAT_PREVIOUS_FRAME_AFTER`][repeat-flag].
|
||||||
|
|
||||||
|
[reset]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java#L179
|
||||||
[rotation]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java#L90
|
[rotation]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java#L90
|
||||||
[repeat]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java#L147-L148
|
[repeat]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java#L246-L247
|
||||||
[repeat-flag]: https://developer.android.com/reference/android/media/MediaFormat.html#KEY_REPEAT_PREVIOUS_FRAME_AFTER
|
[repeat-flag]: https://developer.android.com/reference/android/media/MediaFormat.html#KEY_REPEAT_PREVIOUS_FRAME_AFTER
|
||||||
|
|
||||||
|
|
||||||
|
### Audio encoding
|
||||||
|
|
||||||
|
Similarly, the audio is [captured] using an [`AudioRecord`], and [encoded] using
|
||||||
|
the [`MediaCodec`] asynchronous API.
|
||||||
|
|
||||||
|
More details are available on the [blog post][scrcpy2] introducing the audio feature.
|
||||||
|
|
||||||
|
[captured]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/AudioCapture.java
|
||||||
|
[encoded]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/AudioEncoder.java
|
||||||
|
[`AudioRecord`]: https://developer.android.com/reference/android/media/AudioRecord
|
||||||
|
|
||||||
|
|
||||||
### Input events injection
|
### Input events injection
|
||||||
|
|
||||||
_Control messages_ are received from the client by the [`Controller`] (run in a
|
_Control messages_ are received from the client by the [`Controller`] (run in a
|
||||||
@ -124,13 +207,13 @@ separate thread). There are several types of input events:
|
|||||||
- other commands (e.g. to switch the screen on or to copy the clipboard).
|
- other commands (e.g. to switch the screen on or to copy the clipboard).
|
||||||
|
|
||||||
Some of them need to inject input events to the system. To do so, they use the
|
Some of them need to inject input events to the system. To do so, they use the
|
||||||
_hidden_ method [`InputManager.injectInputEvent`] (exposed by our
|
_hidden_ method [`InputManager.injectInputEvent()`] (exposed by the
|
||||||
[`InputManager` wrapper][inject-wrapper]).
|
[`InputManager` wrapper][inject-wrapper]).
|
||||||
|
|
||||||
[`Controller`]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/Controller.java#L81
|
[`Controller`]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/Controller.java
|
||||||
[`KeyEvent`]: https://developer.android.com/reference/android/view/KeyEvent.html
|
[`KeyEvent`]: https://developer.android.com/reference/android/view/KeyEvent.html
|
||||||
[`MotionEvent`]: https://developer.android.com/reference/android/view/MotionEvent.html
|
[`MotionEvent`]: https://developer.android.com/reference/android/view/MotionEvent.html
|
||||||
[`InputManager.injectInputEvent`]: https://android.googlesource.com/platform/frameworks/base/+/oreo-release/core/java/android/hardware/input/InputManager.java#857
|
[`InputManager.injectInputEvent()`]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/wrappers/InputManager.java#L34
|
||||||
[inject-wrapper]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/wrappers/InputManager.java#L27
|
[inject-wrapper]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/wrappers/InputManager.java#L27
|
||||||
|
|
||||||
|
|
||||||
@ -140,126 +223,222 @@ _hidden_ method [`InputManager.injectInputEvent`] (exposed by our
|
|||||||
The client relies on [SDL], which provides cross-platform API for UI, input
|
The client relies on [SDL], which provides cross-platform API for UI, input
|
||||||
events, threading, etc.
|
events, threading, etc.
|
||||||
|
|
||||||
The video stream is decoded by [libav] (FFmpeg).
|
The video and audio streams are decoded by [FFmpeg].
|
||||||
|
|
||||||
[SDL]: https://www.libsdl.org
|
[SDL]: https://www.libsdl.org
|
||||||
[libav]: https://www.libav.org/
|
[ffmpeg]: https://ffmpeg.org/
|
||||||
|
|
||||||
|
|
||||||
### Initialization
|
### Initialization
|
||||||
|
|
||||||
On startup, in addition to _libav_ and _SDL_ initialization, the client must
|
The client parses the command line arguments, then [runs one of two code
|
||||||
push and start the server on the device, and open two sockets (one for the video
|
paths][run]:
|
||||||
stream, one for control) so that they may communicate.
|
- scrcpy in "normal" mode ([`scrcpy.c`])
|
||||||
|
- scrcpy in [OTG mode](hid-otg.md) ([`scrcpy_otg.c`])
|
||||||
|
|
||||||
Note that the client-server roles are expressed at the application level:
|
[run]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/app/src/main.c#L81-L82
|
||||||
|
[`scrcpy.c`]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/app/src/scrcpy.c#L292-L293
|
||||||
|
[`scrcpy_otg.c`]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/app/src/usb/scrcpy_otg.c#L51-L52
|
||||||
|
|
||||||
- the server _serves_ video stream and handle requests from the client,
|
In the remaining of this document, we assume that the "normal" mode is used
|
||||||
- the client _controls_ the device through the server.
|
(read the code for the OTG mode).
|
||||||
|
|
||||||
However, the roles are reversed at the network level:
|
On startup, the client:
|
||||||
|
- opens the _video_, _audio_ and _control_ sockets;
|
||||||
- the client opens a server socket and listen on a port before starting the
|
- pushes and starts the server on the device;
|
||||||
server,
|
- initializes its components (demuxers, decoders, recorder…).
|
||||||
- the server connects to the client.
|
|
||||||
|
|
||||||
This role inversion guarantees that the connection will not fail due to race
|
|
||||||
conditions, and avoids polling.
|
|
||||||
|
|
||||||
_(Note that over TCP/IP, the roles are not reversed, due to a bug in `adb
|
|
||||||
reverse`. See commit [1038bad] and [issue #5].)_
|
|
||||||
|
|
||||||
Once the server is connected, it sends the device information (name and initial
|
|
||||||
screen dimensions). Thus, the client may init the window and renderer, before
|
|
||||||
the first frame is available.
|
|
||||||
|
|
||||||
To minimize startup time, SDL initialization is performed while listening for
|
|
||||||
the connection from the server (see commit [90a46b4]).
|
|
||||||
|
|
||||||
[1038bad]: https://github.com/Genymobile/scrcpy/commit/1038bad3850f18717a048a4d5c0f8110e54ee172
|
|
||||||
[issue #5]: https://github.com/Genymobile/scrcpy/issues/5
|
|
||||||
[90a46b4]: https://github.com/Genymobile/scrcpy/commit/90a46b4c45637d083e877020d85ade52a9a5fa8e
|
|
||||||
|
|
||||||
|
|
||||||
### Threading
|
### Video and audio streams
|
||||||
|
|
||||||
The client uses 4 threads:
|
Depending on the arguments passed to `scrcpy`, several components may be used.
|
||||||
|
Here is an overview of the video and audio components:
|
||||||
- the **main** thread, executing the SDL event loop,
|
|
||||||
- the **stream** thread, receiving the video and used for decoding and
|
|
||||||
recording,
|
|
||||||
- the **controller** thread, sending _control messages_ to the server,
|
|
||||||
- the **receiver** thread (managed by the controller), receiving _device
|
|
||||||
messages_ from the server.
|
|
||||||
|
|
||||||
In addition, another thread can be started if necessary to handle APK
|
|
||||||
installation or file push requests (via drag&drop on the main window) or to
|
|
||||||
print the framerate regularly in the console.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Stream
|
|
||||||
|
|
||||||
The video [stream] is received from the socket (connected to the server on the
|
|
||||||
device) in a separate thread.
|
|
||||||
|
|
||||||
If a [decoder] is present (i.e. `--no-display` is not set), then it uses _libav_
|
|
||||||
to decode the H.264 stream from the socket, and notifies the main thread when a
|
|
||||||
new frame is available.
|
|
||||||
|
|
||||||
There are two [frames][video_buffer] simultaneously in memory:
|
|
||||||
- the **decoding** frame, written by the decoder from the decoder thread,
|
|
||||||
- the **rendering** frame, rendered in a texture from the main thread.
|
|
||||||
|
|
||||||
When a new decoded frame is available, the decoder _swaps_ the decoding and
|
|
||||||
rendering frame (with proper synchronization). Thus, it immediately starts
|
|
||||||
to decode a new frame while the main thread renders the last one.
|
|
||||||
|
|
||||||
If a [recorder] is present (i.e. `--record` is enabled), then it muxes the raw
|
|
||||||
H.264 packet to the output video file.
|
|
||||||
|
|
||||||
[stream]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/stream.h
|
|
||||||
[decoder]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/decoder.h
|
|
||||||
[video_buffer]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/video_buffer.h
|
|
||||||
[recorder]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/recorder.h
|
|
||||||
|
|
||||||
```
|
```
|
||||||
+----------+ +----------+
|
V4L2 sink
|
||||||
---> | decoder | ---> | screen |
|
/
|
||||||
+---------+ / +----------+ +----------+
|
decoder
|
||||||
socket ---> | stream | ----
|
/ \
|
||||||
+---------+ \ +----------+
|
VIDEO -------------> demuxer display
|
||||||
---> | recorder |
|
\
|
||||||
+----------+
|
recorder
|
||||||
|
/
|
||||||
|
AUDIO -------------> demuxer
|
||||||
|
\
|
||||||
|
decoder --- audio player
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The _demuxer_ is responsible to extract video and audio packets (read some
|
||||||
|
header, split the video stream into packets at correct boundaries, etc.).
|
||||||
|
|
||||||
|
The demuxed packets may be sent to a _decoder_ (one per stream, to produce
|
||||||
|
frames) and to a recorder (receiving both video and audio stream to record a
|
||||||
|
single file). The packets are encoded on the device (by `MediaCodec`), but when
|
||||||
|
recording, they are _muxed_ (asynchronously) into a container (MKV or MP4) on
|
||||||
|
the client side.
|
||||||
|
|
||||||
|
Video frames are sent to the screen/display to be rendered in the scrcpy window.
|
||||||
|
They may also be sent to a [V4L2 sink](v4l2.md).
|
||||||
|
|
||||||
|
Audio "frames" (an array of decoded samples) are sent to the audio player.
|
||||||
|
|
||||||
|
|
||||||
### Controller
|
### Controller
|
||||||
|
|
||||||
The [controller] is responsible to send _control messages_ to the device. It
|
The _controller_ is responsible to send _control messages_ to the device. It
|
||||||
runs in a separate thread, to avoid I/O on the main thread.
|
runs in a separate thread, to avoid I/O on the main thread.
|
||||||
|
|
||||||
On SDL event, received on the main thread, the [input manager][inputmanager]
|
On SDL event, received on the main thread, the _input manager_ creates
|
||||||
creates appropriate [_control messages_][controlmsg]. It is responsible to
|
appropriate _control messages_. It is responsible to convert SDL events to
|
||||||
convert SDL events to Android events (using [convert]). It pushes the _control
|
Android events. It then pushes the _control messages_ to a queue hold by the
|
||||||
messages_ to a queue hold by the controller. On its own thread, the controller
|
controller. On its own thread, the controller takes messages from the queue,
|
||||||
takes messages from the queue, that it serializes and sends to the client.
|
that it serializes and sends to the client.
|
||||||
|
|
||||||
[controller]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/controller.h
|
|
||||||
[controlmsg]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/control_msg.h
|
|
||||||
[inputmanager]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/input_manager.h
|
|
||||||
[convert]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/convert.h
|
|
||||||
|
|
||||||
|
|
||||||
### UI and event loop
|
## Protocol
|
||||||
|
|
||||||
Initialization, input events and rendering are all [managed][scrcpy] in the main
|
The protocol between the client and the server must be considered _internal_: it
|
||||||
thread.
|
may (and will) change at any time for any reason. Everything may change (the
|
||||||
|
number of sockets, the order in which the sockets must be opened, the data
|
||||||
|
format on the wire…) from version to version. A client must always be run with a
|
||||||
|
matching server version.
|
||||||
|
|
||||||
Events are handled in the [event loop], which either updates the [screen] or
|
This section documents the current protocol in scrcpy v2.1.
|
||||||
delegates to the [input manager][inputmanager].
|
|
||||||
|
|
||||||
[scrcpy]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/scrcpy.c
|
### Connection
|
||||||
[event loop]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/scrcpy.c#L201
|
|
||||||
[screen]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/screen.h
|
Firstly, the client sets up an adb tunnel:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# By default, a reverse redirection: the computer listens, the device connects
|
||||||
|
adb reverse localabstract:scrcpy_<SCID> tcp:27183
|
||||||
|
|
||||||
|
# As a fallback (or if --force-adb forward is set), a forward redirection:
|
||||||
|
# the device listens, the computer connects
|
||||||
|
adb forward tcp:27183 localabstract:scrcpy_<SCID>
|
||||||
|
```
|
||||||
|
|
||||||
|
(`<SCID>` is a 31-bit random number, so that it does not fail when several
|
||||||
|
scrcpy instances start "at the same time" for the same device.)
|
||||||
|
|
||||||
|
Then, up to 3 sockets are opened, in that order:
|
||||||
|
- a _video_ socket
|
||||||
|
- an _audio_ socket
|
||||||
|
- a _control_ socket
|
||||||
|
|
||||||
|
Each one may be disabled (respectively by `--no-video`, `--no-audio` and
|
||||||
|
`--no-control`, directly or indirectly). For example, if `--no-audio` is set,
|
||||||
|
then the _video_ socket is opened first, then the _control_ socket.
|
||||||
|
|
||||||
|
On the _first_ socket opened (whichever it is), if the tunnel is _forward_, then
|
||||||
|
a [dummy byte] is sent from the device to the client. This allows to detect a
|
||||||
|
connection error (the client connection does not fail as long as there is an adb
|
||||||
|
forward redirection, even if nothing is listening on the device side).
|
||||||
|
|
||||||
|
Still on this _first_ socket, the device sends some [metadata][device meta] to
|
||||||
|
the client (currently only the device name, used as the window title, but there
|
||||||
|
might be other fields in the future).
|
||||||
|
|
||||||
|
[dummy byte]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/DesktopConnection.java#L93
|
||||||
|
[device meta]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/DesktopConnection.java#L151
|
||||||
|
|
||||||
|
You can read the [client][client-connection] and [server][server-connection]
|
||||||
|
code for more details.
|
||||||
|
|
||||||
|
[client-connection]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/app/src/server.c#L465-L466
|
||||||
|
[server-connection]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/DesktopConnection.java#L63
|
||||||
|
|
||||||
|
Then each socket is used for its intended purpose.
|
||||||
|
|
||||||
|
### Video and audio
|
||||||
|
|
||||||
|
On the _video_ and _audio_ sockets, the device first sends some [codec
|
||||||
|
metadata]:
|
||||||
|
- On the _video_ socket, 12 bytes:
|
||||||
|
- the codec id (`u32`) (H264, H265 or AV1)
|
||||||
|
- the initial video width (`u32`)
|
||||||
|
- the initial video height (`u32`)
|
||||||
|
- On the _audio_ socket, 4 bytes:
|
||||||
|
- the codec id (`u32`) (OPUS, AAC or RAW)
|
||||||
|
|
||||||
|
[codec metadata]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/Streamer.java#L33-L51
|
||||||
|
|
||||||
|
Then each packet produced by `MediaCodec` is sent, prefixed by a 12-byte [frame
|
||||||
|
header]:
|
||||||
|
- config packet flag (`u1`)
|
||||||
|
- key frame flag (`u1`)
|
||||||
|
- PTS (`u62`)
|
||||||
|
- packet size (`u32`)
|
||||||
|
|
||||||
|
Here is a schema describing the frame header:
|
||||||
|
|
||||||
|
```
|
||||||
|
[. . . . . . . .|. . . .]. . . . . . . . . . . . . . . ...
|
||||||
|
<-------------> <-----> <-----------------------------...
|
||||||
|
PTS packet raw packet
|
||||||
|
size
|
||||||
|
<--------------------->
|
||||||
|
frame header
|
||||||
|
|
||||||
|
The most significant bits of the PTS are used for packet flags:
|
||||||
|
|
||||||
|
byte 7 byte 6 byte 5 byte 4 byte 3 byte 2 byte 1 byte 0
|
||||||
|
CK...... ........ ........ ........ ........ ........ ........ ........
|
||||||
|
^^<------------------------------------------------------------------->
|
||||||
|
|| PTS
|
||||||
|
| `- key frame
|
||||||
|
`-- config packet
|
||||||
|
```
|
||||||
|
|
||||||
|
[frame header]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/Streamer.java#L83
|
||||||
|
|
||||||
|
|
||||||
|
### Controls
|
||||||
|
|
||||||
|
Controls messages are sent via a custom binary protocol.
|
||||||
|
|
||||||
|
The only documentation for this protocol is the set of unit tests on both sides:
|
||||||
|
- `ControlMessage` (from client to device): [serialization](https://github.com/Genymobile/scrcpy/blob/master/app/tests/test_control_msg_serialize.c) | [deserialization](https://github.com/Genymobile/scrcpy/blob/master/server/src/test/java/com/genymobile/scrcpy/ControlMessageReaderTest.java)
|
||||||
|
- `DeviceMessage` (from device to client) [serialization](https://github.com/Genymobile/scrcpy/blob/master/server/src/test/java/com/genymobile/scrcpy/DeviceMessageWriterTest.java) | [deserialization](https://github.com/Genymobile/scrcpy/blob/master/app/tests/test_device_msg_deserialize.c)
|
||||||
|
|
||||||
|
|
||||||
|
## Standalone server
|
||||||
|
|
||||||
|
Although the server is designed to work for the scrcpy client, it can be used
|
||||||
|
with any client which uses the same protocol.
|
||||||
|
|
||||||
|
For simplicity, some [server-specific options] have been added to produce raw
|
||||||
|
streams easily:
|
||||||
|
- `send_device_meta=false`: disable the device metata (in practice, the device
|
||||||
|
name) sent on the _first_ socket
|
||||||
|
- `send_frame_meta=false`: disable the 12-byte header for each packet
|
||||||
|
- `send_dummy_byte`: disable the dummy byte sent on forward connections
|
||||||
|
- `send_codec_meta`: disable the codec information (and initial device size for
|
||||||
|
video)
|
||||||
|
- `raw_stream`: disable all the above
|
||||||
|
|
||||||
|
[server-specific options]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/Options.java#L309-L329
|
||||||
|
|
||||||
|
Concretely, here is how to expose a raw H.264 stream on a TCP socket:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
adb push scrcpy-server-v2.1 /data/local/tmp/scrcpy-server-manual.jar
|
||||||
|
adb forward tcp:1234 localabstract:scrcpy
|
||||||
|
adb shell CLASSPATH=/data/local/tmp/scrcpy-server-manual.jar \
|
||||||
|
app_process / com.genymobile.scrcpy.Server 2.1 \
|
||||||
|
tunnel_forward=true audio=false control=false cleanup=false \
|
||||||
|
raw_stream=true max_size=1920
|
||||||
|
```
|
||||||
|
|
||||||
|
As soon as a client connects over TCP on port 1234, the device will start
|
||||||
|
streaming the video. For example, VLC can play the video (although you will
|
||||||
|
experience a very high latency, more details [here][vlc-0latency]):
|
||||||
|
|
||||||
|
```
|
||||||
|
vlc -Idummy --demux=h264 --network-caching=0 tcp://localhost:1234
|
||||||
|
```
|
||||||
|
|
||||||
|
[vlc-0latency]: https://code.videolan.org/rom1v/vlc/-/merge_requests/20
|
||||||
|
|
||||||
|
|
||||||
## Hack
|
## Hack
|
||||||
|
158
doc/device.md
158
doc/device.md
@ -1,156 +1,9 @@
|
|||||||
# Device
|
# Device
|
||||||
|
|
||||||
## Selection
|
|
||||||
|
|
||||||
If exactly one device is connected (i.e. listed by `adb devices`), then it is
|
|
||||||
automatically selected.
|
|
||||||
|
|
||||||
However, if there are multiple devices connected, you must specify the one to
|
|
||||||
use in one of 4 ways:
|
|
||||||
- by its serial:
|
|
||||||
```bash
|
|
||||||
scrcpy --serial=0123456789abcdef
|
|
||||||
scrcpy -s 0123456789abcdef # short version
|
|
||||||
|
|
||||||
# the serial is the ip:port if connected over TCP/IP (same behavior as adb)
|
|
||||||
scrcpy --serial=192.168.1.1:5555
|
|
||||||
```
|
|
||||||
- the one connected over USB (if there is exactly one):
|
|
||||||
```bash
|
|
||||||
scrcpy --select-usb
|
|
||||||
scrcpy -d # short version
|
|
||||||
```
|
|
||||||
- the one connected over TCP/IP (if there is exactly one):
|
|
||||||
```bash
|
|
||||||
scrcpy --select-tcpip
|
|
||||||
scrcpy -e # short version
|
|
||||||
```
|
|
||||||
- a device already listening on TCP/IP (see [below](#tcpip-wireless)):
|
|
||||||
```bash
|
|
||||||
scrcpy --tcpip=192.168.1.1:5555
|
|
||||||
scrcpy --tcpip=192.168.1.1 # default port is 5555
|
|
||||||
```
|
|
||||||
|
|
||||||
The serial may also be provided via the environment variable `ANDROID_SERIAL`
|
|
||||||
(also used by `adb`):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# in bash
|
|
||||||
export ANDROID_SERIAL=0123456789abcdef
|
|
||||||
scrcpy
|
|
||||||
```
|
|
||||||
|
|
||||||
```cmd
|
|
||||||
:: in cmd
|
|
||||||
set ANDROID_SERIAL=0123456789abcdef
|
|
||||||
scrcpy
|
|
||||||
```
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
# in PowerShell
|
|
||||||
$env:ANDROID_SERIAL = '0123456789abcdef'
|
|
||||||
scrcpy
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## TCP/IP (wireless)
|
|
||||||
|
|
||||||
_Scrcpy_ uses `adb` to communicate with the device, and `adb` can [connect] to a
|
|
||||||
device over TCP/IP. The device must be connected on the same network as the
|
|
||||||
computer.
|
|
||||||
|
|
||||||
[connect]: https://developer.android.com/studio/command-line/adb.html#wireless
|
|
||||||
|
|
||||||
|
|
||||||
### Automatic
|
|
||||||
|
|
||||||
An option `--tcpip` allows to configure the connection automatically. There are
|
|
||||||
two variants.
|
|
||||||
|
|
||||||
If the device (accessible at 192.168.1.1 in this example) already listens on a
|
|
||||||
port (typically 5555) for incoming _adb_ connections, then run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scrcpy --tcpip=192.168.1.1 # default port is 5555
|
|
||||||
scrcpy --tcpip=192.168.1.1:5555
|
|
||||||
```
|
|
||||||
|
|
||||||
If _adb_ TCP/IP mode is disabled on the device (or if you don't know the IP
|
|
||||||
address), connect the device over USB, then run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scrcpy --tcpip # without arguments
|
|
||||||
```
|
|
||||||
|
|
||||||
It will automatically find the device IP address and adb port, enable TCP/IP
|
|
||||||
mode if necessary, then connect to the device before starting.
|
|
||||||
|
|
||||||
|
|
||||||
### Manual
|
|
||||||
|
|
||||||
Alternatively, it is possible to enable the TCP/IP connection manually using
|
|
||||||
`adb`:
|
|
||||||
|
|
||||||
1. Plug the device into a USB port on your computer.
|
|
||||||
2. Connect the device to the same Wi-Fi network as your computer.
|
|
||||||
3. Get your device IP address, in Settings → About phone → Status, or by
|
|
||||||
executing this command:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
adb shell ip route | awk '{print $9}'
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Enable `adb` over TCP/IP on your device: `adb tcpip 5555`.
|
|
||||||
5. Unplug your device.
|
|
||||||
6. Connect to your device: `adb connect DEVICE_IP:5555` _(replace `DEVICE_IP`
|
|
||||||
with the device IP address you found)_.
|
|
||||||
7. Run `scrcpy` as usual.
|
|
||||||
8. Run `adb disconnect` once you're done.
|
|
||||||
|
|
||||||
Since Android 11, a [wireless debugging option][adb-wireless] allows to bypass
|
|
||||||
having to physically connect your device directly to your computer.
|
|
||||||
|
|
||||||
[adb-wireless]: https://developer.android.com/studio/command-line/adb#wireless-android11-command-line
|
|
||||||
|
|
||||||
|
|
||||||
## Autostart
|
|
||||||
|
|
||||||
A small tool (by the scrcpy author) allows to run arbitrary commands whenever a
|
|
||||||
new Android device is connected: [AutoAdb]. It can be used to start scrcpy:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
autoadb scrcpy -s '{}'
|
|
||||||
```
|
|
||||||
|
|
||||||
[AutoAdb]: https://github.com/rom1v/autoadb
|
|
||||||
|
|
||||||
|
|
||||||
## 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).
|
|
||||||
|
|
||||||
|
|
||||||
## Actions
|
|
||||||
|
|
||||||
Some command line arguments perform actions on the device itself while scrcpy is
|
Some command line arguments perform actions on the device itself while scrcpy is
|
||||||
running.
|
running.
|
||||||
|
|
||||||
|
## Stay awake
|
||||||
### Stay awake
|
|
||||||
|
|
||||||
To prevent the device from sleeping after a delay **when the device is plugged
|
To prevent the device from sleeping after a delay **when the device is plugged
|
||||||
in**:
|
in**:
|
||||||
@ -166,7 +19,7 @@ If the device is not plugged in (i.e. only connected over TCP/IP),
|
|||||||
`--stay-awake` has no effect (this is the Android behavior).
|
`--stay-awake` has no effect (this is the Android behavior).
|
||||||
|
|
||||||
|
|
||||||
### Turn screen off
|
## Turn screen off
|
||||||
|
|
||||||
It is possible to turn the device screen off while mirroring on start with a
|
It is possible to turn the device screen off while mirroring on start with a
|
||||||
command-line option:
|
command-line option:
|
||||||
@ -194,7 +47,7 @@ scrcpy -Sw # short version
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### Show touches
|
## Show touches
|
||||||
|
|
||||||
For presentations, it may be useful to show physical touches (on the physical
|
For presentations, it may be useful to show physical touches (on the physical
|
||||||
device). Android exposes this feature in _Developers options_.
|
device). Android exposes this feature in _Developers options_.
|
||||||
@ -210,7 +63,7 @@ scrcpy -t # short version
|
|||||||
Note that it only shows _physical_ touches (by a finger on the device).
|
Note that it only shows _physical_ touches (by a finger on the device).
|
||||||
|
|
||||||
|
|
||||||
### Power off on close
|
## Power off on close
|
||||||
|
|
||||||
To turn the device screen off when closing _scrcpy_:
|
To turn the device screen off when closing _scrcpy_:
|
||||||
|
|
||||||
@ -218,11 +71,10 @@ To turn the device screen off when closing _scrcpy_:
|
|||||||
scrcpy --power-off-on-close
|
scrcpy --power-off-on-close
|
||||||
```
|
```
|
||||||
|
|
||||||
### Power on on start
|
## Power on on start
|
||||||
|
|
||||||
By default, on start, the device is powered on. To prevent this behavior:
|
By default, on start, the device is powered on. To prevent this behavior:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
scrcpy --no-power-on
|
scrcpy --no-power-on
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -106,3 +106,7 @@ scrcpy --otg # keyboard and mouse
|
|||||||
|
|
||||||
Like `--hid-keyboard` and `--hid-mouse`, it only works if the device is
|
Like `--hid-keyboard` and `--hid-mouse`, it only works if the device is
|
||||||
connected over USB.
|
connected over USB.
|
||||||
|
|
||||||
|
## HID/OTG issues on Windows
|
||||||
|
|
||||||
|
See [FAQ](/FAQ.md#hidotg-issues-on-windows).
|
||||||
|
@ -9,12 +9,10 @@ Scrcpy is packaged in several distributions and package managers:
|
|||||||
- Debian/Ubuntu: `apt install scrcpy`
|
- Debian/Ubuntu: `apt install scrcpy`
|
||||||
- Arch Linux: `pacman -S scrcpy`
|
- Arch Linux: `pacman -S scrcpy`
|
||||||
- Fedora: `dnf copr enable zeno/scrcpy && dnf install scrcpy`
|
- Fedora: `dnf copr enable zeno/scrcpy && dnf install scrcpy`
|
||||||
- Gentoo: [ebuild][ebuild-link] file
|
- Gentoo: `emerge scrcpy`
|
||||||
- Snap: `snap install scrcpy`
|
- Snap: `snap install scrcpy`
|
||||||
- … (see [repology](https://repology.org/project/scrcpy/versions))
|
- … (see [repology](https://repology.org/project/scrcpy/versions))
|
||||||
|
|
||||||
[ebuild-link]: https://github.com/maggu2810/maggu2810-overlay/tree/master/app-mobilephone/scrcpy
|
|
||||||
|
|
||||||
### Latest version
|
### Latest version
|
||||||
|
|
||||||
However, the packaged version is not always the latest release. To install the
|
However, the packaged version is not always the latest release. To install the
|
||||||
|
@ -29,7 +29,7 @@ _<kbd>[Super]</kbd> is typically the <kbd>Windows</kbd> or <kbd>Cmd</kbd> key._
|
|||||||
| Resize window to 1:1 (pixel-perfect) | <kbd>MOD</kbd>+<kbd>g</kbd>
|
| Resize window to 1:1 (pixel-perfect) | <kbd>MOD</kbd>+<kbd>g</kbd>
|
||||||
| Resize window to remove black borders | <kbd>MOD</kbd>+<kbd>w</kbd> \| _Double-left-click¹_
|
| Resize window to remove black borders | <kbd>MOD</kbd>+<kbd>w</kbd> \| _Double-left-click¹_
|
||||||
| Click on `HOME` | <kbd>MOD</kbd>+<kbd>h</kbd> \| _Middle-click_
|
| Click on `HOME` | <kbd>MOD</kbd>+<kbd>h</kbd> \| _Middle-click_
|
||||||
| Click on `BACK` | <kbd>MOD</kbd>+<kbd>b</kbd> \| _Right-click²_
|
| Click on `BACK` | <kbd>MOD</kbd>+<kbd>b</kbd> \| <kbd>MOD</kbd>+<kbd>Backspace</kbd> \| _Right-click²_
|
||||||
| Click on `APP_SWITCH` | <kbd>MOD</kbd>+<kbd>s</kbd> \| _4th-click³_
|
| Click on `APP_SWITCH` | <kbd>MOD</kbd>+<kbd>s</kbd> \| _4th-click³_
|
||||||
| Click on `MENU` (unlock screen)⁴ | <kbd>MOD</kbd>+<kbd>m</kbd>
|
| Click on `MENU` (unlock screen)⁴ | <kbd>MOD</kbd>+<kbd>m</kbd>
|
||||||
| Click on `VOLUME_UP` | <kbd>MOD</kbd>+<kbd>↑</kbd> _(up)_
|
| Click on `VOLUME_UP` | <kbd>MOD</kbd>+<kbd>↑</kbd> _(up)_
|
||||||
|
34
doc/video.md
34
doc/video.md
@ -21,7 +21,7 @@ If encoding fails, scrcpy automatically tries again with a lower definition
|
|||||||
|
|
||||||
## Bit rate
|
## Bit rate
|
||||||
|
|
||||||
The default video bit-rate is 8 Mbps. To change it:
|
The default video bit rate is 8 Mbps. To change it:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
scrcpy --video-bit-rate=2M
|
scrcpy --video-bit-rate=2M
|
||||||
@ -66,6 +66,14 @@ scrcpy --video-codec=av1
|
|||||||
H265 may provide better quality, but H264 should provide lower latency.
|
H265 may provide better quality, but H264 should provide lower latency.
|
||||||
AV1 encoders are not common on current Android devices.
|
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:
|
Several encoders may be available on the device. They can be listed by:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@ -79,11 +87,6 @@ try another one:
|
|||||||
scrcpy --video-codec=h264 --video-encoder='OMX.qcom.video.encoder.avc'
|
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
|
## Rotation
|
||||||
|
|
||||||
@ -134,6 +137,25 @@ phone, landscape for a tablet).
|
|||||||
If `--max-size` is also specified, resizing is applied after cropping.
|
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
|
## Buffering
|
||||||
|
|
||||||
By default, there is no video buffering, to get the lowest possible latency.
|
By default, there is no video buffering, to get the lowest possible latency.
|
||||||
|
@ -4,18 +4,24 @@
|
|||||||
|
|
||||||
Download the [latest release]:
|
Download the [latest release]:
|
||||||
|
|
||||||
- [`scrcpy-win64-v2.0.zip`][direct-win64] (64-bit)
|
- [`scrcpy-win64-v2.1.1.zip`][direct-win64] (64-bit)
|
||||||
<sub>SHA-256: `ae4c8d37a496b43f8974ba8f07f708e22a9570ba0cddc3dc3a36edbccd4d2a20`</sub>
|
<sub>SHA-256: `f77281e1bce2f9934617699c581f063d5b327f012eff602ee98fb2ef550c25c2`</sub>
|
||||||
- [`scrcpy-win32-v2.0.zip`][direct-win32] (32-bit)
|
- [`scrcpy-win32-v2.1.1.zip`][direct-win32] (32-bit)
|
||||||
<sub>SHA-256: `15d98c02cb0e0bbd84f8b5d54991e0f6925569b1286a86a40743944fcb1c2d8c`</sub>
|
<sub>SHA-256: `ef7ae7fbe9449f2643febdc2244fb186d1a746a3c736394150cfd14f06d3c943`</sub>
|
||||||
|
|
||||||
[latest release]: https://github.com/Genymobile/scrcpy/releases/latest
|
[latest release]: https://github.com/Genymobile/scrcpy/releases/latest
|
||||||
[direct-win64]: https://github.com/Genymobile/scrcpy/releases/download/v2.0/scrcpy-win64-v2.0.zip
|
[direct-win64]: https://github.com/Genymobile/scrcpy/releases/download/v2.1.1/scrcpy-win64-v2.1.1.zip
|
||||||
[direct-win32]: https://github.com/Genymobile/scrcpy/releases/download/v2.0/scrcpy-win32-v2.0.zip
|
[direct-win32]: https://github.com/Genymobile/scrcpy/releases/download/v2.1.1/scrcpy-win32-v2.1.1.zip
|
||||||
|
|
||||||
and extract it.
|
and extract it.
|
||||||
|
|
||||||
Alternatively, you could install it from packages manager, like [Chocolatey]:
|
Alternatively, you could install it from packages manager, like [Winget]:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
winget install scrcpy
|
||||||
|
```
|
||||||
|
|
||||||
|
or [Chocolatey]:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
choco install scrcpy
|
choco install scrcpy
|
||||||
@ -30,6 +36,7 @@ scoop install scrcpy
|
|||||||
scoop install adb # if you don't have it yet
|
scoop install adb # if you don't have it yet
|
||||||
```
|
```
|
||||||
|
|
||||||
|
[Winget]: https://github.com/microsoft/winget-cli
|
||||||
[Chocolatey]: https://chocolatey.org/
|
[Chocolatey]: https://chocolatey.org/
|
||||||
[Scoop]: https://scoop.sh
|
[Scoop]: https://scoop.sh
|
||||||
|
|
||||||
|
@ -2,8 +2,8 @@
|
|||||||
set -e
|
set -e
|
||||||
|
|
||||||
BUILDDIR=build-auto
|
BUILDDIR=build-auto
|
||||||
PREBUILT_SERVER_URL=https://github.com/Genymobile/scrcpy/releases/download/v2.0/scrcpy-server-v2.0
|
PREBUILT_SERVER_URL=https://github.com/Genymobile/scrcpy/releases/download/v2.1.1/scrcpy-server-v2.1.1
|
||||||
PREBUILT_SERVER_SHA256=9e241615f578cd690bb43311000debdecf6a9c50a7082b001952f18f6f21ddc2
|
PREBUILT_SERVER_SHA256=9558db6c56743a1dc03b38f59801fb40e91cc891f8fc0c89e5b0b067761f148e
|
||||||
|
|
||||||
echo "[scrcpy] Downloading prebuilt server..."
|
echo "[scrcpy] Downloading prebuilt server..."
|
||||||
wget "$PREBUILT_SERVER_URL" -O scrcpy-server
|
wget "$PREBUILT_SERVER_URL" -O scrcpy-server
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
project('scrcpy', 'c',
|
project('scrcpy', 'c',
|
||||||
version: '2.0',
|
version: '2.1.1',
|
||||||
meson_version: '>= 0.48',
|
meson_version: '>= 0.48',
|
||||||
default_options: [
|
default_options: [
|
||||||
'c_std=c11',
|
'c_std=c11',
|
||||||
|
16
release.mk
16
release.mk
@ -98,10 +98,10 @@ dist-win32: build-server build-win32
|
|||||||
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win32/bin/avcodec-60.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win32/bin/avcodec-60.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win32/bin/avformat-60.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win32/bin/avformat-60.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win32/bin/swresample-4.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win32/bin/swresample-4.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/platform-tools-34.0.1/adb.exe "$(DIST)/$(WIN32_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/platform-tools-34.0.3/adb.exe "$(DIST)/$(WIN32_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/platform-tools-34.0.1/AdbWinApi.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/platform-tools-34.0.3/AdbWinApi.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/platform-tools-34.0.1/AdbWinUsbApi.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/platform-tools-34.0.3/AdbWinUsbApi.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/SDL2-2.26.4/i686-w64-mingw32/bin/SDL2.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/SDL2-2.28.0/i686-w64-mingw32/bin/SDL2.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/libusb-1.0.26/libusb-MinGW-Win32/bin/msys-usb-1.0.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/libusb-1.0.26/libusb-MinGW-Win32/bin/msys-usb-1.0.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
|
||||||
|
|
||||||
dist-win64: build-server build-win64
|
dist-win64: build-server build-win64
|
||||||
@ -116,10 +116,10 @@ dist-win64: build-server build-win64
|
|||||||
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win64/bin/avcodec-60.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win64/bin/avcodec-60.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win64/bin/avformat-60.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win64/bin/avformat-60.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win64/bin/swresample-4.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win64/bin/swresample-4.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/platform-tools-34.0.1/adb.exe "$(DIST)/$(WIN64_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/platform-tools-34.0.3/adb.exe "$(DIST)/$(WIN64_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/platform-tools-34.0.1/AdbWinApi.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/platform-tools-34.0.3/AdbWinApi.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/platform-tools-34.0.1/AdbWinUsbApi.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/platform-tools-34.0.3/AdbWinUsbApi.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/SDL2-2.26.4/x86_64-w64-mingw32/bin/SDL2.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/SDL2-2.28.0/x86_64-w64-mingw32/bin/SDL2.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
||||||
cp app/prebuilt-deps/data/libusb-1.0.26/libusb-MinGW-x64/bin/msys-usb-1.0.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
cp app/prebuilt-deps/data/libusb-1.0.26/libusb-MinGW-x64/bin/msys-usb-1.0.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
|
||||||
|
|
||||||
zip-win32: dist-win32
|
zip-win32: dist-win32
|
||||||
|
@ -7,8 +7,8 @@ android {
|
|||||||
applicationId "com.genymobile.scrcpy"
|
applicationId "com.genymobile.scrcpy"
|
||||||
minSdkVersion 21
|
minSdkVersion 21
|
||||||
targetSdkVersion 33
|
targetSdkVersion 33
|
||||||
versionCode 20000
|
versionCode 20101
|
||||||
versionName "2.0"
|
versionName "2.1.1"
|
||||||
testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
|
testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
|
||||||
}
|
}
|
||||||
buildTypes {
|
buildTypes {
|
||||||
|
@ -12,7 +12,7 @@
|
|||||||
set -e
|
set -e
|
||||||
|
|
||||||
SCRCPY_DEBUG=false
|
SCRCPY_DEBUG=false
|
||||||
SCRCPY_VERSION_NAME=2.0
|
SCRCPY_VERSION_NAME=2.1.1
|
||||||
|
|
||||||
PLATFORM=${ANDROID_PLATFORM:-33}
|
PLATFORM=${ANDROID_PLATFORM:-33}
|
||||||
BUILD_TOOLS=${ANDROID_BUILD_TOOLS:-33.0.0}
|
BUILD_TOOLS=${ANDROID_BUILD_TOOLS:-33.0.0}
|
||||||
@ -48,6 +48,7 @@ cd "$SERVER_DIR/src/main/aidl"
|
|||||||
"$BUILD_TOOLS_DIR/aidl" -o"$GEN_DIR" android/view/IRotationWatcher.aidl
|
"$BUILD_TOOLS_DIR/aidl" -o"$GEN_DIR" android/view/IRotationWatcher.aidl
|
||||||
"$BUILD_TOOLS_DIR/aidl" -o"$GEN_DIR" \
|
"$BUILD_TOOLS_DIR/aidl" -o"$GEN_DIR" \
|
||||||
android/content/IOnPrimaryClipChangedListener.aidl
|
android/content/IOnPrimaryClipChangedListener.aidl
|
||||||
|
"$BUILD_TOOLS_DIR/aidl" -o"$GEN_DIR" android/view/IDisplayFoldListener.aidl
|
||||||
|
|
||||||
echo "Compiling java sources..."
|
echo "Compiling java sources..."
|
||||||
cd ../java
|
cd ../java
|
||||||
|
@ -118,7 +118,7 @@ public final class AudioCapture {
|
|||||||
if (Build.VERSION.SDK_INT == Build.VERSION_CODES.R) {
|
if (Build.VERSION.SDK_INT == Build.VERSION_CODES.R) {
|
||||||
startWorkaroundAndroid11();
|
startWorkaroundAndroid11();
|
||||||
try {
|
try {
|
||||||
tryStartRecording(3, 100);
|
tryStartRecording(5, 100);
|
||||||
} finally {
|
} finally {
|
||||||
stopWorkaroundAndroid11();
|
stopWorkaroundAndroid11();
|
||||||
}
|
}
|
||||||
|
@ -64,8 +64,6 @@ public final class DesktopConnection implements Closeable {
|
|||||||
throws IOException {
|
throws IOException {
|
||||||
String socketName = getSocketName(scid);
|
String socketName = getSocketName(scid);
|
||||||
|
|
||||||
LocalSocket firstSocket = null;
|
|
||||||
|
|
||||||
LocalSocket videoSocket = null;
|
LocalSocket videoSocket = null;
|
||||||
LocalSocket audioSocket = null;
|
LocalSocket audioSocket = null;
|
||||||
LocalSocket controlSocket = null;
|
LocalSocket controlSocket = null;
|
||||||
@ -74,23 +72,27 @@ public final class DesktopConnection implements Closeable {
|
|||||||
try (LocalServerSocket localServerSocket = new LocalServerSocket(socketName)) {
|
try (LocalServerSocket localServerSocket = new LocalServerSocket(socketName)) {
|
||||||
if (video) {
|
if (video) {
|
||||||
videoSocket = localServerSocket.accept();
|
videoSocket = localServerSocket.accept();
|
||||||
firstSocket = videoSocket;
|
if (sendDummyByte) {
|
||||||
|
// send one byte so the client may read() to detect a connection error
|
||||||
|
videoSocket.getOutputStream().write(0);
|
||||||
|
sendDummyByte = false;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if (audio) {
|
if (audio) {
|
||||||
audioSocket = localServerSocket.accept();
|
audioSocket = localServerSocket.accept();
|
||||||
if (firstSocket == null) {
|
if (sendDummyByte) {
|
||||||
firstSocket = audioSocket;
|
// send one byte so the client may read() to detect a connection error
|
||||||
|
audioSocket.getOutputStream().write(0);
|
||||||
|
sendDummyByte = false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (control) {
|
if (control) {
|
||||||
controlSocket = localServerSocket.accept();
|
controlSocket = localServerSocket.accept();
|
||||||
if (firstSocket == null) {
|
|
||||||
firstSocket = controlSocket;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (sendDummyByte) {
|
if (sendDummyByte) {
|
||||||
// send one byte so the client may read() to detect a connection error
|
// send one byte so the client may read() to detect a connection error
|
||||||
firstSocket.getOutputStream().write(0);
|
controlSocket.getOutputStream().write(0);
|
||||||
|
sendDummyByte = false;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
|
@ -99,9 +99,15 @@ public final class Device {
|
|||||||
}
|
}
|
||||||
}, displayId);
|
}, displayId);
|
||||||
|
|
||||||
|
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
|
||||||
ServiceManager.getWindowManager().registerDisplayFoldListener(new IDisplayFoldListener.Stub() {
|
ServiceManager.getWindowManager().registerDisplayFoldListener(new IDisplayFoldListener.Stub() {
|
||||||
@Override
|
@Override
|
||||||
public void onDisplayFoldChanged(int displayId, boolean folded) {
|
public void onDisplayFoldChanged(int displayId, boolean folded) {
|
||||||
|
if (Device.this.displayId != displayId) {
|
||||||
|
// Ignore events related to other display ids
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
synchronized (Device.this) {
|
synchronized (Device.this) {
|
||||||
DisplayInfo displayInfo = ServiceManager.getDisplayManager().getDisplayInfo(displayId);
|
DisplayInfo displayInfo = ServiceManager.getDisplayManager().getDisplayInfo(displayId);
|
||||||
if (displayInfo == null) {
|
if (displayInfo == null) {
|
||||||
@ -118,6 +124,7 @@ public final class Device {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
}
|
||||||
|
|
||||||
if (options.getControl() && options.getClipboardAutosync()) {
|
if (options.getControl() && options.getClipboardAutosync()) {
|
||||||
// If control and autosync are enabled, synchronize Android clipboard to the computer automatically
|
// If control and autosync are enabled, synchronize Android clipboard to the computer automatically
|
||||||
|
@ -2,11 +2,11 @@ package com.genymobile.scrcpy;
|
|||||||
|
|
||||||
import android.annotation.TargetApi;
|
import android.annotation.TargetApi;
|
||||||
import android.content.AttributionSource;
|
import android.content.AttributionSource;
|
||||||
import android.content.ContextWrapper;
|
import android.content.MutableContextWrapper;
|
||||||
import android.os.Build;
|
import android.os.Build;
|
||||||
import android.os.Process;
|
import android.os.Process;
|
||||||
|
|
||||||
public final class FakeContext extends ContextWrapper {
|
public final class FakeContext extends MutableContextWrapper {
|
||||||
|
|
||||||
public static final String PACKAGE_NAME = "com.android.shell";
|
public static final String PACKAGE_NAME = "com.android.shell";
|
||||||
public static final int ROOT_UID = 0; // Like android.os.Process.ROOT_UID, but before API 29
|
public static final int ROOT_UID = 0; // Like android.os.Process.ROOT_UID, but before API 29
|
||||||
|
@ -8,6 +8,7 @@ import android.media.MediaCodecInfo;
|
|||||||
import android.media.MediaFormat;
|
import android.media.MediaFormat;
|
||||||
import android.os.Build;
|
import android.os.Build;
|
||||||
import android.os.IBinder;
|
import android.os.IBinder;
|
||||||
|
import android.os.Looper;
|
||||||
import android.os.SystemClock;
|
import android.os.SystemClock;
|
||||||
import android.view.Surface;
|
import android.view.Surface;
|
||||||
|
|
||||||
@ -147,7 +148,6 @@ public class ScreenEncoder implements Device.RotationListener, Device.FoldListen
|
|||||||
// Downsizing on error is only enabled if an encoding failure occurs before the first frame (downsizing later could be surprising)
|
// Downsizing on error is only enabled if an encoding failure occurs before the first frame (downsizing later could be surprising)
|
||||||
|
|
||||||
int newMaxSize = chooseMaxSizeFallback(screenInfo.getVideoSize());
|
int newMaxSize = chooseMaxSizeFallback(screenInfo.getVideoSize());
|
||||||
Ln.i("newMaxSize = " + newMaxSize);
|
|
||||||
if (newMaxSize == 0) {
|
if (newMaxSize == 0) {
|
||||||
// Must definitively fail
|
// Must definitively fail
|
||||||
return false;
|
return false;
|
||||||
@ -286,6 +286,10 @@ public class ScreenEncoder implements Device.RotationListener, Device.FoldListen
|
|||||||
@Override
|
@Override
|
||||||
public void start(TerminationListener listener) {
|
public void start(TerminationListener listener) {
|
||||||
thread = new Thread(() -> {
|
thread = new Thread(() -> {
|
||||||
|
// Some devices (Meizu) deadlock if the video encoding thread has no Looper
|
||||||
|
// <https://github.com/Genymobile/scrcpy/issues/4143>
|
||||||
|
Looper.prepare();
|
||||||
|
|
||||||
try {
|
try {
|
||||||
streamScreen();
|
streamScreen();
|
||||||
} catch (ConfigurationException e) {
|
} catch (ConfigurationException e) {
|
||||||
|
@ -99,26 +99,7 @@ public final class Server {
|
|||||||
boolean audio = options.getAudio();
|
boolean audio = options.getAudio();
|
||||||
boolean sendDummyByte = options.getSendDummyByte();
|
boolean sendDummyByte = options.getSendDummyByte();
|
||||||
|
|
||||||
Workarounds.prepareMainLooper();
|
Workarounds.apply(audio);
|
||||||
|
|
||||||
// Workarounds must be applied for Meizu phones:
|
|
||||||
// - <https://github.com/Genymobile/scrcpy/issues/240>
|
|
||||||
// - <https://github.com/Genymobile/scrcpy/issues/365>
|
|
||||||
// - <https://github.com/Genymobile/scrcpy/issues/2656>
|
|
||||||
//
|
|
||||||
// But only apply when strictly necessary, since workarounds can cause other issues:
|
|
||||||
// - <https://github.com/Genymobile/scrcpy/issues/940>
|
|
||||||
// - <https://github.com/Genymobile/scrcpy/issues/994>
|
|
||||||
if (Build.BRAND.equalsIgnoreCase("meizu")) {
|
|
||||||
Workarounds.fillAppInfo();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Before Android 11, audio is not supported.
|
|
||||||
// Since Android 12, we can properly set a context on the AudioRecord.
|
|
||||||
// Only on Android 11 we must fill the application context for the AudioRecord to work.
|
|
||||||
if (audio && Build.VERSION.SDK_INT == Build.VERSION_CODES.R) {
|
|
||||||
Workarounds.fillAppContext();
|
|
||||||
}
|
|
||||||
|
|
||||||
List<AsyncProcessor> asyncProcessors = new ArrayList<>();
|
List<AsyncProcessor> asyncProcessors = new ArrayList<>();
|
||||||
|
|
||||||
|
@ -4,6 +4,7 @@ import android.annotation.SuppressLint;
|
|||||||
import android.annotation.TargetApi;
|
import android.annotation.TargetApi;
|
||||||
import android.app.Application;
|
import android.app.Application;
|
||||||
import android.content.AttributionSource;
|
import android.content.AttributionSource;
|
||||||
|
import android.content.Context;
|
||||||
import android.content.ContextWrapper;
|
import android.content.ContextWrapper;
|
||||||
import android.content.pm.ApplicationInfo;
|
import android.content.pm.ApplicationInfo;
|
||||||
import android.media.AudioAttributes;
|
import android.media.AudioAttributes;
|
||||||
@ -27,8 +28,56 @@ public final class Workarounds {
|
|||||||
// not instantiable
|
// not instantiable
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public static void apply(boolean audio) {
|
||||||
|
Workarounds.prepareMainLooper();
|
||||||
|
|
||||||
|
boolean mustFillAppInfo = false;
|
||||||
|
boolean mustFillBaseContext = false;
|
||||||
|
boolean mustFillAppContext = false;
|
||||||
|
|
||||||
|
|
||||||
|
if (Build.BRAND.equalsIgnoreCase("meizu")) {
|
||||||
|
// Workarounds must be applied for Meizu phones:
|
||||||
|
// - <https://github.com/Genymobile/scrcpy/issues/240>
|
||||||
|
// - <https://github.com/Genymobile/scrcpy/issues/365>
|
||||||
|
// - <https://github.com/Genymobile/scrcpy/issues/2656>
|
||||||
|
//
|
||||||
|
// But only apply when strictly necessary, since workarounds can cause other issues:
|
||||||
|
// - <https://github.com/Genymobile/scrcpy/issues/940>
|
||||||
|
// - <https://github.com/Genymobile/scrcpy/issues/994>
|
||||||
|
mustFillAppInfo = true;
|
||||||
|
} else if (Build.BRAND.equalsIgnoreCase("honor")) {
|
||||||
|
// More workarounds must be applied for Honor devices:
|
||||||
|
// - <https://github.com/Genymobile/scrcpy/issues/4015>
|
||||||
|
//
|
||||||
|
// The system context must not be set for all devices, because it would cause other problems:
|
||||||
|
// - <https://github.com/Genymobile/scrcpy/issues/4015#issuecomment-1595382142>
|
||||||
|
// - <https://github.com/Genymobile/scrcpy/issues/3805#issuecomment-1596148031>
|
||||||
|
mustFillAppInfo = true;
|
||||||
|
mustFillBaseContext = true;
|
||||||
|
mustFillAppContext = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (audio && Build.VERSION.SDK_INT == Build.VERSION_CODES.R) {
|
||||||
|
// Before Android 11, audio is not supported.
|
||||||
|
// Since Android 12, we can properly set a context on the AudioRecord.
|
||||||
|
// Only on Android 11 we must fill the application context for the AudioRecord to work.
|
||||||
|
mustFillAppContext = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (mustFillAppInfo) {
|
||||||
|
Workarounds.fillAppInfo();
|
||||||
|
}
|
||||||
|
if (mustFillBaseContext) {
|
||||||
|
Workarounds.fillBaseContext();
|
||||||
|
}
|
||||||
|
if (mustFillAppContext) {
|
||||||
|
Workarounds.fillAppContext();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
@SuppressWarnings("deprecation")
|
@SuppressWarnings("deprecation")
|
||||||
public static void prepareMainLooper() {
|
private static void prepareMainLooper() {
|
||||||
// Some devices internally create a Handler when creating an input Surface, causing an exception:
|
// Some devices internally create a Handler when creating an input Surface, causing an exception:
|
||||||
// "Can't create handler inside thread that has not called Looper.prepare()"
|
// "Can't create handler inside thread that has not called Looper.prepare()"
|
||||||
// <https://github.com/Genymobile/scrcpy/issues/240>
|
// <https://github.com/Genymobile/scrcpy/issues/240>
|
||||||
@ -57,7 +106,7 @@ public final class Workarounds {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
||||||
public static void fillAppInfo() {
|
private static void fillAppInfo() {
|
||||||
try {
|
try {
|
||||||
fillActivityThread();
|
fillActivityThread();
|
||||||
|
|
||||||
@ -86,7 +135,7 @@ public final class Workarounds {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
||||||
public static void fillAppContext() {
|
private static void fillAppContext() {
|
||||||
try {
|
try {
|
||||||
fillActivityThread();
|
fillActivityThread();
|
||||||
|
|
||||||
@ -105,6 +154,19 @@ public final class Workarounds {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private static void fillBaseContext() {
|
||||||
|
try {
|
||||||
|
fillActivityThread();
|
||||||
|
|
||||||
|
Method getSystemContextMethod = activityThreadClass.getDeclaredMethod("getSystemContext");
|
||||||
|
Context context = (Context) getSystemContextMethod.invoke(activityThread);
|
||||||
|
FakeContext.get().setBaseContext(context);
|
||||||
|
} catch (Throwable throwable) {
|
||||||
|
// this is a workaround, so failing is not an error
|
||||||
|
Ln.d("Could not fill base context: " + throwable.getMessage());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
@TargetApi(Build.VERSION_CODES.R)
|
@TargetApi(Build.VERSION_CODES.R)
|
||||||
@SuppressLint("WrongConstant,MissingPermission,BlockedPrivateApi,SoonBlockedPrivateApi,DiscouragedPrivateApi")
|
@SuppressLint("WrongConstant,MissingPermission,BlockedPrivateApi,SoonBlockedPrivateApi,DiscouragedPrivateApi")
|
||||||
public static AudioRecord createAudioRecord(int source, int sampleRate, int channelConfig, int channels, int channelMask, int encoding) {
|
public static AudioRecord createAudioRecord(int source, int sampleRate, int channelConfig, int channels, int channelMask, int encoding) {
|
||||||
|
@ -17,7 +17,7 @@ import java.lang.reflect.InvocationTargetException;
|
|||||||
import java.lang.reflect.Method;
|
import java.lang.reflect.Method;
|
||||||
|
|
||||||
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
||||||
public class ActivityManager {
|
public final class ActivityManager {
|
||||||
|
|
||||||
private final IInterface manager;
|
private final IInterface manager;
|
||||||
private Method getContentProviderExternalMethod;
|
private Method getContentProviderExternalMethod;
|
||||||
|
@ -11,7 +11,7 @@ import android.os.IInterface;
|
|||||||
import java.lang.reflect.InvocationTargetException;
|
import java.lang.reflect.InvocationTargetException;
|
||||||
import java.lang.reflect.Method;
|
import java.lang.reflect.Method;
|
||||||
|
|
||||||
public class ClipboardManager {
|
public final class ClipboardManager {
|
||||||
private final IInterface manager;
|
private final IInterface manager;
|
||||||
private Method getPrimaryClipMethod;
|
private Method getPrimaryClipMethod;
|
||||||
private Method setPrimaryClipMethod;
|
private Method setPrimaryClipMethod;
|
||||||
|
@ -14,7 +14,7 @@ import java.io.Closeable;
|
|||||||
import java.lang.reflect.InvocationTargetException;
|
import java.lang.reflect.InvocationTargetException;
|
||||||
import java.lang.reflect.Method;
|
import java.lang.reflect.Method;
|
||||||
|
|
||||||
public class ContentProvider implements Closeable {
|
public final class ContentProvider implements Closeable {
|
||||||
|
|
||||||
public static final String TABLE_SYSTEM = "system";
|
public static final String TABLE_SYSTEM = "system";
|
||||||
public static final String TABLE_SECURE = "secure";
|
public static final String TABLE_SECURE = "secure";
|
||||||
|
@ -7,7 +7,7 @@ import android.os.IInterface;
|
|||||||
import java.lang.reflect.InvocationTargetException;
|
import java.lang.reflect.InvocationTargetException;
|
||||||
import java.lang.reflect.Method;
|
import java.lang.reflect.Method;
|
||||||
|
|
||||||
public class StatusBarManager {
|
public final class StatusBarManager {
|
||||||
|
|
||||||
private final IInterface manager;
|
private final IInterface manager;
|
||||||
private Method expandNotificationsPanelMethod;
|
private Method expandNotificationsPanelMethod;
|
||||||
|
@ -2,6 +2,7 @@ package com.genymobile.scrcpy.wrappers;
|
|||||||
|
|
||||||
import com.genymobile.scrcpy.Ln;
|
import com.genymobile.scrcpy.Ln;
|
||||||
|
|
||||||
|
import android.annotation.TargetApi;
|
||||||
import android.os.IInterface;
|
import android.os.IInterface;
|
||||||
import android.view.IRotationWatcher;
|
import android.view.IRotationWatcher;
|
||||||
import android.view.IDisplayFoldListener;
|
import android.view.IDisplayFoldListener;
|
||||||
@ -106,16 +107,17 @@ public final class WindowManager {
|
|||||||
cls.getMethod("watchRotation", IRotationWatcher.class).invoke(manager, rotationWatcher);
|
cls.getMethod("watchRotation", IRotationWatcher.class).invoke(manager, rotationWatcher);
|
||||||
}
|
}
|
||||||
} catch (Exception e) {
|
} catch (Exception e) {
|
||||||
throw new AssertionError(e);
|
Ln.e("Could not register rotation watcher", e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@TargetApi(29)
|
||||||
public void registerDisplayFoldListener(IDisplayFoldListener foldListener) {
|
public void registerDisplayFoldListener(IDisplayFoldListener foldListener) {
|
||||||
try {
|
try {
|
||||||
Class<?> cls = manager.getClass();
|
Class<?> cls = manager.getClass();
|
||||||
cls.getMethod("registerDisplayFoldListener", IDisplayFoldListener.class).invoke(manager, foldListener);
|
cls.getMethod("registerDisplayFoldListener", IDisplayFoldListener.class).invoke(manager, foldListener);
|
||||||
} catch (Exception e) {
|
} catch (Exception e) {
|
||||||
throw new AssertionError(e);
|
Ln.e("Could not register display fold listener", e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user