Enhancement: Color management for Houdini workfiles

[MustafaJafar]

Changelog Description

This PR adds Houdini workfiles color management

• Display: default display, it accepts Colon-separated list of displays, e.g ACES:P3, Read more Active Displays
• View: default view, it accepts Colon-separated list of view names, e.g sRGB:DCDM Read more Active Views
• Review Colorspace : Review output transform which exposes OCIO Colorspace parameter in opngl nodes, Read more Houdini OpenGL

Things to do:

• Set default view and default display: In Houdini this is done via setting OCIO_ACTIVE_DISPLAYS OCIO_ACTIVE_VIEWS
• make review creator and validator to use review color space value specified in the settings
• update color space data while review extraction
• update color space data while houdini image sequence extraction (P.S. It's the colorspace name assigned to scene_linear role.)
• fix the conflict mentioned here Enhancement: Color management for Houdini workfiles #5858 (comment)

Testing notes:

1. Test the hook functionality, case 1:
   • test : disable global color management, enable houdini color management, enable color management/workfile
   • result : Hook won't work.
2. Test the hook functionality, case 2:
   • test : enable global color management, disable houdini color management, enable color management/workfile
   • result : Hook won't work.
3. Test the hook functionality, case 3:
   • test : enable global color management, enable houdini color management, disable color management/workfile
   • result : Hook logs to console that workfile settings are disabled.
4. Test the hook functionality, case 4:
   • test : enable global color management, enable houdini color management, enable color management/workfile
   • result : Hook sets the proper environment variables with values specified in the Houdini settings, it logs to console the environment variables and in houdini you are able to see the only color spaces specified in the settings.
5. Test Review colospace, case 1:
   • test : leave Review colospace empty
   • result : default review colorspace will be used when
     • creating review instances
     • using Set Review Color Space action if Validate Review Colorspace failed
6. Test Review colospace, case 2:
   • test : add you preferred Review colospace value
   • result : this value will be used when
     • creating review instances
     • Validate Review Colorspace will check if ociocolorspace parameter has that value
     • using Set Review Color Space action if Validate Review Colorspace failed

[ynbot]

Task linked: OP-1017 houdini: colorspaces

[MustafaJafar]

To me this issue #67 looks similar to #4836 ? Are they duplicates ? if yes, tell me to make this PR close it as well.

[BigRoy]

To me this issue #67 looks similar to #4836 ? Are they duplicates ? if yes, tell me to make this PR close it as well.

@MustafaJafar That does seem like the same thing, but I do want to note that to 'get on par with nuke' and others likely we also need to test:

• (Image) Outputs from Houdini should also submit along their colorspace data if they don't already do that, so we should make sure published data for e.g. published renders or COP2 networks include colorspace information if that publish itself can have that information from Houdini of course.
• Potentially when loading say an image or anything it'd also automatically set the correct colorspace value - but purely checking out COP2 file nodes I don't see anything with regards to OCIO there at all?

[MustafaJafar]

To me this issue #67 looks similar to #4836 ? Are they duplicates ? if yes, tell me to make this PR close it as well.

@MustafaJafar That does seem like the same thing, but I do want to note that to 'get on par with nuke' and others likely we also need to test:

• (Image) Outputs from Houdini should also submit along their colorspace data if they don't already do that, so we should make sure published data for e.g. published renders or COP2 networks include colorspace information if that publish itself can have that information from Houdini of course.
• Potentially when loading say an image or anything it'd also automatically set the correct colorspace value - but purely checking out COP2 file nodes I don't see anything with regards to OCIO there at all?

This is interesting!
Currently, I have no idea how to achieve that but let's find out!

[Minkiu]

Haven't tested it, but code looks good.

[moonyuet]

The review instance published looks okay.

It also validates the colorspace right when using the project setting to make sure ocio colorspace is in a certain parameter. But it would be great if there is doc(and comment) for users to understand the use of Review Colorspace. We can't guarantee there would be some users would just put sRGB or ACEScg into the setting. Will test it in composite later.

[moonyuet]

Tested with the composite instance.
Looks good with the global color enabled. It can be possibly merged after the code tweaks.

[MustafaJafar]

Quick Note regards review colorspace:

1. Empty Review colorspace setting keeps review colorspace unmanaged which allows artists to pick any colorspace value
   
2. Set Default Review Color Space 🖥️ will set OCIO Colorspace parm in the open gl node to the same value of Review colorspace settings. and if setting is empty, it will fall to default corresponding to the default active view and display.

Tests in OP

Tests in Ayon

[fabiaserra]

Tests in Ayon

why is there a console window poping up when you click Set default review colorspace?

[MustafaJafar]

why is there a console window poping up when you click Set default review colorspace?

because of get_default_display_view_colorspace().
These function were added in #5322

OpenPype/openpype/hosts/houdini/api/colorspace.py

Lines 59 to 69 in 91a1fb1

	def get_default_display_view_colorspace():
	"""Returns the colorspace attribute of the default (display, view) pair.
	It's used for 'ociocolorspace' parm in OpenGL Node."""
	prefs = get_color_management_preferences()
	return get_display_view_colorspace_name(
	config_path=prefs["config"],
	display=prefs["display"],
	view=prefs["view"]
	)

OpenPype/openpype/pipeline/colorspace.py

Lines 1142 to 1162 in 91a1fb1

	def get_display_view_colorspace_name(config_path, display, view):
	"""Returns the colorspace attribute of the (display, view) pair.
	Args:
	config_path (str): path string leading to config.ocio
	display (str): display name e.g. "ACES"
	view (str): view name e.g. "sRGB"
	Returns:
	view color space name (str) e.g. "Output - sRGB"
	"""
	if not compatibility_check():
	# python environment is not compatible with PyOpenColorIO
	# needs to be run in subprocess
	return get_display_view_colorspace_subprocess(config_path,
	display, view)
	from openpype.scripts.ocio_wrapper import _get_display_view_colorspace_name # noqa
	return _get_display_view_colorspace_name(config_path, display, view)

[mkolar]

Because we're splitting OpenPype into ayon-core and individual host addons, this PR would have to be re-created to target one of those.

We're closing it down, but we'll he happy for a new PR to ynput/ayon-core or the host addon repository once it's up.