1 ========================================================================
2 OpenJPIP software 2.0 ReadMe
5 http://www.openjpeg.org
11 ========================================================================
16 3. System requirements
17 4. Implementing instructions
18 5. JP2 encoding instructions
25 OpenJPIP software is an implementation of JPEG 2000 Part9: Interactivity tools, APIs and protocols (JPIP).
26 ( For more info about JPIP, check the website: http://www.jpeg.org/jpeg2000/j2kpart9.html)
27 The current implementation uses some results from the 2KAN project (http://www.2kan.org).
29 First Version 2.0 covers:
30 - JPT-stream (Tile) and JPP-stream (Precinct) media types
31 - Session, channels, cache model managements
33 - Indexing JPEG 2000 files
34 - Embedding XML formatted metadata
35 - Region Of Interest (ROI) requests
41 This software is released under the BSD license, anybody can use or modify the library, even for commercial applications.
42 The only restriction is to retain the copyright in the sources or the binaries documentation.
43 Neither the author, nor the university accept any responsibility for any kind of error or data loss which may occur during usage.
46 3. System requirements
49 - OpenJPEG library (currently assumes it is installed on the system => will not use the one built higher in the directory structure)
50 - FastCGI development kit (C libraries) at server (http://www.fastcgi.com)
51 - Java application launcher at client
53 - Xerces2 java XML parser on the client for accessing embedded image metadata (http://xerces.apache.org/xerces2-j)
55 We tested this software with a virtual server running on the same Linux machine as the clients.
58 4. Building instructions
61 A Makefile is available in the same directory as this README file. Simply type 'make' and it will build all the required C-executables.
62 Concerning the java-based opj_viewer, simply type 'ant' in the corresponding directory (requires 'ant' utility of course)
64 The documentation can be build this way (requires doxygen utility):
73 * HTML documentation is available at http://www.openjpeg.org/jpip/doc/html
74 * Example image is available at http://www.openjpeg.org/jpip/data/copenhague1.zip (20 Mb !)
77 You need a webserver running with the fastcgi module enabled and correctly configured.
78 For Apache, add the following line to your /etc/apache2/mods-available/fastcgi.conf configuration file:
80 FastCGIExternalServer /var/www/myFCGI -host localhost:3000
82 where /var/www is your DocumentRoot.
83 Please refer to 'http://www.openjpeg.org/jpip/doc/ApacheFastCGITutorial.pdf' for more details.
86 1. Store JP2 files in the same directory as opj_server
88 2. Launch opj_server from the server terminal:
89 % spawn-fcgi -f ./opj_server -p 3000 -n
91 For shutting down JPIP server:
92 %GET http://hostname/myFCGI?quitJPIP
93 Notice, http://hostname/myFCGI is the HTTP server URI (myFCGI refers to opj_server by the server setting)
94 Request message "quitJPIP" can be changed in Makefile, modify -DQUIT_SIGNAL=\"quitJPIP\"
97 1. Launch image decoding server, and keep it alive as long as image viewers are open
100 You might prefer to implement this program from another directory since cache files are saved in the working directory.
105 2. Open image viewers (as many as needed)
106 % java -jar opj_viewer.jar http://hostname/myFCGI JP2_filename.jp2 [stateless/session] [jptstream/jppstream]
108 - http://hostname/myFCGI is the HTTP server URI (myFCGI refers to opj_server by the server setting)
109 - JP2_filename.jp2 is the name of a JP2 file available on the server.
110 - request type stateless for no caching, session (default) for caching
111 - return media type, JPT-stream tile based stream, or JPP-stream (default) precinct based stream
112 Image viewer GUI instructions:
113 Scale up request: Enlarge the window
114 ROI request: Select a region by mouse click and drag, then click inside the red frame of the selected region
115 <If Xerces2 is installed>
116 % java -jar opj_viewer_xerces.jar http://hostname/myFCGI JP2_filename.jp2
117 Annotate image with ROI information in XML metadata: Click button "Region Of Interest"
118 Open a new window presenting an aligned image with a locally stored image: Click button "Image Registration" (Under Construction)
120 3. Quit the image decoding server through the telnet, be sure all image viewers are closed
121 % telnet localhost 5000
125 5. JP2 encoding instructions
128 An example to encode a TIF image "copenhague1.tif" at resolution 4780x4050, 8bit/pixel, grayscale.
129 % ./image_to_j2k -i copenhague1.tif -o copenhague1.jp2 -p RPCL -c [64,64] -t 640,480 -jpip -TP R
132 -jpip : embed index table box into the output JP2 file (obligation for JPIP)
133 -TP R : partition a tile into tile parts of different resolution levels (obligation for JPT-stream)
136 3. Embed metadata into JP2 file
137 % ./addXMLinJP2 copenhague1.jp2 copenhague1.xml
138 Input metadata file "copenhague1.xml" looks like:
140 <roi name="island" x="1890" y="1950" w="770" h="310"/>
141 <roi name="ship" x="750" y="330" w="100" h="60"/>
142 <roi name="airport" x="650" y="1800" w="650" h="800"/>
143 <roi name="harbor" x="4200" y="1650" w="130" h="130"/>
144 <irt refimg="name1.jp2" m1="0.50" m2="-0.50" m3="0" m4="0.80" m5="-0.80" m6="0" m7="500" m8="1000" m9="0"/>