Roles now have some assignments
[OpenColorIO-Configs.git] / aces_1.0.0 / python / aces_ocio / create_aces_config.py
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3
4 """
5 Defines objects creating the *ACES* configuration.
6 """
7
8 from __future__ import division
9
10 import os
11 import sys
12
13 import PyOpenColorIO as ocio
14
15 import aces_ocio.create_aces_colorspaces as aces
16 import aces_ocio.create_arri_colorspaces as arri
17 import aces_ocio.create_canon_colorspaces as canon
18 import aces_ocio.create_panasonic_colorspaces as panasonic
19 import aces_ocio.create_red_colorspaces as red
20 import aces_ocio.create_sony_colorspaces as sony
21 import aces_ocio.create_general_colorspaces as general
22
23 from aces_ocio.process import Process
24
25 __author__ = 'ACES Developers'
26 __copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
27 __license__ = ''
28 __maintainer__ = 'ACES Developers'
29 __email__ = 'aces@oscars.org'
30 __status__ = 'Production'
31
32 __all__ = ['ACES_OCIO_CTL_DIRECTORY_ENVIRON',
33            'ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON',
34            'set_config_default_roles',
35            'write_config',
36            'generate_OCIO_transform',
37            'add_colorspace_alias',
38            'create_config',
39            'generate_LUTs',
40            'generate_baked_LUTs',
41            'create_config_dir',
42            'create_ACES_config',
43            'main']
44
45 ACES_OCIO_CTL_DIRECTORY_ENVIRON = 'ACES_OCIO_CTL_DIRECTORY'
46 ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON = 'ACES_OCIO_CONFIGURATION_DIRECTORY'
47
48
49 def set_config_default_roles(config,
50                              color_picking='',
51                              color_timing='',
52                              compositing_log='',
53                              data='',
54                              default='',
55                              matte_paint='',
56                              reference='',
57                              scene_linear='',
58                              texture_paint=''):
59     """
60     Sets given *OCIO* configuration default roles.
61
62     Parameters
63     ----------
64     config : config
65         *OCIO* configuration.
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.
72     data : str or unicode
73         Data role title.
74     default : str or unicode
75         Default role title.
76     matte_paint : str or unicode
77         Matte painting role title.
78     reference : str or unicode
79         Reference role title.
80     scene_linear : str or unicode
81         Scene linear role title.
82     texture_paint : str or unicode
83         Texture painting role title.
84
85     Returns
86     -------
87     bool
88          Definition success.
89     """
90
91     if color_picking:
92         config.setRole(ocio.Constants.ROLE_COLOR_PICKING, color_picking)
93     if color_timing:
94         config.setRole(ocio.Constants.ROLE_COLOR_TIMING, color_timing)
95     if compositing_log:
96         config.setRole(ocio.Constants.ROLE_COMPOSITING_LOG, compositing_log)
97     if data:
98         config.setRole(ocio.Constants.ROLE_DATA, data)
99     if default:
100         config.setRole(ocio.Constants.ROLE_DEFAULT, default)
101     if matte_paint:
102         config.setRole(ocio.Constants.ROLE_MATTE_PAINT, matte_paint)
103     if reference:
104         config.setRole(ocio.Constants.ROLE_REFERENCE, reference)
105     if scene_linear:
106         config.setRole(ocio.Constants.ROLE_SCENE_LINEAR, scene_linear)
107     if texture_paint:
108         config.setRole(ocio.Constants.ROLE_TEXTURE_PAINT, texture_paint)
109
110     return True
111
112
113 def write_config(config, config_path, sanity_check=True):
114     """
115     Writes the configuration to given path.
116
117     Parameters
118     ----------
119     parameter : type
120         Parameter description.
121
122     Returns
123     -------
124     type
125          Return value description.
126     """
127
128     if sanity_check:
129         try:
130             config.sanityCheck()
131         except Exception, e:
132             print e
133             print 'Configuration was not written due to a failed Sanity Check'
134             return
135
136     with open(config_path, mode='w') as fp:
137         fp.write(config.serialize())
138
139
140 def generate_OCIO_transform(transforms):
141     """
142     Object description.
143
144     Parameters
145     ----------
146     parameter : type
147         Parameter description.
148
149     Returns
150     -------
151     type
152          Return value description.
153     """
154
155     interpolation_options = {
156         'linear': ocio.Constants.INTERP_LINEAR,
157         'nearest': ocio.Constants.INTERP_NEAREST,
158         'tetrahedral': ocio.Constants.INTERP_TETRAHEDRAL}
159
160     direction_options = {
161         'forward': ocio.Constants.TRANSFORM_DIR_FORWARD,
162         'inverse': ocio.Constants.TRANSFORM_DIR_INVERSE}
163
164     ocio_transforms = []
165
166     for transform in transforms:
167
168         # lutFile transform
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)
176
177         # matrix 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'])
183
184             if 'offset' in transform:
185                 ocio_transform.setOffset(transform['offset'])
186
187             if 'direction' in transform:
188                 ocio_transform.setDirection(
189                     direction_options[transform['direction']])
190
191             ocio_transforms.append(ocio_transform)
192
193         # exponent transform
194         elif transform['type'] == 'exponent':
195             ocio_transform = ocio.ExponentTransform()
196             ocio_transform.setValue(transform['value'])
197             ocio_transforms.append(ocio_transform)
198
199         # log transform
200         elif transform['type'] == 'log':
201             ocio_transform = ocio.LogTransform(
202                 base=transform['base'],
203                 direction=direction_options[transform['direction']])
204
205             ocio_transforms.append(ocio_transform)
206
207         # color space transform
208         elif transform['type'] == 'colorspace':
209             ocio_transform = ocio.ColorSpaceTransform(src=transform['src'],
210                                                       dst=transform['dst'],
211                                                       direction=
212                                                       direction_options[
213                                                           'forward'])
214             ocio_transforms.append(ocio_transform)
215         # unknown type
216         else:
217             print("Ignoring unknown transform type : %s" % transform['type'])
218
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
224     else:
225         transform = ocio_transforms[0]
226
227     return transform
228
229
230 def add_colorspace_alias(config,
231                          reference_colorspace,
232                          colorspace,
233                          colorspace_alias_names):
234     """
235     Object description.
236
237     Parameters
238     ----------
239     parameter : type
240         Parameter description.
241
242     Returns
243     -------
244     type
245          Return value description.
246     """
247
248     for alias_name in colorspace_alias_names:
249         if alias_name == colorspace.name.lower():
250             return
251
252         print('Adding alias colorspace space %s, alias to %s' % (
253             alias_name, colorspace.name))
254
255         compact_family_name = 'Aliases'
256
257         ocio_colorspace_alias = ocio.ColorSpace(
258             name=alias_name,
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)
266
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(
275                 ocio_transform,
276                 ocio.Constants.COLORSPACE_DIR_TO_REFERENCE)
277
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(
286                 ocio_transform,
287                 ocio.Constants.COLORSPACE_DIR_FROM_REFERENCE)
288
289         config.addColorSpace(ocio_colorspace_alias)
290
291
292 def create_config(config_data, nuke=False):
293     """
294     Object description.
295
296     Parameters
297     ----------
298     parameter : type
299         Parameter description.
300
301     Returns
302     -------
303     type
304          Return value description.
305     """
306
307     # Creating the *OCIO* configuration.
308     config = ocio.Config()
309
310     # Setting configuration overall values.
311     config.setDescription('An ACES config generated from python')
312     config.setSearchPath('luts')
313
314     # Defining the reference colorspace.
315     reference_data = config_data['referenceColorSpace']
316     print('Adding the reference color space : %s' % reference_data.name)
317
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)
327
328     config.addColorSpace(reference)
329
330     # Add alias
331     if reference_data.aliases != []:
332         add_colorspace_alias(config, reference_data,
333                              reference_data, reference_data.aliases)
334
335     print("")
336
337     # Creating the remaining colorspaces.
338     for colorspace in sorted(config_data['colorSpaces']):
339         print('Creating new color space : %s' % colorspace.name)
340
341         ocio_colorspace = ocio.ColorSpace(
342             name=colorspace.name,
343             bitDepth=colorspace.bit_depth,
344             description=colorspace.description,
345             equalityGroup=colorspace.equality_group,
346             family=colorspace.family,
347             isData=colorspace.is_data,
348             allocation=colorspace.allocation_type,
349             allocationVars=colorspace.allocation_vars)
350
351         if colorspace.to_reference_transforms:
352             print('Generating To-Reference transforms')
353             ocio_transform = generate_OCIO_transform(
354                 colorspace.to_reference_transforms)
355             ocio_colorspace.setTransform(
356                 ocio_transform,
357                 ocio.Constants.COLORSPACE_DIR_TO_REFERENCE)
358
359         if colorspace.from_reference_transforms:
360             print('Generating From-Reference transforms')
361             ocio_transform = generate_OCIO_transform(
362                 colorspace.from_reference_transforms)
363             ocio_colorspace.setTransform(
364                 ocio_transform,
365                 ocio.Constants.COLORSPACE_DIR_FROM_REFERENCE)
366
367         config.addColorSpace(ocio_colorspace)
368
369         #
370         # Add alias to normal colorspace, using compact name
371         #
372         if colorspace.aliases != []:
373             add_colorspace_alias(config, reference_data,
374                                  colorspace, colorspace.aliases)
375
376         print('')
377
378     # Defining the *views* and *displays*.
379     displays = []
380     views = []
381
382     # Defining a *generic* *display* and *view* setup.
383     if not nuke:
384         for display, view_list in config_data['displays'].iteritems():
385             for view_name, colorspace in view_list.iteritems():
386                 config.addDisplay(display, view_name, colorspace.name)
387                 if not (view_name in views):
388                     views.append(view_name)
389             displays.append(display)
390
391     # Defining the *Nuke* specific set of *views* and *displays*.
392     else:
393         for display, view_list in config_data['displays'].iteritems():
394             for view_name, colorspace in view_list.iteritems():
395                 if view_name == 'Output Transform':
396                     view_name = 'View'
397                     config.addDisplay(display, view_name, colorspace.name)
398                     if not (view_name in views):
399                         views.append(view_name)
400             displays.append(display)
401
402         linear_display_space_name = config_data['linearDisplaySpace'].name
403         log_display_space_name = config_data['logDisplaySpace'].name
404
405         config.addDisplay('linear', 'View', linear_display_space_name)
406         displays.append('linear')
407         config.addDisplay('log', 'View', log_display_space_name)
408         displays.append('log')
409
410     # Setting the active *displays* and *views*.
411     config.setActiveDisplays(','.join(sorted(displays)))
412     config.setActiveViews(','.join(views))
413
414     set_config_default_roles(
415         config,
416         color_picking=config_data['roles']['color_picking'],
417         color_timing=config_data['roles']['color_timing'],
418         compositing_log=config_data['roles']['compositing_log'],
419         data=config_data['roles']['data'],
420         default=config_data['roles']['default'],
421         matte_paint=config_data['roles']['matte_paint'],
422         reference=config_data['roles']['reference'],
423         scene_linear=config_data['roles']['scene_linear'],
424         texture_paint=config_data['roles']['texture_paint'])
425
426     config.sanityCheck()
427
428     return config
429
430
431 def generate_LUTs(odt_info,
432                   lmt_info,
433                   shaper_name,
434                   aces_ctl_directory,
435                   lut_directory,
436                   lut_resolution_1d=4096,
437                   lut_resolution_3d=64,
438                   cleanup=True):
439     """
440     Object description.
441
442     Parameters
443     ----------
444     parameter : type
445         Parameter description.
446
447     Returns
448     -------
449     dict
450          Colorspaces and transforms converting between those colorspaces and
451          the reference colorspace, *ACES*.
452     """
453
454     print('generateLUTs - begin')
455     config_data = {}
456
457     # Initialize a few variables
458     config_data['displays'] = {}
459     config_data['colorSpaces'] = []
460
461     # -------------------------------------------------------------------------
462     # *ACES Color Spaces*
463     # -------------------------------------------------------------------------
464
465     # *ACES* colorspaces
466     (aces_reference,
467      aces_colorspaces,
468      aces_displays,
469      aces_log_display_space,
470      aces_roles) = aces.create_colorspaces(aces_ctl_directory,
471                                            lut_directory,
472                                            lut_resolution_1d,
473                                            lut_resolution_3d,
474                                            lmt_info,
475                                            odt_info,
476                                            shaper_name,
477                                            cleanup)
478
479     config_data['referenceColorSpace'] = aces_reference
480     config_data['roles'] = aces_roles
481
482     for cs in aces_colorspaces:
483         config_data['colorSpaces'].append(cs)
484
485     for name, data in aces_displays.iteritems():
486         config_data['displays'][name] = data
487
488     config_data['linearDisplaySpace'] = aces_reference
489     config_data['logDisplaySpace'] = aces_log_display_space
490
491     # -------------------------------------------------------------------------
492     # *Camera Input Transforms*
493     # -------------------------------------------------------------------------
494
495     # *ARRI Log-C* to *ACES*.
496     arri_colorSpaces = arri.create_colorspaces(lut_directory,
497                                                lut_resolution_1d)
498     for cs in arri_colorSpaces:
499         config_data['colorSpaces'].append(cs)
500
501     # *Canon-Log* to *ACES*.
502     canon_colorspaces = canon.create_colorspaces(lut_directory,
503                                                  lut_resolution_1d)
504     for cs in canon_colorspaces:
505         config_data['colorSpaces'].append(cs)
506
507     # *Panasonic V-Log* to *ACES*.
508     panasonic_colorSpaces = panasonic.create_colorspaces(lut_directory,
509                                                          lut_resolution_1d)
510     for cs in panasonic_colorSpaces:
511         config_data['colorSpaces'].append(cs)
512
513     # *RED* colorspaces to *ACES*.
514     red_colorspaces = red.create_colorspaces(lut_directory,
515                                              lut_resolution_1d)
516     for cs in red_colorspaces:
517         config_data['colorSpaces'].append(cs)
518
519     # *S-Log* to *ACES*.
520     sony_colorSpaces = sony.create_colorspaces(lut_directory,
521                                                lut_resolution_1d)
522     for cs in sony_colorSpaces:
523         config_data['colorSpaces'].append(cs)
524
525     # -------------------------------------------------------------------------
526     # General Color Spaces
527     # -------------------------------------------------------------------------
528     general_colorSpaces = general.create_colorspaces(lut_directory,
529                                                      lut_resolution_1d,
530                                                      lut_resolution_3d)
531     for cs in general_colorSpaces:
532         config_data['colorSpaces'].append(cs)
533
534     # The *Raw* color space
535     raw = general.create_raw()
536     config_data['colorSpaces'].append(raw)
537
538     # Override 'linear' display
539     config_data['linearDisplaySpace'] = raw
540
541     # Override certain roles, for now
542     config_data['roles']['data'] = raw.name
543     config_data['roles']['reference'] = raw.name
544     config_data['roles']['texture_paint'] = raw.name
545
546     print('generateLUTs - end')
547     return config_data
548
549
550 def generate_baked_LUTs(odt_info,
551                         shaper_name,
552                         baked_directory,
553                         config_path,
554                         lut_resolution_1d,
555                         lut_resolution_3d,
556                         lut_resolution_shaper=1024):
557     """
558     Object description.
559
560     Parameters
561     ----------
562     parameter : type
563         Parameter description.
564
565     Returns
566     -------
567     type
568          Return value description.
569     """
570
571     # Create two entries for ODTs that have full and legal range support
572     odt_info_C = dict(odt_info)
573     for odt_ctl_name, odt_values in odt_info.iteritems():
574         if odt_values['transformHasFullLegalSwitch']:
575             odt_name = odt_values['transformUserName']
576
577             odt_values_legal = dict(odt_values)
578             odt_values_legal['transformUserName'] = '%s - Legal' % odt_name
579             odt_info_C['%s - Legal' % odt_ctl_name] = odt_values_legal
580
581             odt_values_full = dict(odt_values)
582             odt_values_full['transformUserName'] = '%s - Full' % odt_name
583             odt_info_C['%s - Full' % odt_ctl_name] = odt_values_full
584
585             del (odt_info_C[odt_ctl_name])
586
587     # Generate appropriate LUTs for each ODT
588     for odt_ctl_name, odt_values in odt_info_C.iteritems():
589         odt_prefix = odt_values['transformUserNamePrefix']
590         odt_name = odt_values['transformUserName']
591
592         # *Photoshop*
593         for input_space in ['ACEScc', 'ACESproxy']:
594             args = ['--iconfig', config_path,
595                     '-v',
596                     '--inputspace', input_space]
597             args += ['--outputspace', '%s' % odt_name]
598             args += ['--description',
599                      '%s - %s for %s data' % (odt_prefix,
600                                               odt_name,
601                                               input_space)]
602             args += ['--shaperspace', shaper_name,
603                      '--shapersize', str(lut_resolution_shaper)]
604             args += ['--cubesize', str(lut_resolution_3d)]
605             args += ['--format',
606                      'icc',
607                      os.path.join(baked_directory,
608                                   'photoshop',
609                                   '%s for %s.icc' % (odt_name, input_space))]
610
611             bake_lut = Process(description='bake a LUT',
612                                cmd='ociobakelut',
613                                args=args)
614             bake_lut.execute()
615
616         # *Flame*, *Lustre*
617         for input_space in ['ACEScc', 'ACESproxy']:
618             args = ['--iconfig', config_path,
619                     '-v',
620                     '--inputspace', input_space]
621             args += ['--outputspace', '%s' % odt_name]
622             args += ['--description',
623                      '%s - %s for %s data' % (
624                          odt_prefix, odt_name, input_space)]
625             args += ['--shaperspace', shaper_name,
626                      '--shapersize', str(lut_resolution_shaper)]
627             args += ['--cubesize', str(lut_resolution_3d)]
628
629             fargs = ['--format',
630                      'flame',
631                      os.path.join(
632                          baked_directory,
633                          'flame',
634                          '%s for %s Flame.3dl' % (odt_name, input_space))]
635             bake_lut = Process(description='bake a LUT',
636                                cmd='ociobakelut',
637                                args=(args + fargs))
638             bake_lut.execute()
639
640             largs = ['--format',
641                      'lustre',
642                      os.path.join(
643                          baked_directory,
644                          'lustre',
645                          '%s for %s Lustre.3dl' % (odt_name, input_space))]
646             bake_lut = Process(description='bake a LUT',
647                                cmd='ociobakelut',
648                                args=(args + largs))
649             bake_lut.execute()
650
651         # *Maya*, *Houdini*
652         for input_space in ['ACEScg', 'ACES2065-1']:
653             args = ['--iconfig', config_path,
654                     '-v',
655                     '--inputspace', input_space]
656             args += ['--outputspace', '%s' % odt_name]
657             args += ['--description',
658                      '%s - %s for %s data' % (
659                          odt_prefix, odt_name, input_space)]
660             if input_space == 'ACEScg':
661                 lin_shaper_name = '%s - AP1' % shaper_name
662             else:
663                 lin_shaper_name = shaper_name
664             args += ['--shaperspace', lin_shaper_name,
665                      '--shapersize', str(lut_resolution_shaper)]
666
667             args += ['--cubesize', str(lut_resolution_3d)]
668
669             margs = ['--format',
670                      'cinespace',
671                      os.path.join(
672                          baked_directory,
673                          'maya',
674                          '%s for %s Maya.csp' % (odt_name, input_space))]
675             bake_lut = Process(description='bake a LUT',
676                                cmd='ociobakelut',
677                                args=(args + margs))
678             bake_lut.execute()
679
680             hargs = ['--format',
681                      'houdini',
682                      os.path.join(
683                          baked_directory,
684                          'houdini',
685                          '%s for %s Houdini.lut' % (odt_name, input_space))]
686             bake_lut = Process(description='bake a LUT',
687                                cmd='ociobakelut',
688                                args=(args + hargs))
689             bake_lut.execute()
690
691
692 def create_config_dir(config_directory, bake_secondary_LUTs):
693     """
694     Object description.
695
696     Parameters
697     ----------
698     parameter : type
699         Parameter description.
700
701     Returns
702     -------
703     type
704          Return value description.
705     """
706
707     lut_directory = os.path.join(config_directory, 'luts')
708     dirs = [config_directory, lut_directory]
709     if bake_secondary_LUTs:
710         dirs.extend([os.path.join(config_directory, 'baked'),
711                      os.path.join(config_directory, 'baked', 'flame'),
712                      os.path.join(config_directory, 'baked', 'photoshop'),
713                      os.path.join(config_directory, 'baked', 'houdini'),
714                      os.path.join(config_directory, 'baked', 'lustre'),
715                      os.path.join(config_directory, 'baked', 'maya')])
716
717     for d in dirs:
718         not os.path.exists(d) and os.mkdir(d)
719
720     return lut_directory
721
722
723 def create_ACES_config(aces_ctl_directory,
724                        config_directory,
725                        lut_resolution_1d=4096,
726                        lut_resolution_3d=64,
727                        bake_secondary_LUTs=True,
728                        cleanup=True):
729     """
730     Creates the ACES configuration.
731
732     Parameters
733     ----------
734     parameter : type
735         Parameter description.
736
737     Returns
738     -------
739     type
740          Return value description.
741     """
742
743     lut_directory = create_config_dir(config_directory, bake_secondary_LUTs)
744
745     odt_info = aces.get_ODTs_info(aces_ctl_directory)
746     lmt_info = aces.get_LMTs_info(aces_ctl_directory)
747
748     shaper_name = 'Output Shaper'
749     config_data = generate_LUTs(odt_info,
750                                 lmt_info,
751                                 shaper_name,
752                                 aces_ctl_directory,
753                                 lut_directory,
754                                 lut_resolution_1d,
755                                 lut_resolution_3d,
756                                 cleanup)
757
758     print('Creating "generic" config')
759     config = create_config(config_data)
760     print('\n\n\n')
761
762     write_config(config,
763                  os.path.join(config_directory, 'config.ocio'))
764
765     print('Creating "Nuke" config')
766     nuke_config = create_config(config_data, nuke=True)
767     print('\n\n\n')
768
769     write_config(nuke_config,
770                  os.path.join(config_directory, 'nuke_config.ocio'))
771
772     if bake_secondary_LUTs:
773         generate_baked_LUTs(odt_info,
774                             shaper_name,
775                             os.path.join(config_directory, 'baked'),
776                             os.path.join(config_directory, 'config.ocio'),
777                             lut_resolution_1d,
778                             lut_resolution_3d,
779                             lut_resolution_1d)
780
781     return True
782
783
784 def main():
785     """
786     Object description.
787
788     Parameters
789     ----------
790     parameter : type
791         Parameter description.
792
793     Returns
794     -------
795     type
796          Return value description.
797     """
798
799     import optparse
800
801     p = optparse.OptionParser(description='An OCIO config generation script',
802                               prog='createACESConfig',
803                               version='createACESConfig 0.1',
804                               usage='%prog [options]')
805     p.add_option('--acesCTLDir', '-a', default=os.environ.get(
806         ACES_OCIO_CTL_DIRECTORY_ENVIRON, None))
807     p.add_option('--configDir', '-c', default=os.environ.get(
808         ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON, None))
809     p.add_option('--lutResolution1d', default=4096)
810     p.add_option('--lutResolution3d', default=64)
811     p.add_option('--dontBakeSecondaryLUTs', action='store_true')
812     p.add_option('--keepTempImages', action='store_true')
813
814     options, arguments = p.parse_args()
815
816     aces_ctl_directory = options.acesCTLDir
817     config_directory = options.configDir
818     lut_resolution_1d = int(options.lutResolution1d)
819     lut_resolution_3d = int(options.lutResolution3d)
820     bake_secondary_luts = not options.dontBakeSecondaryLUTs
821     cleanup_temp_images = not options.keepTempImages
822
823     # TODO: Investigate the following statements.
824     try:
825         args_start = sys.argv.index('--') + 1
826         args = sys.argv[args_start:]
827     except:
828         args_start = len(sys.argv) + 1
829         args = []
830
831     print('command line : \n%s\n' % ' '.join(sys.argv))
832
833     assert aces_ctl_directory is not None, (
834         'process: No "{0}" environment variable defined or no "ACES CTL" '
835         'directory specified'.format(
836             ACES_OCIO_CTL_DIRECTORY_ENVIRON))
837
838     assert config_directory is not None, (
839         'process: No "{0}" environment variable defined or no configuration '
840         'directory specified'.format(
841             ACES_OCIO_CONFIGURATION_DIRECTORY_ENVIRON))
842
843     return create_ACES_config(aces_ctl_directory,
844                               config_directory,
845                               lut_resolution_1d,
846                               lut_resolution_3d,
847                               bake_secondary_luts,
848                               cleanup_temp_images)
849
850
851 if __name__ == '__main__':
852     main()