Skip to content

collect_farm_render

Collect data to render from scene.

CollectFarmRender

Bases: AbstractCollectRender

Gather all publishable renders.

Source code in client/ayon_harmony/plugins/publish/collect_farm_render.py
 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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
class CollectFarmRender(publish.AbstractCollectRender):
    """Gather all publishable renders."""

    # https://docs.toonboom.com/help/harmony-17/premium/reference/node/output/write-node-image-formats.html
    ext_mapping = {
        "tvg": ["TVG"],
        "tga": ["TGA", "TGA4", "TGA3", "TGA1"],
        "sgi": ["SGI", "SGI4", "SGA3", "SGA1", "SGIDP", "SGIDP4", "SGIDP3"],
        "psd": ["PSD", "PSD1", "PSD3", "PSD4", "PSDDP", "PSDDP1", "PSDDP3",
                "PSDDP4"],
        "yuv": ["YUV"],
        "pal": ["PAL"],
        "scan": ["SCAN"],
        "png": ["PNG", "PNG4", "PNGDP", "PNGDP3", "PNGDP4"],
        "jpg": ["JPG"],
        "bmp": ["BMP", "BMP4"],
        "opt": ["OPT", "OPT1", "OPT3", "OPT4"],
        "var": ["VAR"],
        "tif": ["TIF"],
        "dpx": ["DPX", "DPX3_8", "DPX3_10", "DPX3_12", "DPX3_16",
                "DPX3_10_INVERTED_CHANNELS", "DPX3_12_INVERTED_CHANNELS",
                "DPX3_16_INVERTED_CHANNELS"],
        "exr": ["EXR"],
        "pdf": ["PDF"],
        "dtext": ["DTEX"]
    }

    def get_expected_files(self, render_instance):
        """Get list of expected files to be rendered from Harmony.

        This returns full path with file name determined by Write node
        settings.
        """
        start = render_instance.frameStart - render_instance.handleStart
        end = render_instance.frameEnd + render_instance.handleEnd
        node = render_instance.setMembers[0]
        self_name = self.__class__.__name__
        # 0 - filename / 1 - type / 2 - zeros / 3 - start
        info = harmony.send(
            {
                "function": f"AyonHarmony.Publish.{self_name}."
                            "getRenderNodeSettings",
                "args": node
            })["result"]

        ext = None
        for k, v in self.ext_mapping.items():
            if info[1] in v:
                ext = k

        if not ext:
            raise AssertionError(
                f"Cannot determine file extension for {info[1]}")

        path = Path(render_instance.source).parent
        # is sequence start node on write node offsetting whole sequence?
        expected_files = []

        # '-' in name is important for Harmony17
        for frame in range(start, end + 1):
            expected_files.append(
                path / "{}-{}.{}".format(
                    render_instance.productName,
                    str(frame).rjust(int(info[2]) + 1, "0"),
                    ext
                )
            )
        self.log.debug("expected_files::{}".format(expected_files))
        return expected_files

    def get_instances(self, context):
        """Get instances per Write node in `renderFarm` product type."""
        version = None
        if self.sync_workfile_version:
            version = context.data["version"]

        instances = []

        self_name = self.__class__.__name__

        folder_path = context.data["folderPath"]

        for inst in context:
            if not inst.data.get("active", True):
                continue
            creator_attributes = inst.data.get("creator_attributes", {})
            if creator_attributes.get("render_target") != "farm":
                continue

            node = inst.data["transientData"]["node"]
            # 0 - filename / 1 - type / 2 - zeros / 3 - start / 4 - enabled
            info = harmony.send(
                {
                    "function": f"AyonHarmony.Publish.{self_name}."
                                "getRenderNodeSettings",
                    "args": node
                })["result"]

            # TODO: handle pixel aspect and frame step
            product_name = inst.data["productName"]
            task_name = inst.data.get("task")

            product_type = inst.data("productType")
            instance_families = inst.data.get("families", [])

            render_instance = HarmonyRenderInstance(
                version=version,
                time=get_formatted_current_time(),
                source=context.data["currentFile"],
                name=product_name,
                label="{} - {}".format(product_name, product_type),
                productName=product_name,
                productType=product_type,
                family=product_type,
                families=instance_families,
                farm=True,
                folderPath=folder_path,
                task=task_name,
                attachTo=False,
                setMembers=[node],
                publish=info[4],
                renderer=None,
                priority=50,
                resolutionWidth=context.data["resolutionWidth"],
                resolutionHeight=context.data["resolutionHeight"],
                pixelAspect=1.0,
                multipartExr=False,
                tileRendering=False,
                tilesX=0,
                tilesY=0,
                convertToScanline=False,

                # time settings
                frameStart=context.data["frameStart"],
                frameEnd=context.data["frameEnd"],
                handleStart=context.data["handleStart"],  # from DB
                handleEnd=context.data["handleEnd"],      # from DB
                frameStep=1,
                outputType="Image",
                outputFormat=info[1],
                outputStartFrame=info[3],
                leadingZeros=info[2],
                ignoreFrameHandleCheck=True,
                # The source instance this render instance replaces
                source_instance=inst
            )
            render_instance.context = context
            self.log.debug(render_instance)
            instances.append(render_instance)

        return instances

    def add_additional_data(self, instance):
        instance["FOV"] = self._context.data["FOV"]

        return instance

