Skip to content

load_clip

LoadClip

Bases: TimelineItemLoader

Load a product to timeline as clip

Place clip to timeline on its asset origin timings collected during conforming to project

Source code in client/ayon_resolve/plugins/load/load_clip.py
 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
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
class LoadClip(plugin.TimelineItemLoader):
    """Load a product to timeline as clip

    Place clip to timeline on its asset origin timings collected
    during conforming to project
    """

    product_types = {"render2d", "source", "plate", "render", "review"}

    representations = {"*"}
    extensions = set(
        ext.lstrip(".") for ext in IMAGE_EXTENSIONS.union(VIDEO_EXTENSIONS)
    )

    label = "Load as clip"
    order = -10
    icon = "code-fork"
    color = "orange"

    # for loader multiselection
    timeline = None

    # presets
    clip_color_last = "Olive"
    clip_color = "Orange"

    def load(self, context, name, namespace, options):

        # load clip to timeline and get main variables
        files = plugin.get_representation_files(
            context["project"]["name"],
            context["representation"]
        )

        timeline_item = plugin.ClipLoader(
            self, context, **options).load(files)
        namespace = namespace or timeline_item.GetName()

        # update color of clip regarding the version order
        self.set_item_color(
            context["project"]["name"],
            timeline_item,
            context["version"]
        )

        data_imprint = self.get_tag_data(context, name, namespace)
        return containerise(
            timeline_item,
            name, namespace, context,
            self.__class__.__name__,
            data_imprint)

    def switch(self, container, context):
        self.update(container, context)

    def update(self, container, context):
        """ Updating previously loaded clips
        """

        repre_entity = context["representation"]
        name = container['name']
        namespace = container['namespace']
        timeline_item = container["_timeline_item"]

        media_pool_item = timeline_item.GetMediaPoolItem()

        files = plugin.get_representation_files(
            context["project"]["name"],
            repre_entity
        )

        loader = plugin.ClipLoader(self, context)
        timeline_item = loader.update(timeline_item, files)

        # update color of clip regarding the version order
        self.set_item_color(
            context["project"]["name"],
            timeline_item,
            context["version"]
        )

        # if original media pool item has no remaining usages left
        # remove it from the media pool
        if int(media_pool_item.GetClipProperty("Usage")) == 0:
            lib.remove_media_pool_item(media_pool_item)

        data_imprint = self.get_tag_data(context, name, namespace)
        return update_container(timeline_item, data_imprint)

    def get_tag_data(self, context, name, namespace):
        """Return data to be imprinted on the timeline item marker"""

        repre_entity = context["representation"]
        version_entity = context["version"]
        version_attributes = version_entity["attrib"]
        colorspace = version_attributes.get("colorSpace", None)
        object_name = "{}_{}".format(name, namespace)

        # add additional metadata from the version to imprint Avalon knob
        # move all version data keys to tag data
        add_version_data_keys = [
            "frameStart", "frameEnd", "source", "author",
            "fps", "handleStart", "handleEnd"
        ]
        data = {
            key: version_attributes.get(key, "None")
            for key in add_version_data_keys
        }

        # add variables related to version context
        data.update({
            "representation": repre_entity["id"],
            "version": version_entity["version"],
            "colorspace": colorspace,
            "objectName": object_name
        })
        return data

    @classmethod
    def set_item_color(cls, project_name, timeline_item, version_entity):
        """Color timeline item based on whether it is outdated or latest"""
        # get all versions in list
        last_version_entity = ayon_api.get_last_version_by_product_id(
            project_name,
            version_entity["productId"],
            fields=["name"]
        )
        last_version_id = None
        if last_version_entity:
            last_version_id = last_version_entity["id"]

        # set clip colour
        if version_entity["id"] == last_version_id:
            timeline_item.SetClipColor(cls.clip_color_last)
        else:
            timeline_item.SetClipColor(cls.clip_color)

    def remove(self, container):
        timeline_item = container["_timeline_item"]
        media_pool_item = timeline_item.GetMediaPoolItem()
        timeline = lib.get_current_timeline()

        # DeleteClips function was added in Resolve 18.5+
        # by checking None we can detect whether the
        # function exists in Resolve
        if timeline.DeleteClips is not None:
            timeline.DeleteClips([timeline_item])
        else:
            # Resolve versions older than 18.5 can't delete clips via API
            # so all we can do is just remove the ayon marker to 'untag' it
            if lib.get_ayon_marker(timeline_item):
                # Note: We must call `get_ayon_marker` because
                # `delete_ayon_marker` uses a global variable set by
                # `get_ayon_marker` to delete the right marker
                # TODO: Improve code to avoid the global `temp_marker_frame`
                lib.delete_ayon_marker(timeline_item)

        # if media pool item has no remaining usages left
        # remove it from the media pool
        if int(media_pool_item.GetClipProperty("Usage")) == 0:
            lib.remove_media_pool_item(media_pool_item)

get_tag_data(context, name, namespace)

Return data to be imprinted on the timeline item marker

Source code in client/ayon_resolve/plugins/load/load_clip.py
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
def get_tag_data(self, context, name, namespace):
    """Return data to be imprinted on the timeline item marker"""

    repre_entity = context["representation"]
    version_entity = context["version"]
    version_attributes = version_entity["attrib"]
    colorspace = version_attributes.get("colorSpace", None)
    object_name = "{}_{}".format(name, namespace)

    # add additional metadata from the version to imprint Avalon knob
    # move all version data keys to tag data
    add_version_data_keys = [
        "frameStart", "frameEnd", "source", "author",
        "fps", "handleStart", "handleEnd"
    ]
    data = {
        key: version_attributes.get(key, "None")
        for key in add_version_data_keys
    }

    # add variables related to version context
    data.update({
        "representation": repre_entity["id"],
        "version": version_entity["version"],
        "colorspace": colorspace,
        "objectName": object_name
    })
    return data

set_item_color(project_name, timeline_item, version_entity) classmethod

Color timeline item based on whether it is outdated or latest

Source code in client/ayon_resolve/plugins/load/load_clip.py
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
@classmethod
def set_item_color(cls, project_name, timeline_item, version_entity):
    """Color timeline item based on whether it is outdated or latest"""
    # get all versions in list
    last_version_entity = ayon_api.get_last_version_by_product_id(
        project_name,
        version_entity["productId"],
        fields=["name"]
    )
    last_version_id = None
    if last_version_entity:
        last_version_id = last_version_entity["id"]

    # set clip colour
    if version_entity["id"] == last_version_id:
        timeline_item.SetClipColor(cls.clip_color_last)
    else:
        timeline_item.SetClipColor(cls.clip_color)

update(container, context)

Updating previously loaded clips

Source code in client/ayon_resolve/plugins/load/load_clip.py
 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
def update(self, container, context):
    """ Updating previously loaded clips
    """

    repre_entity = context["representation"]
    name = container['name']
    namespace = container['namespace']
    timeline_item = container["_timeline_item"]

    media_pool_item = timeline_item.GetMediaPoolItem()

    files = plugin.get_representation_files(
        context["project"]["name"],
        repre_entity
    )

    loader = plugin.ClipLoader(self, context)
    timeline_item = loader.update(timeline_item, files)

    # update color of clip regarding the version order
    self.set_item_color(
        context["project"]["name"],
        timeline_item,
        context["version"]
    )

    # if original media pool item has no remaining usages left
    # remove it from the media pool
    if int(media_pool_item.GetClipProperty("Usage")) == 0:
        lib.remove_media_pool_item(media_pool_item)

    data_imprint = self.get_tag_data(context, name, namespace)
    return update_container(timeline_item, data_imprint)