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

edits to README

Browse Source
This commit is contained in:
fduncanh
2021-11-06 06:34:27 -04:00
parent 53f9ed64c0
commit 672d4a9a6f
2 changed files with 13 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.html
View File

@@ -1,8 +1,8 @@
<h1 id="uxplay-1.38">UxPlay 1.38</h1>
<h1 id="uxplay-1.39">UxPlay 1.39</h1>
<p>This project is a GPLv3 unix AirPlay server which now also works on macOS. Its main use is to act like an AppleTV for screen-mirroring (with audio) of iOS/macOS clients (iPads, iPhones, 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, using Apple’s AirPlay Mirror protocol first available in iOS 5. (Details of what is known about the 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 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><em>Note: UxPlay currently only works using the AirPlay screen-mirroring protocol (which streams audio in <strong>AAC</strong> format) (not the AirPlay audio-only streaming protocol which uses lossless <strong>ALAC</strong> format) but the <strong>uxplay -vs 0</strong> option streams AAC-ELD audio using screen-mirroring without displaying the client’s screen. If the client streams audio using AirPlay as opposed to AirPlay screen-mirroring, non-AAC data can be seen to be received and processed by UxPlay, and then input into the GStreamer audio-rendering pipeline, but does not get rendered into audio output. If someone can adapt the GStreamer audio pipeline to also render these Airplay audio streams, such an enhancement of UxPlay would be welcome as a Pull Request!</em></p>
<p>UxPlay 1.38 is based on https://github.com/FD-/RPiPlay, with GStreamer integration from https://github.com/antimof/UxPlay. (UxPlay only uses GStreamer, and does not contain the alternative Raspberry-Pi-specific audio and video renderers also found in RPiPlay.) Tested on Ubuntu 20.04, Linux Mint 20.2, OpenSUSE 15.3, macOS 10.15.</p>
<p><em>New: UxPlay 1.39 now also supports the Airplay audio-only protocol as well as AirPlay Mirror protocol, and can play Apple Lossless (ALAC) 44100/16/2 audio streamed from Apple Music on the client in 2-channel stereo without video (the accompanying cover-art and metadata is received by the server, but not displayed).</em></p>
<p>UxPlay 1.39 is based on https://github.com/FD-/RPiPlay, with GStreamer integration from https://github.com/antimof/UxPlay. (UxPlay only uses GStreamer, and does not contain the alternative Raspberry-Pi-specific audio and video renderers also found in RPiPlay.) Tested on Ubuntu 20.04, Linux Mint 20.2, OpenSUSE 15.3, macOS 10.15.</p>
<p>Features: 1. Based on Gstreamer. 2. Video and audio are supported out of the box. 3. Gstreamer decoding is plugin agnostic. Uses accelerated decoders if available. VAAPI is preferable, (but don’t use VAAPI with nVidia). 4. Automatic screen orientation.</p>
<h1 id="getting-uxplay">Getting UxPlay:</h1>
<p>Either download and unzip <a href="https://github.com/FDH2/UxPlay/archive/refs/heads/master.zip">UxPlay-master.zip</a>, or (if git is installed): “git clone https://github.com/FDH2/UxPlay”.</p>
@@ -68,6 +68,7 @@
<p><strong>-as 0</strong> or <strong>-a</strong> suppresses playing of streamed audio, but displays streamed video.</p>
<p><strong>-t <em>timeout</em></strong> will cause the server to relaunch (without stopping uxplay) if no connections have been present during the previous <em>timeout</em> seconds. (You may wish to use this because the Server may not be visible to new Clients that were inactive when the Server was launched, and an idle Bonjour registration also eventually becomes unavailable for new connections.) The timer only starts once a Client has first made a mirror connection and then has disconnected with “Stop Mirrroring”. <em>This option should <strong>not</strong> be used if the display window is an OpenGL window on macOS, as such an OpenGL window created by GStreamer does not terminate correctly (it causes a segfault) if it is still open when the GStreamer pipeline is closed.</em></p>
<h1 id="changelog">ChangeLog</h1>
<p>1.39 2021-11-06 Added support for Apple Lossless (ALAC) audio streams.</p>
<p>1.38 2021-10-8 Add -as <em>audiosink</em> option to allow user to choose the GStreamer audiosink.</p>
<p>1.37 2021-09-29 Append “<span class="citation" data-cites="hostname">@hostname</span>” to AirPlay Server name, where “hostname” is the name of the server running uxplay (reworked change in 1.36).</p>
<p>1.36 2021-09-29 Implemented suggestion (by <span class="citation" data-cites="mrbesen">@mrbesen</span> and <span class="citation" data-cites="PetrusZ">@PetrusZ</span>) to use hostname of machine runing uxplay as the default server name</p>

22
README.txt
View File

@@ -1,4 +1,4 @@
UxPlay 1.38
UxPlay 1.39
===========
This project is a GPLv3 unix AirPlay server which now also works on
@@ -21,19 +21,13 @@ Linux and BSD Unix servers, this is usually provided by
included in most Linux distributions (this service can also be provided
by macOS, iOS or Windows servers).
*Note: UxPlay currently only works using the AirPlay screen-mirroring
protocol (which streams audio in **AAC** format) (not the AirPlay
audio-only streaming protocol which uses lossless **ALAC** format) but
the **uxplay -vs 0** option streams AAC-ELD audio using screen-mirroring
without displaying the client's screen. If the client streams audio
using AirPlay as opposed to AirPlay screen-mirroring, non-AAC data can
be seen to be received and processed by UxPlay, and then input into the
GStreamer audio-rendering pipeline, but does not get rendered into audio
output. If someone can adapt the GStreamer audio pipeline to also render
these Airplay audio streams, such an enhancement of UxPlay would be
welcome as a Pull Request!*
*New: UxPlay 1.39 now also supports the Airplay audio-only protocol as
well as AirPlay Mirror protocol, and can play Apple Lossless (ALAC)
44100/16/2 audio streamed from Apple Music on the client in 2-channel
stereo without video (the accompanying cover-art and metadata is
received by the server, but not displayed).*
UxPlay 1.38 is based on https://github.com/FD-/RPiPlay, with GStreamer
UxPlay 1.39 is based on https://github.com/FD-/RPiPlay, with GStreamer
integration from https://github.com/antimof/UxPlay. (UxPlay only uses
GStreamer, and does not contain the alternative Raspberry-Pi-specific
audio and video renderers also found in RPiPlay.) Tested on Ubuntu
@@ -388,6 +382,8 @@ still open when the GStreamer pipeline is closed.*
ChangeLog
=========
1.39 2021-11-06 Added support for Apple Lossless (ALAC) audio streams.
1.38 2021-10-8 Add -as *audiosink* option to allow user to choose the
GStreamer audiosink.