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:51:32 -05:00
parent bbb1fe6c4d
commit 1696865dea
3 changed files with 30 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.html
View File

@@ -1,4 +1,5 @@
<h1 id="uxplay-1.48-airplayairplay-mirror-server-for-linux-macos-and-unix.">UxPlay 1.48: AirPlay/AirPlay-Mirror server for Linux, macOS, and Unix.</h1> <h1 id="uxplay-1.48-airplayairplay-mirror-server-for-linux-macos-and-unix.">UxPlay 1.48: AirPlay/AirPlay-Mirror server for Linux, macOS, and Unix.</h1>
<p>** Now developed at GitHub site <a href="https://github.com/FDH2/UxPlay">https://github.com/FDH2/UxPlay</a> (where user issues should be posted)**.</p>
<p>Highlights:</p> <p>Highlights:</p>
<ul> <ul>
<li>GPLv3, open source.</li> <li>GPLv3, open source.</li>
@@ -9,13 +10,13 @@
<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>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> <li>Support for server behind a firewall.</li>
</ul> </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> <p>This project is a GPLv3 open source unix AirPlay2 Mirror server for Linux, macOS, and *BSD. It was initially 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>
<p>Its main use is to act like an AppleTV for screen-mirroring (with audio) of iOS/iPadOS/macOS clients (iPhones, iPads, MacBooks) in a window on the server display (with the possibility of sharing that window on screen-sharing applications such as Zoom) on a host running Linux, macOS, or other unix. UxPlay supports a “legacy” form of Apple’s AirPlay Mirror protocol introduced in iOS 12; client devices running iOS/iPadOS 9.3.5 or later are supported, as is a (non-free) Windows-based AirPlay-client software emulator, AirMyPC. (Details of what is publically known about Apple’s AirPlay2 protocol can be found <a href="https://github.com/SteeBono/airplayreceiver/wiki/AirPlay2-Protocol">here</a> and <a href="https://emanuelecozzi.net/docs/airplay2">here</a>).</p> <p>Its main use is to act like an AppleTV for screen-mirroring (with audio) of iOS/iPadOS/macOS clients (iPhones, iPads, MacBooks) in a window on the server display (with the possibility of sharing that window on screen-sharing applications such as Zoom) on a host running Linux, macOS, or other unix. UxPlay supports a “legacy” form of Apple’s AirPlay Mirror protocol introduced in iOS 12; client devices running iOS/iPadOS 9.3.5 or later are supported, as is a (non-free) Windows-based AirPlay-client software emulator, AirMyPC. (Details of what is publically known about Apple’s AirPlay2 protocol can be found <a href="https://github.com/SteeBono/airplayreceiver/wiki/AirPlay2-Protocol">here</a> and <a href="https://emanuelecozzi.net/docs/airplay2">here</a>).</p>
<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>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>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>UxPlay 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.</p> <p>UxPlay uses <a href="https://gstreamer.freedesktop.org">GStreamer</a> Plugins for rendering audio and video, This 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>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 is generally not included in 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> <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> <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>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>

16
README.md
View File

