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