Compare commits
3 Commits
v2.1
...
activity_t
Author | SHA1 | Date | |
---|---|---|---|
9bff8ccadb | |||
0d4157357a | |||
95e61e2a0b |
8
FAQ.md
8
FAQ.md
@ -159,8 +159,6 @@ 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
|
||||||
|
|
||||||
|
|
||||||
@ -170,12 +168,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].
|
||||||
|
|
||||||
It is also possible to simulate a [physical keyboard][hid] (HID).
|
Since scrcpy v1.20, it is 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]: doc/hid-otg.md
|
[hid]: README.md#physical-keyboard-simulation-hid
|
||||||
|
|
||||||
|
|
||||||
## Client issues
|
## Client issues
|
||||||
@ -231,4 +229,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 FAQ file is guaranteed to be up-to-date.
|
Only this README file is guaranteed to be up-to-date.
|
||||||
|
10
README.md
10
README.md
@ -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 screen [as a webcam (V4L2)](doc/v4l2.md) (Linux-only)
|
- Android device [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 for API >= 30 (Android 11+).
|
[Audio forwarding](doc/audio.md) is supported from 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,14 +47,10 @@ 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. Rebooting the device is necessary once
|
to control it using a keyboard and mouse.
|
||||||
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
|
||||||
|
|
||||||
|
@ -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.3
|
DEP_DIR=platform-tools-34.0.1
|
||||||
|
|
||||||
FILENAME=platform-tools_r34.0.3-windows.zip
|
FILENAME=platform-tools_r34.0.1-windows.zip
|
||||||
SHA256SUM=fce992e93eb786fc9f47df93d83a7b912c46742d45c39d712c02e06d05b72e2b
|
SHA256SUM=5dd9c2be744c224fa3a7cbe30ba02d2cb378c763bd0f797a7e47e9f3156a5daa
|
||||||
|
|
||||||
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.28.0
|
DEP_DIR=SDL2-2.26.4
|
||||||
|
|
||||||
FILENAME=SDL2-devel-2.28.0-mingw.tar.gz
|
FILENAME=SDL2-devel-2.26.4-mingw.tar.gz
|
||||||
SHA256SUM=b91ce59eeacd4a9db403f976fd2337d9360b21ada374124417d716065c380e20
|
SHA256SUM=fe899c8642caac2f180b1ee6f786857ddcaa0adc1fa82474312b09dd47d74712
|
||||||
|
|
||||||
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.1"
|
VALUE "ProductVersion", "2.0"
|
||||||
END
|
END
|
||||||
END
|
END
|
||||||
BLOCK "VarFileInfo"
|
BLOCK "VarFileInfo"
|
||||||
|
@ -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).
|
||||||
|
|
||||||
|
@ -124,7 +124,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 +185,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).",
|
||||||
},
|
},
|
||||||
|
@ -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,
|
bool ok = net_connect_intr(&server->intr, audio_socket, tunnel_host,
|
||||||
tunnel_host, tunnel_port);
|
tunnel_port);
|
||||||
if (!ok) {
|
if (!ok) {
|
||||||
goto fail;
|
goto fail;
|
||||||
}
|
}
|
||||||
|
@ -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.28.0/i686-w64-mingw32'
|
prebuilt_sdl2 = 'SDL2-2.26.4/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.28.0/x86_64-w64-mingw32'
|
prebuilt_sdl2 = 'SDL2-2.26.4/x86_64-w64-mingw32'
|
||||||
prebuilt_libusb = 'libusb-1.0.26/libusb-MinGW-x64'
|
prebuilt_libusb = 'libusb-1.0.26/libusb-MinGW-x64'
|
||||||
|
@ -71,13 +71,6 @@ 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`.
|
|
||||||
|
|
||||||
|
|
||||||
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
|
||||||
@ -98,7 +91,7 @@ check `--audio-codec-options` in the manpage or in `scrcpy --help`.
|
|||||||
|
|
||||||
## Bit rate
|
## Bit rate
|
||||||
|
|
||||||
The default audio bit rate is 128Kbps. To change it:
|
The default video bit-rate is 128Kbps. To change it:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
scrcpy --audio-bit-rate=64K
|
scrcpy --audio-bit-rate=64K
|
||||||
|
445
doc/develop.md
445
doc/develop.md
@ -9,52 +9,16 @@ 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.
|
||||||
|
|
||||||
The client and the server establish communication using separate sockets for
|
Once the client and the server are connected to each other, the server initially
|
||||||
video, audio and controls. Any of them may be disabled (but not all), so
|
sends device information (name and initial screen dimensions), then starts to
|
||||||
there are 1, 2 or 3 socket(s).
|
send a raw H.264 video stream of the device screen. The client decodes the video
|
||||||
|
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 server initially sends the device name on the first socket (it is used for
|
The client captures relevant keyboard and mouse events, that it transmits to the
|
||||||
the scrcpy window title), then each socket is used for its own purpose. All
|
server, which injects them to the device.
|
||||||
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
|
||||||
@ -68,14 +32,15 @@ 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/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/Server.java#L193
|
[main]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/Server.java#L123
|
||||||
|
|
||||||
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 app_process / my.package.MainClass
|
adb shell CLASSPATH=/data/local/tmp/classes.dex \
|
||||||
|
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
|
||||||
@ -84,7 +49,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.jar`).
|
`scrcpy-server`).
|
||||||
|
|
||||||
[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
|
||||||
@ -100,77 +65,42 @@ 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/master/server/src/main/java/com/genymobile/scrcpy/wrappers
|
[wrappers]: https://github.com/Genymobile/scrcpy/tree/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/wrappers
|
||||||
[aidl]: https://github.com/Genymobile/scrcpy/tree/master/server/src/main/aidl
|
[aidl]: https://github.com/Genymobile/scrcpy/tree/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/aidl/android/view
|
||||||
|
|
||||||
|
|
||||||
|
### Threading
|
||||||
|
|
||||||
### Execution
|
The server uses 3 threads:
|
||||||
|
|
||||||
The server is started by the client basically by executing the following
|
- the **main** thread, encoding and streaming the video to the client;
|
||||||
commands:
|
- the **controller** thread, listening for _control messages_ (typically,
|
||||||
|
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).
|
||||||
|
|
||||||
```bash
|
Since the video encoding is typically hardware, there would be no benefit in
|
||||||
adb push scrcpy-server /data/local/tmp/scrcpy-server.jar
|
encoding and streaming in two different threads.
|
||||||
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 encodes the content
|
The video is encoded using the [`MediaCodec`] API. The codec takes its input
|
||||||
of a `Surface` associated to the display, and writes the encoding packets to the
|
from a [surface] associated to the display, and writes the resulting H.264
|
||||||
client (on the _video_ socket).
|
stream to the provided output stream (the socket connected to the client).
|
||||||
|
|
||||||
[`ScreenEncoder`]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java
|
[`ScreenEncoder`]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/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 (or folding), the encoding session is [reset] and restarted.
|
On device [rotation], the codec, surface and display are reinitialized, and a
|
||||||
|
new video stream is produced.
|
||||||
|
|
||||||
New frames are produced only when changes occur on the surface. This avoids to
|
New frames are produced only when changes occur on the surface. This is good
|
||||||
send unnecessary frames, but by default there might be drawbacks:
|
because it avoids to send unnecessary frames, but there are 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.
|
||||||
@ -178,24 +108,11 @@ send unnecessary frames, but by default there might be 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/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java#L246-L247
|
[repeat]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/ScreenEncoder.java#L147-L148
|
||||||
[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
|
||||||
@ -207,13 +124,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 the
|
_hidden_ method [`InputManager.injectInputEvent`] (exposed by our
|
||||||
[`InputManager` wrapper][inject-wrapper]).
|
[`InputManager` wrapper][inject-wrapper]).
|
||||||
|
|
||||||
[`Controller`]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/Controller.java
|
[`Controller`]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/server/src/main/java/com/genymobile/scrcpy/Controller.java#L81
|
||||||
[`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://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/server/src/main/java/com/genymobile/scrcpy/wrappers/InputManager.java#L34
|
[`InputManager.injectInputEvent`]: https://android.googlesource.com/platform/frameworks/base/+/oreo-release/core/java/android/hardware/input/InputManager.java#857
|
||||||
[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
|
||||||
|
|
||||||
|
|
||||||
@ -223,222 +140,126 @@ _hidden_ method [`InputManager.injectInputEvent()`] (exposed by the
|
|||||||
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 and audio streams are decoded by [FFmpeg].
|
The video stream is decoded by [libav] (FFmpeg).
|
||||||
|
|
||||||
[SDL]: https://www.libsdl.org
|
[SDL]: https://www.libsdl.org
|
||||||
[ffmpeg]: https://ffmpeg.org/
|
[libav]: https://www.libav.org/
|
||||||
|
|
||||||
|
|
||||||
### Initialization
|
### Initialization
|
||||||
|
|
||||||
The client parses the command line arguments, then [runs one of two code
|
On startup, in addition to _libav_ and _SDL_ initialization, the client must
|
||||||
paths][run]:
|
push and start the server on the device, and open two sockets (one for the video
|
||||||
- scrcpy in "normal" mode ([`scrcpy.c`])
|
stream, one for control) so that they may communicate.
|
||||||
- scrcpy in [OTG mode](hid-otg.md) ([`scrcpy_otg.c`])
|
|
||||||
|
|
||||||
[run]: https://github.com/Genymobile/scrcpy/blob/a3cdf1a6b86ea22786e1f7d09b9c202feabc6949/app/src/main.c#L81-L82
|
Note that the client-server roles are expressed at the application level:
|
||||||
[`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
|
|
||||||
|
|
||||||
In the remaining of this document, we assume that the "normal" mode is used
|
- the server _serves_ video stream and handle requests from the client,
|
||||||
(read the code for the OTG mode).
|
- the client _controls_ the device through the server.
|
||||||
|
|
||||||
On startup, the client:
|
However, the roles are reversed at the network level:
|
||||||
- opens the _video_, _audio_ and _control_ sockets;
|
|
||||||
- pushes and starts the server on the device;
|
- the client opens a server socket and listen on a port before starting the
|
||||||
- initializes its components (demuxers, decoders, recorder…).
|
server,
|
||||||
|
- 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
|
||||||
|
|
||||||
|
|
||||||
### Video and audio streams
|
### Threading
|
||||||
|
|
||||||
Depending on the arguments passed to `scrcpy`, several components may be used.
|
The client uses 4 threads:
|
||||||
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_ creates
|
On SDL event, received on the main thread, the [input manager][inputmanager]
|
||||||
appropriate _control messages_. It is responsible to convert SDL events to
|
creates appropriate [_control messages_][controlmsg]. It is responsible to
|
||||||
Android events. It then pushes the _control messages_ to a queue hold by the
|
convert SDL events to Android events (using [convert]). It pushes the _control
|
||||||
controller. On its own thread, the controller takes messages from the queue,
|
messages_ to a queue hold by the controller. On its own thread, the controller
|
||||||
that it serializes and sends to the client.
|
takes messages from the queue, 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
|
||||||
|
|
||||||
|
|
||||||
## Protocol
|
### UI and event loop
|
||||||
|
|
||||||
The protocol between the client and the server must be considered _internal_: it
|
Initialization, input events and rendering are all [managed][scrcpy] in the main
|
||||||
may (and will) change at any time for any reason. Everything may change (the
|
thread.
|
||||||
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.
|
|
||||||
|
|
||||||
This section documents the current protocol in scrcpy v2.1.
|
Events are handled in the [event loop], which either updates the [screen] or
|
||||||
|
delegates to the [input manager][inputmanager].
|
||||||
|
|
||||||
### Connection
|
[scrcpy]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/scrcpy.c
|
||||||
|
[event loop]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/scrcpy.c#L201
|
||||||
Firstly, the client sets up an adb tunnel:
|
[screen]: https://github.com/Genymobile/scrcpy/blob/ffe0417228fb78ab45b7ee4e202fc06fc8875bf3/app/src/screen.h
|
||||||
|
|
||||||
```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
|
||||||
|
@ -106,7 +106,3 @@ 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,10 +9,12 @@ 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: `emerge scrcpy`
|
- Gentoo: [ebuild][ebuild-link] file
|
||||||
- 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> \| <kbd>MOD</kbd>+<kbd>Backspace</kbd> \| _Right-click²_
|
| Click on `BACK` | <kbd>MOD</kbd>+<kbd>b</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)_
|
||||||
|
@ -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
|
||||||
|
@ -15,13 +15,7 @@ Download the [latest release]:
|
|||||||
|
|
||||||
and extract it.
|
and extract it.
|
||||||
|
|
||||||
Alternatively, you could install it from packages manager, like [Winget]:
|
Alternatively, you could install it from packages manager, like [Chocolatey]:
|
||||||
|
|
||||||
```bash
|
|
||||||
winget install scrcpy
|
|
||||||
```
|
|
||||||
|
|
||||||
or [Chocolatey]:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
choco install scrcpy
|
choco install scrcpy
|
||||||
@ -36,7 +30,6 @@ 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
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
project('scrcpy', 'c',
|
project('scrcpy', 'c',
|
||||||
version: '2.1',
|
version: '2.0',
|
||||||
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.3/adb.exe "$(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/AdbWinApi.dll "$(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/AdbWinUsbApi.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/SDL2-2.28.0/i686-w64-mingw32/bin/SDL2.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/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.3/adb.exe "$(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/AdbWinApi.dll "$(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/AdbWinUsbApi.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/SDL2-2.28.0/x86_64-w64-mingw32/bin/SDL2.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/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 20100
|
versionCode 20000
|
||||||
versionName "2.1"
|
versionName "2.0"
|
||||||
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.1
|
SCRCPY_VERSION_NAME=2.0
|
||||||
|
|
||||||
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,7 +48,6 @@ 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
|
||||||
|
@ -64,6 +64,8 @@ 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;
|
||||||
@ -72,27 +74,23 @@ 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();
|
||||||
if (sendDummyByte) {
|
firstSocket = videoSocket;
|
||||||
// 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 (sendDummyByte) {
|
if (firstSocket == null) {
|
||||||
// send one byte so the client may read() to detect a connection error
|
firstSocket = audioSocket;
|
||||||
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
|
||||||
controlSocket.getOutputStream().write(0);
|
firstSocket.getOutputStream().write(0);
|
||||||
sendDummyByte = false;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
|
@ -99,7 +99,6 @@ 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) {
|
||||||
@ -119,7 +118,6 @@ 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
|
||||||
|
@ -1,24 +1,42 @@
|
|||||||
package com.genymobile.scrcpy;
|
package com.genymobile.scrcpy;
|
||||||
|
|
||||||
|
import com.genymobile.scrcpy.wrappers.ActivityThread;
|
||||||
|
|
||||||
import android.annotation.TargetApi;
|
import android.annotation.TargetApi;
|
||||||
import android.content.AttributionSource;
|
import android.content.AttributionSource;
|
||||||
import android.content.MutableContextWrapper;
|
import android.content.Context;
|
||||||
|
import android.content.ContextWrapper;
|
||||||
import android.os.Build;
|
import android.os.Build;
|
||||||
import android.os.Process;
|
import android.os.Process;
|
||||||
|
|
||||||
public final class FakeContext extends MutableContextWrapper {
|
import java.lang.reflect.Method;
|
||||||
|
|
||||||
|
public final class FakeContext extends ContextWrapper {
|
||||||
|
|
||||||
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
|
||||||
|
|
||||||
private static final FakeContext INSTANCE = new FakeContext();
|
private static final FakeContext INSTANCE = new FakeContext();
|
||||||
|
|
||||||
|
private static Context retrieveSystemContext() {
|
||||||
|
try {
|
||||||
|
Class<?> activityThreadClass = ActivityThread.getActivityThreadClass();
|
||||||
|
Object activityThread = ActivityThread.getActivityThread();
|
||||||
|
|
||||||
|
Method getSystemContextMethod = activityThreadClass.getDeclaredMethod("getSystemContext");
|
||||||
|
return (Context) getSystemContextMethod.invoke(activityThread);
|
||||||
|
} catch (Exception e) {
|
||||||
|
Ln.e("Cannot retrieve system context", e);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
public static FakeContext get() {
|
public static FakeContext get() {
|
||||||
return INSTANCE;
|
return INSTANCE;
|
||||||
}
|
}
|
||||||
|
|
||||||
private FakeContext() {
|
private FakeContext() {
|
||||||
super(null);
|
super(retrieveSystemContext());
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@ -99,7 +99,26 @@ public final class Server {
|
|||||||
boolean audio = options.getAudio();
|
boolean audio = options.getAudio();
|
||||||
boolean sendDummyByte = options.getSendDummyByte();
|
boolean sendDummyByte = options.getSendDummyByte();
|
||||||
|
|
||||||
Workarounds.apply(audio);
|
Workarounds.prepareMainLooper();
|
||||||
|
|
||||||
|
// 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") || Build.BRAND.equalsIgnoreCase("honor")) {
|
||||||
|
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<>();
|
||||||
|
|
||||||
|
@ -1,10 +1,11 @@
|
|||||||
package com.genymobile.scrcpy;
|
package com.genymobile.scrcpy;
|
||||||
|
|
||||||
|
import com.genymobile.scrcpy.wrappers.ActivityThread;
|
||||||
|
|
||||||
import android.annotation.SuppressLint;
|
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;
|
||||||
@ -21,63 +22,14 @@ import java.lang.reflect.Method;
|
|||||||
|
|
||||||
public final class Workarounds {
|
public final class Workarounds {
|
||||||
|
|
||||||
private static Class<?> activityThreadClass;
|
private static boolean activityThreadFilled;
|
||||||
private static Object activityThread;
|
|
||||||
|
|
||||||
private Workarounds() {
|
private 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")
|
||||||
private static void prepareMainLooper() {
|
public 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>
|
||||||
@ -91,22 +43,21 @@ public final class Workarounds {
|
|||||||
|
|
||||||
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
||||||
private static void fillActivityThread() throws Exception {
|
private static void fillActivityThread() throws Exception {
|
||||||
if (activityThread == null) {
|
if (!activityThreadFilled) {
|
||||||
// ActivityThread activityThread = new ActivityThread();
|
Class<?> activityThreadClass = ActivityThread.getActivityThreadClass();
|
||||||
activityThreadClass = Class.forName("android.app.ActivityThread");
|
Object activityThread = ActivityThread.getActivityThread();
|
||||||
Constructor<?> activityThreadConstructor = activityThreadClass.getDeclaredConstructor();
|
|
||||||
activityThreadConstructor.setAccessible(true);
|
|
||||||
activityThread = activityThreadConstructor.newInstance();
|
|
||||||
|
|
||||||
// ActivityThread.sCurrentActivityThread = activityThread;
|
// ActivityThread.sCurrentActivityThread = activityThread;
|
||||||
Field sCurrentActivityThreadField = activityThreadClass.getDeclaredField("sCurrentActivityThread");
|
Field sCurrentActivityThreadField = activityThreadClass.getDeclaredField("sCurrentActivityThread");
|
||||||
sCurrentActivityThreadField.setAccessible(true);
|
sCurrentActivityThreadField.setAccessible(true);
|
||||||
sCurrentActivityThreadField.set(null, activityThread);
|
sCurrentActivityThreadField.set(null, activityThread);
|
||||||
|
|
||||||
|
activityThreadFilled = true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
||||||
private static void fillAppInfo() {
|
public static void fillAppInfo() {
|
||||||
try {
|
try {
|
||||||
fillActivityThread();
|
fillActivityThread();
|
||||||
|
|
||||||
@ -124,6 +75,9 @@ public final class Workarounds {
|
|||||||
appInfoField.setAccessible(true);
|
appInfoField.setAccessible(true);
|
||||||
appInfoField.set(appBindData, applicationInfo);
|
appInfoField.set(appBindData, applicationInfo);
|
||||||
|
|
||||||
|
Class<?> activityThreadClass = ActivityThread.getActivityThreadClass();
|
||||||
|
Object activityThread = ActivityThread.getActivityThread();
|
||||||
|
|
||||||
// activityThread.mBoundApplication = appBindData;
|
// activityThread.mBoundApplication = appBindData;
|
||||||
Field mBoundApplicationField = activityThreadClass.getDeclaredField("mBoundApplication");
|
Field mBoundApplicationField = activityThreadClass.getDeclaredField("mBoundApplication");
|
||||||
mBoundApplicationField.setAccessible(true);
|
mBoundApplicationField.setAccessible(true);
|
||||||
@ -135,7 +89,7 @@ public final class Workarounds {
|
|||||||
}
|
}
|
||||||
|
|
||||||
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
@SuppressLint("PrivateApi,DiscouragedPrivateApi")
|
||||||
private static void fillAppContext() {
|
public static void fillAppContext() {
|
||||||
try {
|
try {
|
||||||
fillActivityThread();
|
fillActivityThread();
|
||||||
|
|
||||||
@ -144,6 +98,9 @@ public final class Workarounds {
|
|||||||
baseField.setAccessible(true);
|
baseField.setAccessible(true);
|
||||||
baseField.set(app, FakeContext.get());
|
baseField.set(app, FakeContext.get());
|
||||||
|
|
||||||
|
Class<?> activityThreadClass = ActivityThread.getActivityThreadClass();
|
||||||
|
Object activityThread = ActivityThread.getActivityThread();
|
||||||
|
|
||||||
// activityThread.mInitialApplication = app;
|
// activityThread.mInitialApplication = app;
|
||||||
Field mInitialApplicationField = activityThreadClass.getDeclaredField("mInitialApplication");
|
Field mInitialApplicationField = activityThreadClass.getDeclaredField("mInitialApplication");
|
||||||
mInitialApplicationField.setAccessible(true);
|
mInitialApplicationField.setAccessible(true);
|
||||||
@ -154,19 +111,6 @@ public final class Workarounds {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public 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) {
|
||||||
|
@ -0,0 +1,32 @@
|
|||||||
|
package com.genymobile.scrcpy.wrappers;
|
||||||
|
|
||||||
|
import java.lang.reflect.Constructor;
|
||||||
|
|
||||||
|
public class ActivityThread {
|
||||||
|
|
||||||
|
private static final Class<?> activityThreadClass;
|
||||||
|
private static final Object activityThread;
|
||||||
|
|
||||||
|
static {
|
||||||
|
try {
|
||||||
|
activityThreadClass = Class.forName("android.app.ActivityThread");
|
||||||
|
Constructor<?> activityThreadConstructor = activityThreadClass.getDeclaredConstructor();
|
||||||
|
activityThreadConstructor.setAccessible(true);
|
||||||
|
activityThread = activityThreadConstructor.newInstance();
|
||||||
|
} catch (Exception e) {
|
||||||
|
throw new AssertionError(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private ActivityThread() {
|
||||||
|
// only static methods
|
||||||
|
}
|
||||||
|
|
||||||
|
public static Object getActivityThread() {
|
||||||
|
return activityThread;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static Class<?> getActivityThreadClass() {
|
||||||
|
return activityThreadClass;
|
||||||
|
}
|
||||||
|
}
|
@ -2,7 +2,6 @@ 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;
|
||||||
@ -107,17 +106,16 @@ 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) {
|
||||||
Ln.e("Could not register rotation watcher", e);
|
throw new AssertionError(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) {
|
||||||
Ln.e("Could not register display fold listener", e);
|
throw new AssertionError(e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user