libs/jpeg6/jdct.h

   1 /*
   2
   3  * jdct.h
   4
   5  *
   6
   7  * Copyright (C) 1994, Thomas G. Lane.
   8
   9  * This file is part of the Independent JPEG Group's software.
  10
  11  * For conditions of distribution and use, see the accompanying README file.
  12
  13  *
  14
  15  * This include file contains common declarations for the forward and
  16
  17  * inverse DCT modules.  These declarations are private to the DCT managers
  18
  19  * (jcdctmgr.c, jddctmgr.c) and the individual DCT algorithms.
  20
  21  * The individual DCT algorithms are kept in separate files to ease
  22
  23  * machine-dependent tuning (e.g., assembly coding).
  24
  25  */
  26
  27
  28
  29
  30
  31 /*
  32
  33  * A forward DCT routine is given a pointer to a work area of type DCTELEM[];
  34
  35  * the DCT is to be performed in-place in that buffer.  Type DCTELEM is int
  36
  37  * for 8-bit samples, INT32 for 12-bit samples.  (NOTE: Floating-point DCT
  38
  39  * implementations use an array of type FAST_FLOAT, instead.)
  40
  41  * The DCT inputs are expected to be signed (range +-CENTERJSAMPLE).
  42
  43  * The DCT outputs are returned scaled up by a factor of 8; they therefore
  44
  45  * have a range of +-8K for 8-bit data, +-128K for 12-bit data.  This
  46
  47  * convention improves accuracy in integer implementations and saves some
  48
  49  * work in floating-point ones.
  50
  51  * Quantization of the output coefficients is done by jcdctmgr.c.
  52
  53  */
  54
  55
  56
  57 #if BITS_IN_JSAMPLE == 8
  58
  59 typedef int DCTELEM;            /* 16 or 32 bits is fine */
  60
  61 #else
  62
  63 typedef INT32 DCTELEM;          /* must have 32 bits */
  64
  65 #endif
  66
  67
  68
  69 typedef JMETHOD(void, forward_DCT_method_ptr, (DCTELEM * data));
  70
  71 typedef JMETHOD(void, float_DCT_method_ptr, (FAST_FLOAT * data));
  72
  73
  74
  75
  76
  77 /*
  78
  79  * An inverse DCT routine is given a pointer to the input JBLOCK and a pointer
  80
  81  * to an output sample array.  The routine must dequantize the input data as
  82
  83  * well as perform the IDCT; for dequantization, it uses the multiplier table
  84
  85  * pointed to by compptr->dct_table.  The output data is to be placed into the
  86
  87  * sample array starting at a specified column.  (Any row offset needed will
  88
  89  * be applied to the array pointer before it is passed to the IDCT code.)
  90
  91  * Note that the number of samples emitted by the IDCT routine is
  92
  93  * DCT_scaled_size * DCT_scaled_size.
  94
  95  */
  96
  97
  98
  99 /* typedef inverse_DCT_method_ptr is declared in jpegint.h */
 100
 101
 102
 103 /*
 104
 105  * Each IDCT routine has its own ideas about the best dct_table element type.
 106
 107  */
 108
 109
 110
 111 typedef MULTIPLIER ISLOW_MULT_TYPE; /* short or int, whichever is faster */
 112
 113 #if BITS_IN_JSAMPLE == 8
 114
 115 typedef MULTIPLIER IFAST_MULT_TYPE; /* 16 bits is OK, use short if faster */
 116
 117 #define IFAST_SCALE_BITS  2     /* fractional bits in scale factors */
 118
 119 #else
 120
 121 typedef INT32 IFAST_MULT_TYPE;  /* need 32 bits for scaled quantizers */
 122
 123 #define IFAST_SCALE_BITS  13    /* fractional bits in scale factors */
 124
 125 #endif
 126
 127 typedef FAST_FLOAT FLOAT_MULT_TYPE; /* preferred floating type */
 128
 129
 130
 131
 132
 133 /*
 134
 135  * Each IDCT routine is responsible for range-limiting its results and
 136
 137  * converting them to unsigned form (0..MAXJSAMPLE).  The raw outputs could
 138
 139  * be quite far out of range if the input data is corrupt, so a bulletproof
 140
 141  * range-limiting step is required.  We use a mask-and-table-lookup method
 142
 143  * to do the combined operations quickly.  See the comments with
 144
 145  * prepare_range_limit_table (in jdmaster.c) for more info.
 146
 147  */
 148
 149
 150
 151 #define IDCT_range_limit(cinfo)  ((cinfo)->sample_range_limit + CENTERJSAMPLE)
 152
 153
 154
 155 #define RANGE_MASK  (MAXJSAMPLE * 4 + 3) /* 2 bits wider than legal samples */
 156
 157
 158
 159
 160
 161 /* Short forms of external names for systems with brain-damaged linkers. */
 162
 163
 164
 165 #ifdef NEED_SHORT_EXTERNAL_NAMES
 166
 167 #define jpeg_fdct_islow         jFDislow
 168
 169 #define jpeg_fdct_ifast         jFDifast
 170
 171 #define jpeg_fdct_float         jFDfloat
 172
 173 #define jpeg_idct_islow         jRDislow
 174
 175 #define jpeg_idct_ifast         jRDifast
 176
 177 #define jpeg_idct_float         jRDfloat
 178
 179 #define jpeg_idct_4x4           jRD4x4
 180
 181 #define jpeg_idct_2x2           jRD2x2
 182
 183 #define jpeg_idct_1x1           jRD1x1
 184
 185 #endif /* NEED_SHORT_EXTERNAL_NAMES */
 186
 187
 188
 189 /* Extern declarations for the forward and inverse DCT routines. */
 190
 191
 192
 193 EXTERN void jpeg_fdct_islow JPP((DCTELEM * data));
 194
 195 EXTERN void jpeg_fdct_ifast JPP((DCTELEM * data));
 196
 197 EXTERN void jpeg_fdct_float JPP((FAST_FLOAT * data));
 198
 199
 200
 201 EXTERN void jpeg_idct_islow
 202
 203     JPP((j_decompress_ptr cinfo, jpeg_component_info * compptr,
 204
 205          JCOEFPTR coef_block, JSAMPARRAY output_buf, JDIMENSION output_col));
 206
 207 EXTERN void jpeg_idct_ifast
 208
 209     JPP((j_decompress_ptr cinfo, jpeg_component_info * compptr,
 210
 211          JCOEFPTR coef_block, JSAMPARRAY output_buf, JDIMENSION output_col));
 212
 213 EXTERN void jpeg_idct_float
 214
 215     JPP((j_decompress_ptr cinfo, jpeg_component_info * compptr,
 216
 217          JCOEFPTR coef_block, JSAMPARRAY output_buf, JDIMENSION output_col));
 218
 219 EXTERN void jpeg_idct_4x4
 220
 221     JPP((j_decompress_ptr cinfo, jpeg_component_info * compptr,
 222
 223          JCOEFPTR coef_block, JSAMPARRAY output_buf, JDIMENSION output_col));
 224
 225 EXTERN void jpeg_idct_2x2
 226
 227     JPP((j_decompress_ptr cinfo, jpeg_component_info * compptr,
 228
 229          JCOEFPTR coef_block, JSAMPARRAY output_buf, JDIMENSION output_col));
 230
 231 EXTERN void jpeg_idct_1x1
 232
 233     JPP((j_decompress_ptr cinfo, jpeg_component_info * compptr,
 234
 235          JCOEFPTR coef_block, JSAMPARRAY output_buf, JDIMENSION output_col));
 236
 237
 238
 239
 240
 241 /*
 242
 243  * Macros for handling fixed-point arithmetic; these are used by many
 244
 245  * but not all of the DCT/IDCT modules.
 246
 247  *
 248
 249  * All values are expected to be of type INT32.
 250
 251  * Fractional constants are scaled left by CONST_BITS bits.
 252
 253  * CONST_BITS is defined within each module using these macros,
 254
 255  * and may differ from one module to the next.
 256
 257  */
 258
 259
 260
 261 #define ONE     ((INT32) 1)
 262
 263 #define CONST_SCALE (ONE << CONST_BITS)
 264
 265
 266
 267 /* Convert a positive real constant to an integer scaled by CONST_SCALE.
 268
 269  * Caution: some C compilers fail to reduce "FIX(constant)" at compile time,
 270
 271  * thus causing a lot of useless floating-point operations at run time.
 272
 273  */
 274
 275
 276
 277 #define FIX(x)  ((INT32) ((x) * CONST_SCALE + 0.5))
 278
 279
 280
 281 /* Descale and correctly round an INT32 value that's scaled by N bits.
 282
 283  * We assume RIGHT_SHIFT rounds towards minus infinity, so adding
 284
 285  * the fudge factor is correct for either sign of X.
 286
 287  */
 288
 289
 290
 291 #define DESCALE(x,n)  RIGHT_SHIFT((x) + (ONE << ((n)-1)), n)
 292
 293
 294
 295 /* Multiply an INT32 variable by an INT32 constant to yield an INT32 result.
 296
 297  * This macro is used only when the two inputs will actually be no more than
 298
 299  * 16 bits wide, so that a 16x16->32 bit multiply can be used instead of a
 300
 301  * full 32x32 multiply.  This provides a useful speedup on many machines.
 302
 303  * Unfortunately there is no way to specify a 16x16->32 multiply portably
 304
 305  * in C, but some C compilers will do the right thing if you provide the
 306
 307  * correct combination of casts.
 308
 309  */
 310
 311
 312
 313 #ifdef SHORTxSHORT_32           /* may work if 'int' is 32 bits */
 314
 315 #define MULTIPLY16C16(var,const)  (((INT16) (var)) * ((INT16) (const)))
 316
 317 #endif
 318
 319 #ifdef SHORTxLCONST_32          /* known to work with Microsoft C 6.0 */
 320
 321 #define MULTIPLY16C16(var,const)  (((INT16) (var)) * ((INT32) (const)))
 322
 323 #endif
 324
 325
 326
 327 #ifndef MULTIPLY16C16           /* default definition */
 328
 329 #define MULTIPLY16C16(var,const)  ((var) * (const))
 330
 331 #endif
 332
 333
 334
 335 /* Same except both inputs are variables. */
 336
 337
 338
 339 #ifdef SHORTxSHORT_32           /* may work if 'int' is 32 bits */
 340
 341 #define MULTIPLY16V16(var1,var2)  (((INT16) (var1)) * ((INT16) (var2)))
 342
 343 #endif
 344
 345
 346
 347 #ifndef MULTIPLY16V16           /* default definition */
 348
 349 #define MULTIPLY16V16(var1,var2)  ((var1) * (var2))
 350
 351 #endif
 352