@@ -1,5 +1,8 @@
# UxPlay 1.48: AirPlay/AirPlay-Mirror server for Linux, macOS, and Unix. # UxPlay 1.48: AirPlay/AirPlay-Mirror server for Linux, macOS, and Unix.
** Now developed at GitHub site [https://github.com/FDH2/UxPlay](https://github.com/FDH2/UxPlay) (where user issues should be posted)**.
Highlights: Highlights:
* GPLv3, open source. * GPLv3, open source.
@@ -13,8 +16,7 @@ Highlights:
* Support for server behind a firewall. * Support for server behind a firewall.
This project is a GPLv3 open source unix AirPlay2 Mirror server for Linux, macOS, and \*BSD. This project is a GPLv3 open source unix AirPlay2 Mirror server for Linux, macOS, and \*BSD.
*It is now hosted at the It was initially developed by
github site [https://github.com/FDH2/UxPlay](https://github.com/FDH2/UxPlay) (where development and user-assistance now takes place)*, although it initially was developed by
[antimof](http://github.com/antimof/Uxplay) using code [antimof](http://github.com/antimof/Uxplay) using code
from [RPiPlay](https://github.com/FD-/RPiPlay), which in turn derives from from [RPiPlay](https://github.com/FD-/RPiPlay), which in turn derives from
[AirplayServer](https://github.com/KqsMea8/AirplayServer), [AirplayServer](https://github.com/KqsMea8/AirplayServer),
@@ -51,19 +53,17 @@ switch back by initiating a Mirror mode connection._ **Note that Apple DRM
and (unlike with a true AppleTV), the client cannot run a http connection on the server 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.** instead of streaming content from one on the client.**
UxPlay uses GStreamer Plugins for rendering audio and video, UxPlay is tested on a number of systems, including (among others) Debian 10.11 "Buster" and 11.2 "Bullseye", Ubuntu 20.04 and 21.10,
and does not offer the alternative Raspberry-Pi-specific
audio and video renderers available in [RPiPlay](https://github.com/FD-/RPiPlay).
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), 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. Rocky Linux 8.5 (a CentOS successor), OpenSUSE 15.3, Arch Linux 5.16.8, macOS 10.15.7, FreeBSD 13.0.
Using Gstreamer means that video and audio are supported "out of the box", using a choice of plugins. UxPlay uses [GStreamer](https://gstreamer.freedesktop.org) Plugins for rendering audio and video,
This 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 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. available. For Intel integrated graphics, the VAAPI plugin is preferable. VAAPI is convenient for Intel and some AMD systems.
For NVIDIA graphics with the proprietary drivers, the nvdec plugin (now renamed nvh264dec) can be used with the NVIDIA GPU. 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 This plugin is part of gstreamer1.0-plugins-bad, but is generally not included in 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, 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. 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) Users must do this themselves, see [these instructions.](https://gist.github.com/corenel/a615b6f7eb5b5425aa49343a7b409200)

34
README.txt
View File

@@ -1,6 +1,9 @@
UxPlay 1.48: AirPlay/AirPlay-Mirror server for Linux, macOS, and Unix. UxPlay 1.48: AirPlay/AirPlay-Mirror server for Linux, macOS, and Unix.
====================================================================== ======================================================================
\*\* Now developed at GitHub site <https://github.com/FDH2/UxPlay>
(where user issues should be posted)\*\*.
Highlights: Highlights:
- GPLv3, open source. - GPLv3, open source.
@@ -21,9 +24,7 @@ Highlights:
- Support for server behind a firewall. - Support for server behind a firewall.
This project is a GPLv3 open source unix AirPlay2 Mirror server for This project is a GPLv3 open source unix AirPlay2 Mirror server for
Linux, macOS, and \*BSD. *It is now hosted at the github site Linux, macOS, and \*BSD. It was initially developed by
<https://github.com/FDH2/UxPlay> (where development and user-assistance
now takes place)*, although it initially was developed by
[antimof](http://github.com/antimof/Uxplay) using code from [antimof](http://github.com/antimof/Uxplay) using code from
[RPiPlay](https://github.com/FD-/RPiPlay), which in turn derives from [RPiPlay](https://github.com/FD-/RPiPlay), which in turn derives from
[AirplayServer](https://github.com/KqsMea8/AirplayServer), [AirplayServer](https://github.com/KqsMea8/AirplayServer),
@@ -66,24 +67,23 @@ be decrypted by UxPlay, and (unlike with a true AppleTV), the client
cannot run a http connection on the server instead of streaming content cannot run a http connection on the server instead of streaming content
from one on the client.** from one on the client.**
UxPlay uses GStreamer Plugins for rendering audio and video, and does UxPlay is tested on a number of systems, including (among others) Debian
not offer the alternative Raspberry-Pi-specific audio and video 10.11 "Buster" and 11.2 "Bullseye", Ubuntu 20.04 and 21.10, Linux Mint
renderers available in [RPiPlay](https://github.com/FD-/RPiPlay). It is 20.2, Pop!\_OS 21.10 (NVIDIA edition), Rocky Linux 8.5 (a CentOS
tested on a number of systems, including (among others) Debian 10.11 successor), OpenSUSE 15.3, Arch Linux 5.16.8, macOS 10.15.7, FreeBSD
"Buster" and 11.2 "Bullseye", Ubuntu 20.04 and 21.10, Linux Mint 20.2, 13.0.
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.
Using Gstreamer means that video and audio are supported "out of the UxPlay uses [GStreamer](https://gstreamer.freedesktop.org) Plugins for
box", using a choice of plugins. Gstreamer decoding is plugin agnostic, rendering audio and video, This means that video and audio are supported
and uses accelerated decoders if available. For Intel integrated "out of the box", using a choice of plugins. Gstreamer decoding is
graphics, the VAAPI plugin is preferable. VAAPI is convenient for Intel plugin agnostic, and uses accelerated decoders if available. For Intel
and some AMD systems. integrated graphics, the VAAPI plugin is preferable. VAAPI is convenient
for Intel and some AMD systems.
For NVIDIA graphics with the proprietary drivers, the nvdec plugin (now For NVIDIA graphics with the proprietary drivers, the nvdec plugin (now
renamed nvh264dec) can be used with the NVIDIA GPU. This plugin is part 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 of gstreamer1.0-plugins-bad, but is generally not included in binary
NVIDIA's proprietary [Video Codec packages, as NVIDIA's proprietary [Video Codec
SDK](https://docs.nvidia.com/video-technologies/video-codec-sdk/nvdec-video-decoder-api-prog-guide/) 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 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 gstreamer source before the plugin can be compiled. Users must do this