cheng/libtiff
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improvements in the "LIST OF ROUTINES" table as per bug

Browse Source 
http://bugzilla.remotesensing.org/show_bug.cgi?id=545
This commit is contained in:
Andrey Kiselev 2004-11-24 16:20:32 +00:00
parent aec3f3bfd5
commit 326ffc3be2
1 changed files with 120 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

239
man/libtiff.3tiff
View File

@ -1,4 +1,4 @@
.\" $Id: libtiff.3tiff,v 1.1 2004-11-11 14:39:16 dron Exp $ .\" $Id: libtiff.3tiff,v 1.2 2004-11-24 16:20:32 dron Exp $
.\" .\"
.\" Copyright (c) 1988-1997 Sam Leffler .\" Copyright (c) 1988-1997 Sam Leffler
.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
@ -23,7 +23,7 @@
.\" OF THIS SOFTWARE. .\" OF THIS SOFTWARE.
.\" .\"
.if n .po 0 .if n .po 0
.TH INTRO 3TIFF "August 21, 1997" "libtiff" .TH INTRO 3TIFF "November 24, 2004" "libtiff"
.SH NAME .SH NAME
libtiff \- introduction to libtiff \- introduction to
.IR libtiff , .IR libtiff ,
@ -39,12 +39,10 @@ cc file.c
.I libtiff .I libtiff
is a library for reading and writing data files encoded with the is a library for reading and writing data files encoded with the
.I "Tag Image File" .I "Tag Image File"
format, Revision 6.0 (or revision 5.0 or revision 4.0). format, Revision 6.0 (or revision 5.0 or revision 4.0). This file format is
This file format is suitable for archiving multi-color and suitable for archiving multi-color and monochromatic image data.
monochromatic image data.
.PP .PP
The library supports several compression algorithms, as indicated The library supports several compression algorithms, as indicated by the
by the
.I Compression .I Compression
field, including: field, including:
no compression (1), no compression (1),
@ -59,18 +57,16 @@ baseline JPEG compression (7),
word-aligned 1D Huffman compression (32771), word-aligned 1D Huffman compression (32771),
and and
PackBits compression (32773). PackBits compression (32773).
In addition, several nonstandard compression algorithms are supported: In addition, several nonstandard compression algorithms are supported: the
the 4-bit compression algorithm used 4-bit compression algorithm used by the
by the
.I ThunderScan .I ThunderScan
program (32809) (decompression only), program (32809) (decompression only), NeXT's 2-bit compression algorithm
NeXT's 2-bit compression algorithm (32766) (decompression only), (32766) (decompression only), an experimental LZ-style algorithm known as
an experimental LZ-style algorithm known as Deflate (32946), and Deflate (32946), and an experimental CIE LogLuv compression scheme designed
an experimental CIE LogLuv compression scheme designed for images for images with high dynamic range (32845 for LogL and 32845 for LogLuv).
with high dynamic range (32845 for LogL and 32845 for LogLuv). Directory information may be in either little- or big-endian byte order\-byte
Directory information may be in either little- or big-endian byte swapping is automatically done by the library. Data bit ordering may be either
order\-byte swapping is automatically done by the library. Most Significant Bit (\c
Data bit ordering may be either Most Significant Bit (\c
.SM MSB\c .SM MSB\c
) to Least Significant Bit (\c ) to Least Significant Bit (\c
.SM LSB\c .SM LSB\c
@ -94,9 +90,8 @@ Two sets of typedefs are used, one for communication with clients
of the library and one for internal data structures and parsing of the of the library and one for internal data structures and parsing of the
.SM TIFF .SM TIFF
format. format.
The following typedefs are exposed to users either through The following typedefs are exposed to users either through function
function definitions or through parameters passed through the definitions or through parameters passed through the varargs interfaces.
varargs interfaces.
.in +.5i .in +.5i
.sp 5p .sp 5p
.ta +\w'typedef unsigned <\fIthing\fP> uint32; 'u .ta +\w'typedef unsigned <\fIthing\fP> uint32; 'u
@ -121,8 +116,8 @@ Note that
.IR ttile_t , .IR ttile_t ,
and and
.I tsize_t .I tsize_t
are constrained to be no more than 32-bit quantities by are constrained to be no more than 32-bit quantities by 32-bit fields they are
32-bit fields they are stored in in the stored in in the
.SM TIFF .SM TIFF
image. image.
Likewise Likewise
@ -135,106 +130,112 @@ constrains the maximum number of
.SM IFDs .SM IFDs
that may appear in an image and may be an arbitrary size (w/o penalty). that may appear in an image and may be an arbitrary size (w/o penalty).
.I ttag_t .I ttag_t
must be either int, unsigned int, pointer, or double because must be either int, unsigned int, pointer, or double because the library uses
the library uses a varargs interface and a varargs interface and
.SM "ANSI C" .SM "ANSI C"
restricts the type of the parameter before an ellipsis to be a restricts the type of the parameter before an ellipsis to be a promoted type.
promoted type.
.I toff_t .I toff_t
is defined as int32 because TIFF file offsets are (unsigned) 32-bit is defined as int32 because TIFF file offsets are (unsigned) 32-bit
quantities. quantities. A signed value is used because some interfaces return \-1 on
A signed value is used because some interfaces return \-1 on error. error. Finally, note that user-specified data references are passed as opaque
Finally, note that user-specified data references are handles and only cast at the lowest layers where their type is presumed.
passed as opaque handles and only cast at the lowest layers where
their type is presumed.
.SH "LIST OF ROUTINES" .SH "LIST OF ROUTINES"
The following routines are part of the library. The following routines are part of the library. Consult specific manual pages
Consult specific manual pages for details on their operation. for details on their operation; on most systems doing ``man function-name''
The manual page names listed below are for systems will work.
where the full function names can not be encoded in the filesystem; .sp
on most systems doing ``man function-name'' will work.
.sp 5p
.nf .nf
.ta \w'TIFFWriteEncodedStrip'u+2n +\w'Appears on Page'u+2n .ta \w'TIFFCheckpointDirectory'u+2n
\fIName\fP \fIAppears on Page\fP \fIDescription\fP \fIName\fP \fIDescription\fP
.sp 5p .sp 5p
TIFFCheckpointDirectory writedir.3t writes the current state of the directory TIFFCheckpointDirectory writes the current state of the directory
TIFFCheckTile tile.3t very x,y,z,sample is within image TIFFCheckTile very x,y,z,sample is within image
TIFFCIELabToRGBInit color.3t initialize CIE L*a*b* 1976 to RGB conversion state TIFFCIELabToRGBInit initialize CIE L*a*b* 1976 to RGB conversion state
TIFFCIELabToXYZ color.3t perform CIE L*a*b* 1976 to CIE XYZ conversion TIFFCIELabToXYZ perform CIE L*a*b* 1976 to CIE XYZ conversion
TIFFClientOpen open.3t open a file for reading or writing TIFFClientOpen open a file for reading or writing
TIFFClose close.3t close an open file TIFFClose close an open file
TIFFComputeStrip strip.3t return strip containing y,sample TIFFComputeStrip return strip containing y,sample
TIFFComputeTile tile.3t return tile containing x,y,z,sample TIFFComputeTile return tile containing x,y,z,sample
TIFFCurrentDirectory query.3t return index of current directory TIFFCurrentDirectory return index of current directory
TIFFCurrentRow query.3t return index of current scanline TIFFCurrentRow return index of current scanline
TIFFCurrentStrip query.3t return index of current strip TIFFCurrentStrip return index of current strip
TIFFCurrentTile query.3t return index of current tile TIFFCurrentTile return index of current tile
TIFFDataWidth width.3t return the size of TIFF data types TIFFDataWidth return the size of TIFF data types
TIFFError error.3t library error handler TIFFError library error handler
TIFFFdOpen open.3t open a file for reading or writing TIFFFdOpen open a file for reading or writing
TIFFFileName query.3t return name of open file TIFFFileName return name of open file
TIFFFileno query.3t return open file descriptor TIFFFileno return open file descriptor
TIFFFindCODEC codec.3t find standard codec for the specific scheme TIFFFindCODEC find standard codec for the specific scheme
TIFFFlush flush.3t flush all pending writes TIFFFlush flush all pending writes
TIFFFlushData flush.3t flush pending data writes TIFFFlushData flush pending data writes
TIFFGetBitRevTable swab.3t return bit reversal table TIFFGetBitRevTable return bit reversal table
TIFFGetField getfield.3t return tag value in current directory TIFFGetField return tag value in current directory
TIFFGetFieldDefaulted getfield.3t return tag value in current directory TIFFGetFieldDefaulted return tag value in current directory
TIFFGetMode query.3t return open file mode TIFFGetMode return open file mode
TIFFGetVersion query.3t return library version string TIFFGetVersion return library version string
TIFFIsCODECConfigured codec.3t check, whether we have working codec TIFFIsCODECConfigured check, whether we have working codec
TIFFIsTiled query.3t return true if image data is tiled TIFFIsMSB2LSB return true if image data is being returned
TIFFIsByteSwapped query.3t return true if image data is byte-swapped with bit 0 as the most significant bit
TIFFNumberOfStrips strip.3t return number of strips in an image TIFFIsTiled return true if image data is tiled
TIFFNumberOfTiles tile.3t return number of tiles in an image TIFFIsByteSwapped return true if image data is byte-swapped
TIFFOpen open.3t open a file for reading or writing TIFFNumberOfStrips return number of strips in an image
TIFFPrintDirectory print.3t print description of the current directory TIFFNumberOfTiles return number of tiles in an image
TIFFReadBufferSetup rdbuf.3t specify i/o buffer for reading TIFFOpen open a file for reading or writing
TIFFReadDirectory readdir.3t read the next directory TIFFPrintDirectory print description of the current directory
TIFFReadEncodedStrip rdestrip.3t read and decode a strip of data TIFFReadBufferSetup specify i/o buffer for reading
TIFFReadEncodedTile rdetile.3t read and decode a tile of data TIFFReadDirectory read the next directory
TIFFReadRawStrip rdrstrip.3t read a raw strip of data TIFFReadEncodedStrip read and decode a strip of data
TIFFReadRawTile rdrtile.3t read a raw tile of data TIFFReadEncodedTile read and decode a tile of data
TIFFReadRGBAImage rdimage.3t read an image into a fixed format raster TIFFReadRawStrip read a raw strip of data
TIFFReadScanline readline.3t read and decode a row of data TIFFReadRawTile read a raw tile of data
TIFFReadTile readtile.3t read and decode a tile of data TIFFReadRGBAImage read an image into a fixed format raster
TIFFRegisterCODEC codec.3t override standard codec for the specific scheme TIFFReadScanline read and decode a row of data
TIFFReverseBits swab.3t reverse bits in an array of bytes TIFFReadTile read and decode a tile of data
TIFFRGBAImageBegin rgbaimage.3t setup decoder state for TIFFRGBAImageGet TIFFRegisterCODEC override standard codec for the specific scheme
TIFFRGBAImageEnd rgbaimage.3t release TIFFRGBAImage decoder state TIFFReverseBits reverse bits in an array of bytes
TIFFRGBAImageGet rgbaimage.3t read and decode an image TIFFRGBAImageBegin setup decoder state for TIFFRGBAImageGet
TIFFRGBAImageOK rgbaimage.3t is image readable by TIFFRGBAImageGet TIFFRGBAImageEnd release TIFFRGBAImage decoder state
TIFFScanlineSize size.3t return size of a scanline TIFFRGBAImageGet read and decode an image
TIFFSetDirectory setdir.3t set the current directory TIFFRGBAImageOK is image readable by TIFFRGBAImageGet
TIFFSetSubDirectory setdir.3t set the current directory TIFFScanlineSize return size of a scanline
TIFFSetErrorHandler error.3t set error handler function TIFFSetDirectory set the current directory
TIFFSetField setfield.3t set a tag's value in the current directory TIFFSetSubDirectory set the current directory
TIFFSetWarningHandler error.3t set warning handler function TIFFSetErrorHandler set error handler function
TIFFStripSize strip.3t returns size of a strip TIFFSetField set a tag's value in the current directory
TIFFRawStripSize strip.3t returns the number of bytes in a raw strip TIFFSetWarningHandler set warning handler function
TIFFSwabShort swab.3t swap bytes of short TIFFStripSize returns size of a strip
TIFFSwabLong swab.3t swap bytes of long TIFFRawStripSize returns the number of bytes in a raw strip
TIFFSwabArrayOfShort swab.3t swap bytes of an array of shorts TIFFSwabShort swap bytes of short
TIFFSwabArrayOfLong swab.3t swap bytes of an array of longs TIFFSwabLong swap bytes of long
TIFFTileRowSize size.3t return size of a row in a tile TIFFSwabArrayOfShort swap bytes of an array of shorts
TIFFTileSize size.3t return size of a tile TIFFSwabArrayOfLong swap bytes of an array of longs
TIFFUnRegisterCODEC codec.3t unregisters the codec TIFFTileRowSize return size of a row in a tile
TIFFVGetField getfield.3t return tag value in current directory TIFFTileSize return size of a tile
TIFFVGetFieldDefaulted getfield.3t return tag value in current directory TIFFUnRegisterCODEC unregisters the codec
TIFFVSetField setfield.3t set a tag's value in the current directory TIFFVGetField return tag value in current directory
TIFFVStripSize strip.3t returns the number of bytes in a strip TIFFVGetFieldDefaulted return tag value in current directory
TIFFWarning warning.3t library warning handler TIFFVSetField set a tag's value in the current directory
TIFFWriteDirectory writedir.3t write the current directory TIFFVStripSize returns the number of bytes in a strip
TIFFWriteEncodedStrip wrestrip.3t compress and write a strip of data TIFFWarning library warning handler
TIFFWriteEncodedTile wretile.3t compress and write a tile of data TIFFWriteDirectory write the current directory
TIFFWriteRawStrip wrrstrip.3t write a raw strip of data TIFFWriteEncodedStrip compress and write a strip of data
TIFFWriteRawTile wrrtile.3t write a raw tile of data TIFFWriteEncodedTile compress and write a tile of data
TIFFWriteScanline writeline.3t write a scanline of data TIFFWriteRawStrip write a raw strip of data
TIFFWriteTile wrrtile.3t compress and write a tile of data TIFFWriteRawTile write a raw tile of data
TIFFXYZToRGB color.3t perform CIE XYZ to RGB conversion TIFFWriteScanline write a scanline of data
TIFFYCbCrToRGBInit color.3t initialize YCbCr to RGB conversion state TIFFWriteTile compress and write a tile of data
TIFFYCbCrtoRGB color.3t perform YCbCr to RGB conversion TIFFXYZToRGB perform CIE XYZ to RGB conversion
TIFFYCbCrToRGBInit initialize YCbCr to RGB conversion state
TIFFYCbCrtoRGB perform YCbCr to RGB conversion
.sp
Auxiliary functions:
_TIFFfree free memory buffer
_TIFFmalloc dynamically allocate memory buffer
_TIFFmemcmp compare contents of the memory buffers
_TIFFmemcpy copy contents of the one buffer to another
_TIFFmemset fill memory buffer with a constant byte
_TIFFrealloc dynamically reallocate memory buffer
.fi .fi
.SH "TAG USAGE" .SH "TAG USAGE"
The table below lists the The table below lists the
@ -255,7 +256,7 @@ Tags of this sort are considered
tags and the library does not recognize them except when the tags and the library does not recognize them except when the
.I Compression .I Compression
tag has been previously set to the relevant compression scheme. tag has been previously set to the relevant compression scheme.
.sp 5p .sp
.nf .nf
.ta \w'TIFFTAG_JPEGTABLESMODE'u+2n +\w'Value'u+2n +\w'R/W'u+2n .ta \w'TIFFTAG_JPEGTABLESMODE'u+2n +\w'Value'u+2n +\w'R/W'u+2n
\fITag Name\fP \fIValue\fP \fIR/W\fP \fILibrary Use/Notes\fP \fITag Name\fP \fIValue\fP \fIR/W\fP \fILibrary Use/Notes\fP
@ -348,7 +349,7 @@ These tags are termed
.I pseud-tags .I pseud-tags
and are used to control various codec-specific functions within the library. and are used to control various codec-specific functions within the library.
The table below summarizes the defined pseudo-tags. The table below summarizes the defined pseudo-tags.
.sp 5p .sp
.nf .nf
.ta \w'TIFFTAG_JPEGTABLESMODE'u+2n +\w'Codec'u+2n +\w'R/W'u+2n .ta \w'TIFFTAG_JPEGTABLESMODE'u+2n +\w'Codec'u+2n +\w'R/W'u+2n
\fITag Name\fP \fICodec\fP \fIR/W\fP \fILibrary Use/Notes\fP \fITag Name\fP \fICodec\fP \fIR/W\fP \fILibrary Use/Notes\fP