mirror of
https://github.com/Genymobile/scrcpy
synced 2024-11-18 21:26:07 +00:00
fbe0f951e1
Play the decoded audio using SDL. The audio player frame sink receives the audio frames, resample them and write them to a byte buffer (introduced by this commit). On SDL audio callback (from an internal SDL thread), copy samples from this byte buffer to the SDL audio buffer. The byte buffer is protected by the SDL_AudioDeviceLock(), but it has been designed so that the producer and the consumer may write and read in parallel, provided that they don't access the same slices of the ring-buffer buffer. PR #3757 <https://github.com/Genymobile/scrcpy/pull/3757> Co-authored-by: Simon Chan <1330321+yume-chan@users.noreply.github.com>
324 lines
7.3 KiB
Markdown
324 lines
7.3 KiB
Markdown
# Build scrcpy
|
|
|
|
Here are the instructions to build _scrcpy_ (client and server).
|
|
|
|
|
|
## Simple
|
|
|
|
If you just want to install the latest release from `master`, follow this
|
|
simplified process.
|
|
|
|
First, you need to install the required packages:
|
|
|
|
```bash
|
|
# for Debian/Ubuntu
|
|
sudo apt install ffmpeg libsdl2-2.0-0 adb wget \
|
|
gcc git pkg-config meson ninja-build libsdl2-dev \
|
|
libavcodec-dev libavdevice-dev libavformat-dev libavutil-dev \
|
|
libswresample-dev libusb-1.0-0 libusb-1.0-0-dev
|
|
```
|
|
|
|
Then clone the repo and execute the installation script
|
|
([source](install_release.sh)):
|
|
|
|
```bash
|
|
git clone https://github.com/Genymobile/scrcpy
|
|
cd scrcpy
|
|
./install_release.sh
|
|
```
|
|
|
|
When a new release is out, update the repo and reinstall:
|
|
|
|
```bash
|
|
git pull
|
|
./install_release.sh
|
|
```
|
|
|
|
To uninstall:
|
|
|
|
```bash
|
|
sudo ninja -Cbuild-auto uninstall
|
|
```
|
|
|
|
|
|
## Branches
|
|
|
|
### `master`
|
|
|
|
The `master` branch concerns the latest release, and is the home page of the
|
|
project on GitHub.
|
|
|
|
|
|
### `dev`
|
|
|
|
`dev` is the current development branch. Every commit present in `dev` will be
|
|
in the next release.
|
|
|
|
If you want to contribute code, please base your commits on the latest `dev`
|
|
branch.
|
|
|
|
|
|
## Requirements
|
|
|
|
You need [adb]. It is available in the [Android SDK platform
|
|
tools][platform-tools], or packaged in your distribution (`adb`).
|
|
|
|
On Windows, download the [platform-tools][platform-tools-windows] and extract
|
|
the following files to a directory accessible from your `PATH`:
|
|
- `adb.exe`
|
|
- `AdbWinApi.dll`
|
|
- `AdbWinUsbApi.dll`
|
|
|
|
The client requires [FFmpeg] and [LibSDL2]. Just follow the instructions.
|
|
|
|
[adb]: https://developer.android.com/studio/command-line/adb.html
|
|
[platform-tools]: https://developer.android.com/studio/releases/platform-tools.html
|
|
[platform-tools-windows]: https://dl.google.com/android/repository/platform-tools-latest-windows.zip
|
|
[ffmpeg]: https://en.wikipedia.org/wiki/FFmpeg
|
|
[LibSDL2]: https://en.wikipedia.org/wiki/Simple_DirectMedia_Layer
|
|
|
|
|
|
|
|
## System-specific steps
|
|
|
|
### Linux
|
|
|
|
Install the required packages from your package manager.
|
|
|
|
#### Debian/Ubuntu
|
|
|
|
```bash
|
|
# runtime dependencies
|
|
sudo apt install ffmpeg libsdl2-2.0-0 adb libusb-1.0-0
|
|
|
|
# client build dependencies
|
|
sudo apt install gcc git pkg-config meson ninja-build libsdl2-dev \
|
|
libavcodec-dev libavdevice-dev libavformat-dev libavutil-dev \
|
|
libswresample-dev libusb-1.0-0-dev
|
|
|
|
# server build dependencies
|
|
sudo apt install openjdk-11-jdk
|
|
```
|
|
|
|
On old versions (like Ubuntu 16.04), `meson` is too old. In that case, install
|
|
it from `pip3`:
|
|
|
|
```bash
|
|
sudo apt install python3-pip
|
|
pip3 install meson
|
|
```
|
|
|
|
|
|
#### Fedora
|
|
|
|
```bash
|
|
# enable RPM fusion free
|
|
sudo dnf install https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm
|
|
|
|
# client build dependencies
|
|
sudo dnf install SDL2-devel ffms2-devel libusb-devel meson gcc make
|
|
|
|
# server build dependencies
|
|
sudo dnf install java-devel
|
|
```
|
|
|
|
|
|
|
|
### Windows
|
|
|
|
#### Cross-compile from Linux
|
|
|
|
This is the preferred method (and the way the release is built).
|
|
|
|
From _Debian_, install _mingw_:
|
|
|
|
```bash
|
|
sudo apt install mingw-w64 mingw-w64-tools
|
|
```
|
|
|
|
You also need the JDK to build the server:
|
|
|
|
```bash
|
|
sudo apt install openjdk-11-jdk
|
|
```
|
|
|
|
Then generate the releases:
|
|
|
|
```bash
|
|
./release.sh
|
|
```
|
|
|
|
It will generate win32 and win64 releases into `dist/`.
|
|
|
|
|
|
#### In MSYS2
|
|
|
|
From Windows, you need [MSYS2] to build the project. From an MSYS2 terminal,
|
|
install the required packages:
|
|
|
|
[MSYS2]: http://www.msys2.org/
|
|
|
|
```bash
|
|
# runtime dependencies
|
|
pacman -S mingw-w64-x86_64-SDL2 \
|
|
mingw-w64-x86_64-ffmpeg \
|
|
mingw-w64-x86_64-libusb
|
|
|
|
# client build dependencies
|
|
pacman -S mingw-w64-x86_64-make \
|
|
mingw-w64-x86_64-gcc \
|
|
mingw-w64-x86_64-pkg-config \
|
|
mingw-w64-x86_64-meson
|
|
```
|
|
|
|
For a 32 bits version, replace `x86_64` by `i686`:
|
|
|
|
```bash
|
|
# runtime dependencies
|
|
pacman -S mingw-w64-i686-SDL2 \
|
|
mingw-w64-i686-ffmpeg \
|
|
mingw-w64-i686-libusb
|
|
|
|
# client build dependencies
|
|
pacman -S mingw-w64-i686-make \
|
|
mingw-w64-i686-gcc \
|
|
mingw-w64-i686-pkg-config \
|
|
mingw-w64-i686-meson
|
|
```
|
|
|
|
Java (>= 7) is not available in MSYS2, so if you plan to build the server,
|
|
install it manually and make it available from the `PATH`:
|
|
|
|
```bash
|
|
export PATH="$JAVA_HOME/bin:$PATH"
|
|
```
|
|
|
|
### Mac OS
|
|
|
|
Install the packages with [Homebrew]:
|
|
|
|
[Homebrew]: https://brew.sh/
|
|
|
|
```bash
|
|
# runtime dependencies
|
|
brew install sdl2 ffmpeg libusb
|
|
|
|
# client build dependencies
|
|
brew install pkg-config meson
|
|
```
|
|
|
|
Additionally, if you want to build the server, install Java 8 from Caskroom, and
|
|
make it available from the `PATH`:
|
|
|
|
```bash
|
|
brew tap homebrew/cask-versions
|
|
brew install adoptopenjdk/openjdk/adoptopenjdk11
|
|
export JAVA_HOME="$(/usr/libexec/java_home --version 1.11)"
|
|
export PATH="$JAVA_HOME/bin:$PATH"
|
|
```
|
|
|
|
### Docker
|
|
|
|
See [pierlon/scrcpy-docker](https://github.com/pierlon/scrcpy-docker).
|
|
|
|
|
|
## Common steps
|
|
|
|
**As a non-root user**, clone the project:
|
|
|
|
```bash
|
|
git clone https://github.com/Genymobile/scrcpy
|
|
cd scrcpy
|
|
```
|
|
|
|
|
|
### Build
|
|
|
|
You may want to build only the client: the server binary, which will be pushed
|
|
to the Android device, does not depend on your system and architecture. In that
|
|
case, use the [prebuilt server] (so you will not need Java or the Android SDK).
|
|
|
|
[prebuilt server]: #option-2-use-prebuilt-server
|
|
|
|
|
|
#### Option 1: Build everything from sources
|
|
|
|
Install the [Android SDK] (_Android Studio_), and set `ANDROID_SDK_ROOT` to its
|
|
directory. For example:
|
|
|
|
[Android SDK]: https://developer.android.com/studio/index.html
|
|
|
|
```bash
|
|
# Linux
|
|
export ANDROID_SDK_ROOT=~/Android/Sdk
|
|
# Mac
|
|
export ANDROID_SDK_ROOT=~/Library/Android/sdk
|
|
# Windows
|
|
set ANDROID_SDK_ROOT=%LOCALAPPDATA%\Android\sdk
|
|
```
|
|
|
|
Then, build:
|
|
|
|
```bash
|
|
meson setup x --buildtype=release --strip -Db_lto=true
|
|
ninja -Cx # DO NOT RUN AS ROOT
|
|
```
|
|
|
|
_Note: `ninja` [must][ninja-user] be run as a non-root user (only `ninja
|
|
install` must be run as root)._
|
|
|
|
[ninja-user]: https://github.com/Genymobile/scrcpy/commit/4c49b27e9f6be02b8e63b508b60535426bd0291a
|
|
|
|
|
|
#### Option 2: Use prebuilt server
|
|
|
|
- [`scrcpy-server-v1.25`][direct-scrcpy-server]
|
|
<sub>SHA-256: `ce0306c7bbd06ae72f6d06f7ec0ee33774995a65de71e0a83813ecb67aec9bdb`</sub>
|
|
|
|
[direct-scrcpy-server]: https://github.com/Genymobile/scrcpy/releases/download/v1.25/scrcpy-server-v1.25
|
|
|
|
Download the prebuilt server somewhere, and specify its path during the Meson
|
|
configuration:
|
|
|
|
```bash
|
|
meson setup x --buildtype=release --strip -Db_lto=true \
|
|
-Dprebuilt_server=/path/to/scrcpy-server
|
|
ninja -Cx # DO NOT RUN AS ROOT
|
|
```
|
|
|
|
The server only works with a matching client version (this server works with the
|
|
`master` branch).
|
|
|
|
|
|
### Run without installing:
|
|
|
|
```bash
|
|
./run x [options]
|
|
```
|
|
|
|
|
|
### Install
|
|
|
|
After a successful build, you can install _scrcpy_ on the system:
|
|
|
|
```bash
|
|
sudo ninja -Cx install # without sudo on Windows
|
|
```
|
|
|
|
This installs several files:
|
|
|
|
- `/usr/local/bin/scrcpy` (main app)
|
|
- `/usr/local/share/scrcpy/scrcpy-server` (server to push to the device)
|
|
- `/usr/local/share/man/man1/scrcpy.1` (manpage)
|
|
- `/usr/local/share/icons/hicolor/256x256/apps/icon.png` (app icon)
|
|
- `/usr/local/share/zsh/site-functions/_scrcpy` (zsh completion)
|
|
- `/usr/local/share/bash-completion/completions/scrcpy` (bash completion)
|
|
|
|
You can then [run](README.md#run) `scrcpy`.
|
|
|
|
### Uninstall
|
|
|
|
```bash
|
|
sudo ninja -Cx uninstall # without sudo on Windows
|
|
```
|