generic-library/openjpeg
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
1,371 Commits 17 Branches 17 Tags 52 MiB
C 87.4%
C++ 7%
CMake 2.5%
Java 2%
Tcl 0.6%
Other 0.4%
759be64115
Go to file
Mathieu Malaterre 759be64115 [trunk] Fix remainings issues with doxygen doc 
Convert DOS files to UNIX eol
2012-10-29 14:35:11 +00:00
cmake [trunk] Requires CMake 2.8.2 at least 2012-10-01 14:18:20 +00:00
doc [trunk] Fix remainings issues with doxygen doc 2012-10-29 14:35:11 +00:00
src [trunk] Fix remainings issues with doxygen doc 2012-10-29 14:35:11 +00:00
tests [trunk] Remove some warnings about missing prototypes (gcc) 2012-10-15 15:47:56 +00:00
thirdparty [trunk] FolderReorgProposal task: Fix doxygen 2012-10-01 08:30:04 +00:00
wrapping [trunk] Remove some simple warnings about missing prototypes 2012-10-29 13:28:51 +00:00
AUTHORS added NEWS, AUTHORS and THANKS files. Cosmetic changes in autotools files (in trunk) 2011-08-16 13:25:42 +00:00
CMakeLists.txt [trunk] Fix java binding installation 2012-10-22 10:41:44 +00:00
CTestConfig.cmake fixed CTest configuration files 2011-06-30 13:52:23 +00:00
INSTALL [trunk] FolderReorgProposal task: update install instruction 2012-10-01 07:59:48 +00:00
LICENSE [trunk] Backport toplevel files from 1.5 2012-03-02 09:26:15 +00:00
NEWS [trunk] FolderReorgProposal task. Do not rebuild doxygen always 2012-10-01 09:37:19 +00:00
README [trunk] Add documentation for stable API/ABI and gcc flags on UNIX 2012-10-25 08:44:27 +00:00
THANKS INSTALL and THANKS files update 2011-08-22 09:59:03 +00:00

README 

OPENJPEG LIBRARY and APPLICATIONS
----------------------------------

Details on folders hierarchy:

* src
  * lib
    * openjp2: contains the sources of the openjp2 library (Part 1 & 2)
    * openjpwl: contains the additional sources if you want to build a JPWL-flavoured library.
    * openjpip: complete client-server architecture for remote browsing of jpeg 2000 images.
    * openjp3d: JP3D implementation
    * openmj2: MJ2 implementation
  * bin: contains all applications that use the openjpeg library
    * common: common files to all applications
    * jp2: a basic codec
    * mj2: motion jpeg 2000 executables
    * jpip: OpenJPIP applications (server and dec server)
      * java: a Java client viewer for JPIP
    * jp3d: JP3D applications
      * tcltk: a test tool for JP3D
    * wx
      * OPJViewer: gui for displaying j2k files (based on wxWidget)
* wrapping
  * java: java jni to use openjpeg in a java program
* thirdparty: thirdparty libraries used by some applications. These libraries will be built only if there are not found on the system. Note that libopenjpeg itself does not have any dependency.
* doc: doxygen documentation setup file and man pages
* tests: configuration files and utilities for the openjpeg test suite. All test images are located in 'http://openjpeg.googlecode.com/svn/data' folder.
* cmake: cmake related files

see LICENSE for license and copyright information.
see INSTALL for installation procedures.
see NEWS for user visible changes in successive releases.
see CHANGES for per-revision changes.

----------------
API/ABI

OpenJPEG strives to provide a stable API/ABI for your applications. As such it
only exposes a limited subset of its functions.  It uses a mecanism of
exporting/hiding functions. If you are unsure which functions you can use in
your applications, you should compile OpenJPEG using something similar to gcc:
-fvisibility=hidden compilation flag.
See also: http://gcc.gnu.org/wiki/Visibility

On windows, MSVC directly supports export/hidding function and as such the only
API available is the one supported by OpenJPEG.