jerror.h

00001 /*
00002  * jerror.h
00003  *
00004  * Copyright (C) 1994-1997, Thomas G. Lane.
00005  * Modified 1997-2012 by Guido Vollbeding.
00006  * This file is part of the Independent JPEG Group's software.
00007  * For conditions of distribution and use, see the accompanying README file.
00008  *
00009  * This file defines the error and message codes for the JPEG library.
00010  * Edit this file to add new codes, or to translate the message strings to
00011  * some other language.
00012  * A set of error-reporting macros are defined too.  Some applications using
00013  * the JPEG library may wish to include this file to get the error codes
00014  * and/or the macros.
00015  */
00016 
00017 /*
00018  * To define the enum list of message codes, include this file without
00019  * defining macro JMESSAGE.  To create a message string table, include it
00020  * again with a suitable JMESSAGE definition (see jerror.c for an example).
00021  */
00022 #ifndef JMESSAGE
00023 #ifndef JERROR_H
00024 /* First time through, define the enum list */
00025 #define JMAKE_ENUM_LIST
00026 #else
00027 /* Repeated inclusions of this file are no-ops unless JMESSAGE is defined */
00028 #define JMESSAGE(code,string)
00029 #endif /* JERROR_H */
00030 #endif /* JMESSAGE */
00031 
00032 #ifdef JMAKE_ENUM_LIST
00033 
00034 typedef enum {
00035 
00036 #define JMESSAGE(code,string)   code ,
00037 
00038 #endif /* JMAKE_ENUM_LIST */
00039 
00040 JMESSAGE(JMSG_NOMESSAGE, "Bogus message code %d") /* Must be first entry! */
00041 
00042 /* For maintenance convenience, list is alphabetical by message code name */
00043 JMESSAGE(JERR_BAD_ALIGN_TYPE, "ALIGN_TYPE is wrong, please fix")
00044 JMESSAGE(JERR_BAD_ALLOC_CHUNK, "MAX_ALLOC_CHUNK is wrong, please fix")
00045 JMESSAGE(JERR_BAD_BUFFER_MODE, "Bogus buffer control mode")
00046 JMESSAGE(JERR_BAD_COMPONENT_ID, "Invalid component ID %d in SOS")
00047 JMESSAGE(JERR_BAD_CROP_SPEC, "Invalid crop request")
00048 JMESSAGE(JERR_BAD_DCT_COEF, "DCT coefficient out of range")
00049 JMESSAGE(JERR_BAD_DCTSIZE, "DCT scaled block size %dx%d not supported")
00050 JMESSAGE(JERR_BAD_DROP_SAMPLING,
00051      "Component index %d: mismatching sampling ratio %d:%d, %d:%d, %c")
00052 JMESSAGE(JERR_BAD_HUFF_TABLE, "Bogus Huffman table definition")
00053 JMESSAGE(JERR_BAD_IN_COLORSPACE, "Bogus input colorspace")
00054 JMESSAGE(JERR_BAD_J_COLORSPACE, "Bogus JPEG colorspace")
00055 JMESSAGE(JERR_BAD_LENGTH, "Bogus marker length")
00056 JMESSAGE(JERR_BAD_LIB_VERSION,
00057      "Wrong JPEG library version: library is %d, caller expects %d")
00058 JMESSAGE(JERR_BAD_MCU_SIZE, "Sampling factors too large for interleaved scan")
00059 JMESSAGE(JERR_BAD_POOL_ID, "Invalid memory pool code %d")
00060 JMESSAGE(JERR_BAD_PRECISION, "Unsupported JPEG data precision %d")
00061 JMESSAGE(JERR_BAD_PROGRESSION,
00062      "Invalid progressive parameters Ss=%d Se=%d Ah=%d Al=%d")
00063 JMESSAGE(JERR_BAD_PROG_SCRIPT,
00064      "Invalid progressive parameters at scan script entry %d")
00065 JMESSAGE(JERR_BAD_SAMPLING, "Bogus sampling factors")
00066 JMESSAGE(JERR_BAD_SCAN_SCRIPT, "Invalid scan script at entry %d")
00067 JMESSAGE(JERR_BAD_STATE, "Improper call to JPEG library in state %d")
00068 JMESSAGE(JERR_BAD_STRUCT_SIZE,
00069      "JPEG parameter struct mismatch: library thinks size is %u, caller expects %u")
00070 JMESSAGE(JERR_BAD_VIRTUAL_ACCESS, "Bogus virtual array access")
00071 JMESSAGE(JERR_BUFFER_SIZE, "Buffer passed to JPEG library is too small")
00072 JMESSAGE(JERR_CANT_SUSPEND, "Suspension not allowed here")
00073 JMESSAGE(JERR_CCIR601_NOTIMPL, "CCIR601 sampling not implemented yet")
00074 JMESSAGE(JERR_COMPONENT_COUNT, "Too many color components: %d, max %d")
00075 JMESSAGE(JERR_CONVERSION_NOTIMPL, "Unsupported color conversion request")
00076 JMESSAGE(JERR_DAC_INDEX, "Bogus DAC index %d")
00077 JMESSAGE(JERR_DAC_VALUE, "Bogus DAC value 0x%x")
00078 JMESSAGE(JERR_DHT_INDEX, "Bogus DHT index %d")
00079 JMESSAGE(JERR_DQT_INDEX, "Bogus DQT index %d")
00080 JMESSAGE(JERR_EMPTY_IMAGE, "Empty JPEG image (DNL not supported)")
00081 JMESSAGE(JERR_EMS_READ, "Read from EMS failed")
00082 JMESSAGE(JERR_EMS_WRITE, "Write to EMS failed")
00083 JMESSAGE(JERR_EOI_EXPECTED, "Didn't expect more than one scan")
00084 JMESSAGE(JERR_FILE_READ, "Input file read error")
00085 JMESSAGE(JERR_FILE_WRITE, "Output file write error --- out of disk space?")
00086 JMESSAGE(JERR_FRACT_SAMPLE_NOTIMPL, "Fractional sampling not implemented yet")
00087 JMESSAGE(JERR_HUFF_CLEN_OVERFLOW, "Huffman code size table overflow")
00088 JMESSAGE(JERR_HUFF_MISSING_CODE, "Missing Huffman code table entry")
00089 JMESSAGE(JERR_IMAGE_TOO_BIG, "Maximum supported image dimension is %u pixels")
00090 JMESSAGE(JERR_INPUT_EMPTY, "Empty input file")
00091 JMESSAGE(JERR_INPUT_EOF, "Premature end of input file")
00092 JMESSAGE(JERR_MISMATCHED_QUANT_TABLE,
00093      "Cannot transcode due to multiple use of quantization table %d")
00094 JMESSAGE(JERR_MISSING_DATA, "Scan script does not transmit all data")
00095 JMESSAGE(JERR_MODE_CHANGE, "Invalid color quantization mode change")
00096 JMESSAGE(JERR_NOTIMPL, "Not implemented yet")
00097 JMESSAGE(JERR_NOT_COMPILED, "Requested feature was omitted at compile time")
00098 JMESSAGE(JERR_NO_ARITH_TABLE, "Arithmetic table 0x%02x was not defined")
00099 JMESSAGE(JERR_NO_BACKING_STORE, "Backing store not supported")
00100 JMESSAGE(JERR_NO_HUFF_TABLE, "Huffman table 0x%02x was not defined")
00101 JMESSAGE(JERR_NO_IMAGE, "JPEG datastream contains no image")
00102 JMESSAGE(JERR_NO_QUANT_TABLE, "Quantization table 0x%02x was not defined")
00103 JMESSAGE(JERR_NO_SOI, "Not a JPEG file: starts with 0x%02x 0x%02x")
00104 JMESSAGE(JERR_OUT_OF_MEMORY, "Insufficient memory (case %d)")
00105 JMESSAGE(JERR_QUANT_COMPONENTS,
00106      "Cannot quantize more than %d color components")
00107 JMESSAGE(JERR_QUANT_FEW_COLORS, "Cannot quantize to fewer than %d colors")
00108 JMESSAGE(JERR_QUANT_MANY_COLORS, "Cannot quantize to more than %d colors")
00109 JMESSAGE(JERR_SOF_BEFORE, "Invalid JPEG file structure: %s before SOF")
00110 JMESSAGE(JERR_SOF_DUPLICATE, "Invalid JPEG file structure: two SOF markers")
00111 JMESSAGE(JERR_SOF_NO_SOS, "Invalid JPEG file structure: missing SOS marker")
00112 JMESSAGE(JERR_SOF_UNSUPPORTED, "Unsupported JPEG process: SOF type 0x%02x")
00113 JMESSAGE(JERR_SOI_DUPLICATE, "Invalid JPEG file structure: two SOI markers")
00114 JMESSAGE(JERR_TFILE_CREATE, "Failed to create temporary file %s")
00115 JMESSAGE(JERR_TFILE_READ, "Read failed on temporary file")
00116 JMESSAGE(JERR_TFILE_SEEK, "Seek failed on temporary file")
00117 JMESSAGE(JERR_TFILE_WRITE,
00118      "Write failed on temporary file --- out of disk space?")
00119 JMESSAGE(JERR_TOO_LITTLE_DATA, "Application transferred too few scanlines")
00120 JMESSAGE(JERR_UNKNOWN_MARKER, "Unsupported marker type 0x%02x")
00121 JMESSAGE(JERR_VIRTUAL_BUG, "Virtual array controller messed up")
00122 JMESSAGE(JERR_WIDTH_OVERFLOW, "Image too wide for this implementation")
00123 JMESSAGE(JERR_XMS_READ, "Read from XMS failed")
00124 JMESSAGE(JERR_XMS_WRITE, "Write to XMS failed")
00125 JMESSAGE(JMSG_COPYRIGHT, JCOPYRIGHT)
00126 JMESSAGE(JMSG_VERSION, JVERSION)
00127 JMESSAGE(JTRC_16BIT_TABLES,
00128      "Caution: quantization tables are too coarse for baseline JPEG")
00129 JMESSAGE(JTRC_ADOBE,
00130      "Adobe APP14 marker: version %d, flags 0x%04x 0x%04x, transform %d")
00131 JMESSAGE(JTRC_APP0, "Unknown APP0 marker (not JFIF), length %u")
00132 JMESSAGE(JTRC_APP14, "Unknown APP14 marker (not Adobe), length %u")
00133 JMESSAGE(JTRC_DAC, "Define Arithmetic Table 0x%02x: 0x%02x")
00134 JMESSAGE(JTRC_DHT, "Define Huffman Table 0x%02x")
00135 JMESSAGE(JTRC_DQT, "Define Quantization Table %d  precision %d")
00136 JMESSAGE(JTRC_DRI, "Define Restart Interval %u")
00137 JMESSAGE(JTRC_EMS_CLOSE, "Freed EMS handle %u")
00138 JMESSAGE(JTRC_EMS_OPEN, "Obtained EMS handle %u")
00139 JMESSAGE(JTRC_EOI, "End Of Image")
00140 JMESSAGE(JTRC_HUFFBITS, "        %3d %3d %3d %3d %3d %3d %3d %3d")
00141 JMESSAGE(JTRC_JFIF, "JFIF APP0 marker: version %d.%02d, density %dx%d  %d")
00142 JMESSAGE(JTRC_JFIF_BADTHUMBNAILSIZE,
00143      "Warning: thumbnail image size does not match data length %u")
00144 JMESSAGE(JTRC_JFIF_EXTENSION,
00145      "JFIF extension marker: type 0x%02x, length %u")
00146 JMESSAGE(JTRC_JFIF_THUMBNAIL, "    with %d x %d thumbnail image")
00147 JMESSAGE(JTRC_MISC_MARKER, "Miscellaneous marker 0x%02x, length %u")
00148 JMESSAGE(JTRC_PARMLESS_MARKER, "Unexpected marker 0x%02x")
00149 JMESSAGE(JTRC_QUANTVALS, "        %4u %4u %4u %4u %4u %4u %4u %4u")
00150 JMESSAGE(JTRC_QUANT_3_NCOLORS, "Quantizing to %d = %d*%d*%d colors")
00151 JMESSAGE(JTRC_QUANT_NCOLORS, "Quantizing to %d colors")
00152 JMESSAGE(JTRC_QUANT_SELECTED, "Selected %d colors for quantization")
00153 JMESSAGE(JTRC_RECOVERY_ACTION, "At marker 0x%02x, recovery action %d")
00154 JMESSAGE(JTRC_RST, "RST%d")
00155 JMESSAGE(JTRC_SMOOTH_NOTIMPL,
00156      "Smoothing not supported with nonstandard sampling ratios")
00157 JMESSAGE(JTRC_SOF, "Start Of Frame 0x%02x: width=%u, height=%u, components=%d")
00158 JMESSAGE(JTRC_SOF_COMPONENT, "    Component %d: %dhx%dv q=%d")
00159 JMESSAGE(JTRC_SOI, "Start of Image")
00160 JMESSAGE(JTRC_SOS, "Start Of Scan: %d components")
00161 JMESSAGE(JTRC_SOS_COMPONENT, "    Component %d: dc=%d ac=%d")
00162 JMESSAGE(JTRC_SOS_PARAMS, "  Ss=%d, Se=%d, Ah=%d, Al=%d")
00163 JMESSAGE(JTRC_TFILE_CLOSE, "Closed temporary file %s")
00164 JMESSAGE(JTRC_TFILE_OPEN, "Opened temporary file %s")
00165 JMESSAGE(JTRC_THUMB_JPEG,
00166      "JFIF extension marker: JPEG-compressed thumbnail image, length %u")
00167 JMESSAGE(JTRC_THUMB_PALETTE,
00168      "JFIF extension marker: palette thumbnail image, length %u")
00169 JMESSAGE(JTRC_THUMB_RGB,
00170      "JFIF extension marker: RGB thumbnail image, length %u")
00171 JMESSAGE(JTRC_UNKNOWN_IDS,
00172      "Unrecognized component IDs %d %d %d, assuming YCbCr")
00173 JMESSAGE(JTRC_XMS_CLOSE, "Freed XMS handle %u")
00174 JMESSAGE(JTRC_XMS_OPEN, "Obtained XMS handle %u")
00175 JMESSAGE(JWRN_ADOBE_XFORM, "Unknown Adobe color transform code %d")
00176 JMESSAGE(JWRN_ARITH_BAD_CODE, "Corrupt JPEG data: bad arithmetic code")
00177 JMESSAGE(JWRN_BOGUS_PROGRESSION,
00178      "Inconsistent progression sequence for component %d coefficient %d")
00179 JMESSAGE(JWRN_EXTRANEOUS_DATA,
00180      "Corrupt JPEG data: %u extraneous bytes before marker 0x%02x")
00181 JMESSAGE(JWRN_HIT_MARKER, "Corrupt JPEG data: premature end of data segment")
00182 JMESSAGE(JWRN_HUFF_BAD_CODE, "Corrupt JPEG data: bad Huffman code")
00183 JMESSAGE(JWRN_JFIF_MAJOR, "Warning: unknown JFIF revision number %d.%02d")
00184 JMESSAGE(JWRN_JPEG_EOF, "Premature end of JPEG file")
00185 JMESSAGE(JWRN_MUST_RESYNC,
00186      "Corrupt JPEG data: found marker 0x%02x instead of RST%d")
00187 JMESSAGE(JWRN_NOT_SEQUENTIAL, "Invalid SOS parameters for sequential JPEG")
00188 JMESSAGE(JWRN_TOO_MUCH_DATA, "Application transferred too many scanlines")
00189 
00190 #ifdef JMAKE_ENUM_LIST
00191 
00192   JMSG_LASTMSGCODE
00193 } J_MESSAGE_CODE;
00194 
00195 #undef JMAKE_ENUM_LIST
00196 #endif /* JMAKE_ENUM_LIST */
00197 
00198 /* Zap JMESSAGE macro so that future re-inclusions do nothing by default */
00199 #undef JMESSAGE
00200 
00201 
00202 #ifndef JERROR_H
00203 #define JERROR_H
00204 
00205 /* Macros to simplify using the error and trace message stuff */
00206 /* The first parameter is either type of cinfo pointer */
00207 
00208 /* Fatal errors (print message and exit) */
00209 #define ERREXIT(cinfo,code)  \
00210   ((cinfo)->err->msg_code = (code), \
00211    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
00212 #define ERREXIT1(cinfo,code,p1)  \
00213   ((cinfo)->err->msg_code = (code), \
00214    (cinfo)->err->msg_parm.i[0] = (p1), \
00215    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
00216 #define ERREXIT2(cinfo,code,p1,p2)  \
00217   ((cinfo)->err->msg_code = (code), \
00218    (cinfo)->err->msg_parm.i[0] = (p1), \
00219    (cinfo)->err->msg_parm.i[1] = (p2), \
00220    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
00221 #define ERREXIT3(cinfo,code,p1,p2,p3)  \
00222   ((cinfo)->err->msg_code = (code), \
00223    (cinfo)->err->msg_parm.i[0] = (p1), \
00224    (cinfo)->err->msg_parm.i[1] = (p2), \
00225    (cinfo)->err->msg_parm.i[2] = (p3), \
00226    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
00227 #define ERREXIT4(cinfo,code,p1,p2,p3,p4)  \
00228   ((cinfo)->err->msg_code = (code), \
00229    (cinfo)->err->msg_parm.i[0] = (p1), \
00230    (cinfo)->err->msg_parm.i[1] = (p2), \
00231    (cinfo)->err->msg_parm.i[2] = (p3), \
00232    (cinfo)->err->msg_parm.i[3] = (p4), \
00233    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
00234 #define ERREXIT6(cinfo,code,p1,p2,p3,p4,p5,p6)  \
00235   ((cinfo)->err->msg_code = (code), \
00236    (cinfo)->err->msg_parm.i[0] = (p1), \
00237    (cinfo)->err->msg_parm.i[1] = (p2), \
00238    (cinfo)->err->msg_parm.i[2] = (p3), \
00239    (cinfo)->err->msg_parm.i[3] = (p4), \
00240    (cinfo)->err->msg_parm.i[4] = (p5), \
00241    (cinfo)->err->msg_parm.i[5] = (p6), \
00242    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
00243 #define ERREXITS(cinfo,code,str)  \
00244   ((cinfo)->err->msg_code = (code), \
00245    strncpy((cinfo)->err->msg_parm.s, (str), JMSG_STR_PARM_MAX), \
00246    (*(cinfo)->err->error_exit) ((j_common_ptr) (cinfo)))
00247 
00248 #define MAKESTMT(stuff)     do { stuff } while (0)
00249 
00250 /* Nonfatal errors (we can keep going, but the data is probably corrupt) */
00251 #define WARNMS(cinfo,code)  \
00252   ((cinfo)->err->msg_code = (code), \
00253    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), -1))
00254 #define WARNMS1(cinfo,code,p1)  \
00255   ((cinfo)->err->msg_code = (code), \
00256    (cinfo)->err->msg_parm.i[0] = (p1), \
00257    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), -1))
00258 #define WARNMS2(cinfo,code,p1,p2)  \
00259   ((cinfo)->err->msg_code = (code), \
00260    (cinfo)->err->msg_parm.i[0] = (p1), \
00261    (cinfo)->err->msg_parm.i[1] = (p2), \
00262    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), -1))
00263 
00264 /* Informational/debugging messages */
00265 #define TRACEMS(cinfo,lvl,code)  \
00266   ((cinfo)->err->msg_code = (code), \
00267    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)))
00268 #define TRACEMS1(cinfo,lvl,code,p1)  \
00269   ((cinfo)->err->msg_code = (code), \
00270    (cinfo)->err->msg_parm.i[0] = (p1), \
00271    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)))
00272 #define TRACEMS2(cinfo,lvl,code,p1,p2)  \
00273   ((cinfo)->err->msg_code = (code), \
00274    (cinfo)->err->msg_parm.i[0] = (p1), \
00275    (cinfo)->err->msg_parm.i[1] = (p2), \
00276    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)))
00277 #define TRACEMS3(cinfo,lvl,code,p1,p2,p3)  \
00278   MAKESTMT(int * _mp = (cinfo)->err->msg_parm.i; \
00279        _mp[0] = (p1); _mp[1] = (p2); _mp[2] = (p3); \
00280        (cinfo)->err->msg_code = (code); \
00281        (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)); )
00282 #define TRACEMS4(cinfo,lvl,code,p1,p2,p3,p4)  \
00283   MAKESTMT(int * _mp = (cinfo)->err->msg_parm.i; \
00284        _mp[0] = (p1); _mp[1] = (p2); _mp[2] = (p3); _mp[3] = (p4); \
00285        (cinfo)->err->msg_code = (code); \
00286        (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)); )
00287 #define TRACEMS5(cinfo,lvl,code,p1,p2,p3,p4,p5)  \
00288   MAKESTMT(int * _mp = (cinfo)->err->msg_parm.i; \
00289        _mp[0] = (p1); _mp[1] = (p2); _mp[2] = (p3); _mp[3] = (p4); \
00290        _mp[4] = (p5); \
00291        (cinfo)->err->msg_code = (code); \
00292        (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)); )
00293 #define TRACEMS8(cinfo,lvl,code,p1,p2,p3,p4,p5,p6,p7,p8)  \
00294   MAKESTMT(int * _mp = (cinfo)->err->msg_parm.i; \
00295        _mp[0] = (p1); _mp[1] = (p2); _mp[2] = (p3); _mp[3] = (p4); \
00296        _mp[4] = (p5); _mp[5] = (p6); _mp[6] = (p7); _mp[7] = (p8); \
00297        (cinfo)->err->msg_code = (code); \
00298        (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)); )
00299 #define TRACEMSS(cinfo,lvl,code,str)  \
00300   ((cinfo)->err->msg_code = (code), \
00301    strncpy((cinfo)->err->msg_parm.s, (str), JMSG_STR_PARM_MAX), \
00302    (*(cinfo)->err->emit_message) ((j_common_ptr) (cinfo), (lvl)))
00303 
00304 #endif /* JERROR_H */