aces_1.0.0/python/aces_ocio/create_arri_colorspaces.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 """
   5 Implements support for *ARRI* colorspaces conversions and transfer functions.
   6 """
   7
   8 import array
   9 import math
  10 import os
  11
  12 import aces_ocio.generate_lut as genlut
  13 from aces_ocio.utilities import ColorSpace, mat44_from_mat33, sanitize_path
  14
  15
  16 __author__ = 'ACES Developers'
  17 __copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
  18 __license__ = ''
  19 __maintainer__ = 'ACES Developers'
  20 __email__ = 'aces@oscars.org'
  21 __status__ = 'Production'
  22
  23 __all__ = ['create_log_c',
  24            'create_colorspaces']
  25
  26
  27 def create_log_c(gamut,
  28                  transfer_function,
  29                  exposure_index,
  30                  name,
  31                  lut_directory,
  32                  lut_resolution_1d):
  33     """
  34     Object description.
  35
  36     LogC to ACES.
  37
  38     Parameters
  39     ----------
  40     parameter : type
  41         Parameter description.
  42
  43     Returns
  44     -------
  45     type
  46          Return value description.
  47     """
  48
  49     name = '%s (EI%s) - %s' % (transfer_function, exposure_index, gamut)
  50     if transfer_function == '':
  51         name = 'Linear - %s' % gamut
  52     if gamut == '':
  53         name = '%s (EI%s)' % (transfer_function, exposure_index)
  54
  55     cs = ColorSpace(name)
  56     cs.description = name
  57     cs.equality_group = ''
  58     cs.family = 'ARRI'
  59     cs.is_data = False
  60
  61     # Globals.
  62     IDT_maker_version = '0.08'
  63
  64     nominal_EI = 400.0
  65     black_signal = 0.003907
  66     mid_gray_signal = 0.01
  67     encoding_gain = 0.256598
  68     encoding_offset = 0.391007
  69
  70     def gain_for_EI(EI):
  71         return (math.log(EI / nominal_EI) / math.log(2) * (
  72             0.89 - 1) / 3 + 1) * encoding_gain
  73
  74     def log_c_inverse_parameters_for_EI(EI):
  75         cut = 1.0 / 9.0
  76         slope = 1.0 / (cut * math.log(10))
  77         offset = math.log10(cut) - slope * cut
  78         gain = EI / nominal_EI
  79         gray = mid_gray_signal / gain
  80         # The higher the EI, the lower the gamma.
  81         enc_gain = gain_for_EI(EI)
  82         enc_offset = encoding_offset
  83         for i in range(0, 3):
  84             nz = ((95.0 / 1023.0 - enc_offset) / enc_gain - offset) / slope
  85             enc_offset = encoding_offset - math.log10(1 + nz) * enc_gain
  86
  87         a = 1.0 / gray
  88         b = nz - black_signal / gray
  89         e = slope * a * enc_gain
  90         f = enc_gain * (slope * b + offset) + enc_offset
  91
  92         # Ensuring we can return relative exposure.
  93         s = 4 / (0.18 * EI)
  94         t = black_signal
  95         b += a * t
  96         a *= s
  97         f += e * t
  98         e *= s
  99
 100         return {'a': a,
 101                 'b': b,
 102                 'cut': (cut - b) / a,
 103                 'c': enc_gain,
 104                 'd': enc_offset,
 105                 'e': e,
 106                 'f': f}
 107
 108     def log_c_to_linear(code_value, exposure_index):
 109         p = log_c_inverse_parameters_for_EI(exposure_index)
 110         breakpoint = p['e'] * p['cut'] + p['f']
 111         if code_value > breakpoint:
 112             linear = ((pow(10, (code_value / 1023.0 - p['d']) / p['c']) -
 113                        p['b']) / p['a'])
 114         else:
 115             linear = (code_value / 1023.0 - p['f']) / p['e']
 116         return linear
 117
 118     cs.to_reference_transforms = []
 119
 120     if transfer_function == 'V3 LogC':
 121         data = array.array('f', '\0' * lut_resolution_1d * 4)
 122         for c in range(lut_resolution_1d):
 123             data[c] = log_c_to_linear(1023.0 * c / (lut_resolution_1d - 1),
 124                                       int(exposure_index))
 125
 126         lut = '%s_to_linear.spi1d' % (
 127             '%s_%s' % (transfer_function, exposure_index))
 128
 129         lut = sanitize_path(lut)
 130
 131         genlut.write_SPI_1d(
 132             os.path.join(lut_directory, lut),
 133             0.0,
 134             1.0,
 135             data,
 136             lut_resolution_1d,
 137             1)
 138
 139         cs.to_reference_transforms.append({
 140             'type': 'lutFile',
 141             'path': lut,
 142             'interpolation': 'linear',
 143             'direction': 'forward'
 144         })
 145
 146     if gamut == 'Wide Gamut':
 147         cs.to_reference_transforms.append({
 148             'type': 'matrix',
 149             'matrix': mat44_from_mat33([0.680206, 0.236137, 0.083658,
 150                                         0.085415, 1.017471, -0.102886,
 151                                         0.002057, -0.062563, 1.060506]),
 152             'direction': 'forward'
 153         })
 154
 155     cs.from_reference_transforms = []
 156     return cs
 157
 158
 159 def create_colorspaces(lut_directory, lut_resolution_1d):
 160     """
 161     Generates the colorspace conversions.
 162
 163     Parameters
 164     ----------
 165     parameter : type
 166         Parameter description.
 167
 168     Returns
 169     -------
 170     type
 171          Return value description.
 172     """
 173
 174     colorspaces = []
 175
 176     transfer_function = 'V3 LogC'
 177     gamut = 'Wide Gamut'
 178
 179     # EIs = [160.0, 200.0, 250.0, 320.0, 400.0, 500.0, 640.0, 800.0,
 180     # 1000.0, 1280.0, 1600.0, 2000.0, 2560.0, 3200.0]
 181     EIs = [160, 200, 250, 320, 400, 500, 640, 800,
 182            1000, 1280, 1600, 2000, 2560, 3200]
 183     default_EI = 800
 184
 185     # Full Conversion
 186     for EI in EIs:
 187         log_c_EI_full = create_log_c(
 188             gamut,
 189             transfer_function,
 190             EI,
 191             'LogC',
 192             lut_directory,
 193             lut_resolution_1d)
 194         colorspaces.append(log_c_EI_full)
 195
 196     # Linearization Only
 197     for EI in [800]:
 198         log_c_EI_linearization = create_log_c(
 199             '',
 200             transfer_function,
 201             EI,
 202             'LogC',
 203             lut_directory,
 204             lut_resolution_1d)
 205         colorspaces.append(log_c_EI_linearization)
 206
 207     # Primaries Only
 208     log_c_EI_primaries = create_log_c(
 209         gamut,
 210         '',
 211         default_EI,
 212         'LogC',
 213         lut_directory,
 214         lut_resolution_1d)
 215     colorspaces.append(log_c_EI_primaries)
 216
 217     return colorspaces