]> granicus.if.org Git - openjpeg/commitdiff
Added Readme file for OPJViewer
authorGiuseppe Baruffa <gbaruffa@users.noreply.github.com>
Fri, 23 Feb 2007 08:59:46 +0000 (08:59 +0000)
committerGiuseppe Baruffa <gbaruffa@users.noreply.github.com>
Fri, 23 Feb 2007 08:59:46 +0000 (08:59 +0000)
OPJViewer/OPJViewer.dsp
OPJViewer/Readme.txt [new file with mode: 0644]

index 1ab84c3e2c5b9272372fee99aa89093c939a35b8..a388b32b971f8825482ff63afcc8b7b20e4c6f8a 100644 (file)
@@ -42,16 +42,15 @@ RSC=rc.exe
 # PROP Ignore_Export_Lib 0\r
 # PROP Target_Dir ""\r
 # ADD BASE CPP /nologo /W3 /GX /O2 /D "WIN32" /D "NDEBUG" /D "_CONSOLE" /D "_MBCS" /YX /FD /c\r
-# 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\r
-# SUBTRACT CPP /YX\r
+# 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\r
 # ADD BASE RSC /l 0x410 /d "NDEBUG"\r
-# ADD RSC /l 0x409 /i "c:\programmi\wxWidgets-2.8.0\include" /d "NDEBUG"\r
+# ADD RSC /l 0x409 /i "d:\programmi\wxWidgets-2.8.0\include" /d "NDEBUG"\r
 BSC32=bscmake.exe\r
 # ADD BASE BSC32 /nologo\r
 # ADD BSC32 /nologo\r
 LINK32=link.exe\r
 # 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\r
-# 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\r
+# 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\r
 # SUBTRACT LINK32 /pdb:none\r
 \r
 !ELSEIF  "$(CFG)" == "OPJViewer - Win32 Debug"\r
diff --git a/OPJViewer/Readme.txt b/OPJViewer/Readme.txt
new file mode 100644 (file)
index 0000000..58232d8
--- /dev/null
@@ -0,0 +1,99 @@
+===============================================================================
+\r
+       JPEG2000 Visualization Software
+
+ - OPJViewer\r
+\r
+               Version 0.1 alpha\r
+
+===============================================================================
+
+
+\r
+\r
+\r
+1. Scope\r
+=============\r
+\r
+This document describes the installation and use of the OPJViewer in the framework of OpenJPEG library.\r
+\r
+This implementation has been developed using the OpenJPEG library as decoding engine and wxWidgets 2.8.0 as GUI engine.\r
+\r
+If you find some bugs or if you have problems using the encoder/decoder, please send an e-mail to jpwl@diei.unipg.it
+\r
+\r
+2. Installing the viewer\r
+==========================\r
+\r
+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).\r
+\r
+2.1. Compiling the source code in Windows\r
+-------------------------------------------\r
+\r
+These are the steps required to compile the viewer under windows.\r
+\r
+a) Download at least the libonjpeg, jpwl, and opjviewer folders from the SVN trunk.\r
+b) Open the OPJViewer.dsw workspace with Visual C++ 6 and activate the "OPJViewer - Win32 Release" configuration.\r
+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.\r
+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.\r
+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.\r
+f) Build!\r
+g) Run!\r
+h) (OPTIONAL) Prepare an installer by compiling the InnoSetup script OPJViewer.iss (you need to download it from http://www.jrsoftware.org/isinfo.php).\r
+\r
+2.2. Compiling the source code in Unix-like systems\r
+-----------------------------------------------------\r
+\r
+The porting is possible and under way.\r
+\r
+\r
+3. General information on the viewer\r
+====================================\r
+\r
+This viewer is conceived to open and display information and image of J2K, JP2, and MJ2 files.\r
+The viewer application graphical interface is divided into three main panels:\r
+- a browsing pane;\r
+- a viewing pane;\r
+- a log/peek pane.\r
+\r
+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:\r
+\r
+filename\r
+|\r
+|_ #000: Marker/Box short name (Hex code)\r
+|  |\r
+|  |_ *** Marker/Box long name ***\r
+|  |_ startbyte > stopbyte, inner_length + marker/box sign length (total length)\r
+|  |_ Additional info, depending on the marker/box type\r
+|  |_ ...\r
+|\r
+|_ #001: Marker/Box short name (Hex code)\r
+|  |\r
+|  |_ ...\r
+|\r
+...\r
+\r
+\r
+The viewing pane will display the decoded image contained in the JPEG 2000 file.\r
+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.\r
+\r
+\r
+The log/peek pane is shared among two different subpanels:\r
+\r
+- the log panel will report a lot of debugging info coming out from the wx GUI as well as from the openjpeg library\r
+- 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. \r
+\r
+\r
+4. Known bugs and limitations\r
+===============================\r
+\r
+4.1. Bugs\r
+-----------\r
+\r
+* \r
+\r
+4.2. Limitations\r
+------------------\r
+\r
+* For mj2 files, only the first frame is displayed, and only in B/W\r
+* There is no zooming function\r