Official repository of the OpenJPEG project
Go to file
Eharve14 a0b7102434 Style part two 2022-01-13 13:02:57 -05:00
.github/workflows Added support for high throughput (HTJ2K) decoding. 2021-09-25 12:26:59 +02:00
cmake cmake/OpenJPEGConfig.cmake: replace ABSOLUTE by REALPATH 2021-01-07 14:11:26 +01:00
doc Set ${OPENJPEG_INSTALL_DOC_DIR} to DESTINATION of HTMLs 2020-12-14 23:00:04 +09:00
scripts Added support for high throughput (HTJ2K) decoding. 2021-09-25 12:26:59 +02:00
src Style part two 2022-01-13 13:02:57 -05:00
tests opj_compress: add a -TargetBitDepth switch for TIFF output (#1384) 2021-10-27 14:10:50 +02:00
thirdparty Fix some typos (found by codespell) 2021-12-05 13:14:33 +01:00
tools Added support for high throughput (HTJ2K) decoding. 2021-09-25 12:26:59 +02:00
wrapping Remove obsolete components JPWL, JP3D and MJ2 2021-05-04 19:21:45 +02:00
.gitignore Add mechanisms to reformant and check code style (#128) 2017-05-09 20:46:16 +02:00
.travis.yml .travis.yml: try to fix gcc 4.8 config by updating to xenial 2021-06-07 15:43:05 +02:00
AUTHORS.md Update AUTHORS.md 2016-07-05 16:40:27 +02:00
CHANGELOG.md A couple typos found by codespell 2021-08-12 12:12:22 +03:00
CMakeLists.txt Fix some typos (found by codespell) 2021-12-05 13:14:33 +01:00
CTestConfig.cmake fixed CTest configuration files 2011-06-30 13:52:23 +00:00
HOWTO-RELEASE Add HOWTO-RELEASE 2020-12-29 15:34:19 +01: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 Fix year in NEWS 2020-12-28 22:52:34 +01:00
README.md README.md: update badge to github action workflows [ci skip] 2021-09-26 12:49:05 +02:00
THANKS.md Update THANKS.md 2016-10-03 23:47:10 +02:00
appveyor.yml appveyor.yml: disable deploy 2021-09-12 11:18:14 +02: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)
      • openjpip: complete client-server architecture for remote browsing of jpeg 2000 images.
    • bin: contains all applications that use the openjpeg library
      • common: common files to all applications
      • jp2: a basic codec
      • jpip: OpenJPIP applications (server and dec server)
        • java: a Java client viewer for JPIP
      • 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.

Deprecated components

The openjpwl, openjp3d and openmj2 components have been removed after the 2.4.0 release. Their building and working state is unknown. People interested in them should start from the 2.4.0 tag.

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.