diff --git a/README.html b/README.html index 4013045..74f8182 100644 --- a/README.html +++ b/README.html @@ -76,22 +76,22 @@

Usage

Options:

+

-p allows you to select the network ports used by UxPlay (these need to be opened if the server is behind a firewall). By itself, -p sets “legacy” ports TCP 7100, 7000, 7001, UDP 6000, 6001, 7011. -p n (e.g. -p 35000) sets TCP and UDP ports n, n+1, n+2. -p n1,n2,n3 (comma-separated values) sets each port separately; -p n1,n2 sets ports n1,n2,n2+1. -p tcp n or -p udp n sets just the TCP or UDP ports. Ports must be in the range [1024-65535].

+

If the -p option is not used, the ports are chosen dynamically (randomly), which will not work if a firewall is running.

-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. This will also now be the name shown above the mirror display (X11) window.

-nh Do not append “@_hostname_” at the end of the AirPlay server name.

-s wxh (e.g. -s 1920x1080 , which is the default ) sets the display resolution (width and height, in pixels). (This may be a request made to the AirPlay client, and perhaps will not be the final resolution you get.) w and h are whole numbers with four digits or less. Note that the height pixel size is the controlling one used by the client for determining the streaming format; the width is dynamically adjusted to the shape of the image (portrait or landscape format, depending on how an iPad is held, for example).

-s wxh@r As above, but also informs the AirPlay client about the screen refresh rate of the display. Default is r=60 (60 Hz); r must be a whole number less than 256.

+

-o turns on an “overscanned” option for the display window. This reduces the image resolution by using some of the pixels requested by option -s wxh (or their default values 1920x1080) by adding an empty boundary frame of unused pixels (which would be lost in a full-screen display that overscans, and is not displayed by gstreamer). Recommendation: don’t use this option unless there is some special reason to use it.

-fps n sets a maximum frame rate (in frames per second) for the AirPlay client to stream video; n must be a whole number less than 256. (The client may choose to serve video at any frame rate lower than this; default is 30 fps.) A setting below 30 fps might be useful to reduce latency if you are running more than one instance of uxplay at the same time. This setting is only an advisory to the client device, so setting a high value will not force a high framerate. (You can test using “-vs fpsdisplaysink” to see what framerate is being received, or use the option -FPSdata which displays video-stream performance data continuously sent by the client during video-streaming.)

-FPSdata Turns on monitoring of regular reports about video streaming performance that are sent by the client. These will be displayed in the terminal window if this option is used. The data is updated by the client at 1 second intervals.

-

-o turns on an “overscanned” option for the display window. This reduces the image resolution by using some of the pixels requested by option -s wxh (or their default values 1920x1080) by adding an empty boundary frame of unused pixels (which would be lost in a full-screen display that overscans, and is not displayed by gstreamer). Recommendation: don’t use this option unless there is some special reason to use it.

-

-p allows you to select the network ports used by UxPlay (these need to be opened if the server is behind a firewall). By itself, -p sets “legacy” ports TCP 7100, 7000, 7001, UDP 6000, 6001, 7011. -p n (e.g. -p 35000) sets TCP and UDP ports n, n+1, n+2. -p n1,n2,n3 (comma-separated values) sets each port separately; -p n1,n2 sets ports n1,n2,n2+1. -p tcp n or -p udp n sets just the TCP or UDP ports. Ports must be in the range [1024-65535].

-

If the -p option is not used, the ports are chosen dynamically (randomly), which will not work if a firewall is running.

-m generates a random MAC address to use instead of the true hardware MAC number of the computer’s network card. (Different server_name, MAC addresses, and network ports are needed for each running uxplay if you attempt to run two instances of uxplay on the same computer.) If UxPlay fails to find the true MAC address of a network card, (more specifically, the MAC address used by the first active network interface detected) a random MAC address will be used even if option -m was not specifed. (Note that a random MAC address will be different each time UxPlay is started).

Also: image transforms that had been added to RPiPlay have been ported to UxPlay:

-f {H|V|I} implements “videoflip” image transforms: H = horizontal flip (right-left flip, or mirror image); V = vertical flip ; I = 180 degree rotation or inversion (which is the combination of H with V).

-r {R|L} 90 degree Right (clockwise) or Left (counter-clockwise) rotations; these are carried out after any -f transforms.

-vp parser choses the GStreamer pipeline’s h264 parser element, default is h264parse. Using quotes “…” allows options to be added.

