Skip to content

create_movie_batch

BatchMovieCreator

Bases: TrayPublishCreator

Creates instances from movie file(s).

Intended for .mov files, but should work for any video file. Doesn't handle image sequences though.

Source code in client/ayon_traypublisher/plugins/create/create_movie_batch.py
 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
class BatchMovieCreator(TrayPublishCreator):
    """Creates instances from movie file(s).

    Intended for .mov files, but should work for any video file.
    Doesn't handle image sequences though.
    """
    identifier = "render_movie_batch"
    label = "Batch Movies"
    product_type = "render"
    description = "Publish batch of video files"

    create_allow_context_change = False
    version_regex = re.compile(r"^(.+)_v([0-9]+)$")
    # Position batch creator after simple creators
    order = 110

    def apply_settings(self, project_settings):
        creator_settings = (
            project_settings["traypublisher"]["create"]["BatchMovieCreator"]
        )
        self.default_variants = creator_settings["default_variants"]
        self.default_tasks = creator_settings["default_tasks"]
        self.extensions = creator_settings["extensions"]

    def get_icon(self):
        return "fa.file"

    def create(self, product_name, data, pre_create_data):
        file_paths = pre_create_data.get("filepath")
        if not file_paths:
            return

        data_by_folder_id = collections.defaultdict(list)
        for file_info in file_paths:
            instance_data = copy.deepcopy(data)
            file_name = file_info["filenames"][0]
            filepath = os.path.join(file_info["directory"], file_name)
            instance_data["creator_attributes"] = {"filepath": filepath}

            folder_entity, version = get_folder_entity_from_filename(
                self.project_name, file_name, self.version_regex)
            data_by_folder_id[folder_entity["id"]].append(
                (instance_data, folder_entity)
            )

        all_task_entities = ayon_api.get_tasks(
            self.project_name, task_ids=set(data_by_folder_id.keys())
        )
        task_entity_by_folder_id = collections.defaultdict(dict)
        for task_entity in all_task_entities:
            folder_id = task_entity["folderId"]
            task_name = task_entity["name"].lower()
            task_entity_by_folder_id[folder_id][task_name] = task_entity

        for (
            folder_id, (instance_data, folder_entity)
        ) in data_by_folder_id.items():
            task_entities_by_name = task_entity_by_folder_id[folder_id]
            task_name = None
            task_entity = None
            for default_task_name in self.default_tasks:
                _name = default_task_name.lower()
                if _name in task_entities_by_name:
                    task_name = task_entity["name"]
                    task_entity = task_entities_by_name[_name]
                    break

            product_name = self._get_product_name(
                self.project_name, task_entity, data["variant"]
            )

            instance_data["folderPath"] = folder_entity["path"]
            instance_data["task"] = task_name

            # Create new instance
            new_instance = CreatedInstance(self.product_type, product_name,
                                           instance_data, self)
            self._store_new_instance(new_instance)

    def _get_product_name(self, project_name, task_entity, variant):
        """Create product name according to standard template process"""
        host_name = self.create_context.host_name
        task_name = task_type = None
        if task_entity:
            task_name = task_entity["name"]
            task_type = task_entity["taskType"]
        try:
            product_name = get_product_name(
                project_name,
                task_name,
                task_type,
                host_name,
                self.product_type,
                variant,
            )
        except TaskNotSetError:
            # Create instance with fake task
            # - instance will be marked as invalid so it can't be published
            #   but user have ability to change it
            # NOTE: This expect that there is not task 'Undefined' on folder
            dumb_value = "Undefined"
            product_name = get_product_name(
                project_name,
                dumb_value,
                dumb_value,
                host_name,
                self.product_type,
                variant,
            )

        return product_name

    def get_instance_attr_defs(self):
        return [
            BoolDef(
                "add_review_family",
                default=True,
                label="Review"
            )
        ]

    def get_pre_create_attr_defs(self):
        # Use same attributes as for instance attributes
        return [
            FileDef(
                "filepath",
                folders=False,
                single_item=False,
                extensions=self.extensions,
                allow_sequences=False,
                label="Filepath"
            ),
            BoolDef(
                "add_review_family",
                default=True,
                label="Review"
            )
        ]

    def get_detail_description(self):
        return """# Publish batch of .mov to multiple folders.

        File names must then contain only folder name, or folder name + version.
        (eg. 'chair.mov', 'chair_v001.mov', not really safe `my_chair_v001.mov`
        """