blob: 6a3623bcb7686e0e6f3a89712a6c04cde13ab193 [file] [log] [blame]
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -06001README for libpng version 1.2.9beta1 - February 21, 2006 (shared library 12.0)
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06002See the note about version numbers near the top of png.h
Andreas Dilger02ad0ef1997-01-17 01:34:35 -06003
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06004See INSTALL for instructions on how to install libpng.
Glenn Randers-Pehrson2687fcc1998-01-07 20:54:20 -06005
Glenn Randers-Pehrson5b5dcf82004-07-17 22:45:44 -05006Libpng comes in several distribution formats. Get libpng-*.tar.gz
7or libpng-*.tar.bz2 if you want UNIX-style line endings in the text
8files, or lpng*.zip if you want DOS-style line endings.
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -06009
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -050010Version 0.89 was the first official release of libpng. Don't let the
11fact that it's the first release fool you. The libpng library has been in
12extensive use and testing since mid-1995. By late 1997 it had
13finally gotten to the stage where there hadn't been significant
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060014changes to the API in some time, and people have a bad feeling about
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -050015libraries with versions < 1.0. Version 1.0.0 was released in
16March 1998.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060017
Andreas Dilger47a0c421997-05-16 02:46:07 -050018****
19Note that some of the changes to the png_info structure render this
20version of the library binary incompatible with libpng-0.89 or
21earlier versions if you are using a shared library. The type of the
22"filler" parameter for png_set_filler() has changed from png_byte to
Glenn Randers-Pehrson2687fcc1998-01-07 20:54:20 -060023png_uint_32, which will affect shared-library applications that use
Andreas Dilger47a0c421997-05-16 02:46:07 -050024this function.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060025
Andreas Dilger47a0c421997-05-16 02:46:07 -050026To avoid problems with changes to the internals of png_info_struct,
27new APIs have been made available in 0.95 to avoid direct application
28access to info_ptr. These functions are the png_set_<chunk> and
29png_get_<chunk> functions. These functions should be used when
30accessing/storing the info_struct data, rather than manipulating it
31directly, to avoid such problems in the future.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060032
33It is important to note that the APIs do not make current programs
Glenn Randers-Pehrson2687fcc1998-01-07 20:54:20 -060034that access the info struct directly incompatible with the new
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060035library. However, it is strongly suggested that new programs use
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -050036the new APIs (as shown in example.c and pngtest.c), and older programs
37be converted to the new format, to facilitate upgrades in the future.
Andreas Dilger47a0c421997-05-16 02:46:07 -050038****
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060039
Andreas Dilger47a0c421997-05-16 02:46:07 -050040Additions since 0.90 include the ability to compile libpng as a
41Windows DLL, and new APIs for accessing data in the info struct.
42Experimental functions include the ability to set weighting and cost
43factors for row filter selection, direct reads of integers from buffers
44on big-endian processors that support misaligned data access, faster
45methods of doing alpha composition, and more accurate 16->8 bit color
46conversion.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060047
Andreas Dilger47a0c421997-05-16 02:46:07 -050048The additions since 0.89 include the ability to read from a PNG stream
49which has had some (or all) of the signature bytes read by the calling
50application. This also allows the reading of embedded PNG streams that
51do not have the PNG file signature. As well, it is now possible to set
52the library action on the detection of chunk CRC errors. It is possible
53to set different actions based on whether the CRC error occurred in a
54critical or an ancillary chunk.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060055
56The changes made to the library, and bugs fixed are based on discussions
Glenn Randers-Pehrson250dfe12004-09-11 21:19:54 -050057on the PNG-implement mailing list
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -050058and not on material submitted privately to Guy, Andreas, or Glenn. They will
59forward any good suggestions to the list.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060060
61For a detailed description on using libpng, read libpng.txt. For
Andreas Dilger47a0c421997-05-16 02:46:07 -050062examples of libpng in a program, see example.c and pngtest.c. For usage
63information and restrictions (what little they are) on libpng, see
64png.h. For a description on using zlib (the compression library used by
65libpng) and zlib's restrictions, see zlib.h
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060066
Andreas Dilger47a0c421997-05-16 02:46:07 -050067I have included a general makefile, as well as several machine and
68compiler specific ones, but you may have to modify one for your own needs.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060069
70You should use zlib 1.0.4 or later to run this, but it MAY work with
71versions as old as zlib 0.95. Even so, there are bugs in older zlib
72versions which can cause the output of invalid compression streams for
73some images. You will definitely need zlib 1.0.4 or later if you are
74taking advantage of the MS-DOS "far" structure allocation for the small
75and medium memory models. You should also note that zlib is a
76compression library that is useful for more things than just PNG files.
77You can use zlib as a drop-in replacement for fread() and fwrite() if
78you are so inclined.
79
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -050080zlib should be available at the same place that libpng is, or at.
81ftp://ftp.info-zip.org/pub/infozip/zlib
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060082
83You may also want a copy of the PNG specification. It is available
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -050084as an RFC, a W3C Recommendation, and an ISO/IEC Standard. You can find
85these at http://www.libpng.org/pub/png/documents/
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060086
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -050087This code is currently being archived at libpng.sf.net in the
88[DOWNLOAD] area, and on CompuServe, Lib 20 (PNG SUPPORT)
Andreas Dilger02ad0ef1997-01-17 01:34:35 -060089at GO GRAPHSUP. If you can't find it in any of those places,
90e-mail me, and I'll help you find it.
91
92If you have any code changes, requests, problems, etc., please e-mail
93them to me. Also, I'd appreciate any make files or project files,
94and any modifications you needed to make to get libpng to compile,
95along with a #define variable to tell what compiler/system you are on.
96If you needed to add transformations to libpng, or wish libpng would
97provide the image in a different way, drop me a note (and code, if
98possible), so I can consider supporting the transformation.
99Finally, if you get any warning messages when compiling libpng
100(note: not zlib), and they are easy to fix, I'd appreciate the
101fix. Please mention "libpng" somewhere in the subject line. Thanks.
102
103This release was created and will be supported by myself (of course
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600104based in a large way on Guy's and Andreas' earlier work), and the PNG group.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600105
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600106Send comments/corrections/commendations to png-mng-implement at lists.sf.net
107(subscription required; visit
108https://lists.sourceforge.net/lists/listinfo/png-mng-implement
109to subscribe) or to glennrp at users.sourceforge.net
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600110
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600111You can't reach Guy, the original libpng author, at the addresses
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600112given in previous versions of this document. He and Andreas will read mail
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600113addressed to the png-implement list, however.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600114
115Please do not send general questions about PNG. Send them to
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600116the (png-list at ccrc.wustl.edu, subscription required, write to
117majordomo at ccrc.wustl.edu with "subscribe png-list" in your message).
Glenn Randers-Pehrson250dfe12004-09-11 21:19:54 -0500118On the other hand,
119please do not send libpng questions to that address, send them to me
120or to the png-implement list. I'll
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600121get them in the end anyway. If you have a question about something
122in the PNG specification that is related to using libpng, send it
123to me. Send me any questions that start with "I was using libpng,
124and ...". If in doubt, send questions to me. I'll bounce them
125to others, if necessary.
126
127Please do not send suggestions on how to change PNG. We have
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500128been discussing PNG for nine years now, and it is official and
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600129finished. If you have suggestions for libpng, however, I'll
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500130gladly listen. Even if your suggestion is not used immediately,
131it may be used later.
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600132
133Files in this distribution:
134
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600135 ANNOUNCE => Announcement of this version, with recent changes
Andreas Dilger47a0c421997-05-16 02:46:07 -0500136 CHANGES => Description of changes between libpng versions
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600137 KNOWNBUG => List of known bugs and deficiencies
138 LICENSE => License to use and redistribute libpng
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600139 README => This file
140 TODO => Things not implemented in the current library
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600141 Y2KINFO => Statement of Y2K compliance
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600142 example.c => Example code for using libpng functions
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600143 libpng.3 => manual page for libpng (includes libpng.txt)
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600144 libpng.txt => Description of libpng and its functions
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600145 libpngpf.3 => manual page for libpng's private functions
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600146 png.5 => manual page for the PNG format
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600147 png.c => Basic interface functions common to library
148 png.h => Library function and interface declarations
149 pngconf.h => System specific library configuration
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600150 pngasmrd.h => Header file for assembler-coded functions
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600151 pngerror.c => Error/warning message I/O functions
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600152 pngget.c => Functions for retrieving info from struct
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600153 pngmem.c => Memory handling functions
Glenn Randers-Pehrsona4d54bd2000-07-14 08:15:12 -0500154 pngbar.png => PNG logo, 88x31
155 pngnow.png => PNG logo, 98x31
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600156 pngpread.c => Progressive reading functions
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600157 pngread.c => Read data/helper high-level functions
158 pngrio.c => Lowest-level data read I/O functions
159 pngrtran.c => Read data transformation functions
160 pngrutil.c => Read data utility functions
Andreas Dilger47a0c421997-05-16 02:46:07 -0500161 pngset.c => Functions for storing data into the info_struct
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600162 pngtest.c => Library test program
163 pngtest.png => Library test sample image
164 pngtrans.c => Common data transformation functions
165 pngwio.c => Lowest-level write I/O functions
166 pngwrite.c => High-level write functions
167 pngwtran.c => Write data transformations
168 pngwutil.c => Write utility functions
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -0500169 contrib => Contributions
170 gregbook => source code for PNG reading and writing, from
171 Greg Roelofs' "PNG: The Definitive Guide",
172 O'Reilly, 1999
Glenn Randers-Pehrsond4366722000-06-04 14:29:29 -0500173 msvctest => Builds and runs pngtest using a MSVC workspace
Glenn Randers-Pehrson6d8f3b01999-10-23 08:39:18 -0500174 pngminus => Simple pnm2png and png2pnm programs
175 pngsuite => Test images
Glenn Randers-Pehrsondb66d442000-06-23 21:38:16 -0500176 visupng => Contains a MSVC workspace for VisualPng
Glenn Randers-Pehrsonfbbb5ec2001-01-15 22:01:20 -0600177 projects => Contains project files and workspaces for building DLL
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500178 beos => Contains a Beos workspace for building libpng
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500179 c5builder => Contains a Borland workspace for building libpng
Glenn Randers-Pehrsonfbbb5ec2001-01-15 22:01:20 -0600180 and zlib
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500181 visualc6 => Contains a Microsoft Visual C++ (MSVC) workspace
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600182 for building libpng and zlib
Glenn Randers-Pehrsonb1828932001-06-23 08:03:17 -0500183 netware.txt => Contains instructions for downloading a set of
184 project files for building libpng and zlib on
185 Netware.
186 wince.txt => Contains instructions for downloading a Microsoft
187 Visual C++ (Windows CD Toolkit) workspace for
188 building libpng and zlib on WindowsCE
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -0600189 scripts => Directory containing scripts for building libpng:
Glenn Randers-Pehrsonf8b008c1999-09-18 10:54:36 -0500190 descrip.mms => VMS makefile for MMS or MMK
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600191 makefile.std => Generic UNIX makefile (cc, creates static libpng.a)
Glenn Randers-Pehrsonc3dda6d2004-11-27 18:22:29 -0600192 makefile.elf => Linux/ELF makefile symbol versioning,
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600193 gcc, creates libpng12.so.0.1.2.9beta1)
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600194 makefile.linux => Linux/ELF makefile
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600195 (gcc, creates libpng12.so.0.1.2.9beta1)
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500196 makefile.gcmmx => Linux/ELF makefile
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600197 (gcc, creates libpng12.so.0.1.2.9beta1,
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500198 uses assembler code tuned for Intel MMX platform)
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600199 makefile.gcc => Generic makefile (gcc, creates static libpng.a)
Glenn Randers-Pehrsonf8b008c1999-09-18 10:54:36 -0500200 makefile.knr => Archaic UNIX Makefile that converts files with
201 ansi2knr (Requires ansi2knr.c from
202 ftp://ftp.cs.wisc.edu/ghost)
Glenn Randers-Pehrsond56aca72000-11-23 11:51:42 -0600203 makefile.aix => AIX makefile
Glenn Randers-Pehrson5e5c1e12000-11-10 12:26:19 -0600204 makefile.cygwin => Cygwin/gcc makefile
Glenn Randers-Pehrson5cded0b2001-11-07 07:10:08 -0600205 makefile.darwin => Darwin makefile
Glenn Randers-Pehrsonf8b008c1999-09-18 10:54:36 -0500206 makefile.dec => DEC Alpha UNIX makefile
Glenn Randers-Pehrson03008a02002-04-27 10:11:25 -0500207 makefile.freebsd => FreeBSD makefile
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500208 makefile.hpgcc => HPUX makefile using gcc
Glenn Randers-Pehrsonf8b008c1999-09-18 10:54:36 -0500209 makefile.hpux => HPUX (10.20 and 11.00) makefile
Glenn Randers-Pehrson250dfe12004-09-11 21:19:54 -0500210 makefile.hp64 => HPUX (10.20 and 11.00) makefile, 64 bit
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -0600211 makefile.ibmc => IBM C/C++ version 3.x for Win32 and OS/2 (static)
Glenn Randers-Pehrsonec61c232000-05-16 06:17:36 -0500212 makefile.intel => Intel C/C++ version 4.0 and later
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -0600213 libpng.icc => Project file, IBM VisualAge/C++ 4.0 or later
Glenn Randers-Pehrson4fb046a2002-04-15 09:25:51 -0500214 makefile.netbsd => NetBSD/cc makefile, PNGGCCRD, makes libpng.so.
Glenn Randers-Pehrson250dfe12004-09-11 21:19:54 -0500215 makefile.ne12bsd => NetBSD/cc makefile, PNGGCCRD, makes libpng12.so
Glenn Randers-Pehrsonc1bfe682002-03-06 22:08:00 -0600216 makefile.openbsd => OpenBSD makefile
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600217 makefile.sgi => Silicon Graphics IRIX (cc, creates static lib)
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500218 makefile.sggcc => Silicon Graphics
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600219 (gcc, creates libpng12.so.0.1.2.9beta1)
Glenn Randers-Pehrsonf8b008c1999-09-18 10:54:36 -0500220 makefile.sunos => Sun makefile
221 makefile.solaris => Solaris 2.X makefile
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600222 (gcc, creates libpng12.so.0.1.2.9beta1)
Glenn Randers-Pehrson5cded0b2001-11-07 07:10:08 -0600223 makefile.so9 => Solaris 9 makefile
Glenn Randers-Pehrson9c3ab682006-02-20 22:09:05 -0600224 (gcc, creates libpng12.so.0.1.2.9beta1)
Glenn Randers-Pehrsonc1bfe682002-03-06 22:08:00 -0600225 makefile.32sunu => Sun Ultra 32-bit makefile
226 makefile.64sunu => Sun Ultra 64-bit makefile
Glenn Randers-Pehrsonf8b008c1999-09-18 10:54:36 -0500227 makefile.sco => For SCO OSr5 ELF and Unixware 7 with Native cc
228 makefile.mips => MIPS makefile
229 makefile.acorn => Acorn makefile
230 makefile.amiga => Amiga makefile
231 smakefile.ppc => AMIGA smakefile for SAS C V6.58/7.00 PPC
232 compiler (Requires SCOPTIONS, copied from
233 scripts/SCOPTIONS.ppc)
234 makefile.atari => Atari makefile
235 makefile.beos => BEOS makefile for X86
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600236 makefile.bor => Borland makefile (uses bcc)
237 makefile.bc32 => 32-bit Borland C++ (all modules compiled in C mode)
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600238 makefile.tc3 => Turbo C 3.0 makefile
Glenn Randers-Pehrsonf8b008c1999-09-18 10:54:36 -0500239 makefile.dj2 => DJGPP 2 makefile
240 makefile.msc => Microsoft C makefile
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500241 makefile.vcawin32=> makefile for Microsoft Visual C++ 5.0 and
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600242 later (uses assembler code tuned for Intel MMX
243 platform)
Glenn Randers-Pehrsonbcfd15d1999-10-01 14:22:25 -0500244 makefile.vcwin32 => makefile for Microsoft Visual C++ 4.0 and
245 later (does not use assembler code)
Glenn Randers-Pehrsonf8b008c1999-09-18 10:54:36 -0500246 makefile.os2 => OS/2 Makefile (gcc and emx, requires pngos2.def)
247 pngos2.def => OS/2 module definition file used by makefile.os2
248 makefile.watcom => Watcom 10a+ Makefile, 32-bit flat memory model
249 makevms.com => VMS build script
Glenn Randers-Pehrsonf8b008c1999-09-18 10:54:36 -0500250 SCOPTIONS.ppc => Used with smakefile.ppc
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600251
252Good luck, and happy coding.
253
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500254-Glenn Randers-Pehrson (current maintainer)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600255 Internet: glennrp at users.sourceforge.net
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600256
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500257-Andreas Eric Dilger (former maintainer, 1996-1997)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600258 Internet: adilger at enel.ucalgary.ca
Andreas Dilger47a0c421997-05-16 02:46:07 -0500259 Web: http://www-mddsp.enel.ucalgary.ca/People/adilger/
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600260
Glenn Randers-Pehrsona4981d42004-08-25 22:00:45 -0500261-Guy Eric Schalnat (original author and former maintainer, 1995-1996)
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600262 (formerly of Group 42, Inc)
Glenn Randers-Pehrson5dd2b8e2004-11-24 07:50:16 -0600263 Internet: gschal at infinet.com