summaryrefslogtreecommitdiffstats
path: root/DOCS/man/options.rst
Commit message (Collapse)AuthorAgeFilesLines
* player: always notify when writing window-scale optionDudemanguy7 days1-1/+4
| | | | | | As described in the previous commit, update_window_scale will always execute whenever window-scale is written even if the value doesn't change.
* DOCS/man/options: mention the new priority list usage of --gpu-contextnanahi8 days1-5/+7
| | | | The settings list conversion means a custom priority list can now be used.
* sd_ass: add `sub-vsfilter-bidi-compat` to enable vsfilter bidi compatllyyr8 days1-0/+9
| | | | | | | | | | | | | | | | Enable ASS_FEATURE_{WHOLE_TEXT_LAYOUT, BIDI_BRACKETS} and auto base detection by default, and add an option to disable this if needed. This is strictly an improvement for webvtt files as they always use auto base detection. This _fixes_ right-to-left text rendering for webvtt files which correctly mark rtl/ltr. Webvtt files obtained from sources which sideload the RTL information through css also see an improvement due to the auto detection. Generally SRT files also want this, but some are also written to workaround VSFilter quirks. See also: https://github.com/mpv-player/mpv/pull/12985#issuecomment-1839565138
* DOCS: document --show-in-taskbar optionnanahi8 days1-0/+6
|
* mac/vulkan: add support for frame timing via presentation feedbackder richter2024-04-101-0/+1
|
* DOCS/man/options: mention the impact of --hwdec-codecs on startup timenanahi2024-04-071-1/+8
| | | | | | | | Probing for hwdec can be very slow: on my setup (Nvidia GPU without VP9 hwdec capability), this causes 2x hot cache startup time compared to explicitly disabling VP9 in this list (500 ms -> 1 000 ms). Also remove --vo=vdpau reference.
* DOCS/man: unify flag option descriptionsnanahi2024-04-071-86/+82
| | | | | | | | | | | In many places, flags options have duplicate descriptions like --break-player and --no-break-player. This is redundant since the equivalence of this syntax to --break-player=<yes|no> is already documented, and the =<yes|no> syntax is more in line with the syntax of other option types. This replaces all usage of --no-foobar with --foobar=no, and use --foobar=<yes|no> when possible.
* DOCS/options: document key autorepeat defaultsnanahi2024-03-291-6/+7
|
* options: add --input-commands optionDudemanguy2024-03-211-0/+15
| | | | | | | Basically a simple way to perform any command/property action from the command line. This takes the exact same syntax as input.conf but not including the key naturally. Potentially useful for weird properties that don't map well to options (like ao-volume). Fixes #12353.
* DOCS/options: improve wording of dither-depthllyyr2024-03-191-6/+6
|
* vo_gpu_next: make `dither-depth=auto` mean 8 bpc for non-d3d11 SDRllyyr2024-03-191-2/+4
| | | | | | | Fixes the issue described in https://github.com/mpv-player/mpv/issues/11862 for SDR files for non-d3d11 gpu-api. We currently don't have a smarter way to get the real on-the-wire bpc for other APIs, so this is the best that can be done.
* DOCS/options: --x11-name sets the instance name, not the class'sGuido Cella2024-03-171-1/+1
|
* DOCS/options: clarify --autofit-larger effectnanahi2024-03-171-2/+2
| | | | | | Clarify that --autofit-larger sets the maximum size of the window. The original wording was not written with runtime change in mind, so the implication of "not changing size" is ambiguous.
* options: remove --focus-on-open and add --focus-onder richter2024-03-101-3/+6
| | | | | | | | | replaces the old focus-on-open option with a more generic focus-on options that can be extended. adjust the only platform that uses that option. Fixes #8337
* options: add --deinterlace-field-parity option1nsane0002024-03-041-0/+11
| | | | | | | | Previously there was no way to specify the field order of interlaced videos when deinterlacing with inbuilt filters. Lavfi deinterlacers seemed to prefer top field order while inbuilt ones (vdpaupp, vavpp, d3d11vpp) seemed to prefer bottom field order. The default "auto" option should work exactly as before while specifying either "tff" or "bff" should force the specified field order
* DOCS/options: fix Vulkan typopsykose2024-03-021-1/+1
|
* Revert "player: add ao-volume option, to set the system volume at startup"Dudemanguy2024-03-011-7/+0
| | | | | | | | Ended up being a bad idea. As a property, this inherently has more functionality and the tradeoff of being able to do --ao-volume wasn't worth it. This reverts commit 58ed620c064971535e60778612777750aa5e2f4d.
* DOCS/options: clarify --sub-blur and --osd-blur optionsnanahi2024-02-271-2/+4
| | | | | Clarify that these options only apply to the font borders, not to the texts themselves.
* vo_gpu_next: add --border-background optionDudemanguy2024-02-261-0/+4
| | | | | Allow for setting the border background independently from the background option.
* vo_gpu/vo_gpu_next: rework --alpha into --background optionDudemanguy2024-02-261-22/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | The --alpha option currently covers two related but different concepts: whether or not to ignore the alpha component and possibly blending it with a background. Because of the way the option currently works, it is impossible to have a transparent window (which requires setting --alpha=yes) while blending it with the background at the same time. To solve this, let's rework it so it it superseded by the background option. --background controls what kind of background to set for the image if possible. It can be blended with the set background color, with tiles, or not blended at all (the last one is still broken on X11/mesa except for GLX, *sigh*). In this new paradigm, --alpha=no has no real purpose because you can simply set the background to color and whatever color you want for exactly the same effect. So the option is removed. Instead, the hint set by windowing backends (i.e. setting ra_ctx->opts.want_alpha) can by done with the --background option. As an aside, the colors in vo_gpu are currently bugged due to not pre-multiplying the alpha and it seems no one ever noticed. The next commit fixes that. vo_gpu_next support happens latter since it requires new things from libplacebo. Fixes #9615.
* player: rename --background to --background-colorDudemanguy2024-02-261-1/+1
| | | | | This better represents what it actually does. --background will be used for another, related option in the next commit.
* osd_libass: update the OSD bar's dent and border sizeGuido Cella2024-02-261-1/+1
| | | | | Make the OSD bar markers bigger so we can default to a smaller, better-looking border size, without sacrificing markers' visibility.
* DOCS/options: make --scale documentation more consistentdokur0chan2024-02-261-8/+9
| | | | | | | | | | | | Beef up the barebones description for the Mitchell filter and make it consistent with the other --scale examples. In addition to this, make some wording changes to make the language in the documentation a bit more unified. Before this change it was pretty obvious that multiple authors contributed to this part of the manual (at completely different timeframes), so the language was somewhat disjointed. The Mitchell description was also not very helpful.
* DOCS: move ALSA option documentation to ao.rstnanahi2024-02-261-48/+0
| | | | | | All other ao options are documented there so make ALSA the same. Also remove the (Linux only) wording since some systems (e.g. FreeBSD) provide compatibility layer for it.
* DOCS/options: clarify the impact of --audio-buffernanahi2024-02-261-1/+1
| | | | | | | | While making this larger do make audio filters react slower, it doesn't always make softvol react slower. This is because the softvol reaction speed is related to the ao buffer size which on many systems have an upper limit, typically much lower than 200 ms. In this case the softvol won't react slower. Change the wording to clarify this.
* DOCS/options: remove lavrresample referencenanahi2024-02-261-7/+2
| | | | | lavrresample is removed in c8b8fe9981c654c0539ca77056ed6451a3da7367. The replacement is the internal swresample filter.
* DOCS/options: remove --alsa-devicenanahi2024-02-261-3/+0
| | | | This option was removed in 809d160c1ec1c050d1877e66f93fcffc98fe4e83.
* input: add insert-next support for drag-and-dropDavid Vaughan2024-02-261-7/+8
| | | | | | | This commit adds a DND_INSERT_NEXT action option for drag-and-drop, allows for selecting it through the --drag-and-drop=insert-next option, and adds the necessary plumbing to make that happen when something is dragged onto the player.
* DOCS/man: remove outdated softvol entryDudemanguy2024-02-251-13/+2
| | | | 69ae23fdd1e39f4e7aa30082e36cc635d954bccf removed this option completely.
* player: add ao-volume option, to set the system volume at startupLeonardo Boss2024-02-251-0/+7
| | | | closes #12353
* player: set hidpi-window-scale to no by defaultDudemanguy2024-02-241-1/+1
| | | | | | | | | | | | | | | | | | This has defaulted to yes for a very long time, but evidentally it annoys a lot of people (including myself). My argument is that this makes no sense. mpv is for videos; not text. A 1920x1080 video should open as 1920x1080 regardless of whatever the DPI settings of the OS is. This can get very silly when you consider watching a 4k video which will get this additional scale factor which is virtually never desirable. Whether or not the OS and/or WM prevents it from getting larger than the screen depends on a lot of things. Previously some windowing backends required that this option be set to yes in order to report a dpi scale value other than 1, but this should be fixed with the previous commits. The only difference is whether or not to scale the window by the additional factor. Fixes #13465.
* DOCS/options: clarify hidpi-window-scaleDudemanguy2024-02-241-4/+3
|
* DOCS: document --input-preprocess-wheel optionnanahi2024-02-151-0/+14
| | | | | | Document the use cases for enabling or disabling the wheel preprocessing. Also note that this option has no effect on any filtering already done by the OS/driver.
* DOCS/options: mention that sub-clear-on-seek can now break thingsDudemanguy2024-02-151-1/+3
| | | | | | | | | | | | | | | | | This is technically due to the previous commits that made subtitle rendering more efficient by eliminating redraws, but working around this particular edge case is useless. The sub-clear-on-seek option was originally introduced in d5940fabcd6b477c72430c84e460975060807646 and specifically is a workaround for completely broken mkv files. There is no reason to use it otherwise. Because that option disables all duplicate checking and the previous commits rework subtitle rendering in the still image case to be dependent on keeping track of packets, the end result is that you will get the same line rendered multiple times. However the important case of broken mkv files with duplicate ReadOrder fields still work just fine with --no-video. So instead of bothering trying to make this option "work", just clarify that stuff can break since, again, there's no reason to use it other than as a workaround for broken files.
* DOCS/man: more words about --teletext-pageMohammad AlSaleh2024-02-131-2/+11
| | | | Signed-off-by: Mohammad AlSaleh <CE.Mohammad.AlSaleh@gmail.com>
* sub: allow setting lavc txt_page special values via teletext_pageMohammad AlSaleh2024-02-131-2/+5
| | | | | | | | * Range of accepted values for teletext_page now include 0 and -1. * 0 means "subtitle" and -1 means "*". * Make 0 the default. Signed-off-by: Mohammad AlSaleh <CE.Mohammad.AlSaleh@gmail.com>
* player: add an auto option to deinterlaceDudemanguy2024-02-071-10/+9
| | | | | | | | | | Deinterlacing required that the user set it on/off themselves, but we actually have handy flags for detecting if a frame is interlaced. So it's pretty simple to make an auto option using that. Unfortunately, life is not quite that simple and there are known cases of false positives from the ffmpeg flags so we can't make auto the default value. However, it still may have some utility for some people, and the detection could potentially be improved upon later. Closes #10358.
* player: remove all rpi-specific codeDudemanguy2024-02-051-5/+0
| | | | | | | | | | | | | | | | | | | | | | vo_rpi and its related code has pretty much historically been a disaster in mpv. The build regularly gets broken and since nobody uses it, it takes months for anyone to notice. There was also that time where fullscreen was broken for about a year and a half. Also building in waf was entirely broken for about a couple of years or so due to mysterious reasons no one ever figured out (meson magically fixed it). Anyways, once again the build is broken due to rpi being forgotten about again, but instead of pretending to support this crap. Just drop it all. Nowadays, mmal hwdec is a relic since these devices are better off using the v4l2m2m ffmpeg fork instead which actually uses KMS properly. RPI 1 and 2 probably can't do this and will remain broken but oh well blame Broadcom for being special snowflakes and not using standard APIs (my rockpro worked out of the box; just saying). RPI 2 is nearly 10 years old anyways, so I think you can afford a new SBC by now. If we were nicer, there would be a deprecation period, but this is broken in the last major release anyway so too late. Closes #13402.
* x11_common: support --title-barnanahi2024-02-021-1/+1
| | | | | | | | | Some X11 window managers support controlling the title bar independently from other window decorations with _MOTIF_WM_HINTS. This allows hiding the title bar while keeping other decorations like the resizing borders. Let mpv respect the --title-bar option on X11 so --no-title-bar can hide the title bar only like on win32.
* vo_gpu_next: save cache to separate filesKacper Michajłow2024-01-311-6/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Save the cache to separate files to avoid loading/saving a huge combined libplacebo.cache. This approach allows the saving of only new cache objects and avoids resaving the entire cache, especially even if only a tiny change was made. This commit improves the cold start time of mpv and avoids saving data when it's not necessary. Number of changes were made: - each cached object is saved in its own file - cache files are prefixed with the name of cached object - cache directory is cleaned on each uninit - the least recently used cache files are removed if cumulative cache size is above limit - files used in the recent 24 hours are not removed to allow changes to mpv.conf without worrying about the cache being removed during experimentation - shader cache size limit is set to 128 MiB - icc cache size limit is set to 1.5 GiB - cache objects are loaded/saved as needed This commit eliminates the runtime performance penalty associated with the size cache. While we continue to maintain the cache limit to prevent retaining stale objects, mpv now only loads a small subset of files that are currently required for playback, instead of loading all files.
* f_auto_filters: change fallback deinterlace to bwdifDudemanguy2024-01-211-1/+1
| | | | | | | I don't actually deinterlace ever but allegedly this is better than yadif, and there's no real reason to not have this be the fallback deinterlace when we're not using hw frames. Also change various mentions of yadif to bwdif. Ref #12835.
* sub: add `--sub-lavc-o` optionMohammad AlSaleh2024-01-211-0/+7
| | | | | | | We have `--vd-lavc-o` and `--ad-lavc-o`, but no equivalent option for subtitles. Signed-off-by: Mohammad AlSaleh <CE.Mohammad.AlSaleh@gmail.com>
* player: remove --term-remaining-playtime optionDudemanguy2024-01-201-4/+0
| | | | | This wasn't useful and didn't even really do what it said anyway. Closes #12167.
* DOCS/*: remove mentions of Libavllyyr2024-01-201-6/+6
|
* DOCS: reorder --volume-max documentation to where --volume isnanahi2024-01-201-4/+4
|
* DOCS: add documentation for --volume-gain optionsnanahi2024-01-201-0/+7
|
* player: add forced choice to subs-with-matching-audioDudemanguy2024-01-131-5/+7
| | | | | | | | | | fe875083b3d30b06ef77745f40570e8f63afec2 confused things a bit and made --no-subs-with-matching-audio actually mean what it says: no subtitles if the languages match. However, the option actually meant no non-forced subtitles not no subtitles at all. This isn't really intuitive so instead of changing the behavior back to the old way (we already have a release since then), add a third option "forced" which is equivalent to the old meaning of --no-subs-with-matching audio. Fixes #13151.
* vo_gpu_next: respect d3d11 swapchain output format preferencenanahi2024-01-061-0/+5
| | | | | | | | | | Currently, libplacebo always tries to reconfigure the d3d11 swapchain to a 10-bit output format because disable_10bit_sdr isn't set to true, even when an 8-bit format is explicitly requested via --d3d11-output-format. Fix this by passing the requested output format preference to libplacebo. Document that this option may be ignored.
* DOCS/options: note that --geometry doesn't fully work on waylandDudemanguy2024-01-041-0/+5
| | | | | Positioning windows won't work on wayland so note it here to hopefully avoid confusing users.
* DOCS/man: remove "Linux desktop issues" sectionnanahi2023-12-291-3/+5
| | | | | | | | | | | | | | | | | | | This section has no reason to exist anymore because: - No "desktop issues" sections exist for other platforms, and all other Linux-specific issues are represented as notes for options. This section only addressed one specific issue. - This section was shortened significantly with commit 2c46ae8ea3d9ae32b52eae9092f0517d69dcedbc, so there is no need for this to be a separate section anymore. - This section was shortened again with commit d5e681e95df759a4df8608cc773931e3f97c9460, when the original rationale behind this section became outdated because GNOME has implemented the idle inhibit protocol. The historical info is moved to the documentation of --stop-screensaver.
* DOCS/man: use the correct directive type for "Warning" admonitionsnanahi2023-12-281-8/+8
| | | | | | | Some places in the manpage uses `.. admonition:: Warning` instead of the specific directive type `.. warning::` for warning admonitions. This causes the "Warning" text appearing in black color instead of red. Correct them here.
* win32: add support for --input-cursor-passthrough optionnanahi2023-12-281-1/+0
| | | | This completes the support for all supported desktop platforms.
* DOCS/options: fix documentation for --force-window window sizenanahi2023-12-281-1/+1
| | | | | | The value has been wrong since ca2b05c0fbc9a51472b1a5a94d016e977c6c87c3, and recent commit 8b4a995a9d7ee7b65a5d2c893d72844d551d9697 still didn't fix it.
* mac: add support for --input-cursor-passthrough optionder richter2023-12-251-1/+1
|
* DOCS/options: fix --image-display-duration's documentationGuido Cella2023-12-251-6/+6
| | | | | | - --image-display-duration does not hide the OSC. - Saying "Setting --image-display-duration" makes no sense because it is not a boolean and it cannot be unset.
* mac: add support for --auto-window-resize optionder richter2023-12-231-1/+0
| | | | Fixes #9325
* options: add --secondary-sub-ass-overridedyphire2023-12-181-0/+6
| | | | Default: strip. preserve the old behavior
* DOCS/options: fix documentation for replaygain-clipDudemanguy2023-12-161-2/+2
| | | | | | | f1c4d20e6577f32018e20efc4ab9da7d4e1ab4ac added this option, but the documentation is actually backwards. --replaygain-clip allows clipping. Having it disabled, the default, prevents it. Keep the behavior the same, but change the documentation to reflect reality. Closes #13111.
* mac: add support for drag-and-drop optionder richter2023-12-151-1/+0
|
* options: add --secondary-sub-poskarelrooted2023-12-131-2/+6
| | | | The default value is 0 (on the top of the screen)
* filter_sdh: add full width parentheses to the enclosures stringDudemanguy2023-12-081-3/+4
| | | | | Since these are technically parentheses, we'll treat them the same way as normal parenthesis. Fixes #11155.
* filter_sdh: add --sub-filter-sdh-enclosures optionDudemanguy2023-12-081-2/+14
| | | | | | | | | | | This filter is a bit complicated, but one of the essential parts of it is removing text enclosed by particular set of characters (e.g. text inbetween []). This was previously hardcoded to only take into account parenthesis and brackets, but people may want to filter more things so make this customizable. The option only takes "left hand characters" so the right pair is mapped internally if applicable. If not, then we just use the same character. Fixes #8268 since the unicode character in question can just be passed to this option.
* image_writer: default to lossless AVIF screenshotsKacper Michajłow2023-12-041-3/+3