Update README for 1.66 release

This commit is contained in:
F. Duncanh
2023-09-05 17:26:28 -04:00
parent e8e64b6119
commit 5051fc3ac7
6 changed files with 58 additions and 42 deletions

View File

@@ -444,8 +444,8 @@ client drops the connection; since UxPlay-1.58, the option
requests a connection, it removes the current client and takes over.
UxPlay 1.66 introduces a mechanism ( <code>-restrict</code>,
<code>-allow &lt;id&gt;</code>, <code>-block &lt;id&gt;</code>) to
control which clients are allowed to connect, using their immutable
“clientID”.</p></li>
control which clients are allowed to connect, using their “deviceID”
(which appears to be immutable).</p></li>
<li><p>In Mirror mode, GStreamer has a choice of <strong>two</strong>
methods to play video with its accompanying audio: prior to UxPlay-1.64,
the video and audio streams were both played as soon as possible after
@@ -845,8 +845,9 @@ environment, in the Windows Terminal, with
<li>These can also be written (one option per line, without the initial
<code>-</code>” character) in the UxPlay startup file (either given by
environment variable <code>$UXPLAYRC</code>, or <code>~/.uxplayrc</code>
or <code>~/.config/uxplayrc</code>). Command line options supersede
options in the startup file.</li>
or <code>~/.config/uxplayrc</code>); lines begining with
<code>#</code>” are treated as comments, and ignored. Command line
options supersede options in the startup file.</li>
</ul>
<p><strong>-n server_name</strong> (Default: UxPlay);
server_name@_hostname_ will be the name that appears offering AirPlay
@@ -1017,20 +1018,23 @@ when the GStreamer pipeline is closed.</em></p>
client attempts to connect. Without this option, the current client
maintains exclusive ownership of UxPlay until it disconnects.</p>
<p><strong>-restrict</strong> Restrict clients allowed to connect to
those specified by <code>-allow &lt;clientID&gt;</code>. The ClientID is
the true MAC address (in iOS it is listed in Settings-&gt;General-&gt;Wi
Fi Address), which is displayed by UxPlay when the client attempts to
connect. It has the format <code>XX:XX:XX:XX:XX:XX</code>, X =
0-9,A-F.</p>
those specified by <code>-allow &lt;deviceID&gt;</code>. The deviceID
has the form of a MAC address which is displayed by UxPlay when the
client attempts to connect, and appears to be immutable. It has the
format <code>XX:XX:XX:XX:XX:XX</code>, X = 0-9,A-F, and is possibly the
“true” hardware MAC address of the device. Note that iOS clients
generally expose different random “private Wi_Fi addresses” (“fake” MAC
addresses) to different networks (for privacy reasons, to prevent
tracking), which may change, and do not correpond to the deviceID.</p>
<p><strong>-restrict no</strong> Remove restrictions (default). This is
useful as a command-line argument to overide restrictions set in the
Startup file.</p>
<p><strong>-allow <em>id</em></strong> Adds the clientID = <em>id</em>
<p><strong>-allow <em>id</em></strong> Adds the deviceID = <em>id</em>
to the list of allowed clients when client restrictions are being
enforced. Usually this will be an entry in the uxplayrc startup
file.</p>
<p><strong>-block <em>id</em></strong> Always block clients with
clientID = <em>id</em>, even when client restrictions are not being
deviceID = <em>id</em>, even when client restrictions are not being
enforced generally. Usually this will be an entry in the uxplayrc
startup file.</p>
<p><strong>-FPSdata</strong> Turns on monitoring of regular reports
@@ -1387,8 +1391,10 @@ introduced 2017, running tvOS 12.2.1), so it does not seem to matter
what UxPlay claims to be.</p>
<h1 id="changelog">Changelog</h1>
<p>1.66 2023-09-05 Fix IPV6 support. Add option to restrict clients to
those on a list of allowed clientIDs, or to block connections from
clients on a list of blocked clientIDs.</p>
those on a list of allowed deviceIDs, or to block connections from
clients on a list of blocked deviceIDs. Fix for #207 from <span
class="citation" data-cites="thiccaxe">@thiccaxe</span> (screen lag in
vsync mode after client wakes from sleep).</p>
<p>1.65.3 2023-07-23 Add RPM spec file; add warning if required
gstreamer libav feature “avdec_aac” is missing: (this occurs in
RPM-based distributions that ship an incomplete FFmpeg for Patent or

View File

@@ -363,7 +363,7 @@ help with this or other problems.
its current client until that client drops the connection; since UxPlay-1.58, the option `-nohold` modifies this
behavior so that when a new client requests a connection, it removes the current client and takes over. UxPlay 1.66 introduces
a mechanism ( `-restrict`, ``-allow <id>``, ```-block <id>```) to control which clients are allowed to connect, using their
immutable "clientID".
"deviceID" (which appears to be immutable).
* In Mirror mode, GStreamer has a choice of **two** methods to play video with its accompanying audio: prior to UxPlay-1.64,
the video and audio streams were both played as soon as possible after they arrived (the GStreamer "_sync=false_" method), with
@@ -666,7 +666,8 @@ the Windows Terminal, with `C:\msys64\mingw64\bin\uxplay`.
Options:
* These can also be written (one option per line, without the initial "`-`" character) in the UxPlay startup file (either given by
environment variable `$UXPLAYRC`, or ``~/.uxplayrc`` or ```~/.config/uxplayrc```). Command line options supersede options in the startup file.
environment variable `$UXPLAYRC`, or ``~/.uxplayrc`` or ```~/.config/uxplayrc```); lines begining
with "`#`" are treated as comments, and ignored. Command line options supersede options in the startup file.
**-n server_name** (Default: UxPlay); server_name@_hostname_ will be the name that appears offering
AirPlay services to your iPad, iPhone etc, where _hostname_ is the name of the server running uxplay.
@@ -810,17 +811,19 @@ which will not work if a firewall is running.
**-nohold** Drops the current connection when a new client attempts to connect. Without this option,
the current client maintains exclusive ownership of UxPlay until it disconnects.
**-restrict** Restrict clients allowed to connect to those specified by `-allow <clientID>`. The ClientID is the
true MAC address (in iOS it is listed in Settings->General->Wi Fi Address), which is displayed by UxPlay when
the client attempts to connect. It has the format `XX:XX:XX:XX:XX:XX`, X = 0-9,A-F.
**-restrict** Restrict clients allowed to connect to those specified by `-allow <deviceID>`. The deviceID has the
form of a MAC address which is displayed by UxPlay when the client attempts to connect, and appears to be immutable. It
has the format `XX:XX:XX:XX:XX:XX`, X = 0-9,A-F, and is possibly the "true" hardware
MAC address of the device. Note that iOS clients generally expose different random "private Wi_Fi addresses" ("fake" MAC addresses) to
different networks (for privacy reasons, to prevent tracking), which may change, and do not correpond to the deviceID.
**-restrict no** Remove restrictions (default). This is useful as a command-line argument to overide restrictions set
in the Startup file.
**-allow _id_** Adds the clientID = _id_ to the list of allowed clients when client restrictions
**-allow _id_** Adds the deviceID = _id_ to the list of allowed clients when client restrictions
are being enforced. Usually this will be an entry in the uxplayrc startup file.
**-block _id_** Always block clients with clientID = _id_, even when client restrictions are not
**-block _id_** Always block clients with deviceID = _id_, even when client restrictions are not
being enforced generally. Usually this will be an entry in the uxplayrc startup file.
**-FPSdata** Turns on monitoring of regular reports about video streaming performance
@@ -1099,8 +1102,9 @@ tvOS 12.2.1), so it does not seem to matter what UxPlay claims to be.
# Changelog
1.66 2023-09-05 Fix IPV6 support. Add option to restrict clients to those on a list of allowed clientIDs,
or to block connections from clients on a list of blocked clientIDs.
1.66 2023-09-05 Fix IPV6 support. Add option to restrict clients to those on a list of allowed deviceIDs,
or to block connections from clients on a list of blocked deviceIDs. Fix for #207 from
@thiccaxe (screen lag in vsync mode after client wakes from sleep).
1.65.3 2023-07-23 Add RPM spec file; add warning if required gstreamer libav feature "avdec_aac" is
missing: (this occurs in RPM-based distributions that ship an incomplete FFmpeg for Patent

View File

@@ -436,7 +436,7 @@ below for help with this or other problems.
connection, it removes the current client and takes over. UxPlay
1.66 introduces a mechanism ( `-restrict`, `-allow <id>`,
`-block <id>`) to control which clients are allowed to connect,
using their immutable "clientID".
using their "deviceID" (which appears to be immutable).
- In Mirror mode, GStreamer has a choice of **two** methods to play
video with its accompanying audio: prior to UxPlay-1.64, the video
@@ -845,7 +845,8 @@ Options:
- These can also be written (one option per line, without the initial
"`-`" character) in the UxPlay startup file (either given by
environment variable `$UXPLAYRC`, or `~/.uxplayrc` or
`~/.config/uxplayrc`). Command line options supersede options in the
`~/.config/uxplayrc`); lines begining with "`#`" are treated as
comments, and ignored. Command line options supersede options in the
startup file.
**-n server_name** (Default: UxPlay); server_name@\_hostname\_ will be
@@ -1030,19 +1031,23 @@ connect. Without this option, the current client maintains exclusive
ownership of UxPlay until it disconnects.
**-restrict** Restrict clients allowed to connect to those specified by
`-allow <clientID>`. The ClientID is the true MAC address (in iOS it is
listed in Settings-\>General-\>Wi Fi Address), which is displayed by
UxPlay when the client attempts to connect. It has the format
`XX:XX:XX:XX:XX:XX`, X = 0-9,A-F.
`-allow <deviceID>`. The deviceID has the form of a MAC address which is
displayed by UxPlay when the client attempts to connect, and appears to
be immutable. It has the format `XX:XX:XX:XX:XX:XX`, X = 0-9,A-F, and is
possibly the "true" hardware MAC address of the device. Note that iOS
clients generally expose different random "private Wi_Fi addresses"
("fake" MAC addresses) to different networks (for privacy reasons, to
prevent tracking), which may change, and do not correpond to the
deviceID.
**-restrict no** Remove restrictions (default). This is useful as a
command-line argument to overide restrictions set in the Startup file.
**-allow *id*** Adds the clientID = *id* to the list of allowed clients
**-allow *id*** Adds the deviceID = *id* to the list of allowed clients
when client restrictions are being enforced. Usually this will be an
entry in the uxplayrc startup file.
**-block *id*** Always block clients with clientID = *id*, even when
**-block *id*** Always block clients with deviceID = *id*, even when
client restrictions are not being enforced generally. Usually this will
be an entry in the uxplayrc startup file.
@@ -1417,8 +1422,9 @@ what UxPlay claims to be.
# Changelog
1.66 2023-09-05 Fix IPV6 support. Add option to restrict clients to
those on a list of allowed clientIDs, or to block connections from
clients on a list of blocked clientIDs.
those on a list of allowed deviceIDs, or to block connections from
clients on a list of blocked deviceIDs. Fix for #207 from @thiccaxe
(screen lag in vsync mode after client wakes from sleep).
1.65.3 2023-07-23 Add RPM spec file; add warning if required gstreamer
libav feature "avdec_aac" is missing: (this occurs in RPM-based

View File

@@ -92,15 +92,15 @@ UxPlay 1.66: An open\-source AirPlay mirroring (+ audio streaming) server:
.TP
\fB\-nohold\fR Drop current connection when new client connects.
.TP
\fB\-restrict\fR Restrict clients to those specified by "-allow clientID".
\fB\-restrict\fR Restrict clients to those specified by "-allow deviceID".
.IP
Uxplay displays clientID when a client attempts connection.
Uxplay displays deviceID when a client attempts to connect.
.IP
Use "-restrict no" for no client restrictions (default).
.PP
\fB\-allow\fR id Permit clientID = id to connect if restrictions are imposed.
\fB\-allow\fR id Permit deviceID = id to connect if restrictions are imposed.
.TP
\fB\-block\fR id Always block connections from clientID = id.
\fB\-block\fR id Always block connections from deviceID = id.
.TP
\fB\-FPSdata\fR Show video-streaming performance reports sent by client.
.TP

View File

@@ -445,11 +445,11 @@ static void print_info (char *name) {
printf("-reset n Reset after 3n seconds client silence (default %d, 0=never)\n", NTP_TIMEOUT_LIMIT);
printf("-nc do Not Close video window when client stops mirroring\n");
printf("-nohold Drop current connection when new client connects.\n");
printf("-restrict Restrict clients to those specified by \"-allow <clientID>\"\n");
printf(" UxPlay displays clientID when a client attempts connection\n");
printf("-restrict Restrict clients to those specified by \"-allow <deviceID>\"\n");
printf(" UxPlay displays deviceID when a client attempts to connect\n");
printf(" Use \"-restrict no\" for no client restrictions (default)\n");
printf("-allow <i>Permit clientID = <i> to connect if restrictions are imposed\n");
printf("-block <i>Always block connections from clientID = <i>\n");
printf("-allow <i>Permit deviceID = <i> to connect if restrictions are imposed\n");
printf("-block <i>Always block connections from deviceID = <i>\n");
printf("-FPSdata Show video-streaming performance reports sent by client.\n");
printf("-fps n Set maximum allowed streaming framerate, default 30\n");
printf("-f {H|V|I}Horizontal|Vertical flip, or both=Inversion=rotate 180 deg\n");

View File

@@ -1,5 +1,5 @@
Name: uxplay
Version: 1.65.3
Version: 1.66
Release: 1%{?dist}
%global gittag v%{version}
@@ -134,7 +134,7 @@ cd build
%{_docdir}/%{name}/llhttp/LICENSE-MIT
%changelog
* Thu Aug 24 2023 UxPlay maintainer <https://github.com/FDH2/UxPlay>
* Wed Sep 6 2023 UxPlay maintainer <https://github.com/FDH2/UxPlay>
Initial uxplay.spec: tested on Fedora 38, Rocky Linux 9.2, OpenSUSE
Leap 15.5, Mageia 9, OpenMandriva ROME, PCLinuxOS
-