Edited README to point to wiki patching instructions

This commit is contained in:
fduncanh
2022-03-14 13:42:53 -04:00
parent 6ea27f5796
commit 6d97fc6d75
3 changed files with 26 additions and 24 deletions

View File

@@ -21,7 +21,7 @@
<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>
<ul>
<li><p><strong>GPU Support for Raspberry Pi</strong></p>
<p>Raspberry Pi computers can run UxPlay with software decoding of h264 video (options <code>uxplay -rpi -avdec</code>) but this usually has unacceptible latency, and hardware-accelerated decoding by the Pis built-in Broadcom GPU should be used. UxPlays antecedent <a href="http://github.com/FD-/RPiPlay">RPiPlay</a> was developed to use the 32-bit-only omx (OpenMAX) driver for this, but omx has recently been declared obsolete and abandoned in “legacy” status by Raspberry Pi OS (Bullseye). The GStreamer plugin for its replacement v4l2 (Video4Linux2) has until recently been unusable with UxPlay, but new fixes in the GStreamer development branch have changed this. Backports (as patches) to GStreamer 1.18.4 (RPi OS Bullseye), 1.18.5 (Ubuntu 21.10) and 1.20.0 (Manjaro) are now available <a href="https://github.com/FDH2/UxPlay/issues/70">here</a>, until distributions release them as updates, and work well with UxPlay, using a new option <code>uxplay -rpi</code> (tested on RPi model 4B). When using RPi OS Lite (no X11), use <code>uxplay -rpi -vs kmssink</code>.</p></li>
<p>Raspberry Pi (RPi) computers can run UxPlay with software decoding of h264 video (options <code>uxplay -rpi -avdec</code>) but this usually has unacceptible 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 backport to 1.18.4 for RPi OS (Bullseye) has been created, and will appear in some future update. If you cannot wait for the update, 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>
</ul>
<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>

View File

@@ -80,17 +80,18 @@ This plugin should be used with the `-vd nvdec` (or nvh264dec) and `-vs glimages
* **GPU Support for Raspberry Pi**
Raspberry Pi computers can run UxPlay with software decoding of h264 video (options `uxplay -rpi -avdec`) but this usually
Raspberry Pi (RPi) computers can run UxPlay with software decoding of h264 video (options `uxplay -rpi -avdec`) but this usually
has unacceptible latency, and hardware-accelerated decoding by the Pi's built-in Broadcom GPU should be used.
UxPlay's antecedent [RPiPlay](http://github.com/FD-/RPiPlay) was developed to use the 32-bit-only omx (OpenMAX) driver for this, but omx
has recently been declared obsolete and abandoned in "legacy" status by Raspberry Pi OS (Bullseye). The GStreamer plugin for its
replacement v4l2 (Video4Linux2) has until recently been unusable with UxPlay, but new fixes in the GStreamer development branch have
changed this. Backports (as patches) to GStreamer 1.18.4 (RPi OS Bullseye), 1.18.5 (Ubuntu 21.10) and 1.20.0 (Manjaro) are now
available [here](https://github.com/FDH2/UxPlay/issues/70), until distributions release them as updates, and work well with UxPlay,
using a new option `uxplay -rpi` (tested on RPi model 4B). When using RPi OS Lite (no X11), use `uxplay -rpi -vs kmssink`.
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 a backport to 1.18.4 for RPi OS (Bullseye) has been created, and will appear in some future update. If you cannot wait for the update,
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 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.
### 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

View File

@@ -104,22 +104,23 @@ uxplay options.
- **GPU Support for Raspberry Pi**
Raspberry Pi computers can run UxPlay with software decoding of h264
video (options `uxplay -rpi -avdec`) but this usually has
Raspberry Pi (RPi) computers can run UxPlay with software decoding
of h264 video (options `uxplay -rpi -avdec`) but this usually has
unacceptible latency, and hardware-accelerated decoding by the Pi's
built-in Broadcom GPU should be used. UxPlay's antecedent
[RPiPlay](http://github.com/FD-/RPiPlay) was developed to use the
32-bit-only omx (OpenMAX) driver for this, but omx has recently been
declared obsolete and abandoned in "legacy" status by Raspberry Pi
OS (Bullseye). The GStreamer plugin for its replacement v4l2
(Video4Linux2) has until recently been unusable with UxPlay, but new
fixes in the GStreamer development branch have changed this.
Backports (as patches) to GStreamer 1.18.4 (RPi OS Bullseye), 1.18.5
(Ubuntu 21.10) and 1.20.0 (Manjaro) are now available
[here](https://github.com/FDH2/UxPlay/issues/70), until
distributions release them as updates, and work well with UxPlay,
using a new option `uxplay -rpi` (tested on RPi model 4B). When
using RPi OS Lite (no X11), use `uxplay -rpi -vs kmssink`.
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 a
backport to 1.18.4 for RPi OS (Bullseye) has been created, and will
appear in some future update. If you cannot wait for the update, 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
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.
### Note to packagers: OpenSSL-3.0.0 solves GPL v3 license issues.