summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorNiklas Haas <git@haasn.xyz>2019-10-04 18:45:37 +0200
committerNiklas Haas <github-c6e1c8@haasn.xyz>2019-10-04 21:34:22 +0200
commitcb95ce75b5c114b6fd2c6b37ac6941b6848c8014 (patch)
tree8b5efcb27976dd475a867767c661ed9715a8112c /DOCS
parent6064720011c7864bb97b4bb6dd2872246908c1c5 (diff)
downloadmpv-cb95ce75b5c114b6fd2c6b37ac6941b6848c8014.tar.bz2
mpv-cb95ce75b5c114b6fd2c6b37ac6941b6848c8014.tar.xz
options: rename --video-aspect to --video-aspect-override
The justification for this is the fact that the `video-aspect` property doesn't work well with `cycle_values` commands that include the value "-1". The "video-aspect" property has effectively no change in behavior, but we may want to make it read-only in the future. I think it's probably fine to leave as-is, though. Fixes #6068.
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/interface-changes.rst2
-rw-r--r--DOCS/man/input.rst13
-rw-r--r--DOCS/man/options.rst16
3 files changed, 14 insertions, 17 deletions
diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst
index 29377da3a3..c5edb76a9f 100644
--- a/DOCS/interface-changes.rst
+++ b/DOCS/interface-changes.rst
@@ -104,6 +104,8 @@ Interface changes
- add `--demuxer-cue-codepage`
- add ``track-list/N/demux-bitrate``, ``track-list/N/demux-rotation`` and
``track-list/N/demux-par`` property
+ - Deprecate ``--video-aspect`` and add ``--video-aspect-override`` to
+ replace it. (The `video-aspect` option remains unchanged.)
--- mpv 0.29.0 ---
- drop --opensles-sample-rate, as --audio-samplerate should be used if desired
- drop deprecated --videotoolbox-format, --ff-aid, --ff-vid, --ff-sid,
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index d2050bc7b4..92327f2dd6 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -1937,10 +1937,11 @@ Property list
Estimated deviation factor of the vsync duration.
``video-aspect`` (RW)
- Video aspect, see ``--video-aspect``.
+ Deprecated. This is tied to ``--video-aspect-override``, but always
+ reports the current video aspect if video is active.
- If video is active, this reports the effective aspect value, instead of
- the value of the ``--video-aspect`` option.
+ The read and write components of this option can be split up into
+ ``video-params/aspect`` and ``video-aspect-override`` respectively.
``osd-width``, ``osd-height``
Last known OSD width (can be 0). This is needed if you want to use the
@@ -2537,12 +2538,6 @@ caveats with some properties (due to historical reasons):
Option changes at runtime are affected by this as well.
-``video-aspect``
- While video is active, always returns the effective aspect ratio. Setting
- a special value (like ``no``, values ``<= 0``) will make the property
- set this as option, and return whatever actual aspect was derived from the
- option setting.
-
``display-fps``
If a VO is created, this will return either the actual display FPS, or
an invalid value, instead of the option value.
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst
index 69a28f1b7a..52f179051d 100644
--- a/DOCS/man/options.rst
+++ b/DOCS/man/options.rst
@@ -1173,9 +1173,9 @@ Video
This option has no effect if ``--video-unscaled`` option is used.
-``--video-aspect=<ratio|no>``
+``--video-aspect-override=<ratio|no>``
Override video aspect ratio, in case aspect information is incorrect or
- missing in the file being played. See also ``--no-video-aspect``.
+ missing in the file being played.
These values have special meaning:
@@ -1187,13 +1187,13 @@ Video
.. admonition:: Examples
- - ``--video-aspect=4:3`` or ``--video-aspect=1.3333``
- - ``--video-aspect=16:9`` or ``--video-aspect=1.7777``
- - ``--no-video-aspect`` or ``--video-aspect=no``
+ - ``--video-aspect-override=4:3`` or ``--video-aspect-override=1.3333``
+ - ``--video-aspect-override=16:9`` or ``--video-aspect-override=1.7777``
+ - ``--no-video-aspect-override`` or ``--video-aspect-override=no``
``--video-aspect-method=<bitstream|container>``
This sets the default video aspect determination method (if the aspect is
- _not_ overridden by the user with ``--video-aspect`` or others).
+ _not_ overridden by the user with ``--video-aspect-override`` or others).
:container: Strictly prefer the container aspect ratio. This is apparently
the default behavior with VLC, at least with Matroska. Note that
@@ -2814,7 +2814,7 @@ Window
previous setting (e.g. in the config file). Overrides the
``--monitorpixelaspect`` setting if enabled.
- See also ``--monitorpixelaspect`` and ``--video-aspect``.
+ See also ``--monitorpixelaspect`` and ``--video-aspect-override``.
.. admonition:: Examples
@@ -2835,7 +2835,7 @@ Window
``--monitorpixelaspect=<ratio>``
Set the aspect of a single pixel of your monitor or TV screen (default:
1). A value of 1 means square pixels (correct for (almost?) all LCDs). See
- also ``--monitoraspect`` and ``--video-aspect``.
+ also ``--monitoraspect`` and ``--video-aspect-override``.
``--stop-screensaver``, ``--no-stop-screensaver``
Turns off the screensaver (or screen blanker and similar mechanisms) at