Replaced misnamed 'ST 2048' references to 'ST 2084'.
[OpenColorIO-Configs.git] / aces_1.0.1 / README.md
1 ACES 1.0.1 OpenColorIO configuration
2 =
3
4 Informations about ACES
5 -
6
7 The **ACES** project home page is here: 
8
9 - http://www.oscars.org/aces
10
11 The latest documentation on the ACES transforms and specifications can be found here:
12
13 - http://www.oscars.org/science-technology/aces/aces-documentation
14
15
16 Colorspaces
17 -
18
19 Colorspaces in this configurations are grouped into the following families: ACES, ADX, Look, Output, Input, Utility, Aliases. Descriptions for the colorspaces in the different families are provided below.
20
21 For ease of use across a broader number of applications, the family name of each colorspace is pre-prended to the colorspace name when the configuration is authored. Those prefixes will be omitted in this document, but will show up when the configuration is loaded and used.
22
23
24 ### ACES
25
26 ##### Colorspaces
27
28 - ACES2065-1
29 - ACEScc
30 - ACESproxy
31 - ACEScg
32
33 ##### Description
34
35 Colorspaces and transforms representing the core ACES working and interchange colorspaces.
36
37 ##### Technical information
38
39 Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
40
41 ### ADX
42
43 ##### Colorspaces
44
45 - ADX10
46 - ADX16
47
48 ##### Description
49
50 Colorspaces and transforms representing the ACES ADX spaces used for film scanning and printing.
51
52 ##### Technical information
53
54 - Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
55 - [Alex Fry's ACES 0.7.1 OCIO config](https://github.com/imageworks/OpenColorIO-Configs/tree/master/aces_0.7.1) was also a valuable resource.
56
57 ### Look
58
59 ##### Colorspaces
60
61 - ACES 1.0 to 0.1 emulation
62 - ACES 1.0 to 0.2 emulation
63 - ACES 1.0 to 0.7 emulation
64
65 ##### Description
66
67 Colorspaces and transforms emulating the look of the ACES 0.1, 0.2 and 0.7 release.
68
69 - Should be applied to data in the ACES2065-1 colorspace.
70 - Should be used before an ACES Output Transform.
71
72 ##### Technical information
73
74 Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
75
76 ### Output
77
78 ##### Colorspaces
79
80 - sRGB (D60 sim.)
81 - Rec.709
82 - Rec.709 (D60 sim.)
83 - Rec.2020
84 - Rec.2020 ST2048 (1000 nits)
85 - DCDM (P3 gamut clip)
86 - DCDM
87 - P3-D60 ST2048 (1000 nits)
88 - P3-D60 ST2048 (2000 nits)
89 - P3-D60 ST2048 (4000 nits)
90 - P3-D60
91 - P3-DCI
92
93 ##### Description
94
95 Colorspaces and transforms implementing the ACES Output Transforms. These colorspaces produce code values ready for display on hardware devices calibrated to the standard used to name the colorspace.
96
97 ##### Technical information
98 - Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
99 - All transforms produce full-range output. Host applications should be used to apply an full-to-legal scaling needed.
100
101 ### Input
102
103 ##### Colorspaces
104
105 There are a variety of Input Transforms covering different cameras manufacturers, gamuts, transfer functions and camera settings. See below for specifics.
106
107 ##### Description
108
109 Colorspaces and transforms that implement the ACES Input Transforms. These colorspaces are used to convert from camera-specific formats and encodings to ACES.
110
111 ##### Technical information
112
113 References and descriptions are provided for each group of Input Transforms below.
114 - The colorspaces whose names include a transfer function and a gamut name are full implementations of ACES Input Transforms.
115         - Ex. The ARRI 'V3 LogC (EI160) - Wide Gamut' colorspace
116         - Ex. The RED 'REDlogFilm - DRAGONcolor2' colorspace
117         - Ex. The Canon 'Canon-Log - DCI-P3 Daylight' colorspace
118 - The colorspaces that start with 'Linear - ' will convert to or from a specific gamut but not apply a transfer function.
119 - The colorspaces that start with 'Curve - ' will apply a transfer function but not convert between gamuts.
120
121 #### ARRI
122 - [ARRI Input Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl/idt/vendorSupplied/arri/alexa)
123 - Conversations with Joseph Goldstone of ARRI
124
125 #### Canon
126 - [Canon ACES landing page](http://usa.canon.com/cusa/professional/standard_display/aces)
127 - [Clog white paper](http://learn.usa.canon.com/app/pdfs/white_papers/White_Paper_Clog_optoelectronic.pdf)
128 - [C500 Drivers and Software](http://www.usa.canon.com/cusa/professional/products/professional_cameras/cinema_eos_cameras/eos_c500#DriversAndSoftware)
129 - [C300 Drivers and Software](http://www.usa.canon.com/cusa/professional/products/professional_cameras/cinema_eos_cameras/eos_c300#DriversAndSoftware)
130     - Choose *OSX Mountain Lion v10.8* to download the IDTs
131 - [C100 Drivers and Software](http://www.usa.canon.com/cusa/professional/products/professional_cameras/cinema_eos_cameras/eos_c100#DriversAndSoftware)
132     - Choose *OSX Mountain Lion v10.8* to download the IDTs
133
134 #### Panasonic
135 - [Vlog/V-Gamut white paper](http://pro-av.panasonic.net/en/varicam/common/pdf/VARICAM_V-Log_V-Gamut.pdf)
136 - [Varicam Drivers and Software](http://pro-av.panasonic.net/en/varicam/35/dl.html)
137
138 #### RED
139 - [Understanding REDlogFilm and REDgamma](http://www.red.com/learn/red-101/redlogfilm-redgamma)
140 - Conversations with Graeme Nattress of RED
141
142 #### Sony
143 - [Sony Input Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl/idt/vendorSupplied/sony)
144
145 #### GoPro Experimental
146 - The quality and consistency of these transforms has not been verified.
147 - Conversations with David Newman of GoPro
148
149
150 ### Utility
151
152 ##### Description
153
154 A collection of colorspaces that are used to facilitate the creation of LUTs and other basic functionality.
155
156 ##### Technical information
157
158 - The 'Log2 xx nits Shaper' and 'Dolby PQ xx nits Shaper' spaces cover the linear range centered around 18% grey. The 48 nits spaces cover -6.5 stops (0.0028125) to +6.5 stops(16.291740). The 1000 nits spaces cover -12 stops to +10 stops. The 2000 nits spaces cover -12 stops to +11 stops. The 4000 nits spaces cover -12 stops to +12 stops.
159 - The LMT shaper spaces cover the linear range going from 10 stops below 18% grey (0.00017578125) to 6.5 stops above 18% grey (16.291740)
160 - The colorspaces starting with 'Linear - ' will convert to or from a specific gamut but not apply a transfer function.
161 - The colorspaces starting with 'Curve - ' will apply a transfer function but not convert between gamuts.
162
163 ### Roles
164
165 ##### Description
166
167 The role colorspaces are aliases to the colorspaces used for the *OCIO* 'roles' functionality.
168
169 ### Aliases
170
171 ##### Description
172
173 The alias colorspaces are named with all lower-case letters and no spaces, dashes, parentheses or other characters that would not work well in a filename. They are only references, aliases for the base colorspaces with more user-friendly names. These spaces were added to enable OCIO's token-based colorspace / filename matching.
174
175 - These colorspaces should not generally be used by most artists.
176
177
178 Roles
179 -
180
181 The standard *OCIO* roles are defined. They role assignments are:
182
183 - **color_picking**: Output - Rec.709
184 - **color_timing**: ACEScc
185 - **compositing_log**: ACEScc
186 - **data**: Raw
187 - **default**: ACES2065-1
188 - **matte_paint**: ACEScc
189 - **reference**: Raw
190 - **scene_linear**: ACEScg
191 - **texture_paint**: Raw
192
193 Additionally, a number of colorspaces that are gaining wider adoption have been added to the config. Their names and assignment are:
194
195 - **compositing_linear**: ACEScg
196 - **rendering**: ACEScg
197
198
199 Displays and Views
200 -
201
202 The default config has one Display named **ACES**, which contains the following Views / colorspaces:
203
204 - sRGB D60 sim., colorspace: sRGB (D60 sim.)
205 - DCDM, colorspace: DCDM
206 - DCDM P3 gamut clip, colorspace: DCDM (P3 gamut clip)
207 - P3-D60, colorspace: P3-D60
208 - P3-D60 PQ 1000 nits, colorspace: P3-D60 PQ (1000 nits)
209 - P3-D60 PQ 2000 nits, colorspace: P3-D60 PQ (2000 nits)
210 - P3-D60 PQ 4000 nits, colorspace: P3-D60 PQ (4000 nits)
211 - P3-DCI, colorspace: P3-DCI
212 - Rec.2020, colorspace: Rec.2020
213 - Rec.2020 ST2048 1000 nits, colorspace: Rec.2020 ST2048 (1000 nits)
214 - Rec.709, colorspace: Rec.709
215 - Rec.709 D60 sim., colorspace: Rec.709 (D60 sim.)
216 - Raw, colorspace: Raw
217 - Log, colorspace: ACEScc
218
219 Considerations for custom config generation:
220
221 - The choice of a single Display and many Views may not align well with the implementation of OCIO in an application. 
222         - If you would like to generate a config that contains multiple Displays, with a small number of Views for each, review the config generation script's '--createMultipleDisplays' option.
223 - If a Look is added to the config, a new set of Views will be added, one for each of the Views listed above except Raw and Log, that includes the Look. The Views with Looks will be interleaved in the View list with the original Views.
224         - To add a custom Look to the config, review the config generation script's '--addACESLookLUT', '--addACESLookCDL', '--addCustomLookLUT' and '--addCustomLookCDL' optoins.
225
226
227 LUTs
228 -
229
230 The default resolution is 33x33x33 for the 3D LUTs and 1024 for the 1D LUTs. 
231
232 ### OCIO LUTs
233 The LUTs used internally by OCIO can be can be retrieved [from the repository here.](https://github.com/hpd/OpenColorIO-Configs/tree/master/aces_1.0.1/luts) 
234
235 ### Baked LUTs
236 LUTs that can be used outside of OCIO are included in the ['baked' directory here.](https://github.com/hpd/OpenColorIO-Configs/tree/master/aces_1.0.1/baked)
237
238 - The LUTs encode the ACES Output Transform for a specific colorspace input and are generally named:
239         - 'Ouput Transform name' for 'Input colorspace name'.extension
240         - Ex. 'sRGB (D60 sim.) for ACEScc.icc'
241
242 The LUTs included in the 'baked' directory cover the following formats and applications:
243
244 - .3dl for Autodesk Flame
245 - .3dl for Autodesk Lustre
246 - .lut for SideFX Houdini
247 - .csp for Autodesk Maya
248 - .icc for Adobe Photoshop
249
250
251 Generating Configurations
252 -
253
254 ### Python
255 Configurations can be generated by the following *Python* package: [aces_1.0.1/python](https://github.com/hpd/OpenColorIO-Configs/tree/master/aces_1.0.1/python)
256
257 Usage is described on the command line and in the package root [\_\_init__.py](https://github.com/hpd/OpenColorIO-Configs/blob/master/aces_1.0.1/python/aces_ocio/__init__.py) file.
258
259 Features exposed for customization by the user include: 
260
261 - The resolution of 1D and 3D LUTs
262 - Inclusion of custom Looks
263 - Two modes of creating the list of OCIO Displays and Views
264 - Selection of shaper function: Log2 or Dolby PQ
265
266 ### CTL Source
267 The configuration depends on the **ACES 1.0.1 + Hotfixes CTL**. The release contains a number of minor bug fixes and small additions in the utilities folder but is otherwise the same as the master **ACES 1.0.1** release. 
268
269 The CTL is available here:
270
271 - https://github.com/ampas/aces-dev/tree/hotfixes/transforms/ctl
272
273 Clone this repo using the following command:
274
275 - git clone --branch hotfixes https://github.com/ampas/aces-dev.git
276
277
278 Dependencies
279 -
280 The *Python* configuration generation package depends on the following
281 libraries:
282
283 - **OpenImageIO**: http://openimageio.org
284         - Detailed build instructions can be found here: [OpenImageIO Build Instructions](https://sites.google.com/site/openimageio/checking-out-and-building-openimageio)
285 - **OpenColorIO**: http://opencolorio.org
286         - Detailed build instructions can be found here: [OpenColorIO Build Instructions](http://opencolorio.org/installation.html)
287 - **CTL**: https://github.com/ampas/CTL
288
289
290 Building on Mac OSX
291
292 Use the following commands to build these packages on Mac OSX
293
294 - OpenColorIO
295         - brew install -vd opencolorio --with-python
296 - Update the homebrew repository of install scripts to make sure that OpenImageIO is included.
297         - brew tap homebrew/science
298 - Optional Dependencies for OpenImageIO
299         - brew install -vd libRaw
300         - brew install -vd OpenCV
301 - OpenImageIO
302         - brew install -vd openimageio --with-python
303 - CTL
304         - brew install -vd CTL
305 - OpenColorIO, a second time. *ociolutimage* will build with *openimageio* installed.
306         - brew uninstall -vd opencolorio
307         - brew install -vd opencolorio --with-python
308
309 Thanks
310 ------
311 The script used to generate these transforms and the transforms themselves were the product of work and conversations with a number of people. Thanks go to:
312
313 - Steve Agland
314 - Joe Bogacz
315 - Jack Binks
316 - Scott Dyer
317 - Alex Fry
318 - Alex Forsythe
319 - Joseph Goldstone
320 - Stephen Hill
321 - Jim Houston
322 - Thomas Mansencal
323 - Robert Molholm
324 - Nikola Milosevic
325 - Will McCown
326 - Graeme Nattress
327 - David Newman
328 - Sam Richards
329 - Erik Strauss
330 - Doug Walker
331 - Kevin Wheatley
332
333 Author
334 ------
335 The original author of this OCIO config is:
336
337 - Haarm-Pieter Duiker