1 /* $Header: /CVS_DB/Eos/util/HP/include/tiffio.h,v 1.1.1.1 2002/02/01 06:33:11 tacyas Exp $ */
4 * Copyright (c) 1988-1997 Sam Leffler
5 * Copyright (c) 1991-1997 Silicon Graphics, Inc.
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.
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.
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
31 * TIFF I/O Library Definitions.
36 * This define can be used in code that requires
37 * compilation-related definitions specific to a
38 * version or versions of the library. Runtime
39 * version checking should be done based on the
40 * string returned by TIFFGetVersion.
42 #define TIFFLIB_VERSION 19970127 /* January 27, 1997 */
45 * TIFF is defined as an incomplete type to hide the
46 * library's internal data structures from clients.
48 typedef struct tiff TIFF;
51 * The following typedefs define the intrinsic size of
52 * data types used in the *exported* interfaces. These
53 * definitions depend on the proper definition of types
54 * in tiff.h. Note also that the varargs interface used
55 * to pass tag types and values uses the types defined in
58 * NB: ttag_t is unsigned int and not unsigned short because
59 * ANSI C requires that the type before the ellipsis be a
60 * promoted type (i.e. one of int, unsigned int, pointer,
61 * or double) and because we defined pseudo-tags that are
62 * outside the range of legal Aldus-assigned tags.
63 * NB: tsize_t is int32 and not uint32 because some functions
65 * NB: toff_t is not off_t for many reasons; TIFFs max out at
66 * 32-bit file offsets being the most important
68 typedef uint32 ttag_t; /* directory tag */
69 typedef uint16 tdir_t; /* directory index */
70 typedef uint16 tsample_t; /* sample number */
71 typedef uint32 tstrip_t; /* strip number */
72 typedef uint32 ttile_t; /* tile number */
73 typedef int32 tsize_t; /* i/o size in bytes */
74 typedef void* tdata_t; /* image data ref */
75 typedef int32 toff_t; /* file offset */
77 #if !defined(__WIN32__) && (defined(_WIN32) || defined(WIN32))
80 #if defined(_WINDOWS) || defined(__WIN32__) || defined(_Windows)
83 DECLARE_HANDLE(thandle_t); /* Win32 file handle */
85 typedef HFILE thandle_t; /* client data handle */
88 typedef void* thandle_t; /* client data handle */
96 * Flags to pass to TIFFPrintDirectory to control
97 * printing of data structures that are potentially
98 * very large. Bit-or these flags to enable printing
101 #define TIFFPRINT_NONE 0x0 /* no extra info */
102 #define TIFFPRINT_STRIPS 0x1 /* strips/tiles info */
103 #define TIFFPRINT_CURVES 0x2 /* color/gray response curves */
104 #define TIFFPRINT_COLORMAP 0x4 /* colormap */
105 #define TIFFPRINT_JPEGQTABLES 0x100 /* JPEG Q matrices */
106 #define TIFFPRINT_JPEGACTABLES 0x200 /* JPEG AC tables */
107 #define TIFFPRINT_JPEGDCTABLES 0x200 /* JPEG DC tables */
110 * RGBA-style image support.
112 typedef unsigned char TIFFRGBValue; /* 8-bit samples */
113 typedef struct _TIFFRGBAImage TIFFRGBAImage;
115 * The image reading and conversion routines invoke
116 * ``put routines'' to copy/image/whatever tiles of
117 * raw image data. A default set of routines are
118 * provided to convert/copy raw image data to 8-bit
119 * packed ABGR format rasters. Applications can supply
120 * alternate routines that unpack the data into a
121 * different format or, for example, unpack the data
122 * and draw the unpacked raster on the display.
124 typedef void (*tileContigRoutine)
125 (TIFFRGBAImage*, uint32*, uint32, uint32, uint32, uint32, int32, int32,
127 typedef void (*tileSeparateRoutine)
128 (TIFFRGBAImage*, uint32*, uint32, uint32, uint32, uint32, int32, int32,
129 unsigned char*, unsigned char*, unsigned char*, unsigned char*);
133 typedef struct { /* YCbCr->RGB support */
134 TIFFRGBValue* clamptab; /* range clamping table */
139 float coeffs[3]; /* cached for repeated use */
142 struct _TIFFRGBAImage {
143 TIFF* tif; /* image handle */
144 int stoponerr; /* stop on read error */
145 int isContig; /* data is packed/separate */
146 int alpha; /* type of alpha data present */
147 uint32 width; /* image width */
148 uint32 height; /* image height */
149 uint16 bitspersample; /* image bits/sample */
150 uint16 samplesperpixel; /* image samples/pixel */
151 uint16 orientation; /* image orientation */
152 uint16 photometric; /* image photometric interp */
153 uint16* redcmap; /* colormap pallete */
156 /* get image data routine */
157 int (*get)(TIFFRGBAImage*, uint32*, uint32, uint32);
159 void (*any)(TIFFRGBAImage*);
160 tileContigRoutine contig;
161 tileSeparateRoutine separate;
162 } put; /* put decoded strip/tile */
163 TIFFRGBValue* Map; /* sample mapping array */
164 uint32** BWmap; /* black&white map */
165 uint32** PALmap; /* palette image map */
166 TIFFYCbCrToRGB* ycbcr; /* YCbCr conversion state */
170 * Macros for extracting components from the
171 * packed ABGR form returned by TIFFReadRGBAImage.
173 #define TIFFGetR(abgr) ((abgr) & 0xff)
174 #define TIFFGetG(abgr) (((abgr) >> 8) & 0xff)
175 #define TIFFGetB(abgr) (((abgr) >> 16) & 0xff)
176 #define TIFFGetA(abgr) (((abgr) >> 24) & 0xff)
179 * A CODEC is a software package that implements decoding,
180 * encoding, or decoding+encoding of a compression algorithm.
181 * The library provides a collection of builtin codecs.
182 * More codecs may be registered through calls to the library
183 * and/or the builtin implementations may be overridden.
185 typedef int (*TIFFInitMethod)(TIFF*, int);
195 #if defined(__cplusplus)
198 typedef void (*TIFFErrorHandler)(const char*, const char*, va_list);
199 typedef tsize_t (*TIFFReadWriteProc)(thandle_t, tdata_t, tsize_t);
200 typedef toff_t (*TIFFSeekProc)(thandle_t, toff_t, int);
201 typedef int (*TIFFCloseProc)(thandle_t);
202 typedef toff_t (*TIFFSizeProc)(thandle_t);
203 typedef int (*TIFFMapFileProc)(thandle_t, tdata_t*, toff_t*);
204 typedef void (*TIFFUnmapFileProc)(thandle_t, tdata_t, toff_t);
205 typedef void (*TIFFExtendProc)(TIFF*);
207 extern const char* TIFFGetVersion(void);
209 extern const TIFFCodec* TIFFFindCODEC(uint16);
210 extern TIFFCodec* TIFFRegisterCODEC(uint16, const char*, TIFFInitMethod);
211 extern void TIFFUnRegisterCODEC(TIFFCodec*);
213 extern tdata_t _TIFFmalloc(tsize_t);
214 extern tdata_t _TIFFrealloc(tdata_t, tsize_t);
215 extern void _TIFFmemset(tdata_t, int, tsize_t);
216 extern void _TIFFmemcpy(tdata_t, const tdata_t, tsize_t);
217 extern int _TIFFmemcmp(const tdata_t, const tdata_t, tsize_t);
218 extern void _TIFFfree(tdata_t);
220 extern void TIFFClose(TIFF*);
221 extern int TIFFFlush(TIFF*);
222 extern int TIFFFlushData(TIFF*);
223 extern int TIFFGetField(TIFF*, ttag_t, ...);
224 extern int TIFFVGetField(TIFF*, ttag_t, va_list);
225 extern int TIFFGetFieldDefaulted(TIFF*, ttag_t, ...);
226 extern int TIFFVGetFieldDefaulted(TIFF*, ttag_t, va_list);
227 extern int TIFFReadDirectory(TIFF*);
228 extern tsize_t TIFFScanlineSize(TIFF*);
229 extern tsize_t TIFFRasterScanlineSize(TIFF*);
230 extern tsize_t TIFFStripSize(TIFF*);
231 extern tsize_t TIFFVStripSize(TIFF*, uint32);
232 extern tsize_t TIFFTileRowSize(TIFF*);
233 extern tsize_t TIFFTileSize(TIFF*);
234 extern tsize_t TIFFVTileSize(TIFF*, uint32);
235 extern uint32 TIFFDefaultStripSize(TIFF*, uint32);
236 extern void TIFFDefaultTileSize(TIFF*, uint32*, uint32*);
237 extern int TIFFFileno(TIFF*);
238 extern int TIFFGetMode(TIFF*);
239 extern int TIFFIsTiled(TIFF*);
240 extern int TIFFIsByteSwapped(TIFF*);
241 extern int TIFFIsUpSampled(TIFF*);
242 extern int TIFFIsMSB2LSB(TIFF*);
243 extern uint32 TIFFCurrentRow(TIFF*);
244 extern tdir_t TIFFCurrentDirectory(TIFF*);
245 extern tdir_t TIFFNumberOfDirectories(TIFF*);
246 extern uint32 TIFFCurrentDirOffset(TIFF*);
247 extern tstrip_t TIFFCurrentStrip(TIFF*);
248 extern ttile_t TIFFCurrentTile(TIFF*);
249 extern int TIFFReadBufferSetup(TIFF*, tdata_t, tsize_t);
250 extern int TIFFWriteBufferSetup(TIFF*, tdata_t, tsize_t);
251 extern int TIFFLastDirectory(TIFF*);
252 extern int TIFFSetDirectory(TIFF*, tdir_t);
253 extern int TIFFSetSubDirectory(TIFF*, uint32);
254 extern int TIFFUnlinkDirectory(TIFF*, tdir_t);
255 extern int TIFFSetField(TIFF*, ttag_t, ...);
256 extern int TIFFVSetField(TIFF*, ttag_t, va_list);
257 extern int TIFFWriteDirectory(TIFF *);
258 #if defined(c_plusplus) || defined(__cplusplus)
259 extern void TIFFPrintDirectory(TIFF*, FILE*, long = 0);
260 extern int TIFFReadScanline(TIFF*, tdata_t, uint32, tsample_t = 0);
261 extern int TIFFWriteScanline(TIFF*, tdata_t, uint32, tsample_t = 0);
262 extern int TIFFReadRGBAImage(TIFF*, uint32, uint32, uint32*, int = 0);
264 extern void TIFFPrintDirectory(TIFF*, FILE*, long);
265 extern int TIFFReadScanline(TIFF*, tdata_t, uint32, tsample_t);
266 extern int TIFFWriteScanline(TIFF*, tdata_t, uint32, tsample_t);
267 extern int TIFFReadRGBAImage(TIFF*, uint32, uint32, uint32*, int);
269 extern int TIFFRGBAImageOK(TIFF*, char [1024]);
270 extern int TIFFRGBAImageBegin(TIFFRGBAImage*, TIFF*, int, char [1024]);
271 extern int TIFFRGBAImageGet(TIFFRGBAImage*, uint32*, uint32, uint32);
272 extern void TIFFRGBAImageEnd(TIFFRGBAImage*);
273 extern TIFF* TIFFOpen(const char*, const char*);
274 extern TIFF* TIFFFdOpen(int, const char*, const char*);
275 extern TIFF* TIFFClientOpen(const char*, const char*,
277 TIFFReadWriteProc, TIFFReadWriteProc,
278 TIFFSeekProc, TIFFCloseProc,
280 TIFFMapFileProc, TIFFUnmapFileProc);
281 extern const char* TIFFFileName(TIFF*);
282 extern void TIFFError(const char*, const char*, ...);
283 extern void TIFFWarning(const char*, const char*, ...);
284 extern TIFFErrorHandler TIFFSetErrorHandler(TIFFErrorHandler);
285 extern TIFFErrorHandler TIFFSetWarningHandler(TIFFErrorHandler);
286 extern TIFFExtendProc TIFFSetTagExtender(TIFFExtendProc);
287 extern ttile_t TIFFComputeTile(TIFF*, uint32, uint32, uint32, tsample_t);
288 extern int TIFFCheckTile(TIFF*, uint32, uint32, uint32, tsample_t);
289 extern ttile_t TIFFNumberOfTiles(TIFF*);
290 extern tsize_t TIFFReadTile(TIFF*,
291 tdata_t, uint32, uint32, uint32, tsample_t);
292 extern tsize_t TIFFWriteTile(TIFF*,
293 tdata_t, uint32, uint32, uint32, tsample_t);
294 extern tstrip_t TIFFComputeStrip(TIFF*, uint32, tsample_t);
295 extern tstrip_t TIFFNumberOfStrips(TIFF*);
296 extern tsize_t TIFFReadEncodedStrip(TIFF*, tstrip_t, tdata_t, tsize_t);
297 extern tsize_t TIFFReadRawStrip(TIFF*, tstrip_t, tdata_t, tsize_t);
298 extern tsize_t TIFFReadEncodedTile(TIFF*, ttile_t, tdata_t, tsize_t);
299 extern tsize_t TIFFReadRawTile(TIFF*, ttile_t, tdata_t, tsize_t);
300 extern tsize_t TIFFWriteEncodedStrip(TIFF*, tstrip_t, tdata_t, tsize_t);
301 extern tsize_t TIFFWriteRawStrip(TIFF*, tstrip_t, tdata_t, tsize_t);
302 extern tsize_t TIFFWriteEncodedTile(TIFF*, ttile_t, tdata_t, tsize_t);
303 extern tsize_t TIFFWriteRawTile(TIFF*, ttile_t, tdata_t, tsize_t);
304 extern void TIFFSetWriteOffset(TIFF*, toff_t);
305 extern void TIFFSwabShort(uint16*);
306 extern void TIFFSwabLong(uint32*);
307 extern void TIFFSwabDouble(double*);
308 extern void TIFFSwabArrayOfShort(uint16*, unsigned long);
309 extern void TIFFSwabArrayOfLong(uint32*, unsigned long);
310 extern void TIFFSwabArrayOfDouble(double*, unsigned long);
311 extern void TIFFReverseBits(unsigned char *, unsigned long);
312 extern const unsigned char* TIFFGetBitRevTable(int);
313 #if defined(__cplusplus)
316 #endif /* _TIFFIO_ */