Added Readme file for OPJViewer

2 files changed, 102 insertions, 4 deletions

diff --git a/OPJViewer/OPJViewer.dsp b/OPJViewer/OPJViewer.dsp
index 1ab84c3e..a388b32b 100644
--- a/OPJViewer/OPJViewer.dsp
+++ b/OPJViewer/OPJViewer.dsp
@@ -42,16 +42,15 @@ RSC=rc.exe
 # PROP Ignore_Export_Lib 0

 # PROP Target_Dir ""

 # ADD BASE CPP /nologo /W3 /GX /O2 /D "WIN32" /D "NDEBUG" /D "_CONSOLE" /D "_MBCS" /YX /FD /c

-# ADD CPP /nologo /G6 /MD /GX /O2 /I "c:\programmi\wxWidgets-2.8.0\lib\vc_lib\msw" /I "c:\programmi\wxWidgets-2.8.0\include" /I ".." /D "NDEBUG" /D "WIN32" /D "_CONSOLE" /D "_MBCS" /D "_WINDOWS" /D WINVER=0x400 /D "_MT" /D wxUSE_GUI=1 /D "wxUSE_LIBOPENJPEG" /D "OPJ_STATIC" /D "USE_JPWL" /FR /FD /c

-# SUBTRACT CPP /YX

+# ADD CPP /nologo /G6 /MD /GX /O2 /I "d:\programmi\wxWidgets-2.8.0\lib\vc_lib\msw" /I "d:\programmi\wxWidgets-2.8.0\include" /I ".." /D "NDEBUG" /D "WIN32" /D "_CONSOLE" /D "_MBCS" /D "_WINDOWS" /D WINVER=0x400 /D "_MT" /D wxUSE_GUI=1 /D "wxUSE_LIBOPENJPEG" /D "OPJ_STATIC" /D "USE_JPWL" /FR /FD /c

 # ADD BASE RSC /l 0x410 /d "NDEBUG"

-# ADD RSC /l 0x409 /i "c:\programmi\wxWidgets-2.8.0\include" /d "NDEBUG"

+# ADD RSC /l 0x409 /i "d:\programmi\wxWidgets-2.8.0\include" /d "NDEBUG"

 BSC32=bscmake.exe

 # ADD BASE BSC32 /nologo

 # ADD BSC32 /nologo

 LINK32=link.exe

 # ADD BASE LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib odbc32.lib odbccp32.lib /nologo /subsystem:console /machine:I386

-# ADD LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib odbc32.lib odbccp32.lib comctl32.lib rpcrt4.lib wsock32.lib wxzlib.lib wxregex.lib wxpng.lib wxjpeg.lib wxbase28.lib wxmsw28_core.lib wxmsw28_html.lib wxmsw28_adv.lib wxmsw28_core.lib wxbase28.lib wxtiff.lib wxjpeg.lib wxpng.lib wxzlib.lib wxregex.lib wxexpat.lib LibOpenJPEG_JPWL.lib /nologo /subsystem:windows /machine:I386 /nodefaultlib:"libcmt.lib" /libpath:"c:\programmi\wxWidgets-2.8.0\lib\vc_lib" /libpath:"..\jpwl\Release" /IGNORE:4089

+# ADD LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib odbc32.lib odbccp32.lib comctl32.lib rpcrt4.lib wsock32.lib wxzlib.lib wxregex.lib wxpng.lib wxjpeg.lib wxbase28.lib wxmsw28_core.lib wxmsw28_html.lib wxmsw28_adv.lib wxmsw28_core.lib wxbase28.lib wxtiff.lib wxjpeg.lib wxpng.lib wxzlib.lib wxregex.lib wxexpat.lib LibOpenJPEG_JPWL.lib /nologo /subsystem:windows /machine:I386 /nodefaultlib:"libcmt.lib" /libpath:"d:\programmi\wxWidgets-2.8.0\lib\vc_lib" /libpath:"..\jpwl\Release" /IGNORE:4089

 # SUBTRACT LINK32 /pdb:none

 

 !ELSEIF  "$(CFG)" == "OPJViewer - Win32 Debug"

