aces_1.0.0/python/aces_ocio/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             # TODO: Explain context for following comment.
 579             # Deferring adding alias colorspaces until end, which helps with
 580             # some applications.
 581             alias_colorspaces.append(
 582                 [reference_data, reference_data, reference_data.aliases])
 583
 584     print()
 585
 586     if look_info:
 587         print('Adding looks')
 588
 589         config_data['looks'] = []
 590
 591         for look in look_info:
 592             add_look(config,
 593                      look,
 594                      custom_lut_dir,
 595                      reference_data.name,
 596                      config_data)
 597
 598         add_looks_to_views(look_info,
 599                            reference_data.name,
 600                            config_data,
 601                            multiple_displays)
 602
 603         print()
 604
 605     print('Adding regular colorspaces')
 606
 607     for colorspace in sorted(config_data['colorSpaces']):
 608         # Adding the colorspace *Family* into the name which helps with
 609         # applications that presenting colorspaces as one a flat list.
 610         if prefix:
 611             prefixed_name = colorspace_prefixed_name(colorspace)
 612             prefixed_names[colorspace.name] = prefixed_name
 613             colorspace.name = prefixed_name
 614
 615         print('Creating new color space : %s' % colorspace.name)
 616
 617         description = colorspace.description
 618         if colorspace.aces_transform_id:
 619             description += (
 620                 '\n\nACES Transform ID : %s' % colorspace.aces_transform_id)
 621
 622         ocio_colorspace = ocio.ColorSpace(
 623             name=colorspace.name,
 624             bitDepth=colorspace.bit_depth,
 625             description=description,
 626             equalityGroup=colorspace.equality_group,
 627             family=colorspace.family,
 628             isData=colorspace.is_data,
 629             allocation=colorspace.allocation_type,
 630             allocationVars=colorspace.allocation_vars)
 631
 632         if colorspace.to_reference_transforms:
 633             print('\tGenerating To-Reference transforms')
 634             ocio_transform = create_ocio_transform(
 635                 colorspace.to_reference_transforms)
 636             ocio_colorspace.setTransform(
 637                 ocio_transform,
 638                 ocio.Constants.COLORSPACE_DIR_TO_REFERENCE)
 639
 640         if colorspace.from_reference_transforms:
 641             print('\tGenerating From-Reference transforms')
 642             ocio_transform = create_ocio_transform(
 643                 colorspace.from_reference_transforms)
 644             ocio_colorspace.setTransform(
 645                 ocio_transform,
 646                 ocio.Constants.COLORSPACE_DIR_FROM_REFERENCE)
 647
 648         config.addColorSpace(ocio_colorspace)
 649
 650         if aliases:
 651             if colorspace.aliases:
 652                 # TODO: Explain context for following comment.
 653                 # Deferring adding alias colorspaces until end, which helps
 654                 # with some applications.
 655                 alias_colorspaces.append(
 656                     [reference_data, colorspace, colorspace.aliases])
 657
 658         print()
 659
 660     print()
 661
 662     # Adding roles early so that alias colorspaces can be created
 663     # with roles names before remaining colorspace aliases are added
 664     # to the configuration.
 665     print('Setting the roles')
 666
 667     if prefix:
 668         set_config_roles(
 669             config,
 670             color_picking=prefixed_names[
 671                 config_data['roles']['color_picking']],
 672             color_timing=prefixed_names[config_data['roles']['color_timing']],
 673             compositing_log=prefixed_names[
 674                 config_data['roles']['compositing_log']],
 675             data=prefixed_names[config_data['roles']['data']],
 676             default=prefixed_names[config_data['roles']['default']],
 677             matte_paint=prefixed_names[config_data['roles']['matte_paint']],
 678             reference=prefixed_names[config_data['roles']['reference']],
 679             scene_linear=prefixed_names[config_data['roles']['scene_linear']],
 680             texture_paint=prefixed_names[
 681                 config_data['roles']['texture_paint']])
 682
 683         # TODO: Should we remove this dead code path?
 684         # Not allowed at the moment as role names can not overlap
 685         # with colorspace names.
 686         """
 687         # Add the aliased colorspaces for each role
 688         for role_name, role_colorspace_name in config_data['roles'].iteritems():
 689             role_colorspace_prefixed_name = prefixed_names[role_colorspace_name]
 690
 691             print( 'Finding colorspace : %s' % role_colorspace_prefixed_name )
 692             # Find the colorspace pointed to by the role
 693             role_colorspaces = [colorspace
 694                 for colorspace in config_data['colorSpaces']
 695                 if colorspace.name == role_colorspace_prefixed_name]
 696             role_colorspace = None
 697             if len(role_colorspaces) > 0:
 698                 role_colorspace = role_colorspaces[0]
 699             else:
 700                 if reference_data.name == role_colorspace_prefixed_name:
 701                     role_colorspace = reference_data
 702
 703             if role_colorspace:
 704                 print( 'Adding an alias colorspace named %s, pointing to %s' % (
 705                     role_name, role_colorspace.name))
 706
 707                 add_colorspace_aliases(
 708                 config, reference_data, role_colorspace, [role_name], 'Roles')
 709         """
 710
 711     else:
 712         set_config_roles(
 713             config,
 714             color_picking=config_data['roles']['color_picking'],
 715             color_timing=config_data['roles']['color_timing'],
 716             compositing_log=config_data['roles']['compositing_log'],
 717             data=config_data['roles']['data'],
 718             default=config_data['roles']['default'],
 719             matte_paint=config_data['roles']['matte_paint'],
 720             reference=config_data['roles']['reference'],
 721             scene_linear=config_data['roles']['scene_linear'],
 722             texture_paint=config_data['roles']['texture_paint'])
 723
 724         # TODO: Should we remove this dead code path?
 725         # Not allowed at the moment as role names can not overlap
 726         # with colorspace names.
 727         """
 728         # Add the aliased colorspaces for each role
 729         for role_name, role_colorspace_name in config_data['roles'].iteritems():
 730             # Find the colorspace pointed to by the role
 731             role_colorspaces = [colorspace
 732             for colorspace in config_data['colorSpaces']
 733             if colorspace.name == role_colorspace_name]
 734             role_colorspace = None
 735             if len(role_colorspaces) > 0:
 736                 role_colorspace = role_colorspaces[0]
 737             else:
 738                 if reference_data.name == role_colorspace_name:
 739                     role_colorspace = reference_data
 740
 741             if role_colorspace:
 742                 print('Adding an alias colorspace named %s, pointing to %s' % (
 743                     role_name, role_colorspace.name))
 744
 745                 add_colorspace_aliases(
 746                 config, reference_data, role_colorspace, [role_name], 'Roles')
 747         """
 748
 749     print()
 750
 751     # Adding alias colorspaces at the end as some applications use
 752     # colorspaces definitions order of the configuration to order
 753     # the colorspaces in their selection lists, some applications
 754     # use alphabetical ordering.
 755     # This should keep the alias colorspaces out of the way for applications
 756     # using the configuration order.
 757     print('Adding the alias colorspaces')
 758     for reference, colorspace, aliases in alias_colorspaces:
 759         add_colorspace_aliases(config, reference, colorspace, aliases)
 760
 761     print()
 762
 763     print('Adding the diplays and views')
 764
 765     # Setting the *color_picking* role to be the first *Display*'s
 766     # *Output Transform* *View*.
 767     default_display_name = config_data['defaultDisplay']
 768     default_display_views = config_data['displays'][default_display_name]
 769     default_display_colorspace = default_display_views['Output Transform']
 770
 771     set_config_roles(
 772         config,
 773         color_picking=default_display_colorspace.name)
 774
 775     # Defining *Displays* and *Views*.
 776     displays, views = [], []
 777
 778     # Defining a generic *Display* and *View* setup.
 779     if multiple_displays:
 780         looks = config_data['looks'] if ('looks' in config_data) else []
 781         looks = ', '.join(looks)
 782         print('Creating multiple displays, with looks : %s' % looks)
 783
 784         # *Displays* are not reordered to put the *defaultDisplay* first
 785         # because *OCIO* will order them alphabetically when the configuration
 786         # is written to disk.
 787         for display, view_list in config_data['displays'].iteritems():
 788             for view_name, colorspace in view_list.iteritems():
 789                 config.addDisplay(display, view_name, colorspace.name, looks)
 790                 if 'Output Transform' in view_name and looks != '':
 791                     # *Views* without *Looks*.
 792                     config.addDisplay(display, view_name, colorspace.name)
 793
 794                     # *Views* with *Looks*.
 795                     view_name_with_looks = '%s with %s' % (view_name, looks)
 796                     config.addDisplay(display, view_name_with_looks,
 797                                       colorspace.name, looks)
 798                 else:
 799                     config.addDisplay(display, view_name, colorspace.name)
 800                 if not (view_name in views):
 801                     views.append(view_name)
 802             displays.append(display)
 803
 804     # *Displays* and *Views* useful in a *GUI* context.
 805     else:
 806         single_display_name = 'ACES'
 807         displays.append(single_display_name)
 808
 809         # Ensuring the *defaultDisplay* is first.
 810         display_names = sorted(config_data['displays'])
 811         display_names.insert(0, display_names.pop(
 812             display_names.index(default_display_name)))
 813
 814         looks = config_data['looks'] if ('looks' in config_data) else []
 815         look_names = ', '.join(looks)
 816
 817         displays_views_colorspaces = []
 818
 819         for display in display_names:
 820             view_list = config_data['displays'][display]
 821             for view_name, colorspace in view_list.iteritems():
 822                 if 'Output Transform' in view_name:
 823
 824                     # We use the *Display* names as the *View* names in this
 825                     # case as there is a single *Display* containing all the
 826                     # *Views*.
 827                     # This works for more applications than not,as of the time
 828                     # of this implementation.
 829
 830                     # Autodesk Maya 2016 doesn't support parentheses in
 831                     # *View* names.
 832                     sanitised_display = replace(display, {')': '', '(': ''})
 833
 834                     # *View* with *Looks*.
 835                     if 'with' in view_name:
 836                         sanitised_display = '%s with %s' % (
 837                             sanitised_display, look_names)
 838
 839                         views_with_looks_at_end = False
 840                         # Storing combo of *Display*, *View* and *Colorspace*
 841                         # name so they can be added to the end of the list.
 842                         if views_with_looks_at_end:
 843                             displays_views_colorspaces.append(
 844                                 [single_display_name, sanitised_display,
 845                                  colorspace.name])
 846                         else:
 847                             config.addDisplay(single_display_name,
 848                                               sanitised_display,
 849                                               colorspace.name)
 850
 851                             if not (sanitised_display in views):
 852                                 views.append(sanitised_display)
 853
 854                     # *View* without *Looks*.
 855                     else:
 856                         config.addDisplay(single_display_name,
 857                                           sanitised_display,
 858                                           colorspace.name)
 859
 860                         if not (sanitised_display in views):
 861                             views.append(sanitised_display)
 862
 863         # Adding to the configuration any *Display*, *View* combinations that
 864         # were saved for later.
 865         # This list should be empty unless `views_with_looks_at_end` is
 866         # set `True` above.
 867         for display_view_colorspace in displays_views_colorspaces:
 868             single_display_name, sanitised_display, colorspace_name = (
 869                 display_view_colorspace)
 870
 871             config.addDisplay(single_display_name,
 872                               sanitised_display,
 873                               colorspace_name)
 874
 875             if not (sanitised_display in views):
 876                 views.append(sanitised_display)
 877
 878         raw_display_space_name = config_data['roles']['data']
 879         log_display_space_name = config_data['roles']['compositing_log']
 880
 881         if prefix:
 882             raw_display_space_name = prefixed_names[raw_display_space_name]
 883             log_display_space_name = prefixed_names[log_display_space_name]
 884
 885         config.addDisplay(single_display_name, 'Raw', raw_display_space_name)
 886         views.append('Raw')
 887         config.addDisplay(single_display_name, 'Log', log_display_space_name)
 888         views.append('Log')
 889
 890     config.setActiveDisplays(','.join(sorted(displays)))
 891     config.setActiveViews(','.join(views))
 892
 893     print()
 894
 895     # Ensuring the configuration is valid.
 896     config.sanityCheck()
 897
 898     # Resetting colorspace names to their non-prefixed versions.
 899     if prefix:
 900         prefixed_names_inverse = {}
 901         for original, prefixed in prefixed_names.iteritems():
 902             prefixed_names_inverse[prefixed] = original
 903
 904         reference_data.name = prefixed_names_inverse[reference_data.name]
 905
 906         try:
 907             for colorspace in config_data['colorSpaces']:
 908                 colorspace.name = prefixed_names_inverse[colorspace.name]
 909         except:
 910             print('Prefixed names')
 911             for original, prefixed in prefixed_names.iteritems():
 912                 print('%s, %s' % (original, prefixed))
 913
 914             print('\n')
 915
 916             print('Inverse Lookup of Prefixed names')
 917             for prefixed, original in prefixed_names_inverse.iteritems():
 918                 print('%s, %s' % (prefixed, original))
 919             raise
 920
 921     return config
 922
 923
 924 def create_config_data(odt_info,
 925                        lmt_info,
 926                        shaper_name,
 927                        aces_ctl_directory,
 928                        lut_directory,
 929                        lut_resolution_1d=4096,
 930                        lut_resolution_3d=64,
 931                        cleanup=True):
 932     """
 933     Object description.
 934
 935     Parameters
 936     ----------
 937     parameter : type
 938         Parameter description.
 939
 940     Returns
 941     -------
 942     dict
 943          Colorspaces and transforms converting between those colorspaces and
 944          the reference colorspace, *ACES*.
 945     """
 946
 947     print('create_config_data - begin')
 948     config_data = {}
 949
 950     config_data['displays'] = {}
 951     config_data['colorSpaces'] = []
 952
 953     # -------------------------------------------------------------------------
 954     # *ACES Color Spaces*
 955     # -------------------------------------------------------------------------
 956
 957     # *ACES* colorspaces
 958     (aces_reference,
 959      aces_colorspaces,
 960      aces_displays,
 961      aces_log_display_space,
 962      aces_roles,
 963      aces_default_display) = aces.create_colorspaces(aces_ctl_directory,
 964                                                      lut_directory,
 965                                                      lut_resolution_1d,
 966                                                      lut_resolution_3d,
 967                                                      lmt_info,
 968                                                      odt_info,
 969                                                      shaper_name,
 970                                                      cleanup)
 971
 972     config_data['referenceColorSpace'] = aces_reference
 973     config_data['roles'] = aces_roles
 974
 975     for cs in aces_colorspaces:
 976         config_data['colorSpaces'].append(cs)
 977
 978     for name, data in aces_displays.iteritems():
 979         config_data['displays'][name] = data
 980
 981     config_data['defaultDisplay'] = aces_default_display
 982     config_data['linearDisplaySpace'] = aces_reference
 983     config_data['logDisplaySpace'] = aces_log_display_space
 984
 985     # -------------------------------------------------------------------------
 986     # *Camera Input Transforms*
 987     # -------------------------------------------------------------------------
 988
 989     # *ARRI Log-C* to *ACES*
 990     arri_colorspaces = arri.create_colorspaces(lut_directory,
 991                                                lut_resolution_1d)
 992     for cs in arri_colorspaces:
 993         config_data['colorSpaces'].append(cs)
 994
 995     # *Canon-Log* to *ACES*
 996     canon_colorspaces = canon.create_colorspaces(lut_directory,
 997                                                  lut_resolution_1d)
 998     for cs in canon_colorspaces:
 999         config_data['colorSpaces'].append(cs)
