openfx-io

A set of Readers/Writers plugins written using the OpenFX standard.

License

Copyright (C) 2013-2018 INRIA

openfx-io is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

openfx-io is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with openfx-io. If not, see http://www.gnu.org/licenses/gpl-2.0.html

Getting the sources from github

To fetch the latest sources from github, execute the following commands:

git clone https://github.com/NatronGitHub/openfx-io.git
cd openfx-io
git submodule update -i --recursive

In order to get a specific tag, corresponding to a source release, do git tag -l to get the list of tags, and then git checkout tags/<tag_name> to checkout a given tag.

Compiling (Unix/Linux/FreeBSD/OS X, using Makefiles)

On Unix-like systems, the plugins can be compiled by typing in a terminal:

• make [options] to compile as a single combined plugin (see below for valid options).
• make nomulti [options] to compile as separate plugins (useful if only a few plugins are is needed, for example). make can also be executed in any plugin's directory.

The most common options are CONFIG=release to compile a release version, CONFIG=debug to compile a debug version. Or CONFIG=relwithdebinfo to compile an optimized version with debugging symbols.

Another common option is BITS=32for compiling a 32-bits version, BITS=64 for a 64-bits version, and BITS=Universal for a universal binary (OS X only).

See the file Makefile.masterin the toplevel directory for other useful flags/variables.

The compiled plugins are placed in subdirectories named after the configuration, for example Linux-64-realease for a 64-bits Linux compilation. In each of these directories, a *.bundle directory is created, which has to be moved to the proper place (/usr/OFX/Pluginson Linux, or /Library/OFX/Pluginson OS X), using a command like the following, with the same options used for compiling:

sudo make install [options]

Compiling on Ubuntu 12.04 LTS

OpenColorIO

sudo apt-get install cmake libtinyxml-dev liblcms2-dev libyaml-cpp-dev libboost-dev
git clone -b "v1.0.8" https://github.com/imageworks/OpenColorIO.git ocio
cd ocio
mkdir _build
cd _build
cmake .. -DCMAKE_INSTALL_PREFIX=/opt/ocio -DCMAKE_BUILD_TYPE=Release -DOCIO_BUILD_JNIGLUE=OFF -DOCIO_BUILD_NUKE=OFF -DOCIO_BUILD_SHARED=ON -DOCIO_BUILD_STATIC=OFF -DOCIO_STATIC_JNIGLUE=OFF -DOCIO_BUILD_TRUELIGHT=OFF -DUSE_EXTERNAL_LCMS=ON -DUSE_EXTERNAL_TINYXML=ON -DUSE_EXTERNAL_YAML=ON -DOCIO_BUILD_APPS=OFF -DOCIO_USE_BOOST_PTR=ON -DOCIO_BUILD_TESTS=OFF -DOCIO_BUILD_PYGLUE=OFF
make && sudo make install
cd ../..

OpenEXR

sudo apt-get install libopenexr-dev libilmbase-dev

OpenImageIO (for some reason, freetype is not recognized)

sudo apt-get install libopenjpeg-dev libtiff-dev libjpeg-dev libpng-dev libboost-filesystem-dev libboost-regex-dev libboost-thread-dev libboost-system-dev libwebp-dev libfreetype6-dev libssl-dev
git clone -b "RB-1.2" git://github.com/OpenImageIO/oiio.git oiio
cd oiio
make USE_QT=0 USE_TBB=0 USE_PYTHON=0 USE_FIELD3D=0 USE_OPENJPEG=1 USE_OCIO=1 OIIO_BUILD_TESTS=0 OIIO_BUILD_TOOLS=0 OCIO_HOME=/opt/ocio INSTALLDIR=/opt/oiio dist_dir=. cmake
sudo make dist_dir=.
cd ..

FFmpeg

sudo apt-get install libavcodec-dev libavformat-dev libswscale-dev libavutil-dev

Finally

env PKG_CONFIG_PATH=/opt/oiio/lib/pkgconfig make CONFIG=release

Compiling on OS X with macports

Download and install the MacPorts installer that corresponds to your Mac OS X version. Download the local portfiles archive on the bottom of that page, named TuttleOFX-OSX-macports.tar.gz . Uncompress the portfiles in a directory of your choice. In the following, we suppose you uncompressed it in /Users/USER_NAME/Development/dports-dev, but it can be anywhere except in the Documents directory, which has special permissions.

Give read/execute permissions to the local repository:

chmod 755 /Users/USER_NAME/Development/dports-dev

Check that the user nobody can read this directory by typing the following command in a Terminal:

sudo -u nobody ls /Users/USER_NAME/Development/dports-dev

If it fails, then try again after having given execution permissions on your home directory using the following command:

chmod o+x /Users/USER_NAME

If this still fails, then something is really wrong.

Edit the sources.conf file for MacPorts, for example using the nano editor:

sudo nano /opt/local/etc/macports/sources.conf

insert at the beginning of the file the configuration for a local repository (read the comments in the file), by inserting the line

