Implement support for amf_transform_ids.

Closes #154.

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

Author: KelSolaar

docs/opencolorio_config_aces.config.rst

@@ -82,6 +82,7 @@ Reference Configuration
     version_aces_dev
     classify_aces_ctl_transforms
     discover_aces_ctl_transforms
+    filter_amf_components
     filter_ctl_transforms
     generate_amf_components
     print_aces_taxonomy

opencolorio_config_aces/__init__.py

@@ -49,6 +49,7 @@
     conversion_path,
     ctl_transform_to_node,
     discover_aces_ctl_transforms,
+    filter_amf_components,
     filter_ctl_transforms,
     filter_nodes,
     generate_amf_components,
@@ -108,6 +109,7 @@
     "conversion_path",
     "ctl_transform_to_node",
     "discover_aces_ctl_transforms",
+    "filter_amf_components",
     "filter_ctl_transforms",
     "filter_nodes",
     "generate_amf_components",

opencolorio_config_aces/config/__init__.py

@@ -30,6 +30,7 @@
     conversion_path,
     ctl_transform_to_node,
     discover_aces_ctl_transforms,
+    filter_amf_components,
     filter_ctl_transforms,
     filter_nodes,
     generate_amf_components,
@@ -75,6 +76,7 @@
     "conversion_path",
     "ctl_transform_to_node",
     "discover_aces_ctl_transforms",
+    "filter_amf_components",
     "filter_ctl_transforms",
     "filter_nodes",
     "generate_amf_components",

opencolorio_config_aces/config/cg/generate/config.py

@@ -14,7 +14,7 @@
 import logging
 import re
 from collections import defaultdict
-from collections.abc import Callable, Mapping
+from collections.abc import Callable
 from pathlib import Path
 from typing import Any
 
