| | 1 | .\" $Id: TIFFcodec.3tiff,v 1.2 2005/11/02 11:07:18 dron Exp $ |
| | 2 | .\" |
| | 3 | .\" Copyright (c) 1995 Sam Leffler |
| | 4 | .\" Copyright (c) 1995 Silicon Graphics, Inc. |
| | 5 | .\" |
| | 6 | .\" Permission to use, copy, modify, distribute, and sell this software and |
| | 7 | .\" its documentation for any purpose is hereby granted without fee, provided |
| | 8 | .\" that (i) the above copyright notices and this permission notice appear in |
| | 9 | .\" all copies of the software and related documentation, and (ii) the names of |
| | 10 | .\" Sam Leffler and Silicon Graphics may not be used in any advertising or |
| | 11 | .\" publicity relating to the software without the specific, prior written |
| | 12 | .\" permission of Sam Leffler and Silicon Graphics. |
| | 13 | .\" |
| | 14 | .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, |
| | 15 | .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY |
| | 16 | .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. |
| | 17 | .\" |
| | 18 | .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR |
| | 19 | .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, |
| | 20 | .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, |
| | 21 | .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF |
| | 22 | .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE |
| | 23 | .\" OF THIS SOFTWARE. |
| | 24 | .\" |
| | 25 | .if n .po 0 |
| | 26 | .TH CODEC 3TIFF "October 29, 2004" "libtiff" |
| | 27 | .SH NAME |
| | 28 | TIFFFindCODEC, TIFFRegisterCODEC, TIFFUnRegisterCODEC, TIFFIsCODECConfigured |
| | 29 | \- codec-related utility routines |
| | 30 | .SH SYNOPSIS |
| | 31 | .B "#include <tiffio.h>" |
| | 32 | .sp |
| | 33 | .BI "const TIFFCodec* TIFFFindCODEC(uint16 " scheme ");" |
| | 34 | .br |
| | 35 | .BI "TIFFCodec* TIFFRegisterCODEC(uint16 " scheme ", const char *" method ", TIFFInitMethod " init ");" |
| | 36 | .br |
| | 37 | .BI "void TIFFUnRegisterCODEC(TIFFCodec *" codec ");" |
| | 38 | .br |
| | 39 | .BI "int TIFFIsCODECConfigured(uint16 " scheme ");" |
| | 40 | .SH DESCRIPTION |
| | 41 | .I libtiff |
| | 42 | supports a variety of compression schemes implemented by software |
| | 43 | .IR codecs . |
| | 44 | Each codec adheres to a modular interface that provides for |
| | 45 | the decoding and encoding of image data; as well as some other |
| | 46 | methods for initialization, setup, cleanup, and the control |
| | 47 | of default strip and tile sizes. |
| | 48 | Codecs are identified by the associated value of the |
| | 49 | .SM TIFF |
| | 50 | .I Compression |
| | 51 | tag; e.g. 5 for |
| | 52 | .SM LZW |
| | 53 | compression. |
| | 54 | .PP |
| | 55 | The |
| | 56 | .I TIFFRegisterCODEC |
| | 57 | routine can be used to |
| | 58 | augment or override the set of codecs available to an application. |
| | 59 | If the specified |
| | 60 | .I scheme |
| | 61 | already has a registered codec then it is |
| | 62 | .I overridden |
| | 63 | and any images with data encoded with this |
| | 64 | compression scheme will be decoded using the supplied coded. |
| | 65 | .PP |
| | 66 | .I TIFFIsCODECConfigured |
| | 67 | returns 1 if the codec is configured and working. Otherwise 0 will be returned. |
| | 68 | .SH DIAGNOSTICS |
| | 69 | .BR "No space to register compression scheme %s" . |
| | 70 | .I TIFFRegisterCODEC |
| | 71 | was unable to allocate memory for the data structures needed |
| | 72 | to register a codec. |
| | 73 | .PP |
| | 74 | .BR "Cannot remove compression scheme %s; not registered" . |
| | 75 | .I TIFFUnRegisterCODEC |
| | 76 | did not locate the specified codec in the table of registered |
| | 77 | compression schemes. |
| | 78 | .SH "SEE ALSO" |
| | 79 | .BR libtiff (3TIFF) |
| | 80 | .PP |
| | 81 | Libtiff library home page: |
| | 82 | .BR http://www.remotesensing.org/libtiff/ |
projects / wxWidgets.git / blame_incremental