aces_1.0.0/python/aces_ocio/generate_config.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 """
   5 Defines objects creating the *ACES* configuration.
   6 """
   7
   8 from __future__ import division
   9
  10 import copy
  11 import os
  12 import shutil
  13 import sys
  14
  15 import PyOpenColorIO as ocio
  16 from aces_ocio.colorspaces import aces
  17 from aces_ocio.colorspaces import arri
  18 from aces_ocio.colorspaces import canon
  19 from aces_ocio.colorspaces import general
  20 from aces_ocio.colorspaces import gopro
  21 from aces_ocio.colorspaces import panasonic
  22 from aces_ocio.colorspaces import red
  23 from aces_ocio.colorspaces import sony
  24 from aces_ocio.process import Process
  25
  26 from aces_ocio.utilities import (
  27     ColorSpace,
  28     colorspace_prefixed_name,
  29     compact,
  30     replace,
  31     unpack_default)
  32
  33 __author__ = 'ACES Developers'
  34 __copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
  35 __license__ = ''
  36 __maintainer__ = 'ACES Developers'
  37 __email__ = 'aces@oscars.org'
  38 __status__ = 'Production'
  39
  40 __all__ = ['ACES_OCIO_CTL_DIRECTORY_ENVIRON',
  41            'ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON',
  42            'set_config_roles',
  43            'create_ocio_transform',
  44            'add_colorspace_aliases',
  45            'add_look',
  46            'add_looks_to_views',
  47            'create_config',
  48            'create_config_data',
  49            'write_config',
  50            'generate_baked_LUTs',
  51            'generate_config_directory',
  52            'generate_config',
  53            'main']
  54
  55 ACES_OCIO_CTL_DIRECTORY_ENVIRON = 'ACES_OCIO_CTL_DIRECTORY'
  56 ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON = 'ACES_OCIO_CONFIGURATION_DIRECTORY'
  57
  58
  59 def set_config_roles(config,
  60                      color_picking=None,
  61                      color_timing=None,
  62                      compositing_log=None,
  63                      data=None,
  64                      default=None,
  65                      matte_paint=None,
  66                      reference=None,
  67                      scene_linear=None,
  68                      texture_paint=None,
  69                      rendering=None,
  70                      compositing_linear=None):
  71     """
  72     Sets given *OCIO* configuration roles to the config.
  73     Parameters
  74     ----------
  75     config : Config
  76         *OCIO* configuration.
  77     color_picking : str or unicode, optional
  78         Color picking role title.
  79     color_timing : str or unicode, optional
  80         Color timing role title.
  81     compositing_log : str or unicode, optional
  82         Compositing log role title.
  83     data : str or unicode, optional
  84         Data role title.
  85     default : str or unicode, optional
  86         Default role title.
  87     matte_paint : str or unicode, optional
  88         Matte painting role title.
  89     reference : str or unicode, optional
  90         Reference role title.
  91     scene_linear : str or unicode, optional
  92         Scene linear role title.
  93     texture_paint : str or unicode, optional
  94         Texture painting role title.
  95     Returns
  96     -------
  97     bool
  98          Definition success.
  99     """
 100
 101     if color_picking is not None:
 102         config.setRole(ocio.Constants.ROLE_COLOR_PICKING, color_picking)
 103     if color_timing is not None:
 104         config.setRole(ocio.Constants.ROLE_COLOR_TIMING, color_timing)
 105     if compositing_log is not None:
 106         config.setRole(ocio.Constants.ROLE_COMPOSITING_LOG, compositing_log)
 107     if data is not None:
 108         config.setRole(ocio.Constants.ROLE_DATA, data)
 109     if default is not None:
 110         config.setRole(ocio.Constants.ROLE_DEFAULT, default)
 111     if matte_paint is not None:
 112         config.setRole(ocio.Constants.ROLE_MATTE_PAINT, matte_paint)
 113     if reference is not None:
 114         config.setRole(ocio.Constants.ROLE_REFERENCE, reference)
 115     if texture_paint is not None:
 116         config.setRole(ocio.Constants.ROLE_TEXTURE_PAINT, texture_paint)
 117
 118     # *rendering* and *compositing_linear* roles default to the *scene_linear*
 119     # value if not set explicitly.
 120     if rendering is not None:
 121         config.setRole('rendering', rendering)
 122     if compositing_linear is not None:
 123         config.setRole('compositing_linear', compositing_linear)
 124     if scene_linear is not None:
 125         config.setRole(ocio.Constants.ROLE_SCENE_LINEAR, scene_linear)
 126         if rendering is None:
 127             config.setRole('rendering', scene_linear)
 128         if compositing_linear is None:
 129             config.setRole('compositing_linear', scene_linear)
 130
 131     return True
 132
 133
 134 def create_ocio_transform(transforms):
 135     """
 136     Returns an *OCIO* transform from given array of transform descriptions.
 137
 138     Parameters
 139     ----------
 140     transforms : array_like
 141         Transform descriptions as an array_like of dicts:
 142         {'type', 'src', 'dst', 'direction'}
 143
 144     Returns
 145     -------
 146     Transform
 147          *OCIO* transform.
 148     """
 149
 150     direction_options = {
 151         'forward': ocio.Constants.TRANSFORM_DIR_FORWARD,
 152         'inverse': ocio.Constants.TRANSFORM_DIR_INVERSE}
 153
 154     ocio_transforms = []
 155
 156     for transform in transforms:
 157
 158         # *lutFile* transform
 159         if transform['type'] == 'lutFile':
 160             ocio_transform = ocio.FileTransform()
 161
 162             if 'path' in transform:
 163                 ocio_transform.setSrc(transform['path'])
 164
 165             if 'cccid' in transform:
 166                 ocio_transform.setCCCId(transform['cccid'])
 167
 168             if 'interpolation' in transform:
 169                 ocio_transform.setInterpolation(transform['interpolation'])
 170             else:
 171                 ocio_transform.setInterpolation(ocio.Constants.INTERP_BEST)
 172
 173             if 'direction' in transform:
 174                 ocio_transform.setDirection(
 175                     direction_options[transform['direction']])
 176
 177             ocio_transforms.append(ocio_transform)
 178
 179         # *matrix* transform
 180         elif transform['type'] == 'matrix':
 181             ocio_transform = ocio.MatrixTransform()
 182             # `MatrixTransform` member variables can't be initialized directly,
 183             # each must be set individually.
 184             ocio_transform.setMatrix(transform['matrix'])
 185
 186             if 'offset' in transform:
 187                 ocio_transform.setOffset(transform['offset'])
 188
 189             if 'direction' in transform:
 190                 ocio_transform.setDirection(
 191                     direction_options[transform['direction']])
 192
 193             ocio_transforms.append(ocio_transform)
 194
 195         # *exponent* transform
 196         elif transform['type'] == 'exponent':
 197             ocio_transform = ocio.ExponentTransform()
 198
 199             if 'value' in transform:
 200                 ocio_transform.setValue(transform['value'])
 201
 202             ocio_transforms.append(ocio_transform)
 203
 204         # *log* transform
 205         elif transform['type'] == 'log':
 206             ocio_transform = ocio.LogTransform()
 207
 208             if 'base' in transform:
 209                 ocio_transform.setBase(transform['base'])
 210
 211             if 'direction' in transform:
 212                 ocio_transform.setDirection(
 213                     direction_options[transform['direction']])
 214
 215             ocio_transforms.append(ocio_transform)
 216
 217         # *colorspace* transform
 218         elif transform['type'] == 'colorspace':
 219             ocio_transform = ocio.ColorSpaceTransform()
 220
 221             if 'src' in transform:
 222                 ocio_transform.setSrc(transform['src'])
 223
 224             if 'dst' in transform:
 225                 ocio_transform.setDst(transform['dst'])
 226
 227             if 'direction' in transform:
 228                 ocio_transform.setDirection(
 229                     direction_options[transform['direction']])
 230
 231             ocio_transforms.append(ocio_transform)
 232
 233         # *look* transform
 234         elif transform['type'] == 'look':
 235             ocio_transform = ocio.LookTransform()
 236             if 'look' in transform:
 237                 ocio_transform.setLooks(transform['look'])
 238
 239             if 'src' in transform:
 240                 ocio_transform.setSrc(transform['src'])
 241
 242             if 'dst' in transform:
 243                 ocio_transform.setDst(transform['dst'])
 244
 245             if 'direction' in transform:
 246                 ocio_transform.setDirection(
 247                     direction_options[transform['direction']])
 248
 249             ocio_transforms.append(ocio_transform)
 250
 251         # *unknown* type
 252         else:
 253             print('Ignoring unknown transform type : %s' % transform['type'])
 254
 255     if len(ocio_transforms) > 1:
 256         group_transform = ocio.GroupTransform()
 257         for transform in ocio_transforms:
 258             group_transform.push_back(transform)
 259         transform = group_transform
 260     else:
 261         transform = ocio_transforms[0]
 262
 263     return transform
 264
 265
 266 def add_colorspace_aliases(config,
 267                            reference_colorspace,
 268                            colorspace,
 269                            colorspace_alias_names,
 270                            family='Aliases'):
 271     """
 272     Adds given colorspace aliases to the *OCIO* config.
 273
 274     Parameters
 275     ----------
 276     config : Config
 277         *OCIO* configuration.
 278     reference_colorspace : Colorspace
 279         Reference colorspace.
 280     colorspace : Colorspace
 281         Colorspace to set the aliases into the *OCIO* config.
 282     family : unicode
 283         Family.
 284
 285     Returns
 286     -------
 287     bool
 288         Definition success.
 289     """
 290
 291     for alias_name in colorspace_alias_names:
 292         if alias_name.lower() == colorspace.name.lower():
 293             print('Skipping alias creation for %s, alias %s, '
 294                   'because lower cased names match' % (
 295                       colorspace.name, alias_name))
 296             continue
 297
 298         print('Adding alias colorspace space %s, alias to %s' % (
 299             alias_name, colorspace.name))
 300
 301         compact_family_name = family
 302
 303         description = colorspace.description
 304         if colorspace.aces_transform_id:
 305             description += (
 306                 '\n\nACES Transform ID : %s' % colorspace.aces_transform_id)
 307
 308         ocio_colorspace_alias = ocio.ColorSpace(
 309             name=alias_name,
 310             bitDepth=colorspace.bit_depth,
 311             description=description,
 312             equalityGroup=colorspace.equality_group,
 313             family=compact_family_name,
 314             isData=colorspace.is_data,
 315             allocation=colorspace.allocation_type,
 316             allocationVars=colorspace.allocation_vars)
 317
 318         if colorspace.to_reference_transforms:
 319             print('\tGenerating To-Reference transforms')
 320             ocio_transform = create_ocio_transform(
 321                 [{'type': 'colorspace',
 322                   'src': colorspace.name,
 323                   'dst': reference_colorspace.name,
 324                   'direction': 'forward'}])
 325             ocio_colorspace_alias.setTransform(
 326                 ocio_transform,
 327                 ocio.Constants.COLORSPACE_DIR_TO_REFERENCE)
 328
 329         if colorspace.from_reference_transforms:
 330             print('\tGenerating From-Reference transforms')
 331             ocio_transform = create_ocio_transform(
 332                 [{'type': 'colorspace',
 333                   'src': reference_colorspace.name,
 334                   'dst': colorspace.name,
 335                   'direction': 'forward'}])
 336             ocio_colorspace_alias.setTransform(
 337                 ocio_transform,
 338                 ocio.Constants.COLORSPACE_DIR_FROM_REFERENCE)
 339
 340         config.addColorSpace(ocio_colorspace_alias)
 341
 342
 343 def add_look(config,
 344              look,
 345              custom_lut_dir,
 346              reference_name,
 347              config_data):
 348     """
 349     Adds given look to the *OCIO* config.
 350
 351     Parameters
 352     ----------
 353     config : Config
 354         *OCIO* configuration.
 355     look : array_like
 356         Look description: {'name', 'colorspace', 'lut', 'cccid'}
 357     custom_lut_dir : str or unicode
 358         Directory to copy the look lut into.
 359     reference_name : str or unicode
 360         Reference name.
 361     config_data : dict
 362         Colorspaces and transforms converting between those colorspaces and
 363         the reference colorspace, *ACES*.
 364
 365     Returns
 366     -------
 367     bool
 368         Definition success.
 369     """
 370
 371     look_name, look_colorspace, look_lut, look_cccid = unpack_default(look, 4)
 372
 373     print('Adding look %s - %s' % (look_name, ', '.join(look)))
 374
 375     # Copy *look LUT* if `custom_lut_dir` is provided.
 376     if custom_lut_dir:
 377         if '$' not in look_lut:
 378             print('Getting ready to copy look lut : %s' % look_lut)
 379             shutil.copy2(look_lut, custom_lut_dir)
 380             look_lut = os.path.split(look_lut)[1]
 381         else:
 382             print('Skipping LUT copy because path contains a context variable')
 383
 384     print('Adding look to config')
 385     ocio_look = ocio.Look()
 386     ocio_look.setName(look_name)
 387     ocio_look.setProcessSpace(look_colorspace)
 388
 389     keys = {'type': 'lutFile',
 390             'path': look_lut,
 391             'direction': 'forward'}
 392     if look_cccid:
 393         keys['cccid'] = look_cccid
 394
 395     ocio_transform = create_ocio_transform([keys])
 396     ocio_look.setTransform(ocio_transform)
 397
 398     config.addLook(ocio_look)
 399
 400     print('Creating aliased colorspace')
 401
 402     # Creating *OCIO* colorspace referencing the look:
 403     # - Needed for implementations that don't process looks properly.
 404     # - Needed for implementations that don't expose looks properly.
 405     look_aliases = ['look_%s' % compact(look_name)]
 406     colorspace = ColorSpace(look_name,
 407                             aliases=look_aliases,
 408                             description='The %s Look colorspace' % look_name,
 409                             family='Look')
 410
 411     colorspace.from_reference_transforms = [{'type': 'look',
 412                                              'look': look_name,
 413                                              'src': reference_name,
 414                                              'dst': reference_name,
 415                                              'direction': 'forward'}]
 416
 417     print('Adding colorspace %s, alias to look %s to config data' % (
 418         look_name, look_name))
 419
 420     config_data['colorSpaces'].append(colorspace)
 421
 422     print('')
 423
 424
 425 def add_looks_to_views(looks,
 426                        reference_name,
 427                        config_data,
 428                        multiple_displays=False):
 429     """
 430     Object description.
 431
 432     Parameters
 433     ----------
 434     parameter : type
 435         Parameter description.
 436
 437     Returns
 438     -------
 439     type
 440          Return value description.
 441     """
 442     look_names = [look[0] for look in looks]
 443
 444     # Option 1
 445     # - Adding a *look* per *Display*.
 446     # - Assuming there is a *Display* for each *ACES* *Output Transform*.
 447     if multiple_displays:
 448         for look_name in look_names:
 449             config_data['looks'].append(look_name)
 450
 451     # Option 2
 452     # - Copy each *Output Transform* colorspace.
 453     # - For each copy, add a *LookTransform* to the head of the
 454     # `from_reference` transform list.
 455     # - Add these the copy colorspaces for the *Displays* / *Views*.
 456     else:
 457         for display, view_list in config_data['displays'].iteritems():
 458             colorspace_c = None
 459             look_names_string = ''
 460             for view_name, output_colorspace in view_list.iteritems():
 461                 if view_name == 'Output Transform':
 462
 463                     print('Adding new View that incorporates looks')
 464
 465                     colorspace_c = copy.deepcopy(output_colorspace)
 466
 467                     for i, look_name in enumerate(look_names):
 468                         look_name = look_names[i]
 469
 470                         # Add the `LookTransform` to the head of the
 471                         # `from_reference` transform list.
 472                         if colorspace_c.from_reference_transforms:
 473                             colorspace_c.from_reference_transforms.insert(
 474                                 i,
 475                                 {'type': 'look',
 476                                  'look': look_name,
 477                                  'src': reference_name,
 478                                  'dst': reference_name,
 479                                  'direction': 'forward'})
 480
 481                         # Add the `LookTransform` to the end of
 482                         # the `to_reference` transform list.
 483                         if colorspace_c.to_reference_transforms:
 484                             inverse_look_name = look_names[
 485                                 len(look_names) - 1 - i]
 486
 487                             colorspace_c.to_reference_transforms.append(
 488                                 {'type': 'look',
 489                                  'look': inverse_look_name,
 490                                  'src': reference_name,
 491                                  'dst': reference_name,
 492                                  'direction': 'inverse'})
 493
 494                         if look_name not in config_data['looks']:
 495                             config_data['looks'].append(look_name)
 496
 497                     look_names_string = ', '.join(look_names)
 498                     colorspace_c.name = '%s with %s' % (
 499                         output_colorspace.name, look_names_string)
 500                     colorspace_c.aliases = [
 501                         'out_%s' % compact(colorspace_c.name)]
 502
 503                     print('Colorspace that incorporates looks '
 504                           'created : %s' % colorspace_c.name)
 505
 506                     config_data['colorSpaces'].append(colorspace_c)
 507
 508             if colorspace_c:
 509                 print('Adding colorspace that incorporates looks '
 510                       'into view list')
 511
 512                 # Updating the *View* name.
 513                 view_list['Output Transform with %s' % look_names_string] = (
 514                     colorspace_c)
 515                 config_data['displays'][display] = view_list
 516
 517
 518 def create_config(config_data,
 519                   aliases=False,
 520                   prefix=False,
 521                   multiple_displays=False,
 522                   look_info=None,
 523                   custom_lut_dir=None):
 524     """
 525     Object description.
 526
 527     Parameters
 528     ----------
 529     parameter : type
 530         Parameter description.
 531
 532     Returns
 533     -------
 534     type
 535          Return value description.
 536     """
 537
 538     if look_info is None:
 539         look_info = []
 540
 541     prefixed_names = {}
 542     alias_colorspaces = []
 543
 544     config = ocio.Config()
 545
 546     config.setDescription('An ACES config generated from python')
 547
 548     search_path = ['luts']
 549     if custom_lut_dir:
 550         search_path.append('custom')
 551     config.setSearchPath(':'.join(search_path))
 552
 553     reference_data = config_data['referenceColorSpace']
 554
 555     # Adding the colorspace *Family* into the name which helps with
 556     # applications that presenting colorspaces as one a flat list.
 557     if prefix:
 558         prefixed_name = colorspace_prefixed_name(reference_data)
 559         prefixed_names[reference_data.name] = prefixed_name
 560         reference_data.name = prefixed_name
 561
 562     print('Adding the reference color space : %s' % reference_data.name)
 563
 564     reference = ocio.ColorSpace(
 565         name=reference_data.name,
 566         bitDepth=reference_data.bit_depth,
 567         description=reference_data.description,
 568         equalityGroup=reference_data.equality_group,
 569         family=reference_data.family,
 570         isData=reference_data.is_data,
 571         allocation=reference_data.allocation_type,
 572         allocationVars=reference_data.allocation_vars)
 573
 574     config.addColorSpace(reference)
 575
 576     if aliases:
 577         if reference_data.aliases:
 578             # Deferring adding alias colorspaces until end, which helps with
 579             # applications listing the colorspaces in the order that they were
 580             # defined in the configuration: alias colorspaces are usually named
 581             # lower case with spaces but normal colorspaces names are longer
 582             # and more verbose, thus it becomes harder for user to visually
 583             # parse the list of colorspaces when there are names such as
 584             # "crv_canonlog" interspersed with names like
 585             # "Input - Canon - Curve - Canon-Log".
 586             # Moving the alias colorspace definitions to the end of the
 587             # configuration avoids the above problem.
 588             alias_colorspaces.append(
 589                 [reference_data, reference_data, reference_data.aliases])
 590
 591     print('')
 592
 593     if look_info:
 594         print('Adding looks')
 595
 596         config_data['looks'] = []
 597
 598         for look in look_info:
 599             add_look(config,
 600                      look,
 601                      custom_lut_dir,
 602                      reference_data.name,
 603                      config_data)
 604
 605         add_looks_to_views(look_info,
 606                            reference_data.name,
 607                            config_data,
 608                            multiple_displays)
 609
 610         print('')
 611
 612     print('Adding regular colorspaces')
 613
 614     for colorspace in sorted(config_data['colorSpaces'],
 615         cmp=lambda x,y: cmp(x.family.lower(), y.family.lower())):
 616         # Adding the colorspace *Family* into the name which helps with
 617         # applications that presenting colorspaces as one a flat list.
 618         if prefix:
 619             prefixed_name = colorspace_prefixed_name(colorspace)
 620             prefixed_names[colorspace.name] = prefixed_name
 621             colorspace.name = prefixed_name
 622
 623         print('Creating new color space : %s' % colorspace.name)
 624
 625         description = colorspace.description
 626         if colorspace.aces_transform_id:
 627             description += (
 628                 '\n\nACES Transform ID : %s' % colorspace.aces_transform_id)
 629
 630         ocio_colorspace = ocio.ColorSpace(
 631             name=colorspace.name,
 632             bitDepth=colorspace.bit_depth,
 633             description=description,
 634             equalityGroup=colorspace.equality_group,
 635             family=colorspace.family,
 636             isData=colorspace.is_data,
 637             allocation=colorspace.allocation_type,
 638             allocationVars=colorspace.allocation_vars)
 639
 640         if colorspace.to_reference_transforms:
 641             print('\tGenerating To-Reference transforms')
 642             ocio_transform = create_ocio_transform(
 643                 colorspace.to_reference_transforms)
 644             ocio_colorspace.setTransform(
 645                 ocio_transform,
 646                 ocio.Constants.COLORSPACE_DIR_TO_REFERENCE)
 647
 648         if colorspace.from_reference_transforms:
 649             print('\tGenerating From-Reference transforms')
 650             ocio_transform = create_ocio_transform(
 651                 colorspace.from_reference_transforms)
 652             ocio_colorspace.setTransform(
 653                 ocio_transform,
 654                 ocio.Constants.COLORSPACE_DIR_FROM_REFERENCE)
 655
 656         config.addColorSpace(ocio_colorspace)
 657
 658         if aliases:
 659             if colorspace.aliases:
 660                 # Deferring adding alias colorspaces until end, which helps
 661                 # with applications listing the colorspaces in the order that
 662                 # they were defined in the configuration.
 663                 alias_colorspaces.append(
 664                     [reference_data, colorspace, colorspace.aliases])
 665
 666         print('')
 667
 668     print('')
 669
 670     # Adding roles early so that alias colorspaces can be created
 671     # with roles names before remaining colorspace aliases are added
 672     # to the configuration.
 673     print('Setting the roles')
 674
 675     if prefix:
 676         set_config_roles(
 677             config,
 678             color_picking=prefixed_names[
 679                 config_data['roles']['color_picking']],
 680             color_timing=prefixed_names[config_data['roles']['color_timing']],
 681             compositing_log=prefixed_names[
 682                 config_data['roles']['compositing_log']],
 683             data=prefixed_names[config_data['roles']['data']],
 684             default=prefixed_names[config_data['roles']['default']],
 685             matte_paint=prefixed_names[config_data['roles']['matte_paint']],
 686             reference=prefixed_names[config_data['roles']['reference']],
 687             scene_linear=prefixed_names[config_data['roles']['scene_linear']],
 688             texture_paint=prefixed_names[
 689                 config_data['roles']['texture_paint']])
 690
 691         # TODO: Pending code path reactivation.
 692         # Not allowed at the moment as role names can not overlap
 693         # with colorspace names.
 694         """
 695         # Add the aliased colorspaces for each role
 696         for role_name, role_colorspace_name in config_data['roles'].iteritems():
 697             role_colorspace_prefixed_name = prefixed_names[role_colorspace_name]
 698
 699             print( 'Finding colorspace : %s' % role_colorspace_prefixed_name )
 700             # Find the colorspace pointed to by the role
 701             role_colorspaces = [colorspace
 702                 for colorspace in config_data['colorSpaces']
 703                 if colorspace.name == role_colorspace_prefixed_name]
 704             role_colorspace = None
 705             if len(role_colorspaces) > 0:
 706                 role_colorspace = role_colorspaces[0]
 707             else:
 708                 if reference_data.name == role_colorspace_prefixed_name:
 709                     role_colorspace = reference_data
 710
 711             if role_colorspace:
 712                 print( 'Adding an alias colorspace named %s, pointing to %s' % (
 713                     role_name, role_colorspace.name))
 714
 715                 add_colorspace_aliases(
 716                 config, reference_data, role_colorspace, [role_name], 'Roles')
 717         """
 718
 719     else:
 720         set_config_roles(
 721             config,
 722             color_picking=config_data['roles']['color_picking'],
 723             color_timing=config_data['roles']['color_timing'],
 724             compositing_log=config_data['roles']['compositing_log'],
 725             data=config_data['roles']['data'],
 726             default=config_data['roles']['default'],
 727             matte_paint=config_data['roles']['matte_paint'],
 728             reference=config_data['roles']['reference'],
 729             scene_linear=config_data['roles']['scene_linear'],
 730             texture_paint=config_data['roles']['texture_paint'])
 731
 732         # TODO: Pending code path reactivation.
 733         # Not allowed at the moment as role names can not overlap
 734         # with colorspace names.
 735         """
 736         # Add the aliased colorspaces for each role
 737         for role_name, role_colorspace_name in config_data['roles'].iteritems():
 738             # Find the colorspace pointed to by the role
 739             role_colorspaces = [colorspace
 740             for colorspace in config_data['colorSpaces']
 741             if colorspace.name == role_colorspace_name]
 742             role_colorspace = None
 743             if len(role_colorspaces) > 0:
 744                 role_colorspace = role_colorspaces[0]
 745             else:
 746                 if reference_data.name == role_colorspace_name:
 747                     role_colorspace = reference_data
 748
 749             if role_colorspace:
 750                 print('Adding an alias colorspace named %s, pointing to %s' % (
 751                     role_name, role_colorspace.name))
 752
 753                 add_colorspace_aliases(
 754                 config, reference_data, role_colorspace, [role_name], 'Roles')
 755         """
 756
 757     print('')
 758
 759     # Adding alias colorspaces at the end as some applications use
 760     # colorspaces definitions order of the configuration to order
 761     # the colorspaces in their selection lists, some applications
 762     # use alphabetical ordering.
 763     # This should keep the alias colorspaces out of the way for applications
 764     # using the configuration order.
 765     print('Adding the alias colorspaces')
 766     for reference, colorspace, aliases in alias_colorspaces:
 767         add_colorspace_aliases(config, reference, colorspace, aliases)
 768
 769     print('')
 770
 771     print('Adding the diplays and views')
 772
 773     # Setting the *color_picking* role to be the first *Display*'s
 774     # *Output Transform* *View*.
 775     default_display_name = config_data['defaultDisplay']
 776     default_display_views = config_data['displays'][default_display_name]
 777     default_display_colorspace = default_display_views['Output Transform']
 778
 779     set_config_roles(
 780         config,
 781         color_picking=default_display_colorspace.name)
 782
 783     # Defining *Displays* and *Views*.
 784     displays, views = [], []
 785
 786     # Defining a generic *Display* and *View* setup.
 787     if multiple_displays:
 788         looks = config_data['looks'] if ('looks' in config_data) else []
 789         looks = ', '.join(looks)
 790         print('Creating multiple displays, with looks : %s' % looks)
 791
 792         # *Displays* are not reordered to put the *defaultDisplay* first
 793         # because *OCIO* will order them alphabetically when the configuration
 794         # is written to disk.
 795         for display, view_list in config_data['displays'].iteritems():
 796             for view_name, colorspace in view_list.iteritems():
 797                 config.addDisplay(display, view_name, colorspace.name, looks)
 798                 if 'Output Transform' in view_name and looks != '':
 799                     # *Views* without *Looks*.
 800                     config.addDisplay(display, view_name, colorspace.name)
 801
 802                     # *Views* with *Looks*.
 803                     view_name_with_looks = '%s with %s' % (view_name, looks)
 804                     config.addDisplay(display, view_name_with_looks,
 805                                       colorspace.name, looks)
 806                 else:
 807                     config.addDisplay(display, view_name, colorspace.name)
 808                 if not (view_name in views):
 809                     views.append(view_name)
 810             displays.append(display)
 811
 812     # *Displays* and *Views* useful in a *GUI* context.
 813     else:
 814         single_display_name = 'ACES'
 815         displays.append(single_display_name)
 816
 817         # Ensuring the *defaultDisplay* is first.
 818         display_names = sorted(config_data['displays'])
 819         display_names.insert(0, display_names.pop(
 820             display_names.index(default_display_name)))
 821
 822         looks = config_data['looks'] if ('looks' in config_data) else []
 823         look_names = ', '.join(looks)
 824
 825         displays_views_colorspaces = []
 826
 827         for display in display_names:
 828             view_list = config_data['displays'][display]
 829             for view_name, colorspace in view_list.iteritems():
 830                 if 'Output Transform' in view_name:
 831
 832                     # We use the *Display* names as the *View* names in this
 833                     # case as there is a single *Display* containing all the
 834                     # *Views*.
 835                     # This works for more applications than not,as of the time
 836                     # of this implementation.
 837
 838                     # Autodesk Maya 2016 doesn't support parentheses in
 839                     # *View* names.
 840                     sanitised_display = replace(display, {')': '', '(': ''})
 841
 842                     # *View* with *Looks*.
 843                     if 'with' in view_name:
 844                         sanitised_display = '%s with %s' % (
 845                             sanitised_display, look_names)
 846
 847                         views_with_looks_at_end = False
 848                         # Storing combo of *Display*, *View* and *Colorspace*
 849                         # name so they can be added to the end of the list.
 850                         if views_with_looks_at_end:
 851                             displays_views_colorspaces.append(
 852                                 [single_display_name, sanitised_display,
 853                                  colorspace.name])
 854                         else:
 855                             config.addDisplay(single_display_name,
 856                                               sanitised_display,
 857                                               colorspace.name)
 858
 859                             if not (sanitised_display in views):
 860                                 views.append(sanitised_display)
 861
 862                     # *View* without *Looks*.
 863                     else:
 864                         config.addDisplay(single_display_name,
 865                                           sanitised_display,
 866                                           colorspace.name)
 867
 868                         if not (sanitised_display in views):
 869                             views.append(sanitised_display)
 870
 871         # Adding to the configuration any *Display*, *View* combinations that
 872         # were saved for later.
 873         # This list should be empty unless `views_with_looks_at_end` is
 874         # set `True` above.
 875         for display_view_colorspace in displays_views_colorspaces:
 876             single_display_name, sanitised_display, colorspace_name = (
 877                 display_view_colorspace)
 878
 879             config.addDisplay(single_display_name,
 880                               sanitised_display,
 881                               colorspace_name)
 882
 883             if not (sanitised_display in views):
 884                 views.append(sanitised_display)
 885
 886         raw_display_space_name = config_data['roles']['data']
 887         log_display_space_name = config_data['roles']['compositing_log']
 888
 889         if prefix:
 890             raw_display_space_name = prefixed_names[raw_display_space_name]
 891             log_display_space_name = prefixed_names[log_display_space_name]
 892
 893         config.addDisplay(single_display_name, 'Raw', raw_display_space_name)
 894         views.append('Raw')
 895         config.addDisplay(single_display_name, 'Log', log_display_space_name)
 896         views.append('Log')
 897
 898     config.setActiveDisplays(','.join(sorted(displays)))
 899     config.setActiveViews(','.join(views))
 900
 901     print('')
 902
 903     # Ensuring the configuration is valid.
 904     config.sanityCheck()
 905
 906     # Resetting colorspace names to their non-prefixed versions.
 907     if prefix:
 908         prefixed_names_inverse = {}
 909         for original, prefixed in prefixed_names.iteritems():
 910             prefixed_names_inverse[prefixed] = original
 911
 912         reference_data.name = prefixed_names_inverse[reference_data.name]
 913
 914         try:
 915             for colorspace in config_data['colorSpaces']:
 916                 colorspace.name = prefixed_names_inverse[colorspace.name]
 917         except:
 918             print('Prefixed names')
 919             for original, prefixed in prefixed_names.iteritems():
 920                 print('%s, %s' % (original, prefixed))
 921
 922             print('\n')
 923
 924             print('Inverse Lookup of Prefixed names')
 925             for prefixed, original in prefixed_names_inverse.iteritems():
 926                 print('%s, %s' % (prefixed, original))
 927             raise
 928
 929     return config
 930
 931
 932 def create_config_data(odt_info,
 933                        lmt_info,
 934                        shaper_name,
 935                        aces_ctl_directory,
 936                        lut_directory,
 937                        lut_resolution_1d=4096,
 938                        lut_resolution_3d=64,
 939                        cleanup=True):
 940     """
 941     Object description.
 942
 943     Parameters
 944     ----------
 945     parameter : type
 946         Parameter description.
 947
 948     Returns
 949     -------
 950     dict
 951          Colorspaces and transforms converting between those colorspaces and
 952          the reference colorspace, *ACES*.
 953     """
 954
 955     print('create_config_data - begin')
 956     config_data = {}
 957
 958     config_data['displays'] = {}
 959     config_data['colorSpaces'] = []
 960
 961     # -------------------------------------------------------------------------
 962     # *ACES Color Spaces*
 963     # -------------------------------------------------------------------------
 964
 965     # *ACES* colorspaces
 966     (aces_reference,
 967      aces_colorspaces,
 968      aces_displays,
 969      aces_log_display_space,
 970      aces_roles,
 971      aces_default_display) = aces.create_colorspaces(aces_ctl_directory,
 972                                                      lut_directory,
 973                                                      lut_resolution_1d,
 974                                                      lut_resolution_3d,
 975                                                      lmt_info,
 976                                                      odt_info,
 977                                                      shaper_name,
 978                                                      cleanup)
 979
 980     config_data['referenceColorSpace'] = aces_reference
 981     config_data['roles'] = aces_roles
 982
 983     for cs in aces_colorspaces:
 984         config_data['colorSpaces'].append(cs)
 985
 986     for name, data in aces_displays.iteritems():
 987         config_data['displays'][name] = data
 988
 989     config_data['defaultDisplay'] = aces_default_display
 990     config_data['linearDisplaySpace'] = aces_reference
 991     config_data['logDisplaySpace'] = aces_log_display_space
 992
 993     # -------------------------------------------------------------------------
 994     # *Camera Input Transforms*
 995     # -------------------------------------------------------------------------
 996
 997     # *ARRI Log-C* to *ACES*
 998     arri_colorspaces = arri.create_colorspaces(lut_directory,
 999                                                lut_resolution_1d)