file:///Users/USER_NAME/Development/dports-dev

Save and exit (if you're using nano, this means typing ctrl-X, Y and return).

Update MacPorts:

sudo port selfupdate

Recreate the index in the local repository:

cd /Users/USER_NAME/Development/dports-dev; portindex

(no need to be root for this)

Add the following line to /opt/local/etc/macports/variants.conf:

-x11 +no_x11 +bash_completion +no_gnome +quartz

(add +universal on OSX 10.5 and 10.6)

• special portfiles:

  • graphics/openimageio
  • graphics/opencolorio

• external libraries

  sudo port -v install openexr ffmpeg opencolorio openimageio

Then to compile...

env PKG_CONFIG_PATH=/opt/local/lib/pkgconfig make CONFIG=release OCIO_HOME=/opt/local

where /opt/local is where the macports tree stores the includes and libs.

Using Xcode on OSX

In order to use the provided Xcode project file, you should add the following definitions in the Xcode preferences (Preferences/Locations/Source trees in Xcode 6):

• EXR_PATH: path to OpenEXR installation prefix (e.g. /usr/local or /opt/local)
• FFMPEG_PATH: path to FFmpeg installation prefix (e.g. /usr/local or /opt/local)
• OCIO_PATH: path to OpenColorIO installation prefix (e.g. /usr/local or /opt/local)
• OIIO_PATH: path to OpenImageIO installation prefix (e.g. /usr/local or /opt/local)
• SEEXPR_PATH: path to SeExpr installation prefix (e.g. /usr/local or /opt/local)

Compiling on MS Windows

We provide pre-compiled static binaries for dependencies here: 3rdparty_windows_32_and_64bits_msvc2010.zip

On the other hand if you want to compile them yourself, you can do so :

OpenColorIO

Clone the repository from github:

git clone https://github.com/imageworks/OpenColorIO

See Compiling-OpenColorIO-static-on-Windows

OpenEXR

Clone the repository from github:

git clone https://github.com/openexr/openexr

And follow the install instruction in IlmBase/README.win32

OpenImageIO

Clone the repository from github:

git clone https://github.com/OpenImageIO/oiio

Follow the instructions in the INSTALL file of the source distribution. When compiling to use the pre-compiled binaries of OpenEXR provided as the version is too old to successfully build OpenImageIO. Instead use the version you just compiled before and change the include/lib paths in the visual studio project.

FFmpeg

I can only advice you download the pre-built binaries from Zeranoe. You will need to download the Shared to have the dlls and the Dev to have the .lib files allowing you to link with the dlls. Note that on this website you can only get shared versions of the ffmpeg libraries. Only version 4.0 and onwards are supported.

Boost

You can download pre-built binaries for your visual studio version from teeks99

Note about the external libraries

Please note that all libraries should be compiled as static libraries for the simplicity of the IO.ofx deployment. You should have all libraries as static EXCEPT ffmpeg. We will discuss at the end of the README how to deploy so the library loader can find the shared libraries at run time.

Compile IO.sln

There's a solution file in the repository whose purpose is to help building openfx-io on Windows. Note that you might have to make a few changes to the Configuration properties of the project so it can compile on your machine. You will need to change all the hardcoded path in the Additional Include directories to the ones on your machine. You will have to do the same with Additional Dependencies in the linker options.

Also, some preprocessor definitions are mandatory, most notably:

OFX_IO_USING_OCIO
OFX_IO_USING_LIBRAW
OFX_EXTENSIONS_VEGAS
OFX_EXTENSIONS_TUTTLE
OFX_EXTENSIONS_NUKE
OFX_IO_MT_FFMPEG
OpenColorIO_STATIC
_WINDOWS
WIN64 (if you're doing a x64 build)
NOMINMAX

Also note that you'll have to set the runtime library (in the Code Generation tab) to Multi-threaded (/MT).

Once you compile successfully and you have your bundle, locate the IO.ofx file. We assume from now on that the only shared libraries you linked with was ffmpeg (i.e: avcodec.lib, avformat.lib avutil.lib and swscale.lib). Make a new file called INRIA.IO.manifest right next to IO.ofx in the bundle (i.e: at this location: IO.ofx.bundle/Content/Win64/INRIA.IO.manifest). In this file copy the following lines:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
<assemblyIdentity name="INRIA.IO" version="1.0.0.0" type="win32" processorArchitecture="amd64"/>
<file name="avcodec-56.dll">
</file>
<file name="avformat-56.dll">
</file>
<file name="avutil-54.dll">
</file>
<file name="swscale-3.dll">
</file>
<file name="swresample-1.dll">
</file>
</assembly>

Now open the command line tool and navigate to IO.ofx.bundle/Content/Win64/ Execute the following command:

mt -manifest INRIA.IO.manifest -outputresource:IO.ofx;2

This will embed the manifest into the .ofx file so it can now find at runtime the shared dependencies (i.e: the ffmpeg Dlls).