source: x/installing/libvdpau.xml@ e5324803

<?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 libvdpau-version        "1.5">

  <!ENTITY libvdpau-download-http "https://gitlab.freedesktop.org/vdpau/libvdpau/-/archive/&libvdpau-version;/libvdpau-&libvdpau-version;.tar.bz2">
  <!ENTITY libvdpau-download-ftp  " ">
  <!ENTITY libvdpau-md5sum        "148a192110e7a49d62c0bf9ef916c099">
  <!ENTITY libvdpau-size          "140 KB">
  <!ENTITY libvdpau-buildsize     "4.6 MB (with tests)">
  <!ENTITY libvdpau-time          "less than 0.1 SBU (with tests)">
]>

  <sect2 id="libvdpau" xreflabel="libvdpau-&libvdpau-version;">

    <sect2info>
      <date>$Date$</date>
    </sect2info>

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

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

    <sect3 role="package">
      <title>Introduction to libvdpau</title>

      <para>
        The <application>libvdpau</application> package contains a library which
        implements the VDPAU library.
      </para>

      <para>
        VDPAU (Video Decode and Presentation API for Unix) is an open source
        library (libvdpau) and API originally designed by Nvidia for its GeForce
        8 series and later GPU hardware targeted at the X Window System.
        This VDPAU API allows video programs to offload portions of the video
        decoding process and video post-processing to the GPU video-hardware.
     </para>

     <para>
        Currently, the portions capable of being offloaded by VDPAU onto the GPU
        are motion compensation (mo comp), inverse discrete cosine transform
        (iDCT), VLD (variable-length decoding) and deblocking for MPEG-1, MPEG-2,
        MPEG-4 ASP (MPEG-4 Part 2), H.264/MPEG-4 AVC and VC-1, WMV3/WMV9 encoded
        videos.  Which specific codecs of these that can be offloaded to the
        GPU depends on the version of the GPU hardware; specifically,
        to also decode MPEG-4 ASP (MPEG-4 Part 2), Xvid/OpenDivX (DivX 4), and
        DivX 5 formats, a GeForce 200M (2xxM) Series (the eleventh generation of
        Nvidia's GeForce graphics processing units) or newer GPU hardware is
        required.
      </para>

      &lfs112_checked;

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

      <bridgehead renderas="sect4">libvdpau Dependencies</bridgehead>

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="xorg7-lib"/>
      </para>

      <bridgehead renderas="sect5">Optional</bridgehead>
      <para role="optional">
        <xref linkend="doxygen"/>,
        <xref linkend="graphviz"/>, and
        <xref linkend="texlive"/> or <xref linkend="tl-installer"/>
      </para>

      <bridgehead renderas="sect5">Runtime Dependency</bridgehead>
      <para role="optional">
        <xref role="runtime" linkend="mesa"/>
      </para>

      <para condition="html" role="usernotes">
        User Notes: <ulink url="&blfs-wiki;/libvdpau"/>
      </para>
    </sect3>

    <sect3 role="installation">
      <title>Installation of libvdpau</title>

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

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

meson --prefix=$XORG_PREFIX .. &amp;&amp;
ninja</userinput></screen>

      <para>
        To test the results, issue: <command>ninja test</command>.
        There is only one test for this package, dlclose, and it is known to
        fail on some systems.
      </para>

      <para>
        Now, as the <systemitem class="username">root</systemitem> user:
      </para>

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

      <para>
        If <application>doxygen</application> is present at build time
        place the documentation in a versioned directory as the
        <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>[ -e $XORG_PREFIX/share/doc/libvdpau ] &amp;&amp; mv -v $XORG_PREFIX/share/doc/libvdpau{,&libvdpau-version;}</userinput></screen>

    </sect3>

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

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

        <seglistitem>
          <seg>
            None
          </seg>
          <seg>
            libvdpau.so
          </seg>
          <seg>
            $XORG_PREFIX/{include,lib}/vdpau
          </seg>
        </seglistitem>
      </segmentedlist>

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

        <varlistentry id="libvdpau-lib">
          <term><filename class="libraryfile">libvdpau.so</filename></term>
          <listitem>
            <para>
              contains functions to offload portions of the video decoding
              process and video post-processing to the GPU video-hardware
            </para>
            <indexterm zone="libvdpau libvdpau-lib">
              <primary sortas="c-libvdpau">libvdpau.so</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>