@@ -42,11 +42,11 @@
 )
 from opencolorio_config_aces.config.reference import (
     DescriptionStyle,
+    filter_amf_components,
     generate_config_aces,
 )
 from opencolorio_config_aces.config.reference.generate.config import (
     COLORSPACE_SCENE_ENCODING_REFERENCE,
-    HEADER_AMF_COMPONENTS,
     TEMPLATE_ACES_TRANSFORM_ID,
     format_optional_prefix,
     transform_data_aliases,
@@ -170,7 +170,6 @@ def clf_transform_to_colorspace_name(clf_transform: CLFTransform) -> str:
 def clf_transform_to_description(
     clf_transform: CLFTransform,
     describe: DescriptionStyle = DescriptionStyle.LONG_UNION,
-    amf_components: Mapping[str, Any] | None = None,
     direction: str = "Forward",
 ) -> str | None:
     """
@@ -184,9 +183,6 @@ def clf_transform_to_description(
     describe : bool, optional
         Whether to use the full *CLF* transform description  or just the
         first line.
-    amf_components : mapping, optional
-        *ACES* *AMF* components used to extend the *ACES* *CTL* transform
-        description.
     direction : str, optional
         Direction of transform -- determines order of transform descriptors.
         {"Forward", "Reverse"}
@@ -198,8 +194,6 @@ def clf_transform_to_description(
         *OpenColorIO* `Colorspace` or `NamedTransform` description.
     """
 
-    amf_components = optional(amf_components, {})
-
     description = None
     if describe != DescriptionStyle.NONE:
         description = []
@@ -242,22 +236,6 @@ def clf_transform_to_description(
             aces_transform_id = aces_transform_id.aces_transform_id
             description.append(TEMPLATE_ACES_TRANSFORM_ID.format(aces_transform_id))
 
-            if describe in (
-                DescriptionStyle.AMF,
-                DescriptionStyle.SHORT_UNION,
-                DescriptionStyle.LONG_UNION,
-            ):
-                amf_components_description = [
-                    TEMPLATE_ACES_TRANSFORM_ID.format(amf_aces_transform_id)
-                    for amf_aces_transform_id in amf_components.get(
-                        aces_transform_id, []
-                    )
-                ]
-                if amf_components_description:
-                    description.append("")
-                    description.append(HEADER_AMF_COMPONENTS)
-                    description.extend(amf_components_description)
-
         description = "\n".join(description).strip()
 
     return description
@@ -300,7 +278,6 @@ def clf_transform_to_family(
 def clf_transform_to_colorspace(
     clf_transform: CLFTransform,
     describe: DescriptionStyle = DescriptionStyle.LONG_UNION,
-    amf_components: Mapping[str, Any] | None = None,
     signature_only: bool = False,
     **kwargs: Any,
 ) -> dict[str, Any] | ocio.ColorSpace:
@@ -313,9 +290,6 @@ def clf_transform_to_colorspace(
         *CLF* transform.
     describe : bool, optional
         *CLF* transform description style.
-    amf_components : mapping, optional
-        *ACES* *AMF* components used to extend the *ACES* *CTL* transform
-        description.
     signature_only : bool, optional
         Whether to return the *OpenColorIO* `Colorspace` signature only, i.e.,
         the arguments for its instantiation.
@@ -335,9 +309,7 @@ def clf_transform_to_colorspace(
     signature = {
         "name": clf_transform_to_colorspace_name(clf_transform),
         "family": clf_transform_to_family(clf_transform),
-        "description": clf_transform_to_description(
-            clf_transform, describe, amf_components, "Forward"
-        ),
+        "description": clf_transform_to_description(clf_transform, describe, "Forward"),
     }
 
     file_transform = {
@@ -367,7 +339,6 @@ def clf_transform_to_colorspace(
 def clf_transform_to_named_transform(
     clf_transform: CLFTransform,
     describe: DescriptionStyle = DescriptionStyle.LONG_UNION,
-    amf_components: Mapping[str, Any] | None = None,
     signature_only: bool = False,
     **kwargs: Any,
 ) -> dict[str, Any] | ocio.NamedTransform:
@@ -380,9 +351,6 @@ def clf_transform_to_named_transform(
         *CLF* transform.
     describe : bool, optional
         *CLF* transform description style.
-    amf_components : mapping, optional
-        *ACES* *AMF* components used to extend the *ACES* *CTL* transform
-        description.
     signature_only : bool, optional
         Whether to return the *OpenColorIO* `NamedTransform` signature only,
         i.e., the arguments for its instantiation.
@@ -412,12 +380,12 @@ def clf_transform_to_named_transform(
     if is_reference(clf_transform.source):
         signature["inverse_transform"] = file_transform  # pyright: ignore
         signature["description"] = clf_transform_to_description(  # pyright: ignore
-            clf_transform, describe, amf_components, direction="Reverse"
+            clf_transform, describe, direction="Reverse"
         )
     else:
         signature["forward_transform"] = file_transform  # pyright: ignore
         signature["description"] = clf_transform_to_description(  # pyright: ignore
-            clf_transform, describe, amf_components, direction="Forward"
+            clf_transform, describe, direction="Forward"
         )
 
     signature.update(kwargs)
@@ -437,7 +405,6 @@ def clf_transform_to_named_transform(
 def style_to_colorspace(
     style: str,
     describe: DescriptionStyle = DescriptionStyle.LONG_UNION,
-    amf_components: Mapping[str, Any] | None = None,
     signature_only: bool = False,
     scheme: str = "Modern 1",  # noqa: ARG001
     **kwargs: Any,
@@ -452,9 +419,6 @@ def style_to_colorspace(
     describe : int, optional
         Any value from the
         :class:`opencolorio_config_aces.DescriptionStyle` enum.
-    amf_components : mapping, optional
-        *ACES* *AMF* components used to extend the *ACES* *CTL* transform
-        description.
     signature_only : bool, optional
         Whether to return the *OpenColorIO* view `Colorspace` signature only,
         i.e., the arguments for its instantiation.
@@ -494,7 +458,7 @@ def style_to_colorspace(
     clf_transform = kwargs.pop("clf_transform", None)
     if clf_transform:
         colorspace_signature = clf_transform_to_colorspace(
-            clf_transform, describe, amf_components, True, **kwargs
+            clf_transform, describe, True, **kwargs
         )
         description = colorspace_signature["description"]
         signature.update(colorspace_signature)
@@ -547,7 +511,6 @@ def style_to_colorspace(
 def style_to_named_transform(
     style: str,
     describe: DescriptionStyle = DescriptionStyle.LONG_UNION,
-    amf_components: Mapping[str, Any] | None = None,
     signature_only: bool = False,
     scheme: str = "Modern 1",  # noqa: ARG001
     **kwargs: Any,
@@ -562,9 +525,6 @@ def style_to_named_transform(
     describe : int, optional
         Any value from the
         :class:`opencolorio_config_aces.DescriptionStyle` enum.
-    amf_components : mapping, optional
-        *ACES* *AMF* components used to extend the *ACES* *CTL* transform
-        description.
     signature_only : bool, optional
         Whether to return the *OpenColorIO* view `Colorspace` signature only,
         i.e., the arguments for its instantiation.
@@ -604,15 +564,14 @@ def style_to_named_transform(
     clf_transform = kwargs.pop("clf_transform", None)
     if clf_transform:
         colorspace_signature = clf_transform_to_colorspace(
-            clf_transform, describe, amf_components, True, **kwargs
+            clf_transform, describe, True, **kwargs
         )
         signature.update(colorspace_signature)
         signature.pop("from_reference", None)
         source = clf_transform.source
         description = clf_transform_to_description(
             clf_transform,
             describe,
-            amf_components,
             "Reverse" if is_reference(source) else "Forward",
         )
     else:
@@ -1190,7 +1149,6 @@ def remove_existing_named_transform(name: str) -> None:
 
         kwargs = {
             "describe": describe,
-            "amf_components": amf_components,
             "signature_only": True,
             "aliases": transform_data_aliases(transform_data),
             "encoding": transform_data.get("encoding"),
@@ -1202,10 +1160,25 @@ def remove_existing_named_transform(name: str) -> None:
         clf_transform_id = transform_data["clf_transform_id"]
 
         if style:
+            clf_transform = clf_transform_from_style(style)
+
+            filtered_amf_components = None
+            if (
+                aces_transform_id := clf_transform.information.get(  # pyright: ignore
+                    "ACEStransformID"
+                )
+            ) is not None:
+                filtered_amf_components = filter_amf_components(
+                    amf_components, aces_transform_id.aces_transform_id
+                )
+
             kwargs.update(
                 {
                     "style": style,
-                    "clf_transform": clf_transform_from_style(style),
+                    "clf_transform": clf_transform,
+                    "interchange_mapping": None
+                    if filtered_amf_components is None
+                    else {"amf_transform_ids": "\n".join(filtered_amf_components)},
                 }
             )
 
@@ -1250,7 +1223,24 @@ def remove_existing_named_transform(name: str) -> None:
                 f'"{clf_transform_id}" "CLF" transform does not exist!',
             )
 
-            kwargs["clf_transform"] = clf_transform
+            filtered_amf_components = None
+            if (
+                aces_transform_id := clf_transform.information.get(  # pyright: ignore
+                    "ACEStransformID"
+                )
+            ) is not None:
+                filtered_amf_components = filter_amf_components(
+                    amf_components, aces_transform_id.aces_transform_id
+                )
+
+            kwargs.update(
+                {
+                    "clf_transform": clf_transform,
+                    "interchange_mapping": None
+                    if filtered_amf_components is None
+                    else {"amf_transform_ids": "\n".join(filtered_amf_components)},
+                }
+            )
 
             if transform_data["interface"] == "NamedTransform":
                 LOGGER.info(

opencolorio_config_aces/config/generation/configuration.py

@@ -91,19 +91,19 @@ def extended_fields(self) -> dict[str, str]:
     BuildConfiguration(
         aces=Version(2, 0),
         colorspaces=Version(3, 0, 0),
-        ocio=Version(2, 4),
+        ocio=Version(2, 5),
         variant="",
     ),
     BuildConfiguration(
         aces=Version(2, 0),
         colorspaces=Version(3, 0, 0),
-        ocio=Version(2, 4),
+        ocio=Version(2, 5),
         variant="D60 Views",
     ),
     BuildConfiguration(
         aces=Version(2, 0),
         colorspaces=Version(3, 0, 0),
-        ocio=Version(2, 4),
+        ocio=Version(2, 5),
         variant="All Views",
     ),
 ]

opencolorio_config_aces/config/generation/factories.py

@@ -125,6 +125,7 @@ def colorspace_factory(
     is_data: bool | None = None,
     reference_space: str | int | None = None,
     interop_id: str | None = None,
+    interchange_mapping: dict[str, str] | None = None,
     base_colorspace: Mapping[str, Any] | ocio.ColorSpace | None = None,
     **kwargs: Any,
 ) -> ocio.ColorSpace:
@@ -166,6 +167,9 @@ def colorspace_factory(
         See https://github.com/AcademySoftwareFoundation/ColorInterop/blob/\
 5aebc3f37ac192c86694a47bb92fa65cc95e4e67/Recommendations/\
 01_TextureAssetColorSpaces/TextureAssetColorSpaces.md
+    interchange_mapping : dict, optional
+        Mapping of key and value pairs for interchange, e.g.,
+        `amf_transform_ids` or `icc_profile_name`.
     base_colorspace : dict or ColorSpace, optional
         *OpenColorIO* base `Colorspace` inherited for initial attribute values.
 
@@ -261,6 +265,10 @@ def colorspace_factory(
     if interop_id is not None:
         colorspace.setInteropID(interop_id)  # pyright: ignore
 
+    if interchange_mapping is not None:
+        for key, value in interchange_mapping.items():
+            colorspace.setInterchangeAttribute(key, value)  # pyright: ignore
+
     return colorspace
 
 

opencolorio_config_aces/config/reference/__init__.py

@@ -6,6 +6,7 @@
     discover_aces_ctl_transforms,
     classify_aces_ctl_transforms,
     unclassify_ctl_transforms,
+    filter_amf_components,
     filter_ctl_transforms,
     generate_amf_components,
     print_aces_taxonomy,
@@ -26,6 +27,7 @@
     "discover_aces_ctl_transforms",
     "classify_aces_ctl_transforms",
     "unclassify_ctl_transforms",
+    "filter_amf_components",
     "filter_ctl_transforms",
     "generate_amf_components",
     "print_aces_taxonomy",

opencolorio_config_aces/config/reference/discover/__init__.py

@@ -6,6 +6,7 @@
     discover_aces_ctl_transforms,
     classify_aces_ctl_transforms,
     unclassify_ctl_transforms,
+    filter_amf_components,
     filter_ctl_transforms,
     generate_amf_components,
     print_aces_taxonomy,
@@ -24,6 +25,7 @@
     "discover_aces_ctl_transforms",
     "classify_aces_ctl_transforms",
     "unclassify_ctl_transforms",
+    "filter_amf_components",
     "filter_ctl_transforms",
     "generate_amf_components",
     "print_aces_taxonomy",