Support for matte in RenderPass (#2593)

* Handle render pass matte and add a way to pass the render pass prim path when using kick

* Update libs/common/procedural_reader.h

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update libs/translator/reader/reader.h

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update plugins/procedural/main.cpp

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* ignore test_2549 in the testsuite

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: cpichard

CHANGELOG.md

@@ -10,6 +10,7 @@
 ### Bug Fixes
 
 - [usd#2582](https://github.com/Autodesk/arnold-usd/issues/2582) - Arnold-disabled nodes should not be authored to USD
+- [usd#2549](https://github.com/Autodesk/arnold-usd/issues/2549) - Support matte in hydra2 render passes
 
 ## [7.5.1.0] (Unreleased)
 

libs/common/constant_strings.h

@@ -62,6 +62,7 @@ ASTR2(arnold_color_space, "arnold:color_space");
 ASTR2(arnold_filename, "arnold:filename");
 ASTR2(arnold_image, "arnold:image");
 ASTR2(arnold_light, "arnold:light");
+ASTR2(arnold_matte, "arnold:matte");
 ASTR2(arnold_node_entry, "arnold:node_entry");
 ASTR2(arnold_prefix, "arnold:");
 ASTR2(arnold_relative_path, "arnold_relative_path");
@@ -451,6 +452,7 @@ ASTR(region_min_x);
 ASTR(region_min_y);
 ASTR(render_device);
 ASTR(render_outputs);
+ASTR(render_pass);
 ASTR(render_settings);
 ASTR(request_imager_update);
 ASTR(repeat);

libs/common/procedural_reader.h

@@ -19,6 +19,7 @@ class ProceduralReader {
     virtual void SetPurpose(const std::string &p) = 0;
     virtual void SetMask(int m) = 0;
     virtual void SetRenderSettings(const std::string &renderSettings) = 0;
+    virtual void SetRenderPass(const std::string &renderPass) = 0;
     virtual void CreateViewportRegistry(AtProcViewportMode mode, const AtParamValueMap* params) = 0;
     virtual void ReadStage(UsdStageRefPtr stage,
                    const std::string &path) = 0;

libs/render_delegate/reader.cpp

@@ -440,6 +440,14 @@ void HydraArnoldReader::SetMask(int m) {GetArnoldRenderDelegate()->SetMask(m); }
 void HydraArnoldReader::SetPurpose(const std::string &p) { _purpose = TfToken(p.c_str()); }
 void HydraArnoldReader::SetId(unsigned int id) { _id = id; }
 void HydraArnoldReader::SetRenderSettings(const std::string &renderSettings) {_renderSettings = renderSettings;}
+void HydraArnoldReader::SetRenderPass(const std::string &renderPass) {
+    if (_sceneGlobalsSceneIndex) {
+        SdfPath renderPassPrimPath(renderPass);
+        if (!renderPassPrimPath.IsEmpty()) {
+            _sceneGlobalsSceneIndex->SetActiveRenderPassPrimPath(renderPassPrimPath);
+        }
+    }
+}
 
 void HydraArnoldReader::Update()
 {
@@ -490,6 +498,10 @@ HydraArnoldReader::_AppendOverridesSceneIndices(
             HdsiPrimTypePruningSceneIndexTokens->bindingToken,
             HdRetainedTypedSampledDataSource<TfToken>::New(
                 HdMaterialBindingsSchema::GetSchemaToken()));
+    // Add a SceneGlobals scene index that we can use to set the render pass, render settings
+    // shutter, frame, etc.
+    sceneIndex = _sceneGlobalsSceneIndex = 
+        HdsiSceneGlobalsSceneIndex::New(sceneIndex);
 
     // Prune scene materials prior to flattening inherited
     // materials bindings and resolving material bindings

libs/render_delegate/reader.h

@@ -21,6 +21,7 @@
 #include "pxr/usdImaging/usdImaging/rootOverridesSceneIndex.h"
 #include "pxr/imaging/hd/retainedDataSource.h"
 #include "pxr/imaging/hdsi/primTypePruningSceneIndex.h"
+#include "pxr/imaging/hdsi/sceneGlobalsSceneIndex.h"
 #include "pxr/imaging/hd/materialBindingsSchema.h"
 
 #endif
@@ -53,6 +54,7 @@ class HydraArnoldReader : public ProceduralReader {
     void SetPurpose(const std::string &p) override;
     void SetId(unsigned int id) override;
     void SetRenderSettings(const std::string &renderSettings) override;
+    void SetRenderPass(const std::string &renderPass) override;
     void Update() override;
     void CreateViewportRegistry(AtProcViewportMode mode, const AtParamValueMap* params) override {}; // Do we need to create a registry with hydra ???
 
@@ -77,6 +79,7 @@ class HydraArnoldReader : public ProceduralReader {
     HdsiLegacyDisplayStyleOverrideSceneIndexRefPtr _displayStyleSceneIndex;
     HdsiPrimTypePruningSceneIndexRefPtr _materialPruningSceneIndex;
     HdsiPrimTypePruningSceneIndexRefPtr _lightPruningSceneIndex;
+    HdsiSceneGlobalsSceneIndexRefPtr _sceneGlobalsSceneIndex;
 
     AtUniverse *_universe = nullptr;
     HdRenderPassSharedPtr _syncPass;

libs/translator/reader/reader.h

@@ -69,7 +69,7 @@ class UsdArnoldReader : public ProceduralReader {
     void SetPurpose(const std::string &p) override { _purpose = TfToken(p.c_str()); }
     void SetId(unsigned int id) override { _id = id; }
     void SetRenderSettings(const std::string &renderSettings) override {_renderSettings = renderSettings;}
-
+    void SetRenderPass(const std::string &) override {/* Not implemented */}  
     const UsdStageRefPtr &GetStage() const { return _stage; }
     const std::vector<AtNode *> &GetNodes() const override { return _nodes; }
     float GetFrame() const { return _time.frame; }

plugins/procedural/main.cpp

@@ -488,7 +488,15 @@ scene_load
         AtString renderSettings;
         if (AiParamValueMapGetStr(params, str::render_settings, &renderSettings) && renderSettings.length() > 0)
             reader->SetRenderSettings(std::string(renderSettings.c_str()));
-        
+        // We use the "render_pass" argument to set the path to the render pass to use for rendering
+        // With kick you can use -sceneload_arg to pass the argument, note that it works only with the scene index enabled (hydra2)
+        //
+        // kick -sceneload_arg render_pass /Render/Passes/renderpass2 myscene.usda
+        //
+        AtString renderPass;
+        if (AiParamValueMapGetStr(params, str::render_pass, &renderPass) && renderPass.length() > 0) {
+            reader->SetRenderPass(std::string(renderPass.c_str()));
+        }
     }
     reader->SetFrame(frame);
 

plugins/scene_index/renderPassSIP.cpp

@@ -170,23 +170,18 @@ HdSceneIndexPrim HdArnoldRenderPassSceneIndex::GetPrim(const SdfPath &primPath)
         primvarVals.push_back(cameraInvisDs);
     }
 
-    // TODO to Arnold matte
-    // Matte -> ri:Matte
-    //
-    // If the matte pattern matches this prim, set ri:Matte=1.
+    // Matte -> arnold:matte
+    // If the matte pattern matches this prim, set arnold:matte=1.
     // Matte only applies to geometry types.
-    // We do not bother to check if the upstream prim already
-    // has matte set since that is essentially never the case.
-    //
-    // if (_activeRenderPass.DoesOverrideMatte(primPath, prim)) {
-    //     static const HdContainerDataSourceHandle matteDs =
-    //         HdPrimvarSchema::Builder()
-    //             .SetPrimvarValue(HdRetainedTypedSampledDataSource<int>::New(1))
-    //             .SetInterpolation(HdPrimvarSchema::BuildInterpolationDataSource(HdPrimvarSchemaTokens->constant))
-    //             .Build();
-    //     primvarNames.push_back(_tokens->riAttributesRiMatte);
-    //     primvarVals.push_back(matteDs);
-    // }
+    if (_activeRenderPass.DoesOverrideMatte(primPath, prim)) {
+        static const HdContainerDataSourceHandle matteDs =
+            HdPrimvarSchema::Builder()
+                .SetPrimvarValue(HdRetainedTypedSampledDataSource<bool>::New(true))
+                .SetInterpolation(HdPrimvarSchema::BuildInterpolationDataSource(HdPrimvarSchemaTokens->constant))
+                .Build();
+        primvarNames.push_back(str::t_arnold_matte);
+        primvarVals.push_back(matteDs);
+    }
 
     // Apply any accumulated primvar overrides.
     if (!primvarNames.empty()) {

testsuite/groups

@@ -42,7 +42,7 @@ darwin:
 #######################
 
 # Tests in this group will never be executed (you can use it to temporarily disable some tests and/or groups)
-ignore:  unit_render_delegate unit_ndr_plugin unit_translator scene_index_to_fix
+ignore:  unit_render_delegate unit_ndr_plugin unit_translator scene_index_to_fix hydra2_only
 
 # Tests that require the render delegate library, its dependencies and google test
 unit_render_delegate: test_0039 test_0134 test_0136 test_0146 test_0147 test_0152 test_0153 test_0154 test_0155 test_0156
@@ -56,6 +56,9 @@ unit_translator: test_0045
 # Test disabled as failing with the scene index (hydra2)
 scene_index_to_fix: test_1524
 
+# Test disabled as they work only with hydra2
+hydra2_only: test_2549
+
 ############################
 # USER-DEFINED TEST GROUPS #
 ############################

testsuite/test_2549/README

@@ -0,0 +1,9 @@
+Test render pass with matte
+
+It works only in hydra2 mode with the scene index.
+
+Fixes #2549
+
+author: cyril.pichard@autodesk.com 
+
+PARAMS: {'scene':'test.usda', 'kick_params': '-sceneload_arg render_pass /Render/Passes/renderpass2'}