Enhancement: Color management for Houdini workfiles

openpype/hosts/houdini/api/lib.py

@@ -866,6 +866,48 @@ def get_current_context_template_data_with_asset_data():
     return template_data
 
 
+def set_review_color_space(opengl_node, review_color_space="", log=None):
+    """Set ociocolorspace parameter for the given OpenGL node.
+
+    Set `ociocolorspace` parameter of the given OpenGl node
+    to to the given review_color_space value.
+    If review_color_space is empty, a default colorspace corresponding to
+    the display & view of the current Houdini session will be used.
+
+    Args:
+        opengl_node (hou.Node): ROP node to set its ociocolorspace parm.
+        review_color_space (str): Colorspace value for ociocolorspace parm.
+        log (logging.Logger): Logger to log to.
+    """
+
+    if log is None:
+        log = self.log
+
+    # Set Color Correction parameter to OpenColorIO
+    colorcorrect_parm = opengl_node.parm("colorcorrect")
+    if colorcorrect_parm.eval() != 2:
+        colorcorrect_parm.set(2)
+        log.debug(
+            "'Color Correction' parm on '{}' has been set to"
+            " 'OpenColorIO'".format(opengl_node.path())
+        )
+
+    # fall to default review color space if the setting is empty.
+    if not review_color_space:
+        from openpype.hosts.houdini.api.colorspace import get_default_display_view_colorspace  # noqa
+        review_color_space = get_default_display_view_colorspace()
+
+    opengl_node.setParms(
+        {"ociocolorspace": review_color_space}
+    )
+
+    self.log.debug(
+        "'OCIO Colorspace' parm on '{}' has been set to "
+        "the view color space '{}'"
+        .format(opengl_node, review_color_space)
+    )
+
+
 def get_context_var_changes():
     """get context var changes."""
 

openpype/hosts/houdini/hooks/set_default_display_and_view.py

@@ -0,0 +1,58 @@
+from openpype.lib.applications import PreLaunchHook, LaunchTypes
+
+
+class SetDefaultDisplayView(PreLaunchHook):
+    """Set default view and default display for houdini via OpenColorIO.
+
+    Houdini's defaultDisplay and defaultView are set by
+    setting 'OCIO_ACTIVE_DISPLAYS' and 'OCIO_ACTIVE_VIEWS'
+    environment variables respectively.
+
+    More info: https://www.sidefx.com/docs/houdini/io/ocio.html#set-up
+    """
+
+    app_groups = {"houdini"}
+    launch_types = {LaunchTypes.local}
+
+    def execute(self):
+
+        OCIO = self.launch_context.env.get("OCIO")
+
+        # This is a cheap way to skip this hook if either global color
+        # management or houdini color management was disabled because the
+        # OCIO var would be set by the global OCIOEnvHook
+        if not OCIO:
+            return
+
+        houdini_color_settings = \
+            self.data["project_settings"]["houdini"]["imageio"]["workfile"]
+
+        if not houdini_color_settings["enabled"]:
+            self.log.info(
+                "Houdini workfile color management is disabled."
+            )
+            return
+
+        # 'OCIO_ACTIVE_DISPLAYS', 'OCIO_ACTIVE_VIEWS' are checked
+        # as Admins can add them in Ayon env vars or Ayon tools.
+
+        default_display = houdini_color_settings["default_display"]
+        if default_display:
+            # get 'OCIO_ACTIVE_DISPLAYS' value if exists.
+            self._set_context_env("OCIO_ACTIVE_DISPLAYS", default_display)
+
+        default_view = houdini_color_settings["default_view"]
+        if default_view:
+            # get 'OCIO_ACTIVE_VIEWS' value if exists.
+            self._set_context_env("OCIO_ACTIVE_VIEWS", default_view)
+
+    def _set_context_env(self, env_var, default_value):
+        env_value = self.launch_context.env.get(env_var, "")
+        new_value = ":".join(
+            key for key in [default_value, env_value] if key
+        )
+        self.log.info(
+            "Setting {} environment to: {}"
+            .format(env_var, new_value)
+        )
+        self.launch_context.env[env_var] = new_value

openpype/hosts/houdini/plugins/create/create_review.py

@@ -2,7 +2,7 @@
 """Creator plugin for creating openGL reviews."""
 from openpype.hosts.houdini.api import plugin
 from openpype.lib import EnumDef, BoolDef, NumberDef
-
+from openpype.hosts.houdini.api.lib import set_review_color_space
 import os
 import hou
 
