Command line video player
Go to file
Dudemanguy 37549b6faa build: add version.py for generating version.h
version.h is essential for building, and its generation was done by a
shell script. Strictly speaking, python should in general be more
portable (windows), and would be better for the upcoming meson build to
simply just execute a python script. version.py has some small
differences with version.sh which shouldn't matter but they are noted
below.

- version.sh accepted several arguments that seemed useless (like
  --cwd). These were removed from version.py.
- version.py takes either no arguments (prints the version) or it takes
  exactly one argument specifying the complete path of where the header
  should be generated.
- version.sh attempted to read a file named "snapshot_version". The
  comments noted that this was for "daily tarball snapshots". Such a
  file does not exist in the source tree, and it's not really clear that
  anyone actually uses this. This logic was removed from version.py.
- version.py reads the SOURCE_DATE_EPOCH environment variable. Some
  distros use this for reproducible builds. Technically you could also
  just disable the build date but this is only a couple of extra lines
  and maybe it's prettier than UNKNOWN.
- version.py also doesn't attempt to display timezone information in the
  build date. It only shows UTC time.
2021-11-14 19:13:10 +00:00
.github github/workflows: use xcode 13.1 if image defaults to xcode 13.0 2021-10-21 21:29:08 +03:00
DOCS vo_gpu_next: implement HDR passthrough 2021-11-08 20:57:54 +01:00
TOOLS TOOLS/autocrop.lua: allow hiding OSD messages 2021-07-27 20:32:05 +03:00
audio ao_oss: define PATH_DEV_MIXER as it is an internal define 2021-11-10 17:08:16 +01:00
ci ci/build-freebsd: require OSSv4 AO to be enabled 2021-11-10 17:08:16 +01:00
common recorder: add support for attachments (fonts) 2021-07-08 12:44:06 +03:00
demux osdep: rename MP_UNREACHABLE 2021-11-03 15:15:20 +01:00
etc input.conf: remove redundant comments 2021-09-06 10:16:45 +03:00
filters f_lavfi: replace deprecated avfilter_pad_count 2021-11-05 23:34:20 +01:00
input input: new option: --no-input-builtin-bindings 2021-10-11 22:16:51 +03:00
libmpv
misc osdep: rename MP_UNREACHABLE 2021-11-03 15:15:20 +01:00
options osdep: rename MP_UNREACHABLE 2021-11-03 15:15:20 +01:00
osdep osdep: rename MP_UNREACHABLE 2021-11-03 15:15:20 +01:00
player osdep: rename MP_UNREACHABLE 2021-11-03 15:15:20 +01:00
stream stream/dvbin: remove "full-featured" API includes 2021-09-22 19:48:14 +03:00
sub sub: assert potential pitfall 2021-11-03 14:09:27 +01:00
ta
test command: add secondary-sub-start and secondary-sub-end properties 2021-07-12 21:07:37 +00:00
video egl_helpers: remove EGL_OPENGL_ES3_BIT 2021-11-11 16:51:51 +00:00
waftools build: add check_preprocessor 2021-11-03 14:09:27 +01:00
.editorconfig editorconfig: add initial file/config 2021-10-20 12:26:20 +03:00
.gitignore
Copyright
LICENSE.GPL DOCS: use upstream license files 2021-08-25 15:56:58 +02:00
LICENSE.LGPL DOCS: use upstream license files 2021-08-25 15:56:58 +02:00
README.md waftools/features: add forgotten enable variants for enabled features 2021-09-20 00:43:12 +02:00
RELEASE_NOTES Release 0.34.0 2021-11-01 15:44:39 +01:00
VERSION Update VERSION 2021-11-01 15:46:09 +01:00
appveyor.yml appveyor: use latest build image for fixed MSYS2 installation 2021-02-23 01:38:39 +02:00
bootstrap.py
mpv_talloc.h
version.py build: add version.py for generating version.h 2021-11-14 19:13:10 +00:00
version.sh version.sh: bump copyright year 2021-10-25 10:20:54 -05:00
wscript context_drm_egl: use gbm_surface_create_with_modifiers 2021-11-10 09:57:58 -08:00
wscript_build.py vo_gpu_next: add new libplacebo-based renderer 2021-11-03 14:09: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 or enabled 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 (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.libera.chat
  • Developer IRC Channel: #mpv-devel on irc.libera.chat