Overview
========

This is a collection of scripts to make downloading and building mpv, ffmpeg
and libass easier. ffmpeg and libass get special treatment, because they are
essential, and distribution packages are often too old or too broken.

See below for instructions for building Debian packages.

If you are running Mac OSX and using homebrew we provide homebrew-mpv_, an up
to date formula that compiles mpv with sensible dependencies and defaults for
OSX.

Instructions
============

Make sure git is installed. E.g. on Debian or Ubuntu:

    apt-get install git

Also check that the dependencies listed at the end of this file are
installed.

Checkout the build repo:

    git clone https://github.com/mpv-player/mpv-build.git

    cd mpv-build

Get the ffmpeg, libass and mpv sources with the following command:

    ./update

(This is always needed before doing the first build after the initial checkout,
and can be used to update ffmpeg/libass/mpv later.)

Build mpv and ffmpeg/libass with:

    make clean                        # sometimes needed to build successfully

    make

Install mpv with:

    sudo make install

Or if you don't want debugging symbols (smaller binaries):

    sudo make install-strip

mpv doesn't need to be installed. The binary ./mpv/mpv can be used as-is. Note
that libass and ffmpeg will be statically linked with mpv when using the
provided scripts, and no ffmpeg or libass libraries are/need to be installed.

Dependencies
============

Essential dependencies (incomplete list):

- gcc or clang, yasm, git
- X development headers (xlib, X extensions, vdpau, GL, Xv, ...)
- Audio output development headers (libasound, pulseaudio)
- fribidi, freetype, fontconfig development headers (for libass)
- libjpeg
- libquvi if you want to play Youtube videos directly
- libx264 if you want to use encoding (you have to add --enable-libx264 to
  scripts/ffmpeg-config, because ffmpeg doesn't autodetect this library)

Note: most dependencies are optional and autodetected. If they're missing,
these features will be disabled silently. This includes some dependencies
which could be considered essential.

Installing dependencies on Debian or Ubuntu
===========================================

On Debian or Ubuntu systems, you can try to run this command in the
mpv-build directory to install most of the required dependencies:

    mk-build-deps -s sudo -ir

This will generate and install a dummy package with the required
dependencies. If you don't want to use sudo, you can also try:

    mk-build-deps

    dpkg -i mpv-build-deps_1.0_all.deb

dpkg -i will require root rights of course.

Building a Debian package
=========================

You can build a full mpv Debian package with the following command:

    debuild -uc -us -b -j4

The .deb file will be created in the parent directory. (4 is the number
of jobs running in parallel - you can change it.)

Contact
=======

You can find us on IRC in ``#mpv-player`` on ``irc.freenode.net``

Report bugs to the `issues tracker`_ provided by GitHub to send us bug
reports or feature requests.

.. _issues tracker: https://github.com/mpv-player/mpv/issues
.. _homebrew-mpv: https://github.com/mpv-player/homebrew-mpv