Versatile.py

"""

"""

import PyOpenColorIO as ocio

import makeconfig
from makeconfig.config.ingredients import *
from makeconfig import utils


class Versatile(makeconfig.BaseConfig):
    
    name = "Versatile"

    def cook_root(self):

        self.config.setVersion(2, 0)
        self.config.setName(self.name)
        self.config.setDescription(
            'A versatile sRGB based configuration for artists.\n'
            'Visit https://github.com/MrLixm/OCIO.Liam'
        )

        return

    def cook_colorspaces(self):

        _ = "just to avoid the under being considered as method's docstring"

        """____________________________________________________________________

            CIE-XYZ-D65

        """
        self.cs_ref = Colorspace(
            name="CIE-XYZ-D65",
            description=ColorspaceDescription(
                transfer_function="linear",
                primaries="CIE-XYZ",
                whitepoint="D65",
                details="The reference colorspace, CIE XYZ with D65 adaptive white point",
            ),
            encoding=Encodings.scene_linear,
            family=Families.scene,
            categories=[Categories.input, Categories.workspace]
        )
        self.add(self.cs_ref)

        """____________________________________________________________________

            Raw

        """
        self.cs_raw = Colorspace(
            name="Raw",
            description=ColorspaceDescription(
                transfer_function="none",
                primaries="none",
                whitepoint="none",
                details="The No-operation colorspace.",
            ),
            encoding=Encodings.data,
            family=Families.scene,
            categories=[Categories.input, Categories.output],
            is_data=True
        )
        self.add(self.cs_raw)

        """____________________________________________________________________

            sRGB - linear

        """
        self.cs_srgb_lin = Colorspace(
            name="sRGB - linear",
            description=ColorspaceDescription(
                transfer_function="linear",
                primaries="sRGB",
                whitepoint="D65",
                details="With a linear transfer function instead.",
            ),
            encoding=Encodings.scene_linear,
            family=Families.scene,
            categories=[Categories.input, Categories.output, Categories.workspace],
        )
        _matrix = utils.matrix_colorspace_transform(
                source="sRGB",
                target="XYZ",
                target_whitepoint="D65"
        )
        _matrix = utils.matrix_format_ocio(_matrix)
        transform = ocio.MatrixTransform(_matrix)
        self.cs_srgb_lin.setTransform(transform, ocio.COLORSPACE_DIR_TO_REFERENCE)
        self.add(self.cs_srgb_lin)

        """____________________________________________________________________
        
            ACES2065-1
            
        """
        self.cs_ap0 = Colorspace(
            name="ACES2065-1",
            description=ColorspaceDescription(
                transfer_function="linear",
                primaries="ACES2065-1",
                whitepoint="ACES",
                details="ACES reference space. Also AP0.",
            ),
            encoding=Encodings.scene_linear,
            family=Families.aces,
            categories=[Categories.input, Categories.output],
        )
        transform = ocio.GroupTransform(
            [
                ocio.BuiltinTransform(style="UTILITY - ACES-AP0_to_CIE-XYZ-D65_BFD"),
            ]
        )
        self.cs_ap0.setTransform(transform, ocio.COLORSPACE_DIR_TO_REFERENCE)
        self.add(self.cs_ap0)

        """____________________________________________________________________
        
            ACEScg

        """
        self.cs_ap1 = Colorspace(
            name="ACEScg",
            description=ColorspaceDescription(
                transfer_function="linear",
                primaries="ACEScg",
                whitepoint="ACES",
                details="ACES working space. Also AP1.",
            ),
            encoding=Encodings.scene_linear,
            family=Families.aces,
            categories=[Categories.input, Categories.output, Categories.workspace],
        )
        transform = ocio.GroupTransform(
            [
                ocio.BuiltinTransform(style="UTILITY - ACES-AP1_to_CIE-XYZ-D65_BFD"),
            ]
        )
        self.cs_ap1.setTransform(transform, ocio.COLORSPACE_DIR_TO_REFERENCE)
        self.add(self.cs_ap1)

        """____________________________________________________________________

            ACEScct

        """
        self.cs_acescct = Colorspace(
            name="ACEScct",
            description=ColorspaceDescription(
                transfer_function="ACEScct",
                primaries="ACEScg",
                whitepoint="ACES",
                details="Quasi-Logarithmic Encoding of ACES Data for use within Color Grading Systems",
            ),
            encoding=Encodings.log,
            family=Families.aces,
            categories=[Categories.workspace],
        )
        transform = ocio.GroupTransform(
            [
                ocio.BuiltinTransform(
                    style="ACEScct_to_ACES2065-1"),
                ocio.BuiltinTransform(
                    style="UTILITY - ACES-AP0_to_CIE-XYZ-D65_BFD"),
            ]
        )
        self.cs_acescct.setTransform(transform, ocio.COLORSPACE_DIR_TO_REFERENCE)
        self.add(self.cs_acescct)

        """____________________________________________________________________

            sRGB curve
            
            Because Nuke can't read NamedTransforms. (intended ??)

        """
        self.cs_srgb_curve = Colorspace(
            name="sRGB - curve",
            description=ColorspaceDescription(
                transfer_function="sRGB EOTF",
                primaries="None",
                whitepoint="None",
                details="Encoding the sRGB EOTF only.",
            ),
            encoding=Encodings.sdr_video,
            family=Families.display,
            categories=[Categories.input, Categories.output],
        )
        transform = ocio.ExponentWithLinearTransform(
                    [2.4, 2.4, 2.4, 1.0],
                    [0.055, 0.055, 0.055, 0.0],
                    ocio.NEGATIVE_LINEAR,
                    ocio.TRANSFORM_DIR_FORWARD
        )
        self.cs_srgb_curve.setTransform(transform, ocio.COLORSPACE_DIR_FROM_REFERENCE)
        self.add(self.cs_srgb_curve)

        return

    def cook_named_transform(self):

        self.nt_srgb_curve = NamedTransform(
            name="sRGB - curve (nt)",
            description="Encoding the sRGB EOTF only.",
            encoding=Encodings.sdr_video,
            family=Families.display,
            categories=[Categories.input, Categories.output],
        )
        transform = ocio.ExponentWithLinearTransform(
                    [2.4, 2.4, 2.4, 1.0],
                    [0.055, 0.055, 0.055, 0.0],
                    ocio.NEGATIVE_LINEAR,
                    ocio.TRANSFORM_DIR_INVERSE
        )
        self.nt_srgb_curve.setTransform(transform, ocio.TRANSFORM_DIR_FORWARD)
        self.add(self.nt_srgb_curve)

        return

    def cook_colorspaces_display(self):

        _ = "just to avoid the under being considered as method's docstring"

        """____________________________________________________________________

            sRGB

        """
        self.cs_srgb = ColorspaceDisplay(
            name="sRGB",
            description=ColorspaceDescription(
                transfer_function="sRGB EOTF",
                primaries="sRGB",
                whitepoint="D65",
                details="sRGB monitor with piecewise EOTF",
            ),
            encoding=Encodings.sdr_video,
            family=Families.display,
            categories=[Categories.input, Categories.output],
        )

        transform = ocio.GroupTransform(
            [
                ocio.BuiltinTransform(style="DISPLAY - CIE-XYZ-D65_to_sRGB"),
                ocio.RangeTransform(0, 1, 0, 1)
            ]
        )
        self.cs_srgb.setTransform(transform, ocio.COLORSPACE_DIR_FROM_REFERENCE)
        self.add(self.cs_srgb)

        """____________________________________________________________________

            Rec.709

        """
        self.cs_bt709 = ColorspaceDisplay(
            name="Rec.709",
            description=ColorspaceDescription(
                transfer_function="pow(2.4)",
                primaries="BT.709",
                whitepoint="D65",
                details="with BT.1886 transfer-function encoding",
            ),
            encoding=Encodings.sdr_video,
            family=Families.display,
            categories=[Categories.output],
        )

        transform = ocio.GroupTransform(
            [
                ocio.BuiltinTransform(style="DISPLAY - CIE-XYZ-D65_to_REC.1886-REC.709"),
                ocio.RangeTransform(0, 1, 0, 1)
            ]
        )
        self.cs_bt709.setTransform(transform, ocio.COLORSPACE_DIR_FROM_REFERENCE)
        self.add(self.cs_bt709)

        """____________________________________________________________________

            Apple Display P3

        """
        self.cs_p3_d = ColorspaceDisplay(
            name="Apple Display P3",
            description=ColorspaceDescription(
                transfer_function="sRGB EOTF",
                primaries="DCI-P3",
                whitepoint="D65",
                details="Standard for Apple displays.",
            ),
            encoding=Encodings.sdr_video,
            family=Families.display,
            categories=[Categories.output],
        )
        _matrix = utils.matrix_colorspace_transform(
            source="XYZ",
            target="Display P3",
            source_whitepoint="D65"
        )
        _matrix = utils.matrix_format_ocio(_matrix)

        transform = ocio.GroupTransform(
            [
                # DCisplay P3 to CIE-XYZ matrix
                ocio.MatrixTransform(_matrix),
                # sRGB EOTF encoding
                ocio.ExponentWithLinearTransform(
                    [2.4, 2.4, 2.4, 1.0],
                    [0.055, 0.055, 0.055, 0.0],
                    ocio.NEGATIVE_LINEAR,
                    ocio.TRANSFORM_DIR_INVERSE
                ),
                # clamp
                ocio.RangeTransform(0, 1, 0, 1)
            ]
        )
        self.cs_p3_d.setTransform(transform, ocio.COLORSPACE_DIR_FROM_REFERENCE)
        self.add(self.cs_p3_d)

        """____________________________________________________________________

            P3-DCI

        """
        self.cs_p3_dci = ColorspaceDisplay(
            name="P3-DCI",
            description=ColorspaceDescription(
                transfer_function="pow(2.6)",
                primaries="DCI-P3",
                whitepoint="DCI-P3",
                details="Gamma 2.6 (DCI white with Bradford adaptation)",
            ),
            encoding=Encodings.sdr_video,
            family=Families.display,
            categories=[Categories.output],
        )

        transform = ocio.GroupTransform(
            [
                ocio.BuiltinTransform(style="DISPLAY - CIE-XYZ-D65_to_G2.6-P3-DCI-BFD"),
                ocio.RangeTransform(0, 1, 0, 1)
            ]
        )
        self.cs_p3_dci.setTransform(transform, ocio.COLORSPACE_DIR_FROM_REFERENCE)
        self.add(self.cs_p3_dci)

        """____________________________________________________________________

            P3-DCI-D65

        """
        self.cs_p3_dci_d65 = ColorspaceDisplay(
            name="P3-DCI-D65",
            description=ColorspaceDescription(
                transfer_function="pow(2.6)",
                primaries="DCI-P3",
                whitepoint="D65",
                details="For display using a D65 whitepoint instead of DCI-P3",
            ),
            encoding=Encodings.sdr_video,
            family=Families.display,
            categories=[Categories.output],
        )

        transform = ocio.GroupTransform(
            [
                ocio.BuiltinTransform(style="DISPLAY - CIE-XYZ-D65_to_G2.6-P3-D65"),
                ocio.RangeTransform(0, 1, 0, 1)
            ]
        )
        self.cs_p3_dci_d65.setTransform(transform, ocio.COLORSPACE_DIR_FROM_REFERENCE)
        self.add(self.cs_p3_dci_d65)

    def cook_looks(self):
        pass

    def cook_viewtransforms(self):

        # !!!!! the first view_transform shoudl eb the one used by default !!!!
        # or make sure you specify the default one with
        # setDefaultViewTransformName()
        # spent hours debuging while I had the ACES viewtransform as default.
        self.viewtm_pass = ViewTransform(ocio.REFERENCE_SPACE_SCENE)
        self.viewtm_pass.setName("Passthrough")
        self.viewtm_pass.setDescription("No view_transform encoding.")
        transform = ocio.ColorSpaceTransform(
            src=self.cs_ref.name,
            dst=self.cs_ref.name
        )
        self.viewtm_pass.setTransform(transform, ocio.VIEWTRANSFORM_DIR_FROM_REFERENCE)
        self.add(self.viewtm_pass)

        self.viewtm_aces = ViewTransform(ocio.REFERENCE_SPACE_SCENE)
        self.viewtm_aces.setName("ACES")
        self.viewtm_aces.setDescription("the ACES 1.0 RRT")
        transform = ocio.GroupTransform(
            [
                ocio.ColorSpaceTransform(
                    src=self.cs_ref.name,
                    dst=self.cs_ap0.name
                ),
                ocio.BuiltinTransform(style="ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - SDR-VIDEO_1.0"),
            ]
        )
        self.viewtm_aces.setTransform(transform, ocio.VIEWTRANSFORM_DIR_FROM_REFERENCE)
        self.add(self.viewtm_aces)

        self.config.setDefaultViewTransformName(self.viewtm_pass.getName())
        return

    def cook_display(self):

        # start by building the views
        self.view_raw = View(
            "Raw",
            description="Send data directly to the display without encoding.",
            colorspace=self.cs_raw
        )
        self.view_disp = View(
            "Display",
            description="simple display-encoding defined by the colorspace's "
                        "transfer-function",
            view_transform=self.viewtm_pass,
            colorspace=ocio.OCIO_VIEW_USE_DISPLAY_NAME
        )
        self.view_aces = View(
            "ACES",
            description="with ACES 1.0 RRT",
            view_transform=self.viewtm_aces,
            colorspace=ocio.OCIO_VIEW_USE_DISPLAY_NAME
        )

        # !! order is important !!
        all_views = [self.view_disp, self.view_aces, self.view_raw]

        # then build the displays,
        # re-use the name from the associated display colorspaces.
        # ! remember that first one added will be default !
        self.dp_srgb = Display(
            self.cs_srgb.name,
            all_views
        )
        self.add(self.dp_srgb)

        self.dp_bt709 = Display(
            self.cs_bt709.name,
            all_views
        )
        self.add(self.dp_bt709)

        self.dp_p3_d = Display(
            self.cs_p3_d.name,
            all_views
        )
        self.add(self.dp_p3_d)

        self.dp_p3_dci = Display(
            self.cs_p3_dci.name,
            all_views
        )
        self.add(self.dp_p3_dci)

        self.dp_p3_dci_d65 = Display(
            self.cs_p3_dci_d65.name,
            all_views
        )
        self.add(self.dp_p3_dci_d65)

        # set all displays as active
        self.config.setActiveDisplays(
            ",".join(map(str, self.displays))
        )

        return

    def cook_roles(self):

        self.config.setRole(ocio.ROLE_INTERCHANGE_SCENE, self.cs_ref.name)
        self.config.setRole(ocio.ROLE_INTERCHANGE_DISPLAY, self.cs_ref.name)
        self.config.setRole(ocio.ROLE_SCENE_LINEAR, self.cs_srgb_lin.name)
        self.config.setRole(ocio.ROLE_REFERENCE, self.cs_ref.name)
        self.config.setRole(ocio.ROLE_DATA, self.cs_raw.name)
        self.config.setRole(ocio.ROLE_DEFAULT, self.cs_raw.name)
        self.config.setRole(ocio.ROLE_COLOR_PICKING, self.cs_srgb.name)
        self.config.setRole(ocio.ROLE_MATTE_PAINT, self.cs_srgb.name)
        self.config.setRole(ocio.ROLE_TEXTURE_PAINT, self.cs_srgb_lin.name)
        self.config.setRole(ocio.ROLE_COMPOSITING_LOG, self.cs_acescct.name)

        return

    def cook_misc(self):

        self.file_rules = ocio.FileRules()
        self.file_rules.insertRule(
            0,
            "exr",
            str(self.cs_raw),
            "*",
            "exr"
        )
        self.file_rules.insertRule(
            1,
            "jpg",
            str(self.cs_srgb),
            "*",
            "jpg"
        )
        self.file_rules.insertRule(
            2,
            "png",
            str(self.cs_srgb),
            "*",
            "png"
        )
        self.file_rules.insertRule(
            3,
            "tx",
            str(self.cs_raw),
            "*",
            "tx"
        )
        self.file_rules.insertRule(
            4,
            "tex",
            str(self.cs_raw),
            "*",
            "tex"
        )
        self.file_rules.insertRule(
            5,
            "hdr",
            str(self.cs_srgb_lin),
            "*",
            "hdr"
        )
        self.config.setFileRules(self.file_rules)
        pass