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
33typedef enum {
34
35#define JMESSAGE(code,string) code ,
36
37#endif /* JMAKE_ENUM_LIST */
38
39JMESSAGE(JMSG_NOMESSAGE, "Bogus message code %d") /* Must be first entry! */
40
41/* For maintenance convenience, list is alphabetical by message code name */
42JMESSAGE(JERR_ARITH_NOTIMPL,
43 "Sorry, there are legal restrictions on arithmetic coding")
44JMESSAGE(JERR_BAD_ALIGN_TYPE, "ALIGN_TYPE is wrong, please fix")
45JMESSAGE(JERR_BAD_ALLOC_CHUNK, "MAX_ALLOC_CHUNK is wrong, please fix")
46JMESSAGE(JERR_BAD_BUFFER_MODE, "Bogus buffer control mode")
47JMESSAGE(JERR_BAD_COMPONENT_ID, "Invalid component ID %d in SOS")
48JMESSAGE(JERR_BAD_DCT_COEF, "DCT coefficient out of range")
49JMESSAGE(JERR_BAD_DCTSIZE, "IDCT output block size %d not supported")
50JMESSAGE(JERR_BAD_HUFF_TABLE, "Bogus Huffman table definition")
51JMESSAGE(JERR_BAD_IN_COLORSPACE, "Bogus input colorspace")
52JMESSAGE(JERR_BAD_J_COLORSPACE, "Bogus JPEG colorspace")
53JMESSAGE(JERR_BAD_LENGTH, "Bogus marker length")
54JMESSAGE(JERR_BAD_LIB_VERSION,
55 "Wrong JPEG library version: library is %d, caller expects %d")
56JMESSAGE(JERR_BAD_MCU_SIZE, "Sampling factors too large for interleaved scan")
57JMESSAGE(JERR_BAD_POOL_ID, "Invalid memory pool code %d")
58JMESSAGE(JERR_BAD_PRECISION, "Unsupported JPEG data precision %d")
59JMESSAGE(JERR_BAD_PROGRESSION,
60 "Invalid progressive parameters Ss=%d Se=%d Ah=%d Al=%d")
61JMESSAGE(JERR_BAD_PROG_SCRIPT,
62 "Invalid progressive parameters at scan script entry %d")
63JMESSAGE(JERR_BAD_SAMPLING, "Bogus sampling factors")
64JMESSAGE(JERR_BAD_SCAN_SCRIPT, "Invalid scan script at entry %d")
65JMESSAGE(JERR_BAD_STATE, "Improper call to JPEG library in state %d")
66JMESSAGE(JERR_BAD_STRUCT_SIZE,
67 "JPEG parameter struct mismatch: library thinks size is %u, caller expects %u")
68JMESSAGE(JERR_BAD_VIRTUAL_ACCESS, "Bogus virtual array access")
69JMESSAGE(JERR_BUFFER_SIZE, "Buffer passed to JPEG library is too small")
70JMESSAGE(JERR_CANT_SUSPEND, "Suspension not allowed here")
71JMESSAGE(JERR_CCIR601_NOTIMPL, "CCIR601 sampling not implemented yet")
72JMESSAGE(JERR_COMPONENT_COUNT, "Too many color components: %d, max %d")
73JMESSAGE(JERR_CONVERSION_NOTIMPL, "Unsupported color conversion request")
74JMESSAGE(JERR_DAC_INDEX, "Bogus DAC index %d")
75JMESSAGE(JERR_DAC_VALUE, "Bogus DAC value 0x%x")
76JMESSAGE(JERR_DHT_INDEX, "Bogus DHT index %d")
77JMESSAGE(JERR_DQT_INDEX, "Bogus DQT index %d")
78JMESSAGE(JERR_EMPTY_IMAGE, "Empty JPEG image (DNL not supported)")
79JMESSAGE(JERR_EMS_READ, "Read from EMS failed")
80JMESSAGE(JERR_EMS_WRITE, "Write to EMS failed")
81JMESSAGE(JERR_EOI_EXPECTED, "Didn't expect more than one scan")
82JMESSAGE(JERR_FILE_READ, "Input file read error")
83JMESSAGE(JERR_FILE_WRITE, "Output file write error --- out of disk space?")
84JMESSAGE(JERR_FRACT_SAMPLE_NOTIMPL, "Fractional sampling not implemented yet")
85JMESSAGE(JERR_HUFF_CLEN_OVERFLOW, "Huffman code size table overflow")
86JMESSAGE(JERR_HUFF_MISSING_CODE, "Missing Huffman code table entry")
87JMESSAGE(JERR_IMAGE_TOO_BIG, "Maximum supported image dimension is %u pixels")
88JMESSAGE(JERR_INPUT_EMPTY, "Empty input file")
89JMESSAGE(JERR_INPUT_EOF, "Premature end of input file")
90JMESSAGE(JERR_MISMATCHED_QUANT_TABLE,
91 "Cannot transcode due to multiple use of quantization table %d")
92JMESSAGE(JERR_MISSING_DATA, "Scan script does not transmit all data")
93JMESSAGE(JERR_MODE_CHANGE, "Invalid color quantization mode change")
94JMESSAGE(JERR_NOTIMPL, "Not implemented yet")
95JMESSAGE(JERR_NOT_COMPILED, "Requested feature was omitted at compile time")
96JMESSAGE(JERR_NO_BACKING_STORE, "Backing store not supported")
97JMESSAGE(JERR_NO_HUFF_TABLE, "Huffman table 0x%02x was not defined")
98JMESSAGE(JERR_NO_IMAGE, "JPEG datastream contains no image")
99JMESSAGE(JERR_NO_QUANT_TABLE, "Quantization table 0x%02x was not defined")
100JMESSAGE(JERR_NO_SOI, "Not a JPEG file: starts with 0x%02x 0x%02x")
101JMESSAGE(JERR_OUT_OF_MEMORY, "Insufficient memory (case %d)")
102JMESSAGE(JERR_QUANT_COMPONENTS,
103 "Cannot quantize more than %d color components")
104JMESSAGE(JERR_QUANT_FEW_COLORS, "Cannot quantize to fewer than %d colors")
105JMESSAGE(JERR_QUANT_MANY_COLORS, "Cannot quantize to more than %d colors")
106JMESSAGE(JERR_SOF_DUPLICATE, "Invalid JPEG file structure: two SOF markers")
107JMESSAGE(JERR_SOF_NO_SOS, "Invalid JPEG file structure: missing SOS marker")
108JMESSAGE(JERR_SOF_UNSUPPORTED, "Unsupported JPEG process: SOF type 0x%02x")
109JMESSAGE(JERR_SOI_DUPLICATE, "Invalid JPEG file structure: two SOI markers")
110JMESSAGE(JERR_SOS_NO_SOF, "Invalid JPEG file structure: SOS before SOF")
111JMESSAGE(JERR_TFILE_CREATE, "Failed to create temporary file %s")
112JMESSAGE(JERR_TFILE_READ, "Read failed on temporary file")
113JMESSAGE(JERR_TFILE_SEEK, "Seek failed on temporary file")
114JMESSAGE(JERR_TFILE_WRITE,
115 "Write failed on temporary file --- out of disk space?")
116JMESSAGE(JERR_TOO_LITTLE_DATA, "Application transferred too few scanlines")
117JMESSAGE(JERR_UNKNOWN_MARKER, "Unsupported marker type 0x%02x")
118JMESSAGE(JERR_VIRTUAL_BUG, "Virtual array controller messed up")
119JMESSAGE(JERR_WIDTH_OVERFLOW, "Image too wide for this implementation")
120JMESSAGE(JERR_XMS_READ, "Read from XMS failed")
121JMESSAGE(JERR_XMS_WRITE, "Write to XMS failed")
122JMESSAGE(JMSG_COPYRIGHT, JCOPYRIGHT)
123JMESSAGE(JMSG_VERSION, JVERSION)
124JMESSAGE(JTRC_16BIT_TABLES,
125 "Caution: quantization tables are too coarse for baseline JPEG")
126JMESSAGE(JTRC_ADOBE,
127 "Adobe APP14 marker: version %d, flags 0x%04x 0x%04x, transform %d")
128JMESSAGE(JTRC_APP0, "Unknown APP0 marker (not JFIF), length %u")
129JMESSAGE(JTRC_APP14, "Unknown APP14 marker (not Adobe), length %u")
130JMESSAGE(JTRC_DAC, "Define Arithmetic Table 0x%02x: 0x%02x")
131JMESSAGE(JTRC_DHT, "Define Huffman Table 0x%02x")
132JMESSAGE(JTRC_DQT, "Define Quantization Table %d precision %d")
133JMESSAGE(JTRC_DRI, "Define Restart Interval %u")
134JMESSAGE(JTRC_EMS_CLOSE, "Freed EMS handle %u")
135JMESSAGE(JTRC_EMS_OPEN, "Obtained EMS handle %u")
136JMESSAGE(JTRC_EOI, "End Of Image")
137JMESSAGE(JTRC_HUFFBITS, " %3d %3d %3d %3d %3d %3d %3d %3d")
138JMESSAGE(JTRC_JFIF, "JFIF APP0 marker: version %d.%02d, density %dx%d %d")
139JMESSAGE(JTRC_JFIF_BADTHUMBNAILSIZE,
140 "Warning: thumbnail image size does not match data length %u")
141JMESSAGE(JTRC_JFIF_EXTENSION,
142 "JFIF extension marker: type 0x%02x, length %u")
143JMESSAGE(JTRC_JFIF_THUMBNAIL, " with %d x %d thumbnail image")
144JMESSAGE(JTRC_MISC_MARKER, "Miscellaneous marker 0x%02x, length %u")
145JMESSAGE(JTRC_PARMLESS_MARKER, "Unexpected marker 0x%02x")
146JMESSAGE(JTRC_QUANTVALS, " %4u %4u %4u %4u %4u %4u %4u %4u")
147JMESSAGE(JTRC_QUANT_3_NCOLORS, "Quantizing to %d = %d*%d*%d colors")
148JMESSAGE(JTRC_QUANT_NCOLORS, "Quantizing to %d colors")
149JMESSAGE(JTRC_QUANT_SELECTED, "Selected %d colors for quantization")
150JMESSAGE(JTRC_RECOVERY_ACTION, "At marker 0x%02x, recovery action %d")
151JMESSAGE(JTRC_RST, "RST%d")
152JMESSAGE(JTRC_SMOOTH_NOTIMPL,
153 "Smoothing not supported with nonstandard sampling ratios")
154JMESSAGE(JTRC_SOF, "Start Of Frame 0x%02x: width=%u, height=%u, components=%d")
155JMESSAGE(JTRC_SOF_COMPONENT, " Component %d: %dhx%dv q=%d")
156JMESSAGE(JTRC_SOI, "Start of Image")
157JMESSAGE(JTRC_SOS, "Start Of Scan: %d components")
158JMESSAGE(JTRC_SOS_COMPONENT, " Component %d: dc=%d ac=%d")
159JMESSAGE(JTRC_SOS_PARAMS, " Ss=%d, Se=%d, Ah=%d, Al=%d")
160JMESSAGE(JTRC_TFILE_CLOSE, "Closed temporary file %s")
161JMESSAGE(JTRC_TFILE_OPEN, "Opened temporary file %s")
162JMESSAGE(JTRC_THUMB_JPEG,
163 "JFIF extension marker: JPEG-compressed thumbnail image, length %u")
164JMESSAGE(JTRC_THUMB_PALETTE,
165 "JFIF extension marker: palette thumbnail image, length %u")
166JMESSAGE(JTRC_THUMB_RGB,
167 "JFIF extension marker: RGB thumbnail image, length %u")
168JMESSAGE(JTRC_UNKNOWN_IDS,
169 "Unrecognized component IDs %d %d %d, assuming YCbCr")
170JMESSAGE(JTRC_XMS_CLOSE, "Freed XMS handle %u")
171JMESSAGE(JTRC_XMS_OPEN, "Obtained XMS handle %u")
172JMESSAGE(JWRN_ADOBE_XFORM, "Unknown Adobe color transform code %d")
173JMESSAGE(JWRN_BOGUS_PROGRESSION,
174 "Inconsistent progression sequence for component %d coefficient %d")
175JMESSAGE(JWRN_EXTRANEOUS_DATA,
176 "Corrupt JPEG data: %u extraneous bytes before marker 0x%02x")
177JMESSAGE(JWRN_HIT_MARKER, "Corrupt JPEG data: premature end of data segment")
178JMESSAGE(JWRN_HUFF_BAD_CODE, "Corrupt JPEG data: bad Huffman code")
179JMESSAGE(JWRN_JFIF_MAJOR, "Warning: unknown JFIF revision number %d.%02d")
180JMESSAGE(JWRN_JPEG_EOF, "Premature end of JPEG file")
181JMESSAGE(JWRN_MUST_RESYNC,
182 "Corrupt JPEG data: found marker 0x%02x instead of RST%d")
183JMESSAGE(JWRN_NOT_SEQUENTIAL, "Invalid SOS parameters for sequential JPEG")
184JMESSAGE(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 */
292