VirtualBox

source: vbox/trunk/src/libs/libpng-1.6.45/pngstruct.h@ 107935

Last change on this file since 107935 was 107813, checked in by vboxsync, 3 weeks ago

libpng-1.6.45: Applied and adjusted our libpng changes to 1.6.45. bugref:8515

  • Property svn:eol-style set to native
File size: 19.4 KB
Line 
1/* pngstruct.h - header file for PNG reference library
2 *
3 * Copyright (c) 2018-2022 Cosmin Truta
4 * Copyright (c) 1998-2002,2004,2006-2018 Glenn Randers-Pehrson
5 * Copyright (c) 1996-1997 Andreas Dilger
6 * Copyright (c) 1995-1996 Guy Eric Schalnat, Group 42, Inc.
7 *
8 * This code is released under the libpng license.
9 * For conditions of distribution and use, see the disclaimer
10 * and license in png.h
11 */
12
13/* The structure that holds the information to read and write PNG files.
14 * The only people who need to care about what is inside of this are the
15 * people who will be modifying the library for their own special needs.
16 * It should NOT be accessed directly by an application.
17 */
18
19#ifndef PNGSTRUCT_H
20#define PNGSTRUCT_H
21/* zlib.h defines the structure z_stream, an instance of which is included
22 * in this structure and is required for decompressing the LZ compressed
23 * data in PNG files.
24 */
25#ifndef ZLIB_CONST
26 /* We must ensure that zlib uses 'const' in declarations. */
27# define ZLIB_CONST
28#endif
29#include "zlib.h"
30#ifdef const
31 /* zlib.h sometimes #defines const to nothing, undo this. */
32# undef const
33#endif
34
35/* zlib.h has mediocre z_const use before 1.2.6, this stuff is for compatibility
36 * with older builds.
37 */
38#if ZLIB_VERNUM < 0x1260
39# define PNGZ_MSG_CAST(s) png_constcast(char*,s)
40# define PNGZ_INPUT_CAST(b) png_constcast(png_bytep,b)
41#else
42# define PNGZ_MSG_CAST(s) (s)
43# define PNGZ_INPUT_CAST(b) (b)
44#endif
45
46/* zlib.h declares a magic type 'uInt' that limits the amount of data that zlib
47 * can handle at once. This type need be no larger than 16 bits (so maximum of
48 * 65535), this define allows us to discover how big it is, but limited by the
49 * maximum for size_t. The value can be overridden in a library build
50 * (pngusr.h, or set it in CPPFLAGS) and it works to set it to a considerably
51 * lower value (e.g. 255 works). A lower value may help memory usage (slightly)
52 * and may even improve performance on some systems (and degrade it on others.)
53 */
54#ifndef ZLIB_IO_MAX
55# define ZLIB_IO_MAX ((uInt)-1)
56#endif
57
58#ifdef PNG_WRITE_SUPPORTED
59/* The type of a compression buffer list used by the write code. */
60typedef struct png_compression_buffer
61{
62 struct png_compression_buffer *next;
63 png_byte output[1]; /* actually zbuf_size */
64} png_compression_buffer, *png_compression_bufferp;
65
66#define PNG_COMPRESSION_BUFFER_SIZE(pp)\
67 (offsetof(png_compression_buffer, output) + (pp)->zbuffer_size)
68#endif
69
70/* Colorspace support; structures used in png_struct, png_info and in internal
71 * functions to hold and communicate information about the color space.
72 *
73 * PNG_COLORSPACE_SUPPORTED is only required if the application will perform
74 * colorspace corrections, otherwise all the colorspace information can be
75 * skipped and the size of libpng can be reduced (significantly) by compiling
76 * out the colorspace support.
77 */
78#ifdef PNG_COLORSPACE_SUPPORTED
79/* The chromaticities of the red, green and blue colorants and the chromaticity
80 * of the corresponding white point (i.e. of rgb(1.0,1.0,1.0)).
81 */
82typedef struct png_xy
83{
84 png_fixed_point redx, redy;
85 png_fixed_point greenx, greeny;
86 png_fixed_point bluex, bluey;
87 png_fixed_point whitex, whitey;
88} png_xy;
89
90/* The same data as above but encoded as CIE XYZ values. When this data comes
91 * from chromaticities the sum of the Y values is assumed to be 1.0
92 */
93typedef struct png_XYZ
94{
95 png_fixed_point red_X, red_Y, red_Z;
96 png_fixed_point green_X, green_Y, green_Z;
97 png_fixed_point blue_X, blue_Y, blue_Z;
98} png_XYZ;
99#endif /* COLORSPACE */
100
101#if defined(PNG_COLORSPACE_SUPPORTED) || defined(PNG_GAMMA_SUPPORTED)
102/* A colorspace is all the above plus, potentially, profile information;
103 * however at present libpng does not use the profile internally so it is only
104 * stored in the png_info struct (if iCCP is supported.) The rendering intent
105 * is retained here and is checked.
106 *
107 * The file gamma encoding information is also stored here and gamma correction
108 * is done by libpng, whereas color correction must currently be done by the
109 * application.
110 */
111typedef struct png_colorspace
112{
113#ifdef PNG_GAMMA_SUPPORTED
114 png_fixed_point gamma; /* File gamma */
115#endif
116
117#ifdef PNG_COLORSPACE_SUPPORTED
118 png_xy end_points_xy; /* End points as chromaticities */
119 png_XYZ end_points_XYZ; /* End points as CIE XYZ colorant values */
120 png_uint_16 rendering_intent; /* Rendering intent of a profile */
121#endif
122
123 /* Flags are always defined to simplify the code. */
124 png_uint_16 flags; /* As defined below */
125} png_colorspace, * PNG_RESTRICT png_colorspacerp;
126
127typedef const png_colorspace * PNG_RESTRICT png_const_colorspacerp;
128
129/* General flags for the 'flags' field */
130#define PNG_COLORSPACE_HAVE_GAMMA 0x0001
131#define PNG_COLORSPACE_HAVE_ENDPOINTS 0x0002
132#define PNG_COLORSPACE_HAVE_INTENT 0x0004
133#define PNG_COLORSPACE_FROM_gAMA 0x0008
134#define PNG_COLORSPACE_FROM_cHRM 0x0010
135#define PNG_COLORSPACE_FROM_sRGB 0x0020
136#define PNG_COLORSPACE_ENDPOINTS_MATCH_sRGB 0x0040
137#define PNG_COLORSPACE_MATCHES_sRGB 0x0080 /* exact match on profile */
138#define PNG_COLORSPACE_INVALID 0x8000
139#define PNG_COLORSPACE_CANCEL(flags) (0xffff ^ (flags))
140#endif /* COLORSPACE || GAMMA */
141
142struct png_struct_def
143{
144#ifdef PNG_SETJMP_SUPPORTED
145 jmp_buf jmp_buf_local; /* New name in 1.6.0 for jmp_buf in png_struct */
146 png_longjmp_ptr longjmp_fn;/* setjmp non-local goto function. */
147 jmp_buf *jmp_buf_ptr; /* passed to longjmp_fn */
148 size_t jmp_buf_size; /* size of the above, if allocated */
149#endif
150 png_error_ptr error_fn; /* function for printing errors and aborting */
151#ifdef PNG_WARNINGS_SUPPORTED
152 png_error_ptr warning_fn; /* function for printing warnings */
153#endif
154 png_voidp error_ptr; /* user supplied struct for error functions */
155 png_rw_ptr write_data_fn; /* function for writing output data */
156 png_rw_ptr read_data_fn; /* function for reading input data */
157 png_voidp io_ptr; /* ptr to application struct for I/O functions */
158
159#ifdef PNG_READ_USER_TRANSFORM_SUPPORTED
160 png_user_transform_ptr read_user_transform_fn; /* user read transform */
161#endif
162
163#ifdef PNG_WRITE_USER_TRANSFORM_SUPPORTED
164 png_user_transform_ptr write_user_transform_fn; /* user write transform */
165#endif
166
167/* These were added in libpng-1.0.2 */
168#ifdef PNG_USER_TRANSFORM_PTR_SUPPORTED
169#if defined(PNG_READ_USER_TRANSFORM_SUPPORTED) || \
170 defined(PNG_WRITE_USER_TRANSFORM_SUPPORTED)
171 png_voidp user_transform_ptr; /* user supplied struct for user transform */
172 png_byte user_transform_depth; /* bit depth of user transformed pixels */
173 png_byte user_transform_channels; /* channels in user transformed pixels */
174#endif
175#endif
176
177 png_uint_32 mode; /* tells us where we are in the PNG file */
178 png_uint_32 flags; /* flags indicating various things to libpng */
179 png_uint_32 transformations; /* which transformations to perform */
180
181 png_uint_32 zowner; /* ID (chunk type) of zstream owner, 0 if none */
182 z_stream zstream; /* decompression structure */
183
184#ifdef PNG_WRITE_SUPPORTED
185 png_compression_bufferp zbuffer_list; /* Created on demand during write */
186 uInt zbuffer_size; /* size of the actual buffer */
187
188 int zlib_level; /* holds zlib compression level */
189 int zlib_method; /* holds zlib compression method */
190 int zlib_window_bits; /* holds zlib compression window bits */
191 int zlib_mem_level; /* holds zlib compression memory level */
192 int zlib_strategy; /* holds zlib compression strategy */
193#endif
194/* Added at libpng 1.5.4 */
195#ifdef PNG_WRITE_CUSTOMIZE_ZTXT_COMPRESSION_SUPPORTED
196 int zlib_text_level; /* holds zlib compression level */
197 int zlib_text_method; /* holds zlib compression method */
198 int zlib_text_window_bits; /* holds zlib compression window bits */
199 int zlib_text_mem_level; /* holds zlib compression memory level */
200 int zlib_text_strategy; /* holds zlib compression strategy */
201#endif
202/* End of material added at libpng 1.5.4 */
203/* Added at libpng 1.6.0 */
204#ifdef PNG_WRITE_SUPPORTED
205 int zlib_set_level; /* Actual values set into the zstream on write */
206 int zlib_set_method;
207 int zlib_set_window_bits;
208 int zlib_set_mem_level;
209 int zlib_set_strategy;
210#endif
211
212 png_uint_32 width; /* width of image in pixels */
213 png_uint_32 height; /* height of image in pixels */
214 png_uint_32 num_rows; /* number of rows in current pass */
215 png_uint_32 usr_width; /* width of row at start of write */
216 size_t rowbytes; /* size of row in bytes */
217 png_uint_32 iwidth; /* width of current interlaced row in pixels */
218 png_uint_32 row_number; /* current row in interlace pass */
219 png_uint_32 chunk_name; /* PNG_CHUNK() id of current chunk */
220 png_bytep prev_row; /* buffer to save previous (unfiltered) row.
221 * While reading this is a pointer into
222 * big_prev_row; while writing it is separately
223 * allocated if needed.
224 */
225 png_bytep row_buf; /* buffer to save current (unfiltered) row.
226 * While reading, this is a pointer into
227 * big_row_buf; while writing it is separately
228 * allocated.
229 */
230#ifdef PNG_WRITE_FILTER_SUPPORTED
231 png_bytep try_row; /* buffer to save trial row when filtering */
232 png_bytep tst_row; /* buffer to save best trial row when filtering */
233#endif
234 size_t info_rowbytes; /* Added in 1.5.4: cache of updated row bytes */
235
236 png_uint_32 idat_size; /* current IDAT size for read */
237 png_uint_32 crc; /* current chunk CRC value */
238 png_colorp palette; /* palette from the input file */
239 png_uint_16 num_palette; /* number of color entries in palette */
240
241/* Added at libpng-1.5.10 */
242#ifdef PNG_CHECK_FOR_INVALID_INDEX_SUPPORTED
243 int num_palette_max; /* maximum palette index found in IDAT */
244#endif
245
246 png_uint_16 num_trans; /* number of transparency values */
247 png_byte compression; /* file compression type (always 0) */
248 png_byte filter; /* file filter type (always 0) */
249 png_byte interlaced; /* PNG_INTERLACE_NONE, PNG_INTERLACE_ADAM7 */
250 png_byte pass; /* current interlace pass (0 - 6) */
251 png_byte do_filter; /* row filter flags (see PNG_FILTER_ in png.h ) */
252 png_byte color_type; /* color type of file */
253 png_byte bit_depth; /* bit depth of file */
254 png_byte usr_bit_depth; /* bit depth of users row: write only */
255 png_byte pixel_depth; /* number of bits per pixel */
256 png_byte channels; /* number of channels in file */
257#ifdef PNG_WRITE_SUPPORTED
258 png_byte usr_channels; /* channels at start of write: write only */
259#endif
260 png_byte sig_bytes; /* magic bytes read/written from start of file */
261 png_byte maximum_pixel_depth;
262 /* pixel depth used for the row buffers */
263 png_byte transformed_pixel_depth;
264 /* pixel depth after read/write transforms */
265#if ZLIB_VERNUM >= 0x1240
266 png_byte zstream_start; /* at start of an input zlib stream */
267#endif /* Zlib >= 1.2.4 */
268#if defined(PNG_READ_FILLER_SUPPORTED) || defined(PNG_WRITE_FILLER_SUPPORTED)
269 png_uint_16 filler; /* filler bytes for pixel expansion */
270#endif
271
272#if defined(PNG_bKGD_SUPPORTED) || defined(PNG_READ_BACKGROUND_SUPPORTED) ||\
273 defined(PNG_READ_ALPHA_MODE_SUPPORTED)
274 png_byte background_gamma_type;
275 png_fixed_point background_gamma;
276 png_color_16 background; /* background color in screen gamma space */
277#ifdef PNG_READ_GAMMA_SUPPORTED
278 png_color_16 background_1; /* background normalized to gamma 1.0 */
279#endif
280#endif /* bKGD */
281
282#ifdef PNG_WRITE_FLUSH_SUPPORTED
283 png_flush_ptr output_flush_fn; /* Function for flushing output */
284 png_uint_32 flush_dist; /* how many rows apart to flush, 0 - no flush */
285 png_uint_32 flush_rows; /* number of rows written since last flush */
286#endif
287
288#ifdef PNG_READ_GAMMA_SUPPORTED
289 int gamma_shift; /* number of "insignificant" bits in 16-bit gamma */
290 png_fixed_point screen_gamma; /* screen gamma value (display_exponent) */
291
292 png_bytep gamma_table; /* gamma table for 8-bit depth files */
293 png_uint_16pp gamma_16_table; /* gamma table for 16-bit depth files */
294#if defined(PNG_READ_BACKGROUND_SUPPORTED) || \
295 defined(PNG_READ_ALPHA_MODE_SUPPORTED) || \
296 defined(PNG_READ_RGB_TO_GRAY_SUPPORTED)
297 png_bytep gamma_from_1; /* converts from 1.0 to screen */
298 png_bytep gamma_to_1; /* converts from file to 1.0 */
299 png_uint_16pp gamma_16_from_1; /* converts from 1.0 to screen */
300 png_uint_16pp gamma_16_to_1; /* converts from file to 1.0 */
301#endif /* READ_BACKGROUND || READ_ALPHA_MODE || RGB_TO_GRAY */
302#endif
303
304#if defined(PNG_READ_GAMMA_SUPPORTED) || defined(PNG_sBIT_SUPPORTED)
305 png_color_8 sig_bit; /* significant bits in each available channel */
306#endif
307
308#if defined(PNG_READ_SHIFT_SUPPORTED) || defined(PNG_WRITE_SHIFT_SUPPORTED)
309 png_color_8 shift; /* shift for significant bit transformation */
310#endif
311
312#if defined(PNG_tRNS_SUPPORTED) || defined(PNG_READ_BACKGROUND_SUPPORTED) \
313 || defined(PNG_READ_EXPAND_SUPPORTED) || defined(PNG_READ_BACKGROUND_SUPPORTED)
314 png_bytep trans_alpha; /* alpha values for paletted files */
315 png_color_16 trans_color; /* transparent color for non-paletted files */
316#endif
317
318 png_read_status_ptr read_row_fn; /* called after each row is decoded */
319 png_write_status_ptr write_row_fn; /* called after each row is encoded */
320#ifdef PNG_PROGRESSIVE_READ_SUPPORTED
321 png_progressive_info_ptr info_fn; /* called after header data fully read */
322 png_progressive_row_ptr row_fn; /* called after a prog. row is decoded */
323 png_progressive_end_ptr end_fn; /* called after image is complete */
324 png_bytep save_buffer_ptr; /* current location in save_buffer */
325 png_bytep save_buffer; /* buffer for previously read data */
326 png_bytep current_buffer_ptr; /* current location in current_buffer */
327 png_bytep current_buffer; /* buffer for recently used data */
328 png_uint_32 push_length; /* size of current input chunk */
329 png_uint_32 skip_length; /* bytes to skip in input data */
330 size_t save_buffer_size; /* amount of data now in save_buffer */
331 size_t save_buffer_max; /* total size of save_buffer */
332 size_t buffer_size; /* total amount of available input data */
333 size_t current_buffer_size; /* amount of data now in current_buffer */
334 int process_mode; /* what push library is currently doing */
335 int cur_palette; /* current push library palette index */
336#endif /* PROGRESSIVE_READ */
337
338#ifdef PNG_READ_QUANTIZE_SUPPORTED
339 png_bytep palette_lookup; /* lookup table for quantizing */
340 png_bytep quantize_index; /* index translation for palette files */
341#endif
342
343/* Options */
344#ifdef PNG_SET_OPTION_SUPPORTED
345 png_uint_32 options; /* On/off state (up to 16 options) */
346#endif
347
348#if PNG_LIBPNG_VER < 10700
349/* To do: remove this from libpng-1.7 */
350#ifdef PNG_TIME_RFC1123_SUPPORTED
351 char time_buffer[29]; /* String to hold RFC 1123 time text */
352#endif
353#endif
354
355/* New members added in libpng-1.0.6 */
356
357 png_uint_32 free_me; /* flags items libpng is responsible for freeing */
358
359#ifdef PNG_USER_CHUNKS_SUPPORTED
360 png_voidp user_chunk_ptr;
361#ifdef PNG_READ_USER_CHUNKS_SUPPORTED
362 png_user_chunk_ptr read_user_chunk_fn; /* user read chunk handler */
363#endif
364#endif
365
366#ifdef PNG_SET_UNKNOWN_CHUNKS_SUPPORTED
367 int unknown_default; /* As PNG_HANDLE_* */
368 unsigned int num_chunk_list; /* Number of entries in the list */
369 png_bytep chunk_list; /* List of png_byte[5]; the textual chunk name
370 * followed by a PNG_HANDLE_* byte */
371#endif
372
373/* New members added in libpng-1.0.3 */
374#ifdef PNG_READ_RGB_TO_GRAY_SUPPORTED
375 png_byte rgb_to_gray_status;
376 /* Added in libpng 1.5.5 to record setting of coefficients: */
377 png_byte rgb_to_gray_coefficients_set;
378 /* These were changed from png_byte in libpng-1.0.6 */
379 png_uint_16 rgb_to_gray_red_coeff;
380 png_uint_16 rgb_to_gray_green_coeff;
381 /* deleted in 1.5.5: rgb_to_gray_blue_coeff; */
382#endif
383
384/* New member added in libpng-1.6.36 */
385#if defined(PNG_READ_EXPAND_SUPPORTED) && \
386 defined(PNG_ARM_NEON_IMPLEMENTATION)
387 png_bytep riffled_palette; /* buffer for accelerated palette expansion */
388#endif
389
390/* New member added in libpng-1.0.4 (renamed in 1.0.9) */
391#if defined(PNG_MNG_FEATURES_SUPPORTED)
392/* Changed from png_byte to png_uint_32 at version 1.2.0 */
393 png_uint_32 mng_features_permitted;
394#endif
395
396/* New member added in libpng-1.0.9, ifdef'ed out in 1.0.12, enabled in 1.2.0 */
397#ifdef PNG_MNG_FEATURES_SUPPORTED
398 png_byte filter_type;
399#endif
400
401/* New members added in libpng-1.2.0 */
402
403/* New members added in libpng-1.0.2 but first enabled by default in 1.2.0 */
404#ifdef PNG_USER_MEM_SUPPORTED
405 png_voidp mem_ptr; /* user supplied struct for mem functions */
406 png_malloc_ptr malloc_fn; /* function for allocating memory */
407 png_free_ptr free_fn; /* function for freeing memory */
408#endif
409
410/* New member added in libpng-1.0.13 and 1.2.0 */
411 png_bytep big_row_buf; /* buffer to save current (unfiltered) row */
412
413#ifdef PNG_READ_QUANTIZE_SUPPORTED
414/* The following three members were added at version 1.0.14 and 1.2.4 */
415 png_bytep quantize_sort; /* working sort array */
416 png_bytep index_to_palette; /* where the original index currently is
417 in the palette */
418 png_bytep palette_to_index; /* which original index points to this
419 palette color */
420#endif
421
422/* New members added in libpng-1.0.16 and 1.2.6 */
423 png_byte compression_type;
424
425#ifdef PNG_USER_LIMITS_SUPPORTED
426 png_uint_32 user_width_max;
427 png_uint_32 user_height_max;
428
429 /* Added in libpng-1.4.0: Total number of sPLT, text, and unknown
430 * chunks that can be stored (0 means unlimited).
431 */
432 png_uint_32 user_chunk_cache_max;
433
434 /* Total memory that a zTXt, sPLT, iTXt, iCCP, or unknown chunk
435 * can occupy when decompressed. 0 means unlimited.
436 */
437 png_alloc_size_t user_chunk_malloc_max;
438#endif
439
440/* New member added in libpng-1.0.25 and 1.2.17 */
441#ifdef PNG_READ_UNKNOWN_CHUNKS_SUPPORTED
442 /* Temporary storage for unknown chunk that the library doesn't recognize,
443 * used while reading the chunk.
444 */
445 png_unknown_chunk unknown_chunk;
446#endif
447
448/* New member added in libpng-1.2.26 */
449 size_t old_big_row_buf_size;
450
451#ifdef PNG_READ_SUPPORTED
452/* New member added in libpng-1.2.30 */
453 png_bytep read_buffer; /* buffer for reading chunk data */
454 png_alloc_size_t read_buffer_size; /* current size of the buffer */
455#endif
456#ifdef PNG_SEQUENTIAL_READ_SUPPORTED
457 uInt IDAT_read_size; /* limit on read buffer size for IDAT */
458#endif
459
460#ifdef PNG_IO_STATE_SUPPORTED
461/* New member added in libpng-1.4.0 */
462 png_uint_32 io_state;
463#endif
464
465/* New member added in libpng-1.5.6 */
466 png_bytep big_prev_row;
467
468/* New member added in libpng-1.5.7 */
469 void (*read_filter[PNG_FILTER_VALUE_LAST-1])(png_row_infop row_info,
470 png_bytep row, png_const_bytep prev_row);
471
472#ifdef PNG_READ_SUPPORTED
473#if defined(PNG_COLORSPACE_SUPPORTED) || defined(PNG_GAMMA_SUPPORTED)
474 png_colorspace colorspace;
475#endif
476#endif
477};
478#endif /* PNGSTRUCT_H */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette