LIBPNG(3) LIBPNG(3)
NAME
libpng - Portable Network Graphics (PNG) Reference Library 1.2.7
SYNOPSIS
#include <png.h>
png_uint_32 png_access_version_number (void);
int png_check_sig (png_bytep sig, int num);
void png_chunk_error (png_structp png_ptr, png_const_charp error(8,n));
void png_chunk_warning (png_structp png_ptr, png_const_charp message);
void png_convert_from_struct_tm (png_timep ptime, struct tm FAR *
ttime);
void png_convert_from_time_t (png_timep ptime, time_t ttime);
png_charp png_convert_to_rfc1123 (png_structp png_ptr, png_timep
ptime);
png_infop png_create_info_struct (png_structp png_ptr);
png_structp png_create_read_struct (png_const_charp user_png_ver,
png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn);
png_structp png_create_read_struct_2(png_const_charp user_png_ver,
png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn,
png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn);
png_structp png_create_write_struct (png_const_charp user_png_ver,
png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn);
png_structp png_create_write_struct_2(png_const_charp user_png_ver,
png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warn_fn,
png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn);
int png_debug(int level, png_const_charp message);
int png_debug1(int level, png_const_charp message, p1);
int png_debug2(int level, png_const_charp message, p1, p2);
void png_destroy_info_struct (png_structp png_ptr, png_infopp
info_ptr_ptr);
void png_destroy_read_struct (png_structpp png_ptr_ptr, png_infopp
info_ptr_ptr, png_infopp end_info_ptr_ptr);
void png_destroy_write_struct (png_structpp png_ptr_ptr, png_infopp
info_ptr_ptr);
void png_error (png_structp png_ptr, png_const_charp error(8,n));
void png_free (png_structp png_ptr, png_voidp ptr);
void png_free_chunk_list (png_structp png_ptr);
void png_free_default(png_structp png_ptr, png_voidp ptr);
void png_free_data (png_structp png_ptr, png_infop info_ptr, int num);
png_byte png_get_bit_depth (png_structp png_ptr, png_infop info_ptr);
png_uint_32 png_get_bKGD (png_structp png_ptr, png_infop info_ptr,
png_color_16p *background);
png_byte png_get_channels (png_structp png_ptr, png_infop info_ptr);
png_uint_32 png_get_cHRM (png_structp png_ptr, png_infop info_ptr, dou-
ble *white_x, double *white_y, double *red_x, double *red_y, double
*green_x, double *green_y, double *blue_x, double *blue_y);
png_uint_32 png_get_cHRM_fixed (png_structp png_ptr, png_infop
info_ptr, png_uint_32 *white_x, png_uint_32 *white_y, png_uint_32
*red_x, png_uint_32 *red_y, png_uint_32 *green_x, png_uint_32 *green_y,
png_uint_32 *blue_x, png_uint_32 *blue_y);
png_byte png_get_color_type (png_structp png_ptr, png_infop info_ptr);
png_byte png_get_compression_type (png_structp png_ptr, png_infop
info_ptr);
png_byte png_get_copyright (png_structp png_ptr);
png_voidp png_get_error_ptr (png_structp png_ptr);
png_byte png_get_filter_type (png_structp png_ptr, png_infop info_ptr);
png_uint_32 png_get_gAMA (png_structp png_ptr, png_infop info_ptr, dou-
ble *file_gamma);
png_uint_32 png_get_gAMA_fixed (png_structp png_ptr, png_infop
info_ptr, png_uint_32 *int_file_gamma);
png_byte png_get_header_ver (png_structp png_ptr);
png_byte png_get_header_version (png_structp png_ptr);
png_uint_32 png_get_hIST (png_structp png_ptr, png_infop info_ptr,
png_uint_16p *hist);
png_uint_32 png_get_iCCP (png_structp png_ptr, png_infop info_ptr,
png_charpp name, int *compression_type, png_charpp profile, png_uint_32
*proflen);
png_uint_32 png_get_IHDR (png_structp png_ptr, png_infop info_ptr,
png_uint_32 *width, png_uint_32 *height, int *bit_depth, int
*color_type, int *interlace_type, int *compression_type, int *fil-
ter_type);
png_uint_32 png_get_image_height (png_structp png_ptr, png_infop
info_ptr);
png_uint_32 png_get_image_width (png_structp png_ptr, png_infop
info_ptr);
png_byte png_get_interlace_type (png_structp png_ptr, png_infop
info_ptr);
png_voidp png_get_io_ptr (png_structp png_ptr);
png_byte png_get_libpng_ver (png_structp png_ptr);
png_voidp png_get_mem_ptr(png_structp png_ptr);
png_uint_32 png_get_oFFs (png_structp png_ptr, png_infop info_ptr,
png_uint_32 *offset_x, png_uint_32 *offset_y, int *unit_type);
png_uint_32 png_get_pCAL (png_structp png_ptr, png_infop info_ptr,
png_charp *purpose, png_int_32 *X0, png_int_32 *X1, int *type, int
*nparams, png_charp *units(1,7), png_charpp *params);
png_uint_32 png_get_pHYs (png_structp png_ptr, png_infop info_ptr,
png_uint_32 *res_x, png_uint_32 *res_y, int *unit_type);
float png_get_pixel_aspect_ratio (png_structp png_ptr, png_infop
info_ptr);
png_uint_32 png_get_pixels_per_meter (png_structp png_ptr, png_infop
info_ptr);
png_voidp png_get_progressive_ptr (png_structp png_ptr);
png_uint_32 png_get_PLTE (png_structp png_ptr, png_infop info_ptr,
png_colorp *palette, int *num_palette);
png_byte png_get_rgb_to_gray_status (png_structp png_ptr)
png_uint_32 png_get_rowbytes (png_structp png_ptr, png_infop info_ptr);
png_bytepp png_get_rows (png_structp png_ptr, png_infop info_ptr);
png_uint_32 png_get_sBIT (png_structp png_ptr, png_infop info_ptr,
png_color_8p *sig_bit);
png_bytep png_get_signature (png_structp png_ptr, png_infop info_ptr);
png_uint_32 png_get_sPLT (png_structp png_ptr, png_infop info_ptr,
png_spalette_p *splt_ptr);
png_uint_32 png_get_sRGB (png_structp png_ptr, png_infop info_ptr, int
*intent);
png_uint_32 png_get_text (png_structp png_ptr, png_infop info_ptr,
png_textp *text_ptr, int *num_text);
png_uint_32 png_get_tIME (png_structp png_ptr, png_infop info_ptr,
png_timep *mod_time);
png_uint_32 png_get_tRNS (png_structp png_ptr, png_infop info_ptr,
png_bytep *trans, int *num_trans, png_color_16p *trans_values);
png_uint_32 png_get_unknown_chunks (png_structp png_ptr, png_infop
info_ptr, png_unknown_chunkpp unknowns);
png_voidp png_get_user_chunk_ptr (png_structp png_ptr);
png_uint_32 png_get_user_height_max( png_structp png_ptr);
png_voidp png_get_user_transform_ptr (png_structp png_ptr);
png_uint_32 png_get_user_width_max (png_structp png_ptr);
png_uint_32 png_get_valid (png_structp png_ptr, png_infop info_ptr,
png_uint_32 flag);
png_int_32 png_get_x_offset_microns (png_structp png_ptr, png_infop
info_ptr);
png_int_32 png_get_x_offset_pixels (png_structp png_ptr, png_infop
info_ptr);
png_uint_32 png_get_x_pixels_per_meter (png_structp png_ptr, png_infop
info_ptr);
png_int_32 png_get_y_offset_microns (png_structp png_ptr, png_infop
info_ptr);
png_int_32 png_get_y_offset_pixels (png_structp png_ptr, png_infop
info_ptr);
png_uint_32 png_get_y_pixels_per_meter (png_structp png_ptr, png_infop
info_ptr);
png_uint_32 png_get_compression_buffer_size (png_structp png_ptr);
int png_handle_as_unknown (png_structp png_ptr, png_bytep chunk_name);
void png_init_io (png_structp png_ptr, FILE *fp);
DEPRECATED: void png_info_init (png_infop info_ptr);
DEPRECATED: void png_info_init_2 (png_infopp ptr_ptr, png_size_t
png_info_struct_size);
png_voidp png_malloc (png_structp png_ptr, png_uint_32 size);
png_voidp png_malloc_default(png_structp png_ptr, png_uint_32 size);
voidp png_memcpy (png_voidp s1, png_voidp s2, png_size_t size);
png_voidp png_memcpy_check (png_structp png_ptr, png_voidp s1,
png_voidp s2, png_uint_32 size);
voidp png_memset (png_voidp s1, int value, png_size_t size);
png_voidp png_memset_check (png_structp png_ptr, png_voidp s1, int
value, png_uint_32 size);
DEPRECATED: void png_permit_empty_plte (png_structp png_ptr, int
empty_plte_permitted);
void png_process_data (png_structp png_ptr, png_infop info_ptr,
png_bytep buffer, png_size_t buffer_size);
void png_progressive_combine_row (png_structp png_ptr, png_bytep
old_row, png_bytep new_row);
void png_read_destroy (png_structp png_ptr, png_infop info_ptr,
png_infop end_info_ptr);
void png_read_end (png_structp png_ptr, png_infop info_ptr);
void png_read_image (png_structp png_ptr, png_bytepp image);
DEPRECATED: void png_read_init (png_structp png_ptr);
DEPRECATED: void png_read_init_2 (png_structpp ptr_ptr, png_const_charp
user_png_ver, png_size_t png_struct_size, png_size_t png_info_size);
void png_read_info (png_structp png_ptr, png_infop info_ptr);
void png_read_png (png_structp png_ptr, png_infop info_ptr, int trans-
forms, png_voidp params);
void png_read_row (png_structp png_ptr, png_bytep row, png_bytep dis-
play_row);
void png_read_rows (png_structp png_ptr, png_bytepp row, png_bytepp
display_row, png_uint_32 num_rows);
void png_read_update_info (png_structp png_ptr, png_infop info_ptr);
#if(3,n) !defined(PNG_1_0_X)
void png_set_add_alpha (png_structp png_ptr, png_uint_32 filler, int
flags);
#endif
void png_set_background (png_structp png_ptr, png_color_16p back-
ground_color, int background_gamma_code, int need_expand, double back-
ground_gamma);
void png_set_bgr (png_structp png_ptr);
void png_set_bKGD (png_structp png_ptr, png_infop info_ptr,
png_color_16p background);
void png_set_cHRM (png_structp png_ptr, png_infop info_ptr, double
white_x, double white_y, double red_x, double red_y, double green_x,
double green_y, double blue_x, double blue_y);
void png_set_cHRM_fixed (png_structp png_ptr, png_infop info_ptr,
png_uint_32 white_x, png_uint_32 white_y, png_uint_32 red_x,
png_uint_32 red_y, png_uint_32 green_x, png_uint_32 green_y,
png_uint_32 blue_x, png_uint_32 blue_y);
void png_set_compression_level (png_structp png_ptr, int level);
void png_set_compression_mem_level (png_structp png_ptr, int
mem_level);
void png_set_compression_method (png_structp png_ptr, int method);
void png_set_compression_strategy (png_structp png_ptr, int strategy);
void png_set_compression_window_bits (png_structp png_ptr, int win-
dow_bits);
void png_set_crc_action (png_structp png_ptr, int crit_action, int
ancil_action);
void png_set_dither (png_structp png_ptr, png_colorp palette, int
num_palette, int maximum_colors, png_uint_16p histogram, int
full_dither);
void png_set_error_fn (png_structp png_ptr, png_voidp error_ptr,
png_error_ptr error_fn, png_error_ptr warning_fn);
void png_set_expand (png_structp png_ptr);
void png_set_filler (png_structp png_ptr, png_uint_32 filler, int
flags);
void png_set_filter (png_structp png_ptr, int method, int filters);
void png_set_filter_heuristics (png_structp png_ptr, int heuris-
tic_method, int num_weights, png_doublep filter_weights, png_doublep
filter_costs);
void png_set_flush (png_structp png_ptr, int nrows);
void png_set_gamma (png_structp png_ptr, double screen_gamma, double
default_file_gamma);
void png_set_gAMA (png_structp png_ptr, png_infop info_ptr, double
file_gamma);
void png_set_gAMA_fixed (png_structp png_ptr, png_infop info_ptr,
png_uint_32 file_gamma);
void png_set_gray_1_2_4_to_8(png_structp png_ptr);
void png_set_gray_to_rgb (png_structp png_ptr);
void png_set_hIST (png_structp png_ptr, png_infop info_ptr,
png_uint_16p hist);
void png_set_iCCP (png_structp png_ptr, png_infop info_ptr, png_charp
name, int compression_type, png_charp profile, png_uint_32 proflen);
int png_set_interlace_handling (png_structp png_ptr);
void png_set_invalid (png_structp png_ptr, png_infop info_ptr, int
mask);
void png_set_invert_alpha (png_structp png_ptr);
void png_set_invert_mono (png_structp png_ptr);
void png_set_IHDR (png_structp png_ptr, png_infop info_ptr, png_uint_32
width, png_uint_32 height, int bit_depth, int color_type, int inter-
lace_type, int compression_type, int filter_type);
void png_set_keep_unknown_chunks (png_structp png_ptr, int keep,
png_bytep chunk_list, int num_chunks);
void png_set_mem_fn(png_structp png_ptr, png_voidp mem_ptr, png_mal-
loc_ptr malloc_fn, png_free_ptr free_fn);
void png_set_oFFs (png_structp png_ptr, png_infop info_ptr, png_uint_32
offset_x, png_uint_32 offset_y, int unit_type);
void png_set_packing (png_structp png_ptr);
void png_set_packswap (png_structp png_ptr);
void png_set_palette_to_rgb(png_structp png_ptr);
void png_set_pCAL (png_structp png_ptr, png_infop info_ptr, png_charp
purpose, png_int_32 X0, png_int_32 X1, int type, int nparams, png_charp
units(1,7), png_charpp params);
void png_set_pHYs (png_structp png_ptr, png_infop info_ptr, png_uint_32
res_x, png_uint_32 res_y, int unit_type);
void png_set_progressive_read_fn (png_structp png_ptr, png_voidp pro-
gressive_ptr, png_progressive_info_ptr info_fn, png_progressive_row_ptr
row_fn, png_progressive_end_ptr end_fn);
void png_set_PLTE (png_structp png_ptr, png_infop info_ptr, png_colorp
palette, int num_palette);
void png_set_read_fn (png_structp png_ptr, png_voidp io_ptr, png_rw_ptr
read_data_fn);
void png_set_read_status_fn (png_structp png_ptr, png_read_status_ptr
read_row_fn);
void png_set_read_user_transform_fn (png_structp png_ptr,
png_user_transform_ptr read_user_transform_fn);
void png_set_rgb_to_gray (png_structp png_ptr, int error_action, double
red, double green);
void png_set_rgb_to_gray_fixed (png_structp png_ptr, int error_action
png_fixed_point red, png_fixed_point green);
void png_set_rows (png_structp png_ptr, png_infop info_ptr, png_bytepp
row_pointers);
void png_set_sBIT (png_structp png_ptr, png_infop info_ptr,
png_color_8p sig_bit);
void png_set_sCAL (png_structp png_ptr, png_infop info_ptr, png_charp
unit, double width, double height);
void png_set_shift (png_structp png_ptr, png_color_8p true_bits);
void png_set_sig_bytes (png_structp png_ptr, int num_bytes);
void png_set_sPLT (png_structp png_ptr, png_infop info_ptr,
png_spalette_p splt_ptr, int num_spalettes);
void png_set_sRGB (png_structp png_ptr, png_infop info_ptr, int
intent);
void png_set_sRGB_gAMA_and_cHRM (png_structp png_ptr, png_infop
info_ptr, int intent);
void png_set_strip_16 (png_structp png_ptr);
void png_set_strip_alpha (png_structp png_ptr);
void png_set_swap (png_structp png_ptr);
void png_set_swap_alpha (png_structp png_ptr);
void png_set_text (png_structp png_ptr, png_infop info_ptr, png_textp
text_ptr, int num_text);
void png_set_tIME (png_structp png_ptr, png_infop info_ptr, png_timep
mod_time);
void png_set_tRNS (png_structp png_ptr, png_infop info_ptr, png_bytep
trans, int num_trans, png_color_16p trans_values);
void png_set_tRNS_to_alpha(png_structp png_ptr);
png_uint_32 png_set_unknown_chunks (png_structp png_ptr, png_infop
info_ptr, png_unknown_chunkp unknowns, int num, int location);
void png_set_unknown_chunk_location(png_structp png_ptr, png_infop
info_ptr, int chunk, int location);
void png_set_read_user_chunk_fn (png_structp png_ptr, png_voidp
user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn);
void png_set_user_limits (png_structp png_ptr, png_uint_32
user_width_max, png_uint_32 user_height_max);
void png_set_user_transform_info (png_structp png_ptr, png_voidp
user_transform_ptr, int user_transform_depth, int user_transform_chan-
nels);
void png_set_write_fn (png_structp png_ptr, png_voidp io_ptr,
png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn);
void png_set_write_status_fn (png_structp png_ptr, png_write_status_ptr
write_row_fn);
void png_set_write_user_transform_fn (png_structp png_ptr,
png_user_transform_ptr write_user_transform_fn);
void png_set_compression_buffer_size(png_structp png_ptr, png_uint_32
size);
int png_sig_cmp (png_bytep sig, png_size_t start, png_size_t
num_to_check);
void png_start_read_image (png_structp png_ptr);
void png_warning (png_structp png_ptr, png_const_charp message);
void png_write_chunk (png_structp png_ptr, png_bytep chunk_name,
png_bytep data, png_size_t length);
void png_write_chunk_data (png_structp png_ptr, png_bytep data,
png_size_t length);
void png_write_chunk_end (png_structp png_ptr);
void png_write_chunk_start (png_structp png_ptr, png_bytep chunk_name,
png_uint_32 length);
void png_write_destroy (png_structp png_ptr);
void png_write_end (png_structp png_ptr, png_infop info_ptr);
void png_write_flush (png_structp png_ptr);
void png_write_image (png_structp png_ptr, png_bytepp image);
DEPRECATED: void png_write_init (png_structp png_ptr);
DEPRECATED: void png_write_init_2 (png_structpp ptr_ptr,
png_const_charp user_png_ver, png_size_t png_struct_size, png_size_t
png_info_size);
void png_write_info (png_structp png_ptr, png_infop info_ptr);
void png_write_info_before_PLTE (png_structp png_ptr, png_infop
info_ptr);
void png_write_png (png_structp png_ptr, png_infop info_ptr, int trans-
forms, png_voidp params);
void png_write_row (png_structp png_ptr, png_bytep row);
void png_write_rows (png_structp png_ptr, png_bytepp row, png_uint_32
num_rows);
voidpf png_zalloc (voidpf png_ptr, uInt items, uInt size);
void png_zfree (voidpf png_ptr, voidpf ptr);
DESCRIPTION
The libpng library supports encoding(3,n), decoding, and various manipula-
tions of the Portable Network Graphics (PNG) format image files. It
uses the zlib(3) compression library. Following is a copy of the
libpng.txt file(1,n) that accompanies libpng.
LIBPNG.TXT
libpng.txt - A description on how to use and modify libpng
libpng version(1,3,5) 1.2.7 - September 12, 2004
Updated and distributed by Glenn Randers-Pehrson
<glennrp@users.sourceforge.net>
Copyright (c) 1998-2004 Glenn Randers-Pehrson
For conditions of distribution and use, see copyright
notice in(1,8) png.h.
based on:
libpng 1.0 beta 6 version(1,3,5) 0.96 May 28, 1997
Updated and distributed by Andreas Dilger
Copyright (c) 1996, 1997 Andreas Dilger
libpng 1.0 beta 2 - version(1,3,5) 0.88 January 26, 1996
For conditions of distribution and use, see copyright
notice in(1,8) png.h. Copyright (c) 1995, 1996 Guy Eric
Schalnat, Group 42, Inc.
Updated/rewritten per request in(1,8) the libpng FAQ
Copyright (c) 1995, 1996 Frank J. T. Wojcik
December 18, 1995 & January 20, 1996
I. Introduction
This file(1,n) describes how to use and modify the PNG reference library
(known as libpng) for your own use. There are five sections to this
file: introduction, structures, reading, writing, and modification and
configuration notes for various special platforms. In addition to this
file(1,n), example.c is a good starting point for using the library, as it
is heavily commented and should include everything most people will
need. We assume that libpng is already installed; see the INSTALL file(1,n)
for instructions on how to install libpng.
Libpng was written as a companion to the PNG specification, as a way of
reducing the amount of time(1,2,n) and effort it takes to support the PNG file(1,n)
format in(1,8) application programs.
The PNG specification (second edition), November 2003, is available as
a W3C Recommendation and as an ISO Standard (ISO/IEC 15948:2003 (E)) at
<http://www.w3.org/TR/2003/REC-PNG-20031110/ The W3C and ISO documents
have identical technical content.
The PNG-1.2 specification is available at
<http://www.libpng.org/pub/png/documents/>
The PNG-1.0 specification is available as RFC 2083
<http://www.libpng.org/pub/png/documents/> and as a W3C Recommendation
<http://www.w3.org/TR/REC.png.html>. Some additional chunks are
described in(1,8) the special-purpose public chunks documents at
<http://www.libpng.org/pub/png/documents/>.
Other information about PNG, and the latest version(1,3,5) of libpng, can be
found at the PNG home page, <http://www.libpng.org/pub/png/>.
Most users(1,5) will not have to modify the library significantly; advanced
users(1,5) may want to modify it more. All attempts were made to make it as
complete as possible, while keeping the code easy to understand. Cur-
rently, this library only supports C. Support for other languages is
being considered.
Libpng has been designed to handle multiple sessions at one time(1,2,n), to be
easily modifiable, to be portable to the vast majority of machines
(ANSI, K&R, 16-, 32-, and 64-bit) available, and to be easy to use.
The ultimate goal of libpng is to promote the acceptance of the PNG
file(1,n) format in(1,8) whatever way possible. While there is still work to be
done (see the TODO file(1,n)), libpng should cover the majority of the needs
of its users.
Libpng uses zlib for its compression and decompression of PNG files.
Further information about zlib, and the latest version(1,3,5) of zlib, can be
found at the zlib home page, <http://www.info-
zip.org/pub/infozip/zlib/>. The zlib compression utility is a general
purpose utility that is useful for more than PNG files, and can be used
without libpng. See the documentation delivered with zlib for more
details. You can usually find the source files for the zlib utility
wherever you find the libpng source files.
Libpng is thread safe, provided the threads are using different
instances of the structures. Each thread should have its own
png_struct and png_info instances, and thus its own image. Libpng does
not protect itself against two threads using the same instance of a
structure. Note: thread safety may be defeated by use of some of the
MMX assembler code in(1,8) pnggccrd.c, which is only compiled when the user
defines PNG_THREAD_UNSAFE_OK.
II. Structures
There are two main structures that are important to libpng, png_struct
and png_info. The first, png_struct, is an internal structure that
will not, for the most part, be used by a user except as the first
variable passed to every libpng function call.
The png_info structure is designed to provide information about the PNG
file. At one time(1,2,n), the fields of png_info were intended to be directly
accessible to the user. However, this tended to cause problems with
applications using dynamically loaded libraries, and as a result a set(7,n,1 builtins)
of interface functions for png_info (the png_get_*() and png_set_*()
functions) was developed. The fields of png_info are still available
for older applications, but it is suggested that applications use the
new interfaces if(3,n) at all possible.
Applications that do make direct access(2,5) to the members of png_struct
(except for png_ptr->jmpbuf) must be recompiled whenever the library is
updated, and applications that make direct access(2,5) to the members of
png_info must be recompiled if(3,n) they were compiled or loaded with libpng
version(1,3,5) 1.0.6, in(1,8) which the members were in(1,8) a different order. In ver-
sion(1,3,5) 1.0.7, the members of the png_info structure reverted to the old
order, as they were in(1,8) versions 0.97c through 1.0.5. Starting with
version(1,3,5) 2.0.0, both structures are going to be hidden, and the contents
of the structures will only be accessible through the png_get/png_set
functions.
The png.h header file(1,n) is an invaluable reference for programming with
libpng. And while I'm on the topic, make sure you include the libpng
header file:
#include <png.h>
III. Reading
We'll now walk you through the possible functions to call when reading
in(1,8) a PNG file(1,n) sequentially, briefly explaining the syntax and purpose
of each one. See example.c and png.h for more detail. While progres-
sive reading is covered in(1,8) the next section, you will still need some
of the functions discussed in(1,8) this section to read(2,n,1 builtins) a PNG file.
Setup
You will want to do the I/O initialization(*) before you get into
libpng, so if(3,n) it doesn't work, you don't have much to undo. Of course,
you will also want to insure that you are, in(1,8) fact, dealing with a PNG
file. Libpng provides a simple check to see if(3,n) a file(1,n) is a PNG file.
To use it, pass in(1,8) the first 1 to 8 bytes of the file(1,n) to the function
png_sig_cmp(), and it will return 0 if(3,n) the bytes match the correspond-
ing bytes of the PNG signature, or nonzero otherwise. Of course, the
more bytes you pass in(1,8), the greater the accuracy of the prediction.
If you are intending to keep the file(1,n) pointer open(2,3,n) for use in(1,8) libpng,
you must ensure you don't read(2,n,1 builtins) more than 8 bytes from the beginning of
the file(1,n), and you also have to make a call to png_set_sig_bytes_read()
with the number of bytes you read(2,n,1 builtins) from the beginning. Libpng will then
only check the bytes (if(3,n) any) that your program didn't read.
(*): If you are not using the standard I/O functions, you will need to
replace them with custom functions. See the discussion under Customiz-
ing libpng.
FILE *fp = fopen(file_name, "rb");
if(3,n) (!fp)
{
return (ERROR);
}
fread(header, 1, number, fp);
is_png = !png_sig_cmp(header, 0, number);
if(3,n) (!is_png)
{
return (NOT_PNG);
}
Next, png_struct and png_info need to be allocated and initialized. In
order to ensure that the size of these structures is correct even with
a dynamically linked libpng, there are functions to initialize and
allocate the structures. We also pass the library version(1,3,5), optional
pointers to error(8,n) handling functions, and a pointer to a data struct
for use by the error(8,n) functions, if(3,n) necessary (the pointer and functions
can be NULL if(3,n) the default error(8,n) handlers are to be used). See the
section on Changes to Libpng below regarding the old initialization
functions. The structure allocation functions quietly return NULL if(3,n)
they fail to create the structure, so your application should check for
that.
png_structp png_ptr = png_create_read_struct
(PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
user_error_fn, user_warning_fn);
if(3,n) (!png_ptr)
return (ERROR);
png_infop info_ptr = png_create_info_struct(png_ptr);
if(3,n) (!info_ptr)
{
png_destroy_read_struct(&png_ptr,
(png_infopp)NULL, (png_infopp)NULL);
return (ERROR);
}
png_infop end_info = png_create_info_struct(png_ptr);
if(3,n) (!end_info)
{
png_destroy_read_struct(&png_ptr, &info_ptr,
(png_infopp)NULL);
return (ERROR);
}
If you want to use your own memory allocation routines, define
PNG_USER_MEM_SUPPORTED and use png_create_read_struct_2() instead of
png_create_read_struct():
png_structp png_ptr = png_create_read_struct_2
(PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
user_error_fn, user_warning_fn, (png_voidp)
user_mem_ptr, user_malloc_fn, user_free_fn);
The error(8,n) handling routines passed to png_create_read_struct() and the
memory alloc/free routines passed to png_create_struct_2() are only
necessary if(3,n) you are not using the libpng supplied error(8,n) handling and
memory alloc/free functions.
When libpng encounters an error(8,n), it expects to longjmp back to your
routine. Therefore, you will need to call setjmp and pass your
png_jmpbuf(png_ptr). If you read(2,n,1 builtins) the file(1,n) from different routines, you
will need to update(7,n) the jmpbuf field every time(1,2,n) you enter a new routine
that will call a png_*() function.
See your documentation of setjmp/longjmp for your compiler for more
information on setjmp/longjmp. See the discussion on libpng error(8,n) han-
dling in(1,8) the Customizing Libpng section below for more information on
the libpng error(8,n) handling. If an error(8,n) occurs, and libpng longjmp's
back to your setjmp, you will want to call png_destroy_read_struct() to
free any memory.
if(3,n) (setjmp(png_jmpbuf(png_ptr)))
{
png_destroy_read_struct(&png_ptr, &info_ptr,
&end_info);
fclose(fp);
return (ERROR);
}
If you would rather avoid the complexity of setjmp/longjmp issues, you
can compile libpng with PNG_SETJMP_NOT_SUPPORTED, in(1,8) which case errors
will result in(1,8) a call to PNG_ABORT() which defaults to abort(3,7)().
Now you need to set(7,n,1 builtins) up the input code. The default for libpng is to
use the C function fread(). If you use this, you will need to pass a
valid FILE * in(1,8) the function png_init_io(). Be sure that the file(1,n) is
opened in(1,8) binary mode. If you wish to handle reading data in(1,8) another
way, you need not call the png_init_io() function, but you must then
implement the libpng I/O methods discussed in(1,8) the Customizing Libpng
section below.
png_init_io(png_ptr, fp);
If you had previously opened the file(1,n) and read(2,n,1 builtins) any of the signature
from the beginning in(1,8) order to see if(3,n) this was a PNG file(1,n), you need to
let libpng know that there are some bytes missing from the start of the
file.
png_set_sig_bytes(png_ptr, number);
Setting up callback code
You can set(7,n,1 builtins) up a callback function to handle any unknown chunks in(1,8) the
input stream. You must supply the function
read_chunk_callback(png_ptr ptr,
png_unknown_chunkp chunk);
{
/* The unknown chunk structure contains your
chunk data: */
png_byte name[5];
png_byte *data;
png_size_t size;
/* Note that libpng has already taken care of
the CRC handling */
/* put your code here. Return one of the
following: */
return (-n); /* chunk had an error(8,n) */
return (0); /* did not recognize */
return (n); /* success */
}
(You can give your function another name that you like instead of
"read_chunk_callback")
To inform libpng about your function, use
png_set_read_user_chunk_fn(png_ptr, user_chunk_ptr,
read_chunk_callback);
This names not only the callback function, but also a user pointer that
you can retrieve with
png_get_user_chunk_ptr(png_ptr);
At this point, you can set(7,n,1 builtins) up a callback function that will be called
after each row has been read(2,n,1 builtins), which you can use to control a progress
meter or the like. It's demonstrated in(1,8) pngtest.c. You must supply a
function
void read_row_callback(png_ptr ptr, png_uint_32 row,
int pass);
{
/* put your code here */
}
(You can give it another name that you like instead of "read_row_call-
back")
To inform libpng about your function, use
png_set_read_status_fn(png_ptr, read_row_callback);
Width and height limits
The PNG specification allows the width and height of an image to be as
large as 2^31-1 (0x7fffffff), or about 2.147 billion rows and columns.
Since very few applications really need to process such large images,
we have imposed an arbitrary 1-million limit on rows and columns.
Larger images will be rejected immediately with a png_error() call. If
you wish to override this limit, you can use
png_set_user_limits(png_ptr, width_max, height_max);
to set(7,n,1 builtins) your own limits, or use width_max = height_max = 0x7fffffffL to
allow all valid dimensions (libpng may reject some very large images
anyway because of potential buffer overflow conditions).
You should put this statement after you create the PNG structure and
before calling png_read_info(), png_read_png(), or png_process_data().
If you need to retrieve the limits that are being applied, use
width_max = png_get_user_width_max(png_ptr);
height_max = png_get_user_height_max(png_ptr);
Unknown-chunk handling
Now you get to set(7,n,1 builtins) the way the library processes unknown chunks in(1,8) the
input PNG stream. Both known and unknown chunks will be read. Normal
behavior is that known chunks will be parsed into information in(1,8) vari-
ous info_ptr members; unknown chunks will be discarded. To change this,
you can call:
png_set_keep_unknown_chunks(png_ptr, keep,
chunk_list, num_chunks);
keep - 0: do not handle as unknown
1: do not keep
2: keep only if(3,n) safe-to-copy
3: keep even if(3,n) unsafe-to-copy
You can use these definitions:
PNG_HANDLE_CHUNK_AS_DEFAULT 0
PNG_HANDLE_CHUNK_NEVER 1
PNG_HANDLE_CHUNK_IF_SAFE 2
PNG_HANDLE_CHUNK_ALWAYS 3
chunk_list - list of chunks affected (a byte string(3,n),
five bytes per chunk, NULL or ' ' if(3,n)
num_chunks is 0)
num_chunks - number of chunks affected; if(3,n) 0, all
unknown chunks are affected. If nonzero,
only the chunks in(1,8) the list are affected
Unknown chunks declared in(1,8) this way will be saved as raw(3x,7,8,3x cbreak) data onto a
list of png_unknown_chunk structures. If a chunk that is normally
known to libpng is named(5,8) in(1,8) the list, it will be handled as unknown,
according to the "keep" directive. If a chunk is named(5,8) in(1,8) successive
instances of png_set_keep_unknown_chunks(), the final instance will
take precedence. The IHDR and IEND chunks should not be named(5,8) in(1,8)
chunk_list; if(3,n) they are, libpng will process them normally anyway.
The high-level read(2,n,1 builtins) interface
At this point there are two ways to proceed; through the high-level
read(2,n,1 builtins) interface, or through a sequence of low-level read(2,n,1 builtins) operations.
You can use the high-level interface if(3,n) (a) you are willing to read(2,n,1 builtins) the
entire image into memory, and (b) the input transformations you want to
do are limited to the following set:
PNG_TRANSFORM_IDENTITY No transformation
PNG_TRANSFORM_STRIP_16 Strip 16-bit samples to
8 bits
PNG_TRANSFORM_STRIP_ALPHA Discard the alpha channel
PNG_TRANSFORM_PACKING Expand 1, 2 and 4-bit
samples to bytes
PNG_TRANSFORM_PACKSWAP Change order of packed
pixels to LSB first
PNG_TRANSFORM_EXPAND Perform set_expand()
PNG_TRANSFORM_INVERT_MONO Invert monochrome images
PNG_TRANSFORM_SHIFT Normalize pixels to the
sBIT depth
PNG_TRANSFORM_BGR Flip RGB to BGR, RGBA
to BGRA
PNG_TRANSFORM_SWAP_ALPHA Flip RGBA to ARGB or GA
to AG
PNG_TRANSFORM_INVERT_ALPHA Change alpha from opacity
to transparency
PNG_TRANSFORM_SWAP_ENDIAN Byte-swap 16-bit samples
(This excludes setting a background color, doing gamma transformation,
dithering, and setting filler.) If this is the case, simply do this:
png_read_png(png_ptr, info_ptr, png_transforms, NULL)
where png_transforms is an integer containing the logical OR of some
set(7,n,1 builtins) of transformation flags. This call is equivalent to
png_read_info(), followed the set(7,n,1 builtins) of transformations indicated by the
transform mask, then png_read_image(), and finally png_read_end().
(The final parameter of this call is not yet used. Someday it might
point to transformation parameters required by some future input trans-
form.)
You must use png_transforms and not call any png_set_transform() func-
tions when you use png_read_png().
After you have called png_read_png(), you can retrieve the image data
with
row_pointers = png_get_rows(png_ptr, info_ptr);
where row_pointers is an array of pointers to the pixel data for each
row:
png_bytep row_pointers[height];
If you know your image size and pixel size ahead of time(1,2,n), you can allo-
cate row_pointers prior to calling png_read_png() with
if(3,n) (height > PNG_UINT_32_MAX/png_sizeof(png_byte))
png_error (png_ptr,
"Image is too tall to process in(1,8) memory");
if(3,n) (width > PNG_UINT_32_MAX/pixel_size)
png_error (png_ptr,
"Image is too wide to process in(1,8) memory");
row_pointers = png_malloc(png_ptr,
height*png_sizeof(png_bytep));
for (int i=0; i<height, i++)
row_pointers[i]=png_malloc(png_ptr,
width*pixel_size);
png_set_rows(png_ptr, info_ptr, &row_pointers);
Alternatively you could allocate your image in(1,8) one big block and define
row_pointers[i] to point into the proper places in(1,8) your block.
If you use png_set_rows(), the application is responsible for freeing
row_pointers (and row_pointers[i], if(3,n) they were separately allocated).
If you don't allocate row_pointers ahead of time(1,2,n), png_read_png() will
do it, and it'll be free'ed when you call png_destroy_*().
The low-level read(2,n,1 builtins) interface
If you are going the low-level route, you are now ready to read(2,n,1 builtins) all the
file(1,n) information up to the actual image data. You do this with a call
to png_read_info().
png_read_info(png_ptr, info_ptr);
This will process all chunks up to but not including the image data.
Querying the info(1,5,n) structure
Functions are used to get the information from the info_ptr once it has
been read. Note that these fields may not be completely filled in(1,8)
until png_read_end() has read(2,n,1 builtins) the chunk data following the image.
png_get_IHDR(png_ptr, info_ptr, &width, &height,
&bit_depth, &color_type, &interlace_type,
&compression_type, &filter_method);
width - holds the width of the image
in(1,8) pixels (up to 2^31).
height - holds the height of the image
in(1,8) pixels (up to 2^31).
bit_depth - holds the bit depth of one of the
image channels. (valid values are
1, 2, 4, 8, 16 and depend also on
the color_type. See also
significant bits (sBIT) below).
color_type - describes which color/alpha channels
are present.
PNG_COLOR_TYPE_GRAY
(bit depths 1, 2, 4, 8, 16)
PNG_COLOR_TYPE_GRAY_ALPHA
(bit depths 8, 16)
PNG_COLOR_TYPE_PALETTE
(bit depths 1, 2, 4, 8)
PNG_COLOR_TYPE_RGB
(bit_depths 8, 16)
PNG_COLOR_TYPE_RGB_ALPHA
(bit_depths 8, 16)
PNG_COLOR_MASK_PALETTE
PNG_COLOR_MASK_COLOR
PNG_COLOR_MASK_ALPHA
filter_method - (must be PNG_FILTER_TYPE_BASE
for PNG 1.0, and can also be
PNG_INTRAPIXEL_DIFFERENCING if(3,n)
the PNG datastream is embedded in(1,8)
a MNG-1.0 datastream)
compression_type - (must be PNG_COMPRESSION_TYPE_BASE
for PNG 1.0)
interlace_type - (PNG_INTERLACE_NONE or
PNG_INTERLACE_ADAM7)
Any or all of interlace_type, compression_type, of
filter_method can be NULL if(3,n) you are
not interested in(1,8) their values.
channels = png_get_channels(png_ptr, info_ptr);
channels - number of channels of info(1,5,n) for the
color type (valid values are 1 (GRAY,
PALETTE), 2 (GRAY_ALPHA), 3 (RGB),
4 (RGB_ALPHA or RGB + filler byte))
rowbytes = png_get_rowbytes(png_ptr, info_ptr);
rowbytes - number of bytes needed to hold a row
signature = png_get_signature(png_ptr, info_ptr);
signature - holds the signature read(2,n,1 builtins) from the
file(1,n) (if(3,n) any). The data is kept in(1,8)
the same offset it would be if(3,n) the
whole signature were read(2,n,1 builtins) (i.e. if(3,n) an
application had already read(2,n,1 builtins) in(1,8) 4
bytes of signature before starting
libpng, the remaining 4 bytes would
be in(1,8) signature[4] through signature[7]
(see png_set_sig_bytes())).
width = png_get_image_width(png_ptr,
info_ptr);
height = png_get_image_height(png_ptr,
info_ptr);
bit_depth = png_get_bit_depth(png_ptr,
info_ptr);
color_type = png_get_color_type(png_ptr,
info_ptr);
filter_method = png_get_filter_type(png_ptr,
info_ptr);
compression_type = png_get_compression_type(png_ptr,
info_ptr);
interlace_type = png_get_interlace_type(png_ptr,
info_ptr);
These are also important, but their validity depends on whether the
chunk has been read. The png_get_valid(png_ptr, info_ptr,
PNG_INFO_<chunk>) and png_get_<chunk>(png_ptr, info_ptr, ...) functions
return non-zero if(3,n) the data has been read(2,n,1 builtins), or zero if(3,n) it is missing.
The parameters to the png_get_<chunk> are set(7,n,1 builtins) directly if(3,n) they are sim-
ple data types, or a pointer into the info_ptr is returned for any com-
plex types.
png_get_PLTE(png_ptr, info_ptr, &palette,
&num_palette);
palette - the palette for the file(1,n)
(array of png_color)
num_palette - number of entries in(1,8) the palette
png_get_gAMA(png_ptr, info_ptr, &gamma);
gamma - the gamma the file(1,n) is written
at (PNG_INFO_gAMA)
png_get_sRGB(png_ptr, info_ptr, &srgb_intent);
srgb_intent - the rendering intent (PNG_INFO_sRGB)
The presence of the sRGB chunk
means that the pixel data is in(1,8) the
sRGB color space. This chunk also
implies specific values of gAMA and
cHRM.
png_get_iCCP(png_ptr, info_ptr, &name,
&compression_type, &profile, &proflen);
name - The profile name.
compression - The compression type; always
PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
You may give NULL to this argument to
ignore it.
profile - International Color Consortium color
profile data. May contain NULs.
proflen - length of profile data in(1,8) bytes.
png_get_sBIT(png_ptr, info_ptr, &sig_bit);
sig_bit - the number of significant bits for
(PNG_INFO_sBIT) each of the gray,
red, green, and blue channels,
whichever are appropriate for the
given color type (png_color_16)
png_get_tRNS(png_ptr, info_ptr, &trans, &num_trans,
&trans_values);
trans - array of transparent entries for
palette (PNG_INFO_tRNS)
trans_values - graylevel or color sample values of
the single transparent color for
non-paletted images (PNG_INFO_tRNS)
num_trans - number of transparent entries
(PNG_INFO_tRNS)
png_get_hIST(png_ptr, info_ptr, &hist);
(PNG_INFO_hIST)
hist - histogram of palette (array of
png_uint_16)
png_get_tIME(png_ptr, info_ptr, &mod_time);
mod_time - time(1,2,n) image was last modified
(PNG_VALID_tIME)
png_get_bKGD(png_ptr, info_ptr, &background);
background - background color (PNG_VALID_bKGD)
valid 16-bit red, green and blue
values, regardless of color_type
num_comments = png_get_text(png_ptr, info_ptr,
&text_ptr, &num_text);
num_comments - number of comments
text_ptr - array of png_text holding image
comments
text_ptr[i].compression - type of compression used
on "text" PNG_TEXT_COMPRESSION_NONE
PNG_TEXT_COMPRESSION_zTXt
PNG_ITXT_COMPRESSION_NONE
PNG_ITXT_COMPRESSION_zTXt
text_ptr[i].key - keyword for comment. Must contain
1-79 characters.
text_ptr[i].text - text comments for current
keyword. Can be empty.
text_ptr[i].text_length - length of text string(3,n),
after decompression, 0 for iTXt
text_ptr[i].itxt_length - length of itxt string(3,n),
after decompression, 0 for tEXt/zTXt
text_ptr[i].lang - language of comment (empty
string(3,n) for unknown).
text_ptr[i].lang_key - keyword in(1,8) UTF-8
(empty string(3,n) for unknown).
num_text - number of comments (same as
num_comments; you can put NULL here
to avoid the duplication)
Note while png_set_text() will accept(2,8) text, language,
and translated keywords that can be NULL pointers, the
structure returned by png_get_text will always contain
regular zero-terminated C strings. They might be
empty strings but they will never be NULL pointers.
num_spalettes = png_get_sPLT(png_ptr, info_ptr,
&palette_ptr);
palette_ptr - array of palette structures holding
contents of one or more sPLT chunks
read.
num_spalettes - number of sPLT chunks read.
png_get_oFFs(png_ptr, info_ptr, &offset_x, &offset_y,
&unit_type);
offset_x - positive offset from the left edge
of the screen
offset_y - positive offset from the top edge
of the screen
unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
png_get_pHYs(png_ptr, info_ptr, &res_x, &res_y,
&unit_type);
res_x - pixels/unit physical resolution in(1,8)
x direction
res_y - pixels/unit physical resolution in(1,8)
x direction
unit_type - PNG_RESOLUTION_UNKNOWN,
PNG_RESOLUTION_METER
png_get_sCAL(png_ptr, info_ptr, &unit, &width,
&height)
unit - physical scale units(1,7) (an integer)
width - width of a pixel in(1,8) physical scale units(1,7)
height - height of a pixel in(1,8) physical scale units(1,7)
(width and height are doubles)
png_get_sCAL_s(png_ptr, info_ptr, &unit, &width,
&height)
unit - physical scale units(1,7) (an integer)
width - width of a pixel in(1,8) physical scale units(1,7)
height - height of a pixel in(1,8) physical scale units(1,7)
(width and height are strings like "2.54")
num_unknown_chunks = png_get_unknown_chunks(png_ptr,
info_ptr, &unknowns)
unknowns - array of png_unknown_chunk
structures holding unknown chunks
unknowns[i].name - name of unknown chunk
unknowns[i].data - data of unknown chunk
unknowns[i].size - size of unknown chunk's data
unknowns[i].location - position of chunk in(1,8) file(1,n)
The value of "i" corresponds to the order in(1,8) which the
chunks were read(2,n,1 builtins) from the PNG file(1,n) or inserted with the
png_set_unknown_chunks() function.
The data from the pHYs chunk can be retrieved in(1,8) several convenient
forms:
res_x = png_get_x_pixels_per_meter(png_ptr,
info_ptr)
res_y = png_get_y_pixels_per_meter(png_ptr,
info_ptr)
res_x_and_y = png_get_pixels_per_meter(png_ptr,
info_ptr)
res_x = png_get_x_pixels_per_inch(png_ptr,
info_ptr)
res_y = png_get_y_pixels_per_inch(png_ptr,
info_ptr)
res_x_and_y = png_get_pixels_per_inch(png_ptr,
info_ptr)
aspect_ratio = png_get_pixel_aspect_ratio(png_ptr,
info_ptr)
(Each of these returns 0 [signifying "unknown"] if(3,n)
the data is not present or if(3,n) res_x is 0;
res_x_and_y is 0 if(3,n) res_x != res_y)
The data from the oFFs chunk can be retrieved in(1,8) several convenient
forms:
x_offset = png_get_x_offset_microns(png_ptr, info_ptr);
y_offset = png_get_y_offset_microns(png_ptr, info_ptr);
x_offset = png_get_x_offset_inches(png_ptr, info_ptr);
y_offset = png_get_y_offset_inches(png_ptr, info_ptr);
(Each of these returns 0 [signifying "unknown" if(3,n) both
x and y are 0] if(3,n) the data is not present or if(3,n) the
chunk is present but the unit is the pixel)
For more information, see the png_info definition in(1,8) png.h and the PNG
specification for chunk contents. Be careful with trusting rowbytes,
as some of the transformations could increase the space needed to hold
a row (expand, filler, gray_to_rgb, etc.). See png_read_update_info(),
below.
A quick word about text_ptr and num_text. PNG stores comments in(1,8) key-
word/text pairs, one pair per chunk, with no limit on the number of
text chunks, and a 2^31 byte limit on their size. While there are sug-
gested keywords, there is no requirement to restrict the use to these
strings. It is strongly suggested that keywords and text be sensible
to humans (that's the point), so don't use abbreviations. Non-printing
symbols are not allowed. See the PNG specification for more details.
There is also no requirement to have text after the keyword.
Keywords should be limited to 79 Latin-1 characters without leading or
trailing spaces, but non-consecutive spaces are allowed within the key-
word. It is possible to have the same keyword any number of times.
The text_ptr is an array of png_text structures, each holding a pointer
to a language string(3,n), a pointer to a keyword and a pointer to a text
string. The text string(3,n), language code, and translated keyword may be
empty or NULL pointers. The keyword/text pairs are put into the array
in(1,8) the order that they are received. However, some or all of the text
chunks may be after the image, so, to make sure you have read(2,n,1 builtins) all the
text chunks, don't mess with these until after you read(2,n,1 builtins) the stuff after
the image. This will be mentioned again below in(1,8) the discussion that
goes with png_read_end().
Input transformations
After you've read(2,n,1 builtins) the header information, you can set(7,n,1 builtins) up the library to
handle any special transformations of the image data. The various ways
to transform the data will be described in(1,8) the order that they should
occur. This is important, as some of these change the color type
and/or bit depth of the data, and some others only work on certain
color types and bit depths. Even though each transformation checks to
see if(3,n) it has data that it can do something with, you should make sure
to only enable a transformation if(3,n) it will be valid for the data. For
example, don't swap red and blue on grayscale data.
The colors used for the background and transparency values should be
supplied in(1,8) the same format/depth as the current image data. They are
stored in(1,8) the same format/depth as the image data in(1,8) a bKGD or tRNS
chunk, so this is what libpng expects for this data. The colors are
transformed to keep in(1,8) sync(1,2,8) with the image data when an application
calls the png_read_update_info() routine (see below).
Data will be decoded into the supplied row buffers packed into bytes
unless the library has been told to transform it into another format.
For example, 4 bit/pixel paletted or grayscale data will be returned 2
pixels/byte with the leftmost pixel in(1,8) the high-order bits of the byte,
unless png_set_packing() is called. 8-bit RGB data will be stored in(1,8)
RGB RGB RGB format unless png_set_filler() or png_set_add_alpha() is
called to insert filler bytes, either before or after each RGB triplet.
16-bit RGB data will be returned RRGGBB RRGGBB, with the most signifi-
cant byte of the color value first, unless png_set_strip_16() is called
to transform it to regular RGB RGB triplets, or png_set_filler|add
alpha() is called to insert filler bytes, either before or after each
RRGGBB triplet. Similarly, 8-bit or 16-bit grayscale data can be modi-
fied with png_set_filler(), png_set_add_alpha(), or png_set_strip_16().
The following code transforms grayscale images of less(1,3) than 8 to 8
bits, changes paletted images to RGB, and adds a full alpha channel if(3,n)
there is transparency information in(1,8) a tRNS chunk. This is most useful
on grayscale images with bit depths of 2 or 4 or if(3,n) there is a multi-
ple-image viewing application that wishes to treat all images in(1,8) the
same way.
if(3,n) (color_type == PNG_COLOR_TYPE_PALETTE)
png_set_palette_to_rgb(png_ptr);
if(3,n) (color_type == PNG_COLOR_TYPE_GRAY &&
bit_depth < 8) png_set_gray_1_2_4_to_8(png_ptr);
if(3,n) (png_get_valid(png_ptr, info_ptr,
PNG_INFO_tRNS)) png_set_tRNS_to_alpha(png_ptr);
These three functions are actually aliases for png_set_expand(), added
in(1,8) libpng version(1,3,5) 1.0.4, with the function names expanded to improve
code readability. In some future version(1,3,5) they may actually do differ-
ent things.
PNG can have files with 16 bits per channel. If you only can handle 8
bits per channel, this will strip the pixels down to 8 bit.
if(3,n) (bit_depth == 16)
png_set_strip_16(png_ptr);
If, for some reason, you don't need the alpha channel on an image, and
you want to remove it rather than combining it with the background (but
the image author certainly had in(1,8) mind that you *would* combine it with
the background, so that's what you should probably do):
if(3,n) (color_type & PNG_COLOR_MASK_ALPHA)
png_set_strip_alpha(png_ptr);
In PNG files, the alpha channel in(1,8) an image is the level of opacity.
If you need the alpha channel in(1,8) an image to be the level of trans-
parency instead of opacity, you can invert the alpha channel (or the
tRNS chunk data) after it's read(2,n,1 builtins), so that 0 is fully opaque and 255 (in(1,8)
8-bit or paletted images) or 65535 (in(1,8) 16-bit images) is fully trans-
parent, with
png_set_invert_alpha(png_ptr);
PNG files pack(3,n,n pack-old) pixels of bit depths 1, 2, and 4 into bytes as small as
they can, resulting in(1,8), for example, 8 pixels per byte for 1 bit files.
This code expands to 1 pixel per byte without changing the values of
the pixels:
if(3,n) (bit_depth < 8)
png_set_packing(png_ptr);
PNG files have possible bit depths of 1, 2, 4, 8, and 16. All pixels
stored in(1,8) a PNG image have been "scaled" or "shifted" up to the next
higher possible bit depth (e.g. from 5 bits/sample in(1,8) the range [0,31]
to 8 bits/sample in(1,8) the range [0, 255]). However, it is also possible
to convert the PNG pixel data back to the original bit depth of the
image. This call reduces the pixels back down to the original bit
depth:
png_color_8p sig_bit;
if(3,n) (png_get_sBIT(png_ptr, info_ptr, &sig_bit))
png_set_shift(png_ptr, sig_bit);
PNG files store 3-color pixels in(1,8) red, green, blue order. This code
changes the storage of the pixels to blue, green, red:
if(3,n) (color_type == PNG_COLOR_TYPE_RGB ||
color_type == PNG_COLOR_TYPE_RGB_ALPHA)
png_set_bgr(png_ptr);
PNG files store RGB pixels packed into 3 or 6 bytes. This code expands
them into 4 or 8 bytes for windowing systems that need them in(1,8) this
format:
if(3,n) (color_type == PNG_COLOR_TYPE_RGB)
png_set_filler(png_ptr, filler, PNG_FILLER_BEFORE);
where "filler" is the 8 or 16-bit number to fill with, and the location
is either PNG_FILLER_BEFORE or PNG_FILLER_AFTER, depending upon whether
you want the filler before the RGB or after. This transformation does
not affect images that already have full alpha channels. To add an
opaque alpha channel, use filler=0xff or 0xffff and PNG_FILLER_AFTER
which will generate RGBA pixels.
Note that png_set_filler() does not change the color type. If you want
to do that, you can add a true alpha channel with
if(3,n) (color_type == PNG_COLOR_TYPE_RGB ||
color_type == PNG_COLOR_TYPE_GRAY)
png_set_add_alpha(png_ptr, filler, PNG_FILLER_AFTER);
where "filler" contains the alpha value to assign to each pixel. This
function became available in(1,8) libpng-1.2.7.
If you are reading an image with an alpha channel, and you need the
data as ARGB instead of the normal PNG format RGBA:
if(3,n) (color_type == PNG_COLOR_TYPE_RGB_ALPHA)
png_set_swap_alpha(png_ptr);
For some uses, you may want a grayscale image to be represented as RGB.
This code will do that conversion:
if(3,n) (color_type == PNG_COLOR_TYPE_GRAY ||
color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
png_set_gray_to_rgb(png_ptr);
Conversely, you can convert an RGB or RGBA image to grayscale or
grayscale with alpha.
if(3,n) (color_type == PNG_COLOR_TYPE_RGB ||
color_type == PNG_COLOR_TYPE_RGB_ALPHA)
png_set_rgb_to_gray_fixed(png_ptr, error_action,
int red_weight, int green_weight);
error_action = 1: silently do the conversion
error_action = 2: issue a warning if(3,n) the original
image has any pixel where
red != green or red != blue
error_action = 3: issue an error(8,n) and abort(3,7) the
conversion if(3,n) the original
image has any pixel where
red != green or red != blue
red_weight: weight of red component times 100000
green_weight: weight of green component times 100000
If either weight is negative, default
weights (21268, 71514) are used.
If you have set(7,n,1 builtins) error_action = 1 or 2, you can later check whether the
image really was gray, after processing the image rows, with the
png_get_rgb_to_gray_status(png_ptr) function. It will return a
png_byte that is zero if(3,n) the image was gray or 1 if(3,n) there were any non-
gray pixels. bKGD and sBIT data will be silently converted to
grayscale, using the green channel data, regardless of the error_action
setting.
With red_weight+green_weight<=100000, the normalized graylevel is com-
puted:
int rw = red_weight * 65536;
int gw = green_weight * 65536;
int bw = 65536 - (rw + gw);
gray = (rw*red + gw*green + bw*blue)/65536;
The default values approximate those recommended in(1,8) the Charles Poyn-
ton's Color FAQ, <http://www.inforamp.net/~poynton/> Copyright (c)
1998-01-04 Charles Poynton poynton@inforamp.net
Y = 0.212671 * R + 0.715160 * G + 0.072169 * B
Libpng approximates this with
Y = 0.21268 * R + 0.7151 * G + 0.07217 * B
which can be expressed with integers as
Y = (6969 * R + 23434 * G + 2365 * B)/32768
The calculation is done in(1,8) a linear colorspace, if(3,n) the image gamma is
known.
If you have a grayscale and you are using png_set_expand_depth(),
png_set_expand(), or png_set_gray_to_rgb to change to truecolor or to a
higher bit-depth, you must either supply the background color as a gray
value at the original file(1,n) bit-depth (need_expand = 1) or else supply
the background color as an RGB triplet at the final, expanded bit depth
(need_expand = 0). Similarly, if(3,n) you are reading a paletted image, you
must either supply the background color as a palette index (need_expand
= 1) or as an RGB triplet that may or may not be in(1,8) the palette
(need_expand = 0).
png_color_16 my_background;
png_color_16p image_background;
if(3,n) (png_get_bKGD(png_ptr, info_ptr, &image_background))
png_set_background(png_ptr, image_background,
PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
else
png_set_background(png_ptr, &my_background,
PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
The png_set_background() function tells libpng to composite images with
alpha or simple transparency against the supplied background color. If
the PNG file(1,n) contains a bKGD chunk (PNG_INFO_bKGD valid), you may use
this color, or supply another color more suitable for the current dis-
play (e.g., the background color from a web page). You need to tell
libpng whether the color is in(1,8) the gamma space of the display
(PNG_BACKGROUND_GAMMA_SCREEN for colors you supply), the file(1,n)
(PNG_BACKGROUND_GAMMA_FILE for colors from the bKGD chunk), or one that
is neither of these gammas (PNG_BACKGROUND_GAMMA_UNIQUE - I don't know
why anyone would use this, but it's here).
To properly display PNG images on any kind of system, the application
needs to know what the display gamma is. Ideally, the user will know
this, and the application will allow them to set(7,n,1 builtins) it. One method of
allowing the user to set(7,n,1 builtins) the display gamma separately for each system
is to check for a SCREEN_GAMMA or DISPLAY_GAMMA environment variable,
which will hopefully be correctly set.
Note that display_gamma is the overall gamma correction required to
produce pleasing results, which depends on the lighting conditions in(1,8)
the surrounding environment. In a dim or brightly lit room, no compen-
sation other than the physical gamma exponent of the monitor is needed,
while in(1,8) a dark room a slightly smaller exponent is better.
double gamma, screen_gamma;
if(3,n) (/* We have a user-defined screen
gamma value */)
{
screen_gamma = user_defined_screen_gamma;
}
/* One way that applications can share the same
screen gamma value */
else if(3,n) ((gamma_str = getenv("SCREEN_GAMMA"))
!= NULL)
{
screen_gamma = (double)atof(gamma_str);
}
/* If we don't have another value */
else
{
screen_gamma = 2.2; /* A good guess for a
PC monitor in(1,8) a bright office or a dim room */
screen_gamma = 2.0; /* A good guess for a
PC monitor in(1,8) a dark room */
screen_gamma = 1.7 or 1.0; /* A good
guess for Mac systems */
}
The png_set_gamma() function handles gamma transformations of the data.
Pass both the file(1,n) gamma and the current screen_gamma. If the file(1,n)
does not have a gamma value, you can pass one anyway if(3,n) you have an
idea what it is (usually 0.45455 is a good guess for GIF images on
PCs). Note that file(1,n) gammas are inverted from screen gammas. See the
discussions on gamma in(1,8) the PNG specification for an excellent descrip-
tion of what gamma is, and why all applications should support it. It
is strongly recommended that PNG viewers support gamma correction.
if(3,n) (png_get_gAMA(png_ptr, info_ptr, &gamma))
png_set_gamma(png_ptr, screen_gamma, gamma);
else
png_set_gamma(png_ptr, screen_gamma, 0.45455);
If you need to reduce an RGB file(1,n) to a paletted file(1,n), or if(3,n) a paletted
file(1,n) has more entries then will fit on your screen, png_set_dither()
will do that. Note that this is a simple match dither that merely
finds the closest color available. This should work fairly well with
optimized palettes, and fairly badly with linear color cubes. If you
pass a palette that is larger then maximum_colors, the file(1,n) will reduce
the number of colors in(1,8) the palette so it will fit into maximum_colors.
If there is a histogram, it will use it to make more intelligent
choices when reducing the palette. If there is no histogram, it may
not do as good a job.
if(3,n) (color_type & PNG_COLOR_MASK_COLOR)
{
if(3,n) (png_get_valid(png_ptr, info_ptr,
PNG_INFO_PLTE))
{
png_uint_16p histogram = NULL;
png_get_hIST(png_ptr, info_ptr,
&histogram);
png_set_dither(png_ptr, palette, num_palette,
max_screen_colors, histogram, 1);
}
else
{
png_color std_color_cube[MAX_SCREEN_COLORS] =
{ ... colors ... };
png_set_dither(png_ptr, std_color_cube,
MAX_SCREEN_COLORS, MAX_SCREEN_COLORS,
NULL,0);
}
}
PNG files describe monochrome as black being zero and white being one.
The following code will reverse this (make black be one and white be
zero):
if(3,n) (bit_depth == 1 && color_type == PNG_COLOR_TYPE_GRAY)
png_set_invert_mono(png_ptr);
This function can also be used to invert grayscale and gray-alpha
images:
if(3,n) (color_type == PNG_COLOR_TYPE_GRAY ||
color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
png_set_invert_mono(png_ptr);
PNG files store 16 bit pixels in(1,8) network byte order (big-endian, ie.
most significant bits first). This code changes the storage to the
other way (little-endian, i.e. least significant bits first, the way
PCs store them):
if(3,n) (bit_depth == 16)
png_set_swap(png_ptr);
If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
need to change the order the pixels are packed into bytes, you can use:
if(3,n) (bit_depth < 8)
png_set_packswap(png_ptr);
Finally, you can write(1,2) your own transformation function if(3,n) none of the
existing ones meets your needs. This is done by setting a callback
with
png_set_read_user_transform_fn(png_ptr,
read_transform_fn);
You must supply the function
void read_transform_fn(png_ptr ptr, row_info_ptr
row_info, png_bytep data)
See pngtest.c for a working example. Your function will be called
after all of the other transformations have been processed.
You can also set(7,n,1 builtins) up a pointer to a user structure for use by your call-
back function, and you can inform libpng that your transform function
will change the number of channels or bit depth with the function
png_set_user_transform_info(png_ptr, user_ptr,
user_depth, user_channels);
The user's application, not libpng, is responsible for allocating and
freeing any memory required for the user structure.
You can retrieve the pointer via the function png_get_user_trans-
form_ptr(). For example:
voidp read_user_transform_ptr =
png_get_user_transform_ptr(png_ptr);
The last thing to handle is interlacing; this is covered in(1,8) detail
below, but you must call the function here if(3,n) you want libpng to handle
expansion of the interlaced image.
number_of_passes = png_set_interlace_handling(png_ptr);
After setting the transformations, libpng can update(7,n) your png_info
structure to reflect any transformations you've requested with this
call. This is most useful to update(7,n) the info(1,5,n) structure's rowbytes
field so you can use it to allocate your image memory. This function
will also update(7,n) your palette with the correct screen_gamma and back-
ground if(3,n) these have been given with the calls above.
png_read_update_info(png_ptr, info_ptr);
After you call png_read_update_info(), you can allocate any memory you
need to hold the image. The row data is simply raw(3x,7,8,3x cbreak) byte data for all
forms of images. As the actual allocation varies among applications,
no example will be given. If you are allocating one large chunk, you
will need to build an array of pointers to each row, as it will be
needed for some of the functions below.
Reading image data
After you've allocated memory, you can read(2,n,1 builtins) the image data. The sim-
plest way to do this is in(1,8) one function call. If you are allocating
enough memory to hold the whole image, you can just call
png_read_image() and libpng will read(2,n,1 builtins) in(1,8) all the image data and put it
in(1,8) the memory area supplied. You will need to pass in(1,8) an array of
pointers to each row.
This function automatically handles interlacing, so you don't need to
call png_set_interlace_handling() or call this function multiple times,
or any of that other stuff necessary with png_read_rows().
png_read_image(png_ptr, row_pointers);
where row_pointers is:
png_bytep row_pointers[height];
You can point to void or char or whatever you use for pixels.
If you don't want to read(2,n,1 builtins) in(1,8) the whole image at once, you can use
png_read_rows() instead. If there is no interlacing (check inter-
lace_type == PNG_INTERLACE_NONE), this is simple:
png_read_rows(png_ptr, row_pointers, NULL,
number_of_rows);
where row_pointers is the same as in(1,8) the png_read_image() call.
If you are doing this just one row at a time(1,2,n), you can do this with a
single row_pointer instead of an array of row_pointers:
png_bytep row_pointer = row;
png_read_row(png_ptr, row_pointer, NULL);
If the file(1,n) is interlaced (interlace_type != 0 in(1,8) the IHDR chunk),
things get somewhat harder. The only current (PNG Specification ver-
sion(1,3,5) 1.2) interlacing type for PNG is (interlace_type == PNG_INTER-
LACE_ADAM7) is a somewhat complicated 2D interlace scheme, known as
Adam7, that breaks down an image into seven smaller images of varying
size, based on an 8x8 grid.
libpng can fill out those images or it can give them to you "as is".
If you want them filled out, there are two ways to do that. The one
mentioned in(1,8) the PNG specification is to expand each pixel to cover
those pixels that have not been read(2,n,1 builtins) yet (the "rectangle" method).
This results in(1,8) a blocky image for the first pass, which gradually
smooths out as more pixels are read. The other method is the "sparkle"
method, where pixels are drawn only in(1,8) their final locations, with the
rest of the image remaining whatever colors they were initialized to
before the start of the read. The first method usually looks better,
but tends to be slower, as there are more pixels to put in(1,8) the rows.
If you don't want libpng to handle the interlacing details, just call
png_read_rows() seven times to read(2,n,1 builtins) in(1,8) all seven images. Each of the
images is a valid image by itself, or they can all be combined on an
8x8 grid to form a single image (although if(3,n) you intend to combine them
you would be far better off using the libpng interlace handling).
The first pass will return an image 1/8 as wide as the entire image
(every 8th column starting in(1,8) column 0) and 1/8 as high as the original
(every 8th row starting in(1,8) row 0), the second will be 1/8 as wide
(starting in(1,8) column 4) and 1/8 as high (also starting in(1,8) row 0). The
third pass will be 1/4 as wide (every 4th pixel starting in(1,8) column 0)
and 1/8 as high (every 8th row starting in(1,8) row 4), and the fourth pass
will be 1/4 as wide and 1/4 as high (every 4th column starting in(1,8) col-
umn 2, and every 4th row starting in(1,8) row 0). The fifth pass will
return an image 1/2 as wide, and 1/4 as high (starting at column 0 and
row 2), while the sixth pass will be 1/2 as wide and 1/2 as high as the
original (starting in(1,8) column 1 and row 0). The seventh and final pass
will be as wide as the original, and 1/2 as high, containing all of the
odd numbered scanlines. Phew!
If you want libpng to expand the images, call this before calling
png_start_read_image() or png_read_update_info():
if(3,n) (interlace_type == PNG_INTERLACE_ADAM7)
number_of_passes
= png_set_interlace_handling(png_ptr);
This will return the number of passes needed. Currently, this is
seven, but may change if(3,n) another interlace type is added. This func-
tion can be called even if(3,n) the file(1,n) is not interlaced, where it will
return one pass.
If you are not going to display the image after each pass, but are
going to wait until the entire image is read(2,n,1 builtins) in(1,8), use the sparkle
effect. This effect is faster and the end result of either method is
exactly the same. If you are planning on displaying the image after
each pass, the "rectangle" effect is generally considered the better
looking one.
If you only want the "sparkle" effect, just call png_read_rows() as
normal, with the third parameter NULL. Make sure you make pass over
the image number_of_passes times, and you don't change the data in(1,8) the
rows between calls. You can change the locations of the data, just not
the data. Each pass only writes the pixels appropriate for that pass,
and assumes the data from previous passes is still valid.
png_read_rows(png_ptr, row_pointers, NULL,
number_of_rows);
If you only want the first effect (the rectangles), do the same as
before except pass the row buffer in(1,8) the third parameter, and leave the
second parameter NULL.
png_read_rows(png_ptr, NULL, row_pointers,
number_of_rows);
Finishing a sequential read(2,n,1 builtins)
After you are finished reading the image through either the high- or
low-level interfaces, you can finish reading the file. If you are
interested in(1,8) comments or time(1,2,n), which may be stored either before or
after the image data, you should pass the separate png_info struct if(3,n)
you want to keep the comments from before and after the image separate.
If you are not interested, you can pass NULL.
png_read_end(png_ptr, end_info);
When you are done, you can free all memory allocated by libpng like
this:
png_destroy_read_struct(&png_ptr, &info_ptr,
&end_info);
It is also possible to individually free the info_ptr members that
point to libpng-allocated storage with the following function:
png_free_data(png_ptr, info_ptr, mask, seq)
mask - identifies data to be freed, a mask
containing the logical OR of one or
more of
PNG_FREE_PLTE, PNG_FREE_TRNS,
PNG_FREE_HIST, PNG_FREE_ICCP,
PNG_FREE_PCAL, PNG_FREE_ROWS,
PNG_FREE_SCAL, PNG_FREE_SPLT,
PNG_FREE_TEXT, PNG_FREE_UNKN,
or simply PNG_FREE_ALL
seq - sequence number of item to be freed
(-1 for all items)
This function may be safely called when the relevant storage has
already been freed, or has not yet been allocated, or was allocated by
the user and not by libpng, and will in(1,8) those cases do nothing. The
"seq" parameter is ignored if(3,n) only one item of the selected data type,
such as PLTE, is allowed. If "seq" is not -1, and multiple items are
allowed for the data type identified in(1,8) the mask, such as text or sPLT,
only the n'th item in(1,8) the structure is freed, where n is "seq".
The default behavior is only to free data that was allocated internally
by libpng. This can be changed, so that libpng will not free the data,
or so that it will free data that was allocated by the user with
png_malloc() or png_zalloc() and passed in(1,8) via a png_set_*() function,
with
png_data_freer(png_ptr, info_ptr, freer, mask)
mask - which data elements are affected
same choices as in(1,8) png_free_data()
freer - one of
PNG_DESTROY_WILL_FREE_DATA
PNG_SET_WILL_FREE_DATA
PNG_USER_WILL_FREE_DATA
This function only affects data that has already been allocated. You
can call this function after reading the PNG data but before calling
any png_set_*() functions, to control whether the user or the
png_set_*() function is responsible for freeing any existing data that
might be present, and again after the png_set_*() functions to control
whether the user or png_destroy_*() is supposed to free the data. When
the user assumes responsibility for libpng-allocated data, the applica-
tion must use png_free() to free it, and when the user transfers
responsibility to libpng for data that the user has allocated, the user
must have used png_malloc() or png_zalloc() to allocate it.
If you allocated your row_pointers in(1,8) a single block, as suggested
above in(1,8) the description of the high level read(2,n,1 builtins) interface, you must not
transfer responsibility for freeing it to the png_set_rows or
png_read_destroy function, because they would also try to free the
individual row_pointers[i].
If you allocated text_ptr.text, text_ptr.lang, and text_ptr.trans-
lated_keyword separately, do not transfer responsibility for freeing
text_ptr to libpng, because when libpng fills a png_text structure it
combines these members with the key member, and png_free_data() will
free only text_ptr.key. Similarly, if(3,n) you transfer responsibility for
free'ing text_ptr from libpng to your application, your application
must not separately free those members.
The png_free_data() function will turn off the "valid" flag for any-
thing it frees. If you need to turn the flag off for a chunk that was
freed by your application instead of by libpng, you can use
png_set_invalid(png_ptr, info_ptr, mask);
mask - identifies the chunks to be made invalid,
containing the logical OR of one or
more of
PNG_INFO_gAMA, PNG_INFO_sBIT,
PNG_INFO_cHRM, PNG_INFO_PLTE,
PNG_INFO_tRNS, PNG_INFO_bKGD,
PNG_INFO_hIST, PNG_INFO_pHYs,
PNG_INFO_oFFs, PNG_INFO_tIME,
PNG_INFO_pCAL, PNG_INFO_sRGB,
PNG_INFO_iCCP, PNG_INFO_sPLT,
PNG_INFO_sCAL, PNG_INFO_IDAT
For a more compact example of reading a PNG image, see the file(1,n) exam-
ple.c.
Reading PNG files progressively
The progressive reader is slightly different then the non-progressive
reader. Instead of calling png_read_info(), png_read_rows(), and
png_read_end(), you make one call to png_process_data(), which calls
callbacks when it has the info(1,5,n), a row, or the end of the image. You
set(7,n,1 builtins) up these callbacks with png_set_progressive_read_fn(). You don't
have to worry about the input/output functions of libpng, as you are
giving the library the data directly in(1,8) png_process_data(). I will
assume that you have read(2,n,1 builtins) the section on reading PNG files above, so I
will only highlight the differences (although I will show all of the
code).
png_structp png_ptr; png_infop info_ptr;
/* An example code fragment of how you would
initialize the progressive reader in(1,8) your
application. */
int
initialize_png_reader()
{
png_ptr = png_create_read_struct
(PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
user_error_fn, user_warning_fn);
if(3,n) (!png_ptr)
return (ERROR);
info_ptr = png_create_info_struct(png_ptr);
if(3,n) (!info_ptr)
{
png_destroy_read_struct(&png_ptr, (png_infopp)NULL,
(png_infopp)NULL);
return (ERROR);
}
if(3,n) (setjmp(png_jmpbuf(png_ptr)))
{
png_destroy_read_struct(&png_ptr, &info_ptr,
(png_infopp)NULL);
return (ERROR);
}
/* This one's new. You can provide functions
to be called when the header info(1,5,n) is valid,
when each row is completed, and when the image
is finished. If you aren't using all functions,
you can specify NULL parameters. Even when all
three functions are NULL, you need to call
png_set_progressive_read_fn(). You can use
any struct as the user_ptr (cast to a void pointer
for the function call), and retrieve the pointer
from inside the callbacks using the function
png_get_progressive_ptr(png_ptr);
which will return a void pointer, which you have
to cast appropriately.
*/
png_set_progressive_read_fn(png_ptr, (void *)user_ptr,
info_callback, row_callback, end_callback);
return 0;
}
/* A code fragment that you call as you receive blocks
of data */
int
process_data(png_bytep buffer, png_uint_32 length)
{
if(3,n) (setjmp(png_jmpbuf(png_ptr)))
{
png_destroy_read_struct(&png_ptr, &info_ptr,
(png_infopp)NULL);
return (ERROR);
}
/* This one's new also. Simply give it a chunk
of data from the file(1,n) stream (in(1,8) order, of
course). On machines with segmented memory
models machines, don't give it any more than
64K. The library seems to run fine with sizes
of 4K. Although you can give it much less(1,3) if(3,n)
necessary (I assume you can give it chunks of
1 byte, I haven't tried less(1,3) then 256 bytes
yet). When this function returns, you may
want to display any rows that were generated
in(1,8) the row callback if(3,n) you don't already do
so there.
*/
png_process_data(png_ptr, info_ptr, buffer, length);
return 0;
}
/* This function is called (as set(7,n,1 builtins) by
png_set_progressive_read_fn() above) when enough data
has been supplied so all of the header has been
read.
*/
void
info_callback(png_structp png_ptr, png_infop info(1,5,n))
{
/* Do any setup(2,8) here, including setting any of
the transformations mentioned in(1,8) the Reading
PNG files section. For now, you _must_ call
either png_start_read_image() or
png_read_update_info() after all the
transformations are set(7,n,1 builtins) (even if(3,n) you don't set(7,n,1 builtins)
any). You may start getting rows before
png_process_data() returns, so this is your
last chance to prepare for that.
*/
}
/* This function is called when each row of image
data is complete */
void
row_callback(png_structp png_ptr, png_bytep new_row,
png_uint_32 row_num, int pass)
{
/* If the image is interlaced, and you turned
on the interlace handler, this function will
be called for every row in(1,8) every pass. Some
of these rows will not be changed from the
previous pass. When the row is not changed,
the new_row variable will be NULL. The rows
and passes are called in(1,8) order, so you don't
really need the row_num and pass, but I'm
supplying them because it may make your life
easier.
For the non-NULL rows of interlaced images,
you must call png_progressive_combine_row()
passing in(1,8) the row and the old row. You can
call this function for NULL rows (it will just
return) and for non-interlaced images (it just
does the memcpy for you) if(3,n) it will make the
code easier. Thus, you can just do this for
all cases:
*/
png_progressive_combine_row(png_ptr, old_row,
new_row);
/* where old_row is what was displayed for
previously for the row. Note that the first
pass (pass == 0, really) will completely cover
the old row, so the rows do not have to be
initialized. After the first pass (and only
for interlaced images), you will have to pass
the current row, and the function will combine
the old row and the new row.
*/
}
void
end_callback(png_structp png_ptr, png_infop info(1,5,n))
{
/* This function is called after the whole image
has been read(2,n,1 builtins), including any chunks after the
image (up to and including the IEND). You
will usually have the same info(1,5,n) chunk as you
had in(1,8) the header, although some data may have
been added to the comments and time(1,2,n) fields.
Most people won't do much here, perhaps setting
a flag that marks the image as finished.
*/
}
IV. Writing
Much of this is very similar to reading. However, everything of impor-
tance is repeated here, so you won't have to constantly look(1,8,3 Search::Dict) back up in(1,8)
the reading section to understand writing.
Setup
You will want to do the I/O initialization before you get into libpng,
so if(3,n) it doesn't work, you don't have anything to undo. If you are not
using the standard I/O functions, you will need to replace them with
custom writing functions. See the discussion under Customizing libpng.
FILE *fp = fopen(file_name, "wb");
if(3,n) (!fp)
{
return (ERROR);
}
Next, png_struct and png_info need to be allocated and initialized. As
these can be both relatively large, you may not want to store these on
the stack, unless you have stack space to spare. Of course, you will
want to check if(3,n) they return NULL. If you are also reading, you won't
want to name your read(2,n,1 builtins) structure and your write(1,2) structure both
"png_ptr"; you can call them anything you like, such as "read_ptr" and
"write_ptr". Look at pngtest.c, for example.
png_structp png_ptr = png_create_write_struct
(PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
user_error_fn, user_warning_fn);
if(3,n) (!png_ptr)
return (ERROR);
png_infop info_ptr = png_create_info_struct(png_ptr);
if(3,n) (!info_ptr)
{
png_destroy_write_struct(&png_ptr,
(png_infopp)NULL);
return (ERROR);
}
If you want to use your own memory allocation routines, define
PNG_USER_MEM_SUPPORTED and use png_create_write_struct_2() instead of
png_create_write_struct():
png_structp png_ptr = png_create_write_struct_2
(PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
user_error_fn, user_warning_fn, (png_voidp)
user_mem_ptr, user_malloc_fn, user_free_fn);
After you have these structures, you will need to set(7,n,1 builtins) up the error(8,n) han-
dling. When libpng encounters an error(8,n), it expects to longjmp() back
to your routine. Therefore, you will need to call setjmp() and pass
the png_jmpbuf(png_ptr). If you write(1,2) the file(1,n) from different rou-
tines, you will need to update(7,n) the png_jmpbuf(png_ptr) every time(1,2,n) you
enter a new routine that will call a png_*() function. See your docu-
mentation of setjmp/longjmp for your compiler for more information on
setjmp/longjmp. See the discussion on libpng error(8,n) handling in(1,8) the
Customizing Libpng section below for more information on the libpng
error(8,n) handling.
if(3,n) (setjmp(png_jmpbuf(png_ptr)))
{
png_destroy_write_struct(&png_ptr, &info_ptr);
fclose(fp);
return (ERROR);
}
...
return;
If you would rather avoid the complexity of setjmp/longjmp issues, you
can compile libpng with PNG_SETJMP_NOT_SUPPORTED, in(1,8) which case errors
will result in(1,8) a call to PNG_ABORT() which defaults to abort(3,7)().
Now you need to set(7,n,1 builtins) up the output code. The default for libpng is to
use the C function fwrite(). If you use this, you will need to pass a
valid FILE * in(1,8) the function png_init_io(). Be sure that the file(1,n) is
opened in(1,8) binary mode. Again, if(3,n) you wish to handle writing data in(1,8)
another way, see the discussion on libpng I/O handling in(1,8) the Customiz-
ing Libpng section below.
png_init_io(png_ptr, fp);
Write callbacks
At this point, you can set(7,n,1 builtins) up a callback function that will be called
after each row has been written, which you can use to control a
progress meter or the like. It's demonstrated in(1,8) pngtest.c. You must
supply a function
void write_row_callback(png_ptr, png_uint_32 row,
int pass);
{
/* put your code here */
}
(You can give it another name that you like instead of "write_row_call-
back")
To inform libpng about your function, use
png_set_write_status_fn(png_ptr, write_row_callback);
You now have the option of modifying how the compression library will
run. The following functions are mainly for testing, but may be useful
in(1,8) some cases, like if(3,n) you need to write(1,2) PNG files extremely fast and
are willing to give up some compression, or if(3,n) you want to get the max-
imum possible compression at the expense of slower writing. If you
have no special needs in(1,8) this area, let the library do what it wants by
not calling this function at all, as it has been tuned to deliver a
good speed/compression ratio. The second parameter to png_set_filter()
is the filter(1,3x,3x curs_util) method, for which the only valid values are 0 (as of the
July 1999 PNG specification, version(1,3,5) 1.2) or 64 (if(3,n) you are writing a
PNG datastream that is to be embedded in(1,8) a MNG datastream). The third
parameter is a flag that indicates which filter(1,3x,3x curs_util) type(s) are to be
tested for each scanline. See the PNG specification for details on the
specific filter(1,3x,3x curs_util) types.
/* turn on or off filtering, and/or choose
specific filters. You can use either a single
PNG_FILTER_VALUE_NAME or the logical OR of one
or more PNG_FILTER_NAME masks. */
png_set_filter(png_ptr, 0,
PNG_FILTER_NONE | PNG_FILTER_VALUE_NONE |
PNG_FILTER_SUB | PNG_FILTER_VALUE_SUB |
PNG_FILTER_UP | PNG_FILTER_VALUE_UP |
PNG_FILTER_AVE | PNG_FILTER_VALUE_AVE |
PNG_FILTER_PAETH | PNG_FILTER_VALUE_PAETH|
PNG_ALL_FILTERS);
If an application wants to start and stop using particular filters dur-
ing compression, it should start out with all of the filters (to ensure
that the previous row of pixels will be stored in(1,8) case it's needed
later), and then add and remove them after the start of compression.
If you are writing a PNG datastream that is to be embedded in(1,8) a MNG
datastream, the second parameter can be either 0 or 64.
The png_set_compression_*() functions interface to the zlib compression
library, and should mostly be ignored unless you really know what you
are doing. The only generally useful call is png_set_compres-
sion_level() which changes how much time(1,2,n) zlib spends on trying to com-
press the image data. See the Compression Library (zlib.h and algo-
rithm.txt, distributed with zlib) for details on the compression lev-
els.
/* set(7,n,1 builtins) the zlib compression level */
png_set_compression_level(png_ptr,
Z_BEST_COMPRESSION);
/* set(7,n, 