Merge XFA to PDFium master at 4dc95e7 on 10/28/2014
[pdfium.git] / core / src / fxcodec / fx_lpng / lpng_v163 / pnginfo.h
1 \r
2 /* pnginfo.h - header file for PNG reference library\r
3  *\r
4  * Copyright (c) 1998-2013 Glenn Randers-Pehrson\r
5  * (Version 0.96 Copyright (c) 1996, 1997 Andreas Dilger)\r
6  * (Version 0.88 Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc.)\r
7  *\r
8  * Last changed in libpng 1.6.1 [March 28, 2013]\r
9  *\r
10  * This code is released under the libpng license.\r
11  * For conditions of distribution and use, see the disclaimer\r
12  * and license in png.h\r
13  */\r
14 \r
15  /* png_info is a structure that holds the information in a PNG file so\r
16  * that the application can find out the characteristics of the image.\r
17  * If you are reading the file, this structure will tell you what is\r
18  * in the PNG file.  If you are writing the file, fill in the information\r
19  * you want to put into the PNG file, using png_set_*() functions, then\r
20  * call png_write_info().\r
21  *\r
22  * The names chosen should be very close to the PNG specification, so\r
23  * consult that document for information about the meaning of each field.\r
24  *\r
25  * With libpng < 0.95, it was only possible to directly set and read the\r
26  * the values in the png_info_struct, which meant that the contents and\r
27  * order of the values had to remain fixed.  With libpng 0.95 and later,\r
28  * however, there are now functions that abstract the contents of\r
29  * png_info_struct from the application, so this makes it easier to use\r
30  * libpng with dynamic libraries, and even makes it possible to use\r
31  * libraries that don't have all of the libpng ancillary chunk-handing\r
32  * functionality.  In libpng-1.5.0 this was moved into a separate private\r
33  * file that is not visible to applications.\r
34  *\r
35  * The following members may have allocated storage attached that should be\r
36  * cleaned up before the structure is discarded: palette, trans, text,\r
37  * pcal_purpose, pcal_units, pcal_params, hist, iccp_name, iccp_profile,\r
38  * splt_palettes, scal_unit, row_pointers, and unknowns.   By default, these\r
39  * are automatically freed when the info structure is deallocated, if they were\r
40  * allocated internally by libpng.  This behavior can be changed by means\r
41  * of the png_data_freer() function.\r
42  *\r
43  * More allocation details: all the chunk-reading functions that\r
44  * change these members go through the corresponding png_set_*\r
45  * functions.  A function to clear these members is available: see\r
46  * png_free_data().  The png_set_* functions do not depend on being\r
47  * able to point info structure members to any of the storage they are\r
48  * passed (they make their own copies), EXCEPT that the png_set_text\r
49  * functions use the same storage passed to them in the text_ptr or\r
50  * itxt_ptr structure argument, and the png_set_rows and png_set_unknowns\r
51  * functions do not make their own copies.\r
52  */\r
53 #ifndef PNGINFO_H\r
54 #define PNGINFO_H\r
55 \r
56 struct png_info_def\r
57 {\r
58    /* The following are necessary for every PNG file */\r
59    png_uint_32 width;  /* width of image in pixels (from IHDR) */\r
60    png_uint_32 height; /* height of image in pixels (from IHDR) */\r
61    png_uint_32 valid;  /* valid chunk data (see PNG_INFO_ below) */\r
62    png_size_t rowbytes; /* bytes needed to hold an untransformed row */\r
63    png_colorp palette;      /* array of color values (valid & PNG_INFO_PLTE) */\r
64    png_uint_16 num_palette; /* number of color entries in "palette" (PLTE) */\r
65    png_uint_16 num_trans;   /* number of transparent palette color (tRNS) */\r
66    png_byte bit_depth;      /* 1, 2, 4, 8, or 16 bits/channel (from IHDR) */\r
67    png_byte color_type;     /* see PNG_COLOR_TYPE_ below (from IHDR) */\r
68    /* The following three should have been named *_method not *_type */\r
69    png_byte compression_type; /* must be PNG_COMPRESSION_TYPE_BASE (IHDR) */\r
70    png_byte filter_type;    /* must be PNG_FILTER_TYPE_BASE (from IHDR) */\r
71    png_byte interlace_type; /* One of PNG_INTERLACE_NONE, PNG_INTERLACE_ADAM7 */\r
72 \r
73    /* The following are set by png_set_IHDR, called from the application on\r
74     * write, but the are never actually used by the write code.\r
75     */\r
76    png_byte channels;       /* number of data channels per pixel (1, 2, 3, 4) */\r
77    png_byte pixel_depth;    /* number of bits per pixel */\r
78    png_byte spare_byte;     /* to align the data, and for future use */\r
79 \r
80 #ifdef PNG_READ_SUPPORTED\r
81    /* This is never set during write */\r
82    png_byte signature[8];   /* magic bytes read by libpng from start of file */\r
83 #endif\r
84 \r
85    /* The rest of the data is optional.  If you are reading, check the\r
86     * valid field to see if the information in these are valid.  If you\r
87     * are writing, set the valid field to those chunks you want written,\r
88     * and initialize the appropriate fields below.\r
89     */\r
90 \r
91 #if defined(PNG_COLORSPACE_SUPPORTED) || defined(PNG_GAMMA_SUPPORTED)\r
92    /* png_colorspace only contains 'flags' if neither GAMMA or COLORSPACE are\r
93     * defined.  When COLORSPACE is switched on all the colorspace-defining\r
94     * chunks should be enabled, when GAMMA is switched on all the gamma-defining\r
95     * chunks should be enabled.  If this is not done it becomes possible to read\r
96     * inconsistent PNG files and assign a probably incorrect interpretation to\r
97     * the information.  (In other words, by carefully choosing which chunks to\r
98     * recognize the system configuration can select an interpretation for PNG\r
99     * files containing ambiguous data and this will result in inconsistent\r
100     * behavior between different libpng builds!)\r
101     */\r
102    png_colorspace colorspace;\r
103 #endif\r
104 \r
105 #ifdef PNG_iCCP_SUPPORTED\r
106    /* iCCP chunk data. */\r
107    png_charp iccp_name;     /* profile name */\r
108    png_bytep iccp_profile;  /* International Color Consortium profile data */\r
109    png_uint_32 iccp_proflen;  /* ICC profile data length */\r
110 #endif\r
111 \r
112 #ifdef PNG_TEXT_SUPPORTED\r
113    /* The tEXt, and zTXt chunks contain human-readable textual data in\r
114     * uncompressed, compressed, and optionally compressed forms, respectively.\r
115     * The data in "text" is an array of pointers to uncompressed,\r
116     * null-terminated C strings. Each chunk has a keyword that describes the\r
117     * textual data contained in that chunk.  Keywords are not required to be\r
118     * unique, and the text string may be empty.  Any number of text chunks may\r
119     * be in an image.\r
120     */\r
121    int num_text; /* number of comments read or comments to write */\r
122    int max_text; /* current size of text array */\r
123    png_textp text; /* array of comments read or comments to write */\r
124 #endif /* PNG_TEXT_SUPPORTED */\r
125 \r
126 #ifdef PNG_tIME_SUPPORTED\r
127    /* The tIME chunk holds the last time the displayed image data was\r
128     * modified.  See the png_time struct for the contents of this struct.\r
129     */\r
130    png_time mod_time;\r
131 #endif\r
132 \r
133 #ifdef PNG_sBIT_SUPPORTED\r
134    /* The sBIT chunk specifies the number of significant high-order bits\r
135     * in the pixel data.  Values are in the range [1, bit_depth], and are\r
136     * only specified for the channels in the pixel data.  The contents of\r
137     * the low-order bits is not specified.  Data is valid if\r
138     * (valid & PNG_INFO_sBIT) is non-zero.\r
139     */\r
140    png_color_8 sig_bit; /* significant bits in color channels */\r
141 #endif\r
142 \r
143 #if defined(PNG_tRNS_SUPPORTED) || defined(PNG_READ_EXPAND_SUPPORTED) || \\r
144 defined(PNG_READ_BACKGROUND_SUPPORTED)\r
145    /* The tRNS chunk supplies transparency data for paletted images and\r
146     * other image types that don't need a full alpha channel.  There are\r
147     * "num_trans" transparency values for a paletted image, stored in the\r
148     * same order as the palette colors, starting from index 0.  Values\r
149     * for the data are in the range [0, 255], ranging from fully transparent\r
150     * to fully opaque, respectively.  For non-paletted images, there is a\r
151     * single color specified that should be treated as fully transparent.\r
152     * Data is valid if (valid & PNG_INFO_tRNS) is non-zero.\r
153     */\r
154    png_bytep trans_alpha;    /* alpha values for paletted image */\r
155    png_color_16 trans_color; /* transparent color for non-palette image */\r
156 #endif\r
157 \r
158 #if defined(PNG_bKGD_SUPPORTED) || defined(PNG_READ_BACKGROUND_SUPPORTED)\r
159    /* The bKGD chunk gives the suggested image background color if the\r
160     * display program does not have its own background color and the image\r
161     * is needs to composited onto a background before display.  The colors\r
162     * in "background" are normally in the same color space/depth as the\r
163     * pixel data.  Data is valid if (valid & PNG_INFO_bKGD) is non-zero.\r
164     */\r
165    png_color_16 background;\r
166 #endif\r
167 \r
168 #ifdef PNG_oFFs_SUPPORTED\r
169    /* The oFFs chunk gives the offset in "offset_unit_type" units rightwards\r
170     * and downwards from the top-left corner of the display, page, or other\r
171     * application-specific co-ordinate space.  See the PNG_OFFSET_ defines\r
172     * below for the unit types.  Valid if (valid & PNG_INFO_oFFs) non-zero.\r
173     */\r
174    png_int_32 x_offset; /* x offset on page */\r
175    png_int_32 y_offset; /* y offset on page */\r
176    png_byte offset_unit_type; /* offset units type */\r
177 #endif\r
178 \r
179 #ifdef PNG_pHYs_SUPPORTED\r
180    /* The pHYs chunk gives the physical pixel density of the image for\r
181     * display or printing in "phys_unit_type" units (see PNG_RESOLUTION_\r
182     * defines below).  Data is valid if (valid & PNG_INFO_pHYs) is non-zero.\r
183     */\r
184    png_uint_32 x_pixels_per_unit; /* horizontal pixel density */\r
185    png_uint_32 y_pixels_per_unit; /* vertical pixel density */\r
186    png_byte phys_unit_type; /* resolution type (see PNG_RESOLUTION_ below) */\r
187 #endif\r
188 \r
189 #ifdef PNG_hIST_SUPPORTED\r
190    /* The hIST chunk contains the relative frequency or importance of the\r
191     * various palette entries, so that a viewer can intelligently select a\r
192     * reduced-color palette, if required.  Data is an array of "num_palette"\r
193     * values in the range [0,65535]. Data valid if (valid & PNG_INFO_hIST)\r
194     * is non-zero.\r
195     */\r
196    png_uint_16p hist;\r
197 #endif\r
198 \r
199 #ifdef PNG_pCAL_SUPPORTED\r
200    /* The pCAL chunk describes a transformation between the stored pixel\r
201     * values and original physical data values used to create the image.\r
202     * The integer range [0, 2^bit_depth - 1] maps to the floating-point\r
203     * range given by [pcal_X0, pcal_X1], and are further transformed by a\r
204     * (possibly non-linear) transformation function given by "pcal_type"\r
205     * and "pcal_params" into "pcal_units".  Please see the PNG_EQUATION_\r
206     * defines below, and the PNG-Group's PNG extensions document for a\r
207     * complete description of the transformations and how they should be\r
208     * implemented, and for a description of the ASCII parameter strings.\r
209     * Data values are valid if (valid & PNG_INFO_pCAL) non-zero.\r
210     */\r
211    png_charp pcal_purpose;  /* pCAL chunk description string */\r
212    png_int_32 pcal_X0;      /* minimum value */\r
213    png_int_32 pcal_X1;      /* maximum value */\r
214    png_charp pcal_units;    /* Latin-1 string giving physical units */\r
215    png_charpp pcal_params;  /* ASCII strings containing parameter values */\r
216    png_byte pcal_type;      /* equation type (see PNG_EQUATION_ below) */\r
217    png_byte pcal_nparams;   /* number of parameters given in pcal_params */\r
218 #endif\r
219 \r
220 /* New members added in libpng-1.0.6 */\r
221    png_uint_32 free_me;     /* flags items libpng is responsible for freeing */\r
222 \r
223 #ifdef PNG_STORE_UNKNOWN_CHUNKS_SUPPORTED\r
224    /* Storage for unknown chunks that the library doesn't recognize. */\r
225    png_unknown_chunkp unknown_chunks;\r
226 \r
227    /* The type of this field is limited by the type of \r
228     * png_struct::user_chunk_cache_max, else overflow can occur.\r
229     */\r
230    int                unknown_chunks_num;\r
231 #endif\r
232 \r
233 #ifdef PNG_sPLT_SUPPORTED\r
234    /* Data on sPLT chunks (there may be more than one). */\r
235    png_sPLT_tp splt_palettes;\r
236    int         splt_palettes_num; /* Match type returned by png_get API */\r
237 #endif\r
238 \r
239 #ifdef PNG_sCAL_SUPPORTED\r
240    /* The sCAL chunk describes the actual physical dimensions of the\r
241     * subject matter of the graphic.  The chunk contains a unit specification\r
242     * a byte value, and two ASCII strings representing floating-point\r
243     * values.  The values are width and height corresponsing to one pixel\r
244     * in the image.  Data values are valid if (valid & PNG_INFO_sCAL) is\r
245     * non-zero.\r
246     */\r
247    png_byte scal_unit;         /* unit of physical scale */\r
248    png_charp scal_s_width;     /* string containing height */\r
249    png_charp scal_s_height;    /* string containing width */\r
250 #endif\r
251 \r
252 #ifdef PNG_INFO_IMAGE_SUPPORTED\r
253    /* Memory has been allocated if (valid & PNG_ALLOCATED_INFO_ROWS)\r
254       non-zero */\r
255    /* Data valid if (valid & PNG_INFO_IDAT) non-zero */\r
256    png_bytepp row_pointers;        /* the image bits */\r
257 #endif\r
258 \r
259 };\r
260 #endif /* PNGINFO_H */\r