diff options
| author | Roger Leigh <rleigh@codelibre.net> | 2022-06-24 08:13:56 +0000 |
|---|---|---|
| committer | Roger Leigh <rleigh@codelibre.net> | 2022-06-24 08:13:56 +0000 |
| commit | 3923d24ac28ae91368363e407d2a0e1e88dd1365 (patch) | |
| tree | 763a34860c573e1887c422f18183dc5ab887dede | |
| parent | 8887c9e936749c97f9f515744e4a5696c7f78761 (diff) | |
| parent | ad886e10c57a2c6f03a8923b3c5a6d9d994382db (diff) | |
| download | libtiff-git-3923d24ac28ae91368363e407d2a0e1e88dd1365.tar.gz | |
Merge branch 'sphinx-manpages' into 'master'
doc: Add Sphinx conversion of all manpages
Closes #361
See merge request libtiff/libtiff!356
214 files changed, 8665 insertions, 29495 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 9a25d3e9..561a5de4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -156,7 +156,6 @@ if(tiff-contrib) endif() add_subdirectory(build) if(tiff-docs) - add_subdirectory(man) add_subdirectory(doc) endif() diff --git a/Makefile.am b/Makefile.am index 9f06c10b..254ab7d9 100644 --- a/Makefile.am +++ b/Makefile.am @@ -52,7 +52,7 @@ distcheck-hook: if [ -x "$(CMAKE)" ]; then \ mkdir $(distdir)/_build/cmake \ && cd $(distdir)/_build/cmake \ - && cmake ../.. \ + && cmake -Dsphinx=OFF ../.. \ && $(MAKE) \ && ctest -V \ && $(MAKE) DESTDIR=../../_inst/cmake install ; \ @@ -60,7 +60,7 @@ distcheck-hook: rm -rf $(distdir)/_build/cmake rm -rf $(distdir)/_inst/cmake -SUBDIRS = port libtiff tools build contrib test doc man +SUBDIRS = port libtiff tools build contrib test doc release: (rm -f $(top_srcdir)/RELEASE-DATE && echo $(LIBTIFF_RELEASE_DATE) > $(top_srcdir)/RELEASE-DATE) diff --git a/cmake/Sphinx.cmake b/cmake/Sphinx.cmake index 8b78d41c..bef3bf55 100644 --- a/cmake/Sphinx.cmake +++ b/cmake/Sphinx.cmake @@ -52,12 +52,11 @@ option(sphinx "Enable sphinx manual page and HTML documentation" ${SPHINX_DEFAUL option(sphinx-linkcheck "Check sphinx documentation links by default" OFF) set(BUILD_SPHINX ${sphinx}) +set(SPHINX_LIST_DIR ${CMAKE_CURRENT_LIST_DIR}) -set(_ome_sphinx_list_dir "${CMAKE_CURRENT_LIST_DIR}") - -function(sphinx_manpages srcdir confdir mandir manvar) - execute_process(COMMAND "${Python3_EXECUTABLE}" -B ${_ome_sphinx_list_dir}/list-manpages.py - "${confdir}" "${srcdir}" "${mandir}" +function(sphinx_manpages srcdir builddir manvar) + execute_process(COMMAND "${Python3_EXECUTABLE}" -B ${SPHINX_LIST_DIR}/list-manpages.py + "${srcdir}" "${builddir}" RESULT_VARIABLE sphinx_man_fail OUTPUT_VARIABLE MAN_PAGES) if (sphinx_man_fail) @@ -65,11 +64,12 @@ function(sphinx_manpages srcdir confdir mandir manvar) endif() string(REPLACE "\n" ";" MAN_PAGES "${MAN_PAGES}") set(${manvar} "${MAN_PAGES}" PARENT_SCOPE) + + message(STATUS "Sphinx manual pages: ${MAN_PAGES}") endfunction(sphinx_manpages) -function(sphinx_manpage_dependencies srcdir confdir depvar) - execute_process(COMMAND "${Python3_EXECUTABLE}" -B ${_ome_sphinx_list_dir}/list-manpage-dependencies.py - "${confdir}" +function(sphinx_manpage_dependencies srcdir depvar) + execute_process(COMMAND "${Python3_EXECUTABLE}" -B ${SPHINX_LIST_DIR}/list-manpage-dependencies.py "${srcdir}" RESULT_VARIABLE sphinx_dep_fail OUTPUT_VARIABLE SPHINX_MAN_DEPENDENCIES) @@ -77,6 +77,7 @@ function(sphinx_manpage_dependencies srcdir confdir depvar) message(WARNING "Failed to get Sphinx dependencies from ${confdir}") endif() string(REPLACE "\n" ";" SPHINX_MAN_DEPENDENCIES "${SPHINX_MAN_DEPENDENCIES}") + set(${depvar} "${SPHINX_MAN_DEPENDENCIES}" PARENT_SCOPE) endfunction(sphinx_manpage_dependencies) diff --git a/cmake/list-manpage-dependencies.py b/cmake/list-manpage-dependencies.py index 186507d1..67e79ad5 100644 --- a/cmake/list-manpage-dependencies.py +++ b/cmake/list-manpage-dependencies.py @@ -5,19 +5,24 @@ import importlib.util import os.path +import pathlib import sys if __name__ == "__main__": - if len(sys.argv) != 3: - sys.exit("Usage: %s sphinx-confdir sphinx-srcdir" % (sys.argv[0])) + if len(sys.argv) != 2: + sys.exit("Usage: %s sphinx-srcdir" % (sys.argv[0])) - dir = os.path.abspath(sys.argv[1]) - spec = importlib.util.spec_from_file_location('conf', os.path.join(dir, 'conf.py')) + conf_dir = os.path.abspath(sys.argv[1]) + conf_path = os.path.join(conf_dir, 'conf.py') + spec = importlib.util.spec_from_file_location('conf', conf_path) conf = importlib.util.module_from_spec(spec) + spec.loader.exec_module(conf) if hasattr(conf, 'man_pages'): for man in conf.man_pages: - print(os.path.join(sys.argv[2], "%s%s" % - (man[0], conf.source_suffix))) - print(os.path.join(dir, 'conf.py')) + man_path = os.path.join(sys.argv[1], "{}{}".format(man[0], '.rst')) + man_path_posix = pathlib.PureWindowsPath(man_path).as_posix() + print(man_path_posix) + + print(pathlib.PureWindowsPath(conf_path).as_posix()) diff --git a/cmake/list-manpages.py b/cmake/list-manpages.py index 8087d297..42bf0d83 100644 --- a/cmake/list-manpages.py +++ b/cmake/list-manpages.py @@ -6,18 +6,26 @@ import importlib.util import os.path +import pathlib import sys if __name__ == "__main__": - if len(sys.argv) != 4: - sys.exit("Usage: %s sphinx-confdir sphinx-srcdir manpage-dir" % - (sys.argv[0])) + if len(sys.argv) != 3: + print("Usage: {} sphinx-srcdir sphinx-builddir".format(sys.argv[0]), file=sys.stderr) + sys.exit(2) - dir = os.path.abspath(sys.argv[1]) - spec = importlib.util.spec_from_file_location('conf', os.path.join(dir, 'conf.py')) + conf_dir = os.path.abspath(sys.argv[1]) + conf_path = os.path.join(conf_dir, 'conf.py') + spec = importlib.util.spec_from_file_location('conf', conf_path) conf = importlib.util.module_from_spec(spec) + spec.loader.exec_module(conf) if hasattr(conf, 'man_pages'): for man in conf.man_pages: - print(os.path.join(sys.argv[3], "%s.%s" % (man[1], man[4]))) + man_path = os.path.join(sys.argv[2], "%s.%s" % (man[1], man[4])) + man_path_posix = pathlib.PureWindowsPath(man_path).as_posix() + print(man_path_posix) + else: + print("No man_pages array in {}".format(conf_path), file=sys.stderr) + sys.exit(3) diff --git a/configure.ac b/configure.ac index 9a039228..a0c50b52 100644 --- a/configure.ac +++ b/configure.ac @@ -1135,6 +1135,13 @@ if test "$CHECK_JPEG_YCBCR_SUBSAMPLING" = "yes" ; then fi +for python in python3.9 python3.8 python3.7 python3.6 python3.5 python3.4 python3.3 python3.2 python3.1 python3.0 python3 python; do + AC_CHECK_PROGS(PYTHON_BIN, [$python]) + if test "x$PYTHON_BIN" != "x"; then + break + fi +done + AC_ARG_ENABLE(sphinx, AS_HELP_STRING([--disable-sphinx], [disable building of the sphinx documentation]), @@ -1145,8 +1152,28 @@ AC_ARG_ENABLE(sphinx, AC_PATH_PROG(SPHINX_BUILD, [sphinx-build], [no]) -AM_CONDITIONAL([SPHINX], [test "$BUILD_SPHINX" = yes -a "$SPHINX_BUILD" != no]) +AM_CONDITIONAL([SPHINX], [test "$BUILD_SPHINX" = yes -a "$SPHINX_BUILD" != no -a "x$PYTHON_BIN" != "x"]) + +if test "x$PYTHON_BIN" != "x"; then + AC_MSG_CHECKING([generated manual pages]) + TIFF_MAN1_GEN=$(echo $("$PYTHON_BIN" "${srcdir}/cmake/list-manpages.py" "${srcdir}/doc" man | grep "\.1$")) + TIFF_MAN3_GEN=$(echo $("$PYTHON_BIN" "${srcdir}/cmake/list-manpages.py" "${srcdir}/doc" man | grep "\.3tiff$")) + TIFF_MAN_RULES=$("$PYTHON_BIN" "${srcdir}/cmake/list-manpages.py" "${srcdir}/doc" man | sed -e 's;$;: all-local;') + AC_SUBST([TIFF_MAN1_GEN]) + AC_SUBST([TIFF_MAN3_GEN]) + AC_SUBST([TIFF_MAN_RULES]) + AM_SUBST_NOTMAKE([TIFF_MAN_RULES]) + AC_MSG_RESULT([done]) +fi +if test -d "${srcdir}/doc/man-prebuilt"; then + AC_MSG_CHECKING([prebuilt manual pages]) + TIFF_MAN1_PREBUILT=$(echo $(cd "${srcdir}/doc" && ls -1 man-prebuilt/*.1)) + TIFF_MAN3_PREBUILT=$(echo $(cd "${srcdir}/doc" && ls -1 man-prebuilt/*.3tiff)) + AC_SUBST([TIFF_MAN1_PREBUILT]) + AC_SUBST([TIFF_MAN3_PREBUILT]) + AC_MSG_RESULT([done]) +fi dnl --------------------------------------------------------------------------- @@ -1171,7 +1198,6 @@ AC_CONFIG_FILES([Makefile \ doc/Makefile \ libtiff-4.pc \ libtiff/Makefile \ - man/Makefile \ port/Makefile \ test/Makefile \ tools/Makefile]) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 14a00d8f..6cc3d2e4 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -29,6 +29,9 @@ cmake_minimum_required(VERSION 3.2.0) include(Sphinx) if (BUILD_SPHINX AND SPHINX_BUILD) + # Re-run CMake when the Sphinx configuration is updated + set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/conf.py") + message(STATUS "Checking manual page dependencies") # Create build directory and conf.py @@ -36,10 +39,8 @@ if (BUILD_SPHINX AND SPHINX_BUILD) set(sphinx_builddir "${CMAKE_CURRENT_BINARY_DIR}") file(MAKE_DIRECTORY "${sphinx_builddir}") - sphinx_manpages("${sphinx_srcdir}" "${sphinx_builddir}" - "${PROJECT_BINARY_DIR}/man" MAN_PAGES) - sphinx_manpage_dependencies("${sphinx_srcdir}" "${sphinx_builddir}" - MAN_PAGE_DEPENDENCIES) + sphinx_manpages("${sphinx_srcdir}" "${sphinx_builddir}/man" MAN_PAGES) + sphinx_manpage_dependencies("${sphinx_srcdir}" MAN_PAGE_DEPENDENCIES) sphinx_dependencies("${sphinx_srcdir}" SPHINX_DEPENDENCIES) # Generate and install man pages @@ -52,22 +53,21 @@ if (BUILD_SPHINX AND SPHINX_BUILD) COMMAND ${SPHINX_BUILD} -D "release=${LIBTIFF_VERSION_FULL}" -D "version=${tiff_VERSION_MAJOR}.${tiff_VERSION_MINOR}" - -c "${sphinx_builddir}" -d "${sphinx_builddir}/cache" -b man - "${sphinx_srcdir}" "${PROJECT_BINARY_DIR}/man" + "${sphinx_srcdir}" "${sphinx_builddir}/man" WORKING_DIRECTORY "${sphinx_srcdir}" DEPENDS ${MAN_PAGE_DEPENDENCIES}) - if(NOT TARGET man) - add_custom_target(man ALL) + if(NOT TARGET doc-man) + add_custom_target(doc-man ALL) endif() - add_custom_target(${PROJECT_NAME}-man DEPENDS ${MAN_PAGES}) - add_dependencies(man ${PROJECT_NAME}-man) - set(man_target ${PROJECT_NAME}-man) + add_custom_target(${PROJECT_NAME}-doc-man DEPENDS ${MAN_PAGES}) + add_dependencies(doc-man ${PROJECT_NAME}-doc-man) + set(man_target ${PROJECT_NAME}-doc-man) foreach (man ${MAN_PAGES}) - string(REGEX REPLACE ".*(.)\$" "\\1" man_section "${man}") + string(REGEX REPLACE ".*\\.([0-9])[a-z]*\$" "\\1" man_section "${man}") install(FILES "${man}" DESTINATION "${CMAKE_INSTALL_MANDIR}/man${man_section}" COMPONENT "runtime") @@ -118,7 +118,7 @@ if (BUILD_SPHINX AND SPHINX_BUILD) "${sphinx_srcdir}" "${sphinx_builddir}/linkcheck" COMMENT "Checking remote links in sphinx documentation" WORKING_DIRECTORY "${sphinx_srcdir}" - DEPENDS doc-api ${man_target} ${SPHINX_DEPENDENCIES}) + DEPENDS ${man_target} ${SPHINX_DEPENDENCIES}) add_dependencies(doc-linkcheck ${PROJECT_NAME}-doc-linkcheck) if(NOT TARGET doc-locallinkcheck) @@ -144,78 +144,3 @@ elseif(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/html-prebuilt/") else() message(WARNING "Manual pages and HTML manual will not be generated or installed") endif() - -set(html_manpages - libtiff.3tiff.html - TIFFbuffer.3tiff.html - TIFFClose.3tiff.html - TIFFcodec.3tiff.html - TIFFcolor.3tiff.html - TIFFDataWidth.3tiff.html - TIFFError.3tiff.html - TIFFFieldDataType.3tiff.html - TIFFFieldName.3tiff.html - TIFFFieldPassCount.3tiff.html - TIFFFieldReadCount.3tiff.html - TIFFFieldTag.3tiff.html - TIFFFieldWriteCount.3tiff.html - TIFFFlush.3tiff.html - TIFFGetField.3tiff.html - TIFFmemory.3tiff.html - TIFFOpen.3tiff.html - TIFFPrintDirectory.3tiff.html - TIFFquery.3tiff.html - TIFFReadDirectory.3tiff.html - TIFFReadEncodedStrip.3tiff.html - TIFFReadEncodedTile.3tiff.html - TIFFReadRawStrip.3tiff.html - TIFFReadRawTile.3tiff.html - TIFFReadRGBAImage.3tiff.html - TIFFReadRGBAStrip.3tiff.html - TIFFReadRGBATile.3tiff.html - TIFFReadScanline.3tiff.html - TIFFReadTile.3tiff.html - TIFFRGBAImage.3tiff.html - TIFFSetDirectory.3tiff.html - TIFFSetField.3tiff.html - TIFFsize.3tiff.html - TIFFstrip.3tiff.html - TIFFswab.3tiff.html - TIFFtile.3tiff.html - TIFFWarning.3tiff.html - TIFFWriteDirectory.3tiff.html - TIFFWriteEncodedStrip.3tiff.html - TIFFWriteEncodedTile.3tiff.html - TIFFWriteRawStrip.3tiff.html - TIFFWriteRawTile.3tiff.html - TIFFWriteScanline.3tiff.html - TIFFWriteTile.3tiff.html - fax2ps.1.html - fax2tiff.1.html - pal2rgb.1.html - ppm2tiff.1.html - raw2tiff.1.html - tiff2bw.1.html - tiff2pdf.1.html - tiff2ps.1.html - tiff2rgba.1.html - tiffcmp.1.html - tiffcp.1.html - tiffcrop.1.html - tiffdither.1.html - tiffdump.1.html - tiffgt.1.html - tiffinfo.1.html - tiffmedian.1.html - tiffset.1.html - tiffsplit.1.html) - -# htmldoc target to regenerate HTML files -string(REPLACE ";" "^" escaped_html_manpages "${html_manpages}") -add_custom_target(htmldoc - COMMAND "${CMAKE_COMMAND}" - "-DMANSRCDIR=${PROJECT_SOURCE_DIR}/man" - "-DHTMLMANDIR=${PROJECT_SOURCE_DIR}/doc/static/man" - "-DINDEXFILE=${PROJECT_SOURCE_DIR}/doc/manpages.rst" - "-DDOCFILES=${escaped_html_manpages}" - -P "${CMAKE_CURRENT_SOURCE_DIR}/HtmlDoc.cmake") diff --git a/doc/HtmlDoc.cmake b/doc/HtmlDoc.cmake deleted file mode 100644 index ac28e8e1..00000000 --- a/doc/HtmlDoc.cmake +++ /dev/null @@ -1,52 +0,0 @@ -# CMake documentation generation for libtiff -# -# Copyright © 2015 Open Microscopy Environment / University of Dundee -# Written by Roger Leigh <rleigh@codelibre.net> -# -# Permission to use, copy, modify, distribute, and sell this software and -# its documentation for any purpose is hereby granted without fee, provided -# that (i) the above copyright notices and this permission notice appear in -# all copies of the software and related documentation, and (ii) the names of -# Sam Leffler and Silicon Graphics may not be used in any advertising or -# publicity relating to the software without the specific, prior written -# permission of Sam Leffler and Silicon Graphics. -# -# THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -# EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -# WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -# -# IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -# ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -# OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -# WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -# LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -# OF THIS SOFTWARE. - -string(REPLACE "^" ";" DOCFILES "${DOCFILES}") - -set(INDEXSTART "Manual pages -============ - -") -set(INDEXEND "") - -set(indexcontent "${INDEXSTART} -") - -foreach(doc ${DOCFILES}) - string(REGEX REPLACE "(.*)\\.html$" "\\1" man "${doc}") - execute_process(COMMAND groff -Thtml -mandoc "${MANSRCDIR}/${man}" - OUTPUT_FILE "${HTMLMANDIR}/${doc}" - RESULT_VARIABLE GROFF_STATUS) - if(GROFF_STATUS) - message(FATAL_ERROR "Groff failed to generate HTML manpage") - endif() - message(STATUS "Generated ${HTMLMANDIR}/${doc} from ${MANSRCDIR}/${man}") - - set(indexcontent "${indexcontent}* `${man} <man/${doc}>`_ -") -endforeach() - -set(indexcontent "${indexcontent}${INDEXEND}") -file(WRITE "${INDEXFILE}" "${indexcontent}") -message(STATUS "Generated ${INDEXFILE}") diff --git a/doc/Makefile.am b/doc/Makefile.am index 87938d21..e451248f 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -26,6 +26,7 @@ docdir = $(LIBTIFF_DOCDIR)/manual +if TIFF_DOCS if SPHINX doc-html: $(SPHINX_BUILD) \ @@ -35,16 +36,40 @@ doc-html: -b html \ "$(srcdir)" "$(builddir)/html" -html/index.html: doc-html +doc-man: + $(SPHINX_BUILD) \ + -D "release=$(LIBTIFF_VERSION)" \ + -D "version=$(LIBTIFF_MAJOR_VERSION).$(LIBTIFF_MINOR_VERSION)" \ + -d "$(builddir)/cache" \ + -b man \ + "$(srcdir)" "$(builddir)/man" -all-local: html/index.html +man1_MANS = $(TIFF_MAN1_GEN) +man3_MANS = $(TIFF_MAN3_GEN) + +@TIFF_MAN_RULES@ + +all-local: doc-html doc-man clean-local: rm -r html + rm -r man rm -r cache html_installdir = html else +# Sphinx not available +doc-html: + echo "HTML documentation generation not configured (sphinx not available)" + exit 1 + +doc-man: + echo "Manual page documentation generation not configured (sphinx not available)" + exit 1 + +man1_MANS = $(TIFF_MAN1_PREBUILT) +man3_MANS = $(TIFF_MAN3_PREBUILT) + html_installdir = $(srcdir)/html-prebuilt endif @@ -63,96 +88,170 @@ install-data-local: all-local uninstall-local: echo "rm -r $(DESTDIR)$(docdir)" rm -r $(DESTDIR)$(docdir) +else +# Documentation generation disabled +doc-html: + echo "HTML documentation generation not configured" + exit 1 + +doc-man: + echo "Manual page documentation generation not configured" + exit 1 +endif rst_sources = \ - ./index.rst \ - ./build.rst \ - ./internals.rst \ - ./manpages.rst \ - ./project/license.rst \ - ./project/index.rst \ - ./project/acknowledgements.rst \ - ./project/bugs.rst \ - ./project/mailinglist.rst \ - ./addingtags.rst \ - ./specification/index.rst \ - ./specification/bigtiff.rst \ - ./specification/coverage.rst \ - ./specification/technote2.rst \ - ./specification/coverage-bigtiff.rst \ - ./releases/v3.4beta028.rst \ - ./releases/v4.0.9.rst \ - ./releases/v3.9.0.rst \ - ./releases/v4.0.7.rst \ - ./releases/v3.5.7.rst \ - ./releases/v4.0.0.rst \ - ./releases/v3.7.0beta2.rst \ - ./releases/v3.7.1.rst \ - ./releases/index.rst \ - ./releases/v3.8.0.rst \ - ./releases/v4.1.0.rst \ - ./releases/historical.rst \ - ./releases/v3.5.6beta.rst \ - ./releases/v3.6.1.rst \ - ./releases/v4.2.0.rst \ - ./releases/v3.7.0.rst \ - ./releases/v4.0.1.rst \ - ./releases/v3.5.1.rst \ - ./releases/v4.0.10.rst \ - ./releases/v4.0.6.rst \ - ./releases/v4.0.8.rst \ - ./releases/v3.9.1.rst \ - ./releases/v3.4beta029.rst \ - ./releases/v4.3.0.rst \ - ./releases/v3.4beta031.rst \ - ./releases/v3.7.0alpha.rst \ - ./releases/v3.6.0.rst \ - ./releases/v3.4beta036.rst \ - ./releases/v4.0.4beta.rst \ - ./releases/v3.8.1.rst \ - ./releases/v4.4.0.rst \ - ./releases/v3.4beta035.rst \ - ./releases/v3.4beta032.rst \ - ./releases/v3.4beta007.rst \ - ./releases/v3.9.0beta.rst \ - ./releases/v3.8.2.rst \ - ./releases/v3.4beta018.rst \ - ./releases/v3.7.3.rst \ - ./releases/v3.4beta016.rst \ - ./releases/v3.7.4.rst \ - ./releases/v3.5.2.rst \ - ./releases/v4.0.5.rst \ - ./releases/v3.4beta024.rst \ - ./releases/v3.5.5.rst \ - ./releases/v4.0.2.rst \ - ./releases/v3.9.5.rst \ - ./releases/v3.9.2.rst \ - ./releases/v3.4beta033.rst \ - ./releases/v3.4beta034.rst \ - ./releases/v3.9.3.rst \ - ./releases/v3.9.4.rst \ - ./releases/v3.7.0beta.rst \ - ./releases/v3.5.4.rst \ - ./releases/v4.0.3.rst \ - ./releases/v3.5.3.rst \ - ./releases/v4.0.4.rst \ - ./releases/v3.7.2.rst \ - ./tools.rst \ - ./terms.rst \ - ./contrib.rst \ - ./libtiff.rst \ - ./images.rst + index.rst \ + build.rst \ + internals.rst \ + tools/tiffgt.rst \ + tools/tiffdither.rst \ + tools/tiff2pdf.rst \ + tools/tiff2ps.rst \ + tools/ppm2tiff.rst \ + tools/raw2tiff.rst \ + tools/fax2tiff.rst \ + tools/tiffcrop.rst \ + tools/tiff2bw.rst \ + tools/fax2ps.rst \ + tools/thumbnail.rst \ + tools/tiffcmp.rst \ + tools/tiffdump.rst \ + tools/tiff2rgba.rst \ + tools/tiffinfo.rst \ + tools/rgb2ycbcr.rst \ + tools/tiffset.rst \ + tools/tiffsplit.rst \ + tools/tiffmedian.rst \ + tools/pal2rgb.rst \ + tools/tiffcp.rst \ + project/license.rst \ + project/index.rst \ + project/acknowledgements.rst \ + project/bugs.rst \ + project/mailinglist.rst \ + addingtags.rst \ + specification/index.rst \ + specification/bigtiff.rst \ + specification/coverage.rst \ + specification/technote2.rst \ + specification/coverage-bigtiff.rst \ + releases/v3.4beta028.rst \ + releases/v4.0.9.rst \ + releases/v3.9.0.rst \ + releases/v4.0.7.rst \ + releases/v3.5.7.rst \ + releases/v4.0.0.rst \ + releases/v3.7.0beta2.rst \ + releases/v3.7.1.rst \ + releases/index.rst \ + releases/v3.8.0.rst \ + releases/v4.1.0.rst \ + releases/historical.rst \ + releases/v3.5.6beta.rst \ + releases/v3.6.1.rst \ + releases/v4.2.0.rst \ + releases/v3.7.0.rst \ + releases/v4.0.1.rst \ + releases/v3.5.1.rst \ + releases/v4.0.10.rst \ + releases/v4.0.6.rst \ + releases/v4.0.8.rst \ + releases/v3.9.1.rst \ + releases/v3.4beta029.rst \ + releases/v4.3.0.rst \ + releases/v3.4beta031.rst \ + releases/v3.7.0alpha.rst \ + releases/v3.6.0.rst \ + releases/v3.4beta036.rst \ + releases/v4.0.4beta.rst \ + releases/v3.8.1.rst \ + releases/v4.4.0.rst \ + releases/v3.4beta035.rst \ + releases/v3.4beta032.rst \ + releases/v3.4beta007.rst \ + releases/v3.9.0beta.rst \ + releases/v3.8.2.rst \ + releases/v3.4beta018.rst \ + releases/v3.7.3.rst \ + releases/v3.4beta016.rst \ + releases/v3.7.4.rst \ + releases/v3.5.2.rst \ + releases/v4.0.5.rst \ + releases/v3.4beta024.rst \ + releases/v3.5.5.rst \ + releases/v4.0.2.rst \ + releases/v3.9.5.rst \ + releases/v3.9.2.rst \ + releases/v3.4beta033.rst \ + releases/v3.4beta034.rst \ + releases/v3.9.3.rst \ + releases/v3.9.4.rst \ + releases/v3.7.0beta.rst \ + releases/v3.5.4.rst \ + releases/v4.0.3.rst \ + releases/v3.5.3.rst \ + releases/v4.0.4.rst \ + releases/v3.7.2.rst \ + functions.rst \ + tools.rst \ + terms.rst \ + contrib.rst \ + functions/TIFFRGBAImage.rst \ + functions/TIFFGetField.rst \ + functions/TIFFSetDirectory.rst \ + functions/TIFFWriteRawStrip.rst \ + functions/TIFFcolor.rst \ + functions/TIFFstrip.rst \ + functions/TIFFReadDirectory.rst \ + functions/TIFFReadRawTile.rst \ + functions/libtiff.rst \ + functions/TIFFPrintDirectory.rst \ + functions/TIFFsize.rst \ + functions/TIFFReadRGBATile.rst \ + functions/TIFFswab.rst \ + functions/TIFFmemory.rst \ + functions/TIFFtile.rst \ + functions/TIFFReadEncodedTile.rst \ + functions/TIFFWriteDirectory.rst \ + functions/TIFFSetField.rst \ + functions/TIFFWriteScanline.rst \ + functions/TIFFClose.rst \ + functions/TIFFFieldName.rst \ + functions/TIFFFieldReadCount.rst \ + functions/TIFFError.rst \ + functions/TIFFOpen.rst \ + functions/TIFFcodec.rst \ + functions/TIFFFlush.rst \ + functions/TIFFDataWidth.rst \ + functions/TIFFReadRawStrip.rst \ + functions/TIFFReadTile.rst \ + functions/TIFFFieldWriteCount.rst \ + functions/TIFFbuffer.rst \ + functions/TIFFWriteRawTile.rst \ + functions/TIFFWarning.rst \ + functions/TIFFFieldDataType.rst \ + functions/TIFFWriteEncodedStrip.rst \ + functions/TIFFFieldPassCount.rst \ + functions/TIFFReadRGBAImage.rst \ + functions/TIFFReadScanline.rst \ + functions/TIFFReadEncodedStrip.rst \ + functions/TIFFFieldTag.rst \ + functions/TIFFWriteTile.rst \ + functions/TIFFReadRGBAStrip.rst \ + functions/TIFFquery.rst \ + functions/TIFFWriteEncodedTile.rst \ + libtiff.rst \ + images.rst EXTRA_DIST = \ CMakeLists.txt \ - HtmlDoc.cmake \ conf.py \ specification/bigtiffpr_images \ images \ - static \ $(rst_sources) -dist-hook: doc-html +dist-hook: doc-html doc-man cp -r html $(distdir)/html-prebuilt + cp -r man $(distdir)/man-prebuilt -.PHONY: doc-html +.PHONY: doc-html doc-man diff --git a/doc/build.rst b/doc/build.rst index 86652924..96b3af5f 100644 --- a/doc/build.rst +++ b/doc/build.rst @@ -19,14 +19,14 @@ generate build files for most common build systems and IDEs, and supports all UNIX-like systems as well as Windows. See the `CMake website <http://www.cmake.org/>`_ for further details. To build the software on you need to first run -:program:`cmake` to configure the build and generate the system-specific +:command:`cmake` to configure the build and generate the system-specific build files. This reads the top-level :file:`CMakeLists.txt` file, which probes the target system for necessary tools and functions, checks any options you specified to configure the build, and then outputs build files configured for your system. If using ``Unix Makefiles``, once configuration is done, you simply -run :program:`make` (or :program:`gmake`) to build the software and -then ``make install`` to do the installation. For other build +run :command:`make` (or :command:`gmake`) to build the software and +then :command:`make install` to do the installation. For other build systems, you do the equivalent steps with the tool for that system. For example, on any UNIX system: @@ -90,21 +90,20 @@ the build procedure. This second scheme is useful for: * building multiple targets from a single source tree -* building from a read-only source tree (e.g. if you receive the -distribution on CD-ROM) +* building from a read-only source tree * sharing the source files via a network, but building on -multiple systems + multiple systems * keeping the source tree clean -(unlike :program:`autoconf`, :program:`cmake` does not provide -a ``distclean`` target, so out of source builds are -recommended) + (unlike :program:`autoconf`, :program:`cmake` does not provide + a ``distclean`` target, so out of source builds are + recommended) Generators ^^^^^^^^^^ The default generator for UNIX is ``Unix Makefiles``, and on Windows is ``NMake Makefiles`` or ``MSBuild`` depending upon the setup. -Run ``cmake --help`` to list all the +Run :command:`cmake --help` to list all the generators available for your platform. For example, to use the Ninja `build system <https://martine.github.io/ninja/>`_ on UNIX or Windows: @@ -116,7 +115,7 @@ Windows: ctest -V cmake --build . --target install -Note that ``cmake --build .`` is a build-system-independent way +Note that :command:`cmake --build .` is a build-system-independent way of building a target; you can always use the build system directly. Alternatively, using the MSBuild system on Windows (64-bit Release @@ -141,7 +140,7 @@ installation, and operation of the software. The :file:`CMakeLists.txt` script runs a series of tests to decide whether or not the target system supports required functionality and, if it does not, whether it can emulate or -workaround the missing functions. After running :program:`cmake`, check +workaround the missing functions. After running :command:`cmake`, check the :file:`CMakeCache.txt` file; this contains all the results of the checks performed and the options set by the user. If :program:`cmake` failed to run, check :file:`CMakeFiles/CMakeOutput.log` @@ -153,32 +152,50 @@ configuration parameters for the software. Of particular note are the directories where the software is to be installed. By default the software is installed in the :file:`/usr/local` hierarchy. To change this behaviour the appropriate parameters can be specified on the -command line. Run ``cmake --help`` to get a full list of possible -options, and ``cmake -LH`` to list all the configurable options for -this software package, or ``cmake -LAH`` to show all advanced +command line. Run :command:`cmake --help` to get a full list of possible +options, and :command:`cmake -LH` to list all the configurable options for +this software package, or :command:`cmake -LAH` to show all advanced options in addition. Standard installation related options are shown below. -:: - - Installation directories: - CMAKE_INSTALL_PREFIX - - Fine tuning of the installation directories: - CMAKE_INSTALL_BINDIR user executables [PREFIX/bin] - CMAKE_INSTALL_SBINDIR system admin executables [PREFIX/sbin] - CMAKE_INSTALL_LIBEXECDIR program executables [PREFIX/libexec] - CMAKE_INSTALL_SYSCONFDIR read-only single-machine data [PREFIX/etc] - CMAKE_INSTALL_SHAREDSTATEDIR modifiable architecture-independent data [PREFIX/com] - CMAKE_INSTALL_LOCALSTATEDIR modifiable single-machine data [PREFIX/var] - CMAKE_INSTALL_LIBDIR object code libraries [PREFIX/lib] - CMAKE_INSTALL_INCLUDEDIR C header files [PREFIX/include] - CMAKE_INSTALL_OLDINCLUDEDIR C header files for non-gcc [/usr/include] - CMAKE_INSTALL_DATAROOTDIR read-only arch.-independent data root [PREFIX/share] - CMAKE_INSTALL_DATADIR read-only architecture-independent data [DATAROOTDIR] - CMAKE_INSTALL_LOCALEDIR locale-dependent data [DATAROOTDIR/locale] - CMAKE_INSTALL_MANDIR man documentation [DATAROOTDIR/man] - CMAKE_INSTALL_DOCDIR documentation root [DATAROOTDIR/doc/tiff] + .. list-table:: Installation options + :widths: 10 15 + :header-rows: 1 + + * - Option + - Description + + * - ``CMAKE_INSTALL_PREFIX`` + - Installation root directory. The options below may be used to override + individual installation locations. + * - ``CMAKE_INSTALL_BINDIR`` + - user executables [:file:`PREFIX/bin`] + * - ``CMAKE_INSTALL_SBINDIR`` + - system admin executables [:file:`PREFIX/sbin`] + * - ``CMAKE_INSTALL_LIBEXECDIR`` + - program executables [:file:`PREFIX/libexec`] + * - ``CMAKE_INSTALL_SYSCONFDIR`` + - read-only single-machine data [:file:`PREFIX/etc`] + * - ``CMAKE_INSTALL_SHAREDSTATEDIR`` + - modifiable architecture-independent data [:file:`PREFIX/com`] + * - ``CMAKE_INSTALL_LOCALSTATEDIR`` + - modifiable single-machine data [:file:`PREFIX/var`] + * - ``CMAKE_INSTALL_LIBDIR`` + - object code libraries [:file:`PREFIX/lib`] + * - ``CMAKE_INSTALL_INCLUDEDIR`` + - C header files [:file:`PREFIX/include`] + * - ``CMAKE_INSTALL_OLDINCLUDEDIR`` + - C header files for non-gcc [:file:`/usr/include`] + * - ``CMAKE_INSTALL_DATAROOTDIR`` + - read-only architecture-independent data root [:file:`PREFIX/share`] + * - ``CMAKE_INSTALL_DATADIR`` + - read-only architecture-independent data [:file:`DATAROOTDIR`] + * - ``CMAKE_INSTALL_LOCALEDIR`` + - locale-dependent data [:file:`DATAROOTDIR/locale`] + * - ``CMAKE_INSTALL_MANDIR`` + - man documentation [:file:`DATAROOTDIR/man`] + * - ``CMAKE_INSTALL_DOCDIR`` + - documentation root [:file:`DATAROOTDIR/doc/tiff`] Also see the CMake `documentation <http://www.cmake.org/cmake/help/latest/>`_ @@ -252,13 +269,15 @@ Mark Adler; this software is available at `<http://www.zlib.org/>`_. Building on a UNIX System with Autoconf --------------------------------------- +.. program:: configure + To build the software on a UNIX system you need to first run the :program:`configure` shell script that is located in the top level of the source directory. This script probes the target system for necessary tools and functions and constructs a build environment in which the software may be compiled. Once configuration is done, you -simply run :program:`make` (or :program:`gmake`) to build the software -and then ``make install`` to do the installation; for example: +simply run :command:`make` (or :command:`gmake`) to build the software +and then :command:`make install` to do the installation; for example: .. code-block:: shell @@ -277,15 +296,24 @@ Supplied Makefiles are dependent on a :program:`make` utility and a C In general, the software is designed such that the following should be "make-able" in each directory: -:: - - make [all] build stuff - make check run the test suite - make install build and install stuff - make clean remove object files, executables and cruft - make distclean remove everything, that can be recreated - -Note that after running ``make distclean`` the + .. list-table:: Make targets + :widths: 10 15 + :header-rows: 1 + + * - Target + - Description + * - :command:`make [all]` + - build everything + * - :command:`make check` + - run the test suite + * - :command:`make install` + - build and install everything + * - :command:`make clean` + - remove object files, executables and cruft + * - :command:`make distclean` + - remove everything that can be recreated + +Note that after running :command:`make distclean` the :program:`configure` script must be run again to create the :file:`Makefile` and other make-related files. @@ -324,8 +352,7 @@ the build procedure. This second scheme is useful for: * building multiple targets from a single source tree -* building from a read-only source tree (e.g. if you receive the - distribution on CD-ROM) +* building from a read-only source tree * sharing the source files via a network, but building on multiple systems @@ -348,52 +375,101 @@ configuration parameters for the software. Of particular note are the directories where the software is to be installed. By default the software is installed in the :file:`/usr/local` hierarchy. To change this behaviour the appropriate parameters can be specified -on the command line to configure. Run ``./configure --help`` to +on the command line to configure. Run :command:`./configure --help` to get a full list of possible options. Standard installation related options are shown below. -:: +Installation directories: - Installation directories: - --prefix=PREFIX install architecture-independent files in PREFIX - [/usr/local] - --exec-prefix=EPREFIX install architecture-dependent files in EPREFIX - [PREFIX] +.. option:: --prefix=PREFIX -By default, `make install' will install all the files in -:file:`/usr/local/bin`, :file:`/usr/local/lib` etc. You can specify -an installation prefix other than :file:`/usr/local` using ``--prefix``, -for instance ``--prefix=$HOME``. + install architecture-independent files in *PREFIX* [:file:`/usr/local`] + +.. option:: --exec-prefix=EPREFIX -For better control, use the options below. + install architecture-dependent files in *EPREFIX* [:file:`PREFIX`] + +By default, :command:`make install` will install all the files in +:file:`/usr/local/bin`, :file:`/usr/local/lib` etc. You can specify +an installation prefix other than :file:`/usr/local` using :option:`--prefix`, +for instance ``--prefix=$HOME``. For better control, use the options below. Fine tuning of the installation directories: -:: +.. option:: --bindir=DIR + + user executables [:file:`EPREFIX/bin`] + +.. option:: --sbindir=DIR + + system admin executables [:file:`EPREFIX/sbin`] + +.. option:: --libexecdir=DIR + + program executables [:file:`EPREFIX/libexec`] + +.. option:: --sysconfdir=DIR + + read-only single-machine data [:file:`PREFIX/etc`] + +.. option:: --sharedstatedir=DIR + + modifiable architecture-independent data [:file:`PREFIX/com`] + +.. option:: --localstatedir=DIR + + modifiable single-machine data [:file:`PREFIX/var`] + +.. option:: --libdir=DIR + + object code libraries [:file:`EPREFIX/lib`] + +.. option:: --includedir=DIR + + C header files [:file:`PREFIX/include`] + +.. option:: --oldincludedir=DIR + + C header files for non-gcc [:file:`/usr/include`] + +.. option:: --datarootdir=DIR + + read-only architecture-independent data root [:file:`PREFIX/share`] + +.. option:: --datadir=DIR + + read-only architecture-independent data [:file:`DATAROOTDIR`] + +.. option:: --localedir=DIR + + locale-dependent data [:file:`DATAROOTDIR/locale`] + +.. option:: --mandir=DIR + + man documentation [:file:`DATAROOTDIR/man`] + +.. option:: --docdir=DIR + + documentation root [:file:`DATAROOTDIR/doc/tiff`] + +.. option:: --htmldir=DIR + + html documentation [:file:`DOCDIR`] - --bindir=DIR user executables [EPREFIX/bin] - --sbindir=DIR system admin executables [EPREFIX/sbin] - --libexecdir=DIR program executables [EPREFIX/libexec] - --sysconfdir=DIR read-only single-machine data [PREFIX/etc] - --sharedstatedir=DIR modifiable architecture-independent data [PREFIX/com] - --localstatedir=DIR modifiable single-machine data [PREFIX/var] - --libdir=DIR object code libraries [EPREFIX/lib] - --includedir=DIR C header files [PREFIX/include] - --oldincludedir=DIR C header files for non-gcc [/usr/include] - --datarootdir=DIR read-only arch.-independent data root [PREFIX/share] - --datadir=DIR read-only architecture-independent data [DATAROOTDIR] - --localedir=DIR locale-dependent data [DATAROOTDIR/locale] - --mandir=DIR man documentation [DATAROOTDIR/man] - --docdir=DIR documentation root [DATAROOTDIR/doc/tiff] - --htmldir=DIR html documentation [DOCDIR] Program names: -:: +.. option:: --program-prefix=PREFIX + + prepend *PREFIX* to installed program names + +.. option:: --program-suffix=SUFFIX + +append *SUFFIX* to installed program names + +.. option:: --program-transform-name=PROGRAM - --program-prefix=PREFIX prepend PREFIX to installed program names - --program-suffix=SUFFIX append SUFFIX to installed program names - --program-transform-name=PROGRAM run sed PROGRAM on installed program names + run :command:`sed` *PROGRAM* on installed program names Configuring Optional Packages/Support ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -406,13 +482,13 @@ configure script is run. Packages can be configured via the Static/Shared Objects Support ............................. -``--enable-shared[=PKGS]``: +.. option:: --enable-shared[=PKGS] - Build shared libraries [default=yes] + Build shared libraries [enabled] -``--enable-static[=PKGS]``: +.. option:: --enable-static[=PKGS] - Build static libraries [default=yes] + Build static libraries [enabled] These options control whether or not to configure the software to build a shared and static binaries for the TIFF library. Use of @@ -421,16 +497,16 @@ Static/Shared Objects Support the code is statically linked into each application that uses it. By default both types of binaries are configured. -``--enable-rpath``: +.. option:: --enable-rpath - Enable runtime linker paths (-R libtool option) + Enable runtime linker paths (``-R`` libtool option) Add library directories (see other options below) to the TIFF library run-time linker path. -``--enable-ld-version-script``: +.. option:: --enable-ld-version-script - Enable linker version script (default is disabled) + Enable linker version script [no] Add shared library symbol versioning on ELF-based systems (e.g. Linux and FreeBSD) which use the GNU linker. This is needed if @@ -440,15 +516,15 @@ Static/Shared Objects Support JPEG Support ............ -``--disable-jpeg``: +.. option:: --disable-jpeg Disable IJG JPEG library usage (required for JPEG compression, enabled by default) -``--with-jpeg-include-dir=DIR``: +.. option:: --with-jpeg-include-dir=DIR Location of IJG JPEG library headers -``--with-jpeg-lib-dir=DIR``: +.. option:: --with-jpeg-lib-dir=DIR Location of IJG JPEG library binary) @@ -469,10 +545,8 @@ The ``ZIP`` support enables support for the handling of TIFF images with deflate-encoded data. Support for deflate-encoded data requires the freely available ``zlib`` distribution written by Jean-loup Gailly and Mark Adler; this software is -available at `<http://www.zlib.org/>`_. If ZIP support is -enabled the ``DIRS_LIBINC`` and ``DIR_GZLIB`` parameters -should also be set (see below). By default this package is not -configured. +available at `<http://www.zlib.org/>`_. Support will be +enabled automatically if ``zlib`` is found. Building the Software on Other Systems @@ -497,17 +571,17 @@ example: ./mkg3states -c const tif_fax3sm.c The ``-c`` option can be used to control whether or not the -resutling tables are generated with a ``const`` declaration. +resulting tables are generated with a ``const`` declaration. The ``-s`` option can be used to specify a C storage class for the table declarations. The ``-b`` option can be used to force -data values to be explicitly bracketed with ``{}'' (apparently +data values to be explicitly bracketed with ``{}`` (apparently needed for some MS-Windows compilers); otherwise the structures are emitted in as compact a format as possible. Consult the source code for this program if you have questions. The second file required to build the library, :file:`version.h`, contains the version information returned by the -``TIFFGetVersion`` routine. This file is built on most systems +:c:func:`TIFFGetVersion` routine. This file is built on most systems using the :file:`mkversion` program and the contents of the :file:`VERSION` and :file:`tiff.alpha` files; for example, @@ -528,7 +602,7 @@ building the software. Systems without a 32-bit compiler may not be able to handle some of the codecs in the library; especially the Group 3 and 4 decoder. If you encounter problems try disabling support for a particular -codec; consult the :ref:`internals`. +codec; consult the :doc:`internals`. Programs in the tools directory are written to assume an ANSI C compilation environment. There may be a few POSIX'isms as well. The @@ -540,15 +614,15 @@ emulation routines from the :file:`port` directory. It may be necessary to manually do this work on a non-UNIX system. -Checking out the Software -------------------------- +Testing the software +-------------------- -Assuming you have working versions of :program:`tiffgt` and -:program:`tiffsv`, you can just use them to view any of the sample -images available for testing (see the :ref:`images` section -on obtaining the test images). Otherwise, you can do a cursory -check of the library with the :program:`tiffcp` and :program:`tiffcmp` -programs. For example, +Assuming you have working versions of :doc:`/tools/tiffgt`, you can now use +it to view any of the sample images available for testing, or try +:doc:`/tools/tiffinfo` to display the file metadata. See the +:doc:`images` section on obtaining the test images. Otherwise, you can +do a cursory check of the library with the :doc:`/tools/tiffcp` and +:doc:`/tools.tiffcmp` programs. For example, .. code-block:: shell @@ -559,65 +633,122 @@ programs. For example, correctly). -Table of Contents ------------------ +LibTIFF source files +-------------------- The following files make up the core library: -============================== ================================================ -File Description -============================== ================================================ -libtiff/tiff.h TIFF spec definitions -libtiff/tiffcomp.h non-UNIX OS-compatibility definitions -libtiff/tiffconf.h non-UNIX configuration definitions -libtiff/tiffio.h public TIFF library definitions -libtiff/tiffiop.h private TIFF library definitions -libtiff/t4.h CCITT Group 3/4 code tables+definitions -libtiff/tif_dir.h private defs for TIFF directory handling -libtiff/tif_fax3.h CCITT Group 3/4-related definitions -libtiff/tif_predict.h private defs for Predictor tag support -libtiff/uvcode.h LogL/LogLuv codec-specific definitions -libtiff/version.h version string (generated by Makefile) -libtiff/tif_apple.c Apple-related OS support -libtiff/tif_atari.c Atari-related OS support -libtiff/tif_aux.c auxiliary directory-related functions -libtiff/tif_close.c close an open TIFF file -libtiff/tif_codec.c configuration table of builtin codecs -libtiff/tif_compress.c compression scheme support -libtiff/tif_dir.c directory tag interface code -libtiff/tif_dirinfo.c directory known tag support code -libtiff/tif_dirread.c directory reading code -libtiff/tif_dirwrite.c directory writing code -libtiff/tif_dumpmode.c "no" compression codec -libtiff/tif_error.c library error handler -libtiff/tif_fax3.c CCITT Group 3 and 4 codec -libtiff/tif_fax3sm.c G3/G4 state tables (generated by mkg3states) -libtiff/tif_flush.c i/o and directory state flushing -libtiff/tif_getimage.c TIFFRGBAImage support -libtiff/tif_jpeg.c JPEG codec (interface to the IJG distribution) -libtiff/tif_luv.c SGI LogL/LogLuv codec -libtiff/tif_lzw.c LZW codec -libtiff/tif_msdos.c MSDOS-related OS support -libtiff/tif_next.c NeXT 2-bit scheme codec (decoding only) -libtiff/tif_open.c open and simply query code -libtiff/tif_packbits.c Packbits codec -libtiff/tif_pixarlog.c Pixar codec -libtiff/tif_predict.c Predictor tag support -libtiff/tif_print.c directory printing support -libtiff/tif_read.c image data reading support -libtiff/tif_strip.c some strip-related code -libtiff/tif_swab.c byte and bit swapping support -libtiff/tif_thunder.c Thunderscan codec (decoding only) -libtiff/tif_tile.c some tile-related code -libtiff/tif_unix.c UNIX-related OS support -libtiff/tif_version.c library version support -libtiff/tif_warning.c library warning handler -libtiff/tif_win3.c Windows-3.1-related OS support -libtiff/tif_win32.c Win32 (95/98/NT) related OS support -libtiff/tif_write.c image data writing support -libtiff/tif_zip.c Deflate codec - -libtiff/mkg3states.c program to generate G3/G4 decoder state tables -libtiff/mkspans.c program to generate black-white span tables -libtiff/mkversion.c program to generate libtiff/version.h. -============================== ================================================ + .. list-table:: Core library source files + :widths: 5 15 + :header-rows: 1 + + * - File + - Description + + * - :file:`libtiff/tiff.h` + - TIFF spec definitions + * - :file:`libtiff/tiffconf.h` + - non-UNIX configuration definitions + * - :file:`libtiff/tiffio.h` + - public TIFF library definitions + * - :file:`libtiff/tiffiop.h` + - private TIFF library definitions + * - :file:`libtiff/t4.h` + - CCITT Group 3/4 code tables+definitions + * - :file:`libtiff/tif_dir.h` + - private defs for TIFF directory handling + * - :file:`libtiff/tif_fax3.h` + - CCITT Group 3/4-related definitions + * - :file:`libtiff/tif_predict.h` + - private defs for Predictor tag support + * - :file:`libtiff/tiffvers.h` + - version string + * - :file:`libtiff/uvcode.h` + - LogL/LogLuv codec-specific definitions + * - :file:`libtiff/tif_aux.c` + - auxiliary directory-related functions + * - :file:`libtiff/tif_close.c` + - close an open TIFF file + * - :file:`libtiff/tif_codec.c` + - configuration table of builtin codecs + * - :file:`libtiff/tif_color.c` + - colorspace transforms + * - :file:`libtiff/tif_compress.c` + - compression scheme support + * - :file:`libtiff/tif_dir.c` + - directory tag interface code + * - :file:`libtiff/tif_dirinfo.c` + - directory known tag support code + * - :file:`libtiff/tif_dirread.c` + - directory reading code + * - :file:`libtiff/tif_dirwrite.c` + - directory writing code + * - :file:`libtiff/tif_dumpmode.c` + - "no" compression codec + * - :file:`libtiff/tif_error.c` + - library error handler + * - :file:`libtiff/tif_fax3.c` + - CCITT Group 3 and 4 codec + * - :file:`libtiff/tif_fax3sm.c` + - G3/G4 state tables (generated by mkg3states) + * - :file:`libtiff/tif_flush.c` + - i/o and directory state flushing + * - :file:`libtiff/tif_getimage.c` + - :doc:`/functions/TIFFRGBAImage` support + * - :file:`libtiff/tif_jbig.c` + - JBIG codec + * - :file:`libtiff/tif_jpeg.c` + - JPEG codec (interface to the IJG distribution) + * - :file:`libtiff/tif_jpeg_12.c` + - 12-bit JPEG codec (interface to the IJG distribution) + * - :file:`libtiff/tif_lerc.c` + - LERC codec + * - :file:`libtiff/tif_luv.c` + - SGI LogL/LogLuv codec + * - :file:`libtiff/tif_lzma.c` + - LZMA codec + * - :file:`libtiff/tif_lzw.c` + - LZW codec + * - :file:`libtiff/tif_next.c` + - NeXT 2-bit scheme codec (decoding only) + * - :file:`libtiff/tif_ojpeg.c` + - Old JPEG codec (obsolete, decoding only) + * - :file:`libtiff/tif_open.c` + - open and simply query code + * - :file:`libtiff/tif_packbits.c` + - Packbits codec + * - :file:`libtiff/tif_pixarlog.c` + - Pixar codec + * - :file:`libtiff/tif_predict.c` + - Predictor tag support + * - :file:`libtiff/tif_print.c` + - directory printing support + * - :file:`libtiff/tif_read.c` + - image data reading support + * - :file:`libtiff/tif_strip.c` + - some strip-related code + * - :file:`libtiff/tif_swab.c` + - byte and bit swapping support + * - :file:`libtiff/tif_thunder.c` + - Thunderscan codec (decoding only) + * - :file:`libtiff/tif_tile.c` + - some tile-related code + * - :file:`libtiff/tif_unix.c` + - UNIX-related OS support + * - :file:`libtiff/tif_version.c` + - library version support + * - :file:`libtiff/tif_warning.c` + - library warning handler + * - :file:`libtiff/tif_win32.c` + - Win32 (Windows)-related OS support + * - :file:`libtiff/tif_write.c` + - image data writing support + * - :file:`libtiff/tif_zip.c` + - Deflate codec + * - :file:`libtiff/tif_zstd.c` + - ZSTD codec + + * - :file:`libtiff/mkg3states.c` + - program to generate G3/G4 decoder state tables + * - :file:`libtiff/mkspans.c` + - program to generate black-white span tables diff --git a/doc/conf.py b/doc/conf.py index 212cabfc..52547740 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -84,3 +84,80 @@ html_theme = 'sphinxdoc' html_static_path = ['_static'] html_extra_path = ['static'] + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('functions/libtiff', 'libtiff', 'introduction to libtiff, a library for reading and writing TIFF files', author, '3tiff'), + + ('tools/fax2ps', 'fax2ps', 'convert a TIFF facsimile to compressed PostScriptâ„¢', author, 1), + ('tools/fax2tiff', 'fax2tiff', 'create a TIFF Class F fax file from raw fax data', author, 1), + ('tools/pal2rgb', 'pal2rgb', 'convert a palette color TIFF image to a full color image', author, 1), + ('tools/ppm2tiff', 'ppm2tiff', 'create a TIFF file from PPM, PGM and PBM image files', author, 1), + ('tools/raw2tiff', 'raw2tiff', 'create a TIFF file from a raw data file', author, 1), + ('tools/rgb2ycbcr', 'rgb2ycbcr', 'convert non-YCbCr TIFF images to a YCbCr TIFF image', author, 1), + ('tools/thumbnail', 'thumbnail', 'create a TIFF file with thumbnail images', author, 1), + ('tools/tiff2bw', 'tiff2bw', 'convert a color TIFF image to greyscale', author, 1), + ('tools/tiff2pdf', 'tiff2pdf', 'convert a TIFF image to a PDF document', author, 1), + ('tools/tiff2ps', 'tiff2ps', 'convert TIFF image to PostScriptâ„¢', author, 1), + ('tools/tiff2rgba', 'tiff2rgba', 'convert a TIFF image to RGBA color space', author, 1), + ('tools/tiffcmp', 'tiffcmp', 'compare two TIFF files', author, 1), + ('tools/tiffcp', 'tiffcp', 'copy (and possibly convert) a TIFF file', author, 1), + ('tools/tiffcrop', 'tiffcrop', 'select, copy, crop, convert, extract, and/or process one or more TIFF files', author, 1), + ('tools/tiffdither', 'tiffdither', 'convert a greyscale TIFF image to bilevel using dithering', author, 1), + ('tools/tiffdump', 'tiffdump', 'print verbatim information about TIFF files', author, 1), + ('tools/tiffgt', 'tiffgt', 'display an image stored in a TIFF file (Silicon Graphics version)', author, 1), + ('tools/tiffinfo', 'tiffinfo', 'print information about TIFF files', author, 1), + ('tools/tiffmedian', 'tiffmedian', 'apply the median cut algorithm to data in a TIFF file', author, 1), + ('tools/tiffset', 'tiffset', 'set or unset a field in a TIFF header', author, 1), + ('tools/tiffsplit', 'tiffsplit', 'split a multi-image TIFF into single-image TIFF files', author, 1), + + ('functions/TIFFbuffer', 'TIFFbuffer', 'I/O buffering control routines', author, '3tiff'), + ('functions/TIFFClose', 'TIFFClose', 'close a previously opened TIFF file', author, '3tiff'), + ('functions/TIFFcodec', 'TIFFcodec', 'codec-related utility routines', author, '3tiff'), + ('functions/TIFFcolor', 'TIFFcolor', 'color conversion routines', author, '3tiff'), + ('functions/TIFFDataWidth', 'TIFFDataWidth', 'get the size of TIFF data types', author, '3tiff'), + ('functions/TIFFError', 'TIFFError', 'library error handling interface', author, '3tiff'), + ('functions/TIFFFieldDataType', 'TIFFFieldDataType', 'get TIFF data type from field information', author, '3tiff'), + ('functions/TIFFFieldName', 'TIFFFieldName', 'get TIFF field name from field information', author, '3tiff'), + ('functions/TIFFFieldPassCount', 'TIFFFieldPassCount', 'get whether to pass a count to TIFFGetField/TIFFSetField', author, '3tiff'), + ('functions/TIFFFieldReadCount', 'TIFFFieldReadCount', 'get number of values to be read from field', author, '3tiff'), + ('functions/TIFFFieldTag', 'TIFFFieldTag', 'get TIFF field tag value from field information', author, '3tiff'), + ('functions/TIFFFieldWriteCount', 'TIFFFieldWriteCount', 'get number of values to be written to field', author, '3tiff'), + ('functions/TIFFFlush', 'TIFFFlush', 'flush pending writes to an open TIFF file', author, '3tiff'), + ('functions/TIFFGetField', 'TIFFGetField', 'get the value(s) of a tag in an open TIFF file', author, '3tiff'), + ('functions/TIFFmemory', 'TIFFmemory', 'memory management-related functions for use with TIFF files', author, '3tiff'), + ('functions/TIFFOpen', 'TIFFOpen', 'open a TIFF file for reading or writing', author, '3tiff'), + ('functions/TIFFPrintDirectory', 'TIFFPrintDirectory', 'print a description of a TIFF directory', author, '3tiff'), + ('functions/TIFFquery', 'TIFFquery', 'query routines', author, '3tiff'), + ('functions/TIFFReadDirectory', 'TIFFReadDirectory', 'get the contents of the next directory in an open TIFF file', author, '3tiff'), + ('functions/TIFFReadEncodedStrip', 'TIFFReadEncodedStrip', 'read and decode a strip of data from an open TIFF file', author, '3tiff'), + ('functions/TIFFReadEncodedTile', 'TIFFReadEncodedTile', 'read and decode a tile of data from an open TIFF file', author, '3tiff'), + ('functions/TIFFReadRawStrip', 'TIFFReadRawStrip', 'return the undecoded contents of a strip of data from an open TIFF file', author, '3tiff'), + ('functions/TIFFReadRawTile', 'TIFFReadRawTile', 'return an undecoded tile of data from an open TIFF file', author, '3tiff'), + ('functions/TIFFReadRGBAImage', 'TIFFReadRGBAImage', 'read and decode an image into a fixed-format raster', author, '3tiff'), + ('functions/TIFFReadRGBAStrip', 'TIFFReadRGBAStrip', 'read and decode an image strip into a fixed-format raster', author, '3tiff'), + ('functions/TIFFReadRGBATile', 'TIFFReadRGBATile', 'read and decode an image tile into a fixed-format raster', author, '3tiff'), + ('functions/TIFFReadScanline', 'TIFFReadScanline', 'read and decode a scanline of data from an open TIFF file', author, '3tiff'), + ('functions/TIFFReadTile', 'TIFFReadTile', 'read and decode a tile of data from an open TIFF file', author, '3tiff'), + ('functions/TIFFRGBAImage', 'TIFFRGBAImage', 'read and decode an image into a raster', author, '3tiff'), + ('functions/TIFFSetDirectory', 'TIFFSetDirectory', 'set the current directory for an open TIFF file', author, '3tiff'), + ('functions/TIFFSetField', 'TIFFSetField', 'set the value(s) of a tag in a TIFF file open for writing', author, '3tiff'), + ('functions/TIFFsize', 'TIFFsize', 'return the size of various items associated with an open TIFF file', author, '3tiff'), + ('functions/TIFFstrip', 'TIFFstrip', 'strip-related utility routines', author, '3tiff'), + ('functions/TIFFswab', 'TIFFswab', 'byte- and bit-swapping routines', author, '3tiff'), + ('functions/TIFFtile', 'TIFFtile', 'tile-related utility routines', author, '3tiff'), + ('functions/TIFFWarning', 'TIFFWarning', 'library warning interface', author, '3tiff'), + ('functions/TIFFWriteDirectory', 'TIFFWriteDirectory', 'write the current directory in an open TIFF file', author, '3tiff'), + ('functions/TIFFWriteEncodedStrip', 'TIFFWriteEncodedStrip', 'compress and write a strip of data to an open TIFF file', author, '3tiff'), + ('functions/TIFFWriteEncodedTile', 'TIFFWriteEncodedTile', 'compress and write a tile of data to an open TIFF file', author, '3tiff'), + ('functions/TIFFWriteRawStrip', 'TIFFWriteRawStrip', 'write a strip of raw data to an open TIFF file', author, '3tiff'), + ('functions/TIFFWriteRawTile', 'TIFFWriteRawTile', 'write a tile of raw data to an open TIFF file', author, '3tiff'), + ('functions/TIFFWriteScanline', 'TIFFWriteScanline', 'write a scanline to an open TIFF file', author, '3tiff'), + ('functions/TIFFWriteTile', 'TIFFWriteTile', 'encode and write a tile of data to an open TIFF file', author, '3tiff'), +] + +# If true, show URL addresses after external links. +man_show_urls = True diff --git a/doc/functions.rst b/doc/functions.rst new file mode 100644 index 00000000..f544d0e0 --- /dev/null +++ b/doc/functions.rst @@ -0,0 +1,51 @@ +TIFF Functions Overview +======================= + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + functions/libtiff + functions/TIFFbuffer + functions/TIFFClose + functions/TIFFcodec + functions/TIFFcolor + functions/TIFFDataWidth + functions/TIFFError + functions/TIFFFieldDataType + functions/TIFFFieldName + functions/TIFFFieldPassCount + functions/TIFFFieldReadCount + functions/TIFFFieldTag + functions/TIFFFieldWriteCount + functions/TIFFFlush + functions/TIFFGetField + functions/TIFFmemory + functions/TIFFOpen + functions/TIFFPrintDirectory + functions/TIFFquery + functions/TIFFReadDirectory + functions/TIFFReadEncodedStrip + functions/TIFFReadEncodedTile + functions/TIFFReadRawStrip + functions/TIFFReadRawTile + functions/TIFFReadRGBAImage + functions/TIFFReadRGBAStrip + functions/TIFFReadRGBATile + functions/TIFFReadScanline + functions/TIFFReadTile + functions/TIFFRGBAImage + functions/TIFFSetDirectory + functions/TIFFSetField + functions/TIFFsize + functions/TIFFstrip + functions/TIFFswab + functions/TIFFtile + functions/TIFFWarning + functions/TIFFWriteDirectory + functions/TIFFWriteEncodedStrip + functions/TIFFWriteEncodedTile + functions/TIFFWriteRawStrip + functions/TIFFWriteRawTile + functions/TIFFWriteScanline + functions/TIFFWriteTile diff --git a/doc/functions/TIFFClose.rst b/doc/functions/TIFFClose.rst new file mode 100644 index 00000000..1eb523a4 --- /dev/null +++ b/doc/functions/TIFFClose.rst @@ -0,0 +1,35 @@ +TIFFClose +========== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + + +.. c:function:: void TIFFClose(TIFF* tif) + +Description +----------- + +:c:func:`TIFFClose` closes a file that was previously opened with +:c:func:`TIFFOpen`. Any buffered data are flushed to the file, including +the contents of the current directory (if modified); and all resources +are reclaimed. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. +Likewise, warning messages are directed to the :c:func:`TIFFWarning` routine. + +See also +-------- + +:doc:`libtiff` (3tiff), +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFError` (3tiff) diff --git a/doc/functions/TIFFDataWidth.rst b/doc/functions/TIFFDataWidth.rst new file mode 100644 index 00000000..d60f3af7 --- /dev/null +++ b/doc/functions/TIFFDataWidth.rst @@ -0,0 +1,44 @@ +TIFFDataWidth +============= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFDataWidth(TIFFDataType type) + +Description +----------- + +:c:func:`TIFFDataWidth` returns the size of *type* in bytes. +Currently following data types are supported: + +* :c:macro:`TIFF_BYTE` +* :c:macro:`TIFF_ASCII` +* :c:macro:`TIFF_SBYTE` +* :c:macro:`TIFF_UNDEFINED` +* :c:macro:`TIFF_SHORT` +* :c:macro:`TIFF_SSHORT` +* :c:macro:`TIFF_LONG` +* :c:macro:`TIFF_SLONG` +* :c:macro:`TIFF_FLOAT` +* :c:macro:`TIFF_IFD` +* :c:macro:`TIFF_RATIONAL` +* :c:macro:`TIFF_SRATIONAL` +* :c:macro:`TIFF_DOUBLE` + +Return values +------------- + +:c:func:`TIFFDataWidth` returns a number of bytes occupied by the item +of given type. 0 returned when unknown data type supplied. + +See also +-------- + +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFError.rst b/doc/functions/TIFFError.rst new file mode 100644 index 00000000..846ede87 --- /dev/null +++ b/doc/functions/TIFFError.rst @@ -0,0 +1,42 @@ +TIFFError +========= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + #include <stdarg.h> + +.. c:function:: void TIFFError(const char * module, const char * fmt, ...) + +.. c:type:: void (*TIFFErrorHandler)(const char * module, const char* fmt, va_list ap) + +.. c:function:: TIFFErrorHandler TIFFSetErrorHandler(TIFFErrorHandler handler) + +Description +----------- + +:c:func:`TIFFError` invokes the library-wide error handling function to (normally) write an error +message to ``stderr``. The *fmt* parameter is a :c:func:`printf` format string, and any number +arguments can be supplied. The *module* parameter, if non-zero, is printed before the message; it +typically is used to identify the software module in which an error is detected. + +Applications that desire to capture control in the event of an error should +:c:func:`TIFFSetErrorHandler` to override the default error handler. +A :c:macro:`NULL` (0) error handling function may be installed to suppress error messages. + +Return values +------------- + +:c:func:`TIFFSetErrorHandler` returns a reference to the previous error handling function. + +See also +-------- + +:doc:`TIFFWarning` (3tiff), +:doc:`libtiff` (3tiff), +printf (3) diff --git a/doc/functions/TIFFFieldDataType.rst b/doc/functions/TIFFFieldDataType.rst new file mode 100644 index 00000000..8f5a8b61 --- /dev/null +++ b/doc/functions/TIFFFieldDataType.rst @@ -0,0 +1,30 @@ +TIFFFieldDataType +================= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: TIFFDataType TIFFFieldDataType(const TIFFField* fip) + +Description + +:c:func:`TIFFFieldDataType` returns the data type stored in a TIFF field. +*fip* is a field information pointer previously returned by +:c:func:`TIFFFindField`, :c:func:`TIFFFieldWithTag`, or :c:func:`TIFFFieldWithName`. + +Return values +------------- + +:c:func:`TIFFFieldDataType` returns a member of the enum type +:c:type:`TIFFDataType`. + +See also +-------- + +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFFieldName.rst b/doc/functions/TIFFFieldName.rst new file mode 100644 index 00000000..e4ceace5 --- /dev/null +++ b/doc/functions/TIFFFieldName.rst @@ -0,0 +1,30 @@ +TIFFFieldName +============= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: const char* TIFFFieldName(const TIFFField* fip) + +Description +----------- + +:c:func:`TIFFFieldName` returns the textual name for a TIFF field. +*fip* is a field information pointer previously returned by +:c:func:`TIFFFindField`, :c:func:`TIFFFieldWithTag`, or :c:func:`TIFFFieldWithName`. + +Return values +------------- + +:c:func:`TIFFFieldName` returns a constant C string. + +See also +-------- + +:doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFFieldPassCount.rst b/doc/functions/TIFFFieldPassCount.rst new file mode 100644 index 00000000..83080636 --- /dev/null +++ b/doc/functions/TIFFFieldPassCount.rst @@ -0,0 +1,40 @@ +TIFFFieldPassCount +================== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFFieldPassCount(const TIFFField* fip) + +Description +----------- + +:c:func:`TIFFFieldPassCount` returns true (nonzero) if +:c:func:`TIFFGetField` and :c:func:`TIFFSetField` +expect a :c:var:`count` value to be passed before the actual data pointer. + +:c:var:`fip` is a field information pointer previously returned by +:c:func:`TIFFFindField`, +:c:func:`TIFFFieldWithTag`, +:c:func:`TIFFFieldWithName`. + +When a :c:var:`count` is required, it will be of type :c:type:`uint32_t` if +:c:func:`TIFFFieldReadCount` reports :c:macro:`TIFF_VARIABLE2`, +and of type :c:type:`uint16_t` otherwise. (This distinction is critical for use of +:c:func:`TIFFGetField`, but normally not so for use of :c:func:`TIFFSetField`.) + +Return values +------------- + +:c:func:`TIFFFieldPassCount` returns an integer that is always 1 (true) or 0 (false). + +See also +-------- + +:doc:`libtiff` diff --git a/doc/functions/TIFFFieldReadCount.rst b/doc/functions/TIFFFieldReadCount.rst new file mode 100644 index 00000000..cbcb848c --- /dev/null +++ b/doc/functions/TIFFFieldReadCount.rst @@ -0,0 +1,42 @@ +TIFFFieldReadCount +================== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFFieldReadCount(const TIFFField* fip) + +Description +----------- + +:c:func:`TIFFFieldReadCount` returns the number of values available to be read +from the specified TIFF field; that is, the number of arguments that should be +supplied to :c:func:`TIFFGetField`. For most field types this is a small +positive integer, typically 1 or 2, but there are some special values: + +* :c:macro:`TIFF_VARIABLE` indicates that a variable number of values is possible; + then, a :c:type:`uint16_t` *count* argument and a pointer *data* argument must + be supplied to :c:func:`TIFFGetField`. +* :c:macro:`TIFF_VARIABLE2` is the same as :c:macro:`TIFF_VARIABLE` except that + the *count* argument must have type :c:type:`uint32_t`. +* :c:macro:`TIFF_SPP` indicates that the number of arguments is equal to the + image's number of samples per pixel. + +*fip* is a field information pointer previously returned by +:c:func:`TIFFFindField`, :c:func:`TIFFFieldWithTag`, or :c:func:`TIFFFieldWithName`. + +Return values +------------- + +:c:func:`TIFFFieldReadCount` returns an integer. + +See also +-------- + +:doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFFieldTag.rst b/doc/functions/TIFFFieldTag.rst new file mode 100644 index 00000000..9c7f58d0 --- /dev/null +++ b/doc/functions/TIFFFieldTag.rst @@ -0,0 +1,33 @@ +TIFFFieldTag +============ + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: uint32_t TIFFFieldTag(const TIFFField* fip) + +Description +----------- + +:c:func:`TIFFFieldTag` returns the numeric tag value for a TIFF field. +This can be compared to various constants exported by the :program:`libtiff` +header files, such as :c:macro:`TIFFTAG_IMAGEWIDTH`. + +*fip* is a field information pointer previously returned by +:c:func:`TIFFFindField`, :c:func:`TIFFFieldWithTag`, or :c:func:`TIFFFieldWithName`. + +Return values +------------- + +:c:func:`TIFFFieldTag` returns an integer tag value. + +See also +-------- + +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFFieldWriteCount.rst b/doc/functions/TIFFFieldWriteCount.rst new file mode 100644 index 00000000..d03a2a62 --- /dev/null +++ b/doc/functions/TIFFFieldWriteCount.rst @@ -0,0 +1,48 @@ +TIFFFieldWriteCount +=================== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFFieldWriteCount(const TIFFField* fip) + +Description +----------- + +:c:func:`TIFFFieldWriteCount` returns the number of values to be written into the specified +TIFF field; that is, the number of arguments that should be supplied to +:c:func:`TIFFSetField`. +For most field types this is a small positive integer, typically 1 or 2, +but there are some special values: + +* :c:macro:`TIFF_VARIABLE` indicates that a variable number of values is possible; then, a + :c:type:`uint16_t` *count* argument and a pointer *data* argument must be supplied to + :c:func:`TIFFSetField`. +* :c:macro:`TIFF_VARIABLE2` is the same as :c:macro:`TIFF_VARIABLE` except that the + *count* argument must have type :c:type:`uint32_t`. (On most modern machines, this makes + no practical difference, and the *count* argument can simply be an :c:type:`int` in + either case.) +* :c:type:`TIFF_SPP` indicates that the number of arguments must be equal to the image's + number of samples per pixel. + +*fip* is a field information pointer previously returned by +:c:func:`TIFFFindField`, :c:func:`TIFFFieldWithTag`, or :c:func:`TIFFFieldWithName`. + +For most field types, :c:func:`TIFFFieldWriteCount` returns the same value as +:c:func:`TIFFFieldReadCount`, but there are some exceptions. + +Return values +------------- + +:c:func:`TIFFFieldWriteCount` returns an integer. + +See also +-------- + +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFFlush.rst b/doc/functions/TIFFFlush.rst new file mode 100644 index 00000000..843765f3 --- /dev/null +++ b/doc/functions/TIFFFlush.rst @@ -0,0 +1,50 @@ +TIFFFlush +========= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFFlush(TIFF* tif) + +.. c:function:: int TIFFFlushData(TIFF* tif) + +Description +----------- + +:c:func:`TIFFFlush` causes any pending writes for the specified file +(including writes for the current directory) to be done. In normal +operation this call is never needed—the library automatically does +any flushing required. + +:c:func:`TIFFFlushData` flushes any pending image data for the specified +file to be written out; directory-related data are not flushed. In normal +operation this call is never needed—the library automatically does any +flushing required. + +Return values +------------- + +0 is returned if an error is encountered, otherwise 1 is returned. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFWriteEncodedStrip` (3tiff), +:doc:`TIFFWriteEncodedTile` (3tiff), +:doc:`TIFFWriteRawStrip` (3tiff), +:doc:`TIFFWriteRawTile` (3tiff), +:doc:`TIFFWriteScanline` (3tiff), +:doc:`TIFFWriteTile` (3tiff), +:doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFGetField.rst b/doc/functions/TIFFGetField.rst new file mode 100644 index 00000000..8acac264 --- /dev/null +++ b/doc/functions/TIFFGetField.rst @@ -0,0 +1,490 @@ +TIFFGetField +============ + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + #include <stdarg.h> + +.. c:function:: int TIFFGetField(TIFF* tif, ttag_t tag, ...) + +.. c:function:: int TIFFVGetField(TIFF* tif, ttag_t tag, va_list ap) + +.. c:function:: int TIFFGetFieldDefaulted(TIFF* tif, ttag_t tag, ...) + +.. c:function:: int TIFFVGetFieldDefaulted(TIFF* tif, ttag_t tag, va_list ap) + +Description +----------- + +:c:func:`TIFFGetField` returns the value of a tag or pseudo-tag associated with the +the current directory of the opened TIFF file *tif*. (A *pseudo-tag* is a +parameter that is used to control the operation of the TIFF library but whose value +is not read or written to the underlying file.) The file must have been previously +opened with :c:func:`TIFFOpen`. The tag is identified by *tag*, one of the values +defined in the include file :file:`tiff.h` (see also the table below). The type and +number of values returned is dependent on the tag being requested. The programming +interface uses a variable argument list as prescribed by the :file:`stdarg.h` +interface. The returned values should only be interpreted if :c:func:`TIFFGetField` +returns 1. + +:c:func:`TIFFVGetField` is functionally equivalent to :c:func:`TIFFGetField` +except that it takes a pointer to a variable argument list. :c:func:`TIFFVGetField` +is useful for layering interfaces on top of the functionality provided by +:c:func:`TIFFGetField`. + +:c:func:`TIFFGetFieldDefaulted` and :c:func:`TIFFVGetFieldDefaulted` are identical +to :c:func:`TIFFGetField` and :c:func:`TIFFVGetField`, respectively, except that if +a tag is not defined in the current directory and it has a default value, then the +default value is returned. + +The tags understood by :program:`libtiff` the number of parameter values, and the +types for the returned values are shown below. The data types are specified as in C +and correspond to the types used to specify tag values to +:c:func:`TIFFSetField`. Remember that :c:func:`TIFFGetField` returns parameter +values, so all the listed data types are pointers to storage where values should be +returned. Consult the TIFF specification (or relevant industry specification) for +information on the meaning of each tag and their possible values. + + .. list-table:: Tag properties + :widths: 5 3 5 10 + :header-rows: 1 + + * - Tag name + - Count + - Types + - Notes + + * - :c:macro:`TIFFTAG_ARTIST` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_BADFAXLINES` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_BITSPERSAMPLE` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_CLEANFAXDATA` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_COLORMAP` + - 3 + - :c:type:`const uint16_t**` + - :c:expr:`1<<BitsPerSample` arrays + + * - :c:macro:`TIFFTAG_COMPRESSION` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_CONSECUTIVEBADFAXLINES` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_COPYRIGHT` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_DATATYPE` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_DATETIME` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_DOCUMENTNAME` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_DOTRANGE` + - 2 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_EXTRASAMPLES` + - 2 + - :c:type:`uint16_t*`, :c:type:`const uint16_t**` + - count, types array + + * - :c:macro:`TIFFTAG_FAXFILLFUNC` + - 1 + - :c:type:`TIFFFaxFillFunc*` + - G3/G4 compression pseudo-tag + + * - :c:macro:`TIFFTAG_FAXMODE` + - 1 + - :c:type:`int*` + - G3/G4 compression pseudo-tag + + * - :c:macro:`TIFFTAG_FILLORDER` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_GROUP3OPTIONS` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_GROUP4OPTIONS` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_HALFTONEHINTS` + - 2 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_HOSTCOMPUTER` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_ICCPROFILE` + - 2 + - :c:type:`const uint32_t*`, :c:type:`const void**` + - count, profile data‡ + + * - :c:macro:`TIFFTAG_IMAGEDEPTH` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_IMAGEDESCRIPTION` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_IMAGELENGTH` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_IMAGEWIDTH` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_INKNAMES` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_INKSET` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_JPEGCOLORMODE` + - 1 + - :c:type:`int*` + - JPEG pseudo-tag + + * - :c:macro:`TIFFTAG_JPEGQUALITY` + - 1 + - :c:type:`int*` + - JPEG pseudo-tag + + * - :c:macro:`TIFFTAG_JPEGTABLES` + - 2 + - :c:type:`uint32_t*`, :c:type:`const void**` + - count, tables + + * - :c:macro:`TIFFTAG_JPEGTABLESMODE` + - 1 + - :c:type:`int*` + - JPEG pseudo-tag + + * - :c:macro:`TIFFTAG_MAKE` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_MATTEING` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_MAXSAMPLEVALUE` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_MINSAMPLEVALUE` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_MODEL` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_ORIENTATION` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_PAGENAME` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_PAGENUMBER` + - 2 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_PHOTOMETRIC` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_PHOTOSHOP` + - 2 + - :c:type:`uint32_t*`, :c:type:`const void**` + - count, data + + * - :c:macro:`TIFFTAG_PLANARCONFIG` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_PREDICTOR` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_PRIMARYCHROMATICITIES` + - 1 + - :c:type:`const float**` + - 6-entry array + + * - :c:macro:`TIFFTAG_REFERENCEBLACKWHITE` + - 1 + - :c:type:`const float**` + - 6-entry array + + * - :c:macro:`TIFFTAG_RESOLUTIONUNIT` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_RICHTIFFIPTC` + - 2 + - :c:type:`uint32_t*`, :c:type:`const void**` + - count, data + + * - :c:macro:`TIFFTAG_ROWSPERSTRIP` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_SAMPLEFORMAT` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_SAMPLESPERPIXEL` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_SMAXSAMPLEVALUE` + - 1 + - :c:type:`double*` + - + + * - :c:macro:`TIFFTAG_SMINSAMPLEVALUE` + - 1 + - :c:type:`double*` + - + + * - :c:macro:`TIFFTAG_SOFTWARE` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_STONITS` + - 1 + - :c:type:`const double**` + - + + * - :c:macro:`TIFFTAG_STRIPBYTECOUNTS` + - 1 + - :c:type:`const uint64_t**` + - + + * - :c:macro:`TIFFTAG_STRIPOFFSETS` + - 1 + - :c:type:`const uint64_t**` + - + + * - :c:macro:`TIFFTAG_SUBFILETYPE` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_SUBIFD` + - 2 + - :c:type:`uint16_t*`, :c:type:`const uint64_t**` + - count, offsets array + + * - :c:macro:`TIFFTAG_TARGETPRINTER` + - 1 + - :c:type:`const char**` + - + + * - :c:macro:`TIFFTAG_THRESHHOLDING` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_TILEBYTECOUNTS` + - 1 + - :c:type:`const uint64_t**` + - + + * - :c:macro:`TIFFTAG_TILEDEPTH` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_TILELENGTH` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_TILEOFFSETS` + - 1 + - :c:type:`const uint64_t**` + - + + * - :c:macro:`TIFFTAG_TILEWIDTH` + - 1 + - :c:type:`uint32_t*` + - + + * - :c:macro:`TIFFTAG_TRANSFERFUNCTION` + - 1 or 3†+ - :c:type:`const uint16_t**` + - :c:expr:`1<<BitsPerSample` entry arrays + + * - :c:macro:`TIFFTAG_WHITEPOINT` + - 1 + - :c:type:`const float**` + - 2-entry array + + * - :c:macro:`TIFFTAG_XMLPACKET` + - 2 + - :c:type:`uint32_t*,const void**` + - count, data + + * - :c:macro:`TIFFTAG_XPOSITION` + - 1 + - :c:type:`float*` + - + + * - :c:macro:`TIFFTAG_XRESOLUTION` + - 1 + - :c:type:`float*` + - + + * - :c:macro:`TIFFTAG_YCBCRCOEFFICIENTS` + - 1 + - :c:type:`const float**` + - 3-entry array + + * - :c:macro:`TIFFTAG_YCBCRPOSITIONING` + - 1 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_YCBCRSUBSAMPLING` + - 2 + - :c:type:`uint16_t*` + - + + * - :c:macro:`TIFFTAG_YPOSITION` + - 1 + - :c:type:`float*` + - + + * - :c:macro:`TIFFTAG_YRESOLUTION` + - 1 + - :c:type:`float*` + - + +†: + If ``SamplesPerPixel`` is one, then a single array is returned; otherwise + three arrays are returned. + +‡: + The contents of this field are quite complex. See + "The ICC Profile Format Specification", + Annex B.3 "Embedding ICC Profiles in TIFF Files" (available at + http://www.color.org) for an explanation. + +Autoregistered tags +------------------- + +If you can't find the tag in the table above that means this is an unsupported +tag and is not directly supported by the :program:`libtiff` library. You will +still be able to read it's value if you know the data type of that tag. For +example, if you want to read the ``LONG`` value from the tag 33424 +and ``ASCII`` string from the tag 36867 you can use the following code: + +:: + + uint32_t count; + void *data; + + TIFFGetField(tiff, 33424, &count, &data); + printf("Tag %d: %d, count %d\n", 33424, *(uint32_t *)data, count); + TIFFGetField(tiff, 36867, &count, &data); + printf("Tag %d: %s, count %d\n", 36867, (char *)data, count); + +Return values +------------- + +1 is returned if the tag is defined in the current directory; otherwise a 0 is +returned. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``Unknown field, tag 0x%x``: + + An unknown tag was supplied. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFSetField` (3tiff), +:doc:`TIFFSetDirectory` (3tiff), +:doc:`TIFFReadDirectory` (3tiff), +:doc:`TIFFWriteDirectory` (3tiff) +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFOpen.rst b/doc/functions/TIFFOpen.rst new file mode 100644 index 00000000..b237069f --- /dev/null +++ b/doc/functions/TIFFOpen.rst @@ -0,0 +1,250 @@ +TIFFOpen +======== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: TIFF* TIFFOpen(const char* filename, const char* mode) + +.. c:function:: TIFF* TIFFFdOpen(const int fd, const char* filename, const char*mode) + +.. c:type:: tsize_t (*TIFFReadWriteProc)(thandle_t, tdata_t, tsize_t) +.. c:type:: toff_t (*TIFFSeekProc)(thandle_t, toff_t, int) +.. c:type:: int (*TIFFCloseProc)(thandle_t) +.. c:type:: toff_t (*TIFFSizeProc)(thandle_t) +.. c:type:: int (*TIFFMapFileProc)(thandle_t, tdata_t*, toff_t*) +.. c:type:: void (*TIFFUnmapFileProc)(thandle_t, tdata_t, toff_t) + +.. c:function:: TIFF* TIFFClientOpen(const char* filename, const char* mode, thandle_t clientdata, TIFFReadWriteProc readproc, TIFFReadWriteProc writeproc, TIFFSeekProc seekproc, TIFFCloseProc closeproc, TIFFSizeProc sizeproc, TIFFMapFileProc mapproc, TIFFUnmapFileProc unmapproc) + +Description +----------- + +:c:func:`TIFFOpen` opens a TIFF file whose name is *filename* +and returns a handle to be used in subsequent calls to routines in +:program:`libtiff`. If the open operation fails, then +:c:macro:`NULL` (0) is returned. The *mode* parameter specifies if +the file is to be opened for reading (``r``), writing (``w``), or +appending (``a``) and, optionally, whether to override certain +default aspects of library operation (see below). +When a file is opened for appending, existing data will not +be touched; instead new data will be written as additional subfiles. +If an existing file is opened for writing, all previous data is +overwritten. + +If a file is opened for reading, the first TIFF directory in the file +is automatically read (also see :c:func:`TIFFSetDirectory` for reading +directories other than the first). +If a file is opened for writing or appending, a default directory +is automatically created for writing subsequent data. +This directory has all the default values specified in TIFF Revision 6.0: + +* ``BitsPerSample`` = 1, +* ``ThreshHolding`` = "bilevel art scan" +* ``FillOrder`` = 1 (most significant bit of each data byte is filled first) +* ``Orientation`` = 1 (the 0th row represents the visual top of the image, and the 0th + column represents the visual left hand side), +* ``SamplesPerPixel`` = 1, +* ``RowsPerStrip`` = ∞, +* ``ResolutionUnit`` = 2 (inches), and +* ``Compression`` = 1 (no compression). + +To alter these values, or to define values for additional fields, +:c:func:`TIFFSetField` must be used. + +:c:func:`TIFFFdOpen` is like :c:func:`TIFFOpen` except that it opens a +TIFF file given an open file descriptor *fd*. +The file's name and mode must reflect that of the open descriptor. +The object associated with the file descriptor **must support random access**. + +:c:func:`TIFFClientOpen` is like :c:func:`TIFFOpen` except that the caller +supplies a collection of functions that the library will use to do UNIX-like +I/O operations. The *readproc* and *writeproc* functions are called to read +and write data at the current file position. +*seekproc* is called to change the current file position à la :c:func:`lseek` (2). +*closeproc* is invoked to release any resources associated with an open file. +*sizeproc* is invoked to obtain the size in bytes of a file. +*mapproc* and *unmapproc* are called to map and unmap a file's contents in +memory; c.f. :c:func:`mmap` (2) and :c:func:`munmap` (2). +The *clientdata* parameter is an opaque "handle" passed to the client-specified +routines passed as parameters to :c:func:`TIFFClientOpen`. + + +Options +------- + +The open mode parameter can include the following flags in +addition to the ``r``, ``w``, and ``a`` flags. +Note however that option flags must follow the read-write-append +specification. + +``l``: + + When creating a new file force information be written with + Little-Endian byte order (but see below). + By default the library will create new files using the native + CPU byte order. + +``b``: + + When creating a new file force information be written with + Big-Endian byte order (but see below). + By default the library will create new files using the native + CPU byte order. + +``L``: + + Force image data that is read or written to be treated with + bits filled from Least Significant Bit (LSB) to + Most Significant Bit (MSB). + Note that this is the opposite to the way the library has + worked from its inception. + +``B``: + + Force image data that is read or written to be treated with + bits filled from Most Significant Bit (MSB) to + Least Significant Bit (LSB); this is the default. + +``H``: + + Force image data that is read or written to be treated with + bits filled in the same order as the native + CPU. + +``M``: + + Enable the use of memory-mapped files for images opened read-only. + If the underlying system does not support memory-mapped files + or if the specific image being opened cannot be memory-mapped + then the library will fallback to using the normal system interface + for reading information. + By default the library will attempt to use memory-mapped files. + +``m``: + + Disable the use of memory-mapped files. + +``C``: + + Enable the use of "strip chopping" when reading images + that are comprised of a single strip or tile of uncompressed data. + Strip chopping is a mechanism by which the library will automatically + convert the single-strip image to multiple strips, + each of which has about 8 Kilobytes of data. + This facility can be useful in reducing the amount of memory used + to read an image because the library normally reads each strip + in its entirety. + Strip chopping does however alter the apparent contents of the + image because when an image is divided into multiple strips it + looks as though the underlying file contains multiple separate + strips. + Finally, note that default handling of strip chopping is a compile-time + configuration parameter. + The default behaviour, for backwards compatibility, is to enable + strip chopping. + +``c``: + + Disable the use of strip chopping when reading images. + +``h``: + + Read TIFF header only, do not load the first image directory. That could be + useful in case of the broken first directory. We can open the file and proceed + to the other directories. + +``4``: + + ClassicTIFF for creating a file (default) + +``8``: + + BigTIFF for creating a file. + +``D``: + + Enable use of deferred strip/tile offset/bytecount array loading. They will + be loaded the first time they are accessed to. This loading will be done in + its entirety unless the O flag is also specified. + +``O``: + + On-demand loading of values of the strip/tile offset/bytecount arrays, limited + to the requested strip/tile, instead of whole array loading (implies ``D``) + +Byte order +---------- + +The TIFF specification (**all versions**) states that compliant readers +"must be capable of reading images written in either byte order" . +Nonetheless some software that claims to support the reading of +TIFF images is incapable of reading images in anything but the native +CPU byte order on which the software was written. +(Especially notorious are applications written to run on Intel-based machines.) +By default the library will create new files with the native +byte-order of the CPU on which the application is run. +This ensures optimal performance and is portable to any application +that conforms to the TIFF specification. +To force the library to use a specific byte-order when creating +a new file the ``b`` and ``l`` option flags may be included in +the call to open a file; for example, ``wb`` or ``wl``. + +Return values +------------- + +Upon successful completion +:c:func:`TIFFOpen`, :c:func:`TIFFFdOpen`, and :c:func:`TIFFClientOpen` +return a TIFF pointer. Otherwise, :c:macro:`NULL` is returned. + +Diagnostics +----------- + + +All error messages are directed to the :c:func:`TIFFError` routine. +Likewise, warning messages are directed to the :c:func:`TIFFWarning` routine. + +``"%s": Bad mode``: + + The specified *mode* parameter was not one of ``r`` (read), ``w`` (write), + or ``a`` (append). + +``"%s: Cannot open"``: + + :c:func:`TIFFOpen` was unable to open the specified filename for read/writing. + +``"Cannot read TIFF header"``: + + An error occurred while attempting to read the header information. + +``"Error writing TIFF header"``: + + An error occurred while writing the default header information + for a new file. + +``"Not a TIFF file, bad magic number %d (0x%x)"``: + + The magic number in the header was not (hex) + 0x4d4d or (hex) 0x4949. + +``"Not a TIFF file, bad version number %d (0x%x)"``: + + The version field in the header was not 42 (decimal). + +``"Cannot append to file that has opposite byte ordering"``: + + A file with a byte ordering opposite to the native byte + ordering of the current machine was opened for appending (``a``). + This is a limitation of the library. + +See also +-------- + +:doc:`libtiff` (3tiff), +:doc:`TIFFClose` (3tiff) diff --git a/doc/functions/TIFFPrintDirectory.rst b/doc/functions/TIFFPrintDirectory.rst new file mode 100644 index 00000000..fb10c805 --- /dev/null +++ b/doc/functions/TIFFPrintDirectory.rst @@ -0,0 +1,58 @@ +TIFFPrintDirectory +================== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: void TIFFPrintDirectory(TIFF* tif, FILE* fd, long flags) + +Description +----------- + +:c:func:`TIFFPrintDirectory` prints a description of the current directory in the specified +TIFF file to the standard I/O output stream *fd*. +The *flags* parameter is used to control the "level of detail" +of the printed information; it is a bitwise-or of the flags defined in +:file:`tiffio.h`: + + +================================= ===== =========================== +Name Value Description +================================= ===== =========================== +:c:macro:`TIFFPRINT_NONE` 0x0 no extra info +:c:macro:`TIFFPRINT_STRIPS` 0x1 strips/tiles info +:c:macro:`TIFFPRINT_CURVES` 0x2 color/gray response curves +:c:macro:`TIFFPRINT_COLORMAP` 0x4 colormap +:c:macro:`TIFFPRINT_JPEGQTABLES` 0x100 JPEG Q matrices +:c:macro:`TIFFPRINT_JPEGACTABLES` 0x200 JPEG AC tables +:c:macro:`TIFFPRINT_JPEGDCTABLES` 0x200 JPEG DC tables +================================= ===== =========================== + +Notes +----- + +In C++ the *flags* parameter defaults to 0. + +Return values +------------- + +None. + +Diagnostics +----------- + +None. + +See also +-------- + +:doc:`libtiff` (3tiff), +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFReadDirectory` (3tiff), +:doc:`TIFFSetDirectory` (3tiff) diff --git a/doc/functions/TIFFRGBAImage.rst b/doc/functions/TIFFRGBAImage.rst new file mode 100644 index 00000000..f61d314e --- /dev/null +++ b/doc/functions/TIFFRGBAImage.rst @@ -0,0 +1,235 @@ +TIFFRGBAImage +============= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:type:: unsigned char TIFFRGBValue + +.. c:type:: struct _TIFFRGBAImage TIFFRGBAImage + +.. c:function:: int TIFFRGBAImageOK(TIFF* tif, char emsg[1024]) + +.. c:function:: int TIFFRGBAImageBegin(TIFFRGBAImage* img, TIFF* tif, int stopOnError, char emsg[1024]) + +.. c:function:: int TIFFRGBAImageGet(TIFFRGBAImage* img, uint32_t* raster, uint32_t width, uint32_t height) + +.. c:function:: void TIFFRGBAImageEnd(TIFFRGBAImage* img) + +Description +----------- + +The routines described here provide a high-level interface through which +TIFF images may be read into memory. +Images may be strip- or tile-based and have a variety of different +characteristics: bits/sample, samples/pixel, photometric, etc. +Decoding state is encapsulated in a :c:type:`TIFFRGBAImage` +structure making it possible to capture state for multiple images +and quickly switch between them. +The target raster format can be customized to a particular application's +needs by installing custom routines that manipulate image data +according to application requirements. + +The default usage for these routines is: + +* check if an image can be processed using :c:func:`TIFFRGBAImageOK` +* construct a decoder state block using :c:func:`TIFFRGBAImageBegin` +* read and decode an image into a target raster using :c:func:`TIFFRGBAImageGet`, + and then +* release resources using :c:func:`TIFFRGBAImageEnd` + +:c:func:`TIFFRGBAImageGet` can be called multiple times to decode an +image using different state parameters. +If multiple images are to be displayed and there is not enough +space for each of the decoded rasters, multiple state blocks can +be managed and then calls can be made to :c:func:`TIFFRGBAImageGet` +as needed to display an image. + +The generated raster is assumed to be an array of +*width* × *height* +32-bit entries, where *width* must be less than or equal to the width of +the image (*height* may be any non-zero size). +If the raster dimensions are smaller than the image, the image data +is cropped to the raster bounds. +If the raster height is greater than that of the image, then the +image data are placed in the lower part of the raster. +(Note that the raster is assume to be organized such that the pixel +at location (*x*, *y*) is *raster* [ *y* × *width* + *x* ]; +with the raster origin in the *lower-left hand corner*.) + +Raster pixels are 8-bit packed red, green, blue, alpha samples. +The macros :c:macro:`TIFFGetR`, :c:macro:`TIFFGetG`, :c:macro:`TIFFGetB`, +and :c:macro:`TIFFGetA` should be used to access individual samples. +Images without Associated Alpha matting information have a constant +Alpha of 1.0 (255). + +:c:func:`TIFFRGBAImageGet` converts non-8-bit images by scaling sample +values. Palette, grayscale, bilevel, CMYK, and YCbCr images are +converted to RGB transparently. +Raster pixels are returned uncorrected by any colorimetry information +present in the directory. + +The parameter *stopOnError* specifies how to act if an error is +encountered while reading the image. If *stopOnError* is non-zero, +then an error will terminate the operation; otherwise +:c:func:`TIFFRGBAImageGet` will continue processing data until all the +possible data in the image have been requested. + +Alternate raster formats +------------------------ + +To use the core support for reading and processing TIFF images, but +write the resulting raster data in a different format one need only +override the "put methods" used to store raster data. +These methods are are defined in the :c:type:`TIFFRGBAImage` +structure and initially setup by :c:func:`TIFFRGBAImageBegin` +to point to routines that pack raster data in the default +ABGR pixel format. +Two different routines are used according to the physical organization +of the image data in the file: +``PlanarConfiguration`` = 1 (packed samples), and +``PlanarConfiguration`` = 2 (separated samples). +Note that this mechanism can be used to transform the data before +storing it in the raster. +For example one can convert data to colormap indices for display on a +colormap display. + +Simultaneous raster store and display +------------------------------------- + +It is simple to display an image as it is being read into memory +by overriding the put methods as described above for supporting +alternate raster formats. +Simply keep a reference to the default put methods setup by +:c:func:`TIFFRGBAImageBegin` and then invoke them before or after +each display operation. For example, the +:doc:`/tools/tiffgt` utility uses the following put method to +update the display as the raster is being filled: + +:: + + static void + putContigAndDraw(TIFFRGBAImage* img, uint32_t* raster, + uint32_t x, uint32_t y, uint32_t w, uint32_t h, + int32_t fromskew, int32_t toskew, + unsigned char* cp) + { + (*putContig)(img, raster, x, y, w, h, fromskew, toskew, cp); + if (x+w == width) { + w = width; + if (img->orientation == ORIENTATION_TOPLEFT) + lrectwrite(0, y-(h-1), w-1, y, raster-x-(h-1)*w); + else + lrectwrite(0, y, w-1, y+h-1, raster); + } + } + +(the original routine provided by the library is saved in the +variable :c:var:`putContig`.) + +Supporting additional TIFF formats +---------------------------------- + +The :c:func:`TIFFRGBAImage` routines support the most commonly +encountered flavors of TIFF. It is possible to extend this support by +overriding the "get method" invoked by :c:func:`TIFFRGBAImageGet` +to read TIFF image data. +Details of doing this are a bit involved, it is best to make a copy +of an existing get method and modify it to suit the needs of an +application. + +Notes +----- + +Samples must be either 1, 2, 4, 8, or 16 bits. +Colorimetric samples/pixel must be either 1, 3, or 4 (i.e. +``SamplesPerPixel`` -``ExtraSamples``). + +Palette image colormaps that appear to be incorrectly written +as 8-bit values are automatically scaled to 16-bits. + +Return values +------------- + +All routines return 1 if the operation was successful. +Otherwise, 0 is returned if an error was encountered and +*stopOnError* is zero. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``"Sorry, can not handle %d-bit pictures"``: + + The image had ``BitsPerSample`` other than 1, 2, 4, 8, or 16. + +``"Sorry, can not handle %d-channel images"``: + + The image had ``SamplesPerPixel`` other than 1, 3, or 4. + +``Missing needed "PhotometricInterpretation" tag``: + + The image did not have a tag that describes how to display + the data. + +``No "PhotometricInterpretation" tag, assuming RGB``: + + The image was missing a tag that describes how to display it, + but because it has 3 or 4 samples/pixel, it is assumed to be + RGB. + +``No "PhotometricInterpretation" tag, assuming min-is-black``: + + The image was missing a tag that describes how to display it, + but because it has 1 sample/pixel, it is assumed to be a grayscale + or bilevel image. + +``"No space for photometric conversion table"``: + + There was insufficient memory for a table used to convert + image samples to 8-bit RGB. + +``Missing required "Colormap" tag``: + + A Palette image did not have a required ``Colormap`` tag. + +``"No space for tile buffer"``: + + There was insufficient memory to allocate an i/o buffer. + +``"No space for strip buffer"``: + + There was insufficient memory to allocate an i/o buffer. + +``"Can not handle format"``: + + The image has a format (combination of ``BitsPerSample``, + ``SamplesPerPixel`` and ``PhotometricInterpretation``) + that can not be handled. + +``"No space for B&W mapping table"``: + + There was insufficient memory to allocate a table used to map + grayscale data to RGB. + +``"No space for Palette mapping table"``: + + There was insufficient memory to allocate a table used to map + data to 8-bit RGB. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFReadRGBAImage` (3tiff), +:doc:`TIFFReadRGBAImageOriented` (3tiff), +:doc:`TIFFReadRGBAStrip` (3tiff), +:doc:`TIFFReadRGBATile` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFReadDirectory.rst b/doc/functions/TIFFReadDirectory.rst new file mode 100644 index 00000000..db07b601 --- /dev/null +++ b/doc/functions/TIFFReadDirectory.rst @@ -0,0 +1,143 @@ +TIFFReadDirectory +================= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFReadDirectory(TIFF* tif) + +Description +----------- + +Read the next directory in the specified file and make it the current +directory. Applications only need to call :c:func:`TIFFReadDirectory` +to read multiple subfiles in a single TIFF file—(the first directory +in a file is automatically read when :c:func:`TIFFOpen` is called. + +Notes +----- + +If the library is compiled with :c:macro:`STRIPCHOP_SUPPORT` enabled, then +images that have a single uncompressed strip or tile of data are +automatically treated as if they were made up of multiple strips or tiles of +approximately 8 kilobytes each. This operation is done only in-memory; it does +not alter the contents of the file. However, the construction of the "chopped +strips" is visible to the application through the number of strips [tiles] +returned by :c:func:`TIFFNumberOfStrips` [:c:func:`TIFFNumberOfTiles`]. + +Return values +------------- + +If the next directory was successfully read, 1 is returned. Otherwise, 0 is +returned if an error was encountered, or if there are no more directories to +be read. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. +All warning messages are directed to the :c:func:`TIFFWarning` routine. + +``Seek error accessing TIFF directory``: + + An error occurred while positioning to the location of the + directory. + +``Wrong data type %d for field "%s"``: + + The tag entry in the directory had an incorrect data type. + For example, an ``ImageDescription`` tag with a ``SHORT`` + data type. + +``TIFF directory is missing required "%s" field``: + + The specified tag is required to be present by the TIFF + 5.0 specification, but is missing. + The directory is (usually) unusable. + +``%s: Rational with zero denominator``: + + A directory tag has a ``RATIONAL`` value whose denominator is zero. + +``Incorrect count %d for field "%s" (%lu, expecting %lu); tag ignored``: + + The specified tag's count field is bad. + For example, a count other than 1 for a ``SubFileType`` tag. + +``Cannot handle different per-sample values for field "%s"``: + + The tag has ``SamplesPerPixel`` values and they are not all the same; e.g. + ``BitsPerSample``. The library is unable to handle images of this sort. + +``Count mismatch for field "%s"; expecting %d, got %d``: + + The count field in a tag does not agree with the number expected by the library. + This should never happen, so if it does, the library refuses to + read the directory. + +``Invalid TIFF directory; tags are not sorted in ascending order``: + + The directory tags are not properly sorted as specified + in the TIFF 5.0 specification. This error is not fatal. + +``Ignoring unknown field with tag %d (0x%x)``: + + An unknown tag was encountered in the directory; + the library ignores all such tags. + +``TIFF directory is missing required "ImageLength" field``: + + The image violates the specification by not having a necessary field. + There is no way for the library to recover from this error. + +``TIFF directory is missing required "PlanarConfig" field``: + + The image violates the specification by not having a necessary field. + There is no way for the library to recover from this error. + +``TIFF directory is missing required "StripOffsets" field``: + + The image has multiple strips, but is missing the tag that + specifies the file offset to each strip of data. + There is no way for the library to recover from this error. + +``TIFF directory is missing required "TileOffsets" field``: + + The image has multiple tiles, but is missing the tag that + specifies the file offset to each tile of data. + There is no way for the library to recover from this error. + +``TIFF directory is missing required "StripByteCounts" field``: + + The image has multiple strips, but is missing the tag that + specifies the size of each strip of data. + There is no way for the library to recover from this error. + +``TIFF directory is missing required "StripByteCounts" field, calculating from imagelength``: + + The image violates the specification by not having a necessary field. + However, when the image is comprised of only one strip or tile, the + library will estimate the missing value based on the file size. + +``Bogus "StripByteCounts" field, ignoring and calculating from imagelength``: + + Certain vendors violate the specification by writing zero for + the StripByteCounts tag when they want to leave the value + unspecified. + If the image has a single strip, the library will estimate + the missing value based on the file size. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFWriteDirectory` (3tiff), +:doc:`TIFFSetDirectory` (3tiff), +:doc:`TIFFSetSubDirectory` (3tiff), +:doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFReadEncodedStrip.rst b/doc/functions/TIFFReadEncodedStrip.rst new file mode 100644 index 00000000..60605952 --- /dev/null +++ b/doc/functions/TIFFReadEncodedStrip.rst @@ -0,0 +1,56 @@ +TIFFReadEncodedStrip +==================== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: tmsize_t TIFFReadEncodedStrip(TIFF* tif, uint32_t strip, void* buf, tmsize_t size) + +Description +----------- + +Read the specified strip of data and place up to *size* bytes of decompressed +information in the (user supplied) data buffer. + +Notes +----- + +The value of *strip* is a "raw strip number". That is, the caller must take +into account whether or not the data are organized in separate planes +(``PlanarConfiguration`` = 2). +To read a full strip of data the data buffer should typically be at least as +large as the number returned by :c:func:`TIFFStripSize`. +If -1 is passed in the *size* parameter, the whole strip will be read. You +should be sure you have enough space allocated for the buffer. + +The library attempts to hide bit- and byte-ordering differences between the +image and the native machine by converting data to the native machine order. +Bit reversal is done if the ``FillOrder`` tag is opposite to the native +machine bit order. 16- and 32-bit samples are automatically byte-swapped if +the file was written with a byte order opposite to the native machine byte +order. + +Return values +------------- + +The actual number of bytes of data that were placed in *buf* is returned; +:c:func:`TIFFReadEncodedStrip` returns -1 if an error was encountered. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFReadRawStrip` (3tiff), +:doc:`TIFFReadScanline` (3tiff), +:doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFReadEncodedTile.rst b/doc/functions/TIFFReadEncodedTile.rst new file mode 100644 index 00000000..bbd52434 --- /dev/null +++ b/doc/functions/TIFFReadEncodedTile.rst @@ -0,0 +1,56 @@ +TIFFReadEncodedTile +=================== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFReadEncodedTile(TIFF* tif, ttile_t tile, tdata_t buf, tsize_t size) + +Description +----------- + +Read the specified tile of data and place up to *size* bytes of decompressed +information in the (user supplied) data buffer. + +Notes +----- + +The value of *tile* is a "raw tile number". That is, the caller must take +into account whether or not the data are organized in separate planes +(``PlanarConfiguration`` = 2). +:c:func:`TIFFComputeTile` automatically does this when converting an +(x,y,z,sample) coordinate quadruple to a tile number. To read a full tile +of data the data buffer should be at least as large as the value returned by +:c:func:`TIFFTileSize`. + +The library attempts to hide bit- and byte-ordering differences between the +image and the native machine by converting data to the native machine order. +Bit reversal is done if the ``FillOrder`` tag is opposite to the native +machine bit order. 16- and 32-bit samples are automatically byte-swapped if +the file was written with a byte order opposite to the native machine byte +order. + +Return values +------------- + +The actual number of bytes of data that were placed in *buf* is returned; +:c:func:`TIFFReadEncodedTile` returns -1 if an error was encountered. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFReadRawTile` (3tiff), +:doc:`TIFFReadTile` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFReadRGBAImage.rst b/doc/functions/TIFFReadRGBAImage.rst new file mode 100644 index 00000000..4947ce1d --- /dev/null +++ b/doc/functions/TIFFReadRGBAImage.rst @@ -0,0 +1,171 @@ +TIFFReadRGBAImage +================= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:macro:: TIFFGetR(abgr) + + :c:expr:`((abgr) & 0xff)` + +.. c:macro:: TIFFGetG(abgr) + + :c:expr:`(((abgr) >> 8) & 0xff)` + +.. c:macro:: TIFFGetB(abgr) + + :c:expr:`(((abgr) >> 16) & 0xff)` + +.. c:macro:: TIFFGetA(abgr) + + :c:expr:`(((abgr) >> 24) & 0xff)` + +.. c:function:: int TIFFReadRGBAImage(TIFF* tif, uint32_t width, uint32_t height, uint32_t* raster, int stopOnError) + +.. c:function:: int TIFFReadRGBAImageOriented(TIFF* tif, uint32_t width, uint32_t height, uint32_t * raster, int orientation, int stopOnError) + +Description +----------- + +:c:func:`TIFFReadRGBAImage` reads a strip- or tile-based image into memory, +storing the result in the user supplied *raster*. +The raster is assumed to be an array of *width* × *height* 32-bit entries, +where *width* must be less than or equal to the width of the image +(*height* may be any non-zero size). +If the raster dimensions are smaller than the image, the image data is +cropped to the raster bounds. +If the raster height is greater than that of the image, then the image data +are placed in the lower part of the raster. +(Note that the raster is assume to be organized such that the pixel +at location (*x*, *y*) is *raster* [ *y* × *width* + *x* ]; +with the raster origin in the lower-left hand corner.) + +:c:func:`TIFFReadRGBAImageOriented` works like :c:func:`TIFFReadRGBAImage` +except that the user can specify the raster origin position with the +*orientation* parameter. Four orientations are supported: + +* :c:macro:`ORIENTATION_TOPLEFT`: origin in top-left corner, +* :c:macro:`ORIENTATION_TOPRIGHT`: origin in top-right corner, +* :c:macro:`ORIENTATION_BOTLEFT`: origin in bottom-left corner +* :c:macro:`ORIENTATION_BOTRIGHT`: origin in bottom-right corner. + +If you choose :c:macro:`ORIENTATION_BOTLEFT`, the result will be the same +as returned by the :c:func:`TIFFReadRGBAImage`. + +Raster pixels are 8-bit packed red, green, blue, alpha samples. +The macros :c:macro:`TIFFGetR`, :c:macro:`TIFFGetG`, :c:macro:`TIFFGetB`, +and :c:macro:`TIFFGetA` should be used to access individual samples. +Images without Associated Alpha matting information have a constant +Alpha of 1.0 (255). + +:c:func:`TIFFReadRGBAImage` converts non-8-bit images by scaling sample +values. Palette, grayscale, bilevel, CMYK, and YCbCr images are +converted to RGB transparently. +Raster pixels are returned uncorrected by any colorimetry information +present in the directory. + +The parameter *stopOnError* specifies how to act if an error is +encountered while reading the image. If *stopOnError* is non-zero, then +an error will terminate the operation; otherwise :c:func:`TIFFReadRGBAImage` +will continue processing data until all the possible data in the +image have been requested. + +Notes +----- + +In C++ the *stopOnError* parameter defaults to 0. + +``SamplesPerPixel`` must be either 1, 2, 4, 8, or 16 bits. +Colorimetric samples/pixel must be either 1, 3, or 4 (i.e. +``SamplesPerPixel`` minus ``ExtraSamples``). + +Palettte image colormaps that appear to be incorrectly written +as 8-bit values are automatically scaled to 16-bits. + +:c:func:`IFFReadRGBAImage` is just a wrapper around the more general +:doc:`TIFFRGBAImage` facilities. + +Return values +------------- + +1 is returned if the image was successfully read and converted. +Otherwise, 0 is returned if an error was encountered and +*stopOnError* is zero. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``"Sorry, can not handle %d-bit pictures"``: + + The image had ``BitsPerSample`` other than 1, 2, 4, 8, or 16. + +``"Sorry, can not handle %d-channel images"``: + + The image had ``SamplesPerPixel`` other than 1, 3, or 4. + +``Missing needed "PhotometricInterpretation" tag``: + + The image did not have a tag that describes how to display + the data. + +``No "PhotometricInterpretation" tag, assuming RGB``: + + The image was missing a tag that describes how to display it, + but because it has 3 or 4 samples/pixel, it is assumed to be + RGB. + +``No "PhotometricInterpretation" tag, assuming min-is-black``: + + The image was missing a tag that describes how to display it, + but because it has 1 sample/pixel, it is assumed to be a grayscale + or bilevel image. + +``"No space for photometric conversion table"``: + + There was insufficient memory for a table used to convert + image samples to 8-bit RGB. + +``Missing required "Colormap" tag``: + + A Palette image did not have a required ``Colormap`` tag. + +``"No space for tile buffer"``: + + There was insufficient memory to allocate an i/o buffer. + +``"No space for strip buffer"``: + + There was insufficient memory to allocate an i/o buffer. + +``"Can not handle format"``: + + The image has a format (combination of ``BitsPerSample``, + ``SamplesPerPixel``, and ``PhotometricInterpretation``) + that :c:func:`TIFFReadRGBAImage` can not handle. + +``"No space for B&W mapping table"``: + + There was insufficient memory to allocate a table used to map + grayscale data to RGB. + +``"No space for Palette mapping table"``: + + There was insufficient memory to allocate a table used to map + data to 8-bit RGB. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFRGBAImage` (3tiff), +:doc:`TIFFReadRGBAStrip` (3tiff), +:doc:`TIFFReadRGBATile` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFReadRGBAStrip.rst b/doc/functions/TIFFReadRGBAStrip.rst new file mode 100644 index 00000000..22119574 --- /dev/null +++ b/doc/functions/TIFFReadRGBAStrip.rst @@ -0,0 +1,134 @@ +TIFFReadRGBAStrip +================= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFReadRGBAStrip(TIFF* tif, uint32_t row, uint32_t* raster) + +Description +----------- + +:c:func:`TIFFReadRGBAStrip` reads a single strip of a strip-based image +into memory, storing the result in the user supplied RGBA *raster*. +The raster is assumed to be an array of ``ImageWidth`` × ``RowsPerStrip`` +32-bit entries, where ``ImageWidth`` is the width of the image +(:c:macro:`TIFFTAG_IMAGEWIDTH`) and ``RowsPerStrip`` is the maximum lines +in a strip (:c:macro:`TIFFTAG_ROWSPERSTRIP`). + +The *row* value should be the row of the first row in the strip +(*strip* × ``RowsPerStrip``, zero based). + +Note that the raster is assume to be organized such that the pixel at location +(*x*, *y*) is *raster* [ *y* × *width* + *x* ]; with the raster origin in the +*lower-left hand corner* of the strip. That is bottom to top organization. +When reading a partial last strip in the file the last line of the image will +begin at the beginning of the buffer. + +Raster pixels are 8-bit packed red, green, blue, alpha samples. The macros +:c:macro:`TIFFGetR`, :c:macro:`TIFFGetG`, :c:macro:`TIFFGetB`, and +:c:macro:`TIFFGetA` should be used to access individual samples. Images +without Associated Alpha matting information have a constant Alpha of 1.0 +(255). + +See the :doc:`TIFFRGBAImage` page for more details on how various image types +are converted to RGBA values. + +Notes +----- + +Samples must be either 1, 2, 4, 8, or 16 bits. +Colorimetric samples/pixel must be either 1, 3, or 4 (i.e. ``SamplesPerPixel`` +- ``ExtraSamples``). + +Palette image colormaps that appear to be incorrectly written as 8-bit values +are automatically scaled to 16-bits. + +:c:func:`TIFFReadRGBAStrip` is just a wrapper around the more general +:doc:`TIFFRGBAImage` facilities. It's main advantage over the similar +:c:func:`TIFFReadRGBAImage` function is that for large images a single +buffer capable of holding the whole image doesn't need to be allocated, +only enough for one strip. The :c:func:`TIFFReadRGBATile` function +does a similar operation for tiled images. + +Return values +------------- + +1 is returned if the image was successfully read and converted. +Otherwise, 0 is returned if an error was encountered. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``"Sorry, can not handle %d-bit pictures"``: + + The image had ``BitsPerSample`` other than 1, 2, 4, 8, or 16. + +``"Sorry, can not handle %d-channel images"``: + + The image had ``SamplesPerPixel`` other than 1, 3, or 4. + +``Missing needed "PhotometricInterpretation" tag``: + + The image did not have a tag that describes how to display the data. + +``No "PhotometricInterpretation" tag, assuming RGB``: + + The image was missing a tag that describes how to display it, but because it + has 3 or 4 samples/pixel, it is assumed to be RGB. + +``No "PhotometricInterpretation" tag, assuming min-is-black\fP``: + + The image was missing a tag that describes how to display it, but + because it has 1 sample/pixel, it is assumed to be a grayscale or + bilevel image. + +``"No space for photometric conversion table"``: + + There was insufficient memory for a table used to convert image samples to + 8-bit RGB. + +``Missing required "Colormap" tag``: + + A Palette image did not have a required ``Colormap`` tag. + +``"No space for tile buffer"``: + + There was insufficient memory to allocate an i/o buffer. + +``"No space for strip buffer"``: + + There was insufficient memory to allocate an i/o buffer. + +``"Can not handle format"``: + + The image has a format (combination of ``BitsPerSample``, + ``SamplesPerPixel``, and ``PhotometricInterpretation``) + that :c:func:`TIFFReadRGBAImage` can not handle. + +``"No space for B&W mapping table"``: + + There was insufficient memory to allocate a table used to map grayscale data + to RGB. + +``"No space for Palette mapping table"``: + + There was insufficient memory to allocate a table used to map data to 8-bit + RGB. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFRGBAImage` (3tiff), +:doc:`TIFFReadRGBAImage` (3tiff), +:doc:`TIFFReadRGBATile` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFReadRGBATile.rst b/doc/functions/TIFFReadRGBATile.rst new file mode 100644 index 00000000..152f1053 --- /dev/null +++ b/doc/functions/TIFFReadRGBATile.rst @@ -0,0 +1,136 @@ +TIFFReadRGBATile +================ + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFReadRGBATile(TIFF* tif, uint32_t x, uint32_t y, uint32_t* raster) + +Description +----------- + +:c:func:`TIFFReadRGBATile` reads a single tile of a tile-based image into +memory, storing the result in the user supplied RGBA *raster*. +The raster is assumed to be an array of ``TileWidth`` × ``TileLength`` +32-bit entries, where ``TileWidth`` is the width of a tile +(:c:macro:`TIFFTAG_TILEWIDTH`) and ``TileLength`` is the height of a +tile (:c:macro:`TIFFTAG_TILELENGTH`). + +The *x* and *y* values are the offsets from the top left corner to the top +left corner of the tile to be read. They must be an exact multiple of the +tile width and length. + +Note that the raster is assume to be organized such that the pixel at +location +(*x*, *y*) is *raster* [ *y* × *width* + *x* ]; with the raster origin +in the *lower-left hand corner* of the tile. That is bottom to top +organization. Edge tiles which partly fall off the image will be filled +out with appropriate zeroed areas. + +Raster pixels are 8-bit packed red, green, blue, alpha samples. The macros +:c:macro:`TIFFGetR`, :c:macro:`TIFFGetG`, :c:macro:`TIFFGetB`, and +:c:macro:`TIFFGetA` should be used to access individual samples. Images +without Associated Alpha matting information have a constant Alpha of 1.0 +(255). + +See the :doc:`TIFFRGBAImage` page for more details on how various image +types are converted to RGBA values. + +Notes +----- + +Samples must be either 1, 2, 4, 8, or 16 bits. +Colorimetric samples/pixel must be either 1, 3, or 4 (i.e. +``SamplesPerPixel`` - ``ExtraSamples``). + +Palette image colormaps that appear to be incorrectly written as 8-bit +values are automatically scaled to 16-bits. + +:c:func:`TIFFReadRGBATile` is just a wrapper around the more general +:doc:`TIFFRGBAImage` facilities. It's main advantage over the similar +:c:func:`TIFFReadRGBAImage` function is that for large images a single +buffer capable of holding the whole image doesn't need to be allocated, +only enough for one tile. The :c:func:`TIFFReadRGBAStrip` function +does a similar operation for stripped images. + +Return values +------------- + +1 is returned if the image was successfully read and converted. +Otherwise, 0 is returned if an error was encountered. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``"Sorry, can not handle %d-bit pictures"``: + + The image had ``BitsPerSample`` other than 1, 2, 4, 8, or 16. + +``"Sorry, can not handle %d-channel images"``: + + The image had ``SamplesPerPixel`` other than 1, 3, or 4. + +``Missing needed "PhotometricInterpretation" tag``: + + The image did not have a tag that describes how to display the data. + +``No "PhotometricInterpretation" tag, assuming RGB``: + + The image was missing a tag that describes how to display it, but because it + has 3 or 4 samples/pixel, it is assumed to be RGB. + +``No "PhotometricInterpretation" tag, assuming min-is-black``: + + The image was missing a tag that describes how to display it, + but because it has 1 sample/pixel, it is assumed to be a grayscale + or bilevel image. + +``"No space for photometric conversion table"``: + + There was insufficient memory for a table used to convert + image samples to 8-bit RGB. + +``Missing required "Colormap" tag``: + + A Palette image did not have a required ``Colormap`` tag. + +``"No space for tile buffer"``: + + There was insufficient memory to allocate an i/o buffer. + +``"No space for strip buffer"``: + + There was insufficient memory to allocate an i/o buffer. + +``"Can not handle format"``: + + The image has a format (combination of ``BitsPerSample``, + ``SamplesPerPixel``, and ``PhotometricInterpretation``) + that :c:func:`TIFFReadRGBAImage` can not handle. + +``"No space for B&W mapping table"``: + + There was insufficient memory to allocate a table used to map + grayscale data to RGB. + +``"No space for Palette mapping table"``: + + There was insufficient memory to allocate a table used to map data to 8-bit + RGB. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFRGBAImage` (3tiff), +:doc:`TIFFReadRGBAImage` (3tiff), +:doc:`TIFFReadRGBAStrip` (3tiff), +:doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFReadRawStrip.rst b/doc/functions/TIFFReadRawStrip.rst new file mode 100644 index 00000000..82214d21 --- /dev/null +++ b/doc/functions/TIFFReadRawStrip.rst @@ -0,0 +1,43 @@ +TIFFReadRawStrip +================ + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: tsize_t TIFFReadRawStrip(TIFF* tif, tstrip_t strip, tdata_t buf, tsize_t size) + +Description +----------- + +Read the contents of the specified strip into the (user supplied) data buffer. +Note that the value of *strip* is a "raw strip number". That is, the caller +must take into account whether or not the data is organized in separate planes +(``PlanarConfiguration`` = 2). +To read a full strip of data the data buffer should typically be at least as +large as the number returned by :c:func:`TIFFStripSize`. + +Return values +------------- + +The actual number of bytes of data that were placed in *buf* is returned; +:c:func:`TIFFReadRawStrip` returns -1 if an error was encountered. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFReadEncodedStrip` (3tiff), +:doc:`TIFFReadScanline` (3tiff), +:doc:`TIFFStripSize` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFReadRawTile.rst b/doc/functions/TIFFReadRawTile.rst new file mode 100644 index 00000000..68af1e7d --- /dev/null +++ b/doc/functions/TIFFReadRawTile.rst @@ -0,0 +1,45 @@ +TIFFReadRawTile +=============== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: tsize_t TIFFReadRawTile(TIFF* tif, ttile_t tile, tdata_t buf, tsize_t size) + +Description +----------- + +Read the contents of the specified tile into the (user supplied) data buffer. +Note that the value of *tile* is a "raw tile number". That is, the caller +must take into account whether or not the data is organized in separate planes +(``PlanarConfiguration`` = 2). +:c:func:`TIFFComputeTile` automatically does this when converting an (x,y,z,sample) +coordinate quadruple to a tile number. To read a full tile of data the data buffer +should typically be at least as large as the value returned by +:c:func:`TIFFTileSize`. + +Return values +------------- + +The actual number of bytes of data that were placed in *buf* is returned; +:c:func:`TIFFReadRawTile` returns -1 if an error was encountered. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFReadEncodedTile` (3tiff), +:doc:`TIFFReadTile` (3tiff), +:doc:`TIFFTileSize` (3tiff), +:doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFReadScanline.rst b/doc/functions/TIFFReadScanline.rst new file mode 100644 index 00000000..ecca8b92 --- /dev/null +++ b/doc/functions/TIFFReadScanline.rst @@ -0,0 +1,75 @@ +TIFFReadScanline +================ + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFReadScanline(TIFF* tif, tdata_t buf, uint32_t row, tsample_t sample) + +Description +----------- + +Read the data for the specified row into the (user supplied) data buffer +*buf*. The data are returned decompressed and, in the native byte- and +bit-ordering, but are otherwise packed (see further below). The buffer +must be large enough to hold an entire scanline of data. Applications +should call the routine :c:func:`TIFFScanlineSize` to find out the size +(in bytes) of a scanline buffer. +The *row* parameter is always used by :c:func:`TIFFReadScanline`; the +*sample* parameter is used only if data are organized in separate planes +(``PlanarConfiguration`` = 2). + +Notes +----- + +The library attempts to hide bit- and byte-ordering differences between the +image and the native machine by converting data to the native machine order. +Bit reversal is done if the ``FillOrder`` tag is opposite to the native +machine bit order. 16- and 32-bit samples are automatically byte-swapped if +the file was written with a byte order opposite to the native machine byte +order, + +In C++ the *sample* parameter defaults to 0. + +Return values +------------- + +:c:func:`TIFFReadScanline` returns -1 if it detects an error; otherwise 1 is +returned. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``"Compression algorithm does not support random access"``: + + Data was requested in a non-sequential order from a file that uses a + compression algorithm and that has ``RowsPerStrip`` greater than one. + That is, data in the image is stored in a compressed form, and with multiple + rows packed into a strip. In this case, the library does not support random + access to the data. The data should either be accessed sequentially, or the + file should be converted so that each strip is made up of one row of data. + +Bugs +---- + +Reading subsampled YCbCR data does not work correctly because, for +``PlanarConfiguration`` = 2, the size of a scanline is not calculated on a +per-sample basis, and for ``PlanarConfiguration`` = 1, the library does not +unpack the block-interleaved samples; use the strip- and +tile-based interfaces to read these formats. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFReadEncodedStrip` (3tiff), +:doc:`TIFFReadRawStrip` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFReadTile.rst b/doc/functions/TIFFReadTile.rst new file mode 100644 index 00000000..b7d6c31f --- /dev/null +++ b/doc/functions/TIFFReadTile.rst @@ -0,0 +1,58 @@ +TIFFReadTile +============ + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: tsize_t TIFFReadTile(TIFF* tif, tdata_t buf, uint32_t x, uint32_t y, uint32_t z, tsample_t sample) + +Description +----------- + +Return the data for the tile *containing* the specified coordinates. The +data placed in *buf* are returned decompressed and, typically, in the +native byte- and bit-ordering, but are otherwise packed (see further +below). The buffer must be large enough to hold an entire tile of data. +Applications should call the routine :c:func:`TIFFTileSize` to find out +the size (in bytes) of a tile buffer. The *x* and *y* parameters are +always used by :c:func:`TIFFReadTile`. The *z* parameter is used if the +image is deeper than 1 slice (``ImageDepth`` > 1). The *sample* +parameter is used only if data are organized in separate planes ( +``PlanarConfiguration`` = 2). + +Notes +----- + +The library attempts to hide bit- and byte-ordering differences between +the image and the native machine by converting data to the native machine +order. Bit reversal is done if the ``FillOrder`` tag is opposite to the +native machine bit order. 16- and 32-bit samples are automatically +byte-swapped if the file was written with a byte order opposite to the +native machine byte order. + +Return values +------------- + +:c:func:`TIFFReadTile` returns -1 if it detects an error; otherwise the +number of bytes in the decoded tile is returned. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +See also +-------- + +:doc:`TIFFCheckTile` (3tiff), +:doc:`TIFFComputeTile` (3tiff), +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFReadEncodedTile` (3tiff), +:doc:`TIFFReadRawTile` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFSetDirectory.rst b/doc/functions/TIFFSetDirectory.rst new file mode 100644 index 00000000..a1382700 --- /dev/null +++ b/doc/functions/TIFFSetDirectory.rst @@ -0,0 +1,58 @@ +TIFFSetDirectory +================ + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFSetDirectory(TIFF* tif, tdir_t dirnum) + +.. c:fucntion:: int TIFFSetSubDirectory(TIFF* tif, uint64_t diroff) + +Description +----------- + +:c:func:`TIFFSetDirectory` changes the current directory and reads its +contents with :c:func:`TIFFReadDirectory`. The parameter *dirnum* +specifies the subfile/directory as an integer number, with the first +directory numbered zero. + +:c:func:`TIFFSetSubDirectory` acts like :c:func:`TIFFSetDirectory`, +except the directory is specified as a file offset instead of an index; +this is required for accessing subdirectories linked through a +``SubIFD`` tag. + +Return values +------------- + +On successful return 1 is returned. Otherwise, 0 is returned if *dirnum* +or *diroff* specifies a non-existent directory, or if an error was +encountered while reading the directory's contents. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``"%s: Error fetching directory count"``: + + An error was encountered while reading the "directory count" field. + +``"%s: Error fetching directory link"``: + + An error was encountered while reading the "link value" that points to the + next directory in a file. + +See also +-------- + +:doc:`TIFFCurrentDirectory` (3tiff), +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFReadDirectory` (3tiff), +:doc:`TIFFWriteDirectory` (3tiff), +:doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFSetField.rst b/doc/functions/TIFFSetField.rst new file mode 100644 index 00000000..fff7252f --- /dev/null +++ b/doc/functions/TIFFSetField.rst @@ -0,0 +1,397 @@ +TIFFSetField +============ + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + #include <stdarg.h>" + +.. c:function:: int TIFFSetField(TIFF* tif, ttag_t tag, ...) + +.. c:function:: int TIFFVSetField(TIFF* tif, ttag_t tag, va_list ap) + +Description +----------- + +:c:func:`TIFFSetField` sets the value of a field or pseudo-tag in the +current directory associated with the open TIFF file *tif*. +(A *pseudo-tag* is a parameter that is used to control the operation of +the TIFF library but whose value is not read or written to the underlying +file.) To set the value of a field the file must have been previously +opened for writing with :c:func:`TIFFOpen`. +Pseudo-tags can be set whether the file was opened for reading or writing. +The field is identified by *tag*, one of the values defined in the include +file :file:`tiff.h` (see also the table below). +The actual value is specified using a variable argument list, as +prescribed by the :file:`stdarg.h` interface. + +:c:func:`TIFFVSetField` is functionally equivalent to :c:func:`TIFFSetField` +except that it takes a pointer to a variable argument list. +:c:func:`TIFFVSetField` is useful for writing routines that are layered on +top of the functionality provided by :c:func:`TIFFSetField`. + +The tags understood by :program:`libtiff`, the number of parameter values, +and the expected types for the parameter values are shown below. +The data types are: + +.. list-table:: Tag data types + :widths: 5 15 + :header-rows: 1 + + * - Type + - Description + + * - char* + - a null-terminated string corresponding to the ``ASCII`` data type + * - uint16_t + - an unsigned 16-bit value + * - uint32_t + - an unsigned 32-bit value; + * - uint16_t* + - an array of unsigned 16-bit values. + * - void* + an array of data values of unspecified type. + +Consult the TIFF specification for information on the meaning of each tag. + + .. list-table:: Tag properties + :widths: 5 3 5 10 + :header-rows: 1 + + * - Tag name + - Count + - Types + - Notes + + + * - :c:macro:`TIFFTAG_ARTIST` + - 1 + - :c:type:`char*` + - + * - :c:macro:`TIFFTAG_BADFAXLINES` + - 1 + - :c:type:`uint32_t` + - + * - :c:macro:`TIFFTAG_BITSPERSAMPLE` + - 1 + - :c:type:`uint16_t` + - †+ * - :c:macro:`TIFFTAG_CLEANFAXDATA` + - 1 + - :c:type:`uint16_t` + - + * - :c:macro:`TIFFTAG_COLORMAP` + - 3 + - :c:type:`uint16_t*` + - :c:expr:`1<<BitsPerSample` arrays + * - :c:macro:`TIFFTAG_COMPRESSION` + - 1 + - :c:type:`uint16_t` + - †+ * - :c:macro:`TIFFTAG_CONSECUTIVEBADFAXLINES` + - 1 + - :c:type:`uint32_t` + - + * - :c:macro:`TIFFTAG_COPYRIGHT` + - 1 + - :c:type:`char*` + - + * - :c:macro:`TIFFTAG_DATETIME` + - 1 + - :c:type:`char*` + - + * - :c:macro:`TIFFTAG_DOCUMENTNAME` + - 1 + - :c:type:`char*` + - + * - :c:macro:`TIFFTAG_DOTRANGE` + - 2 + - :c:type:`uint16_t` + - + * - :c:macro:`TIFFTAG_EXTRASAMPLES` + - 2 + - :c:type:`uint16_t`, :c:type:`uint16_t*` + - †count, types array + * - :c:macro:`TIFFTAG_FAXFILLFUNC` + - 1 + - :c:type:`TIFFFaxFillFunc` + - G3/G4 compression pseudo-tag + * - :c:macro:`TIFFTAG_FAXMODE` + - 1 + - :c:type:`int` + - †G3/G4 compression pseudo-tag + * - :c:macro:`TIFFTAG_FILLORDER` + - 1 + - :c:type:`uint16_t` + - †+ * - :c:macro:`TIFFTAG_GROUP3OPTIONS` + - 1 + - :c:type:`uint32_t` + - †+ * - :c:macro:`TIFFTAG_GROUP4OPTIONS` + - 1 + - :c:type:`uint32_t` + - †+ * - :c:macro:`TIFFTAG_HALFTONEHINTS` + - 2 + - :c:type:`uint16_t` + - + * - :c:macro:`TIFFTAG_HOSTCOMPUTER` + - 1 + - :c:type:`char*` + - + * - :c:macro:`TIFFTAG_ICCPROFILE` + - 2 + - :c:type:`uint32_t`, :c:type:`void*` + - count, profile data* + * - :c:macro:`TIFFTAG_IMAGEDEPTH` + - 1 + - :c:type:`uint32_t` + - †+ * - :c:macro:`TIFFTAG_IMAGEDESCRIPTION` + - 1 + - :c:type:`char*` + - + * - :c:macro:`TIFFTAG_IMAGELENGTH` + - 1 + - :c:type:`uint32_t` + - + * - :c:macro:`TIFFTAG_IMAGEWIDTH` + - 1 + - :c:type:`uint32_t` + - †+ * - :c:macro:`TIFFTAG_INKNAMES` + - 2 + - :c:type:`uint16_t`, :c:type:`char*` + - + * - :c:macro:`TIFFTAG_INKSET` + - 1 + - :c:type:`uint16_t` + - †+ * - :c:macro:`TIFFTAG_JPEGCOLORMODE` + - 1 + - :c:type:`int` + - †JPEG pseudo-tag + * - :c:macro:`TIFFTAG_JPEGQUALITY` + - 1 + - :c:type:`int` + - JPEG pseudo-tag + * - :c:macro:`TIFFTAG_JPEGTABLES` + - 2 + - :c:type:`uint32_t*`, :c:type:`void*` + - †count, tables + * - :c:macro:`TIFFTAG_JPEGTABLESMODE` + - 1 + - :c:type:`int` + - †JPEG pseudo-tag + * - :c:macro:`TIFFTAG_MAKE` + - 1 + - :c:type:`char*` + - + * - :c:macro:`TIFFTAG_MATTEING` + - 1 + - :c:type:`uint16_t` + - †+ * - :c:macro:`TIFFTAG_MAXSAMPLEVALUE` + - 1 + - :c:type:`uint16_t` + - + * - :c:macro:`TIFFTAG_MINSAMPLEVALUE` + - 1 + - :c:type:`uint16_t` + - + * - :c:macro:`TIFFTAG_MODEL` + - 1 + - :c:type:`char*` + - + * - :c:macro:`TIFFTAG_ORIENTATION` + - 1 + - :c:type:`uint16_t` + - + * - :c:macro:`TIFFTAG_PAGENAME` + - 1 + - :c:type:`char*` + - + * - :c:macro:`TIFFTAG_PAGENUMBER` + - 2 + - :c:type:`uint16_t` + - + * - :c:macro:`TIFFTAG_PHOTOMETRIC` + - 1 + - :c:type:`uint16_t` + - + * - :c:macro:`TIFFTAG_PHOTOSHOP` + - ? + - :c:type:`uint32_t`, :c:type:`void*` + - count, data + * - :c:macro:`TIFFTAG_PLANARCONFIG` + - 1 + - :c:type:`uint16_t` + - †+ * - :c:macro:`TIFFTAG_PREDICTOR` + - 1 + - :c:type:`uint16_t` + - †+ * - :c:macro:`TIFFTAG_PRIMARYCHROMATICITIES` + - 1 + - :c:type:`float*` + - 6-entry array + * - :c:macro:`TIFFTAG_REFERENCEBLACKWHITE` + - 1 + - :c:type:`float*` + - †6-entry array + * - :c:macro:`TIFFTAG_RESOLUTIONUNIT` + - 1 + - :c:type:`uint16_t` + - + * - :c:macro:`TIFFTAG_RICHTIFFIPTC` + - 2 + - :c:type:`uint32_t`, :c:type:`void*` + - count, data + * - :c:macro:`TIFFTAG_ROWSPERSTRIP` + - 1 + - :c:type:`uint32_t` + - †must be > 0 + * - :c:macro:`TIFFTAG_SAMPLEFORMAT` + - 1 + - :c:type:`uint16_t` + - †+ * - :c:macro:`TIFFTAG_SAMPLESPERPIXEL` + - 1 + - :c:type:`uint16_t` + - †value must be ≤ 4 + * - :c:macro:`TIFFTAG_SMAXSAMPLEVALUE` + - 1 + - :c:type:`double` + - + * - :c:macro:`TIFFTAG_SMINSAMPLEVALUE` + - 1 + - :c:type:`double` + - + * - :c:macro:`TIFFTAG_SOFTWARE` + - 1 + - :c:type:`char*` + - + * - :c:macro:`TIFFTAG_STONITS` + - 1 + - :c:type:`double` + - †+ * - :c:macro:`TIFFTAG_SUBFILETYPE` + - 1 + - :c:type:`uint32_t` + - + * - :c:macro:`TIFFTAG_SUBIFD` + - 2 + - :c:type:`uint16_t`, :c:type:`uint64_t*` + - count, offsets array + * - :c:macro:`TIFFTAG_TARGETPRINTER` + - 1 + - :c:type:`char*` + - + * - :c:macro:`TIFFTAG_THRESHHOLDING` + - 1 + - :c:type:`uint16_t` + - + * - :c:macro:`TIFFTAG_TILEDEPTH` + - 1 + - :c:type:`uint32_t` + - †+ * - :c:macro:`TIFFTAG_TILELENGTH` + - 1 + - :c:type:`uint32_t` + - †must be a multiple of 8 + * - :c:macro:`TIFFTAG_TILEWIDTH` + - 1 + - :c:type:`uint32_t` + - †must be a multiple of 8 + * - :c:macro:`TIFFTAG_TRANSFERFUNCTION` + - 1 or 3‡ + - :c:type:`uint16_t*` + - :c:expr:`1<<BitsPerSample` entry arrays + * - :c:macro:`TIFFTAG_WHITEPOINT` + - 1 + - :c:type:`float*` + - 2-entry array + * - :c:macro:`TIFFTAG_XMLPACKET` + - 2 + - :c:type:`uint32_t`, :c:type:`void*` + - count, data + * - :c:macro:`TIFFTAG_XPOSITION` + - 1 + - :c:type:`float` + - + * - :c:macro:`TIFFTAG_XRESOLUTION` + - 1 + - :c:type:`float` + - + * - :c:macro:`TIFFTAG_YCBCRCOEFFICIENTS` + - 1 + - :c:type:`float*` + - †3-entry array + * - :c:macro:`TIFFTAG_YCBCRPOSITIONING` + - 1 + - :c:type:`uint16_t` + - †+ * - :c:macro:`TIFFTAG_YCBCRSAMPLING` + - 2 + - :c:type:`uint16_t` + - †+ * - :c:macro:`TIFFTAG_YPOSITION` + - 1 + - :c:type:`float` + - + * - :c:macro:`TIFFTAG_YRESOLUTION` + - 1 + - :c:type:`float` + - + +†: + Tag may not have its values changed once data is written. + +‡: + + If ``SamplesPerPixel`` is one, then a single array is passed; + otherwise three arrays should be passed. + +\*: + The contents of this field are quite complex. See + "The ICC Profile Format Specification", + Annex B.3 "Embedding ICC Profiles in TIFF Files" + (available at http://www.color.org) for an explanation. + +Return values +------------- + +1 is returned if the operation was successful. +Otherwise, 0 is returned if an error was detected. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``%s: Cannot modify tag "%s" while writing``: + + Data has already been written to the file, so the + specified tag's value can not be changed. + This restriction is applied to all tags that affect + the format of written data. + +``%d: Bad value for "%s"``: + + An invalid value was supplied for the named tag. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFGetField` (3tiff), +:doc:`TIFFSetDirectory` (3tiff), +:doc:`TIFFWriteDirectory` (3tiff), +:doc:`TIFFReadDirectory` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFWarning.rst b/doc/functions/TIFFWarning.rst new file mode 100644 index 00000000..8a0406bb --- /dev/null +++ b/doc/functions/TIFFWarning.rst @@ -0,0 +1,47 @@ +TIFFWarning +=========== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + #include <stdarg.h> + +.. c:function:: void TIFFWarning(const char* module, const char* fmt, ...) + +.. c:type:: void (*TIFFWarningHandler)(const char* module, const char* fmt, va_list ap); + +.. c:function:: TIFFWarningHandler TIFFSetWarningHandler(TIFFWarningHandler handler) + +Description +----------- + +:c:func:`TIFFWarning` invokes the library-wide warning handler function +to (normally) write a warning message to the ``stderr``. +The *fmt* parameter is a :c:func:`printf` format string, and any number +arguments can be supplied. The *module* parameter is interpreted as a +string that, if non-zero, should be printed before the message; it +typically is used to identify the software module in which a warning is +detected. + +Applications that desire to capture control in the event of a warning should +use :c:func:`TIFFSetWarningHandler` to override the default warning handler. +A :c:macro:`NULL` (0) warning handler function may be installed to suppress +error messages. + +Return values +------------- + +:c:func:`TIFFSetWarningHandler` returns a reference to the previous error +handling function. + +See also +-------- + +:doc:`TIFFError` (3tiff), +:doc:`libtiff` (3tiff), +printf (3) diff --git a/doc/functions/TIFFWriteDirectory.rst b/doc/functions/TIFFWriteDirectory.rst new file mode 100644 index 00000000..5c2e3f10 --- /dev/null +++ b/doc/functions/TIFFWriteDirectory.rst @@ -0,0 +1,121 @@ +TIFFWriteDirectory +================== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + + +.. c:function:: int TIFFWriteDirectory(TIFF* tif) + +.. c:function:: int TIFFRewriteDirectory(TIFF* tif) + +.. c:function:: int TIFFCheckpointDirectory(TIFF* tif) + +Description +----------- + +:c:func:`TIFFWriteDirectory` will write the contents of the current +directory to the file and setup to create a new subfile in the same +file. Applications only need to call :c:func:`TIFFWriteDirectory` +when writing multiple subfiles to a single TIFF file. +:c:func:`TIFFWriteDirectory` is automatically called by +:c:func:`TIFFClose` and :c:func:`TIFFFlush` to write a modified +directory if the file is open for writing. + +The :c:func:`TIFFRewriteDirectory` function operates similarly to +:c:func:`TIFFWriteDirectory`, but can be called with directories +previously read or written that already have an established location +in the file. It will rewrite the directory, but instead of placing it +at its old location (as :c:func:`TIFFWriteDirectory` would) it will +place them at the end of the file, correcting the pointer from the +preceding directory or file header to point to it's new location. This +is particularly important in cases where the size of the directory and +pointed to data has grown, so it won't fit in the space available at the +old location. + +The :c:func:`TIFFCheckpointDirectory` writes the current state of the +tiff directory into the file to make what is currently in the file +readable. Unlike :c:func:`TIFFWriteDirectory`, +:c:func:`TIFFCheckpointDirectory` does not free up the directory data +structures in memory, so they can be updated (as strips/tiles are +written) and written again. Reading such a partial file you will at +worst get a tiff read error for the first strip/tile encountered that +is incomplete, but you will at least get all the valid data in the file +before that. When the file is complete, just use +:c:func:`TIFFWriteDirectory` as usual to finish it off cleanly. + +Return values +------------- + +1 is returned when the contents are successfully written to the file. +Otherwise, 0 is returned if an error was encountered when writing +the directory contents. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``"Error post-encoding before directory write"``: + + Before writing the contents of the current directory, any pending data are + flushed. This message indicates that an error occurred while doing this. + +``"Error flushing data before directory write"``: + + Before writing the contents of the current directory, any pending data are + flushed. This message indicates that an error occurred while doing this. + +``"Cannot write directory, out of space"``: + + There was not enough space to allocate a temporary area for the directory that + was to be written. + +``"Error writing directory count"``: + + A write error occurred when writing the count of fields in the directory. + +``"Error writing directory contents"``: + + A write error occurred when writing the directory fields. + +``"Error writing directory link"``: + + A write error occurred when writing the link to the next directory. + +``Error writing data for field "%s"``: + + A write error occurred when writing indirect data for the specified field. + +``"Error writing TIFF header"``: + + A write error occurred when re-writing header at the front of the file. + +``"Error fetching directory count"``: + + A read error occurred when fetching the directory count field for + a previous directory. + This can occur when setting up a link to the directory that is being + written. + +``"Error fetching directory link"``: + + A read error occurred when fetching the directory link field for + a previous directory. + This can occur when setting up a link to the directory that is being + written. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFError` (3tiff), +:doc:`TIFFReadDirectory` (3tiff), +:doc:`TIFFSetDirectory` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFWriteEncodedStrip.rst b/doc/functions/TIFFWriteEncodedStrip.rst new file mode 100644 index 00000000..caf387ee --- /dev/null +++ b/doc/functions/TIFFWriteEncodedStrip.rst @@ -0,0 +1,80 @@ +TIFFWriteEncodedStrip +===================== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: tsize_t TIFFWriteEncodedStrip(TIFF* tif, tstrip_t strip, tdata_t buf, tsize_t size) + +Description +----------- + +Compress *size* bytes of raw data from *buf* and write the result to the +specified strip; replacing any previously written data. Note that the +value of *strip* is a "raw strip number". That is, the caller must take +into account whether or not the data are organized in separate planes +(``PlanarConfiguration`` = 2). + +Notes +----- + +The library writes encoded data using the native machine byte order. +Correctly implemented TIFF readers are expected to do any necessary +byte-swapping to correctly process image data with ``BitsPerSample`` +greater than 8. + +The strip number must be valid according to the current settings of the +``ImageLength`` and ``RowsPerStrip`` tags. +An image may be dynamically grown by increasing the value of +``ImageLength`` prior to each call to ``TIFFWriteEncodedStrip``. + +Return values +------------- + +-1 is returned if an error was encountered. Otherwise, the value of +*size* is returned. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``%s: File not open for writing``: + + The file was opened for reading, not writing. + +``Can not write scanlines to a tiled image``: + + The image is assumed to be organized in tiles because the + ``TileWidth`` and ``TileLength`` tags have been set with + :c:func:`TIFFSetField`. + +``%s: Must set "ImageWidth" before writing data\fP``: + + The image's width has not be set before the first write. See + :c:func:`TIFFSetField` for information on how to do this. + +``%s: Must set "PlanarConfiguration" before writing data``: + + The organization of data has not be defined before the first + write. See :c:func:`TIFFSetField` for information on how to do + this. + +``%s: No space for strip arrays"``: + + There was not enough space for the arrays that hold strip offsets and + byte counts. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFWriteScanline` (3tiff), +:doc:`TIFFWriteRawStrip` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFWriteEncodedTile.rst b/doc/functions/TIFFWriteEncodedTile.rst new file mode 100644 index 00000000..62cfdfe4 --- /dev/null +++ b/doc/functions/TIFFWriteEncodedTile.rst @@ -0,0 +1,76 @@ +TIFFWriteEncodedTile +==================== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: tsize_t TIFFWriteEncodedTile(TIFF* tif, ttile_t tile, tdata_t buf, tsize_t size) + +Description +----------- + +Compress *size* bytes of raw data from *buf* and **append** the result +to the end of the specified tile. Note that the value of *tile* is a +"raw tile number". That is, the caller must take into account whether +or not the data are organized in separate planes +(``PlanarConfiguration`` = 2). +:c:func:`TIFFComputeTile` automatically does this when converting an +(x,y,z,sample) coordinate quadruple to a tile number. + +Notes +----- + +The library writes encoded data using the native machine byte order. +Correctly implemented TIFF readers are expected to do any necessary +byte-swapping to correctly process image data with ``BitsPerSample`` +greater than 8. + +Return values +------------- + +-1 is returned if an error was encountered. Otherwise, the value of +*size* is returned. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``%s: File not open for writing``: + + The file was opened for reading, not writing. + +``Can not write tiles to a stripped image``: + + The image is assumed to be organized in strips because neither of the + ``TileWidth`` or ``TileLength`` tags have been set with + :c:func:`TIFFSetField`. + +``%s: Must set "ImageWidth" before writing data``: + + The image's width has not been set before the first write. See + :c:func:`TIFFSetField` for information on how to do this. + +``%s: Must set "PlanarConfiguration" before writing data``: + + The organization of data has not be defined before the first write. + See :c:func:`TIFFSetField` for information on how to do this. + +``%s: No space for tile arrays"``: + + There was not enough space for the arrays that hold tile offsets and + byte counts. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFWriteTile` (3tiff), +:doc:`TIFFWriteRawTile` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFWriteRawStrip.rst b/doc/functions/TIFFWriteRawStrip.rst new file mode 100644 index 00000000..3b6c59bd --- /dev/null +++ b/doc/functions/TIFFWriteRawStrip.rst @@ -0,0 +1,75 @@ +TIFFWriteRawStrip +================= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: tsize_t TIFFWriteRawStrip(TIFF* tif, tstrip_t strip, tdata_t buf, tsize_t size) + +Description +----------- + +Append *size* bytes of raw data to the specified strip. + +Notes +----- + +The strip number must be valid according to the current settings of the +``ImageLength`` and ``RowsPerStrip`` tags. +An image may be dynamically grown by increasing the value of +``ImageLength`` prior to each call to :c:func:`TIFFWriteRawStrip`. + +Return values +------------- + +-1 is returned if an error occurred. Otherwise, the value of *size* is +returned. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``%s: File not open for writing``: + + The file was opened for reading, not writing. + +``Can not write scanlines to a tiled image``: + + The image is assumed to be organized in tiles because the + ``TileWidth`` and ``TileLength`` tags have been set with + :c:func:`TIFFSetField`. + +``%s: Must set "ImageWidth" before writing data``: + + The image's width has not be set before the first write. + See :c:func:`TIFFSetField` for information on how to do this. + +``%s: Must set "PlanarConfiguration" before writing data``: + + The organization of data has not be defined before the first write. + See :c:func:`TIFFSetField` for information on how to do this. + +``%s: No space for strip arrays"``: + + There was not enough space for the arrays that hold strip + offsets and byte counts. + +``%s: Strip %d out of range, max %d``: + + The specified strip is not a valid strip according to the + currently specified image dimensions. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFWriteEncodedStrip` (3tiff), +:doc:`TIFFWriteScanline` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFWriteRawTile.rst b/doc/functions/TIFFWriteRawTile.rst new file mode 100644 index 00000000..c69575b4 --- /dev/null +++ b/doc/functions/TIFFWriteRawTile.rst @@ -0,0 +1,66 @@ +TIFFWriteRawTile +================ + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: tsize_t TIFFWriteRawTile(TIFF* tif, ttile_t tile, tdata_t buf, tsize_tsize) + +Description +----------- + +Append *size* bytes of raw data to the specified tile. + +Return values +------------- + +-1 is returned if an error occurred. Otherwise, the value of *size* is returned. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``%s: File not open for writing``: + + The file was opened for reading, not writing. + +``Can not write tiles to a stripped image``: + + The image is assumed to be organized in strips because neither of the + ``TileWidth`` or ``TileLength`` tags have been set with + :c:func:`TIFFSetField`. + +``%s: Must set "ImageWidth" before writing data``: + + The image's width has not be set before the first write. + See :c:func:`TIFFSetField` for information on how to do this. + +``%s: Must set "PlanarConfiguration" before writing data``: + + The organization of data has not be defined before the first write. + See :c:func:`TIFFSetField` for information on how to do this. + +``%s: No space for tile arrays``: + + There was not enough space for the arrays that hold tile offsets and + byte counts. + +``%s: Specified tile %d out of range, max %d``: + + The specified tile is not valid according to the currently specified + image dimensions. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFWriteEncodedTile` (3tiff), +:doc:`TIFFWriteScanline` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFWriteScanline.rst b/doc/functions/TIFFWriteScanline.rst new file mode 100644 index 00000000..3ae180b8 --- /dev/null +++ b/doc/functions/TIFFWriteScanline.rst @@ -0,0 +1,124 @@ +TIFFWriteScanline +================= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFWriteScanline(TIFF* tif, tdata_t buf, uint32_t row, tsample_t sample) + +Description +----------- + +Write data to a file at the specified row. The *sample* parameter is +used only if data are organized in separate planes +(``PlanarConfiguration`` = 2). +The data are assumed to be uncompressed and in the native bit- and +byte-order of the host machine. The data written to the file is +compressed according to the compression scheme of the current +TIFF directory (see further below). If the current scanline is past the +end of the current subfile, the ``ImageLength`` field is automatically +increased to include the scanline (except for ``PlanarConfiguration`` = 2, +where the ``ImageLength`` cannot be changed once the first data are +written). If the ``ImageLength`` is increased, the ``StripOffsets`` +and ``StripByteCounts`` fields are similarly enlarged to reflect data +written past the previous end of image. + +Notes +----- + +The library writes encoded data using the native machine byte order. +Correctly implemented TIFF readers are expected to do any necessary +byte-swapping to correctly process image data with ``BitsPerSample`` +greater than 8. The library attempts to hide bit-ordering differences +between the image and the native machine by converting data from the +native machine order. + +In C++ the *sample* parameter defaults to 0. + +Once data are written to a file for the current directory, the values of +certain tags may not be altered; see :c:func:`TIFFSetField` for more +information. + +It is not possible to write scanlines to a file that uses a tiled +organization. The routine :c:func:`TIFFIsTiled` can be used to +determine if the file is organized as tiles or strips. + +Return values +------------- + +:c:func:`TIFFWriteScanline` returns -1 if it immediately detects an +error and 1 for a successful write. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +``%s: File not open for writing``: + + The file was opened for reading, not writing. + +``"Can not write scanlines to a tiled image"``: + + An attempt was made to write a scanline to a tiled image. The image + is assumed to be organized in tiles because the ``TileWidth`` and + ``TileLength`` tags have been set with :c:func:`TIFFSetField`. + +``"Compression algorithm does not support random access"``: + + Data was written in a non-sequential order to a file that uses a + compression algorithm and that has ``RowsPerStrip`` greater than one. + That is, data in the image is to be stored in a compressed form, and + with multiple rows packed into a strip. In this case, the library + does not support random access to the data. The data should either be + written as entire strips, sequentially by rows, or the value of + ``RowsPerStrip`` should be set to one. + +``%s: Must set "ImageWidth" before writing data``: + + The image's width has not be set before the first write. + See :c:func:`TIFFSetField` for information on how to do this. + +``%s: Must set "PlanarConfiguration" before writing data``: + + The organization of data has not be defined before the first write. + See :c:func:`TIFFSetField` for information on how to do this. + +``Can not change "ImageLength" when using separate planes``: + + Separate image planes are being used (``PlanarConfiguration`` = 2), + but the number of rows has not been specified before the first write. + The library supports the dynamic growth of an image only when data + are organized in a contiguous manner (``PlanarConfiguration`` = 1). + +``"%d: Sample out of range, max %d"``: + + The *sample* parameter was greater than the value of the + ``SamplesPerPixel`` tag. + +``%s: No space for strip arrays``: + + There was not enough space for the arrays that hold strip offsets and + byte counts. + +Bugs +---- + +Writing subsampled YCbCR data does not work correctly because, for +``PlanarConfiguration`` = 2 the size of a scanline is not calculated on +a per-sample basis, and for ``PlanarConfiguration`` = 1 the library +does not pack the block-interleaved samples. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFWriteEncodedStrip` (3tiff), +:doc:`TIFFWriteRawStrip` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFWriteTile.rst b/doc/functions/TIFFWriteTile.rst new file mode 100644 index 00000000..3e25d2c1 --- /dev/null +++ b/doc/functions/TIFFWriteTile.rst @@ -0,0 +1,52 @@ +TIFFWriteTile +============= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +TIFFWriteTile \- encode and write a tile of data to an open TIFF file + +.. c:function:: tsize_t TIFFWriteTile(TIFF* tif, tdata_t buf, uint32_t x, uint32_t y, uint32_t z, tsample_t sample) + +Description +----------- + +Write the data for the tile *containing* the specified coordinates. The +data in *buf* are (potentially) compressed, and written to the +indicated file, normally being appended to the end of the file. The +buffer must be contain an entire tile of data. Applications should +call the routine :c:func:`TIFFTileSize` to find out the size (in bytes) +of a tile buffer. The *x* and *y* parameters are always used by +:c:func:`TIFFWriteTile`. The *z* parameter is used if the image is +deeper than 1 slice (``ImageDepth`` > 1). +The *sample* parameter is used only if data are organized in separate +planes (``PlanarConfiguration`` = 2). + +Return values +------------- + +:c:func:`TIFFWriteTile` returns -1 if it detects an error; otherwise +the number of bytes in the tile is returned. + +Diagnostics +----------- + +All error messages are directed to the :c:func:`TIFFError` routine. + +See also +-------- + +:doc:`TIFFCheckTile` (3tiff), +:doc:`TIFFComputeTile` (3tiff), +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFReadTile` (3tiff), +:doc:`TIFFWriteScanline` (3tiff), +:doc:`TIFFWriteEncodedTile` (3tiff), +:doc:`TIFFWriteRawTile` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFbuffer.rst b/doc/functions/TIFFbuffer.rst new file mode 100644 index 00000000..1772bc0e --- /dev/null +++ b/doc/functions/TIFFbuffer.rst @@ -0,0 +1,57 @@ +TIFFbuffer +========== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + + +.. c:function:: int TIFFReadBufferSetup(TIFF* tif, tdata_t buffer, tsize_t size) +.. c:function:: int TIFFWriteBufferSetup(TIFF* tif, tdata_t buffer, tsize_t size) + +Description +----------- + +The following routines are provided for client-control of the I/O buffers used +by the library. Applications need never use these routines; they are provided +only for "intelligent clients" that wish to optimize memory usage and/or +eliminate potential copy operations that can occur when working with images +that have data stored without compression. + +:c:func:`TIFFReadBufferSetup` sets up the data buffer used to read raw (encoded) +data from a file. If the specified pointer is :c:macro:`NULL` (zero), then a +buffer of the appropriate size is allocated. Otherwise the caller must guarantee +that the buffer is large enough to hold any individual strip of raw data. +:c:func:`TIFFReadBufferSetup` returns a non-zero value if the setup was successful +and zero otherwise. + +:c:func:`TIFFWriteBufferSetup` sets up the data buffer used to write raw (encoded) +data to a file. If the specified *size* is -1, then the buffer size is selected to +hold a complete tile or strip, or at least 8 kilobytes, whichever is greater. If +the specified *buffer* is :c:macro:`NULL` (zero), then a buffer of the appropriate +size is dynamically allocated. +:c:func:`TIFFWriteBufferSetup` returns a non-zero value if the setup was successful +and zero otherwise. + +Diagnostics +----------- + +``%s: No space for data buffer at scanline %ld``: + + :c:func:`TIFFReadBufferSetup` was unable to dynamically allocate space for a + data buffer. + +``%s: No space for output buffer``: + + :c:func:`TIFFWriteBufferSetup` was unable to dynamically allocate space for a + data buffer. + +See also +-------- + +:doc:`/man/libtiff` (3tiff) diff --git a/doc/functions/TIFFcodec.rst b/doc/functions/TIFFcodec.rst new file mode 100644 index 00000000..b8784bc8 --- /dev/null +++ b/doc/functions/TIFFcodec.rst @@ -0,0 +1,56 @@ +TIFFcodec +========= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: const TIFFCodec* TIFFFindCODEC(uint16_t scheme) + +.. c:function:: TIFFCodec* TIFFRegisterCODEC(uint16_t scheme, const char *method, TIFFInitMethod init) + +.. c:function:: void TIFFUnRegisterCODEC(TIFFCodec * codec) + +.. c:function:: int TIFFIsCODECConfigured(uint16_t scheme) + +Description +----------- + +:program:`libtiff` supports a variety of compression schemes implemented +by software *codecs*. Each codec adheres to a modular interface that +provides for the decoding and encoding of image data; as well as some +other methods for initialization, setup, cleanup, and the control of +default strip and tile sizes. Codecs are identified by the associated +value of the TIFF ``Compression`` tag; e.g. 5 for LZW compression. + +The :c:func:`TIFFRegisterCODEC` routine can be used to augment or +override the set of codecs available to an application. If the +specified *scheme* already has a registered codec then it is +*overridden* and any images with data encoded with this compression +scheme will be decoded using the supplied codec. + +:c:func:`TIFFIsCODECConfigured` returns 1 if the codec is configured +and working. Otherwise 0 will be returned. + +Diagnostics +----------- + +``No space to register compression scheme %s``: + + :c:func:`TIFFRegisterCODEC` was unable to allocate memory for the + data structures needed to register a codec. + +``Cannot remove compression scheme %s; not registered``: + + :c:func:`TIFFUnRegisterCODEC` did not locate the specified codec in + the table of registered compression schemes. + +See also +-------- + +:doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFcolor.rst b/doc/functions/TIFFcolor.rst new file mode 100644 index 00000000..d0f43afb --- /dev/null +++ b/doc/functions/TIFFcolor.rst @@ -0,0 +1,211 @@ +TIFFcolor +========= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: int TIFFYCbCrToRGBInit(TIFFYCbCrToRGB *ycbcr, float *luma, float *refBlackWhite) + +.. c:function:: void TIFFYCbCrtoRGB(TIFFYCbCrToRGB *ycbcr, uint32_t Y, int32_t Cb, int32_t Cr, uint32_t *R, uint32_t *G, uint32_t *B) + +.. c:function:: int TIFFCIELabToRGBInit(TIFFCIELabToRGB *cielab, const TIFFDisplay *displayw, float *refWhite) + +.. c:function:: void TIFFCIELabToXYZ(TIFFCIELabToRGB *cielab, uint32_t L, int32_t a, int32_t b, float *X, float *Y, float *Z) + +.. c:function:: void TIFFXYZToRGB(TIFFCIELabToRGB *cielab, float X, float Y, float Z, uint32_t *R, uint32_t *G, uint32_t *B) + +Description +----------- + +TIFF supports several color spaces for images stored in that format. There is +usually a problem of application to handle the data properly and convert +between different colorspaces for displaying and printing purposes. To +simplify this task libtiff implements several color conversion routines +itself. In particular, these routines used in the :doc:`TIFFRGBAImage` +interface. + +:c:func:`TIFFYCbCrToRGBInit` used to initialize *YCbCr* to *RGB* +conversion state. Allocating and freeing of the *ycbcr* structure +belongs to programmer. :c:struct:`TIFFYCbCrToRGB` is defined in +:file:`tiffio.h` as: + +:: + + typedef struct { /* YCbCr->RGB support */ + TIFFRGBValue* clamptab; /* range clamping table */ + int* Cr_r_tab; + int* Cb_b_tab; + int32_t* Cr_g_tab; + int32_t* Cb_g_tab; + int32_t* Y_tab; + } TIFFYCbCrToRGB; + +*luma* is a float array of three values representing proportions of the +red, green and blue in luminance, Y (see section 21 of the TIFF 6.0 +specification, where YCbCr images are discussed). +:c:macro:`TIFFTAG_YCBCRCOEFFICIENTS` hold these values in TIFF file. +*refBlackWhite* is a float array of 6 values which specifies a pair of +headroom and footroom image data values (codes) for each image component +(see section 20 of the TIFF 6.0 specification where the colorimetry +fields are discussed). +:c:macro:`TIFFTAG_REFERENCEBLACKWHITE` is responsible for storing these +values in TIFF file. The following code snippet should help to +understand the the technique: + +:: + + float *luma, *refBlackWhite; + uint16_t hs, vs; + + /* Initialize structures */ + ycbcr = (TIFFYCbCrToRGB*) + _TIFFmalloc(TIFFroundup(sizeof(TIFFYCbCrToRGB), sizeof(long)) + + 4*256*sizeof(TIFFRGBValue) + + 2*256*sizeof(int) + + 3*256*sizeof(int32_t)); + if (ycbcr == NULL) { + TIFFError("YCbCr->RGB", + "No space for YCbCr->RGB conversion state"); + exit(0); + } + + TIFFGetFieldDefaulted(tif, TIFFTAG_YCBCRCOEFFICIENTS, &luma); + TIFFGetFieldDefaulted(tif, TIFFTAG_REFERENCEBLACKWHITE, &refBlackWhite); + if (TIFFYCbCrToRGBInit(ycbcr, luma, refBlackWhite) < 0) { + exit(0); + } + + /* Start conversion */ + uint32_t r, g, b; + uint32_t Y; + int32_t Cb, Cr; + + for each pixel in image { + TIFFYCbCrtoRGB(img->ycbcr, Y, Cb, Cr, &r, &g, &b); + } + + /* Free state structure */ + _TIFFfree(ycbcr); + +:c:func:`TIFFCIELabToRGBInit` initializes the *CIE L\*a\*b\* 1976* to +*RGB* conversion state. :c:struct:`TIFFCIELabToRGB` is defined as: + +:: + + #define CIELABTORGB_TABLE_RANGE 1500 + + typedef struct { /* CIE Lab 1976->RGB support */ + int range; /* Size of conversion table */ + float rstep, gstep, bstep; + float X0, Y0, Z0; /* Reference white point */ + TIFFDisplay display; + float Yr2r[CIELABTORGB_TABLE_RANGE + 1]; /* Conversion of Yr to r */ + float Yg2g[CIELABTORGB_TABLE_RANGE + 1]; /* Conversion of Yg to g */ + float Yb2b[CIELABTORGB_TABLE_RANGE + 1]; /* Conversion of Yb to b */ + } TIFFCIELabToRGB; + +*display* is a display device description, declared as: + +:: + + typedef struct { + float d_mat[3][3]; /* XYZ -> luminance matrix */ + float d_YCR; /* Light o/p for reference white */ + float d_YCG; + float d_YCB; + uint32_t d_Vrwr; /* Pixel values for ref. white */ + uint32_t d_Vrwg; + uint32_t d_Vrwb; + float d_Y0R; /* Residual light for black pixel */ + float d_Y0G; + float d_Y0B; + float d_gammaR; /* Gamma values for the three guns */ + float d_gammaG; + float d_gammaB; + } TIFFDisplay; + +For example, one can use sRGB device, which has the following parameters: + +:: + + TIFFDisplay display_sRGB = { + { /* XYZ -> luminance matrix */ + { 3.2410F, -1.5374F, -0.4986F }, + { -0.9692F, 1.8760F, 0.0416F }, + { 0.0556F, -0.2040F, 1.0570F } + }, + 100.0F, 100.0F, 100.0F, /* Light o/p for reference white */ + 255, 255, 255, /* Pixel values for ref. white */ + 1.0F, 1.0F, 1.0F, /* Residual light o/p for black pixel */ + 2.4F, 2.4F, 2.4F, /* Gamma values for the three guns */ + }; + +*refWhite* is a color temperature of the reference white. The +:c:macro:`TIFFTAG_WHITEPOINT` contains the chromaticity of the white +point of the image from where the reference white can be calculated +using following formulae: + +:: + + refWhite_Y = 100.0 + + refWhite_X = whitePoint_x / whitePoint_y * refWhite_Y + + refWhite_Z = (1.0 - whitePoint_x - whitePoint_y) / whitePoint_y * refWhite_X + +The conversion itself performed in two steps: at the first one we will convert +*CIE L\*a\*b\* 1976* to *CIE XYZ* using the :c:func:`TIFFCIELabToXYZ` routine, +and at the second step we will convert *CIE XYZ* to *RGB* using +:c:func:`TIFFXYZToRGB`. Look at the code sample below: + +:: + + float *whitePoint; + float refWhite[3]; + + /* Initialize structures */ + img->cielab = (TIFFCIELabToRGB *) + _TIFFmalloc(sizeof(TIFFCIELabToRGB)); + if (!cielab) { + TIFFError("CIE L*a*b*->RGB", + "No space for CIE L*a*b*->RGB conversion state."); + exit(0); + } + + TIFFGetFieldDefaulted(tif, TIFFTAG_WHITEPOINT, &whitePoint); + refWhite[1] = 100.0F; + refWhite[0] = whitePoint[0] / whitePoint[1] * refWhite[1]; + refWhite[2] = (1.0F - whitePoint[0] - whitePoint[1]) + / whitePoint[1] * refWhite[1]; + if (TIFFCIELabToRGBInit(cielab, &display_sRGB, refWhite) < 0) { + TIFFError("CIE L*a*b*->RGB", + "Failed to initialize CIE L*a*b*->RGB conversion state."); + _TIFFfree(cielab); + exit(0); + } + + /* Now we can start to convert */ + uint32_t r, g, b; + uint32_t L; + int32_t a, b; + float X, Y, Z; + + for each pixel in image { + TIFFCIELabToXYZ(cielab, L, a, b, &X, &Y, &Z); + TIFFXYZToRGB(cielab, X, Y, Z, &r, &g, &b); + } + + /* Don't forget to free the state structure */ + _TIFFfree(cielab); + +See also +-------- + +:doc:`TIFFRGBAImage` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFmemory.rst b/doc/functions/TIFFmemory.rst new file mode 100644 index 00000000..169a9681 --- /dev/null +++ b/doc/functions/TIFFmemory.rst @@ -0,0 +1,53 @@ +TIFFmemory +========== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: tdata_t _TIFFmalloc(tsize_t size) + +.. c:function:: tdata_t _TIFFrealloc(tdata_t buffer, tsize_t size) + +.. c:function:: void _TIFFfree(tdata_t " buffer ") + +.. c:function:: void _TIFFmemset(tdata_t s, int c, tsize_t n) + +.. c:function:: void _TIFFmemcpy(tdata_t dest, const tdata_t src, tsize_t n) + +.. c:function:: int _TIFFmemcmp(const tdata_t s1, const tdata_ts2, tsize_t n) + +Description +----------- + +These routines are provided for writing portable software that uses +:program:`libtiff`; they hide any memory-management related issues, such as +dealing with segmented architectures found on 16-bit machines. + +:c:func:`_TIFFmalloc` and :c:func:`_TIFFrealloc` are used to dynamically +allocate and reallocate memory used by :program:`libtiff`; such as memory +passed into the I/O routines. Memory allocated through these interfaces is +released back to the system using the :c:func:`_TIFFfree` routine. + +Memory allocated through one of the above interfaces can be set to a known +value using :c:func:`_TIFFmemset`, copied to another memory location using +:c:func:`_TIFFmemcpy`, or compared for equality using :c:func:`_TIFFmemcmp`. +These routines conform to the equivalent C routines: +:c:func:`memset`, :c:func:`memcpy`, :c:func:`memcmp`, respectively. + +Diagnostics +----------- + +None. + +See also +-------- + +malloc (3), +memory (3), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFquery.rst b/doc/functions/TIFFquery.rst new file mode 100644 index 00000000..bf146f76 --- /dev/null +++ b/doc/functions/TIFFquery.rst @@ -0,0 +1,95 @@ +TIFFquery +========= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: uint32_t TIFFCurrentRow(TIFF* tif) + +.. c:function:: tstrip_t TIFFCurrentStrip(TIFF* tif) + +.. c:function:: ttile_t TIFFCurrentTile(TIFF* tif) + +.. c:function:: tdir_t TIFFCurrentDirectory(TIFF* tif) + +.. c:function:: int TIFFLastDirectory(TIFF* tif) + +.. c:function:: int TIFFFileno(TIFF* tif) + +.. c:function:: char* TIFFFileName(TIFF* tif) + +.. c:function:: int TIFFGetMode(TIFF* tif) + +.. c:function:: int TIFFIsTiled(TIFF* tif) + +.. c:function:: int TIFFIsByteSwapped(TIFF* tif) + +.. c:function:: int TIFFIsUpSampled(TIFF* tif) + +.. c:function:: int TIFFIsMSB2LSB(TIFF* tif) + +.. c:function:: const char* TIFFGetVersion(void) + +Description +----------- + +The following routines return status information about an open TIFF file. + +:c:func:`TIFFCurrentDirectory` returns the index of the current directory +(directories are numbered starting at 0). This number is suitable for use +with the :c:func:`TIFFSetDirectory` routine. + +:c:func:`TIFFLastDirectory` returns a non-zero value if the current +directory is the last directory in the file; otherwise zero is returned. + +:c:func:`TIFFCurrentRow`, :c:func:`TIFFCurrentStrip`, and +:c:func:`TIFFCurrentTile` return the current row, strip, and tile, +respectively, that is being read or written. These values are updated each +time a read or write is done. + +:c:func:`TIFFFileno` returns the underlying file descriptor used to access the +TIFF image in the filesystem. + +:c:func:`TIFFFileName` returns the pathname argument passed to :c:func:`TIFFOpen` +or :c:func:`TIFFFdOpen`. + +:c:func:`TIFFGetMode` returns the mode with which the underlying file was opened. +On UNIX systems, this is the value passed to the :c:func:`open` (2) system call. + +:c:func:`TIFFIsTiled` returns a non-zero value if the image data has a tiled +organization. Zero is returned if the image data is organized in strips. + +:c:func:`TIFFIsByteSwapped` returns a non-zero value if the image data was in a +different byte-order than the host machine. Zero is returned if the TIFF file and +local host byte-orders are the same. Note that :c:func:`TIFFReadTile`, +:c:func:`TIFFReadEncodedStrip` and :c:func:`TIFFReadScanline` functions already +normally perform byte swapping to local host order if needed. + +:c:func:`TIFFIsUpSampled` returns a non-zero value if image data returned through +the read interface routines is being up-sampled. This can be useful to applications +that want to calculate I/O buffer sizes to reflect this usage (though the usual +strip and tile size routines already do this). + +:c:func:`TIFFIsMSB2LSB` returns a non-zero value if the image data is being returned +with bit 0 as the most significant bit. + +:c:func:`TIFFGetVersion` returns an ``ASCII`` string that has a version stamp for the +TIFF library software. + +Diagnostics +----------- + +None. + +See also +-------- + +:doc:`libtiff` (3tiff), +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFFdOpen` (3tiff) diff --git a/doc/functions/TIFFsize.rst b/doc/functions/TIFFsize.rst new file mode 100644 index 00000000..8455af42 --- /dev/null +++ b/doc/functions/TIFFsize.rst @@ -0,0 +1,39 @@ +TIFFsize +======== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: tsize_t TIFFRasterScanlineSize(TIFF* tif) + +.. c:function:: tsize_t TIFFScanlineSize(TIFF* tif) + +Description +----------- + +:c:func:`TIFFScanlineSize` returns the size in bytes of a row of data as +it would be returned in a call to :c:func:`TIFFReadScanline`, or as it +would be expected in a call to :c:func:`TIFFWriteScanline`. + +:c:func:`TIFFRasterScanlineSize` returns the size in bytes of a complete +decoded and packed raster scanline. Note that this value may be different +from the value returned by :c:func:`TIFFScanlineSize` if data is stored +as separate planes. + +Diagnostics +----------- + +None. + +See also +-------- + +:doc:`TIFFOpen` (3tiff), +:doc:`TIFFReadScanline` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFstrip.rst b/doc/functions/TIFFstrip.rst new file mode 100644 index 00000000..0d98ab59 --- /dev/null +++ b/doc/functions/TIFFstrip.rst @@ -0,0 +1,69 @@ +TIFFstrip +========= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: uint32_t TIFFDefaultStripSize(TIFF* tif, uint32_t estimate) + +.. c:function:: tmsize_t TIFFStripSize(TIFF* tif) + +.. c:function:: tmsize_t TIFFVStripSize(TIFF* tif, uint32_t nrows) + +.. c:function:: tmsize_t TIFFRawStripSize(TIFF* tif, uint32_t strip) + +.. c:function:: tstrip_t TIFFComputeStrip(TIFF* tif, uint32_t row, tsample_t sample) + +.. c:function:: tstrip_t TIFFNumberOfStrips(TIFF* tif) + +Description +----------- + +:c:func:`TIFFDefaultStripSize` returns the number of rows for a +reasonable-sized strip according to the current settings of the +``ImageWidth``, ``BitsPerSample`` and ``SamplesPerPixel``, +tags and any compression-specific requirements. If the *estimate* +parameter, sf non-zero, then it is taken as an estimate of the desired strip +size and adjusted according to any compression-specific requirements. The +value returned by this function is typically used to define the +``RowsPerStrip`` tag. In lieu of any unusual requirements +``TIFFDefaultStripSize`` tries to create strips that have approximately +8 kilobytes of uncompressed data. + +:c:func:`TIFFStripSize` returns the equivalent size for a strip of data +as it would be returned in a call to :c:func:`TIFFReadEncodedStrip` +or as it would be expected in a call to :c:func:`TIFFWriteEncodedStrip`. + +:c:func:`TIFFVStripSize` returns the number of bytes in a strip with +*nrows* rows of data. + +:c:func:`TIFFRawStripSize` returns the number of bytes in a raw strip +(i.e. not decoded). + +:c:func:`TIFFComputeStrip` returns the strip that contains the specified +coordinates. A valid strip is always returned; out-of-range coordinate +values are clamped to the bounds of the image. The *row* parameter is +always used in calculating a strip. The *sample* parameter is used only +if data are organized in separate planes (``PlanarConfiguration`` = 2). + +:c:func:`TIFFNumberOfStrips` returns the number of strips in the image. + +Diagnostics +----------- + +None. + +See also +-------- + +:doc:`TIFFReadEncodedStrip` (3tiff), +:doc:`TIFFReadRawStrip` (3tiff), +:doc:`TIFFWriteEncodedStrip` (3tiff), +:doc:`TIFFWriteRawStrip` (3tiff), +:doc:`libtiff` (3tiff), diff --git a/doc/functions/TIFFswab.rst b/doc/functions/TIFFswab.rst new file mode 100644 index 00000000..ffbd7e53 --- /dev/null +++ b/doc/functions/TIFFswab.rst @@ -0,0 +1,51 @@ +TIFFswab +======== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: const unsigned char* TIFFGetBitRevTable(int reversed) + +.. c:function:: void TIFFReverseBits(u_char* data, unsigned long nbytes) + +.. c:function:: void TIFFSwabShort(uint16_t* data) + +.. c:function:: void TIFFSwabLong(uint32_t* data) + +.. c:function:: void TIFFSwabArrayOfShort(uint16_t* data, unsigned long nshorts) + +.. c:function:: void TIFFSwabArrayOfLong(uint32_t* data, unsigned long nlongs) + +Description +----------- + +The following routines are used by the library to swap 16- and 32-bit +data and to reverse the order of bits in bytes. +:c:func:`TIFFSwabShort` and :c:func:`TIFFSwabLong` swap the bytes in a +single 16-bit and 32-bit item, respectively. +:c:func:`TIFFSwabArrayOfShort` and :c:func:`TIFFSwabArrayOfLong` +swap the bytes in an array of 16-bit and 32-bit items, respectively. + +:c:func:`TIFFReverseBits` replaces each byte in *data* with the +equivalent bit-reversed value. This operation is performed with a +lookup table, which is returned using the :c:func:`TIFFGetBitRevTable` +function. The *reversed* parameter specifies which table should be +returned. Supply *1* if you want bit reversal table. Supply *0* to get +the table that do not reverse bit values. It is a lookup table that can +be used as an "identity function"; i.e. :c:expr:`TIFFNoBitRevTable[n] == n`. + +Diagnostics +----------- + +None. + +See also +-------- + +:doc:`libtiff` (3tiff) diff --git a/doc/functions/TIFFtile.rst b/doc/functions/TIFFtile.rst new file mode 100644 index 00000000..0f759748 --- /dev/null +++ b/doc/functions/TIFFtile.rst @@ -0,0 +1,81 @@ +TIFFtile +======== + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. c:function:: void TIFFDefaultTileSize(TIFF* tif, uint32_t* tw, uint32_t* th) + +.. c:function:: tsize_t TIFFTileSize(TIFF* tif) + +.. c:function:: tsize_t TIFFTileRowSize(TIFF* tif) + +.. c:function:: tsize_t TIFFVTileSize(TIFF* tif, uint32_t nrows) + +.. c:function:: ttile_t TIFFComputeTile(TIFF* tif, uint32_t x, uint32_t y, uint32_t z, tsample_t sample) + +.. c:function:: int TIFFCheckTile(TIFF* tif, uint32_t x, uint32_t y, uint32_t z, tsample_t sample) + +.. c:function:: ttile_t TIFFNumberOfTiles(TIFF* tif) + +Description +----------- + +:c:func:`TIFFDefaultTileSize` returns the pixel width and height of a +reasonable-sized tile; suitable for setting up the ``TileWidth`` and +``TileLength`` tags. If the *tw* and *th* values passed in are +non-zero, then they are adjusted to reflect any compression-specific +requirements. The returned width and height are constrained to be a +multiple of 16 pixels to conform with the TIFF specification. + +:c:func:`TIFFTileSize` returns the equivalent size for a tile of data +as it would be returned in a call to :c:func:`TIFFReadTile` or as it +would be expected in a call to :c:func:`TIFFWriteTile`. + +:c:func:`TIFFVTileSize` returns the number of bytes in a row-aligned +tile with *nrows* of data. + +:c:func:`TIFFTileRowSize` returns the number of bytes of a row of data +in a tile. + +:c:func:`TIFFComputeTile` returns the tile that contains the specified +coordinates. A valid tile is always returned; out-of-range coordinate +values are clamped to the bounds of the image. The *x* and *y* +parameters are always used in calculating a tile. The *z* +parameter is used if the image is deeper than 1 slice +(``ImageDepth`` > 1). +The *sample* parameter is used only if data are organized in separate +planes (``PlanarConfiguration`` = 2). + +:c:func:`TIFFCheckTile` returns a non-zero value if the supplied +coordinates are within the bounds of the image and zero otherwise. The +*x* parameter is checked against the value of the ``ImageWidth`` tag. +The *y* parameter is checked against the value of the ``ImageLength`` +tag. The *z* parameter is checked against the value of the +``ImageDepth`` tag (if defined). The *sample* parameter is checked +against the value of the ``SamplesPerPixel`` parameter if the data are +organized in separate planes. + +:c:func:`TIFFNumberOfTiles` returns the number of tiles in the image. + +Diagnostics +----------- + +None. + +See also +-------- + +:doc:`TIFFReadEncodedTile` (3tiff), +:doc:`TIFFReadRawTile` (3tiff), +:doc:`TIFFReadTile` (3tiff), +:doc:`TIFFWriteEncodedTile` (3tiff), +:doc:`TIFFWriteRawTile` (3tiff), +:doc:`TIFFWriteTile` (3tiff), +:doc:`libtiff` (3tiff) diff --git a/doc/functions/libtiff.rst b/doc/functions/libtiff.rst new file mode 100644 index 00000000..e0da7efe --- /dev/null +++ b/doc/functions/libtiff.rst @@ -0,0 +1,916 @@ +libtiff +======= + +Synopsis +-------- + +.. highlight:: c + +:: + + #include <tiffio.h> + +.. highlight:: shell + +:: + + cc file.c -ltiff + +Description +----------- + +:program:`libtiff` is a library for reading and writing data files encoded with the +*"Tag Image File"* format, Revision 6.0 (or revision 5.0 or revision 4.0). This file format is +suitable for archiving multi-color and monochromatic image data. + +The library supports several compression algorithms, as indicated by the +``Compression`` field, including: +no compression (1), +CCITT 1D Huffman compression (2), +CCITT Group 3 Facsimile compression (3), +CCITT Group 4 Facsimile compression (4), +Lempel-Ziv & Welch compression (5), +baseline JPEG compression (7), +word-aligned 1D Huffman compression (32771), +PackBits compression (32773). +In addition, several nonstandard compression algorithms are supported: the +4-bit compression algorithm used by the +*ThunderScan* program (32809) (decompression only), +NeXT's 2-bit compression algorithm (32766) (decompression only), +an experimental LZ-style algorithm known as Deflate (32946), +and an experimental CIE LogLuv compression scheme designed +for images with high dynamic range (32845 for LogL and 32845 for LogLuv). +Directory information may be in either little- or big-endian byte order; byte +swapping is automatically done by the library. Data bit ordering may be either +Most Significant Bit (``MSB``) to Least Significant Bit (``LSB``) or +LSB to MSB. +Finally, the library does not support files in which the +``BitsPerSample`` , +``Compression`` , +``MinSampleValue`` , +or +``MaxSampleValue`` +fields are defined differently on a per-sample basis +(in Rev. 6.0 the +``Compression`` +tag is not defined on a per-sample basis, so this is immaterial). + +Data types +---------- + +The library makes extensive use of C typedefs to promote portability. +Two sets of typedefs are used, one for communication with clients +of the library and one for internal data structures and parsing of the +TIFF format. +The following typedefs are exposed to users either through function +definitions or through parameters passed through the varargs interfaces. + +.. highlight:: c + +:: + + typedef uint32_t ttag_t; // directory tag + typedef uint16_t tdir_t; // directory index + typedef uint16_t tsample_t; // sample number + typedef uint32_t tstrip_t; // strip number + typedef uint32_t ttile_t; // tile number + typedef int64_t tmsize_t; // signed size type (int32_t on 32-bit platforms) + typedef tmsize_t tsize_t; // i/o size in bytes + typedef void* tdata_t; // image data ref + typedef void* thandle_t; // client data handle + typedef uint64_t toff_t; // file offset + +Note that +:c:type:`tstrip_t`, +:c:type:`ttile_t`, +and +:c:type:`tsize_t` +are constrained to be no more than 32-bit quantities by 32-bit fields they are +stored in in the +TIFF +image. +Likewise +:c:type:`tsample_t` +is limited by the 16-bit field used to store the +``SamplesPerPixel`` +tag. +:c:type:`tdir_t` +constrains the maximum number of +IFDs +that may appear in an image and may be an arbitrary size (w/o penalty). +:c:type:`ttag_t` +must be either int, unsigned int, pointer, or double because the library uses +a varargs interface and +C restricts the type of the parameter before an ellipsis to be a promoted type. +:c:type:`toff_t` +is defined as :c:type:`uint64_t` because TIFF file offsets are (unsigned) 32-bit +quantities, and BigTIFF file offsets are unsigned 64-bit quantities. +A signed value is used because some interfaces return -1 on +error. Finally, note that user-specified data references are passed as opaque +handles and only cast at the lowest layers where their type is presumed. + +.. TODO: Check why this toff_t was switched to unsigned and update description. + + +List of routines +---------------- + +The following routines are part of the library. Consult specific manual pages +for details on their operation; on most systems doing :command:`man function-name` +will work. + +.. list-table:: libtiff functions + :widths: 5 20 + :header-rows: 1 + + * - Name + - Description + * - :c:func:`TIFFCheckpointDirectory` + - writes the current state of the directory + * - :c:func:`TIFFCheckTile` + - very x,y,z,sample is within image + * - :c:func:`TIFFCIELabToRGBInit` + - initialize CIE L*a*b* 1976 to RGB conversion state + * - :c:func:`TIFFCIELabToXYZ` + - perform CIE L*a*b* 1976 to CIE XYZ conversion + * - :c:func:`TIFFClientOpen` + - open a file for reading or writing + * - :c:func:`TIFFClose` + - close an open file + * - :c:func:`TIFFComputeStrip` + - return strip containing y,sample + * - :c:func:`TIFFComputeTile` + - return tile containing x,y,z,sample + * - :c:func:`TIFFCurrentDirectory` + - return index of current directory + * - :c:func:`TIFFCurrentRow` + - return index of current scanline + * - :c:func:`TIFFCurrentStrip` + - return index of current strip + * - :c:func:`TIFFCurrentTile` + - return index of current tile + * - :c:func:`TIFFDataWidth` + - return the size of TIFF data types + * - :c:func:`TIFFError` + - library error handler + * - :c:func:`TIFFFdOpen` + - open a file for reading or writing + * - :c:func:`TIFFFieldDataType` + - get data type from field information + * - :c:func:`TIFFFieldName` + - get field name from field information + * - :c:func:`TIFFFieldPassCount` + - get whether to pass a value count to Get/SetField + * - :c:func:`TIFFFieldReadCount` + - get number of values to be read from field + * - :c:func:`TIFFFieldTag` + - get tag value from field information + * - :c:func:`TIFFFieldWithName` + - get field information given field name + * - :c:func:`TIFFFieldWithTag` + - get field information given tag + * - :c:func:`TIFFFieldWriteCount` + - get number of values to be written to field + * - :c:func:`TIFFFileName` + - return name of open file + * - :c:func:`TIFFFileno` + - return open file descriptor + * - :c:func:`TIFFFindCODEC` + - find standard codec for the specific scheme + * - :c:func:`TIFFFindField` + - get field information given tag and data type + * - :c:func:`TIFFFlush` + - flush all pending writes + * - :c:func:`TIFFFlushData` + - flush pending data writes + * - :c:func:`TIFFGetBitRevTable` + - return bit reversal table + * - :c:func:`TIFFGetField` + - return tag value in current directory + * - :c:func:`TIFFGetFieldDefaulted` + - return tag value in current directory + * - :c:func:`TIFFGetMode` + - return open file mode + * - :c:func:`TIFFGetVersion` + - return library version string + * - :c:func:`TIFFIsCODECConfigured` + - check, whether we have working codec + * - :c:func:`TIFFIsMSB2LSB` + - return true if image data is being returned + * - :c:func:`` + - with bit 0 as the most significant bit + * - :c:func:`TIFFIsTiled` + - return true if image data is tiled + * - :c:func:`TIFFIsByteSwapped` + - return true if image data is byte-swapped + * - :c:func:`TIFFNumberOfStrips` + - return number of strips in an image + * - :c:func:`TIFFNumberOfTiles` + - return number of tiles in an image + * - :c:func:`TIFFOpen` + - open a file for reading or writing + * - :c:func:`TIFFPrintDirectory` + - print description of the current directory + * - :c:func:`TIFFReadBufferSetup` + - specify i/o buffer for reading + * - :c:func:`TIFFReadDirectory` + - read the next directory + * - :c:func:`TIFFReadEncodedStrip` + - read and decode a strip of data + * - :c:func:`TIFFReadEncodedTile` + - read and decode a tile of data + * - :c:func:`TIFFReadRawStrip` + - read a raw strip of data + * - :c:func:`TIFFReadRawTile` + - read a raw tile of data + * - :c:func:`TIFFReadRGBAImage` + - read an image into a fixed format raster + * - :c:func:`TIFFReadScanline` + - read and decode a row of data + * - :c:func:`TIFFReadTile` + - read and decode a tile of data + * - :c:func:`TIFFRegisterCODEC` + - override standard codec for the specific scheme + * - :c:func:`TIFFReverseBits` + - reverse bits in an array of bytes + * - :c:func:`TIFFRGBAImageBegin` + - setup decoder state for TIFFRGBAImageGet + * - :c:func:`TIFFRGBAImageEnd` + - release TIFFRGBAImage decoder state + * - :c:func:`TIFFRGBAImageGet` + - read and decode an image + * - :c:func:`TIFFRGBAImageOK` + - is image readable by TIFFRGBAImageGet + * - :c:func:`TIFFScanlineSize` + - return size of a scanline + * - :c:func:`TIFFSetDirectory` + - set the current directory + * - :c:func:`TIFFSetSubDirectory` + - set the current directory + * - :c:func:`TIFFSetErrorHandler` + - set error handler function + * - :c:func:`TIFFSetField` + - set a tag's value in the current directory + * - :c:func:`TIFFSetWarningHandler` + - set warning handler function + * - :c:func:`TIFFStripSize` + - returns size of a strip + * - :c:func:`TIFFRawStripSize` + - returns the number of bytes in a raw strip + * - :c:func:`TIFFSwabShort` + - swap bytes of short + * - :c:func:`TIFFSwabLong` + - swap bytes of long + * - :c:func:`TIFFSwabArrayOfShort` + - swap bytes of an array of shorts + * - :c:func:`TIFFSwabArrayOfLong` + - swap bytes of an array of longs + * - :c:func:`TIFFTileRowSize` + - return size of a row in a tile + * - :c:func:`TIFFTileSize` + - return size of a tile + * - :c:func:`TIFFUnRegisterCODEC` + - unregisters the codec + * - :c:func:`TIFFVGetField` + - return tag value in current directory + * - :c:func:`TIFFVGetFieldDefaulted` + - return tag value in current directory + * - :c:func:`TIFFVSetField` + - set a tag's value in the current directory + * - :c:func:`TIFFVStripSize` + - returns the number of bytes in a strip + * - :c:func:`TIFFWarning` + - library warning handler + * - :c:func:`TIFFWriteDirectory` + - write the current directory + * - :c:func:`TIFFWriteEncodedStrip` + - compress and write a strip of data + * - :c:func:`TIFFWriteEncodedTile` + - compress and write a tile of data + * - :c:func:`TIFFWriteRawStrip` + - write a raw strip of data + * - :c:func:`TIFFWriteRawTile` + - write a raw tile of data + * - :c:func:`TIFFWriteScanline` + - write a scanline of data + * - :c:func:`TIFFWriteTile` + - compress and write a tile of data + * - :c:func:`TIFFXYZToRGB` + - perform CIE XYZ to RGB conversion + * - :c:func:`TIFFYCbCrToRGBInit` + - initialize YCbCr to RGB conversion state + * - :c:func:`TIFFYCbCrtoRGB` + - perform YCbCr to RGB conversion + +.. list-table:: libtiff auxillary functions + :widths: 5 20 + :header-rows: 1 + + * - Name + - Description + * - :c:func:`_TIFFfree` + - free memory buffer + * - :c:func:`_TIFFmalloc` + - dynamically allocate memory buffer + * - :c:func:`_TIFFmemcmp` + - compare contents of the memory buffers + * - :c:func:`_TIFFmemcpy` + - copy contents of the one buffer to another + * - :c:func:`_TIFFmemset` + - fill memory buffer with a constant byte + * - :c:func:`_TIFFrealloc` + - dynamically reallocate memory buffer + +Tag usage +--------- + +The table below lists the TIFF +tags that are recognized and handled by the library. +If no use is indicated in the table, then the library +reads and writes the tag, but does not use it internally. +Note that some tags are meaningful only when a particular +compression scheme is being used; e.g. ``Group3Options`` +is only useful if ``Compression`` +is set to CCITT Group 3 encoding. +Tags of this sort are considered *codec-specific* +tags and the library does not recognize them except when the +``Compression`` +tag has been previously set to the relevant compression scheme. + +.. list-table:: libtiff supported tags + :widths: 10 2 2 15 + :header-rows: 1 + + * - Tag name + - Value + - R/W + - Library Use/Notes + * - ``Artist`` + - 315 + - R/W + - + * - ``BadFaxLines`` + - 326 + - R/W + - + * - ``BitsPerSample`` + - 258 + - R/W + - lots + * - ``CellLength`` + - 265 + - + - parsed but ignored + * - ``CellWidth`` + - 264 + - + - parsed but ignored + * - ``CleanFaxData`` + - 327 + - R/W + - + * - ``ColorMap`` + - 320 + - R/W + - + * - ``ColorResponseUnit`` + - 300 + - + - parsed but ignored + * - ``Compression`` + - 259 + - R/W + - choosing codec + * - ``ConsecutiveBadFaxLines`` + - 328 + - R/W + - + * - ``Copyright`` + - 33432 + - R/W + - + * - ``DataType`` + - 32996 + - R + - obsoleted by ``SampleFormat`` tag + * - ``DateTime`` + - 306 + - R/W + - + * - ``DocumentName`` + - 269 + - R/W + - + * - ``DotRange`` + - 336 + - R/W + - + * - ``ExtraSamples`` + - 338 + - R/W + - lots + * - ``FaxRecvParams`` + - 34908 + - R/W + - + * - ``FaxSubAddress`` + - 34909 + - R/W + - + * - ``FaxRecvTime`` + - 34910 + - R/W + - + * - ``FillOrder`` + - 266 + - R/W + - control bit order + * - ``FreeByteCounts`` + - 289 + - + - parsed but ignored + * - ``FreeOffsets`` + - 288 + - + - parsed but ignored + * - ``GrayResponseCurve`` + - 291 + - + - parsed but ignored + * - ``GrayResponseUnit`` + - 290 + - + - parsed but ignored + * - ``Group3Options`` + - 292 + - R/W + - used by Group 3 codec + * - ``Group4Options`` + - 293 + - R/W + - + * - ``HostComputer`` + - 316 + - R/W + - + * - ``ImageDepth`` + - 32997 + - R/W + - tile/strip calculations + * - ``ImageDescription`` + - 270 + - R/W + - + * - ``ImageLength`` + - 257 + - R/W + - lots + * - ``ImageWidth`` + - 256 + - R/W + - lots + * - ``InkNames`` + - 333 + - R/W + - + * - ``InkSet`` + - 332 + - R/W + - + * - ``JPEGTables`` + - 347 + - R/W + - used by JPEG codec + * - ``Make`` + - 271 + - R/W + - + * - ``Matteing`` + - 32995 + - R + - obsoleted by ExtraSamples tag + * - ``MaxSampleValue`` + - 281 + - R/W + - + * - ``MinSampleValue`` + - 280 + - R/W + - + * - ``Model`` + - 272 + - R/W + - + * - ``NewSubFileType`` + - 254 + - R/W + - called ``SubFileType`` in spec + * - ``NumberOfInks`` + - 334 + - R/W + - + * - ``Orientation`` + - 274 + - R/W + - + * - ``PageName`` + - 285 + - R/W + - + * - ``PageNumber`` + - 297 + - R/W + - + * - ``PhotometricInterpretation`` + - 262 + - R/W + - used by Group 3 and JPEG codecs + * - ``PlanarConfiguration`` + - 284 + - R/W + - data i/o + * - ``Predictor`` + - 317 + - R/W + - used by LZW and Deflate codecs + * - ``PrimaryChromacities`` + - 319 + - R/W + - + * - ``ReferenceBlackWhite`` + - 532 + - R/W + - + * - ``ResolutionUnit`` + - 296 + - R/W + - used by Group 3 codec + * - ``RowsPerStrip`` + - 278 + - R/W + - data i/o + * - ``SampleFormat`` + - 339 + - R/W + - + * - ``SamplesPerPixel`` + - 277 + - R/W + - lots + * - ``SMinSampleValue`` + - 340 + - R/W + - + * - ``SMaxSampleValue`` + - 341 + - R/W + - + * - ``Software`` + - 305 + - R/W + - + * - ``StoNits`` + - 37439 + - R/W + - + * - ``StripByteCounts`` + - 279 + - R/W + - data i/o + * - ``StripOffsets`` + - 273 + - R/W + - data i/o + * - ``SubFileType`` + - 255 + - R/W + - called ``OSubFileType`` in spec + * - ``TargetPrinter`` + - 337 + - R/W + - + * - ``Thresholding`` + - 263 + - R/W + - + * - ``TileByteCounts`` + - 324 + - R/W + - data i/o + * - ``TileDepth`` + - 32998 + - R/W + - tile/strip calculations + * - ``TileLength`` + - 323 + - R/W + - data i/o + * - ``TileOffsets`` + - 324 + - R/W + - data i/o + * - ``TileWidth`` + - 322 + - R/W + - data i/o + * - ``TransferFunction`` + - 301 + - R/W + - + * - ``WhitePoint`` + - 318 + - R/W + - + * - ``XPosition`` + - 286 + - R/W + - + * - ``XResolution`` + - 282 + - R/W + - + * - ``YCbCrCoefficients`` + - 529 + - R/W + - used by ``TIFFRGBAImage`` support + * - ``YCbCrPositioning`` + - 531 + - R/W + - tile/strip size calculations + * - ``YCbCrSubsampling`` + - 530 + - R/W + - + * - ``YPosition`` + - 286 + - R/W + - + * - ``YResolution`` + - 283 + - R/W + - used by Group 3 codec + +"Pseudo tags" +------------- + +In addition to the normal TIFF +tags the library supports a collection of +tags whose values lie in a range outside the valid range of TIFF +tags. These tags are termed *pseudo-tags* +and are used to control various codec-specific functions within the library. +The table below summarizes the defined pseudo-tags. + +.. list-table:: libtiff supported tags + :widths: 10 2 2 15 + :header-rows: 1 + + * - Tag name + - Codec + - R/W + - Library Use/Notes + + * - :c:macro:`TIFFTAG_FAXMODE` + - G3 + - R/W + - general codec operation + * - :c:macro:`TIFFTAG_FAXFILLFUNC` + - G3/G4 + - R/W + - bitmap fill function + * - :c:macro:`TIFFTAG_JPEGQUALITY` + - JPEG + - R/W + - compression quality control + * - :c:macro:`TIFFTAG_JPEGCOLORMODE` + - JPEG + - R/W + - control colorspace conversions + * - :c:macro:`TIFFTAG_JPEGTABLESMODE` + - JPEG + - R/W + - control contents of ``JPEGTables`` tag + * - :c:macro:`TIFFTAG_ZIPQUALITY` + - Deflate + - R/W + - compression quality level + * - :c:macro:`TIFFTAG_PIXARLOGDATAFMT` + - PixarLog + - R/W + - user data format + * - :c:macro:`TIFFTAG_PIXARLOGQUALITY` + - PixarLog + - R/W + - compression quality level + * - :c:macro:`TIFFTAG_SGILOGDATAFMT` + - SGILog + - R/W + - user data format + +:c:macro:`TIFFTAG_FAXMODE`: + + Control the operation of the Group 3 codec. + Possible values (independent bits that can be combined by + or'ing them together) are: + + :c:macro:`FAXMODE_CLASSIC`: + + (enable old-style format in which the ``RTC`` + is written at the end of the last strip), + + :c:macro:`FAXMODE_NORTC`: + + (opposite of :c:macro:`FAXMODE_CLASSIC`; also called + :c:macro:`FAXMODE_CLASSF`), + + :c:macro:`FAXMODE_NOEOL`: + + (do not write ``EOL`` codes at the start of each row of data), + + :c:macro:`FAXMODE_BYTEALIGN`: + + (align each encoded row to an 8-bit boundary), + + :c:macro:`FAXMODE_WORDALIGN`: + + (align each encoded row to an 16-bit boundary), + + The default value is dependent on the compression scheme; this + pseudo-tag is used by the various G3 and G4 codecs to share code. + +:c:macro:`TIFFTAG_FAXFILLFUNC`: + + Control the function used to convert arrays of black and white + runs to packed bit arrays. + This hook can be used to image decoded scanlines in multi-bit + depth rasters (e.g. for display in colormap mode) + or for other purposes. + The default value is a pointer to a builtin function that images + packed bilevel data. + +:c:macro:`TIFFTAG_IPTCNEWSPHOTO`: + + Tag contains image metadata per the IPTC newsphoto spec: Headline, + captioning, credit, etc... Used by most wire services. + +:c:macro:`TIFFTAG_PHOTOSHOP`: + + Tag contains Photoshop captioning information and metadata. Photoshop + uses in parallel and redundantly alongside :c:macro:`IPTCNEWSPHOTO` information. + +:c:macro:`TIFFTAG_JPEGQUALITY`: + + Control the compression quality level used in the baseline algorithm. + Note that quality levels are in the range 0-100 with a default value of 75. + +:c:macro:`TIFFTAG_JPEGCOLORMODE`: + + Control whether or not conversion is done between + RGB and YCbCr colorspaces. + Possible values are: + + :c:macro:`JPEGCOLORMODE_RAW`: + + (do not convert), and + + :c:macro:`JPEGCOLORMODE_RGB`: + + (convert to/from RGB) + + The default value is :c:macro:`JPEGCOLORMODE_RAW`. + +:c:macro:`TIFFTAG_JPEGTABLESMODE`: + + Control the information written in the ``JPEGTables`` tag. + Possible values (independent bits that can be combined by + or'ing them together) are: + + :c:macro:`JPEGTABLESMODE_QUANT`: + + (include quantization tables), and + + :c:macro:`JPEGTABLESMODE_HUFF`: + + (include Huffman encoding tables). + + The default value is :c:expr:`JPEGTABLESMODE_QUANT|JPEGTABLESMODE_HUFF`. + +:c:macro:`TIFFTAG_ZIPQUALITY`: + + Control the compression technique used by the Deflate codec. + Quality levels are in the range 1-9 with larger numbers yielding better + compression at the cost of more computation. + The default quality level is 6 which yields a good time-space tradeoff. + +:c:macro:`TIFFTAG_PIXARLOGDATAFMT`: + + Control the format of user data passed *in* + to the PixarLog codec when encoding and passed + *out* from when decoding. Possible values are: + + :c:macro:`PIXARLOGDATAFMT_8BIT`: + + for 8-bit unsigned pixels, + + :c:macro:`PIXARLOGDATAFMT_8BITABGR`: + + for 8-bit unsigned ABGR-ordered pixels, + + :c:macro:`PIXARLOGDATAFMT_11BITLOG`: + + for 11-bit log-encoded raw data, + + :c:macro:`PIXARLOGDATAFMT_12BITPICIO`: + + for 12-bit PICIO-compatible data, + + :c:macro:`PIXARLOGDATAFMT_16BIT`: + + for 16-bit signed samples, and + + :c:macro:`PIXARLOGDATAFMT_FLOAT`: + + for 32-bit IEEE floating point samples. + +:c:macro:`TIFFTAG_PIXARLOGQUALITY`: + + Control the compression technique used by the PixarLog codec. + This value is treated identically to :c:macro:`TIFFTAG_ZIPQUALITY`; see the + above description. + +:c:macro:`TIFFTAG_SGILOGDATAFMT`: + + Control the format of client data passed *in* + to the SGILog codec when encoding and passed + *out* from when decoding. Possible values are: + + :c:macro:`SGILOGDATAFMT_FLTXYZ`: + + for converting between LogLuv and 32-bit IEEE floating valued XYZ pixels, + + :c:macro:`SGILOGDATAFMT_16BITLUV`: + + for 16-bit encoded Luv pixels, + + :c:macro:`SGILOGDATAFMT_32BITRAW`: + :c:macro:`SGILOGDATAFMT_24BITRAW`: + + for no conversion of data, + + :c:macro:`SGILOGDATAFMT_8BITRGB`: + + for returning 8-bit RGB data (valid only when decoding LogLuv-encoded data), + + :c:macro:`SGILOGDATAFMT_FLTY`: + + for converting between LogL and 32-bit IEEE floating valued Y pixels, + + :c:macro:`SGILOGDATAFMT_16BITL`: + + for 16-bit encoded L pixels, and + + :c:macro:`SGILOGDATAFMT_8BITGRY`: + + for returning 8-bit greyscale data + (valid only when decoding LogL-encoded data). + +Diagnostics +----------- + +All error messages are directed through the :c:func:`TIFFError` routine. +By default messages are directed to ``stderr`` in the form: +``module: message\n``. +Warning messages are likewise directed through the +:c:func:`TIFFWarning` routine. + +See also +-------- + +:doc:`/tools/fax2tiff`, +:doc:`/tools/pal2rgb`, +:doc:`/tools/ppm2tiff`, +:doc:`/tools/rgb2ycbcr`, +:doc:`/tools/raw2tiff`, +:doc:`/tools/tiff2bw`, +:doc:`/tools/tiffdither`, +:doc:`/tools/tiffdump`, +:doc:`/tools/tiffcp`, +:doc:`/tools/tiffcmp`, +:doc:`/tools/tiffgt`, +:doc:`/tools/tiffinfo`, +:doc:`/tools/tiffmedian`, +:doc:`/tools/tiffsplit`, + +**"Tag Image File Format Specification *Revision 6.0*"**, +an Aldus Technical Memorandum. + +**"The Spirit of TIFF Class F"** , +an appendix to the TIFF 5.0 specification prepared by Cygnet Technologies. + +Bugs +---- + +* The library does not support multi-sample images + where some samples have different bits/sample. + +* The library does not support random access to compressed data + that is organized with more than one row per tile or strip. diff --git a/doc/index.rst b/doc/index.rst index b278f59a..ff844959 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -46,10 +46,10 @@ The following sections are included in this documentation: build terms libtiff + functions internals addingtags tools contrib - manpages project/index releases/index diff --git a/doc/internals.rst b/doc/internals.rst index ec6ef9ab..21b60417 100644 --- a/doc/internals.rst +++ b/doc/internals.rst @@ -384,7 +384,7 @@ or do the following to add support directly to the core library: * Create a file with the compression scheme code, by convention files are named :file:`tif_*.c` (except perhaps on some systems where the ``tif_`` prefix pushes some filenames over 14 chars. -* Update build configuration to include new source file +* Update build configuration to include new source file. A codec, say ``foo``, can have many different entry points: @@ -407,7 +407,7 @@ A codec, say ``foo``, can have many different entry points: fooEncodeTile(...) /* called to decode an entire tile */ fooPostEncode(tif) /* called once per strip/tile, just before data is written */ fooSeek(tif, row) /* seek forwards row scanlines from the beginning - of a strip (row will always be >0 and <rows/strip */ + of a strip (row will always be <0 and >rows/strip */ fooCleanup(tif) /* called when compression scheme is replaced by user */ Note that the encoding and decoding variants are only needed when diff --git a/doc/libtiff.rst b/doc/libtiff.rst index 2e126ba4..73aba89e 100644 --- a/doc/libtiff.rst +++ b/doc/libtiff.rst @@ -330,8 +330,8 @@ then the routine :c:func:`TIFFReadRGBAImage` can be used: size_t npixels; uint32_t* raster; - TIFFGetField(tif, TIFFTAG_IMAGEWIDTH, &w); - TIFFGetField(tif, TIFFTAG_IMAGELENGTH, &h); + TIFFGetField(tif, TIFFTAG_IMAGEWIDTH, &w); + TIFFGetField(tif, TIFFTAG_IMAGELENGTH, &h); npixels = w * h; raster = (uint32_t*) _TIFFmalloc(npixels * sizeof (uint32_t)); if (raster != NULL) { @@ -365,19 +365,19 @@ is: TIFFRGBAImage img; char emsg[1024]; - if (TIFFRGBAImageBegin(&img, tif, 0, emsg)) { + if (TIFFRGBAImageBegin(&img, tif, 0, emsg)) { size_t npixels; uint32_t* raster; npixels = img.width * img.height; raster = (uint32_t*) _TIFFmalloc(npixels * sizeof (uint32_t)); if (raster != NULL) { - if (TIFFRGBAImageGet(&img, raster, img.width, img.height)) { + if (TIFFRGBAImageGet(&img, raster, img.width, img.height)) { ...process raster data... } _TIFFfree(raster); } - TIFFRGBAImageEnd(&img); + TIFFRGBAImageEnd(&img); } else TIFFError(argv[1], emsg); TIFFClose(tif); @@ -459,9 +459,9 @@ is assumed to be organized in strips, the following might be used: tdata_t buf; uint32_t row; - TIFFGetField(tif, TIFFTAG_IMAGELENGTH, &imagelength); + TIFFGetField(tif, TIFFTAG_IMAGELENGTH, &imagelength); buf = _TIFFmalloc(TIFFScanlineSize(tif)); - for (row = 0; row < imagelength; row++) + for (row = 0; row < imagelength; row++) TIFFReadScanline(tif, buf, row, 0); _TIFFfree(buf); TIFFClose(tif); @@ -486,18 +486,18 @@ to handle either case one might use the following instead: tdata_t buf; uint32_t row; - TIFFGetField(tif, TIFFTAG_IMAGELENGTH, &imagelength); - TIFFGetField(tif, TIFFTAG_PLANARCONFIG, &config); + TIFFGetField(tif, TIFFTAG_IMAGELENGTH, &imagelength); + TIFFGetField(tif, TIFFTAG_PLANARCONFIG, &config); buf = _TIFFmalloc(TIFFScanlineSize(tif)); if (config == PLANARCONFIG_CONTIG) { - for (row = 0; row < imagelength; row++) + for (row = 0; row < imagelength; row++) TIFFReadScanline(tif, buf, row, 0); } else if (config == planarconfig_separate) { uint16_t s, nsamples; - tiffgetfield(tif, tifftag_samplesperpixel, &nsamples); - for (s = 0; s < nsamples; s++) - for (row = 0; row < imagelength; row++) + tiffgetfield(tif, tifftag_samplesperpixel, &nsamples); + for (s = 0; s < nsamples; s++) + for (row = 0; row < imagelength; row++) TIFFReadScanline(tif, buf, row, s); } _TIFFfree(buf); @@ -510,8 +510,8 @@ read data in the case ``PLANARCONFIG_SEPARATE``,... :: - for (row = 0; row < imagelength; row++) - for (s = 0; s < nsamples; s++) + for (row = 0; row < imagelength; row++) + for (s = 0; s < nsamples; s++) TIFFReadScanline(tif, buf, row, s); ...then problems would arise if ``RowsPerStrip`` was not one @@ -542,7 +542,7 @@ A simple example of reading an image by strips is: tstrip_t strip; buf = _TIFFmalloc(TIFFStripSize(tif)); - for (strip = 0; strip < tiffnumberofstrips(tif); strip++) + for (strip = 0; strip < tiffnumberofstrips(tif); strip++) tiffreadencodedstrip(tif, strip, buf, (tsize_t) -1); _TIFFfree(buf); TIFFClose(tif); @@ -578,11 +578,11 @@ a file: uint32_t* bc; uint32_t stripsize; - TIFFGetField(tif, TIFFTAG_STRIPBYTECOUNTS, &bc); + TIFFGetField(tif, TIFFTAG_STRIPBYTECOUNTS, &bc); stripsize = bc[0]; buf = _TIFFmalloc(stripsize); - for (strip = 0; strip < tiffnumberofstrips(tif); strip++) { - if (bc[strip] > stripsize) { + for (strip = 0; strip < tiffnumberofstrips(tif); strip++) { + if (bc[strip] > stripsize) { buf = _TIFFrealloc(buf, bc[strip]); stripsize = bc[strip]; } @@ -632,13 +632,13 @@ code of the following sort might be used: uint32_t x, y; tdata_t buf; - TIFFGetField(tif, TIFFTAG_IMAGEWIDTH, &imageWidth); - TIFFGetField(tif, TIFFTAG_IMAGELENGTH, &imageLength); - TIFFGetField(tif, TIFFTAG_TILEWIDTH, &tileWidth); - TIFFGetField(tif, TIFFTAG_TILELENGTH, &tileLength); + TIFFGetField(tif, TIFFTAG_IMAGEWIDTH, &imageWidth); + TIFFGetField(tif, TIFFTAG_IMAGELENGTH, &imageLength); + TIFFGetField(tif, TIFFTAG_TILEWIDTH, &tileWidth); + TIFFGetField(tif, TIFFTAG_TILELENGTH, &tileLength); buf = _TIFFmalloc(TIFFTileSize(tif)); - for (y = 0; y < imagelength; y += tilelength) - for (x = 0; x < imagewidth; x += tilewidth) + for (y = 0; y < imagelength; y += tilelength) + for (x = 0; x < imagewidth; x += tilewidth) tiffreadtile(tif, buf, x, y, 0); _TIFFfree(buf); TIFFClose(tif); @@ -664,7 +664,7 @@ and written with :c:func:`TIFFWriteEncodedTile` or ttile_t tile; buf = _TIFFmalloc(TIFFTileSize(tif)); - for (tile = 0; tile < tiffnumberoftiles(tif); tile++) + for (tile = 0; tile < tiffnumberoftiles(tif); tile++) tiffreadencodedtile(tif, tile, buf, (tsize_t) -1); _TIFFfree(buf); TIFFClose(tif); diff --git a/doc/manpages.rst b/doc/manpages.rst deleted file mode 100644 index dc0ea239..00000000 --- a/doc/manpages.rst +++ /dev/null @@ -1,67 +0,0 @@ -Manual pages -============ - - -* `libtiff.3tiff <man/libtiff.3tiff.html>`_ -* `TIFFbuffer.3tiff <man/TIFFbuffer.3tiff.html>`_ -* `TIFFClose.3tiff <man/TIFFClose.3tiff.html>`_ -* `TIFFcodec.3tiff <man/TIFFcodec.3tiff.html>`_ -* `TIFFcolor.3tiff <man/TIFFcolor.3tiff.html>`_ -* `TIFFDataWidth.3tiff <man/TIFFDataWidth.3tiff.html>`_ -* `TIFFError.3tiff <man/TIFFError.3tiff.html>`_ -* `TIFFFieldDataType.3tiff <man/TIFFFieldDataType.3tiff.html>`_ -* `TIFFFieldName.3tiff <man/TIFFFieldName.3tiff.html>`_ -* `TIFFFieldPassCount.3tiff <man/TIFFFieldPassCount.3tiff.html>`_ -* `TIFFFieldReadCount.3tiff <man/TIFFFieldReadCount.3tiff.html>`_ -* `TIFFFieldTag.3tiff <man/TIFFFieldTag.3tiff.html>`_ -* `TIFFFieldWriteCount.3tiff <man/TIFFFieldWriteCount.3tiff.html>`_ -* `TIFFFlush.3tiff <man/TIFFFlush.3tiff.html>`_ -* `TIFFGetField.3tiff <man/TIFFGetField.3tiff.html>`_ -* `TIFFmemory.3tiff <man/TIFFmemory.3tiff.html>`_ -* `TIFFOpen.3tiff <man/TIFFOpen.3tiff.html>`_ -* `TIFFPrintDirectory.3tiff <man/TIFFPrintDirectory.3tiff.html>`_ -* `TIFFquery.3tiff <man/TIFFquery.3tiff.html>`_ -* `TIFFReadDirectory.3tiff <man/TIFFReadDirectory.3tiff.html>`_ -* `TIFFReadEncodedStrip.3tiff <man/TIFFReadEncodedStrip.3tiff.html>`_ -* `TIFFReadEncodedTile.3tiff <man/TIFFReadEncodedTile.3tiff.html>`_ -* `TIFFReadRawStrip.3tiff <man/TIFFReadRawStrip.3tiff.html>`_ -* `TIFFReadRawTile.3tiff <man/TIFFReadRawTile.3tiff.html>`_ -* `TIFFReadRGBAImage.3tiff <man/TIFFReadRGBAImage.3tiff.html>`_ -* `TIFFReadRGBAStrip.3tiff <man/TIFFReadRGBAStrip.3tiff.html>`_ -* `TIFFReadRGBATile.3tiff <man/TIFFReadRGBATile.3tiff.html>`_ -* `TIFFReadScanline.3tiff <man/TIFFReadScanline.3tiff.html>`_ -* `TIFFReadTile.3tiff <man/TIFFReadTile.3tiff.html>`_ -* `TIFFRGBAImage.3tiff <man/TIFFRGBAImage.3tiff.html>`_ -* `TIFFSetDirectory.3tiff <man/TIFFSetDirectory.3tiff.html>`_ -* `TIFFSetField.3tiff <man/TIFFSetField.3tiff.html>`_ -* `TIFFsize.3tiff <man/TIFFsize.3tiff.html>`_ -* `TIFFstrip.3tiff <man/TIFFstrip.3tiff.html>`_ -* `TIFFswab.3tiff <man/TIFFswab.3tiff.html>`_ -* `TIFFtile.3tiff <man/TIFFtile.3tiff.html>`_ -* `TIFFWarning.3tiff <man/TIFFWarning.3tiff.html>`_ -* `TIFFWriteDirectory.3tiff <man/TIFFWriteDirectory.3tiff.html>`_ -* `TIFFWriteEncodedStrip.3tiff <man/TIFFWriteEncodedStrip.3tiff.html>`_ -* `TIFFWriteEncodedTile.3tiff <man/TIFFWriteEncodedTile.3tiff.html>`_ -* `TIFFWriteRawStrip.3tiff <man/TIFFWriteRawStrip.3tiff.html>`_ -* `TIFFWriteRawTile.3tiff <man/TIFFWriteRawTile.3tiff.html>`_ -* `TIFFWriteScanline.3tiff <man/TIFFWriteScanline.3tiff.html>`_ -* `TIFFWriteTile.3tiff <man/TIFFWriteTile.3tiff.html>`_ -* `fax2ps.1 <man/fax2ps.1.html>`_ -* `fax2tiff.1 <man/fax2tiff.1.html>`_ -* `pal2rgb.1 <man/pal2rgb.1.html>`_ -* `ppm2tiff.1 <man/ppm2tiff.1.html>`_ -* `raw2tiff.1 <man/raw2tiff.1.html>`_ -* `tiff2bw.1 <man/tiff2bw.1.html>`_ -* `tiff2pdf.1 <man/tiff2pdf.1.html>`_ -* `tiff2ps.1 <man/tiff2ps.1.html>`_ -* `tiff2rgba.1 <man/tiff2rgba.1.html>`_ -* `tiffcmp.1 <man/tiffcmp.1.html>`_ -* `tiffcp.1 <man/tiffcp.1.html>`_ -* `tiffcrop.1 <man/tiffcrop.1.html>`_ -* `tiffdither.1 <man/tiffdither.1.html>`_ -* `tiffdump.1 <man/tiffdump.1.html>`_ -* `tiffgt.1 <man/tiffgt.1.html>`_ -* `tiffinfo.1 <man/tiffinfo.1.html>`_ -* `tiffmedian.1 <man/tiffmedian.1.html>`_ -* `tiffset.1 <man/tiffset.1.html>`_ -* `tiffsplit.1 <man/tiffsplit.1.html>`_ diff --git a/doc/static/man/TIFFClose.3tiff.html b/doc/static/man/TIFFClose.3tiff.html deleted file mode 100644 index 5dd9a129..00000000 --- a/doc/static/man/TIFFClose.3tiff.html +++ /dev/null @@ -1,87 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:25 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFClose</title> - -</head> -<body> - -<h1 align="center">TIFFClose</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFClose -− close a previously opened <small>TIFF</small> -file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>void -TIFFClose(TIFF *</b><i>tif</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFClose</i></b> -closes a file that was previously opened with -<b>TIFFOpen</b>(3TIFF). Any buffered data are flushed to the -file, including the contents of the current directory (if -modified); and all resources are reclaimed.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine. Likewise, warning messages are directed to the -<b>TIFFWarning</b>(3TIFF) routine.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF), -<b>TIFFOpen</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFDataWidth.3tiff.html b/doc/static/man/TIFFDataWidth.3tiff.html deleted file mode 100644 index 09216bc0..00000000 --- a/doc/static/man/TIFFDataWidth.3tiff.html +++ /dev/null @@ -1,96 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:25 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFDataWidth</title> - -</head> -<body> - -<h1 align="center">TIFFDataWidth</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFDataWidth -− Get the size of TIFF data types</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFDataWidth(TIFFDataType</b> <i>type</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFDataWidth</i></b> -returns a size of <i>type</i> in bytes. Currently following -data types are supported: <i><br> -TIFF_BYTE <br> -TIFF_ASCII <br> -TIFF_SBYTE <br> -TIFF_UNDEFINED <br> -TIFF_SHORT <br> -TIFF_SSHORT <br> -TIFF_LONG <br> -TIFF_SLONG <br> -TIFF_FLOAT <br> -TIFF_IFD <br> -TIFF_RATIONAL <br> -TIFF_SRATIONAL <br> -TIFF_DOUBLE</i></p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFDataWidth</i> -returns a number of bytes occupied by the item of given -type. 0 returned when unknown data type supplied.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF),</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFError.3tiff.html b/doc/static/man/TIFFError.3tiff.html deleted file mode 100644 index a2becb75..00000000 --- a/doc/static/man/TIFFError.3tiff.html +++ /dev/null @@ -1,107 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFError</title> - -</head> -<body> - -<h1 align="center">TIFFError</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFError, -TIFFSetErrorHandler − library error handling -interface</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>void -TIFFError(const char *</b><i>module</i><b>, const char -*</b><i>fmt</i><b>,</b> <i>...</i><b>)</b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<stdarg.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>typedef void -(*TIFFErrorHandler)(const char *</b><i>module</i><b>, const -char *</b><i>fmt</i><b>, va_list</b> <i>ap</i><b>); <br> -TIFFErrorHandler TIFFSetErrorHandler(TIFFErrorHandler -handler);</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFError</i></b> -invokes the library-wide error handling function to -(normally) write an error message to the <b>stderr</b>. The -<i>fmt</i> parameter is a <i>printf</i>(3S) format string, -and any number arguments can be supplied. The <i>module</i> -parameter, if non-zero, is printed before the message; it -typically is used to identify the software module in which -an error is detected.</p> - -<p style="margin-left:11%; margin-top: 1em">Applications -that desire to capture control in the event of an error -should use <i>TIFFSetErrorHandler</i> to override the -default error handler. A <small>NULL</small> (0) error -handling function may be installed to suppress error -messages.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFSetErrorHandler</i> -returns a reference to the previous error handling -function.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFWarning</b>(3TIFF), -<b>libtiff</b>(3TIFF), <b>printf</b>(3)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFFieldDataType.3tiff.html b/doc/static/man/TIFFFieldDataType.3tiff.html deleted file mode 100644 index 8c1d21d4..00000000 --- a/doc/static/man/TIFFFieldDataType.3tiff.html +++ /dev/null @@ -1,89 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFFieldDataType</title> - -</head> -<body> - -<h1 align="center">TIFFFieldDataType</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFFieldDataType -− Get TIFF data type from field information</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFDataType -TIFFFieldDataType(const TIFFField*</b> -<i>fip</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldDataType</b> -returns the data type stored in a TIFF field.</p> - -<p style="margin-left:11%; margin-top: 1em"><i>fip</i> is a -field information pointer previously returned by -<b>TIFFFindField</b>, <b>TIFFFieldWithTag</b>, or -<b>TIFFFieldWithName</b>.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldDataType</b> -returns a member of the enum type <b>TIFFDataType</b>.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF),</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFFieldName.3tiff.html b/doc/static/man/TIFFFieldName.3tiff.html deleted file mode 100644 index ad7f791d..00000000 --- a/doc/static/man/TIFFFieldName.3tiff.html +++ /dev/null @@ -1,86 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFFieldName</title> - -</head> -<body> - -<h1 align="center">TIFFFieldName</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFFieldName -− Get TIFF field name from field information</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>const char* -TIFFFieldName(const TIFFField*</b> <i>fip</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldName</b> -returns the textual name for a TIFF field.</p> - -<p style="margin-left:11%; margin-top: 1em"><i>fip</i> is a -field information pointer previously returned by -<b>TIFFFindField</b>, <b>TIFFFieldWithTag</b>, or -<b>TIFFFieldWithName</b>.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldName</b> -returns a constant C string.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF),</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFFieldPassCount.3tiff.html b/doc/static/man/TIFFFieldPassCount.3tiff.html deleted file mode 100644 index 97a10a10..00000000 --- a/doc/static/man/TIFFFieldPassCount.3tiff.html +++ /dev/null @@ -1,98 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFFieldPassCount</title> - -</head> -<body> - -<h1 align="center">TIFFFieldPassCount</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFFieldPassCount -− Get whether to pass a count to TIFFGet/SetField</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFFieldPassCount(const TIFFField*</b> -<i>fip</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldPassCount</b> -returns true (nonzero) if <b>TIFFGetField</b> and -<b>TIFFSetField</b> expect a <i>count</i> value to be passed -before the actual data pointer.</p> - -<p style="margin-left:11%; margin-top: 1em"><i>fip</i> is a -field information pointer previously returned by -<b>TIFFFindField</b>, <b>TIFFFieldWithTag</b>, or -<b>TIFFFieldWithName</b>.</p> - -<p style="margin-left:11%; margin-top: 1em">When a -<i>count</i> is required, it will be of type <b>uint32_t</b> -when <b>TIFFFieldReadCount</b> reports -<b>TIFF_VARIABLE2</b>, and of type <b>uint16_t</b> -otherwise. (This distinction is critical for use of -<b>TIFFGetField</b>, but normally not so for use of -<b>TIFFSetField</b>.)</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldPassCount</b> -returns an integer that is always 1 (true) or 0 (false).</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF),</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFFieldReadCount.3tiff.html b/doc/static/man/TIFFFieldReadCount.3tiff.html deleted file mode 100644 index 168511a4..00000000 --- a/doc/static/man/TIFFFieldReadCount.3tiff.html +++ /dev/null @@ -1,101 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFFieldReadCount</title> - -</head> -<body> - -<h1 align="center">TIFFFieldReadCount</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFFieldReadCount -− Get number of values to be read from field</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFFieldReadCount(const TIFFField*</b> -<i>fip</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldReadCount</b> -returns the number of values available to be read from the -specified TIFF field; that is, the number of arguments that -should be supplied to <b>TIFFGetField</b>. For most field -types this is a small positive integer, typically 1 or 2, -but there are some special values: <b><br> -TIFF_VARIABLE</b> indicates that a variable number of values -is possible; then, a <b>uint16_t</b> <i>count</i> argument -and a pointer <i>data</i> argument must be supplied to -<b>TIFFGetField</b>. <b><br> -TIFF_VARIABLE2</b> is the same as <b>TIFF_VARIABLE</b> -except that the <i>count</i> argument must have type -<b>uint32_t</b>. <b><br> -TIFF_SPP</b> indicates that the number of arguments is equal -to the image’s number of samples per pixel.</p> - -<p style="margin-left:11%; margin-top: 1em"><i>fip</i> is a -field information pointer previously returned by -<b>TIFFFindField</b>, <b>TIFFFieldWithTag</b>, or -<b>TIFFFieldWithName</b>.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldReadCount</b> -returns an integer.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF),</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFFieldTag.3tiff.html b/doc/static/man/TIFFFieldTag.3tiff.html deleted file mode 100644 index 2b0e8be2..00000000 --- a/doc/static/man/TIFFFieldTag.3tiff.html +++ /dev/null @@ -1,88 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFFieldTag</title> - -</head> -<body> - -<h1 align="center">TIFFFieldTag</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFFieldTag -− Get TIFF field tag value from field information</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>uint32_t -TIFFFieldTag(const TIFFField*</b> <i>fip</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldTag</b> -returns the numeric tag value for a TIFF field. This can be -compared to various constants exported by the <b>libtiff</b> -header files, such as <b>TIFFTAG_IMAGEWIDTH</b>.</p> - -<p style="margin-left:11%; margin-top: 1em"><i>fip</i> is a -field information pointer previously returned by -<b>TIFFFindField</b>, <b>TIFFFieldWithTag</b>, or -<b>TIFFFieldWithName</b>.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldTag</b> -returns an integer tag value.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF),</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFFieldWriteCount.3tiff.html b/doc/static/man/TIFFFieldWriteCount.3tiff.html deleted file mode 100644 index 05c25c53..00000000 --- a/doc/static/man/TIFFFieldWriteCount.3tiff.html +++ /dev/null @@ -1,108 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFFieldWriteCount</title> - -</head> -<body> - -<h1 align="center">TIFFFieldWriteCount</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFFieldWriteCount -− Get number of values to be written to field</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFFieldWriteCount(const TIFFField*</b> -<i>fip</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldWriteCount</b> -returns the number of values to be written into the -specified TIFF field; that is, the number of arguments that -should be supplied to <b>TIFFSetField</b>. For most field -types this is a small positive integer, typically 1 or 2, -but there are some special values: <b><br> -TIFF_VARIABLE</b> indicates that a variable number of values -is possible; then, a <b>uint16_t</b> <i>count</i> argument -and a pointer <i>data</i> argument must be supplied to -<b>TIFFSetField</b>. <b><br> -TIFF_VARIABLE2</b> is the same as <b>TIFF_VARIABLE</b> -except that the <i>count</i> argument must have type -<b>uint32_t</b>. (On most modern machines, this makes no -practical difference, and the <i>count</i> argument can -simply be an <b>int</b> in either case.) <b><br> -TIFF_SPP</b> indicates that the number of arguments must be -equal to the image’s number of samples per pixel.</p> - -<p style="margin-left:11%; margin-top: 1em"><i>fip</i> is a -field information pointer previously returned by -<b>TIFFFindField</b>, <b>TIFFFieldWithTag</b>, or -<b>TIFFFieldWithName</b>.</p> - -<p style="margin-left:11%; margin-top: 1em">For most field -types, <b>TIFFFieldWriteCount</b> returns the same value as -<b>TIFFFieldReadCount</b>, but there are some -exceptions.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFFieldWriteCount</b> -returns an integer.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF),</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFFlush.3tiff.html b/doc/static/man/TIFFFlush.3tiff.html deleted file mode 100644 index e7c93175..00000000 --- a/doc/static/man/TIFFFlush.3tiff.html +++ /dev/null @@ -1,108 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFFlush</title> - -</head> -<body> - -<h1 align="center">TIFFFlush</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFFlush, -TIFFFlushData − flush pending writes to an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFFlush(TIFF *</b><i>tif</i><b>) <br> -int TIFFFlushData(TIFF *</b><i>tif</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFFlush</i></b> -causes any pending writes for the specified file (including -writes for the current directory) to be done. In normal -operation this call is never needed − the library -automatically does any flushing required.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFFlushData</i> -flushes any pending image data for the specified file to be -written out; directory-related data are not flushed. In -normal operation this call is never needed − the -library automatically does any flushing required.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">0 is returned -if an error is encountered, otherwise 1 is returned.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFWriteEncodedStrip</b>(3TIFF), -<b>TIFFWriteEncodedTile</b>(3TIFF), -<b>TIFFWriteRawStrip</b>(3TIFF), -<b>TIFFWriteRawTile</b>(3TIFF), -<b>TIFFWriteScanline</b>(3TIFF), <b>TIFFWriteTile</b>(3TIFF) -<b>libtiff</b>(3TIFF),</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFGetField.3tiff.html b/doc/static/man/TIFFGetField.3tiff.html deleted file mode 100644 index b6796d54..00000000 --- a/doc/static/man/TIFFGetField.3tiff.html +++ /dev/null @@ -1,1953 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFGetField</title> - -</head> -<body> - -<h1 align="center">TIFFGetField</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#AUTOREGISTERED TAGS">AUTOREGISTERED TAGS</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFGetField, -TIFFVGetField − get the value(s) of a tag in an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFGetField(TIFF *</b><i>tif</i><b>, ttag_t</b> -<i>tag</i><b>,</b> <i>...</i><b>)</b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<stdarg.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFVGetField(TIFF *</b><i>tif</i><b>, ttag_t</b> -<i>tag</i><b>, va_list</b> <i>ap</i><b>) <br> -int TIFFGetFieldDefaulted(TIFF *</b><i>tif</i><b>, -ttag_t</b> <i>tag</i><b>,</b> <i>...</i><b>) <br> -int TIFFVGetFieldDefaulted(TIFF *</b><i>tif</i><b>, -ttag_t</b> <i>tag</i><b>, va_list</b> <i>ap</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFGetField</i></b> -returns the value of a tag or pseudo-tag associated with the -the current directory of the opened <small>TIFF</small> file -<i>tif</i>. (A <i>pseudo-tag</i> is a parameter that is used -to control the operation of the <small>TIFF</small> library -but whose value is not read or written to the underlying -file.) The file must have been previously opened with -<i>TIFFOpen</i>(3TIFF). The tag is identified by <i>tag</i>, -one of the values defined in the include file <b>tiff.h</b> -(see also the table below). The type and number of values -returned is dependent on the tag being requested. The -programming interface uses a variable argument list as -prescribed by the <i>stdarg</i>(3) interface. The returned -values should only be interpreted if <i>TIFFGetField</i> -returns 1.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFVGetField</i> -is functionally equivalent to <i>TIFFGetField</i> except -that it takes a pointer to a variable argument list. -<i>TIFFVGetField</i> is useful for layering interfaces on -top of the functionality provided by -<i>TIFFGetField</i>.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFGetFieldDefaulted</i> -and <i>TIFFVGetFieldDefaulted</i> are identical to -<i>TIFFGetField</i> and <i>TIFFVGetField</i>, except that if -a tag is not defined in the current directory and it has a -default value, then the default value is returned.</p> - -<p style="margin-left:11%; margin-top: 1em">The tags -understood by <i>libtiff(3TIFF),</i> the number of parameter -values, and the types for the returned values are shown -below. The data types are specified as in C and correspond -to the types used to specify tag values to -<i>TIFFSetField</i>(3TIFF). Remember that -<i>TIFFGetField</i> returns parameter values, so all the -listed data types are pointers to storage where values -should be returned. Consult the <small>TIFF</small> -specification (or relevant industry specification) for -information on the meaning of each tag and their possible -values.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p><i>Tag Name</i></p></td> -<td width="11%"></td> -<td width="28%"> - - -<p><i>Count</i></p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p><i>Types</i></p></td> -<td width="12%"> - - -<p><i>Notes</i></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_ARTIST</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_BADFAXLINES</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_BITSPERSAMPLE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_CLEANFAXDATA</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_COLORMAP</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>3</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const uint16_t**</p></td> -<td width="12%"> - - -<p>1<<BitsPerSample arrays</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_COMPRESSION</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_CONSECUTIVEBADFAXLINES</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_COPYRIGHT</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_DATATYPE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_DATETIME</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_DOCUMENTNAME</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_DOTRANGE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>2</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_EXTRASAMPLES</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>2</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*,const uint16_t**count & types array</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_FAXFILLFUNC</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>TIFFFaxFillFunc*</p></td> -<td width="12%"> - - -<p>G3/G4 compression pseudo-tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_FAXMODE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>int*</p></td> -<td width="12%"> - - -<p>G3/G4 compression pseudo-tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_FILLORDER</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_GROUP3OPTIONS</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_GROUP4OPTIONS</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_HALFTONEHINTS</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>2</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_HOSTCOMPUTER</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_ICCPROFILE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>2</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const uint32_t*,const void**count, profile data</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_IMAGEDEPTH</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_IMAGEDESCRIPTION</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_IMAGELENGTH</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_IMAGEWIDTH</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_INKNAMES</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_INKSET</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_JPEGCOLORMODE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>int*</p></td> -<td width="12%"> - - -<p>JPEG pseudo-tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_JPEGQUALITY</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>int*</p></td> -<td width="12%"> - - -<p>JPEG pseudo-tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_JPEGTABLES</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>2</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*,const void**count & tables</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_JPEGTABLESMODE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>int*</p></td> -<td width="12%"> - - -<p>JPEG pseudo-tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_MAKE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_MATTEING</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_MAXSAMPLEVALUE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_MINSAMPLEVALUE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_MODEL</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_ORIENTATION</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PAGENAME</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PAGENUMBER</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>2</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PHOTOMETRIC</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PHOTOSHOP</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>2</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*,const void**count, data</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PLANARCONFIG</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PREDICTOR</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PRIMARYCHROMATICITIES</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const float**</p></td> -<td width="12%"> - - -<p>6-entry array</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_REFERENCEBLACKWHITE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const float**</p></td> -<td width="12%"> - - -<p>6-entry array</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_RESOLUTIONUNIT</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_RICHTIFFIPTC</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>2</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*,const void**count, data</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_ROWSPERSTRIP</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SAMPLEFORMAT</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SAMPLESPERPIXEL</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SMAXSAMPLEVALUE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>double*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SMINSAMPLEVALUE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>double*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SOFTWARE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_STONITS</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const double**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_STRIPBYTECOUNTS</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const uint64_t**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_STRIPOFFSETS</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const uint64_t**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SUBFILETYPE</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SUBIFD</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>2</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*,const uint64_t**count & offsets array</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TARGETPRINTER</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const char**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_THRESHHOLDING</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TILEBYTECOUNTS</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const uint64_t**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TILEDEPTH</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TILELENGTH</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TILEOFFSETS</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const uint64_t**</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TILEWIDTH</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TRANSFERFUNCTION</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1 or 3†</p></td> -<td width="12%"> - - -<p>const uint16_t**1<<BitsPerSample entry arrays</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_WHITEPOINT</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const float**</p></td> -<td width="12%"> - - -<p>2-entry array</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_XMLPACKET</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>2</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint32_t*,const void**count, data</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_XPOSITION</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>float*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_XRESOLUTION</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>float*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_YCBCRCOEFFICIENTS</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>const float**</p></td> -<td width="12%"> - - -<p>3-entry array</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_YCBCRPOSITIONING</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_YCBCRSUBSAMPLING</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>2</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>uint16_t*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_YPOSITION</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>float*</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_YRESOLUTION</p></td> -<td width="11%"></td> -<td width="28%"> - - -<p>1</p></td> -<td width="12%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="28%"> - - -<p>float*‡</p></td> -<td width="12%"> -</td></tr> -</table> - -<p style="margin-left:11%;">† If -<i>SamplesPerPixel</i> is one, then a single array is -returned; otherwise three arrays are returned. <br> -‡ The contents of this field are quite complex. See -<i>The ICC Profile Format Specification</i>, Annex B.3 -"Embedding ICC Profiles in TIFF Files" (available -at http://www.color.org) for an explanation.</p> - -<h2>AUTOREGISTERED TAGS -<a name="AUTOREGISTERED TAGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">If you -can’t find the tag in the table above that means this -is an unsupported tag and is not directly supported by -<b>libtiff(3TIFF)</b> library. You will still be able to -read it’s value if you know the data type of that tag. -For example, if you want to read the LONG value from the tag -33424 and ASCII string from the tag 36867 you can use the -following code:</p> - -<p style="margin-left:22%; margin-top: 1em">uint32_t count; -<br> -void *data;</p> - - -<p style="margin-left:22%; margin-top: 1em">TIFFGetField(tiff, -33424, &count, &data); <br> -printf("Tag %d: %d, count %d0, 33424, *(uint32_t -*)data, count); <br> -TIFFGetField(tiff, 36867, &count, &data); <br> -printf("Tag %d: %s, count %d0, 36867, (char *)data, -count);</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">1 is returned -if the tag is defined in the current directory; otherwise a -0 is returned.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Unknown -field, tag 0x%x</b>. An unknown tag was supplied.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFSetField</b>(3TIFF), <b>TIFFSetDirectory</b>(3TIFF), -<b>TIFFReadDirectory</b>(3TIFF), -<b>TIFFWriteDirectory</b>(3TIFF) <b>libtiff</b>(3TIFF),</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFOpen.3tiff.html b/doc/static/man/TIFFOpen.3tiff.html deleted file mode 100644 index 58227ca9..00000000 --- a/doc/static/man/TIFFOpen.3tiff.html +++ /dev/null @@ -1,452 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFOpen</title> - -</head> -<body> - -<h1 align="center">TIFFOpen</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#BYTE ORDER">BYTE ORDER</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFOpen, -TIFFFdOpen, TIFFClientOpen − open a -<small>TIFF</small> file for reading or writing</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>TIFF* -TIFFOpen(const char *</b><i>filename</i><b>, const char -*</b><i>mode</i><b>) <br> -TIFF* TIFFFdOpen(const int</b> <i>fd</i><b>, const char -*</b><i>filename</i><b>, const char -*</b><i>mode</i><b>)</b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>typedef -tsize_t (*TIFFReadWriteProc)(thandle_t, tdata_t, tsize_t); -<br> -typedef toff_t (*TIFFSeekProc)(thandle_t, toff_t, int); <br> -typedef int (*TIFFCloseProc)(thandle_t); <br> -typedef toff_t (*TIFFSizeProc)(thandle_t); <br> -typedef int (*TIFFMapFileProc)(thandle_t, tdata_t*, -toff_t*); <br> -typedef void (*TIFFUnmapFileProc)(thandle_t, tdata_t, -toff_t);</b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>TIFF* -TIFFClientOpen(const char *</b><i>filename</i><b>, const -char *</b><i>mode</i><b>, thandle_t</b> -<i>clientdata</i><b>, TIFFReadWriteProc</b> -<i>readproc</i><b>, TIFFReadWriteProc</b> -<i>writeproc</i><b>, TIFFSeekProc</b> <i>seekproc</i><b>, -TIFFCloseProc</b> <i>closeproc</i><b>, TIFFSizeProc</b> -<i>sizeproc</i><b>, TIFFMapFileProc</b> <i>mapproc</i><b>, -TIFFUnmapFileProc</b> <i>unmapproc</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFOpen</i></b> -opens a <small>TIFF</small> file whose name is -<i>filename</i> and returns a handle to be used in -subsequent calls to routines in <i>libtiff</i>. If the open -operation fails, then zero is returned. The <i>mode</i> -parameter specifies if the file is to be opened for reading -(‘‘r’’), writing -(‘‘w’’), or appending -(‘‘a’’) and, optionally, whether to -override certain default aspects of library operation (see -below). When a file is opened for appending, existing data -will not be touched; instead new data will be written as -additional subfiles. If an existing file is opened for -writing, all previous data is overwritten.</p> - -<p style="margin-left:11%; margin-top: 1em">If a file is -opened for reading, the first <small>TIFF</small> directory -in the file is automatically read (also see -<i>TIFFSetDirectory</i>(3TIFF) for reading directories other -than the first). If a file is opened for writing or -appending, a default directory is automatically created for -writing subsequent data. This directory has all the default -values specified in <small>TIFF</small> Revision 6.0: -<i>BitsPerSample</i>=1, <i>ThreshHolding</i>=bilevel art -scan, <i>FillOrder</i>=1 (most significant bit of each data -byte is filled first), <i>Orientation</i>=1 (the 0th row -represents the visual top of the image, and the 0th column -represents the visual left hand side), -<i>SamplesPerPixel</i>=1, <i>RowsPerStrip</i>=infinity, -<i>ResolutionUnit</i>=2 (inches), and <i>Compression</i>=1 -(no compression). To alter these values, or to define values -for additional fields, <i>TIFFSetField</i>(3TIFF) must be -used.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFFdOpen</i> -is like <i>TIFFOpen</i> except that it opens a -<small>TIFF</small> file given an open file descriptor -<i>fd</i>. The file’s name and mode must reflect that -of the open descriptor. The object associated with the file -descriptor <b>must support random access</b>.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFClientOpen</i> -is like <i>TIFFOpen</i> except that the caller supplies a -collection of functions that the library will use to do -<small>UNIX</small> -like I/O operations. The -<i>readproc</i> and <i>writeproc</i> are called to read and -write data at the current file position. <i>seekproc</i> is -called to change the current file position a la -<i>lseek</i>(2). <i>closeproc</i> is invoked to release any -resources associated with an open file. <i>sizeproc</i> is -invoked to obtain the size in bytes of a file. -<i>mapproc</i> and <i>unmapproc</i> are called to map and -unmap a file’s contents in memory; c.f. <i>mmap</i>(2) -and <i>munmap</i>(2). The <i>clientdata</i> parameter is an -opaque ‘‘handle’’ passed to the -client-specified routines passed as parameters to -<i>TIFFClientOpen</i>.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The open mode -parameter can include the following flags in addition to the -‘‘r’’, -‘‘w’’, and -‘‘a’’ flags. Note however that -option flags must follow the read-write-append -specification.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>l</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>When creating a new file force information be written -with Little-Endian byte order (but see below). By default -the library will create new files using the native -<small>CPU</small> byte order.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>b</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>When creating a new file force information be written -with Big-Endian byte order (but see below). By default the -library will create new files using the native -<small>CPU</small> byte order.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>L</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>Force image data that is read or written to be treated -with bits filled from Least Significant Bit ( -<small>LSB</small> ) to Most Significant Bit ( -<small>MSB</small> ). Note that this is the opposite to the -way the library has worked from its inception.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>B</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>Force image data that is read or written to be treated -with bits filled from Most Significant Bit ( -<small>MSB</small> ) to Least Significant Bit ( -<small>LSB</small> ); this is the default.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>H</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>Force image data that is read or written to be treated -with bits filled in the same order as the native -<small>CPU.</small></p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>M</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>Enable the use of memory-mapped files for images opened -read-only. If the underlying system does not support -memory-mapped files or if the specific image being opened -cannot be memory-mapped then the library will fallback to -using the normal system interface for reading information. -By default the library will attempt to use memory-mapped -files.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>m</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>Disable the use of memory-mapped files.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>C</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>Enable the use of ‘‘strip -chopping’’ when reading images that are -comprised of a single strip or tile of uncompressed data. -Strip chopping is a mechanism by which the library will -automatically convert the single-strip image to multiple -strips, each of which has about 8 Kilobytes of data. This -facility can be useful in reducing the amount of memory used -to read an image because the library normally reads each -strip in its entirety. Strip chopping does however alter the -apparent contents of the image because when an image is -divided into multiple strips it looks as though the -underlying file contains multiple separate strips. Finally, -note that default handling of strip chopping is a -compile-time configuration parameter. The default behaviour, -for backwards compatibility, is to enable strip -chopping.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>c</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>Disable the use of strip chopping when reading -images.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>h</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>Read TIFF header only, do not load the first image -directory. That could be useful in case of the broken first -directory. We can open the file and proceed to the other -directories.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>4</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>ClassicTIFF for creating a file (default)</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>8</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>BigTIFF for creating a file.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>D</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>Enable use of deferred strip/tile offset/bytecount array -loading. They will be loaded the first time they are -accessed to. This loading will be done in its entirety -unless the O flag is also specified.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>O</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>On-demand loading of values of the strip/tile -offset/bytecount arrays, limited to the requested -strip/tile, instead of whole array loading (implies D)</p></td></tr> -</table> - -<h2>BYTE ORDER -<a name="BYTE ORDER"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The -<small>TIFF</small> specification (<b>all versions</b>) -states that compliant readers <i>must be capable of reading -images written in either byte order</i>. Nonetheless some -software that claims to support the reading of -<small>TIFF</small> images is incapable of reading images in -anything but the native <small>CPU</small> byte order on -which the software was written. (Especially notorious are -applications written to run on Intel-based machines.) By -default the library will create new files with the native -byte-order of the <small>CPU</small> on which the -application is run. This ensures optimal performance and is -portable to any application that conforms to the TIFF -specification. To force the library to use a specific -byte-order when creating a new file the -‘‘b’’ and -‘‘l’’ option flags may be included -in the call to open a file; for example, -‘‘wb’’ or -‘‘wl’’.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Upon successful -completion <i>TIFFOpen</i>, <i>TIFFFdOpen</i>, and -<i>TIFFClientOpen</i> return a <small>TIFF</small> pointer. -Otherwise, NULL is returned.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <i>TIFFError</i>(3TIFF) -routine. Likewise, warning messages are directed to the -<i>TIFFWarning</i>(3TIFF) routine.</p> - - -<p style="margin-left:11%; margin-top: 1em"><b>"%s": -Bad mode</b>. The specified <i>mode</i> parameter was not -one of ‘‘r’’ (read), -‘‘w’’ (write), or -‘‘a’’ (append).</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Cannot -open</b>. <i>TIFFOpen</i>() was unable to open the specified -filename for read/writing.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Cannot read -TIFF header</b>. An error occurred while attempting to read -the header information.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Error -writing TIFF header</b>. An error occurred while writing the -default header information for a new file.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Not a TIFF -file, bad magic number %d (0x%x)</b>. The magic number in -the header was not (hex) 0x4d4d or (hex) 0x4949.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Not a TIFF -file, bad version number %d (0x%x)</b>. The version field in -the header was not 42 (decimal).</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Cannot -append to file that has opposite byte ordering</b>. A file -with a byte ordering opposite to the native byte ordering of -the current machine was opened for appending -(‘‘a’’). This is a limitation of the -library.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>libtiff</i>(3TIFF), -<i>TIFFClose</i>(3TIFF)</p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFPrintDirectory.3tiff.html b/doc/static/man/TIFFPrintDirectory.3tiff.html deleted file mode 100644 index 06fd8980..00000000 --- a/doc/static/man/TIFFPrintDirectory.3tiff.html +++ /dev/null @@ -1,233 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFPrintDirectory</title> - -</head> -<body> - -<h1 align="center">TIFFPrintDirectory</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFPrintDirectory -− print a description of a <small>TIFF</small> -directory</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>void -TIFFPrintDirectory(TIFF *</b><i>tif</i><b>, FILE -*</b><i>fd</i><b>, long</b> <i>flags</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFPrintDirectory</i></b> -prints a description of the current directory in the -specified <small>TIFF</small> file to the standard I/O -output stream <i>fd</i>. The <i>flags</i> parameter is used -to control the <i>level of detail</i> of the printed -information; it is a bit-or of the flags defined in -<b>tiffio.h</b>:</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p>#define</p></td> -<td width="37%"> - - -<p>TIFFPRINT_NONE</p></td> -<td width="13%"> - - -<p>0x0</p></td> -<td width="38%"> - - -<p>/* no extra info */</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p>#define</p></td> -<td width="37%"> - - -<p>TIFFPRINT_STRIPS</p></td> -<td width="13%"> - - -<p>0x1</p></td> -<td width="38%"> - - -<p>/* strips/tiles info */</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p>#define</p></td> -<td width="37%"> - - -<p>TIFFPRINT_CURVES</p></td> -<td width="13%"> - - -<p>0x2</p></td> -<td width="38%"> - - -<p>/* color/gray response curves */</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p>#define</p></td> -<td width="37%"> - - -<p>TIFFPRINT_COLORMAP</p></td> -<td width="13%"> - - -<p>0x4</p></td> -<td width="38%"> - - -<p>/* colormap */</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p>#define</p></td> -<td width="37%"> - - -<p>TIFFPRINT_JPEGQTABLES</p></td> -<td width="13%"> - - -<p>0x100</p></td> -<td width="38%"> - - -<p>/* JPEG Q matrices */</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p>#define</p></td> -<td width="37%"> - - -<p>TIFFPRINT_JPEGACTABLES</p></td> -<td width="13%"> - - -<p>0x200</p></td> -<td width="38%"> - - -<p>/* JPEG AC tables */</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p>#define</p></td> -<td width="37%"> - - -<p>TIFFPRINT_JPEGDCTABLES</p></td> -<td width="13%"> - - -<p>0x200</p></td> -<td width="38%"> - - -<p>/* JPEG DC tables */</p></td></tr> -</table> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">In C++ the -<i>flags</i> parameter defaults to 0.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">None.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">None.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>libtiff</i>(3TIFF), -<i>TIFFOpen</i>(3TIFF), <i>TIFFReadDirectory</i>(3TIFF), -<i>TIFFSetDirectory</i>(3TIFF)</p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFRGBAImage.3tiff.html b/doc/static/man/TIFFRGBAImage.3tiff.html deleted file mode 100644 index 90bb5dc3..00000000 --- a/doc/static/man/TIFFRGBAImage.3tiff.html +++ /dev/null @@ -1,319 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFRGBAImage</title> - -</head> -<body> - -<h1 align="center">TIFFRGBAImage</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#ALTERNATE RASTER FORMATS">ALTERNATE RASTER FORMATS</a><br> -<a href="#SIMULTANEOUS RASTER STORE AND DISPLAY">SIMULTANEOUS RASTER STORE AND DISPLAY</a><br> -<a href="#SUPPORTING ADDITIONAL TIFF FORMATS">SUPPORTING ADDITIONAL TIFF FORMATS</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFRGBAImageOK, -TIFFRGBAImageBegin, TIFFRGBAImageGet, TIFFRGBAImageEnd -− read and decode an image into a raster</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>typedef -unsigned char TIFFRGBValue; typedef struct _TIFFRGBAImage -TIFFRGBAImage;</b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFRGBAImageOK(TIFF *</b><i>tif</i><b>, char</b> -<i>emsg[1024]</i><b>) <br> -int TIFFRGBAImageBegin(TIFFRGBAImage *</b><i>img</i><b>, -TIFF*</b> <i>tif</i><b>, int</b> <i>stopOnError</i><b>, -char</b> <i>emsg[1024]</i><b>) <br> -int TIFFRGBAImageGet(TIFFRGBAImage *</b><i>img</i><b>, -uint32_t*</b> <i>raster</i><b>, uint32_t</b> <i>width</i> -<b>, uint32_t</b> <i>height</i><b>) <br> -void TIFFRGBAImageEnd(TIFFRGBAImage -*</b><i>img</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The routines -described here provide a high-level interface through which -<small>TIFF</small> images may be read into memory. Images -may be strip- or tile-based and have a variety of different -characteristics: bits/sample, samples/pixel, photometric, -etc. Decoding state is encapsulated in a -<i>TIFFRGBAImage</i> structure making it possible to capture -state for multiple images and quickly switch between them. -The target raster format can be customized to a particular -application’s needs by installing custom routines that -manipulate image data according to application -requirements.</p> - -<p style="margin-left:11%; margin-top: 1em">The default -usage for these routines is: check if an image can be -processed using <i>TIFFRGBAImageOK</i>, construct a decoder -state block using <i>TIFFRGBAImageBegin</i>, read and decode -an image into a target raster using <i>TIFFRGBAImageGet</i>, -and then release resources using <i>TIFFRGBAImageEnd</i>. -<i>TIFFRGBAImageGet</i> can be called multiple times to -decode an image using different state parameters. If -multiple images are to be displayed and there is not enough -space for each of the decoded rasters, multiple state blocks -can be managed and then calls can be made to -<i>TIFFRGBAImageGet</i> as needed to display an image.</p> - -<p style="margin-left:11%; margin-top: 1em">The generated -raster is assumed to be an array of <i>width</i> times -<i>height</i> 32-bit entries, where <i>width</i> must be -less than or equal to the width of the image (<i>height</i> -may be any non-zero size). If the raster dimensions are -smaller than the image, the image data is cropped to the -raster bounds. If the raster height is greater than that of -the image, then the image data are placed in the lower part -of the raster. (Note that the raster is assume to be -organized such that the pixel at location -(<i>x</i>,<i>y</i>) is -<i>raster</i>[<i>y</i>*<i>width</i>+<i>x</i>]; with the -raster origin in the <b>lower-left</b> hand corner.)</p> - -<p style="margin-left:11%; margin-top: 1em">Raster pixels -are 8-bit packed red, green, blue, alpha samples. The macros -<i>TIFFGetR</i>, <i>TIFFGetG</i>, <i>TIFFGetB</i>, and -<i>TIFFGetA</i> should be used to access individual samples. -Images without Associated Alpha matting information have a -constant Alpha of 1.0 (255).</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFRGBAImageGet</i> -converts non-8-bit images by scaling sample values. Palette, -grayscale, bilevel, <small>CMYK, and YCbCr images are -converted to RGB</small> transparently. Raster pixels are -returned uncorrected by any colorimetry information present -in the directory.</p> - -<p style="margin-left:11%; margin-top: 1em">The parameter -<i>stopOnError</i> specifies how to act if an error is -encountered while reading the image. If <i>stopOnError</i> -is non-zero, then an error will terminate the operation; -otherwise <i>TIFFRGBAImageGet</i> will continue processing -data until all the possible data in the image have been -requested.</p> - -<h2>ALTERNATE RASTER FORMATS -<a name="ALTERNATE RASTER FORMATS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">To use the core -support for reading and processing <small>TIFF</small> -images, but write the resulting raster data in a different -format one need only override the ‘‘<i>put -methods</i>’’ used to store raster data. These -methods are are defined in the <i>TIFFRGBAImage</i> -structure and initially setup by <i>TIFFRGBAImageBegin</i> -to point to routines that pack raster data in the default -<small>ABGR</small> pixel format. Two different routines are -used according to the physical organization of the image -data in the file: <i>PlanarConfiguration</i>=1 (packed -samples), and <i>PlanarConfiguration</i>=2 (separated -samples). Note that this mechanism can be used to transform -the data before storing it in the raster. For example one -can convert data to colormap indices for display on a -colormap display.</p> - -<h2>SIMULTANEOUS RASTER STORE AND DISPLAY -<a name="SIMULTANEOUS RASTER STORE AND DISPLAY"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">It is simple to -display an image as it is being read into memory by -overriding the put methods as described above for supporting -alternate raster formats. Simply keep a reference to the -default put methods setup by <i>TIFFRGBAImageBegin</i> and -then invoke them before or after each display operation. For -example, the <i>tiffgt</i>(1) utility uses the following put -method to update the display as the raster is being -filled:</p> - -<pre style="margin-left:11%; margin-top: 1em">static void -putContigAndDraw(TIFFRGBAImage* img, uint32_t* raster, - uint32_t x, uint32_t y, uint32_t w, uint32_t h, - int32_t fromskew, int32_t toskew, - unsigned char* cp) -{ - (*putContig)(img, raster, x, y, w, h, fromskew, toskew, cp); - if (x+w == width) { - w = width; - if (img->orientation == ORIENTATION_TOPLEFT) - lrectwrite(0, y-(h-1), w-1, y, raster-x-(h-1)*w); - else - lrectwrite(0, y, w-1, y+h-1, raster); - } -}</pre> - - -<p style="margin-left:11%; margin-top: 1em">(the original -routine provided by the library is saved in the variable -<i>putContig</i>.)</p> - -<h2>SUPPORTING ADDITIONAL TIFF FORMATS -<a name="SUPPORTING ADDITIONAL TIFF FORMATS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The -<i>TIFFRGBAImage</i> routines support the most commonly -encountered flavors of <small>TIFF.</small> It is possible -to extend this support by overriding the -‘‘<i>get method</i>’’ invoked by -<i>TIFFRGBAImageGet</i> to read <small>TIFF</small> image -data. Details of doing this are a bit involved, it is best -to make a copy of an existing get method and modify it to -suit the needs of an application.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Samples must be -either 1, 2, 4, 8, or 16 bits. Colorimetric samples/pixel -must be either 1, 3, or 4 (i.e. <i>SamplesPerPixel</i> minus -<i>ExtraSamples</i>).</p> - -<p style="margin-left:11%; margin-top: 1em">Palette image -colormaps that appear to be incorrectly written as 8-bit -values are automatically scaled to 16-bits.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All routines -return 1 if the operation was successful. Otherwise, 0 is -returned if an error was encountered and <i>stopOnError</i> -is zero.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <i>TIFFError</i>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Sorry, can -not handle %d-bit pictures</b>. The image had -<i>BitsPerSample</i> other than 1, 2, 4, 8, or 16.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Sorry, can -not handle %d-channel images</b>. The image had -<i>SamplesPerPixel</i> other than 1, 3, or 4.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Missing -needed "PhotometricInterpretation" tag</b>. The -image did not have a tag that describes how to display the -data.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No -"PhotometricInterpretation" tag, assuming RGB</b>. -The image was missing a tag that describes how to display -it, but because it has 3 or 4 samples/pixel, it is assumed -to be <small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>No -"PhotometricInterpretation" tag, assuming -min-is-black</b>. The image was missing a tag that describes -how to display it, but because it has 1 sample/pixel, it is -assumed to be a grayscale or bilevel image.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -photometric conversion table</b>. There was insufficient -memory for a table used to convert image samples to 8-bit -<small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>Missing -required "Colormap" tag</b>. A Palette image did -not have a required <i>Colormap</i> tag.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -tile buffer</b>. There was insufficient memory to allocate -an i/o buffer.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -strip buffer</b>. There was insufficient memory to allocate -an i/o buffer.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Can not -handle format</b>. The image has a format (combination of -<i>BitsPerSample</i>, <i>SamplesPerPixel</i>, and -<i>PhotometricInterpretation</i>) that can not be -handled.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -B&W mapping table</b>. There was insufficient memory to -allocate a table used to map grayscale data to -<small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -Palette mapping table</b>. There was insufficient memory to -allocate a table used to map data to 8-bit -<small>RGB.</small></p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFReadRGBAImage</b>(3TIFF), -<b>TIFFReadRGBAImageOriented</b>(3TIFF), -<b>TIFFReadRGBAStrip</b>(3TIFF), -<b>TIFFReadRGBATile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFReadDirectory.3tiff.html b/doc/static/man/TIFFReadDirectory.3tiff.html deleted file mode 100644 index 4daf3bfa..00000000 --- a/doc/static/man/TIFFReadDirectory.3tiff.html +++ /dev/null @@ -1,217 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFReadDirectory</title> - -</head> -<body> - -<h1 align="center">TIFFReadDirectory</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFReadDirectory -− get the contents of the next directory in an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFReadDirectory(TIFF *</b><i>tif</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Read the next -directory in the specified file and make it the current -directory. Applications only need to call -<i>TIFFReadDirectory</i> to read multiple subfiles in a -single <small>TIFF</small> file— the first directory -in a file is automatically read when <i>TIFFOpen</i> is -called.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">If the library -is compiled with <small>STRIPCHOP_SUPPORT</small> enabled, -then images that have a single uncompressed strip or tile of -data are automatically treated as if they were made up of -multiple strips or tiles of approximately 8 kilobytes each. -This operation is done only in-memory; it does not alter the -contents of the file. However, the construction of the -‘‘chopped strips’’ is visible to the -application through the number of strips [tiles] returned by -<i>TIFFNumberOfStrips</i> [<i>TIFFNumberOfTiles</i>].</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">If the next -directory was successfully read, 1 is returned. Otherwise, 0 -is returned if an error was encountered, or if there are no -more directories to be read.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <i>TIFFError</i>(3TIFF) -routine. All warning messages are directed to the -<i>TIFFWarning</i>(3TIFF) routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Seek error -accessing TIFF directory</b>. An error occurred while -positioning to the location of the directory.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Wrong data -type %d for field "%s"</b>. The tag entry in the -directory had an incorrect data type. For example, an -<i>ImageDescription</i> tag with a <small>SHORT</small> data -type.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>TIFF -directory is missing required "%s" field</b>. The -specified tag is required to be present by the -<small>TIFF</small> 5.0 specification, but is missing. The -directory is (usually) unusable.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Rational -with zero denominator</b>. A directory tag has a -<small>RATIONAL</small> value whose denominator is zero.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Incorrect -count %d for field "%s" (%lu, expecting %lu); tag -ignored</b>. The specified tag’s count field is bad. -For example, a count other than 1 for a <i>SubFileType</i> -tag.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Cannot -handle different per-sample values for field -"%s"</b>. The tag has <i>SamplesPerPixel</i> -values and they are not all the same; e.g. -<i>BitsPerSample</i>. The library is unable to handle images -of this sort.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Count -mismatch for field "%s"; expecting %d, got %d</b>. -The count field in a tag does not agree with the number -expected by the library. This should never happen, so if it -does, the library refuses to read the directory.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Invalid TIFF -directory; tags are not sorted in ascending order</b>. The -directory tags are not properly sorted as specified in the -<small>TIFF</small> 5.0 specification. This error is not -fatal.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Ignoring -unknown field with tag %d (0x%x)</b>. An unknown tag was -encountered in the directory; the library ignores all such -tags.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>TIFF -directory is missing required "ImageLength" -field</b>. The image violates the specification by not -having a necessary field. There is no way for the library to -recover from this error.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>TIFF -directory is missing required "PlanarConfig" -field</b>. The image violates the specification by not -having a necessary field. There is no way for the library to -recover from this error.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>TIFF -directory is missing required "StripOffsets" -field</b>. The image has multiple strips, but is missing the -tag that specifies the file offset to each strip of data. -There is no way for the library to recover from this -error.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>TIFF -directory is missing required "TileOffsets" -field</b>. The image has multiple tiles, but is missing the -tag that specifies the file offset to each tile of data. -There is no way for the library to recover from this -error.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>TIFF -directory is missing required "StripByteCounts" -field</b>. The image has multiple strips, but is missing the -tag that specifies the size of each strip of data. There is -no way for the library to recover from this error.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>TIFF -directory is missing required "StripByteCounts" -field, calculating from imagelength</b>. The image violates -the specification by not having a necessary field. However, -when the image is comprised of only one strip or tile, the -library will estimate the missing value based on the file -size.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Bogus -"StripByteCounts" field, ignoring and calculating -from imagelength</b>. Certain vendors violate the -specification by writing zero for the StripByteCounts tag -when they want to leave the value unspecified. If the image -has a single strip, the library will estimate the missing -value based on the file size.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFWriteDirectory</b>(3TIFF), -<b>TIFFSetDirectory</b>(3TIFF), -<b>TIFFSetSubDirectory</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFReadEncodedStrip.3tiff.html b/doc/static/man/TIFFReadEncodedStrip.3tiff.html deleted file mode 100644 index 71b8e2ac..00000000 --- a/doc/static/man/TIFFReadEncodedStrip.3tiff.html +++ /dev/null @@ -1,125 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFReadEncodedStrip</title> - -</head> -<body> - -<h1 align="center">TIFFReadEncodedStrip</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFReadEncodedStrip -− read and decode a strip of data from an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>tmsize_t -TIFFReadEncodedStrip(TIFF *</b><i>tif</i><b>, uint32_t</b> -<i>strip</i><b>, void *</b><i>buf</i><b>, tmsize_t</b> -<i>size</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Read the -specified strip of data and place up to <i>size</i> bytes of -decompressed information in the (user supplied) data -buffer.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The value of -<i>strip</i> is a ‘‘raw strip -number.’’ That is, the caller must take into -account whether or not the data are organized in separate -planes (<i>PlanarConfiguration</i>=2). To read a full strip -of data the data buffer should typically be at least as -large as the number returned by <b>TIFFStripSize</b>(3TIFF). -If the -1 passed in <i>size</i> parameter, the whole strip -will be read. You should be sure you have enough space -allocated for the buffer.</p> - -<p style="margin-left:11%; margin-top: 1em">The library -attempts to hide bit- and byte-ordering differences between -the image and the native machine by converting data to the -native machine order. Bit reversal is done if the -<i>FillOrder</i> tag is opposite to the native machine bit -order. 16- and 32-bit samples are automatically byte-swapped -if the file was written with a byte order opposite to the -native machine byte order,</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The actual -number of bytes of data that were placed in <i>buf</i> is -returned; <i>TIFFReadEncodedStrip</i> returns −1 if an -error was encountered.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFReadRawStrip</b>(3TIFF), -<b>TIFFReadScanline</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFReadEncodedTile.3tiff.html b/doc/static/man/TIFFReadEncodedTile.3tiff.html deleted file mode 100644 index 45084027..00000000 --- a/doc/static/man/TIFFReadEncodedTile.3tiff.html +++ /dev/null @@ -1,125 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFReadEncodedTile</title> - -</head> -<body> - -<h1 align="center">TIFFReadEncodedTile</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFReadEncodedTile -− read and decode a tile of data from an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFReadEncodedTile(TIFF *</b><i>tif</i><b>, ttile_t</b> -<i>tile</i><b>, tdata_t</b> <i>buf</i><b>, tsize_t</b> -<i>size</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Read the -specified tile of data and place up to <i>size</i> bytes of -decompressed information in the (user supplied) data -buffer.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The value of -<i>tile</i> is a ‘‘raw tile -number.’’ That is, the caller must take into -account whether or not the data are organized in separate -planes (<i>PlanarConfiguration</i>=2). -<i>TIFFComputeTile</i> automatically does this when -converting an (x,y,z,sample) coordinate quadruple to a tile -number. To read a full tile of data the data buffer should -be at least as large as the value returned by -<i>TIFFTileSize</i>.</p> - -<p style="margin-left:11%; margin-top: 1em">The library -attempts to hide bit- and byte-ordering differences between -the image and the native machine by converting data to the -native machine order. Bit reversal is done if the -<i>FillOrder</i> tag is opposite to the native machine bit -order. 16- and 32-bit samples are automatically byte-swapped -if the file was written with a byte order opposite to the -native machine byte order,</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The actual -number of bytes of data that were placed in <i>buf</i> is -returned; <i>TIFFReadEncodedTile</i> returns −1 if an -error was encountered.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFReadRawTile</b>(3TIFF), <b>TIFFReadTile</b>(3TIFF), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFReadRGBAImage.3tiff.html b/doc/static/man/TIFFReadRGBAImage.3tiff.html deleted file mode 100644 index 0292f319..00000000 --- a/doc/static/man/TIFFReadRGBAImage.3tiff.html +++ /dev/null @@ -1,258 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFReadRGBAImage</title> - -</head> -<body> - -<h1 align="center">TIFFReadRGBAImage</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFReadRGBAImage, -TIFFReadRGBAImageOriented − read and decode an image -into a fixed-format raster</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>#define -TIFFGetR(abgr) ((abgr) & 0xff) <br> -#define TIFFGetG(abgr) (((abgr) >> 8) & 0xff) <br> -#define TIFFGetB(abgr) (((abgr) >> 16) & 0xff) -<br> -#define TIFFGetA(abgr) (((abgr) >> 24) & -0xff)</b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFReadRGBAImage(TIFF *</b><i>tif</i><b>, uint32_t</b> -<i>width</i><b>, uint32_t</b> <i>height</i><b>, uint32_t -*</b><i>raster</i><b>, int</b> <i>stopOnError</i><b>) <br> -int TIFFReadRGBAImageOriented(TIFF *</b><i>tif</i><b>, -uint32_t</b> <i>width</i><b>, uint32_t</b> <i>height</i><b>, -uint32_t *</b><i>raster</i><b>, int</b> -<i>orientation</i><b>, int</b> -<i>stopOnError</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFReadRGBAImage</i></b> -reads a strip- or tile-based image into memory, storing the -result in the user supplied <i>raster</i>. The raster is -assumed to be an array of <i>width</i> times <i>height</i> -32-bit entries, where <i>width</i> must be less than or -equal to the width of the image (<i>height</i> may be any -non-zero size). If the raster dimensions are smaller than -the image, the image data is cropped to the raster bounds. -If the raster height is greater than that of the image, then -the image data are placed in the lower part of the raster. -(Note that the raster is assume to be organized such that -the pixel at location (<i>x</i>,<i>y</i>) is -<i>raster</i>[<i>y</i>*<i>width</i>+<i>x</i>]; with the -raster origin in the lower-left hand corner.)</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFReadRGBAImageOriented</i> -works like <i>TIFFReadRGBAImage</i> with except of that user -can specify the raster origin position with the -<i>orientation</i> parameter. Four orientations supported: -<b><br> -ORIENTATION_TOPLEFT</b></p> - -<p style="margin-left:22%;">origin in top-left corner,</p> - - -<p style="margin-left:11%;"><b>ORIENTATION_TOPRIGHT</b></p> - -<p style="margin-left:22%;">origin in top-right corner,</p> - -<p style="margin-left:11%;"><b>ORIENTATION_BOTLEFT</b></p> - -<p style="margin-left:22%;">origin in bottom-left corner -and</p> - - -<p style="margin-left:11%;"><b>ORIENTATION_BOTRIGHT</b></p> - -<p style="margin-left:22%;">origin in bottom-right -corner.</p> - -<p style="margin-left:11%; margin-top: 1em">If you choose -<b>ORIENTATION_BOTLEFT</b> result will be the same as -returned by the <i>TIFFReadRGBAImage.</i></p> - -<p style="margin-left:11%; margin-top: 1em">Raster pixels -are 8-bit packed red, green, blue, alpha samples. The macros -<i>TIFFGetR</i>, <i>TIFFGetG</i>, <i>TIFFGetB</i>, and -<i>TIFFGetA</i> should be used to access individual samples. -Images without Associated Alpha matting information have a -constant Alpha of 1.0 (255).</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFReadRGBAImage</i> -converts non-8-bit images by scaling sample values. Palette, -grayscale, bilevel, <small>CMYK, and YCbCr images are -converted to RGB</small> transparently. Raster pixels are -returned uncorrected by any colorimetry information present -in the directory.</p> - -<p style="margin-left:11%; margin-top: 1em">The parameter -<i>stopOnError</i> specifies how to act if an error is -encountered while reading the image. If <i>stopOnError</i> -is non-zero, then an error will terminate the operation; -otherwise <i>TIFFReadRGBAImage</i> will continue processing -data until all the possible data in the image have been -requested.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">In C++ the -<i>stopOnError</i> parameter defaults to 0.</p> - -<p style="margin-left:11%; margin-top: 1em">Samples must be -either 1, 2, 4, 8, or 16 bits. Colorimetric samples/pixel -must be either 1, 3, or 4 (i.e. <i>SamplesPerPixel</i> minus -<i>ExtraSamples</i>).</p> - -<p style="margin-left:11%; margin-top: 1em">Palettte image -colormaps that appear to be incorrectly written as 8-bit -values are automatically scaled to 16-bits.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFReadRGBAImage</i> -is just a wrapper around the more general -<i>TIFFRGBAImage</i>(3TIFF) facilities.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">1 is returned -if the image was successfully read and converted. Otherwise, -0 is returned if an error was encountered and -<i>stopOnError</i> is zero.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <i>TIFFError</i>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Sorry, can -not handle %d-bit pictures</b>. The image had -<i>BitsPerSample</i> other than 1, 2, 4, 8, or 16.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Sorry, can -not handle %d-channel images</b>. The image had -<i>SamplesPerPixel</i> other than 1, 3, or 4.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Missing -needed "PhotometricInterpretation" tag</b>. The -image did not have a tag that describes how to display the -data.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No -"PhotometricInterpretation" tag, assuming RGB</b>. -The image was missing a tag that describes how to display -it, but because it has 3 or 4 samples/pixel, it is assumed -to be <small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>No -"PhotometricInterpretation" tag, assuming -min-is-black</b>. The image was missing a tag that describes -how to display it, but because it has 1 sample/pixel, it is -assumed to be a grayscale or bilevel image.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -photometric conversion table</b>. There was insufficient -memory for a table used to convert image samples to 8-bit -<small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>Missing -required "Colormap" tag</b>. A Palette image did -not have a required <i>Colormap</i> tag.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -tile buffer</b>. There was insufficient memory to allocate -an i/o buffer.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -strip buffer</b>. There was insufficient memory to allocate -an i/o buffer.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Can not -handle format</b>. The image has a format (combination of -<i>BitsPerSample</i>, <i>SamplesPerPixel</i>, and -<i>PhotometricInterpretation</i>) that -<i>TIFFReadRGBAImage</i> can not handle.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -B&W mapping table</b>. There was insufficient memory to -allocate a table used to map grayscale data to -<small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -Palette mapping table</b>. There was insufficient memory to -allocate a table used to map data to 8-bit -<small>RGB.</small></p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFRGBAImage</b>(3TIFF), -<b>TIFFReadRGBAStrip</b>(3TIFF), -<b>TIFFReadRGBATile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFReadRGBAStrip.3tiff.html b/doc/static/man/TIFFReadRGBAStrip.3tiff.html deleted file mode 100644 index d1c497c0..00000000 --- a/doc/static/man/TIFFReadRGBAStrip.3tiff.html +++ /dev/null @@ -1,217 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFReadRGBAStrip</title> - -</head> -<body> - -<h1 align="center">TIFFReadRGBAStrip</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFReadRGBAStrip -− read and decode an image strip into a fixed-format -raster</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>#define -TIFFGetR(abgr) ((abgr) & 0xff) <br> -#define TIFFGetG(abgr) (((abgr) >> 8) & 0xff) <br> -#define TIFFGetB(abgr) (((abgr) >> 16) & 0xff) -<br> -#define TIFFGetA(abgr) (((abgr) >> 24) & -0xff)</b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFReadRGBAStrip(TIFF *</b><i>tif</i><b>, uint32_t</b> -<i>row</i><b>, uint32_t *</b><i>raster</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFReadRGBAStrip</i></b> -reads a single strip of a strip-based image into memory, -storing the result in the user supplied RGBA <i>raster</i>. -The raster is assumed to be an array of width times -rowsperstrip 32-bit entries, where width is the width of the -image (TIFFTAG_IMAGEWIDTH) and rowsperstrip is the maximum -lines in a strip (TIFFTAG_ROWSPERSTRIP).</p> - -<p style="margin-left:11%; margin-top: 1em">The <i>row</i> -value should be the row of the first row in the strip (strip -* rowsperstrip, zero based).</p> - -<p style="margin-left:11%; margin-top: 1em">Note that the -raster is assume to be organized such that the pixel at -location (<i>x</i>,<i>y</i>) is -<i>raster</i>[<i>y</i>*<i>width</i>+<i>x</i>]; with the -raster origin in the <i>lower-left hand corner</i> of the -strip. That is bottom to top organization. When reading a -partial last strip in the file the last line of the image -will begin at the beginning of the buffer.</p> - -<p style="margin-left:11%; margin-top: 1em">Raster pixels -are 8-bit packed red, green, blue, alpha samples. The macros -<i>TIFFGetR</i>, <i>TIFFGetG</i>, <i>TIFFGetB</i>, and -<i>TIFFGetA</i> should be used to access individual samples. -Images without Associated Alpha matting information have a -constant Alpha of 1.0 (255).</p> - -<p style="margin-left:11%; margin-top: 1em">See the -<i>TIFFRGBAImage</i>(3TIFF) page for more details on how -various image types are converted to RGBA values.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Samples must be -either 1, 2, 4, 8, or 16 bits. Colorimetric samples/pixel -must be either 1, 3, or 4 (i.e. <i>SamplesPerPixel</i> minus -<i>ExtraSamples</i>).</p> - -<p style="margin-left:11%; margin-top: 1em">Palette image -colormaps that appear to be incorrectly written as 8-bit -values are automatically scaled to 16-bits.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFReadRGBAStrip</i> -is just a wrapper around the more general -<i>TIFFRGBAImage</i>(3TIFF) facilities. It’s main -advantage over the similar <i>TIFFReadRGBAImage()</i> -function is that for large images a single buffer capable of -holding the whole image doesn’t need to be allocated, -only enough for one strip. The <i>TIFFReadRGBATile()</i> -function does a similar operation for tiled images.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">1 is returned -if the image was successfully read and converted. Otherwise, -0 is returned if an error was encountered.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <i>TIFFError</i>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Sorry, can -not handle %d-bit pictures</b>. The image had -<i>BitsPerSample</i> other than 1, 2, 4, 8, or 16.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Sorry, can -not handle %d-channel images</b>. The image had -<i>SamplesPerPixel</i> other than 1, 3, or 4.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Missing -needed "PhotometricInterpretation" tag</b>. The -image did not have a tag that describes how to display the -data.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No -"PhotometricInterpretation" tag, assuming RGB</b>. -The image was missing a tag that describes how to display -it, but because it has 3 or 4 samples/pixel, it is assumed -to be <small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>No -"PhotometricInterpretation" tag, assuming -min-is-black</b>. The image was missing a tag that describes -how to display it, but because it has 1 sample/pixel, it is -assumed to be a grayscale or bilevel image.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -photometric conversion table</b>. There was insufficient -memory for a table used to convert image samples to 8-bit -<small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>Missing -required "Colormap" tag</b>. A Palette image did -not have a required <i>Colormap</i> tag.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -tile buffer</b>. There was insufficient memory to allocate -an i/o buffer.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -strip buffer</b>. There was insufficient memory to allocate -an i/o buffer.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Can not -handle format</b>. The image has a format (combination of -<i>BitsPerSample</i>, <i>SamplesPerPixel</i>, and -<i>PhotometricInterpretation</i>) that -<i>TIFFReadRGBAImage</i> can not handle.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -B&W mapping table</b>. There was insufficient memory to -allocate a table used to map grayscale data to -<small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -Palette mapping table</b>. There was insufficient memory to -allocate a table used to map data to 8-bit -<small>RGB.</small></p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFRGBAImage</b>(3TIFF), -<b>TIFFReadRGBAImage</b>(3TIFF), -<b>TIFFReadRGBATile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFReadRGBATile.3tiff.html b/doc/static/man/TIFFReadRGBATile.3tiff.html deleted file mode 100644 index b5b7f43a..00000000 --- a/doc/static/man/TIFFReadRGBATile.3tiff.html +++ /dev/null @@ -1,263 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFReadRGBATile</title> - -</head> -<body> - -<h1 align="center">TIFFReadRGBATile</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFReadRGBATile -− read and decode an image tile into a fixed-format -raster</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="-3%"> - - -<p><b>#define TIFFGetR(abgr)</b></p></td> -<td width="30%"></td> -<td width="8%"></td> -<td width="54%"> - - -<p><b>((abgr) & 0xff)</b></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="-3%"> - - -<p><b>#define TIFFGetG(abgr)</b></p></td> -<td width="30%"></td> -<td width="8%"></td> -<td width="54%"> - - -<p><b>(((abgr) >> 8) & 0xff)</b></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="-3%"> - - -<p><b>#define TIFFGetB(abgr)</b></p></td> -<td width="30%"></td> -<td width="8%"></td> -<td width="54%"> - - -<p><b>(((abgr) >> 16) & 0xff)</b></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="-3%"> - - -<p><b>#define TIFFGetA(abgr)</b></p></td> -<td width="30%"></td> -<td width="8%"></td> -<td width="54%"> - - -<p><b>(((abgr) >> 24) & 0xff)</b></p></td></tr> -</table> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFReadRGBATile(TIFF *</b><i>tif</i><b>, uint32_t</b> -<i>x</i><b>, uint32_t</b> <i>y</i><b>, uint32_t -*</b><i>raster</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFReadRGBATile</i></b> -reads a single tile of a tile-based image into memory, -storing the result in the user supplied RGBA <i>raster</i>. -The raster is assumed to be an array of width times length -32-bit entries, where width is the width of a tile -(TIFFTAG_TILEWIDTH) and length is the height of a tile -(TIFFTAG_TILELENGTH).</p> - -<p style="margin-left:11%; margin-top: 1em">The <i>x</i> -and <i>y</i> values are the offsets from the top left corner -to the top left corner of the tile to be read. They must be -an exact multiple of the tile width and length.</p> - -<p style="margin-left:11%; margin-top: 1em">Note that the -raster is assume to be organized such that the pixel at -location (<i>x</i>,<i>y</i>) is -<i>raster</i>[<i>y</i>*<i>width</i>+<i>x</i>]; with the -raster origin in the <i>lower-left hand corner</i> of the -tile. That is bottom to top organization. Edge tiles which -partly fall off the image will be filled out with -appropriate zeroed areas.</p> - -<p style="margin-left:11%; margin-top: 1em">Raster pixels -are 8-bit packed red, green, blue, alpha samples. The macros -<i>TIFFGetR</i>, <i>TIFFGetG</i>, <i>TIFFGetB</i>, and -<i>TIFFGetA</i> should be used to access individual samples. -Images without Associated Alpha matting information have a -constant Alpha of 1.0 (255).</p> - -<p style="margin-left:11%; margin-top: 1em">See the -<i>TIFFRGBAImage</i>(3TIFF) page for more details on how -various image types are converted to RGBA values.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Samples must be -either 1, 2, 4, 8, or 16 bits. Colorimetric samples/pixel -must be either 1, 3, or 4 (i.e. <i>SamplesPerPixel</i> minus -<i>ExtraSamples</i>).</p> - -<p style="margin-left:11%; margin-top: 1em">Palette image -colormaps that appear to be incorrectly written as 8-bit -values are automatically scaled to 16-bits.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFReadRGBATile</i> -is just a wrapper around the more general -<i>TIFFRGBAImage</i>(3TIFF) facilities. It’s main -advantage over the similar <i>TIFFReadRGBAImage()</i> -function is that for large images a single buffer capable of -holding the whole image doesn’t need to be allocated, -only enough for one tile. The <i>TIFFReadRGBAStrip()</i> -function does a similar operation for stripped images.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">1 is returned -if the image was successfully read and converted. Otherwise, -0 is returned if an error was encountered.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <i>TIFFError</i>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Sorry, can -not handle %d-bit pictures</b>. The image had -<i>BitsPerSample</i> other than 1, 2, 4, 8, or 16.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Sorry, can -not handle %d-channel images</b>. The image had -<i>SamplesPerPixel</i> other than 1, 3, or 4.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Missing -needed "PhotometricInterpretation" tag</b>. The -image did not have a tag that describes how to display the -data.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No -"PhotometricInterpretation" tag, assuming RGB</b>. -The image was missing a tag that describes how to display -it, but because it has 3 or 4 samples/pixel, it is assumed -to be <small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>No -"PhotometricInterpretation" tag, assuming -min-is-black</b>. The image was missing a tag that describes -how to display it, but because it has 1 sample/pixel, it is -assumed to be a grayscale or bilevel image.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -photometric conversion table</b>. There was insufficient -memory for a table used to convert image samples to 8-bit -<small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>Missing -required "Colormap" tag</b>. A Palette image did -not have a required <i>Colormap</i> tag.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -tile buffer</b>. There was insufficient memory to allocate -an i/o buffer.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -strip buffer</b>. There was insufficient memory to allocate -an i/o buffer.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Can not -handle format</b>. The image has a format (combination of -<i>BitsPerSample</i>, <i>SamplesPerPixel</i>, and -<i>PhotometricInterpretation</i>) that -<i>TIFFReadRGBAImage</i> can not handle.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -B&W mapping table</b>. There was insufficient memory to -allocate a table used to map grayscale data to -<small>RGB.</small></p> - -<p style="margin-left:11%; margin-top: 1em"><b>No space for -Palette mapping table</b>. There was insufficient memory to -allocate a table used to map data to 8-bit -<small>RGB.</small></p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFRGBAImage</b>(3TIFF), -<b>TIFFReadRGBAImage</b>(3TIFF), -<b>TIFFReadRGBAStrip</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFReadRawStrip.3tiff.html b/doc/static/man/TIFFReadRawStrip.3tiff.html deleted file mode 100644 index 1c814ee6..00000000 --- a/doc/static/man/TIFFReadRawStrip.3tiff.html +++ /dev/null @@ -1,105 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFReadRawStrip</title> - -</head> -<body> - -<h1 align="center">TIFFReadRawStrip</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFReadRawStrip -− return the undecoded contents of a strip of data -from an open <small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>tsize_t -TIFFReadRawStrip(TIFF *</b><i>tif</i><b>, tstrip_t</b> -<i>strip</i><b>, tdata_t</b> <i>buf</i><b>, tsize_t</b> -<i>size</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Read the -contents of the specified strip into the (user supplied) -data buffer. Note that the value of <i>strip</i> is a -‘‘raw strip number.’’ That is, the -caller must take into account whether or not the data is -organized in separate planes (<i>PlanarConfiguration</i>=2). -To read a full strip of data the data buffer should -typically be at least as large as the number returned by -<i>TIFFStripSize</i>.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The actual -number of bytes of data that were placed in <i>buf</i> is -returned; <i>TIFFReadRawStrip</i> returns −1 if an -error was encountered.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFReadEncodedStrip</b>(3TIFF), -<b>TIFFReadScanline</b>(3TIFF), <b>TIFFStripSize</b>(3TIFF), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFReadRawTile.3tiff.html b/doc/static/man/TIFFReadRawTile.3tiff.html deleted file mode 100644 index 92aa3482..00000000 --- a/doc/static/man/TIFFReadRawTile.3tiff.html +++ /dev/null @@ -1,107 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFReadRawTile</title> - -</head> -<body> - -<h1 align="center">TIFFReadRawTile</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFReadRawTile -− return an undecoded tile of data from an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>tsize_t -TIFFReadRawTile(TIFF *</b><i>tif</i><b>, ttile_t</b> -<i>tile</i><b>, tdata_t</b> <i>buf</i><b>, tsize_t</b> -<i>size</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Read the -contents of the specified tile into the (user supplied) data -buffer. Note that the value of <i>tile</i> is a -‘‘raw tile number.’’ That is, the -caller must take into account whether or not the data is -organized in separate planes (<i>PlanarConfiguration</i>=2). -<i>TIFFComputeTile</i> automatically does this when -converting an (x,y,z,sample) coordinate quadruple to a tile -number. To read a full tile of data the data buffer should -typically be at least as large as the value returned by -<i>TIFFTileSize</i>.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The actual -number of bytes of data that were placed in <i>buf</i> is -returned; <i>TIFFReadEncodedTile</i> returns −1 if an -error was encountered.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFReadEncodedTile</b>(3TIFF), -<b>TIFFReadTile</b>(3TIFF), <b>TIFFTileSize</b>(3TIFF), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFReadScanline.3tiff.html b/doc/static/man/TIFFReadScanline.3tiff.html deleted file mode 100644 index e84a6f45..00000000 --- a/doc/static/man/TIFFReadScanline.3tiff.html +++ /dev/null @@ -1,149 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFReadScanline</title> - -</head> -<body> - -<h1 align="center">TIFFReadScanline</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#BUGS">BUGS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFReadScanline -− read and decode a scanline of data from an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFReadScanline(TIFF *</b><i>tif</i><b>, tdata_t</b> -<i>buf</i><b>, uint32_t</b> <i>row</i><b>, tsample_t</b> -<i>sample</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Read the data -for the specified row into the (user supplied) data buffer -<i>buf</i>. The data are returned decompressed and, in the -native byte- and bit-ordering, but are otherwise packed (see -further below). The buffer must be large enough to hold an -entire scanline of data. Applications should call the -routine <i>TIFFScanlineSize</i> to find out the size (in -bytes) of a scanline buffer. The <i>row</i> parameter is -always used by <i>TIFFReadScanline</i>; the <i>sample</i> -parameter is used only if data are organized in separate -planes (<i>PlanarConfiguration</i>=2).</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The library -attempts to hide bit- and byte-ordering differences between -the image and the native machine by converting data to the -native machine order. Bit reversal is done if the -<i>FillOrder</i> tag is opposite to the native machine bit -order. 16- and 32-bit samples are automatically byte-swapped -if the file was written with a byte order opposite to the -native machine byte order,</p> - -<p style="margin-left:11%; margin-top: 1em">In C++ the -<i>sample</i> parameter defaults to 0.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFReadScanline</i> -returns −1 if it detects an error; otherwise 1 is -returned.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <i>TIFFError</i>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Compression -algorithm does not support random access</b>. Data was -requested in a non-sequential order from a file that uses a -compression algorithm and that has <i>RowsPerStrip</i> -greater than one. That is, data in the image is stored in a -compressed form, and with multiple rows packed into a strip. -In this case, the library does not support random access to -the data. The data should either be accessed sequentially, -or the file should be converted so that each strip is made -up of one row of data.</p> - -<h2>BUGS -<a name="BUGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Reading -subsampled YCbCR data does not work correctly because, for -<i>PlanarConfiguration</i>=2 the size of a scanline is not -calculated on a per-sample basis, and for -<i>PlanarConfiguration</i>=1 the library does not unpack the -block-interleaved samples; use the strip- and tile-based -interfaces to read these formats.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFReadEncodedStrip</b>(3TIFF), -<b>TIFFReadRawStrip</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFReadTile.3tiff.html b/doc/static/man/TIFFReadTile.3tiff.html deleted file mode 100644 index e38cb295..00000000 --- a/doc/static/man/TIFFReadTile.3tiff.html +++ /dev/null @@ -1,124 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFReadTile</title> - -</head> -<body> - -<h1 align="center">TIFFReadTile</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFReadTile -− read and decode a tile of data from an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>tsize_t -TIFFReadTile(TIFF *</b><i>tif</i><b>, tdata_t</b> -<i>buf</i><b>, uint32_t</b> <i>x</i><b>, uint32_t</b> -<i>y</i><b>, uint32_t</b> <i>z</i><b>, tsample_t</b> -<i>sample</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Return the data -for the tile <i>containing</i> the specified coordinates. -The data placed in <i>buf</i> are returned decompressed and, -typically, in the native byte- and bit-ordering, but are -otherwise packed (see further below). The buffer must be -large enough to hold an entire tile of data. Applications -should call the routine <i>TIFFTileSize</i> to find out the -size (in bytes) of a tile buffer. The <i>x</i> and <i>y</i> -parameters are always used by <i>TIFFReadTile</i>. The -<i>z</i> parameter is used if the image is deeper than 1 -slice (<i>ImageDepth</i>>1). The <i>sample</i> parameter -is used only if data are organized in separate planes -(<i>PlanarConfiguration</i>=2).</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The library -attempts to hide bit- and byte-ordering differences between -the image and the native machine by converting data to the -native machine order. Bit reversal is done if the -<i>FillOrder</i> tag is opposite to the native machine bit -order. 16- and 32-bit samples are automatically byte-swapped -if the file was written with a byte order opposite to the -native machine byte order,</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFReadTile</i> -returns −1 if it detects an error; otherwise the -number of bytes in the decoded tile is returned.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFCheckTile</b>(3TIFF), -<b>TIFFComputeTile</b>(3TIFF), <b>TIFFOpen</b>(3TIFF), -<b>TIFFReadEncodedTile</b>(3TIFF), -<b>TIFFReadRawTile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFSetDirectory.3tiff.html b/doc/static/man/TIFFSetDirectory.3tiff.html deleted file mode 100644 index d0dacac3..00000000 --- a/doc/static/man/TIFFSetDirectory.3tiff.html +++ /dev/null @@ -1,120 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFSetDirectory</title> - -</head> -<body> - -<h1 align="center">TIFFSetDirectory</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFSetDirectory, -TIFFSetSubDirectory − set the current directory for an -open <small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFSetDirectory(TIFF *</b><i>tif</i><b>, tdir_t</b> -<i>dirnum</i><b>) <br> -int TIFFSetSubDirectory(TIFF *</b><i>tif</i><b>, -uint64_t</b> <i>diroff</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFSetDirectory</i></b> -changes the current directory and reads its contents with -<i>TIFFReadDirectory</i>. The parameter <i>dirnum</i> -specifies the subfile/directory as an integer number, with -the first directory numbered zero.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFSetSubDirectory</i> -acts like <i>TIFFSetDirectory</i>, except the directory is -specified as a file offset instead of an index; this is -required for accessing subdirectories linked through a -<i>SubIFD</i> tag.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">On successful -return 1 is returned. Otherwise, 0 is returned if -<i>dirnum</i> or <i>diroff</i> specifies a non-existent -directory, or if an error was encountered while reading the -directory’s contents.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <i>TIFFError</i>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Error -fetching directory count</b>. An error was encountered while -reading the ‘‘directory count’’ -field.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Error -fetching directory link</b>. An error was encountered while -reading the ‘‘link value’’ that -points to the next directory in a file.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFCurrentDirectory</i>(3TIFF), -<i>TIFFOpen</i>(3TIFF), <i>TIFFReadDirectory</i>(3TIFF), -<i>TIFFWriteDirectory</i>(3TIFF), <i>libtiff</i>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFSetField.3tiff.html b/doc/static/man/TIFFSetField.3tiff.html deleted file mode 100644 index b7f05f9e..00000000 --- a/doc/static/man/TIFFSetField.3tiff.html +++ /dev/null @@ -1,1865 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFSetField</title> - -</head> -<body> - -<h1 align="center">TIFFSetField</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFSetField, -TIFFVSetField − set the value(s) of a tag in a -<small>TIFF</small> file open for writing</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFSetField(TIFF *</b><i>tif</i><b>, ttag_t</b> -<i>tag</i><b>,</b> <i>...</i><b>)</b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<stdarg.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFVSetField(TIFF *</b><i>tif</i><b>, ttag_t</b> -<i>tag</i><b>, va_list</b> <i>ap</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFSetField</i></b> -sets the value of a field or pseudo-tag in the current -directory associated with the open <small>TIFF</small> file -<i>tif</i>. (A <i>pseudo-tag</i> is a parameter that is used -to control the operation of the <small>TIFF</small> library -but whose value is not read or written to the underlying -file.) To set the value of a field the file must have been -previously opened for writing with <i>TIFFOpen</i>(3TIFF); -pseudo-tags can be set whether the file was opened for -reading or writing. The field is identified by <i>tag</i>, -one of the values defined in the include file <b>tiff.h</b> -(see also the table below). The actual value is specified -using a variable argument list, as prescribed by the -<i>stdarg</i>(3) interface (or, on some machines, the -<i>varargs</i>(3) interface.)</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFVSetField</i> -is functionally equivalent to <i>TIFFSetField</i> except -that it takes a pointer to a variable argument list. -<i>TIFFVSetField</i> is useful for writing routines that are -layered on top of the functionality provided by -<i>TIFFSetField</i>.</p> - -<p style="margin-left:11%; margin-top: 1em">The tags -understood by <i>libtiff</i>, the number of parameter -values, and the expected types for the parameter values are -shown below. The data types are: <i>char*</i> is -null-terminated string and corresponds to the -<small>ASCII</small> data type; <i>uint16_t</i> is an -unsigned 16-bit value; <i>uint32_t</i> is an unsigned 32-bit -value; <i>uint16_t*</i> is an array of unsigned 16-bit -values. <i>void*</i> is an array of data values of -unspecified type.</p> - -<p style="margin-left:11%; margin-top: 1em">Consult the -<small>TIFF</small> specification for information on the -meaning of each tag.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p><i>Tag Name</i></p></td> -<td width="11%"></td> -<td width="29%"> - - -<p><i>Count</i></p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p><i>Types</i></p></td> -<td width="11%"> - - -<p><i>Notes</i></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_ARTIST</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_BADFAXLINES</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_BITSPERSAMPLE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_CLEANFAXDATA</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_COLORMAP</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>3</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t*</p></td> -<td width="11%"> - - -<p>1<<BitsPerSample arrays</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_COMPRESSION</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_CONSECUTIVEBADFAXLINES</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_COPYRIGHT</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_DATETIME</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_DOCUMENTNAME</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_DOTRANGE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>2</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_EXTRASAMPLES</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>2</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t,uint16_t*</p></td> -<td width="11%"> - - -<p>† count & types array</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_FAXFILLFUNC</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>TIFFFaxFillFunc</p></td> -<td width="11%"> - - -<p>G3/G4 compression pseudo-tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_FAXMODE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>int</p></td> -<td width="11%"> - - -<p>† G3/G4 compression pseudo-tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_FILLORDER</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_GROUP3OPTIONS</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_GROUP4OPTIONS</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_HALFTONEHINTS</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>2</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_HOSTCOMPUTER</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_ICCPROFILE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>2</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t,void*</p></td> -<td width="11%"> - - -<p>count, profile data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_IMAGEDEPTH</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_IMAGEDESCRIPTION</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_IMAGELENGTH</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_IMAGEWIDTH</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_INKNAMES</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>2</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t, char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_INKSET</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_JPEGCOLORMODE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>int</p></td> -<td width="11%"> - - -<p>† JPEG pseudo-tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_JPEGQUALITY</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>int</p></td> -<td width="11%"> - - -<p>JPEG pseudo-tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_JPEGTABLES</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>2</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t*,void*</p></td> -<td width="11%"> - - -<p>† count & tables</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_JPEGTABLESMODE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>int</p></td> -<td width="11%"> - - -<p>† JPEG pseudo-tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_MAKE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_MATTEING</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_MAXSAMPLEVALUE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_MINSAMPLEVALUE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_MODEL</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_ORIENTATION</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PAGENAME</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PAGENUMBER</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>2</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PHOTOMETRIC</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PHOTOSHOP</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>?</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t,void*</p></td> -<td width="11%"> - - -<p>count, data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PLANARCONFIG</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PREDICTOR</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_PRIMARYCHROMATICITIES</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>float*</p></td> -<td width="11%"> - - -<p>6-entry array</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_REFERENCEBLACKWHITE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>float*</p></td> -<td width="11%"> - - -<p>† 6-entry array</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_RESOLUTIONUNIT</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_RICHTIFFIPTC</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>2</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t,void*</p></td> -<td width="11%"> - - -<p>count, data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_ROWSPERSTRIP</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> - - -<p>† must be > 0</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SAMPLEFORMAT</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SAMPLESPERPIXEL</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> - - -<p>† value must be <= 4</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SMAXSAMPLEVALUE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>double</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SMINSAMPLEVALUE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>double</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SOFTWARE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_STONITS</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>double</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SUBFILETYPE</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_SUBIFD</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>2</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t,uint64_t*</p></td> -<td width="11%"> - - -<p>count & offsets array</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TARGETPRINTER</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>char*</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_THRESHHOLDING</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TILEDEPTH</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TILELENGTH</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> - - -<p>† must be a multiple of 8</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TILEWIDTH</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t</p></td> -<td width="11%"> - - -<p>† must be a multiple of 8</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_TRANSFERFUNCTION</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1 or 3‡ uint16_t*</p></td> -<td width="11%"> - - -<p>1<<BitsPerSample entry arrays</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_WHITEPOINT</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>float*</p></td> -<td width="11%"> - - -<p>2-entry array</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_XMLPACKET</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>2</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint32_t,void*</p></td> -<td width="11%"> - - -<p>count, data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_XPOSITION</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>float</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_XRESOLUTION</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>float</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_YCBCRCOEFFICIENTS</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>float*</p></td> -<td width="11%"> - - -<p>† 3-entry array</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_YCBCRPOSITIONING</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_YCBCRSAMPLING</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>2</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>uint16_t</p></td> -<td width="11%"> - - -<p>†</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_YPOSITION</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>float</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"> - - -<p>TIFFTAG_YRESOLUTION</p></td> -<td width="11%"></td> -<td width="29%"> - - -<p>1</p></td> -<td width="11%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="38%"></td> -<td width="11%"></td> -<td width="29%"> - - -<p>float</p></td> -<td width="11%"> -</td></tr> -</table> - -<p style="margin-left:11%;">† Tag may not have its -values changed once data is written. <br> -‡ If <i>SamplesPerPixel</i> is one, then a single -array is passed; otherwise three arrays should be passed. -<br> -* The contents of this field are quite complex. See <b>The -ICC Profile Format Specification</b>, Annex B.3 -"Embedding ICC Profiles in TIFF Files" (available -at http://www.color.org) for an explanation.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">1 is returned -if the operation was successful. Otherwise, 0 is returned if -an error was detected.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Cannot -modify tag "%s" while writing</b>. Data has -already been written to the file, so the specified -tag’s value can not be changed. This restriction is -applied to all tags that affect the format of written -data.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%d: Bad -value for "%s"</b>. An invalid value was supplied -for the named tag.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFGetField</b>(3TIFF), <b>TIFFSetDirectory</b>(3TIFF), -<b>TIFFWriteDirectory</b>(3TIFF), -<b>TIFFReadDirectory</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFWarning.3tiff.html b/doc/static/man/TIFFWarning.3tiff.html deleted file mode 100644 index 04e7eae4..00000000 --- a/doc/static/man/TIFFWarning.3tiff.html +++ /dev/null @@ -1,111 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFWarning</title> - -</head> -<body> - -<h1 align="center">TIFFWarning</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFWarning, -TIFFSetWarningHandler − library warning interface</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>void -TIFFWarning(const char *</b><i>module</i><b>, const char -*</b><i>fmt</i><b>,</b> <i>...</i><b>)</b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<stdarg.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>typedef void -(*TIFFWarningHandler)(const char *</b><i>module</i><b>, -const char *</b><i>fmt</i><b>, va_list</b> -<i>ap</i><b>);</b></p> - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFWarningHandler -TIFFSetWarningHandler(TIFFWarningHandler</b> -<i>handler</i><b>);</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFWarning</i></b> -invokes the library-wide warning handler function to -(normally) write a warning message to the <b>stderr</b>. The -<i>fmt</i> parameter is a <i>printf</i>(3S) format string, -and any number arguments can be supplied. The <i>module</i> -parameter is interpreted as a string that, if non-zero, -should be printed before the message; it typically is used -to identify the software module in which a warning is -detected.</p> - -<p style="margin-left:11%; margin-top: 1em">Applications -that desire to capture control in the event of a warning -should use <i>TIFFSetWarningHandler</i> to override the -default warning handler. A <small>NULL</small> (0) warning -handler function may be installed to suppress error -messages.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFSetWarningHandler</i> -returns a reference to the previous error handling -function.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFError</b>(3TIFF), -<b>libtiff</b>(3TIFF), <b>printf</b>(3)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFWriteDirectory.3tiff.html b/doc/static/man/TIFFWriteDirectory.3tiff.html deleted file mode 100644 index 0cec618b..00000000 --- a/doc/static/man/TIFFWriteDirectory.3tiff.html +++ /dev/null @@ -1,184 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFWriteDirectory</title> - -</head> -<body> - -<h1 align="center">TIFFWriteDirectory</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFWriteDirectory, -TIFFRewriteDirectory, TIFFCheckpointDirectory − write -the current directory in an open <small>TIFF</small> -file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFWriteDirectory(TIFF *</b><i>tif</i><b>) <br> -int TIFFRewriteDirectory(TIFF *</b><i>tif</i><b>) <br> -int TIFFCheckpointDirectory(TIFF *</b><i>tif</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFWriteDirectory</i></b> -will write the contents of the current directory to the file -and setup to create a new subfile in the same file. -Applications only need to call <i>TIFFWriteDirectory</i> -when writing multiple subfiles to a single -<small>TIFF</small> file. <i>TIFFWriteDirectory</i> is -automatically called by <i>TIFFClose</i> and -<i>TIFFFlush</i> to write a modified directory if the file -is open for writing.</p> - -<p style="margin-left:11%; margin-top: 1em">The -<i>TIFFRewriteDirectory</i> function operates similarly to -<i>TIFFWriteDirectory,</i> but can be called with -directories previously read or written that already have an -established location in the file. It will rewrite the -directory, but instead of place it at it’s old -location (as <i>TIFFWriteDirectory</i> would) it will place -them at the end of the file, correcting the pointer from the -preceding directory or file header to point to it’s -new location. This is particularly important in cases where -the size of the directory and pointed to data has grown, so -it won’t fit in the space available at the old -location.</p> - -<p style="margin-left:11%; margin-top: 1em">The -<i>TIFFCheckpointDirectory</i> writes the current state of -the tiff directory into the file to make what is currently -in the file readable. Unlike <i>TIFFWriteDirectory, -TIFFCheckpointDirectory</i> does not free up the directory -data structures in memory, so they can be updated (as -strips/tiles are written) and written again. Reading such a -partial file you will at worst get a tiff read error for the -first strip/tile encountered that is incomplete, but you -will at least get all the valid data in the file before -that. When the file is complete, just use -<i>TIFFWriteDirectory</i> as usual to finish it off -cleanly.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">1 is returned -when the contents are successfully written to the file. -Otherwise, 0 is returned if an error was encountered when -writing the directory contents.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <i>TIFFError</i>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Error -post-encoding before directory write</b>. Before writing the -contents of the current directory, any pending data are -flushed. This message indicates that an error occurred while -doing this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Error -flushing data before directory write</b>. Before writing the -contents of the current directory, any pending data are -flushed. This message indicates that an error occurred while -doing this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Cannot write -directory, out of space</b>. There was not enough space to -allocate a temporary area for the directory that was to be -written.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Error -writing directory count</b>. A write error occurred when -writing the count of fields in the directory.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Error -writing directory contents</b>. A write error occurred when -writing the directory fields.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Error -writing directory link</b>. A write error occurred when -writing the link to the next directory.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Error -writing data for field "%s"</b>. A write error -occurred when writing indirect data for the specified -field.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Error -writing TIFF header</b>. A write error occurred when -re-writing header at the front of the file.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Error -fetching directory count</b>. A read error occurred when -fetching the directory count field for a previous directory. -This can occur when setting up a link to the directory that -is being written.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Error -fetching directory link</b>. A read error occurred when -fetching the directory link field for a previous directory. -This can occur when setting up a link to the directory that -is being written.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFError</b>(3TIFF), <b>TIFFReadDirectory</b>(3TIFF), -<b>TIFFSetDirectory</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFWriteEncodedStrip.3tiff.html b/doc/static/man/TIFFWriteEncodedStrip.3tiff.html deleted file mode 100644 index 12dc8e93..00000000 --- a/doc/static/man/TIFFWriteEncodedStrip.3tiff.html +++ /dev/null @@ -1,147 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFWriteEncodedStrip</title> - -</head> -<body> - -<h1 align="center">TIFFWriteEncodedStrip</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFWritedEncodedStrip -− compress and write a strip of data to an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>tsize_t -TIFFWriteEncodedStrip(TIFF *</b><i>tif</i><b>, tstrip_t</b> -<i>strip</i><b>, tdata_t</b> <i>buf</i><b>, tsize_t</b> -<i>size</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Compress -<i>size</i> bytes of raw data from <i>buf</i> and write the -result to the specified strip; replacing any previously -written data. Note that the value of <i>strip</i> is a -‘‘raw strip number.’’ That is, the -caller must take into account whether or not the data are -organized in separate planes -(<i>PlanarConfiguration</i>=2).</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The library -writes encoded data using the native machine byte order. -Correctly implemented <small>TIFF</small> readers are -expected to do any necessary byte-swapping to correctly -process image data with BitsPerSample greater than 8.</p> - -<p style="margin-left:11%; margin-top: 1em">The strip -number must be valid according to the current settings of -the <i>ImageLength</i> and <i>RowsPerStrip</i> tags. An -image may be dynamically grown by increasing the value of -<i>ImageLength</i> prior to each call to -<i>TIFFWriteEncodedStrip</i>.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">−1 is -returned if an error was encountered. Otherwise, the value -of <i>size</i> is returned.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <i>TIFFError</i>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: File not -open for writing</b>. The file was opened for reading, not -writing.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Can not -write scanlines to a tiled image</b>. The image is assumed -to be organized in tiles because the <i>TileWidth</i> and -<i>TileLength</i> tags have been set with -<i>TIFFSetField</i>(3TIFF).</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set -"ImageWidth" before writing data</b>. The -image’s width has not be set before the first write. -See <i>TIFFSetField</i>(3TIFF) for information on how to do -this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set -"PlanarConfiguration" before writing data</b>. The -organization of data has not be defined before the first -write. See <i>TIFFSetField</i>(3TIFF) for information on how -to do this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: No space -for strip arrays"</b>. There was not enough space for -the arrays that hold strip offsets and byte counts.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFWriteScanline</b>(3TIFF), -<b>TIFFWriteRawStrip</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFWriteEncodedTile.3tiff.html b/doc/static/man/TIFFWriteEncodedTile.3tiff.html deleted file mode 100644 index 5e4ef717..00000000 --- a/doc/static/man/TIFFWriteEncodedTile.3tiff.html +++ /dev/null @@ -1,142 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFWriteEncodedTile</title> - -</head> -<body> - -<h1 align="center">TIFFWriteEncodedTile</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFWritedEncodedTile -− compress and write a tile of data to an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>tsize_t -TIFFWriteEncodedTile(TIFF *</b><i>tif</i><b>, ttile_t</b> -<i>tile</i><b>, tdata_t</b> <i>buf</i><b>, tsize_t</b> -<i>size</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Compress -<i>size</i> bytes of raw data from <i>buf</i> and -<b>append</b> the result to the end of the specified tile. -Note that the value of <i>tile</i> is a ‘‘raw -tile number.’’ That is, the caller must take -into account whether or not the data are organized in -separate places (<i>PlanarConfiguration</i>=2). -<i>TIFFComputeTile</i> automatically does this when -converting an (x,y,z,sample) coordinate quadruple to a tile -number.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The library -writes encoded data using the native machine byte order. -Correctly implemented <small>TIFF</small> readers are -expected to do any necessary byte-swapping to correctly -process image data with BitsPerSample greater than 8.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">−1 is -returned if an error was encountered. Otherwise, the value -of <i>size</i> is returned.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: File not -open for writing</b>. The file was opened for reading, not -writing.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Can not -write tiles to a stripped image</b>. The image is assumed to -be organized in strips because neither of the -<i>TileWidth</i> or <i>TileLength</i> tags have been set -with <b>TIFFSetField</b>(3TIFF).</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set -"ImageWidth" before writing data</b>. The -image’s width has not be set before the first write. -See <b>TIFFSetField</b>(3TIFF) for information on how to do -this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set -"PlanarConfiguration" before writing data</b>. The -organization of data has not be defined before the first -write. See <b>TIFFSetField</b>(3TIFF) for information on how -to do this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: No space -for tile arrays"</b>. There was not enough space for -the arrays that hold tile offsets and byte counts.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFWriteTile</b>(3TIFF), <b>TIFFWriteRawTile</b>(3TIFF), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFWriteRawStrip.3tiff.html b/doc/static/man/TIFFWriteRawStrip.3tiff.html deleted file mode 100644 index 32a6b01f..00000000 --- a/doc/static/man/TIFFWriteRawStrip.3tiff.html +++ /dev/null @@ -1,140 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFWriteRawstrip</title> - -</head> -<body> - -<h1 align="center">TIFFWriteRawstrip</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFWriteRawStrip -− write a strip of raw data to an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>tsize_t -TIFFWriteRawStrip(TIFF *</b><i>tif</i><b>, tstrip_t</b> -<i>strip</i><b>, tdata_t</b> <i>buf</i><b>, tsize_t</b> -<i>size</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Append -<i>size</i> bytes of raw data to the specified strip.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The strip -number must be valid according to the current settings of -the <i>ImageLength</i> and <i>RowsPerStrip</i> tags. An -image may be dynamically grown by increasing the value of -<i>ImageLength</i> prior to each call to -<i>TIFFWriteRawStrip</i>.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">−1 is -returned if an error occurred. Otherwise, the value of -<i>size</i> is returned.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: File not -open for writing</b>. The file was opened for reading, not -writing.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Can not -write scanlines to a tiled image</b>. The image is assumed -to be organized in tiles because the <i>TileWidth</i> and -<i>TileLength</i> tags have been set with -<b>TIFFSetField</b>(3TIFF).</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set -"ImageWidth" before writing data</b>. The -image’s width has not be set before the first write. -See <b>TIFFSetField</b>(3TIFF) for information on how to do -this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set -"PlanarConfiguration" before writing data</b>. The -organization of data has not be defined before the first -write. See <b>TIFFSetField</b>(3TIFF) for information on how -to do this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: No space -for strip arrays"</b>. There was not enough space for -the arrays that hold strip offsets and byte counts.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Strip %d -out of range, max %d</b>. The specified strip is not a valid -strip according to the currently specified image -dimensions.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFWriteEncodedStrip</b>(3TIFF), -<b>TIFFWriteScanline</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFWriteRawTile.3tiff.html b/doc/static/man/TIFFWriteRawTile.3tiff.html deleted file mode 100644 index 6debfa15..00000000 --- a/doc/static/man/TIFFWriteRawTile.3tiff.html +++ /dev/null @@ -1,127 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFWriteRawtile</title> - -</head> -<body> - -<h1 align="center">TIFFWriteRawtile</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFWriteRawTile -− write a tile of raw data to an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>tsize_t -TIFFWriteRawTile(TIFF *</b><i>tif</i><b>, ttile_t</b> -<i>tile</i><b>, tdata_t</b> <i>buf</i><b>, tsize_t</b> -<i>size</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Append -<i>size</i> bytes of raw data to the specified tile.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">−1 is -returned if an error occurred. Otherwise, the value of -<i>size</i> is returned.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: File not -open for writing</b>. The file was opened for reading, not -writing.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Can not -write tiles to a stripped image</b>. The image is assumed to -be organized in strips because neither of the -<i>TileWidth</i> or <i>TileLength</i> tags have been set -with <b>TIFFSetField</b>(3TIFF).</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set -"ImageWidth" before writing data</b>. The -image’s width has not be set before the first write. -See <b>TIFFSetField</b>(3TIFF) for information on how to do -this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set -"PlanarConfiguration" before writing data</b>. The -organization of data has not be defined before the first -write. See <b>TIFFSetField</b>(3TIFF) for information on how -to do this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: No space -for tile arrays"</b>. There was not enough space for -the arrays that hold tile offsets and byte counts.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: -Specified tile %d out of range, max %d</b>. The specified -tile is not valid according to the currently specified image -dimensions.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFWriteEncodedTile</b>(3TIFF), -<b>TIFFWriteScanline</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFWriteScanline.3tiff.html b/doc/static/man/TIFFWriteScanline.3tiff.html deleted file mode 100644 index 5249039f..00000000 --- a/doc/static/man/TIFFWriteScanline.3tiff.html +++ /dev/null @@ -1,203 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFWriteScanline</title> - -</head> -<body> - -<h1 align="center">TIFFWriteScanline</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#BUGS">BUGS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFWriteScanline -− write a scanline to an open <small>TIFF</small> -file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFWriteScanline(TIFF *</b><i>tif</i><b>, tdata_t</b> -<i>buf</i><b>, uint32_t</b> <i>row</i><b>, tsample_t</b> -<i>sample</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Write data to a -file at the specified row. The <i>sample</i> parameter is -used only if data are organized in separate planes -(<i>PlanarConfiguration</i>=2). The data are assumed to be -uncompressed and in the native bit- and byte-order of the -host machine. The data written to the file is compressed -according to the compression scheme of the current -<small>TIFF</small> directory (see further below). If the -current scanline is past the end of the current subfile, the -<i>ImageLength</i> field is automatically increased to -include the scanline (except for -<i>PlanarConfiguration</i>=2, where the <i>ImageLength</i> -cannot be changed once the first data are written). If the -<i>ImageLength</i> is increased, the <i>StripOffsets</i> and -<i>StripByteCounts</i> fields are similarly enlarged to -reflect data written past the previous end of image.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The library -writes encoded data using the native machine byte order. -Correctly implemented <small>TIFF</small> readers are -expected to do any necessary byte-swapping to correctly -process image data with BitsPerSample greater than 8. The -library attempts to hide bit-ordering differences between -the image and the native machine by converting data from the -native machine order.</p> - -<p style="margin-left:11%; margin-top: 1em">In C++ the -<i>sample</i> parameter defaults to 0.</p> - -<p style="margin-left:11%; margin-top: 1em">Once data are -written to a file for the current directory, the values of -certain tags may not be altered; see -<i>TIFFSetField</i>(3TIFF) for more information.</p> - -<p style="margin-left:11%; margin-top: 1em">It is not -possible to write scanlines to a file that uses a tiled -organization. The routine <i>TIFFIsTiled</i> can be used to -determine if the file is organized as tiles or strips.</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFWriteScanline</i> -returns −1 if it immediately detects an error and 1 -for a successful write.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <i>TIFFError</i>(3TIFF) -routine.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: File not -open for writing .</b> The file was opened for reading, not -writing.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Can not -write scanlines to a tiled image</b>. An attempt was made to -write a scanline to a tiled image. The image is assumed to -be organized in tiles because the <i>TileWidth</i> and -<i>TileLength</i> tags have been set with -<i>TIFFSetField</i>(3TIFF).</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Compression -algorithm does not support random access</b>. Data was -written in a non-sequential order to a file that uses a -compression algorithm and that has <i>RowsPerStrip</i> -greater than one. That is, data in the image is to be stored -in a compressed form, and with multiple rows packed into a -strip. In this case, the library does not support random -access to the data. The data should either be written as -entire strips, sequentially by rows, or the value of -<i>RowsPerStrip</i> should be set to one.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set -"ImageWidth" before writing data</b>. The -image’s width has not be set before the first write. -See <b>TIFFSetField</b>(3TIFF) for information on how to do -this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: Must set -"PlanarConfiguration" before writing data</b>. The -organization of data has not be defined before the first -write. See <b>TIFFSetField</b>(3TIFF) for information on how -to do this.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Can not -change "ImageLength" when using separate -planes</b>. Separate image planes are being used -(<i>PlanarConfiguration</i>=2), but the number of rows has -not been specified before the first write. The library -supports the dynamic growth of an image only when data are -organized in a contiguous manner -(<i>PlanarConfiguration</i>=1).</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%d: Sample -out of range, max %d</b>. The <i>sample</i> parameter was -greater than the value of the SamplesPerPixel tag.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: No space -for strip arrays .</b> There was not enough space for the -arrays that hold strip offsets and byte counts.</p> - -<h2>BUGS -<a name="BUGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Writing -subsampled YCbCR data does not work correctly because, for -<i>PlanarConfiguration</i>=2 the size of a scanline is not -calculated on a per-sample basis, and for -<i>PlanarConfiguration</i>=1 the library does not pack the -block-interleaved samples.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFWriteEncodedStrip</b>(3TIFF), -<b>TIFFWriteRawStrip</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFWriteTile.3tiff.html b/doc/static/man/TIFFWriteTile.3tiff.html deleted file mode 100644 index 9b1ef6eb..00000000 --- a/doc/static/man/TIFFWriteTile.3tiff.html +++ /dev/null @@ -1,110 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFWriteTile</title> - -</head> -<body> - -<h1 align="center">TIFFWriteTile</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#RETURN VALUES">RETURN VALUES</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFWriteTile -− encode and write a tile of data to an open -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>tsize_t -TIFFWriteTile(TIFF *</b><i>tif</i><b>, tdata_t</b> -<i>buf</i><b>, uint32_t</b> <i>x</i><b>, uint32_t</b> -<i>y</i><b>, uint32_t</b> <i>z</i><b>, tsample_t</b> -<i>sample</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Write the data -for the tile <i>containing</i> the specified coordinates. -The data in <i>buf</i> are is (potentially) compressed, and -written to the indicated file, normally being appended to -the end of the file. The buffer must be contain an entire -tile of data. Applications should call the routine -<i>TIFFTileSize</i> to find out the size (in bytes) of a -tile buffer. The <i>x</i> and <i>y</i> parameters are always -used by <i>TIFFWriteTile</i>. The <i>z</i> parameter is used -if the image is deeper than 1 slice -(<i>ImageDepth</i>>1). The <i>sample</i> parameter is -used only if data are organized in separate planes -(<i>PlanarConfiguration</i>=2).</p> - -<h2>RETURN VALUES -<a name="RETURN VALUES"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFWriteTile</i> -returns −1 if it detects an error; otherwise the -number of bytes in the tile is returned.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed to the <b>TIFFError</b>(3TIFF) -routine.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFCheckTile</b>(3TIFF), -<b>TIFFComputeTile</b>(3TIFF), <b>TIFFOpen</b>(3TIFF), -<b>TIFFReadTile</b>(3TIFF), <b>TIFFWriteScanline</b>(3TIFF), -<b>TIFFWriteEncodedTile</b>(3TIFF), -<b>TIFFWriteRawTile</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFbuffer.3tiff.html b/doc/static/man/TIFFbuffer.3tiff.html deleted file mode 100644 index 557044e8..00000000 --- a/doc/static/man/TIFFbuffer.3tiff.html +++ /dev/null @@ -1,118 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:25 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFBUFFER</title> - -</head> -<body> - -<h1 align="center">TIFFBUFFER</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFReadBufferSetup, -TIFFWriteBufferSetup − I/O buffering control -routines</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFReadBufferSetup(TIFF *</b><i>tif</i><b>, tdata_t</b> -<i>buffer</i><b>, tsize_t</b> <i>size</i><b>); <br> -int TIFFWriteBufferSetup(TIFF *</b><i>tif</i><b>, -tdata_t</b> <i>buffer</i><b>, tsize_t</b> -<i>size</i><b>);</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The following -routines are provided for client-control of the I/O buffers -used by the library. Applications need never use these -routines; they are provided only for -‘‘intelligent clients’’ that wish to -optimize memory usage and/or eliminate potential copy -operations that can occur when working with images that have -data stored without compression.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFReadBufferSetup</i> -sets up the data buffer used to read raw (encoded) data from -a file. If the specified pointer is <small>NULL</small> -(zero), then a buffer of the appropriate size is allocated. -Otherwise the caller must guarantee that the buffer is large -enough to hold any individual strip of raw data. -<i>TIFFReadBufferSetup</i> returns a non-zero value if the -setup was successful and zero otherwise.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFWriteBufferSetup</i> -sets up the data buffer used to write raw (encoded) data to -a file. If the specified <i>size</i> is −1 then the -buffer size is selected to hold a complete tile or strip, or -at least 8 kilobytes, whichever is greater. If the specified -<i>buffer</i> is <small>NULL</small> (zero), then a buffer -of the appropriate size is dynamically allocated. -<i>TIFFWriteBufferSetup</i> returns a non-zero value if the -setup was successful and zero otherwise.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>%s: No space -for data buffer at scanline %ld</b>. -<i>TIFFReadBufferSetup</i> was unable to dynamically -allocate space for a data buffer.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>%s: No space -for output buffer</b>. <i>TIFFWriteBufferSetup</i> was -unable to dynamically allocate space for a data buffer.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFcodec.3tiff.html b/doc/static/man/TIFFcodec.3tiff.html deleted file mode 100644 index 1d85df48..00000000 --- a/doc/static/man/TIFFcodec.3tiff.html +++ /dev/null @@ -1,118 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:25 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>CODEC</title> - -</head> -<body> - -<h1 align="center">CODEC</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFFindCODEC, -TIFFRegisterCODEC, TIFFUnRegisterCODEC, -TIFFIsCODECConfigured − codec-related utility -routines</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>const -TIFFCodec* TIFFFindCODEC(uint16_t</b> <i>scheme</i><b>); -<br> -TIFFCodec* TIFFRegisterCODEC(uint16_t</b> <i>scheme</i><b>, -const char *</b><i>method</i><b>, TIFFInitMethod</b> -<i>init</i><b>); <br> -void TIFFUnRegisterCODEC(TIFFCodec *</b><i>codec</i><b>); -<br> -int TIFFIsCODECConfigured(uint16_t</b> -<i>scheme</i><b>);</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>libtiff</i></b> -supports a variety of compression schemes implemented by -software <i>codecs</i>. Each codec adheres to a modular -interface that provides for the decoding and encoding of -image data; as well as some other methods for -initialization, setup, cleanup, and the control of default -strip and tile sizes. Codecs are identified by the -associated value of the <small>TIFF</small> -<i>Compression</i> tag; e.g. 5 for <small>LZW</small> -compression.</p> - -<p style="margin-left:11%; margin-top: 1em">The -<i>TIFFRegisterCODEC</i> routine can be used to augment or -override the set of codecs available to an application. If -the specified <i>scheme</i> already has a registered codec -then it is <i>overridden</i> and any images with data -encoded with this compression scheme will be decoded using -the supplied codec.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFIsCODECConfigured</i> -returns 1 if the codec is configured and working. Otherwise -0 will be returned.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>No space to -register compression scheme %s</b>. <i>TIFFRegisterCODEC</i> -was unable to allocate memory for the data structures needed -to register a codec.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Cannot -remove compression scheme %s; not registered</b>. -<i>TIFFUnRegisterCODEC</i> did not locate the specified -codec in the table of registered compression schemes.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFcolor.3tiff.html b/doc/static/man/TIFFcolor.3tiff.html deleted file mode 100644 index 2d1e1d89..00000000 --- a/doc/static/man/TIFFcolor.3tiff.html +++ /dev/null @@ -1,827 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:25 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>COLOR</title> - -</head> -<body> - -<h1 align="center">COLOR</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFYCbCrToRGBInit, -TIFFYCbCrtoRGB, TIFFCIELabToRGBInit, TIFFCIELabToXYZ, -TIFFXYZToRGB − color conversion routines.</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFYCbCrToRGBInit(TIFFYCbCrToRGB *</b><i>ycbcr</i><b>, -float *</b><i>luma</i><b>, float -*</b><i>refBlackWhite"</i><b>);" <br> -void TIFFYCbCrtoRGB(TIFFYCbCrToRGB *</b><i>ycbcr</i><b>, -uint32_t</b> <i>Y</i><b>, int32_t</b> <i>Cb</i><b>, -int32_t</b> <i>Cr</i><b>, uint32_t *</b><i>R</i><b>, -uint32_t *</b><i>G</i><b>, uint32_t *</b><i>B</i> -<b>);</b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>int -TIFFCIELabToRGBInit(TIFFCIELabToRGB *</b><i>cielab</i><b>, -const TIFFDisplay *</b><i>display</i><b>, float -*</b><i>refWhite</i><b>); <br> -void TIFFCIELabToXYZ(TIFFCIELabToRGB *</b><i>cielab</i><b>, -uint32_t</b> <i>L</i><b>, int32_t</b> <i>a</i><b>, -int32_t</b> <i>b</i><b>, float *</b><i>X</i><b>, float -*</b><i>Y</i><b>, float *</b><i>Z</i><b>); <br> -void TIFFXYZToRGB(TIFFCIELabToRGB *</b><i>cielab</i><b>, -float</b> <i>X</i><b>, float</b> <i>Y</i><b>, float</b> -<i>Z"</i><b>,</b><i>uint32_t</i><b>*"</b><i>R</i><b>, -uint32_t *</b><i>G</i><b>, uint32_t -*</b><i>B</i><b>);</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFF supports -several color spaces for images stored in that format. There -is usually a problem of application to handle the data -properly and convert between different colorspaces for -displaying and printing purposes. To simplify this task -libtiff implements several color conversion routines itself. -In particular, these routines used in -<b>TIFFRGBAImage(3TIFF)</b> interface.</p> - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFYCbCrToRGBInit()</b> -used to initialize <i>YCbCr</i> to <i>RGB</i> conversion -state. Allocating and freeing of the <i>ycbcr</i> structure -belongs to programmer. <i>TIFFYCbCrToRGB</i> defined in -<b>tiffio.h</b> as</p> - -<p style="margin-left:22%; margin-top: 1em">typedef struct -{ /* YCbCr->RGB support */ <br> -TIFFRGBValue* clamptab; /* range clamping table */</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> - - -<p>int*</p><td width="34%"></td> -<td width="-26%"></td> -<td width="15%"></td> -<td width="8%"></td> -<td width="7%"></td> -<td width="62%"> - - -<p>Cr_r_tab; <br> -int*</p></td></tr> -<tr valign="top" align="left"> -<td width="34%"></td> -<td width="-26%"></td> -<td width="15%"></td> -<td width="8%"></td> -<td width="7%"></td> -<td width="62%"> - - -<p>Cb_b_tab; <br> -int32_t*</p></td></tr> -<tr valign="top" align="left"> -<td width="34%"></td> -<td width="-26%"></td> -<td width="15%"></td> -<td width="8%"></td> -<td width="7%"></td> -<td width="62%"> - - -<p>Cr_g_tab; <br> -int32_t*</p></td></tr> -<tr valign="top" align="left"> -<td width="34%"></td> -<td width="-26%"></td> -<td width="15%"></td> -<td width="8%"></td> -<td width="7%"></td> -<td width="62%"> - - -<p>Cb_g_tab;</p></td></tr> -</table> - -<p style="margin-left:22%;">int32_t* Y_tab; <br> -} TIFFYCbCrToRGB;</p> - -<p style="margin-left:11%; margin-top: 1em"><i>luma</i> is -a float array of three values representing proportions of -the red, green and blue in luminance, Y (see section 21 of -the TIFF 6.0 specification, where the YCbCr images -discussed). <i>TIFFTAG_YCBCRCOEFFICIENTS</i> holds that -values in TIFF file. <i>refBlackWhite</i> is a float array -of 6 values which specifies a pair of headroom and footroom -image data values (codes) for each image component (see -section 20 of the TIFF 6.0 specification where the -colorinmetry fields discussed). -<i>TIFFTAG_REFERENCEBLACKWHITE</i> is responsible for -storing these values in TIFF file. Following code snippet -should helps to understand the the technique:</p> - -<p style="margin-left:22%; margin-top: 1em">float *luma, -*refBlackWhite; <br> -uint16_t hs, vs;</p> - -<p style="margin-left:22%; margin-top: 1em">/* Initialize -structures */ <br> -ycbcr = (TIFFYCbCrToRGB*)</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>_TIFFmalloc(TIFFroundup(sizeof(TIFFYCbCrToRGB), -sizeof(long))</p> </td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>+ 4*256*sizeof(TIFFRGBValue)</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>+ 2*256*sizeof(int)</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>+ 3*256*sizeof(int32_t));</p></td></tr> -</table> - -<p style="margin-left:22%;">if (ycbcr == NULL) { <br> -TIFFError("YCbCr->RGB",</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="77%"> -</td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>"No space for YCbCr->RGB conversion -state");</p> </td></tr> -</table> - -<p style="margin-left:22%;">exit(0); <br> -}</p> - - -<p style="margin-left:22%; margin-top: 1em">TIFFGetFieldDefaulted(tif, -TIFFTAG_YCBCRCOEFFICIENTS, &luma); <br> -TIFFGetFieldDefaulted(tif, TIFFTAG_REFERENCEBLACKWHITE, -&refBlackWhite); <br> -if (TIFFYCbCrToRGBInit(ycbcr, luma, refBlackWhite) < -0)</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>exit(0);</p></td></tr> -</table> - -<p style="margin-left:22%; margin-top: 1em">/* Start -conversion */ <br> -uint32_t r, g, b; <br> -uint32_t Y; <br> -int32_t Cb, Cr;</p> - -<p style="margin-left:22%; margin-top: 1em">for each pixel -in image</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>TIFFYCbCrtoRGB(img->ycbcr, Y, Cb, Cr, &r, &g, -&b);</p> </td></tr> -</table> - -<p style="margin-left:22%; margin-top: 1em">/* Free state -structure */ <br> -_TIFFfree(ycbcr);</p> - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFCIELabToRGBInit()</b> -initializes the <i>CIE L*a*b* 1976</i> to <i>RGB</i> -conversion state. <b>TIFFCIELabToRGB</b> defined as</p> - -<p style="margin-left:22%; margin-top: 1em">#define -CIELABTORGB_TABLE_RANGE 1500</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-14%"></td> -<td width="7%"></td> -<td width="8%"> - - -<p>typedef struct {</p></td> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="8%"> -</td> -<td width="46%"> - - -<p>/* CIE Lab 1976->RGB support */</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-14%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="8%"> - - -<p>int</p></td> -<td width="7%"> - - -<p>range;</p></td> -<td width="8%"></td> -<td width="8%"> -</td> -<td width="46%"> - - -<p>/* Size of conversion table */</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-14%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="8%"> - - -<p>float</p></td> -<td width="7%"></td> -<td width="8%"> - - -<p>rstep, gstep, bstep;</p></td> -<td width="8%"></td> -<td width="46%"> -</td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-14%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="8%"> - - -<p>float</p></td> -<td width="7%"></td> -<td width="8%"> - - -<p>X0, Y0, Z0;</p></td> -<td width="8%"></td> -<td width="46%"> - - -<p>/* Reference white point */</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-14%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="8%"> - - -<p>TIFFDisplay display;</p></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="8%"></td> -<td width="46%"> -</td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-14%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="8%"> - - -<p>float</p></td> -<td width="7%"></td> -<td width="8%"> - - -<p>Yr2r[CIELABTORGB_TABLE_RANGE + 1]; /* Conversion of Yr -to r */</p></td> -<td width="8%"></td> -<td width="46%"> -</td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-14%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="8%"> - - -<p>float</p></td> -<td width="7%"></td> -<td width="8%"> - - -<p>Yg2g[CIELABTORGB_TABLE_RANGE + 1]; /* Conversion of Yg -to g */</p></td> -<td width="8%"></td> -<td width="46%"> -</td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-14%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="8%"> - - -<p>float</p></td> -<td width="7%"></td> -<td width="8%"> - - -<p>Yb2b[CIELABTORGB_TABLE_RANGE + 1]; /* Conversion of Yb -to b */</p></td> -<td width="8%"></td> -<td width="46%"> -</td></tr> -</table> - -<p style="margin-left:22%;">} TIFFCIELabToRGB;</p> - -<p style="margin-left:11%; margin-top: 1em"><i>display</i> -is a display device description, declared as</p> - -<p style="margin-left:22%; margin-top: 1em">typedef struct -{</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>float d_mat[3][3]; /* XYZ -> luminance matrix */</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>float d_YCR; /* Light o/p for reference white */</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>float d_YCG;</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>float d_YCB;</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>uint32_t d_Vrwr; /* Pixel values for ref. white */</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>uint32_t d_Vrwg;</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>uint32_t d_Vrwb;</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>float d_Y0R; /* Residual light for black pixel */</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>float d_Y0G;</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>float d_Y0B;</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>float d_gammaR; /* Gamma values for the three guns -*/</p> </td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>float d_gammaG;</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>float d_gammaB;</p></td></tr> -</table> - -<p style="margin-left:22%;">} TIFFDisplay;</p> - -<p style="margin-left:11%; margin-top: 1em">For example, -the one can use sRGB device, which has the following -parameters:</p> - -<p style="margin-left:22%; margin-top: 1em">TIFFDisplay -display_sRGB = {</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>{ /* XYZ -> luminance matrix */</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="77%"> -</td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>{ 3.2410F, -1.5374F, -0.4986F },</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="77%"> -</td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>{ -0.9692F, 1.8760F, 0.0416F },</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="77%"> -</td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>{ 0.0556F, -0.2040F, 1.0570F }</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="77%"> - - -<p>},</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> -</td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>100.0F, 100.0F, 100.0F, /* Light o/p for reference white -*/</p> </td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>255, 255, 255, /* Pixel values for ref. white */</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>1.0F, 1.0F, 1.0F, /* Residual light o/p for black pixel -*/</p> </td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>2.4F, 2.4F, 2.4F, /* Gamma values for the three guns -*/</p> </td></tr> -</table> - -<p style="margin-left:22%;">};</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>refWhite</i> -is a color temperature of the reference white. The -<i>TIFFTAG_WHITEPOINT</i> contains the chromaticity of the -white point of the image from where the reference white can -be calculated using following formulae:</p> - -<p style="margin-left:22%; margin-top: 1em">refWhite_Y = -100.0 <br> -refWhite_X = whitePoint_x / whitePoint_y * refWhite_Y <br> -refWhite_Z = (1.0 - whitePoint_x - whitePoint_y) / -whitePoint_y * refWhite_X</p> - -<p style="margin-left:11%; margin-top: 1em">The conversion -itself performed in two steps: at the first one we will -convert <i>CIE L*a*b* 1976</i> to <i>CIE XYZ</i> using -<b>TIFFCIELabToXYZ()</b> routine, and at the second step we -will convert <i>CIE XYZ</i> to <i>RGB</i> using -<b>TIFFXYZToRGB().</b> Look at the code sample below:</p> - -<p style="margin-left:22%; margin-top: 1em">float -*whitePoint; <br> -float refWhite[3];</p> - -<p style="margin-left:22%; margin-top: 1em">/* Initialize -structures */ <br> -img->cielab = (TIFFCIELabToRGB *)</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>_TIFFmalloc(sizeof(TIFFCIELabToRGB));</p></td></tr> -</table> - -<p style="margin-left:22%;">if (!cielab) {</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>TIFFError("CIE L*a*b*->RGB",</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="77%"> -</td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>"No space for CIE L*a*b*->RGB conversion -state.");</p> </td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>exit(0);</p></td></tr> -</table> - -<p style="margin-left:22%;">}</p> - - -<p style="margin-left:22%; margin-top: 1em">TIFFGetFieldDefaulted(tif, -TIFFTAG_WHITEPOINT, &whitePoint); <br> -refWhite[1] = 100.0F; <br> -refWhite[0] = whitePoint[0] / whitePoint[1] * refWhite[1]; -<br> -refWhite[2] = (1.0F - whitePoint[0] - whitePoint[1])</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>/ whitePoint[1] * refWhite[1];</p></td></tr> -</table> - -<p style="margin-left:22%;">if (TIFFCIELabToRGBInit(cielab, -&display_sRGB, refWhite) < 0) {</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>TIFFError("CIE L*a*b*->RGB",</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"> -</td> -<td width="77%"> -</td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>"Failed to initialize CIE L*a*b*->RGB conversion -state.");</p> </td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>_TIFFfree(cielab);</p></td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="7%"></td> -<td width="8%"></td> -<td width="77%"> - - -<p>exit(0);</p></td></tr> -</table> - -<p style="margin-left:22%;">}</p> - -<p style="margin-left:22%; margin-top: 1em">/* Now we can -start to convert */ <br> -uint32_t r, g, b; <br> -uint32_t L; <br> -int32_t a, b; <br> -float X, Y, Z;</p> - -<p style="margin-left:22%; margin-top: 1em">for each pixel -in image</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>TIFFCIELabToXYZ(cielab, L, a, b, &X, &Y, -&Z);</p> </td></tr> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="92%"> - - -<p>TIFFXYZToRGB(cielab, X, Y, Z, &r, &g, -&b);</p> </td></tr> -</table> - -<p style="margin-left:22%; margin-top: 1em">/* Don’t -forget to free the state structure */ <br> -_TIFFfree(cielab);</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFRGBAImage</b>(3TIFF) -<b>libtiff</b>(3TIFF),</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFmemory.3tiff.html b/doc/static/man/TIFFmemory.3tiff.html deleted file mode 100644 index 4172bd88..00000000 --- a/doc/static/man/TIFFmemory.3tiff.html +++ /dev/null @@ -1,110 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>MEMORY</title> - -</head> -<body> - -<h1 align="center">MEMORY</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">_TIFFmalloc, -_TIFFrealloc, _TIFFfree, _TIFFmemset, _TIFFmemcpy, -_TIFFmemcmp, − memory management-related functions for -use with <small>TIFF</small> files</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>tdata_t -_TIFFmalloc(tsize_t</b> <i>size</i><b>); <br> -tdata_t _TIFFrealloc(tdata_t</b> <i>buffer</i><b>, -tsize_t</b> <i>size</i><b>); <br> -void _TIFFfree(tdata_t</b> <i>buffer</i><b>); <br> -void _TIFFmemset(tdata_t</b> <i>s</i><b>, int</b> -<i>c</i><b>, tsize_t</b> <i>n</i><b>); <br> -void _TIFFmemcpy(tdata_t</b> <i>dest</i><b>, const -tdata_t</b> <i>src</i><b>, tsize_t</b> <i>n</i><b>); <br> -int _TIFFmemcmp(const tdata_t</b> <i>s1</i><b>, const -tdata_t</b> <i>s2</i><b>, tsize_t</b> <i>n</i><b>);</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">These routines -are provided for writing portable software that uses -<i>libtiff</i>; they hide any memory-management related -issues, such as dealing with segmented architectures found -on 16-bit machines.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>_TIFFmalloc</i> -and <i>_TIFFrealloc</i> are used to dynamically allocate and -reallocate memory used by <i>libtiff</i>; such as memory -passed into the I/O routines. Memory allocated through these -interfaces is released back to the system using the -<i>_TIFFfree</i> routine.</p> - -<p style="margin-left:11%; margin-top: 1em">Memory -allocated through one of the above interfaces can be set to -a known value using <i>_TIFFmemset</i>, copied to another -memory location using <i>_TIFFmemcpy</i>, or compared for -equality using <i>_TIFFmemcmp</i>. These routines conform to -the equivalent <small>ANSI</small> C routines: -<i>memset</i>, <i>memcpy</i>, and <i>memcmp</i>, -respectively.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">None.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>malloc</b>(3), -<b>memory</b>(3), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFquery.3tiff.html b/doc/static/man/TIFFquery.3tiff.html deleted file mode 100644 index 8af961f3..00000000 --- a/doc/static/man/TIFFquery.3tiff.html +++ /dev/null @@ -1,160 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:26 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>QUERY</title> - -</head> -<body> - -<h1 align="center">QUERY</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFCurrentRow, -TIFFCurrentStrip, TIFFCurrentTile, TIFFCurrentDirectory, -TIFFLastDirectory, TIFFFileno, TIFFFileName, TIFFGetMode, -TIFFIsTiled, TIFFIsByteSwapped, TIFFIsUpSampled, -TIFFIsMSB2LSB, TIFFGetVersion − query routines</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>uint32_t -TIFFCurrentRow(TIFF*</b> <i>tif</i><b>) <br> -tstrip_t TIFFCurrentStrip(TIFF*</b> <i>tif</i><b>) <br> -ttile_t TIFFCurrentTile(TIFF*</b> <i>tif</i><b>) <br> -tdir_t TIFFCurrentDirectory(TIFF*</b> <i>tif</i><b>) <br> -int TIFFLastDirectory(TIFF*</b> <i>tif</i><b>) <br> -int TIFFFileno(TIFF*</b> <i>tif</i><b>) <br> -char* TIFFFileName(TIFF*</b> <i>tif</i><b>) <br> -int TIFFGetMode(TIFF*</b> <i>tif</i><b>) <br> -int TIFFIsTiled(TIFF*</b> <i>tif</i><b>) <br> -int TIFFIsByteSwapped(TIFF*</b> <i>tif</i><b>) <br> -int TIFFIsUpSampled(TIFF*</b> <i>tif</i><b>) <br> -int TIFFIsMSB2LSB(TIFF*</b> <i>tif</i><b>) <br> -const char* TIFFGetVersion(void)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The following -routines return status information about an open -<small>TIFF</small> file.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFCurrentDirectory</i> -returns the index of the current directory (directories are -numbered starting at 0). This number is suitable for use -with the <i>TIFFSetDirectory</i> routine.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFLastDirectory</i> -returns a non-zero value if the current directory is the -last directory in the file; otherwise zero is returned.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFCurrentRow</i>, -<i>TIFFCurrentStrip</i>, and <i>TIFFCurrentTile</i>, return -the current row, strip, and tile, respectively, that is -being read or written. These values are updated each time a -read or write is done.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFFileno</i> -returns the underlying file descriptor used to access the -<small>TIFF</small> image in the filesystem.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFFileName</i> -returns the pathname argument passed to <i>TIFFOpen</i> or -<i>TIFFFdOpen</i>.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFGetMode</i> -returns the mode with which the underlying file was opened. -On <small>UNIX</small> systems, this is the value passed to -the <i>open</i>(2) system call.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFIsTiled</i> -returns a non-zero value if the image data has a tiled -organization. Zero is returned if the image data is -organized in strips.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFIsByteSwapped</i> -returns a non-zero value if the image data was in a -different byte-order than the host machine. Zero is returned -if the TIFF file and local host byte-orders are the same. -Note that TIFFReadTile(), TIFFReadEncodedStrip() and -TIFFReadScanline() functions already normally perform byte -swapping to local host order if needed.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFIsUpSampled</i> -returns a non-zero value if image data returned through the -read interface routines is being up-sampled. This can be -useful to applications that want to calculate I/O buffer -sizes to reflect this usage (though the usual strip and tile -size routines already do this).</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFIsMSB2LSB</i> -returns a non-zero value if the image data is being returned -with bit 0 as the most significant bit.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFGetVersion</i> -returns an <small>ASCII</small> string that has a version -stamp for the <small>TIFF</small> library software.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">None.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>libtiff</i>(3TIFF), -<i>TIFFOpen</i>(3TIFF), <i>TIFFFdOpen</i>(3TIFF)</p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFsize.3tiff.html b/doc/static/man/TIFFsize.3tiff.html deleted file mode 100644 index 9ec15e6b..00000000 --- a/doc/static/man/TIFFsize.3tiff.html +++ /dev/null @@ -1,92 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFSIZE</title> - -</head> -<body> - -<h1 align="center">TIFFSIZE</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFScanlineSize, -TIFFRasterScanlineSize, − return the size of various -items associated with an open <small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>tsize_t -TIFFRasterScanlineSize(TIFF *</b><i>tif</i><b>) <br> -tsize_t TIFFScanlineSize(TIFF *</b><i>tif</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFScanlineSize</i></b> -returns the size in bytes of a row of data as it would be -returned in a call to <i>TIFFReadScanline</i>, or as it -would be expected in a call to <i>TIFFWriteScanline</i>.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFRasterScanlineSize</i> -returns the size in bytes of a complete decoded and packed -raster scanline. Note that this value may be different from -the value returned by <i>TIFFScanlineSize</i> if data is -stored as separate planes.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">None.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFOpen</b>(3TIFF), -<b>TIFFReadScanline</b>(3TIFF), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFstrip.3tiff.html b/doc/static/man/TIFFstrip.3tiff.html deleted file mode 100644 index 25a5fd76..00000000 --- a/doc/static/man/TIFFstrip.3tiff.html +++ /dev/null @@ -1,136 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFSTRIP</title> - -</head> -<body> - -<h1 align="center">TIFFSTRIP</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFDefaultStripSize, -TIFFStripSize, TIFFVStripSize, TIFFRawStripSize, -TIFFComputeStrip, TIFFNumberOfStrips − strip-related -utility routines</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>uint32_t -TIFFDefaultStripSize(TIFF *</b><i>tif</i><b>, uint32_t</b> -<i>estimate</i><b>) <br> -tmsize_t TIFFStripSize(TIFF *</b><i>tif</i><b>) <br> -tmsize_t TIFFVStripSize(TIFF *</b><i>tif</i><b>, -uint32_t</b> <i>nrows</i><b>) <br> -tmsize_t TIFFRawStripSize(TIFF *</b><i>tif</i><b>, -uint32_t</b> <i>strip</i><b>) <br> -tstrip_t TIFFComputeStrip(TIFF *</b><i>tif</i><b>, -uint32_t</b> <i>row</i><b>, tsample_t</b> <i>sample</i><b>) -<br> -tstrip_t TIFFNumberOfStrips(TIFF *</b><i>tif</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFDefaultStripSize</i></b> -returns the number of rows for a reasonable-sized strip -according to the current settings of the <i>ImageWidth</i>, -<i>BitsPerSample</i>, <i>SamplesPerPixel</i>, tags and any -compression-specific requirements. If the <i>estimate</i> -parameter, if non-zero, then it is taken as an estimate of -the desired strip size and adjusted according to any -compression-specific requirements. The value returned by -this function is typically used to define the -<i>RowsPerStrip</i> tag. In lieu of any unusual requirements -<i>TIFFDefaultStripSize</i> tries to create strips that have -approximately 8 kilobytes of uncompressed data.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFStripSize</i> -returns the equivalent size for a strip of data as it would -be returned in a call to <i>TIFFReadEncodedStrip</i> or as -it would be expected in a call to -<i>TIFFWriteEncodedStrip</i>.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFVStripSize</i> -returns the number of bytes in a strip with <i>nrows</i> -rows of data.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFRawStripSize</i> -returns the number of bytes in a raw strip (i.e. not -decoded).</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFComputeStrip</i> -returns the strip that contains the specified coordinates. A -valid strip is always returned; out-of-range coordinate -values are clamped to the bounds of the image. The -<i>row</i> parameter is always used in calculating a strip. -The <i>sample</i> parameter is used only if data are -organized in separate planes -(<i>PlanarConfiguration</i>=2).</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFNumberOfStrips</i> -returns the number of strips in the image.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">None.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFReadEncodedStrip</b>(3TIFF), -<b>TIFFReadRawStrip</b>(3TIFF), -<b>TIFFWriteEncodedStrip</b>(3TIFF), -<b>TIFFWriteRawStrip</b>(3TIFF), <b>libtiff</b>(3TIFF),</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFswab.3tiff.html b/doc/static/man/TIFFswab.3tiff.html deleted file mode 100644 index aaa44478..00000000 --- a/doc/static/man/TIFFswab.3tiff.html +++ /dev/null @@ -1,110 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>SWAB</title> - -</head> -<body> - -<h1 align="center">SWAB</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em">TIFFGetBitRevTable, -TIFFReverseBits, TIFFSwabShort, TIFFSwabLong, -TIFFSwabArrayOfShort, TIFFSwabArrayOfLong − byte- and -bit-swapping routines</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>const -unsigned char* TIFFGetBitRevTable(int</b> -<i>reversed</i><b>) <br> -void TIFFReverseBits(u_char *</b><i>data</i><b>, unsigned -long</b> <i>nbytes</i><b>) <br> -void TIFFSwabShort(uint16_t *</b><i>data</i><b>) <br> -void TIFFSwabLong(uint32_t *</b><i>data</i><b>) <br> -void TIFFSwabArrayOfShort(uint16_t *</b><i>data</i><b>, -unsigned long</b> <i>nshorts</i><b>) <br> -void TIFFSwabArrayOfLong(uint32_t *</b><i>data</i><b>, -unsigned long</b> <i>nlongs</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The following -routines are used by the library to swap 16- and 32-bit data -and to reverse the order of bits in bytes.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFSwabShort</i> -and <i>TIFFSwabLong</i> swap the bytes in a single 16-bit -and 32-bit item, respectively. <i>TIFFSwabArrayOfShort</i> -and <i>TIFFSwabArrayOfLong</i> swap the bytes in an array of -16-bit and 32-bit items, respectively.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFReverseBits</i> -replaces each byte in <i>data</i> with the equivalent -bit-reversed value. This operation is performed with a -lookup table, which is returned using the -<i>TIFFGetBitRevTable</i> function. <i>reversed</i> -parameter specifies which table should be returned. Supply -<i>1</i> if you want bit reversal table. Supply <i>0</i> to -get the table that do not reverse bit values. It is a lookup -table that can be used as an <i>identity function</i>; i.e. -<i>TIFFNoBitRevTable[n] == n</i>.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">None.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/TIFFtile.3tiff.html b/doc/static/man/TIFFtile.3tiff.html deleted file mode 100644 index c19e0533..00000000 --- a/doc/static/man/TIFFtile.3tiff.html +++ /dev/null @@ -1,148 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:27 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFTILE</title> - -</head> -<body> - -<h1 align="center">TIFFTILE</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">TIFFTileSize, -TIFFTileRowSize, TIFFVTileSize, TIFFDefaultTileSize, -TIFFComputeTile, TIFFCheckTile, TIFFNumberOfTiles − -tile-related utility routines</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em"><b>void -TIFFDefaultTileSize(TIFF *</b><i>tif</i><b>, uint32_t -*</b><i>tw</i><b>, uint32_t *</b><i>th</i><b>) <br> -tsize_t TIFFTileSize(TIFF *</b><i>tif</i><b>) <br> -tsize_t TIFFTileRowSize(TIFF *</b><i>tif</i><b>) <br> -tsize_t TIFFVTileSize(TIFF *</b><i>tif</i><b>, uint32_t</b> -<i>nrows</i><b>) <br> -ttile_t TIFFComputeTile(TIFF *</b><i>tif</i><b>, -uint32_t</b> <i>x</i><b>, uint32_t</b> <i>y</i><b>, -uint32_t</b> <i>z</i><b>, tsample_t</b> <i>sample</i><b>) -<br> -int TIFFCheckTile(TIFF *</b><i>tif</i><b>, uint32_t</b> -<i>x</i><b>, uint32_t</b> <i>y</i><b>, uint32_t</b> -<i>z</i><b>, tsample_t</b> <i>sample</i><b>) <br> -ttile_t TIFFNumberOfTiles(TIFF *</b><i>tif</i><b>)</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>TIFFDefaultTileSize</i></b> -returns the pixel width and height of a reasonable-sized -tile; suitable for setting up the <i>TileWidth</i> and -<i>TileLength</i> tags. If the <i>tw</i> and <i>th</i> -values passed in are non-zero, then they are adjusted to -reflect any compression-specific requirements. The returned -width and height are constrained to be a multiple of 16 -pixels to conform with the <small>TIFF</small> -specification.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFTileSize</i> -returns the equivalent size for a tile of data as it would -be returned in a call to <i>TIFFReadTile</i> or as it would -be expected in a call to <i>TIFFWriteTile</i>.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFVTileSize</i> -returns the number of bytes in a row-aligned tile with -<i>nrows</i> of data.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFTileRowSize</i> -returns the number of bytes of a row of data in a tile.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFComputeTile</i> -returns the tile that contains the specified coordinates. A -valid tile is always returned; out-of-range coordinate -values are clamped to the bounds of the image. The <i>x</i> -and <i>y</i> parameters are always used in calculating a -tile. The <i>z</i> parameter is used if the image is deeper -than 1 slice (<i>ImageDepth</i>>1). The <i>sample</i> -parameter is used only if data are organized in separate -planes (<i>PlanarConfiguration</i>=2).</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFCheckTile</i> -returns a non-zero value if the supplied coordinates are -within the bounds of the image and zero otherwise. The -<i>x</i> parameter is checked against the value of the -<i>ImageWidth</i> tag. The <i>y</i> parameter is checked -against the value of the <i>ImageLength</i> tag. The -<i>z</i> parameter is checked against the value of the -<i>ImageDepth</i> tag (if defined). The <i>sample</i> -parameter is checked against the value of the -<i>SamplesPerPixel</i> parameter if the data are organized -in separate planes.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>TIFFNumberOfTiles</i> -returns the number of tiles in the image.</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">None.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>TIFFReadEncodedTile</b>(3TIFF), -<b>TIFFReadRawTile</b>(3TIFF), <b>TIFFReadTile</b>(3TIFF), -<b>TIFFWriteEncodedTile</b>(3TIFF), -<b>TIFFWriteRawTile</b>(3TIFF), <b>TIFFWriteTile</b>(3TIFF), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/fax2ps.1.html b/doc/static/man/fax2ps.1.html deleted file mode 100644 index 49130c5b..00000000 --- a/doc/static/man/fax2ps.1.html +++ /dev/null @@ -1,224 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>FAX2PS</title> - -</head> -<body> - -<h1 align="center">FAX2PS</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#BUGS">BUGS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">fax2ps − -convert a <small>TIFF</small> facsimile to compressed -PostScript™</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>fax2ps</b> [ -<i>options</i> ] [ <i>file ...</i> ]</p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><i>fax2ps</i> -reads one or more <small>TIFF</small> facsimile image files -and prints a compressed form of PostScript on the standard -output that is suitable for printing.</p> - -<p style="margin-left:11%; margin-top: 1em">By default, -each page is scaled to reflect the image dimensions and -resolutions stored in the file. The <b>−x</b> and -<b>−y</b> options can be used to specify the -horizontal and vertical image resolutions (lines/inch), -respectively. If the <b>−S</b> option is specified, -each page is scaled to fill an output page. The default -output page is 8.5 by 11 inches. Alternate page dimensions -can be specified in inches with the <b>−W</b> and -<b>−H</b> options.</p> - -<p style="margin-left:11%; margin-top: 1em">By default -<i>fax2ps</i> generates PostScript for all pages in the -file. The <b>−p</b> option can be used to select one -or more pages from a multi-page document.</p> - -<p style="margin-left:11%; margin-top: 1em"><i>fax2ps</i> -generates a compressed form of PostScript that is optimized -for sending pages of text to a PostScript printer attached -to a host through a low-speed link (such as a serial line). -Each output page is filled with white and then only the -black areas are drawn. The PostScript specification of the -black drawing operations is optimized by using a special -font that encodes the move-draw operations required to fill -the black regions on the page. This compression scheme -typically results in a substantially reduced PostScript -description, relative to the straightforward imaging of the -page with a PostScript <i>image</i> operator. This algorithm -can, however, be ineffective for continuous-tone and -white-on-black images. For these images, it sometimes is -more efficient to send the raster bitmap image directly; see -<b>tiff2ps</b>(1).</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="14%"> - - -<p style="margin-top: 1em"><b>−p</b> -<i>number</i></p> </td> -<td width="1%"></td> -<td width="74%"> - - -<p style="margin-top: 1em">Print only the indicated page. -Multiple pages may be printed by specifying this option more -than once.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−x</b> -<i>resolution</i></p> - -<p style="margin-left:26%;">Use <i>resolution</i> as the -horizontal resolution, in dots/inch, of the image data. By -default this value is taken from the file.</p> - -<p style="margin-left:11%;"><b>−y</b> -<i>resolution</i></p> - -<p style="margin-left:26%;">Use <i>resolution</i> as the -vertical resolution, in lines/inch, of the image data. By -default this value is taken from the file.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="14%"> - - -<p><b>−S</b></p></td> -<td width="1%"></td> -<td width="74%"> - - -<p>Scale each page of image data to fill the output page -dimensions. By default images are presented according to the -dimension information recorded in the <small>TIFF</small> -file.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="14%"> - - -<p><b>−W</b> <i>width</i></p></td> -<td width="1%"></td> -<td width="74%"> - - -<p>Use <i>width</i> as the width, in inches, of the output -page.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="14%"> - - -<p><b>−H</b> <i>height</i></p></td> -<td width="1%"></td> -<td width="74%"> - - -<p>Use <i>height</i> as the height, in inches, of the -output page.</p></td></tr> -</table> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Some messages -about malformed <small>TIFF</small> images come from the -<small>TIFF</small> library.</p> - -<p style="margin-left:11%; margin-top: 1em">Various -messages about badly formatted facsimile images may be -generated due to transmission errors in received facsimile. -<i>fax2ps</i> attempts to recover from such data errors by -resynchronizing decoding at the end of the current scanline. -This can result in long horizontal black lines in the -resultant PostScript image.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">If the -destination printer supports PostScript Level II then it is -always faster to just send the encoded bitmap generated by -the <b>tiff2ps</b>(1) program.</p> - -<h2>BUGS -<a name="BUGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><i>fax2ps</i> -should probably figure out when it is doing a poor job of -compressing the output and just generate PostScript to image -the bitmap raster instead.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiff2ps</b>(1), -<b>libtiff</b>(3)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/fax2tiff.1.html b/doc/static/man/fax2tiff.1.html deleted file mode 100644 index c12bfd27..00000000 --- a/doc/static/man/fax2tiff.1.html +++ /dev/null @@ -1,573 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>FAX2TIFF</title> - -</head> -<body> - -<h1 align="center">FAX2TIFF</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#BUGS">BUGS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">fax2tiff -− create a <small>TIFF</small> Class F fax file from -raw fax data</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>fax2tiff</b> -[ <i>options</i> ] [ <b>−o</b> <i>output.tif</i> ] -<i>input.raw</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>Fax2tiff</i> -creates a <small>TIFF</small> file containing -<small>CCITT</small> Group 3 or Group 4 encoded data from -one or more files containing ‘‘raw’’ -Group 3 or Group 4 encoded data (typically obtained directly -from a fax modem). By default, each row of data in the -resultant <small>TIFF</small> file is 1-dimensionally -encoded and padded or truncated to 1728 pixels, as needed. -The resultant image is a set of low resolution (98 -lines/inch) or medium resolution (196 lines/inch) pages, -each of which is a single strip of data. The generated file -conforms to the <small>TIFF</small> Class F ( <small>FAX) -specification for storing facsimile data.</small> This -means, in particular, that each page of the data does -<b>not</b> include the trailing <i>return to control</i> ( -<small>RTC) code; as required</small> for transmission by -the <small>CCITT</small> Group 3 specifications. The old, -‘‘classic’’, format is created if -the <b>−c</b> option is used. (The Class F format can -also be requested with the <b>−f</b> option.)</p> - -<p style="margin-left:11%; margin-top: 1em">The default -name of the output image is <i>fax.tif</i>; this can be -changed with the <b>−o</b> option. Each input file is -assumed to be a separate page of facsimile data from the -same document. The order in which input files are specified -on the command line is the order in which the resultant -pages appear in the output file.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Options that -affect the interpretation of input data are:</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−3</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Assume input data is <small>CCITT</small> Group 3 -encoded (default).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−4</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Assume input data is <small>CCITT</small> Group 4 -encoded.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−U</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Assume input data is uncompressed (Group 3 or Group -4).</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−1</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Assume input data is encoded with the 1-dimensional -version of the <small>CCITT</small> Group 3 Huffman encoding -algorithm (default).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−2</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Assume input data is 2-dimensional version of the -<small>CCITT</small> Group 3 Huffman encoding algorithm.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−P</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Assume input data is <b>not</b> EOL-aligned (default). -This option has effect with Group 3 encoded input only.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−A</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Assume input data is EOL-aligned. This option has effect -with Group 3 encoded input only.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−M</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Treat input data as having bits filled from most -significant bit ( <small>MSB) to most least bit ( -<small>LSB).</small></small></p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><b>−L</b></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small>Treat input data as having bits filled from least -significant bit ( <small>LSB) to most significant bit ( -<small>MSB) (default).</small></small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−B</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Assume input data was encoded with black -as 0 and white as 1.</small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−W</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Assume input data was encoded with black -as 1 and white as 0 (default).</small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−R</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Specify the vertical resolution, in -lines/inch, of the input images. By default input are -assumed to have a vertical resolution of 196 lines/inch. If -images are low resolution facsimile, a value of 98 -lines/inch should be specified.</small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−X</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Specify the width, in pixels, of the input -images. By default input are assumed to have a width of 1728 -pixels.</small></small></p> </td></tr> -</table> - - -<p style="margin-left:11%; margin-top: 1em"><small><small>Options -that affect the output file format are:</small></small></p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - - -<p style="margin-top: 1em"><small><small><b>−o</b></small></small></p> </td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em"><small><small>Specify the name -of the output file.</small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−7</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Force output to be compressed with the -<small>CCITT</small> Group 3 Huffman encoding algorithm -(default).</small></small></p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−8</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Force output to be compressed with the -<small>CCITT</small> Group 4 Huffman -encoding.</small></small></p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−u</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Force output to be uncompressed (Group 3 -or Group 4).</small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−5</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Force output to be encoded with the -1-dimensional version of the <small>CCITT</small> Group 3 -Huffman encoding algorithm.</small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−6</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Force output to be encoded with the -2-dimensional version of the <small>CCITT</small> Group 3 -Huffman encoding algorithm (default).</small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−a</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Force the last bit of each <i>End Of -Line</i> ( <small>EOL) code to land on a byte boundary -(default). This ‘‘zero padding’’ -will</small> be reflected in the contents of the -<i>Group3Options</i> tag of the resultant -<small>TIFF</small> file. This option has effect with Group -3 encoded output only.</small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−p</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Do not EOL-align output. This option has -effect with Group 3 encoded output only.</small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−c</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Generate "classic" Group 3 TIFF -format.</small></small></p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−f</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Generate TIFF Class F (TIFF/F) format -(default).</small></small></p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><small><small><b>−m</b></small></small></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small>Force output data to have bits filled from -most significant bit ( <small>MSB) to most least bit ( -<small>LSB).</small></small></small></small></p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - - -<p><small><small><small><b>−l</b></small></small></small></p> </td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small><small>Force output data to have bits -filled from least significant bit ( <small>LSB) to most -significant bit ( <small>MSB) -(default).</small></small></small></small></small></p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - - -<p><small><small><small><small><b>−r</b></small></small></small></small></p> </td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small><small><small>Specify the number of rows -(scanlines) in each strip of data written to the output -file. By default (or when value <b>0</b> is specified), -<i>tiffcp</i> attempts to set the rows/strip that no more -than 8 kilobytes of data appear in a strip (with except of -G3/G4 compression schemes). If you specify special value -<b>−1</b> it will results in infinite number of the -rows per strip. The entire image will be the one strip in -that case. This is default in case of G3/G4 output -compression schemes.</small></small></small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - - -<p><small><small><small><small><b>−s</b></small></small></small></small></p> </td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small><small><small>Stretch the input image -vertically by writing each input row of data twice to the -output file.</small></small></small></small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - - -<p><small><small><small><small><b>−v</b></small></small></small></small></p> </td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small><small><small>Force <i>fax2tiff</i> to -print the number of rows of data it retrieved from the input -file.</small></small></small></small></p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - - -<p><small><small><small><small><b>−z</b></small></small></small></small></p> </td> -<td width="8%"></td> -<td width="78%"> - - -<p><small><small><small><small>Force output to be -compressed with the LZW -encoding.</small></small></small></small></p> </td></tr> -</table> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><small><small><small><small>The -following warnings and errors come from the decoding -routines in the library.</small></small></small></small></p> - - -<p style="margin-left:11%; margin-top: 1em"><small><small><small><small><b>Warning, -%s: Premature EOL at scanline %d (x %d).\n</b>. The input -data had a row that was shorter than the expected width. The -row is padded with -white.</small></small></small></small></p> - - -<p style="margin-left:11%; margin-top: 1em"><small><small><small><small><b>%s: -Premature EOF at scanline %d (x %d).\n</b>. The decoder ran -out of data in the middle of a scanline. The resultant row -is padded with white.</small></small></small></small></p> - - -<p style="margin-left:11%; margin-top: 1em"><small><small><small><small><b>%s: -Bad code word at row %d, x %d\n</b>. An invalid Group 3 -<i>code</i> was encountered while decoding the input file. -The row number and horizontal position is given. The -remainder of the input row is discarded, while the -corresponding output row is padded with -white.</small></small></small></small></p> - - -<p style="margin-left:11%; margin-top: 1em"><small><small><small><small><b>%s: -Bad 2D code word at scanline %d.\n</b>. An invalid Group 4 -or 2D Group 3 <i>code</i> was encountered while decoding the -input file. The row number and horizontal position is given. -The remainder of the input row is discarded, while the -corresponding output row is padded with -white.</small></small></small></small></p> - -<h2>BUGS -<a name="BUGS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><small><small><small><small>Input -data are assumed to have a a ‘‘top -left’’ orientation; it should be possible to -override this assumption from the command -line.</small></small></small></small></p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><small><small><small><small><b><small>CCITT</small> -Recommendation T.4</b> (Standardization of Group 3 Facsimile -Apparatus for Document -Transmission).</small></small></small></small></p> - - -<p style="margin-left:11%; margin-top: 1em"><small><small><small><small><b>The -Spirit of TIFF Class F</b>, an appendix to the TIFF 5.0 -specification prepared by Cygnet -Technologies.</small></small></small></small></p> - - -<p style="margin-left:11%; margin-top: 1em"><small><small><small><small><b>tiffinfo</b>(1), -<b>tiffdither</b>(1), <b>tiffgt</b>(1), -<b>libtiff</b>(3)</small></small></small></small></p> - - -<p style="margin-left:11%; margin-top: 1em"><small><small><small><small>Libtiff -library home page: -<b>http://www.simplesystems.org/libtiff/</b></small></small></small></small></p> -<hr> -</body> -</html> diff --git a/doc/static/man/libtiff.3tiff.html b/doc/static/man/libtiff.3tiff.html deleted file mode 100644 index a196857f..00000000 --- a/doc/static/man/libtiff.3tiff.html +++ /dev/null @@ -1,3099 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:25 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>INTRO</title> - -</head> -<body> - -<h1 align="center">INTRO</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#DATA TYPES">DATA TYPES</a><br> -<a href="#LIST OF ROUTINES">LIST OF ROUTINES</a><br> -<a href="#TAG USAGE">TAG USAGE</a><br> -<a href="#PSEUDO TAGS">PSEUDO TAGS</a><br> -<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> -<a href="#BUGS">BUGS</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">libtiff − -introduction to <i>libtiff</i>, a library for reading and -writing <small>TIFF</small> files</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>#include -<tiffio.h></b></p> - -<p style="margin-left:11%; margin-top: 1em">cc file.c -<b>-ltiff</b></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b><i>libtiff</i></b> -is a library for reading and writing data files encoded with -the <i>Tag Image File</i> format, Revision 6.0 (or revision -5.0 or revision 4.0). This file format is suitable for -archiving multi-color and monochromatic image data.</p> - -<p style="margin-left:11%; margin-top: 1em">The library -supports several compression algorithms, as indicated by the -<i>Compression</i> field, including: no compression (1), -<small>CCITT</small> 1D Huffman compression (2), -<small>CCITT</small> Group 3 Facsimile compression (3), -<small>CCITT</small> Group 4 Facsimile compression (4), -Lempel-Ziv & Welch compression (5), baseline JPEG -compression (7), word-aligned 1D Huffman compression -(32771), and PackBits compression (32773). In addition, -several nonstandard compression algorithms are supported: -the 4-bit compression algorithm used by the -<i>ThunderScan</i> program (32809) (decompression only), -NeXT’s 2-bit compression algorithm (32766) -(decompression only), an experimental LZ-style algorithm -known as Deflate (32946), and an experimental CIE LogLuv -compression scheme designed for images with high dynamic -range (32845 for LogL and 32845 for LogLuv). Directory -information may be in either little- or big-endian byte -order−byte swapping is automatically done by the -library. Data bit ordering may be either Most Significant -Bit ( <small>MSB) to Least Significant Bit ( <small>LSB) -or</small> LSB</small> to <small>MSB.</small> Finally, the -library does not support files in which the -<i>BitsPerSample</i>, <i>Compression</i>, -<i>MinSampleValue</i>, or <i>MaxSampleValue</i> fields are -defined differently on a per-sample basis (in Rev. 6.0 the -<i>Compression</i> tag is not defined on a per-sample basis, -so this is immaterial).</p> - -<h2>DATA TYPES -<a name="DATA TYPES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The library -makes extensive use of C typedefs to promote portability. -Two sets of typedefs are used, one for communication with -clients of the library and one for internal data structures -and parsing of the <small>TIFF</small> format. The following -typedefs are exposed to users either through function -definitions or through parameters passed through the varargs -interfaces.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="40%"> - - -<p>typedef unsigned short uint16_t;</p></td> -<td width="42%"> - - -<p>16-bit unsigned integer</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="40%"> - - -<p>typedef unsigned <<i>thing</i>> uint32_t;</p></td> -<td width="42%"> - - -<p>32-bit unsigned integer</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="40%"> - - -<p>typedef unsigned int ttag_t;</p></td> -<td width="42%"> - - -<p>directory tag</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="40%"> - - -<p>typedef uint16_t tdir_t;</p></td> -<td width="42%"> - - -<p>directory index</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="40%"> - - -<p>typedef uint16_t tsample_t;</p></td> -<td width="42%"> - - -<p>sample number</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="40%"> - - -<p>typedef uint32_t tstrip_t;</p></td> -<td width="42%"> - - -<p>strip number</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="40%"> - - -<p>typedef uint32_t ttile_t;</p></td> -<td width="42%"> - - -<p>tile number</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="40%"> - - -<p>typedef int32_t tsize_t;</p></td> -<td width="42%"> - - -<p>i/o size in bytes</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="40%"> - - -<p>typedef void* tdata_t;</p></td> -<td width="42%"> - - -<p>image data ref</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="40%"> - - -<p>typedef void* thandle_t;</p></td> -<td width="42%"> - - -<p>client data handle</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="40%"> - - -<p>typedef int32_t toff_t;</p></td> -<td width="42%"> - - -<p>file offset</p></td></tr> -</table> - -<p style="margin-left:11%;">Note that <i>tstrip_t</i>, -<i>ttile_t</i>, and <i>tsize_t</i> are constrained to be no -more than 32-bit quantities by 32-bit fields they are stored -in in the <small>TIFF</small> image. Likewise -<i>tsample_t</i> is limited by the 16-bit field used to -store the <i>SamplesPerPixel</i> tag. <i>tdir_t</i> -constrains the maximum number of <small>IFDs</small> that -may appear in an image and may be an arbitrary size (w/o -penalty). <i>ttag_t</i> must be either int, unsigned int, -pointer, or double because the library uses a varargs -interface and <small>ANSI C</small> restricts the type of -the parameter before an ellipsis to be a promoted type. -<i>toff_t</i> is defined as int32_t because TIFF file -offsets are (unsigned) 32-bit quantities. A signed value is -used because some interfaces return −1 on error. -Finally, note that user-specified data references are passed -as opaque handles and only cast at the lowest layers where -their type is presumed.</p> - -<h2>LIST OF ROUTINES -<a name="LIST OF ROUTINES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The following -routines are part of the library. Consult specific manual -pages for details on their operation; on most systems doing -‘‘man function-name’’ will work.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p><i>Name</i></p></td> -<td width="62%"> - - -<p><i>Description</i></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFCheckpointDirectory</p></td> -<td width="62%"> - - -<p>writes the current state of the directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFCheckTile</p></td> -<td width="62%"> - - -<p>very x,y,z,sample is within image</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFCIELabToRGBInit</p></td> -<td width="62%"> - - -<p>initialize CIE L*a*b* 1976 to RGB conversion state</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFCIELabToXYZ</p></td> -<td width="62%"> - - -<p>perform CIE L*a*b* 1976 to CIE XYZ conversion</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFClientOpen</p></td> -<td width="62%"> - - -<p>open a file for reading or writing</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFClose</p></td> -<td width="62%"> - - -<p>close an open file</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFComputeStrip</p></td> -<td width="62%"> - - -<p>return strip containing y,sample</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFComputeTile</p></td> -<td width="62%"> - - -<p>return tile containing x,y,z,sample</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFCurrentDirectory</p></td> -<td width="62%"> - - -<p>return index of current directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFCurrentRow</p></td> -<td width="62%"> - - -<p>return index of current scanline</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFCurrentStrip</p></td> -<td width="62%"> - - -<p>return index of current strip</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFCurrentTile</p></td> -<td width="62%"> - - -<p>return index of current tile</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFDataWidth</p></td> -<td width="62%"> - - -<p>return the size of TIFF data types</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFError</p></td> -<td width="62%"> - - -<p>library error handler</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFdOpen</p></td> -<td width="62%"> - - -<p>open a file for reading or writing</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFieldDataType</p></td> -<td width="62%"> - - -<p>get data type from field information</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFieldName</p></td> -<td width="62%"> - - -<p>get field name from field information</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFieldPassCount</p></td> -<td width="62%"> - - -<p>get whether to pass a value count to Get/SetField</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFieldReadCount</p></td> -<td width="62%"> - - -<p>get number of values to be read from field</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFieldTag</p></td> -<td width="62%"> - - -<p>get tag value from field information</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFieldWithName</p></td> -<td width="62%"> - - -<p>get field information given field name</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFieldWithTag</p></td> -<td width="62%"> - - -<p>get field information given tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFieldWriteCount</p></td> -<td width="62%"> - - -<p>get number of values to be written to field</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFileName</p></td> -<td width="62%"> - - -<p>return name of open file</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFileno</p></td> -<td width="62%"> - - -<p>return open file descriptor</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFindCODEC</p></td> -<td width="62%"> - - -<p>find standard codec for the specific scheme</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFindField</p></td> -<td width="62%"> - - -<p>get field information given tag and data type</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFlush</p></td> -<td width="62%"> - - -<p>flush all pending writes</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFFlushData</p></td> -<td width="62%"> - - -<p>flush pending data writes</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFGetBitRevTable</p></td> -<td width="62%"> - - -<p>return bit reversal table</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFGetField</p></td> -<td width="62%"> - - -<p>return tag value in current directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFGetFieldDefaulted</p></td> -<td width="62%"> - - -<p>return tag value in current directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFGetMode</p></td> -<td width="62%"> - - -<p>return open file mode</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFGetVersion</p></td> -<td width="62%"> - - -<p>return library version string</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFIsCODECConfigured</p></td> -<td width="62%"> - - -<p>check, whether we have working codec</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFIsMSB2LSB</p></td> -<td width="62%"> - - -<p>return true if image data is being returned</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"></td> -<td width="62%"> - - -<p>with bit 0 as the most significant bit</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFIsTiled</p></td> -<td width="62%"> - - -<p>return true if image data is tiled</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFIsByteSwapped</p></td> -<td width="62%"> - - -<p>return true if image data is byte-swapped</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFNumberOfStrips</p></td> -<td width="62%"> - - -<p>return number of strips in an image</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFNumberOfTiles</p></td> -<td width="62%"> - - -<p>return number of tiles in an image</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFOpen</p></td> -<td width="62%"> - - -<p>open a file for reading or writing</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFPrintDirectory</p></td> -<td width="62%"> - - -<p>print description of the current directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFReadBufferSetup</p></td> -<td width="62%"> - - -<p>specify i/o buffer for reading</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFReadDirectory</p></td> -<td width="62%"> - - -<p>read the next directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFReadEncodedStrip</p></td> -<td width="62%"> - - -<p>read and decode a strip of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFReadEncodedTile</p></td> -<td width="62%"> - - -<p>read and decode a tile of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFReadRawStrip</p></td> -<td width="62%"> - - -<p>read a raw strip of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFReadRawTile</p></td> -<td width="62%"> - - -<p>read a raw tile of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFReadRGBAImage</p></td> -<td width="62%"> - - -<p>read an image into a fixed format raster</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFReadScanline</p></td> -<td width="62%"> - - -<p>read and decode a row of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFReadTile</p></td> -<td width="62%"> - - -<p>read and decode a tile of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFRegisterCODEC</p></td> -<td width="62%"> - - -<p>override standard codec for the specific scheme</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFReverseBits</p></td> -<td width="62%"> - - -<p>reverse bits in an array of bytes</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFRGBAImageBegin</p></td> -<td width="62%"> - - -<p>setup decoder state for TIFFRGBAImageGet</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFRGBAImageEnd</p></td> -<td width="62%"> - - -<p>release TIFFRGBAImage decoder state</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFRGBAImageGet</p></td> -<td width="62%"> - - -<p>read and decode an image</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFRGBAImageOK</p></td> -<td width="62%"> - - -<p>is image readable by TIFFRGBAImageGet</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFScanlineSize</p></td> -<td width="62%"> - - -<p>return size of a scanline</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFSetDirectory</p></td> -<td width="62%"> - - -<p>set the current directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFSetSubDirectory</p></td> -<td width="62%"> - - -<p>set the current directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFSetErrorHandler</p></td> -<td width="62%"> - - -<p>set error handler function</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFSetField</p></td> -<td width="62%"> - - -<p>set a tag’s value in the current directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFSetWarningHandler</p></td> -<td width="62%"> - - -<p>set warning handler function</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFStripSize</p></td> -<td width="62%"> - - -<p>returns size of a strip</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFRawStripSize</p></td> -<td width="62%"> - - -<p>returns the number of bytes in a raw strip</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFSwabShort</p></td> -<td width="62%"> - - -<p>swap bytes of short</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFSwabLong</p></td> -<td width="62%"> - - -<p>swap bytes of long</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFSwabArrayOfShort</p></td> -<td width="62%"> - - -<p>swap bytes of an array of shorts</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFSwabArrayOfLong</p></td> -<td width="62%"> - - -<p>swap bytes of an array of longs</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFTileRowSize</p></td> -<td width="62%"> - - -<p>return size of a row in a tile</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFTileSize</p></td> -<td width="62%"> - - -<p>return size of a tile</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFUnRegisterCODEC</p></td> -<td width="62%"> - - -<p>unregisters the codec</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFVGetField</p></td> -<td width="62%"> - - -<p>return tag value in current directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFVGetFieldDefaulted</p></td> -<td width="62%"> - - -<p>return tag value in current directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFVSetField</p></td> -<td width="62%"> - - -<p>set a tag’s value in the current directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFVStripSize</p></td> -<td width="62%"> - - -<p>returns the number of bytes in a strip</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFWarning</p></td> -<td width="62%"> - - -<p>library warning handler</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFWriteDirectory</p></td> -<td width="62%"> - - -<p>write the current directory</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFWriteEncodedStrip</p></td> -<td width="62%"> - - -<p>compress and write a strip of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFWriteEncodedTile</p></td> -<td width="62%"> - - -<p>compress and write a tile of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFWriteRawStrip</p></td> -<td width="62%"> - - -<p>write a raw strip of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFWriteRawTile</p></td> -<td width="62%"> - - -<p>write a raw tile of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFWriteScanline</p></td> -<td width="62%"> - - -<p>write a scanline of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFWriteTile</p></td> -<td width="62%"> - - -<p>compress and write a tile of data</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFXYZToRGB</p></td> -<td width="62%"> - - -<p>perform CIE XYZ to RGB conversion</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFYCbCrToRGBInit</p></td> -<td width="62%"> - - -<p>initialize YCbCr to RGB conversion state</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>TIFFYCbCrtoRGB</p></td> -<td width="62%"> - - -<p>perform YCbCr to RGB conversion</p></td></tr> -</table> - -<p style="margin-left:11%; margin-top: 1em">Auxiliary -functions:</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>_TIFFfree</p></td> -<td width="62%"> - - -<p>free memory buffer</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>_TIFFmalloc</p></td> -<td width="62%"> - - -<p>dynamically allocate memory buffer</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>_TIFFmemcmp</p></td> -<td width="62%"> - - -<p>compare contents of the memory buffers</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>_TIFFmemcpy</p></td> -<td width="62%"> - - -<p>copy contents of the one buffer to another</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>_TIFFmemset</p></td> -<td width="62%"> - - -<p>fill memory buffer with a constant byte</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="27%"> - - -<p>_TIFFrealloc</p></td> -<td width="62%"> - - -<p>dynamically reallocate memory buffer</p></td></tr> -</table> - -<h2>TAG USAGE -<a name="TAG USAGE"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The table below -lists the <small>TIFF</small> tags that are recognized and -handled by the library. If no use is indicated in the table, -then the library reads and writes the tag, but does not use -it internally. Note that some tags are meaningful only when -a particular compression scheme is being used; e.g. -<i>Group3Options</i> is only useful if <i>Compression</i> is -set to <small>CCITT</small> Group 3 encoding. Tags of this -sort are considered <i>codec-specific</i> tags and the -library does not recognize them except when the -<i>Compression</i> tag has been previously set to the -relevant compression scheme.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p><i>Tag Name</i></p></td> -<td width="11%"></td> -<td width="7%"> - - -<p><i>Value</i></p></td> -<td width="45%"> - - -<p><i>R/W</i></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p><i>Library Use/Notes</i></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>Artist</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>315</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>BadFaxLines</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>326</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>BitsPerSample</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>258</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>lots</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>CellLength</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>265</p></td> -<td width="45%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>parsed but ignored</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>CellWidth</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>264</p></td> -<td width="45%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>parsed but ignored</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>CleanFaxData</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>327</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>ColorMap</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>320</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>ColorResponseUnit</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>300</p></td> -<td width="45%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>parsed but ignored</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>Compression</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>259</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>choosing codec</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>ConsecutiveBadFaxLines</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>328</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -</table> - -<p style="margin-left:11%;">Copyright 33432 R/W</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>DataType</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>32996</p></td> -<td width="45%"> - - -<p>R</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>obsoleted by SampleFormat tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>DateTime</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>306</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>DocumentName</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>269</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>DotRange</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>336</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>ExtraSamples</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>338</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>lots</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>FaxRecvParams</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>34908</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>FaxSubAddress</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>34909</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>FaxRecvTime</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>34910</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>FillOrder</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>266</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>control bit order</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>FreeByteCounts</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>289</p></td> -<td width="45%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>parsed but ignored</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>FreeOffsets</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>288</p></td> -<td width="45%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>parsed but ignored</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>GrayResponseCurve</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>291</p></td> -<td width="45%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>parsed but ignored</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>GrayResponseUnit</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>290</p></td> -<td width="45%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>parsed but ignored</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>Group3Options</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>292</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>used by Group 3 codec</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>Group4Options</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>293</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>HostComputer</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>316</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>ImageDepth</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>32997</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>tile/strip calculations</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>ImageDescription</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>270</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>ImageLength</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>257</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>lots</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>ImageWidth</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>256</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>lots</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>InkNames</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>333</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>InkSet</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>332</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>JPEGTables</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>347</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>used by JPEG codec</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>Make</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>271</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>Matteing</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>32995</p></td> -<td width="45%"> - - -<p>R</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>obsoleted by ExtraSamples tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>MaxSampleValue</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>281</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>MinSampleValue</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>280</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>Model</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>272</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>NewSubFileType</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>254</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>called SubFileType in spec</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>NumberOfInks</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>334</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>Orientation</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>274</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>PageName</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>285</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>PageNumber</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>297</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>PhotometricInterpretation</p></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>262</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>R/Wused by Group 3 and JPEG codecs</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>PlanarConfiguration</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>284</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>data i/o</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>Predictor</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>317</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>used by LZW and Deflate codecs</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>PrimaryChromacities</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>319</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>ReferenceBlackWhite</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>532</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>ResolutionUnit</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>296</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>used by Group 3 codec</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>RowsPerStrip</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>278</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>data i/o</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>SampleFormat</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>339</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>SamplesPerPixel</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>277</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>lots</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>SMinSampleValue</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>340</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>SMaxSampleValue</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>341</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>Software</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>305</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>StoNits</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>37439</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>StripByteCounts</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>279</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>data i/o</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>StripOffsets</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>273</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>data i/o</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>SubFileType</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>255</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>called OSubFileType in spec</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TargetPrinter</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>337</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>Thresholding</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>263</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> -</td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TileByteCounts</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>324</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>data i/o</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TileDepth</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>32998</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>tile/strip calculations</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TileLength</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>323</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>data i/o</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TileOffsets</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>324</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>data i/o</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TileWidth</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>322</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>data i/o</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TransferFunction</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>301</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>WhitePoint</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>318</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>XPosition</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>286</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>XResolution</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>282</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>YCbCrCoefficients</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>529</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>used by TIFFRGBAImage support</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>YCbCrPositioning</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>531</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>tile/strip size calculations</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>YCbCrSubsampling</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>530</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>YPosition</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>286</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>YResolution</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>283</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>used by Group 3 codec</p></td></tr> -</table> - -<h2>PSEUDO TAGS -<a name="PSEUDO TAGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">In addition to -the normal <small>TIFF</small> tags the library supports a -collection of tags whose values lie in a range outside the -valid range of <small>TIFF</small> tags. These tags are -termed <i>pseudo-tags</i> and are used to control various -codec-specific functions within the library. The table below -summarizes the defined pseudo-tags.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p><i>Tag Name</i></p></td> -<td width="11%"></td> -<td width="7%"> - - -<p><i>Codec</i></p></td> -<td width="45%"> - - -<p><i>R/W</i></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p><i>Library Use/Notes</i></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TIFFTAG_FAXMODE</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>G3</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>general codec operation</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TIFFTAG_FAXFILLFUNC</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>G3/G4</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>bitmap fill function</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TIFFTAG_JPEGQUALITY</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>JPEG</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>compression quality control</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TIFFTAG_JPEGCOLORMODE</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>JPEG</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>control colorspace conversions</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TIFFTAG_JPEGTABLESMODE</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>JPEG</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>control contents of <i>JPEGTables</i> tag</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TIFFTAG_ZIPQUALITY</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>Deflate</p></td> -<td width="45%"> - - -<p>R/Wcompression quality level</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TIFFTAG_PIXARLOGDATAFMT</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>PixarLog</p></td> -<td width="45%"> - - -<p>R/Wuser data format</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TIFFTAG_PIXARLOGQUALITY</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>PixarLog</p></td> -<td width="45%"> - - -<p>R/Wcompression quality level</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"> - - -<p>TIFFTAG_SGILOGDATAFMT</p></td> -<td width="11%"></td> -<td width="7%"> - - -<p>SGILog</p></td> -<td width="45%"> - - -<p>R/W</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="26%"></td> -<td width="11%"></td> -<td width="7%"></td> -<td width="45%"> - - -<p>user data format</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>TIFFTAG_FAXMODE</b></p> - -<p style="margin-left:22%;">Control the operation of the -Group 3 codec. Possible values (independent bits that can be -combined by or’ing them together) are: FAXMODE_CLASSIC -(enable old-style format in which the <small>RTC</small> is -written at the end of the last strip), FAXMODE_NORTC -(opposite of FAXMODE_CLASSIC; also called FAXMODE_CLASSF), -FAXMODE_NOEOL (do not write <small>EOL</small> codes at the -start of each row of data), FAXMODE_BYTEALIGN (align each -encoded row to an 8-bit boundary), FAXMODE_WORDALIGN (align -each encoded row to an 16-bit boundary), The default value -is dependent on the compression scheme; this pseudo-tag is -used by the various G3 and G4 codecs to share code.</p> - -<p style="margin-left:11%;"><b>TIFFTAG_FAXFILLFUNC</b></p> - -<p style="margin-left:22%;">Control the function used to -convert arrays of black and white runs to packed bit arrays. -This hook can be used to image decoded scanlines in -multi-bit depth rasters (e.g. for display in colormap mode) -or for other purposes. The default value is a pointer to a -builtin function that images packed bilevel data.</p> - - -<p style="margin-left:11%;"><b>TIFFTAG_IPTCNEWSPHOTO</b></p> - -<p style="margin-left:22%;">Tag contains image metadata per -the IPTC newsphoto spec: Headline, captioning, credit, -etc... Used by most wire services.</p> - -<p style="margin-left:11%;"><b>TIFFTAG_PHOTOSHOP</b></p> - -<p style="margin-left:22%;">Tag contains Photoshop -captioning information and metadata. Photoshop uses in -parallel and redundantly alongside IPTCNEWSPHOTO -information.</p> - -<p style="margin-left:11%;"><b>TIFFTAG_JPEGQUALITY</b></p> - -<p style="margin-left:22%;">Control the compression quality -level used in the baseline algorithm. Note that quality -levels are in the range 0-100 with a default value of -75.</p> - - -<p style="margin-left:11%;"><b>TIFFTAG_JPEGCOLORMODE</b></p> - -<p style="margin-left:22%;">Control whether or not -conversion is done between RGB and YCbCr colorspaces. -Possible values are: JPEGCOLORMODE_RAW (do not convert), and -JPEGCOLORMODE_RGB (convert to/from RGB) The default value is -JPEGCOLORMODE_RAW.</p> - - -<p style="margin-left:11%;"><b>TIFFTAG_JPEGTABLESMODE</b></p> - -<p style="margin-left:22%;">Control the information written -in the <i>JPEGTables</i> tag. Possible values (independent -bits that can be combined by or’ing them together) -are: JPEGTABLESMODE_QUANT (include quantization tables), and -JPEGTABLESMODE_HUFF (include Huffman encoding tables). The -default value is -JPEGTABLESMODE_QUANT|JPEGTABLESMODE_HUFF.</p> - -<p style="margin-left:11%;"><b>TIFFTAG_ZIPQUALITY</b></p> - -<p style="margin-left:22%;">Control the compression -technique used by the Deflate codec. Quality levels are in -the range 1-9 with larger numbers yielding better -compression at the cost of more computation. The default -quality level is 6 which yields a good time-space -tradeoff.</p> - - -<p style="margin-left:11%;"><b>TIFFTAG_PIXARLOGDATAFMT</b></p> - -<p style="margin-left:22%;">Control the format of user data -passed <i>in</i> to the PixarLog codec when encoding and -passed <i>out</i> from when decoding. Possible values are: -PIXARLOGDATAFMT_8BIT for 8-bit unsigned pixels, -PIXARLOGDATAFMT_8BITABGR for 8-bit unsigned ABGR-ordered -pixels, PIXARLOGDATAFMT_11BITLOG for 11-bit log-encoded raw -data, PIXARLOGDATAFMT_12BITPICIO for 12-bit PICIO-compatible -data, PIXARLOGDATAFMT_16BIT for 16-bit signed samples, and -PIXARLOGDATAFMT_FLOAT for 32-bit IEEE floating point -samples.</p> - - -<p style="margin-left:11%;"><b>TIFFTAG_PIXARLOGQUALITY</b></p> - -<p style="margin-left:22%;">Control the compression -technique used by the PixarLog codec. This value is treated -identically to TIFFTAG_ZIPQUALITY; see the above -description.</p> - - -<p style="margin-left:11%;"><b>TIFFTAG_SGILOGDATAFMT</b></p> - -<p style="margin-left:22%;">Control the format of client -data passed <i>in</i> to the SGILog codec when encoding and -passed <i>out</i> from when decoding. Possible values are: -SGILOGDATAFMT_FLTXYZ for converting between LogLuv and -32-bit IEEE floating valued XYZ pixels, -SGILOGDATAFMT_16BITLUV for 16-bit encoded Luv pixels, -SGILOGDATAFMT_32BITRAW and SGILOGDATAFMT_24BITRAW for no -conversion of data, SGILOGDATAFMT_8BITRGB for returning -8-bit RGB data (valid only when decoding LogLuv-encoded -data), SGILOGDATAFMT_FLTY for converting between LogL and -32-bit IEEE floating valued Y pixels, SGILOGDATAFMT_16BITL -for 16-bit encoded L pixels, and SGILOGDATAFMT_8BITGRY for -returning 8-bit greyscale data (valid only when decoding -LogL-encoded data).</p> - -<h2>DIAGNOSTICS -<a name="DIAGNOSTICS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">All error -messages are directed through the <i>TIFFError</i> routine. -By default messages are directed to <b>stderr</b> in the -form: <i>module: message\n.</i> Warning messages are -likewise directed through the <i>TIFFWarning</i> -routine.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>fax2tiff</b>(1), -<b>gif2tiff</b>(1), <b>pal2rgb</b>(1), <b>ppm2tiff</b>(1), -<b>rgb2ycbcr</b>(1), <b>ras2tiff</b>(1), <b>raw2tiff</b>(1), -<b>sgi2tiff</b>(1), <b>tiff2bw</b>(1), <b>tiffdither</b>(1), -<b>tiffdump</b>(1), <b>tiffcp</b>(1), <b>tiffcmp</b>(1), -<b>tiffgt</b>(1), <b>tiffinfo</b>(1), <b>tiffmedian</b>(1), -<b>tiffsplit</b>(1), <b>tiffsv</b>(1).</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Tag Image -File Format Specification — Revision 6.0</b>, an Aldus -Technical Memorandum.</p> - -<p style="margin-left:11%; margin-top: 1em"><b>The Spirit -of TIFF Class F</b>, an appendix to the TIFF 5.0 -specification prepared by Cygnet Technologies.</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> - -<h2>BUGS -<a name="BUGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The library -does not support multi-sample images where some samples have -different bits/sample.</p> - -<p style="margin-left:11%; margin-top: 1em">The library -does not support random access to compressed data that is -organized with more than one row per tile or strip.</p> -<hr> -</body> -</html> diff --git a/doc/static/man/pal2rgb.1.html b/doc/static/man/pal2rgb.1.html deleted file mode 100644 index dee13cd5..00000000 --- a/doc/static/man/pal2rgb.1.html +++ /dev/null @@ -1,168 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>PAL2RGB</title> - -</head> -<body> - -<h1 align="center">PAL2RGB</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#BUGS">BUGS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">pal2rgb − -convert a palette color <small>TIFF</small> image to a full -color image</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>pal2rgb</b> -[ <i>options</i> ] <i>input.tif output.tif</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><i>Pal2rgb</i> -converts a palette color <small>TIFF</small> image to a full -color image by applying the colormap of the palette image to -each sample to generate a full color <small>RGB</small> -image.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Options that -affect the interpretation of input data are:</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−C</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>This option overrides the default behavior of -<i>pal2rgb</i> in determining whether or not colormap -entries contain 16-bit or 8-bit values. By default the -colormap is inspected and if no colormap entry greater than -255 is found, the colormap is assumed to have only 8-bit -values; otherwise 16-bit values (as required by the -<small>TIFF</small> specification) are assumed. The -<b>−C</b> option can be used to explicitly specify the -number of bits for colormap entries: <b>−C 8</b> for -8-bit values, <b>−C 16</b> for 16-bit values.</p></td></tr> -</table> - -<p style="margin-left:11%; margin-top: 1em">Options that -affect the output file format are:</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−p</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Explicitly select the planar -configuration used in organizing data samples in the output -image: <b>−p contig</b> for samples packed -contiguously, and <b>−p separate</b> for samples -stored separately. By default samples are packed.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Use the specific compression algorithm to encoded image -data in the output file: <b>−c packbits</b> for -Macintosh Packbits, <b>−c lzw</b> for Lempel-Ziv & -Welch, <b>−c zip</b> for Deflate, <b>−c none</b> -for no compression. If no compression-related option is -specified, the input file’s compression algorithm is -used.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−r</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Explicitly specify the number of rows in each strip of -the output file. If the <b>−r</b> option is not -specified, a number is selected such that each output strip -has approximately 8 kilobytes of data in it.</p></td></tr> -</table> - -<h2>BUGS -<a name="BUGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Only 8-bit -images are handled.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffinfo</b>(1), -<b>tiffcp</b>(1), <b>tiffmedian</b>(1), -<b>libtiff</b>(3)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/ppm2tiff.1.html b/doc/static/man/ppm2tiff.1.html deleted file mode 100644 index 9bade75b..00000000 --- a/doc/static/man/ppm2tiff.1.html +++ /dev/null @@ -1,142 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>PPM2TIFF</title> - -</head> -<body> - -<h1 align="center">PPM2TIFF</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">ppm2tiff -− create a <small>TIFF</small> file from <small>PPM, -PGM</small> and <small>PBM</small> image files</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>ppm2tiff</b> -[ <i>options</i> ] [ <i>input.ppm</i> ] -<i>output.tif</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>ppm2tiff</i> -converts a file in the <small>PPM, PGM</small> and -<small>PBM</small> image formats to <small>TIFF.</small> By -default, the <small>TIFF</small> image is created with data -samples packed (<i>PlanarConfiguration</i>=1), compressed -with the Packbits algorithm (<i>Compression</i>=32773), and -with each strip no more than 8 kilobytes. These -characteristics can be overridden, or explicitly specified -with the options described below</p> - -<p style="margin-left:11%; margin-top: 1em">If the -<small>PPM</small> file contains greyscale data, then the -<i>PhotometricInterpretation</i> tag is set to 1 -(min-is-black), otherwise it is set to 2 (RGB).</p> - -<p style="margin-left:11%; margin-top: 1em">If no -<small>PPM</small> file is specified on the command line, -<i>ppm2tiff</i> will read from the standard input.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Specify a compression scheme to -use when writing image data: <b>none</b> for no compression, -<b>packbits</b> for PackBits compression (will be used by -default), <b>lzw</b> for Lempel-Ziv & Welch compression, -<b>jpeg</b> for baseline JPEG compression, <b>zip</b> for -Deflate compression, <b>g3</b> for CCITT Group 3 (T.4) -compression, and <b>g4</b> for CCITT Group 4 (T.6) -compression.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−r</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Write data with a specified number of rows per strip; by -default the number of rows/strip is selected so that each -strip is approximately 8 kilobytes.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−R</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Mark the resultant image to have the specified X and Y -resolution (in dots/inch).</p></td></tr> -</table> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffinfo</b>(1), -<b>tiffcp</b>(1), <b>tiffmedian</b>(1), -<b>libtiff</b>(3)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/raw2tiff.1.html b/doc/static/man/raw2tiff.1.html deleted file mode 100644 index 7b25602e..00000000 --- a/doc/static/man/raw2tiff.1.html +++ /dev/null @@ -1,487 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>RAW2TIFF</title> - -</head> -<body> - -<h1 align="center">RAW2TIFF</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#GUESSING THE IMAGE GEOMETRY">GUESSING THE IMAGE GEOMETRY</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">raw2tiff -− create a <small>TIFF</small> file from a raw -data</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>raw2tiff</b> -[ <i>options</i> ] <i>input.raw output.tif</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>raw2tiff</i> -converts a raw byte sequence into <small>TIFF.</small> By -default, the <small>TIFF</small> image is created with data -samples packed (<i>PlanarConfiguration</i>=1), compressed -with the PackBits algorithm (<i>Compression</i>=32773), and -with each strip no more than 8 kilobytes. These -characteristics can overridden, or explicitly specified with -the options described below.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>−H</b> -<i>number</i></p> - -<p style="margin-left:22%;">size of input image file header -in bytes (0 by default). This amount of data just will be -skipped from the start of file while reading.</p> - -<p style="margin-left:11%;"><b>−w</b> -<i>number</i></p> - -<p style="margin-left:22%;">width of input image in pixels -(can be guessed, see <b><small>GUESSING THE IMAGE -GEOMETRY</small></b> below).</p> - -<p style="margin-left:11%;"><b>−l</b> -<i>number</i></p> - -<p style="margin-left:22%;">length of input image in lines -(can be guessed, see <b><small>GUESSING THE IMAGE -GEOMETRY</small></b> below).</p> - -<p style="margin-left:11%;"><b>−b</b> -<i>number</i></p> - -<p style="margin-left:22%;">number of bands in input image -(1 by default).</p> - -<p style="margin-left:11%;"><b>−d</b> -<i>data_type</i></p> - -<p style="margin-left:22%;">type of samples in input image, -where <i>data_type</i> may be:</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p><b>byte</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p>8-bit unsigned integer (default),</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p><b>short</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p>16-bit unsigned integer,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p><b>long</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p>32-bit unsigned integer,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p><b>sbyte</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p>8-bit signed integer,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p><b>sshort</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p>16-bit signed integer,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p><b>slong</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p>32-bit signed integer,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p><b>float</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p>32-bit IEEE floating point,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p><b>double</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-10%"></td> -<td width="88%"> - - -<p>64-bit IEEE floating point.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−i</b> -<i>config</i></p> - -<p style="margin-left:22%;">type of samples interleaving in -input image, where <i>config</i> may be:</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-11%"></td> -<td width="89%"> - - -<p><b>pixel</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-11%"></td> -<td width="89%"> - - -<p>pixel interleaved data (default),</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-11%"></td> -<td width="89%"> - - -<p><b>band</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-11%"></td> -<td width="89%"> - - -<p>band interleaved data.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−p</b> -<i>photo</i></p> - -<p style="margin-left:22%;">photometric interpretation -(color space) of the input image, where <i>photo</i> may -be:</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p><b>miniswhite</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p>white color represented with 0 value,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p><b>minisblack</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p>black color represented with 0 value (default),</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p><b>rgb</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p>image has RGB color model,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p><b>cmyk</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p>image has CMYK (separated) color model,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p><b>ycbcr</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p>image has YCbCr color model,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p><b>cielab</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p>image has CIE L*a*b color model,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p><b>icclab</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p>image has ICC L*a*b color model,</p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p><b>itulab</b></p></td></tr> -<tr valign="top" align="left"> -<td width="22%"></td> -<td width="-4%"></td> -<td width="82%"> - - -<p>image has ITU L*a*b color model.</p></td></tr> -</table> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−s</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>swap bytes fetched from the input file.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−L</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>input data has LSB2MSB bit order (default).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−M</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>input data has MSB2LSB bit order.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify a compression scheme to use when writing image -data: <b>−c none</b> for no compression, <b>−c -packbits</b> for the PackBits compression algorithm (the -default), <b>−c jpeg</b> for the baseline JPEG -compression algorithm, <b>−c zip</b> for the Deflate -compression algorithm, and <b>−c lzw</b> for -Lempel-Ziv & Welch.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−r</b> -<i>number</i></p> - -<p style="margin-left:22%;">Write data with a specified -number of rows per strip; by default the number of -rows/strip is selected so that each strip is approximately 8 -kilobytes.</p> - -<h2>GUESSING THE IMAGE GEOMETRY -<a name="GUESSING THE IMAGE GEOMETRY"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>raw2tiff</i> -can guess image width and height in case one or both of -these parameters are not specified. If you omit one of those -parameters, the complementary one will be calculated based -on the file size (taking into account header size, number of -bands and data type). If you omit both parameters, the -statistical approach will be used. Utility will compute -correlation coefficient between two lines at the image -center using several appropriate line sizes and the highest -absolute value of the coefficient will indicate the right -line size. That is why you should be cautious with the very -large images, because guessing process may take a while -(depending on your system performance). Of course, the -utility can’t guess the header size, number of bands -and data type, so it should be specified manually. If you -don’t know anything about your image, just try with -the several combinations of those options.</p> - -<p style="margin-left:11%; margin-top: 1em">There is no -magic, it is just a mathematical statistics, so it can be -wrong in some cases. But for most ordinary images guessing -method will work fine.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>pal2rgb</b>(1), -<b>tiffinfo</b>(1), <b>tiffcp</b>(1), <b>tiffmedian</b>(1), -<b>libtiff</b>(3)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/rgb2ycbcr.1.html b/doc/static/man/rgb2ycbcr.1.html deleted file mode 100644 index 6e481f79..00000000 --- a/doc/static/man/rgb2ycbcr.1.html +++ /dev/null @@ -1,155 +0,0 @@ -<!-- Creator : groff version 1.18.1 --> -<!-- CreationDate: Sat Feb 24 18:37:19 2007 --> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta name="Content-Style" content="text/css"> -<title>RGB2YCBCR</title> -</head> -<body> - -<h1 align=center>RGB2YCBCR</h1> -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> -<a name="NAME"></a> -<h2>NAME</h2> -<!-- INDENTATION --> -<table width="100%" border=0 rules="none" frame="void" - cols="2" cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="91%"> -<p>rgb2ycbcr − convert non-YCbCr <small>TIFF</small> -images to a YCbCr <small>TIFF</small> image</p> -</td> -</table> -<a name="SYNOPSIS"></a> -<h2>SYNOPSIS</h2> -<!-- INDENTATION --> -<table width="100%" border=0 rules="none" frame="void" - cols="2" cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="91%"> -<p><b>rgb2ycbcr</b> [ <i>options</i> ] <i>src1.tif src2.tif -... dst.tif</i></p> -</td> -</table> -<a name="DESCRIPTION"></a> -<h2>DESCRIPTION</h2> -<!-- INDENTATION --> -<table width="100%" border=0 rules="none" frame="void" - cols="2" cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="91%"> -<p><i>rgb2ycbcr</i> converts <small>RGB</small> color, -greyscale, or bi-level <small>TIFF</small> images to YCbCr -images by transforming and sampling pixel data. If multiple -files are specified on the command line each source file is -converted to a separate directory in the destination -file.</p> -<!-- INDENTATION --> -<p>By default, chrominance samples are created by sampling 2 -by 2 blocks of luminance values; this can be changed with -the <b>−h</b> and <b>−v</b> options. Output data -are compressed with the <small>PackBits</small> compression -scheme, by default; an alternate scheme can be selected with -the <b>−c</b> option. By default, output data are -compressed in strips with the number of rows in each strip -selected so that the size of a strip is never more than 8 -kilobytes; the <b>−r</b> option can be used to -explicitly set the number of rows per strip.</p> -</td> -</table> -<a name="OPTIONS"></a> -<h2>OPTIONS</h2> -<!-- TABS --> -<table width="100%" border=0 rules="none" frame="void" - cols="5" cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="10%"></td> -<td width="3%"> - -<p><b>−c</b></p> -</td> -<td width="5%"></td> -<td width="80%"> - -<p>Specify a compression scheme to use when writing image -data: <b>−c none</b> for no compression, <b>−c -packbits</b> for the PackBits compression algorithm (the -default), <b>−c jpeg</b> for the JPEG compression -algorithm, <b>−c zip</b> for the deflate compression -algorithm, and <b>−c lzw</b> for Lempel-Ziv & -Welch.</p> -</td> -<td width="0%"> -</td> -<tr valign="top" align="left"> -<td width="10%"></td> -<td width="3%"> - -<p><b>−h</b></p> -</td> -<td width="5%"></td> -<td width="80%"> - -<p>Set the horizontal sampling dimension to one of: 1, 2 -(default), or 4.</p> -</td> -<td width="0%"> -</td> -<tr valign="top" align="left"> -<td width="10%"></td> -<td width="3%"> - -<p><b>−r</b></p> -</td> -<td width="5%"></td> -<td width="80%"> - -<p>Write data with a specified number of rows per strip; by -default the number of rows/strip is selected so that each -strip is approximately 8 kilobytes.</p> -</td> -<td width="0%"> -</td> -<tr valign="top" align="left"> -<td width="10%"></td> -<td width="3%"> - -<p><b>−v</b></p> -</td> -<td width="5%"></td> -<td width="80%"> - -<p>Set the vertical sampling dimension to one of: 1, 2 -(default), or 4.</p> -</td> -<td width="0%"> -</td> -</table> -<a name="SEE ALSO"></a> -<h2>SEE ALSO</h2> -<!-- INDENTATION --> -<table width="100%" border=0 rules="none" frame="void" - cols="2" cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="91%"> -<p><b>tiffinfo</b>(1), <b>tiffcp</b>(1), -<b>libtiff</b>(3)</p> -<!-- INDENTATION --> -<p>Libtiff library home page: -<b>http://www.simplesystems.org/libtiff/</b></p> -</td> -</table> -<hr> -</body> -</html> diff --git a/doc/static/man/thumbnail.1.html b/doc/static/man/thumbnail.1.html deleted file mode 100644 index 8b114137..00000000 --- a/doc/static/man/thumbnail.1.html +++ /dev/null @@ -1,148 +0,0 @@ -<!-- Creator : groff version 1.18.1 --> -<!-- CreationDate: Sat Feb 24 18:37:19 2007 --> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta name="Content-Style" content="text/css"> -<title>THUMBNAIL</title> -</head> -<body> - -<h1 align=center>THUMBNAIL</h1> -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#BUGS">BUGS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> -<a name="NAME"></a> -<h2>NAME</h2> -<!-- INDENTATION --> -<table width="100%" border=0 rules="none" frame="void" - cols="2" cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="91%"> -<p>thumbnail − create a <small>TIFF</small> file with -thumbnail images</p> -</td> -</table> -<a name="SYNOPSIS"></a> -<h2>SYNOPSIS</h2> -<!-- INDENTATION --> -<table width="100%" border=0 rules="none" frame="void" - cols="2" cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="91%"> -<p><b>thumbnail</b> [ <i>options</i> ] <i>input.tif -output.tif</i></p> -</td> -</table> -<a name="DESCRIPTION"></a> -<h2>DESCRIPTION</h2> -<!-- INDENTATION --> -<table width="100%" border=0 rules="none" frame="void" - cols="2" cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="91%"> -<p><i>thumbnail</i> is a program written to show how one -might use the SubIFD tag (#330) to store thumbnail images. -<i>thumbnail</i> copies a <small>TIFF</small> Class F -facsimile file to the output file and for each image an -8-bit greyscale <i>thumbnail sketch</i>. The output file -contains the thumbnail image with the associated -full-resolution page linked below with the SubIFD tag.</p> -<!-- INDENTATION --> -<p>By default, thumbnail images are 216 pixels wide by 274 -pixels high. Pixels are calculated by sampling and filtering -the input image with each pixel value passed through a -contrast curve.</p> -</td> -</table> -<a name="OPTIONS"></a> -<h2>OPTIONS</h2> -<!-- TABS --> -<table width="100%" border=0 rules="none" frame="void" - cols="5" cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="10%"></td> -<td width="3%"> - -<p><b>−w</b></p> -</td> -<td width="5%"></td> -<td width="80%"> - -<p>Specify the width of thumbnail images in pixels.</p> -</td> -<td width="0%"> -</td> -<tr valign="top" align="left"> -<td width="10%"></td> -<td width="3%"> - -<p><b>−h</b></p> -</td> -<td width="5%"></td> -<td width="80%"> - -<p>Specify the height of thumbnail images in pixels.</p> -</td> -<td width="0%"> -</td> -<tr valign="top" align="left"> -<td width="10%"></td> -<td width="3%"> - -<p><b>−c</b></p> -</td> -<td width="5%"></td> -<td width="80%"> - -<p>Specify a contrast curve to apply in generating the -thumbnail images. By default pixels values are passed -through a linear contrast curve that simply maps the pixel -value ranges. Alternative curves are: <b>exp50</b> for a 50% -exponential curve, <b>exp60</b> for a 60% exponential curve, -<b>exp70</b> for a 70% exponential curve, <b>exp80</b> for a -80% exponential curve, <b>exp90</b> for a 90% exponential -curve, <b>exp</b> for a pure exponential curve, -<b>linear</b> for a linear curve.</p> -</td> -<td width="0%"> -</td> -</table> -<a name="BUGS"></a> -<h2>BUGS</h2> -<!-- INDENTATION --> -<table width="100%" border=0 rules="none" frame="void" - cols="2" cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="91%"> -<p>There are no options to control the format of the saved -thumbnail images.</p> -</td> -</table> -<a name="SEE ALSO"></a> -<h2>SEE ALSO</h2> -<!-- INDENTATION --> -<table width="100%" border=0 rules="none" frame="void" - cols="2" cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="8%"></td> -<td width="91%"> -<p><b>tiffdump</b>(1), <b>tiffgt</b>(1), <b>tiffinfo</b>(1), -<b>libtiff</b>(3)</p> -<!-- INDENTATION --> -<p>Libtiff library home page: -<b>http://www.simplesystems.org/libtiff/</b></p> -</td> -</table> -<hr> -</body> -</html> diff --git a/doc/static/man/tiff2bw.1.html b/doc/static/man/tiff2bw.1.html deleted file mode 100644 index b8c3558d..00000000 --- a/doc/static/man/tiff2bw.1.html +++ /dev/null @@ -1,153 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFF2BW</title> - -</head> -<body> - -<h1 align="center">TIFF2BW</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiff2bw − -convert a color <small>TIFF</small> image to greyscale</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>tiff2bw</b> -[ <i>options</i> ] <i>input.tif output.tif</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><i>Tiff2bw</i> -converts an <small>RGB</small> or Palette color -<small>TIFF</small> image to a greyscale image by combining -percentages of the red, green, and blue channels. By -default, output samples are created by taking 28% of the red -channel, 59% of the green channel, and 11% of the blue -channel. To alter these percentages, the <b>−R</b>, -<b>−G</b>, and <b>−B</b> options may be -used.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Specify a compression scheme to -use when writing image data: <b>−c none</b> for no -compression, <b>−c packbits</b> for the PackBits -compression algorithm, <b>−c zip</b> for the Deflate -compression algorithm, <b>−c g3</b> for the CCITT -Group 3 compression algorithm, <b>−c g4</b> for the -CCITT Group 4 compression algorithm, and <b>−c lzw</b> -for Lempel-Ziv & Welch (the default).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−r</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Write data with a specified number of rows per strip; by -default the number of rows/strip is selected so that each -strip is approximately 8 kilobytes.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−R</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the percentage of the red channel to use -(default 28).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−G</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the percentage of the green channel to use -(default 59).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−B</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the percentage of the blue channel to use -(default 11).</p></td></tr> -</table> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>pal2rgb</b>(1), -<b>tiffinfo</b>(1), <b>tiffcp</b>(1), <b>tiffmedian</b>(1), -<b>libtiff</b>(3)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiff2pdf.1.html b/doc/static/man/tiff2pdf.1.html deleted file mode 100644 index f0a056a2..00000000 --- a/doc/static/man/tiff2pdf.1.html +++ /dev/null @@ -1,419 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFF2PDF</title> - -</head> -<body> - -<h1 align="center">TIFF2PDF</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#EXAMPLES">EXAMPLES</a><br> -<a href="#BUGS">BUGS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiff2pdf -− convert a TIFF image to a PDF document</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiff2pdf</b> -[ <i>options</i> ] <i>input.tiff</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>tiff2pdf</i> -opens a TIFF image and writes a PDF document to standard -output.</p> - -<p style="margin-left:11%; margin-top: 1em">The program -converts one TIFF file to one PDF file, including multiple -page TIFF files, tiled TIFF files, black and white. -grayscale, and color TIFF files that contain data of TIFF -photometric interpretations of bilevel, grayscale, RGB, -YCbCr, CMYK separation, and ICC L*a*b* as supported by -<i>libtiff</i> and PDF.</p> - -<p style="margin-left:11%; margin-top: 1em">If you have -multiple TIFF files to convert into one PDF file then use -<i>tiffcp</i> or other program to concatenate the files into -a multiple page TIFF file. If the input TIFF file is of huge -dimensions (greater than 10000 pixels height or width) -convert the input image to a tiled TIFF if it is not -already.</p> - -<p style="margin-left:11%; margin-top: 1em">The standard -output is standard output. Set the output file name with the -<b>−o</b> <i>output.pdf</i> option.</p> - -<p style="margin-left:11%; margin-top: 1em">All black and -white files are compressed into a single strip CCITT G4 Fax -compressed PDF, unless tiled, where tiled black and white -images are compressed into tiled CCITT G4 Fax compressed -PDF, <i>libtiff</i> CCITT support is assumed.</p> - -<p style="margin-left:11%; margin-top: 1em">Color and -grayscale data can be compressed using either JPEG -compression, ITU-T T.81, or Zip/Deflate LZ77 compression. -Set the compression type using the <b>−j</b> or -<b>−z</b> options. JPEG compression support requires -that <i>libtiff</i> be configured with JPEG support, and -Zip/Deflate compression support requires that <i>libtiff</i> -be configured with Zip support, in tiffconf.h. Use only one -or the other of <b>−j</b> and <b>−z.</b></p> - -<p style="margin-left:11%; margin-top: 1em">If the input -TIFF contains single strip CCITT G4 Fax compressed -information, then that is written to the PDF file without -transcoding, unless the options of no compression and no -passthrough are set, <b>−d</b> and -<b>−n.</b></p> - -<p style="margin-left:11%; margin-top: 1em">If the input -TIFF contains JPEG or single strip Zip/Deflate compressed -information, and they are configured, then that is written -to the PDF file without transcoding, unless the options of -no compression and no passthrough are set.</p> - -<p style="margin-left:11%; margin-top: 1em">The default -page size upon which the TIFF image is placed is determined -by the resolution and extent of the image data. Default -values for the TIFF image resolution can be set using the -<b>−x</b> and <b>−y</b> options. The page size -can be set using the <b>−p</b> option for paper size, -or <b>−w</b> and <b>−l</b> for paper width and -length, then each page of the TIFF image is centered on its -page. The distance unit for default resolution and page -width and length can be set by the <b>−u</b> option, -the default unit is inch.</p> - -<p style="margin-left:11%; margin-top: 1em">Various items -of the output document information can be set with the -<b>−e</b>, <b>−c</b>, <b>−a</b>, -<b>−t</b>, <b>−s</b>, and <b>−k</b> -options. Setting the argument of the option to "" -for these tags causes the relevant document information -field to be not written. Some of the document information -values otherwise get their information from the input TIFF -image, the software, author, document name, and image -description.</p> - -<p style="margin-left:11%; margin-top: 1em">The Portable -Document Format (PDF) specification is copyrighted by Adobe -Systems, Incorporated.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>−o</b> -<i>output-file</i></p> - -<p style="margin-left:22%;">Set the output to go to file. -<i>output-file</i></p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−j</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Compress with JPEG (requires <i>libjpeg</i> configured -with <i>libtiff</i>).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−z</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Compress with Zip/Deflate (requires <i>zlib</i> -configured with <i>libtiff</i>).</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−q</b> -<i>quality</i></p> - -<p style="margin-left:22%;">Set the compression quality, -1-100 for JPEG.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−n</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Do not allow data to be converted without uncompressing, -no compressed data passthrough.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−b</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Set PDF ‘‘Interpolate’’ user -preference.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−d</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Do not compress (decompress).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−i</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Invert colors.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−p</b> -<i>paper-size</i></p> - -<p style="margin-left:22%;">Set paper size, e.g., -<b>letter</b>, <b>legal</b>, <b>A4</b>.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−F</b></p></td> -<td width="8%"></td> -<td width="55%"> - - -<p>Cause the tiff to fill the PDF page.</p></td> -<td width="23%"> -</td></tr> -</table> - -<p style="margin-left:11%;"><b>−u</b> -[<b>i</b>|<b>m</b>]</p> - -<p style="margin-left:22%;">Set distance unit, <b>i</b> for -inch, <b>m</b> for centimeter.</p> - -<p style="margin-left:11%;"><b>−w</b> -<i>width</i></p> - -<p style="margin-left:22%;">Set width in units.</p> - -<p style="margin-left:11%;"><b>−l</b> -<i>length</i></p> - -<p style="margin-left:22%;">Set length in units.</p> - -<p style="margin-left:11%;"><b>−x</b> <i>xres</i></p> - -<p style="margin-left:22%;">Set x/width resolution -default.</p> - -<p style="margin-left:11%;"><b>−y</b> <i>yres</i></p> - -<p style="margin-left:22%;">Set y/length resolution -default.</p> - -<p style="margin-left:11%;"><b>−r</b> -[<b>d</b>|<b>o</b>]</p> - -<p style="margin-left:22%;">Set <b>d</b> for resolution -default for images without resolution, <b>o</b> for -resolution override for all images.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−f</b></p></td> -<td width="8%"></td> -<td width="60%"> - - -<p>Set PDF ‘‘Fit Window’’ user -preference.</p> </td> -<td width="18%"> -</td></tr> -</table> - -<p style="margin-left:11%;"><b>−e</b> -<i>YYYYMMDDHHMMSS</i></p> - -<p style="margin-left:22%;">Set document information date, -overrides image or current date/time default, -<i>YYYYMMDDHHMMSS.</i></p> - -<p style="margin-left:11%;"><b>−c</b> -<i>creator</i></p> - -<p style="margin-left:22%;">Set document information -creator, overrides image software default.</p> - -<p style="margin-left:11%;"><b>−a</b> -<i>author</i></p> - -<p style="margin-left:22%;">Set document information -author, overrides image artist default.</p> - -<p style="margin-left:11%;"><b>−t</b> -<i>title</i></p> - -<p style="margin-left:22%;">Set document information title, -overrides image document name default.</p> - -<p style="margin-left:11%;"><b>−s</b> -<i>subject</i></p> - -<p style="margin-left:22%;">Set document information -subject, overrides image image description default.</p> - -<p style="margin-left:11%;"><b>−k</b> -<i>keywords</i></p> - -<p style="margin-left:22%;">Set document information -keywords.</p> - -<p style="margin-left:11%;"><b>−m</b> <i>size</i></p> - -<p style="margin-left:22%;">Set memory allocation limit (in -MiB). Default is 256MiB. Set to 0 to disable the limit.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−h</b></p></td> -<td width="8%"></td> -<td width="60%"> - - -<p>List usage reminder to stderr and exit.</p></td> -<td width="18%"> -</td></tr> -</table> - -<h2>EXAMPLES -<a name="EXAMPLES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The following -example would generate the file output.pdf from <br> -input.tiff.</p> - -<p style="margin-left:22%;">tiff2pdf −o output.pdf -input.tiff</p> - -<p style="margin-left:11%; margin-top: 1em">The following -example would generate PDF output from input.tiff and write -it to standard output.</p> - -<p style="margin-left:22%;">tiff2pdf input.tiff</p> - -<p style="margin-left:11%; margin-top: 1em">The following -example would generate the file output.pdf from input.tiff, -putting the image pages on a letter sized page, compressing -the output with JPEG, with JPEG quality 75, setting the -title to ‘‘Document’’, and setting -the ‘‘Fit Window’’ option.</p> - -<p style="margin-left:22%;">tiff2pdf −p letter -−j −q 75 −t "Document" −f -−o output.pdf input.tiff</p> - -<h2>BUGS -<a name="BUGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Please report -bugs via the web interface at</p> - - -<p style="margin-left:22%; margin-top: 1em">http://bugzilla.remotesensing.org/enter_bug.cgi?product=libtiff</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>libtiff</b>(3), -<b>tiffcp</b>(1), <b>tiff2ps</b>(1)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiff2ps.1.html b/doc/static/man/tiff2ps.1.html deleted file mode 100644 index d480a0ad..00000000 --- a/doc/static/man/tiff2ps.1.html +++ /dev/null @@ -1,544 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:28 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFF2PS</title> - -</head> -<body> - -<h1 align="center">TIFF2PS</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#EXAMPLES">EXAMPLES</a><br> -<a href="#BUGS">BUGS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiff2ps − -convert a <small>TIFF</small> image to PostScript™</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>tiff2ps</b> -[ <i>options</i> ] <i>input.tif ...</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><i>tiff2ps</i> -reads <small>TIFF</small> images and writes PostScript or -Encapsulated PostScript (EPS) on the standard output. By -default, <i>tiff2ps</i> writes Encapsulated PostScript for -the first image in the specified <small>TIFF</small> image -file.</p> - -<p style="margin-left:11%; margin-top: 1em">By default, -<i>tiff2ps</i> will generate PostScript that fills a printed -area specified by the <small>TIFF</small> tags in the input -file. If the file does not contain <i>XResolution</i> or -<i>YResolution</i> tags, then the printed area is set -according to the image dimensions. The <b>−w</b> and -<b>−h</b> options (see below) can be used to set the -dimensions of the printed area in inches; overriding any -relevant <small>TIFF</small> tags.</p> - -<p style="margin-left:11%; margin-top: 1em">The PostScript -generated for <small>RGB,</small> palette, and -<small>CMYK</small> images uses the <i>colorimage</i> -operator. The PostScript generated for greyscale and bilevel -images uses the <i>image</i> operator. When the -<i>colorimage</i> operator is used, PostScript code to -emulate this operator on older PostScript printers is also -generated. Note that this emulation code can be very -slow.</p> - -<p style="margin-left:11%; margin-top: 1em">Color images -with associated alpha data are composited over a white -background.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−1</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Generate PostScript Level 1 (the -default).</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−2</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Generate PostScript Level 2.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−3</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Generate PostScript Level 3. It basically allows one to -use the /flateDecode filter for ZIP compressed TIFF -images.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−8</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Disable use of ASCII85 encoding with PostScript Level -2/3.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−a</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Generate output for all IFDs (pages) in the input -file.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−b</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the bottom margin for the output (in inches). -This does not affect the height of the printed image.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Center the image in the output. This option only shows -an effect if both the <b>−w</b> and the -<b>−h</b> option are given.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−C</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the document creator name.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−d</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Set the initial <small>TIFF</small> directory to the -specified directory number. (NB: Directories are numbered -starting at zero.) This option is useful for selecting -individual pages in a multi-page (e.g. facsimile) file.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−D</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Enable duplex printing (two pages per sheet of -paper).</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−e</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force the generation of Encapsulated PostScript (implies -<b>−z</b>).</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−h</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the vertical size of the printed area (in -inches).</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−H</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the maximum height of image (in inches). Images -with larger sizes will be split in several pages. Option -<b>−L</b> may be used for specifying size of split -images overlapping. <b>−i</b> Enable/disable pixel -interpolation. This option requires a single numeric value: -zero to disable pixel interpolation and non-zero to enable. -The default is enabled.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−L</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the size of overlapping for split images (in -inches). Used in conjunction with <b>−H</b> and -<b>−W</b> options.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−l</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the left margin for the output (in inches). This -does not affect the width of the printed image.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−M</b> <i>size</i></p> - -<p style="margin-left:22%;">Set maximum memory allocation -size (in MiB). The default is 256MiB. Set to 0 to disable -the limit.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>−m</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Where possible render using the <i>imagemask</i> -PostScript operator instead of the <i>image</i> operator. -When this option is specified <i>tiff2ps</i> will use -<i>imagemask</i> for rendering 1 bit deep images. If this -option is not specified or if the image depth is greater -than 1 then the <i>image</i> operator is used.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>−o</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Set the initial <small>TIFF</small> directory to the -<small>IFD</small> at the specified file offset. This option -is useful for selecting thumbnail images and the like which -are hidden using the <i>SubIFD</i> tag.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>−O</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Write PostScript to specified file instead of standard -output.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>−p</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Force the generation of (non-Encapsulated) -PostScript.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>−P L|P</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Set optional PageOrientation DSC comment to Landscape or -Portrait.</p> </td></tr> -</table> - -<p style="margin-left:11%;"><b>−r -90|180|270|auto</b></p> - -<p style="margin-left:22%;">Rotate image by 90, 180, 270 -degrees or auto. Auto picks the best fit for the image on -the specified paper size (eg portrait or landscape) if -h or --w is specified. Rotation is in degrees counterclockwise. -Auto rotates 90 degrees ccw to produce landscape.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−s</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Generate output for a single IFD (page) in the input -file.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−t</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the document title string.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−T</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Print pages for top edge binding.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−w</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the horizontal size of the printed area (in -inches).</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−W</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the maximum width of image (in inches). Images -with larger sizes will be split in several pages. Options -<b>−L</b> and <b>−W</b> are mutually -exclusive.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−x</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Override resolution units specified in the TIFF as -centimeters.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−y</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Override resolution units specified in the TIFF as -inches.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−z</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>When generating PostScript Level 2, data is scaled so -that it does not image into the <i>deadzone</i> on a page -(the outer margin that the printing device is unable to -mark). This option suppresses this behavior. When PostScript -Level 1 is generated, data is imaged to the entire printed -page and this option has no affect.</p></td></tr> -</table> - -<h2>EXAMPLES -<a name="EXAMPLES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The following -generates PostScript Level 2 for all pages of a -facsimile:</p> - -<p style="margin-left:22%;">tiff2ps −a2 fax.tif | -lpr</p> - -<p style="margin-left:11%;">Note also that if you have -version 2.6.1 or newer of Ghostscript then you can -efficiently preview facsimile generated with the above -command.</p> - -<p style="margin-left:11%; margin-top: 1em">To generate -Encapsulated PostScript for a the image at directory 2 of an -image use:</p> - -<p style="margin-left:22%;">tiff2ps −d 1 foo.tif</p> - -<p style="margin-left:11%;">(Notice that directories are -numbered starting at zero.)</p> - -<p style="margin-left:11%; margin-top: 1em">If you have a -long image, it may be split in several pages:</p> - -<p style="margin-left:22%;">tiff2ps −h11 −w8.5 -−H14 −L.5 foo.tif > foo.ps</p> - -<p style="margin-left:11%;">The page size is set to 8.5x11 -by <b>−w</b> and <b>−h</b> options. We will -accept a small amount of vertical compression, so -<b>−H</b> set to 14. Any pages between 11 and 14 -inches will be fit onto one page. Pages longer than 14 -inches are cut off at 11 and continued on the next page. The -<b>−L.5</b> option says to repeat a half inch on the -next page (to improve readability).</p> - -<h2>BUGS -<a name="BUGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Because -PostScript does not support the notion of a colormap, 8-bit -palette images produce 24-bit PostScript images. This -conversion results in output that is six times bigger than -the original image and which takes a long time to send to a -printer over a serial line. Matters are even worse for 4-, -2-, and 1-bit palette images.</p> - -<p style="margin-left:11%; margin-top: 1em">Does not handle -tiled images when generating PostScript Level I output.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>pal2rgb</b>(1), -<b>tiffinfo</b>(1), <b>tiffcp</b>(1), <b>tiffgt</b>(1), -<b>tiffmedian</b>(1), <b>tiff2bw</b>(1), <b>tiffsv</b>(1), -<b>libtiff</b>(3)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiff2rgba.1.html b/doc/static/man/tiff2rgba.1.html deleted file mode 100644 index a5cd1d23..00000000 --- a/doc/static/man/tiff2rgba.1.html +++ /dev/null @@ -1,165 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:29 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFF2RGBA</title> - -</head> -<body> - -<h1 align="center">TIFF2RGBA</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiff2rgba -− convert a <small>TIFF</small> image to RGBA color -space</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiff2rgba</b> -[ <i>options</i> ] <i>input.tif output.tif</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>Tiff2rgba</i> -converts a wide variety of TIFF images into an RGBA TIFF -image. This includes the ability to translate different -color spaces and photometric interpretation into RGBA, -support for alpha blending, and translation of many -different bit depths into a 32bit RGBA image.</p> - -<p style="margin-left:11%; margin-top: 1em">Internally this -program is implemented using the <i>TIFFReadRGBAImage()</i> -function, and it suffers any limitations of that image. This -includes limited support for > 8 BitsPerSample images, -and flaws with some esoteric combinations of BitsPerSample, -photometric interpretation, block organization and planar -configuration.</p> - -<p style="margin-left:11%; margin-top: 1em">The generated -images are stripped images with four samples per pixel (red, -green, blue and alpha) or if the <b>−n</b> flag is -used, three samples per pixel (red, green, and blue). The -resulting images are always planar configuration contiguous. -For this reason, this program is a useful utility for -transform exotic TIFF files into a form ingestible by almost -any TIFF supporting software.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Specify a compression scheme to -use when writing image data: <b>−c none</b> for no -compression (the default), <b>−c packbits</b> for the -PackBits compression algorithm, <b>−c zip</b> for the -Deflate compression algorithm, <b>−c jpeg</b> for the -JPEG compression algorithm, and <b>−c lzw</b> for -Lempel-Ziv & Welch.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−r</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Write data with a specified number of rows per strip; by -default the number of rows/strip is selected so that each -strip is approximately 8 kilobytes.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−b</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Process the image one block (strip/tile) at a time -instead of by reading the whole image into memory at once. -This may be necessary for very large images on systems with -limited RAM.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−n</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Drop the alpha component from the output file, producing -a pure RGB file. Currently this does not work if the -<b>−b</b> flag is also in effect.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−M</b> <i>size</i></p> - -<p style="margin-left:22%;">Set maximum memory allocation -size (in MiB). The default is 256MiB. Set to 0 to disable -the limit.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiff2bw</b>(1), -<b>TIFFReadRGBAImage</b>(3t), <b>libtiff</b>(3)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiffcmp.1.html b/doc/static/man/tiffcmp.1.html deleted file mode 100644 index 419a6f94..00000000 --- a/doc/static/man/tiffcmp.1.html +++ /dev/null @@ -1,144 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:29 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFCMP</title> - -</head> -<body> - -<h1 align="center">TIFFCMP</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#BUGS">BUGS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiffcmp − -compare two <small>TIFF</small> files</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffcmp</b> -[ <i>options</i> ] <i>file1.tif file2.tif</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><i>Tiffcmp</i> -compares the tags and data in two files created according to -the Tagged Image File Format, Revision 6.0. The schemes used -for compressing data in each file are immaterial when data -are compared−data are compared on a -scanline-by-scanline basis after decompression. Most -directory tags are checked; notable exceptions are: -<i>GrayResponseCurve</i>, <i>ColorResponseCurve</i>, and -<i>ColorMap</i> tags. Data will not be compared if any of -the <i>BitsPerSample</i>, <i>SamplesPerPixel</i>, or -<i>ImageWidth</i> values are not equal. By default, -<i>tiffcmp</i> will terminate if it encounters any -difference.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−l</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">List each byte of image data -that differs between the files.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−z</b> -<i>number</i></p> - -<p style="margin-left:22%;">List specified number of image -data bytes that differs between the files.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−t</b></p></td> -<td width="8%"></td> -<td width="63%"> - - -<p>Ignore any differences in directory tags.</p></td> -<td width="15%"> -</td></tr> -</table> - -<h2>BUGS -<a name="BUGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Tags that are -not recognized by the library are not compared; they may -also generate spurious diagnostics.</p> - -<p style="margin-left:11%; margin-top: 1em">The image data -of tiled files is not compared, since the -<i>TIFFReadScanline()</i> function is used. An error will be -reported for tiled files.</p> - -<p style="margin-left:11%; margin-top: 1em">The pixel -and/or sample number reported in differences may be off in -some exotic cases.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>pal2rgb</b>(1), -<b>tiffinfo</b>(1), <b>tiffcp</b>(1), <b>tiffmedian</b>(1), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiffcp.1.html b/doc/static/man/tiffcp.1.html deleted file mode 100644 index fa036cb4..00000000 --- a/doc/static/man/tiffcp.1.html +++ /dev/null @@ -1,474 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:29 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFCP</title> - -</head> -<body> - -<h1 align="center">TIFFCP</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#EXAMPLES">EXAMPLES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiffcp − -copy (and possibly convert) a <small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffcp</b> [ -<i>options</i> ] <i>src1.tif ... srcN.tif dst.tif</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><i>tiffcp</i> -combines one or more files created according to the Tag -Image File Format, Revision 6.0 into a single -<small>TIFF</small> file. Because the output file may be -compressed using a different algorithm than the input files, -<i>tiffcp</i> is most often used to convert between -different compression schemes.</p> - -<p style="margin-left:11%; margin-top: 1em">By default, -<i>tiffcp</i> will copy all the understood tags in a -<small>TIFF</small> directory of an input file to the -associated directory in the output file.</p> - -<p style="margin-left:11%; margin-top: 1em"><i>tiffcp</i> -can be used to reorganize the storage characteristics of -data in a file, but it is explicitly intended to not alter -or convert the image data content in any way.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−a</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Append to an existing output -file instead of overwriting it.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−b</b> -<i>image</i></p> - -<p style="margin-left:22%;">subtract the following -monochrome image from all others processed. This can be used -to remove a noise bias from a set of images. This bias image -is typically an image of noise the camera saw with its -shutter closed.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−B</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force output to be written with Big-Endian byte order. -This option only has an effect when the output file is -created or overwritten and not when it is appended to.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−C</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Suppress the use of ‘‘strip -chopping’’ when reading images that have a -single strip/tile of uncompressed data.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the compression to use for data written to the -output file: <b>none</b> for no compression, <b>packbits</b> -for PackBits compression, <b>lzw</b> for Lempel-Ziv & -Welch compression, <b>zip</b> for Deflate compression, -<b>lzma</b> for LZMA2 compression, <b>jpeg</b> for baseline -JPEG compression, <b>g3</b> for CCITT Group 3 (T.4) -compression, <b>g4</b> for CCITT Group 4 (T.6) compression, -or <b>sgilog</b> for SGILOG compression. By default -<i>tiffcp</i> will compress data according to the value of -the <i>Compression</i> tag found in the source file.</p></td></tr> -</table> - -<p style="margin-left:22%; margin-top: 1em">The -<small>CCITT</small> Group 3 and Group 4 compression -algorithms can only be used with bilevel data.</p> - -<p style="margin-left:22%; margin-top: 1em">Group 3 -compression can be specified together with several -T.4-specific options: <b>1d</b> for 1-dimensional encoding, -<b>2d</b> for 2-dimensional encoding, and <b>fill</b> to -force each encoded scanline to be zero-filled so that the -terminating EOL code lies on a byte boundary. Group -3-specific options are specified by appending a -‘‘:’’-separated list to the -‘‘g3’’ option; e.g. <b>−c -g3:2d:fill</b> to get 2D-encoded data with byte-aligned EOL -codes.</p> - -<p style="margin-left:22%; margin-top: 1em"><small>LZW, -Deflate</small> and <small>LZMA2</small> compression can be -specified together with a <i>predictor</i> value. A -predictor value of 2 causes each scanline of the output -image to undergo horizontal differencing before it is -encoded; a value of 1 forces each scanline to be encoded -without differencing. A value 3 is for floating point -predictor which you can use if the encoded data are in -floating point format. LZW-specific options are specified by -appending a ‘‘:’’-separated list to -the ‘‘lzw’’ option; e.g. <b>−c -lzw:2</b> for <small>LZW</small> compression with horizontal -differencing.</p> - - -<p style="margin-left:22%; margin-top: 1em"><small>Deflate</small> -and <small>LZMA2</small> encoders support various -compression levels (or encoder presets) set as character -‘‘p’’ and a preset number. -‘‘p1’’ is the fastest one with the -worst compression ratio and ‘‘p9’’ -is the slowest but with the best possible ratio; e.g. -<b>−c zip:3:p9</b> for <small>Deflate</small> encoding -with maximum compression level and floating point -predictor.</p> - -<p style="margin-left:22%; margin-top: 1em">For the -<small>Deflate</small> codec, and in a libtiff build with -libdeflate enabled, ‘‘p12‘‘ is -actually the maximum level.</p> - -<p style="margin-left:22%; margin-top: 1em">For the -<small>Deflate</small> codec, and in a libtiff build with -libdeflate enabled, ‘‘s0‘‘ can be -used to require zlib to be used, and -‘‘s1‘‘ for libdeflate (defaults to -libdeflate when it is available).</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−f</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Specify the bit fill order to -use in writing output data. By default, <i>tiffcp</i> will -create a new file with the same fill order as the original. -Specifying <b>−f lsb2msb</b> will force data to be -written with the FillOrder tag set to -<small>LSB2MSB,</small> while <b>−f msb2lsb</b> will -force data to be written with the FillOrder tag set to -<small>MSB2LSB.</small></p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−i</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Ignore non-fatal read errors and continue processing of -the input file.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−l</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the length of a tile (in pixels). <i>tiffcp</i> -attempts to set the tile dimensions so that no more than 8 -kilobytes of data appear in a tile.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−L</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force output to be written with Little-Endian byte -order. This option only has an effect when the output file -is created or overwritten and not when it is appended -to.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−M</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Suppress the use of memory-mapped files when reading -images.</p> </td></tr> -</table> - -<p style="margin-left:11%;"><b>−o</b> -<i>offset</i></p> - -<p style="margin-left:22%;">Set initial directory -offset.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−p</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the planar configuration to use in writing image -data that has one 8-bit sample per pixel. By default, -<i>tiffcp</i> will create a new file with the same planar -configuration as the original. Specifying <b>−p -contig</b> will force data to be written with multi-sample -data packed together, while <b>−p separate</b> will -force samples to be written in separate planes.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−r</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the number of rows (scanlines) in each strip of -data written to the output file. By default (or when value -<b>0</b> is specified), <i>tiffcp</i> attempts to set the -rows/strip that no more than 8 kilobytes of data appear in a -strip. If you specify special value <b>−1</b> it will -results in infinite number of the rows per strip. The entire -image will be the one strip in that case.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−s</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force the output file to be written with data organized -in strips (rather than tiles).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−t</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force the output file to be written with data organized -in tiles (rather than strips). options can be used to force -the resultant image to be written as strips or tiles of -data, respectively.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−w</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the width of a tile (in pixels). <i>tiffcp</i> -attempts to set the tile dimensions so that no more than 8 -kilobytes of data appear in a tile. <i>tiffcp</i> attempts -to set the tile dimensions so that no more than 8 kilobytes -of data appear in a tile.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−x</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force the output file to be written with PAGENUMBER -value in sequence.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−8</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Write BigTIFF instead of classic TIFF format.</p></td></tr> -</table> - - -<p style="margin-left:11%;"><b>−,=</b><i>character</i></p> - -<p style="margin-left:22%;">substitute <i>character</i> for -‘,’ in parsing image directory indices in files. -This is necessary if filenames contain commas. Note that -<b>−,=</b> with whitespace immediately following will -disable the special meaning of the ‘,’ entirely. -See examples.</p> - -<p style="margin-left:11%;"><b>−m</b> <i>size</i></p> - -<p style="margin-left:22%;">Set maximum memory allocation -size (in MiB). The default is 256MiB. Set to 0 to disable -the limit.</p> - -<h2>EXAMPLES -<a name="EXAMPLES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The following -concatenates two files and writes the result using -<small>LZW</small> encoding:</p> - -<p style="margin-left:22%;">tiffcp −c lzw a.tif b.tif -result.tif</p> - -<p style="margin-left:11%; margin-top: 1em">To convert a G3 -1d-encoded <small>TIFF</small> to a single strip of -G4-encoded data the following might be used:</p> - -<p style="margin-left:22%;">tiffcp −c g4 −r -10000 g3.tif g4.tif</p> - -<p style="margin-left:11%;">(1000 is just a number that is -larger than the number of rows in the source file.)</p> - -<p style="margin-left:11%; margin-top: 1em">To extract a -selected set of images from a multi-image TIFF file, the -file name may be immediately followed by a ‘,’ -separated list of image directory indices. The first image -is always in directory 0. Thus, to copy the 1st and 3rd -images of image file ‘‘album.tif’’ -to ‘‘result.tif’’:</p> - -<p style="margin-left:22%;">tiffcp album.tif,0,2 -result.tif</p> - -<p style="margin-left:11%; margin-top: 1em">A trailing -comma denotes remaining images in sequence. The following -command will copy all image with except the first one:</p> - -<p style="margin-left:22%;">tiffcp album.tif,1, -result.tif</p> - -<p style="margin-left:11%; margin-top: 1em">Given file -‘‘CCD.tif’’ whose first image is a -noise bias followed by images which include that bias, -subtract the noise from all those images following it (while -decompressing) with the command:</p> - -<p style="margin-left:22%;">tiffcp −c none −b -CCD.tif CCD.tif,1, result.tif</p> - -<p style="margin-left:11%; margin-top: 1em">If the file -above were named ‘‘CCD,X.tif’’, the -<b>−,=</b> option would be required to correctly parse -this filename with image numbers, as follows:</p> - -<p style="margin-left:22%;">tiffcp −c none −,=% -−b CCD,X.tif CCD,X%1%.tif result.tif</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>pal2rgb</b>(1), -<b>tiffinfo</b>(1), <b>tiffcmp</b>(1), <b>tiffmedian</b>(1), -<b>tiffsplit</b>(1), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiffcrop.1.html b/doc/static/man/tiffcrop.1.html deleted file mode 100644 index 1007c0bb..00000000 --- a/doc/static/man/tiffcrop.1.html +++ /dev/null @@ -1,868 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:29 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFCROP</title> - -</head> -<body> - -<h1 align="center">TIFFCROP</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#EXAMPLES">EXAMPLES</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiffcrop -− select, copy, crop, convert, extract, and/or process -one or more <small>TIFF</small> files.</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffcrop</b> -[ <i>options</i> ] <i>src1.tif ... srcN.tif dst.tif</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>Tiffcrop</i> -processes one or more files created according to the Tag -Image File Format, Revision 6.0, specification into one or -more <small>TIFF</small> file(s). <i>Tiffcrop</i> is most -often used to extract portions of an image for processing -with bar code recognizer or OCR software when that software -cannot restrict the region of interest to a specific portion -of the image or to improve efficiency when the regions of -interest must be rotated. It can also be used to subdivide -all or part of a processed image into smaller sections and -export individual images or sections of images as separate -files or separate images within one or more files derived -from the original input image or images.</p> - -<p style="margin-left:11%; margin-top: 1em">The available -functions can be grouped broadly into three classes:</p> - -<p style="margin-left:22%; margin-top: 1em">Those that -select individual images or sections of images from the -input files. The options −N for sequences or lists of -individual images in the input files, −Z for zones, -−z for regions, −X and −Y for fixed sized -selections, −m for margins, −U for units, and -−E for edge reference provide a variety of ways to -specify portions of the input image.</p> - -<p style="margin-left:22%; margin-top: 1em">Those that -allow the individual images or selections to be exported to -one or more output files in different groupings and control -the organization of the data in the output images. The -options −P for page size grouping, −S for -subdivision into columns and rows and −e for export -mode options that produce one or more files from each input -image. The options −r, −s, −t, −w -control strip and tile format and sizes while −B -−L −c −f modify the endian addressing -scheme, the compression options, and the bit fill sequence -of images as they are written.</p> - -<p style="margin-left:22%; margin-top: 1em">Those that -perform some action on each image that is selected from the -input file. The options include −R for rotate, -−I for inversion of the photometric interpretation -and/or data values, and −F to flip (mirror) the image -horizontally or vertically.</p> - -<p style="margin-left:11%; margin-top: 1em">Functions are -applied to the input image(s) in the following order: -cropping, fixed area extraction, zone and region extraction, -inversion, mirroring, rotation.</p> - -<p style="margin-left:11%; margin-top: 1em">Functions are -applied to the output image(s) in the following order: -export mode options for grouping zones, regions, or images -into one or more files, <i>or</i> row and column divisions -with output margins, <i>or</i> page size divisions with page -orientation options.</p> - -<p style="margin-left:11%; margin-top: 1em">Finally, strip, -tile, byte order, output resolution, and compression options -are applied to all output images.</p> - -<p style="margin-left:11%; margin-top: 1em">The output -file(s) may be organized and compressed using a different -algorithm from the input files. By default, <i>tiffcrop</i> -will copy all the understood tags in a <small>TIFF</small> -directory of an input file to the associated directory in -the output file. Options can be used to force the resultant -image to be written as strips or tiles of data, -respectively.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>Tiffcrop</i> -can be used to reorganize the storage characteristics of -data in a file, and to reorganize, extract, rotate, and -otherwise process the image data as specified at the same -time whereas tiffcp does not alter the image data within the -file.</p> - -<p style="margin-left:11%; margin-top: 1em">Using the -options for selecting individual input images and the -options for exporting images and/or segments defined as -zones or regions of each input image, <i>tiffcrop</i> can -perform the functions of tiffcp and tiffsplit in a single -pass while applying multiple operations to individual -selections or images.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−h</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Display the syntax summary for -tiffcrop.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−v</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Report the current version and last modification date -for tiffcrop.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−N -odd|even|#,#−#,#|last</b></p> - -<p style="margin-left:22%;">Specify one or more series or -range(s) of images within each file to process. The words -<b>odd</b> or <b>even</b> may be used to specify all odd or -even numbered images counting from one. Note that -internally, TIFF images are numbered from zero rather than -one but since this convention is not obvious to most users, -tiffcrop used 1 to specify the first image in a multipage -file. The word <b>last</b> may be used in place of a number -in the sequence to indicate the final image in the file -without knowing how many images there are. Ranges of images -may be specified with a dash and multiple sets can be -indicated by joining them in a comma−separated list. -eg. use <b>−N 1,5−7,last</b> to process the 1st, -5th through 7th, and final image in the file.</p> - -<p style="margin-left:11%;"><b>−E -top|bottom|left|right</b></p> - -<p style="margin-left:22%;">Specify the top, bottom, left, -or right edge as the reference from which to calculate the -width and length of crop regions or sequence of positions -for zones. When used with the −e option for exporting -zones or regions, the reference edge determines how -composite images are arranged. Using −E left or right -causes successive zones or regions to be merged horizontally -whereas using −E top or bottom causes successive zones -or regions to be arranged vertically. This option has no -effect on export layout when multiple zones or regions are -not being exported to composite images. Edges may be -abbreviated to the first letter.</p> - -<p style="margin-left:11%;"><b>−e -combined|divided|image|multiple|separate</b></p> - -<p style="margin-left:22%;">Specify the export mode for -images and selections from input images. The final filename -on the command line is considered to be the destination file -or filename stem for automatically generated sequences of -files. Modes may be abbreviated to the first letter.</p> - -<p style="margin-left:22%; margin-top: 1em">combined All -images and selections are written to a single file with -multiple selections from one image combined into a single -image (default)</p> - -<p style="margin-left:22%; margin-top: 1em">divided All -images and selections are written to a single file with each -selection from one image written to a new image</p> - -<p style="margin-left:22%; margin-top: 1em">image Each -input image is written to a new file (numeric filename -sequence) with multiple selections from the image combined -into one image</p> - -<p style="margin-left:22%; margin-top: 1em">multiple Each -input image is written to a new file (numeric filename -sequence) with each selection from the image written to a -new image</p> - -<p style="margin-left:22%; margin-top: 1em">separate -Individual selections from each image are written to -separate files</p> - -<p style="margin-left:11%;"><b>−U in|cm|px</b></p> - -<p style="margin-left:22%;">Specify the type of units to -apply to dimensions for margins and crop regions for input -and output images. Inches or centimeters are converted to -pixels using the resolution unit specified in the TIFF file -(which defaults to inches if not specified in the IFD).</p> - -<p style="margin-left:11%;"><b>−m #,#,#,#</b></p> - -<p style="margin-left:22%;">Specify margins to be removed -from the input image. The order must be top, left, bottom, -right with only commas separating the elements of the list. -Margins are scaled according to the current units and -removed before any other extractions are computed..</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="6%"> - - -<p><b>−X #</b></p></td> -<td width="5%"></td> -<td width="78%"> - - -<p>Set the horizontal (X−axis) dimension of a region -to extract relative to the specified origin reference. If -the origin is the top or bottom edge, the X axis value will -be assumed to start at the left edge.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="6%"> - - -<p><b>−Y #</b></p></td> -<td width="5%"></td> -<td width="78%"> - - -<p>Set the vertical (Y−axis) dimension of a region to -extract relative to the specified origin reference. If the -origin is the left or right edge, the Y axis value will be -assumed to start at the top.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−Z #:#,#:#</b></p> - -<p style="margin-left:22%;">Specify zones of the image -designated as position X of Y equal sized portions measured -from the reference edge, eg 1:3 would be first third of the -image starting from the reference edge minus any margins -specified for the confining edges. Multiple zones can be -specified as a comma separated list but they must reference -the same edge. To extract the top quarter and the bottom -third of an image you would use <b>−Z 1:4,3:3.</b></p> - -<p style="margin-left:11%;"><b>−z x1,y1,x2,y2: ... -:xN,yN,xN+1,yN+1</b></p> - -<p style="margin-left:22%;">Specify a series of coordinates -to define regions for processing and exporting. The -coordinates represent the top left and lower right corners -of each region in the current units, eg inch, cm, or pixels. -Pixels are counted from one to width or height and inches or -cm are calculated from image resolution data.</p> - -<p style="margin-left:22%; margin-top: 1em">Each colon -delimited series of four values represents the horizontal -and vertical offsets from the top and left edges of the -image, regardless of the edge specified with the −E -option. The first and third values represent the horizontal -offsets of the corner points from the left edge while the -second and fourth values represent the vertical offsets from -the top edge.</p> - -<p style="margin-left:11%;"><b>−F horiz|vert</b></p> - -<p style="margin-left:22%;">Flip, ie mirror, the image or -extracted region horizontally or vertically.</p> - -<p style="margin-left:11%;"><b>−R 90|180|270</b></p> - -<p style="margin-left:22%;">Rotate the image or extracted -region 90, 180, or 270 degrees clockwise.</p> - -<p style="margin-left:11%;"><b>−I -[black|white|data|both]</b></p> - -<p style="margin-left:22%;">Invert color space, eg dark to -light for bilevel and grayscale images. This can be used to -modify negative images to positive or to correct images that -have the PHOTOMETRIC_INTERPRETATIN tag set incorrectly. If -the value is black or white, the PHOTOMETRIC_INTERPRETATION -tag is set to MinIsBlack or MinIsWhite, without altering the -image data. If the argument is data or both, the data values -of the image are modified. Specifying both inverts the data -and the PHOTOMETRIC_INTERPRETATION tag, whereas using data -inverts the data but not the PHOTOMETRIC_INTERPRETATION tag. -No support for modifying the color space of color images in -this release.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="6%"> - - -<p><b>−H #</b></p></td> -<td width="5%"></td> -<td width="78%"> - - -<p>Set the horizontal resolution of output images to # -expressed in the current units.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="6%"> - - -<p><b>−V #</b></p></td> -<td width="5%"></td> -<td width="78%"> - - -<p>Set the vertical resolution of the output images to # -expressed in the current units.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="6%"> - - -<p><b>−J #</b></p></td> -<td width="5%"></td> -<td width="78%"> - - -<p>Set the horizontal margin of an output page size to # -expressed in the current units when sectioning image into -columns x rows subimages using the −S cols:rows -option.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="6%"> - - -<p><b>−K #</b></p></td> -<td width="5%"></td> -<td width="78%"> - - -<p>Set the vertical margin of an output page size to # -expressed in the current units when sectioning image into -columns x rows submiages using the −S cols:rows -option.</p> </td></tr> -</table> - -<p style="margin-left:11%;"><b>−O -portrait|landscape|auto</b></p> - -<p style="margin-left:22%;">Set the output orientation of -the pages or sections. Auto will use the arrangement that -requires the fewest pages. This option is only meaningful in -conjunction with the -P option to format an image to fit on -a specific paper size.</p> - -<p style="margin-left:11%;"><b>−P page</b></p> - -<p style="margin-left:22%;">Format the output images to fit -on page size paper. Use −P list to show the supported -page sizes and dimensions. You can define a custom page size -by entering the width and length of the page in the current -units with the following format #.#x#.#.</p> - -<p style="margin-left:11%;"><b>−S cols:rows</b></p> - -<p style="margin-left:22%;">Divide each image into cols -across and rows down equal sections.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−B</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force output to be written with Big−Endian byte -order. This option only has an effect when the output file -is created or overwritten and not when it is appended -to.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−C</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Suppress the use of ‘‘strip -chopping’’ when reading images that have a -single strip/tile of uncompressed data.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the compression to use for data written to the -output file: <b>none</b> for no compression, <b>packbits</b> -for PackBits compression, <b>lzw</b> for Lempel−Ziv -& Welch compression, <b>jpeg</b> for baseline JPEG -compression. <b>zip</b> for Deflate compression, <b>g3</b> -for CCITT Group 3 (T.4) compression, and <b>g4</b> for CCITT -Group 4 (T.6) compression. By default <i>tiffcrop</i> will -compress data according to the value of the -<i>Compression</i> tag found in the source file.</p></td></tr> -</table> - -<p style="margin-left:22%; margin-top: 1em">The -<small>CCITT</small> Group 3 and Group 4 compression -algorithms can only be used with bilevel data.</p> - -<p style="margin-left:22%; margin-top: 1em">Group 3 -compression can be specified together with several -T.4−specific options: <b>1d</b> for -1−dimensional encoding, <b>2d</b> for -2−dimensional encoding, and <b>fill</b> to force each -encoded scanline to be zero−filled so that the -terminating EOL code lies on a byte boundary. Group -3−specific options are specified by appending a -‘‘:’’−separated list to the -‘‘g3’’ option; e.g. <b>−c -g3:2d:fill</b> to get 2D−encoded data with -byte−aligned EOL codes.</p> - - -<p style="margin-left:22%; margin-top: 1em"><small>LZW</small> -compression can be specified together with a -<i>predictor</i> value. A predictor value of 2 causes each -scanline of the output image to undergo horizontal -differencing before it is encoded; a value of 1 forces each -scanline to be encoded without differencing. -LZW−specific options are specified by appending a -‘‘:’’−separated list to the -‘‘lzw’’ option; e.g. <b>−c -lzw:2</b> for <small>LZW</small> compression with horizontal -differencing.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−f</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Specify the bit fill order to -use in writing output data. By default, <i>tiffcrop</i> will -create a new file with the same fill order as the original. -Specifying <b>−f lsb2msb</b> will force data to be -written with the FillOrder tag set to -<small>LSB2MSB,</small> while <b>−f msb2lsb</b> will -force data to be written with the FillOrder tag set to -<small>MSB2LSB.</small></p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−i</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Ignore non−fatal read errors and continue -processing of the input file.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−k size</b></p> - -<p style="margin-left:22%;">Set maximum memory allocation -size (in MiB). The default is 256MiB. Set to 0 to disable -the limit.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−l</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the length of a tile (in pixels). -<i>Tiffcrop</i> attempts to set the tile dimensions so that -no more than 8 kilobytes of data appear in a tile.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−L</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force output to be written with Little−Endian byte -order. This option only has an effect when the output file -is created or overwritten and not when it is appended -to.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−M</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Suppress the use of memory−mapped files when -reading images.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−p</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the planar configuration to use in writing image -data that has more than one sample per pixel. By default, -<i>tiffcrop</i> will create a new file with the same planar -configuration as the original. Specifying <b>−p -contig</b> will force data to be written with -multi−sample data packed together, while <b>−p -separate</b> will force samples to be written in separate -planes.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−r</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the number of rows (scanlines) in each strip of -data written to the output file. By default (or when value -<b>0</b> is specified), <i>tiffcrop</i> attempts to set the -rows/strip that no more than 8 kilobytes of data appear in a -strip. If you specify the special value <b>−1</b> it -will results in infinite number of the rows per strip. The -entire image will be the one strip in that case.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−s</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force the output file to be written with data organized -in strips (rather than tiles).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−t</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force the output file to be written with data organized -in tiles (rather than strips).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−w</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the width of a tile (in pixels). <i>tiffcrop</i> -attempts to set the tile dimensions so that no more than 8 -kilobytes of data appear in a tile. <i>tiffcrop</i> attempts -to set the tile dimensions so that no more than 8 kilobytes -of data appear in a tile.</p></td></tr> -</table> - -<p style="margin-left:11%;">Debug and dump facility</p> - -<p style="margin-left:22%;"><b>−D -opt1:value1,opt2:value2,opt3:value3:opt4:value4</b> Display -program progress and/or dump raw data to non−TIFF -files. Options include the following and must be joined as a -comma separated list. The use of this option is generally -limited to program debugging and development of future -options. An equal sign may be substituted for the colon in -option:value pairs.</p> - -<p style="margin-left:22%; margin-top: 1em">debug:N Display -limited program progress indicators where larger N increase -the level of detail.</p> - -<p style="margin-left:22%; margin-top: 1em">format:txt|raw -Format any logged data as ASCII text or raw binary values. -ASCII text dumps include strings of ones and zeroes -representing the binary values in the image data plus -identifying headers.</p> - -<p style="margin-left:22%; margin-top: 1em">level:N Specify -the level of detail presented in the dump files. This can -vary from dumps of the entire input or output image data to -dumps of data processed by specific functions. Current range -of levels is 1 to 3.</p> - - -<p style="margin-left:22%; margin-top: 1em">input:full−path−to−directory/input−dumpname</p> - - -<p style="margin-left:22%; margin-top: 1em">output:full−path−to−directory/output−dumpname</p> - -<p style="margin-left:22%; margin-top: 1em">When dump files -are being written, each image will be written to a separate -file with the name built by adding a numeric sequence value -to the dumpname and an extension of .txt for ASCII dumps or -.bin for binary dumps.</p> - -<p style="margin-left:22%; margin-top: 1em">The four -debug/dump options are independent, though it makes little -sense to specify a dump file without specifying a detail -level.</p> - -<p style="margin-left:22%; margin-top: 1em">Note: Tiffcrop -may be compiled with -DDEVELMODE to enable additional very -<br> -low level debug reporting.</p> - -<h2>EXAMPLES -<a name="EXAMPLES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The following -concatenates two files and writes the result using -<small>LZW</small> encoding:</p> - -<p style="margin-left:22%;">tiffcrop −c lzw a.tif -b.tif result.tif</p> - -<p style="margin-left:11%; margin-top: 1em">To convert a G3 -1d−encoded <small>TIFF</small> to a single strip of -G4−encoded data the following might be used:</p> - -<p style="margin-left:22%;">tiffcrop −c g4 −r -10000 g3.tif g4.tif</p> - -<p style="margin-left:11%;">(1000 is just a number that is -larger than the number of rows in the source file.)</p> - -<p style="margin-left:11%; margin-top: 1em">To extract a -selected set of images from a multi−image TIFF file -use the −N option described above. Thus, to copy the -1st and 3rd images of image file "album.tif" to -"result.tif":</p> - -<p style="margin-left:22%;">tiffcrop −N 1,3 album.tif -result.tif</p> - -<p style="margin-left:11%; margin-top: 1em">Invert a -bilevel image scan of a microfilmed document and crop off -margins of 0.25 inches on the left and right, 0.5 inch on -the top, and 0.75 inch on the bottom. From the remaining -portion of the image, select the second and third quarters, -ie, one half of the area left from the center to each -margin.</p> - -<p style="margin-left:22%;">tiffcrop −U in −m -0.5,0.25,0.75,0.25 −E left −Z 2:4,3:4 −I -both MicrofilmNegative.tif MicrofilmPostiveCenter.tif</p> - -<p style="margin-left:11%; margin-top: 1em">Extract only -the final image of a large Architectural E sized multipage -TIFF file and rotate it 90 degrees clockwise while -reformatting the output to fit on tabloid sized sheets with -one quarter of an inch on each side:</p> - -<p style="margin-left:22%;">tiffcrop −N last −R -90 −O auto −P tabloid −U in −J 0.25 -−K 0.25 −H 300 −V 300 -Big−PlatMap.tif BigPlatMap−Tabloid.tif</p> - -<p style="margin-left:11%;">The output images will have a -specified resolution of 300 dpi in both directions. The -orientation of each page will be determined by whichever -choice requires the fewest pages. To specify a specific -orientation, use the portrait or landscape option. The paper -size option does not resample the image. It breaks each -original image into a series of smaller images that will fit -on the target paper size at the specified resolution.</p> - -<p style="margin-left:11%; margin-top: 1em">Extract two -regions 2048 pixels wide by 2048 pixels high from each page -of a multi−page input file and write each region to a -separate output file.</p> - -<p style="margin-left:22%;">tiffcrop −U px −z -1,1,2048,2048:1,2049,2048,4097 −e separate -CheckScans.tiff Check</p> - -<p style="margin-left:11%;">The output file names will use -the stem Check with a numeric suffix which is incremented -for each region of each image, eg Check−001.tiff, -Check−002.tiff ... Check−NNN.tiff. To produce a -unique file for each page of the input image with one new -image for each region of the input image on that page, -change the export option to −e multiple.</p> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">In general, -bilevel, grayscale, palette and RGB(A) data with bit depths -from 1 to 32 bits should work in both interleaved and -separate plane formats. Unlike tiffcp, tiffcrop can read and -write tiled images with bits per sample that are not a -multiple of 8 in both interleaved and separate planar -format. Floating point data types are supported at bit depts -of 16, 24, 32 and 64 bits per sample.</p> - -<p style="margin-left:11%; margin-top: 1em">Not all images -can be converted from one compression scheme to another. -Data with some photometric interpretations and/or bit depths -are tied to specific compression schemes and vice-versa, -e.g. Group 3/4 compression is only usable for bilevel data. -JPEG compression is only usable on 8 bit per sample data (or -12 bit if <i>LibTIFF</i> was compiled with 12 bit JPEG -support). Support for OJPEG compressed images is problematic -at best. Since OJPEG compression is no longer supported for -writing images with LibTIFF, these images will be updated to -the newer JPEG compression when they are copied or -processed. This may cause the image to appear color shifted -or distorted after conversion. In some cases, it is possible -to remove the original compression from image data using the -option -cnone.</p> - -<p style="margin-left:11%; margin-top: 1em">Tiffcrop does -not currently provide options to up or downsample data to -different bit depths or convert data from one photometric -interpretation to another, e.g. 16 bits per sample to 8 bits -per sample or RGB to grayscale.</p> - -<p style="margin-left:11%; margin-top: 1em">Tiffcrop is -very loosely derived from code in <i>tiffcp</i> with -extensive modifications and additions to support the -selection of input images and regions and the exporting of -them to one or more output files in various groupings. The -image manipulation routines are entirely new and additional -ones may be added in the future. It will handle tiled images -with bit depths that are not a multiple of eight that tiffcp -may refuse to read.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>Tiffcrop</i> -was designed to handle large files containing many moderate -sized images with memory usage that is independent of the -number of images in the file. In order to support -compression modes that are not based on individual -scanlines, e.g. JPEG, it now reads images by strip or tile -rather than by individual scanlines. In addition to the -memory required by the input and output buffers associated -with <i>LibTIFF</i> one or more buffers at least as large as -the largest image to be read are required. The design favors -large volume document processing uses over scientific or -graphical manipulation of large datasets as might be found -in research or remote sensing scenarios.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>pal2rgb</b>(1), -<b>tiffinfo</b>(1), <b>tiffcmp</b>(1), <b>tiffcp</b>(1), -<b>tiffmedian</b>(1), <b>tiffsplit</b>(1), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiffdither.1.html b/doc/static/man/tiffdither.1.html deleted file mode 100644 index 979d4662..00000000 --- a/doc/static/man/tiffdither.1.html +++ /dev/null @@ -1,188 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:29 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFDITHER</title> - -</head> -<body> - -<h1 align="center">TIFFDITHER</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiffdither -− convert a greyscale image to bilevel using -dithering</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffdither</b> -[ <i>options</i> ] <i>input.tif output.tif</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>tiffdither</i> -converts a single channel 8-bit greyscale image to a bilevel -image using Floyd-Steinberg error propagation with -thresholding.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Specify the compression to use -for data written to the output file: <b>none</b> for no -compression, <b>packbits</b> for PackBits compression, -<b>lzw</b> for Lempel-Ziv & Welch compression, -<b>zip</b> for Deflate compression, <b>g3</b> for CCITT -Group 3 (T.4) compression, and <b>g4</b> for CCITT Group 4 -(T.6) compression. By default <i>tiffdither</i> will -compress data according to the value of the -<i>Compression</i> tag found in the source file.</p></td></tr> -</table> - -<p style="margin-left:22%; margin-top: 1em">The -<small>CCITT</small> Group 3 and Group 4 compression -algorithms can only be used with bilevel data.</p> - -<p style="margin-left:22%; margin-top: 1em">Group 3 -compression can be specified together with several -T.4-specific options: <b>1d</b> for 1-dimensional encoding, -<b>2d</b> for 2-dimensional encoding, and <b>fill</b> to -force each encoded scanline to be zero-filled so that the -terminating EOL code lies on a byte boundary. Group -3-specific options are specified by appending a -‘‘:’’-separated list to the -‘‘g3’’ option; e.g. <b>−c -g3:2d:fill</b> to get 2D-encoded data with byte-aligned EOL -codes.</p> - - -<p style="margin-left:22%; margin-top: 1em"><small>LZW</small> -compression can be specified together with a -<i>predictor</i> value. A predictor value of 2 causes each -scanline of the output image to undergo horizontal -differencing before it is encoded; a value of 1 forces each -scanline to be encoded without differencing. LZW-specific -options are specified by appending a -‘‘:’’-separated list to the -‘‘lzw’’ option; e.g. <b>−c -lzw:2</b> for <small>LZW</small> compression with horizontal -differencing.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−f</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Specify the bit fill order to -use in writing output data. By default, <i>tiffdither</i> -will create a new file with the same fill order as the -original. Specifying <b>−f lsb2msb</b> will force data -to be written with the <i>FillOrder</i> tag set to -<small>LSB2MSB ,</small> while <b>−f msb2lsb</b> will -force data to be written with the <i>FillOrder</i> tag set -to <small>MSB2LSB .</small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−r</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Make each strip have no more than the given number of -rows.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−t</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Set the threshold value for dithering. By default the -threshold value is 128.</p></td></tr> -</table> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The dither -algorithm is taken from the <b>tiffmedian</b>(1) program -(written by Paul Heckbert).</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>pal2rgb</b>(1), -<b>fax2tiff</b>(1), <b>tiffinfo</b>(1), <b>tiffcp</b>(1), -<b>tiff2bw</b>(1), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiffdump.1.html b/doc/static/man/tiffdump.1.html deleted file mode 100644 index 4123321e..00000000 --- a/doc/static/man/tiffdump.1.html +++ /dev/null @@ -1,128 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:29 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFDUMP</title> - -</head> -<body> - -<h1 align="center">TIFFDUMP</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiffdump -− print verbatim information about <small>TIFF</small> -files</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffdump</b> -[ <i>options</i> ] <i>name ...</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>tiffdump</i> -displays directory information from files created according -to the Tag Image File Format, Revision 6.0. The header of -each <small>TIFF</small> file (magic number, version, and -first directory offset) is displayed, followed by the tag -contents of each directory in the file. For each tag, the -name, data type, count, and value(s) is displayed. When the -symbolic name for a tag or data type is known, the symbolic -name is displayed followed by it’s numeric (decimal) -value. Tag values are displayed enclosed in -‘‘<>’’ characters immediately -preceded by the value of the count field. For example, an -<i>ImageWidth</i> tag might be displayed as -‘‘ImageWidth (256) SHORT (3) -1<800>’’.</p> - - -<p style="margin-left:11%; margin-top: 1em"><i>tiffdump</i> -is particularly useful for investigating the contents of -<small>TIFF</small> files that <i>libtiff</i> does not -understand.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−h</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Force numeric data to be printed -in hexadecimal rather than the default decimal.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>−m</b> -<i>items</i></p> - -<p style="margin-left:22%;">Change the number of indirect -data items that are printed. By default, this will be -24.</p> - -<p style="margin-left:11%;"><b>−o</b> -<i>offset</i></p> - -<p style="margin-left:22%;">Dump the contents of the -<small>IFD</small> at the a particular file offset. The file -offset may be specified using the usual C-style syntax; i.e. -a leading ‘‘0x’’ for hexadecimal and -a leading ‘‘0’’ for octal.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffinfo</b>(1), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiffgt.1.html b/doc/static/man/tiffgt.1.html deleted file mode 100644 index e03b050a..00000000 --- a/doc/static/man/tiffgt.1.html +++ /dev/null @@ -1,496 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:29 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFGT</title> - -</head> -<body> - -<h1 align="center">TIFFGT</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#BUGS">BUGS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiffgt − -display an image stored in a <small>TIFF</small> file -(Silicon Graphics version)</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffgt</b> [ -<i>options</i> ] <i>input.tif ...</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><i>tiffgt</i> -displays one or more images stored using the Tag Image File -Format, Revision 6.0. Each image is placed in a fixed size -window that the user must position on the display (unless -configured otherwise through X defaults). If the display has -fewer than 24 bitplanes, or if the image does not warrant -full color, then <small>RGB</small> color values are mapped -to the closest values that exist in the colormap (this is -done using the <i>rgbi</i> routine found in the graphics -utility library <b>−lgutil</b>.)</p> - -<p style="margin-left:11%; margin-top: 1em"><i>tiffgt</i> -correctly handles files with any of the following -characteristics:</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="24%"> - - -<p><i>BitsPerSample</i></p></td> -<td width="58%"> - - -<p>1, 2, 4, 8, 16</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="24%"> - - -<p><i>SamplesPerPixel</i></p></td> -<td width="58%"> - - -<p>1, 3, 4 (the 4th sample is ignored)</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="24%"> - - -<p><i>PhotometricInterpretation</i></p></td> -<td width="58%"> - - -<p>0 (min-is-white), 1 (min-is-black), 2 (RGB), 3 -(palette), 6 (YCbCr)</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="24%"> - - -<p><i>PlanarConfiguration</i></p></td> -<td width="58%"> - - -<p>1 (contiguous), 2 (separate)</p></td></tr> -<tr valign="top" align="left"> -<td width="18%"></td> -<td width="24%"> - - -<p><i>Orientation</i></p></td> -<td width="58%"> - - -<p>1 (top-left), 4 (bottom-left)</p></td></tr> -</table> - -<p style="margin-left:11%;">Data may be organized as strips -or tiles and may be compressed with any of the compression -algorithms supported by the <i>libtiff</i>(3) library.</p> - -<p style="margin-left:11%; margin-top: 1em">For palette -images (<i>PhotometricInterpretation</i>=3), <i>tiffgt</i> -inspects the colormap values and assumes either 16-bit or -8-bit values according to the maximum value. That is, if no -colormap entry greater than 255 is found, <i>tiffgt</i> -assumes the colormap has only 8-bit values; otherwise it -assumes 16-bit values. This inspection is done to handle old -images written by previous (incorrect) versions of -<i>libtiff</i>.</p> - -<p style="margin-left:11%; margin-top: 1em"><i>tiffgt</i> -can be used to display multiple images one-at-a-time. The -left mouse button switches the display to the first image in -the <i>next</i> file in the list of files specified on the -command line. The right mouse button switches to the first -image in the <i>previous</i> file in the list. The middle -mouse button causes the first image in the first file -specified on the command line to be displayed. In addition -the following keyboard commands are recognized:</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>b</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Use a <i>PhotometricInterpretation</i> of MinIsBlack in -displaying the current image.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>l</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Use a <i>FillOrder</i> of lsb-to-msb in decoding the -current image.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>m</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Use a <i>FillOrder</i> of msb-to-lsb in decoding the -current image.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>c</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Use a colormap visual to display the current image.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>r</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Use a true color (24-bit RGB) visual to display the -current image.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>w</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Use a <i>PhotometricInterpretation</i> of MinIsWhite in -displaying the current image.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>W</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Toggle (enable/disable) display of warning messages from -the <small>TIFF</small> library when decoding images.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>E</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Toggle (enable/disable) display of error messages from -the <small>TIFF</small> library when decoding images.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>z</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Reset all parameters to their default settings -(<i>FillOrder</i>, <i>PhotometricInterpretation</i>, -handling of warnings and errors).</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="9%"> - - -<p><b>PageUp</b></p></td> -<td width="2%"></td> -<td width="78%"> - - -<p>Display the previous image in the current file or the -last image in the previous file.</p></td></tr> -</table> - -<p style="margin-left:11%;"><b>PageDown</b></p> - -<p style="margin-left:22%;">Display the next image in the -current file or the first image in the next file.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="6%"> - - -<p><b>Home</b></p></td> -<td width="5%"></td> -<td width="78%"> - - -<p>Display the first image in the current file.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="6%"> - - -<p><b>End</b></p></td> -<td width="5%"></td> -<td width="78%"> - - -<p>Display the last image in the current file -(unimplemented).</p> </td></tr> -</table> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Force image display in a -colormap window.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−d</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify an image to display by directory number. By -default the first image in the file is displayed. -Directories are numbered starting at zero.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−e</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Enable reporting of error messages from the -<small>TIFF</small> library. By default <i>tiffgt</i> -silently ignores images that cannot be read.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−f</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force <i>tiffgt</i> to run as a foreground process. By -default <i>tiffgt</i> will place itself in the background -once it has opened the requested image file.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−l</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force the presumed bit ordering to be <small>LSB</small> -to <small>MSB.</small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−m</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force the presumed bit ordering to be <small>MSB</small> -to <small>LSB.</small></p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−o</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify an image to display by directory offset. By -default the first image in the file is displayed. -Directories offsets may be specified using C-style syntax; -i.e. a leading ‘‘0x’’ for -hexadecimal and a leading ‘‘0’’ for -octal.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−p</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Override the value of the -<i>PhotometricInterpretation</i> tag; the parameter may be -one of: <b>miniswhite</b>, <b>minisblack</b>, <b>rgb</b>, -<b>palette</b>, <b>mask</b>, <b>separated</b>, <b>ycbcr</b>, -and <b>cielab</b>.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−r</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Force image display in a full color window.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−s</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Stop on the first read error. By default all errors in -the input data are ignored and <i>tiffgt</i> does it’s -best to display as much of an image as possible.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−w</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Enable reporting of warning messages from the -<small>TIFF</small> library. By default <i>tiffgt</i> -ignores warning messages generated when reading an -image.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−v</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Place information in the title bar describing what type -of window (full color or colormap) is being used, the name -of the input file, and the directory index of the image (if -non-zero). By default, the window type is not shown in the -title bar.</p></td></tr> -</table> - -<h2>BUGS -<a name="BUGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Images wider -and taller than the display are silently truncated to avoid -crashing old versions of the window manager.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffdump</b>(1), -<b>tiffinfo</b>(1), <b>tiffcp</b>(1), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiffinfo.1.html b/doc/static/man/tiffinfo.1.html deleted file mode 100644 index dff4b49c..00000000 --- a/doc/static/man/tiffinfo.1.html +++ /dev/null @@ -1,185 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:29 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFINFO</title> - -</head> -<body> - -<h1 align="center">TIFFINFO</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiffinfo -− print information about <small>TIFF</small> -files</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffinfo</b> -[ <i>options</i> ] <i>input.tif ...</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>Tiffinfo</i> -displays information about files created according to the -Tag Image File Format, Revision 6.0. By default, the -contents of each <small>TIFF</small> directory in each file -is displayed, with the value of each tag shown symbolically -(where sensible).</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Display the colormap and -color/gray response curves, if present.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−D</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>In addition to displaying the directory tags, read and -decompress all the data in each image (but not display -it).</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−d</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>In addition to displaying the directory tags, print each -byte of decompressed data in hexadecimal.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−j</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Display any <small>JPEG</small> -related tags that are -present.</p> </td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−o</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Set the initial <small>TIFF</small> directory according -to the specified file offset. The file offset may be -specified using the usual C-style syntax; i.e. a leading -‘‘0x’’ for hexadecimal and a leading -‘‘0’’ for octal.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−s</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Display the offsets and byte counts for each data strip -in a directory.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−z</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Enable strip chopping when reading image data.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−#</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Set the initial <small>TIFF</small> directory to -<i>#</i>.</p> </td></tr> -</table> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>pal2rgb</b>(1), -<b>tiffcp</b>(1), <b>tiffcmp</b>(1), <b>tiffmedian</b>(1), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiffmedian.1.html b/doc/static/man/tiffmedian.1.html deleted file mode 100644 index 99c1295a..00000000 --- a/doc/static/man/tiffmedian.1.html +++ /dev/null @@ -1,174 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:29 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFMEDIAN</title> - -</head> -<body> - -<h1 align="center">TIFFMEDIAN</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#NOTES">NOTES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiffmedian -− apply the median cut algorithm to data in a -<small>TIFF</small> file</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffmedian</b> -[ <i>options</i> ] <i>input.tif output.tif</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>tiffmedian</i> -applies the median cut algorithm to an <small>RGB</small> -image in <i>input.tif</i> to generate a palette image that -is written to <i>output.tif</i>. The generated colormap has, -by default, 256 entries. The image data is quantized by -mapping each pixel to the closest color values in the -colormap.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−c</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Specify the compression to use -for data written to the output file: <b>none</b> for no -compression, <b>packbits</b> for PackBits compression, -<b>lzw</b> for Lempel-Ziv & Welch compression, and -<b>zip</b> for Deflate compression. By default -<i>tiffmedian</i> will compress data according to the value -of the <i>Compression</i> tag found in the source file.</p></td></tr> -</table> - - -<p style="margin-left:22%; margin-top: 1em"><small>LZW</small> -compression can be specified together with a -<i>predictor</i> value. A predictor value of 2 causes each -scanline of the output image to undergo horizontal -differencing before it is encoded; a value of 1 forces each -scanline to be encoded without differencing. LZW-specific -options are specified by appending a -‘‘:’’-separated list to the -‘‘lzw’’ option; e.g. <b>−c -lzw:2</b> for <small>LZW</small> compression with horizontal -differencing.</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p style="margin-top: 1em"><b>−C</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p style="margin-top: 1em">Specify the number of entries to -use in the generated colormap. By default all 256 -entries/colors are used.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−f</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Apply Floyd-Steinberg dithering before selecting a -colormap entry.</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="3%"> - - -<p><b>−r</b></p></td> -<td width="8%"></td> -<td width="78%"> - - -<p>Specify the number of rows (scanlines) in each strip of -data written to the output file. By default, -<i>tiffmedian</i> attempts to set the rows/strip that no -more than 8 kilobytes of data appear in a strip.</p></td></tr> -</table> - -<h2>NOTES -<a name="NOTES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">This program is -derived from Paul Heckbert’s <i>median</i> -program.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>pal2rgb</b>(1), -<b>tiffinfo</b>(1), <b>tiffcp</b>(1), <b>tiffcmp</b>(1), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em"><b>Color Image -Quantization for Frame Buffer Display</b>, Paul Heckbert, -SIGGRAPH proceedings, 1982, pp. 297-307.</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiffset.1.html b/doc/static/man/tiffset.1.html deleted file mode 100644 index 4b1cdc8f..00000000 --- a/doc/static/man/tiffset.1.html +++ /dev/null @@ -1,141 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:29 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFSET</title> - -</head> -<body> - -<h1 align="center">TIFFSET</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#EXAMPLES">EXAMPLES</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiffset − -set or unset a field in a <small>TIFF</small> header</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffset</b> -[ <i>options</i> ] <i>filename.tif</i></p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em"><i>Tiffset</i> -sets the value of a <small>TIFF</small> header to a -specified value or removes an existing setting.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>−d</b> -<i>dirnumber</i></p> - -<p style="margin-left:22%;">change the current directory -(starting at 0).</p> - -<p style="margin-left:11%;"><b>−s</b> -<i>tagnumber</i> [ <i>count</i> ] <i>value ...</i></p> - -<p style="margin-left:22%;">Set the value of the named tag -to the value or values specified.</p> - -<p style="margin-left:11%;"><b>−sd</b> -<i>diroffset</i></p> - -<p style="margin-left:22%;">change the current directory by -offset.</p> - -<p style="margin-left:11%;"><b>−sf</b> <i>tagnumber -filename</i></p> - -<p style="margin-left:22%;">Set the value of the tag to the -contents of filename. This option is supported for ASCII -tags only.</p> - -<p style="margin-left:11%;"><b>−u</b> -<i>tagnumber</i></p> - -<p style="margin-left:22%;">Unset the tag.</p> - -<h2>EXAMPLES -<a name="EXAMPLES"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">The following -example sets the image description tag (270) of a.tif to the -contents of the file descrip:</p> - -<p style="margin-left:22%;">tiffset −sf 270 descrip -a.tif</p> - -<p style="margin-left:11%; margin-top: 1em">The following -example sets the artist tag (315) of a.tif to the string -‘‘Anonymous’’:</p> - -<p style="margin-left:22%;">tiffset −s 315 Anonymous -a.tif</p> - -<p style="margin-left:11%; margin-top: 1em">This example -sets the resolution of the file a.tif to 300 dpi:</p> - -<p style="margin-left:22%;">tiffset −s 296 2 a.tif -<br> -tiffset −s 282 300.0 a.tif <br> -tiffset −s 283 300.0 a.tif</p> - -<p style="margin-left:11%; margin-top: 1em">Set the -photometric interpretation of the third page of a.tif to -min-is-black (ie. inverts it):</p> - -<p style="margin-left:22%;">tiffset -d 2 -s 262 1 a.tif</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffdump</b>(1), -<b>tiffinfo</b>(1), <b>tiffcp</b>(1), -<b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/static/man/tiffsplit.1.html b/doc/static/man/tiffsplit.1.html deleted file mode 100644 index cefa0d4b..00000000 --- a/doc/static/man/tiffsplit.1.html +++ /dev/null @@ -1,134 +0,0 @@ -<!-- Creator : groff version 1.22.4 --> -<!-- CreationDate: Sat Jun 4 16:23:29 2022 --> -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta name="generator" content="groff -Thtml, see www.gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<meta name="Content-Style" content="text/css"> -<style type="text/css"> - p { margin-top: 0; margin-bottom: 0; vertical-align: top } - pre { margin-top: 0; margin-bottom: 0; vertical-align: top } - table { margin-top: 0; margin-bottom: 0; vertical-align: top } - h1 { text-align: center } -</style> -<title>TIFFSPLIT</title> - -</head> -<body> - -<h1 align="center">TIFFSPLIT</h1> - -<a href="#NAME">NAME</a><br> -<a href="#SYNOPSIS">SYNOPSIS</a><br> -<a href="#DESCRIPTION">DESCRIPTION</a><br> -<a href="#OPTIONS">OPTIONS</a><br> -<a href="#EXIT STATUS">EXIT STATUS</a><br> -<a href="#BUGS">BUGS</a><br> -<a href="#SEE ALSO">SEE ALSO</a><br> - -<hr> - - -<h2>NAME -<a name="NAME"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">tiffsplit -− split a multi-image <small>TIFF</small> into -single-image <small>TIFF</small> files</p> - -<h2>SYNOPSIS -<a name="SYNOPSIS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffsplit</b> -<i>src.tif</i> [ <i>prefix</i> ]</p> - -<h2>DESCRIPTION -<a name="DESCRIPTION"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>tiffsplit</i> -takes a multi-directory (page) <small>TIFF</small> file and -creates one or more single-directory (page) -<small>TIFF</small> files from it. The output files are -given names created by concatenating a prefix, a lexically -ordered suffix in the range [<i>aaa</i>-<i>zzz</i>], the -suffix <i>.tif</i> (e.g. <i>xaaa.tif</i>, <i>xaab.tif</i>, -<i>...</i>, <i>xzzz.tif</i>). If a prefix is not specified -on the command line, the default prefix of <i>x</i> is -used.</p> - -<h2>OPTIONS -<a name="OPTIONS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">None.</p> - -<h2>EXIT STATUS -<a name="EXIT STATUS"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><i>tiffsplit</i> -exits with one of the following values:</p> - -<table width="100%" border="0" rules="none" frame="void" - cellspacing="0" cellpadding="0"> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>0</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>Success</p></td></tr> -<tr valign="top" align="left"> -<td width="11%"></td> -<td width="1%"> - - -<p><b>1</b></p></td> -<td width="10%"></td> -<td width="78%"> - - -<p>An error occurred either reading the input or writing -results.</p> </td></tr> -</table> - -<h2>BUGS -<a name="BUGS"></a> -</h2> - - -<p style="margin-left:11%; margin-top: 1em">Only a select -set of ‘‘known tags’’ is copied when -splitting.</p> - -<h2>SEE ALSO -<a name="SEE ALSO"></a> -</h2> - - - -<p style="margin-left:11%; margin-top: 1em"><b>tiffcp</b>(1), -<b>tiffinfo</b>(1), <b>libtiff</b>(3TIFF)</p> - -<p style="margin-left:11%; margin-top: 1em">Libtiff library -home page: <b>http://www.simplesystems.org/libtiff/</b></p> -<hr> -</body> -</html> diff --git a/doc/tools.rst b/doc/tools.rst index a2b05010..df102f04 100644 --- a/doc/tools.rst +++ b/doc/tools.rst @@ -12,6 +12,35 @@ of these tools are useful in their own right. Many of them however are more intended to serve as programming examples for using the TIFF library. +Manual pages +------------ + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + tools/fax2ps + tools/fax2tiff + tools/pal2rgb + tools/ppm2tiff + tools/raw2tiff + tools/rgb2ycbcr + tools/thumbnail + tools/tiff2bw + tools/tiff2pdf + tools/tiff2ps + tools/tiff2rgba + tools/tiffcmp + tools/tiffcp + tools/tiffcrop + tools/tiffdither + tools/tiffdump + tools/tiffgt + tools/tiffinfo + tools/tiffmedian + tools/tiffset + tools/tiffsplit + Device-dependent Programs ------------------------- @@ -25,7 +54,7 @@ examples for writing programs to display and save TIFF images. * - Tool - Description - * - `tiffgt <man/tiffgt.1.html>`_ + * - :doc:`tools/tiffgt` - Display the contents of one or more TIFF images using OpenGL. The software makes extensive use of the ``TIFFRGBAImage`` facilities described elsewhere. @@ -42,55 +71,55 @@ The remaining programs should be device-independent: * - Tool - Description - * - `fax2ps <man/fax2ps.1.html>`_ + * - :doc:`tools/fax2ps` - Convert a Group 3- or Group 4- compressed TIFF to PostScript that is significantly more compressed than is generated by :program:`tiff2ps` (unless :program:`tiff2ps` writes PS Level II) - * - `fax2tiff <man/fax2tiff.1.html>`_ + * - :doc:`tools/fax2tiff` - Convert raw Group 3 or Group 4 facsimile data to TIFF - * - `pal2rgb <man/pal2rgb.1.html>`_ + * - :doc:`tools/pal2rgb` - Convert a Palette-style image to a full color RGB image by applying the colormap - * - `ppm2tiff <man/ppm2tiff.1.html>`_ + * - :doc:`tools/ppm2tiff` - A quick hack that converts 8-bit PPM format images to TIFF - * - `raw2tiff <man/raw2tiff.1.html>`_ + * - :doc:`tools/raw2tiff` - Create a TIFF file from raw data - * - `rgb2ycbcr <man/rgb2ycbcr.1.html>`_ + * - :doc:`tools/rgb2ycbcr` - Convert an RGB, grayscale, or bilevel TIFF image to a YCbCr TIFF image; it's mainly provided for testing - * - `thumbnail <man/thumbnail.1.html>`_ + * - :doc:`tools/thumbnail` - Copy a bilevel TIFF to one that includes 8-bit greyscale "thumbnail images" for each page; it is provided as an example of how one might use the ``SubIFD`` tag (and the library support for it) - * - `tiff2bw <man/tiff2bw.1.html>`_ + * - :doc:`tools/tiff2bw` - A simple program to convert a color image to grayscale - * - `tiff2pdf <man/tiff2pdf.1.html>`_ + * - :doc:`tools/tiff2pdf` - Convert TIFF images to PDF - * - `tiff2ps <man/tiff2ps.1.html>`_ + * - :doc:`tools/tiff2ps` - Convert TIFF images to PostScript - * - `tiff2rgba <man/tiff2rgba.1.html>`_ + * - :doc:`tools/tiff2rgba` - Convert a TIFF image to RGBA color space - * - `tiffcmp <man/tiffcmp.1.html>`_ + * - :doc:`tools/tiffcmp` - Compare the contents of two TIFF files (it does not check all the directory information, but does check all the data) - * - `tiffcp <man/tiffcp.1.html>`_ + * - :doc:`tools/tiffcp` - Copy, concatenate, and convert TIFF images (e.g. switching from ``Compression=5`` to ``Compression=1``) - * - `tiffcrop <man/tiffcrop.1.html>`_ + * - :doc:`tools/tiffcrop` - Provides selection of images from within one or more multi-image TIFF files, with orthogonal rotation, mirroring, cropping, and extraction of multiple sections and exporting to one or more files. @@ -100,26 +129,26 @@ The remaining programs should be device-independent: segments to fit on multiple /pages/ (standard paper sizes), plus other functions described in the tiffcrop man page - * - `tiffdither <man/tiffdither.1.html>`_ + * - :doc:`tools/tiffdither` - Dither a b&w image into a bilevel image (suitable for use in creating fax files) - * - `tiffdump <man/tiffdump.1.html>`_ + * - :doc:`tools/tiffdump` - Display the verbatim contents of the TIFF directory in a file (it's very useful for debugging bogus files that you may get from someone that claims they support TIFF) - * - `tiffinfo <man/tiffinfo.1.html>`_ + * - :doc:`tools/tiffinfo` - Display information about one or more TIFF files - * - `tiffmedian <man/tiffmedian.1.html>`_ + * - :doc:`tools/tiffmedian` - A version of Paul Heckbert's median cut program that reads an RGB TIFF image, and creates a TIFF palette file as a result - * - `tiffset <man/tiffset.1.html>`_ + * - :doc:`tools/tiffset` - Set a field in a TIFF header - * - `tiffsplit <man/tiffsplit.1.html>`_ + * - :doc:`tools/tiffsplit` - Create one or more single-image files from a (possibly) multi-image file diff --git a/doc/tools/fax2ps.rst b/doc/tools/fax2ps.rst new file mode 100644 index 00000000..0bf3a438 --- /dev/null +++ b/doc/tools/fax2ps.rst @@ -0,0 +1,129 @@ +fax2ps +====== + +.. program:: fax2ps + +Synopsis +-------- + +**fax2ps** [ *options* ] [ *file …* ] + +Description +----------- + +:program:`fax2ps` reads one or more TIFF +facsimile image files and prints a compressed form of +PostScript on the standard output that is suitable for printing. + +By default, each page is scaled to reflect the +image dimensions and resolutions stored in the file. +The :option:`-x` and :option:`-y` +options can be used to specify the horizontal and vertical +image resolutions (lines/inch), respectively. +If the :option:`-S` +option is specified, each page is scaled to fill an output page. +The default output page is 8.5 by 11 inches. +Alternate page dimensions can be specified in inches with the +:option:`-W` and :option:`-H` +options. + +By default :program:`fax2ps` +generates PostScript for all pages in the file. +The :option:`-p` +option can be used to select one or more pages from +a multi-page document. + + +:program:`fax2ps` +generates a compressed form of PostScript that is +optimized for sending pages of text to a PostScript +printer attached to a host through a low-speed link (such +as a serial line). +Each output page is filled with white and then only +the black areas are drawn. +The PostScript specification of the black drawing operations +is optimized by using a special font that encodes the +move-draw operations required to fill +the black regions on the page. +This compression scheme typically results in a substantially +reduced PostScript description, relative to the straightforward +imaging of the page with a PostScript +``image`` +operator. +This algorithm can, however, be ineffective +for continuous-tone and white-on-black images. +For these images, it sometimes is more efficient to send +the raster bitmap image directly; see +.BR tiff2ps (1). + +Options +------- + +.. option:: -p number + + Print only the indicated page. + Multiple pages may be printed by specifying + this option more than once. + +.. option:: -x resolution + + Use *resolution* + as the horizontal resolution, in dots/inch, of the image data. + By default this value is taken from the file. + +.. option:: -y resolution + + Use *resolution* + as the vertical resolution, in lines/inch, of the image data. + By default this value is taken from the file. + +.. option:: -S + + Scale each page of image data to fill the output page dimensions. + By default images are presented according to the dimension + information recorded in the TIFF file. + +.. option:: -W width + + Use *width* + as the width, in inches, of the output page. + +.. option:: -H height + + Use *height* + as the height, in inches, of the output page. + +Diagnostics +----------- + +Some messages about malformed TIFF images come from the +TIFF library. + +Various messages about badly formatted facsimile images +may be generated due to transmission errors in received +facsimile. +:program:`fax2ps` +attempts to recover from such data errors by resynchronizing +decoding at the end of the current scanline. +This can result in long horizontal black lines in the resultant +PostScript image. + +Notes +----- + +If the destination printer supports PostScript Level II then +it is always faster to just send the encoded bitmap generated +by the :program:`tiff2ps` program. + +Bugs +---- + +:program:`fax2ps` +should probably figure out when it is doing a poor +job of compressing the output and just generate +PostScript to image the bitmap raster instead. + +See also +-------- + +:doc`tiff2ps` (1), :doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/fax2tiff.rst b/doc/tools/fax2tiff.rst new file mode 100644 index 00000000..1888a474 --- /dev/null +++ b/doc/tools/fax2tiff.rst @@ -0,0 +1,246 @@ +fax2tiff +======== + +.. program:: fax2tiff + +Synopsis +-------- + +**fax2tiff** [ *options* ] [ **-o** *output.tif* ] *input.raw* + +Description +----------- + +:program:`fax2tiff` creates a TIFF file containing CCITT +Group 3 or Group 4 encoded data from one or more files containing "raw" +Group 3 or Group 4 encoded data (typically obtained directly from a fax modem). +By default, each row of data in the resultant TIFF +file is 1-dimensionally encoded and +padded or truncated to 1728 pixels, as needed. +The resultant image is a set of low resolution (98 lines/inch) +or medium resolution (196 lines/inch) +pages, each of which is a single strip of data. +The generated file conforms to the TIFF +Class F (FAX) specification for storing facsimile data. +This means, in particular, that each page of the data does +**not** include the trailing +*"return to control"* (``RTC``) code; as required +for transmission by the CCITT Group 3 specifications. +The old, "classic", format is created if the +:option:`-c` option is used. +(The Class F format can also be requested with the +:option:`-f` option.) + +The default name of the output image is :file:`fax.tif`; +this can be changed with the :option:`-o` option. +Each input file is assumed to be a separate page of facsimile data +from the same document. +The order in which input files are specified on the command +line is the order in which the resultant pages appear in the +output file. + +Options +------- + +Options that affect the interpretation of input data are: + +.. option:: -3 + + Assume input data is CCITT Group 3 encoded (default). + +.. option:: -4 + + Assume input data is CCITT Group 4 encoded. + +.. option:: -U + + Assume input data is uncompressed (Group 3 or Group 4). + +.. option:: -1 + + Assume input data is encoded with the 1-dimensional version of the CCITT + Group 3 Huffman encoding algorithm (default). + +.. option:: -2 + + Assume input data is 2-dimensional version of the CCITT + Group 3 Huffman encoding algorithm. + +.. option:: -P + + Assume input data is **not** + EOL-aligned (default). This option has effect with Group 3 encoded input only. + +.. option:: -A + + Assume input data is EOL-aligned. This option has effect with Group 3 + encoded input only. + +.. option:: -M + + Treat input data as having bits filled from most significant bit (``MSB``) to most least bit (``LSB``). + +.. option:: -L + + Treat input data as having bits filled from least significant bit (``LSB``) to most significant bit + (``MSB``) (default). + +.. option:: -B + + Assume input data was encoded with black as 0 and white as 1. + +.. option:: -W + + Assume input data was encoded with black as 1 and white as 0 (default). + +.. option:: -R + + Specify the vertical resolution, in lines/inch, of the input images. + By default input are assumed to have a vertical resolution of 196 lines/inch. + If images are low resolution facsimile, a value of 98 lines/inch should + be specified. + +.. option:: -X + + Specify the width, in pixels, of the input images. + By default input are assumed to have a width of 1728 pixels. + +Options that affect the output file format are: + +.. option:: -o + + Specify the name of the output file. + + +.. option:: -7 + + Force output to be compressed with the CCITT + Group 3 Huffman encoding algorithm (default). + +.. option:: -8 + + Force output to be compressed with the CCITT + Group 4 Huffman encoding. + +.. option:: -u + + Force output to be uncompressed (Group 3 or Group 4). + +.. option:: -5 + + Force output to be encoded with the 1-dimensional version of the CCITT + Group 3 Huffman encoding algorithm. + +.. option:: -6 + + Force output to be encoded with the 2-dimensional version of the CCITT + Group 3 Huffman encoding algorithm (default). + +.. option:: -a + + Force the last bit of each *"End Of Line"* (``EOL``) + code to land on a byte boundary (default). This "zero padding" will + be reflected in the contents of the ``Group3Options`` + tag of the resultant TIFF file. This option has effect with Group 3 encoded output only. + +.. option:: -p + + Do not EOL-align output. This option has effect with Group 3 encoded + output only. + +.. option:: -c + + Generate "classic" Group 3 TIFF format. + +.. option:: -f + + Generate TIFF Class F (TIFF/F) format (default). + +.. option:: -m + + Force output data to have bits filled from most significant bit (``MSB``) + to most least bit (``LSB``). + +.. option:: -l + + Force output data to have bits filled from least significant bit (``LSB``) + to most significant bit (``MSB``) (default). + +.. option:: -r + + Specify the number of rows (scanlines) in each strip of data + written to the output file. + By default (or when value ``0`` is specified), :program:`tiffcp` + attempts to set the rows/strip + that no more than 8 kilobytes of data appear in a strip (with except of G3/G4 + compression schemes). If you specify special value ``-1`` + it will results in infinite number of the rows per strip. The entire image + will be the one strip in that case. This is default in case of G3/G4 output + compression schemes. + +.. option:: -s + + Stretch the input image vertically by writing each input row of + data twice to the output file. + +.. option:: -v + + Force :program:`fax2tiff` + to print the number of rows of data it retrieved from the input file. + +.. option:: -z + + Force output to be compressed with the LZW encoding. + +Diagnostics +----------- + +The following warnings and errors come from the decoding +routines in the library. + +**"Warning, %s: Premature EOL at scanline %d (x %d).\en"**: + + The input data had a row that was shorter than the expected width. + The row is padded with white. + +**"%s: Premature EOF at scanline %d (x %d).\en"**: + + The decoder ran out of data in the middle of a scanline. + The resultant row is padded with white. + +**"%s: Bad code word at row %d, x %d\en"**: + + An invalid Group 3 ``code`` + was encountered while decoding the input file. + The row number and horizontal position is given. + The remainder of the input row is discarded, while + the corresponding output row is padded with white. + +**"%s: Bad 2D code word at scanline %d.\en"**: + + An invalid Group 4 or 2D Group 3 ``code`` + was encountered while decoding the input file. + The row number and horizontal position is given. + The remainder of the input row is discarded, while + the corresponding output row is padded with white. + +Bugs +---- + +Input data are assumed to have a a "top left" orientation; +it should be possible to override this assumption +from the command line. + +See also +-------- + +"CCITT Recommendation T.4" +(Standardization of Group 3 Facsimile Apparatus for Document Transmission). + +"The Spirit of TIFF Class F", +an appendix to the TIFF 5.0 specification prepared by Cygnet Technologies. + +:doc:`tiffinfo` (1), +:doc:`tiffdither` (1), +:doc:`tiffgt` (1), +:doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/pal2rgb.rst b/doc/tools/pal2rgb.rst new file mode 100644 index 00000000..5439d467 --- /dev/null +++ b/doc/tools/pal2rgb.rst @@ -0,0 +1,80 @@ +pal2rgb +======= + +.. program:: pal2rgb + +Synopsis +-------- + +**pal2rgb** [ *options* ] *input.tif* *output.tif* + +Description +----------- + +:program:`pal2rgb` converts a palette color image to a full color image by +applying the colormap of the palette image to each sample to generate a full color +RGB image. + +Options +------- + +Options that affect the interpretation of input data are: + +.. option:: -C numentries + + This option overrides the default behavior of :program:`pal2rgb` + in determining whether or not + colormap entries contain 16-bit or 8-bit values. + By default the colormap is inspected and + if no colormap entry greater than 255 is found, + the colormap is assumed to have only 8-bit values; otherwise + 16-bit values (as required by the TIFF + specification) are assumed. + The + :option:`-C` + option can be used to explicitly specify the number of + bits for colormap entries: + :command:`-C 8` for 8-bit values, + :command:`-C 16` for 16-bit values. + +Options that affect the output file format are: + +.. option:: -p planarconfig + + Explicitly select the planar configuration used in organizing + data samples in the output image: + :command:`-p contig` for samples packed contiguously, and + :command:`-p separate` for samples stored separately. + By default samples are packed. + +.. option:: -c compress + + Use the specified compression algorithm to encoded image data + in the output file: + :command:`-c packbits` for Macintosh Packbits, + :command:`-c lzw` for Lempel-Ziv & Welch, + :command:`-c zip` for Deflate, + :command:`-c none` + for no compression. + If no compression-related option is specified, the input + file's compression algorithm is used. + +.. option:: -r striprows + + Explicitly specify the number of rows in each strip of the + output file. If the :option:`-r` + option is not specified, a number is selected such that each + output strip has approximately 8 kilobytes of data in it. + +Bugs +---- + +Only 8-bit images are handled. + +See also +-------- + +:doc:`tiffinfo` (1), +:doc:`tiffcp` (1), +:doc:`tiffmedian` (1), +:doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/ppm2tiff.rst b/doc/tools/ppm2tiff.rst new file mode 100644 index 00000000..988609dd --- /dev/null +++ b/doc/tools/ppm2tiff.rst @@ -0,0 +1,56 @@ +ppm2tiff +======== + +.. program:: ppm2tiff + +Synopsis + +**ppm2tiff** [ *options* ] [ *input.ppm* ] *output.tif* + +Description +----------- + +:program:`ppm2tiff` converts a file in the PPM, PGM and PBM image formats to +TIFF. By default, the TIFF image is created with data samples packed +(``PlanarConfiguration=1``), compressed with the Packbits algorithm +(``Compression=32773``), and with each strip no more than 8 kilobytes. +These characteristics can be overridden, or explicitly specified with the +options described below. + +If the PPM file contains greyscale data, then the ``PhotometricInterpretation`` +tag is set to 1 (min-is-black), otherwise it is set to 2 (RGB). + +If no PPM file is specified on the command line, :program:`ppm2tiff` +will read from the standard input. + +Options +------- + +.. option:: -c compress + + Specify a compression scheme to use when writing image data: + :command:`-c none` for no compression, + :command:`-c packbits` for PackBits compression (will be used by default), + :command:`-c lzw` for Lempel-Ziv & Welch compression, + :command:`-c jpeg` for baseline JPEG compression, + :command:`-c zip` for Deflate compression, + :command:`-c g3` for CCITT Group 3 (T.4) compression, and + :command:`-c g4` for CCITT Group 4 (T.6) compression. + +.. option:: -r striprows + + Write data with a specified number of rows per strip; by default the number of + rows/strip is selected so that each strip is approximately 8 kilobytes. + +.. option:: -R resolution + + Mark the resultant image to have the specified X and Y resolution (in + dots/inch). + +See also +-------- + +:doc:`tiffinfo` (1), +:doc:`tiffcp` (1), +:doc:`tiffmedian` (1), +:doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/raw2tiff.rst b/doc/tools/raw2tiff.rst new file mode 100644 index 00000000..4df3627c --- /dev/null +++ b/doc/tools/raw2tiff.rst @@ -0,0 +1,143 @@ +raw2tiff +======== + +.. program:: raw2tiff + + +Synopsis +-------- + +**raw2tiff** [ *options ] *input.raw* *output.tif* + +Description +----------- + +:program:`raw2tiff` converts a raw byte sequence into TIFF. +By default, the TIFF image is created with data samples packed +(``PlanarConfiguration=1``), compressed with the PackBits algorithm +(``Compression=32773``), and with each strip no more than 8 kilobytes. +These characteristics can overridden, or explicitly specified +with the options described below. + +Options +------- + +.. option:: -H number + + Size of input image file header in bytes (0 by default). This amount of data + just will be skipped from the start of file while reading. + +.. option:: -w number + + Width of input image in pixels (can be guessed, see :ref:`raw-guess` below). + +.. option: -l number + + length of input image in lines (can be guessed, see :ref:`raw-guess` below). + +:option: -b number + + number of bands in input image (1 by default). + +.. option:: -d datatype + + type of samples in input image, where *datatype* may be one of: + + ========= =================================== + Data type Description + ========= =================================== + byte 8-bit unsigned integer (default) + short 16-bit unsigned integer + long 32-bit unsigned integer + sbyte 8-bit signed integer + sshort 16-bit signed integer + slong 32-bit signed integer + float 32-bit IEEE floating point + double 64-bit IEEE floating point + ========= =================================== + +.. option:: -i config + + type of sample interleaving in input image, where *config* may be one of: + + ============= ================================ + Configuration Description + ============= ================================ + pixel pixel interleaved data (default) + band band interleaved data. + ============= ================================ + +.. option:: -p photo + + photometric interpretation (color space) of the input image, where *photo* may + be one of: + + =========== ============================================== + Photometric Description + =========== ============================================== + miniswhite white color represented with 0 value + minisblack black color represented with 0 value (default) + rgb image has RGB color model + cmyk image has CMYK (separated) color model + ycbcr image has YCbCr color model + cielab image has CIE L*a*b color model + icclab image has ICC L*a*b color model + itulab image has ITU L*a*b color model + =========== ============================================== + +.. option:: -s + + swap bytes fetched from the input file. + +.. option:: -L + + input data has LSB2MSB bit order (default). + +.. option:: -M + + input data has MSB2LSB bit order. + +.. option:: -c + + Specify a compression scheme to use when writing image data: + :command:`-c none` for no compression, + :command:`-c packbits` for the PackBits compression algorithm (the default), + :command:`-c jpeg` for the baseline JPEG compression algorithm, + :command:`-c zip` for the Deflate compression algorithm, + :command:`\-c lzw` for Lempel-Ziv & Welch. + +.. option -r striprows + + Write data with a specified number of rows per strip; + by default the number of rows/strip is selected so that each strip + is approximately 8 kilobytes. + +.. _raw-guess: + +Guessing the image geometry +--------------------------- + +:program:`raw2tif` can guess image width and height in case one or both of these parameters are +not specified. If you omit one of those parameters, the complementary one will +be calculated based on the file size (taking into account header size, number +of bands and data type). If you omit both parameters, the statistical approach +will be used. Utility will compute correlation coefficient between two lines +at the image center using several appropriate line sizes and the highest +absolute value of the coefficient will indicate the right line size. That is +why you should be cautious with the very large images, because guessing +process may take a while (depending on your system performance). Of course, the +utility can't guess the header size, number of bands and data type, so it +should be specified manually. If you don't know anything about your image, +just try with the several combinations of those options. + +There is no magic, it is just a mathematical statistics, so it can be wrong +in some cases. But for most ordinary images guessing method will work fine. + +See also +-------- + +:doc:`pal2rgb` (1), +:doc:`tiffinfo` (1), +:doc:`tiffcp` (1), +:doc:`tiffmedian` (1), +:doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/rgb2ycbcr.rst b/doc/tools/rgb2ycbcr.rst new file mode 100644 index 00000000..9a0bec63 --- /dev/null +++ b/doc/tools/rgb2ycbcr.rst @@ -0,0 +1,63 @@ +rgb2ycbcr +========= + +.. program:: rgb2ycbcr + +Synopsis +-------- + +**rgb2ycbcr** [ *options* ] *src1.tif src2.tif … dst.tif* + +Description +----------- + +:program:`rgb2ycbcr` converts RGB color, greyscale, or bi-level TIFF +images to YCbCr images by transforming and sampling pixel data. If multiple +files are specified on the command line each source file is converted to a +separate directory in the destination file. + +By default, chrominance samples are created by sampling +2 by 2 blocks of luminance values; this can be changed with the +:option:`-h` and :option:`-v` options. +Output data are compressed with the ``PackBits`` +compression scheme, by default; an alternate scheme can be selected with the +:option:`-c` option. +By default, output data are compressed in strips with +the number of rows in each strip selected so that the +size of a strip is never more than 8 kilobytes; +the :option:`-r` +option can be used to explicitly set the number of +rows per strip. + +Options +------- + +.. option:: -c compress + + Specify a compression scheme to use when writing image data: + :command:`-c none` for no compression, + :command:`-c packbits` for the PackBits compression algorithm (the default), + :command:`-c jpeg` for the JPEG compression algorithm, + :command:`\-c zip` for the deflate compression algorithm, and + :command:`-c lzw` for Lempel-Ziv & Welch. + +.. option:: -h size + + Set the horizontal sampling dimension to one of: 1, 2 (default), or 4. + +.. option:: -r striprows + + Write data with a specified number of rows per strip; + by default the number of rows/strip is selected so that each strip + is approximately 8 kilobytes. + +.. option:: -v size + + Set the vertical sampling dimension to one of: 1, 2 (default), or 4. + +See also +-------- + +:doc:`tiffinfo` (1), +:doc:`tiffcp` (1), +:doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/thumbnail.rst b/doc/tools/thumbnail.rst new file mode 100644 index 00000000..722388d0 --- /dev/null +++ b/doc/tools/thumbnail.rst @@ -0,0 +1,66 @@ +thumbnail +========= + +.. program:: thumbnail + +Synopsis +-------- + +**thumbnail** [ *options* ] *input.tif* *output.tif* + +Description +----------- + +:program:`thumbnail` is a program written to show how one might use the +``SubIFD`` tag (#330) to store thumbnail images. +:program:`thumbnail` +copies a TIFF Class F facsimile file to the output file +and for each image an 8-bit greyscale "thumbnail sketch" is created. +The output file contains the thumbnail image with the associated +full-resolution page linked below with the SubIFD tag. + +By default, thumbnail images are 216 pixels wide by 274 pixels high. +Pixels are calculated by sampling and filtering the input image +with each pixel value passed through a contrast curve. + +Options +------- + +.. option:: -w width + + Specify the width of thumbnail images in pixels. + +.. option:: -h height + + Specify the height of thumbnail images in pixels. + +.. option:: -c contrast + + Specify a contrast curve to apply in generating the thumbnail images. + By default pixels values are passed through a linear contrast curve + that simply maps the pixel value ranges. Alternative curves are: + + ====== ====================== + Curve Description + ====== ====================== + exp50 50% exponential curve + exp60 60% exponential curve + exp70 70% exponential curve + exp80 80% exponential curve + exp90 90% exponential curve + exp pure exponential curve + linear linear curve + ====== ====================== + +Bugs +---- + +There are no options to control the format of the saved thumbnail images. + +See also +-------- + +:doc:`tiffdump` (1), +:doc:`tiffgt` (1), +:doc:`tiffinfo` (1), +:doc:`/man/libtiff` (3tiff), diff --git a/doc/tools/tiff2bw.rst b/doc/tools/tiff2bw.rst new file mode 100644 index 00000000..bf01f172 --- /dev/null +++ b/doc/tools/tiff2bw.rst @@ -0,0 +1,60 @@ +tiff2bw +======= + +.. program:: tiff2bw + +Synopsis +-------- + +**tiff2bw** [ *options* ] *input.tif* *output.tif* + +Description +----------- + +:program:`tiff2bw` converts an RGB or Palette color TIFF +image to a greyscale image by +combining percentages of the red, green, and blue channels. +By default, output samples are created by taking +28% of the red channel, 59% of the green channel, and 11% of +the blue channel. To alter these percentages, the +:option:`-R`, :option:`-G`, and :option:`-B` options may be used. + +Options +------- + +.. option:: -c compress + + Specify a compression scheme to use when writing image data: + :command:`-c none` for no compression, + :command:`-c packbits` for the PackBits compression algorithm, + :command:`-c zip` for the Deflate compression algorithm, + :command:`-c g3` for the CCITT Group 3 compression algorithm, + :command:`-c g4` for the CCITT Group 4 compression algorithm, + :command:`-c lzw` for Lempel-Ziv & Welch (the default). + +.. option:: -r striprows + + Write data with a specified number of rows per strip; + by default the number of rows/strip is selected so that each strip + is approximately 8 kilobytes. + +.. option:: -R redperc + + Specify the percentage of the red channel to use (default 28). + +.. option:: -G greenperc + + Specify the percentage of the green channel to use (default 59). + +.. option:: -B blueperc + + Specify the percentage of the blue channel to use (default 11). + +See also +-------- + +:doc:`pal2rgb` (1), +:doc:`tiffinfo` (1), +:doc:`tiffcp` (1), +:doc:`tiffmedian` (1), +:doc:`/man/libtiff` (3tiff), diff --git a/doc/tools/tiff2pdf.rst b/doc/tools/tiff2pdf.rst new file mode 100644 index 00000000..d76f6c04 --- /dev/null +++ b/doc/tools/tiff2pdf.rst @@ -0,0 +1,211 @@ +tiff2pdf +======== + +.. program:: tiff2pdf + +Synopsis +-------- + +**tiff2pdf** [ *options* ] *input.tiff* + +Description +----------- + +:program:`tiff2pdf` opens a TIFF image and writes a PDF document to standard output. + +The program converts one TIFF file to one PDF file, including multiple page +TIFF files, tiled TIFF files, black and white. grayscale, and color TIFF +files that contain data of TIFF photometric interpretations of bilevel, +grayscale, RGB, YCbCr, CMYK separation, and ICC L*a*b* as supported by +:program:`libtiff` and PDF. + +If you have multiple TIFF files to convert into one PDF file then use :program:`tiffcp` +or other program to concatenate the files into a multiple page TIFF file. +If the input TIFF file is of huge dimensions (greater than 10000 pixels height +or width) convert the input image to a tiled TIFF if it is not already. + +The standard output is standard output. Set the output file name with the +:option:`-o` option. + +All black and white files are compressed into a single strip CCITT G4 Fax +compressed PDF, unless tiled, where tiled black and white images are +compressed into tiled CCITT G4 Fax compressed PDF, +:program:`libtiff` CCITT support is assumed. + +Color and grayscale data can be compressed using either JPEG compression, +ITU-T T.81, or Zip/Deflate LZ77 compression. Set the compression type using +the :option:`-j` or :option:`-z` options. JPEG compression support +requires that :program:`libtiff` be configured with JPEG support, and +Zip/Deflate compression support requires that :program:`libtiff` +be configured with Zip support. Use only one or the other of +:option:`-j` and :option:`-z`. + +If the input TIFF contains single strip CCITT G4 Fax compressed information, +then that is written to the PDF file without transcoding, unless the options +of no compression and no passthrough are set, :option:`-d` and :option:`-n`. + +If the input TIFF contains JPEG or single strip Zip/Deflate compressed +information, and they are configured, then that is written to the PDF file +without transcoding, unless the options of no compression and no passthrough +are set. + +The default page size upon which the TIFF image is placed is determined by +the resolution and extent of the image data. Default values for the TIFF +image resolution can be set using the :option:`-x` and :option:`-y` +options. The page size can be set using the :option:`-p` +option for paper size, or :option:`-w` and :option:`-l` +for paper width and length, then each page of the TIFF image is centered on +its page. The distance unit for default resolution and page width and +length can be set by the :option:`-u` option, the default unit is inch. + +Various items of the output document information can be set with the +:option:`-e`, :option:`-c`, :option:`-a`, :option:`-t`, :option:`-s`, +and :option:`-k` options. Setting the argument of the option to ``""`` for these +tags causes the relevant document information field to be not written. Some +of the document information values otherwise get their information from the +input TIFF image, the software, author, document name, and image description. + +The Portable Document Format (PDF) specification is copyrighted by Adobe +Systems, Incorporated. + +Options +------- + +.. option:: -o output-file + + Set the output to go to file *output-file* + +.. option:: -j + + Compress with JPEG (requires :program:`libjpeg` configured with + :program:`libtiff`). + +.. option:: -z + + Compress with Zip/Deflate (requires :program`zlib` configured with + :program:`libtiff`). + +.. option:: -q quality + + Set the compression quality, 1-100 for JPEG. + +.. option:: -n + + Do not allow data to be converted without uncompressing, no compressed + data passthrough. + +.. option:: -b + + Set PDF ``Interpolate`` user preference. + +.. option:: -d + + Do not compress (decompress). + +.. option:: -i + + Invert colors. + +.. option:: -p paper-size + + Set paper size, e.g., ``letter``, ``legal``, ``A4``. + +.. option:: -F + + Cause the tiff to fill the PDF page. + +.. option:: -u [ i | m ] + + Set distance unit, ``i`` for inch, ``m`` for centimeter. + +.. option:: -w width + + Set width in units. + +.. option:: -l length + + Set length in units. + +.. option:: -x xres + + Set x/width resolution default. + +.. option:: -y yres + + Set y/length resolution default. + +.. option:: -r [ d | o ] + + Set ``d`` for resolution default for images without resolution, + ``o`` for resolution override for all images. + +.. option:: -f + + Set PDF ``Fit Window`` user preference. + +.. option:: -e YYYYMMDDHHMMSS + + Set document information date, overrides image or current date/time default, + ``YYYYMMDDHHMMSS``. + +.. option:: -c creator + + Set document information creator, overrides image software default. + +.. option:: -a author + + Set document information author, overrides image artist default. + +.. option:: -t title + + Set document information title, overrides image document name default. + +.. option:: -s subject + + Set document information subject, overrides image image description default. + +.. option:: -k keywords + + Set document information keywords. + +.. option:: -m size + + Set memory allocation limit (in MiB). Default is 256MiB. Set to 0 to disable the limit. + +.. option:: -h + + List usage reminder to stderr and exit. + +Examples +-------- + +The following example would generate the file output.pdf from input.tiff: + +.. highlight:: shell + +:: + + tiff2pdf -o output.pdf input.tiff + +The following example would generate PDF output from input.tiff and write it +to standard output: + +:: + + tiff2pdf input.tiff + +The following example would generate the file output.pdf from input.tiff, +putting the image pages on a letter sized page, compressing the output +with JPEG, with JPEG quality 75, setting the title to ``Document``, and setting +the ``Fit Window`` option: + +:: + + tiff2pdf -p letter -j -q 75 -t "Document" -f -o output.pdf input.tiff + +See also +-------- + +:doc:`tiffcp` (1), +:doc:`tiff2ps` (1), +:doc:`/man/libtiff` (3tiff), diff --git a/doc/tools/tiff2ps.rst b/doc/tools/tiff2ps.rst new file mode 100644 index 00000000..13d4ef56 --- /dev/null +++ b/doc/tools/tiff2ps.rst @@ -0,0 +1,251 @@ +tiff2ps +======== + +.. program:: tiff2ps + +Synopsis +-------- + +**tiff2ps** [ *options* ] *input.tif* … + +Description +----------- + +:program:`tiff2ps` reads TIFF images and writes PostScriptâ„¢ or Encapsulated +PostScriptâ„¢ (EPS) on the standard output. By default :program:`tiff2ps` +writes Encapsulated PostScriptâ„¢ for the first image in the specified +TIFF image file. + +By default, :program:`tiff2ps` will generate PostScriptâ„¢ that fills a +printed area specified by the TIFF tags in the input file. +If the file does not contain ``XResolution`` or ``YResolution`` +tags, then the printed area is set according to the image dimensions. +The :option:`-w` and :option:`-h` options (see below) +can be used to set the dimensions of the printed area in inches; +overriding any relevant TIFF tags. + +The PostScriptâ„¢ generated for RGB, palette, and CMYK images uses the +``colorimage`` operator. The PostScriptâ„¢ generated for greyscale and +bilevel images uses the ``image`` operator. When the ``colorimage`` +operator is used, PostScriptâ„¢ code to emulate this operator +on older PostScriptâ„¢ printers is also generated. +Note that this emulation code can be very slow. + +Color images with associated alpha data are composited over +a white background. + +Options +------- + +.. option:: -1 + + Generate PostScriptâ„¢ Level 1 (the default). + +.. option:: -2 + + Generate PostScriptâ„¢ Level 2. + +.. option:: -3 + + Generate PostScriptâ„¢ Level 3. It basically allows one to use the ```/flateDecode`` + filter for ZIP compressed TIFF images. + +.. option:: -8 + + Disable use of ASCII85 encoding with PostScriptâ„¢ Level 2/3. + +.. option:: -a + + Generate output for all IFDs (pages) in the input file. + +.. option:: -b margin + + Specify the bottom margin for the output (in inches). This does not affect + the height of the printed image. + +.. option:: -c + + Center the image in the output. This option only shows an effect if both + the :option:`-w` and the :option:`-h` option are given. + +.. option:: -C name + + Specify the document creator name. + +.. option:: -d dir + + Set the initial TIFF + directory to the specified directory number. + (NB: Directories are numbered starting at zero.) + This option is useful for selecting individual pages in a + multi-page (e.g. facsimile) file. + +.. option:: -D + + Enable duplex printing (two pages per sheet of paper). + +.. option:: -e + + Force the generation of Encapsulated PostScriptâ„¢ (implies + :option:`-z`). + +.. option:: -h size + + Specify the vertical size of the printed area (in inches). + +.. option:: -H + + Specify the maximum height of image (in inches). Images with larger sizes will + be split in several pages. Option :option:`-L` + may be used for specifying size of split images overlapping. + +.. option:: -i + + Enable/disable pixel interpolation. This option requires a + single numeric value: zero to disable pixel interpolation and + non-zero to enable. The default is enabled. + +.. option:: -L + + Specify the size of overlapping for split images (in inches). Used in + conjunction with :option:`-H` and :option:`-W` options. + +.. option:: -l + + Specify the left margin for the output (in inches). This does not affect + the width of the printed image. + +.. option:: -M size + + Set maximum memory allocation size (in MiB). The default is 256MiB. + Set to 0 to disable the limit. + + +.. option:: -m + + Where possible render using the ``imagemask`` PostScriptâ„¢ operator instead of the + ``image`` operator. When this option is specified :program:`tiff2ps` will use + ``imagemask`` for rendering 1 bit deep images. If this option is not specified + or if the image depth is greater than 1 then the ``image`` operator is used. + +.. option:: -o ifdoffset + + Set the initial TIFF directory to the IFD at the specified file offset. + This option is useful for selecting thumbnail images and the + like which are hidden using the ``SubIFD`` tag. + +.. option:: -O + + Write PostScriptâ„¢ to specified file instead of standard output. + +.. option:: -p + + Force the generation of (non-Encapsulated) PostScriptâ„¢. + +.. option:: -P L|P + + Set optional PageOrientation DSC comment to Landscape or Portrait. + +.. option:: -r 90|180|270|auto + + Rotate image by 90, 180, 270 degrees or auto. Auto picks the best + fit for the image on the specified paper size (eg portrait + or landscape) if :option:`-h` or :option:`-w` is specified. Rotation is in degrees + counterclockwise. Auto rotates 90 degrees ccw to produce landscape. + +.. option:: -s + + Generate output for a single IFD (page) in the input file. + +.. option:: -t title + + Specify the document title string. + +.. option:: -T + + Print pages for top edge binding. + +.. option:: -w size + + Specify the horizontal size of the printed area (in inches). + +.. option:: -W size + + Specify the maximum width of image (in inches). Images with larger sizes will + be split in several pages. Options :option:`-L` and :option:`-W` + are mutually exclusive. + +.. option:: -x + + Override resolution units specified in the TIFF as centimeters. + +.. option:: -y + + Override resolution units specified in the TIFF as inches. + +.. option:: -z + + When generating PostScriptâ„¢ Level 2, data is scaled so that it does not + image into the ``deadzone`` on a page (the outer margin that the printing device + is unable to mark). This option suppresses this behavior. + When PostScriptâ„¢ Level 1 is generated, data is imaged to the entire printed + page and this option has no affect. + +Examples +-------- + +The following generates PostScriptâ„¢ Level 2 for all pages of a facsimile: + +.. highlight:: shell + +:: + + tiff2ps \-a2 fax.tif | lpr + +Note also that if you have version 2.6.1 or newer of Ghostscript then you +can efficiently preview facsimile generated with the above command. + +To generate Encapsulated PostScriptâ„¢ for a the image at directory 2 +of an image use: + +:: + + tiff2ps \-d 1 foo.tif + +(Notice that directories are numbered starting at zero.) + +If you have a long image, it may be split in several pages: + +:: + + tiff2ps \-h11 \-w8.5 \-H14 \-L.5 foo.tif > foo.ps + +The page size is set to 8.5x11 by :option:`-w` and :option:`-h` +options. We will accept a small amount of vertical compression, so +:option:`-H` set to 14. Any pages between 11 and 14 inches will be fit onto one page. +Pages longer than 14 inches are cut off at 11 and continued on the next +page. The :command:`-L.5` +option says to repeat a half inch on the next page (to improve readability). + +Bugs +---- + +Because PostScriptâ„¢ does not support the notion of a colormap, +8-bit palette images produce 24-bit PostScriptâ„¢ images. +This conversion results in output that is six times +bigger than the original image and which takes a long time +to send to a printer over a serial line. +Matters are even worse for 4-, 2-, and 1-bit palette images. + +Does not handle tiled images when generating PostScriptâ„¢ Level I output. + +See also +-------- + +:doc:`pal2rgb` (1), +:doc:`tiffinfo` (1), +:doc:`tiffcp` (1), +:doc:`tiffgt` (1), +:doc:`tiffmedian` (1), +:doc:`tiff2bw` (1), +:doc:`/man/libtiff` (3tiff), diff --git a/doc/tools/tiff2rgba.rst b/doc/tools/tiff2rgba.rst new file mode 100644 index 00000000..166980c5 --- /dev/null +++ b/doc/tools/tiff2rgba.rst @@ -0,0 +1,72 @@ +tiff2rgba +========= + +.. program:: tiff2rgba + +Synopsis +-------- + +**tiff2rgba** [ *options* ] *input.tif* *output.tif* + +Description +----------- + +:program:`tiff2rgba` converts a wide variety of TIFF images into an RGBA TIFF image. This +includes the ability to translate different color spaces and photometric +interpretation into RGBA, support for alpha blending, and translation +of many different bit depths into a 32bit RGBA image. + +Internally this program is implemented using the :c:func:`TIFFReadRGBAImage` +function, and it suffers any limitations of that function. This includes +limited support for > 8 ``BitsPerSample`` images, and flaws with some +esoteric combinations of ``BitsPerSample``, photometric interpretation, +block organization and planar configuration. + +The generated images are stripped images with four samples per pixel +(red, green, blue and alpha) or if the :option:`-n` flag is used, three samples +per pixel (red, green, and blue). The resulting images are always planar +configuration contiguous. For this reason, this program is a useful utility +for transform exotic TIFF files into a form ingestible by almost any TIFF +supporting software. + +Options +------- + +.. option:: -c + + Specify a compression scheme to use when writing image data: + :command:`-c none` for no compression (the default), + :command:`-c packbits` for the PackBits compression algorithm, + :command:`-c zip` for the Deflate compression algorithm, + :command:`-c jpeg` for the JPEG compression algorithm, and + :command:`-c lzw` for Lempel-Ziv & Welch. + +.. option:: -r striprows + + Write data with a specified number of rows per strip; + by default the number of rows/strip is selected so that each strip + is approximately 8 kilobytes. + + +.. option:: -b + + Process the image one block (strip/tile) at a time instead of by reading + the whole image into memory at once. This may be necessary for very large + images on systems with limited RAM. + +.. option:: -n + + Drop the alpha component from the output file, producing a pure RGB file. + Currently this does not work if the :option:`-b` flag is also in effect. + +.. option:: -M size + + Set maximum memory allocation size (in MiB). The default is 256MiB. + Set to 0 to disable the limit. + +See also +-------- + +:doc:`tiff2bw` (1), +:doc:`/man/TIFFReadRGBAImage` (3tiff), +:doc:`/man/libtiff` (3tiff), diff --git a/doc/tools/tiffcmp.rst b/doc/tools/tiffcmp.rst new file mode 100644 index 00000000..25c4be62 --- /dev/null +++ b/doc/tools/tiffcmp.rst @@ -0,0 +1,59 @@ +tiff2cmp +======== + +.. program:: tiffcmp + +Synopsis +-------- + +**tiffcmp** [ *options* ] *file1.tif* *file2.tif* + +Description +----------- + +:program:`tiffcmp` compares the tags and data in two files created according +to the Tagged Image File Format, Revision 6.0. +The schemes used for compressing data in each file +are immaterial when data are compared\-data are compared on +a scanline-by-scanline basis after decompression. +Most directory tags are checked; notable exceptions are: +``GrayResponseCurve``, ``ColorResponseCurve``, and ``ColorMap`` tags. +Data will not be compared if any of the ``BitsPerSample``, +``SamplesPerPixel``, or ``ImageWidth`` values are not equal. +By default, :program:`tiffcmp` will terminate if it encounters any difference. + +Options +------- + +.. option:: -l + + List each byte of image data that differs between the files. + +.. option:: -z number + + List specified number of image data bytes that differs between the files. + +.. option:: -t + + Ignore any differences in directory tags. + +Bugs +---- + +Tags that are not recognized by the library are not +compared; they may also generate spurious diagnostics. + +The image data of tiled files is not compared, since the :c:func:`TIFFReadScanline` +function is used. An error will be reported for tiled files. + +The pixel and/or sample number reported in differences may be off +in some exotic cases. + +See also +-------- + +:doc:`pal2rgb` (1), +:doc:`tiffinfo` (1), +:doc:`tiffcp` (1), +:doc:`tiffmedian` (1), +:doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/tiffcp.rst b/doc/tools/tiffcp.rst new file mode 100644 index 00000000..6c2ab4cd --- /dev/null +++ b/doc/tools/tiffcp.rst @@ -0,0 +1,255 @@ +tiffcp +====== + +.. program:: tiffcp + +Synopsis +-------- + +**tiffcp** [ *options* ] *src1.tif* … *srcN.tif* *dst.tif* + +Description +----------- +:program:`tiffcp` combines one or more files created according +to the Tag Image File Format, Revision 6.0 into a single TIFF file. +Because the output file may be compressed using a different +algorithm than the input files, :program:`tiffcp` is most often +used to convert between different compression schemes. + +By default, :program:`tiffcp` will copy all the understood tags in a +TIFF directory of an input file to the associated directory in the output file. + +:program:`tiffcp` can be used to reorganize the storage characteristics of data +in a file, but it is explicitly intended to not alter or convert +the image data content in any way. + +Options +------- + +.. option:: -a + + Append to an existing output file instead of overwriting it. + +.. option:: -b image + + subtract the following monochrome image from all others + processed. This can be used to remove a noise bias + from a set of images. This bias image is typically an + image of noise the camera saw with its shutter closed. + +.. option:: -B + + Force output to be written with Big-Endian byte order. + This option only has an effect when the output file is created or + overwritten and not when it is appended to. + +.. option:: -C + + Suppress the use of "strip chopping" when reading images + that have a single strip/tile of uncompressed data. + +.. option:: -c + + Specify the compression to use for data written to the output file: + :command:`-c none` for no compression, + :command:`-c packbits` for PackBits compression, + :command:`-c lzw` for Lempel-Ziv & Welch compression, + :command:`-c zip` for Deflate compression, + :command:`-c lzma` for LZMA2 compression, + :command:`-c jpeg` for baseline JPEG compression, + :command:`-c g3` for CCITT Group 3 (T.4) compression, + :command:`-c g4` for CCITT Group 4 (T.6) compression, or + :command:`-c sgilog` for SGILOG compression. + + By default :program:`tiffcp` will compress data according to the + value of the ``Compression`` tag found in the source file. + + The CCITT Group 3 and Group 4 compression algorithms can only + be used with bilevel data. + + Group 3 compression can be specified together with several + T.4-specific options: + + * ``1d`` for 1-dimensional encoding, + * ``2d`` for 2-dimensional encoding, and + * ``fill`` to force each encoded scanline to be zero-filled so that the + terminating EOL code lies on a byte boundary. + + Group 3-specific options are specified by appending a ``:``-separated + list to the ``g3`` option; e.g. :command:`-c g3:2d:fill` + to get 2D-encoded data with byte-aligned EOL codes. + + LZW, Deflate and LZMA2 compression can be specified together with a + ``predictor`` value. A predictor value of 2 causes each scanline of the output image to + undergo horizontal differencing before it is encoded; a value of 1 forces each + scanline to be encoded without differencing. A value 3 is for floating point + predictor which you can use if the encoded data are in floating point format. + LZW-specific options are specified by appending a ``:``-separated list to the + ``lzw`` option; e.g. :command:`-c lzw:2` for LZW compression with horizontal differencing. + + Deflate and LZMA2 encoders support various compression levels (or encoder presets) set as + character ``p`` and a preset number. ``p1`` is the fastest one with the worst + compression ratio and ``p9`` is the slowest but with the best possible ratio; + e.g. :command:`-c zip:3:p9` for + Deflate encoding with maximum compression level and floating point predictor. + + For the Deflate codec, and in a libtiff build with libdeflate enabled, ``p12`` is + actually the maximum level. + + For the Deflate codec, and in a libtiff build with libdeflate enabled, ``s0`` can be used to + require zlib to be used, and ``s1`` for libdeflate (defaults to libdeflate when + it is available). + +.. option:: -f fillorder + + Specify the bit fill order to use in writing output data. By default, :program:`tiffcp` + will create a new file with the same fill order as the original. Specifying :command:`\-f lsb2msb` + will force data to be written with the ``FillOrder`` tag set to ``LSB2MSB``, while + :command:`\-f msb2lsb` will force data to be written with the ``FillOrder`` tag set to + ``MSB2LSB``. + +.. option:: -i + + Ignore non-fatal read errors and continue processing of the input file. + +.. option:: -l + + Specify the length of a tile (in pixels). + + :program:`tiffcp` attempts to set the tile dimensions so + that no more than 8 kilobytes of data appear in a tile. + +.. option:: -L + + Force output to be written with Little-Endian byte order. + This option only has an effect when the output file is created or + overwritten and not when it is appended to. + +.. option:: -M + + Suppress the use of memory-mapped files when reading images. + +.. option:: -o offset + + Set initial directory offset. + +.. option:: -p + + Specify the planar configuration to use in writing image data + that has one 8-bit sample per pixel. By default, :program:`tiffcp` + will create a new file with the same planar configuration as + the original. Specifying :command:`\-p contig` + will force data to be written with multi-sample data packed + together, while :command:`-p separate` + will force samples to be written in separate planes. + +.. option:: -r + + Specify the number of rows (scanlines) in each strip of data + written to the output file. By default (or when value **0** + is specified), :program:`tiffcp` attempts to set the rows/strip + that no more than 8 kilobytes of data appear in a strip. If you specify + special value **-1** it will results in infinite number of the rows per + strip. The entire image will be the one strip in that case. + +.. option:: -s + + Force the output file to be written with data organized in strips + (rather than tiles). + +.. option:: -t + + Force the output file to be written with data organized in tiles (rather than + strips). options can be used to force the resultant image to be written as + strips or tiles of data, respectively. + +.. option:: -w + + Specify the width of a tile (in pixels). :program::`tiffcp` + attempts to set the tile dimensions so that no more than 8 kilobytes of data + appear in a tile. + +.. option:: -x + + Force the output file to be written with ``PAGENUMBER`` value in sequence. + +.. option:: -8 + + Write BigTIFF instead of classic TIFF format. + +.. option:: -,= character + + substitute *character* for ``,`` + in parsing image directory indices + in files. This is necessary if filenames contain commas. + Note that ``-,=`` + with whitespace immediately following will disable + the special meaning of the ``,`` entirely. See examples. + +.. option:: -m size + + Set maximum memory allocation size (in MiB). The default is 256MiB. + Set to 0 to disable the limit. + +Examples +-------- + +The following concatenates two files and writes the result using LZW encoding: + +.. highlight:: shell + +:: + + tiffcp -c lzw a.tif b.tif result.tif + +To convert a G3 1d-encoded TIFF to a single strip of G4-encoded data the following might be used: + +:: + + tiffcp -c g4 -r 10000 g3.tif g4.tif + +(1000 is just a number that is larger than the number of rows in +the source file.) + +To extract a selected set of images from a multi-image TIFF file, the file +name may be immediately followed by a ``,`` separated list of image directory +indices. The first image is always in directory 0. Thus, to copy the 1st and +3rd images of image file :file:`album.tif` to :file:`result.tif`: + +:: + + tiffcp album.tif,0,2 result.tif + +A trailing comma denotes remaining images in sequence. The following command +will copy all image with except the first one: + +:: + + tiffcp album.tif,1, result.tif + +Given file :file:`CCD.tif` whose first image is a noise bias +followed by images which include that bias, +subtract the noise from all those images following it +(while decompressing) with the command: + +:: + + tiffcp -c none -b CCD.tif CCD.tif,1, result.tif + +If the file above were named :file:`CCD,X.tif`, the ``-,=`` +option would be required to correctly parse this filename with image numbers, +as follows: + +:: + + tiffcp -c none -,=% -b CCD,X.tif CCD,X%1%.tif result.tif + +See also +-------- + +:doc:`pal2rgb` (1), +:doc:`tiffinfo` (1), +:doc:`tiffcmp` (1), +:doc:`tiffmedian` (1), +:doc:`tiffsplit` (1), +:doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/tiffcrop.rst b/doc/tools/tiffcrop.rst new file mode 100644 index 00000000..282a2b0c --- /dev/null +++ b/doc/tools/tiffcrop.rst @@ -0,0 +1,539 @@ +tiffcrop +======== + +.. program:: tiffcrop + +Synopsis +-------- + +**tiffcrop** [ *options* ] *src1.tif* … *srcN.tif* *dst.tif* + +Description +----------- + +:program:`tiffcrop` processes one or more files created according +to the Tag Image File Format, Revision 6.0, specification +into one or more TIFF file(s). +:program:`tiffcrop` is most often used to extract portions of an image for processing +with bar code recognizer or OCR software when that software cannot +restrict the region of interest to a specific portion of the image +or to improve efficiency when the regions of interest must be rotated. +It can also be used to subdivide all or part of a processed image into +smaller sections and export individual images or sections of images +as separate files or separate images within one or more files derived +from the original input image or images. + +The available functions can be grouped broadly into three classes: + +#. Those that select individual images or sections of images from the input files. + The options :option:`-N` for sequences or lists of individual images in the input files, + :option:`-Z` for zones, :option:`-z` for regions, :option:`-X` and :option:`-Y` for fixed sized selections, + :option:`-m` for margins, :option:`-U` for units, and :option:`-E` for edge reference provide a variety of + ways to specify portions of the input image. + +#. Those that allow the individual images or selections to be exported to one or + more output files in different groupings and control the organization of the + data in the output images. The options :option:`-P` for page size grouping, :option:`-S` for + subdivision into columns and rows and :option:`-e` for export mode options that produce + one or more files from each input image. The options :option:`-r`, :option:`-s`, :option:`-t`, :option:`-w` control + strip and tile format and sizes while :option:`-B`, :option:`-L`, :option:`-c`, :option:`-f` modify the endian addressing + scheme, the compression options, and the bit fill sequence of images as they + are written. + +#. Those that perform some action on each image that is selected from the input file. + The options include :option:`-R` for rotate, :option:`-I` for inversion of the photometric + interpretation and/or data values, and :option:`-F` to flip (mirror) the image horizontally + or vertically. + +Functions are applied to the input image(s) in the following order: +cropping, fixed area extraction, zone and region extraction, +inversion, mirroring, rotation. + +Functions are applied to the output image(s) in the following order: +export mode options for grouping zones, regions, or images into +one or more files, *or* row and column divisions with output margins, +*or* page size divisions with page orientation options. + +Finally, strip, tile, byte order, output resolution, and compression options are +applied to all output images. + +The output file(s) may be organized and compressed using a different +algorithm from the input files. +By default, :program:`tiffcrop` will copy all the understood tags in a TIFF +directory of an input file to the associated directory in the output file. +Options can be used to force the resultant image to be written as strips +or tiles of data, respectively. + +:program:`tiffcrop` can be used to reorganize the storage characteristics of data +in a file, and to reorganize, extract, rotate, and otherwise +process the image data as specified at the same time whereas +:program:`tiffcp` does not alter the image data within the file. + +Using the options for selecting individual input images and the +options for exporting images and/or segments defined as zones or +regions of each input image, :program:`tiffcrop` can perform the +functions of :program:`tiffcp` and :program:`tiffsplit` in a single pass +while applying multiple operations to individual selections or images. + +Options +------- + +.. option:: -h + + Display the syntax summary for tiffcrop. + +.. option:: -v + + Report the current version and last modification date for tiffcrop. + +.. option:: -N odd|even|#,#-#,#|last + + Specify one or more series or range(s) of images within each file to process. + The words ``odd`` or ``even`` + may be used to specify all odd or even numbered images counting from one. + Note that internally, TIFF images are numbered from zero rather than one + but since this convention is not obvious to most users, :program:`tiffcrop` used 1 + to specify the first image in a multipage file. The word ``last`` + may be used in place of a number in the sequence to indicate the + final image in the file without knowing how many images there are. + Ranges of images may be specified with a dash and multiple sets + can be indicated by joining them in a comma-separated list. eg. use + ``-N 1,5-7,last`` + to process the 1st, 5th through 7th, and final image in the file. + +.. option:: -E top|bottom|left|right + + Specify the ``top``, ``bottom``, ``left``, or ``right`` edge as the reference from + which to calculate the width and length of crop regions or sequence + of positions for zones. When used with the :option:`-e` option for exporting + zones or regions, the reference edge determines how composite images + are arranged. Using ``-E left`` or ``-E right`` causes successive zones or + regions to be merged horizontally whereas using ``-E top`` or ``-E bottom`` + causes successive zones or regions to be arranged vertically. This + option has no effect on export layout when multiple zones or regions + are not being exported to composite images. Edges may be abbreviated + to the first letter. + +.. option:: -e combined|divided|image|multiple|separate + + Specify the export mode for images and selections from input images. + The final filename on the command line is considered to be the + destination file or filename stem for automatically generated + sequences of files. Modes may be abbreviated to the first letter. + + .. list-table:: Export modes + :widths: 5 20 + :header-rows: 1 + + * - Export mode + - Description + + * - combined + - All images and selections are written to a single file with + multiple selections from one image combined into a single image (default) + * - divided + - All images and selections are written to a single file + with each selection from one image written to a new image + * - image + - Each input image is written to a new file (numeric filename sequence) + with multiple selections from the image combined into one image + * - multiple + - Each input image is written to a new file (numeric filename sequence) + with each selection from the image written to a new image + * - separate + - Individual selections from each image are written to separate files + +.. option:: -U in|cm|px + + Specify the type of units to apply to dimensions for margins and + crop regions for input and output images. Inches or centimeters + are converted to pixels using the resolution unit specified in the + TIFF file (which defaults to inches if not specified in the IFD). + +.. option:: -m top,left,bottom,right + + Specify margins to be removed from the input image. The order must + be *top*, *left*, *bottom*, *right* with only commas separating the elements + of the list. Margins are scaled according to the current units and + removed before any other extractions are computed. + +.. option:: -X # + + Set the horizontal (X-axis) dimension of a region to extract relative to + the specified origin reference. If the origin is the top or bottom + edge, the X axis value will be assumed to start at the left edge. + +.. option:: -Y # + + Set the vertical (Y-axis) dimension of a region to extract relative to + the specified origin reference. If the origin is the left or right + edge, the Y axis value will be assumed to start at the top. + +.. option:: -Z #:#,#:# + + Specify zones of the image designated as position X of Y equal sized portions + measured from the reference edge, eg 1:3 would be first third of the + image starting from the reference edge minus any margins specified + for the confining edges. Multiple zones can be specified as a comma + separated list but they must reference the same edge. To extract the + top quarter and the bottom third of an image you would use + ``-Z 1:4,3:3``. + +.. option:: -z x1,y1,x2,y2: ... :xN,yN,xN+1,yN+1 + + Specify a series of coordinates to define regions for processing and exporting. + The coordinates represent the top left and lower right corners of each region + in the current units, eg inch, cm, or pixels. Pixels are counted from one to + width or height and inches or cm are calculated from image resolution data. + + Each colon delimited series of four values represents the horizontal and vertical + offsets from the top and left edges of the image, regardless of the edge specified + with the :option:`-E` option. The first and third values represent the horizontal offsets of + the corner points from the left edge while the second and fourth values represent + the vertical offsets from the top edge. + +.. option:: -F horiz|vert + + Flip, ie mirror, the image or extracted region horizontally or vertically. + +.. option:: -R 90|180|270 + + Rotate the image or extracted region 90, 180, or 270 degrees clockwise. + +.. option:: -I [black|white|data|both] + + Invert color space, eg dark to light for bilevel and grayscale images. + This can be used to modify negative images to positive or to correct + images that have the ``PHOTOMETRIC_INTERPRETATION`` tag set incorrectly. + If the value is black or white, the ``PHOTOMETRIC_INTERPRETATION`` tag is set to + MinIsBlack or MinIsWhite, without altering the image data. If the argument + is data or both, the data values of the image are modified. Specifying both + inverts the data and the ``PHOTOMETRIC_INTERPRETATION`` tag, whereas using data + inverts the data but not the ``PHOTOMETRIC_INTERPRETATION`` tag. + No support for modifying the color space of color images in this release. + +.. option:: -H # + + Set the horizontal resolution of output images to *#*, + expressed in the current units. + +.. option:: -V # + + Set the vertical resolution of the output images to *#* + expressed in the current units. + +.. option:: -J # + + Set the horizontal margin of an output page size to *#* + expressed in the current units when sectioning image into *columns* × *rows* + subimages using the :option:`-S` ``cols:rows`` option. + +.. option:: -K # + + Set the vertical margin of an output page size to *#* + expressed in the current units when sectioning image into *columns* × *rows* + subimages using the :option:`-S` ``cols:rows`` option. + +.. option:: -O portrait|landscape|auto + + Set the output orientation of the pages or sections. + Auto will use the arrangement that requires the fewest pages. + This option is only meaningful in conjunction with the :option:`-P` + option to format an image to fit on a specific paper size. + +.. option:: -P page + + Format the output images to fit on page size paper. Use + ``-P list`` to show the supported page sizes and dimensions. + You can define a custom page size by entering the width and length of the + page in the current units with the following format ``#.#x#.#``. + +.. option:: -S cols:rows + + Divide each image into cols across and rows down equal sections. + +.. option:: -B + + Force output to be written with Big-Endian byte order. + This option only has an effect when the output file is created or + overwritten and not when it is appended to. + +.. option:: -C + + Suppress the use of "strip chopping" when reading images + that have a single strip/tile of uncompressed data. + +.. option:: -c + + Specify the compression to use for data written to the output file: + :command:`-c none` for no compression, + :command:`-c packbits` for PackBits compression, + :command:`-c lzw` for Lempel-Ziv & Welch compression, + :command:`-c jpeg` for baseline JPEG compression. + :command:`-c zip` for Deflate compression, + :command:`-c g3` for CCITT Group 3 (T.4) compression, + :command:`-c g4` for CCITT Group 4 (T.6) compression. + By default :program:`tiffcrop` will compress data according to the value of the + ``Compression`` tag found in the source file. + + The CCITT Group 3 and Group 4 compression algorithms can only + be used with bilevel data. + + Group 3 compression can be specified together with several + T.4-specific options: + ``1d`` for 1-dimensional encoding, + ``2d`` for 2-dimensional encoding, + ``fill`` to force each encoded scanline to be zero-filled so that the + terminating EOL code lies on a byte boundary. + Group 3-specific options are specified by appending a ``:``-separated + list to the ``g3`` option; e.g. ``-c g3:2d:fill`` + to get 2D-encoded data with byte-aligned EOL codes. + + LZW compression can be specified together with a ``predictor`` + value. A predictor value of 2 causes + each scanline of the output image to undergo horizontal + differencing before it is encoded; a value + of 1 forces each scanline to be encoded without differencing. + LZW-specific options are specified by appending a ``:``-separated + list to the ``lzw`` option; e.g. ``-c lzw:2`` for LZW + compression with horizontal differencing. + +.. option:: -f + + Specify the bit fill order to use in writing output data. + By default, :program:`tiffcrop` + will create a new file with the same fill order as the original. + Specifying + ``-f lsb2msb`` + will force data to be written with the ``FillOrder`` tag set to + ``LSB2MSB``, while + ``-f msb2lsb`` will force data to be written with the ``FillOrder`` + tag set to ``MSB2LSB``. + +.. option:: -i + + Ignore non-fatal read errors and continue processing of the input file. + +.. option:: -k size + + Set maximum memory allocation size (in MiB). The default is 256MiB. + Set to 0 to disable the limit. + +.. option:: -l + + Specify the length of a tile (in pixels). + :program:`tiffcrop` attempts to set the tile dimensions so + that no more than 8 kilobytes of data appear in a tile. + +.. option:: -L + + Force output to be written with Little-Endian byte order. + This option only has an effect when the output file is created or + overwritten and not when it is appended to. + +.. option:: -M + + Suppress the use of memory-mapped files when reading images. + +.. option:: -p + + Specify the planar configuration to use in writing image data + that has more than one sample per pixel. + By default, :program:`tiffcrop` + will create a new file with the same planar configuration as + the original. + Specifying :command:`-p contig` + will force data to be written with multi-sample data packed + together, while + :command:`-p separate` + will force samples to be written in separate planes. + +.. option:: -r + + Specify the number of rows (scanlines) in each strip of data + written to the output file. + By default (or when value **0** is specified), :program:`tiffcrop` + attempts to set the rows/strip that no more than 8 kilobytes of + data appear in a strip. If you specify the special value + **-1** it will results in infinite number of the rows per strip. The entire image + will be the one strip in that case. + +.. option:: -s + + Force the output file to be written with data organized in strips + (rather than tiles). + +.. option:: -t + + Force the output file to be written with data organized in tiles + (rather than strips). + +.. option:: -w + + Specify the width of a tile (in pixels). + :program:`tiffcrop` attempts to set the tile dimensions so + that no more than 8 kilobytes of data appear in a tile. + +.. option:: -D opt1:value1,opt2:value2,opt3:value3:opt4:value4 + + Debug and dump facility + + Display program progress and/or dump raw data to non-TIFF files. + Options include the following and must be joined as a comma + separated list. The use of this option is generally limited to + program debugging and development of future options. An equal sign + may be substituted for the colon in option:value pairs. + + ``debug:N``: + + Display limited program progress indicators where larger *N* + increases the level of detail. + + ``format:txt|raw``: + + Format any logged data as ASCII text or raw binary + values. ASCII text dumps include strings of ones and zeroes representing + the binary values in the image data plus identifying headers. + + ``level:N``: + + Specify the level of detail presented in the dump files. + This can vary from dumps of the entire input or output image data to dumps + of data processed by specific functions. Current range of levels is 1 to 3. + + ``input:full-path-to-directory/input-dumpname``: + + ``output:full-path-to-directory/output-dumpname``: + + When dump files are being written, each image will be written to a separate + file with the name built by adding a numeric sequence value to the dumpname + and an extension of :file:`.txt` for ASCII dumps or :file:`.bin` for binary dumps. + + The four debug/dump options are independent, though it makes little sense to + specify a dump file without specifying a detail level. + + Note: :program:`tiffcrop` may be compiled with :command:`-DDEVELMODE` to enable + additional very low level debug reporting. + +Examples +-------- + +The following concatenates two files and writes the result using LZW +encoding: + +.. highlight:: shell + +:: + + tiffcrop -c lzw a.tif b.tif result.tif + +To convert a G3 1d-encoded TIFF to a single strip of G4-encoded data the following might be used: + +:: + + tiffcrop -c g4 -r 10000 g3.tif g4.tif + +(1000 is just a number that is larger than the number of rows in +the source file.) + +To extract a selected set of images from a multi-image TIFF file +use the :option:`-N` option described above. Thus, to copy the 1st and 3rd +images of image file :file:`album.tif` to :file:`result.tif`: + +:: + + tiffcrop -N 1,3 album.tif result.tif + +Invert a bilevel image scan of a microfilmed document and crop off margins of +0.25 inches on the left and right, 0.5 inch on the top, and 0.75 inch on the +bottom. From the remaining portion of the image, select the second and third +quarters, ie, one half of the area left from the center to each margin: + +:: + + tiffcrop -U in -m 0.5,0.25,0.75,0.25 -E left -Z 2:4,3:4 -I both MicrofilmNegative.tif MicrofilmPostiveCenter.tif + +Extract only the final image of a large Architectural E sized +multipage TIFF file and rotate it 90 degrees clockwise while +reformatting the output to fit on tabloid sized sheets with one +quarter of an inch on each side: + +:: + + tiffcrop -N last -R 90 -O auto -P tabloid -U in -J 0.25 -K 0.25 -H 300 -V 300 Big-PlatMap.tif BigPlatMap-Tabloid.tif + +The output images will have a specified resolution of 300 dpi in both +directions. The orientation of each page will be determined by whichever +choice requires the fewest pages. To specify a specific orientation, use +the portrait or landscape option. The paper size option does not resample +the image. It breaks each original image into a series of smaller images +that will fit on the target paper size at the specified resolution. + +Extract two regions 2048 pixels wide by 2048 pixels high from each page of +a multi-page input file and write each region to a separate output file: + +:: + + tiffcrop -U px -z 1,1,2048,2048:1,2049,2048,4097 -e separate CheckScans.tiff Check + +The output file names will use the stem :file:`Check` with a numeric suffix which is +incremented for each region of each image, eg :file:`Check-001.tiff`, +:file:`Check-002.tiff` … :file:`Check-NNN.tiff`. To produce a unique file for each page +of the input image with one new image for each region of the input image on that page +change the export option to ``-e multiple``. + +Notes +----- + +In general, bilevel, grayscale, palette and RGB(A) data with bit depths +from 1 to 32 bits should work in both interleaved and separate plane +formats. Unlike :program:`tiffcp`, :program:`tiffcrop` can read and write tiled images with +bits per sample that are not a multiple of 8 in both interleaved and +separate planar format. Floating point data types are supported at +bit depths of 16, 24, 32 and 64 bits per sample. + +Not all images can be converted from one compression scheme to another. +Data with some photometric interpretations and/or bit depths are tied to +specific compression schemes and vice-versa, e.g. Group 3/4 compression +is only usable for bilevel data. JPEG compression is only usable on 8 +bit per sample data (or 12 bit if :program:`libtiff` +was compiled with 12 bit JPEG support). Support for OJPEG compressed +images is problematic at best. Since OJPEG compression is no longer +supported for writing images with LibTIFF, these images will be updated +to the newer JPEG compression when they are copied or processed. This +may cause the image to appear color shifted or distorted after conversion. +In some cases, it is possible to remove the original compression from +image data using the option ``-c none``. + +:program:`tiffcrop` does not currently provide options to up or downsample data to +different bit depths or convert data from one photometric interpretation +to another, e.g. 16 bits per sample to 8 bits per sample or RGB to grayscale. + +:program:`tiffcrop` is very loosely derived from code in :program:`tiffcp` +with extensive modifications and additions to support the selection of input +images and regions and the exporting of them to one or more output files in +various groupings. The image manipulation routines are entirely new and +additional ones may be added in the future. It will handle tiled images with +bit depths that are not a multiple of eight that tiffcp may refuse to read. + +:program:`tiffcrop` was designed to handle large files containing many moderate sized images +with memory usage that is independent of the number of images in the file. +In order to support compression modes that are not based on individual +scanlines, e.g. JPEG, it now reads images by strip or tile rather than by +individual scanlines. In addition to the memory required by the input and +output buffers associated with :program:`libtiff` +one or more buffers at least as large as the largest image to be read are +required. The design favors large volume document processing uses over +scientific or graphical manipulation of large datasets as might be found +in research or remote sensing scenarios. + +See also +-------- + +:doc:`pal2rgb` (1), +:doc:`tiffinfo` (1), +:doc:`tiffcmp` (1), +:doc:`tiffcp` (1), +:doc:`tiffmedian` (1), +:doc:`tiffsplit` (1), +:doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/tiffdither.rst b/doc/tools/tiffdither.rst new file mode 100644 index 00000000..9183259b --- /dev/null +++ b/doc/tools/tiffdither.rst @@ -0,0 +1,93 @@ +tiffdither +========== + +.. program:: tiffdither + +Synopsis +-------- + +**tiffdither** [ *options* ] *input.tif* *output.tif* + +Description +----------- + +:program:`tiffdither` converts a single channel 8-bit greyscale image to a bilevel image +using Floyd-Steinberg error propagation with thresholding. + +Options +------- + +.. option:: -c compress + + Specify the compression to use for data written to the output file: + + =========== =================================== + Compression Description + =========== =================================== + none no compression + packbits PackBits compression + lzw Lempel-Ziv & Welch compression + zip Deflate compression + g3 CCITT Group 3 (T.4) compression + g4 for CCITT Group 4 (T.6) compression + =========== =================================== + + By default :program:`tiffdither` + will compress data according to the value of the + ``Compression`` tag found in the source file. + + The CCITT Group 3 and Group 4 compression algorithms can only + be used with bilevel data. + + Group 3 compression can be specified together with several + T.4-specific options: + ``1d`` for 1-dimensional encoding, + ``2d`` for 2-dimensional encoding, and + ``fill`` to force each encoded scanline to be zero-filled so that the + terminating EOL code lies on a byte boundary. + Group 3-specific options are specified by appending a ``:``-separated + list to the ``g3`` option; e.g. ``-c g3:2d:fill`` + to get 2D-encoded data with byte-aligned EOL codes. + + LZW compression can be specified together with a ``predictor`` value. + A predictor value of 2 causes each scanline of the output image to undergo + horizontal differencing before it is encoded; a value + of 1 forces each scanline to be encoded without differencing. + LZW-specific options are specified by appending a ``:``-separated + list to the ``lzw`` option; e.g. ``-c lzw:2`` for LZW + compression with horizontal differencing. + +.. option:: -f + + Specify the bit fill order to use in writing output data. + By default, :program:`tiffdither` + will create a new file with the same fill order as the original. + Specifying + :command:`-f lsb2msb` will force data to be written with the + ``FillOrder`` tag set to ``LSB2MSB``, while + :command:`-f msb2lsb` will force data to be written with the + ``FillOrder`` tag set to ``MSB2LSB``. + +.. option:: -r + + Make each strip have no more than the given number of rows. + +.. option:: -t + + Set the threshold value for dithering. + By default the threshold value is 128. + +Notes +----- + +The dither algorithm is taken from the :program:`tiffmedian` +program (written by Paul Heckbert). + +See also +-------- + +:doc:`pal2rgb` (1), +:doc:`fax2tiff` (1), +:doc:`tiffinfo` (1), +:doc:`tiffcp` (1), +:doc:`tiff2bw` (3tiff) diff --git a/doc/tools/tiffdump.rst b/doc/tools/tiffdump.rst new file mode 100644 index 00000000..2da4e456 --- /dev/null +++ b/doc/tools/tiffdump.rst @@ -0,0 +1,52 @@ +tiffdump +======== + +.. program:: tiffdump + +Synopsis +-------- + +**tiffdump** [ *options* ] *name* … + +Description +----------- + +:program:`tiffdump` displays directory information from files created according +to the Tag Image File Format, Revision 6.0. +The header of each TIFF file (magic number, version, and first directory offset) +is displayed, followed by the tag contents of each directory in the file. +For each tag, the name, data type, count, and value(s) is displayed. +When the symbolic name for a tag or data type is known, the symbolic +name is displayed followed by it's numeric (decimal) value. +Tag values are displayed enclosed in ``<>`` characters immediately +preceded by the value of the count field. +For example, an ``ImageWidth`` +tag might be displayed as ``ImageWidth (256) SHORT (3) 1<800>``. + +:program:`tiffdump` is particularly useful for investigating the contents of +TIFF files that :program:`libtiff` does not understand. + +Options +------- + +.. option:: -h + + Force numeric data to be printed in hexadecimal rather than the + default decimal. + +.. option:: -m items + + Change the number of indirect data items that are printed. By default, this + will be 24. + +.. option:: -o offset + + Dump the contents of the IFD at the a particular file offset. + The file offset may be specified using the usual C-style syntax; + i.e. a leading ``0x`` for hexadecimal and a leading ``0`` for octal. + +See also +-------- + +:doc:`tiffinfo` (1), +:doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/tiffgt.rst b/doc/tools/tiffgt.rst new file mode 100644 index 00000000..0be40723 --- /dev/null +++ b/doc/tools/tiffgt.rst @@ -0,0 +1,186 @@ +tiffgt +====== + +.. program:: tiffgt + +Synopsis +-------- + +**tiffgt** [ *options* ] *input.tif* … + +Description +----------- + +:program:`tiffgt` displays one or more images stored using the +Tag Image File Format, Revision 6.0. + +:program:`tiffgt` correctly handles files with any of the following characteristics: + + .. list-table:: Supported tag values + :widths: 5 20 + :header-rows: 1 + + * - Tag + - Value + + * - BitsPerSample + - 1, 2, 4, 8, 16 + * - SamplesPerPixel + - 1, 3, 4 (the 4th sample is ignored) + * - PhotometricInterpretation + - 0 (min-is-white), 1 (min-is-black), 2 (RGB), 3 (palette), 6 (YCbCr) + * - PlanarConfiguration + - 1 (contiguous), 2 (separate) + * - Orientation + - 1 (top-left), 4 (bottom-left) + +Data may be organized as strips or tiles and may be +compressed with any of the compression algorithms supported +by the :program:`libtiff` library. + +For palette images (``PhotometricInterpretation=3``), :program:`tiffgt` +inspects the colormap values and assumes either 16-bit +or 8-bit values according to the maximum value. +That is, if no colormap entry greater than 255 is found, +:program:`tiffgt` assumes the colormap has only 8-bit values; otherwise +it assumes 16-bit values. +This inspection is done to handle old images written by +previous (incorrect) versions of +:program:`libtiff`. + +:program:`tiffgt` can be used to display multiple images one-at-a-time. +The left mouse button switches the display to the first image in the +*next* file in the list of files specified on the command line. +The right mouse button switches to the first image in the +*previous* file in the list. +The middle mouse button causes the first image in the first file +specified on the command line to be displayed. +In addition the following keyboard commands are recognized: + + .. list-table:: Action keys + :widths: 2 23 + :header-rows: 1 + + * - Key + - Description + + * - :kbd:`b` + - Use a ``PhotometricInterpretation`` + of ``MinIsBlack`` in displaying the current image + * - :kbd:`l` + - Use a ``FillOrder`` of lsb-to-msb in decoding the current image + * - :kbd:`m` + - Use a ``FillOrder`` of msb-to-lsb in decoding the current image + * - :kbd:`c` + - Use a colormap visual to display the current image + * - :kbd:`r` + - Use a true color (24-bit RGB) visual to display the current image + * - :kbd:`w` + - Use a ``PhotometricInterpretation`` of ``MinIsWhite`` in displaying + the current image + * - :kbd:`W` + - Toggle (enable/disable) display of warning messages from the + TIFF library when decoding images + * - :kbd:`E` + - Toggle (enable/disable) display of error messages from the + TIFF library when decoding images. + * - :kbd:`z` + - Reset all parameters to their default settings (``FillOrder``, + ``PhotometricInterpretation``, handling of warnings and errors) + * - :kbd:`PageUp` + - Display the previous image in the current file or the last + image in the previous file + * - :kbd:`PageDown` + - Display the next image in the current file or the first image + in the next file + * - :kbd:`Home` + - Display the first image in the current file + * - :kbd:`End` + - Display the last image in the current file (unimplemented) + +Options +------- + +.. option:: -c + + Force image display in a colormap window. + +.. option:: -d + + Specify an image to display by directory number. + By default the first image in the file is displayed. + Directories are numbered starting at zero. + +.. option:: -e + + Enable reporting of error messages from the TIFF library. + By default :program:`tiffgt` silently ignores images that cannot be read. + +.. option:: -f + + Force :program:`tiffgt` to run as a foreground process. + By default :program:`tiffgt` will place itself in the background once it + has opened the requested image file. + +.. option:: -l + + Force the presumed bit ordering to be LSB to MSB. + +.. option:: -m + + Force the presumed bit ordering to be MSB to LSB. + + +.. option:: -o + + Specify an image to display by directory offset. + By default the first image in the file is displayed. + Directories offsets may be specified using C-style syntax; + i.e. a leading ``0x`` for hexadecimal and a leading ``0`` for octal. + + +.. option:: -p + + Override the value of the ``PhotometricInterpretation`` + tag; the parameter may be one of: ``miniswhite`` , + ``minisblack``, ``rgb``, ``palette``, ``mask``, + ``separated``, ``ycbcr``, and ``cielab``. + +.. option:: -r + + Force image display in a full color window. + +.. option:: -s + + Stop on the first read error. + By default all errors in the input data are ignored and + :program:`tiffgt` + does it's best to display as much of an image as possible. + +.. option:: -w + + Enable reporting of warning messages from the TIFF library. + By default :program:`tiffgt` + ignores warning messages generated when reading an image. + +.. option:: -v + + Place information in the title bar describing + what type of window (full color or colormap) is being + used, the name of the input file, and the directory + index of the image (if non-zero). + By default, the window type is not shown in the title bar. + +Bugs +---- + +Images wider and taller than the display are silently truncated to avoid +crashing old versions of the window manager. + +See also +-------- + +:doc:`tiffdump` (1), +:doc:`tiffinfo` (1), +:doc:`tiffcp` (1), +:doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/tiffinfo.rst b/doc/tools/tiffinfo.rst new file mode 100644 index 00000000..6f0784af --- /dev/null +++ b/doc/tools/tiffinfo.rst @@ -0,0 +1,65 @@ +tiffinfo +======== + +.. program:: tiffinfo + +Synopsis +-------- + +**tiffinfo** [ *options* ] *input.tif* … + +Description +----------- + +:program:`tiffinfo` displays information about files created according +to the Tag Image File Format, Revision 6.0. By default, the contents of +each TIFF directory in each file are displayed, with the value of each +tag shown symbolically (where sensible). + +Options +------- + +.. option:: -c + + Display the colormap and color/gray response curves, if present. + +.. option:: -D + + In addition to displaying the directory tags, + read and decompress all the data in each image (but not display it). + +.. option:: -d + + In addition to displaying the directory tags, + print each byte of decompressed data in hexadecimal. + +.. option:: -j + + Display any JPEG-related tags that are present. + +.. option:: -o + + Set the initial TIFF directory according to the specified file offset. + The file offset may be specified using the usual C-style syntax; + i.e. a leading ``0x`` for hexadecimal and a leading ``0`` for octal. + +.. option:: -s + + Display the offsets and byte counts for each data strip in a directory. + +.. option:: -z + + Enable strip chopping when reading image data. + +.. option:: -# + + Set the initial TIFF directory to *#*. + +See also +-------- + +:doc:`pal2rgb`, +:doc:`tiffcp`, +:doc:`tiffcmp`, +:doc:`tiffmedian`, +:doc:`/man/libtiff` diff --git a/doc/tools/tiffmedian.rst b/doc/tools/tiffmedian.rst new file mode 100644 index 00000000..2f3713d8 --- /dev/null +++ b/doc/tools/tiffmedian.rst @@ -0,0 +1,73 @@ +tiffmedian +========== + +.. program:: tiffmedian + +Synopsis +-------- + +**tiffmedian** [ *options* ] *input.tif* *output.tif* + +Description +----------- + +:program:`tiffmedian` applies the median cut algorithm to an RGB +image in *input.tif* to generate a palette image that is written to +*output.tif*. The generated colormap has, by default, 256 entries. +The image data is quantized by mapping each pixel to the closest color +values in the colormap. + +Options +------- + +.. option:: -c + + Specify the compression to use for data written to the output file: + :command:`-c none` for no compression, + :command:`-c packbits` for PackBits compression, + :command:`-c lzw` for Lempel-Ziv & Welch compression, + :command:`-c zip` for Deflate compression. + + By default :program:`tiffmedian` will compress data according to the + value of the ``Compression`` tag found in the source file. + + LZW compression can be specified together with a ``predictor`` value. + A predictor value of 2 causes each scanline of the output image to + undergo horizontal differencing before it is encoded; a value of 1 + forces each scanline to be encoded without differencing. + LZW-specific options are specified by appending a ``:``-separated + list to the ``lzw`` option; e.g. ``-c lzw:2`` for LZW compression + with horizontal differencing. + +.. option:: -C + + Specify the number of entries to use in the generated colormap. + By default all 256 entries/colors are used. + +.. option:: -f + + Apply Floyd-Steinberg dithering before selecting a colormap entry. + +.. option:: -r + + Specify the number of rows (scanlines) in each strip of data + written to the output file. By default, :program:`tiffmedian` + attempts to set the rows/strip that no more than 8 kilobytes of + data appear in a strip. + +Notes +----- + +This program is derived from Paul Heckbert's :program:`median` program. + +See also +-------- + +:doc:`pal2rgb` (1), +:doc:`tiffinfo` (1), +:doc:`tiffcp` (1), +:doc:`tiffcmp` (1), +:doc:`/man/libtiff` (3tiff), + +**"Color Image Quantization for Frame Buffer Display"**, +Paul Heckbert, SIGGRAPH proceedings, 1982, pp. 297-307. diff --git a/doc/tools/tiffset.rst b/doc/tools/tiffset.rst new file mode 100644 index 00000000..42739926 --- /dev/null +++ b/doc/tools/tiffset.rst @@ -0,0 +1,82 @@ +tiffset +======== + +.. program:: tiffset + +Synopsis +-------- + +**tiffset** [ *options* ] *filename.tif* + +Description +----------- + +:program:`tiffset` sets the value of a TIFF header to a specified value +or removes an existing setting. + +Options +------- + +.. option:: -d dirnumber + + Change the current directory (starting at 0). + +.. option:: -s tagnumber [ count ] value … + + Set the value of the named tag to the value or values specified. + +.. option:: -sd diroffset + + Change the current directory by offset. + +.. option:: -sf tagnumber filename + + Set the value of the tag to the contents of filename. This option is + supported for ASCII tags only. + +.. option:: -u tagnumber + + Unset the tag. + +Examples +-------- + +The following example sets the image description tag (270) of :file:`a.tif` to +the contents of the file :file:`descrip`: + +.. highlight:: shell + +:: + + tiffset -sf 270 descrip a.tif + +The following example sets the artist tag (315) of :file:`a.tif` to the string +``Anonymous``: + +:: + + tiffset -s 315 Anonymous a.tif + + +This example sets the resolution of the file :file:`a.tif` to 300 dpi: + +:: + + tiffset -s 296 2 a.tif + tiffset -s 282 300.0 a.tif + tiffset -s 283 300.0 a.tif + +Set the photometric interpretation of the third page of :file:`a.tif` to +min-is-black (ie. inverts it): + +:: + + tiffset -d 2 -s 262 1 a.tif + +See also +-------- + +:doc:`tiffdump` (1), +:doc:`tiffinfo` (1), +:doc:`tiffcp` (1), +:doc:`/man/libtiff` (3tiff) diff --git a/doc/tools/tiffsplit.rst b/doc/tools/tiffsplit.rst new file mode 100644 index 00000000..c28e8ab6 --- /dev/null +++ b/doc/tools/tiffsplit.rst @@ -0,0 +1,52 @@ +tiffsplit +========= + +.. program:: tiffsplit + +Synopsis +-------- + +**tiffsplit** *src.tif* [ *prefix* ] + +Description +----------- + +:program:`tiffsplit` takes a multi-directory (page) TIFF +file and creates one or more single-directory (page) TIFF +files from it. +The output files are given names created by concatenating +a prefix, a lexically ordered suffix in the range [aaa--zzz], +the suffix :file:`.tif` +(e.g. :file:`xaaa.tif`, :file:`xaab.tif`, :file:`…`, :file:`xzzz.tif`). +If a prefix is not specified on the command line, the default prefix of +:file:`x` is used. + +Options +------- + +None. + +Exit status +----------- + +:program:`tiffsplit` exits with one of the following values: + +0: + + Success + +1: + + An error occurred either reading the input or writing results. + +Bugs +---- + +Only a select set of "known tags" are copied when splitting. + +See also +-------- + +:doc:`tiffcp` (1), +:doc:`tiffinfo` (1), +:doc:`/man/libtiff` (3tiff), diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt deleted file mode 100644 index 0812c60c..00000000 --- a/man/CMakeLists.txt +++ /dev/null @@ -1,95 +0,0 @@ -# CMake build for libtiff -# -# Copyright © 2015 Open Microscopy Environment / University of Dundee -# Written by Roger Leigh <rleigh@codelibre.net> -# -# Permission to use, copy, modify, distribute, and sell this software and -# its documentation for any purpose is hereby granted without fee, provided -# that (i) the above copyright notices and this permission notice appear in -# all copies of the software and related documentation, and (ii) the names of -# Sam Leffler and Silicon Graphics may not be used in any advertising or -# publicity relating to the software without the specific, prior written -# permission of Sam Leffler and Silicon Graphics. -# -# THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -# EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -# WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -# -# IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -# ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -# OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -# WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -# LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -# OF THIS SOFTWARE. - -set(man1_MANS - fax2ps.1 - fax2tiff.1 - pal2rgb.1 - ppm2tiff.1 - raw2tiff.1 - tiff2bw.1 - tiff2pdf.1 - tiff2ps.1 - tiff2rgba.1 - tiffcmp.1 - tiffcp.1 - tiffcrop.1 - tiffdither.1 - tiffdump.1 - tiffgt.1 - tiffinfo.1 - tiffmedian.1 - tiffset.1 - tiffsplit.1) - -set(man3_MANS - libtiff.3tiff - TIFFbuffer.3tiff - TIFFClose.3tiff - TIFFcodec.3tiff - TIFFcolor.3tiff - TIFFDataWidth.3tiff - TIFFError.3tiff - TIFFFieldDataType.3tiff - TIFFFieldName.3tiff - TIFFFieldPassCount.3tiff - TIFFFieldReadCount.3tiff - TIFFFieldTag.3tiff - TIFFFieldWriteCount.3tiff - TIFFFlush.3tiff - TIFFGetField.3tiff - TIFFmemory.3tiff - TIFFOpen.3tiff - TIFFPrintDirectory.3tiff - TIFFquery.3tiff - TIFFReadDirectory.3tiff - TIFFReadEncodedStrip.3tiff - TIFFReadEncodedTile.3tiff - TIFFReadRawStrip.3tiff - TIFFReadRawTile.3tiff - TIFFReadRGBAImage.3tiff - TIFFReadRGBAStrip.3tiff - TIFFReadRGBATile.3tiff - TIFFReadScanline.3tiff - TIFFReadTile.3tiff - TIFFRGBAImage.3tiff - TIFFSetDirectory.3tiff - TIFFSetField.3tiff - TIFFsize.3tiff - TIFFstrip.3tiff - TIFFswab.3tiff - TIFFtile.3tiff - TIFFWarning.3tiff - TIFFWriteDirectory.3tiff - TIFFWriteEncodedStrip.3tiff - TIFFWriteEncodedTile.3tiff - TIFFWriteRawStrip.3tiff - TIFFWriteRawTile.3tiff - TIFFWriteScanline.3tiff - TIFFWriteTile.3tiff) - -install(FILES ${man1_MANS} - DESTINATION "${CMAKE_INSTALL_MANDIR}/man1") -install(FILES ${man3_MANS} - DESTINATION "${CMAKE_INSTALL_MANDIR}/man3") diff --git a/man/Makefile.am b/man/Makefile.am deleted file mode 100644 index 7cc14608..00000000 --- a/man/Makefile.am +++ /dev/null @@ -1,102 +0,0 @@ -# Tag Image File Format (TIFF) Software -# -# Copyright (C) 2004, Andrey Kiselev <dron@ak4719.spb.edu> -# -# Permission to use, copy, modify, distribute, and sell this software and -# its documentation for any purpose is hereby granted without fee, provided -# that (i) the above copyright notices and this permission notice appear in -# all copies of the software and related documentation, and (ii) the names of -# Sam Leffler and Silicon Graphics may not be used in any advertising or -# publicity relating to the software without the specific, prior written -# permission of Sam Leffler and Silicon Graphics. -# -# THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -# EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -# WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -# -# IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -# ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -# OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -# WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -# LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -# OF THIS SOFTWARE. - -# Process this file with automake to produce Makefile.in. - -man1_pages = \ - fax2ps.1 \ - fax2tiff.1 \ - pal2rgb.1 \ - ppm2tiff.1 \ - raw2tiff.1 \ - tiff2bw.1 \ - tiff2pdf.1 \ - tiff2ps.1 \ - tiff2rgba.1 \ - tiffcmp.1 \ - tiffcp.1 \ - tiffcrop.1 \ - tiffdither.1 \ - tiffdump.1 \ - tiffgt.1 \ - tiffinfo.1 \ - tiffmedian.1 \ - tiffset.1 \ - tiffsplit.1 - -man3_pages = \ - libtiff.3tiff \ - TIFFbuffer.3tiff \ - TIFFClose.3tiff \ - TIFFcodec.3tiff \ - TIFFcolor.3tiff \ - TIFFDataWidth.3tiff \ - TIFFError.3tiff \ - TIFFFieldDataType.3tiff \ - TIFFFieldName.3tiff \ - TIFFFieldPassCount.3tiff \ - TIFFFieldReadCount.3tiff \ - TIFFFieldTag.3tiff \ - TIFFFieldWriteCount.3tiff \ - TIFFFlush.3tiff \ - TIFFGetField.3tiff \ - TIFFmemory.3tiff \ - TIFFOpen.3tiff \ - TIFFPrintDirectory.3tiff \ - TIFFquery.3tiff \ - TIFFReadDirectory.3tiff \ - TIFFReadEncodedStrip.3tiff \ - TIFFReadEncodedTile.3tiff \ - TIFFReadRawStrip.3tiff \ - TIFFReadRawTile.3tiff \ - TIFFReadRGBAImage.3tiff \ - TIFFReadRGBAStrip.3tiff \ - TIFFReadRGBATile.3tiff \ - TIFFReadScanline.3tiff \ - TIFFReadTile.3tiff \ - TIFFRGBAImage.3tiff \ - TIFFSetDirectory.3tiff \ - TIFFSetField.3tiff \ - TIFFsize.3tiff \ - TIFFstrip.3tiff \ - TIFFswab.3tiff \ - TIFFtile.3tiff \ - TIFFWarning.3tiff \ - TIFFWriteDirectory.3tiff \ - TIFFWriteEncodedStrip.3tiff \ - TIFFWriteEncodedTile.3tiff \ - TIFFWriteRawStrip.3tiff \ - TIFFWriteRawTile.3tiff \ - TIFFWriteScanline.3tiff \ - TIFFWriteTile.3tiff - -if TIFF_DOCS -man1_MANS = $(man1_pages) -man3_MANS = $(man3_pages) -endif - - -EXTRA_DIST = \ - $(man1_pages) \ - $(man3_pages) \ - CMakeLists.txt diff --git a/man/TIFFClose.3tiff b/man/TIFFClose.3tiff deleted file mode 100644 index fc64ccc3..00000000 --- a/man/TIFFClose.3tiff +++ /dev/null @@ -1,52 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFClose 3TIFF "November 2, 2005" "libtiff" -.SH NAME -TIFFClose \- close a previously opened -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "void TIFFClose(TIFF *" tif ")" -.SH DESCRIPTION -.IR TIFFClose -closes a file that was previously opened with -.BR TIFFOpen (3TIFF). -Any buffered data are flushed to the file, including the contents of the -current directory (if modified); and all resources are reclaimed. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -Likewise, warning messages are directed to the -.BR TIFFWarning (3TIFF) -routine. -.SH "SEE ALSO" -.BR libtiff (3TIFF), -.BR TIFFOpen (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFDataWidth.3tiff b/man/TIFFDataWidth.3tiff deleted file mode 100644 index d69cd115..00000000 --- a/man/TIFFDataWidth.3tiff +++ /dev/null @@ -1,73 +0,0 @@ -.\" -.\" Copyright (c) 2002, Andrey Kiselev <dron@ak4719.spb.edu> -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFDataWidth 3TIFF "September 12, 2002" "libtiff" -.SH NAME -TIFFDataWidth \- Get the size of TIFF data types -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFDataWidth(TIFFDataType " type ")" -.SH DESCRIPTION -.I TIFFDataWidth -returns a size of -.I type -in bytes. -Currently following data types are supported: -.br -.I TIFF_BYTE -.br -.I TIFF_ASCII -.br -.I TIFF_SBYTE -.br -.I TIFF_UNDEFINED -.br -.I TIFF_SHORT -.br -.I TIFF_SSHORT -.br -.I TIFF_LONG -.br -.I TIFF_SLONG -.br -.I TIFF_FLOAT -.br -.I TIFF_IFD -.br -.I TIFF_RATIONAL -.br -.I TIFF_SRATIONAL -.br -.I TIFF_DOUBLE -.br -.SH "RETURN VALUES" -.br -.IR TIFFDataWidth -returns a number of bytes occupied by the item of given type. 0 returned when -unknown data type supplied. -.SH "SEE ALSO" -.BR libtiff (3TIFF), -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFError.3tiff b/man/TIFFError.3tiff deleted file mode 100644 index 5d0c2196..00000000 --- a/man/TIFFError.3tiff +++ /dev/null @@ -1,68 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFError 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFError, TIFFSetErrorHandler \- library error handling interface -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "void TIFFError(const char *" module ", const char *" fmt ", " ... ")" -.sp -.B "#include <stdarg.h>" -.sp -.BI "typedef void (*TIFFErrorHandler)(const char *" module ", const char *" fmt ", va_list " ap ");" -.br -.B "TIFFErrorHandler TIFFSetErrorHandler(TIFFErrorHandler handler);" -.SH DESCRIPTION -.I TIFFError -invokes the library-wide error handling function to (normally) write an error -message to the -.BR stderr . -The -.I fmt -parameter is a -.IR printf (3S) -format string, and any number arguments can be supplied. The -.I module -parameter, if non-zero, is printed before the message; it typically is used to -identify the software module in which an error is detected. -.PP -Applications that desire to capture control in the event of an error should -use -.IR TIFFSetErrorHandler -to override the default error handler. -A -.SM NULL -(0) error handling function may be installed to suppress error messages. -.SH "RETURN VALUES" -.IR TIFFSetErrorHandler -returns a reference to the previous error handling function. -.SH "SEE ALSO" -.BR TIFFWarning (3TIFF), -.BR libtiff (3TIFF), -.BR printf (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFFieldDataType.3tiff b/man/TIFFFieldDataType.3tiff deleted file mode 100644 index 6049f591..00000000 --- a/man/TIFFFieldDataType.3tiff +++ /dev/null @@ -1,52 +0,0 @@ -.\" -.\" Copyright (c) 2012, Tom Lane <tgl@sss.pgh.pa.us> -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFFieldDataType 3TIFF "July 26, 2012" "libtiff" -.SH NAME -TIFFFieldDataType \- Get TIFF data type from field information -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "TIFFDataType TIFFFieldDataType(const TIFFField* " fip ")" -.SH DESCRIPTION -.BR TIFFFieldDataType -returns the data type stored in a TIFF field. -.P -.I fip -is a field information pointer previously returned by -.BR TIFFFindField , -.BR TIFFFieldWithTag , -or -.BR TIFFFieldWithName . -.br -.SH "RETURN VALUES" -.br -.BR TIFFFieldDataType -returns a member of the enum type -.BR TIFFDataType . -.br -.SH "SEE ALSO" -.BR libtiff (3TIFF), -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFFieldName.3tiff b/man/TIFFFieldName.3tiff deleted file mode 100644 index 47d9ad84..00000000 --- a/man/TIFFFieldName.3tiff +++ /dev/null @@ -1,51 +0,0 @@ -.\" -.\" Copyright (c) 2012, Tom Lane <tgl@sss.pgh.pa.us> -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFFieldName 3TIFF "July 26, 2012" "libtiff" -.SH NAME -TIFFFieldName \- Get TIFF field name from field information -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "const char* TIFFFieldName(const TIFFField* " fip ")" -.SH DESCRIPTION -.BR TIFFFieldName -returns the textual name for a TIFF field. -.P -.I fip -is a field information pointer previously returned by -.BR TIFFFindField , -.BR TIFFFieldWithTag , -or -.BR TIFFFieldWithName . -.br -.SH "RETURN VALUES" -.br -.BR TIFFFieldName -returns a constant C string. -.br -.SH "SEE ALSO" -.BR libtiff (3TIFF), -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFFieldPassCount.3tiff b/man/TIFFFieldPassCount.3tiff deleted file mode 100644 index 45018573..00000000 --- a/man/TIFFFieldPassCount.3tiff +++ /dev/null @@ -1,72 +0,0 @@ -.\" -.\" Copyright (c) 2012, Tom Lane <tgl@sss.pgh.pa.us> -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFFieldPassCount 3TIFF "July 26, 2012" "libtiff" -.SH NAME -TIFFFieldPassCount \- Get whether to pass a count to TIFFGet/SetField -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFFieldPassCount(const TIFFField* " fip ")" -.SH DESCRIPTION -.BR TIFFFieldPassCount -returns true (nonzero) if -.BR TIFFGetField -and -.BR TIFFSetField -expect a -.I count -value to be passed before the actual data pointer. -.P -.I fip -is a field information pointer previously returned by -.BR TIFFFindField , -.BR TIFFFieldWithTag , -or -.BR TIFFFieldWithName . -.P -When a -.I count -is required, it will be of type -.BR uint32_t -when -.BR TIFFFieldReadCount -reports -.BR TIFF_VARIABLE2 , -and of type -.BR uint16_t -otherwise. (This distinction is critical for use of -.BR TIFFGetField , -but normally not so for use of -.BR TIFFSetField .) -.br -.SH "RETURN VALUES" -.br -.BR TIFFFieldPassCount -returns an integer that is always 1 (true) or 0 (false). -.br -.SH "SEE ALSO" -.BR libtiff (3TIFF), -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFFieldReadCount.3tiff b/man/TIFFFieldReadCount.3tiff deleted file mode 100644 index 80bcc6b3..00000000 --- a/man/TIFFFieldReadCount.3tiff +++ /dev/null @@ -1,76 +0,0 @@ -.\" -.\" Copyright (c) 2012, Tom Lane <tgl@sss.pgh.pa.us> -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFFieldReadCount 3TIFF "July 26, 2012" "libtiff" -.SH NAME -TIFFFieldReadCount \- Get number of values to be read from field -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFFieldReadCount(const TIFFField* " fip ")" -.SH DESCRIPTION -.BR TIFFFieldReadCount -returns the number of values available to be read from the specified -TIFF field; that is, the number of arguments that should be supplied to -.BR TIFFGetField . -For most field types this is a small positive integer, typically 1 or 2, -but there are some special values: -.br -.BR TIFF_VARIABLE -indicates that a variable number of values is possible; then, a -.BR uint16_t -.I count -argument and a pointer -.I data -argument must be supplied to -.BR TIFFGetField . -.br -.BR TIFF_VARIABLE2 -is the same as -.BR TIFF_VARIABLE -except that the -.I count -argument must have type -.BR uint32_t . -.br -.BR TIFF_SPP -indicates that the number of arguments is equal to the image's -number of samples per pixel. -.P -.I fip -is a field information pointer previously returned by -.BR TIFFFindField , -.BR TIFFFieldWithTag , -or -.BR TIFFFieldWithName . -.br -.SH "RETURN VALUES" -.br -.BR TIFFFieldReadCount -returns an integer. -.br -.SH "SEE ALSO" -.BR libtiff (3TIFF), -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFFieldTag.3tiff b/man/TIFFFieldTag.3tiff deleted file mode 100644 index 2fe41841..00000000 --- a/man/TIFFFieldTag.3tiff +++ /dev/null @@ -1,55 +0,0 @@ -.\" -.\" Copyright (c) 2012, Tom Lane <tgl@sss.pgh.pa.us> -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFFieldTag 3TIFF "July 26, 2012" "libtiff" -.SH NAME -TIFFFieldTag \- Get TIFF field tag value from field information -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "uint32_t TIFFFieldTag(const TIFFField* " fip ")" -.SH DESCRIPTION -.BR TIFFFieldTag -returns the numeric tag value for a TIFF field. -This can be compared to various constants exported by the -.BR libtiff -header files, such as -.BR TIFFTAG_IMAGEWIDTH . -.P -.I fip -is a field information pointer previously returned by -.BR TIFFFindField , -.BR TIFFFieldWithTag , -or -.BR TIFFFieldWithName . -.br -.SH "RETURN VALUES" -.br -.BR TIFFFieldTag -returns an integer tag value. -.br -.SH "SEE ALSO" -.BR libtiff (3TIFF), -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFFieldWriteCount.3tiff b/man/TIFFFieldWriteCount.3tiff deleted file mode 100644 index bfc7222c..00000000 --- a/man/TIFFFieldWriteCount.3tiff +++ /dev/null @@ -1,87 +0,0 @@ -.\" -.\" Copyright (c) 2012, Tom Lane <tgl@sss.pgh.pa.us> -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFFieldWriteCount 3TIFF "July 26, 2012" "libtiff" -.SH NAME -TIFFFieldWriteCount \- Get number of values to be written to field -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFFieldWriteCount(const TIFFField* " fip ")" -.SH DESCRIPTION -.BR TIFFFieldWriteCount -returns the number of values to be written into the specified -TIFF field; that is, the number of arguments that should be supplied to -.BR TIFFSetField . -For most field types this is a small positive integer, typically 1 or 2, -but there are some special values: -.br -.BR TIFF_VARIABLE -indicates that a variable number of values is possible; then, a -.BR uint16_t -.I count -argument and a pointer -.I data -argument must be supplied to -.BR TIFFSetField . -.br -.BR TIFF_VARIABLE2 -is the same as -.BR TIFF_VARIABLE -except that the -.I count -argument must have type -.BR uint32_t . -(On most modern machines, this makes no practical difference, and the -.I count -argument can simply be an -.BR int -in either case.) -.br -.BR TIFF_SPP -indicates that the number of arguments must be equal to the image's -number of samples per pixel. -.P -.I fip -is a field information pointer previously returned by -.BR TIFFFindField , -.BR TIFFFieldWithTag , -or -.BR TIFFFieldWithName . -.P -For most field types, -.BR TIFFFieldWriteCount -returns the same value as -.BR TIFFFieldReadCount , -but there are some exceptions. -.br -.SH "RETURN VALUES" -.br -.BR TIFFFieldWriteCount -returns an integer. -.br -.SH "SEE ALSO" -.BR libtiff (3TIFF), -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFFlush.3tiff b/man/TIFFFlush.3tiff deleted file mode 100644 index c46a2a3f..00000000 --- a/man/TIFFFlush.3tiff +++ /dev/null @@ -1,63 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFFlush 3TIFF "December 16, 1991" "libtiff" -.SH NAME -TIFFFlush, TIFFFlushData \- flush pending writes to an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFFlush(TIFF *" tif ")" -.br -.BI "int TIFFFlushData(TIFF *" tif ")" -.SH DESCRIPTION -.IR TIFFFlush -causes any pending writes for the specified file (including writes for the -current directory) to be done. In normal operation this call is never needed \- -the library automatically does any flushing required. -.PP -.IR TIFFFlushData -flushes any pending image data for the specified file to be written out; -directory-related data are not flushed. In normal operation this call is never -needed \- the library automatically does any flushing required. -.SH "RETURN VALUES" -0 is returned if an error is encountered, otherwise 1 is returned. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFWriteEncodedStrip (3TIFF), -.BR TIFFWriteEncodedTile (3TIFF), -.BR TIFFWriteRawStrip (3TIFF), -.BR TIFFWriteRawTile (3TIFF), -.BR TIFFWriteScanline (3TIFF), -.BR TIFFWriteTile (3TIFF) -.BR libtiff (3TIFF), -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFGetField.3tiff b/man/TIFFGetField.3tiff deleted file mode 100644 index dc158578..00000000 --- a/man/TIFFGetField.3tiff +++ /dev/null @@ -1,228 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFGetField 3TIFF "March 29, 2020" "libtiff" -.SH NAME -TIFFGetField, TIFFVGetField \- get the value(s) of a tag in an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFGetField(TIFF *" tif ", ttag_t " tag ", " ... ")" -.sp -.B "#include <stdarg.h>" -.sp -.BI "int TIFFVGetField(TIFF *" tif ", ttag_t " tag ", va_list " ap ")" -.br -.BI "int TIFFGetFieldDefaulted(TIFF *" tif ", ttag_t " tag ", " ... ")" -.br -.BI "int TIFFVGetFieldDefaulted(TIFF *" tif ", ttag_t " tag ", va_list " ap ")" -.SH DESCRIPTION -.IR TIFFGetField -returns the value of a tag or pseudo-tag associated with the the current -directory of the opened -.SM TIFF -file -.IR tif . -(A -.I pseudo-tag -is a parameter that is used to control the operation of the -.SM TIFF -library but whose value is not read or written to the underlying file.) The -file must have been previously opened with -.IR TIFFOpen (3TIFF). -The tag is identified by -.IR tag , -one of the values defined in the include file -.B tiff.h -(see also the table below). The type and number of values returned is -dependent on the tag being requested. The programming interface uses a -variable argument list as prescribed by the -.IR stdarg (3) -interface. The returned values should only be interpreted if -.IR TIFFGetField -returns 1. -.PP -.IR TIFFVGetField -is functionally equivalent to -.IR TIFFGetField -except that it takes a pointer to a variable argument list. -.I TIFFVGetField -is useful for layering interfaces on top of the functionality provided by -.IR TIFFGetField . -.PP -.IR TIFFGetFieldDefaulted -and -.IR TIFFVGetFieldDefaulted -are identical to -.IR TIFFGetField -and -.IR TIFFVGetField , -except that if a tag is not defined in the current directory and it has a -default value, then the default value is returned. -.PP -The tags understood by -.IR libtiff(3TIFF), -the number of parameter values, and the types for the returned values are -shown below. The data types are specified as in C and correspond to the types -used to specify tag values to -.IR TIFFSetField (3TIFF). -Remember that -.IR TIFFGetField -returns parameter values, so all the listed data types are pointers to storage -where values should be returned. -Consult the -.SM TIFF -specification (or relevant industry specification) for information on the -meaning of each tag and their possible values. -.PP -.nf -.ta \w'TIFFTAG_CONSECUTIVEBADFAXLINES'u+2n +\w'Count'u+2n +\w'TIFFFaxFillFunc*'u+2n -\fITag Name\fP \fICount\fP \fITypes\fP \fINotes\fP -.sp 5p -TIFFTAG_ARTIST 1 const char** -TIFFTAG_BADFAXLINES 1 uint32_t* -TIFFTAG_BITSPERSAMPLE 1 uint16_t* -TIFFTAG_CLEANFAXDATA 1 uint16_t* -TIFFTAG_COLORMAP 3 const uint16_t** 1<<BitsPerSample arrays -TIFFTAG_COMPRESSION 1 uint16_t* -TIFFTAG_CONSECUTIVEBADFAXLINES 1 uint32_t* -TIFFTAG_COPYRIGHT 1 const char** -TIFFTAG_DATATYPE 1 uint16_t* -TIFFTAG_DATETIME 1 const char** -TIFFTAG_DOCUMENTNAME 1 const char** -TIFFTAG_DOTRANGE 2 uint16_t* -TIFFTAG_EXTRASAMPLES 2 uint16_t*,const uint16_t** count & types array -TIFFTAG_FAXFILLFUNC 1 TIFFFaxFillFunc* G3/G4 compression pseudo-tag -TIFFTAG_FAXMODE 1 int* G3/G4 compression pseudo-tag -TIFFTAG_FILLORDER 1 uint16_t* -TIFFTAG_GROUP3OPTIONS 1 uint32_t* -TIFFTAG_GROUP4OPTIONS 1 uint32_t* -TIFFTAG_HALFTONEHINTS 2 uint16_t* -TIFFTAG_HOSTCOMPUTER 1 const char** -TIFFTAG_ICCPROFILE 2 const uint32_t*,const void** count, profile data -TIFFTAG_IMAGEDEPTH 1 uint32_t* -TIFFTAG_IMAGEDESCRIPTION 1 const char** -TIFFTAG_IMAGELENGTH 1 uint32_t* -TIFFTAG_IMAGEWIDTH 1 uint32_t* -TIFFTAG_INKNAMES 1 const char** -TIFFTAG_INKSET 1 uint16_t* -TIFFTAG_JPEGCOLORMODE 1 int* JPEG pseudo-tag -TIFFTAG_JPEGQUALITY 1 int* JPEG pseudo-tag -TIFFTAG_JPEGTABLES 2 uint32_t*,const void** count & tables -TIFFTAG_JPEGTABLESMODE 1 int* JPEG pseudo-tag -TIFFTAG_MAKE 1 const char** -TIFFTAG_MATTEING 1 uint16_t* -TIFFTAG_MAXSAMPLEVALUE 1 uint16_t* -TIFFTAG_MINSAMPLEVALUE 1 uint16_t* -TIFFTAG_MODEL 1 const char** -TIFFTAG_ORIENTATION 1 uint16_t* -TIFFTAG_PAGENAME 1 const char** -TIFFTAG_PAGENUMBER 2 uint16_t* -TIFFTAG_PHOTOMETRIC 1 uint16_t* -TIFFTAG_PHOTOSHOP 2 uint32_t*,const void** count, data -TIFFTAG_PLANARCONFIG 1 uint16_t* -TIFFTAG_PREDICTOR 1 uint16_t* -TIFFTAG_PRIMARYCHROMATICITIES 1 const float** 6-entry array -TIFFTAG_REFERENCEBLACKWHITE 1 const float** 6-entry array -TIFFTAG_RESOLUTIONUNIT 1 uint16_t* -TIFFTAG_RICHTIFFIPTC 2 uint32_t*,const void** count, data -TIFFTAG_ROWSPERSTRIP 1 uint32_t* -TIFFTAG_SAMPLEFORMAT 1 uint16_t* -TIFFTAG_SAMPLESPERPIXEL 1 uint16_t* -TIFFTAG_SMAXSAMPLEVALUE 1 double* -TIFFTAG_SMINSAMPLEVALUE 1 double* -TIFFTAG_SOFTWARE 1 const char** -TIFFTAG_STONITS 1 const double** -TIFFTAG_STRIPBYTECOUNTS 1 const uint64_t** -TIFFTAG_STRIPOFFSETS 1 const uint64_t** -TIFFTAG_SUBFILETYPE 1 uint32_t* -TIFFTAG_SUBIFD 2 uint16_t*,const uint64_t** count & offsets array -TIFFTAG_TARGETPRINTER 1 const char** -TIFFTAG_THRESHHOLDING 1 uint16_t* -TIFFTAG_TILEBYTECOUNTS 1 const uint64_t** -TIFFTAG_TILEDEPTH 1 uint32_t* -TIFFTAG_TILELENGTH 1 uint32_t* -TIFFTAG_TILEOFFSETS 1 const uint64_t** -TIFFTAG_TILEWIDTH 1 uint32_t* -TIFFTAG_TRANSFERFUNCTION 1 or 3\(dg const uint16_t**1<<BitsPerSample entry arrays -TIFFTAG_WHITEPOINT 1 const float** 2-entry array -TIFFTAG_XMLPACKET 2 uint32_t*,const void** count, data -TIFFTAG_XPOSITION 1 float* -TIFFTAG_XRESOLUTION 1 float* -TIFFTAG_YCBCRCOEFFICIENTS 1 const float** 3-entry array -TIFFTAG_YCBCRPOSITIONING 1 uint16_t* -TIFFTAG_YCBCRSUBSAMPLING 2 uint16_t* -TIFFTAG_YPOSITION 1 float* -TIFFTAG_YRESOLUTION 1 float*\(dd -.fi -\(dg If -.I SamplesPerPixel -is one, then a single array is returned; otherwise three arrays are returned. -.fi -\(dd The contents of this field are quite complex. See -.IR "The ICC Profile Format Specification" , -Annex B.3 "Embedding ICC Profiles in TIFF Files" (available at -http://www.color.org) for an explanation. -.SH AUTOREGISTERED TAGS -If you can't find the tag in the table above that means this is an unsupported -tag and is not directly supported by -.BR libtiff(3TIFF) -library. You will still be able to read it's value if you know the data type of -that tag. For example, if you want to read the LONG value from the tag 33424 -and ASCII string from the tag 36867 you can use the following code: -.PP -.RS -.nf -uint32_t count; -void *data; - -TIFFGetField(tiff, 33424, &count, &data); -printf("Tag %d: %d, count %d\n", 33424, *(uint32_t *)data, count); -TIFFGetField(tiff, 36867, &count, &data); -printf("Tag %d: %s, count %d\n", 36867, (char *)data, count); -.fi -.RE -.PP -.SH RETURN VALUES -1 is returned if the tag is defined in the current directory; otherwise a 0 is -returned. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.PP -.BR "Unknown field, tag 0x%x" . -An unknown tag was supplied. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFSetField (3TIFF), -.BR TIFFSetDirectory (3TIFF), -.BR TIFFReadDirectory (3TIFF), -.BR TIFFWriteDirectory (3TIFF) -.BR libtiff (3TIFF), -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFOpen.3tiff b/man/TIFFOpen.3tiff deleted file mode 100644 index c6ed28e6..00000000 --- a/man/TIFFOpen.3tiff +++ /dev/null @@ -1,293 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFOpen 3TIFF "July 1, 2005" "libtiff" -.SH NAME -TIFFOpen, TIFFFdOpen, TIFFClientOpen \- open a -.SM TIFF -file for reading or writing -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "TIFF* TIFFOpen(const char *" filename ", const char *" mode ")" -.br -.BI "TIFF* TIFFFdOpen(const int " fd ", const char *" filename ", const char *" mode ")" -.sp -.B "typedef tsize_t (*TIFFReadWriteProc)(thandle_t, tdata_t, tsize_t);" -.br -.B "typedef toff_t (*TIFFSeekProc)(thandle_t, toff_t, int);" -.br -.B "typedef int (*TIFFCloseProc)(thandle_t);" -.br -.B "typedef toff_t (*TIFFSizeProc)(thandle_t);" -.br -.B "typedef int (*TIFFMapFileProc)(thandle_t, tdata_t*, toff_t*);" -.br -.B "typedef void (*TIFFUnmapFileProc)(thandle_t, tdata_t, toff_t);" -.sp -.BI "TIFF* TIFFClientOpen(const char *" filename ", const char *" mode ", thandle_t " clientdata ", TIFFReadWriteProc " readproc ", TIFFReadWriteProc " writeproc ", TIFFSeekProc " seekproc ", TIFFCloseProc " closeproc ", TIFFSizeProc " sizeproc ", TIFFMapFileProc " mapproc ", TIFFUnmapFileProc " unmapproc ")" -.SH DESCRIPTION -.IR TIFFOpen -opens a -.SM TIFF -file whose name is -.I filename -and returns a handle to be used in subsequent calls to routines in -.IR libtiff . -If the open operation fails, then zero is returned. -The -.I mode -parameter specifies if the file is to be opened for reading (``r''), -writing (``w''), or appending (``a'') and, optionally, whether -to override certain default aspects of library operation (see below). -When a file is opened for appending, existing data will not -be touched; instead new data will be written as additional subfiles. -If an existing file is opened for writing, all previous data is -overwritten. -.PP -If a file is opened for reading, the first -.SM TIFF -directory in the file is automatically read -(also see -.IR TIFFSetDirectory (3TIFF) -for reading directories other than the first). -If a file is opened for writing or appending, a default directory -is automatically created for writing subsequent data. -This directory has all the default values specified in -.SM TIFF -Revision 6.0: -.IR BitsPerSample =1, -.IR ThreshHolding "=bilevel art scan," -.IR FillOrder =1 -(most significant bit of each data byte is filled first), -.IR Orientation =1 -(the 0th row represents the visual top of the image, and the 0th -column represents the visual left hand side), -.IR SamplesPerPixel =1, -.IR RowsPerStrip =infinity, -.IR ResolutionUnit =2 -(inches), and -.IR Compression =1 -(no compression). -To alter these values, or to define values for additional fields, -.IR TIFFSetField (3TIFF) -must be used. -.PP -.IR TIFFFdOpen -is like -.IR TIFFOpen -except that it opens a -.SM TIFF -file given an open file descriptor -.IR fd . -The file's name and mode must reflect that of the open descriptor. -The object associated with the file descriptor -.BR "must support random access" . -.PP -.IR TIFFClientOpen -is like -.IR TIFFOpen -except that the caller supplies a collection of functions that the -library will use to do \s-1UNIX\s+1-like I/O operations. -The -.I readproc -and -.I writeproc -are called to read and write data at the current file position. -.I seekproc -is called to change the current file position a la -.IR lseek (2). -.I closeproc -is invoked to release any resources associated with an open file. -.I sizeproc -is invoked to obtain the size in bytes of a file. -.I mapproc -and -.I unmapproc -are called to map and unmap a file's contents in memory; c.f. -.IR mmap (2) -and -.IR munmap (2). -The -.I clientdata -parameter is an opaque ``handle'' passed to the client-specified -routines passed as parameters to -.IR TIFFClientOpen . -.SH OPTIONS -The open mode parameter can include the following flags in -addition to the ``r'', ``w'', and ``a'' flags. -Note however that option flags must follow the read-write-append -specification. -.TP -.B l -When creating a new file force information be written with -Little-Endian byte order (but see below). -By default the library will create new files using the native -.SM CPU -byte order. -.TP -.B b -When creating a new file force information be written with -Big-Endian byte order (but see below). -By default the library will create new files using the native -.SM CPU -byte order. -.TP -.B L -Force image data that is read or written to be treated with -bits filled from Least Significant Bit (\s-1LSB\s+1) to -Most Significant Bit (\s-1MSB\s+1). -Note that this is the opposite to the way the library has -worked from its inception. -.TP -.B B -Force image data that is read or written to be treated with -bits filled from Most Significant Bit (\s-1MSB\s+1) to -Least Significant Bit (\s-1LSB\s+1); this is the default. -.TP -.B H -Force image data that is read or written to be treated with -bits filled in the same order as the native -.SM CPU. -.TP -.B M -Enable the use of memory-mapped files for images opened read-only. -If the underlying system does not support memory-mapped files -or if the specific image being opened cannot be memory-mapped -then the library will fallback to using the normal system interface -for reading information. -By default the library will attempt to use memory-mapped files. -.TP -.B m -Disable the use of memory-mapped files. -.TP -.B C -Enable the use of ``strip chopping'' when reading images -that are comprised of a single strip or tile of uncompressed data. -Strip chopping is a mechanism by which the library will automatically -convert the single-strip image to multiple strips, -each of which has about 8 Kilobytes of data. -This facility can be useful in reducing the amount of memory used -to read an image because the library normally reads each strip -in its entirety. -Strip chopping does however alter the apparent contents of the -image because when an image is divided into multiple strips it -looks as though the underlying file contains multiple separate -strips. -Finally, note that default handling of strip chopping is a compile-time -configuration parameter. -The default behaviour, for backwards compatibility, is to enable -strip chopping. -.TP -.B c -Disable the use of strip chopping when reading images. -.TP -.B h -Read TIFF header only, do not load the first image directory. That could be -useful in case of the broken first directory. We can open the file and proceed -to the other directories. -.TP -.B 4 -ClassicTIFF for creating a file (default) -.TP -.B 8 -BigTIFF for creating a file. -.TP -.B D -Enable use of deferred strip/tile offset/bytecount array loading. They will -be loaded the first time they are accessed to. This loading will be done in -its entirety unless the O flag is also specified. -.TP -.B O -On-demand loading of values of the strip/tile offset/bytecount arrays, limited -to the requested strip/tile, instead of whole array loading (implies D) -.SH "BYTE ORDER" -The -.SM TIFF -specification (\fBall versions\fP) states that compliant readers -.IR "must be capable of reading images written in either byte order" . -Nonetheless some software that claims to support the reading of -.SM TIFF -images is incapable of reading images in anything but the native -.SM CPU -byte order on which the software was written. -(Especially notorious -are applications written to run on Intel-based machines.) -By default the library will create new files with the native -byte-order of the -.SM CPU -on which the application is run. -This ensures optimal performance and is portable to any application -that conforms to the TIFF specification. -To force the library to use a specific byte-order when creating -a new file the ``b'' and ``l'' option flags may be included in -the call to open a file; for example, ``wb'' or ``wl''. -.SH "RETURN VALUES" -Upon successful completion -.IR TIFFOpen , -.IR TIFFFdOpen , -and -.IR TIFFClientOpen -return a -.SM TIFF -pointer. -Otherwise, NULL is returned. -.SH DIAGNOSTICS -All error messages are directed to the -.IR TIFFError (3TIFF) -routine. -Likewise, warning messages are directed to the -.IR TIFFWarning (3TIFF) -routine. -.PP -\fB"%s": Bad mode\fP. -The specified -.I mode -parameter was not one of ``r'' (read), ``w'' (write), or ``a'' (append). -.PP -.BR "%s: Cannot open" . -.IR TIFFOpen () -was unable to open the specified filename for read/writing. -.PP -.BR "Cannot read TIFF header" . -An error occurred while attempting to read the header information. -.PP -.BR "Error writing TIFF header" . -An error occurred while writing the default header information -for a new file. -.PP -.BR "Not a TIFF file, bad magic number %d (0x%x)" . -The magic number in the header was not (hex) -0x4d4d or (hex) 0x4949. -.PP -.BR "Not a TIFF file, bad version number %d (0x%x)" . -The version field in the header was not 42 (decimal). -.PP -.BR "Cannot append to file that has opposite byte ordering" . -A file with a byte ordering opposite to the native byte -ordering of the current machine was opened for appending (``a''). -This is a limitation of the library. -.SH "SEE ALSO" -.IR libtiff (3TIFF), -.IR TIFFClose (3TIFF) diff --git a/man/TIFFPrintDirectory.3tiff b/man/TIFFPrintDirectory.3tiff deleted file mode 100644 index c208f044..00000000 --- a/man/TIFFPrintDirectory.3tiff +++ /dev/null @@ -1,69 +0,0 @@ -.\" -.\" Copyright (c) 1991-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFPrintDirectory 3TIFF "December 12, 1991" "libtiff" -.SH NAME -TIFFPrintDirectory \- print a description of a -.SM TIFF -directory -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "void TIFFPrintDirectory(TIFF *" tif ", FILE *" fd ", long " flags ")" -.SH DESCRIPTION -.I TIFFPrintDirectory -prints a description of the current directory in the specified -.SM TIFF -file to the standard I/O output stream -.IR fd . -The -.I flags -parameter is used to control the -.I "level of detail" -of the printed information; it is a bit-or of the flags defined in -.BR tiffio.h : -.sp .5 -.nf -.ta \w'#define 'u +\w'TIFFPRINT_JPEGDCTABLES 'u +\w'0x200 'u -#define TIFFPRINT_NONE 0x0 /* no extra info */ -#define TIFFPRINT_STRIPS 0x1 /* strips/tiles info */ -#define TIFFPRINT_CURVES 0x2 /* color/gray response curves */ -#define TIFFPRINT_COLORMAP 0x4 /* colormap */ -#define TIFFPRINT_JPEGQTABLES 0x100 /* JPEG Q matrices */ -#define TIFFPRINT_JPEGACTABLES 0x200 /* JPEG AC tables */ -#define TIFFPRINT_JPEGDCTABLES 0x200 /* JPEG DC tables */ -.fi -.SH NOTES -In C++ the -.I flags -parameter defaults to 0. -.SH "RETURN VALUES" -None. -.SH DIAGNOSTICS -None. -.SH "SEE ALSO" -.IR libtiff (3TIFF), -.IR TIFFOpen (3TIFF), -.IR TIFFReadDirectory (3TIFF), -.IR TIFFSetDirectory (3TIFF) diff --git a/man/TIFFRGBAImage.3tiff b/man/TIFFRGBAImage.3tiff deleted file mode 100644 index 2c5f79c4..00000000 --- a/man/TIFFRGBAImage.3tiff +++ /dev/null @@ -1,285 +0,0 @@ -.\" -.\" Copyright (c) 1991-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFRGBAImage 3TIFF "October 29, 2004" "libtiff" -.SH NAME -TIFFRGBAImageOK, TIFFRGBAImageBegin, TIFFRGBAImageGet, TIFFRGBAImageEnd -\- read and decode an image into a raster -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.B "typedef unsigned char TIFFRGBValue;" -.B "typedef struct _TIFFRGBAImage TIFFRGBAImage;" -.sp -.BI "int TIFFRGBAImageOK(TIFF *" tif ", char " emsg[1024] ")" -.br -.BI "int TIFFRGBAImageBegin(TIFFRGBAImage *" img ", TIFF* " tif ", int " stopOnError ", char " emsg[1024] ")" -.br -.BI "int TIFFRGBAImageGet(TIFFRGBAImage *" img ", uint32_t* " raster ", uint32_t " width " , uint32_t " height ")" -.br -.BI "void TIFFRGBAImageEnd(TIFFRGBAImage *" img ")" -.br -.SH DESCRIPTION -The routines described here provide a high-level interface -through which -.SM TIFF -images may be read into memory. -Images may be strip- or tile-based and have a variety of different -characteristics: bits/sample, samples/pixel, photometric, etc. -Decoding state is encapsulated in a -.I TIFFRGBAImage -structure making it possible to capture state for multiple images -and quickly switch between them. -The target raster format can be customized to a particular application's -needs by installing custom routines that manipulate image data -according to application requirements. -.PP -The default usage for these routines is: check if an image can -be processed using -.IR TIFFRGBAImageOK , -construct a decoder state block using -.IR TIFFRGBAImageBegin , -read and decode an image into a target raster using -.IR TIFFRGBAImageGet , -and then -release resources using -.IR TIFFRGBAImageEnd . -.I TIFFRGBAImageGet -can be called multiple times to decode an image using different -state parameters. -If multiple images are to be displayed and there is not enough -space for each of the decoded rasters, multiple state blocks can -be managed and then calls can be made to -.I TIFFRGBAImageGet -as needed to display an image. -.PP -The generated raster is assumed to be an array of -.I width -times -.I height -32-bit entries, where -.I width -must be less than or equal to the width of the image (\c -.I height -may be any non-zero size). -If the raster dimensions are smaller than the image, the image data -is cropped to the raster bounds. -If the raster height is greater than that of the image, then the -image data are placed in the lower part of the raster. -(Note that the raster is assume to be organized such that the pixel -at location (\fIx\fP,\fIy\fP) is \fIraster\fP[\fIy\fP*\fIwidth\fP+\fIx\fP]; -with the raster origin in the -.B lower-left -hand corner.) -.PP -Raster pixels are 8-bit packed red, green, blue, alpha samples. -The macros -.IR TIFFGetR , -.IR TIFFGetG , -.IR TIFFGetB , -and -.I TIFFGetA -should be used to access individual samples. -Images without Associated Alpha matting information have a constant -Alpha of 1.0 (255). -.PP -.I TIFFRGBAImageGet -converts non-8-bit images by scaling sample values. -Palette, grayscale, bilevel, -.SM CMYK\c -, and YCbCr images are converted to -.SM RGB -transparently. -Raster pixels are returned uncorrected by any colorimetry information -present in the directory. -.PP -The parameter -.I stopOnError -specifies how to act if an error is encountered while reading -the image. -If -.I stopOnError -is non-zero, then an error will terminate the operation; otherwise -.I TIFFRGBAImageGet -will continue processing data until all the possible data in the -image have been requested. -.SH "ALTERNATE RASTER FORMATS" -To use the core support for reading and processing -.SM TIFF -images, but write the resulting raster data in a different format -one need only override the ``\fIput methods\fP'' used to store raster data. -These methods are are defined in the -.I TIFFRGBAImage -structure and initially setup by -.I TIFFRGBAImageBegin -to point to routines that pack raster data in the default -.SM ABGR -pixel format. -Two different routines are used according to the physical organization -of the image data in the file: -.IR PlanarConfiguration =1 -(packed samples), -and -.IR PlanarConfiguration =2 -(separated samples). -Note that this mechanism can be used to transform the data before -storing it in the raster. -For example one can convert data -to colormap indices for display on a colormap display. -.SH "SIMULTANEOUS RASTER STORE AND DISPLAY" -It is simple to display an image as it is being read into memory -by overriding the put methods as described above for supporting -alternate raster formats. -Simply keep a reference to the default put methods setup by -.I TIFFRGBAImageBegin -and then invoke them before or after each display operation. -For example, the -.IR tiffgt (1) -utility uses the following put method to update the display as -the raster is being filled: -.sp -.nf -.ft C -static void -putContigAndDraw(TIFFRGBAImage* img, uint32_t* raster, - uint32_t x, uint32_t y, uint32_t w, uint32_t h, - int32_t fromskew, int32_t toskew, - unsigned char* cp) -{ - (*putContig)(img, raster, x, y, w, h, fromskew, toskew, cp); - if (x+w == width) { - w = width; - if (img->orientation == ORIENTATION_TOPLEFT) - lrectwrite(0, y-(h-1), w-1, y, raster-x-(h-1)*w); - else - lrectwrite(0, y, w-1, y+h-1, raster); - } -} -.ft R -.fi -.sp -(the original routine provided by the library is saved in the -variable -.IR putContig .) -.SH "SUPPORTING ADDITIONAL TIFF FORMATS" -The -.I TIFFRGBAImage -routines support the most commonly encountered flavors of -.SM TIFF. -It is possible to extend this support by overriding the ``\fIget method\fP'' -invoked by -.I TIFFRGBAImageGet -to read -.SM TIFF -image data. -Details of doing this are a bit involved, it is best to make a copy -of an existing get method and modify it to suit the needs of an -application. -.SH NOTES -Samples must be either 1, 2, 4, 8, or 16 bits. -Colorimetric samples/pixel must be either 1, 3, or 4 (i.e. -.I SamplesPerPixel -minus -.IR ExtraSamples ). -.PP -Palette image colormaps that appear to be incorrectly written -as 8-bit values are automatically scaled to 16-bits. -.SH "RETURN VALUES" -All routines return -1 if the operation was successful. -Otherwise, 0 is returned if an error was encountered and -.I stopOnError -is zero. -.SH DIAGNOSTICS -All error messages are directed to the -.IR TIFFError (3TIFF) -routine. -.PP -.BR "Sorry, can not handle %d-bit pictures" . -The image had -.I BitsPerSample -other than 1, 2, 4, 8, or 16. -.PP -.BR "Sorry, can not handle %d-channel images" . -The image had -.I SamplesPerPixel -other than 1, 3, or 4. -.PP -\fBMissing needed "PhotometricInterpretation" tag\fP. -The image did not have a tag that describes how to display -the data. -.PP -\fBNo "PhotometricInterpretation" tag, assuming RGB\fP. -The image was missing a tag that describes how to display it, -but because it has 3 or 4 samples/pixel, it is assumed to be -.SM RGB. -.PP -\fBNo "PhotometricInterpretation" tag, assuming min-is-black\fP. -The image was missing a tag that describes how to display it, -but because it has 1 sample/pixel, it is assumed to be a grayscale -or bilevel image. -.PP -.BR "No space for photometric conversion table" . -There was insufficient memory for a table used to convert -image samples to 8-bit -.SM RGB. -.PP -\fBMissing required "Colormap" tag\fP. -A Palette image did not have a required -.I Colormap -tag. -.PP -.BR "No space for tile buffer" . -There was insufficient memory to allocate an i/o buffer. -.PP -.BR "No space for strip buffer" . -There was insufficient memory to allocate an i/o buffer. -.PP -.BR "Can not handle format" . -The image has a format (combination of -.IR BitsPerSample , -.IR SamplesPerPixel , -and -.IR PhotometricInterpretation ) -that can not be handled. -.PP -.BR "No space for B&W mapping table" . -There was insufficient memory to allocate a table used to map -grayscale data to -.SM RGB. -.PP -.BR "No space for Palette mapping table" . -There was insufficient memory to allocate a table used to map -data to 8-bit -.SM RGB. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFReadRGBAImage (3TIFF), -.BR TIFFReadRGBAImageOriented (3TIFF), -.BR TIFFReadRGBAStrip (3TIFF), -.BR TIFFReadRGBATile (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFReadDirectory.3tiff b/man/TIFFReadDirectory.3tiff deleted file mode 100644 index c178c42b..00000000 --- a/man/TIFFReadDirectory.3tiff +++ /dev/null @@ -1,163 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFReadDirectory 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFReadDirectory \- get the contents of the next directory in an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFReadDirectory(TIFF *" tif ")" -.SH DESCRIPTION -Read the next directory in the specified file and make it the current -directory. Applications only need to call -.I TIFFReadDirectory -to read multiple subfiles in a single -.SM TIFF -file\(em -the first directory in a file is automatically read when -.IR TIFFOpen -is called. -.SH NOTES -If the library is compiled with -.SM STRIPCHOP_SUPPORT -enabled, then images that have a single uncompressed strip or tile of data are -automatically treated as if they were made up of multiple strips or tiles of -approximately 8 kilobytes each. This operation is done only in-memory; it does -not alter the contents of the file. However, the construction of the ``chopped -strips'' is visible to the application through the number of strips [tiles] -returned by -.I TIFFNumberOfStrips -[\c -.IR TIFFNumberOfTiles ]. -.SH "RETURN VALUES" -If the next directory was successfully read, 1 is returned. Otherwise, 0 is -returned if an error was encountered, or if there are no more directories to -be read. -.SH DIAGNOSTICS -All error messages are directed to the -.IR TIFFError (3TIFF) -routine. -All warning messages are directed to the -.IR TIFFWarning (3TIFF) -routine. -.PP -\fBSeek error accessing TIFF directory\fP. -An error occurred while positioning to the location of the -directory. -.PP -\fBWrong data type %d for field "%s"\fP. -The tag entry in the directory had an incorrect data type. -For example, an -.I ImageDescription -tag with a -.SM SHORT -data type. -.PP -\fBTIFF directory is missing required "%s" field\fP. -The specified tag is required to be present by the -.SM TIFF -5.0 specification, but is missing. -The directory is (usually) unusable. -.PP -\fB%s: Rational with zero denominator\fP. -A directory tag has a -.SM RATIONAL -value whose denominator is zero. -.PP -\fBIncorrect count %d for field "%s" (%lu, expecting %lu); tag ignored\fP. -The specified tag's count field is bad. -For example, a count other than 1 for a -.I SubFileType -tag. -.PP -\fBCannot handle different per-sample values for field "%s"\fP. -The tag has -.I SamplesPerPixel -values and they are not all the same; e.g. -.IR BitsPerSample . -The library is unable to handle images of this sort. -.PP -\fBCount mismatch for field "%s"; expecting %d, got %d\fP. -The count field in a -tag does not agree with the number expected by the library. -This should never happen, so if it does, the library refuses to -read the directory. -.PP -\fBInvalid TIFF directory; tags are not sorted in ascending order\fP. -The directory tags are not properly sorted as specified -in the -.SM TIFF -5.0 specification. -This error is not fatal. -.PP -\fBIgnoring unknown field with tag %d (0x%x)\fP. -An unknown tag was encountered in the directory; -the library ignores all such tags. -.PP -\fBTIFF directory is missing required "ImageLength" field\fP. -The image violates the specification by not having a necessary field. -There is no way for the library to recover from this error. -.PP -\fBTIFF directory is missing required "PlanarConfig" field\fP. -The image violates the specification by not having a necessary field. -There is no way for the library to recover from this error. -.PP -\fBTIFF directory is missing required "StripOffsets" field\fP. -The image has multiple strips, but is missing the tag that -specifies the file offset to each strip of data. -There is no way for the library to recover from this error. -.PP -\fBTIFF directory is missing required "TileOffsets" field\fP. -The image has multiple tiles, but is missing the tag that -specifies the file offset to each tile of data. -There is no way for the library to recover from this error. -.PP -\fBTIFF directory is missing required "StripByteCounts" field\fP. -The image has multiple strips, but is missing the tag that -specifies the size of each strip of data. -There is no way for the library to recover from this error. -.PP -\fBTIFF directory is missing required "StripByteCounts" field, calculating from imagelength\fP. -The image violates the specification by not having a necessary field. -However, when the image is comprised of only one strip or tile, the -library will estimate the missing value based on the file size. -.PP -\fBBogus "StripByteCounts" field, ignoring and calculating from imagelength\fP. -Certain vendors violate the specification by writing zero for -the StripByteCounts tag when they want to leave the value -unspecified. -If the image has a single strip, the library will estimate -the missing value based on the file size. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFWriteDirectory (3TIFF), -.BR TIFFSetDirectory (3TIFF), -.BR TIFFSetSubDirectory (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFReadEncodedStrip.3tiff b/man/TIFFReadEncodedStrip.3tiff deleted file mode 100644 index 8d1ad6c5..00000000 --- a/man/TIFFReadEncodedStrip.3tiff +++ /dev/null @@ -1,77 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFReadEncodedStrip 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFReadEncodedStrip \- read and decode a strip of data from an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "tmsize_t TIFFReadEncodedStrip(TIFF *" tif ", uint32_t " strip ", void *" buf ", tmsize_t " size ")" -.SH DESCRIPTION -Read the specified strip of data and place up to -.I size -bytes of decompressed information in the (user supplied) data buffer. -.SH NOTES -The value of -.I strip -is a ``raw strip number.'' -That is, the caller must take into account whether or not the data are -organized in separate planes (\c -.IR PlanarConfiguration =2). -To read a full strip of data the data buffer should typically be at least as -large as the number returned by -.BR TIFFStripSize (3TIFF). -If the -1 passed in -.I size -parameter, the whole strip will be read. You should be sure you have enough -space allocated for the buffer. -.PP -The library attempts to hide bit- and byte-ordering differences between the -image and the native machine by converting data to the native machine order. -Bit reversal is done if the -.I FillOrder -tag is opposite to the native machine bit order. 16- and 32-bit samples are -automatically byte-swapped if the file was written with a byte order opposite -to the native machine byte order, -.SH "RETURN VALUES" -The actual number of bytes of data that were placed in -.I buf -is returned; -.IR TIFFReadEncodedStrip -returns \-1 if an error was encountered. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFReadRawStrip (3TIFF), -.BR TIFFReadScanline (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFReadEncodedTile.3tiff b/man/TIFFReadEncodedTile.3tiff deleted file mode 100644 index 6f8d6496..00000000 --- a/man/TIFFReadEncodedTile.3tiff +++ /dev/null @@ -1,75 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFReadEncodedTile 3TIFF "October 13, 2006" "libtiff" -.SH NAME -TIFFReadEncodedTile \- read and decode a tile of data from an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFReadEncodedTile(TIFF *" tif ", ttile_t " tile ", tdata_t " buf ", tsize_t " size ")" -.SH DESCRIPTION -Read the specified tile of data and place up to -.I size -bytes of decompressed information in the (user supplied) data buffer. -.SH NOTES -The value of -.I tile -is a ``raw tile number.'' -That is, the caller must take into account whether or not the data are -organized in separate planes (\c -.IR PlanarConfiguration =2). -.IR TIFFComputeTile -automatically does this when converting an (x,y,z,sample) coordinate quadruple -to a tile number. To read a full tile of data the data buffer should be at -least as large as the value returned by -.IR TIFFTileSize . -.PP -The library attempts to hide bit- and byte-ordering differences between the -image and the native machine by converting data to the native machine order. -Bit reversal is done if the -.I FillOrder -tag is opposite to the native machine bit order. 16- and 32-bit samples are -automatically byte-swapped if the file was written with a byte order opposite -to the native machine byte order, -.SH "RETURN VALUES" -The actual number of bytes of data that were placed in -.I buf -is returned; -.IR TIFFReadEncodedTile -returns \-1 if an error was encountered. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFReadRawTile (3TIFF), -.BR TIFFReadTile (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFReadRGBAImage.3tiff b/man/TIFFReadRGBAImage.3tiff deleted file mode 100644 index a17f71ed..00000000 --- a/man/TIFFReadRGBAImage.3tiff +++ /dev/null @@ -1,217 +0,0 @@ -.\" -.\" Copyright (c) 1991-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFReadRGBAImage 3TIFF "October 13, 2006" "libtiff" -.SH NAME -TIFFReadRGBAImage, TIFFReadRGBAImageOriented \- read and decode an image -into a fixed-format raster -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.B "#define TIFFGetR(abgr) ((abgr) & 0xff)" -.br -.B "#define TIFFGetG(abgr) (((abgr) >> 8) & 0xff)" -.br -.B "#define TIFFGetB(abgr) (((abgr) >> 16) & 0xff)" -.br -.B "#define TIFFGetA(abgr) (((abgr) >> 24) & 0xff)" -.sp -.BI "int TIFFReadRGBAImage(TIFF *" tif ", uint32_t " width ", uint32_t " height ", uint32_t *" raster ", int " stopOnError ")" -.br -.BI "int TIFFReadRGBAImageOriented(TIFF *" tif ", uint32_t " width ", uint32_t " height ", uint32_t *" raster ", int " orientation ", int " stopOnError ")" -.br -.SH DESCRIPTION -.IR TIFFReadRGBAImage -reads a strip- or tile-based image into memory, storing the -result in the user supplied -.IR raster . -The raster is assumed to be an array of -.I width -times -.I height -32-bit entries, where -.I width -must be less than or equal to the width of the image (\c -.I height -may be any non-zero size). -If the raster dimensions are smaller than the image, the image data -is cropped to the raster bounds. -If the raster height is greater than that of the image, then the -image data are placed in the lower part of the raster. -(Note that the raster is assume to be organized such that the pixel -at location (\fIx\fP,\fIy\fP) is \fIraster\fP[\fIy\fP*\fIwidth\fP+\fIx\fP]; -with the raster origin in the lower-left hand corner.) -.PP -.IR TIFFReadRGBAImageOriented -works like -.IR TIFFReadRGBAImage -with except of that user can specify the raster origin position with the -.I orientation -parameter. Four orientations supported: -.TP -.B ORIENTATION_TOPLEFT -origin in top-left corner, -.TP -.B ORIENTATION_TOPRIGHT -origin in top-right corner, -.TP -.B ORIENTATION_BOTLEFT -origin in bottom-left corner -and -.TP -.B ORIENTATION_BOTRIGHT -origin in bottom-right corner. -.LP -If you choose -.B ORIENTATION_BOTLEFT -result will be the same as returned by the -.IR TIFFReadRGBAImage. -.PP -Raster pixels are 8-bit packed red, green, blue, alpha samples. -The macros -.IR TIFFGetR , -.IR TIFFGetG , -.IR TIFFGetB , -and -.I TIFFGetA -should be used to access individual samples. -Images without Associated Alpha matting information have a constant -Alpha of 1.0 (255). -.PP -.I TIFFReadRGBAImage -converts non-8-bit images by scaling sample values. -Palette, grayscale, bilevel, -.SM CMYK\c -, and YCbCr images are converted to -.SM RGB -transparently. -Raster pixels are returned uncorrected by any colorimetry information -present in the directory. -.PP -The parameter -.I stopOnError -specifies how to act if an error is encountered while reading -the image. -If -.I stopOnError -is non-zero, then an error will terminate the operation; otherwise -.I TIFFReadRGBAImage -will continue processing data until all the possible data in the -image have been requested. -.SH NOTES -In C++ the -.I stopOnError -parameter defaults to 0. -.PP -Samples must be either 1, 2, 4, 8, or 16 bits. -Colorimetric samples/pixel must be either 1, 3, or 4 (i.e. -.I SamplesPerPixel -minus -.IR ExtraSamples ). -.PP -Palettte image colormaps that appear to be incorrectly written -as 8-bit values are automatically scaled to 16-bits. -.PP -.I TIFFReadRGBAImage -is just a wrapper around the more general -.IR TIFFRGBAImage (3TIFF) -facilities. -.SH "RETURN VALUES" -1 is returned if the image was successfully read and converted. -Otherwise, 0 is returned if an error was encountered and -.I stopOnError -is zero. -.SH DIAGNOSTICS -All error messages are directed to the -.IR TIFFError (3TIFF) -routine. -.PP -.BR "Sorry, can not handle %d-bit pictures" . -The image had -.I BitsPerSample -other than 1, 2, 4, 8, or 16. -.PP -.BR "Sorry, can not handle %d-channel images" . -The image had -.I SamplesPerPixel -other than 1, 3, or 4. -.PP -\fBMissing needed "PhotometricInterpretation" tag\fP. -The image did not have a tag that describes how to display -the data. -.PP -\fBNo "PhotometricInterpretation" tag, assuming RGB\fP. -The image was missing a tag that describes how to display it, -but because it has 3 or 4 samples/pixel, it is assumed to be -.SM RGB. -.PP -\fBNo "PhotometricInterpretation" tag, assuming min-is-black\fP. -The image was missing a tag that describes how to display it, -but because it has 1 sample/pixel, it is assumed to be a grayscale -or bilevel image. -.PP -.BR "No space for photometric conversion table" . -There was insufficient memory for a table used to convert -image samples to 8-bit -.SM RGB. -.PP -\fBMissing required "Colormap" tag\fP. -A Palette image did not have a required -.I Colormap -tag. -.PP -.BR "No space for tile buffer" . -There was insufficient memory to allocate an i/o buffer. -.PP -.BR "No space for strip buffer" . -There was insufficient memory to allocate an i/o buffer. -.PP -.BR "Can not handle format" . -The image has a format (combination of -.IR BitsPerSample , -.IR SamplesPerPixel , -and -.IR PhotometricInterpretation ) -that -.I TIFFReadRGBAImage -can not handle. -.PP -.BR "No space for B&W mapping table" . -There was insufficient memory to allocate a table used to map -grayscale data to -.SM RGB. -.PP -.BR "No space for Palette mapping table" . -There was insufficient memory to allocate a table used to map -data to 8-bit -.SM RGB. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFRGBAImage (3TIFF), -.BR TIFFReadRGBAStrip (3TIFF), -.BR TIFFReadRGBATile (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFReadRGBAStrip.3tiff b/man/TIFFReadRGBAStrip.3tiff deleted file mode 100644 index 803a99af..00000000 --- a/man/TIFFReadRGBAStrip.3tiff +++ /dev/null @@ -1,169 +0,0 @@ -.\" -.\" Copyright (c) 1991-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFReadRGBAStrip 3TIFF "December 10, 1998" "libtiff" -.SH NAME -TIFFReadRGBAStrip \- read and decode an image strip into a fixed-format raster -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.B "#define TIFFGetR(abgr) ((abgr) & 0xff)" -.br -.B "#define TIFFGetG(abgr) (((abgr) >> 8) & 0xff)" -.br -.B "#define TIFFGetB(abgr) (((abgr) >> 16) & 0xff)" -.br -.B "#define TIFFGetA(abgr) (((abgr) >> 24) & 0xff)" -.sp -.BI "int TIFFReadRGBAStrip(TIFF *" tif ", uint32_t " row ", uint32_t *" raster ")" -.SH DESCRIPTION -.IR TIFFReadRGBAStrip -reads a single strip of a strip-based image into memory, storing the result in -the user supplied RGBA -.IR raster . -The raster is assumed to be an array of width times rowsperstrip 32-bit -entries, where width is the width of the image (TIFFTAG_IMAGEWIDTH) and -rowsperstrip is the maximum lines in a strip (TIFFTAG_ROWSPERSTRIP). - -.PP -The -.IR row -value should be the row of the first row in the strip (strip * rowsperstrip, -zero based). - -.PP -Note that the raster is assume to be organized such that the pixel at location -(\fIx\fP,\fIy\fP) is \fIraster\fP[\fIy\fP*\fIwidth\fP+\fIx\fP]; with the -raster origin in the -.I lower-left hand corner -of the strip. That is bottom to top organization. When reading a partial last -strip in the file the last line of the image will begin at the beginning of -the buffer. - -.PP -Raster pixels are 8-bit packed red, green, blue, alpha samples. The macros -.IR TIFFGetR , -.IR TIFFGetG , -.IR TIFFGetB , -and -.I TIFFGetA -should be used to access individual samples. Images without Associated Alpha -matting information have a constant Alpha of 1.0 (255). -.PP -See the -.IR TIFFRGBAImage (3TIFF) -page for more details on how various image types are converted to RGBA values. -.SH NOTES -Samples must be either 1, 2, 4, 8, or 16 bits. Colorimetric samples/pixel must -be either 1, 3, or 4 (i.e. -.I SamplesPerPixel -minus -.IR ExtraSamples ). -.PP -Palette image colormaps that appear to be incorrectly written as 8-bit values -are automatically scaled to 16-bits. -.PP -.I TIFFReadRGBAStrip -is just a wrapper around the more general -.IR TIFFRGBAImage (3TIFF) -facilities. It's main advantage over the similar -.IR TIFFReadRGBAImage() -function is that for large images a single buffer capable of holding the whole -image doesn't need to be allocated, only enough for one strip. The -.IR TIFFReadRGBATile() -function does a similar operation for tiled images. -.SH "RETURN VALUES" -1 is returned if the image was successfully read and converted. -Otherwise, 0 is returned if an error was encountered. -.SH DIAGNOSTICS -All error messages are directed to the -.IR TIFFError (3TIFF) -routine. -.PP -.BR "Sorry, can not handle %d-bit pictures" . -The image had -.I BitsPerSample -other than 1, 2, 4, 8, or 16. -.PP -.BR "Sorry, can not handle %d-channel images" . -The image had -.I SamplesPerPixel -other than 1, 3, or 4. -.PP -\fBMissing needed "PhotometricInterpretation" tag\fP. -The image did not have a tag that describes how to display the data. -.PP -\fBNo "PhotometricInterpretation" tag, assuming RGB\fP. -The image was missing a tag that describes how to display it, but because it -has 3 or 4 samples/pixel, it is assumed to be -.SM RGB. -.PP -\fBNo "PhotometricInterpretation" tag, assuming min-is-black\fP. The image was -missing a tag that describes how to display it, but because it has 1 -sample/pixel, it is assumed to be a grayscale or bilevel image. -.PP -.BR "No space for photometric conversion table" . -There was insufficient memory for a table used to convert image samples to -8-bit -.SM RGB. -.PP -\fBMissing required "Colormap" tag\fP. -A Palette image did not have a required -.I Colormap -tag. -.PP -.BR "No space for tile buffer" . -There was insufficient memory to allocate an i/o buffer. -.PP -.BR "No space for strip buffer" . -There was insufficient memory to allocate an i/o buffer. -.PP -.BR "Can not handle format" . -The image has a format (combination of -.IR BitsPerSample , -.IR SamplesPerPixel , -and -.IR PhotometricInterpretation ) -that -.I TIFFReadRGBAImage -can not handle. -.PP -.BR "No space for B&W mapping table" . -There was insufficient memory to allocate a table used to map grayscale data -to -.SM RGB. -.PP -.BR "No space for Palette mapping table" . -There was insufficient memory to allocate a table used to map data to 8-bit -.SM RGB. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFRGBAImage (3TIFF), -.BR TIFFReadRGBAImage (3TIFF), -.BR TIFFReadRGBATile (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ - diff --git a/man/TIFFReadRGBATile.3tiff b/man/TIFFReadRGBATile.3tiff deleted file mode 100644 index 4ee59180..00000000 --- a/man/TIFFReadRGBATile.3tiff +++ /dev/null @@ -1,170 +0,0 @@ -.\" -.\" Copyright (c) 1991-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFReadRGBATile 3TIFF "December 10, 1998" "libtiff" -.SH NAME -TIFFReadRGBATile \- read and decode an image tile into a fixed-format raster -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.B "#define TIFFGetR(abgr) ((abgr) & 0xff)" -.br -.B "#define TIFFGetG(abgr) (((abgr) >> 8) & 0xff)" -.br -.B "#define TIFFGetB(abgr) (((abgr) >> 16) & 0xff)" -.br -.B "#define TIFFGetA(abgr) (((abgr) >> 24) & 0xff)" -.sp -.BI "int TIFFReadRGBATile(TIFF *" tif ", uint32_t " x ", uint32_t " y ", uint32_t *" raster ")" -.SH DESCRIPTION -.IR TIFFReadRGBATile -reads a single tile of a tile-based image into memory, storing the result in -the user supplied RGBA -.IR raster . -The raster is assumed to be an array of width times length 32-bit entries, -where width is the width of a tile (TIFFTAG_TILEWIDTH) and length is the -height of a tile (TIFFTAG_TILELENGTH). - -.PP -The -.IR x -and -.IR y -values are the offsets from the top left corner to the top left corner of the -tile to be read. They must be an exact multiple of the tile width and length. - -.PP -Note that the raster is assume to be organized such that the pixel at location -(\fIx\fP,\fIy\fP) is \fIraster\fP[\fIy\fP*\fIwidth\fP+\fIx\fP]; with the -raster origin in the -.I lower-left hand corner -of the tile. That is bottom to top organization. Edge tiles which partly fall -off the image will be filled out with appropriate zeroed areas. - -.PP -Raster pixels are 8-bit packed red, green, blue, alpha samples. The macros -.IR TIFFGetR , -.IR TIFFGetG , -.IR TIFFGetB , -and -.I TIFFGetA -should be used to access individual samples. Images without Associated Alpha -matting information have a constant Alpha of 1.0 (255). -.PP -See the -.IR TIFFRGBAImage (3TIFF) -page for more details on how various image types are converted to RGBA values. -.SH NOTES -Samples must be either 1, 2, 4, 8, or 16 bits. Colorimetric samples/pixel must -be either 1, 3, or 4 (i.e. -.I SamplesPerPixel -minus -.IR ExtraSamples ). -.PP -Palette image colormaps that appear to be incorrectly written as 8-bit values -are automatically scaled to 16-bits. -.PP -.I TIFFReadRGBATile -is just a wrapper around the more general -.IR TIFFRGBAImage (3TIFF) -facilities. It's main advantage over the similar -.IR TIFFReadRGBAImage() -function is that for large images a single buffer capable of holding the whole -image doesn't need to be allocated, only enough for one tile. The -.IR TIFFReadRGBAStrip() -function does a similar operation for stripped images. -.SH "RETURN VALUES" -1 is returned if the image was successfully read and converted. -Otherwise, 0 is returned if an error was encountered. -.SH DIAGNOSTICS -All error messages are directed to the -.IR TIFFError (3TIFF) -routine. -.PP -.BR "Sorry, can not handle %d-bit pictures" . -The image had -.I BitsPerSample -other than 1, 2, 4, 8, or 16. -.PP -.BR "Sorry, can not handle %d-channel images" . -The image had -.I SamplesPerPixel -other than 1, 3, or 4. -.PP -\fBMissing needed "PhotometricInterpretation" tag\fP. -The image did not have a tag that describes how to display the data. -.PP -\fBNo "PhotometricInterpretation" tag, assuming RGB\fP. -The image was missing a tag that describes how to display it, but because it -has 3 or 4 samples/pixel, it is assumed to be -.SM RGB. -.PP -\fBNo "PhotometricInterpretation" tag, assuming min-is-black\fP. -The image was missing a tag that describes how to display it, -but because it has 1 sample/pixel, it is assumed to be a grayscale -or bilevel image. -.PP -.BR "No space for photometric conversion table" . -There was insufficient memory for a table used to convert -image samples to 8-bit -.SM RGB. -.PP -\fBMissing required "Colormap" tag\fP. -A Palette image did not have a required -.I Colormap -tag. -.PP -.BR "No space for tile buffer" . -There was insufficient memory to allocate an i/o buffer. -.PP -.BR "No space for strip buffer" . -There was insufficient memory to allocate an i/o buffer. -.PP -.BR "Can not handle format" . -The image has a format (combination of -.IR BitsPerSample , -.IR SamplesPerPixel , -and -.IR PhotometricInterpretation ) -that -.I TIFFReadRGBAImage -can not handle. -.PP -.BR "No space for B&W mapping table" . -There was insufficient memory to allocate a table used to map -grayscale data to -.SM RGB. -.PP -.BR "No space for Palette mapping table" . -There was insufficient memory to allocate a table used to map data to 8-bit -.SM RGB. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFRGBAImage (3TIFF), -.BR TIFFReadRGBAImage (3TIFF), -.BR TIFFReadRGBAStrip (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFReadRawStrip.3tiff b/man/TIFFReadRawStrip.3tiff deleted file mode 100644 index dfd5a51f..00000000 --- a/man/TIFFReadRawStrip.3tiff +++ /dev/null @@ -1,63 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFReadRawStrip 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFReadRawStrip \- return the undecoded contents of a strip of data from an -open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "tsize_t TIFFReadRawStrip(TIFF *" tif ", tstrip_t " strip ", tdata_t " buf ", tsize_t " size ")" -.SH DESCRIPTION -Read the contents of the specified strip into the (user supplied) data buffer. -Note that the value of -.I strip -is a ``raw strip number.'' That is, the caller must take into account whether -or not the data is organized in separate planes (\c -.IR PlanarConfiguration =2). -To read a full strip of data the data buffer should typically be at least as -large as the number returned by -.IR TIFFStripSize . -.SH "RETURN VALUES" -The actual number of bytes of data that were placed in -.I buf -is returned; -.IR TIFFReadRawStrip -returns \-1 if an error was encountered. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFReadEncodedStrip (3TIFF), -.BR TIFFReadScanline (3TIFF), -.BR TIFFStripSize (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFReadRawTile.3tiff b/man/TIFFReadRawTile.3tiff deleted file mode 100644 index 9c60888a..00000000 --- a/man/TIFFReadRawTile.3tiff +++ /dev/null @@ -1,64 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFReadRawTile 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFReadRawTile \- return an undecoded tile of data from an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "tsize_t TIFFReadRawTile(TIFF *" tif ", ttile_t " tile ", tdata_t " buf ", tsize_t " size ")" -.SH DESCRIPTION -Read the contents of the specified tile into the (user supplied) data buffer. -Note that the value of -.I tile -is a ``raw tile number.'' That is, the caller must take into account whether -or not the data is organized in separate planes (\c -.IR PlanarConfiguration =2). -.I TIFFComputeTile -automatically does this when converting an (x,y,z,sample) coordinate quadruple -to a tile number. To read a full tile of data the data buffer should typically -be at least as large as the value returned by -.IR TIFFTileSize . -.SH "RETURN VALUES" -The actual number of bytes of data that were placed in -.I buf -is returned; -.IR TIFFReadEncodedTile -returns \-1 if an error was encountered. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFReadEncodedTile (3TIFF), -.BR TIFFReadTile (3TIFF), -.BR TIFFTileSize (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFReadScanline.3tiff b/man/TIFFReadScanline.3tiff deleted file mode 100644 index 9a61fc85..00000000 --- a/man/TIFFReadScanline.3tiff +++ /dev/null @@ -1,93 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFReadScanline 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFReadScanline \- read and decode a scanline of data from an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFReadScanline(TIFF *" tif ", tdata_t " buf ", uint32_t " row ", tsample_t " sample ")" -.SH DESCRIPTION -Read the data for the specified row into the (user supplied) data buffer -.IR buf . -The data are returned decompressed and, in the native byte- and bit-ordering, -but are otherwise packed (see further below). The buffer must be large enough -to hold an entire scanline of data. Applications should call the routine -.IR TIFFScanlineSize -to find out the size (in bytes) of a scanline buffer. -The -.I row -parameter is always used by -.IR TIFFReadScanline ; -the -.I sample -parameter is used only if data are organized in separate planes (\c -.IR PlanarConfiguration =2). -.SH NOTES -The library attempts to hide bit- and byte-ordering differences between the -image and the native machine by converting data to the native machine order. -Bit reversal is done if the -.I FillOrder -tag is opposite to the native machine bit order. 16- and 32-bit samples are -automatically byte-swapped if the file was written with a byte order opposite -to the native machine byte order, -.PP -In C++ the -.I sample -parameter defaults to 0. -.SH "RETURN VALUES" -.IR TIFFReadScanline -returns \-1 if it detects an error; otherwise 1 is returned. -.SH DIAGNOSTICS -All error messages are directed to the -.IR TIFFError (3TIFF) -routine. -.PP -.BR "Compression algorithm does not support random access" . -Data was requested in a non-sequential order from a file that uses a -compression algorithm and that has -.I RowsPerStrip -greater than one. -That is, data in the image is stored in a compressed form, and with multiple -rows packed into a strip. In this case, the library does not support random -access to the data. The data should either be accessed sequentially, or the -file should be converted so that each strip is made up of one row of data. -.SH BUGS -Reading subsampled YCbCR data does not work correctly because, for -.IR PlanarConfiguration =2 -the size of a scanline is not calculated on a per-sample basis, and for -.IR PlanarConfiguration =1 -the library does not unpack the block-interleaved samples; use the strip- and -tile-based interfaces to read these formats. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFReadEncodedStrip (3TIFF), -.BR TIFFReadRawStrip (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFReadTile.3tiff b/man/TIFFReadTile.3tiff deleted file mode 100644 index 5bfbbd36..00000000 --- a/man/TIFFReadTile.3tiff +++ /dev/null @@ -1,83 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFReadTile 3TIFF "December 16, 1991" "libtiff" -.SH NAME -TIFFReadTile \- read and decode a tile of data from an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "tsize_t TIFFReadTile(TIFF *" tif ", tdata_t " buf ", uint32_t " x ", uint32_t " y ", uint32_t " z ", tsample_t " sample ")" -.SH DESCRIPTION -Return the data for the tile -.I containing -the specified coordinates. The data placed in -.I buf -are returned decompressed and, typically, in the native byte- and -bit-ordering, but are otherwise packed (see further below). The buffer must be -large enough to hold an entire tile of data. Applications should call the -routine -.IR TIFFTileSize -to find out the size (in bytes) of a tile buffer. The -.I x -and -.I y -parameters are always used by -.IR TIFFReadTile . -The -.I z -parameter is used if the image is deeper than 1 slice (\c -.IR ImageDepth >1). -The -.I sample -parameter is used only if data are organized in separate planes (\c -.IR PlanarConfiguration =2). -.SH NOTES -The library attempts to hide bit- and byte-ordering differences between the -image and the native machine by converting data to the native machine order. -Bit reversal is done if the -.I FillOrder -tag is opposite to the native machine bit order. 16- and 32-bit samples are -automatically byte-swapped if the file was written with a byte order opposite -to the native machine byte order, -.SH "RETURN VALUES" -.IR TIFFReadTile -returns \-1 if it detects an error; otherwise the number of bytes in the -decoded tile is returned. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.SH "SEE ALSO" -.BR TIFFCheckTile (3TIFF), -.BR TIFFComputeTile (3TIFF), -.BR TIFFOpen (3TIFF), -.BR TIFFReadEncodedTile (3TIFF), -.BR TIFFReadRawTile (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFSetDirectory.3tiff b/man/TIFFSetDirectory.3tiff deleted file mode 100644 index d5b49908..00000000 --- a/man/TIFFSetDirectory.3tiff +++ /dev/null @@ -1,78 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFSetDirectory 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFSetDirectory, TIFFSetSubDirectory \- set the current directory for an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFSetDirectory(TIFF *" tif ", tdir_t " dirnum ")" -.br -.BI "int TIFFSetSubDirectory(TIFF *" tif ", uint64_t " diroff ")" -.SH DESCRIPTION -.I TIFFSetDirectory -changes the current directory and reads its contents with -.IR TIFFReadDirectory . -The parameter -.I dirnum -specifies the subfile/directory as an integer number, with the first directory -numbered zero. -.PP -.I TIFFSetSubDirectory -acts like -.IR TIFFSetDirectory , -except the directory is specified as a file offset instead of an index; this -is required for accessing subdirectories linked through a -.I SubIFD -tag. -.SH "RETURN VALUES" -On successful return 1 is returned. Otherwise, 0 is returned if -.I dirnum -or -.I diroff -specifies a non-existent directory, or if an error was encountered while -reading the directory's contents. -.SH DIAGNOSTICS -All error messages are directed to the -.IR TIFFError (3TIFF) -routine. -.PP -.BR "%s: Error fetching directory count" . -An error was encountered while reading the ``directory count'' field. -.PP -.BR "%s: Error fetching directory link" . -An error was encountered while reading the ``link value'' that points to the -next directory in a file. -.SH "SEE ALSO" -.IR TIFFCurrentDirectory (3TIFF), -.IR TIFFOpen (3TIFF), -.IR TIFFReadDirectory (3TIFF), -.IR TIFFWriteDirectory (3TIFF), -.IR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFSetField.3tiff b/man/TIFFSetField.3tiff deleted file mode 100644 index f614e075..00000000 --- a/man/TIFFSetField.3tiff +++ /dev/null @@ -1,216 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFSetField 3TIFF "October 29, 2004" "libtiff" -.SH NAME -TIFFSetField, TIFFVSetField \- set the value(s) of a tag in a -.SM TIFF -file open for writing -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFSetField(TIFF *" tif ", ttag_t " tag ", " ... ")" -.sp -.B "#include <stdarg.h>" -.sp -.BI "int TIFFVSetField(TIFF *" tif ", ttag_t " tag ", va_list " ap ")" -.SH DESCRIPTION -.IR TIFFSetField -sets the value of a field -or pseudo-tag in the current directory associated with -the open -.SM TIFF -file -.IR tif . -(A -.I pseudo-tag -is a parameter that is used to control the operation of the -.SM TIFF -library but whose value is not read or written to the underlying file.) -To set the value of a field -the file must have been previously opened for writing with -.IR TIFFOpen (3TIFF); -pseudo-tags can be set whether the file was opened for reading -or writing. -The field is identified by -.IR tag , -one of the values defined in the include file -.B tiff.h -(see also the table below). -The actual value is specified using a variable argument list, -as prescribed by the -.IR stdarg (3) -interface (\c -or, on some machines, the -.IR varargs (3) -interface.) -.PP -.IR TIFFVSetField -is functionally equivalent to -.IR TIFFSetField -except that it takes a pointer to a variable -argument list. -.I TIFFVSetField -is useful for writing routines that are layered -on top of the functionality provided by -.IR TIFFSetField . -.PP -The tags understood by -.IR libtiff , -the number of parameter values, and the -expected types for the parameter values are shown below. -The data types are: -.I char* -is null-terminated string and corresponds to the -.SM ASCII -data type; -.I uint16_t -is an unsigned 16-bit value; -.I uint32_t -is an unsigned 32-bit value; -.I uint16_t* -is an array of unsigned 16-bit values. -.I void* -is an array of data values of unspecified type. - -Consult the -.SM TIFF -specification for information on the meaning of each tag. -.PP -.nf -.ta \w'TIFFTAG_CONSECUTIVEBADFAXLINES'u+2n +\w'Count'u+2n +\w'TIFFFaxFillFunc \(dg'u+2n -\fITag Name\fP \fICount\fP \fITypes\fP \fINotes\fP -.sp 5p -TIFFTAG_ARTIST 1 char* -TIFFTAG_BADFAXLINES 1 uint32_t -TIFFTAG_BITSPERSAMPLE 1 uint16_t \(dg -TIFFTAG_CLEANFAXDATA 1 uint16_t -TIFFTAG_COLORMAP 3 uint16_t* 1<<BitsPerSample arrays -TIFFTAG_COMPRESSION 1 uint16_t \(dg -TIFFTAG_CONSECUTIVEBADFAXLINES 1 uint32_t -TIFFTAG_COPYRIGHT 1 char* -TIFFTAG_DATETIME 1 char* -TIFFTAG_DOCUMENTNAME 1 char* -TIFFTAG_DOTRANGE 2 uint16_t -TIFFTAG_EXTRASAMPLES 2 uint16_t,uint16_t* \(dg count & types array -TIFFTAG_FAXFILLFUNC 1 TIFFFaxFillFunc G3/G4 compression pseudo-tag -TIFFTAG_FAXMODE 1 int \(dg G3/G4 compression pseudo-tag -TIFFTAG_FILLORDER 1 uint16_t \(dg -TIFFTAG_GROUP3OPTIONS 1 uint32_t \(dg -TIFFTAG_GROUP4OPTIONS 1 uint32_t \(dg -TIFFTAG_HALFTONEHINTS 2 uint16_t -TIFFTAG_HOSTCOMPUTER 1 char* -TIFFTAG_ICCPROFILE 2 uint32_t,void* count, profile data -TIFFTAG_IMAGEDEPTH 1 uint32_t \(dg -TIFFTAG_IMAGEDESCRIPTION 1 char* -TIFFTAG_IMAGELENGTH 1 uint32_t -TIFFTAG_IMAGEWIDTH 1 uint32_t \(dg -TIFFTAG_INKNAMES 2 uint16_t, char* -TIFFTAG_INKSET 1 uint16_t \(dg -TIFFTAG_JPEGCOLORMODE 1 int \(dg JPEG pseudo-tag -TIFFTAG_JPEGQUALITY 1 int JPEG pseudo-tag -TIFFTAG_JPEGTABLES 2 uint32_t*,void* \(dg count & tables -TIFFTAG_JPEGTABLESMODE 1 int \(dg JPEG pseudo-tag -TIFFTAG_MAKE 1 char* -TIFFTAG_MATTEING 1 uint16_t \(dg -TIFFTAG_MAXSAMPLEVALUE 1 uint16_t -TIFFTAG_MINSAMPLEVALUE 1 uint16_t -TIFFTAG_MODEL 1 char* -TIFFTAG_ORIENTATION 1 uint16_t -TIFFTAG_PAGENAME 1 char* -TIFFTAG_PAGENUMBER 2 uint16_t -TIFFTAG_PHOTOMETRIC 1 uint16_t -TIFFTAG_PHOTOSHOP ? uint32_t,void* count, data -TIFFTAG_PLANARCONFIG 1 uint16_t \(dg -TIFFTAG_PREDICTOR 1 uint16_t \(dg -TIFFTAG_PRIMARYCHROMATICITIES 1 float* 6-entry array -TIFFTAG_REFERENCEBLACKWHITE 1 float* \(dg 6-entry array -TIFFTAG_RESOLUTIONUNIT 1 uint16_t -TIFFTAG_RICHTIFFIPTC 2 uint32_t,void* count, data -TIFFTAG_ROWSPERSTRIP 1 uint32_t \(dg must be > 0 -TIFFTAG_SAMPLEFORMAT 1 uint16_t \(dg -TIFFTAG_SAMPLESPERPIXEL 1 uint16_t \(dg value must be <= 4 -TIFFTAG_SMAXSAMPLEVALUE 1 double -TIFFTAG_SMINSAMPLEVALUE 1 double -TIFFTAG_SOFTWARE 1 char* -TIFFTAG_STONITS 1 double \(dg -TIFFTAG_SUBFILETYPE 1 uint32_t -TIFFTAG_SUBIFD 2 uint16_t,uint64_t* count & offsets array -TIFFTAG_TARGETPRINTER 1 char* -TIFFTAG_THRESHHOLDING 1 uint16_t -TIFFTAG_TILEDEPTH 1 uint32_t \(dg -TIFFTAG_TILELENGTH 1 uint32_t \(dg must be a multiple of 8 -TIFFTAG_TILEWIDTH 1 uint32_t \(dg must be a multiple of 8 -TIFFTAG_TRANSFERFUNCTION 1 or 3\(dd uint16_t* 1<<BitsPerSample entry arrays -TIFFTAG_WHITEPOINT 1 float* 2-entry array -TIFFTAG_XMLPACKET 2 uint32_t,void* count, data -TIFFTAG_XPOSITION 1 float -TIFFTAG_XRESOLUTION 1 float -TIFFTAG_YCBCRCOEFFICIENTS 1 float* \(dg 3-entry array -TIFFTAG_YCBCRPOSITIONING 1 uint16_t \(dg -TIFFTAG_YCBCRSAMPLING 2 uint16_t \(dg -TIFFTAG_YPOSITION 1 float -TIFFTAG_YRESOLUTION 1 float -.fi -.sp 5p -\(dg Tag may not have its values changed once data is written. -.br -.fi -\(dd -If -.I SamplesPerPixel -is one, then a single array is passed; otherwise three arrays should be -passed. -.fi -* The contents of this field are quite complex. See -.BR "The ICC Profile Format Specification" , -Annex B.3 "Embedding ICC Profiles in TIFF Files" -(available at http://www.color.org) for an explanation. -.br -.SH "RETURN VALUES" -1 is returned if the operation was successful. -Otherwise, 0 is returned if an error was detected. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.PP -\fB%s: Cannot modify tag "%s" while writing\fP. -Data has already been written to the file, so the -specified tag's value can not be changed. -This restriction is applied to all tags that affect -the format of written data. -.PP -\fB%d: Bad value for "%s"\fP. -An invalid value was supplied for the named tag. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFGetField (3TIFF), -.BR TIFFSetDirectory (3TIFF), -.BR TIFFWriteDirectory (3TIFF), -.BR TIFFReadDirectory (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFWarning.3tiff b/man/TIFFWarning.3tiff deleted file mode 100644 index 9a4d9096..00000000 --- a/man/TIFFWarning.3tiff +++ /dev/null @@ -1,69 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFWarning 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFWarning, TIFFSetWarningHandler \- library warning interface -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "void TIFFWarning(const char *" module ", const char *" fmt ", " ... ")" -.sp -.B "#include <stdarg.h>" -.sp -.BI "typedef void (*TIFFWarningHandler)(const char *" module ", const char *" fmt ", va_list " ap ");" -.sp -.BI "TIFFWarningHandler TIFFSetWarningHandler(TIFFWarningHandler " handler ");" -.SH DESCRIPTION -.I TIFFWarning -invokes the library-wide warning handler function to (normally) write a -warning message to the -.BR stderr . -The -.I fmt -parameter is a -.IR printf (3S) -format string, and any number arguments can be supplied. The -.I module -parameter is interpreted as a string that, if non-zero, should be printed -before the message; it typically is used to identify the software module in -which a warning is detected. -.PP -Applications that desire to capture control in the event of a warning should -use -.IR TIFFSetWarningHandler -to override the default warning handler. -A -.SM NULL -(0) warning handler function may be installed to suppress error messages. -.SH "RETURN VALUES" -.IR TIFFSetWarningHandler -returns a reference to the previous error handling function. -.SH "SEE ALSO" -.BR TIFFError (3TIFF), -.BR libtiff (3TIFF), -.BR printf (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFWriteDirectory.3tiff b/man/TIFFWriteDirectory.3tiff deleted file mode 100644 index e7b84b6d..00000000 --- a/man/TIFFWriteDirectory.3tiff +++ /dev/null @@ -1,137 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFWriteDirectory 3TIFF "September 26, 2001" "libtiff" -.SH NAME -TIFFWriteDirectory, TIFFRewriteDirectory, TIFFCheckpointDirectory \- write the -current directory in an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFWriteDirectory(TIFF *" tif ")" -.br -.BI "int TIFFRewriteDirectory(TIFF *" tif ")" -.br -.BI "int TIFFCheckpointDirectory(TIFF *" tif ")" -.SH DESCRIPTION -.IR TIFFWriteDirectory -will write the contents of the current directory to the file and setup to -create a new subfile in the same file. Applications only need to call -.IR TIFFWriteDirectory -when writing multiple subfiles to a single -.SM TIFF -file. -.IR TIFFWriteDirectory -is automatically called by -.IR TIFFClose -and -.IR TIFFFlush -to write a modified directory if the file is open for writing. -.PP -The -.IR TIFFRewriteDirectory -function operates similarly to -.IR TIFFWriteDirectory, -but can be called with directories previously read or written that already -have an established location in the file. It will rewrite the directory, -but instead of place it at it's old location (as -.IR TIFFWriteDirectory -would) it will place them at the end of the file, correcting the pointer from -the preceding directory or file header to point to it's new location. This -is particularly important in cases where the size of the directory and -pointed to data has grown, so it won't fit in the space available at the -old location. -.PP -The -.IR TIFFCheckpointDirectory -writes the current state of the tiff directory into the file to make what -is currently in the file readable. Unlike -.IR TIFFWriteDirectory, -.IR TIFFCheckpointDirectory -does not free up the directory data structures in memory, so they can be -updated (as strips/tiles are written) and written again. Reading such -a partial file you will at worst get a tiff read error for the first -strip/tile encountered that is incomplete, but you will at least get -all the valid data in the file before that. When the file is complete, -just use -.IR TIFFWriteDirectory -as usual to finish it off cleanly. -.SH "RETURN VALUES" -1 is returned when the contents are successfully written to the file. -Otherwise, 0 is returned if an error was encountered when writing -the directory contents. -.SH DIAGNOSTICS -All error messages are directed to the -.IR TIFFError (3TIFF) -routine. -.PP -.BR "Error post-encoding before directory write" . -Before writing the contents of the current directory, any pending data are -flushed. This message indicates that an error occurred while doing this. -.PP -.BR "Error flushing data before directory write" . -Before writing the contents of the current directory, any pending data are -flushed. This message indicates that an error occurred while doing this. -.PP -.BR "Cannot write directory, out of space" . -There was not enough space to allocate a temporary area for the directory that -was to be written. -.PP -.BR "Error writing directory count" . -A write error occurred when writing the count of fields in the directory. -.PP -.BR "Error writing directory contents" . -A write error occurred when writing the directory fields. -.PP -.BR "Error writing directory link" . -A write error occurred when writing the link to the next directory. -.PP -\fBError writing data for field "%s"\fP. -A write error occurred when writing indirect data for the specified field. -.PP -.BR "Error writing TIFF header" . -A write error occurred when re-writing header at the front of the file. -.PP -.BR "Error fetching directory count" . -A read error occurred when fetching the directory count field for -a previous directory. -This can occur when setting up a link to the directory that is being -written. -.PP -.BR "Error fetching directory link" . -A read error occurred when fetching the directory link field for -a previous directory. -This can occur when setting up a link to the directory that is being -written. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFError (3TIFF), -.BR TIFFReadDirectory (3TIFF), -.BR TIFFSetDirectory (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFWriteEncodedStrip.3tiff b/man/TIFFWriteEncodedStrip.3tiff deleted file mode 100644 index dc410e41..00000000 --- a/man/TIFFWriteEncodedStrip.3tiff +++ /dev/null @@ -1,101 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFWriteEncodedStrip 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFWritedEncodedStrip \- compress and write a strip of data to an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "tsize_t TIFFWriteEncodedStrip(TIFF *" tif ", tstrip_t " strip ", tdata_t " buf ", tsize_t " size ")" -.SH DESCRIPTION -Compress -.I size -bytes of raw data from -.I buf -and write the result to the specified strip; replacing any previously written -data. Note that the value of -.I strip -is a ``raw strip number.'' That is, the caller must take into account whether -or not the data are organized in separate planes (\c -.IR PlanarConfiguration =2). -.SH NOTES -The library writes encoded data using the native machine byte order. Correctly -implemented -.SM TIFF -readers are expected to do any necessary byte-swapping to correctly process -image data with BitsPerSample greater than 8. -.PP -The strip number must be valid according to the current settings of the -.I ImageLength -and -.I RowsPerStrip -tags. -An image may be dynamically grown by increasing the value of -.I ImageLength -prior to each call to -.IR TIFFWriteEncodedStrip . -.SH "RETURN VALUES" -\-1 is returned if an error was encountered. Otherwise, the value of -.IR size -is returned. -.SH DIAGNOSTICS -All error messages are directed to the -.IR TIFFError (3TIFF) -routine. -.PP -\fB%s: File not open for writing\fP. The file was opened for reading, not -writing. -.PP -\fBCan not write scanlines to a tiled image\fP. The image is assumed to be -organized in tiles because the -.I TileWidth -and -.I TileLength -tags have been set with -.IR TIFFSetField (3TIFF). -.PP -\fB%s: Must set "ImageWidth" before writing data\fP. -The image's width has not be set before the first write. See -.IR TIFFSetField (3TIFF) -for information on how to do this. -.PP -\fB%s: Must set "PlanarConfiguration" before writing data\fP. -The organization of data has not be defined before the first write. See -.IR TIFFSetField (3TIFF) -for information on how to do this. -.PP -\fB%s: No space for strip arrays"\fP. -There was not enough space for the arrays that hold strip offsets and byte -counts. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFWriteScanline (3TIFF), -.BR TIFFWriteRawStrip (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFWriteEncodedTile.3tiff b/man/TIFFWriteEncodedTile.3tiff deleted file mode 100644 index d94f4d0e..00000000 --- a/man/TIFFWriteEncodedTile.3tiff +++ /dev/null @@ -1,95 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFWriteEncodedTile 3TIFF "December 16, 1991" "libtiff" -.SH NAME -TIFFWritedEncodedTile \- compress and write a tile of data to an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "tsize_t TIFFWriteEncodedTile(TIFF *" tif ", ttile_t " tile ", tdata_t " buf ", tsize_t " size ")" -.SH DESCRIPTION -Compress -.I size -bytes of raw data from -.I buf -and -.B append -the result to the end of the specified tile. Note that the value of -.I tile -is a ``raw tile number.'' That is, the caller must take into account whether -or not the data are organized in separate places (\c -.IR PlanarConfiguration =2). -.IR TIFFComputeTile -automatically does this when converting an (x,y,z,sample) coordinate quadruple -to a tile number. -.SH NOTES -The library writes encoded data using the native machine byte order. Correctly -implemented -.SM TIFF -readers are expected to do any necessary byte-swapping to correctly process -image data with BitsPerSample greater than 8. -.SH "RETURN VALUES" -\-1 is returned if an error was encountered. Otherwise, the value of -.IR size -is returned. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.PP -\fB%s: File not open for writing\fP. -The file was opened for reading, not writing. -.PP -\fBCan not write tiles to a stripped image\fP. -The image is assumed to be organized in strips because neither of the -.I TileWidth -or -.I TileLength -tags have been set with -.BR TIFFSetField (3TIFF). -.PP -\fB%s: Must set "ImageWidth" before writing data\fP. The image's width has not -be set before the first write. See -.BR TIFFSetField (3TIFF) -for information on how to do this. -.PP -\fB%s: Must set "PlanarConfiguration" before writing data\fP. The organization -of data has not be defined before the first write. See -.BR TIFFSetField (3TIFF) -for information on how to do this. -.PP -\fB%s: No space for tile arrays"\fP. -There was not enough space for the arrays that hold tile offsets and byte -counts. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFWriteTile (3TIFF), -.BR TIFFWriteRawTile (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFWriteRawStrip.3tiff b/man/TIFFWriteRawStrip.3tiff deleted file mode 100644 index 784a6e03..00000000 --- a/man/TIFFWriteRawStrip.3tiff +++ /dev/null @@ -1,95 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFWriteRawstrip 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFWriteRawStrip \- write a strip of raw data to an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "tsize_t TIFFWriteRawStrip(TIFF *" tif ", tstrip_t " strip ", tdata_t " buf ", tsize_t " size ")" -.SH DESCRIPTION -Append -.I size -bytes of raw data to the specified strip. -.SH NOTES -The strip number must be valid according to the current settings of the -.I ImageLength -and -.I RowsPerStrip -tags. -An image may be dynamically grown by increasing the value of -.I ImageLength -prior to each call to -.IR TIFFWriteRawStrip . -.SH "RETURN VALUES" -\-1 is returned if an error occurred. -Otherwise, the value of -.IR size -is returned. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.PP -\fB%s: File not open for writing\fP. -The file was opened for reading, not writing. -.PP -\fBCan not write scanlines to a tiled image\fP. The image is assumed to be -organized in tiles because the -.I TileWidth -and -.I TileLength -tags have been set with -.BR TIFFSetField (3TIFF). -.PP -\fB%s: Must set "ImageWidth" before writing data\fP. -The image's width has not be set before the first write. -See -.BR TIFFSetField (3TIFF) -for information on how to do this. -.PP -\fB%s: Must set "PlanarConfiguration" before writing data\fP. -The organization of data has not be defined before the first write. -See -.BR TIFFSetField (3TIFF) -for information on how to do this. -.PP -\fB%s: No space for strip arrays"\fP. -There was not enough space for the arrays that hold strip -offsets and byte counts. -.PP -\fB%s: Strip %d out of range, max %d\fP. -The specified strip is not a valid strip according to the -currently specified image dimensions. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFWriteEncodedStrip (3TIFF), -.BR TIFFWriteScanline (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFWriteRawTile.3tiff b/man/TIFFWriteRawTile.3tiff deleted file mode 100644 index f3334b85..00000000 --- a/man/TIFFWriteRawTile.3tiff +++ /dev/null @@ -1,83 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFWriteRawtile 3TIFF "December 16, 1991" "libtiff" -.SH NAME -TIFFWriteRawTile \- write a tile of raw data to an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "tsize_t TIFFWriteRawTile(TIFF *" tif ", ttile_t " tile ", tdata_t " buf ", tsize_t " size ")" -.SH DESCRIPTION -Append -.I size -bytes of raw data to the specified tile. -.SH "RETURN VALUES" -\-1 is returned if an error occurred. Otherwise, the value of -.IR size -is returned. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.PP -\fB%s: File not open for writing\fP. -The file was opened for reading, not writing. -.PP -\fBCan not write tiles to a stripped image\fP. -The image is assumed to be organized in strips because neither of the -.I TileWidth -or -.I TileLength -tags have been set with -.BR TIFFSetField (3TIFF). -.PP -\fB%s: Must set "ImageWidth" before writing data\fP. -The image's width has not be set before the first write. -See -.BR TIFFSetField (3TIFF) -for information on how to do this. -.PP -\fB%s: Must set "PlanarConfiguration" before writing data\fP. The organization -of data has not be defined before the first write. See -.BR TIFFSetField (3TIFF) -for information on how to do this. -.PP -\fB%s: No space for tile arrays"\fP. -There was not enough space for the arrays that hold tile offsets and byte -counts. -.PP -\fB%s: Specified tile %d out of range, max %d\fP. -The specified tile is not valid according to the currently specified image -dimensions. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFWriteEncodedTile (3TIFF), -.BR TIFFWriteScanline (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFWriteScanline.3tiff b/man/TIFFWriteScanline.3tiff deleted file mode 100644 index bf6e6a8d..00000000 --- a/man/TIFFWriteScanline.3tiff +++ /dev/null @@ -1,153 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFWriteScanline 3TIFF "December 16, 1991" "libtiff" -.SH NAME -TIFFWriteScanline \- write a scanline to an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFWriteScanline(TIFF *" tif ", tdata_t " buf ", uint32_t " row ", tsample_t " sample ")" -.SH DESCRIPTION -Write data to a file at the specified row. The -.I sample -parameter is used only if data are organized in separate planes (\c -.IR PlanarConfiguration =2). -The data are assumed to be uncompressed and in the native bit- and byte-order -of the host machine. The data written to the file is compressed according to -the compression scheme of the current -.SM TIFF -directory (see further below). If the current scanline is past the end of the -current subfile, the -.I ImageLength -field is automatically increased to include the scanline (except -for -.IR PlanarConfiguration =2, -where the -.I ImageLength -cannot be changed once the first data are written). If the -.I ImageLength -is increased, the -.I StripOffsets -and -.I StripByteCounts -fields are similarly enlarged to reflect data written past the previous end of -image. -.SH NOTES -The library writes encoded data using the native machine byte order. Correctly -implemented -.SM TIFF -readers are expected to do any necessary byte-swapping to correctly process -image data with BitsPerSample greater than 8. The library attempts to hide -bit-ordering differences between the image and the native machine by -converting data from the native machine order. -.PP -In C++ the -.I sample -parameter defaults to 0. -.PP -Once data are written to a file for the current directory, the values of -certain tags may not be altered; see -.IR TIFFSetField (3TIFF) -for more information. -.PP -It is not possible to write scanlines to a file that uses a tiled -organization. The routine -.IR TIFFIsTiled -can be used to determine if the file is organized as tiles or strips. -.SH "RETURN VALUES" -.IR TIFFWriteScanline -returns \-1 if it immediately detects an error and 1 for a successful write. -.SH DIAGNOSTICS -All error messages are directed to the -.IR TIFFError (3TIFF) -routine. -.PP -.BR "%s: File not open for writing . -The file was opened for reading, not writing. -.PP -.BR "Can not write scanlines to a tiled image" . -An attempt was made to write a scanline to a tiled image. The image is assumed -to be organized in tiles because the -.I TileWidth -and -.I TileLength -tags have been set with -.IR TIFFSetField (3TIFF). -.PP -.BR "Compression algorithm does not support random access" . -Data was written in a non-sequential order to a file that uses a compression -algorithm and that has -.I RowsPerStrip -greater than one. That is, data in the image is to be stored in a compressed -form, and with multiple rows packed into a strip. In this case, the library -does not support random access to the data. The data should either be written -as entire strips, sequentially by rows, or the value of -.I RowsPerStrip -should be set to one. -.PP -\fB%s: Must set "ImageWidth" before writing data\fP. -The image's width has not be set before the first write. -See -.BR TIFFSetField (3TIFF) -for information on how to do this. -.PP -\fB%s: Must set "PlanarConfiguration" before writing data\fP. -The organization of data has not be defined before the first write. -See -.BR TIFFSetField (3TIFF) -for information on how to do this. -.PP -\fBCan not change "ImageLength" when using separate planes\fP. Separate image -planes are being used (\c -.IR PlanarConfiguration =2), -but the number of rows has not been specified before the first write. The -library supports the dynamic growth of an image only when data are organized -in a contiguous manner (\c -.IR PlanarConfiguration =1). -.PP -.BR "%d: Sample out of range, max %d" . -The -.I sample -parameter was greater than the value of the SamplesPerPixel tag. -.PP -.BR "%s: No space for strip arrays . -There was not enough space for the arrays that hold strip offsets and byte -counts. -.SH BUGS -Writing subsampled YCbCR data does not work correctly because, for -.IR PlanarConfiguration =2 -the size of a scanline is not calculated on a per-sample basis, and for -.IR PlanarConfiguration =1 -the library does not pack the block-interleaved samples. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFWriteEncodedStrip (3TIFF), -.BR TIFFWriteRawStrip (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFWriteTile.3tiff b/man/TIFFWriteTile.3tiff deleted file mode 100644 index 7e86ae00..00000000 --- a/man/TIFFWriteTile.3tiff +++ /dev/null @@ -1,76 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFWriteTile 3TIFF "November 29, 1999" "libtiff" -.SH NAME -TIFFWriteTile \- encode and write a tile of data to an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "tsize_t TIFFWriteTile(TIFF *" tif ", tdata_t " buf ", uint32_t " x ", uint32_t " y ", uint32_t " z ", tsample_t " sample ")" -.SH DESCRIPTION -Write the data for the tile -.I containing -the specified coordinates. The data in -.I buf -are is (potentially) compressed, and written to the indicated file, normally -being appended to the end of the file. The buffer must be contain an entire -tile of data. Applications should call the routine -.IR TIFFTileSize -to find out the size (in bytes) of a tile buffer. The -.I x -and -.I y -parameters are always used by -.IR TIFFWriteTile . -The -.I z -parameter is used if the image is deeper than 1 slice (\c -.IR ImageDepth >1). -The -.I sample -parameter is used only if data are organized in separate planes (\c -.IR PlanarConfiguration =2). -.SH "RETURN VALUES" -.IR TIFFWriteTile -returns \-1 if it detects an error; otherwise the number of bytes in the tile -is returned. -.SH DIAGNOSTICS -All error messages are directed to the -.BR TIFFError (3TIFF) -routine. -.SH "SEE ALSO" -.BR TIFFCheckTile (3TIFF), -.BR TIFFComputeTile (3TIFF), -.BR TIFFOpen (3TIFF), -.BR TIFFReadTile (3TIFF), -.BR TIFFWriteScanline (3TIFF), -.BR TIFFWriteEncodedTile (3TIFF), -.BR TIFFWriteRawTile (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFbuffer.3tiff b/man/TIFFbuffer.3tiff deleted file mode 100644 index 20111701..00000000 --- a/man/TIFFbuffer.3tiff +++ /dev/null @@ -1,76 +0,0 @@ -.\" -.\" Copyright (c) 1995 Sam Leffler -.\" Copyright (c) 1995 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFBUFFER 3TIFF "November 1, 2005" "libtiff" -.SH NAME -TIFFReadBufferSetup, TIFFWriteBufferSetup \- I/O buffering control routines -.SH SYNOPSIS -.nf -.B "#include <tiffio.h>" -.sp -.BI "int TIFFReadBufferSetup(TIFF *" tif ", tdata_t " buffer ", tsize_t " size ");" -.BI "int TIFFWriteBufferSetup(TIFF *" tif ", tdata_t " buffer ", tsize_t " size ");" -.fi -.SH DESCRIPTION -The following routines are provided for client-control of the I/O buffers used -by the library. Applications need never use these routines; they are provided -only for ``intelligent clients'' that wish to optimize memory usage and/or -eliminate potential copy operations that can occur when working with images -that have data stored without compression. -.PP -.I TIFFReadBufferSetup -sets up the data buffer used to read raw (encoded) data from a file. If the -specified pointer is -.SM NULL -(zero), then a buffer of the appropriate size is allocated. Otherwise the -caller must guarantee that the buffer is large enough to hold any individual -strip of raw data. -.I TIFFReadBufferSetup -returns a non-zero value if the setup was successful and zero otherwise. -.PP -.I TIFFWriteBufferSetup -sets up the data buffer used to write raw (encoded) data to a file. If the -specified -.I size -is \-1 then the buffer size is selected to hold a complete tile or strip, or -at least 8 kilobytes, whichever is greater. If the specified -.I buffer -is -.SM NULL -(zero), then a buffer of the appropriate size is dynamically allocated. -.I TIFFWriteBufferSetup -returns a non-zero value if the setup was successful and zero otherwise. -.SH DIAGNOSTICS -.BR "%s: No space for data buffer at scanline %ld" . -.I TIFFReadBufferSetup -was unable to dynamically allocate space for a data buffer. -.PP -.BR "%s: No space for output buffer" . -.I TIFFWriteBufferSetup -was unable to dynamically allocate space for a data buffer. -.SH "SEE ALSO" -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFcodec.3tiff b/man/TIFFcodec.3tiff deleted file mode 100644 index 1fb41816..00000000 --- a/man/TIFFcodec.3tiff +++ /dev/null @@ -1,81 +0,0 @@ -.\" -.\" Copyright (c) 1995 Sam Leffler -.\" Copyright (c) 1995 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH CODEC 3TIFF "October 29, 2004" "libtiff" -.SH NAME -TIFFFindCODEC, TIFFRegisterCODEC, TIFFUnRegisterCODEC, TIFFIsCODECConfigured -\- codec-related utility routines -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "const TIFFCodec* TIFFFindCODEC(uint16_t " scheme ");" -.br -.BI "TIFFCodec* TIFFRegisterCODEC(uint16_t " scheme ", const char *" method ", TIFFInitMethod " init ");" -.br -.BI "void TIFFUnRegisterCODEC(TIFFCodec *" codec ");" -.br -.BI "int TIFFIsCODECConfigured(uint16_t " scheme ");" -.SH DESCRIPTION -.I libtiff -supports a variety of compression schemes implemented by software -.IR codecs . -Each codec adheres to a modular interface that provides for -the decoding and encoding of image data; as well as some other -methods for initialization, setup, cleanup, and the control -of default strip and tile sizes. -Codecs are identified by the associated value of the -.SM TIFF -.I Compression -tag; e.g. 5 for -.SM LZW -compression. -.PP -The -.I TIFFRegisterCODEC -routine can be used to -augment or override the set of codecs available to an application. -If the specified -.I scheme -already has a registered codec then it is -.I overridden -and any images with data encoded with this -compression scheme will be decoded using the supplied codec. -.PP -.I TIFFIsCODECConfigured -returns 1 if the codec is configured and working. Otherwise 0 will be returned. -.SH DIAGNOSTICS -.BR "No space to register compression scheme %s" . -.I TIFFRegisterCODEC -was unable to allocate memory for the data structures needed -to register a codec. -.PP -.BR "Cannot remove compression scheme %s; not registered" . -.I TIFFUnRegisterCODEC -did not locate the specified codec in the table of registered -compression schemes. -.SH "SEE ALSO" -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFcolor.3tiff b/man/TIFFcolor.3tiff deleted file mode 100644 index d1e74a7c..00000000 --- a/man/TIFFcolor.3tiff +++ /dev/null @@ -1,267 +0,0 @@ -.\" -.\" Copyright (c) 2003, Andrey Kiselev <dron@ak4719.spb.edu> -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH COLOR 3TIFF "December 21, 2003" "libtiff" -.SH NAME -TIFFYCbCrToRGBInit, TIFFYCbCrtoRGB, TIFFCIELabToRGBInit, TIFFCIELabToXYZ, -TIFFXYZToRGB \- color conversion routines. -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "int TIFFYCbCrToRGBInit(TIFFYCbCrToRGB *" ycbcr ", float *" luma ", float *"refBlackWhite" );" -.br -.BI "void TIFFYCbCrtoRGB(TIFFYCbCrToRGB *" ycbcr ", uint32_t " Y ", int32_t " Cb ", int32_t " Cr ", uint32_t *" R ", uint32_t *" G ", uint32_t *" B " );" -.sp -.BI "int TIFFCIELabToRGBInit(TIFFCIELabToRGB *" cielab ", const TIFFDisplay *" display ", float *" refWhite ");" -.br -.BI "void TIFFCIELabToXYZ(TIFFCIELabToRGB *" cielab ", uint32_t " L ", int32_t " a ", int32_t " b ", float *" X ", float *" Y ", float *" Z ");" -.br -.BI "void TIFFXYZToRGB(TIFFCIELabToRGB *" cielab ", float " X ", float " Y ", float " Z" , uint32_t *" R ", uint32_t *" G ", uint32_t *" B ");" -.SH DESCRIPTION -TIFF supports several color spaces for images stored in that format. There is -usually a problem of application to handle the data properly and convert -between different colorspaces for displaying and printing purposes. To -simplify this task libtiff implements several color conversion routines -itself. In particular, these routines used in -.B TIFFRGBAImage(3TIFF) -interface. -.PP -.B TIFFYCbCrToRGBInit() -used to initialize -.I YCbCr -to -.I RGB -conversion state. Allocating and freeing of the -.I ycbcr -structure belongs to programmer. -.I TIFFYCbCrToRGB -defined in -.B tiffio.h -as -.PP -.RS -.nf -typedef struct { /* YCbCr->RGB support */ - TIFFRGBValue* clamptab; /* range clamping table */ - int* Cr_r_tab; - int* Cb_b_tab; - int32_t* Cr_g_tab; - int32_t* Cb_g_tab; - int32_t* Y_tab; -} TIFFYCbCrToRGB; -.fi -.RE -.PP -.I luma -is a float array of three values representing proportions of the red, green -and blue in luminance, Y (see section 21 of the TIFF 6.0 specification, where -the YCbCr images discussed). -.I TIFFTAG_YCBCRCOEFFICIENTS -holds that values in TIFF file. -.I refBlackWhite -is a float array of 6 values which specifies a pair of headroom and footroom -image data values (codes) for each image component (see section 20 of the -TIFF 6.0 specification where the colorinmetry fields discussed). -.I TIFFTAG_REFERENCEBLACKWHITE -is responsible for storing these values in TIFF file. Following code snippet -should helps to understand the the technique: -.PP -.RS -.nf -float *luma, *refBlackWhite; -uint16_t hs, vs; - -/* Initialize structures */ -ycbcr = (TIFFYCbCrToRGB*) - _TIFFmalloc(TIFFroundup(sizeof(TIFFYCbCrToRGB), sizeof(long)) - + 4*256*sizeof(TIFFRGBValue) - + 2*256*sizeof(int) - + 3*256*sizeof(int32_t)); -if (ycbcr == NULL) { - TIFFError("YCbCr->RGB", - "No space for YCbCr->RGB conversion state"); - exit(0); -} - -TIFFGetFieldDefaulted(tif, TIFFTAG_YCBCRCOEFFICIENTS, &luma); -TIFFGetFieldDefaulted(tif, TIFFTAG_REFERENCEBLACKWHITE, &refBlackWhite); -if (TIFFYCbCrToRGBInit(ycbcr, luma, refBlackWhite) < 0) - exit(0); - -/* Start conversion */ -uint32_t r, g, b; -uint32_t Y; -int32_t Cb, Cr; - -for each pixel in image - TIFFYCbCrtoRGB(img->ycbcr, Y, Cb, Cr, &r, &g, &b); - -/* Free state structure */ -_TIFFfree(ycbcr); -.fi -.RE -.PP - -.PP -.B TIFFCIELabToRGBInit() -initializes the -.I CIE L*a*b* 1976 -to -.I RGB -conversion state. -.B TIFFCIELabToRGB -defined as -.PP -.RS -.nf -#define CIELABTORGB_TABLE_RANGE 1500 - -typedef struct { /* CIE Lab 1976->RGB support */ - int range; /* Size of conversion table */ - float rstep, gstep, bstep; - float X0, Y0, Z0; /* Reference white point */ - TIFFDisplay display; - float Yr2r[CIELABTORGB_TABLE_RANGE + 1]; /* Conversion of Yr to r */ - float Yg2g[CIELABTORGB_TABLE_RANGE + 1]; /* Conversion of Yg to g */ - float Yb2b[CIELABTORGB_TABLE_RANGE + 1]; /* Conversion of Yb to b */ -} TIFFCIELabToRGB; -.fi -.RE -.PP -.I display -is a display device description, declared as -.PP -.RS -.nf -typedef struct { - float d_mat[3][3]; /* XYZ -> luminance matrix */ - float d_YCR; /* Light o/p for reference white */ - float d_YCG; - float d_YCB; - uint32_t d_Vrwr; /* Pixel values for ref. white */ - uint32_t d_Vrwg; - uint32_t d_Vrwb; - float d_Y0R; /* Residual light for black pixel */ - float d_Y0G; - float d_Y0B; - float d_gammaR; /* Gamma values for the three guns */ - float d_gammaG; - float d_gammaB; -} TIFFDisplay; -.fi -.RE -.PP -For example, the one can use sRGB device, which has the following parameters: -.PP -.RS -.nf -TIFFDisplay display_sRGB = { - { /* XYZ -> luminance matrix */ - { 3.2410F, -1.5374F, -0.4986F }, - { -0.9692F, 1.8760F, 0.0416F }, - { 0.0556F, -0.2040F, 1.0570F } - }, - 100.0F, 100.0F, 100.0F, /* Light o/p for reference white */ - 255, 255, 255, /* Pixel values for ref. white */ - 1.0F, 1.0F, 1.0F, /* Residual light o/p for black pixel */ - 2.4F, 2.4F, 2.4F, /* Gamma values for the three guns */ -}; -.fi -.RE -.PP -.I refWhite -is a color temperature of the reference white. The -.I TIFFTAG_WHITEPOINT -contains the chromaticity of the white point of the image from where the -reference white can be calculated using following formulae: -.PP -.RS -refWhite_Y = 100.0 -.br -refWhite_X = whitePoint_x / whitePoint_y * refWhite_Y -.br -refWhite_Z = (1.0 - whitePoint_x - whitePoint_y) / whitePoint_y * refWhite_X -.br -.RE -.PP -The conversion itself performed in two steps: at the first one we will convert -.I CIE L*a*b* 1976 -to -.I CIE XYZ -using -.B TIFFCIELabToXYZ() -routine, and at the second step we will convert -.I CIE XYZ -to -.I RGB -using -.B TIFFXYZToRGB(). -Look at the code sample below: -.PP -.RS -.nf -float *whitePoint; -float refWhite[3]; - -/* Initialize structures */ -img->cielab = (TIFFCIELabToRGB *) - _TIFFmalloc(sizeof(TIFFCIELabToRGB)); -if (!cielab) { - TIFFError("CIE L*a*b*->RGB", - "No space for CIE L*a*b*->RGB conversion state."); - exit(0); -} - -TIFFGetFieldDefaulted(tif, TIFFTAG_WHITEPOINT, &whitePoint); -refWhite[1] = 100.0F; -refWhite[0] = whitePoint[0] / whitePoint[1] * refWhite[1]; -refWhite[2] = (1.0F - whitePoint[0] - whitePoint[1]) - / whitePoint[1] * refWhite[1]; -if (TIFFCIELabToRGBInit(cielab, &display_sRGB, refWhite) < 0) { - TIFFError("CIE L*a*b*->RGB", - "Failed to initialize CIE L*a*b*->RGB conversion state."); - _TIFFfree(cielab); - exit(0); -} - -/* Now we can start to convert */ -uint32_t r, g, b; -uint32_t L; -int32_t a, b; -float X, Y, Z; - -for each pixel in image - TIFFCIELabToXYZ(cielab, L, a, b, &X, &Y, &Z); - TIFFXYZToRGB(cielab, X, Y, Z, &r, &g, &b); - -/* Don't forget to free the state structure */ -_TIFFfree(cielab); -.fi -.RE -.PP -.SH "SEE ALSO" -.BR TIFFRGBAImage (3TIFF) -.BR libtiff (3TIFF), -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFmemory.3tiff b/man/TIFFmemory.3tiff deleted file mode 100644 index 70a82123..00000000 --- a/man/TIFFmemory.3tiff +++ /dev/null @@ -1,89 +0,0 @@ -.\" -.\" Copyright (c) 1995 Sam Leffler -.\" Copyright (c) 1995 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH MEMORY 3TIFF "October 15, 1995" "libtiff" -.SH NAME -_TIFFmalloc, \c -_TIFFrealloc, \c -_TIFFfree, \c -_TIFFmemset, \c -_TIFFmemcpy, \c -_TIFFmemcmp, \c -\- memory management-related functions for use with -.SM TIFF -files -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "tdata_t _TIFFmalloc(tsize_t " size ");" -.br -.BI "tdata_t _TIFFrealloc(tdata_t " buffer ", tsize_t " size ");" -.br -.BI "void _TIFFfree(tdata_t " buffer ");" -.br -.BI "void _TIFFmemset(tdata_t " s ", int " c ", tsize_t " n ");" -.br -.BI "void _TIFFmemcpy(tdata_t " dest ", const tdata_t " src ", tsize_t " n ");" -.br -.BI "int _TIFFmemcmp(const tdata_t " s1 ", const tdata_t "s2 ", tsize_t " n ");" -.SH DESCRIPTION -These routines are provided for writing portable software that uses -.IR libtiff ; -they hide any memory-management related issues, such as dealing with segmented -architectures found on 16-bit machines. -.PP -.I _TIFFmalloc -and -.I _TIFFrealloc -are used to dynamically allocate and reallocate memory used by -.IR libtiff ; -such as memory passed into the I/O routines. Memory allocated through these -interfaces is released back to the system using the -.I _TIFFfree -routine. -.PP -Memory allocated through one of the above interfaces can be set to a known -value using -.IR _TIFFmemset , -copied to another memory location using -.IR _TIFFmemcpy , -or compared for equality using -.IR _TIFFmemcmp . -These routines conform to the equivalent -.SM ANSI -C routines: -.IR memset , -.IR memcpy , -and -.IR memcmp , -respectively. -.SH DIAGNOSTICS -None. -.SH "SEE ALSO" -.BR malloc (3), -.BR memory (3), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFquery.3tiff b/man/TIFFquery.3tiff deleted file mode 100644 index 1e56a0ec..00000000 --- a/man/TIFFquery.3tiff +++ /dev/null @@ -1,141 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH QUERY 3TIFF "October 29, 2004" "libtiff" -.SH NAME -TIFFCurrentRow, -TIFFCurrentStrip, -TIFFCurrentTile, -TIFFCurrentDirectory, -TIFFLastDirectory, -TIFFFileno, -TIFFFileName, -TIFFGetMode, -TIFFIsTiled, -TIFFIsByteSwapped, -TIFFIsUpSampled, -TIFFIsMSB2LSB, -TIFFGetVersion -\- query routines -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "uint32_t TIFFCurrentRow(TIFF* " tif ")" -.br -.BI "tstrip_t TIFFCurrentStrip(TIFF* " tif ")" -.br -.BI "ttile_t TIFFCurrentTile(TIFF* " tif ")" -.br -.BI "tdir_t TIFFCurrentDirectory(TIFF* " tif ")" -.br -.BI "int TIFFLastDirectory(TIFF* " tif ")" -.br -.BI "int TIFFFileno(TIFF* " tif ")" -.br -.BI "char* TIFFFileName(TIFF* " tif ")" -.br -.BI "int TIFFGetMode(TIFF* " tif ")" -.br -.BI "int TIFFIsTiled(TIFF* " tif ")" -.br -.BI "int TIFFIsByteSwapped(TIFF* " tif ")" -.br -.BI "int TIFFIsUpSampled(TIFF* " tif ")" -.br -.BI "int TIFFIsMSB2LSB(TIFF* " tif ")" -.br -.BI "const char* TIFFGetVersion(void)" -.SH DESCRIPTION -The following routines return status information about an open -.SM TIFF -file. -.PP -.IR TIFFCurrentDirectory -returns the index of the current directory (directories are numbered starting -at 0). This number is suitable for use with the -.IR TIFFSetDirectory -routine. -.PP -.IR TIFFLastDirectory -returns a non-zero value if the current directory is the last directory in the -file; otherwise zero is returned. -.PP -.IR TIFFCurrentRow , -.IR TIFFCurrentStrip , -and -.IR TIFFCurrentTile , -return the current row, strip, and tile, respectively, that is being read or -written. These values are updated each time a read or write is done. -.PP -.IR TIFFFileno -returns the underlying file descriptor used to access the -.SM TIFF -image in the filesystem. -.PP -.IR TIFFFileName -returns the pathname argument passed to -.IR TIFFOpen -or -.IR TIFFFdOpen . -.PP -.IR TIFFGetMode -returns the mode with which the underlying file was opened. On -.SM UNIX -systems, this is the value passed to the -.IR open (2) -system call. -.PP -.IR TIFFIsTiled -returns a non-zero value if the image data has a tiled organization. Zero is -returned if the image data is organized in strips. -.PP -.IR TIFFIsByteSwapped -returns a non-zero value if the image data was in a different byte-order than -the host machine. Zero is returned if the TIFF file and local host byte-orders -are the same. Note that TIFFReadTile(), TIFFReadEncodedStrip() and -TIFFReadScanline() functions already normally perform byte swapping to local -host order if needed. -.PP -.I TIFFIsUpSampled -returns a non-zero value if image data returned through the read interface -routines is being up-sampled. This can be useful to applications that want to -calculate I/O buffer sizes to reflect this usage (though the usual strip and -tile size routines already do this). -.PP -.I TIFFIsMSB2LSB -returns a non-zero value if the image data is being returned with bit 0 as the -most significant bit. -.PP -.IR TIFFGetVersion -returns an -.SM ASCII -string that has a version stamp for the -.SM TIFF -library software. -.SH DIAGNOSTICS -None. -.SH "SEE ALSO" -.IR libtiff (3TIFF), -.IR TIFFOpen (3TIFF), -.IR TIFFFdOpen (3TIFF) diff --git a/man/TIFFsize.3tiff b/man/TIFFsize.3tiff deleted file mode 100644 index 5fbc6bc9..00000000 --- a/man/TIFFsize.3tiff +++ /dev/null @@ -1,58 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFSIZE 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFScanlineSize, TIFFRasterScanlineSize, -\- return the size of various items associated with an open -.SM TIFF -file -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "tsize_t TIFFRasterScanlineSize(TIFF *" tif ")" -.br -.BI "tsize_t TIFFScanlineSize(TIFF *" tif ")" -.SH DESCRIPTION -.I TIFFScanlineSize -returns the size in bytes of a row of data as it would be returned in a call -to -.IR TIFFReadScanline , -or as it would be expected in a call to -.IR TIFFWriteScanline . -.PP -.I TIFFRasterScanlineSize -returns the size in bytes of a complete decoded and packed raster scanline. -Note that this value may be different from the value returned by -.I TIFFScanlineSize -if data is stored as separate planes. -.SH DIAGNOSTICS -None. -.SH "SEE ALSO" -.BR TIFFOpen (3TIFF), -.BR TIFFReadScanline (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFstrip.3tiff b/man/TIFFstrip.3tiff deleted file mode 100644 index f8b765ad..00000000 --- a/man/TIFFstrip.3tiff +++ /dev/null @@ -1,98 +0,0 @@ -.\" -.\" Copyright (c) 1992-1997 Sam Leffler -.\" Copyright (c) 1992-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFSTRIP 3TIFF "October 15, 1995" "libtiff" -.SH NAME -TIFFDefaultStripSize, TIFFStripSize, TIFFVStripSize, TIFFRawStripSize, -TIFFComputeStrip, TIFFNumberOfStrips \- strip-related utility routines -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "uint32_t TIFFDefaultStripSize(TIFF *" tif ", uint32_t " estimate ")" -.br -.BI "tmsize_t TIFFStripSize(TIFF *" tif ")" -.br -.BI "tmsize_t TIFFVStripSize(TIFF *" tif ", uint32_t " nrows ")" -.br -.BI "tmsize_t TIFFRawStripSize(TIFF *" tif ", uint32_t " strip ")" -.br -.BI "tstrip_t TIFFComputeStrip(TIFF *" tif ", uint32_t " row ", tsample_t " sample ")" -.br -.BI "tstrip_t TIFFNumberOfStrips(TIFF *" tif ")" -.SH DESCRIPTION -.I TIFFDefaultStripSize -returns the number of rows for a reasonable-sized strip according to the -current settings of the -.IR ImageWidth , -.IR BitsPerSample , -.IR SamplesPerPixel , -tags and any compression-specific requirements. If the -.I estimate -parameter, if non-zero, then it is taken as an estimate of the desired strip -size and adjusted according to any compression-specific requirements. The -value returned by this function is typically used to define the -.I RowsPerStrip -tag. In lieu of any unusual requirements -.I TIFFDefaultStripSize -tries to create strips that have approximately -8 kilobytes of uncompressed data. -.PP -.IR TIFFStripSize -returns the equivalent size for a strip of data as it would be returned in a -call to -.IR TIFFReadEncodedStrip -or as it would be expected in a call to -.IR TIFFWriteEncodedStrip . -.PP -.I TIFFVStripSize -returns the number of bytes in a strip with -.I nrows -rows of data. -.PP -.I TIFFRawStripSize -returns the number of bytes in a raw strip (i.e. not decoded). -.PP -.IR TIFFComputeStrip -returns the strip that contains the specified coordinates. A valid strip is -always returned; out-of-range coordinate values are clamped to the bounds of -the image. The -.I row -parameter is always used in calculating a strip. The -.I sample -parameter is used only if data are organized in separate planes (\c -.IR PlanarConfiguration =2). -.PP -.IR TIFFNumberOfStrips -returns the number of strips in the image. -.SH DIAGNOSTICS -None. -.SH "SEE ALSO" -.BR TIFFReadEncodedStrip (3TIFF), -.BR TIFFReadRawStrip (3TIFF), -.BR TIFFWriteEncodedStrip (3TIFF), -.BR TIFFWriteRawStrip (3TIFF), -.BR libtiff (3TIFF), -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFswab.3tiff b/man/TIFFswab.3tiff deleted file mode 100644 index 44325223..00000000 --- a/man/TIFFswab.3tiff +++ /dev/null @@ -1,79 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH SWAB 3TIFF "November 04, 2004" "libtiff" -.SH NAME -TIFFGetBitRevTable, TIFFReverseBits, TIFFSwabShort, TIFFSwabLong, -TIFFSwabArrayOfShort, TIFFSwabArrayOfLong \- byte- and bit-swapping routines -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "const unsigned char* TIFFGetBitRevTable(int " reversed ")" -.br -.BI "void TIFFReverseBits(u_char *" data ", unsigned long " nbytes ")" -.br -.BI "void TIFFSwabShort(uint16_t *" data ")" -.br -.BI "void TIFFSwabLong(uint32_t *" data ")" -.br -.BI "void TIFFSwabArrayOfShort(uint16_t *" data ", unsigned long " nshorts ")" -.br -.BI "void TIFFSwabArrayOfLong(uint32_t *" data ", unsigned long " nlongs ")" -.SH DESCRIPTION -The following routines are used by the library to swap -16- and 32-bit data and to reverse the order of bits in bytes. -.PP -.IR TIFFSwabShort -and -.IR TIFFSwabLong -swap the bytes in a single 16-bit and 32-bit item, respectively. -.IR TIFFSwabArrayOfShort -and -.IR TIFFSwabArrayOfLong -swap the bytes in an array of 16-bit and 32-bit items, respectively. -.PP -.IR TIFFReverseBits -replaces each byte in -.I data -with the equivalent bit-reversed value. This operation is performed with a -lookup table, which is returned using the -.IR TIFFGetBitRevTable -function. -.I reversed -parameter specifies which table should be returned. Supply -.I 1 -if you want bit reversal table. Supply -.I 0 -to get the table that do not reverse bit values. It is a lookup table that can -be used as an -.IR "identity function" ; -i.e. -.IR "TIFFNoBitRevTable[n] == n" . -.SH DIAGNOSTICS -None. -.SH "SEE ALSO" -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/TIFFtile.3tiff b/man/TIFFtile.3tiff deleted file mode 100644 index 7928e406..00000000 --- a/man/TIFFtile.3tiff +++ /dev/null @@ -1,130 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFTILE 3TIFF "February 14, 1992" "libtiff" -.SH NAME -TIFFTileSize, TIFFTileRowSize, TIFFVTileSize, TIFFDefaultTileSize, -TIFFComputeTile, TIFFCheckTile, TIFFNumberOfTiles \- tile-related utility -routines -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -.BI "void TIFFDefaultTileSize(TIFF *" tif ", uint32_t *" tw ", uint32_t *" th ")" -.br -.BI "tsize_t TIFFTileSize(TIFF *" tif ")" -.br -.BI "tsize_t TIFFTileRowSize(TIFF *" tif ")" -.br -.BI "tsize_t TIFFVTileSize(TIFF *" tif ", uint32_t " nrows ")" -.br -.BI "ttile_t TIFFComputeTile(TIFF *" tif ", uint32_t " x ", uint32_t " y ", uint32_t " z ", tsample_t " sample ")" -.br -.BI "int TIFFCheckTile(TIFF *" tif ", uint32_t " x ", uint32_t " y ", uint32_t " z ", tsample_t " sample ")" -.br -.BI "ttile_t TIFFNumberOfTiles(TIFF *" tif ")" -.br -.SH DESCRIPTION -.I TIFFDefaultTileSize -returns the pixel width and height of a reasonable-sized tile; suitable for -setting up the -.I TileWidth -and -.I TileLength -tags. -If the -.I tw -and -.I th -values passed in are non-zero, then they are adjusted to reflect any -compression-specific requirements. The returned width and height are -constrained to be a multiple of 16 pixels to conform with the -.SM TIFF -specification. -.PP -.I TIFFTileSize -returns the equivalent size for a tile of data as it would be returned in a -call to -.I TIFFReadTile -or as it would be expected in a call to -.IR TIFFWriteTile . -.PP -.I TIFFVTileSize -returns the number of bytes in a row-aligned tile with -.I nrows -of data. -.PP -.I TIFFTileRowSize -returns the number of bytes of a row of data in a tile. -.PP -.IR TIFFComputeTile -returns the tile that contains the specified coordinates. A valid tile is -always returned; out-of-range coordinate values are clamped to the bounds of -the image. The -.I x -and -.I y -parameters are always used in calculating a tile. The -.I z -parameter is used if the image is deeper than 1 slice (\c -.IR ImageDepth >1). -The -.I sample -parameter is used only if data are organized in separate planes (\c -.IR PlanarConfiguration =2). -.PP -.IR TIFFCheckTile -returns a non-zero value if the supplied coordinates are within the bounds of -the image and zero otherwise. The -.I x -parameter is checked against the value of the -.I ImageWidth -tag. The -.I y -parameter is checked against the value of the -.I ImageLength -tag. The -.I z -parameter is checked against the value of the -.I ImageDepth -tag (if defined). The -.I sample -parameter is checked against the value of the -.I SamplesPerPixel -parameter if the data are organized in separate planes. -.PP -.IR TIFFNumberOfTiles -returns the number of tiles in the image. -.SH DIAGNOSTICS -None. -.SH "SEE ALSO" -.BR TIFFReadEncodedTile (3TIFF), -.BR TIFFReadRawTile (3TIFF), -.BR TIFFReadTile (3TIFF), -.BR TIFFWriteEncodedTile (3TIFF), -.BR TIFFWriteRawTile (3TIFF), -.BR TIFFWriteTile (3TIFF), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/fax2ps.1 b/man/fax2ps.1 deleted file mode 100644 index 7aeea4f9..00000000 --- a/man/fax2ps.1 +++ /dev/null @@ -1,158 +0,0 @@ -.\" -.\" Copyright (c) 1991-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.ds Ps PostScript -.if n .po 0 -.TH FAX2PS 1 "November 2, 2005" "libtiff" -.SH NAME -fax2ps \- convert a -.SM TIFF -facsimile to compressed \*(Ps\(tm -.SH SYNOPSIS -.B fax2ps -[ -.I options -] [ -.I file ...\& -] -.SH DESCRIPTION -.I fax2ps -reads one or more -.SM TIFF -facsimile image files and prints a compressed form of -\*(Ps on the standard output that is suitable for printing. -.PP -By default, each page is scaled to reflect the -image dimensions and resolutions stored in the file. -The -.B \-x -and -.B \-y -options can be used to specify the horizontal and vertical -image resolutions (lines/inch), respectively. -If the -.B \-S -option is specified, each page is scaled to fill an output page. -The default output page is 8.5 by 11 inches. -Alternate page dimensions can be specified in inches with the -.B \-W -and -.B \-H -options. -.PP -By default -.I fax2ps -generates \*(Ps for all pages in the file. -The -.B \-p -option can be used to select one or more pages from -a multi-page document. -.PP -.I fax2ps -generates a compressed form of \*(Ps that is -optimized for sending pages of text to a \*(Ps -printer attached to a host through a low-speed link (such -as a serial line). -Each output page is filled with white and then only -the black areas are drawn. -The \*(Ps specification of the black drawing operations -is optimized by using a special font that encodes the -move-draw operations required to fill -the black regions on the page. -This compression scheme typically results in a substantially -reduced \*(Ps description, relative to the straightforward -imaging of the page with a \*(Ps -.I image -operator. -This algorithm can, however, be ineffective -for continuous-tone and white-on-black images. -For these images, it sometimes is more efficient to send -the raster bitmap image directly; see -.BR tiff2ps (1). -.SH OPTIONS -.TP 10 -.BI \-p " number" -Print only the indicated page. -Multiple pages may be printed by specifying -this option more than once. -.TP 10 -.BI \-x " resolution" -Use -.I resolution -as the horizontal resolution, in dots/inch, of the image data. -By default this value is taken from the file. -.TP 10 -.BI \-y " resolution" -Use -.I resolution -as the vertical resolution, in lines/inch, of the image data. -By default this value is taken from the file. -.TP 10 -.B \-S -Scale each page of image data to fill the output page dimensions. -By default images are presented according to the dimension -information recorded in the -.SM TIFF -file. -.TP 10 -.BI \-W " width" -Use -.I width -as the width, in inches, of the output page. -.TP 10 -.BI \-H " height" -Use -.I height -as the height, in inches, of the output page. -.SH DIAGNOSTICS -Some messages about malformed -.SM TIFF -images come from the -.SM TIFF -library. -.PP -Various messages about badly formatted facsimile images -may be generated due to transmission errors in received -facsimile. -.I fax2ps -attempts to recover from such data errors by resynchronizing -decoding at the end of the current scanline. -This can result in long horizontal black lines in the resultant -\*(Ps image. -.SH NOTES -If the destination printer supports \*(Ps Level II then -it is always faster to just send the encoded bitmap generated -by the -.BR tiff2ps (1) -program. -.SH BUGS -.I fax2ps -should probably figure out when it is doing a poor -job of compressing the output and just generate -\*(Ps to image the bitmap raster instead. -.SH "SEE ALSO" -.BR tiff2ps (1), -.BR libtiff (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/fax2tiff.1 b/man/fax2tiff.1 deleted file mode 100644 index 97144c9f..00000000 --- a/man/fax2tiff.1 +++ /dev/null @@ -1,285 +0,0 @@ -.\" -.\" Copyright (c) 1990-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH FAX2TIFF 1 "November 2, 2005" "libtiff" -.SH NAME -fax2tiff \- create a -.SM TIFF -Class F fax file from raw fax data -.SH SYNOPSIS -.B fax2tiff -[ -.I options -] [ -.B \-o -.I output.tif -] -.I input.raw -.SH DESCRIPTION -.I Fax2tiff -creates a -.SM TIFF -file containing -.SM CCITT -Group 3 or Group 4 encoded data from one or more files containing ``raw'' -Group 3 or Group 4 encoded data (typically obtained directly from a fax modem). -By default, each row of data in the resultant -.SM TIFF -file is 1-dimensionally encoded and -padded or truncated to 1728 pixels, as needed. -The resultant image is a set of low resolution (98 lines/inch) -or medium resolution (196 lines/inch) -pages, each of which is a single strip of data. -The generated file conforms to the -.SM TIFF -Class F (\c -.SM FAX\c -) specification for storing facsimile data. -This means, in particular, that each page of the data does -.B not -include the trailing -.I "return to control" -(\c -.SM RTC\c -) code; as required -for transmission by the -.SM CCITT -Group 3 specifications. -The old, ``classic'', format is created if the -.B \-c -option is used. -(The Class F format can also be requested with the -.B \-f -option.) -.PP -The default name of the output image is -.IR fax.tif ; -this can be changed with the -.B \-o -option. -Each input file is assumed to be a separate page of facsimile data -from the same document. -The order in which input files are specified on the command -line is the order in which the resultant pages appear in the -output file. -.SH OPTIONS -Options that affect the interpretation of input data are: -.TP -.B \-3 -Assume input data is -.SM CCITT -Group 3 encoded (default). -.TP -.B \-4 -Assume input data is -.SM CCITT -Group 4 encoded. -.TP -.B \-U -Assume input data is uncompressed (Group 3 or Group 4). -.TP -.B \-1 -Assume input data is encoded with the 1-dimensional version of the -.SM CCITT -Group 3 Huffman encoding algorithm (default). -.TP -.B \-2 -Assume input data is 2-dimensional version of the -.SM CCITT -Group 3 Huffman encoding algorithm. -.TP -.B \-P -Assume input data is -.B not -EOL-aligned (default). This option has effect with Group 3 encoded input only. -.TP -.B \-A -Assume input data is EOL-aligned. This option has effect with Group 3 -encoded input only. -.TP -.B \-M -Treat input data as having bits filled from most significant bit (\c -.SM MSB\c -) to most least bit (\c -.SM LSB\c -). -.TP -.B \-L -Treat input data as having bits filled from least significant bit (\c -.SM LSB\c -) to most significant bit (\c -.SM MSB\c -) (default). -.TP -.B \-B -Assume input data was encoded with black as 0 and white as 1. -.TP -.B \-W -Assume input data was encoded with black as 1 and white as 0 (default). -.TP -.B \-R -Specify the vertical resolution, in lines/inch, of the input images. -By default input are assumed to have a vertical resolution of 196 lines/inch. -If images are low resolution facsimile, a value of 98 lines/inch should -be specified. -.TP -.B \-X -Specify the width, in pixels, of the input images. -By default input are assumed to have a width of 1728 pixels. -.PP -Options that affect the output file format are: -.TP -.B \-o -Specify the name of the output file. -.TP -.B \-7 -Force output to be compressed with the -.SM CCITT -Group 3 Huffman encoding algorithm (default). -.TP -.B \-8 -Force output to be compressed with the -.SM CCITT -Group 4 Huffman encoding. -.TP -.B \-u -Force output to be uncompressed (Group 3 or Group 4). -.TP -.B \-5 -Force output to be encoded with the 1-dimensional version of the -.SM CCITT -Group 3 Huffman encoding algorithm. -.TP -.B \-6 -Force output to be encoded with the 2-dimensional version of the -.SM CCITT -Group 3 Huffman encoding algorithm (default). -.TP -.B \-a -Force the last bit of each -.I "End Of Line" -(\c -.SM EOL\c -) code to land on a byte boundary (default). This ``zero padding'' will -be reflected in the contents of the -.I Group3Options -tag of the resultant -.SM TIFF -file. This option has effect with Group 3 encoded output only. -.TP -.B \-p -Do not EOL-align output. This option has effect with Group 3 encoded -output only. -.TP -.B \-c -Generate "classic" Group 3 TIFF format. -.TP -.B \-f -Generate TIFF Class F (TIFF/F) format (default). -.TP -.B \-m -Force output data to have bits filled from most significant bit (\c -.SM MSB\c -) to most least bit (\c -.SM LSB\c -). -.TP -.B \-l -Force output data to have bits filled from least significant bit (\c -.SM LSB\c -) to most significant bit (\c -.SM MSB\c -) (default). -.TP -.B \-r -Specify the number of rows (scanlines) in each strip of data -written to the output file. -By default (or when value -.B 0 -is specified), -.I tiffcp -attempts to set the rows/strip -that no more than 8 kilobytes of data appear in a strip (with except of G3/G4 -compression schemes). If you specify special value -.B \-1 -it will results in infinite number of the rows per strip. The entire image -will be the one strip in that case. This is default in case of G3/G4 output -compression schemes. -.TP -.B \-s -Stretch the input image vertically by writing each input row of -data twice to the output file. -.TP -.B \-v -Force -.I fax2tiff -to print the number of rows of data it retrieved from the input file. -.TP -.B \-z -Force output to be compressed with the LZW encoding. -.SH DIAGNOSTICS -The following warnings and errors come from the decoding -routines in the library. -.PP -.BR "Warning, %s: Premature EOL at scanline %d (x %d).\en" . -The input data had a row that was shorter than the expected width. -The row is padded with white. -.PP -.BR "%s: Premature EOF at scanline %d (x %d).\en" . -The decoder ran out of data in the middle of a scanline. -The resultant row is padded with white. -.PP -.BR "%s: Bad code word at row %d, x %d\en" . -An invalid Group 3 -.I code -was encountered while decoding the input file. -The row number and horizontal position is given. -The remainder of the input row is discarded, while -the corresponding output row is padded with white. -.PP -.BR "%s: Bad 2D code word at scanline %d.\en" . -An invalid Group 4 or 2D Group 3 -.I code -was encountered while decoding the input file. -The row number and horizontal position is given. -The remainder of the input row is discarded, while -the corresponding output row is padded with white. -.SH BUGS -Input data are assumed to have a a ``top left'' orientation; -it should be possible to override this assumption -from the command line. -.SH "SEE ALSO" -.BR "\s-1CCITT\s+1 Recommendation T.4" -(Standardization of Group 3 Facsimile Apparatus for Document Transmission). -.PP -.BR "The Spirit of TIFF Class F", -an appendix to the TIFF 5.0 specification prepared by Cygnet Technologies. -.PP -.BR tiffinfo (1), -.BR tiffdither (1), -.BR tiffgt (1), -.BR libtiff (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/libtiff.3tiff b/man/libtiff.3tiff deleted file mode 100644 index 1f646789..00000000 --- a/man/libtiff.3tiff +++ /dev/null @@ -1,544 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH INTRO 3TIFF "November 2, 2005" "libtiff" -.SH NAME -libtiff \- introduction to -.IR libtiff , -a library for reading and writing -.SM TIFF -files -.SH SYNOPSIS -.B "#include <tiffio.h>" -.sp -cc file.c -.B -ltiff -.SH DESCRIPTION -.I libtiff -is a library for reading and writing data files encoded with the -.I "Tag Image File" -format, Revision 6.0 (or revision 5.0 or revision 4.0). This file format is -suitable for archiving multi-color and monochromatic image data. -.PP -The library supports several compression algorithms, as indicated by the -.I Compression -field, including: -no compression (1), -.SM CCITT -1D Huffman compression (2), -.SM CCITT -Group 3 Facsimile compression (3), -.SM CCITT -Group 4 Facsimile compression (4), -Lempel-Ziv & Welch compression (5), -baseline JPEG compression (7), -word-aligned 1D Huffman compression (32771), -and -PackBits compression (32773). -In addition, several nonstandard compression algorithms are supported: the -4-bit compression algorithm used by the -.I ThunderScan -program (32809) (decompression only), NeXT's 2-bit compression algorithm -(32766) (decompression only), an experimental LZ-style algorithm known as -Deflate (32946), and an experimental CIE LogLuv compression scheme designed -for images with high dynamic range (32845 for LogL and 32845 for LogLuv). -Directory information may be in either little- or big-endian byte order\-byte -swapping is automatically done by the library. Data bit ordering may be either -Most Significant Bit (\c -.SM MSB\c -) to Least Significant Bit (\c -.SM LSB\c -) or -.SM LSB -to -.SM MSB. -Finally, the library does not support files in which the -.IR BitsPerSample , -.IR Compression , -.IR MinSampleValue , -or -.IR MaxSampleValue -fields are defined differently on a per-sample basis -(in Rev. 6.0 the -.I Compression -tag is not defined on a per-sample basis, so this is immaterial). -.SH "DATA TYPES" -The library makes extensive use of C typedefs to promote portability. -Two sets of typedefs are used, one for communication with clients -of the library and one for internal data structures and parsing of the -.SM TIFF -format. -The following typedefs are exposed to users either through function -definitions or through parameters passed through the varargs interfaces. -.in +.5i -.sp 5p -.ta +\w'typedef unsigned <\fIthing\fP> uint32_t; 'u -.nf -typedef unsigned short uint16_t; 16-bit unsigned integer -typedef unsigned <\fIthing\fP> uint32_t; 32-bit unsigned integer -.sp 5p -typedef unsigned int ttag_t; directory tag -typedef uint16_t tdir_t; directory index -typedef uint16_t tsample_t; sample number -typedef uint32_t tstrip_t; strip number -typedef uint32_t ttile_t; tile number -typedef int32_t tsize_t; i/o size in bytes -typedef void* tdata_t; image data ref -typedef void* thandle_t; client data handle -typedef int32_t toff_t; file offset -.fi -.sp 5p -.in -.5i -Note that -.IR tstrip_t , -.IR ttile_t , -and -.I tsize_t -are constrained to be no more than 32-bit quantities by 32-bit fields they are -stored in in the -.SM TIFF -image. -Likewise -.I tsample_t -is limited by the 16-bit field used to store the -.I SamplesPerPixel -tag. -.I tdir_t -constrains the maximum number of -.SM IFDs -that may appear in an image and may be an arbitrary size (w/o penalty). -.I ttag_t -must be either int, unsigned int, pointer, or double because the library uses -a varargs interface and -.SM "ANSI C" -restricts the type of the parameter before an ellipsis to be a promoted type. -.I toff_t -is defined as int32_t because TIFF file offsets are (unsigned) 32-bit -quantities. A signed value is used because some interfaces return \-1 on -error. Finally, note that user-specified data references are passed as opaque -handles and only cast at the lowest layers where their type is presumed. -.SH "LIST OF ROUTINES" -The following routines are part of the library. Consult specific manual pages -for details on their operation; on most systems doing ``man function-name'' -will work. -.sp -.nf -.ta \w'TIFFCheckpointDirectory'u+2n -\fIName\fP \fIDescription\fP -.sp 5p -TIFFCheckpointDirectory writes the current state of the directory -TIFFCheckTile very x,y,z,sample is within image -TIFFCIELabToRGBInit initialize CIE L*a*b* 1976 to RGB conversion state -TIFFCIELabToXYZ perform CIE L*a*b* 1976 to CIE XYZ conversion -TIFFClientOpen open a file for reading or writing -TIFFClose close an open file -TIFFComputeStrip return strip containing y,sample -TIFFComputeTile return tile containing x,y,z,sample -TIFFCurrentDirectory return index of current directory -TIFFCurrentRow return index of current scanline -TIFFCurrentStrip return index of current strip -TIFFCurrentTile return index of current tile -TIFFDataWidth return the size of TIFF data types -TIFFError library error handler -TIFFFdOpen open a file for reading or writing -TIFFFieldDataType get data type from field information -TIFFFieldName get field name from field information -TIFFFieldPassCount get whether to pass a value count to Get/SetField -TIFFFieldReadCount get number of values to be read from field -TIFFFieldTag get tag value from field information -TIFFFieldWithName get field information given field name -TIFFFieldWithTag get field information given tag -TIFFFieldWriteCount get number of values to be written to field -TIFFFileName return name of open file -TIFFFileno return open file descriptor -TIFFFindCODEC find standard codec for the specific scheme -TIFFFindField get field information given tag and data type -TIFFFlush flush all pending writes -TIFFFlushData flush pending data writes -TIFFGetBitRevTable return bit reversal table -TIFFGetField return tag value in current directory -TIFFGetFieldDefaulted return tag value in current directory -TIFFGetMode return open file mode -TIFFGetVersion return library version string -TIFFIsCODECConfigured check, whether we have working codec -TIFFIsMSB2LSB return true if image data is being returned - with bit 0 as the most significant bit -TIFFIsTiled return true if image data is tiled -TIFFIsByteSwapped return true if image data is byte-swapped -TIFFNumberOfStrips return number of strips in an image -TIFFNumberOfTiles return number of tiles in an image -TIFFOpen open a file for reading or writing -TIFFPrintDirectory print description of the current directory -TIFFReadBufferSetup specify i/o buffer for reading -TIFFReadDirectory read the next directory -TIFFReadEncodedStrip read and decode a strip of data -TIFFReadEncodedTile read and decode a tile of data -TIFFReadRawStrip read a raw strip of data -TIFFReadRawTile read a raw tile of data -TIFFReadRGBAImage read an image into a fixed format raster -TIFFReadScanline read and decode a row of data -TIFFReadTile read and decode a tile of data -TIFFRegisterCODEC override standard codec for the specific scheme -TIFFReverseBits reverse bits in an array of bytes -TIFFRGBAImageBegin setup decoder state for TIFFRGBAImageGet -TIFFRGBAImageEnd release TIFFRGBAImage decoder state -TIFFRGBAImageGet read and decode an image -TIFFRGBAImageOK is image readable by TIFFRGBAImageGet -TIFFScanlineSize return size of a scanline -TIFFSetDirectory set the current directory -TIFFSetSubDirectory set the current directory -TIFFSetErrorHandler set error handler function -TIFFSetField set a tag's value in the current directory -TIFFSetWarningHandler set warning handler function -TIFFStripSize returns size of a strip -TIFFRawStripSize returns the number of bytes in a raw strip -TIFFSwabShort swap bytes of short -TIFFSwabLong swap bytes of long -TIFFSwabArrayOfShort swap bytes of an array of shorts -TIFFSwabArrayOfLong swap bytes of an array of longs -TIFFTileRowSize return size of a row in a tile -TIFFTileSize return size of a tile -TIFFUnRegisterCODEC unregisters the codec -TIFFVGetField return tag value in current directory -TIFFVGetFieldDefaulted return tag value in current directory -TIFFVSetField set a tag's value in the current directory -TIFFVStripSize returns the number of bytes in a strip -TIFFWarning library warning handler -TIFFWriteDirectory write the current directory -TIFFWriteEncodedStrip compress and write a strip of data -TIFFWriteEncodedTile compress and write a tile of data -TIFFWriteRawStrip write a raw strip of data -TIFFWriteRawTile write a raw tile of data -TIFFWriteScanline write a scanline of data -TIFFWriteTile compress and write a tile of data -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 -.SH "TAG USAGE" -The table below lists the -.SM TIFF -tags that are recognized and handled by the library. -If no use is indicated in the table, then the library -reads and writes the tag, but does not use it internally. -Note that some tags are meaningful only when a particular -compression scheme is being used; e.g. -.I Group3Options -is only useful if -.I Compression -is set to -.SM CCITT -Group 3 encoding. -Tags of this sort are considered -.I codec-specific -tags and the library does not recognize them except when the -.I Compression -tag has been previously set to the relevant compression scheme. -.sp -.nf -.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 -.sp 5p -.nf -Artist 315 R/W -BadFaxLines 326 R/W -BitsPerSample 258 R/W lots -CellLength 265 parsed but ignored -CellWidth 264 parsed but ignored -CleanFaxData 327 R/W -ColorMap 320 R/W -ColorResponseUnit 300 parsed but ignored -Compression 259 R/W choosing codec -ConsecutiveBadFaxLines 328 R/W -Copyright 33432 R/W -DataType 32996 R obsoleted by SampleFormat tag -DateTime 306 R/W -DocumentName 269 R/W -DotRange 336 R/W -ExtraSamples 338 R/W lots -FaxRecvParams 34908 R/W -FaxSubAddress 34909 R/W -FaxRecvTime 34910 R/W -FillOrder 266 R/W control bit order -FreeByteCounts 289 parsed but ignored -FreeOffsets 288 parsed but ignored -GrayResponseCurve 291 parsed but ignored -GrayResponseUnit 290 parsed but ignored -Group3Options 292 R/W used by Group 3 codec -Group4Options 293 R/W -HostComputer 316 R/W -ImageDepth 32997 R/W tile/strip calculations -ImageDescription 270 R/W -ImageLength 257 R/W lots -ImageWidth 256 R/W lots -InkNames 333 R/W -InkSet 332 R/W -JPEGTables 347 R/W used by JPEG codec -Make 271 R/W -Matteing 32995 R obsoleted by ExtraSamples tag -MaxSampleValue 281 R/W -MinSampleValue 280 R/W -Model 272 R/W -NewSubFileType 254 R/W called SubFileType in spec -NumberOfInks 334 R/W -Orientation 274 R/W -PageName 285 R/W -PageNumber 297 R/W -PhotometricInterpretation 262 R/W used by Group 3 and JPEG codecs -PlanarConfiguration 284 R/W data i/o -Predictor 317 R/W used by LZW and Deflate codecs -PrimaryChromacities 319 R/W -ReferenceBlackWhite 532 R/W -ResolutionUnit 296 R/W used by Group 3 codec -RowsPerStrip 278 R/W data i/o -SampleFormat 339 R/W -SamplesPerPixel 277 R/W lots -SMinSampleValue 340 R/W -SMaxSampleValue 341 R/W -Software 305 R/W -StoNits 37439 R/W -StripByteCounts 279 R/W data i/o -StripOffsets 273 R/W data i/o -SubFileType 255 R/W called OSubFileType in spec -TargetPrinter 337 R/W -Thresholding 263 R/W -TileByteCounts 324 R/W data i/o -TileDepth 32998 R/W tile/strip calculations -TileLength 323 R/W data i/o -TileOffsets 324 R/W data i/o -TileWidth 322 R/W data i/o -TransferFunction 301 R/W -WhitePoint 318 R/W -XPosition 286 R/W -XResolution 282 R/W -YCbCrCoefficients 529 R/W used by TIFFRGBAImage support -YCbCrPositioning 531 R/W tile/strip size calculations -YCbCrSubsampling 530 R/W -YPosition 286 R/W -YResolution 283 R/W used by Group 3 codec -.SH "PSEUDO TAGS" -In addition to the normal -.SM TIFF -tags the library supports a collection of -tags whose values lie in a range outside the valid range of -.SM TIFF -tags. -These tags are termed -.I pseudo-tags -and are used to control various codec-specific functions within the library. -The table below summarizes the defined pseudo-tags. -.sp -.nf -.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 -.sp 5p -.nf -TIFFTAG_FAXMODE G3 R/W general codec operation -TIFFTAG_FAXFILLFUNC G3/G4 R/W bitmap fill function -TIFFTAG_JPEGQUALITY JPEG R/W compression quality control -TIFFTAG_JPEGCOLORMODE JPEG R/W control colorspace conversions -TIFFTAG_JPEGTABLESMODE JPEG R/W control contents of \fIJPEGTables\fP tag -TIFFTAG_ZIPQUALITY Deflate R/W compression quality level -TIFFTAG_PIXARLOGDATAFMT PixarLog R/W user data format -TIFFTAG_PIXARLOGQUALITY PixarLog R/W compression quality level -TIFFTAG_SGILOGDATAFMT SGILog R/W user data format -.fi -.TP -.B TIFFTAG_FAXMODE -Control the operation of the Group 3 codec. -Possible values (independent bits that can be combined by -or'ing them together) are: -FAXMODE_CLASSIC -(enable old-style format in which the -.SM RTC -is written at the end of the last strip), -FAXMODE_NORTC -(opposite of -FAXMODE_CLASSIC; -also called -FAXMODE_CLASSF), -FAXMODE_NOEOL -(do not write -.SM EOL -codes at the start of each row of data), -FAXMODE_BYTEALIGN -(align each encoded row to an 8-bit boundary), -FAXMODE_WORDALIGN -(align each encoded row to an 16-bit boundary), -The default value is dependent on the compression scheme; this -pseudo-tag is used by the various G3 and G4 codecs to share code. -.TP -.B TIFFTAG_FAXFILLFUNC -Control the function used to convert arrays of black and white -runs to packed bit arrays. -This hook can be used to image decoded scanlines in multi-bit -depth rasters (e.g. for display in colormap mode) -or for other purposes. -The default value is a pointer to a builtin function that images -packed bilevel data. -.TP -.B TIFFTAG_IPTCNEWSPHOTO -Tag contains image metadata per the IPTC newsphoto spec: Headline, -captioning, credit, etc... Used by most wire services. -.TP -.B TIFFTAG_PHOTOSHOP -Tag contains Photoshop captioning information and metadata. Photoshop -uses in parallel and redundantly alongside IPTCNEWSPHOTO information. -.TP -.B TIFFTAG_JPEGQUALITY -Control the compression quality level used in the baseline algorithm. -Note that quality levels are in the range 0-100 with a default value of 75. -.TP -.B TIFFTAG_JPEGCOLORMODE -Control whether or not conversion is done between -RGB and YCbCr colorspaces. -Possible values are: -JPEGCOLORMODE_RAW -(do not convert), and -JPEGCOLORMODE_RGB -(convert to/from RGB) -The default value is JPEGCOLORMODE_RAW. -.TP -.B TIFFTAG_JPEGTABLESMODE -Control the information written in the -.I JPEGTables -tag. -Possible values (independent bits that can be combined by -or'ing them together) are: -JPEGTABLESMODE_QUANT -(include quantization tables), -and -JPEGTABLESMODE_HUFF -(include Huffman encoding tables). -The default value is JPEGTABLESMODE_QUANT|JPEGTABLESMODE_HUFF. -.TP -.B TIFFTAG_ZIPQUALITY -Control the compression technique used by the Deflate codec. -Quality levels are in the range 1-9 with larger numbers yielding better -compression at the cost of more computation. -The default quality level is 6 which yields a good time-space tradeoff. -.TP -.B TIFFTAG_PIXARLOGDATAFMT -Control the format of user data passed -.I in -to the PixarLog codec when encoding and passed -.I out -from when decoding. -Possible values are: -PIXARLOGDATAFMT_8BIT -for 8-bit unsigned pixels, -PIXARLOGDATAFMT_8BITABGR -for 8-bit unsigned ABGR-ordered pixels, -PIXARLOGDATAFMT_11BITLOG -for 11-bit log-encoded raw data, -PIXARLOGDATAFMT_12BITPICIO -for 12-bit PICIO-compatible data, -PIXARLOGDATAFMT_16BIT -for 16-bit signed samples, -and -PIXARLOGDATAFMT_FLOAT -for 32-bit IEEE floating point samples. -.TP -.B TIFFTAG_PIXARLOGQUALITY -Control the compression technique used by the PixarLog codec. -This value is treated identically to TIFFTAG_ZIPQUALITY; see the -above description. -.TP -.B TIFFTAG_SGILOGDATAFMT -Control the format of client data passed -.I in -to the SGILog codec when encoding and passed -.I out -from when decoding. -Possible values are: -SGILOGDATAFMT_FLTXYZ -for converting between LogLuv and 32-bit IEEE floating valued XYZ pixels, -SGILOGDATAFMT_16BITLUV -for 16-bit encoded Luv pixels, -SGILOGDATAFMT_32BITRAW and SGILOGDATAFMT_24BITRAW -for no conversion of data, -SGILOGDATAFMT_8BITRGB -for returning 8-bit RGB data (valid only when decoding LogLuv-encoded data), -SGILOGDATAFMT_FLTY -for converting between LogL and 32-bit IEEE floating valued Y pixels, -SGILOGDATAFMT_16BITL -for 16-bit encoded L pixels, -and -SGILOGDATAFMT_8BITGRY -for returning 8-bit greyscale data -(valid only when decoding LogL-encoded data). -.SH DIAGNOSTICS -All error messages are directed through the -.IR TIFFError -routine. -By default messages are directed to -.B stderr -in the form: -.IR "module: message\en." -Warning messages are likewise directed through the -.IR TIFFWarning -routine. -.SH "SEE ALSO" -.BR fax2tiff (1), -.BR gif2tiff (1), -.BR pal2rgb (1), -.BR ppm2tiff (1), -.BR rgb2ycbcr (1), -.BR ras2tiff (1), -.BR raw2tiff (1), -.BR sgi2tiff (1), -.BR tiff2bw (1), -.BR tiffdither (1), -.BR tiffdump (1), -.BR tiffcp (1), -.BR tiffcmp (1), -.BR tiffgt (1), -.BR tiffinfo (1), -.BR tiffmedian (1), -.BR tiffsplit (1), -.BR tiffsv (1). -.PP -.BR "Tag Image File Format Specification \(em Revision 6.0" , -an Aldus Technical Memorandum. -.PP -.BR "The Spirit of TIFF Class F" , -an appendix to the TIFF 5.0 specification prepared by Cygnet Technologies. -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ -.SH BUGS -The library does not support multi-sample images -where some samples have different bits/sample. -.PP -The library does not support random access to compressed data -that is organized with more than one row per tile or strip. diff --git a/man/pal2rgb.1 b/man/pal2rgb.1 deleted file mode 100644 index 772b4a7b..00000000 --- a/man/pal2rgb.1 +++ /dev/null @@ -1,110 +0,0 @@ -.\" -.\" Copyright (c) 1990-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH PAL2RGB 1 "September 20, 2005" "libtiff" -.SH NAME -pal2rgb \- convert a palette color -.SM TIFF -image to a full color image -.SH SYNOPSIS -.B pal2rgb -[ -.I options -] -.I input.tif -.I output.tif -.SH DESCRIPTION -.I Pal2rgb -converts a palette color -.SM TIFF -image to a full color image by -applying the colormap of the palette image to each sample -to generate a full color -.SM RGB -image. -.SH OPTIONS -Options that affect the interpretation of input data are: -.TP -.B \-C -This option overrides the default behavior of -.I pal2rgb -in determining whether or not -colormap entries contain 16-bit or 8-bit values. -By default the colormap is inspected and -if no colormap entry greater than 255 is found, -the colormap is assumed to have only 8-bit values; otherwise -16-bit values (as required by the -.SM TIFF -specification) are assumed. -The -.B \-C -option can be used to explicitly specify the number of -bits for colormap entries: -.B "\-C 8" -for 8-bit values, -.B "\-C 16" -for 16-bit values. -.PP -Options that affect the output file format are: -.TP -.B \-p -Explicitly select the planar configuration used in organizing -data samples in the output image: -.B "\-p contig" -for samples packed contiguously, and -.B "\-p separate" -for samples stored separately. -By default samples are packed. -.TP -.B \-c -Use the specific compression algorithm to encoded image data -in the output file: -.B "\-c packbits" -for Macintosh Packbits, -.B "\-c lzw" -for Lempel-Ziv & Welch, -.B "\-c zip" -for Deflate, -.B "\-c none" -for no compression. -If no compression-related option is specified, the input -file's compression algorithm is used. -.TP -.B \-r -Explicitly specify the number of rows in each strip of the -output file. -If the -.B \-r -option is not specified, a number is selected such that each -output strip has approximately 8 kilobytes of data in it. -.SH BUGS -Only 8-bit images are handled. -.SH "SEE ALSO" -.BR tiffinfo (1), -.BR tiffcp (1), -.BR tiffmedian (1), -.BR libtiff (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/ppm2tiff.1 b/man/ppm2tiff.1 deleted file mode 100644 index 12e58e2c..00000000 --- a/man/ppm2tiff.1 +++ /dev/null @@ -1,104 +0,0 @@ -.\" -.\" Copyright (c) 1991-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH PPM2TIFF 1 "March 1, 2006" "libtiff" -.SH NAME -ppm2tiff \- create a -.SM TIFF -file from -.SM PPM, PGM -and -.SM PBM -image files -.SH SYNOPSIS -.B ppm2tiff -[ -.I options -] [ -.I input.ppm -] -.I output.tif -.SH DESCRIPTION -.I ppm2tiff -converts a file in the -.SM PPM, PGM -and -.SM PBM -image formats to -.SM TIFF. -By default, the -.SM TIFF -image is created with data samples packed (\c -.IR PlanarConfiguration =1), -compressed with the Packbits algorithm (\c -.IR Compression =32773), -and with each strip no more than 8 kilobytes. These characteristics can be -overridden, or explicitly specified with the options described below -.PP -If the -.SM PPM -file contains greyscale data, then the -.I PhotometricInterpretation -tag is set to 1 (min-is-black), otherwise it is set to 2 (RGB). -.PP -If no -.SM PPM -file is specified on the command line, -.I ppm2tiff -will read from the standard input. -.SH OPTIONS -.TP -.B \-c -Specify a compression scheme to use when writing image data: -.B none -for no compression, -.B packbits -for PackBits compression (will be used by default), -.B lzw -for Lempel-Ziv & Welch compression, -.B jpeg -for baseline JPEG compression, -.B zip -for Deflate compression, -.B g3 -for CCITT Group 3 (T.4) compression, -and -.B g4 -for CCITT Group 4 (T.6) compression. -.TP -.B \-r -Write data with a specified number of rows per strip; by default the number of -rows/strip is selected so that each strip is approximately 8 kilobytes. -.TP -.B \-R -Mark the resultant image to have the specified X and Y resolution (in -dots/inch). -.SH "SEE ALSO" -.BR tiffinfo (1), -.BR tiffcp (1), -.BR tiffmedian (1), -.BR libtiff (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/raw2tiff.1 b/man/raw2tiff.1 deleted file mode 100644 index f45569d4..00000000 --- a/man/raw2tiff.1 +++ /dev/null @@ -1,195 +0,0 @@ -.\" -.\" Copyright (c) 1990-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH RAW2TIFF 1 "November 2, 2005" "libtiff" -.SH NAME -raw2tiff \- create a -.SM TIFF -file from a raw data -.SH SYNOPSIS -.B raw2tiff -[ -.I options -] -.I input.raw -.I output.tif -.SH DESCRIPTION -.I raw2tiff -converts a raw byte sequence into -.SM TIFF. -By default, the -.SM TIFF -image is created with data samples packed (\c -.IR PlanarConfiguration =1), -compressed with the PackBits algorithm (\c -.IR Compression =32773), -and with each strip no more than 8 kilobytes. -These characteristics can overridden, or explicitly specified -with the options described below. -.SH OPTIONS -.TP -.BI \-H " number" -size of input image file header in bytes (0 by default). This amount of data -just will be skipped from the start of file while reading. -.TP -.BI \-w " number" -width of input image in pixels (can be guessed, see -.SM -.B "GUESSING THE IMAGE GEOMETRY" -below). -.TP -.BI \-l " number" -length of input image in lines (can be guessed, see -.SM -.B "GUESSING THE IMAGE GEOMETRY" -below). -.TP -.BI \-b " number" -number of bands in input image (1 by default). -.TP -.BI \-d " data_type" -type of samples in input image, where -.I data_type -may be: -.ta \w'\fBdouble \fR'u -.br -.B byte\t -8-bit unsigned integer (default), -.br -.B short\t -16-bit unsigned integer, -.br -.B long\t -32-bit unsigned integer, -.br -.B sbyte\t -8-bit signed integer, -.br -.B sshort\t -16-bit signed integer, -.br -.B slong\t -32-bit signed integer, -.br -.B float\t -32-bit IEEE floating point, -.br -.B double\t -64-bit IEEE floating point. -.TP -.BI \-i " config" -type of samples interleaving in input image, where -.I config -may be: -.ta \w'\fBpixel \fR'u -.br -.B pixel\t -pixel interleaved data (default), -.br -.B band\t -band interleaved data. -.TP -.BI \-p " photo" -photometric interpretation (color space) of the input image, where -.I photo -may be: -.ta \w'\fBminiswhite \fR'u -.br -.B miniswhite\t -white color represented with 0 value, -.br -.B minisblack\t -black color represented with 0 value (default), -.br -.B rgb\t -image has RGB color model, -.br -.B cmyk\t -image has CMYK (separated) color model, -.br -.B ycbcr\t -image has YCbCr color model, -.br -.B cielab\t -image has CIE L*a*b color model, -.br -.B icclab\t -image has ICC L*a*b color model, -.br -.B itulab\t -image has ITU L*a*b color model. -.TP -.B \-s -swap bytes fetched from the input file. -.TP -.B \-L -input data has LSB2MSB bit order (default). -.TP -.B \-M -input data has MSB2LSB bit order. -.TP -.B \-c -Specify a compression scheme to use when writing image data: -.B "\-c none" -for no compression, -.B "\-c packbits" -for the PackBits compression algorithm (the default), -.B "\-c jpeg" -for the baseline JPEG compression algorithm, -.B "\-c zip" -for the Deflate compression algorithm, -and -.B "\-c lzw" -for Lempel-Ziv & Welch. -.TP -.BI \-r " number" -Write data with a specified number of rows per strip; -by default the number of rows/strip is selected so that each strip -is approximately 8 kilobytes. -.SH GUESSING THE IMAGE GEOMETRY -.I raw2tiff -can guess image width and height in case one or both of these parameters are -not specified. If you omit one of those parameters, the complementary one will -be calculated based on the file size (taking into account header size, number -of bands and data type). If you omit both parameters, the statistical approach -will be used. Utility will compute correlation coefficient between two lines -at the image center using several appropriate line sizes and the highest -absolute value of the coefficient will indicate the right line size. That is -why you should be cautious with the very large images, because guessing -process may take a while (depending on your system performance). Of course, the -utility can't guess the header size, number of bands and data type, so it -should be specified manually. If you don't know anything about your image, -just try with the several combinations of those options. -.P -There is no magic, it is just a mathematical statistics, so it can be wrong -in some cases. But for most ordinary images guessing method will work fine. -.SH "SEE ALSO" -.BR pal2rgb (1), -.BR tiffinfo (1), -.BR tiffcp (1), -.BR tiffmedian (1), -.BR libtiff (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/rgb2ycbcr.1 b/man/rgb2ycbcr.1 deleted file mode 100644 index 908b49ae..00000000 --- a/man/rgb2ycbcr.1 +++ /dev/null @@ -1,98 +0,0 @@ -.\" -.\" Copyright (c) 1991-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH RGB2YCBCR 1 "November 2, 2005" "libtiff" -.SH NAME -rgb2ycbcr \- convert non-YCbCr -.SM TIFF -images to a YCbCr -.SM TIFF -image -.SH SYNOPSIS -.B rgb2ycbcr -[ -.I options -] -.I "src1.tif src2.tif ... dst.tif" -.SH DESCRIPTION -.I rgb2ycbcr -converts -.SM RGB -color, greyscale, or bi-level -.SM TIFF -images to YCbCr images by transforming and sampling pixel data. If multiple -files are specified on the command line each source file is converted to a -separate directory in the destination file. -.PP -By default, chrominance samples are created by sampling -2 by 2 blocks of luminance values; this can be changed with the -.B \-h -and -.B \-v -options. -Output data are compressed with the -.SM PackBits -compression scheme, by default; an alternate scheme can be selected with the -.B \-c -option. -By default, output data are compressed in strips with -the number of rows in each strip selected so that the -size of a strip is never more than 8 kilobytes; -the -.B \-r -option can be used to explicitly set the number of -rows per strip. -.SH OPTIONS -.TP -.B \-c -Specify a compression scheme to use when writing image data: -.B "\-c none" -for no compression, -.B "\-c packbits" -for the PackBits compression algorithm (the default), -.B "\-c jpeg" -for the JPEG compression algorithm, -.B "\-c zip" -for the deflate compression algorithm, -and -.B "\-c lzw" -for Lempel-Ziv & Welch. -.TP -.B \-h -Set the horizontal sampling dimension to one of: 1, 2 (default), or 4. -.TP -.B \-r -Write data with a specified number of rows per strip; -by default the number of rows/strip is selected so that each strip -is approximately 8 kilobytes. -.TP -.B \-v -Set the vertical sampling dimension to one of: 1, 2 (default), or 4. -.SH "SEE ALSO" -.BR tiffinfo (1), -.BR tiffcp (1), -.BR libtiff (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff diff --git a/man/thumbnail.1 b/man/thumbnail.1 deleted file mode 100644 index f5563ea3..00000000 --- a/man/thumbnail.1 +++ /dev/null @@ -1,89 +0,0 @@ -.\" -.\" Copyright (c) 1994-1997 Sam Leffler -.\" Copyright (c) 1994-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH THUMBNAIL 1 "November 2, 2005" "libtiff" -.SH NAME -thumbnail \- create a -.SM TIFF -file with thumbnail images -.SH SYNOPSIS -.B thumbnail -[ -.I options -] -.I input.tif -.I output.tif -.SH DESCRIPTION -.I thumbnail -is a program written to show how one might use the -SubIFD tag (#330) to store thumbnail images. -.I thumbnail -copies a -.SM TIFF -Class F facsimile file to the output file -and for each image an 8-bit greyscale -.IR "thumbnail sketch" . -The output file contains the thumbnail image with the associated -full-resolution page linked below with the SubIFD tag. -.PP -By default, thumbnail images are 216 pixels wide by 274 pixels high. -Pixels are calculated by sampling and filtering the input image -with each pixel value passed through a contrast curve. -.SH OPTIONS -.TP -.B \-w -Specify the width of thumbnail images in pixels. -.TP -.B \-h -Specify the height of thumbnail images in pixels. -.TP -.B \-c -Specify a contrast curve to apply in generating the thumbnail images. -By default pixels values are passed through a linear contrast curve -that simply maps the pixel value ranges. -Alternative curves are: -.B exp50 -for a 50% exponential curve, -.B exp60 -for a 60% exponential curve, -.B exp70 -for a 70% exponential curve, -.B exp80 -for a 80% exponential curve, -.B exp90 -for a 90% exponential curve, -.B exp -for a pure exponential curve, -.B linear -for a linear curve. -.SH BUGS -There are no options to control the format of the saved thumbnail images. -.SH "SEE ALSO" -.BR tiffdump (1), -.BR tiffgt (1), -.BR tiffinfo (1), -.BR libtiff (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiff2bw.1 b/man/tiff2bw.1 deleted file mode 100644 index 4fe9942f..00000000 --- a/man/tiff2bw.1 +++ /dev/null @@ -1,93 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFF2BW 1 "November 2, 2005" "libtiff" -.SH NAME -tiff2bw \- convert a color -.SM TIFF -image to greyscale -.SH SYNOPSIS -.B tiff2bw -[ -.I options -] -.I input.tif -.I output.tif -.SH DESCRIPTION -.I Tiff2bw -converts an -.SM RGB -or Palette color -.SM TIFF -image to a greyscale image by -combining percentages of the red, green, and blue channels. -By default, output samples are created by taking -28% of the red channel, 59% of the green channel, and 11% of -the blue channel. -To alter these percentages, the -.BR \-R , -.BR \-G , -and -.BR \-B -options may be used. -.SH OPTIONS -.TP -.B \-c -Specify a compression scheme to use when writing image data: -.B "\-c none" -for no compression, -.B "\-c packbits" -for the PackBits compression algorithm, -.B "\-c zip -for the Deflate compression algorithm, -.B "\-c g3 -for the CCITT Group 3 compression algorithm, -.B "\-c g4 -for the CCITT Group 4 compression algorithm, -and -.B "\-c lzw" -for Lempel-Ziv & Welch (the default). -.TP -.B \-r -Write data with a specified number of rows per strip; -by default the number of rows/strip is selected so that each strip -is approximately 8 kilobytes. -.TP -.B \-R -Specify the percentage of the red channel to use (default 28). -.TP -.B \-G -Specify the percentage of the green channel to use (default 59). -.TP -.B \-B -Specify the percentage of the blue channel to use (default 11). -.SH "SEE ALSO" -.BR pal2rgb (1), -.BR tiffinfo (1), -.BR tiffcp (1), -.BR tiffmedian (1), -.BR libtiff (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiff2pdf.1 b/man/tiff2pdf.1 deleted file mode 100644 index 6b3b4abf..00000000 --- a/man/tiff2pdf.1 +++ /dev/null @@ -1,256 +0,0 @@ -.\" -.\" Copyright (c) 2003 Ross Finlayson -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the name of -.\" Ross Finlayson may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Ross Finlayson. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL ROSS FINLAYSON BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.\" Process this file with -.\" groff -man -Tascii tiff2pdf.1 -.\" -.TH TIFF2PDF 1 "April 20, 2006" "libtiff" -.SH NAME -tiff2pdf \- convert a TIFF image to a PDF document -.SH SYNOPSIS -.B tiff2pdf -[ -.I options -] -.I input.tiff -.SH DESCRIPTION -.I tiff2pdf -opens a TIFF image and writes a PDF document to standard output. -.PP -The program converts one TIFF file to one PDF file, including multiple page -TIFF files, tiled TIFF files, black and white. grayscale, and color TIFF -files that contain data of TIFF photometric interpretations of bilevel, -grayscale, RGB, YCbCr, CMYK separation, and ICC L*a*b* as supported by -.I libtiff -and PDF. -.PP -If you have multiple TIFF files to convert into one PDF file then use -.I tiffcp -or other program to concatenate the files into a multiple page TIFF file. -If the input TIFF file is of huge dimensions (greater than 10000 pixels height -or width) convert the input image to a tiled TIFF if it is not already. -.PP -The standard output is standard output. Set the output file name with the -.BI \-o " output.pdf" -option. -.PP -All black and white files are compressed into a single strip CCITT G4 Fax -compressed PDF, unless tiled, where tiled black and white images are -compressed into tiled CCITT G4 Fax compressed PDF, -.I libtiff -CCITT support is assumed. -.PP -Color and grayscale data can be compressed using either JPEG compression, -ITU-T T.81, or Zip/Deflate LZ77 compression. Set the compression type using -the -.B \-j -or -.B \-z -options. JPEG compression support -requires that -.I libtiff -be configured with JPEG support, and Zip/Deflate compression support requires -that -.I libtiff -be configured with Zip support, in tiffconf.h. Use only one or the other of -.B \-j -and -.B \-z. -.PP -If the input TIFF contains single strip CCITT G4 Fax compressed information, -then that is written to the PDF file without transcoding, unless the options -of no compression and no passthrough are set, -.B \-d -and -.B \-n. -.PP -If the input TIFF contains JPEG or single strip Zip/Deflate compressed -information, and they are configured, then that is written to the PDF file -without transcoding, unless the options of no compression and no passthrough -are set. -.PP -The default page size upon which the TIFF image is placed is determined by -the resolution and extent of the image data. Default values for the TIFF -image resolution can be set using the -.B \-x -and -.B \-y -options. The page size can be set using the -.B \-p -option for paper size, or -.B \-w -and -.B \-l -for paper width and length, then each page of the TIFF image is centered on -its page. The distance unit for default resolution and page width and -length can be set by the -.B \-u -option, the default unit is inch. -.PP -Various items of the output document information can be set with the -.BR \-e , -.BR \-c , -.BR \-a , -.BR \-t , -.BR \-s , -and -.B \-k -options. Setting the argument of the option to "" for these -tags causes the relevant document information field to be not written. Some -of the document information values otherwise get their information from the -input TIFF image, the software, author, document name, and image description. -.PP -The Portable Document Format (PDF) specification is copyrighted by Adobe -Systems, Incorporated. -.SH OPTIONS -.TP -.BI \-o " output-file" -Set the output to go to file. -.I output-file -.TP -.B \-j -Compress with JPEG (requires -.I libjpeg -configured with -.IR libtiff ). -.TP -.B \-z -Compress with Zip/Deflate (requires -.I zlib -configured with -.IR libtiff ). -.TP -.BI \-q " quality" -Set the compression quality, 1-100 for JPEG. -.TP -.B \-n -Do not allow data to be converted without uncompressing, no compressed -data passthrough. -.TP -.BI \-b -Set PDF ``Interpolate'' user preference. -.TP -.B \-d -Do not compress (decompress). -.TP -.B \-i -Invert colors. -.TP -.BI \-p " paper-size" -Set paper size, e.g., -.BR letter , -.BR legal , -.BR A4 . -.TP -.B \-F -Cause the tiff to fill the PDF page. -.TP -.BR \-u " [" i | m ] -Set distance unit, -.B i -for inch, -.B m -for centimeter. -.TP -.BI \-w " width" -Set width in units. -.TP -.BI \-l " length" -Set length in units. -.TP -.BI \-x " xres" -Set x/width resolution default. -.TP -.BI \-y " yres" -Set y/length resolution default. -.TP -.BR \-r " [" d | o ] -Set -.B d -for resolution default for images without resolution, -.B o -for resolution override for all images. -.TP -.BI \-f -Set PDF ``Fit Window'' user preference. -.TP -.BI \-e " YYYYMMDDHHMMSS" -Set document information date, overrides image or current date/time default, -.I YYYYMMDDHHMMSS. -.TP -.BI \-c " creator" -Set document information creator, overrides image software default. -.TP -.BI \-a " author" -Set document information author, overrides image artist default. -.TP -.BI \-t " title" -Set document information title, overrides image document name default. -.TP -.BI \-s " subject" -Set document information subject, overrides image image description default. -.TP -.BI \-k " keywords" -Set document information keywords. -.TP -.BI \-m " size" -Set memory allocation limit (in MiB). Default is 256MiB. Set to 0 to disable the limit. -.TP -.B \-h -List usage reminder to stderr and exit. -.SH EXAMPLES -.TP -The following example would generate the file output.pdf from input.tiff. -.RS -.nf -tiff2pdf \-o output.pdf input.tiff -.fi -.RE -.PP -The following example would generate PDF output from input.tiff and write it -to standard output. -.RS -.nf -tiff2pdf input.tiff -.fi -.RE -.PP -The following example would generate the file output.pdf from input.tiff, -putting the image pages on a letter sized page, compressing the output -with JPEG, with JPEG quality 75, setting the title to ``Document'', and setting -the ``Fit Window'' option. -.RS -.nf -tiff2pdf \-p letter \-j \-q 75 \-t "Document" \-f \-o output.pdf input.tiff -.fi -.RE -.SH BUGS -Please report bugs via the web interface at -.IP -\%http://bugzilla.remotesensing.org/enter_bug.cgi?product=libtiff -.SH "SEE ALSO" -.BR libtiff (3), -.BR tiffcp (1), -.BR tiff2ps (1) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiff2ps.1 b/man/tiff2ps.1 deleted file mode 100644 index ce323eee..00000000 --- a/man/tiff2ps.1 +++ /dev/null @@ -1,297 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.ds Ps PostScript -.if n .po 0 -.TH TIFF2PS 1 "November 2, 2005" "libtiff" -.SH NAME -tiff2ps \- convert a -.SM TIFF -image to \*(Ps\*(Tm -.SH SYNOPSIS -.B tiff2ps -[ -.I options -] -.I "input.tif ..." -.SH DESCRIPTION -.I tiff2ps -reads -.SM TIFF -images and writes \*(Ps or Encapsulated \*(Ps (EPS) -on the standard output. -By default, -.I tiff2ps -writes Encapsulated \*(Ps for the first image in the specified -.SM TIFF -image file. -.PP -By default, -.I tiff2ps -will generate \*(Ps that fills a printed area specified -by the -.SM TIFF -tags in the input file. -If the file does not contain -.I XResolution -or -.I YResolution -tags, then the printed area is set according to the image dimensions. -The -.B \-w -and -.B \-h -options (see below) -can be used to set the dimensions of the printed area in inches; -overriding any relevant -.SM TIFF -tags. -.PP -The \*(Ps generated for -.SM RGB, -palette, and -.SM CMYK -images uses the -.I colorimage -operator. -The \*(Ps generated for -greyscale and bilevel images -uses the -.I image -operator. -When the -.I colorimage -operator is used, \*(Ps code to emulate this operator -on older \*(Ps printers is also generated. -Note that this emulation code can be very slow. -.PP -Color images with associated alpha data are composited over -a white background. -.SH OPTIONS -.TP -.B \-1 -Generate \*(Ps Level 1 (the default). -.TP -.B \-2 -Generate \*(Ps Level 2. -.TP -.B \-3 -Generate \*(Ps Level 3. It basically allows one to use the /flateDecode -filter for ZIP compressed TIFF images. -.TP -.B \-8 -Disable use of ASCII85 encoding with \*(Ps Level 2/3. -.TP -.B \-a -Generate output for all IFDs (pages) in the input file. -.TP -.B \-b -Specify the bottom margin for the output (in inches). This does not affect -the height of the printed image. -.TP -.B \-c -Center the image in the output. This option only shows an effect if both -the -.B \-w -and the -.B \-h -option are given. -.TP -.B \-C -Specify the document creator name. -.TP -.B \-d -Set the initial -.SM TIFF -directory to the specified directory number. -(NB: Directories are numbered starting at zero.) -This option is useful for selecting individual pages in a -multi-page (e.g. facsimile) file. -.TP -.B \-D -Enable duplex printing (two pages per sheet of paper). -.TP -.B \-e -Force the generation of Encapsulated \*(Ps (implies -.BR \-z ). -.TP -.B \-h -Specify the vertical size of the printed area (in inches). -.TP -.B \-H -Specify the maximum height of image (in inches). Images with larger sizes will -be split in several pages. Option -.B \-L -may be used for specifying size of split images overlapping. -.B \-i -Enable/disable pixel interpolation. This option requires a -single numeric value: zero to disable pixel interpolation and -non-zero to enable. The default is enabled. -.TP -.B \-L -Specify the size of overlapping for split images (in inches). Used in -conjunction with -.B \-H -and -.B \-W -options. -.TP -.B \-l -Specify the left margin for the output (in inches). This does not affect -the width of the printed image. -.TP -.BI \-M " size" -Set maximum memory allocation size (in MiB). The default is 256MiB. -Set to 0 to disable the limit. -.TP -.B \-m -Where possible render using the -.I imagemask -\*(Ps operator instead of the -.I image -operator. When this option is specified -.I tiff2ps -will use -.I imagemask -for rendering 1 bit deep images. If this option is not specified -or if the image depth is greater than 1 then the -.I image -operator is used. -.TP -.B \-o -Set the initial -.SM TIFF -directory to the -.SM IFD -at the specified file offset. -This option is useful for selecting thumbnail images and the -like which are hidden using the -.I SubIFD -tag. -.TP -.B \-O -Write \*(Ps to specified file instead of standard output. -.TP -.B \-p -Force the generation of (non-Encapsulated) \*(Ps. -.TP -.B \-P L|P -Set optional PageOrientation DSC comment to Landscape or Portrait. -.TP -.B \-r 90|180|270|auto -Rotate image by 90, 180, 270 degrees or auto. Auto picks the best -fit for the image on the specified paper size (eg portrait -or landscape) if -h or -w is specified. Rotation is in degrees -counterclockwise. Auto rotates 90 degrees ccw to produce landscape. -.TP -.B \-s -Generate output for a single IFD (page) in the input file. -.TP -.B \-t -Specify the document title string. -.TP -.B \-T -Print pages for top edge binding. -.TP -.B \-w -Specify the horizontal size of the printed area (in inches). -.TP -.B \-W -Specify the maximum width of image (in inches). Images with larger sizes will -be split in several pages. Options -.B \-L -and -.B \-W -are mutually exclusive. -.TP -.B \-x -Override resolution units specified in the TIFF as centimeters. -.TP -.B \-y -Override resolution units specified in the TIFF as inches. -.TP -.B \-z -When generating \*(Ps Level 2, data is scaled so that it does not -image into the -.I deadzone -on a page (the outer margin that the printing device is unable to mark). -This option suppresses this behavior. -When \*(Ps Level 1 is generated, data is imaged to the entire printed -page and this option has no affect. -.SH EXAMPLES -The following generates \*(Ps Level 2 for all pages of a facsimile: -.RS -.nf -tiff2ps \-a2 fax.tif | lpr -.fi -.RE -Note also that if you have version 2.6.1 or newer of Ghostscript then you -can efficiently preview facsimile generated with the above command. -.PP -To generate Encapsulated \*(Ps for a the image at directory 2 -of an image use: -.RS -.nf -tiff2ps \-d 1 foo.tif -.fi -.RE -(Notice that directories are numbered starting at zero.) -.PP -If you have a long image, it may be split in several pages: -.RS -.nf -tiff2ps \-h11 \-w8.5 \-H14 \-L.5 foo.tif > foo.ps -.fi -.RE -The page size is set to 8.5x11 by -.B \-w -and -.B \-h -options. We will accept a small amount of vertical compression, so -.B \-H -set to 14. Any pages between 11 and 14 inches will be fit onto one page. -Pages longer than 14 inches are cut off at 11 and continued on the next -page. The -.B \-L.5 -option says to repeat a half inch on the next page (to improve readability). -.SH BUGS -Because \*(Ps does not support the notion of a colormap, -8-bit palette images produce 24-bit \*(Ps images. -This conversion results in output that is six times -bigger than the original image and which takes a long time -to send to a printer over a serial line. -Matters are even worse for 4-, 2-, and 1-bit palette images. -.PP -Does not handle tiled images when generating \*(Ps Level I output. -.SH "SEE ALSO" -.BR pal2rgb (1), -.BR tiffinfo (1), -.BR tiffcp (1), -.BR tiffgt (1), -.BR tiffmedian (1), -.BR tiff2bw (1), -.BR tiffsv (1), -.BR libtiff (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiff2rgba.1 b/man/tiff2rgba.1 deleted file mode 100644 index fe9ebb2c..00000000 --- a/man/tiff2rgba.1 +++ /dev/null @@ -1,100 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFF2RGBA 1 "November 2, 2005" "libtiff" -.SH NAME -tiff2rgba \- convert a -.SM TIFF -image to RGBA color space -.SH SYNOPSIS -.B tiff2rgba -[ -.I options -] -.I input.tif -.I output.tif -.SH DESCRIPTION -.I Tiff2rgba -converts a wide variety of TIFF images into an RGBA TIFF image. This -includes the ability to translate different color spaces and photometric -interpretation into RGBA, support for alpha blending, and translation -of many different bit depths into a 32bit RGBA image. -.P -Internally this program is implemented using the -.I TIFFReadRGBAImage() -function, and it suffers any limitations of that image. This includes -limited support for > 8 BitsPerSample images, and flaws with some -esoteric combinations of BitsPerSample, photometric interpretation, -block organization and planar configuration. -.P -The generated images are stripped images with four samples per pixel -(red, green, blue and alpha) or if the -.B \-n -flag is used, three samples -per pixel (red, green, and blue). The resulting images are always planar -configuration contiguous. For this reason, this program is a useful utility -for transform exotic TIFF files into a form ingestible by almost any TIFF -supporting software. -.SH OPTIONS -.TP -.B \-c -Specify a compression scheme to use when writing image data: -.B "\-c none" -for no compression (the default), -.B "\-c packbits" -for the PackBits compression algorithm, -.B "\-c zip" -for the Deflate compression algorithm, -.B "\-c jpeg" -for the JPEG compression algorithm, -and -.B "\-c lzw" -for Lempel-Ziv & Welch. -.TP -.B \-r -Write data with a specified number of rows per strip; -by default the number of rows/strip is selected so that each strip -is approximately 8 kilobytes. -.TP -.B \-b -Process the image one block (strip/tile) at a time instead of by reading -the whole image into memory at once. This may be necessary for very large -images on systems with limited RAM. -.TP -.B \-n -Drop the alpha component from the output file, producing a pure RGB file. -Currently this does not work if the -.B \-b -flag is also in effect. -.TP -.BI \-M " size" -Set maximum memory allocation size (in MiB). The default is 256MiB. -Set to 0 to disable the limit. -.SH "SEE ALSO" -.BR tiff2bw (1), -.BR TIFFReadRGBAImage (3t), -.BR libtiff (3) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiffcmp.1 b/man/tiffcmp.1 deleted file mode 100644 index ee83a742..00000000 --- a/man/tiffcmp.1 +++ /dev/null @@ -1,86 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFCMP 1 "November 2, 2005" "libtiff" -.SH NAME -tiffcmp \- compare two -.SM TIFF -files -.SH SYNOPSIS -.B tiffcmp -[ -.I options -] -.I "file1.tif file2.tif" -.SH DESCRIPTION -.I Tiffcmp -compares the tags and data in two files created according -to the Tagged Image File Format, Revision 6.0. -The schemes used for compressing data in each file -are immaterial when data are compared\-data are compared on -a scanline-by-scanline basis after decompression. -Most directory tags are checked; notable exceptions are: -.IR GrayResponseCurve , -.IR ColorResponseCurve , -and -.IR ColorMap -tags. -Data will not be compared if any of the -.IR BitsPerSample , -.IR SamplesPerPixel , -or -.I ImageWidth -values are not equal. -By default, -.I tiffcmp -will terminate if it encounters any difference. -.SH OPTIONS -.TP -.B \-l -List each byte of image data that differs between the files. -.TP -.BI \-z " number" -List specified number of image data bytes that differs between the files. -.TP -.B \-t -Ignore any differences in directory tags. -.SH BUGS -Tags that are not recognized by the library are not -compared; they may also generate spurious diagnostics. -.PP -The image data of tiled files is not compared, since the -.I TIFFReadScanline() -function is used. An error will be reported for tiled files. -.PP -The pixel and/or sample number reported in differences may be off -in some exotic cases. -.SH "SEE ALSO" -.BR pal2rgb (1), -.BR tiffinfo (1), -.BR tiffcp (1), -.BR tiffmedian (1), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiffcp.1 b/man/tiffcp.1 deleted file mode 100644 index 6bfee348..00000000 --- a/man/tiffcp.1 +++ /dev/null @@ -1,331 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFCP 1 "February 24, 2007" "libtiff" -.SH NAME -tiffcp \- copy (and possibly convert) a -.SM TIFF -file -.SH SYNOPSIS -.B tiffcp -[ -.I options -] -.I "src1.tif ... srcN.tif dst.tif" -.SH DESCRIPTION -.I tiffcp -combines one or more files created according -to the Tag Image File Format, Revision 6.0 -into a single -.SM TIFF -file. -Because the output file may be compressed using a different -algorithm than the input files, -.I tiffcp -is most often used to convert between different compression -schemes. -.PP -By default, -.I tiffcp -will copy all the understood tags in a -.SM TIFF -directory of an input -file to the associated directory in the output file. -.PP -.I tiffcp -can be used to reorganize the storage characteristics of data -in a file, but it is explicitly intended to not alter or convert -the image data content in any way. -.SH OPTIONS -.TP -.B \-a -Append to an existing output file instead of overwriting it. -.TP -.BI \-b " image" -subtract the following monochrome image from all others -processed. This can be used to remove a noise bias -from a set of images. This bias image is typically an -image of noise the camera saw with its shutter closed. -.TP -.B \-B -Force output to be written with Big-Endian byte order. -This option only has an effect when the output file is created or -overwritten and not when it is appended to. -.TP -.B \-C -Suppress the use of ``strip chopping'' when reading images -that have a single strip/tile of uncompressed data. -.TP -.B \-c -Specify the compression to use for data written to the output file: -.B none -for no compression, -.B packbits -for PackBits compression, -.B lzw -for Lempel-Ziv & Welch compression, -.B zip -for Deflate compression, -.B lzma -for LZMA2 compression, -.B jpeg -for baseline JPEG compression, -.B g3 -for CCITT Group 3 (T.4) compression, -.B g4 -for CCITT Group 4 (T.6) compression, -or -.B sgilog -for SGILOG compression. -By default -.I tiffcp -will compress data according to the value of the -.I Compression -tag found in the source file. -.IP -The -.SM CCITT -Group 3 and Group 4 compression algorithms can only -be used with bilevel data. -.IP -Group 3 compression can be specified together with several -T.4-specific options: -.B 1d -for 1-dimensional encoding, -.B 2d -for 2-dimensional encoding, -and -.B fill -to force each encoded scanline to be zero-filled so that the -terminating EOL code lies on a byte boundary. -Group 3-specific options are specified by appending a ``:''-separated -list to the ``g3'' option; e.g. -.B "\-c g3:2d:fill" -to get 2D-encoded data with byte-aligned EOL codes. -.IP -.SM LZW, Deflate -and -.SM LZMA2 -compression can be specified together with a -.I predictor -value. A predictor value of 2 causes each scanline of the output image to -undergo horizontal differencing before it is encoded; a value of 1 forces each -scanline to be encoded without differencing. A value 3 is for floating point -predictor which you can use if the encoded data are in floating point format. -LZW-specific options are specified by appending a ``:''-separated list to the -``lzw'' option; e.g. -.B "\-c lzw:2" -for -.SM LZW -compression with horizontal differencing. -.IP -.SM Deflate -and -.SM LZMA2 -encoders support various compression levels (or encoder presets) set as -character ``p'' and a preset number. ``p1'' is the fastest one with the worst -compression ratio and ``p9'' is the slowest but with the best possible ratio; -e.g. -.B "\-c zip:3:p9" -for -.SM Deflate -encoding with maximum compression level and floating point predictor. -.IP -For the -.SM Deflate -codec, and in a libtiff build with libdeflate enabled, ``p12`` is -actually the maximum level. -.IP -For the -.SM Deflate -codec, and in a libtiff build with libdeflate enabled, ``s0`` can be used to -require zlib to be used, and ``s1`` for libdeflate (defaults to libdeflate when -it is available). -.TP -.B \-f -Specify the bit fill order to use in writing output data. -By default, -.I tiffcp -will create a new file with the same fill order as the original. -Specifying -.B "\-f lsb2msb" -will force data to be written with the FillOrder tag set to -.SM LSB2MSB, -while -.B "\-f msb2lsb" -will force data to be written with the FillOrder tag set to -.SM MSB2LSB. -.TP -.B \-i -Ignore non-fatal read errors and continue processing of the input file. -.TP -.B \-l -Specify the length of a tile (in pixels). -.I tiffcp -attempts to set the tile dimensions so -that no more than 8 kilobytes of data appear in a tile. -.TP -.B \-L -Force output to be written with Little-Endian byte order. -This option only has an effect when the output file is created or -overwritten and not when it is appended to. -.TP -.B \-M -Suppress the use of memory-mapped files when reading images. -.TP -.BI \-o " offset" -Set initial directory offset. -.TP -.B \-p -Specify the planar configuration to use in writing image data -that has one 8-bit sample per pixel. -By default, -.I tiffcp -will create a new file with the same planar configuration as -the original. -Specifying -.B "\-p contig" -will force data to be written with multi-sample data packed -together, while -.B "\-p separate" -will force samples to be written in separate planes. -.TP -.B \-r -Specify the number of rows (scanlines) in each strip of data -written to the output file. -By default (or when value -.B 0 -is specified), -.I tiffcp -attempts to set the rows/strip -that no more than 8 kilobytes of data appear in a strip. If you specify -special value -.B \-1 -it will results in infinite number of the rows per strip. The entire image -will be the one strip in that case. -.TP -.B \-s -Force the output file to be written with data organized in strips -(rather than tiles). -.TP -.B \-t -Force the output file to be written with data organized in tiles (rather than -strips). options can be used to force the resultant image to be written as -strips or tiles of data, respectively. -.TP -.B \-w -Specify the width of a tile (in pixels). -.I tiffcp -attempts to set the tile dimensions so that no more than 8 kilobytes of data -appear in a tile. -.I tiffcp -attempts to set the tile dimensions so that no more than 8 kilobytes of data -appear in a tile. -.TP -.B \-x -Force the output file to be written with PAGENUMBER value in sequence. -.TP -.B \-8 -Write BigTIFF instead of classic TIFF format. -.TP -.BI \-,= character -substitute -.I character -for `,' in parsing image directory indices -in files. This is necessary if filenames contain commas. -Note that -.B \-,= -with whitespace immediately following will disable -the special meaning of the `,' entirely. See examples. -.TP -.BI \-m " size" -Set maximum memory allocation size (in MiB). The default is 256MiB. -Set to 0 to disable the limit. -.SH EXAMPLES -The following concatenates two files and writes the result using -.SM LZW -encoding: -.RS -.nf -tiffcp \-c lzw a.tif b.tif result.tif -.fi -.RE -.PP -To convert a G3 1d-encoded -.SM TIFF -to a single strip of G4-encoded data the following might be used: -.RS -.nf -tiffcp \-c g4 \-r 10000 g3.tif g4.tif -.fi -.RE -(1000 is just a number that is larger than the number of rows in -the source file.) - -To extract a selected set of images from a multi-image TIFF file, the file -name may be immediately followed by a `,' separated list of image directory -indices. The first image is always in directory 0. Thus, to copy the 1st and -3rd images of image file ``album.tif'' to ``result.tif'': -.RS -.nf -tiffcp album.tif,0,2 result.tif -.fi -.RE - -A trailing comma denotes remaining images in sequence. The following command -will copy all image with except the first one: -.RS -.nf -tiffcp album.tif,1, result.tif -.fi -.RE - -Given file ``CCD.tif'' whose first image is a noise bias -followed by images which include that bias, -subtract the noise from all those images following it -(while decompressing) with the command: -.RS -.nf -tiffcp \-c none \-b CCD.tif CCD.tif,1, result.tif -.fi -.RE - -If the file above were named ``CCD,X.tif'', the -.B \-,= -option would -be required to correctly parse this filename with image numbers, -as follows: -.RS -.nf -tiffcp \-c none \-,=% \-b CCD,X.tif CCD,X%1%.tif result.tif -.SH "SEE ALSO" -.BR pal2rgb (1), -.BR tiffinfo (1), -.BR tiffcmp (1), -.BR tiffmedian (1), -.BR tiffsplit (1), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiffcrop.1 b/man/tiffcrop.1 deleted file mode 100644 index d133f652..00000000 --- a/man/tiffcrop.1 +++ /dev/null @@ -1,574 +0,0 @@ -.\" tiffcrop -- a port of tiffcp.c extended to include extended processing of images -.\" -.\" Original code: -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.\" Additional code Copyright (c) 2006-2009 Richard Nolde -.\" Lasted Updated 9/2009 -.\" .if n .po 0 -.TH "TIFFCROP" "1" "December, 2008" "libtiff" "" -.SH "NAME" -tiffcrop \- select, copy, crop, convert, extract, and/or process one or more -.SM TIFF -files. -.SH "SYNOPSIS" -.B tiffcrop -[ -.I options -] -.I "src1.tif ... srcN.tif dst.tif" -.SH "DESCRIPTION" -.I Tiffcrop -processes one or more files created according -to the Tag Image File Format, Revision 6.0, specification -into one or more -.SM TIFF -file(s). -.I Tiffcrop -is most often used to extract portions of an image for processing -with bar code recognizer or OCR software when that software cannot -restrict the region of interest to a specific portion of the image -or to improve efficiency when the regions of interest must be rotated. -It can also be used to subdivide all or part of a processed image into -smaller sections and export individual images or sections of images -as separate files or separate images within one or more files derived -from the original input image or images. -.PP -The available functions can be grouped broadly into three classes: -.IP -Those that select individual images or sections of images from the input files. -The options \-N for sequences or lists of individual images in the input files, -\-Z for zones, \-z for regions, \-X and \-Y for fixed sized selections, -\-m for margins, \-U for units, and \-E for edge reference provide a variety of -ways to specify portions of the input image. -.IP -Those that allow the individual images or selections to be exported to one or -more output files in different groupings and control the organization of the -data in the output images. The options \-P for page size grouping, \-S for -subdivision into columns and rows and \-e for export mode options that produce -one or more files from each input image. The options \-r, \-s, \-t, \-w control -strip and tile format and sizes while \-B \-L \-c \-f modify the endian addressing -scheme, the compression options, and the bit fill sequence of images as they -are written. -.IP -Those that perform some action on each image that is selected from the input file. -The options include \-R for rotate, \-I for inversion of the photometric -interpretation and/or data values, and \-F to flip (mirror) the image horizontally -or vertically. -.PP - -Functions are applied to the input image(s) in the following order: -cropping, fixed area extraction, zone and region extraction, -inversion, mirroring, rotation. -.PP -Functions are applied to the output image(s) in the following order: -export mode options for grouping zones, regions, or images into -one or more files, -.I or -row and column divisions with output margins, -.I or -page size divisions with page orientation options. -.PP -Finally, strip, tile, byte order, output resolution, and compression options are -applied to all output images. -.PP -The output file(s) may be organized and compressed using a different -algorithm from the input files. -By default, -.I tiffcrop -will copy all the understood tags in a -.SM TIFF -directory of an input file to the associated directory in the output file. -Options can be used to force the resultant image to be written as strips -or tiles of data, respectively. -.PP -.I Tiffcrop -can be used to reorganize the storage characteristics of data -in a file, and to reorganize, extract, rotate, and otherwise -process the image data as specified at the same time whereas -tiffcp does not alter the image data within the file. -.PP -Using the options for selecting individual input images and the -options for exporting images and/or segments defined as zones or -regions of each input image, -.I tiffcrop -can perform the functions of tiffcp and tiffsplit in a single pass -while applying multiple operations to individual selections or images. -.PP -.SH "OPTIONS" -.TP -.B \-h -Display the syntax summary for tiffcrop. -.TP -.B \-v -Report the current version and last modification date for tiffcrop. -.TP -.B \-N odd|even|#,#\-#,#|last -Specify one or more series or range(s) of images within each file to process. -The words -.B odd -or -.B even -may be used to specify all odd or even numbered images counting from one. -Note that internally, TIFF images are numbered from zero rather than one -but since this convention is not obvious to most users, tiffcrop used 1 -to specify the first image in a multipage file. The word -.B last -may be used in place of a number in the sequence to indicate the -final image in the file without knowing how many images there are. -Ranges of images may be specified with a dash and multiple sets -can be indicated by joining them in a comma\-separated list. eg. use -.B \-N 1,5\-7,last -to process the 1st, 5th through 7th, and final image in the file. -.TP -.B \-E top|bottom|left|right -Specify the top, bottom, left, or right edge as the reference from -which to calculate the width and length of crop regions or sequence -of positions for zones. When used with the \-e option for exporting -zones or regions, the reference edge determines how composite images -are arranged. Using \-E left or right causes successive zones or -regions to be merged horizontally whereas using \-E top or bottom -causes successive zones or regions to be arranged vertically. This -option has no effect on export layout when multiple zones or regions -are not being exported to composite images. Edges may be abbreviated -to the first letter. -.TP -.B \-e combined|divided|image|multiple|separate -Specify the export mode for images and selections from input images. -The final filename on the command line is considered to be the -destination file or filename stem for automatically generated -sequences of files. Modes may be abbreviated to the first letter. -.IP -combined All images and selections are written to a single file with -multiple selections from one image combined into a single image (default) -.IP -divided All images and selections are written to a single file -with each selection from one image written to a new image -.IP -image Each input image is written to a new file (numeric filename sequence) -with multiple selections from the image combined into one image -.IP -multiple Each input image is written to a new file (numeric filename sequence) -with each selection from the image written to a new image -.IP -separate Individual selections from each image are written to separate files -.TP -.B \-U in|cm|px -Specify the type of units to apply to dimensions for margins and -crop regions for input and output images. Inches or centimeters -are converted to pixels using the resolution unit specified in the -TIFF file (which defaults to inches if not specified in the IFD). -.TP -.B \-m #,#,#,# -Specify margins to be removed from the input image. The order must -be top, left, bottom, right with only commas separating the elements -of the list. Margins are scaled according to the current units and -removed before any other extractions are computed.. -.TP -.B \-X # -Set the horizontal (X\-axis) dimension of a region to extract relative to -the specified origin reference. If the origin is the top or bottom -edge, the X axis value will be assumed to start at the left edge. -.TP -.B \-Y # -Set the vertical (Y\-axis) dimension of a region to extract relative to -the specified origin reference. If the origin is the left or right -edge, the Y axis value will be assumed to start at the top. -.TP -.B \-Z #:#,#:# -Specify zones of the image designated as position X of Y equal sized portions -measured from the reference edge, eg 1:3 would be first third of the -image starting from the reference edge minus any margins specified -for the confining edges. Multiple zones can be specified as a comma -separated list but they must reference the same edge. To extract the -top quarter and the bottom third of an image you would use -.B \-Z 1:4,3:3. -.TP -.B \-z x1,y1,x2,y2: ... :xN,yN,xN+1,yN+1 -Specify a series of coordinates to define regions for processing and exporting. -The coordinates represent the top left and lower right corners of each region -in the current units, eg inch, cm, or pixels. Pixels are counted from one to -width or height and inches or cm are calculated from image resolution data. - -Each colon delimited series of four values represents the horizontal and vertical -offsets from the top and left edges of the image, regardless of the edge specified -with the \-E option. The first and third values represent the horizontal offsets of -the corner points from the left edge while the second and fourth values represent -the vertical offsets from the top edge. -.TP -.B \-F horiz|vert -Flip, ie mirror, the image or extracted region horizontally or vertically. -.TP -.B \-R 90|180|270 -Rotate the image or extracted region 90, 180, or 270 degrees clockwise. -.TP -.B \\-I [black|white|data|both] -Invert color space, eg dark to light for bilevel and grayscale images. -This can be used to modify negative images to positive or to correct -images that have the PHOTOMETRIC_INTERPRETATIN tag set incorrectly. -If the value is black or white, the PHOTOMETRIC_INTERPRETATION tag is set to -MinIsBlack or MinIsWhite, without altering the image data. If the argument -is data or both, the data values of the image are modified. Specifying both -inverts the data and the PHOTOMETRIC_INTERPRETATION tag, whereas using data -inverts the data but not the PHOTOMETRIC_INTERPRETATION tag. -No support for modifying the color space of color images in this release. -.TP -.B \-H # -Set the horizontal resolution of output images to # -expressed in the current units. -.TP -.B \-V # -Set the vertical resolution of the output images to # -expressed in the current units. -.TP -.B \-J # -Set the horizontal margin of an output page size to # -expressed in the current units when sectioning image into columns x rows -subimages using the \-S cols:rows option. -.TP -.B \-K # -Set the vertical margin of an output page size to # -expressed in the current units when sectioning image into columns x rows -submiages using the \-S cols:rows option. -.TP -.B \-O portrait|landscape|auto -Set the output orientation of the pages or sections. -Auto will use the arrangement that requires the fewest pages. -This option is only meaningful in conjunction with the -P -option to format an image to fit on a specific paper size. -.TP -.B \-P page -Format the output images to fit on page size paper. Use -\-P list to show the supported page sizes and dimensions. -You can define a custom page size by entering the width and length of the -page in the current units with the following format #.#x#.#. -.TP -.B \-S cols:rows -Divide each image into cols across and rows down equal sections. -.TP -.B \-B -Force output to be written with Big\-Endian byte order. -This option only has an effect when the output file is created or -overwritten and not when it is appended to. -.TP -.B \-C -Suppress the use of ``strip chopping'' when reading images -that have a single strip/tile of uncompressed data. -.TP -.B \-c -Specify the compression to use for data written to the output file: -.B none -for no compression, -.B packbits -for PackBits compression, -.B lzw -for Lempel\-Ziv & Welch compression, -.B jpeg -for baseline JPEG compression. -.B zip -for Deflate compression, -.B g3 -for CCITT Group 3 (T.4) compression, -and -.B g4 -for CCITT Group 4 (T.6) compression. -By default -.I tiffcrop -will compress data according to the value of the -.I Compression -tag found in the source file. -.IP -The -.SM CCITT -Group 3 and Group 4 compression algorithms can only -be used with bilevel data. -.IP -Group 3 compression can be specified together with several -T.4\-specific options: -.B 1d -for 1\-dimensional encoding, -.B 2d -for 2\-dimensional encoding, -and -.B fill -to force each encoded scanline to be zero\-filled so that the -terminating EOL code lies on a byte boundary. -Group 3\-specific options are specified by appending a ``:''\-separated -list to the ``g3'' option; e.g. -.B "\-c g3:2d:fill" -to get 2D\-encoded data with byte\-aligned EOL codes. -.IP -.SM LZW -compression can be specified together with a -.I predictor -value. -A predictor value of 2 causes -each scanline of the output image to undergo horizontal -differencing before it is encoded; a value -of 1 forces each scanline to be encoded without differencing. -LZW\-specific options are specified by appending a ``:''\-separated -list to the ``lzw'' option; e.g. -.B "\-c lzw:2" -for -.SM LZW -compression with horizontal differencing. -.TP -.B \-f -Specify the bit fill order to use in writing output data. -By default, -.I tiffcrop -will create a new file with the same fill order as the original. -Specifying -.B "\-f lsb2msb" -will force data to be written with the FillOrder tag set to -.SM LSB2MSB, -while -.B "\-f msb2lsb" -will force data to be written with the FillOrder tag set to -.SM MSB2LSB. -.TP -.B \-i -Ignore non\-fatal read errors and continue processing of the input file. -.TP -.B "\-k size" -Set maximum memory allocation size (in MiB). The default is 256MiB. -Set to 0 to disable the limit. -.TP -.B \-l -Specify the length of a tile (in pixels). -.I Tiffcrop -attempts to set the tile dimensions so -that no more than 8 kilobytes of data appear in a tile. -.TP -.B \-L -Force output to be written with Little\-Endian byte order. -This option only has an effect when the output file is created or -overwritten and not when it is appended to. -.TP -.B \-M -Suppress the use of memory\-mapped files when reading images. -.TP -.B \-p -Specify the planar configuration to use in writing image data -that has more than one sample per pixel. -By default, -.I tiffcrop -will create a new file with the same planar configuration as -the original. -Specifying -.B "\-p contig" -will force data to be written with multi\-sample data packed -together, while -.B "\-p separate" -will force samples to be written in separate planes. -.TP -.B \-r -Specify the number of rows (scanlines) in each strip of data -written to the output file. -By default (or when value -.B 0 -is specified), -.I tiffcrop -attempts to set the rows/strip that no more than 8 kilobytes of -data appear in a strip. If you specify the special value -.B \-1 -it will results in infinite number of the rows per strip. The entire image -will be the one strip in that case. -.TP -.B \-s -Force the output file to be written with data organized in strips -(rather than tiles). -.TP -.B \-t -Force the output file to be written with data organized in tiles -(rather than strips). -.TP -.B \-w -Specify the width of a tile (in pixels). -.I tiffcrop -attempts to set the tile dimensions so -that no more than 8 kilobytes of data appear in a tile. -.I tiffcrop -attempts to set the tile dimensions so -that no more than 8 kilobytes of data appear in a tile. -.TP -Debug and dump facility -.B \-D opt1:value1,opt2:value2,opt3:value3:opt4:value4 -Display program progress and/or dump raw data to non\-TIFF files. -Options include the following and must be joined as a comma -separated list. The use of this option is generally limited to -program debugging and development of future options. An equal sign -may be substituted for the colon in option:value pairs. -.IP -debug:N Display limited program progress indicators where larger N -increase the level of detail. -.IP -format:txt|raw Format any logged data as ASCII text or raw binary -values. ASCII text dumps include strings of ones and zeroes representing -the binary values in the image data plus identifying headers. -.IP -level:N Specify the level of detail presented in the dump files. -This can vary from dumps of the entire input or output image data to dumps -of data processed by specific functions. Current range of levels is 1 to 3. -.IP -input:full\-path\-to\-directory/input\-dumpname -.IP -output:full\-path\-to\-directory/output\-dumpname -.IP -When dump files are being written, each image will be written to a separate -file with the name built by adding a numeric sequence value to the dumpname -and an extension of .txt for ASCII dumps or .bin for binary dumps. - -The four debug/dump options are independent, though it makes little sense to -specify a dump file without specifying a detail level. -.IP -Note: Tiffcrop may be compiled with -DDEVELMODE to enable additional very - low level debug reporting. -.SH "EXAMPLES" -The following concatenates two files and writes the result using -.SM LZW -encoding: -.RS -.nf -tiffcrop \-c lzw a.tif b.tif result.tif -.fi -.RE -.PP -To convert a G3 1d\-encoded -.SM TIFF -to a single strip of G4\-encoded data the following might be used: -.RS -.nf -tiffcrop \-c g4 \-r 10000 g3.tif g4.tif -.fi -.RE -(1000 is just a number that is larger than the number of rows in -the source file.) - -To extract a selected set of images from a multi\-image TIFF file -use the \-N option described above. Thus, to copy the 1st and 3rd -images of image file "album.tif" to "result.tif": -.RS -.nf -tiffcrop \-N 1,3 album.tif result.tif -.fi -.RE -.PP -Invert a bilevel image scan of a microfilmed document and crop off margins of -0.25 inches on the left and right, 0.5 inch on the top, and 0.75 inch on the -bottom. From the remaining portion of the image, select the second and third -quarters, ie, one half of the area left from the center to each margin. -.RS -tiffcrop \-U in \-m 0.5,0.25,0.75,0.25 \-E left \-Z 2:4,3:4 \-I both MicrofilmNegative.tif MicrofilmPostiveCenter.tif -.fi -.RE -.PP -Extract only the final image of a large Architectural E sized -multipage TIFF file and rotate it 90 degrees clockwise while -reformatting the output to fit on tabloid sized sheets with one -quarter of an inch on each side: -.RS -tiffcrop \-N last \-R 90 \-O auto \-P tabloid \-U in \-J 0.25 \-K 0.25 \-H 300 \-V 300 Big\-PlatMap.tif BigPlatMap\-Tabloid.tif -.fi -.RE -The output images will have a specified resolution of 300 dpi in both -directions. The orientation of each page will be determined by whichever -choice requires the fewest pages. To specify a specific orientation, use -the portrait or landscape option. The paper size option does not resample -the image. It breaks each original image into a series of smaller images -that will fit on the target paper size at the specified resolution. -.fi -.RE -.PP -Extract two regions 2048 pixels wide by 2048 pixels high from each page of -a multi\-page input file and write each region to a separate output file. -.RS -tiffcrop \-U px \-z 1,1,2048,2048:1,2049,2048,4097 \-e separate CheckScans.tiff Check -.fi -.RE -The output file names will use the stem Check with a numeric suffix which is -incremented for each region of each image, eg Check\-001.tiff, Check\-002.tiff ... -Check\-NNN.tiff. To produce a unique file for each page of the input image -with one new image for each region of the input image on that page, change -the export option to \-e multiple. - -.SH "NOTES" -.PP -In general, bilevel, grayscale, palette and RGB(A) data with bit depths -from 1 to 32 bits should work in both interleaved and separate plane -formats. Unlike tiffcp, tiffcrop can read and write tiled images with -bits per sample that are not a multiple of 8 in both interleaved and -separate planar format. Floating point data types are supported at -bit depts of 16, 24, 32 and 64 bits per sample. -.PP -Not all images can be converted from one compression scheme to another. -Data with some photometric interpretations and/or bit depths are tied to -specific compression schemes and vice-versa, e.g. Group 3/4 compression -is only usable for bilevel data. JPEG compression is only usable on 8 -bit per sample data (or 12 bit if -.I LibTIFF -was compiled with 12 bit JPEG support). Support for OJPEG compressed -images is problematic at best. Since OJPEG compression is no longer -supported for writing images with LibTIFF, these images will be updated -to the newer JPEG compression when they are copied or processed. This -may cause the image to appear color shifted or distorted after conversion. -In some cases, it is possible to remove the original compression from -image data using the option -cnone. -.PP -Tiffcrop does not currently provide options to up or downsample data to -different bit depths or convert data from one photometric interpretation -to another, e.g. 16 bits per sample to 8 bits per sample or RGB to grayscale. -.PP -Tiffcrop is very loosely derived from code in -.I tiffcp -with extensive modifications and additions to support the selection of input -images and regions and the exporting of them to one or more output files in -various groupings. The image manipulation routines are entirely new and -additional ones may be added in the future. It will handle tiled images with -bit depths that are not a multiple of eight that tiffcp may refuse to read. -.PP -.I Tiffcrop -was designed to handle large files containing many moderate sized images -with memory usage that is independent of the number of images in the file. -In order to support compression modes that are not based on individual -scanlines, e.g. JPEG, it now reads images by strip or tile rather than by -individual scanlines. In addition to the memory required by the input and -output buffers associated with -.I LibTIFF -one or more buffers at least as large as the largest image to be read are -required. The design favors large volume document processing uses over -scientific or graphical manipulation of large datasets as might be found -in research or remote sensing scenarios. -.SH "SEE ALSO" -.BR pal2rgb (1), -.BR tiffinfo (1), -.BR tiffcmp (1), -.BR tiffcp (1), -.BR tiffmedian (1), -.BR tiffsplit (1), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ - diff --git a/man/tiffdither.1 b/man/tiffdither.1 deleted file mode 100644 index 56725b2b..00000000 --- a/man/tiffdither.1 +++ /dev/null @@ -1,134 +0,0 @@ -.\" -.\" Copyright (c) 1990-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFDITHER 1 "September 20, 2005" "libtiff" -.SH NAME -tiffdither \- convert a greyscale image to bilevel using dithering -.SH SYNOPSIS -.B tiffdither -[ -.I options -] -.I input.tif -.I output.tif -.SH DESCRIPTION -.I tiffdither -converts a single channel 8-bit greyscale image to a bilevel image -using Floyd-Steinberg error propagation with thresholding. -.SH OPTIONS -.TP -.B \-c -Specify the compression to use for data written to the output file: -.B none -for no compression, -.B packbits -for PackBits compression, -.B lzw -for Lempel-Ziv & Welch compression, -.B zip -for Deflate compression, -.B g3 -for CCITT Group 3 (T.4) compression, -and -.B g4 -for CCITT Group 4 (T.6) compression. -By default -.I tiffdither -will compress data according to the value of the -.I Compression -tag found in the source file. -.IP -The -.SM CCITT -Group 3 and Group 4 compression algorithms can only -be used with bilevel data. -.IP -Group 3 compression can be specified together with several -T.4-specific options: -.B 1d -for 1-dimensional encoding, -.B 2d -for 2-dimensional encoding, -and -.B fill -to force each encoded scanline to be zero-filled so that the -terminating EOL code lies on a byte boundary. -Group 3-specific options are specified by appending a ``:''-separated -list to the ``g3'' option; e.g. -.B "\-c g3:2d:fill" -to get 2D-encoded data with byte-aligned EOL codes. -.IP -.SM LZW -compression can be specified together with a -.I predictor -value. -A predictor value of 2 causes -each scanline of the output image to undergo horizontal -differencing before it is encoded; a value -of 1 forces each scanline to be encoded without differencing. -LZW-specific options are specified by appending a ``:''-separated -list to the ``lzw'' option; e.g. -.B "\-c lzw:2" -for -.SM LZW -compression with horizontal differencing. -.TP -.B \-f -Specify the bit fill order to use in writing output data. -By default, -.I tiffdither -will create a new file with the same fill order as the original. -Specifying -.B "\-f lsb2msb" -will force data to be written with the -.I Fill\%Order -tag set to -.SM LSB2MSB , -while -.B "\-f msb2lsb" -will force data to be written with the -.I Fill\%Order -tag set to -.SM MSB2LSB . -.TP -.B \-r -Make each strip have no more than the given number of rows. -.TP -.B \-t -Set the threshold value for dithering. -By default the threshold value is 128. -.SH NOTES -The dither algorithm is taken from the -.BR tiffmedian (1) -program (written by Paul Heckbert). -.SH "SEE ALSO" -.BR pal2rgb (1), -.BR fax2tiff (1), -.BR tiffinfo (1), -.BR tiffcp (1), -.BR tiff2bw (1), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiffdump.1 b/man/tiffdump.1 deleted file mode 100644 index 07b08e3c..00000000 --- a/man/tiffdump.1 +++ /dev/null @@ -1,80 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFDUMP 1 "October 23, 2005" "libtiff" -.SH NAME -tiffdump \- print verbatim information about -.SM TIFF -files -.SH SYNOPSIS -.B tiffdump -[ -.I options -] -.I "name \&..." -.SH DESCRIPTION -.I tiffdump -displays directory information from files created according -to the Tag Image File Format, Revision 6.0. -The header of each -.SM TIFF -file (magic number, version, and first directory offset) -is displayed, followed by the tag contents of each directory in the file. -For each tag, the name, data type, count, and value(s) is displayed. -When the symbolic name for a tag or data type is known, the symbolic -name is displayed followed by it's numeric (decimal) value. -Tag values are displayed enclosed in ``<>'' characters immediately -preceded by the value of the count field. -For example, an -.I ImageWidth -tag might be displayed as ``ImageWidth (256) SHORT (3) 1<800>''. -.PP -.I tiffdump -is particularly useful for investigating the contents of -.SM TIFF -files that -.I libtiff -does not understand. -.SH OPTIONS -.TP -.B \-h -Force numeric data to be printed in hexadecimal rather than the -default decimal. -.TP -.BI \-m " items" -Change the number of indirect data items that are printed. By default, this -will be 24. -.TP -.BI \-o " offset" -Dump the contents of the -.SM IFD -at the a particular file offset. -The file offset may be specified using the usual C-style syntax; -i.e. a leading ``0x'' for hexadecimal and a leading ``0'' for octal. -.SH "SEE ALSO" -.BR tiffinfo (1), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiffgt.1 b/man/tiffgt.1 deleted file mode 100644 index 6ef6209f..00000000 --- a/man/tiffgt.1 +++ /dev/null @@ -1,244 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFGT 1 "September 20, 2005" "libtiff" -.SH NAME -tiffgt \- display an image stored in a -.SM TIFF -file (Silicon Graphics version) -.SH SYNOPSIS -.B tiffgt -[ -.I options -] -.I "input.tif ..." -.SH DESCRIPTION -.I tiffgt -displays one or more images stored using the -Tag Image File Format, Revision 6.0. -Each image is placed in a fixed size window that the -user must position on the display (unless configured -otherwise through X defaults). -If the display has fewer than 24 bitplanes, or if the -image does not warrant full color, then -.SM RGB -color values are mapped to the closest values that exist in -the colormap (this is done using the -.I rgbi -routine found in the graphics utility library -.BR \-lgutil .) -.PP -.I tiffgt -correctly handles files with any of the following characteristics: -.sp .5 -.in +0.5i -.ta \w'\fIPhotometricInterpretation\fP 'u -.nf -\fIBitsPerSample\fP 1, 2, 4, 8, 16 -\fISamplesPerPixel\fP 1, 3, 4 (the 4th sample is ignored) -\fIPhotometricInterpretation\fP 0 (min-is-white), 1 (min-is-black), 2 (RGB), 3 (palette), 6 (YCbCr) -\fIPlanarConfiguration\fP 1 (contiguous), 2 (separate) -\fIOrientation\fP 1 (top-left), 4 (bottom-left) -.fi -.in -0.5i -.sp .5 -Data may be organized as strips or tiles and may be -compressed with any of the compression algorithms supported -by the -.IR libtiff (3) -library. -.PP -For palette images (\c -.IR PhotometricInterpretation =3), -.I tiffgt -inspects the colormap values and assumes either 16-bit -or 8-bit values according to the maximum value. -That is, if no colormap entry greater than 255 is found, -.I tiffgt -assumes the colormap has only 8-bit values; otherwise -it assumes 16-bit values. -This inspection is done to handle old images written by -previous (incorrect) versions of -.IR libtiff . -.PP -.I tiffgt -can be used to display multiple images one-at-a-time. -The left mouse button switches the display to the first image in the -.I next -file in the list of files specified on the command line. -The right mouse button switches to the first image in the -.I previous -file in the list. -The middle mouse button causes the first image in the first file -specified on the command line to be displayed. -In addition the following keyboard commands are recognized: -.TP -.B b -Use a -.I PhotometricInterpretation -of MinIsBlack in displaying the current image. -.TP -.B l -Use a -.I FillOrder -of lsb-to-msb in decoding the current image. -.TP -.B m -Use a -.I FillOrder -of msb-to-lsb in decoding the current image. -.TP -.B c -Use a colormap visual to display the current image. -.TP -.B r -Use a true color (24-bit RGB) visual to display the current image. -.TP -.B w -Use a -.I PhotometricInterpretation -of MinIsWhite in displaying the current image. -.TP -.B W -Toggle (enable/disable) display of warning messages from the -.SM TIFF -library when decoding images. -.TP -.B E -Toggle (enable/disable) display of error messages from the -.SM TIFF -library when decoding images. -.TP -.B z -Reset all parameters to their default settings (\c -.IR FillOrder , -.IR PhotometricInterpretation , -handling of warnings and errors). -.TP -.B PageUp -Display the previous image in the current file or the last -image in the previous file. -.TP -.B PageDown -Display the next image in the current file or the first image -in the next file. -.TP -.B Home -Display the first image in the current file. -.TP -.B End -Display the last image in the current file (unimplemented). -.SH OPTIONS -.TP -.B \-c -Force image display in a colormap window. -.TP -.B \-d -Specify an image to display by directory number. -By default the first image in the file is displayed. -Directories are numbered starting at zero. -.TP -.B \-e -Enable reporting of error messages from the -.SM TIFF -library. -By default -.I tiffgt -silently ignores images that cannot be read. -.TP -.B \-f -Force -.I tiffgt -to run as a foreground process. -By default -.I tiffgt -will place itself in the background once it has opened the -requested image file. -.TP -.B \-l -Force the presumed bit ordering to be -.SM LSB -to -.SM MSB. -.TP -.B \-m -Force the presumed bit ordering to be -.SM MSB -to -.SM LSB. -.TP -.B \-o -Specify an image to display by directory offset. -By default the first image in the file is displayed. -Directories offsets may be specified using C-style syntax; -i.e. a leading ``0x'' for hexadecimal and a leading ``0'' for octal. -.TP -.B \-p -Override the value of the -.I PhotometricInterpretation -tag; the parameter may be one of: -.BR miniswhite , -.BR minisblack , -.BR rgb , -.BR palette , -.BR mask , -.BR separated , -.BR ycbcr , -and -.BR cielab . -.TP -.B \-r -Force image display in a full color window. -.TP -.B \-s -Stop on the first read error. -By default all errors in the input data are ignored and -.I tiffgt -does it's best to display as much of an image as possible. -.TP -.B \-w -Enable reporting of warning messages from the -.SM TIFF -library. -By default -.I tiffgt -ignores warning messages generated when reading an image. -.TP -.B \-v -Place information in the title bar describing -what type of window (full color or colormap) is being -used, the name of the input file, and the directory -index of the image (if non-zero). -By default, the window type is not shown in the title bar. -.SH BUGS -Images wider and taller than the display are silently truncated to avoid -crashing old versions of the window manager. -.SH "SEE ALSO" -.BR tiffdump (1), -.BR tiffinfo (1), -.BR tiffcp (1), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiffinfo.1 b/man/tiffinfo.1 deleted file mode 100644 index 64958a6c..00000000 --- a/man/tiffinfo.1 +++ /dev/null @@ -1,87 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFINFO 1 "November 2, 2005" "libtiff" -.SH NAME -tiffinfo \- print information about -.SM TIFF -files -.SH SYNOPSIS -.B tiffinfo -[ -.I options -] -.I "input.tif \&..." -.SH DESCRIPTION -.I Tiffinfo -displays information about files created according -to the Tag Image File Format, Revision 6.0. -By default, the contents of each -.SM TIFF -directory in each file -is displayed, with the value of each tag shown symbolically -(where sensible). -.SH OPTIONS -.TP -.B \-c -Display the colormap and color/gray response curves, if present. -.TP -.B \-D -In addition to displaying the directory tags, -read and decompress all the data in each image (but not display it). -.TP -.B \-d -In addition to displaying the directory tags, -print each byte of decompressed data in hexadecimal. -.TP -.B \-j -Display any \s-2JPEG\s0-related tags that are present. -.TP -.B \-o -Set the initial -.SM TIFF -directory according to the specified file offset. -The file offset may be specified using the usual C-style syntax; -i.e. a leading ``0x'' for hexadecimal and a leading ``0'' for octal. -.TP -.B \-s -Display the offsets and byte counts for each data strip in a directory. -.TP -.B \-z -Enable strip chopping when reading image data. -.TP -.B \-# -Set the initial -.SM TIFF -directory to -.IR # . -.SH "SEE ALSO" -.BR pal2rgb (1), -.BR tiffcp (1), -.BR tiffcmp (1), -.BR tiffmedian (1), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiffmedian.1 b/man/tiffmedian.1 deleted file mode 100644 index b10ba798..00000000 --- a/man/tiffmedian.1 +++ /dev/null @@ -1,111 +0,0 @@ -.\" -.\" Copyright (c) 1990-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFMEDIAN 1 "November 2, 2005" "libtiff" -.SH NAME -tiffmedian \- apply the median cut algorithm to data in a -.SM TIFF -file -.SH SYNOPSIS -.B tiffmedian -[ -.I options -] -.I input.tif -.I output.tif -.SH DESCRIPTION -.I tiffmedian -applies the median cut algorithm to an -.SM RGB -image in -.I input.tif -to generate a palette image that is written to -.IR output.tif . -The generated colormap has, by default, 256 entries. -The image data is quantized by mapping each -pixel to the closest color values in the colormap. -.SH OPTIONS -.TP -.B \-c -Specify the compression to use for data written to the output file: -.B none -for no compression, -.B packbits -for PackBits compression, -.B lzw -for Lempel-Ziv & Welch compression, -and -.B zip -for Deflate compression. -By default -.I tiffmedian -will compress data according to the value of the -.I Compression -tag found in the source file. -.IP -.SM LZW -compression can be specified together with a -.I predictor -value. -A predictor value of 2 causes -each scanline of the output image to undergo horizontal -differencing before it is encoded; a value -of 1 forces each scanline to be encoded without differencing. -LZW-specific options are specified by appending a ``:''-separated -list to the ``lzw'' option; e.g. -.B "\-c lzw:2" -for -.SM LZW -compression with horizontal differencing. -.TP -.B \-C -Specify the number of entries to use in the generated colormap. -By default all 256 entries/colors are used. -.TP -.B \-f -Apply Floyd-Steinberg dithering before selecting a colormap entry. -.TP -.B \-r -Specify the number of rows (scanlines) in each strip of data -written to the output file. -By default, -.I tiffmedian -attempts to set the rows/strip -that no more than 8 kilobytes of data appear in a strip. -.SH NOTES -This program is derived from Paul Heckbert's -.I median -program. -.SH "SEE ALSO" -.BR pal2rgb (1), -.BR tiffinfo (1), -.BR tiffcp (1), -.BR tiffcmp (1), -.BR libtiff (3TIFF) -.PP -.BR "Color Image Quantization for Frame Buffer Display", -Paul Heckbert, SIGGRAPH proceedings, 1982, pp. 297-307. -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiffset.1 b/man/tiffset.1 deleted file mode 100644 index 513c7567..00000000 --- a/man/tiffset.1 +++ /dev/null @@ -1,98 +0,0 @@ -.\" -.\" Copyright (c) 1988-1997 Sam Leffler -.\" Copyright (c) 1991-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFSET 1 "December 3, 2012" "libtiff" -.SH NAME -tiffset \- set or unset a field in a -.SM TIFF -header -.SH SYNOPSIS -.B tiffset -[ -.I options -] -.I filename.tif -.SH DESCRIPTION -.I Tiffset -sets the value of a -.SM TIFF -header to a specified value or removes an existing setting. -.SH OPTIONS -.TP -.BI \-d " dirnumber" -change the current directory (starting at 0). -.TP -.BI \-s " tagnumber" "\fR [\fP" " count" "\fR ]\fP" " value ..." -Set the value of the named tag to the value or values specified. -.TP -.BI \-sd " diroffset" -change the current directory by offset. -.TP -.BI \-sf " tagnumber filename" -Set the value of the tag to the contents of filename. This option is -supported for ASCII tags only. -.TP -.BI \-u " tagnumber" -Unset the tag. -.SH EXAMPLES -The following example sets the image description tag (270) of a.tif to -the contents of the file descrip: -.RS -.nf -tiffset \-sf 270 descrip a.tif -.fi -.RE -.PP -The following example sets the artist tag (315) of a.tif to the string -``Anonymous'': -.RS -.nf -tiffset \-s 315 Anonymous a.tif -.fi -.RE -.PP -This example sets the resolution of the file a.tif to 300 dpi: -.RS -.nf -tiffset \-s 296 2 a.tif -tiffset \-s 282 300.0 a.tif -tiffset \-s 283 300.0 a.tif -.fi -.RE -.PP -Set the photometric interpretation of the third page of a.tif to -min-is-black (ie. inverts it): -.RS -.nf -tiffset -d 2 -s 262 1 a.tif -.fi -.RE -.SH "SEE ALSO" -.BR tiffdump (1), -.BR tiffinfo (1), -.BR tiffcp (1), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ diff --git a/man/tiffsplit.1 b/man/tiffsplit.1 deleted file mode 100644 index 6b0b5121..00000000 --- a/man/tiffsplit.1 +++ /dev/null @@ -1,80 +0,0 @@ -.\" -.\" Copyright (c) 1992-1997 Sam Leffler -.\" Copyright (c) 1992-1997 Silicon Graphics, Inc. -.\" -.\" Permission to use, copy, modify, distribute, and sell this software and -.\" its documentation for any purpose is hereby granted without fee, provided -.\" that (i) the above copyright notices and this permission notice appear in -.\" all copies of the software and related documentation, and (ii) the names of -.\" Sam Leffler and Silicon Graphics may not be used in any advertising or -.\" publicity relating to the software without the specific, prior written -.\" permission of Sam Leffler and Silicon Graphics. -.\" -.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, -.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY -.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -.\" -.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR -.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, -.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, -.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF -.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE -.\" OF THIS SOFTWARE. -.\" -.if n .po 0 -.TH TIFFSPLIT 1 "September 20, 2005" "libtiff" -.SH NAME -tiffsplit \- split a multi-image -.SM TIFF -into single-image -.SM TIFF -files -.SH SYNOPSIS -.B tiffsplit -.I src.tif -[ -.I prefix -] -.SH DESCRIPTION -.I tiffsplit -takes a multi-directory (page) -.SM TIFF -file and creates one or more single-directory (page) -.SM TIFF -files from it. -The output files are given names created by concatenating -a prefix, a lexically ordered -suffix in the range [\fIaaa\fP-\fIzzz\fP], the suffix -.I .tif -(e.g. -.IR xaaa.tif , -.IR xaab.tif , -.IR ... , -.IR xzzz.tif ). -If a prefix is not specified on the command line, -the default prefix of -.I x -is used. -.SH OPTIONS -None. -.SH EXIT STATUS -.I tiffsplit -exits with one of the following values: -.PD 0 -.TP -.B 0 -Success -.TP -.B 1 -An error occurred either reading the input or writing results. -.RE -.PD -.SH BUGS -Only a select set of ``known tags'' is copied when splitting. -.SH "SEE ALSO" -.BR tiffcp (1), -.BR tiffinfo (1), -.BR libtiff (3TIFF) -.PP -Libtiff library home page: -.BR http://www.simplesystems.org/libtiff/ |