source: x/installing/libva.xml@ 99183088

<?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 libva-download-http "https://github.com/intel/libva/releases/download/&libva-version;/libva-&libva-version;.tar.bz2">
  <!ENTITY libva-download-ftp  " ">
  <!ENTITY libva-md5sum        "521be94281beed9ffcb1b2830ccc50fc">
  <!ENTITY libva-size          "472 KB">
  <!ENTITY libva-buildsize     "7.8 MB">
  <!ENTITY libva-time          "less than 0.1 SBU">


  <!ENTITY libva-intel-driver-download-http "https://github.com/intel/intel-vaapi-driver/releases/download/&libva-intel-driver-version;/intel-vaapi-driver-&libva-intel-driver-version;.tar.bz2">
  <!ENTITY libva-intel-driver-download-ftp  " ">
  <!ENTITY libva-intel-driver-md5sum        "073fce0f409559109ad2dd0a6531055d">
  <!ENTITY libva-intel-driver-size          "2.8 MB">
  <!ENTITY libva-intel-driver-buildsize     "97 MB">
  <!ENTITY libva-intel-driver-time          "0.3 SBU">
]>

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

  <sect2info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect2info>

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

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

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

    <para>
       The <application>libva</application> package contains a library which
       provides access to hardware accelerated video processing, using hardware
       to accelerate video processing in order to offload the central
       processing unit (CPU) to decode and encode compressed digital video. The VA
       API video decode/encode interface is platform and window system
       independent targeted at Direct Rendering Infrastructure (DRI) in the X
       Window System however it can potentially also be used with direct
       framebuffer and graphics sub-systems for video output. Accelerated
       processing includes support for video decoding, video encoding,
       subpicture blending, and rendering.
    </para>

    &lfs10_checked;

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

    <bridgehead renderas="sect4">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Intel Driver Download (HTTP): <ulink url="&libva-intel-driver-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Intel Driver Download (FTP): <ulink url="&libva-intel-driver-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Intel Driver Download MD5 sum: &libva-intel-driver-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Intel Driver Download size: &libva-intel-driver-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &libva-intel-driver-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &libva-intel-driver-time;
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect5">Required</bridgehead>
    <para role="required">
      <xref linkend="libdrm"/>
    </para>

    <bridgehead renderas="sect5">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="mesa"/>
    </para>

    <bridgehead renderas="sect5">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>,
      <xref linkend="wayland"/>, and
      <ulink url="https://gitlab.freedesktop.org/drm/igt-gpu-tools">intel-gpu-tools</ulink>
    </para>

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

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

    <caution>
      <para>
        If you are reinstalling this package, you will need 
        to remove the older versions of the libraries.  These are in the
        form of libva*.so.1 and any symbolic links pointing to them.  In
        addition, any packages that use these files need to be rebuilt.
      </para>
    </caution>

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

<screen><userinput>./configure $XORG_CONFIG &amp;&amp;
make</userinput></screen>

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

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

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

  <bridgehead renderas="sect3">Installation of intel-vaapi-driver</bridgehead>

    <para>
      The <application>intel-vaapi-driver</application> is designed
      specifically for video cards based on an Intel GPU.
      Unpack the intel-vaapi tarball:
    </para>

<screen><userinput>tar -xvf ../intel-vaapi-driver-&libva-intel-driver-version;.tar.bz2 &amp;&amp;
cd intel-vaapi-driver-&libva-intel-driver-version;</userinput></screen>

<!-- Fixed in intel-vaapi-driver-2.4.1
    <para>
      Fix building with GCC-10 and above:
    </para>

<screen><userinput>sed -e 's/const/extern &amp;/' \
    -i src/gen9_hevc_enc_kernels_binary.h</userinput></screen>
-->

    <para>
      Install the driver by running the following commands:
    </para>

<screen><userinput>./configure $XORG_CONFIG &amp;&amp;
make</userinput></screen>

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

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

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

  </sect3>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Driver</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libva-drm.so, 
          libva-glx.so, 
          libva.so,
          libva-wayland.so, and 
          libva-x11.so
        </seg>
        <seg>
          i965_drv_video.so
        </seg>
        <seg>
          $XORG_PREFIX/include/va
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libva-lib">
        <term><filename class="libraryfile">libva.so</filename></term>
        <listitem>
          <para>
            contains API functions which provide access to hardware
            accelerated video processing.
          </para>
          <indexterm zone="libva libva-lib">
            <primary sortas="c-libva">libva.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect3>

</sect2>