Move the sources to trunk
[opencv] / otherlibs / _graphics / src / libtiff / tif_dir.h
1 /* $Id: tif_dir.h,v 1.1 2005/06/17 13:54:52 vp153 Exp $ */
2
3 /*
4  * Copyright (c) 1988-1997 Sam Leffler
5  * Copyright (c) 1991-1997 Silicon Graphics, Inc.
6  *
7  * Permission to use, copy, modify, distribute, and sell this software and 
8  * its documentation for any purpose is hereby granted without fee, provided
9  * that (i) the above copyright notices and this permission notice appear in
10  * all copies of the software and related documentation, and (ii) the names of
11  * Sam Leffler and Silicon Graphics may not be used in any advertising or
12  * publicity relating to the software without the specific, prior written
13  * permission of Sam Leffler and Silicon Graphics.
14  * 
15  * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
16  * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
17  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
18  * 
19  * IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
20  * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
21  * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
22  * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
24  * OF THIS SOFTWARE.
25  */
26
27 #ifndef _TIFFDIR_
28 #define _TIFFDIR_
29 /*
30  * ``Library-private'' Directory-related Definitions.
31  */
32
33 /*
34  * Internal format of a TIFF directory entry.
35  */
36 typedef struct {
37 #define FIELD_SETLONGS  4
38         /* bit vector of fields that are set */
39         unsigned long   td_fieldsset[FIELD_SETLONGS];
40
41         uint32  td_imagewidth, td_imagelength, td_imagedepth;
42         uint32  td_tilewidth, td_tilelength, td_tiledepth;
43         uint32  td_subfiletype;
44         uint16  td_bitspersample;
45         uint16  td_sampleformat;
46         uint16  td_compression;
47         uint16  td_photometric;
48         uint16  td_threshholding;
49         uint16  td_fillorder;
50         uint16  td_orientation;
51         uint16  td_samplesperpixel;
52         uint32  td_rowsperstrip;
53         uint16  td_minsamplevalue, td_maxsamplevalue;
54         double  td_sminsamplevalue, td_smaxsamplevalue;
55         float   td_xresolution, td_yresolution;
56         uint16  td_resolutionunit;
57         uint16  td_planarconfig;
58         float   td_xposition, td_yposition;
59         uint16  td_pagenumber[2];
60         uint16* td_colormap[3];
61         uint16  td_halftonehints[2];
62         uint16  td_extrasamples;
63         uint16* td_sampleinfo;
64         double  td_stonits;
65         char*   td_documentname;
66         char*   td_artist;
67         char*   td_datetime;
68         char*   td_hostcomputer;
69         char*   td_imagedescription;
70         char*   td_make;
71         char*   td_model;
72         char*   td_copyright;
73         char*   td_pagename;
74         tstrip_t td_stripsperimage;
75         tstrip_t td_nstrips;            /* size of offset & bytecount arrays */
76         uint32* td_stripoffset;
77         uint32* td_stripbytecount;
78         int     td_stripbytecountsorted; /* is the bytecount array sorted ascending? */
79         uint16  td_nsubifd;
80         uint32* td_subifd;
81         /* YCbCr parameters */
82         float*  td_ycbcrcoeffs;
83         uint16  td_ycbcrsubsampling[2];
84         uint16  td_ycbcrpositioning;
85         /* Colorimetry parameters */
86         float*  td_whitepoint;
87         float*  td_primarychromas;
88         float*  td_refblackwhite;
89         uint16* td_transferfunction[3];
90         /* CMYK parameters */
91         uint16  td_inkset;
92         uint16  td_ninks;
93         uint16  td_dotrange[2];
94         int     td_inknameslen;
95         char*   td_inknames;
96         char*   td_targetprinter;
97         /* ICC parameters */
98         uint32  td_profileLength;
99         void    *td_profileData;
100         /* Adobe Photoshop tag handling */
101         uint32  td_photoshopLength;
102         void    *td_photoshopData;
103         /* IPTC parameters */
104         uint32  td_richtiffiptcLength;
105         void    *td_richtiffiptcData;
106         /* Begin Pixar Tag values. */
107         uint32  td_imagefullwidth, td_imagefulllength;
108         char*   td_textureformat;
109         char*   td_wrapmodes;
110         float   td_fovcot;
111         float*  td_matrixWorldToScreen;
112         float*  td_matrixWorldToCamera;
113         /* End Pixar Tag Values. */
114         uint32  td_xmlpacketLength;
115         void    *td_xmlpacketData;
116         int     td_customValueCount;
117         TIFFTagValue *td_customValues;
118 } TIFFDirectory;
119
120 /*
121  * Field flags used to indicate fields that have
122  * been set in a directory, and to reference fields
123  * when manipulating a directory.
124  */
125
126 /*
127  * FIELD_IGNORE is used to signify tags that are to
128  * be processed but otherwise ignored.  This permits
129  * antiquated tags to be quietly read and discarded.
130  * Note that a bit *is* allocated for ignored tags;
131  * this is understood by the directory reading logic
132  * which uses this fact to avoid special-case handling
133  */ 
134 #define FIELD_IGNORE                    0
135
136 /* multi-item fields */
137 #define FIELD_IMAGEDIMENSIONS           1
138 #define FIELD_TILEDIMENSIONS            2
139 #define FIELD_RESOLUTION                3
140 #define FIELD_POSITION                  4
141
142 /* single-item fields */
143 #define FIELD_SUBFILETYPE               5
144 #define FIELD_BITSPERSAMPLE             6
145 #define FIELD_COMPRESSION               7
146 #define FIELD_PHOTOMETRIC               8
147 #define FIELD_THRESHHOLDING             9
148 #define FIELD_FILLORDER                 10
149 #define FIELD_DOCUMENTNAME              11
150 #define FIELD_IMAGEDESCRIPTION          12
151 #define FIELD_MAKE                      13
152 #define FIELD_MODEL                     14
153 #define FIELD_ORIENTATION               15
154 #define FIELD_SAMPLESPERPIXEL           16
155 #define FIELD_ROWSPERSTRIP              17
156 #define FIELD_MINSAMPLEVALUE            18
157 #define FIELD_MAXSAMPLEVALUE            19
158 #define FIELD_PLANARCONFIG              20
159 #define FIELD_PAGENAME                  21
160 #define FIELD_RESOLUTIONUNIT            22
161 #define FIELD_PAGENUMBER                23
162 #define FIELD_STRIPBYTECOUNTS           24
163 #define FIELD_STRIPOFFSETS              25
164 #define FIELD_COLORMAP                  26
165 #define FIELD_ARTIST                    27
166 #define FIELD_DATETIME                  28
167 #define FIELD_HOSTCOMPUTER              29
168 /* unused - was FIELD_SOFTWARE          30 */
169 #define FIELD_EXTRASAMPLES              31
170 #define FIELD_SAMPLEFORMAT              32
171 #define FIELD_SMINSAMPLEVALUE           33
172 #define FIELD_SMAXSAMPLEVALUE           34
173 #define FIELD_IMAGEDEPTH                35
174 #define FIELD_TILEDEPTH                 36
175 #define FIELD_HALFTONEHINTS             37
176 #define FIELD_YCBCRCOEFFICIENTS         38
177 #define FIELD_YCBCRSUBSAMPLING          39
178 #define FIELD_YCBCRPOSITIONING          40
179 #define FIELD_REFBLACKWHITE             41
180 #define FIELD_WHITEPOINT                42
181 #define FIELD_PRIMARYCHROMAS            43
182 #define FIELD_TRANSFERFUNCTION          44
183 #define FIELD_INKSET                    45
184 #define FIELD_INKNAMES                  46
185 #define FIELD_DOTRANGE                  47
186 #define FIELD_TARGETPRINTER             48
187 #define FIELD_SUBIFD                    49
188 #define FIELD_NUMBEROFINKS              50
189 #define FIELD_ICCPROFILE                51
190 #define FIELD_PHOTOSHOP                 52
191 #define FIELD_RICHTIFFIPTC              53
192 #define FIELD_STONITS                   54
193 /* Begin PIXAR */
194 #define FIELD_IMAGEFULLWIDTH            55
195 #define FIELD_IMAGEFULLLENGTH           56
196 #define FIELD_TEXTUREFORMAT             57
197 #define FIELD_WRAPMODES                 58
198 #define FIELD_FOVCOT                    59
199 #define FIELD_MATRIX_WORLDTOSCREEN      60
200 #define FIELD_MATRIX_WORLDTOCAMERA      61
201 #define FIELD_COPYRIGHT                 62
202 #define FIELD_XMLPACKET                 63
203 /*      FIELD_CUSTOM (see tiffio.h)     65 */
204 /* end of support for well-known tags; codec-private tags follow */
205 #define FIELD_CODEC                     66      /* base of codec-private tags */
206
207
208 /*
209  * Pseudo-tags don't normally need field bits since they
210  * are not written to an output file (by definition).
211  * The library also has express logic to always query a
212  * codec for a pseudo-tag so allocating a field bit for
213  * one is a waste.   If codec wants to promote the notion
214  * of a pseudo-tag being ``set'' or ``unset'' then it can
215  * do using internal state flags without polluting the
216  * field bit space defined for real tags.
217  */
218 #define FIELD_PSEUDO                    0
219
220 #define FIELD_LAST                      (32*FIELD_SETLONGS-1)
221
222 #define TIFFExtractData(tif, type, v) \
223     ((uint32) ((tif)->tif_header.tiff_magic == TIFF_BIGENDIAN ? \
224         ((v) >> (tif)->tif_typeshift[type]) & (tif)->tif_typemask[type] : \
225         (v) & (tif)->tif_typemask[type]))
226 #define TIFFInsertData(tif, type, v) \
227     ((uint32) ((tif)->tif_header.tiff_magic == TIFF_BIGENDIAN ? \
228         ((v) & (tif)->tif_typemask[type]) << (tif)->tif_typeshift[type] : \
229         (v) & (tif)->tif_typemask[type]))
230
231
232 #define BITn(n)                         (((unsigned long)1L)<<((n)&0x1f)) 
233 #define BITFIELDn(tif, n)               ((tif)->tif_dir.td_fieldsset[(n)/32]) 
234 #define TIFFFieldSet(tif, field)        (BITFIELDn(tif, field) & BITn(field)) 
235 #define TIFFSetFieldBit(tif, field)     (BITFIELDn(tif, field) |= BITn(field))
236 #define TIFFClrFieldBit(tif, field)     (BITFIELDn(tif, field) &= ~BITn(field))
237
238 #define FieldSet(fields, f)             (fields[(f)/32] & BITn(f))
239 #define ResetFieldBit(fields, f)        (fields[(f)/32] &= ~BITn(f))
240
241 #if defined(__cplusplus)
242 extern "C" {
243 #endif
244 extern  void _TIFFSetupFieldInfo(TIFF*);
245 extern  void _TIFFPrintFieldInfo(TIFF*, FILE*);
246 extern  TIFFDataType _TIFFSampleToTagType(TIFF*);
247 extern  const TIFFFieldInfo* _TIFFFindOrRegisterFieldInfo( TIFF *tif,
248                                                            ttag_t tag,
249                                                            TIFFDataType dt );
250 extern  TIFFFieldInfo* _TIFFCreateAnonFieldInfo( TIFF *tif, ttag_t tag,
251                                                  TIFFDataType dt );
252
253 #define _TIFFMergeFieldInfo         TIFFMergeFieldInfo
254 #define _TIFFFindFieldInfo          TIFFFindFieldInfo
255 #define _TIFFFindFieldInfoByName    TIFFFindFieldInfoByName
256 #define _TIFFFieldWithTag           TIFFFieldWithTag
257 #define _TIFFFieldWithName          TIFFFieldWithName
258
259 #if defined(__cplusplus)
260 }
261 #endif
262 #endif /* _TIFFDIR_ */
263
264 /* vim: set ts=8 sts=8 sw=8 noet: */