Add remaining CG config transforms (#34)

* Add remaining CG config transforms

Signed-off-by: Michael Dolan <[email protected]>

* Fix linting error

Signed-off-by: Michael Dolan <[email protected]>

* Update doctests

Signed-off-by: Michael Dolan <[email protected]>

* Updates from feedback

Signed-off-by: Michael Dolan <[email protected]>

* Clean up trailing whitespace

Signed-off-by: Michael Dolan <[email protected]>

* Update doctests

Signed-off-by: Michael Dolan <[email protected]>

* Update doctests

Signed-off-by: Michael Dolan <[email protected]>

* Updates from working group discussion

Signed-off-by: Michael Dolan <[email protected]>

* Fix linting error

Signed-off-by: Michael Dolan <[email protected]>

* Fix doctest

Signed-off-by: Michael Dolan <[email protected]>

* Code formatting.

Signed-off-by: Thomas Mansencal <[email protected]>

* Generalise "CLF" transform embedding.

Signed-off-by: Thomas Mansencal <[email protected]>

* Refactor the "factories".

Signed-off-by: Thomas Mansencal <[email protected]>

* Rename various transform factory keyword arguments.

Signed-off-by: Thomas Mansencal <[email protected]>

Co-authored-by: Thomas Mansencal <[email protected]>

Author: michdolan

docs/opencolorio_config_aces.config.rst

@@ -25,6 +25,7 @@ Config Generation Common Objects
     view_transform_factory
     look_factory
     ConfigData
+    VersionData
     deserialize_config_data
     serialize_config_data
     validate_config

opencolorio_config_aces/__init__.py

@@ -21,15 +21,15 @@
 """
 
 from .config import (
-    ConfigData, build_aces_conversion_graph, classify_aces_ctl_transforms,
-    colorspace_factory, conversion_path, ctl_transform_to_node,
-    deserialize_config_data, discover_aces_ctl_transforms,
-    filter_ctl_transforms, filter_nodes, generate_config, generate_config_aces,
-    generate_config_cg, group_transform_factory, look_factory,
-    named_transform_factory, node_to_ctl_transform, plot_aces_conversion_graph,
-    print_aces_taxonomy, produce_transform, serialize_config_data,
-    transform_factory, unclassify_ctl_transforms, validate_config,
-    view_transform_factory)
+    ConfigData, VersionData, build_aces_conversion_graph,
+    classify_aces_ctl_transforms, colorspace_factory, conversion_path,
+    ctl_transform_to_node, deserialize_config_data,
+    discover_aces_ctl_transforms, filter_ctl_transforms, filter_nodes,
+    generate_config, generate_config_aces, generate_config_cg,
+    group_transform_factory, look_factory, named_transform_factory,
+    node_to_ctl_transform, plot_aces_conversion_graph, print_aces_taxonomy,
+    produce_transform, serialize_config_data, transform_factory,
+    unclassify_ctl_transforms, validate_config, view_transform_factory)
 from .clf import (classify_clf_transforms, discover_clf_transforms,
                   filter_clf_transforms, generate_clf, print_clf_taxonomy,
                   unclassify_clf_transforms)
@@ -42,7 +42,7 @@
 __status__ = 'Production'
 
 __all__ = [
-    'ConfigData', 'build_aces_conversion_graph',
+    'ConfigData', 'VersionData', 'build_aces_conversion_graph',
     'classify_aces_ctl_transforms', 'colorspace_factory', 'conversion_path',
     'ctl_transform_to_node', 'deserialize_config_data',
     'discover_aces_ctl_transforms', 'filter_ctl_transforms', 'filter_nodes',

opencolorio_config_aces/clf/discover/classify.py

@@ -17,7 +17,6 @@
 import itertools
 import logging
 import os
-import re
 import xml.etree.ElementTree as ET
 from collections import defaultdict
 from collections.abc import Mapping
@@ -33,7 +32,7 @@
 __status__ = 'Production'
 
 __all__ = [
-    'URN_CLF', 'SEPARATOR_URN_CLF', 'SEPARATOR_ID_CLF', 'NAMESPACE_CLF',
+    'URN_CLF', 'SEPARATOR_VERSION_CLF', 'SEPARATOR_ID_CLF', 'NAMESPACE_CLF',
     'TRANSFORM_TYPES_CLF', 'TRANSFORM_FAMILIES_CLF',
     'TRANSFORM_GENUS_DEFAULT_CLF', 'TRANSFORM_FILTERERS_DEFAULT_CLF',
     'PATTERNS_DESCRIPTION_CLF', 'ROOT_TRANSFORMS_CLF',
@@ -43,50 +42,52 @@
     'filter_clf_transforms', 'print_clf_taxonomy'
 ]
 
-URN_CLF = 'urn:aswf:ocio:transformId:v1.0'
+URN_CLF = 'urn:aswf:ocio:transformId:1.0'
 """
 *CLF* Uniform Resource Name (*URN*).
 
 URN_CLF : unicode
 """
 
-SEPARATOR_URN_CLF = ':'
+SEPARATOR_VERSION_CLF = '.'
 """
-*CLFtransformID* separator used to separate the *URN* and *ID* part of the
+*CLFtransformID* separator used to tokenize the *VERSION* parts of the
 *CLFtransformID*.
 
-SEPARATOR_URN_CLF : unicode
+urn:aswf:ocio:transformId:1.0:OCIO:ACES:AP0_to_AP1-Gamma2pnt2:1.0
+                         |---|                               |---|
+
+SEPARATOR_ID_CLF : unicode
 """
 
-SEPARATOR_ID_CLF = '.'
+SEPARATOR_ID_CLF = ':'
 """
 *CLFtransformID* separator used to tokenize the *ID* part of the
 *CLFtransformID*.
 
-urn:aswf:ocio:transformId:v1.0:ACES.OCIO.AP0_to_AP1-Gamma2pnt2.c1.v1
-|-------------URN------------|:|-----------------ID----------------|
+urn:aswf:ocio:transformId:1.0:OCIO:ACES:AP0_to_AP1-Gamma2pnt2:1.0
+|-------------URN-----------|:|----------------ID---------------|
 
 SEPARATOR_ID_CLF : unicode
 """
 
 NAMESPACE_CLF = 'OCIO'
 """
-*ACES* namespace for the *OCIO* *CLF* transforms.
+Namespace for the *OCIO* *CLF* transforms.
 
 NAMESPACE_CLF : unicode
 """
 
 TRANSFORM_TYPES_CLF = [
-    'ACES',
-    'Common',
+    'Utility',
 ]
 """
 *CLF* transform types.
 
 TRANSFORM_TYPES_CLF : list
 """
 
-TRANSFORM_FAMILIES_CLF = {'aces': 'aces'}
+TRANSFORM_FAMILIES_CLF = {'utility': 'Utility'}
 """
 *CLF* transform families mapping the *CLF* transform directories to family
 names.
@@ -119,7 +120,7 @@
     os.environ.get(
         'OPENCOLORIO_CONFIG_ACES__CLF_TRANSFORMS_ROOT',
         os.path.join(
-            os.path.dirname(__file__), '..', 'transforms', 'builtins')))
+            os.path.dirname(__file__), '..', 'transforms', 'ocio')))
 """
 *CLF* transforms root directory, default to the version controlled
 sub-module repository. It can be defined by setting the
@@ -457,30 +458,31 @@ def _parse(self):
 
         clf_transform_id = self._clf_transform_id
 
-        self._urn, components = clf_transform_id.rsplit(SEPARATOR_URN_CLF, 1)
-        components = components.split(SEPARATOR_ID_CLF)
-        self._type, components = components[0], components[1:]
-
-        assert self._urn == URN_CLF, (
+        assert clf_transform_id.startswith(URN_CLF), (
             f'{self._clf_transform_id} URN {self._urn} is invalid!')
 
-        assert len(components) in (4, 5), (
+        self._urn = clf_transform_id[:len(URN_CLF) + 1]
+        components = clf_transform_id[len(URN_CLF) + 1:]
+        components = components.split(SEPARATOR_ID_CLF)
+
+        assert len(components) == 4, (
             f'{self._clf_transform_id} is an invalid "CLFtransformID"!')
 
-        if len(components) == 4:
-            (self._namespace, self._name, self._major_version_number,
-             self._minor_version_number) = components
-        else:
-            (self._namespace, self._name, self._major_version_number,
-             self._minor_version_number,
-             self._patch_version_number) = components
+        (self._namespace, self._type, self._name, version) = components
 
         assert self._type in TRANSFORM_TYPES_CLF, (
             f'{self._clf_transform_id} type {self._type} is invalid!')
 
         if self._name is not None:
             self._source, self._target = self._name.split('_to_')
 
+        assert version.count(SEPARATOR_VERSION_CLF) == 1, (
+            f'{self._clf_transform_id} has an invalid "CLFtransformID" '
+            f'version!')
+
+        (self._major_version_number,
+         self._minor_version_number) = version.split(SEPARATOR_VERSION_CLF)
+
 
 class CLFTransform:
     """
