2 # -*- coding: utf-8 -*-
5 Defines objects creating the *ACES* configuration.
8 from __future__ import division
13 import PyOpenColorIO as ocio
14 from aces_ocio.colorspaces import aces
15 from aces_ocio.colorspaces import arri
16 from aces_ocio.colorspaces import canon
17 from aces_ocio.colorspaces import general
18 from aces_ocio.colorspaces import gopro
19 from aces_ocio.colorspaces import panasonic
20 from aces_ocio.colorspaces import red
21 from aces_ocio.colorspaces import sony
22 from aces_ocio.process import Process
25 __author__ = 'ACES Developers'
26 __copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
28 __maintainer__ = 'ACES Developers'
29 __email__ = 'aces@oscars.org'
30 __status__ = 'Production'
32 __all__ = ['ACES_OCIO_CTL_DIRECTORY_ENVIRON',
33 'ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON',
34 'set_config_default_roles',
36 'generate_OCIO_transform',
37 'add_colorspace_alias',
40 'generate_baked_LUTs',
45 ACES_OCIO_CTL_DIRECTORY_ENVIRON = 'ACES_OCIO_CTL_DIRECTORY'
46 ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON = 'ACES_OCIO_CONFIGURATION_DIRECTORY'
49 def set_config_default_roles(config,
60 Sets given *OCIO* configuration default roles.
66 color_picking : str or unicode
67 Color picking role title.
68 color_timing : str or unicode
69 Color timing role title.
70 compositing_log : str or unicode
71 Compositing log role title.
74 default : str or unicode
76 matte_paint : str or unicode
77 Matte painting role title.
78 reference : str or unicode
80 scene_linear : str or unicode
81 Scene linear role title.
82 texture_paint : str or unicode
83 Texture painting role title.
92 config.setRole(ocio.Constants.ROLE_COLOR_PICKING, color_picking)
94 config.setRole(ocio.Constants.ROLE_COLOR_TIMING, color_timing)
96 config.setRole(ocio.Constants.ROLE_COMPOSITING_LOG, compositing_log)
98 config.setRole(ocio.Constants.ROLE_DATA, data)
100 config.setRole(ocio.Constants.ROLE_DEFAULT, default)
102 config.setRole(ocio.Constants.ROLE_MATTE_PAINT, matte_paint)
104 config.setRole(ocio.Constants.ROLE_REFERENCE, reference)
106 config.setRole(ocio.Constants.ROLE_SCENE_LINEAR, scene_linear)
108 config.setRole(ocio.Constants.ROLE_TEXTURE_PAINT, texture_paint)
113 def write_config(config, config_path, sanity_check=True):
115 Writes the configuration to given path.
120 Parameter description.
125 Return value description.
133 print 'Configuration was not written due to a failed Sanity Check'
136 with open(config_path, mode='w') as fp:
137 fp.write(config.serialize())
140 def generate_OCIO_transform(transforms):
147 Parameter description.
152 Return value description.
155 interpolation_options = {
156 'linear': ocio.Constants.INTERP_LINEAR,
157 'nearest': ocio.Constants.INTERP_NEAREST,
158 'tetrahedral': ocio.Constants.INTERP_TETRAHEDRAL}
160 direction_options = {
161 'forward': ocio.Constants.TRANSFORM_DIR_FORWARD,
162 'inverse': ocio.Constants.TRANSFORM_DIR_INVERSE}
166 for transform in transforms:
169 if transform['type'] == 'lutFile':
170 ocio_transform = ocio.FileTransform(
171 src=transform['path'],
172 interpolation=interpolation_options[
173 transform['interpolation']],
174 direction=direction_options[transform['direction']])
175 ocio_transforms.append(ocio_transform)
178 elif transform['type'] == 'matrix':
179 ocio_transform = ocio.MatrixTransform()
180 # MatrixTransform member variables can't be initialized directly.
181 # Each must be set individually.
182 ocio_transform.setMatrix(transform['matrix'])
184 if 'offset' in transform:
185 ocio_transform.setOffset(transform['offset'])
187 if 'direction' in transform:
188 ocio_transform.setDirection(
189 direction_options[transform['direction']])
191 ocio_transforms.append(ocio_transform)
194 elif transform['type'] == 'exponent':
195 ocio_transform = ocio.ExponentTransform()
196 ocio_transform.setValue(transform['value'])
197 ocio_transforms.append(ocio_transform)
200 elif transform['type'] == 'log':
201 ocio_transform = ocio.LogTransform(
202 base=transform['base'],
203 direction=direction_options[transform['direction']])
205 ocio_transforms.append(ocio_transform)
207 # color space transform
208 elif transform['type'] == 'colorspace':
209 ocio_transform = ocio.ColorSpaceTransform(src=transform['src'],
210 dst=transform['dst'],
214 ocio_transforms.append(ocio_transform)
217 print("Ignoring unknown transform type : %s" % transform['type'])
219 if len(ocio_transforms) > 1:
220 group_transform = ocio.GroupTransform()
221 for transform in ocio_transforms:
222 group_transform.push_back(transform)
223 transform = group_transform
225 transform = ocio_transforms[0]
230 def add_colorspace_alias(config,
231 reference_colorspace,
233 colorspace_alias_names):
240 Parameter description.
245 Return value description.
248 for alias_name in colorspace_alias_names:
249 if alias_name == colorspace.name.lower():
252 print('Adding alias colorspace space %s, alias to %s' % (
253 alias_name, colorspace.name))
255 compact_family_name = 'Aliases'
257 ocio_colorspace_alias = ocio.ColorSpace(
259 bitDepth=colorspace.bit_depth,
260 description=colorspace.description,
261 equalityGroup=colorspace.equality_group,
262 family=compact_family_name,
263 isData=colorspace.is_data,
264 allocation=colorspace.allocation_type,
265 allocationVars=colorspace.allocation_vars)
267 if not colorspace.to_reference_transforms:
268 print('Generating To-Reference transforms')
269 ocio_transform = generate_OCIO_transform(
270 [{'type': 'colorspace',
271 'src': colorspace.name,
272 'dst': reference_colorspace.name,
273 'direction': 'forward'}])
274 ocio_colorspace_alias.setTransform(
276 ocio.Constants.COLORSPACE_DIR_TO_REFERENCE)
278 if not colorspace.from_reference_transforms:
279 print('Generating From-Reference transforms')
280 ocio_transform = generate_OCIO_transform(
281 [{'type': 'colorspace',
282 'src': reference_colorspace.name,
283 'dst': colorspace.name,
284 'direction': 'forward'}])
285 ocio_colorspace_alias.setTransform(
287 ocio.Constants.COLORSPACE_DIR_FROM_REFERENCE)
289 config.addColorSpace(ocio_colorspace_alias)
292 def create_config(config_data, nuke=False):
299 Parameter description.
304 Return value description.
307 # Creating the *OCIO* configuration.
308 config = ocio.Config()
310 # Setting configuration overall values.
311 config.setDescription('An ACES config generated from python')
312 config.setSearchPath('luts')
314 # Defining the reference colorspace.
315 reference_data = config_data['referenceColorSpace']
316 print('Adding the reference color space : %s' % reference_data.name)
318 reference = ocio.ColorSpace(
319 name=reference_data.name,
320 bitDepth=reference_data.bit_depth,
321 description=reference_data.description,
322 equalityGroup=reference_data.equality_group,
323 family=reference_data.family,
324 isData=reference_data.is_data,
325 allocation=reference_data.allocation_type,
326 allocationVars=reference_data.allocation_vars)
328 config.addColorSpace(reference)
332 if reference_data.aliases != []:
333 add_colorspace_alias(config, reference_data,
334 reference_data, reference_data.aliases)
338 # Creating the remaining colorspaces.
339 for colorspace in sorted(config_data['colorSpaces']):
340 print('Creating new color space : %s' % colorspace.name)
342 ocio_colorspace = ocio.ColorSpace(
343 name=colorspace.name,
344 bitDepth=colorspace.bit_depth,
345 description=colorspace.description,
346 equalityGroup=colorspace.equality_group,
347 family=colorspace.family,
348 isData=colorspace.is_data,
349 allocation=colorspace.allocation_type,
350 allocationVars=colorspace.allocation_vars)
352 if colorspace.to_reference_transforms:
353 print('Generating To-Reference transforms')
354 ocio_transform = generate_OCIO_transform(
355 colorspace.to_reference_transforms)
356 ocio_colorspace.setTransform(
358 ocio.Constants.COLORSPACE_DIR_TO_REFERENCE)
360 if colorspace.from_reference_transforms:
361 print('Generating From-Reference transforms')
362 ocio_transform = generate_OCIO_transform(
363 colorspace.from_reference_transforms)
364 ocio_colorspace.setTransform(
366 ocio.Constants.COLORSPACE_DIR_FROM_REFERENCE)
368 config.addColorSpace(ocio_colorspace)
371 # Add alias to normal colorspace, using compact name
374 if colorspace.aliases != []:
375 add_colorspace_alias(config, reference_data,
376 colorspace, colorspace.aliases)
380 # Defining the *views* and *displays*.
384 # Defining a *generic* *display* and *view* setup.
386 for display, view_list in config_data['displays'].iteritems():
387 for view_name, colorspace in view_list.iteritems():
388 config.addDisplay(display, view_name, colorspace.name)
389 if not (view_name in views):
390 views.append(view_name)
391 displays.append(display)
393 # Defining the *Nuke* specific set of *views* and *displays*.
395 display_name = 'ACES'
396 displays.append(display_name)
398 display_names = sorted(config_data['displays'])
399 for display in display_names:
400 view_list = config_data['displays'][display]
401 for view_name, colorspace in view_list.iteritems():
402 if view_name == 'Output Transform':
403 config.addDisplay(display_name, display, colorspace.name)
404 if not (display in views):
405 views.append(display)
407 # Works with Nuke Studio and Mari, but not Nuke
408 # display_name = 'Utility'
409 # displays.append(display_name)
411 linear_display_space_name = config_data['linearDisplaySpace'].name
412 log_display_space_name = config_data['logDisplaySpace'].name
414 config.addDisplay(display_name, 'Linear', linear_display_space_name)
415 views.append('Linear')
416 config.addDisplay(display_name, 'Log', log_display_space_name)
419 # Setting the active *displays* and *views*.
420 config.setActiveDisplays(','.join(sorted(displays)))
421 config.setActiveViews(','.join(views))
423 set_config_default_roles(
425 color_picking=config_data['roles']['color_picking'],
426 color_timing=config_data['roles']['color_timing'],
427 compositing_log=config_data['roles']['compositing_log'],
428 data=config_data['roles']['data'],
429 default=config_data['roles']['default'],
430 matte_paint=config_data['roles']['matte_paint'],
431 reference=config_data['roles']['reference'],
432 scene_linear=config_data['roles']['scene_linear'],
433 texture_paint=config_data['roles']['texture_paint'])
440 def generate_LUTs(odt_info,
445 lut_resolution_1d=4096,
446 lut_resolution_3d=64,
454 Parameter description.
459 Colorspaces and transforms converting between those colorspaces and
460 the reference colorspace, *ACES*.
463 print('generateLUTs - begin')
466 # Initialize a few variables
467 config_data['displays'] = {}
468 config_data['colorSpaces'] = []
470 # -------------------------------------------------------------------------
471 # *ACES Color Spaces*
472 # -------------------------------------------------------------------------
478 aces_log_display_space,
479 aces_roles) = aces.create_colorspaces(aces_ctl_directory,
488 config_data['referenceColorSpace'] = aces_reference
489 config_data['roles'] = aces_roles
491 for cs in aces_colorspaces:
492 config_data['colorSpaces'].append(cs)
494 for name, data in aces_displays.iteritems():
495 config_data['displays'][name] = data
497 config_data['linearDisplaySpace'] = aces_reference
498 config_data['logDisplaySpace'] = aces_log_display_space
500 # -------------------------------------------------------------------------
501 # *Camera Input Transforms*
502 # -------------------------------------------------------------------------
504 # *ARRI Log-C* to *ACES*.
505 arri_colorSpaces = arri.create_colorspaces(lut_directory,
507 for cs in arri_colorSpaces:
508 config_data['colorSpaces'].append(cs)
510 # *Canon-Log* to *ACES*.
511 canon_colorspaces = canon.create_colorspaces(lut_directory,
513 for cs in canon_colorspaces:
514 config_data['colorSpaces'].append(cs)
516 # *GoPro Protune* to *ACES*.
517 gopro_colorspaces = gopro.create_colorspaces(lut_directory,
519 for cs in gopro_colorspaces:
520 config_data['colorSpaces'].append(cs)
522 # *Panasonic V-Log* to *ACES*.
523 panasonic_colorSpaces = panasonic.create_colorspaces(lut_directory,
525 for cs in panasonic_colorSpaces:
526 config_data['colorSpaces'].append(cs)
528 # *RED* colorspaces to *ACES*.
529 red_colorspaces = red.create_colorspaces(lut_directory,
531 for cs in red_colorspaces:
532 config_data['colorSpaces'].append(cs)
535 sony_colorSpaces = sony.create_colorspaces(lut_directory,
537 for cs in sony_colorSpaces:
538 config_data['colorSpaces'].append(cs)
540 # -------------------------------------------------------------------------
541 # General Color Spaces
542 # -------------------------------------------------------------------------
543 general_colorSpaces = general.create_colorspaces(lut_directory,
546 for cs in general_colorSpaces:
547 config_data['colorSpaces'].append(cs)
549 # The *Raw* color space
550 raw = general.create_raw()
551 config_data['colorSpaces'].append(raw)
553 # Override certain roles, for now
554 config_data['roles']['data'] = raw.name
555 config_data['roles']['reference'] = raw.name
556 config_data['roles']['texture_paint'] = raw.name
558 print('generateLUTs - end')
562 def generate_baked_LUTs(odt_info,
568 lut_resolution_shaper=1024):
575 Parameter description.
580 Return value description.
583 # Create two entries for ODTs that have full and legal range support
584 odt_info_C = dict(odt_info)
585 for odt_ctl_name, odt_values in odt_info.iteritems():
586 if odt_values['transformHasFullLegalSwitch']:
587 odt_name = odt_values['transformUserName']
589 odt_values_legal = dict(odt_values)
590 odt_values_legal['transformUserName'] = '%s - Legal' % odt_name
591 odt_info_C['%s - Legal' % odt_ctl_name] = odt_values_legal
593 odt_values_full = dict(odt_values)
594 odt_values_full['transformUserName'] = '%s - Full' % odt_name
595 odt_info_C['%s - Full' % odt_ctl_name] = odt_values_full
597 del (odt_info_C[odt_ctl_name])
599 # Generate appropriate LUTs for each ODT
600 for odt_ctl_name, odt_values in odt_info_C.iteritems():
601 odt_prefix = odt_values['transformUserNamePrefix']
602 odt_name = odt_values['transformUserName']
605 for input_space in ['ACEScc', 'ACESproxy']:
606 args = ['--iconfig', config_path,
608 '--inputspace', input_space]
609 args += ['--outputspace', '%s' % odt_name]
610 args += ['--description',
611 '%s - %s for %s data' % (odt_prefix,
614 args += ['--shaperspace', shaper_name,
615 '--shapersize', str(lut_resolution_shaper)]
616 args += ['--cubesize', str(lut_resolution_3d)]
619 os.path.join(baked_directory,
621 '%s for %s.icc' % (odt_name, input_space))]
623 bake_lut = Process(description='bake a LUT',
629 for input_space in ['ACEScc', 'ACESproxy']:
630 args = ['--iconfig', config_path,
632 '--inputspace', input_space]
633 args += ['--outputspace', '%s' % odt_name]
634 args += ['--description',
635 '%s - %s for %s data' % (
636 odt_prefix, odt_name, input_space)]
637 args += ['--shaperspace', shaper_name,
638 '--shapersize', str(lut_resolution_shaper)]
639 args += ['--cubesize', str(lut_resolution_3d)]
646 '%s for %s Flame.3dl' % (odt_name, input_space))]
647 bake_lut = Process(description='bake a LUT',
657 '%s for %s Lustre.3dl' % (odt_name, input_space))]
658 bake_lut = Process(description='bake a LUT',
664 for input_space in ['ACEScg', 'ACES2065-1']:
665 args = ['--iconfig', config_path,
667 '--inputspace', input_space]
668 args += ['--outputspace', '%s' % odt_name]
669 args += ['--description',
670 '%s - %s for %s data' % (
671 odt_prefix, odt_name, input_space)]
672 if input_space == 'ACEScg':
673 lin_shaper_name = '%s - AP1' % shaper_name
675 lin_shaper_name = shaper_name
676 args += ['--shaperspace', lin_shaper_name,
677 '--shapersize', str(lut_resolution_shaper)]
679 args += ['--cubesize', str(lut_resolution_3d)]
686 '%s for %s Maya.csp' % (odt_name, input_space))]
687 bake_lut = Process(description='bake a LUT',
697 '%s for %s Houdini.lut' % (odt_name, input_space))]
698 bake_lut = Process(description='bake a LUT',
704 def create_config_dir(config_directory, bake_secondary_LUTs):
711 Parameter description.
716 Return value description.
719 lut_directory = os.path.join(config_directory, 'luts')
720 dirs = [config_directory, lut_directory]
721 if bake_secondary_LUTs:
722 dirs.extend([os.path.join(config_directory, 'baked'),
723 os.path.join(config_directory, 'baked', 'flame'),
724 os.path.join(config_directory, 'baked', 'photoshop'),
725 os.path.join(config_directory, 'baked', 'houdini'),
726 os.path.join(config_directory, 'baked', 'lustre'),
727 os.path.join(config_directory, 'baked', 'maya')])
730 not os.path.exists(d) and os.mkdir(d)
735 def create_ACES_config(aces_ctl_directory,
737 lut_resolution_1d=4096,
738 lut_resolution_3d=64,
739 bake_secondary_LUTs=True,
742 Creates the ACES configuration.
747 Parameter description.
752 Return value description.
755 lut_directory = create_config_dir(config_directory, bake_secondary_LUTs)
757 odt_info = aces.get_ODTs_info(aces_ctl_directory)
758 lmt_info = aces.get_LMTs_info(aces_ctl_directory)
760 shaper_name = 'Output Shaper'
761 config_data = generate_LUTs(odt_info,
770 print('Creating "generic" config')
771 config = create_config(config_data)
775 os.path.join(config_directory, 'config.ocio'))
777 print('Creating "Nuke" config')
778 nuke_config = create_config(config_data, nuke=True)
781 write_config(nuke_config,
782 os.path.join(config_directory, 'nuke_config.ocio'))
784 if bake_secondary_LUTs:
785 generate_baked_LUTs(odt_info,
787 os.path.join(config_directory, 'baked'),
788 os.path.join(config_directory, 'config.ocio'),
803 Parameter description.
808 Return value description.
813 p = optparse.OptionParser(description='An OCIO config generation script',
814 prog='createACESConfig',
815 version='createACESConfig 0.1',
816 usage='%prog [options]')
817 p.add_option('--acesCTLDir', '-a', default=os.environ.get(
818 ACES_OCIO_CTL_DIRECTORY_ENVIRON, None))
819 p.add_option('--configDir', '-c', default=os.environ.get(
820 ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON, None))
821 p.add_option('--lutResolution1d', default=4096)
822 p.add_option('--lutResolution3d', default=64)
823 p.add_option('--dontBakeSecondaryLUTs', action='store_true')
824 p.add_option('--keepTempImages', action='store_true')
826 options, arguments = p.parse_args()
828 aces_ctl_directory = options.acesCTLDir
829 config_directory = options.configDir
830 lut_resolution_1d = int(options.lutResolution1d)
831 lut_resolution_3d = int(options.lutResolution3d)
832 bake_secondary_luts = not options.dontBakeSecondaryLUTs
833 cleanup_temp_images = not options.keepTempImages
835 # TODO: Investigate the following statements.
837 args_start = sys.argv.index('--') + 1
838 args = sys.argv[args_start:]
840 args_start = len(sys.argv) + 1
843 print('command line : \n%s\n' % ' '.join(sys.argv))
845 assert aces_ctl_directory is not None, (
846 'process: No "{0}" environment variable defined or no "ACES CTL" '
847 'directory specified'.format(
848 ACES_OCIO_CTL_DIRECTORY_ENVIRON))
850 assert config_directory is not None, (
851 'process: No "{0}" environment variable defined or no configuration '
852 'directory specified'.format(
853 ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON))
855 return create_ACES_config(aces_ctl_directory,
863 if __name__ == '__main__':