]> git.saurik.com Git - wxWidgets.git/blame - src/png/example.c
remove unnecessary class definitions and variables
[wxWidgets.git] / src / png / example.c
CommitLineData
0272a10d
VZ
1
2#if 0 /* in case someone actually tries to compile this */
3
4/* example.c - an example of using libpng
9c0d9ce3 5 * Last changed in libpng 1.5.6 [November 3, 2011]
0272a10d 6 * This file has been placed in the public domain by the authors.
9c0d9ce3 7 * Maintained 1998-2011 Glenn Randers-Pehrson
0272a10d
VZ
8 * Maintained 1996, 1997 Andreas Dilger)
9 * Written 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)
10 */
11
12/* This is an example of how to use libpng to read and write PNG files.
9c0d9ce3 13 * The file libpng-manual.txt is much more verbose then this. If you have not
0272a10d
VZ
14 * read it, do so first. This was designed to be a starting point of an
15 * implementation. This is not officially part of libpng, is hereby placed
16 * in the public domain, and therefore does not require a copyright notice.
17 *
18 * This file does not currently compile, because it is missing certain
19 * parts, like allocating memory to hold an image. You will have to
20 * supply these parts to get it to compile. For an example of a minimal
21 * working PNG reader/writer, see pngtest.c, included in this distribution;
22 * see also the programs in the contrib directory.
23 */
24
9c0d9ce3
DS
25#define _POSIX_SOURCE 1 /* libpng and zlib are POSIX-compliant. You may
26 * change this if your application uses non-POSIX
27 * extensions. */
28
0272a10d
VZ
29#include "png.h"
30
31 /* The png_jmpbuf() macro, used in error handling, became available in
32 * libpng version 1.0.6. If you want to be able to run your code with older
33 * versions of libpng, you must define the macro yourself (but only if it
34 * is not already defined by libpng!).
35 */
36
37#ifndef png_jmpbuf
9c0d9ce3 38# define png_jmpbuf(png_ptr) ((png_ptr)->png_jmpbuf)
0272a10d
VZ
39#endif
40
41/* Check to see if a file is a PNG file using png_sig_cmp(). png_sig_cmp()
42 * returns zero if the image is a PNG and nonzero if it isn't a PNG.
43 *
44 * The function check_if_png() shown here, but not used, returns nonzero (true)
45 * if the file can be opened and is a PNG, 0 (false) otherwise.
46 *
47 * If this call is successful, and you are going to keep the file open,
48 * you should call png_set_sig_bytes(png_ptr, PNG_BYTES_TO_CHECK); once
49 * you have created the png_ptr, so that libpng knows your application
50 * has read that many bytes from the start of the file. Make sure you
51 * don't call png_set_sig_bytes() with more than 8 bytes read or give it
52 * an incorrect number of bytes read, or you will either have read too
53 * many bytes (your fault), or you are telling libpng to read the wrong
54 * number of magic bytes (also your fault).
55 *
56 * Many applications already read the first 2 or 4 bytes from the start
57 * of the image to determine the file type, so it would be easiest just
58 * to pass the bytes to png_sig_cmp() or even skip that if you know
59 * you have a PNG file, and call png_set_sig_bytes().
60 */
61#define PNG_BYTES_TO_CHECK 4
62int check_if_png(char *file_name, FILE **fp)
63{
64 char buf[PNG_BYTES_TO_CHECK];
65
66 /* Open the prospective PNG file. */
67 if ((*fp = fopen(file_name, "rb")) == NULL)
68 return 0;
69
70 /* Read in some of the signature bytes */
71 if (fread(buf, 1, PNG_BYTES_TO_CHECK, *fp) != PNG_BYTES_TO_CHECK)
72 return 0;
73
74 /* Compare the first PNG_BYTES_TO_CHECK bytes of the signature.
75 Return nonzero (true) if they match */
76
77 return(!png_sig_cmp(buf, (png_size_t)0, PNG_BYTES_TO_CHECK));
78}
79
80/* Read a PNG file. You may want to return an error code if the read
81 * fails (depending upon the failure). There are two "prototypes" given
82 * here - one where we are given the filename, and we need to open the
83 * file, and the other where we are given an open file (possibly with
84 * some or all of the magic bytes read - see comments above).
85 */
86#ifdef open_file /* prototype 1 */
87void read_png(char *file_name) /* We need to open the file */
88{
89 png_structp png_ptr;
90 png_infop info_ptr;
91 unsigned int sig_read = 0;
92 png_uint_32 width, height;
93 int bit_depth, color_type, interlace_type;
94 FILE *fp;
95
96 if ((fp = fopen(file_name, "rb")) == NULL)
97 return (ERROR);
b61cc19c 98
0272a10d 99#else no_open_file /* prototype 2 */
b61cc19c 100void read_png(FILE *fp, unsigned int sig_read) /* File is already open */
0272a10d
VZ
101{
102 png_structp png_ptr;
103 png_infop info_ptr;
104 png_uint_32 width, height;
105 int bit_depth, color_type, interlace_type;
b61cc19c 106#endif no_open_file /* Only use one prototype! */
0272a10d
VZ
107
108 /* Create and initialize the png_struct with the desired error handler
109 * functions. If you want to use the default stderr and longjump method,
110 * you can supply NULL for the last three parameters. We also supply the
111 * the compiler header file version, so that we know if the application
112 * was compiled with a compatible version of the library. REQUIRED
113 */
114 png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
115 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
116
117 if (png_ptr == NULL)
118 {
119 fclose(fp);
120 return (ERROR);
121 }
122
123 /* Allocate/initialize the memory for image information. REQUIRED. */
124 info_ptr = png_create_info_struct(png_ptr);
125 if (info_ptr == NULL)
126 {
127 fclose(fp);
b61cc19c 128 png_destroy_read_struct(&png_ptr, NULL, NULL);
0272a10d
VZ
129 return (ERROR);
130 }
131
132 /* Set error handling if you are using the setjmp/longjmp method (this is
133 * the normal method of doing things with libpng). REQUIRED unless you
134 * set up your own error handlers in the png_create_read_struct() earlier.
135 */
136
137 if (setjmp(png_jmpbuf(png_ptr)))
138 {
139 /* Free all of the memory associated with the png_ptr and info_ptr */
b61cc19c 140 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
0272a10d
VZ
141 fclose(fp);
142 /* If we get here, we had a problem reading the file */
143 return (ERROR);
144 }
145
146 /* One of the following I/O initialization methods is REQUIRED */
147#ifdef streams /* PNG file I/O method 1 */
148 /* Set up the input control if you are using standard C streams */
149 png_init_io(png_ptr, fp);
150
151#else no_streams /* PNG file I/O method 2 */
152 /* If you are using replacement read functions, instead of calling
153 * png_init_io() here you would call:
154 */
155 png_set_read_fn(png_ptr, (void *)user_io_ptr, user_read_fn);
156 /* where user_io_ptr is a structure you want available to the callbacks */
157#endif no_streams /* Use only one I/O method! */
158
159 /* If we have already read some of the signature */
160 png_set_sig_bytes(png_ptr, sig_read);
161
162#ifdef hilevel
163 /*
164 * If you have enough memory to read in the entire image at once,
165 * and you need to specify only transforms that can be controlled
166 * with one of the PNG_TRANSFORM_* bits (this presently excludes
b61cc19c 167 * quantizing, filling, setting background, and doing gamma
0272a10d
VZ
168 * adjustment), then you can read the entire image (including
169 * pixels) into the info structure with this call:
170 */
b61cc19c
PC
171 png_read_png(png_ptr, info_ptr, png_transforms, NULL);
172
0272a10d
VZ
173#else
174 /* OK, you're doing it the hard way, with the lower-level functions */
175
176 /* The call to png_read_info() gives us all of the information from the
177 * PNG file before the first IDAT (image data chunk). REQUIRED
178 */
179 png_read_info(png_ptr, info_ptr);
180
181 png_get_IHDR(png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
b61cc19c 182 &interlace_type, NULL, NULL);
0272a10d 183
b61cc19c
PC
184 /* Set up the data transformations you want. Note that these are all
185 * optional. Only call them if you want/need them. Many of the
186 * transformations only work on specific types of images, and many
187 * are mutually exclusive.
188 */
0272a10d 189
9c0d9ce3
DS
190 /* Tell libpng to strip 16 bit/color files down to 8 bits/color.
191 * Use accurate scaling if it's available, otherwise just chop off the
192 * low byte.
193 */
194#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
195 png_set_scale_16(png_ptr);
196#else
0272a10d 197 png_set_strip_16(png_ptr);
9c0d9ce3 198#endif
0272a10d
VZ
199
200 /* Strip alpha bytes from the input data without combining with the
201 * background (not recommended).
202 */
203 png_set_strip_alpha(png_ptr);
204
205 /* Extract multiple pixels with bit depths of 1, 2, and 4 from a single
206 * byte into separate bytes (useful for paletted and grayscale images).
207 */
208 png_set_packing(png_ptr);
209
210 /* Change the order of packed pixels to least significant bit first
211 * (not useful if you are using png_set_packing). */
212 png_set_packswap(png_ptr);
213
214 /* Expand paletted colors into true RGB triplets */
215 if (color_type == PNG_COLOR_TYPE_PALETTE)
216 png_set_palette_to_rgb(png_ptr);
217
218 /* Expand grayscale images to the full 8 bits from 1, 2, or 4 bits/pixel */
219 if (color_type == PNG_COLOR_TYPE_GRAY && bit_depth < 8)
970f6abe 220 png_set_expand_gray_1_2_4_to_8(png_ptr);
0272a10d
VZ
221
222 /* Expand paletted or RGB images with transparency to full alpha channels
223 * so the data will be available as RGBA quartets.
224 */
225 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_tRNS))
226 png_set_tRNS_to_alpha(png_ptr);
227
228 /* Set the background color to draw transparent and alpha images over.
229 * It is possible to set the red, green, and blue components directly
230 * for paletted images instead of supplying a palette index. Note that
231 * even if the PNG file supplies a background, you are not required to
232 * use it - you should use the (solid) application background if it has one.
233 */
234
235 png_color_16 my_background, *image_background;
236
237 if (png_get_bKGD(png_ptr, info_ptr, &image_background))
238 png_set_background(png_ptr, image_background,
239 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
240 else
241 png_set_background(png_ptr, &my_background,
242 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
243
b61cc19c
PC
244 /* Some suggestions as to how to get a screen gamma value
245 *
246 * Note that screen gamma is the display_exponent, which includes
247 * the CRT_exponent and any correction for viewing conditions
248 */
0272a10d
VZ
249 if (/* We have a user-defined screen gamma value */)
250 {
251 screen_gamma = user-defined screen_gamma;
252 }
253 /* This is one way that applications share the same screen gamma value */
254 else if ((gamma_str = getenv("SCREEN_GAMMA")) != NULL)
255 {
256 screen_gamma = atof(gamma_str);
257 }
258 /* If we don't have another value */
259 else
260 {
b61cc19c 261 screen_gamma = 2.2; /* A good guess for a PC monitor in a dimly
0272a10d
VZ
262 lit room */
263 screen_gamma = 1.7 or 1.0; /* A good guess for Mac systems */
264 }
265
266 /* Tell libpng to handle the gamma conversion for you. The final call
267 * is a good guess for PC generated images, but it should be configurable
268 * by the user at run time by the user. It is strongly suggested that
269 * your application support gamma correction.
270 */
271
272 int intent;
273
274 if (png_get_sRGB(png_ptr, info_ptr, &intent))
275 png_set_gamma(png_ptr, screen_gamma, 0.45455);
276 else
277 {
278 double image_gamma;
279 if (png_get_gAMA(png_ptr, info_ptr, &image_gamma))
280 png_set_gamma(png_ptr, screen_gamma, image_gamma);
281 else
282 png_set_gamma(png_ptr, screen_gamma, 0.45455);
283 }
284
b61cc19c
PC
285#ifdef PNG_READ_QUANTIZE_SUPPORTED
286 /* Quantize RGB files down to 8 bit palette or reduce palettes
0272a10d
VZ
287 * to the number of colors available on your screen.
288 */
289 if (color_type & PNG_COLOR_MASK_COLOR)
290 {
291 int num_palette;
292 png_colorp palette;
293
294 /* This reduces the image to the application supplied palette */
b61cc19c 295 if (/* We have our own palette */)
0272a10d 296 {
b61cc19c 297 /* An array of colors to which the image should be quantized */
0272a10d
VZ
298 png_color std_color_cube[MAX_SCREEN_COLORS];
299
b61cc19c
PC
300 png_set_quantize(png_ptr, std_color_cube, MAX_SCREEN_COLORS,
301 MAX_SCREEN_COLORS, NULL, 0);
0272a10d
VZ
302 }
303 /* This reduces the image to the palette supplied in the file */
304 else if (png_get_PLTE(png_ptr, info_ptr, &palette, &num_palette))
305 {
306 png_uint_16p histogram = NULL;
307
308 png_get_hIST(png_ptr, info_ptr, &histogram);
309
b61cc19c 310 png_set_quantize(png_ptr, palette, num_palette,
0272a10d
VZ
311 max_screen_colors, histogram, 0);
312 }
313 }
b61cc19c 314#endif /* PNG_READ_QUANTIZE_SUPPORTED */
0272a10d 315
b61cc19c 316 /* Invert monochrome files to have 0 as white and 1 as black */
0272a10d
VZ
317 png_set_invert_mono(png_ptr);
318
319 /* If you want to shift the pixel values from the range [0,255] or
320 * [0,65535] to the original [0,7] or [0,31], or whatever range the
321 * colors were originally in:
322 */
323 if (png_get_valid(png_ptr, info_ptr, PNG_INFO_sBIT))
324 {
b61cc19c 325 png_color_8p sig_bit_p;
0272a10d 326
b61cc19c
PC
327 png_get_sBIT(png_ptr, info_ptr, &sig_bit_p);
328 png_set_shift(png_ptr, sig_bit_p);
0272a10d
VZ
329 }
330
b61cc19c 331 /* Flip the RGB pixels to BGR (or RGBA to BGRA) */
0272a10d
VZ
332 if (color_type & PNG_COLOR_MASK_COLOR)
333 png_set_bgr(png_ptr);
334
b61cc19c 335 /* Swap the RGBA or GA data to ARGB or AG (or BGRA to ABGR) */
0272a10d
VZ
336 png_set_swap_alpha(png_ptr);
337
b61cc19c 338 /* Swap bytes of 16 bit files to least significant byte first */
0272a10d
VZ
339 png_set_swap(png_ptr);
340
341 /* Add filler (or alpha) byte (before/after each RGB triplet) */
342 png_set_filler(png_ptr, 0xff, PNG_FILLER_AFTER);
343
9c0d9ce3 344#ifdef PNG_READ_INTERLACING_SUPPORTED
0272a10d
VZ
345 /* Turn on interlace handling. REQUIRED if you are not using
346 * png_read_image(). To see how to handle interlacing passes,
347 * see the png_read_row() method below:
348 */
349 number_passes = png_set_interlace_handling(png_ptr);
9c0d9ce3
DS
350#else
351 number_passes = 1;
352#endif /* PNG_READ_INTERLACING_SUPPORTED */
353
0272a10d
VZ
354
355 /* Optional call to gamma correct and add the background to the palette
356 * and update info structure. REQUIRED if you are expecting libpng to
357 * update the palette for you (ie you selected such a transform above).
358 */
359 png_read_update_info(png_ptr, info_ptr);
360
361 /* Allocate the memory to hold the image using the fields of info_ptr. */
362
363 /* The easiest way to read the image: */
364 png_bytep row_pointers[height];
365
b61cc19c
PC
366 /* Clear the pointer array */
367 for (row = 0; row < height; row++)
368 row_pointers[row] = NULL;
369
0272a10d 370 for (row = 0; row < height; row++)
0272a10d
VZ
371 row_pointers[row] = png_malloc(png_ptr, png_get_rowbytes(png_ptr,
372 info_ptr));
0272a10d
VZ
373
374 /* Now it's time to read the image. One of these methods is REQUIRED */
375#ifdef entire /* Read the entire image in one go */
376 png_read_image(png_ptr, row_pointers);
377
378#else no_entire /* Read the image one or more scanlines at a time */
379 /* The other way to read images - deal with interlacing: */
380
381 for (pass = 0; pass < number_passes; pass++)
382 {
383#ifdef single /* Read the image a single row at a time */
384 for (y = 0; y < height; y++)
385 {
b61cc19c 386 png_read_rows(png_ptr, &row_pointers[y], NULL, 1);
0272a10d
VZ
387 }
388
389#else no_single /* Read the image several rows at a time */
390 for (y = 0; y < height; y += number_of_rows)
391 {
392#ifdef sparkle /* Read the image using the "sparkle" effect. */
b61cc19c 393 png_read_rows(png_ptr, &row_pointers[y], NULL,
0272a10d
VZ
394 number_of_rows);
395#else no_sparkle /* Read the image using the "rectangle" effect */
b61cc19c 396 png_read_rows(png_ptr, NULL, &row_pointers[y],
0272a10d 397 number_of_rows);
b61cc19c 398#endif no_sparkle /* Use only one of these two methods */
0272a10d
VZ
399 }
400
b61cc19c
PC
401 /* If you want to display the image after every pass, do so here */
402#endif no_single /* Use only one of these two methods */
0272a10d 403 }
b61cc19c 404#endif no_entire /* Use only one of these two methods */
0272a10d 405
b61cc19c 406 /* Read rest of file, and get additional chunks in info_ptr - REQUIRED */
0272a10d
VZ
407 png_read_end(png_ptr, info_ptr);
408#endif hilevel
409
410 /* At this point you have read the entire image */
411
b61cc19c
PC
412 /* Clean up after the read, and free any memory allocated - REQUIRED */
413 png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
0272a10d 414
b61cc19c 415 /* Close the file */
0272a10d
VZ
416 fclose(fp);
417
b61cc19c 418 /* That's it */
0272a10d
VZ
419 return (OK);
420}
421
b61cc19c 422/* Progressively read a file */
0272a10d
VZ
423
424int
425initialize_png_reader(png_structp *png_ptr, png_infop *info_ptr)
426{
427 /* Create and initialize the png_struct with the desired error handler
428 * functions. If you want to use the default stderr and longjump method,
429 * you can supply NULL for the last three parameters. We also check that
430 * the library version is compatible in case we are using dynamically
431 * linked libraries.
432 */
433 *png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING,
434 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
435
436 if (*png_ptr == NULL)
437 {
438 *info_ptr = NULL;
439 return (ERROR);
440 }
441
442 *info_ptr = png_create_info_struct(png_ptr);
443
444 if (*info_ptr == NULL)
445 {
b61cc19c 446 png_destroy_read_struct(png_ptr, info_ptr, NULL);
0272a10d
VZ
447 return (ERROR);
448 }
449
450 if (setjmp(png_jmpbuf((*png_ptr))))
451 {
b61cc19c 452 png_destroy_read_struct(png_ptr, info_ptr, NULL);
0272a10d
VZ
453 return (ERROR);
454 }
455
456 /* This one's new. You will need to provide all three
457 * function callbacks, even if you aren't using them all.
458 * If you aren't using all functions, you can specify NULL
459 * parameters. Even when all three functions are NULL,
460 * you need to call png_set_progressive_read_fn().
461 * These functions shouldn't be dependent on global or
462 * static variables if you are decoding several images
463 * simultaneously. You should store stream specific data
464 * in a separate struct, given as the second parameter,
465 * and retrieve the pointer from inside the callbacks using
466 * the function png_get_progressive_ptr(png_ptr).
467 */
468 png_set_progressive_read_fn(*png_ptr, (void *)stream_data,
469 info_callback, row_callback, end_callback);
470
471 return (OK);
472}
473
474int
475process_data(png_structp *png_ptr, png_infop *info_ptr,
476 png_bytep buffer, png_uint_32 length)
477{
478 if (setjmp(png_jmpbuf((*png_ptr))))
479 {
480 /* Free the png_ptr and info_ptr memory on error */
b61cc19c 481 png_destroy_read_struct(png_ptr, info_ptr, NULL);
0272a10d
VZ
482 return (ERROR);
483 }
484
485 /* This one's new also. Simply give it chunks of data as
486 * they arrive from the data stream (in order, of course).
b61cc19c 487 * On segmented machines, don't give it any more than 64K.
0272a10d
VZ
488 * The library seems to run fine with sizes of 4K, although
489 * you can give it much less if necessary (I assume you can
490 * give it chunks of 1 byte, but I haven't tried with less
491 * than 256 bytes yet). When this function returns, you may
492 * want to display any rows that were generated in the row
493 * callback, if you aren't already displaying them there.
494 */
495 png_process_data(*png_ptr, *info_ptr, buffer, length);
496 return (OK);
497}
498
499info_callback(png_structp png_ptr, png_infop info)
500{
b61cc19c
PC
501 /* Do any setup here, including setting any of the transformations
502 * mentioned in the Reading PNG files section. For now, you _must_
503 * call either png_start_read_image() or png_read_update_info()
504 * after all the transformations are set (even if you don't set
505 * any). You may start getting rows before png_process_data()
506 * returns, so this is your last chance to prepare for that.
507 */
0272a10d
VZ
508}
509
510row_callback(png_structp png_ptr, png_bytep new_row,
511 png_uint_32 row_num, int pass)
512{
b61cc19c
PC
513 /*
514 * This function is called for every row in the image. If the
515 * image is interlaced, and you turned on the interlace handler,
516 * this function will be called for every row in every pass.
517 *
518 * In this function you will receive a pointer to new row data from
519 * libpng called new_row that is to replace a corresponding row (of
520 * the same data format) in a buffer allocated by your application.
521 *
522 * The new row data pointer "new_row" may be NULL, indicating there is
523 * no new data to be replaced (in cases of interlace loading).
524 *
525 * If new_row is not NULL then you need to call
526 * png_progressive_combine_row() to replace the corresponding row as
527 * shown below:
528 */
529
530 /* Get pointer to corresponding row in our
531 * PNG read buffer.
532 */
533 png_bytep old_row = ((png_bytep *)our_data)[row_num];
0272a10d 534
9c0d9ce3 535#ifdef PNG_READ_INTERLACING_SUPPORTED
b61cc19c
PC
536 /* If both rows are allocated then copy the new row
537 * data to the corresponding row data.
538 */
539 if ((old_row != NULL) && (new_row != NULL))
0272a10d
VZ
540 png_progressive_combine_row(png_ptr, old_row, new_row);
541
b61cc19c
PC
542 /*
543 * The rows and passes are called in order, so you don't really
544 * need the row_num and pass, but I'm supplying them because it
545 * may make your life easier.
546 *
547 * For the non-NULL rows of interlaced images, you must call
548 * png_progressive_combine_row() passing in the new row and the
549 * old row, as demonstrated above. You can call this function for
550 * NULL rows (it will just return) and for non-interlaced images
551 * (it just does the png_memcpy for you) if it will make the code
552 * easier. Thus, you can just do this for all cases:
553 */
554
555 png_progressive_combine_row(png_ptr, old_row, new_row);
556
557 /* where old_row is what was displayed for previous rows. Note
558 * that the first pass (pass == 0 really) will completely cover
559 * the old row, so the rows do not have to be initialized. After
560 * the first pass (and only for interlaced images), you will have
561 * to pass the current row as new_row, and the function will combine
562 * the old row and the new row.
563 */
9c0d9ce3 564#endif /* PNG_READ_INTERLACING_SUPPORTED */
0272a10d
VZ
565}
566
567end_callback(png_structp png_ptr, png_infop info)
568{
b61cc19c
PC
569 /* This function is called when the whole image has been read,
570 * including any chunks after the image (up to and including
571 * the IEND). You will usually have the same info chunk as you
572 * had in the header, although some data may have been added
573 * to the comments and time fields.
574 *
575 * Most people won't do much here, perhaps setting a flag that
576 * marks the image as finished.
577 */
0272a10d
VZ
578}
579
b61cc19c 580/* Write a png file */
0272a10d
VZ
581void write_png(char *file_name /* , ... other image information ... */)
582{
583 FILE *fp;
584 png_structp png_ptr;
585 png_infop info_ptr;
586 png_colorp palette;
587
b61cc19c 588 /* Open the file */
0272a10d
VZ
589 fp = fopen(file_name, "wb");
590 if (fp == NULL)
591 return (ERROR);
592
593 /* Create and initialize the png_struct with the desired error handler
594 * functions. If you want to use the default stderr and longjump method,
595 * you can supply NULL for the last three parameters. We also check that
596 * the library version is compatible with the one used at compile time,
597 * in case we are using dynamically linked libraries. REQUIRED.
598 */
599 png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING,
600 png_voidp user_error_ptr, user_error_fn, user_warning_fn);
601
602 if (png_ptr == NULL)
603 {
604 fclose(fp);
605 return (ERROR);
606 }
607
608 /* Allocate/initialize the image information data. REQUIRED */
609 info_ptr = png_create_info_struct(png_ptr);
610 if (info_ptr == NULL)
611 {
612 fclose(fp);
b61cc19c 613 png_destroy_write_struct(&png_ptr, NULL);
0272a10d
VZ
614 return (ERROR);
615 }
616
617 /* Set error handling. REQUIRED if you aren't supplying your own
618 * error handling functions in the png_create_write_struct() call.
619 */
620 if (setjmp(png_jmpbuf(png_ptr)))
621 {
b61cc19c 622 /* If we get here, we had a problem writing the file */
0272a10d
VZ
623 fclose(fp);
624 png_destroy_write_struct(&png_ptr, &info_ptr);
625 return (ERROR);
626 }
627
628 /* One of the following I/O initialization functions is REQUIRED */
b61cc19c 629
0272a10d 630#ifdef streams /* I/O initialization method 1 */
b61cc19c 631 /* Set up the output control if you are using standard C streams */
0272a10d 632 png_init_io(png_ptr, fp);
b61cc19c 633
0272a10d 634#else no_streams /* I/O initialization method 2 */
970f6abe 635 /* If you are using replacement write functions, instead of calling
b61cc19c
PC
636 * png_init_io() here you would call
637 */
0272a10d
VZ
638 png_set_write_fn(png_ptr, (void *)user_io_ptr, user_write_fn,
639 user_IO_flush_function);
640 /* where user_io_ptr is a structure you want available to the callbacks */
b61cc19c 641#endif no_streams /* Only use one initialization method */
0272a10d
VZ
642
643#ifdef hilevel
644 /* This is the easy way. Use it if you already have all the
b61cc19c 645 * image info living in the structure. You could "|" many
0272a10d
VZ
646 * PNG_TRANSFORM flags into the png_transforms integer here.
647 */
b61cc19c
PC
648 png_write_png(png_ptr, info_ptr, png_transforms, NULL);
649
0272a10d
VZ
650#else
651 /* This is the hard way */
652
653 /* Set the image information here. Width and height are up to 2^31,
654 * bit_depth is one of 1, 2, 4, 8, or 16, but valid values also depend on
655 * the color_type selected. color_type is one of PNG_COLOR_TYPE_GRAY,
656 * PNG_COLOR_TYPE_GRAY_ALPHA, PNG_COLOR_TYPE_PALETTE, PNG_COLOR_TYPE_RGB,
657 * or PNG_COLOR_TYPE_RGB_ALPHA. interlace is either PNG_INTERLACE_NONE or
658 * PNG_INTERLACE_ADAM7, and the compression_type and filter_type MUST
659 * currently be PNG_COMPRESSION_TYPE_BASE and PNG_FILTER_TYPE_BASE. REQUIRED
660 */
661 png_set_IHDR(png_ptr, info_ptr, width, height, bit_depth, PNG_COLOR_TYPE_???,
662 PNG_INTERLACE_????, PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
663
b61cc19c 664 /* Set the palette if there is one. REQUIRED for indexed-color images */
0272a10d 665 palette = (png_colorp)png_malloc(png_ptr, PNG_MAX_PALETTE_LENGTH
970f6abe 666 * png_sizeof(png_color));
b61cc19c 667 /* ... Set palette colors ... */
0272a10d
VZ
668 png_set_PLTE(png_ptr, info_ptr, palette, PNG_MAX_PALETTE_LENGTH);
669 /* You must not free palette here, because png_set_PLTE only makes a link to
b61cc19c
PC
670 * the palette that you malloced. Wait until you are about to destroy
671 * the png structure.
672 */
0272a10d 673
b61cc19c
PC
674 /* Optional significant bit (sBIT) chunk */
675 png_color_8 sig_bit;
9c0d9ce3 676
b61cc19c 677 /* If we are dealing with a grayscale image then */
0272a10d 678 sig_bit.gray = true_bit_depth;
9c0d9ce3 679
b61cc19c 680 /* Otherwise, if we are dealing with a color image then */
0272a10d
VZ
681 sig_bit.red = true_red_bit_depth;
682 sig_bit.green = true_green_bit_depth;
683 sig_bit.blue = true_blue_bit_depth;
9c0d9ce3 684
b61cc19c 685 /* If the image has an alpha channel then */
0272a10d 686 sig_bit.alpha = true_alpha_bit_depth;
9c0d9ce3 687
b61cc19c 688 png_set_sBIT(png_ptr, info_ptr, &sig_bit);
0272a10d
VZ
689
690
691 /* Optional gamma chunk is strongly suggested if you have any guess
692 * as to the correct gamma of the image.
693 */
694 png_set_gAMA(png_ptr, info_ptr, gamma);
695
696 /* Optionally write comments into the image */
697 text_ptr[0].key = "Title";
698 text_ptr[0].text = "Mona Lisa";
699 text_ptr[0].compression = PNG_TEXT_COMPRESSION_NONE;
9c0d9ce3
DS
700 text_ptr[0].itxt_length = 0;
701 text_ptr[0].lang = NULL;
702 text_ptr[0].lang_key = NULL;
0272a10d
VZ
703 text_ptr[1].key = "Author";
704 text_ptr[1].text = "Leonardo DaVinci";
705 text_ptr[1].compression = PNG_TEXT_COMPRESSION_NONE;
9c0d9ce3
DS
706 text_ptr[1].itxt_length = 0;
707 text_ptr[1].lang = NULL;
708 text_ptr[1].lang_key = NULL;
0272a10d
VZ
709 text_ptr[2].key = "Description";
710 text_ptr[2].text = "<long text>";
711 text_ptr[2].compression = PNG_TEXT_COMPRESSION_zTXt;
9c0d9ce3 712 text_ptr[2].itxt_length = 0;
0272a10d 713 text_ptr[2].lang = NULL;
b61cc19c 714 text_ptr[2].lang_key = NULL;
0272a10d
VZ
715 png_set_text(png_ptr, info_ptr, text_ptr, 3);
716
b61cc19c
PC
717 /* Other optional chunks like cHRM, bKGD, tRNS, tIME, oFFs, pHYs */
718
719 /* Note that if sRGB is present the gAMA and cHRM chunks must be ignored
720 * on read and, if your application chooses to write them, they must
721 * be written in accordance with the sRGB profile
722 */
0272a10d
VZ
723
724 /* Write the file header information. REQUIRED */
725 png_write_info(png_ptr, info_ptr);
726
727 /* If you want, you can write the info in two steps, in case you need to
728 * write your private chunk ahead of PLTE:
729 *
730 * png_write_info_before_PLTE(write_ptr, write_info_ptr);
731 * write_my_chunk();
732 * png_write_info(png_ptr, info_ptr);
733 *
b61cc19c 734 * However, given the level of known- and unknown-chunk support in 1.2.0
0272a10d
VZ
735 * and up, this should no longer be necessary.
736 */
737
738 /* Once we write out the header, the compression type on the text
739 * chunks gets changed to PNG_TEXT_COMPRESSION_NONE_WR or
740 * PNG_TEXT_COMPRESSION_zTXt_WR, so it doesn't get written out again
741 * at the end.
742 */
743
b61cc19c 744 /* Set up the transformations you want. Note that these are
0272a10d
VZ
745 * all optional. Only call them if you want them.
746 */
747
b61cc19c 748 /* Invert monochrome pixels */
0272a10d
VZ
749 png_set_invert_mono(png_ptr);
750
751 /* Shift the pixels up to a legal bit depth and fill in
752 * as appropriate to correctly scale the image.
753 */
754 png_set_shift(png_ptr, &sig_bit);
755
b61cc19c 756 /* Pack pixels into bytes */
0272a10d
VZ
757 png_set_packing(png_ptr);
758
b61cc19c 759 /* Swap location of alpha bytes from ARGB to RGBA */
0272a10d
VZ
760 png_set_swap_alpha(png_ptr);
761
762 /* Get rid of filler (OR ALPHA) bytes, pack XRGB/RGBX/ARGB/RGBA into
763 * RGB (4 channels -> 3 channels). The second parameter is not used.
764 */
765 png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
766
b61cc19c 767 /* Flip BGR pixels to RGB */
0272a10d
VZ
768 png_set_bgr(png_ptr);
769
b61cc19c 770 /* Swap bytes of 16-bit files to most significant byte first */
0272a10d
VZ
771 png_set_swap(png_ptr);
772
b61cc19c 773 /* Swap bits of 1, 2, 4 bit packed pixel formats */
0272a10d
VZ
774 png_set_packswap(png_ptr);
775
b61cc19c 776 /* Turn on interlace handling if you are not using png_write_image() */
0272a10d
VZ
777 if (interlacing)
778 number_passes = png_set_interlace_handling(png_ptr);
9c0d9ce3 779
0272a10d
VZ
780 else
781 number_passes = 1;
782
783 /* The easiest way to write the image (you may have a different memory
784 * layout, however, so choose what fits your needs best). You need to
785 * use the first method if you aren't handling interlacing yourself.
786 */
787 png_uint_32 k, height, width;
788 png_byte image[height][width*bytes_per_pixel];
789 png_bytep row_pointers[height];
790
791 if (height > PNG_UINT_32_MAX/png_sizeof(png_bytep))
792 png_error (png_ptr, "Image is too tall to process in memory");
793
794 for (k = 0; k < height; k++)
795 row_pointers[k] = image + k*width*bytes_per_pixel;
796
797 /* One of the following output methods is REQUIRED */
b61cc19c
PC
798
799#ifdef entire /* Write out the entire image data in one call */
0272a10d
VZ
800 png_write_image(png_ptr, row_pointers);
801
b61cc19c
PC
802 /* The other way to write the image - deal with interlacing */
803
804#else no_entire /* Write out the image data by one or more scanlines */
0272a10d 805
0272a10d
VZ
806 /* The number of passes is either 1 for non-interlaced images,
807 * or 7 for interlaced images.
808 */
809 for (pass = 0; pass < number_passes; pass++)
810 {
811 /* Write a few rows at a time. */
812 png_write_rows(png_ptr, &row_pointers[first_row], number_of_rows);
813
814 /* If you are only writing one row at a time, this works */
815 for (y = 0; y < height; y++)
0272a10d 816 png_write_rows(png_ptr, &row_pointers[y], 1);
0272a10d 817 }
b61cc19c 818#endif no_entire /* Use only one output method */
0272a10d
VZ
819
820 /* You can write optional chunks like tEXt, zTXt, and tIME at the end
b61cc19c 821 * as well. Shouldn't be necessary in 1.2.0 and up as all the public
0272a10d
VZ
822 * chunks are supported and you can use png_set_unknown_chunks() to
823 * register unknown chunks into the info structure to be written out.
824 */
825
826 /* It is REQUIRED to call this to finish writing the rest of the file */
827 png_write_end(png_ptr, info_ptr);
828#endif hilevel
829
830 /* If you png_malloced a palette, free it here (don't free info_ptr->palette,
b61cc19c
PC
831 * as recommended in versions 1.0.5m and earlier of this example; if
832 * libpng mallocs info_ptr->palette, libpng will free it). If you
833 * allocated it with malloc() instead of png_malloc(), use free() instead
834 * of png_free().
835 */
0272a10d 836 png_free(png_ptr, palette);
970f6abe 837 palette = NULL;
0272a10d
VZ
838
839 /* Similarly, if you png_malloced any data that you passed in with
b61cc19c
PC
840 * png_set_something(), such as a hist or trans array, free it here,
841 * when you can be sure that libpng is through with it.
842 */
0272a10d 843 png_free(png_ptr, trans);
970f6abe 844 trans = NULL;
b61cc19c
PC
845 /* Whenever you use png_free() it is a good idea to set the pointer to
846 * NULL in case your application inadvertently tries to png_free() it
847 * again. When png_free() sees a NULL it returns without action, thus
848 * avoiding the double-free security problem.
849 */
0272a10d 850
b61cc19c 851 /* Clean up after the write, and free any memory allocated */
0272a10d
VZ
852 png_destroy_write_struct(&png_ptr, &info_ptr);
853
b61cc19c 854 /* Close the file */
0272a10d
VZ
855 fclose(fp);
856
b61cc19c 857 /* That's it */
0272a10d
VZ
858 return (OK);
859}
860
861#endif /* if 0 */