README 13.2 KB
Newer Older
1
README for libpng version 1.4.5beta03 - October 5, 2010 (shared library 14.0)
2
See the note about version numbers near the top of png.h
A
Andreas Dilger 已提交
3

4
See INSTALL for instructions on how to install libpng.
5

6
Libpng comes in several distribution formats.  Get libpng-*.tar.gz,
7 8
libpng-*.tar.xz or libpng-*.tar.bz2 if you want UNIX-style line endings
in the text files, or lpng*.zip if you want DOS-style line endings.
9

10 11 12 13
Version 0.89 was the first official release of libpng.  Don't let the
fact that it's the first release fool you.  The libpng library has been in
extensive use and testing since mid-1995.  By late 1997 it had
finally gotten to the stage where there hadn't been significant
14
changes to the API in some time, and people have a bad feeling about
15 16
libraries with versions < 1.0.  Version 1.0.0 was released in
March 1998.
17

A
Andreas Dilger 已提交
18 19 20 21 22
****
Note that some of the changes to the png_info structure render this
version of the library binary incompatible with libpng-0.89 or
earlier versions if you are using a shared library.  The type of the
"filler" parameter for png_set_filler() has changed from png_byte to
23
png_uint_32, which will affect shared-library applications that use
A
Andreas Dilger 已提交
24 25 26 27 28 29 30 31
this function.

To avoid problems with changes to the internals of png_info_struct,
new APIs have been made available in 0.95 to avoid direct application
access to info_ptr.  These functions are the png_set_<chunk> and
png_get_<chunk> functions.  These functions should be used when
accessing/storing the info_struct data, rather than manipulating it
directly, to avoid such problems in the future.
32 33

It is important to note that the APIs do not make current programs
34
that access the info struct directly incompatible with the new
35
library.  However, it is strongly suggested that new programs use
36 37
the new APIs (as shown in example.c and pngtest.c), and older programs
be converted to the new format, to facilitate upgrades in the future.
A
Andreas Dilger 已提交
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
****

Additions since 0.90 include the ability to compile libpng as a
Windows DLL, and new APIs for accessing data in the info struct.
Experimental functions include the ability to set weighting and cost
factors for row filter selection, direct reads of integers from buffers
on big-endian processors that support misaligned data access, faster
methods of doing alpha composition, and more accurate 16->8 bit color
conversion.

The additions since 0.89 include the ability to read from a PNG stream
which has had some (or all) of the signature bytes read by the calling
application.  This also allows the reading of embedded PNG streams that
do not have the PNG file signature.  As well, it is now possible to set
the library action on the detection of chunk CRC errors.  It is possible
to set different actions based on whether the CRC error occurred in a
critical or an ancillary chunk.
A
Andreas Dilger 已提交
55 56

The changes made to the library, and bugs fixed are based on discussions
57
on the PNG-implement mailing list and not on material submitted
58 59
privately to Guy, Andreas, or Glenn.  They will forward any good
suggestions to the list.
A
Andreas Dilger 已提交
60 61

For a detailed description on using libpng, read libpng.txt.  For
A
Andreas Dilger 已提交
62 63 64 65
examples of libpng in a program, see example.c and pngtest.c.  For usage
information and restrictions (what little they are) on libpng, see
png.h.  For a description on using zlib (the compression library used by
libpng) and zlib's restrictions, see zlib.h
A
Andreas Dilger 已提交
66

A
Andreas Dilger 已提交
67 68
I have included a general makefile, as well as several machine and
compiler specific ones, but you may have to modify one for your own needs.
A
Andreas Dilger 已提交
69 70 71 72 73 74 75 76 77 78 79

You should use zlib 1.0.4 or later to run this, but it MAY work with
versions as old as zlib 0.95.  Even so, there are bugs in older zlib
versions which can cause the output of invalid compression streams for
some images.  You will definitely need zlib 1.0.4 or later if you are
taking advantage of the MS-DOS "far" structure allocation for the small
and medium memory models.  You should also note that zlib is a
compression library that is useful for more things than just PNG files.
You can use zlib as a drop-in replacement for fread() and fwrite() if
you are so inclined.

80 81
zlib should be available at the same place that libpng is, or at.
ftp://ftp.info-zip.org/pub/infozip/zlib
A
Andreas Dilger 已提交
82 83

You may also want a copy of the PNG specification.  It is available
84
as an RFC, a W3C Recommendation, and an ISO/IEC Standard.  You can find
85
these at http://www.libpng.org/pub/png/documents/
A
Andreas Dilger 已提交
86

87 88
This code is currently being archived at libpng.sf.net in the
[DOWNLOAD] area, and on CompuServe, Lib 20 (PNG SUPPORT)
A
Andreas Dilger 已提交
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
at GO GRAPHSUP.  If you can't find it in any of those places,
e-mail me, and I'll help you find it.

If you have any code changes, requests, problems, etc., please e-mail
them to me.  Also, I'd appreciate any make files or project files,
and any modifications you needed to make to get libpng to compile,
along with a #define variable to tell what compiler/system you are on.
If you needed to add transformations to libpng, or wish libpng would
provide the image in a different way, drop me a note (and code, if
possible), so I can consider supporting the transformation.
Finally, if you get any warning messages when compiling libpng
(note: not zlib), and they are easy to fix, I'd appreciate the
fix.  Please mention "libpng" somewhere in the subject line.  Thanks.

This release was created and will be supported by myself (of course
104 105
based in a large way on Guy's and Andreas' earlier work), and the PNG
development group.
A
Andreas Dilger 已提交
106

107 108
Send comments/corrections/commendations to png-mng-implement at
lists.sourceforge.net (subscription required; visit 
109 110
https://lists.sourceforge.net/lists/listinfo/png-mng-implement
to subscribe) or to glennrp at users.sourceforge.net
A
Andreas Dilger 已提交
111

112
You can't reach Guy, the original libpng author, at the addresses
113
given in previous versions of this document.  He and Andreas will
114
read mail addressed to the png-implement list, however.
A
Andreas Dilger 已提交
115 116

Please do not send general questions about PNG.  Send them to
117 118 119 120 121
the (png-list at ccrc.wustl.edu, subscription required, write to
majordomo at ccrc.wustl.edu with "subscribe png-list" in your message).
On the other hand,
please do not send libpng questions to that address, send them to me
or to the png-implement list.  I'll
A
Andreas Dilger 已提交
122 123 124 125 126 127 128
get them in the end anyway.  If you have a question about something
in the PNG specification that is related to using libpng, send it
to me.  Send me any questions that start with "I was using libpng,
and ...".  If in doubt, send questions to me.  I'll bounce them
to others, if necessary.

Please do not send suggestions on how to change PNG.  We have
129
been discussing PNG for nine years now, and it is official and
A
Andreas Dilger 已提交
130
finished.  If you have suggestions for libpng, however, I'll
131 132
gladly listen.  Even if your suggestion is not used immediately,
it may be used later.
A
Andreas Dilger 已提交
133 134 135

Files in this distribution:

136
      ANNOUNCE      =>  Announcement of this version, with recent changes
A
Andreas Dilger 已提交
137
      CHANGES       =>  Description of changes between libpng versions
138 139
      KNOWNBUG      =>  List of known bugs and deficiencies
      LICENSE       =>  License to use and redistribute libpng
A
Andreas Dilger 已提交
140 141
      README        =>  This file
      TODO          =>  Things not implemented in the current library
142
      Y2KINFO       =>  Statement of Y2K compliance
A
Andreas Dilger 已提交
143
      example.c     =>  Example code for using libpng functions
144
      libpng.3      =>  manual page for libpng (includes libpng.txt)
A
Andreas Dilger 已提交
145
      libpng.txt    =>  Description of libpng and its functions
146 147
      libpngpf.3    =>  manual page for libpng's private functions
      png.5         =>  manual page for the PNG format
A
Andreas Dilger 已提交
148 149 150 151
      png.c         =>  Basic interface functions common to library
      png.h         =>  Library function and interface declarations
      pngconf.h     =>  System specific library configuration
      pngerror.c    =>  Error/warning message I/O functions
152
      pngget.c      =>  Functions for retrieving info from struct
A
Andreas Dilger 已提交
153
      pngmem.c      =>  Memory handling functions
154 155
      pngbar.png    =>  PNG logo, 88x31
      pngnow.png    =>  PNG logo, 98x31
A
Andreas Dilger 已提交
156 157 158 159 160
      pngpread.c    =>  Progressive reading functions
      pngread.c     =>  Read data/helper high-level functions
      pngrio.c      =>  Lowest-level data read I/O functions
      pngrtran.c    =>  Read data transformation functions
      pngrutil.c    =>  Read data utility functions
A
Andreas Dilger 已提交
161
      pngset.c      =>  Functions for storing data into the info_struct
A
Andreas Dilger 已提交
162 163 164 165 166 167 168
      pngtest.c     =>  Library test program
      pngtest.png   =>  Library test sample image
      pngtrans.c    =>  Common data transformation functions
      pngwio.c      =>  Lowest-level write I/O functions
      pngwrite.c    =>  High-level write functions
      pngwtran.c    =>  Write data transformations
      pngwutil.c    =>  Write utility functions
169 170 171 172
      contrib       =>  Contributions
       gregbook         =>  source code for PNG reading and writing, from
                            Greg Roelofs' "PNG: The Definitive Guide",
                            O'Reilly, 1999
173
       msvctest     =>  Builds and runs pngtest using a MSVC workspace
174 175
       pngminus     =>  Simple pnm2png and png2pnm programs
       pngsuite     =>  Test images
176
       visupng      =>  Contains a MSVC workspace for VisualPng
177 178 179 180 181 182
      projects      =>  Contains project files and workspaces for
                        building a DLL
       c5builder        =>  Contains a Borland workspace for building
                            libpng and zlib
       visualc6         =>  Contains a Microsoft Visual C++ (MSVC)
                            workspace for building libpng and zlib
