Official repository of the OpenJPEG project
Go to file
Hildeberto Mendonça 79b079bdc0 Update README.md 2015-06-13 15:39:03 +02: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] Fix offset computations in opj_j2k_update_image_data 2015-06-03 20:56:13 +00:00
tests [trunk] Fix overflow in opj_image_comp_header_update (fixes issue 495) 2015-05-27 23:05:16 +00:00
thirdparty [trunk] Fixed compilation error under Visual Studio 2003 (fixes issue 351) 2014-12-09 05:44:55 +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] removed warnings when configuring with CMake 3.x on MacOS (fixes issue 443) 2014-11-25 23:57:37 +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.md Update README.md 2015-06-13 15:39:03 +02:00
THANKS [trunk] add Aaron Boxer as contributor 2014-10-22 23:01:04 +00:00

README.md

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.

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.