Skip to content

Commit 8fe2ac5

Browse files
docs: clarify exr2aces output format (AcademySoftwareFoundation#1963)
* docs: clarify exr2aces output format Inspired by discussion in AcademySoftwareFoundation#1962. Adds additional background to the ACES Image Container format produced by exr2aces. Signed-off-by: Patrick Hulce <[email protected]> * docs: update exr2aces.rst with recommended edits Signed-off-by: Patrick Hulce <[email protected]> * docs: add justified indentation Signed-off-by: Patrick Hulce <[email protected]> * Use inline link instead. Co-authored-by: Cary Phillips <[email protected]> Signed-off-by: Patrick Hulce <[email protected]> * Remove link reference Signed-off-by: Patrick Hulce <[email protected]> --------- Signed-off-by: Patrick Hulce <[email protected]> Co-authored-by: Cary Phillips <[email protected]>
1 parent 750fd3f commit 8fe2ac5

File tree

1 file changed

+40
-20
lines changed

1 file changed

+40
-20
lines changed

website/bin/exr2aces.rst

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,46 @@ Description
1515
Read an OpenEXR file from infile and save the contents
1616
in ACES image file outfile.
1717

18-
The ACES image file format is a subset of the OpenEXR file
19-
format. ACES image files are restricted as follows:
20-
21-
- Images are stored as scanlines; tiles are not allowed.
22-
23-
- Images contain three color channels, either R, G, B (red, green,
24-
blue) or Y, RY, BY (luminance, sub-sampled chroma)
25-
26-
- Images may optionally contain an alpha channel.
27-
28-
- Only three compression types are allowed:
29-
30-
* NO_COMPRESSION (file is not compressed)
31-
32-
* PIZ_COMPRESSION (lossless)
33-
34-
* B44A_COMPRESSION (lossy)
35-
36-
- The "chromaticities" header attribute must specify
37-
the ACES RGB primaries and white point.
18+
The ACES Image Container File Format specified in SMPTE ST 2065-4
19+
is a subset of the OpenEXR file format defined by the implementation
20+
of the time (roughly OpenEXR 1.6).
21+
22+
This imposes considerable restrictions on what image data and metadata
23+
can be transported from a modern OpenEXR file into an ACES Image
24+
Container File, including (but not limited to) the following:
25+
26+
- The version field must be either be 2 or 1026; a value of 2 implies
27+
attribute names cannot be longer than 31 characters in length,
28+
as was the case prior to OpenEXR 1.7.
29+
30+
- Images must be stored as scanlines; tiles are not allowed.
31+
32+
- Images must contain RGB and possibly an A channel if they are monoscopic;
33+
images representing stereo pairs would add another three (or four if A is
34+
present) channels. Other channels are not permitted, including channels
35+
that otherwise might represent a combination of a luminance channel and
36+
chromaticity channels.
37+
38+
- The image must not be compressed.
39+
40+
- The `chromaticities` attribute must specify the ACES RGB primaries and
41+
the ACES neutral as specified in SMPTE ST 2065-1.
42+
43+
- The `acesImageContainerFlag` flat must be present and have the value 1.
44+
45+
For the full set of restrictions, see `SMTPE ST 2065-4 <https://doi.org/10.5594/SMPTE.ST2065-4.2013>`_ (or any
46+
superseding later version of that standard).
47+
48+
In practice, facilities and productions often use the term "ACES file"
49+
to mean OpenEXR files containing linear scene data expressed as
50+
combinations of R, G and B whose chromaticities match those found in
51+
ST 2065-1, where equal amounts of those primaries produce a color the
52+
chromaticity of which matches that of the ACES neutral. The image data
53+
might be compressed using one of the OpenEXR's library's built-in compression
54+
functions, even though strict compliance with ST 2065-4 would forbid such
55+
compression; the `acesImageContainerFile` flag might be missing; and the
56+
`chromaticities` attribute might contain chromaticities that do not actually
57+
match those found in ST 2065-1.
3858

3959
Options:
4060
--------

0 commit comments

Comments
 (0)