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 openjpeg2-download-http "https://github.com/uclouvain/openjpeg/archive/v&openjpeg2-version;/openjpeg-&openjpeg2-version;.tar.gz">
|
---|
8 | <!ENTITY openjpeg2-download-ftp " ">
|
---|
9 | <!ENTITY openjpeg2-md5sum "f9ee64845881a15109ed0aa73a12202f">
|
---|
10 | <!ENTITY openjpeg2-size "1.8 MB">
|
---|
11 | <!ENTITY openjpeg2-buildsize "13 MB (add 1.7 GB for tests)">
|
---|
12 | <!ENTITY openjpeg2-time "0.2 SBU (add 0.8 SBU for tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="openjpeg2" xreflabel="OpenJPEG-&openjpeg2-version;">
|
---|
16 | <?dbhtml filename="openjpeg2.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>OpenJPEG-&openjpeg2-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="openjpeg2">
|
---|
22 | <primary sortas="a-openjpeg2">OpenJPEG</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to OpenJPEG</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | <application>OpenJPEG</application> is an open-source implementation of
|
---|
30 | the JPEG-2000 standard. OpenJPEG fully respects the JPEG-2000
|
---|
31 | specifications and can compress/decompress lossless 16-bit images.
|
---|
32 | </para>
|
---|
33 |
|
---|
34 | &lfs122_checked;
|
---|
35 |
|
---|
36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
37 | <itemizedlist spacing="compact">
|
---|
38 | <listitem>
|
---|
39 | <para>
|
---|
40 | Download (HTTP): <ulink url="&openjpeg2-download-http;"/>
|
---|
41 | </para>
|
---|
42 | </listitem>
|
---|
43 | <listitem>
|
---|
44 | <para>
|
---|
45 | Download (FTP): <ulink url="&openjpeg2-download-ftp;"/>
|
---|
46 | </para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download MD5 sum: &openjpeg2-md5sum;
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download size: &openjpeg2-size;
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Estimated disk space required: &openjpeg2-buildsize;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Estimated build time: &openjpeg2-time;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | </itemizedlist>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect3">OpenJPEG Dependencies</bridgehead>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
73 | <para role="required">
|
---|
74 | <xref linkend="cmake"/>
|
---|
75 | </para>
|
---|
76 |
|
---|
77 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
78 | <para role="optional">
|
---|
79 | <xref linkend="git"/> (for tests),
|
---|
80 | <xref linkend="lcms2"/>,
|
---|
81 | <xref linkend="libpng"/>,
|
---|
82 | <xref linkend="libtiff"/>, and
|
---|
83 | <xref linkend="doxygen"/> (to build the API documentation)
|
---|
84 | </para>
|
---|
85 |
|
---|
86 | </sect2>
|
---|
87 |
|
---|
88 | <sect2 role="installation">
|
---|
89 | <title>Installation of OpenJPEG</title>
|
---|
90 |
|
---|
91 | <para>
|
---|
92 | Install <application>OpenJPEG</application> by running the
|
---|
93 | following commands:
|
---|
94 | </para>
|
---|
95 |
|
---|
96 | <screen><userinput>mkdir -v build &&
|
---|
97 | cd build &&
|
---|
98 |
|
---|
99 | cmake -D CMAKE_BUILD_TYPE=Release \
|
---|
100 | -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
101 | -D BUILD_STATIC_LIBS=OFF .. &&
|
---|
102 | make</userinput></screen>
|
---|
103 |
|
---|
104 | <para>
|
---|
105 | If you wish to run the tests, some additional files are required. Download
|
---|
106 | these files and run the tests using the following commands, but note that
|
---|
107 | 8 tests are known to fail:
|
---|
108 | </para>
|
---|
109 |
|
---|
110 | <screen remap="test"><userinput>git clone https://github.com/uclouvain/openjpeg-data.git --depth 1 &&
|
---|
111 | OPJ_DATA_ROOT=$PWD/openjpeg-data cmake -D BUILD_TESTING=ON .. &&
|
---|
112 | make &&
|
---|
113 | make test</userinput></screen>
|
---|
114 |
|
---|
115 | <para>
|
---|
116 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
117 | </para>
|
---|
118 |
|
---|
119 | <screen role="root"><userinput>make install &&
|
---|
120 | cp -rv ../doc/man -T /usr/share/man</userinput></screen>
|
---|
121 |
|
---|
122 | </sect2>
|
---|
123 | <!--
|
---|
124 | <sect2 role="commands">
|
---|
125 | <title>Command Explanations</title>
|
---|
126 |
|
---|
127 | <para>
|
---|
128 | <option>-D BUILD_TESTING=ON</option>: This switch enables
|
---|
129 | building the test suite.
|
---|
130 | </para>
|
---|
131 |
|
---|
132 | </sect2>-->
|
---|
133 |
|
---|
134 | <sect2 role="content">
|
---|
135 | <title>Contents</title>
|
---|
136 |
|
---|
137 | <segmentedlist>
|
---|
138 | <segtitle>Installed Programs</segtitle>
|
---|
139 | <segtitle>Installed Libraries</segtitle>
|
---|
140 | <segtitle>Installed Directories</segtitle>
|
---|
141 |
|
---|
142 | <seglistitem>
|
---|
143 | <seg>opj_compress, opj_decompress, and opj_dump</seg>
|
---|
144 | <seg>libopenjp2.so</seg>
|
---|
145 | <seg>/usr/include/openjpeg-&openjpeg2-majmin-version; and /usr/lib/openjpeg-&openjpeg2-majmin-version;</seg>
|
---|
146 | </seglistitem>
|
---|
147 | </segmentedlist>
|
---|
148 |
|
---|
149 | <variablelist>
|
---|
150 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
151 | <?dbfo list-presentation="list"?>
|
---|
152 | <?dbhtml list-presentation="table"?>
|
---|
153 |
|
---|
154 | <varlistentry id="opj_compress">
|
---|
155 | <term><command>opj_compress</command></term>
|
---|
156 | <listitem>
|
---|
157 | <para>
|
---|
158 | converts various image formats to the jpeg2000 format
|
---|
159 | </para>
|
---|
160 | <indexterm zone="openjpeg2 opj_compress">
|
---|
161 | <primary sortas="b-opj_compress">opj_compress</primary>
|
---|
162 | </indexterm>
|
---|
163 | </listitem>
|
---|
164 | </varlistentry>
|
---|
165 |
|
---|
166 | <varlistentry id="opj_decompress">
|
---|
167 | <term><command>opj_decompress</command></term>
|
---|
168 | <listitem>
|
---|
169 | <para>
|
---|
170 | converts jpeg2000 images to other image types
|
---|
171 | </para>
|
---|
172 | <indexterm zone="openjpeg2 opj_decompress">
|
---|
173 | <primary sortas="b-opj_decompress">opj_decompress</primary>
|
---|
174 | </indexterm>
|
---|
175 | </listitem>
|
---|
176 | </varlistentry>
|
---|
177 |
|
---|
178 | <varlistentry id="opj_dump">
|
---|
179 | <term><command>opj_dump</command></term>
|
---|
180 | <listitem>
|
---|
181 | <para>
|
---|
182 | reads in a jpeg2000 image and dumps the contents to stdout
|
---|
183 | </para>
|
---|
184 | <indexterm zone="openjpeg2 opj_dump">
|
---|
185 | <primary sortas="b-opj_dump">opj_dump</primary>
|
---|
186 | </indexterm>
|
---|
187 | </listitem>
|
---|
188 | </varlistentry>
|
---|
189 |
|
---|
190 | </variablelist>
|
---|
191 |
|
---|
192 | </sect2>
|
---|
193 |
|
---|
194 | </sect1>
|
---|