src/tiff/man/TIFFcodec.3tiff

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