summaryrefslogtreecommitdiffstats
path: root/DOCS/man/mpv.rst
Commit message (Collapse)AuthorAgeFilesLines
* lua: set package path if loaded from a script directorywm42020-02-011-4/+5
| | | | | | And document the shit. This uses code from commit bc1c024ae032e5b5c.
* scripting: make player error when attempting to load unknown scriptswm42020-01-191-3/+4
| | | | | | It's ridiculous that --script=something.dumb does not cause an error. Make it error, and extend this behavior to the scripts/ sub-dir in the mpv config dir.
* options: change option parsing when using a single dashwm42020-01-071-4/+10
| | | | | | | | | | | | | Addresses dumb things like accidentally overwriting a media file with e.g. "mpv --log-file test.mkv" (when the user thought that --log-file was a flag option, when it actually takes a filename). This example will now print an error. It still works with "-log-file overwritten.mkv", but prints a warning. Not sure if I'm being too careful or not "radical" enough. In any case, both the syntax that stops working and the syntax that produces a warning now have been discouraged and were called legacy for almost a decade.
* manpage: add osc and console default keys to keyboard control sectionwm42019-12-201-0/+6
| | | | | | Although they were not undocumented, they were hidden away in the respective manpage sections. It's a good idea to add them to the main keyboard bindings overview too. stats.lua also did this.
* options: deprecate -del for list optionswm42019-12-181-2/+2
| | | | | | I never liked that these used integer indexes. -remove should have existed from the start. This deprecation is yet another empty threat, though.
* options: add -remove action to list optionswm42019-12-181-0/+3
| | | | | | Actually I wanted this for key/value lists only, but add it to the others for consistency too. (For vf/af it barely makes even sense, but anyway.)
* options: make keys in key/value lists uniquewm42019-12-181-0/+3
| | | | | | | | | | | | | | I don't even know anymore whether this was intended or not. Certain use cases for the "-o" options might require this. These options are for passing general FFmpeg options. These are translated to av_opt_set() calls, which may or may not accumulate the option values on multiple calls with the same option name (how should I know?). Anyway, it seems crazy to allow non-unique keys, so make them unique. The ad-hoc nature of the option code makes this wonderfully complicated (when I wrote that this code is cursed, I meant it). In combination with lazy testing, it probably means there are lots of bugs here.
* options: increase consistency between list options and document themwm42019-12-181-17/+72
| | | | | | | | | | | | | | | | | | | | Whenever I deal with this, I have to look at the code to make sense of this. And beyond that, there are some strange inconsistencies. (I think this code is cursed. It always was, and maybe always will be.) Although the manpage claimed that using multiple items for -add etc. is deprecated, string list options didn't warn against it. So add the warning, and add something in the changelog (even though nobody will ever read this). The manpage mentioned --vf-append, but this didn't even exist. So add it, I guess. We encourage using -append for the other option types, so for consistency, it should work on filter options. (And I already tricked me into believing it existed when I mentioned it in the manpage.) Make the "operations" table separate for all option types, and mention the option type on every single of the top-level list options.
* console.lua: add this scriptJames Ross-Gowan2019-12-081-0/+2
| | | | | | | | | | | | | | | | | | | | | Merged from mpv-repl git repo commit 5ea2bf64f9c239f0326b02. Some changes were made on top of it: - Tabs were converted to 4 spaces indentation (plus some manual indentation fixes in some places). - All user-visible mentions of "repl" were renamed to "console". - The README was converted to a manpage (with heavy changes, some additions taken from stats.rst; rossy converted the key bindings table to RST). - The method to change the default key binding was changed. - Change minor detail about "font" default value setting (not a functional change). - Integrate into the player as builtin script, including an option to prevent loading it. Above changes and commit message done by wm4. Signed-off-by: wm4 <wm4@nowhere>
* manpage: add section about using mpv from programs and scriptswm42019-11-161-0/+45
| | | | | | | | | | | | | | | Give an overview over the various methods. I feel like I've written text like this over and over again (compatibility.rst and interface-changes.rst for example duplicate the list of mpv API abstractions), but such is life in hell. Use this in particular to strongly suggest not to parse terminal output. This suggestion got lost or de-emphasized at some point (maybe when removing MPlayer and "slave mode" references). Some of this text is still there, but it can be considered "fine print" at best, that nobody will see. Now we have it in a more prominent place. This is especially important since MPlayer-style use of mpv still seems to be prevalent, see for example #7153.
* manpage: expand MPV_LEAK_REPORT environment variable descriptionwm42019-11-091-1/+5
|
* manpage: update input protocolswm42019-11-041-55/+20
| | | | | | | | | tv:// and pvr:// are gone, DVD almost. The former didn't really have any uses left, except webcams. Provide a replacement example for that. We don't need a separate section for DVD. If you use DVD, you're on your own. There's still enough documentation left to puzzle things together even if you don't read the source code.
* manpage: Update information about default mouse bindingsCameron Cawley2019-10-281-3/+12
|
* player: update status line cache displaywm42019-09-201-5/+3
| | | | | | | | | | | Replace the "+" with "/". The "+" was supposed to imply that the cache is the sum of the time (demuxer cache) and the size in bytes (stream cache). We could not provide something nicer, because we had no idea how many seconds of media was buffered in the stream cache. Now the stream cache is done, and both the duration and byte size show the amount buffered in the demuxer cache. Hopefully "/" is better to imply this properly. Update the manpage explanations too.
* Remove libdvdread support in favor of libdvdnavwm42019-09-131-17/+0
| | | | | | | | | | | stream_dvd.c contained large amounts of ancient, unmaintained code, which has been historically moved to libdvdnav. Basically, it's full of low level parsing of DVD on-disc structures. Kill it for good. Users can use the remaining dvdnav support (which basically operates in non-menu mode). Users have reported that libdvdread sometimes works better, but this is just libdvdnav's problem and not ours.
* DOCS/man/mpv.rst: Fix big-cache profile exampleLeo Izen2019-03-161-1/+2
| | | | | | The cache options were changed, and this commit fixes the example big-cache profile to use the new cache options.
* man: mention stats in interactive controlNicolas F2018-10-141-0/+5
| | | | | | | Someone on IRC pointed out that the default stats bindings weren't documented in the interactive control section of the manual, so let's add them with a short mention and a reference to the STATS section of the manual.
* manpage: fixup mistaken show playlist/track-list shortcutsDaniel M. Capella2018-07-231-2/+2
| | | | | This was mistaken in 496b13227b7f4b47a660bbf4e314f9a55b7e8867 and not noticed in review.
* manpage: mention that fd:// file descriptors may be modifiedwm42018-05-251-0/+2
| | | | | For example, we call setmode() to switch a FD from text to binary mode on garbage OSes.
* config: replace config dir lua-settings/ with dir script-opts/Avi Halachmi (:avih)2018-04-071-1/+1
| | | | lua-settings/ is still supported, with deprecation warning.
* input: minor additions to default key bindingswm42018-03-041-6/+41
| | | | | | | | | This adds key bindings for some semi-popular features. It also tries to cleanup some old bindings. For example w/e for panscan is now changed to w/W. In all cases, the old bindings are still kept and work, though. Part of an ongoing attempt to cleanup the default key bindings. See #973 for some context.
* manpage: describe how to list/inspect/apply profileswm42018-03-031-0/+5
| | | | | This is all documented elsewhere in the manpage, but hard to find from here.
* options: add a builtin low-latency profilewm42018-03-031-0/+39
| | | | | | | | | | Well I guess it doesn't help that much. Also add some stuff that might help to the manpage. The fundamental problem with some "live" sources (e.g. x11grab) is actually that the player gets behind initially, and never thinks it has to catch up. This is also why --untimed can help.
* stream_file: add mode for reading appended fileswm42018-02-211-0/+13
| | | | | | | | | | | | | Do this because retrying reading on higher levels (like the demuxer) usually causes tons of problems. A hack like this is simpler and could allow to remove some of the higher level retry behavior. This works by trying to detect whether the file is appended. If we reach EOF, check if the file size changed compared to the initial value. If it did, it means the file was appended at least once, and we set the p->appending flag. If that flag is set, we simply retry reading more data every time we encounter EOF. The only way to do this is polling, and we poll for at most 10 times, after waiting for 200ms every time.
* manpage: remove mention of --vf=eqwm42018-02-131-1/+1
| | | | This doesn't work anymore.
* input: add a keybinding to toggle hardware decodingwm42018-02-131-0/+3
| | | | | We sure as hell won't enable hardware decoding by default, but we can make it more accessible with a key binding.
* options: add string list -toggle actionwm42018-01-251-0/+1
|
* command: add a change-list commandwm42018-01-251-0/+3
| | | | | | | | | | | | | Requested. See manpage additions. The main reason why this goes through the trouble to keep the action/operation parameter separate is so that we don't expose some option parser implementation details to the command (although that is a relatively weak reason), and also to make it more different from the "set" command, which can't support this type of option as it goes through the property layer. Fixes #5435.
* manpage: remove obsolete information on bd://Ricardo Constantino2018-01-251-4/+3
| | | | ISO files have been supported by bd:// for a while.
* stream_bluray: always show list of available titlesRicardo Constantino2018-01-231-2/+2
|
* options: add -add/-append actions to key/value listswm42017-12-261-0/+2
| | | | Requested.
* player: show demuxer cache buffered amount in bytes in the status linewm42017-12-231-2/+4
| | | | | | | | I don't want to add another field to display stream and demuxer cache separately, so just add them up. This strangely makes sense, since the forward buffered stream cache amount consists of data not read by the demuxer yet. (If the demuxer cache has buffered the full stream, the forward buffered stream cache amount is 0.)
* manpage: add some minor documenation fixesLeo Izen2017-12-041-1/+1
| | | | | | - replace the incorrect reference to --opengl-shader - document a caveat when using --image-display-duration - add some documentation on --vf=lavfi=
* DOCS/mpv.rst: document bluray:// alias for bd://Leo Izen2017-11-301-0/+2
| | | | | | bluray:// is an alias for bd://, but this isn't actually documented anywhere. This should fix that.
* stats: add documentationJulian2017-10-091-0/+2
| | | | stats.rst is heavily based on osc.rst
* vo_opengl: refactor into vo_gpuNiklas Haas2017-09-211-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is done in several steps: 1. refactor MPGLContext -> struct ra_ctx 2. move GL-specific stuff in vo_opengl into opengl/context.c 3. generalize context creation to support other APIs, and add --gpu-api 4. rename all of the --opengl- options that are no longer opengl-specific 5. move all of the stuff from opengl/* that isn't GL-specific into gpu/ (note: opengl/gl_utils.h became opengl/utils.h) 6. rename vo_opengl to vo_gpu 7. to handle window screenshots, the short-term approach was to just add it to ra_swchain_fns. Long term (and for vulkan) this has to be moved to ra itself (and vo_gpu altered to compensate), but this was a stop-gap measure to prevent this commit from getting too big 8. move ra->fns->flush to ra_gl_ctx instead 9. some other minor changes that I've probably already forgotten Note: This is one half of a major refactor, the other half of which is provided by rossy's following commit. This commit enables support for all linux platforms, while his version enables support for all non-linux platforms. Note 2: vo_opengl_cb.c also re-uses ra_gl_ctx so it benefits from the --opengl- options like --opengl-early-flush, --opengl-finish etc. Should be a strict superset of the old functionality. Disclaimer: Since I have no way of compiling mpv on all platforms, some of these ports were done blindly. Specifically, the blind ports included context_mali_fbdev.c and context_rpi.c. Since they're both based on egl_helpers, the port should have gone smoothly without any major changes required. But if somebody complains about a compile error on those platforms (assuming anybody actually uses them), you know where to complain.
* man/mpv: document bd:// expected titles and title listRicardo Constantino2017-08-111-0/+5
|
* manpage: fix minor spelling mistake in mpv.rstJames Cowgill2017-07-191-1/+1
| | | | Found by https://lintian.debian.org/
* options: change everything againwm42017-07-021-4/+5
| | | | Fucking bullshit.
* options: change path list options, and document list optionswm42017-06-301-0/+29
| | | | | | | | | | | | | | | | | | | | | | | The changes to path list options is basically getting rid of the need to pass multiple paths to a single option. Instead, you can use the option multiple times. The old behavior can be used by using the -set suffix with the option. Change some options to path lists. For example --script is now append by default, and if you use --script-set, you need to use ":"/";" as separator instead of ",". --sub-paths/--audio-file-paths is a deprecated alias now, and will break if the user tries to pass multiple paths to it. I'm assuming that if these are used, most users will pass only 1 path anyway. --opengl-shaders has more compatibility handling, since it's probably rather common that users pass multiple options to it. Also document all that in the manpage. I'll probably regret this later, as it somewhat increases the complexity of the option parser, rather than increasing it.
* input.conf: drop TV/DVB bindingswm42017-06-271-7/+2
| | | | Is anyone still using them? Well, I'm removing them anyway.
* manpage: Remove documentation to use 'I' to show filename on the OSDLeo Izen2017-06-211-3/+0
| | | | | | A relic of mplayer had 'I' as the keybind to show the filename of the currently playing file on the OSD. mpv does not do this by default. This commit removes this incorrect information from the mpv manage.
* stream_file: option to close fd after use -> fdclose://sfan52017-06-161-0/+5
| | | | | fdclose://123 will instruct mpv to close the file descriptor when it is no longer needed (usually when playing finishes).
* js: add javascript scripting support using MuJSAvi Halachmi (:avih)2017-06-141-0/+2
| | | | | | | | | | | | | | | Implements JS with almost identical API to the Lua support. Key differences from Lua: - The global mp, mp.msg and mp.utils are always available. - Instead of returning x, error, return x and expose mp.last_error(). - Timers are JS standard set/clear Timeout/Interval. - Supports CommonJS modules/require. - Added at mp.utils: getenv, read_file, write_file and few more. - Global print and dump (expand objects) functions. - mp.options currently not supported. See DOCS/man/javascript.rst for more details.
* manpage: Update 'u' keyboard shortcut docs to say 'sub-ass-override'Leo Izen2017-06-131-1/+1
| | | | | | | | | Sometime earlier, "sub-ass-style-override" was renamed to "sub-ass-override". The option's documentation was updated to support this, but not the documentation for the hotkey that toggles this option. This commit updates the keyboard shortcut documentation to fix that. Signed-off-by: wm4 <wm4@nowhere>
* man: document fonts.conf, subfont.ttf, and fonts subdirZhuoyun Wei2017-05-021-0/+17
| | | | | | | | | | | | | | | | | | | Update man page for fonts.conf and subfont.ttf. These are two undocumented features in mpv. They were only hardcoded into sub/ass_mp.c and could not be found anywhere else in the entire codebase. Git log reveals that fonts.conf was added in 2013 while subfont.ttf was brought in by a ancient patch of mplayer in 2002... These are two quite useful undocumented features when you do not want to mess up with global fonts.conf to include more fonts. Also document ~/.config/mpv/fonts/ directory and suggest using fonts.conf to include additional fonts. mpv reads all files in ~/.config/mpv/fonts/ directory into memory. If there are a lot of fonts in that directory, mpv would use a lot of memory. Using ~/.config/mpv/fonts.conf to include additional fonts is more memory-efficent.
* manpage: add empty line between protocol header/descriptionwm42017-03-251-0/+19
| | | | Appears to give better formatting. (I'll never understand rst...)
* manpage: explain more about outstanding dvdnav bugsFrederick Eaton2017-03-251-5/+11
|
* stream_lavf: add support for data URIsRicardo Constantino2017-01-251-0/+4
| | | | | | | Only FFmpeg supports them and they need to be in the format data:// like other protocols or prefixed with ffmpeg:// or lavf://. Closes #4058
* manpage: add "A/V sync" to make it findable with Ctrl+foctos2017-01-251-1/+1
|
* manpage: add table of contents to the HTML versionZhiming Wang2016-12-141-0/+2
| | | | | | | | The reST contents directive is added to mpv.rst. In wscript_build.py, the --strip-elements-with-class=contents option is needed for the rst2man call in order to prevent the TOC from appearing in mpv.1.
* manpage: document current and legacy option syntax betterwm42016-12-121-0/+28
| | | | | | | I thought it ewas already documented, but I'm not seeing it anywhere. Maybe it did exist, but was deleted. See #3899.
* manpage: remove mention of window alpha (OSX)Akemi2016-12-081-4/+1
| | | | | | | This is not implemented and i don't even know if it ever was. Also remove a trailing whitespace. Fixes #3866
* manpage: document ytdl://wm42016-10-231-0/+9
|
* options: rename subtitle optionsDan Oscarsson2016-10-031-2/+2
| | | | | | | | | | | Rename the text subtitle options from --sub-text- to --sub- and --ass- options to --sub-ass-. The intention is to common sub options to prefixed --sub- and special ASS option be seen as a special version of sub options. The OSD options that work like the --sub- options are still named --osd-. Man page updated including a short note about renamed --sub-text-* and --ass-* options to --sub-* and --sub-ass-*.
* player: allow opts in pseudo-gui set by the user to override user's defaultRicardo Constantino2016-09-261-6/+10
| | | | | | | | | | | | | | | | | | | | | This should still allow user-set default options to override built-in pseudo-gui while respecting user-set pseudo-gui options. Pros: - user option in default profile overrides built-in pseudo-gui's options Ex: screenshot-directory overrides built-in pseudo-gui's - user can "fix" pseudo-gui if some option like "force-window=no" is set in default by setting "force-window=yes" in [pseudo-gui] - `mpv --profile=pseudo-gui` will work as before Cons: - --show-profile=pseudo-gui won't display the built-in's options Original idea from wm4. Documentation edits mostly by wm4. Signed-off-by: wm4 <wm4@nowhere>
* player: do not let pseudo-gui override user config settingswm42016-09-231-7/+11
| | | | | | | | Seems like this confused users quite often. Instead of --profile=pseudo-gui, --player-operation-mode=pseudo-gui now has to be used to invoke pseudo GUI mode. The old way still works, and still behaves in the old way.
* DOCS: vo/ao auto profiles are deprecatedRiCON2016-09-171-2/+1
| | | Leftovers from removal of references to ao/vo auto profiles.
* stream_cdda: remove weird option parsing stuffwm42016-09-091-1/+1
| | |