Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/thirdparty/libpng/png.h
9833 views
1
/* png.h - header file for PNG reference library
2
*
3
* libpng version 1.6.48
4
*
5
* Copyright (c) 2018-2025 Cosmin Truta
6
* Copyright (c) 1998-2002,2004,2006-2018 Glenn Randers-Pehrson
7
* Copyright (c) 1996-1997 Andreas Dilger
8
* Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.
9
*
10
* This code is released under the libpng license. (See LICENSE, below.)
11
*
12
* Authors and maintainers:
13
* libpng versions 0.71, May 1995, through 0.88, January 1996: Guy Schalnat
14
* libpng versions 0.89, June 1996, through 0.96, May 1997: Andreas Dilger
15
* libpng versions 0.97, January 1998, through 1.6.35, July 2018:
16
* Glenn Randers-Pehrson
17
* libpng versions 1.6.36, December 2018, through 1.6.48, April 2025:
18
* Cosmin Truta
19
* See also "Contributing Authors", below.
20
*/
21
22
/*
23
* COPYRIGHT NOTICE, DISCLAIMER, and LICENSE
24
* =========================================
25
*
26
* PNG Reference Library License version 2
27
* ---------------------------------------
28
*
29
* * Copyright (c) 1995-2025 The PNG Reference Library Authors.
30
* * Copyright (c) 2018-2025 Cosmin Truta.
31
* * Copyright (c) 2000-2002, 2004, 2006-2018 Glenn Randers-Pehrson.
32
* * Copyright (c) 1996-1997 Andreas Dilger.
33
* * Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.
34
*
35
* The software is supplied "as is", without warranty of any kind,
36
* express or implied, including, without limitation, the warranties
37
* of merchantability, fitness for a particular purpose, title, and
38
* non-infringement. In no event shall the Copyright owners, or
39
* anyone distributing the software, be liable for any damages or
40
* other liability, whether in contract, tort or otherwise, arising
41
* from, out of, or in connection with the software, or the use or
42
* other dealings in the software, even if advised of the possibility
43
* of such damage.
44
*
45
* Permission is hereby granted to use, copy, modify, and distribute
46
* this software, or portions hereof, for any purpose, without fee,
47
* subject to the following restrictions:
48
*
49
* 1. The origin of this software must not be misrepresented; you
50
* must not claim that you wrote the original software. If you
51
* use this software in a product, an acknowledgment in the product
52
* documentation would be appreciated, but is not required.
53
*
54
* 2. Altered source versions must be plainly marked as such, and must
55
* not be misrepresented as being the original software.
56
*
57
* 3. This Copyright notice may not be removed or altered from any
58
* source or altered source distribution.
59
*
60
*
61
* PNG Reference Library License version 1 (for libpng 0.5 through 1.6.35)
62
* -----------------------------------------------------------------------
63
*
64
* libpng versions 1.0.7, July 1, 2000, through 1.6.35, July 15, 2018 are
65
* Copyright (c) 2000-2002, 2004, 2006-2018 Glenn Randers-Pehrson, are
66
* derived from libpng-1.0.6, and are distributed according to the same
67
* disclaimer and license as libpng-1.0.6 with the following individuals
68
* added to the list of Contributing Authors:
69
*
70
* Simon-Pierre Cadieux
71
* Eric S. Raymond
72
* Mans Rullgard
73
* Cosmin Truta
74
* Gilles Vollant
75
* James Yu
76
* Mandar Sahastrabuddhe
77
* Google Inc.
78
* Vadim Barkov
79
*
80
* and with the following additions to the disclaimer:
81
*
82
* There is no warranty against interference with your enjoyment of
83
* the library or against infringement. There is no warranty that our
84
* efforts or the library will fulfill any of your particular purposes
85
* or needs. This library is provided with all faults, and the entire
86
* risk of satisfactory quality, performance, accuracy, and effort is
87
* with the user.
88
*
89
* Some files in the "contrib" directory and some configure-generated
90
* files that are distributed with libpng have other copyright owners, and
91
* are released under other open source licenses.
92
*
93
* libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are
94
* Copyright (c) 1998-2000 Glenn Randers-Pehrson, are derived from
95
* libpng-0.96, and are distributed according to the same disclaimer and
96
* license as libpng-0.96, with the following individuals added to the
97
* list of Contributing Authors:
98
*
99
* Tom Lane
100
* Glenn Randers-Pehrson
101
* Willem van Schaik
102
*
103
* libpng versions 0.89, June 1996, through 0.96, May 1997, are
104
* Copyright (c) 1996-1997 Andreas Dilger, are derived from libpng-0.88,
105
* and are distributed according to the same disclaimer and license as
106
* libpng-0.88, with the following individuals added to the list of
107
* Contributing Authors:
108
*
109
* John Bowler
110
* Kevin Bracey
111
* Sam Bushell
112
* Magnus Holmgren
113
* Greg Roelofs
114
* Tom Tanner
115
*
116
* Some files in the "scripts" directory have other copyright owners,
117
* but are released under this license.
118
*
119
* libpng versions 0.5, May 1995, through 0.88, January 1996, are
120
* Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.
121
*
122
* For the purposes of this copyright and license, "Contributing Authors"
123
* is defined as the following set of individuals:
124
*
125
* Andreas Dilger
126
* Dave Martindale
127
* Guy Eric Schalnat
128
* Paul Schmidt
129
* Tim Wegner
130
*
131
* The PNG Reference Library is supplied "AS IS". The Contributing
132
* Authors and Group 42, Inc. disclaim all warranties, expressed or
133
* implied, including, without limitation, the warranties of
134
* merchantability and of fitness for any purpose. The Contributing
135
* Authors and Group 42, Inc. assume no liability for direct, indirect,
136
* incidental, special, exemplary, or consequential damages, which may
137
* result from the use of the PNG Reference Library, even if advised of
138
* the possibility of such damage.
139
*
140
* Permission is hereby granted to use, copy, modify, and distribute this
141
* source code, or portions hereof, for any purpose, without fee, subject
142
* to the following restrictions:
143
*
144
* 1. The origin of this source code must not be misrepresented.
145
*
146
* 2. Altered versions must be plainly marked as such and must not
147
* be misrepresented as being the original source.
148
*
149
* 3. This Copyright notice may not be removed or altered from any
150
* source or altered source distribution.
151
*
152
* The Contributing Authors and Group 42, Inc. specifically permit,
153
* without fee, and encourage the use of this source code as a component
154
* to supporting the PNG file format in commercial products. If you use
155
* this source code in a product, acknowledgment is not required but would
156
* be appreciated.
157
*
158
* END OF COPYRIGHT NOTICE, DISCLAIMER, and LICENSE.
159
*
160
* TRADEMARK
161
* =========
162
*
163
* The name "libpng" has not been registered by the Copyright owners
164
* as a trademark in any jurisdiction. However, because libpng has
165
* been distributed and maintained world-wide, continually since 1995,
166
* the Copyright owners claim "common-law trademark protection" in any
167
* jurisdiction where common-law trademark is recognized.
168
*/
169
170
/*
171
* A "png_get_copyright" function is available, for convenient use in "about"
172
* boxes and the like:
173
*
174
* printf("%s", png_get_copyright(NULL));
175
*
176
* Also, the PNG logo (in PNG format, of course) is supplied in the
177
* files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31).
178
*/
179
180
/*
181
* The contributing authors would like to thank all those who helped
182
* with testing, bug fixes, and patience. This wouldn't have been
183
* possible without all of you.
184
*
185
* Thanks to Frank J. T. Wojcik for helping with the documentation.
186
*/
187
188
/* Note about libpng version numbers:
189
*
190
* Due to various miscommunications, unforeseen code incompatibilities
191
* and occasional factors outside the authors' control, version numbering
192
* on the library has not always been consistent and straightforward.
193
* The following table summarizes matters since version 0.89c, which was
194
* the first widely used release:
195
*
196
* source png.h png.h shared-lib
197
* version string int version
198
* ------- ------ ----- ----------
199
* 0.89c "1.0 beta 3" 0.89 89 1.0.89
200
* 0.90 "1.0 beta 4" 0.90 90 0.90 [should have been 2.0.90]
201
* 0.95 "1.0 beta 5" 0.95 95 0.95 [should have been 2.0.95]
202
* 0.96 "1.0 beta 6" 0.96 96 0.96 [should have been 2.0.96]
203
* 0.97b "1.00.97 beta 7" 1.00.97 97 1.0.1 [should have been 2.0.97]
204
* 0.97c 0.97 97 2.0.97
205
* 0.98 0.98 98 2.0.98
206
* 0.99 0.99 98 2.0.99
207
* 0.99a-m 0.99 99 2.0.99
208
* 1.00 1.00 100 2.1.0 [100 should be 10000]
209
* 1.0.0 (from here on, the 100 2.1.0 [100 should be 10000]
210
* 1.0.1 png.h string is 10001 2.1.0
211
* 1.0.1a-e identical to the 10002 from here on, the shared library
212
* 1.0.2 source version) 10002 is 2.V where V is the source code
213
* 1.0.2a-b 10003 version, except as noted.
214
* 1.0.3 10003
215
* 1.0.3a-d 10004
216
* 1.0.4 10004
217
* 1.0.4a-f 10005
218
* 1.0.5 (+ 2 patches) 10005
219
* 1.0.5a-d 10006
220
* 1.0.5e-r 10100 (not source compatible)
221
* 1.0.5s-v 10006 (not binary compatible)
222
* 1.0.6 (+ 3 patches) 10006 (still binary incompatible)
223
* 1.0.6d-f 10007 (still binary incompatible)
224
* 1.0.6g 10007
225
* 1.0.6h 10007 10.6h (testing xy.z so-numbering)
226
* 1.0.6i 10007 10.6i
227
* 1.0.6j 10007 2.1.0.6j (incompatible with 1.0.0)
228
* 1.0.7beta11-14 DLLNUM 10007 2.1.0.7beta11-14 (binary compatible)
229
* 1.0.7beta15-18 1 10007 2.1.0.7beta15-18 (binary compatible)
230
* 1.0.7rc1-2 1 10007 2.1.0.7rc1-2 (binary compatible)
231
* 1.0.7 1 10007 (still compatible)
232
* ...
233
* 1.0.69 10 10069 10.so.0.69[.0]
234
* ...
235
* 1.2.59 13 10259 12.so.0.59[.0]
236
* ...
237
* 1.4.20 14 10420 14.so.0.20[.0]
238
* ...
239
* 1.5.30 15 10530 15.so.15.30[.0]
240
* ...
241
* 1.6.48 16 10648 16.so.16.48[.0]
242
*
243
* Henceforth the source version will match the shared-library major and
244
* minor numbers; the shared-library major version number will be used for
245
* changes in backward compatibility, as it is intended.
246
* The PNG_LIBPNG_VER macro, which is not used within libpng but is
247
* available for applications, is an unsigned integer of the form XYYZZ
248
* corresponding to the source version X.Y.Z (leading zeros in Y and Z).
249
* Beta versions were given the previous public release number plus a
250
* letter, until version 1.0.6j; from then on they were given the upcoming
251
* public release number plus "betaNN" or "rcNN".
252
*
253
* Binary incompatibility exists only when applications make direct access
254
* to the info_ptr or png_ptr members through png.h, and the compiled
255
* application is loaded with a different version of the library.
256
*
257
* See libpng.txt or libpng.3 for more information. The PNG specification
258
* is available as a W3C Recommendation and as an ISO/IEC Standard; see
259
* <https://www.w3.org/TR/2003/REC-PNG-20031110/>
260
*/
261
262
#ifndef PNG_H
263
#define PNG_H
264
265
/* This is not the place to learn how to use libpng. The file libpng-manual.txt
266
* describes how to use libpng, and the file example.c summarizes it
267
* with some code on which to build. This file is useful for looking
268
* at the actual function definitions and structure components. If that
269
* file has been stripped from your copy of libpng, you can find it at
270
* <http://www.libpng.org/pub/png/libpng-manual.txt>
271
*
272
* If you just need to read a PNG file and don't want to read the documentation
273
* skip to the end of this file and read the section entitled 'simplified API'.
274
*/
275
276
/* Version information for png.h - this should match the version in png.c */
277
#define PNG_LIBPNG_VER_STRING "1.6.48"
278
#define PNG_HEADER_VERSION_STRING " libpng version " PNG_LIBPNG_VER_STRING "\n"
279
280
/* The versions of shared library builds should stay in sync, going forward */
281
#define PNG_LIBPNG_VER_SHAREDLIB 16
282
#define PNG_LIBPNG_VER_SONUM PNG_LIBPNG_VER_SHAREDLIB /* [Deprecated] */
283
#define PNG_LIBPNG_VER_DLLNUM PNG_LIBPNG_VER_SHAREDLIB /* [Deprecated] */
284
285
/* These should match the first 3 components of PNG_LIBPNG_VER_STRING: */
286
#define PNG_LIBPNG_VER_MAJOR 1
287
#define PNG_LIBPNG_VER_MINOR 6
288
#define PNG_LIBPNG_VER_RELEASE 48
289
290
/* This should be zero for a public release, or non-zero for a
291
* development version.
292
*/
293
#define PNG_LIBPNG_VER_BUILD 0
294
295
/* Release Status */
296
#define PNG_LIBPNG_BUILD_ALPHA 1
297
#define PNG_LIBPNG_BUILD_BETA 2
298
#define PNG_LIBPNG_BUILD_RC 3
299
#define PNG_LIBPNG_BUILD_STABLE 4
300
#define PNG_LIBPNG_BUILD_RELEASE_STATUS_MASK 7
301
302
/* Release-Specific Flags */
303
#define PNG_LIBPNG_BUILD_PATCH 8 /* Can be OR'ed with
304
PNG_LIBPNG_BUILD_STABLE only */
305
#define PNG_LIBPNG_BUILD_PRIVATE 16 /* Cannot be OR'ed with
306
PNG_LIBPNG_BUILD_SPECIAL */
307
#define PNG_LIBPNG_BUILD_SPECIAL 32 /* Cannot be OR'ed with
308
PNG_LIBPNG_BUILD_PRIVATE */
309
310
#define PNG_LIBPNG_BUILD_BASE_TYPE PNG_LIBPNG_BUILD_STABLE
311
312
/* Careful here. At one time, Guy wanted to use 082, but that
313
* would be octal. We must not include leading zeros.
314
* Versions 0.7 through 1.0.0 were in the range 0 to 100 here
315
* (only version 1.0.0 was mis-numbered 100 instead of 10000).
316
* From version 1.0.1 it is:
317
* XXYYZZ, where XX=major, YY=minor, ZZ=release
318
*/
319
#define PNG_LIBPNG_VER 10648 /* 1.6.48 */
320
321
/* Library configuration: these options cannot be changed after
322
* the library has been built.
323
*/
324
#ifndef PNGLCONF_H
325
/* If pnglibconf.h is missing, you can
326
* copy scripts/pnglibconf.h.prebuilt to pnglibconf.h
327
*/
328
# include "pnglibconf.h"
329
#endif
330
331
#ifndef PNG_VERSION_INFO_ONLY
332
/* Machine specific configuration. */
333
# include "pngconf.h"
334
#endif
335
336
/*
337
* Added at libpng-1.2.8
338
*
339
* Ref MSDN: Private as priority over Special
340
* VS_FF_PRIVATEBUILD File *was not* built using standard release
341
* procedures. If this value is given, the StringFileInfo block must
342
* contain a PrivateBuild string.
343
*
344
* VS_FF_SPECIALBUILD File *was* built by the original company using
345
* standard release procedures but is a variation of the standard
346
* file of the same version number. If this value is given, the
347
* StringFileInfo block must contain a SpecialBuild string.
348
*/
349
350
#ifdef PNG_USER_PRIVATEBUILD /* From pnglibconf.h */
351
# define PNG_LIBPNG_BUILD_TYPE \
352
(PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_PRIVATE)
353
#else
354
# ifdef PNG_LIBPNG_SPECIALBUILD
355
# define PNG_LIBPNG_BUILD_TYPE \
356
(PNG_LIBPNG_BUILD_BASE_TYPE | PNG_LIBPNG_BUILD_SPECIAL)
357
# else
358
# define PNG_LIBPNG_BUILD_TYPE (PNG_LIBPNG_BUILD_BASE_TYPE)
359
# endif
360
#endif
361
362
#ifndef PNG_VERSION_INFO_ONLY
363
364
/* Inhibit C++ name-mangling for libpng functions but not for system calls. */
365
#ifdef __cplusplus
366
extern "C" {
367
#endif /* __cplusplus */
368
369
/* Version information for C files, stored in png.c. This had better match
370
* the version above.
371
*/
372
#define png_libpng_ver png_get_header_ver(NULL)
373
374
/* This file is arranged in several sections:
375
*
376
* 1. [omitted]
377
* 2. Any configuration options that can be specified by for the application
378
* code when it is built. (Build time configuration is in pnglibconf.h)
379
* 3. Type definitions (base types are defined in pngconf.h), structure
380
* definitions.
381
* 4. Exported library functions.
382
* 5. Simplified API.
383
* 6. Implementation options.
384
*
385
* The library source code has additional files (principally pngpriv.h) that
386
* allow configuration of the library.
387
*/
388
389
/* Section 1: [omitted] */
390
391
/* Section 2: run time configuration
392
* See pnglibconf.h for build time configuration
393
*
394
* Run time configuration allows the application to choose between
395
* implementations of certain arithmetic APIs. The default is set
396
* at build time and recorded in pnglibconf.h, but it is safe to
397
* override these (and only these) settings. Note that this won't
398
* change what the library does, only application code, and the
399
* settings can (and probably should) be made on a per-file basis
400
* by setting the #defines before including png.h
401
*
402
* Use macros to read integers from PNG data or use the exported
403
* functions?
404
* PNG_USE_READ_MACROS: use the macros (see below) Note that
405
* the macros evaluate their argument multiple times.
406
* PNG_NO_USE_READ_MACROS: call the relevant library function.
407
*
408
* Use the alternative algorithm for compositing alpha samples that
409
* does not use division?
410
* PNG_READ_COMPOSITE_NODIV_SUPPORTED: use the 'no division'
411
* algorithm.
412
* PNG_NO_READ_COMPOSITE_NODIV: use the 'division' algorithm.
413
*
414
* How to handle benign errors if PNG_ALLOW_BENIGN_ERRORS is
415
* false?
416
* PNG_ALLOW_BENIGN_ERRORS: map calls to the benign error
417
* APIs to png_warning.
418
* Otherwise the calls are mapped to png_error.
419
*/
420
421
/* Section 3: type definitions, including structures and compile time
422
* constants.
423
* See pngconf.h for base types that vary by machine/system
424
*/
425
426
/* This triggers a compiler error in png.c, if png.c and png.h
427
* do not agree upon the version number.
428
*/
429
typedef char* png_libpng_version_1_6_48;
430
431
/* Basic control structions. Read libpng-manual.txt or libpng.3 for more info.
432
*
433
* png_struct is the cache of information used while reading or writing a single
434
* PNG file. One of these is always required, although the simplified API
435
* (below) hides the creation and destruction of it.
436
*/
437
typedef struct png_struct_def png_struct;
438
typedef const png_struct * png_const_structp;
439
typedef png_struct * png_structp;
440
typedef png_struct * * png_structpp;
441
442
/* png_info contains information read from or to be written to a PNG file. One
443
* or more of these must exist while reading or creating a PNG file. The
444
* information is not used by libpng during read but is used to control what
445
* gets written when a PNG file is created. "png_get_" function calls read
446
* information during read and "png_set_" functions calls write information
447
* when creating a PNG.
448
* been moved into a separate header file that is not accessible to
449
* applications. Read libpng-manual.txt or libpng.3 for more info.
450
*/
451
typedef struct png_info_def png_info;
452
typedef png_info * png_infop;
453
typedef const png_info * png_const_infop;
454
typedef png_info * * png_infopp;
455
456
/* Types with names ending 'p' are pointer types. The corresponding types with
457
* names ending 'rp' are identical pointer types except that the pointer is
458
* marked 'restrict', which means that it is the only pointer to the object
459
* passed to the function. Applications should not use the 'restrict' types;
460
* it is always valid to pass 'p' to a pointer with a function argument of the
461
* corresponding 'rp' type. Different compilers have different rules with
462
* regard to type matching in the presence of 'restrict'. For backward
463
* compatibility libpng callbacks never have 'restrict' in their parameters and,
464
* consequentially, writing portable application code is extremely difficult if
465
* an attempt is made to use 'restrict'.
466
*/
467
typedef png_struct * PNG_RESTRICT png_structrp;
468
typedef const png_struct * PNG_RESTRICT png_const_structrp;
469
typedef png_info * PNG_RESTRICT png_inforp;
470
typedef const png_info * PNG_RESTRICT png_const_inforp;
471
472
/* Three color definitions. The order of the red, green, and blue, (and the
473
* exact size) is not important, although the size of the fields need to
474
* be png_byte or png_uint_16 (as defined below).
475
*/
476
typedef struct png_color_struct
477
{
478
png_byte red;
479
png_byte green;
480
png_byte blue;
481
} png_color;
482
typedef png_color * png_colorp;
483
typedef const png_color * png_const_colorp;
484
typedef png_color * * png_colorpp;
485
486
typedef struct png_color_16_struct
487
{
488
png_byte index; /* used for palette files */
489
png_uint_16 red; /* for use in red green blue files */
490
png_uint_16 green;
491
png_uint_16 blue;
492
png_uint_16 gray; /* for use in grayscale files */
493
} png_color_16;
494
typedef png_color_16 * png_color_16p;
495
typedef const png_color_16 * png_const_color_16p;
496
typedef png_color_16 * * png_color_16pp;
497
498
typedef struct png_color_8_struct
499
{
500
png_byte red; /* for use in red green blue files */
501
png_byte green;
502
png_byte blue;
503
png_byte gray; /* for use in grayscale files */
504
png_byte alpha; /* for alpha channel files */
505
} png_color_8;
506
typedef png_color_8 * png_color_8p;
507
typedef const png_color_8 * png_const_color_8p;
508
typedef png_color_8 * * png_color_8pp;
509
510
/*
511
* The following two structures are used for the in-core representation
512
* of sPLT chunks.
513
*/
514
typedef struct png_sPLT_entry_struct
515
{
516
png_uint_16 red;
517
png_uint_16 green;
518
png_uint_16 blue;
519
png_uint_16 alpha;
520
png_uint_16 frequency;
521
} png_sPLT_entry;
522
typedef png_sPLT_entry * png_sPLT_entryp;
523
typedef const png_sPLT_entry * png_const_sPLT_entryp;
524
typedef png_sPLT_entry * * png_sPLT_entrypp;
525
526
/* When the depth of the sPLT palette is 8 bits, the color and alpha samples
527
* occupy the LSB of their respective members, and the MSB of each member
528
* is zero-filled. The frequency member always occupies the full 16 bits.
529
*/
530
531
typedef struct png_sPLT_struct
532
{
533
png_charp name; /* palette name */
534
png_byte depth; /* depth of palette samples */
535
png_sPLT_entryp entries; /* palette entries */
536
png_int_32 nentries; /* number of palette entries */
537
} png_sPLT_t;
538
typedef png_sPLT_t * png_sPLT_tp;
539
typedef const png_sPLT_t * png_const_sPLT_tp;
540
typedef png_sPLT_t * * png_sPLT_tpp;
541
542
#ifdef PNG_TEXT_SUPPORTED
543
/* png_text holds the contents of a text/ztxt/itxt chunk in a PNG file,
544
* and whether that contents is compressed or not. The "key" field
545
* points to a regular zero-terminated C string. The "text" fields can be a
546
* regular C string, an empty string, or a NULL pointer.
547
* However, the structure returned by png_get_text() will always contain
548
* the "text" field as a regular zero-terminated C string (possibly
549
* empty), never a NULL pointer, so it can be safely used in printf() and
550
* other string-handling functions. Note that the "itxt_length", "lang", and
551
* "lang_key" members of the structure only exist when the library is built
552
* with iTXt chunk support. Prior to libpng-1.4.0 the library was built by
553
* default without iTXt support. Also note that when iTXt *is* supported,
554
* the "lang" and "lang_key" fields contain NULL pointers when the
555
* "compression" field contains * PNG_TEXT_COMPRESSION_NONE or
556
* PNG_TEXT_COMPRESSION_zTXt. Note that the "compression value" is not the
557
* same as what appears in the PNG tEXt/zTXt/iTXt chunk's "compression flag"
558
* which is always 0 or 1, or its "compression method" which is always 0.
559
*/
560
typedef struct png_text_struct
561
{
562
int compression; /* compression value:
563
-1: tEXt, none
564
0: zTXt, deflate
565
1: iTXt, none
566
2: iTXt, deflate */
567
png_charp key; /* keyword, 1-79 character description of "text" */
568
png_charp text; /* comment, may be an empty string (ie "")
569
or a NULL pointer */
570
size_t text_length; /* length of the text string */
571
size_t itxt_length; /* length of the itxt string */
572
png_charp lang; /* language code, 0-79 characters
573
or a NULL pointer */
574
png_charp lang_key; /* keyword translated UTF-8 string, 0 or more
575
chars or a NULL pointer */
576
} png_text;
577
typedef png_text * png_textp;
578
typedef const png_text * png_const_textp;
579
typedef png_text * * png_textpp;
580
#endif
581
582
/* Supported compression types for text in PNG files (tEXt, and zTXt).
583
* The values of the PNG_TEXT_COMPRESSION_ defines should NOT be changed. */
584
#define PNG_TEXT_COMPRESSION_NONE_WR -3
585
#define PNG_TEXT_COMPRESSION_zTXt_WR -2
586
#define PNG_TEXT_COMPRESSION_NONE -1
587
#define PNG_TEXT_COMPRESSION_zTXt 0
588
#define PNG_ITXT_COMPRESSION_NONE 1
589
#define PNG_ITXT_COMPRESSION_zTXt 2
590
#define PNG_TEXT_COMPRESSION_LAST 3 /* Not a valid value */
591
592
/* png_time is a way to hold the time in an machine independent way.
593
* Two conversions are provided, both from time_t and struct tm. There
594
* is no portable way to convert to either of these structures, as far
595
* as I know. If you know of a portable way, send it to me. As a side
596
* note - PNG has always been Year 2000 compliant!
597
*/
598
typedef struct png_time_struct
599
{
600
png_uint_16 year; /* full year, as in, 1995 */
601
png_byte month; /* month of year, 1 - 12 */
602
png_byte day; /* day of month, 1 - 31 */
603
png_byte hour; /* hour of day, 0 - 23 */
604
png_byte minute; /* minute of hour, 0 - 59 */
605
png_byte second; /* second of minute, 0 - 60 (for leap seconds) */
606
} png_time;
607
typedef png_time * png_timep;
608
typedef const png_time * png_const_timep;
609
typedef png_time * * png_timepp;
610
611
#if defined(PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED) ||\
612
defined(PNG_USER_CHUNKS_SUPPORTED)
613
/* png_unknown_chunk is a structure to hold queued chunks for which there is
614
* no specific support. The idea is that we can use this to queue
615
* up private chunks for output even though the library doesn't actually
616
* know about their semantics.
617
*
618
* The data in the structure is set by libpng on read and used on write.
619
*/
620
typedef struct png_unknown_chunk_t
621
{
622
png_byte name[5]; /* Textual chunk name with '\0' terminator */
623
png_byte *data; /* Data, should not be modified on read! */
624
size_t size;
625
626
/* On write 'location' must be set using the flag values listed below.
627
* Notice that on read it is set by libpng however the values stored have
628
* more bits set than are listed below. Always treat the value as a
629
* bitmask. On write set only one bit - setting multiple bits may cause the
630
* chunk to be written in multiple places.
631
*/
632
png_byte location; /* mode of operation at read time */
633
}
634
png_unknown_chunk;
635
636
typedef png_unknown_chunk * png_unknown_chunkp;
637
typedef const png_unknown_chunk * png_const_unknown_chunkp;
638
typedef png_unknown_chunk * * png_unknown_chunkpp;
639
#endif
640
641
/* Flag values for the unknown chunk location byte. */
642
#define PNG_HAVE_IHDR 0x01
643
#define PNG_HAVE_PLTE 0x02
644
#define PNG_AFTER_IDAT 0x08
645
646
/* Maximum positive integer used in PNG is (2^31)-1 */
647
#define PNG_UINT_31_MAX ((png_uint_32)0x7fffffffL)
648
#define PNG_UINT_32_MAX ((png_uint_32)(-1))
649
#define PNG_SIZE_MAX ((size_t)(-1))
650
651
/* These are constants for fixed point values encoded in the
652
* PNG specification manner (x100000)
653
*/
654
#define PNG_FP_1 100000
655
#define PNG_FP_HALF 50000
656
#define PNG_FP_MAX ((png_fixed_point)0x7fffffffL)
657
#define PNG_FP_MIN (-PNG_FP_MAX)
658
659
/* These describe the color_type field in png_info. */
660
/* color type masks */
661
#define PNG_COLOR_MASK_PALETTE 1
662
#define PNG_COLOR_MASK_COLOR 2
663
#define PNG_COLOR_MASK_ALPHA 4
664
665
/* color types. Note that not all combinations are legal */
666
#define PNG_COLOR_TYPE_GRAY 0
667
#define PNG_COLOR_TYPE_PALETTE (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_PALETTE)
668
#define PNG_COLOR_TYPE_RGB (PNG_COLOR_MASK_COLOR)
669
#define PNG_COLOR_TYPE_RGB_ALPHA (PNG_COLOR_MASK_COLOR | PNG_COLOR_MASK_ALPHA)
670
#define PNG_COLOR_TYPE_GRAY_ALPHA (PNG_COLOR_MASK_ALPHA)
671
/* aliases */
672
#define PNG_COLOR_TYPE_RGBA PNG_COLOR_TYPE_RGB_ALPHA
673
#define PNG_COLOR_TYPE_GA PNG_COLOR_TYPE_GRAY_ALPHA
674
675
/* This is for compression type. PNG 1.0-1.2 only define the single type. */
676
#define PNG_COMPRESSION_TYPE_BASE 0 /* Deflate method 8, 32K window */
677
#define PNG_COMPRESSION_TYPE_DEFAULT PNG_COMPRESSION_TYPE_BASE
678
679
/* This is for filter type. PNG 1.0-1.2 only define the single type. */
680
#define PNG_FILTER_TYPE_BASE 0 /* Single row per-byte filtering */
681
#define PNG_INTRAPIXEL_DIFFERENCING 64 /* Used only in MNG datastreams */
682
#define PNG_FILTER_TYPE_DEFAULT PNG_FILTER_TYPE_BASE
683
684
/* These are for the interlacing type. These values should NOT be changed. */
685
#define PNG_INTERLACE_NONE 0 /* Non-interlaced image */
686
#define PNG_INTERLACE_ADAM7 1 /* Adam7 interlacing */
687
#define PNG_INTERLACE_LAST 2 /* Not a valid value */
688
689
/* These are for the oFFs chunk. These values should NOT be changed. */
690
#define PNG_OFFSET_PIXEL 0 /* Offset in pixels */
691
#define PNG_OFFSET_MICROMETER 1 /* Offset in micrometers (1/10^6 meter) */
692
#define PNG_OFFSET_LAST 2 /* Not a valid value */
693
694
/* These are for the pCAL chunk. These values should NOT be changed. */
695
#define PNG_EQUATION_LINEAR 0 /* Linear transformation */
696
#define PNG_EQUATION_BASE_E 1 /* Exponential base e transform */
697
#define PNG_EQUATION_ARBITRARY 2 /* Arbitrary base exponential transform */
698
#define PNG_EQUATION_HYPERBOLIC 3 /* Hyperbolic sine transformation */
699
#define PNG_EQUATION_LAST 4 /* Not a valid value */
700
701
/* These are for the sCAL chunk. These values should NOT be changed. */
702
#define PNG_SCALE_UNKNOWN 0 /* unknown unit (image scale) */
703
#define PNG_SCALE_METER 1 /* meters per pixel */
704
#define PNG_SCALE_RADIAN 2 /* radians per pixel */
705
#define PNG_SCALE_LAST 3 /* Not a valid value */
706
707
/* These are for the pHYs chunk. These values should NOT be changed. */
708
#define PNG_RESOLUTION_UNKNOWN 0 /* pixels/unknown unit (aspect ratio) */
709
#define PNG_RESOLUTION_METER 1 /* pixels/meter */
710
#define PNG_RESOLUTION_LAST 2 /* Not a valid value */
711
712
/* These are for the sRGB chunk. These values should NOT be changed. */
713
#define PNG_sRGB_INTENT_PERCEPTUAL 0
714
#define PNG_sRGB_INTENT_RELATIVE 1
715
#define PNG_sRGB_INTENT_SATURATION 2
716
#define PNG_sRGB_INTENT_ABSOLUTE 3
717
#define PNG_sRGB_INTENT_LAST 4 /* Not a valid value */
718
719
/* This is for text chunks */
720
#define PNG_KEYWORD_MAX_LENGTH 79
721
722
/* Maximum number of entries in PLTE/sPLT/tRNS arrays */
723
#define PNG_MAX_PALETTE_LENGTH 256
724
725
/* These determine if an ancillary chunk's data has been successfully read
726
* from the PNG header, or if the application has filled in the corresponding
727
* data in the info_struct to be written into the output file. The values
728
* of the PNG_INFO_<chunk> defines should NOT be changed.
729
*/
730
#define PNG_INFO_gAMA 0x0001U
731
#define PNG_INFO_sBIT 0x0002U
732
#define PNG_INFO_cHRM 0x0004U
733
#define PNG_INFO_PLTE 0x0008U
734
#define PNG_INFO_tRNS 0x0010U
735
#define PNG_INFO_bKGD 0x0020U
736
#define PNG_INFO_hIST 0x0040U
737
#define PNG_INFO_pHYs 0x0080U
738
#define PNG_INFO_oFFs 0x0100U
739
#define PNG_INFO_tIME 0x0200U
740
#define PNG_INFO_pCAL 0x0400U
741
#define PNG_INFO_sRGB 0x0800U /* GR-P, 0.96a */
742
#define PNG_INFO_iCCP 0x1000U /* ESR, 1.0.6 */
743
#define PNG_INFO_sPLT 0x2000U /* ESR, 1.0.6 */
744
#define PNG_INFO_sCAL 0x4000U /* ESR, 1.0.6 */
745
#define PNG_INFO_IDAT 0x8000U /* ESR, 1.0.6 */
746
#define PNG_INFO_eXIf 0x10000U /* GR-P, 1.6.31 */
747
#define PNG_INFO_cICP 0x20000U /* PNGv3: 1.6.45 */
748
#define PNG_INFO_cLLI 0x40000U /* PNGv3: 1.6.45 */
749
#define PNG_INFO_mDCV 0x80000U /* PNGv3: 1.6.45 */
750
/* APNG: these chunks are stored as unknown, these flags are never set
751
* however they are provided as a convenience for implementors of APNG and
752
* avoids any merge conflicts.
753
*
754
* Private chunks: these chunk names violate the chunk name recommendations
755
* because the chunk definitions have no signature and because the private
756
* chunks with these names have been reserved. Private definitions should
757
* avoid them.
758
*/
759
#define PNG_INFO_acTL 0x100000U /* PNGv3: 1.6.45: unknown */
760
#define PNG_INFO_fcTL 0x200000U /* PNGv3: 1.6.45: unknown */
761
#define PNG_INFO_fdAT 0x400000U /* PNGv3: 1.6.45: unknown */
762
763
/* This is used for the transformation routines, as some of them
764
* change these values for the row. It also should enable using
765
* the routines for other purposes.
766
*/
767
typedef struct png_row_info_struct
768
{
769
png_uint_32 width; /* width of row */
770
size_t rowbytes; /* number of bytes in row */
771
png_byte color_type; /* color type of row */
772
png_byte bit_depth; /* bit depth of row */
773
png_byte channels; /* number of channels (1, 2, 3, or 4) */
774
png_byte pixel_depth; /* bits per pixel (depth * channels) */
775
} png_row_info;
776
777
typedef png_row_info * png_row_infop;
778
typedef png_row_info * * png_row_infopp;
779
780
/* These are the function types for the I/O functions and for the functions
781
* that allow the user to override the default I/O functions with his or her
782
* own. The png_error_ptr type should match that of user-supplied warning
783
* and error functions, while the png_rw_ptr type should match that of the
784
* user read/write data functions. Note that the 'write' function must not
785
* modify the buffer it is passed. The 'read' function, on the other hand, is
786
* expected to return the read data in the buffer.
787
*/
788
typedef PNG_CALLBACK(void, *png_error_ptr, (png_structp, png_const_charp));
789
typedef PNG_CALLBACK(void, *png_rw_ptr, (png_structp, png_bytep, size_t));
790
typedef PNG_CALLBACK(void, *png_flush_ptr, (png_structp));
791
typedef PNG_CALLBACK(void, *png_read_status_ptr, (png_structp, png_uint_32,
792
int));
793
typedef PNG_CALLBACK(void, *png_write_status_ptr, (png_structp, png_uint_32,
794
int));
795
796
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
797
typedef PNG_CALLBACK(void, *png_progressive_info_ptr, (png_structp, png_infop));
798
typedef PNG_CALLBACK(void, *png_progressive_end_ptr, (png_structp, png_infop));
799
800
/* The following callback receives png_uint_32 row_number, int pass for the
801
* png_bytep data of the row. When transforming an interlaced image the
802
* row number is the row number within the sub-image of the interlace pass, so
803
* the value will increase to the height of the sub-image (not the full image)
804
* then reset to 0 for the next pass.
805
*
806
* Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
807
* find the output pixel (x,y) given an interlaced sub-image pixel
808
* (row,col,pass). (See below for these macros.)
809
*/
810
typedef PNG_CALLBACK(void, *png_progressive_row_ptr, (png_structp, png_bytep,
811
png_uint_32, int));
812
#endif
813
814
#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
815
defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
816
typedef PNG_CALLBACK(void, *png_user_transform_ptr, (png_structp, png_row_infop,
817
png_bytep));
818
#endif
819
820
#ifdef PNG_USER_CHUNKS_SUPPORTED
821
typedef PNG_CALLBACK(int, *png_user_chunk_ptr, (png_structp,
822
png_unknown_chunkp));
823
#endif
824
#ifdef PNG_UNKNOWN_CHUNKS_SUPPORTED
825
/* not used anywhere */
826
/* typedef PNG_CALLBACK(void, *png_unknown_chunk_ptr, (png_structp)); */
827
#endif
828
829
#ifdef PNG_SETJMP_SUPPORTED
830
/* This must match the function definition in <setjmp.h>, and the application
831
* must include this before png.h to obtain the definition of jmp_buf. The
832
* function is required to be PNG_NORETURN, but this is not checked. If the
833
* function does return the application will crash via an abort() or similar
834
* system level call.
835
*
836
* If you get a warning here while building the library you may need to make
837
* changes to ensure that pnglibconf.h records the calling convention used by
838
* your compiler. This may be very difficult - try using a different compiler
839
* to build the library!
840
*/
841
PNG_FUNCTION(void, (PNGCAPI *png_longjmp_ptr), (jmp_buf, int), typedef);
842
#endif
843
844
/* Transform masks for the high-level interface */
845
#define PNG_TRANSFORM_IDENTITY 0x0000 /* read and write */
846
#define PNG_TRANSFORM_STRIP_16 0x0001 /* read only */
847
#define PNG_TRANSFORM_STRIP_ALPHA 0x0002 /* read only */
848
#define PNG_TRANSFORM_PACKING 0x0004 /* read and write */
849
#define PNG_TRANSFORM_PACKSWAP 0x0008 /* read and write */
850
#define PNG_TRANSFORM_EXPAND 0x0010 /* read only */
851
#define PNG_TRANSFORM_INVERT_MONO 0x0020 /* read and write */
852
#define PNG_TRANSFORM_SHIFT 0x0040 /* read and write */
853
#define PNG_TRANSFORM_BGR 0x0080 /* read and write */
854
#define PNG_TRANSFORM_SWAP_ALPHA 0x0100 /* read and write */
855
#define PNG_TRANSFORM_SWAP_ENDIAN 0x0200 /* read and write */
856
#define PNG_TRANSFORM_INVERT_ALPHA 0x0400 /* read and write */
857
#define PNG_TRANSFORM_STRIP_FILLER 0x0800 /* write only */
858
/* Added to libpng-1.2.34 */
859
#define PNG_TRANSFORM_STRIP_FILLER_BEFORE PNG_TRANSFORM_STRIP_FILLER
860
#define PNG_TRANSFORM_STRIP_FILLER_AFTER 0x1000 /* write only */
861
/* Added to libpng-1.4.0 */
862
#define PNG_TRANSFORM_GRAY_TO_RGB 0x2000 /* read only */
863
/* Added to libpng-1.5.4 */
864
#define PNG_TRANSFORM_EXPAND_16 0x4000 /* read only */
865
#if ~0U > 0xffffU /* or else this might break on a 16-bit machine */
866
#define PNG_TRANSFORM_SCALE_16 0x8000 /* read only */
867
#endif
868
869
/* Flags for MNG supported features */
870
#define PNG_FLAG_MNG_EMPTY_PLTE 0x01
871
#define PNG_FLAG_MNG_FILTER_64 0x04
872
#define PNG_ALL_MNG_FEATURES 0x05
873
874
/* NOTE: prior to 1.5 these functions had no 'API' style declaration,
875
* this allowed the zlib default functions to be used on Windows
876
* platforms. In 1.5 the zlib default malloc (which just calls malloc and
877
* ignores the first argument) should be completely compatible with the
878
* following.
879
*/
880
typedef PNG_CALLBACK(png_voidp, *png_malloc_ptr, (png_structp,
881
png_alloc_size_t));
882
typedef PNG_CALLBACK(void, *png_free_ptr, (png_structp, png_voidp));
883
884
/* Section 4: exported functions
885
* Here are the function definitions most commonly used. This is not
886
* the place to find out how to use libpng. See libpng-manual.txt for the
887
* full explanation, see example.c for the summary. This just provides
888
* a simple one line description of the use of each function.
889
*
890
* The PNG_EXPORT() and PNG_EXPORTA() macros used below are defined in
891
* pngconf.h and in the *.dfn files in the scripts directory.
892
*
893
* PNG_EXPORT(ordinal, type, name, (args));
894
*
895
* ordinal: ordinal that is used while building
896
* *.def files. The ordinal value is only
897
* relevant when preprocessing png.h with
898
* the *.dfn files for building symbol table
899
* entries, and are removed by pngconf.h.
900
* type: return type of the function
901
* name: function name
902
* args: function arguments, with types
903
*
904
* When we wish to append attributes to a function prototype we use
905
* the PNG_EXPORTA() macro instead.
906
*
907
* PNG_EXPORTA(ordinal, type, name, (args), attributes);
908
*
909
* ordinal, type, name, and args: same as in PNG_EXPORT().
910
* attributes: function attributes
911
*/
912
913
/* Returns the version number of the library */
914
PNG_EXPORT(1, png_uint_32, png_access_version_number, (void));
915
916
/* Tell lib we have already handled the first <num_bytes> magic bytes.
917
* Handling more than 8 bytes from the beginning of the file is an error.
918
*/
919
PNG_EXPORT(2, void, png_set_sig_bytes, (png_structrp png_ptr, int num_bytes));
920
921
/* Check sig[start] through sig[start + num_to_check - 1] to see if it's a
922
* PNG file. Returns zero if the supplied bytes match the 8-byte PNG
923
* signature, and non-zero otherwise. Having num_to_check == 0 or
924
* start > 7 will always fail (i.e. return non-zero).
925
*/
926
PNG_EXPORT(3, int, png_sig_cmp, (png_const_bytep sig, size_t start,
927
size_t num_to_check));
928
929
/* Simple signature checking function. This is the same as calling
930
* png_check_sig(sig, n) := (png_sig_cmp(sig, 0, n) == 0).
931
*/
932
#define png_check_sig(sig, n) (png_sig_cmp((sig), 0, (n)) == 0) /* DEPRECATED */
933
934
/* Allocate and initialize png_ptr struct for reading, and any other memory. */
935
PNG_EXPORTA(4, png_structp, png_create_read_struct,
936
(png_const_charp user_png_ver, png_voidp error_ptr,
937
png_error_ptr error_fn, png_error_ptr warn_fn),
938
PNG_ALLOCATED);
939
940
/* Allocate and initialize png_ptr struct for writing, and any other memory */
941
PNG_EXPORTA(5, png_structp, png_create_write_struct,
942
(png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
943
png_error_ptr warn_fn),
944
PNG_ALLOCATED);
945
946
PNG_EXPORT(6, size_t, png_get_compression_buffer_size,
947
(png_const_structrp png_ptr));
948
949
PNG_EXPORT(7, void, png_set_compression_buffer_size, (png_structrp png_ptr,
950
size_t size));
951
952
/* Moved from pngconf.h in 1.4.0 and modified to ensure setjmp/longjmp
953
* match up.
954
*/
955
#ifdef PNG_SETJMP_SUPPORTED
956
/* This function returns the jmp_buf built in to *png_ptr. It must be
957
* supplied with an appropriate 'longjmp' function to use on that jmp_buf
958
* unless the default error function is overridden in which case NULL is
959
* acceptable. The size of the jmp_buf is checked against the actual size
960
* allocated by the library - the call will return NULL on a mismatch
961
* indicating an ABI mismatch.
962
*/
963
PNG_EXPORT(8, jmp_buf*, png_set_longjmp_fn, (png_structrp png_ptr,
964
png_longjmp_ptr longjmp_fn, size_t jmp_buf_size));
965
# define png_jmpbuf(png_ptr) \
966
(*png_set_longjmp_fn((png_ptr), longjmp, (sizeof (jmp_buf))))
967
#else
968
# define png_jmpbuf(png_ptr) \
969
(LIBPNG_WAS_COMPILED_WITH__PNG_NO_SETJMP)
970
#endif
971
/* This function should be used by libpng applications in place of
972
* longjmp(png_ptr->jmpbuf, val). If longjmp_fn() has been set, it
973
* will use it; otherwise it will call PNG_ABORT(). This function was
974
* added in libpng-1.5.0.
975
*/
976
PNG_EXPORTA(9, void, png_longjmp, (png_const_structrp png_ptr, int val),
977
PNG_NORETURN);
978
979
#ifdef PNG_READ_SUPPORTED
980
/* Reset the compression stream */
981
PNG_EXPORTA(10, int, png_reset_zstream, (png_structrp png_ptr), PNG_DEPRECATED);
982
#endif
983
984
/* New functions added in libpng-1.0.2 (not enabled by default until 1.2.0) */
985
#ifdef PNG_USER_MEM_SUPPORTED
986
PNG_EXPORTA(11, png_structp, png_create_read_struct_2,
987
(png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
988
png_error_ptr warn_fn,
989
png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
990
PNG_ALLOCATED);
991
PNG_EXPORTA(12, png_structp, png_create_write_struct_2,
992
(png_const_charp user_png_ver, png_voidp error_ptr, png_error_ptr error_fn,
993
png_error_ptr warn_fn,
994
png_voidp mem_ptr, png_malloc_ptr malloc_fn, png_free_ptr free_fn),
995
PNG_ALLOCATED);
996
#endif
997
998
/* Write the PNG file signature. */
999
PNG_EXPORT(13, void, png_write_sig, (png_structrp png_ptr));
1000
1001
/* Write a PNG chunk - size, type, (optional) data, CRC. */
1002
PNG_EXPORT(14, void, png_write_chunk, (png_structrp png_ptr, png_const_bytep
1003
chunk_name, png_const_bytep data, size_t length));
1004
1005
/* Write the start of a PNG chunk - length and chunk name. */
1006
PNG_EXPORT(15, void, png_write_chunk_start, (png_structrp png_ptr,
1007
png_const_bytep chunk_name, png_uint_32 length));
1008
1009
/* Write the data of a PNG chunk started with png_write_chunk_start(). */
1010
PNG_EXPORT(16, void, png_write_chunk_data, (png_structrp png_ptr,
1011
png_const_bytep data, size_t length));
1012
1013
/* Finish a chunk started with png_write_chunk_start() (includes CRC). */
1014
PNG_EXPORT(17, void, png_write_chunk_end, (png_structrp png_ptr));
1015
1016
/* Allocate and initialize the info structure */
1017
PNG_EXPORTA(18, png_infop, png_create_info_struct, (png_const_structrp png_ptr),
1018
PNG_ALLOCATED);
1019
1020
/* DEPRECATED: this function allowed init structures to be created using the
1021
* default allocation method (typically malloc). Use is deprecated in 1.6.0 and
1022
* the API will be removed in the future.
1023
*/
1024
PNG_EXPORTA(19, void, png_info_init_3, (png_infopp info_ptr,
1025
size_t png_info_struct_size), PNG_DEPRECATED);
1026
1027
/* Writes all the PNG information before the image. */
1028
PNG_EXPORT(20, void, png_write_info_before_PLTE,
1029
(png_structrp png_ptr, png_const_inforp info_ptr));
1030
PNG_EXPORT(21, void, png_write_info,
1031
(png_structrp png_ptr, png_const_inforp info_ptr));
1032
1033
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1034
/* Read the information before the actual image data. */
1035
PNG_EXPORT(22, void, png_read_info,
1036
(png_structrp png_ptr, png_inforp info_ptr));
1037
#endif
1038
1039
#ifdef PNG_TIME_RFC1123_SUPPORTED
1040
/* Convert to a US string format: there is no localization support in this
1041
* routine. The original implementation used a 29 character buffer in
1042
* png_struct, this will be removed in future versions.
1043
*/
1044
#if PNG_LIBPNG_VER < 10700
1045
/* To do: remove this from libpng17 (and from libpng17/png.c and pngstruct.h) */
1046
PNG_EXPORTA(23, png_const_charp, png_convert_to_rfc1123, (png_structrp png_ptr,
1047
png_const_timep ptime),PNG_DEPRECATED);
1048
#endif
1049
PNG_EXPORT(241, int, png_convert_to_rfc1123_buffer, (char out[29],
1050
png_const_timep ptime));
1051
#endif
1052
1053
#ifdef PNG_CONVERT_tIME_SUPPORTED
1054
/* Convert from a struct tm to png_time */
1055
PNG_EXPORT(24, void, png_convert_from_struct_tm, (png_timep ptime,
1056
const struct tm * ttime));
1057
1058
/* Convert from time_t to png_time. Uses gmtime() */
1059
PNG_EXPORT(25, void, png_convert_from_time_t, (png_timep ptime, time_t ttime));
1060
#endif /* CONVERT_tIME */
1061
1062
#ifdef PNG_READ_EXPAND_SUPPORTED
1063
/* Expand data to 24-bit RGB, or 8-bit grayscale, with alpha if available. */
1064
PNG_EXPORT(26, void, png_set_expand, (png_structrp png_ptr));
1065
PNG_EXPORT(27, void, png_set_expand_gray_1_2_4_to_8, (png_structrp png_ptr));
1066
PNG_EXPORT(28, void, png_set_palette_to_rgb, (png_structrp png_ptr));
1067
PNG_EXPORT(29, void, png_set_tRNS_to_alpha, (png_structrp png_ptr));
1068
#endif
1069
1070
#ifdef PNG_READ_EXPAND_16_SUPPORTED
1071
/* Expand to 16-bit channels, forces conversion of palette to RGB and expansion
1072
* of a tRNS chunk if present.
1073
*/
1074
PNG_EXPORT(221, void, png_set_expand_16, (png_structrp png_ptr));
1075
#endif
1076
1077
#if defined(PNG_READ_BGR_SUPPORTED) || defined(PNG_WRITE_BGR_SUPPORTED)
1078
/* Use blue, green, red order for pixels. */
1079
PNG_EXPORT(30, void, png_set_bgr, (png_structrp png_ptr));
1080
#endif
1081
1082
#ifdef PNG_READ_GRAY_TO_RGB_SUPPORTED
1083
/* Expand the grayscale to 24-bit RGB if necessary. */
1084
PNG_EXPORT(31, void, png_set_gray_to_rgb, (png_structrp png_ptr));
1085
#endif
1086
1087
#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
1088
/* Reduce RGB to grayscale. */
1089
#define PNG_ERROR_ACTION_NONE 1
1090
#define PNG_ERROR_ACTION_WARN 2
1091
#define PNG_ERROR_ACTION_ERROR 3
1092
#define PNG_RGB_TO_GRAY_DEFAULT (-1)/*for red/green coefficients*/
1093
1094
PNG_FP_EXPORT(32, void, png_set_rgb_to_gray, (png_structrp png_ptr,
1095
int error_action, double red, double green))
1096
PNG_FIXED_EXPORT(33, void, png_set_rgb_to_gray_fixed, (png_structrp png_ptr,
1097
int error_action, png_fixed_point red, png_fixed_point green))
1098
1099
PNG_EXPORT(34, png_byte, png_get_rgb_to_gray_status, (png_const_structrp
1100
png_ptr));
1101
#endif
1102
1103
#ifdef PNG_BUILD_GRAYSCALE_PALETTE_SUPPORTED
1104
PNG_EXPORT(35, void, png_build_grayscale_palette, (int bit_depth,
1105
png_colorp palette));
1106
#endif
1107
1108
#ifdef PNG_READ_ALPHA_MODE_SUPPORTED
1109
/* How the alpha channel is interpreted - this affects how the color channels
1110
* of a PNG file are returned to the calling application when an alpha channel,
1111
* or a tRNS chunk in a palette file, is present.
1112
*
1113
* This has no effect on the way pixels are written into a PNG output
1114
* datastream. The color samples in a PNG datastream are never premultiplied
1115
* with the alpha samples.
1116
*
1117
* The default is to return data according to the PNG specification: the alpha
1118
* channel is a linear measure of the contribution of the pixel to the
1119
* corresponding composited pixel, and the color channels are unassociated
1120
* (not premultiplied). The gamma encoded color channels must be scaled
1121
* according to the contribution and to do this it is necessary to undo
1122
* the encoding, scale the color values, perform the composition and re-encode
1123
* the values. This is the 'PNG' mode.
1124
*
1125
* The alternative is to 'associate' the alpha with the color information by
1126
* storing color channel values that have been scaled by the alpha.
1127
* image. These are the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' modes
1128
* (the latter being the two common names for associated alpha color channels).
1129
*
1130
* For the 'OPTIMIZED' mode, a pixel is treated as opaque only if the alpha
1131
* value is equal to the maximum value.
1132
*
1133
* The final choice is to gamma encode the alpha channel as well. This is
1134
* broken because, in practice, no implementation that uses this choice
1135
* correctly undoes the encoding before handling alpha composition. Use this
1136
* choice only if other serious errors in the software or hardware you use
1137
* mandate it; the typical serious error is for dark halos to appear around
1138
* opaque areas of the composited PNG image because of arithmetic overflow.
1139
*
1140
* The API function png_set_alpha_mode specifies which of these choices to use
1141
* with an enumerated 'mode' value and the gamma of the required output:
1142
*/
1143
#define PNG_ALPHA_PNG 0 /* according to the PNG standard */
1144
#define PNG_ALPHA_STANDARD 1 /* according to Porter/Duff */
1145
#define PNG_ALPHA_ASSOCIATED 1 /* as above; this is the normal practice */
1146
#define PNG_ALPHA_PREMULTIPLIED 1 /* as above */
1147
#define PNG_ALPHA_OPTIMIZED 2 /* 'PNG' for opaque pixels, else 'STANDARD' */
1148
#define PNG_ALPHA_BROKEN 3 /* the alpha channel is gamma encoded */
1149
1150
PNG_FP_EXPORT(227, void, png_set_alpha_mode, (png_structrp png_ptr, int mode,
1151
double output_gamma))
1152
PNG_FIXED_EXPORT(228, void, png_set_alpha_mode_fixed, (png_structrp png_ptr,
1153
int mode, png_fixed_point output_gamma))
1154
#endif
1155
1156
#if defined(PNG_GAMMA_SUPPORTED) || defined(PNG_READ_ALPHA_MODE_SUPPORTED)
1157
/* The output_gamma value is a screen gamma in libpng terminology: it expresses
1158
* how to decode the output values, not how they are encoded.
1159
*/
1160
#define PNG_DEFAULT_sRGB -1 /* sRGB gamma and color space */
1161
#define PNG_GAMMA_MAC_18 -2 /* Old Mac '1.8' gamma and color space */
1162
#define PNG_GAMMA_sRGB 220000 /* Television standards--matches sRGB gamma */
1163
#define PNG_GAMMA_LINEAR PNG_FP_1 /* Linear */
1164
#endif
1165
1166
/* The following are examples of calls to png_set_alpha_mode to achieve the
1167
* required overall gamma correction and, where necessary, alpha
1168
* premultiplication.
1169
*
1170
* png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1171
* This is the default libpng handling of the alpha channel - it is not
1172
* pre-multiplied into the color components. In addition the call states
1173
* that the output is for a sRGB system and causes all PNG files without gAMA
1174
* chunks to be assumed to be encoded using sRGB.
1175
*
1176
* png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1177
* In this case the output is assumed to be something like an sRGB conformant
1178
* display preceded by a power-law lookup table of power 1.45. This is how
1179
* early Mac systems behaved.
1180
*
1181
* png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
1182
* This is the classic Jim Blinn approach and will work in academic
1183
* environments where everything is done by the book. It has the shortcoming
1184
* of assuming that input PNG data with no gamma information is linear - this
1185
* is unlikely to be correct unless the PNG files where generated locally.
1186
* Most of the time the output precision will be so low as to show
1187
* significant banding in dark areas of the image.
1188
*
1189
* png_set_expand_16(pp);
1190
* png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
1191
* This is a somewhat more realistic Jim Blinn inspired approach. PNG files
1192
* are assumed to have the sRGB encoding if not marked with a gamma value and
1193
* the output is always 16 bits per component. This permits accurate scaling
1194
* and processing of the data. If you know that your input PNG files were
1195
* generated locally you might need to replace PNG_DEFAULT_sRGB with the
1196
* correct value for your system.
1197
*
1198
* png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
1199
* If you just need to composite the PNG image onto an existing background
1200
* and if you control the code that does this you can use the optimization
1201
* setting. In this case you just copy completely opaque pixels to the
1202
* output. For pixels that are not completely transparent (you just skip
1203
* those) you do the composition math using png_composite or png_composite_16
1204
* below then encode the resultant 8-bit or 16-bit values to match the output
1205
* encoding.
1206
*
1207
* Other cases
1208
* If neither the PNG nor the standard linear encoding work for you because
1209
* of the software or hardware you use then you have a big problem. The PNG
1210
* case will probably result in halos around the image. The linear encoding
1211
* will probably result in a washed out, too bright, image (it's actually too
1212
* contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably
1213
* substantially reduce the halos. Alternatively try:
1214
*
1215
* png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
1216
* This option will also reduce the halos, but there will be slight dark
1217
* halos round the opaque parts of the image where the background is light.
1218
* In the OPTIMIZED mode the halos will be light halos where the background
1219
* is dark. Take your pick - the halos are unavoidable unless you can get
1220
* your hardware/software fixed! (The OPTIMIZED approach is slightly
1221
* faster.)
1222
*
1223
* When the default gamma of PNG files doesn't match the output gamma.
1224
* If you have PNG files with no gamma information png_set_alpha_mode allows
1225
* you to provide a default gamma, but it also sets the output gamma to the
1226
* matching value. If you know your PNG files have a gamma that doesn't
1227
* match the output you can take advantage of the fact that
1228
* png_set_alpha_mode always sets the output gamma but only sets the PNG
1229
* default if it is not already set:
1230
*
1231
* png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
1232
* png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
1233
* The first call sets both the default and the output gamma values, the
1234
* second call overrides the output gamma without changing the default. This
1235
* is easier than achieving the same effect with png_set_gamma. You must use
1236
* PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
1237
* fire if more than one call to png_set_alpha_mode and png_set_background is
1238
* made in the same read operation, however multiple calls with PNG_ALPHA_PNG
1239
* are ignored.
1240
*/
1241
1242
#ifdef PNG_READ_STRIP_ALPHA_SUPPORTED
1243
PNG_EXPORT(36, void, png_set_strip_alpha, (png_structrp png_ptr));
1244
#endif
1245
1246
#if defined(PNG_READ_SWAP_ALPHA_SUPPORTED) || \
1247
defined(PNG_WRITE_SWAP_ALPHA_SUPPORTED)
1248
PNG_EXPORT(37, void, png_set_swap_alpha, (png_structrp png_ptr));
1249
#endif
1250
1251
#if defined(PNG_READ_INVERT_ALPHA_SUPPORTED) || \
1252
defined(PNG_WRITE_INVERT_ALPHA_SUPPORTED)
1253
PNG_EXPORT(38, void, png_set_invert_alpha, (png_structrp png_ptr));
1254
#endif
1255
1256
#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
1257
/* Add a filler byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */
1258
PNG_EXPORT(39, void, png_set_filler, (png_structrp png_ptr, png_uint_32 filler,
1259
int flags));
1260
/* The values of the PNG_FILLER_ defines should NOT be changed */
1261
# define PNG_FILLER_BEFORE 0
1262
# define PNG_FILLER_AFTER 1
1263
/* Add an alpha byte to 8-bit or 16-bit Gray or 24-bit or 48-bit RGB images. */
1264
PNG_EXPORT(40, void, png_set_add_alpha, (png_structrp png_ptr,
1265
png_uint_32 filler, int flags));
1266
#endif /* READ_FILLER || WRITE_FILLER */
1267
1268
#if defined(PNG_READ_SWAP_SUPPORTED) || defined(PNG_WRITE_SWAP_SUPPORTED)
1269
/* Swap bytes in 16-bit depth files. */
1270
PNG_EXPORT(41, void, png_set_swap, (png_structrp png_ptr));
1271
#endif
1272
1273
#if defined(PNG_READ_PACK_SUPPORTED) || defined(PNG_WRITE_PACK_SUPPORTED)
1274
/* Use 1 byte per pixel in 1, 2, or 4-bit depth files. */
1275
PNG_EXPORT(42, void, png_set_packing, (png_structrp png_ptr));
1276
#endif
1277
1278
#if defined(PNG_READ_PACKSWAP_SUPPORTED) || \
1279
defined(PNG_WRITE_PACKSWAP_SUPPORTED)
1280
/* Swap packing order of pixels in bytes. */
1281
PNG_EXPORT(43, void, png_set_packswap, (png_structrp png_ptr));
1282
#endif
1283
1284
#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
1285
/* Converts files to legal bit depths. */
1286
PNG_EXPORT(44, void, png_set_shift, (png_structrp png_ptr, png_const_color_8p
1287
true_bits));
1288
#endif
1289
1290
#if defined(PNG_READ_INTERLACING_SUPPORTED) || \
1291
defined(PNG_WRITE_INTERLACING_SUPPORTED)
1292
/* Have the code handle the interlacing. Returns the number of passes.
1293
* MUST be called before png_read_update_info or png_start_read_image,
1294
* otherwise it will not have the desired effect. Note that it is still
1295
* necessary to call png_read_row or png_read_rows png_get_image_height
1296
* times for each pass.
1297
*/
1298
PNG_EXPORT(45, int, png_set_interlace_handling, (png_structrp png_ptr));
1299
#endif
1300
1301
#if defined(PNG_READ_INVERT_SUPPORTED) || defined(PNG_WRITE_INVERT_SUPPORTED)
1302
/* Invert monochrome files */
1303
PNG_EXPORT(46, void, png_set_invert_mono, (png_structrp png_ptr));
1304
#endif
1305
1306
#ifdef PNG_READ_BACKGROUND_SUPPORTED
1307
/* Handle alpha and tRNS by replacing with a background color. Prior to
1308
* libpng-1.5.4 this API must not be called before the PNG file header has been
1309
* read. Doing so will result in unexpected behavior and possible warnings or
1310
* errors if the PNG file contains a bKGD chunk.
1311
*/
1312
PNG_FP_EXPORT(47, void, png_set_background, (png_structrp png_ptr,
1313
png_const_color_16p background_color, int background_gamma_code,
1314
int need_expand, double background_gamma))
1315
PNG_FIXED_EXPORT(215, void, png_set_background_fixed, (png_structrp png_ptr,
1316
png_const_color_16p background_color, int background_gamma_code,
1317
int need_expand, png_fixed_point background_gamma))
1318
#endif
1319
#ifdef PNG_READ_BACKGROUND_SUPPORTED
1320
# define PNG_BACKGROUND_GAMMA_UNKNOWN 0
1321
# define PNG_BACKGROUND_GAMMA_SCREEN 1
1322
# define PNG_BACKGROUND_GAMMA_FILE 2
1323
# define PNG_BACKGROUND_GAMMA_UNIQUE 3
1324
#endif
1325
1326
#ifdef PNG_READ_SCALE_16_TO_8_SUPPORTED
1327
/* Scale a 16-bit depth file down to 8-bit, accurately. */
1328
PNG_EXPORT(229, void, png_set_scale_16, (png_structrp png_ptr));
1329
#endif
1330
1331
#ifdef PNG_READ_STRIP_16_TO_8_SUPPORTED
1332
#define PNG_READ_16_TO_8_SUPPORTED /* Name prior to 1.5.4 */
1333
/* Strip the second byte of information from a 16-bit depth file. */
1334
PNG_EXPORT(48, void, png_set_strip_16, (png_structrp png_ptr));
1335
#endif
1336
1337
#ifdef PNG_READ_QUANTIZE_SUPPORTED
1338
/* Turn on quantizing, and reduce the palette to the number of colors
1339
* available.
1340
*/
1341
PNG_EXPORT(49, void, png_set_quantize, (png_structrp png_ptr,
1342
png_colorp palette, int num_palette, int maximum_colors,
1343
png_const_uint_16p histogram, int full_quantize));
1344
#endif
1345
1346
#ifdef PNG_READ_GAMMA_SUPPORTED
1347
/* The threshold on gamma processing is configurable but hard-wired into the
1348
* library. The following is the floating point variant.
1349
*/
1350
#define PNG_GAMMA_THRESHOLD (PNG_GAMMA_THRESHOLD_FIXED*.00001)
1351
1352
/* Handle gamma correction. Screen_gamma=(display_exponent).
1353
* NOTE: this API simply sets the screen and file gamma values. It will
1354
* therefore override the value for gamma in a PNG file if it is called after
1355
* the file header has been read - use with care - call before reading the PNG
1356
* file for best results!
1357
*
1358
* These routines accept the same gamma values as png_set_alpha_mode (described
1359
* above). The PNG_GAMMA_ defines and PNG_DEFAULT_sRGB can be passed to either
1360
* API (floating point or fixed.) Notice, however, that the 'file_gamma' value
1361
* is the inverse of a 'screen gamma' value.
1362
*/
1363
PNG_FP_EXPORT(50, void, png_set_gamma, (png_structrp png_ptr,
1364
double screen_gamma, double override_file_gamma))
1365
PNG_FIXED_EXPORT(208, void, png_set_gamma_fixed, (png_structrp png_ptr,
1366
png_fixed_point screen_gamma, png_fixed_point override_file_gamma))
1367
#endif
1368
1369
#ifdef PNG_WRITE_FLUSH_SUPPORTED
1370
/* Set how many lines between output flushes - 0 for no flushing */
1371
PNG_EXPORT(51, void, png_set_flush, (png_structrp png_ptr, int nrows));
1372
/* Flush the current PNG output buffer */
1373
PNG_EXPORT(52, void, png_write_flush, (png_structrp png_ptr));
1374
#endif
1375
1376
/* Optional update palette with requested transformations */
1377
PNG_EXPORT(53, void, png_start_read_image, (png_structrp png_ptr));
1378
1379
/* Optional call to update the users info structure */
1380
PNG_EXPORT(54, void, png_read_update_info, (png_structrp png_ptr,
1381
png_inforp info_ptr));
1382
1383
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1384
/* Read one or more rows of image data. */
1385
PNG_EXPORT(55, void, png_read_rows, (png_structrp png_ptr, png_bytepp row,
1386
png_bytepp display_row, png_uint_32 num_rows));
1387
#endif
1388
1389
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1390
/* Read a row of data. */
1391
PNG_EXPORT(56, void, png_read_row, (png_structrp png_ptr, png_bytep row,
1392
png_bytep display_row));
1393
#endif
1394
1395
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1396
/* Read the whole image into memory at once. */
1397
PNG_EXPORT(57, void, png_read_image, (png_structrp png_ptr, png_bytepp image));
1398
#endif
1399
1400
/* Write a row of image data */
1401
PNG_EXPORT(58, void, png_write_row, (png_structrp png_ptr,
1402
png_const_bytep row));
1403
1404
/* Write a few rows of image data: (*row) is not written; however, the type
1405
* is declared as writeable to maintain compatibility with previous versions
1406
* of libpng and to allow the 'display_row' array from read_rows to be passed
1407
* unchanged to write_rows.
1408
*/
1409
PNG_EXPORT(59, void, png_write_rows, (png_structrp png_ptr, png_bytepp row,
1410
png_uint_32 num_rows));
1411
1412
/* Write the image data */
1413
PNG_EXPORT(60, void, png_write_image, (png_structrp png_ptr, png_bytepp image));
1414
1415
/* Write the end of the PNG file. */
1416
PNG_EXPORT(61, void, png_write_end, (png_structrp png_ptr,
1417
png_inforp info_ptr));
1418
1419
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
1420
/* Read the end of the PNG file. */
1421
PNG_EXPORT(62, void, png_read_end, (png_structrp png_ptr, png_inforp info_ptr));
1422
#endif
1423
1424
/* Free any memory associated with the png_info_struct */
1425
PNG_EXPORT(63, void, png_destroy_info_struct, (png_const_structrp png_ptr,
1426
png_infopp info_ptr_ptr));
1427
1428
/* Free any memory associated with the png_struct and the png_info_structs */
1429
PNG_EXPORT(64, void, png_destroy_read_struct, (png_structpp png_ptr_ptr,
1430
png_infopp info_ptr_ptr, png_infopp end_info_ptr_ptr));
1431
1432
/* Free any memory associated with the png_struct and the png_info_structs */
1433
PNG_EXPORT(65, void, png_destroy_write_struct, (png_structpp png_ptr_ptr,
1434
png_infopp info_ptr_ptr));
1435
1436
/* Set the libpng method of handling chunk CRC errors */
1437
PNG_EXPORT(66, void, png_set_crc_action, (png_structrp png_ptr, int crit_action,
1438
int ancil_action));
1439
1440
/* Values for png_set_crc_action() say how to handle CRC errors in
1441
* ancillary and critical chunks, and whether to use the data contained
1442
* therein. Note that it is impossible to "discard" data in a critical
1443
* chunk. For versions prior to 0.90, the action was always error/quit,
1444
* whereas in version 0.90 and later, the action for CRC errors in ancillary
1445
* chunks is warn/discard. These values should NOT be changed.
1446
*
1447
* value action:critical action:ancillary
1448
*/
1449
#define PNG_CRC_DEFAULT 0 /* error/quit warn/discard data */
1450
#define PNG_CRC_ERROR_QUIT 1 /* error/quit error/quit */
1451
#define PNG_CRC_WARN_DISCARD 2 /* (INVALID) warn/discard data */
1452
#define PNG_CRC_WARN_USE 3 /* warn/use data warn/use data */
1453
#define PNG_CRC_QUIET_USE 4 /* quiet/use data quiet/use data */
1454
#define PNG_CRC_NO_CHANGE 5 /* use current value use current value */
1455
1456
#ifdef PNG_WRITE_SUPPORTED
1457
/* These functions give the user control over the scan-line filtering in
1458
* libpng and the compression methods used by zlib. These functions are
1459
* mainly useful for testing, as the defaults should work with most users.
1460
* Those users who are tight on memory or want faster performance at the
1461
* expense of compression can modify them. See the compression library
1462
* header file (zlib.h) for an explanation of the compression functions.
1463
*/
1464
1465
/* Set the filtering method(s) used by libpng. Currently, the only valid
1466
* value for "method" is 0.
1467
*/
1468
PNG_EXPORT(67, void, png_set_filter, (png_structrp png_ptr, int method,
1469
int filters));
1470
#endif /* WRITE */
1471
1472
/* Flags for png_set_filter() to say which filters to use. The flags
1473
* are chosen so that they don't conflict with real filter types
1474
* below, in case they are supplied instead of the #defined constants.
1475
* These values should NOT be changed.
1476
*/
1477
#define PNG_NO_FILTERS 0x00
1478
#define PNG_FILTER_NONE 0x08
1479
#define PNG_FILTER_SUB 0x10
1480
#define PNG_FILTER_UP 0x20
1481
#define PNG_FILTER_AVG 0x40
1482
#define PNG_FILTER_PAETH 0x80
1483
#define PNG_FAST_FILTERS (PNG_FILTER_NONE | PNG_FILTER_SUB | PNG_FILTER_UP)
1484
#define PNG_ALL_FILTERS (PNG_FAST_FILTERS | PNG_FILTER_AVG | PNG_FILTER_PAETH)
1485
1486
/* Filter values (not flags) - used in pngwrite.c, pngwutil.c for now.
1487
* These defines should NOT be changed.
1488
*/
1489
#define PNG_FILTER_VALUE_NONE 0
1490
#define PNG_FILTER_VALUE_SUB 1
1491
#define PNG_FILTER_VALUE_UP 2
1492
#define PNG_FILTER_VALUE_AVG 3
1493
#define PNG_FILTER_VALUE_PAETH 4
1494
#define PNG_FILTER_VALUE_LAST 5
1495
1496
#ifdef PNG_WRITE_SUPPORTED
1497
#ifdef PNG_WRITE_WEIGHTED_FILTER_SUPPORTED /* DEPRECATED */
1498
PNG_FP_EXPORT(68, void, png_set_filter_heuristics, (png_structrp png_ptr,
1499
int heuristic_method, int num_weights, png_const_doublep filter_weights,
1500
png_const_doublep filter_costs))
1501
PNG_FIXED_EXPORT(209, void, png_set_filter_heuristics_fixed,
1502
(png_structrp png_ptr, int heuristic_method, int num_weights,
1503
png_const_fixed_point_p filter_weights,
1504
png_const_fixed_point_p filter_costs))
1505
#endif /* WRITE_WEIGHTED_FILTER */
1506
1507
/* The following are no longer used and will be removed from libpng-1.7: */
1508
#define PNG_FILTER_HEURISTIC_DEFAULT 0 /* Currently "UNWEIGHTED" */
1509
#define PNG_FILTER_HEURISTIC_UNWEIGHTED 1 /* Used by libpng < 0.95 */
1510
#define PNG_FILTER_HEURISTIC_WEIGHTED 2 /* Experimental feature */
1511
#define PNG_FILTER_HEURISTIC_LAST 3 /* Not a valid value */
1512
1513
/* Set the library compression level. Currently, valid values range from
1514
* 0 - 9, corresponding directly to the zlib compression levels 0 - 9
1515
* (0 - no compression, 9 - "maximal" compression). Note that tests have
1516
* shown that zlib compression levels 3-6 usually perform as well as level 9
1517
* for PNG images, and do considerably fewer calculations. In the future,
1518
* these values may not correspond directly to the zlib compression levels.
1519
*/
1520
#ifdef PNG_WRITE_CUSTOMIZE_COMPRESSION_SUPPORTED
1521
PNG_EXPORT(69, void, png_set_compression_level, (png_structrp png_ptr,
1522
int level));
1523
1524
PNG_EXPORT(70, void, png_set_compression_mem_level, (png_structrp png_ptr,
1525
int mem_level));
1526
1527
PNG_EXPORT(71, void, png_set_compression_strategy, (png_structrp png_ptr,
1528
int strategy));
1529
1530
/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1531
* smaller value of window_bits if it can do so safely.
1532
*/
1533
PNG_EXPORT(72, void, png_set_compression_window_bits, (png_structrp png_ptr,
1534
int window_bits));
1535
1536
PNG_EXPORT(73, void, png_set_compression_method, (png_structrp png_ptr,
1537
int method));
1538
#endif /* WRITE_CUSTOMIZE_COMPRESSION */
1539
1540
#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
1541
/* Also set zlib parameters for compressing non-IDAT chunks */
1542
PNG_EXPORT(222, void, png_set_text_compression_level, (png_structrp png_ptr,
1543
int level));
1544
1545
PNG_EXPORT(223, void, png_set_text_compression_mem_level, (png_structrp png_ptr,
1546
int mem_level));
1547
1548
PNG_EXPORT(224, void, png_set_text_compression_strategy, (png_structrp png_ptr,
1549
int strategy));
1550
1551
/* If PNG_WRITE_OPTIMIZE_CMF_SUPPORTED is defined, libpng will use a
1552
* smaller value of window_bits if it can do so safely.
1553
*/
1554
PNG_EXPORT(225, void, png_set_text_compression_window_bits,
1555
(png_structrp png_ptr, int window_bits));
1556
1557
PNG_EXPORT(226, void, png_set_text_compression_method, (png_structrp png_ptr,
1558
int method));
1559
#endif /* WRITE_CUSTOMIZE_ZTXT_COMPRESSION */
1560
#endif /* WRITE */
1561
1562
/* These next functions are called for input/output, memory, and error
1563
* handling. They are in the file pngrio.c, pngwio.c, and pngerror.c,
1564
* and call standard C I/O routines such as fread(), fwrite(), and
1565
* fprintf(). These functions can be made to use other I/O routines
1566
* at run time for those applications that need to handle I/O in a
1567
* different manner by calling png_set_???_fn(). See libpng-manual.txt for
1568
* more information.
1569
*/
1570
1571
#ifdef PNG_STDIO_SUPPORTED
1572
/* Initialize the input/output for the PNG file to the default functions. */
1573
PNG_EXPORT(74, void, png_init_io, (png_structrp png_ptr, FILE *fp));
1574
#endif
1575
1576
/* Replace the (error and abort), and warning functions with user
1577
* supplied functions. If no messages are to be printed you must still
1578
* write and use replacement functions. The replacement error_fn should
1579
* still do a longjmp to the last setjmp location if you are using this
1580
* method of error handling. If error_fn or warning_fn is NULL, the
1581
* default function will be used.
1582
*/
1583
1584
PNG_EXPORT(75, void, png_set_error_fn, (png_structrp png_ptr,
1585
png_voidp error_ptr, png_error_ptr error_fn, png_error_ptr warning_fn));
1586
1587
/* Return the user pointer associated with the error functions */
1588
PNG_EXPORT(76, png_voidp, png_get_error_ptr, (png_const_structrp png_ptr));
1589
1590
/* Replace the default data output functions with a user supplied one(s).
1591
* If buffered output is not used, then output_flush_fn can be set to NULL.
1592
* If PNG_WRITE_FLUSH_SUPPORTED is not defined at libpng compile time
1593
* output_flush_fn will be ignored (and thus can be NULL).
1594
* It is probably a mistake to use NULL for output_flush_fn if
1595
* write_data_fn is not also NULL unless you have built libpng with
1596
* PNG_WRITE_FLUSH_SUPPORTED undefined, because in this case libpng's
1597
* default flush function, which uses the standard *FILE structure, will
1598
* be used.
1599
*/
1600
PNG_EXPORT(77, void, png_set_write_fn, (png_structrp png_ptr, png_voidp io_ptr,
1601
png_rw_ptr write_data_fn, png_flush_ptr output_flush_fn));
1602
1603
/* Replace the default data input function with a user supplied one. */
1604
PNG_EXPORT(78, void, png_set_read_fn, (png_structrp png_ptr, png_voidp io_ptr,
1605
png_rw_ptr read_data_fn));
1606
1607
/* Return the user pointer associated with the I/O functions */
1608
PNG_EXPORT(79, png_voidp, png_get_io_ptr, (png_const_structrp png_ptr));
1609
1610
PNG_EXPORT(80, void, png_set_read_status_fn, (png_structrp png_ptr,
1611
png_read_status_ptr read_row_fn));
1612
1613
PNG_EXPORT(81, void, png_set_write_status_fn, (png_structrp png_ptr,
1614
png_write_status_ptr write_row_fn));
1615
1616
#ifdef PNG_USER_MEM_SUPPORTED
1617
/* Replace the default memory allocation functions with user supplied one(s). */
1618
PNG_EXPORT(82, void, png_set_mem_fn, (png_structrp png_ptr, png_voidp mem_ptr,
1619
png_malloc_ptr malloc_fn, png_free_ptr free_fn));
1620
/* Return the user pointer associated with the memory functions */
1621
PNG_EXPORT(83, png_voidp, png_get_mem_ptr, (png_const_structrp png_ptr));
1622
#endif
1623
1624
#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
1625
PNG_EXPORT(84, void, png_set_read_user_transform_fn, (png_structrp png_ptr,
1626
png_user_transform_ptr read_user_transform_fn));
1627
#endif
1628
1629
#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
1630
PNG_EXPORT(85, void, png_set_write_user_transform_fn, (png_structrp png_ptr,
1631
png_user_transform_ptr write_user_transform_fn));
1632
#endif
1633
1634
#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
1635
PNG_EXPORT(86, void, png_set_user_transform_info, (png_structrp png_ptr,
1636
png_voidp user_transform_ptr, int user_transform_depth,
1637
int user_transform_channels));
1638
/* Return the user pointer associated with the user transform functions */
1639
PNG_EXPORT(87, png_voidp, png_get_user_transform_ptr,
1640
(png_const_structrp png_ptr));
1641
#endif
1642
1643
#ifdef PNG_USER_TRANSFORM_INFO_SUPPORTED
1644
/* Return information about the row currently being processed. Note that these
1645
* APIs do not fail but will return unexpected results if called outside a user
1646
* transform callback. Also note that when transforming an interlaced image the
1647
* row number is the row number within the sub-image of the interlace pass, so
1648
* the value will increase to the height of the sub-image (not the full image)
1649
* then reset to 0 for the next pass.
1650
*
1651
* Use PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
1652
* find the output pixel (x,y) given an interlaced sub-image pixel
1653
* (row,col,pass). (See below for these macros.)
1654
*/
1655
PNG_EXPORT(217, png_uint_32, png_get_current_row_number, (png_const_structrp));
1656
PNG_EXPORT(218, png_byte, png_get_current_pass_number, (png_const_structrp));
1657
#endif
1658
1659
#ifdef PNG_READ_USER_CHUNKS_SUPPORTED
1660
/* This callback is called only for *unknown* chunks. If
1661
* PNG_HANDLE_AS_UNKNOWN_SUPPORTED is set then it is possible to set known
1662
* chunks to be treated as unknown, however in this case the callback must do
1663
* any processing required by the chunk (e.g. by calling the appropriate
1664
* png_set_ APIs.)
1665
*
1666
* There is no write support - on write, by default, all the chunks in the
1667
* 'unknown' list are written in the specified position.
1668
*
1669
* The integer return from the callback function is interpreted thus:
1670
*
1671
* negative: An error occurred; png_chunk_error will be called.
1672
* zero: The chunk was not handled, the chunk will be saved. A critical
1673
* chunk will cause an error at this point unless it is to be saved.
1674
* positive: The chunk was handled, libpng will ignore/discard it.
1675
*
1676
* See "INTERACTION WITH USER CHUNK CALLBACKS" below for important notes about
1677
* how this behavior will change in libpng 1.7
1678
*/
1679
PNG_EXPORT(88, void, png_set_read_user_chunk_fn, (png_structrp png_ptr,
1680
png_voidp user_chunk_ptr, png_user_chunk_ptr read_user_chunk_fn));
1681
#endif
1682
1683
#ifdef PNG_USER_CHUNKS_SUPPORTED
1684
PNG_EXPORT(89, png_voidp, png_get_user_chunk_ptr, (png_const_structrp png_ptr));
1685
#endif
1686
1687
#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
1688
/* Sets the function callbacks for the push reader, and a pointer to a
1689
* user-defined structure available to the callback functions.
1690
*/
1691
PNG_EXPORT(90, void, png_set_progressive_read_fn, (png_structrp png_ptr,
1692
png_voidp progressive_ptr, png_progressive_info_ptr info_fn,
1693
png_progressive_row_ptr row_fn, png_progressive_end_ptr end_fn));
1694
1695
/* Returns the user pointer associated with the push read functions */
1696
PNG_EXPORT(91, png_voidp, png_get_progressive_ptr,
1697
(png_const_structrp png_ptr));
1698
1699
/* Function to be called when data becomes available */
1700
PNG_EXPORT(92, void, png_process_data, (png_structrp png_ptr,
1701
png_inforp info_ptr, png_bytep buffer, size_t buffer_size));
1702
1703
/* A function which may be called *only* within png_process_data to stop the
1704
* processing of any more data. The function returns the number of bytes
1705
* remaining, excluding any that libpng has cached internally. A subsequent
1706
* call to png_process_data must supply these bytes again. If the argument
1707
* 'save' is set to true the routine will first save all the pending data and
1708
* will always return 0.
1709
*/
1710
PNG_EXPORT(219, size_t, png_process_data_pause, (png_structrp, int save));
1711
1712
/* A function which may be called *only* outside (after) a call to
1713
* png_process_data. It returns the number of bytes of data to skip in the
1714
* input. Normally it will return 0, but if it returns a non-zero value the
1715
* application must skip than number of bytes of input data and pass the
1716
* following data to the next call to png_process_data.
1717
*/
1718
PNG_EXPORT(220, png_uint_32, png_process_data_skip, (png_structrp));
1719
1720
/* Function that combines rows. 'new_row' is a flag that should come from
1721
* the callback and be non-NULL if anything needs to be done; the library
1722
* stores its own version of the new data internally and ignores the passed
1723
* in value.
1724
*/
1725
PNG_EXPORT(93, void, png_progressive_combine_row, (png_const_structrp png_ptr,
1726
png_bytep old_row, png_const_bytep new_row));
1727
#endif /* PROGRESSIVE_READ */
1728
1729
PNG_EXPORTA(94, png_voidp, png_malloc, (png_const_structrp png_ptr,
1730
png_alloc_size_t size), PNG_ALLOCATED);
1731
/* Added at libpng version 1.4.0 */
1732
PNG_EXPORTA(95, png_voidp, png_calloc, (png_const_structrp png_ptr,
1733
png_alloc_size_t size), PNG_ALLOCATED);
1734
1735
/* Added at libpng version 1.2.4 */
1736
PNG_EXPORTA(96, png_voidp, png_malloc_warn, (png_const_structrp png_ptr,
1737
png_alloc_size_t size), PNG_ALLOCATED);
1738
1739
/* Frees a pointer allocated by png_malloc() */
1740
PNG_EXPORT(97, void, png_free, (png_const_structrp png_ptr, png_voidp ptr));
1741
1742
/* Free data that was allocated internally */
1743
PNG_EXPORT(98, void, png_free_data, (png_const_structrp png_ptr,
1744
png_inforp info_ptr, png_uint_32 free_me, int num));
1745
1746
/* Reassign the responsibility for freeing existing data, whether allocated
1747
* by libpng or by the application; this works on the png_info structure passed
1748
* in, without changing the state for other png_info structures.
1749
*/
1750
PNG_EXPORT(99, void, png_data_freer, (png_const_structrp png_ptr,
1751
png_inforp info_ptr, int freer, png_uint_32 mask));
1752
1753
/* Assignments for png_data_freer */
1754
#define PNG_DESTROY_WILL_FREE_DATA 1
1755
#define PNG_SET_WILL_FREE_DATA 1
1756
#define PNG_USER_WILL_FREE_DATA 2
1757
/* Flags for png_ptr->free_me and info_ptr->free_me */
1758
#define PNG_FREE_HIST 0x0008U
1759
#define PNG_FREE_ICCP 0x0010U
1760
#define PNG_FREE_SPLT 0x0020U
1761
#define PNG_FREE_ROWS 0x0040U
1762
#define PNG_FREE_PCAL 0x0080U
1763
#define PNG_FREE_SCAL 0x0100U
1764
#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
1765
# define PNG_FREE_UNKN 0x0200U
1766
#endif
1767
/* PNG_FREE_LIST 0x0400U removed in 1.6.0 because it is ignored */
1768
#define PNG_FREE_PLTE 0x1000U
1769
#define PNG_FREE_TRNS 0x2000U
1770
#define PNG_FREE_TEXT 0x4000U
1771
#define PNG_FREE_EXIF 0x8000U /* Added at libpng-1.6.31 */
1772
#define PNG_FREE_ALL 0xffffU
1773
#define PNG_FREE_MUL 0x4220U /* PNG_FREE_SPLT|PNG_FREE_TEXT|PNG_FREE_UNKN */
1774
1775
#ifdef PNG_USER_MEM_SUPPORTED
1776
PNG_EXPORTA(100, png_voidp, png_malloc_default, (png_const_structrp png_ptr,
1777
png_alloc_size_t size), PNG_ALLOCATED PNG_DEPRECATED);
1778
PNG_EXPORTA(101, void, png_free_default, (png_const_structrp png_ptr,
1779
png_voidp ptr), PNG_DEPRECATED);
1780
#endif
1781
1782
#ifdef PNG_ERROR_TEXT_SUPPORTED
1783
/* Fatal error in PNG image of libpng - can't continue */
1784
PNG_EXPORTA(102, void, png_error, (png_const_structrp png_ptr,
1785
png_const_charp error_message), PNG_NORETURN);
1786
1787
/* The same, but the chunk name is prepended to the error string. */
1788
PNG_EXPORTA(103, void, png_chunk_error, (png_const_structrp png_ptr,
1789
png_const_charp error_message), PNG_NORETURN);
1790
1791
#else
1792
/* Fatal error in PNG image of libpng - can't continue */
1793
PNG_EXPORTA(104, void, png_err, (png_const_structrp png_ptr), PNG_NORETURN);
1794
# define png_error(s1,s2) png_err(s1)
1795
# define png_chunk_error(s1,s2) png_err(s1)
1796
#endif
1797
1798
#ifdef PNG_WARNINGS_SUPPORTED
1799
/* Non-fatal error in libpng. Can continue, but may have a problem. */
1800
PNG_EXPORT(105, void, png_warning, (png_const_structrp png_ptr,
1801
png_const_charp warning_message));
1802
1803
/* Non-fatal error in libpng, chunk name is prepended to message. */
1804
PNG_EXPORT(106, void, png_chunk_warning, (png_const_structrp png_ptr,
1805
png_const_charp warning_message));
1806
#else
1807
# define png_warning(s1,s2) ((void)(s1))
1808
# define png_chunk_warning(s1,s2) ((void)(s1))
1809
#endif
1810
1811
#ifdef PNG_BENIGN_ERRORS_SUPPORTED
1812
/* Benign error in libpng. Can continue, but may have a problem.
1813
* User can choose whether to handle as a fatal error or as a warning. */
1814
PNG_EXPORT(107, void, png_benign_error, (png_const_structrp png_ptr,
1815
png_const_charp warning_message));
1816
1817
#ifdef PNG_READ_SUPPORTED
1818
/* Same, chunk name is prepended to message (only during read) */
1819
PNG_EXPORT(108, void, png_chunk_benign_error, (png_const_structrp png_ptr,
1820
png_const_charp warning_message));
1821
#endif
1822
1823
PNG_EXPORT(109, void, png_set_benign_errors,
1824
(png_structrp png_ptr, int allowed));
1825
#else
1826
# ifdef PNG_ALLOW_BENIGN_ERRORS
1827
# define png_benign_error png_warning
1828
# define png_chunk_benign_error png_chunk_warning
1829
# else
1830
# define png_benign_error png_error
1831
# define png_chunk_benign_error png_chunk_error
1832
# endif
1833
#endif
1834
1835
/* The png_set_<chunk> functions are for storing values in the png_info_struct.
1836
* Similarly, the png_get_<chunk> calls are used to read values from the
1837
* png_info_struct, either storing the parameters in the passed variables, or
1838
* setting pointers into the png_info_struct where the data is stored. The
1839
* png_get_<chunk> functions return a non-zero value if the data was available
1840
* in info_ptr, or return zero and do not change any of the parameters if the
1841
* data was not available.
1842
*
1843
* These functions should be used instead of directly accessing png_info
1844
* to avoid problems with future changes in the size and internal layout of
1845
* png_info_struct.
1846
*/
1847
/* Returns "flag" if chunk data is valid in info_ptr. */
1848
PNG_EXPORT(110, png_uint_32, png_get_valid, (png_const_structrp png_ptr,
1849
png_const_inforp info_ptr, png_uint_32 flag));
1850
1851
/* Returns number of bytes needed to hold a transformed row. */
1852
PNG_EXPORT(111, size_t, png_get_rowbytes, (png_const_structrp png_ptr,
1853
png_const_inforp info_ptr));
1854
1855
#ifdef PNG_INFO_IMAGE_SUPPORTED
1856
/* Returns row_pointers, which is an array of pointers to scanlines that was
1857
* returned from png_read_png().
1858
*/
1859
PNG_EXPORT(112, png_bytepp, png_get_rows, (png_const_structrp png_ptr,
1860
png_const_inforp info_ptr));
1861
1862
/* Set row_pointers, which is an array of pointers to scanlines for use
1863
* by png_write_png().
1864
*/
1865
PNG_EXPORT(113, void, png_set_rows, (png_const_structrp png_ptr,
1866
png_inforp info_ptr, png_bytepp row_pointers));
1867
#endif
1868
1869
/* Returns number of color channels in image. */
1870
PNG_EXPORT(114, png_byte, png_get_channels, (png_const_structrp png_ptr,
1871
png_const_inforp info_ptr));
1872
1873
#ifdef PNG_EASY_ACCESS_SUPPORTED
1874
/* Returns image width in pixels. */
1875
PNG_EXPORT(115, png_uint_32, png_get_image_width, (png_const_structrp png_ptr,
1876
png_const_inforp info_ptr));
1877
1878
/* Returns image height in pixels. */
1879
PNG_EXPORT(116, png_uint_32, png_get_image_height, (png_const_structrp png_ptr,
1880
png_const_inforp info_ptr));
1881
1882
/* Returns image bit_depth. */
1883
PNG_EXPORT(117, png_byte, png_get_bit_depth, (png_const_structrp png_ptr,
1884
png_const_inforp info_ptr));
1885
1886
/* Returns image color_type. */
1887
PNG_EXPORT(118, png_byte, png_get_color_type, (png_const_structrp png_ptr,
1888
png_const_inforp info_ptr));
1889
1890
/* Returns image filter_type. */
1891
PNG_EXPORT(119, png_byte, png_get_filter_type, (png_const_structrp png_ptr,
1892
png_const_inforp info_ptr));
1893
1894
/* Returns image interlace_type. */
1895
PNG_EXPORT(120, png_byte, png_get_interlace_type, (png_const_structrp png_ptr,
1896
png_const_inforp info_ptr));
1897
1898
/* Returns image compression_type. */
1899
PNG_EXPORT(121, png_byte, png_get_compression_type, (png_const_structrp png_ptr,
1900
png_const_inforp info_ptr));
1901
1902
/* Returns image resolution in pixels per meter, from pHYs chunk data. */
1903
PNG_EXPORT(122, png_uint_32, png_get_pixels_per_meter,
1904
(png_const_structrp png_ptr, png_const_inforp info_ptr));
1905
PNG_EXPORT(123, png_uint_32, png_get_x_pixels_per_meter,
1906
(png_const_structrp png_ptr, png_const_inforp info_ptr));
1907
PNG_EXPORT(124, png_uint_32, png_get_y_pixels_per_meter,
1908
(png_const_structrp png_ptr, png_const_inforp info_ptr));
1909
1910
/* Returns pixel aspect ratio, computed from pHYs chunk data. */
1911
PNG_FP_EXPORT(125, float, png_get_pixel_aspect_ratio,
1912
(png_const_structrp png_ptr, png_const_inforp info_ptr))
1913
PNG_FIXED_EXPORT(210, png_fixed_point, png_get_pixel_aspect_ratio_fixed,
1914
(png_const_structrp png_ptr, png_const_inforp info_ptr))
1915
1916
/* Returns image x, y offset in pixels or microns, from oFFs chunk data. */
1917
PNG_EXPORT(126, png_int_32, png_get_x_offset_pixels,
1918
(png_const_structrp png_ptr, png_const_inforp info_ptr));
1919
PNG_EXPORT(127, png_int_32, png_get_y_offset_pixels,
1920
(png_const_structrp png_ptr, png_const_inforp info_ptr));
1921
PNG_EXPORT(128, png_int_32, png_get_x_offset_microns,
1922
(png_const_structrp png_ptr, png_const_inforp info_ptr));
1923
PNG_EXPORT(129, png_int_32, png_get_y_offset_microns,
1924
(png_const_structrp png_ptr, png_const_inforp info_ptr));
1925
1926
#endif /* EASY_ACCESS */
1927
1928
#ifdef PNG_READ_SUPPORTED
1929
/* Returns pointer to signature string read from PNG header */
1930
PNG_EXPORT(130, png_const_bytep, png_get_signature, (png_const_structrp png_ptr,
1931
png_const_inforp info_ptr));
1932
#endif
1933
1934
#ifdef PNG_bKGD_SUPPORTED
1935
PNG_EXPORT(131, png_uint_32, png_get_bKGD, (png_const_structrp png_ptr,
1936
png_inforp info_ptr, png_color_16p *background));
1937
#endif
1938
1939
#ifdef PNG_bKGD_SUPPORTED
1940
PNG_EXPORT(132, void, png_set_bKGD, (png_const_structrp png_ptr,
1941
png_inforp info_ptr, png_const_color_16p background));
1942
#endif
1943
1944
#ifdef PNG_cHRM_SUPPORTED
1945
PNG_FP_EXPORT(133, png_uint_32, png_get_cHRM, (png_const_structrp png_ptr,
1946
png_const_inforp info_ptr, double *white_x, double *white_y, double *red_x,
1947
double *red_y, double *green_x, double *green_y, double *blue_x,
1948
double *blue_y))
1949
PNG_FP_EXPORT(230, png_uint_32, png_get_cHRM_XYZ, (png_const_structrp png_ptr,
1950
png_const_inforp info_ptr, double *red_X, double *red_Y, double *red_Z,
1951
double *green_X, double *green_Y, double *green_Z, double *blue_X,
1952
double *blue_Y, double *blue_Z))
1953
PNG_FIXED_EXPORT(134, png_uint_32, png_get_cHRM_fixed,
1954
(png_const_structrp png_ptr, png_const_inforp info_ptr,
1955
png_fixed_point *int_white_x, png_fixed_point *int_white_y,
1956
png_fixed_point *int_red_x, png_fixed_point *int_red_y,
1957
png_fixed_point *int_green_x, png_fixed_point *int_green_y,
1958
png_fixed_point *int_blue_x, png_fixed_point *int_blue_y))
1959
PNG_FIXED_EXPORT(231, png_uint_32, png_get_cHRM_XYZ_fixed,
1960
(png_const_structrp png_ptr, png_const_inforp info_ptr,
1961
png_fixed_point *int_red_X, png_fixed_point *int_red_Y,
1962
png_fixed_point *int_red_Z, png_fixed_point *int_green_X,
1963
png_fixed_point *int_green_Y, png_fixed_point *int_green_Z,
1964
png_fixed_point *int_blue_X, png_fixed_point *int_blue_Y,
1965
png_fixed_point *int_blue_Z))
1966
#endif
1967
1968
#ifdef PNG_cHRM_SUPPORTED
1969
PNG_FP_EXPORT(135, void, png_set_cHRM, (png_const_structrp png_ptr,
1970
png_inforp info_ptr,
1971
double white_x, double white_y, double red_x, double red_y, double green_x,
1972
double green_y, double blue_x, double blue_y))
1973
PNG_FP_EXPORT(232, void, png_set_cHRM_XYZ, (png_const_structrp png_ptr,
1974
png_inforp info_ptr, double red_X, double red_Y, double red_Z,
1975
double green_X, double green_Y, double green_Z, double blue_X,
1976
double blue_Y, double blue_Z))
1977
PNG_FIXED_EXPORT(136, void, png_set_cHRM_fixed, (png_const_structrp png_ptr,
1978
png_inforp info_ptr, png_fixed_point int_white_x,
1979
png_fixed_point int_white_y, png_fixed_point int_red_x,
1980
png_fixed_point int_red_y, png_fixed_point int_green_x,
1981
png_fixed_point int_green_y, png_fixed_point int_blue_x,
1982
png_fixed_point int_blue_y))
1983
PNG_FIXED_EXPORT(233, void, png_set_cHRM_XYZ_fixed, (png_const_structrp png_ptr,
1984
png_inforp info_ptr, png_fixed_point int_red_X, png_fixed_point int_red_Y,
1985
png_fixed_point int_red_Z, png_fixed_point int_green_X,
1986
png_fixed_point int_green_Y, png_fixed_point int_green_Z,
1987
png_fixed_point int_blue_X, png_fixed_point int_blue_Y,
1988
png_fixed_point int_blue_Z))
1989
#endif
1990
1991
#ifdef PNG_cICP_SUPPORTED
1992
PNG_EXPORT(250, png_uint_32, png_get_cICP, (png_const_structrp png_ptr,
1993
png_const_inforp info_ptr, png_bytep colour_primaries,
1994
png_bytep transfer_function, png_bytep matrix_coefficients,
1995
png_bytep video_full_range_flag));
1996
#endif
1997
1998
#ifdef PNG_cICP_SUPPORTED
1999
PNG_EXPORT(251, void, png_set_cICP, (png_const_structrp png_ptr,
2000
png_inforp info_ptr, png_byte colour_primaries,
2001
png_byte transfer_function, png_byte matrix_coefficients,
2002
png_byte video_full_range_flag));
2003
#endif
2004
2005
#ifdef PNG_cLLI_SUPPORTED
2006
PNG_FP_EXPORT(252, png_uint_32, png_get_cLLI, (png_const_structrp png_ptr,
2007
png_const_inforp info_ptr, double *maximum_content_light_level,
2008
double *maximum_frame_average_light_level))
2009
PNG_FIXED_EXPORT(253, png_uint_32, png_get_cLLI_fixed,
2010
(png_const_structrp png_ptr, png_const_inforp info_ptr,
2011
/* The values below are in cd/m2 (nits) and are scaled by 10,000; not
2012
* 100,000 as in the case of png_fixed_point.
2013
*/
2014
png_uint_32p maximum_content_light_level_scaled_by_10000,
2015
png_uint_32p maximum_frame_average_light_level_scaled_by_10000))
2016
#endif
2017
2018
#ifdef PNG_cLLI_SUPPORTED
2019
PNG_FP_EXPORT(254, void, png_set_cLLI, (png_const_structrp png_ptr,
2020
png_inforp info_ptr, double maximum_content_light_level,
2021
double maximum_frame_average_light_level))
2022
PNG_FIXED_EXPORT(255, void, png_set_cLLI_fixed, (png_const_structrp png_ptr,
2023
png_inforp info_ptr,
2024
/* The values below are in cd/m2 (nits) and are scaled by 10,000; not
2025
* 100,000 as in the case of png_fixed_point.
2026
*/
2027
png_uint_32 maximum_content_light_level_scaled_by_10000,
2028
png_uint_32 maximum_frame_average_light_level_scaled_by_10000))
2029
#endif
2030
2031
#ifdef PNG_eXIf_SUPPORTED
2032
PNG_EXPORT(246, png_uint_32, png_get_eXIf, (png_const_structrp png_ptr,
2033
png_inforp info_ptr, png_bytep *exif));
2034
PNG_EXPORT(247, void, png_set_eXIf, (png_const_structrp png_ptr,
2035
png_inforp info_ptr, png_bytep exif));
2036
2037
PNG_EXPORT(248, png_uint_32, png_get_eXIf_1, (png_const_structrp png_ptr,
2038
png_const_inforp info_ptr, png_uint_32 *num_exif, png_bytep *exif));
2039
PNG_EXPORT(249, void, png_set_eXIf_1, (png_const_structrp png_ptr,
2040
png_inforp info_ptr, png_uint_32 num_exif, png_bytep exif));
2041
#endif
2042
2043
#ifdef PNG_gAMA_SUPPORTED
2044
PNG_FP_EXPORT(137, png_uint_32, png_get_gAMA, (png_const_structrp png_ptr,
2045
png_const_inforp info_ptr, double *file_gamma))
2046
PNG_FIXED_EXPORT(138, png_uint_32, png_get_gAMA_fixed,
2047
(png_const_structrp png_ptr, png_const_inforp info_ptr,
2048
png_fixed_point *int_file_gamma))
2049
#endif
2050
2051
#ifdef PNG_gAMA_SUPPORTED
2052
PNG_FP_EXPORT(139, void, png_set_gAMA, (png_const_structrp png_ptr,
2053
png_inforp info_ptr, double file_gamma))
2054
PNG_FIXED_EXPORT(140, void, png_set_gAMA_fixed, (png_const_structrp png_ptr,
2055
png_inforp info_ptr, png_fixed_point int_file_gamma))
2056
#endif
2057
2058
#ifdef PNG_hIST_SUPPORTED
2059
PNG_EXPORT(141, png_uint_32, png_get_hIST, (png_const_structrp png_ptr,
2060
png_inforp info_ptr, png_uint_16p *hist));
2061
PNG_EXPORT(142, void, png_set_hIST, (png_const_structrp png_ptr,
2062
png_inforp info_ptr, png_const_uint_16p hist));
2063
#endif
2064
2065
PNG_EXPORT(143, png_uint_32, png_get_IHDR, (png_const_structrp png_ptr,
2066
png_const_inforp info_ptr, png_uint_32 *width, png_uint_32 *height,
2067
int *bit_depth, int *color_type, int *interlace_method,
2068
int *compression_method, int *filter_method));
2069
2070
PNG_EXPORT(144, void, png_set_IHDR, (png_const_structrp png_ptr,
2071
png_inforp info_ptr, png_uint_32 width, png_uint_32 height, int bit_depth,
2072
int color_type, int interlace_method, int compression_method,
2073
int filter_method));
2074
2075
#ifdef PNG_mDCV_SUPPORTED
2076
PNG_FP_EXPORT(256, png_uint_32, png_get_mDCV, (png_const_structrp png_ptr,
2077
png_const_inforp info_ptr,
2078
/* The chromaticities of the mastering display. As cHRM, but independent of
2079
* the encoding endpoints in cHRM, or cICP, or iCCP. These values will
2080
* always be in the range 0 to 1.3107.
2081
*/
2082
double *white_x, double *white_y, double *red_x, double *red_y,
2083
double *green_x, double *green_y, double *blue_x, double *blue_y,
2084
/* Mastering display luminance in cd/m2 (nits). */
2085
double *mastering_display_maximum_luminance,
2086
double *mastering_display_minimum_luminance))
2087
2088
PNG_FIXED_EXPORT(257, png_uint_32, png_get_mDCV_fixed,
2089
(png_const_structrp png_ptr, png_const_inforp info_ptr,
2090
png_fixed_point *int_white_x, png_fixed_point *int_white_y,
2091
png_fixed_point *int_red_x, png_fixed_point *int_red_y,
2092
png_fixed_point *int_green_x, png_fixed_point *int_green_y,
2093
png_fixed_point *int_blue_x, png_fixed_point *int_blue_y,
2094
/* Mastering display luminance in cd/m2 (nits) multiplied (scaled) by
2095
* 10,000.
2096
*/
2097
png_uint_32p mastering_display_maximum_luminance_scaled_by_10000,
2098
png_uint_32p mastering_display_minimum_luminance_scaled_by_10000))
2099
#endif
2100
2101
#ifdef PNG_mDCV_SUPPORTED
2102
PNG_FP_EXPORT(258, void, png_set_mDCV, (png_const_structrp png_ptr,
2103
png_inforp info_ptr,
2104
/* The chromaticities of the mastering display. As cHRM, but independent of
2105
* the encoding endpoints in cHRM, or cICP, or iCCP.
2106
*/
2107
double white_x, double white_y, double red_x, double red_y, double green_x,
2108
double green_y, double blue_x, double blue_y,
2109
/* Mastering display luminance in cd/m2 (nits). */
2110
double mastering_display_maximum_luminance,
2111
double mastering_display_minimum_luminance))
2112
2113
PNG_FIXED_EXPORT(259, void, png_set_mDCV_fixed, (png_const_structrp png_ptr,
2114
png_inforp info_ptr,
2115
/* The admissible range of these values is not the full range of a PNG
2116
* fixed point value. Negative values cannot be encoded and the maximum
2117
* value is about 1.3 */
2118
png_fixed_point int_white_x, png_fixed_point int_white_y,
2119
png_fixed_point int_red_x, png_fixed_point int_red_y,
2120
png_fixed_point int_green_x, png_fixed_point int_green_y,
2121
png_fixed_point int_blue_x, png_fixed_point int_blue_y,
2122
/* These are PNG unsigned 4 byte values: 31-bit unsigned values. The MSB
2123
* must be zero.
2124
*/
2125
png_uint_32 mastering_display_maximum_luminance_scaled_by_10000,
2126
png_uint_32 mastering_display_minimum_luminance_scaled_by_10000))
2127
#endif
2128
2129
#ifdef PNG_oFFs_SUPPORTED
2130
PNG_EXPORT(145, png_uint_32, png_get_oFFs, (png_const_structrp png_ptr,
2131
png_const_inforp info_ptr, png_int_32 *offset_x, png_int_32 *offset_y,
2132
int *unit_type));
2133
#endif
2134
2135
#ifdef PNG_oFFs_SUPPORTED
2136
PNG_EXPORT(146, void, png_set_oFFs, (png_const_structrp png_ptr,
2137
png_inforp info_ptr, png_int_32 offset_x, png_int_32 offset_y,
2138
int unit_type));
2139
#endif
2140
2141
#ifdef PNG_pCAL_SUPPORTED
2142
PNG_EXPORT(147, png_uint_32, png_get_pCAL, (png_const_structrp png_ptr,
2143
png_inforp info_ptr, png_charp *purpose, png_int_32 *X0,
2144
png_int_32 *X1, int *type, int *nparams, png_charp *units,
2145
png_charpp *params));
2146
#endif
2147
2148
#ifdef PNG_pCAL_SUPPORTED
2149
PNG_EXPORT(148, void, png_set_pCAL, (png_const_structrp png_ptr,
2150
png_inforp info_ptr, png_const_charp purpose, png_int_32 X0, png_int_32 X1,
2151
int type, int nparams, png_const_charp units, png_charpp params));
2152
#endif
2153
2154
#ifdef PNG_pHYs_SUPPORTED
2155
PNG_EXPORT(149, png_uint_32, png_get_pHYs, (png_const_structrp png_ptr,
2156
png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2157
int *unit_type));
2158
#endif
2159
2160
#ifdef PNG_pHYs_SUPPORTED
2161
PNG_EXPORT(150, void, png_set_pHYs, (png_const_structrp png_ptr,
2162
png_inforp info_ptr, png_uint_32 res_x, png_uint_32 res_y, int unit_type));
2163
#endif
2164
2165
PNG_EXPORT(151, png_uint_32, png_get_PLTE, (png_const_structrp png_ptr,
2166
png_inforp info_ptr, png_colorp *palette, int *num_palette));
2167
2168
PNG_EXPORT(152, void, png_set_PLTE, (png_structrp png_ptr,
2169
png_inforp info_ptr, png_const_colorp palette, int num_palette));
2170
2171
#ifdef PNG_sBIT_SUPPORTED
2172
PNG_EXPORT(153, png_uint_32, png_get_sBIT, (png_const_structrp png_ptr,
2173
png_inforp info_ptr, png_color_8p *sig_bit));
2174
#endif
2175
2176
#ifdef PNG_sBIT_SUPPORTED
2177
PNG_EXPORT(154, void, png_set_sBIT, (png_const_structrp png_ptr,
2178
png_inforp info_ptr, png_const_color_8p sig_bit));
2179
#endif
2180
2181
#ifdef PNG_sRGB_SUPPORTED
2182
PNG_EXPORT(155, png_uint_32, png_get_sRGB, (png_const_structrp png_ptr,
2183
png_const_inforp info_ptr, int *file_srgb_intent));
2184
#endif
2185
2186
#ifdef PNG_sRGB_SUPPORTED
2187
PNG_EXPORT(156, void, png_set_sRGB, (png_const_structrp png_ptr,
2188
png_inforp info_ptr, int srgb_intent));
2189
PNG_EXPORT(157, void, png_set_sRGB_gAMA_and_cHRM, (png_const_structrp png_ptr,
2190
png_inforp info_ptr, int srgb_intent));
2191
#endif
2192
2193
#ifdef PNG_iCCP_SUPPORTED
2194
PNG_EXPORT(158, png_uint_32, png_get_iCCP, (png_const_structrp png_ptr,
2195
png_inforp info_ptr, png_charpp name, int *compression_type,
2196
png_bytepp profile, png_uint_32 *proflen));
2197
#endif
2198
2199
#ifdef PNG_iCCP_SUPPORTED
2200
PNG_EXPORT(159, void, png_set_iCCP, (png_const_structrp png_ptr,
2201
png_inforp info_ptr, png_const_charp name, int compression_type,
2202
png_const_bytep profile, png_uint_32 proflen));
2203
#endif
2204
2205
#ifdef PNG_sPLT_SUPPORTED
2206
PNG_EXPORT(160, int, png_get_sPLT, (png_const_structrp png_ptr,
2207
png_inforp info_ptr, png_sPLT_tpp entries));
2208
#endif
2209
2210
#ifdef PNG_sPLT_SUPPORTED
2211
PNG_EXPORT(161, void, png_set_sPLT, (png_const_structrp png_ptr,
2212
png_inforp info_ptr, png_const_sPLT_tp entries, int nentries));
2213
#endif
2214
2215
#ifdef PNG_TEXT_SUPPORTED
2216
/* png_get_text also returns the number of text chunks in *num_text */
2217
PNG_EXPORT(162, int, png_get_text, (png_const_structrp png_ptr,
2218
png_inforp info_ptr, png_textp *text_ptr, int *num_text));
2219
#endif
2220
2221
/* Note while png_set_text() will accept a structure whose text,
2222
* language, and translated keywords are NULL pointers, the structure
2223
* returned by png_get_text will always contain regular
2224
* zero-terminated C strings. They might be empty strings but
2225
* they will never be NULL pointers.
2226
*/
2227
2228
#ifdef PNG_TEXT_SUPPORTED
2229
PNG_EXPORT(163, void, png_set_text, (png_const_structrp png_ptr,
2230
png_inforp info_ptr, png_const_textp text_ptr, int num_text));
2231
#endif
2232
2233
#ifdef PNG_tIME_SUPPORTED
2234
PNG_EXPORT(164, png_uint_32, png_get_tIME, (png_const_structrp png_ptr,
2235
png_inforp info_ptr, png_timep *mod_time));
2236
#endif
2237
2238
#ifdef PNG_tIME_SUPPORTED
2239
PNG_EXPORT(165, void, png_set_tIME, (png_const_structrp png_ptr,
2240
png_inforp info_ptr, png_const_timep mod_time));
2241
#endif
2242
2243
#ifdef PNG_tRNS_SUPPORTED
2244
PNG_EXPORT(166, png_uint_32, png_get_tRNS, (png_const_structrp png_ptr,
2245
png_inforp info_ptr, png_bytep *trans_alpha, int *num_trans,
2246
png_color_16p *trans_color));
2247
#endif
2248
2249
#ifdef PNG_tRNS_SUPPORTED
2250
PNG_EXPORT(167, void, png_set_tRNS, (png_structrp png_ptr,
2251
png_inforp info_ptr, png_const_bytep trans_alpha, int num_trans,
2252
png_const_color_16p trans_color));
2253
#endif
2254
2255
#ifdef PNG_sCAL_SUPPORTED
2256
PNG_FP_EXPORT(168, png_uint_32, png_get_sCAL, (png_const_structrp png_ptr,
2257
png_const_inforp info_ptr, int *unit, double *width, double *height))
2258
#if defined(PNG_FLOATING_ARITHMETIC_SUPPORTED) || \
2259
defined(PNG_FLOATING_POINT_SUPPORTED)
2260
/* NOTE: this API is currently implemented using floating point arithmetic,
2261
* consequently it can only be used on systems with floating point support.
2262
* In any case the range of values supported by png_fixed_point is small and it
2263
* is highly recommended that png_get_sCAL_s be used instead.
2264
*/
2265
PNG_FIXED_EXPORT(214, png_uint_32, png_get_sCAL_fixed,
2266
(png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
2267
png_fixed_point *width, png_fixed_point *height))
2268
#endif
2269
PNG_EXPORT(169, png_uint_32, png_get_sCAL_s,
2270
(png_const_structrp png_ptr, png_const_inforp info_ptr, int *unit,
2271
png_charpp swidth, png_charpp sheight));
2272
2273
PNG_FP_EXPORT(170, void, png_set_sCAL, (png_const_structrp png_ptr,
2274
png_inforp info_ptr, int unit, double width, double height))
2275
PNG_FIXED_EXPORT(213, void, png_set_sCAL_fixed, (png_const_structrp png_ptr,
2276
png_inforp info_ptr, int unit, png_fixed_point width,
2277
png_fixed_point height))
2278
PNG_EXPORT(171, void, png_set_sCAL_s, (png_const_structrp png_ptr,
2279
png_inforp info_ptr, int unit,
2280
png_const_charp swidth, png_const_charp sheight));
2281
#endif /* sCAL */
2282
2283
#ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED
2284
/* Provide the default handling for all unknown chunks or, optionally, for
2285
* specific unknown chunks.
2286
*
2287
* NOTE: prior to 1.6.0 the handling specified for particular chunks on read was
2288
* ignored and the default was used, the per-chunk setting only had an effect on
2289
* write. If you wish to have chunk-specific handling on read in code that must
2290
* work on earlier versions you must use a user chunk callback to specify the
2291
* desired handling (keep or discard.)
2292
*
2293
* The 'keep' parameter is a PNG_HANDLE_CHUNK_ value as listed below. The
2294
* parameter is interpreted as follows:
2295
*
2296
* READ:
2297
* PNG_HANDLE_CHUNK_AS_DEFAULT:
2298
* Known chunks: do normal libpng processing, do not keep the chunk (but
2299
* see the comments below about PNG_HANDLE_AS_UNKNOWN_SUPPORTED)
2300
* Unknown chunks: for a specific chunk use the global default, when used
2301
* as the default discard the chunk data.
2302
* PNG_HANDLE_CHUNK_NEVER:
2303
* Discard the chunk data.
2304
* PNG_HANDLE_CHUNK_IF_SAFE:
2305
* Keep the chunk data if the chunk is not critical else raise a chunk
2306
* error.
2307
* PNG_HANDLE_CHUNK_ALWAYS:
2308
* Keep the chunk data.
2309
*
2310
* If the chunk data is saved it can be retrieved using png_get_unknown_chunks,
2311
* below. Notice that specifying "AS_DEFAULT" as a global default is equivalent
2312
* to specifying "NEVER", however when "AS_DEFAULT" is used for specific chunks
2313
* it simply resets the behavior to the libpng default.
2314
*
2315
* INTERACTION WITH USER CHUNK CALLBACKS:
2316
* The per-chunk handling is always used when there is a png_user_chunk_ptr
2317
* callback and the callback returns 0; the chunk is then always stored *unless*
2318
* it is critical and the per-chunk setting is other than ALWAYS. Notice that
2319
* the global default is *not* used in this case. (In effect the per-chunk
2320
* value is incremented to at least IF_SAFE.)
2321
*
2322
* IMPORTANT NOTE: this behavior will change in libpng 1.7 - the global and
2323
* per-chunk defaults will be honored. If you want to preserve the current
2324
* behavior when your callback returns 0 you must set PNG_HANDLE_CHUNK_IF_SAFE
2325
* as the default - if you don't do this libpng 1.6 will issue a warning.
2326
*
2327
* If you want unhandled unknown chunks to be discarded in libpng 1.6 and
2328
* earlier simply return '1' (handled).
2329
*
2330
* PNG_HANDLE_AS_UNKNOWN_SUPPORTED:
2331
* If this is *not* set known chunks will always be handled by libpng and
2332
* will never be stored in the unknown chunk list. Known chunks listed to
2333
* png_set_keep_unknown_chunks will have no effect. If it is set then known
2334
* chunks listed with a keep other than AS_DEFAULT will *never* be processed
2335
* by libpng, in addition critical chunks must either be processed by the
2336
* callback or saved.
2337
*
2338
* The IHDR and IEND chunks must not be listed. Because this turns off the
2339
* default handling for chunks that would otherwise be recognized the
2340
* behavior of libpng transformations may well become incorrect!
2341
*
2342
* WRITE:
2343
* When writing chunks the options only apply to the chunks specified by
2344
* png_set_unknown_chunks (below), libpng will *always* write known chunks
2345
* required by png_set_ calls and will always write the core critical chunks
2346
* (as required for PLTE).
2347
*
2348
* Each chunk in the png_set_unknown_chunks list is looked up in the
2349
* png_set_keep_unknown_chunks list to find the keep setting, this is then
2350
* interpreted as follows:
2351
*
2352
* PNG_HANDLE_CHUNK_AS_DEFAULT:
2353
* Write safe-to-copy chunks and write other chunks if the global
2354
* default is set to _ALWAYS, otherwise don't write this chunk.
2355
* PNG_HANDLE_CHUNK_NEVER:
2356
* Do not write the chunk.
2357
* PNG_HANDLE_CHUNK_IF_SAFE:
2358
* Write the chunk if it is safe-to-copy, otherwise do not write it.
2359
* PNG_HANDLE_CHUNK_ALWAYS:
2360
* Write the chunk.
2361
*
2362
* Note that the default behavior is effectively the opposite of the read case -
2363
* in read unknown chunks are not stored by default, in write they are written
2364
* by default. Also the behavior of PNG_HANDLE_CHUNK_IF_SAFE is very different
2365
* - on write the safe-to-copy bit is checked, on read the critical bit is
2366
* checked and on read if the chunk is critical an error will be raised.
2367
*
2368
* num_chunks:
2369
* ===========
2370
* If num_chunks is positive, then the "keep" parameter specifies the manner
2371
* for handling only those chunks appearing in the chunk_list array,
2372
* otherwise the chunk list array is ignored.
2373
*
2374
* If num_chunks is 0 the "keep" parameter specifies the default behavior for
2375
* unknown chunks, as described above.
2376
*
2377
* If num_chunks is negative, then the "keep" parameter specifies the manner
2378
* for handling all unknown chunks plus all chunks recognized by libpng
2379
* except for the IHDR, PLTE, tRNS, IDAT, and IEND chunks (which continue to
2380
* be processed by libpng.
2381
*/
2382
#ifdef PNG_HANDLE_AS_UNKNOWN_SUPPORTED
2383
PNG_EXPORT(172, void, png_set_keep_unknown_chunks, (png_structrp png_ptr,
2384
int keep, png_const_bytep chunk_list, int num_chunks));
2385
#endif /* HANDLE_AS_UNKNOWN */
2386
2387
/* The "keep" PNG_HANDLE_CHUNK_ parameter for the specified chunk is returned;
2388
* the result is therefore true (non-zero) if special handling is required,
2389
* false for the default handling.
2390
*/
2391
PNG_EXPORT(173, int, png_handle_as_unknown, (png_const_structrp png_ptr,
2392
png_const_bytep chunk_name));
2393
#endif /* SET_UNKNOWN_CHUNKS */
2394
2395
#ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED
2396
PNG_EXPORT(174, void, png_set_unknown_chunks, (png_const_structrp png_ptr,
2397
png_inforp info_ptr, png_const_unknown_chunkp unknowns,
2398
int num_unknowns));
2399
/* NOTE: prior to 1.6.0 this routine set the 'location' field of the added
2400
* unknowns to the location currently stored in the png_struct. This is
2401
* invariably the wrong value on write. To fix this call the following API
2402
* for each chunk in the list with the correct location. If you know your
2403
* code won't be compiled on earlier versions you can rely on
2404
* png_set_unknown_chunks(write-ptr, png_get_unknown_chunks(read-ptr)) doing
2405
* the correct thing.
2406
*/
2407
2408
PNG_EXPORT(175, void, png_set_unknown_chunk_location,
2409
(png_const_structrp png_ptr, png_inforp info_ptr, int chunk, int location));
2410
2411
PNG_EXPORT(176, int, png_get_unknown_chunks, (png_const_structrp png_ptr,
2412
png_inforp info_ptr, png_unknown_chunkpp entries));
2413
#endif
2414
2415
/* Png_free_data() will turn off the "valid" flag for anything it frees.
2416
* If you need to turn it off for a chunk that your application has freed,
2417
* you can use png_set_invalid(png_ptr, info_ptr, PNG_INFO_CHNK);
2418
*/
2419
PNG_EXPORT(177, void, png_set_invalid, (png_const_structrp png_ptr,
2420
png_inforp info_ptr, int mask));
2421
2422
#ifdef PNG_INFO_IMAGE_SUPPORTED
2423
/* The "params" pointer is currently not used and is for future expansion. */
2424
#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
2425
PNG_EXPORT(178, void, png_read_png, (png_structrp png_ptr, png_inforp info_ptr,
2426
int transforms, png_voidp params));
2427
#endif
2428
#ifdef PNG_WRITE_SUPPORTED
2429
PNG_EXPORT(179, void, png_write_png, (png_structrp png_ptr, png_inforp info_ptr,
2430
int transforms, png_voidp params));
2431
#endif
2432
#endif
2433
2434
PNG_EXPORT(180, png_const_charp, png_get_copyright,
2435
(png_const_structrp png_ptr));
2436
PNG_EXPORT(181, png_const_charp, png_get_header_ver,
2437
(png_const_structrp png_ptr));
2438
PNG_EXPORT(182, png_const_charp, png_get_header_version,
2439
(png_const_structrp png_ptr));
2440
PNG_EXPORT(183, png_const_charp, png_get_libpng_ver,
2441
(png_const_structrp png_ptr));
2442
2443
#ifdef PNG_MNG_FEATURES_SUPPORTED
2444
PNG_EXPORT(184, png_uint_32, png_permit_mng_features, (png_structrp png_ptr,
2445
png_uint_32 mng_features_permitted));
2446
#endif
2447
2448
/* For use in png_set_keep_unknown, added to version 1.2.6 */
2449
#define PNG_HANDLE_CHUNK_AS_DEFAULT 0
2450
#define PNG_HANDLE_CHUNK_NEVER 1
2451
#define PNG_HANDLE_CHUNK_IF_SAFE 2
2452
#define PNG_HANDLE_CHUNK_ALWAYS 3
2453
#define PNG_HANDLE_CHUNK_LAST 4
2454
2455
/* Strip the prepended error numbers ("#nnn ") from error and warning
2456
* messages before passing them to the error or warning handler.
2457
*/
2458
#ifdef PNG_ERROR_NUMBERS_SUPPORTED
2459
PNG_EXPORT(185, void, png_set_strip_error_numbers, (png_structrp png_ptr,
2460
png_uint_32 strip_mode));
2461
#endif
2462
2463
/* Added in libpng-1.2.6 */
2464
#ifdef PNG_SET_USER_LIMITS_SUPPORTED
2465
PNG_EXPORT(186, void, png_set_user_limits, (png_structrp png_ptr,
2466
png_uint_32 user_width_max, png_uint_32 user_height_max));
2467
PNG_EXPORT(187, png_uint_32, png_get_user_width_max,
2468
(png_const_structrp png_ptr));
2469
PNG_EXPORT(188, png_uint_32, png_get_user_height_max,
2470
(png_const_structrp png_ptr));
2471
/* Added in libpng-1.4.0 */
2472
PNG_EXPORT(189, void, png_set_chunk_cache_max, (png_structrp png_ptr,
2473
png_uint_32 user_chunk_cache_max));
2474
PNG_EXPORT(190, png_uint_32, png_get_chunk_cache_max,
2475
(png_const_structrp png_ptr));
2476
/* Added in libpng-1.4.1 */
2477
PNG_EXPORT(191, void, png_set_chunk_malloc_max, (png_structrp png_ptr,
2478
png_alloc_size_t user_chunk_cache_max));
2479
PNG_EXPORT(192, png_alloc_size_t, png_get_chunk_malloc_max,
2480
(png_const_structrp png_ptr));
2481
#endif
2482
2483
#if defined(PNG_INCH_CONVERSIONS_SUPPORTED)
2484
PNG_EXPORT(193, png_uint_32, png_get_pixels_per_inch,
2485
(png_const_structrp png_ptr, png_const_inforp info_ptr));
2486
2487
PNG_EXPORT(194, png_uint_32, png_get_x_pixels_per_inch,
2488
(png_const_structrp png_ptr, png_const_inforp info_ptr));
2489
2490
PNG_EXPORT(195, png_uint_32, png_get_y_pixels_per_inch,
2491
(png_const_structrp png_ptr, png_const_inforp info_ptr));
2492
2493
PNG_FP_EXPORT(196, float, png_get_x_offset_inches,
2494
(png_const_structrp png_ptr, png_const_inforp info_ptr))
2495
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2496
PNG_FIXED_EXPORT(211, png_fixed_point, png_get_x_offset_inches_fixed,
2497
(png_const_structrp png_ptr, png_const_inforp info_ptr))
2498
#endif
2499
2500
PNG_FP_EXPORT(197, float, png_get_y_offset_inches, (png_const_structrp png_ptr,
2501
png_const_inforp info_ptr))
2502
#ifdef PNG_FIXED_POINT_SUPPORTED /* otherwise not implemented. */
2503
PNG_FIXED_EXPORT(212, png_fixed_point, png_get_y_offset_inches_fixed,
2504
(png_const_structrp png_ptr, png_const_inforp info_ptr))
2505
#endif
2506
2507
# ifdef PNG_pHYs_SUPPORTED
2508
PNG_EXPORT(198, png_uint_32, png_get_pHYs_dpi, (png_const_structrp png_ptr,
2509
png_const_inforp info_ptr, png_uint_32 *res_x, png_uint_32 *res_y,
2510
int *unit_type));
2511
# endif /* pHYs */
2512
#endif /* INCH_CONVERSIONS */
2513
2514
/* Added in libpng-1.4.0 */
2515
#ifdef PNG_IO_STATE_SUPPORTED
2516
PNG_EXPORT(199, png_uint_32, png_get_io_state, (png_const_structrp png_ptr));
2517
2518
/* Removed from libpng 1.6; use png_get_io_chunk_type. */
2519
PNG_REMOVED(200, png_const_bytep, png_get_io_chunk_name, (png_structrp png_ptr),
2520
PNG_DEPRECATED)
2521
2522
PNG_EXPORT(216, png_uint_32, png_get_io_chunk_type,
2523
(png_const_structrp png_ptr));
2524
2525
/* The flags returned by png_get_io_state() are the following: */
2526
# define PNG_IO_NONE 0x0000 /* no I/O at this moment */
2527
# define PNG_IO_READING 0x0001 /* currently reading */
2528
# define PNG_IO_WRITING 0x0002 /* currently writing */
2529
# define PNG_IO_SIGNATURE 0x0010 /* currently at the file signature */
2530
# define PNG_IO_CHUNK_HDR 0x0020 /* currently at the chunk header */
2531
# define PNG_IO_CHUNK_DATA 0x0040 /* currently at the chunk data */
2532
# define PNG_IO_CHUNK_CRC 0x0080 /* currently at the chunk crc */
2533
# define PNG_IO_MASK_OP 0x000f /* current operation: reading/writing */
2534
# define PNG_IO_MASK_LOC 0x00f0 /* current location: sig/hdr/data/crc */
2535
#endif /* IO_STATE */
2536
2537
/* Interlace support. The following macros are always defined so that if
2538
* libpng interlace handling is turned off the macros may be used to handle
2539
* interlaced images within the application.
2540
*/
2541
#define PNG_INTERLACE_ADAM7_PASSES 7
2542
2543
/* Two macros to return the first row and first column of the original,
2544
* full, image which appears in a given pass. 'pass' is in the range 0
2545
* to 6 and the result is in the range 0 to 7.
2546
*/
2547
#define PNG_PASS_START_ROW(pass) (((1&~(pass))<<(3-((pass)>>1)))&7)
2548
#define PNG_PASS_START_COL(pass) (((1& (pass))<<(3-(((pass)+1)>>1)))&7)
2549
2550
/* A macro to return the offset between pixels in the output row for a pair of
2551
* pixels in the input - effectively the inverse of the 'COL_SHIFT' macro that
2552
* follows. Note that ROW_OFFSET is the offset from one row to the next whereas
2553
* COL_OFFSET is from one column to the next, within a row.
2554
*/
2555
#define PNG_PASS_ROW_OFFSET(pass) ((pass)>2?(8>>(((pass)-1)>>1)):8)
2556
#define PNG_PASS_COL_OFFSET(pass) (1<<((7-(pass))>>1))
2557
2558
/* Two macros to help evaluate the number of rows or columns in each
2559
* pass. This is expressed as a shift - effectively log2 of the number or
2560
* rows or columns in each 8x8 tile of the original image.
2561
*/
2562
#define PNG_PASS_ROW_SHIFT(pass) ((pass)>2?(8-(pass))>>1:3)
2563
#define PNG_PASS_COL_SHIFT(pass) ((pass)>1?(7-(pass))>>1:3)
2564
2565
/* Hence two macros to determine the number of rows or columns in a given
2566
* pass of an image given its height or width. In fact these macros may
2567
* return non-zero even though the sub-image is empty, because the other
2568
* dimension may be empty for a small image.
2569
*/
2570
#define PNG_PASS_ROWS(height, pass) (((height)+(((1<<PNG_PASS_ROW_SHIFT(pass))\
2571
-1)-PNG_PASS_START_ROW(pass)))>>PNG_PASS_ROW_SHIFT(pass))
2572
#define PNG_PASS_COLS(width, pass) (((width)+(((1<<PNG_PASS_COL_SHIFT(pass))\
2573
-1)-PNG_PASS_START_COL(pass)))>>PNG_PASS_COL_SHIFT(pass))
2574
2575
/* For the reader row callbacks (both progressive and sequential) it is
2576
* necessary to find the row in the output image given a row in an interlaced
2577
* image, so two more macros:
2578
*/
2579
#define PNG_ROW_FROM_PASS_ROW(y_in, pass) \
2580
(((y_in)<<PNG_PASS_ROW_SHIFT(pass))+PNG_PASS_START_ROW(pass))
2581
#define PNG_COL_FROM_PASS_COL(x_in, pass) \
2582
(((x_in)<<PNG_PASS_COL_SHIFT(pass))+PNG_PASS_START_COL(pass))
2583
2584
/* Two macros which return a boolean (0 or 1) saying whether the given row
2585
* or column is in a particular pass. These use a common utility macro that
2586
* returns a mask for a given pass - the offset 'off' selects the row or
2587
* column version. The mask has the appropriate bit set for each column in
2588
* the tile.
2589
*/
2590
#define PNG_PASS_MASK(pass,off) ( \
2591
((0x110145AF>>(((7-(off))-(pass))<<2)) & 0xF) | \
2592
((0x01145AF0>>(((7-(off))-(pass))<<2)) & 0xF0))
2593
2594
#define PNG_ROW_IN_INTERLACE_PASS(y, pass) \
2595
((PNG_PASS_MASK(pass,0) >> ((y)&7)) & 1)
2596
#define PNG_COL_IN_INTERLACE_PASS(x, pass) \
2597
((PNG_PASS_MASK(pass,1) >> ((x)&7)) & 1)
2598
2599
#ifdef PNG_READ_COMPOSITE_NODIV_SUPPORTED
2600
/* With these routines we avoid an integer divide, which will be slower on
2601
* most machines. However, it does take more operations than the corresponding
2602
* divide method, so it may be slower on a few RISC systems. There are two
2603
* shifts (by 8 or 16 bits) and an addition, versus a single integer divide.
2604
*
2605
* Note that the rounding factors are NOT supposed to be the same! 128 and
2606
* 32768 are correct for the NODIV code; 127 and 32767 are correct for the
2607
* standard method.
2608
*
2609
* [Optimized code by Greg Roelofs and Mark Adler...blame us for bugs. :-) ]
2610
*/
2611
2612
/* fg and bg should be in `gamma 1.0' space; alpha is the opacity */
2613
2614
# define png_composite(composite, fg, alpha, bg) \
2615
{ \
2616
png_uint_16 temp = (png_uint_16)((png_uint_16)(fg) \
2617
* (png_uint_16)(alpha) \
2618
+ (png_uint_16)(bg)*(png_uint_16)(255 \
2619
- (png_uint_16)(alpha)) + 128); \
2620
(composite) = (png_byte)(((temp + (temp >> 8)) >> 8) & 0xff); \
2621
}
2622
2623
# define png_composite_16(composite, fg, alpha, bg) \
2624
{ \
2625
png_uint_32 temp = (png_uint_32)((png_uint_32)(fg) \
2626
* (png_uint_32)(alpha) \
2627
+ (png_uint_32)(bg)*(65535 \
2628
- (png_uint_32)(alpha)) + 32768); \
2629
(composite) = (png_uint_16)(0xffff & ((temp + (temp >> 16)) >> 16)); \
2630
}
2631
2632
#else /* Standard method using integer division */
2633
2634
# define png_composite(composite, fg, alpha, bg) \
2635
(composite) = \
2636
(png_byte)(0xff & (((png_uint_16)(fg) * (png_uint_16)(alpha) + \
2637
(png_uint_16)(bg) * (png_uint_16)(255 - (png_uint_16)(alpha)) + \
2638
127) / 255))
2639
2640
# define png_composite_16(composite, fg, alpha, bg) \
2641
(composite) = \
2642
(png_uint_16)(0xffff & (((png_uint_32)(fg) * (png_uint_32)(alpha) + \
2643
(png_uint_32)(bg)*(png_uint_32)(65535 - (png_uint_32)(alpha)) + \
2644
32767) / 65535))
2645
#endif /* READ_COMPOSITE_NODIV */
2646
2647
#ifdef PNG_READ_INT_FUNCTIONS_SUPPORTED
2648
PNG_EXPORT(201, png_uint_32, png_get_uint_32, (png_const_bytep buf));
2649
PNG_EXPORT(202, png_uint_16, png_get_uint_16, (png_const_bytep buf));
2650
PNG_EXPORT(203, png_int_32, png_get_int_32, (png_const_bytep buf));
2651
#endif
2652
2653
PNG_EXPORT(204, png_uint_32, png_get_uint_31, (png_const_structrp png_ptr,
2654
png_const_bytep buf));
2655
/* No png_get_int_16 -- may be added if there's a real need for it. */
2656
2657
/* Place a 32-bit number into a buffer in PNG byte order (big-endian). */
2658
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2659
PNG_EXPORT(205, void, png_save_uint_32, (png_bytep buf, png_uint_32 i));
2660
#endif
2661
#ifdef PNG_SAVE_INT_32_SUPPORTED
2662
PNG_EXPORT(206, void, png_save_int_32, (png_bytep buf, png_int_32 i));
2663
#endif
2664
2665
/* Place a 16-bit number into a buffer in PNG byte order.
2666
* The parameter is declared unsigned int, not png_uint_16,
2667
* just to avoid potential problems on pre-ANSI C compilers.
2668
*/
2669
#ifdef PNG_WRITE_INT_FUNCTIONS_SUPPORTED
2670
PNG_EXPORT(207, void, png_save_uint_16, (png_bytep buf, unsigned int i));
2671
/* No png_save_int_16 -- may be added if there's a real need for it. */
2672
#endif
2673
2674
#ifdef PNG_USE_READ_MACROS
2675
/* Inline macros to do direct reads of bytes from the input buffer.
2676
* The png_get_int_32() routine assumes we are using two's complement
2677
* format for negative values, which is almost certainly true.
2678
*/
2679
# define PNG_get_uint_32(buf) \
2680
(((png_uint_32)(*(buf)) << 24) + \
2681
((png_uint_32)(*((buf) + 1)) << 16) + \
2682
((png_uint_32)(*((buf) + 2)) << 8) + \
2683
((png_uint_32)(*((buf) + 3))))
2684
2685
/* From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
2686
* function) incorrectly returned a value of type png_uint_32.
2687
*/
2688
# define PNG_get_uint_16(buf) \
2689
((png_uint_16) \
2690
(((unsigned int)(*(buf)) << 8) + \
2691
((unsigned int)(*((buf) + 1)))))
2692
2693
# define PNG_get_int_32(buf) \
2694
((png_int_32)((*(buf) & 0x80) \
2695
? -((png_int_32)(((png_get_uint_32(buf)^0xffffffffU)+1U)&0x7fffffffU)) \
2696
: (png_int_32)png_get_uint_32(buf)))
2697
2698
/* If PNG_PREFIX is defined the same thing as below happens in pnglibconf.h,
2699
* but defining a macro name prefixed with PNG_PREFIX.
2700
*/
2701
# ifndef PNG_PREFIX
2702
# define png_get_uint_32(buf) PNG_get_uint_32(buf)
2703
# define png_get_uint_16(buf) PNG_get_uint_16(buf)
2704
# define png_get_int_32(buf) PNG_get_int_32(buf)
2705
# endif
2706
#else
2707
# ifdef PNG_PREFIX
2708
/* No macros; revert to the (redefined) function */
2709
# define PNG_get_uint_32 (png_get_uint_32)
2710
# define PNG_get_uint_16 (png_get_uint_16)
2711
# define PNG_get_int_32 (png_get_int_32)
2712
# endif
2713
#endif
2714
2715
#ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED
2716
PNG_EXPORT(242, void, png_set_check_for_invalid_index,
2717
(png_structrp png_ptr, int allowed));
2718
# ifdef PNG_GET_PALETTE_MAX_SUPPORTED
2719
PNG_EXPORT(243, int, png_get_palette_max, (png_const_structp png_ptr,
2720
png_const_infop info_ptr));
2721
# endif
2722
#endif /* CHECK_FOR_INVALID_INDEX */
2723
2724
/*******************************************************************************
2725
* Section 5: SIMPLIFIED API
2726
*******************************************************************************
2727
*
2728
* Please read the documentation in libpng-manual.txt (TODO: write said
2729
* documentation) if you don't understand what follows.
2730
*
2731
* The simplified API hides the details of both libpng and the PNG file format
2732
* itself. It allows PNG files to be read into a very limited number of
2733
* in-memory bitmap formats or to be written from the same formats. If these
2734
* formats do not accommodate your needs then you can, and should, use the more
2735
* sophisticated APIs above - these support a wide variety of in-memory formats
2736
* and a wide variety of sophisticated transformations to those formats as well
2737
* as a wide variety of APIs to manipulate ancillary information.
2738
*
2739
* To read a PNG file using the simplified API:
2740
*
2741
* 1) Declare a 'png_image' structure (see below) on the stack, set the
2742
* version field to PNG_IMAGE_VERSION and the 'opaque' pointer to NULL
2743
* (this is REQUIRED, your program may crash if you don't do it.)
2744
* 2) Call the appropriate png_image_begin_read... function.
2745
* 3) Set the png_image 'format' member to the required sample format.
2746
* 4) Allocate a buffer for the image and, if required, the color-map.
2747
* 5) Call png_image_finish_read to read the image and, if required, the
2748
* color-map into your buffers.
2749
*
2750
* There are no restrictions on the format of the PNG input itself; all valid
2751
* color types, bit depths, and interlace methods are acceptable, and the
2752
* input image is transformed as necessary to the requested in-memory format
2753
* during the png_image_finish_read() step. The only caveat is that if you
2754
* request a color-mapped image from a PNG that is full-color or makes
2755
* complex use of an alpha channel the transformation is extremely lossy and the
2756
* result may look terrible.
2757
*
2758
* To write a PNG file using the simplified API:
2759
*
2760
* 1) Declare a 'png_image' structure on the stack and memset() it to all zero.
2761
* 2) Initialize the members of the structure that describe the image, setting
2762
* the 'format' member to the format of the image samples.
2763
* 3) Call the appropriate png_image_write... function with a pointer to the
2764
* image and, if necessary, the color-map to write the PNG data.
2765
*
2766
* png_image is a structure that describes the in-memory format of an image
2767
* when it is being read or defines the in-memory format of an image that you
2768
* need to write:
2769
*/
2770
#if defined(PNG_SIMPLIFIED_READ_SUPPORTED) || \
2771
defined(PNG_SIMPLIFIED_WRITE_SUPPORTED)
2772
2773
#define PNG_IMAGE_VERSION 1
2774
2775
typedef struct png_control *png_controlp;
2776
typedef struct
2777
{
2778
png_controlp opaque; /* Initialize to NULL, free with png_image_free */
2779
png_uint_32 version; /* Set to PNG_IMAGE_VERSION */
2780
png_uint_32 width; /* Image width in pixels (columns) */
2781
png_uint_32 height; /* Image height in pixels (rows) */
2782
png_uint_32 format; /* Image format as defined below */
2783
png_uint_32 flags; /* A bit mask containing informational flags */
2784
png_uint_32 colormap_entries;
2785
/* Number of entries in the color-map */
2786
2787
/* In the event of an error or warning the following field will be set to a
2788
* non-zero value and the 'message' field will contain a '\0' terminated
2789
* string with the libpng error or warning message. If both warnings and
2790
* an error were encountered, only the error is recorded. If there
2791
* are multiple warnings, only the first one is recorded.
2792
*
2793
* The upper 30 bits of this value are reserved, the low two bits contain
2794
* a value as follows:
2795
*/
2796
# define PNG_IMAGE_WARNING 1
2797
# define PNG_IMAGE_ERROR 2
2798
/*
2799
* The result is a two-bit code such that a value more than 1 indicates
2800
* a failure in the API just called:
2801
*
2802
* 0 - no warning or error
2803
* 1 - warning
2804
* 2 - error
2805
* 3 - error preceded by warning
2806
*/
2807
# define PNG_IMAGE_FAILED(png_cntrl) ((((png_cntrl).warning_or_error)&0x03)>1)
2808
2809
png_uint_32 warning_or_error;
2810
2811
char message[64];
2812
} png_image, *png_imagep;
2813
2814
/* The samples of the image have one to four channels whose components have
2815
* original values in the range 0 to 1.0:
2816
*
2817
* 1: A single gray or luminance channel (G).
2818
* 2: A gray/luminance channel and an alpha channel (GA).
2819
* 3: Three red, green, blue color channels (RGB).
2820
* 4: Three color channels and an alpha channel (RGBA).
2821
*
2822
* The components are encoded in one of two ways:
2823
*
2824
* a) As a small integer, value 0..255, contained in a single byte. For the
2825
* alpha channel the original value is simply value/255. For the color or
2826
* luminance channels the value is encoded according to the sRGB specification
2827
* and matches the 8-bit format expected by typical display devices.
2828
*
2829
* The color/gray channels are not scaled (pre-multiplied) by the alpha
2830
* channel and are suitable for passing to color management software.
2831
*
2832
* b) As a value in the range 0..65535, contained in a 2-byte integer. All
2833
* channels can be converted to the original value by dividing by 65535; all
2834
* channels are linear. Color channels use the RGB encoding (RGB end-points) of
2835
* the sRGB specification. This encoding is identified by the
2836
* PNG_FORMAT_FLAG_LINEAR flag below.
2837
*
2838
* When the simplified API needs to convert between sRGB and linear colorspaces,
2839
* the actual sRGB transfer curve defined in the sRGB specification (see the
2840
* article at <https://en.wikipedia.org/wiki/SRGB>) is used, not the gamma=1/2.2
2841
* approximation used elsewhere in libpng.
2842
*
2843
* When an alpha channel is present it is expected to denote pixel coverage
2844
* of the color or luminance channels and is returned as an associated alpha
2845
* channel: the color/gray channels are scaled (pre-multiplied) by the alpha
2846
* value.
2847
*
2848
* The samples are either contained directly in the image data, between 1 and 8
2849
* bytes per pixel according to the encoding, or are held in a color-map indexed
2850
* by bytes in the image data. In the case of a color-map the color-map entries
2851
* are individual samples, encoded as above, and the image data has one byte per
2852
* pixel to select the relevant sample from the color-map.
2853
*/
2854
2855
/* PNG_FORMAT_*
2856
*
2857
* #defines to be used in png_image::format. Each #define identifies a
2858
* particular layout of sample data and, if present, alpha values. There are
2859
* separate defines for each of the two component encodings.
2860
*
2861
* A format is built up using single bit flag values. All combinations are
2862
* valid. Formats can be built up from the flag values or you can use one of
2863
* the predefined values below. When testing formats always use the FORMAT_FLAG
2864
* macros to test for individual features - future versions of the library may
2865
* add new flags.
2866
*
2867
* When reading or writing color-mapped images the format should be set to the
2868
* format of the entries in the color-map then png_image_{read,write}_colormap
2869
* called to read or write the color-map and set the format correctly for the
2870
* image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly!
2871
*
2872
* NOTE: libpng can be built with particular features disabled. If you see
2873
* compiler errors because the definition of one of the following flags has been
2874
* compiled out it is because libpng does not have the required support. It is
2875
* possible, however, for the libpng configuration to enable the format on just
2876
* read or just write; in that case you may see an error at run time. You can
2877
* guard against this by checking for the definition of the appropriate
2878
* "_SUPPORTED" macro, one of:
2879
*
2880
* PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
2881
*/
2882
#define PNG_FORMAT_FLAG_ALPHA 0x01U /* format with an alpha channel */
2883
#define PNG_FORMAT_FLAG_COLOR 0x02U /* color format: otherwise grayscale */
2884
#define PNG_FORMAT_FLAG_LINEAR 0x04U /* 2-byte channels else 1-byte */
2885
#define PNG_FORMAT_FLAG_COLORMAP 0x08U /* image data is color-mapped */
2886
2887
#ifdef PNG_FORMAT_BGR_SUPPORTED
2888
# define PNG_FORMAT_FLAG_BGR 0x10U /* BGR colors, else order is RGB */
2889
#endif
2890
2891
#ifdef PNG_FORMAT_AFIRST_SUPPORTED
2892
# define PNG_FORMAT_FLAG_AFIRST 0x20U /* alpha channel comes first */
2893
#endif
2894
2895
#define PNG_FORMAT_FLAG_ASSOCIATED_ALPHA 0x40U /* alpha channel is associated */
2896
2897
/* Commonly used formats have predefined macros.
2898
*
2899
* First the single byte (sRGB) formats:
2900
*/
2901
#define PNG_FORMAT_GRAY 0
2902
#define PNG_FORMAT_GA PNG_FORMAT_FLAG_ALPHA
2903
#define PNG_FORMAT_AG (PNG_FORMAT_GA|PNG_FORMAT_FLAG_AFIRST)
2904
#define PNG_FORMAT_RGB PNG_FORMAT_FLAG_COLOR
2905
#define PNG_FORMAT_BGR (PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_BGR)
2906
#define PNG_FORMAT_RGBA (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_ALPHA)
2907
#define PNG_FORMAT_ARGB (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_AFIRST)
2908
#define PNG_FORMAT_BGRA (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_ALPHA)
2909
#define PNG_FORMAT_ABGR (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_AFIRST)
2910
2911
/* Then the linear 2-byte formats. When naming these "Y" is used to
2912
* indicate a luminance (gray) channel.
2913
*/
2914
#define PNG_FORMAT_LINEAR_Y PNG_FORMAT_FLAG_LINEAR
2915
#define PNG_FORMAT_LINEAR_Y_ALPHA (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_ALPHA)
2916
#define PNG_FORMAT_LINEAR_RGB (PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR)
2917
#define PNG_FORMAT_LINEAR_RGB_ALPHA \
2918
(PNG_FORMAT_FLAG_LINEAR|PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA)
2919
2920
/* With color-mapped formats the image data is one byte for each pixel, the byte
2921
* is an index into the color-map which is formatted as above. To obtain a
2922
* color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP
2923
* to one of the above definitions, or you can use one of the definitions below.
2924
*/
2925
#define PNG_FORMAT_RGB_COLORMAP (PNG_FORMAT_RGB|PNG_FORMAT_FLAG_COLORMAP)
2926
#define PNG_FORMAT_BGR_COLORMAP (PNG_FORMAT_BGR|PNG_FORMAT_FLAG_COLORMAP)
2927
#define PNG_FORMAT_RGBA_COLORMAP (PNG_FORMAT_RGBA|PNG_FORMAT_FLAG_COLORMAP)
2928
#define PNG_FORMAT_ARGB_COLORMAP (PNG_FORMAT_ARGB|PNG_FORMAT_FLAG_COLORMAP)
2929
#define PNG_FORMAT_BGRA_COLORMAP (PNG_FORMAT_BGRA|PNG_FORMAT_FLAG_COLORMAP)
2930
#define PNG_FORMAT_ABGR_COLORMAP (PNG_FORMAT_ABGR|PNG_FORMAT_FLAG_COLORMAP)
2931
2932
/* PNG_IMAGE macros
2933
*
2934
* These are convenience macros to derive information from a png_image
2935
* structure. The PNG_IMAGE_SAMPLE_ macros return values appropriate to the
2936
* actual image sample values - either the entries in the color-map or the
2937
* pixels in the image. The PNG_IMAGE_PIXEL_ macros return corresponding values
2938
* for the pixels and will always return 1 for color-mapped formats. The
2939
* remaining macros return information about the rows in the image and the
2940
* complete image.
2941
*
2942
* NOTE: All the macros that take a png_image::format parameter are compile time
2943
* constants if the format parameter is, itself, a constant. Therefore these
2944
* macros can be used in array declarations and case labels where required.
2945
* Similarly the macros are also pre-processor constants (sizeof is not used) so
2946
* they can be used in #if tests.
2947
*
2948
* First the information about the samples.
2949
*/
2950
#define PNG_IMAGE_SAMPLE_CHANNELS(fmt)\
2951
(((fmt)&(PNG_FORMAT_FLAG_COLOR|PNG_FORMAT_FLAG_ALPHA))+1)
2952
/* Return the total number of channels in a given format: 1..4 */
2953
2954
#define PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)\
2955
((((fmt) & PNG_FORMAT_FLAG_LINEAR) >> 2)+1)
2956
/* Return the size in bytes of a single component of a pixel or color-map
2957
* entry (as appropriate) in the image: 1 or 2.
2958
*/
2959
2960
#define PNG_IMAGE_SAMPLE_SIZE(fmt)\
2961
(PNG_IMAGE_SAMPLE_CHANNELS(fmt) * PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt))
2962
/* This is the size of the sample data for one sample. If the image is
2963
* color-mapped it is the size of one color-map entry (and image pixels are
2964
* one byte in size), otherwise it is the size of one image pixel.
2965
*/
2966
2967
#define PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)\
2968
(PNG_IMAGE_SAMPLE_CHANNELS(fmt) * 256)
2969
/* The maximum size of the color-map required by the format expressed in a
2970
* count of components. This can be used to compile-time allocate a
2971
* color-map:
2972
*
2973
* png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
2974
*
2975
* png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
2976
*
2977
* Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
2978
* information from one of the png_image_begin_read_ APIs and dynamically
2979
* allocate the required memory.
2980
*/
2981
2982
/* Corresponding information about the pixels */
2983
#define PNG_IMAGE_PIXEL_(test,fmt)\
2984
(((fmt)&PNG_FORMAT_FLAG_COLORMAP)?1:test(fmt))
2985
2986
#define PNG_IMAGE_PIXEL_CHANNELS(fmt)\
2987
PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_CHANNELS,fmt)
2988
/* The number of separate channels (components) in a pixel; 1 for a
2989
* color-mapped image.
2990
*/
2991
2992
#define PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\
2993
PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_COMPONENT_SIZE,fmt)
2994
/* The size, in bytes, of each component in a pixel; 1 for a color-mapped
2995
* image.
2996
*/
2997
2998
#define PNG_IMAGE_PIXEL_SIZE(fmt) PNG_IMAGE_PIXEL_(PNG_IMAGE_SAMPLE_SIZE,fmt)
2999
/* The size, in bytes, of a complete pixel; 1 for a color-mapped image. */
3000
3001
/* Information about the whole row, or whole image */
3002
#define PNG_IMAGE_ROW_STRIDE(image)\
3003
(PNG_IMAGE_PIXEL_CHANNELS((image).format) * (image).width)
3004
/* Return the total number of components in a single row of the image; this
3005
* is the minimum 'row stride', the minimum count of components between each
3006
* row. For a color-mapped image this is the minimum number of bytes in a
3007
* row.
3008
*
3009
* WARNING: this macro overflows for some images with more than one component
3010
* and very large image widths. libpng will refuse to process an image where
3011
* this macro would overflow.
3012
*/
3013
3014
#define PNG_IMAGE_BUFFER_SIZE(image, row_stride)\
3015
(PNG_IMAGE_PIXEL_COMPONENT_SIZE((image).format)*(image).height*(row_stride))
3016
/* Return the size, in bytes, of an image buffer given a png_image and a row
3017
* stride - the number of components to leave space for in each row.
3018
*
3019
* WARNING: this macro overflows a 32-bit integer for some large PNG images,
3020
* libpng will refuse to process an image where such an overflow would occur.
3021
*/
3022
3023
#define PNG_IMAGE_SIZE(image)\
3024
PNG_IMAGE_BUFFER_SIZE(image, PNG_IMAGE_ROW_STRIDE(image))
3025
/* Return the size, in bytes, of the image in memory given just a png_image;
3026
* the row stride is the minimum stride required for the image.
3027
*/
3028
3029
#define PNG_IMAGE_COLORMAP_SIZE(image)\
3030
(PNG_IMAGE_SAMPLE_SIZE((image).format) * (image).colormap_entries)
3031
/* Return the size, in bytes, of the color-map of this image. If the image
3032
* format is not a color-map format this will return a size sufficient for
3033
* 256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if
3034
* you don't want to allocate a color-map in this case.
3035
*/
3036
3037
/* PNG_IMAGE_FLAG_*
3038
*
3039
* Flags containing additional information about the image are held in the
3040
* 'flags' field of png_image.
3041
*/
3042
#define PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB 0x01
3043
/* This indicates that the RGB values of the in-memory bitmap do not
3044
* correspond to the red, green and blue end-points defined by sRGB.
3045
*/
3046
3047
#define PNG_IMAGE_FLAG_FAST 0x02
3048
/* On write emphasise speed over compression; the resultant PNG file will be
3049
* larger but will be produced significantly faster, particular for large
3050
* images. Do not use this option for images which will be distributed, only
3051
* used it when producing intermediate files that will be read back in
3052
* repeatedly. For a typical 24-bit image the option will double the read
3053
* speed at the cost of increasing the image size by 25%, however for many
3054
* more compressible images the PNG file can be 10 times larger with only a
3055
* slight speed gain.
3056
*/
3057
3058
#define PNG_IMAGE_FLAG_16BIT_sRGB 0x04
3059
/* On read if the image is a 16-bit per component image and there is no gAMA
3060
* or sRGB chunk assume that the components are sRGB encoded. Notice that
3061
* images output by the simplified API always have gamma information; setting
3062
* this flag only affects the interpretation of 16-bit images from an
3063
* external source. It is recommended that the application expose this flag
3064
* to the user; the user can normally easily recognize the difference between
3065
* linear and sRGB encoding. This flag has no effect on write - the data
3066
* passed to the write APIs must have the correct encoding (as defined
3067
* above.)
3068
*
3069
* If the flag is not set (the default) input 16-bit per component data is
3070
* assumed to be linear.
3071
*
3072
* NOTE: the flag can only be set after the png_image_begin_read_ call,
3073
* because that call initializes the 'flags' field.
3074
*/
3075
3076
#ifdef PNG_SIMPLIFIED_READ_SUPPORTED
3077
/* READ APIs
3078
* ---------
3079
*
3080
* The png_image passed to the read APIs must have been initialized by setting
3081
* the png_controlp field 'opaque' to NULL (or, safer, memset the whole thing.)
3082
*/
3083
#ifdef PNG_STDIO_SUPPORTED
3084
PNG_EXPORT(234, int, png_image_begin_read_from_file, (png_imagep image,
3085
const char *file_name));
3086
/* The named file is opened for read and the image header is filled in
3087
* from the PNG header in the file.
3088
*/
3089
3090
PNG_EXPORT(235, int, png_image_begin_read_from_stdio, (png_imagep image,
3091
FILE *file));
3092
/* The PNG header is read from the stdio FILE object. */
3093
#endif /* STDIO */
3094
3095
PNG_EXPORT(236, int, png_image_begin_read_from_memory, (png_imagep image,
3096
png_const_voidp memory, size_t size));
3097
/* The PNG header is read from the given memory buffer. */
3098
3099
PNG_EXPORT(237, int, png_image_finish_read, (png_imagep image,
3100
png_const_colorp background, void *buffer, png_int_32 row_stride,
3101
void *colormap));
3102
/* Finish reading the image into the supplied buffer and clean up the
3103
* png_image structure.
3104
*
3105
* row_stride is the step, in byte or 2-byte units as appropriate,
3106
* between adjacent rows. A positive stride indicates that the top-most row
3107
* is first in the buffer - the normal top-down arrangement. A negative
3108
* stride indicates that the bottom-most row is first in the buffer.
3109
*
3110
* background need only be supplied if an alpha channel must be removed from
3111
* a png_byte format and the removal is to be done by compositing on a solid
3112
* color; otherwise it may be NULL and any composition will be done directly
3113
* onto the buffer. The value is an sRGB color to use for the background,
3114
* for grayscale output the green channel is used.
3115
*
3116
* background must be supplied when an alpha channel must be removed from a
3117
* single byte color-mapped output format, in other words if:
3118
*
3119
* 1) The original format from png_image_begin_read_from_* had
3120
* PNG_FORMAT_FLAG_ALPHA set.
3121
* 2) The format set by the application does not.
3122
* 3) The format set by the application has PNG_FORMAT_FLAG_COLORMAP set and
3123
* PNG_FORMAT_FLAG_LINEAR *not* set.
3124
*
3125
* For linear output removing the alpha channel is always done by compositing
3126
* on black and background is ignored.
3127
*
3128
* colormap must be supplied when PNG_FORMAT_FLAG_COLORMAP is set. It must
3129
* be at least the size (in bytes) returned by PNG_IMAGE_COLORMAP_SIZE.
3130
* image->colormap_entries will be updated to the actual number of entries
3131
* written to the colormap; this may be less than the original value.
3132
*/
3133
3134
PNG_EXPORT(238, void, png_image_free, (png_imagep image));
3135
/* Free any data allocated by libpng in image->opaque, setting the pointer to
3136
* NULL. May be called at any time after the structure is initialized.
3137
*/
3138
#endif /* SIMPLIFIED_READ */
3139
3140
#ifdef PNG_SIMPLIFIED_WRITE_SUPPORTED
3141
/* WRITE APIS
3142
* ----------
3143
* For write you must initialize a png_image structure to describe the image to
3144
* be written. To do this use memset to set the whole structure to 0 then
3145
* initialize fields describing your image.
3146
*
3147
* version: must be set to PNG_IMAGE_VERSION
3148
* opaque: must be initialized to NULL
3149
* width: image width in pixels
3150
* height: image height in rows
3151
* format: the format of the data (image and color-map) you wish to write
3152
* flags: set to 0 unless one of the defined flags applies; set
3153
* PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images where the RGB
3154
* values do not correspond to the colors in sRGB.
3155
* colormap_entries: set to the number of entries in the color-map (0 to 256)
3156
*/
3157
#ifdef PNG_SIMPLIFIED_WRITE_STDIO_SUPPORTED
3158
PNG_EXPORT(239, int, png_image_write_to_file, (png_imagep image,
3159
const char *file, int convert_to_8bit, const void *buffer,
3160
png_int_32 row_stride, const void *colormap));
3161
/* Write the image to the named file. */
3162
3163
PNG_EXPORT(240, int, png_image_write_to_stdio, (png_imagep image, FILE *file,
3164
int convert_to_8_bit, const void *buffer, png_int_32 row_stride,
3165
const void *colormap));
3166
/* Write the image to the given FILE object. */
3167
#endif /* SIMPLIFIED_WRITE_STDIO */
3168
3169
/* With all write APIs if image is in one of the linear formats with 16-bit
3170
* data then setting convert_to_8_bit will cause the output to be an 8-bit PNG
3171
* gamma encoded according to the sRGB specification, otherwise a 16-bit linear
3172
* encoded PNG file is written.
3173
*
3174
* With color-mapped data formats the colormap parameter point to a color-map
3175
* with at least image->colormap_entries encoded in the specified format. If
3176
* the format is linear the written PNG color-map will be converted to sRGB
3177
* regardless of the convert_to_8_bit flag.
3178
*
3179
* With all APIs row_stride is handled as in the read APIs - it is the spacing
3180
* from one row to the next in component sized units (1 or 2 bytes) and if
3181
* negative indicates a bottom-up row layout in the buffer. If row_stride is
3182
* zero, libpng will calculate it for you from the image width and number of
3183
* channels.
3184
*
3185
* Note that the write API does not support interlacing, sub-8-bit pixels or
3186
* most ancillary chunks. If you need to write text chunks (e.g. for copyright
3187
* notices) you need to use one of the other APIs.
3188
*/
3189
3190
PNG_EXPORT(245, int, png_image_write_to_memory, (png_imagep image, void *memory,
3191
png_alloc_size_t * PNG_RESTRICT memory_bytes, int convert_to_8_bit,
3192
const void *buffer, png_int_32 row_stride, const void *colormap));
3193
/* Write the image to the given memory buffer. The function both writes the
3194
* whole PNG data stream to *memory and updates *memory_bytes with the count
3195
* of bytes written.
3196
*
3197
* 'memory' may be NULL. In this case *memory_bytes is not read however on
3198
* success the number of bytes which would have been written will still be
3199
* stored in *memory_bytes. On failure *memory_bytes will contain 0.
3200
*
3201
* If 'memory' is not NULL it must point to memory[*memory_bytes] of
3202
* writeable memory.
3203
*
3204
* If the function returns success memory[*memory_bytes] (if 'memory' is not
3205
* NULL) contains the written PNG data. *memory_bytes will always be less
3206
* than or equal to the original value.
3207
*
3208
* If the function returns false and *memory_bytes was not changed an error
3209
* occurred during write. If *memory_bytes was changed, or is not 0 if
3210
* 'memory' was NULL, the write would have succeeded but for the memory
3211
* buffer being too small. *memory_bytes contains the required number of
3212
* bytes and will be bigger that the original value.
3213
*/
3214
3215
#define png_image_write_get_memory_size(image, size, convert_to_8_bit, buffer,\
3216
row_stride, colormap)\
3217
png_image_write_to_memory(&(image), 0, &(size), convert_to_8_bit, buffer,\
3218
row_stride, colormap)
3219
/* Return the amount of memory in 'size' required to compress this image.
3220
* The png_image structure 'image' must be filled in as in the above
3221
* function and must not be changed before the actual write call, the buffer
3222
* and all other parameters must also be identical to that in the final
3223
* write call. The 'size' variable need not be initialized.
3224
*
3225
* NOTE: the macro returns true/false, if false is returned 'size' will be
3226
* set to zero and the write failed and probably will fail if tried again.
3227
*/
3228
3229
/* You can pre-allocate the buffer by making sure it is of sufficient size
3230
* regardless of the amount of compression achieved. The buffer size will
3231
* always be bigger than the original image and it will never be filled. The
3232
* following macros are provided to assist in allocating the buffer.
3233
*/
3234
#define PNG_IMAGE_DATA_SIZE(image) (PNG_IMAGE_SIZE(image)+(image).height)
3235
/* The number of uncompressed bytes in the PNG byte encoding of the image;
3236
* uncompressing the PNG IDAT data will give this number of bytes.
3237
*
3238
* NOTE: while PNG_IMAGE_SIZE cannot overflow for an image in memory this
3239
* macro can because of the extra bytes used in the PNG byte encoding. You
3240
* need to avoid this macro if your image size approaches 2^30 in width or
3241
* height. The same goes for the remainder of these macros; they all produce
3242
* bigger numbers than the actual in-memory image size.
3243
*/
3244
#ifndef PNG_ZLIB_MAX_SIZE
3245
# define PNG_ZLIB_MAX_SIZE(b) ((b)+(((b)+7U)>>3)+(((b)+63U)>>6)+11U)
3246
/* An upper bound on the number of compressed bytes given 'b' uncompressed
3247
* bytes. This is based on deflateBounds() in zlib; different
3248
* implementations of zlib compression may conceivably produce more data so
3249
* if your zlib implementation is not zlib itself redefine this macro
3250
* appropriately.
3251
*/
3252
#endif
3253
3254
#define PNG_IMAGE_COMPRESSED_SIZE_MAX(image)\
3255
PNG_ZLIB_MAX_SIZE((png_alloc_size_t)PNG_IMAGE_DATA_SIZE(image))
3256
/* An upper bound on the size of the data in the PNG IDAT chunks. */
3257
3258
#define PNG_IMAGE_PNG_SIZE_MAX_(image, image_size)\
3259
((8U/*sig*/+25U/*IHDR*/+16U/*gAMA*/+44U/*cHRM*/+12U/*IEND*/+\
3260
(((image).format&PNG_FORMAT_FLAG_COLORMAP)?/*colormap: PLTE, tRNS*/\
3261
12U+3U*(image).colormap_entries/*PLTE data*/+\
3262
(((image).format&PNG_FORMAT_FLAG_ALPHA)?\
3263
12U/*tRNS*/+(image).colormap_entries:0U):0U)+\
3264
12U)+(12U*((image_size)/PNG_ZBUF_SIZE))/*IDAT*/+(image_size))
3265
/* A helper for the following macro; if your compiler cannot handle the
3266
* following macro use this one with the result of
3267
* PNG_IMAGE_COMPRESSED_SIZE_MAX(image) as the second argument (most
3268
* compilers should handle this just fine.)
3269
*/
3270
3271
#define PNG_IMAGE_PNG_SIZE_MAX(image)\
3272
PNG_IMAGE_PNG_SIZE_MAX_(image, PNG_IMAGE_COMPRESSED_SIZE_MAX(image))
3273
/* An upper bound on the total length of the PNG data stream for 'image'.
3274
* The result is of type png_alloc_size_t, on 32-bit systems this may
3275
* overflow even though PNG_IMAGE_DATA_SIZE does not overflow; the write will
3276
* run out of buffer space but return a corrected size which should work.
3277
*/
3278
#endif /* SIMPLIFIED_WRITE */
3279
/*******************************************************************************
3280
* END OF SIMPLIFIED API
3281
******************************************************************************/
3282
#endif /* SIMPLIFIED_{READ|WRITE} */
3283
3284
/*******************************************************************************
3285
* Section 6: IMPLEMENTATION OPTIONS
3286
*******************************************************************************
3287
*
3288
* Support for arbitrary implementation-specific optimizations. The API allows
3289
* particular options to be turned on or off. 'Option' is the number of the
3290
* option and 'onoff' is 0 (off) or non-0 (on). The value returned is given
3291
* by the PNG_OPTION_ defines below.
3292
*
3293
* HARDWARE: normally hardware capabilities, such as the Intel SSE instructions,
3294
* are detected at run time, however sometimes it may be impossible
3295
* to do this in user mode, in which case it is necessary to discover
3296
* the capabilities in an OS specific way. Such capabilities are
3297
* listed here when libpng has support for them and must be turned
3298
* ON by the application if present.
3299
*
3300
* SOFTWARE: sometimes software optimizations actually result in performance
3301
* decrease on some architectures or systems, or with some sets of
3302
* PNG images. 'Software' options allow such optimizations to be
3303
* selected at run time.
3304
*/
3305
#ifdef PNG_SET_OPTION_SUPPORTED
3306
#ifdef PNG_ARM_NEON_API_SUPPORTED
3307
# define PNG_ARM_NEON 0 /* HARDWARE: ARM Neon SIMD instructions supported */
3308
#endif
3309
#define PNG_MAXIMUM_INFLATE_WINDOW 2 /* SOFTWARE: force maximum window */
3310
#define PNG_SKIP_sRGB_CHECK_PROFILE 4 /* SOFTWARE: Check ICC profile for sRGB */
3311
#ifdef PNG_MIPS_MSA_API_SUPPORTED
3312
# define PNG_MIPS_MSA 6 /* HARDWARE: MIPS Msa SIMD instructions supported */
3313
#endif
3314
#ifdef PNG_DISABLE_ADLER32_CHECK_SUPPORTED
3315
# define PNG_IGNORE_ADLER32 8 /* SOFTWARE: disable Adler32 check on IDAT */
3316
#endif
3317
#ifdef PNG_POWERPC_VSX_API_SUPPORTED
3318
# define PNG_POWERPC_VSX 10 /* HARDWARE: PowerPC VSX SIMD instructions
3319
* supported */
3320
#endif
3321
#ifdef PNG_MIPS_MMI_API_SUPPORTED
3322
# define PNG_MIPS_MMI 12 /* HARDWARE: MIPS MMI SIMD instructions supported */
3323
#endif
3324
3325
#define PNG_OPTION_NEXT 14 /* Next option - numbers must be even */
3326
3327
/* Return values: NOTE: there are four values and 'off' is *not* zero */
3328
#define PNG_OPTION_UNSET 0 /* Unset - defaults to off */
3329
#define PNG_OPTION_INVALID 1 /* Option number out of range */
3330
#define PNG_OPTION_OFF 2
3331
#define PNG_OPTION_ON 3
3332
3333
PNG_EXPORT(244, int, png_set_option, (png_structrp png_ptr, int option,
3334
int onoff));
3335
#endif /* SET_OPTION */
3336
3337
/*******************************************************************************
3338
* END OF HARDWARE AND SOFTWARE OPTIONS
3339
******************************************************************************/
3340
3341
/* Maintainer: Put new public prototypes here ^, in libpng.3, in project
3342
* defs, and in scripts/symbols.def.
3343
*/
3344
3345
/* The last ordinal number (this is the *last* one already used; the next
3346
* one to use is one more than this.)
3347
*/
3348
#ifdef PNG_EXPORT_LAST_ORDINAL
3349
PNG_EXPORT_LAST_ORDINAL(259);
3350
#endif
3351
3352
#ifdef __cplusplus
3353
}
3354
#endif
3355
3356
#endif /* PNG_VERSION_INFO_ONLY */
3357
/* Do not put anything past this line */
3358
#endif /* PNG_H */
3359
3360