src/3rdparty/libpng/libpng-1.4.0.txt
changeset 30 5dc02b23752f
equal deleted inserted replaced
29:b72c6db6890b 30:5dc02b23752f
       
     1 libpng.txt - A description on how to use and modify libpng
       
     2 
       
     3  libpng version 1.4.0 - January 3, 2010
       
     4  Updated and distributed by Glenn Randers-Pehrson
       
     5  <glennrp at users.sourceforge.net>
       
     6  Copyright (c) 1998-2009 Glenn Randers-Pehrson
       
     7 
       
     8  This document is released under the libpng license.
       
     9  For conditions of distribution and use, see the disclaimer
       
    10  and license in png.h
       
    11 
       
    12  Based on:
       
    13 
       
    14  libpng versions 0.97, January 1998, through 1.4.0 - January 3, 2010
       
    15  Updated and distributed by Glenn Randers-Pehrson
       
    16  Copyright (c) 1998-2009 Glenn Randers-Pehrson
       
    17 
       
    18  libpng 1.0 beta 6  version 0.96 May 28, 1997
       
    19  Updated and distributed by Andreas Dilger
       
    20  Copyright (c) 1996, 1997 Andreas Dilger
       
    21 
       
    22  libpng 1.0 beta 2 - version 0.88  January 26, 1996
       
    23  For conditions of distribution and use, see copyright
       
    24  notice in png.h. Copyright (c) 1995, 1996 Guy Eric
       
    25  Schalnat, Group 42, Inc.
       
    26 
       
    27  Updated/rewritten per request in the libpng FAQ
       
    28  Copyright (c) 1995, 1996 Frank J. T. Wojcik
       
    29  December 18, 1995 & January 20, 1996
       
    30 
       
    31 I. Introduction
       
    32 
       
    33 This file describes how to use and modify the PNG reference library
       
    34 (known as libpng) for your own use.  There are five sections to this
       
    35 file: introduction, structures, reading, writing, and modification and
       
    36 configuration notes for various special platforms.  In addition to this
       
    37 file, example.c is a good starting point for using the library, as
       
    38 it is heavily commented and should include everything most people
       
    39 will need.  We assume that libpng is already installed; see the
       
    40 INSTALL file for instructions on how to install libpng.
       
    41 
       
    42 For examples of libpng usage, see the files "example.c", "pngtest.c",
       
    43 and the files in the "contrib" directory, all of which are included in
       
    44 the libpng distribution.
       
    45 
       
    46 Libpng was written as a companion to the PNG specification, as a way
       
    47 of reducing the amount of time and effort it takes to support the PNG
       
    48 file format in application programs.
       
    49 
       
    50 The PNG specification (second edition), November 2003, is available as
       
    51 a W3C Recommendation and as an ISO Standard (ISO/IEC 15948:2003 (E)) at
       
    52 <http://www.w3.org/TR/2003/REC-PNG-20031110/
       
    53 The W3C and ISO documents have identical technical content.
       
    54 
       
    55 The PNG-1.2 specification is available at
       
    56 <http://www.libpng.org/pub/png/documents/>.  It is technically equivalent
       
    57 to the PNG specification (second edition) but has some additional material.
       
    58 
       
    59 The PNG-1.0 specification is available
       
    60 as RFC 2083 <http://www.libpng.org/pub/png/documents/> and as a
       
    61 W3C Recommendation <http://www.w3.org/TR/REC.png.html>.
       
    62 
       
    63 Some additional chunks are described in the special-purpose public chunks
       
    64 documents at <http://www.libpng.org/pub/png/documents/>.
       
    65 
       
    66 Other information
       
    67 about PNG, and the latest version of libpng, can be found at the PNG home
       
    68 page, <http://www.libpng.org/pub/png/>.
       
    69 
       
    70 Most users will not have to modify the library significantly; advanced
       
    71 users may want to modify it more.  All attempts were made to make it as
       
    72 complete as possible, while keeping the code easy to understand.
       
    73 Currently, this library only supports C.  Support for other languages
       
    74 is being considered.
       
    75 
       
    76 Libpng has been designed to handle multiple sessions at one time,
       
    77 to be easily modifiable, to be portable to the vast majority of
       
    78 machines (ANSI, K&R, 16-, 32-, and 64-bit) available, and to be easy
       
    79 to use.  The ultimate goal of libpng is to promote the acceptance of
       
    80 the PNG file format in whatever way possible.  While there is still
       
    81 work to be done (see the TODO file), libpng should cover the
       
    82 majority of the needs of its users.
       
    83 
       
    84 Libpng uses zlib for its compression and decompression of PNG files.
       
    85 Further information about zlib, and the latest version of zlib, can
       
    86 be found at the zlib home page, <http://www.info-zip.org/pub/infozip/zlib/>.
       
    87 The zlib compression utility is a general purpose utility that is
       
    88 useful for more than PNG files, and can be used without libpng.
       
    89 See the documentation delivered with zlib for more details.
       
    90 You can usually find the source files for the zlib utility wherever you
       
    91 find the libpng source files.
       
    92 
       
    93 Libpng is thread safe, provided the threads are using different
       
    94 instances of the structures.  Each thread should have its own
       
    95 png_struct and png_info instances, and thus its own image.
       
    96 Libpng does not protect itself against two threads using the
       
    97 same instance of a structure.
       
    98 
       
    99 II. Structures
       
   100 
       
   101 There are two main structures that are important to libpng, png_struct
       
   102 and png_info.  The first, png_struct, is an internal structure that
       
   103 will not, for the most part, be used by a user except as the first
       
   104 variable passed to every libpng function call.
       
   105 
       
   106 The png_info structure is designed to provide information about the
       
   107 PNG file.  At one time, the fields of png_info were intended to be
       
   108 directly accessible to the user.  However, this tended to cause problems
       
   109 with applications using dynamically loaded libraries, and as a result
       
   110 a set of interface functions for png_info (the png_get_*() and png_set_*()
       
   111 functions) was developed.  The fields of png_info are still available for
       
   112 older applications, but it is suggested that applications use the new
       
   113 interfaces if at all possible.
       
   114 
       
   115 Applications that do make direct access to the members of png_struct (except
       
   116 for png_ptr->jmpbuf) must be recompiled whenever the library is updated,
       
   117 and applications that make direct access to the members of png_info must
       
   118 be recompiled if they were compiled or loaded with libpng version 1.0.6,
       
   119 in which the members were in a different order.  In version 1.0.7, the
       
   120 members of the png_info structure reverted to the old order, as they were
       
   121 in versions 0.97c through 1.0.5.  Starting with version 2.0.0, both
       
   122 structures are going to be hidden, and the contents of the structures will
       
   123 only be accessible through the png_get/png_set functions.
       
   124 
       
   125 The png.h header file is an invaluable reference for programming with libpng.
       
   126 And while I'm on the topic, make sure you include the libpng header file:
       
   127 
       
   128 #include <png.h>
       
   129 
       
   130 III. Reading
       
   131 
       
   132 We'll now walk you through the possible functions to call when reading
       
   133 in a PNG file sequentially, briefly explaining the syntax and purpose
       
   134 of each one.  See example.c and png.h for more detail.  While
       
   135 progressive reading is covered in the next section, you will still
       
   136 need some of the functions discussed in this section to read a PNG
       
   137 file.
       
   138 
       
   139 Setup
       
   140 
       
   141 You will want to do the I/O initialization(*) before you get into libpng,
       
   142 so if it doesn't work, you don't have much to undo.  Of course, you
       
   143 will also want to insure that you are, in fact, dealing with a PNG
       
   144 file.  Libpng provides a simple check to see if a file is a PNG file.
       
   145 To use it, pass in the first 1 to 8 bytes of the file to the function
       
   146 png_sig_cmp(), and it will return 0 (false) if the bytes match the
       
   147 corresponding bytes of the PNG signature, or nonzero (true) otherwise.
       
   148 Of course, the more bytes you pass in, the greater the accuracy of the
       
   149 prediction.
       
   150 
       
   151 If you are intending to keep the file pointer open for use in libpng,
       
   152 you must ensure you don't read more than 8 bytes from the beginning
       
   153 of the file, and you also have to make a call to png_set_sig_bytes_read()
       
   154 with the number of bytes you read from the beginning.  Libpng will
       
   155 then only check the bytes (if any) that your program didn't read.
       
   156 
       
   157 (*): If you are not using the standard I/O functions, you will need
       
   158 to replace them with custom functions.  See the discussion under
       
   159 Customizing libpng.
       
   160 
       
   161 
       
   162     FILE *fp = fopen(file_name, "rb");
       
   163     if (!fp)
       
   164     {
       
   165         return (ERROR);
       
   166     }
       
   167     fread(header, 1, number, fp);
       
   168     is_png = !png_sig_cmp(header, 0, number);
       
   169     if (!is_png)
       
   170     {
       
   171         return (NOT_PNG);
       
   172     }
       
   173 
       
   174 
       
   175 Next, png_struct and png_info need to be allocated and initialized.  In
       
   176 order to ensure that the size of these structures is correct even with a
       
   177 dynamically linked libpng, there are functions to initialize and
       
   178 allocate the structures.  We also pass the library version, optional
       
   179 pointers to error handling functions, and a pointer to a data struct for
       
   180 use by the error functions, if necessary (the pointer and functions can
       
   181 be NULL if the default error handlers are to be used).  See the section
       
   182 on Changes to Libpng below regarding the old initialization functions.
       
   183 The structure allocation functions quietly return NULL if they fail to
       
   184 create the structure, so your application should check for that.
       
   185 
       
   186     png_structp png_ptr = png_create_read_struct
       
   187        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
       
   188         user_error_fn, user_warning_fn);
       
   189     if (!png_ptr)
       
   190         return (ERROR);
       
   191 
       
   192     png_infop info_ptr = png_create_info_struct(png_ptr);
       
   193     if (!info_ptr)
       
   194     {
       
   195         png_destroy_read_struct(&png_ptr,
       
   196            (png_infopp)NULL, (png_infopp)NULL);
       
   197         return (ERROR);
       
   198     }
       
   199 
       
   200     png_infop end_info = png_create_info_struct(png_ptr);
       
   201     if (!end_info)
       
   202     {
       
   203         png_destroy_read_struct(&png_ptr, &info_ptr,
       
   204           (png_infopp)NULL);
       
   205         return (ERROR);
       
   206     }
       
   207 
       
   208 If you want to use your own memory allocation routines,
       
   209 define PNG_USER_MEM_SUPPORTED and use
       
   210 png_create_read_struct_2() instead of png_create_read_struct():
       
   211 
       
   212     png_structp png_ptr = png_create_read_struct_2
       
   213        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
       
   214         user_error_fn, user_warning_fn, (png_voidp)
       
   215         user_mem_ptr, user_malloc_fn, user_free_fn);
       
   216 
       
   217 The error handling routines passed to png_create_read_struct()
       
   218 and the memory alloc/free routines passed to png_create_struct_2()
       
   219 are only necessary if you are not using the libpng supplied error
       
   220 handling and memory alloc/free functions.
       
   221 
       
   222 When libpng encounters an error, it expects to longjmp back
       
   223 to your routine.  Therefore, you will need to call setjmp and pass
       
   224 your png_jmpbuf(png_ptr).  If you read the file from different
       
   225 routines, you will need to update the jmpbuf field every time you enter
       
   226 a new routine that will call a png_*() function.
       
   227 
       
   228 See your documentation of setjmp/longjmp for your compiler for more
       
   229 information on setjmp/longjmp.  See the discussion on libpng error
       
   230 handling in the Customizing Libpng section below for more information
       
   231 on the libpng error handling.  If an error occurs, and libpng longjmp's
       
   232 back to your setjmp, you will want to call png_destroy_read_struct() to
       
   233 free any memory.
       
   234 
       
   235     if (setjmp(png_jmpbuf(png_ptr)))
       
   236     {
       
   237         png_destroy_read_struct(&png_ptr, &info_ptr,
       
   238            &end_info);
       
   239         fclose(fp);
       
   240         return (ERROR);
       
   241     }
       
   242 
       
   243 If you would rather avoid the complexity of setjmp/longjmp issues,
       
   244 you can compile libpng with PNG_SETJMP_NOT_SUPPORTED, in which case
       
   245 errors will result in a call to PNG_ABORT() which defaults to abort().
       
   246 
       
   247 Now you need to set up the input code.  The default for libpng is to
       
   248 use the C function fread().  If you use this, you will need to pass a
       
   249 valid FILE * in the function png_init_io().  Be sure that the file is
       
   250 opened in binary mode.  If you wish to handle reading data in another
       
   251 way, you need not call the png_init_io() function, but you must then
       
   252 implement the libpng I/O methods discussed in the Customizing Libpng
       
   253 section below.
       
   254 
       
   255     png_init_io(png_ptr, fp);
       
   256 
       
   257 If you had previously opened the file and read any of the signature from
       
   258 the beginning in order to see if this was a PNG file, you need to let
       
   259 libpng know that there are some bytes missing from the start of the file.
       
   260 
       
   261     png_set_sig_bytes(png_ptr, number);
       
   262 
       
   263 Setting up callback code
       
   264 
       
   265 You can set up a callback function to handle any unknown chunks in the
       
   266 input stream. You must supply the function
       
   267 
       
   268     read_chunk_callback(png_ptr ptr,
       
   269          png_unknown_chunkp chunk);
       
   270     {
       
   271        /* The unknown chunk structure contains your
       
   272           chunk data, along with similar data for any other
       
   273           unknown chunks: */
       
   274 
       
   275            png_byte name[5];
       
   276            png_byte *data;
       
   277            png_size_t size;
       
   278 
       
   279        /* Note that libpng has already taken care of
       
   280           the CRC handling */
       
   281 
       
   282        /* put your code here.  Search for your chunk in the
       
   283           unknown chunk structure, process it, and return one
       
   284           of the following: */
       
   285 
       
   286        return (-n); /* chunk had an error */
       
   287        return (0); /* did not recognize */
       
   288        return (n); /* success */
       
   289     }
       
   290 
       
   291 (You can give your function another name that you like instead of
       
   292 "read_chunk_callback")
       
   293 
       
   294 To inform libpng about your function, use
       
   295 
       
   296     png_set_read_user_chunk_fn(png_ptr, user_chunk_ptr,
       
   297         read_chunk_callback);
       
   298 
       
   299 This names not only the callback function, but also a user pointer that
       
   300 you can retrieve with
       
   301 
       
   302     png_get_user_chunk_ptr(png_ptr);
       
   303 
       
   304 If you call the png_set_read_user_chunk_fn() function, then all unknown
       
   305 chunks will be saved when read, in case your callback function will need
       
   306 one or more of them.  This behavior can be changed with the
       
   307 png_set_keep_unknown_chunks() function, described below.
       
   308 
       
   309 At this point, you can set up a callback function that will be
       
   310 called after each row has been read, which you can use to control
       
   311 a progress meter or the like.  It's demonstrated in pngtest.c.
       
   312 You must supply a function
       
   313 
       
   314     void read_row_callback(png_ptr ptr, png_uint_32 row,
       
   315        int pass);
       
   316     {
       
   317       /* put your code here */
       
   318     }
       
   319 
       
   320 (You can give it another name that you like instead of "read_row_callback")
       
   321 
       
   322 To inform libpng about your function, use
       
   323 
       
   324     png_set_read_status_fn(png_ptr, read_row_callback);
       
   325 
       
   326 Unknown-chunk handling
       
   327 
       
   328 Now you get to set the way the library processes unknown chunks in the
       
   329 input PNG stream. Both known and unknown chunks will be read.  Normal
       
   330 behavior is that known chunks will be parsed into information in
       
   331 various info_ptr members while unknown chunks will be discarded. This
       
   332 behavior can be wasteful if your application will never use some known
       
   333 chunk types. To change this, you can call:
       
   334 
       
   335     png_set_keep_unknown_chunks(png_ptr, keep,
       
   336         chunk_list, num_chunks);
       
   337     keep       - 0: default unknown chunk handling
       
   338                  1: ignore; do not keep
       
   339                  2: keep only if safe-to-copy
       
   340                  3: keep even if unsafe-to-copy
       
   341                You can use these definitions:
       
   342                  PNG_HANDLE_CHUNK_AS_DEFAULT   0
       
   343                  PNG_HANDLE_CHUNK_NEVER        1
       
   344                  PNG_HANDLE_CHUNK_IF_SAFE      2
       
   345                  PNG_HANDLE_CHUNK_ALWAYS       3
       
   346     chunk_list - list of chunks affected (a byte string,
       
   347                  five bytes per chunk, NULL or '\0' if
       
   348                  num_chunks is 0)
       
   349     num_chunks - number of chunks affected; if 0, all
       
   350                  unknown chunks are affected.  If nonzero,
       
   351                  only the chunks in the list are affected
       
   352 
       
   353 Unknown chunks declared in this way will be saved as raw data onto a
       
   354 list of png_unknown_chunk structures.  If a chunk that is normally
       
   355 known to libpng is named in the list, it will be handled as unknown,
       
   356 according to the "keep" directive.  If a chunk is named in successive
       
   357 instances of png_set_keep_unknown_chunks(), the final instance will
       
   358 take precedence.  The IHDR and IEND chunks should not be named in
       
   359 chunk_list; if they are, libpng will process them normally anyway.
       
   360 
       
   361 Here is an example of the usage of png_set_keep_unknown_chunks(),
       
   362 where the private "vpAg" chunk will later be processed by a user chunk
       
   363 callback function:
       
   364 
       
   365     png_byte vpAg[5]={118, 112,  65, 103, (png_byte) '\0'};
       
   366 
       
   367     #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
       
   368       png_byte unused_chunks[]=
       
   369       {
       
   370         104,  73,  83,  84, (png_byte) '\0',   /* hIST */
       
   371         105,  84,  88, 116, (png_byte) '\0',   /* iTXt */
       
   372         112,  67,  65,  76, (png_byte) '\0',   /* pCAL */
       
   373         115,  67,  65,  76, (png_byte) '\0',   /* sCAL */
       
   374         115,  80,  76,  84, (png_byte) '\0',   /* sPLT */
       
   375         116,  73,  77,  69, (png_byte) '\0',   /* tIME */
       
   376       };
       
   377     #endif
       
   378 
       
   379     ...
       
   380 
       
   381     #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
       
   382       /* ignore all unknown chunks: */
       
   383       png_set_keep_unknown_chunks(read_ptr, 1, NULL, 0);
       
   384       /* except for vpAg: */
       
   385       png_set_keep_unknown_chunks(read_ptr, 2, vpAg, 1);
       
   386       /* also ignore unused known chunks: */
       
   387       png_set_keep_unknown_chunks(read_ptr, 1, unused_chunks,
       
   388          (int)sizeof(unused_chunks)/5);
       
   389     #endif
       
   390 
       
   391 User limits
       
   392 
       
   393 The PNG specification allows the width and height of an image to be as
       
   394 large as 2^31-1 (0x7fffffff), or about 2.147 billion rows and columns.
       
   395 Since very few applications really need to process such large images,
       
   396 we have imposed an arbitrary 1-million limit on rows and columns.
       
   397 Larger images will be rejected immediately with a png_error() call. If
       
   398 you wish to override this limit, you can use
       
   399 
       
   400    png_set_user_limits(png_ptr, width_max, height_max);
       
   401 
       
   402 to set your own limits, or use width_max = height_max = 0x7fffffffL
       
   403 to allow all valid dimensions (libpng may reject some very large images
       
   404 anyway because of potential buffer overflow conditions).
       
   405 
       
   406 You should put this statement after you create the PNG structure and
       
   407 before calling png_read_info(), png_read_png(), or png_process_data().
       
   408 If you need to retrieve the limits that are being applied, use
       
   409 
       
   410    width_max = png_get_user_width_max(png_ptr);
       
   411    height_max = png_get_user_height_max(png_ptr);
       
   412 
       
   413 The PNG specification sets no limit on the number of ancillary chunks
       
   414 allowed in a PNG datastream.  You can impose a limit on the total number
       
   415 of sPLT, tEXt, iTXt, zTXt, and unknown chunks that will be stored, with
       
   416 
       
   417    png_set_chunk_cache_max(png_ptr, user_chunk_cache_max);
       
   418 
       
   419 where 0x7fffffffL means unlimited.  You can retrieve this limit with
       
   420 
       
   421    chunk_cache_max = png_get_chunk_cache_max(png_ptr);
       
   422 
       
   423 This limit also applies to the number of buffers that can be allocated
       
   424 by png_decompress_chunk() while decompressing iTXt, zTXt, and iCCP chunks.
       
   425 
       
   426 The high-level read interface
       
   427 
       
   428 At this point there are two ways to proceed; through the high-level
       
   429 read interface, or through a sequence of low-level read operations.
       
   430 You can use the high-level interface if (a) you are willing to read
       
   431 the entire image into memory, and (b) the input transformations
       
   432 you want to do are limited to the following set:
       
   433 
       
   434     PNG_TRANSFORM_IDENTITY      No transformation
       
   435     PNG_TRANSFORM_STRIP_16      Strip 16-bit samples to
       
   436                                 8 bits
       
   437     PNG_TRANSFORM_STRIP_ALPHA   Discard the alpha channel
       
   438     PNG_TRANSFORM_PACKING       Expand 1, 2 and 4-bit
       
   439                                 samples to bytes
       
   440     PNG_TRANSFORM_PACKSWAP      Change order of packed
       
   441                                 pixels to LSB first
       
   442     PNG_TRANSFORM_EXPAND        Perform set_expand()
       
   443     PNG_TRANSFORM_INVERT_MONO   Invert monochrome images
       
   444     PNG_TRANSFORM_SHIFT         Normalize pixels to the
       
   445                                 sBIT depth
       
   446     PNG_TRANSFORM_BGR           Flip RGB to BGR, RGBA
       
   447                                 to BGRA
       
   448     PNG_TRANSFORM_SWAP_ALPHA    Flip RGBA to ARGB or GA
       
   449                                 to AG
       
   450     PNG_TRANSFORM_INVERT_ALPHA  Change alpha from opacity
       
   451                                 to transparency
       
   452     PNG_TRANSFORM_SWAP_ENDIAN   Byte-swap 16-bit samples
       
   453     PNG_TRANSFORM_GRAY_TO_RGB   Expand grayscale samples
       
   454                                 to RGB (or GA to RGBA)
       
   455 
       
   456 (This excludes setting a background color, doing gamma transformation,
       
   457 dithering, and setting filler.)  If this is the case, simply do this:
       
   458 
       
   459     png_read_png(png_ptr, info_ptr, png_transforms, NULL)
       
   460 
       
   461 where png_transforms is an integer containing the bitwise OR of some
       
   462 set of transformation flags.  This call is equivalent to png_read_info(),
       
   463 followed the set of transformations indicated by the transform mask,
       
   464 then png_read_image(), and finally png_read_end().
       
   465 
       
   466 (The final parameter of this call is not yet used.  Someday it might point
       
   467 to transformation parameters required by some future input transform.)
       
   468 
       
   469 You must use png_transforms and not call any png_set_transform() functions
       
   470 when you use png_read_png().
       
   471 
       
   472 After you have called png_read_png(), you can retrieve the image data
       
   473 with
       
   474 
       
   475    row_pointers = png_get_rows(png_ptr, info_ptr);
       
   476 
       
   477 where row_pointers is an array of pointers to the pixel data for each row:
       
   478 
       
   479    png_bytep row_pointers[height];
       
   480 
       
   481 If you know your image size and pixel size ahead of time, you can allocate
       
   482 row_pointers prior to calling png_read_png() with
       
   483 
       
   484    if (height > PNG_UINT_32_MAX/png_sizeof(png_byte))
       
   485       png_error (png_ptr,
       
   486          "Image is too tall to process in memory");
       
   487    if (width > PNG_UINT_32_MAX/pixel_size)
       
   488       png_error (png_ptr,
       
   489          "Image is too wide to process in memory");
       
   490    row_pointers = png_malloc(png_ptr,
       
   491       height*png_sizeof(png_bytep));
       
   492    for (int i=0; i<height, i++)
       
   493       row_pointers[i]=NULL;  /* security precaution */
       
   494    for (int i=0; i<height, i++)
       
   495       row_pointers[i]=png_malloc(png_ptr,
       
   496          width*pixel_size);
       
   497    png_set_rows(png_ptr, info_ptr, &row_pointers);
       
   498 
       
   499 Alternatively you could allocate your image in one big block and define
       
   500 row_pointers[i] to point into the proper places in your block.
       
   501 
       
   502 If you use png_set_rows(), the application is responsible for freeing
       
   503 row_pointers (and row_pointers[i], if they were separately allocated).
       
   504 
       
   505 If you don't allocate row_pointers ahead of time, png_read_png() will
       
   506 do it, and it'll be free'ed when you call png_destroy_*().
       
   507 
       
   508 The low-level read interface
       
   509 
       
   510 If you are going the low-level route, you are now ready to read all
       
   511 the file information up to the actual image data.  You do this with a
       
   512 call to png_read_info().
       
   513 
       
   514     png_read_info(png_ptr, info_ptr);
       
   515 
       
   516 This will process all chunks up to but not including the image data.
       
   517 
       
   518 Querying the info structure
       
   519 
       
   520 Functions are used to get the information from the info_ptr once it
       
   521 has been read.  Note that these fields may not be completely filled
       
   522 in until png_read_end() has read the chunk data following the image.
       
   523 
       
   524     png_get_IHDR(png_ptr, info_ptr, &width, &height,
       
   525        &bit_depth, &color_type, &interlace_type,
       
   526        &compression_type, &filter_method);
       
   527 
       
   528     width          - holds the width of the image
       
   529                      in pixels (up to 2^31).
       
   530     height         - holds the height of the image
       
   531                      in pixels (up to 2^31).
       
   532     bit_depth      - holds the bit depth of one of the
       
   533                      image channels.  (valid values are
       
   534                      1, 2, 4, 8, 16 and depend also on
       
   535                      the color_type.  See also
       
   536                      significant bits (sBIT) below).
       
   537     color_type     - describes which color/alpha channels
       
   538                          are present.
       
   539                      PNG_COLOR_TYPE_GRAY
       
   540                         (bit depths 1, 2, 4, 8, 16)
       
   541                      PNG_COLOR_TYPE_GRAY_ALPHA
       
   542                         (bit depths 8, 16)
       
   543                      PNG_COLOR_TYPE_PALETTE
       
   544                         (bit depths 1, 2, 4, 8)
       
   545                      PNG_COLOR_TYPE_RGB
       
   546                         (bit_depths 8, 16)
       
   547                      PNG_COLOR_TYPE_RGB_ALPHA
       
   548                         (bit_depths 8, 16)
       
   549 
       
   550                      PNG_COLOR_MASK_PALETTE
       
   551                      PNG_COLOR_MASK_COLOR
       
   552                      PNG_COLOR_MASK_ALPHA
       
   553 
       
   554     filter_method  - (must be PNG_FILTER_TYPE_BASE
       
   555                      for PNG 1.0, and can also be
       
   556                      PNG_INTRAPIXEL_DIFFERENCING if
       
   557                      the PNG datastream is embedded in
       
   558                      a MNG-1.0 datastream)
       
   559     compression_type - (must be PNG_COMPRESSION_TYPE_BASE
       
   560                      for PNG 1.0)
       
   561     interlace_type - (PNG_INTERLACE_NONE or
       
   562                      PNG_INTERLACE_ADAM7)
       
   563 
       
   564     Any or all of interlace_type, compression_type, or
       
   565     filter_method can be NULL if you are
       
   566     not interested in their values.
       
   567 
       
   568     Note that png_get_IHDR() returns 32-bit data into
       
   569     the application's width and height variables.
       
   570     This is an unsafe situation if these are 16-bit
       
   571     variables.  In such situations, the
       
   572     png_get_image_width() and png_get_image_height()
       
   573     functions described below are safer.
       
   574 
       
   575     width            = png_get_image_width(png_ptr,
       
   576                          info_ptr);
       
   577     height           = png_get_image_height(png_ptr,
       
   578                          info_ptr);
       
   579     bit_depth        = png_get_bit_depth(png_ptr,
       
   580                          info_ptr);
       
   581     color_type       = png_get_color_type(png_ptr,
       
   582                          info_ptr);
       
   583     filter_method    = png_get_filter_type(png_ptr,
       
   584                          info_ptr);
       
   585     compression_type = png_get_compression_type(png_ptr,
       
   586                          info_ptr);
       
   587     interlace_type   = png_get_interlace_type(png_ptr,
       
   588                          info_ptr);
       
   589 
       
   590     channels = png_get_channels(png_ptr, info_ptr);
       
   591     channels       - number of channels of info for the
       
   592                      color type (valid values are 1 (GRAY,
       
   593                      PALETTE), 2 (GRAY_ALPHA), 3 (RGB),
       
   594                      4 (RGB_ALPHA or RGB + filler byte))
       
   595     rowbytes = png_get_rowbytes(png_ptr, info_ptr);
       
   596     rowbytes       - number of bytes needed to hold a row
       
   597 
       
   598     signature = png_get_signature(png_ptr, info_ptr);
       
   599     signature      - holds the signature read from the
       
   600                      file (if any).  The data is kept in
       
   601                      the same offset it would be if the
       
   602                      whole signature were read (i.e. if an
       
   603                      application had already read in 4
       
   604                      bytes of signature before starting
       
   605                      libpng, the remaining 4 bytes would
       
   606                      be in signature[4] through signature[7]
       
   607                      (see png_set_sig_bytes())).
       
   608 
       
   609 These are also important, but their validity depends on whether the chunk
       
   610 has been read.  The png_get_valid(png_ptr, info_ptr, PNG_INFO_<chunk>) and
       
   611 png_get_<chunk>(png_ptr, info_ptr, ...) functions return non-zero if the
       
   612 data has been read, or zero if it is missing.  The parameters to the
       
   613 png_get_<chunk> are set directly if they are simple data types, or a
       
   614 pointer into the info_ptr is returned for any complex types.
       
   615 
       
   616     png_get_PLTE(png_ptr, info_ptr, &palette,
       
   617                      &num_palette);
       
   618     palette        - the palette for the file
       
   619                      (array of png_color)
       
   620     num_palette    - number of entries in the palette
       
   621 
       
   622     png_get_gAMA(png_ptr, info_ptr, &gamma);
       
   623     gamma          - the gamma the file is written
       
   624                      at (PNG_INFO_gAMA)
       
   625 
       
   626     png_get_sRGB(png_ptr, info_ptr, &srgb_intent);
       
   627     srgb_intent    - the rendering intent (PNG_INFO_sRGB)
       
   628                      The presence of the sRGB chunk
       
   629                      means that the pixel data is in the
       
   630                      sRGB color space.  This chunk also
       
   631                      implies specific values of gAMA and
       
   632                      cHRM.
       
   633 
       
   634     png_get_iCCP(png_ptr, info_ptr, &name,
       
   635        &compression_type, &profile, &proflen);
       
   636     name            - The profile name.
       
   637     compression     - The compression type; always
       
   638                       PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
       
   639                       You may give NULL to this argument to
       
   640                       ignore it.
       
   641     profile         - International Color Consortium color
       
   642                       profile data. May contain NULs.
       
   643     proflen         - length of profile data in bytes.
       
   644 
       
   645     png_get_sBIT(png_ptr, info_ptr, &sig_bit);
       
   646     sig_bit        - the number of significant bits for
       
   647                      (PNG_INFO_sBIT) each of the gray,
       
   648                      red, green, and blue channels,
       
   649                      whichever are appropriate for the
       
   650                      given color type (png_color_16)
       
   651 
       
   652     png_get_tRNS(png_ptr, info_ptr, &trans_alpha,
       
   653                      &num_trans, &trans_color);
       
   654     trans_alpha    - array of alpha (transparency)
       
   655                      entries for palette (PNG_INFO_tRNS)
       
   656     trans_color    - graylevel or color sample values of
       
   657                      the single transparent color for
       
   658                      non-paletted images (PNG_INFO_tRNS)
       
   659     num_trans      - number of transparent entries
       
   660                      (PNG_INFO_tRNS)
       
   661 
       
   662     png_get_hIST(png_ptr, info_ptr, &hist);
       
   663                      (PNG_INFO_hIST)
       
   664     hist           - histogram of palette (array of
       
   665                      png_uint_16)
       
   666 
       
   667     png_get_tIME(png_ptr, info_ptr, &mod_time);
       
   668     mod_time       - time image was last modified
       
   669                     (PNG_VALID_tIME)
       
   670 
       
   671     png_get_bKGD(png_ptr, info_ptr, &background);
       
   672     background     - background color (PNG_VALID_bKGD)
       
   673                      valid 16-bit red, green and blue
       
   674                      values, regardless of color_type
       
   675 
       
   676     num_comments   = png_get_text(png_ptr, info_ptr,
       
   677                      &text_ptr, &num_text);
       
   678     num_comments   - number of comments
       
   679     text_ptr       - array of png_text holding image
       
   680                      comments
       
   681     text_ptr[i].compression - type of compression used
       
   682                  on "text" PNG_TEXT_COMPRESSION_NONE
       
   683                            PNG_TEXT_COMPRESSION_zTXt
       
   684                            PNG_ITXT_COMPRESSION_NONE
       
   685                            PNG_ITXT_COMPRESSION_zTXt
       
   686     text_ptr[i].key   - keyword for comment.  Must contain
       
   687                          1-79 characters.
       
   688     text_ptr[i].text  - text comments for current
       
   689                          keyword.  Can be empty.
       
   690     text_ptr[i].text_length - length of text string,
       
   691                  after decompression, 0 for iTXt
       
   692     text_ptr[i].itxt_length - length of itxt string,
       
   693                  after decompression, 0 for tEXt/zTXt
       
   694     text_ptr[i].lang  - language of comment (empty
       
   695                          string for unknown).
       
   696     text_ptr[i].lang_key  - keyword in UTF-8
       
   697                          (empty string for unknown).
       
   698     Note that the itxt_length, lang, and lang_key
       
   699     members of the text_ptr structure only exist
       
   700     when the library is built with iTXt chunk support.
       
   701 
       
   702     num_text       - number of comments (same as
       
   703                      num_comments; you can put NULL here
       
   704                      to avoid the duplication)
       
   705     Note while png_set_text() will accept text, language,
       
   706     and translated keywords that can be NULL pointers, the
       
   707     structure returned by png_get_text will always contain
       
   708     regular zero-terminated C strings.  They might be
       
   709     empty strings but they will never be NULL pointers.
       
   710 
       
   711     num_spalettes = png_get_sPLT(png_ptr, info_ptr,
       
   712        &palette_ptr);
       
   713     palette_ptr    - array of palette structures holding
       
   714                      contents of one or more sPLT chunks
       
   715                      read.
       
   716     num_spalettes  - number of sPLT chunks read.
       
   717 
       
   718     png_get_oFFs(png_ptr, info_ptr, &offset_x, &offset_y,
       
   719        &unit_type);
       
   720     offset_x       - positive offset from the left edge
       
   721                      of the screen
       
   722     offset_y       - positive offset from the top edge
       
   723                      of the screen
       
   724     unit_type      - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
       
   725 
       
   726     png_get_pHYs(png_ptr, info_ptr, &res_x, &res_y,
       
   727        &unit_type);
       
   728     res_x          - pixels/unit physical resolution in
       
   729                      x direction
       
   730     res_y          - pixels/unit physical resolution in
       
   731                      x direction
       
   732     unit_type      - PNG_RESOLUTION_UNKNOWN,
       
   733                      PNG_RESOLUTION_METER
       
   734 
       
   735     png_get_sCAL(png_ptr, info_ptr, &unit, &width,
       
   736        &height)
       
   737     unit        - physical scale units (an integer)
       
   738     width       - width of a pixel in physical scale units
       
   739     height      - height of a pixel in physical scale units
       
   740                  (width and height are doubles)
       
   741 
       
   742     png_get_sCAL_s(png_ptr, info_ptr, &unit, &width,
       
   743        &height)
       
   744     unit        - physical scale units (an integer)
       
   745     width       - width of a pixel in physical scale units
       
   746     height      - height of a pixel in physical scale units
       
   747                  (width and height are strings like "2.54")
       
   748 
       
   749     num_unknown_chunks = png_get_unknown_chunks(png_ptr,
       
   750        info_ptr, &unknowns)
       
   751     unknowns          - array of png_unknown_chunk
       
   752                         structures holding unknown chunks
       
   753     unknowns[i].name  - name of unknown chunk
       
   754     unknowns[i].data  - data of unknown chunk
       
   755     unknowns[i].size  - size of unknown chunk's data
       
   756     unknowns[i].location - position of chunk in file
       
   757 
       
   758     The value of "i" corresponds to the order in which the
       
   759     chunks were read from the PNG file or inserted with the
       
   760     png_set_unknown_chunks() function.
       
   761 
       
   762 The data from the pHYs chunk can be retrieved in several convenient
       
   763 forms:
       
   764 
       
   765     res_x = png_get_x_pixels_per_meter(png_ptr,
       
   766        info_ptr)
       
   767     res_y = png_get_y_pixels_per_meter(png_ptr,
       
   768        info_ptr)
       
   769     res_x_and_y = png_get_pixels_per_meter(png_ptr,
       
   770        info_ptr)
       
   771     res_x = png_get_x_pixels_per_inch(png_ptr,
       
   772        info_ptr)
       
   773     res_y = png_get_y_pixels_per_inch(png_ptr,
       
   774        info_ptr)
       
   775     res_x_and_y = png_get_pixels_per_inch(png_ptr,
       
   776        info_ptr)
       
   777     aspect_ratio = png_get_pixel_aspect_ratio(png_ptr,
       
   778        info_ptr)
       
   779 
       
   780    (Each of these returns 0 [signifying "unknown"] if
       
   781        the data is not present or if res_x is 0;
       
   782        res_x_and_y is 0 if res_x != res_y)
       
   783 
       
   784 The data from the oFFs chunk can be retrieved in several convenient
       
   785 forms:
       
   786 
       
   787     x_offset = png_get_x_offset_microns(png_ptr, info_ptr);
       
   788     y_offset = png_get_y_offset_microns(png_ptr, info_ptr);
       
   789     x_offset = png_get_x_offset_inches(png_ptr, info_ptr);
       
   790     y_offset = png_get_y_offset_inches(png_ptr, info_ptr);
       
   791 
       
   792    (Each of these returns 0 [signifying "unknown" if both
       
   793        x and y are 0] if the data is not present or if the
       
   794        chunk is present but the unit is the pixel)
       
   795 
       
   796 For more information, see the png_info definition in png.h and the
       
   797 PNG specification for chunk contents.  Be careful with trusting
       
   798 rowbytes, as some of the transformations could increase the space
       
   799 needed to hold a row (expand, filler, gray_to_rgb, etc.).
       
   800 See png_read_update_info(), below.
       
   801 
       
   802 A quick word about text_ptr and num_text.  PNG stores comments in
       
   803 keyword/text pairs, one pair per chunk, with no limit on the number
       
   804 of text chunks, and a 2^31 byte limit on their size.  While there are
       
   805 suggested keywords, there is no requirement to restrict the use to these
       
   806 strings.  It is strongly suggested that keywords and text be sensible
       
   807 to humans (that's the point), so don't use abbreviations.  Non-printing
       
   808 symbols are not allowed.  See the PNG specification for more details.
       
   809 There is also no requirement to have text after the keyword.
       
   810 
       
   811 Keywords should be limited to 79 Latin-1 characters without leading or
       
   812 trailing spaces, but non-consecutive spaces are allowed within the
       
   813 keyword.  It is possible to have the same keyword any number of times.
       
   814 The text_ptr is an array of png_text structures, each holding a
       
   815 pointer to a language string, a pointer to a keyword and a pointer to
       
   816 a text string.  The text string, language code, and translated
       
   817 keyword may be empty or NULL pointers.  The keyword/text
       
   818 pairs are put into the array in the order that they are received.
       
   819 However, some or all of the text chunks may be after the image, so, to
       
   820 make sure you have read all the text chunks, don't mess with these
       
   821 until after you read the stuff after the image.  This will be
       
   822 mentioned again below in the discussion that goes with png_read_end().
       
   823 
       
   824 Input transformations
       
   825 
       
   826 After you've read the header information, you can set up the library
       
   827 to handle any special transformations of the image data.  The various
       
   828 ways to transform the data will be described in the order that they
       
   829 should occur.  This is important, as some of these change the color
       
   830 type and/or bit depth of the data, and some others only work on
       
   831 certain color types and bit depths.  Even though each transformation
       
   832 checks to see if it has data that it can do something with, you should
       
   833 make sure to only enable a transformation if it will be valid for the
       
   834 data.  For example, don't swap red and blue on grayscale data.
       
   835 
       
   836 The colors used for the background and transparency values should be
       
   837 supplied in the same format/depth as the current image data.  They
       
   838 are stored in the same format/depth as the image data in a bKGD or tRNS
       
   839 chunk, so this is what libpng expects for this data.  The colors are
       
   840 transformed to keep in sync with the image data when an application
       
   841 calls the png_read_update_info() routine (see below).
       
   842 
       
   843 Data will be decoded into the supplied row buffers packed into bytes
       
   844 unless the library has been told to transform it into another format.
       
   845 For example, 4 bit/pixel paletted or grayscale data will be returned
       
   846 2 pixels/byte with the leftmost pixel in the high-order bits of the
       
   847 byte, unless png_set_packing() is called.  8-bit RGB data will be stored
       
   848 in RGB RGB RGB format unless png_set_filler() or png_set_add_alpha()
       
   849 is called to insert filler bytes, either before or after each RGB triplet.
       
   850 16-bit RGB data will be returned RRGGBB RRGGBB, with the most significant
       
   851 byte of the color value first, unless png_set_strip_16() is called to
       
   852 transform it to regular RGB RGB triplets, or png_set_filler() or
       
   853 png_set_add alpha() is called to insert filler bytes, either before or
       
   854 after each RRGGBB triplet.  Similarly, 8-bit or 16-bit grayscale data can
       
   855 be modified with
       
   856 png_set_filler(), png_set_add_alpha(), or png_set_strip_16().
       
   857 
       
   858 The following code transforms grayscale images of less than 8 to 8 bits,
       
   859 changes paletted images to RGB, and adds a full alpha channel if there is
       
   860 transparency information in a tRNS chunk.  This is most useful on
       
   861 grayscale images with bit depths of 2 or 4 or if there is a multiple-image
       
   862 viewing application that wishes to treat all images in the same way.
       
   863 
       
   864     if (color_type == PNG_COLOR_TYPE_PALETTE)
       
   865         png_set_palette_to_rgb(png_ptr);
       
   866 
       
   867     if (color_type == PNG_COLOR_TYPE_GRAY &&
       
   868         bit_depth < 8) png_set_expand_gray_1_2_4_to_8(png_ptr);
       
   869 
       
   870     if (png_get_valid(png_ptr, info_ptr,
       
   871         PNG_INFO_tRNS)) png_set_tRNS_to_alpha(png_ptr);
       
   872 
       
   873 These three functions are actually aliases for png_set_expand(), added
       
   874 in libpng version 1.0.4, with the function names expanded to improve code
       
   875 readability.  In some future version they may actually do different
       
   876 things.
       
   877 
       
   878 As of libpng version 1.2.9, png_set_expand_gray_1_2_4_to_8() was
       
   879 added.  It expands the sample depth without changing tRNS to alpha.
       
   880 
       
   881 As of libpng version 1.4.0, not all possible expansions are supported.
       
   882 
       
   883 In the following table, the 01 means grayscale with depth<8, 31 means
       
   884 indexed with depth<8, other numerals represent the color type, "T" means
       
   885 the tRNS chunk is present, A means an alpha channel is present, and O
       
   886 means tRNS or alpha is present but all pixels in the image are opaque.
       
   887 
       
   888   FROM  01  31   0  0T  0O   2  2T  2O   3  3T  3O  4A  4O  6A  6O 
       
   889    TO
       
   890    01    -                   
       
   891    31        -
       
   892     0    1       -           
       
   893    0T                -
       
   894    0O                    -
       
   895     2           GX           -
       
   896    2T                            -
       
   897    2O                                -
       
   898     3        1                           -
       
   899    3T                                        -
       
   900    3O                                            -
       
   901    4A                T                               -
       
   902    4O                                                    -
       
   903    6A               GX         TX           TX               -
       
   904    6O                   GX                      TX               -
       
   905 
       
   906 Within the matrix,
       
   907      "-" means the transformation is not supported.
       
   908      "X" means the transformation is obtained by png_set_expand().
       
   909      "1" means the transformation is obtained by
       
   910          png_set_expand_gray_1_2_4_to_8
       
   911      "G" means the transformation is obtained by
       
   912          png_set_gray_to_rgb().
       
   913      "P" means the transformation is obtained by
       
   914          png_set_expand_palette_to_rgb().
       
   915      "T" means the transformation is obtained by
       
   916          png_set_tRNS_to_alpha().
       
   917 
       
   918 PNG can have files with 16 bits per channel.  If you only can handle
       
   919 8 bits per channel, this will strip the pixels down to 8 bit.
       
   920 
       
   921     if (bit_depth == 16)
       
   922         png_set_strip_16(png_ptr);
       
   923 
       
   924 If, for some reason, you don't need the alpha channel on an image,
       
   925 and you want to remove it rather than combining it with the background
       
   926 (but the image author certainly had in mind that you *would* combine
       
   927 it with the background, so that's what you should probably do):
       
   928 
       
   929     if (color_type & PNG_COLOR_MASK_ALPHA)
       
   930         png_set_strip_alpha(png_ptr);
       
   931 
       
   932 In PNG files, the alpha channel in an image
       
   933 is the level of opacity.  If you need the alpha channel in an image to
       
   934 be the level of transparency instead of opacity, you can invert the
       
   935 alpha channel (or the tRNS chunk data) after it's read, so that 0 is
       
   936 fully opaque and 255 (in 8-bit or paletted images) or 65535 (in 16-bit
       
   937 images) is fully transparent, with
       
   938 
       
   939     png_set_invert_alpha(png_ptr);
       
   940 
       
   941 PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
       
   942 they can, resulting in, for example, 8 pixels per byte for 1 bit
       
   943 files.  This code expands to 1 pixel per byte without changing the
       
   944 values of the pixels:
       
   945 
       
   946     if (bit_depth < 8)
       
   947         png_set_packing(png_ptr);
       
   948 
       
   949 PNG files have possible bit depths of 1, 2, 4, 8, and 16.  All pixels
       
   950 stored in a PNG image have been "scaled" or "shifted" up to the next
       
   951 higher possible bit depth (e.g. from 5 bits/sample in the range [0,31]
       
   952 to 8 bits/sample in the range [0, 255]).  However, it is also possible
       
   953 to convert the PNG pixel data back to the original bit depth of the
       
   954 image.  This call reduces the pixels back down to the original bit depth:
       
   955 
       
   956     png_color_8p sig_bit;
       
   957 
       
   958     if (png_get_sBIT(png_ptr, info_ptr, &sig_bit))
       
   959         png_set_shift(png_ptr, sig_bit);
       
   960 
       
   961 PNG files store 3-color pixels in red, green, blue order.  This code
       
   962 changes the storage of the pixels to blue, green, red:
       
   963 
       
   964     if (color_type == PNG_COLOR_TYPE_RGB ||
       
   965         color_type == PNG_COLOR_TYPE_RGB_ALPHA)
       
   966         png_set_bgr(png_ptr);
       
   967 
       
   968 PNG files store RGB pixels packed into 3 or 6 bytes. This code expands them
       
   969 into 4 or 8 bytes for windowing systems that need them in this format:
       
   970 
       
   971     if (color_type == PNG_COLOR_TYPE_RGB)
       
   972         png_set_filler(png_ptr, filler, PNG_FILLER_BEFORE);
       
   973 
       
   974 where "filler" is the 8 or 16-bit number to fill with, and the location is
       
   975 either PNG_FILLER_BEFORE or PNG_FILLER_AFTER, depending upon whether
       
   976 you want the filler before the RGB or after.  This transformation
       
   977 does not affect images that already have full alpha channels.  To add an
       
   978 opaque alpha channel, use filler=0xff or 0xffff and PNG_FILLER_AFTER which
       
   979 will generate RGBA pixels.
       
   980 
       
   981 Note that png_set_filler() does not change the color type.  If you want
       
   982 to do that, you can add a true alpha channel with
       
   983 
       
   984     if (color_type == PNG_COLOR_TYPE_RGB ||
       
   985            color_type == PNG_COLOR_TYPE_GRAY)
       
   986     png_set_add_alpha(png_ptr, filler, PNG_FILLER_AFTER);
       
   987 
       
   988 where "filler" contains the alpha value to assign to each pixel.
       
   989 This function was added in libpng-1.2.7.
       
   990 
       
   991 If you are reading an image with an alpha channel, and you need the
       
   992 data as ARGB instead of the normal PNG format RGBA:
       
   993 
       
   994     if (color_type == PNG_COLOR_TYPE_RGB_ALPHA)
       
   995         png_set_swap_alpha(png_ptr);
       
   996 
       
   997 For some uses, you may want a grayscale image to be represented as
       
   998 RGB.  This code will do that conversion:
       
   999 
       
  1000     if (color_type == PNG_COLOR_TYPE_GRAY ||
       
  1001         color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
       
  1002           png_set_gray_to_rgb(png_ptr);
       
  1003 
       
  1004 Conversely, you can convert an RGB or RGBA image to grayscale or grayscale
       
  1005 with alpha.
       
  1006 
       
  1007     if (color_type == PNG_COLOR_TYPE_RGB ||
       
  1008         color_type == PNG_COLOR_TYPE_RGB_ALPHA)
       
  1009           png_set_rgb_to_gray_fixed(png_ptr, error_action,
       
  1010              int red_weight, int green_weight);
       
  1011 
       
  1012     error_action = 1: silently do the conversion
       
  1013     error_action = 2: issue a warning if the original
       
  1014                       image has any pixel where
       
  1015                       red != green or red != blue
       
  1016     error_action = 3: issue an error and abort the
       
  1017                       conversion if the original
       
  1018                       image has any pixel where
       
  1019                       red != green or red != blue
       
  1020 
       
  1021     red_weight:       weight of red component times 100000
       
  1022     green_weight:     weight of green component times 100000
       
  1023                       If either weight is negative, default
       
  1024                       weights (21268, 71514) are used.
       
  1025 
       
  1026 If you have set error_action = 1 or 2, you can
       
  1027 later check whether the image really was gray, after processing
       
  1028 the image rows, with the png_get_rgb_to_gray_status(png_ptr) function.
       
  1029 It will return a png_byte that is zero if the image was gray or
       
  1030 1 if there were any non-gray pixels.  bKGD and sBIT data
       
  1031 will be silently converted to grayscale, using the green channel
       
  1032 data, regardless of the error_action setting.
       
  1033 
       
  1034 With red_weight+green_weight<=100000,
       
  1035 the normalized graylevel is computed:
       
  1036 
       
  1037     int rw = red_weight * 65536;
       
  1038     int gw = green_weight * 65536;
       
  1039     int bw = 65536 - (rw + gw);
       
  1040     gray = (rw*red + gw*green + bw*blue)/65536;
       
  1041 
       
  1042 The default values approximate those recommended in the Charles
       
  1043 Poynton's Color FAQ, <http://www.inforamp.net/~poynton/>
       
  1044 Copyright (c) 1998-01-04 Charles Poynton <poynton at inforamp.net>
       
  1045 
       
  1046     Y = 0.212671 * R + 0.715160 * G + 0.072169 * B
       
  1047 
       
  1048 Libpng approximates this with
       
  1049 
       
  1050     Y = 0.21268 * R    + 0.7151 * G    + 0.07217 * B
       
  1051 
       
  1052 which can be expressed with integers as
       
  1053 
       
  1054     Y = (6969 * R + 23434 * G + 2365 * B)/32768
       
  1055 
       
  1056 The calculation is done in a linear colorspace, if the image gamma
       
  1057 is known.
       
  1058 
       
  1059 If you have a grayscale and you are using png_set_expand_depth(),
       
  1060 png_set_expand(), or png_set_gray_to_rgb to change to truecolor or to
       
  1061 a higher bit-depth, you must either supply the background color as a gray
       
  1062 value at the original file bit-depth (need_expand = 1) or else supply the
       
  1063 background color as an RGB triplet at the final, expanded bit depth
       
  1064 (need_expand = 0).  Similarly, if you are reading a paletted image, you
       
  1065 must either supply the background color as a palette index (need_expand = 1)
       
  1066 or as an RGB triplet that may or may not be in the palette (need_expand = 0).
       
  1067 
       
  1068     png_color_16 my_background;
       
  1069     png_color_16p image_background;
       
  1070 
       
  1071     if (png_get_bKGD(png_ptr, info_ptr, &image_background))
       
  1072         png_set_background(png_ptr, image_background,
       
  1073           PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
       
  1074     else
       
  1075         png_set_background(png_ptr, &my_background,
       
  1076           PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
       
  1077 
       
  1078 The png_set_background() function tells libpng to composite images
       
  1079 with alpha or simple transparency against the supplied background
       
  1080 color.  If the PNG file contains a bKGD chunk (PNG_INFO_bKGD valid),
       
  1081 you may use this color, or supply another color more suitable for
       
  1082 the current display (e.g., the background color from a web page).  You
       
  1083 need to tell libpng whether the color is in the gamma space of the
       
  1084 display (PNG_BACKGROUND_GAMMA_SCREEN for colors you supply), the file
       
  1085 (PNG_BACKGROUND_GAMMA_FILE for colors from the bKGD chunk), or one
       
  1086 that is neither of these gammas (PNG_BACKGROUND_GAMMA_UNIQUE - I don't
       
  1087 know why anyone would use this, but it's here).
       
  1088 
       
  1089 To properly display PNG images on any kind of system, the application needs
       
  1090 to know what the display gamma is.  Ideally, the user will know this, and
       
  1091 the application will allow them to set it.  One method of allowing the user
       
  1092 to set the display gamma separately for each system is to check for a
       
  1093 SCREEN_GAMMA or DISPLAY_GAMMA environment variable, which will hopefully be
       
  1094 correctly set.
       
  1095 
       
  1096 Note that display_gamma is the overall gamma correction required to produce
       
  1097 pleasing results, which depends on the lighting conditions in the surrounding
       
  1098 environment.  In a dim or brightly lit room, no compensation other than
       
  1099 the physical gamma exponent of the monitor is needed, while in a dark room
       
  1100 a slightly smaller exponent is better.
       
  1101 
       
  1102    double gamma, screen_gamma;
       
  1103 
       
  1104    if (/* We have a user-defined screen
       
  1105        gamma value */)
       
  1106    {
       
  1107       screen_gamma = user_defined_screen_gamma;
       
  1108    }
       
  1109    /* One way that applications can share the same
       
  1110       screen gamma value */
       
  1111    else if ((gamma_str = getenv("SCREEN_GAMMA"))
       
  1112       != NULL)
       
  1113    {
       
  1114       screen_gamma = (double)atof(gamma_str);
       
  1115    }
       
  1116    /* If we don't have another value */
       
  1117    else
       
  1118    {
       
  1119       screen_gamma = 2.2; /* A good guess for a
       
  1120            PC monitor in a bright office or a dim room */
       
  1121       screen_gamma = 2.0; /* A good guess for a
       
  1122            PC monitor in a dark room */
       
  1123       screen_gamma = 1.7 or 1.0;  /* A good
       
  1124            guess for Mac systems */
       
  1125    }
       
  1126 
       
  1127 The png_set_gamma() function handles gamma transformations of the data.
       
  1128 Pass both the file gamma and the current screen_gamma.  If the file does
       
  1129 not have a gamma value, you can pass one anyway if you have an idea what
       
  1130 it is (usually 0.45455 is a good guess for GIF images on PCs).  Note
       
  1131 that file gammas are inverted from screen gammas.  See the discussions
       
  1132 on gamma in the PNG specification for an excellent description of what
       
  1133 gamma is, and why all applications should support it.  It is strongly
       
  1134 recommended that PNG viewers support gamma correction.
       
  1135 
       
  1136    if (png_get_gAMA(png_ptr, info_ptr, &gamma))
       
  1137       png_set_gamma(png_ptr, screen_gamma, gamma);
       
  1138    else
       
  1139       png_set_gamma(png_ptr, screen_gamma, 0.45455);
       
  1140 
       
  1141 PNG files describe monochrome as black being zero and white being one.
       
  1142 The following code will reverse this (make black be one and white be
       
  1143 zero):
       
  1144 
       
  1145    if (bit_depth == 1 && color_type == PNG_COLOR_TYPE_GRAY)
       
  1146       png_set_invert_mono(png_ptr);
       
  1147 
       
  1148 This function can also be used to invert grayscale and gray-alpha images:
       
  1149 
       
  1150    if (color_type == PNG_COLOR_TYPE_GRAY ||
       
  1151         color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
       
  1152       png_set_invert_mono(png_ptr);
       
  1153 
       
  1154 PNG files store 16 bit pixels in network byte order (big-endian,
       
  1155 ie. most significant bits first).  This code changes the storage to the
       
  1156 other way (little-endian, i.e. least significant bits first, the
       
  1157 way PCs store them):
       
  1158 
       
  1159     if (bit_depth == 16)
       
  1160         png_set_swap(png_ptr);
       
  1161 
       
  1162 If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
       
  1163 need to change the order the pixels are packed into bytes, you can use:
       
  1164 
       
  1165     if (bit_depth < 8)
       
  1166        png_set_packswap(png_ptr);
       
  1167 
       
  1168 Finally, you can write your own transformation function if none of
       
  1169 the existing ones meets your needs.  This is done by setting a callback
       
  1170 with
       
  1171 
       
  1172     png_set_read_user_transform_fn(png_ptr,
       
  1173        read_transform_fn);
       
  1174 
       
  1175 You must supply the function
       
  1176 
       
  1177     void read_transform_fn(png_ptr ptr, row_info_ptr
       
  1178        row_info, png_bytep data)
       
  1179 
       
  1180 See pngtest.c for a working example.  Your function will be called
       
  1181 after all of the other transformations have been processed.
       
  1182 
       
  1183 You can also set up a pointer to a user structure for use by your
       
  1184 callback function, and you can inform libpng that your transform
       
  1185 function will change the number of channels or bit depth with the
       
  1186 function
       
  1187 
       
  1188     png_set_user_transform_info(png_ptr, user_ptr,
       
  1189        user_depth, user_channels);
       
  1190 
       
  1191 The user's application, not libpng, is responsible for allocating and
       
  1192 freeing any memory required for the user structure.
       
  1193 
       
  1194 You can retrieve the pointer via the function
       
  1195 png_get_user_transform_ptr().  For example:
       
  1196 
       
  1197     voidp read_user_transform_ptr =
       
  1198        png_get_user_transform_ptr(png_ptr);
       
  1199 
       
  1200 The last thing to handle is interlacing; this is covered in detail below,
       
  1201 but you must call the function here if you want libpng to handle expansion
       
  1202 of the interlaced image.
       
  1203 
       
  1204     number_of_passes = png_set_interlace_handling(png_ptr);
       
  1205 
       
  1206 After setting the transformations, libpng can update your png_info
       
  1207 structure to reflect any transformations you've requested with this
       
  1208 call.  This is most useful to update the info structure's rowbytes
       
  1209 field so you can use it to allocate your image memory.  This function
       
  1210 will also update your palette with the correct screen_gamma and
       
  1211 background if these have been given with the calls above.
       
  1212 
       
  1213     png_read_update_info(png_ptr, info_ptr);
       
  1214 
       
  1215 After you call png_read_update_info(), you can allocate any
       
  1216 memory you need to hold the image.  The row data is simply
       
  1217 raw byte data for all forms of images.  As the actual allocation
       
  1218 varies among applications, no example will be given.  If you
       
  1219 are allocating one large chunk, you will need to build an
       
  1220 array of pointers to each row, as it will be needed for some
       
  1221 of the functions below.
       
  1222 
       
  1223 Reading image data
       
  1224 
       
  1225 After you've allocated memory, you can read the image data.
       
  1226 The simplest way to do this is in one function call.  If you are
       
  1227 allocating enough memory to hold the whole image, you can just
       
  1228 call png_read_image() and libpng will read in all the image data
       
  1229 and put it in the memory area supplied.  You will need to pass in
       
  1230 an array of pointers to each row.
       
  1231 
       
  1232 This function automatically handles interlacing, so you don't need
       
  1233 to call png_set_interlace_handling() or call this function multiple
       
  1234 times, or any of that other stuff necessary with png_read_rows().
       
  1235 
       
  1236    png_read_image(png_ptr, row_pointers);
       
  1237 
       
  1238 where row_pointers is:
       
  1239 
       
  1240    png_bytep row_pointers[height];
       
  1241 
       
  1242 You can point to void or char or whatever you use for pixels.
       
  1243 
       
  1244 If you don't want to read in the whole image at once, you can
       
  1245 use png_read_rows() instead.  If there is no interlacing (check
       
  1246 interlace_type == PNG_INTERLACE_NONE), this is simple:
       
  1247 
       
  1248     png_read_rows(png_ptr, row_pointers, NULL,
       
  1249        number_of_rows);
       
  1250 
       
  1251 where row_pointers is the same as in the png_read_image() call.
       
  1252 
       
  1253 If you are doing this just one row at a time, you can do this with
       
  1254 a single row_pointer instead of an array of row_pointers:
       
  1255 
       
  1256     png_bytep row_pointer = row;
       
  1257     png_read_row(png_ptr, row_pointer, NULL);
       
  1258 
       
  1259 If the file is interlaced (interlace_type != 0 in the IHDR chunk), things
       
  1260 get somewhat harder.  The only current (PNG Specification version 1.2)
       
  1261 interlacing type for PNG is (interlace_type == PNG_INTERLACE_ADAM7)
       
  1262 is a somewhat complicated 2D interlace scheme, known as Adam7, that
       
  1263 breaks down an image into seven smaller images of varying size, based
       
  1264 on an 8x8 grid.
       
  1265 
       
  1266 libpng can fill out those images or it can give them to you "as is".
       
  1267 If you want them filled out, there are two ways to do that.  The one
       
  1268 mentioned in the PNG specification is to expand each pixel to cover
       
  1269 those pixels that have not been read yet (the "rectangle" method).
       
  1270 This results in a blocky image for the first pass, which gradually
       
  1271 smooths out as more pixels are read.  The other method is the "sparkle"
       
  1272 method, where pixels are drawn only in their final locations, with the
       
  1273 rest of the image remaining whatever colors they were initialized to
       
  1274 before the start of the read.  The first method usually looks better,
       
  1275 but tends to be slower, as there are more pixels to put in the rows.
       
  1276 
       
  1277 If you don't want libpng to handle the interlacing details, just call
       
  1278 png_read_rows() seven times to read in all seven images.  Each of the
       
  1279 images is a valid image by itself, or they can all be combined on an
       
  1280 8x8 grid to form a single image (although if you intend to combine them
       
  1281 you would be far better off using the libpng interlace handling).
       
  1282 
       
  1283 The first pass will return an image 1/8 as wide as the entire image
       
  1284 (every 8th column starting in column 0) and 1/8 as high as the original
       
  1285 (every 8th row starting in row 0), the second will be 1/8 as wide
       
  1286 (starting in column 4) and 1/8 as high (also starting in row 0).  The
       
  1287 third pass will be 1/4 as wide (every 4th pixel starting in column 0) and
       
  1288 1/8 as high (every 8th row starting in row 4), and the fourth pass will
       
  1289 be 1/4 as wide and 1/4 as high (every 4th column starting in column 2,
       
  1290 and every 4th row starting in row 0).  The fifth pass will return an
       
  1291 image 1/2 as wide, and 1/4 as high (starting at column 0 and row 2),
       
  1292 while the sixth pass will be 1/2 as wide and 1/2 as high as the original
       
  1293 (starting in column 1 and row 0).  The seventh and final pass will be as
       
  1294 wide as the original, and 1/2 as high, containing all of the odd
       
  1295 numbered scanlines.  Phew!
       
  1296 
       
  1297 If you want libpng to expand the images, call this before calling
       
  1298 png_start_read_image() or png_read_update_info():
       
  1299 
       
  1300     if (interlace_type == PNG_INTERLACE_ADAM7)
       
  1301         number_of_passes
       
  1302            = png_set_interlace_handling(png_ptr);
       
  1303 
       
  1304 This will return the number of passes needed.  Currently, this
       
  1305 is seven, but may change if another interlace type is added.
       
  1306 This function can be called even if the file is not interlaced,
       
  1307 where it will return one pass.
       
  1308 
       
  1309 If you are not going to display the image after each pass, but are
       
  1310 going to wait until the entire image is read in, use the sparkle
       
  1311 effect.  This effect is faster and the end result of either method
       
  1312 is exactly the same.  If you are planning on displaying the image
       
  1313 after each pass, the "rectangle" effect is generally considered the
       
  1314 better looking one.
       
  1315 
       
  1316 If you only want the "sparkle" effect, just call png_read_rows() as
       
  1317 normal, with the third parameter NULL.  Make sure you make pass over
       
  1318 the image number_of_passes times, and you don't change the data in the
       
  1319 rows between calls.  You can change the locations of the data, just
       
  1320 not the data.  Each pass only writes the pixels appropriate for that
       
  1321 pass, and assumes the data from previous passes is still valid.
       
  1322 
       
  1323     png_read_rows(png_ptr, row_pointers, NULL,
       
  1324        number_of_rows);
       
  1325 
       
  1326 If you only want the first effect (the rectangles), do the same as
       
  1327 before except pass the row buffer in the third parameter, and leave
       
  1328 the second parameter NULL.
       
  1329 
       
  1330     png_read_rows(png_ptr, NULL, row_pointers,
       
  1331        number_of_rows);
       
  1332 
       
  1333 Finishing a sequential read
       
  1334 
       
  1335 After you are finished reading the image through the
       
  1336 low-level interface, you can finish reading the file.  If you are
       
  1337 interested in comments or time, which may be stored either before or
       
  1338 after the image data, you should pass the separate png_info struct if
       
  1339 you want to keep the comments from before and after the image
       
  1340 separate.  If you are not interested, you can pass NULL.
       
  1341 
       
  1342    png_read_end(png_ptr, end_info);
       
  1343 
       
  1344 When you are done, you can free all memory allocated by libpng like this:
       
  1345 
       
  1346    png_destroy_read_struct(&png_ptr, &info_ptr,
       
  1347        &end_info);
       
  1348 
       
  1349 It is also possible to individually free the info_ptr members that
       
  1350 point to libpng-allocated storage with the following function:
       
  1351 
       
  1352     png_free_data(png_ptr, info_ptr, mask, seq)
       
  1353     mask - identifies data to be freed, a mask
       
  1354            containing the bitwise OR of one or
       
  1355            more of
       
  1356              PNG_FREE_PLTE, PNG_FREE_TRNS,
       
  1357              PNG_FREE_HIST, PNG_FREE_ICCP,
       
  1358              PNG_FREE_PCAL, PNG_FREE_ROWS,
       
  1359              PNG_FREE_SCAL, PNG_FREE_SPLT,
       
  1360              PNG_FREE_TEXT, PNG_FREE_UNKN,
       
  1361            or simply PNG_FREE_ALL
       
  1362     seq  - sequence number of item to be freed
       
  1363            (-1 for all items)
       
  1364 
       
  1365 This function may be safely called when the relevant storage has
       
  1366 already been freed, or has not yet been allocated, or was allocated
       
  1367 by the user and not by libpng,  and will in those cases do nothing.
       
  1368 The "seq" parameter is ignored if only one item of the selected data
       
  1369 type, such as PLTE, is allowed.  If "seq" is not -1, and multiple items
       
  1370 are allowed for the data type identified in the mask, such as text or
       
  1371 sPLT, only the n'th item in the structure is freed, where n is "seq".
       
  1372 
       
  1373 The default behavior is only to free data that was allocated internally
       
  1374 by libpng.  This can be changed, so that libpng will not free the data,
       
  1375 or so that it will free data that was allocated by the user with png_malloc()
       
  1376 or png_zalloc() and passed in via a png_set_*() function, with
       
  1377 
       
  1378     png_data_freer(png_ptr, info_ptr, freer, mask)
       
  1379     mask   - which data elements are affected
       
  1380              same choices as in png_free_data()
       
  1381     freer  - one of
       
  1382                PNG_DESTROY_WILL_FREE_DATA
       
  1383                PNG_SET_WILL_FREE_DATA
       
  1384                PNG_USER_WILL_FREE_DATA
       
  1385 
       
  1386 This function only affects data that has already been allocated.
       
  1387 You can call this function after reading the PNG data but before calling
       
  1388 any png_set_*() functions, to control whether the user or the png_set_*()
       
  1389 function is responsible for freeing any existing data that might be present,
       
  1390 and again after the png_set_*() functions to control whether the user
       
  1391 or png_destroy_*() is supposed to free the data.  When the user assumes
       
  1392 responsibility for libpng-allocated data, the application must use
       
  1393 png_free() to free it, and when the user transfers responsibility to libpng
       
  1394 for data that the user has allocated, the user must have used png_malloc()
       
  1395 or png_zalloc() to allocate it.
       
  1396 
       
  1397 If you allocated your row_pointers in a single block, as suggested above in
       
  1398 the description of the high level read interface, you must not transfer
       
  1399 responsibility for freeing it to the png_set_rows or png_read_destroy function,
       
  1400 because they would also try to free the individual row_pointers[i].
       
  1401 
       
  1402 If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
       
  1403 separately, do not transfer responsibility for freeing text_ptr to libpng,
       
  1404 because when libpng fills a png_text structure it combines these members with
       
  1405 the key member, and png_free_data() will free only text_ptr.key.  Similarly,
       
  1406 if you transfer responsibility for free'ing text_ptr from libpng to your
       
  1407 application, your application must not separately free those members.
       
  1408 
       
  1409 The png_free_data() function will turn off the "valid" flag for anything
       
  1410 it frees.  If you need to turn the flag off for a chunk that was freed by
       
  1411 your application instead of by libpng, you can use
       
  1412 
       
  1413     png_set_invalid(png_ptr, info_ptr, mask);
       
  1414     mask - identifies the chunks to be made invalid,
       
  1415            containing the bitwise OR of one or
       
  1416            more of
       
  1417              PNG_INFO_gAMA, PNG_INFO_sBIT,
       
  1418              PNG_INFO_cHRM, PNG_INFO_PLTE,
       
  1419              PNG_INFO_tRNS, PNG_INFO_bKGD,
       
  1420              PNG_INFO_hIST, PNG_INFO_pHYs,
       
  1421              PNG_INFO_oFFs, PNG_INFO_tIME,
       
  1422              PNG_INFO_pCAL, PNG_INFO_sRGB,
       
  1423              PNG_INFO_iCCP, PNG_INFO_sPLT,
       
  1424              PNG_INFO_sCAL, PNG_INFO_IDAT
       
  1425 
       
  1426 For a more compact example of reading a PNG image, see the file example.c.
       
  1427 
       
  1428 Reading PNG files progressively
       
  1429 
       
  1430 The progressive reader is slightly different then the non-progressive
       
  1431 reader.  Instead of calling png_read_info(), png_read_rows(), and
       
  1432 png_read_end(), you make one call to png_process_data(), which calls
       
  1433 callbacks when it has the info, a row, or the end of the image.  You
       
  1434 set up these callbacks with png_set_progressive_read_fn().  You don't
       
  1435 have to worry about the input/output functions of libpng, as you are
       
  1436 giving the library the data directly in png_process_data().  I will
       
  1437 assume that you have read the section on reading PNG files above,
       
  1438 so I will only highlight the differences (although I will show
       
  1439 all of the code).
       
  1440 
       
  1441 png_structp png_ptr;
       
  1442 png_infop info_ptr;
       
  1443 
       
  1444  /*  An example code fragment of how you would
       
  1445      initialize the progressive reader in your
       
  1446      application. */
       
  1447  int
       
  1448  initialize_png_reader()
       
  1449  {
       
  1450     png_ptr = png_create_read_struct
       
  1451         (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
       
  1452          user_error_fn, user_warning_fn);
       
  1453     if (!png_ptr)
       
  1454         return (ERROR);
       
  1455     info_ptr = png_create_info_struct(png_ptr);
       
  1456     if (!info_ptr)
       
  1457     {
       
  1458         png_destroy_read_struct(&png_ptr, (png_infopp)NULL,
       
  1459            (png_infopp)NULL);
       
  1460         return (ERROR);
       
  1461     }
       
  1462 
       
  1463     if (setjmp(png_jmpbuf(png_ptr)))
       
  1464     {
       
  1465         png_destroy_read_struct(&png_ptr, &info_ptr,
       
  1466            (png_infopp)NULL);
       
  1467         return (ERROR);
       
  1468     }
       
  1469 
       
  1470     /* This one's new.  You can provide functions
       
  1471        to be called when the header info is valid,
       
  1472        when each row is completed, and when the image
       
  1473        is finished.  If you aren't using all functions,
       
  1474        you can specify NULL parameters.  Even when all
       
  1475        three functions are NULL, you need to call
       
  1476        png_set_progressive_read_fn().  You can use
       
  1477        any struct as the user_ptr (cast to a void pointer
       
  1478        for the function call), and retrieve the pointer
       
  1479        from inside the callbacks using the function
       
  1480 
       
  1481           png_get_progressive_ptr(png_ptr);
       
  1482 
       
  1483        which will return a void pointer, which you have
       
  1484        to cast appropriately.
       
  1485      */
       
  1486     png_set_progressive_read_fn(png_ptr, (void *)user_ptr,
       
  1487         info_callback, row_callback, end_callback);
       
  1488 
       
  1489     return 0;
       
  1490  }
       
  1491 
       
  1492  /* A code fragment that you call as you receive blocks
       
  1493    of data */
       
  1494  int
       
  1495  process_data(png_bytep buffer, png_uint_32 length)
       
  1496  {
       
  1497     if (setjmp(png_jmpbuf(png_ptr)))
       
  1498     {
       
  1499         png_destroy_read_struct(&png_ptr, &info_ptr,
       
  1500            (png_infopp)NULL);
       
  1501         return (ERROR);
       
  1502     }
       
  1503 
       
  1504     /* This one's new also.  Simply give it a chunk
       
  1505        of data from the file stream (in order, of
       
  1506        course).  On machines with segmented memory
       
  1507        models machines, don't give it any more than
       
  1508        64K.  The library seems to run fine with sizes
       
  1509        of 4K. Although you can give it much less if
       
  1510        necessary (I assume you can give it chunks of
       
  1511        1 byte, I haven't tried less then 256 bytes
       
  1512        yet).  When this function returns, you may
       
  1513        want to display any rows that were generated
       
  1514        in the row callback if you don't already do
       
  1515        so there.
       
  1516      */
       
  1517     png_process_data(png_ptr, info_ptr, buffer, length);
       
  1518     return 0;
       
  1519  }
       
  1520 
       
  1521  /* This function is called (as set by
       
  1522     png_set_progressive_read_fn() above) when enough data
       
  1523     has been supplied so all of the header has been
       
  1524     read.
       
  1525  */
       
  1526  void
       
  1527  info_callback(png_structp png_ptr, png_infop info)
       
  1528  {
       
  1529     /* Do any setup here, including setting any of
       
  1530        the transformations mentioned in the Reading
       
  1531        PNG files section.  For now, you _must_ call
       
  1532        either png_start_read_image() or
       
  1533        png_read_update_info() after all the
       
  1534        transformations are set (even if you don't set
       
  1535        any).  You may start getting rows before
       
  1536        png_process_data() returns, so this is your
       
  1537        last chance to prepare for that.
       
  1538      */
       
  1539  }
       
  1540 
       
  1541  /* This function is called when each row of image
       
  1542     data is complete */
       
  1543  void
       
  1544  row_callback(png_structp png_ptr, png_bytep new_row,
       
  1545     png_uint_32 row_num, int pass)
       
  1546  {
       
  1547     /* If the image is interlaced, and you turned
       
  1548        on the interlace handler, this function will
       
  1549        be called for every row in every pass.  Some
       
  1550        of these rows will not be changed from the
       
  1551        previous pass.  When the row is not changed,
       
  1552        the new_row variable will be NULL.  The rows
       
  1553        and passes are called in order, so you don't
       
  1554        really need the row_num and pass, but I'm
       
  1555        supplying them because it may make your life
       
  1556        easier.
       
  1557 
       
  1558        For the non-NULL rows of interlaced images,
       
  1559        you must call png_progressive_combine_row()
       
  1560        passing in the row and the old row.  You can
       
  1561        call this function for NULL rows (it will just
       
  1562        return) and for non-interlaced images (it just
       
  1563        does the memcpy for you) if it will make the
       
  1564        code easier.  Thus, you can just do this for
       
  1565        all cases:
       
  1566      */
       
  1567 
       
  1568         png_progressive_combine_row(png_ptr, old_row,
       
  1569           new_row);
       
  1570 
       
  1571     /* where old_row is what was displayed for
       
  1572        previously for the row.  Note that the first
       
  1573        pass (pass == 0, really) will completely cover
       
  1574        the old row, so the rows do not have to be
       
  1575        initialized.  After the first pass (and only
       
  1576        for interlaced images), you will have to pass
       
  1577        the current row, and the function will combine
       
  1578        the old row and the new row.
       
  1579     */
       
  1580  }
       
  1581 
       
  1582  void
       
  1583  end_callback(png_structp png_ptr, png_infop info)
       
  1584  {
       
  1585     /* This function is called after the whole image
       
  1586        has been read, including any chunks after the
       
  1587        image (up to and including the IEND).  You
       
  1588        will usually have the same info chunk as you
       
  1589        had in the header, although some data may have
       
  1590        been added to the comments and time fields.
       
  1591 
       
  1592        Most people won't do much here, perhaps setting
       
  1593        a flag that marks the image as finished.
       
  1594      */
       
  1595  }
       
  1596 
       
  1597 
       
  1598 
       
  1599 IV. Writing
       
  1600 
       
  1601 Much of this is very similar to reading.  However, everything of
       
  1602 importance is repeated here, so you won't have to constantly look
       
  1603 back up in the reading section to understand writing.
       
  1604 
       
  1605 Setup
       
  1606 
       
  1607 You will want to do the I/O initialization before you get into libpng,
       
  1608 so if it doesn't work, you don't have anything to undo. If you are not
       
  1609 using the standard I/O functions, you will need to replace them with
       
  1610 custom writing functions.  See the discussion under Customizing libpng.
       
  1611 
       
  1612     FILE *fp = fopen(file_name, "wb");
       
  1613     if (!fp)
       
  1614     {
       
  1615        return (ERROR);
       
  1616     }
       
  1617 
       
  1618 Next, png_struct and png_info need to be allocated and initialized.
       
  1619 As these can be both relatively large, you may not want to store these
       
  1620 on the stack, unless you have stack space to spare.  Of course, you
       
  1621 will want to check if they return NULL.  If you are also reading,
       
  1622 you won't want to name your read structure and your write structure
       
  1623 both "png_ptr"; you can call them anything you like, such as
       
  1624 "read_ptr" and "write_ptr".  Look at pngtest.c, for example.
       
  1625 
       
  1626     png_structp png_ptr = png_create_write_struct
       
  1627        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
       
  1628         user_error_fn, user_warning_fn);
       
  1629     if (!png_ptr)
       
  1630        return (ERROR);
       
  1631 
       
  1632     png_infop info_ptr = png_create_info_struct(png_ptr);
       
  1633     if (!info_ptr)
       
  1634     {
       
  1635        png_destroy_write_struct(&png_ptr,
       
  1636          (png_infopp)NULL);
       
  1637        return (ERROR);
       
  1638     }
       
  1639 
       
  1640 If you want to use your own memory allocation routines,
       
  1641 define PNG_USER_MEM_SUPPORTED and use
       
  1642 png_create_write_struct_2() instead of png_create_write_struct():
       
  1643 
       
  1644     png_structp png_ptr = png_create_write_struct_2
       
  1645        (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
       
  1646         user_error_fn, user_warning_fn, (png_voidp)
       
  1647         user_mem_ptr, user_malloc_fn, user_free_fn);
       
  1648 
       
  1649 After you have these structures, you will need to set up the
       
  1650 error handling.  When libpng encounters an error, it expects to
       
  1651 longjmp() back to your routine.  Therefore, you will need to call
       
  1652 setjmp() and pass the png_jmpbuf(png_ptr).  If you
       
  1653 write the file from different routines, you will need to update
       
  1654 the png_jmpbuf(png_ptr) every time you enter a new routine that will
       
  1655 call a png_*() function.  See your documentation of setjmp/longjmp
       
  1656 for your compiler for more information on setjmp/longjmp.  See
       
  1657 the discussion on libpng error handling in the Customizing Libpng
       
  1658 section below for more information on the libpng error handling.
       
  1659 
       
  1660     if (setjmp(png_jmpbuf(png_ptr)))
       
  1661     {
       
  1662        png_destroy_write_struct(&png_ptr, &info_ptr);
       
  1663        fclose(fp);
       
  1664        return (ERROR);
       
  1665     }
       
  1666     ...
       
  1667     return;
       
  1668 
       
  1669 If you would rather avoid the complexity of setjmp/longjmp issues,
       
  1670 you can compile libpng with PNG_SETJMP_NOT_SUPPORTED, in which case
       
  1671 errors will result in a call to PNG_ABORT() which defaults to abort().
       
  1672 
       
  1673 Now you need to set up the output code.  The default for libpng is to
       
  1674 use the C function fwrite().  If you use this, you will need to pass a
       
  1675 valid FILE * in the function png_init_io().  Be sure that the file is
       
  1676 opened in binary mode.  Again, if you wish to handle writing data in
       
  1677 another way, see the discussion on libpng I/O handling in the Customizing
       
  1678 Libpng section below.
       
  1679 
       
  1680     png_init_io(png_ptr, fp);
       
  1681 
       
  1682 If you are embedding your PNG into a datastream such as MNG, and don't
       
  1683 want libpng to write the 8-byte signature, or if you have already
       
  1684 written the signature in your application, use
       
  1685 
       
  1686     png_set_sig_bytes(png_ptr, 8);
       
  1687 
       
  1688 to inform libpng that it should not write a signature.
       
  1689 
       
  1690 Write callbacks
       
  1691 
       
  1692 At this point, you can set up a callback function that will be
       
  1693 called after each row has been written, which you can use to control
       
  1694 a progress meter or the like.  It's demonstrated in pngtest.c.
       
  1695 You must supply a function
       
  1696 
       
  1697     void write_row_callback(png_ptr, png_uint_32 row,
       
  1698        int pass);
       
  1699     {
       
  1700       /* put your code here */
       
  1701     }
       
  1702 
       
  1703 (You can give it another name that you like instead of "write_row_callback")
       
  1704 
       
  1705 To inform libpng about your function, use
       
  1706 
       
  1707     png_set_write_status_fn(png_ptr, write_row_callback);
       
  1708 
       
  1709 You now have the option of modifying how the compression library will
       
  1710 run.  The following functions are mainly for testing, but may be useful
       
  1711 in some cases, like if you need to write PNG files extremely fast and
       
  1712 are willing to give up some compression, or if you want to get the
       
  1713 maximum possible compression at the expense of slower writing.  If you
       
  1714 have no special needs in this area, let the library do what it wants by
       
  1715 not calling this function at all, as it has been tuned to deliver a good
       
  1716 speed/compression ratio. The second parameter to png_set_filter() is
       
  1717 the filter method, for which the only valid values are 0 (as of the
       
  1718 July 1999 PNG specification, version 1.2) or 64 (if you are writing
       
  1719 a PNG datastream that is to be embedded in a MNG datastream).  The third
       
  1720 parameter is a flag that indicates which filter type(s) are to be tested
       
  1721 for each scanline.  See the PNG specification for details on the specific
       
  1722 filter types.
       
  1723 
       
  1724 
       
  1725     /* turn on or off filtering, and/or choose
       
  1726        specific filters.  You can use either a single
       
  1727        PNG_FILTER_VALUE_NAME or the bitwise OR of one
       
  1728        or more PNG_FILTER_NAME masks. */
       
  1729     png_set_filter(png_ptr, 0,
       
  1730        PNG_FILTER_NONE  | PNG_FILTER_VALUE_NONE |
       
  1731        PNG_FILTER_SUB   | PNG_FILTER_VALUE_SUB  |
       
  1732        PNG_FILTER_UP    | PNG_FILTER_VALUE_UP   |
       
  1733        PNG_FILTER_AVG   | PNG_FILTER_VALUE_AVG  |
       
  1734        PNG_FILTER_PAETH | PNG_FILTER_VALUE_PAETH|
       
  1735        PNG_ALL_FILTERS);
       
  1736 
       
  1737 If an application
       
  1738 wants to start and stop using particular filters during compression,
       
  1739 it should start out with all of the filters (to ensure that the previous
       
  1740 row of pixels will be stored in case it's needed later), and then add
       
  1741 and remove them after the start of compression.
       
  1742 
       
  1743 If you are writing a PNG datastream that is to be embedded in a MNG
       
  1744 datastream, the second parameter can be either 0 or 64.
       
  1745 
       
  1746 The png_set_compression_*() functions interface to the zlib compression
       
  1747 library, and should mostly be ignored unless you really know what you are
       
  1748 doing.  The only generally useful call is png_set_compression_level()
       
  1749 which changes how much time zlib spends on trying to compress the image
       
  1750 data.  See the Compression Library (zlib.h and algorithm.txt, distributed
       
  1751 with zlib) for details on the compression levels.
       
  1752 
       
  1753     /* set the zlib compression level */
       
  1754     png_set_compression_level(png_ptr,
       
  1755         Z_BEST_COMPRESSION);
       
  1756 
       
  1757     /* set other zlib parameters */
       
  1758     png_set_compression_mem_level(png_ptr, 8);
       
  1759     png_set_compression_strategy(png_ptr,
       
  1760         Z_DEFAULT_STRATEGY);
       
  1761     png_set_compression_window_bits(png_ptr, 15);
       
  1762     png_set_compression_method(png_ptr, 8);
       
  1763     png_set_compression_buffer_size(png_ptr, 8192)
       
  1764 
       
  1765 extern PNG_EXPORT(void,png_set_zbuf_size)
       
  1766 
       
  1767 Setting the contents of info for output
       
  1768 
       
  1769 You now need to fill in the png_info structure with all the data you
       
  1770 wish to write before the actual image.  Note that the only thing you
       
  1771 are allowed to write after the image is the text chunks and the time
       
  1772 chunk (as of PNG Specification 1.2, anyway).  See png_write_end() and
       
  1773 the latest PNG specification for more information on that.  If you
       
  1774 wish to write them before the image, fill them in now, and flag that
       
  1775 data as being valid.  If you want to wait until after the data, don't
       
  1776 fill them until png_write_end().  For all the fields in png_info and
       
  1777 their data types, see png.h.  For explanations of what the fields
       
  1778 contain, see the PNG specification.
       
  1779 
       
  1780 Some of the more important parts of the png_info are:
       
  1781 
       
  1782     png_set_IHDR(png_ptr, info_ptr, width, height,
       
  1783        bit_depth, color_type, interlace_type,
       
  1784        compression_type, filter_method)
       
  1785     width          - holds the width of the image
       
  1786                      in pixels (up to 2^31).
       
  1787     height         - holds the height of the image
       
  1788                      in pixels (up to 2^31).
       
  1789     bit_depth      - holds the bit depth of one of the
       
  1790                      image channels.
       
  1791                      (valid values are 1, 2, 4, 8, 16
       
  1792                      and depend also on the
       
  1793                      color_type.  See also significant
       
  1794                      bits (sBIT) below).
       
  1795     color_type     - describes which color/alpha
       
  1796                      channels are present.
       
  1797                      PNG_COLOR_TYPE_GRAY
       
  1798                         (bit depths 1, 2, 4, 8, 16)
       
  1799                      PNG_COLOR_TYPE_GRAY_ALPHA
       
  1800                         (bit depths 8, 16)
       
  1801                      PNG_COLOR_TYPE_PALETTE
       
  1802                         (bit depths 1, 2, 4, 8)
       
  1803                      PNG_COLOR_TYPE_RGB
       
  1804                         (bit_depths 8, 16)
       
  1805                      PNG_COLOR_TYPE_RGB_ALPHA
       
  1806                         (bit_depths 8, 16)
       
  1807 
       
  1808                      PNG_COLOR_MASK_PALETTE
       
  1809                      PNG_COLOR_MASK_COLOR
       
  1810                      PNG_COLOR_MASK_ALPHA
       
  1811 
       
  1812     interlace_type - PNG_INTERLACE_NONE or
       
  1813                      PNG_INTERLACE_ADAM7
       
  1814     compression_type - (must be
       
  1815                      PNG_COMPRESSION_TYPE_DEFAULT)
       
  1816     filter_method  - (must be PNG_FILTER_TYPE_DEFAULT
       
  1817                      or, if you are writing a PNG to
       
  1818                      be embedded in a MNG datastream,
       
  1819                      can also be
       
  1820                      PNG_INTRAPIXEL_DIFFERENCING)
       
  1821 
       
  1822 If you call png_set_IHDR(), the call must appear before any of the
       
  1823 other png_set_*() functions, because they might require access to some of
       
  1824 the IHDR settings.  The remaining png_set_*() functions can be called
       
  1825 in any order.
       
  1826 
       
  1827 If you wish, you can reset the compression_type, interlace_type, or
       
  1828 filter_method later by calling png_set_IHDR() again; if you do this, the
       
  1829 width, height, bit_depth, and color_type must be the same in each call.
       
  1830 
       
  1831     png_set_PLTE(png_ptr, info_ptr, palette,
       
  1832        num_palette);
       
  1833     palette        - the palette for the file
       
  1834                      (array of png_color)
       
  1835     num_palette    - number of entries in the palette
       
  1836 
       
  1837     png_set_gAMA(png_ptr, info_ptr, gamma);
       
  1838     gamma          - the gamma the image was created
       
  1839                      at (PNG_INFO_gAMA)
       
  1840 
       
  1841     png_set_sRGB(png_ptr, info_ptr, srgb_intent);
       
  1842     srgb_intent    - the rendering intent
       
  1843                      (PNG_INFO_sRGB) The presence of
       
  1844                      the sRGB chunk means that the pixel
       
  1845                      data is in the sRGB color space.
       
  1846                      This chunk also implies specific
       
  1847                      values of gAMA and cHRM.  Rendering
       
  1848                      intent is the CSS-1 property that
       
  1849                      has been defined by the International
       
  1850                      Color Consortium
       
  1851                      (http://www.color.org).
       
  1852                      It can be one of
       
  1853                      PNG_sRGB_INTENT_SATURATION,
       
  1854                      PNG_sRGB_INTENT_PERCEPTUAL,
       
  1855                      PNG_sRGB_INTENT_ABSOLUTE, or
       
  1856                      PNG_sRGB_INTENT_RELATIVE.
       
  1857 
       
  1858 
       
  1859     png_set_sRGB_gAMA_and_cHRM(png_ptr, info_ptr,
       
  1860        srgb_intent);
       
  1861     srgb_intent    - the rendering intent
       
  1862                      (PNG_INFO_sRGB) The presence of the
       
  1863                      sRGB chunk means that the pixel
       
  1864                      data is in the sRGB color space.
       
  1865                      This function also causes gAMA and
       
  1866                      cHRM chunks with the specific values
       
  1867                      that are consistent with sRGB to be
       
  1868                      written.
       
  1869 
       
  1870     png_set_iCCP(png_ptr, info_ptr, name, compression_type,
       
  1871                       profile, proflen);
       
  1872     name            - The profile name.
       
  1873     compression     - The compression type; always
       
  1874                       PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
       
  1875                       You may give NULL to this argument to
       
  1876                       ignore it.
       
  1877     profile         - International Color Consortium color
       
  1878                       profile data. May contain NULs.
       
  1879     proflen         - length of profile data in bytes.
       
  1880 
       
  1881     png_set_sBIT(png_ptr, info_ptr, sig_bit);
       
  1882     sig_bit        - the number of significant bits for
       
  1883                      (PNG_INFO_sBIT) each of the gray, red,
       
  1884                      green, and blue channels, whichever are
       
  1885                      appropriate for the given color type
       
  1886                      (png_color_16)
       
  1887 
       
  1888     png_set_tRNS(png_ptr, info_ptr, trans_alpha,
       
  1889        num_trans, trans_color);
       
  1890     trans_alpha    - array of alpha (transparency)
       
  1891                      entries for palette (PNG_INFO_tRNS)
       
  1892     trans_color    - graylevel or color sample values
       
  1893                      (in order red, green, blue) of the
       
  1894                      single transparent color for
       
  1895                      non-paletted images (PNG_INFO_tRNS)
       
  1896     num_trans      - number of transparent entries
       
  1897                      (PNG_INFO_tRNS)
       
  1898 
       
  1899     png_set_hIST(png_ptr, info_ptr, hist);
       
  1900                     (PNG_INFO_hIST)
       
  1901     hist           - histogram of palette (array of
       
  1902                      png_uint_16)
       
  1903 
       
  1904     png_set_tIME(png_ptr, info_ptr, mod_time);
       
  1905     mod_time       - time image was last modified
       
  1906                      (PNG_VALID_tIME)
       
  1907 
       
  1908     png_set_bKGD(png_ptr, info_ptr, background);
       
  1909     background     - background color (PNG_VALID_bKGD)
       
  1910 
       
  1911     png_set_text(png_ptr, info_ptr, text_ptr, num_text);
       
  1912     text_ptr       - array of png_text holding image
       
  1913                      comments
       
  1914     text_ptr[i].compression - type of compression used
       
  1915                  on "text" PNG_TEXT_COMPRESSION_NONE
       
  1916                            PNG_TEXT_COMPRESSION_zTXt
       
  1917                            PNG_ITXT_COMPRESSION_NONE
       
  1918                            PNG_ITXT_COMPRESSION_zTXt
       
  1919     text_ptr[i].key   - keyword for comment.  Must contain
       
  1920                  1-79 characters.
       
  1921     text_ptr[i].text  - text comments for current
       
  1922                          keyword.  Can be NULL or empty.
       
  1923     text_ptr[i].text_length - length of text string,
       
  1924                  after decompression, 0 for iTXt
       
  1925     text_ptr[i].itxt_length - length of itxt string,
       
  1926                  after decompression, 0 for tEXt/zTXt
       
  1927     text_ptr[i].lang  - language of comment (NULL or
       
  1928                          empty for unknown).
       
  1929     text_ptr[i].translated_keyword  - keyword in UTF-8 (NULL
       
  1930                          or empty for unknown).
       
  1931     Note that the itxt_length, lang, and lang_key
       
  1932     members of the text_ptr structure only exist
       
  1933     when the library is built with iTXt chunk support.
       
  1934 
       
  1935     num_text       - number of comments
       
  1936 
       
  1937     png_set_sPLT(png_ptr, info_ptr, &palette_ptr,
       
  1938        num_spalettes);
       
  1939     palette_ptr    - array of png_sPLT_struct structures
       
  1940                      to be added to the list of palettes
       
  1941                      in the info structure.
       
  1942     num_spalettes  - number of palette structures to be
       
  1943                      added.
       
  1944 
       
  1945     png_set_oFFs(png_ptr, info_ptr, offset_x, offset_y,
       
  1946         unit_type);
       
  1947     offset_x  - positive offset from the left
       
  1948                      edge of the screen
       
  1949     offset_y  - positive offset from the top
       
  1950                      edge of the screen
       
  1951     unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
       
  1952 
       
  1953     png_set_pHYs(png_ptr, info_ptr, res_x, res_y,
       
  1954         unit_type);
       
  1955     res_x       - pixels/unit physical resolution
       
  1956                   in x direction
       
  1957     res_y       - pixels/unit physical resolution
       
  1958                   in y direction
       
  1959     unit_type   - PNG_RESOLUTION_UNKNOWN,
       
  1960                   PNG_RESOLUTION_METER
       
  1961 
       
  1962     png_set_sCAL(png_ptr, info_ptr, unit, width, height)
       
  1963     unit        - physical scale units (an integer)
       
  1964     width       - width of a pixel in physical scale units
       
  1965     height      - height of a pixel in physical scale units
       
  1966                   (width and height are doubles)
       
  1967 
       
  1968     png_set_sCAL_s(png_ptr, info_ptr, unit, width, height)
       
  1969     unit        - physical scale units (an integer)
       
  1970     width       - width of a pixel in physical scale units
       
  1971     height      - height of a pixel in physical scale units
       
  1972                  (width and height are strings like "2.54")
       
  1973 
       
  1974     png_set_unknown_chunks(png_ptr, info_ptr, &unknowns,
       
  1975        num_unknowns)
       
  1976     unknowns          - array of png_unknown_chunk
       
  1977                         structures holding unknown chunks
       
  1978     unknowns[i].name  - name of unknown chunk
       
  1979     unknowns[i].data  - data of unknown chunk
       
  1980     unknowns[i].size  - size of unknown chunk's data
       
  1981     unknowns[i].location - position to write chunk in file
       
  1982                            0: do not write chunk
       
  1983                            PNG_HAVE_IHDR: before PLTE
       
  1984                            PNG_HAVE_PLTE: before IDAT
       
  1985                            PNG_AFTER_IDAT: after IDAT
       
  1986 
       
  1987 The "location" member is set automatically according to
       
  1988 what part of the output file has already been written.
       
  1989 You can change its value after calling png_set_unknown_chunks()
       
  1990 as demonstrated in pngtest.c.  Within each of the "locations",
       
  1991 the chunks are sequenced according to their position in the
       
  1992 structure (that is, the value of "i", which is the order in which
       
  1993 the chunk was either read from the input file or defined with
       
  1994 png_set_unknown_chunks).
       
  1995 
       
  1996 A quick word about text and num_text.  text is an array of png_text
       
  1997 structures.  num_text is the number of valid structures in the array.
       
  1998 Each png_text structure holds a language code, a keyword, a text value,
       
  1999 and a compression type.
       
  2000 
       
  2001 The compression types have the same valid numbers as the compression
       
  2002 types of the image data.  Currently, the only valid number is zero.
       
  2003 However, you can store text either compressed or uncompressed, unlike
       
  2004 images, which always have to be compressed.  So if you don't want the
       
  2005 text compressed, set the compression type to PNG_TEXT_COMPRESSION_NONE.
       
  2006 Because tEXt and zTXt chunks don't have a language field, if you
       
  2007 specify PNG_TEXT_COMPRESSION_NONE or PNG_TEXT_COMPRESSION_zTXt
       
  2008 any language code or translated keyword will not be written out.
       
  2009 
       
  2010 Until text gets around 1000 bytes, it is not worth compressing it.
       
  2011 After the text has been written out to the file, the compression type
       
  2012 is set to PNG_TEXT_COMPRESSION_NONE_WR or PNG_TEXT_COMPRESSION_zTXt_WR,
       
  2013 so that it isn't written out again at the end (in case you are calling
       
  2014 png_write_end() with the same struct.
       
  2015 
       
  2016 The keywords that are given in the PNG Specification are:
       
  2017 
       
  2018     Title            Short (one line) title or
       
  2019                      caption for image
       
  2020     Author           Name of image's creator
       
  2021     Description      Description of image (possibly long)
       
  2022     Copyright        Copyright notice
       
  2023     Creation Time    Time of original image creation
       
  2024                      (usually RFC 1123 format, see below)
       
  2025     Software         Software used to create the image
       
  2026     Disclaimer       Legal disclaimer
       
  2027     Warning          Warning of nature of content
       
  2028     Source           Device used to create the image
       
  2029     Comment          Miscellaneous comment; conversion
       
  2030                      from other image format
       
  2031 
       
  2032 The keyword-text pairs work like this.  Keywords should be short
       
  2033 simple descriptions of what the comment is about.  Some typical
       
  2034 keywords are found in the PNG specification, as is some recommendations
       
  2035 on keywords.  You can repeat keywords in a file.  You can even write
       
  2036 some text before the image and some after.  For example, you may want
       
  2037 to put a description of the image before the image, but leave the
       
  2038 disclaimer until after, so viewers working over modem connections
       
  2039 don't have to wait for the disclaimer to go over the modem before
       
  2040 they start seeing the image.  Finally, keywords should be full
       
  2041 words, not abbreviations.  Keywords and text are in the ISO 8859-1
       
  2042 (Latin-1) character set (a superset of regular ASCII) and can not
       
  2043 contain NUL characters, and should not contain control or other
       
  2044 unprintable characters.  To make the comments widely readable, stick
       
  2045 with basic ASCII, and avoid machine specific character set extensions
       
  2046 like the IBM-PC character set.  The keyword must be present, but
       
  2047 you can leave off the text string on non-compressed pairs.
       
  2048 Compressed pairs must have a text string, as only the text string
       
  2049 is compressed anyway, so the compression would be meaningless.
       
  2050 
       
  2051 PNG supports modification time via the png_time structure.  Two
       
  2052 conversion routines are provided, png_convert_from_time_t() for
       
  2053 time_t and png_convert_from_struct_tm() for struct tm.  The
       
  2054 time_t routine uses gmtime().  You don't have to use either of
       
  2055 these, but if you wish to fill in the png_time structure directly,
       
  2056 you should provide the time in universal time (GMT) if possible
       
  2057 instead of your local time.  Note that the year number is the full
       
  2058 year (e.g. 1998, rather than 98 - PNG is year 2000 compliant!), and
       
  2059 that months start with 1.
       
  2060 
       
  2061 If you want to store the time of the original image creation, you should
       
  2062 use a plain tEXt chunk with the "Creation Time" keyword.  This is
       
  2063 necessary because the "creation time" of a PNG image is somewhat vague,
       
  2064 depending on whether you mean the PNG file, the time the image was
       
  2065 created in a non-PNG format, a still photo from which the image was
       
  2066 scanned, or possibly the subject matter itself.  In order to facilitate
       
  2067 machine-readable dates, it is recommended that the "Creation Time"
       
  2068 tEXt chunk use RFC 1123 format dates (e.g. "22 May 1997 18:07:10 GMT"),
       
  2069 although this isn't a requirement.  Unlike the tIME chunk, the
       
  2070 "Creation Time" tEXt chunk is not expected to be automatically changed
       
  2071 by the software.  To facilitate the use of RFC 1123 dates, a function
       
  2072 png_convert_to_rfc1123(png_timep) is provided to convert from PNG
       
  2073 time to an RFC 1123 format string.
       
  2074 
       
  2075 Writing unknown chunks
       
  2076 
       
  2077 You can use the png_set_unknown_chunks function to queue up chunks
       
  2078 for writing.  You give it a chunk name, raw data, and a size; that's
       
  2079 all there is to it.  The chunks will be written by the next following
       
  2080 png_write_info_before_PLTE, png_write_info, or png_write_end function.
       
  2081 Any chunks previously read into the info structure's unknown-chunk
       
  2082 list will also be written out in a sequence that satisfies the PNG
       
  2083 specification's ordering rules.
       
  2084 
       
  2085 The high-level write interface
       
  2086 
       
  2087 At this point there are two ways to proceed; through the high-level
       
  2088 write interface, or through a sequence of low-level write operations.
       
  2089 You can use the high-level interface if your image data is present
       
  2090 in the info structure.  All defined output
       
  2091 transformations are permitted, enabled by the following masks.
       
  2092 
       
  2093     PNG_TRANSFORM_IDENTITY      No transformation
       
  2094     PNG_TRANSFORM_PACKING       Pack 1, 2 and 4-bit samples
       
  2095     PNG_TRANSFORM_PACKSWAP      Change order of packed
       
  2096                                 pixels to LSB first
       
  2097     PNG_TRANSFORM_INVERT_MONO   Invert monochrome images
       
  2098     PNG_TRANSFORM_SHIFT         Normalize pixels to the
       
  2099                                 sBIT depth
       
  2100     PNG_TRANSFORM_BGR           Flip RGB to BGR, RGBA
       
  2101                                 to BGRA
       
  2102     PNG_TRANSFORM_SWAP_ALPHA    Flip RGBA to ARGB or GA
       
  2103                                 to AG
       
  2104     PNG_TRANSFORM_INVERT_ALPHA  Change alpha from opacity
       
  2105                                 to transparency
       
  2106     PNG_TRANSFORM_SWAP_ENDIAN   Byte-swap 16-bit samples
       
  2107     PNG_TRANSFORM_STRIP_FILLER        Strip out filler
       
  2108                                       bytes (deprecated).
       
  2109     PNG_TRANSFORM_STRIP_FILLER_BEFORE Strip out leading
       
  2110                                       filler bytes
       
  2111     PNG_TRANSFORM_STRIP_FILLER_AFTER  Strip out trailing
       
  2112                                       filler bytes
       
  2113 
       
  2114 If you have valid image data in the info structure (you can use
       
  2115 png_set_rows() to put image data in the info structure), simply do this:
       
  2116 
       
  2117     png_write_png(png_ptr, info_ptr, png_transforms, NULL)
       
  2118 
       
  2119 where png_transforms is an integer containing the bitwise OR of some set of
       
  2120 transformation flags.  This call is equivalent to png_write_info(),
       
  2121 followed the set of transformations indicated by the transform mask,
       
  2122 then png_write_image(), and finally png_write_end().
       
  2123 
       
  2124 (The final parameter of this call is not yet used.  Someday it might point
       
  2125 to transformation parameters required by some future output transform.)
       
  2126 
       
  2127 You must use png_transforms and not call any png_set_transform() functions
       
  2128 when you use png_write_png().
       
  2129 
       
  2130 The low-level write interface
       
  2131 
       
  2132 If you are going the low-level route instead, you are now ready to
       
  2133 write all the file information up to the actual image data.  You do
       
  2134 this with a call to png_write_info().
       
  2135 
       
  2136     png_write_info(png_ptr, info_ptr);
       
  2137 
       
  2138 Note that there is one transformation you may need to do before
       
  2139 png_write_info().  In PNG files, the alpha channel in an image is the
       
  2140 level of opacity.  If your data is supplied as a level of transparency,
       
  2141 you can invert the alpha channel before you write it, so that 0 is
       
  2142 fully transparent and 255 (in 8-bit or paletted images) or 65535
       
  2143 (in 16-bit images) is fully opaque, with
       
  2144 
       
  2145     png_set_invert_alpha(png_ptr);
       
  2146 
       
  2147 This must appear before png_write_info() instead of later with the
       
  2148 other transformations because in the case of paletted images the tRNS
       
  2149 chunk data has to be inverted before the tRNS chunk is written.  If
       
  2150 your image is not a paletted image, the tRNS data (which in such cases
       
  2151 represents a single color to be rendered as transparent) won't need to
       
  2152 be changed, and you can safely do this transformation after your
       
  2153 png_write_info() call.
       
  2154 
       
  2155 If you need to write a private chunk that you want to appear before
       
  2156 the PLTE chunk when PLTE is present, you can write the PNG info in
       
  2157 two steps, and insert code to write your own chunk between them:
       
  2158 
       
  2159     png_write_info_before_PLTE(png_ptr, info_ptr);
       
  2160     png_set_unknown_chunks(png_ptr, info_ptr, ...);
       
  2161     png_write_info(png_ptr, info_ptr);
       
  2162 
       
  2163 After you've written the file information, you can set up the library
       
  2164 to handle any special transformations of the image data.  The various
       
  2165 ways to transform the data will be described in the order that they
       
  2166 should occur.  This is important, as some of these change the color
       
  2167 type and/or bit depth of the data, and some others only work on
       
  2168 certain color types and bit depths.  Even though each transformation
       
  2169 checks to see if it has data that it can do something with, you should
       
  2170 make sure to only enable a transformation if it will be valid for the
       
  2171 data.  For example, don't swap red and blue on grayscale data.
       
  2172 
       
  2173 PNG files store RGB pixels packed into 3 or 6 bytes.  This code tells
       
  2174 the library to strip input data that has 4 or 8 bytes per pixel down
       
  2175 to 3 or 6 bytes (or strip 2 or 4-byte grayscale+filler data to 1 or 2
       
  2176 bytes per pixel).
       
  2177 
       
  2178     png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
       
  2179 
       
  2180 where the 0 is unused, and the location is either PNG_FILLER_BEFORE or
       
  2181 PNG_FILLER_AFTER, depending upon whether the filler byte in the pixel
       
  2182 is stored XRGB or RGBX.
       
  2183 
       
  2184 PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
       
  2185 they can, resulting in, for example, 8 pixels per byte for 1 bit files.
       
  2186 If the data is supplied at 1 pixel per byte, use this code, which will
       
  2187 correctly pack the pixels into a single byte:
       
  2188 
       
  2189     png_set_packing(png_ptr);
       
  2190 
       
  2191 PNG files reduce possible bit depths to 1, 2, 4, 8, and 16.  If your
       
  2192 data is of another bit depth, you can write an sBIT chunk into the
       
  2193 file so that decoders can recover the original data if desired.
       
  2194 
       
  2195     /* Set the true bit depth of the image data */
       
  2196     if (color_type & PNG_COLOR_MASK_COLOR)
       
  2197     {
       
  2198         sig_bit.red = true_bit_depth;
       
  2199         sig_bit.green = true_bit_depth;
       
  2200         sig_bit.blue = true_bit_depth;
       
  2201     }
       
  2202     else
       
  2203     {
       
  2204         sig_bit.gray = true_bit_depth;
       
  2205     }
       
  2206     if (color_type & PNG_COLOR_MASK_ALPHA)
       
  2207     {
       
  2208         sig_bit.alpha = true_bit_depth;
       
  2209     }
       
  2210 
       
  2211     png_set_sBIT(png_ptr, info_ptr, &sig_bit);
       
  2212 
       
  2213 If the data is stored in the row buffer in a bit depth other than
       
  2214 one supported by PNG (e.g. 3 bit data in the range 0-7 for a 4-bit PNG),
       
  2215 this will scale the values to appear to be the correct bit depth as
       
  2216 is required by PNG.
       
  2217 
       
  2218     png_set_shift(png_ptr, &sig_bit);
       
  2219 
       
  2220 PNG files store 16 bit pixels in network byte order (big-endian,
       
  2221 ie. most significant bits first).  This code would be used if they are
       
  2222 supplied the other way (little-endian, i.e. least significant bits
       
  2223 first, the way PCs store them):
       
  2224 
       
  2225     if (bit_depth > 8)
       
  2226        png_set_swap(png_ptr);
       
  2227 
       
  2228 If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
       
  2229 need to change the order the pixels are packed into bytes, you can use:
       
  2230 
       
  2231     if (bit_depth < 8)
       
  2232        png_set_packswap(png_ptr);
       
  2233 
       
  2234 PNG files store 3 color pixels in red, green, blue order.  This code
       
  2235 would be used if they are supplied as blue, green, red:
       
  2236 
       
  2237     png_set_bgr(png_ptr);
       
  2238 
       
  2239 PNG files describe monochrome as black being zero and white being
       
  2240 one. This code would be used if the pixels are supplied with this reversed
       
  2241 (black being one and white being zero):
       
  2242 
       
  2243     png_set_invert_mono(png_ptr);
       
  2244 
       
  2245 Finally, you can write your own transformation function if none of
       
  2246 the existing ones meets your needs.  This is done by setting a callback
       
  2247 with
       
  2248 
       
  2249     png_set_write_user_transform_fn(png_ptr,
       
  2250        write_transform_fn);
       
  2251 
       
  2252 You must supply the function
       
  2253 
       
  2254     void write_transform_fn(png_ptr ptr, row_info_ptr
       
  2255        row_info, png_bytep data)
       
  2256 
       
  2257 See pngtest.c for a working example.  Your function will be called
       
  2258 before any of the other transformations are processed.
       
  2259 
       
  2260 You can also set up a pointer to a user structure for use by your
       
  2261 callback function.
       
  2262 
       
  2263     png_set_user_transform_info(png_ptr, user_ptr, 0, 0);
       
  2264 
       
  2265 The user_channels and user_depth parameters of this function are ignored
       
  2266 when writing; you can set them to zero as shown.
       
  2267 
       
  2268 You can retrieve the pointer via the function png_get_user_transform_ptr().
       
  2269 For example:
       
  2270 
       
  2271     voidp write_user_transform_ptr =
       
  2272        png_get_user_transform_ptr(png_ptr);
       
  2273 
       
  2274 It is possible to have libpng flush any pending output, either manually,
       
  2275 or automatically after a certain number of lines have been written.  To
       
  2276 flush the output stream a single time call:
       
  2277 
       
  2278     png_write_flush(png_ptr);
       
  2279 
       
  2280 and to have libpng flush the output stream periodically after a certain
       
  2281 number of scanlines have been written, call:
       
  2282 
       
  2283     png_set_flush(png_ptr, nrows);
       
  2284 
       
  2285 Note that the distance between rows is from the last time png_write_flush()
       
  2286 was called, or the first row of the image if it has never been called.
       
  2287 So if you write 50 lines, and then png_set_flush 25, it will flush the
       
  2288 output on the next scanline, and every 25 lines thereafter, unless
       
  2289 png_write_flush() is called before 25 more lines have been written.
       
  2290 If nrows is too small (less than about 10 lines for a 640 pixel wide
       
  2291 RGB image) the image compression may decrease noticeably (although this
       
  2292 may be acceptable for real-time applications).  Infrequent flushing will
       
  2293 only degrade the compression performance by a few percent over images
       
  2294 that do not use flushing.
       
  2295 
       
  2296 Writing the image data
       
  2297 
       
  2298 That's it for the transformations.  Now you can write the image data.
       
  2299 The simplest way to do this is in one function call.  If you have the
       
  2300 whole image in memory, you can just call png_write_image() and libpng
       
  2301 will write the image.  You will need to pass in an array of pointers to
       
  2302 each row.  This function automatically handles interlacing, so you don't
       
  2303 need to call png_set_interlace_handling() or call this function multiple
       
  2304 times, or any of that other stuff necessary with png_write_rows().
       
  2305 
       
  2306     png_write_image(png_ptr, row_pointers);
       
  2307 
       
  2308 where row_pointers is:
       
  2309 
       
  2310     png_byte *row_pointers[height];
       
  2311 
       
  2312 You can point to void or char or whatever you use for pixels.
       
  2313 
       
  2314 If you don't want to write the whole image at once, you can
       
  2315 use png_write_rows() instead.  If the file is not interlaced,
       
  2316 this is simple:
       
  2317 
       
  2318     png_write_rows(png_ptr, row_pointers,
       
  2319        number_of_rows);
       
  2320 
       
  2321 row_pointers is the same as in the png_write_image() call.
       
  2322 
       
  2323 If you are just writing one row at a time, you can do this with
       
  2324 a single row_pointer instead of an array of row_pointers:
       
  2325 
       
  2326     png_bytep row_pointer = row;
       
  2327 
       
  2328     png_write_row(png_ptr, row_pointer);
       
  2329 
       
  2330 When the file is interlaced, things can get a good deal more complicated.
       
  2331 The only currently (as of the PNG Specification version 1.2, dated July
       
  2332 1999) defined interlacing scheme for PNG files is the "Adam7" interlace
       
  2333 scheme, that breaks down an image into seven smaller images of varying
       
  2334 size.  libpng will build these images for you, or you can do them
       
  2335 yourself.  If you want to build them yourself, see the PNG specification
       
  2336 for details of which pixels to write when.
       
  2337 
       
  2338 If you don't want libpng to handle the interlacing details, just
       
  2339 use png_set_interlace_handling() and call png_write_rows() the
       
  2340 correct number of times to write all seven sub-images.
       
  2341 
       
  2342 If you want libpng to build the sub-images, call this before you start
       
  2343 writing any rows:
       
  2344 
       
  2345     number_of_passes =
       
  2346        png_set_interlace_handling(png_ptr);
       
  2347 
       
  2348 This will return the number of passes needed.  Currently, this is seven,
       
  2349 but may change if another interlace type is added.
       
  2350 
       
  2351 Then write the complete image number_of_passes times.
       
  2352 
       
  2353     png_write_rows(png_ptr, row_pointers,
       
  2354        number_of_rows);
       
  2355 
       
  2356 As some of these rows are not used, and thus return immediately, you may
       
  2357 want to read about interlacing in the PNG specification, and only update
       
  2358 the rows that are actually used.
       
  2359 
       
  2360 Finishing a sequential write
       
  2361 
       
  2362 After you are finished writing the image, you should finish writing
       
  2363 the file.  If you are interested in writing comments or time, you should
       
  2364 pass an appropriately filled png_info pointer.  If you are not interested,
       
  2365 you can pass NULL.
       
  2366 
       
  2367     png_write_end(png_ptr, info_ptr);
       
  2368 
       
  2369 When you are done, you can free all memory used by libpng like this:
       
  2370 
       
  2371     png_destroy_write_struct(&png_ptr, &info_ptr);
       
  2372 
       
  2373 It is also possible to individually free the info_ptr members that
       
  2374 point to libpng-allocated storage with the following function:
       
  2375 
       
  2376     png_free_data(png_ptr, info_ptr, mask, seq)
       
  2377     mask  - identifies data to be freed, a mask
       
  2378             containing the bitwise OR of one or
       
  2379             more of
       
  2380               PNG_FREE_PLTE, PNG_FREE_TRNS,
       
  2381               PNG_FREE_HIST, PNG_FREE_ICCP,
       
  2382               PNG_FREE_PCAL, PNG_FREE_ROWS,
       
  2383               PNG_FREE_SCAL, PNG_FREE_SPLT,
       
  2384               PNG_FREE_TEXT, PNG_FREE_UNKN,
       
  2385             or simply PNG_FREE_ALL
       
  2386     seq   - sequence number of item to be freed
       
  2387             (-1 for all items)
       
  2388 
       
  2389 This function may be safely called when the relevant storage has
       
  2390 already been freed, or has not yet been allocated, or was allocated
       
  2391 by the user  and not by libpng,  and will in those cases do nothing.
       
  2392 The "seq" parameter is ignored if only one item of the selected data
       
  2393 type, such as PLTE, is allowed.  If "seq" is not -1, and multiple items
       
  2394 are allowed for the data type identified in the mask, such as text or
       
  2395 sPLT, only the n'th item in the structure is freed, where n is "seq".
       
  2396 
       
  2397 If you allocated data such as a palette that you passed in to libpng
       
  2398 with png_set_*, you must not free it until just before the call to
       
  2399 png_destroy_write_struct().
       
  2400 
       
  2401 The default behavior is only to free data that was allocated internally
       
  2402 by libpng.  This can be changed, so that libpng will not free the data,
       
  2403 or so that it will free data that was allocated by the user with png_malloc()
       
  2404 or png_zalloc() and passed in via a png_set_*() function, with
       
  2405 
       
  2406     png_data_freer(png_ptr, info_ptr, freer, mask)
       
  2407     mask   - which data elements are affected
       
  2408              same choices as in png_free_data()
       
  2409     freer  - one of
       
  2410                PNG_DESTROY_WILL_FREE_DATA
       
  2411                PNG_SET_WILL_FREE_DATA
       
  2412                PNG_USER_WILL_FREE_DATA
       
  2413 
       
  2414 For example, to transfer responsibility for some data from a read structure
       
  2415 to a write structure, you could use
       
  2416 
       
  2417     png_data_freer(read_ptr, read_info_ptr,
       
  2418        PNG_USER_WILL_FREE_DATA,
       
  2419        PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
       
  2420     png_data_freer(write_ptr, write_info_ptr,
       
  2421        PNG_DESTROY_WILL_FREE_DATA,
       
  2422        PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
       
  2423 
       
  2424 thereby briefly reassigning responsibility for freeing to the user but
       
  2425 immediately afterwards reassigning it once more to the write_destroy
       
  2426 function.  Having done this, it would then be safe to destroy the read
       
  2427 structure and continue to use the PLTE, tRNS, and hIST data in the write
       
  2428 structure.
       
  2429 
       
  2430 This function only affects data that has already been allocated.
       
  2431 You can call this function before calling after the png_set_*() functions
       
  2432 to control whether the user or png_destroy_*() is supposed to free the data.
       
  2433 When the user assumes responsibility for libpng-allocated data, the
       
  2434 application must use
       
  2435 png_free() to free it, and when the user transfers responsibility to libpng
       
  2436 for data that the user has allocated, the user must have used png_malloc()
       
  2437 or png_zalloc() to allocate it.
       
  2438 
       
  2439 If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
       
  2440 separately, do not transfer responsibility for freeing text_ptr to libpng,
       
  2441 because when libpng fills a png_text structure it combines these members with
       
  2442 the key member, and png_free_data() will free only text_ptr.key.  Similarly,
       
  2443 if you transfer responsibility for free'ing text_ptr from libpng to your
       
  2444 application, your application must not separately free those members.
       
  2445 For a more compact example of writing a PNG image, see the file example.c.
       
  2446 
       
  2447 V. Modifying/Customizing libpng:
       
  2448 
       
  2449 There are two issues here.  The first is changing how libpng does
       
  2450 standard things like memory allocation, input/output, and error handling.
       
  2451 The second deals with more complicated things like adding new chunks,
       
  2452 adding new transformations, and generally changing how libpng works.
       
  2453 Both of those are compile-time issues; that is, they are generally
       
  2454 determined at the time the code is written, and there is rarely a need
       
  2455 to provide the user with a means of changing them.
       
  2456 
       
  2457 Memory allocation, input/output, and error handling
       
  2458 
       
  2459 All of the memory allocation, input/output, and error handling in libpng
       
  2460 goes through callbacks that are user-settable.  The default routines are
       
  2461 in pngmem.c, pngrio.c, pngwio.c, and pngerror.c, respectively.  To change
       
  2462 these functions, call the appropriate png_set_*_fn() function.
       
  2463 
       
  2464 Memory allocation is done through the functions png_malloc(), png_calloc(),
       
  2465 and png_free().  These currently just call the standard C functions.
       
  2466 png_calloc() calls png_malloc() and then png_memset() to clear the newly
       
  2467 allocated memory to zero.  If your pointers can't access more then 64K
       
  2468 at a time, you will want to set MAXSEG_64K in zlib.h.  Since it is
       
  2469 unlikely that the method of handling memory allocation on a platform
       
  2470 will change between applications, these functions must be modified in
       
  2471 the library at compile time.  If you prefer to use a different method
       
  2472 of allocating and freeing data, you can use png_create_read_struct_2() or
       
  2473 png_create_write_struct_2() to register your own functions as described
       
  2474 above.  These functions also provide a void pointer that can be retrieved
       
  2475 via
       
  2476 
       
  2477     mem_ptr=png_get_mem_ptr(png_ptr);
       
  2478 
       
  2479 Your replacement memory functions must have prototypes as follows:
       
  2480 
       
  2481     png_voidp malloc_fn(png_structp png_ptr,
       
  2482        png_size_t size);
       
  2483     void free_fn(png_structp png_ptr, png_voidp ptr);
       
  2484 
       
  2485 Your malloc_fn() must return NULL in case of failure.  The png_malloc()
       
  2486 function will normally call png_error() if it receives a NULL from the
       
  2487 system memory allocator or from your replacement malloc_fn().
       
  2488 
       
  2489 Your free_fn() will never be called with a NULL ptr, since libpng's
       
  2490 png_free() checks for NULL before calling free_fn().
       
  2491 
       
  2492 Input/Output in libpng is done through png_read() and png_write(),
       
  2493 which currently just call fread() and fwrite().  The FILE * is stored in
       
  2494 png_struct and is initialized via png_init_io().  If you wish to change
       
  2495 the method of I/O, the library supplies callbacks that you can set
       
  2496 through the function png_set_read_fn() and png_set_write_fn() at run
       
  2497 time, instead of calling the png_init_io() function.  These functions
       
  2498 also provide a void pointer that can be retrieved via the function
       
  2499 png_get_io_ptr().  For example:
       
  2500 
       
  2501     png_set_read_fn(png_structp read_ptr,
       
  2502         voidp read_io_ptr, png_rw_ptr read_data_fn)
       
  2503 
       
  2504     png_set_write_fn(png_structp write_ptr,
       
  2505         voidp write_io_ptr, png_rw_ptr write_data_fn,
       
  2506         png_flush_ptr output_flush_fn);
       
  2507 
       
  2508     voidp read_io_ptr = png_get_io_ptr(read_ptr);
       
  2509     voidp write_io_ptr = png_get_io_ptr(write_ptr);
       
  2510 
       
  2511 The replacement I/O functions must have prototypes as follows:
       
  2512 
       
  2513     void user_read_data(png_structp png_ptr,
       
  2514         png_bytep data, png_size_t length);
       
  2515     void user_write_data(png_structp png_ptr,
       
  2516         png_bytep data, png_size_t length);
       
  2517     void user_flush_data(png_structp png_ptr);
       
  2518 
       
  2519 The user_read_data() function is responsible for detecting and
       
  2520 handling end-of-data errors.
       
  2521 
       
  2522 Supplying NULL for the read, write, or flush functions sets them back
       
  2523 to using the default C stream functions, which expect the io_ptr to
       
  2524 point to a standard *FILE structure.  It is probably a mistake
       
  2525 to use NULL for one of write_data_fn and output_flush_fn but not both
       
  2526 of them, unless you have built libpng with PNG_NO_WRITE_FLUSH defined.
       
  2527 It is an error to read from a write stream, and vice versa.
       
  2528 
       
  2529 Error handling in libpng is done through png_error() and png_warning().
       
  2530 Errors handled through png_error() are fatal, meaning that png_error()
       
  2531 should never return to its caller.  Currently, this is handled via
       
  2532 setjmp() and longjmp() (unless you have compiled libpng with
       
  2533 PNG_SETJMP_NOT_SUPPORTED, in which case it is handled via PNG_ABORT()),
       
  2534 but you could change this to do things like exit() if you should wish.
       
  2535 
       
  2536 On non-fatal errors, png_warning() is called
       
  2537 to print a warning message, and then control returns to the calling code.
       
  2538 By default png_error() and png_warning() print a message on stderr via
       
  2539 fprintf() unless the library is compiled with PNG_NO_CONSOLE_IO defined
       
  2540 (because you don't want the messages) or PNG_NO_STDIO defined (because
       
  2541 fprintf() isn't available).  If you wish to change the behavior of the error
       
  2542 functions, you will need to set up your own message callbacks.  These
       
  2543 functions are normally supplied at the time that the png_struct is created.
       
  2544 It is also possible to redirect errors and warnings to your own replacement
       
  2545 functions after png_create_*_struct() has been called by calling:
       
  2546 
       
  2547     png_set_error_fn(png_structp png_ptr,
       
  2548         png_voidp error_ptr, png_error_ptr error_fn,
       
  2549         png_error_ptr warning_fn);
       
  2550 
       
  2551     png_voidp error_ptr = png_get_error_ptr(png_ptr);
       
  2552 
       
  2553 If NULL is supplied for either error_fn or warning_fn, then the libpng
       
  2554 default function will be used, calling fprintf() and/or longjmp() if a
       
  2555 problem is encountered.  The replacement error functions should have
       
  2556 parameters as follows:
       
  2557 
       
  2558     void user_error_fn(png_structp png_ptr,
       
  2559         png_const_charp error_msg);
       
  2560     void user_warning_fn(png_structp png_ptr,
       
  2561         png_const_charp warning_msg);
       
  2562 
       
  2563 The motivation behind using setjmp() and longjmp() is the C++ throw and
       
  2564 catch exception handling methods.  This makes the code much easier to write,
       
  2565 as there is no need to check every return code of every function call.
       
  2566 However, there are some uncertainties about the status of local variables
       
  2567 after a longjmp, so the user may want to be careful about doing anything
       
  2568 after setjmp returns non-zero besides returning itself.  Consult your
       
  2569 compiler documentation for more details.  For an alternative approach, you
       
  2570 may wish to use the "cexcept" facility (see http://cexcept.sourceforge.net).
       
  2571 
       
  2572 Custom chunks
       
  2573 
       
  2574 If you need to read or write custom chunks, you may need to get deeper
       
  2575 into the libpng code.  The library now has mechanisms for storing
       
  2576 and writing chunks of unknown type; you can even declare callbacks
       
  2577 for custom chunks.  However, this may not be good enough if the
       
  2578 library code itself needs to know about interactions between your
       
  2579 chunk and existing `intrinsic' chunks.
       
  2580 
       
  2581 If you need to write a new intrinsic chunk, first read the PNG
       
  2582 specification. Acquire a first level of understanding of how it works.
       
  2583 Pay particular attention to the sections that describe chunk names,
       
  2584 and look at how other chunks were designed, so you can do things
       
  2585 similarly.  Second, check out the sections of libpng that read and
       
  2586 write chunks.  Try to find a chunk that is similar to yours and use
       
  2587 it as a template.  More details can be found in the comments inside
       
  2588 the code.  It is best to handle unknown chunks in a generic method,
       
  2589 via callback functions, instead of by modifying libpng functions.
       
  2590 
       
  2591 If you wish to write your own transformation for the data, look through
       
  2592 the part of the code that does the transformations, and check out some of
       
  2593 the simpler ones to get an idea of how they work.  Try to find a similar
       
  2594 transformation to the one you want to add and copy off of it.  More details
       
  2595 can be found in the comments inside the code itself.
       
  2596 
       
  2597 Configuring for 16 bit platforms
       
  2598 
       
  2599 You will want to look into zconf.h to tell zlib (and thus libpng) that
       
  2600 it cannot allocate more then 64K at a time.  Even if you can, the memory
       
  2601 won't be accessible.  So limit zlib and libpng to 64K by defining MAXSEG_64K.
       
  2602 
       
  2603 Configuring for DOS
       
  2604 
       
  2605 For DOS users who only have access to the lower 640K, you will
       
  2606 have to limit zlib's memory usage via a png_set_compression_mem_level()
       
  2607 call.  See zlib.h or zconf.h in the zlib library for more information.
       
  2608 
       
  2609 Configuring for Medium Model
       
  2610 
       
  2611 Libpng's support for medium model has been tested on most of the popular
       
  2612 compilers.  Make sure MAXSEG_64K gets defined, USE_FAR_KEYWORD gets
       
  2613 defined, and FAR gets defined to far in pngconf.h, and you should be
       
  2614 all set.  Everything in the library (except for zlib's structure) is
       
  2615 expecting far data.  You must use the typedefs with the p or pp on
       
  2616 the end for pointers (or at least look at them and be careful).  Make
       
  2617 note that the rows of data are defined as png_bytepp, which is an
       
  2618 unsigned char far * far *.
       
  2619 
       
  2620 Configuring for gui/windowing platforms:
       
  2621 
       
  2622 You will need to write new error and warning functions that use the GUI
       
  2623 interface, as described previously, and set them to be the error and
       
  2624 warning functions at the time that png_create_*_struct() is called,
       
  2625 in order to have them available during the structure initialization.
       
  2626 They can be changed later via png_set_error_fn().  On some compilers,
       
  2627 you may also have to change the memory allocators (png_malloc, etc.).
       
  2628 
       
  2629 Configuring for compiler xxx:
       
  2630 
       
  2631 All includes for libpng are in pngconf.h.  If you need to add, change
       
  2632 or delete an include, this is the place to do it.
       
  2633 The includes that are not needed outside libpng are placed in pngpriv.h,
       
  2634 which is only used by the routines inside libpng itself.
       
  2635 The files in libpng proper only include pngpriv.h and png.h, which
       
  2636 in turn includes pngconf.h.
       
  2637 
       
  2638 Configuring zlib:
       
  2639 
       
  2640 There are special functions to configure the compression.  Perhaps the
       
  2641 most useful one changes the compression level, which currently uses
       
  2642 input compression values in the range 0 - 9.  The library normally
       
  2643 uses the default compression level (Z_DEFAULT_COMPRESSION = 6).  Tests
       
  2644 have shown that for a large majority of images, compression values in
       
  2645 the range 3-6 compress nearly as well as higher levels, and do so much
       
  2646 faster.  For online applications it may be desirable to have maximum speed
       
  2647 (Z_BEST_SPEED = 1).  With versions of zlib after v0.99, you can also
       
  2648 specify no compression (Z_NO_COMPRESSION = 0), but this would create
       
  2649 files larger than just storing the raw bitmap.  You can specify the
       
  2650 compression level by calling:
       
  2651 
       
  2652     png_set_compression_level(png_ptr, level);
       
  2653 
       
  2654 Another useful one is to reduce the memory level used by the library.
       
  2655 The memory level defaults to 8, but it can be lowered if you are
       
  2656 short on memory (running DOS, for example, where you only have 640K).
       
  2657 Note that the memory level does have an effect on compression; among
       
  2658 other things, lower levels will result in sections of incompressible
       
  2659 data being emitted in smaller stored blocks, with a correspondingly
       
  2660 larger relative overhead of up to 15% in the worst case.
       
  2661 
       
  2662     png_set_compression_mem_level(png_ptr, level);
       
  2663 
       
  2664 The other functions are for configuring zlib.  They are not recommended
       
  2665 for normal use and may result in writing an invalid PNG file.  See
       
  2666 zlib.h for more information on what these mean.
       
  2667 
       
  2668     png_set_compression_strategy(png_ptr,
       
  2669         strategy);
       
  2670     png_set_compression_window_bits(png_ptr,
       
  2671         window_bits);
       
  2672     png_set_compression_method(png_ptr, method);
       
  2673     png_set_compression_buffer_size(png_ptr, size);
       
  2674 
       
  2675 Controlling row filtering
       
  2676 
       
  2677 If you want to control whether libpng uses filtering or not, which
       
  2678 filters are used, and how it goes about picking row filters, you
       
  2679 can call one of these functions.  The selection and configuration
       
  2680 of row filters can have a significant impact on the size and
       
  2681 encoding speed and a somewhat lesser impact on the decoding speed
       
  2682 of an image.  Filtering is enabled by default for RGB and grayscale
       
  2683 images (with and without alpha), but not for paletted images nor
       
  2684 for any images with bit depths less than 8 bits/pixel.
       
  2685 
       
  2686 The 'method' parameter sets the main filtering method, which is
       
  2687 currently only '0' in the PNG 1.2 specification.  The 'filters'
       
  2688 parameter sets which filter(s), if any, should be used for each
       
  2689 scanline.  Possible values are PNG_ALL_FILTERS and PNG_NO_FILTERS
       
  2690 to turn filtering on and off, respectively.
       
  2691 
       
  2692 Individual filter types are PNG_FILTER_NONE, PNG_FILTER_SUB,
       
  2693 PNG_FILTER_UP, PNG_FILTER_AVG, PNG_FILTER_PAETH, which can be bitwise
       
  2694 ORed together with '|' to specify one or more filters to use.
       
  2695 These filters are described in more detail in the PNG specification.
       
  2696 If you intend to change the filter type during the course of writing
       
  2697 the image, you should start with flags set for all of the filters
       
  2698 you intend to use so that libpng can initialize its internal
       
  2699 structures appropriately for all of the filter types.  (Note that this
       
  2700 means the first row must always be adaptively filtered, because libpng
       
  2701 currently does not allocate the filter buffers until png_write_row()
       
  2702 is called for the first time.)
       
  2703 
       
  2704     filters = PNG_FILTER_NONE | PNG_FILTER_SUB
       
  2705               PNG_FILTER_UP | PNG_FILTER_AVG |
       
  2706               PNG_FILTER_PAETH | PNG_ALL_FILTERS;
       
  2707 
       
  2708     png_set_filter(png_ptr, PNG_FILTER_TYPE_BASE,
       
  2709        filters);
       
  2710               The second parameter can also be
       
  2711               PNG_INTRAPIXEL_DIFFERENCING if you are
       
  2712               writing a PNG to be embedded in a MNG
       
  2713               datastream.  This parameter must be the
       
  2714               same as the value of filter_method used
       
  2715               in png_set_IHDR().
       
  2716 
       
  2717 It is also possible to influence how libpng chooses from among the
       
  2718 available filters.  This is done in one or both of two ways - by
       
  2719 telling it how important it is to keep the same filter for successive
       
  2720 rows, and by telling it the relative computational costs of the filters.
       
  2721 
       
  2722     double weights[3] = {1.5, 1.3, 1.1},
       
  2723        costs[PNG_FILTER_VALUE_LAST] =
       
  2724        {1.0, 1.3, 1.3, 1.5, 1.7};
       
  2725 
       
  2726     png_set_filter_heuristics(png_ptr,
       
  2727        PNG_FILTER_HEURISTIC_WEIGHTED, 3,
       
  2728        weights, costs);
       
  2729 
       
  2730 The weights are multiplying factors that indicate to libpng that the
       
  2731 row filter should be the same for successive rows unless another row filter
       
  2732 is that many times better than the previous filter.  In the above example,
       
  2733 if the previous 3 filters were SUB, SUB, NONE, the SUB filter could have a
       
  2734 "sum of absolute differences" 1.5 x 1.3 times higher than other filters
       
  2735 and still be chosen, while the NONE filter could have a sum 1.1 times
       
  2736 higher than other filters and still be chosen.  Unspecified weights are
       
  2737 taken to be 1.0, and the specified weights should probably be declining
       
  2738 like those above in order to emphasize recent filters over older filters.
       
  2739 
       
  2740 The filter costs specify for each filter type a relative decoding cost
       
  2741 to be considered when selecting row filters.  This means that filters
       
  2742 with higher costs are less likely to be chosen over filters with lower
       
  2743 costs, unless their "sum of absolute differences" is that much smaller.
       
  2744 The costs do not necessarily reflect the exact computational speeds of
       
  2745 the various filters, since this would unduly influence the final image
       
  2746 size.
       
  2747 
       
  2748 Note that the numbers above were invented purely for this example and
       
  2749 are given only to help explain the function usage.  Little testing has
       
  2750 been done to find optimum values for either the costs or the weights.
       
  2751 
       
  2752 Removing unwanted object code
       
  2753 
       
  2754 There are a bunch of #define's in pngconf.h that control what parts of
       
  2755 libpng are compiled.  All the defines end in _SUPPORTED.  If you are
       
  2756 never going to use a capability, you can change the #define to #undef
       
  2757 before recompiling libpng and save yourself code and data space, or
       
  2758 you can turn off individual capabilities with defines that begin with
       
  2759 PNG_NO_.
       
  2760 
       
  2761 You can also turn all of the transforms and ancillary chunk capabilities
       
  2762 off en masse with compiler directives that define
       
  2763 PNG_NO_READ[or WRITE]_TRANSFORMS, or PNG_NO_READ[or WRITE]_ANCILLARY_CHUNKS,
       
  2764 or all four,
       
  2765 along with directives to turn on any of the capabilities that you do
       
  2766 want.  The PNG_NO_READ[or WRITE]_TRANSFORMS directives disable the extra
       
  2767 transformations but still leave the library fully capable of reading
       
  2768 and writing PNG files with all known public chunks. Use of the
       
  2769 PNG_NO_READ[or WRITE]_ANCILLARY_CHUNKS directive produces a library
       
  2770 that is incapable of reading or writing ancillary chunks.  If you are
       
  2771 not using the progressive reading capability, you can turn that off
       
  2772 with PNG_NO_PROGRESSIVE_READ (don't confuse this with the INTERLACING
       
  2773 capability, which you'll still have).
       
  2774 
       
  2775 All the reading and writing specific code are in separate files, so the
       
  2776 linker should only grab the files it needs.  However, if you want to
       
  2777 make sure, or if you are building a stand alone library, all the
       
  2778 reading files start with pngr and all the writing files start with
       
  2779 pngw.  The files that don't match either (like png.c, pngtrans.c, etc.)
       
  2780 are used for both reading and writing, and always need to be included.
       
  2781 The progressive reader is in pngpread.c
       
  2782 
       
  2783 If you are creating or distributing a dynamically linked library (a .so
       
  2784 or DLL file), you should not remove or disable any parts of the library,
       
  2785 as this will cause applications linked with different versions of the
       
  2786 library to fail if they call functions not available in your library.
       
  2787 The size of the library itself should not be an issue, because only
       
  2788 those sections that are actually used will be loaded into memory.
       
  2789 
       
  2790 Requesting debug printout
       
  2791 
       
  2792 The macro definition PNG_DEBUG can be used to request debugging
       
  2793 printout.  Set it to an integer value in the range 0 to 3.  Higher
       
  2794 numbers result in increasing amounts of debugging information.  The
       
  2795 information is printed to the "stderr" file, unless another file
       
  2796 name is specified in the PNG_DEBUG_FILE macro definition.
       
  2797 
       
  2798 When PNG_DEBUG > 0, the following functions (macros) become available:
       
  2799 
       
  2800    png_debug(level, message)
       
  2801    png_debug1(level, message, p1)
       
  2802    png_debug2(level, message, p1, p2)
       
  2803 
       
  2804 in which "level" is compared to PNG_DEBUG to decide whether to print
       
  2805 the message, "message" is the formatted string to be printed,
       
  2806 and p1 and p2 are parameters that are to be embedded in the string
       
  2807 according to printf-style formatting directives.  For example,
       
  2808 
       
  2809    png_debug1(2, "foo=%d\n", foo);
       
  2810 
       
  2811 is expanded to
       
  2812 
       
  2813    if(PNG_DEBUG > 2)
       
  2814      fprintf(PNG_DEBUG_FILE, "foo=%d\n", foo);
       
  2815 
       
  2816 When PNG_DEBUG is defined but is zero, the macros aren't defined, but you
       
  2817 can still use PNG_DEBUG to control your own debugging:
       
  2818 
       
  2819    #ifdef PNG_DEBUG
       
  2820        fprintf(stderr, ...
       
  2821    #endif
       
  2822 
       
  2823 When PNG_DEBUG = 1, the macros are defined, but only png_debug statements
       
  2824 having level = 0 will be printed.  There aren't any such statements in
       
  2825 this version of libpng, but if you insert some they will be printed.
       
  2826 
       
  2827 VI.  MNG support
       
  2828 
       
  2829 The MNG specification (available at http://www.libpng.org/pub/mng) allows
       
  2830 certain extensions to PNG for PNG images that are embedded in MNG datastreams.
       
  2831 Libpng can support some of these extensions.  To enable them, use the
       
  2832 png_permit_mng_features() function:
       
  2833 
       
  2834    feature_set = png_permit_mng_features(png_ptr, mask)
       
  2835    mask is a png_uint_32 containing the bitwise OR of the
       
  2836         features you want to enable.  These include
       
  2837         PNG_FLAG_MNG_EMPTY_PLTE
       
  2838         PNG_FLAG_MNG_FILTER_64
       
  2839         PNG_ALL_MNG_FEATURES
       
  2840    feature_set is a png_uint_32 that is the bitwise AND of
       
  2841       your mask with the set of MNG features that is
       
  2842       supported by the version of libpng that you are using.
       
  2843 
       
  2844 It is an error to use this function when reading or writing a standalone
       
  2845 PNG file with the PNG 8-byte signature.  The PNG datastream must be wrapped
       
  2846 in a MNG datastream.  As a minimum, it must have the MNG 8-byte signature
       
  2847 and the MHDR and MEND chunks.  Libpng does not provide support for these
       
  2848 or any other MNG chunks; your application must provide its own support for
       
  2849 them.  You may wish to consider using libmng (available at
       
  2850 http://www.libmng.com) instead.
       
  2851 
       
  2852 VII.  Changes to Libpng from version 0.88
       
  2853 
       
  2854 It should be noted that versions of libpng later than 0.96 are not
       
  2855 distributed by the original libpng author, Guy Schalnat, nor by
       
  2856 Andreas Dilger, who had taken over from Guy during 1996 and 1997, and
       
  2857 distributed versions 0.89 through 0.96, but rather by another member
       
  2858 of the original PNG Group, Glenn Randers-Pehrson.  Guy and Andreas are
       
  2859 still alive and well, but they have moved on to other things.
       
  2860 
       
  2861 The old libpng functions png_read_init(), png_write_init(),
       
  2862 png_info_init(), png_read_destroy(), and png_write_destroy() have been
       
  2863 moved to PNG_INTERNAL in version 0.95 to discourage their use.  These
       
  2864 functions will be removed from libpng version 2.0.0.
       
  2865 
       
  2866 The preferred method of creating and initializing the libpng structures is
       
  2867 via the png_create_read_struct(), png_create_write_struct(), and
       
  2868 png_create_info_struct() because they isolate the size of the structures
       
  2869 from the application, allow version error checking, and also allow the
       
  2870 use of custom error handling routines during the initialization, which
       
  2871 the old functions do not.  The functions png_read_destroy() and
       
  2872 png_write_destroy() do not actually free the memory that libpng
       
  2873 allocated for these structs, but just reset the data structures, so they
       
  2874 can be used instead of png_destroy_read_struct() and
       
  2875 png_destroy_write_struct() if you feel there is too much system overhead
       
  2876 allocating and freeing the png_struct for each image read.
       
  2877 
       
  2878 Setting the error callbacks via png_set_message_fn() before
       
  2879 png_read_init() as was suggested in libpng-0.88 is no longer supported
       
  2880 because this caused applications that do not use custom error functions
       
  2881 to fail if the png_ptr was not initialized to zero.  It is still possible
       
  2882 to set the error callbacks AFTER png_read_init(), or to change them with
       
  2883 png_set_error_fn(), which is essentially the same function, but with a new
       
  2884 name to force compilation errors with applications that try to use the old
       
  2885 method.
       
  2886 
       
  2887 Starting with version 1.0.7, you can find out which version of the library
       
  2888 you are using at run-time:
       
  2889 
       
  2890    png_uint_32 libpng_vn = png_access_version_number();
       
  2891 
       
  2892 The number libpng_vn is constructed from the major version, minor
       
  2893 version with leading zero, and release number with leading zero,
       
  2894 (e.g., libpng_vn for version 1.0.7 is 10007).
       
  2895 
       
  2896 You can also check which version of png.h you used when compiling your
       
  2897 application:
       
  2898 
       
  2899    png_uint_32 application_vn = PNG_LIBPNG_VER;
       
  2900 
       
  2901 VIII.  Changes to Libpng from version 1.0.x to 1.2.x
       
  2902 
       
  2903 Support for user memory management was enabled by default.  To
       
  2904 accomplish this, the functions png_create_read_struct_2(),
       
  2905 png_create_write_struct_2(), png_set_mem_fn(), png_get_mem_ptr(),
       
  2906 png_malloc_default(), and png_free_default() were added.
       
  2907 
       
  2908 Support for the iTXt chunk has been enabled by default as of
       
  2909 version 1.2.41.
       
  2910 
       
  2911 Support for certain MNG features was enabled.
       
  2912 
       
  2913 Support for numbered error messages was added.  However, we never got
       
  2914 around to actually numbering the error messages.  The function
       
  2915 png_set_strip_error_numbers() was added (Note: the prototype for this
       
  2916 function was inadvertently removed from png.h in PNG_NO_ASSEMBLER_CODE
       
  2917 builds of libpng-1.2.15.  It was restored in libpng-1.2.36).
       
  2918 
       
  2919 The png_malloc_warn() function was added at libpng-1.2.3.  This issues
       
  2920 a png_warning and returns NULL instead of aborting when it fails to
       
  2921 acquire the requested memory allocation.
       
  2922 
       
  2923 Support for setting user limits on image width and height was enabled
       
  2924 by default.  The functions png_set_user_limits(), png_get_user_width_max(),
       
  2925 and png_get_user_height_max() were added at libpng-1.2.6.
       
  2926 
       
  2927 The png_set_add_alpha() function was added at libpng-1.2.7.
       
  2928 
       
  2929 The function png_set_expand_gray_1_2_4_to_8() was added at libpng-1.2.9.
       
  2930 Unlike png_set_gray_1_2_4_to_8(), the new function does not expand the
       
  2931 tRNS chunk to alpha. The png_set_gray_1_2_4_to_8() function is
       
  2932 deprecated.
       
  2933 
       
  2934 A number of macro definitions in support of runtime selection of
       
  2935 assembler code features (especially Intel MMX code support) were
       
  2936 added at libpng-1.2.0:
       
  2937 
       
  2938     PNG_ASM_FLAG_MMX_SUPPORT_COMPILED
       
  2939     PNG_ASM_FLAG_MMX_SUPPORT_IN_CPU
       
  2940     PNG_ASM_FLAG_MMX_READ_COMBINE_ROW
       
  2941     PNG_ASM_FLAG_MMX_READ_INTERLACE
       
  2942     PNG_ASM_FLAG_MMX_READ_FILTER_SUB
       
  2943     PNG_ASM_FLAG_MMX_READ_FILTER_UP
       
  2944     PNG_ASM_FLAG_MMX_READ_FILTER_AVG
       
  2945     PNG_ASM_FLAG_MMX_READ_FILTER_PAETH
       
  2946     PNG_ASM_FLAGS_INITIALIZED
       
  2947     PNG_MMX_READ_FLAGS
       
  2948     PNG_MMX_FLAGS
       
  2949     PNG_MMX_WRITE_FLAGS
       
  2950     PNG_MMX_FLAGS
       
  2951 
       
  2952 We added the following functions in support of runtime
       
  2953 selection of assembler code features:
       
  2954 
       
  2955     png_get_mmx_flagmask()
       
  2956     png_set_mmx_thresholds()
       
  2957     png_get_asm_flags()
       
  2958     png_get_mmx_bitdepth_threshold()
       
  2959     png_get_mmx_rowbytes_threshold()
       
  2960     png_set_asm_flags()
       
  2961 
       
  2962 We replaced all of these functions with simple stubs in libpng-1.2.20,
       
  2963 when the Intel assembler code was removed due to a licensing issue.
       
  2964 
       
  2965 These macros are deprecated:
       
  2966 
       
  2967     PNG_READ_TRANSFORMS_NOT_SUPPORTED
       
  2968     PNG_PROGRESSIVE_READ_NOT_SUPPORTED
       
  2969     PNG_NO_SEQUENTIAL_READ_SUPPORTED
       
  2970     PNG_WRITE_TRANSFORMS_NOT_SUPPORTED
       
  2971     PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED
       
  2972     PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED
       
  2973 
       
  2974 They have been replaced, respectively, by:
       
  2975 
       
  2976     PNG_NO_READ_TRANSFORMS
       
  2977     PNG_NO_PROGRESSIVE_READ
       
  2978     PNG_NO_SEQUENTIAL_READ
       
  2979     PNG_NO_WRITE_TRANSFORMS
       
  2980     PNG_NO_READ_ANCILLARY_CHUNKS
       
  2981     PNG_NO_WRITE_ANCILLARY_CHUNKS
       
  2982 
       
  2983 PNG_MAX_UINT was replaced with PNG_UINT_31_MAX.  It has been
       
  2984 deprecated since libpng-1.0.16 and libpng-1.2.6.
       
  2985 
       
  2986 The function
       
  2987     png_check_sig(sig, num)
       
  2988 was replaced with
       
  2989     !png_sig_cmp(sig, 0, num)
       
  2990 It has been deprecated since libpng-0.90.
       
  2991 
       
  2992 The function
       
  2993     png_set_gray_1_2_4_to_8()
       
  2994 which also expands tRNS to alpha was replaced with
       
  2995     png_set_expand_gray_1_2_4_to_8()
       
  2996 which does not. It has been deprecated since libpng-1.0.18 and 1.2.9.
       
  2997 
       
  2998 IX.  Changes to Libpng from version 1.0.x/1.2.x to 1.4.x
       
  2999 
       
  3000 Private libpng prototypes and macro definitions were moved from
       
  3001 png.h and pngconf.h into a new pngpriv.h header file.
       
  3002 
       
  3003 Functions png_set_benign_errors(), png_benign_error(), and
       
  3004 png_chunk_benign_error() were added.
       
  3005 
       
  3006 Support for setting the maximum amount of memory that the application
       
  3007 will allocate for reading chunks was added, as a security measure.
       
  3008 The functions png_set_chunk_cache_max() and png_get_chunk_cache_max()
       
  3009 were added to the library.
       
  3010 
       
  3011 We implemented support for I/O states by adding png_ptr member io_state
       
  3012 and functions png_get_io_chunk_name() and png_get_io_state() in pngget.c
       
  3013 
       
  3014 We added PNG_TRANSFORM_GRAY_TO_RGB to the available high-level
       
  3015 input transforms.
       
  3016 
       
  3017 Checking for and reporting of errors in the IHDR chunk is more thorough.
       
  3018 
       
  3019 Support for global arrays was removed, to improve thread safety.
       
  3020 
       
  3021 Some obsolete/deprecated macros and functions have been removed.
       
  3022 
       
  3023 Typecasted NULL definitions such as
       
  3024    #define png_voidp_NULL            (png_voidp)NULL
       
  3025 were eliminated.  If you used these in your application, just use
       
  3026 NULL instead.
       
  3027 
       
  3028 The png_struct and info_struct members "trans" and "trans_values" were
       
  3029 changed to "trans_alpha" and "trans_color", respectively.
       
  3030 
       
  3031 The obsolete, unused pnggccrd.c and pngvcrd.c files and related makefiles
       
  3032 were removed.
       
  3033 
       
  3034 The PNG_1_0_X and PNG_1_2_X macros were eliminated.
       
  3035 
       
  3036 The PNG_LEGACY_SUPPORTED macro was eliminated.
       
  3037 
       
  3038 Many WIN32_WCE #ifdefs were removed.
       
  3039 
       
  3040 The functions png_read_init(info_ptr), png_write_init(info_ptr),
       
  3041 png_info_init(info_ptr), png_read_destroy(), and png_write_destroy()
       
  3042 have been removed.  They have been deprecated since libpng-0.95.
       
  3043 
       
  3044 The png_permit_empty_plte() was removed. It has been deprecated
       
  3045 since libpng-1.0.9.  Use png_permit_mng_features() instead.
       
  3046 
       
  3047 We removed the obsolete stub functions png_get_mmx_flagmask(),
       
  3048 png_set_mmx_thresholds(), png_get_asm_flags(),
       
  3049 png_get_mmx_bitdepth_threshold(), png_get_mmx_rowbytes_threshold(),
       
  3050 png_set_asm_flags(), and png_mmx_supported()
       
  3051 
       
  3052 We removed the obsolete png_check_sig(), png_memcpy_check(), and
       
  3053 png_memset_check() functions.  Instead use !png_sig_cmp(), png_memcpy(),
       
  3054 and png_memset(), respectively.
       
  3055 
       
  3056 The function png_set_gray_1_2_4_to_8() was removed. It has been
       
  3057 deprecated since libpng-1.0.18 and 1.2.9, when it was replaced with
       
  3058 png_set_expand_gray_1_2_4_to_8() because the former function also
       
  3059 expanded palette images.
       
  3060 
       
  3061 We changed the prototype for png_malloc() from
       
  3062     png_malloc(png_structp png_ptr, png_uint_32 size)
       
  3063 to
       
  3064     png_malloc(png_structp png_ptr, png_alloc_size_t size)
       
  3065 
       
  3066 The png_calloc() function was added and is used in place of
       
  3067 of "png_malloc(); png_memset();" except in the case in png_read_png()
       
  3068 where the array consists of pointers; in this case a "for" loop is used
       
  3069 after the png_malloc() to set the pointers to NULL, to give robust.
       
  3070 behavior in case the application runs out of memory part-way through
       
  3071 the process.
       
  3072 
       
  3073 We changed the prototypes of png_get_compression_buffer_size() and
       
  3074 png_set_compression_buffer_size() to work with png_size_t instead of
       
  3075 png_uint_32.
       
  3076 
       
  3077 Support for numbered error messages was removed by default, since we
       
  3078 never got around to actually numbering the error messages. The function
       
  3079 png_set_strip_error_numbers() was removed from the library by default.
       
  3080 
       
  3081 The png_zalloc() and png_zfree() functions are no longer exported.
       
  3082 The png_zalloc() function no longer zeroes out the memory that it
       
  3083 allocates.
       
  3084 
       
  3085 We removed the trailing '.' from the warning and error messages.
       
  3086 
       
  3087 X. Detecting libpng
       
  3088 
       
  3089 The png_get_io_ptr() function has been present since libpng-0.88, has never
       
  3090 changed, and is unaffected by conditional compilation macros.  It is the
       
  3091 best choice for use in configure scripts for detecting the presence of any
       
  3092 libpng version since 0.88.  In an autoconf "configure.in" you could use
       
  3093 
       
  3094     AC_CHECK_LIB(png, png_get_io_ptr, ...
       
  3095 
       
  3096 XI. Source code repository
       
  3097 
       
  3098 Since about February 2009, version 1.2.34, libpng has been under "git" source
       
  3099 control.  The git repository was built from old libpng-x.y.z.tar.gz files
       
  3100 going back to version 0.70.  You can access the git repository (read only)
       
  3101 at
       
  3102 
       
  3103     git://libpng.git.sourceforge.net/gitroot/libpng
       
  3104 
       
  3105 or you can browse it via "gitweb" at
       
  3106 
       
  3107     http://libpng.git.sourceforge.net/git/gitweb.cgi?p=libpng
       
  3108 
       
  3109 Patches can be sent to glennrp at users.sourceforge.net or to
       
  3110 png-mng-implement at lists.sourceforge.net or you can upload them to
       
  3111 the libpng bug tracker at
       
  3112 
       
  3113     http://libpng.sourceforge.net
       
  3114 
       
  3115 XII. Coding style
       
  3116 
       
  3117 Our coding style is similar to the "Allman" style, with curly
       
  3118 braces on separate lines:
       
  3119 
       
  3120     if (condition)
       
  3121     {
       
  3122        action;
       
  3123     }
       
  3124 
       
  3125     else if (another condition)
       
  3126     {
       
  3127        another action;
       
  3128     }
       
  3129 
       
  3130 The braces can be omitted from simple one-line actions:
       
  3131 
       
  3132     if (condition)
       
  3133        return (0);
       
  3134 
       
  3135 We use 3-space indentation, except for continued statements which
       
  3136 are usually indented the same as the first line of the statement
       
  3137 plus four more spaces.
       
  3138 
       
  3139 For macro definitions we use 2-space indentation, always leaving the "#"
       
  3140 in the first column.
       
  3141 
       
  3142     #ifndef PNG_NO_FEATURE
       
  3143     #  ifndef PNG_FEATURE_SUPPORTED
       
  3144     #    define PNG_FEATURE_SUPPORTED
       
  3145     #  endif
       
  3146     #endif
       
  3147 
       
  3148 Comments appear with the leading "/*" at the same indentation as
       
  3149 the statement that follows the comment:
       
  3150 
       
  3151     /* Single-line comment */
       
  3152     statement;
       
  3153 
       
  3154     /* Multiple-line
       
  3155      * comment
       
  3156      */
       
  3157     statement;
       
  3158 
       
  3159 Very short comments can be placed at the end of the statement
       
  3160 to which they pertain:
       
  3161 
       
  3162     statement;    /* comment */
       
  3163 
       
  3164 We don't use C++ style ("//") comments. We have, however,
       
  3165 used them in the past in some now-abandoned MMX assembler
       
  3166 code.
       
  3167 
       
  3168 Functions and their curly braces are not indented, and
       
  3169 exported functions are marked with PNGAPI:
       
  3170 
       
  3171  /* This is a public function that is visible to
       
  3172   * application programers. It does thus-and-so.
       
  3173   */
       
  3174  void PNGAPI
       
  3175  png_exported_function(png_ptr, png_info, foo)
       
  3176  {
       
  3177     body;
       
  3178  }
       
  3179 
       
  3180 The prototypes for all exported functions appear in png.h,
       
  3181 above the comment that says
       
  3182 
       
  3183     /* Maintainer: Put new public prototypes here ... */
       
  3184 
       
  3185 We mark all non-exported functions with "/* PRIVATE */"":
       
  3186 
       
  3187  void /* PRIVATE */
       
  3188  png_non_exported_function(png_ptr, png_info, foo)
       
  3189  {
       
  3190     body;
       
  3191  }
       
  3192 
       
  3193 The prototypes for non-exported functions (except for those in
       
  3194 pngtest) appear in
       
  3195 pngpriv.h
       
  3196 above the comment that says
       
  3197 
       
  3198   /* Maintainer: Put new private prototypes here ^ and in libpngpf.3 */
       
  3199 
       
  3200 The names of all exported functions and variables begin
       
  3201 with  "png_", and all publicly visible C preprocessor
       
  3202 macros begin with "PNG_".
       
  3203 
       
  3204 We put a space after each comma and after each semicolon
       
  3205 in "for" statments, and we put spaces before and after each
       
  3206 C binary operator and after "for" or "while".  We don't
       
  3207 put a space between a typecast and the expression being
       
  3208 cast, nor do we put one between a function name and the
       
  3209 left parenthesis that follows it:
       
  3210 
       
  3211     for (i = 2; i > 0; --i)
       
  3212        y[i] = a(x) + (int)b;
       
  3213 
       
  3214 We prefer #ifdef and #ifndef to #if defined() and if !defined()
       
  3215 when there is only one macro being tested.
       
  3216 
       
  3217 We do not use the TAB character for indentation in the C sources.
       
  3218 
       
  3219 Lines do not exceed 80 characters.
       
  3220 
       
  3221 Other rules can be inferred by inspecting the libpng source.
       
  3222 
       
  3223 XIII. Y2K Compliance in libpng
       
  3224 
       
  3225 January 3, 2010
       
  3226 
       
  3227 Since the PNG Development group is an ad-hoc body, we can't make
       
  3228 an official declaration.
       
  3229 
       
  3230 This is your unofficial assurance that libpng from version 0.71 and
       
  3231 upward through 1.4.0 are Y2K compliant.  It is my belief that earlier
       
  3232 versions were also Y2K compliant.
       
  3233 
       
  3234 Libpng only has three year fields.  One is a 2-byte unsigned integer that
       
  3235 will hold years up to 65535.  The other two hold the date in text
       
  3236 format, and will hold years up to 9999.
       
  3237 
       
  3238 The integer is
       
  3239     "png_uint_16 year" in png_time_struct.
       
  3240 
       
  3241 The strings are
       
  3242     "png_charp time_buffer" in png_struct and
       
  3243     "near_time_buffer", which is a local character string in png.c.
       
  3244 
       
  3245 There are seven time-related functions:
       
  3246 
       
  3247     png_convert_to_rfc_1123() in png.c
       
  3248       (formerly png_convert_to_rfc_1152() in error)
       
  3249     png_convert_from_struct_tm() in pngwrite.c, called
       
  3250       in pngwrite.c
       
  3251     png_convert_from_time_t() in pngwrite.c
       
  3252     png_get_tIME() in pngget.c
       
  3253     png_handle_tIME() in pngrutil.c, called in pngread.c
       
  3254     png_set_tIME() in pngset.c
       
  3255     png_write_tIME() in pngwutil.c, called in pngwrite.c
       
  3256 
       
  3257 All appear to handle dates properly in a Y2K environment.  The
       
  3258 png_convert_from_time_t() function calls gmtime() to convert from system
       
  3259 clock time, which returns (year - 1900), which we properly convert to
       
  3260 the full 4-digit year.  There is a possibility that applications using
       
  3261 libpng are not passing 4-digit years into the png_convert_to_rfc_1123()
       
  3262 function, or that they are incorrectly passing only a 2-digit year
       
  3263 instead of "year - 1900" into the png_convert_from_struct_tm() function,
       
  3264 but this is not under our control.  The libpng documentation has always
       
  3265 stated that it works with 4-digit years, and the APIs have been
       
  3266 documented as such.
       
  3267 
       
  3268 The tIME chunk itself is also Y2K compliant.  It uses a 2-byte unsigned
       
  3269 integer to hold the year, and can hold years as large as 65535.
       
  3270 
       
  3271 zlib, upon which libpng depends, is also Y2K compliant.  It contains
       
  3272 no date-related code.
       
  3273 
       
  3274 
       
  3275    Glenn Randers-Pehrson
       
  3276    libpng maintainer
       
  3277    PNG Development Group