2 # -*- coding: utf-8 -*-
5 Defines objects creating the *ACES* configuration.
16 import PyOpenColorIO as ocio
18 import aces_ocio.create_arri_colorspaces as arri
19 import aces_ocio.create_canon_colorspaces as canon
20 import aces_ocio.create_red_colorspaces as red
21 import aces_ocio.create_sony_colorspaces as sony
22 from aces_ocio.generate_lut import (
23 generate_1d_LUT_from_CTL,
24 generate_3d_LUT_from_CTL,
26 from aces_ocio.process import Process
27 from aces_ocio.utilities import ColorSpace, mat44_from_mat33, sanitize_path
29 __author__ = 'ACES Developers'
30 __copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
32 __maintainer__ = 'ACES Developers'
33 __email__ = 'aces@oscars.org'
34 __status__ = 'Production'
36 __all__ = ['ACES_OCIO_CTL_DIRECTORY_ENVIRON',
37 'ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON',
38 'set_config_default_roles',
40 'generate_OCIO_transform',
43 'generate_baked_LUTs',
51 ACES_OCIO_CTL_DIRECTORY_ENVIRON = 'ACES_OCIO_CTL_DIRECTORY'
52 ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON = 'ACES_OCIO_CONFIGURATION_DIRECTORY'
55 def set_config_default_roles(config,
66 Sets given *OCIO* configuration default roles.
72 color_picking : str or unicode
73 Color picking role title.
74 color_timing : str or unicode
75 Color timing role title.
76 compositing_log : str or unicode
77 Compositing log role title.
80 default : str or unicode
82 matte_paint : str or unicode
83 Matte painting role title.
84 reference : str or unicode
86 scene_linear : str or unicode
87 Scene linear role title.
88 texture_paint : str or unicode
89 Texture painting role title.
98 config.setRole(ocio.Constants.ROLE_COLOR_PICKING, color_picking)
100 config.setRole(ocio.Constants.ROLE_COLOR_TIMING, color_timing)
102 config.setRole(ocio.Constants.ROLE_COMPOSITING_LOG, compositing_log)
104 config.setRole(ocio.Constants.ROLE_DATA, data)
106 config.setRole(ocio.Constants.ROLE_DEFAULT, default)
108 config.setRole(ocio.Constants.ROLE_MATTE_PAINT, matte_paint)
110 config.setRole(ocio.Constants.ROLE_REFERENCE, reference)
112 config.setRole(ocio.Constants.ROLE_SCENE_LINEAR, scene_linear)
114 config.setRole(ocio.Constants.ROLE_TEXTURE_PAINT, texture_paint)
119 def write_config(config, config_path, sanity_check=True):
121 Writes the configuration to given path.
126 Parameter description.
131 Return value description.
139 print 'Configuration was not written due to a failed Sanity Check'
142 with open(config_path, mode='w') as fp:
143 fp.write(config.serialize())
146 def generate_OCIO_transform(transforms):
153 Parameter description.
158 Return value description.
161 interpolation_options = {
162 'linear': ocio.Constants.INTERP_LINEAR,
163 'nearest': ocio.Constants.INTERP_NEAREST,
164 'tetrahedral': ocio.Constants.INTERP_TETRAHEDRAL
166 direction_options = {
167 'forward': ocio.Constants.TRANSFORM_DIR_FORWARD,
168 'inverse': ocio.Constants.TRANSFORM_DIR_INVERSE
173 for transform in transforms:
174 if transform['type'] == 'lutFile':
175 ocio_transform = ocio.FileTransform(
176 src=transform['path'],
177 interpolation=interpolation_options[
178 transform['interpolation']],
179 direction=direction_options[transform['direction']])
180 ocio_transforms.append(ocio_transform)
181 elif transform['type'] == 'matrix':
182 ocio_transform = ocio.MatrixTransform()
183 # MatrixTransform member variables can't be initialized directly
184 # and must be set individually.
185 ocio_transform.setMatrix(transform['matrix'])
187 if 'offset' in transform:
188 ocio_transform.setOffset(transform['offset'])
190 if 'direction' in transform:
191 ocio_transform.setDirection(
192 direction_options[transform['direction']])
194 ocio_transforms.append(ocio_transform)
195 elif transform['type'] == 'exponent':
196 ocio_transform = ocio.ExponentTransform()
197 ocio_transform.setValue(transform['value'])
198 ocio_transforms.append(ocio_transform)
199 elif transform['type'] == 'log':
200 ocio_transform = ocio.LogTransform(
201 base=transform['base'],
202 direction=direction_options[transform['direction']])
204 ocio_transforms.append(ocio_transform)
206 print('Ignoring unknown transform type : %s' % transform['type'])
208 if len(ocio_transforms) > 1:
209 group_transform = ocio.GroupTransform()
210 for transform in ocio_transforms:
211 group_transform.push_back(transform)
212 transform = group_transform
214 transform = ocio_transforms[0]
219 def create_config(config_data, nuke=False):
226 Parameter description.
231 Return value description.
234 # Creating the *OCIO* configuration.
235 config = ocio.Config()
237 # Setting configuration overall values.
238 config.setDescription('An ACES config generated from python')
239 config.setSearchPath('luts')
241 # Defining the reference colorspace.
242 reference_data = config_data['referenceColorSpace']
243 print('Adding the reference color space : %s' % reference_data.name)
245 reference = ocio.ColorSpace(
246 name=reference_data.name,
247 bitDepth=reference_data.bit_depth,
248 description=reference_data.description,
249 equalityGroup=reference_data.equality_group,
250 family=reference_data.family,
251 isData=reference_data.is_data,
252 allocation=reference_data.allocation_type,
253 allocationVars=reference_data.allocation_vars)
255 config.addColorSpace(reference)
257 # Creating the remaining colorspaces.
258 for colorspace in sorted(config_data['colorSpaces']):
259 print('Creating new color space : %s' % colorspace.name)
261 ocio_colorspace = ocio.ColorSpace(
262 name=colorspace.name,
263 bitDepth=colorspace.bit_depth,
264 description=colorspace.description,
265 equalityGroup=colorspace.equality_group,
266 family=colorspace.family,
267 isData=colorspace.is_data,
268 allocation=colorspace.allocation_type,
269 allocationVars=colorspace.allocation_vars)
271 if colorspace.to_reference_transforms:
272 print('Generating To-Reference transforms')
273 ocio_transform = generate_OCIO_transform(
274 colorspace.to_reference_transforms)
275 ocio_colorspace.setTransform(
277 ocio.Constants.COLORSPACE_DIR_TO_REFERENCE)
279 if colorspace.from_reference_transforms:
280 print('Generating From-Reference transforms')
281 ocio_transform = generate_OCIO_transform(
282 colorspace.from_reference_transforms)
283 ocio_colorspace.setTransform(
285 ocio.Constants.COLORSPACE_DIR_FROM_REFERENCE)
287 config.addColorSpace(ocio_colorspace)
291 # Defining the *views* and *displays*.
295 # Defining a *generic* *display* and *view* setup.
297 for display, view_list in config_data['displays'].iteritems():
298 for view_name, colorspace in view_list.iteritems():
299 config.addDisplay(display, view_name, colorspace.name)
300 if not (view_name in views):
301 views.append(view_name)
302 displays.append(display)
303 # Defining the *Nuke* specific set of *views* and *displays*.
305 for display, view_list in config_data['displays'].iteritems():
306 for view_name, colorspace in view_list.iteritems():
307 if view_name == 'Output Transform':
309 config.addDisplay(display, view_name, colorspace.name)
310 if not (view_name in views):
311 views.append(view_name)
312 displays.append(display)
314 config.addDisplay('linear', 'View', 'ACES2065-1')
315 displays.append('linear')
316 config.addDisplay('log', 'View', 'ACEScc')
317 displays.append('log')
319 # Setting the active *displays* and *views*.
320 config.setActiveDisplays(','.join(sorted(displays)))
321 config.setActiveViews(','.join(views))
323 set_config_default_roles(
325 color_picking=reference.getName(),
326 color_timing=reference.getName(),
327 compositing_log=reference.getName(),
328 data=reference.getName(),
329 default=reference.getName(),
330 matte_paint=reference.getName(),
331 reference=reference.getName(),
332 scene_linear=reference.getName(),
333 texture_paint=reference.getName())
340 def generate_LUTs(odt_info,
345 lut_resolution_1d=4096,
346 lut_resolution_3d=64,
354 Parameter description.
359 Colorspaces and transforms converting between those colorspaces and
360 the reference colorspace, *ACES*.
363 print('generateLUTs - begin')
366 # Defining the reference colorspace.
367 ACES = ColorSpace('ACES2065-1')
369 'The Academy Color Encoding System reference color space')
370 ACES.equality_group = ''
373 ACES.allocation_type = ocio.Constants.ALLOCATION_LG2
374 ACES.allocation_vars = [-15, 6]
376 config_data['referenceColorSpace'] = ACES
378 config_data['displays'] = {}
379 config_data['colorSpaces'] = []
381 # Matrix converting *ACES AP1* primaries to *AP0*.
382 ACES_AP1_to_AP0 = [0.6954522414, 0.1406786965, 0.1638690622,
383 0.0447945634, 0.8596711185, 0.0955343182,
384 -0.0055258826, 0.0040252103, 1.0015006723]
386 # Matrix converting *ACES AP0* primaries to *XYZ*.
387 ACES_AP0_to_XYZ = [0.9525523959, 0.0000000000, 0.0000936786,
388 0.3439664498, 0.7281660966, -0.0721325464,
389 0.0000000000, 0.0000000000, 1.0088251844]
391 # -------------------------------------------------------------------------
393 # -------------------------------------------------------------------------
394 def create_ACEScc(name='ACEScc',
398 cs = ColorSpace(name)
399 cs.description = 'The %s color space' % name
400 cs.equality_group = ''
404 ctls = [os.path.join(aces_CTL_directory,
406 'ACEScsc.ACEScc_to_ACES.a1.0.0.ctl'),
407 # This transform gets back to the *AP1* primaries.
408 # Useful as the 1d LUT is only covering the transfer function.
409 # The primaries switch is covered by the matrix below:
410 os.path.join(aces_CTL_directory,
412 'ACEScsc.ACES_to_ACEScg.a1.0.0.ctl')]
413 lut = '%s_to_ACES.spi1d' % name
415 lut = sanitize_path(lut)
417 generate_1d_LUT_from_CTL(
418 os.path.join(lut_directory, lut),
430 cs.to_reference_transforms = []
431 cs.to_reference_transforms.append({
434 'interpolation': 'linear',
435 'direction': 'forward'})
437 # *AP1* primaries to *AP0* primaries.
438 cs.to_reference_transforms.append({
440 'matrix': mat44_from_mat33(ACES_AP1_to_AP0),
441 'direction': 'forward'})
443 cs.from_reference_transforms = []
446 ACEScc = create_ACEScc()
447 config_data['colorSpaces'].append(ACEScc)
449 # -------------------------------------------------------------------------
451 # -------------------------------------------------------------------------
452 def create_ACESproxy(name='ACESproxy'):
453 cs = ColorSpace(name)
454 cs.description = 'The %s color space' % name
455 cs.equality_group = ''
459 ctls = [os.path.join(aces_CTL_directory,
461 'ACEScsc.ACESproxy10i_to_ACES.a1.0.0.ctl'),
462 # This transform gets back to the *AP1* primaries.
463 # Useful as the 1d LUT is only covering the transfer function.
464 # The primaries switch is covered by the matrix below:
465 os.path.join(aces_CTL_directory,
467 'ACEScsc.ACES_to_ACEScg.a1.0.0.ctl')]
468 lut = '%s_to_aces.spi1d' % name
470 lut = sanitize_path(lut)
472 generate_1d_LUT_from_CTL(
473 os.path.join(lut_directory, lut),
483 cs.to_reference_transforms = []
484 cs.to_reference_transforms.append({
487 'interpolation': 'linear',
488 'direction': 'forward'
491 # *AP1* primaries to *AP0* primaries.
492 cs.to_reference_transforms.append({
494 'matrix': mat44_from_mat33(ACES_AP1_to_AP0),
495 'direction': 'forward'
498 cs.from_reference_transforms = []
501 ACESproxy = create_ACESproxy()
502 config_data['colorSpaces'].append(ACESproxy)
504 # -------------------------------------------------------------------------
506 # -------------------------------------------------------------------------
507 def create_ACEScg(name='ACEScg'):
508 cs = ColorSpace(name)
509 cs.description = 'The %s color space' % name
510 cs.equality_group = ''
514 cs.to_reference_transforms = []
516 # *AP1* primaries to *AP0* primaries.
517 cs.to_reference_transforms.append({
519 'matrix': mat44_from_mat33(ACES_AP1_to_AP0),
520 'direction': 'forward'
523 cs.from_reference_transforms = []
526 ACEScg = create_ACEScg()
527 config_data['colorSpaces'].append(ACEScg)
529 # -------------------------------------------------------------------------
531 # -------------------------------------------------------------------------
532 def create_ADX(bit_depth=10, name='ADX'):
533 name = '%s%s' % (name, bit_depth)
534 cs = ColorSpace(name)
535 cs.description = '%s color space - used for film scans' % name
536 cs.equality_group = ''
541 cs.bit_depth = ocio.Constants.BIT_DEPTH_UINT10
542 adx_to_cdd = [1023.0 / 500.0, 0.0, 0.0, 0.0,
543 0.0, 1023.0 / 500.0, 0.0, 0.0,
544 0.0, 0.0, 1023.0 / 500.0, 0.0,
546 offset = [-95.0 / 500.0, -95.0 / 500.0, -95.0 / 500.0, 0.0]
547 elif bit_depth == 16:
548 cs.bit_depth = ocio.Constants.BIT_DEPTH_UINT16
549 adx_to_cdd = [65535.0 / 8000.0, 0.0, 0.0, 0.0,
550 0.0, 65535.0 / 8000.0, 0.0, 0.0,
551 0.0, 0.0, 65535.0 / 8000.0, 0.0,
553 offset = [-1520.0 / 8000.0, -1520.0 / 8000.0, -1520.0 / 8000.0,
556 cs.to_reference_transforms = []
558 # Converting from *ADX* to *Channel-Dependent Density*.
559 cs.to_reference_transforms.append({
561 'matrix': adx_to_cdd,
563 'direction': 'forward'
566 # Convert from Channel-Dependent Density to Channel-Independent Density
567 cs.to_reference_transforms.append({
569 'matrix': [0.75573, 0.22197, 0.02230, 0,
570 0.05901, 0.96928, -0.02829, 0,
571 0.16134, 0.07406, 0.76460, 0,
573 'direction': 'forward'
576 # Copied from *Alex Fry*'s *adx_cid_to_rle.py*
577 def create_CID_to_RLE_LUT():
579 def interpolate_1D(x, xp, fp):
580 return numpy.interp(x, xp, fp)
582 LUT_1D_xp = [-0.190000000000000,
594 LUT_1D_fp = [-6.000000000000000,
606 REF_PT = ((7120.0 - 1520.0) / 8000.0 * (100.0 / 55.0) -
607 math.log(0.18, 10.0))
611 return interpolate_1D(x, LUT_1D_xp, LUT_1D_fp)
612 return (100.0 / 55.0) * x - REF_PT
614 def fit(value, from_min, from_max, to_min, to_max):
615 if from_min == from_max:
616 raise ValueError('from_min == from_max')
617 return (value - from_min) / (from_max - from_min) * (
618 to_max - to_min) + to_min
620 NUM_SAMPLES = 2 ** 12
623 for i in xrange(NUM_SAMPLES):
624 x = i / (NUM_SAMPLES - 1.0)
625 x = fit(x, 0.0, 1.0, RANGE[0], RANGE[1])
626 data.append(cid_to_rle(x))
628 lut = 'ADX_CID_to_RLE.spi1d'
629 write_SPI_1d(os.path.join(lut_directory, lut),
637 # Converting *Channel Independent Density* values to
638 # *Relative Log Exposure* values.
639 lut = create_CID_to_RLE_LUT()
640 cs.to_reference_transforms.append({
643 'interpolation': 'linear',
644 'direction': 'forward'})
646 # Converting *Relative Log Exposure* values to
647 # *Relative Exposure* values.
648 cs.to_reference_transforms.append({
651 'direction': 'inverse'})
653 # Convert *Relative Exposure* values to *ACES* values.
654 cs.to_reference_transforms.append({
656 'matrix': [0.72286, 0.12630, 0.15084, 0,
657 0.11923, 0.76418, 0.11659, 0,
658 0.01427, 0.08213, 0.90359, 0,
660 'direction': 'forward'})
662 cs.from_reference_transforms = []
665 ADX10 = create_ADX(bit_depth=10)
666 config_data['colorSpaces'].append(ADX10)
668 ADX16 = create_ADX(bit_depth=16)
669 config_data['colorSpaces'].append(ADX16)
671 # -------------------------------------------------------------------------
672 # *Camera Input Transforms*
673 # -------------------------------------------------------------------------
675 # *RED* colorspaces to *ACES*.
676 red_colorspaces = red.create_colorspaces(lut_directory, lut_resolution_1d)
677 for cs in red_colorspaces:
678 config_data['colorSpaces'].append(cs)
680 # *Canon-Log* to *ACES*.
681 canon_colorspaces = canon.create_colorspaces(lut_directory,
683 for cs in canon_colorspaces:
684 config_data['colorSpaces'].append(cs)
687 sony_colorSpaces = sony.create_colorspaces(lut_directory,
689 for cs in sony_colorSpaces:
690 config_data['colorSpaces'].append(cs)
693 arri_colorSpaces = arri.create_colorspaces(lut_directory,
695 for cs in arri_colorSpaces:
696 config_data['colorSpaces'].append(cs)
698 # -------------------------------------------------------------------------
699 # *Generic Log Transform*
700 # -------------------------------------------------------------------------
701 def create_generic_log(name='log',
708 lut_resolution_1d=lut_resolution_1d):
709 cs = ColorSpace(name)
710 cs.description = 'The %s color space' % name
711 cs.equality_group = name
712 cs.family = 'Utility'
715 ctls = [os.path.join(
718 'ACESlib.OCIO_shaper_log2_to_lin_param.a1.0.0.ctl')]
719 lut = '%s_to_aces.spi1d' % name
721 lut = sanitize_path(lut)
723 generate_1d_LUT_from_CTL(
724 os.path.join(lut_directory, lut),
730 {'middleGrey': middle_grey,
731 'minExposure': min_exposure,
732 'maxExposure': max_exposure},
738 cs.to_reference_transforms = []
739 cs.to_reference_transforms.append({
742 'interpolation': 'linear',
743 'direction': 'forward'})
745 cs.from_reference_transforms = []
748 # -------------------------------------------------------------------------
750 # -------------------------------------------------------------------------
751 def create_ACES_LMT(lmt_name,
754 lut_resolution_1d=1024,
755 lut_resolution_3d=64,
757 cs = ColorSpace('%s' % lmt_name)
758 cs.description = 'The ACES Look Transform: %s' % lmt_name
759 cs.equality_group = ''
763 pprint.pprint(lmt_values)
765 # Generating the *shaper* transform.
768 shaper_from_ACES_CTL,
770 shaper_params) = shaper_info
772 shaper_lut = '%s_to_aces.spi1d' % shaper_name
773 if not os.path.exists(os.path.join(lut_directory, shaper_lut)):
774 ctls = [shaper_to_ACES_CTL % aces_CTL_directory]
776 shaper_lut = sanitize_path(shaper_lut)
778 generate_1d_LUT_from_CTL(
779 os.path.join(lut_directory, shaper_lut),
783 1.0 / shaper_input_scale,
789 shaper_OCIO_transform = {
792 'interpolation': 'linear',
793 'direction': 'inverse'}
795 # Generating the forward transform.
796 cs.from_reference_transforms = []
798 if 'transformCTL' in lmt_values:
799 ctls = [shaper_to_ACES_CTL % aces_CTL_directory,
800 os.path.join(aces_CTL_directory,
801 lmt_values['transformCTL'])]
802 lut = '%s.%s.spi3d' % (shaper_name, lmt_name)
804 lut = sanitize_path(lut)
806 generate_3d_LUT_from_CTL(
807 os.path.join(lut_directory, lut),
811 1.0 / shaper_input_scale,
817 cs.from_reference_transforms.append(shaper_OCIO_transform)
818 cs.from_reference_transforms.append({
821 'interpolation': 'tetrahedral',
822 'direction': 'forward'
825 # Generating the inverse transform.
826 cs.to_reference_transforms = []
828 if 'transformCTLInverse' in lmt_values:
829 ctls = [os.path.join(aces_CTL_directory,
830 odt_values['transformCTLInverse']),
831 shaper_from_ACES_CTL % aces_CTL_directory]
832 lut = 'Inverse.%s.%s.spi3d' % (odt_name, shaper_name)
834 lut = sanitize_path(lut)
836 generate_3d_LUT_from_CTL(
837 os.path.join(lut_directory, lut),
847 cs.to_reference_transforms.append({
850 'interpolation': 'tetrahedral',
851 'direction': 'forward'})
853 shaper_inverse = shaper_OCIO_transform.copy()
854 shaper_inverse['direction'] = 'forward'
855 cs.to_reference_transforms.append(shaper_inverse)
859 # -------------------------------------------------------------------------
861 # -------------------------------------------------------------------------
863 lmt_lut_resolution_1d = max(4096, lut_resolution_1d)
864 lmt_lut_resolution_3d = max(65, lut_resolution_3d)
866 # Defining the *Log 2* shaper.
867 lmt_shaper_name = 'LMT Shaper'
870 'minExposure': -10.0,
873 lmt_shaper = create_generic_log(name=lmt_shaper_name,
874 middle_grey=lmt_params['middleGrey'],
875 min_exposure=lmt_params['minExposure'],
876 max_exposure=lmt_params['maxExposure'],
877 lut_resolution_1d=lmt_lut_resolution_1d)
878 config_data['colorSpaces'].append(lmt_shaper)
880 shaper_input_scale_generic_log2 = 1.0
882 # *Log 2* shaper name and *CTL* transforms bundled up.
887 'ACESlib.OCIO_shaper_log2_to_lin_param.a1.0.0.ctl'),
890 'ACESlib.OCIO_shaper_lin_to_log2_param.a1.0.0.ctl'),
891 shaper_input_scale_generic_log2,
894 sorted_LMTs = sorted(lmt_info.iteritems(), key=lambda x: x[1])
896 for lmt in sorted_LMTs:
897 (lmt_name, lmt_values) = lmt
898 cs = create_ACES_LMT(
899 lmt_values['transformUserName'],
902 lmt_lut_resolution_1d,
903 lmt_lut_resolution_3d,
905 config_data['colorSpaces'].append(cs)
907 # -------------------------------------------------------------------------
908 # *ACES RRT* with supplied *ODT*.
909 # -------------------------------------------------------------------------
910 def create_ACES_RRT_plus_ODT(odt_name,
913 lut_resolution_1d=1024,
914 lut_resolution_3d=64,
916 cs = ColorSpace('%s' % odt_name)
917 cs.description = '%s - %s Output Transform' % (
918 odt_values['transformUserNamePrefix'], odt_name)
919 cs.equality_group = ''
923 pprint.pprint(odt_values)
925 # Generating the *shaper* transform.
928 shaper_from_ACES_CTL,
930 shaper_params) = shaper_info
932 if 'legalRange' in odt_values:
933 shaper_params['legalRange'] = odt_values['legalRange']
935 shaper_params['legalRange'] = 0
937 shaper_lut = '%s_to_aces.spi1d' % shaper_name
938 if not os.path.exists(os.path.join(lut_directory, shaper_lut)):
939 ctls = [shaper_to_ACES_CTL % aces_CTL_directory]
941 shaper_lut = sanitize_path(shaper_lut)
943 generate_1d_LUT_from_CTL(
944 os.path.join(lut_directory, shaper_lut),
948 1.0 / shaper_input_scale,
954 shaper_OCIO_transform = {
957 'interpolation': 'linear',
958 'direction': 'inverse'}
960 # Generating the *forward* transform.
961 cs.from_reference_transforms = []
963 if 'transformLUT' in odt_values:
964 transform_LUT_file_name = os.path.basename(
965 odt_values['transformLUT'])
966 lut = os.path.join(lut_directory, transform_LUT_file_name)
967 shutil.copy(odt_values['transformLUT'], lut)
969 cs.from_reference_transforms.append(shaper_OCIO_transform)
970 cs.from_reference_transforms.append({
972 'path': transform_LUT_file_name,
973 'interpolation': 'tetrahedral',
974 'direction': 'forward'})
975 elif 'transformCTL' in odt_values:
977 shaper_to_ACES_CTL % aces_CTL_directory,
978 os.path.join(aces_CTL_directory,
981 os.path.join(aces_CTL_directory,
983 odt_values['transformCTL'])]
984 lut = '%s.RRT.a1.0.0.%s.spi3d' % (shaper_name, odt_name)
986 lut = sanitize_path(lut)
988 generate_3d_LUT_from_CTL(
989 os.path.join(lut_directory, lut),
994 1.0 / shaper_input_scale,
1000 cs.from_reference_transforms.append(shaper_OCIO_transform)
1001 cs.from_reference_transforms.append({
1004 'interpolation': 'tetrahedral',
1005 'direction': 'forward'})
1007 # Generating the *inverse* transform.
1008 cs.to_reference_transforms = []
1010 if 'transformLUTInverse' in odt_values:
1011 transform_LUT_inverse_file_name = os.path.basename(
1012 odt_values['transformLUTInverse'])
1013 lut = os.path.join(lut_directory, transform_LUT_inverse_file_name)
1014 shutil.copy(odt_values['transformLUTInverse'], lut)
1016 cs.to_reference_transforms.append({
1018 'path': transform_LUT_inverse_file_name,
1019 'interpolation': 'tetrahedral',
1020 'direction': 'forward'})
1022 shaper_inverse = shaper_OCIO_transform.copy()
1023 shaper_inverse['direction'] = 'forward'
1024 cs.to_reference_transforms.append(shaper_inverse)
1025 elif 'transformCTLInverse' in odt_values:
1026 ctls = [os.path.join(aces_CTL_directory,
1028 odt_values['transformCTLInverse']),
1029 os.path.join(aces_CTL_directory,
1031 'InvRRT.a1.0.0.ctl'),
1032 shaper_from_ACES_CTL % aces_CTL_directory]
1033 lut = 'InvRRT.a1.0.0.%s.%s.spi3d' % (odt_name, shaper_name)
1035 lut = sanitize_path(lut)
1037 generate_3d_LUT_from_CTL(
1038 os.path.join(lut_directory, lut),
1049 cs.to_reference_transforms.append({
1052 'interpolation': 'tetrahedral',
1053 'direction': 'forward'})
1055 shaper_inverse = shaper_OCIO_transform.copy()
1056 shaper_inverse['direction'] = 'forward'
1057 cs.to_reference_transforms.append(shaper_inverse)
1061 # -------------------------------------------------------------------------
1062 # *RRT / ODT* Shaper Options
1063 # -------------------------------------------------------------------------
1066 # Defining the *Log 2* shaper.
1067 log2_shaper_name = shaper_name
1070 'minExposure': -6.0,
1073 log2_shaper = create_generic_log(
1074 name=log2_shaper_name,
1075 middle_grey=log2_params['middleGrey'],
1076 min_exposure=log2_params['minExposure'],
1077 max_exposure=log2_params['maxExposure'])
1078 config_data['colorSpaces'].append(log2_shaper)
1080 shaper_input_scale_generic_log2 = 1.0
1082 # *Log 2* shaper name and *CTL* transforms bundled up.
1083 log2_shaper_data = [
1087 'ACESlib.OCIO_shaper_log2_to_lin_param.a1.0.0.ctl'),
1090 'ACESlib.OCIO_shaper_lin_to_log2_param.a1.0.0.ctl'),
1091 shaper_input_scale_generic_log2,
1094 shaper_data[log2_shaper_name] = log2_shaper_data
1096 # Shaper that also includes the AP1 primaries.
1097 # Needed for some LUT baking steps.
1098 log2_shaper_AP1 = create_generic_log(
1099 name=log2_shaper_name,
1100 middle_grey=log2_params['middleGrey'],
1101 min_exposure=log2_params['minExposure'],
1102 max_exposure=log2_params['maxExposure'])
1103 log2_shaper_AP1.name = '%s - AP1' % log2_shaper_AP1.name
1105 # *AP1* primaries to *AP0* primaries.
1106 log2_shaper_AP1.to_reference_transforms.append({
1108 'matrix': mat44_from_mat33(ACES_AP1_to_AP0),
1109 'direction': 'forward'
1111 config_data['colorSpaces'].append(log2_shaper_AP1)
1113 rrt_shaper = log2_shaper_data
1115 # *RRT + ODT* combinations.
1116 sorted_odts = sorted(odt_info.iteritems(), key=lambda x: x[1])
1118 for odt in sorted_odts:
1119 (odt_name, odt_values) = odt
1121 # Handling *ODTs* that can generate either *legal* or *full* output.
1122 if odt_name in ['Academy.Rec2020_100nits_dim.a1.0.0',
1123 'Academy.Rec709_100nits_dim.a1.0.0',
1124 'Academy.Rec709_D60sim_100nits_dim.a1.0.0']:
1125 odt_name_legal = '%s - Legal' % odt_values['transformUserName']
1127 odt_name_legal = odt_values['transformUserName']
1129 odt_legal = odt_values.copy()
1130 odt_legal['legalRange'] = 1
1132 cs = create_ACES_RRT_plus_ODT(
1139 config_data['colorSpaces'].append(cs)
1141 config_data['displays'][odt_name_legal] = {
1144 'Output Transform': cs}
1146 if odt_name in ['Academy.Rec2020_100nits_dim.a1.0.0',
1147 'Academy.Rec709_100nits_dim.a1.0.0',
1148 'Academy.Rec709_D60sim_100nits_dim.a1.0.0']:
1149 print('Generating full range ODT for %s' % odt_name)
1151 odt_name_full = '%s - Full' % odt_values['transformUserName']
1152 odt_full = odt_values.copy()
1153 odt_full['legalRange'] = 0
1155 cs_full = create_ACES_RRT_plus_ODT(
1162 config_data['colorSpaces'].append(cs_full)
1164 config_data['displays'][odt_name_full] = {
1167 'Output Transform': cs_full}
1169 # -------------------------------------------------------------------------
1170 # Generic Matrix transform
1171 # -------------------------------------------------------------------------
1172 def create_generic_matrix(name='matrix',
1173 from_reference_values=[],
1174 to_reference_values=[]):
1175 cs = ColorSpace(name)
1176 cs.description = 'The %s color space' % name
1177 cs.equality_group = name
1178 cs.family = 'Utility'
1181 cs.to_reference_transforms = []
1182 if to_reference_values:
1183 for matrix in to_reference_values:
1184 cs.to_reference_transforms.append({
1186 'matrix': mat44_from_mat33(matrix),
1187 'direction': 'forward'})
1189 cs.from_reference_transforms = []
1190 if from_reference_values:
1191 for matrix in from_reference_values:
1192 cs.from_reference_transforms.append({
1194 'matrix': mat44_from_mat33(matrix),
1195 'direction': 'forward'})
1199 cs = create_generic_matrix('XYZ', from_reference_values=[ACES_AP0_to_XYZ])
1200 config_data['colorSpaces'].append(cs)
1202 cs = create_generic_matrix(
1203 'Linear - AP1', to_reference_values=[ACES_AP1_to_AP0])
1204 config_data['colorSpaces'].append(cs)
1206 # *ACES* to *Linear*, *P3D60* primaries.
1207 XYZ_to_P3D60 = [2.4027414142, -0.8974841639, -0.3880533700,
1208 -0.8325796487, 1.7692317536, 0.0237127115,
1209 0.0388233815, -0.0824996856, 1.0363685997]
1211 cs = create_generic_matrix(
1213 from_reference_values=[ACES_AP0_to_XYZ, XYZ_to_P3D60])
1214 config_data['colorSpaces'].append(cs)
1216 # *ACES* to *Linear*, *P3DCI* primaries.
1217 XYZ_to_P3DCI = [2.7253940305, -1.0180030062, -0.4401631952,
1218 -0.7951680258, 1.6897320548, 0.0226471906,
1219 0.0412418914, -0.0876390192, 1.1009293786]
1221 cs = create_generic_matrix(
1223 from_reference_values=[ACES_AP0_to_XYZ, XYZ_to_P3DCI])
1224 config_data['colorSpaces'].append(cs)
1226 # *ACES* to *Linear*, *Rec. 709* primaries.
1227 XYZ_to_Rec709 = [3.2409699419, -1.5373831776, -0.4986107603,
1228 -0.9692436363, 1.8759675015, 0.0415550574,
1229 0.0556300797, -0.2039769589, 1.0569715142]
1231 cs = create_generic_matrix(
1233 from_reference_values=[ACES_AP0_to_XYZ, XYZ_to_Rec709])
1234 config_data['colorSpaces'].append(cs)
1236 # *ACES* to *Linear*, *Rec. 2020* primaries.
1237 XYZ_to_Rec2020 = [1.7166511880, -0.3556707838, -0.2533662814,
1238 -0.6666843518, 1.6164812366, 0.0157685458,
1239 0.0176398574, -0.0427706133, 0.9421031212]
1241 cs = create_generic_matrix(
1242 'Linear - Rec.2020',
1243 from_reference_values=[ACES_AP0_to_XYZ, XYZ_to_Rec2020])
1244 config_data['colorSpaces'].append(cs)
1246 print('generateLUTs - end')
1250 def generate_baked_LUTs(odt_info,
1256 lut_resolution_shaper=1024):
1263 Parameter description.
1268 Return value description.
1271 odt_info_C = dict(odt_info)
1272 for odt_CTL_name, odt_values in odt_info.iteritems():
1273 if odt_CTL_name in ['Academy.Rec2020_100nits_dim.a1.0.0',
1274 'Academy.Rec709_100nits_dim.a1.0.0',
1275 'Academy.Rec709_D60sim_100nits_dim.a1.0.0']:
1276 odt_name = odt_values['transformUserName']
1278 odt_values_legal = dict(odt_values)
1279 odt_values_legal['transformUserName'] = '%s - Legal' % odt_name
1280 odt_info_C['%s - Legal' % odt_CTL_name] = odt_values_legal
1282 odt_values_full = dict(odt_values)
1283 odt_values_full['transformUserName'] = '%s - Full' % odt_name
1284 odt_info_C['%s - Full' % odt_CTL_name] = odt_values_full
1286 del (odt_info_C[odt_CTL_name])
1288 for odt_CTL_name, odt_values in odt_info_C.iteritems():
1289 odt_prefix = odt_values['transformUserNamePrefix']
1290 odt_name = odt_values['transformUserName']
1293 for input_space in ['ACEScc', 'ACESproxy']:
1294 args = ['--iconfig', config_path,
1296 '--inputspace', input_space]
1297 args += ['--outputspace', '%s' % odt_name]
1298 args += ['--description',
1299 '%s - %s for %s data' % (odt_prefix,
1302 args += ['--shaperspace', shaper_name,
1303 '--shapersize', str(lut_resolution_shaper)]
1304 args += ['--cubesize', str(lut_resolution_3d)]
1305 args += ['--format',
1307 os.path.join(baked_directory,
1309 '%s for %s.icc' % (odt_name, input_space))]
1311 bake_LUT = Process(description='bake a LUT',
1317 for input_space in ['ACEScc', 'ACESproxy']:
1318 args = ['--iconfig', config_path,
1320 '--inputspace', input_space]
1321 args += ['--outputspace', '%s' % odt_name]
1322 args += ['--description',
1323 '%s - %s for %s data' % (
1324 odt_prefix, odt_name, input_space)]
1325 args += ['--shaperspace', shaper_name,
1326 '--shapersize', str(lut_resolution_shaper)]
1327 args += ['--cubesize', str(lut_resolution_3d)]
1329 fargs = ['--format',
1334 '%s for %s Flame.3dl' % (odt_name, input_space))]
1335 bake_LUT = Process(description='bake a LUT',
1337 args=(args + fargs))
1340 largs = ['--format',
1345 '%s for %s Lustre.3dl' % (odt_name, input_space))]
1346 bake_LUT = Process(description='bake a LUT',
1348 args=(args + largs))
1352 for input_space in ['ACEScg', 'ACES2065-1']:
1353 args = ['--iconfig', config_path,
1355 '--inputspace', input_space]
1356 args += ['--outputspace', '%s' % odt_name]
1357 args += ['--description',
1358 '%s - %s for %s data' % (
1359 odt_prefix, odt_name, input_space)]
1360 if input_space == 'ACEScg':
1361 lin_shaper_name = '%s - AP1' % shaper_name
1363 lin_shaper_name = shaper_name
1364 args += ['--shaperspace', lin_shaper_name,
1365 '--shapersize', str(lut_resolution_shaper)]
1367 args += ['--cubesize', str(lut_resolution_3d)]
1369 margs = ['--format',
1374 '%s for %s Maya.csp' % (odt_name, input_space))]
1375 bake_LUT = Process(description='bake a LUT',
1377 args=(args + margs))
1380 hargs = ['--format',
1385 '%s for %s Houdini.lut' % (odt_name, input_space))]
1386 bake_LUT = Process(description='bake a LUT',
1388 args=(args + hargs))
1392 def create_config_dir(config_directory, bake_secondary_LUTs):
1399 Parameter description.
1404 Return value description.
1407 dirs = [config_directory, os.path.join(config_directory, 'luts')]
1408 if bake_secondary_LUTs:
1409 dirs.extend([os.path.join(config_directory, 'baked'),
1410 os.path.join(config_directory, 'baked', 'flame'),
1411 os.path.join(config_directory, 'baked', 'photoshop'),
1412 os.path.join(config_directory, 'baked', 'houdini'),
1413 os.path.join(config_directory, 'baked', 'lustre'),
1414 os.path.join(config_directory, 'baked', 'maya')])
1417 not os.path.exists(d) and os.mkdir(d)
1420 def get_transform_info(ctl_transform):
1427 Parameter description.
1432 Return value description.
1435 with open(ctl_transform, 'rb') as fp:
1436 lines = fp.readlines()
1438 # Retrieving the *transform ID* and *User Name*.
1439 transform_id = lines[1][3:].split('<')[1].split('>')[1].strip()
1440 transform_user_name = '-'.join(
1441 lines[2][3:].split('<')[1].split('>')[1].split('-')[1:]).strip()
1442 transform_user_name_prefix = (
1443 lines[2][3:].split('<')[1].split('>')[1].split('-')[0].strip())
1445 return transform_id, transform_user_name, transform_user_name_prefix
1448 def get_ODT_info(aces_CTL_directory):
1452 For versions after WGR9.
1457 Parameter description.
1462 Return value description.
1465 # TODO: Investigate usage of *files_walker* definition here.
1466 # Credit to *Alex Fry* for the original approach here.
1467 odt_dir = os.path.join(aces_CTL_directory, 'odt')
1469 for dir_name, subdir_list, file_list in os.walk(odt_dir):
1470 for fname in file_list:
1471 all_odt.append((os.path.join(dir_name, fname)))
1473 odt_CTLs = [x for x in all_odt if
1474 ('InvODT' not in x) and (os.path.split(x)[-1][0] != '.')]
1478 for odt_CTL in odt_CTLs:
1479 odt_tokens = os.path.split(odt_CTL)
1481 # Handling nested directories.
1482 odt_path_tokens = os.path.split(odt_tokens[-2])
1483 odt_dir = odt_path_tokens[-1]
1484 while odt_path_tokens[-2][-3:] != 'odt':
1485 odt_path_tokens = os.path.split(odt_path_tokens[-2])
1486 odt_dir = os.path.join(odt_path_tokens[-1], odt_dir)
1488 # Building full name,
1489 transform_CTL = odt_tokens[-1]
1490 odt_name = string.join(transform_CTL.split('.')[1:-1], '.')
1492 # Finding id, user name and user name prefix.
1494 transform_user_name,
1495 transform_user_name_prefix) = get_transform_info(
1496 os.path.join(aces_CTL_directory, 'odt', odt_dir, transform_CTL))
1499 transform_CTL_inverse = 'InvODT.%s.ctl' % odt_name
1500 if not os.path.exists(
1501 os.path.join(odt_tokens[-2], transform_CTL_inverse)):
1502 transform_CTL_inverse = None
1504 # Add to list of ODTs
1506 odts[odt_name]['transformCTL'] = os.path.join(odt_dir, transform_CTL)
1507 if transform_CTL_inverse != None:
1508 odts[odt_name]['transformCTLInverse'] = os.path.join(
1509 odt_dir, transform_CTL_inverse)
1511 odts[odt_name]['transformID'] = transform_ID
1512 odts[odt_name]['transformUserNamePrefix'] = transform_user_name_prefix
1513 odts[odt_name]['transformUserName'] = transform_user_name
1515 forward_CTL = odts[odt_name]['transformCTL']
1517 print('ODT : %s' % odt_name)
1518 print('\tTransform ID : %s' % transform_ID)
1519 print('\tTransform User Name Prefix : %s' % transform_user_name_prefix)
1520 print('\tTransform User Name : %s' % transform_user_name)
1521 print('\tForward ctl : %s' % forward_CTL)
1522 if 'transformCTLInverse' in odts[odt_name]:
1523 inverse_CTL = odts[odt_name]['transformCTLInverse']
1524 print('\tInverse ctl : %s' % inverse_CTL)
1526 print('\tInverse ctl : %s' % 'None')
1533 def get_LMT_info(aces_CTL_directory):
1537 For versions after WGR9.
1542 Parameter description.
1547 Return value description.
1550 # TODO: Investigate refactoring with previous definition.
1552 # Credit to Alex Fry for the original approach here
1553 lmt_dir = os.path.join(aces_CTL_directory, 'lmt')
1555 for dir_name, subdir_list, file_list in os.walk(lmt_dir):
1556 for fname in file_list:
1557 all_lmt.append((os.path.join(dir_name, fname)))
1559 lmt_CTLs = [x for x in all_lmt if
1560 ('InvLMT' not in x) and ('README' not in x) and (
1561 os.path.split(x)[-1][0] != '.')]
1565 for lmt_CTL in lmt_CTLs:
1566 lmt_tokens = os.path.split(lmt_CTL)
1568 # Handlimg nested directories.
1569 lmt_path_tokens = os.path.split(lmt_tokens[-2])
1570 lmt_dir = lmt_path_tokens[-1]
1571 while lmt_path_tokens[-2][-3:] != 'ctl':
1572 lmt_path_tokens = os.path.split(lmt_path_tokens[-2])
1573 lmt_dir = os.path.join(lmt_path_tokens[-1], lmt_dir)
1575 # Building full name.
1576 transform_CTL = lmt_tokens[-1]
1577 lmt_name = string.join(transform_CTL.split('.')[1:-1], '.')
1579 # Finding id, user name and user name prefix.
1581 transform_user_name,
1582 transform_user_name_prefix) = get_transform_info(
1583 os.path.join(aces_CTL_directory, lmt_dir, transform_CTL))
1586 transform_CTL_inverse = 'InvLMT.%s.ctl' % lmt_name
1587 if not os.path.exists(
1588 os.path.join(lmt_tokens[-2], transform_CTL_inverse)):
1589 transform_CTL_inverse = None
1592 lmts[lmt_name]['transformCTL'] = os.path.join(lmt_dir, transform_CTL)
1593 if transform_CTL_inverse != None:
1594 lmts[lmt_name]['transformCTLInverse'] = os.path.join(
1595 lmt_dir, transform_CTL_inverse)
1597 lmts[lmt_name]['transformID'] = transform_ID
1598 lmts[lmt_name]['transformUserNamePrefix'] = transform_user_name_prefix
1599 lmts[lmt_name]['transformUserName'] = transform_user_name
1601 forward_CTL = lmts[lmt_name]['transformCTL']
1603 print('LMT : %s' % lmt_name)
1604 print('\tTransform ID : %s' % transform_ID)
1605 print('\tTransform User Name Prefix : %s' % transform_user_name_prefix)
1606 print('\tTransform User Name : %s' % transform_user_name)
1607 print('\t Forward ctl : %s' % forward_CTL)
1608 if 'transformCTLInverse' in lmts[lmt_name]:
1609 inverse_CTL = lmts[lmt_name]['transformCTLInverse']
1610 print('\t Inverse ctl : %s' % inverse_CTL)
1612 print('\t Inverse ctl : %s' % 'None')
1619 def create_ACES_config(aces_CTL_directory,
1621 lut_resolution_1d=4096,
1622 lut_resolution_3d=64,
1623 bake_secondary_LUTs=True,
1626 Creates the ACES configuration.
1631 Parameter description.
1636 Return value description.
1639 odt_info = get_ODT_info(aces_CTL_directory)
1640 lmt_info = get_LMT_info(aces_CTL_directory)
1642 create_config_dir(config_directory, bake_secondary_LUTs)
1644 lut_directory = os.path.join(config_directory, 'luts')
1645 shaper_name = 'Output Shaper'
1646 config_data = generate_LUTs(odt_info,
1655 print('Creating "generic" config')
1656 config = create_config(config_data)
1659 write_config(config,
1660 os.path.join(config_directory, 'config.ocio'))
1662 print('Creating "Nuke" config')
1663 nuke_config = create_config(config_data, nuke=True)
1666 write_config(nuke_config,
1667 os.path.join(config_directory, 'nuke_config.ocio'))
1669 if bake_secondary_LUTs:
1670 generate_baked_LUTs(odt_info,
1672 os.path.join(config_directory, 'baked'),
1673 os.path.join(config_directory, 'config.ocio'),
1688 Parameter description.
1693 Return value description.
1698 p = optparse.OptionParser(description='An OCIO config generation script',
1699 prog='createACESConfig',
1700 version='createACESConfig 0.1',
1701 usage='%prog [options]')
1702 p.add_option('--acesCTLDir', '-a', default=os.environ.get(
1703 ACES_OCIO_CTL_DIRECTORY_ENVIRON, None))
1704 p.add_option('--configDir', '-c', default=os.environ.get(
1705 ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON, None))
1706 p.add_option('--lutResolution1d', default=4096)
1707 p.add_option('--lutResolution3d', default=64)
1708 p.add_option('--dontBakeSecondaryLUTs', action='store_true')
1709 p.add_option('--keepTempImages', action='store_true')
1711 options, arguments = p.parse_args()
1713 aces_CTL_directory = options.acesCTLDir
1714 config_directory = options.configDir
1715 lut_resolution_1d = int(options.lutResolution1d)
1716 lut_resolution_3d = int(options.lutResolution3d)
1717 bake_secondary_LUTs = not options.dontBakeSecondaryLUTs
1718 cleanup_temp_images = not options.keepTempImages
1720 # TODO: Investigate the following statements.
1722 args_start = sys.argv.index('--') + 1
1723 args = sys.argv[args_start:]
1725 args_start = len(sys.argv) + 1
1728 print('command line : \n%s\n' % ' '.join(sys.argv))
1730 assert aces_CTL_directory is not None, (
1731 'process: No "{0}" environment variable defined or no "ACES CTL" '
1732 'directory specified'.format(
1733 ACES_OCIO_CTL_DIRECTORY_ENVIRON))
1735 assert config_directory is not None, (
1736 'process: No "{0}" environment variable defined or no configuration '
1737 'directory specified'.format(
1738 ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON))
1740 return create_ACES_config(aces_CTL_directory,
1744 bake_secondary_LUTs,
1745 cleanup_temp_images)
1748 if __name__ == '__main__':