source: x/installing/libvdpau-va-gl.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-va-gl-version       "0.4.0">

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

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

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

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

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

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

      <para>
        The <application>libvdpau-va-gl</application> package contains a library
        which implements the VDPAU library.  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>

      &lfs112_checked;

      <bridgehead renderas="sect4">Package Information</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>

      <bridgehead renderas="sect4">libvdpau-va-gl Dependencies</bridgehead>

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="cmake"/>,
        <xref linkend="libvdpau"/>, and
        <xref linkend="libva"/>
      </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-va-gl</title>

      <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_va_gl.so
          </seg>
          <seg>
            None
          </seg>
        </seglistitem>
      </segmentedlist>

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

        <varlistentry id="libvdpau-va-gl-lib">
          <term><filename class="libraryfile">libvdpau_va_gl.so</filename></term>
          <listitem>
            <para>
              contains functions to implement the OpenGL backend to
              the VDPAU (Video Decode and Presentation API for Unix) API
            </para>
            <indexterm zone="libvdpau-va-gl libvdpau-va-gl-lib">
              <primary sortas="c-libvdpau-va-gl">libvdpau.so</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>