get_expected_files(render_instance)

Get list of expected files to be rendered from Harmony.

This returns full path with file name determined by Write node settings.

Source code in client/ayon_harmony/plugins/publish/collect_farm_render.py
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
def get_expected_files(self, render_instance):
    """Get list of expected files to be rendered from Harmony.

    This returns full path with file name determined by Write node
    settings.
    """
    start = render_instance.frameStart - render_instance.handleStart
    end = render_instance.frameEnd + render_instance.handleEnd
    node = render_instance.setMembers[0]
    self_name = self.__class__.__name__
    # 0 - filename / 1 - type / 2 - zeros / 3 - start
    info = harmony.send(
        {
            "function": f"AyonHarmony.Publish.{self_name}."
                        "getRenderNodeSettings",
            "args": node
        })["result"]

    ext = None
    for k, v in self.ext_mapping.items():
        if info[1] in v:
            ext = k

    if not ext:
        raise AssertionError(
            f"Cannot determine file extension for {info[1]}")

    path = Path(render_instance.source).parent
    # is sequence start node on write node offsetting whole sequence?
    expected_files = []

    # '-' in name is important for Harmony17
    for frame in range(start, end + 1):
        expected_files.append(
            path / "{}-{}.{}".format(
                render_instance.productName,
                str(frame).rjust(int(info[2]) + 1, "0"),
                ext
            )
        )
    self.log.debug("expected_files::{}".format(expected_files))
    return expected_files

get_instances(context)

Get instances per Write node in renderFarm product type.

Source code in client/ayon_harmony/plugins/publish/collect_farm_render.py
 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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
def get_instances(self, context):
    """Get instances per Write node in `renderFarm` product type."""
    version = None
    if self.sync_workfile_version:
        version = context.data["version"]

    instances = []

    self_name = self.__class__.__name__

    folder_path = context.data["folderPath"]

    for inst in context:
        if not inst.data.get("active", True):
            continue
        creator_attributes = inst.data.get("creator_attributes", {})
        if creator_attributes.get("render_target") != "farm":
            continue

        node = inst.data["transientData"]["node"]
        # 0 - filename / 1 - type / 2 - zeros / 3 - start / 4 - enabled
        info = harmony.send(
            {
                "function": f"AyonHarmony.Publish.{self_name}."
                            "getRenderNodeSettings",
                "args": node
            })["result"]

        # TODO: handle pixel aspect and frame step
        product_name = inst.data["productName"]
        task_name = inst.data.get("task")

        product_type = inst.data("productType")
        instance_families = inst.data.get("families", [])

        render_instance = HarmonyRenderInstance(
            version=version,
            time=get_formatted_current_time(),
            source=context.data["currentFile"],
            name=product_name,
            label="{} - {}".format(product_name, product_type),
            productName=product_name,
            productType=product_type,
            family=product_type,
            families=instance_families,
            farm=True,
            folderPath=folder_path,
            task=task_name,
            attachTo=False,
            setMembers=[node],
            publish=info[4],
            renderer=None,
            priority=50,
            resolutionWidth=context.data["resolutionWidth"],
            resolutionHeight=context.data["resolutionHeight"],
            pixelAspect=1.0,
            multipartExr=False,
            tileRendering=False,
            tilesX=0,
            tilesY=0,
            convertToScanline=False,

            # time settings
            frameStart=context.data["frameStart"],
            frameEnd=context.data["frameEnd"],
            handleStart=context.data["handleStart"],  # from DB
            handleEnd=context.data["handleEnd"],      # from DB
            frameStep=1,
            outputType="Image",
            outputFormat=info[1],
            outputStartFrame=info[3],
            leadingZeros=info[2],
            ignoreFrameHandleCheck=True,
            # The source instance this render instance replaces
            source_instance=inst
        )
        render_instance.context = context
        self.log.debug(render_instance)
        instances.append(render_instance)

    return instances