Resolve: mediapool loader and inventory clearing plugins

server_addon/resolve/client/ayon_resolve/api/lib.py

@@ -145,7 +145,9 @@ def get_new_timeline(timeline_name: str = None):
     return new_timeline
 
 
-def create_bin(name: str, root: object = None) -> object:
+def create_bin(name: str,
+               root: object = None,
+               set_as_current: bool = True) -> object:
     """
     Create media pool's folder.
 
@@ -156,6 +158,8 @@ def create_bin(name: str, root: object = None) -> object:
     Args:
         name (str): name of folder / bin, or hierarchycal name "parent/name"
         root (resolve.Folder)[optional]: root folder / bin object
+        set_as_current (resolve.Folder)[optional]: Whether to set the
+            resulting bin as current folder or not.
 
     Returns:
         object: resolve.Folder
@@ -168,22 +172,24 @@ def create_bin(name: str, root: object = None) -> object:
     if "/" in name.replace("\\", "/"):
         child_bin = None
         for bname in name.split("/"):
-            child_bin = create_bin(bname, child_bin or root_bin)
+            child_bin = create_bin(bname,
+                                   root=child_bin or root_bin,
+                                   set_as_current=set_as_current)
         if child_bin:
             return child_bin
     else:
-        created_bin = None
+        # Find existing folder or create it
         for subfolder in root_bin.GetSubFolderList():
-            if subfolder.GetName() in name:
+            if subfolder.GetName() == name:
                 created_bin = subfolder
-
-        if not created_bin:
-            new_folder = media_pool.AddSubFolder(root_bin, name)
-            media_pool.SetCurrentFolder(new_folder)
+                break
         else:
+            created_bin = media_pool.AddSubFolder(root_bin, name)
+
+        if set_as_current:
             media_pool.SetCurrentFolder(created_bin)
 
-        return media_pool.GetCurrentFolder()
+        return created_bin
 
 
 def remove_media_pool_item(media_pool_item: object) -> bool:
@@ -272,8 +278,7 @@ def create_timeline_item(
     # get all variables
     project = get_current_project()
     media_pool = project.GetMediaPool()
-    _clip_property = media_pool_item.GetClipProperty
-    clip_name = _clip_property("File Name")
+    clip_name = media_pool_item.GetClipProperty("File Name")
     timeline = timeline or get_current_timeline()
 
     # timing variables
@@ -298,16 +303,22 @@ def create_timeline_item(
         if source_end:
             clip_data["endFrame"] = source_end
         if timecode_in:
+            # Note: specifying a recordFrame will fail to place the timeline
+            #  item if there's already an existing clip at that time on the
+            #  active track.
             clip_data["recordFrame"] = timeline_in
 
         # add to timeline
-        media_pool.AppendToTimeline([clip_data])
+        output_timeline_item = media_pool.AppendToTimeline([clip_data])[0]
 
-        output_timeline_item = get_timeline_item(
-            media_pool_item, timeline)
+        # Adding the item may fail whilst Resolve will still return a
+        # TimelineItem instance - however all `Get*` calls return None
+        # Hence, we check whether the result is valid
+        if output_timeline_item.GetDuration() is None:
+            output_timeline_item = None
 
     assert output_timeline_item, AssertionError((
-        "Clip name '{}' was't created on the timeline: '{}' \n\n"
+        "Clip name '{}' wasn't created on the timeline: '{}' \n\n"
         "Please check if correct track position is activated, \n"
         "or if a clip is not already at the timeline in \n"
         "position: '{}' out: '{}'. \n\n"
@@ -947,3 +958,13 @@ def get_reformated_path(path, padded=False, first=False):
         else:
             path = re.sub(num_pattern, "%d", path)
     return path
+
+
+def iter_all_media_pool_clips():
+    """Recursively iterate all media pool clips in current project"""
+    root = get_current_project().GetMediaPool().GetRootFolder()
+    queue = [root]
+    for folder in queue:
+        for clip in folder.GetClipList():
+            yield clip
+        queue.extend(folder.GetSubFolderList())

server_addon/resolve/client/ayon_resolve/api/pipeline.py

@@ -2,6 +2,7 @@
 Basic avalon integration
 """
 import os
+import json
 import contextlib
 from collections import OrderedDict
 
@@ -12,6 +13,7 @@
     schema,
     register_loader_plugin_path,
     register_creator_plugin_path,
+    register_inventory_action_path,
     AVALON_CONTAINER_ID,
 )
 from ayon_core.host import (
@@ -38,6 +40,7 @@
 PUBLISH_PATH = os.path.join(PLUGINS_DIR, "publish")
 LOAD_PATH = os.path.join(PLUGINS_DIR, "load")
 CREATE_PATH = os.path.join(PLUGINS_DIR, "create")
+INVENTORY_PATH = os.path.join(PLUGINS_DIR, "inventory")
 
 AVALON_CONTAINERS = ":AVALON_CONTAINERS"
 
@@ -65,6 +68,7 @@ def install(self):
 
         register_loader_plugin_path(LOAD_PATH)
         register_creator_plugin_path(CREATE_PATH)
+        register_inventory_action_path(INVENTORY_PATH)
 
         # register callback for switching publishable
         pyblish.register_callback("instanceToggled",
@@ -145,6 +149,26 @@ def ls():
     and the Maya equivalent, which is in `avalon.maya.pipeline`
     """
 
+    # Media Pool instances from Load Media loader
+    for clip in lib.iter_all_media_pool_clips():
+        data = clip.GetMetadata(lib.pype_tag_name)
+        if not data:
+            continue
+        data = json.loads(data)
+
+        # If not all required data, skip it
+        required = ['schema', 'id', 'loader', 'representation']
+        if not all(key in data for key in required):
+            continue
+
+        container = {key: data[key] for key in required}
+        container["objectName"] = clip.GetName()  # Get path in folders
+        container["namespace"] = clip.GetName()
+        container["name"] = clip.GetUniqueId()
+        container["_item"] = clip
+        yield container
+
+    # Timeline instances from Load Clip loader
     # get all track items from current timeline
     all_timeline_items = lib.get_current_timeline_items(filter=False)
 

server_addon/resolve/client/ayon_resolve/plugins/inventory/remove_unused_media_pool_items.py

@@ -0,0 +1,31 @@
+from ayon_core.pipeline import (
+    InventoryAction,
+)
+from ayon_core.pipeline.load.utils import remove_container
+
+
+class RemoveUnusedMedia(InventoryAction):
+
+    label = "Remove Unused Media"
+    icon = "trash"
+
+    @staticmethod
+    def is_compatible(container):
+        return (
+            container.get("loader") == "LoadMedia"
+        )
+
+    def process(self, containers):
+        any_removed = False
+        for container in containers:
+            media_pool_item = container["_item"]
+            usage = int(media_pool_item.GetClipProperty("Usage"))
+            name = media_pool_item.GetName()
+            if usage == 0:
+                print(f"Removing {name}")
+                remove_container(container)
+                any_removed = True
+            else:
+                print(f"Keeping {name} with usage: {usage}")
+
+        return any_removed