Merge remote-tracking branch 'OpenPype/enhancement/OP-1017_houdini-colorspaces' into enhancement/OP-1017_houdini-colorspaces

client/ayon_core/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."""
 

client/ayon_core/hosts/houdini/hooks/set_default_display_and_view.py

@@ -0,0 +1,58 @@
+from ayon_core.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

client/ayon_core/hosts/houdini/plugins/publish/extract_composite.py

@@ -7,7 +7,8 @@ from ayon_core.hosts.houdini.api.lib import render_rop, splitext
 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 @@ class ExtractComposite(publish.Extractor):
             "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)

client/ayon_core/hosts/houdini/plugins/publish/extract_opengl.py

@@ -8,7 +8,8 @@ from ayon_core.hosts.houdini.api.lib import render_rop
 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 @@ class ExtractOpenGL(publish.Extractor):
             "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)

client/ayon_core/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": [],

server_addon/houdini/server/settings/imageio.py

@@ -34,6 +34,34 @@ class ImageIOFileRulesModel(BaseSettingsModel):
         return value
 
 
+class WorkfileImageIOModel(BaseSettingsModel):
+    """Workfile settings help.
+
+    Empty values will be skipped, allowing any existing env vars to
+    pass through as defined.
+
+    Note: The render space in Houdini is
+    always set to the 'scene_linear' role."""
+
+    enabled: bool = SettingsField(False, title="Enabled")
+    default_display: str = SettingsField(
+        title="Default active displays",
+        description="It behaves like the 'OCIO_ACTIVE_DISPLAYS' env var,"
+                    " Colon-separated list of displays, e.g ACES:P3"
+    )
+    default_view: str = SettingsField(
+        title="Default active views",
+        description="It behaves like the 'OCIO_ACTIVE_VIEWS' env var,"
+                    " Colon-separated list of views, e.g sRGB:DCDM"
+    )
+    review_color_space: str = SettingsField(
+        title="Review colorspace",
+        description="It exposes OCIO Colorspace parameter in opengl nodes."
+                    "if left empty, Ayon will figure out the default "
+                    "colorspace using your default display and default view."
+    )
+
+
 class HoudiniImageIOModel(BaseSettingsModel):
     activate_host_color_management: bool = SettingsField(
         True, title="Enable Color Management"
@@ -46,3 +74,26 @@ class HoudiniImageIOModel(BaseSettingsModel):
         default_factory=ImageIOFileRulesModel,
         title="File Rules"
     )
+    workfile: WorkfileImageIOModel = SettingsField(
+        default_factory=WorkfileImageIOModel,
+        title="Workfile"
+    )
+
+
+DEFAULT_IMAGEIO_SETTINGS = {
+    "activate_host_color_management": False,
+    "ocio_config": {
+        "override_global_config": False,
+        "filepath": []
+    },
+    "file_rules": {
+        "activate_host_rules": False,
+        "rules": []
+    },
+    "workfile": {
+        "enabled": False,
+        "default_display": "ACES",
+        "default_view": "sRGB",
+        "review_color_space": ""
+    }
+}

server_addon/houdini/server/settings/main.py

@@ -3,7 +3,10 @@ from .general import (
     GeneralSettingsModel,
     DEFAULT_GENERAL_SETTINGS
 )
-from .imageio import HoudiniImageIOModel
+from .imageio import (
+    HoudiniImageIOModel,
+    DEFAULT_IMAGEIO_SETTINGS
+)
 from .shelves import ShelvesModel
 from .create import (
     CreatePluginsModel,
@@ -40,6 +43,7 @@ class HoudiniSettings(BaseSettingsModel):
 
 DEFAULT_VALUES = {
     "general": DEFAULT_GENERAL_SETTINGS,
+    "imageio": DEFAULT_IMAGEIO_SETTINGS,
     "shelves": [],
     "create": DEFAULT_HOUDINI_CREATE_SETTINGS,
     "publish": DEFAULT_HOUDINI_PUBLISH_SETTINGS

server_addon/houdini/server/version.py

@@ -1 +1 @@
-__version__ = "0.2.11"
+__version__ = "0.2.12"