From c656e996d6664f33fbbe2e865626b768c3fa7677 Mon Sep 17 00:00:00 2001 From: fduncanh Date: Fri, 25 Feb 2022 14:57:07 -0500 Subject: [PATCH] edit README --- README.html | 2 +- README.md | 3 ++- README.txt | 7 ++++--- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.html b/README.html index 8f8ca14..7108e4b 100644 --- a/README.html +++ b/README.html @@ -15,7 +15,7 @@

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

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

UxPlay uses GStreamer 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 GPU decoders if available. For Intel integrated graphics, the VAAPI plugin is preferable. VAAPI is open-source, and supports some AMD systems, as well as Intel, and open-source “Nouveau” NVIDIA drivers.

-

For NVIDIA graphics with the proprietary drivers (and CUDA), the nvdec plugin (recently renamed nvh264dec) can be used for accelerated video decoding on the NVIDIA GPU. This plugin is part of gstreamer1.0-plugins-bad, but is generally not included in binary packages, as NVIDIA’s proprietary Video Codec SDK 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. The plugin should be used with the -vd nvdec (or nvh264dec) and -vs glimagesink uxplay options.

+

For NVIDIA graphics with the proprietary drivers (and CUDA), the nvdec plugin (recently renamed nvh264dec) can be used for accelerated video decoding on the NVIDIA GPU. This plugin is part of gstreamer1.0-plugins-bad, but is generally not included in binary packages, as NVIDIA’s proprietary Video Codec SDK 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., and adapt them as necessary for your GStreamer installation. The plugin should be used with the -vd nvdec (or nvh264dec) and -vs glimagesink uxplay options.

The Video4Linux2 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 video decoding is not used, as its CPU is not powerful enough for satisfactory software-based decoding without large latency); uxplay options can be used to create GStreamer video pipelines to use non-VAAPI hardware decoders, and a special option -rpi creates a pipeline appropriate for the Raspberry Pi. (This is “Work In Progess”, has worked, but not yet consistently.)

Note to packagers: OpenSSL-3.0.0 solves GPL v3 license issues.

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.

diff --git a/README.md b/README.md index a38cf93..69b6c4a 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,8 @@ accelerated video decoding on the NVIDIA GPU. This plugin is part of gstreamer1. 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, 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), and +adapt them as necessary for your GStreamer installation. The plugin should be used with the `-vd nvdec` (or nvh264dec) and `-vs glimagesink` uxplay options. The Video4Linux2 decoder v4l2h264dec (from gstreamer1.0-plugins-good) is the appropriate choice for the Broadcom GPU in the diff --git a/README.txt b/README.txt index 932658f..6f494e6 100644 --- a/README.txt +++ b/README.txt @@ -87,9 +87,10 @@ SDK](https://docs.nvidia.com/video-technologies/video-codec-sdk/nvdec-video-deco 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 `-vd nvdec` (or nvh264dec) and -`-vs glimagesink` uxplay options. +instructions.](https://gist.github.com/corenel/a615b6f7eb5b5425aa49343a7b409200), +and adapt them as necessary for your GStreamer installation. The plugin +should be used with the `-vd nvdec` (or nvh264dec) and `-vs glimagesink` +uxplay options. The Video4Linux2 decoder v4l2h264dec (from gstreamer1.0-plugins-good) is the appropriate choice for the Broadcom GPU in the Raspberry Pi 4,