hiero_upload_thumbnail.py

# Copyright (c) 2013 Shotgun Software Inc.
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
# Source Code License included in this distribution package. See LICENSE.
# By accessing, using, copying or modifying this work you indicate your
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
# not expressly granted therein are reserved by Shotgun Software Inc.

import os
import sys
import math
import shutil
import tempfile
import traceback
import time

from tank.platform.qt import QtCore
from tank import Hook
import tank.templatekey


class HieroUploadThumbnail(Hook):
    """
    This class implements a hook that's responsible for uploading a thumbnail
    to a given Shotgun entity for a given Hiero source item.
    """

    def execute(self, entity, source, item, **kwargs):
        """
        Uploads a thumbnail to the given entity in Shotgun.

        :param dict entity: The entity dictionary that will receive the new
            thumbnail image.
        :param source: The Hiero source sequence object being exported.
        :param item: The Hiero task item being processed.
        :param task: The Hiero task being processed.
        """
        thumbdir = tempfile.mkdtemp(prefix="hiero_process_shot")
        try:
            path = "%s.png" % os.path.join(thumbdir, source.name())
            task = kwargs.get("task", None)

            if item is None:
                # No timeline info, use the poster frame of the source item
                frame = source.posterFrame()
                thumb_qimage = source.thumbnail(frame)
            else:
                if (task is not None) and task.isCollated():
                    # collated shot, use middle frame from task sequence (all collated items)
                    max_frame = 0
                    min_frame = sys.maxsize
                    for track in task._sequence.videoTracks():
                        for i in track.items():
                            min_frame = min(i.timelineIn(), min_frame)
                            max_frame = max(i.timelineOut(), max_frame)
                    frame = int(math.ceil((min_frame + max_frame) / 2.0))
                    thumb_qimage = task._sequence.thumbnail(frame)
                else:
                    # Simple item, just use middle frame
                    frame = int(math.ceil((item.sourceIn() + item.sourceOut()) / 2.0))
                    thumb_qimage = source.thumbnail(frame)
            # scale it down to 600px wide
            thumb_qimage_scaled = thumb_qimage.scaledToWidth(
                600, QtCore.Qt.SmoothTransformation
            )
            # scale thumbnail here...
            thumb_qimage_scaled.save(path)
            self.parent.log_debug(
                "Uploading thumbnail for %s %s..." % (entity["type"], entity["id"])
            )
            self.parent.shotgun.upload_thumbnail(entity["type"], entity["id"], path)
        except:
            self.parent.log_info(
                "Thumbnail for %s was not refreshed in Flow Production Tracking."
                % source
            )

            tb = traceback.format_exc()
            self.parent.log_debug(tb)
        finally:
            # Sometimes Windows holds on to the temporary thumbnail file longer than expected which
            # can cause an exception here. If we wait a second and try again, this usually solves
            # the issue.
            try:
                shutil.rmtree(thumbdir)
            except Exception:
                self.parent.log_error(
                    "Error removing temporary thumbnail file, trying again."
                )
                time.sleep(1.0)
                shutil.rmtree(thumbdir)