Command line video player
Go to file
Philip Langdale 61e685594d hwdec_vulkan: add Vulkan HW Interop
Vulkan Video Decoding has finally become a reality, as it's now
showing up in shipping drivers, and the ffmpeg support has been
merged.

With that in mind, this change introduces HW interop support for
ffmpeg Vulkan frames. The implementation is functionally complete - it
can display frames produced by hardware decoding, and it can work with
ffmpeg vulkan filters. There are still various caveats due to gaps and
bugs in drivers, so YMMV, as always.

Primary testing has been done on Intel, AMD, and nvidia hardware on
Linux with basic Windows testing on nvidia.

Notable caveats:
* Due to driver bugs, video decoding on nvidia does not work right now,
  unless you use the Vulkan Beta driver. It can be worked around, but
  requires ffmpeg changes that are not considered acceptable to merge.
* Even if those work-arounds are applied, Vulkan filters will not work
  on video that was decoded by Vulkan, due to additional bugs in the
  nvidia drivers. The filters do work correctly on content decoded some
  other way, and then uploaded to Vulkan (eg: Decode with nvdec, upload
  with --vf=format=vulkan)
* Vulkan filters can only be used with drivers that support
  VK_EXT_descriptor_buffer which doesn't include Intel ANV as yet.
  There is an MR outstanding for this.
* When dealing with 1080p content, there may be some visual distortion
  in the bottom lines of frames due to chroma scaling incorporating the
  extra hidden lines at the bottom of the frame (1080p content is
  actually stored as 1088 lines), depending on the hardware/driver
  combination and the scaling algorithm. This cannot be easily
  addressed as the mechanical fix for it violates the Vulkan spec, and
  probably requires a spec change to resolve properly.

All of these caveats will be fixed in either drivers or ffmpeg, and so
will not require mpv changes (unless something unexpected happens)

If you want to run on nvidia with the non-beta drivers, you can this
ffmpeg tree with the work-around patches:

* https://github.com/philipl/FFmpeg/tree/vulkan-nvidia-workarounds
2023-05-28 15:46:05 -07:00
.github ci: switch to lua51 for MSYS build 2023-04-29 19:07:45 +00:00
DOCS hwdec_vulkan: add Vulkan HW Interop 2023-05-28 15:46:05 -07:00
TOOLS TOOLS/docutils-wrapper: handle commands without depfile 2023-03-24 02:18:39 +00:00
audio ao_oss: return actual OSS playing state 2023-05-11 01:53:55 +00:00
ci ci: use auto detection for lua library version for MSYS 2023-04-29 19:07:45 +00:00
common path: simplify "cache" and "state" fallback 2023-05-21 20:11:24 +02:00
demux demux/demux_lavf: pass-through mime_type 2023-05-16 10:46:35 -04:00
etc stream: accept webdav:// and webdavs:// urls 2023-01-31 12:03:41 -05:00
filters hwdec_vulkan: add Vulkan HW Interop 2023-05-28 15:46:05 -07:00
generated wayland: add wp-fractional-scale-v1 support 2023-01-24 00:04:39 +00:00
input options: transition commands from OPT_FLAG to OPT_BOOL 2023-02-21 17:15:17 +00:00
libmpv libmpv: fix file name in documentation 2023-04-11 20:06:42 +00:00
misc charset_conv: fix memory corruption in mp_iconv_to_utf8 2023-04-29 01:37:41 +00:00
options path: let configdir also override "cache" and "state" paths 2023-05-21 20:11:24 +02:00
osdep player: use XDG_CACHE_HOME by default 2023-05-09 20:37:17 +00:00
player player: improve diagnostics around writing watch_later files 2023-05-21 20:11:24 +02:00
stream options: remove explicit initialization of integers to 0 2023-02-21 17:15:17 +00:00
sub sub: fix UPDATE_SUB_HARD for converted and external subtitles 2023-04-29 00:30:15 +00:00
ta ta/README: update link to talloc documentation 2023-01-10 17:06:38 +00:00
test various: fix typos 2023-03-28 19:29:44 +00:00
video hwdec_vulkan: add Vulkan HW Interop 2023-05-28 15:46:05 -07:00
waftools command: add platform property 2023-02-27 17:13:21 +00:00
.editorconfig editorconfig: add initial file/config 2021-10-20 12:26:20 +03:00
.gitignore build: add meson build support 2021-11-14 19:13:10 +00:00
Copyright stream_smb: remove this 2020-03-05 22:00:50 +01:00
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 build: officially deprecate waf 2023-01-15 16:46:11 +00:00
RELEASE_NOTES Release 0.35.0 2022-11-12 14:52:40 +01:00
VERSION Update VERSION 2022-11-12 14:54:19 +01:00
bootstrap.py build: update waf to 2.0.24 2022-09-21 22:51:25 +02:00
meson.build hwdec_vulkan: add Vulkan HW Interop 2023-05-28 15:46:05 -07:00
meson_options.txt hwdec_vulkan: add Vulkan HW Interop 2023-05-28 15:46:05 -07:00
mpv_talloc.h
version.py waf: migrate to version.py 2023-01-28 01:03:12 +00:00
wscript hwdec_vulkan: add Vulkan HW Interop 2023-05-28 15:46:05 -07:00
wscript_build.py hwdec_vulkan: add Vulkan HW Interop 2023-05-28 15:46:05 -07: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. One of the two build systems supported by mpv is required: meson or waf. Meson can be obtained from your distro or PyPI. Waf can be downloaded by using the ./bootstrap.py script. It will get the latest version of waf that was tested with mpv. Some documentation about the differences between the build systems are located in build-system-differences.

Note: Building with waf is considered deprecated and will be removed in the future.

Meson

After creating your build directory (e.g. meson setup build), you can view a list of all the build options via meson configure build. You could also just simply look at the meson_options.txt file. Logs are stored in meson-logs within your build directory.

Example:

meson setup build
meson compile -C build
meson install -C build

Waf

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