Fixed binary search: no more infinite loops when vendor is unknown.
[tangerine.git] / compiler / libjpeg / main / jmorecfg.h
blob2665b72953ce445d31bf62c9ff682a9898bc93df
1 /*
2 $Id$
3 */
5 /*
6 * jmorecfg.h
8 * Copyright (C) 1991-1998, Thomas G. Lane.
9 * This file is part of the Independent JPEG Group's software.
10 * For conditions of distribution and use, see the accompanying README file.
12 * This file contains additional configuration options that customize the
13 * JPEG software for special applications or support machine-dependent
14 * optimizations. Most users will not need to touch this file.
19 * Define BITS_IN_JSAMPLE as either
20 * 8 for 8-bit sample values (the usual setting)
21 * 12 for 12-bit sample values
22 * Only 8 and 12 are legal data precisions for lossy JPEG according to the
23 * JPEG standard, and the IJG code does not support anything else!
24 * We do not support run-time selection of data precision, sorry.
27 #define BITS_IN_JSAMPLE 8 /* use 8 or 12 */
31 * Maximum number of components (color channels) allowed in JPEG image.
32 * To meet the letter of the JPEG spec, set this to 255. However, darn
33 * few applications need more than 4 channels (maybe 5 for CMYK + alpha
34 * mask). We recommend 10 as a reasonable compromise; use 4 if you are
35 * really short on memory. (Each allowed component costs a hundred or so
36 * bytes of storage, whether actually used in an image or not.)
39 #define MAX_COMPONENTS 10 /* maximum number of image components */
43 * Basic data types.
44 * You may need to change these if you have a machine with unusual data
45 * type sizes; for example, "char" not 8 bits, "short" not 16 bits,
46 * or "long" not 32 bits. We don't care whether "int" is 16 or 32 bits,
47 * but it had better be at least 16.
50 /* Representation of a single sample (pixel element value).
51 * We frequently allocate large arrays of these, so it's important to keep
52 * them small. But if you have memory to burn and access to char or short
53 * arrays is very slow on your hardware, you might want to change these.
56 #if BITS_IN_JSAMPLE == 8
57 /* JSAMPLE should be the smallest type that will hold the values 0..255.
58 * You can use a signed char by having GETJSAMPLE mask it with 0xFF.
61 #ifdef HAVE_UNSIGNED_CHAR
63 typedef unsigned char JSAMPLE;
64 #define GETJSAMPLE(value) ((int) (value))
66 #else /* not HAVE_UNSIGNED_CHAR */
68 typedef char JSAMPLE;
69 #ifdef CHAR_IS_UNSIGNED
70 #define GETJSAMPLE(value) ((int) (value))
71 #else
72 #define GETJSAMPLE(value) ((int) (value) & 0xFF)
73 #endif /* CHAR_IS_UNSIGNED */
75 #endif /* HAVE_UNSIGNED_CHAR */
77 #define MAXJSAMPLE 255
78 #define CENTERJSAMPLE 128
80 #endif /* BITS_IN_JSAMPLE == 8 */
83 #if BITS_IN_JSAMPLE == 12
84 /* JSAMPLE should be the smallest type that will hold the values 0..4095.
85 * On nearly all machines "short" will do nicely.
88 typedef short JSAMPLE;
89 #define GETJSAMPLE(value) ((int) (value))
91 #define MAXJSAMPLE 4095
92 #define CENTERJSAMPLE 2048
94 #endif /* BITS_IN_JSAMPLE == 12 */
97 #if BITS_IN_JSAMPLE == 16
98 /* JSAMPLE should be the smallest type that will hold the values 0..65535.
99 * You can use a signed short by having GETJSAMPLE mask it with 0xFFFF.
102 #ifdef HAVE_UNSIGNED_SHORT
104 typedef unsigned short JSAMPLE;
105 #define GETJSAMPLE(value) ((int) (value))
107 #else /* not HAVE_UNSIGNED_SHORT */
109 typedef short JSAMPLE;
110 #ifdef SHORT_IS_UNSIGNED
111 #define GETJSAMPLE(value) ((int) (value))
112 #else
113 #define GETJSAMPLE(value) ((int) (value) & 0xFFFF)
114 #endif /* SHORT_IS_UNSIGNED */
116 #endif /* HAVE_UNSIGNED_SHORT */
118 #define MAXJSAMPLE 65535
119 #define CENTERJSAMPLE 32768
121 #endif /* BITS_IN_JSAMPLE == 16 */
124 /* Representation of a DCT frequency coefficient.
125 * This should be a signed value of at least 16 bits; "short" is usually OK.
126 * Again, we allocate large arrays of these, but you can change to int
127 * if you have memory to burn and "short" is really slow.
130 typedef short JCOEF;
133 /* Representation of a spatial difference value.
134 * This should be a signed value of at least 16 bits; int is usually OK.
137 typedef int JDIFF;
140 /* Compressed datastreams are represented as arrays of JOCTET.
141 * These must be EXACTLY 8 bits wide, at least once they are written to
142 * external storage. Note that when using the stdio data source/destination
143 * managers, this is also the data type passed to fread/fwrite.
146 #ifdef HAVE_UNSIGNED_CHAR
148 typedef unsigned char JOCTET;
149 #define GETJOCTET(value) (value)
151 #else /* not HAVE_UNSIGNED_CHAR */
153 typedef char JOCTET;
154 #ifdef CHAR_IS_UNSIGNED
155 #define GETJOCTET(value) (value)
156 #else
157 #define GETJOCTET(value) ((value) & 0xFF)
158 #endif /* CHAR_IS_UNSIGNED */
160 #endif /* HAVE_UNSIGNED_CHAR */
163 /* These typedefs are used for various table entries and so forth.
164 * They must be at least as wide as specified; but making them too big
165 * won't cost a huge amount of memory, so we don't provide special
166 * extraction code like we did for JSAMPLE. (In other words, these
167 * typedefs live at a different point on the speed/space tradeoff curve.)
170 /* UINT8 must hold at least the values 0..255. */
172 #ifdef HAVE_UNSIGNED_CHAR
173 typedef unsigned char UINT8;
174 #else /* not HAVE_UNSIGNED_CHAR */
175 #ifdef CHAR_IS_UNSIGNED
176 typedef char UINT8;
177 #else /* not CHAR_IS_UNSIGNED */
178 typedef short UINT8;
179 #endif /* CHAR_IS_UNSIGNED */
180 #endif /* HAVE_UNSIGNED_CHAR */
182 /* UINT16 must hold at least the values 0..65535. */
184 #ifdef HAVE_UNSIGNED_SHORT
185 typedef unsigned short UINT16;
186 #else /* not HAVE_UNSIGNED_SHORT */
187 typedef unsigned int UINT16;
188 #endif /* HAVE_UNSIGNED_SHORT */
190 /* INT16 must hold at least the values -32768..32767. */
192 #ifndef XMD_H /* X11/xmd.h correctly defines INT16 */
193 typedef short INT16;
194 #endif
196 /* INT32 must hold at least signed 32-bit values. */
198 #ifndef XMD_H /* X11/xmd.h correctly defines INT32 */
199 typedef long INT32;
200 #endif
202 /* Datatype used for image dimensions. The JPEG standard only supports
203 * images up to 64K*64K due to 16-bit fields in SOF markers. Therefore
204 * "unsigned int" is sufficient on all machines. However, if you need to
205 * handle larger images and you don't mind deviating from the spec, you
206 * can change this datatype.
209 typedef unsigned int JDIMENSION;
211 #define JPEG_MAX_DIMENSION 65500L /* a tad under 64K to prevent overflows */
214 /* These macros are used in all function definitions and extern declarations.
215 * You could modify them if you need to change function linkage conventions;
216 * in particular, you'll need to do that to make the library a Windows DLL.
217 * Another application is to make all functions global for use with debuggers
218 * or code profilers that require it.
221 /* a function called through method pointers: */
222 #define METHODDEF(type) static type
223 /* a function used only in its module: */
224 #define LOCAL(type) static type
225 /* a function referenced thru EXTERNs: */
226 #define JGLOBAL(type) type
227 /* a reference to a JGLOBAL function: */
228 #define JEXTERN(type) extern type
231 /* This macro is used to declare a "method", that is, a function pointer.
232 * We want to supply prototype parameters if the compiler can cope.
233 * Note that the arglist parameter must be parenthesized!
234 * Again, you can customize this if you need special linkage keywords.
237 #ifdef HAVE_PROTOTYPES
238 #define JMETHOD(type,methodname,arglist) type (*methodname) arglist
239 #else
240 #define JMETHOD(type,methodname,arglist) type (*methodname) ()
241 #endif
244 /* Here is the pseudo-keyword for declaring pointers that must be "far"
245 * on 80x86 machines. Most of the specialized coding for 80x86 is handled
246 * by just saying "FAR *" where such a pointer is needed. In a few places
247 * explicit coding is needed; see uses of the NEED_FAR_POINTERS symbol.
250 #ifdef NEED_FAR_POINTERS
251 #define FAR far
252 #else
253 #define FAR
254 #endif
258 * On a few systems, type boolean and/or its values FALSE, TRUE may appear
259 * in standard header files. Or you may have conflicts with application-
260 * specific header files that you want to include together with these files.
261 * Defining HAVE_BOOLEAN before including jpeglib.h should make it work.
264 #ifndef HAVE_BOOLEAN
265 typedef int boolean;
266 #endif
267 #ifndef FALSE /* in case these macros already exist */
268 #define FALSE 0 /* values of boolean */
269 #endif
270 #ifndef TRUE
271 #define TRUE 1
272 #endif
276 * The remaining options affect code selection within the JPEG library,
277 * but they don't need to be visible to most applications using the library.
278 * To minimize application namespace pollution, the symbols won't be
279 * defined unless JPEG_INTERNALS or JPEG_INTERNAL_OPTIONS has been defined.
282 #ifdef JPEG_INTERNALS
283 #define JPEG_INTERNAL_OPTIONS
284 #endif
286 #ifdef JPEG_INTERNAL_OPTIONS
290 * These defines indicate whether to include various optional functions.
291 * Undefining some of these symbols will produce a smaller but less capable
292 * library. Note that you can leave certain source files out of the
293 * compilation/linking process if you've #undef'd the corresponding symbols.
294 * (You may HAVE to do that if your compiler doesn't like null source files.)
297 /* Arithmetic coding is unsupported for legal reasons. Complaints to IBM. */
299 /* Capability options common to encoder and decoder: */
301 #define DCT_ISLOW_SUPPORTED /* slow but accurate integer algorithm */
302 #define DCT_IFAST_SUPPORTED /* faster, less accurate integer method */
303 #define DCT_FLOAT_SUPPORTED /* floating-point: accurate, fast on fast HW */
305 /* Encoder capability options: */
307 #undef C_ARITH_CODING_SUPPORTED /* Arithmetic coding back end? */
308 #define C_MULTISCAN_FILES_SUPPORTED /* Multiple-scan JPEG files? */
309 #define C_PROGRESSIVE_SUPPORTED /* Progressive JPEG? (Requires MULTISCAN)*/
310 #define C_LOSSLESS_SUPPORTED /* Lossless JPEG? */
311 #define ENTROPY_OPT_SUPPORTED /* Optimization of entropy coding parms? */
312 /* Note: if you selected 12-bit data precision, it is dangerous to turn off
313 * ENTROPY_OPT_SUPPORTED. The standard Huffman tables are only good for 8-bit
314 * precision, so jcshuff.c normally uses entropy optimization to compute
315 * usable tables for higher precision. If you don't want to do optimization,
316 * you'll have to supply different default Huffman tables.
317 * The exact same statements apply for progressive and lossless JPEG:
318 * the default tables don't work for progressive mode or lossless mode.
319 * (This may get fixed, however.)
321 #define INPUT_SMOOTHING_SUPPORTED /* Input image smoothing option? */
323 /* Decoder capability options: */
325 #undef D_ARITH_CODING_SUPPORTED /* Arithmetic coding back end? */
326 #define D_MULTISCAN_FILES_SUPPORTED /* Multiple-scan JPEG files? */
327 #define D_PROGRESSIVE_SUPPORTED /* Progressive JPEG? (Requires MULTISCAN)*/
328 #define D_LOSSLESS_SUPPORTED /* Lossless JPEG? */
329 #define SAVE_MARKERS_SUPPORTED /* jpeg_save_markers() needed? */
330 #define BLOCK_SMOOTHING_SUPPORTED /* Block smoothing? (Progressive only) */
331 #define IDCT_SCALING_SUPPORTED /* Output rescaling via IDCT? */
332 #undef UPSAMPLE_SCALING_SUPPORTED /* Output rescaling at upsample stage? */
333 #define UPSAMPLE_MERGING_SUPPORTED /* Fast path for sloppy upsampling? */
334 #define QUANT_1PASS_SUPPORTED /* 1-pass color quantization? */
335 #define QUANT_2PASS_SUPPORTED /* 2-pass color quantization? */
337 /* more capability options later, no doubt */
341 * Ordering of RGB data in scanlines passed to or from the application.
342 * If your application wants to deal with data in the order B,G,R, just
343 * change these macros. You can also deal with formats such as R,G,B,X
344 * (one extra byte per pixel) by changing RGB_PIXELSIZE. Note that changing
345 * the offsets will also change the order in which colormap data is organized.
346 * RESTRICTIONS:
347 * 1. The sample applications cjpeg,djpeg do NOT support modified RGB formats.
348 * 2. These macros only affect RGB<=>YCbCr color conversion, so they are not
349 * useful if you are using JPEG color spaces other than YCbCr or grayscale.
350 * 3. The color quantizer modules will not behave desirably if RGB_PIXELSIZE
351 * is not 3 (they don't understand about dummy color components!). So you
352 * can't use color quantization if you change that value.
355 #define RGB_RED 0 /* Offset of Red in an RGB scanline element */
356 #define RGB_GREEN 1 /* Offset of Green */
357 #define RGB_BLUE 2 /* Offset of Blue */
358 #define RGB_PIXELSIZE 3 /* JSAMPLEs per RGB scanline element */
361 /* Definitions for speed-related optimizations. */
364 /* If your compiler supports inline functions, define INLINE
365 * as the inline keyword; otherwise define it as empty.
368 #ifndef INLINE
369 #ifdef __GNUC__ /* for instance, GNU C knows about inline */
370 #define INLINE __inline__
371 #endif
372 #ifndef INLINE
373 #define INLINE /* default is to define it as empty */
374 #endif
375 #endif
378 /* On some machines (notably 68000 series) "int" is 32 bits, but multiplying
379 * two 16-bit shorts is faster than multiplying two ints. Define MULTIPLIER
380 * as short on such a machine. MULTIPLIER must be at least 16 bits wide.
383 #ifndef MULTIPLIER
384 #define MULTIPLIER int /* type for fastest integer multiply */
385 #endif
388 /* FAST_FLOAT should be either float or double, whichever is done faster
389 * by your compiler. (Note that this type is only used in the floating point
390 * DCT routines, so it only matters if you've defined DCT_FLOAT_SUPPORTED.)
391 * Typically, float is faster in ANSI C compilers, while double is faster in
392 * pre-ANSI compilers (because they insist on converting to double anyway).
393 * The code below therefore chooses float if we have ANSI-style prototypes.
396 #ifndef FAST_FLOAT
397 #ifdef HAVE_PROTOTYPES
398 #define FAST_FLOAT float
399 #else
400 #define FAST_FLOAT double
401 #endif
402 #endif
404 #endif /* JPEG_INTERNAL_OPTIONS */