options: rename subtitle-related options

--ass           → --sub-ass
--autosub       → --sub-auto
--autosub-match → --sub-auto-match
--sub           → --sub-file
--subcp         → --sub-codepage
--subfps        → --sub-fps
This commit is contained in:
Martin Herkt
2014-04-24 17:42:54 +02:00
parent 32c63fc119
commit 8d7d6caeaf
6 changed files with 61 additions and 57 deletions

View File

@@ -149,6 +149,7 @@ Command Line Switches
``-afm hwac3`` ``--ad=spdif:ac3,spdif:dts``
``-ao alsa:device=hw=0.3`` ``--ao=alsa:device=[hw:0,3]``
``-ass-bottom-margin`` ``--vf=sub=bottom:top``
``-ass`` ``--sub-ass``
``-benchmark`` ``--untimed`` (no stats)
``-capture`` ``--stream-capture=<filename>``
``-channels`` ``--channels`` (changed semantics)
@@ -167,6 +168,7 @@ Command Line Switches
``-mixer`` AO suboptions (``alsa``, ``oss``)
``-mouse-movements`` ``--input-cursor``
``-noar`` ``--no-input-appleremote``
``-noautosub`` ``--no-sub-auto``
``-noconsolecontrols`` ``--no-input-terminal``
``-nojoystick`` ``--no-input-joystick``
``-nosound`` ``--no-audio``
@@ -179,12 +181,15 @@ Command Line Switches
``-spugauss`` ``--sub-gauss``
``-ss`` ``--start``
``-stop-xscreensaver`` ``--stop-screensaver``
``-sub-fuzziness`` ``--autosub-match``
``-sub-fuzziness`` ``--sub-auto-match``
``-sub`` ``--sub-file``
``-subcp`` ``--sub-codepage``
``-subdelay`` ``--sub-delay``
``-subfile`` ``--sub``
``-subfont-*`` ``--sub-text-*``, ``--osd-*``
``-subfont-text-scale`` ``--sub-scale``
``-subfont`` ``--sub-text-font``
``-subfps`` ``--sub-fps``
``-subpos`` ``--sub-pos``
``-use-filename-title`` ``--title='${filename}'``
``-vc ffh264vdpau`` (etc.) ``--hwdec=vdpau``

View File

