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