Skip to content

collect_mantra_rop

CollectMantraROPRenderProducts

Bases: HoudiniInstancePlugin

Collect Mantra Render Products

Collects the instance.data["files"] for the render products.

Provides

instance -> files

Source code in client/ayon_houdini/plugins/publish/collect_mantra_rop.py
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
class CollectMantraROPRenderProducts(plugin.HoudiniInstancePlugin):
    """Collect Mantra Render Products

    Collects the instance.data["files"] for the render products.

    Provides:
        instance    -> files

    """

    label = "Mantra ROP Render Products"
    # This specific order value is used so that
    # this plugin runs after CollectFrames
    order = pyblish.api.CollectorOrder + 0.11
    families = ["mantra_rop"]

    def process(self, instance):

        rop = hou.node(instance.data.get("instance_node"))

        default_prefix = evalParmNoFrame(rop, "vm_picture")
        render_products = []

        export_prefix = None
        export_products = []
        if instance.data["splitRender"]:
            export_prefix = evalParmNoFrame(
                rop, "soho_diskfile", pad_character="0"
            )
            beauty_export_product = self.get_render_product_name(
                prefix=export_prefix,
                suffix=None)
            export_products.append(beauty_export_product)
            self.log.debug(
                "Found export product: {}".format(beauty_export_product)
            )
            instance.data["ifdFile"] = beauty_export_product
            instance.data["exportFiles"] = list(export_products)

        # Default beauty AOV
        beauty_product = self.get_render_product_name(
            prefix=default_prefix, suffix=None
        )
        render_products.append(beauty_product)

        files_by_aov = {
            "beauty": self.generate_expected_files(instance,
                                                   beauty_product)
        }

        # Assume it's a multipartExr Render.
        multipartExr = True

        # TODO: This logic doesn't take into considerations
        #       cryptomatte defined in 'Images > Cryptomatte'
        aov_numbers = rop.evalParm("vm_numaux")
        if aov_numbers > 0:
            # get the filenames of the AOVs
            for i in range(1, aov_numbers + 1):
                var = rop.evalParm("vm_variable_plane%d" % i)
                if var:
                    aov_name = "vm_filename_plane%d" % i
                    aov_boolean = "vm_usefile_plane%d" % i
                    aov_enabled = rop.evalParm(aov_boolean)
                    has_aov_path = rop.evalParm(aov_name)
                    if has_aov_path and aov_enabled == 1:
                        aov_prefix = evalParmNoFrame(rop, aov_name)
                        aov_product = self.get_render_product_name(
                            prefix=aov_prefix, suffix=None
                        )
                        render_products.append(aov_product)

                        files_by_aov[var] = self.generate_expected_files(instance, aov_product)     # noqa

                        # Set to False as soon as we have a separated aov.
                        multipartExr = False

        # Review Logic expects this key to exist and be True
        # if render is a multipart Exr.
        # As long as we have one AOV then multipartExr should be True.
        instance.data["multipartExr"] = multipartExr

        for product in render_products:
            self.log.debug("Found render product: %s" % product)

        filenames = list(render_products)
        instance.data["files"] = filenames

        # For now by default do NOT try to publish the rendered output
        instance.data["publishJobState"] = "Suspended"
        instance.data["attachTo"] = []      # stub required data

        if "expectedFiles" not in instance.data:
            instance.data["expectedFiles"] = list()
        instance.data["expectedFiles"].append(files_by_aov)

    def get_render_product_name(self, prefix, suffix):
        product_name = prefix
        if suffix:
            # Add ".{suffix}" before the extension
            prefix_base, ext = os.path.splitext(prefix)
            product_name = prefix_base + "." + suffix + ext

        return product_name

    def generate_expected_files(self, instance, path):
        """Create expected files in instance data"""

        dir = os.path.dirname(path)
        file = os.path.basename(path)

        if "#" in file:
            def replace(match):
                return "%0{}d".format(len(match.group()))

            file = re.sub("#+", replace, file)

        if "%" not in file:
            return path

        expected_files = []
        start = instance.data["frameStartHandle"]
        end = instance.data["frameEndHandle"]

        for i in range(int(start), (int(end) + 1)):
            expected_files.append(
                os.path.join(dir, (file % i)).replace("\\", "/"))

        return expected_files

generate_expected_files(instance, path)

Create expected files in instance data

Source code in client/ayon_houdini/plugins/publish/collect_mantra_rop.py
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def generate_expected_files(self, instance, path):
    """Create expected files in instance data"""

    dir = os.path.dirname(path)
    file = os.path.basename(path)

    if "#" in file:
        def replace(match):
            return "%0{}d".format(len(match.group()))

        file = re.sub("#+", replace, file)

    if "%" not in file:
        return path

    expected_files = []
    start = instance.data["frameStartHandle"]
    end = instance.data["frameEndHandle"]

    for i in range(int(start), (int(end) + 1)):
        expected_files.append(
            os.path.join(dir, (file % i)).replace("\\", "/"))

    return expected_files