Skip to content

Latest commit

 

History

History
453 lines (343 loc) · 20.8 KB

INSTALL.md

File metadata and controls

453 lines (343 loc) · 20.8 KB

Installation instructions for OpenImageIO

Table of Contents

  1. OpenImageIO's Dependencies
  2. Installing binaries from package managers
  3. Building OIIO from source

Dependencies

NEW or CHANGED MINIMUM dependencies since the last major release are bold.

Required dependencies -- OIIO will not build at all without these

  • C++17 or higher (also builds with C++20 and C++23)
    • The default build mode is C++17. This can be controlled by via the CMake configuration flag: -DCMAKE_CXX_STANDARD=20, etc.
  • Compilers: gcc 9.3 - 14.2, clang 10 - 20, MSVS 2017 - 2022 (v19.14 and up), Intel OneAPI C++ compiler 2022+.
  • CMake >= 3.18.2 (tested through 4.1)
  • Imath >= 3.1 (tested through 3.2 and main)
  • OpenEXR >= 3.1 (tested through 3.4 and main)
  • libTIFF >= 4.0 (tested through 4.7 and master)
  • OpenColorIO >= 2.3 (tested through 2.5 and main)
  • libjpeg >= 8 (tested through jpeg9e), or libjpeg-turbo >= 2.1 (tested through 3.1)
  • zlib >= 1.2.7 (tested through 1.3.1)
  • fmtlib >= 9.0 (tested through 12.1 and master). If not found at build time, this will be automatically downloaded and built.
  • Robin-map (unknown minimum, tested through 1.4, which is the recommended version). If not found at build time, this will be automatically downloaded and built.

Optional dependencies -- features may be disabled if not found

  • If you are building the iv viewer (which will be disabled if any of these are not found):
    • Qt5 >= 5.6 (tested through 5.15) or Qt6 (tested through 6.9)
    • OpenGL
  • If you are building the Python bindings or running the testsuite:
    • Python >= 3.9 (tested through 3.13).
    • pybind11 >= 2.7 (tested through 3.0)
    • NumPy (tested through 2.2.4)
  • If you want support for PNG files:
    • libPNG >= 1.6.0 (tested though 1.6.50)
  • If you want support for camera "RAW" formats:
    • LibRaw >= 0.20 (tested though 0.22.0 and master)
  • If you want support for a wide variety of video formats:
    • ffmpeg >= 4.0 (tested through 8.0)
  • If you want support for jpeg 2000 images:
    • OpenJpeg >= 2.0 (tested through 2.5.4; we recommend 2.4 or higher for multithreading support)
  • If you want support for OpenVDB files:
    • OpenVDB >= 9.0 (tested through 12.1).
  • If you want to use TBB as the thread pool:
    • TBB >= 2018 (tested through 2021 and OneTBB)
  • If you want support for converting to and from OpenCV data structures, or for capturing images from a camera:
    • OpenCV 4.x (tested through 4.12)
  • If you want support for GIF images:
    • giflib >= 5.0 (tested through 5.2.2)
  • If you want support for HEIF/HEIC or AVIF images:
    • libheif >= 1.11 (1.16 required for correct orientation support and 1.17 required for monochrome HEIC support; tested through 1.21.1)
    • libheif must be built with an AV1 encoder/decoder for AVIF support.
  • If you want support for DICOM medical image files:
    • DCMTK >= 3.6.1 (tested through 3.6.9)
  • If you want support for WebP images:
    • WebP >= 1.1 (tested through 1.6)
  • If you want support for Ptex:
    • Ptex >= 2.3.1 (probably works for older; tested through 2.5)
  • If you want to be able to do font rendering into images:
    • Freetype >= 2.10.0 (tested through 2.14)
  • If you want to be able to read "ultra-HDR" embedded in JPEG files:
    • libultrahdr >= 1.3 (tested through 1.4)
  • If you want support for JPEG XL images:
    • libjxl >= 0.10.1 (tested through 0.11.1)
  • If you want support for j2c files:
    • OpenJPH >= 0.21.2 (tested through 0.23)
  • We use PugiXML for XML parsing. There is a version embedded in the OIIO tree, but if you want to use an external, system-installed version (as may be required by some software distributions with policies against embedding other projects), then just build with -DUSE_EXTERNAL_PUGIXML=1. Any PugiXML >= 1.8 should be fine (we have tested through 1.15).

