README.md

   1
   2 # OPENJPEG Library and Applications
   3
   4 ## What is OpenJPEG ?
   5
   6 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](http://www.jpeg.org/jpeg2000), a still-image compression standard from the Joint Photographic Experts Group ([JPEG](http://www.jpeg.org)).  Since April 2015, it is officially recognized by ISO/IEC and ITU-T as a [JPEG 2000 Reference Software](http://www.itu.int/rec/T-REC-T.804-201504-I!Amd2).
   7
   8 ## Who can use the code ?
   9 [![badge-license]][link-license]
  10
  11 Anyone. As the OpenJPEG code is released under the [BSD 2-clause "Simplified" License][link-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](https://github.com/uclouvain/openjpeg/pulls) or by filling an [issue](https://github.com/uclouvain/openjpeg/issues)) but this is not a requirement.
  12
  13 ## How to install and use OpenJPEG ?
  14 API Documentation needs a major refactoring. Meanwhile, you can check [installation](https://github.com/uclouvain/openjpeg/wiki/Installation) instructions and [codec documentation](https://github.com/uclouvain/openjpeg/wiki/DocJ2KCodec).
  15
  16 ## Current Status
  17 [![badge-build]][link-build]
  18
  19 [![badge-msvc-build]][link-msvc-build]
  20
  21 [![badge-coverity]][link-coverity]
  22
  23 ## Who are the developers ?
  24
  25 The library is developed and maintained by the Image and Signal Processing Group ([ISPGroup](http://sites.uclouvain.be/ispgroup/)), in the Université catholique de Louvain ([UCL](http://www.uclouvain.be/en-index.html), with the support of the [CNES](https://cnes.fr/), the [CS](http://www.c-s.fr/) company and the [intoPIX](http://www.intopix.com) company. The JPWL module has been developed by the Digital Signal Processing Lab ([DSPLab](http://dsplab.diei.unipg.it/)) of the University of Perugia, Italy ([UNIPG](http://www.unipg.it/)).
  26
  27 ## Details on folders hierarchy
  28
  29 * src
  30   * lib
  31     * openjp2: contains the sources of the openjp2 library (Part 1 & 2)
  32     * openjpwl: contains the additional sources if you want to build a JPWL-flavoured library.
  33     * openjpip: complete client-server architecture for remote browsing of jpeg 2000 images.
  34     * openjp3d: JP3D implementation
  35     * openmj2: MJ2 implementation
  36   * bin: contains all applications that use the openjpeg library
  37     * common: common files to all applications
  38     * jp2: a basic codec
  39     * mj2: motion jpeg 2000 executables
  40     * jpip: OpenJPIP applications (server and dec server)
  41       * java: a Java client viewer for JPIP
  42     * jp3d: JP3D applications
  43       * tcltk: a test tool for JP3D
  44     * wx
  45       * OPJViewer: gui for displaying j2k files (based on wxWidget)
  46 * wrapping
  47   * java: java jni to use openjpeg in a java program
  48 * 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.
  49 * doc: doxygen documentation setup file and man pages
  50 * tests: configuration files and utilities for the openjpeg test suite. All test images are located in [openjpeg-data](https://github.com/uclouvain/openjpeg-data) repository.
  51 * cmake: cmake related files
  52 * scripts: scripts for developers
  53
  54 See [LICENSE][link-license] for license and copyright information.
  55
  56 See [INSTALL](https://github.com/uclouvain/openjpeg/blob/master/INSTALL.md) for installation procedures.
  57
  58 See [NEWS](https://github.com/uclouvain/openjpeg/blob/master/NEWS.md) for user visible changes in successive releases.
  59
  60 ## API/ABI
  61
  62 An API/ABI timeline is automatically updated [here][link-api-timeline].
  63
  64 OpenJPEG strives to provide a stable API/ABI for your applications. As such it
  65 only exposes a limited subset of its functions.  It uses a mechanism of
  66 exporting/hiding functions. If you are unsure which functions you can use in
  67 your applications, you should compile OpenJPEG using something similar to gcc:
  68 `-fvisibility=hidden` compilation flag.
  69 See also: http://gcc.gnu.org/wiki/Visibility
  70
  71 On windows, MSVC directly supports export/hiding function and as such the only
  72 API available is the one supported by OpenJPEG.
  73
  74 [comment-license]: https://img.shields.io/github/license/uclouvain/openjpeg.svg "https://img.shields.io/badge/license-BSD--2--Clause-blue.svg"
  75 [badge-license]: https://img.shields.io/badge/license-BSD--2--Clause-blue.svg "BSD 2-clause \"Simplified\" License"
  76 [link-license]: https://github.com/uclouvain/openjpeg/blob/master/LICENSE "BSD 2-clause \"Simplified\" License"
  77 [badge-build]: https://travis-ci.org/uclouvain/openjpeg.svg?branch=master "Build Status"
  78 [link-build]: https://travis-ci.org/uclouvain/openjpeg "Build Status"
  79 [badge-msvc-build]: https://ci.appveyor.com/api/projects/status/github/uclouvain/openjpeg?branch=master&svg=true "Windows Build Status"
  80 [link-msvc-build]: https://ci.appveyor.com/project/detonin/openjpeg/branch/master "Windows Build Status"
  81 [badge-coverity]: https://scan.coverity.com/projects/6383/badge.svg "Coverity Scan Build Status"
  82 [link-coverity]: https://scan.coverity.com/projects/uclouvain-openjpeg "Coverity Scan Build Status"
  83 [link-api-timeline]: http://www.openjpeg.org/abi-check/timeline/openjpeg "OpenJPEG API/ABI timeline"