Collect Media Script (aka archiving un-managed media)

For quite some time now people have asked for the an ability to collect clips similar to how AE does. I had a bit of spare time on my hands so I thought I’d give it a go. I must say, I have a new appreciation for the dev team who have to envision every possible scenario a user could organize things! Turns out nothing is all that straight forward.

Unfortunately it doesn’t work exactly as I’d like but that’s either due to me not being able to figure it out or the fact that the API doesn’t allow access to what we need. That said, on to the bits:

What It Does

The script will go through all the non-shared libraries within the current workspace and scrape everything to find clips. This includes folders, reels, reel groups and desktops. If a clip is uncached then it is added to a file (a note of this later). At the end you can use this file to run rsync to copy everything to a backup location of your choice. The original folder structure is kept.

What Doesn’t Work/Cavets

  • Currently you can not get the cached status of a segment so it will treat these as uncached and add them to the list. Upvote FI-02659 to allow that.
  • Unable to get anything that is inside a BFX so all clips that have one applied will not be picked up. Upvote FI-02664 to allow that.
  • This will only grab the used version of a versioned clip, not every version available.
  • This will only grab the latest batch iteration, not previous iterations.
  • Only works on the current workspace.
  • Will not grab audio. (Fixed in v0.2)
  • Flame returns the path of an image sequence as the first frame in the sequence, not the first frame being used within said image sequence. For now the safest route is to find the last frame in the sequence on disk and use that to populate the list.

Unsure if it’s possible:

  • Access a BFX segment and get a list of clips used within it along with their attributes. (It is not, upvote feature request above)
  • See if a clip is an audio file (I didn’t stress about audio all that much…these clips were giving me errors so I’ve ignored them for now) Implemented in v0.2
  • Access other workspaces within the project. (It is not and for good reason)
  • Access clips used in previous batch group iterations and get clips used.

Who This Is For Right Now:

Someone who works completely un-cached and doesn’t use BFX (or if they do, then they have a reference to the original clip either in the timeline or someone within a library).

That said even if you’re not that person, knowing the above limitations, you do you and maybe it fills a need. Funnily enough, I personally am not the target audience but we never moved to an un-managed workflow due to this exact issue.

How To Use

Download v0.2 of the script and put it where you keep your hooks. Once you’ve refreshed your hooks you’ll see a “Collect Media” option within the main menu. Once it’s run, have a look at the shell and you’ll see where it has placed the text file as well as a rsync command to run.

By the very nature of rsync you will not have duplicated media so you can run this across however many workspaces/machines you have and be left with a clean backup.

I hope some of you find this useful. Let me know how it works out in your given situation. I’ve tried to test it fairly throughly but I’m sure there’ll be something that throws up an error somewhere.

If anyone would like to help make this more robust or to address some of the things I couldn’t figure out, please chime in. Sharing is caring as they say. @fredwarren @MikeV @claussteinmassl maybe you guys already know if any of those things are indeed possible and could point me in the right direction.

Finally, thanks to @claussteinmassl for helping me with the sub-folder issue.

Disclaimer: This isn’t bullet-proof nor is this my day job so use it at your own risk. You should always verify your backups before you remove anything.

11 Likes

This looks great. I’ll be trying it out.

Thanks!

Good effort @kyleobley

Way beyond my abilities.

Amazing!!!

Thanks all. Hopefully some of you find it useful. There’s quite a few things that would be nice to figure out so I’ll keep plugging away it.

@fredwarren Is it possible to access clips within a BFX as well as access other workspaces beyond the current one?

Technically it is possible to access the clips inside a BFX from the Python Console, but I would say that it is only possible to do so from the Python Console after you made some manual operations.

  1. You need to enter the BFX and this is not possible from the API itself.
  2. You need to select the clips in the Media Panel
  3. You would need to use flame.execute_shortcut() for the Exit and we do not recommend using this in scripts that you are sharing to the community.

Clip Select
When you are inside the Batch FX you can manually select the clips and then use flame.media_panel.selected_entries to get the list of selected clips but that’s pretty much it.

