jerror.h 14 KB

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