No description
Find a file
Romain Vimont c78ad6377c Terminate the server on stop
On user request to quit, two kinds of blocking calls must be interrupted
on the server:
 1. the reads from and writes to the socket;
 2. the call to MediaCodec.dequeueOutputBuffer().

The former case was handled by calling shutdown() on the socket from the
client, but the latter was not managed.

There is no easy way to wake this call properly, so just terminate the
process from the client (i.e. send SIGTERM on Linux) instead.
2018-02-28 16:56:20 +01:00
app Terminate the server on stop 2018-02-28 16:56:20 +01:00
config Apply Genymobile rules for Android projects 2018-02-07 20:58:18 +01:00
gradle/wrapper Convert server to an Android project 2018-01-30 12:01:36 +01:00
scripts Rename SCRCPY_SERVER_JAR to SCRCPY_SERVER_PATH 2018-02-16 15:36:25 +01:00
server Initialize eof flag from BufferInfo 2018-02-28 15:40:52 +01:00
.gitignore Convert server to an Android project 2018-01-30 12:01:36 +01:00
build.gradle Convert server to an Android project 2018-01-30 12:01:36 +01:00
gradle.properties Convert server to an Android project 2018-01-30 12:01:36 +01:00
gradlew Convert server to an Android project 2018-01-30 12:01:36 +01:00
gradlew.bat Convert server to an Android project 2018-01-30 12:01:36 +01:00
Makefile Add missing .PHONY in portable Makefile 2018-02-16 15:36:25 +01:00
meson.build Require Meson 0.37 2018-02-14 14:03:56 +01:00
meson_options.txt Rename SCRCPY_SERVER_JAR to SCRCPY_SERVER_PATH 2018-02-16 15:36:25 +01:00
README.md Parse XPM without SDL_image 2018-02-05 19:24:33 +01:00
run Rename SCRCPY_SERVER_JAR to SCRCPY_SERVER_PATH 2018-02-16 15:36:25 +01:00
settings.gradle Convert server to an Android project 2018-01-30 12:01:36 +01:00

ScrCpy

This project displays screens of Android devices plugged on USB in live.

Run

Runtime requirements

This projects requires FFmpeg, LibSDL2 and LibSDL2-net.

Linux

Install the packages from your package manager. For example, on Debian:

sudo apt install ffmpeg libsdl2-2.0.0 libsdl2-net-2.0.0

Windows

From MSYS2:

pacman -S mingw-w64-x86_64-SDL2
pacman -S mingw-w64-x86_64-SDL2_net
pacman -S mingw-w64-x86_64-ffmpeg

MacOS

TODO

Build

The project is divided into two parts:

  • the server, running on the device (in server/);
  • the client, running on the computer (in app/).

The server is a raw Java project requiring Android SDK. It not an Android project: the target file is a .jar, and a main() method is executed with shell rights.

The client is a C project using SDL and FFmpeg, built with Meson/Ninja.

The root directory contains a Makefile to build both parts.

Build requirements

Install the Android SDK, the JDK 8 (openjdk-8-jdk), and the packages described below.

Linux

sudo apt install make gcc openjdk-8-jdk pkg-config meson zip \
                 libavcodec-dev libavformat-dev libavutil-dev \
                 libsdl2-dev libsdl2-net-dev

Windows

Install these packages:

pacman -S mingw-w64-x86_64-make
pacman -S mingw-w64-x86_64-gcc
pacman -S mingw-w64-x86_64-pkg-config
pacman -S mingw-w64-x86_64-meson
pacman -S zip

Java 8 is not available in MSYS2, so install it manually and make it available from the PATH:

export PATH="$JAVA_HOME/bin:$PATH"

Build

Make sure your ANDROID_HOME variable is set to your Android SDK directory:

export ANDROID_HOME=~/android/sdk

From the project root directory, execute:

make build

To run the build:

make run

It is also pass arguments to scrcpy via make:

make run ARGS="-p 1234"

The purpose of this command is to execute scrcpy during the development.

Test

To execute unit tests:

make test

The server-side tests require JUnit 4:

sudo apt install junit4

Generate a release

From the project root directory, execute:

make release

This will generate the application in dist/scrcpy/.

Run

Plug a device, and from dist/scrcpy/, execute:

./scrcpy

If several devices are listed in adb devices, you must specify the serial:

./scrcpy 0123456789abcdef

To change the default port (useful to launch several scrcpy simultaneously):

./scrcpy -p 1234

Other options are available, check scrcpy --help.