IECoreUSD::ShaderAlgo : Round-trip ColorSpace data on shader parameters.

Author: Alex Fuller

Changes

@@ -1,6 +1,11 @@
 10.6.x.x (relative to 10.6.0.1)
 ========
 
+Features
+--------
+
+- IECoreUSD::ShaderAlgo : Round-trip ColorSpace data that is stored on USD Attributes by storing an additional parameter with the `_colorspace` suffix.
+
 API
 ---
 
@@ -52,94 +57,6 @@ Breaking Changes
 - SmoothSkinningData : Removed, along with all associated Ops and Parameters.
 
 10.5.x.x (relative to 10.5.15.4)
-=======
-
-
-
-10.5.15.4 (relative to 10.5.15.3)
-========
-
-Improvements
------
-
-- IECoreUSD: Added support for root level tags (reading/writing) to our IECoreUSD::SceneCacheData plugin.
-
-Fixes
------
-
-- IECoreUSD: Fixed crash when using invalid file path with IECoreUSD::SceneCacheFileFormat.
-
-10.5.15.3 (relative to 10.5.15.2)
-=========
-
-Fixes
------
-
-- USDScene : Worked around numerical imprecision when converting between time and UsdTimeCode.
-
-10.5.15.2 (relative to 10.5.15.1)
-=========
-
-Fixes
------
-
-- VDBObject : Fixed worldBound() result when bbox metadata not already present.
-
-API
----
-
-- SConstruct : Install "private" headers.
-- VDBObject : Marked metadata() as deprecated.
-
-10.5.15.1 (relative to 10.5.15.0)
-=========
-
-Fixes
------
-
-- USDScene : Fixed reading of bounds from prims with `extentsHint` and model `kind` but without UsdGeomModelAPI applied.
-
-10.5.15.0 (relative to 10.5.14.1)
-=========
-
-Improvements
-------------
-
-- USDScene : Added loading of ArnoldAlembic, ArnoldUsd and ArnoldProceduralCustom prims as Cortex ExternalProcedural objects.
-
-Fixes
------
-
-- USDScene : Fixed loading of instanced UsdSkel geometry with unique animation applied.
-
-10.5.14.1 (relative to 10.5.14.0)
-=========
-
-Fixes
------
-
-- Boost : Fixed compatibility with Boost 1.82.
-
-10.5.14.0 (relative to 10.5.13.1)
-=========
-
-Features
---------
-
-- ObjectMatrix : Added new class providing an object that holds a matrix of child objects.
-
-Fixes
------
-
-- Alembic : Fixed crashes caused by invalid UVs.
-
-10.5.13.1 (relative to 10.5.13.0)
-=========
-
-Fixes
------
-
-- USD : Fixed compatibility with USD 25.05.
 
 10.5.13.0 (relative to 10.5.12.0)
 =========

contrib/IECoreUSD/src/IECoreUSD/ShaderAlgo.cpp

@@ -244,6 +244,16 @@ IECore::InternedString readShaderNetworkWalk( const pxr::SdfPath &anchorPath, co
 		if( IECore::DataPtr d = IECoreUSD::DataAlgo::fromUSD( pxr::UsdAttribute( valueAttribute ) ) )
 		{
 			parameters[fromUSDParameterName( i.GetBaseName() )] = d;
+			// If there's colorspace data on the parameter, we can store this as
+			// `<name>_colorspace`, this is how MaterialX stores colorspace on
+			// generated OSL nodes so we match here the same behaviour.
+			if( pxr::UsdAttribute( valueAttribute ).HasColorSpace() )
+			{
+				const IECore::InternedString colorSpace( pxr::UsdAttribute( valueAttribute ).GetColorSpace().GetString() );
+				const IECore::InternedString paramName(
+					( boost::format( "%s_colorspace" ) % fromUSDParameterName( i.GetBaseName() ).string() ).str() );
+				parameters[paramName] = new IECore::InternedStringData( colorSpace );
+			}
 		}
 	}
 
@@ -334,6 +344,13 @@ void writeShaderParameterValues( const IECoreScene::Shader *shader, pxr::UsdShad
 			continue;
 		}
 