-vd decoder chooses the GStreamer pipeline’s h264 decoder element, instead of letting decodebin pick it for you. Software decoding is done by avdec_h264; various hardware decoders include: vaapi264dec, nvdec, nvh264dec, v4l2h264dec (these require that the appropriate hardware is available). Using quotes “…” allows some parameters to be included with the decoder name.

-

-vc converter chooses the GStreamer pipeline’s videoconverter element, instead of the default value “videoconvert”. When using video4linux hardware decoding by a GPU,-vc v4l2convert will also use the GPU for video conversion. Using quotes “…” allows some parameters to be included with the converter name.

+

-vc converter chooses the GStreamer pipeline’s videoconverter element, instead of the default value “videoconvert”. When using Video4Linux2 hardware-decoding by a GPU,-vc v4l2convert will also use the GPU for video conversion. Using quotes “…” allows some parameters to be included with the converter name.

-vs videosink chooses the GStreamer videosink, instead of letting autovideosink pick it for you. Some videosink choices are: ximagesink, xvimagesink, vaapisink (for intel graphics), gtksink, glimagesink, waylandsink, osximagesink (for macOS), kmssink (for systems without X11, like Raspberry Pi OS lite) or fpsdisplaysink (which shows the streaming framerate in fps). Using quotes “…” allows some parameters to be included with the videosink name. For example, fullscreen mode is supported by the vaapisink plugin, and is obtained using -vs "vaapisink fullscreen=true"; this also works with waylandsink. The syntax of such options is specific to a given plugin, and some choices of videosink might not work on your system.

-vs 0 suppresses display of streamed video, but plays streamed audio. (The client’s screen is still mirrored at a reduced rate of 1 frame per second, but is not rendered or displayed.) This feature (which streams audio in AAC audio format) is now probably unneeded, as UxPlay can now stream superior-quality Apple Lossless audio without video in Airplay non-mirror mode.

