Update to properly source file names from ACES 'hotfixes' fork
[OpenColorIO-Configs.git] / aces_1.0.0 / README.md
1 ACES 1.0.0 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         - ACES2065
28         - ACEScc
29         - ACESproxy
30         - ACEScg
31
32 - Description: Colorspaces and transforms representing the core ACES working and interchange color spaces.
33
34 - Technical information: Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
35
36 ### ADX
37
38 - Colorspaces
39         - ADX10
40         - ADX16
41
42 - Description: Colorspaces and transforms representing the ACES ADX spaces used for film scanning and printing.
43
44 - Technical information: Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
45         - [Alex Fry's ACES 0.7.1 OCIO config](https://github.com/imageworks/OpenColorIO-Configs/tree/master/aces_0.7.1) as also a valuable resource.
46
47 ### Look
48
49 - Colorspaces
50         - ACES 1.0 to 0.1 emulation
51         - ACES 1.0 to 0.2 emulation
52         - ACES 1.0 to 0.7 emulation
53
54 - Description: Colorspaces and transforms emulating the look of the ACES 0.1, 0.2 and 0.7 release.
55         - Should be used before an ACES Output Transform
56
57 - Technical information: Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
58
59 ### Output
60
61 - Colorspaces
62         - sRGB (D60 sim.)
63         - Rec.709
64         - Rec.709 (D60 sim.)
65         - Rec.2020
66         - DCDM (P3 gamut clip)
67         - DCDM
68         - P3-D60 PQ (1000 nits)
69         - P3-D60 PQ (2000 nits)
70         - P3-D60 PQ (4000 nits)
71         - P3-D60
72         - P3-DCI
73
74 - Description: 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.
75
76 - Technical information
77         - Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
78         - All transforms produce full-range output. Host applications should be used to apply an full-to-legal scaling needed.
79
80 ### Input
81
82 - Description: Colorspaces and transforms that implement the ACES Input Transforms. These colorspaces are used to convert from camera-specific formats and encodings to ACES.
83 - Colorspaces: There are a variety of Input Transforms covering different cameras manufacturers, gamuts, transfer functions and camera settings. See below for specifics.
84
85 - Technical information: References and descriptions are provided for each group of Input Transforms below.
86         - The colorspaces whose names include a transfer function and a gamut name are full implementations of ACES Input Transforms.
87                 - Ex. The ARRI 'V3 LogC (EI160) - Wide Gamut' colorspace
88                 - Ex. The RED 'REDlogFilm - DRAGONcolor2' colorspace
89                 - Ex. The Canon 'Canon-Log - DCI-P3 Daylight' colorspace
90         - The colorspaces that start with "Linear - " will convert to or from a specific gamut but not apply a transfer function.
91         - The colorspaces that start with "Curve - " will apply a transfer function but not convert between gamuts.
92
93 #### ARRI
94 - [ARRI Input Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl/idt/vendorSupplied/arri/alexa)
95 - Conversations with Joseph Goldstone of ARRI
96
97 #### Canon
98 - [Canon ACES landing page](http://usa.canon.com/cusa/professional/standard_display/aces)
99 - [Clog white paper](http://learn.usa.canon.com/app/pdfs/white_papers/White_Paper_Clog_optoelectronic.pdf)
100 - [C500 Drivers and Software](http://www.usa.canon.com/cusa/professional/products/professional_cameras/cinema_eos_cameras/eos_c500#DriversAndSoftware)
101 - [C300 Drivers and Software](http://www.usa.canon.com/cusa/professional/products/professional_cameras/cinema_eos_cameras/eos_c300#DriversAndSoftware)
102     - Choose *OSX Mountain Lion v10.8* to download the IDTs
103 - [C100 Drivers and Software](http://www.usa.canon.com/cusa/professional/products/professional_cameras/cinema_eos_cameras/eos_c100#DriversAndSoftware)
104     - Choose *OSX Mountain Lion v10.8* to download the IDTs
105
106 #### Panasonic
107 - [Vlog/V-Gamut white paper](http://pro-av.panasonic.net/en/varicam/common/pdf/VARICAM_V-Log_V-Gamut.pdf)
108 - [Varicam Drivers and Software](http://pro-av.panasonic.net/en/varicam/35/dl.html)
109
110 #### RED
111 - [Understanding REDlogFilm and REDgamma](http://www.red.com/learn/red-101/redlogfilm-redgamma)
112 - Conversations with Graeme Nattress of RED
113
114 #### Sony
115 - [Sony Input Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl/idt/vendorSupplied/sony)
116
117 #### GoPro Experimental
118 - The quality and consistency of these transforms has not been verified.
119 - Conversations with David Newman of GoPro
120
121
122 ### Utility
123
124 - Description: A collection of colorspaces that are used to facilitate the creation of LUTs and other basic functionality.
125
126 - Technical information:
127         - The Log2 shaper, Output shaper and 'Dolby PQ Scaled' spaces cover the linear range going from 6 stops below 18% grey (0.0028125) to 6.5 stops above 18% grey (16.291740)
128         - 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)
129         - The colorspaces that start with "Linear - " will convert to or from a specific gamut but not apply a transfer function.
130         - The colorspaces that start with "Curve - " will apply a transfer function but not convert between gamuts.
131
132
133 ### Aliases
134
135 - Description: 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.
136         - These colorspaces should not generally be used by most artists.
137
138
139 Roles
140 -
141 The standard OCIO roles are defined. They role assignments are:
142
143 - color_picking: ACEScg
144 - color_timing: ACEScc
145 - compositing_log: ACEScc
146 - data: Raw
147 - default: ACES2065-1
148 - matte_paint: ACEScc
149 - reference: Raw
150 - scene_linear: ACEScg
151 - texture_paint: Raw
152
153 Additionally, a number of colorspaces that are gaining wider adoption have been added to the config. Their names and assignment are:
154
155 - compositing_linear: ACEScg
156 - rendering: ACEScg
157
158
159 Displays and Views
160 -
161 The default config has one Display named **ACES**, which contains the following Views / colorspaces:
162
163 - sRGB D60 sim., colorspace: sRGB (D60 sim.)
164 - DCDM, colorspace: DCDM
165 - DCDM P3 gamut clip, colorspace: DCDM (P3 gamut clip)
166 - P3-D60, colorspace: P3-D60
167 - P3-D60 PQ 1000 nits, colorspace: P3-D60 PQ (1000 nits)
168 - P3-D60 PQ 2000 nits, colorspace: P3-D60 PQ (2000 nits)
169 - P3-D60 PQ 4000 nits, colorspace: P3-D60 PQ (4000 nits)
170 - P3-DCI, colorspace: P3-DCI
171 - Rec.2020, colorspace: Rec.2020
172 - Rec.709, colorspace: Rec.709
173 - Rec.709 D60 sim., colorspace: Rec.709 (D60 sim.)
174 - Raw, colorspace: Raw
175 - Log, colorspace: ACEScc
176
177 Considerations for custom config generation
178
179 - The choice of a single Display and many Views may not align well with the implementation of OCIO in an application. 
180         - 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.
181 - 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.
182         - To add a custom Look to the config, review the config generation script's '--addACESLookLUT', '--addACESLookCDL', '--addCustomLookLUT' and '--addCustomLookCDL' optoins.
183
184
185 LUTs
186 -
187
188 The default resolution is 33x33x33 for the 3D LUTs and 1024 for the 1D LUTs. 
189
190 ### OCIO LUTs
191 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.0/luts) 
192
193 ### Baked LUTs
194 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.0/baked)
195
196 - The LUTs encode the ACES Output Transform for a specific colorspace input and are generally named:
197         - 'Ouput Transform name' for 'Input colorspace name'.extension
198         - Ex. 'sRGB (D60 sim.) for ACEScc.icc'
199
200 The LUTs included in the 'baked' directory cover the following formats and applications:
201
202 - .3dl for Autodesk Flame
203 - .3dl for Autodesk Lustre
204 - .lut for SideFX Houdini
205 - .csp for Autodesk Maya
206 - .icc for Adobe Photoshop
207
208
209 Generating Configurations
210 -
211
212 ### Python
213 Configurations can be generated by the following *Python* package: [aces_1.0.0/python](https://github.com/hpd/OpenColorIO-Configs/tree/master/aces_1.0.0/python)
214
215 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.0/python/aces_ocio/__init__.py) file.
216
217 Features exposed for customization by the user include: 
218
219 - The resolution of 1D and 3D LUTs
220 - Inclusion of custom Looks
221 - Two modes of creating the list of OCIO Displays and Views
222
223 ### CTL Source
224 The configuration depends on the **'hotfixes' fork of the 1.0 ACES CTL**. The fork 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 release. 
225
226 The fork is available here:
227
228 - https://github.com/ampas/aces-dev/tree/hotfixes/transforms/ctl
229 - Clone this repo using the following command
230         - git clone --branch hotfixes https://github.com/ampas/aces-dev.git
231
232
233 Dependencies
234 -
235 The *Python* configuration generation package depends on the following
236 libraries:
237
238 - **OpenImageIO**: http://openimageio.org
239         - Detailed build instructions can be found here: [OpenImageIO Build Instructions](https://sites.google.com/site/openimageio/checking-out-and-building-openimageio)
240 - **OpenColorIO**: http://opencolorio.org
241         - Detailed build instructions can be found here: [OpenColorIO Build Instructions](http://opencolorio.org/installation.html)
242 - **CTL**: https://github.com/ampas/CTL
243
244
245 Building on Mac OSX
246
247 Use the following commands to build these packages on Mac OSX
248
249 - OpenColorIO
250         - brew install -vd opencolorio --with-python
251 - Update the homebrew repository of install scripts to make sure that OpenImageIO is included.
252         - brew tap homebrew/science
253 - Optional Dependencies for OpenImageIO
254         - brew install -vd libRaw
255         - brew install -vd OpenCV
256 - OpenImageIO
257         - brew install -vd openimageio --with-python
258 - CTL
259         - brew install -vd CTL
260 - OpenColorIO, a second time. *ociolutimage* will build with *openimageio* installed.
261         - brew uninstall -vd opencolorio
262         - brew install -vd opencolorio --with-python
263
264 Thanks
265 ------
266 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:
267
268 - Steve Agland
269 - Joe Bogacz
270 - Jack Binks
271 - Scott Dyer
272 - Alex Fry
273 - Alex Forsythe
274 - Joseph Goldstone
275 - Jim Houston
276 - Thomas Mansencal
277 - Robert Molholm
278 - Nikola Milosevic
279 - Will McCown
280 - Graeme Nattress
281 - David Newman
282 - Sam Richards
283 - Erik Strauss
284 - Doug Walker
285 - Kevin Wheatley
286
287 Author
288 ------
289 The original author of this OCIO config is:
290
291 - Haarm-Pieter Duiker