summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorDudemanguy <random342@airmail.cc>2023-10-15 09:36:56 -0500
committerDudemanguy <random342@airmail.cc>2023-10-25 16:16:37 +0000
commit7aed492ccc48fd32084d7dfe65a50b5b90d8411a (patch)
tree3361dcf55e770918e1f1646ab4d4db172a678833 /DOCS
parentdac977193cccbf7e2e999cf0c4b0292314839c4c (diff)
downloadmpv-7aed492ccc48fd32084d7dfe65a50b5b90d8411a.tar.bz2
mpv-7aed492ccc48fd32084d7dfe65a50b5b90d8411a.tar.xz
options: rename --fps to --container-fps-override
This better reflects what it actually does. As a bonus, script writers won't be misled into thinking that fps displays the actual video or display fps.
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/interface-changes.rst1
-rw-r--r--DOCS/man/mpv.rst3
-rw-r--r--DOCS/man/options.rst12
-rw-r--r--DOCS/man/vf.rst2
4 files changed, 10 insertions, 8 deletions
diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst
index 055651117a..d47a4d9c41 100644
--- a/DOCS/interface-changes.rst
+++ b/DOCS/interface-changes.rst
@@ -101,6 +101,7 @@ Interface changes
- change `video-codec` to show description or name, not both
- deprecate `--cdda-toc-bias` option, offsets are always checked now
- disable `--allow-delayed-peak-detect` by default
+ - rename `--fps` to `--container-fps-override`
--- mpv 0.36.0 ---
- add `--target-contrast`
- Target luminance value is now also applied when ICC profile is used.
diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst
index dd42c73412..636d4bbdc3 100644
--- a/DOCS/man/mpv.rst
+++ b/DOCS/man/mpv.rst
@@ -1094,7 +1094,8 @@ this with ``--untimed``, but it will likely break, unless the stream has no
audio, and the input feeds data to the player at a constant rate.
Another common problem is with MJPEG streams. These do not signal the correct
-framerate. Using ``--untimed`` or ``--no-correct-pts --fps=60`` might help.
+framerate. Using ``--untimed`` or ``--no-correct-pts --container-fps-override=60``
+might help.
For livestreams, data can build up due to pausing the stream, due to slightly
lower playback rate, or "buffering" pauses. If the demuxer cache is enabled,
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst
index 5d89bcb77c..b3c83de4da 100644
--- a/DOCS/man/options.rst
+++ b/DOCS/man/options.rst
@@ -1625,13 +1625,13 @@ Video
``--correct-pts``, ``--no-correct-pts``
``--no-correct-pts`` switches mpv to a mode where video timing is
- determined using a fixed framerate value (either using the ``--fps``
- option, or using file information). Sometimes, files with very broken
- timestamps can be played somewhat well in this mode. Note that video
- filters, subtitle rendering, seeking (including hr-seeks and backstepping),
- and audio synchronization can be completely broken in this mode.
+ determined using a fixed framerate value (either using the
+ ``--container-fps-override`` option, or using file information). Sometimes,
+ files with very broken timestamps can be played somewhat well in this mode.
+ Note that video filters, subtitle rendering, seeking (including hr-seeks and
+ backstepping), and audio synchronization can be completely broken in this mode.
-``--fps=<float>``
+``--container-fps-override=<float>``
Override video framerate. Useful if the original value is wrong or missing.
.. note::
diff --git a/DOCS/man/vf.rst b/DOCS/man/vf.rst
index da531eaae0..0d546bc071 100644
--- a/DOCS/man/vf.rst
+++ b/DOCS/man/vf.rst
@@ -574,7 +574,7 @@ Available mpv-only filters are:
completely broken (e.g. 0 or NaN). Even if the value is correct,
if another filter changes the real FPS (by dropping or inserting
frames), the value of this variable will not be useful. Note that
- the ``--fps`` command line option overrides this value.
+ the ``--container-fps-override`` command line option overrides this value.
Useful for some filters which insist on having a FPS.