README 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263
  1. README for libpng version 1.2.12 - June 27, 2006 (shared library 12.0)
  2. See the note about version numbers near the top of png.h
  3. See INSTALL for instructions on how to install libpng.
  4. Libpng comes in several distribution formats. Get libpng-*.tar.gz
  5. or libpng-*.tar.bz2 if you want UNIX-style line endings in the text
  6. files, or lpng*.zip if you want DOS-style line endings.
  7. Version 0.89 was the first official release of libpng. Don't let the
  8. fact that it's the first release fool you. The libpng library has been in
  9. extensive use and testing since mid-1995. By late 1997 it had
  10. finally gotten to the stage where there hadn't been significant
  11. changes to the API in some time, and people have a bad feeling about
  12. libraries with versions < 1.0. Version 1.0.0 was released in
  13. March 1998.
  14. ****
  15. Note that some of the changes to the png_info structure render this
  16. version of the library binary incompatible with libpng-0.89 or
  17. earlier versions if you are using a shared library. The type of the
  18. "filler" parameter for png_set_filler() has changed from png_byte to
  19. png_uint_32, which will affect shared-library applications that use
  20. this function.
  21. To avoid problems with changes to the internals of png_info_struct,
  22. new APIs have been made available in 0.95 to avoid direct application
  23. access to info_ptr. These functions are the png_set_<chunk> and
  24. png_get_<chunk> functions. These functions should be used when
  25. accessing/storing the info_struct data, rather than manipulating it
  26. directly, to avoid such problems in the future.
  27. It is important to note that the APIs do not make current programs
  28. that access the info struct directly incompatible with the new
  29. library. However, it is strongly suggested that new programs use
  30. the new APIs (as shown in example.c and pngtest.c), and older programs
  31. be converted to the new format, to facilitate upgrades in the future.
  32. ****
  33. Additions since 0.90 include the ability to compile libpng as a
  34. Windows DLL, and new APIs for accessing data in the info struct.
  35. Experimental functions include the ability to set weighting and cost
  36. factors for row filter selection, direct reads of integers from buffers
  37. on big-endian processors that support misaligned data access, faster
  38. methods of doing alpha composition, and more accurate 16->8 bit color
  39. conversion.
  40. The additions since 0.89 include the ability to read from a PNG stream
  41. which has had some (or all) of the signature bytes read by the calling
  42. application. This also allows the reading of embedded PNG streams that
  43. do not have the PNG file signature. As well, it is now possible to set
  44. the library action on the detection of chunk CRC errors. It is possible
  45. to set different actions based on whether the CRC error occurred in a
  46. critical or an ancillary chunk.
  47. The changes made to the library, and bugs fixed are based on discussions
  48. on the PNG-implement mailing list
  49. and not on material submitted privately to Guy, Andreas, or Glenn. They will
  50. forward any good suggestions to the list.
  51. For a detailed description on using libpng, read libpng.txt. For
  52. examples of libpng in a program, see example.c and pngtest.c. For usage
  53. information and restrictions (what little they are) on libpng, see
  54. png.h. For a description on using zlib (the compression library used by
  55. libpng) and zlib's restrictions, see zlib.h
  56. I have included a general makefile, as well as several machine and
  57. compiler specific ones, but you may have to modify one for your own needs.
  58. You should use zlib 1.0.4 or later to run this, but it MAY work with
  59. versions as old as zlib 0.95. Even so, there are bugs in older zlib
  60. versions which can cause the output of invalid compression streams for
  61. some images. You will definitely need zlib 1.0.4 or later if you are
  62. taking advantage of the MS-DOS "far" structure allocation for the small
  63. and medium memory models. You should also note that zlib is a
  64. compression library that is useful for more things than just PNG files.
  65. You can use zlib as a drop-in replacement for fread() and fwrite() if
  66. you are so inclined.
  67. zlib should be available at the same place that libpng is, or at.
  68. ftp://ftp.info-zip.org/pub/infozip/zlib
  69. You may also want a copy of the PNG specification. It is available
  70. as an RFC, a W3C Recommendation, and an ISO/IEC Standard. You can find
  71. these at http://www.libpng.org/pub/png/documents/
  72. This code is currently being archived at libpng.sf.net in the
  73. [DOWNLOAD] area, and on CompuServe, Lib 20 (PNG SUPPORT)
  74. at GO GRAPHSUP. If you can't find it in any of those places,
  75. e-mail me, and I'll help you find it.
  76. If you have any code changes, requests, problems, etc., please e-mail
  77. them to me. Also, I'd appreciate any make files or project files,
  78. and any modifications you needed to make to get libpng to compile,
  79. along with a #define variable to tell what compiler/system you are on.
  80. If you needed to add transformations to libpng, or wish libpng would
  81. provide the image in a different way, drop me a note (and code, if
  82. possible), so I can consider supporting the transformation.
  83. Finally, if you get any warning messages when compiling libpng
  84. (note: not zlib), and they are easy to fix, I'd appreciate the
  85. fix. Please mention "libpng" somewhere in the subject line. Thanks.
  86. This release was created and will be supported by myself (of course
  87. based in a large way on Guy's and Andreas' earlier work), and the PNG group.
  88. Send comments/corrections/commendations to png-mng-implement at lists.sf.net
  89. (subscription required; visit
  90. https://lists.sourceforge.net/lists/listinfo/png-mng-implement
  91. to subscribe) or to glennrp at users.sourceforge.net
  92. You can't reach Guy, the original libpng author, at the addresses
  93. given in previous versions of this document. He and Andreas will read mail
  94. addressed to the png-implement list, however.
  95. Please do not send general questions about PNG. Send them to
  96. the (png-list at ccrc.wustl.edu, subscription required, write to
  97. majordomo at ccrc.wustl.edu with "subscribe png-list" in your message).
  98. On the other hand,
  99. please do not send libpng questions to that address, send them to me
  100. or to the png-implement list. I'll
  101. get them in the end anyway. If you have a question about something
  102. in the PNG specification that is related to using libpng, send it
  103. to me. Send me any questions that start with "I was using libpng,
  104. and ...". If in doubt, send questions to me. I'll bounce them
  105. to others, if necessary.
  106. Please do not send suggestions on how to change PNG. We have
  107. been discussing PNG for nine years now, and it is official and
  108. finished. If you have suggestions for libpng, however, I'll
  109. gladly listen. Even if your suggestion is not used immediately,
  110. it may be used later.
  111. Files in this distribution:
  112. ANNOUNCE => Announcement of this version, with recent changes
  113. CHANGES => Description of changes between libpng versions
  114. KNOWNBUG => List of known bugs and deficiencies
  115. LICENSE => License to use and redistribute libpng
  116. README => This file
  117. TODO => Things not implemented in the current library
  118. Y2KINFO => Statement of Y2K compliance
  119. example.c => Example code for using libpng functions
  120. libpng.3 => manual page for libpng (includes libpng.txt)
  121. libpng.txt => Description of libpng and its functions
  122. libpngpf.3 => manual page for libpng's private functions
  123. png.5 => manual page for the PNG format
  124. png.c => Basic interface functions common to library
  125. png.h => Library function and interface declarations
  126. pngconf.h => System specific library configuration
  127. pngasmrd.h => Header file for assembler-coded functions
  128. pngerror.c => Error/warning message I/O functions
  129. pngget.c => Functions for retrieving info from struct
  130. pngmem.c => Memory handling functions
  131. pngbar.png => PNG logo, 88x31
  132. pngnow.png => PNG logo, 98x31
  133. pngpread.c => Progressive reading functions
  134. pngread.c => Read data/helper high-level functions
  135. pngrio.c => Lowest-level data read I/O functions
  136. pngrtran.c => Read data transformation functions
  137. pngrutil.c => Read data utility functions
  138. pngset.c => Functions for storing data into the info_struct
  139. pngtest.c => Library test program
  140. pngtest.png => Library test sample image
  141. pngtrans.c => Common data transformation functions
  142. pngwio.c => Lowest-level write I/O functions
  143. pngwrite.c => High-level write functions
  144. pngwtran.c => Write data transformations
  145. pngwutil.c => Write utility functions
  146. contrib => Contributions
  147. gregbook => source code for PNG reading and writing, from
  148. Greg Roelofs' "PNG: The Definitive Guide",
  149. O'Reilly, 1999
  150. msvctest => Builds and runs pngtest using a MSVC workspace
  151. pngminus => Simple pnm2png and png2pnm programs
  152. pngsuite => Test images
  153. visupng => Contains a MSVC workspace for VisualPng
  154. projects => Contains project files and workspaces for building DLL
  155. beos => Contains a Beos workspace for building libpng
  156. c5builder => Contains a Borland workspace for building libpng
  157. and zlib
  158. visualc6 => Contains a Microsoft Visual C++ (MSVC) workspace
  159. for building libpng and zlib
  160. netware.txt => Contains instructions for downloading a set of
  161. project files for building libpng and zlib on
  162. Netware.
  163. wince.txt => Contains instructions for downloading a Microsoft
  164. Visual C++ (Windows CD Toolkit) workspace for
  165. building libpng and zlib on WindowsCE
  166. scripts => Directory containing scripts for building libpng:
  167. descrip.mms => VMS makefile for MMS or MMK
  168. makefile.std => Generic UNIX makefile (cc, creates static libpng.a)
  169. makefile.elf => Linux/ELF makefile symbol versioning,
  170. gcc, creates libpng12.so.0.1.2.12)
  171. makefile.linux => Linux/ELF makefile
  172. (gcc, creates libpng12.so.0.1.2.12)
  173. makefile.gcmmx => Linux/ELF makefile
  174. (gcc, creates libpng12.so.0.1.2.12,
  175. uses assembler code tuned for Intel MMX platform)
  176. makefile.gcc => Generic makefile (gcc, creates static libpng.a)
  177. makefile.knr => Archaic UNIX Makefile that converts files with
  178. ansi2knr (Requires ansi2knr.c from
  179. ftp://ftp.cs.wisc.edu/ghost)
  180. makefile.aix => AIX makefile
  181. makefile.cygwin => Cygwin/gcc makefile
  182. makefile.darwin => Darwin makefile
  183. makefile.dec => DEC Alpha UNIX makefile
  184. makefile.freebsd => FreeBSD makefile
  185. makefile.hpgcc => HPUX makefile using gcc
  186. makefile.hpux => HPUX (10.20 and 11.00) makefile
  187. makefile.hp64 => HPUX (10.20 and 11.00) makefile, 64 bit
  188. makefile.ibmc => IBM C/C++ version 3.x for Win32 and OS/2 (static)
  189. makefile.intel => Intel C/C++ version 4.0 and later
  190. libpng.icc => Project file, IBM VisualAge/C++ 4.0 or later
  191. makefile.netbsd => NetBSD/cc makefile, PNGGCCRD, makes libpng.so.
  192. makefile.ne12bsd => NetBSD/cc makefile, PNGGCCRD, makes libpng12.so
  193. makefile.openbsd => OpenBSD makefile
  194. makefile.sgi => Silicon Graphics IRIX (cc, creates static lib)
  195. makefile.sggcc => Silicon Graphics
  196. (gcc, creates libpng12.so.0.1.2.12)
  197. makefile.sunos => Sun makefile
  198. makefile.solaris => Solaris 2.X makefile
  199. (gcc, creates libpng12.so.0.1.2.12)
  200. makefile.so9 => Solaris 9 makefile
  201. (gcc, creates libpng12.so.0.1.2.12)
  202. makefile.32sunu => Sun Ultra 32-bit makefile
  203. makefile.64sunu => Sun Ultra 64-bit makefile
  204. makefile.sco => For SCO OSr5 ELF and Unixware 7 with Native cc
  205. makefile.mips => MIPS makefile
  206. makefile.acorn => Acorn makefile
  207. makefile.amiga => Amiga makefile
  208. smakefile.ppc => AMIGA smakefile for SAS C V6.58/7.00 PPC
  209. compiler (Requires SCOPTIONS, copied from
  210. scripts/SCOPTIONS.ppc)
  211. makefile.atari => Atari makefile
  212. makefile.beos => BEOS makefile for X86
  213. makefile.bor => Borland makefile (uses bcc)
  214. makefile.bc32 => 32-bit Borland C++ (all modules compiled in C mode)
  215. makefile.tc3 => Turbo C 3.0 makefile
  216. makefile.dj2 => DJGPP 2 makefile
  217. makefile.msc => Microsoft C makefile
  218. makefile.vcawin32=> makefile for Microsoft Visual C++ 5.0 and
  219. later (uses assembler code tuned for Intel MMX
  220. platform)
  221. makefile.vcwin32 => makefile for Microsoft Visual C++ 4.0 and
  222. later (does not use assembler code)
  223. makefile.os2 => OS/2 Makefile (gcc and emx, requires pngos2.def)
  224. pngos2.def => OS/2 module definition file used by makefile.os2
  225. makefile.watcom => Watcom 10a+ Makefile, 32-bit flat memory model
  226. makevms.com => VMS build script
  227. SCOPTIONS.ppc => Used with smakefile.ppc
  228. Good luck, and happy coding.
  229. -Glenn Randers-Pehrson (current maintainer)
  230. Internet: glennrp at users.sourceforge.net
  231. -Andreas Eric Dilger (former maintainer, 1996-1997)
  232. Internet: adilger at enel.ucalgary.ca
  233. Web: http://www-mddsp.enel.ucalgary.ca/People/adilger/
  234. -Guy Eric Schalnat (original author and former maintainer, 1995-1996)
  235. (formerly of Group 42, Inc)
  236. Internet: gschal at infinet.com