blob: 61d9d74db6ff571ef8d69b285a0e3b9048852029 [file] [log] [blame]
Glenn Randers-Pehrson08a33431998-03-07 06:06:55 -06001
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -05002#if 0 /* in case someone actually tries to compile this */
3
Glenn Randers-Pehrsonb7f95932006-03-05 20:15:20 -06004/* example.c - an example of using libpng
Glenn Randers-Pehrson13831bc2011-12-21 08:28:28 -06005 * Last changed in libpng 1.6.0 [(PENDING RELEASE)]
Glenn Randers-Pehrson1531bd62012-01-01 14:45:04 -06006 * Maintained 1998-2012 Glenn Randers-Pehrson
Glenn Randers-Pehrsonb7f95932006-03-05 20:15:20 -06007 * Maintained 1996, 1997 Andreas Dilger)
8 * Written 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
Glenn Randers-Pehrson2ddb2522011-11-25 07:27:51 -06009 * To the extent possible under law, the authors have waived
10 * all copyright and related or neighboring rights to this file.
11 * This work is published from: United States.
Glenn Randers-Pehrsonb7f95932006-03-05 20:15:20 -060012 */
Guy Schalnat0d580581995-07-20 02:43:20 -050013
Andreas Dilger47a0c421997-05-16 02:46:07 -050014/* This is an example of how to use libpng to read and write PNG files.
Glenn Randers-Pehrsonf3abb2c2010-10-17 12:51:53 -050015 * The file libpng-manual.txt is much more verbose then this. If you have not
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060016 * read it, do so first. This was designed to be a starting point of an
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060017 * implementation. This is not officially part of libpng, is hereby placed
18 * in the public domain, and therefore does not require a copyright notice.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060019 *
20 * This file does not currently compile, because it is missing certain
21 * parts, like allocating memory to hold an image. You will have to
22 * supply these parts to get it to compile. For an example of a minimal
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -060023 * working PNG reader/writer, see pngtest.c, included in this distribution;
24 * see also the programs in the contrib directory.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -060025 */
Guy Schalnat0d580581995-07-20 02:43:20 -050026
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -060027/* The simple, but restricted, approach to reading a PNG file or data stream
28 * just requires two function calls, as in the following complete program.
29 * Writing a file just needs one function call, so long as the data has an
30 * appropriate layout.
31 *
32 * The following code reads PNG image data from a file and writes it, in a
33 * potentially new format, to a new file. While this code will compile there is
34 * minimal (insufficient) error checking; for a more realistic version look at
35 * contrib/examples/pngtopng.c
36 */
37#include <stddef.h>
38#include <stdlib.h>
39#include <string.h>
40#include <stdio.h>
41#include <png.h>
John Bowler5d567862011-12-24 09:12:00 -060042#include <zlib.h>
Glenn Randers-Pehrsone1018a52011-05-05 21:03:07 -050043
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -060044int main(int argc, const char **argv)
45{
46 if (argc == 3)
47 {
48 png_image image; /* The control structure used by libpng */
49
50 /* Initialize the 'png_image' structure. */
51 memset(&image, 0, sizeof image);
52
53 /* The first argument is the file to read: */
54 if (png_image_begin_read_from_file(&image, argv[1]))
55 {
56 png_bytep buffer;
57
58 /* Set the format in which to read the PNG file; this code chooses a
59 * simple sRGB format with a non-associated alpha channel, adequate to
60 * store most images.
61 */
62 image.format = PNG_FORMAT_RGBA;
63
64 /* Now allocate enough memory to hold the image in this format; the
65 * PNG_IMAGE_SIZE macro uses the information about the image (width,
66 * height and format) stored in 'image'.
67 */
68 buffer = malloc(PNG_IMAGE_SIZE(image));
69
70 /* If enough memory was available read the image in the desired format
71 * then write the result out to the new file. 'background' is not
72 * necessary when reading the image because the alpha channel is
73 * preserved; if it were to be removed, for example if we requested
74 * PNG_FORMAT_RGB, then either a solid background color would have to
75 * be supplied or the output buffer would have to be initialized to the
76 * actual background of the image.
77 *
78 * The final argument to png_image_finish_read is the 'row_stride' -
79 * this is the number of components allocated for the image in each
80 * row. It has to be at least as big as the value returned by
81 * PNG_IMAGE_ROW_STRIDE, but if you just allocate space for the
82 * default, minimum, size using PNG_IMAGE_SIZE as above you can pass
83 * zero.
84 */
85 if (buffer != NULL &&
86 png_image_finish_read(&image, NULL/*background*/, buffer,
87 0/*row_stride*/))
88 {
89 /* Now write the image out to the second argument. In the write
90 * call 'convert_to_8bit' allows 16-bit data to be squashed down to
91 * 8 bits; this isn't necessary here because the original read was
92 * to the 8-bit format.
93 */
94 if (png_image_write_to_file(&image, argv[2], 0/*convert_to_8bit*/,
95 buffer, 0/*row_stride*/))
96 {
97 /* The image has been written successfully. */
98 exit(0);
99 }
100 }
John Bowler414769b2011-11-27 21:39:13 -0600101
102 else
103 {
104 /* Calling png_free_image is optional unless the simplified API was
105 * not run to completion. In this case if there wasn't enough
106 * memory for 'buffer' we didn't complete the read, so we must free
107 * the image:
108 */
109 if (buffer == NULL)
110 png_free_image(&image);
111
112 else
113 free(buffer);
Glenn Randers-Pehrson7455cbf2011-11-24 14:40:36 -0600114 }
115
116 /* Something went wrong reading or writing the image. libpng stores a
117 * textual message in the 'png_image' structure:
118 */
119 fprintf(stderr, "pngtopng: error: %s\n", image.message);
120 exit (1);
121 }
122
123 fprintf(stderr, "pngtopng: usage: pngtopng input-file output-file\n");
124 exit(1);
125}
126
127/* That's it ;-) Of course you probably want to do more with PNG files than
128 * just converting them all to 32-bit RGBA PNG files; you can do that between
129 * the call to png_image_finish_read and png_image_write_to_file. You can also
130 * ask for the image data to be presented in a number of different formats. You
131 * do this by simply changing the 'format' parameter set before allocating the
132 * buffer.
133 *
134 * The format parameter consists of five flags that define various aspects of
135 * the image, you can simply add these together to get the format or you can use
136 * one of the predefined macros from png.h (as above):
137 *
138 * PNG_FORMAT_FLAG_COLOR: if set the image will have three color components per
139 * pixel (red, green and blue), if not set the image will just have one
140 * luminance (grayscale) component.
141 *
142 * PNG_FORMAT_FLAG_ALPHA: if set each pixel in the image will have an additional
143 * alpha value; a linear value that describes the degree the image pixel
144 * covers (overwrites) the contents of the existing pixel on the display.
145 *
146 * PNG_FORMAT_FLAG_LINEAR: if set the components of each pixel will be returned
147 * as a series of 16-bit linear values, if not set the components will be
148 * returned as a series of 8-bit values encoded according to the 'sRGB'
149 * standard. The 8-bit format is the normal format for images intended for
150 * direct display, because almost all display devices do the inverse of the
151 * sRGB transformation to the data they receive. The 16-bit format is more
152 * common for scientific data and image data that must be further processed;
153 * because it is linear simple math can be done on the component values.
154 * Regardless of the setting of this flag the alpha channel is always linear,
155 * although it will be 8 bits or 16 bits wide as specified by the flag.
156 *
157 * PNG_FORMAT_FLAG_BGR: if set the components of a color pixel will be returned
158 * in the order blue, then green, then red. If not set the pixel components
159 * are in the order red, then green, then blue.
160 *
161 * PNG_FORMAT_FLAG_AFIRST: if set the alpha channel (if present) precedes the
162 * color or grayscale components. If not set the alpha channel follows the
163 * components.
164 *
165 * You do not have to read directly from a file. You can read from memory or,
166 * on systems that support it, from a <stdio.h> FILE*. This is controlled by
167 * the particular png_image_read_from_ function you call at the start. Likewise
168 * on write you can write to a FILE* if your system supports it. Check the
169 * macro PNG_STDIO_SUPPORTED to see if stdio support has been included in your
170 * libpng build.
171 *
172 * If you read 16-bit (PNG_FORMAT_FLAG_LINEAR) data you may need to write it in
173 * the 8-bit format for display. You do this by setting the convert_to_8bit
174 * flag to 'true'.
175 *
176 * Don't repeatedly convert between the 8-bit and 16-bit forms. There is
177 * significant data loss when 16-bit data is converted to the 8-bit encoding and
178 * the current libpng implementation of convertion to 16-bit is also
179 * significantly lossy. The latter will be fixed in the future, but the former
180 * is unavoidable - the 8-bit format just doesn't have enough resolution.
181 */
182
183/* If your program needs more information from the PNG data it reads, or if you
184 * need to do more complex transformations, or minimise transformations, on the
185 * data you read, then you must use one of the several lower level libpng
186 * interfaces.
187 *
188 * All these interfaces require that you do your own error handling - your
189 * program must be able to arrange for control to return to your own code any
190 * time libpng encounters a problem. There are several ways to do this, but the
191 * standard way is to use the ANSI-C (C90) <setjmp.h> interface to establish a
192 * return point within your own code. You must do this if you do not use the
193 * simplified interface (above).
194 *
195 * The first step is to include the header files you need, including the libpng
196 * header file. Include any standard headers and feature test macros your
197 * program requires before including png.h:
198 */
199#include <png.h>
Guy Schalnat0d580581995-07-20 02:43:20 -0500200
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600201 /* The png_jmpbuf() macro, used in error handling, became available in
202 * libpng version 1.0.6. If you want to be able to run your code with older
203 * versions of libpng, you must define the macro yourself (but only if it
204 * is not already defined by libpng!).
205 */
206
207#ifndef png_jmpbuf
Glenn Randers-Pehrson95ca51b2010-02-19 14:09:09 -0600208# define png_jmpbuf(png_ptr) ((png_ptr)->png_jmpbuf)
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600209#endif
210
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -0600211/* Check to see if a file is a PNG file using png_sig_cmp(). png_sig_cmp()
212 * returns zero if the image is a PNG and nonzero if it isn't a PNG.
213 *
214 * The function check_if_png() shown here, but not used, returns nonzero (true)
215 * if the file can be opened and is a PNG, 0 (false) otherwise.
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600216 *
217 * If this call is successful, and you are going to keep the file open,
218 * you should call png_set_sig_bytes(png_ptr, PNG_BYTES_TO_CHECK); once
219 * you have created the png_ptr, so that libpng knows your application
220 * has read that many bytes from the start of the file. Make sure you
221 * don't call png_set_sig_bytes() with more than 8 bytes read or give it
222 * an incorrect number of bytes read, or you will either have read too
223 * many bytes (your fault), or you are telling libpng to read the wrong
224 * number of magic bytes (also your fault).
225 *
226 * Many applications already read the first 2 or 4 bytes from the start
227 * of the image to determine the file type, so it would be easiest just
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600228 * to pass the bytes to png_sig_cmp() or even skip that if you know
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600229 * you have a PNG file, and call png_set_sig_bytes().
230 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500231#define PNG_BYTES_TO_CHECK 4
232int check_if_png(char *file_name, FILE **fp)
Guy Schalnat0d580581995-07-20 02:43:20 -0500233{
Andreas Dilger47a0c421997-05-16 02:46:07 -0500234 char buf[PNG_BYTES_TO_CHECK];
Guy Schalnat0d580581995-07-20 02:43:20 -0500235
Andreas Dilger47a0c421997-05-16 02:46:07 -0500236 /* Open the prospective PNG file. */
Glenn Randers-Pehrson68ea2432000-04-01 21:10:05 -0600237 if ((*fp = fopen(file_name, "rb")) == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500238 return 0;
239
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -0600240 /* Read in some of the signature bytes */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500241 if (fread(buf, 1, PNG_BYTES_TO_CHECK, *fp) != PNG_BYTES_TO_CHECK)
242 return 0;
Guy Schalnat0d580581995-07-20 02:43:20 -0500243
Glenn Randers-Pehrsonc9442291999-01-06 21:50:16 -0600244 /* Compare the first PNG_BYTES_TO_CHECK bytes of the signature.
245 Return nonzero (true) if they match */
246
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500247 return(!png_sig_cmp(buf, (png_size_t)0, PNG_BYTES_TO_CHECK));
Guy Schalnat0d580581995-07-20 02:43:20 -0500248}
249
Andreas Dilger47a0c421997-05-16 02:46:07 -0500250/* Read a PNG file. You may want to return an error code if the read
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600251 * fails (depending upon the failure). There are two "prototypes" given
252 * here - one where we are given the filename, and we need to open the
253 * file, and the other where we are given an open file (possibly with
254 * some or all of the magic bytes read - see comments above).
255 */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600256#ifdef open_file /* prototype 1 */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600257void read_png(char *file_name) /* We need to open the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500258{
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600259 png_structp png_ptr;
Guy Schalnat6d764711995-12-19 03:22:19 -0600260 png_infop info_ptr;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500261 unsigned int sig_read = 0;
262 png_uint_32 width, height;
263 int bit_depth, color_type, interlace_type;
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600264 FILE *fp;
Guy Schalnat0d580581995-07-20 02:43:20 -0500265
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600266 if ((fp = fopen(file_name, "rb")) == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500267 return (ERROR);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500268
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600269#else no_open_file /* prototype 2 */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500270void read_png(FILE *fp, unsigned int sig_read) /* File is already open */
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600271{
272 png_structp png_ptr;
273 png_infop info_ptr;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500274 png_uint_32 width, height;
275 int bit_depth, color_type, interlace_type;
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500276#endif no_open_file /* Only use one prototype! */
Guy Schalnat0d580581995-07-20 02:43:20 -0500277
Guy Schalnate5a37791996-06-05 15:50:50 -0500278 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500279 * functions. If you want to use the default stderr and longjump method,
280 * you can supply NULL for the last three parameters. We also supply the
281 * the compiler header file version, so that we know if the application
282 * was compiled with a compatible version of the library. REQUIRED
283 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500284 png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500285 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500286
Andreas Dilger47a0c421997-05-16 02:46:07 -0500287 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500288 {
289 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500290 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500291 }
292
Andreas Dilger47a0c421997-05-16 02:46:07 -0500293 /* Allocate/initialize the memory for image information. REQUIRED. */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600294 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500295 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500296 {
297 fclose(fp);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500298 png_destroy_read_struct(&png_ptr, NULL, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500299 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500300 }
301
Andreas Dilger47a0c421997-05-16 02:46:07 -0500302 /* Set error handling if you are using the setjmp/longjmp method (this is
303 * the normal method of doing things with libpng). REQUIRED unless you
304 * set up your own error handlers in the png_create_read_struct() earlier.
305 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600306
307 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500308 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500309 /* Free all of the memory associated with the png_ptr and info_ptr */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500310 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500311 fclose(fp);
Guy Schalnat0d580581995-07-20 02:43:20 -0500312 /* If we get here, we had a problem reading the file */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500313 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500314 }
315
Andreas Dilger47a0c421997-05-16 02:46:07 -0500316 /* One of the following I/O initialization methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600317#ifdef streams /* PNG file I/O method 1 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500318 /* Set up the input control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500319 png_init_io(png_ptr, fp);
320
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600321#else no_streams /* PNG file I/O method 2 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500322 /* If you are using replacement read functions, instead of calling
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600323 * png_init_io() here you would call:
324 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500325 png_set_read_fn(png_ptr, (void *)user_io_ptr, user_read_fn);
326 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600327#endif no_streams /* Use only one I/O method! */
Guy Schalnat69b14481996-01-10 02:56:49 -0600328
Andreas Dilger47a0c421997-05-16 02:46:07 -0500329 /* If we have already read some of the signature */
Glenn Randers-Pehrson0f7202f1998-03-08 18:52:15 -0600330 png_set_sig_bytes(png_ptr, sig_read);
Andreas Dilger02ad0ef1997-01-17 01:34:35 -0600331
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600332#ifdef hilevel
333 /*
334 * If you have enough memory to read in the entire image at once,
335 * and you need to specify only transforms that can be controlled
336 * with one of the PNG_TRANSFORM_* bits (this presently excludes
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500337 * quantizing, filling, setting background, and doing gamma
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600338 * adjustment), then you can read the entire image (including
339 * pixels) into the info structure with this call:
340 */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500341 png_read_png(png_ptr, info_ptr, png_transforms, NULL);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500342
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600343#else
344 /* OK, you're doing it the hard way, with the lower-level functions */
345
Andreas Dilger47a0c421997-05-16 02:46:07 -0500346 /* The call to png_read_info() gives us all of the information from the
347 * PNG file before the first IDAT (image data chunk). REQUIRED
348 */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600349 png_read_info(png_ptr, info_ptr);
Guy Schalnat69b14481996-01-10 02:56:49 -0600350
Andreas Dilger47a0c421997-05-16 02:46:07 -0500351 png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500352 &interlace_type, NULL, NULL);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500353
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500354 /* Set up the data transformations you want. Note that these are all
355 * optional. Only call them if you want/need them. Many of the
356 * transformations only work on specific types of images, and many
357 * are mutually exclusive.
358 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500359
Glenn Randers-Pehrson857dbbe2011-06-16 09:39:40 -0500360 /* Tell libpng to strip 16 bit/color files down to 8 bits/color.
361 * Use accurate scaling if it's available, otherwise just chop off the
362 * low byte.
363 */
John Bowler8d261262011-06-18 13:37:11 -0500364#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -0500365 png_set_scale_16(png_ptr);
Glenn Randers-Pehrson857dbbe2011-06-16 09:39:40 -0500366#else
Glenn Randers-Pehrsonab63dd02011-06-17 20:04:17 -0500367 png_set_strip_16(png_ptr);
Glenn Randers-Pehrson857dbbe2011-06-16 09:39:40 -0500368#endif
Andreas Dilger47a0c421997-05-16 02:46:07 -0500369
Glenn Randers-Pehrson4393a9a1999-09-17 12:27:26 -0500370 /* Strip alpha bytes from the input data without combining with the
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600371 * background (not recommended).
372 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500373 png_set_strip_alpha(png_ptr);
374
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600375 /* Extract multiple pixels with bit depths of 1, 2, and 4 from a single
Andreas Dilger47a0c421997-05-16 02:46:07 -0500376 * byte into separate bytes (useful for paletted and grayscale images).
377 */
378 png_set_packing(png_ptr);
379
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600380 /* Change the order of packed pixels to least significant bit first
Andreas Dilger47a0c421997-05-16 02:46:07 -0500381 * (not useful if you are using png_set_packing). */
382 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500383
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600384 /* Expand paletted colors into true RGB triplets */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500385 if (color_type == PNG_COLOR_TYPE_PALETTE)
Glenn Randers-Pehrsonf46918d2006-06-02 05:31:20 -0500386 png_set_palette_to_rgb(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500387
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600388 /* Expand grayscale images to the full 8 bits from 1, 2, or 4 bits/pixel */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500389 if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
Glenn Randers-Pehrson56f63962008-10-06 10:16:17 -0500390 png_set_expand_gray_1_2_4_to_8(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500391
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600392 /* Expand paletted or RGB images with transparency to full alpha channels
393 * so the data will be available as RGBA quartets.
394 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500395 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
Glenn Randers-Pehrsonb1828932001-06-23 08:03:17 -0500396 png_set_tRNS_to_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500397
Andreas Dilger47a0c421997-05-16 02:46:07 -0500398 /* Set the background color to draw transparent and alpha images over.
399 * It is possible to set the red, green, and blue components directly
400 * for paletted images instead of supplying a palette index. Note that
401 * even if the PNG file supplies a background, you are not required to
402 * use it - you should use the (solid) application background if it has one.
403 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500404
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600405 png_color_16 my_background, *image_background;
Guy Schalnat0d580581995-07-20 02:43:20 -0500406
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600407 if (png_get_bKGD(png_ptr, info_ptr, &image_background))
408 png_set_background(png_ptr, image_background,
Guy Schalnate5a37791996-06-05 15:50:50 -0500409 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600410 else
411 png_set_background(png_ptr, &my_background,
Guy Schalnate5a37791996-06-05 15:50:50 -0500412 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500413
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500414 /* Some suggestions as to how to get a screen gamma value
415 *
416 * Note that screen gamma is the display_exponent, which includes
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500417 * the CRT_exponent and any correction for viewing conditions
418 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500419 if (/* We have a user-defined screen gamma value */)
420 {
421 screen_gamma = user-defined screen_gamma;
422 }
423 /* This is one way that applications share the same screen gamma value */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600424 else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL)
Andreas Dilger47a0c421997-05-16 02:46:07 -0500425 {
426 screen_gamma = atof(gamma_str);
427 }
428 /* If we don't have another value */
429 else
430 {
Glenn Randers-Pehrsonf0a8fe02009-04-14 08:28:15 -0500431 screen_gamma = 2.2; /* A good guess for a PC monitor in a dimly
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600432 lit room */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500433 screen_gamma = 1.7 or 1.0; /* A good guess for Mac systems */
434 }
435
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600436 /* Tell libpng to handle the gamma conversion for you. The final call
Andreas Dilger47a0c421997-05-16 02:46:07 -0500437 * is a good guess for PC generated images, but it should be configurable
438 * by the user at run time by the user. It is strongly suggested that
439 * your application support gamma correction.
440 */
Glenn Randers-Pehrsonc4a2ae61998-01-16 22:06:18 -0600441
442 int intent;
443
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600444 if (png_get_sRGB(png_ptr, info_ptr, &intent))
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600445 png_set_gamma(png_ptr, screen_gamma, 0.45455);
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600446 else
447 {
448 double image_gamma;
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600449 if (png_get_gAMA(png_ptr, info_ptr, &image_gamma))
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600450 png_set_gamma(png_ptr, screen_gamma, image_gamma);
451 else
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600452 png_set_gamma(png_ptr, screen_gamma, 0.45455);
453 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500454
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500455#ifdef PNG_READ_QUANTIZE_SUPPORTED
456 /* Quantize RGB files down to 8 bit palette or reduce palettes
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600457 * to the number of colors available on your screen.
458 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500459 if (color_type & PNG_COLOR_MASK_COLOR)
Guy Schalnat0d580581995-07-20 02:43:20 -0500460 {
Glenn Randers-Pehrsonf05f8032000-12-23 14:27:39 -0600461 int num_palette;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500462 png_colorp palette;
463
464 /* This reduces the image to the application supplied palette */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500465 if (/* We have our own palette */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500466 {
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500467 /* An array of colors to which the image should be quantized */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500468 png_color std_color_cube[MAX_SCREEN_COLORS];
Guy Schalnat0d580581995-07-20 02:43:20 -0500469
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500470 png_set_quantize(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500471 MAX_SCREEN_COLORS, NULL, 0);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500472 }
473 /* This reduces the image to the palette supplied in the file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600474 else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette))
Andreas Dilger47a0c421997-05-16 02:46:07 -0500475 {
Glenn Randers-Pehrson865f4f02002-09-15 20:30:38 -0500476 png_uint_16p histogram = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500477
478 png_get_hIST(png_ptr, info_ptr, &histogram);
479
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500480 png_set_quantize(png_ptr, palette, num_palette,
Andreas Dilger47a0c421997-05-16 02:46:07 -0500481 max_screen_colors, histogram, 0);
Guy Schalnat0d580581995-07-20 02:43:20 -0500482 }
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600483 }
Glenn Randers-Pehrson3cd7cff2010-04-16 19:27:08 -0500484#endif /* PNG_READ_QUANTIZE_SUPPORTED */
Guy Schalnat0d580581995-07-20 02:43:20 -0500485
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500486 /* Invert monochrome files to have 0 as white and 1 as black */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600487 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500488
Andreas Dilger47a0c421997-05-16 02:46:07 -0500489 /* If you want to shift the pixel values from the range [0,255] or
490 * [0,65535] to the original [0,7] or [0,31], or whatever range the
491 * colors were originally in:
492 */
493 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT))
494 {
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500495 png_color_8p sig_bit_p;
Guy Schalnat0d580581995-07-20 02:43:20 -0500496
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500497 png_get_sBIT(png_ptr, info_ptr, &sig_bit_p);
498 png_set_shift(png_ptr, sig_bit_p);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500499 }
Guy Schalnat0d580581995-07-20 02:43:20 -0500500
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500501 /* Flip the RGB pixels to BGR (or RGBA to BGRA) */
Glenn Randers-Pehrson6942d532000-05-01 09:31:54 -0500502 if (color_type & PNG_COLOR_MASK_COLOR)
503 png_set_bgr(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500504
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500505 /* Swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500506 png_set_swap_alpha(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500507
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500508 /* Swap bytes of 16 bit files to least significant byte first */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500509 png_set_swap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500510
Andreas Dilger47a0c421997-05-16 02:46:07 -0500511 /* Add filler (or alpha) byte (before/after each RGB triplet) */
512 png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
513
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -0500514#ifdef PNG_READ_INTERLACING_SUPPORTED
Andreas Dilger47a0c421997-05-16 02:46:07 -0500515 /* Turn on interlace handling. REQUIRED if you are not using
516 * png_read_image(). To see how to handle interlacing passes,
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600517 * see the png_read_row() method below:
Andreas Dilger47a0c421997-05-16 02:46:07 -0500518 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500519 number_passes = png_set_interlace_handling(png_ptr);
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -0500520#else
521 number_passes = 1;
522#endif /* PNG_READ_INTERLACING_SUPPORTED */
523
Guy Schalnat0d580581995-07-20 02:43:20 -0500524
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600525 /* Optional call to gamma correct and add the background to the palette
Andreas Dilger47a0c421997-05-16 02:46:07 -0500526 * and update info structure. REQUIRED if you are expecting libpng to
527 * update the palette for you (ie you selected such a transform above).
528 */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500529 png_read_update_info(png_ptr, info_ptr);
530
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600531 /* Allocate the memory to hold the image using the fields of info_ptr. */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500532
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600533 /* The easiest way to read the image: */
Guy Schalnat6d764711995-12-19 03:22:19 -0600534 png_bytep row_pointers[height];
Guy Schalnate5a37791996-06-05 15:50:50 -0500535
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500536 /* Clear the pointer array */
Guy Schalnate5a37791996-06-05 15:50:50 -0500537 for (row = 0; row < height; row++)
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500538 row_pointers[row] = NULL;
539
540 for (row = 0; row < height; row++)
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500541 row_pointers[row] = png_malloc(png_ptr, png_get_rowbytes(png_ptr,
542 info_ptr));
Guy Schalnate5a37791996-06-05 15:50:50 -0500543
Andreas Dilger47a0c421997-05-16 02:46:07 -0500544 /* Now it's time to read the image. One of these methods is REQUIRED */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600545#ifdef entire /* Read the entire image in one go */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500546 png_read_image(png_ptr, row_pointers);
547
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600548#else no_entire /* Read the image one or more scanlines at a time */
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600549 /* The other way to read images - deal with interlacing: */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500550
Guy Schalnat0d580581995-07-20 02:43:20 -0500551 for (pass = 0; pass < number_passes; pass++)
552 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600553#ifdef single /* Read the image a single row at a time */
Guy Schalnat0d580581995-07-20 02:43:20 -0500554 for (y = 0; y < height; y++)
555 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500556 png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500557 }
558
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600559#else no_single /* Read the image several rows at a time */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500560 for (y = 0; y < height; y += number_of_rows)
561 {
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600562#ifdef sparkle /* Read the image using the "sparkle" effect. */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500563 png_read_rows(png_ptr, &row_pointers[y], NULL,
564 number_of_rows);
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600565#else no_sparkle /* Read the image using the "rectangle" effect */
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500566 png_read_rows(png_ptr, NULL, &row_pointers[y],
567 number_of_rows);
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500568#endif no_sparkle /* Use only one of these two methods */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500569 }
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600570
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500571 /* If you want to display the image after every pass, do so here */
572#endif no_single /* Use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500573 }
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500574#endif no_entire /* Use only one of these two methods */
Guy Schalnat0d580581995-07-20 02:43:20 -0500575
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500576 /* Read rest of file, and get additional chunks in info_ptr - REQUIRED */
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600577 png_read_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600578#endif hilevel
579
580 /* At this point you have read the entire image */
Guy Schalnat0d580581995-07-20 02:43:20 -0500581
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500582 /* Clean up after the read, and free any memory allocated - REQUIRED */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500583 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
Guy Schalnat0d580581995-07-20 02:43:20 -0500584
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500585 /* Close the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500586 fclose(fp);
587
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500588 /* That's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500589 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -0500590}
591
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500592/* Progressively read a file */
Guy Schalnat6d764711995-12-19 03:22:19 -0600593
Guy Schalnat6d764711995-12-19 03:22:19 -0600594int
Guy Schalnate5a37791996-06-05 15:50:50 -0500595initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
Guy Schalnat6d764711995-12-19 03:22:19 -0600596{
Guy Schalnate5a37791996-06-05 15:50:50 -0500597 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500598 * functions. If you want to use the default stderr and longjump method,
599 * you can supply NULL for the last three parameters. We also check that
600 * the library version is compatible in case we are using dynamically
601 * linked libraries.
Guy Schalnate5a37791996-06-05 15:50:50 -0500602 */
603 *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500604 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500605
Andreas Dilger47a0c421997-05-16 02:46:07 -0500606 if (*png_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600607 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500608 *info_ptr = NULL;
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500609 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600610 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600611
Guy Schalnate5a37791996-06-05 15:50:50 -0500612 *info_ptr = png_create_info_struct(png_ptr);
613
Andreas Dilger47a0c421997-05-16 02:46:07 -0500614 if (*info_ptr == NULL)
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600615 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500616 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500617 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600618 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600619
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600620 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnate5a37791996-06-05 15:50:50 -0500621 {
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500622 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500623 return (ERROR);
Guy Schalnate5a37791996-06-05 15:50:50 -0500624 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600625
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600626 /* This one's new. You will need to provide all three
Andreas Dilger47a0c421997-05-16 02:46:07 -0500627 * function callbacks, even if you aren't using them all.
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600628 * If you aren't using all functions, you can specify NULL
629 * parameters. Even when all three functions are NULL,
630 * you need to call png_set_progressive_read_fn().
Andreas Dilger47a0c421997-05-16 02:46:07 -0500631 * These functions shouldn't be dependent on global or
632 * static variables if you are decoding several images
633 * simultaneously. You should store stream specific data
634 * in a separate struct, given as the second parameter,
635 * and retrieve the pointer from inside the callbacks using
636 * the function png_get_progressive_ptr(png_ptr).
637 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500638 png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600639 info_callback, row_callback, end_callback);
Guy Schalnat6d764711995-12-19 03:22:19 -0600640
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500641 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600642}
643
644int
Guy Schalnate5a37791996-06-05 15:50:50 -0500645process_data(png_structp *png_ptr, png_infop *info_ptr,
646 png_bytep buffer, png_uint_32 length)
Guy Schalnat6d764711995-12-19 03:22:19 -0600647{
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600648 if (setjmp(png_jmpbuf((*png_ptr))))
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600649 {
Guy Schalnate5a37791996-06-05 15:50:50 -0500650 /* Free the png_ptr and info_ptr memory on error */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500651 png_destroy_read_struct(png_ptr, info_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500652 return (ERROR);
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600653 }
Guy Schalnat6d764711995-12-19 03:22:19 -0600654
Andreas Dilger47a0c421997-05-16 02:46:07 -0500655 /* This one's new also. Simply give it chunks of data as
656 * they arrive from the data stream (in order, of course).
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500657 * On segmented machines, don't give it any more than 64K.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500658 * The library seems to run fine with sizes of 4K, although
659 * you can give it much less if necessary (I assume you can
660 * give it chunks of 1 byte, but I haven't tried with less
661 * than 256 bytes yet). When this function returns, you may
662 * want to display any rows that were generated in the row
663 * callback, if you aren't already displaying them there.
664 */
Guy Schalnate5a37791996-06-05 15:50:50 -0500665 png_process_data(*png_ptr, *info_ptr, buffer, length);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500666 return (OK);
Guy Schalnat6d764711995-12-19 03:22:19 -0600667}
668
669info_callback(png_structp png_ptr, png_infop info)
670{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500671 /* Do any setup here, including setting any of the transformations
672 * mentioned in the Reading PNG files section. For now, you _must_
673 * call either png_start_read_image() or png_read_update_info()
674 * after all the transformations are set (even if you don't set
675 * any). You may start getting rows before png_process_data()
676 * returns, so this is your last chance to prepare for that.
677 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600678}
679
680row_callback(png_structp png_ptr, png_bytep new_row,
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600681 png_uint_32 row_num, int pass)
Guy Schalnat6d764711995-12-19 03:22:19 -0600682{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500683 /*
684 * This function is called for every row in the image. If the
685 * image is interlaced, and you turned on the interlace handler,
686 * this function will be called for every row in every pass.
687 *
688 * In this function you will receive a pointer to new row data from
689 * libpng called new_row that is to replace a corresponding row (of
690 * the same data format) in a buffer allocated by your application.
691 *
692 * The new row data pointer "new_row" may be NULL, indicating there is
693 * no new data to be replaced (in cases of interlace loading).
694 *
695 * If new_row is not NULL then you need to call
696 * png_progressive_combine_row() to replace the corresponding row as
697 * shown below:
698 */
699
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500700 /* Get pointer to corresponding row in our
701 * PNG read buffer.
702 */
703 png_bytep old_row = ((png_bytep *)our_data)[row_num];
Glenn Randers-Pehrson5a0be342001-10-18 20:55:13 -0500704
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -0500705#ifdef PNG_READ_INTERLACING_SUPPORTED
Glenn Randers-Pehrson53c07f52010-06-18 18:55:55 -0500706 /* If both rows are allocated then copy the new row
707 * data to the corresponding row data.
708 */
709 if ((old_row != NULL) && (new_row != NULL))
710 png_progressive_combine_row(png_ptr, old_row, new_row);
711
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500712 /*
713 * The rows and passes are called in order, so you don't really
714 * need the row_num and pass, but I'm supplying them because it
715 * may make your life easier.
716 *
717 * For the non-NULL rows of interlaced images, you must call
718 * png_progressive_combine_row() passing in the new row and the
719 * old row, as demonstrated above. You can call this function for
720 * NULL rows (it will just return) and for non-interlaced images
John Bowlerfcd301d2011-12-28 21:34:27 -0600721 * (it just does the memcpy for you) if it will make the code
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500722 * easier. Thus, you can just do this for all cases:
723 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600724
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600725 png_progressive_combine_row(png_ptr, old_row, new_row);
Guy Schalnat6d764711995-12-19 03:22:19 -0600726
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500727 /* where old_row is what was displayed for previous rows. Note
728 * that the first pass (pass == 0 really) will completely cover
729 * the old row, so the rows do not have to be initialized. After
730 * the first pass (and only for interlaced images), you will have
731 * to pass the current row as new_row, and the function will combine
732 * the old row and the new row.
733 */
Glenn Randers-Pehrson4daae302011-10-06 21:37:47 -0500734#endif /* PNG_READ_INTERLACING_SUPPORTED */
Guy Schalnat6d764711995-12-19 03:22:19 -0600735}
736
737end_callback(png_structp png_ptr, png_infop info)
738{
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500739 /* This function is called when the whole image has been read,
740 * including any chunks after the image (up to and including
741 * the IEND). You will usually have the same info chunk as you
742 * had in the header, although some data may have been added
743 * to the comments and time fields.
744 *
745 * Most people won't do much here, perhaps setting a flag that
746 * marks the image as finished.
747 */
Guy Schalnat6d764711995-12-19 03:22:19 -0600748}
749
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500750/* Write a png file */
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600751void write_png(char *file_name /* , ... other image information ... */)
Guy Schalnat0d580581995-07-20 02:43:20 -0500752{
753 FILE *fp;
Guy Schalnatb2e01bd1996-01-26 01:38:47 -0600754 png_structp png_ptr;
755 png_infop info_ptr;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600756 png_colorp palette;
Guy Schalnat0d580581995-07-20 02:43:20 -0500757
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500758 /* Open the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500759 fp = fopen(file_name, "wb");
Andreas Dilger47a0c421997-05-16 02:46:07 -0500760 if (fp == NULL)
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500761 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500762
Guy Schalnate5a37791996-06-05 15:50:50 -0500763 /* Create and initialize the png_struct with the desired error handler
Andreas Dilger47a0c421997-05-16 02:46:07 -0500764 * functions. If you want to use the default stderr and longjump method,
765 * you can supply NULL for the last three parameters. We also check that
766 * the library version is compatible with the one used at compile time,
767 * in case we are using dynamically linked libraries. REQUIRED.
Guy Schalnate5a37791996-06-05 15:50:50 -0500768 */
769 png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
Glenn Randers-Pehrsond0dce401998-05-09 10:02:29 -0500770 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
Guy Schalnate5a37791996-06-05 15:50:50 -0500771
Andreas Dilger47a0c421997-05-16 02:46:07 -0500772 if (png_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500773 {
774 fclose(fp);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500775 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500776 }
777
Andreas Dilger47a0c421997-05-16 02:46:07 -0500778 /* Allocate/initialize the image information data. REQUIRED */
Guy Schalnate5a37791996-06-05 15:50:50 -0500779 info_ptr = png_create_info_struct(png_ptr);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500780 if (info_ptr == NULL)
Guy Schalnat0d580581995-07-20 02:43:20 -0500781 {
782 fclose(fp);
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500783 png_destroy_write_struct(&png_ptr, NULL);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500784 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500785 }
786
Andreas Dilger47a0c421997-05-16 02:46:07 -0500787 /* Set error handling. REQUIRED if you aren't supplying your own
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600788 * error handling functions in the png_create_write_struct() call.
Andreas Dilger47a0c421997-05-16 02:46:07 -0500789 */
Glenn Randers-Pehrson520a7642000-03-21 05:13:06 -0600790 if (setjmp(png_jmpbuf(png_ptr)))
Guy Schalnat0d580581995-07-20 02:43:20 -0500791 {
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500792 /* If we get here, we had a problem writing the file */
Guy Schalnate5a37791996-06-05 15:50:50 -0500793 fclose(fp);
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -0500794 png_destroy_write_struct(&png_ptr, &info_ptr);
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -0500795 return (ERROR);
Guy Schalnat0d580581995-07-20 02:43:20 -0500796 }
797
Andreas Dilger47a0c421997-05-16 02:46:07 -0500798 /* One of the following I/O initialization functions is REQUIRED */
Glenn Randers-Pehrson glennrp@comcast.netb1c0d332009-05-15 20:39:34 -0500799
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600800#ifdef streams /* I/O initialization method 1 */
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500801 /* Set up the output control if you are using standard C streams */
Guy Schalnat0d580581995-07-20 02:43:20 -0500802 png_init_io(png_ptr, fp);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500803
Glenn Randers-Pehrsoncbe52d81998-02-28 07:00:24 -0600804#else no_streams /* I/O initialization method 2 */
Glenn Randers-Pehrsona5fa5c92008-09-06 07:06:22 -0500805 /* If you are using replacement write functions, instead of calling
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500806 * png_init_io() here you would call
807 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500808 png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn,
809 user_IO_flush_function);
810 /* where user_io_ptr is a structure you want available to the callbacks */
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500811#endif no_streams /* Only use one initialization method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500812
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600813#ifdef hilevel
814 /* This is the easy way. Use it if you already have all the
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500815 * image info living in the structure. You could "|" many
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600816 * PNG_TRANSFORM flags into the png_transforms integer here.
817 */
Glenn Randers-Pehrsonbeb572e2006-08-19 13:59:24 -0500818 png_write_png(png_ptr, info_ptr, png_transforms, NULL);
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500819
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600820#else
821 /* This is the hard way */
822
Andreas Dilger47a0c421997-05-16 02:46:07 -0500823 /* Set the image information here. Width and height are up to 2^31,
824 * bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on
825 * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
826 * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
827 * or PNG_COLOR_TYPE_RGB_ALPHA. interlace is either PNG_INTERLACE_NONE or
828 * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
829 * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED
830 */
831 png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???,
832 PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
Guy Schalnat0d580581995-07-20 02:43:20 -0500833
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500834 /* Set the palette if there is one. REQUIRED for indexed-color images */
Glenn Randers-Pehrson3097f612001-05-07 14:52:45 -0500835 palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500836 * png_sizeof(png_color));
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500837 /* ... Set palette colors ... */
Glenn Randers-Pehrson76e5fd62000-12-28 07:50:05 -0600838 png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH);
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600839 /* You must not free palette here, because png_set_PLTE only makes a link to
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500840 * the palette that you malloced. Wait until you are about to destroy
841 * the png structure.
842 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500843
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500844 /* Optional significant bit (sBIT) chunk */
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500845 png_color_8 sig_bit;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500846
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500847 /* If we are dealing with a grayscale image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500848 sig_bit.gray = true_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500849
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500850 /* Otherwise, if we are dealing with a color image then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500851 sig_bit.red = true_red_bit_depth;
852 sig_bit.green = true_green_bit_depth;
853 sig_bit.blue = true_blue_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500854
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500855 /* If the image has an alpha channel then */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500856 sig_bit.alpha = true_alpha_bit_depth;
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500857
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500858 png_set_sBIT(png_ptr, info_ptr, &sig_bit);
Andreas Dilger47a0c421997-05-16 02:46:07 -0500859
Glenn Randers-Pehrson5c6aeb21998-12-29 11:47:59 -0600860
Andreas Dilger47a0c421997-05-16 02:46:07 -0500861 /* Optional gamma chunk is strongly suggested if you have any guess
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600862 * as to the correct gamma of the image.
863 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500864 png_set_gAMA(png_ptr, info_ptr, gamma);
Guy Schalnat0d580581995-07-20 02:43:20 -0500865
Andreas Dilger47a0c421997-05-16 02:46:07 -0500866 /* Optionally write comments into the image */
867 text_ptr[0].key = "Title";
868 text_ptr[0].text = "Mona Lisa";
869 text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500870 text_ptr[0].itxt_length = 0;
871 text_ptr[0].lang = NULL;
872 text_ptr[0].lang_key = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500873 text_ptr[1].key = "Author";
874 text_ptr[1].text = "Leonardo DaVinci";
875 text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500876 text_ptr[1].itxt_length = 0;
877 text_ptr[1].lang = NULL;
878 text_ptr[1].lang_key = NULL;
Andreas Dilger47a0c421997-05-16 02:46:07 -0500879 text_ptr[2].key = "Description";
880 text_ptr[2].text = "<long text>";
881 text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500882 text_ptr[2].itxt_length = 0;
Glenn Randers-Pehrson166c5a31999-12-10 09:43:02 -0600883 text_ptr[2].lang = NULL;
Glenn Randers-Pehrsondd78d522010-03-30 08:34:02 -0500884 text_ptr[2].lang_key = NULL;
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500885 png_set_text(png_ptr, info_ptr, text_ptr, 3);
Guy Schalnat0d580581995-07-20 02:43:20 -0500886
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500887 /* Other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs */
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500888
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500889 /* Note that if sRGB is present the gAMA and cHRM chunks must be ignored
Glenn Randers-Pehrson640b7d52009-05-13 07:33:22 -0500890 * on read and, if your application chooses to write them, they must
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500891 * be written in accordance with the sRGB profile
892 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500893
894 /* Write the file header information. REQUIRED */
Guy Schalnat0d580581995-07-20 02:43:20 -0500895 png_write_info(png_ptr, info_ptr);
896
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600897 /* If you want, you can write the info in two steps, in case you need to
898 * write your private chunk ahead of PLTE:
899 *
900 * png_write_info_before_PLTE(write_ptr, write_info_ptr);
901 * write_my_chunk();
902 * png_write_info(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600903 *
Glenn Randers-Pehrson8fb550c2009-03-21 08:15:32 -0500904 * However, given the level of known- and unknown-chunk support in 1.2.0
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600905 * and up, this should no longer be necessary.
Glenn Randers-Pehrson5379b241999-11-27 10:22:33 -0600906 */
907
Andreas Dilger47a0c421997-05-16 02:46:07 -0500908 /* Once we write out the header, the compression type on the text
909 * chunks gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
910 * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
911 * at the end.
912 */
913
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500914 /* Set up the transformations you want. Note that these are
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600915 * all optional. Only call them if you want them.
916 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500917
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500918 /* Invert monochrome pixels */
Glenn Randers-Pehrson46f61e21998-01-30 21:45:12 -0600919 png_set_invert_mono(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500920
Andreas Dilger47a0c421997-05-16 02:46:07 -0500921 /* Shift the pixels up to a legal bit depth and fill in
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600922 * as appropriate to correctly scale the image.
923 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500924 png_set_shift(png_ptr, &sig_bit);
Guy Schalnat0d580581995-07-20 02:43:20 -0500925
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500926 /* Pack pixels into bytes */
Guy Schalnat0d580581995-07-20 02:43:20 -0500927 png_set_packing(png_ptr);
928
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500929 /* Swap location of alpha bytes from ARGB to RGBA */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500930 png_set_swap_alpha(png_ptr);
931
932 /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
Glenn Randers-Pehrsonb6ce43d1998-01-01 07:13:13 -0600933 * RGB (4 channels -> 3 channels). The second parameter is not used.
934 */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500935 png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
936
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500937 /* Flip BGR pixels to RGB */
Guy Schalnat0d580581995-07-20 02:43:20 -0500938 png_set_bgr(png_ptr);
939
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500940 /* Swap bytes of 16-bit files to most significant byte first */
Guy Schalnat0d580581995-07-20 02:43:20 -0500941 png_set_swap(png_ptr);
942
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500943 /* Swap bits of 1, 2, 4 bit packed pixel formats */
Andreas Dilger47a0c421997-05-16 02:46:07 -0500944 png_set_packswap(png_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -0500945
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500946 /* Turn on interlace handling if you are not using png_write_image() */
Guy Schalnat0d580581995-07-20 02:43:20 -0500947 if (interlacing)
948 number_passes = png_set_interlace_handling(png_ptr);
Glenn Randers-Pehrsonf24daf22010-05-06 09:44:04 -0500949
Guy Schalnat0d580581995-07-20 02:43:20 -0500950 else
951 number_passes = 1;
952
Andreas Dilger47a0c421997-05-16 02:46:07 -0500953 /* The easiest way to write the image (you may have a different memory
954 * layout, however, so choose what fits your needs best). You need to
955 * use the first method if you aren't handling interlacing yourself.
956 */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500957 png_uint_32 k, height, width;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600958 png_byte image[height][width*bytes_per_pixel];
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500959 png_bytep row_pointers[height];
Glenn Randers-Pehrson5fea36f2004-07-28 08:20:44 -0500960
Glenn Randers-Pehrson145f5c82008-07-10 09:13:13 -0500961 if (height > PNG_UINT_32_MAX/png_sizeof(png_bytep))
Glenn Randers-Pehrson67864af2004-08-28 23:30:07 -0500962 png_error (png_ptr, "Image is too tall to process in memory");
963
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500964 for (k = 0; k < height; k++)
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -0600965 row_pointers[k] = image + k*width*bytes_per_pixel;
Guy Schalnate5a37791996-06-05 15:50:50 -0500966
Andreas Dilger47a0c421997-05-16 02:46:07 -0500967 /* One of the following output methods is REQUIRED */
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500968
969#ifdef entire /* Write out the entire image data in one call */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500970 png_write_image(png_ptr, row_pointers);
971
Glenn Randers-Pehrson4bb4d012009-05-20 12:45:29 -0500972 /* The other way to write the image - deal with interlacing */
Guy Schalnat51f0eb41995-09-26 05:22:39 -0500973
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500974#else no_entire /* Write out the image data by one or more scanlines */
975
Andreas Dilger47a0c421997-05-16 02:46:07 -0500976 /* The number of passes is either 1 for non-interlaced images,
977 * or 7 for interlaced images.
978 */
Guy Schalnat0d580581995-07-20 02:43:20 -0500979 for (pass = 0; pass < number_passes; pass++)
980 {
981 /* Write a few rows at a time. */
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500982 png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
Guy Schalnat0d580581995-07-20 02:43:20 -0500983
984 /* If you are only writing one row at a time, this works */
985 for (y = 0; y < height; y++)
Glenn Randers-Pehrson8686fff1998-05-21 09:27:50 -0500986 png_write_rows(png_ptr, &row_pointers[y], 1);
Guy Schalnat0d580581995-07-20 02:43:20 -0500987 }
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -0500988#endif no_entire /* Use only one output method */
Guy Schalnat0d580581995-07-20 02:43:20 -0500989
Andreas Dilger47a0c421997-05-16 02:46:07 -0500990 /* You can write optional chunks like tEXt, zTXt, and tIME at the end
Glenn Randers-Pehrsonf0a8fe02009-04-14 08:28:15 -0500991 * as well. Shouldn't be necessary in 1.2.0 and up as all the public
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600992 * chunks are supported and you can use png_set_unknown_chunks() to
993 * register unknown chunks into the info structure to be written out.
Guy Schalnate5a37791996-06-05 15:50:50 -0500994 */
995
Andreas Dilger47a0c421997-05-16 02:46:07 -0500996 /* It is REQUIRED to call this to finish writing the rest of the file */
Guy Schalnat0d580581995-07-20 02:43:20 -0500997 png_write_end(png_ptr, info_ptr);
Glenn Randers-Pehrson61c32d92000-02-04 23:40:16 -0600998#endif hilevel
Guy Schalnat0d580581995-07-20 02:43:20 -0500999
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001000 /* If you png_malloced a palette, free it here (don't free info_ptr->palette,
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001001 * as recommended in versions 1.0.5m and earlier of this example; if
1002 * libpng mallocs info_ptr->palette, libpng will free it). If you
1003 * allocated it with malloc() instead of png_malloc(), use free() instead
1004 * of png_free().
1005 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001006 png_free(png_ptr, palette);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -05001007 palette = NULL;
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001008
1009 /* Similarly, if you png_malloced any data that you passed in with
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001010 * png_set_something(), such as a hist or trans array, free it here,
1011 * when you can be sure that libpng is through with it.
1012 */
Glenn Randers-Pehrsona77ef622000-02-18 13:48:52 -06001013 png_free(png_ptr, trans);
Glenn Randers-Pehrson895a9c92008-07-25 08:51:18 -05001014 trans = NULL;
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001015 /* Whenever you use png_free() it is a good idea to set the pointer to
1016 * NULL in case your application inadvertently tries to png_free() it
1017 * again. When png_free() sees a NULL it returns without action, thus
1018 * avoiding the double-free security problem.
1019 */
Guy Schalnat0d580581995-07-20 02:43:20 -05001020
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001021 /* Clean up after the write, and free any memory allocated */
Glenn Randers-Pehrsonfc4a1432000-05-17 17:39:34 -05001022 png_destroy_write_struct(&png_ptr, &info_ptr);
Guy Schalnat0d580581995-07-20 02:43:20 -05001023
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001024 /* Close the file */
Guy Schalnat0d580581995-07-20 02:43:20 -05001025 fclose(fp);
1026
Glenn Randers-Pehrson64548de2009-05-13 15:23:03 -05001027 /* That's it */
Glenn Randers-Pehrson104622b2000-05-29 08:58:03 -05001028 return (OK);
Guy Schalnat0d580581995-07-20 02:43:20 -05001029}
1030
Glenn Randers-Pehrson860ab2b1999-10-14 07:43:10 -05001031#endif /* if 0 */