QtScrcpy

中文介绍

QtScrcpy connects to Android devices via USB (or via TCP/IP) for display and control. It does NOT require the root privileges.

A single instance supports up to 16 Android device connections at the same time.

It supports three major platforms: GNU/Linux, Windows and MacOS.

It focuses on:

lightness (native, displays only the device screen)
performance (30~60fps)
quality (1920×1080 or above)
low latency (35~70ms)
low startup time (~1 second to display the first image)
non-intrusiveness (nothing is left installed on the device)

Customized key mapping (Windows&MacOS only)

You can write your own script to map keyboard and mouse actions to touches and clicks of the mobile phone according to your needs. Here are the rules.

A script for "PUBG mobile" and TikTok mapping is provided by default. Once enabled, you can play the game with your keyboard and mouse as the PC version. or you can use up/down/left/right direction keys to simulate up/down/left/right sliding. You can also write your own mapping files for other games according to writing rules. The default key mapping is as follows:

Here is a video demonstration of playing "PUBG mobile"

Here is the instruction of adding new customized mapping files.

Write a customized script and put it in the keymap directory
Click refresh script to check whether it can be found
Select your script
Connect your phone, start service and click apply
Press ~ key (left side of the number key 1) to switch to the custom mapping mode (It can be changed in the script as switchkey)
Press the ~ key again to switch back to normal mode
(For PUBG and similar games) If you want to drive cars with WASD, you need to check the single rocker mode in the game setting.

Group control

You can control all your phones at the same time.

Thanks

QtScrcpy is based on Genymobile's scrcpy project. Thanks

The difference between QtScrcpy and the original scrcpy is as follows:

keys	scrcpy	QtScrcpy
ui	sdl	qt
video encode	ffmpeg	ffmpeg
video render	sdl	opengl
cross-platform	self implemented	provided by Qt
language	C	C++
style	sync	async
keymap	no custom keymap	support custom keymap
build	meson+gradle	Qt Creator

It's very easy to customize your GUI with Qt
Asynchronous programming of Qt-based signal slot mechanism improves performance
Easy to learn
Add support for multi-touch

Learn

If you are interested in it and want to learn how it works but do not know how to get started, you can choose to purchase my recorded video lessons. It details the development architecture and the development process of the entire software, and help you develop QtScrcpy from scratch.

Course introduction：https://blog.csdn.net/rankun1/article/details/87970523

You can join my QQ group for QtScrcpy and exchange ideas with like-minded friends.：

QQ Group number：901736468

Requirements

Android API >= 21 (Android 5.0).

Make sure you enabled adb debugging on your device(s).

Download

Windows

For Windows, for simplicity, prebuilt archives with all the dependencies (including adb) are available:

QtScrcpy

or you can build it by yourself

Mac OS

For Mac OS, for simplicity, prebuilt archives with all the dependencies (including adb) are available:

QtScrcpy

or you can build it by yourself

Linux

you can build it by yourself(just ubuntu test)

Run

Connect to your Android device on your computer, then run the program and click the button below to connect to the Android device.

Wireless connection steps (ensure that the mobile phone and PC are in the same LAN):

Enable USB debugging in developer options on the Android device
Connect the Android device to computer via USB
Click update device, and you will see that the device number is updated
Click get device IP
Click start adbd
Click wireless connect
Click update device again, and another device with IP address will be found. Select this device.
Click start service

Note: it is not necessary to keep you Android device connected via USB after you start adbd.

Interface button introduction：

Start config: function parameter settings before starting the service

You can set the bit rate, resolution, recording format, and video save path of the local recorded video.
- Background record: the Android device screen is not displayed after starting the service. It is recorded in background.
- Always on top: the video window for Android device will be kept on the top
- Close screen: automatically turn off the Android device screen to save power after starting the service
- Reverse connection: service startup mode. You can uncheck it if you experience connection failure with message more than one device
Refresh devices: Refresh the currently connected device
Start service: connect to the Android device
Stop service: disconnect from Android device
Stop all services: disconnect all connected Android devices
Get device IP: Get the IP address of the Android device and update it to the "Wireless" area for the ease of wireless connection setting.
Start adbd: Start the adbd service of the Android device. You must start it before the wireless connection.
Wireless connect: Connect to Android devices wirelessly
Wireless disconnect: Disconnect wirelessly connected Android devices
adb command: execute customized adb commands (blocking commands are not supported now, such as shell)

The main function