@@ -14,6 +14,11 @@ class CreateReview(plugin.HoudiniCreator):
     label = "Review"
     family = "review"
     icon = "video-camera"
+    workfile_color_settings = {}
+
+    def apply_settings(self, project_settings):
+        super(CreateReview, self).apply_settings(project_settings)
+        self.workfile_color_settings = project_settings["houdini"]["imageio"]["workfile"]  # noqa
 
     def create(self, subset_name, instance_data, pre_create_data):
 
@@ -87,7 +92,15 @@ def create(self, subset_name, instance_data, pre_create_data):
         # Set OCIO Colorspace to the default output colorspace
         #  if there's OCIO
         if os.getenv("OCIO"):
-            self.set_colorcorrect_to_default_view_space(instance_node)
+            workfile_color_settings = self.project_settings["houdini"]["imageio"]["workfile"]  # noqa
+            review_color_space = workfile_color_settings["enabled"] and \
+                workfile_color_settings["review_color_space"]
+
+            set_review_color_space(
+                instance_node,
+                review_color_space,
+                log=self.log)
+
 
         to_lock = ["id", "family"]
 
@@ -130,23 +143,3 @@ def get_pre_create_attr_defs(self):
                       minimum=0.0001,
                       decimals=3)
         ]
-
-    def set_colorcorrect_to_default_view_space(self,
-                                               instance_node):
-        """Set ociocolorspace to the default output space."""
-        from openpype.hosts.houdini.api.colorspace import get_default_display_view_colorspace  # noqa
-
-        # set Color Correction parameter to OpenColorIO
-        instance_node.setParms({"colorcorrect": 2})
-
-        # Get default view space for ociocolorspace parm.
-        default_view_space = get_default_display_view_colorspace()
-        instance_node.setParms(
-            {"ociocolorspace": default_view_space}
-        )
-
-        self.log.debug(
-            "'OCIO Colorspace' parm on '{}' has been set to "
-            "the default view color space '{}'"
-            .format(instance_node, default_view_space)
-        )

openpype/hosts/houdini/plugins/publish/extract_composite.py

@@ -7,7 +7,8 @@
 import hou
 
 
-class ExtractComposite(publish.Extractor):
+class ExtractComposite(publish.Extractor,
+                       publish.ColormanagedPyblishPluginMixin):
 
     order = pyblish.api.ExtractorOrder
     label = "Extract Composite (Image Sequence)"
@@ -45,8 +46,14 @@ def process(self, instance):
             "frameEnd": instance.data["frameEndHandle"],
         }
 
-        from pprint import pformat
-
-        self.log.info(pformat(representation))
+        if ext == "exr":
+            # Inject colorspace with 'scene_linear' as that's the
+            # default Houdini working colorspace and all extracted
+            # OpenEXR images should be in that colorspace.
+            # https://www.sidefx.com/docs/houdini/render/linear.html#image-formats
+            self.set_representation_colorspace(
+                representation, instance.context,
+                colorspace="scene_linear"
+            )
 
         instance.data["representations"].append(representation)

openpype/hosts/houdini/plugins/publish/extract_opengl.py

@@ -8,7 +8,8 @@
 import hou
 
 
-class ExtractOpenGL(publish.Extractor):
+class ExtractOpenGL(publish.Extractor,
+                    publish.ColormanagedPyblishPluginMixin):
 
     order = pyblish.api.ExtractorOrder - 0.01
     label = "Extract OpenGL"
@@ -46,6 +47,14 @@ def process(self, instance):
             "camera_name": instance.data.get("review_camera")
         }
 
+        if ropnode.evalParm("colorcorrect") == 2:  # OpenColorIO enabled
+            colorspace = ropnode.evalParm("ociocolorspace")
+            # inject colorspace data
+            self.set_representation_colorspace(
+                representation, instance.context,
+                colorspace=colorspace
+            )
+
         if "representations" not in instance.data:
             instance.data["representations"] = []
         instance.data["representations"].append(representation)

openpype/hosts/houdini/plugins/publish/validate_review_colorspace.py

@@ -6,13 +6,14 @@
 )
 from openpype.pipeline.publish import RepairAction
 from openpype.hosts.houdini.api.action import SelectROPAction
+from openpype.hosts.houdini.api.lib import set_review_color_space
 
 import os
 import hou
 
 