@@ -503,6 +505,8 @@ class CLFTransform:
     clf_transform_id
     user_name
     description
+    input_descriptor
+    output_descriptor
     family
     genus
 
@@ -521,6 +525,8 @@ def __init__(self, path, family=None, genus=None):
         self._clf_transform_id = None
         self._user_name = None
         self._description = ''
+        self._input_descriptor = ''
+        self._output_descriptor = ''
 
         self._family = family
         self._genus = genus
@@ -641,6 +647,52 @@ def description(self):
 
         return self._description
 
+    @property
+    def input_descriptor(self):
+        """
+        Getter and setter property for the *CLF* transform input descriptor
+        extracted from parsing the file content header.
+
+        Parameters
+        ----------
+        value : unicode
+            Attribute value.
+
+        Returns
+        -------
+        unicode
+            *CLF* transform input descriptor.
+
+        Notes
+        -----
+        -   This property is read only.
+        """
+
+        return self._input_descriptor
+
+    @property
+    def output_descriptor(self):
+        """
+        Getter and setter property for the *CLF* transform output descriptor
+        extracted from parsing the file content header.
+
+        Parameters
+        ----------
+        value : unicode
+            Attribute value.
+
+        Returns
+        -------
+        unicode
+            *CLF* transform output descriptor.
+
+        Notes
+        -----
+        -   This property is read only.
+        """
+
+        return self._output_descriptor
+
     @property
     def family(self):
         """
@@ -785,10 +837,21 @@ def _parse(self):
 
         self._clf_transform_id = CLFTransformID(root.attrib['id'])
         self._user_name = root.attrib['name']
+
         description = next(iter(root.findall('./Description')), None)
         if description is not None:
             self._description = description.text
 
+        input_descriptor = next(
+            iter(root.findall('./InputDescriptor')), None)
+        if input_descriptor is not None:
+            self._input_descriptor = input_descriptor.text
+
+        output_descriptor = next(
+            iter(root.findall('./OutputDescriptor')), None)
+        if output_descriptor is not None:
+            self._output_descriptor = output_descriptor.text
+
 
 class CLFTransformPair:
     """
