image_pack 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (319) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +18 -0
  3. data/LICENSE.txt +21 -0
  4. data/README.md +140 -0
  5. data/THIRD_PARTY_NOTICES.md +8 -0
  6. data/ext/image_pack/extconf.rb +515 -0
  7. data/ext/image_pack/image_pack.c +1618 -0
  8. data/ext/image_pack/vendor/.vendored +1 -0
  9. data/ext/image_pack/vendor/mozjpeg/BUILDING.txt +902 -0
  10. data/ext/image_pack/vendor/mozjpeg/CMakeLists.txt +1593 -0
  11. data/ext/image_pack/vendor/mozjpeg/LICENSE.md +132 -0
  12. data/ext/image_pack/vendor/mozjpeg/README-mozilla.txt +194 -0
  13. data/ext/image_pack/vendor/mozjpeg/README-turbo.txt +346 -0
  14. data/ext/image_pack/vendor/mozjpeg/README.ijg +258 -0
  15. data/ext/image_pack/vendor/mozjpeg/README.md +29 -0
  16. data/ext/image_pack/vendor/mozjpeg/cderror.h +128 -0
  17. data/ext/image_pack/vendor/mozjpeg/cdjpeg.c +156 -0
  18. data/ext/image_pack/vendor/mozjpeg/cdjpeg.h +171 -0
  19. data/ext/image_pack/vendor/mozjpeg/cjpeg.c +961 -0
  20. data/ext/image_pack/vendor/mozjpeg/cmyk.h +60 -0
  21. data/ext/image_pack/vendor/mozjpeg/coderules.txt +78 -0
  22. data/ext/image_pack/vendor/mozjpeg/croptest.in +95 -0
  23. data/ext/image_pack/vendor/mozjpeg/djpeg.c +855 -0
  24. data/ext/image_pack/vendor/mozjpeg/example.txt +464 -0
  25. data/ext/image_pack/vendor/mozjpeg/jaricom.c +157 -0
  26. data/ext/image_pack/vendor/mozjpeg/jcapimin.c +307 -0
  27. data/ext/image_pack/vendor/mozjpeg/jcapistd.c +168 -0
  28. data/ext/image_pack/vendor/mozjpeg/jcarith.c +972 -0
  29. data/ext/image_pack/vendor/mozjpeg/jccoefct.c +609 -0
  30. data/ext/image_pack/vendor/mozjpeg/jccolext.c +144 -0
  31. data/ext/image_pack/vendor/mozjpeg/jccolor.c +721 -0
  32. data/ext/image_pack/vendor/mozjpeg/jcdctmgr.c +1776 -0
  33. data/ext/image_pack/vendor/mozjpeg/jcext.c +219 -0
  34. data/ext/image_pack/vendor/mozjpeg/jchuff.c +1146 -0
  35. data/ext/image_pack/vendor/mozjpeg/jchuff.h +57 -0
  36. data/ext/image_pack/vendor/mozjpeg/jcicc.c +105 -0
  37. data/ext/image_pack/vendor/mozjpeg/jcinit.c +82 -0
  38. data/ext/image_pack/vendor/mozjpeg/jcmainct.c +162 -0
  39. data/ext/image_pack/vendor/mozjpeg/jcmarker.c +844 -0
  40. data/ext/image_pack/vendor/mozjpeg/jcmaster.c +958 -0
  41. data/ext/image_pack/vendor/mozjpeg/jcmaster.h +56 -0
  42. data/ext/image_pack/vendor/mozjpeg/jcomapi.c +109 -0
  43. data/ext/image_pack/vendor/mozjpeg/jconfig.h.in +37 -0
  44. data/ext/image_pack/vendor/mozjpeg/jconfig.txt +93 -0
  45. data/ext/image_pack/vendor/mozjpeg/jconfigint.h.in +44 -0
  46. data/ext/image_pack/vendor/mozjpeg/jcparam.c +991 -0
  47. data/ext/image_pack/vendor/mozjpeg/jcphuff.c +1123 -0
  48. data/ext/image_pack/vendor/mozjpeg/jcprepct.c +351 -0
  49. data/ext/image_pack/vendor/mozjpeg/jcsample.c +522 -0
  50. data/ext/image_pack/vendor/mozjpeg/jcstest.c +126 -0
  51. data/ext/image_pack/vendor/mozjpeg/jctrans.c +408 -0
  52. data/ext/image_pack/vendor/mozjpeg/jdapimin.c +407 -0
  53. data/ext/image_pack/vendor/mozjpeg/jdapistd.c +691 -0
  54. data/ext/image_pack/vendor/mozjpeg/jdarith.c +782 -0
  55. data/ext/image_pack/vendor/mozjpeg/jdatadst-tj.c +198 -0
  56. data/ext/image_pack/vendor/mozjpeg/jdatadst.c +299 -0
  57. data/ext/image_pack/vendor/mozjpeg/jdatasrc-tj.c +194 -0
  58. data/ext/image_pack/vendor/mozjpeg/jdatasrc.c +295 -0
  59. data/ext/image_pack/vendor/mozjpeg/jdcoefct.c +881 -0
  60. data/ext/image_pack/vendor/mozjpeg/jdcoefct.h +83 -0
  61. data/ext/image_pack/vendor/mozjpeg/jdcol565.c +384 -0
  62. data/ext/image_pack/vendor/mozjpeg/jdcolext.c +141 -0
  63. data/ext/image_pack/vendor/mozjpeg/jdcolor.c +881 -0
  64. data/ext/image_pack/vendor/mozjpeg/jdct.h +208 -0
  65. data/ext/image_pack/vendor/mozjpeg/jddctmgr.c +367 -0
  66. data/ext/image_pack/vendor/mozjpeg/jdhuff.c +834 -0
  67. data/ext/image_pack/vendor/mozjpeg/jdhuff.h +247 -0
  68. data/ext/image_pack/vendor/mozjpeg/jdicc.c +167 -0
  69. data/ext/image_pack/vendor/mozjpeg/jdinput.c +408 -0
  70. data/ext/image_pack/vendor/mozjpeg/jdmainct.c +460 -0
  71. data/ext/image_pack/vendor/mozjpeg/jdmainct.h +71 -0
  72. data/ext/image_pack/vendor/mozjpeg/jdmarker.c +1374 -0
  73. data/ext/image_pack/vendor/mozjpeg/jdmaster.c +727 -0
  74. data/ext/image_pack/vendor/mozjpeg/jdmaster.h +33 -0
  75. data/ext/image_pack/vendor/mozjpeg/jdmerge.c +587 -0
  76. data/ext/image_pack/vendor/mozjpeg/jdmerge.h +47 -0
  77. data/ext/image_pack/vendor/mozjpeg/jdmrg565.c +354 -0
  78. data/ext/image_pack/vendor/mozjpeg/jdmrgext.c +184 -0
  79. data/ext/image_pack/vendor/mozjpeg/jdphuff.c +679 -0
  80. data/ext/image_pack/vendor/mozjpeg/jdpostct.c +294 -0
  81. data/ext/image_pack/vendor/mozjpeg/jdsample.c +524 -0
  82. data/ext/image_pack/vendor/mozjpeg/jdsample.h +50 -0
  83. data/ext/image_pack/vendor/mozjpeg/jdtrans.c +156 -0
  84. data/ext/image_pack/vendor/mozjpeg/jerror.c +251 -0
  85. data/ext/image_pack/vendor/mozjpeg/jerror.h +335 -0
  86. data/ext/image_pack/vendor/mozjpeg/jfdctflt.c +169 -0
  87. data/ext/image_pack/vendor/mozjpeg/jfdctfst.c +227 -0
  88. data/ext/image_pack/vendor/mozjpeg/jfdctint.c +288 -0
  89. data/ext/image_pack/vendor/mozjpeg/jidctflt.c +240 -0
  90. data/ext/image_pack/vendor/mozjpeg/jidctfst.c +371 -0
  91. data/ext/image_pack/vendor/mozjpeg/jidctint.c +2627 -0
  92. data/ext/image_pack/vendor/mozjpeg/jidctred.c +409 -0
  93. data/ext/image_pack/vendor/mozjpeg/jinclude.h +147 -0
  94. data/ext/image_pack/vendor/mozjpeg/jmemmgr.c +1180 -0
  95. data/ext/image_pack/vendor/mozjpeg/jmemnobs.c +110 -0
  96. data/ext/image_pack/vendor/mozjpeg/jmemsys.h +178 -0
  97. data/ext/image_pack/vendor/mozjpeg/jmorecfg.h +382 -0
  98. data/ext/image_pack/vendor/mozjpeg/jpeg_nbits_table.h +4098 -0
  99. data/ext/image_pack/vendor/mozjpeg/jpegcomp.h +32 -0
  100. data/ext/image_pack/vendor/mozjpeg/jpegint.h +453 -0
  101. data/ext/image_pack/vendor/mozjpeg/jpeglib.h +1211 -0
  102. data/ext/image_pack/vendor/mozjpeg/jpegtran.c +827 -0
  103. data/ext/image_pack/vendor/mozjpeg/jpegyuv.c +172 -0
  104. data/ext/image_pack/vendor/mozjpeg/jquant1.c +856 -0
  105. data/ext/image_pack/vendor/mozjpeg/jquant2.c +1286 -0
  106. data/ext/image_pack/vendor/mozjpeg/jsimd.h +123 -0
  107. data/ext/image_pack/vendor/mozjpeg/jsimd_none.c +431 -0
  108. data/ext/image_pack/vendor/mozjpeg/jsimddct.h +70 -0
  109. data/ext/image_pack/vendor/mozjpeg/jstdhuff.c +144 -0
  110. data/ext/image_pack/vendor/mozjpeg/jutils.c +133 -0
  111. data/ext/image_pack/vendor/mozjpeg/jversion.h.in +56 -0
  112. data/ext/image_pack/vendor/mozjpeg/libjpeg.map.in +11 -0
  113. data/ext/image_pack/vendor/mozjpeg/libjpeg.txt +3150 -0
  114. data/ext/image_pack/vendor/mozjpeg/rdbmp.c +690 -0
  115. data/ext/image_pack/vendor/mozjpeg/rdcolmap.c +253 -0
  116. data/ext/image_pack/vendor/mozjpeg/rdgif.c +720 -0
  117. data/ext/image_pack/vendor/mozjpeg/rdjpeg.c +160 -0
  118. data/ext/image_pack/vendor/mozjpeg/rdjpgcom.c +494 -0
  119. data/ext/image_pack/vendor/mozjpeg/rdpng.c +194 -0
  120. data/ext/image_pack/vendor/mozjpeg/rdppm.c +781 -0
  121. data/ext/image_pack/vendor/mozjpeg/rdswitch.c +642 -0
  122. data/ext/image_pack/vendor/mozjpeg/rdtarga.c +508 -0
  123. data/ext/image_pack/vendor/mozjpeg/simd/arm/aarch32/jccolext-neon.c +148 -0
  124. data/ext/image_pack/vendor/mozjpeg/simd/arm/aarch32/jchuff-neon.c +334 -0
  125. data/ext/image_pack/vendor/mozjpeg/simd/arm/aarch32/jsimd.c +976 -0
  126. data/ext/image_pack/vendor/mozjpeg/simd/arm/aarch32/jsimd_neon.S +1200 -0
  127. data/ext/image_pack/vendor/mozjpeg/simd/arm/aarch64/jccolext-neon.c +316 -0
  128. data/ext/image_pack/vendor/mozjpeg/simd/arm/aarch64/jchuff-neon.c +411 -0
  129. data/ext/image_pack/vendor/mozjpeg/simd/arm/aarch64/jsimd.c +1053 -0
  130. data/ext/image_pack/vendor/mozjpeg/simd/arm/aarch64/jsimd_neon.S +2254 -0
  131. data/ext/image_pack/vendor/mozjpeg/simd/arm/align.h +28 -0
  132. data/ext/image_pack/vendor/mozjpeg/simd/arm/jccolor-neon.c +160 -0
  133. data/ext/image_pack/vendor/mozjpeg/simd/arm/jcgray-neon.c +120 -0
  134. data/ext/image_pack/vendor/mozjpeg/simd/arm/jcgryext-neon.c +106 -0
  135. data/ext/image_pack/vendor/mozjpeg/simd/arm/jchuff.h +131 -0
  136. data/ext/image_pack/vendor/mozjpeg/simd/arm/jcphuff-neon.c +623 -0
  137. data/ext/image_pack/vendor/mozjpeg/simd/arm/jcsample-neon.c +192 -0
  138. data/ext/image_pack/vendor/mozjpeg/simd/arm/jdcolext-neon.c +374 -0
  139. data/ext/image_pack/vendor/mozjpeg/simd/arm/jdcolor-neon.c +141 -0
  140. data/ext/image_pack/vendor/mozjpeg/simd/arm/jdmerge-neon.c +144 -0
  141. data/ext/image_pack/vendor/mozjpeg/simd/arm/jdmrgext-neon.c +723 -0
  142. data/ext/image_pack/vendor/mozjpeg/simd/arm/jdsample-neon.c +569 -0
  143. data/ext/image_pack/vendor/mozjpeg/simd/arm/jfdctfst-neon.c +214 -0
  144. data/ext/image_pack/vendor/mozjpeg/simd/arm/jfdctint-neon.c +376 -0
  145. data/ext/image_pack/vendor/mozjpeg/simd/arm/jidctfst-neon.c +472 -0
  146. data/ext/image_pack/vendor/mozjpeg/simd/arm/jidctint-neon.c +801 -0
  147. data/ext/image_pack/vendor/mozjpeg/simd/arm/jidctred-neon.c +486 -0
  148. data/ext/image_pack/vendor/mozjpeg/simd/arm/jquanti-neon.c +193 -0
  149. data/ext/image_pack/vendor/mozjpeg/simd/arm/neon-compat.h +26 -0
  150. data/ext/image_pack/vendor/mozjpeg/simd/arm/neon-compat.h.in +37 -0
  151. data/ext/image_pack/vendor/mozjpeg/simd/i386/jccolext-avx2.asm +578 -0
  152. data/ext/image_pack/vendor/mozjpeg/simd/i386/jccolext-mmx.asm +476 -0
  153. data/ext/image_pack/vendor/mozjpeg/simd/i386/jccolext-sse2.asm +503 -0
  154. data/ext/image_pack/vendor/mozjpeg/simd/i386/jccolor-avx2.asm +121 -0
  155. data/ext/image_pack/vendor/mozjpeg/simd/i386/jccolor-mmx.asm +121 -0
  156. data/ext/image_pack/vendor/mozjpeg/simd/i386/jccolor-sse2.asm +120 -0
  157. data/ext/image_pack/vendor/mozjpeg/simd/i386/jcgray-avx2.asm +113 -0
  158. data/ext/image_pack/vendor/mozjpeg/simd/i386/jcgray-mmx.asm +113 -0
  159. data/ext/image_pack/vendor/mozjpeg/simd/i386/jcgray-sse2.asm +112 -0
  160. data/ext/image_pack/vendor/mozjpeg/simd/i386/jcgryext-avx2.asm +457 -0
  161. data/ext/image_pack/vendor/mozjpeg/simd/i386/jcgryext-mmx.asm +355 -0
  162. data/ext/image_pack/vendor/mozjpeg/simd/i386/jcgryext-sse2.asm +382 -0
  163. data/ext/image_pack/vendor/mozjpeg/simd/i386/jchuff-sse2.asm +761 -0
  164. data/ext/image_pack/vendor/mozjpeg/simd/i386/jcphuff-sse2.asm +662 -0
  165. data/ext/image_pack/vendor/mozjpeg/simd/i386/jcsample-avx2.asm +388 -0
  166. data/ext/image_pack/vendor/mozjpeg/simd/i386/jcsample-mmx.asm +324 -0
  167. data/ext/image_pack/vendor/mozjpeg/simd/i386/jcsample-sse2.asm +351 -0
  168. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdcolext-avx2.asm +515 -0
  169. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdcolext-mmx.asm +404 -0
  170. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdcolext-sse2.asm +458 -0
  171. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdcolor-avx2.asm +118 -0
  172. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdcolor-mmx.asm +117 -0
  173. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdcolor-sse2.asm +117 -0
  174. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdmerge-avx2.asm +136 -0
  175. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdmerge-mmx.asm +123 -0
  176. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdmerge-sse2.asm +135 -0
  177. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdmrgext-avx2.asm +575 -0
  178. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdmrgext-mmx.asm +460 -0
  179. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdmrgext-sse2.asm +517 -0
  180. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdsample-avx2.asm +760 -0
  181. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdsample-mmx.asm +731 -0
  182. data/ext/image_pack/vendor/mozjpeg/simd/i386/jdsample-sse2.asm +724 -0
  183. data/ext/image_pack/vendor/mozjpeg/simd/i386/jfdctflt-3dn.asm +318 -0
  184. data/ext/image_pack/vendor/mozjpeg/simd/i386/jfdctflt-sse.asm +369 -0
  185. data/ext/image_pack/vendor/mozjpeg/simd/i386/jfdctfst-mmx.asm +395 -0
  186. data/ext/image_pack/vendor/mozjpeg/simd/i386/jfdctfst-sse2.asm +403 -0
  187. data/ext/image_pack/vendor/mozjpeg/simd/i386/jfdctint-avx2.asm +331 -0
  188. data/ext/image_pack/vendor/mozjpeg/simd/i386/jfdctint-mmx.asm +620 -0
  189. data/ext/image_pack/vendor/mozjpeg/simd/i386/jfdctint-sse2.asm +633 -0
  190. data/ext/image_pack/vendor/mozjpeg/simd/i386/jidctflt-3dn.asm +451 -0
  191. data/ext/image_pack/vendor/mozjpeg/simd/i386/jidctflt-sse.asm +571 -0
  192. data/ext/image_pack/vendor/mozjpeg/simd/i386/jidctflt-sse2.asm +497 -0
  193. data/ext/image_pack/vendor/mozjpeg/simd/i386/jidctfst-mmx.asm +499 -0
  194. data/ext/image_pack/vendor/mozjpeg/simd/i386/jidctfst-sse2.asm +501 -0
  195. data/ext/image_pack/vendor/mozjpeg/simd/i386/jidctint-avx2.asm +453 -0
  196. data/ext/image_pack/vendor/mozjpeg/simd/i386/jidctint-mmx.asm +851 -0
  197. data/ext/image_pack/vendor/mozjpeg/simd/i386/jidctint-sse2.asm +858 -0
  198. data/ext/image_pack/vendor/mozjpeg/simd/i386/jidctred-mmx.asm +704 -0
  199. data/ext/image_pack/vendor/mozjpeg/simd/i386/jidctred-sse2.asm +592 -0
  200. data/ext/image_pack/vendor/mozjpeg/simd/i386/jquant-3dn.asm +230 -0
  201. data/ext/image_pack/vendor/mozjpeg/simd/i386/jquant-mmx.asm +276 -0
  202. data/ext/image_pack/vendor/mozjpeg/simd/i386/jquant-sse.asm +208 -0
  203. data/ext/image_pack/vendor/mozjpeg/simd/i386/jquantf-sse2.asm +168 -0
  204. data/ext/image_pack/vendor/mozjpeg/simd/i386/jquanti-avx2.asm +188 -0
  205. data/ext/image_pack/vendor/mozjpeg/simd/i386/jquanti-sse2.asm +201 -0
  206. data/ext/image_pack/vendor/mozjpeg/simd/i386/jsimd.c +1312 -0
  207. data/ext/image_pack/vendor/mozjpeg/simd/i386/jsimdcpu.asm +135 -0
  208. data/ext/image_pack/vendor/mozjpeg/simd/jsimd.h +1258 -0
  209. data/ext/image_pack/vendor/mozjpeg/simd/mips/jsimd.c +1143 -0
  210. data/ext/image_pack/vendor/mozjpeg/simd/mips/jsimd_dspr2.S +4543 -0
  211. data/ext/image_pack/vendor/mozjpeg/simd/mips/jsimd_dspr2_asm.h +292 -0
  212. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jccolext-mmi.c +455 -0
  213. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jccolor-mmi.c +148 -0
  214. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jcgray-mmi.c +132 -0
  215. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jcgryext-mmi.c +374 -0
  216. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jcsample-mmi.c +98 -0
  217. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jcsample.h +28 -0
  218. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jdcolext-mmi.c +415 -0
  219. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jdcolor-mmi.c +139 -0
  220. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jdmerge-mmi.c +149 -0
  221. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jdmrgext-mmi.c +615 -0
  222. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jdsample-mmi.c +304 -0
  223. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jfdctfst-mmi.c +255 -0
  224. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jfdctint-mmi.c +398 -0
  225. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jidctfst-mmi.c +395 -0
  226. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jidctint-mmi.c +571 -0
  227. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jquanti-mmi.c +124 -0
  228. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jsimd.c +866 -0
  229. data/ext/image_pack/vendor/mozjpeg/simd/mips64/jsimd_mmi.h +69 -0
  230. data/ext/image_pack/vendor/mozjpeg/simd/mips64/loongson-mmintrin.h +1334 -0
  231. data/ext/image_pack/vendor/mozjpeg/simd/nasm/jcolsamp.inc +135 -0
  232. data/ext/image_pack/vendor/mozjpeg/simd/nasm/jdct.inc +31 -0
  233. data/ext/image_pack/vendor/mozjpeg/simd/nasm/jsimdcfg.inc +93 -0
  234. data/ext/image_pack/vendor/mozjpeg/simd/nasm/jsimdcfg.inc.h +133 -0
  235. data/ext/image_pack/vendor/mozjpeg/simd/nasm/jsimdext.inc +520 -0
  236. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jccolext-altivec.c +269 -0
  237. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jccolor-altivec.c +116 -0
  238. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jcgray-altivec.c +111 -0
  239. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jcgryext-altivec.c +228 -0
  240. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jcsample-altivec.c +159 -0
  241. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jcsample.h +28 -0
  242. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jdcolext-altivec.c +276 -0
  243. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jdcolor-altivec.c +106 -0
  244. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jdmerge-altivec.c +130 -0
  245. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jdmrgext-altivec.c +329 -0
  246. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jdsample-altivec.c +400 -0
  247. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jfdctfst-altivec.c +154 -0
  248. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jfdctint-altivec.c +258 -0
  249. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jidctfst-altivec.c +255 -0
  250. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jidctint-altivec.c +357 -0
  251. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jquanti-altivec.c +250 -0
  252. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jsimd.c +884 -0
  253. data/ext/image_pack/vendor/mozjpeg/simd/powerpc/jsimd_altivec.h +98 -0
  254. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jccolext-avx2.asm +559 -0
  255. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jccolext-sse2.asm +484 -0
  256. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jccolor-avx2.asm +121 -0
  257. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jccolor-sse2.asm +120 -0
  258. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jcgray-avx2.asm +113 -0
  259. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jcgray-sse2.asm +112 -0
  260. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jcgryext-avx2.asm +438 -0
  261. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jcgryext-sse2.asm +363 -0
  262. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jchuff-sse2.asm +583 -0
  263. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jcphuff-sse2.asm +639 -0
  264. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jcsample-avx2.asm +367 -0
  265. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jcsample-sse2.asm +330 -0
  266. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jdcolext-avx2.asm +496 -0
  267. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jdcolext-sse2.asm +439 -0
  268. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jdcolor-avx2.asm +118 -0
  269. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jdcolor-sse2.asm +117 -0
  270. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jdmerge-avx2.asm +136 -0
  271. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jdmerge-sse2.asm +135 -0
  272. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jdmrgext-avx2.asm +596 -0
  273. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jdmrgext-sse2.asm +538 -0
  274. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jdsample-avx2.asm +696 -0
  275. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jdsample-sse2.asm +665 -0
  276. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jfdctflt-sse.asm +355 -0
  277. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jfdctfst-sse2.asm +389 -0
  278. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jfdctint-avx2.asm +320 -0
  279. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jfdctint-sse2.asm +619 -0
  280. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jidctflt-sse2.asm +482 -0
  281. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jidctfst-sse2.asm +491 -0
  282. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jidctint-avx2.asm +418 -0
  283. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jidctint-sse2.asm +847 -0
  284. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jidctred-sse2.asm +574 -0
  285. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jquantf-sse2.asm +155 -0
  286. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jquanti-avx2.asm +163 -0
  287. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jquanti-sse2.asm +188 -0
  288. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jsimd.c +1110 -0
  289. data/ext/image_pack/vendor/mozjpeg/simd/x86_64/jsimdcpu.asm +86 -0
  290. data/ext/image_pack/vendor/mozjpeg/strtest.c +170 -0
  291. data/ext/image_pack/vendor/mozjpeg/structure.txt +900 -0
  292. data/ext/image_pack/vendor/mozjpeg/tjbench.c +1044 -0
  293. data/ext/image_pack/vendor/mozjpeg/tjbenchtest.in +256 -0
  294. data/ext/image_pack/vendor/mozjpeg/tjbenchtest.java.in +215 -0
  295. data/ext/image_pack/vendor/mozjpeg/tjexample.c +406 -0
  296. data/ext/image_pack/vendor/mozjpeg/tjexampletest.in +149 -0
  297. data/ext/image_pack/vendor/mozjpeg/tjexampletest.java.in +151 -0
  298. data/ext/image_pack/vendor/mozjpeg/tjunittest.c +961 -0
  299. data/ext/image_pack/vendor/mozjpeg/tjutil.c +70 -0
  300. data/ext/image_pack/vendor/mozjpeg/tjutil.h +53 -0
  301. data/ext/image_pack/vendor/mozjpeg/transupp.c +2373 -0
  302. data/ext/image_pack/vendor/mozjpeg/transupp.h +243 -0
  303. data/ext/image_pack/vendor/mozjpeg/turbojpeg-jni.c +1259 -0
  304. data/ext/image_pack/vendor/mozjpeg/turbojpeg.c +2320 -0
  305. data/ext/image_pack/vendor/mozjpeg/turbojpeg.h +1784 -0
  306. data/ext/image_pack/vendor/mozjpeg/usage.txt +679 -0
  307. data/ext/image_pack/vendor/mozjpeg/wizard.txt +220 -0
  308. data/ext/image_pack/vendor/mozjpeg/wrbmp.c +552 -0
  309. data/ext/image_pack/vendor/mozjpeg/wrgif.c +580 -0
  310. data/ext/image_pack/vendor/mozjpeg/wrjpgcom.c +577 -0
  311. data/ext/image_pack/vendor/mozjpeg/wrppm.c +366 -0
  312. data/ext/image_pack/vendor/mozjpeg/wrtarga.c +258 -0
  313. data/ext/image_pack/vendor/mozjpeg/yuvjpeg.c +268 -0
  314. data/lib/image_pack/backend.rb +8 -0
  315. data/lib/image_pack/configuration.rb +23 -0
  316. data/lib/image_pack/errors.rb +13 -0
  317. data/lib/image_pack/version.rb +5 -0
  318. data/lib/image_pack.rb +208 -0
  319. metadata +433 -0
