openjpeg

Official repository of the OpenJPEG project

c jpeg2000 openjpeg reference reference-implementation

Go to file

Mathieu Malaterre b08135e7c1 [trunk] Finalize API for openjpeg 2.1 public header will only contains minimal information: major, minor and build version Prefix has been changed from OPENJPEG to OPJ for consistency SOVERSION has been removed from header (ABI vs API info) OPJ_VERSION string has been removed, since it is accessible already (PACKAGE_VERSION) Fixes issue 342		2014-04-28 09:17:31 +00:00
cmake	[trunk] Properly copy/paste code from the autotools	2014-03-27 15:07:58 +00:00
doc	[trunk] updated copyright and added copyright notice required by ISO, in each file; updated AUTHORS, NEWS	2014-04-03 15:30:57 +00:00
src	[trunk] Finalize API for openjpeg 2.1	2014-04-28 09:17:31 +00:00
tests	[trunk]Replaced deprecated opj_stream_set_user_data function from API	2014-04-23 07:46:11 +00:00
thirdparty	[trunk] removed debug message in CMakeLists.txt	2014-04-02 16:37:07 +00:00
wrapping	[trunk] updated copyright and added copyright notice required by ISO, in each file; updated AUTHORS, NEWS	2014-04-03 15:30:57 +00:00
AUTHORS	[trunk] updated copyright and added copyright notice required by ISO, in each file; updated AUTHORS, NEWS	2014-04-03 15:30:57 +00:00
CMakeLists.txt	[trunk] properly handle pkg-config on non-UNIX hosts	2014-04-28 07:34:26 +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] updated copyright and added copyright notice required by ISO, in each file; updated AUTHORS, NEWS	2014-04-03 15:30:57 +00:00
NEWS	[trunk] fixed typo in NEWS	2014-04-27 21:31:32 +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.