source: x/installing/libva.xml@ 9a6d0d9

<?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-version                "2.18.0">

  <!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        "b597a43395daebf65f23872b67bcd794">
  <!ENTITY libva-size          "496 KB">
  <!ENTITY libva-buildsize     "5.4 MB">
  <!ENTITY libva-time          "less than 0.1 SBU">
]>

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

    <sect2info>
      <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>

      &lfs113_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">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">Recommended (Runtime)</bridgehead>
      <!-- "nodep" to prevent BLFS tool from blindly installing all the
           drivers -->
      <para role='nodep'>
        The VA API driver suitable for the hardware in your system:
        <xref linkend='intel-vaapi-driver'/> (for Intel GPUs provided with
        Haswell CPUs or earlier),
        <xref linkend='intel-media-driver'/> (for Intel GPUs provided with
        Broadwell CPUs or later),
        <xref linkend='mesa'/> (providing the <literal>r600</literal>,
        <literal>raedonsi</literal>, and <literal>nouveau</literal> VA API
        drivers, for the ATI/AMD Raedon HD 2xxx GPUs and later, and
        <ulink url='https://nouveau.freedesktop.org/VideoAcceleration.html'>
supported
        NVIDIA GPUs</ulink>; there is a circular dependency, read the Mesa page
        for information on how to break it)
      </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>

    </sect3>

    <sect3 role="installation">
      <title>Installation of libva</title>
      <!-- libva*.so.2 have been around for a long time...
      <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>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=$XORG_PREFIX --buildtype=release &amp;&amp;
ninja</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>ninja install</userinput></screen>

    </sect3>

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

      <segmentedlist>
        <segtitle>Installed Programs</segtitle>
        <segtitle>Installed Libraries</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>
            $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>