Skip to content

extract_clip_effects

ExtractClipEffects

Bases: Extractor

Extract clip effects instances.

Source code in client/ayon_hiero/plugins/publish/extract_clip_effects.py 
  8
  9
 10
 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
class ExtractClipEffects(publish.Extractor):
    """Extract clip effects instances."""

    order = pyblish.api.ExtractorOrder
    label = "Export Clip Effects"
    families = ["effect"]

    def process(self, instance):
        item = instance.data["trackItem"]
        effects = instance.data.get("effects")

        # skip any without effects
        if not effects:
            return

        product_name = instance.data.get("productName")
        product_type = instance.data["productType"]

        self.log.debug("creating staging dir")
        staging_dir = self.staging_dir(instance)

        transfers = list()
        if "transfers" not in instance.data:
            instance.data["transfers"] = list()

        ext = "json"
        file = product_name + "." + ext

        # when instance is created during collection part
        resources_dir = instance.data["resourcesDir"]

        # change paths in effects to files
        for k, effect in effects.items():
            if "assignTo" in k:
                continue
            trn = self.copy_linked_files(effect, resources_dir)
            if trn:
                transfers.append((trn[0], trn[1]))

        instance.data["transfers"].extend(transfers)
        self.log.debug("_ transfers: `{}`".format(
            instance.data["transfers"]))

        # create representations
        instance.data["representations"] = list()

        transfer_data = [
            "handleStart", "handleEnd",
            "sourceStart", "sourceStartH", "sourceEnd", "sourceEndH",
            "frameStart", "frameEnd",
            "clipIn", "clipOut", "clipInH", "clipOutH",
            "folderPath", "version"
        ]

        # pass data to version
        version_data = dict()
        version_data.update({k: instance.data[k] for k in transfer_data})

        # add to data of representation
        version_data.update({
            "colorSpace": item.sourceMediaColourTransform(),
            "colorspaceScript": instance.context.data["colorspace"],
            "families": [product_type, "plate"],
            # TODO find out if 'subset' is needed (and 'productName')
            "subset": product_name,
            "productName": product_name,
            "fps": instance.context.data["fps"]
        })
        instance.data["versionData"] = version_data

        representation = {
            'files': file,
            'stagingDir': staging_dir,
            'name': product_type + ext.title(),
            'ext': ext
        }
        instance.data["representations"].append(representation)

        self.log.debug("_ representations: `{}`".format(
            instance.data["representations"]))

        self.log.debug("_ version_data: `{}`".format(
            instance.data["versionData"]))

        with open(os.path.join(staging_dir, file), "w") as outfile:
            outfile.write(json.dumps(effects, indent=4, sort_keys=True))

    def copy_linked_files(self, effect, dst_dir):
        for k, v in effect["node"].items():
            if k in "file" and isinstance(v, str) and v != '':
                base_name = os.path.basename(v)
                dst = os.path.join(dst_dir, base_name).replace("\\", "/")

                # add it to the json
                effect["node"][k] = dst
                return (v, dst)