morgan/UxPlay
1
0
Fork 0
mirror of https://github.com/morgan9e/UxPlay synced 2026-04-14 00:04:13 +09:00
Code Issues Packages Projects Releases Wiki Activity

edit README

Browse Source
This commit is contained in:
fduncanh
2022-02-25 13:48:16 -05:00
parent 288274304a
commit c8d4cab59d
3 changed files with 22 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.html
View File

@@ -15,8 +15,8 @@
<p>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). <em>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.</em> <strong>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.</strong></p>
<p>UxPlay is tested on a number of systems, including (among others) Debian 10.11 “Buster” and 11.2 “Bullseye”, Ubuntu 20.04 and 21.10, Linux Mint 20.2, Pop!_OS 21.10 (NVIDIA edition), Rocky Linux 8.5 (a CentOS successor), OpenSUSE 15.3, Arch Linux 5.16.8, macOS 10.15.7, FreeBSD 13.0.</p>
<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. Gstreamer decoding is plugin agnostic, and uses accelerated decoders if available. For Intel integrated graphics, the VAAPI plugin is preferable. VAAPI is convenient for Intel and some AMD systems.</p>
<p>For NVIDIA graphics with the proprietary drivers, the nvdec plugin (now renamed nvh264dec) can be used with the NVIDIA GPU. This plugin is part of gstreamer1.0-plugins-bad, but is generally not included in binary packages, as NVIDIA’s 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> The plugin should be used with the <code>-vc nvdec</code> (or nvh264dec) and <code>-vs glimagesink</code> uxplay options.</p>
<p>The 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 decoding is not used, as its CPU is not powerful enough for satisfactory software h264 video decoding). The -vd, -vc, and -vs uxplay options can be used to create GStreamer video pipelines to use non-VAAPI hardware decoders, and an option -rpi does this for the Raspberry Pi.</p>
<p>For NVIDIA graphics with the proprietary drivers, the nvdec plugin (recently renamed nvh264dec) can be used with the NVIDIA GPU. This plugin is part of gstreamer1.0-plugins-bad, but is generally not included in binary packages, as NVIDIA’s 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> The plugin should be used with the <code>-vd nvdec</code> (or nvh264dec) and <code>-vs glimagesink</code> uxplay options.</p>
<p>The 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.</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>

17
README.md
View File

@@ -61,17 +61,18 @@ This means that video and audio are supported "out of the box", using a choice o
Gstreamer decoding is plugin agnostic, and uses accelerated decoders if
available. For Intel integrated graphics, the VAAPI plugin is preferable. VAAPI is convenient for Intel and some AMD systems.
For NVIDIA graphics with the proprietary drivers, the nvdec plugin (now renamed nvh264dec) can be used with the NVIDIA GPU.
For NVIDIA graphics with the proprietary drivers, the nvdec plugin (recently renamed nvh264dec) can be used with 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](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.
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)
The plugin should be used with the `-vc nvdec` (or nvh264dec) and `-vs glimagesink` uxplay options.
The plugin should be used with the `-vd nvdec` (or nvh264dec) and `-vs glimagesink` uxplay options.
The 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 decoding is not used, as its CPU is not powerful enough for
satisfactory software h264 video decoding). The -vd, -vc, and -vs uxplay options
can be used to create GStreamer video pipelines to use non-VAAPI hardware decoders, and an option -rpi does this for the Raspberry Pi.
The 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.
### Note to packagers: OpenSSL-3.0.0 solves GPL v3 license issues.

21
README.txt
View File

@@ -77,25 +77,26 @@ plugin agnostic, and uses accelerated decoders if available. For Intel
integrated graphics, the VAAPI plugin is preferable. VAAPI is convenient
for Intel and some AMD systems.
For NVIDIA graphics with the proprietary drivers, the nvdec plugin (now
renamed nvh264dec) can be used with 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
For NVIDIA graphics with the proprietary drivers, the nvdec plugin
(recently renamed nvh264dec) can be used with 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](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)
The plugin should be used with the `-vc nvdec` (or nvh264dec) and
The plugin should be used with the `-vd nvdec` (or nvh264dec) and
`-vs glimagesink` uxplay options.
The 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 decoding is
not used, as its CPU is not powerful enough for satisfactory software
h264 video decoding). The -vd, -vc, and -vs uxplay options can be used
to create GStreamer video pipelines to use non-VAAPI hardware decoders,
and an option -rpi does this for the Raspberry Pi.
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.
### Note to packagers: OpenSSL-3.0.0 solves GPL v3 license issues.