From 672d4a9a6fb724e072a8a3596cb643fdf67c6de0 Mon Sep 17 00:00:00 2001 From: fduncanh Date: Sat, 6 Nov 2021 06:34:27 -0400 Subject: [PATCH] edits to README --- README.html | 7 ++++--- README.txt | 22 +++++++++------------- 2 files changed, 13 insertions(+), 16 deletions(-) diff --git a/README.html b/README.html index 8fc3a23..c0bfe11 100644 --- a/README.html +++ b/README.html @@ -1,8 +1,8 @@ -

UxPlay 1.38

+

UxPlay 1.39

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 here and here).

The UxPlay server and its client must be on the same local area network, on which a Bonjour/Zeroconf mDNS/DNS-SD server 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 Avahi, through the avahi-daemon service, and is 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!

-

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.

+

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.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.

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.

Getting UxPlay:

Either download and unzip UxPlay-master.zip, or (if git is installed): “git clone https://github.com/FDH2/UxPlay”.

@@ -68,6 +68,7 @@

-as 0 or -a suppresses playing of streamed audio, but displays streamed video.

-t timeout will cause the server to relaunch (without stopping uxplay) if no connections have been present during the previous timeout 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”. This option should not 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.

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.

1.37 2021-09-29 Append “@hostname” to AirPlay Server name, where “hostname” is the name of the server running uxplay (reworked change in 1.36).

1.36 2021-09-29 Implemented suggestion (by @mrbesen and @PetrusZ) to use hostname of machine runing uxplay as the default server name

diff --git a/README.txt b/README.txt index 9c258c2..bbefc2c 100644 --- a/README.txt +++ b/README.txt @@ -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.