morgan/UxPlay
1
0
Fork 0
mirror of https://github.com/morgan9e/UxPlay synced 2026-04-15 00:34:05 +09:00
Code Issues Packages Projects Releases Wiki Activity

edits to README

Browse Source
This commit is contained in:
fduncanh
2022-02-25 03:34:18 -05:00
parent f6f68f326b
commit bbb1fe6c4d
3 changed files with 43 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.html
View File

@@ -6,6 +6,7 @@
<li>macOS computers (2011 or later) can act either as AirPlay clients, or as the server running UxPlay (tested on macOS 10.15 Catalina). Using AirPlay, UxPlay can emulate a second display for macOS clients.</li>
<li>Support for older 32-bit iOS clients (such as iPad 2nd gen, iPhone 4S, when upgraded to iOS 9.3.5 or later), and also a Windows AirPlay-client emulator, AirMyPC.</li>
<li>Uses GStreamer, with options to select different output “videosinks” and “audiosinks”.</li>
<li>Since v1.48, it works well on <strong>Raspberry Pi</strong> (tested on model 4B) when using GPU for h264 video decoding.</li>
<li>Support for server behind a firewall.</li>
</ul>
<p>This project is a GPLv3 open source unix AirPlay2 Mirror server for Linux, macOS, and *BSD. <em>It is now hosted at the github site <a href="https://github.com/FDH2/UxPlay">https://github.com/FDH2/UxPlay</a> (where development and user-assistance now takes place)</em>, although it initially was developed by <a href="http://github.com/antimof/Uxplay">antimof</a> using code from <a href="https://github.com/FD-/RPiPlay">RPiPlay</a>, which in turn derives from <a href="https://github.com/KqsMea8/AirplayServer">AirplayServer</a>, <a href="https://github.com/juhovh/shairplay">shairplay</a>, and <a href="https://github.com/EstebanKubata/playfair">playfair</a>. (The antimof site is mainly inactive, but periodically posts updates pulled from the <a href="https://github.com/FDH2/UxPlay">main UxPlay site</a>).</p>
@@ -13,7 +14,9 @@
<p>The UxPlay server and its client must be on the same local area network, on which a <strong>Bonjour/Zeroconf mDNS/DNS-SD server</strong> is also running (only DNS-SD “Service Discovery” service is strictly necessary, it is not necessary that the local network also be of the “.local” mDNS-based type). On Linux and BSD Unix servers, this is usually provided by <a href="https://www.avahi.org">Avahi</a>, through the avahi-daemon service, and is included in most Linux distributions (this service can also be provided by macOS, iOS or Windows servers).</p>
<p>Connections to the UxPlay server by iOS/MacOS clients can be initiated both in AirPlay Mirror mode (which streams lossily-compressed AAC audio while mirroring the client screen, or in the alternative AirPlay Audio mode which streams Apple Lossless (ALAC) audio without screen mirroring (the accompanying metadata and cover art in this mode is not displayed). <em>Switching between these two modes during an active connection is possible: in Mirror mode, close the mirror window and start an Audio mode connection, switch back by initiating a Mirror mode connection.</em> <strong>Note that Apple DRM (as in Apple TV app content on the client) cannot be decrypted by UxPlay, and (unlike with a true AppleTV), the client cannot run a http connection on the server instead of streaming content from one on the client.</strong></p>
<p>UxPlay uses GStreamer Plugins for rendering audio and video, and does not offer the alternative Raspberry-Pi-specific audio and video renderers available in <a href="https://github.com/FD-/RPiPlay">RPiPlay</a>. It is tested on a number of systems, including (among others) Debian 10.11 “Buster” and 11.2 “Bullseye”, Ubuntu 20.04 and 21.10, Linux Mint 20.2, Pop!_OS 21.10 (NVIDIA edition), Rocky Linux 8.5 (a CentOS successor), OpenSUSE 15.3, Arch Linux 5.16.8, macOS 10.15.7, FreeBSD 13.0.</p>
<p>Using Gstreamer means that video and audio are supported “out of the box”, using a choice of plugins. Gstreamer decoding is plugin agnostic, and uses accelerated decoders if available. For Intel integrated graphics, the VAAPI plugin is preferable. VAAPI is convenient for Intel and some AMD systems. For NVIDIA graphics, the proprietary nvdec (or nvh264dec) plugin can be used with the NVIDIA GPU if you manage to build and install it (it is part of GStreamer-plugins-bad, but the user must build them after adding some files from NVIDIA). The decoder v4l2h264dec (from GStreamer1.0-plugins-good) would be the appropriate choice for the Broadcom GPU in the Raspberry Pi 4, if you can get it working (UxPlay does not run well on the Raspberry PI if GPU hardware h264 decoding is not used, as its CPU is not powerful enough for satisfactory software h264 video decoding). The -vd, -vc, and -vs options can be used to create GStreamer video pipelines to use non-VAAPI hardware decoders.</p>
<p>Using Gstreamer means that video and audio are supported “out of the box”, using a choice of plugins. Gstreamer decoding is plugin agnostic, and uses accelerated decoders if available. For Intel integrated graphics, the VAAPI plugin is preferable. VAAPI is convenient for Intel and some AMD systems.</p>
<p>For NVIDIA graphics with the proprietary drivers, the nvdec plugin (now renamed nvh264dec) can be used with the NVIDIA GPU. This plugin is part of gstreamer1.0-plugins-bad, but not included in the binary packages, as NVIDIA’s proprietary <a href="https://docs.nvidia.com/video-technologies/video-codec-sdk/nvdec-video-decoder-api-prog-guide/">Video Codec SDK</a> must be downloaded, and three header files from it must be added to the gstreamer source before the plugin can be compiled. Users must do this themselves, see <a href="https://gist.github.com/corenel/a615b6f7eb5b5425aa49343a7b409200">these instructions.</a> The plugin should be used with the <code>-vc nvdec</code> (or nvh264dec) and <code>-vs glimagesink</code> uxplay options.</p>
<p>The decoder v4l2h264dec (from GStreamer1.0-plugins-good) is the appropriate choice for the Broadcom GPU in the Raspberry Pi 4, (UxPlay does not run well on the Raspberry Pi if GPU hardware h264 decoding is not used, as its CPU is not powerful enough for satisfactory software h264 video decoding). The -vd, -vc, and -vs uxplay options can be used to create GStreamer video pipelines to use non-VAAPI hardware decoders, and an option -rpi does this for the Raspberry Pi.</p>
<h3 id="note-to-packagers-openssl-3.0.0-solves-gpl-v3-license-issues.">Note to packagers: OpenSSL-3.0.0 solves GPL v3 license issues.</h3>
<p>Some Linux distributions such as Debian do not allow distribution of compiled GPL code linked to OpenSSL-1.1.1 because its “dual OpenSSL/SSLeay” license has some incompatibilities with GPL, unless all code authors have explicitly given an “exception” to allow such linking (the historical origins of UxPlay make this impossible to obtain). Other distributions treat OpenSSL as a “System Library” which the GPL allows linking to.</p>
<p>For “GPL-strict” distributions, UxPlay can be built using OpenSSL- 3.0.0, which has a new <a href="https://www.openssl.org/blog/blog/2021/09/07/OpenSSL3.Final/">GPLv3-compatible license</a>.</p>
@@ -26,7 +29,7 @@
<p>You need a C/C++ compiler (e.g. g++) with the standard development libraries installed. Make sure that cmake&gt;=3.4.1 and pkg-config are also installed: “sudo apt-get install cmake pkg-config”. In a terminal window, change directories to the source directory of the downloaded source code (“UxPlay-*”, “*” = “master” or the release tag for zipfile downloads, “UxPlay” for “git clone” downloads), then do</p>
<ol type="1">
<li><code>sudo apt-get install libssl-dev libplist-dev</code> (unless you need to build OpenSSL and libplist from source).</li>
<li><code>sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav gstreamer1.0-plugins-bad</code></li>
<li><code>sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav gstreamer1.0-plugins-bad</code> (for the Raspberry Pi, make sure <code>gstreamer-1.0-gl</code> is also installed).</li>
<li><code>sudo apt-get install gstreamer1.0-vaapi</code> (For hardware-accelerated Intel graphics, but not NVIDIA)</li>
<li><code>sudo apt-get install libx11-dev</code> (only needed if you invoke the “ZOOMFIX” X11 display-name fix in the next step)</li>
<li><code>cmake .</code> (or “<code>cmake -DZOOMFIX=ON .</code>” to get a screen-sharing fix to make X11 mirror display windows visible to screen-sharing applications such as Zoom, see <a href="#improvements">Improvements</a> #3 below).</li>

21
README.md
View File

@@ -9,6 +9,7 @@ Highlights:
* Support for older 32-bit iOS clients (such as iPad 2nd gen, iPhone 4S, when upgraded to iOS 9.3.5 or later), and also a Windows AirPlay-client
emulator, AirMyPC.
* Uses GStreamer, with options to select different output "videosinks" and "audiosinks".
* Since v1.48, it works well on **Raspberry Pi** (tested on model 4B) when using GPU for h264 video decoding.
* Support for server behind a firewall.
This project is a GPLv3 open source unix AirPlay2 Mirror server for Linux, macOS, and \*BSD.
@@ -60,13 +61,18 @@ Rocky Linux 8.5 (a CentOS successor), OpenSUSE 15.3, Arch Linux 5.16.8, macOS 10
Using Gstreamer means that video and audio are supported "out of the box", using a choice of plugins.
Gstreamer decoding is plugin agnostic, and uses accelerated decoders if
available. For Intel integrated graphics, the VAAPI plugin is preferable. VAAPI is convenient for Intel and some AMD systems.
For NVIDIA graphics, the proprietary nvdec (or nvh264dec) plugin can be used with the NVIDIA GPU if you manage to build and install it (it is part of
GStreamer-plugins-bad, but the user must build it after adding some files from NVIDIA).
The decoder v4l2h264dec
(from GStreamer1.0-plugins-good) would be the appropriate choice for the Broadcom GPU in the Raspberry Pi 4, if you can get it working (UxPlay
does not run well on the Raspberry PI if GPU hardware h264 decoding is not used, as its CPU is not powerful enough for
satisfactory software h264 video decoding). The -vd, -vc, and -vs options
can be used to create GStreamer video pipelines to use non-VAAPI hardware decoders.
For NVIDIA graphics with the proprietary drivers, the nvdec plugin (now renamed nvh264dec) can be used with the NVIDIA GPU.
This plugin is part of gstreamer1.0-plugins-bad, but not included in the binary packages, as NVIDIA's
proprietary [Video Codec SDK](https://docs.nvidia.com/video-technologies/video-codec-sdk/nvdec-video-decoder-api-prog-guide/) must be downloaded,
and three header files from it must be added to the gstreamer source before the plugin can be compiled.
Users must do this themselves, see [these instructions.](https://gist.github.com/corenel/a615b6f7eb5b5425aa49343a7b409200)
The plugin should be used with the `-vc nvdec` (or nvh264dec) and `-vs glimagesink` uxplay options.
The decoder v4l2h264dec (from GStreamer1.0-plugins-good) is the appropriate choice for the Broadcom GPU in the Raspberry Pi 4, (UxPlay
does not run well on the Raspberry Pi if GPU hardware h264 decoding is not used, as its CPU is not powerful enough for
satisfactory software h264 video decoding). The -vd, -vc, and -vs uxplay options
can be used to create GStreamer video pipelines to use non-VAAPI hardware decoders, and an option -rpi does this for the Raspberry Pi.
### Note to packagers: OpenSSL-3.0.0 solves GPL v3 license issues.
@@ -106,6 +112,7 @@ downloaded source code ("UxPlay-\*", "\*" = "master" or the release tag for zipf
1. `sudo apt-get install libssl-dev libplist-dev` (unless you need to build OpenSSL and libplist from source).
2. `sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav gstreamer1.0-plugins-bad`
(for the Raspberry Pi, make sure `gstreamer-1.0-gl` is also installed).
3. `sudo apt-get install gstreamer1.0-vaapi` (For hardware-accelerated Intel graphics, but not NVIDIA)
4. `sudo apt-get install libx11-dev` (only needed if you invoke the "ZOOMFIX" X11 display-name fix in the next step)
5. `cmake .` (or "`cmake -DZOOMFIX=ON .`" to get a screen-sharing fix to

33
README.txt
View File

@@ -16,6 +16,8 @@ Highlights:
AirPlay-client emulator, AirMyPC.
- Uses GStreamer, with options to select different output "videosinks"
and "audiosinks".
- Since v1.48, it works well on **Raspberry Pi** (tested on model 4B)
when using GPU for h264 video decoding.
- Support for server behind a firewall.
This project is a GPLv3 open source unix AirPlay2 Mirror server for
@@ -76,16 +78,27 @@ Using Gstreamer means that video and audio are supported "out of the
box", using a choice of plugins. Gstreamer decoding is plugin agnostic,
and uses accelerated decoders if available. For Intel integrated
graphics, the VAAPI plugin is preferable. VAAPI is convenient for Intel
and some AMD systems. For NVIDIA graphics, the proprietary nvdec (or
nvh264dec) plugin can be used with the NVIDIA GPU if you manage to build
and install it (it is part of GStreamer-plugins-bad, but the user must
build them after adding some files from NVIDIA). The decoder v4l2h264dec
(from GStreamer1.0-plugins-good) would be the appropriate choice for the
Broadcom GPU in the Raspberry Pi 4, if you can get it working (UxPlay
does not run well on the Raspberry PI if GPU hardware h264 decoding is
and some AMD systems.
For NVIDIA graphics with the proprietary drivers, the nvdec plugin (now
renamed nvh264dec) can be used with the NVIDIA GPU. This plugin is part
of gstreamer1.0-plugins-bad, but not included in the binary packages, as
NVIDIA's proprietary [Video Codec
SDK](https://docs.nvidia.com/video-technologies/video-codec-sdk/nvdec-video-decoder-api-prog-guide/)
must be downloaded, and three header files from it must be added to the
gstreamer source before the plugin can be compiled. Users must do this
themselves, see [these
instructions.](https://gist.github.com/corenel/a615b6f7eb5b5425aa49343a7b409200)
The plugin should be used with the `-vc nvdec` (or nvh264dec) and
`-vs glimagesink` uxplay options.
The decoder v4l2h264dec (from GStreamer1.0-plugins-good) is the
appropriate choice for the Broadcom GPU in the Raspberry Pi 4, (UxPlay
does not run well on the Raspberry Pi if GPU hardware h264 decoding is
not used, as its CPU is not powerful enough for satisfactory software
h264 video decoding). The -vd, -vc, and -vs options can be used to
create GStreamer video pipelines to use non-VAAPI hardware decoders.
h264 video decoding). The -vd, -vc, and -vs uxplay options can be used
to create GStreamer video pipelines to use non-VAAPI hardware decoders,
and an option -rpi does this for the Raspberry Pi.
### Note to packagers: OpenSSL-3.0.0 solves GPL v3 license issues.
@@ -136,6 +149,8 @@ downloads, "UxPlay" for "git clone" downloads), then do
1. `sudo apt-get install libssl-dev libplist-dev` (unless you need to
build OpenSSL and libplist from source).
2. `sudo apt-get install libavahi-compat-libdnssd-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev gstreamer1.0-libav gstreamer1.0-plugins-bad`
(for the Raspberry Pi, make sure `gstreamer-1.0-gl` is also
installed).
3. `sudo apt-get install gstreamer1.0-vaapi` (For hardware-accelerated
Intel graphics, but not NVIDIA)
4. `sudo apt-get install libx11-dev` (only needed if you invoke the