Command line video player
Go to file
wm4 e265c07547 vo: fix missed option updates under rare circumstances
Dear diary,

today I fixed a shitty bug that was all my fault because I made a
horrible mess. (Except it was a horrible mess before I even touched
this shit, but let's not blame others.)

Sometimes, updates to VO option that control video sizing (like panscan)
didn't update the screen correctly. They were delayed until the next
option change or so.

It turns out that if the option update happens at the "same" time as a
VOCTRL, update_opts() doesn't actually notify the vo_driver of the
change. This in turn happened because run_control() called
m_config_cache_update(). The latter function returns true if the options
changed since the last call, and update_opts() also calls it (on the
same config cache) for the same purpose. The update_opts() call, which
is triggered by a third mechanism, comes later, but the cache update
call will return false (as it should). Basically, given the config API,
you can't act differently on multiple update calls and expect it to
work. The skipped handling in update_opts() meant that the notification
required to apply the changed option wasn't run.

Fix this by simply calling update_opts() directly instead. Now there's
only 1 m_config_cache_update() call on this specific instance. Fix the
call in run_reconfig() too, so the previous sentence isn't a lie (but it
probably doesn't make a difference in practice due to certain details).

I'm not sure how I even ran into this sort-of race condition. The VOCTRL
that messed up the option update was VOCTRL_UPDATE_PLAYBACK_STATE, which
happens semi-regularly.

Why this config cache shit and all the other shit? Rediscovering this
crap wasn't pleasant. It's a bunch of hacks that became necessary when
the ancient MPlayer architecture made it hard to move the VO to a
separate thread.

All the VO code typically accesses vo->opts (whose fields all used to be
global variables in MPlayer). The frontend changes these on user input.
Putting locking around all the options would be a nightmare, and keeping
a copy of the options in the thread was much simpler. You need a way to
propagate option changes, notify the thread, and update the local copy
too. And the result of these thoughts was the config cache mechanism.

In this specific case, the relevant cache update call in update_opts()
triggers a VOCTRL_SET_PANSCAN to the VO driver, which isn't related to
its former function anymore. Instead, it causes the VO driver to update
the video sizing/placing options, which the generic VO code can't do.
(Mostly because the VO driver includes the windowing stuff and is
responsible for resizing etc. itself.)

VOCTRLs sent by the frontend are even worse. MPlayer had no real runtime
option change mechanism. Some options were vaguely duplicated by
properties, so you could effectively change those options at runtime.
Each of these options had its own VOCTRL, which still exist today, e.g.
VOCTRL_FULLSCREEN, or VOCTRL_ONTOP. I tried to make all options runtime
changeable, and to unify properties with options. But I couldn't be
bothered with updating all VO drivers to listen to option changes
directly, because that would be pretty tedious. So the property code is
still all there and sends the old VOCTRLs. But of course you need to
sync up the options, which is why the run_control() code did that.

(Unrelated: VO_EVENT_FULLSCREEN_STATE is the worst shithack of them all.
Currently, only the frontend can actually write to options (for awful
reasons), so if the fullscreen state changes due to outside interaction,
the VO driver can't update the corresponding option fields. So the VO
notifies the frontend with said VO_EVENT_, and the frontend then sends
VOCTRL_GET_FULLSCREEN, and updates the global copy of the option with
the value returned by that. I still like to think the situation is not
that bad considering the monstrous effort of converting single-threaded
code that had hundreds of options in global variables to multi-threaded
code with no global variables at all.)
2019-09-19 20:37:05 +02:00
.github github: recommend 0x0.st rather than sprunge.us for logfiles 2018-02-16 00:59:25 -08:00
DOCS command, demux: add AB-loop keyframe cache align command 2019-09-19 20:37:05 +02:00
TOOLS TOOLS/travis-rebuild-website: update condition after docker transition 2019-07-30 20:12:33 +01:00
audio audio: remove unreferenced af_lavrresample 2019-09-19 20:37:05 +02:00
ci ci: remove now unuspported libdvdread 2019-09-13 18:19:50 +02:00
common recorder: always mux all packets on discont/close 2019-09-19 20:37:05 +02:00
demux command, demux: add AB-loop keyframe cache align command 2019-09-19 20:37:05 +02:00
etc docs: add removed properties and options to interface-changes.rst 2018-12-06 19:14:14 +01:00
filters vf_vapourynth: remove Lua backend 2019-09-19 20:37:05 +02:00
input Merge commit '559a400ac36e75a8d73ba263fd7fa6736df1c2da' into wm4-commits--merge-edition 2018-12-05 19:19:24 +01:00
libmpv drm: fix libmpv ABI breakage introduced in 351c083487 2019-09-18 23:59:32 +03:00
misc rendezvous: fix a typo 2018-10-01 10:41:01 +02:00
options m_config: fix typo in comment 2019-09-19 20:37:05 +02:00
osdep win32: remove -municode from mpv binary 2019-09-19 20:37:05 +02:00
player command, demux: add AB-loop keyframe cache align command 2019-09-19 20:37:05 +02:00
stream stream: add a generic concat implementation 2019-09-19 20:37:05 +02:00
sub sd_lavc: implement --sub-pos for bitmap subtitles 2019-09-19 20:37:04 +02:00
ta ta: introduce talloc_dup() and use it in some places 2018-01-18 01:42:36 -08:00
test misc: add linked list helpers 2018-05-24 19:56:35 +02:00
video vo: fix missed option updates under rare circumstances 2019-09-19 20:37:05 +02:00
waftools win32: remove -municode from mpv binary 2019-09-19 20:37:05 +02:00
.gitignore player: move builtin profiles to a separate file 2016-09-15 14:50:38 +02:00
.travis.yml travis: rework scripts to re-enable macOS 2019-09-02 00:34:49 +03:00
Copyright Copyright: fix missing word 2018-01-31 03:50:22 +01:00
LICENSE.GPL Copyright: some more licensing clarifications 2017-10-13 15:44:55 +02:00
LICENSE.LGPL Copyright: some more licensing clarifications 2017-10-13 15:44:55 +02:00
README.md README: remove old googlegroups mailing list address 2019-09-14 16:40:50 +02:00
RELEASE_NOTES docs: add mentions of the Vulkan rendering abstraction replacement 2019-04-22 15:58:10 +03:00
VERSION Update VERSION 2018-07-22 18:47:16 +02:00
appveyor.yml appveyor: remove broken packages, install libplacebo 2019-07-03 17:30:50 +03:00
bootstrap.py build: add --no-download option to bootstrap.py 2018-08-13 19:09:35 +02:00
mpv_talloc.h
version.sh version.sh: update MPVCOPYRIGHT to include the current year, 2019 2019-04-16 20:11:30 +02:00
wscript build: better POSIX check 2019-09-19 20:37:05 +02:00
wscript_build.py vf_vapourynth: remove Lua backend 2019-09-19 20:37:05 +02:00

README.md

mpv logo

mpv

Overview

mpv is a media player based on MPlayer and mplayer2. It supports a wide variety of video file formats, audio and video codecs, and subtitle types.

Releases can be found on the release list.

System requirements

  • A not too ancient Linux, Windows 7 or later, or OSX 10.8 or later.
  • A somewhat capable CPU. Hardware decoding might help if the CPU is too slow to decode video in realtime, but must be explicitly enabled with the --hwdec option.
  • A not too crappy GPU. mpv is not intended to be used with bad GPUs. There are many caveats with drivers or system compositors causing tearing, stutter, etc. On Windows, you might want to make sure the graphics drivers are current. In some cases, ancient fallback video output methods can help (such as --vo=xv on Linux), but this use is not recommended or supported.

Downloads

For semi-official builds and third-party packages please see mpv.io/installation.

Changelog

There is no complete changelog; however, changes to the player core interface are listed in the interface changelog.

Changes to the C API are documented in the client API changelog.

The release list has a summary of most of the important changes on every release.

Changes to the default key bindings are indicated in restore-old-bindings.conf.

Compilation

Compiling with full features requires development files for several external libraries. Below is a list of some important requirements.

The mpv build system uses waf, but we don't store it in the repository. The ./bootstrap.py script will download the latest version of waf that was tested with the build system.

For a list of the available build options use ./waf configure --help. If you think you have support for some feature installed but configure fails to detect it, the file build/config.log may contain information about the reasons for the failure.

NOTE: To avoid cluttering the output with unreadable spam, --help only shows one of the two switches for each option. If the option is autodetected by default, the --disable-*** switch is printed; if the option is disabled by default, the --enable-*** switch is printed. Either way, you can use --enable-*** or --disable-** regardless of what is printed by --help.

To build the software you can use ./waf build: the result of the compilation will be located in build/mpv. You can use ./waf install to install mpv to the prefix after it is compiled.

Example:

./bootstrap.py
./waf configure
./waf
./waf install

Essential dependencies (incomplete list):

  • gcc or clang
  • X development headers (xlib, xrandr, xext, xscrnsaver, xinerama, libvdpau, libGL, GLX, EGL, xv, ...)
  • Audio output development headers (libasound/ALSA, pulseaudio)
  • FFmpeg libraries (libavutil libavcodec libavformat libswscale libavfilter and either libswresample or libavresample)
  • zlib
  • iconv (normally provided by the system libc)
  • libass (OSD, OSC, text subtitles)
  • Lua (optional, required for the OSC pseudo-GUI and youtube-dl integration)
  • libjpeg (optional, used for screenshots only)
  • uchardet (optional, for subtitle charset detection)
  • vdpau and vaapi libraries for hardware decoding on Linux (optional)

Libass dependencies:

  • gcc or clang, yasm on x86 and x86_64
  • fribidi, freetype, fontconfig development headers (for libass)
  • harfbuzz (optional, required for correct rendering of combining characters, particularly for correct rendering of non-English text on OSX, and Arabic/Indic scripts on any platform)

FFmpeg dependencies:

  • gcc or clang, yasm on x86 and x86_64
  • OpenSSL or GnuTLS (have to be explicitly enabled when compiling FFmpeg)
  • libx264/libmp3lame/libfdk-aac if you want to use encoding (have to be explicitly enabled when compiling FFmpeg)
  • For native DASH playback, FFmpeg needs to be built with --enable-libxml2 (although there are security implications).
  • For good nvidia support on Linux, make sure nv-codec-headers is installed and can be found by configure.
  • Libav support is broken. (See section below.)

Most of the above libraries are available in suitable versions on normal Linux distributions. For ease of compiling the latest git master of everything, you may wish to use the separately available build wrapper (mpv-build) which first compiles FFmpeg libraries and libass, and then compiles the player statically linked against those.

If you want to build a Windows binary, you either have to use MSYS2 and MinGW, or cross-compile from Linux with MinGW. See Windows compilation.

FFmpeg vs. Libav

Generally, mpv should work with the latest release as well as the git version of FFmpeg. Libav support is currently broken, because they did not add certain FFmpeg API changes which mpv relies on.

FFmpeg ABI compatibility

mpv does not support linking against FFmpeg versions it was not built with, even if the linked version is supposedly ABI-compatible with the version it was compiled against. Expect malfunctions, crashes, and security issues if you do it anyway.

The reason for not supporting this is because it creates far too much complexity with little to no benefit, coupled with absurd and unusable FFmpeg API artifacts.

Newer mpv versions will refuse to start if runtime and compile time FFmpeg library versions mismatch.

Release cycle

Every other month, an arbitrary git snapshot is made, and is assigned a 0.X.0 version number. No further maintenance is done.

The goal of releases is to make Linux distributions happy. Linux distributions are also expected to apply their own patches in case of bugs and security issues.

Releases other than the latest release are unsupported and unmaintained.

See the release policy document for more information.

Bug reports

Please use the issue tracker provided by GitHub to send us bug reports or feature requests. Follow the template's instructions or the issue will likely be ignored or closed as invalid.

Using the bug tracker as place for simple questions is fine but IRC is recommended (see Contact below).

Contributing

Please read contribute.md.

For small changes you can just send us pull requests through GitHub. For bigger changes come and talk to us on IRC before you start working on them. It will make code review easier for both parties later on.

You can check the wiki or the issue tracker for ideas on what you could contribute with.

Relation to MPlayer and mplayer2

mpv is a fork of MPlayer. Much has changed, and in general, mpv should be considered a completely new program, rather than a MPlayer drop-in replacement.

For details see FAQ entry.

If you are wondering what's different from mplayer2 and MPlayer, an incomplete and largely unmaintained list of changes is located here.

License

GPLv2 "or later" by default, LGPLv2.1 "or later" with --enable-lgpl. See details.

Contact

Most activity happens on the IRC channel and the github issue tracker.

  • GitHub issue tracker: issue tracker (report bugs here)
  • User IRC Channel: #mpv on irc.freenode.net
  • Developer IRC Channel: #mpv-devel on irc.freenode.net