1000     for cs in arri_colorspaces:
1001         config_data['colorSpaces'].append(cs)
1002
1003     # *Canon-Log* to *ACES*
1004     canon_colorspaces = canon.create_colorspaces(lut_directory,
1005                                                  lut_resolution_1d)
1006     for cs in canon_colorspaces:
1007         config_data['colorSpaces'].append(cs)
1008
1009     # *GoPro Protune* to *ACES*
1010     gopro_colorspaces = gopro.create_colorspaces(lut_directory,
1011                                                  lut_resolution_1d)
1012     for cs in gopro_colorspaces:
1013         config_data['colorSpaces'].append(cs)
1014
1015     # *Panasonic V-Log* to *ACES*
1016     panasonic_colorspaces = panasonic.create_colorspaces(lut_directory,
1017                                                          lut_resolution_1d)
1018     for cs in panasonic_colorspaces:
1019         config_data['colorSpaces'].append(cs)
1020
1021     # *RED* colorspaces to *ACES*
1022     red_colorspaces = red.create_colorspaces(lut_directory,
1023                                              lut_resolution_1d)
1024     for cs in red_colorspaces:
1025         config_data['colorSpaces'].append(cs)
1026
1027     # *S-Log* to *ACES*
1028     sony_colorspaces = sony.create_colorspaces(lut_directory,
1029                                                lut_resolution_1d)
1030     for cs in sony_colorspaces:
1031         config_data['colorSpaces'].append(cs)
1032
1033     # -------------------------------------------------------------------------
1034     # General Colorspaces
1035     # -------------------------------------------------------------------------
1036     general_colorspaces = general.create_colorspaces(lut_directory,
1037                                                      lut_resolution_1d)
1038     for cs in general_colorspaces:
1039         config_data['colorSpaces'].append(cs)
1040
1041     # The *Raw* colorspace
1042     raw = general.create_raw()
1043     config_data['colorSpaces'].append(raw)
1044
1045     # Overriding various roles
1046     config_data['roles']['data'] = raw.name
1047     config_data['roles']['reference'] = raw.name
1048     config_data['roles']['texture_paint'] = raw.name
1049
1050     print('create_config_data - end')
1051
1052     return config_data
1053
1054
1055 def write_config(config, config_path, sanity_check=True):
1056     """
1057     Writes the configuration to given path.
1058
1059     Parameters
1060     ----------
1061     config : Config
1062         *OCIO* configuration.
1063     config_path : str or unicode
1064         Path to write the configuration path.
1065     sanity_check : bool
1066         Performs configuration sanity checking prior to writing it on disk.
1067
1068     Returns
1069     -------
1070     bool
1071          Definition success.
1072     """
1073
1074     if sanity_check:
1075         try:
1076             config.sanityCheck()
1077         except Exception, e:
1078             print e
1079             print 'Configuration was not written due to a failed Sanity Check'
1080             return
1081
1082     with open(config_path, mode='w') as fp:
1083         fp.write(config.serialize())
1084
1085
1086 def generate_baked_LUTs(odt_info,
1087                         shaper_name,
1088                         baked_directory,
1089                         config_path,
1090                         lut_resolution_3d,
1091                         lut_resolution_shaper=1024,
1092                         prefix=False):
1093     """
1094     Object description.
1095
1096     Parameters
1097     ----------
1098     parameter : type
1099         Parameter description.
1100
1101     Returns
1102     -------
1103     type
1104          Return value description.
1105     """
1106
1107     odt_info_C = dict(odt_info)
1108
1109     # Older behavior for *ODTs* that have support for full and legal ranges,
1110     # generating a LUT for both ranges.
1111     """
1112     # Create two entries for ODTs that have full and legal range support
1113     for odt_ctl_name, odt_values in odt_info.iteritems():
1114         if odt_values['transformHasFullLegalSwitch']:
1115             odt_name = odt_values['transformUserName']
1116
1117             odt_values_legal = dict(odt_values)
1118             odt_values_legal['transformUserName'] = '%s - Legal' % odt_name
1119             odt_info_C['%s - Legal' % odt_ctl_name] = odt_values_legal
1120
1121             odt_values_full = dict(odt_values)
1122             odt_values_full['transformUserName'] = '%s - Full' % odt_name
1123             odt_info_C['%s - Full' % odt_ctl_name] = odt_values_full
1124
1125             del (odt_info_C[odt_ctl_name])
1126     """
1127
1128     for odt_ctl_name, odt_values in odt_info_C.iteritems():
1129         odt_prefix = odt_values['transformUserNamePrefix']
1130         odt_name = odt_values['transformUserName']
1131
1132         # *Photoshop*
1133         for input_space in ['ACEScc', 'ACESproxy']:
1134             args = ['--iconfig', config_path,
1135                     '-v']
1136             if prefix:
1137                 args += ['--inputspace', 'ACES - %s' % input_space]
1138                 args += ['--outputspace', 'Output - %s' % odt_name]
1139             else:
1140                 args += ['--inputspace', input_space]
1141                 args += ['--outputspace', odt_name]
1142
1143             args += ['--description',
1144                      '%s - %s for %s data' % (odt_prefix,
1145                                               odt_name,
1146                                               input_space)]
1147             if prefix:
1148                 args += ['--shaperspace', 'Utility - %s' % shaper_name,
1149                          '--shapersize', str(lut_resolution_shaper)]
1150             else:
1151                 args += ['--shaperspace', shaper_name,
1152                          '--shapersize', str(lut_resolution_shaper)]
1153             args += ['--cubesize', str(lut_resolution_3d)]
1154             args += ['--format',
1155                      'icc',
1156                      os.path.join(baked_directory,
1157                                   'photoshop',
1158                                   '%s for %s.icc' % (odt_name, input_space))]
1159
1160             bake_lut = Process(description='bake a LUT',
1161                                cmd='ociobakelut',
1162                                args=args)
1163             bake_lut.execute()
1164
1165         # *Flame*, *Lustre*
1166         for input_space in ['ACEScc', 'ACESproxy']:
1167             args = ['--iconfig', config_path,
1168                     '-v']
1169             if prefix:
1170                 args += ['--inputspace', 'ACES - %s' % input_space]
1171                 args += ['--outputspace', 'Output - %s' % odt_name]
1172             else:
1173                 args += ['--inputspace', input_space]
1174                 args += ['--outputspace', odt_name]
1175             args += ['--description',
1176                      '%s - %s for %s data' % (
1177                          odt_prefix, odt_name, input_space)]
1178             if prefix:
1179                 args += ['--shaperspace', 'Utility - %s' % shaper_name,
1180                          '--shapersize', str(lut_resolution_shaper)]
1181             else:
1182                 args += ['--shaperspace', shaper_name,
1183                          '--shapersize', str(lut_resolution_shaper)]
1184             args += ['--cubesize', str(lut_resolution_3d)]
1185
1186             fargs = ['--format',
1187                      'flame',
1188                      os.path.join(
1189                          baked_directory,
1190                          'flame',
1191                          '%s for %s Flame.3dl' % (odt_name, input_space))]
1192             bake_lut = Process(description='bake a LUT',
1193                                cmd='ociobakelut',
1194                                args=(args + fargs))
1195             bake_lut.execute()
1196
1197             largs = ['--format',
1198                      'lustre',
1199                      os.path.join(
1200                          baked_directory,
1201                          'lustre',
1202                          '%s for %s Lustre.3dl' % (odt_name, input_space))]
1203             bake_lut = Process(description='bake a LUT',
1204                                cmd='ociobakelut',
1205                                args=(args + largs))
1206             bake_lut.execute()
1207
1208         # *Maya*, *Houdini*
1209         for input_space in ['ACEScg', 'ACES2065-1']:
1210             args = ['--iconfig', config_path,
1211                     '-v']
1212             if prefix:
1213                 args += ['--inputspace', 'ACES - %s' % input_space]
1214                 args += ['--outputspace', 'Output - %s' % odt_name]
1215             else:
1216                 args += ['--inputspace', input_space]
1217                 args += ['--outputspace', odt_name]
1218             args += ['--description',
1219                      '%s - %s for %s data' % (
1220                          odt_prefix, odt_name, input_space)]
1221             if input_space == 'ACEScg':
1222                 lin_shaper_name = '%s - AP1' % shaper_name
1223             else:
1224                 lin_shaper_name = shaper_name
1225             if prefix:
1226                 lin_shaper_name = 'Utility - %s' % lin_shaper_name
1227             args += ['--shaperspace', lin_shaper_name,
1228                      '--shapersize', str(lut_resolution_shaper)]
1229
1230             args += ['--cubesize', str(lut_resolution_3d)]
1231
1232             margs = ['--format',
1233                      'cinespace',
1234                      os.path.join(
1235                          baked_directory,
1236                          'maya',
1237                          '%s for %s Maya.csp' % (odt_name, input_space))]
1238             bake_lut = Process(description='bake a LUT',
1239                                cmd='ociobakelut',
1240                                args=(args + margs))
1241             bake_lut.execute()
1242
1243             hargs = ['--format',
1244                      'houdini',
1245                      os.path.join(
1246                          baked_directory,
1247                          'houdini',
1248                          '%s for %s Houdini.lut' % (odt_name, input_space))]
1249             bake_lut = Process(description='bake a LUT',
1250                                cmd='ociobakelut',
1251                                args=(args + hargs))
1252             bake_lut.execute()
1253
1254
1255 def generate_config_directory(config_directory,
1256                               bake_secondary_luts=False,
1257                               custom_lut_dir=None):
1258     """
1259     Object description.
1260
1261     Parameters
1262     ----------
1263     parameter : type
1264         Parameter description.
1265
1266     Returns
1267     -------
1268     type
1269          Return value description.
1270     """
1271
1272     lut_directory = os.path.join(config_directory, 'luts')
1273     dirs = [config_directory, lut_directory]
1274
1275     if bake_secondary_luts:
1276         dirs.extend([os.path.join(config_directory, 'baked'),
1277                      os.path.join(config_directory, 'baked', 'flame'),
1278                      os.path.join(config_directory, 'baked', 'photoshop'),
1279                      os.path.join(config_directory, 'baked', 'houdini'),
1280                      os.path.join(config_directory, 'baked', 'lustre'),
1281                      os.path.join(config_directory, 'baked', 'maya')])
1282
1283     if custom_lut_dir:
1284         dirs.append(os.path.join(config_directory, 'custom'))
1285
1286     for d in dirs:
1287         not os.path.exists(d) and os.mkdir(d)
1288
1289     return lut_directory
1290
1291
1292 def generate_config(aces_ctl_directory,
1293                     config_directory,
1294                     lut_resolution_1d=4096,
1295                     lut_resolution_3d=64,
1296                     bake_secondary_luts=True,
1297                     multiple_displays=False,
1298                     look_info=None,
1299                     copy_custom_luts=True,
1300                     cleanup=True,
1301                     prefix_colorspaces_with_family_names=True):
1302     """
1303     Creates the ACES configuration.
1304
1305     Parameters
1306     ----------
1307     parameter : type
1308         Parameter description.
1309
1310     Returns
1311     -------
1312     type
1313          Return value description.
1314     """
1315
1316     if look_info is None:
1317         look_info = []
1318
1319     custom_lut_dir = None
1320     if copy_custom_luts:
1321         custom_lut_dir = os.path.join(config_directory, 'custom')
1322
1323     lut_directory = generate_config_directory(config_directory,
1324                                               bake_secondary_luts,
1325                                               custom_lut_dir)
1326
1327     odt_info = aces.get_ODTs_info(aces_ctl_directory)
1328     lmt_info = aces.get_LMTs_info(aces_ctl_directory)
1329
1330     shaper_name = 'Output Shaper'
1331     config_data = create_config_data(odt_info,
1332                                      lmt_info,
1333                                      shaper_name,
1334                                      aces_ctl_directory,
1335                                      lut_directory,
1336                                      lut_resolution_1d,
1337                                      lut_resolution_3d,
1338                                      cleanup)
1339
1340     print('Creating config - with prefixes, with aliases')
1341     config = create_config(config_data,
1342                            prefix=prefix_colorspaces_with_family_names,
1343                            aliases=True,
1344                            multiple_displays=multiple_displays,
1345                            look_info=look_info,
1346                            custom_lut_dir=custom_lut_dir)
1347     print('\n\n\n')
1348
1349     write_config(config,
1350                  os.path.join(config_directory, 'config.ocio'))
1351
1352     if bake_secondary_luts:
1353         generate_baked_LUTs(odt_info,
1354                             shaper_name,
1355                             os.path.join(config_directory, 'baked'),
1356                             os.path.join(config_directory, 'config.ocio'),
1357                             lut_resolution_3d,
1358                             lut_resolution_1d,
1359                             prefix=prefix_colorspaces_with_family_names)
1360
1361     return True
1362
1363
1364 def main():
1365     """
1366     Object description.
1367
1368     Parameters
1369     ----------
1370     parameter : type
1371         Parameter description.
1372
1373     Returns
1374     -------
1375     type
1376          Return value description.
1377     """
1378
1379     import optparse
1380
1381     usage = '%prog [options]\n'
1382     usage += '\n'
1383     usage += 'An OCIO config generation script for ACES 1.0\n'
1384     usage += '\n'
1385     usage += 'Command line examples'
1386     usage += '\n'
1387     usage += ('Create a GUI-friendly ACES 1.0 config with no secondary, '
1388               'baked LUTs : \n')
1389     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1390               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1391               '--dontBakeSecondaryLUTs')
1392     usage += '\n'
1393     usage += 'Create a more OCIO-compliant ACES 1.0 config : \n'
1394     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1395               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1396               '--createMultipleDisplays')
1397     usage += '\n'
1398     usage += '\n'
1399     usage += 'Adding custom looks'
1400     usage += '\n'
1401     usage += ('Create a GUI-friendly ACES 1.0 config with an ACES-style CDL '
1402               '(will be applied in the ACEScc colorspace): \n')
1403     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1404               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1405               '\n\t\t--addACESLookCDL ACESCDLName '
1406               '/path/to/SampleCDL.ccc cc03345')
1407     usage += '\n'
1408     usage += 'Create a GUI-friendly ACES 1.0 config with an general CDL: \n'
1409     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1410               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1411               '\n\t\t--addCustomLookCDL CustomCDLName "ACES - ACEScc" '
1412               '/path/to/SampleCDL.ccc cc03345')
1413     usage += '\n'
1414     usage += ('\tIn this example, the CDL will be applied in the '
1415               'ACEScc colorspace, but the user could choose other spaces '
1416               'by changing the argument after the name of the look. \n')
1417     usage += '\n'
1418     usage += ('Create a GUI-friendly ACES 1.0 config with an ACES-style LUT '
1419               '(will be applied in the ACEScc colorspace): \n')
1420     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1421               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1422               '\n\t\t--addACESLookLUT ACESLUTName '
1423               '/path/to/SampleCDL.ccc cc03345')
1424     usage += '\n'
1425     usage += 'Create a GUI-friendly ACES 1.0 config with an general LUT: \n'
1426     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1427               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1428               '\n\t\t--addCustomLookLUT CustomLUTName "ACES - ACEScc" '
1429               '/path/to/SampleCDL.ccc cc03345')
1430     usage += '\n'
1431     usage += ('\tIn this example, the LUT will be applied in the '
1432               'ACEScc colorspace, but the user could choose other spaces '
1433               'by changing the argument after the name of the look. \n')
1434     usage += '\n'
1435
1436     look_info = []
1437
1438     def look_info_callback(option, opt_str, value, parser):
1439         print('look_info_callback')
1440         print(option, opt_str, value, parser)
1441         if opt_str == '--addCustomLookCDL':
1442             look_info.append(value)
1443         elif opt_str == '--addCustomLookLUT':
1444             look_info.append(value)
1445         elif opt_str == '--addACESLookCDL':
1446             look_info.append([value[0], 'ACES - ACEScc', value[1], value[2]])
1447         elif opt_str == '--addACESLookLUT':
1448             look_info.append([value[0], 'ACES - ACEScc', value[1]])
1449
1450     p = optparse.OptionParser(description='',
1451                               prog='create_aces_config',
1452                               version='create_aces_config 1.0',
1453                               usage=usage)
1454     p.add_option('--acesCTLDir', '-a', default=os.environ.get(
1455         ACES_OCIO_CTL_DIRECTORY_ENVIRON, None))
1456     p.add_option('--configDir', '-c', default=os.environ.get(
1457         ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON, None))
1458     p.add_option('--lutResolution1d', default=4096)
1459     p.add_option('--lutResolution3d', default=64)
1460     p.add_option('--dontBakeSecondaryLUTs', action='store_true', default=False)
1461     p.add_option('--keepTempImages', action='store_true', default=False)
1462
1463     p.add_option('--createMultipleDisplays', action='store_true',
1464                  default=False)
1465
1466     p.add_option('--addCustomLookLUT', '', type='string', nargs=3,
1467                  action='callback', callback=look_info_callback)
1468     p.add_option('--addCustomLookCDL', '', type='string', nargs=4,
1469                  action='callback', callback=look_info_callback)
1470     p.add_option('--addACESLookLUT', '', type='string', nargs=2,
1471                  action='callback', callback=look_info_callback)
1472     p.add_option('--addACESLookCDL', '', type='string', nargs=3,
1473                  action='callback', callback=look_info_callback)
1474     p.add_option('--copyCustomLUTs', action='store_true', default=False)
1475
1476     options, arguments = p.parse_args()
1477
1478     aces_ctl_directory = options.acesCTLDir
1479     config_directory = options.configDir
1480     lut_resolution_1d = int(options.lutResolution1d)
1481     lut_resolution_3d = int(options.lutResolution3d)
1482     bake_secondary_luts = not options.dontBakeSecondaryLUTs
1483     cleanup_temp_images = not options.keepTempImages
1484     multiple_displays = options.createMultipleDisplays
1485     copy_custom_luts = options.copyCustomLUTs
1486
1487     print(look_info)
1488
1489     print('command line : \n%s\n' % ' '.join(sys.argv))
1490
1491     assert aces_ctl_directory is not None, (
1492         'process: No "{0}" environment variable defined or no "ACES CTL" '
1493         'directory specified'.format(
1494             ACES_OCIO_CTL_DIRECTORY_ENVIRON))
1495
1496     assert config_directory is not None, (
1497         'process: No "{0}" environment variable defined or no configuration '
1498         'directory specified'.format(
1499             ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON))
1500
1501     return generate_config(aces_ctl_directory,
1502                            config_directory,
1503                            lut_resolution_1d,
1504                            lut_resolution_3d,
1505                            bake_secondary_luts,
1506                            multiple_displays,
1507                            look_info,
1508                            copy_custom_luts,
1509                            cleanup_temp_images)
1510
1511
1512 if __name__ == '__main__':
1513     main()