X-Git-Url: http://users.mur.at/ms/git/gitweb/?a=blobdiff_plain;f=aces_1.0.0%2Fpython%2Faces_ocio%2Fcolorspaces%2Faces.py;h=ce73beef69f62a84ab8a36dc9a736f3659b98e5e;hb=008ab628a49b703cd1141a39b7963947adce9e99;hp=5996b438d916c31da62ab5e417429e7445b9a413;hpb=b05a1064b4e4b9a6b1cfc5ccd8c249d19e007330;p=OpenColorIO-Configs.git diff --git a/aces_1.0.0/python/aces_ocio/colorspaces/aces.py b/aces_1.0.0/python/aces_ocio/colorspaces/aces.py index 5996b43..ce73bee 100644 --- a/aces_1.0.0/python/aces_ocio/colorspaces/aces.py +++ b/aces_1.0.0/python/aces_ocio/colorspaces/aces.py @@ -7,6 +7,7 @@ Implements support for *ACES* colorspaces conversions and transfer functions. from __future__ import division +import copy import math import numpy import os @@ -34,17 +35,24 @@ __email__ = 'aces@oscars.org' __status__ = 'Production' __all__ = ['ACES_AP1_TO_AP0', + 'ACES_AP0_TO_AP1', 'ACES_AP0_TO_XYZ', + 'ACES_XYZ_TO_AP0', 'create_ACES', 'create_ACEScc', 'create_ACESproxy', 'create_ACEScg', 'create_ADX', - 'create_ACES_LMT', - 'create_ACES_RRT_plus_ODT', 'create_generic_log', + 'create_Dolby_PQ', + 'create_Dolby_PQ_shaper', + 'create_ACES_LMT', 'create_LMTs', + 'create_ACES_RRT_plus_ODT', 'create_ODTs', + 'create_shapers_dolbypq' + 'create_shapers_log2', + 'create_shapers', 'get_transform_info', 'get_ODTs_info', 'get_LMTs_info', @@ -73,17 +81,16 @@ ACES_XYZ_TO_AP0 = [1.0498110175, 0.0000000000, -0.0000974845, def create_ACES(): """ - Object description. + Creates the *ACES2065-1* reference color space Parameters ---------- - parameter : type - Parameter description. + None Returns ------- - type - Return value description. + ColorSpace + *ACES2065-1* and all its identifying information """ # Defining the reference colorspace. @@ -109,17 +116,31 @@ def create_ACEScc(aces_ctl_directory, max_value=1, input_scale=1): """ - Creates the *ACEScc* colorspace. + Creates the *ACEScc* reference color space Parameters ---------- - parameter : type - Parameter description. + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_1d : int + The resolution of generated 1D LUTs + cleanup : bool + Whether or not to clean up the intermediate images + name : str or unicode, optional + The name of the ColorSpace + min_value : float, optional + The minimum value to consider for the space + max_value : float, optional + The maximum value to consider for the space + input_scale : float, optional + A scale factor to divide input values Returns ------- - Colorspace - *ACEScc* colorspace. + ColorSpace + *ACEScc* and all its identifying information """ cs = ColorSpace(name) @@ -166,7 +187,7 @@ def create_ACEScc(aces_ctl_directory, 'interpolation': 'linear', 'direction': 'forward'}) - # *AP1* primaries to *AP0* primaries. + # *AP1* primaries to *AP0* primaries cs.to_reference_transforms.append({ 'type': 'matrix', 'matrix': mat44_from_mat33(ACES_AP1_TO_AP0), @@ -182,17 +203,25 @@ def create_ACESproxy(aces_ctl_directory, cleanup, name='ACESproxy'): """ - Creates the *ACESproxy* colorspace. + Creates the *ACESproxy* color space Parameters ---------- - parameter : type - Parameter description. + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_1d : int + The resolution of generated 1D LUTs + cleanup : bool + Whether or not to clean up the intermediate images + name : str or unicode, optional + The name of the ColorSpace Returns ------- - Colorspace - *ACESproxy* colorspace. + ColorSpace + *ACESproxy* and all its identifying information """ cs = ColorSpace(name) @@ -238,7 +267,7 @@ def create_ACESproxy(aces_ctl_directory, 'interpolation': 'linear', 'direction': 'forward'}) - # *AP1* primaries to *AP0* primaries. + # *AP1* primaries to *AP0* primaries cs.to_reference_transforms.append({ 'type': 'matrix', 'matrix': mat44_from_mat33(ACES_AP1_TO_AP0), @@ -251,25 +280,22 @@ def create_ACESproxy(aces_ctl_directory, # ------------------------------------------------------------------------- # *ACEScg* # ------------------------------------------------------------------------- -def create_ACEScg(aces_ctl_directory, - lut_directory, - lut_resolution_1d, - cleanup, - name='ACEScg'): +def create_ACEScg(): """ - Creates the *ACEScg* colorspace. + Creates the *ACEScg* color space Parameters ---------- - parameter : type - Parameter description. + None Returns ------- - Colorspace - *ACEScg* colorspace. + ColorSpace + *ACEScg* and all its identifying information """ + name = 'ACEScg' + cs = ColorSpace(name) cs.description = 'The %s color space' % name cs.aliases = ['acescg', 'lin_ap1'] @@ -283,7 +309,7 @@ def create_ACEScg(aces_ctl_directory, cs.to_reference_transforms = [] - # *AP1* primaries to *AP0* primaries. + # *AP1* primaries to *AP0* primaries cs.to_reference_transforms.append({ 'type': 'matrix', 'matrix': mat44_from_mat33(ACES_AP1_TO_AP0), @@ -291,11 +317,15 @@ def create_ACEScg(aces_ctl_directory, cs.from_reference_transforms = [] - # *AP1* primaries to *AP0* primaries. - cs.from_reference_transforms.append({ - 'type': 'matrix', - 'matrix': mat44_from_mat33(ACES_AP0_TO_AP1), - 'direction': 'forward'}) + # Commented out because specifying the inverse matrix causes some + # of OCIO's checks to see if a set of transforms can be collapsed + # to fail. + + # *AP1* primaries to *AP0* primaries + #cs.from_reference_transforms.append({ + # 'type': 'matrix', + # 'matrix': mat44_from_mat33(ACES_AP0_TO_AP1), + # 'direction': 'forward'}) return cs @@ -304,21 +334,24 @@ def create_ACEScg(aces_ctl_directory, # *ADX* # ------------------------------------------------------------------------- def create_ADX(lut_directory, - lut_resolution_1d, bit_depth=10, name='ADX'): """ - Creates the *ADX* colorspace. + Creates the *ADX* color space Parameters ---------- - parameter : type - Parameter description. + lut_directory : str or unicode + The directory to use when generating LUTs + bit_depth : int + Choose either 10 or 16 bit ADX + name : str or unicode, optional + The name of the ColorSpace Returns ------- - Colorspace - *ADX* colorspace. + ColorSpace + *ADX* and all its identifying information """ name = '%s%s' % (name, bit_depth) @@ -357,7 +390,8 @@ def create_ADX(lut_directory, 'offset': offset, 'direction': 'forward'}) - # Convert from Channel-Dependent Density to Channel-Independent Density + # Converting from *Channel-Dependent Density* to + # *Channel-Independent Density*. cs.to_reference_transforms.append({ 'type': 'matrix', 'matrix': [0.75573, 0.22197, 0.02230, 0, @@ -457,7 +491,7 @@ def create_ADX(lut_directory, # ------------------------------------------------------------------------- -# *Generic Log Transform* +# Generic *Log* Transform # ------------------------------------------------------------------------- def create_generic_log(aces_ctl_directory, lut_directory, @@ -469,19 +503,43 @@ def create_generic_log(aces_ctl_directory, max_value=1, input_scale=1, middle_grey=0.18, - min_exposure=-6, + min_exposure=-6.5, max_exposure=6.5): """ Creates the *Generic Log* colorspace. Parameters ---------- - parameter : type - Parameter description. + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_1d : int + The resolution of generated 1D LUTs + cleanup : bool + Whether or not to clean up the intermediate images + name : str or unicode, optional + The name of the ColorSpace + aliases : list of str or unicode, optional + The alias names to use for the ColorSpace + min_value : float, optional + The minimum value to consider for the space + max_value : float, optional + The maximum value to consider for the space + input_scale : float, optional + A scale factor to divide input values + middle_grey : float, optional + The middle of the dynamic range covered by the transfer function + min_exposure : float, optional + The offset from middle grey, in stops, that defines the low end of the dynamic + range covered by the transfer function + max_exposure : float, optional + The offset from middle grey, in stops, that defines the high end of the dynamic + range covered by the transfer function Returns ------- - Colorspace + ColorSpace *Generic Log* colorspace. """ @@ -531,17 +589,47 @@ def create_generic_log(aces_ctl_directory, # ------------------------------------------------------------------------- -# *base Dolby PQ Transform* +# Base *Dolby PQ* Transform # ------------------------------------------------------------------------- def create_Dolby_PQ(aces_ctl_directory, - lut_directory, - lut_resolution_1d, - cleanup, - name='pq', - aliases=None, - min_value=0.0, - max_value=1.0, - input_scale=1.0): + lut_directory, + lut_resolution_1d, + cleanup, + name='pq', + aliases=None, + min_value=0.0, + max_value=1.0, + input_scale=1.0): + """ + Creates the generic *Dolby PQ* colorspace. + + Parameters + ---------- + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_1d : int + The resolution of generated 1D LUTs + cleanup : bool + Whether or not to clean up the intermediate images + name : str or unicode, optional + The name of the ColorSpace + aliases : list of str or unicode, optional + The alias names to use for the ColorSpace + min_value : float, optional + The minimum value to consider for the space + max_value : float, optional + The maximum value to consider for the space + input_scale : float, optional + A scale factor to divide input values + + Returns + ------- + ColorSpace + Generic *Dolby PQ* colorspace. + """ + if aliases is None: aliases = [] @@ -585,20 +673,58 @@ def create_Dolby_PQ(aces_ctl_directory, # ------------------------------------------------------------------------- -# *Dolby PQ Transform that considers a fixed linear range* +# *Dolby PQ* Transform - Fixed Linear Range # ------------------------------------------------------------------------- -def create_Dolby_PQ_scaled(aces_ctl_directory, - lut_directory, - lut_resolution_1d, - cleanup, - name='pq', - aliases=None, - min_value=0.0, - max_value=1.0, - input_scale=1.0, - middle_grey=0.18, - min_exposure=-6.0, - max_exposure=6.5): +def create_Dolby_PQ_shaper(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup, + name='pq', + aliases=None, + min_value=0.0, + max_value=1.0, + input_scale=1.0, + middle_grey=0.18, + min_exposure=-6.5, + max_exposure=6.5): + """ + Creates a *Dolby PQ* colorspace that covers a specific dynamic range + + Parameters + ---------- + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_1d : int + The resolution of generated 1D LUTs + cleanup : bool + Whether or not to clean up the intermediate images + name : str or unicode, optional + The name of the ColorSpace + aliases : list of str or unicode, optional + The alias names to use for the ColorSpace + min_value : float, optional + The minimum value to consider for the space + max_value : float, optional + The maximum value to consider for the space + input_scale : float, optional + A scale factor to divide input values + middle_grey : float, optional + The middle of the dynamic range covered by the transfer function + min_exposure : float, optional + The offset from middle grey, in stops, that defines the low end of the dynamic + range covered by the transfer function + max_exposure : float, optional + The offset from middle grey, in stops, that defines the high end of the dynamic + range covered by the transfer function + + Returns + ------- + ColorSpace + A *Dolby PQ* colorspace that covers a specific dynamic range + """ + if aliases is None: aliases = [] @@ -612,7 +738,7 @@ def create_Dolby_PQ_scaled(aces_ctl_directory, ctls = [os.path.join( aces_ctl_directory, 'utilities', - 'ACESlib.DolbyPQ_to_lin_param.a1.0.0.ctl')] + 'ACESlib.OCIOshaper_to_Lin_param.a1.0.0.ctl')] lut = '%s_to_linear.spi1d' % name lut = sanitize(lut) @@ -644,29 +770,43 @@ def create_Dolby_PQ_scaled(aces_ctl_directory, # ------------------------------------------------------------------------- -# *Individual LMT* +# Individual *LMT* # ------------------------------------------------------------------------- def create_ACES_LMT(lmt_name, lmt_values, shaper_info, aces_ctl_directory, lut_directory, - lut_resolution_1d=1024, lut_resolution_3d=64, cleanup=True, aliases=None): """ - Creates the *ACES LMT* colorspace. + Creates an *ACES Look Transform (LMT)* colorspace. Parameters ---------- - parameter : type - Parameter description. + lmt_name : str or unicode + The name of the Look Transform (LMT) + lmt_values : dict + A collection of values that define the Look Transform's attributes and behavior + shaper_info : dict + A collection of values that define the Shaper to use when generating LUTs to + represent the Look Transform + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_3d : int, optional + The resolution of generated 3D LUTs + cleanup : bool, optional + Whether or not to clean up the intermediate images + aliases : list of str or unicode, optional + The alias names to use for the ColorSpace Returns ------- - Colorspace - *ACES LMT* colorspace. + ColorSpace + An *ACES LMT* colorspace. """ if aliases is None: @@ -691,7 +831,6 @@ def create_ACES_LMT(lmt_name, shaper_input_scale, shaper_params) = shaper_info - # Add the shaper transform shaper_lut = '%s_to_linear.spi1d' % shaper_name shaper_lut = sanitize(shaper_lut) @@ -737,7 +876,7 @@ def create_ACES_LMT(lmt_name, ctls = [os.path.join(aces_ctl_directory, lmt_values['transformCTLInverse']), shaper_from_aces_ctl % aces_ctl_directory] - lut = 'Inverse.%s.%s.spi3d' % (odt_name, shaper_name) + lut = 'Inverse.%s.%s.spi3d' % (lmt_name, shaper_name) lut = sanitize(lut) @@ -774,20 +913,32 @@ def create_LMTs(aces_ctl_directory, lut_resolution_1d, lut_resolution_3d, lmt_info, - shaper_name, cleanup): """ - Object description. + Create ColorSpaces representing the *ACES Look Transforms* Parameters ---------- - parameter : type - Parameter description. + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_1d : int + The resolution of generated 1D LUTs + lut_resolution_3d : int + The resolution of generated 3D LUTs + cleanup : bool + Whether or not to clean up the intermediate images + aliases : list of str or unicode, optional + The alias names to use for the ColorSpace + lmt_info : dict + A collection of values that define the Look Transforms that need to be + generated Returns ------- - type - Return value description. + list of ColorSpaces + ColorSpaces representing the *ACES Look Transforms* """ colorspaces = [] @@ -842,7 +993,6 @@ def create_LMTs(aces_ctl_directory, lmt_shaper_data, aces_ctl_directory, lut_directory, - lmt_lut_resolution_1d, lmt_lut_resolution_3d, cleanup, lmt_aliases) @@ -859,22 +1009,36 @@ def create_ACES_RRT_plus_ODT(odt_name, shaper_info, aces_ctl_directory, lut_directory, - lut_resolution_1d=1024, lut_resolution_3d=64, cleanup=True, aliases=None): """ - Object description. + Creates an *ACES Output Transform (RRT + ODT)* colorspace. Parameters ---------- - parameter : type - Parameter description. + odt_name : str or unicode + The name of the Output Transform (RRT + ODT) + odt_values : dict + A collection of values that define the Output Transform's attributes and behavior + shaper_info : dict + A collection of values that define the Shaper to use when generating LUTs to + represent the Output Transform + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_3d : int, optional + The resolution of generated 3D LUTs + cleanup : bool, optional + Whether or not to clean up the intermediate images + aliases : list of str or unicode, optional + The alias names to use for the ColorSpace Returns ------- - type - Return value description. + ColorSpace + An *ACES Output Transform (RRT + ODT)* colorspace. """ if aliases is None: @@ -904,7 +1068,6 @@ def create_ACES_RRT_plus_ODT(odt_name, else: shaper_params['legalRange'] = 0 - # Add the shaper transform shaper_lut = '%s_to_linear.spi1d' % shaper_name shaper_lut = sanitize(shaper_lut) @@ -944,7 +1107,6 @@ def create_ACES_RRT_plus_ODT(odt_name, generate_3d_LUT_from_CTL( os.path.join(lut_directory, lut), - # shaperLUT, ctls, lut_resolution_3d, 'float', @@ -993,7 +1155,6 @@ def create_ACES_RRT_plus_ODT(odt_name, generate_3d_LUT_from_CTL( os.path.join(lut_directory, lut), - # None, ctls, lut_resolution_3d, 'half', @@ -1015,48 +1176,57 @@ def create_ACES_RRT_plus_ODT(odt_name, return cs - # ------------------------------------------------------------------------- -# *ODTs* +# *Log 2 Shapers* # ------------------------------------------------------------------------- -def create_ODTs(aces_ctl_directory, - lut_directory, - lut_resolution_1d, - lut_resolution_3d, - odt_info, - shaper_name, - cleanup, - linear_display_space, - log_display_space): +def create_shapers_log2(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup, + shaper_name, + middle_grey, + min_exposure, + max_exposure): """ - Object description. + Creates a *Log base 2* colorspace that covers a specific dynamic range Parameters ---------- - parameter : type - Parameter description. + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_1d : int + The resolution of generated 1D LUTs + cleanup : bool + Whether or not to clean up the intermediate images + shaper_name : str or unicode, optional + The name of the ColorSpace + middle_grey : float + The middle of the dynamic range covered by the transfer function + min_exposure : float + The offset from middle grey, in stops, that defines the low end of the dynamic + range covered by the transfer function + max_exposure : float + The offset from middle grey, in stops, that defines the high end of the dynamic + range covered by the transfer function Returns ------- - type - Return value description. + ColorSpace + A *Log base 2* colorspace that covers a specific dynamic range """ colorspaces = [] - displays = {} - - # ------------------------------------------------------------------------- - # *RRT / ODT* Shaper Options - # ------------------------------------------------------------------------- shaper_data = {} - # Defining the *Log 2* shaper. + # Defining the *Log 2* shaper for *ODTs covering 48 nit output*. log2_shaper_name = shaper_name log2_shaper_name_aliases = ['crv_%s' % compact(log2_shaper_name)] log2_params = { - 'middleGrey': 0.18, - 'minExposure': -6, - 'maxExposure': 6.5} + 'middleGrey': middle_grey, + 'minExposure': min_exposure, + 'maxExposure': max_exposure} log2_shaper_colorspace = create_generic_log( aces_ctl_directory, @@ -1086,38 +1256,18 @@ def create_ODTs(aces_ctl_directory, shaper_data[log2_shaper_name] = log2_shaper_data - # Space with a more user-friendly name. Direct copy otherwise. - log2_shaper_copy_name = 'Log2 Shaper' - log2_shaper_copy_colorspace = ColorSpace(log2_shaper_copy_name) - log2_shaper_copy_colorspace.description = ( - 'The %s color space' % log2_shaper_copy_name) - log2_shaper_copy_colorspace.aliases = [ - 'crv_%s' % compact(log2_shaper_copy_name)] - log2_shaper_copy_colorspace.equality_group = log2_shaper_copy_name - log2_shaper_copy_colorspace.family = log2_shaper_colorspace.family - log2_shaper_copy_colorspace.is_data = log2_shaper_colorspace.is_data - log2_shaper_copy_colorspace.to_reference_transforms = list( - log2_shaper_colorspace.to_reference_transforms) - log2_shaper_copy_colorspace.from_reference_transforms = list( - log2_shaper_colorspace.from_reference_transforms) - colorspaces.append(log2_shaper_copy_colorspace) - # Defining the *Log2 shaper that includes the AP1* primaries. - log2_shaper_api1_name = '%s - AP1' % 'Log2 Shaper' - log2_shaper_api1_colorspace = ColorSpace(log2_shaper_api1_name) + log2_shaper_api1_name = '%s - AP1' % log2_shaper_name + log2_shaper_api1_colorspace = copy.deepcopy(log2_shaper_colorspace) + + log2_shaper_api1_colorspace.name = log2_shaper_api1_name log2_shaper_api1_colorspace.description = ( 'The %s color space' % log2_shaper_api1_name) log2_shaper_api1_colorspace.aliases = [ - '%s_ap1' % compact(log2_shaper_copy_name)] + '%s_ap1' % compact(log2_shaper_name)] log2_shaper_api1_colorspace.equality_group = log2_shaper_api1_name - log2_shaper_api1_colorspace.family = log2_shaper_colorspace.family - log2_shaper_api1_colorspace.is_data = log2_shaper_colorspace.is_data - log2_shaper_api1_colorspace.to_reference_transforms = list( - log2_shaper_colorspace.to_reference_transforms) - log2_shaper_api1_colorspace.from_reference_transforms = list( - log2_shaper_colorspace.from_reference_transforms) - - # *AP1* primaries to *AP0* primaries. + + # *AP1* primaries to *AP0* primaries log2_shaper_api1_colorspace.to_reference_transforms.append({ 'type': 'matrix', 'matrix': mat44_from_mat33(ACES_AP1_TO_AP0), @@ -1125,83 +1275,354 @@ def create_ODTs(aces_ctl_directory, }) colorspaces.append(log2_shaper_api1_colorspace) - # Defining the *Log2 shaper that includes the AP1* primaries. - # Named with 'shaper_name' variable. Needed for some LUT baking steps. - shaper_api1_name = '%s - AP1' % shaper_name - shaper_api1_colorspace = ColorSpace(shaper_api1_name) - shaper_api1_colorspace.description = ( - 'The %s color space' % shaper_api1_name) - shaper_api1_colorspace.aliases = ['%s_ap1' % compact(shaper_name)] - shaper_api1_colorspace.equality_group = shaper_api1_name - shaper_api1_colorspace.family = log2_shaper_colorspace.family - shaper_api1_colorspace.is_data = log2_shaper_colorspace.is_data - shaper_api1_colorspace.to_reference_transforms = list( - log2_shaper_api1_colorspace.to_reference_transforms) - shaper_api1_colorspace.from_reference_transforms = list( - log2_shaper_api1_colorspace.from_reference_transforms) - colorspaces.append(shaper_api1_colorspace) - - # Define the base *Dolby PQ Shaper* - # - dolbypq_shaper_name = 'Dolby PQ 10000' - dolbypq_shaper_name_aliases = ['crv_%s' % 'dolbypq_10000'] + return shaper_data, colorspaces - dolbypq_shaper_colorspace = create_Dolby_PQ( +# ------------------------------------------------------------------------- +# *Dolby PQ-based Shapers* +# ------------------------------------------------------------------------- +def create_shapers_dolbypq(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup, + shaper_name, + middle_grey, + min_exposure, + max_exposure): + """ + Creates two *Dolby PQ* colorspaces, one with now gamut conversion, the other with + the conversion from *ACES* *AP0* to *AP1* + + Parameters + ---------- + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_1d : int + The resolution of generated 1D LUTs + cleanup : bool + Whether or not to clean up the intermediate images + shaper_name : str or unicode, optional + The name of the ColorSpace + middle_grey : float + The middle of the dynamic range covered by the transfer function + min_exposure : float + The offset from middle grey, in stops, that defines the low end of the dynamic + range covered by the transfer function + max_exposure : float + The offset from middle grey, in stops, that defines the high end of the dynamic + range covered by the transfer function + + Returns + ------- + dict + Values defining a Shaper + list of ColorSpaces + A list of *Dolby PQ* colorspaces that covers a specific dynamic range + """ + colorspaces = [] + shaper_data = {} + + # Define the *Dolby PQ Shaper that considers a fixed linear range* + dolby_pq_shaper_name = shaper_name + dolby_pq_shaper_name_aliases = ['crv_%s' % compact(dolby_pq_shaper_name)] + + dolby_pq_params = { + 'middleGrey': middle_grey, + 'minExposure': min_exposure, + 'maxExposure': max_exposure} + + dolby_pq_shaper_colorspace = create_Dolby_PQ_shaper( aces_ctl_directory, lut_directory, lut_resolution_1d, cleanup, - name=dolbypq_shaper_name, - aliases=dolbypq_shaper_name_aliases) - colorspaces.append(dolbypq_shaper_colorspace) + name=dolby_pq_shaper_name, + aliases=dolby_pq_shaper_name_aliases, + middle_grey=dolby_pq_params['middleGrey'], + min_exposure=dolby_pq_params['minExposure'], + max_exposure=dolby_pq_params['maxExposure']) + colorspaces.append(dolby_pq_shaper_colorspace) # *Dolby PQ* shaper name and *CTL* transforms bundled up. - dolbypq_shaper_data = [ - dolbypq_shaper_name, + dolby_pq_shaper_data = [ + dolby_pq_shaper_name, os.path.join('%s', 'utilities', - 'ACESlib.DolbyPQ_to_Lin.a1.0.0.ctl'), + 'ACESlib.OCIOshaper_to_Lin_param.a1.0.0.ctl'), os.path.join('%s', 'utilities', - 'ACESlib.Lin_to_DolbyPQ.a1.0.0.ctl'), + 'ACESlib.Lin_to_OCIOshaper_param.a1.0.0.ctl'), 1.0, - {}] + dolby_pq_params] - shaper_data[dolbypq_shaper_name] = dolbypq_shaper_data + shaper_data[dolby_pq_shaper_name] = dolby_pq_shaper_data - # Define the *Dolby PQ Shaper that considers a fixed linear range* + # Defining the *Dolby PQ shaper that includes the AP1* primaries. + dolby_pq_shaper_api1_name = '%s - AP1' % dolby_pq_shaper_name + dolby_pq_shaper_api1_colorspace = copy.deepcopy(dolby_pq_shaper_colorspace) + + dolby_pq_shaper_api1_colorspace.name = dolby_pq_shaper_api1_name + dolby_pq_shaper_api1_colorspace.description = ( + 'The %s color space' % dolby_pq_shaper_api1_name) + dolby_pq_shaper_api1_colorspace.aliases = [ + '%s_ap1' % compact(dolby_pq_shaper_name)] + dolby_pq_shaper_api1_colorspace.equality_group = dolby_pq_shaper_api1_name + + # *AP1* primaries to *AP0* primaries + dolby_pq_shaper_api1_colorspace.to_reference_transforms.append({ + 'type': 'matrix', + 'matrix': mat44_from_mat33(ACES_AP1_TO_AP0), + 'direction': 'forward' + }) + colorspaces.append(dolby_pq_shaper_api1_colorspace) + + return shaper_data, colorspaces + + +# ------------------------------------------------------------------------- +# *Shapers* +# ------------------------------------------------------------------------- +def create_shapers(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup): + + """ + Creates sets of shaper colorspaces covering the *Log 2* and *Dolby PQ* + transfer functions and dynamic ranges suitable of use with the 48 nit, + 1000 nit, 2000 nit and 4000 nit *ACES Output Transforms* + + Parameters + ---------- + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_1d : int + The resolution of generated 1D LUTs + cleanup : bool + Whether or not to clean up the intermediate images + + Returns + ------- + list of dicts + Values defining a set of Shapers + list of ColorSpaces + A list of Shaper colorspaces that covers a varying dynamic ranges and + transfer functions + """ + + colorspaces = [] + shaper_data = {} + + # Define the base *Log2 48 nits shaper* # - dolbypq_scaled_shaper_name = 'Dolby PQ Scaled' - dolbypq_scaled_shaper_name_aliases = ['crv_%s' % 'dolbypq_scaled'] + (log2_48nits_shaper_data, + log2_48nits_colorspaces) = create_shapers_log2(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup, + 'Log2 48 nits Shaper', + 0.18, + -6.5, + 6.5) + colorspaces.extend(log2_48nits_colorspaces) + shaper_data.update(log2_48nits_shaper_data) + + # Define the base *Log2 1000 nits shaper* + # + (log2_1000nits_shaper_data, + log2_1000nits_colorspaces) = create_shapers_log2(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup, + 'Log2 1000 nits Shaper', + 0.18, + -12.0, + 10.0) + colorspaces.extend(log2_1000nits_colorspaces) + shaper_data.update(log2_1000nits_shaper_data) + + # Define the base *Log2 2000 nits shaper* + # + (log2_2000nits_shaper_data, + log2_2000nits_colorspaces) = create_shapers_log2(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup, + 'Log2 2000 nits Shaper', + 0.18, + -12.0, + 11.0) + colorspaces.extend(log2_2000nits_colorspaces) + shaper_data.update(log2_2000nits_shaper_data) + + # Define the base *Log2 4000 nits shaper* + # + (log2_4000nits_shaper_data, + log2_4000nits_colorspaces) = create_shapers_log2(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup, + 'Log2 4000 nits Shaper', + 0.18, + -12.0, + 12.0) + colorspaces.extend(log2_4000nits_colorspaces) + shaper_data.update(log2_4000nits_shaper_data) + + # Define the base *Dolby PQ transfer function* + # + dolby_pq_shaper_name = 'Dolby PQ 10000' + dolby_pq_shaper_name_aliases = ['crv_%s' % 'dolbypq_10000'] - dolbypq_scaled_shaper_colorspace = create_Dolby_PQ_scaled( + dolby_pq_shaper_colorspace = create_Dolby_PQ( aces_ctl_directory, lut_directory, lut_resolution_1d, cleanup, - name=dolbypq_scaled_shaper_name, - aliases=dolbypq_scaled_shaper_name_aliases) - colorspaces.append(dolbypq_scaled_shaper_colorspace) + name=dolby_pq_shaper_name, + aliases=dolby_pq_shaper_name_aliases) + colorspaces.append(dolby_pq_shaper_colorspace) # *Dolby PQ* shaper name and *CTL* transforms bundled up. - dolbypq_scaled_shaper_data = [ - dolbypq_scaled_shaper_name, + dolby_pq_shaper_data = [ + dolby_pq_shaper_name, os.path.join('%s', 'utilities', - 'ACESlib.DolbyPQ_to_Lin_param.a1.0.0.ctl'), + 'ACESlib.DolbyPQ_to_Lin.a1.0.0.ctl'), os.path.join('%s', 'utilities', - 'ACESlib.Lin_to_DolbyPQ_param.a1.0.0.ctl'), + 'ACESlib.Lin_to_DolbyPQ.a1.0.0.ctl'), 1.0, - log2_params] + {}] - shaper_data[dolbypq_scaled_shaper_name] = dolbypq_scaled_shaper_data + shaper_data[dolby_pq_shaper_name] = dolby_pq_shaper_data + # Define the *Dolby PQ 48 nits shaper* + # + (dolbypq_48nits_shaper_data, + dolbypq_48nits_colorspaces) = create_shapers_dolbypq(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup, + 'Dolby PQ 48 nits Shaper', + 0.18, + -6.5, + 6.5) + colorspaces.extend(dolbypq_48nits_colorspaces) + shaper_data.update(dolbypq_48nits_shaper_data) + + # Define the *Dolby PQ 1000 nits shaper* + # + (dolbypq_1000nits_shaper_data, + dolbypq_1000nits_colorspaces) = create_shapers_dolbypq(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup, + 'Dolby PQ 1000 nits Shaper', + 0.18, + -12.0, + 10.0) + colorspaces.extend(dolbypq_1000nits_colorspaces) + shaper_data.update(dolbypq_1000nits_shaper_data) + + # Define the *Dolby PQ 2000 nits shaper* # - # Pick a specific shaper + (dolbypq_2000nits_shaper_data, + dolbypq_2000nits_colorspaces) = create_shapers_dolbypq(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup, + 'Dolby PQ 2000 nits Shaper', + 0.18, + -12.0, + 11.0) + colorspaces.extend(dolbypq_2000nits_colorspaces) + shaper_data.update(dolbypq_2000nits_shaper_data) + + # Define the *Dolby PQ 4000 nits shaper* # - rrt_shaper = log2_shaper_data - # rrt_shaper = dolbypq_scaled_shaper_data + (dolbypq_4000nits_shaper_data, + dolbypq_4000nits_colorspaces) = create_shapers_dolbypq(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup, + 'Dolby PQ 4000 nits Shaper', + 0.18, + -12.0, + 12.0) + colorspaces.extend(dolbypq_4000nits_colorspaces) + shaper_data.update(dolbypq_4000nits_shaper_data) + + return shaper_data, colorspaces + +# ------------------------------------------------------------------------- +# *ODTs* +# ------------------------------------------------------------------------- +def create_ODTs(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + lut_resolution_3d, + odt_info, + shaper_name, + cleanup, + linear_display_space, + log_display_space): + """ + Create ColorSpaces representing the *ACES Output Transforms* + + Parameters + ---------- + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_1d : int + The resolution of generated 1D LUTs + lut_resolution_3d : int + The resolution of generated 3D LUTs + odt_info : dict + A collection of values that define the Output Transforms that need to be + generated + shaper_name : str or unicode, optional + The name of Shaper ColorSpace to use when generating LUTs + cleanup : bool + Whether or not to clean up the intermediate images + linear_display_space : lstr or unicode + The name of the ColorSpace to use for the raw or linear View + log_display_space : lstr or unicode + The name of the ColorSpace to use for the log View + + Returns + ------- + list of ColorSpaces + ColorSpaces representing the *ACES Output Transforms* + list of dicts + Collections of names and ColorSpaces corresponding to the Displays and + Views + """ + + colorspaces = [] + displays = {} + + # ------------------------------------------------------------------------- + # *RRT / ODT* Shaper Options + # ------------------------------------------------------------------------- + shaper_data, shaper_colorspaces = create_shapers(aces_ctl_directory, + lut_directory, + lut_resolution_1d, + cleanup) + + colorspaces.extend(shaper_colorspaces) + + # Assumes shaper has variants covering the range expected by the + # 48 nit, 1000 nit, 2000 nit and 4000 nit Ouput Transforms + rrt_shaper_48nits = shaper_data[shaper_name] + rrt_shaper_1000nits = shaper_data[shaper_name.replace("48 nits", "1000 nits")] + rrt_shaper_2000nits = shaper_data[shaper_name.replace("48 nits", "2000 nits")] + rrt_shaper_4000nits = shaper_data[shaper_name.replace("48 nits", "4000 nits")] # *RRT + ODT* combinations. sorted_odts = sorted(odt_info.iteritems(), key=lambda x: x[1]) @@ -1209,31 +1630,28 @@ def create_ODTs(aces_ctl_directory, for odt in sorted_odts: (odt_name, odt_values) = odt - # Generating only full range transform for *ODTs* that can generate - # either *legal* or *full* output. - - # Uncomment these lines and the lower section and - # flip the 'legalRange' value to 1 to recover the old behavior, - # where both legal and full range LUTs were generated. if odt_values['transformHasFullLegalSwitch']: - # odt_name_legal = '%s - Legal' % odt_values['transformUserName'] odt_legal['legalRange'] = 0 - # else: - # odt_name_legal = odt_values['transformUserName'] odt_name_legal = odt_values['transformUserName'] - odt_legal = odt_values.copy() - odt_aliases = ['out_%s' % compact(odt_name_legal)] + if odt_name_legal in ['P3-D60 PQ (1000 nits)']: + rrt_shaper = rrt_shaper_1000nits + elif odt_name_legal in ['P3-D60 PQ (2000 nits)']: + rrt_shaper = rrt_shaper_2000nits + elif odt_name_legal in ['P3-D60 PQ (4000 nits)']: + rrt_shaper = rrt_shaper_4000nits + else: + rrt_shaper = rrt_shaper_48nits + cs = create_ACES_RRT_plus_ODT( odt_name_legal, odt_legal, rrt_shaper, aces_ctl_directory, lut_directory, - lut_resolution_1d, lut_resolution_3d, cleanup, odt_aliases) @@ -1244,52 +1662,24 @@ def create_ODTs(aces_ctl_directory, 'Log': log_display_space, 'Output Transform': cs} - """ - # Generating full range transform for *ODTs* that can generate - # either *legal* or *full* output. - if odt_values['transformHasFullLegalSwitch']: - print('Generating full range ODT for %s' % odt_name) - - odt_name_full = '%s - Full' % odt_values['transformUserName'] - odt_full = odt_values.copy() - odt_full['legalRange'] = 0 - - odt_full_aliases = ['out_%s' % compact(odt_name_full)] - - cs_full = create_ACES_RRT_plus_ODT( - odt_name_full, - odt_full, - rrt_shaper, - aces_ctl_directory, - lut_directory, - lut_resolution_1d, - lut_resolution_3d, - cleanup, - odt_full_aliases) - colorspaces.append(cs_full) - - displays[odt_name_full] = { - 'Raw': linear_display_space, - 'Log': log_display_space, - 'Output Transform': cs_full} - """ - - return (colorspaces, displays) + return colorspaces, displays def get_transform_info(ctl_transform): """ - Object description. + Returns the information stored in first couple of lines of an official + *ACES Transform* CTL file Parameters ---------- - parameter : type - Parameter description. + ctl_transform : str or unicode + The path to the CTL file to be scraped. Returns ------- - type - Return value description. + tuple + Combination of Transform ID, User Name, User Name Prefix and Full/Legal + switch """ with open(ctl_transform, 'rb') as fp: @@ -1302,8 +1692,8 @@ def get_transform_info(ctl_transform): transform_user_name_prefix = ( lines[2][3:].split('<')[1].split('>')[1].split('-')[0].strip()) - # Figuring out if this transform has options - # for processing full and legal range. + # Figuring out if this transform has options for processing *full* and + # *legal* ranges. transform_full_legal_switch = False for line in lines: if line.strip() == 'input varying int legalRange = 0': @@ -1311,25 +1701,26 @@ def get_transform_info(ctl_transform): transform_full_legal_switch = True break - return (transform_id, transform_user_name, transform_user_name_prefix, + return (transform_id, + transform_user_name, + transform_user_name_prefix, transform_full_legal_switch) def get_ODTs_info(aces_ctl_directory): """ - Object description. - - For versions after WGR9. + Returns the information describing the names and CTL files associated with + the *ACES Output Transforms* in a given ACES release Parameters ---------- - parameter : type - Parameter description. + aces_ctl_directory : str or unicode + The path to the base *ACES* CTL directory Returns ------- - type - Return value description. + dict of dicts + Collecton of dicts, one describing each *ACES Output Transform* """ # TODO: Investigate usage of *files_walker* definition here. @@ -1355,7 +1746,7 @@ def get_ODTs_info(aces_ctl_directory): odt_path_tokens = os.path.split(odt_path_tokens[-2]) odt_dir = os.path.join(odt_path_tokens[-1], odt_dir) - # Building full name, + # Building full name. transform_ctl = odt_tokens[-1] odt_name = string.join(transform_ctl.split('.')[1:-1], '.') @@ -1372,7 +1763,7 @@ def get_ODTs_info(aces_ctl_directory): os.path.join(odt_tokens[-2], transform_ctl_inverse)): transform_ctl_inverse = None - # Add to list of ODTs + # Adding to list of *ODTs*. odts[odt_name] = {} odts[odt_name]['transformCTL'] = os.path.join(odt_dir, transform_ctl) if transform_ctl_inverse is not None: @@ -1407,19 +1798,18 @@ def get_ODTs_info(aces_ctl_directory): def get_LMTs_info(aces_ctl_directory): """ - Object description. - - For versions after WGR9. + Returns the information describing the names and CTL files associated with + the *ACES Look Transforms* in a given ACES release Parameters ---------- - parameter : type - Parameter description. + aces_ctl_directory : str or unicode + The path to the base *ACES* CTL directory Returns ------- - type - Return value description. + dict of dicts + Collecton of dicts, one describing each *ACES Look Transform* """ # TODO: Investigate refactoring with previous definition. @@ -1448,15 +1838,15 @@ def get_LMTs_info(aces_ctl_directory): lmt_dir = os.path.join(lmt_path_tokens[-1], lmt_dir) # Building full name. - transform_CTL = lmt_tokens[-1] - lmt_name = string.join(transform_CTL.split('.')[1:-1], '.') + transform_ctl = lmt_tokens[-1] + lmt_name = string.join(transform_ctl.split('.')[1:-1], '.') # Finding id, user name and user name prefix. (transform_id, transform_user_name, transform_user_name_prefix, transform_full_legal_switch) = get_transform_info( - os.path.join(aces_ctl_directory, lmt_dir, transform_CTL)) + os.path.join(aces_ctl_directory, lmt_dir, transform_ctl)) # Finding inverse. transform_ctl_inverse = 'InvLMT.%s.ctl' % lmt_name @@ -1465,7 +1855,7 @@ def get_LMTs_info(aces_ctl_directory): transform_ctl_inverse = None lmts[lmt_name] = {} - lmts[lmt_name]['transformCTL'] = os.path.join(lmt_dir, transform_CTL) + lmts[lmt_name]['transformCTL'] = os.path.join(lmt_dir, transform_ctl) if transform_ctl_inverse is not None: lmts[lmt_name]['transformCTLInverse'] = os.path.join( lmt_dir, transform_ctl_inverse) @@ -1501,17 +1891,39 @@ def create_colorspaces(aces_ctl_directory, shaper_name, cleanup): """ - Generates the colorspace conversions. + Generates the *ACES* colorspaces, displays and views Parameters ---------- - parameter : type - Parameter description. + aces_ctl_directory : str or unicode + The path to the aces 'transforms/ctl/utilities' + lut_directory : str or unicode + The directory to use when generating LUTs + lut_resolution_1d : int + The resolution of generated 1D LUTs + lut_resolution_3d : int + The resolution of generated 3D LUTs + lmt_info : dict + A collection of values that define the Look Transforms that need to be + generated + odt_info : dict + A collection of values that define the Output Transforms that need to be + generated + shaper_name : str or unicode, optional + The name of Shaper ColorSpace to use when generating LUTs + cleanup : bool + Whether or not to clean up the intermediate images Returns ------- - type - Return value description. + tuple + A collection of values defining + the reference colorspace : ACES + a list of the colorspaces created + a list of the displays created + a list of the general log colorspace + a list of the role assignments + the name of the default display """ colorspaces = [] @@ -1527,14 +1939,13 @@ def create_colorspaces(aces_ctl_directory, lut_resolution_1d, cleanup) colorspaces.append(ACESproxy) - ACEScg = create_ACEScg(aces_ctl_directory, lut_directory, - lut_resolution_1d, cleanup) + ACEScg = create_ACEScg() colorspaces.append(ACEScg) - ADX10 = create_ADX(lut_directory, lut_resolution_1d, bit_depth=10) + ADX10 = create_ADX(lut_directory, bit_depth=10) colorspaces.append(ADX10) - ADX16 = create_ADX(lut_directory, lut_resolution_1d, bit_depth=16) + ADX16 = create_ADX(lut_directory, bit_depth=16) colorspaces.append(ADX16) lmts = create_LMTs(aces_ctl_directory, @@ -1542,7 +1953,6 @@ def create_colorspaces(aces_ctl_directory, lut_resolution_1d, lut_resolution_3d, lmt_info, - shaper_name, cleanup) colorspaces.extend(lmts) @@ -1557,10 +1967,11 @@ def create_colorspaces(aces_ctl_directory, ACEScc) colorspaces.extend(odts) - # Wish there was an automatic way to get this from the CTL + # TODO: Investigate if there is a way to retrieve these values from *CTL*. default_display = 'sRGB (D60 sim.)' + color_picking = 'Rec.709' - roles = {'color_picking': ACEScg.name, + roles = {'color_picking': color_picking, 'color_timing': ACEScc.name, 'compositing_log': ACEScc.name, 'data': '', @@ -1568,6 +1979,8 @@ def create_colorspaces(aces_ctl_directory, 'matte_paint': ACEScc.name, 'reference': '', 'scene_linear': ACEScg.name, - 'texture_paint': ''} + 'texture_paint': '', + 'compositing_linear': ACEScg.name, + 'rendering': ACEScg.name} return ACES, colorspaces, displays, ACEScc, roles, default_display