Maya export postprocessing (#271)

* pass any additional flags from launch into the executable

* changes to environment variable handling to allow running hython from within Maya. Added a post export function to the Maya USD exporter for running Houdini HDAs after export

Author: scottdmilner

pipeline/__main__.py

@@ -31,9 +31,13 @@ def getLevelNamesMapping():
     return logging._nameToLevel.keys()
 
 
-def launch(software_name: str, is_python_shell: bool = False) -> None:
+def launch(
+    software_name: str,
+    is_python_shell: bool = False,
+    extra_args: list[str] | None = None,
+) -> None:
     software = find_implementation(DCCInterface, f"software.{software_name}")
-    software(is_python_shell).launch()
+    software(is_python_shell, extra_args).launch()
 
 
 if __name__ == "__main__":
@@ -58,13 +62,13 @@ def launch(software_name: str, is_python_shell: bool = False) -> None:
         action="store_true",
     )
 
-    args = parser.parse_args()
+    args, extras = parser.parse_known_args()
 
     logging.basicConfig(
         level=args.log_level,
         format="%(asctime)s %(processName)s(%(process)s) %(threadName)s [%(name)s(%(lineno)s)] [%(levelname)s] %(message)s",
     )
 
-    launch(args.software, args.python)
+    launch(args.software, args.python, extras)
 
     log.info("Exiting")

pipeline/pipe/h/animpostprocess.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+import hou
+
+from typing import TYPE_CHECKING
+
+from pipe.db import DB
+from env_sg import DB_Config
+
+if TYPE_CHECKING:
+    pass
+
+
+class AnimPostProcessor:
+    _conn: DB
+
+    def __init__(self):
+        self._conn = DB(DB_Config)
+
+    def run(self, shot_code: str) -> None:
+        # Set up
+        shot = self._conn.get_shot_by_code(shot_code)
+        hou.playbar.setFrameRange(shot.cut_in - 5, shot.cut_out + 5)
+        hou.playbar.setPlaybackRange(shot.cut_in - 5, shot.cut_out + 5)
+
+        stage_ctx: hou.Node = hou.node("/stage")  # type: ignore[assignment]
+
+        load_layer = stage_ctx.createNode("sdm223::main::LnD_Load_Layers::1.0")
+        load_layer.parm("shot").set(f"$JOB/{shot.path}")  # type: ignore[union-attr]
+
+        for dep in ["cfx", "fx", "flo", "lighting"]:
+            load_layer.parm(f"{dep}_enable").set(0)  # type: ignore[union-attr]
+
+        if env_stub := (shot.set or self._conn.get_sequence_by_stub(shot.sequence).set):  # type: ignore[arg-type]
+            layout = self._conn.get_env_by_stub(env_stub)
+            load_layer.parm("layout_path").set(f"$JOB/{layout.path}/main.usd")  # type: ignore[union-attr]
+
+        layer_break = stage_ctx.createNode("layerbreak")
+
+        postprocess = stage_ctx.createNode("sdm222::lnd_anim_postprocess::1.0")
+
+        publish = stage_ctx.createNode("usd_rop")
+
+        publish.parm("trange").set("normal")  # type: ignore[union-attr]
+        publish.parm("lopoutput").set(f"$JOB/{shot.path}/anim/usd/post-process.usd")  # type: ignore[union-attr]
+        publish.parm("savestyle").set("flattenalllayers")  # type: ignore[union-attr]
+
+        layer_break.setInput(0, load_layer)
+        postprocess.setInput(0, layer_break)
+        publish.setInput(0, postprocess)
+
+        publish.parm("execute").pressButton()  # type: ignore[union-attr]

pipeline/pipe/m/publish/anim.py

@@ -4,6 +4,7 @@
 import logging
 
 from pathlib import Path
+from pxr import Sdf
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -15,6 +16,7 @@
 from pipe.glui.dialogs import MessageDialog
 from pipe.m.util import maintain_selection
 from pipe.struct.timeline import Timeline
+from software.houdini import HoudiniDCC
 from shared.util import get_production_path
 
 from .publisher import Publisher
@@ -96,3 +98,19 @@ def _get_mayausd_kwargs(self) -> dict[str, Any]:
 
     def _get_confirm_message(self):
         return f"Animation has been exported to {self._publish_path}"
