src/libpng/README

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