diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 70 |
1 files changed, 27 insertions, 43 deletions
@@ -36,19 +36,26 @@ Releases can be found on the [release list][releases]. ## System requirements -- A not too ancient Linux, Windows 7 or later, or OSX 10.8 or later. +- A not too ancient Linux (usually, only the latest releases of distributions + are actively supported), Windows 10 or later, or macOS 10.15 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, + etc. On such GPUs, it's recommended to use `--profile=fast` for smooth playback. + 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. +mpv does not go out of its way to break on older hardware or old, unsupported +operating systems, but development is not done with them in mind. Keeping +compatibility with such setups is not guaranteed. If things work, consider it +a happy accident. + ## Downloads @@ -73,58 +80,36 @@ Changes to the default key bindings are indicated in Compiling with full features requires development files for several -external libraries. One of the two build systems supported by mpv is required: -[meson](https://mesonbuild.com/index.html) or [waf](https://waf.io/). 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][build-system-differences]. - -### Meson +external libraries. Mpv requires [meson](https://mesonbuild.com/index.html) +to build. Meson can be obtained from your distro or PyPI. -After creating your build directory (e.g. `meson build`), you can view a list +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 build + 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: +For libplacebo, meson can use a git check out as a subproject for a convenient +way to compile mpv if a sufficient libplacebo version is not easily available +in the build environment. It will be statically linked with mpv. Example: - ./bootstrap.py - ./waf configure - ./waf - ./waf install + mkdir -p subprojects + git clone https://code.videolan.org/videolan/libplacebo.git --depth=1 --recursive subprojects/libplacebo Essential dependencies (incomplete list): - gcc or clang -- X development headers (xlib, xrandr, xext, xscrnsaver, xinerama, libvdpau, +- X development headers (xlib, xrandr, xext, xscrnsaver, xpresent, libvdpau, libGL, GLX, EGL, xv, ...) - Audio output development headers (libasound/ALSA, pulseaudio) - FFmpeg libraries (libavutil libavcodec libavformat libswscale libavfilter and either libswresample or libavresample) +- libplacebo - zlib - iconv (normally provided by the system libc) - libass (OSD, OSC, text subtitles) @@ -138,7 +123,7 @@ 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 + for correct rendering of non-English text on macOS, and Arabic/Indic scripts on any platform) FFmpeg dependencies (when building FFmpeg): @@ -166,12 +151,12 @@ or cross-compile from Linux with MinGW. See ## 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. +Once or twice a year, a release is cut off from the current development state +and is assigned a 0.X.0 version number. No further maintenance is done, except +in the event of security issues. 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. +are also expected to apply their own patches in case of bugs. Releases other than the latest release are unsupported and unmaintained. @@ -202,7 +187,7 @@ for ideas on what you could contribute with. ## License -GPLv2 "or later" by default, LGPLv2.1 "or later" with `--enable-lgpl`. +GPLv2 "or later" by default, LGPLv2.1 "or later" with `-Dgpl=false`. See [details.](https://github.com/mpv-player/mpv/blob/master/Copyright) ## History @@ -214,7 +199,7 @@ see the [FAQ][FAQ]. ## Contact -Most activity happens on the IRC channel and the github issue tracker. +Most activity happens on the IRC channel and the GitHub issue tracker. - **GitHub issue tracker**: [issue tracker][issue-tracker] (report bugs here) - **User IRC Channel**: `#mpv` on `irc.libera.chat` @@ -230,4 +215,3 @@ Most activity happens on the IRC channel and the github issue tracker. [api-changes]: https://github.com/mpv-player/mpv/blob/master/DOCS/client-api-changes.rst [restore-old-bindings]: https://github.com/mpv-player/mpv/blob/master/etc/restore-old-bindings.conf [contribute.md]: https://github.com/mpv-player/mpv/blob/master/DOCS/contribute.md -[build-system-differences]: https://github.com/mpv-player/mpv/blob/master/DOCS/build-system-differences.md |