Display Android device screens in real time
Real-time mouse and keyboard control of Android devices
Screen recording
Screenshot to png
Wireless connection
Supports up to 16 device connections (the number can be higher if your PC performance allows. You need to compile it by yourself)
Full-screen display
Display on the top
Install apk: drag and drop apk to the video window to install
Transfer files: Drag files to the video window to send files to Android devices
Background recording: record only, no display interface
Copy-paste

It is possible to synchronize clipboards between the computer and the device, in both directions:
- Ctrl+c copies the device clipboard to the computer clipboard;
- Ctrl+Shift+v copies the computer clipboard to the device clipboard;
- Ctrl+v pastes the computer clipboard as a sequence of text events (but breaks non-ASCII characters).
Group control

Shortcuts

Action	Shortcut (Windows)	Shortcut (macOS)
Switch fullscreen mode	`Ctrl`+`f`	`Cmd`+`f`
Resize window to 1:1 (pixel-perfect)	`Ctrl`+`g`	`Cmd`+`g`
Resize window to remove black borders	`Ctrl`+`x` \| Double-click¹	`Cmd`+`x` \| Double-click¹
Click on `HOME`	`Ctrl`+`h` \| Middle-click	`Ctrl`+`h` \| Middle-click
Click on `BACK`	`Ctrl`+`b` \| Right-click²	`Cmd`+`b` \| Right-click²
Click on `APP_SWITCH`	`Ctrl`+`s`	`Cmd`+`s`
Click on `MENU`	`Ctrl`+`m`	`Ctrl`+`m`
Click on `VOLUME_UP`	`Ctrl`+`↑` (up)	`Cmd`+`↑` (up)
Click on `VOLUME_DOWN`	`Ctrl`+`↓` (down)	`Cmd`+`↓` (down)
Click on `POWER`	`Ctrl`+`p`	`Cmd`+`p`
Power on	Right-click²	Right-click²
Turn device screen off (keep mirroring)	`Ctrl`+`o`	`Cmd`+`o`
Expand notification panel	`Ctrl`+`n`	`Cmd`+`n`
Collapse notification panel	`Ctrl`+`Shift`+`n`	`Cmd`+`Shift`+`n`
Copy device clipboard to computer	`Ctrl`+`c`	`Cmd`+`c`
Paste computer clipboard to device	`Ctrl`+`v`	`Cmd`+`v`
Copy computer clipboard to device	`Ctrl`+`Shift`+`v`	`Cmd`+`Shift`+`v`

¹Double-click on black borders to remove them.

²Right-click turns the screen on if it was off, presses BACK otherwise.

TODO

FAQ

DEVELOP

Everyone is welcome to maintain this project and contribute your own code, but please follow these requirements:

pr please mention the dev branch, not the master branch
Please rebase dev before mentioning pr
pr please submit on the principle of a small number of times (a small function point is recommended to mention a pr)
Please keep the code style consistent with the existing style

Why develop QtScrcpy?

There are several reasons listed as below according to importance (high to low).

In the process of learning Qt, I need a real project to try
I have some background skill about audio and video and I am interested at them
I have some Android development skills. But I have used it for a long time. I want to consolidate it.
I found scrcpy and decided to re-make it with the new technology stack (C++ + Qt + Opengl + ffmpeg)

Build

All the dependencies are provided and it is easy to compile.

PC client

Set up the Qt development environment on the target platform (Qt >= 5.12.0, vs >= 2017 (mingw not supported))
Clone the project
Open the project root directory all.pro with QtCreator
Compile and run

Android (If you do not have special requirements, you can directly use the built-in scrcpy-server.jar)

Set up an Android development environment on the target platform
Open server project in project root with Android Studio
The first time you open it, if you do not have the corresponding version of gradle, you will be prompted to find gradle, whether to upgrade gradle and create it. Select Cancel. After canceling, you will be prompted to select the location of the existing gradle. You can also cancel it (it will download automatically).
Edit the code as needed, but of course you do n’t need to.
After compiling the apk, rename it to scrcpy-server and replace third_party/scrcpy-server.

Licence

Since it is based on scrcpy, respect its Licence

Copyright (C) 2018 Genymobile

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About the author

Barry CSDN

An ordinary programmer, working mainly in C++ for desktop client development, graduated from Shandong for more than a year of steel simulation education software, and later moved to Shanghai to work in security, online education related fields, familiar with audio and video. I have an understanding of audio and video fields such as voice calls, live education, video conferencing and other related solutions. At the same time have android, linux server and other development experience.

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

liangent/QtScrcpy