-class SetDefaultViewSpaceAction(RepairAction):
-    label = "Set default view colorspace"
+class SetReviewColorSpaceAction(RepairAction):
+    label = "Set Default Review Color Space"
     icon = "mdi.monitor"
 
 
@@ -27,7 +28,7 @@ class ValidateReviewColorspace(pyblish.api.InstancePlugin,
     families = ["review"]
     hosts = ["houdini"]
     label = "Validate Review Colorspace"
-    actions = [SetDefaultViewSpaceAction, SelectROPAction]
+    actions = [SetReviewColorSpaceAction, SelectROPAction]
 
     optional = True
 
@@ -61,30 +62,42 @@ def process(self, instance):
                 .format(rop_node.path())
             )
 
+        workfile_color_settings = instance.context.data["project_settings"]["houdini"]["imageio"]["workfile"]  # noqa
+        # skip if houdini workfile color settings are disabled
+        if workfile_color_settings["enabled"]:
+            review_color_space = workfile_color_settings["review_color_space"]
+
+            # skip if review color space setting is empty.
+            if review_color_space and \
+                    rop_node.evalParm("ociocolorspace") != review_color_space:
+
+                raise PublishValidationError(
+                    "Invalid value: Colorspace name doesn't match studio "
+                    "settings.\nCheck 'OCIO Colorspace' parameter on '{}' ROP"
+                    .format(rop_node.path())
+                )
+
     @classmethod
     def repair(cls, instance):
-        """Set Default View Space Action.
+        """Set Default Review Space Action.
 
-        It is a helper action more than a repair action,
-        used to set colorspace on opengl node to the default view.
-        """
-        from openpype.hosts.houdini.api.colorspace import get_default_display_view_colorspace  # noqa
+        It sets ociocolorspace parameter.
 
-        rop_node = hou.node(instance.data["instance_node"])
+        If workfile settings are enabled, it will use the value
+        exposed in the settings.
 
-        if rop_node.evalParm("colorcorrect") != 2:
-            rop_node.setParms({"colorcorrect": 2})
-            cls.log.debug(
-                "'Color Correction' parm on '{}' has been set to"
-                " 'OpenColorIO'".format(rop_node.path())
-            )
+        If the value exposed in the settings is empty,
+        it will use the default colorspace corresponding to
+        the display & view of the current Houdini session.
+        """
+
+        opengl_node = hou.node(instance.data["instance_node"])
 
-        # Get default view colorspace name
-        default_view_space = get_default_display_view_colorspace()
+        workfile_color_settings = instance.context.data["project_settings"]["houdini"]["imageio"]["workfile"]  # noqa
+        review_color_space = workfile_color_settings["enabled"] and \
+            workfile_color_settings["review_color_space"]
 
-        rop_node.setParms({"ociocolorspace": default_view_space})
-        cls.log.info(
-            "'OCIO Colorspace' parm on '{}' has been set to "
-            "the default view color space '{}'"
-            .format(rop_node, default_view_space)
-        )
+        set_review_color_space(
+            opengl_node,
+            review_color_space,
+            log=cls.log)

openpype/settings/defaults/project_settings/houdini.json

@@ -21,6 +21,12 @@
         "file_rules": {
             "activate_host_rules": false,
             "rules": {}
+        },
+        "workfile":{
+            "enabled": false,
+            "default_display": "ACES",
+            "default_view": "sRGB",
+            "review_color_space": ""
         }
     },
     "shelves": [],

openpype/settings/entities/schemas/projects_schema/schema_project_houdini.json

@@ -19,6 +19,39 @@
                 {
                     "type": "template",
                     "name": "template_host_color_management_ocio"
+                },
+                {
+                    "key": "workfile",
+                    "type": "dict",
+                    "label": "Workfile",
+                    "collapsible": true,
+                    "checkbox_key": "enabled",
+                    "children": [
+                        {
+                            "type": "boolean",
+                            "key": "enabled",
+                            "label": "Enabled"
+                        },
+                        {
+                            "type": "label",
+                            "label": "Empty values will be skipped, allowing any existing env vars to pass through as defined.\nNote: The render space in Houdini is always set to the 'scene_linear' role."
+                        },
+                        {
+                            "type": "text",
+                            "key": "default_display",
+                            "label": "Default active displays"
+                        },
+                        {
+                            "type": "text",
+                            "key": "default_view",
+                            "label": "Default active views"
+                        },
+                        {
+                            "type": "text",
+                            "key": "review_color_space",
+                            "label": "Review colorspace"
+                        }
+                    ]
                 }
             ]
         },