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