libpng/example.c

757 lines
27 KiB
C
Raw Normal View History

1998-03-07 07:06:55 -05:00
1999-10-14 08:43:10 -04:00
#if 0 /* in case someone actually tries to compile this */
1995-07-20 03:43:20 -04:00
/* example.c - an example of using libpng */
1997-05-16 03:46:07 -04:00
/* This is an example of how to use libpng to read and write PNG files.
1998-01-01 08:13:13 -05:00
* The file libpng.txt is much more verbose then this. If you have not
* read it, do so first. This was designed to be a starting point of an
* implementation. This is not officially part of libpng, and therefore
* does not require a copyright notice.
*
* This file does not currently compile, because it is missing certain
* parts, like allocating memory to hold an image. You will have to
* supply these parts to get it to compile. For an example of a minimal
* working PNG reader/writer, see pngtest.c, included in this distribution.
*/
1995-07-20 03:43:20 -04:00
1998-02-28 08:00:24 -05:00
#include "png.h"
1995-07-20 03:43:20 -04:00
1999-01-06 22:50:16 -05:00
/* Check to see if a file is a PNG file using png_sig_cmp(). png_sig_cmp()
* returns zero if the image is a PNG and nonzero if it isn't a PNG.
*
* The function check_if_png() shown here, but not used, returns nonzero (true)
* if the file can be opened and is a PNG, 0 (false) otherwise.
1998-01-01 08:13:13 -05:00
*
* If this call is successful, and you are going to keep the file open,
* you should call png_set_sig_bytes(png_ptr, PNG_BYTES_TO_CHECK); once
* you have created the png_ptr, so that libpng knows your application
* has read that many bytes from the start of the file. Make sure you
* don't call png_set_sig_bytes() with more than 8 bytes read or give it
* an incorrect number of bytes read, or you will either have read too
* many bytes (your fault), or you are telling libpng to read the wrong
* number of magic bytes (also your fault).
*
* Many applications already read the first 2 or 4 bytes from the start
* of the image to determine the file type, so it would be easiest just
1998-03-08 19:52:15 -05:00
* to pass the bytes to png_sig_cmp() or even skip that if you know
1998-01-01 08:13:13 -05:00
* you have a PNG file, and call png_set_sig_bytes().
*/
1997-05-16 03:46:07 -04:00
#define PNG_BYTES_TO_CHECK 4
int check_if_png(char *file_name, FILE **fp)
1995-07-20 03:43:20 -04:00
{
1997-05-16 03:46:07 -04:00
char buf[PNG_BYTES_TO_CHECK];
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* Open the prospective PNG file. */
if ((*fp = fopen(file_name, "rb")) != NULL);
1995-07-20 03:43:20 -04:00
return 0;
1999-01-06 22:50:16 -05:00
/* Read in some of the signature bytes */
1997-05-16 03:46:07 -04:00
if (fread(buf, 1, PNG_BYTES_TO_CHECK, *fp) != PNG_BYTES_TO_CHECK)
1995-07-20 03:43:20 -04:00
return 0;
1999-01-06 22:50:16 -05:00
/* Compare the first PNG_BYTES_TO_CHECK bytes of the signature.
Return nonzero (true) if they match */
return(!png_sig_cmp(buf, (png_size_t)0, PNG_BYTES_TO_CHECK));
1995-07-20 03:43:20 -04:00
}
1997-05-16 03:46:07 -04:00
/* Read a PNG file. You may want to return an error code if the read
1998-01-01 08:13:13 -05:00
* fails (depending upon the failure). There are two "prototypes" given
* here - one where we are given the filename, and we need to open the
* file, and the other where we are given an open file (possibly with
* some or all of the magic bytes read - see comments above).
*/
1998-02-28 08:00:24 -05:00
#ifdef open_file /* prototype 1 */
1997-01-17 02:34:35 -05:00
void read_png(char *file_name) /* We need to open the file */
1995-07-20 03:43:20 -04:00
{
1996-01-26 02:38:47 -05:00
png_structp png_ptr;
1995-12-19 04:22:19 -05:00
png_infop info_ptr;
1997-05-16 03:46:07 -04:00
unsigned int sig_read = 0;
png_uint_32 width, height;
int bit_depth, color_type, interlace_type;
1997-01-17 02:34:35 -05:00
FILE *fp;
1995-07-20 03:43:20 -04:00
1997-01-17 02:34:35 -05:00
if ((fp = fopen(file_name, "rb")) == NULL)
1995-07-20 03:43:20 -04:00
return;
1998-02-28 08:00:24 -05:00
#else no_open_file /* prototype 2 */
1997-01-17 02:34:35 -05:00
void read_png(FILE *fp, unsigned int sig_read) /* file is already open */
{
png_structp png_ptr;
png_infop info_ptr;
1997-05-16 03:46:07 -04:00
png_uint_32 width, height;
int bit_depth, color_type, interlace_type;
1998-02-28 08:00:24 -05:00
#endif no_open_file /* only use one prototype! */
1995-07-20 03:43:20 -04:00
1996-06-05 16:50:50 -04:00
/* Create and initialize the png_struct with the desired error handler
1997-05-16 03:46:07 -04:00
* functions. If you want to use the default stderr and longjump method,
* you can supply NULL for the last three parameters. We also supply the
* the compiler header file version, so that we know if the application
* was compiled with a compatible version of the library. REQUIRED
*/
1996-06-05 16:50:50 -04:00
png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
1998-05-09 11:02:29 -04:00
png_voidp user_error_ptr, user_error_fn, user_warning_fn);
1996-06-05 16:50:50 -04:00
1997-05-16 03:46:07 -04:00
if (png_ptr == NULL)
1995-07-20 03:43:20 -04:00
{
fclose(fp);
return;
}
1997-05-16 03:46:07 -04:00
/* Allocate/initialize the memory for image information. REQUIRED. */
1998-03-08 19:52:15 -05:00
info_ptr = png_create_info_struct(png_ptr);
1997-05-16 03:46:07 -04:00
if (info_ptr == NULL)
1995-07-20 03:43:20 -04:00
{
fclose(fp);
1997-05-16 03:46:07 -04:00
png_destroy_read_struct(&png_ptr, (png_infopp)NULL, (png_infopp)NULL);
1995-07-20 03:43:20 -04:00
return;
}
1997-05-16 03:46:07 -04:00
/* Set error handling if you are using the setjmp/longjmp method (this is
* the normal method of doing things with libpng). REQUIRED unless you
* set up your own error handlers in the png_create_read_struct() earlier.
*/
1995-07-20 03:43:20 -04:00
if (setjmp(png_ptr->jmpbuf))
{
1996-06-05 16:50:50 -04:00
/* Free all of the memory associated with the png_ptr and info_ptr */
png_destroy_read_struct(&png_ptr, &info_ptr, (png_infopp)NULL);
1995-07-20 03:43:20 -04:00
fclose(fp);
/* If we get here, we had a problem reading the file */
return;
}
1997-05-16 03:46:07 -04:00
/* One of the following I/O initialization methods is REQUIRED */
1998-02-28 08:00:24 -05:00
#ifdef streams /* PNG file I/O method 1 */
1997-05-16 03:46:07 -04:00
/* Set up the input control if you are using standard C streams */
1995-07-20 03:43:20 -04:00
png_init_io(png_ptr, fp);
1998-02-28 08:00:24 -05:00
#else no_streams /* PNG file I/O method 2 */
1997-05-16 03:46:07 -04:00
/* If you are using replacement read functions, instead of calling
1998-01-01 08:13:13 -05:00
* png_init_io() here you would call:
*/
1996-06-05 16:50:50 -04:00
png_set_read_fn(png_ptr, (void *)user_io_ptr, user_read_fn);
/* where user_io_ptr is a structure you want available to the callbacks */
1998-02-28 08:00:24 -05:00
#endif no_streams /* Use only one I/O method! */
1996-01-10 03:56:49 -05:00
1997-05-16 03:46:07 -04:00
/* If we have already read some of the signature */
1998-03-08 19:52:15 -05:00
png_set_sig_bytes(png_ptr, sig_read);
1997-01-17 02:34:35 -05:00
2000-02-05 00:40:16 -05:00
#ifdef hilevel
/*
* If you have enough memory to read in the entire image at once,
* and you need to specify only transforms that can be controlled
* with one of the PNG_TRANSFORM_* bits (this presently excludes
* dithering, filling, setting background, and doing gamma
* adjustment), then you can read the entire image (including
* pixels) into the info structure with this call:
*/
png_read_png(png_ptr, info_ptr, png_transforms, NULL);
#else
/* OK, you're doing it the hard way, with the lower-level functions */
1997-05-16 03:46:07 -04:00
/* The call to png_read_info() gives us all of the information from the
* PNG file before the first IDAT (image data chunk). REQUIRED
*/
1996-01-26 02:38:47 -05:00
png_read_info(png_ptr, info_ptr);
1996-01-10 03:56:49 -05:00
1997-05-16 03:46:07 -04:00
png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
&interlace_type, NULL, NULL);
/**** Set up the data transformations you want. Note that these are all
**** optional. Only call them if you want/need them. Many of the
**** transformations only work on specific types of images, and many
**** are mutually exclusive.
****/
/* tell libpng to strip 16 bit/color files down to 8 bits/color */
png_set_strip_16(png_ptr);
1999-09-17 13:27:26 -04:00
/* Strip alpha bytes from the input data without combining with the
1998-01-01 08:13:13 -05:00
* background (not recommended).
*/
1997-05-16 03:46:07 -04:00
png_set_strip_alpha(png_ptr);
1998-01-01 08:13:13 -05:00
/* Extract multiple pixels with bit depths of 1, 2, and 4 from a single
1997-05-16 03:46:07 -04:00
* byte into separate bytes (useful for paletted and grayscale images).
*/
png_set_packing(png_ptr);
1998-01-01 08:13:13 -05:00
/* Change the order of packed pixels to least significant bit first
1997-05-16 03:46:07 -04:00
* (not useful if you are using png_set_packing). */
png_set_packswap(png_ptr);
1995-07-20 03:43:20 -04:00
1998-01-01 08:13:13 -05:00
/* Expand paletted colors into true RGB triplets */
1997-05-16 03:46:07 -04:00
if (color_type == PNG_COLOR_TYPE_PALETTE)
1995-07-20 03:43:20 -04:00
png_set_expand(png_ptr);
1998-01-01 08:13:13 -05:00
/* Expand grayscale images to the full 8 bits from 1, 2, or 4 bits/pixel */
1997-05-16 03:46:07 -04:00
if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
1995-07-20 03:43:20 -04:00
png_set_expand(png_ptr);
1998-01-01 08:13:13 -05:00
/* Expand paletted or RGB images with transparency to full alpha channels
* so the data will be available as RGBA quartets.
*/
1997-05-16 03:46:07 -04:00
if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
1995-07-20 03:43:20 -04:00
png_set_expand(png_ptr);
1997-05-16 03:46:07 -04:00
/* Set the background color to draw transparent and alpha images over.
* It is possible to set the red, green, and blue components directly
* for paletted images instead of supplying a palette index. Note that
* even if the PNG file supplies a background, you are not required to
* use it - you should use the (solid) application background if it has one.
*/
1996-06-05 16:50:50 -04:00
1998-02-28 08:00:24 -05:00
png_color_16 my_background, *image_background;
1995-07-20 03:43:20 -04:00
1998-02-28 08:00:24 -05:00
if (png_get_bKGD(png_ptr, info_ptr, &image_background))
png_set_background(png_ptr, image_background,
1996-06-05 16:50:50 -04:00
PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
1996-01-26 02:38:47 -05:00
else
png_set_background(png_ptr, &my_background,
1996-06-05 16:50:50 -04:00
PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* Some suggestions as to how to get a screen gamma value */
1998-01-16 23:06:18 -05:00
1999-10-01 15:22:25 -04:00
/* Note that screen gamma is the display_exponent, which includes
* the CRT_exponent and any correction for viewing conditions */
1997-05-16 03:46:07 -04:00
if (/* We have a user-defined screen gamma value */)
{
screen_gamma = user-defined screen_gamma;
}
/* This is one way that applications share the same screen gamma value */
1998-01-16 23:06:18 -05:00
else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL)
1997-05-16 03:46:07 -04:00
{
screen_gamma = atof(gamma_str);
}
/* If we don't have another value */
1995-07-20 03:43:20 -04:00
else
1997-05-16 03:46:07 -04:00
{
1998-01-30 22:45:12 -05:00
screen_gamma = 2.2; /* A good guess for a PC monitors in a dimly
1998-01-16 23:06:18 -05:00
lit room */
1997-05-16 03:46:07 -04:00
screen_gamma = 1.7 or 1.0; /* A good guess for Mac systems */
}
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* Tell libpng to handle the gamma conversion for you. The second call
* is a good guess for PC generated images, but it should be configurable
* by the user at run time by the user. It is strongly suggested that
* your application support gamma correction.
*/
1998-01-16 23:06:18 -05:00
int intent;
1998-02-28 08:00:24 -05:00
if (png_get_sRGB(png_ptr, info_ptr, &intent))
1999-10-23 09:39:18 -04:00
png_set_sRGB(png_ptr, info_ptr, intent);
1998-12-29 12:47:59 -05:00
else
{
double image_gamma;
1998-02-28 08:00:24 -05:00
if (png_get_gAMA(png_ptr, info_ptr, &image_gamma))
1998-01-01 08:13:13 -05:00
png_set_gamma(png_ptr, screen_gamma, image_gamma);
else
1998-12-29 12:47:59 -05:00
png_set_gamma(png_ptr, screen_gamma, 0.45455);
}
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* Dither RGB files down to 8 bit palette or reduce palettes
1998-01-01 08:13:13 -05:00
* to the number of colors available on your screen.
*/
1997-05-16 03:46:07 -04:00
if (color_type & PNG_COLOR_MASK_COLOR)
1995-07-20 03:43:20 -04:00
{
1997-05-16 03:46:07 -04:00
png_uint_32 num_palette;
png_colorp palette;
/* This reduces the image to the application supplied palette */
1998-02-28 08:00:24 -05:00
if (/* we have our own palette */)
1995-07-20 03:43:20 -04:00
{
1997-05-16 03:46:07 -04:00
/* An array of colors to which the image should be dithered */
png_color std_color_cube[MAX_SCREEN_COLORS];
1995-07-20 03:43:20 -04:00
png_set_dither(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
1997-05-16 03:46:07 -04:00
MAX_SCREEN_COLORS, NULL, 0);
}
/* This reduces the image to the palette supplied in the file */
1998-02-28 08:00:24 -05:00
else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette))
1997-05-16 03:46:07 -04:00
{
png_color16p histogram;
png_get_hIST(png_ptr, info_ptr, &histogram);
png_set_dither(png_ptr, palette, num_palette,
max_screen_colors, histogram, 0);
1995-07-20 03:43:20 -04:00
}
1996-01-26 02:38:47 -05:00
}
1995-07-20 03:43:20 -04:00
1996-06-05 16:50:50 -04:00
/* invert monocrome files to have 0 as white and 1 as black */
1998-01-30 22:45:12 -05:00
png_set_invert_mono(png_ptr);
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* If you want to shift the pixel values from the range [0,255] or
* [0,65535] to the original [0,7] or [0,31], or whatever range the
* colors were originally in:
*/
if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT))
{
2000-02-05 00:40:16 -05:00
png_color_8p sig_bit;
1997-05-16 03:46:07 -04:00
png_get_sBIT(png_ptr, info_ptr, &sig_bit);
png_set_shift(png_ptr, sig_bit);
}
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* flip the RGB pixels to BGR (or RGBA to BGRA) */
png_set_bgr(png_ptr);
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */
png_set_swap_alpha(png_ptr);
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* swap bytes of 16 bit files to least significant byte first */
png_set_swap(png_ptr);
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* Add filler (or alpha) byte (before/after each RGB triplet) */
png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
1995-09-26 06:22:39 -04:00
1997-05-16 03:46:07 -04:00
/* Turn on interlace handling. REQUIRED if you are not using
* png_read_image(). To see how to handle interlacing passes,
1998-01-01 08:13:13 -05:00
* see the png_read_row() method below:
1997-05-16 03:46:07 -04:00
*/
1996-06-05 16:50:50 -04:00
number_passes = png_set_interlace_handling(png_ptr);
1995-07-20 03:43:20 -04:00
1998-01-01 08:13:13 -05:00
/* Optional call to gamma correct and add the background to the palette
1997-05-16 03:46:07 -04:00
* and update info structure. REQUIRED if you are expecting libpng to
* update the palette for you (ie you selected such a transform above).
*/
1995-09-26 06:22:39 -04:00
png_read_update_info(png_ptr, info_ptr);
1998-01-01 08:13:13 -05:00
/* Allocate the memory to hold the image using the fields of info_ptr. */
1995-09-26 06:22:39 -04:00
1998-01-01 08:13:13 -05:00
/* The easiest way to read the image: */
1995-12-19 04:22:19 -05:00
png_bytep row_pointers[height];
1996-06-05 16:50:50 -04:00
for (row = 0; row < height; row++)
{
1997-05-16 03:46:07 -04:00
row_pointers[row] = malloc(png_get_rowbytes(png_ptr, info_ptr));
1996-06-05 16:50:50 -04:00
}
1997-05-16 03:46:07 -04:00
/* Now it's time to read the image. One of these methods is REQUIRED */
1998-02-28 08:00:24 -05:00
#ifdef entire /* Read the entire image in one go */
1995-07-20 03:43:20 -04:00
png_read_image(png_ptr, row_pointers);
1998-02-28 08:00:24 -05:00
#else no_entire /* Read the image one or more scanlines at a time */
1998-01-01 08:13:13 -05:00
/* The other way to read images - deal with interlacing: */
1995-07-20 03:43:20 -04:00
for (pass = 0; pass < number_passes; pass++)
{
1998-02-28 08:00:24 -05:00
#ifdef single /* Read the image a single row at a time */
1995-07-20 03:43:20 -04:00
for (y = 0; y < height; y++)
{
1998-05-21 10:27:50 -04:00
png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
1995-07-20 03:43:20 -04:00
}
1998-02-28 08:00:24 -05:00
#else no_single /* Read the image several rows at a time */
1997-05-16 03:46:07 -04:00
for (y = 0; y < height; y += number_of_rows)
{
1998-02-28 08:00:24 -05:00
#ifdef sparkle /* Read the image using the "sparkle" effect. */
1998-05-21 10:27:50 -04:00
png_read_rows(png_ptr, &row_pointers[y], NULL, number_of_rows);
1998-12-29 12:47:59 -05:00
1998-05-21 10:27:50 -04:00
png_read_rows(png_ptr, NULL, row_pointers[y], number_of_rows);
1998-02-28 08:00:24 -05:00
#else no_sparkle /* Read the image using the "rectangle" effect */
1998-05-21 10:27:50 -04:00
png_read_rows(png_ptr, NULL, &row_pointers[y], number_of_rows);
1998-02-28 08:00:24 -05:00
#endif no_sparkle /* use only one of these two methods */
1997-05-16 03:46:07 -04:00
}
1998-12-29 12:47:59 -05:00
1995-07-20 03:43:20 -04:00
/* if you want to display the image after every pass, do
so here */
1998-02-28 08:00:24 -05:00
#endif no_single /* use only one of these two methods */
1995-07-20 03:43:20 -04:00
}
1998-02-28 08:00:24 -05:00
#endif no_entire /* use only one of these two methods */
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* read rest of file, and get additional chunks in info_ptr - REQUIRED */
1996-01-26 02:38:47 -05:00
png_read_end(png_ptr, info_ptr);
2000-02-05 00:40:16 -05:00
#endif hilevel
/* At this point you have read the entire image */
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* clean up after the read, and free any memory allocated - REQUIRED */
1996-06-05 16:50:50 -04:00
png_destroy_read_struct(&png_ptr, &info_ptr, (png_infopp)NULL);
1995-07-20 03:43:20 -04:00
/* close the file */
fclose(fp);
/* that's it */
return;
}
1995-12-19 04:22:19 -05:00
/* progressively read a file */
int
1996-06-05 16:50:50 -04:00
initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
1995-12-19 04:22:19 -05:00
{
1996-06-05 16:50:50 -04:00
/* Create and initialize the png_struct with the desired error handler
1997-05-16 03:46:07 -04:00
* functions. If you want to use the default stderr and longjump method,
* you can supply NULL for the last three parameters. We also check that
* the library version is compatible in case we are using dynamically
* linked libraries.
1996-06-05 16:50:50 -04:00
*/
*png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
1998-05-09 11:02:29 -04:00
png_voidp user_error_ptr, user_error_fn, user_warning_fn);
1996-06-05 16:50:50 -04:00
1997-05-16 03:46:07 -04:00
if (*png_ptr == NULL)
1996-01-26 02:38:47 -05:00
{
1996-06-05 16:50:50 -04:00
*info_ptr = NULL;
return ERROR;
1996-01-26 02:38:47 -05:00
}
1996-06-05 16:50:50 -04:00
*info_ptr = png_create_info_struct(png_ptr);
1997-05-16 03:46:07 -04:00
if (*info_ptr == NULL)
1996-01-26 02:38:47 -05:00
{
1996-06-05 16:50:50 -04:00
png_destroy_read_struct(png_ptr, info_ptr, (png_infopp)NULL);
return ERROR;
1996-01-26 02:38:47 -05:00
}
1996-06-05 16:50:50 -04:00
if (setjmp((*png_ptr)->jmpbuf))
{
png_destroy_read_struct(png_ptr, info_ptr, (png_infopp)NULL);
return ERROR;
}
1996-01-26 02:38:47 -05:00
1998-12-29 12:47:59 -05:00
/* This one's new. You will need to provide all three
1997-05-16 03:46:07 -04:00
* function callbacks, even if you aren't using them all.
1998-12-29 12:47:59 -05:00
* 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().
1997-05-16 03:46:07 -04:00
* These functions shouldn't be dependent on global or
* static variables if you are decoding several images
* simultaneously. You should store stream specific data
* in a separate struct, given as the second parameter,
* and retrieve the pointer from inside the callbacks using
* the function png_get_progressive_ptr(png_ptr).
*/
1996-06-05 16:50:50 -04:00
png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
1996-01-26 02:38:47 -05:00
info_callback, row_callback, end_callback);
1996-06-05 16:50:50 -04:00
return OK;
1995-12-19 04:22:19 -05:00
}
int
1996-06-05 16:50:50 -04:00
process_data(png_structp *png_ptr, png_infop *info_ptr,
png_bytep buffer, png_uint_32 length)
1995-12-19 04:22:19 -05:00
{
1996-06-05 16:50:50 -04:00
if (setjmp((*png_ptr)->jmpbuf))
1996-01-26 02:38:47 -05:00
{
1996-06-05 16:50:50 -04:00
/* Free the png_ptr and info_ptr memory on error */
png_destroy_read_struct(png_ptr, info_ptr, (png_infopp)NULL);
return ERROR;
1996-01-26 02:38:47 -05:00
}
1997-05-16 03:46:07 -04:00
/* This one's new also. Simply give it chunks of data as
* they arrive from the data stream (in order, of course).
* On Segmented 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 if necessary (I assume you can
* give it chunks of 1 byte, but I haven't tried with less
* than 256 bytes yet). When this function returns, you may
* want to display any rows that were generated in the row
* callback, if you aren't already displaying them there.
*/
1996-06-05 16:50:50 -04:00
png_process_data(*png_ptr, *info_ptr, buffer, length);
return OK;
1995-12-19 04:22:19 -05:00
}
info_callback(png_structp png_ptr, png_infop info)
{
1996-01-26 02:38:47 -05:00
/* do any setup here, including setting any of the transformations
1997-05-16 03:46:07 -04:00
* mentioned in 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 (even if you don't set
* any). You may start getting rows before png_process_data()
* returns, so this is your last chance to prepare for that.
*/
1995-12-19 04:22:19 -05:00
}
row_callback(png_structp png_ptr, png_bytep new_row,
1996-01-26 02:38:47 -05:00
png_uint_32 row_num, int pass)
1995-12-19 04:22:19 -05:00
{
1996-01-26 02:38:47 -05:00
/* this function is called for every row in the image. If the
1997-05-16 03:46:07 -04:00
* image is interlacing, and you turned on the interlace handler,
* this function will be called for every row in 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 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 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 it will make the code easier. Thus, you
* can just do this for all cases:
*/
1996-01-26 02:38:47 -05:00
png_progressive_combine_row(png_ptr, old_row, new_row);
/* where old_row is what was displayed for previous rows. Note
1997-05-16 03:46:07 -04:00
* 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.
*/
1995-12-19 04:22:19 -05:00
}
end_callback(png_structp png_ptr, png_infop info)
{
1996-01-26 02:38:47 -05:00
/* this function is called when the whole image has been read,
1997-05-16 03:46:07 -04:00
* including any chunks after the image (up to and including
* the IEND). You will usually have the same info chunk as you
* had in the header, although some data may have been added
* to the comments and time fields.
*
* Most people won't do much here, perhaps setting a flag that
* marks the image as finished.
*/
1995-12-19 04:22:19 -05:00
}
1995-07-20 03:43:20 -04:00
/* write a png file */
1998-02-28 08:00:24 -05:00
void write_png(char *file_name /* , ... other image information ... */)
1995-07-20 03:43:20 -04:00
{
FILE *fp;
1996-01-26 02:38:47 -05:00
png_structp png_ptr;
png_infop info_ptr;
1995-07-20 03:43:20 -04:00
/* open the file */
fp = fopen(file_name, "wb");
1997-05-16 03:46:07 -04:00
if (fp == NULL)
1995-07-20 03:43:20 -04:00
return;
1996-06-05 16:50:50 -04:00
/* Create and initialize the png_struct with the desired error handler
1997-05-16 03:46:07 -04:00
* functions. If you want to use the default stderr and longjump method,
* you can supply NULL for the last three parameters. We also check that
* the library version is compatible with the one used at compile time,
* in case we are using dynamically linked libraries. REQUIRED.
1996-06-05 16:50:50 -04:00
*/
png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
1998-05-09 11:02:29 -04:00
png_voidp user_error_ptr, user_error_fn, user_warning_fn);
1996-06-05 16:50:50 -04:00
1997-05-16 03:46:07 -04:00
if (png_ptr == NULL)
1995-07-20 03:43:20 -04:00
{
fclose(fp);
return;
}
1997-05-16 03:46:07 -04:00
/* Allocate/initialize the image information data. REQUIRED */
1996-06-05 16:50:50 -04:00
info_ptr = png_create_info_struct(png_ptr);
1997-05-16 03:46:07 -04:00
if (info_ptr == NULL)
1995-07-20 03:43:20 -04:00
{
fclose(fp);
1996-06-05 16:50:50 -04:00
png_destroy_write_struct(&png_ptr, (png_infopp)NULL);
1995-07-20 03:43:20 -04:00
return;
}
1997-05-16 03:46:07 -04:00
/* Set error handling. REQUIRED if you aren't supplying your own
2000-02-05 00:40:16 -05:00
* error handling functions in the png_create_write_struct() call.
1997-05-16 03:46:07 -04:00
*/
1996-01-26 02:38:47 -05:00
if (setjmp(png_ptr->jmpbuf))
1995-07-20 03:43:20 -04:00
{
/* If we get here, we had a problem reading the file */
1996-06-05 16:50:50 -04:00
fclose(fp);
png_destroy_write_struct(&png_ptr, (png_infopp)NULL);
1995-07-20 03:43:20 -04:00
return;
}
1997-05-16 03:46:07 -04:00
/* One of the following I/O initialization functions is REQUIRED */
1998-02-28 08:00:24 -05:00
#ifdef streams /* I/O initialization method 1 */
1996-01-10 03:56:49 -05:00
/* set up the output control if you are using standard C streams */
1995-07-20 03:43:20 -04:00
png_init_io(png_ptr, fp);
1998-02-28 08:00:24 -05:00
#else no_streams /* I/O initialization method 2 */
1997-05-16 03:46:07 -04:00
/* If you are using replacement read functions, instead of calling
* png_init_io() here you would call */
png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn,
user_IO_flush_function);
/* where user_io_ptr is a structure you want available to the callbacks */
1998-02-28 08:00:24 -05:00
#endif no_streams /* only use one initialization method */
1997-05-16 03:46:07 -04:00
2000-02-05 00:40:16 -05:00
#ifdef hilevel
/* This is the easy way. Use it if you already have all the
* image info living info in the structure. You could "|" many
* PNG_TRANSFORM flags into the png_transforms integer here.
*/
png_write_png(png_ptr, info_ptr, png_transforms, NULL);
#else
/* This is the hard way */
1997-05-16 03:46:07 -04:00
/* Set the image information here. Width and height are up to 2^31,
* bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on
* the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
* PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
* or PNG_COLOR_TYPE_RGB_ALPHA. interlace is either PNG_INTERLACE_NONE or
* PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
* currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED
*/
png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???,
PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* set the palette if there is one. REQUIRED for indexed-color images */
1998-01-30 22:45:12 -05:00
palette = (png_colorp)png_malloc(png_ptr, 256 * sizeof (png_color));
1998-02-28 08:00:24 -05:00
/* ... set palette colors ... */
1997-05-16 03:46:07 -04:00
png_set_PLTE(png_ptr, info_ptr, palette, 256);
2000-02-05 00:40:16 -05:00
/* You can free the palette here if you like, since libpng has made its
own copy. In versions of libpng earlier than version 1.0.5n, it was
necessary to keep the palette until after png_write_end(), because
libpng was using the caller's copy. */
free(palette);
1995-07-20 03:43:20 -04:00
/* optional significant bit chunk */
1996-01-26 02:38:47 -05:00
/* if we are dealing with a grayscale image then */
1997-05-16 03:46:07 -04:00
sig_bit.gray = true_bit_depth;
1996-01-26 02:38:47 -05:00
/* otherwise, if we are dealing with a color image then */
1997-05-16 03:46:07 -04:00
sig_bit.red = true_red_bit_depth;
sig_bit.green = true_green_bit_depth;
sig_bit.blue = true_blue_bit_depth;
1996-01-26 02:38:47 -05:00
/* if the image has an alpha channel then */
1997-05-16 03:46:07 -04:00
sig_bit.alpha = true_alpha_bit_depth;
png_set_sBIT(png_ptr, info_ptr, sig_bit);
1995-07-20 03:43:20 -04:00
1998-12-29 12:47:59 -05:00
1997-05-16 03:46:07 -04:00
/* Optional gamma chunk is strongly suggested if you have any guess
1998-01-01 08:13:13 -05:00
* as to the correct gamma of the image.
*/
1997-05-16 03:46:07 -04:00
png_set_gAMA(png_ptr, info_ptr, gamma);
/* Optionally write comments into the image */
text_ptr[0].key = "Title";
text_ptr[0].text = "Mona Lisa";
text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
text_ptr[1].key = "Author";
text_ptr[1].text = "Leonardo DaVinci";
text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
text_ptr[2].key = "Description";
text_ptr[2].text = "<long text>";
text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
1999-12-10 10:43:02 -05:00
#ifdef PNG_iTXt_SUPPORTED
text_ptr[0].lang = NULL;
text_ptr[1].lang = NULL;
text_ptr[2].lang = NULL;
#endif
1998-05-21 10:27:50 -04:00
png_set_text(png_ptr, info_ptr, text_ptr, 3);
1997-05-16 03:46:07 -04:00
/* other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs, */
1998-01-01 08:13:13 -05:00
/* note that if sRGB is present the cHRM chunk must be ignored
* on read and must be written in accordance with the sRGB profile */
1997-05-16 03:46:07 -04:00
/* Write the file header information. REQUIRED */
1995-07-20 03:43:20 -04:00
png_write_info(png_ptr, info_ptr);
1999-11-27 11:22:33 -05:00
/* If you want, you can write the info in two steps, in case you need to
* write your private chunk ahead of PLTE:
*
* png_write_info_before_PLTE(write_ptr, write_info_ptr);
* write_my_chunk();
* png_write_info(png_ptr, info_ptr);
2000-02-05 00:40:16 -05:00
*
* However, given the level of known- and unknown-chunk support in 1.1.0
* and up, this should no longer be necessary.
1999-11-27 11:22:33 -05:00
*/
1997-05-16 03:46:07 -04:00
/* Once we write out the header, the compression type on the text
* chunks gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
* PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
* at the end.
*/
1995-07-20 03:43:20 -04:00
/* set up the transformations you want. Note that these are
1998-01-01 08:13:13 -05:00
* all optional. Only call them if you want them.
*/
1995-07-20 03:43:20 -04:00
/* invert monocrome pixels */
1998-01-30 22:45:12 -05:00
png_set_invert_mono(png_ptr);
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* Shift the pixels up to a legal bit depth and fill in
1998-01-01 08:13:13 -05:00
* as appropriate to correctly scale the image.
*/
1997-05-16 03:46:07 -04:00
png_set_shift(png_ptr, &sig_bit);
1995-07-20 03:43:20 -04:00
/* pack pixels into bytes */
png_set_packing(png_ptr);
1997-05-16 03:46:07 -04:00
/* swap location of alpha bytes from ARGB to RGBA */
png_set_swap_alpha(png_ptr);
/* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
1998-01-01 08:13:13 -05:00
* RGB (4 channels -> 3 channels). The second parameter is not used.
*/
1997-05-16 03:46:07 -04:00
png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
/* flip BGR pixels to RGB */
1995-07-20 03:43:20 -04:00
png_set_bgr(png_ptr);
1997-05-16 03:46:07 -04:00
/* swap bytes of 16-bit files to most significant byte first */
1995-07-20 03:43:20 -04:00
png_set_swap(png_ptr);
1997-05-16 03:46:07 -04:00
/* swap bits of 1, 2, 4 bit packed pixel formats */
png_set_packswap(png_ptr);
1995-07-20 03:43:20 -04:00
1995-09-26 06:22:39 -04:00
/* turn on interlace handling if you are not using png_write_image() */
1995-07-20 03:43:20 -04:00
if (interlacing)
number_passes = png_set_interlace_handling(png_ptr);
else
number_passes = 1;
1997-05-16 03:46:07 -04:00
/* The easiest way to write the image (you may have a different memory
* layout, however, so choose what fits your needs best). You need to
* use the first method if you aren't handling interlacing yourself.
*/
1998-05-21 10:27:50 -04:00
png_uint_32 k, height, width;
png_byte image[height][width];
png_bytep row_pointers[height];
for (k = 0; k < height; k++)
row_pointers[k] = image + k*width;
1996-06-05 16:50:50 -04:00
1997-05-16 03:46:07 -04:00
/* One of the following output methods is REQUIRED */
1998-02-28 08:00:24 -05:00
#ifdef entire /* write out the entire image data in one call */
1995-09-26 06:22:39 -04:00
png_write_image(png_ptr, row_pointers);
/* the other way to write the image - deal with interlacing */
1998-02-28 08:00:24 -05:00
#else no_entire /* write out the image data by one or more scanlines */
1997-05-16 03:46:07 -04:00
/* The number of passes is either 1 for non-interlaced images,
* or 7 for interlaced images.
*/
1995-07-20 03:43:20 -04:00
for (pass = 0; pass < number_passes; pass++)
{
/* Write a few rows at a time. */
1998-05-21 10:27:50 -04:00
png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
1995-07-20 03:43:20 -04:00
/* If you are only writing one row at a time, this works */
for (y = 0; y < height; y++)
{
1998-05-21 10:27:50 -04:00
png_write_rows(png_ptr, &row_pointers[y], 1);
1995-07-20 03:43:20 -04:00
}
}
1998-02-28 08:00:24 -05:00
#endif no_entire /* use only one output method */
1995-07-20 03:43:20 -04:00
1997-05-16 03:46:07 -04:00
/* You can write optional chunks like tEXt, zTXt, and tIME at the end
2000-02-05 00:40:16 -05:00
* as well. Shouldn't be necessary in 1.1.0 and up as all the public
* chunks are supported and you can use png_set_unknown_chunks() to
* register unknown chunks into the info structure to be written out.
1996-06-05 16:50:50 -04:00
*/
1997-05-16 03:46:07 -04:00
/* It is REQUIRED to call this to finish writing the rest of the file */
1995-07-20 03:43:20 -04:00
png_write_end(png_ptr, info_ptr);
2000-02-05 00:40:16 -05:00
#endif hilevel
1995-07-20 03:43:20 -04:00
2000-02-05 00:40:16 -05:00
/* if you malloced a palette and have not already freed it, free it
here (do *not* free libpng's copy of the palette in info_ptr->palette,
as recommended in versions 1.0.5m and earlier of this example; libpng
now takes care of that automatically). */
free(palette);
1995-07-20 03:43:20 -04:00
1996-06-05 16:50:50 -04:00
/* clean up after the write, and free any memory allocated */
1997-05-16 03:46:07 -04:00
png_destroy_write_struct(&png_ptr, (png_infopp)NULL);
1995-07-20 03:43:20 -04:00
/* close the file */
fclose(fp);
/* that's it */
return;
}
1999-10-14 08:43:10 -04:00
#endif /* if 0 */