jpeg/jerror.h

   1 /*
   2  * jerror.h
   3  *
   4  * Copyright (C) 1994-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 defines the error and message codes for the JPEG library.
   9  * Edit this file to add new codes, or to translate the message strings to
  10  * some other language.
  11  * A set of error-reporting macros are defined too.  Some applications using
  12  * the JPEG library may wish to include this file to get the error codes
  13  * and/or the macros.
  14  */
  15
  16 /*
  17  * To define the enum list of message codes, include this file without
  18  * defining macro JMESSAGE.  To create a message string table, include it
  19  * again with a suitable JMESSAGE definition (see jerror.c for an example).
  20  */
  21 #ifndef JMESSAGE
  22 #ifndef JERROR_H
  23 /* First time through, define the enum list */
  24 #define JMAKE_ENUM_LIST
  25 #else
  26 /* Repeated inclusions of this file are no-ops unless JMESSAGE is defined */
  27 #define JMESSAGE(code,string)
  28 #endif /* JERROR_H */
  29 #endif /* JMESSAGE */
  30
  31 #ifdef JMAKE_ENUM_LIST
  32
  33 typedef enum {
  34
  35 #define JMESSAGE(code,string)   code ,
  36
  37 #endif /* JMAKE_ENUM_LIST */
  38
  39 JMESSAGE(JMSG_NOMESSAGE, "Bogus message code %d") /* Must be first entry! */
  40
  41 /* For maintenance convenience, list is alphabetical by message code name */
  42 JMESSAGE(JERR_ARITH_NOTIMPL,
  43          "Sorry, there are legal restrictions on arithmetic coding")
  44 JMESSAGE(JERR_BAD_ALIGN_TYPE, "ALIGN_TYPE is wrong, please fix")
  45 JMESSAGE(JERR_BAD_ALLOC_CHUNK, "MAX_ALLOC_CHUNK is wrong, please fix")
  46 JMESSAGE(JERR_BAD_BUFFER_MODE, "Bogus buffer control mode")
  47 JMESSAGE(JERR_BAD_COMPONENT_ID, "Invalid component ID %d in SOS")
  48 JMESSAGE(JERR_BAD_DCT_COEF, "DCT coefficient out of range")
  49 JMESSAGE(JERR_BAD_DCTSIZE, "IDCT output block size %d not supported")
  50 JMESSAGE(JERR_BAD_HUFF_TABLE, "Bogus Huffman table definition")
  51 JMESSAGE(JERR_BAD_IN_COLORSPACE, "Bogus input colorspace")
  52 JMESSAGE(JERR_BAD_J_COLORSPACE, "Bogus JPEG colorspace")
  53 JMESSAGE(JERR_BAD_LENGTH, "Bogus marker length")
  54 JMESSAGE(JERR_BAD_LIB_VERSION,
  55          "Wrong JPEG library version: library is %d, caller expects %d")
  56 JMESSAGE(JERR_BAD_MCU_SIZE, "Sampling factors too large for interleaved scan")
  57 JMESSAGE(JERR_BAD_POOL_ID, "Invalid memory pool code %d")
  58 JMESSAGE(JERR_BAD_PRECISION, "Unsupported JPEG data precision %d")
  59 JMESSAGE(JERR_BAD_PROGRESSION,
  60          "Invalid progressive parameters Ss=%d Se=%d Ah=%d Al=%d")
  61 JMESSAGE(JERR_BAD_PROG_SCRIPT,
  62          "Invalid progressive parameters at scan script entry %d")
  63 JMESSAGE(JERR_BAD_SAMPLING, "Bogus sampling factors")
  64 JMESSAGE(JERR_BAD_SCAN_SCRIPT, "Invalid scan script at entry %d")
  65 JMESSAGE(JERR_BAD_STATE, "Improper call to JPEG library in state %d")
  66 JMESSAGE(JERR_BAD_STRUCT_SIZE,
  67          "JPEG parameter struct mismatch: library thinks size is %u, caller expects %u")
  68 JMESSAGE(JERR_BAD_VIRTUAL_ACCESS, "Bogus virtual array access")
  69 JMESSAGE(JERR_BUFFER_SIZE, "Buffer passed to JPEG library is too small")
  70 JMESSAGE(JERR_CANT_SUSPEND, "Suspension not allowed here")
  71 JMESSAGE(JERR_CCIR601_NOTIMPL, "CCIR601 sampling not implemented yet")
  72 JMESSAGE(JERR_COMPONENT_COUNT, "Too many color components: %d, max %d")
  73 JMESSAGE(JERR_CONVERSION_NOTIMPL, "Unsupported color conversion request")
  74 JMESSAGE(JERR_DAC_INDEX, "Bogus DAC index %d")
  75 JMESSAGE(JERR_DAC_VALUE, "Bogus DAC value 0x%x")
  76 JMESSAGE(JERR_DHT_INDEX, "Bogus DHT index %d")
  77 JMESSAGE(JERR_DQT_INDEX, "Bogus DQT index %d")
  78 JMESSAGE(JERR_EMPTY_IMAGE, "Empty JPEG image (DNL not supported)")
  79 JMESSAGE(JERR_EMS_READ, "Read from EMS failed")
  80 JMESSAGE(JERR_EMS_WRITE, "Write to EMS failed")
  81 JMESSAGE(JERR_EOI_EXPECTED, "Didn't expect more than one scan")
  82 JMESSAGE(JERR_FILE_READ, "Input file read error")
  83 JMESSAGE(JERR_FILE_WRITE, "Output file write error --- out of disk space?")
  84 JMESSAGE(JERR_FRACT_SAMPLE_NOTIMPL, "Fractional sampling not implemented yet")
  85 JMESSAGE(JERR_HUFF_CLEN_OVERFLOW, "Huffman code size table overflow")
  86 JMESSAGE(JERR_HUFF_MISSING_CODE, "Missing Huffman code table entry")
  87 JMESSAGE(JERR_IMAGE_TOO_BIG, "Maximum supported image dimension is %u pixels")
  88 JMESSAGE(JERR_INPUT_EMPTY, "Empty input file")
  89 JMESSAGE(JERR_INPUT_EOF, "Premature end of input file")
  90 JMESSAGE(JERR_MISMATCHED_QUANT_TABLE,
  91          "Cannot transcode due to multiple use of quantization table %d")
  92 JMESSAGE(JERR_MISSING_DATA, "Scan script does not transmit all data")
  93 JMESSAGE(JERR_MODE_CHANGE, "Invalid color quantization mode change")
  94 JMESSAGE(JERR_NOTIMPL, "Not implemented yet")
  95 JMESSAGE(JERR_NOT_COMPILED, "Requested feature was omitted at compile time")
  96 JMESSAGE(JERR_NO_BACKING_STORE, "Backing store not supported")
  97 JMESSAGE(JERR_NO_HUFF_TABLE, "Huffman table 0x%02x was not defined")
  98 JMESSAGE(JERR_NO_IMAGE, "JPEG datastream contains no image")
  99 JMESSAGE(JERR_NO_QUANT_TABLE, "Quantization table 0x%02x was not defined")
 100 JMESSAGE(JERR_NO_SOI, "Not a JPEG file: starts with 0x%02x 0x%02x")
 101 JMESSAGE(JERR_OUT_OF_MEMORY, "Insufficient memory (case %d)")
 102 JMESSAGE(JERR_QUANT_COMPONENTS,
 103          "Cannot quantize more than %d color components")
 104 JMESSAGE(JERR_QUANT_FEW_COLORS, "Cannot quantize to fewer than %d colors")
 105 JMESSAGE(JERR_QUANT_MANY_COLORS, "Cannot quantize to more than %d colors")
 106 JMESSAGE(JERR_SOF_DUPLICATE, "Invalid JPEG file structure: two SOF markers")
 107 JMESSAGE(JERR_SOF_NO_SOS, "Invalid JPEG file structure: missing SOS marker")
 108 JMESSAGE(JERR_SOF_UNSUPPORTED, "Unsupported JPEG process: SOF type 0x%02x")
 109 JMESSAGE(JERR_SOI_DUPLICATE, "Invalid JPEG file structure: two SOI markers")
 110 JMESSAGE(JERR_SOS_NO_SOF, "Invalid JPEG file structure: SOS before SOF")
 111 JMESSAGE(JERR_TFILE_CREATE, "Failed to create temporary file %s")
 112 JMESSAGE(JERR_TFILE_READ, "Read failed on temporary file")
 113 JMESSAGE(JERR_TFILE_SEEK, "Seek failed on temporary file")
 114 JMESSAGE(JERR_TFILE_WRITE,
 115          "Write failed on temporary file --- out of disk space?")
 116 JMESSAGE(JERR_TOO_LITTLE_DATA, "Application transferred too few scanlines")
 117 JMESSAGE(JERR_UNKNOWN_MARKER, "Unsupported marker type 0x%02x")
 118 JMESSAGE(JERR_VIRTUAL_BUG, "Virtual array controller messed up")
 119 JMESSAGE(JERR_WIDTH_OVERFLOW, "Image too wide for this implementation")
 120 JMESSAGE(JERR_XMS_READ, "Read from XMS failed")
 121 JMESSAGE(JERR_XMS_WRITE, "Write to XMS failed")
 122 JMESSAGE(JMSG_COPYRIGHT, JCOPYRIGHT)
 123 JMESSAGE(JMSG_VERSION, JVERSION)
 124 JMESSAGE(JTRC_16BIT_TABLES,
 125          "Caution: quantization tables are too coarse for baseline JPEG")
 126 JMESSAGE(JTRC_ADOBE,
 127          "Adobe APP14 marker: version %d, flags 0x%04x 0x%04x, transform %d")
 128 JMESSAGE(JTRC_APP0, "Unknown APP0 marker (not JFIF), length %u")
 129 JMESSAGE(JTRC_APP14, "Unknown APP14 marker (not Adobe), length %u")
 130 JMESSAGE(JTRC_DAC, "Define Arithmetic Table 0x%02x: 0x%02x")
 131 JMESSAGE(JTRC_DHT, "Define Huffman Table 0x%02x")
 132 JMESSAGE(JTRC_DQT, "Define Quantization Table %d  precision %d")
 133 JMESSAGE(JTRC_DRI, "Define Restart Interval %u")
 134 JMESSAGE(JTRC_EMS_CLOSE, "Freed EMS handle %u")
 135 JMESSAGE(JTRC_EMS_OPEN, "Obtained EMS handle %u")
 136 JMESSAGE(JTRC_EOI, "End Of Image")
 137 JMESSAGE(JTRC_HUFFBITS, "        %3d %3d %3d %3d %3d %3d %3d %3d")
 138 JMESSAGE(JTRC_JFIF, "JFIF APP0 marker: version %d.%02d, density %dx%d  %d")
 139 JMESSAGE(JTRC_JFIF_BADTHUMBNAILSIZE,
 140          "Warning: thumbnail image size does not match data length %u")
 141 JMESSAGE(JTRC_JFIF_EXTENSION,
 142          "JFIF extension marker: type 0x%02x, length %u")
 143 JMESSAGE(JTRC_JFIF_THUMBNAIL, "    with %d x %d thumbnail image")
 144 JMESSAGE(JTRC_MISC_MARKER, "Miscellaneous marker 0x%02x, length %u")
 145 JMESSAGE(JTRC_PARMLESS_MARKER, "Unexpected marker 0x%02x")
 146 JMESSAGE(JTRC_QUANTVALS, "        %4u %4u %4u %4u %4u %4u %4u %4u")
 147 JMESSAGE(JTRC_QUANT_3_NCOLORS, "Quantizing to %d = %d*%d*%d colors")
 148 JMESSAGE(JTRC_QUANT_NCOLORS, "Quantizing to %d colors")
 149 JMESSAGE(JTRC_QUANT_SELECTED, "Selected %d colors for quantization")
 150 JMESSAGE(JTRC_RECOVERY_ACTION, "At marker 0x%02x, recovery action %d")
 151 JMESSAGE(JTRC_RST, "RST%d")
 152 JMESSAGE(JTRC_SMOOTH_NOTIMPL,
 153          "Smoothing not supported with nonstandard sampling ratios")
 154 JMESSAGE(JTRC_SOF, "Start Of Frame 0x%02x: width=%u, height=%u, components=%d")
 155 JMESSAGE(JTRC_SOF_COMPONENT, "    Component %d: %dhx%dv q=%d")
 156 JMESSAGE(JTRC_SOI, "Start of Image")
 157 JMESSAGE(JTRC_SOS, "Start Of Scan: %d components")
 158 JMESSAGE(JTRC_SOS_COMPONENT, "    Component %d: dc=%d ac=%d")
 159 JMESSAGE(JTRC_SOS_PARAMS, "  Ss=%d, Se=%d, Ah=%d, Al=%d")
 160 JMESSAGE(JTRC_TFILE_CLOSE, "Closed temporary file %s")
 161 JMESSAGE(JTRC_TFILE_OPEN, "Opened temporary file %s")
 162 JMESSAGE(JTRC_THUMB_JPEG,
 163          "JFIF extension marker: JPEG-compressed thumbnail image, length %u")
 164 JMESSAGE(JTRC_THUMB_PALETTE,
 165          "JFIF extension marker: palette thumbnail image, length %u")
 166 JMESSAGE(JTRC_THUMB_RGB,
 167          "JFIF extension marker: RGB thumbnail image, length %u")
 168 JMESSAGE(JTRC_UNKNOWN_IDS,
 169          "Unrecognized component IDs %d %d %d, assuming YCbCr")
 170 JMESSAGE(JTRC_XMS_CLOSE, "Freed XMS handle %u")
 171 JMESSAGE(JTRC_XMS_OPEN, "Obtained XMS handle %u")
 172 JMESSAGE(JWRN_ADOBE_XFORM, "Unknown Adobe color transform code %d")
 173 JMESSAGE(JWRN_BOGUS_PROGRESSION,
 174          "Inconsistent progression sequence for component %d coefficient %d")
 175 JMESSAGE(JWRN_EXTRANEOUS_DATA,
 176          "Corrupt JPEG data: %u extraneous bytes before marker 0x%02x")
 177 JMESSAGE(JWRN_HIT_MARKER, "Corrupt JPEG data: premature end of data segment")
 178 JMESSAGE(JWRN_HUFF_BAD_CODE, "Corrupt JPEG data: bad Huffman code")
 179 JMESSAGE(JWRN_JFIF_MAJOR, "Warning: unknown JFIF revision number %d.%02d")
 180 JMESSAGE(JWRN_JPEG_EOF, "Premature end of JPEG file")
 181 JMESSAGE(JWRN_MUST_RESYNC,
 182          "Corrupt JPEG data: found marker 0x%02x instead of RST%d")
 183 JMESSAGE(JWRN_NOT_SEQUENTIAL, "Invalid SOS parameters for sequential JPEG")
 184 JMESSAGE(JWRN_TOO_MUCH_DATA, "Application transferred too many scanlines")
 185
 186 #ifdef JMAKE_ENUM_LIST
 187
 188   JMSG_LASTMSGCODE
 189 } J_MESSAGE_CODE;
 190
 191 #undef JMAKE_ENUM_LIST
 192 #endif /* JMAKE_ENUM_LIST */
 193
 194 /* Zap JMESSAGE macro so that future re-inclusions do nothing by default */
 195 #undef JMESSAGE
 196
 197
 198 #ifndef JERROR_H
 199 #define JERROR_H
 200
 201 /* Macros to simplify using the error and trace message stuff */
 202 /* The first parameter is either type of cinfo pointer */
 203
 204 /* Fatal errors (print message and exit) */
 205 #define ERREXIT(cinfo,code)  \
 206   ((cinfo)->err->msg_code = (code), \
 207    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
 208 #define ERREXIT1(cinfo,code,p1)  \
 209   ((cinfo)->err->msg_code = (code), \
 210    (cinfo)->err->msg_parm.i[0] = (p1), \
 211    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
 212 #define ERREXIT2(cinfo,code,p1,p2)  \
 213   ((cinfo)->err->msg_code = (code), \
 214    (cinfo)->err->msg_parm.i[0] = (p1), \
 215    (cinfo)->err->msg_parm.i[1] = (p2), \
 216    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
 217 #define ERREXIT3(cinfo,code,p1,p2,p3)  \
 218   ((cinfo)->err->msg_code = (code), \
 219    (cinfo)->err->msg_parm.i[0] = (p1), \
 220    (cinfo)->err->msg_parm.i[1] = (p2), \
 221    (cinfo)->err->msg_parm.i[2] = (p3), \
 222    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
 223 #define ERREXIT4(cinfo,code,p1,p2,p3,p4)  \
 224   ((cinfo)->err->msg_code = (code), \
 225    (cinfo)->err->msg_parm.i[0] = (p1), \
 226    (cinfo)->err->msg_parm.i[1] = (p2), \
 227    (cinfo)->err->msg_parm.i[2] = (p3), \
 228    (cinfo)->err->msg_parm.i[3] = (p4), \
 229    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
 230 #define ERREXITS(cinfo,code,str)  \
 231   ((cinfo)->err->msg_code = (code), \
 232    strncpy((cinfo)->err->msg_parm.s, (str), JMSG_STR_PARM_MAX), \
 233    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
 234
 235 #define MAKESTMT(stuff)         do { stuff } while (0)
 236
 237 /* Nonfatal errors (we can keep going, but the data is probably corrupt) */
 238 #define WARNMS(cinfo,code)  \
 239   ((cinfo)->err->msg_code = (code), \
 240    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), -1))
 241 #define WARNMS1(cinfo,code,p1)  \
 242   ((cinfo)->err->msg_code = (code), \
 243    (cinfo)->err->msg_parm.i[0] = (p1), \
 244    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), -1))
 245 #define WARNMS2(cinfo,code,p1,p2)  \
 246   ((cinfo)->err->msg_code = (code), \
 247    (cinfo)->err->msg_parm.i[0] = (p1), \
 248    (cinfo)->err->msg_parm.i[1] = (p2), \
 249    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), -1))
 250
 251 /* Informational/debugging messages */
 252 #define TRACEMS(cinfo,lvl,code)  \
 253   ((cinfo)->err->msg_code = (code), \
 254    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)))
 255 #define TRACEMS1(cinfo,lvl,code,p1)  \
 256   ((cinfo)->err->msg_code = (code), \
 257    (cinfo)->err->msg_parm.i[0] = (p1), \
 258    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)))
 259 #define TRACEMS2(cinfo,lvl,code,p1,p2)  \
 260   ((cinfo)->err->msg_code = (code), \
 261    (cinfo)->err->msg_parm.i[0] = (p1), \
 262    (cinfo)->err->msg_parm.i[1] = (p2), \
 263    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)))
 264 #define TRACEMS3(cinfo,lvl,code,p1,p2,p3)  \
 265   MAKESTMT(int * _mp = (cinfo)->err->msg_parm.i; \
 266            _mp[0] = (p1); _mp[1] = (p2); _mp[2] = (p3); \
 267            (cinfo)->err->msg_code = (code); \
 268            (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)); )
 269 #define TRACEMS4(cinfo,lvl,code,p1,p2,p3,p4)  \
 270   MAKESTMT(int * _mp = (cinfo)->err->msg_parm.i; \
 271            _mp[0] = (p1); _mp[1] = (p2); _mp[2] = (p3); _mp[3] = (p4); \
 272            (cinfo)->err->msg_code = (code); \
 273            (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)); )
 274 #define TRACEMS5(cinfo,lvl,code,p1,p2,p3,p4,p5)  \
 275   MAKESTMT(int * _mp = (cinfo)->err->msg_parm.i; \
 276            _mp[0] = (p1); _mp[1] = (p2); _mp[2] = (p3); _mp[3] = (p4); \
 277            _mp[4] = (p5); \
 278            (cinfo)->err->msg_code = (code); \
 279            (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)); )
 280 #define TRACEMS8(cinfo,lvl,code,p1,p2,p3,p4,p5,p6,p7,p8)  \
 281   MAKESTMT(int * _mp = (cinfo)->err->msg_parm.i; \
 282            _mp[0] = (p1); _mp[1] = (p2); _mp[2] = (p3); _mp[3] = (p4); \
 283            _mp[4] = (p5); _mp[5] = (p6); _mp[6] = (p7); _mp[7] = (p8); \
 284            (cinfo)->err->msg_code = (code); \
 285            (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)); )
 286 #define TRACEMSS(cinfo,lvl,code,str)  \
 287   ((cinfo)->err->msg_code = (code), \
 288    strncpy((cinfo)->err->msg_parm.s, (str), JMSG_STR_PARM_MAX), \
 289    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)))
 290
 291 #endif /* JERROR_H */