1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 libavif-download-http "https://github.com/AOMediaCodec/libavif/archive/v&libavif-version;/libavif-&libavif-version;.tar.gz">
|
---|
8 | <!ENTITY libavif-download-ftp " ">
|
---|
9 | <!ENTITY libavif-md5sum "633c2113d52aecab5f0073da3456e2ae">
|
---|
10 | <!ENTITY libavif-size "13 MB">
|
---|
11 | <!ENTITY libavif-buildsize "21 MB">
|
---|
12 | <!ENTITY libavif-time "less than 0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="libavif" xreflabel="libavif-&libavif-version;">
|
---|
16 | <?dbhtml filename="libavif.html"?>
|
---|
17 |
|
---|
18 | <title>libavif-&libavif-version;</title>
|
---|
19 |
|
---|
20 | <indexterm zone="libavif">
|
---|
21 | <primary sortas="a-libavif">libavif</primary>
|
---|
22 | </indexterm>
|
---|
23 |
|
---|
24 | <sect2 role="package">
|
---|
25 | <title>Introduction to libavif</title>
|
---|
26 |
|
---|
27 | <para>
|
---|
28 | The <application>libavif</application> package contains a library used
|
---|
29 | for encoding and decoding AVIF files.
|
---|
30 | </para>
|
---|
31 |
|
---|
32 | &lfs122_checked;
|
---|
33 |
|
---|
34 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
35 | <itemizedlist spacing="compact">
|
---|
36 | <listitem>
|
---|
37 | <para>
|
---|
38 | Download (HTTP): <ulink url="&libavif-download-http;"/>
|
---|
39 | </para>
|
---|
40 | </listitem>
|
---|
41 | <listitem>
|
---|
42 | <para>
|
---|
43 | Download (FTP): <ulink url="&libavif-download-ftp;"/>
|
---|
44 | </para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>
|
---|
48 | Download MD5 sum: &libavif-md5sum;
|
---|
49 | </para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>
|
---|
53 | Download size: &libavif-size;
|
---|
54 | </para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>
|
---|
58 | Estimated disk space required: &libavif-buildsize;
|
---|
59 | </para>
|
---|
60 | </listitem>
|
---|
61 | <listitem>
|
---|
62 | <para>
|
---|
63 | Estimated build time: &libavif-time;
|
---|
64 | </para>
|
---|
65 | </listitem>
|
---|
66 | </itemizedlist>
|
---|
67 |
|
---|
68 | <bridgehead renderas="sect3">libavif Dependencies</bridgehead>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
71 | <para role="required">
|
---|
72 | <xref linkend="libaom"/>
|
---|
73 | </para>
|
---|
74 |
|
---|
75 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
76 | <para role="recommended">
|
---|
77 | <xref linkend="gdk-pixbuf"/>
|
---|
78 | </para>
|
---|
79 |
|
---|
80 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
81 | <para role="optional">
|
---|
82 | <ulink url="https://github.com/google/googletest">gtest</ulink>,
|
---|
83 | <ulink url="https://code.videolan.org/videolan/dav1d">libdav1d</ulink>,
|
---|
84 | <ulink url="https://chromium.googlesource.com/libyuv/libyuv/">libyuv</ulink>,
|
---|
85 | <ulink url="https://github.com/xiph/rav1e">rav1e</ulink>, and
|
---|
86 | <ulink url="https://gitlab.com/AOMediaCodec/SVT-AV1">svt-av1</ulink>
|
---|
87 | </para>
|
---|
88 |
|
---|
89 | &test-use-internet;
|
---|
90 |
|
---|
91 | </sect2>
|
---|
92 |
|
---|
93 | <sect2 role="installation">
|
---|
94 | <title>Installation of libavif</title>
|
---|
95 |
|
---|
96 | <para>
|
---|
97 | Install <application>libavif</application> by running the following
|
---|
98 | commands:
|
---|
99 | </para>
|
---|
100 |
|
---|
101 | <screen><userinput>mkdir build &&
|
---|
102 | cd build &&
|
---|
103 |
|
---|
104 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
105 | -D CMAKE_BUILD_TYPE=Release \
|
---|
106 | -D AVIF_CODEC_AOM=SYSTEM \
|
---|
107 | -D AVIF_BUILD_GDK_PIXBUF=ON \
|
---|
108 | -D AVIF_LIBYUV=OFF \
|
---|
109 | -G Ninja .. &&
|
---|
110 | ninja</userinput></screen>
|
---|
111 |
|
---|
112 | <para>
|
---|
113 | To test the package (note that it will cause the building system to
|
---|
114 | download a copy of
|
---|
115 | <ulink url="https://github.com/google/googletest">gtest</ulink> and
|
---|
116 | build the test suite with the copy), issue:
|
---|
117 | </para>
|
---|
118 |
|
---|
119 | <screen remap='test'><userinput>cmake .. -D AVIF_GTEST=LOCAL -D AVIF_BUILD_TESTS=ON &&
|
---|
120 | ninja && ninja test</userinput></screen>
|
---|
121 |
|
---|
122 | <para>
|
---|
123 | Now, as the &root; user:
|
---|
124 | </para>
|
---|
125 |
|
---|
126 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
127 |
|
---|
128 | <para>
|
---|
129 | The AV1 format needs to be added to the loaders cache. As the
|
---|
130 | &root; user:
|
---|
131 | </para>
|
---|
132 |
|
---|
133 | <screen role="root"><userinput>gdk-pixbuf-query-loaders --update-cache</userinput></screen>
|
---|
134 |
|
---|
135 | </sect2>
|
---|
136 |
|
---|
137 | <sect2 role="commands">
|
---|
138 | <title>Command Explanations</title>
|
---|
139 |
|
---|
140 | <para>
|
---|
141 | <parameter>-D AVIF_CODEC_AOM=SYSTEM</parameter>: This switch enables using
|
---|
142 | the AOM codec. This package is useless without at least one codec
|
---|
143 | built in.
|
---|
144 | </para>
|
---|
145 |
|
---|
146 | <para>
|
---|
147 | <parameter>-D AVIF_BUILD_GDK_PIXBUF=ON</parameter>: This switch builds
|
---|
148 | the AVIF loader for applications which use gdk-pixbuf. Remove it if you
|
---|
149 | have not installed <xref role="nodep" linkend="gdk-pixbuf"/>.
|
---|
150 | </para>
|
---|
151 |
|
---|
152 | <para>
|
---|
153 | <option>-D AVIF_LIBYUV=OFF</option>: Use this switch if you have
|
---|
154 | not installed
|
---|
155 | <ulink url="https://chromium.googlesource.com/libyuv/libyuv/">libyuv</ulink>.
|
---|
156 | </para>
|
---|
157 |
|
---|
158 | <para>
|
---|
159 | <option>-D AVIF_CODEC_DAV1D=SYSTEM</option>: Use this switch if you have
|
---|
160 | installed <ulink url="https://code.videolan.org/videolan/dav1d">libdav1d</ulink>
|
---|
161 | and wish to use it as a codec.
|
---|
162 | </para>
|
---|
163 |
|
---|
164 | <para>
|
---|
165 | <option>-D AVIF_CODEC_RAV1E=SYSTEM</option>: Use this switch if you have
|
---|
166 | installed <ulink url="https://github.com/xiph/rav1e">rav1e</ulink> and
|
---|
167 | wish to use it as a codec.
|
---|
168 | </para>
|
---|
169 |
|
---|
170 | <para>
|
---|
171 | <option>-D AVIF_CODEC_SVT=SYSTEM</option>: Use this switch if you have
|
---|
172 | installed <ulink url="https://gitlab.com/AOMediaCodec/SVT-AV1">svt-av1</ulink>
|
---|
173 | and wish to use it as a codec.
|
---|
174 | </para>
|
---|
175 |
|
---|
176 | </sect2>
|
---|
177 |
|
---|
178 | <sect2 role="content">
|
---|
179 | <title>Contents</title>
|
---|
180 |
|
---|
181 | <segmentedlist>
|
---|
182 | <segtitle>Installed Programs</segtitle>
|
---|
183 | <segtitle>Installed Libraries</segtitle>
|
---|
184 | <segtitle>Installed Directories</segtitle>
|
---|
185 |
|
---|
186 | <seglistitem>
|
---|
187 | <seg>
|
---|
188 | None
|
---|
189 | </seg>
|
---|
190 | <seg>
|
---|
191 | libavif.so and
|
---|
192 | libpixbbufloader-avif.so (in /usr/lib/gdk-pixbuf-2.0/2.10.0/loaders)
|
---|
193 | </seg>
|
---|
194 | <seg>
|
---|
195 | /usr/include/avif and
|
---|
196 | /usr/lib/cmake/libavif
|
---|
197 | </seg>
|
---|
198 | </seglistitem>
|
---|
199 | </segmentedlist>
|
---|
200 |
|
---|
201 | <variablelist>
|
---|
202 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
203 | <?dbfo list-presentation="list"?>
|
---|
204 | <?dbhtml list-presentation="table"?>
|
---|
205 |
|
---|
206 | <varlistentry id="libavif-lib">
|
---|
207 | <term><filename class="libraryfile">libavif.so</filename></term>
|
---|
208 | <listitem>
|
---|
209 | <para>
|
---|
210 | contains functions that provide a portable C implementation of the
|
---|
211 | AV1 Image Format
|
---|
212 | </para>
|
---|
213 | <indexterm zone="libavif-lib libavif">
|
---|
214 | <primary sortas="c-libavif">libavif.so</primary>
|
---|
215 | </indexterm>
|
---|
216 | </listitem>
|
---|
217 | </varlistentry>
|
---|
218 |
|
---|
219 | <varlistentry id="libpixbufloader-avif">
|
---|
220 | <term><filename class="libraryfile">libpixbufloader-avif.so</filename></term>
|
---|
221 | <listitem>
|
---|
222 | <para>
|
---|
223 | allows applications which use gdk-pixbuf to read AVIF images
|
---|
224 | </para>
|
---|
225 | <indexterm zone="libavif libpixbufloader-avif">
|
---|
226 | <primary sortas="c-libpixbufloader-avif">libpixbufloader-avif.so</primary>
|
---|
227 | </indexterm>
|
---|
228 | </listitem>
|
---|
229 | </varlistentry>
|
---|
230 | </variablelist>
|
---|
231 | </sect2>
|
---|
232 | </sect1>
|
---|