glfs/multimedia/videoutils/mpv.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY mpv-download-http "https://github.com/mpv-player/mpv/archive/refs/tags/v&mpv-version;/mpv-&mpv-version;.tar.gz">
  <!ENTITY mpv-download-ftp  " ">
  <!ENTITY mpv-md5sum        "54bd6864cc831f1fee6dee693a0421eb">
  <!ENTITY mpv-size          "3.2 MB">
  <!ENTITY mpv-buildsize     "25 MB">
  <!ENTITY mpv-time          "0.2 SBU (Using parallelism=4)">

]>

<sect1 id="mpv" xreflabel="mpv-&mpv-version;">
  <?dbhtml filename="mpv.html"?>

  <title>mpv-&mpv-version;</title>

  <indexterm zone="mpv">
    <primary sortas="a-mpv">mpv</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to mpv</title>

    <para>
      <application>mpv</application> is a free media player for the
      command line. It supports a wide variety of media file formats,
      audio and video codecs, and subtitle types.
    </para>

    &lfs120_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&mpv-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&mpv-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &mpv-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &mpv-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &mpv-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &mpv-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">mpv Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="alsa"/>,
      <xref linkend="ffmpeg"/>,
      <xref linkend="libass"/>,
      <xref linkend="libplacebo"/>,
      <xref linkend="mesa"/>, and
      <xref linkend="pulseaudio"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libjpeg"/>,
      <xref linkend="libva"/>,
      <xref linkend="libvdpau"/>,
      <xref linkend="lua52"/>,
      <xref linkend="uchardet"/>, and
      <xref linkend="vulkan-loader"/>
    </para>

    <bridgehead renderas="sect4">Optional Input Drivers and Libraries</bridgehead>
    <para role="optional">
      <xref linkend="libdvdcss"/>,
      <xref linkend="libdvdread"/>,
      <xref linkend="libdvdnav"/>, and
      <ulink url="https://www.videolan.org/developers/libbluray.html">libbluray</ulink>
    </para>

    <bridgehead renderas="sect4">Optional Audio Output Drivers and Libraries</bridgehead>
    <para role="optional">
      <xref linkend="pipewire"/>,
      <xref linkend="sdl2"/>,
      <ulink url="https://jackaudio.org/">JACK</ulink>, and
      <ulink url="https://openal.org/">OpenAL</ulink>
    </para>

    <bridgehead renderas="sect4">Optional Video Output Drivers and Libraries</bridgehead>
    <para role="optional">
      <ulink url="https://github.com/cacalabs/libcaca">libcaca</ulink> and
      <ulink url="https://www.svgalib.org/">SVGAlib</ulink>
    </para>

    <bridgehead renderas="sect4">Optional (for documentation)</bridgehead>
    <para role="optional">
      <xref linkend="docutils"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of mpv</title>

      <para>
        Install <application>mpv</application> by running the following
        commands:
      </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dx11=enabled       \
            ..                  &amp;&amp;
ninja</userinput></screen>

      <para>
        This package does not come with a test suite.
      </para>

      <para>
        Now, as the &root; user:
      </para>

<screen role="root"><userinput>ninja install</userinput></screen>

      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
        href="../../xincludes/update-icons-and-desktop.xml"/>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-Dx11=enabled</parameter>: allows linking to the X11 libraries.
    </para>

    <para>
      <option>-Ddvdnav=enabled</option>: enables support for DVD playback.
    </para>

    <para>
      <option>-Dcdda=enabled</option>: enables support for CD Audio.
    </para>

    <para>
      <option>-Dsdl2=enabled</option>: enables the usage of SDL2 for
      audio and video output.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring mpv</title>

    <sect3 id="mpv-config">
      <title>Config Files</title>

      <para>
        <filename>/etc/mpv/*</filename> and
        <filename>~/.config/mpv/*</filename>
      </para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          mpv
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /etc/mpv and
          /usr/share/doc/mpv
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="mpv-prog">
        <term><command>mpv</command></term>
        <listitem>
          <para>
            is the mpv video player
          </para>
          <indexterm zone="mpv mpv-prog">
            <primary sortas="b-mpv">mpv</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>