from __future__ import division
+import copy
import os
+import shutil
import sys
import PyOpenColorIO as ocio
from aces_ocio.colorspaces import sony
from aces_ocio.process import Process
+from aces_ocio.utilities import (
+ ColorSpace,
+ colorspace_prefixed_name,
+ compact,
+ replace,
+ unpack_default)
__author__ = 'ACES Developers'
__copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
'ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON',
'set_config_default_roles',
'write_config',
- 'generate_OCIO_transform',
- 'add_colorspace_alias',
+ 'generate_ocio_transform',
+ 'add_colorspace_aliases',
+ 'add_look',
+ 'integrate_looks_into_views',
'create_config',
'generate_LUTs',
'generate_baked_LUTs',
if texture_paint:
config.setRole(ocio.Constants.ROLE_TEXTURE_PAINT, texture_paint)
- # 'rendering' and 'compositing_linear' roles default to the 'scene_linear'
- # value if not set explicitly
+ # *rendering* and *compositing_linear* roles default to the *scene_linear*
+ # value if not set explicitly.
if rendering:
- config.setRole("rendering", rendering)
+ config.setRole('rendering', rendering)
if compositing_linear:
- config.setRole("compositing_linear", compositing_linear)
+ config.setRole('compositing_linear', compositing_linear)
if scene_linear:
config.setRole(ocio.Constants.ROLE_SCENE_LINEAR, scene_linear)
if not rendering:
- config.setRole("rendering", scene_linear)
+ config.setRole('rendering', scene_linear)
if not compositing_linear:
- config.setRole("compositing_linear", scene_linear)
+ config.setRole('compositing_linear', scene_linear)
return True
fp.write(config.serialize())
-def generate_OCIO_transform(transforms):
+def generate_ocio_transform(transforms):
"""
Object description.
Return value description.
"""
- interpolation_options = {
- 'linear': ocio.Constants.INTERP_LINEAR,
- 'nearest': ocio.Constants.INTERP_NEAREST,
- 'tetrahedral': ocio.Constants.INTERP_TETRAHEDRAL}
-
direction_options = {
'forward': ocio.Constants.TRANSFORM_DIR_FORWARD,
'inverse': ocio.Constants.TRANSFORM_DIR_INVERSE}
for transform in transforms:
- # lutFile transform
+ # *lutFile* transform
if transform['type'] == 'lutFile':
- ocio_transform = ocio.FileTransform(
- src=transform['path'],
- interpolation=interpolation_options[
- transform['interpolation']],
- direction=direction_options[transform['direction']])
+ ocio_transform = ocio.FileTransform()
+
+ if 'path' in transform:
+ ocio_transform.setSrc(transform['path'])
+
+ if 'cccid' in transform:
+ ocio_transform.setCCCId(transform['cccid'])
+
+ if 'interpolation' in transform:
+ ocio_transform.setInterpolation(transform['interpolation'])
+ else:
+ ocio_transform.setInterpolation(ocio.Constants.INTERP_BEST)
+
+ if 'direction' in transform:
+ ocio_transform.setDirection(
+ direction_options[transform['direction']])
+
ocio_transforms.append(ocio_transform)
- # matrix transform
+ # *matrix* transform
elif transform['type'] == 'matrix':
ocio_transform = ocio.MatrixTransform()
- # MatrixTransform member variables can't be initialized directly.
- # Each must be set individually.
+ # `MatrixTransform` member variables can't be initialized directly,
+ # each must be set individually.
ocio_transform.setMatrix(transform['matrix'])
if 'offset' in transform:
ocio_transforms.append(ocio_transform)
- # exponent transform
+ # *exponent* transform
elif transform['type'] == 'exponent':
ocio_transform = ocio.ExponentTransform()
- ocio_transform.setValue(transform['value'])
+
+ if 'value' in transform:
+ ocio_transform.setValue(transform['value'])
+
ocio_transforms.append(ocio_transform)
- # log transform
+ # *log* transform
elif transform['type'] == 'log':
- ocio_transform = ocio.LogTransform(
- base=transform['base'],
- direction=direction_options[transform['direction']])
+ ocio_transform = ocio.LogTransform()
+
+ if 'base' in transform:
+ ocio_transform.setBase(transform['base'])
+
+ if 'direction' in transform:
+ ocio_transform.setDirection(
+ direction_options[transform['direction']])
ocio_transforms.append(ocio_transform)
- # color space transform
+ # *colorspace* transform
elif transform['type'] == 'colorspace':
- ocio_transform = ocio.ColorSpaceTransform(src=transform['src'],
- dst=transform['dst'],
- direction=
- direction_options[
- 'forward'])
+ ocio_transform = ocio.ColorSpaceTransform()
+
+ if 'src' in transform:
+ ocio_transform.setSrc(transform['src'])
+
+ if 'dst' in transform:
+ ocio_transform.setDst(transform['dst'])
+
+ if 'direction' in transform:
+ ocio_transform.setDirection(
+ direction_options[transform['direction']])
+
+ ocio_transforms.append(ocio_transform)
+
+ # *look* transform
+ elif transform['type'] == 'look':
+ ocio_transform = ocio.LookTransform()
+ if 'look' in transform:
+ ocio_transform.setLooks(transform['look'])
+
+ if 'src' in transform:
+ ocio_transform.setSrc(transform['src'])
+
+ if 'dst' in transform:
+ ocio_transform.setDst(transform['dst'])
+
+ if 'direction' in transform:
+ ocio_transform.setDirection(
+ direction_options[transform['direction']])
+
ocio_transforms.append(ocio_transform)
- # unknown type
+
+ # *unknown* type
else:
- print("Ignoring unknown transform type : %s" % transform['type'])
+ print('Ignoring unknown transform type : %s' % transform['type'])
if len(ocio_transforms) > 1:
group_transform = ocio.GroupTransform()
return transform
-def add_colorspace_alias(config,
- reference_colorspace,
- colorspace,
- colorspace_alias_names):
+def add_colorspace_aliases(config,
+ reference_colorspace,
+ colorspace,
+ colorspace_alias_names,
+ family='Aliases'):
"""
Object description.
for alias_name in colorspace_alias_names:
if alias_name.lower() == colorspace.name.lower():
- print('Skipping alias creation for %s, alias %s, because lower cased names match' % (
- colorspace.name, alias_name) )
- return
+ print('Skipping alias creation for %s, alias %s, '
+ 'because lower cased names match' % (
+ colorspace.name, alias_name))
+ continue
print('Adding alias colorspace space %s, alias to %s' % (
alias_name, colorspace.name))
- compact_family_name = 'Aliases'
+ compact_family_name = family
+
+ description = colorspace.description
+ if colorspace.aces_transform_id:
+ description += (
+ '\n\nACES Transform ID : %s' % colorspace.aces_transform_id)
ocio_colorspace_alias = ocio.ColorSpace(
name=alias_name,
bitDepth=colorspace.bit_depth,
- description=colorspace.description,
+ description=description,
equalityGroup=colorspace.equality_group,
family=compact_family_name,
isData=colorspace.is_data,
allocationVars=colorspace.allocation_vars)
if colorspace.to_reference_transforms:
- print('Generating To-Reference transforms')
- ocio_transform = generate_OCIO_transform(
+ print('\tGenerating To-Reference transforms')
+ ocio_transform = generate_ocio_transform(
[{'type': 'colorspace',
'src': colorspace.name,
'dst': reference_colorspace.name,
ocio.Constants.COLORSPACE_DIR_TO_REFERENCE)
if colorspace.from_reference_transforms:
- print('Generating From-Reference transforms')
- ocio_transform = generate_OCIO_transform(
+ print('\tGenerating From-Reference transforms')
+ ocio_transform = generate_ocio_transform(
[{'type': 'colorspace',
'src': reference_colorspace.name,
'dst': colorspace.name,
config.addColorSpace(ocio_colorspace_alias)
-def create_config(config_data, gui=False):
+def add_look(config,
+ look,
+ custom_lut_dir,
+ reference_name,
+ config_data):
+ """
+ Object description.
+
+ Parameters
+ ----------
+ parameter : type
+ Parameter description.
+
+ Returns
+ -------
+ type
+ Return value description.
+ """
+
+ look_name, look_colorspace, look_lut, look_cccid = unpack_default(look, 4)
+
+ print('Adding look %s - %s' % (look_name, ', '.join(look)))
+
+ # Copy *look LUT* if `custom_lut_dir` is provided.
+ if custom_lut_dir:
+ if '$' not in look_lut:
+ print('Getting ready to copy look lut : %s' % look_lut)
+ shutil.copy2(look_lut, custom_lut_dir)
+ look_lut = os.path.split(look_lut)[1]
+ else:
+ print('Skipping LUT copy because path contains a context variable')
+
+ print('Adding look to config')
+ ocio_look = ocio.Look()
+ ocio_look.setName(look_name)
+ ocio_look.setProcessSpace(look_colorspace)
+
+ keys = {'type': 'lutFile',
+ 'path': look_lut,
+ 'direction': 'forward'}
+ if look_cccid:
+ keys['cccid'] = look_cccid
+
+ ocio_transform = generate_ocio_transform([keys])
+ ocio_look.setTransform(ocio_transform)
+
+ config.addLook(ocio_look)
+
+ print('Creating aliased colorspace')
+
+ # Creating *OCIO* colorspace referencing the look:
+ # - Needed for implementations that don't process looks properly.
+ # - Needed for implementations that don't expose looks properly.
+ look_aliases = ['look_%s' % compact(look_name)]
+ colorspace = ColorSpace(look_name,
+ aliases=look_aliases,
+ description='The %s Look colorspace' % look_name,
+ family='Look')
+
+ colorspace.from_reference_transforms = [{'type': 'look',
+ 'look': look_name,
+ 'src': reference_name,
+ 'dst': reference_name,
+ 'direction': 'forward'}]
+
+ print('Adding colorspace %s, alias to look %s to config data' % (
+ look_name, look_name))
+
+ config_data['colorSpaces'].append(colorspace)
+
+ print()
+
+
+def integrate_looks_into_views(looks,
+ reference_name,
+ config_data,
+ multiple_displays=False):
+ """
+ Object description.
+
+ Parameters
+ ----------
+ parameter : type
+ Parameter description.
+
+ Returns
+ -------
+ type
+ Return value description.
+ """
+ look_names = [look[0] for look in looks]
+
+ # Option 1
+ # - Adding a *look* per *Display*.
+ # - Assuming there is a *Display* for each *ACES* *Output Transform*.
+ if multiple_displays:
+ for look_name in look_names:
+ config_data['looks'].append(look_name)
+
+ # Option 2
+ # - Copy each *Output Transform* colorspace.
+ # - For each copy, add a *LookTransform* to the head of the
+ # `from_reference` transform list.
+ # - Add these the copy colorspaces for the *Displays* / *Views*.
+ else:
+ for display, view_list in config_data['displays'].iteritems():
+ colorspace_c = None
+ look_names_string = ''
+ for view_name, output_colorspace in view_list.iteritems():
+ if view_name == 'Output Transform':
+
+ print('Adding new View that incorporates looks')
+
+ colorspace_c = copy.deepcopy(output_colorspace)
+
+ for i, look_name in enumerate(look_names):
+ look_name = look_names[i]
+
+ # Add the `LookTransform` to the head of the
+ # `from_reference` transform list.
+ if colorspace_c.from_reference_transforms:
+ colorspace_c.from_reference_transforms.insert(
+ i,
+ {'type': 'look',
+ 'look': look_name,
+ 'src': reference_name,
+ 'dst': reference_name,
+ 'direction': 'forward'})
+
+ # Add the `LookTransform` to the end of
+ # the `to_reference` transform list.
+ if colorspace_c.to_reference_transforms:
+ inverse_look_name = look_names[
+ len(look_names) - 1 - i]
+
+ colorspace_c.to_reference_transforms.append(
+ {'type': 'look',
+ 'look': inverse_look_name,
+ 'src': reference_name,
+ 'dst': reference_name,
+ 'direction': 'inverse'})
+
+ if look_name not in config_data['looks']:
+ config_data['looks'].append(look_name)
+
+ look_names_string = ', '.join(look_names)
+ colorspace_c.name = '%s with %s' % (
+ output_colorspace.name, look_names_string)
+ colorspace_c.aliases = [
+ 'out_%s' % compact(colorspace_c.name)]
+
+ print('Colorspace that incorporates looks '
+ 'created : %s' % colorspace_c.name)
+
+ config_data['colorSpaces'].append(colorspace_c)
+
+ if colorspace_c:
+ print('Adding colorspace that incorporates looks '
+ 'into view list')
+
+ # Updating the *View* name.
+ view_list['Output Transform with %s' % look_names_string] = (
+ colorspace_c)
+ config_data['displays'][display] = view_list
+
+
+def create_config(config_data,
+ aliases=False,
+ prefix=False,
+ multiple_displays=False,
+ look_info=None,
+ custom_lut_dir=None):
"""
Object description.
Return value description.
"""
- # Creating the *OCIO* configuration.
+ if look_info is None:
+ look_info = []
+
+ prefixed_names = {}
+ alias_colorspaces = []
+
config = ocio.Config()
- # Setting configuration overall values.
config.setDescription('An ACES config generated from python')
- config.setSearchPath('luts')
- # Defining the reference colorspace.
+ search_path = ['luts']
+ if custom_lut_dir:
+ search_path.append('custom')
+ config.setSearchPath(':'.join(search_path))
+
reference_data = config_data['referenceColorSpace']
+
+ # Adding the colorspace *Family* into the name which helps with
+ # applications that presenting colorspaces as one a flat list.
+ if prefix:
+ prefixed_name = colorspace_prefixed_name(reference_data)
+ prefixed_names[reference_data.name] = prefixed_name
+ reference_data.name = prefixed_name
+
print('Adding the reference color space : %s' % reference_data.name)
reference = ocio.ColorSpace(
config.addColorSpace(reference)
- # Add alias
- #if not gui:
- if reference_data.aliases != []:
- add_colorspace_alias(config, reference_data,
- reference_data, reference_data.aliases)
+ if aliases:
+ if reference_data.aliases:
+ # TODO: Explain context for following comment.
+ # Deferring adding alias colorspaces until end, which helps with
+ # some applications.
+ alias_colorspaces.append(
+ [reference_data, reference_data, reference_data.aliases])
+
+ print()
+
+ if look_info:
+ print('Adding looks')
- print("")
+ config_data['looks'] = []
- #print( "color spaces : %s" % [x.name for x in sorted(config_data['colorSpaces'])])
+ for look in look_info:
+ add_look(config,
+ look,
+ custom_lut_dir,
+ reference_data.name,
+ config_data)
+
+ integrate_looks_into_views(look_info,
+ reference_data.name,
+ config_data,
+ multiple_displays)
+
+ print()
+
+ print('Adding regular colorspaces')
- # Creating the remaining colorspaces.
for colorspace in sorted(config_data['colorSpaces']):
+ # Adding the colorspace *Family* into the name which helps with
+ # applications that presenting colorspaces as one a flat list.
+ if prefix:
+ prefixed_name = colorspace_prefixed_name(colorspace)
+ prefixed_names[colorspace.name] = prefixed_name
+ colorspace.name = prefixed_name
+
print('Creating new color space : %s' % colorspace.name)
+ description = colorspace.description
+ if colorspace.aces_transform_id:
+ description += (
+ '\n\nACES Transform ID : %s' % colorspace.aces_transform_id)
+
ocio_colorspace = ocio.ColorSpace(
name=colorspace.name,
bitDepth=colorspace.bit_depth,
- description=colorspace.description,
+ description=description,
equalityGroup=colorspace.equality_group,
family=colorspace.family,
isData=colorspace.is_data,
allocationVars=colorspace.allocation_vars)
if colorspace.to_reference_transforms:
- print('Generating To-Reference transforms')
- ocio_transform = generate_OCIO_transform(
+ print('\tGenerating To-Reference transforms')
+ ocio_transform = generate_ocio_transform(
colorspace.to_reference_transforms)
ocio_colorspace.setTransform(
ocio_transform,
ocio.Constants.COLORSPACE_DIR_TO_REFERENCE)
if colorspace.from_reference_transforms:
- print('Generating From-Reference transforms')
- ocio_transform = generate_OCIO_transform(
+ print('\tGenerating From-Reference transforms')
+ ocio_transform = generate_ocio_transform(
colorspace.from_reference_transforms)
ocio_colorspace.setTransform(
ocio_transform,
config.addColorSpace(ocio_colorspace)
- #
- # Add alias to normal colorspace, using compact name
- #
- #if not gui:
- if colorspace.aliases != []:
- #print('Adding alias color spaces : %s' % colorspace.aliases)
- add_colorspace_alias(config, reference_data,
- colorspace, colorspace.aliases)
+ if aliases:
+ if colorspace.aliases:
+ # TODO: Explain context for following comment.
+ # Deferring adding alias colorspaces until end, which helps
+ # with some applications.
+ alias_colorspaces.append(
+ [reference_data, colorspace, colorspace.aliases])
+
+ print()
+
+ print()
+
+ # Adding roles early so that alias colorspaces can be created
+ # with roles names before remaining colorspace aliases are added
+ # to the configuration.
+ print('Setting the roles')
+
+ if prefix:
+ set_config_default_roles(
+ config,
+ color_picking=prefixed_names[
+ config_data['roles']['color_picking']],
+ color_timing=prefixed_names[config_data['roles']['color_timing']],
+ compositing_log=prefixed_names[
+ config_data['roles']['compositing_log']],
+ data=prefixed_names[config_data['roles']['data']],
+ default=prefixed_names[config_data['roles']['default']],
+ matte_paint=prefixed_names[config_data['roles']['matte_paint']],
+ reference=prefixed_names[config_data['roles']['reference']],
+ scene_linear=prefixed_names[config_data['roles']['scene_linear']],
+ texture_paint=prefixed_names[
+ config_data['roles']['texture_paint']])
+
+ # TODO: Should we remove this dead code path?
+ # Not allowed at the moment as role names can not overlap
+ # with colorspace names.
+ """
+ # Add the aliased colorspaces for each role
+ for role_name, role_colorspace_name in config_data['roles'].iteritems():
+ role_colorspace_prefixed_name = prefixed_names[role_colorspace_name]
+
+ print( 'Finding colorspace : %s' % role_colorspace_prefixed_name )
+ # Find the colorspace pointed to by the role
+ role_colorspaces = [colorspace
+ for colorspace in config_data['colorSpaces']
+ if colorspace.name == role_colorspace_prefixed_name]
+ role_colorspace = None
+ if len(role_colorspaces) > 0:
+ role_colorspace = role_colorspaces[0]
+ else:
+ if reference_data.name == role_colorspace_prefixed_name:
+ role_colorspace = reference_data
+
+ if role_colorspace:
+ print( 'Adding an alias colorspace named %s, pointing to %s' % (
+ role_name, role_colorspace.name))
+
+ add_colorspace_aliases(
+ config, reference_data, role_colorspace, [role_name], 'Roles')
+ """
+
+ else:
+ set_config_default_roles(
+ config,
+ color_picking=config_data['roles']['color_picking'],
+ color_timing=config_data['roles']['color_timing'],
+ compositing_log=config_data['roles']['compositing_log'],
+ data=config_data['roles']['data'],
+ default=config_data['roles']['default'],
+ matte_paint=config_data['roles']['matte_paint'],
+ reference=config_data['roles']['reference'],
+ scene_linear=config_data['roles']['scene_linear'],
+ texture_paint=config_data['roles']['texture_paint'])
+
+ # TODO: Should we remove this dead code path?
+ # Not allowed at the moment as role names can not overlap
+ # with colorspace names.
+ """
+ # Add the aliased colorspaces for each role
+ for role_name, role_colorspace_name in config_data['roles'].iteritems():
+ # Find the colorspace pointed to by the role
+ role_colorspaces = [colorspace
+ for colorspace in config_data['colorSpaces']
+ if colorspace.name == role_colorspace_name]
+ role_colorspace = None
+ if len(role_colorspaces) > 0:
+ role_colorspace = role_colorspaces[0]
+ else:
+ if reference_data.name == role_colorspace_name:
+ role_colorspace = reference_data
+
+ if role_colorspace:
+ print('Adding an alias colorspace named %s, pointing to %s' % (
+ role_name, role_colorspace.name))
+
+ add_colorspace_aliases(
+ config, reference_data, role_colorspace, [role_name], 'Roles')
+ """
- print('')
+ print()
- # Defining the *views* and *displays*.
- displays = []
- views = []
+ # Adding alias colorspaces at the end as some applications use
+ # colorspaces definitions order of the configuration to order
+ # the colorspaces in their selection lists, some applications
+ # use alphabetical ordering.
+ # This should keep the alias colorspaces out of the way for applications
+ # using the configuration order.
+ print('Adding the alias colorspaces')
+ for reference, colorspace, aliases in alias_colorspaces:
+ add_colorspace_aliases(config, reference, colorspace, aliases)
- # Defining a *generic* *display* and *view* setup.
- if not gui:
+ print()
+
+ print('Adding the diplays and views')
+
+ # Setting the *color_picking* role to be the first *Display*'s
+ # *Output Transform* *View*.
+ default_display_name = config_data['defaultDisplay']
+ default_display_views = config_data['displays'][default_display_name]
+ default_display_colorspace = default_display_views['Output Transform']
+
+ set_config_default_roles(
+ config,
+ color_picking=default_display_colorspace.name)
+
+ # Defining *Displays* and *Views*.
+ displays, views = [], []
+
+ # Defining a generic *Display* and *View* setup.
+ if multiple_displays:
+ looks = config_data['looks'] if ('looks' in config_data) else []
+ looks = ', '.join(looks)
+ print('Creating multiple displays, with looks : %s' % looks)
+
+ # *Displays* are not reordered to put the *defaultDisplay* first
+ # because *OCIO* will order them alphabetically when the configuration
+ # is written to disk.
for display, view_list in config_data['displays'].iteritems():
for view_name, colorspace in view_list.iteritems():
- config.addDisplay(display, view_name, colorspace.name)
+ config.addDisplay(display, view_name, colorspace.name, looks)
+ if 'Output Transform' in view_name and looks != '':
+ # *Views* without *Looks*.
+ config.addDisplay(display, view_name, colorspace.name)
+
+ # *Views* with *Looks*.
+ view_name_with_looks = '%s with %s' % (view_name, looks)
+ config.addDisplay(display, view_name_with_looks,
+ colorspace.name, looks)
+ else:
+ config.addDisplay(display, view_name, colorspace.name)
if not (view_name in views):
views.append(view_name)
displays.append(display)
- # Defining the set of *views* and *displays* useful in a *GUI* context.
+ # *Displays* and *Views* useful in a *GUI* context.
else:
- display_name = 'ACES'
- displays.append(display_name)
+ single_display_name = 'ACES'
+ displays.append(single_display_name)
+ # Ensuring the *defaultDisplay* is first.
display_names = sorted(config_data['displays'])
+ display_names.insert(0, display_names.pop(
+ display_names.index(default_display_name)))
+
+ looks = config_data['looks'] if ('looks' in config_data) else []
+ look_names = ', '.join(looks)
- # Make sure the default display is first
- default_display = config_data['defaultDisplay']
- display_names.insert(0, display_names.pop(display_names.index(default_display)))
+ displays_views_colorspaces = []
for display in display_names:
view_list = config_data['displays'][display]
for view_name, colorspace in view_list.iteritems():
- if view_name == 'Output Transform':
- config.addDisplay(display_name, display, colorspace.name)
- if not (display in views):
- views.append(display)
-
- # Works with Nuke Studio and Mari, but not Nuke
- # display_name = 'Utility'
- # displays.append(display_name)
-
- linear_display_space_name = config_data['roles']['scene_linear']
+ if 'Output Transform' in view_name:
+
+ # We use the *Display* names as the *View* names in this
+ # case as there is a single *Display* containing all the
+ # *Views*.
+ # This works for more applications than not,as of the time
+ # of this implementation.
+
+ # Autodesk Maya 2016 doesn't support parentheses in
+ # *View* names.
+ sanitised_display = replace(display, {')': '', '(': ''})
+
+ # *View* with *Looks*.
+ if 'with' in view_name:
+ sanitised_display = '%s with %s' % (
+ sanitised_display, look_names)
+
+ views_with_looks_at_end = False
+ # Storing combo of *Display*, *View* and *Colorspace*
+ # name so they can be added to the end of the list.
+ if views_with_looks_at_end:
+ displays_views_colorspaces.append(
+ [single_display_name, sanitised_display,
+ colorspace.name])
+ else:
+ config.addDisplay(single_display_name,
+ sanitised_display,
+ colorspace.name)
+
+ if not (sanitised_display in views):
+ views.append(sanitised_display)
+
+ # *View* without *Looks*.
+ else:
+ config.addDisplay(single_display_name,
+ sanitised_display,
+ colorspace.name)
+
+ if not (sanitised_display in views):
+ views.append(sanitised_display)
+
+ # Adding to the configuration any *Display*, *View* combinations that
+ # were saved for later.
+ # This list should be empty unless `views_with_looks_at_end` is
+ # set `True` above.
+ for display_view_colorspace in displays_views_colorspaces:
+ single_display_name, sanitised_display, colorspace_name = (
+ display_view_colorspace)
+
+ config.addDisplay(single_display_name,
+ sanitised_display,
+ colorspace_name)
+
+ if not (sanitised_display in views):
+ views.append(sanitised_display)
+
+ raw_display_space_name = config_data['roles']['data']
log_display_space_name = config_data['roles']['compositing_log']
- config.addDisplay(display_name, 'Linear', linear_display_space_name)
- views.append('Linear')
- config.addDisplay(display_name, 'Log', log_display_space_name)
+ if prefix:
+ raw_display_space_name = prefixed_names[raw_display_space_name]
+ log_display_space_name = prefixed_names[log_display_space_name]
+
+ config.addDisplay(single_display_name, 'Raw', raw_display_space_name)
+ views.append('Raw')
+ config.addDisplay(single_display_name, 'Log', log_display_space_name)
views.append('Log')
- # Setting the active *displays* and *views*.
config.setActiveDisplays(','.join(sorted(displays)))
config.setActiveViews(','.join(views))
- set_config_default_roles(
- config,
- color_picking=config_data['roles']['color_picking'],
- color_timing=config_data['roles']['color_timing'],
- compositing_log=config_data['roles']['compositing_log'],
- data=config_data['roles']['data'],
- default=config_data['roles']['default'],
- matte_paint=config_data['roles']['matte_paint'],
- reference=config_data['roles']['reference'],
- scene_linear=config_data['roles']['scene_linear'],
- texture_paint=config_data['roles']['texture_paint'])
+ print()
+ # Ensuring the configuration is valid.
config.sanityCheck()
+ # Resetting colorspace names to their non-prefixed versions.
+ if prefix:
+ prefixed_names_inverse = {}
+ for original, prefixed in prefixed_names.iteritems():
+ prefixed_names_inverse[prefixed] = original
+
+ reference_data.name = prefixed_names_inverse[reference_data.name]
+
+ try:
+ for colorspace in config_data['colorSpaces']:
+ colorspace.name = prefixed_names_inverse[colorspace.name]
+ except:
+ print('Prefixed names')
+ for original, prefixed in prefixed_names.iteritems():
+ print('%s, %s' % (original, prefixed))
+
+ print('\n')
+
+ print('Inverse Lookup of Prefixed names')
+ for prefixed, original in prefixed_names_inverse.iteritems():
+ print('%s, %s' % (prefixed, original))
+ raise
+
return config
print('generateLUTs - begin')
config_data = {}
- # Initialize a few variables
config_data['displays'] = {}
config_data['colorSpaces'] = []
# *Camera Input Transforms*
# -------------------------------------------------------------------------
- # *ARRI Log-C* to *ACES*.
- arri_colorSpaces = arri.create_colorspaces(lut_directory,
+ # *ARRI Log-C* to *ACES*
+ arri_colorspaces = arri.create_colorspaces(lut_directory,
lut_resolution_1d)
- for cs in arri_colorSpaces:
+ for cs in arri_colorspaces:
config_data['colorSpaces'].append(cs)
- # *Canon-Log* to *ACES*.
+ # *Canon-Log* to *ACES*
canon_colorspaces = canon.create_colorspaces(lut_directory,
lut_resolution_1d)
for cs in canon_colorspaces:
config_data['colorSpaces'].append(cs)
- # *GoPro Protune* to *ACES*.
+ # *GoPro Protune* to *ACES*
gopro_colorspaces = gopro.create_colorspaces(lut_directory,
lut_resolution_1d)
for cs in gopro_colorspaces:
config_data['colorSpaces'].append(cs)
- # *Panasonic V-Log* to *ACES*.
- panasonic_colorSpaces = panasonic.create_colorspaces(lut_directory,
+ # *Panasonic V-Log* to *ACES*
+ panasonic_colorspaces = panasonic.create_colorspaces(lut_directory,
lut_resolution_1d)
- for cs in panasonic_colorSpaces:
+ for cs in panasonic_colorspaces:
config_data['colorSpaces'].append(cs)
- # *RED* colorspaces to *ACES*.
+ # *RED* colorspaces to *ACES*
red_colorspaces = red.create_colorspaces(lut_directory,
lut_resolution_1d)
for cs in red_colorspaces:
config_data['colorSpaces'].append(cs)
- # *S-Log* to *ACES*.
- sony_colorSpaces = sony.create_colorspaces(lut_directory,
+ # *S-Log* to *ACES*
+ sony_colorspaces = sony.create_colorspaces(lut_directory,
lut_resolution_1d)
- for cs in sony_colorSpaces:
+ for cs in sony_colorspaces:
config_data['colorSpaces'].append(cs)
# -------------------------------------------------------------------------
- # General Color Spaces
+ # General Colorspaces
# -------------------------------------------------------------------------
- general_colorSpaces = general.create_colorspaces(lut_directory,
- lut_resolution_1d,
- lut_resolution_3d)
- for cs in general_colorSpaces:
+ general_colorspaces = general.create_colorspaces(lut_directory,
+ lut_resolution_1d)
+ for cs in general_colorspaces:
config_data['colorSpaces'].append(cs)
- # The *Raw* color space
+ # The *Raw* colorspace
raw = general.create_raw()
config_data['colorSpaces'].append(raw)
- # Override certain roles, for now
+ # Overriding various roles
config_data['roles']['data'] = raw.name
config_data['roles']['reference'] = raw.name
config_data['roles']['texture_paint'] = raw.name
print('generateLUTs - end')
+
return config_data
shaper_name,
baked_directory,
config_path,
- lut_resolution_1d,
lut_resolution_3d,
- lut_resolution_shaper=1024):
+ lut_resolution_shaper=1024,
+ prefix=False):
"""
Object description.
Return value description.
"""
- # Create two entries for ODTs that have full and legal range support
odt_info_C = dict(odt_info)
+
+ # Older behavior for *ODTs* that have support for full and legal ranges,
+ # generating a LUT for both ranges.
+ """
+ # Create two entries for ODTs that have full and legal range support
for odt_ctl_name, odt_values in odt_info.iteritems():
if odt_values['transformHasFullLegalSwitch']:
odt_name = odt_values['transformUserName']
odt_info_C['%s - Full' % odt_ctl_name] = odt_values_full
del (odt_info_C[odt_ctl_name])
+ """
- # Generate appropriate LUTs for each ODT
for odt_ctl_name, odt_values in odt_info_C.iteritems():
odt_prefix = odt_values['transformUserNamePrefix']
odt_name = odt_values['transformUserName']
# *Photoshop*
for input_space in ['ACEScc', 'ACESproxy']:
args = ['--iconfig', config_path,
- '-v',
- '--inputspace', input_space]
- args += ['--outputspace', '%s' % odt_name]
+ '-v']
+ if prefix:
+ args += ['--inputspace', 'ACES - %s' % input_space]
+ args += ['--outputspace', 'Output - %s' % odt_name]
+ else:
+ args += ['--inputspace', input_space]
+ args += ['--outputspace', odt_name]
+
args += ['--description',
'%s - %s for %s data' % (odt_prefix,
odt_name,
input_space)]
- args += ['--shaperspace', shaper_name,
- '--shapersize', str(lut_resolution_shaper)]
+ if prefix:
+ args += ['--shaperspace', 'Utility - %s' % shaper_name,
+ '--shapersize', str(lut_resolution_shaper)]
+ else:
+ args += ['--shaperspace', shaper_name,
+ '--shapersize', str(lut_resolution_shaper)]
args += ['--cubesize', str(lut_resolution_3d)]
args += ['--format',
'icc',
# *Flame*, *Lustre*
for input_space in ['ACEScc', 'ACESproxy']:
args = ['--iconfig', config_path,
- '-v',
- '--inputspace', input_space]
- args += ['--outputspace', '%s' % odt_name]
+ '-v']
+ if prefix:
+ args += ['--inputspace', 'ACES - %s' % input_space]
+ args += ['--outputspace', 'Output - %s' % odt_name]
+ else:
+ args += ['--inputspace', input_space]
+ args += ['--outputspace', odt_name]
args += ['--description',
'%s - %s for %s data' % (
odt_prefix, odt_name, input_space)]
- args += ['--shaperspace', shaper_name,
- '--shapersize', str(lut_resolution_shaper)]
+ if prefix:
+ args += ['--shaperspace', 'Utility - %s' % shaper_name,
+ '--shapersize', str(lut_resolution_shaper)]
+ else:
+ args += ['--shaperspace', shaper_name,
+ '--shapersize', str(lut_resolution_shaper)]
args += ['--cubesize', str(lut_resolution_3d)]
fargs = ['--format',
# *Maya*, *Houdini*
for input_space in ['ACEScg', 'ACES2065-1']:
args = ['--iconfig', config_path,
- '-v',
- '--inputspace', input_space]
- args += ['--outputspace', '%s' % odt_name]
+ '-v']
+ if prefix:
+ args += ['--inputspace', 'ACES - %s' % input_space]
+ args += ['--outputspace', 'Output - %s' % odt_name]
+ else:
+ args += ['--inputspace', input_space]
+ args += ['--outputspace', odt_name]
args += ['--description',
'%s - %s for %s data' % (
odt_prefix, odt_name, input_space)]
lin_shaper_name = '%s - AP1' % shaper_name
else:
lin_shaper_name = shaper_name
+ if prefix:
+ lin_shaper_name = 'Utility - %s' % lin_shaper_name
args += ['--shaperspace', lin_shaper_name,
'--shapersize', str(lut_resolution_shaper)]
bake_lut.execute()
-def create_config_dir(config_directory, bake_secondary_LUTs):
+def create_config_dir(config_directory,
+ bake_secondary_luts=False,
+ custom_lut_dir=None):
"""
Object description.
lut_directory = os.path.join(config_directory, 'luts')
dirs = [config_directory, lut_directory]
- if bake_secondary_LUTs:
+
+ if bake_secondary_luts:
dirs.extend([os.path.join(config_directory, 'baked'),
os.path.join(config_directory, 'baked', 'flame'),
os.path.join(config_directory, 'baked', 'photoshop'),
os.path.join(config_directory, 'baked', 'lustre'),
os.path.join(config_directory, 'baked', 'maya')])
+ if custom_lut_dir:
+ dirs.append(os.path.join(config_directory, 'custom'))
+
for d in dirs:
not os.path.exists(d) and os.mkdir(d)
config_directory,
lut_resolution_1d=4096,
lut_resolution_3d=64,
- bake_secondary_LUTs=True,
- cleanup=True):
+ bake_secondary_luts=True,
+ multiple_displays=False,
+ look_info=None,
+ copy_custom_luts=True,
+ cleanup=True,
+ prefix_colorspaces_with_family_names=True):
"""
Creates the ACES configuration.
Return value description.
"""
- lut_directory = create_config_dir(config_directory, bake_secondary_LUTs)
+ if look_info is None:
+ look_info = []
+
+ custom_lut_dir = None
+ if copy_custom_luts:
+ custom_lut_dir = os.path.join(config_directory, 'custom')
+
+ lut_directory = create_config_dir(config_directory,
+ bake_secondary_luts,
+ custom_lut_dir)
odt_info = aces.get_ODTs_info(aces_ctl_directory)
lmt_info = aces.get_LMTs_info(aces_ctl_directory)
lut_resolution_3d,
cleanup)
- '''
- print('Creating "generic" config')
- config = create_config(config_data)
+ print('Creating config - with prefixes, with aliases')
+ config = create_config(config_data,
+ prefix=prefix_colorspaces_with_family_names,
+ aliases=True,
+ multiple_displays=multiple_displays,
+ look_info=look_info,
+ custom_lut_dir=custom_lut_dir)
print('\n\n\n')
write_config(config,
os.path.join(config_directory, 'config.ocio'))
- '''
-
- print('Creating "GUI" config')
- gui_config = create_config(config_data, gui=True)
- print('\n\n\n')
- write_config(gui_config,
- os.path.join(config_directory, 'config.ocio'))
-
- if bake_secondary_LUTs:
+ if bake_secondary_luts:
generate_baked_LUTs(odt_info,
shaper_name,
os.path.join(config_directory, 'baked'),
os.path.join(config_directory, 'config.ocio'),
- lut_resolution_1d,
lut_resolution_3d,
- lut_resolution_1d)
+ lut_resolution_1d,
+ prefix=prefix_colorspaces_with_family_names)
return True
import optparse
- p = optparse.OptionParser(description='An OCIO config generation script',
- prog='createACESConfig',
- version='createACESConfig 0.1',
- usage='%prog [options]')
+ usage = '%prog [options]\n'
+ usage += '\n'
+ usage += 'An OCIO config generation script for ACES 1.0\n'
+ usage += '\n'
+ usage += 'Command line examples'
+ usage += '\n'
+ usage += ('Create a GUI-friendly ACES 1.0 config with no secondary, '
+ 'baked LUTs : \n')
+ usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
+ '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
+ '--dontBakeSecondaryLUTs')
+ usage += '\n'
+ usage += 'Create a more OCIO-compliant ACES 1.0 config : \n'
+ usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
+ '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
+ '--createMultipleDisplays')
+ usage += '\n'
+ usage += '\n'
+ usage += 'Adding custom looks'
+ usage += '\n'
+ usage += ('Create a GUI-friendly ACES 1.0 config with an ACES-style CDL '
+ '(will be applied in the ACEScc colorspace): \n')
+ usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
+ '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
+ '\n\t\t--addACESLookCDL ACESCDLName '
+ '/path/to/SampleCDL.ccc cc03345')
+ usage += '\n'
+ usage += 'Create a GUI-friendly ACES 1.0 config with an general CDL: \n'
+ usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
+ '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
+ '\n\t\t--addCustomLookCDL CustomCDLName "ACES - ACEScc" '
+ '/path/to/SampleCDL.ccc cc03345')
+ usage += '\n'
+ usage += ('\tIn this example, the CDL will be applied in the '
+ 'ACEScc colorspace, but the user could choose other spaces '
+ 'by changing the argument after the name of the look. \n')
+ usage += '\n'
+ usage += ('Create a GUI-friendly ACES 1.0 config with an ACES-style LUT '
+ '(will be applied in the ACEScc colorspace): \n')
+ usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
+ '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
+ '\n\t\t--addACESLookLUT ACESLUTName '
+ '/path/to/SampleCDL.ccc cc03345')
+ usage += '\n'
+ usage += 'Create a GUI-friendly ACES 1.0 config with an general LUT: \n'
+ usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
+ '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
+ '\n\t\t--addCustomLookLUT CustomLUTName "ACES - ACEScc" '
+ '/path/to/SampleCDL.ccc cc03345')
+ usage += '\n'
+ usage += ('\tIn this example, the LUT will be applied in the '
+ 'ACEScc colorspace, but the user could choose other spaces '
+ 'by changing the argument after the name of the look. \n')
+ usage += '\n'
+
+ look_info = []
+
+ def look_info_callback(option, opt_str, value, parser):
+ print('look_info_callback')
+ print(option, opt_str, value, parser)
+ if opt_str == '--addCustomLookCDL':
+ look_info.append(value)
+ elif opt_str == '--addCustomLookLUT':
+ look_info.append(value)
+ elif opt_str == '--addACESLookCDL':
+ look_info.append([value[0], 'ACES - ACEScc', value[1], value[2]])
+ elif opt_str == '--addACESLookLUT':
+ look_info.append([value[0], 'ACES - ACEScc', value[1]])
+
+ p = optparse.OptionParser(description='',
+ prog='create_aces_config',
+ version='create_aces_config 1.0',
+ usage=usage)
p.add_option('--acesCTLDir', '-a', default=os.environ.get(
ACES_OCIO_CTL_DIRECTORY_ENVIRON, None))
p.add_option('--configDir', '-c', default=os.environ.get(
ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON, None))
p.add_option('--lutResolution1d', default=4096)
p.add_option('--lutResolution3d', default=64)
- p.add_option('--dontBakeSecondaryLUTs', action='store_true')
- p.add_option('--keepTempImages', action='store_true')
+ p.add_option('--dontBakeSecondaryLUTs', action='store_true', default=False)
+ p.add_option('--keepTempImages', action='store_true', default=False)
+
+ p.add_option('--createMultipleDisplays', action='store_true',
+ default=False)
+
+ p.add_option('--addCustomLookLUT', '', type='string', nargs=3,
+ action='callback', callback=look_info_callback)
+ p.add_option('--addCustomLookCDL', '', type='string', nargs=4,
+ action='callback', callback=look_info_callback)
+ p.add_option('--addACESLookLUT', '', type='string', nargs=2,
+ action='callback', callback=look_info_callback)
+ p.add_option('--addACESLookCDL', '', type='string', nargs=3,
+ action='callback', callback=look_info_callback)
+ p.add_option('--copyCustomLUTs', action='store_true', default=False)
options, arguments = p.parse_args()
lut_resolution_3d = int(options.lutResolution3d)
bake_secondary_luts = not options.dontBakeSecondaryLUTs
cleanup_temp_images = not options.keepTempImages
+ multiple_displays = options.createMultipleDisplays
+ copy_custom_luts = options.copyCustomLUTs
- # TODO: Investigate the following statements.
- try:
- args_start = sys.argv.index('--') + 1
- args = sys.argv[args_start:]
- except:
- args_start = len(sys.argv) + 1
- args = []
+ print(look_info)
print('command line : \n%s\n' % ' '.join(sys.argv))
lut_resolution_1d,
lut_resolution_3d,
bake_secondary_luts,
+ multiple_displays,
+ look_info,
+ copy_custom_luts,
cleanup_temp_images)