The easy way¶

While prebuilt binaries are not yet available for all platforms, OCIO is available via several platform’s package managers.

yum install OpenColorIO

brew install opencolorio

brew install opencolorio --with-python

Building from source¶

$ mkdir /tmp/ociobuild
$ cd /tmp/ociobuild

$ cmake -D CMAKE_INSTALL_PREFIX=/software/ocio /source/ocio

-- Configuring done
-- Generating done
-- Build files have been written to: /tmp/ociobuild

$ make -j8

$ make install

$ cd /software/ocio
$ ls
bin/     include/ lib/
$ ls bin/
ocio2icc    ociobakelut ociocheck
$ ls include/
OpenColorIO/   PyOpenColorIO/ pkgconfig/
$ ls lib/
libOpenColorIO.a      libOpenColorIO.dylib

@echo off


REM Grab the repo name, default is ocio_rw
set repo_name=ocio_rw
if not %1.==. set repo_name=%1


set CYGWIN=nodosfilewarning

set CMAKE_PATH=D:\OpenSource\cmake-3.9.3
set PYTHON_PATH=C:\Python27
set BOOST_ROOT=D:\SolidAngle\boost_1_55_0

set PATH=D:\Tools\cygwin64\bin;%CMAKE_PATH%\bin;%PYTHON_PATH%;%PATH%

call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64


set OCIO_PATH=D:\OpenSource\%repo_name%


@doskey ne="D:\Tools\Notepad++\notepad++.exe" -nosession -multiInst $*
@doskey sub="D:\Tools\Sublime Text 3\subl.exe" --project %OCIO_PATH%_project.sublime-project


REM Decompose the directory change to avoid problems...
D:

IF NOT EXIST %OCIO_PATH% (
echo %OCIO_PATH% does not exist
exit /b
)
cd %OCIO_PATH%


set CMAKE_BUILD_TYPE=Release

echo *******
echo *********************************************
echo ******* Building %OCIO_PATH%
echo **
echo **
set are_you_sure = Y
set /P are_you_sure=Build in %CMAKE_BUILD_TYPE% ([Y]/N)?
if not %are_you_sure%==Y set CMAKE_BUILD_TYPE=Debug


set BUILD_PATH=_build_rls
if not %CMAKE_BUILD_TYPE%==Release set BUILD_PATH=_build_dbg

IF NOT EXIST %BUILD_PATH% ( mkdir %BUILD_PATH% )
cd %BUILD_PATH%


echo **
echo **

cmake -G "NMake Makefiles" ^
    -DCMAKE_BUILD_TYPE=%CMAKE_BUILD_TYPE% ^
    -DCMAKE_INSTALL_PREFIX=%OCIO_PATH%\_install ^
    -DOCIO_BUILD_TESTS=ON ^
    %OCIO_PATH%

set PATH=%OCIO_PATH%\%BUILD_PATH%\src\core;%PATH%


REM Find the current branch
set GITBRANCH=
for /f %%I in ('git.exe rev-parse --abbrev-ref HEAD 2^> NUL') do set GITBRANCH=%%I

if not "%GITBRANCH%" == ""  prompt $C%GITBRANCH%$F $P$G


echo *******
echo *********************************************
echo boost    = %BOOST_ROOT%
echo cmake    = %CMAKE_PATH%
echo *******
if not "%GITBRANCH%" == "" echo branch  = %GITBRANCH%
echo *******
echo Mode    = %CMAKE_BUILD_TYPE%
echo path    = %OCIO_PATH%\%BUILD_PATH%
echo compile = nmake all
echo test    = nmake test
echo *********************************************
echo *******

-- Python 2.6 okay, will build the Python bindings against .../include/python2.6

$ cmake -D PYTHON=/my/custom/python2.6 /source/ocio

$ cmake -D PYTHON=/my/custom/python2.6 -D NUKE_INSTALL_PATH=/Applications/Nuke6.2v1/Nuke6.2v1.app/Contents/MacOS/ /source/ocio

-- Found Nuke: /Applications/Nuke6.2v1/Nuke6.2v1.app/Contents/MacOS/include
-- Nuke_API_VERSION: --6.2--

-- Not building ocioconvert. Requirement(s) found: OIIO:FALSE

Quick environment configuration¶

The quickest way to set the required Environment variables is to source the share/ocio/setup_ocio.sh script installed with OCIO.

For a simple single-user setup, add the following to ~/.bashrc (assuming you are using bash, and the example install directory of /software/ocio):

source /software/ocio/share/ocio/setup_ocio.sh