+
+    def _postpublish(self) -> None:
+        """Launch a Houdini process to compute the anim post-process HDA"""
+        post_script = ";".join(
+            [
+                "from pipe.h.animpostprocess import AnimPostProcessor",
+                f"AnimPostProcessor().run('{self._shot.code}')",
+                "exit()",
+            ]
+        )
+
+        HoudiniDCC(is_python_shell=True, extra_args=["-c", post_script]).launch()
+
+        root_layer = Sdf.Layer.FindOrOpen(str(self._publish_path))
+        root_layer.subLayerPaths.append("post-process.usd")
+        root_layer.Save()

pipeline/pipe/m/publish/publisher.py

@@ -191,9 +191,14 @@ def publish(self):
             if self._IS_WINDOWS:
                 shutil.move(temp_publish_path, self._publish_path)
 
+            self._postpublish()
+
             confirm = MessageDialog(
                 self._window,
                 self._get_confirm_message(),
                 "Export Complete",
             )
             confirm.exec_()
+
+    def _postpublish(self) -> None:
+        pass

pipeline/software/baseclass.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import json
 import logging
 import os
 import subprocess
@@ -46,35 +47,45 @@ def __init__(
         self.env_vars = env_vars or {}
         self.pre_launch_tasks = pre_launch_tasks or (lambda: None)
 
-    def _set_env_vars(
+    def _get_env_vars(
         self, env_vars: typing.Mapping[str, int | str | None] | None = None
-    ) -> None:
+    ) -> dict[str, str]:
         """(Un)Set environment variables to their associated values.
 
         All values will be converted to strings. If a value is None,
         that environment variable will be unset.
         """
+        BASE_ENVIRON = "BASE_ENVIRON"
+
+        if BASE_ENVIRON not in os.environ:
+            venv = os.environ.copy()
+            venv[BASE_ENVIRON] = json.dumps(venv)
+        else:
+            venv = json.loads(os.environ[BASE_ENVIRON])
+
         if env_vars is None:
             env_vars = self.env_vars
 
         log.info("(Un)setting environment vars")
 
         for key, val in env_vars.items():
             if val is None:
-                if key in os.environ:
-                    del os.environ[key]
+                if key in venv:
+                    del venv[key]
             else:
-                os.environ[key] = str(val)
+                venv[key] = str(val)
 
-        if not os.environ["PYTHONPATH"]:
-            os.environ["PYTHONPATH"] = ""
-        os.environ["PYTHONPATH"] = os.pathsep.join(
+        PYTHONPATH = "PYTHONPATH"
+        if PYTHONPATH not in venv:
+            venv[PYTHONPATH] = ""
+        venv[PYTHONPATH] = os.pathsep.join(
             [
-                os.environ["PYTHONPATH"],
+                venv[PYTHONPATH],
                 str(get_production_path() / "../pipeline/pipeline/lib/python/any"),
             ]
         )
-        print(os.environ["PYTHONPATH"])
+        print(venv[PYTHONPATH])
+        return venv
 
     def launch(
         self,
@@ -97,11 +108,11 @@ def launch(
 
         fix_launcher_metadata()
         pre_launch_tasks()
-        self._set_env_vars()
+        venv = self._get_env_vars()
 
         log.info("Launching the software")
         log.debug(f"Command: {command}, Args: {args}")
-        subprocess.call([command] + list(args or []))
+        subprocess.call([command] + list(args or []), env=venv)
 
 
 class DCCLocalizer(DCCLocalizerInterface):

pipeline/software/houdini/dcc.py

@@ -21,8 +21,7 @@ class HoudiniDCC(DCC):
     """Houdini DCC class"""
 
     def __init__(
-        self,
-        is_python_shell: bool = False,
+        self, is_python_shell: bool = False, extra_args: list[str] | None = None
     ) -> None:
         this_path = Path(__file__).resolve()
         pipe_path = this_path.parents[2]
@@ -69,6 +68,8 @@ def __init__(
             "HSITE": str(resolve_mapped_path(this_path.parent / "hsite")),
             # Job directory
             "JOB": str(resolve_mapped_path(get_production_path())),
+            # Ensure LD_LIBRARY_PATH is unset to allow nesting pipe instances
+            "LD_LIBRARY_PATH": None,
             # Manually set LD_LIBRARY_PATH to integrated Houdini libraries (for Axiom)
             # "LD_LIBRARY_PATH": str(Executables.hfs / "dsolib")
             # if platform.system() == "Linux"
@@ -111,6 +112,9 @@ def __init__(
         else:
             launch_command = str(Executables.houdini)
 
-        launch_args: list[str] = [] if is_python_shell else ["-foreground"]
+        if is_python_shell:
+            launch_args = extra_args or []
+        else:
+            launch_args = ["-foreground", *(extra_args or [])]
 
         super().__init__(launch_command, launch_args, env_vars)

pipeline/software/maya/dcc.py

@@ -23,7 +23,9 @@ class MayaDCC(DCC):
 
     shelf_path: str
 
-    def __init__(self, is_python_shell: bool = False) -> None:
+    def __init__(
+        self, is_python_shell: bool = False, extra_args: list[str] | None = None
+    ) -> None:
         this_path = Path(__file__).resolve()
         pipe_path = this_path.parents[2]
 
@@ -82,19 +84,51 @@ def __init__(self, is_python_shell: bool = False) -> None:
         launch_args: list[str] = []
         if is_python_shell:
             launch_command = str(Executables.mayapy)
-            launch_args = [
+            cmd_str = ""
+            extra_args_preamble = []
+
+            print(extra_args)
+
+            if extra_args:
+                # extract the cmd arg so we can append it to everything else
+                try:
+                    cmd_flag_index = next(
+                        (
+                            i
+                            for i, f in enumerate(extra_args)
+                            if (f[0] == "-") and (f[-1] == "c")
+                        )
+                    )
+                    cmd_str = extra_args[cmd_flag_index + 1]
+                    if len(extra_args[cmd_flag_index]) > 2:
+                        cmd_str_other_flags = ["-" + extra_args[cmd_flag_index][1:-1]]
+                    else:
+                        cmd_str_other_flags = []
+
+                    extra_args_preamble = (
+                        extra_args[:cmd_flag_index]
+                        + extra_args[cmd_flag_index + 2 :]
+                        + cmd_str_other_flags
+                    )
+                except StopIteration:
+                    pass
+
+            launch_args = extra_args_preamble + [
                 "-ic",
                 ";".join(
                     [
                         "import atexit",
                         "import maya.standalone",
                         "maya.standalone.initialize()",
                         "atexit.register(maya.standalone.uninitialize)",
+                        cmd_str,
                     ]
                 ),
             ]
         else:
             launch_command = str(Executables.maya)
+            if extra_args:
+                launch_args = extra_args
 
         super().__init__(
             launch_command, launch_args, env_vars, lambda: self.set_up_shelf_path()

pipeline/software/nuke/dcc.py

@@ -19,8 +19,7 @@ class NukeDCC(DCC):
     """Nuke DCC class"""
 
     def __init__(
-        self,
-        is_python_shell: bool = False,
+        self, is_python_shell: bool = False, extra_args: list[str] | None = None
     ) -> None:
         this_path = Path(__file__).resolve()
         pipe_path = this_path.parents[2]
@@ -51,8 +50,8 @@ def __init__(
             launch_command = str(Executables.nuke)
 
         if is_python_shell:
-            launch_args = []
+            launch_args = extra_args or []
         else:
-            launch_args = ["--nukex"]
+            launch_args = ["--nukex", *(extra_args or [])]
 
         super().__init__(launch_command, launch_args, env_vars)

pipeline/software/substance_designer/dcc.py

@@ -16,8 +16,7 @@ class SubstanceDesignerDCC(DCC):
     """Substance Designer DCC class"""
 
     def __init__(
-        self,
-        is_python_shell: bool = False,
+        self, is_python_shell: bool = False, extra_args: list[str] | None = None
     ) -> None:
         this_path = Path(__file__).resolve()
         pipe_path = this_path.parents[2]
@@ -47,6 +46,7 @@ def __init__(
         launch_args = [
             "--config-file",
             str(this_path.parent / "lnd_configuration.sbscfg"),
+            *(extra_args or []),
         ]
 
         super().__init__(launch_command, launch_args, env_vars)

pipeline/software/substance_painter/dcc.py

@@ -21,8 +21,7 @@ class SubstancePainterDCC(DCC):
     """Substance Painter DCC class"""
 
     def __init__(
-        self,
-        is_python_shell: bool = False,
+        self, is_python_shell: bool = False, extra_args: list[str] | None = None
     ) -> None:
         this_path = Path(__file__).resolve()
         pipe_path = this_path.parents[2]
@@ -55,6 +54,6 @@ def __init__(
                 f"The operating system {system} is not a supported OS for this DCC software"
             )
 
-        launch_args: list[str] = []
+        launch_args: list[str] = extra_args or []
 
         super().__init__(launch_command, launch_args, env_vars)