Supported platforms at present include Linux (32 and 64 bit), Mac OS X, and Windows.

Our build system is based upon 'CMake'. If you don't already have it installed on your system, you can get it from http://www.cmake.org

If certain dependencies (robin-map and fmtlib) are not found, their sources will be retrieved and built into libraries, as part of the build process. The sources of those dependencies are cloned from their Git repo, hence git must be available as a command.

After you build OpenImageIO, if you compiled with the EMBEDPLUGINS=0 flag you will need to set the environment variable OIIO_LIBRARY_PATH to point to the 'lib' directory where OpenImageIO is installed, or else it will not be able to find the plugins.

Installing from package managers

If all you want to do is install the OIIO libraries, headers, and command line tools as quickly as possible (don't need OIIO source or any custom build options), maybe one of these packages managers will do it for you:

If these work for you and it's all you need, bingo! You are done.

You may find this guide to versions carried by distributions helpful:

OpenImageIO packaging status

Building from source

Dependency control and disabling components

Hints for finding dependencies

For each external dependency PkgName, our CMake build system will recognize the following optional variable:

PkgName_ROOT=...

to specify a hint about where the package is installed. It can either be a CMake variable (set by -DPkgName_ROOT=... on the CMake command line), or an environment variable of the same name, or a variable setting on the Make wrapper (make PkgName_ROOT=...).

Disabling optional dependencies and individual components

USE_PYTHON=0 : Omits building the Python bindings.

OIIO_BUILD_TESTS=0 : Omits building tests (you probably don't need them unless you are a developer of OIIO or want to verify that your build passes all tests).

OIIO_BUILD_TOOLS=0 : Disables building all the command line tools (such as iinfo, oiiotool, maketx, etc.).

ENABLE_toolname=0 : Disables building the named command line tool (iinfo, oiiotool, etc.). This works both as a CMake variable and also as an environment variable.

ENABLE_formatname=0 : Disables building support for the particular named file format (jpeg, fits, png, etc.). This works both as a CMake variable and also as an environment variable.

ENABLE_PkgName=0 : Disables use of an optional dependency (such as FFmpeg, OpenVDB, Webp, etc.) -- even if the dependency is found on the system. This will obviously disable any functionality that requires the dependency. This works both as a CMake variable and also as an environment variable.

Building OpenImageIO on Linux or OS X

The following dependencies must be installed to build the core of OpenImageIO:

  • libjpeg
  • libtiff
  • libpng
  • Imath
  • OpenEXR

These can be installed using the standard package managers on your system. Optionally, to build the image viewing tools, you will need Qt and OpenGL.

On OS X, these dependencies can be installed using Fink, MacPorts or Homebrew. After installation of any of these package installers, use the "fink", "port" or "brew" commands (respectively) to install the dependencies (e.g. "fink install libpng16", "port install qt4-mac" or "brew update; brew doctor; brew install qt") before invoking make as described below.

On OS X, Fink can also be used to directly compile and install the OpenImageIO tools directly with the command "fink install openimageio-tools". On OS X releases where Fink has a binary distribution (10.8, 10.9, and 10.10 as of 2015), the command "apt-get install openimageio-tools" will fetch prebuilt binaries.

Dependent libraries can be installed in either the system default locations or in custom directories. Libraries installed in custom directories must notify the CMake system using environment variables. For example, set QTDIR to point at the root of the Qt library location so that CMake can find it (see CMake configuration output).

On Linux and OS X, you can build from source from the top-level directory by just typing 'make'. (Yes, we have a 'make' wrapper around our CMake build, it simplifies things.)

During the make, various temporary files (object files, etc.) will be put in build/PLATFORM, where 'PLATFORM' will be the name of the platform you are building for (e.g., linux, linux64, macosx).

The result of the make will be a full binary distribution in dist/PLATFORM.

Make targets you should know about:

Target Command
make Build an optimized distro in dist/PLATFORM, with temp files created while building in build/PLATFORM.
make debug Build a debugging (symbols, not stripped) distro, will end up in dist/PLATFORM.debug
make clean Get rid of all the temporary files in build/PLATFORM
make realclean Get rid of both build/PLATFORM and dist/PLATFORM
make nuke Get rid of all build/ and dist/, for all platforms
make profile Build a profilable version dist/PLATFORM.profile
make help Print all the make options

Additionally, a few helpful modifiers alter some build-time options:

Target Command
make VERBOSE=1 ... Show all compilation commands
make STOP_ON_WARNING=0 Do not stop building if compiler warns
make EMBEDPLUGINS=0 ... Don't compile the plugins into libOpenImageIO
make USE_OPENGL=0 ... Skip anything that needs OpenGL
make USE_QT=0 ... Skip anything that needs Qt
make MYCC=xx MYCXX=yy ... Use custom compilers
make USE_PYTHON=0 ... Don't build the Python binding
make BUILD_SHARED_LIBS=0 Build static library instead of shared
make IGNORE_HOMEBREWED_DEPS=1 Ignore homebrew-managed dependencies
make LINKSTATIC=1 ... Link with static external libraries when possible
make SOVERSION=nn ... Include the specified major version number in the shared object metadata
make NAMESPACE=name Wrap everything in another namespace

The command 'make help' will list all possible options.

You can also ignore the top level Makefile wrapper, and instead use CMake directly:

cmake -B build -S .
cmake --build build --target install

If the compile stops because of warnings, try again with

make nuke
make STOP_ON_WARNING=0

or, if you are using CMake directly,

rm -rf build
cmake -B build -S . -DSTOP_ON_WARNING=0
cmake --build build --target install

Building on Windows

Method 1 - from source

You will need to have Git, CMake and Visual Studio installed.

The minimal set of dependencies for OIIO is: zlib, libTIFF, Imath, OpenEXR, OpenColorIO, and libjpeg or libjpeg-turbo. If you have them built somewhere then if you set the environment variable CMAKE_PREFIX_PATH to include those areas so CMake will find them, the OpenImageIO build will find those pre-built packages and use them. If you don't have them build, or are unsure, the OpenImageIO_BUILD_MISSING_DEPS=all CMake option will cause the build process to download the sources of those dependencies, build them, and use them.

To build OpenImageIO, you first need to clone the OIIO repository and check out the desired branch or tag:

cd {OIIO_ROOT}
git clone https://github.com/AcademySoftwareFoundation/OpenImageIO .
git checkout release

OIIO_ROOT is the directory where you want to place the OIIO source code.

Note the git checkout release line. There are a few choices here:

  • release - always will be the latest stable supported release, which is the recommended choice for most users.
  • v3.0.3.0 - a specific release version, which is the recommended choice for most users who want to use a specific version of OIIO. Note that this is just an example, and by the time you are reading these instructions, it will likely be out of date. Adjust the version number to match the one you want. Note that release is a shortcut for the latest stable release, if you aren't sure which version you want.
  • main - the latest development version, which may be unstable, but is probably what you want if you are a developer and are working on new contributions to OIIO.

Next, you need to do the "cmake configure" step:

cmake -S . -B build -DOpenImageIO_BUILD_MISSING_DEPS=all ^
  -DBUILD_SHARED_LIBS=0 -DLINKSTATIC=1

If that command succeeds, you can either do the full build and install from the command line, or open the generated Visual Studio solution.

Note that you can speed up the build by disabling certain components if you know you won't need them: Adding -DUSE_PYTHON=0 to the command above will skip building the Python bindings, -DUSE_QT=0 will disable looking for and using Qt (needed only for the iv viewer), and -DOIIO_BUILD_TESTS=0 will skip building certain unit tests (which you only need if you want to OIIO's tests).

If you just want a one-step build/install from the command line, you can run:

cmake --build build --target install --config Release

and that will build the package and install it into the {OIIO_ROOT/dist area. (If you instead wanted the install to end up elsewhere, the easiest way is on the earlier config step, to add the option -DCMAKE_INSTALL_PREFIX=somewhere_else.)

On the other hand, if you would prefer to open the generated Visual Studio solution, the "cmake configure" will have produced {OIIO_ROOT}/build/OpenImageIO.sln that can be opened in Visual Studio IDE. Note that the solution will be only for the Intel x64 architecture only; and will only target "min-spec" (SSE2) SIMD instruction set.

Optional packages that OIIO can use (e.g. libpng, Qt) can be build and pointed to OIIO build process in a similar way.

In Visual Studio, open {OIIO_ROOT}/build/OpenImageIO.sln and pick Release build configuration. If you pick Debug, you might need to re-run the CMake command above with -DCMAKE_BUILD_TYPE=Debug and also have all the dependencies above built with Debug config too.

The main project that builds the library is OpenImageIO. The library is built into {OIIO_ROOT}/build/lib/{CONFIG} folder. The various OIIO command line tools (oiiotool, iconvert etc.) are projects under Tools subfolder in VS IDE solution explorer. They all build into {OIIO_ROOT}/build/bin/{CONFIG} folder.

There's a CMakePredefinedTargets/INSTALL project that you can build to produce a {OIIO_ROOT}/dist folder with bin, include, lib, share folders as an OIIO distribution.

The instructions above use options for building statically-linked OIIO library and tools. Adjust options passed to CMake to produce a dynamic-linked version.

Method 2 - Using vcpkg

  1. Visit Microsoft's vcpkg GitHub page: https://github.com/Microsoft/vcpkg. Also note that the openimageio package is located here: https://github.com/Microsoft/vcpkg/tree/master/ports/openimageio

  2. Follow vcpkg installation instructions and complete the install. Please note vcpkg has its own list of prerequisites listed on their page.

  3. Execute the PowerShell command from where vcpkg is located in directory. vcpkg install openimageio

Note: Importing the OpenImageIO Python Module

As of OpenImageIO 3.0.3.0, the default DLL-loading behavior for Python 3.8+ has changed.

If you've built OIIO from source and import OpenImageIO is throwing a ModuleNotFound exception, revert to the legacy DLL-loading behavior by setting environment variable OPENIMAGEIO_PYTHON_LOAD_DLLS_FROM_PATH=1.

Python-based Builds and Installs

Installing from prebuilt binary distributions

If you're only interested in the Python module and the CLI tools, you can install with pip or uv:

pip install OpenImageIO

Building and installing from source

If you have a C++ compiler installed, you can also use the Python build-backend to compile and install from source by navigating to the root of the repository and running: pip install .

This will download and install CMake and Ninja if necessary, and invoke the CMake build system; which, in turn, will build missing dependencies, compile OIIO, and install the Python module, the libraries, the headers, and the CLI tools to a platform-specific, Python-specific location.

See the scikit-build-core docs for more information on customizing and overriding build-tool options and CMake arguments.

This repo contains python type stubs which are generated from pybind11 signatures. The workflow for releasing new stubs is as follows:

  • Install uv and docker
  • Run make pystubs locally to generate updated stubs in src/python/stubs/__init__.pyi
  • Run make test-pystubs locally to use mypy to test the stubs against the code in the python testsuite.
  • Commit the new stubs and push to Github
  • In CI, the stubs will be included in the wheels built by cibuildwheel, as defined in .github/wheel.yml
  • In CI, one of the cibuildwheel Github actions will rebuild the stubs to a temp location and verify that they match what has been committed to the repo.
    This step ensures that if changes to the C++ source code and bindings results in a change to the stubs, developers are notified of the need to regenerate the stubs, so that changes can be reviewed and the rules in generate_stubs.py can be updated, if necessary.

Note that if you can't (or don't want to) build the stubs locally, you can download an artifact containing the wheel and __init__.pyi file from any job that fails the stub validation.

Test Images

There are several projects containing sets of sample images for testing OpenImageIO.

They are kept separate in order to make the main source code tree smaller and simpler for people who don't need the test suite. Additionally, some of these packages are maintained outside the OpenImageIO project by their respective organizations.

Download Directory Placement Notes
git clone https://github.com/AcademySoftwareFoundation/OpenImageIO-images.git <path>/../oiio-images CMake will download if not present
git clone https://github.com/AcademySoftwareFoundation/openexr-images.git <path>/../openexr-images CMake will download if not present
http://www.cv.nrao.edu/fits/data/tests/ <path>/../fits-images Manual download required
https://www.itu.int/net/ITU-T/sigdb/speimage/ImageForm-s.aspx?val=10100803 <path>/../j2kp4files_v1_5 Manual download required
Where <path> is the location of the main OpenImageIO repository.

You do not need any of these packages in order to build or use OpenImageIO. But if you are going to contribute to OpenImageIO development, you probably want them, since it is required for executing OpenImageIO's test suite (when you run "make test").