Enter
You would need to assign a shortcut to the “Editor…” button and then use flame.execute_shortcut("Editor…(Button)). There are two main problems with this:

  1. People who are grabbing your script would need to manually create the shortcut for the script to work.
  2. It would only work if the BFX is focused rather than any other Timeline FX that could be on the segment.

Finally, the answer is no for the Workspace. You can only access the current one.

fred

Thank you for the explanation. I’ll make a feature request to be able to get into BFX then.

The workspaces I totally understand since you wouldn’t want someone else being able to change things whilst you’re in it.

Hey @kyleobley,

please excuse that I couldn’t reply any sooner! Really great work! Thanks for all your effort, including the very detailed description! :slight_smile:

Unfortunately I cannot run and test your script as it’s only written for Python 3 and I’m still running 2020.3 at the machine I’m currently using. I don’t know, if you want to make it compatible with older versions, too. If not, it might be a good idea to specify a minimum version when adding the menu entry.
Some things could probably be adapted without much effort (print function, subprocess etc.), others need a different approach (glob module) as some functions aren’t available in older versions. So without the current ability to test the script, here are just some thoughts from reading the code:

  1. Calling a subprocess at the end to sort the list and remove duplicates:
    I think there is no need to call a subprocess with external tools. set() and sort() can do the same for your natively in python. However I think it might be even better to make sure there are no duplicates in the list while building it. As this step happens in many places in your script, why not make the lists a custom class. That way you do not need to change much in your existing code. Here is a quick example:
# python 3:
try:
	from collections import UserList
# python 2:
except:
	from UserList import UserList


class UniqueList(UserList):
    """Custom list class that acts like a set to make each item unique."""
    def __init__(self, items=None):
        self.data = []

        if items:
            if isinstance(items, UniqueList):
                self.data = items.data.copy()
            else:
                for item in items:
                    self.append(item)


    def append(self, item):
        if not item in self.data:
            super(UniqueList, self).append(item)


# before:
clips = []
sequences = []

# after:
clips = UniqueList()
sequences = UniqueList()

# test:
test = UniqueList([1, 2, 2, 3])
print test

test.append(2)
print test
  1. Docstrings & Comments:
    Docstrings (those comments starting with “”") should really only be used as such right after the declaration of a function as they are returned when running help(). For any normal comments only the hashtag should be used. :slight_smile:

.
Regarding audio:
You can access the audio file path like this:

for track in clip.audio_tracks:
    for channel in item.channels:
        for segment in channel.segments:
            print segment.file_path

.
Here again a unique list can be very handy, as a stereo-clip would also return the same file path two times with this loop. :slight_smile:

2 Likes

Hey Clauss,

Fair enough, I didn’t think about making it backwards compatible! Even more thanks for taking the time to write that class. These are all the Python-ness things that are cool to learn about. I suppose my logic was why re-invent something if linux has a built-in, super fast way to do the same thing. But I dig the Pythonic way of thinking so I’ll give this a go. I’ll also look more into docstrings and how all this stuff is supposed to be used. If I recall you were the one pushing the standards approach :wink:

Again, thank you for this. I’ll give it a go once I have a moment.

EDIT: Now I remember why I also wanted to use sort…this way the file could be written to multiple times and still only keep uniques but I could just read the file if it already exists and put that into the lists to start.

Yes, that’s true. I know this is a rather dry subject, but I really think it’s worth it. :smiley:

If you wanted, you could just read all lines from the text-file as a UniqueList, too. Merging this with the newly collected clips would also not create any duplicates:

list1 = UniqueList([1, 2, 3])
list2 = UniqueList([1, 2, 3, 4])

merged = list1 + list2
print merged
# Result: [1, 2, 3, 4]

For sorting it’s just:

# sorts the list in place (probably more useful in this case)
clips.sort()
# alternatively create a new sorted list and keep the unsorted list if needed
sorted_clips = sorted(clips)

I think doing stuff natively should be the way to go unless there is a real need for external solutions (e.g. major speed improvements, components not natively available etc.). That way you can be sure the script will just run everywhere, independent of the operating system etc. :slight_smile:

1 Like

Update v0.2

Download Here

Thanks to @claussteinmassl and his guidance I’ve updated the script so it can be used in versions below 2022…at least I think so. It would be great if people can test and let me know if it’s working for them.

Beyond how lists are managed, the big addition is the ability to find audio files. The same caveat exists as with video, we can’t get the cached status if it’s in a sequence so audio within one will be added to the list regardless if it’s cached or not.

Hopefully now that it will work in previous versions of Flame it’ll be of more use to everyone.

2 Likes