@@ -965,9 +1028,7 @@ def stem(path):
     # to define which transform is the forward transform.
     paths = defaultdict(list)
     for clf_transform in sorted(clf_transforms, key=stem):
-        forward_path = tuple(
-            re.split('_to_',
-                     stem(clf_transform).split('.', 2)[-1]))
+        forward_path = tuple(stem(clf_transform).split('_to_', 1))
         inverse_path = tuple(reversed(forward_path))
         if inverse_path in paths:
             paths[inverse_path].append(clf_transform)
@@ -1012,9 +1073,10 @@ def discover_clf_transforms(root_directory=ROOT_TRANSFORMS_CLF):
     >>> clf_transforms = discover_clf_transforms()
     >>> key = sorted(clf_transforms.keys())[0]
     >>> os.path.basename(key)
-    'aces'
+    'utility'
     >>> sorted([os.path.basename(path) for path in clf_transforms[key]])[:2]
-    ['ACES.OCIO.AP0_to_AP1-Gamma2.2.clf', 'ACES.OCIO.AP0_to_P3-D65.clf']
+    ['OCIO.Utility.AP0_to_AP1-Gamma2.2.clf', \
+'OCIO.Utility.AP0_to_P3-D65-Linear.clf']
     """
 
     root_directory = os.path.normpath(os.path.expandvars(root_directory))
@@ -1071,24 +1133,28 @@ def classify_clf_transforms(unclassified_clf_transforms):
     ...     discover_clf_transforms())
     >>> family = sorted(clf_transforms.keys())[0]
     >>> str(family)
-    'aces'
+    'Utility'
     >>> genera = sorted(clf_transforms[family])
     >>> print(genera)
     ['undefined']
     >>> genus = genera[0]
     >>> sorted(clf_transforms[family][genus].items())[:2]  # doctest: +ELLIPSIS
-    [('ACES.OCIO.AP0_to_AP1-Gamma2.2', \
-CLFTransform('aces...ACES.OCIO.AP0_to_AP1-Gamma2.2.clf')), \
-('ACES.OCIO.AP0_to_P3-D65', \
-CLFTransform('aces...ACES.OCIO.AP0_to_P3-D65.clf'))]
+    [('OCIO.Utility.AP0_to_AP1-Gamma2.2', \
+CLFTransform('utility...OCIO.Utility.AP0_to_AP1-Gamma2.2.clf')), \
+('OCIO.Utility.AP0_to_P3-D65-Linear', \
+CLFTransform('utility...OCIO.Utility.AP0_to_P3-D65-Linear.clf'))]
     """
 
     classified_clf_transforms = defaultdict(lambda: defaultdict(dict))
 
     root_directory = paths_common_ancestor(
         *itertools.chain.from_iterable(unclassified_clf_transforms.values()))
     for directory, clf_transforms in unclassified_clf_transforms.items():
