Official repository of the OpenJPEG project
Go to file
Even Rouault e7640f58f1
Merge pull request #1168 from Young-X/fix_dev
Fix multiple potential vulnerabilities and bugs
2018-12-07 21:27:38 +01:00
cmake The change makes a relative path to header files 2018-08-31 12:57:40 +02:00
doc Some Doxygen tags are removed 2018-01-07 17:11:09 +01:00
scripts Reformat: apply reformattin on .h files (#128) 2017-05-15 12:21:30 +02:00
src Merge pull request #1168 from Young-X/fix_dev 2018-12-07 21:27:38 +01:00
tests Add test cases for https://github.com/uclouvain/openjpeg/issues/1120 and https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=2785 2018-06-20 15:28:53 +02:00
thirdparty Fix some typos in code comments and documentation 2018-09-05 20:01:10 +02:00
tools Update knownfailures- files given current configurations 2018-09-22 21:56:50 +02:00
wrapping Spelling fixes (patch by ka7, #890, rebased on top of master) 2017-07-26 21:06:38 +02:00
.gitignore Add mechanisms to reformant and check code style (#128) 2017-05-09 20:46:16 +02:00
.travis.yml Update knownfailures- files given current configurations 2018-09-22 21:56:50 +02:00
AUTHORS.md Update AUTHORS.md 2016-07-05 16:40:27 +02:00
CHANGELOG.md Fixed typos 2018-02-09 21:02:25 +11:00
CMakeLists.txt CMakeLists.txt: turn BUILD_PKGCONFIG_FILES ON by default on Windows if compiler is GCC 2017-10-14 22:42:12 +02:00
CTestConfig.cmake fixed CTest configuration files 2011-06-30 13:52:23 +00:00
INSTALL.md Add -DBUILD_PKGCONFIG_FILES to install instructions 2018-08-11 16:59:30 -04: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.md Update NEWS.md 2017-10-03 17:48:44 -03:00
README.md Add mechanisms to reformant and check code style (#128) 2017-05-09 20:46:16 +02:00
THANKS.md Update THANKS.md 2016-10-03 23:47:10 +02:00
appveyor.yml Preparing v2.3.0 release 2017-10-03 17:08:30 -03:00

README.md

OPENJPEG Library and Applications

What is OpenJPEG ?

OpenJPEG is an open-source JPEG 2000 codec written in C language. It has been developed in order to promote the use of JPEG 2000, a still-image compression standard from the Joint Photographic Experts Group (JPEG). Since April 2015, it is officially recognized by ISO/IEC and ITU-T as a JPEG 2000 Reference Software.

Who can use the code ?

badge-license

Anyone. As the OpenJPEG code is released under the BSD 2-clause "Simplified" License, anyone can use or modify the code, even for commercial applications. The only restriction is to retain the copyright in the sources or in the binaries documentation. Of course, if you modified the code in a way that might be of interest for other users, you are encouraged to share it (through a github pull request or by filling an issue) but this is not a requirement.

How to install and use OpenJPEG ?

API Documentation needs a major refactoring. Meanwhile, you can check installation instructions and codec documentation.

Current Status

badge-build

badge-msvc-build

badge-coverity

Who are the developers ?

The library is developed and maintained by the Image and Signal Processing Group (ISPGroup), in the Université catholique de Louvain (UCL, with the support of the CNES, the CS company and the intoPIX company. The JPWL module has been developed by the Digital Signal Processing Lab (DSPLab) of the University of Perugia, Italy (UNIPG).

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 openjpeg-data repository.
  • cmake: cmake related files
  • scripts: scripts for developers

See LICENSE for license and copyright information.

See INSTALL for installation procedures.

See NEWS for user visible changes in successive releases.

API/ABI

An API/ABI timeline is automatically updated here.

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 mechanism 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/hiding function and as such the only API available is the one supported by OpenJPEG.