From b8a705312f5b5f12c94e716dab5028c42d4be4e3 Mon Sep 17 00:00:00 2001
From: "F. Duncanh"
Date: Sat, 9 Mar 2024 11:18:26 -0500
Subject: [PATCH] Minor README clarification (max audio gain)
---
README.html | 23 +++++++++++++----------
README.md | 6 +++---
README.txt | 18 ++++++++++--------
3 files changed, 26 insertions(+), 21 deletions(-)
diff --git a/README.html b/README.html
index f0df080..5734fce 100644
--- a/README.html
+++ b/README.html
@@ -487,9 +487,10 @@ GStreamer internal clock used to try to keep them synchronized.
Starting with UxPlay-1.64, the other method (GStreamer’s
“sync=true” mode), which uses timestamps in the audio and video
streams sent by the client, is the new default. On
-low-decoding-power UxPlay hosts (such as Raspberry Pi 3 models) this
-will drop video frames that cannot be decoded in time to play with the
-audio, making the video jerky, but still synchronized.
+low-decoding-power UxPlay hosts (such as Raspberry Pi Zero W or 3 B+
+models) this will drop video frames that cannot be decoded in time to
+play with the audio, making the video jerky, but still
+synchronized.
The older method which does not drop late video frames worked well on
more powerful systems, and is still available with the UxPlay option
@@ -513,12 +514,13 @@ before a pause or track-change initiated on the client takes effect on
the audio played by the server.
AirPlay volume-control attenuates volume (gain) by up to -30dB: the
-range -30dB:0dB can be rescaled from Low:0, or
+decibel range -30:0 can be rescaled from Low:0, or
Low:High, using the option -db (“-db
Low” or “-db Low:High”), Low must be
-negative. Rescaling is linear in decibels. The option
--taper provides a “tapered” AirPlay volume-control profile
-some users may prefer.
+negative. Rescaling is linear in decibels. Note that GStreamer’s audio
+format will “clip” any audio gain above +20db, so keep High
+below that level. The option -taper provides a “tapered”
+AirPlay volume-control profile some users may prefer.
The -vsync and -async options also allow an optional positive (or
negative) audio-delay adjustment in milliseconds for
fine-tuning : -vsync 20.5 delays audio relative to video by
@@ -747,9 +749,10 @@ not affect the (small) initial OpenGL mirror window size, but the window
can be expanded using the mouse or trackpad. In contrast, a window
created with “-vs osxvideosink” is initially big, but has the wrong
aspect ratio (stretched image); in this case the aspect ratio changes
-when the window width is changed by dragging its side; the option “-vs
-osxvideosink force-aspect-ratio=true” can be used to make the window
-have the correct aspect ratio when it first opens.
+when the window width is changed by dragging its side; the option
+-vs "osxvideosink force-aspect-ratio=true" can be used to
+make the window have the correct aspect ratio when it first
+opens.
Building
diff --git a/README.md b/README.md
index 8bc4aa4..0b08ea0 100644
--- a/README.md
+++ b/README.md
@@ -415,9 +415,9 @@ delays the video on the client to match audio on the server, so leads to
a slight delay before a pause or track-change initiated on the client takes effect on the audio played by the server.
AirPlay volume-control attenuates volume (gain) by up to -30dB: the decibel range -30:0 can be rescaled from _Low_:0, or _Low_:_High_, using the
-option `-db` ("-db _Low_ " or "-db _Low_:_High_ "), _Low_ must be negative. Rescaling is linear in decibels. The
-option ```-taper``` provides a "tapered" AirPlay volume-control
-profile some users may prefer.
+option `-db` ("-db _Low_ " or "-db _Low_:_High_ "), _Low_ must be negative. Rescaling is linear in decibels.
+Note that GStreamer's audio format will "clip" any audio gain above +20db, so keep *High* below that level. The
+option ```-taper``` provides a "tapered" AirPlay volume-control profile some users may prefer.
The -vsync and -async options
also allow an optional positive (or negative) audio-delay adjustment in _milliseconds_ for fine-tuning : `-vsync 20.5`
diff --git a/README.txt b/README.txt
index 9de8972..3d4e7df 100644
--- a/README.txt
+++ b/README.txt
@@ -481,9 +481,9 @@ below for help with this or other problems.
with UxPlay-1.64, the other method (GStreamer's "*sync=true*" mode),
which uses timestamps in the audio and video streams sent by the
client, is the new default**. On low-decoding-power UxPlay hosts
- (such as Raspberry Pi 3 models) this will drop video frames that
- cannot be decoded in time to play with the audio, making the video
- jerky, but still synchronized.
+ (such as Raspberry Pi Zero W or 3 B+ models) this will drop video
+ frames that cannot be decoded in time to play with the audio, making
+ the video jerky, but still synchronized.
The older method which does not drop late video frames worked well on
more powerful systems, and is still available with the UxPlay option
@@ -506,10 +506,12 @@ helped to prevent this previously when timestamps were not being used.)
takes effect on the audio played by the server.
AirPlay volume-control attenuates volume (gain) by up to -30dB: the
-range -30dB:0dB can be rescaled from *Low*:0, or *Low*:*High*, using the
-option `-db` ("-db *Low*" or "-db *Low*:*High*"), *Low* must be
-negative. Rescaling is linear in decibels. The option `-taper` provides
-a "tapered" AirPlay volume-control profile some users may prefer.
+decibel range -30:0 can be rescaled from *Low*:0, or *Low*:*High*, using
+the option `-db` ("-db *Low*" or "-db *Low*:*High*"), *Low* must be
+negative. Rescaling is linear in decibels. Note that GStreamer's audio
+format will "clip" any audio gain above +20db, so keep *High* below that
+level. The option `-taper` provides a "tapered" AirPlay volume-control
+profile some users may prefer.
The -vsync and -async options also allow an optional positive (or
negative) audio-delay adjustment in *milliseconds* for fine-tuning :
@@ -751,7 +753,7 @@ downloads, "UxPlay" for "git clone" downloads) and build/install with
created with "-vs osxvideosink" is initially big, but has the wrong
aspect ratio (stretched image); in this case the aspect ratio
changes when the window width is changed by dragging its side; the
- option "-vs osxvideosink force-aspect-ratio=true" can be used to
+ option `-vs "osxvideosink force-aspect-ratio=true"` can be used to
make the window have the correct aspect ratio when it first opens.
## Building UxPlay on Microsoft Windows, using MSYS2 with the MinGW-64 compiler.