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 * Modified 1997-2009 by Guido Vollbeding. 7 * libjpeg-turbo Modifications: 8 * Copyright (C) 2009, 2011, 2014-2015, D. R. Commander. 9 * For conditions of distribution and use, see the accompanying README.ijg 10 * file. 11 * 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. 15 */ 16 17 #include <stdint.h> 18 19 /* 20 * Maximum number of components (color channels) allowed in JPEG image. 21 * To meet the letter of the JPEG spec, set this to 255. However, darn 22 * few applications need more than 4 channels (maybe 5 for CMYK + alpha 23 * mask). We recommend 10 as a reasonable compromise; use 4 if you are 24 * really short on memory. (Each allowed component costs a hundred or so 25 * bytes of storage, whether actually used in an image or not.) 26 */ 27 28 #define MAX_COMPONENTS 10 /* maximum number of image components */ 29 30 31 /* 32 * Basic data types. 33 * You may need to change these if you have a machine with unusual data 34 * type sizes; for example, "char" not 8 bits, "short" not 16 bits, 35 * or "long" not 32 bits. We don't care whether "int" is 16 or 32 bits, 36 * but it had better be at least 16. 37 */ 38 39 /* Representation of a single sample (pixel element value). 40 * We frequently allocate large arrays of these, so it's important to keep 41 * them small. But if you have memory to burn and access to char or short 42 * arrays is very slow on your hardware, you might want to change these. 43 */ 44 45 #if BITS_IN_JSAMPLE == 8 46 /* JSAMPLE should be the smallest type that will hold the values 0..255. 47 * You can use a signed char by having GETJSAMPLE mask it with 0xFF. 48 */ 49 50 #ifdef HAVE_UNSIGNED_CHAR 51 52 typedef unsigned char JSAMPLE; 53 #define GETJSAMPLE(value) ((int) (value)) 54 55 #else /* not HAVE_UNSIGNED_CHAR */ 56 57 typedef char JSAMPLE; 58 #ifdef __CHAR_UNSIGNED__ 59 #define GETJSAMPLE(value) ((int) (value)) 60 #else 61 #define GETJSAMPLE(value) ((int) (value) & 0xFF) 62 #endif /* __CHAR_UNSIGNED__ */ 63 64 #endif /* HAVE_UNSIGNED_CHAR */ 65 66 #define MAXJSAMPLE 255 67 #define CENTERJSAMPLE 128 68 69 #endif /* BITS_IN_JSAMPLE == 8 */ 70 71 72 #if BITS_IN_JSAMPLE == 12 73 /* JSAMPLE should be the smallest type that will hold the values 0..4095. 74 * On nearly all machines "short" will do nicely. 75 */ 76 77 typedef short JSAMPLE; 78 #define GETJSAMPLE(value) ((int) (value)) 79 80 #define MAXJSAMPLE 4095 81 #define CENTERJSAMPLE 2048 82 83 #endif /* BITS_IN_JSAMPLE == 12 */ 84 85 86 /* Representation of a DCT frequency coefficient. 87 * This should be a signed value of at least 16 bits; "short" is usually OK. 88 * Again, we allocate large arrays of these, but you can change to int 89 * if you have memory to burn and "short" is really slow. 90 */ 91 92 typedef short JCOEF; 93 94 95 /* Compressed datastreams are represented as arrays of JOCTET. 96 * These must be EXACTLY 8 bits wide, at least once they are written to 97 * external storage. Note that when using the stdio data source/destination 98 * managers, this is also the data type passed to fread/fwrite. 99 */ 100 101 #ifdef HAVE_UNSIGNED_CHAR 102 103 typedef unsigned char JOCTET; 104 #define GETJOCTET(value) (value) 105 106 #else /* not HAVE_UNSIGNED_CHAR */ 107 108 typedef char JOCTET; 109 #ifdef __CHAR_UNSIGNED__ 110 #define GETJOCTET(value) (value) 111 #else 112 #define GETJOCTET(value) ((value) & 0xFF) 113 #endif /* __CHAR_UNSIGNED__ */ 114 115 #endif /* HAVE_UNSIGNED_CHAR */ 116 117 118 /* These typedefs are used for various table entries and so forth. 119 * They must be at least as wide as specified; but making them too big 120 * won't cost a huge amount of memory, so we don't provide special 121 * extraction code like we did for JSAMPLE. (In other words, these 122 * typedefs live at a different point on the speed/space tradeoff curve.) 123 */ 124 125 /* UINT8 must hold at least the values 0..255. */ 126 127 typedef uint8_t UINT8; 128 129 /* UINT16 must hold at least the values 0..65535. */ 130 131 typedef uint16_t UINT16; 132 133 /* INT16 must hold at least the values -32768..32767. */ 134 135 typedef int16_t INT16; 136 137 /* INT32 must hold at least signed 32-bit values. 138 * 139 * NOTE: The INT32 typedef dates back to libjpeg v5 (1994.) Integers were 140 * sometimes 16-bit back then (MS-DOS), which is why INT32 is typedef'd to 141 * long. It also wasn't common (or at least as common) in 1994 for INT32 to be 142 * defined by platform headers. Since then, however, INT32 is defined in 143 * several other common places: 144 * 145 * Xmd.h (X11 header) typedefs INT32 to int on 64-bit platforms and long on 146 * 32-bit platforms (i.e always a 32-bit signed type.) 147 * 148 * basetsd.h (Win32 header) typedefs INT32 to int (always a 32-bit signed type 149 * on modern platforms.) 150 * 151 * qglobal.h (Qt header) typedefs INT32 to int (always a 32-bit signed type on 152 * modern platforms.) 153 * 154 * This is a recipe for conflict, since "long" and "int" aren't always 155 * compatible types. Since the definition of INT32 has technically been part 156 * of the libjpeg API for more than 20 years, we can't remove it, but we do not 157 * use it internally any longer. We instead define a separate type (JLONG) 158 * for internal use, which ensures that internal behavior will always be the 159 * same regardless of any external headers that may be included. 160 */ 161 162 typedef int32_t INT32; 163 164 /* Datatype used for image dimensions. The JPEG standard only supports 165 * images up to 64K*64K due to 16-bit fields in SOF markers. Therefore 166 * "unsigned int" is sufficient on all machines. However, if you need to 167 * handle larger images and you don't mind deviating from the spec, you 168 * can change this datatype. (Note that changing this datatype will 169 * potentially require modifying the SIMD code. The x86-64 SIMD extensions, 170 * in particular, assume a 32-bit JDIMENSION.) 171 */ 172 173 typedef 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 /* Originally, this macro was used as a way of defining function prototypes 196 * for both modern compilers as well as older compilers that did not support 197 * prototype parameters. libjpeg-turbo has never supported these older, 198 * non-ANSI compilers, but the macro is still included because there is some 199 * software out there that uses it. 200 */ 201 202 #define JMETHOD(type,methodname,arglist) type (*methodname) arglist 203 204 205 /* libjpeg-turbo no longer supports platforms that have far symbols (MS-DOS), 206 * but again, some software relies on this macro. 207 */ 208 209 #undef FAR 210 #define FAR 211 212 213 /* 214 * On a few systems, type boolean and/or its values FALSE, TRUE may appear 215 * in standard header files. Or you may have conflicts with application- 216 * specific header files that you want to include together with these files. 217 * Defining HAVE_BOOLEAN before including jpeglib.h should make it work. 218 */ 219 220 #ifndef HAVE_BOOLEAN 221 typedef int boolean; 222 #endif 223 #ifndef FALSE /* in case these macros already exist */ 224 #define FALSE 0 /* values of boolean */ 225 #endif 226 #ifndef TRUE 227 #define TRUE 1 228 #endif 229 230 231 /* 232 * The remaining options affect code selection within the JPEG library, 233 * but they don't need to be visible to most applications using the library. 234 * To minimize application namespace pollution, the symbols won't be 235 * defined unless JPEG_INTERNALS or JPEG_INTERNAL_OPTIONS has been defined. 236 */ 237 238 #ifdef JPEG_INTERNALS 239 #define JPEG_INTERNAL_OPTIONS 240 #endif 241 242 #ifdef JPEG_INTERNAL_OPTIONS 243 244 245 /* 246 * These defines indicate whether to include various optional functions. 247 * Undefining some of these symbols will produce a smaller but less capable 248 * library. Note that you can leave certain source files out of the 249 * compilation/linking process if you've #undef'd the corresponding symbols. 250 * (You may HAVE to do that if your compiler doesn't like null source files.) 251 */ 252 253 /* Capability options common to encoder and decoder: */ 254 255 #define DCT_ISLOW_SUPPORTED /* slow but accurate integer algorithm */ 256 #define DCT_IFAST_SUPPORTED /* faster, less accurate integer method */ 257 #define DCT_FLOAT_SUPPORTED /* floating-point: accurate, fast on fast HW */ 258 259 /* Encoder capability options: */ 260 261 #define C_MULTISCAN_FILES_SUPPORTED /* Multiple-scan JPEG files? */ 262 #define C_PROGRESSIVE_SUPPORTED /* Progressive JPEG? (Requires MULTISCAN)*/ 263 #define ENTROPY_OPT_SUPPORTED /* Optimization of entropy coding parms? */ 264 /* Note: if you selected 12-bit data precision, it is dangerous to turn off 265 * ENTROPY_OPT_SUPPORTED. The standard Huffman tables are only good for 8-bit 266 * precision, so jchuff.c normally uses entropy optimization to compute 267 * usable tables for higher precision. If you don't want to do optimization, 268 * you'll have to supply different default Huffman tables. 269 * The exact same statements apply for progressive JPEG: the default tables 270 * don't work for progressive mode. (This may get fixed, however.) 271 */ 272 #define INPUT_SMOOTHING_SUPPORTED /* Input image smoothing option? */ 273 274 /* Decoder capability options: */ 275 276 #define D_MULTISCAN_FILES_SUPPORTED /* Multiple-scan JPEG files? */ 277 #define D_PROGRESSIVE_SUPPORTED /* Progressive JPEG? (Requires MULTISCAN)*/ 278 #define SAVE_MARKERS_SUPPORTED /* jpeg_save_markers() needed? */ 279 #define BLOCK_SMOOTHING_SUPPORTED /* Block smoothing? (Progressive only) */ 280 #define IDCT_SCALING_SUPPORTED /* Output rescaling via IDCT? */ 281 #undef UPSAMPLE_SCALING_SUPPORTED /* Output rescaling at upsample stage? */ 282 #define UPSAMPLE_MERGING_SUPPORTED /* Fast path for sloppy upsampling? */ 283 #define QUANT_1PASS_SUPPORTED /* 1-pass color quantization? */ 284 #define QUANT_2PASS_SUPPORTED /* 2-pass color quantization? */ 285 286 /* more capability options later, no doubt */ 287 288 289 /* 290 * The RGB_RED, RGB_GREEN, RGB_BLUE, and RGB_PIXELSIZE macros are a vestigial 291 * feature of libjpeg. The idea was that, if an application developer needed 292 * to compress from/decompress to a BGR/BGRX/RGBX/XBGR/XRGB buffer, they could 293 * change these macros, rebuild libjpeg, and link their application statically 294 * with it. In reality, few people ever did this, because there were some 295 * severe restrictions involved (cjpeg and djpeg no longer worked properly, 296 * compressing/decompressing RGB JPEGs no longer worked properly, and the color 297 * quantizer wouldn't work with pixel sizes other than 3.) Further, since all 298 * of the O/S-supplied versions of libjpeg were built with the default values 299 * of RGB_RED, RGB_GREEN, RGB_BLUE, and RGB_PIXELSIZE, many applications have 300 * come to regard these values as immutable. 301 * 302 * The libjpeg-turbo colorspace extensions provide a much cleaner way of 303 * compressing from/decompressing to buffers with arbitrary component orders 304 * and pixel sizes. Thus, we do not support changing the values of RGB_RED, 305 * RGB_GREEN, RGB_BLUE, or RGB_PIXELSIZE. In addition to the restrictions 306 * listed above, changing these values will also break the SIMD extensions and 307 * the regression tests. 308 */ 309 310 #define RGB_RED 0 /* Offset of Red in an RGB scanline element */ 311 #define RGB_GREEN 1 /* Offset of Green */ 312 #define RGB_BLUE 2 /* Offset of Blue */ 313 #define RGB_PIXELSIZE 3 /* JSAMPLEs per RGB scanline element */ 314 315 #define JPEG_NUMCS 17 316 317 #define EXT_RGB_RED 0 318 #define EXT_RGB_GREEN 1 319 #define EXT_RGB_BLUE 2 320 #define EXT_RGB_PIXELSIZE 3 321 322 #define EXT_RGBX_RED 0 323 #define EXT_RGBX_GREEN 1 324 #define EXT_RGBX_BLUE 2 325 #define EXT_RGBX_PIXELSIZE 4 326 327 #define EXT_BGR_RED 2 328 #define EXT_BGR_GREEN 1 329 #define EXT_BGR_BLUE 0 330 #define EXT_BGR_PIXELSIZE 3 331 332 #define EXT_BGRX_RED 2 333 #define EXT_BGRX_GREEN 1 334 #define EXT_BGRX_BLUE 0 335 #define EXT_BGRX_PIXELSIZE 4 336 337 #define EXT_XBGR_RED 3 338 #define EXT_XBGR_GREEN 2 339 #define EXT_XBGR_BLUE 1 340 #define EXT_XBGR_PIXELSIZE 4 341 342 #define EXT_XRGB_RED 1 343 #define EXT_XRGB_GREEN 2 344 #define EXT_XRGB_BLUE 3 345 #define EXT_XRGB_PIXELSIZE 4 346 347 static const int rgb_red[JPEG_NUMCS] = { 348 -1, -1, RGB_RED, -1, -1, -1, EXT_RGB_RED, EXT_RGBX_RED, 349 EXT_BGR_RED, EXT_BGRX_RED, EXT_XBGR_RED, EXT_XRGB_RED, 350 EXT_RGBX_RED, EXT_BGRX_RED, EXT_XBGR_RED, EXT_XRGB_RED, 351 -1 352 }; 353 354 static const int rgb_green[JPEG_NUMCS] = { 355 -1, -1, RGB_GREEN, -1, -1, -1, EXT_RGB_GREEN, EXT_RGBX_GREEN, 356 EXT_BGR_GREEN, EXT_BGRX_GREEN, EXT_XBGR_GREEN, EXT_XRGB_GREEN, 357 EXT_RGBX_GREEN, EXT_BGRX_GREEN, EXT_XBGR_GREEN, EXT_XRGB_GREEN, 358 -1 359 }; 360 361 static const int rgb_blue[JPEG_NUMCS] = { 362 -1, -1, RGB_BLUE, -1, -1, -1, EXT_RGB_BLUE, EXT_RGBX_BLUE, 363 EXT_BGR_BLUE, EXT_BGRX_BLUE, EXT_XBGR_BLUE, EXT_XRGB_BLUE, 364 EXT_RGBX_BLUE, EXT_BGRX_BLUE, EXT_XBGR_BLUE, EXT_XRGB_BLUE, 365 -1 366 }; 367 368 static const int rgb_pixelsize[JPEG_NUMCS] = { 369 -1, -1, RGB_PIXELSIZE, -1, -1, -1, EXT_RGB_PIXELSIZE, EXT_RGBX_PIXELSIZE, 370 EXT_BGR_PIXELSIZE, EXT_BGRX_PIXELSIZE, EXT_XBGR_PIXELSIZE, EXT_XRGB_PIXELSIZE, 371 EXT_RGBX_PIXELSIZE, EXT_BGRX_PIXELSIZE, EXT_XBGR_PIXELSIZE, EXT_XRGB_PIXELSIZE, 372 -1 373 }; 374 375 /* Definitions for speed-related optimizations. */ 376 377 /* On some machines (notably 68000 series) "int" is 32 bits, but multiplying 378 * two 16-bit shorts is faster than multiplying two ints. Define MULTIPLIER 379 * as short on such a machine. MULTIPLIER must be at least 16 bits wide. 380 */ 381 382 #ifndef MULTIPLIER 383 #ifndef WITH_SIMD 384 #define MULTIPLIER int /* type for fastest integer multiply */ 385 #else 386 #define MULTIPLIER short /* prefer 16-bit with SIMD for parellelism */ 387 #endif 388 #endif 389 390 391 /* FAST_FLOAT should be either float or double, whichever is done faster 392 * by your compiler. (Note that this type is only used in the floating point 393 * DCT routines, so it only matters if you've defined DCT_FLOAT_SUPPORTED.) 394 */ 395 396 #ifndef FAST_FLOAT 397 #define FAST_FLOAT float 398 #endif 399 400 #endif /* JPEG_INTERNAL_OPTIONS */ 401