Command line video player
Go to file
wm4 c784820454 options: introduce bool option type, use it for --fullscreen
The option code is very old and was added to MPlayer in the early 2000s,
when C99 was still new. MPlayer did not use the "bool" type anywhere,l
and the logical option equivalent to bool, the "flag" option type, used
int, with the convention that only the values 0 and 1 are allowed.

mpv may have hammered many, many additional tentacles to the option
code, but some of the basics never changed, and m_option_type_flag still
uses int. This seems a bit weird, since mpv uses bool for booleans. So
finally introduce an m_option_type_bool. To avoid duplicating too much
code, change the flag code to bool, and "reimplement" m_option_type_flag
on top of m_option_type_bool.

As a "demonstration", change the --fullscreen option to this new type.
Ideally, all options would be changed too bool, and m_option_type_flag
would be removed. But that is a lot of monotonous thankless work, so I'm
not doing it, and making it a painful years long transition.

At the same time, I'm introducing a new concept for option declarations.
Instead of OPT_BOOL(), which define the full m_option struct contents,
there's OPTF_BOOL(), which only takes the option field name itself. The
name is provided via a normal struct field initializer. Other fields
(such as flags) can be provided via designated initializers.

The advantage of this is that we don't need tons of nested vararg
macros. We also don't need to deal with 0-sized varargs being a pain
(and in fact they are not a thing in standard C99 and probably C11).
There is no need to provide a mandatory flags argument either, which is
the reason why so many OPT_ macros are used with a "0" argument. (The
flag argument seems to confuse other developers; they either don't
immediately recognize what it is, and sometimes it's supposed to be the
option's default value.)

Not having to mess with the flag argument in such option macros is also
a reason for the removal of M_OPT_RANGE etc., for the better or worse.

The only place that special-cased the _flag option type was in
command.c; change it to use something effectively very similar that
automatically includes the new _bool option type. Everything else should
be transparent to the change. The fullscreen option change should be
transparent too, as C99 bool is basically an integer type that is
clamped to 0/1 (except in Swift, Swift sucks).
2020-03-14 02:23:38 +01:00
.github github: fix a typo in the contact links info 2020-02-09 13:25:29 +01:00
DOCS DOCS/interface-changes.rst: add note about property notification changes 2020-03-14 01:40:54 +01:00
TOOLS client API: provide ways to finish property changes on file changes 2020-03-07 02:52:10 +01:00
audio options: change how option range min/max is handled 2020-03-13 17:34:46 +01:00
ci ci: remove libsmblient 2020-03-07 13:53:56 +01:00
common player: rearrange libav* library check 2020-03-08 19:38:10 +01:00
demux options: change how option range min/max is handled 2020-03-13 17:34:46 +01:00
etc sws_utils: use zimg by default if available 2020-02-12 18:06:53 +01:00
filters options: change how option range min/max is handled 2020-03-13 17:34:46 +01:00
input ipc: allow sending commands with named arguments 2020-02-24 00:31:46 +01:00
libmpv client API: remove deprecated qthelper.hpp header 2020-03-06 19:37:44 +01:00
misc dispatch: add strange mechanism for making worker threads responsive 2020-03-05 22:00:50 +01:00
options options: introduce bool option type, use it for --fullscreen 2020-03-14 02:23:38 +01:00
osdep options: introduce bool option type, use it for --fullscreen 2020-03-14 02:23:38 +01:00
player options: introduce bool option type, use it for --fullscreen 2020-03-14 02:23:38 +01:00
stream options: change how option range min/max is handled 2020-03-13 17:34:46 +01:00
sub sub: log libass version 2020-03-08 19:38:10 +01:00
ta ta: fix logging of unfreed child allocations 2020-02-29 20:12:31 +01:00
test test: update img_formats.txt 2020-02-29 01:23:20 +01:00
video options: change how option range min/max is handled 2020-03-13 17:34:46 +01:00
waftools build: pick up Lua 5.2 by default 2020-02-29 21:49:14 +01:00
.gitignore
.travis.yml travis: don't send notifications for forks 2020-01-26 12:12:22 +01:00
Copyright stream_smb: remove this 2020-03-05 22:00:50 +01:00
LICENSE.GPL
LICENSE.LGPL
README.md README: fix typo 2019-12-04 16:20:40 +01:00
RELEASE_NOTES Release 0.32.0 2020-01-26 21:31:54 +01:00
VERSION Update VERSION 2020-01-26 21:35:20 +01:00
appveyor.yml appveyor: remove broken packages, install libplacebo 2019-07-03 17:30:50 +03:00
bootstrap.py build: force bootstrap.py to use python3 2019-12-24 12:22:36 +01:00
mpv_talloc.h
version.sh Bump copyright year 2019-12-31 17:10:46 +01:00
wscript build: make C11 atomics mandatory 2020-03-13 13:47:11 +01:00
wscript_build.py options: split m_config.c/h 2020-03-13 16:50:27 +01:00

README.md

mpv logo

mpv

Overview

mpv is a free (as in freedom) media player for the command line. It supports a wide variety of media file formats, audio and video codecs, and subtitle types.

There is a FAQ.

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's focus is not on power-efficient playback on embedded or integrated GPUs (for example, hardware decoding is not even enabled by default). Low power GPUs may cause issues like tearing, stutter, etc. The main video output uses shaders for video rendering and scaling, rather than GPU fixed function hardware. 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)
  • nvdec and vaapi libraries for hardware decoding on Linux (optional)

Libass dependencies (when building libass):

  • 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 (when building FFmpeg):

  • 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, and DASH support has lots of bugs).
  • AV1 decoding support requires dav1d.
  • For good nvidia support on Linux, make sure nv-codec-headers is installed and can be found by configure.

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.

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.

License

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

History

This software is based on the MPlayer project. Before mpv existed as a project, the code base was briefly developed under the mplayer2 project. For details, see the FAQ.

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