Skip to content

INSTALL.md

Latest commit

 

History

History
48 lines (39 loc) · 1.88 KB

INSTALL.md

File metadata and controls

48 lines (39 loc) · 1.88 KB
Raw

Building OpenJP3D

Prerequisites

  • CMake ≥ 3.14
  • C11-compatible compiler (GCC ≥ 7, Clang ≥ 6, MSVC ≥ 2019)
  • (Optional) Doxygen ≥ 1.9 for API documentation

Quick Start

cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build
ctest --test-dir build

CMake Options

Option Default Description
BUILD_JP3D ON Build the core JP3D codec library
BUILD_HTJ2K_3D OFF Build the HTJ2K 3-D block coder
BUILD_JPIP_3D ON Build the JPIP 3-D streaming library
BUILD_CLI_TOOLS ON Build command-line utilities
BUILD_DOC OFF Build Doxygen documentation
BUILD_DOC_EXAMPLES OFF Build documentation example programs
BUILD_TESTING ON Build and enable CTest test suite
BUILD_SHARED_LIBS OFF Build shared libraries
ENABLE_OPENMP OFF Enable OpenMP multi-threading
BUILD_BENCHMARKS OFF Build the benchmark suite
BUILD_FUZZ OFF Build libFuzzer harnesses (Clang)
BUILD_GUI_TOOLS OFF Build interactive GUI application (Dear ImGui + SDL2)
BUILD_PYTHON_BINDINGS OFF Register Python ctypes binding tests (requires Python 3, pytest, NumPy, and BUILD_SHARED_LIBS=ON)

Installation

cmake --install build --prefix /usr/local

This installs:

  • Libraries: lib/libopenjp3d.a (or .so), lib/libopenjpip3d.a
  • Headers: include/openjp3d.h, include/openjpip3d.h
  • Binaries: bin/opj_jp3d_compress, bin/opj_jp3d_decompress, bin/opj_jp3d_dump, bin/opj_jp3d_transcode, bin/opj_jpip3d_server
  • Man pages: share/man/man1/opj_jp3d_*.1
  • CMake config: lib/cmake/OpenJP3D/
  • pkg-config: lib/pkgconfig/openjp3d.pc