edit README

This commit is contained in:
fduncanh
2022-03-20 02:21:28 -04:00
parent 6a5f0cf817
commit f6929db17b
3 changed files with 23 additions and 22 deletions

View File

@@ -18,7 +18,7 @@
<h3 id="possibility-for-using-hardware-accelerated-h264-video-decoding-if-available.">Possibility for using hardware-accelerated h264 video-decoding, if available.</h3>
<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. 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.</p>
<p>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 GPUs (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).</p>
<p>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 NVIDIAs 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://github.com/FDH2/UxPlay/wiki/NVIDIA-nvdec-and-nvenc-plugins">these instructions</a>, and adapt them as necessary for your GStreamer installation. This plugin should be used with the <code>-vd nvdec</code> (or nvh264dec) and <code>-vs glimagesink</code> uxplay options.</p>
<p>For NVIDIA graphics with the proprietary drivers, the <code>nvh264dec</code> plugin (included in gstreamer1.0-plugins-bad since GStreamer-1.18.0) can be used for accelerated video decoding on the NVIDIA GPU after NVIDIAs CUDA toolkit is installed. This plugin should be used with options <code>uxplay -vd nvh264dec -vs glimagesink</code>. For GStreamer-1.16 or earlier, the plugin is called <code>nvdec</code>, and must be build by the user, using NVIDIAs proprietary <a href="https://docs.nvidia.com/video-technologies/video-codec-sdk/nvdec-video-decoder-api-prog-guide/">Video Codec SDK</a>. This must be downloaded, and three header files from it must be added to the gstreamer source before the plugin can be compiled: see <a href="https://github.com/FDH2/UxPlay/wiki/NVIDIA-nvdec-and-nvenc-plugins">these instructions</a>. This older form of the plugin should be used with the <code>-vd nvdec -vs glimagesink</code> uxplay options.</p>
<ul>
<li><p><strong>GPU Support for Raspberry Pi</strong></p>
<p>Raspberry Pi (RPi) computers can run UxPlay with software decoding of h264 video (options <code>uxplay -rpi -avdec</code>) but this usually has unacceptable latency, and hardware-accelerated decoding by the Pis built-in Broadcom GPU should be used. RPi OS (Bullseye) has abandoned the omx (OpenMAX) driver used till now for this by <a href="http://github.com/FD-/RPiPlay">RPiPlay</a>, in favor of v4l2 (Video4Linux2). The GStreamer Video4Linux2 plugin only works with 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 <a href="https://github.com/FDH2/UxPlay/wiki/Gstreamer-Video4Linux2-plugin-patches">patching instructions</a> in the <a href="https://github.com/FDH2/UxPlay/wiki">UxPlay Wiki</a>. Use the options <code>uxplay -rpi</code> ( or <code>uxplay -rpi -vs kmssink</code> on RPi OS Lite with no X11) with the patched GStreamer. Patches for GStreamer-1.18.5 (used in Ubuntu 21.10 for RPi) and GStreamer-1.20.0 (used in Manjaro for RPi) are also available there.</p></li>

View File

@@ -69,14 +69,15 @@ For systems with Intel integrated graphics, hardware GPU decoding with the gstre
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](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://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.
For NVIDIA graphics with the proprietary drivers, the `nvh264dec` plugin
(included in gstreamer1.0-plugins-bad since GStreamer-1.18.0)
can be used for accelerated video decoding on the NVIDIA GPU after
NVIDIA's CUDA toolkit is installed. This plugin should be used with options
`uxplay -vd nvh264dec -vs glimagesink`. For GStreamer-1.16 or earlier, the
plugin is called `nvdec`, and must be build by the user, using NVIDIA's
proprietary [Video Codec SDK](https://docs.nvidia.com/video-technologies/video-codec-sdk/nvdec-video-decoder-api-prog-guide/).
This must be downloaded, and three header files from it must be added to the gstreamer source before the plugin can be compiled: see [these instructions](https://github.com/FDH2/UxPlay/wiki/NVIDIA-nvdec-and-nvenc-plugins).
This older form of the plugin should be used with the `-vd nvdec -vs glimagesink` uxplay options.
* **GPU Support for Raspberry Pi**

View File

@@ -88,19 +88,19 @@ 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](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://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.
For NVIDIA graphics with the proprietary drivers, the `nvh264dec` plugin
(included in gstreamer1.0-plugins-bad since GStreamer-1.18.0) can be
used for accelerated video decoding on the NVIDIA GPU after NVIDIA's
CUDA toolkit is installed. This plugin should be used with options
`uxplay -vd nvh264dec -vs glimagesink`. For GStreamer-1.16 or earlier,
the plugin is called `nvdec`, and must be build by the user, using
NVIDIA's proprietary [Video Codec
SDK](https://docs.nvidia.com/video-technologies/video-codec-sdk/nvdec-video-decoder-api-prog-guide/).
This must be downloaded, and three header files from it must be added to
the gstreamer source before the plugin can be compiled: see [these
instructions](https://github.com/FDH2/UxPlay/wiki/NVIDIA-nvdec-and-nvenc-plugins).
This older form of the plugin should be used with the
`-vd nvdec -vs glimagesink` uxplay options.
- **GPU Support for Raspberry Pi**