These are step-by-step instructions to compile Natron on OS X.
OS X 10.6 (a.k.a. Snow Leopard) and newer are supported when building with MacPorts, and Homebrew can be used to compile it on the latest OS X.
git clone https://github.com/MrKepzie/Natron.git
cd Natron
If you want to compile the bleeding edge version, use the master branch:
git checkout master
Update the submodules:
git submodule update -i --recursive
##Install libraries
In order to have Natron compiling, first you need to install the required libraries.
There are two exclusive options: using MacPorts or using Homebrew.
Homebrew is easier to set up than MacPorts, but cannot build universal binaries.
You need an up to date MacPorts version. Just download it and install it from http://www.macports.org, and execute the following commands in a terminal:
sudo port selfupdate
sudo port upgrade outdated
Then, you should add the "ports" provided by Natron. Edit as root the file /opt/local/etc/macports/sources.conf (as in sudo nano /opt/local/etc/macports/sources.conf) and add the following line at the beginning, with the path to the Natron sources (yes, there are three slashes after file:):
file:///Users/your_username/path_to_sources/Natron/tools/MacPorts
Then, create the index file:
(cd /Users/your_username/path_to_sources/Natron/tools/MacPorts; portindex)
It is also recommended to add the following line to /opt/local/etc/macports/variants.conf:
-x11 +no_x11 +bash_completion +no_gnome +quartz
If compiling on Mac OS X 10.6 with Xcode 4, you should also revert to the default compilers list of Xcode 3.2.6 (MacPort's /opt/local/libexec/macports/lib/port1.0/portconfigure.tcl sets it to a different value for an unknown reason, resulting in llvm-gcc-4.2 being used to compile everything in MacPorts). Add the following line to /opt/local/etc/macports/macports.conf:
default_compilers gcc-4.2 clang llvm-gcc-4.2 macports-clang-3.4 macports-clang-3.3 macports-llvm-gcc-4.2 apple-gcc-4.2 gcc-4.0
And finally install the required packages:
sudo port install qt4-mac boost cairo expat
sudo port install py27-pyside py27-sphinx
sudo ln -s python2.7-config /opt/local/bin/python2-config
Create the file /opt/local/lib/pkgconfig/glu.pc containing GLU configuration, for example using the following comands:
sudo -s
cat > /opt/local/lib/pkgconfig/glu.pc << EOF
prefix=/usr
exec_prefix=${prefix}
libdir=${exec_prefix}/lib
includedir=${prefix}/include
Name: glu
Version: 2.0
Description: glu
Requires:
Libs:
Cflags: -I${includedir}
EOFIf you intend to build the openfx-io plugins too, you will need these additional packages:
sudo port -v install openexr ffmpeg opencolorio openimageio seexpr
and for openfx-arena (note that it installs a version of ImageMagick without support for many image I/O libraries):
sudo port -v install ImageMagick +natron
Install homebrew from http://brew.sh/
Patch the qt4 recipe to fix the stack overflow issue (see QTBUG-49607, homebrew issue #46307, MacPorts ticket 49793).
Patching a homebrew recipe is explained in the homebrew FAQ.
brew edit qt
and before the line that starts with head, add the following code:
patch :p0 do
url "https://bugreports.qt.io/secure/attachment/52520/patch-qthread-stacksize.diff"
sha256 "477630235eb5ee34ed04e33f156625d1724da290e7a66b745611fb49d17f1347"
end
Install libraries:
brew tap homebrew/python
brew tap homebrew/science
brew install --build-from-source qt --with-mysql
brew install expat cairo
brew install pyside sphinx-doc
The last command above should tell you do do that if the homebrew.pth file does not exist:
mkdir -p /Users/devernay/Library/Python/2.7/lib/python/site-packages
echo 'import site; site.addsitedir("/usr/local/lib/python2.7/site-packages")' >> ~/Library/Python/2.7/lib/python/site-packages/homebrew.pth
sudo ln -s ~/Library/Python/2.7/lib/python/site-packages/homebrew.pth /Library/Python/2.7/lib/python/site-packages/homebrew.pth
To install the openfx-io and openfx-misc sets of plugin, you also need the following:
brew install ilmbase openexr freetype fontconfig ffmpeg opencolorio openimageio seexpr
also set the correct value for the pkg-config path (you can also put this in your .bash_profile):
export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/opt/X11/lib/pkgconfig:/usr/local/opt/cairo/lib/pkgconfig
See QTBUG-49607, homebrew issue #46307, MacPorts ticket 49793.
wget https://download.qt.io/official_releases/qt/4.8/4.8.7/qt-everywhere-opensource-src-4.8.7.tar.gz
tar zxvf qt-everywhere-opensource-src-4.8.7.tar.gz
cd qt-everywhere-opensource-src-4.8.7
wget https://raw.githubusercontent.com/Homebrew/patches/480b7142c4e2ae07de6028f672695eb927a34875/qt/el-capitan.patch
patch -p1 < el-capitan.patch
wget https://bugreports.qt.io/secure/attachment/52520/patch-qthread-stacksize.diff
patch -p0 < patch-qthread-stacksize.diff
Then, configure using:
./configure -prefix /opt/qt4 -pch -system-zlib -qt-libtiff -qt-libpng -qt-libjpeg -confirm-license -opensource -nomake demos -nomake examples -nomake docs -cocoa -fast -release
- On OS X >= 10.9 add
-platform unsupported/macx-clang-libc++ - On OS X < 10.9, to compile with clang add
-platform unsupported/macx-clang - If compiling with gcc/g++, make sure that
g++ --versionrefers to Apple's gcc >= 4.2 or clang >= 318.0.61 - To use another openssl than the system (mainly for security reasons), add
-openssl-linked -I /usr/local/Cellar/openssl/1.0.2d_1/include -L /usr/local/Cellar/openssl/1.0.2d_1/lib(where the path is changed to your openssl installation).
Then, compile using:
make
And install (after making sure /opt/qt4 is user-writable) using:
make install
In the past, OCIO configs were a submodule, though due to the size of the repository, we have chosen instead to make a tarball release and let you download it here. Place it at the root of Natron source tree:
curl -k -L https://github.com/MrKepzie/OpenColorIO-Configs/archive/Natron-v2.1.tar.gz | tar zxf -
mv OpenColorIO-Configs-Natron-v2.1 OpenColorIO-Configs
You have to define the locations of the required libraries. This is done by creating a .pri file that will tell the .pro where to find those libraries. The only library to put in the config.pri file on unix systems is boost. For all other libraries are found with PKGConfig.
- create the config.pri file next to the Project.pro file.
You can fill it with the following proposed code to point to the libraries. Of course you need to provide valid paths that are valid on your system.
INCLUDEPATH is the path to the include files
LIBS is the path to the libs
If you installed libraries using MacPorts, use the following config.pri:
# copy and paste the following in a terminal
cat > config.pri << EOF
boost: INCLUDEPATH += /opt/local/include
boost: LIBS += -L/opt/local/lib -lboost_serialization-mt
EOFIf you installed libraries using Homebrew, use the following config.pri:
# copy and paste the following in a terminal
cat > config.pri << EOF
boost: INCLUDEPATH += /usr/local/include
boost: LIBS += -L/usr/local/lib -lboost_serialization-mt -lboost_thread-mt -lboost_system-mt
expat: PKGCONFIG -= expat
expat: INCLUDEPATH += /usr/local/opt/expat/include
expat: LIBS += -L/usr/local/opt/expat/lib -lexpat
EOFYou can generate a makefile by opening a Terminal, setting the current directory to the toplevel source directory, and typing
qmake -r
then type
make
This will create all binaries in all the subprojects folders.
If you want to build in DEBUG mode change the qmake call to this line:
qmake -r CONFIG+=debug
-
You can also enable logging by adding CONFIG+=log
-
You can also enable clang sanitizer by adding CONFIG+=sanitizer
Follow the instruction of build but add -spec macx-xcode to the qmake call command:
qmake -r -spec macx-xcode
Then open the already provided Project-xcode.xcodeproj and compile the target "all"
The source distributions of the plugin sets openfx-io and
openfx-misc contain Xcode projects, but these require setting a few
global variables in Xcode. These variables can be used to switch
between the system-installed version of a package and a custom install
(e.g. if you need to debug something that happens in OpenImageIO).
In Xcode Preferences, select "Locations", then "Source Trees", and add the following variable names/values (Xcode may need to be restarted after setting these):
LOCAL:/usr/localon Homebrew,/opt/localon MacPortsBOOST_PATH:$(LOCAL)/includeEXR_PATH:$(LOCAL)FFMPEG_PATH:$(LOCAL)OCIO_PATH:$(LOCAL)OIIO_PATH:$(LOCAL)OPENCV_PATH:$(LOCAL)SEEXPR_PATH:$(LOCAL)
It is also recommended in Xcode Preferences, select "Locations", then
"Locations", to set the Derived Data location to be Relative, and in
the advanced settings to set the build location to Legacy (if not,
build files are somewhere under ~/Library/Developer/Xcode.
Whenever the .pro files change, Xcode will try to launch qmake and probably fail because it doesn't find the necessary binaries (qmake, moc, pkg-config, python3-config, etc.). In this case, just open a Terminal and relaunch the above command. This will rebuild the Xcode projects.
Alternatively, you can globally add the necessary directories
(/usr/local/binon Homebrew, /opt/local/bin on MacPorts) to you
PATH (see http://www.emacswiki.org/emacs/EmacsApp for instructions).
On MacPorts, this would look like:
launchctl setenv PATH /opt/local/bin:/opt/local/sbin:/usr/bin:/bin:/usr/sbin:/sbin
(cd Tests && qmake -r CONFIG+=debug CONFIG+=coverage && make -j4 && ./Tests)
This is not required as generated files are already in the repository. You would need to run it if you were to extend or modify the Python bindings via the typesystem.xml file. See the documentation of shiboken-3.4 for an explanation of the command line arguments.
On MacPorts:
rm Engine/NatronEngine/* Gui/NatronGui/*
shiboken-3.4 --avoid-protected-hack --enable-pyside-extensions --include-paths=../Engine:../Global:/opt/local/include:/opt/local/include/PySide-3.4 --typesystem-paths=/opt/local/share/PySide-3.4/typesystems --output-directory=Engine Engine/Pyside_Engine_Python.h Engine/typesystem_engine.xml
shiboken-3.4 --avoid-protected-hack --enable-pyside-extensions --include-paths=../Engine:../Gui:../Global:/opt/local/include:/opt/local/include/PySide-3.4 --typesystem-paths=/opt/local/share/PySide-3.4/typesystems:Engine --output-directory=Gui Gui/Pyside_Gui_Python.h Gui/typesystem_natronGui.xml
tools/utils/runPostShiboken.shon HomeBrew:
rm Engine/NatronEngine/* Gui/NatronGui/*
shiboken --avoid-protected-hack --enable-pyside-extensions --include-paths=../Engine:../Global:/usr/local/include:/usr/local/include/PySide --typesystem-paths=/usr/local/share/PySide/typesystems --output-directory=Engine Engine/Pyside_Engine_Python.h Engine/typesystem_engine.xml
shiboken --avoid-protected-hack --enable-pyside-extensions --include-paths=../Engine:../Gui:../Global:/usr/local/include:/usr/local/include/PySide --typesystem-paths=/usr/local/share/PySide/typesystems:Engine --output-directory=Gui Gui/Pyside_Gui_Python.h Gui/typesystem_natronGui.xml
tools/utils/runPostShiboken.shNote Shiboken has a few glitches which needs fixing with some sed commands, run tools/utils/runPostShiboken.sh once shiboken is called
Instructions to build the openfx-io and openfx-misc sets of plugins can also be found in the tools/packageOSX.sh script if you are using MacPorts, or in the .travis.yml file in their respective github repositories if you are using homebrew (openfx-misc/.travis.yml, openfx-io/.travis.yml.
You can install TuttleOFX using homebrew:
brew tap homebrew/science homebrew/x11 homebrew/python cbenhagen/video
brew install tuttleofx
Or have a look at the instructions for building on MacPorts as well as precompiled universal binaries.