Merge pull request #1351 from murraystevenson/goodbyeAppleseed

Remove IECoreAppleseed

Author: johnhaddon

.github/workflows/main.yml

@@ -44,7 +44,7 @@ jobs:
             containerImage: ghcr.io/gafferhq/build/build:2.0.0
             options: .github/workflows/main/options.posix
             dependenciesURL: https://github.com/GafferHQ/dependencies/releases/download/6.0.0/gafferDependencies-6.0.0-linux.tar.gz
-            tests: testCore testCorePython testScene testImage testAlembic testUSD testVDB testAppleseed
+            tests: testCore testCorePython testScene testImage testAlembic testUSD testVDB
             publish: true
 
           - name: linux-python3-debug
@@ -53,7 +53,7 @@ jobs:
             containerImage: ghcr.io/gafferhq/build/build:2.0.0
             options: .github/workflows/main/options.posix
             dependenciesURL: https://github.com/GafferHQ/dependencies/releases/download/6.0.0/gafferDependencies-6.0.0-linux.tar.gz
-            tests: testCore testCorePython testScene testImage testAlembic testUSD testVDB testAppleseed
+            tests: testCore testCorePython testScene testImage testAlembic testUSD testVDB
             publish: false
 
           - name: windows-python3

.github/workflows/main/options.posix

@@ -59,13 +59,6 @@ TBB_INCLUDE_PATH = includes
 USD_INCLUDE_PATH = includes
 USD_LIB_PREFIX = "usd_"
 
-# Renderers
-# =========
-
-APPLESEED_ROOT = deps + "/appleseed"
-APPLESEED_INCLUDE_PATH = deps + "/appleseed/include"
-APPLESEED_LIB_PATH = deps + "/appleseed/lib"
-
 # Environment
 # ===========
 

.github/workflows/main/options.windows

@@ -47,13 +47,6 @@ USD_LIB_PATH = libs
 USD_LIB_PREFIX = "usd_"
 DOXYGEN = deps + "\\doxygen\\doxygen.exe"
 
-# Renderers
-# =========
-
-APPLESEED_ROOT = deps + "\\appleseed"
-APPLESEED_INCLUDE_PATH = deps + "\\appleseed\\include"
-APPLESEED_LIB_PATH = deps + "\\appleseed\\lib"
-
 # DCC Integrations
 # ================
 NUKE_ROOT = ""

Changes

@@ -4,6 +4,7 @@
 Breaking Changes
 ----------------
 
+- IECoreAppleseed : Removed. With Appleseed's removal from Gaffer `1.3.0.0` Cortex no longer provides IECoreAppleseed.
 - Python : Removed support for Python 2.
 - Primitive : Changed `variableIndexedView()` return type from `boost::optional` to `std::optional`.
 

README.md

@@ -5,7 +5,7 @@
 
 Cortex is a cross-application framework for computation, rendering, and file I/O that provides a set of high-quality C++ libraries and Python modules tailored for software development in the VFX industry. This project focuses on creating a set of practical and reusable modules for technical directors, CG supervisors, and programmers, freeing them to focus on innovation and new features in their software projects.
 