diff --git a/OPJViewer/Readme.txt b/OPJViewer/Readme.txt
new file mode 100644
index 00000000..58232d82
--- /dev/null
+++ b/OPJViewer/Readme.txt
@@ -0,0 +1,99 @@
+===============================================================================
+

+	JPEG2000 Visualization Software
+
+ - OPJViewer

+

+		Version 0.1 alpha

+
+===============================================================================
+
+
+

+

+

+1. Scope

+=============

+

+This document describes the installation and use of the OPJViewer in the framework of OpenJPEG library.

+

+This implementation has been developed using the OpenJPEG library as decoding engine and wxWidgets 2.8.0 as GUI engine.

+

+If you find some bugs or if you have problems using the encoder/decoder, please send an e-mail to jpwl@diei.unipg.it
+

+

+2. Installing the viewer

+==========================

+

+There are two available options, at the moment: a) compile from source code, and b) download a precompiled binary. In order to perform option a), it is mandatory to have compiled and built the LibOpenJPEG_JPWL library and the wxWidgets 2.8.0 framework (you have to download it from http://www.wxwidgets.org/ and compile the wx* libraries).

+

+2.1. Compiling the source code in Windows

+-------------------------------------------

+

+These are the steps required to compile the viewer under windows.

+

+a) Download at least the libonjpeg, jpwl, and opjviewer folders from the SVN trunk.

+b) Open the OPJViewer.dsw workspace with Visual C++ 6 and activate the "OPJViewer - Win32 Release" configuration.

+c) In the configuration settings, go to the C++ tab and modify the wxWidgets paths in order to reflect your wx* install configuration (Preprocessor -> Additional include directories): simply update each instance of the two wx paths, do not remove or add them.

+d) In the configuration settings, go to the Link tab and modify the wxWidgets path in order to reflect your wx* install configuration (Input -> Additional library path): simply update the wx path.

+e) In the configuration settings, go to the Resources tab and modify the wxWidgets path in order to reflect your wx* install configuration (Additional resource include directories): simply update the wx path.

+f) Build!

+g) Run!

+h) (OPTIONAL) Prepare an installer by compiling the InnoSetup script OPJViewer.iss (you need to download it from http://www.jrsoftware.org/isinfo.php).

+

+2.2. Compiling the source code in Unix-like systems

+-----------------------------------------------------

+

+The porting is possible and under way.

+

+

+3. General information on the viewer

+====================================

+

+This viewer is conceived to open and display information and image of J2K, JP2, and MJ2 files.

+The viewer application graphical interface is divided into three main panels:

+- a browsing pane;

+- a viewing pane;

+- a log/peek pane.

+

+The browsing pane will present the markers or boxes hierarchy, with position (byte number where marker/box starts and stops) and length information (i.e., inner length as signalled by marker/box and total length, with marker/box sign included), in the following form:

+

+filename

+|

+|_ #000: Marker/Box short name (Hex code)

+|  |

+|  |_ *** Marker/Box long name ***

+|  |_ startbyte > stopbyte, inner_length + marker/box sign length (total length)

+|  |_ Additional info, depending on the marker/box type

+|  |_ ...

+|

+|_ #001: Marker/Box short name (Hex code)

+|  |

+|  |_ ...

+|

+...

+

+

+The viewing pane will display the decoded image contained in the JPEG 2000 file.

+It should display correctly images as large as 4000x2000, provided that a couple of GB of RAM are available. Nothing is known about the display of larger sizes: let us know if you manage to get it working.

+

+

+The log/peek pane is shared among two different subpanels:

+

+- the log panel will report a lot of debugging info coming out from the wx GUI as well as from the openjpeg library

+- the peek pane tries to give a peek on the codestream/file portion which is currently selected in the browsing pane. It shows both hex and ascii values corresponding to the marker/box section. 

+

+

+4. Known bugs and limitations

+===============================

+

+4.1. Bugs

+-----------

+

+* 

+

+4.2. Limitations

+------------------

+

+* For mj2 files, only the first frame is displayed, and only in B/W

+* There is no zooming function