-        sub_directory = directory.replace(f'{root_directory}{os.sep}', '')
+        if directory == root_directory:
+            sub_directory = os.path.basename(root_directory)
+        else:
+            sub_directory = directory.replace(f'{root_directory}{os.sep}', '')
+
         family, *genus = [
             TRANSFORM_FAMILIES_CLF.get(part, part)
             for part in sub_directory.split(os.sep)
@@ -1149,7 +1215,7 @@ def unclassify_clf_transforms(classified_clf_transforms):
     ...     discover_clf_transforms())
     >>> sorted(  # doctest: +ELLIPSIS
     ...     unclassify_clf_transforms(clf_transforms), key=lambda x: x.path)[0]
-    CLFTransform('aces...ACES.OCIO.AP0_to_AP1-Gamma2.2.clf')
+    CLFTransform('utility...OCIO.Utility.AP0_to_AP1-Gamma2.2.clf')
     """
 
     unclassified_clf_transforms = []
@@ -1202,9 +1268,9 @@ def filter_clf_transforms(clf_transforms, filterers=None):
     >>> sorted(  # doctest: +ELLIPSIS
     ...     filter_clf_transforms(
     ...         clf_transforms,
-    ...         [lambda x: x.family == 'common']),
+    ...         [lambda x: x.family == 'Utility']),
     ...     key=lambda x: x.path)[0]
-    CLFTransform('common...Common.OCIO.Linear_to_Rec1886.clf')
+    CLFTransform('utility...OCIO.Utility.AP0_to_AP1-Gamma2.2.clf')
     """
 
     if filterers is None:

opencolorio_config_aces/clf/transforms/aces.py

@@ -53,10 +53,11 @@ def generate_clf_aces(directory):
         1.0000000000, 0.0000000000, 0.0000000000, 0.0000000000, 0.0000000000,
         1.0000000000
     ]
-    _dummy_matrix_transform = transform_factory(**{
-        'name': 'MatrixTransform',
-        'matrix': _M_dummy,
-    })
+    _dummy_matrix_transform = transform_factory(
+        **{
+            'transform_type': 'MatrixTransform',
+            'matrix': _M_dummy,
+        })
     _dummy_metadata = {
         'ID': 'Undefined',
         'name': 'Undefined',
@@ -127,7 +128,7 @@ def generate_clf_aces(directory):
             'CAT02',
         ))
     matrix_transform = transform_factory(**{
-        'name': 'MatrixTransform',
+        'transform_type': 'MatrixTransform',
         'matrix': M_AP0_to_Rec709,
     })
     clf_path = directory / 'ACES.OCIO.AP0_to_Rec.709.clf'