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