Release notes for v3.1.0 (AcademySoftwareFoundation#1089)

* Initial draft of v3.1.0 release notes

Signed-off-by: Cary Phillips <[email protected]>

* v3.1.0 Release notes summary; Set date to July 19

Signed-off-by: Cary Phillips <[email protected]>

* Add recent PR's

Signed-off-by: Cary Phillips <[email protected]>

* Add PR 1092 and 1097

Signed-off-by: Cary Phillips <[email protected]>

* formatting

Signed-off-by: Cary Phillips <[email protected]>

Author: cary-ilm

CHANGES.md

@@ -1,5 +1,6 @@
 # OpenEXR Release Notes
 
+* [Version 3.1.0](#version-310-july-22-2021) July 22, 2021
 * [Version 3.0.5](#version-305-july-1-2021) July 1, 2021
 * [Version 3.0.4](#version-304-june-3-2021) June 3, 2021
 * [Version 3.0.3](#version-303-may-18-2021) May 18, 2021
@@ -49,6 +50,98 @@
 * [Version 1.0.1](#version-101)
 * [Version 1.0](#version-10)
 
+## Version 3.1.0 (July 22, 2021)
+
+The 3.1 release of OpenEXR introduces a new library, OpenEXRCore,
+which is the result of a significant re-thinking of how OpenEXR
+manages file I/O and provides access to image data. It begins to
+address long-standing scalability issues with multithreaded image
+reading and writing.
+
+The OpenEXRCore library provides thread-safe, non-blocking access to
+files, which was not possible with the current API, where the
+framebuffer management is separate from read requests. It is written
+entirely in C and provides a new C-language API alongside the existing
+C++ API. This new low-level API allows applications to do custom
+unpacking of EXR data, such as on the GPU, while still benefiting from
+efficient I/O, file validation, and other semantics. It provides
+efficient direct access to EXR files in texturing applications. This C
+library also introduces an easier path to implementing OpenEXR
+bindings in other languages, such as Rust.
+
+The 3.1 release represents a technology preview for upcoming
+releases. The initial release is incremental; the existing API and
+underlying behavior has not changed. The new API is available now for
+performance validation testing, and then in future OpenEXR releases,
+the C++ API will migrate to use the new core in stages.  It is not the
+intention to entirely deprecate the C++ API, nor must all applications
+re-implement EXR I/O in terms of the C library. The C API does not,
+and will not, provide the rich set of utility classes that exist in
+the C++ layer. The 3.1 release of the OpenEXRCore library simply
+offers new functionality for specialty applications seeking the
+highest possible performance. In the future, the ABI will evolve, but
+the API will remain consistent, or only have additions.
+
+Technical Design
+
+The OpenEXRCore API introduces a ``context`` object to manage file
+I/O. The context provides customization for I/O, memory allocation,
+and error handling.  This makes it possible to use a decode and/or
+encode pipeline to customize how the chunks are written and read, and
+how they are packed or unpacked.
+
+The OpenEXRCore library is built around the concept of “chunks”, or
+atomic blocks of data in a file, the smallest unit of data to be read
+or written.  The contents of a chunk vary from file to file based on
+compression (i.e. zip and zips) and layout (scanline
+vs. tiled). Currently this is either 1, 16, or 32 scanlines, or 1 tile
+(or subset of a tile on edge boundaries / small mip level).
+
+The OpenEXRCore library is specifically designed for multipart EXR
+files. It will continue to produce legacy-compatible single part files
+as needed, but the API assumes you are always dealing with a
+multi-part file. It also fully supports attributes, although being C,
+it lacks some of the C++ layer’s abstraction.
+
+Limitations:
+
+* No support yet for DWAA and DWAB compression during decode and
+  encode pipelines. The low-level chunk I/O still works with DWAA and
+  DWAB compressed files, but the encoder and decoder are not yet
+  included in this release.
+
+* For deep files, reading of deep data is functional, but the path for
+  encoding deep data into chunk-level data (i.e. packing and
+  compressing) is not yet complete.
+
+* For both of these deficiencies, it is easy to define a custom
+  routine to implement this, should it be needed prior to the library
+  providing full support.
+
+* No attempt to search through the file and find missing chunks is
+  made when a corrupt chunk table is encountered. However, if a
+  particular chunk is corrupt, this is handled such that the other
+  chunks may be read without rendering the context unusable
+
+Merged Pull Requests:
+
+* [1097](https://github.com/AcademySoftwareFoundation/openexr/pull/1097) Include exported OpenEXR headers with "" instead of <>
+* [1092](https://github.com/AcademySoftwareFoundation/openexr/pull/1092) Document current standard optional attributes
+* [1088](https://github.com/AcademySoftwareFoundation/openexr/pull/1088) First draft of rst/readthedocs for C API/OpenEXRCore
+* [1087](https://github.com/AcademySoftwareFoundation/openexr/pull/1087) Edit doxygen comments for consistency and style
+* [1086](https://github.com/AcademySoftwareFoundation/openexr/pull/1086) Simplify names, improve error messages, fix imath usage in Core
+* [1077](https://github.com/AcademySoftwareFoundation/openexr/pull/1077) Initial doxygen/sphinx/breathe/readthedocs docs
+* [1076](https://github.com/AcademySoftwareFoundation/openexr/pull/1076) Refactor deep tests to separate file, fix deep chunk reads, ripmap reading
+* [1074](https://github.com/AcademySoftwareFoundation/openexr/pull/1074) Add utility function for ease of use in other libraries
+* [1073](https://github.com/AcademySoftwareFoundation/openexr/pull/1073) Use same struct scheme as box from imath for consistency
+* [1069](https://github.com/AcademySoftwareFoundation/openexr/pull/1069) Clean up library VERSION and SOVERSION
+* [1062](https://github.com/AcademySoftwareFoundation/openexr/pull/1062) Add missing "throw" before InputExc in IDManifest::init()
+* [1045](https://github.com/AcademySoftwareFoundation/openexr/pull/1045) Fix #1039 The vtable for TiledRgbaInputFile was not properly tagged
+* [1038](https://github.com/AcademySoftwareFoundation/openexr/pull/1038) fix/extend part number validation in MultiPart methods
+* [1024](https://github.com/AcademySoftwareFoundation/openexr/pull/1024) Remove dead code in ImfB44Compressor.cpp
+* [1020](https://github.com/AcademySoftwareFoundation/openexr/pull/1020) Fix comparison of integer expressions of different signedness warning
+* [870](https://github.com/AcademySoftwareFoundation/openexr/pull/870) WIP: New C core
+
 ## Version 3.0.5 (July 1, 2021)
 
 Patch release that fixes problems with library symlinks and