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