# Copyright (c) 2010 The Foundry Visionmongers Ltd. All Rights Reserved.
###############################################################################
import nuke_internal as nuke
[docs]class FlipbookApplication(object):
"""An interface, for so far as Python supports it. To add support for a
flipbook this needs to be subclassed and the 3 methods implemented. The
default implementation just raises an exception so any sub implementer
will soon find out whether his implementation works."""
def __init__(self):
return
[docs] def name(self):
""" Return the name of the flipbook.
@return: String"""
raise NotImplementedError
[docs] def path(self):
"""Return the executable path required to run a flipbook.
@return: String"""
raise NotImplementedError
[docs] def cacheDir(self):
"""Return the preferred directory for rendering.
@return: String"""
raise NotImplementedError
[docs] def runFromNode(self, nodeToFlipbook, frameRanges, views, options):
"""Execute the flipbook on a node.
This method will use the node's filename to call run()
@param node: The node to run the flipbook
@param frameRanges: A FrameRanges object representing the range that should be flipbooked. Note that in 6.2v1-2 this was a FrameRange object.
@param views: A list of strings comprising of the views to flipbook. Willnot be more than the maximum supported by the flipbook.
@param options: A dictionary of options to use. This may contain the keys pixelAspect, roi, dimensions, audio and lut. These contain a float, a dict with bounding box dimensions, a dict with width and height, a path to audio file and a string indicating the LUT conversion to apply.
@return: None"""
filename = nuke.filename(nodeToFlipbook)
if filename is None or filename == "":
raise RuntimeError("Cannot run a flipbook on '%s', expected to find a filename and there was none." % (nodeToFlipbook.fullName(),))
self.run( filename, frameRanges, views, options)
[docs] def run(self, path, frameRanges, views, options):
"""Execute the flipbook on a path.
@param path: The path to run the flipbook on. This will be similar to /path/to/foo%03d.exr
@param frameRanges: A FrameRanges object representing the range that should be flipbooked. Note that in 6.2v1-2 this was a FrameRange object.
@param views: A list of strings comprising of the views to flipbook. Willnot be more than the maximum supported by the flipbook.
@param options: A dictionary of options to use. This may contain the keys pixelAspect, roi, dimensions, audio and lut. These contain a float, a dict with bounding box dimensions, a dict with width and height, a path to audio file and a string indicating the LUT conversion to apply.
@return: None"""
raise NotImplementedError
[docs] def capabilities(self):
"""Return the capabilities of the flipbook application in a dict. Currently used are:
canPreLaunch: bool, whether the flipbook can display a frames that are still being rendered by Nuke.
maximumViews: int, the number of views supported by this flipbook, should be 1 or higher.
fileTypes: list, the extensions of the file types supported by this format. Must all be lowercase, e.g ["exr", "jpg", ...].
A wildcard ["*"] can also be used to indicate support for any file type Nuke supports
"roi: bool, whether the flipbook supports region-of-interest
@return: dict with the capabilities above."""
raise NotImplementedError
[docs] def dialogKnobs(self, dialog):
"""This is called when the user has selected this flipbook application, and will be interested in any knobs that you might have to show for custom settings.
@param dialog: The FlipbookDialog that has requested the knobs to be added to it, e.g. dialog.addKnob(...)
@return: None"""
raise NotImplementedError
[docs] def dialogKnobChanged(self, dialog, knob):
"""Called whenever this flipbook is selected and one of the knobs added in dialogKnobs was changed.
@param dialog: The FlipbookDialog that contains the knob
@param knob: The knob added in dialogKnobs that was modified.
@return: None"""
raise NotImplementedError
[docs]class FlipbookFactory(object):
def __init__(self):
self._flipbookApplications = {}
[docs] def isRegistered(self, flipbook):
""" Return whether a flipbook app with that name has already been registered.
@param flipbook: FlipBookApplication object that's tested for.
@return: bool"""
return flipbook.name() in self._flipbookApplications
[docs] def register(self, flipbookApplication):
"""Register a flipbook app. It will fail if the flipbook app name isn't unique.
@param flipbook: FlipBookApplication object to register
@return: None"""
if not self.isRegistered(flipbookApplication):
nuke.registerFlipbook(flipbookApplication.name())
self._flipbookApplications[flipbookApplication.name()] = flipbookApplication
else:
raise RuntimeError("Already registered a flipbook application with this name")
[docs] def getNames(self):
"""Returns a list of the names of all available flipbook apps.
@return: list"""
return sorted(self._flipbookApplications.keys())
[docs] def getApplication(self, name):
"""Returns the flipbook app implementation with the given name, raises an exception if none could be found.
@param name: The name of a flipbook that was registered.
@return: FlipBookApplication"""
if name in self._flipbookApplications:
return self._flipbookApplications[name]
else:
raise RuntimeError("Requested flipbook not registered")
[docs]class FlipbookLUTPathRegistry(object):
"""A registery of all LUT files against LUTs for each specific flipbook."""
def __init__(self):
self._luts = {}
[docs] def registerLUTPathForFlipbook(self, flipbook, lut, path):
"""Register the given LUT file.
@param flipbook: The unique name of the flipbook
@param lut: The unique name for the LUT, e.g. 'sRGB' and 'rec709'
@param path: Location of the flipbook specific file."""
if flipbook not in self._luts:
self._luts[flipbook] = {}
self._luts[flipbook][lut] = path
[docs] def getLUTPathForFlipbook(self, flipbook, lut):
"""Return the path for the given flipbook and lut. May return an empty string if none registered.
@param flipbook: The unique name of the flipbook
@param lut: The unique name for the LUT, e.g. 'sRGB' and 'rec709'"""
return self._luts.get(flipbook, {}).get(lut, "")
# Global registry of flipbooks.
gFlipbookFactory = FlipbookFactory()
# Global registry of user specified LUTs
gFlipbookLUTPathRegistry = FlipbookLUTPathRegistry()
# Convenience functions that make access to the globals a few key strokes less.
[docs]def register(flipbookApplication):
"""Register a flipbook. Convenience function that simple calls register() on the FlipbookFactory."""
gFlipbookFactory.register(flipbookApplication)
[docs]def registerLUTPath(flipbookApplication, lut, path):
"""Register a LUT for a specific flipbook. The path should refer to a file that contains the LUT for the given flipbook identified by the name in flipbookApplication. It is up to the flipbook subimplementation to actually use this file and the format may vary.
@param flipbook: The unique name of the flipbook
@param lut: The unique name for the LUT, e.g. 'sRGB' and 'rec709'
@param path: Location of the flipbook specific file."""
gFlipbookLUTPathRegistry.registerLUTPathForFlipbook(flipbookApplication, lut, path)
[docs]def getLUTPath(flipbookAppliction, lut):
"""Returns a path to a LUT file for the given flipbook. The contents of the file will be different for each flipbook application. Please see the relevant documentation for the specific flipbook applications.
@param flipbook: The unique name of the flipbook
@param lut: The unique name for the LUT, e.g. 'sRGB' and 'rec709'"""
return gFlipbookLUTPathRegistry.getLUTPathForFlipbook(flipbookAppliction, lut)