+		// Skip colorspace parameters, these will be set using SetColorSpace() on the
+		// USD attribue that it corresponds to.
+		if( boost::ends_with( p.first.string(), "_colorspace" ) )
+		{
+			continue;
+		}
+
 		const pxr::TfToken usdParameterName = toUSDParameterName( p.first );
 		pxr::UsdShadeInput input = usdShader.GetInput( usdParameterName );
 		if( !input )
@@ -364,6 +381,17 @@ void writeShaderParameterValues( const IECoreScene::Shader *shader, pxr::UsdShad
 			}
 		}
 		input.Set( IECoreUSD::DataAlgo::toUSD( p.second.get() ) );
+
+		// Make sure to set any colorspace parameters onto the attribute
+		// if any exist.
+		auto it = shader->parameters().find( ( boost::format( "%s_colorspace" ) % p.first.string() ).str() );
+		if( it != shader->parameters().end() )
+		{
+			if( auto *s = IECore::runTimeCast<IECore::InternedStringData>( it->second.get() ) )
+			{
+				pxr::UsdAttribute( input ).SetColorSpace( pxr::TfToken( s->readable().string() ) );
+			}
+		}
 	}
 
 	if( shader->blindData()->readable().size() )

contrib/IECoreUSD/test/IECoreUSD/USDSceneTest.py

@@ -2932,6 +2932,7 @@ def testShaders( self ) :
 
 		texture = IECoreScene.Shader( "texture", "ai:shader" )
 		texture.parameters["filename"] = IECore.StringData( "sometexture.tx" )
+		texture.parameters["filename_colorspace"] = IECore.InternedStringData( "ACEScg" )
 
 		oneShaderNetwork = IECoreScene.ShaderNetwork()
 		oneShaderNetwork.addShader( "foo", surface )
@@ -3119,6 +3120,8 @@ def testShaders( self ) :
 		textureUsd = pxr.UsdShade.Shader( add1Source[0].GetPrim() )
 		self.assertEqual( textureUsd.GetShaderId(), "arnold:texture" )
 		self.assertEqual( textureUsd.GetInput( "filename" ).Get(), "sometexture.tx" )
+		self.assertEqual( add1Source[0].GetPrim().GetAttribute( "inputs:filename" ).GetColorSpace(), "ACEScg" )
+		self.assertEqual( add1Source[0].GetPrim().HasAttribute( "inputs:filename_colorspace" ), False )
 
 
 		# Read via SceneInterface, and check that we've round-tripped successfully.
@@ -3395,6 +3398,15 @@ def testTextureParameters( self ) :
 			os.path.normcase( os.path.normpath( network.getShader( "udimTexture" ).parameters["file"].value ) ),
 			os.path.normcase( os.path.normpath( "/full/path/to/myTexture.<UDIM>.tx" ) )
 		)
+		self.assertEqual(
+			network.getShader( "relativeTexture" ).parameters["file_colorspace"].value, "ACEScg"
+		)
+		self.assertEqual(
+			network.getShader( "relativeUDIMTexture" ).parameters["file_colorspace"].value, "lin_rec709_scene"
+		)
+		self.assertEqual(
+			network.getShader( "udimTexture" ).parameters["file_colorspace"].value, "srgb_rec709_scene"
+		)
 
 	def testExposedShaderInput( self ) :
 

contrib/IECoreUSD/test/IECoreUSD/data/textureParameters.usda

@@ -29,22 +29,28 @@ def "model"
 			def Shader "relativeTexture"
 			{
 				uniform token info:id = "UsdUVTexture"
-				asset inputs:file = @../myTexture.tx@
+				asset inputs:file = @../myTexture.tx@ (
+					colorSpace = "ACEScg"
+				)
 				vector3f outputs:rgb
 			}
 
 			def Shader "relativeUDIMTexture"
 			{
 				uniform token info:id = "UsdUVTexture"
-				asset inputs:file = @../myTexture.<UDIM>.tx@
+				asset inputs:file = @../myTexture.<UDIM>.tx@ (
+					colorSpace = "lin_rec709_scene"
+				)
 				vector3f outputs:rgb
 
 			}
 
 			def Shader "udimTexture"
 			{
 				uniform token info:id = "UsdUVTexture"
-				asset inputs:file = @/full/path/to/myTexture.<UDIM>.tx@
+				asset inputs:file = @/full/path/to/myTexture.<UDIM>.tx@ (
+					colorSpace = "srgb_rec709_scene"
+				)
 				float outputs:r
 			}
 		}