im.format_ecw source code

1 /** \file
2  * \brief Register the ECW Format
3  *
4  * See Copyright Notice in im_lib.d
5  */
6 
7 module im.format_ecw;
8 
9 extern (C) @safe nothrow:
10 
11 /** \defgroup ecw ECW - ECW JPEG 2000
12  * \section Description
13  *
14  * \par
15  * ECW JPEG 2000 Copyright 1998 Earth Resource Mapping Ltd.
16  * Two formats are supported with this module. The ECW (Enhanced Compression Wavelet) format and the ISO JPEG 2000 format.
17  * \par
18  * Access to the ECW format uses the ECW JPEG 2000 SDK version 3.3.
19  * Available in Windows, Linux and Solaris Only. But source code is also available. \n
20  * You must link the application with "im_ecw.lib"
21  * and you must call the function \ref imFormatRegisterECW once
22  * to register the format into the IM core library. \n
23  * Depends also on the ECW JPEG 2000 SDK libraries (NCSEcw.lib).
24  * \par
25  * When using other JPEG 2000 libraries the first registered library will be used to guess the file format.
26  * Use the extension *.ecw to shortcut to this implementation of the JPEG 2000 format.
27  * \par
28  * See \ref im_format_ecw.h
29  * \par
30  * \par
31  * http://www.ermapper.com/ecw/ \n
32  * The three types of licenses available for the ECW JPEG 2000 SDK are as follows:
33 \verbatim
34    - ECW JPEG 2000 SDK Free Use License Agreement - This license governs the free use of
35      the ECW JPEG 2000 SDK with Unlimited Decompression and Limited Compression (Less
36      than 500MB).
37    - ECW JPEG 2000 SDK Public Use License Agreement - This license governs the use of the
38      ECW SDK with Unlimited Decompression and Unlimited Compression for applications
39      licensed under a GNU General Public style license.
40    - ECW JPEG 2000 SDK Commercial Use License Agreement - This license governs the use
41      of the ECW JPEG 2000 SDK with Unlimited Decompression and Unlimited Compression
42      for commercial applications.
43 \endverbatim
44  *
45  * \section Features
46  *
47 \verbatim
48     Data Types: Byte, Short, UShort, Float
49     Color Spaces: BINARY, GRAY, RGB, YCBCR
50     Compressions:
51       ECW - Enhanced Compression Wavelet
52       JPEG-2000 - ISO JPEG 2000
53     Only one image.
54     Can have an alpha channel
55     Internally the components are always packed.
56     Lines arranged from top down to bottom.
57     Handle() returns NCSFileView* when reading, NCSEcwCompressClient* when writing.
58 
59     Attributes:
60       CompressionRatio   IM_FLOAT (1) [example: Ratio=7 just like 7:1]
61       OriginX, OriginY   IM_FLOAT (1)
62       Rotation           IM_FLOAT (1)
63       CellIncrementX, CellIncrementY    IM_FLOAT (1)
64       CellUnits (string)
65       Datum (string)
66       Projection (string)
67       ViewWidth, ViewHeight                    IM_INT (1)    [view zoom]
68       ViewXmin, ViewYmin, ViewXmax, ViewYmax   IM_INT (1)    [view limits]
69       MultiBandCount IM_USHORT (1)    [Number of bands in a multiband gray image.]
70       MultiBandSelect IM_USHORT (1)   [Band number to read one band of a multiband gray image. Must be set before reading image info.]
71 
72     Comments:
73       Only read support is implemented.
74       To read a region of the image you must set the View* attributes before reading the image data.
75       After reading a partial image the width and height returned in ReadImageInfo is the view size.
76       The view limits define the region to be read.
77       The view size is the actual size of the image, so the result can be zoomed.
78 \endverbatim
79  * \ingroup format */
80 
81 /** Register the ECW Format
82  * \ingroup ecw */
83 void imFormatRegisterECW();
84