source: general/graphlib/libjxl.xml@ e202579

trunk
Last change on this file since e202579 was 3c9b5e9, checked in by Douglas R. Reno <renodr@…>, 4 weeks ago

Tag GTK+-3 and printing stack
  • Property mode set to 100644
File size: 10.7 KB
Line 
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 libjxl-download-http "https://github.com/libjxl/libjxl/archive/v&libjxl-version;/libjxl-&libjxl-version;.tar.gz">
8 <!ENTITY libjxl-md5sum "0fd3db8956a41d13b5e8eac4fe61d8d3">
9 <!ENTITY libjxl-size "1.8 MB">
10 <!ENTITY libjxl-buildsize "42 MB">
11 <!ENTITY libjxl-time "0.6 SBU (with parallelism=4)">
12
13]>
14
15<sect1 id="libjxl" xreflabel="libjxl-&libjxl-version;">
16 <?dbhtml filename="libjxl.html"?>
17
18 <title>libjxl-&libjxl-version;</title>
19
20 <indexterm zone="libjxl">
21 <primary sortas="a-libjxl">libjxl</primary>
22 </indexterm>
23
24 <sect2 role="package">
25 <title>Introduction to libjxl</title>
26
27 <para>
28 The <application>libjxl</application> package contains the reference
29 implementation of the JPEG XL image format.
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="&libjxl-download-http;"/>
39 </para>
40 </listitem>
41 <listitem>
42 <para>
43 Download MD5 sum: &libjxl-md5sum;
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download size: &libjxl-size;
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Estimated disk space required: &libjxl-buildsize;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Estimated build time: &libjxl-time;
59 </para>
60 </listitem>
61 </itemizedlist>
62
63 <bridgehead renderas="sect3">libjxl Dependencies</bridgehead>
64
65 <bridgehead renderas="sect4">Required</bridgehead>
66 <para role="required">
67 <xref linkend="brotli"/>,
68 <xref linkend="cmake"/>,
69 <xref linkend="giflib"/>,
70 <xref linkend="highway"/>,
71 <xref linkend="lcms2"/>,
72 <xref linkend="libjpeg"/>, and
73 <xref linkend="libpng"/>
74 </para>
75
76 <bridgehead renderas="sect4">Recommended</bridgehead>
77 <para role="recommended">
78 <xref linkend="gdk-pixbuf"/> (for the plugin)
79 </para>
80
81 <bridgehead renderas="sect4">Optional</bridgehead>
82 <para role="optional">
83 <xref linkend="doxygen"/> and <xref linkend="graphviz"/>
84 (for documentation),
85 <!--<xref linkend="gimp"/> (for the plugin),-->
86 <xref linkend="java"/> (for the JAR),
87 <xref linkend="libavif"/>,
88 <xref linkend="libwebp"/>,
89 <ulink url="https://github.com/google/googletest">gtest</ulink>,
90 <ulink url="https://www.openexr.com/">OpenEXR</ulink>,
91 <ulink url="https://github.com/webmproject/sjpeg">sjpeg</ulink>, and
92 <ulink url="https://skia.googlesource.com/skcms/">skcms</ulink>
93 </para>
94
95 </sect2>
96
97 <sect2 role="installation">
98 <title>Installation of libjxl</title>
99
100 <para>
101 Install <application>libjxl</application> by running the following
102 commands:
103 </para>
104
105<screen><userinput>mkdir build &amp;&amp;
106cd build &amp;&amp;
107
108cmake -D CMAKE_INSTALL_PREFIX=/usr \
109 -D CMAKE_BUILD_TYPE=Release \
110 -D BUILD_TESTING=OFF \
111 -D BUILD_SHARED_LIBS=ON \
112 -D JPEGXL_ENABLE_SKCMS=OFF \
113 -D JPEGXL_ENABLE_SJPEG=OFF \
114 -D JPEGXL_ENABLE_PLUGINS=ON \
115 -D JPEGXL_INSTALL_JARDIR=/usr/share/java \
116 -G Ninja .. &amp;&amp;
117ninja</userinput></screen>
118
119 <para>
120 This package does come with a test suite, but it requires
121 <ulink url="https://github.com/google/googletest">gtest</ulink>, which
122 is not in BLFS.
123 </para>
124
125 <para>
126 Now, as the &root; user:
127 </para>
128
129<screen role="root"><userinput>ninja install &amp;&amp;
130gdk-pixbuf-query-loaders --update-cache</userinput></screen>
131
132 </sect2>
133
134 <sect2 role="commands">
135 <title>Command Explanations</title>
136
137 <para>
138 <command>gdk-pixbuf-query-loaders --update-cache</command>: This command
139 regenerates the <application>GDK Pixbuf</application> loader cache so
140 that it is aware of the JPEG-XL loader.
141 </para>
142
143 <para>
144 <parameter>-D BUILD_TESTING=OFF</parameter>: This parameter disables the
145 tests because they require
146 <ulink url="https://github.com/google/googletest">gtest</ulink>, which
147 is not in BLFS. If you wish to run the tests and have
148 <ulink url="https://github.com/google/googletest">gtest</ulink> installed,
149 remove this parameter.
150 </para>
151
152 <para>
153 <parameter>-D BUILD_SHARED_LIBS=ON</parameter>: This parameter enables
154 building shared versions of the libraries instead of static ones.
155 </para>
156
157 <para>
158 <parameter>-D JPEGXL_ENABLE_SKCMS=OFF</parameter>: This parameter disables
159 building support for Skia's <application>skcms</application> since it is
160 not necessary for BLFS purposes and requires
161 <ulink url="https://skia.googlesource.com/skcms/">skcms</ulink>.
162 </para>
163
164 <para>
165 <parameter>-D JPEGXL_ENABLE_SJPEG=OFF</parameter>: This parameter disables
166 support for SimpleJPEG since it is not necessary for BLFS purposes and
167 requires <ulink url="https://github.com/webmproject/sjpeg">sjpeg</ulink>.
168 </para>
169
170 <para>
171 <parameter>-D JPEGXL_ENABLE_PLUGINS=ON</parameter>: This parameter enables
172 Plugin support, which creates plugins for <!--<xref linkend="gimp"/> and-->
173 <xref linkend="gdk-pixbuf"/> if the package is installed.
174 </para>
175
176 <para>
177 <parameter>-D JPEGXL_INSTALL_JARDIR=/usr/share/java</parameter>: This
178 parameter places the JAR file for JPEG XL support in the correct
179 directory if <xref linkend="java"/> is installed.
180 </para>
181
182 </sect2>
183
184 <sect2 role="content">
185 <title>Contents</title>
186
187 <segmentedlist>
188 <segtitle>Installed Programs</segtitle>
189 <segtitle>Installed Libraries</segtitle>
190 <segtitle>Installed Directories</segtitle>
191
192 <seglistitem>
193 <seg>
194 benchmark_xl,
195 cjxl,
196 djxl, and
197 jxlinfo
198 </seg>
199 <seg>
200 libjxl.so,
201 libjxl_cms.so,
202 libjxl_extras_codec.so,
203 libjxl_jni.so,
204 libjxl_threads.so, and
205 libpixbufloader-jxl.so (in /usr/lib/gdk-pixbuf-2.0/2.10.0/loaders)
206 </seg>
207 <seg>
208 /usr/include/jxl
209 </seg>
210 </seglistitem>
211 </segmentedlist>
212
213 <variablelist>
214 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
215 <?dbfo list-presentation="list"?>
216 <?dbhtml list-presentation="table"?>
217
218 <varlistentry id="benchmark_xl">
219 <term><command>benchmark_xl</command></term>
220 <listitem>
221 <para>
222 runs performance benchmarks against libjxl
223 </para>
224 <indexterm zone="libjxl benchmark_xl">
225 <primary sortas="b-benchmark_xl">benchmark_xl</primary>
226 </indexterm>
227 </listitem>
228 </varlistentry>
229
230 <varlistentry id="cjxl">
231 <term><command>cjxl</command></term>
232 <listitem>
233 <para>
234 compresses images into JPEG XL format
235 </para>
236 <indexterm zone="libjxl cjxl">
237 <primary sortas="b-cjxl">cjxl</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="djxl">
243 <term><command>djxl</command></term>
244 <listitem>
245 <para>
246 decompresses images from JPEG XL format into other formats
247 </para>
248 <indexterm zone="libjxl djxl">
249 <primary sortas="b-djxl">djxl</primary>
250 </indexterm>
251 </listitem>
252 </varlistentry>
253
254 <varlistentry id="jxlinfo">
255 <term><command>jxlinfo</command></term>
256 <listitem>
257 <para>
258 displays information about JPEG XL images
259 </para>
260 <indexterm zone="libjxl jxlinfo">
261 <primary sortas="b-jxlinfo">jxlinfo</primary>
262 </indexterm>
263 </listitem>
264 </varlistentry>
265
266 <varlistentry id="libjxl-lib">
267 <term><filename class="libraryfile">libjxl.so</filename></term>
268 <listitem>
269 <para>
270 contains the reference implementation of the JPEG XL standard
271 </para>
272 <indexterm zone="libjxl libjxl-lib">
273 <primary sortas="c-libjxl">libjxl.so</primary>
274 </indexterm>
275 </listitem>
276 </varlistentry>
277
278 <varlistentry id="libjxl_cms">
279 <term><filename class="libraryfile">libjxl_cms.so</filename></term>
280 <listitem>
281 <para>
282 contains support for Little CMS in libjxl
283 </para>
284 <indexterm zone="libjxl libjxl_cms">
285 <primary sortas="c-libjxl_cms">libjxl_cms.so</primary>
286 </indexterm>
287 </listitem>
288 </varlistentry>
289
290 <varlistentry id="libjxl_extras_codec">
291 <term><filename class="libraryfile">libjxl_extras_codec.so</filename></term>
292 <listitem>
293 <para>
294 contains additional codec support for JPEG XL images
295 </para>
296 <indexterm zone="libjxl libjxl_extras_codec">
297 <primary sortas="c-libjxl_extras_codec">libjxl_extras_codec.so</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301
302 <varlistentry id="libjxl_jni">
303 <term><filename class="libraryfile">libjxl_jni.so</filename></term>
304 <listitem>
305 <para>
306 contains a Java interface to support JPEG XL on systems where
307 <xref linkend="java"/> was installed at build time
308 </para>
309 <indexterm zone="libjxl libjxl_jni">
310 <primary sortas="c-libjxl_jni">libjxl_jni.so</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="libjxl_threads">
316 <term><filename class="libraryfile">libjxl_threads.so</filename></term>
317 <listitem>
318 <para>
319 contains threading functions for JPEG XL
320 </para>
321 <indexterm zone="libjxl libjxl_threads">
322 <primary sortas="c-libjxl_threads">libjxl_threads.so</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="libpixbufloader-jxl">
328 <term><filename class="libraryfile">libpixbufloader-jxl.so</filename></term>
329 <listitem>
330 <para>
331 contains a loader for gdk-pixbuf to allow it to load JPEG XL images
332 </para>
333 <indexterm zone="libjxl libpixbufloader-jxl">
334 <primary sortas="c-libpixbufloader-jxl">libpixbufloader-jxl.so</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338 </variablelist>
339 </sect2>
340</sect1>
Note: See TracBrowser for help on using the repository browser.