edit README

This commit is contained in:
fduncanh
2022-03-03 02:04:48 -05:00
parent 80052546e1
commit df1de2aa9d
3 changed files with 4 additions and 4 deletions

View File

@@ -18,7 +18,7 @@
<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://gist.github.com/corenel/a615b6f7eb5b5425aa49343a7b409200">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>The Raspberry Pi has a Broadcom GPU which is needed for hardware-accelerated h264 decoding, as UxPlay has unacceptible latency on the Pi when software decoding is used. The Pi has been supported by <a href="http://github.com/FD-/RPiPlay">RPiPlay</a> using omx (OpenMAX) drivers. These 32-bit drivers are deprecated, and were recently removed from Raspberry Pi OS (Bullseye). The designated replacement for OpenMAX is Video4linux2, and the options that <em>should</em> provide hardware decoding with UxPlay are <code>-vd v4l2h264dec</code> (best supplemented with <code>-vc v4l2convert</code>), which is a plugin from gstreamer1.0-plugins-good. Unfortunately, with this plugin GStreamer “caps negotiation” usually fails; a workaround has not yet been found. This is currently an open <a href="https://github.com/FDH2/UxPlay/issues/70">Issue</a>. ** UxPlay support for the Pi may need to wait for a fix to the v4l2 plugin.**</p>
<p>The Raspberry Pi has a Broadcom GPU which is needed for hardware-accelerated h264 decoding, as UxPlay has unacceptible latency on the Pi when software decoding is used. The Pi has been supported by <a href="http://github.com/FD-/RPiPlay">RPiPlay</a> using omx (OpenMAX) drivers. These 32-bit drivers are deprecated, and were recently removed from Raspberry Pi OS (Bullseye). The designated replacement for OpenMAX is Video4linux2, and the options that <em>should</em> provide hardware decoding with UxPlay are <code>-vd v4l2h264dec</code> (best supplemented with <code>-vc v4l2convert</code>), which is a plugin from gstreamer1.0-plugins-good. Unfortunately, with this plugin GStreamer “caps negotiation” usually fails; a workaround has not yet been found. This is currently an open <a href="https://github.com/FDH2/UxPlay/issues/70">Issue</a>. <strong>UxPlay support for the Pi may need to wait for a fix to the v4l2 plugin.</strong></p>
<h3 id="note-to-packagers-openssl-3.0.0-solves-gpl-v3-license-issues.">Note to packagers: OpenSSL-3.0.0 solves GPL v3 license issues.</h3>
<p>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.</p>
<p>For “GPL-strict” distributions, UxPlay can be built using OpenSSL- 3.0.0, which has a new <a href="https://www.openssl.org/blog/blog/2021/09/07/OpenSSL3.Final/">GPLv3-compatible license</a>.</p>

View File

@@ -83,7 +83,7 @@ The designated replacement for OpenMAX is Video4linux2, and the options that _sh
are `-vd v4l2h264dec`
(best supplemented with `-vc v4l2convert`), which is a plugin from gstreamer1.0-plugins-good.
Unfortunately, with this plugin GStreamer "caps negotiation" usually fails; a workaround has not yet been found. This is currently
an open [Issue](https://github.com/FDH2/UxPlay/issues/70). ** UxPlay support for the Pi may need to wait for a fix to the v4l2 plugin.**
an open [Issue](https://github.com/FDH2/UxPlay/issues/70). **UxPlay support for the Pi may need to wait for a fix to the v4l2 plugin.**
### Note to packagers: OpenSSL-3.0.0 solves GPL v3 license issues.

View File

@@ -111,8 +111,8 @@ with UxPlay are `-vd v4l2h264dec` (best supplemented with
`-vc v4l2convert`), which is a plugin from gstreamer1.0-plugins-good.
Unfortunately, with this plugin GStreamer "caps negotiation" usually
fails; a workaround has not yet been found. This is currently an open
[Issue](https://github.com/FDH2/UxPlay/issues/70). \*\* UxPlay support
for the Pi may need to wait for a fix to the v4l2 plugin.\*\*
[Issue](https://github.com/FDH2/UxPlay/issues/70). **UxPlay support for
the Pi may need to wait for a fix to the v4l2 plugin.**
### Note to packagers: OpenSSL-3.0.0 solves GPL v3 license issues.