source: multimedia/libdriv/libaom.xml@ 3ff7901

<?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 libaom-download-http "https://storage.googleapis.com/aom-releases/libaom-&libaom-version;.tar.gz">
  <!ENTITY libaom-download-ftp  " ">
  <!ENTITY libaom-md5sum        "26fd53c63898211c4f13ffab1e807617">
  <!ENTITY libaom-size          "5.1 MB">
  <!ENTITY libaom-buildsize     "111 MB (add 998 MB for tests)">
  <!ENTITY libaom-time          "1.2 SBU (with parallelism=4, add 187 SBU for tests)">

]>

<!-- Tests not run for version 3.6.1. -->

<sect1 id="libaom" xreflabel="libaom-&libaom-version;">
  <?dbhtml filename="libaom.html"?>

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

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

  <sect2 role="package">
    <title>Introduction to libaom</title>

    <para>
      The <application>libaom</application> package contains a reference
      version of the Alliance for Open Media video codec. This codec is a
      patent free alternative to H.265, and is starting to be used throughout
      the internet.
    </para>

    &lfs120_checked;

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

    <bridgehead renderas="sect3">libaom Dependencies</bridgehead>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="yasm"/>
      (or <xref role='nodep' linkend="nasm"/>, pass the
      <option>-DENABLE_NASM=yes</option> option to <command>cmake</command>
      if you want to use it instead of yasm)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>
    </para>

    &test-use-internet;

  </sect2>

  <sect2 role="installation">
    <title>Installation of libaom</title>

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

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

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_SHARED_LIBS=1       \
      -DENABLE_DOCS=no            \
      -G Ninja .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja runtests</command>. Note that
      the tests take an extremely long time to run.
    </para>

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

<screen role="root"><userinput>ninja install &amp;&amp;
rm -v /usr/lib/libaom.a</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DBUILD_SHARED_LIBS=1</parameter>: This switch builds shared
      versions of the libraries.
    </para>

    <para>
      <parameter>-DENABLE_DOCS=no</parameter>: This switch disables building
      the documentation because it fails due to an incompatibility with the
      latest version of <xref role="nodep" linkend="doxygen"/>.
    </para>

    <para>
      <option>-DENABLE_NASM=yes</option>: Use this switch if you have
      <xref role="nodep" linkend="nasm"/> installed and wish to use it instead
      of yasm.
    </para>
  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libaom.so
        </seg>
        <seg>
          /usr/include/aom
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libaom-lib">
        <term><filename class="libraryfile">libaom.so</filename></term>
        <listitem>
          <para>
            contains functions that provide a reference implementation of the
            AV1 codec
          </para>
          <indexterm zone="libaom libaom-lib">
            <primary sortas="c-libaom">libaom.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>