walkero
/
openjpeg
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
Official repository of the OpenJPEG project
1,693 Commits 24 Branches 23 Tags 132 MiB
C 83.2%
C++ 9.6%
CMake 3.2%
Java 2.6%
Shell 1%
Other 0.3%
Go to file
Mathieu Malaterre 9095c7361e [trunk] Remove old warnings about deprecated API 2014-03-10 14:51:59 +00:00
cmake [trunk] Remove old warnings about deprecated API 2014-03-10 14:51:59 +00:00
doc Doxyfile: HTML_TIMESTAMP = NO 2012-12-07 15:07:50 +00:00
src [trunk] Remove a set of warning about sign conversion 2014-03-10 14:15:27 +00:00
tests [trunk] Run richter test suite, correct a regression introduced in r2668 2014-03-10 13:51:16 +00:00
thirdparty [trunk] use everywhere the new opj_ prefix for HAVE variables and use the opj_apps_config file (thanks to winfried) 2013-03-17 17:03:00 +00:00
wrapping [trunk] Remove some simple warnings about missing prototypes 2012-10-29 13:28:51 +00:00
AUTHORS [trunk]update the copyright, the authors and thanks to respect the license 2012-11-15 15:22:29 +00:00
CMakeLists.txt [trunk] Fix find_path behavior within cross-compilation execution 2014-02-28 08:28:25 +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]update the copyright, the authors and thanks to respect the license 2012-11-15 15:22:29 +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 [trunk]update the copyright, the authors and thanks to respect the license 2012-11-15 15:22:29 +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.