@@ -113,18 +113,18 @@ OPTIONS
- ``--aspect=4:3`` or ``--aspect=1.3333``
- ``--aspect=16:9`` or ``--aspect=1.7777``
``--ass``, ``--no-ass``
``--sub-ass``, ``--no-sub-ass``
Render ASS subtitles natively (enabled by default).
If ``--no-ass`` is specified, all tags and style declarations are stripped
and ignored on display. The subtitle renderer uses the font style as
specified by the ``--sub-text-`` options instead.
If ``--no-sub-ass`` is specified, all tags and style declarations are
stripped and ignored on display. The subtitle renderer uses the font style
as specified by the ``--sub-text-`` options instead.
.. note::
Using ``--no-ass`` may lead to incorrect or completely broken rendering
of ASS/SSA subtitles. It can sometimes be useful to forcibly override
the styling of ASS subtitles, but should be avoided in general.
Using ``--no-sub-ass`` may lead to incorrect or completely broken
rendering of ASS/SSA subtitles. It can sometimes be useful to forcibly
override the styling of ASS subtitles, but should be avoided in general.
``--ass-force-style=<[Style.]Param=Value[,...]>``
Override some style or script info parameters.
@@ -314,19 +314,6 @@ OPTIONS
screen height, make the window smaller until either its width is 90%
of the screen, or its height is 80% of the screen.
``--autosub``, ``--no-autosub``
Load additional subtitle files matching the video filename. Enabled by
default. See also ``--autosub-match``.
``--autosub-match=<exact|fuzzy|all>``
Adjust matching fuzziness when searching for subtitles:
:exact: exact match
:fuzzy: Load all subs containing movie name.
:all: Load all subs in the current and ``--sub-paths`` directories.
(default: exact)
``--autosync=<factor>``
Gradually adjusts the A/V sync based on audio delay measurements.
Specifying ``--autosync=0``, the default, will cause frame timing to be
@@ -801,8 +788,7 @@ OPTIONS
``--embeddedfonts``, ``--no-embeddedfonts``
Use fonts embedded in Matroska container files and ASS scripts (default:
enabled). These fonts can be used for SSA/ASS subtitle rendering
(``--ass`` option).
enabled). These fonts can be used for SSA/ASS subtitle rendering.
``--end=<time>``
Stop at given absolute time. Use ``--length`` if the time should be relative
@@ -1599,7 +1585,7 @@ OPTIONS
The ``--sub-text-font`` option (and most other ``--sub-text-``
options) are ignored when ASS-subtitles are rendered, unless the
``--no-ass`` option is specified.
``--no-sub-ass`` option is specified.
``--osd-font-size=<size>``, ``--sub-text-font-size=<size>``
Specify the OSD/sub font size. The unit is the size in scaled pixels at a
@@ -2049,14 +2035,14 @@ OPTIONS
.. note::
Styling and interpretation of any formatting tags is disabled for the
secondary subtitle. Internally, the same mechanism as ``--no-ass`` is
used to strip the styling.
secondary subtitle. Internally, the same mechanism as ``--no-sub-ass``
is used to strip the styling.
.. note::
If the main subtitle stream contains formatting tags which display the
subtitle at the top of the screen, it will overlap with the secondary
subtitle. To prevent this, you could use ``--no-ass`` to disable
subtitle. To prevent this, you could use ``--no-sub-ass`` to disable
styling in the main subtitle stream.
``--show-profile=<profile>``
@@ -2215,19 +2201,22 @@ OPTIONS
implemented, but does not work (happens often on GNOME). You might be able
to to work this around using ``--heartbeat-cmd`` instead.
``--sub=<subtitlefile1,subtitlefile2,...>``
``--sub-file=<subtitlefile1,subtitlefile2,...>``
Use/display these subtitle files. Only one file can be displayed at the
same time.
``--sub-fix-timing``, ``--no-sub-fix-timing``
By default, external text subtitles are preprocessed to remove minor gaps
or overlaps between subtitles (if the difference is smaller than 200 ms,
the gap or overlap is removed). This does not affect image subtitles,
subtitles muxed with audio/video, or subtitles in the ASS format.
``--sub-auto``, ``--no-sub-auto``
Load additional subtitle files matching the video filename. Enabled by
default. See also ``--sub-auto-match``.
``--sub-demuxer=<[+]name>``
Force subtitle demuxer type for ``--sub``. Give the demuxer name as
printed by ``--sub-demuxer=help``.
``--sub-auto-match=<exact|fuzzy|all>``
Adjust matching fuzziness when searching for subtitles:
:exact: exact match
:fuzzy: Load all subs containing movie name.
:all: Load all subs in the current and ``--sub-paths`` directories.
(default: exact)
``--sub-paths=<path1:path2:...>``
Specify extra directories to search for subtitles matching the video.
@@ -2247,7 +2236,11 @@ OPTIONS
- ``/tmp/subs/``
- ``~/.mpv/sub/``
``--subcp=<codepage>``
``--sub-demuxer=<[+]name>``
Force subtitle demuxer type for ``--sub-file``. Give the demuxer name as
printed by ``--sub-demuxer=help``.
``--sub-codepage=<codepage>``
If your system supports ``iconv(3)``, you can use this option to specify
the subtitle codepage. By default, ENCA will be used to guess the charset.
If mpv is not compiled with ENCA, ``UTF-8:UTF-8-BROKEN`` is the default,
@@ -2263,9 +2256,9 @@ OPTIONS
.. admonition:: Examples
- ``--subcp=utf8:latin2`` Use Latin 2 if input is not UTF-8.
- ``--subcp=utf8:cp1250`` Use CP1250 if input is not UTF-8.
- ``--subcp=cp1250`` Always force recoding to cp1250.
- ``--sub-codepage=utf8:latin2`` Use Latin 2 if input is not UTF-8.
- ``--sub-codepage=utf8:cp1250`` Use CP1250 if input is not UTF-8.
- ``--sub-codepage=cp1250`` Always force recoding to cp1250.
The pseudo codepage ``UTF-8-BROKEN`` is used internally. If this is used
as codepage, the subtitle will be interpreted as UTF-8, but with "Latin 1"
@@ -2275,7 +2268,7 @@ OPTIONS
If the player was compiled with ENCA support, you can control it with the
following syntax::
``--subcp=enca:<language>:<fallback codepage>``
``--sub-codepage=enca:<language>:<fallback codepage>``
You can specify your language using a two letter language code to make
ENCA detect the codepage automatically. If unsure, enter anything (if the
@@ -2285,26 +2278,32 @@ OPTIONS
.. admonition:: Examples
- ``--subcp=enca:cs:latin2`` guess the encoding, assuming the subtitles
- ``--sub-codepage=enca:cs:latin2`` guess the encoding, assuming the subtitles
are Czech, fall back on latin 2, if the detection fails.
- ``--subcp=enca:pl:cp1250`` guess the encoding for Polish, fall back on
- ``--sub-codepage=enca:pl:cp1250`` guess the encoding for Polish, fall back on
cp1250.
- ``--subcp=enca:pl`` guess the encoding for Polish, fall back on UTF-8.
- ``--subcp=enca`` try universal detection, fall back on UTF-8.
- ``--sub-codepage=enca:pl`` guess the encoding for Polish, fall back on UTF-8.
- ``--sub-codepage=enca`` try universal detection, fall back on UTF-8.
If the player was compiled with libguess support, you can use it with:
``--subcp=guess:<language>:<fallback codepage>``
``--sub-codepage=guess:<language>:<fallback codepage>``
Note that libguess always needs a language. There is no universal detection
mode. Use ``--subcp=guess:help`` to get a list of languages (like with ENCA,
mode. Use ``--sub-codepage=guess:help`` to get a list of languages (like with ENCA,
it will be printed only if the conversion code is somehow called, for
example when loading an external subtitle).
``--sub-fix-timing``, ``--no-sub-fix-timing``
By default, external text subtitles are preprocessed to remove minor gaps
or overlaps between subtitles (if the difference is smaller than 200 ms,
the gap or overlap is removed). This does not affect image subtitles,
subtitles muxed with audio/video, or subtitles in the ASS format.
``--sub-delay=<sec>``
Delays subtitles by ``<sec>`` seconds. Can be negative.
``--subfps=<rate>``
``--sub-fps=<rate>``
Specify the framerate of the subtitle file (default: movie fps).
.. note::

View File

@@ -222,7 +222,7 @@ sub/:
.ass subtitles via libass. demux_lavf.c loads most subtitle types via
FFmpeg. demux_subreader.c is the old MPlayer code. It's used as last
fallback, or to handle some text subtitle types on Libav. (It also can
load UTF-16 encoded subtitles without requiring the use of -subcp.)
load UTF-16 encoded subtitles without requiring the use of -sub-codepage.)
demux_subreader.c should eventually go away (maybe).
The subtitles are passed to dec_sub.c and the subtitle decoders in sd_*.c

View File

@@ -85,7 +85,7 @@
# Change subtitle encoding. For Arabic subtitles use 'cp1256'.
# If the file seems to be valid UTF-8, prefer UTF-8.
#subcp = utf8:cp1256
#sub-codepage = utf8:cp1256
# Enable hardware decoding if available. Often, this requires using an certain
# video output, otherwise no hardware decoding will be used.

View File

@@ -402,23 +402,23 @@ const m_option_t mp_opts[] = {
// ------------------------- subtitles options --------------------
OPT_STRINGLIST("sub", sub_name, 0),
OPT_STRINGLIST("sub-file", sub_name, 0),
OPT_PATHLIST("sub-paths", sub_paths, 0),
OPT_STRING("subcp", sub_cp, 0),
OPT_STRING("sub-codepage", sub_cp, 0),
OPT_FLOAT("sub-delay", sub_delay, 0),
OPT_FLOAT("subfps", sub_fps, 0),
OPT_FLOAT("sub-fps", sub_fps, 0),
OPT_FLOAT("sub-speed", sub_speed, 0),
OPT_FLAG("autosub", sub_auto, 0),
OPT_FLAG("sub-auto", sub_auto, 0),
OPT_FLAG("sub-visibility", sub_visibility, 0),
OPT_FLAG("sub-forced-only", forced_subs_only, 0),
OPT_FLAG("stretch-dvd-subs", stretch_dvd_subs, 0),
OPT_FLAG_CONSTANTS("sub-fix-timing", suboverlap_enabled, 0, 1, 0),
OPT_CHOICE("autosub-match", sub_match_fuzziness, 0,
OPT_CHOICE("sub-auto-match", sub_match_fuzziness, 0,
({"exact", 0}, {"fuzzy", 1}, {"all", 2})),
OPT_INTRANGE("sub-pos", sub_pos, 0, 0, 100),
OPT_FLOATRANGE("sub-gauss", sub_gauss, 0, 0.0, 3.0),
OPT_FLAG("sub-gray", sub_gray, 0),
OPT_FLAG("ass", ass_enabled, 0),
OPT_FLAG("sub-ass", ass_enabled, 0),
OPT_FLOATRANGE("sub-scale", sub_scale, 0, 0, 100),
OPT_FLOATRANGE("ass-line-spacing", ass_line_spacing, 0, -1000, 1000),
OPT_FLAG("ass-use-margins", ass_use_margins, 0),

View File

@@ -95,7 +95,7 @@ const char mp_help_text[] =
" --no-audio do not play sound\n"
" --no-video do not play video\n"
" --fs fullscreen playback\n"
" --sub=<file> specify subtitle file to use\n"
" --sub-file=<file> specify subtitle file to use\n"
" --playlist=<file> specify playlist file\n"
"\n"
" --list-options list all mpv options\n"