summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'openjpeg/doc')
-rw-r--r--openjpeg/doc/CMakeLists.txt52
-rw-r--r--openjpeg/doc/Doxyfile.dox.cmake.in285
-rw-r--r--openjpeg/doc/jpip_architect.pngbin0 -> 62577 bytes
-rw-r--r--openjpeg/doc/jpip_protocol.pngbin0 -> 6376 bytes
-rw-r--r--openjpeg/doc/mainpage.dox.in62
-rw-r--r--openjpeg/doc/man/man1/opj_compress.1222
-rw-r--r--openjpeg/doc/man/man1/opj_decompress.1119
-rw-r--r--openjpeg/doc/man/man1/opj_dump.162
-rw-r--r--openjpeg/doc/man/man3/libopenjp2.3337
-rw-r--r--openjpeg/doc/openjpip.dox.in94
10 files changed, 1233 insertions, 0 deletions
diff --git a/openjpeg/doc/CMakeLists.txt b/openjpeg/doc/CMakeLists.txt
new file mode 100644
index 00000000..d4f3ddbe
--- /dev/null
+++ b/openjpeg/doc/CMakeLists.txt
@@ -0,0 +1,52 @@
+# Generate target to build the html documentation through CMake tool
+# After having configured the project with the BUILD_DOC option you can run make doc
+# to generate the html documentation in the doc/html repository of the build folder.
+
+# Try to find the doxygen tool
+find_package(Doxygen)
+
+if(DOXYGEN_FOUND)
+ # Configure the doxygen config file with variable from CMake and move it
+ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.dox.cmake.in
+ ${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox @ONLY)
+
+ # Configure the html mainpage file of the doxygen documentation with variable
+ # from CMake and move it
+ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in
+ ${CMAKE_BINARY_DIR}/doc/mainpage.dox @ONLY)
+ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/openjpip.dox.in
+ ${CMAKE_BINARY_DIR}/doc/openjpip.dox @ONLY)
+ # copy png file to make local (binary tree) documentation valid:
+ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/jpip_architect.png
+ ${CMAKE_BINARY_DIR}/doc/html/jpip_architect.png COPYONLY)
+ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/jpip_protocol.png
+ ${CMAKE_BINARY_DIR}/doc/html/jpip_protocol.png COPYONLY)
+
+ file(GLOB headers
+ ${OPENJPEG_SOURCE_DIR}/src/lib/openjp2/*.h
+ ${OPENJPEG_SOURCE_DIR}/src/lib/openjp2/*.c
+ ${OPENJPEG_SOURCE_DIR}/src/lib/openjpip/*.h
+ ${OPENJPEG_SOURCE_DIR}/src/lib/openjpip/*.c
+ )
+ # Generate new target to build the html documentation
+ add_custom_command(
+ OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/html/index.html
+ COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox
+ DEPENDS ${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox
+ ${CMAKE_BINARY_DIR}/doc/mainpage.dox
+ ${CMAKE_BINARY_DIR}/doc/openjpip.dox
+ ${headers}
+ )
+ add_custom_target(doc ALL
+ DEPENDS ${CMAKE_BINARY_DIR}/doc/html/index.html
+ COMMENT "Building doxygen documentation"
+ )
+
+ # install HTML documentation (install png files too):
+ install(DIRECTORY ${CMAKE_BINARY_DIR}/doc/html
+ DESTINATION share/doc
+ PATTERN ".svn" EXCLUDE
+ )
+else()
+ message(STATUS "Doxygen not found, we cannot generate the documentation")
+endif()
diff --git a/openjpeg/doc/Doxyfile.dox.cmake.in b/openjpeg/doc/Doxyfile.dox.cmake.in
new file mode 100644
index 00000000..3163f991
--- /dev/null
+++ b/openjpeg/doc/Doxyfile.dox.cmake.in
@@ -0,0 +1,285 @@
+# Doxyfile 1.7.1
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+DOXYFILE_ENCODING = UTF-8
+PROJECT_NAME = OpenJPEG
+PROJECT_NUMBER = @OPENJPEG_VERSION@
+OUTPUT_DIRECTORY = @OPENJPEG_BINARY_DIR@/doc
+CREATE_SUBDIRS = NO
+OUTPUT_LANGUAGE = English
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = YES
+ABBREVIATE_BRIEF = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+ALWAYS_DETAILED_SEC = NO
+INLINE_INHERITED_MEMB = NO
+FULL_PATH_NAMES = NO
+STRIP_FROM_PATH = C://
+STRIP_FROM_INC_PATH =
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = YES
+QT_AUTOBRIEF = NO
+MULTILINE_CPP_IS_BRIEF = NO
+INHERIT_DOCS = YES
+SEPARATE_MEMBER_PAGES = NO
+TAB_SIZE = 8
+ALIASES =
+OPTIMIZE_OUTPUT_FOR_C = YES
+OPTIMIZE_OUTPUT_JAVA = NO
+OPTIMIZE_FOR_FORTRAN = NO
+OPTIMIZE_OUTPUT_VHDL = NO
+EXTENSION_MAPPING =
+BUILTIN_STL_SUPPORT = NO
+CPP_CLI_SUPPORT = NO
+SIP_SUPPORT = NO
+IDL_PROPERTY_SUPPORT = YES
+DISTRIBUTE_GROUP_DOC = NO
+SUBGROUPING = YES
+TYPEDEF_HIDES_STRUCT = NO
+SYMBOL_CACHE_SIZE = 0
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = YES
+EXTRACT_PRIVATE = YES
+EXTRACT_STATIC = YES
+EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_METHODS = NO
+EXTRACT_ANON_NSPACES = NO
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = NO
+CASE_SENSE_NAMES = NO
+HIDE_SCOPE_NAMES = NO
+SHOW_INCLUDE_FILES = YES
+FORCE_LOCAL_INCLUDES = NO
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = YES
+SORT_BRIEF_DOCS = NO
+SORT_MEMBERS_CTORS_1ST = NO
+SORT_GROUP_NAMES = NO
+SORT_BY_SCOPE_NAME = NO
+GENERATE_TODOLIST = YES
+GENERATE_TESTLIST = YES
+GENERATE_BUGLIST = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 30
+SHOW_USED_FILES = YES
+SHOW_DIRECTORIES = NO
+SHOW_FILES = YES
+SHOW_NAMESPACES = YES
+FILE_VERSION_FILTER =
+LAYOUT_FILE =
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = NO
+WARN_FORMAT = "$file:$line: $text"
+WARN_LOGFILE =
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = @OPENJPEG_SOURCE_DIR@/src/lib/openjp2 \
+ @OPENJPEG_SOURCE_DIR@/src/lib/openjpip \
+ @OPENJPEG_BINARY_DIR@/doc
+INPUT_ENCODING = UTF-8
+FILE_PATTERNS = *.h \
+ *.c \
+ *.dox
+RECURSIVE = YES
+EXCLUDE =
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS = */.svn/*
+EXCLUDE_SYMBOLS =
+EXAMPLE_PATH =
+EXAMPLE_PATTERNS = *
+EXAMPLE_RECURSIVE = NO
+IMAGE_PATH = @OPENJPEG_SOURCE_DIR@/doc
+INPUT_FILTER =
+FILTER_PATTERNS =
+FILTER_SOURCE_FILES = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = NO
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = YES
+REFERENCED_BY_RELATION = YES
+REFERENCES_RELATION = YES
+REFERENCES_LINK_SOURCE = YES
+USE_HTAGS = NO
+VERBATIM_HEADERS = YES
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = NO
+COLS_IN_ALPHA_INDEX = 5
+IGNORE_PREFIX =
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = ./html
+HTML_FILE_EXTENSION = .html
+HTML_HEADER =
+HTML_FOOTER =
+HTML_STYLESHEET =
+HTML_COLORSTYLE_HUE = 220
+HTML_COLORSTYLE_SAT = 100
+HTML_COLORSTYLE_GAMMA = 80
+HTML_TIMESTAMP = NO
+HTML_ALIGN_MEMBERS = YES
+HTML_DYNAMIC_SECTIONS = NO
+GENERATE_DOCSET = NO
+DOCSET_FEEDNAME = "Doxygen generated docs"
+DOCSET_BUNDLE_ID = org.doxygen.Project
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+DOCSET_PUBLISHER_NAME = Publisher
+GENERATE_HTMLHELP = NO
+CHM_FILE =
+HHC_LOCATION =
+GENERATE_CHI = NO
+CHM_INDEX_ENCODING =
+BINARY_TOC = NO
+TOC_EXPAND = NO
+GENERATE_QHP = NO
+QCH_FILE =
+QHP_NAMESPACE = org.doxygen.Project
+QHP_VIRTUAL_FOLDER = doc
+QHP_CUST_FILTER_NAME =
+QHP_CUST_FILTER_ATTRS =
+QHP_SECT_FILTER_ATTRS =
+QHG_LOCATION =
+GENERATE_ECLIPSEHELP = NO
+ECLIPSE_DOC_ID = org.doxygen.Project
+DISABLE_INDEX = NO
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = NO
+USE_INLINE_TREES = NO
+TREEVIEW_WIDTH = 250
+EXT_LINKS_IN_WINDOW = NO
+FORMULA_FONTSIZE = 10
+FORMULA_TRANSPARENT = YES
+SEARCHENGINE = NO
+SERVER_BASED_SEARCH = NO
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4wide
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = NO
+USE_PDFLATEX = NO
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+LATEX_SOURCE_CODE = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = NO
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED = USE_JPWL \
+ USE_JPSEC
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE =
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = YES
+PERL_PATH = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = YES
+MSCGEN_PATH =
+HIDE_UNDOC_RELATIONS = YES
+HAVE_DOT = NO
+DOT_NUM_THREADS = 0
+DOT_FONTNAME = Helvetica
+DOT_FONTSIZE = 10
+DOT_FONTPATH =
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = YES
+GROUP_GRAPHS = YES
+UML_LOOK = NO
+TEMPLATE_RELATIONS = NO
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = YES
+CALL_GRAPH = NO
+CALLER_GRAPH = NO
+GRAPHICAL_HIERARCHY = YES
+DIRECTORY_GRAPH = YES
+DOT_IMAGE_FORMAT = png
+DOT_PATH =
+DOTFILE_DIRS =
+DOT_GRAPH_MAX_NODES = 50
+MAX_DOT_GRAPH_DEPTH = 1000
+DOT_TRANSPARENT = NO
+DOT_MULTI_TARGETS = NO
+GENERATE_LEGEND = YES
+DOT_CLEANUP = YES
diff --git a/openjpeg/doc/jpip_architect.png b/openjpeg/doc/jpip_architect.png
new file mode 100644
index 00000000..5375bf91
--- /dev/null
+++ b/openjpeg/doc/jpip_architect.png
Binary files differ
diff --git a/openjpeg/doc/jpip_protocol.png b/openjpeg/doc/jpip_protocol.png
new file mode 100644
index 00000000..bc326d45
--- /dev/null
+++ b/openjpeg/doc/jpip_protocol.png
Binary files differ
diff --git a/openjpeg/doc/mainpage.dox.in b/openjpeg/doc/mainpage.dox.in
new file mode 100644
index 00000000..6c105998
--- /dev/null
+++ b/openjpeg/doc/mainpage.dox.in
@@ -0,0 +1,62 @@
+/*
+ * $Id$
+ *
+ * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+ * Copyright (c) 2011, Mickael Savinaud, Communications & Systemes <mickael.savinaud@c-s.fr>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/*! \mainpage OpenJPEG v@OPENJPEG_VERSION@ Documentation
+*
+* \section intro Introduction
+* This manual documents the low-level OpenJPEG C API.\n
+* The OpenJPEG library is an open-source JPEG 2000 library developed in order to promote the use of JPEG 2000.\n
+* This documents is focused on the main part of the library which try to implement Part 1 and Part 2 of the JPEG2000 norm.\n
+*
+* \section home Home page
+*
+* The Home Page of the OpenJPEG project can be found at:
+*
+* http://www.openjpeg.org/
+*
+* The source code repository is available here:
+*
+* http://github.com/uclouvain/openjpeg
+*
+* The OpenJPEG mailing list is located here:
+*
+* http://groups.google.com/group/openjpeg
+*
+* The test files repository is available here:
+*
+* http://github.com/uclouvain/openjpeg-data
+*
+* \section license License
+* This software is released under the BSD license, anybody can use or modify the library, even for commercial applications.\n
+* The only restriction is to retain the copyright in the sources or the binaries documentation.\n
+* Neither the author, nor the university accept any responsibility for any kind of error or data loss which may occur during usage.
+*
+* \author OpenJPEG Team
+*
+*/
diff --git a/openjpeg/doc/man/man1/opj_compress.1 b/openjpeg/doc/man/man1/opj_compress.1
new file mode 100644
index 00000000..76ef01ee
--- /dev/null
+++ b/openjpeg/doc/man/man1/opj_compress.1
@@ -0,0 +1,222 @@
+'\" t
+'\" The line above instructs most `man' programs to invoke tbl
+'\"
+'\" Separate paragraphs; not the same as PP which resets indent level.
+.de SP
+.if t .sp .5
+.if n .sp
+..
+'\"
+'\" Replacement em-dash for nroff (default is too short).
+.ie n .ds m " -
+.el .ds m \(em
+'\"
+'\" Placeholder macro for if longer nroff arrow is needed.
+.ds RA \(->
+'\"
+'\" Decimal point set slightly raised
+.if t .ds d \v'-.15m'.\v'+.15m'
+.if n .ds d .
+'\"
+'\" Enclosure macro for examples
+.de EX
+.SP
+.nf
+.ft CW
+..
+.de EE
+.ft R
+.SP
+.fi
+..
+.TH opj_compress 1 "Version 2.1.1" "opj_compress" "converts to jpeg2000 files"
+.P
+.SH NAME
+opj_compress \-
+This program reads in an image of a certain type and converts it to a
+jpeg2000 file. It is part of the OpenJPEG library.
+.SP
+Valid input image extensions are
+.B .bmp, .pgm, .pgx, .png, .pnm, .ppm, .raw, .tga, .tif \fR. For PNG resp. TIF it needs libpng resp. libtiff .
+.SP
+Valid output image extensions are
+.B .j2k, .jp2
+.SH SYNOPSIS
+.P
+.B opj_compress \-i \fRinfile.bmp \fB-o \fRoutfile.j2k
+.P
+.B opj_compress \-ImgDir \fRdirectory_name \fB-OutFor \fRjp2
+.P
+.B opj_compress \-h \fRPrint a help message and exit.
+.P
+See JPWL OPTIONS for special options
+.SH OPTIONS
+.TP
+.B \-\^b " n,n"
+(Size of code block (e.g. \-b 32,32). Default: 64 x 64)
+.TP
+.B \-\^c " n"
+(Size of precinct (e.g. \-c 128,128). Default: 2^15 x 2^15)
+.TP
+.B \-\^cinema2K " fps"
+Digital Cinema 2K profile compliant codestream. Valid \fBfps\fR values are 24 or 48.
+.TP
+.B \-\^cinema4K
+Digital Cinema 4K profile compliant codestream. Does not need an fps: default is 24 fps.
+.TP
+.B \-\^d " X,Y"
+(Offset of image origin (e.g. \-d 150,300))
+.TP
+.B \-\^h
+Print a help message and exit.
+.TP
+.B \-\^i " name"
+(input file name)
+.TP
+.B \-\^n " n"
+(Number of resolutions. Default: 6)
+.TP
+.B \-\^o " name"
+(output file name)
+.TP
+.B \-\^p " name"
+Progression order. \fBname\fR can be one out of:LRCP, RLCP, RPCL, PCRL, CPRL. Default: LRCP.
+.TP
+.B \-\^q " n"
+different psnr for successive layers
+.br
+.B Note: \fR(options \-r and \-q cannot be used together)
+.TP
+.B \-\^r " n"
+different compression ratio(s) for successive layers. The rate specified for each quality level is the desired compression factor.
+.br
+.B Note: \fR(options \-r and \-q cannot be used together)
+.TP
+.B \-\^s " X,Y"
+sub-sampling factor (e.g. \-s 2,2). Default: No sub-sampling in x or y direction.
+.br
+.B Remark: \fRsub-sampling bigger than 2 can produce errors.
+.TP
+.B \-\^t " W,H"
+(Size of tile (e.g. \-t 512,512) )
+.TP
+.B \-\^x " name"
+(Create index file and fill it. Default: no index file)
+.TP
+.B \-\^EPH
+(Write EPH marker after each header packet. Default:no EPH)
+.TP
+.B \-\^F " rawWidth,rawHeight,rawComp,rawBitDepth,s_or_u"
+characteristics of the raw input image
+.TP
+.B \-\^I
+(Use the irreversible DWT 9-7. Default: Reversible DWT 5-3)
+.TP
+.B \-\^ImgDir " directory_name"
+(directory containing input files)
+.TP
+.B \-\^M " n"
+mode switch with values: 1, 2, 4, 8, 16, 32. Default:No mode switch activated.
+.br
+\fIMeaning:\fR
+.br
+BYPASS(1)
+.br
+RESET(2)
+.br
+RESTART(4)
+.br
+VSC(8)
+.br
+ERTERM(16)
+.br
+SEGMARK(32)
+.br
+Values can be added: RESTART(4) + RESET(2) + SEGMARK(32) = \-M 38
+.TP
+.B \-\^OutFor "ext"
+(extension for output files)
+.TP
+.B \-\^POC "TtileNr=resolutionStart, componentStart, layerEnd, resolutionEnd, componentEnd, progressionOrder"
+(see Examples)
+.TP
+.B \-\^ROI "c=n,U=n"
+quantization indices upshifted for component c (0 or 1 or 2) with a value of U (>= 0 and <= 37)
+.br
+e.g. \fB-ROI c=0,U=25\fR
+.TP
+.B \-\^SOP
+(Write SOP marker before each packet. Default: No SOP marker in the codestream.)
+.TP
+.B \-\^T "X,Y"
+(Offset of the origin of the tiles (e.g. \-T 100,75) )
+.TP
+.B \-\^W
+(see JPWL OPTIONS)
+.P
+.SH JPWL OPTIONS
+Options usable only if the library has been compiled with \fB-DUSE_JPWL\fR
+.P
+.B \-W h<tilepart><=type>, s<tilepart><=method>, a=<addr>, z=<size>, g=<range>, p<tilepart:pack><=type>
+.P
+.B h\fR selects the header error protection (EPB): \fBtype\fR can be
+ [0=none 1,absent=predefined 16=CRC-16 32=CRC-32 37-128=RS]
+ if \fBtilepart\fR is absent, it is for main and tile headers
+ if \fBtilepart\fR is present, it applies from that tile
+ onwards, up to the next h<> spec, or to the last tilepart
+ in the codestream (max. 16 specs)
+.P
+.B p \fRselects the packet error protection (EEP/UEP with EPBs)
+ to be applied to raw data: \fBtype\fR can be
+ [0=none 1,absent=predefined 16=CRC-16 32=CRC-32 37-128=RS]
+ if \fBtilepart:pack\fR is absent, it is from tile 0, packet 0
+ if \fBtilepart:pack\fR is present, it applies from that tile
+ and that packet onwards, up to the next packet spec
+ or to the last packet in the last tilepart in the stream
+ (max. 16 specs)
+.P
+.B s \fRenables sensitivity data insertion (ESD): \fBmethod\fR can be
+ [\-1=NO ESD 0=RELATIVE ERROR 1=MSE 2=MSE REDUCTION 3=PSNR
+ 4=PSNR INCREMENT 5=MAXERR 6=TSE 7=RESERVED]
+ if \fBtilepart\fR is absent, it is for main header only
+ if \fBtilepart\fR is present, it applies from that tile
+ onwards, up to the next s<> spec, or to the last tilepart
+ in the codestream (max. 16 specs)
+.P
+.B g \fRdetermines the addressing mode: \fBrange\fR can be
+ [0=PACKET 1=BYTE RANGE 2=PACKET RANGE]
+.P
+.B a \fRdetermines the size of data addressing: \fBaddr\fR can be
+ 2/4 bytes (small/large codestreams). If not set, auto-mode
+.P
+.B z \fRdetermines the size of sensitivity values: \fBsize\fR can be
+ 1/2 bytes, for the transformed pseudo-floating point value
+.P
+.SH EXAMPLES
+.P
+.B opj_compress \-i \fRfile.bmp \fB-o \fRfile.j2k \fB-r \fR20,10,1 (compress 20x, then 10x, then lossless).
+.P
+.B opj_compress \-i \fRfile.ppm \fB-o \fRfile.j2k \fB-q \fR30,40,50
+.P
+.B opj_compress \-i \fRfile.pgx \fB-o \fRfile.j2k \fB-POC \fRT1=0,0,1,5,3,CPRL
+.P
+.B opj_compress \-i \fRlena.raw \fB-o \fRlena.j2k \fB-F \fR512,512,3,8,u
+.P
+.SH AUTHORS
+Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+.br
+Copyright (c) 2002-2014, Professor Benoit Macq
+.br
+Copyright (c) 2001-2003, David Janssens
+.br
+Copyright (c) 2002-2003, Yannick Verschueren
+.br
+Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
+.br
+Copyright (c) 2005, Herve Drolon, FreeImage Team
+.br
+Copyright (c) 2006-2007, Parvatha Elangovan
+.P
+.SH "SEE ALSO"
+opj_decompress(1) opj_dump(1)
+
diff --git a/openjpeg/doc/man/man1/opj_decompress.1 b/openjpeg/doc/man/man1/opj_decompress.1
new file mode 100644
index 00000000..ae55f921
--- /dev/null
+++ b/openjpeg/doc/man/man1/opj_decompress.1
@@ -0,0 +1,119 @@
+'\" t
+'\" The line above instructs most `man' programs to invoke tbl
+'\"
+'\" Separate paragraphs; not the same as PP which resets indent level.
+.de SP
+.if t .sp .5
+.if n .sp
+..
+'\"
+'\" Replacement em-dash for nroff (default is too short).
+.ie n .ds m " -
+.el .ds m \(em
+'\"
+'\" Placeholder macro for if longer nroff arrow is needed.
+.ds RA \(->
+'\"
+'\" Decimal point set slightly raised
+.if t .ds d \v'-.15m'.\v'+.15m'
+.if n .ds d .
+'\"
+'\" Enclosure macro for examples
+.de EX
+.SP
+.nf
+.ft CW
+..
+.de EE
+.ft R
+.SP
+.fi
+..
+.TH opj_decompress 1 "Version 2.1.1" "opj_decompress" "converts jpeg2000 files"
+.P
+.SH NAME
+opj_decompress \-
+This program reads in a jpeg2000 image and converts it to another
+image type. It is part of the OpenJPEG library.
+.SP
+Valid input image extensions are
+.B .j2k, .jp2, .j2c, .jpt
+.SP
+Valid output image extensions are
+.B .bmp, .pgm, .pgx, .png, .pnm, .ppm, .raw, .tga, .tif \fR. For PNG resp. TIF it needs libpng resp. libtiff .
+.SH SYNOPSIS
+.P
+.B opj_decompress \-i \fRinfile.j2k \fB-o \fRoutfile.png
+.P
+.B opj_decompress \-ImgDir \fRimages/ \fB-OutFor \fRbmp
+.P
+.B opj_decompress \-h \fRPrint help message and exit
+.P
+See JPWL OPTIONS for special options
+.SH OPTIONS
+.TP
+.B \-\^i "name"
+(jpeg2000 input file name)
+.TP
+.B \-\^l "n"
+n is the maximum number of quality layers to decode. See LAYERS below)
+.TP
+.B \-\^o "name"
+(output file name with extension)
+.TP
+.B \-\^r "n"
+(n is the highest resolution level to be discarded. See REDUCTION below)
+.TP
+.B \-\^x "name"
+(use name as index file and fill it)
+.TP
+.B \-\^ImgDir "directory_name"
+(directory containing input files)
+.TP
+.B \-\^OutFor "ext"
+(extension for output files)
+.P
+.SH JPIP OPTIONS
+Options usable only if the library has been compiled with
+.B BUILD_JPIP
+.TP
+.B -jpip
+Embed index table box into the output JP2 file (compulsory for JPIP)
+.TP
+.B -TP R
+Partition a tile into tile parts of different resolution levels (compulsory for JPT-stream)
+.P
+.SH JPWL OPTIONS
+Options usable only if the library has been compiled with
+.B BUILD_JPWL
+.TP
+.B -W c\fR[=Nc] (Nc is the number of expected components in the codestream; default:3)
+.TP
+.B -W t\fR[=Nt] (Nt is the maximum number of tiles in the codestream; default:8192)
+.TP
+.B -W c\fR[=Nc]\fB, t\fR[=Nt] \fR(same as above)
+.P
+.SH REDUCTION
+Set the number of highest resolution levels to be discarded.
+The image resolution is effectively divided by 2 to the power of the number of discarded levels. The reduce factor is limited by the smallest total number of decomposition levels among tiles.
+.SH TILES
+Set the maximum number of quality layers to decode. If there are less quality layers than the specified number, all the quality layers are decoded.
+.P
+'\".SH BUGS
+.SH AUTHORS
+Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+.br
+Copyright (c) 2002-2014, Professor Benoit Macq
+.br
+Copyright (c) 2001-2003, David Janssens
+.br
+Copyright (c) 2002-2003, Yannick Verschueren
+.br
+Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
+.br
+Copyright (c) 2005, Herve Drolon, FreeImage Team
+.br
+Copyright (c) 2006-2007, Parvatha Elangovan
+.P
+.SH "SEE ALSO"
+opj_compress(1) opj_dump(1)
diff --git a/openjpeg/doc/man/man1/opj_dump.1 b/openjpeg/doc/man/man1/opj_dump.1
new file mode 100644
index 00000000..10b996d0
--- /dev/null
+++ b/openjpeg/doc/man/man1/opj_dump.1
@@ -0,0 +1,62 @@
+'\" t
+'\" The line above instructs most `man' programs to invoke tbl
+'\"
+'\" Separate paragraphs; not the same as PP which resets indent level.
+.de SP
+.if t .sp .5
+.if n .sp
+..
+'\"
+'\" Replacement em-dash for nroff (default is too short).
+.ie n .ds m " -
+.el .ds m \(em
+'\"
+'\" Placeholder macro for if longer nroff arrow is needed.
+.ds RA \(->
+'\"
+'\" Decimal point set slightly raised
+.if t .ds d \v'-.15m'.\v'+.15m'
+.if n .ds d .
+'\"
+'\" Enclosure macro for examples
+.de EX
+.SP
+.nf
+.ft CW
+..
+.de EE
+.ft R
+.SP
+.fi
+..
+.TH opj_dump 1 "Version 2.1.1" "opj_dump" "dumps jpeg2000 files"
+.P
+.SH NAME
+opj_dump \-
+This program reads in a jpeg2000 image and dumps the contents to stdout. It is part of the OpenJPEG library.
+.SP
+Valid input image extensions are
+.B .j2k, .jp2, .jpt
+.SP
+.SH SYNOPSIS
+.P
+.B opj_dump \-i \fRinfile.j2k
+.P
+.B opj_dump \-ImgDir \fRimages/ \fRDump all files in images/
+.P
+.B opj_dump \-h \fRPrint help message and exit
+.P
+.SH OPTIONS
+.TP
+.B \-\^i "name"
+(jpeg2000 input file name)
+.TP
+.B \-\^ImgDir "directory_name"
+(directory containing jpeg2000 input files)
+.P
+'\".SH BUGS
+.SH AUTHORS
+Copyright (c) 2010, Mathieu Malaterre
+.P
+.SH "SEE ALSO"
+opj_compress(1) opj_decompress(1)
diff --git a/openjpeg/doc/man/man3/libopenjp2.3 b/openjpeg/doc/man/man3/libopenjp2.3
new file mode 100644
index 00000000..9b06cc86
--- /dev/null
+++ b/openjpeg/doc/man/man3/libopenjp2.3
@@ -0,0 +1,337 @@
+'\" t
+'\" The line above instructs most `man' programs to invoke tbl
+'\"
+'\" Separate paragraphs; not the same as PP which resets indent level.
+.de SP
+.if t .sp .5
+.if n .sp
+..
+'\"
+'\" Replacement em-dash for nroff (default is too short).
+.ie n .ds m " -
+.el .ds m \(em
+'\"
+'\" Placeholder macro for if longer nroff arrow is needed.
+.ds RA \(->
+'\"
+'\" Decimal point set slightly raised
+.if t .ds d \v'-.15m'.\v'+.15m'
+.if n .ds d .
+'\"
+'\" Enclosure macro for examples
+.de EX
+.SP
+.nf
+.ft CW
+..
+.de EE
+.ft R
+.SP
+.fi
+..
+.TH libopenjp2 3 "Oct 2010" "Version 1.4.0" "Oct 2010"
+.P
+.SH NAME
+libopenjp2 -
+a library for reading and writing JPEG2000 image files.
+.SP
+.SH SYNOPSIS
+.P
+.B #include <openjpeg.h>
+.P
+.SS CONVERSION FORMATS
+.B PGX: imagetopgx() \fR/\fB pgxtoimage()
+.P
+.B PXM: imagetopnm() \fR/\fB pnmtoimage()
+.P
+.B BMP: imagetobmp() \fR/\fB bmptoimage()
+.P
+.B TIF: imagetotif() \fR/\fB tiftoimage()
+.P
+.B RAW: imagetoraw() \fR/\fB rawtoimage()
+.P
+.B TGA: imagetotga() \fR/\fB tgatoimage()
+.P
+.B PNG: imagetopng() \fR/\fB pngtoimage()
+.P
+.B YUV: imagetoyuv() \fR/\fB yuvtoimage() \fR(MJ2)
+.P
+.SS READ
+.B opj_set_default_decoder_parameters(opj_dparameters_t *\fIparams\fB);
+.P
+.B opj_dinfo_t *opj_create_decompress(OPJ_CODEC_FORMAT \fIformat\fB);
+.P
+.B opj_event_mgr_t *opj_set_event_mgr(opj_common_ptr \fIinfo\fB, opj_event_mgr_t *\fIevent_mgr\fB, void *\fIcontext\fB);
+.P
+.B void opj_setup_decoder(opj_dinfo_t *\fIdinfo\fB, opj_dparameters_t * \fIparams\fB);
+.P
+.B opj_cio_t *opj_cio_open(opj_common_ptr \fIinfo\fB, unsigned char *\fIbuf\fB, int \fIbuf_len\fB);
+.P
+.B opj_image_t *opj_decode(opj_dinfo_t *\fIdinfo\fB, opj_cio_t *\fIcio\fB);
+.P
+.B void opj_cio_close(opj_cio_t *\fIcio\fB);
+.P
+.B void opj_destroy_decompress(opj_dinfo_t *\fIdinfo\fB);
+.P
+.B void opj_image_destroy(opj_image_t *\fIimage\fB);
+.P
+.SS WRITE
+.B void opj_set_default_encoder_parameters(opj_cparameters_t *\fIparams\fB);
+.P
+/*
+.B opj_image_t *FORMATtoimage(const char *\fIfname\fB, opj_cparameters_t *\fIparams\fB);
+.P
+*/
+.br
+.B opj_cinfo_t* opj_create_compress(OPJ_CODEC_FORMAT \fIformat\fB);
+.P
+.B opj_event_mgr_t *opj_set_event_mgr(opj_common_ptr \fIinfo\fB, opj_event_mgr_t *\fIevent_mgr\fB, void *\fIcontext\fB);
+.P
+.B void opj_setup_encoder(opj_cinfo_t *\fIcinfo\fB, opj_cparameters_t *\fIparams\fB, opj_image_t *\fIimage\fB);
+.P
+.B opj_cio_t *opj_cio_open(opj_common_ptr \fIcinfo\fB, \fINULL\fB, \fI0\fB);
+.P
+.B bool opj_encode(opj_cinfo_t *\fIcinfo\fB, opj_cio_t *\fIcio\fB, opj_image_t *\fIimage\fB, char *\fIindex\fB);
+.P
+.B void opj_cio_close(opj_cio_t *\fIcio\fB);
+.P
+.B void opj_destroy_compress(opj_cinfo_t *\fIcinfo\fB);
+.P
+.B void opj_image_destroy(opj_image_t *\fIimage\fB);
+.P
+.SS GENERAL
+.P
+.B void opj_image_create(int \fInumcmpts\fB, opj_image_cmptparm_t *\fIcmptparms\fB, OPJ_COLOR_SPACE \fIclrspc\fB);
+.P
+.B int cio_tell(opj_cio_t *\fIcio\fB);
+.P
+.B void cio_seek(opj_cio_t *\fIcio\fB, int \fIpos\fB);
+.P
+.B opj_image_t *opj_decode_with_info(opj_dinfo_t *\fIdinfo\fB, opj_cio_t *\fIcio\fB, opj_codestream_info_t *\fIcstr_info\fB);
+.P
+.B bool opj_encode_with_info(opj_cinfo_t *\fIcinfo\fB, opj_cio_t *\fIcio\fB, opj_image_t *\fIimage\fB, opj_codestream_info_t *\fIcstr_info\fB);
+.P
+.B void opj_destroy_cstr_info(opj_codestream_info_t *\fIcstr_info\fB);
+.P
+.B const char *opj_version(\fIvoid\fB);
+.P
+.SH OPJ_CODEC_FORMAT
+.P
+.B CODEC_J2K\fR or \fBCODEC_JPT\fR or \fBCODEC_JP2
+.P
+.SH OPJ_COLOR_SPACE
+.P
+.B CLRSPC_UNKNOWN\fR or \fBCLRSPC_UNSPECIFIED\fR or \fBCLRSPC_SRGB\fR or \fBCLRSPC_GRAY\fR or \fBCLRSPC_SYCC
+.P
+.SH DECOMPRESSION PARAMETERS
+.p
+typedef struct opj_dparameters
+.br
+{
+ /*
+ Set the number of highest resolution levels to be discarded.
+ The image resolution is effectively divided by 2 to the power
+ of the number of discarded levels.
+ The reduce factor is limited by the smallest total number of
+ decomposition levels among tiles.
+ if != 0, then original dimension divided by 2^(reduce);
+ if == 0 or not used, image is decoded to the full resolution
+ */
+ \fBint\fR cp_reduce;
+ /*
+ Set the maximum number of quality layers to decode.
+ If there are less quality layers than the specified number,
+ all the quality layers are decoded.
+ if != 0, then only the first "layer" layers are decoded;
+ if == 0 or not used, all the quality layers are decoded
+ */
+ \fBint\fR cp_layer;
+
+ /*command line encoder parameters (not used inside the library) */
+ /* input file name */
+ \fBchar\fR infile[OPJ_PATH_LEN];
+ /* output file name */
+ \fBchar\fR outfile[OPJ_PATH_LEN];
+ /* input file format: see OPJ_CODEC_FORMAT */
+ \fBint\fR decod_format;
+ /* output file format */
+ \fBint\fR cod_format;
+
+ /*JPWL decoding parameters */
+ /* activates the JPWL correction capabilities */
+ \fBbool\fR jpwl_correct;
+ /* expected number of components */
+ \fBint\fR jpwl_exp_comps;
+ /* maximum number of tiles */
+ \fBint\fR jpwl_max_tiles;
+
+ /*
+ Specify whether the decoding should be done on the entire
+ codestream, or be limited to the main header
+ Limiting the decoding to the main header makes it possible
+ to extract the characteristics of the codestream
+ if == NO_LIMITATION, the entire codestream is decoded;
+ if == LIMIT_TO_MAIN_HEADER, only the main header is decoded;
+ */
+ \fBOPJ_LIMIT_DECODING\fR cp_limit_decoding;
+.br
+} opj_dparameters_t;
+
+.SH COMPRESSION PARAMETERS
+.P
+typedef struct opj_cparameters
+.br
+{
+ /* size of tile: tile_size_on = false (not in argument)
+ or tile_size_on = true (in argument) */
+ \fBbool\fR tile_size_on;
+ /* XTOsiz */
+ \fBint\fR cp_tx0;
+ /* YTOsiz */
+ \fBint\fR cp_ty0;
+ /* XTsiz */
+ \fBint\fR cp_tdx;
+ /* YTsiz */
+ \fBint\fR cp_tdy;
+ /* allocation by rate/distortion */
+ \fBint\fR cp_disto_alloc;
+ /* allocation by fixed layer */
+ \fBint\fR cp_fixed_alloc;
+ /* add fixed_quality */
+ \fBint\fR cp_fixed_quality;
+ /* fixed layer */
+ \fBint *\fRcp_matrice;
+ /* comment for coding */
+ \fBchar *\fRcp_comment;
+ /* coding style */
+ \fBint\fR csty;
+ /* progression order:
+ PROG_UNKNOWN, LRCP(default), RLCP, RPCL, PCRL, CPRL */
+ \fBOPJ_PROG_ORDER\fR prog_order;
+ /* progression order changes */
+ \fBopj_poc_t\fR POC[32];
+ /* number of progression order changes (POC), default: 0 */
+ \fBint\fR numpocs;
+ /* number of layers */
+ \fBint\fR tcp_numlayers;
+ /* rates of layers */
+ \fBfloat\fR tcp_rates[100];
+ /* different psnr for successive layers */
+ \fBfloat\fR tcp_distoratio[100];
+ /* number of resolutions */
+ \fBint\fR numresolution;
+ /* initial code block width, default: 64 */
+ \fBint\fR cblockw_init;
+ /* initial code block height, default: 64 */
+ \fBint\fR cblockh_init;
+ /* mode switch (cblk_style) */
+ /* 1 : use the irreversible DWT 9-7,
+ 0 : use lossless compression (default) */
+ \fBint\fR irreversible;
+ /* region of interest: affected component in [0..3],
+ -1 means no ROI */
+ \fBint\fR roi_compno;
+ /* region of interest: upshift value */
+ \fBint\fR roi_shift;
+ /* number of precinct size specifications */
+ \fBint\fR res_spec;
+ /* initial precinct width */
+ \fBint\fR prcw_init[J2K_MAXRLVLS];
+ /* initial precinct height */
+ \fBint\fR prch_init[J2K_MAXRLVLS];
+
+ /*command line encoder parameters (not used inside the library) */
+ /* input file name */
+ \fBchar\fR infile[OPJ_PATH_LEN];
+ /* output file name */
+ \fBchar\fR outfile[OPJ_PATH_LEN];
+ /* DEPRECATED. Index generation is now handeld with the
+ opj_encode_with_info() function. Set to NULL */
+ \fBint\fR index_on;
+ /* DEPRECATED. Index generation is now handeld with the
+ opj_encode_with_info() function. Set to NULL */
+ \fBchar\fR index[OPJ_PATH_LEN];
+ /* subimage encoding: origin image offset in x direction */
+ \fBint\fR image_offset_x0;
+ /* subimage encoding: origin image offset in y direction */
+ \fBint\fR image_offset_y0;
+ /* subsampling value for dx */
+ \fBint\fR subsampling_dx;
+ /* subsampling value for dy */
+ \fBint\fR subsampling_dy;
+ /* input file format */
+ \fBint\fR decod_format;
+ /* output file format: see OPJ_CODEC_FORMAT */
+ \fBint\fR cod_format;
+
+ /*JPWL encoding parameters */
+ /* enables writing of EPC in MH, thus activating JPWL */
+ \fBbool\fR jpwl_epc_on;
+ /* error protection method for MH (0,1,16,32,37-128) */
+ \fBint\fR jpwl_hprot_MH;
+ /* tile number of header protection specification (>=0) */
+ \fBint\fR jpwl_hprot_TPH_tileno[JPWL_MAX_NO_TILESPECS];
+ /* error protection methods for TPHs (0,1,16,32,37-128) */
+ \fBint\fR jpwl_hprot_TPH[JPWL_MAX_NO_TILESPECS];
+ /* tile number of packet protection specification (>=0) */
+ \fBint\fR jpwl_pprot_tileno[JPWL_MAX_NO_PACKSPECS];
+ /* packet number of packet protection specification (>=0) */
+ \fBint\fR jpwl_pprot_packno[JPWL_MAX_NO_PACKSPECS];
+ /* error protection methods for packets (0,1,16,32,37-128) */
+ \fBint\fR jpwl_pprot[JPWL_MAX_NO_PACKSPECS];
+ /* enables writing of ESD, (0=no/1/2 bytes) */
+ \fBint\fR jpwl_sens_size;
+ /* sensitivity addressing size (0=auto/2/4 bytes) */
+ \fBint\fR jpwl_sens_addr;
+ /* sensitivity range (0-3) */
+ \fBint\fR jpwl_sens_range;
+ /* sensitivity method for MH (-1=no,0-7) */
+ \fBint\fR jpwl_sens_MH;
+ /* tile number of sensitivity specification (>=0) */
+ \fBint\fR jpwl_sens_TPH_tileno[JPWL_MAX_NO_TILESPECS];
+ /* sensitivity methods for TPHs (-1=no,0-7) */
+ \fBint\fR jpwl_sens_TPH[JPWL_MAX_NO_TILESPECS];
+
+ /* Digital Cinema compliance: OFF-not compliant,
+ CINEMA2K_24, CINEMA2K_48, CINEMA4K_24 */
+ \fBOPJ_CINEMA_MODE\fR cp_cinema;
+ /* Maximum rate for each component.
+ If == 0, component size limitation is not considered */
+ \fBint\fR max_comp_size;
+ /* Profile name*/
+ \fBOPJ_RSIZ_CAPABILITIES\fR cp_rsiz;
+ /* Tile part generation*/
+ \fBchar\fR tp_on;
+ /* Flag for Tile part generation*/
+ \fBchar\fR tp_flag;
+ /* MCT (multiple component transform) */
+ \fBchar\fR tcp_mct;
+.br
+} opj_cparameters_t;
+
+
+'\".SH OPTIONS
+'\".SH BUGS
+.SH AUTHORS
+Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+
+Copyright (c) 2002-2014, Professor Benoit Macq
+
+Copyright (c) 2001-2003, David Janssens
+
+Copyright (c) 2002-2003, Yannick Verschueren
+
+Copyright (c) 2003-2007, Francois-Olivier Devaux and Antonin Descampe
+
+Copyright (c) 2005, Herve Drolon, FreeImage Team
+
+Copyright (c) 2006-2007, Parvatha Elangovan
+
+.P
+.SH "SEE ALSO"
+\fBimage_to_j2k\fR(1) \fBj2k_to_image\fR(1) \fBj2k_dump\fR(1)
+
+\fBJPWL_image_to_j2k\fR(1) \fBJPWL_j2k_to_image\fR(1)
+
+\fBextract_j2k_from_mj2\fR(1) \fBwrap_j2k_in_mj2\fR(1)
+\fBframes_to_mj2\fR(1) \fBmj2_to_frames\fR(1)
diff --git a/openjpeg/doc/openjpip.dox.in b/openjpeg/doc/openjpip.dox.in
new file mode 100644
index 00000000..fd06ee0e
--- /dev/null
+++ b/openjpeg/doc/openjpip.dox.in
@@ -0,0 +1,94 @@
+/*
+ * $Id$
+ *
+ * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+ * Copyright (c) 2002-2014, Professor Benoit Macq
+ * Copyright (c) 2010-2011, Kaori Hagihara
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/*! \page openjpippage OpenJPIP v@OPENJPEG_VERSION@ Documentation
+ *
+ * \section Introduction
+ * This manual documents the low-level OpenJPIP C API.\n
+ * OpenJPIP software is an implementation of JPEG 2000 Part9: Interactivity tools, APIs and protocols (JPIP).\n
+ * ( For more info about JPIP, check the website: http://www.jpeg.org/jpeg2000/j2kpart9.html)\n
+ *
+ * This whole documents covers the following six programs.\n
+ * - opj_server.c JPIP server supporting HTTP connection and JPT/JPP-stream
+ * - opj_dec_server.c Server to decode JPT/JPP-stream and communicate locally with JPIP client, which is coded in java
+ * - opj_jpip_addxml.c To Embed metadata into JP2 file
+ * - opj_jpip_transcode.c To Convert JPT/JPP-stream to JP2 or J2K
+ * - opj_jpip_test.c To test index code format of a JP2 file
+ *
+ * \section License
+ * This software is released under the BSD license, anybody can use or modify the library, even for commercial applications.\n
+ * The only restriction is to retain the copyright in the sources or the binaries documentation.\n
+ * Neither the author, nor the university accept any responsibility for any kind of error or data loss which may occur during usage.
+ *
+ *
+ * \section reqlibs Required libraries
+ * - OpenJPEG library
+ * - FastCGI development kit (C libraries) at server (http://www.fastcgi.com)
+ * - libcURL library
+ *
+ * We tested this software with a virtual server running on the same Linux machine as the clients.
+ *
+ *
+ * \section compilenotes Compiling Notes
+ * When you are making opj_server, set anything (e.g. yes) to the parameter jpipserver to define itself in the Makefile, which enables to make it in server mode.\n
+ * Otherwise do not define (or do not set to) the parameter jpipserver.\n
+ * Be sure that any object files and library file libopenjpip.a are not reused to compile in the two different mode (server mode and non server mode).\n
+ * In other words, do make clean before making new targets which are in different modes as previous make.\n
+ *
+ *
+ * \section sysarchtect System Architecture
+ * JPIP protocol is implemented between the JPIP server program (opj_server) and the JPIP client java program (opj_viewer).\n
+ * Figure below represents the overview of our system architecture.\n
+ * The JPIP server parses JPIP query and sends corresponding JPT/JPP-stream.
+ * The JPIP client viewer is an image viewer with GUI to publish JPIP requests and receive JPT/JPP-stream.\n
+ * Particularly, our system has the image decoding module implemented on a server (opj_dec_server, Image decoding Server).
+ * Image decoding Server and JPIP client viewer communicate closely.
+ * This specific architecture enables sharing cache of image codestream data among all viewers connected to the same Image decoding Server not only locally but also remotely.
+ *
+ * \image html jpip_architect.png "OpenJPIP system architecture"
+ *
+ * JPIP server follows up the client cache during a session. \n
+ * Concretely, the JPIP server models cache in each session, to which Channel IDs are associated.
+ * A Channel ID identifies a JPIP client viewer.
+ * And, new viewers can belong to a session by referring to one of its channel ID.
+ * The Image decoding Server maintains the association between channel IDs and targets, and provides a reference channel ID to a Viewer on demand.\n
+ *
+ * Typical requests and replies among JPIP server, JPIP client, and Image decoding server is presented below.\n
+ * The JPIP server parses HTTP query and sends corresponding JPT/JPP-stream back to the JPIP client (Viewer).
+ * JPT/JPP-stream is unreadable by JPIP client, and it is directly passed to Image decoding Server, and which provides the image in raw format (PGM or PPM) to the JPIP client.
+ * The Image decoding Server handles the decoding and caching of JPT/JPP-stream.
+ * JPIP client can read PGM and PPM images natively.
+ * Before connecting to the JPIP server, every JPIP client checks local cache data of the requesting image with the image decoding server.
+ * If its cache exists, the image decoding server provides ChannelID (CID), which identifies the image and its cache model on the JPIP server, and the whole system can continue the session using the CID.
+ *
+ * \image html jpip_protocol.png "Message Sequence Chart of OpenJPIP implementation"
+ *
+ * \author Kaori Hagihara UCL/SST/ICTM/ELEN
+ */