183
      scripts       =>  Directory containing scripts for building libpng:
184
       descrip.mms      =>  VMS makefile for MMS or MMK
185 186
       makefile.std     =>  Generic UNIX makefile (cc, creates static
                            libpng.a)
187
       makefile.elf     =>  Linux/ELF makefile symbol versioning,
188
                            (gcc, creates libpng14.so.14.1.4.5beta03)
189
       makefile.linux   =>  Linux/ELF makefile
190
                            (gcc, creates libpng14.so.14.1.4.5beta03)
191 192 193
       makefile.gcc     =>  Generic makefile (gcc, creates static libpng.a)
       makefile.knr     =>  Archaic UNIX Makefile that converts files with
                            ansi2knr (Requires ansi2knr.c from
194
                            ftp://ftp.cs.wisc.edu/ghost)
195
       makefile.aix     =>  AIX makefile
196
       makefile.cygwin  =>  Cygwin/gcc makefile
197
       makefile.darwin  =>  Darwin makefile
198
       makefile.dec     =>  DEC Alpha UNIX makefile
199
       makefile.freebsd =>  FreeBSD makefile
200
       makefile.hpgcc   =>  HPUX makefile using gcc
201
       makefile.hpux    =>  HPUX (10.20 and 11.00) makefile
202
       makefile.hp64    =>  HPUX (10.20 and 11.00) makefile, 64 bit
203
       makefile.ibmc    =>  IBM C/C++ version 3.x for Win32 and OS/2 (static)
204
       makefile.intel   =>  Intel C/C++ version 4.0 and later
205
       makefile.mingw   =>  Mingw/gcc makefile
206
       makefile.netbsd  =>  NetBSD/cc makefile, makes libpng.so.
207 208
       makefile.ne14bsd  =>  NetBSD/cc makefile, makes
                            libpng14.so
209
       makefile.openbsd =>  OpenBSD makefile
210
       makefile.sgi     =>  Silicon Graphics IRIX (cc, creates static lib)
211
       makefile.sggcc   =>  Silicon Graphics
212
                            (gcc, creates libpng14.so.14.1.4.5beta03)
213 214
       makefile.sunos   =>  Sun makefile
       makefile.solaris =>  Solaris 2.X makefile
215
                            (gcc, creates libpng14.so.14.1.4.5beta03)
216
       makefile.so9     =>  Solaris 9 makefile
217
                            (gcc, creates libpng14.so.14.1.4.5beta03)
218 219
       makefile.32sunu  =>  Sun Ultra 32-bit makefile
       makefile.64sunu  =>  Sun Ultra 64-bit makefile
220 221 222 223 224 225 226 227 228
       makefile.sco     =>  For SCO OSr5  ELF and Unixware 7 with Native cc
       makefile.mips    =>  MIPS makefile
       makefile.acorn   =>  Acorn makefile
       makefile.amiga   =>  Amiga makefile
       smakefile.ppc    =>  AMIGA smakefile for SAS C V6.58/7.00 PPC
                            compiler (Requires SCOPTIONS, copied from
                            scripts/SCOPTIONS.ppc)
       makefile.atari   =>  Atari makefile
       makefile.beos    =>  BEOS makefile for X86
229 230 231
       makefile.bor     =>  Borland makefile (uses bcc)
       makefile.bc32    =>  32-bit Borland C++ (all modules compiled in C mode)
       makefile.tc3     =>  Turbo C 3.0 makefile
232 233
       makefile.dj2     =>  DJGPP 2 makefile
       makefile.msc     =>  Microsoft C makefile
234 235
       makefile.vcwin32 =>  makefile for Microsoft Visual C++ 4.0 and
                            later (does not use assembler code)
236
       makefile.os2     =>  OS/2 Makefile (gcc and emx, requires pngos2.def)
237 238 239 240 241
       png32ce.def      =>  module definition for makefile.cegccg
       pngos2.def       =>  OS/2 module definition file used by
                            makefile.os2
       pngwin.def       =>  module definition file used by
                            makefile.cygwin and makefile.mingw
242 243 244
       makefile.watcom  =>  Watcom 10a+ Makefile, 32-bit flat memory model
       makevms.com      =>  VMS build script
       SCOPTIONS.ppc    =>  Used with smakefile.ppc
A
Andreas Dilger 已提交
245 246 247

Good luck, and happy coding.

248
-Glenn Randers-Pehrson (current maintainer, since 1998)
249
 Internet: glennrp at users.sourceforge.net
250

251
-Andreas Eric Dilger (former maintainer, 1996-1997)
252
 Internet: adilger at enel.ucalgary.ca
253
 Web: http://www-mddsp.enel.ucalgary.ca/People/adilger/
A
Andreas Dilger 已提交
254

255
-Guy Eric Schalnat (original author and former maintainer, 1995-1996)
256
 (formerly of Group 42, Inc)
257
 Internet: gschal at infinet.com