-rpi Video settings for Raspberry Pi, for hardware h264 video decoding in the GPU (requires the video4linux2 plugin from GStreamer-1.21.0 or later, or a backported patched version of an earlier release. (If this is unavailable, use uxplay -rpi -avdec). Uses the glimagesink videosink.

diff --git a/README.md b/README.md index db62c74..f01d050 100644 --- a/README.md +++ b/README.md @@ -285,12 +285,24 @@ as the device is rotated). Options: +**-p** allows you to select the network ports used by UxPlay (these need + to be opened if the server is behind a firewall). By itself, -p sets + "legacy" ports TCP 7100, 7000, 7001, UDP 6000, 6001, 7011. -p n (e.g. -p + 35000) sets TCP and UDP ports n, n+1, n+2. -p n1,n2,n3 (comma-separated + values) sets each port separately; -p n1,n2 sets ports n1,n2,n2+1. -p tcp n + or -p udp n sets just the TCP or UDP ports. Ports must be in the range + [1024-65535]. + +If the -p option is not used, the ports are chosen dynamically (randomly), +which will not work if a firewall is running. + **-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. This will also now be the name shown above the mirror display (X11) window. **-nh** Do not append "@_hostname_" at the end of the AirPlay server name. + **-s wxh** (e.g. -s 1920x1080 , which is the default ) sets the display resolution (width and height, in pixels). (This may be a request made to the AirPlay client, and perhaps will not @@ -303,7 +315,15 @@ Options: **-s wxh@r** As above, but also informs the AirPlay client about the screen refresh rate of the display. Default is r=60 (60 Hz); r must be a whole number less than 256. - + +**-o** turns on an "overscanned" option for the display window. This + reduces the image resolution by using some of the pixels requested + by option -s wxh (or their default values 1920x1080) by adding an empty + boundary frame of unused pixels (which would be lost in a full-screen + display that overscans, and is not displayed by gstreamer). + Recommendation: **don't use this option** unless there is some special + reason to use it. + **-fps n** sets a maximum frame rate (in frames per second) for the AirPlay client to stream video; n must be a whole number less than 256. (The client may choose to serve video at any frame rate lower @@ -319,25 +339,6 @@ Options: that are sent by the client. These will be displayed in the terminal window if this option is used. The data is updated by the client at 1 second intervals. -**-o** turns on an "overscanned" option for the display window. This - reduces the image resolution by using some of the pixels requested - by option -s wxh (or their default values 1920x1080) by adding an empty - boundary frame of unused pixels (which would be lost in a full-screen - display that overscans, and is not displayed by gstreamer). - Recommendation: **don't use this option** unless there is some special - reason to use it. - -**-p** allows you to select the network ports used by UxPlay (these need - to be opened if the server is behind a firewall). By itself, -p sets - "legacy" ports TCP 7100, 7000, 7001, UDP 6000, 6001, 7011. -p n (e.g. -p - 35000) sets TCP and UDP ports n, n+1, n+2. -p n1,n2,n3 (comma-separated - values) sets each port separately; -p n1,n2 sets ports n1,n2,n2+1. -p tcp n - or -p udp n sets just the TCP or UDP ports. Ports must be in the range - [1024-65535]. - -If the -p option is not used, the ports are chosen dynamically (randomly), -which will not work if a firewall is running. - **-m** generates a random MAC address to use instead of the true hardware MAC number of the computer's network card. (Different server_name, MAC addresses, and network ports are needed for each running uxplay if you @@ -366,7 +367,7 @@ Also: image transforms that had been added to RPiPlay have been ported to UxPlay available). Using quotes "..." allows some parameters to be included with the decoder name. **-vc _converter_** chooses the GStreamer pipeline's videoconverter element, instead of the default - value "videoconvert". When using video4linux hardware decoding by a GPU,`-vc v4l2convert` will also use + value "videoconvert". When using Video4Linux2 hardware-decoding by a GPU,`-vc v4l2convert` will also use the GPU for video conversion. Using quotes "..." allows some parameters to be included with the converter name. **-vs _videosink_** chooses the GStreamer videosink, instead of letting diff --git a/README.txt b/README.txt index 9fc313a..9a47c54 100644 --- a/README.txt +++ b/README.txt @@ -386,6 +386,17 @@ Usage Options: +**-p** allows you to select the network ports used by UxPlay (these need +to be opened if the server is behind a firewall). By itself, -p sets +"legacy" ports TCP 7100, 7000, 7001, UDP 6000, 6001, 7011. -p n (e.g. -p +35000) sets TCP and UDP ports n, n+1, n+2. -p n1,n2,n3 (comma-separated +values) sets each port separately; -p n1,n2 sets ports n1,n2,n2+1. -p +tcp n or -p udp n sets just the TCP or UDP ports. Ports must be in the +range \[1024-65535\]. + +If the -p option is not used, the ports are chosen dynamically +(randomly), which will not work if a firewall is running. + **-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. This @@ -407,6 +418,14 @@ an iPad is held, for example). screen refresh rate of the display. Default is r=60 (60 Hz); r must be a whole number less than 256. +**-o** turns on an "overscanned" option for the display window. This +reduces the image resolution by using some of the pixels requested by +option -s wxh (or their default values 1920x1080) by adding an empty +boundary frame of unused pixels (which would be lost in a full-screen +display that overscans, and is not displayed by gstreamer). +Recommendation: **don't use this option** unless there is some special +reason to use it. + **-fps n** sets a maximum frame rate (in frames per second) for the AirPlay client to stream video; n must be a whole number less than 256. (The client may choose to serve video at any frame rate lower than this; @@ -423,25 +442,6 @@ streaming performance that are sent by the client. These will be displayed in the terminal window if this option is used. The data is updated by the client at 1 second intervals. -**-o** turns on an "overscanned" option for the display window. This -reduces the image resolution by using some of the pixels requested by -option -s wxh (or their default values 1920x1080) by adding an empty -boundary frame of unused pixels (which would be lost in a full-screen -display that overscans, and is not displayed by gstreamer). -Recommendation: **don't use this option** unless there is some special -reason to use it. - -**-p** allows you to select the network ports used by UxPlay (these need -to be opened if the server is behind a firewall). By itself, -p sets -"legacy" ports TCP 7100, 7000, 7001, UDP 6000, 6001, 7011. -p n (e.g. -p -35000) sets TCP and UDP ports n, n+1, n+2. -p n1,n2,n3 (comma-separated -values) sets each port separately; -p n1,n2 sets ports n1,n2,n2+1. -p -tcp n or -p udp n sets just the TCP or UDP ports. Ports must be in the -range \[1024-65535\]. - -If the -p option is not used, the ports are chosen dynamically -(randomly), which will not work if a firewall is running. - **-m** generates a random MAC address to use instead of the true hardware MAC number of the computer's network card. (Different server\_name, MAC addresses, and network ports are needed for each @@ -474,7 +474,7 @@ with the decoder name. **-vc *converter*** chooses the GStreamer pipeline's videoconverter element, instead of the default value "videoconvert". When using -video4linux hardware decoding by a GPU,`-vc v4l2convert` will also use +Video4Linux2 hardware-decoding by a GPU,`-vc v4l2convert` will also use the GPU for video conversion. Using quotes "..." allows some parameters to be included with the converter name.