source: general/graphlib/libjxl.xml@ ee1941d

lazarus trunk
Last change on this file since ee1941d was 07cb2c5, checked in by Douglas R. Reno <renodr@…>, 2 months ago

Add libjxl to the book

This is in support of gnome-backgrounds and adds functionality to
several other packages in the book
  • Property mode set to 100644
File size: 10.5 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/refs/tags/v&libjxl-version;/libjxl-&libjxl-version;.tar.gz">
8 <!ENTITY libjxl-md5sum "e383b622cb2caef4dfcc8047f5a0fe72">
9 <!ENTITY libjxl-size "1.8 MB">
10 <!ENTITY libjxl-buildsize "53 MB">
11 <!ENTITY libjxl-time "0.8 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 &lfs121_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://www.openexr.com/">OpenEXR</ulink>
90 </para>
91
92 </sect2>
93
94 <sect2 role="installation">
95 <title>Installation of libjxl</title>
96
97 <para>
98 Install <application>libjxl</application> by running the following
99 commands:
100 </para>
101
102<screen><userinput>mkdir build &amp;&amp;
103cd build &amp;&amp;
104
105cmake -D CMAKE_INSTALL_PREFIX=/usr \
106 -D CMAKE_BUILD_TYPE=Release \
107 -D BUILD_TESTING=OFF \
108 -D BUILD_SHARED_LIBS=ON \
109 -D JPEGXL_ENABLE_SKCMS=OFF \
110 -D JPEGXL_ENABLE_SJPEG=OFF \
111 -D JPEGXL_ENABLE_PLUGINS=ON \
112 -D JPEGXL_INSTALL_JARDIR=/usr/share/java \
113 -G Ninja .. &amp;&amp;
114ninja</userinput></screen>
115
116 <para>
117 This package does come with a test suite, but it requires
118 <ulink url="https://github.com/google/googletest">gtest</ulink>, which
119 is not in BLFS.
120 </para>
121
122 <para>
123 Now, as the &root; user:
124 </para>
125
126<screen role="root"><userinput>ninja install &amp;&amp;
127gdk-pixbuf-query-loaders --update-cache</userinput></screen>
128
129 </sect2>
130
131 <sect2 role="commands">
132 <title>Command Explanations</title>
133
134 <para>
135 <command>gdk-pixbuf-query-loaders --update-cache</command>: This command
136 regenerates the <application>GDK Pixbuf</application> loader cache so
137 that it is aware of the JPEG-XL loader.
138 </para>
139
140 <para>
141 <parameter>-DBUILD_TESTING=OFF</parameter>: This parameter disables the
142 tests because they require
143 <ulink url="https://github.com/google/googletest">gtest</ulink>, which
144 is not in BLFS. If you wish to run the tests and have
145 <ulink url="https://github.com/google/googletest">gtest</ulink> installed,
146 remove this parameter.
147 </para>
148
149 <para>
150 <parameter>-DBUILD_SHARED_LIBS=ON</parameter>: This parameter enables
151 building shared versions of the libraries instead of static ones.
152 </para>
153
154 <para>
155 <parameter>-DJPEGXL_ENABLE_SKCMS=OFF</parameter>: This parameter disables
156 building support for Skia's <application>skcms</application> since it is
157 not necessary for BLFS purposes and requires
158 <ulink url="https://skia.googlesource.com/skcms/">skcms</ulink>.
159 </para>
160
161 <para>
162 <parameter>-DJPEGXL_ENABLE_SJPEG=OFF</parameter>: This parameter disables
163 support for SimpleJPEG since it is not necessary for BLFS purposes and
164 requires <ulink url="https://github.com/webmproject/sjpeg">sjpeg</ulink>.
165 </para>
166
167 <para>
168 <parameter>-DJPEGXL_ENABLE_PLUGINS=ON</parameter>: This parameter enables
169 Plugin support, which creates plugins for <xref linkend="gimp"/> and
170 <xref linkend="gdk-pixbuf"/> if those packages are installed.
171 </para>
172
173 <para>
174 <parameter>-DJPEGXL_INSTALL_JARDIR=/usr/share/java</parameter>: This
175 parameter places the JAR file for JPEG XL support in the correct
176 directory if <xref linkend="java"/> is installed.
177 </para>
178
179 </sect2>
180
181 <sect2 role="content">
182 <title>Contents</title>
183
184 <segmentedlist>
185 <segtitle>Installed Programs</segtitle>
186 <segtitle>Installed Libraries</segtitle>
187 <segtitle>Installed Directories</segtitle>
188
189 <seglistitem>
190 <seg>
191 benchmark_xl,
192 cjxl,
193 djxl, and
194 jxlinfo
195 </seg>
196 <seg>
197 libjxl.so,
198 libjxl_cms.so,
199 libjxl_extras_codec.so,
200 libjxl_jni.so,
201 libjxl_threads.so, and
202 libpixbufloader-jxl.so (in /usr/lib/gdk-pixbuf-2.0/2.10.0/loaders),
203 </seg>
204 <seg>
205 /usr/include/jxl
206 </seg>
207 </seglistitem>
208 </segmentedlist>
209
210 <variablelist>
211 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
212 <?dbfo list-presentation="list"?>
213 <?dbhtml list-presentation="table"?>
214
215 <varlistentry id="benchmark_xl">
216 <term><command>benchmark_xl</command></term>
217 <listitem>
218 <para>
219 runs performance benchmarks against libjxl
220 </para>
221 <indexterm zone="libjxl benchmark_xl">
222 <primary sortas="b-benchmark_xl">benchmark_xl</primary>
223 </indexterm>
224 </listitem>
225 </varlistentry>
226
227 <varlistentry id="cjxl">
228 <term><command>cjxl</command></term>
229 <listitem>
230 <para>
231 compresses images into JPEG XL format
232 </para>
233 <indexterm zone="libjxl cjxl">
234 <primary sortas="b-cjxl">cjxl</primary>
235 </indexterm>
236 </listitem>
237 </varlistentry>
238
239 <varlistentry id="djxl">
240 <term><command>djxl</command></term>
241 <listitem>
242 <para>
243 decompresses images from JPEG XL format into other formats
244 </para>
245 <indexterm zone="libjxl djxl">
246 <primary sortas="b-djxl">djxl</primary>
247 </indexterm>
248 </listitem>
249 </varlistentry>
250
251 <varlistentry id="jxlinfo">
252 <term><command>jxlinfo</command></term>
253 <listitem>
254 <para>
255 displays information about JPEG XL images
256 </para>
257 <indexterm zone="libjxl jxlinfo">
258 <primary sortas="b-jxlinfo">jxlinfo</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="libjxl-lib">
264 <term><filename class="libraryfile">libjxl.so</filename></term>
265 <listitem>
266 <para>
267 contains the reference implementation of the JPEG XL standard
268 </para>
269 <indexterm zone="libjxl libjxl-lib">
270 <primary sortas="c-libjxl">libjxl.so</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="libjxl_cms">
276 <term><filename class="libraryfile">libjxl_cms.so</filename></term>
277 <listitem>
278 <para>
279 contains support for Little CMS in libjxl
280 </para>
281 <indexterm zone="libjxl libjxl_cms">
282 <primary sortas="c-libjxl_cms">libjxl_cms.so</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="libjxl_extras_codec">
288 <term><filename class="libraryfile">libjxl_extras_codec.so</filename></term>
289 <listitem>
290 <para>
291 contains additional codec support for JPEG XL images
292 </para>
293 <indexterm zone="libjxl libjxl_extras_codec">
294 <primary sortas="c-libjxl_extras_codec">libjxl_extras_codec.so</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="libjxl_jni">
300 <term><filename class="libraryfile">libjxl_jni.so</filename></term>
301 <listitem>
302 <para>
303 contains a Java interface to support JPEG XL on systems where
304 <xref linkend="java"/> was installed at build time
305 </para>
306 <indexterm zone="libjxl libjxl_jni">
307 <primary sortas="c-libjxl_jni">libjxl_jni.so</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="libjxl_threads">
313 <term><filename class="libraryfile">libjxl_threads.so</filename></term>
314 <listitem>
315 <para>
316 contains threading functions for JPEG XL
317 </para>
318 <indexterm zone="libjxl libjxl_threads">
319 <primary sortas="c-libjxl_threads">libjxl_threads.so</primary>
320 </indexterm>
321 </listitem>
322 </varlistentry>
323
324 <varlistentry id="libpixbufloader-jxl">
325 <term><filename class="libraryfile">libpixbufloader-jxl.so</filename></term>
326 <listitem>
327 <para>
328 contains a loader for gdk-pixbuf to allow it to load JPEG XL images
329 </para>
330 <indexterm zone="libjxl libpixbufloader-jxl">
331 <primary sortas="c-libpixbufloader-jxl">libpixbufloader-jxl.so</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335 </variablelist>
336 </sect2>
337</sect1>
Note: See TracBrowser for help on using the repository browser.