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