The only environment variable you must configure manually is OCIO, which points to the configuration file you wish to use. For prebuilt config files, see the Downloads section

To do this, you would add a line to ~/.bashrc (or a per-project configuration script etc), for example:

export OCIO="/path/to/my/config.ocio"

Nuke Configuration¶

If you specified the NUKE_INSTALL_PATH option when running cmake, you should have a /software/ocio/lib/nuke6.2 directory containing various files.

If you have followed Quick environment configuration, the plugins should be functional. However, one common additional configuration step is to register an OCIODisplay node for each display device/view specified in the config.

To do this, in a menu.py on NUKE_PATH (e.g ~/.nuke/menu.py for a single user setup), add the following:

import ocionuke.viewer
ocionuke.viewer.populate_viewer(also_remove = "default")

The also_remove argument can be set to either “default” to remove the default sRGB/rec709 options, “all” to remove everything, or “none” to leave existing viewer processes untouched.

Alternatively, if your workflow has different requirements, you can copy the function and modify it as required, or use it as reference to write your own, better viewer setup function!

import nuke


def register_viewers(also_remove = "default"):
    """Registers the a viewer process for each display device/view, and
    sets the default viewer process.

    ``also_remove`` can be set to either:
    
    - "default" to remove the default sRGB/rec709 viewer processes
    - "all" to remove all processes
    - "none" to leave existing viewer processes untouched
    """

    if also_remove not in ("default", "none", "all"):
        raise ValueError("also_remove should be set to 'default', 'none' or 'all'")

    if also_remove == "default":
        nuke.ViewerProcess.unregister('rec709')
        nuke.ViewerProcess.unregister('sRGB')
        nuke.ViewerProcess.unregister('None')
    elif also_remove == "all":
        # Unregister all processes, including None, which should be defined in config.ocio
        for curname in nuke.ViewerProcess.registeredNames():
            nuke.ViewerProcess.unregister(curname)

    # Formats the display and transform, e.g "Film1D (sRGB)"
    DISPLAY_UI_FORMAT = "%(view)s (%(display)s)"

    import PyOpenColorIO as OCIO
    config = OCIO.GetCurrentConfig()

    # For every display, loop over every view
    for display in config.getDisplays():
        for view in config.getViews(display):
            # Register the node
            nuke.ViewerProcess.register(
                name = DISPLAY_UI_FORMAT % {'view': view, "display": display},
                call = nuke.nodes.OCIODisplay,
                args = (),
                kwargs = {"display": display, "view": view, "layer": "all"})


    # Get the default display and view, set it as the default used on Nuke startup
    defaultDisplay = config.getDefaultDisplay()
    defaultView = config.getDefaultView(defaultDisplay)
    
    nuke.knobDefault(
        "Viewer.viewerProcess",
        DISPLAY_UI_FORMAT % {'view': defaultView, "display": defaultDisplay})

Environment variables¶

OCIO¶

This variable needs to point to the global OCIO config file, e.g config.ocio

OCIO_LOGGING_LEVEL¶

Configures OCIO’s internal logging level. Valid values are none, warning, info, or debug (or their respective numeric values 0, 1, 2, or 3 can be used)

Logging output is sent to STDERR output.

OCIO_ACTIVE_DISPLAYS¶

Overrides the active_displays configuration value. Colon-separated list of displays, e.g sRGB:P3

OCIO_ACTIVE_VIEWS¶

Overrides the active_views configuration item. Colon-separated list of view names, e.g internal:client:DI

DYLD_LIBRARY_PATH¶

The lib/ folder (containing libOpenColorIO.dylib) must be on the DYLD_LIBRARY_PATH search path, or you will get an error similar to:

dlopen(.../OCIOColorSpace.so, 2): Library not loaded: libOpenColorIO.dylib
Referenced from: .../OCIOColorSpace.so
Reason: image not found

This applies to anything that links against OCIO, including the Nuke nodes, and the PyOpenColorIO Python bindings.

LD_LIBRARY_PATH¶

Equivalent to the DYLD_LIBRARY_PATH on Linux

PYTHONPATH¶

Python’s module search path. If you are using the PyOpenColorIO module, you must add lib/python2.x to this search path (e.g python/2.5), or importing the module will fail:

>>> import PyOpenColorIO
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: No module named PyOpenColorIO

Note that DYLD_LIBRARY_PATH or LD_LIBRARY_PATH must be set correctly for the module to work.

NUKE_PATH¶

Nuke’s customization search path, where it will look for plugins, gizmos, init.py and menu.py scripts and other customizations.

This should point to both lib/nuke6.2/ (or whatever version the plugins are built against), and share/nuke/