1000
1001     # *GoPro Protune* to *ACES*
1002     gopro_colorspaces = gopro.create_colorspaces(lut_directory,
1003                                                  lut_resolution_1d)
1004     for cs in gopro_colorspaces:
1005         config_data['colorSpaces'].append(cs)
1006
1007     # *Panasonic V-Log* to *ACES*
1008     panasonic_colorspaces = panasonic.create_colorspaces(lut_directory,
1009                                                          lut_resolution_1d)
1010     for cs in panasonic_colorspaces:
1011         config_data['colorSpaces'].append(cs)
1012
1013     # *RED* colorspaces to *ACES*
1014     red_colorspaces = red.create_colorspaces(lut_directory,
1015                                              lut_resolution_1d)
1016     for cs in red_colorspaces:
1017         config_data['colorSpaces'].append(cs)
1018
1019     # *S-Log* to *ACES*
1020     sony_colorspaces = sony.create_colorspaces(lut_directory,
1021                                                lut_resolution_1d)
1022     for cs in sony_colorspaces:
1023         config_data['colorSpaces'].append(cs)
1024
1025     # -------------------------------------------------------------------------
1026     # General Colorspaces
1027     # -------------------------------------------------------------------------
1028     general_colorspaces = general.create_colorspaces(lut_directory,
1029                                                      lut_resolution_1d)
1030     for cs in general_colorspaces:
1031         config_data['colorSpaces'].append(cs)
1032
1033     # The *Raw* colorspace
1034     raw = general.create_raw()
1035     config_data['colorSpaces'].append(raw)
1036
1037     # Overriding various roles
1038     config_data['roles']['data'] = raw.name
1039     config_data['roles']['reference'] = raw.name
1040     config_data['roles']['texture_paint'] = raw.name
1041
1042     print('create_config_data - end')
1043
1044     return config_data
1045
1046
1047 def write_config(config, config_path, sanity_check=True):
1048     """
1049     Writes the configuration to given path.
1050
1051     Parameters
1052     ----------
1053     config : Config
1054         *OCIO* configuration.
1055     config_path : str or unicode
1056         Path to write the configuration path.
1057     sanity_check : bool
1058         Performs configuration sanity checking prior to writing it on disk.
1059
1060     Returns
1061     -------
1062     bool
1063          Definition success.
1064     """
1065
1066     if sanity_check:
1067         try:
1068             config.sanityCheck()
1069         except Exception, e:
1070             print e
1071             print 'Configuration was not written due to a failed Sanity Check'
1072             return
1073
1074     with open(config_path, mode='w') as fp:
1075         fp.write(config.serialize())
1076
1077
1078 def generate_baked_LUTs(odt_info,
1079                         shaper_name,
1080                         baked_directory,
1081                         config_path,
1082                         lut_resolution_3d,
1083                         lut_resolution_shaper=1024,
1084                         prefix=False):
1085     """
1086     Object description.
1087
1088     Parameters
1089     ----------
1090     parameter : type
1091         Parameter description.
1092
1093     Returns
1094     -------
1095     type
1096          Return value description.
1097     """
1098
1099     odt_info_C = dict(odt_info)
1100
1101     # Older behavior for *ODTs* that have support for full and legal ranges,
1102     # generating a LUT for both ranges.
1103     """
1104     # Create two entries for ODTs that have full and legal range support
1105     for odt_ctl_name, odt_values in odt_info.iteritems():
1106         if odt_values['transformHasFullLegalSwitch']:
1107             odt_name = odt_values['transformUserName']
1108
1109             odt_values_legal = dict(odt_values)
1110             odt_values_legal['transformUserName'] = '%s - Legal' % odt_name
1111             odt_info_C['%s - Legal' % odt_ctl_name] = odt_values_legal
1112
1113             odt_values_full = dict(odt_values)
1114             odt_values_full['transformUserName'] = '%s - Full' % odt_name
1115             odt_info_C['%s - Full' % odt_ctl_name] = odt_values_full
1116
1117             del (odt_info_C[odt_ctl_name])
1118     """
1119
1120     for odt_ctl_name, odt_values in odt_info_C.iteritems():
1121         odt_prefix = odt_values['transformUserNamePrefix']
1122         odt_name = odt_values['transformUserName']
1123
1124         # *Photoshop*
1125         for input_space in ['ACEScc', 'ACESproxy']:
1126             args = ['--iconfig', config_path,
1127                     '-v']
1128             if prefix:
1129                 args += ['--inputspace', 'ACES - %s' % input_space]
1130                 args += ['--outputspace', 'Output - %s' % odt_name]
1131             else:
1132                 args += ['--inputspace', input_space]
1133                 args += ['--outputspace', odt_name]
1134
1135             args += ['--description',
1136                      '%s - %s for %s data' % (odt_prefix,
1137                                               odt_name,
1138                                               input_space)]
1139             if prefix:
1140                 args += ['--shaperspace', 'Utility - %s' % shaper_name,
1141                          '--shapersize', str(lut_resolution_shaper)]
1142             else:
1143                 args += ['--shaperspace', shaper_name,
1144                          '--shapersize', str(lut_resolution_shaper)]
1145             args += ['--cubesize', str(lut_resolution_3d)]
1146             args += ['--format',
1147                      'icc',
1148                      os.path.join(baked_directory,
1149                                   'photoshop',
1150                                   '%s for %s.icc' % (odt_name, input_space))]
1151
1152             bake_lut = Process(description='bake a LUT',
1153                                cmd='ociobakelut',
1154                                args=args)
1155             bake_lut.execute()
1156
1157         # *Flame*, *Lustre*
1158         for input_space in ['ACEScc', 'ACESproxy']:
1159             args = ['--iconfig', config_path,
1160                     '-v']
1161             if prefix:
1162                 args += ['--inputspace', 'ACES - %s' % input_space]
1163                 args += ['--outputspace', 'Output - %s' % odt_name]
1164             else:
1165                 args += ['--inputspace', input_space]
1166                 args += ['--outputspace', odt_name]
1167             args += ['--description',
1168                      '%s - %s for %s data' % (
1169                          odt_prefix, odt_name, input_space)]
1170             if prefix:
1171                 args += ['--shaperspace', 'Utility - %s' % shaper_name,
1172                          '--shapersize', str(lut_resolution_shaper)]
1173             else:
1174                 args += ['--shaperspace', shaper_name,
1175                          '--shapersize', str(lut_resolution_shaper)]
1176             args += ['--cubesize', str(lut_resolution_3d)]
1177
1178             fargs = ['--format',
1179                      'flame',
1180                      os.path.join(
1181                          baked_directory,
1182                          'flame',
1183                          '%s for %s Flame.3dl' % (odt_name, input_space))]
1184             bake_lut = Process(description='bake a LUT',
1185                                cmd='ociobakelut',
1186                                args=(args + fargs))
1187             bake_lut.execute()
1188
1189             largs = ['--format',
1190                      'lustre',
1191                      os.path.join(
1192                          baked_directory,
1193                          'lustre',
1194                          '%s for %s Lustre.3dl' % (odt_name, input_space))]
1195             bake_lut = Process(description='bake a LUT',
1196                                cmd='ociobakelut',
1197                                args=(args + largs))
1198             bake_lut.execute()
1199
1200         # *Maya*, *Houdini*
1201         for input_space in ['ACEScg', 'ACES2065-1']:
1202             args = ['--iconfig', config_path,
1203                     '-v']
1204             if prefix:
1205                 args += ['--inputspace', 'ACES - %s' % input_space]
1206                 args += ['--outputspace', 'Output - %s' % odt_name]
1207             else:
1208                 args += ['--inputspace', input_space]
1209                 args += ['--outputspace', odt_name]
1210             args += ['--description',
1211                      '%s - %s for %s data' % (
1212                          odt_prefix, odt_name, input_space)]
1213             if input_space == 'ACEScg':
1214                 lin_shaper_name = '%s - AP1' % shaper_name
1215             else:
1216                 lin_shaper_name = shaper_name
1217             if prefix:
1218                 lin_shaper_name = 'Utility - %s' % lin_shaper_name
1219             args += ['--shaperspace', lin_shaper_name,
1220                      '--shapersize', str(lut_resolution_shaper)]
1221
1222             args += ['--cubesize', str(lut_resolution_3d)]
1223
1224             margs = ['--format',
1225                      'cinespace',
1226                      os.path.join(
1227                          baked_directory,
1228                          'maya',
1229                          '%s for %s Maya.csp' % (odt_name, input_space))]
1230             bake_lut = Process(description='bake a LUT',
1231                                cmd='ociobakelut',
1232                                args=(args + margs))
1233             bake_lut.execute()
1234
1235             hargs = ['--format',
1236                      'houdini',
1237                      os.path.join(
1238                          baked_directory,
1239                          'houdini',
1240                          '%s for %s Houdini.lut' % (odt_name, input_space))]
1241             bake_lut = Process(description='bake a LUT',
1242                                cmd='ociobakelut',
1243                                args=(args + hargs))
1244             bake_lut.execute()
1245
1246
1247 def generate_config_directory(config_directory,
1248                               bake_secondary_luts=False,
1249                               custom_lut_dir=None):
1250     """
1251     Object description.
1252
1253     Parameters
1254     ----------
1255     parameter : type
1256         Parameter description.
1257
1258     Returns
1259     -------
1260     type
1261          Return value description.
1262     """
1263
1264     lut_directory = os.path.join(config_directory, 'luts')
1265     dirs = [config_directory, lut_directory]
1266
1267     if bake_secondary_luts:
1268         dirs.extend([os.path.join(config_directory, 'baked'),
1269                      os.path.join(config_directory, 'baked', 'flame'),
1270                      os.path.join(config_directory, 'baked', 'photoshop'),
1271                      os.path.join(config_directory, 'baked', 'houdini'),
1272                      os.path.join(config_directory, 'baked', 'lustre'),
1273                      os.path.join(config_directory, 'baked', 'maya')])
1274
1275     if custom_lut_dir:
1276         dirs.append(os.path.join(config_directory, 'custom'))
1277
1278     for d in dirs:
1279         not os.path.exists(d) and os.mkdir(d)
1280
1281     return lut_directory
1282
1283
1284 def generate_config(aces_ctl_directory,
1285                     config_directory,
1286                     lut_resolution_1d=4096,
1287                     lut_resolution_3d=64,
1288                     bake_secondary_luts=True,
1289                     multiple_displays=False,
1290                     look_info=None,
1291                     copy_custom_luts=True,
1292                     cleanup=True,
1293                     prefix_colorspaces_with_family_names=True):
1294     """
1295     Creates the ACES configuration.
1296
1297     Parameters
1298     ----------
1299     parameter : type
1300         Parameter description.
1301
1302     Returns
1303     -------
1304     type
1305          Return value description.
1306     """
1307
1308     if look_info is None:
1309         look_info = []
1310
1311     custom_lut_dir = None
1312     if copy_custom_luts:
1313         custom_lut_dir = os.path.join(config_directory, 'custom')
1314
1315     lut_directory = generate_config_directory(config_directory,
1316                                               bake_secondary_luts,
1317                                               custom_lut_dir)
1318
1319     odt_info = aces.get_ODTs_info(aces_ctl_directory)
1320     lmt_info = aces.get_LMTs_info(aces_ctl_directory)
1321
1322     shaper_name = 'Output Shaper'
1323     config_data = create_config_data(odt_info,
1324                                      lmt_info,
1325                                      shaper_name,
1326                                      aces_ctl_directory,
1327                                      lut_directory,
1328                                      lut_resolution_1d,
1329                                      lut_resolution_3d,
1330                                      cleanup)
1331
1332     print('Creating config - with prefixes, with aliases')
1333     config = create_config(config_data,
1334                            prefix=prefix_colorspaces_with_family_names,
1335                            aliases=True,
1336                            multiple_displays=multiple_displays,
1337                            look_info=look_info,
1338                            custom_lut_dir=custom_lut_dir)
1339     print('\n\n\n')
1340
1341     write_config(config,
1342                  os.path.join(config_directory, 'config.ocio'))
1343
1344     if bake_secondary_luts:
1345         generate_baked_LUTs(odt_info,
1346                             shaper_name,
1347                             os.path.join(config_directory, 'baked'),
1348                             os.path.join(config_directory, 'config.ocio'),
1349                             lut_resolution_3d,
1350                             lut_resolution_1d,
1351                             prefix=prefix_colorspaces_with_family_names)
1352
1353     return True
1354
1355
1356 def main():
1357     """
1358     Object description.
1359
1360     Parameters
1361     ----------
1362     parameter : type
1363         Parameter description.
1364
1365     Returns
1366     -------
1367     type
1368          Return value description.
1369     """
1370
1371     import optparse
1372
1373     usage = '%prog [options]\n'
1374     usage += '\n'
1375     usage += 'An OCIO config generation script for ACES 1.0\n'
1376     usage += '\n'
1377     usage += 'Command line examples'
1378     usage += '\n'
1379     usage += ('Create a GUI-friendly ACES 1.0 config with no secondary, '
1380               'baked LUTs : \n')
1381     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1382               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1383               '--dontBakeSecondaryLUTs')
1384     usage += '\n'
1385     usage += 'Create a more OCIO-compliant ACES 1.0 config : \n'
1386     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1387               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1388               '--createMultipleDisplays')
1389     usage += '\n'
1390     usage += '\n'
1391     usage += 'Adding custom looks'
1392     usage += '\n'
1393     usage += ('Create a GUI-friendly ACES 1.0 config with an ACES-style CDL '
1394               '(will be applied in the ACEScc colorspace): \n')
1395     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1396               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1397               '\n\t\t--addACESLookCDL ACESCDLName '
1398               '/path/to/SampleCDL.ccc cc03345')
1399     usage += '\n'
1400     usage += 'Create a GUI-friendly ACES 1.0 config with an general CDL: \n'
1401     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1402               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1403               '\n\t\t--addCustomLookCDL CustomCDLName "ACES - ACEScc" '
1404               '/path/to/SampleCDL.ccc cc03345')
1405     usage += '\n'
1406     usage += ('\tIn this example, the CDL will be applied in the '
1407               'ACEScc colorspace, but the user could choose other spaces '
1408               'by changing the argument after the name of the look. \n')
1409     usage += '\n'
1410     usage += ('Create a GUI-friendly ACES 1.0 config with an ACES-style LUT '
1411               '(will be applied in the ACEScc colorspace): \n')
1412     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1413               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1414               '\n\t\t--addACESLookLUT ACESLUTName '
1415               '/path/to/SampleCDL.ccc cc03345')
1416     usage += '\n'
1417     usage += 'Create a GUI-friendly ACES 1.0 config with an general LUT: \n'
1418     usage += ('\tcreate_aces_config -a /path/to/aces-dev/transforms/ctl '
1419               '--lutResolution1d 1024 --lutResolution3d 33 -c aces_1.0.0 '
1420               '\n\t\t--addCustomLookLUT CustomLUTName "ACES - ACEScc" '
1421               '/path/to/SampleCDL.ccc cc03345')
1422     usage += '\n'
1423     usage += ('\tIn this example, the LUT will be applied in the '
1424               'ACEScc colorspace, but the user could choose other spaces '
1425               'by changing the argument after the name of the look. \n')
1426     usage += '\n'
1427
1428     look_info = []
1429
1430     def look_info_callback(option, opt_str, value, parser):
1431         print('look_info_callback')
1432         print(option, opt_str, value, parser)
1433         if opt_str == '--addCustomLookCDL':
1434             look_info.append(value)
1435         elif opt_str == '--addCustomLookLUT':
1436             look_info.append(value)
1437         elif opt_str == '--addACESLookCDL':
1438             look_info.append([value[0], 'ACES - ACEScc', value[1], value[2]])
1439         elif opt_str == '--addACESLookLUT':
1440             look_info.append([value[0], 'ACES - ACEScc', value[1]])
1441
1442     p = optparse.OptionParser(description='',
1443                               prog='create_aces_config',
1444                               version='create_aces_config 1.0',
1445                               usage=usage)
1446     p.add_option('--acesCTLDir', '-a', default=os.environ.get(
1447         ACES_OCIO_CTL_DIRECTORY_ENVIRON, None))
1448     p.add_option('--configDir', '-c', default=os.environ.get(
1449         ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON, None))
1450     p.add_option('--lutResolution1d', default=4096)
1451     p.add_option('--lutResolution3d', default=64)
1452     p.add_option('--dontBakeSecondaryLUTs', action='store_true', default=False)
1453     p.add_option('--keepTempImages', action='store_true', default=False)
1454
1455     p.add_option('--createMultipleDisplays', action='store_true',
1456                  default=False)
1457
1458     p.add_option('--addCustomLookLUT', '', type='string', nargs=3,
1459                  action='callback', callback=look_info_callback)
1460     p.add_option('--addCustomLookCDL', '', type='string', nargs=4,
1461                  action='callback', callback=look_info_callback)
1462     p.add_option('--addACESLookLUT', '', type='string', nargs=2,
1463                  action='callback', callback=look_info_callback)
1464     p.add_option('--addACESLookCDL', '', type='string', nargs=3,
1465                  action='callback', callback=look_info_callback)
1466     p.add_option('--copyCustomLUTs', action='store_true', default=False)
1467
1468     options, arguments = p.parse_args()
1469
1470     aces_ctl_directory = options.acesCTLDir
1471     config_directory = options.configDir
1472     lut_resolution_1d = int(options.lutResolution1d)
1473     lut_resolution_3d = int(options.lutResolution3d)
1474     bake_secondary_luts = not options.dontBakeSecondaryLUTs
1475     cleanup_temp_images = not options.keepTempImages
1476     multiple_displays = options.createMultipleDisplays
1477     copy_custom_luts = options.copyCustomLUTs
1478
1479     print(look_info)
1480
1481     print('command line : \n%s\n' % ' '.join(sys.argv))
1482
1483     assert aces_ctl_directory is not None, (
1484         'process: No "{0}" environment variable defined or no "ACES CTL" '
1485         'directory specified'.format(
1486             ACES_OCIO_CTL_DIRECTORY_ENVIRON))
1487
1488     assert config_directory is not None, (
1489         'process: No "{0}" environment variable defined or no configuration '
1490         'directory specified'.format(
1491             ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON))
1492
1493     return generate_config(aces_ctl_directory,
1494                            config_directory,
1495                            lut_resolution_1d,
1496                            lut_resolution_3d,
1497                            bake_secondary_luts,
1498                            multiple_displays,
1499                            look_info,
1500                            copy_custom_luts,
1501                            cleanup_temp_images)
1502
1503
1504 if __name__ == '__main__':
1505     main()