]> git.saurik.com Git - wxWidgets.git/blame - src/tiff/tiffio.h
Final cleanup
[wxWidgets.git] / src / tiff / tiffio.h
CommitLineData
b47c832e
RR
1/* $Header$ */
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 _TIFFIO_
28#define _TIFFIO_
29
30/*
31 * TIFF I/O Library Definitions.
32 */
33#include "tiff.h"
34
35/*
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.
41 */
42#define TIFFLIB_VERSION 19970127 /* January 27, 1997 */
43
44/*
45 * TIFF is defined as an incomplete type to hide the
46 * library's internal data structures from clients.
47 */
48typedef struct tiff TIFF;
49
50/*
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
56 * tiff.h directly.
57 *
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
64 * return -1.
65 * NB: toff_t is not off_t for many reasons; TIFFs max out at
66 * 32-bit file offsets being the most important
67 */
68typedef uint32 ttag_t; /* directory tag */
69typedef uint16 tdir_t; /* directory index */
70typedef uint16 tsample_t; /* sample number */
71typedef uint32 tstrip_t; /* strip number */
72typedef uint32 ttile_t; /* tile number */
73typedef int32 tsize_t; /* i/o size in bytes */
74typedef void* tdata_t; /* image data ref */
75typedef int32 toff_t; /* file offset */
76
77#if !defined(__WIN32__) && (defined(_WIN32) || defined(WIN32))
78#define __WIN32__
79#endif
80#if defined(_WINDOWS) || defined(__WIN32__) || defined(_Windows)
81#include <windows.h>
82#ifdef __WIN32__
83DECLARE_HANDLE(thandle_t); /* Win32 file handle */
84#else
85typedef HFILE thandle_t; /* client data handle */
86#endif
87#else
88typedef void* thandle_t; /* client data handle */
89#endif
90
91#ifndef NULL
92#define NULL 0
93#endif
94
95/*
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
99 * multiple items.
100 */
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 */
108
109/*
110 * RGBA-style image support.
111 */
112typedef unsigned char TIFFRGBValue; /* 8-bit samples */
113typedef struct _TIFFRGBAImage TIFFRGBAImage;
114/*
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.
123 */
124typedef void (*tileContigRoutine)
125 (TIFFRGBAImage*, uint32*, uint32, uint32, uint32, uint32, int32, int32,
126 unsigned char*);
127typedef void (*tileSeparateRoutine)
128 (TIFFRGBAImage*, uint32*, uint32, uint32, uint32, uint32, int32, int32,
129 unsigned char*, unsigned char*, unsigned char*, unsigned char*);
130/*
131 * RGBA-reader state.
132 */
133typedef struct { /* YCbCr->RGB support */
134 TIFFRGBValue* clamptab; /* range clamping table */
135 int* Cr_r_tab;
136 int* Cb_b_tab;
137 int32* Cr_g_tab;
138 int32* Cb_g_tab;
139 float coeffs[3]; /* cached for repeated use */
140} TIFFYCbCrToRGB;
141
142struct _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 */
154 uint16* greencmap;
155 uint16* bluecmap;
156 /* get image data routine */
157 int (*get)(TIFFRGBAImage*, uint32*, uint32, uint32);
158 union {
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 */
167
168 int row_offset;
169 int col_offset;
170};
171
172/*
173 * Macros for extracting components from the
174 * packed ABGR form returned by TIFFReadRGBAImage.
175 */
176#define TIFFGetR(abgr) ((abgr) & 0xff)
177#define TIFFGetG(abgr) (((abgr) >> 8) & 0xff)
178#define TIFFGetB(abgr) (((abgr) >> 16) & 0xff)
179#define TIFFGetA(abgr) (((abgr) >> 24) & 0xff)
180
181/*
182 * A CODEC is a software package that implements decoding,
183 * encoding, or decoding+encoding of a compression algorithm.
184 * The library provides a collection of builtin codecs.
185 * More codecs may be registered through calls to the library
186 * and/or the builtin implementations may be overridden.
187 */
188typedef int (*TIFFInitMethod)(TIFF*, int);
189typedef struct {
190 char* name;
191 uint16 scheme;
192 TIFFInitMethod init;
193} TIFFCodec;
194
195#include <stdio.h>
196#include <stdarg.h>
197
198#if defined(__cplusplus)
199extern "C" {
200#endif
201typedef void (*TIFFErrorHandler)(const char*, const char*, va_list);
202typedef tsize_t (*TIFFReadWriteProc)(thandle_t, tdata_t, tsize_t);
203typedef toff_t (*TIFFSeekProc)(thandle_t, toff_t, int);
204typedef int (*TIFFCloseProc)(thandle_t);
205typedef toff_t (*TIFFSizeProc)(thandle_t);
206typedef int (*TIFFMapFileProc)(thandle_t, tdata_t*, toff_t*);
207typedef void (*TIFFUnmapFileProc)(thandle_t, tdata_t, toff_t);
208typedef void (*TIFFExtendProc)(TIFF*);
209
210extern const char* TIFFGetVersion(void);
211
212extern const TIFFCodec* TIFFFindCODEC(uint16);
213extern TIFFCodec* TIFFRegisterCODEC(uint16, const char*, TIFFInitMethod);
214extern void TIFFUnRegisterCODEC(TIFFCodec*);
215
216extern tdata_t _TIFFmalloc(tsize_t);
217extern tdata_t _TIFFrealloc(tdata_t, tsize_t);
218extern void _TIFFmemset(tdata_t, int, tsize_t);
219extern void _TIFFmemcpy(tdata_t, const tdata_t, tsize_t);
220extern int _TIFFmemcmp(const tdata_t, const tdata_t, tsize_t);
221extern void _TIFFfree(tdata_t);
222
223extern void TIFFClose(TIFF*);
224extern int TIFFFlush(TIFF*);
225extern int TIFFFlushData(TIFF*);
226extern int TIFFGetField(TIFF*, ttag_t, ...);
227extern int TIFFVGetField(TIFF*, ttag_t, va_list);
228extern int TIFFGetFieldDefaulted(TIFF*, ttag_t, ...);
229extern int TIFFVGetFieldDefaulted(TIFF*, ttag_t, va_list);
230extern int TIFFReadDirectory(TIFF*);
231extern tsize_t TIFFScanlineSize(TIFF*);
232extern tsize_t TIFFRasterScanlineSize(TIFF*);
233extern tsize_t TIFFStripSize(TIFF*);
234extern tsize_t TIFFVStripSize(TIFF*, uint32);
235extern tsize_t TIFFTileRowSize(TIFF*);
236extern tsize_t TIFFTileSize(TIFF*);
237extern tsize_t TIFFVTileSize(TIFF*, uint32);
238extern uint32 TIFFDefaultStripSize(TIFF*, uint32);
239extern void TIFFDefaultTileSize(TIFF*, uint32*, uint32*);
240extern int TIFFFileno(TIFF*);
241extern int TIFFGetMode(TIFF*);
242extern int TIFFIsTiled(TIFF*);
243extern int TIFFIsByteSwapped(TIFF*);
244extern int TIFFIsUpSampled(TIFF*);
245extern int TIFFIsMSB2LSB(TIFF*);
246extern uint32 TIFFCurrentRow(TIFF*);
247extern tdir_t TIFFCurrentDirectory(TIFF*);
248extern tdir_t TIFFNumberOfDirectories(TIFF*);
249extern uint32 TIFFCurrentDirOffset(TIFF*);
250extern tstrip_t TIFFCurrentStrip(TIFF*);
251extern ttile_t TIFFCurrentTile(TIFF*);
252extern int TIFFReadBufferSetup(TIFF*, tdata_t, tsize_t);
253extern int TIFFWriteBufferSetup(TIFF*, tdata_t, tsize_t);
254extern int TIFFLastDirectory(TIFF*);
255extern int TIFFSetDirectory(TIFF*, tdir_t);
256extern int TIFFSetSubDirectory(TIFF*, uint32);
257extern int TIFFUnlinkDirectory(TIFF*, tdir_t);
258extern int TIFFSetField(TIFF*, ttag_t, ...);
259extern int TIFFVSetField(TIFF*, ttag_t, va_list);
260extern int TIFFWriteDirectory(TIFF *);
261extern int TIFFReassignTagToIgnore(enum TIFFIgnoreSense, int);
262
263#if defined(c_plusplus) || defined(__cplusplus)
264extern void TIFFPrintDirectory(TIFF*, FILE*, long = 0);
265extern int TIFFReadScanline(TIFF*, tdata_t, uint32, tsample_t = 0);
266extern int TIFFWriteScanline(TIFF*, tdata_t, uint32, tsample_t = 0);
267extern int TIFFReadRGBAImage(TIFF*, uint32, uint32, uint32*, int = 0);
268#else
269extern void TIFFPrintDirectory(TIFF*, FILE*, long);
270extern int TIFFReadScanline(TIFF*, tdata_t, uint32, tsample_t);
271extern int TIFFWriteScanline(TIFF*, tdata_t, uint32, tsample_t);
272extern int TIFFReadRGBAImage(TIFF*, uint32, uint32, uint32*, int);
273#endif
274
275extern int TIFFReadRGBAStrip(TIFF*, tstrip_t, uint32 * );
276extern int TIFFReadRGBATile(TIFF*, uint32, uint32, uint32 * );
277extern int TIFFRGBAImageOK(TIFF*, char [1024]);
278extern int TIFFRGBAImageBegin(TIFFRGBAImage*, TIFF*, int, char [1024]);
279extern int TIFFRGBAImageGet(TIFFRGBAImage*, uint32*, uint32, uint32);
280extern void TIFFRGBAImageEnd(TIFFRGBAImage*);
281extern TIFF* TIFFOpen(const char*, const char*);
282extern TIFF* TIFFFdOpen(int, const char*, const char*);
283extern TIFF* TIFFClientOpen(const char*, const char*,
284 thandle_t,
285 TIFFReadWriteProc, TIFFReadWriteProc,
286 TIFFSeekProc, TIFFCloseProc,
287 TIFFSizeProc,
288 TIFFMapFileProc, TIFFUnmapFileProc);
289extern const char* TIFFFileName(TIFF*);
290extern void TIFFError(const char*, const char*, ...);
291extern void TIFFWarning(const char*, const char*, ...);
292extern TIFFErrorHandler TIFFSetErrorHandler(TIFFErrorHandler);
293extern TIFFErrorHandler TIFFSetWarningHandler(TIFFErrorHandler);
294extern TIFFExtendProc TIFFSetTagExtender(TIFFExtendProc);
295extern ttile_t TIFFComputeTile(TIFF*, uint32, uint32, uint32, tsample_t);
296extern int TIFFCheckTile(TIFF*, uint32, uint32, uint32, tsample_t);
297extern ttile_t TIFFNumberOfTiles(TIFF*);
298extern tsize_t TIFFReadTile(TIFF*,
299 tdata_t, uint32, uint32, uint32, tsample_t);
300extern tsize_t TIFFWriteTile(TIFF*,
301 tdata_t, uint32, uint32, uint32, tsample_t);
302extern tstrip_t TIFFComputeStrip(TIFF*, uint32, tsample_t);
303extern tstrip_t TIFFNumberOfStrips(TIFF*);
304extern tsize_t TIFFReadEncodedStrip(TIFF*, tstrip_t, tdata_t, tsize_t);
305extern tsize_t TIFFReadRawStrip(TIFF*, tstrip_t, tdata_t, tsize_t);
306extern tsize_t TIFFReadEncodedTile(TIFF*, ttile_t, tdata_t, tsize_t);
307extern tsize_t TIFFReadRawTile(TIFF*, ttile_t, tdata_t, tsize_t);
308extern tsize_t TIFFWriteEncodedStrip(TIFF*, tstrip_t, tdata_t, tsize_t);
309extern tsize_t TIFFWriteRawStrip(TIFF*, tstrip_t, tdata_t, tsize_t);
310extern tsize_t TIFFWriteEncodedTile(TIFF*, ttile_t, tdata_t, tsize_t);
311extern tsize_t TIFFWriteRawTile(TIFF*, ttile_t, tdata_t, tsize_t);
312extern void TIFFSetWriteOffset(TIFF*, toff_t);
313extern void TIFFSwabShort(uint16*);
314extern void TIFFSwabLong(uint32*);
315extern void TIFFSwabDouble(double*);
316extern void TIFFSwabArrayOfShort(uint16*, unsigned long);
317extern void TIFFSwabArrayOfLong(uint32*, unsigned long);
318extern void TIFFSwabArrayOfDouble(double*, unsigned long);
319extern void TIFFReverseBits(unsigned char *, unsigned long);
320extern const unsigned char* TIFFGetBitRevTable(int);
321#if defined(__cplusplus)
322}
323#endif
324#endif /* _TIFFIO_ */