blob: 29672fde66ceb13f1e37a5d78685422c0b20fdb5 [file] [log] [blame]
DRC68fef832010-02-16 05:29:10 +00001*******************************************************************************
DRCf32640e2013-03-23 09:57:03 +00002** Building on Un*x Platforms (including Cygwin and OS X)
DRC68fef832010-02-16 05:29:10 +00003*******************************************************************************
4
DRCcc243742010-10-16 09:22:43 +00005
DRC68fef832010-02-16 05:29:10 +00006==================
7Build Requirements
8==================
9
10-- autoconf 2.56 or later
DRC68fef832010-02-16 05:29:10 +000011-- automake 1.7 or later
DRC68fef832010-02-16 05:29:10 +000012-- libtool 1.4 or later
DRCf32640e2013-03-23 09:57:03 +000013 * If using Xcode 4.3 or later on OS X, autoconf and automake are no longer
14 provided. The easiest way to obtain them is from MacPorts
15 (http://www.macports.org/).
DRC68fef832010-02-16 05:29:10 +000016
DRC94755ce2011-10-19 05:13:27 +000017-- NASM (if building x86 or x86-64 SIMD extensions)
DRC254937b2011-04-16 13:35:35 +000018 * 0.98, or 2.01 or later is required for a 32-bit build
19 * NASM 2.00 or later is required for a 64-bit build
DRC9026b372011-04-16 13:37:22 +000020 * NASM 2.07 or later is required for a 64-bit build on OS X. This can be
DRC0dedd1a2010-07-02 09:20:12 +000021 obtained from MacPorts (http://www.macports.org/).
DRC68fef832010-02-16 05:29:10 +000022
DRC254937b2011-04-16 13:35:35 +000023 The binary RPMs released by the NASM project do not work on older Linux
24 systems, such as Red Hat Enterprise Linux 4. On such systems, you can
25 easily build and install NASM from a source RPM by downloading one of the
26 SRPMs from
27
28 http://www.nasm.us/pub/nasm/releasebuilds
29
30 and executing the following as root:
DRC68fef832010-02-16 05:29:10 +000031
32 ARCH=`uname -m`
DRC254937b2011-04-16 13:35:35 +000033 rpmbuild --rebuild nasm-{version}.src.rpm
34 rpm -Uvh /usr/src/redhat/RPMS/$ARCH/nasm-{version}.$ARCH.rpm
DRC68fef832010-02-16 05:29:10 +000035
DRC254937b2011-04-16 13:35:35 +000036 NOTE: the NASM build will fail if texinfo is not installed.
DRCc3f4ac02010-02-19 21:51:26 +000037
DRC8f870c22010-02-24 00:30:00 +000038-- GCC v4.1 or later recommended for best performance
DRCf32640e2013-03-23 09:57:03 +000039 * Beginning with Xcode 4, Apple stopped distributing GCC and switched to
DRC08769b32013-03-23 21:35:41 +000040 the LLVM compiler. Xcode v4.0 through v4.6 provides a GCC front end
41 called LLVM-GCC. Unfortunately, as of this writing, neither LLVM-GCC nor
42 the LLVM (clang) compiler produces optimal performance with libjpeg-turbo.
DRCf32640e2013-03-23 09:57:03 +000043 Building libjpeg-turbo with LLVM-GCC v4.2 results in a 10% performance
44 degradation when compressing using 64-bit code, relative to building
45 libjpeg-turbo with GCC v4.2. Building libjpeg-turbo with LLVM (clang)
46 results in a 20% performance degradation when compressing using 64-bit
47 code, relative to building libjpeg-turbo with GCC v4.2. If you are
48 running Snow Leopard or earlier, it is suggested that you continue to use
49 Xcode v3.2.6, which provides GCC v4.2. If you are using Lion or later, it
50 is suggested that you install Apple GCC v4.2 through MacPorts.
DRC68fef832010-02-16 05:29:10 +000051
DRC5039d732013-01-21 23:42:12 +000052-- If building the TurboJPEG Java wrapper, JDK or OpenJDK 1.5 or later is
DRC279bd342011-04-02 05:17:12 +000053 required. Some systems, such as OS X 10.4, Solaris 10 and later, and Red
54 Hat Enterprise Linux 5 and later, have this pre-installed. On OS X 10.5 and
55 later, it will be necessary to install the Java Developer Package, which can
56 be downloaded from http://connect.apple.com. For systems that do not have a
57 JDK installed, you can obtain the Oracle Java Development Kit from
58 http://www.java.com.
DRCf8e00552011-02-04 11:06:36 +000059
DRCcc243742010-10-16 09:22:43 +000060
61==================
62Out-of-Tree Builds
63==================
64
65Binary objects, libraries, and executables are generated in the same directory
66from which configure was executed (the "binary directory"), and this directory
67need not necessarily be the same as the libjpeg-turbo source directory. You
68can create multiple independent binary directories, in which different versions
69of libjpeg-turbo can be built from the same source tree using different
70compilers or settings. In the sections below, {build_directory} refers to the
71binary directory, whereas {source_directory} refers to the libjpeg-turbo source
72directory. For in-tree builds, these directories are the same.
73
74
DRC68fef832010-02-16 05:29:10 +000075======================
76Building libjpeg-turbo
77======================
78
DRC5039d732013-01-21 23:42:12 +000079The following procedure will build libjpeg-turbo on Linux, FreeBSD, Cygwin, and
80Solaris/x86 systems (on Solaris, this generates a 32-bit library. See below
81for 64-bit build instructions.)
DRC68fef832010-02-16 05:29:10 +000082
DRCcc243742010-10-16 09:22:43 +000083 cd {source_directory}
DRC68fef832010-02-16 05:29:10 +000084 autoreconf -fiv
DRCcc243742010-10-16 09:22:43 +000085 cd {build_directory}
DRC98dbe912010-11-04 22:22:30 +000086 sh {source_directory}/configure [additional configure flags]
DRC68fef832010-02-16 05:29:10 +000087 make
88
DRCfde862b2013-02-11 03:38:53 +000089NOTE: Running autoreconf in the source directory is usually only necessary if
90building libjpeg-turbo from the SVN repository.
DRC68fef832010-02-16 05:29:10 +000091
92This will generate the following files under .libs/
93
94 libjpeg.a
DRC5039d732013-01-21 23:42:12 +000095 Static link library for the libjpeg API
DRC68fef832010-02-16 05:29:10 +000096
DRC5039d732013-01-21 23:42:12 +000097 libjpeg.so.{version} (Linux, Unix)
DRCcc243742010-10-16 09:22:43 +000098 libjpeg.{version}.dylib (OS X)
DRC81543312010-10-18 07:23:58 +000099 cygjpeg-{version}.dll (Cygwin)
DRC5039d732013-01-21 23:42:12 +0000100 Shared library for the libjpeg API
DRC68fef832010-02-16 05:29:10 +0000101
DRC5039d732013-01-21 23:42:12 +0000102 By default, {version} is 62.1.0, 7.1.0, or 8.0.2, depending on whether
103 libjpeg v6b (default), v7, or v8 emulation is enabled. If using Cygwin,
104 {version} is 62, 7, or 8.
105
106 libjpeg.so (Linux, Unix)
DRC68fef832010-02-16 05:29:10 +0000107 libjpeg.dylib (OS X)
DRC5039d732013-01-21 23:42:12 +0000108 Development symlink for the libjpeg API
109
DRC81543312010-10-18 07:23:58 +0000110 libjpeg.dll.a (Cygwin)
DRC5039d732013-01-21 23:42:12 +0000111 Import library for the libjpeg API
DRC68fef832010-02-16 05:29:10 +0000112
113 libturbojpeg.a
DRC5039d732013-01-21 23:42:12 +0000114 Static link library for the TurboJPEG API
DRC68fef832010-02-16 05:29:10 +0000115
DRC5039d732013-01-21 23:42:12 +0000116 libturbojpeg.so.0.0.0 (Linux, Unix)
117 libturbojpeg.0.0.0.dylib (OS X)
118 cygturbojpeg-0.dll (Cygwin)
119 Shared library for the TurboJPEG API
120
121 libturbojpeg.so (Linux, Unix)
DRC68fef832010-02-16 05:29:10 +0000122 libturbojpeg.dylib (OS X)
DRC5039d732013-01-21 23:42:12 +0000123 Development symlink for the TurboJPEG API
DRC81543312010-10-18 07:23:58 +0000124
125 libturbojpeg.dll.a (Cygwin)
DRC5039d732013-01-21 23:42:12 +0000126 Import library for the TurboJPEG API
DRC81543312010-10-18 07:23:58 +0000127
128
DRC30913542012-01-27 09:53:33 +0000129libjpeg v7 or v8 API/ABI Emulation
130----------------------------------
DRC81543312010-10-18 07:23:58 +0000131
132Add --with-jpeg7 to the configure command line to build a version of
DRC30913542012-01-27 09:53:33 +0000133libjpeg-turbo that is API/ABI-compatible with libjpeg v7. Add --with-jpeg8 to
134the configure command to build a version of libjpeg-turbo that is
135API/ABI-compatible with libjpeg v8. See README-turbo.txt for more information
136on libjpeg v7 and v8 emulation.
DRC81543312010-10-18 07:23:58 +0000137
DRC68fef832010-02-16 05:29:10 +0000138
DRC5039d732013-01-21 23:42:12 +0000139In-Memory Source/Destination Managers
140-------------------------------------
141
142When using libjpeg v6b or v7 API/ABI emulation, add --without-mem-srcdst to the
143configure command line to build a version of libjpeg-turbo that lacks the
144jpeg_mem_src() and jpeg_mem_dest() functions. These functions were not part of
145the original libjpeg v6b and v7 APIs, so removing them ensures strict
146conformance with those APIs. See README-turbo.txt for more information.
147
148
DRC245cfdf2010-11-23 17:11:06 +0000149Arithmetic Coding Support
150-------------------------
151
152Since the patent on arithmetic coding has expired, this functionality has been
153included in this release of libjpeg-turbo. libjpeg-turbo's implementation is
DRCf38eee02011-02-18 07:00:38 +0000154based on the implementation in libjpeg v8, but it works when emulating libjpeg
DRC245cfdf2010-11-23 17:11:06 +0000155v7 or v6b as well. The default is to enable both arithmetic encoding and
156decoding, but those who have philosophical objections to arithmetic coding can
157add --without-arith-enc or --without-arith-dec to the configure command line to
158disable encoding or decoding (respectively.)
159
DRC68fef832010-02-16 05:29:10 +0000160
DRC5039d732013-01-21 23:42:12 +0000161TurboJPEG Java Wrapper
162----------------------
DRC88f54a42011-04-01 01:21:22 +0000163Add --with-java to the configure command line to incorporate an optional Java
DRC5039d732013-01-21 23:42:12 +0000164Native Interface wrapper into the TurboJPEG shared library and build the Java
165front-end classes to support it. This allows the TurboJPEG shared library to
166be used directly from Java applications. See java/README for more details.
DRC88f54a42011-04-01 01:21:22 +0000167
168You can set the JAVAC, JAR, and JAVA configure variables to specify
169alternate commands for javac, jar, and java (respectively.) You can also
170set the JAVACFLAGS configure variable to specify arguments that should be
171passed to the Java compiler when building the front-end classes, and JNI_CFLAGS
172to specify arguments that should be passed to the C compiler when building the
173JNI wrapper. Run 'configure --help' for more details.
DRCf8e00552011-02-04 11:06:36 +0000174
175
DRC68fef832010-02-16 05:29:10 +0000176========================
177Installing libjpeg-turbo
178========================
179
180If you intend to install these libraries and the associated header files, then
181replace 'make' in the instructions above with
182
183 make install prefix={base dir} libdir={library directory}
184
185For example,
186
187 make install prefix=/usr/local libdir=/usr/local/lib64
188
189will install the header files in /usr/local/include and the library files in
190/usr/local/lib64. If 'prefix' and 'libdir' are not specified, then the default
191is to install the header files in /opt/libjpeg-turbo/include and the library
DRCd7a642b2013-04-24 06:40:25 +0000192files in /opt/libjpeg-turbo/lib32 (32-bit) or /opt/libjpeg-turbo/lib64
193(64-bit.)
DRC68fef832010-02-16 05:29:10 +0000194
195NOTE: You can specify a prefix of /usr and a libdir of, for instance,
196/usr/lib64 to overwrite the system's version of libjpeg. If you do this,
197however, then be sure to BACK UP YOUR SYSTEM'S INSTALLATION OF LIBJPEG before
198overwriting it. It is recommended that you instead install libjpeg-turbo into
DRC5039d732013-01-21 23:42:12 +0000199a non-system directory and manipulate the LD_LIBRARY_PATH or create symlinks
DRC68fef832010-02-16 05:29:10 +0000200to force applications to use libjpeg-turbo instead of libjpeg. See
201README-turbo.txt for more information.
202
DRCcc243742010-10-16 09:22:43 +0000203
DRC68fef832010-02-16 05:29:10 +0000204=============
205Build Recipes
206=============
207
DRCcc243742010-10-16 09:22:43 +0000208
DRC5039d732013-01-21 23:42:12 +000020932-bit Build on 64-bit Linux
210----------------------------
DRC68fef832010-02-16 05:29:10 +0000211
DRCca5e7d12010-02-17 02:25:06 +0000212Add
DRC68fef832010-02-16 05:29:10 +0000213
DRC2e4d0442011-02-08 01:18:37 +0000214 --host i686-pc-linux-gnu CFLAGS='-O3 -m32' LDFLAGS=-m32
DRC68fef832010-02-16 05:29:10 +0000215
216to the configure command line.
217
218
DRC5039d732013-01-21 23:42:12 +000021964-bit Build on 64-bit OS X
220---------------------------
DRC68fef832010-02-16 05:29:10 +0000221
DRCca5e7d12010-02-17 02:25:06 +0000222Add
DRC68fef832010-02-16 05:29:10 +0000223
DRC0dedd1a2010-07-02 09:20:12 +0000224 --host x86_64-apple-darwin NASM=/opt/local/bin/nasm
DRC68fef832010-02-16 05:29:10 +0000225
DRC7bac07b2010-04-10 05:53:35 +0000226to the configure command line. NASM 2.07 or later from MacPorts must be
227installed.
DRC68fef832010-02-16 05:29:10 +0000228
229
DRC5039d732013-01-21 23:42:12 +000023032-bit Build on 64-bit OS X
231---------------------------
DRC68fef832010-02-16 05:29:10 +0000232
DRCca5e7d12010-02-17 02:25:06 +0000233Add
DRC68fef832010-02-16 05:29:10 +0000234
DRC5950c5d2012-06-28 23:22:03 +0000235 --host i686-apple-darwin CFLAGS='-O3 -m32' LDFLAGS=-m32
DRC68fef832010-02-16 05:29:10 +0000236
237to the configure command line.
238
239
DRC5039d732013-01-21 23:42:12 +000024064-bit Backward-Compatible Build on 64-bit OS X
241-----------------------------------------------
DRC68fef832010-02-16 05:29:10 +0000242
DRCca5e7d12010-02-17 02:25:06 +0000243Add
DRC68fef832010-02-16 05:29:10 +0000244
DRC0dedd1a2010-07-02 09:20:12 +0000245 --host x86_64-apple-darwin NASM=/opt/local/bin/nasm \
246 CFLAGS='-isysroot /Developer/SDKs/MacOSX10.4u.sdk \
247 -mmacosx-version-min=10.4 -O3' \
DRC0dedd1a2010-07-02 09:20:12 +0000248 LDFLAGS='-isysroot /Developer/SDKs/MacOSX10.4u.sdk \
249 -mmacosx-version-min=10.4'
250
DRC575c3422010-07-08 07:01:20 +0000251to the configure command line. The OS X 10.4 SDK, and NASM 2.07 or later from
252MacPorts, must be installed.
DRC0dedd1a2010-07-02 09:20:12 +0000253
254
DRC5039d732013-01-21 23:42:12 +000025532-bit Backward-Compatible Build on OS X
256----------------------------------------
DRC0dedd1a2010-07-02 09:20:12 +0000257
258Add
259
DRC5950c5d2012-06-28 23:22:03 +0000260 --host i686-apple-darwin \
261 CFLAGS='-isysroot /Developer/SDKs/MacOSX10.4u.sdk \
DRC485cd802010-02-23 23:23:42 +0000262 -mmacosx-version-min=10.4 -O3 -m32' \
DRC68fef832010-02-16 05:29:10 +0000263 LDFLAGS='-isysroot /Developer/SDKs/MacOSX10.4u.sdk \
264 -mmacosx-version-min=10.4 -m32'
265
266to the configure command line. The OS X 10.4 SDK must be installed.
267
268
26964-bit Library Build on 64-bit Solaris
270--------------------------------------
271
DRCca5e7d12010-02-17 02:25:06 +0000272Add
DRC68fef832010-02-16 05:29:10 +0000273
DRC2e4d0442011-02-08 01:18:37 +0000274 --host x86_64-pc-solaris CFLAGS='-O3 -m64' LDFLAGS=-m64
DRC68fef832010-02-16 05:29:10 +0000275
276to the configure command line.
277
278
DRC5039d732013-01-21 23:42:12 +000027932-bit Build on 64-bit FreeBSD
280------------------------------
DRC7bac07b2010-04-10 05:53:35 +0000281
282Add
283
DRC2e4d0442011-02-08 01:18:37 +0000284 --host i386-unknown-freebsd CC='gcc -B /usr/lib32' CFLAGS='-O3 -m32' \
285 LDFLAGS='-B/usr/lib32'
DRC7bac07b2010-04-10 05:53:35 +0000286
287to the configure command line. NASM 2.07 or later from FreeBSD ports must be
288installed.
289
290
DRC0559e942012-03-23 03:12:35 +0000291Oracle Solaris Studio
292---------------------
DRCca5e7d12010-02-17 02:25:06 +0000293
294Add
295
DRC2e4d0442011-02-08 01:18:37 +0000296 CC=cc
DRCca5e7d12010-02-17 02:25:06 +0000297
298to the configure command line. libjpeg-turbo will automatically be built with
DRC2e4d0442011-02-08 01:18:37 +0000299the maximum optimization level (-xO5) unless you override CFLAGS.
DRCca5e7d12010-02-17 02:25:06 +0000300
DRC0559e942012-03-23 03:12:35 +0000301To build a 64-bit version of libjpeg-turbo using Oracle Solaris Studio, add
DRCca5e7d12010-02-17 02:25:06 +0000302
DRC2e4d0442011-02-08 01:18:37 +0000303 --host x86_64-pc-solaris CC=cc CFLAGS='-xO5 -m64' LDFLAGS=-m64
DRCca5e7d12010-02-17 02:25:06 +0000304
305to the configure command line.
306
DRC8b014d72010-02-18 13:03:41 +0000307
DRC81543312010-10-18 07:23:58 +0000308MinGW Build on Cygwin
309---------------------
310
311Use CMake (see recipes below)
312
313
DRC94755ce2011-10-19 05:13:27 +0000314===========
315ARM Support
316===========
317
318This release of libjpeg-turbo can use ARM NEON SIMD instructions to accelerate
319JPEG compression/decompression by approximately 2-4x on ARMv7 and later
320platforms. If libjpeg-turbo is configured on an ARM Linux platform, then the
321build system will automatically include the NEON SIMD routines, if they are
322supported.
323
324
325Building libjpeg-turbo for iOS
326------------------------------
327
328iOS platforms, such as the iPhone and iPad, also use ARM processors, some of
329which support NEON instructions. Additional steps are required to build
330libjpeg-turbo for these platforms. The steps below assume iOS SDK v4.3. If
331you are using a different SDK version, then you will need to modify the
332examples accordingly.
333
334Additional build requirements:
335
336 gas-preprocessor.pl (https://github.com/yuvi/gas-preprocessor) should be
337 installed in your PATH.
338
339Set the following shell variables for simplicity:
340
DRCa2a2cd62013-02-04 22:29:57 +0000341 Xcode 3.2.x / iOS 4.3 SDK:
DRC94755ce2011-10-19 05:13:27 +0000342 IOS_PLATFORMDIR="/Developer/Platforms/iPhoneOS.platform"
343 IOS_SYSROOT="$IOS_PLATFORMDIR/Developer/SDKs/iPhoneOS4.3.sdk"
344 IOS_GCC="$IOS_PLATFORMDIR/Developer/usr/bin/arm-apple-darwin10-llvm-gcc-4.2"
345
DRCa2a2cd62013-02-04 22:29:57 +0000346 Xcode 4.5.x / iOS 6.0 SDK:
347 IOS_PLATFORMDIR="/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform"
348 IOS_SYSROOT="$IOS_PLATFORMDIR/Developer/SDKs/iPhoneOS6.0.sdk"
349 IOS_GCC="$IOS_PLATFORMDIR/Developer/usr/bin/arm-apple-darwin10-llvm-gcc-4.2"
350
DRC94755ce2011-10-19 05:13:27 +0000351 ARM v6 only (up to and including iPhone 3G):
DRCa2a2cd62013-02-04 22:29:57 +0000352 [NOTE: Requires Xcode 4.4.x or earlier]
DRC94755ce2011-10-19 05:13:27 +0000353 IOS_CFLAGS="-march=armv6 -mcpu=arm1176jzf-s -mfpu=vfp"
354
DRC5039d732013-01-21 23:42:12 +0000355 ARM v7 only (iPhone 3GS-4S, iPad 1st-3rd Generation):
DRC94755ce2011-10-19 05:13:27 +0000356 IOS_CFLAGS="-march=armv7 -mcpu=cortex-a8 -mtune=cortex-a8 -mfpu=neon"
357
DRCa2a2cd62013-02-04 22:29:57 +0000358 ARM v7s only (iPhone 5, iPad 4th Generation):
359 [NOTE: Requires Xcode 4.5 or later]
360 IOS_CFLAGS="-march=armv7s -mcpu=swift -mtune=swift -mfpu=neon"
361
DRC94755ce2011-10-19 05:13:27 +0000362Follow the procedure under "Building libjpeg-turbo" above, adding
363
DRC89c59dd2011-10-27 20:40:21 +0000364 --host arm-apple-darwin10 --enable-static --disable-shared \
DRC94755ce2011-10-19 05:13:27 +0000365 CC="$IOS_GCC" LD="$IOS_GCC" \
366 CFLAGS="-mfloat-abi=softfp -isysroot $IOS_SYSROOT -O3 $IOS_CFLAGS" \
367 LDFLAGS="-mfloat-abi=softfp -isysroot $IOS_SYSROOT $IOS_CFLAGS"
368
369to the configure command line.
370
DRCa2a2cd62013-02-04 22:29:57 +0000371Once built, lipo can be used to combine the ARM v6, v7, and/or v7s variants
372into a universal library.
DRC5039d732013-01-21 23:42:12 +0000373
DRCfde862b2013-02-11 03:38:53 +0000374NOTE: If you are building libjpeg-turbo from the "official" project tarball,
375then it is highly likely that you will need to run 'autoreconf -fiv' in the
376source tree prior to building ARM v7 or v7s iOS binaries using the techniques
377described above. Otherwise, you may get a libtool error such as "unable to
378infer tagged configuration."
379
DRC81543312010-10-18 07:23:58 +0000380
DRC68fef832010-02-16 05:29:10 +0000381*******************************************************************************
DRC81543312010-10-18 07:23:58 +0000382** Building on Windows (Visual C++ or MinGW)
DRC68fef832010-02-16 05:29:10 +0000383*******************************************************************************
384
DRCcc243742010-10-16 09:22:43 +0000385
DRC68fef832010-02-16 05:29:10 +0000386==================
387Build Requirements
388==================
389
DRCcc243742010-10-16 09:22:43 +0000390-- CMake (http://www.cmake.org) v2.6 or later
DRC68fef832010-02-16 05:29:10 +0000391
DRCcc243742010-10-16 09:22:43 +0000392-- Microsoft Visual C++ 2005 or later
DRC68fef832010-02-16 05:29:10 +0000393
DRCcc243742010-10-16 09:22:43 +0000394 If you don't already have Visual C++, then the easiest way to get it is by
395 installing the Windows SDK:
DRC68fef832010-02-16 05:29:10 +0000396
DRCcc243742010-10-16 09:22:43 +0000397 http://msdn.microsoft.com/en-us/windows/bb980924.aspx
398
399 The Windows SDK includes both 32-bit and 64-bit Visual C++ compilers and
400 everything necessary to build libjpeg-turbo.
401
402 * For 32-bit builds, you can also use Microsoft Visual C++ Express
403 Edition. Visual C++ Express Edition is a free download.
404 * If you intend to build libjpeg-turbo from the command line, then add the
405 appropriate compiler and SDK directories to the INCLUDE, LIB, and PATH
406 environment variables. This is generally accomplished by executing
407 vcvars32.bat or vcvars64.bat and SetEnv.cmd. vcvars32.bat and
408 vcvars64.bat are part of Visual C++ and are located in the same directory
409 as the compiler. SetEnv.cmd is part of the Windows SDK. You can pass
410 optional arguments to SetEnv.cmd to specify a 32-bit or 64-bit build
411 environment.
412
413... OR ...
414
DRC81543312010-10-18 07:23:58 +0000415-- MinGW
DRCcc243742010-10-16 09:22:43 +0000416
417 GCC v4.1 or later recommended for best performance
DRC68fef832010-02-16 05:29:10 +0000418
DRC377add72010-05-17 16:41:12 +0000419-- NASM (http://www.nasm.us/) 0.98 or later (NASM 2.05 or later is required for
420 a 64-bit build)
DRC68fef832010-02-16 05:29:10 +0000421
DRC5039d732013-01-21 23:42:12 +0000422-- If building the TurboJPEG Java wrapper, JDK 1.5 or later is required. This
423 can be downloaded from http://www.java.com.
DRC218c0c12011-02-05 06:01:18 +0000424
DRCcc243742010-10-16 09:22:43 +0000425
426==================
427Out-of-Tree Builds
428==================
429
430Binary objects, libraries, and executables are generated in the same directory
431from which cmake was executed (the "binary directory"), and this directory need
432not necessarily be the same as the libjpeg-turbo source directory. You can
433create multiple independent binary directories, in which different versions of
434libjpeg-turbo can be built from the same source tree using different compilers
435or settings. In the sections below, {build_directory} refers to the binary
436directory, whereas {source_directory} refers to the libjpeg-turbo source
437directory. For in-tree builds, these directories are the same.
438
439
DRC68fef832010-02-16 05:29:10 +0000440======================
441Building libjpeg-turbo
442======================
443
DRC68fef832010-02-16 05:29:10 +0000444
DRCcc243742010-10-16 09:22:43 +0000445Visual C++ (Command Line)
446-------------------------
DRC68fef832010-02-16 05:29:10 +0000447
DRCcc243742010-10-16 09:22:43 +0000448 cd {build_directory}
449 cmake -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Release {source_directory}
450 nmake
DRC68fef832010-02-16 05:29:10 +0000451
DRCcc243742010-10-16 09:22:43 +0000452This will build either a 32-bit or a 64-bit version of libjpeg-turbo, depending
453on which version of cl.exe is in the PATH.
DRC8b014d72010-02-18 13:03:41 +0000454
DRCcc243742010-10-16 09:22:43 +0000455The following files will be generated under {build_directory}:
456
457 jpeg-static.lib
DRC5039d732013-01-21 23:42:12 +0000458 Static link library for the libjpeg API
DRCcc243742010-10-16 09:22:43 +0000459 sharedlib/jpeg{version}.dll
DRC5039d732013-01-21 23:42:12 +0000460 DLL for the libjpeg API
DRCcc243742010-10-16 09:22:43 +0000461 sharedlib/jpeg.lib
DRC5039d732013-01-21 23:42:12 +0000462 Import library for the libjpeg API
DRCcc243742010-10-16 09:22:43 +0000463 turbojpeg-static.lib
DRC5039d732013-01-21 23:42:12 +0000464 Static link library for the TurboJPEG API
DRCcc243742010-10-16 09:22:43 +0000465 turbojpeg.dll
DRC5039d732013-01-21 23:42:12 +0000466 DLL for the TurboJPEG API
DRCcc243742010-10-16 09:22:43 +0000467 turbojpeg.lib
DRC5039d732013-01-21 23:42:12 +0000468 Import library for the TurboJPEG API
DRCcc243742010-10-16 09:22:43 +0000469
470{version} is 62, 7, or 8, depending on whether libjpeg v6b (default), v7, or
DRCf38eee02011-02-18 07:00:38 +0000471v8 emulation is enabled.
DRCcc243742010-10-16 09:22:43 +0000472
473
474Visual C++ (IDE)
475----------------
476
477Choose the appropriate CMake generator option for your version of Visual Studio
478(run "cmake" with no arguments for a list of available generators.) For
479instance:
480
481 cd {build_directory}
482 cmake -G "Visual Studio 9 2008" {source_directory}
483
484You can then open ALL_BUILD.vcproj in Visual Studio and build one of the
485configurations in that project ("Debug", "Release", etc.) to generate a full
486build of libjpeg-turbo.
487
488This will generate the following files under {build_directory}:
489
490 {configuration}/jpeg-static.lib
DRC5039d732013-01-21 23:42:12 +0000491 Static link library for the libjpeg API
DRCcc243742010-10-16 09:22:43 +0000492 sharedlib/{configuration}/jpeg{version}.dll
DRC5039d732013-01-21 23:42:12 +0000493 DLL for the libjpeg API
DRCcc243742010-10-16 09:22:43 +0000494 sharedlib/{configuration}/jpeg.lib
DRC5039d732013-01-21 23:42:12 +0000495 Import library for the libjpeg API
DRCcc243742010-10-16 09:22:43 +0000496 {configuration}/turbojpeg-static.lib
DRC5039d732013-01-21 23:42:12 +0000497 Static link library for the TurboJPEG API
DRCcc243742010-10-16 09:22:43 +0000498 {configuration}/turbojpeg.dll
DRC5039d732013-01-21 23:42:12 +0000499 DLL for the TurboJPEG API
DRCcc243742010-10-16 09:22:43 +0000500 {configuration}/turbojpeg.lib
DRC5039d732013-01-21 23:42:12 +0000501 Import library for the TurboJPEG API
DRCcc243742010-10-16 09:22:43 +0000502
503{configuration} is Debug, Release, RelWithDebInfo, or MinSizeRel, depending on
504the configuration you built in the IDE, and {version} is 62, 7, or 8,
DRCf38eee02011-02-18 07:00:38 +0000505depending on whether libjpeg v6b (default), v7, or v8 emulation is enabled.
DRCcc243742010-10-16 09:22:43 +0000506
507
508MinGW
509-----
510
511 cd {build_directory}
512 cmake -G "MSYS Makefiles" {source_directory}
513 make
514
515This will generate the following files under {build_directory}
516
517 libjpeg.a
DRC5039d732013-01-21 23:42:12 +0000518 Static link library for the libjpeg API
DRCcc243742010-10-16 09:22:43 +0000519 sharedlib/libjpeg-{version}.dll
DRC5039d732013-01-21 23:42:12 +0000520 DLL for the libjpeg API
DRCcc243742010-10-16 09:22:43 +0000521 sharedlib/libjpeg.dll.a
DRC5039d732013-01-21 23:42:12 +0000522 Import library for the libjpeg API
DRCcc243742010-10-16 09:22:43 +0000523 libturbojpeg.a
DRC5039d732013-01-21 23:42:12 +0000524 Static link library for the TurboJPEG API
DRCcc243742010-10-16 09:22:43 +0000525 libturbojpeg.dll
DRC5039d732013-01-21 23:42:12 +0000526 DLL for the TurboJPEG API
DRCcc243742010-10-16 09:22:43 +0000527 libturbojpeg.dll.a
DRC5039d732013-01-21 23:42:12 +0000528 Import library for the TurboJPEG API
DRCcc243742010-10-16 09:22:43 +0000529
530{version} is 62, 7, or 8, depending on whether libjpeg v6b (default), v7, or
DRCf38eee02011-02-18 07:00:38 +0000531v8 emulation is enabled.
DRCcc243742010-10-16 09:22:43 +0000532
533
DRCcc243742010-10-16 09:22:43 +0000534Debug Build
535-----------
536
537Add "-DCMAKE_BUILD_TYPE=Debug" to the cmake command line. Or, if building with
538NMake, remove "-DCMAKE_BUILD_TYPE=Release" (Debug builds are the default with
539NMake.)
540
541
DRC30913542012-01-27 09:53:33 +0000542libjpeg v7 or v8 API/ABI Emulation
543-----------------------------------
DRCcc243742010-10-16 09:22:43 +0000544
545Add "-DWITH_JPEG7=1" to the cmake command line to build a version of
DRC30913542012-01-27 09:53:33 +0000546libjpeg-turbo that is API/ABI-compatible with libjpeg v7. Add "-DWITH_JPEG8=1"
547to the cmake command to build a version of libjpeg-turbo that is
548API/ABI-compatible with libjpeg v8. See README-turbo.txt for more information
549on libjpeg v7 and v8 emulation.
DRCcc243742010-10-16 09:22:43 +0000550
551
DRC5039d732013-01-21 23:42:12 +0000552In-Memory Source/Destination Managers
553-------------------------------------
554
555When using libjpeg v6b or v7 API/ABI emulation, add -DWITH_MEM_SRCDST=0 to the
556CMake command line to build a version of libjpeg-turbo that lacks the
557jpeg_mem_src() and jpeg_mem_dest() functions. These functions were not part of
558the original libjpeg v6b and v7 APIs, so removing them ensures strict
559conformance with those APIs. See README-turbo.txt for more information.
560
561
DRC245cfdf2010-11-23 17:11:06 +0000562Arithmetic Coding Support
563-------------------------
564
565Since the patent on arithmetic coding has expired, this functionality has been
566included in this release of libjpeg-turbo. libjpeg-turbo's implementation is
DRCf38eee02011-02-18 07:00:38 +0000567based on the implementation in libjpeg v8, but it works when emulating libjpeg
DRC245cfdf2010-11-23 17:11:06 +0000568v7 or v6b as well. The default is to enable both arithmetic encoding and
569decoding, but those who have philosophical objections to arithmetic coding can
570add "-DWITH_ARITH_ENC=0" or "-DWITH_ARITH_DEC=0" to the cmake command line to
571disable encoding or decoding (respectively.)
572
573
DRC5039d732013-01-21 23:42:12 +0000574TurboJPEG Java Wrapper
575----------------------
DRC279bd342011-04-02 05:17:12 +0000576Add "-DWITH_JAVA=1" to the cmake command line to incorporate an optional Java
DRC5039d732013-01-21 23:42:12 +0000577Native Interface wrapper into the TurboJPEG shared library and build the Java
578front-end classes to support it. This allows the TurboJPEG shared library to
579be used directly from Java applications. See java/README for more details.
DRC218c0c12011-02-05 06:01:18 +0000580
DRCdb425062011-04-03 06:10:18 +0000581If you are using CMake 2.8, you can set the Java_JAVAC_EXECUTABLE,
582Java_JAVA_EXECUTABLE, and Java_JAR_EXECUTABLE CMake variables to specify
583alternate commands or locations for javac, jar, and java (respectively.) If
584you are using CMake 2.6, set JAVA_COMPILE, JAVA_RUNTIME, and JAVA_ARCHIVE
585instead. You can also set the JAVACFLAGS CMake variable to specify arguments
586that should be passed to the Java compiler when building the front-end classes.
587
DRC218c0c12011-02-05 06:01:18 +0000588
DRC26658432010-10-16 22:04:29 +0000589========================
590Installing libjpeg-turbo
591========================
592
593You can use the build system to install libjpeg-turbo into a directory of your
594choosing (as opposed to creating an installer.) To do this, add:
595
596 -DCMAKE_INSTALL_PREFIX={install_directory}
597
598to the cmake command line.
599
600For example,
601
DRC81543312010-10-18 07:23:58 +0000602 cmake -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Release \
DRC26658432010-10-16 22:04:29 +0000603 -DCMAKE_INSTALL_PREFIX=c:\libjpeg-turbo {source_directory}
604 nmake install
605
606will install the header files in c:\libjpeg-turbo\include, the library files
607in c:\libjpeg-turbo\lib, the DLL's in c:\libjpeg-turbo\bin, and the
608documentation in c:\libjpeg-turbo\doc.
609
610
DRCcc243742010-10-16 09:22:43 +0000611=============
612Build Recipes
613=============
614
615
DRC1c73ce82010-10-16 21:02:54 +000061664-bit MinGW Build on Cygwin
617----------------------------
618
619 cd {build_directory}
DRC2e4d0442011-02-08 01:18:37 +0000620 CC=/usr/bin/x86_64-w64-mingw32-gcc \
DRC68bf3f22010-10-18 07:56:14 +0000621 cmake -G "Unix Makefiles" -DCMAKE_SYSTEM_NAME=Windows \
622 -DCMAKE_AR=/usr/bin/x86_64-w64-mingw32-ar \
DRC1c73ce82010-10-16 21:02:54 +0000623 -DCMAKE_RANLIB=/usr/bin/x86_64-w64-mingw32-ranlib {source_directory}
624 make
625
626This produces a 64-bit build of libjpeg-turbo that does not depend on
627cygwin1.dll or other Cygwin DLL's. The mingw64-x86_64-gcc-core and
628mingw64-x86_64-gcc-g++ packages (and their dependencies) must be installed.
629
630
63132-bit MinGW Build on Cygwin
632----------------------------
633
634 cd {build_directory}
DRC2e4d0442011-02-08 01:18:37 +0000635 CC=/usr/bin/i686-w64-mingw32-gcc \
DRC68bf3f22010-10-18 07:56:14 +0000636 cmake -G "Unix Makefiles" -DCMAKE_SYSTEM_NAME=Windows \
637 -DDCMAKE_AR=/usr/bin/i686-w64-mingw32-ar \
DRC1c73ce82010-10-16 21:02:54 +0000638 -DCMAKE_RANLIB=/usr/bin/i686-w64-mingw32-ranlib {source_directory}
639 make
640
641This produces a 32-bit build of libjpeg-turbo that does not depend on
642cygwin1.dll or other Cygwin DLL's. The mingw64-i686-gcc-core and
643mingw64-i686-gcc-g++ packages (and their dependencies) must be installed.
644
645
646MinGW-w64 Build on Windows
647--------------------------
648
649This produces a 64-bit build of libjpeg-turbo using the "native" MinGW-w64
650toolchain (which is faster than the Cygwin version):
651
652 cd {build_directory}
653 CC={mingw-w64_binary_path}/x86_64-w64-mingw32-gcc \
DRC81543312010-10-18 07:23:58 +0000654 cmake -G "MSYS Makefiles" \
DRC1c73ce82010-10-16 21:02:54 +0000655 -DCMAKE_AR={mingw-w64_binary_path}/x86_64-w64-mingw32-ar \
656 -DCMAKE_RANLIB={mingw-w64_binary_path}/x86_64-w64-mingw32-ranlib \
657 {source_directory}
658 make
659
660
DRCcc243742010-10-16 09:22:43 +0000661MinGW Build on Linux
662--------------------
663
664 cd {build_directory}
665 CC={mingw_binary_path}/i386-mingw32-gcc \
DRC68bf3f22010-10-18 07:56:14 +0000666 cmake -G "Unix Makefiles" -DCMAKE_SYSTEM_NAME=Windows \
667 -DCMAKE_AR={mingw_binary_path}/i386-mingw32-ar \
DRCcc243742010-10-16 09:22:43 +0000668 -DCMAKE_RANLIB={mingw_binary_path}/i386-mingw32-ranlib \
DRC68bf3f22010-10-18 07:56:14 +0000669 {source_directory}
DRCcc243742010-10-16 09:22:43 +0000670 make
DRC8b014d72010-02-18 13:03:41 +0000671
DRC68fef832010-02-16 05:29:10 +0000672
673*******************************************************************************
674** Creating Release Packages
675*******************************************************************************
676
677The following commands can be used to create various types of release packages:
678
DRCcc243742010-10-16 09:22:43 +0000679
DRCd7a642b2013-04-24 06:40:25 +0000680Unix/Linux
681----------
DRCcc243742010-10-16 09:22:43 +0000682
DRC68fef832010-02-16 05:29:10 +0000683make rpm
684
DRCcc243742010-10-16 09:22:43 +0000685 Create Red Hat-style binary RPM package. Requires RPM v4 or later.
DRC68fef832010-02-16 05:29:10 +0000686
687make srpm
688
689 This runs 'make dist' to create a pristine source tarball, then creates a
DRCcc243742010-10-16 09:22:43 +0000690 Red Hat-style source RPM package from the tarball. Requires RPM v4 or later.
DRC68fef832010-02-16 05:29:10 +0000691
692make deb
693
694 Create Debian-style binary package. Requires dpkg.
695
696make dmg
697
698 Create Macintosh package/disk image. This requires the PackageMaker
699 application, which must be installed in /Developer/Applications/Utilities.
DRC7ed0aeb2013-02-24 20:39:30 +0000700 Note that PackageMaker is not included in recent releases of Xcode, but it
701 can be obtained by downloading the "Auxiliary Tools for Xcode" package from
702 http://developer.apple.com/downloads.
DRC68fef832010-02-16 05:29:10 +0000703
DRC9ef93db2010-10-18 08:24:42 +0000704make udmg [BUILDDIR32={32-bit build directory}]
DRC68fef832010-02-16 05:29:10 +0000705
DRC20b734e2012-02-10 01:30:37 +0000706 On 64-bit OS X systems, this creates a Macintosh package and disk image that
707 contains universal i386/x86-64 binaries. You should first configure a 32-bit
708 out-of-tree build of libjpeg-turbo, then configure a 64-bit out-of-tree
709 build, then run 'make udmg' from the 64-bit build directory. The build
710 system will look for the 32-bit build under {source_directory}/osxx86 by
711 default, but you can override this by setting the BUILDDIR32 variable on the
712 make command line as shown above.
713
714make iosdmg [BUILDDIR32={32-bit build directory}] \
715 [BUILDDIRARMV6={ARM v6 build directory}] \
716 [BUILDDIRARMV7={ARM v7 build directory}] \
DRCa2a2cd62013-02-04 22:29:57 +0000717 [BUILDDIRARMV7S={ARM v7s build directory}]
DRC20b734e2012-02-10 01:30:37 +0000718
719 On OS X systems, this creates a Macintosh package and disk image in which the
720 libjpeg-turbo static libraries contain ARM architectures necessary to build
721 iOS applications. If building on an x86-64 system, the binaries will also
722 contain the i386 architecture, as with 'make udmg' above. You should first
DRCa2a2cd62013-02-04 22:29:57 +0000723 configure ARM v6, ARM v7, and/or ARM v7s out-of-tree builds of libjpeg-turbo
724 (see "Building libjpeg-turbo for iOS" above.) If you are building an x86-64
DRC20b734e2012-02-10 01:30:37 +0000725 version of libjpeg-turbo, you should configure a 32-bit out-of-tree build as
726 well. Next, build libjpeg-turbo as you would normally, using an out-of-tree
727 build. When it is built, run 'make iosdmg' from the build directory. The
728 build system will look for the ARM v6 build under {source_directory}/iosarmv6
729 by default, the ARM v7 build under {source_directory}/iosarmv7 by default,
DRCa2a2cd62013-02-04 22:29:57 +0000730 the ARM v7s build under {source_directory}/iosarmv7s by default, and (if
731 applicable) the 32-bit build under {source_directory}/osxx86 by default, but
732 you can override this by setting the BUILDDIR32, BUILDDIRARMV6,
733 BUILDDIRARMV7, and/or BUILDDIRARMV7S variables on the make command line as
734 shown above.
DRC68fef832010-02-16 05:29:10 +0000735
DRC81543312010-10-18 07:23:58 +0000736make cygwinpkg
737
738 Build a Cygwin binary package.
739
DRC0a1f68e2010-02-24 07:24:26 +0000740
DRCcc243742010-10-16 09:22:43 +0000741Windows
742-------
DRC0a1f68e2010-02-24 07:24:26 +0000743
DRCcc243742010-10-16 09:22:43 +0000744If using NMake:
DRC68fef832010-02-16 05:29:10 +0000745
DRCcc243742010-10-16 09:22:43 +0000746 cd {build_directory}
747 nmake installer
748
DRC81543312010-10-18 07:23:58 +0000749If using MinGW:
DRCcc243742010-10-16 09:22:43 +0000750
751 cd {build_directory}
752 make installer
753
754If using the Visual Studio IDE, build the "installer" project.
755
756The installer package (libjpeg-turbo[-gcc][64].exe) will be located under
757{build_directory}. If building using the Visual Studio IDE, then the installer
758package will be located in a subdirectory with the same name as the
759configuration you built (such as {build_directory}\Debug\ or
760{build_directory}\Release\).
761
762Building a Windows installer requires the Nullsoft Install System
763(http://nsis.sourceforge.net/.) makensis.exe should be in your PATH.
DRC9cd4e4b2012-01-31 07:56:44 +0000764
765
766*******************************************************************************
767** Regression testing
768*******************************************************************************
769
770The most common way to test libjpeg-turbo is by invoking 'make test' on
771Unix/Linux platforms or 'ctest' on Windows platforms, once the build has
772completed. This runs a series of tests to ensure that mathematical
773compatibility has been maintained between libjpeg-turbo and libjpeg v6b. This
774also invokes the TurboJPEG unit tests, which ensure that the colorspace
775extensions, YUV encoding, decompression scaling, and other features of the
776TurboJPEG C and Java APIs are working properly (and, by extension, that the
777equivalent features of the underlying libjpeg API are also working.)
778
779Invoking 'make testclean' or 'nmake testclean' (if using NMake) or building
780the 'testclean' target (if using the Visual Studio IDE) will clean up the
781output images generated by 'make test'.
782
DRC5039d732013-01-21 23:42:12 +0000783On Unix/Linux platforms, more extensive tests of the TurboJPEG C and Java
DRC9cd4e4b2012-01-31 07:56:44 +0000784wrappers can be run by invoking 'make tjtest'. These extended TurboJPEG tests
785essentially iterate through all of the available features of the TurboJPEG APIs
786that are not covered by the TurboJPEG unit tests (this includes the lossless
787transform options) and compare the images generated by each feature to images
788generated using the equivalent feature in the libjpeg API. The extended
789TurboJPEG tests are meant to test for regressions in the TurboJPEG wrappers,
DRC5039d732013-01-21 23:42:12 +0000790not in the underlying libjpeg API library.