-Out of the box, Cortex has full support for the [Arnold](https://www.arnoldrenderer.com/arnold/), [Appleseed](https://appleseedhq.net), and [3Delight](https://www.3delight.com) renderers. It also has built-in integration with Maya, Houdini, and Nuke, with default user interfaces that provide for file I/O and live data manipulation. With its extensible API, Cortex’s DCC integration can be expanded to create custom tools to solve studio pipeline needs.
+Out of the box, Cortex has full support for the [Arnold](https://www.arnoldrenderer.com/arnold/) and [3Delight](https://www.3delight.com) renderers. It also has built-in integration with Maya, Houdini, and Nuke, with default user interfaces that provide for file I/O and live data manipulation. With its extensible API, Cortex’s DCC integration can be expanded to create custom tools to solve studio pipeline needs.
 
 You can find out more from our [introductory paper on Cortex](https://github.com/ImageEngine/cortex/wiki/pdfs/AnOpenSourceFrameworkForVisualEffectsSoftwareDevelopment.pdf) and the [Cortex presentations at SIGGRAPH 2011](https://vimeo.com/album/5504655).
 

SConstruct

@@ -557,20 +557,6 @@ o.Add(
 	"",
 )
 
-# appleseed options
-
-o.Add(
-	"APPLESEED_INCLUDE_PATH",
-	"The path to the appleseed include directory.",
-	"",
-)
-
-o.Add(
-	"APPLESEED_LIB_PATH",
-	"The path to the appleseed lib directory.",
-	"",
-)
-
 # Build options
 
 o.Add(
@@ -671,14 +657,6 @@ o.Add(
 	"$INSTALL_PREFIX/lib/$IECORE_NAME",
 )
 
-o.Add(
-	"INSTALL_APPLESEEDLIB_NAME",
-	"The name under which to install the appleseed libraries. This "
-	"can be used to build and install the library for multiple "
-	"appleseed versions.",
-	"$INSTALL_PREFIX/lib/$IECORE_NAME",
-)
-
 o.Add(
 	"INSTALL_PYTHON_DIR",
 	"The directory in which to install python modules.",
@@ -757,12 +735,6 @@ o.Add(
 	"$INSTALL_PREFIX/nuke/plugins/$IECORE_NAME",
 )
 
-o.Add(
-	"INSTALL_APPLESEEDOUTPUTDRIVER_NAME",
-	"The name under which to install the appleseed output driver.",
-	"$INSTALL_PREFIX/appleseedDisplays/$IECORE_NAME",
-)
-
 o.Add(
 	"INSTALL_DOC_DIR",
 	"The directory in which to install the documentation.",
@@ -955,14 +927,6 @@ o.Add(
 	"contrib/IECoreUSD/test/IECoreUSD/All.py"
 )
 
-o.Add(
-	"TEST_APPLESEED_SCRIPT",
-	"The python script to run for the appleseed tests. The default will run all the tests, "
-	"but it can be useful to override this to run just the test for the functionality "
-	"you're working on.",
-	"contrib/IECoreAppleseed/test/IECoreAppleseed/All.py"
-)
-
 o.Add(
 	"TEST_LIBPATH",
 	"Additional colon separated (semi-colon on Windows) paths to be prepended to the "
@@ -3267,156 +3231,6 @@ if doConfigure :
 		NoCache( alembicTest )
 		alembicTestEnv.Alias( "testAlembic", alembicTest )
 
-###########################################################################################
-# Build, install and test the IECoreAppleseed library and bindings
-###########################################################################################
-
-appleseedEnvSets = {
-	"IECORE_NAME" : "IECoreAppleseed"
-}
-
-appleseedEnv = env.Clone( **appleseedEnvSets )
-
-appleseedEnvAppends = {
-	"CXXFLAGS" : [
-		"-DIECoreAppleseed_EXPORTS",
-		systemIncludeArgument, "$APPLESEED_INCLUDE_PATH",
-		systemIncludeArgument, "$OSL_INCLUDE_PATH",
-		systemIncludeArgument, "$OIIO_INCLUDE_PATH",
-	],
-	"CPPPATH" : [
-		"contrib/IECoreAppleseed/include",
-	],
-	"CPPFLAGS" : [
-		"-DAPPLESEED_ENABLE_IMATH_INTEROP",
-	],
-	"LIBPATH" : [
-		"$APPLESEED_LIB_PATH",
-		"$OSL_LIB_PATH",
-		"$OIIO_LIB_PATH"
-	],
-}
-
-if platform.machine() != "arm64" :
-	appleseedEnvAppends["CPPFLAGS"].append( "-DAPPLESEED_USE_SSE" )
-
-appleseedEnv.Append( **appleseedEnvAppends )
-
-appleseedPythonModuleEnv = pythonModuleEnv.Clone( **appleseedEnvSets )
-appleseedPythonModuleEnv.Append( **appleseedEnvAppends)
-appleseedPythonModuleEnv.Append(
-	CPPPATH = [
-		"contrib/IECoreAppleseed/include/bindings",
-	],
-)
-
-appleseedDriverEnv = appleseedEnv.Clone( IECORE_NAME = "ieDisplay" )
-appleseedDriverEnv["SHLIBPREFIX"] = ""
-appleseedDriverEnv["SHLIBSUFFIX"] = ".so" if env["PLATFORM"] != "win32" else ".dll"
-
-haveAppleseed = False
-
-if doConfigure :
-
-	c = configureSharedLibrary( appleseedEnv )
-
-	if not c.CheckLibWithHeader( "appleseed", "renderer/api/rendering.h", "CXX" ) :
-
-		sys.stderr.write( "WARNING : no appleseed library found, not building IECoreAppleseed - check APPLESEED_INCLUDE_PATH and APPLESEED_LIB_PATH.\n" )
-		c.Finish()
-
-	else :
-
-		haveAppleseed = True
-
-		appleseedSources = sorted( glob.glob( "contrib/IECoreAppleseed/src/IECoreAppleseed/*.cpp" ) )
-		appleseedHeaders = glob.glob( "contrib/IECoreAppleseed/include/IECoreAppleseed/*.h" ) + glob.glob( "contrib/IECoreAppleseed/include/IECoreAppleseed/*.inl" )
-		appleseedPythonSources = sorted( glob.glob( "contrib/IECoreAppleseed/src/IECoreAppleseed/bindings/*.cpp" ) )
-		appleseedPythonScripts = glob.glob( "contrib/IECoreAppleseed/python/IECoreAppleseed/*.py" )
-
-		c.Finish()
-
-		appleseedEnv.Append(
-			LIBS = [
-				"appleseed",
-				# We can't append this before configuring, as then it gets built as
-				# part of the configure process
-				os.path.basename( coreEnv.subst( "$INSTALL_LIB_NAME" ) ),
-				os.path.basename( sceneEnv.subst( "$INSTALL_LIB_NAME" ) ),
-			]
-		)
-
-		appleseedPythonModuleEnv.Append(
-			LIBS = [
-				os.path.basename( corePythonEnv.subst( "$INSTALL_PYTHONLIB_NAME" ) ),
-				os.path.basename( sceneEnv.subst( "$INSTALL_LIB_NAME" ) ),
-			]
-		)
-
-		appleseedDriverEnv.Append(
-			LIBS = [
-				"appleseed",
-				os.path.basename( coreEnv.subst( "$INSTALL_LIB_NAME" ) ),
-				os.path.basename( imageEnv.subst( "$INSTALL_LIB_NAME" ) ),
-				os.path.basename( appleseedEnv.subst( "$INSTALL_LIB_NAME" ) ),
-			]
-		)
-
-		# library
-		appleseedLibrary = appleseedEnv.SharedLibrary( "lib/" + os.path.basename( appleseedEnv.subst( "$INSTALL_APPLESEEDLIB_NAME" ) ), appleseedSources )
-		appleseedLibraryInstall = appleseedEnv.Install( os.path.dirname( appleseedEnv.subst( "$INSTALL_APPLESEEDLIB_NAME" ) ), appleseedLibrary )
-		appleseedEnv.NoCache( appleseedLibraryInstall )
-		appleseedEnv.AddPostAction( appleseedLibraryInstall, lambda target, source, env : makeLibSymLinks( appleseedEnv ) )
-		appleseedEnv.Alias( "install", appleseedLibraryInstall )
-		appleseedEnv.Alias( "installAppleseed", appleseedLibraryInstall )
-		appleseedEnv.Alias( "installLib", [ appleseedLibraryInstall ] )
-
-		# headers
-		appleseedHeaderInstall = appleseedEnv.Install( "$INSTALL_HEADER_DIR/IECoreAppleseed", appleseedHeaders )
-		appleseedEnv.AddPostAction( "$INSTALL_HEADER_DIR/IECoreAppleseed", lambda target, source, env : makeSymLinks( appleseedEnv, appleseedEnv["INSTALL_HEADER_DIR"] ) )
-		appleseedEnv.Alias( "install", appleseedHeaderInstall )
-		appleseedEnv.Alias( "installAppleseed", appleseedHeaderInstall )
-
-		# python module
-		appleseedPythonModuleEnv.Append(
-			LIBS = [
-				os.path.basename( coreEnv.subst( "$INSTALL_LIB_NAME" ) ),
-				os.path.basename( appleseedEnv.subst( "$INSTALL_LIB_NAME" ) ),
-				"appleseed",
-			]
-		)
-		appleseedPythonModule = appleseedPythonModuleEnv.SharedLibrary( "contrib/IECoreAppleseed/python/IECoreAppleseed/_IECoreAppleseed", appleseedPythonSources )
-		appleseedPythonModuleEnv.Depends( appleseedPythonModule, appleseedLibrary )
-
-		appleseedPythonModuleInstall = appleseedPythonModuleEnv.Install( "$INSTALL_PYTHON_DIR/IECoreAppleseed", appleseedPythonScripts + appleseedPythonModule )
-		appleseedPythonModuleEnv.AddPostAction( "$INSTALL_PYTHON_DIR/IECoreAppleseed", lambda target, source, env : makeSymLinks( appleseedPythonModuleEnv, appleseedPythonModuleEnv["INSTALL_PYTHON_DIR"] ) )
-		appleseedPythonModuleEnv.Alias( "install", appleseedPythonModuleInstall )
-		appleseedPythonModuleEnv.Alias( "installAppleseed", appleseedPythonModuleInstall )
-
-
-		# output driver
-		appleseedDriver = appleseedDriverEnv.SharedLibrary( "contrib/IECoreAppleseed/src/IECoreAppleseed/outputDriver/" + os.path.basename( appleseedDriverEnv.subst( "$INSTALL_APPLESEEDOUTPUTDRIVER_NAME" ) ), "contrib/IECoreAppleseed/src/IECoreAppleseed/outputDriver/DisplayTileCallback.cpp" )
-		appleseedDriverInstall = appleseedDriverEnv.Install( os.path.dirname( appleseedDriverEnv.subst( "$INSTALL_APPLESEEDOUTPUTDRIVER_NAME" ) ), appleseedDriver )
-		appleseedDriverEnv.NoCache( appleseedDriverInstall )
-		appleseedDriverEnv.AddPostAction( appleseedDriverInstall, lambda target, source, env : makeLibSymLinks( appleseedDriverEnv, libNameVar="INSTALL_APPLESEEDOUTPUTDRIVER_NAME" ) )
-		appleseedDriverEnv.Alias( "install", appleseedDriverInstall )
-		appleseedDriverEnv.Alias( "installAppleseed", appleseedDriverInstall )
-		appleseedDriverForTest = appleseedDriverEnv.Install( "contrib/IECoreAppleseed/test/IECoreAppleseed/plugins", appleseedDriver )
-
-		Default( [ appleseedLibrary, appleseedPythonModule, appleseedDriver, appleseedDriverForTest ] )
-
-		# tests
-		appleseedTestEnv = testEnv.Clone()
-		appleseedTestEnv["ENV"]["PYTHONPATH"] += ":./contrib/IECoreAppleseed/python" + os.pathsep + appleseedEnv.subst( "$APPLESEED_LIB_PATH/python" + pythonEnv["PYTHON_VERSION"] )
-		appleseedTestEnv["ENV"][testEnv["TEST_LIBRARY_PATH_ENV_VAR"]] += os.pathsep + appleseedEnv.subst( os.pathsep.join( appleseedPythonModuleEnv["LIBPATH"] ) )
-		appleseedTestEnv["ENV"]["PATH"] = appleseedEnv.subst( "$APPLESEED_ROOT/bin" ) + os.pathsep + appleseedTestEnv["ENV"]["PATH"]
-		appleseedTestEnv["ENV"]["APPLESEED_SEARCHPATH"] = os.getcwd() + "/contrib/IECoreAppleseed/test/IECoreAppleseed/plugins"
-		appleseedTest = appleseedTestEnv.Command( "contrib/IECoreAppleseed/test/IECoreAppleseed/results.txt", appleseedPythonModule, "$PYTHON $TEST_APPLESEED_SCRIPT --verbose" )
-		NoCache( appleseedTest )
-		appleseedTestEnv.Depends( appleseedTest, [ corePythonModule, scenePythonModule, appleseedPythonModule, appleseedLibrary, appleseedDriverForTest ] )
-		appleseedTestEnv.Depends( appleseedTest, glob.glob( "contrib/IECoreAppleseed/test/IECoreAppleseed/*.py" ) )
-		appleseedTestEnv.Alias( "testAppleseed", appleseedTest )
-
 ###########################################################################################
 # Documentation
 ###########################################################################################

config/ie/buildAll

@@ -110,7 +110,6 @@ def installDocs() :
 
 compilerVersions = IEBuild.utils.versionsToInstall( "gcc" )
 pythonVersions = IEBuild.utils.versionsToInstall( "python" )
-appleseedVersions = IEBuild.utils.versionsToInstall( "appleseed" )
 mayaVersions = IEBuild.utils.versionsToInstall( "maya" )
 nukeVersions = IEBuild.utils.versionsToInstall( "nuke" )
 houdiniVersions = IEBuild.utils.versionsToInstall( "houdini" )
@@ -120,35 +119,22 @@ if platform in ( "cent7.x86_64", ) :
 
 	for compilerVersion in compilerVersions:
 		for pythonVersion in pythonVersions :
-			build( [ "COMPILER_VERSION="+compilerVersion, "PYTHON_VERSION="+pythonVersion, "APPLESEED_VERSION=UNDEFINED", "DL_VERSION=UNDEFINED" ] )
-
-	appleseedCompilerMap = { x : [] for x in compilerVersions }
-	for appleseedVersion in appleseedVersions:
-		compilerVersion = IEEnv.registry["apps"]["appleseed"][appleseedVersion][platform]["compilerVersion"]
-		appleseedCompilerMap[compilerVersion].append( appleseedVersion )
-		for pythonVersion in pythonVersions :
-			build( [ "COMPILER_VERSION="+compilerVersion, "PYTHON_VERSION="+pythonVersion, "APPLESEED_VERSION="+appleseedVersion, "DL_VERSION=UNDEFINED" ] )
-	for appleseedCompiler, versions in appleseedCompilerMap.items() :
-		if len(versions) == 0 :
-			appleseedCompilerMap[appleseedCompiler].append( "UNDEFINED" )
+			build( [ "COMPILER_VERSION="+compilerVersion, "PYTHON_VERSION="+pythonVersion, "DL_VERSION=UNDEFINED" ] )
 
 	for mayaVersion in mayaVersions :
 		compilerVersion = IEEnv.registry["apps"]["maya"][mayaVersion][platform]["compilerVersion"]
-		appleseedVersion = appleseedCompilerMap.get( compilerVersion, appleseedVersions )[-1]
-		build( [ "APP=maya", "APP_VERSION="+mayaVersion, "APPLESEED_VERSION={0}".format(appleseedVersion)] )
+		build( [ "APP=maya", "APP_VERSION="+mayaVersion ] )
 
 	for nukeVersion in nukeVersions :
 		compilerVersion = IEEnv.registry["apps"]["nuke"][nukeVersion][platform]["compilerVersion"]
-		appleseedVersion = appleseedCompilerMap.get( compilerVersion, appleseedVersions )[-1]
-		build( [ "APP=nuke", "APP_VERSION="+nukeVersion, "APPLESEED_VERSION={0}".format(appleseedVersion) ] )
+		build( [ "APP=nuke", "APP_VERSION="+nukeVersion ] )
 
 	for houdiniVersion in houdiniVersions :
 		compilerVersion = IEEnv.registry["apps"]["houdini"][houdiniVersion][platform]["compilerVersion"]
-		appleseedVersion = appleseedCompilerMap.get( compilerVersion, appleseedVersions )[-1]
-		build( [ "APP=houdini", "APP_VERSION="+houdiniVersion, "APPLESEED_VERSION={0}".format(appleseedVersion) ] )
+		build( [ "APP=houdini", "APP_VERSION="+houdiniVersion ] )
 
 	for rvVersion in rvVersions :
-		build( [ "APP=rv", "APP_VERSION="+rvVersion, "APPLESEED_VERSION=UNDEFINED", "DL_VERSION=UNDEFINED" ] )
+		build( [ "APP=rv", "APP_VERSION="+rvVersion, "DL_VERSION=UNDEFINED" ] )
 
 	installDocs()
 

config/ie/options

@@ -248,23 +248,6 @@ if targetApp :
 	else:
 		appPrefix = os.path.join( installPrefix, targetApp, targetAppMajorVersion )
 
-appleseedReg = None
-appleseedVersion = getOption( "APPLESEED_VERSION", os.environ.get("APPLESEED_VERSION", "") )
-try :
-	appleseedReg = IEEnv.registry["apps"]["appleseed"][appleseedVersion][platform]
-except :
-	pass
-
-if appleseedReg :
-
-	APPLESEED_INCLUDE_PATH = os.path.join( appleseedReg["location"], "include" )
-	APPLESEED_LIB_PATH = os.path.join( appleseedReg["location"], "lib" )
-
-	oslVersion = appleseedReg.get( "OpenShadingLanguageVersion", cortexReg["OpenShadingLanguageVersion"] )
-	oslRoot = os.path.join( "/software", "apps", "OpenShadingLanguage", oslVersion, platform, compiler, compilerVersion )
-	OSL_INCLUDE_PATH = os.path.join( oslRoot, "include" )
-	OSL_LIB_PATH = os.path.join( oslRoot, "lib" )
-
 # ask for opengl support
 WITH_GL=1
 
@@ -464,8 +447,7 @@ testLibs = [
 	os.path.join( pythonReg["location"], compiler, compilerVersion, "lib" ),
 	os.path.join( compilerReg["location"], "lib" ),
 ]
-if appleseedReg :
-	testLibs.extend( [ APPLESEED_LIB_PATH, OSL_LIB_PATH, OIIO_LIB_PATH ] )
+
 TEST_LIBPATH = ":".join( testLibs )
 TEST_LIBRARY_PATH_ENV_VAR = "IEENV_LIBRARY_PREFIX_PATH"
 
@@ -480,18 +462,14 @@ if targetApp :
 	INSTALL_LIB_NAME = os.path.join( appPrefix, "lib", "$IECORE_NAME-$IECORE_COMPATIBILITY_VERSION" )
 	INSTALL_PYTHONLIB_NAME = os.path.join( appPrefix, "lib", "$IECORE_NAME-$IECORE_COMPATIBILITY_VERSION-python$PYTHON_VERSION" )
 	INSTALL_PYTHON_DIR = os.path.join( appPrefix, "python" )
-	INSTALL_APPLESEEDLIB_NAME = os.path.join( appPrefix, "lib", "$IECORE_NAME-$IECORE_COMPATIBILITY_VERSION" )
 	INSTALL_ALEMBICLIB_NAME = os.path.join( appPrefix, "lib", "$IECORE_NAME-$IECORE_COMPATIBILITY_VERSION" )
 	INSTALL_USDLIB_NAME = os.path.join( appPrefix, "lib", "$IECORE_NAME-$IECORE_COMPATIBILITY_VERSION" )
-	INSTALL_APPLESEEDOUTPUTDRIVER_NAME = os.path.join( "tmp", os.environ['USER'], "unwantedAppleseedDrivers/$IECORE_NAME-$IECORE_COMPATIBILITY_VERSION" )
 else :
 	INSTALL_HEADER_DIR = os.path.join( basePrefix, "include" )
 	INSTALL_USD_RESOURCE_DIR = os.path.join( basePrefix, "resource" )
 	INSTALL_LIB_NAME = os.path.join( basePrefix, "lib", compiler, compilerVersion, "$IECORE_NAME-$IECORE_COMPATIBILITY_VERSION" )
 	INSTALL_PYTHONLIB_NAME = os.path.join( basePrefix, "lib", compiler, compilerVersion, "$IECORE_NAME-$IECORE_COMPATIBILITY_VERSION-python$PYTHON_VERSION" )
 	INSTALL_PYTHON_DIR = os.path.join( basePrefix, "python", pythonVersion, compiler, compilerVersion )
-	INSTALL_APPLESEEDLIB_NAME = os.path.join( basePrefix, "appleseed", appleseedVersion, "lib", compiler, compilerVersion, "$IECORE_NAME-$IECORE_COMPATIBILITY_VERSION" )
-	INSTALL_APPLESEEDOUTPUTDRIVER_NAME = os.path.join( basePrefix, "appleseed", appleseedVersion, "plugins", compiler, compilerVersion, "$IECORE_NAME" )
 	INSTALL_ALEMBICLIB_NAME = os.path.join( basePrefix, "lib", compiler, compilerVersion, "$IECORE_NAME-$IECORE_COMPATIBILITY_VERSION" )
 	INSTALL_USDLIB_NAME = os.path.join( basePrefix, "lib", compiler, compilerVersion, "$IECORE_NAME-$IECORE_COMPATIBILITY_VERSION" )