diff options
Diffstat (limited to 'DOCS')
| -rw-r--r-- | DOCS/client-api-changes.rst | 22 | ||||
| -rw-r--r-- | DOCS/compile-windows.md | 6 | ||||
| -rw-r--r-- | DOCS/interface-changes.rst | 76 | ||||
| -rw-r--r-- | DOCS/libmpv-client-api.rst | 14 | ||||
| -rw-r--r-- | DOCS/man/af.rst | 26 | ||||
| -rw-r--r-- | DOCS/man/ao.rst | 191 | ||||
| -rw-r--r-- | DOCS/man/changes.rst | 7 | ||||
| -rw-r--r-- | DOCS/man/input.rst | 325 | ||||
| -rw-r--r-- | DOCS/man/ipc.rst | 4 | ||||
| -rw-r--r-- | DOCS/man/libmpv.rst | 16 | ||||
| -rw-r--r-- | DOCS/man/lua.rst | 24 | ||||
| -rw-r--r-- | DOCS/man/mpv.rst | 72 | ||||
| -rw-r--r-- | DOCS/man/options.rst | 1365 | ||||
| -rw-r--r-- | DOCS/man/osc.rst | 114 | ||||
| -rw-r--r-- | DOCS/man/vo.rst | 1080 | ||||
| -rw-r--r-- | DOCS/mplayer-changes.rst | 9 |
16 files changed, 1779 insertions, 1572 deletions
diff --git a/DOCS/client-api-changes.rst b/DOCS/client-api-changes.rst index 4d6608bd97..87b1c650da 100644 --- a/DOCS/client-api-changes.rst +++ b/DOCS/client-api-changes.rst @@ -32,8 +32,26 @@ API changes :: - --- mpv 0.20.0 - --- mpv 0.19.0 + --- mpv 0.21.0 --- + 1.23 - deprecate setting "no-" options via mpv_set_option*(). For example, + instead of "no-video=" you should set "video=no". + - do not override the SIGPIPE signal handler anymore. This was done as + workaround for the FFmpeg TLS code, which has been fixed long ago. + - deprecate mpv_suspend() and mpv_resume(). They will be stubbed out + in mpv 0.22.0. + - make mpv_set_property() work to some degree before mpv_initialize(). + It can now be used instead of mpv_set_option(). + - semi-deprecate mpv_set_option()/mpv_set_option_string(). You should + use mpv_set_property() instead. There are some deprecated properties + which conflict with some options (see client.h remarks on + mpv_set_option()), for which mpv_set_option() might still be required. + In future mpv releases, the conflicting deprecated options/properties + will be removed, and mpv_set_option() will internally translate API + calls to mpv_set_property(). + - qthelper.hpp: deprecate get_property_variant, set_property_variant, + mpv_set_option, command_variant, and replace them with get_property, + set_property, command. + --- mpv 0.19.0 --- 1.22 - add stream_cb API for custom protocols --- mpv 0.18.1 --- ---- - remove "status" log level from mpv_request_log_messages() docs. This diff --git a/DOCS/compile-windows.md b/DOCS/compile-windows.md index c043671c9f..e283460674 100644 --- a/DOCS/compile-windows.md +++ b/DOCS/compile-windows.md @@ -104,10 +104,10 @@ Installing MSYS2 It doesn't matter whether the i686 or the x86_64 version is used. Both can build 32-bit and 64-bit binaries when running on a 64-bit version of Windows. -2. Start a MinGW-w64 shell (``mingw64_shell.bat``). Note that this is different +2. Start a MinGW-w64 shell (``mingw64.exe``). Note that this is different from the MSYS2 shell that is started from the final installation dialog. - For a 32-bit build, use ``mingw32_shell.bat``. + For a 32-bit build, use ``mingw32.exe``. Updating MSYS2 -------------- @@ -118,7 +118,7 @@ separately. ```bash # Check for core updates. If instructed, close the shell window and reopen it # before continuing. -update-core +pacman -Syu # Update everything else pacman -Su diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst index f02f6588ff..1e27edfe03 100644 --- a/DOCS/interface-changes.rst +++ b/DOCS/interface-changes.rst @@ -19,6 +19,82 @@ Interface changes :: + --- mpv 0.21.0 --- + - setting certain options at runtime will now take care of updating them + property (see for example issue #3281). On the other hand, it will also + do runtime verification and reject option changes that do not work + (example: setting the "vf" option to a filter during playback, which fails + to initialize - the option value will remain at its old value). In general, + "set name value" should be mostly equivalent to "set options/name value" + in cases where the "name" property is not deprecated and "options/name" + exists - deviations from this are either bugs, or documented as caveats + in the "Inconsistencies between options and properties" manpage section. + - deprecate _all_ --vo and --ao suboptions. Generally, all suboptions are + replaced by global options, which do exactly the same. For example, + "--vo=opengl:scale=nearest" turns into "--scale=nearest". In some cases, + the global option is prefixed, e.g. "--vo=opengl:pbo" turns into + "--opengl-pbo". + Most of the exact replacements are documented here: + https://github.com/mpv-player/mpv/wiki/Option-replacement-list + - remove --vo=opengl-hq. Set --profile=opengl-hq instead. Note that this + profile does not force the VO. This means if you use the --vo option to + set another VO, it won't work. But this also means it can be used with + opengl-cb. + - remove the --vo=opengl "pre-shaders", "post-shaders" and "scale-shader" + sub-options: they were deprecated in favor of "user-shaders" + - deprecate --vo-defaults (no replacement) + - remove the vo-cmdline command. You can set OpenGL renderer options + directly via properties instead. + - deprecate the device/sink options on all AOs. Use --audio-device instead. + - deprecate "--ao=wasapi:exclusive" and "--ao=coreaudio:exclusive", + use --audio-exclusive instead. + - subtle changes in how "--no-..." options are treated mean that they are + not accessible under "options/..." anymore (instead, these are resolved + at parsing time). This does not affect options which start with "--no-", + but do not use the mechanism for negation options. + (Also see client API change for API version 1.23.) + - rename the following properties + - "demuxer" -> "current-demuxer" + - "fps" -> "container-fps" + - "idle" -> "idle-active" + - "cache" -> "cache-percent" + the old names are deprecated and will change behavior in mpv 0.22.0. + - remove deprecated "hwdec-active" and "hwdec-detected" properties + - deprecate the ao and vo auto-profiles (they never made any sense) + - deprecate "--vo=direct3d_shaders" - use "--vo=direct3d" instead. + Change "--vo=direct3d" to always use shaders by default. + - deprecate --playlist-pos option, renamed to --playlist-start + - deprecate the --chapter option, as it is redundant with --start/--end, + and conflicts with the semantics of the "chapter" property + - rename --sub-text-* to --sub-* and --ass-* to --sub-ass-* (old options + deprecated) + - incompatible change to cdda:// protocol options: the part after cdda:// + now always sets the device, not the span or speed to be played. No + separating extra "/" is needed. The hidden --cdda-device options is also + deleted (it was redundant with the documented --cdrom-device). + - deprecate --vo=rpi. It will be removed in mpv 0.22.0. Its functionality + was folded into --vo=opengl, which now uses RPI hardware decoding by + treating it as a hardware overlay (without applying GL filtering). Also + to be changed in 0.22.0: the --fs flag will be reset to "no" by default + (like on the other platforms). + - deprecate --mute=auto (informally has been since 0.18.1) + - deprecate "resume" and "suspend" IPC commands. They will be completely + removed in 0.22.0. + - deprecate mp.suspend(), mp.resume(), mp.resume_all() Lua scripting + commands, as well as setting mp.use_suspend. They will be completely + removed in 0.22.0. + - the "seek" command's absolute seek mode will now interpret negative + seek times as relative from the end of the file (and clamps seeks that + still go before 0) + - add almost all options to the property list, meaning you can change + options without adding "options/" to the property name (a new section + has been added to the manpage describing some conflicting behavior + between options and properties) + - implement changing sub-speed during playback + - make many previously fixed options changeable at runtime (for example + --terminal, --osc, --ytdl, can all be enable/disabled after + mpv_initialize() - this can be extended to other still fixed options + on user requests) --- mpv 0.20.0 --- - add --image-display-duration option - this also means that image duration is not influenced by --mf-fps anymore in the general case (this is an diff --git a/DOCS/libmpv-client-api.rst b/DOCS/libmpv-client-api.rst deleted file mode 100644 index eeb5fe0408..0000000000 --- a/DOCS/libmpv-client-api.rst +++ /dev/null @@ -1,14 +0,0 @@ -Client API (libmpv) documentation and examples -============================================== - -libmpv lets you embed mpv as a library. It is meant to enable development of -GUI frontends. - -Since libmpv merely allows access to underlying mechanisms that can control -mpv, documentation is spread over a few places: - -- https://github.com/mpv-player/mpv/blob/master/libmpv/client.h -- http://mpv.io/manual/master/#options -- http://mpv.io/manual/master/#list-of-input-commands -- http://mpv.io/manual/master/#properties -- https://github.com/mpv-player/mpv-examples/tree/master/libmpv diff --git a/DOCS/man/af.rst b/DOCS/man/af.rst index c52c422299..4c91b5a9b5 100644 --- a/DOCS/man/af.rst +++ b/DOCS/man/af.rst @@ -312,6 +312,13 @@ Available filters are: ``mpv '--af=format=channels=5.1' '--audio-channels=5.1'`` would always force remixing audio to 5.1 and output it like this. + This filter supports the following ``af-command`` commands: + + ``set-matrix`` + Set the ``<matrix>`` argument dynamically. This can be used to change + the mixing matrix at runtime, without reinitializing the entire filter + chain. + ``drc[=method:target]`` Applies dynamic range compression. This maximizes the volume by compressing the audio signal's dynamic range. (Formerly called ``volnorm``.) @@ -394,10 +401,6 @@ Available filters are: ``mpv --af=scaletempo=stride=30:overlap=.50:search=10 media.ogg`` Would tweak the quality and performance parameters. - ``mpv --af=format=float,scaletempo media.ogg`` - Would make scaletempo use float code. Maybe faster on some - platforms. - ``mpv --af=scaletempo=scale=1.2:speed=pitch audio.ogg`` Would play media at 1.2x normal speed, with audio at normal pitch. Changing playback speed would change pitch, leaving audio tempo at @@ -406,9 +409,13 @@ Available filters are: ``rubberband`` High quality pitch correction with librubberband. This can be used in place of ``scaletempo``, and will be used to adjust audio pitch when playing - at speed different from normal. + at speed different from normal. It can also be used to adjust audio pitch + without changing playback speed. - This filter has a number of sub-options. You can list them with + ``<pitch-scale>`` + Sets the pitch scaling factor. Frequencies are multiplied by this value. + + This filter has a number of additional sub-options. You can list them with ``mpv --af=rubberband=help``. This will also show the default values for each option. The options are not documented here, because they are merely passed to librubberband. Look at the librubberband documentation @@ -417,6 +424,13 @@ Available filters are: (The mapping of the mpv rubberband filter sub-option names and values to those of librubberband follows a simple pattern: ``"Option" + Name + Value``.) + This filter supports the following ``af-command`` commands: + + ``set-pitch`` + Set the ``<pitch-scale>`` argument dynamically. This can be used to + change the playback pitch at runtime. Note that speed is controlled + using the standard ``speed`` property, not ``af-command``. + ``lavfi=graph`` Filter audio using FFmpeg's libavfilter. diff --git a/DOCS/man/ao.rst b/DOCS/man/ao.rst index 8bddc98a42..0e45b1e96e 100644 --- a/DOCS/man/ao.rst +++ b/DOCS/man/ao.rst @@ -4,18 +4,17 @@ AUDIO OUTPUT DRIVERS Audio output drivers are interfaces to different audio output facilities. The syntax is: -``--ao=<driver1[:suboption1[=value]:...],driver2,...[,]>`` +``--ao=<driver1,driver2,...[,]>`` Specify a priority list of audio output drivers to be used. If the list has a trailing ',', mpv will fall back on drivers not contained -in the list. Suboptions are optional and can mostly be omitted. - -You can also set defaults for each driver. The defaults are applied before the -normal driver parameters. +in the list. ``--ao-defaults=<driver1[:parameter1:parameter2:...],driver2,...>`` Set defaults for each driver. + Deprecated. No replacement. + .. note:: See ``--ao=help`` for a list of compiled-in audio output drivers. The @@ -23,87 +22,19 @@ normal driver parameters. where PulseAudio is used. On BSD systems, ``--ao=oss`` or ``--ao=sndio`` may work (the latter being experimental). -.. admonition:: Examples - - - ``--ao=alsa,oss,`` Try the ALSA driver, then the OSS driver, then others. - - ``--ao=alsa:resample=yes:device=[plughw:0,3]`` Lets ALSA resample and - sets the device-name as first card, fourth device. - Available audio output drivers are: ``alsa`` (Linux only) ALSA audio output driver - ``device=<device>`` - Sets the device name. For ac3 output via S/PDIF, use an "iec958" or - "spdif" device, unless you really know how to set it correctly. - ``resample=yes`` - Enable ALSA resampling plugin. (This is disabled by default, because - some drivers report incorrect audio delay in some cases.) - ``mixer-device=<device>`` - Set the mixer device used with ``--no-softvol`` (default: ``default``). - ``mixer-name=<name>`` - Set the name of the mixer element (default: ``Master``). This is for - example ``PCM`` or ``Master``. - ``mixer-index=<number>`` - Set the index of the mixer channel (default: 0). Consider the output of - "``amixer scontrols``", then the index is the number that follows the - name of the element. - ``non-interleaved`` - Allow output of non-interleaved formats (if the audio decoder uses - this format). Currently disabled by default, because some popular - ALSA plugins are utterly broken with non-interleaved formats. - ``ignore-chmap`` - Don't read or set the channel map of the ALSA device - only request the - required number of channels, and then pass the audio as-is to it. This - option most likely should not be used. It can be useful for debugging, - or for static setups with a specially engineered ALSA configuration (in - this case you should always force the same layout with ``--audio-channels``, - or it will work only for files which use the layout implicit to your - ALSA device). - - .. note:: - - MPlayer and mplayer2 required you to replace any ',' with '.' and - any ':' with '=' in the ALSA device name. mpv does not do this anymore. - Instead, quote the device name: - - ``--ao=alsa:device=[plug:surround50]`` - - Note that the ``[`` and ``]`` simply quote the device name. With some - shells (like zsh), you have to quote the option string to prevent the - shell from interpreting the brackets instead of passing them to mpv. - - Actually, you should use the ``--audio-device`` option, instead of - setting the device directly. + See `ALSA audio output options`_ for options specific to this AO. .. warning:: - Handling of multichannel/surround audio changed in mpv 0.8.0 from the - behavior in MPlayer/mplayer2 and older versions of mpv. - - The old behavior is that the player always downmixed to stereo by - default. The ``--audio-channels`` (or ``--channels`` before that) option - had to be set to get multichannel audio. Then playing stereo would - use the ``default`` device (which typically allows multiple programs - to play audio at the same time via dmix), while playing anything with - more channels would open one of the hardware devices, e.g. via the - ``surround51`` alias (typically with exclusive access). Whether the - player would use exclusive access or not would depend on the file - being played. - - The new behavior since mpv 0.8.0 always enables multichannel audio, - i.e. ``--audio-channels=auto`` is the default. However, since ALSA - provides no good way to play multichannel audio in a non-exclusive - way (without blocking other applications from using audio), the player - is restricted to the capabilities of the ``default`` device by default, - which means it supports only stereo and mono (at least with current - typical ALSA configurations). But if a hardware device is selected, - then multichannel audio will typically work. - - The short story is: if you want multichannel audio with ALSA, use - ``--audio-device`` to select the device (use ``--audio-device=help`` - to get a list of all devices and their mpv name). + To get multichannel/surround audio, use ``--audio-channels=auto``. The + default for this option is ``auto-safe``, which makes this audio otuput + explicitly reject multichannel output, as there is no way to detect + whether a certain channel layout is actually supported. You can also try `using the upmix plugin <http://git.io/vfuAy>`_. This setup enables multichannel audio on the ``default`` device @@ -113,31 +44,36 @@ Available audio output drivers are: ``oss`` OSS audio output driver - ``<dsp-device>`` + The following global options are supported by this audio output: + + ``--oss-device`` Sets the audio output device (default: ``/dev/dsp``). - ``<mixer-device>`` + Deprecated, use ``--audio-device``. + ``--oss-mixer-device`` Sets the audio mixer device (default: ``/dev/mixer``). - ``<mixer-channel>`` + ``--oss-mixer-channel`` Sets the audio mixer channel (default: ``pcm``). Other valid values include **vol, pcm, line**. For a complete list of options look for ``SOUND_DEVICE_NAMES`` in ``/usr/include/linux/soundcard.h``. ``jack`` - JACK (Jack Audio Connection Kit) audio output driver + JACK (Jack Audio Connection Kit) audio output driver. - ``port=<name>`` + The following global options are supported by this audio output: + + ``--jack-port=<name>`` Connects to the ports with the given name (default: physical ports). - ``name=<client>`` + ``--jack-name=<client>`` Client name that is passed to JACK (default: ``mpv``). Useful if you want to have certain connections established automatically. - ``(no-)autostart`` + ``--jack-autostart=<yes|no>`` Automatically start jackd if necessary (default: disabled). Note that this tends to be unreliable and will flood stdout with server messages. - ``(no-)connect`` + ``--jack-connect=<yes|no>`` Automatically create connections to output ports (default: enabled). When enabled, the maximum number of output channels will be limited to the number of available output ports. - ``std-channel-layout=waveext|any`` + ``--jack-std-channel-layout=<waveext|any>`` Select the standard channel layout (default: waveext). JACK itself has no notion of channel layouts (i.e. assigning which speaker a given channel is supposed to map to) - it just takes whatever the application @@ -157,7 +93,9 @@ Available audio output drivers are: Automatically redirects to ``coreaudio_exclusive`` when playing compressed formats. - ``change-physical-format=<yes|no>`` + The following global options are supported by this audio output: + + ``--coreaudio-change-physical-format=<yes|no>`` Change the physical format to one similar to the requested audio format (default: no). This has the advantage that multichannel audio output will actually work. The disadvantage is that it will change the @@ -165,11 +103,13 @@ Available audio output drivers are: setting in the ``Audio Devices`` dialog in the ``Audio MIDI Setup`` utility. Note that this does not affect the selected speaker setup. - ``exclusive`` + ``--coreaudio-exclusive`` + Deprecated, use ``--audio-exclusive``. Use exclusive mode access. This merely redirects to ``coreaudio_exclusive``, but should be preferred over using that AO directly. + ``coreaudio_exclusive`` (Mac OS X only) Native Mac OS X audio output driver using direct device access and exclusive mode (bypasses the sound server). @@ -183,18 +123,21 @@ Available audio output drivers are: ``pulse`` PulseAudio audio output driver - ``[<host>][:<output sink>]`` + The following global options are supported by this audio output: + + ``--pulse-host=<host>``, ``--pulse-sink=<sink>`` Specify the host and optionally output sink to use. An empty <host> string uses a local connection, "localhost" uses network transfer (most likely not what you want). + Deprecated, use ``--audio-device``. - ``buffer=<1-2000|native>`` + ``--pulse-buffer=<1-2000|native>`` Set the audio buffer size in milliseconds. A higher value buffers more data, and has a lower probability of buffer underruns. A smaller value makes the audio stream react faster, e.g. to playback speed changes. Default: 250. - ``latency-hacks=<yes|no>`` + ``--pulse-latency-hacks=<yes|no>`` Enable hacks to workaround PulseAudio timing bugs (default: no). If enabled, mpv will do elaborate latency calculations on its own. If disabled, it will use PulseAudio automatically updated timing @@ -214,61 +157,67 @@ Available audio output drivers are: environments, such as systems where none of the other drivers are available. - ``buflen=<length>`` + The following global options are supported by this audio output: + + ``--sdl-buflen=<length>`` Sets the audio buffer length in seconds. Is used only as a hint by the sound system. Playing a file with ``-v`` will show the requested and obtained exact buffer size. A value of 0 selects the sound system default. - ``bufcnt=<count>`` + ``--sdl-bufcnt=<count>`` Sets the number of extra audio buffers in mpv. Usually needs not be changed. ``null`` - Produces no audio output but maintains video playback speed. Use - ``--ao=null:untimed`` for benchmarking. + Produces no audio output but maintains video playback speed. You can use + ``--ao=null --ao-null-untimed`` for benchmarking. + + The following global options are supported by this audio output: - ``untimed`` + ``--ao-null-untimed`` Do not simulate timing of a perfect audio device. This means audio decoding will go as fast as possible, instead of timing it to the system clock. - ``buffer`` + ``--ao-null-buffer`` Simulated buffer length in seconds. - ``outburst`` + ``--ao-null-outburst`` Simulated chunk size in samples. - ``speed`` + ``--ao-null-speed`` Simulated audio playback speed as a multiplier. Usually, a real audio device will not go exactly as fast as the system clock. It will deviate just a little, and this option helps to simulate this. - ``latency`` + ``--ao-null-latency`` Simulated device latency. This is additional to EOF. - ``broken-eof`` + ``--ao-null-broken-eof`` Simulate broken audio drivers, which always add the fixed device latency to the reported audio playback position. - ``broken-delay`` + ``--ao-null-broken-delay`` Simulate broken audio drivers, which don't report latency correctly. - ``channel-layouts`` + ``--ao-null-channel-layouts`` If not empty, this is a ``,`` separated list of channel layouts the AO allows. This can be used to test channel layout selection. ``pcm`` Raw PCM/WAVE file writer audio output - ``(no-)waveheader`` + The following global options are supported by this audio output: + + ``--ao-pcm-waveheader=<yes|no>`` Include or do not include the WAVE header (default: included). When not included, raw PCM will be generated. - ``file=<filename>`` + ``--ao-pcm-file=<filename>`` Write the sound to ``<filename>`` instead of the default ``audiodump.wav``. If ``no-waveheader`` is specified, the default is ``audiodump.pcm``. - ``(no-)append`` + ``--ao-pcm-append=<yes|no>`` Append to the file, instead of overwriting it. Always use this with the ``no-waveheader`` option - with ``waveheader`` it's broken, because it will write a WAVE header every time the file is opened. @@ -280,14 +229,19 @@ Available audio output drivers are: confused with RoarAudio, which is something completely different. - ``host=<name/path>`` + The following global options are supported by this audio output: + + ``--rsound-host=<name/path>`` Set the address of the server (default: localhost). Can be either a network hostname for TCP connections or a Unix domain socket path starting with '/'. - ``port=<number>`` + ``--rsound-port=<number>`` Set the TCP port used for connecting to the server (default: 12345). Not used if connecting to a Unix domain socket. + These options are deprecated. If anyone cares enough, their functionality + can be added back using ``--audio-device``. + ``sndio`` Audio output to the OpenBSD sndio sound system @@ -296,16 +250,24 @@ Available audio output drivers are: (Note: only supports mono, stereo, 4.0, 5.1 and 7.1 channel layouts.) - ``device=<device>`` + The following global options are supported by this audio output: + + ``--ao-sndio-device=<device>`` sndio device to use (default: ``$AUDIODEVICE``, resp. ``snd0``). + Deprecated, use ``--audio-device``. ``wasapi`` Audio output to the Windows Audio Session API. - ``exclusive`` + The following global options are supported by this audio output: + + ``--ao-wasapi-exclusive`` + Deprecated, use ``--audio-exclusive``. Requests exclusive, direct hardware access. By definition prevents sound playback of any other program until mpv exits. - ``device=<id>`` + ``--ao-wasapi-device=<id>`` + Deprecated, use ``--audio-device``. + Uses the requested endpoint instead of the system's default audio endpoint. Both an ordinal number (0,1,2,...) and the GUID String are valid; the GUID string is guaranteed to not change @@ -313,8 +275,3 @@ Available audio output drivers are: Also supports searching active devices by human-readable name. If more than one device matches the name, refuses loading it. - - This option is mostly deprecated in favour of the more general - ``--audio-device`` option. That said, ``--audio-device=help`` will give - a list of valid device GUIDs (prefixed with ``wasapi/``), as well as - their human readable names, which should work here. diff --git a/DOCS/man/changes.rst b/DOCS/man/changes.rst index 92ec3444af..d1daa32bd7 100644 --- a/DOCS/man/changes.rst +++ b/DOCS/man/changes.rst @@ -8,6 +8,11 @@ There is no real changelog, but you can look at the following things: https://github.com/mpv-player/mpv/releases * The git log, which is the "real" changelog +* The files ``client-api-changes.rst`` and ``interface-changes.rst`` in the + ``DOCS`` sub directoryon the git repository, which document API and user + interface changes (the latter usually documents breaking changes only, rather + than additions). * The file ``mplayer-changes.rst`` in the ``DOCS`` sub directory on the git repository, which used to be in place of this section. It documents some - changes that happened since mplayer2 forked off MPlayer. + changes that happened since mplayer2 forked off MPlayer. (Not updated + anymore.) diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst index 8cdba41a3d..d15aa41903 100644 --- a/DOCS/man/input.rst +++ b/DOCS/man/input.rst @@ -95,7 +95,7 @@ List of Input Commands relative (default) Seek relative to current position (a negative value seeks backwards). absolute - Seek to a given time. + Seek to a given time (a negative value starts from the end of the file). absolute-percent Seek to a given percent position. relative-percent @@ -665,13 +665,6 @@ Input Commands that are Possibly Subject to Change (the ``ab-loop-a`` property); the second the ``B`` point, and the third will clear both points. -``vo-cmdline "<args>"`` - Reset the sub-option of the current VO. Currently works with ``opengl`` - (including ``opengl-hq``). The argument is the sub-option string usually - passed to the VO on the command line. Not all sub-options can be set, but - those which can will be reset even if they don't appear in the argument. - This command might be changed or removed in the future. - ``drop-buffers`` Drop audio/video/demuxer buffers, and restart from fresh. Might help with unseekable streams that are going out of sync. @@ -698,6 +691,17 @@ Input Commands that are Possibly Subject to Change ``af-command "<label>" "<cmd>" "<args>"`` Same as ``vf-command``, but for audio filters. +``apply-profile "<name>"`` + Apply the contents of a named profile. This is like using ``profile=name`` + in a config file, except you can map it to a key binding to change it at + runtime. + + There is no such thing as "unapplying" a profile - applying a profile + merely sets all option values listed within the profile. + +``load-script "<path>"`` + Load a script, similar to the ``--script`` option. + Undocumented commands: ``tv-last-channel`` (TV/DVB only), ``ao-reload`` (experimental/internal). @@ -838,20 +842,12 @@ an option at runtime. Property list ------------- -``osd-level`` (RW) - See ``--osd-level``. +.. note:: -``osd-scale`` (RW) - OSD font size multiplier, see ``--osd-scale``. - -``loop`` (RW) - See ``--loop``. - -``loop-file`` (RW) - See ``--loop-file`` (uses ``yes``/``no``). - -``speed`` (RW) - See ``--speed``. + Most options can be set as runtime via properties as well. Just remove the + leading ``--`` from the option name. These are not documented. Only + properties which do not exist as option with the same name, or which have + very different behavior from the options are documented below. ``audio-speed-correction``, ``video-speed-correction`` Factor multiplied with ``speed`` at which the player attempts to play the @@ -911,9 +907,11 @@ Property list list of format names, e.g. mp4 is ``mov,mp4,m4a,3gp,3g2,mj2`` (the list may grow in the future for any format). -``demuxer`` +``current-demuxer`` Name of the current demuxer. (This is useless.) + (Renamed from ``demuxer``.) + ``stream-path`` Filename (full path) of the stream layer filename. (This is probably useless. It looks like this can be different from ``path`` only when @@ -989,6 +987,12 @@ Property list Remaining length of the file in seconds. Note that the file duration is not always exactly known, so this is an estimate. +``audio-pts`` (R) + Current audio playback position in current file in seconds. Unlike time-pos, + this updates more often than once per frame. For audio-only files, it is + mostly equivalent to time-pos, while for video-only files this property is + not available. + ``playtime-remaining`` ``time-remaining`` scaled by the current ``speed``. @@ -1078,10 +1082,6 @@ Property list "title" MPV_FORMAT_STRING "default" MPV_FORMAT_FLAG -``ab-loop-a``, ``ab-loop-b`` (RW) - Set/get A-B loop points. See corresponding options and ``ab-loop`` command - for details. - ``angle`` (RW) Current DVD angle. @@ -1154,13 +1154,12 @@ Property list ``af-metadata/<filter-label>`` Equivalent to ``vf-metadata/<filter-label>``, but for audio filters. -``pause`` (RW) - Pause status. This is usually ``yes`` or ``no``. See ``--pause``. - -``idle`` +``idle-active`` Return ``yes`` if no file is loaded, but the player is staying around because of the ``--idle`` option. + (Renamed from ``idle``.) + ``core-idle`` Return ``yes`` if the playback core is paused, otherwise ``no``. This can be different ``pause`` in special situations, such as when the player @@ -1236,25 +1235,12 @@ Property list is loaded, or when switching ordered chapter segments. This is because the same underlying code is used for seeking and resyncing.) -``hr-seek`` (RW) - See ``--hr-seek``. - ``mixer-active`` Return ``yes`` if the audio mixer is active, ``no`` otherwise. This option is relatively useless. Before mpv 0.18.1, it could be used to infer behavior of the ``volume`` property. -``volume`` (RW) - Current volume (see ``--volume`` for details). - -``volume-max`` (RW) - Current maximum value the volume property can be set to. (Equivalent to the - ``--volume-max`` option.) - -``mute`` (RW) - Current mute status (``yes``/``no``). - ``ao-volume`` (RW) System volume. This property is available only if mpv audio output is currently active, and only if the underlying implementation supports volume @@ -1266,9 +1252,6 @@ Property list Similar to ``ao-volume``, but controls the mute state. May be unimplemented even if ``ao-volume`` works. -``audio-delay`` (RW) - See ``--audio-delay``. - ``audio-codec`` Audio codec selected for decoding. @@ -1316,28 +1299,6 @@ Property list Same as ``audio-params``, but the format of the data written to the audio API. -``aid`` (RW) - Current audio track (similar to ``--aid``). - -``audio`` (RW) - Alias for ``aid``. - |