source: x/installing/libvdpau.xml@ a267452

<?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-download-http "http://people.freedesktop.org/~aplattner/vdpau/libvdpau-&libvdpau-version;.tar.gz">
  <!ENTITY libvdpau-download-ftp  " ">
  <!ENTITY libvdpau-md5sum        "acf68adc8b8ff4f72be6e8679abc284e">
  <!ENTITY libvdpau-size          "476 KB">
  <!ENTITY libvdpau-buildsize     "8.9 MB">
  <!ENTITY libvdpau-time          "0.1 SBU">

  <!ENTITY libvdpau-va-gl-download-http "https://github.com/i-rinat/libvdpau-va-gl/archive/v&libvdpau-va-gl-version;.tar.gz">
  <!ENTITY libvdpau-va-gl-download-ftp  " ">
  <!ENTITY libvdpau-va-gl-md5sum        "09ceb2f75eafccc9b002d35ede0de6a5">
  <!ENTITY libvdpau-va-gl-size          "100 KB">
  <!ENTITY libvdpau-va-gl-buildsize     "4.0 MB">
  <!ENTITY libvdpau-va-gl-time          "less than 0.1 SBU">
]>

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

  <sect2info>
    <othername>$LastChangedBy$</othername>
    <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>

    &lfs75_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">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Libvdpau-va-gl Driver Download (HTTP): <ulink url="&libvdpau-va-gl-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Libvdpau-va-gl Driver Download (FTP): <ulink url="&libvdpau-va-gl-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Libvdpau-va-gl Driver Download MD5 sum: &libvdpau-va-gl-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Libvdpau-va-gl Driver Download size: &libvdpau-va-gl-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &libvdpau-va-gl-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &libvdpau-va-gl-time;
        </para>
      </listitem>
    </itemizedlist>
 
    <note><para>The tarball name for libvdpau-va-gl does not include the 
    file name, although it does expand to libvdpau-va-gl-&libvdpau-va-gl-version;.
    The file should be renamed after downloading:</para>

<screen><command>mv v&libvdpau-va-gl-version;.tar.gz libvdpau-va-gl-&libvdpau-va-gl-version;.tar.gz</command></screen>
    </note>


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

    <bridgehead renderas="sect5">Required</bridgehead>
    <para role="required">
      <xref linkend="xorg7-lib"/> for libvdpau and
      <xref linkend="cmake"/>,
      <xref linkend="ffmpeg"/>,
      <xref linkend="glu"/>, and
      <xref linkend="libva"/> for libvdpau-va-gl
    </para>

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

    <bridgehead renderas="sect5">Runtime Dependency</bridgehead>
    <para role="optional">
      <xref linkend="mesalib"/>
    </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>./configure $XORG_CONFIG &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

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

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

  </sect3>

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

    <para>Libvdpau_va_gl uses OpenGL under the hood to accelerate drawing and 
    scaling and the VA-API (if available) to accelerate video decoding. For now 
    VA-API is available on some Intel chips, and on some AMD video adapters with 
    the help of the libvdpau driver.</para>

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

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

cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$XORG_PREFIX .. &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.  The tests must
      be run from an Xorg environment. 
    </para>

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

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

  </sect3>

  <sect3 role="configuration">
    <title>Configuration</title>

    <para>To allow libvdpau to find libvdpau-va-gl, set an environment variable.
    As the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>echo "export VDPAU_DRIVER=va_gl" >> /etc/profile.d/xorg.sh</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 and libvdpau_va_gl.so
        </seg>
        <seg>
          /usr/include/libvdpau and
          /usr/lib/libvdpau
        </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>