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