2 # -*- coding: utf-8 -*-
5 Defines objects creating the *ACES* configuration.
16 # TODO: This restores the capability of running the script without having
17 # added the package to PYTHONPATH, this is ugly and should ideally replaced by
18 # dedicated executable in a /bin directory.
19 sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
21 import PyOpenColorIO as ocio
23 import aces_ocio.create_arri_colorspaces as arri
24 import aces_ocio.create_canon_colorspaces as canon
25 import aces_ocio.create_red_colorspaces as red
26 import aces_ocio.create_sony_colorspaces as sony
27 from aces_ocio.generate_lut import (
28 generate_1d_LUT_from_CTL,
29 generate_3d_LUT_from_CTL,
31 from aces_ocio.process import Process
32 from aces_ocio.utilities import ColorSpace, mat44_from_mat33
34 __author__ = 'ACES Developers'
35 __copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
37 __maintainer__ = 'ACES Developers'
38 __email__ = 'aces@oscars.org'
39 __status__ = 'Production'
41 __all__ = ['ACES_OCIO_CTL_DIRECTORY_ENVIRON',
42 'ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON',
43 'set_config_default_roles',
45 'generate_OCIO_transform',
48 'generate_baked_LUTs',
56 ACES_OCIO_CTL_DIRECTORY_ENVIRON = 'ACES_OCIO_CTL_DIRECTORY'
57 ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON = 'ACES_OCIO_CONFIGURATION_DIRECTORY'
60 def set_config_default_roles(config,
71 Sets given *OCIO* configuration default roles.
77 color_picking : str or unicode
78 Color picking role title.
79 color_timing : str or unicode
80 Color timing role title.
81 compositing_log : str or unicode
82 Compositing log role title.
85 default : str or unicode
87 matte_paint : str or unicode
88 Matte painting role title.
89 reference : str or unicode
91 scene_linear : str or unicode
92 Scene linear role title.
93 texture_paint : str or unicode
94 Texture painting role title.
103 config.setRole(ocio.Constants.ROLE_COLOR_PICKING, color_picking)
105 config.setRole(ocio.Constants.ROLE_COLOR_TIMING, color_timing)
107 config.setRole(ocio.Constants.ROLE_COMPOSITING_LOG, compositing_log)
109 config.setRole(ocio.Constants.ROLE_DATA, data)
111 config.setRole(ocio.Constants.ROLE_DEFAULT, default)
113 config.setRole(ocio.Constants.ROLE_MATTE_PAINT, matte_paint)
115 config.setRole(ocio.Constants.ROLE_REFERENCE, reference)
117 config.setRole(ocio.Constants.ROLE_SCENE_LINEAR, scene_linear)
119 config.setRole(ocio.Constants.ROLE_TEXTURE_PAINT, texture_paint)
124 def write_config(config, config_path, sanity_check=True):
126 Writes the configuration to given path.
131 Parameter description.
136 Return value description.
144 print 'Configuration was not written due to a failed Sanity Check'
148 file_handle = open(config_path, mode='w')
149 file_handle.write(config.serialize())
153 def generate_OCIO_transform(transforms):
160 Parameter description.
165 Return value description.
168 # print('Generating transforms')
170 interpolation_options = {
171 'linear': ocio.Constants.INTERP_LINEAR,
172 'nearest': ocio.Constants.INTERP_NEAREST,
173 'tetrahedral': ocio.Constants.INTERP_TETRAHEDRAL
175 direction_options = {
176 'forward': ocio.Constants.TRANSFORM_DIR_FORWARD,
177 'inverse': ocio.Constants.TRANSFORM_DIR_INVERSE
182 for transform in transforms:
183 if transform['type'] == 'lutFile':
184 ocio_transform = ocio.FileTransform(
185 src=transform['path'],
186 interpolation=interpolation_options[
187 transform['interpolation']],
188 direction=direction_options[transform['direction']])
189 ocio_transforms.append(ocio_transform)
190 elif transform['type'] == 'matrix':
191 ocio_transform = ocio.MatrixTransform()
192 # MatrixTransform member variables can't be initialized directly.
193 # Each must be set individually.
194 ocio_transform.setMatrix(transform['matrix'])
196 if 'offset' in transform:
197 ocio_transform.setOffset(transform['offset'])
199 if 'direction' in transform:
200 ocio_transform.setDirection(
201 direction_options[transform['direction']])
203 ocio_transforms.append(ocio_transform)
204 elif transform['type'] == 'exponent':
205 ocio_transform = ocio.ExponentTransform()
206 ocio_transform.setValue(transform['value'])
207 ocio_transforms.append(ocio_transform)
208 elif transform['type'] == 'log':
209 ocio_transform = ocio.LogTransform(
210 base=transform['base'],
211 direction=direction_options[transform['direction']])
213 ocio_transforms.append(ocio_transform)
215 print('Ignoring unknown transform type : %s' % transform['type'])
217 # Build a group transform if necessary
218 if len(ocio_transforms) > 1:
219 transform_G = ocio.GroupTransform()
220 for transform in ocio_transforms:
221 transform_G.push_back(transform)
222 transform = transform_G
224 # Or take the first transform from the list
226 transform = ocio_transforms[0]
231 def create_config(config_data, nuke=False):
238 Parameter description.
243 Return value description.
247 config = ocio.Config()
250 # Set config wide values
252 config.setDescription('An ACES config generated from python')
253 config.setSearchPath('luts')
256 # Define the reference color space
258 reference_data = config_data['referenceColorSpace']
259 print('Adding the reference color space : %s' % reference_data.name)
261 # Create a color space
262 reference = ocio.ColorSpace(
263 name=reference_data.name,
264 bitDepth=reference_data.bit_depth,
265 description=reference_data.description,
266 equalityGroup=reference_data.equality_group,
267 family=reference_data.family,
268 isData=reference_data.is_data,
269 allocation=reference_data.allocation_type,
270 allocationVars=reference_data.allocation_vars)
273 config.addColorSpace(reference)
276 # Create the rest of the color spaces
278 for colorspace in sorted(config_data['colorSpaces']):
279 print('Creating new color space : %s' % colorspace.name)
281 ocio_colorspace = ocio.ColorSpace(
282 name=colorspace.name,
283 bitDepth=colorspace.bit_depth,
284 description=colorspace.description,
285 equalityGroup=colorspace.equality_group,
286 family=colorspace.family,
287 isData=colorspace.is_data,
288 allocation=colorspace.allocation_type,
289 allocationVars=colorspace.allocation_vars)
291 if colorspace.to_reference_transforms != []:
292 print('Generating To-Reference transforms')
293 ocio_transform = generate_OCIO_transform(
294 colorspace.to_reference_transforms)
295 ocio_colorspace.setTransform(
297 ocio.Constants.COLORSPACE_DIR_TO_REFERENCE)
299 if colorspace.from_reference_transforms != []:
300 print('Generating From-Reference transforms')
301 ocio_transform = generate_OCIO_transform(
302 colorspace.from_reference_transforms)
303 ocio_colorspace.setTransform(
305 ocio.Constants.COLORSPACE_DIR_FROM_REFERENCE)
307 config.addColorSpace(ocio_colorspace)
312 # Define the views and displays
317 # Generic display and view setup
319 for display, view_list in config_data['displays'].iteritems():
320 for view_name, colorspace in view_list.iteritems():
321 config.addDisplay(display, view_name, colorspace.name)
322 if not (view_name in views):
323 views.append(view_name)
324 displays.append(display)
325 # A Nuke specific set of views and displays
328 # A few names: Output Transform, ACES, ACEScc, are hard-coded here.
329 # Would be better to automate.
332 for display, view_list in config_data['displays'].iteritems():
333 for view_name, colorspace in view_list.iteritems():
334 if (view_name == 'Output Transform'):
336 config.addDisplay(display, view_name, colorspace.name)
337 if not (view_name in views):
338 views.append(view_name)
339 displays.append(display)
341 config.addDisplay('linear', 'View', 'ACES2065-1')
342 displays.append('linear')
343 config.addDisplay('log', 'View', 'ACEScc')
344 displays.append('log')
346 # Set active displays and views
347 config.setActiveDisplays(','.join(sorted(displays)))
348 config.setActiveViews(','.join(views))
351 # Need to generalize this at some point
355 set_config_default_roles(
357 color_picking=reference.getName(),
358 color_timing=reference.getName(),
359 compositing_log=reference.getName(),
360 data=reference.getName(),
361 default=reference.getName(),
362 matte_paint=reference.getName(),
363 reference=reference.getName(),
364 scene_linear=reference.getName(),
365 texture_paint=reference.getName())
367 # Check to make sure we didn't screw something up
373 def generate_LUTs(odt_info,
378 lut_resolution_1d=4096,
379 lut_resolution_3d=64,
387 Parameter description.
392 Colorspaces and transforms converting between those colorspaces and
393 the reference colorspace, *ACES*.
396 print('generateLUTs - begin')
400 # Define the reference color space
402 ACES = ColorSpace('ACES2065-1')
404 'The Academy Color Encoding System reference color space')
405 ACES.equality_group = ''
408 ACES.allocation_type = ocio.Constants.ALLOCATION_LG2
409 ACES.allocation_vars = [-15, 6]
411 config_data['referenceColorSpace'] = ACES
414 # Define the displays
416 config_data['displays'] = {}
419 # Define the other color spaces
421 config_data['colorSpaces'] = []
423 # Matrix converting ACES AP1 primaries to AP0
424 ACES_AP1_to_AP0 = [0.6954522414, 0.1406786965, 0.1638690622,
425 0.0447945634, 0.8596711185, 0.0955343182,
426 -0.0055258826, 0.0040252103, 1.0015006723]
428 # Matrix converting ACES AP0 primaries to XYZ
429 ACES_AP0_to_XYZ = [0.9525523959, 0.0000000000, 0.0000936786,
430 0.3439664498, 0.7281660966, -0.0721325464,
431 0.0000000000, 0.0000000000, 1.0088251844]
436 def create_ACEScc(name='ACEScc',
440 cs = ColorSpace(name)
441 cs.description = 'The %s color space' % name
442 cs.equality_group = ''
447 '%s/ACEScc/ACEScsc.ACEScc_to_ACES.a1.0.0.ctl' % aces_CTL_directory,
448 # This transform gets back to the AP1 primaries
449 # Useful as the 1d LUT is only covering the transfer function
450 # The primaries switch is covered by the matrix below
451 '%s/ACEScg/ACEScsc.ACES_to_ACEScg.a1.0.0.ctl' % aces_CTL_directory
453 lut = '%s_to_ACES.spi1d' % name
455 # Remove spaces and parentheses
456 lut = lut.replace(' ', '_').replace(')', '_').replace('(', '_')
458 generate_1d_LUT_from_CTL(
459 os.path.join(lut_directory, lut),
471 cs.to_reference_transforms = []
472 cs.to_reference_transforms.append({
475 'interpolation': 'linear',
476 'direction': 'forward'
479 # AP1 primaries to AP0 primaries
480 cs.to_reference_transforms.append({
482 'matrix': mat44_from_mat33(ACES_AP1_to_AP0),
483 'direction': 'forward'
486 cs.from_reference_transforms = []
489 ACEScc = create_ACEScc()
490 config_data['colorSpaces'].append(ACEScc)
495 def create_ACESproxy(name='ACESproxy'):
496 cs = ColorSpace(name)
497 cs.description = 'The %s color space' % name
498 cs.equality_group = ''
503 '%s/ACESproxy/ACEScsc.ACESproxy10i_to_ACES.a1.0.0.ctl' % (
505 # This transform gets back to the AP1 primaries
506 # Useful as the 1d LUT is only covering the transfer function
507 # The primaries switch is covered by the matrix below
508 '%s/ACEScg/ACEScsc.ACES_to_ACEScg.a1.0.0.ctl' % aces_CTL_directory
510 lut = '%s_to_aces.spi1d' % name
512 # Remove spaces and parentheses
513 lut = lut.replace(' ', '_').replace(')', '_').replace('(', '_')
515 generate_1d_LUT_from_CTL(
516 os.path.join(lut_directory, lut),
526 cs.to_reference_transforms = []
527 cs.to_reference_transforms.append({
530 'interpolation': 'linear',
531 'direction': 'forward'
534 # AP1 primaries to AP0 primaries
535 cs.to_reference_transforms.append({
537 'matrix': mat44_from_mat33(ACES_AP1_to_AP0),
538 'direction': 'forward'
541 cs.from_reference_transforms = []
544 ACESproxy = create_ACESproxy()
545 config_data['colorSpaces'].append(ACESproxy)
550 def create_ACEScg(name='ACEScg'):
551 cs = ColorSpace(name)
552 cs.description = 'The %s color space' % name
553 cs.equality_group = ''
557 cs.to_reference_transforms = []
559 # AP1 primaries to AP0 primaries
560 cs.to_reference_transforms.append({
562 'matrix': mat44_from_mat33(ACES_AP1_to_AP0),
563 'direction': 'forward'
566 cs.from_reference_transforms = []
569 ACEScg = create_ACEScg()
570 config_data['colorSpaces'].append(ACEScg)
575 def create_ADX(bit_depth=10, name='ADX'):
576 name = '%s%s' % (name, bit_depth)
577 cs = ColorSpace(name)
578 cs.description = '%s color space - used for film scans' % name
579 cs.equality_group = ''
584 cs.bit_depth = bit_depth = ocio.Constants.BIT_DEPTH_UINT10
585 adx_to_cdd = [1023.0 / 500.0, 0.0, 0.0, 0.0,
586 0.0, 1023.0 / 500.0, 0.0, 0.0,
587 0.0, 0.0, 1023.0 / 500.0, 0.0,
589 offset = [-95.0 / 500.0, -95.0 / 500.0, -95.0 / 500.0, 0.0]
590 elif bit_depth == 16:
591 cs.bit_depth = bit_depth = ocio.Constants.BIT_DEPTH_UINT16
592 adx_to_cdd = [65535.0 / 8000.0, 0.0, 0.0, 0.0,
593 0.0, 65535.0 / 8000.0, 0.0, 0.0,
594 0.0, 0.0, 65535.0 / 8000.0, 0.0,
596 offset = [-1520.0 / 8000.0, -1520.0 / 8000.0, -1520.0 / 8000.0,
599 cs.to_reference_transforms = []
601 # Convert from ADX to Channel-Dependent Density
602 cs.to_reference_transforms.append({
604 'matrix': adx_to_cdd,
606 'direction': 'forward'
609 # Convert from Channel-Dependent Density to Channel-Independent Density
610 cs.to_reference_transforms.append({
612 'matrix': [0.75573, 0.22197, 0.02230, 0,
613 0.05901, 0.96928, -0.02829, 0,
614 0.16134, 0.07406, 0.76460, 0,
616 'direction': 'forward'
619 # Copied from Alex Fry's adx_cid_to_rle.py
620 def create_CID_to_RLE_LUT():
621 def interpolate_1D(x, xp, fp):
622 return numpy.interp(x, xp, fp)
624 LUT_1D_xp = [-0.190000000000000,
636 LUT_1D_fp = [-6.000000000000000,
648 REF_PT = ((7120.0 - 1520.0) / 8000.0 * (100.0 / 55.0) -
649 math.log(0.18, 10.0))
653 return interpolate_1D(x, LUT_1D_xp, LUT_1D_fp)
654 return (100.0 / 55.0) * x - REF_PT
656 def fit(value, from_min, from_max, to_min, to_max):
657 if from_min == from_max:
658 raise ValueError('from_min == from_max')
659 return (value - from_min) / (from_max - from_min) * (
660 to_max - to_min) + to_min
662 NUM_SAMPLES = 2 ** 12
665 for i in xrange(NUM_SAMPLES):
666 x = i / (NUM_SAMPLES - 1.0)
667 x = fit(x, 0.0, 1.0, RANGE[0], RANGE[1])
668 data.append(cid_to_rle(x))
670 lut = 'ADX_CID_to_RLE.spi1d'
671 write_SPI_1d(os.path.join(lut_directory, lut),
679 # Convert Channel Independent Density values to Relative Log Exposure
681 lut = create_CID_to_RLE_LUT()
682 cs.to_reference_transforms.append({
685 'interpolation': 'linear',
686 'direction': 'forward'
689 # Convert Relative Log Exposure values to Relative Exposure values
690 cs.to_reference_transforms.append({
693 'direction': 'inverse'
696 # Convert Relative Exposure values to ACES values
697 cs.to_reference_transforms.append({
699 'matrix': [0.72286, 0.12630, 0.15084, 0,
700 0.11923, 0.76418, 0.11659, 0,
701 0.01427, 0.08213, 0.90359, 0,
703 'direction': 'forward'
706 cs.from_reference_transforms = []
709 ADX10 = create_ADX(bit_depth=10)
710 config_data['colorSpaces'].append(ADX10)
712 ADX16 = create_ADX(bit_depth=16)
713 config_data['colorSpaces'].append(ADX16)
716 # Camera Input Transforms
719 # RED color spaces to ACES
720 red_colorspaces = red.create_colorspaces(lut_directory, lut_resolution_1d)
721 for cs in red_colorspaces:
722 config_data['colorSpaces'].append(cs)
725 canon_colorspaces = canon.create_colorspaces(lut_directory,
727 for cs in canon_colorspaces:
728 config_data['colorSpaces'].append(cs)
731 sony_colorSpaces = sony.create_colorspaces(lut_directory,
733 for cs in sony_colorSpaces:
734 config_data['colorSpaces'].append(cs)
737 arri_colorSpaces = arri.create_colorspaces(lut_directory,
739 for cs in arri_colorSpaces:
740 config_data['colorSpaces'].append(cs)
743 # Generic log transform
745 def create_generic_log(name='log',
752 lut_resolution_1d=lut_resolution_1d):
753 cs = ColorSpace(name)
754 cs.description = 'The %s color space' % name
755 cs.equality_group = name
756 cs.family = 'Utility'
760 '%s/utilities/ACESlib.OCIO_shaper_log2_to_lin_param.a1.0.0.ctl' % (
762 lut = '%s_to_aces.spi1d' % name
764 # Remove spaces and parentheses
765 lut = lut.replace(' ', '_').replace(')', '_').replace('(', '_')
767 generate_1d_LUT_from_CTL(
768 os.path.join(lut_directory, lut),
775 'middleGrey': middle_grey,
776 'minExposure': min_exposure,
777 'maxExposure': max_exposure
784 cs.to_reference_transforms = []
785 cs.to_reference_transforms.append({
788 'interpolation': 'linear',
789 'direction': 'forward'
792 cs.from_reference_transforms = []
798 def create_ACES_LMT(lmt_name,
801 lut_resolution_1d=1024,
802 lut_resolution_3d=64,
804 cs = ColorSpace('%s' % lmt_name)
805 cs.description = 'The ACES Look Transform: %s' % lmt_name
806 cs.equality_group = ''
810 pprint.pprint(lmt_values)
813 # Generate the shaper transform
817 shaper_from_ACES_CTL,
819 shaper_params) = shaper_info
821 shaper_lut = '%s_to_aces.spi1d' % shaper_name
822 if (not os.path.exists(os.path.join(lut_directory, shaper_lut))):
823 ctls = [shaper_to_ACES_CTL % aces_CTL_directory]
825 # Remove spaces and parentheses
826 shaper_lut = shaper_lut.replace(
827 ' ', '_').replace(')', '_').replace('(', '_')
829 generate_1d_LUT_from_CTL(
830 os.path.join(lut_directory, shaper_lut),
834 1.0 / shaper_input_scale,
840 shaper_OCIO_transform = {
843 'interpolation': 'linear',
844 'direction': 'inverse'
848 # Generate the forward transform
850 cs.from_reference_transforms = []
852 if 'transformCTL' in lmt_values:
854 shaper_to_ACES_CTL % aces_CTL_directory,
855 '%s/%s' % (aces_CTL_directory, lmt_values['transformCTL'])
857 lut = '%s.%s.spi3d' % (shaper_name, lmt_name)
859 # Remove spaces and parentheses
860 lut = lut.replace(' ', '_').replace(')', '_').replace('(', '_')
862 generate_3d_LUT_from_CTL(
863 os.path.join(lut_directory, lut),
867 1.0 / shaper_input_scale,
873 cs.from_reference_transforms.append(shaper_OCIO_transform)
874 cs.from_reference_transforms.append({
877 'interpolation': 'tetrahedral',
878 'direction': 'forward'
882 # Generate the inverse transform
884 cs.to_reference_transforms = []
886 if 'transformCTLInverse' in lmt_values:
889 aces_CTL_directory, odt_values['transformCTLInverse']),
890 shaper_from_ACES_CTL % aces_CTL_directory
892 lut = 'Inverse.%s.%s.spi3d' % (odt_name, shaper_name)
894 # Remove spaces and parentheses
895 lut = lut.replace(' ', '_').replace(')', '_').replace('(', '_')
897 generate_3d_LUT_from_CTL(
898 os.path.join(lut_directory, lut),
908 cs.to_reference_transforms.append({
911 'interpolation': 'tetrahedral',
912 'direction': 'forward'
915 shaper_inverse = shaper_OCIO_transform.copy()
916 shaper_inverse['direction'] = 'forward'
917 cs.to_reference_transforms.append(shaper_inverse)
925 lmt_lut_resolution_1d = max(4096, lut_resolution_1d)
926 lmt_lut_resolution_3d = max(65, lut_resolution_3d)
929 lmt_shaper_name = 'LMT Shaper'
932 'minExposure': -10.0,
935 lmt_shaper = create_generic_log(name=lmt_shaper_name,
936 middle_grey=lmt_params['middleGrey'],
937 min_exposure=lmt_params['minExposure'],
938 max_exposure=lmt_params['maxExposure'],
939 lut_resolution_1d=lmt_lut_resolution_1d)
940 config_data['colorSpaces'].append(lmt_shaper)
942 shaper_input_scale_generic_log2 = 1.0
944 # Log 2 shaper name and CTL transforms bundled up
947 '%s/utilities/ACESlib.OCIO_shaper_log2_to_lin_param.a1.0.0.ctl',
948 '%s/utilities/ACESlib.OCIO_shaper_lin_to_log2_param.a1.0.0.ctl',
949 shaper_input_scale_generic_log2,
953 sorted_LMTs = sorted(lmt_info.iteritems(), key=lambda x: x[1])
955 for lmt in sorted_LMTs:
956 (lmt_name, lmt_values) = lmt
957 cs = create_ACES_LMT(
958 lmt_values['transformUserName'],
961 lmt_lut_resolution_1d,
962 lmt_lut_resolution_3d,
964 config_data['colorSpaces'].append(cs)
967 # ACES RRT with the supplied ODT
969 def create_ACES_RRT_plus_ODT(odt_name,
972 lut_resolution_1d=1024,
973 lut_resolution_3d=64,
975 cs = ColorSpace('%s' % odt_name)
976 cs.description = '%s - %s Output Transform' % (
977 odt_values['transformUserNamePrefix'], odt_name)
978 cs.equality_group = ''
982 pprint.pprint(odt_values)
985 # Generate the shaper transform
987 # if 'shaperCTL' in odtValues:
990 shaper_from_ACES_CTL,
992 shaper_params) = shaper_info
994 if 'legalRange' in odt_values:
995 shaper_params['legalRange'] = odt_values['legalRange']
997 shaper_params['legalRange'] = 0
999 shaper_lut = '%s_to_aces.spi1d' % shaper_name
1000 if (not os.path.exists(os.path.join(lut_directory, shaper_lut))):
1001 ctls = [shaper_to_ACES_CTL % aces_CTL_directory]
1003 # Remove spaces and parentheses
1004 shaper_lut = shaper_lut.replace(
1005 ' ', '_').replace(')', '_').replace('(', '_')
1007 generate_1d_LUT_from_CTL(
1008 os.path.join(lut_directory, shaper_lut),
1012 1.0 / shaper_input_scale,
1018 shaper_OCIO_transform = {
1021 'interpolation': 'linear',
1022 'direction': 'inverse'
1026 # Generate the forward transform
1028 cs.from_reference_transforms = []
1030 if 'transformLUT' in odt_values:
1031 # Copy into the lut dir
1032 transform_LUT_file_name = os.path.basename(
1033 odt_values['transformLUT'])
1034 lut = os.path.join(lut_directory, transform_LUT_file_name)
1035 shutil.copy(odt_values['transformLUT'], lut)
1037 cs.from_reference_transforms.append(shaper_OCIO_transform)
1038 cs.from_reference_transforms.append({
1040 'path': transform_LUT_file_name,
1041 'interpolation': 'tetrahedral',
1042 'direction': 'forward'
1044 elif 'transformCTL' in odt_values:
1048 shaper_to_ACES_CTL % aces_CTL_directory,
1049 '%s/rrt/RRT.a1.0.0.ctl' % aces_CTL_directory,
1050 '%s/odt/%s' % (aces_CTL_directory, odt_values['transformCTL'])
1052 lut = '%s.RRT.a1.0.0.%s.spi3d' % (shaper_name, odt_name)
1054 # Remove spaces and parentheses
1055 lut = lut.replace(' ', '_').replace(')', '_').replace('(', '_')
1057 generate_3d_LUT_from_CTL(
1058 os.path.join(lut_directory, lut),
1063 1.0 / shaper_input_scale,
1069 cs.from_reference_transforms.append(shaper_OCIO_transform)
1070 cs.from_reference_transforms.append({
1073 'interpolation': 'tetrahedral',
1074 'direction': 'forward'
1078 # Generate the inverse transform
1080 cs.to_reference_transforms = []
1082 if 'transformLUTInverse' in odt_values:
1083 # Copy into the lut dir
1084 transform_LUT_inverse_file_name = os.path.basename(
1085 odt_values['transformLUTInverse'])
1086 lut = os.path.join(lut_directory, transform_LUT_inverse_file_name)
1087 shutil.copy(odt_values['transformLUTInverse'], lut)
1089 cs.to_reference_transforms.append({
1091 'path': transform_LUT_inverse_file_name,
1092 'interpolation': 'tetrahedral',
1093 'direction': 'forward'
1096 shaper_inverse = shaper_OCIO_transform.copy()
1097 shaper_inverse['direction'] = 'forward'
1098 cs.to_reference_transforms.append(shaper_inverse)
1099 elif 'transformCTLInverse' in odt_values:
1102 aces_CTL_directory, odt_values['transformCTLInverse']),
1103 '%s/rrt/InvRRT.a1.0.0.ctl' % aces_CTL_directory,
1104 shaper_from_ACES_CTL % aces_CTL_directory
1106 lut = 'InvRRT.a1.0.0.%s.%s.spi3d' % (odt_name, shaper_name)
1108 # Remove spaces and parentheses
1109 lut = lut.replace(' ', '_').replace(')', '_').replace('(', '_')
1111 generate_3d_LUT_from_CTL(
1112 os.path.join(lut_directory, lut),
1123 cs.to_reference_transforms.append({
1126 'interpolation': 'tetrahedral',
1127 'direction': 'forward'
1130 shaper_inverse = shaper_OCIO_transform.copy()
1131 shaper_inverse['direction'] = 'forward'
1132 cs.to_reference_transforms.append(shaper_inverse)
1137 # RRT/ODT shaper options
1142 log2_shaper_name = shaper_name
1145 'minExposure': -6.0,
1148 log2_shaper = create_generic_log(
1149 name=log2_shaper_name,
1150 middle_grey=log2_params['middleGrey'],
1151 min_exposure=log2_params['minExposure'],
1152 max_exposure=log2_params['maxExposure'])
1153 config_data['colorSpaces'].append(log2_shaper)
1155 shaper_input_scale_generic_log2 = 1.0
1157 # Log 2 shaper name and CTL transforms bundled up
1158 log2_shaper_data = [
1160 '%s/utilities/ACESlib.OCIO_shaper_log2_to_lin_param.a1.0.0.ctl',
1161 '%s/utilities/ACESlib.OCIO_shaper_lin_to_log2_param.a1.0.0.ctl',
1162 shaper_input_scale_generic_log2,
1166 shaper_data[log2_shaper_name] = log2_shaper_data
1169 # Shaper that also includes the AP1 primaries
1170 # - Needed for some LUT baking steps
1172 log2_shaper_AP1 = create_generic_log(
1173 name=log2_shaper_name,
1174 middle_grey=log2_params['middleGrey'],
1175 min_exposure=log2_params['minExposure'],
1176 max_exposure=log2_params['maxExposure'])
1177 log2_shaper_AP1.name = '%s - AP1' % log2_shaper_AP1.name
1178 # AP1 primaries to AP0 primaries
1179 log2_shaper_AP1.to_reference_transforms.append({
1181 'matrix': mat44_from_mat33(ACES_AP1_to_AP0),
1182 'direction': 'forward'
1184 config_data['colorSpaces'].append(log2_shaper_AP1)
1187 # Choose your shaper
1189 rrt_shaper_name = log2_shaper_name
1190 rrt_shaper = log2_shaper_data
1193 # RRT + ODT Combinations
1195 sorted_odts = sorted(odt_info.iteritems(), key=lambda x: x[1])
1197 for odt in sorted_odts:
1198 (odt_name, odt_values) = odt
1200 # Have to handle ODTs that can generate either legal or full output
1201 if odt_name in ['Academy.Rec2020_100nits_dim.a1.0.0',
1202 'Academy.Rec709_100nits_dim.a1.0.0',
1203 'Academy.Rec709_D60sim_100nits_dim.a1.0.0']:
1204 odt_name_legal = '%s - Legal' % odt_values['transformUserName']
1206 odt_name_legal = odt_values['transformUserName']
1208 odt_legal = odt_values.copy()
1209 odt_legal['legalRange'] = 1
1211 cs = create_ACES_RRT_plus_ODT(
1218 config_data['colorSpaces'].append(cs)
1220 # Create a display entry using this color space
1221 config_data['displays'][odt_name_legal] = {
1224 'Output Transform': cs}
1226 if odt_name in ['Academy.Rec2020_100nits_dim.a1.0.0',
1227 'Academy.Rec709_100nits_dim.a1.0.0',
1228 'Academy.Rec709_D60sim_100nits_dim.a1.0.0']:
1229 print('Generating full range ODT for %s' % odt_name)
1231 odt_name_full = '%s - Full' % odt_values['transformUserName']
1232 odt_full = odt_values.copy()
1233 odt_full['legalRange'] = 0
1235 cs_full = create_ACES_RRT_plus_ODT(
1242 config_data['colorSpaces'].append(cs_full)
1244 # Create a display entry using this color space
1245 config_data['displays'][odt_name_full] = {
1248 'Output Transform': cs_full}
1251 # Generic Matrix transform
1253 def create_generic_matrix(name='matrix',
1254 from_reference_values=[],
1255 to_reference_values=[]):
1256 cs = ColorSpace(name)
1257 cs.description = 'The %s color space' % name
1258 cs.equality_group = name
1259 cs.family = 'Utility'
1262 cs.to_reference_transforms = []
1263 if to_reference_values != []:
1264 for matrix in to_reference_values:
1265 cs.to_reference_transforms.append({
1267 'matrix': mat44_from_mat33(matrix),
1268 'direction': 'forward'
1271 cs.from_reference_transforms = []
1272 if from_reference_values != []:
1273 for matrix in from_reference_values:
1274 cs.from_reference_transforms.append({
1276 'matrix': mat44_from_mat33(matrix),
1277 'direction': 'forward'
1282 cs = create_generic_matrix('XYZ', from_reference_values=[ACES_AP0_to_XYZ])
1283 config_data['colorSpaces'].append(cs)
1285 cs = create_generic_matrix(
1286 'Linear - AP1', to_reference_values=[ACES_AP1_to_AP0])
1287 config_data['colorSpaces'].append(cs)
1289 # ACES to Linear, P3D60 primaries
1290 XYZ_to_P3D60 = [2.4027414142, -0.8974841639, -0.3880533700,
1291 -0.8325796487, 1.7692317536, 0.0237127115,
1292 0.0388233815, -0.0824996856, 1.0363685997]
1294 cs = create_generic_matrix(
1296 from_reference_values=[ACES_AP0_to_XYZ, XYZ_to_P3D60])
1297 config_data['colorSpaces'].append(cs)
1299 # ACES to Linear, P3D60 primaries
1300 XYZ_to_P3DCI = [2.7253940305, -1.0180030062, -0.4401631952,
1301 -0.7951680258, 1.6897320548, 0.0226471906,
1302 0.0412418914, -0.0876390192, 1.1009293786]
1304 cs = create_generic_matrix(
1306 from_reference_values=[ACES_AP0_to_XYZ, XYZ_to_P3DCI])
1307 config_data['colorSpaces'].append(cs)
1309 # ACES to Linear, Rec 709 primaries
1310 XYZ_to_Rec709 = [3.2409699419, -1.5373831776, -0.4986107603,
1311 -0.9692436363, 1.8759675015, 0.0415550574,
1312 0.0556300797, -0.2039769589, 1.0569715142]
1314 cs = create_generic_matrix(
1316 from_reference_values=[ACES_AP0_to_XYZ, XYZ_to_Rec709])
1317 config_data['colorSpaces'].append(cs)
1319 # ACES to Linear, Rec 2020 primaries
1320 XYZ_to_Rec2020 = [1.7166511880, -0.3556707838, -0.2533662814,
1321 -0.6666843518, 1.6164812366, 0.0157685458,
1322 0.0176398574, -0.0427706133, 0.9421031212]
1324 cs = create_generic_matrix(
1325 'Linear - Rec.2020',
1326 from_reference_values=[ACES_AP0_to_XYZ, XYZ_to_Rec2020])
1327 config_data['colorSpaces'].append(cs)
1329 print('generateLUTs - end')
1333 def generate_baked_LUTs(odt_info,
1339 lut_resolution_shaper=1024):
1346 Parameter description.
1351 Return value description.
1354 # Add the legal and full variations into this list
1355 odt_info_C = dict(odt_info)
1356 for odt_CTL_name, odt_values in odt_info.iteritems():
1357 if odt_CTL_name in ['Academy.Rec2020_100nits_dim.a1.0.0',
1358 'Academy.Rec709_100nits_dim.a1.0.0',
1359 'Academy.Rec709_D60sim_100nits_dim.a1.0.0']:
1360 odt_name = odt_values['transformUserName']
1362 odt_values_legal = dict(odt_values)
1363 odt_values_legal['transformUserName'] = '%s - Legal' % odt_name
1364 odt_info_C['%s - Legal' % odt_CTL_name] = odt_values_legal
1366 odt_values_full = dict(odt_values)
1367 odt_values_full['transformUserName'] = '%s - Full' % odt_name
1368 odt_info_C['%s - Full' % odt_CTL_name] = odt_values_full
1370 del (odt_info_C[odt_CTL_name])
1372 for odt_CTL_name, odt_values in odt_info_C.iteritems():
1373 odt_prefix = odt_values['transformUserNamePrefix']
1374 odt_name = odt_values['transformUserName']
1377 for input_space in ['ACEScc', 'ACESproxy']:
1378 args = ['--iconfig', config_path,
1380 '--inputspace', input_space]
1381 args += ['--outputspace', '%s' % odt_name]
1382 args += ['--description',
1383 '%s - %s for %s data' % (odt_prefix,
1386 args += ['--shaperspace', shaper_name,
1387 '--shapersize', str(lut_resolution_shaper)]
1388 args += ['--cubesize', str(lut_resolution_3d)]
1389 args += ['--format',
1391 '%s/photoshop/%s for %s.icc' % (baked_directory,
1395 bake_LUT = Process(description='bake a LUT',
1401 for input_space in ['ACEScc', 'ACESproxy']:
1402 args = ['--iconfig', config_path,
1404 '--inputspace', input_space]
1405 args += ['--outputspace', '%s' % odt_name]
1406 args += ['--description',
1407 '%s - %s for %s data' % (
1408 odt_prefix, odt_name, input_space)]
1409 args += ['--shaperspace', shaper_name,
1410 '--shapersize', str(lut_resolution_shaper)]
1411 args += ['--cubesize', str(lut_resolution_3d)]
1413 fargs = ['--format', 'flame', '%s/flame/%s for %s Flame.3dl' % (
1414 baked_directory, odt_name, input_space)]
1415 bake_LUT = Process(description='bake a LUT',
1417 args=(args + fargs))
1420 largs = ['--format', 'lustre', '%s/lustre/%s for %s Lustre.3dl' % (
1421 baked_directory, odt_name, input_space)]
1422 bake_LUT = Process(description='bake a LUT',
1424 args=(args + largs))
1428 for input_space in ['ACEScg', 'ACES2065-1']:
1429 args = ['--iconfig', config_path,
1431 '--inputspace', input_space]
1432 args += ['--outputspace', '%s' % odt_name]
1433 args += ['--description',
1434 '%s - %s for %s data' % (
1435 odt_prefix, odt_name, input_space)]
1436 if input_space == 'ACEScg':
1437 lin_shaper_name = '%s - AP1' % shaper_name
1439 lin_shaper_name = shaper_name
1440 args += ['--shaperspace', lin_shaper_name,
1441 '--shapersize', str(lut_resolution_shaper)]
1443 args += ['--cubesize', str(lut_resolution_3d)]
1445 margs = ['--format', 'cinespace', '%s/maya/%s for %s Maya.csp' % (
1446 baked_directory, odt_name, input_space)]
1447 bake_LUT = Process(description='bake a LUT',
1449 args=(args + margs))
1452 hargs = ['--format', 'houdini',
1453 '%s/houdini/%s for %s Houdini.lut' % (
1454 baked_directory, odt_name, input_space)]
1455 bake_LUT = Process(description='bake a LUT',
1457 args=(args + hargs))
1461 def create_config_dir(config_directory, bake_secondary_LUTs):
1468 Parameter description.
1473 Return value description.
1476 dirs = [config_directory, '%s/luts' % config_directory]
1477 if bake_secondary_LUTs:
1478 dirs.extend(['%s/baked' % config_directory,
1479 '%s/baked/flame' % config_directory,
1480 '%s/baked/photoshop' % config_directory,
1481 '%s/baked/houdini' % config_directory,
1482 '%s/baked/lustre' % config_directory,
1483 '%s/baked/maya' % config_directory])
1486 not os.path.exists(d) and os.mkdir(d)
1489 def get_transform_info(ctl_transform):
1496 Parameter description.
1501 Return value description.
1504 # TODO: Use *with* statement.
1505 fp = open(ctl_transform, 'rb')
1508 lines = fp.readlines()
1510 # Grab transform ID and User Name
1511 transform_ID = lines[1][3:].split('<')[1].split('>')[1].strip()
1512 # print(transformID)
1513 transform_user_name = '-'.join(
1514 lines[2][3:].split('<')[1].split('>')[1].split('-')[1:]).strip()
1515 transform_user_name_prefix = (
1516 lines[2][3:].split('<')[1].split('>')[1].split('-')[0].strip())
1517 # print(transformUserName)
1520 return transform_ID, transform_user_name, transform_user_name_prefix
1523 def get_ODT_info(aces_CTL_directory):
1527 For versions after WGR9.
1532 Parameter description.
1537 Return value description.
1540 # TODO: Investigate usage of *files_walker* definition here.
1541 # Credit to Alex Fry for the original approach here
1542 odt_dir = os.path.join(aces_CTL_directory, 'odt')
1544 for dir_name, subdir_list, file_list in os.walk(odt_dir):
1545 for fname in file_list:
1546 all_odt.append((os.path.join(dir_name, fname)))
1548 odt_CTLs = [x for x in all_odt if
1549 ('InvODT' not in x) and (os.path.split(x)[-1][0] != '.')]
1555 for odt_CTL in odt_CTLs:
1556 odt_tokens = os.path.split(odt_CTL)
1559 # Handle nested directories
1560 odt_path_tokens = os.path.split(odt_tokens[-2])
1561 odt_dir = odt_path_tokens[-1]
1562 while odt_path_tokens[-2][-3:] != 'odt':
1563 odt_path_tokens = os.path.split(odt_path_tokens[-2])
1564 odt_dir = os.path.join(odt_path_tokens[-1], odt_dir)
1567 # print('odtDir : %s' % odtDir)
1568 transform_CTL = odt_tokens[-1]
1569 # print(transformCTL)
1570 odt_name = string.join(transform_CTL.split('.')[1:-1], '.')
1573 # Find id, user name and user name prefix
1575 transform_user_name,
1576 transform_user_name_prefix) = get_transform_info(
1577 '%s/odt/%s/%s' % (aces_CTL_directory, odt_dir, transform_CTL))
1580 transform_CTL_inverse = 'InvODT.%s.ctl' % odt_name
1581 if not os.path.exists(
1582 os.path.join(odt_tokens[-2], transform_CTL_inverse)):
1583 transform_CTL_inverse = None
1584 # print(transformCTLInverse)
1586 # Add to list of ODTs
1588 odts[odt_name]['transformCTL'] = os.path.join(odt_dir, transform_CTL)
1589 if transform_CTL_inverse != None:
1590 odts[odt_name]['transformCTLInverse'] = os.path.join(
1591 odt_dir, transform_CTL_inverse)
1593 odts[odt_name]['transformID'] = transform_ID
1594 odts[odt_name]['transformUserNamePrefix'] = transform_user_name_prefix
1595 odts[odt_name]['transformUserName'] = transform_user_name
1597 print('ODT : %s' % odt_name)
1598 print('\tTransform ID : %s' % transform_ID)
1599 print('\tTransform User Name Prefix : %s' % transform_user_name_prefix)
1600 print('\tTransform User Name : %s' % transform_user_name)
1601 print('\tForward ctl : %s' % (
1602 odts[odt_name]['transformCTL']))
1603 if 'transformCTLInverse' in odts[odt_name]:
1604 print('\tInverse ctl : %s' % (
1605 odts[odt_name]['transformCTLInverse']))
1607 print('\tInverse ctl : %s' % 'None')
1614 def get_LMT_info(aces_CTL_directory):
1618 For versions after WGR9.
1623 Parameter description.
1628 Return value description.
1631 # TODO: Investigate refactoring with previous definition.
1633 # Credit to Alex Fry for the original approach here
1634 lmt_dir = os.path.join(aces_CTL_directory, 'lmt')
1636 for dir_name, subdir_list, file_list in os.walk(lmt_dir):
1637 for fname in file_list:
1638 all_lmt.append((os.path.join(dir_name, fname)))
1640 lmt_CTLs = [x for x in all_lmt if
1641 ('InvLMT' not in x) and ('README' not in x) and (
1642 os.path.split(x)[-1][0] != '.')]
1648 for lmt_CTL in lmt_CTLs:
1649 lmt_tokens = os.path.split(lmt_CTL)
1652 # Handle nested directories
1653 lmt_path_tokens = os.path.split(lmt_tokens[-2])
1654 lmt_dir = lmt_path_tokens[-1]
1655 while lmt_path_tokens[-2][-3:] != 'ctl':
1656 lmt_path_tokens = os.path.split(lmt_path_tokens[-2])
1657 lmt_dir = os.path.join(lmt_path_tokens[-1], lmt_dir)
1660 # print('lmtDir : %s' % lmtDir)
1661 transform_CTL = lmt_tokens[-1]
1662 # print(transformCTL)
1663 lmt_name = string.join(transform_CTL.split('.')[1:-1], '.')
1666 # Find id, user name and user name prefix
1668 transform_user_name,
1669 transform_user_name_prefix) = get_transform_info(
1670 '%s/%s/%s' % (aces_CTL_directory, lmt_dir, transform_CTL))
1673 transform_CTL_inverse = 'InvLMT.%s.ctl' % lmt_name
1674 if not os.path.exists(
1675 os.path.join(lmt_tokens[-2], transform_CTL_inverse)):
1676 transform_CTL_inverse = None
1677 # print(transformCTLInverse)
1679 # Add to list of LMTs
1681 lmts[lmt_name]['transformCTL'] = os.path.join(lmt_dir, transform_CTL)
1682 if transform_CTL_inverse != None:
1683 # TODO: Check unresolved *odt_name* referemce.
1684 lmts[odt_name]['transformCTLInverse'] = os.path.join(
1685 lmt_dir, transform_CTL_inverse)
1687 lmts[lmt_name]['transformID'] = transform_ID
1688 lmts[lmt_name]['transformUserNamePrefix'] = transform_user_name_prefix
1689 lmts[lmt_name]['transformUserName'] = transform_user_name
1691 print('LMT : %s' % lmt_name)
1692 print('\tTransform ID : %s' % transform_ID)
1693 print('\tTransform User Name Prefix : %s' % transform_user_name_prefix)
1694 print('\tTransform User Name : %s' % transform_user_name)
1695 print('\t Forward ctl : %s' % lmts[lmt_name]['transformCTL'])
1696 if 'transformCTLInverse' in lmts[lmt_name]:
1697 print('\t Inverse ctl : %s' % (
1698 lmts[lmt_name]['transformCTLInverse']))
1700 print('\t Inverse ctl : %s' % 'None')
1707 def create_ACES_config(aces_CTL_directory,
1709 lut_resolution_1d=4096,
1710 lut_resolution_3d=64,
1711 bake_secondary_LUTs=True,
1714 Creates the ACES configuration.
1719 Parameter description.
1724 Return value description.
1727 # Get ODT names and CTL paths
1728 odt_info = get_ODT_info(aces_CTL_directory)
1730 # Get ODT names and CTL paths
1731 lmt_info = get_LMT_info(aces_CTL_directory)
1734 create_config_dir(config_directory, bake_secondary_LUTs)
1736 # Generate config data and LUTs for different transforms
1737 lut_directory = '%s/luts' % config_directory
1738 shaper_name = 'Output Shaper'
1739 config_data = generate_LUTs(odt_info,
1748 # Create the config using the generated LUTs
1749 print('Creating generic config')
1750 config = create_config(config_data)
1753 # Write the config to disk
1754 write_config(config, '%s/config.ocio' % config_directory)
1756 # Create a config that will work well with Nuke using the previously
1758 print('Creating Nuke-specific config')
1759 nuke_config = create_config(config_data, nuke=True)
1762 # Write the config to disk
1763 write_config(nuke_config, '%s/nuke_config.ocio' % config_directory)
1765 # Bake secondary LUTs using the config
1766 if bake_secondary_LUTs:
1767 generate_baked_LUTs(odt_info,
1769 '%s/baked' % config_directory,
1770 '%s/config.ocio' % config_directory,
1785 Parameter description.
1790 Return value description.
1795 p = optparse.OptionParser(description='An OCIO config generation script',
1796 prog='createACESConfig',
1797 version='createACESConfig 0.1',
1798 usage='%prog [options]')
1799 p.add_option('--acesCTLDir', '-a', default=os.environ.get(
1800 'ACES_OCIO_CTL_DIRECTORY', None))
1801 p.add_option('--configDir', '-c', default=os.environ.get(
1802 'ACES_OCIO_CONFIGURATION_DIRECTORY', None))
1803 p.add_option('--lutResolution1d', default=4096)
1804 p.add_option('--lutResolution3d', default=64)
1805 p.add_option('--dontBakeSecondaryLUTs', action='store_true')
1806 p.add_option('--keepTempImages', action='store_true')
1808 options, arguments = p.parse_args()
1813 aces_CTL_directory = options.acesCTLDir
1814 config_directory = options.configDir
1815 lut_resolution_1d = int(options.lutResolution1d)
1816 lut_resolution_3d = int(options.lutResolution3d)
1817 bake_secondary_LUTs = not (options.dontBakeSecondaryLUTs)
1818 cleanup_temp_images = not (options.keepTempImages)
1821 args_start = sys.argv.index('--') + 1
1822 args = sys.argv[args_start:]
1824 args_start = len(sys.argv) + 1
1827 print('command line : \n%s\n' % ' '.join(sys.argv))
1829 # TODO: Use assertion and mention environment variables.
1830 if not aces_CTL_directory:
1831 print('process: No ACES CTL directory specified')
1833 if not config_directory:
1834 print('process: No configuration directory specified')
1837 # Generate the configuration
1839 return create_ACES_config(aces_CTL_directory,
1843 bake_secondary_LUTs,
1844 cleanup_temp_images)
1847 if __name__ == '__main__':