DOOM-3-BFG

DOOM 3 BFG Edition
Log | Files | Refs

jmorecfg.h (11920B)


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