summaryrefslogtreecommitdiffstats
path: root/DOCS/man
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2019-11-25 00:47:53 +0100
committerwm4 <wm4@nowhere>2019-11-25 00:47:53 +0100
commit3a2dc8b22e9f947c9cd3a91445b0731b8df1d798 (patch)
tree830404c6eeffd7c5ee9c7664d574cba84e7f8511 /DOCS/man
parentc26e80d0fd1a751bac1674e5c0792b11eb57957d (diff)
downloadmpv-3a2dc8b22e9f947c9cd3a91445b0731b8df1d798.tar.bz2
mpv-3a2dc8b22e9f947c9cd3a91445b0731b8df1d798.tar.xz
command, options: deprecate old --display-fps behavior
See changelog and manpage changes. (So much effort to fix an ancient dumb mistake for an option nobody should use anyway.)
Diffstat (limited to 'DOCS/man')
-rw-r--r--DOCS/man/input.rst12
-rw-r--r--DOCS/man/options.rst8
2 files changed, 14 insertions, 6 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index a161645930..a098de99e2 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -2029,13 +2029,18 @@ Property list
Display Product Names as used in the System Information and only one display
name is returned since a window can only be on one screen.
-``display-fps`` (RW)
+``display-fps``
The refresh rate of the current display. Currently, this is the lowest FPS
of any display covered by the video, as retrieved by the underlying system
APIs (e.g. xrandr on X11). It is not the measured FPS. It's not necessarily
available on all platforms. Note that any of the listed facts may change
any time without a warning.
+ Writing to this property is deprecated. It has the same effect as writing to
+ ``override-display-fps``. Since mpv 0.31.0, this property is unavailable
+ if no display FPS was reported (e.g. if no video is active), while in older
+ versions, it returned the ``--display-fps`` option value.
+
``estimated-display-fps``
Only available if display-sync mode (as selected by ``--video-sync``) is
active. Returns the actual rate at which display refreshes seem to occur,
@@ -2697,8 +2702,9 @@ caveats with some properties (due to historical reasons):
Option changes at runtime are affected by this as well.
``display-fps``
- If a VO is created, this will return either the actual display FPS, or
- an invalid value, instead of the option value.
+ This inconsistent behavior is deprecated. Post-deprecation, the reported
+ value and the option value are cleanly separated (``override-display-fps``
+ for the option value).
``vf``, ``af``
If you set the properties during playback, and the filter chain fails to
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst
index b2ba69ff26..fde338ceb6 100644
--- a/DOCS/man/options.rst
+++ b/DOCS/man/options.rst
@@ -949,8 +949,7 @@ Video
frame, so if this is not done, there is some likeliness that the VO has
to drop some frames if rendering the first frame takes longer than needed.
-
-``--display-fps=<fps>``
+``--override-display-fps=<fps>``
Set the display FPS used with the ``--video-sync=display-*`` modes. By
default, a detected value is used. Keep in mind that setting an incorrect
value (even if slightly incorrect) can ruin video playback. On multi-monitor
@@ -960,6 +959,9 @@ Video
Set this option only if you have reason to believe the automatically
determined value is wrong.
+``--display-fps=<fps>``
+ Deprecated alias for ``--override-display-fps``.
+
``--hwdec=<api>``
Specify the hardware video decoding API that should be used if possible.
Whether hardware decoding is actually done depends on the video codec. If
@@ -4776,7 +4778,7 @@ The following video options are currently all specific to ``--vo=gpu`` and
require driver-specific hacks if using multiple monitors, to ensure mpv
syncs to the right one. Compositing window managers can also lead to bad
results, as can missing or incorrect display FPS information (see
- ``--display-fps``).
+ ``--override-display-fps``).
``--vulkan-swap-mode=<mode>``
Controls the presentation mode of the vulkan swapchain. This is similar