From 6a5f0cf8178f4b31507bf3987beb9940e0570aed Mon Sep 17 00:00:00 2001 From: fduncanh Date: Sat, 19 Mar 2022 19:59:14 -0400 Subject: [PATCH] edit README --- README.html | 4 ++-- README.md | 6 +++--- README.txt | 15 ++++++++------- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/README.html b/README.html index 11afdf3..d3a084c 100644 --- a/README.html +++ b/README.html @@ -18,10 +18,10 @@

Possibility for using hardware-accelerated h264 video-decoding, if available.

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. AirPlay streams video in h264 format: gstreamer decoding is plugin agnostic, and uses accelerated GPU hardware h264 decoders if available; if not, software decoding is used.

For systems with Intel integrated graphics, hardware GPU decoding with the gstreamer VAAPI plugin is preferable. VAAPI is open-source, and in addition to Intel, can support some AMD GPU’s (the open-source “Nouveau” drivers for NVIDIA graphics are also in principle supported when VAAPI is supplemented with firmware extracted from the proprietary NVIDIA drivers).

-

For NVIDIA graphics with the proprietary drivers, the nvdec plugin (recently renamed nvh264dec) can be used for accelerated video decoding on the NVIDIA GPU with CUDA. The nvdec 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. This plugin should be used with the -vd nvdec (or nvh264dec) and -vs glimagesink uxplay options.

+

For NVIDIA graphics with the proprietary drivers, the nvdec plugin (recently renamed nvh264dec) can be used for accelerated video decoding on the NVIDIA GPU with CUDA. The nvdec 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. This plugin should be used with the -vd nvdec (or nvh264dec) and -vs glimagesink uxplay options.

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 e37e293..d81516c 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ accelerated video decoding on the NVIDIA GPU with CUDA. The nvdec plugin is par 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), and +Users must do this themselves: see [these instructions](https://github.com/FDH2/UxPlay/wiki/NVIDIA-nvdec-and-nvenc-plugins), and adapt them as necessary for your GStreamer installation. This plugin should be used with the `-vd nvdec` (or nvh264dec) and `-vs glimagesink` uxplay options. @@ -82,9 +82,9 @@ This plugin should be used with the `-vd nvdec` (or nvh264dec) and `-vs glimages Raspberry Pi (RPi) computers can run UxPlay with software decoding of h264 video (options `uxplay -rpi -avdec`) but this usually has unacceptable latency, and hardware-accelerated decoding by the Pi's built-in Broadcom GPU should be used. - RPi OS (Bulseye) has abandoned the omx (OpenMAX) driver used till now for this by [RPiPlay](http://github.com/FD-/RPiPlay), in + RPi OS (Bullseye) has abandoned the omx (OpenMAX) driver used till now for this by [RPiPlay](http://github.com/FD-/RPiPlay), in favor of v4l2 (Video4Linux2). The GStreamer Video4Linux2 plugin only works with UxPlay since GStreamer-1.21.0.0 on the development branch, - but backports to 1.18.4 for RPi OS (Bullseye) are appearing in current updates. In case the latest update has not yet appeared, or you + but a (partial) backport to 1.18.4 for RPi OS (Bullseye) has already appeared in current updates. In case the full update has not yet appeared, or you are using a different distribution, you can find [patching instructions](https://github.com/FDH2/UxPlay/wiki/Gstreamer-Video4Linux2-plugin-patches) in the [UxPlay Wiki](https://github.com/FDH2/UxPlay/wiki). Use the options `uxplay -rpi` ( diff --git a/README.txt b/README.txt index 193f0f1..99fcaa7 100644 --- a/README.txt +++ b/README.txt @@ -97,7 +97,7 @@ 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), +instructions](https://github.com/FDH2/UxPlay/wiki/NVIDIA-nvdec-and-nvenc-plugins), and adapt them as necessary for your GStreamer installation. This plugin should be used with the `-vd nvdec` (or nvh264dec) and `-vs glimagesink` uxplay options. @@ -107,14 +107,15 @@ uxplay options. Raspberry Pi (RPi) computers can run UxPlay with software decoding of h264 video (options `uxplay -rpi -avdec`) but this usually has unacceptable latency, and hardware-accelerated decoding by the Pi's - built-in Broadcom GPU should be used. RPi OS (Bulseye) has abandoned - the omx (OpenMAX) driver used till now for this by + built-in Broadcom GPU should be used. RPi OS (Bullseye) has + abandoned the omx (OpenMAX) driver used till now for this by [RPiPlay](http://github.com/FD-/RPiPlay), in favor of v4l2 (Video4Linux2). The GStreamer Video4Linux2 plugin only works with - UxPlay since GStreamer-1.21.0.0 on the development branch, but - backports to 1.18.4 for RPi OS (Bullseye) are appearing in current - updates. In case the latest update has not yet appeared, or you are - using a different distribution, you can find [patching + UxPlay since GStreamer-1.21.0.0 on the development branch, but a + (partial) backport to 1.18.4 for RPi OS (Bullseye) has already + appeared in current updates. In case the full update has not yet + appeared, or you are using a different distribution, you can find + [patching instructions](https://github.com/FDH2/UxPlay/wiki/Gstreamer-Video4Linux2-plugin-patches) in the [UxPlay Wiki](https://github.com/FDH2/UxPlay/wiki). Use the options `uxplay -rpi` ( or `uxplay -rpi -vs kmssink` on RPi OS Lite