@@ -0,0 +1,3150 @@
1
+ USING THE IJG JPEG LIBRARY
2
+
3
+ This file was part of the Independent JPEG Group's software:
4
+ Copyright (C) 1994-2013, Thomas G. Lane, Guido Vollbeding.
5
+ libjpeg-turbo Modifications:
6
+ Copyright (C) 2010, 2014-2018, 2020, 2022, D. R. Commander.
7
+ Copyright (C) 2015, Google, Inc.
8
+ For conditions of distribution and use, see the accompanying README.ijg file.
9
+
10
+
11
+ This file describes how to use the IJG JPEG library within an application
12
+ program. Read it if you want to write a program that uses the library.
13
+
14
+ The file example.txt provides heavily commented skeleton code for calling the
15
+ JPEG library. Also see jpeglib.h (the include file to be used by application
16
+ programs) for full details about data structures and function parameter lists.
17
+ The library source code, of course, is the ultimate reference.
18
+
19
+ Note that there have been *major* changes from the application interface
20
+ presented by IJG version 4 and earlier versions. The old design had several
21
+ inherent limitations, and it had accumulated a lot of cruft as we added
22
+ features while trying to minimize application-interface changes. We have
23
+ sacrificed backward compatibility in the version 5 rewrite, but we think the
24
+ improvements justify this.
25
+
26
+
27
+ TABLE OF CONTENTS
28
+ -----------------
29
+
30
+ Overview:
31
+ Functions provided by the library
32
+ Outline of typical usage
33
+ Basic library usage:
34
+ Data formats
35
+ Compression details
36
+ Decompression details
37
+ Partial image decompression
38
+ Mechanics of usage: include files, linking, etc
39
+ Advanced features:
40
+ Compression parameter selection
41
+ Decompression parameter selection
42
+ Special color spaces
43
+ Error handling
44
+ Compressed data handling (source and destination managers)
45
+ I/O suspension
46
+ Progressive JPEG support
47
+ Buffered-image mode
48
+ Abbreviated datastreams and multiple images
49
+ Special markers
50
+ ICC profiles
51
+ Raw (downsampled) image data
52
+ Really raw data: DCT coefficients
53
+ Progress monitoring
54
+ Memory management
55
+ Memory usage
56
+ Library compile-time options
57
+ Portability considerations
58
+
59
+ You should read at least the overview and basic usage sections before trying
60
+ to program with the library. The sections on advanced features can be read
61
+ if and when you need them.
62
+
63
+
64
+ OVERVIEW
65
+ ========
66
+
67
+ Functions provided by the library
68
+ ---------------------------------
69
+
70
+ The IJG JPEG library provides C code to read and write JPEG-compressed image
71
+ files. The surrounding application program receives or supplies image data a
72
+ scanline at a time, using a straightforward uncompressed image format. All
73
+ details of color conversion and other preprocessing/postprocessing can be
74
+ handled by the library.
75
+
76
+ The library includes a substantial amount of code that is not covered by the
77
+ JPEG standard but is necessary for typical applications of JPEG. These
78
+ functions preprocess the image before JPEG compression or postprocess it after
79
+ decompression. They include colorspace conversion, downsampling/upsampling,
80
+ and color quantization. The application indirectly selects use of this code
81
+ by specifying the format in which it wishes to supply or receive image data.
82
+ For example, if colormapped output is requested, then the decompression
83
+ library automatically invokes color quantization.
84
+
85
+ A wide range of quality vs. speed tradeoffs are possible in JPEG processing,
86
+ and even more so in decompression postprocessing. The decompression library
87
+ provides multiple implementations that cover most of the useful tradeoffs,
88
+ ranging from very-high-quality down to fast-preview operation. On the
89
+ compression side we have generally not provided low-quality choices, since
90
+ compression is normally less time-critical. It should be understood that the
91
+ low-quality modes may not meet the JPEG standard's accuracy requirements;
92
+ nonetheless, they are useful for viewers.
93
+
94
+ A word about functions *not* provided by the library. We handle a subset of
95
+ the ISO JPEG standard; most baseline, extended-sequential, and progressive
96
+ JPEG processes are supported. (Our subset includes all features now in common
97
+ use.) Unsupported ISO options include:
98
+ * Hierarchical storage
99
+ * Lossless JPEG
100
+ * DNL marker
101
+ * Nonintegral subsampling ratios
102
+ We support both 8- and 12-bit data precision, but this is a compile-time
103
+ choice rather than a run-time choice; hence it is difficult to use both
104
+ precisions in a single application.
105
+
106
+ By itself, the library handles only interchange JPEG datastreams --- in
107
+ particular the widely used JFIF file format. The library can be used by
108
+ surrounding code to process interchange or abbreviated JPEG datastreams that
109
+ are embedded in more complex file formats. (For example, this library is
110
+ used by the free LIBTIFF library to support JPEG compression in TIFF.)
111
+
112
+
113
+ Outline of typical usage
114
+ ------------------------
115
+
116
+ The rough outline of a JPEG compression operation is:
117
+
118
+ Allocate and initialize a JPEG compression object
119
+ Specify the destination for the compressed data (eg, a file)
120
+ Set parameters for compression, including image size & colorspace
121
+ jpeg_start_compress(...);
122
+ while (scan lines remain to be written)
123
+ jpeg_write_scanlines(...);
124
+ jpeg_finish_compress(...);
125
+ Release the JPEG compression object
126
+
127
+ A JPEG compression object holds parameters and working state for the JPEG
128
+ library. We make creation/destruction of the object separate from starting
129
+ or finishing compression of an image; the same object can be re-used for a
130
+ series of image compression operations. This makes it easy to re-use the
131
+ same parameter settings for a sequence of images. Re-use of a JPEG object
132
+ also has important implications for processing abbreviated JPEG datastreams,
133
+ as discussed later.
134
+
135
+ The image data to be compressed is supplied to jpeg_write_scanlines() from
136
+ in-memory buffers. If the application is doing file-to-file compression,
137
+ reading image data from the source file is the application's responsibility.
138
+ The library emits compressed data by calling a "data destination manager",
139
+ which typically will write the data into a file; but the application can
140
+ provide its own destination manager to do something else.
141
+
142
+ Similarly, the rough outline of a JPEG decompression operation is:
143
+
144
+ Allocate and initialize a JPEG decompression object
145
+ Specify the source of the compressed data (eg, a file)
146
+ Call jpeg_read_header() to obtain image info
147
+ Set parameters for decompression
148
+ jpeg_start_decompress(...);
149
+ while (scan lines remain to be read)
150
+ jpeg_read_scanlines(...);
151
+ jpeg_finish_decompress(...);
152
+ Release the JPEG decompression object
153
+
154
+ This is comparable to the compression outline except that reading the
155
+ datastream header is a separate step. This is helpful because information
156
+ about the image's size, colorspace, etc is available when the application
157
+ selects decompression parameters. For example, the application can choose an
158
+ output scaling ratio that will fit the image into the available screen size.
159
+
160
+ The decompression library obtains compressed data by calling a data source
161
+ manager, which typically will read the data from a file; but other behaviors
162
+ can be obtained with a custom source manager. Decompressed data is delivered
163
+ into in-memory buffers passed to jpeg_read_scanlines().
164
+
165
+ It is possible to abort an incomplete compression or decompression operation
166
+ by calling jpeg_abort(); or, if you do not need to retain the JPEG object,
167
+ simply release it by calling jpeg_destroy().
168
+
169
+ JPEG compression and decompression objects are two separate struct types.
170
+ However, they share some common fields, and certain routines such as
171
+ jpeg_destroy() can work on either type of object.
172
+
173
+ The JPEG library has no static variables: all state is in the compression
174
+ or decompression object. Therefore it is possible to process multiple
175
+ compression and decompression operations concurrently, using multiple JPEG
176
+ objects.
177
+
178
+ Both compression and decompression can be done in an incremental memory-to-
179
+ memory fashion, if suitable source/destination managers are used. See the
180
+ section on "I/O suspension" for more details.
181
+
182
+
183
+ BASIC LIBRARY USAGE
184
+ ===================
185
+
186
+ Data formats
187
+ ------------
188
+
189
+ Before diving into procedural details, it is helpful to understand the
190
+ image data format that the JPEG library expects or returns.
191
+
192
+ The standard input image format is a rectangular array of pixels, with each
193
+ pixel having the same number of "component" or "sample" values (color
194
+ channels). You must specify how many components there are and the colorspace
195
+ interpretation of the components. Most applications will use RGB data
196
+ (three components per pixel) or grayscale data (one component per pixel).
197
+ PLEASE NOTE THAT RGB DATA IS THREE SAMPLES PER PIXEL, GRAYSCALE ONLY ONE.
198
+ A remarkable number of people manage to miss this, only to find that their
199
+ programs don't work with grayscale JPEG files.
200
+
201
+ There is no provision for colormapped input. JPEG files are always full-color
202
+ or full grayscale (or sometimes another colorspace such as CMYK). You can
203
+ feed in a colormapped image by expanding it to full-color format. However
204
+ JPEG often doesn't work very well with source data that has been colormapped,
205
+ because of dithering noise. This is discussed in more detail in the JPEG FAQ
206
+ and the other references mentioned in the README.ijg file.
207
+
208
+ Pixels are stored by scanlines, with each scanline running from left to
209
+ right. The component values for each pixel are adjacent in the row; for
210
+ example, R,G,B,R,G,B,R,G,B,... for 24-bit RGB color. Each scanline is an
211
+ array of data type JSAMPLE --- which is typically "unsigned char", unless
212
+ you've changed jmorecfg.h. (You can also change the RGB pixel layout, say
213
+ to B,G,R order, by modifying jmorecfg.h. But see the restrictions listed in
214
+ that file before doing so.)
215
+
216
+ A 2-D array of pixels is formed by making a list of pointers to the starts of
217
+ scanlines; so the scanlines need not be physically adjacent in memory. Even
218
+ if you process just one scanline at a time, you must make a one-element
219
+ pointer array to conform to this structure. Pointers to JSAMPLE rows are of
220
+ type JSAMPROW, and the pointer to the pointer array is of type JSAMPARRAY.
221
+
222
+ The library accepts or supplies one or more complete scanlines per call.
223
+ It is not possible to process part of a row at a time. Scanlines are always
224
+ processed top-to-bottom. You can process an entire image in one call if you
225
+ have it all in memory, but usually it's simplest to process one scanline at
226
+ a time.
227
+
228
+ For best results, source data values should have the precision specified by
229
+ BITS_IN_JSAMPLE (normally 8 bits). For instance, if you choose to compress
230
+ data that's only 6 bits/channel, you should left-justify each value in a
231
+ byte before passing it to the compressor. If you need to compress data
232
+ that has more than 8 bits/channel, compile with BITS_IN_JSAMPLE = 12.
233
+ (See "Library compile-time options", later.)
234
+
235
+
236
+ The data format returned by the decompressor is the same in all details,
237
+ except that colormapped output is supported. (Again, a JPEG file is never
238
+ colormapped. But you can ask the decompressor to perform on-the-fly color
239
+ quantization to deliver colormapped output.) If you request colormapped
240
+ output then the returned data array contains a single JSAMPLE per pixel;
241
+ its value is an index into a color map. The color map is represented as
242
+ a 2-D JSAMPARRAY in which each row holds the values of one color component,
243
+ that is, colormap[i][j] is the value of the i'th color component for pixel
244
+ value (map index) j. Note that since the colormap indexes are stored in
245
+ JSAMPLEs, the maximum number of colors is limited by the size of JSAMPLE
246
+ (ie, at most 256 colors for an 8-bit JPEG library).
247
+
248
+
249
+ Compression details
250
+ -------------------
251
+
252
+ Here we revisit the JPEG compression outline given in the overview.
253
+
254
+ 1. Allocate and initialize a JPEG compression object.
255
+
256
+ A JPEG compression object is a "struct jpeg_compress_struct". (It also has
257
+ a bunch of subsidiary structures which are allocated via malloc(), but the
258
+ application doesn't control those directly.) This struct can be just a local
259
+ variable in the calling routine, if a single routine is going to execute the
260
+ whole JPEG compression sequence. Otherwise it can be static or allocated
261
+ from malloc().
262
+
263
+ You will also need a structure representing a JPEG error handler. The part
264
+ of this that the library cares about is a "struct jpeg_error_mgr". If you
265
+ are providing your own error handler, you'll typically want to embed the
266
+ jpeg_error_mgr struct in a larger structure; this is discussed later under
267
+ "Error handling". For now we'll assume you are just using the default error
268
+ handler. The default error handler will print JPEG error/warning messages
269
+ on stderr, and it will call exit() if a fatal error occurs.
270
+
271
+ You must initialize the error handler structure, store a pointer to it into
272
+ the JPEG object's "err" field, and then call jpeg_create_compress() to
273
+ initialize the rest of the JPEG object.
274
+
275
+ Typical code for this step, if you are using the default error handler, is
276
+
277
+ struct jpeg_compress_struct cinfo;
278
+ struct jpeg_error_mgr jerr;
279
+ ...
280
+ cinfo.err = jpeg_std_error(&jerr);
281
+ jpeg_create_compress(&cinfo);
282
+
283
+ jpeg_create_compress allocates a small amount of memory, so it could fail
284
+ if you are out of memory. In that case it will exit via the error handler;
285
+ that's why the error handler must be initialized first.
286
+
287
+
288
+ 2. Specify the destination for the compressed data (eg, a file).
289
+
290
+ As previously mentioned, the JPEG library delivers compressed data to a
291
+ "data destination" module. The library includes one data destination
292
+ module which knows how to write to a stdio stream. You can use your own
293
+ destination module if you want to do something else, as discussed later.
294
+
295
+ If you use the standard destination module, you must open the target stdio
296
+ stream beforehand. Typical code for this step looks like:
297
+
298
+ FILE *outfile;
299
+ ...
300
+ if ((outfile = fopen(filename, "wb")) == NULL) {
301
+ fprintf(stderr, "can't open %s\n", filename);
302
+ exit(1);
303
+ }
304
+ jpeg_stdio_dest(&cinfo, outfile);
305
+
306
+ where the last line invokes the standard destination module.
307
+
308
+ WARNING: it is critical that the binary compressed data be delivered to the
309
+ output file unchanged. On non-Unix systems the stdio library may perform
310
+ newline translation or otherwise corrupt binary data. To suppress this
311
+ behavior, you may need to use a "b" option to fopen (as shown above), or use
312
+ setmode() or another routine to put the stdio stream in binary mode. See
313
+ cjpeg.c and djpeg.c for code that has been found to work on many systems.
314
+
315
+ You can select the data destination after setting other parameters (step 3),
316
+ if that's more convenient. You may not change the destination between
317
+ calling jpeg_start_compress() and jpeg_finish_compress().
318
+
319
+
320
+ 3. Set parameters for compression, including image size & colorspace.
321
+
322
+ You must supply information about the source image by setting the following
323
+ fields in the JPEG object (cinfo structure):
324
+
325
+ image_width Width of image, in pixels
326
+ image_height Height of image, in pixels
327
+ input_components Number of color channels (samples per pixel)
328
+ in_color_space Color space of source image
329
+
330
+ The image dimensions are, hopefully, obvious. JPEG supports image dimensions
331
+ of 1 to 64K pixels in either direction. The input color space is typically
332
+ RGB or grayscale, and input_components is 3 or 1 accordingly. (See "Special
333
+ color spaces", later, for more info.) The in_color_space field must be
334
+ assigned one of the J_COLOR_SPACE enum constants, typically JCS_RGB or
335
+ JCS_GRAYSCALE.
336
+
337
+ JPEG has a large number of compression parameters that determine how the
338
+ image is encoded. Most applications don't need or want to know about all
339
+ these parameters. You can set all the parameters to reasonable defaults by
340
+ calling jpeg_set_defaults(); then, if there are particular values you want
341
+ to change, you can do so after that. The "Compression parameter selection"
342
+ section tells about all the parameters.
343
+
344
+ You must set in_color_space correctly before calling jpeg_set_defaults(),
345
+ because the defaults depend on the source image colorspace. However the
346
+ other three source image parameters need not be valid until you call
347
+ jpeg_start_compress(). There's no harm in calling jpeg_set_defaults() more
348
+ than once, if that happens to be convenient.
349
+
350
+ Typical code for a 24-bit RGB source image is
351
+
352
+ cinfo.image_width = Width; /* image width and height, in pixels */
353
+ cinfo.image_height = Height;
354
+ cinfo.input_components = 3; /* # of color components per pixel */
355
+ cinfo.in_color_space = JCS_RGB; /* colorspace of input image */
356
+
357
+ jpeg_set_defaults(&cinfo);
358
+ /* Make optional parameter settings here */
359
+
360
+
361
+ 4. jpeg_start_compress(...);
362
+
363
+ After you have established the data destination and set all the necessary
364
+ source image info and other parameters, call jpeg_start_compress() to begin
365
+ a compression cycle. This will initialize internal state, allocate working
366
+ storage, and emit the first few bytes of the JPEG datastream header.
367
+
368
+ Typical code:
369
+
370
+ jpeg_start_compress(&cinfo, TRUE);
371
+
372
+ The "TRUE" parameter ensures that a complete JPEG interchange datastream
373
+ will be written. This is appropriate in most cases. If you think you might
374
+ want to use an abbreviated datastream, read the section on abbreviated
375
+ datastreams, below.
376
+
377
+ Once you have called jpeg_start_compress(), you may not alter any JPEG
378
+ parameters or other fields of the JPEG object until you have completed
379
+ the compression cycle.
380
+
381
+
382
+ 5. while (scan lines remain to be written)
383
+ jpeg_write_scanlines(...);
384
+
385
+ Now write all the required image data by calling jpeg_write_scanlines()
386
+ one or more times. You can pass one or more scanlines in each call, up
387
+ to the total image height. In most applications it is convenient to pass
388
+ just one or a few scanlines at a time. The expected format for the passed
389
+ data is discussed under "Data formats", above.
390
+
391
+ Image data should be written in top-to-bottom scanline order.
392
+ Rec. ITU-T T.81 | ISO/IEC 10918-1 says, "Applications determine which edges of
393
+ a source image are defined as top, bottom, left, and right." However, if you
394
+ want your files to be compatible with everyone else's, then top-to-bottom order
395
+ must be used. If the source data must be read in bottom-to-top order, then you
396
+ can use the JPEG library's virtual array mechanism to invert the data
397
+ efficiently. Examples of this can be found in the sample application cjpeg.
398
+
399
+ The library maintains a count of the number of scanlines written so far
400
+ in the next_scanline field of the JPEG object. Usually you can just use
401
+ this variable as the loop counter, so that the loop test looks like
402
+ "while (cinfo.next_scanline < cinfo.image_height)".
403
+
404
+ Code for this step depends heavily on the way that you store the source data.
405
+ example.txt shows the following code for the case of a full-size 2-D source
406
+ array containing 3-byte RGB pixels:
407
+
408
+ JSAMPROW row_pointer[1]; /* pointer to a single row */
409
+ int row_stride; /* physical row width in buffer */
410
+
411
+ row_stride = image_width * 3; /* JSAMPLEs per row in image_buffer */
412
+
413
+ while (cinfo.next_scanline < cinfo.image_height) {
414
+ row_pointer[0] = &image_buffer[cinfo.next_scanline * row_stride];
415
+ jpeg_write_scanlines(&cinfo, row_pointer, 1);
416
+ }
417
+
418
+ jpeg_write_scanlines() returns the number of scanlines actually written.
419
+ This will normally be equal to the number passed in, so you can usually
420
+ ignore the return value. It is different in just two cases:
421
+ * If you try to write more scanlines than the declared image height,
422
+ the additional scanlines are ignored.
423
+ * If you use a suspending data destination manager, output buffer overrun
424
+ will cause the compressor to return before accepting all the passed lines.
425
+ This feature is discussed under "I/O suspension", below. The normal
426
+ stdio destination manager will NOT cause this to happen.
427
+ In any case, the return value is the same as the change in the value of
428
+ next_scanline.
429
+
430
+
431
+ 6. jpeg_finish_compress(...);
432
+
433
+ After all the image data has been written, call jpeg_finish_compress() to
434
+ complete the compression cycle. This step is ESSENTIAL to ensure that the
435
+ last bufferload of data is written to the data destination.
436
+ jpeg_finish_compress() also releases working memory associated with the JPEG
437
+ object.
438
+
439
+ Typical code:
440
+
441
+ jpeg_finish_compress(&cinfo);
442
+
443
+ If using the stdio destination manager, don't forget to close the output
444
+ stdio stream (if necessary) afterwards.
445
+
446
+ If you have requested a multi-pass operating mode, such as Huffman code
447
+ optimization, jpeg_finish_compress() will perform the additional passes using
448
+ data buffered by the first pass. In this case jpeg_finish_compress() may take
449
+ quite a while to complete. With the default compression parameters, this will
450
+ not happen.
451
+
452
+ It is an error to call jpeg_finish_compress() before writing the necessary
453
+ total number of scanlines. If you wish to abort compression, call
454
+ jpeg_abort() as discussed below.
455
+
456
+ After completing a compression cycle, you may dispose of the JPEG object
457
+ as discussed next, or you may use it to compress another image. In that case
458
+ return to step 2, 3, or 4 as appropriate. If you do not change the
459
+ destination manager, the new datastream will be written to the same target.
460
+ If you do not change any JPEG parameters, the new datastream will be written
461
+ with the same parameters as before. Note that you can change the input image
462
+ dimensions freely between cycles, but if you change the input colorspace, you
463
+ should call jpeg_set_defaults() to adjust for the new colorspace; and then
464
+ you'll need to repeat all of step 3.
465
+
466
+
467
+ 7. Release the JPEG compression object.
468
+
469
+ When you are done with a JPEG compression object, destroy it by calling
470
+ jpeg_destroy_compress(). This will free all subsidiary memory (regardless of
471
+ the previous state of the object). Or you can call jpeg_destroy(), which
472
+ works for either compression or decompression objects --- this may be more
473
+ convenient if you are sharing code between compression and decompression
474
+ cases. (Actually, these routines are equivalent except for the declared type
475
+ of the passed pointer. To avoid gripes from ANSI C compilers, jpeg_destroy()
476
+ should be passed a j_common_ptr.)
477
+
478
+ If you allocated the jpeg_compress_struct structure from malloc(), freeing
479
+ it is your responsibility --- jpeg_destroy() won't. Ditto for the error
480
+ handler structure.
481
+
482
+ Typical code:
483
+
484
+ jpeg_destroy_compress(&cinfo);
485
+
486
+
487
+ 8. Aborting.
488
+
489
+ If you decide to abort a compression cycle before finishing, you can clean up
490
+ in either of two ways:
491
+
492
+ * If you don't need the JPEG object any more, just call
493
+ jpeg_destroy_compress() or jpeg_destroy() to release memory. This is
494
+ legitimate at any point after calling jpeg_create_compress() --- in fact,
495
+ it's safe even if jpeg_create_compress() fails.
496
+
497
+ * If you want to re-use the JPEG object, call jpeg_abort_compress(), or call
498
+ jpeg_abort() which works on both compression and decompression objects.
499
+ This will return the object to an idle state, releasing any working memory.
500
+ jpeg_abort() is allowed at any time after successful object creation.
501
+
502
+ Note that cleaning up the data destination, if required, is your
503
+ responsibility; neither of these routines will call term_destination().
504
+ (See "Compressed data handling", below, for more about that.)
505
+
506
+ jpeg_destroy() and jpeg_abort() are the only safe calls to make on a JPEG
507
+ object that has reported an error by calling error_exit (see "Error handling"
508
+ for more info). The internal state of such an object is likely to be out of
509
+ whack. Either of these two routines will return the object to a known state.
510
+
511
+
512
+ Decompression details
513
+ ---------------------
514
+
515
+ Here we revisit the JPEG decompression outline given in the overview.
516
+
517
+ 1. Allocate and initialize a JPEG decompression object.
518
+
519
+ This is just like initialization for compression, as discussed above,
520
+ except that the object is a "struct jpeg_decompress_struct" and you
521
+ call jpeg_create_decompress(). Error handling is exactly the same.
522
+
523
+ Typical code:
524
+
525
+ struct jpeg_decompress_struct cinfo;
526
+ struct jpeg_error_mgr jerr;
527
+ ...
528
+ cinfo.err = jpeg_std_error(&jerr);
529
+ jpeg_create_decompress(&cinfo);
530
+
531
+ (Both here and in the IJG code, we usually use variable name "cinfo" for
532
+ both compression and decompression objects.)
533
+
534
+
535
+ 2. Specify the source of the compressed data (eg, a file).
536
+
537
+ As previously mentioned, the JPEG library reads compressed data from a "data
538
+ source" module. The library includes one data source module which knows how
539
+ to read from a stdio stream. You can use your own source module if you want
540
+ to do something else, as discussed later.
541
+
542
+ If you use the standard source module, you must open the source stdio stream
543
+ beforehand. Typical code for this step looks like:
544
+
545
+ FILE *infile;
546
+ ...
547
+ if ((infile = fopen(filename, "rb")) == NULL) {
548
+ fprintf(stderr, "can't open %s\n", filename);
549
+ exit(1);
550
+ }
551
+ jpeg_stdio_src(&cinfo, infile);
552
+
553
+ where the last line invokes the standard source module.
554
+
555
+ WARNING: it is critical that the binary compressed data be read unchanged.
556
+ On non-Unix systems the stdio library may perform newline translation or
557
+ otherwise corrupt binary data. To suppress this behavior, you may need to use
558
+ a "b" option to fopen (as shown above), or use setmode() or another routine to
559
+ put the stdio stream in binary mode. See cjpeg.c and djpeg.c for code that
560
+ has been found to work on many systems.
561
+
562
+ You may not change the data source between calling jpeg_read_header() and
563
+ jpeg_finish_decompress(). If you wish to read a series of JPEG images from
564
+ a single source file, you should repeat the jpeg_read_header() to
565
+ jpeg_finish_decompress() sequence without reinitializing either the JPEG
566
+ object or the data source module; this prevents buffered input data from
567
+ being discarded.
568
+
569
+
570
+ 3. Call jpeg_read_header() to obtain image info.
571
+
572
+ Typical code for this step is just
573
+
574
+ jpeg_read_header(&cinfo, TRUE);
575
+
576
+ This will read the source datastream header markers, up to the beginning
577
+ of the compressed data proper. On return, the image dimensions and other
578
+ info have been stored in the JPEG object. The application may wish to
579
+ consult this information before selecting decompression parameters.
580
+
581
+ More complex code is necessary if
582
+ * A suspending data source is used --- in that case jpeg_read_header()
583
+ may return before it has read all the header data. See "I/O suspension",
584
+ below. The normal stdio source manager will NOT cause this to happen.
585
+ * Abbreviated JPEG files are to be processed --- see the section on
586
+ abbreviated datastreams. Standard applications that deal only in
587
+ interchange JPEG files need not be concerned with this case either.
588
+
589
+ It is permissible to stop at this point if you just wanted to find out the
590
+ image dimensions and other header info for a JPEG file. In that case,
591
+ call jpeg_destroy() when you are done with the JPEG object, or call
592
+ jpeg_abort() to return it to an idle state before selecting a new data
593
+ source and reading another header.
594
+
595
+
596
+ 4. Set parameters for decompression.
597
+
598
+ jpeg_read_header() sets appropriate default decompression parameters based on
599
+ the properties of the image (in particular, its colorspace). However, you
600
+ may well want to alter these defaults before beginning the decompression.
601
+ For example, the default is to produce full color output from a color file.
602
+ If you want colormapped output you must ask for it. Other options allow the
603
+ returned image to be scaled and allow various speed/quality tradeoffs to be
604
+ selected. "Decompression parameter selection", below, gives details.
605
+
606
+ If the defaults are appropriate, nothing need be done at this step.
607
+
608
+ Note that all default values are set by each call to jpeg_read_header().
609
+ If you reuse a decompression object, you cannot expect your parameter
610
+ settings to be preserved across cycles, as you can for compression.
611
+ You must set desired parameter values each time.
612
+
613
+
614
+ 5. jpeg_start_decompress(...);
615
+
616
+ Once the parameter values are satisfactory, call jpeg_start_decompress() to
617
+ begin decompression. This will initialize internal state, allocate working
618
+ memory, and prepare for returning data.
619
+
620
+ Typical code is just
621
+
622
+ jpeg_start_decompress(&cinfo);
623
+
624
+ If you have requested a multi-pass operating mode, such as 2-pass color
625
+ quantization, jpeg_start_decompress() will do everything needed before data
626
+ output can begin. In this case jpeg_start_decompress() may take quite a while
627
+ to complete. With a single-scan (non progressive) JPEG file and default
628
+ decompression parameters, this will not happen; jpeg_start_decompress() will
629
+ return quickly.
630
+
631
+ After this call, the final output image dimensions, including any requested
632
+ scaling, are available in the JPEG object; so is the selected colormap, if
633
+ colormapped output has been requested. Useful fields include
634
+
635
+ output_width image width and height, as scaled
636
+ output_height
637
+ out_color_components # of color components in out_color_space
638
+ output_components # of color components returned per pixel
639
+ colormap the selected colormap, if any
640
+ actual_number_of_colors number of entries in colormap
641
+
642
+ output_components is 1 (a colormap index) when quantizing colors; otherwise it
643
+ equals out_color_components. It is the number of JSAMPLE values that will be
644
+ emitted per pixel in the output arrays.
645
+
646
+ Typically you will need to allocate data buffers to hold the incoming image.
647
+ You will need output_width * output_components JSAMPLEs per scanline in your
648
+ output buffer, and a total of output_height scanlines will be returned.
649
+
650
+ Note: if you are using the JPEG library's internal memory manager to allocate
651
+ data buffers (as djpeg does), then the manager's protocol requires that you
652
+ request large buffers *before* calling jpeg_start_decompress(). This is a
653
+ little tricky since the output_XXX fields are not normally valid then. You
654
+ can make them valid by calling jpeg_calc_output_dimensions() after setting the
655
+ relevant parameters (scaling, output color space, and quantization flag).
656
+
657
+
658
+ 6. while (scan lines remain to be read)
659
+ jpeg_read_scanlines(...);
660
+
661
+ Now you can read the decompressed image data by calling jpeg_read_scanlines()
662
+ one or more times. At each call, you pass in the maximum number of scanlines
663
+ to be read (ie, the height of your working buffer); jpeg_read_scanlines()
664
+ will return up to that many lines. The return value is the number of lines
665
+ actually read. The format of the returned data is discussed under "Data
666
+ formats", above. Don't forget that grayscale and color JPEGs will return
667
+ different data formats!
668
+
669
+ Image data is returned in top-to-bottom scanline order. If you must write
670
+ out the image in bottom-to-top order, you can use the JPEG library's virtual
671
+ array mechanism to invert the data efficiently. Examples of this can be
672
+ found in the sample application djpeg.
673
+
674
+ The library maintains a count of the number of scanlines returned so far
675
+ in the output_scanline field of the JPEG object. Usually you can just use
676
+ this variable as the loop counter, so that the loop test looks like
677
+ "while (cinfo.output_scanline < cinfo.output_height)". (Note that the test
678
+ should NOT be against image_height, unless you never use scaling. The
679
+ image_height field is the height of the original unscaled image.)
680
+ The return value always equals the change in the value of output_scanline.
681
+
682
+ If you don't use a suspending data source, it is safe to assume that
683
+ jpeg_read_scanlines() reads at least one scanline per call, until the
684
+ bottom of the image has been reached.
685
+
686
+ If you use a buffer larger than one scanline, it is NOT safe to assume that
687
+ jpeg_read_scanlines() fills it. (The current implementation returns only a
688
+ few scanlines per call, no matter how large a buffer you pass.) So you must
689
+ always provide a loop that calls jpeg_read_scanlines() repeatedly until the
690
+ whole image has been read.
691
+
692
+
693
+ 7. jpeg_finish_decompress(...);
694
+
695
+ After all the image data has been read, call jpeg_finish_decompress() to
696
+ complete the decompression cycle. This causes working memory associated
697
+ with the JPEG object to be released.
698
+
699
+ Typical code:
700
+
701
+ jpeg_finish_decompress(&cinfo);
702
+
703
+ If using the stdio source manager, don't forget to close the source stdio
704
+ stream if necessary.
705
+
706
+ It is an error to call jpeg_finish_decompress() before reading the correct
707
+ total number of scanlines. If you wish to abort decompression, call
708
+ jpeg_abort() as discussed below.
709
+
710
+ After completing a decompression cycle, you may dispose of the JPEG object as
711
+ discussed next, or you may use it to decompress another image. In that case
712
+ return to step 2 or 3 as appropriate. If you do not change the source
713
+ manager, the next image will be read from the same source.
714
+
715
+
716
+ 8. Release the JPEG decompression object.
717
+
718
+ When you are done with a JPEG decompression object, destroy it by calling
719
+ jpeg_destroy_decompress() or jpeg_destroy(). The previous discussion of
720
+ destroying compression objects applies here too.
721
+
722
+ Typical code:
723
+
724
+ jpeg_destroy_decompress(&cinfo);
725
+
726
+
727
+ 9. Aborting.
728
+
729
+ You can abort a decompression cycle by calling jpeg_destroy_decompress() or
730
+ jpeg_destroy() if you don't need the JPEG object any more, or
731
+ jpeg_abort_decompress() or jpeg_abort() if you want to reuse the object.
732
+ The previous discussion of aborting compression cycles applies here too.
733
+
734
+
735
+ Partial image decompression
736
+ ---------------------------
737
+
738
+ Partial image decompression is convenient for performance-critical applications
739
+ that wish to view only a portion of a large JPEG image without decompressing
740
+ the whole thing. It it also useful in memory-constrained environments (such as
741
+ on mobile devices.) This library provides the following functions to support
742
+ partial image decompression:
743
+
744
+ 1. Skipping rows when decompressing
745
+
746
+ jpeg_skip_scanlines(j_decompress_ptr cinfo, JDIMENSION num_lines);
747
+
748
+ This function provides application programmers with the ability to skip over
749
+ multiple rows in the JPEG image.
750
+
751
+ Suspending data sources are not supported by this function. Calling
752
+ jpeg_skip_scanlines() with a suspending data source will result in undefined
753
+ behavior. Two-pass color quantization is also not supported by this function.
754
+ Calling jpeg_skip_scanlines() with two-pass color quantization enabled will
755
+ result in an error.
756
+
757
+ jpeg_skip_scanlines() will not allow skipping past the bottom of the image. If
758
+ the value of num_lines is large enough to skip past the bottom of the image,
759
+ then the function will skip to the end of the image instead.
760
+
761
+ If the value of num_lines is valid, then jpeg_skip_scanlines() will always
762
+ skip all of the input rows requested. There is no need to inspect the return
763
+ value of the function in that case.
764
+
765
+ Best results will be achieved by calling jpeg_skip_scanlines() for large chunks
766
+ of rows. The function should be viewed as a way to quickly jump to a
767
+ particular vertical offset in the JPEG image in order to decode a subset of the
768
+ image. Used in this manner, it will provide significant performance
769
+ improvements.
770
+
771
+ Calling jpeg_skip_scanlines() for small values of num_lines has several
772
+ potential drawbacks:
773
+ 1) JPEG decompression occurs in blocks, so if jpeg_skip_scanlines() is
774
+ called from the middle of a decompression block, then it is likely that
775
+ much of the decompression work has already been done for the first
776
+ couple of rows that need to be skipped.
777
+ 2) When this function returns, it must leave the decompressor in a state
778
+ such that it is ready to read the next line. This may involve
779
+ decompressing a block that must be partially skipped.
780
+ These issues are especially tricky for cases in which upsampling requires
781
+ context rows. In the worst case, jpeg_skip_scanlines() will perform similarly
782
+ to jpeg_read_scanlines() (since it will actually call jpeg_read_scanlines().)
783
+
784
+ 2. Decompressing partial scanlines
785
+
786
+ jpeg_crop_scanline (j_decompress_ptr cinfo, JDIMENSION *xoffset,
787
+ JDIMENSION *width)
788
+
789
+ This function provides application programmers with the ability to decompress
790
+ only a portion of each row in the JPEG image. It must be called after
791
+ jpeg_start_decompress() and before any calls to jpeg_read_scanlines() or
792
+ jpeg_skip_scanlines().
793
+
794
+ If xoffset and width do not form a valid subset of the image row, then this
795
+ function will generate an error. Note that if the output image is scaled, then
796
+ xoffset and width are relative to the scaled image dimensions.
797
+
798
+ xoffset and width are passed by reference because xoffset must fall on an iMCU
799
+ boundary. If it doesn't, then it will be moved left to the nearest iMCU
800
+ boundary, and width will be increased accordingly. If the calling program does
801
+ not like the adjusted values of xoffset and width, then it can call
802
+ jpeg_crop_scanline() again with new values (for instance, if it wants to move
803
+ xoffset to the nearest iMCU boundary to the right instead of to the left.)
804
+
805
+ After calling this function, cinfo->output_width will be set to the adjusted
806
+ width. This value should be used when allocating an output buffer to pass to
807
+ jpeg_read_scanlines().
808
+
809
+ The output image from a partial-width decompression will be identical to the
810
+ corresponding image region from a full decode, with one exception: The "fancy"
811
+ (smooth) h2v2 (4:2:0) and h2v1 (4:2:2) upsampling algorithms fill in the
812
+ missing chroma components by averaging the chroma components from neighboring
813
+ pixels, except on the right and left edges of the image (where there are no
814
+ neighboring pixels.) When performing a partial-width decompression, these
815
+ "fancy" upsampling algorithms may treat the left and right edges of the partial
816
+ image region as if they are the left and right edges of the image, meaning that
817
+ the upsampling algorithm may be simplified. The result is that the pixels on
818
+ the left or right edge of the partial image may not be exactly identical to the
819
+ corresponding pixels in the original image.
820
+
821
+
822
+ Mechanics of usage: include files, linking, etc
823
+ -----------------------------------------------
824
+
825
+ Applications using the JPEG library should include the header file jpeglib.h
826
+ to obtain declarations of data types and routines. Before including
827
+ jpeglib.h, include system headers that define at least the typedefs FILE and
828
+ size_t. On ANSI-conforming systems, including <stdio.h> is sufficient; on
829
+ older Unix systems, you may need <sys/types.h> to define size_t.
830
+
831
+ If the application needs to refer to individual JPEG library error codes, also
832
+ include jerror.h to define those symbols.
833
+
834
+ jpeglib.h indirectly includes the files jconfig.h and jmorecfg.h. If you are
835
+ installing the JPEG header files in a system directory, you will want to
836
+ install all four files: jpeglib.h, jerror.h, jconfig.h, jmorecfg.h.
837
+
838
+ The most convenient way to include the JPEG code into your executable program
839
+ is to prepare a library file ("libjpeg.a", or a corresponding name on non-Unix
840
+ machines) and reference it at your link step. If you use only half of the
841
+ library (only compression or only decompression), only that much code will be
842
+ included from the library, unless your linker is hopelessly brain-damaged.
843
+ The supplied build system builds libjpeg.a automatically.
844
+
845
+ It may be worth pointing out that the core JPEG library does not actually
846
+ require the stdio library: only the default source/destination managers and
847
+ error handler need it. You can use the library in a stdio-less environment
848
+ if you replace those modules and use jmemnobs.c (or another memory manager of
849
+ your own devising). More info about the minimum system library requirements
850
+ may be found in jinclude.h.
851
+
852
+
853
+ ADVANCED FEATURES
854
+ =================
855
+
856
+ Compression parameter selection
857
+ -------------------------------
858
+
859
+ This section describes all the optional parameters you can set for JPEG
860
+ compression, as well as the "helper" routines provided to assist in this
861
+ task. Proper setting of some parameters requires detailed understanding
862
+ of the JPEG standard; if you don't know what a parameter is for, it's best
863
+ not to mess with it! See REFERENCES in the README.ijg file for pointers to
864
+ more info about JPEG.
865
+
866
+ It's a good idea to call jpeg_set_defaults() first, even if you plan to set
867
+ all the parameters; that way your code is more likely to work with future JPEG
868
+ libraries that have additional parameters. For the same reason, we recommend
869
+ you use a helper routine where one is provided, in preference to twiddling
870
+ cinfo fields directly.
871
+
872
+ The helper routines are:
873
+
874
+ jpeg_set_defaults (j_compress_ptr cinfo)
875
+ This routine sets all JPEG parameters to reasonable defaults, using
876
+ only the input image's color space (field in_color_space, which must
877
+ already be set in cinfo). Many applications will only need to use
878
+ this routine and perhaps jpeg_set_quality().
879
+
880
+ jpeg_set_colorspace (j_compress_ptr cinfo, J_COLOR_SPACE colorspace)
881
+ Sets the JPEG file's colorspace (field jpeg_color_space) as specified,
882
+ and sets other color-space-dependent parameters appropriately. See
883
+ "Special color spaces", below, before using this. A large number of
884
+ parameters, including all per-component parameters, are set by this
885
+ routine; if you want to twiddle individual parameters you should call
886
+ jpeg_set_colorspace() before rather than after.
887
+
888
+ jpeg_default_colorspace (j_compress_ptr cinfo)
889
+ Selects an appropriate JPEG colorspace based on cinfo->in_color_space,
890
+ and calls jpeg_set_colorspace(). This is actually a subroutine of
891
+ jpeg_set_defaults(). It's broken out in case you want to change
892
+ just the colorspace-dependent JPEG parameters.
893
+
894
+ jpeg_set_quality (j_compress_ptr cinfo, int quality, boolean force_baseline)
895
+ Constructs JPEG quantization tables appropriate for the indicated
896
+ quality setting. The quality value is expressed on the 0..100 scale
897
+ recommended by IJG (cjpeg's "-quality" switch uses this routine).
898
+ Note that the exact mapping from quality values to tables may change
899
+ in future IJG releases as more is learned about DCT quantization.
900
+ If the force_baseline parameter is TRUE, then the quantization table
901
+ entries are constrained to the range 1..255 for full JPEG baseline
902
+ compatibility. In the current implementation, this only makes a
903
+ difference for quality settings below 25, and it effectively prevents
904
+ very small/low quality files from being generated. The IJG decoder
905
+ is capable of reading the non-baseline files generated at low quality
906
+ settings when force_baseline is FALSE, but other decoders may not be.
907
+
908
+ jpeg_set_linear_quality (j_compress_ptr cinfo, int scale_factor,
909
+ boolean force_baseline)
910
+ Same as jpeg_set_quality() except that the generated tables are the
911
+ sample tables given in Annex K (Clause K.1) of
912
+ Rec. ITU-T T.81 (1992) | ISO/IEC 10918-1:1994, multiplied by the
913
+ specified scale factor (which is expressed as a percentage; thus
914
+ scale_factor = 100 reproduces the spec's tables). Note that larger
915
+ scale factors give lower quality. This entry point is useful for
916
+ conforming to the Adobe PostScript DCT conventions, but we do not
917
+ recommend linear scaling as a user-visible quality scale otherwise.
918
+ force_baseline again constrains the computed table entries to 1..255.
919
+
920
+ int jpeg_quality_scaling (int quality)
921
+ Converts a value on the IJG-recommended quality scale to a linear
922
+ scaling percentage. Note that this routine may change or go away
923
+ in future releases --- IJG may choose to adopt a scaling method that
924
+ can't be expressed as a simple scalar multiplier, in which case the
925
+ premise of this routine collapses. Caveat user.
926
+
927
+ jpeg_default_qtables (j_compress_ptr cinfo, boolean force_baseline)
928
+ [libjpeg v7+ API/ABI emulation only]
929
+ Set default quantization tables with linear q_scale_factor[] values
930
+ (see below).
931
+
932
+ jpeg_add_quant_table (j_compress_ptr cinfo, int which_tbl,
933
+ const unsigned int *basic_table,
934
+ int scale_factor, boolean force_baseline)
935
+ Allows an arbitrary quantization table to be created. which_tbl
936
+ indicates which table slot to fill. basic_table points to an array
937
+ of 64 unsigned ints given in normal array order. These values are
938
+ multiplied by scale_factor/100 and then clamped to the range 1..65535
939
+ (or to 1..255 if force_baseline is TRUE).
940
+ CAUTION: prior to library version 6a, jpeg_add_quant_table expected
941
+ the basic table to be given in JPEG zigzag order. If you need to
942
+ write code that works with either older or newer versions of this
943
+ routine, you must check the library version number. Something like
944
+ "#if JPEG_LIB_VERSION >= 61" is the right test.
945
+
946
+ jpeg_simple_progression (j_compress_ptr cinfo)
947
+ Generates a default scan script for writing a progressive-JPEG file.
948
+ This is the recommended method of creating a progressive file,
949
+ unless you want to make a custom scan sequence. You must ensure that
950
+ the JPEG color space is set correctly before calling this routine.
951
+
952
+
953
+ Compression parameters (cinfo fields) include:
954
+
955
+ boolean arith_code
956
+ If TRUE, use arithmetic coding.
957
+ If FALSE, use Huffman coding.
958
+
959
+ J_DCT_METHOD dct_method
960
+ Selects the algorithm used for the DCT step. Choices are:
961
+ JDCT_ISLOW: accurate integer method
962
+ JDCT_IFAST: less accurate integer method [legacy feature]
963
+ JDCT_FLOAT: floating-point method [legacy feature]
964
+ JDCT_DEFAULT: default method (normally JDCT_ISLOW)
965
+ JDCT_FASTEST: fastest method (normally JDCT_IFAST)
966
+ When the Independent JPEG Group's software was first released in 1991,
967
+ the compression time for a 1-megapixel JPEG image on a mainstream PC
968
+ was measured in minutes. Thus, JDCT_IFAST provided noticeable
969
+ performance benefits. On modern CPUs running libjpeg-turbo, however,
970
+ the compression time for a 1-megapixel JPEG image is measured in
971
+ milliseconds, and thus the performance benefits of JDCT_IFAST are much
972
+ less noticeable. On modern x86/x86-64 CPUs that support AVX2
973
+ instructions, JDCT_IFAST and JDCT_ISLOW have similar performance. On
974
+ other types of CPUs, JDCT_IFAST is generally about 5-15% faster than
975
+ JDCT_ISLOW.
976
+
977
+ For quality levels of 90 and below, there should be little or no
978
+ perceptible quality difference between the two algorithms. For quality
979
+ levels above 90, however, the difference between JDCT_IFAST and
980
+ JDCT_ISLOW becomes more pronounced. With quality=97, for instance,
981
+ JDCT_IFAST incurs generally about a 1-3 dB loss in PSNR relative to
982
+ JDCT_ISLOW, but this can be larger for some images. Do not use
983
+ JDCT_IFAST with quality levels above 97. The algorithm often
984
+ degenerates at quality=98 and above and can actually produce a more
985
+ lossy image than if lower quality levels had been used. Also, in
986
+ libjpeg-turbo, JDCT_IFAST is not fully accelerated for quality levels
987
+ above 97, so it will be slower than JDCT_ISLOW.
988
+
989
+ JDCT_FLOAT does not produce significantly more accurate results than
990
+ JDCT_ISLOW, and it is much slower. JDCT_FLOAT may also give different
991
+ results on different machines due to varying roundoff behavior, whereas
992
+ the integer methods should give the same results on all machines.
993
+
994
+ J_COLOR_SPACE jpeg_color_space
995
+ int num_components
996
+ The JPEG color space and corresponding number of components; see
997
+ "Special color spaces", below, for more info. We recommend using
998
+ jpeg_set_color_space() if you want to change these.
999
+
1000
+ boolean optimize_coding
1001
+ TRUE causes the compressor to compute optimal Huffman coding tables
1002
+ for the image. This requires an extra pass over the data and
1003
+ therefore costs a good deal of space and time. The default is
1004
+ FALSE, which tells the compressor to use the supplied or default
1005
+ Huffman tables. In most cases optimal tables save only a few percent
1006
+ of file size compared to the default tables. Note that when this is
1007
+ TRUE, you need not supply Huffman tables at all, and any you do
1008
+ supply will be overwritten.
1009
+
1010
+ unsigned int restart_interval
1011
+ int restart_in_rows
1012
+ To emit restart markers in the JPEG file, set one of these nonzero.
1013
+ Set restart_interval to specify the exact interval in MCU blocks.
1014
+ Set restart_in_rows to specify the interval in MCU rows. (If
1015
+ restart_in_rows is not 0, then restart_interval is set after the
1016
+ image width in MCUs is computed.) Defaults are zero (no restarts).
1017
+ One restart marker per MCU row is often a good choice.
1018
+ NOTE: the overhead of restart markers is higher in grayscale JPEG
1019
+ files than in color files, and MUCH higher in progressive JPEGs.
1020
+ If you use restarts, you may want to use larger intervals in those
1021
+ cases.
1022
+
1023
+ const jpeg_scan_info *scan_info
1024
+ int num_scans
1025
+ By default, scan_info is NULL; this causes the compressor to write a
1026
+ single-scan sequential JPEG file. If not NULL, scan_info points to
1027
+ an array of scan definition records of length num_scans. The
1028
+ compressor will then write a JPEG file having one scan for each scan
1029
+ definition record. This is used to generate noninterleaved or
1030
+ progressive JPEG files. The library checks that the scan array
1031
+ defines a valid JPEG scan sequence. (jpeg_simple_progression creates
1032
+ a suitable scan definition array for progressive JPEG.) This is
1033
+ discussed further under "Progressive JPEG support".
1034
+
1035
+ int smoothing_factor
1036
+ If non-zero, the input image is smoothed; the value should be 1 for
1037
+ minimal smoothing to 100 for maximum smoothing. Consult jcsample.c
1038
+ for details of the smoothing algorithm. The default is zero.
1039
+
1040
+ boolean write_JFIF_header
1041
+ If TRUE, a JFIF APP0 marker is emitted. jpeg_set_defaults() and
1042
+ jpeg_set_colorspace() set this TRUE if a JFIF-legal JPEG color space
1043
+ (ie, YCbCr or grayscale) is selected, otherwise FALSE.
1044
+
1045
+ UINT8 JFIF_major_version
1046
+ UINT8 JFIF_minor_version
1047
+ The version number to be written into the JFIF marker.
1048
+ jpeg_set_defaults() initializes the version to 1.01 (major=minor=1).
1049
+ You should set it to 1.02 (major=1, minor=2) if you plan to write
1050
+ any JFIF 1.02 extension markers.
1051
+
1052
+ UINT8 density_unit
1053
+ UINT16 X_density
1054
+ UINT16 Y_density
1055
+ The resolution information to be written into the JFIF marker;
1056
+ not used otherwise. density_unit may be 0 for unknown,
1057
+ 1 for dots/inch, or 2 for dots/cm. The default values are 0,1,1
1058
+ indicating square pixels of unknown size.
1059
+
1060
+ boolean write_Adobe_marker
1061
+ If TRUE, an Adobe APP14 marker is emitted. jpeg_set_defaults() and
1062
+ jpeg_set_colorspace() set this TRUE if JPEG color space RGB, CMYK,
1063
+ or YCCK is selected, otherwise FALSE. It is generally a bad idea
1064
+ to set both write_JFIF_header and write_Adobe_marker. In fact,
1065
+ you probably shouldn't change the default settings at all --- the
1066
+ default behavior ensures that the JPEG file's color space can be
1067
+ recognized by the decoder.
1068
+
1069
+ JQUANT_TBL *quant_tbl_ptrs[NUM_QUANT_TBLS]
1070
+ Pointers to coefficient quantization tables, one per table slot,
1071
+ or NULL if no table is defined for a slot. Usually these should
1072
+ be set via one of the above helper routines; jpeg_add_quant_table()
1073
+ is general enough to define any quantization table. The other
1074
+ routines will set up table slot 0 for luminance quality and table
1075
+ slot 1 for chrominance.
1076
+
1077
+ int q_scale_factor[NUM_QUANT_TBLS]
1078
+ [libjpeg v7+ API/ABI emulation only]
1079
+ Linear quantization scaling factors (0-100, default 100)
1080
+ for use with jpeg_default_qtables().
1081
+ See rdswitch.c and cjpeg.c for an example of usage.
1082
+ Note that the q_scale_factor[] values use "linear" scales, so JPEG
1083
+ quality levels chosen by the user must be converted to these scales
1084
+ using jpeg_quality_scaling(). Here is an example that corresponds to
1085
+ cjpeg -quality 90,70:
1086
+
1087
+ jpeg_set_defaults(cinfo);
1088
+
1089
+ /* Set luminance quality 90. */
1090
+ cinfo->q_scale_factor[0] = jpeg_quality_scaling(90);
1091
+ /* Set chrominance quality 70. */
1092
+ cinfo->q_scale_factor[1] = jpeg_quality_scaling(70);
1093
+
1094
+ jpeg_default_qtables(cinfo, force_baseline);
1095
+
1096
+ CAUTION: Setting separate quality levels for chrominance and luminance
1097
+ is mainly only useful if chrominance subsampling is disabled. 2x2
1098
+ chrominance subsampling (AKA "4:2:0") is the default, but you can
1099
+ explicitly disable subsampling as follows:
1100
+
1101
+ cinfo->comp_info[0].v_samp_factor = 1;
1102
+ cinfo->comp_info[0].h_samp_factor = 1;
1103
+
1104
+ JHUFF_TBL *dc_huff_tbl_ptrs[NUM_HUFF_TBLS]
1105
+ JHUFF_TBL *ac_huff_tbl_ptrs[NUM_HUFF_TBLS]
1106
+ Pointers to Huffman coding tables, one per table slot, or NULL if
1107
+ no table is defined for a slot. Slots 0 and 1 are filled with the
1108
+ JPEG sample tables by jpeg_set_defaults(). If you need to allocate
1109
+ more table structures, jpeg_alloc_huff_table() may be used.
1110
+ Note that optimal Huffman tables can be computed for an image
1111
+ by setting optimize_coding, as discussed above; there's seldom
1112
+ any need to mess with providing your own Huffman tables.
1113
+
1114
+
1115
+ [libjpeg v7+ API/ABI emulation only]
1116
+ The actual dimensions of the JPEG image that will be written to the file are
1117
+ given by the following fields. These are computed from the input image
1118
+ dimensions and the compression parameters by jpeg_start_compress(). You can
1119
+ also call jpeg_calc_jpeg_dimensions() to obtain the values that will result
1120
+ from the current parameter settings. This can be useful if you are trying
1121
+ to pick a scaling ratio that will get close to a desired target size.
1122
+
1123
+ JDIMENSION jpeg_width Actual dimensions of output image.
1124
+ JDIMENSION jpeg_height
1125
+
1126
+
1127
+ Per-component parameters are stored in the struct cinfo.comp_info[i] for
1128
+ component number i. Note that components here refer to components of the
1129
+ JPEG color space, *not* the source image color space. A suitably large
1130
+ comp_info[] array is allocated by jpeg_set_defaults(); if you choose not
1131
+ to use that routine, it's up to you to allocate the array.
1132
+
1133
+ int component_id
1134
+ The one-byte identifier code to be recorded in the JPEG file for
1135
+ this component. For the standard color spaces, we recommend you
1136
+ leave the default values alone.
1137
+
1138
+ int h_samp_factor
1139
+ int v_samp_factor
1140
+ Horizontal and vertical sampling factors for the component; must
1141
+ be 1..4 according to the JPEG standard. Note that larger sampling
1142
+ factors indicate a higher-resolution component; many people find
1143
+ this behavior quite unintuitive. The default values are 2,2 for
1144
+ luminance components and 1,1 for chrominance components, except
1145
+ for grayscale where 1,1 is used.
1146
+
1147
+ int quant_tbl_no
1148
+ Quantization table number for component. The default value is
1149
+ 0 for luminance components and 1 for chrominance components.
1150
+
1151
+ int dc_tbl_no
1152
+ int ac_tbl_no
1153
+ DC and AC entropy coding table numbers. The default values are
1154
+ 0 for luminance components and 1 for chrominance components.
1155
+
1156
+ int component_index
1157
+ Must equal the component's index in comp_info[]. (Beginning in
1158
+ release v6, the compressor library will fill this in automatically;
1159
+ you don't have to.)
1160
+
1161
+
1162
+ Decompression parameter selection
1163
+ ---------------------------------
1164
+
1165
+ Decompression parameter selection is somewhat simpler than compression
1166
+ parameter selection, since all of the JPEG internal parameters are
1167
+ recorded in the source file and need not be supplied by the application.
1168
+ (Unless you are working with abbreviated files, in which case see
1169
+ "Abbreviated datastreams", below.) Decompression parameters control
1170
+ the postprocessing done on the image to deliver it in a format suitable
1171
+ for the application's use. Many of the parameters control speed/quality
1172
+ tradeoffs, in which faster decompression may be obtained at the price of
1173
+ a poorer-quality image. The defaults select the highest quality (slowest)
1174
+ processing.
1175
+
1176
+ The following fields in the JPEG object are set by jpeg_read_header() and
1177
+ may be useful to the application in choosing decompression parameters:
1178
+
1179
+ JDIMENSION image_width Width and height of image
1180
+ JDIMENSION image_height
1181
+ int num_components Number of color components
1182
+ J_COLOR_SPACE jpeg_color_space Colorspace of image
1183
+ boolean saw_JFIF_marker TRUE if a JFIF APP0 marker was seen
1184
+ UINT8 JFIF_major_version Version information from JFIF marker
1185
+ UINT8 JFIF_minor_version
1186
+ UINT8 density_unit Resolution data from JFIF marker
1187
+ UINT16 X_density
1188
+ UINT16 Y_density
1189
+ boolean saw_Adobe_marker TRUE if an Adobe APP14 marker was seen
1190
+ UINT8 Adobe_transform Color transform code from Adobe marker
1191
+
1192
+ The JPEG color space, unfortunately, is something of a guess since the JPEG
1193
+ standard proper does not provide a way to record it. In practice most files
1194
+ adhere to the JFIF or Adobe conventions, and the decoder will recognize these
1195
+ correctly. See "Special color spaces", below, for more info.
1196
+
1197
+
1198
+ The decompression parameters that determine the basic properties of the
1199
+ returned image are:
1200
+
1201
+ J_COLOR_SPACE out_color_space
1202
+ Output color space. jpeg_read_header() sets an appropriate default
1203
+ based on jpeg_color_space; typically it will be RGB or grayscale.
1204
+ The application can change this field to request output in a different
1205
+ colorspace. For example, set it to JCS_GRAYSCALE to get grayscale
1206
+ output from a color file. (This is useful for previewing: grayscale
1207
+ output is faster than full color since the color components need not
1208
+ be processed.) Note that not all possible color space transforms are
1209
+ currently implemented; you may need to extend jdcolor.c if you want an
1210
+ unusual conversion.
1211
+
1212
+ unsigned int scale_num, scale_denom
1213
+ Scale the image by the fraction scale_num/scale_denom. Default is
1214
+ 1/1, or no scaling. Currently, the only supported scaling ratios
1215
+ are M/8 with all M from 1 to 16, or any reduced fraction thereof (such
1216
+ as 1/2, 3/4, etc.) (The library design allows for arbitrary
1217
+ scaling ratios but this is not likely to be implemented any time soon.)
1218
+ Smaller scaling ratios permit significantly faster decoding since
1219
+ fewer pixels need be processed and a simpler IDCT method can be used.
1220
+
1221
+ boolean quantize_colors
1222
+ If set TRUE, colormapped output will be delivered. Default is FALSE,
1223
+ meaning that full-color output will be delivered.
1224
+
1225
+ The next three parameters are relevant only if quantize_colors is TRUE.
1226
+
1227
+ int desired_number_of_colors
1228
+ Maximum number of colors to use in generating a library-supplied color
1229
+ map (the actual number of colors is returned in a different field).
1230
+ Default 256. Ignored when the application supplies its own color map.
1231
+
1232
+ boolean two_pass_quantize
1233
+ If TRUE, an extra pass over the image is made to select a custom color
1234
+ map for the image. This usually looks a lot better than the one-size-
1235
+ fits-all colormap that is used otherwise. Default is TRUE. Ignored
1236
+ when the application supplies its own color map.
1237
+
1238
+ J_DITHER_MODE dither_mode
1239
+ Selects color dithering method. Supported values are:
1240
+ JDITHER_NONE no dithering: fast, very low quality
1241
+ JDITHER_ORDERED ordered dither: moderate speed and quality
1242
+ JDITHER_FS Floyd-Steinberg dither: slow, high quality
1243
+ Default is JDITHER_FS. (At present, ordered dither is implemented
1244
+ only in the single-pass, standard-colormap case. If you ask for
1245
+ ordered dither when two_pass_quantize is TRUE or when you supply
1246
+ an external color map, you'll get F-S dithering.)
1247
+
1248
+ When quantize_colors is TRUE, the target color map is described by the next
1249
+ two fields. colormap is set to NULL by jpeg_read_header(). The application
1250
+ can supply a color map by setting colormap non-NULL and setting
1251
+ actual_number_of_colors to the map size. Otherwise, jpeg_start_decompress()
1252
+ selects a suitable color map and sets these two fields itself.
1253
+ [Implementation restriction: at present, an externally supplied colormap is
1254
+ only accepted for 3-component output color spaces.]
1255
+
1256
+ JSAMPARRAY colormap
1257
+ The color map, represented as a 2-D pixel array of out_color_components
1258
+ rows and actual_number_of_colors columns. Ignored if not quantizing.
1259
+ CAUTION: if the JPEG library creates its own colormap, the storage
1260
+ pointed to by this field is released by jpeg_finish_decompress().
1261
+ Copy the colormap somewhere else first, if you want to save it.
1262
+
1263
+ int actual_number_of_colors
1264
+ The number of colors in the color map.
1265
+
1266
+ Additional decompression parameters that the application may set include:
1267
+
1268
+ J_DCT_METHOD dct_method
1269
+ Selects the algorithm used for the DCT step. Choices are:
1270
+ JDCT_ISLOW: accurate integer method
1271
+ JDCT_IFAST: less accurate integer method [legacy feature]
1272
+ JDCT_FLOAT: floating-point method [legacy feature]
1273
+ JDCT_DEFAULT: default method (normally JDCT_ISLOW)
1274
+ JDCT_FASTEST: fastest method (normally JDCT_IFAST)
1275
+ When the Independent JPEG Group's software was first released in 1991,
1276
+ the decompression time for a 1-megapixel JPEG image on a mainstream PC
1277
+ was measured in minutes. Thus, JDCT_IFAST provided noticeable
1278
+ performance benefits. On modern CPUs running libjpeg-turbo, however,
1279
+ the decompression time for a 1-megapixel JPEG image is measured in
1280
+ milliseconds, and thus the performance benefits of JDCT_IFAST are much
1281
+ less noticeable. On modern x86/x86-64 CPUs that support AVX2
1282
+ instructions, JDCT_IFAST and JDCT_ISLOW have similar performance. On
1283
+ other types of CPUs, JDCT_IFAST is generally about 5-15% faster than
1284
+ JDCT_ISLOW.
1285
+
1286
+ If the JPEG image was compressed using a quality level of 85 or below,
1287
+ then there should be little or no perceptible quality difference
1288
+ between the two algorithms. When decompressing images that were
1289
+ compressed using quality levels above 85, however, the difference
1290
+ between JDCT_IFAST and JDCT_ISLOW becomes more pronounced. With images
1291
+ compressed using quality=97, for instance, JDCT_IFAST incurs generally
1292
+ about a 4-6 dB loss in PSNR relative to JDCT_ISLOW, but this can be
1293
+ larger for some images. If you can avoid it, do not use JDCT_IFAST
1294
+ when decompressing images that were compressed using quality levels
1295
+ above 97. The algorithm often degenerates for such images and can
1296
+ actually produce a more lossy output image than if the JPEG image had
1297
+ been compressed using lower quality levels.
1298
+
1299
+ JDCT_FLOAT does not produce significantly more accurate results than
1300
+ JDCT_ISLOW, and it is much slower. JDCT_FLOAT may also give different
1301
+ results on different machines due to varying roundoff behavior, whereas
1302
+ the integer methods should give the same results on all machines.
1303
+
1304
+ boolean do_fancy_upsampling
1305
+ If TRUE, do careful upsampling of chroma components. If FALSE,
1306
+ a faster but sloppier method is used. Default is TRUE. The visual
1307
+ impact of the sloppier method is often very small.
1308
+
1309
+ boolean do_block_smoothing
1310
+ If TRUE, interblock smoothing is applied in early stages of decoding
1311
+ progressive JPEG files; if FALSE, not. Default is TRUE. Early
1312
+ progression stages look "fuzzy" with smoothing, "blocky" without.
1313
+ In any case, block smoothing ceases to be applied after the first few
1314
+ AC coefficients are known to full accuracy, so it is relevant only
1315
+ when using buffered-image mode for progressive images.
1316
+
1317
+ boolean enable_1pass_quant
1318
+ boolean enable_external_quant
1319
+ boolean enable_2pass_quant
1320
+ These are significant only in buffered-image mode, which is
1321
+ described in its own section below.
1322
+
1323
+
1324
+ The output image dimensions are given by the following fields. These are
1325
+ computed from the source image dimensions and the decompression parameters
1326
+ by jpeg_start_decompress(). You can also call jpeg_calc_output_dimensions()
1327
+ to obtain the values that will result from the current parameter settings.
1328
+ This can be useful if you are trying to pick a scaling ratio that will get
1329
+ close to a desired target size. It's also important if you are using the
1330
+ JPEG library's memory manager to allocate output buffer space, because you
1331
+ are supposed to request such buffers *before* jpeg_start_decompress().
1332
+
1333
+ JDIMENSION output_width Actual dimensions of output image.
1334
+ JDIMENSION output_height
1335
+ int out_color_components Number of color components in out_color_space.
1336
+ int output_components Number of color components returned.
1337
+ int rec_outbuf_height Recommended height of scanline buffer.
1338
+
1339
+ When quantizing colors, output_components is 1, indicating a single color map
1340
+ index per pixel. Otherwise it equals out_color_components. The output arrays
1341
+ are required to be output_width * output_components JSAMPLEs wide.
1342
+
1343
+ rec_outbuf_height is the recommended minimum height (in scanlines) of the
1344
+ buffer passed to jpeg_read_scanlines(). If the buffer is smaller, the
1345
+ library will still work, but time will be wasted due to unnecessary data
1346
+ copying. In high-quality modes, rec_outbuf_height is always 1, but some
1347
+ faster, lower-quality modes set it to larger values (typically 2 to 4).
1348
+ If you are going to ask for a high-speed processing mode, you may as well
1349
+ go to the trouble of honoring rec_outbuf_height so as to avoid data copying.
1350
+ (An output buffer larger than rec_outbuf_height lines is OK, but won't
1351
+ provide any material speed improvement over that height.)
1352
+
1353
+
1354
+ Special color spaces
1355
+ --------------------
1356
+
1357
+ The JPEG standard itself is "color blind" and doesn't specify any particular
1358
+ color space. It is customary to convert color data to a luminance/chrominance
1359
+ color space before compressing, since this permits greater compression. The
1360
+ existing de-facto JPEG file format standards specify YCbCr or grayscale data
1361
+ (JFIF), or grayscale, RGB, YCbCr, CMYK, or YCCK (Adobe). For special
1362
+ applications such as multispectral images, other color spaces can be used,
1363
+ but it must be understood that such files will be unportable.
1364
+
1365
+ The JPEG library can handle the most common colorspace conversions (namely
1366
+ RGB <=> YCbCr and CMYK <=> YCCK). It can also deal with data of an unknown
1367
+ color space, passing it through without conversion. If you deal extensively
1368
+ with an unusual color space, you can easily extend the library to understand
1369
+ additional color spaces and perform appropriate conversions.
1370
+
1371
+ For compression, the source data's color space is specified by field
1372
+ in_color_space. This is transformed to the JPEG file's color space given
1373
+ by jpeg_color_space. jpeg_set_defaults() chooses a reasonable JPEG color
1374
+ space depending on in_color_space, but you can override this by calling
1375
+ jpeg_set_colorspace(). Of course you must select a supported transformation.
1376
+ jccolor.c currently supports the following transformations:
1377
+ RGB => YCbCr
1378
+ RGB => GRAYSCALE
1379
+ YCbCr => GRAYSCALE
1380
+ CMYK => YCCK
1381
+ plus the null transforms: GRAYSCALE => GRAYSCALE, RGB => RGB,
1382
+ YCbCr => YCbCr, CMYK => CMYK, YCCK => YCCK, and UNKNOWN => UNKNOWN.
1383
+
1384
+ The de-facto file format standards (JFIF and Adobe) specify APPn markers that
1385
+ indicate the color space of the JPEG file. It is important to ensure that
1386
+ these are written correctly, or omitted if the JPEG file's color space is not
1387
+ one of the ones supported by the de-facto standards. jpeg_set_colorspace()
1388
+ will set the compression parameters to include or omit the APPn markers
1389
+ properly, so long as it is told the truth about the JPEG color space.
1390
+ For example, if you are writing some random 3-component color space without
1391
+ conversion, don't try to fake out the library by setting in_color_space and
1392
+ jpeg_color_space to JCS_YCbCr; use JCS_UNKNOWN. You may want to write an
1393
+ APPn marker of your own devising to identify the colorspace --- see "Special
1394
+ markers", below.
1395
+
1396
+ When told that the color space is UNKNOWN, the library will default to using
1397
+ luminance-quality compression parameters for all color components. You may
1398
+ well want to change these parameters. See the source code for
1399
+ jpeg_set_colorspace(), in jcparam.c, for details.
1400
+
1401
+ For decompression, the JPEG file's color space is given in jpeg_color_space,
1402
+ and this is transformed to the output color space out_color_space.
1403
+ jpeg_read_header's setting of jpeg_color_space can be relied on if the file
1404
+ conforms to JFIF or Adobe conventions, but otherwise it is no better than a
1405
+ guess. If you know the JPEG file's color space for certain, you can override
1406
+ jpeg_read_header's guess by setting jpeg_color_space. jpeg_read_header also
1407
+ selects a default output color space based on (its guess of) jpeg_color_space;
1408
+ set out_color_space to override this. Again, you must select a supported
1409
+ transformation. jdcolor.c currently supports
1410
+ YCbCr => RGB
1411
+ YCbCr => GRAYSCALE
1412
+ RGB => GRAYSCALE
1413
+ GRAYSCALE => RGB
1414
+ YCCK => CMYK
1415
+ as well as the null transforms. (Since GRAYSCALE=>RGB is provided, an
1416
+ application can force grayscale JPEGs to look like color JPEGs if it only
1417
+ wants to handle one case.)
1418
+
1419
+ The two-pass color quantizer, jquant2.c, is specialized to handle RGB data
1420
+ (it weights distances appropriately for RGB colors). You'll need to modify
1421
+ the code if you want to use it for non-RGB output color spaces. Note that
1422
+ jquant2.c is used to map to an application-supplied colormap as well as for
1423
+ the normal two-pass colormap selection process.
1424
+
1425
+ CAUTION: it appears that Adobe Photoshop writes inverted data in CMYK JPEG
1426
+ files: 0 represents 100% ink coverage, rather than 0% ink as you'd expect.
1427
+ This is arguably a bug in Photoshop, but if you need to work with Photoshop
1428
+ CMYK files, you will have to deal with it in your application. We cannot
1429
+ "fix" this in the library by inverting the data during the CMYK<=>YCCK
1430
+ transform, because that would break other applications, notably Ghostscript.
1431
+ Photoshop versions prior to 3.0 write EPS files containing JPEG-encoded CMYK
1432
+ data in the same inverted-YCCK representation used in bare JPEG files, but
1433
+ the surrounding PostScript code performs an inversion using the PS image
1434
+ operator. I am told that Photoshop 3.0 will write uninverted YCCK in
1435
+ EPS/JPEG files, and will omit the PS-level inversion. (But the data
1436
+ polarity used in bare JPEG files will not change in 3.0.) In either case,
1437
+ the JPEG library must not invert the data itself, or else Ghostscript would
1438
+ read these EPS files incorrectly.
1439
+
1440
+
1441
+ Error handling
1442
+ --------------
1443
+
1444
+ When the default error handler is used, any error detected inside the JPEG
1445
+ routines will cause a message to be printed on stderr, followed by exit().
1446
+ You can supply your own error handling routines to override this behavior
1447
+ and to control the treatment of nonfatal warnings and trace/debug messages.
1448
+ The file example.txt illustrates the most common case, which is to have the
1449
+ application regain control after an error rather than exiting.
1450
+
1451
+ The JPEG library never writes any message directly; it always goes through
1452
+ the error handling routines. Three classes of messages are recognized:
1453
+ * Fatal errors: the library cannot continue.
1454
+ * Warnings: the library can continue, but the data is corrupt, and a
1455
+ damaged output image is likely to result.
1456
+ * Trace/informational messages. These come with a trace level indicating
1457
+ the importance of the message; you can control the verbosity of the
1458
+ program by adjusting the maximum trace level that will be displayed.
1459
+
1460
+ You may, if you wish, simply replace the entire JPEG error handling module
1461
+ (jerror.c) with your own code. However, you can avoid code duplication by
1462
+ only replacing some of the routines depending on the behavior you need.
1463
+ This is accomplished by calling jpeg_std_error() as usual, but then overriding
1464
+ some of the method pointers in the jpeg_error_mgr struct, as illustrated by
1465
+ example.txt.
1466
+
1467
+ All of the error handling routines will receive a pointer to the JPEG object
1468
+ (a j_common_ptr which points to either a jpeg_compress_struct or a
1469
+ jpeg_decompress_struct; if you need to tell which, test the is_decompressor
1470
+ field). This struct includes a pointer to the error manager struct in its
1471
+ "err" field. Frequently, custom error handler routines will need to access
1472
+ additional data which is not known to the JPEG library or the standard error
1473
+ handler. The most convenient way to do this is to embed either the JPEG
1474
+ object or the jpeg_error_mgr struct in a larger structure that contains
1475
+ additional fields; then casting the passed pointer provides access to the
1476
+ additional fields. Again, see example.txt for one way to do it. (Beginning
1477
+ with IJG version 6b, there is also a void pointer "client_data" in each
1478
+ JPEG object, which the application can also use to find related data.
1479
+ The library does not touch client_data at all.)
1480
+
1481
+ The individual methods that you might wish to override are:
1482
+
1483
+ error_exit (j_common_ptr cinfo)
1484
+ Receives control for a fatal error. Information sufficient to
1485
+ generate the error message has been stored in cinfo->err; call
1486
+ output_message to display it. Control must NOT return to the caller;
1487
+ generally this routine will exit() or longjmp() somewhere.
1488
+ Typically you would override this routine to get rid of the exit()
1489
+ default behavior. Note that if you continue processing, you should
1490
+ clean up the JPEG object with jpeg_abort() or jpeg_destroy().
1491
+
1492
+ output_message (j_common_ptr cinfo)
1493
+ Actual output of any JPEG message. Override this to send messages
1494
+ somewhere other than stderr. Note that this method does not know
1495
+ how to generate a message, only where to send it.
1496
+
1497
+ format_message (j_common_ptr cinfo, char *buffer)
1498
+ Constructs a readable error message string based on the error info
1499
+ stored in cinfo->err. This method is called by output_message. Few
1500
+ applications should need to override this method. One possible
1501
+ reason for doing so is to implement dynamic switching of error message
1502
+ language.
1503
+
1504
+ emit_message (j_common_ptr cinfo, int msg_level)
1505
+ Decide whether or not to emit a warning or trace message; if so,
1506
+ calls output_message. The main reason for overriding this method
1507
+ would be to abort on warnings. msg_level is -1 for warnings,
1508
+ 0 and up for trace messages.
1509
+
1510
+ Only error_exit() and emit_message() are called from the rest of the JPEG
1511
+ library; the other two are internal to the error handler.
1512
+
1513
+ The actual message texts are stored in an array of strings which is pointed to
1514
+ by the field err->jpeg_message_table. The messages are numbered from 0 to
1515
+ err->last_jpeg_message, and it is these code numbers that are used in the
1516
+ JPEG library code. You could replace the message texts (for instance, with
1517
+ messages in French or German) by changing the message table pointer. See
1518
+ jerror.h for the default texts. CAUTION: this table will almost certainly
1519
+ change or grow from one library version to the next.
1520
+
1521
+ It may be useful for an application to add its own message texts that are
1522
+ handled by the same mechanism. The error handler supports a second "add-on"
1523
+ message table for this purpose. To define an addon table, set the pointer
1524
+ err->addon_message_table and the message numbers err->first_addon_message and
1525
+ err->last_addon_message. If you number the addon messages beginning at 1000
1526
+ or so, you won't have to worry about conflicts with the library's built-in
1527
+ messages. See the sample applications cjpeg/djpeg for an example of using
1528
+ addon messages (the addon messages are defined in cderror.h).
1529
+
1530
+ Actual invocation of the error handler is done via macros defined in jerror.h:
1531
+ ERREXITn(...) for fatal errors
1532
+ WARNMSn(...) for corrupt-data warnings
1533
+ TRACEMSn(...) for trace and informational messages.
1534
+ These macros store the message code and any additional parameters into the
1535
+ error handler struct, then invoke the error_exit() or emit_message() method.
1536
+ The variants of each macro are for varying numbers of additional parameters.
1537
+ The additional parameters are inserted into the generated message using
1538
+ standard printf() format codes.
1539
+
1540
+ See jerror.h and jerror.c for further details.
1541
+
1542
+
1543
+ Compressed data handling (source and destination managers)
1544
+ ----------------------------------------------------------
1545
+
1546
+ The JPEG compression library sends its compressed data to a "destination
1547
+ manager" module. The default destination manager just writes the data to a
1548
+ memory buffer or to a stdio stream, but you can provide your own manager to
1549
+ do something else. Similarly, the decompression library calls a "source
1550
+ manager" to obtain the compressed data; you can provide your own source
1551
+ manager if you want the data to come from somewhere other than a memory
1552
+ buffer or a stdio stream.
1553
+
1554
+ In both cases, compressed data is processed a bufferload at a time: the
1555
+ destination or source manager provides a work buffer, and the library invokes
1556
+ the manager only when the buffer is filled or emptied. (You could define a
1557
+ one-character buffer to force the manager to be invoked for each byte, but
1558
+ that would be rather inefficient.) The buffer's size and location are
1559
+ controlled by the manager, not by the library. For example, the memory
1560
+ source manager just makes the buffer pointer and length point to the original
1561
+ data in memory. In this case the buffer-reload procedure will be invoked
1562
+ only if the decompressor ran off the end of the datastream, which would
1563
+ indicate an erroneous datastream.
1564
+
1565
+ The work buffer is defined as an array of datatype JOCTET, which is generally
1566
+ "char" or "unsigned char". On a machine where char is not exactly 8 bits
1567
+ wide, you must define JOCTET as a wider data type and then modify the data
1568
+ source and destination modules to transcribe the work arrays into 8-bit units
1569
+ on external storage.
1570
+
1571
+ A data destination manager struct contains a pointer and count defining the
1572
+ next byte to write in the work buffer and the remaining free space:
1573
+
1574
+ JOCTET *next_output_byte; /* => next byte to write in buffer */
1575
+ size_t free_in_buffer; /* # of byte spaces remaining in buffer */
1576
+
1577
+ The library increments the pointer and decrements the count until the buffer
1578
+ is filled. The manager's empty_output_buffer method must reset the pointer
1579
+ and count. The manager is expected to remember the buffer's starting address
1580
+ and total size in private fields not visible to the library.
1581
+
1582
+ A data destination manager provides three methods:
1583
+
1584
+ init_destination (j_compress_ptr cinfo)
1585
+ Initialize destination. This is called by jpeg_start_compress()
1586
+ before any data is actually written. It must initialize
1587
+ next_output_byte and free_in_buffer. free_in_buffer must be
1588
+ initialized to a positive value.
1589
+
1590
+ empty_output_buffer (j_compress_ptr cinfo)
1591
+ This is called whenever the buffer has filled (free_in_buffer
1592
+ reaches zero). In typical applications, it should write out the
1593
+ *entire* buffer (use the saved start address and buffer length;
1594
+ ignore the current state of next_output_byte and free_in_buffer).
1595
+ Then reset the pointer & count to the start of the buffer, and
1596
+ return TRUE indicating that the buffer has been dumped.
1597
+ free_in_buffer must be set to a positive value when TRUE is
1598
+ returned. A FALSE return should only be used when I/O suspension is
1599
+ desired (this operating mode is discussed in the next section).
1600
+
1601
+ term_destination (j_compress_ptr cinfo)
1602
+ Terminate destination --- called by jpeg_finish_compress() after all
1603
+ data has been written. In most applications, this must flush any
1604
+ data remaining in the buffer. Use either next_output_byte or
1605
+ free_in_buffer to determine how much data is in the buffer.
1606
+
1607
+ term_destination() is NOT called by jpeg_abort() or jpeg_destroy(). If you
1608
+ want the destination manager to be cleaned up during an abort, you must do it
1609
+ yourself.
1610
+
1611
+ You will also need code to create a jpeg_destination_mgr struct, fill in its
1612
+ method pointers, and insert a pointer to the struct into the "dest" field of
1613
+ the JPEG compression object. This can be done in-line in your setup code if
1614
+ you like, but it's probably cleaner to provide a separate routine similar to
1615
+ the jpeg_stdio_dest() or jpeg_mem_dest() routines of the supplied destination
1616
+ managers.
1617
+
1618
+ Decompression source managers follow a parallel design, but with some
1619
+ additional frammishes. The source manager struct contains a pointer and count
1620
+ defining the next byte to read from the work buffer and the number of bytes
1621
+ remaining:
1622
+
1623
+ const JOCTET *next_input_byte; /* => next byte to read from buffer */
1624
+ size_t bytes_in_buffer; /* # of bytes remaining in buffer */
1625
+
1626
+ The library increments the pointer and decrements the count until the buffer
1627
+ is emptied. The manager's fill_input_buffer method must reset the pointer and
1628
+ count. In most applications, the manager must remember the buffer's starting
1629
+ address and total size in private fields not visible to the library.
1630
+
1631
+ A data source manager provides five methods:
1632
+
1633
+ init_source (j_decompress_ptr cinfo)
1634
+ Initialize source. This is called by jpeg_read_header() before any
1635
+ data is actually read. Unlike init_destination(), it may leave
1636
+ bytes_in_buffer set to 0 (in which case a fill_input_buffer() call
1637
+ will occur immediately).
1638
+
1639
+ fill_input_buffer (j_decompress_ptr cinfo)
1640
+ This is called whenever bytes_in_buffer has reached zero and more
1641
+ data is wanted. In typical applications, it should read fresh data
1642
+ into the buffer (ignoring the current state of next_input_byte and
1643
+ bytes_in_buffer), reset the pointer & count to the start of the
1644
+ buffer, and return TRUE indicating that the buffer has been reloaded.
1645
+ It is not necessary to fill the buffer entirely, only to obtain at
1646
+ least one more byte. bytes_in_buffer MUST be set to a positive value
1647
+ if TRUE is returned. A FALSE return should only be used when I/O
1648
+ suspension is desired (this mode is discussed in the next section).
1649
+
1650
+ skip_input_data (j_decompress_ptr cinfo, long num_bytes)
1651
+ Skip num_bytes worth of data. The buffer pointer and count should
1652
+ be advanced over num_bytes input bytes, refilling the buffer as
1653
+ needed. This is used to skip over a potentially large amount of
1654
+ uninteresting data (such as an APPn marker). In some applications
1655
+ it may be possible to optimize away the reading of the skipped data,
1656
+ but it's not clear that being smart is worth much trouble; large
1657
+ skips are uncommon. bytes_in_buffer may be zero on return.
1658
+ A zero or negative skip count should be treated as a no-op.
1659
+
1660
+ resync_to_restart (j_decompress_ptr cinfo, int desired)
1661
+ This routine is called only when the decompressor has failed to find
1662
+ a restart (RSTn) marker where one is expected. Its mission is to
1663
+ find a suitable point for resuming decompression. For most
1664
+ applications, we recommend that you just use the default resync
1665
+ procedure, jpeg_resync_to_restart(). However, if you are able to back
1666
+ up in the input data stream, or if you have a-priori knowledge about
1667
+ the likely location of restart markers, you may be able to do better.
1668
+ Read the read_restart_marker() and jpeg_resync_to_restart() routines
1669
+ in jdmarker.c if you think you'd like to implement your own resync
1670
+ procedure.
1671
+
1672
+ term_source (j_decompress_ptr cinfo)
1673
+ Terminate source --- called by jpeg_finish_decompress() after all
1674
+ data has been read. Often a no-op.
1675
+
1676
+ For both fill_input_buffer() and skip_input_data(), there is no such thing
1677
+ as an EOF return. If the end of the file has been reached, the routine has
1678
+ a choice of exiting via ERREXIT() or inserting fake data into the buffer.
1679
+ In most cases, generating a warning message and inserting a fake EOI marker
1680
+ is the best course of action --- this will allow the decompressor to output
1681
+ however much of the image is there. In pathological cases, the decompressor
1682
+ may swallow the EOI and again demand data ... just keep feeding it fake EOIs.
1683
+ jdatasrc.c illustrates the recommended error recovery behavior.
1684
+
1685
+ term_source() is NOT called by jpeg_abort() or jpeg_destroy(). If you want
1686
+ the source manager to be cleaned up during an abort, you must do it yourself.
1687
+
1688
+ You will also need code to create a jpeg_source_mgr struct, fill in its method
1689
+ pointers, and insert a pointer to the struct into the "src" field of the JPEG
1690
+ decompression object. This can be done in-line in your setup code if you
1691
+ like, but it's probably cleaner to provide a separate routine similar to the
1692
+ jpeg_stdio_src() or jpeg_mem_src() routines of the supplied source managers.
1693
+
1694
+ For more information, consult the memory and stdio source and destination
1695
+ managers in jdatasrc.c and jdatadst.c.
1696
+
1697
+
1698
+ I/O suspension
1699
+ --------------
1700
+
1701
+ Some applications need to use the JPEG library as an incremental memory-to-
1702
+ memory filter: when the compressed data buffer is filled or emptied, they want
1703
+ control to return to the outer loop, rather than expecting that the buffer can
1704
+ be emptied or reloaded within the data source/destination manager subroutine.
1705
+ The library supports this need by providing an "I/O suspension" mode, which we
1706
+ describe in this section.
1707
+
1708
+ The I/O suspension mode is not a panacea: nothing is guaranteed about the
1709
+ maximum amount of time spent in any one call to the library, so it will not
1710
+ eliminate response-time problems in single-threaded applications. If you
1711
+ need guaranteed response time, we suggest you "bite the bullet" and implement
1712
+ a real multi-tasking capability.
1713
+
1714
+ To use I/O suspension, cooperation is needed between the calling application
1715
+ and the data source or destination manager; you will always need a custom
1716
+ source/destination manager. (Please read the previous section if you haven't
1717
+ already.) The basic idea is that the empty_output_buffer() or
1718
+ fill_input_buffer() routine is a no-op, merely returning FALSE to indicate
1719
+ that it has done nothing. Upon seeing this, the JPEG library suspends
1720
+ operation and returns to its caller. The surrounding application is
1721
+ responsible for emptying or refilling the work buffer before calling the
1722
+ JPEG library again.
1723
+
1724
+ Compression suspension:
1725
+
1726
+ For compression suspension, use an empty_output_buffer() routine that returns
1727
+ FALSE; typically it will not do anything else. This will cause the
1728
+ compressor to return to the caller of jpeg_write_scanlines(), with the return
1729
+ value indicating that not all the supplied scanlines have been accepted.
1730
+ The application must make more room in the output buffer, adjust the output
1731
+ buffer pointer/count appropriately, and then call jpeg_write_scanlines()
1732
+ again, pointing to the first unconsumed scanline.
1733
+
1734
+ When forced to suspend, the compressor will backtrack to a convenient stopping
1735
+ point (usually the start of the current MCU); it will regenerate some output
1736
+ data when restarted. Therefore, although empty_output_buffer() is only
1737
+ called when the buffer is filled, you should NOT write out the entire buffer
1738
+ after a suspension. Write only the data up to the current position of
1739
+ next_output_byte/free_in_buffer. The data beyond that point will be
1740
+ regenerated after resumption.
1741
+
1742
+ Because of the backtracking behavior, a good-size output buffer is essential
1743
+ for efficiency; you don't want the compressor to suspend often. (In fact, an
1744
+ overly small buffer could lead to infinite looping, if a single MCU required
1745
+ more data than would fit in the buffer.) We recommend a buffer of at least
1746
+ several Kbytes. You may want to insert explicit code to ensure that you don't
1747
+ call jpeg_write_scanlines() unless there is a reasonable amount of space in
1748
+ the output buffer; in other words, flush the buffer before trying to compress
1749
+ more data.
1750
+
1751
+ The compressor does not allow suspension while it is trying to write JPEG
1752
+ markers at the beginning and end of the file. This means that:
1753
+ * At the beginning of a compression operation, there must be enough free
1754
+ space in the output buffer to hold the header markers (typically 600 or
1755
+ so bytes). The recommended buffer size is bigger than this anyway, so
1756
+ this is not a problem as long as you start with an empty buffer. However,
1757
+ this restriction might catch you if you insert large special markers, such
1758
+ as a JFIF thumbnail image, without flushing the buffer afterwards.
1759
+ * When you call jpeg_finish_compress(), there must be enough space in the
1760
+ output buffer to emit any buffered data and the final EOI marker. In the
1761
+ current implementation, half a dozen bytes should suffice for this, but
1762
+ for safety's sake we recommend ensuring that at least 100 bytes are free
1763
+ before calling jpeg_finish_compress().
1764
+
1765
+ A more significant restriction is that jpeg_finish_compress() cannot suspend.
1766
+ This means you cannot use suspension with multi-pass operating modes, namely
1767
+ Huffman code optimization and multiple-scan output. Those modes write the
1768
+ whole file during jpeg_finish_compress(), which will certainly result in
1769
+ buffer overrun. (Note that this restriction applies only to compression,
1770
+ not decompression. The decompressor supports input suspension in all of its
1771
+ operating modes.)
1772
+
1773
+ Decompression suspension:
1774
+
1775
+ For decompression suspension, use a fill_input_buffer() routine that simply
1776
+ returns FALSE (except perhaps during error recovery, as discussed below).
1777
+ This will cause the decompressor to return to its caller with an indication
1778
+ that suspension has occurred. This can happen at four places:
1779
+ * jpeg_read_header(): will return JPEG_SUSPENDED.
1780
+ * jpeg_start_decompress(): will return FALSE, rather than its usual TRUE.
1781
+ * jpeg_read_scanlines(): will return the number of scanlines already
1782
+ completed (possibly 0).
1783
+ * jpeg_finish_decompress(): will return FALSE, rather than its usual TRUE.
1784
+ The surrounding application must recognize these cases, load more data into
1785
+ the input buffer, and repeat the call. In the case of jpeg_read_scanlines(),
1786
+ increment the passed pointers past any scanlines successfully read.
1787
+
1788
+ Just as with compression, the decompressor will typically backtrack to a
1789
+ convenient restart point before suspending. When fill_input_buffer() is
1790
+ called, next_input_byte/bytes_in_buffer point to the current restart point,
1791
+ which is where the decompressor will backtrack to if FALSE is returned.
1792
+ The data beyond that position must NOT be discarded if you suspend; it needs
1793
+ to be re-read upon resumption. In most implementations, you'll need to shift
1794
+ this data down to the start of your work buffer and then load more data after
1795
+ it. Again, this behavior means that a several-Kbyte work buffer is essential
1796
+ for decent performance; furthermore, you should load a reasonable amount of
1797
+ new data before resuming decompression. (If you loaded, say, only one new
1798
+ byte each time around, you could waste a LOT of cycles.)
1799
+
1800
+ The skip_input_data() source manager routine requires special care in a
1801
+ suspension scenario. This routine is NOT granted the ability to suspend the
1802
+ decompressor; it can decrement bytes_in_buffer to zero, but no more. If the
1803
+ requested skip distance exceeds the amount of data currently in the input
1804
+ buffer, then skip_input_data() must set bytes_in_buffer to zero and record the
1805
+ additional skip distance somewhere else. The decompressor will immediately
1806
+ call fill_input_buffer(), which should return FALSE, which will cause a
1807
+ suspension return. The surrounding application must then arrange to discard
1808
+ the recorded number of bytes before it resumes loading the input buffer.
1809
+ (Yes, this design is rather baroque, but it avoids complexity in the far more
1810
+ common case where a non-suspending source manager is used.)
1811
+
1812
+ If the input data has been exhausted, we recommend that you emit a warning
1813
+ and insert dummy EOI markers just as a non-suspending data source manager
1814
+ would do. This can be handled either in the surrounding application logic or
1815
+ within fill_input_buffer(); the latter is probably more efficient. If
1816
+ fill_input_buffer() knows that no more data is available, it can set the
1817
+ pointer/count to point to a dummy EOI marker and then return TRUE just as
1818
+ though it had read more data in a non-suspending situation.
1819
+
1820
+ The decompressor does not attempt to suspend within standard JPEG markers;
1821
+ instead it will backtrack to the start of the marker and reprocess the whole
1822
+ marker next time. Hence the input buffer must be large enough to hold the
1823
+ longest standard marker in the file. Standard JPEG markers should normally
1824
+ not exceed a few hundred bytes each (DHT tables are typically the longest).
1825
+ We recommend at least a 2K buffer for performance reasons, which is much
1826
+ larger than any correct marker is likely to be. For robustness against
1827
+ damaged marker length counts, you may wish to insert a test in your
1828
+ application for the case that the input buffer is completely full and yet
1829
+ the decoder has suspended without consuming any data --- otherwise, if this
1830
+ situation did occur, it would lead to an endless loop. (The library can't
1831
+ provide this test since it has no idea whether "the buffer is full", or
1832
+ even whether there is a fixed-size input buffer.)
1833
+
1834
+ The input buffer would need to be 64K to allow for arbitrary COM or APPn
1835
+ markers, but these are handled specially: they are either saved into allocated
1836
+ memory, or skipped over by calling skip_input_data(). In the former case,
1837
+ suspension is handled correctly, and in the latter case, the problem of
1838
+ buffer overrun is placed on skip_input_data's shoulders, as explained above.
1839
+ Note that if you provide your own marker handling routine for large markers,
1840
+ you should consider how to deal with buffer overflow.
1841
+
1842
+ Multiple-buffer management:
1843
+
1844
+ In some applications it is desirable to store the compressed data in a linked
1845
+ list of buffer areas, so as to avoid data copying. This can be handled by
1846
+ having empty_output_buffer() or fill_input_buffer() set the pointer and count
1847
+ to reference the next available buffer; FALSE is returned only if no more
1848
+ buffers are available. Although seemingly straightforward, there is a
1849
+ pitfall in this approach: the backtrack that occurs when FALSE is returned
1850
+ could back up into an earlier buffer. For example, when fill_input_buffer()
1851
+ is called, the current pointer & count indicate the backtrack restart point.
1852
+ Since fill_input_buffer() will set the pointer and count to refer to a new
1853
+ buffer, the restart position must be saved somewhere else. Suppose a second
1854
+ call to fill_input_buffer() occurs in the same library call, and no
1855
+ additional input data is available, so fill_input_buffer must return FALSE.
1856
+ If the JPEG library has not moved the pointer/count forward in the current
1857
+ buffer, then *the correct restart point is the saved position in the prior
1858
+ buffer*. Prior buffers may be discarded only after the library establishes
1859
+ a restart point within a later buffer. Similar remarks apply for output into
1860
+ a chain of buffers.
1861
+
1862
+ The library will never attempt to backtrack over a skip_input_data() call,
1863
+ so any skipped data can be permanently discarded. You still have to deal
1864
+ with the case of skipping not-yet-received data, however.
1865
+
1866
+ It's much simpler to use only a single buffer; when fill_input_buffer() is
1867
+ called, move any unconsumed data (beyond the current pointer/count) down to
1868
+ the beginning of this buffer and then load new data into the remaining buffer
1869
+ space. This approach requires a little more data copying but is far easier
1870
+ to get right.
1871
+
1872
+
1873
+ Progressive JPEG support
1874
+ ------------------------
1875
+
1876
+ Progressive JPEG rearranges the stored data into a series of scans of
1877
+ increasing quality. In situations where a JPEG file is transmitted across a
1878
+ slow communications link, a decoder can generate a low-quality image very
1879
+ quickly from the first scan, then gradually improve the displayed quality as
1880
+ more scans are received. The final image after all scans are complete is
1881
+ identical to that of a regular (sequential) JPEG file of the same quality
1882
+ setting. Progressive JPEG files are often slightly smaller than equivalent
1883
+ sequential JPEG files, but the possibility of incremental display is the main
1884
+ reason for using progressive JPEG.
1885
+
1886
+ The IJG encoder library generates progressive JPEG files when given a
1887
+ suitable "scan script" defining how to divide the data into scans.
1888
+ Creation of progressive JPEG files is otherwise transparent to the encoder.
1889
+ Progressive JPEG files can also be read transparently by the decoder library.
1890
+ If the decoding application simply uses the library as defined above, it
1891
+ will receive a final decoded image without any indication that the file was
1892
+ progressive. Of course, this approach does not allow incremental display.
1893
+ To perform incremental display, an application needs to use the decoder
1894
+ library's "buffered-image" mode, in which it receives a decoded image
1895
+ multiple times.
1896
+
1897
+ Each displayed scan requires about as much work to decode as a full JPEG
1898
+ image of the same size, so the decoder must be fairly fast in relation to the
1899
+ data transmission rate in order to make incremental display useful. However,
1900
+ it is possible to skip displaying the image and simply add the incoming bits
1901
+ to the decoder's coefficient buffer. This is fast because only Huffman
1902
+ decoding need be done, not IDCT, upsampling, colorspace conversion, etc.
1903
+ The IJG decoder library allows the application to switch dynamically between
1904
+ displaying the image and simply absorbing the incoming bits. A properly
1905
+ coded application can automatically adapt the number of display passes to
1906
+ suit the time available as the image is received. Also, a final
1907
+ higher-quality display cycle can be performed from the buffered data after
1908
+ the end of the file is reached.
1909
+
1910
+ Progressive compression:
1911
+
1912
+ To create a progressive JPEG file (or a multiple-scan sequential JPEG file),
1913
+ set the scan_info cinfo field to point to an array of scan descriptors, and
1914
+ perform compression as usual. Instead of constructing your own scan list,
1915
+ you can call the jpeg_simple_progression() helper routine to create a
1916
+ recommended progression sequence; this method should be used by all
1917
+ applications that don't want to get involved in the nitty-gritty of
1918
+ progressive scan sequence design. (If you want to provide user control of
1919
+ scan sequences, you may wish to borrow the scan script reading code found
1920
+ in rdswitch.c, so that you can read scan script files just like cjpeg's.)
1921
+ When scan_info is not NULL, the compression library will store DCT'd data
1922
+ into a buffer array as jpeg_write_scanlines() is called, and will emit all
1923
+ the requested scans during jpeg_finish_compress(). This implies that
1924
+ multiple-scan output cannot be created with a suspending data destination
1925
+ manager, since jpeg_finish_compress() does not support suspension. We
1926
+ should also note that the compressor currently forces Huffman optimization
1927
+ mode when creating a progressive JPEG file, because the default Huffman
1928
+ tables are unsuitable for progressive files.
1929
+
1930
+ Progressive decompression:
1931
+
1932
+ When buffered-image mode is not used, the decoder library will read all of
1933
+ a multi-scan file during jpeg_start_decompress(), so that it can provide a
1934
+ final decoded image. (Here "multi-scan" means either progressive or
1935
+ multi-scan sequential.) This makes multi-scan files transparent to the
1936
+ decoding application. However, existing applications that used suspending
1937
+ input with version 5 of the IJG library will need to be modified to check
1938
+ for a suspension return from jpeg_start_decompress().
1939
+
1940
+ To perform incremental display, an application must use the library's
1941
+ buffered-image mode. This is described in the next section.
1942
+
1943
+
1944
+ Buffered-image mode
1945
+ -------------------
1946
+
1947
+ In buffered-image mode, the library stores the partially decoded image in a
1948
+ coefficient buffer, from which it can be read out as many times as desired.
1949
+ This mode is typically used for incremental display of progressive JPEG files,
1950
+ but it can be used with any JPEG file. Each scan of a progressive JPEG file
1951
+ adds more data (more detail) to the buffered image. The application can
1952
+ display in lockstep with the source file (one display pass per input scan),
1953
+ or it can allow input processing to outrun display processing. By making
1954
+ input and display processing run independently, it is possible for the
1955
+ application to adapt progressive display to a wide range of data transmission
1956
+ rates.
1957
+
1958
+ The basic control flow for buffered-image decoding is
1959
+
1960
+ jpeg_create_decompress()
1961
+ set data source
1962
+ jpeg_read_header()
1963
+ set overall decompression parameters
1964
+ cinfo.buffered_image = TRUE; /* select buffered-image mode */
1965
+ jpeg_start_decompress()
1966
+ for (each output pass) {
1967
+ adjust output decompression parameters if required
1968
+ jpeg_start_output() /* start a new output pass */
1969
+ for (all scanlines in image) {
1970
+ jpeg_read_scanlines()
1971
+ display scanlines
1972
+ }
1973
+ jpeg_finish_output() /* terminate output pass */
1974
+ }
1975
+ jpeg_finish_decompress()
1976
+ jpeg_destroy_decompress()
1977
+
1978
+ This differs from ordinary unbuffered decoding in that there is an additional
1979
+ level of looping. The application can choose how many output passes to make
1980
+ and how to display each pass.
1981
+
1982
+ The simplest approach to displaying progressive images is to do one display
1983
+ pass for each scan appearing in the input file. In this case the outer loop
1984
+ condition is typically
1985
+ while (!jpeg_input_complete(&cinfo))
1986
+ and the start-output call should read
1987
+ jpeg_start_output(&cinfo, cinfo.input_scan_number);
1988
+ The second parameter to jpeg_start_output() indicates which scan of the input
1989
+ file is to be displayed; the scans are numbered starting at 1 for this
1990
+ purpose. (You can use a loop counter starting at 1 if you like, but using
1991
+ the library's input scan counter is easier.) The library automatically reads
1992
+ data as necessary to complete each requested scan, and jpeg_finish_output()
1993
+ advances to the next scan or end-of-image marker (hence input_scan_number
1994
+ will be incremented by the time control arrives back at jpeg_start_output()).
1995
+ With this technique, data is read from the input file only as needed, and
1996
+ input and output processing run in lockstep.
1997
+
1998
+ After reading the final scan and reaching the end of the input file, the
1999
+ buffered image remains available; it can be read additional times by
2000
+ repeating the jpeg_start_output()/jpeg_read_scanlines()/jpeg_finish_output()
2001
+ sequence. For example, a useful technique is to use fast one-pass color
2002
+ quantization for display passes made while the image is arriving, followed by
2003
+ a final display pass using two-pass quantization for highest quality. This
2004
+ is done by changing the library parameters before the final output pass.
2005
+ Changing parameters between passes is discussed in detail below.
2006
+
2007
+ In general the last scan of a progressive file cannot be recognized as such
2008
+ until after it is read, so a post-input display pass is the best approach if
2009
+ you want special processing in the final pass.
2010
+
2011
+ When done with the image, be sure to call jpeg_finish_decompress() to release
2012
+ the buffered image (or just use jpeg_destroy_decompress()).
2013
+
2014
+ If input data arrives faster than it can be displayed, the application can
2015
+ cause the library to decode input data in advance of what's needed to produce
2016
+ output. This is done by calling the routine jpeg_consume_input().
2017
+ The return value is one of the following:
2018
+ JPEG_REACHED_SOS: reached an SOS marker (the start of a new scan)
2019
+ JPEG_REACHED_EOI: reached the EOI marker (end of image)
2020
+ JPEG_ROW_COMPLETED: completed reading one MCU row of compressed data
2021
+ JPEG_SCAN_COMPLETED: completed reading last MCU row of current scan
2022
+ JPEG_SUSPENDED: suspended before completing any of the above
2023
+ (JPEG_SUSPENDED can occur only if a suspending data source is used.) This
2024
+ routine can be called at any time after initializing the JPEG object. It
2025
+ reads some additional data and returns when one of the indicated significant
2026
+ events occurs. (If called after the EOI marker is reached, it will
2027
+ immediately return JPEG_REACHED_EOI without attempting to read more data.)
2028
+
2029
+ The library's output processing will automatically call jpeg_consume_input()
2030
+ whenever the output processing overtakes the input; thus, simple lockstep
2031
+ display requires no direct calls to jpeg_consume_input(). But by adding
2032
+ calls to jpeg_consume_input(), you can absorb data in advance of what is
2033
+ being displayed. This has two benefits:
2034
+ * You can limit buildup of unprocessed data in your input buffer.
2035
+ * You can eliminate extra display passes by paying attention to the
2036
+ state of the library's input processing.
2037
+
2038
+ The first of these benefits only requires interspersing calls to
2039
+ jpeg_consume_input() with your display operations and any other processing
2040
+ you may be doing. To avoid wasting cycles due to backtracking, it's best to
2041
+ call jpeg_consume_input() only after a hundred or so new bytes have arrived.
2042
+ This is discussed further under "I/O suspension", above. (Note: the JPEG
2043
+ library currently is not thread-safe. You must not call jpeg_consume_input()
2044
+ from one thread of control if a different library routine is working on the
2045
+ same JPEG object in another thread.)
2046
+
2047
+ When input arrives fast enough that more than one new scan is available
2048
+ before you start a new output pass, you may as well skip the output pass
2049
+ corresponding to the completed scan. This occurs for free if you pass
2050
+ cinfo.input_scan_number as the target scan number to jpeg_start_output().
2051
+ The input_scan_number field is simply the index of the scan currently being
2052
+ consumed by the input processor. You can ensure that this is up-to-date by
2053
+ emptying the input buffer just before calling jpeg_start_output(): call
2054
+ jpeg_consume_input() repeatedly until it returns JPEG_SUSPENDED or
2055
+ JPEG_REACHED_EOI.
2056
+
2057
+ The target scan number passed to jpeg_start_output() is saved in the
2058
+ cinfo.output_scan_number field. The library's output processing calls
2059
+ jpeg_consume_input() whenever the current input scan number and row within
2060
+ that scan is less than or equal to the current output scan number and row.
2061
+ Thus, input processing can "get ahead" of the output processing but is not
2062
+ allowed to "fall behind". You can achieve several different effects by
2063
+ manipulating this interlock rule. For example, if you pass a target scan
2064
+ number greater than the current input scan number, the output processor will
2065
+ wait until that scan starts to arrive before producing any output. (To avoid
2066
+ an infinite loop, the target scan number is automatically reset to the last
2067
+ scan number when the end of image is reached. Thus, if you specify a large
2068
+ target scan number, the library will just absorb the entire input file and
2069
+ then perform an output pass. This is effectively the same as what
2070
+ jpeg_start_decompress() does when you don't select buffered-image mode.)
2071
+ When you pass a target scan number equal to the current input scan number,
2072
+ the image is displayed no faster than the current input scan arrives. The
2073
+ final possibility is to pass a target scan number less than the current input
2074
+ scan number; this disables the input/output interlock and causes the output
2075
+ processor to simply display whatever it finds in the image buffer, without
2076
+ waiting for input. (However, the library will not accept a target scan
2077
+ number less than one, so you can't avoid waiting for the first scan.)
2078
+
2079
+ When data is arriving faster than the output display processing can advance
2080
+ through the image, jpeg_consume_input() will store data into the buffered
2081
+ image beyond the point at which the output processing is reading data out
2082
+ again. If the input arrives fast enough, it may "wrap around" the buffer to
2083
+ the point where the input is more than one whole scan ahead of the output.
2084
+ If the output processing simply proceeds through its display pass without
2085
+ paying attention to the input, the effect seen on-screen is that the lower
2086
+ part of the image is one or more scans better in quality than the upper part.
2087
+ Then, when the next output scan is started, you have a choice of what target
2088
+ scan number to use. The recommended choice is to use the current input scan
2089
+ number at that time, which implies that you've skipped the output scans
2090
+ corresponding to the input scans that were completed while you processed the
2091
+ previous output scan. In this way, the decoder automatically adapts its
2092
+ speed to the arriving data, by skipping output scans as necessary to keep up
2093
+ with the arriving data.
2094
+
2095
+ When using this strategy, you'll want to be sure that you perform a final
2096
+ output pass after receiving all the data; otherwise your last display may not
2097
+ be full quality across the whole screen. So the right outer loop logic is
2098
+ something like this:
2099
+ do {
2100
+ absorb any waiting input by calling jpeg_consume_input()
2101
+ final_pass = jpeg_input_complete(&cinfo);
2102
+ adjust output decompression parameters if required
2103
+ jpeg_start_output(&cinfo, cinfo.input_scan_number);
2104
+ ...
2105
+ jpeg_finish_output()
2106
+ } while (!final_pass);
2107
+ rather than quitting as soon as jpeg_input_complete() returns TRUE. This
2108
+ arrangement makes it simple to use higher-quality decoding parameters
2109
+ for the final pass. But if you don't want to use special parameters for
2110
+ the final pass, the right loop logic is like this:
2111
+ for (;;) {
2112
+ absorb any waiting input by calling jpeg_consume_input()
2113
+ jpeg_start_output(&cinfo, cinfo.input_scan_number);
2114
+ ...
2115
+ jpeg_finish_output()
2116
+ if (jpeg_input_complete(&cinfo) &&
2117
+ cinfo.input_scan_number == cinfo.output_scan_number)
2118
+ break;
2119
+ }
2120
+ In this case you don't need to know in advance whether an output pass is to
2121
+ be the last one, so it's not necessary to have reached EOF before starting
2122
+ the final output pass; rather, what you want to test is whether the output
2123
+ pass was performed in sync with the final input scan. This form of the loop
2124
+ will avoid an extra output pass whenever the decoder is able (or nearly able)
2125
+ to keep up with the incoming data.
2126
+
2127
+ When the data transmission speed is high, you might begin a display pass,
2128
+ then find that much or all of the file has arrived before you can complete
2129
+ the pass. (You can detect this by noting the JPEG_REACHED_EOI return code
2130
+ from jpeg_consume_input(), or equivalently by testing jpeg_input_complete().)
2131
+ In this situation you may wish to abort the current display pass and start a
2132
+ new one using the newly arrived information. To do so, just call
2133
+ jpeg_finish_output() and then start a new pass with jpeg_start_output().
2134
+
2135
+ A variant strategy is to abort and restart display if more than one complete
2136
+ scan arrives during an output pass; this can be detected by noting
2137
+ JPEG_REACHED_SOS returns and/or examining cinfo.input_scan_number. This
2138
+ idea should be employed with caution, however, since the display process
2139
+ might never get to the bottom of the image before being aborted, resulting
2140
+ in the lower part of the screen being several passes worse than the upper.
2141
+ In most cases it's probably best to abort an output pass only if the whole
2142
+ file has arrived and you want to begin the final output pass immediately.
2143
+
2144
+ When receiving data across a communication link, we recommend always using
2145
+ the current input scan number for the output target scan number; if a
2146
+ higher-quality final pass is to be done, it should be started (aborting any
2147
+ incomplete output pass) as soon as the end of file is received. However,
2148
+ many other strategies are possible. For example, the application can examine
2149
+ the parameters of the current input scan and decide whether to display it or
2150
+ not. If the scan contains only chroma data, one might choose not to use it
2151
+ as the target scan, expecting that the scan will be small and will arrive
2152
+ quickly. To skip to the next scan, call jpeg_consume_input() until it
2153
+ returns JPEG_REACHED_SOS or JPEG_REACHED_EOI. Or just use the next higher
2154
+ number as the target scan for jpeg_start_output(); but that method doesn't
2155
+ let you inspect the next scan's parameters before deciding to display it.
2156
+
2157
+
2158
+ In buffered-image mode, jpeg_start_decompress() never performs input and
2159
+ thus never suspends. An application that uses input suspension with
2160
+ buffered-image mode must be prepared for suspension returns from these
2161
+ routines:
2162
+ * jpeg_start_output() performs input only if you request 2-pass quantization
2163
+ and the target scan isn't fully read yet. (This is discussed below.)
2164
+ * jpeg_read_scanlines(), as always, returns the number of scanlines that it
2165
+ was able to produce before suspending.
2166
+ * jpeg_finish_output() will read any markers following the target scan,
2167
+ up to the end of the file or the SOS marker that begins another scan.
2168
+ (But it reads no input if jpeg_consume_input() has already reached the
2169
+ end of the file or a SOS marker beyond the target output scan.)
2170
+ * jpeg_finish_decompress() will read until the end of file, and thus can
2171
+ suspend if the end hasn't already been reached (as can be tested by
2172
+ calling jpeg_input_complete()).
2173
+ jpeg_start_output(), jpeg_finish_output(), and jpeg_finish_decompress()
2174
+ all return TRUE if they completed their tasks, FALSE if they had to suspend.
2175
+ In the event of a FALSE return, the application must load more input data
2176
+ and repeat the call. Applications that use non-suspending data sources need
2177
+ not check the return values of these three routines.
2178
+
2179
+
2180
+ It is possible to change decoding parameters between output passes in the
2181
+ buffered-image mode. The decoder library currently supports only very
2182
+ limited changes of parameters. ONLY THE FOLLOWING parameter changes are
2183
+ allowed after jpeg_start_decompress() is called:
2184
+ * dct_method can be changed before each call to jpeg_start_output().
2185
+ For example, one could use a fast DCT method for early scans, changing
2186
+ to a higher quality method for the final scan.
2187
+ * dither_mode can be changed before each call to jpeg_start_output();
2188
+ of course this has no impact if not using color quantization. Typically
2189
+ one would use ordered dither for initial passes, then switch to
2190
+ Floyd-Steinberg dither for the final pass. Caution: changing dither mode
2191
+ can cause more memory to be allocated by the library. Although the amount
2192
+ of memory involved is not large (a scanline or so), it may cause the
2193
+ initial max_memory_to_use specification to be exceeded, which in the worst
2194
+ case would result in an out-of-memory failure.
2195
+ * do_block_smoothing can be changed before each call to jpeg_start_output().
2196
+ This setting is relevant only when decoding a progressive JPEG image.
2197
+ During the first DC-only scan, block smoothing provides a very "fuzzy" look
2198
+ instead of the very "blocky" look seen without it; which is better seems a
2199
+ matter of personal taste. But block smoothing is nearly always a win
2200
+ during later stages, especially when decoding a successive-approximation
2201
+ image: smoothing helps to hide the slight blockiness that otherwise shows
2202
+ up on smooth gradients until the lowest coefficient bits are sent.
2203
+ * Color quantization mode can be changed under the rules described below.
2204
+ You *cannot* change between full-color and quantized output (because that
2205
+ would alter the required I/O buffer sizes), but you can change which
2206
+ quantization method is used.
2207
+
2208
+ When generating color-quantized output, changing quantization method is a
2209
+ very useful way of switching between high-speed and high-quality display.
2210
+ The library allows you to change among its three quantization methods:
2211
+ 1. Single-pass quantization to a fixed color cube.
2212
+ Selected by cinfo.two_pass_quantize = FALSE and cinfo.colormap = NULL.
2213
+ 2. Single-pass quantization to an application-supplied colormap.
2214
+ Selected by setting cinfo.colormap to point to the colormap (the value of
2215
+ two_pass_quantize is ignored); also set cinfo.actual_number_of_colors.
2216
+ 3. Two-pass quantization to a colormap chosen specifically for the image.
2217
+ Selected by cinfo.two_pass_quantize = TRUE and cinfo.colormap = NULL.
2218
+ (This is the default setting selected by jpeg_read_header, but it is
2219
+ probably NOT what you want for the first pass of progressive display!)
2220
+ These methods offer successively better quality and lesser speed. However,
2221
+ only the first method is available for quantizing in non-RGB color spaces.
2222
+
2223
+ IMPORTANT: because the different quantizer methods have very different
2224
+ working-storage requirements, the library requires you to indicate which
2225
+ one(s) you intend to use before you call jpeg_start_decompress(). (If we did
2226
+ not require this, the max_memory_to_use setting would be a complete fiction.)
2227
+ You do this by setting one or more of these three cinfo fields to TRUE:
2228
+ enable_1pass_quant Fixed color cube colormap
2229
+ enable_external_quant Externally-supplied colormap
2230
+ enable_2pass_quant Two-pass custom colormap
2231
+ All three are initialized FALSE by jpeg_read_header(). But
2232
+ jpeg_start_decompress() automatically sets TRUE the one selected by the
2233
+ current two_pass_quantize and colormap settings, so you only need to set the
2234
+ enable flags for any other quantization methods you plan to change to later.
2235
+
2236
+ After setting the enable flags correctly at jpeg_start_decompress() time, you
2237
+ can change to any enabled quantization method by setting two_pass_quantize
2238
+ and colormap properly just before calling jpeg_start_output(). The following
2239
+ special rules apply:
2240
+ 1. You must explicitly set cinfo.colormap to NULL when switching to 1-pass
2241
+ or 2-pass mode from a different mode, or when you want the 2-pass
2242
+ quantizer to be re-run to generate a new colormap.
2243
+ 2. To switch to an external colormap, or to change to a different external
2244
+ colormap than was used on the prior pass, you must call
2245
+ jpeg_new_colormap() after setting cinfo.colormap.
2246
+ NOTE: if you want to use the same colormap as was used in the prior pass,
2247
+ you should not do either of these things. This will save some nontrivial
2248
+ switchover costs.
2249
+ (These requirements exist because cinfo.colormap will always be non-NULL
2250
+ after completing a prior output pass, since both the 1-pass and 2-pass
2251
+ quantizers set it to point to their output colormaps. Thus you have to
2252
+ do one of these two things to notify the library that something has changed.
2253
+ Yup, it's a bit klugy, but it's necessary to do it this way for backwards
2254
+ compatibility.)
2255
+
2256
+ Note that in buffered-image mode, the library generates any requested colormap
2257
+ during jpeg_start_output(), not during jpeg_start_decompress().
2258
+
2259
+ When using two-pass quantization, jpeg_start_output() makes a pass over the
2260
+ buffered image to determine the optimum color map; it therefore may take a
2261
+ significant amount of time, whereas ordinarily it does little work. The
2262
+ progress monitor hook is called during this pass, if defined. It is also
2263
+ important to realize that if the specified target scan number is greater than
2264
+ or equal to the current input scan number, jpeg_start_output() will attempt
2265
+ to consume input as it makes this pass. If you use a suspending data source,
2266
+ you need to check for a FALSE return from jpeg_start_output() under these
2267
+ conditions. The combination of 2-pass quantization and a not-yet-fully-read
2268
+ target scan is the only case in which jpeg_start_output() will consume input.
2269
+
2270
+
2271
+ Application authors who support buffered-image mode may be tempted to use it
2272
+ for all JPEG images, even single-scan ones. This will work, but it is
2273
+ inefficient: there is no need to create an image-sized coefficient buffer for
2274
+ single-scan images. Requesting buffered-image mode for such an image wastes
2275
+ memory. Worse, it can cost time on large images, since the buffered data has
2276
+ to be swapped out or written to a temporary file. If you are concerned about
2277
+ maximum performance on baseline JPEG files, you should use buffered-image
2278
+ mode only when the incoming file actually has multiple scans. This can be
2279
+ tested by calling jpeg_has_multiple_scans(), which will return a correct
2280
+ result at any time after jpeg_read_header() completes.
2281
+
2282
+ It is also worth noting that when you use jpeg_consume_input() to let input
2283
+ processing get ahead of output processing, the resulting pattern of access to
2284
+ the coefficient buffer is quite nonsequential. It's best to use the memory
2285
+ manager jmemnobs.c if you can (ie, if you have enough real or virtual main
2286
+ memory). If not, at least make sure that max_memory_to_use is set as high as
2287
+ possible. If the JPEG memory manager has to use a temporary file, you will
2288
+ probably see a lot of disk traffic and poor performance. (This could be
2289
+ improved with additional work on the memory manager, but we haven't gotten
2290
+ around to it yet.)
2291
+
2292
+ In some applications it may be convenient to use jpeg_consume_input() for all
2293
+ input processing, including reading the initial markers; that is, you may
2294
+ wish to call jpeg_consume_input() instead of jpeg_read_header() during
2295
+ startup. This works, but note that you must check for JPEG_REACHED_SOS and
2296
+ JPEG_REACHED_EOI return codes as the equivalent of jpeg_read_header's codes.
2297
+ Once the first SOS marker has been reached, you must call
2298
+ jpeg_start_decompress() before jpeg_consume_input() will consume more input;
2299
+ it'll just keep returning JPEG_REACHED_SOS until you do. If you read a
2300
+ tables-only file this way, jpeg_consume_input() will return JPEG_REACHED_EOI
2301
+ without ever returning JPEG_REACHED_SOS; be sure to check for this case.
2302
+ If this happens, the decompressor will not read any more input until you call
2303
+ jpeg_abort() to reset it. It is OK to call jpeg_consume_input() even when not
2304
+ using buffered-image mode, but in that case it's basically a no-op after the
2305
+ initial markers have been read: it will just return JPEG_SUSPENDED.
2306
+
2307
+
2308
+ Abbreviated datastreams and multiple images
2309
+ -------------------------------------------
2310
+
2311
+ A JPEG compression or decompression object can be reused to process multiple
2312
+ images. This saves a small amount of time per image by eliminating the
2313
+ "create" and "destroy" operations, but that isn't the real purpose of the
2314
+ feature. Rather, reuse of an object provides support for abbreviated JPEG
2315
+ datastreams. Object reuse can also simplify processing a series of images in
2316
+ a single input or output file. This section explains these features.
2317
+
2318
+ A JPEG file normally contains several hundred bytes worth of quantization
2319
+ and Huffman tables. In a situation where many images will be stored or
2320
+ transmitted with identical tables, this may represent an annoying overhead.
2321
+ The JPEG standard therefore permits tables to be omitted. The standard
2322
+ defines three classes of JPEG datastreams:
2323
+ * "Interchange" datastreams contain an image and all tables needed to decode
2324
+ the image. These are the usual kind of JPEG file.
2325
+ * "Abbreviated image" datastreams contain an image, but are missing some or
2326
+ all of the tables needed to decode that image.
2327
+ * "Abbreviated table specification" (henceforth "tables-only") datastreams
2328
+ contain only table specifications.
2329
+ To decode an abbreviated image, it is necessary to load the missing table(s)
2330
+ into the decoder beforehand. This can be accomplished by reading a separate
2331
+ tables-only file. A variant scheme uses a series of images in which the first
2332
+ image is an interchange (complete) datastream, while subsequent ones are
2333
+ abbreviated and rely on the tables loaded by the first image. It is assumed
2334
+ that once the decoder has read a table, it will remember that table until a
2335
+ new definition for the same table number is encountered.
2336
+
2337
+ It is the application designer's responsibility to figure out how to associate
2338
+ the correct tables with an abbreviated image. While abbreviated datastreams
2339
+ can be useful in a closed environment, their use is strongly discouraged in
2340
+ any situation where data exchange with other applications might be needed.
2341
+ Caveat designer.
2342
+
2343
+ The JPEG library provides support for reading and writing any combination of
2344
+ tables-only datastreams and abbreviated images. In both compression and
2345
+ decompression objects, a quantization or Huffman table will be retained for
2346
+ the lifetime of the object, unless it is overwritten by a new table definition.
2347
+
2348
+
2349
+ To create abbreviated image datastreams, it is only necessary to tell the
2350
+ compressor not to emit some or all of the tables it is using. Each
2351
+ quantization and Huffman table struct contains a boolean field "sent_table",
2352
+ which normally is initialized to FALSE. For each table used by the image, the
2353
+ header-writing process emits the table and sets sent_table = TRUE unless it is
2354
+ already TRUE. (In normal usage, this prevents outputting the same table
2355
+ definition multiple times, as would otherwise occur because the chroma
2356
+ components typically share tables.) Thus, setting this field to TRUE before
2357
+ calling jpeg_start_compress() will prevent the table from being written at
2358
+ all.
2359
+
2360
+ If you want to create a "pure" abbreviated image file containing no tables,
2361
+ just call "jpeg_suppress_tables(&cinfo, TRUE)" after constructing all the
2362
+ tables. If you want to emit some but not all tables, you'll need to set the
2363
+ individual sent_table fields directly.
2364
+
2365
+ To create an abbreviated image, you must also call jpeg_start_compress()
2366
+ with a second parameter of FALSE, not TRUE. Otherwise jpeg_start_compress()
2367
+ will force all the sent_table fields to FALSE. (This is a safety feature to
2368
+ prevent abbreviated images from being created accidentally.)
2369
+
2370
+ To create a tables-only file, perform the same parameter setup that you
2371
+ normally would, but instead of calling jpeg_start_compress() and so on, call
2372
+ jpeg_write_tables(&cinfo). This will write an abbreviated datastream
2373
+ containing only SOI, DQT and/or DHT markers, and EOI. All the quantization
2374
+ and Huffman tables that are currently defined in the compression object will
2375
+ be emitted unless their sent_tables flag is already TRUE, and then all the
2376
+ sent_tables flags will be set TRUE.
2377
+
2378
+ A sure-fire way to create matching tables-only and abbreviated image files
2379
+ is to proceed as follows:
2380
+
2381
+ create JPEG compression object
2382
+ set JPEG parameters
2383
+ set destination to tables-only file
2384
+ jpeg_write_tables(&cinfo);
2385
+ set destination to image file
2386
+ jpeg_start_compress(&cinfo, FALSE);
2387
+ write data...
2388
+ jpeg_finish_compress(&cinfo);
2389
+
2390
+ Since the JPEG parameters are not altered between writing the table file and
2391
+ the abbreviated image file, the same tables are sure to be used. Of course,
2392
+ you can repeat the jpeg_start_compress() ... jpeg_finish_compress() sequence
2393
+ many times to produce many abbreviated image files matching the table file.
2394
+
2395
+ You cannot suppress output of the computed Huffman tables when Huffman
2396
+ optimization is selected. (If you could, there'd be no way to decode the
2397
+ image...) Generally, you don't want to set optimize_coding = TRUE when
2398
+ you are trying to produce abbreviated files.
2399
+
2400
+ In some cases you might want to compress an image using tables which are
2401
+ not stored in the application, but are defined in an interchange or
2402
+ tables-only file readable by the application. This can be done by setting up
2403
+ a JPEG decompression object to read the specification file, then copying the
2404
+ tables into your compression object. See jpeg_copy_critical_parameters()
2405
+ for an example of copying quantization tables.
2406
+
2407
+
2408
+ To read abbreviated image files, you simply need to load the proper tables
2409
+ into the decompression object before trying to read the abbreviated image.
2410
+ If the proper tables are stored in the application program, you can just
2411
+ allocate the table structs and fill in their contents directly. For example,
2412
+ to load a fixed quantization table into table slot "n":
2413
+
2414
+ if (cinfo.quant_tbl_ptrs[n] == NULL)
2415
+ cinfo.quant_tbl_ptrs[n] = jpeg_alloc_quant_table((j_common_ptr) &cinfo);
2416
+ quant_ptr = cinfo.quant_tbl_ptrs[n]; /* quant_ptr is JQUANT_TBL* */
2417
+ for (i = 0; i < 64; i++) {
2418
+ /* Qtable[] is desired quantization table, in natural array order */
2419
+ quant_ptr->quantval[i] = Qtable[i];
2420
+ }
2421
+
2422
+ Code to load a fixed Huffman table is typically (for AC table "n"):
2423
+
2424
+ if (cinfo.ac_huff_tbl_ptrs[n] == NULL)
2425
+ cinfo.ac_huff_tbl_ptrs[n] = jpeg_alloc_huff_table((j_common_ptr) &cinfo);
2426
+ huff_ptr = cinfo.ac_huff_tbl_ptrs[n]; /* huff_ptr is JHUFF_TBL* */
2427
+ for (i = 1; i <= 16; i++) {
2428
+ /* counts[i] is number of Huffman codes of length i bits, i=1..16 */
2429
+ huff_ptr->bits[i] = counts[i];
2430
+ }
2431
+ for (i = 0; i < 256; i++) {
2432
+ /* symbols[] is the list of Huffman symbols, in code-length order */
2433
+ huff_ptr->huffval[i] = symbols[i];
2434
+ }
2435
+
2436
+ (Note that trying to set cinfo.quant_tbl_ptrs[n] to point directly at a
2437
+ constant JQUANT_TBL object is not safe. If the incoming file happened to
2438
+ contain a quantization table definition, your master table would get
2439
+ overwritten! Instead allocate a working table copy and copy the master table
2440
+ into it, as illustrated above. Ditto for Huffman tables, of course.)
2441
+
2442
+ You might want to read the tables from a tables-only file, rather than
2443
+ hard-wiring them into your application. The jpeg_read_header() call is
2444
+ sufficient to read a tables-only file. You must pass a second parameter of
2445
+ FALSE to indicate that you do not require an image to be present. Thus, the
2446
+ typical scenario is
2447
+
2448
+ create JPEG decompression object
2449
+ set source to tables-only file
2450
+ jpeg_read_header(&cinfo, FALSE);
2451
+ set source to abbreviated image file
2452
+ jpeg_read_header(&cinfo, TRUE);
2453
+ set decompression parameters
2454
+ jpeg_start_decompress(&cinfo);
2455
+ read data...
2456
+ jpeg_finish_decompress(&cinfo);
2457
+
2458
+ In some cases, you may want to read a file without knowing whether it contains
2459
+ an image or just tables. In that case, pass FALSE and check the return value
2460
+ from jpeg_read_header(): it will be JPEG_HEADER_OK if an image was found,
2461
+ JPEG_HEADER_TABLES_ONLY if only tables were found. (A third return value,
2462
+ JPEG_SUSPENDED, is possible when using a suspending data source manager.)
2463
+ Note that jpeg_read_header() will not complain if you read an abbreviated
2464
+ image for which you haven't loaded the missing tables; the missing-table check
2465
+ occurs later, in jpeg_start_decompress().
2466
+
2467
+
2468
+ It is possible to read a series of images from a single source file by
2469
+ repeating the jpeg_read_header() ... jpeg_finish_decompress() sequence,
2470
+ without releasing/recreating the JPEG object or the data source module.
2471
+ (If you did reinitialize, any partial bufferload left in the data source
2472
+ buffer at the end of one image would be discarded, causing you to lose the
2473
+ start of the next image.) When you use this method, stored tables are
2474
+ automatically carried forward, so some of the images can be abbreviated images
2475
+ that depend on tables from earlier images.
2476
+
2477
+ If you intend to write a series of images into a single destination file,
2478
+ you might want to make a specialized data destination module that doesn't
2479
+ flush the output buffer at term_destination() time. This would speed things
2480
+ up by some trifling amount. Of course, you'd need to remember to flush the
2481
+ buffer after the last image. You can make the later images be abbreviated
2482
+ ones by passing FALSE to jpeg_start_compress().
2483
+
2484
+
2485
+ Special markers
2486
+ ---------------
2487
+
2488
+ Some applications may need to insert or extract special data in the JPEG
2489
+ datastream. The JPEG standard provides marker types "COM" (comment) and
2490
+ "APP0" through "APP15" (application) to hold application-specific data.
2491
+ Unfortunately, the use of these markers is not specified by the standard.
2492
+ COM markers are fairly widely used to hold user-supplied text. The JFIF file
2493
+ format spec uses APP0 markers with specified initial strings to hold certain
2494
+ data. Adobe applications use APP14 markers beginning with the string "Adobe"
2495
+ for miscellaneous data. Other APPn markers are rarely seen, but might
2496
+ contain almost anything.
2497
+
2498
+ If you wish to store user-supplied text, we recommend you use COM markers
2499
+ and place readable 7-bit ASCII text in them. Newline conventions are not
2500
+ standardized --- expect to find LF (Unix style), CR/LF (DOS style), or CR
2501
+ (Mac style). A robust COM reader should be able to cope with random binary
2502
+ garbage, including nulls, since some applications generate COM markers
2503
+ containing non-ASCII junk. (But yours should not be one of them.)
2504
+
2505
+ For program-supplied data, use an APPn marker, and be sure to begin it with an
2506
+ identifying string so that you can tell whether the marker is actually yours.
2507
+ It's probably best to avoid using APP0 or APP14 for any private markers.
2508
+ (NOTE: the upcoming SPIFF standard will use APP8 markers; we recommend you
2509
+ not use APP8 markers for any private purposes, either.)
2510
+
2511
+ Keep in mind that at most 65533 bytes can be put into one marker, but you
2512
+ can have as many markers as you like.
2513
+
2514
+ By default, the IJG compression library will write a JFIF APP0 marker if the
2515
+ selected JPEG colorspace is grayscale or YCbCr, or an Adobe APP14 marker if
2516
+ the selected colorspace is RGB, CMYK, or YCCK. You can disable this, but
2517
+ we don't recommend it. The decompression library will recognize JFIF and
2518
+ Adobe markers and will set the JPEG colorspace properly when one is found.
2519
+
2520
+
2521
+ You can write special markers immediately following the datastream header by
2522
+ calling jpeg_write_marker() after jpeg_start_compress() and before the first
2523
+ call to jpeg_write_scanlines(). When you do this, the markers appear after
2524
+ the SOI and the JFIF APP0 and Adobe APP14 markers (if written), but before
2525
+ all else. Specify the marker type parameter as "JPEG_COM" for COM or
2526
+ "JPEG_APP0 + n" for APPn. (Actually, jpeg_write_marker will let you write
2527
+ any marker type, but we don't recommend writing any other kinds of marker.)
2528
+ For example, to write a user comment string pointed to by comment_text:
2529
+ jpeg_write_marker(cinfo, JPEG_COM, comment_text, strlen(comment_text));
2530
+
2531
+ If it's not convenient to store all the marker data in memory at once,
2532
+ you can instead call jpeg_write_m_header() followed by multiple calls to
2533
+ jpeg_write_m_byte(). If you do it this way, it's your responsibility to
2534
+ call jpeg_write_m_byte() exactly the number of times given in the length
2535
+ parameter to jpeg_write_m_header(). (This method lets you empty the
2536
+ output buffer partway through a marker, which might be important when
2537
+ using a suspending data destination module. In any case, if you are using
2538
+ a suspending destination, you should flush its buffer after inserting
2539
+ any special markers. See "I/O suspension".)
2540
+
2541
+ Or, if you prefer to synthesize the marker byte sequence yourself,
2542
+ you can just cram it straight into the data destination module.
2543
+
2544
+ If you are writing JFIF 1.02 extension markers (thumbnail images), don't
2545
+ forget to set cinfo.JFIF_minor_version = 2 so that the encoder will write the
2546
+ correct JFIF version number in the JFIF header marker. The library's default
2547
+ is to write version 1.01, but that's wrong if you insert any 1.02 extension
2548
+ markers. (We could probably get away with just defaulting to 1.02, but there
2549
+ used to be broken decoders that would complain about unknown minor version
2550
+ numbers. To reduce compatibility risks it's safest not to write 1.02 unless
2551
+ you are actually using 1.02 extensions.)
2552
+
2553
+
2554
+ When reading, two methods of handling special markers are available:
2555
+ 1. You can ask the library to save the contents of COM and/or APPn markers
2556
+ into memory, and then examine them at your leisure afterwards.
2557
+ 2. You can supply your own routine to process COM and/or APPn markers
2558
+ on-the-fly as they are read.
2559
+ The first method is simpler to use, especially if you are using a suspending
2560
+ data source; writing a marker processor that copes with input suspension is
2561
+ not easy (consider what happens if the marker is longer than your available
2562
+ input buffer). However, the second method conserves memory since the marker
2563
+ data need not be kept around after it's been processed.
2564
+
2565
+ For either method, you'd normally set up marker handling after creating a
2566
+ decompression object and before calling jpeg_read_header(), because the
2567
+ markers of interest will typically be near the head of the file and so will
2568
+ be scanned by jpeg_read_header. Once you've established a marker handling
2569
+ method, it will be used for the life of that decompression object
2570
+ (potentially many datastreams), unless you change it. Marker handling is
2571
+ determined separately for COM markers and for each APPn marker code.
2572
+
2573
+
2574
+ To save the contents of special markers in memory, call
2575
+ jpeg_save_markers(cinfo, marker_code, length_limit)
2576
+ where marker_code is the marker type to save, JPEG_COM or JPEG_APP0+n.
2577
+ (To arrange to save all the special marker types, you need to call this
2578
+ routine 17 times, for COM and APP0-APP15.) If the incoming marker is longer
2579
+ than length_limit data bytes, only length_limit bytes will be saved; this
2580
+ parameter allows you to avoid chewing up memory when you only need to see the
2581
+ first few bytes of a potentially large marker. If you want to save all the
2582
+ data, set length_limit to 0xFFFF; that is enough since marker lengths are only
2583
+ 16 bits. As a special case, setting length_limit to 0 prevents that marker
2584
+ type from being saved at all. (That is the default behavior, in fact.)
2585
+
2586
+ After jpeg_read_header() completes, you can examine the special markers by
2587
+ following the cinfo->marker_list pointer chain. All the special markers in
2588
+ the file appear in this list, in order of their occurrence in the file (but
2589
+ omitting any markers of types you didn't ask for). Both the original data
2590
+ length and the saved data length are recorded for each list entry; the latter
2591
+ will not exceed length_limit for the particular marker type. Note that these
2592
+ lengths exclude the marker length word, whereas the stored representation
2593
+ within the JPEG file includes it. (Hence the maximum data length is really
2594
+ only 65533.)
2595
+
2596
+ It is possible that additional special markers appear in the file beyond the
2597
+ SOS marker at which jpeg_read_header stops; if so, the marker list will be
2598
+ extended during reading of the rest of the file. This is not expected to be
2599
+ common, however. If you are short on memory you may want to reset the length
2600
+ limit to zero for all marker types after finishing jpeg_read_header, to
2601
+ ensure that the max_memory_to_use setting cannot be exceeded due to addition
2602
+ of later markers.
2603
+
2604
+ The marker list remains stored until you call jpeg_finish_decompress or
2605
+ jpeg_abort, at which point the memory is freed and the list is set to empty.
2606
+ (jpeg_destroy also releases the storage, of course.)
2607
+
2608
+ Note that the library is internally interested in APP0 and APP14 markers;
2609
+ if you try to set a small nonzero length limit on these types, the library
2610
+ will silently force the length up to the minimum it wants. (But you can set
2611
+ a zero length limit to prevent them from being saved at all.) Also, in a
2612
+ 16-bit environment, the maximum length limit may be constrained to less than
2613
+ 65533 by malloc() limitations. It is therefore best not to assume that the
2614
+ effective length limit is exactly what you set it to be.
2615
+
2616
+
2617
+ If you want to supply your own marker-reading routine, you do it by calling
2618
+ jpeg_set_marker_processor(). A marker processor routine must have the
2619
+ signature
2620
+ boolean jpeg_marker_parser_method (j_decompress_ptr cinfo)
2621
+ Although the marker code is not explicitly passed, the routine can find it
2622
+ in cinfo->unread_marker. At the time of call, the marker proper has been
2623
+ read from the data source module. The processor routine is responsible for
2624
+ reading the marker length word and the remaining parameter bytes, if any.
2625
+ Return TRUE to indicate success. (FALSE should be returned only if you are
2626
+ using a suspending data source and it tells you to suspend. See the standard
2627
+ marker processors in jdmarker.c for appropriate coding methods if you need to
2628
+ use a suspending data source.)
2629
+
2630
+ If you override the default APP0 or APP14 processors, it is up to you to
2631
+ recognize JFIF and Adobe markers if you want colorspace recognition to occur
2632
+ properly. We recommend copying and extending the default processors if you
2633
+ want to do that. (A better idea is to save these marker types for later
2634
+ examination by calling jpeg_save_markers(); that method doesn't interfere
2635
+ with the library's own processing of these markers.)
2636
+
2637
+ jpeg_set_marker_processor() and jpeg_save_markers() are mutually exclusive
2638
+ --- if you call one it overrides any previous call to the other, for the
2639
+ particular marker type specified.
2640
+
2641
+ A simple example of an external COM processor can be found in djpeg.c.
2642
+ Also, see jpegtran.c for an example of using jpeg_save_markers.
2643
+
2644
+
2645
+ ICC profiles
2646
+ ------------
2647
+
2648
+ Two functions are provided for writing and reading International Color
2649
+ Consortium (ICC) device profiles embedded in JFIF JPEG image files:
2650
+
2651
+ void jpeg_write_icc_profile (j_compress_ptr cinfo,
2652
+ const JOCTET *icc_data_ptr,
2653
+ unsigned int icc_data_len);
2654
+ boolean jpeg_read_icc_profile (j_decompress_ptr cinfo,
2655
+ JOCTET **icc_data_ptr,
2656
+ unsigned int *icc_data_len);
2657
+
2658
+ The ICC has defined a standard for including such data in JPEG "APP2" markers.
2659
+ The aforementioned functions do not know anything about the internal structure
2660
+ of the ICC profile data; they just know how to embed the profile data into a
2661
+ JPEG file while writing it, or to extract the profile data from a JPEG file
2662
+ while reading it.
2663
+
2664
+ jpeg_write_icc_profile() must be called after calling jpeg_start_compress() and
2665
+ before the first call to jpeg_write_scanlines() or jpeg_write_raw_data(). This
2666
+ ordering ensures that the APP2 marker(s) will appear after the SOI and JFIF or
2667
+ Adobe markers, but before all other data.
2668
+
2669
+ jpeg_read_icc_profile() returns TRUE if an ICC profile was found and FALSE
2670
+ otherwise. If an ICC profile was found, then the function will allocate a
2671
+ memory region containing the profile and will return a pointer to that memory
2672
+ region in *icc_data_ptr, as well as the length of the region in *icc_data_len.
2673
+ This memory region is allocated by the library using malloc() and must be freed
2674
+ by the caller using free() when the memory region is no longer needed. Callers
2675
+ wishing to use jpeg_read_icc_profile() must call
2676
+
2677
+ jpeg_save_markers(cinfo, JPEG_APP0 + 2, 0xFFFF);
2678
+
2679
+ prior to calling jpeg_read_header(). jpeg_read_icc_profile() can be called at
2680
+ any point between jpeg_read_header() and jpeg_finish_decompress().
2681
+
2682
+
2683
+ Raw (downsampled) image data
2684
+ ----------------------------
2685
+
2686
+ Some applications need to supply already-downsampled image data to the JPEG
2687
+ compressor, or to receive raw downsampled data from the decompressor. The
2688
+ library supports this requirement by allowing the application to write or
2689
+ read raw data, bypassing the normal preprocessing or postprocessing steps.
2690
+ The interface is different from the standard one and is somewhat harder to
2691
+ use. If your interest is merely in bypassing color conversion, we recommend
2692
+ that you use the standard interface and simply set jpeg_color_space =
2693
+ in_color_space (or jpeg_color_space = out_color_space for decompression).
2694
+ The mechanism described in this section is necessary only to supply or
2695
+ receive downsampled image data, in which not all components have the same
2696
+ dimensions.
2697
+
2698
+
2699
+ To compress raw data, you must supply the data in the colorspace to be used
2700
+ in the JPEG file (please read the earlier section on Special color spaces)
2701
+ and downsampled to the sampling factors specified in the JPEG parameters.
2702
+ You must supply the data in the format used internally by the JPEG library,
2703
+ namely a JSAMPIMAGE array. This is an array of pointers to two-dimensional
2704
+ arrays, each of type JSAMPARRAY. Each 2-D array holds the values for one
2705
+ color component. This structure is necessary since the components are of
2706
+ different sizes. If the image dimensions are not a multiple of the MCU size,
2707
+ you must also pad the data correctly (usually, this is done by replicating
2708
+ the last column and/or row). The data must be padded to a multiple of a DCT
2709
+ block in each component: that is, each downsampled row must contain a
2710
+ multiple of 8 valid samples, and there must be a multiple of 8 sample rows
2711
+ for each component. (For applications such as conversion of digital TV
2712
+ images, the standard image size is usually a multiple of the DCT block size,
2713
+ so that no padding need actually be done.)
2714
+
2715
+ The procedure for compression of raw data is basically the same as normal
2716
+ compression, except that you call jpeg_write_raw_data() in place of
2717
+ jpeg_write_scanlines(). Before calling jpeg_start_compress(), you must do
2718
+ the following:
2719
+ * Set cinfo->raw_data_in to TRUE. (It is set FALSE by jpeg_set_defaults().)
2720
+ This notifies the library that you will be supplying raw data.
2721
+ * Ensure jpeg_color_space is correct --- an explicit jpeg_set_colorspace()
2722
+ call is a good idea. Note that since color conversion is bypassed,
2723
+ in_color_space is ignored, except that jpeg_set_defaults() uses it to
2724
+ choose the default jpeg_color_space setting.
2725
+ * Ensure the sampling factors, cinfo->comp_info[i].h_samp_factor and
2726
+ cinfo->comp_info[i].v_samp_factor, are correct. Since these indicate the
2727
+ dimensions of the data you are supplying, it's wise to set them
2728
+ explicitly, rather than assuming the library's defaults are what you want.
2729
+
2730
+ To pass raw data to the library, call jpeg_write_raw_data() in place of
2731
+ jpeg_write_scanlines(). The two routines work similarly except that
2732
+ jpeg_write_raw_data takes a JSAMPIMAGE data array rather than JSAMPARRAY.
2733
+ The scanlines count passed to and returned from jpeg_write_raw_data is
2734
+ measured in terms of the component with the largest v_samp_factor.
2735
+
2736
+ jpeg_write_raw_data() processes one MCU row per call, which is to say
2737
+ v_samp_factor*DCTSIZE sample rows of each component. The passed num_lines
2738
+ value must be at least max_v_samp_factor*DCTSIZE, and the return value will
2739
+ be exactly that amount (or possibly some multiple of that amount, in future
2740
+ library versions). This is true even on the last call at the bottom of the
2741
+ image; don't forget to pad your data as necessary.
2742
+
2743
+ The required dimensions of the supplied data can be computed for each
2744
+ component as
2745
+ cinfo->comp_info[i].width_in_blocks*DCTSIZE samples per row
2746
+ cinfo->comp_info[i].height_in_blocks*DCTSIZE rows in image
2747
+ after jpeg_start_compress() has initialized those fields. If the valid data
2748
+ is smaller than this, it must be padded appropriately. For some sampling
2749
+ factors and image sizes, additional dummy DCT blocks are inserted to make
2750
+ the image a multiple of the MCU dimensions. The library creates such dummy
2751
+ blocks itself; it does not read them from your supplied data. Therefore you
2752
+ need never pad by more than DCTSIZE samples. An example may help here.
2753
+ Assume 2h2v downsampling of YCbCr data, that is
2754
+ cinfo->comp_info[0].h_samp_factor = 2 for Y
2755
+ cinfo->comp_info[0].v_samp_factor = 2
2756
+ cinfo->comp_info[1].h_samp_factor = 1 for Cb
2757
+ cinfo->comp_info[1].v_samp_factor = 1
2758
+ cinfo->comp_info[2].h_samp_factor = 1 for Cr
2759
+ cinfo->comp_info[2].v_samp_factor = 1
2760
+ and suppose that the nominal image dimensions (cinfo->image_width and
2761
+ cinfo->image_height) are 101x101 pixels. Then jpeg_start_compress() will
2762
+ compute downsampled_width = 101 and width_in_blocks = 13 for Y,
2763
+ downsampled_width = 51 and width_in_blocks = 7 for Cb and Cr (and the same
2764
+ for the height fields). You must pad the Y data to at least 13*8 = 104
2765
+ columns and rows, the Cb/Cr data to at least 7*8 = 56 columns and rows. The
2766
+ MCU height is max_v_samp_factor = 2 DCT rows so you must pass at least 16
2767
+ scanlines on each call to jpeg_write_raw_data(), which is to say 16 actual
2768
+ sample rows of Y and 8 each of Cb and Cr. A total of 7 MCU rows are needed,
2769
+ so you must pass a total of 7*16 = 112 "scanlines". The last DCT block row
2770
+ of Y data is dummy, so it doesn't matter what you pass for it in the data
2771
+ arrays, but the scanlines count must total up to 112 so that all of the Cb
2772
+ and Cr data gets passed.
2773
+
2774
+ Output suspension is supported with raw-data compression: if the data
2775
+ destination module suspends, jpeg_write_raw_data() will return 0.
2776
+ In this case the same data rows must be passed again on the next call.
2777
+
2778
+
2779
+ Decompression with raw data output implies bypassing all postprocessing:
2780
+ you cannot ask for rescaling or color quantization, for instance. More
2781
+ seriously, you must deal with the color space and sampling factors present in
2782
+ the incoming file. If your application only handles, say, 2h1v YCbCr data,
2783
+ you must check for and fail on other color spaces or other sampling factors.
2784
+ The library will not convert to a different color space for you.
2785
+
2786
+ To obtain raw data output, set cinfo->raw_data_out = TRUE before
2787
+ jpeg_start_decompress() (it is set FALSE by jpeg_read_header()). Be sure to
2788
+ verify that the color space and sampling factors are ones you can handle.
2789
+ Then call jpeg_read_raw_data() in place of jpeg_read_scanlines(). The
2790
+ decompression process is otherwise the same as usual.
2791
+
2792
+ jpeg_read_raw_data() returns one MCU row per call, and thus you must pass a
2793
+ buffer of at least max_v_samp_factor*DCTSIZE scanlines (scanline counting is
2794
+ the same as for raw-data compression). The buffer you pass must be large
2795
+ enough to hold the actual data plus padding to DCT-block boundaries. As with
2796
+ compression, any entirely dummy DCT blocks are not processed so you need not
2797
+ allocate space for them, but the total scanline count includes them. The
2798
+ above example of computing buffer dimensions for raw-data compression is
2799
+ equally valid for decompression.
2800
+
2801
+ Input suspension is supported with raw-data decompression: if the data source
2802
+ module suspends, jpeg_read_raw_data() will return 0. You can also use
2803
+ buffered-image mode to read raw data in multiple passes.
2804
+
2805
+
2806
+ Really raw data: DCT coefficients
2807
+ ---------------------------------
2808
+
2809
+ It is possible to read or write the contents of a JPEG file as raw DCT
2810
+ coefficients. This facility is mainly intended for use in lossless
2811
+ transcoding between different JPEG file formats. Other possible applications
2812
+ include lossless cropping of a JPEG image, lossless reassembly of a
2813
+ multi-strip or multi-tile TIFF/JPEG file into a single JPEG datastream, etc.
2814
+
2815
+ To read the contents of a JPEG file as DCT coefficients, open the file and do
2816
+ jpeg_read_header() as usual. But instead of calling jpeg_start_decompress()
2817
+ and jpeg_read_scanlines(), call jpeg_read_coefficients(). This will read the
2818
+ entire image into a set of virtual coefficient-block arrays, one array per
2819
+ component. The return value is a pointer to an array of virtual-array
2820
+ descriptors. Each virtual array can be accessed directly using the JPEG
2821
+ memory manager's access_virt_barray method (see Memory management, below,
2822
+ and also read structure.txt's discussion of virtual array handling). Or,
2823
+ for simple transcoding to a different JPEG file format, the array list can
2824
+ just be handed directly to jpeg_write_coefficients().
2825
+
2826
+ Each block in the block arrays contains quantized coefficient values in
2827
+ normal array order (not JPEG zigzag order). The block arrays contain only
2828
+ DCT blocks containing real data; any entirely-dummy blocks added to fill out
2829
+ interleaved MCUs at the right or bottom edges of the image are discarded
2830
+ during reading and are not stored in the block arrays. (The size of each
2831
+ block array can be determined from the width_in_blocks and height_in_blocks
2832
+ fields of the component's comp_info entry.) This is also the data format
2833
+ expected by jpeg_write_coefficients().
2834
+
2835
+ When you are done using the virtual arrays, call jpeg_finish_decompress()
2836
+ to release the array storage and return the decompression object to an idle
2837
+ state; or just call jpeg_destroy() if you don't need to reuse the object.
2838
+
2839
+ If you use a suspending data source, jpeg_read_coefficients() will return
2840
+ NULL if it is forced to suspend; a non-NULL return value indicates successful
2841
+ completion. You need not test for a NULL return value when using a
2842
+ non-suspending data source.
2843
+
2844
+ It is also possible to call jpeg_read_coefficients() to obtain access to the
2845
+ decoder's coefficient arrays during a normal decode cycle in buffered-image
2846
+ mode. This frammish might be useful for progressively displaying an incoming
2847
+ image and then re-encoding it without loss. To do this, decode in buffered-
2848
+ image mode as discussed previously, then call jpeg_read_coefficients() after
2849
+ the last jpeg_finish_output() call. The arrays will be available for your use
2850
+ until you call jpeg_finish_decompress().
2851
+
2852
+
2853
+ To write the contents of a JPEG file as DCT coefficients, you must provide
2854
+ the DCT coefficients stored in virtual block arrays. You can either pass
2855
+ block arrays read from an input JPEG file by jpeg_read_coefficients(), or
2856
+ allocate virtual arrays from the JPEG compression object and fill them
2857
+ yourself. In either case, jpeg_write_coefficients() is substituted for
2858
+ jpeg_start_compress() and jpeg_write_scanlines(). Thus the sequence is
2859
+ * Create compression object
2860
+ * Set all compression parameters as necessary
2861
+ * Request virtual arrays if needed
2862
+ * jpeg_write_coefficients()
2863
+ * jpeg_finish_compress()
2864
+ * Destroy or re-use compression object
2865
+ jpeg_write_coefficients() is passed a pointer to an array of virtual block
2866
+ array descriptors; the number of arrays is equal to cinfo.num_components.
2867
+
2868
+ The virtual arrays need only have been requested, not realized, before
2869
+ jpeg_write_coefficients() is called. A side-effect of
2870
+ jpeg_write_coefficients() is to realize any virtual arrays that have been
2871
+ requested from the compression object's memory manager. Thus, when obtaining
2872
+ the virtual arrays from the compression object, you should fill the arrays
2873
+ after calling jpeg_write_coefficients(). The data is actually written out
2874
+ when you call jpeg_finish_compress(); jpeg_write_coefficients() only writes
2875
+ the file header.
2876
+
2877
+ When writing raw DCT coefficients, it is crucial that the JPEG quantization
2878
+ tables and sampling factors match the way the data was encoded, or the
2879
+ resulting file will be invalid. For transcoding from an existing JPEG file,
2880
+ we recommend using jpeg_copy_critical_parameters(). This routine initializes
2881
+ all the compression parameters to default values (like jpeg_set_defaults()),
2882
+ then copies the critical information from a source decompression object.
2883
+ The decompression object should have just been used to read the entire
2884
+ JPEG input file --- that is, it should be awaiting jpeg_finish_decompress().
2885
+
2886
+ jpeg_write_coefficients() marks all tables stored in the compression object
2887
+ as needing to be written to the output file (thus, it acts like
2888
+ jpeg_start_compress(cinfo, TRUE)). This is for safety's sake, to avoid
2889
+ emitting abbreviated JPEG files by accident. If you really want to emit an
2890
+ abbreviated JPEG file, call jpeg_suppress_tables(), or set the tables'
2891
+ individual sent_table flags, between calling jpeg_write_coefficients() and
2892
+ jpeg_finish_compress().
2893
+
2894
+
2895
+ Progress monitoring
2896
+ -------------------
2897
+
2898
+ Some applications may need to regain control from the JPEG library every so
2899
+ often. The typical use of this feature is to produce a percent-done bar or
2900
+ other progress display. (For a simple example, see cjpeg.c or djpeg.c.)
2901
+ Although you do get control back frequently during the data-transferring pass
2902
+ (the jpeg_read_scanlines or jpeg_write_scanlines loop), any additional passes
2903
+ will occur inside jpeg_finish_compress or jpeg_start_decompress; those
2904
+ routines may take a long time to execute, and you don't get control back
2905
+ until they are done.
2906
+
2907
+ You can define a progress-monitor routine which will be called periodically
2908
+ by the library. No guarantees are made about how often this call will occur,
2909
+ so we don't recommend you use it for mouse tracking or anything like that.
2910
+ At present, a call will occur once per MCU row, scanline, or sample row
2911
+ group, whichever unit is convenient for the current processing mode; so the
2912
+ wider the image, the longer the time between calls. During the data
2913
+ transferring pass, only one call occurs per call of jpeg_read_scanlines or
2914
+ jpeg_write_scanlines, so don't pass a large number of scanlines at once if
2915
+ you want fine resolution in the progress count. (If you really need to use
2916
+ the callback mechanism for time-critical tasks like mouse tracking, you could
2917
+ insert additional calls inside some of the library's inner loops.)
2918
+
2919
+ To establish a progress-monitor callback, create a struct jpeg_progress_mgr,
2920
+ fill in its progress_monitor field with a pointer to your callback routine,
2921
+ and set cinfo->progress to point to the struct. The callback will be called
2922
+ whenever cinfo->progress is non-NULL. (This pointer is set to NULL by
2923
+ jpeg_create_compress or jpeg_create_decompress; the library will not change
2924
+ it thereafter. So if you allocate dynamic storage for the progress struct,
2925
+ make sure it will live as long as the JPEG object does. Allocating from the
2926
+ JPEG memory manager with lifetime JPOOL_PERMANENT will work nicely.) You
2927
+ can use the same callback routine for both compression and decompression.
2928
+
2929
+ The jpeg_progress_mgr struct contains four fields which are set by the library:
2930
+ long pass_counter; /* work units completed in this pass */
2931
+ long pass_limit; /* total number of work units in this pass */
2932
+ int completed_passes; /* passes completed so far */
2933
+ int total_passes; /* total number of passes expected */
2934
+ During any one pass, pass_counter increases from 0 up to (not including)
2935
+ pass_limit; the step size is usually but not necessarily 1. The pass_limit
2936
+ value may change from one pass to another. The expected total number of
2937
+ passes is in total_passes, and the number of passes already completed is in
2938
+ completed_passes. Thus the fraction of work completed may be estimated as
2939
+ completed_passes + (pass_counter/pass_limit)
2940
+ --------------------------------------------
2941
+ total_passes
2942
+ ignoring the fact that the passes may not be equal amounts of work.
2943
+
2944
+ When decompressing, pass_limit can even change within a pass, because it
2945
+ depends on the number of scans in the JPEG file, which isn't always known in
2946
+ advance. The computed fraction-of-work-done may jump suddenly (if the library
2947
+ discovers it has overestimated the number of scans) or even decrease (in the
2948
+ opposite case). It is not wise to put great faith in the work estimate.
2949
+
2950
+ When using the decompressor's buffered-image mode, the progress monitor work
2951
+ estimate is likely to be completely unhelpful, because the library has no way
2952
+ to know how many output passes will be demanded of it. Currently, the library
2953
+ sets total_passes based on the assumption that there will be one more output
2954
+ pass if the input file end hasn't yet been read (jpeg_input_complete() isn't
2955
+ TRUE), but no more output passes if the file end has been reached when the
2956
+ output pass is started. This means that total_passes will rise as additional
2957
+ output passes are requested. If you have a way of determining the input file
2958
+ size, estimating progress based on the fraction of the file that's been read
2959
+ will probably be more useful than using the library's value.
2960
+
2961
+
2962
+ Memory management
2963
+ -----------------
2964
+
2965
+ This section covers some key facts about the JPEG library's built-in memory
2966
+ manager. For more info, please read structure.txt's section about the memory
2967
+ manager, and consult the source code if necessary.
2968
+
2969
+ All memory and temporary file allocation within the library is done via the
2970
+ memory manager. If necessary, you can replace the "back end" of the memory
2971
+ manager to control allocation yourself (for example, if you don't want the
2972
+ library to use malloc() and free() for some reason).
2973
+
2974
+ Some data is allocated "permanently" and will not be freed until the JPEG
2975
+ object is destroyed. Most data is allocated "per image" and is freed by
2976
+ jpeg_finish_compress, jpeg_finish_decompress, or jpeg_abort. You can call the
2977
+ memory manager yourself to allocate structures that will automatically be
2978
+ freed at these times. Typical code for this is
2979
+ ptr = (*cinfo->mem->alloc_small) ((j_common_ptr)cinfo, JPOOL_IMAGE, size);
2980
+ Use JPOOL_PERMANENT to get storage that lasts as long as the JPEG object.
2981
+ Use alloc_large instead of alloc_small for anything bigger than a few Kbytes.
2982
+ There are also alloc_sarray and alloc_barray routines that automatically
2983
+ build 2-D sample or block arrays.
2984
+
2985
+ The library's minimum space requirements to process an image depend on the
2986
+ image's width, but not on its height, because the library ordinarily works
2987
+ with "strip" buffers that are as wide as the image but just a few rows high.
2988
+ Some operating modes (eg, two-pass color quantization) require full-image
2989
+ buffers. Such buffers are treated as "virtual arrays": only the current strip
2990
+ need be in memory, and the rest can be swapped out to a temporary file.
2991
+
2992
+ When using temporary files, the library will make the in-memory buffers for
2993
+ its virtual arrays just big enough to stay within a "maximum memory" setting.
2994
+ Your application can set this limit by setting cinfo->mem->max_memory_to_use
2995
+ after creating the JPEG object. (Of course, there is still a minimum size for
2996
+ the buffers, so the max-memory setting is effective only if it is bigger than
2997
+ the minimum space needed.) If you allocate any large structures yourself, you
2998
+ must allocate them before jpeg_start_compress() or jpeg_start_decompress() in
2999
+ order to have them counted against the max memory limit. Also keep in mind
3000
+ that space allocated with alloc_small() is ignored, on the assumption that
3001
+ it's too small to be worth worrying about; so a reasonable safety margin
3002
+ should be left when setting max_memory_to_use.
3003
+
3004
+ NOTE: Unless you develop your own memory manager back end, then temporary files
3005
+ will never be used. The back end provided in libjpeg-turbo (jmemnobs.c) simply
3006
+ malloc()s and free()s virtual arrays, and an error occurs if the required
3007
+ memory exceeds the limit specified in cinfo->mem->max_memory_to_use.
3008
+
3009
+
3010
+ Memory usage
3011
+ ------------
3012
+
3013
+ Working memory requirements while performing compression or decompression
3014
+ depend on image dimensions, image characteristics (such as colorspace and
3015
+ JPEG process), and operating mode (application-selected options).
3016
+
3017
+ As of v6b, the decompressor requires:
3018
+ 1. About 24K in more-or-less-fixed-size data. This varies a bit depending
3019
+ on operating mode and image characteristics (particularly color vs.
3020
+ grayscale), but it doesn't depend on image dimensions.
3021
+ 2. Strip buffers (of size proportional to the image width) for IDCT and
3022
+ upsampling results. The worst case for commonly used sampling factors
3023
+ is about 34 bytes * width in pixels for a color image. A grayscale image
3024
+ only needs about 8 bytes per pixel column.
3025
+ 3. A full-image DCT coefficient buffer is needed to decode a multi-scan JPEG
3026
+ file (including progressive JPEGs), or whenever you select buffered-image
3027
+ mode. This takes 2 bytes/coefficient. At typical 2x2 sampling, that's
3028
+ 3 bytes per pixel for a color image. Worst case (1x1 sampling) requires
3029
+ 6 bytes/pixel. For grayscale, figure 2 bytes/pixel.
3030
+ 4. To perform 2-pass color quantization, the decompressor also needs a
3031
+ 128K color lookup table and a full-image pixel buffer (3 bytes/pixel).
3032
+ This does not count any memory allocated by the application, such as a
3033
+ buffer to hold the final output image.
3034
+
3035
+ The above figures are valid for 8-bit JPEG data precision and a machine with
3036
+ 32-bit ints. For 12-bit JPEG data, double the size of the strip buffers and
3037
+ quantization pixel buffer. The "fixed-size" data will be somewhat smaller
3038
+ with 16-bit ints, larger with 64-bit ints. Also, CMYK or other unusual
3039
+ color spaces will require different amounts of space.
3040
+
3041
+ The full-image coefficient and pixel buffers, if needed at all, do not
3042
+ have to be fully RAM resident; you can have the library use temporary
3043
+ files instead when the total memory usage would exceed a limit you set.
3044
+ (But if your OS supports virtual memory, it's probably better to just use
3045
+ jmemnobs and let the OS do the swapping.)
3046
+
3047
+ The compressor's memory requirements are similar, except that it has no need
3048
+ for color quantization. Also, it needs a full-image DCT coefficient buffer
3049
+ if Huffman-table optimization is asked for, even if progressive mode is not
3050
+ requested.
3051
+
3052
+ If you need more detailed information about memory usage in a particular
3053
+ situation, you can enable the MEM_STATS code in jmemmgr.c.
3054
+
3055
+
3056
+ Library compile-time options
3057
+ ----------------------------
3058
+
3059
+ A number of compile-time options are available by modifying jmorecfg.h.
3060
+
3061
+ The JPEG standard provides for both the baseline 8-bit DCT process and
3062
+ a 12-bit DCT process. The IJG code supports 12-bit lossy JPEG if you define
3063
+ BITS_IN_JSAMPLE as 12 rather than 8. Note that this causes JSAMPLE to be
3064
+ larger than a char, so it affects the surrounding application's image data.
3065
+ The sample applications cjpeg and djpeg can support 12-bit mode only for PPM
3066
+ and GIF file formats; you must disable the other file formats to compile a
3067
+ 12-bit cjpeg or djpeg. At present, a 12-bit library can handle *only* 12-bit
3068
+ images, not both precisions.
3069
+
3070
+ Note that a 12-bit library always compresses in Huffman optimization mode,
3071
+ in order to generate valid Huffman tables. This is necessary because our
3072
+ default Huffman tables only cover 8-bit data. If you need to output 12-bit
3073
+ files in one pass, you'll have to supply suitable default Huffman tables.
3074
+ You may also want to supply your own DCT quantization tables; the existing
3075
+ quality-scaling code has been developed for 8-bit use, and probably doesn't
3076
+ generate especially good tables for 12-bit.
3077
+
3078
+ The maximum number of components (color channels) in the image is determined
3079
+ by MAX_COMPONENTS. The JPEG standard allows up to 255 components, but we
3080
+ expect that few applications will need more than four or so.
3081
+
3082
+ On machines with unusual data type sizes, you may be able to improve
3083
+ performance or reduce memory space by tweaking the various typedefs in
3084
+ jmorecfg.h. In particular, on some RISC CPUs, access to arrays of "short"s
3085
+ is quite slow; consider trading memory for speed by making JCOEF, INT16, and
3086
+ UINT16 be "int" or "unsigned int". UINT8 is also a candidate to become int.
3087
+ You probably don't want to make JSAMPLE be int unless you have lots of memory
3088
+ to burn.
3089
+
3090
+ You can reduce the size of the library by compiling out various optional
3091
+ functions. To do this, undefine xxx_SUPPORTED symbols as necessary.
3092
+
3093
+ You can also save a few K by not having text error messages in the library;
3094
+ the standard error message table occupies about 5Kb. This is particularly
3095
+ reasonable for embedded applications where there's no good way to display
3096
+ a message anyway. To do this, remove the creation of the message table
3097
+ (jpeg_std_message_table[]) from jerror.c, and alter format_message to do
3098
+ something reasonable without it. You could output the numeric value of the
3099
+ message code number, for example. If you do this, you can also save a couple
3100
+ more K by modifying the TRACEMSn() macros in jerror.h to expand to nothing;
3101
+ you don't need trace capability anyway, right?
3102
+
3103
+
3104
+ Portability considerations
3105
+ --------------------------
3106
+
3107
+ The JPEG library has been written to be extremely portable; the sample
3108
+ applications cjpeg and djpeg are slightly less so. This section summarizes
3109
+ the design goals in this area. (If you encounter any bugs that cause the
3110
+ library to be less portable than is claimed here, we'd appreciate hearing
3111
+ about them.)
3112
+
3113
+ The code works fine on ANSI C and C++ compilers, using any of the popular
3114
+ system include file setups, and some not-so-popular ones too.
3115
+
3116
+ The code is not dependent on the exact sizes of the C data types. As
3117
+ distributed, we make the assumptions that
3118
+ char is at least 8 bits wide
3119
+ short is at least 16 bits wide
3120
+ int is at least 16 bits wide
3121
+ long is at least 32 bits wide
3122
+ (These are the minimum requirements of the ANSI C standard.) Wider types will
3123
+ work fine, although memory may be used inefficiently if char is much larger
3124
+ than 8 bits or short is much bigger than 16 bits. The code should work
3125
+ equally well with 16- or 32-bit ints.
3126
+
3127
+ In a system where these assumptions are not met, you may be able to make the
3128
+ code work by modifying the typedefs in jmorecfg.h. However, you will probably
3129
+ have difficulty if int is less than 16 bits wide, since references to plain
3130
+ int abound in the code.
3131
+
3132
+ char can be either signed or unsigned, although the code runs faster if an
3133
+ unsigned char type is available. If char is wider than 8 bits, you will need
3134
+ to redefine JOCTET and/or provide custom data source/destination managers so
3135
+ that JOCTET represents exactly 8 bits of data on external storage.
3136
+
3137
+ The JPEG library proper does not assume ASCII representation of characters.
3138
+ But some of the image file I/O modules in cjpeg/djpeg do have ASCII
3139
+ dependencies in file-header manipulation; so does cjpeg's select_file_type()
3140
+ routine.
3141
+
3142
+ The JPEG library does not rely heavily on the C library. In particular, C
3143
+ stdio is used only by the data source/destination modules and the error
3144
+ handler, all of which are application-replaceable. (cjpeg/djpeg are more
3145
+ heavily dependent on stdio.) malloc and free are called only from the memory
3146
+ manager "back end" module, so you can use a different memory allocator by
3147
+ replacing that one file.
3148
+
3149
+ More info about porting the code may be gleaned by reading jconfig.txt,
3150
+ jmorecfg.h, and jinclude.h.