[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[f6503c73] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY libaom-download-http "https://storage.googleapis.com/aom-releases/libaom-&libaom-version;.tar.gz">
|
---|
| 8 | <!ENTITY libaom-download-ftp " ">
|
---|
[8c70403] | 9 | <!ENTITY libaom-md5sum "f31b72e81dd177396e3553576f6515ef">
|
---|
[9c3f73f] | 10 | <!ENTITY libaom-size "5.3 MB">
|
---|
[8c70403] | 11 | <!ENTITY libaom-buildsize "104 MB (add 1.0 GB for tests)">
|
---|
| 12 | <!ENTITY libaom-time "1.0 SBU (with parallelism=4, add 187 SBU for tests)">
|
---|
[f6503c73] | 13 | ]>
|
---|
| 14 |
|
---|
[76646147] | 15 | <!-- Tests not run for version 3.6.1. -->
|
---|
[9c3f73f] | 16 | <!-- Tests not run for version 3.9.0. -->
|
---|
[76646147] | 17 |
|
---|
[f6503c73] | 18 | <sect1 id="libaom" xreflabel="libaom-&libaom-version;">
|
---|
| 19 | <?dbhtml filename="libaom.html"?>
|
---|
| 20 |
|
---|
| 21 | <title>libaom-&libaom-version;</title>
|
---|
| 22 |
|
---|
| 23 | <indexterm zone="libaom">
|
---|
| 24 | <primary sortas="a-libaom">libaom</primary>
|
---|
| 25 | </indexterm>
|
---|
| 26 |
|
---|
| 27 | <sect2 role="package">
|
---|
| 28 | <title>Introduction to libaom</title>
|
---|
| 29 |
|
---|
| 30 | <para>
|
---|
| 31 | The <application>libaom</application> package contains a reference
|
---|
| 32 | version of the Alliance for Open Media video codec. This codec is a
|
---|
| 33 | patent free alternative to H.265, and is starting to be used throughout
|
---|
| 34 | the internet.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[3c9b5e9] | 37 | &lfs122_checked;
|
---|
[f6503c73] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&libaom-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&libaom-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &libaom-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &libaom-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &libaom-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &libaom-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect3">libaom Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 76 | <para role="recommended">
|
---|
| 77 | <xref linkend="yasm"/>
|
---|
[e75e99bd] | 78 | (or <xref role='nodep' linkend="nasm"/>)
|
---|
[f6503c73] | 79 | </para>
|
---|
| 80 |
|
---|
| 81 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 82 | <para role="optional">
|
---|
| 83 | <xref linkend="doxygen"/>
|
---|
| 84 | </para>
|
---|
| 85 |
|
---|
[b7afa97] | 86 | &test-use-internet;
|
---|
| 87 |
|
---|
[f6503c73] | 88 | </sect2>
|
---|
[e440af5] | 89 |
|
---|
[f6503c73] | 90 | <sect2 role="installation">
|
---|
| 91 | <title>Installation of libaom</title>
|
---|
| 92 |
|
---|
| 93 | <para>
|
---|
| 94 | Install <application>libaom</application> by running the following
|
---|
| 95 | commands:
|
---|
| 96 | </para>
|
---|
| 97 |
|
---|
| 98 | <screen><userinput>mkdir aom-build &&
|
---|
| 99 | cd aom-build &&
|
---|
| 100 |
|
---|
[cbfa153] | 101 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
| 102 | -D CMAKE_BUILD_TYPE=Release \
|
---|
| 103 | -D BUILD_SHARED_LIBS=1 \
|
---|
| 104 | -D ENABLE_DOCS=no \
|
---|
[f6503c73] | 105 | -G Ninja .. &&
|
---|
| 106 | ninja</userinput></screen>
|
---|
| 107 |
|
---|
| 108 | <para>
|
---|
| 109 | To test the results, issue: <command>ninja runtests</command>. Note that
|
---|
| 110 | the tests take an extremely long time to run.
|
---|
| 111 | </para>
|
---|
| 112 |
|
---|
| 113 | <para>
|
---|
| 114 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 115 | </para>
|
---|
| 116 |
|
---|
| 117 | <screen role="root"><userinput>ninja install &&
|
---|
| 118 | rm -v /usr/lib/libaom.a</userinput></screen>
|
---|
| 119 |
|
---|
| 120 | </sect2>
|
---|
| 121 |
|
---|
| 122 | <sect2 role="commands">
|
---|
| 123 | <title>Command Explanations</title>
|
---|
| 124 |
|
---|
| 125 | <para>
|
---|
[cbfa153] | 126 | <parameter>-D BUILD_SHARED_LIBS=1</parameter>: This switch builds shared
|
---|
[f6503c73] | 127 | versions of the libraries.
|
---|
| 128 | </para>
|
---|
[e440af5] | 129 |
|
---|
[f6503c73] | 130 | <para>
|
---|
[cbfa153] | 131 | <parameter>-D ENABLE_DOCS=no</parameter>: This switch disables building
|
---|
[82d463fb] | 132 | the documentation because it fails due to an incompatibility with the
|
---|
[f6503c73] | 133 | latest version of <xref role="nodep" linkend="doxygen"/>.
|
---|
| 134 | </para>
|
---|
| 135 |
|
---|
| 136 | <para>
|
---|
[cbfa153] | 137 | <option>-D ENABLE_NASM=yes</option>: Use this switch if you have both
|
---|
[832e339] | 138 | <xref linkend="yasm"/> and
|
---|
| 139 | <xref role="nodep" linkend="nasm"/> installed and wish to use
|
---|
| 140 | nasm instead of yasm.
|
---|
[f6503c73] | 141 | </para>
|
---|
| 142 | </sect2>
|
---|
| 143 |
|
---|
| 144 | <sect2 role="content">
|
---|
| 145 | <title>Contents</title>
|
---|
| 146 |
|
---|
| 147 | <segmentedlist>
|
---|
| 148 | <segtitle>Installed Programs</segtitle>
|
---|
| 149 | <segtitle>Installed Libraries</segtitle>
|
---|
| 150 | <segtitle>Installed Directories</segtitle>
|
---|
| 151 |
|
---|
| 152 | <seglistitem>
|
---|
| 153 | <seg>
|
---|
| 154 | None
|
---|
| 155 | </seg>
|
---|
| 156 | <seg>
|
---|
| 157 | libaom.so
|
---|
| 158 | </seg>
|
---|
| 159 | <seg>
|
---|
| 160 | /usr/include/aom
|
---|
| 161 | </seg>
|
---|
| 162 | </seglistitem>
|
---|
| 163 | </segmentedlist>
|
---|
| 164 |
|
---|
| 165 | <variablelist>
|
---|
| 166 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 167 | <?dbfo list-presentation="list"?>
|
---|
| 168 | <?dbhtml list-presentation="table"?>
|
---|
| 169 |
|
---|
| 170 | <varlistentry id="libaom-lib">
|
---|
| 171 | <term><filename class="libraryfile">libaom.so</filename></term>
|
---|
| 172 | <listitem>
|
---|
| 173 | <para>
|
---|
| 174 | contains functions that provide a reference implementation of the
|
---|
| 175 | AV1 codec
|
---|
| 176 | </para>
|
---|
| 177 | <indexterm zone="libaom libaom-lib">
|
---|
| 178 | <primary sortas="c-libaom">libaom.so</primary>
|
---|
| 179 | </indexterm>
|
---|
| 180 | </listitem>
|
---|
| 181 | </varlistentry>
|
---|
| 182 | </variablelist>
|
---|
| 183 | </sect2>
|
---|
| 184 | </sect1>
|
---|