Merge branch 'AcademySoftwareFoundation:main' into CUDA

Author: 1div0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,12 +1,15 @@
 ---
 name: Bug report
 about: I think I have identified a legit bug and can describe it.
-title: "[BUG]"
+title: "bug:"
 labels: ''
 assignees: ''
 
 ---
 
+<!-- THESE ARE JUST SUGGESTIONS. FEEL FREE TO DELETE ALL OF THIS AND -->
+<!-- WRITE YOUR OWN THOROUGH BUG REPORT.                             -->
+
 **Describe the bug**
 
 A clear and concise description of what the bug is. What happened, and

.github/ISSUE_TEMPLATE/build_problem.md

@@ -1,7 +1,7 @@
 ---
 name: Build problems
 about: I'm having trouble building OIIO. Help!
-title: "[BUILD]"
+title: "build:"
 labels: ''
 assignees: ''
 
@@ -10,7 +10,8 @@ assignees: ''
 **PLEASE DO NOT REPORT BUILD TROUBLES AS GITHUB "ISSUES" UNLESS YOU ARE REALLY SURE IT'S A BUG**
 
 The best way to get help with your build problems is to ask a question on the
-[oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev).
+[oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev) or on the
+[ASWF Slack](https://slack.aswf.io) `#openimageio` channel.
 
 When you email about this, please attach one or both of the following:
 1. The full verbose build log, which you can create like this:

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,12 +1,15 @@
 ---
 name: Feature request
 about: I have a concrete idea about how to improve OpenImageIO.
-title: "[FEATURE REQUEST]"
+title: "feat:"
 labels: ''
 assignees: ''
 
 ---
 
+<!-- THESE ARE JUST SUGGESTIONS. FEEL FREE TO DELETE ALL OF THIS AND -->
+<!-- WRITE YOUR OWN THOROUGH FEATURE REQUEST.                        -->
+
 **Is your feature request related to a problem? Please describe.**
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 

.github/ISSUE_TEMPLATE/question.md

@@ -1,7 +1,7 @@
 ---
 name: Question
 about: How do I...  I need help with...
-title: "[HELP]"
+title: "help:"
 labels: ''
 assignees: ''
 
@@ -18,8 +18,8 @@ But if you are just asking a question:
 * Am I doing something wrong?
 * I can't build OpenImageIO
 
-For anything of this nature, the best way to get help using OpenImageIO is
-to ask a question on the [oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev).
+For anything of this nature, the best way to get help using OpenImageIO is to
+ask a question on the [oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev) or the [ASWF Slack](https://slack.aswf.io) `#openimageio` channel.
 
 The [documentation](https://docs.openimageio.org)
 is pretty comprehensive, so please check there first; you may find the answer

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,34 +1,42 @@
-<!-- This is just a guideline and set of reminders about what constitutes -->
-<!-- a good PR. Feel free to delete all this matter and replace it with   -->
-<!-- your own detailed message about the PR, assuming you hit all the     -->
-<!-- important points made below.                                         -->
+YOU MAY DELETE ALL OF THIS IF YOU ALREADY HAVE A DESCRIPTIVE COMMIT MESSAGE!
 
+This is just a template and set of reminders about what constitutes a good PR.
+But please look over the checklist at the bottom.
 
-## Description
+If THIS TEXT is still in your PR description, we'll know you didn't read the
+instructions!
+
+
+
+
+### Description
 
 <!-- Please provide a description of what this PR is meant to fix, and  -->
 <!-- how it works (if it's not going to be very clear from the code).   -->
 
-## Tests
+### Tests
 
 <!-- Did you / should you add a testsuite case (new test, or add to an  -->
 <!-- existing test) to verify that this works?                          -->
 
 
-## Checklist:
+### Checklist:
 
 <!-- Put an 'x' in the boxes as you complete the checklist items -->
 
-- [ ] I have read the [contribution guidelines](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/CONTRIBUTING.md).
-- [ ] I have updated the documentation, if applicable. (Check if there is no
-  need to update the documentation, for example if this is a bug fix that
-  doesn't change the API.)
-- [ ] I have ensured that the change is tested somewhere in the testsuite
-  (adding new test cases if necessary).
-- [ ] If I added or modified a C++ API call, I have also amended the
-  corresponding Python bindings (and if altering ImageBufAlgo functions, also
-  exposed the new functionality as oiiotool options).
-- [ ] My code follows the prevailing code style of this project. If I haven't
-  already run clang-format before submitting, I definitely will look at the CI
-  test that runs clang-format and fix anything that it highlights as being
-  nonconforming.
+- [ ] **I have read the guidelines** on [contributions](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/CONTRIBUTING.md) and [code review procedures](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/docs/dev/CodeReview.md).
+- [ ] **I have updated the documentation** if my PR adds features or changes
+  behavior.
+- [ ] **I am sure that this PR's changes are tested somewhere in the
+  testsuite**.
+- [ ] **I have run and passed the testsuite in CI** *before* submitting the
+  PR, by pushing the changes to my fork and seeing that the automated CI
+  passed there. (Exceptions: If most tests pass and you can't figure out why
+  the remaining ones fail, it's ok to submit the PR and ask for help. Or if
+  any failures seem entirely unrelated to your change; sometimes things break
+  on the GitHub runners.)
+- [ ] **My code follows the prevailing code style of this project** and I
+  fixed any problems reported by the clang-format CI test.
+- [ ] If I added or modified a public C++ API call, I have also amended the
+  corresponding Python bindings. If altering ImageBufAlgo functions, I also
+  exposed the new functionality as oiiotool options.

src/jpegxl.imageio/jxlinput.cpp

@@ -16,6 +16,7 @@
 #include <cassert>
 #include <cstdio>
 
+#include <OpenImageIO/color.h>
 #include <OpenImageIO/filesystem.h>
 #include <OpenImageIO/fmath.h>
 #include <OpenImageIO/imageio.h>
@@ -54,7 +55,6 @@ class JxlInput final : public ImageInput {
     std::string m_filename;
     int m_next_scanline;  // Which scanline is the next to read?
     uint32_t m_channels;
-    JxlColorEncoding m_color_encoding;
     JxlDecoderPtr m_decoder;
     JxlResizableParallelRunnerPtr m_runner;
     std::unique_ptr<ImageSpec> m_config;  // Saved copy of configuration spec
@@ -224,6 +224,8 @@ JxlInput::open(const std::string& name, ImageSpec& newspec)
     JxlDataType jxl_data_type;
     TypeDesc m_data_type;
     uint32_t bits = 0;
+    JxlColorEncoding color_encoding {};
+    bool have_color_encoding = false;
 
     for (;;) {
         JxlDecoderStatus status = JxlDecoderProcessInput(m_decoder.get());
@@ -300,6 +302,16 @@ JxlInput::open(const std::string& name, ImageSpec& newspec)
                 errorfmt("JxlDecoderGetColorAsICCProfile failed\n");
                 return false;
             }
+
+            // Get the color encoding of the pixel data
+            // This will return JXL_DEC_ERR for a valid file without color
+            // encoding information, so don't report an error.
+            if (JXL_DEC_SUCCESS
+                == JxlDecoderGetColorAsEncodedProfile(
+                    m_decoder.get(), JXL_COLOR_PROFILE_TARGET_DATA,
+                    &color_encoding)) {
+                have_color_encoding = true;
+            }
         } else if (status == JXL_DEC_NEED_IMAGE_OUT_BUFFER) {
             DBG std::cout << "JXL_DEC_NEED_IMAGE_OUT_BUFFER\n";
 
@@ -348,6 +360,7 @@ JxlInput::open(const std::string& name, ImageSpec& newspec)
 
     m_spec = ImageSpec(info.xsize, info.ysize, m_channels, m_data_type);
 
+    // Read ICC profile
     if (m_icc_profile.size() && m_icc_profile.data()) {
         m_spec.attribute("ICCProfile",
                          TypeDesc(TypeDesc::UINT8, m_icc_profile.size()),
@@ -365,6 +378,21 @@ JxlInput::open(const std::string& name, ImageSpec& newspec)
         }
     }
 
+    // Read CICP from color encoding. Custom primaries, custom white point and
+    // arbitrary gamma not supported currently.
+    if (have_color_encoding && color_encoding.primaries != JXL_PRIMARIES_CUSTOM
+        && color_encoding.white_point != JXL_WHITE_POINT_CUSTOM
+        && color_encoding.transfer_function != JXL_TRANSFER_FUNCTION_GAMMA) {
+        const int cicp[4] = { color_encoding.primaries,
+                              color_encoding.transfer_function, 0 /* RGB */,
+                              1 /* Full range */ };
+        m_spec.attribute("CICP", TypeDesc(TypeDesc::INT, 4), cicp);
+        const ColorConfig& colorconfig(ColorConfig::default_colorconfig());
+        string_view interop_id = colorconfig.get_color_interop_id(cicp);
+        if (!interop_id.empty())
+            m_spec.attribute("oiio:ColorSpace", interop_id);
+    }
+
     newspec = m_spec;
     return true;
 }

src/jpegxl.imageio/jxloutput.cpp

@@ -6,6 +6,7 @@
 #include <cstdio>
 #include <vector>
 
+#include <OpenImageIO/color.h>
 #include <OpenImageIO/filesystem.h>
 #include <OpenImageIO/fmath.h>
 #include <OpenImageIO/imageio.h>
@@ -538,6 +539,8 @@ JxlOutput::save_image(const void* data)
         return false;
     }
 
+    bool wrote_colorspace = false;
+
     // Write the ICC profile, if available
     const ParamValue* icc_profile_parameter = m_spec.find_attribute(
         "ICCProfile");
@@ -551,6 +554,59 @@ JxlOutput::save_image(const void* data)
                                            length)) {
                 errorfmt("JxlEncoderSetICCProfile failed\n");
             }
+            wrote_colorspace = true;
+        }
+    }
+
+    // Write CICP
+    const ColorConfig& colorconfig(ColorConfig::default_colorconfig());
+    const ParamValue* p    = m_spec.find_attribute("CICP",
+                                                   TypeDesc(TypeDesc::INT, 4));
+    string_view colorspace = m_spec.get_string_attribute("oiio:ColorSpace");
+    cspan<int> cicp        = (p) ? p->as_cspan<int>()
+                             : (!wrote_colorspace) ? colorconfig.get_cicp(colorspace)
+                                                   : cspan<int>();
+    if (!cicp.empty()) {
+        // JXL only has a subset of CICP, only write if supported. Custom
+        // primaries and white point are not currently used but could help
+        // support more CICP codes.
+        JxlColorEncoding color_encoding {};
+        color_encoding.primaries         = JxlPrimaries(cicp[0]);
+        color_encoding.transfer_function = JxlTransferFunction(cicp[1]);
+        color_encoding.color_space       = JXL_COLOR_SPACE_RGB;
+
+        bool supported_primaries = false;
+        bool supported_transfer  = false;
+
+        switch (color_encoding.primaries) {
+        case JXL_PRIMARIES_SRGB:
+        case JXL_PRIMARIES_2100:
+        case JXL_PRIMARIES_P3:
+            supported_primaries        = true;
+            color_encoding.white_point = JXL_WHITE_POINT_D65;
+            break;
+        case JXL_PRIMARIES_CUSTOM:  // Not an actual CICP code in JXL
+            break;
+        }
+
+        switch (color_encoding.transfer_function) {
+        case JXL_TRANSFER_FUNCTION_709:
+        case JXL_TRANSFER_FUNCTION_UNKNOWN:
+        case JXL_TRANSFER_FUNCTION_LINEAR:
+        case JXL_TRANSFER_FUNCTION_SRGB:
+        case JXL_TRANSFER_FUNCTION_PQ:
+        case JXL_TRANSFER_FUNCTION_DCI:
+        case JXL_TRANSFER_FUNCTION_HLG: supported_transfer = true; break;
+        case JXL_TRANSFER_FUNCTION_GAMMA:  // Not an actual CICP code
+            break;
+        }
+
+        if (supported_primaries && supported_transfer) {
+            if (JXL_ENC_SUCCESS
+                != JxlEncoderSetColorEncoding(m_encoder.get(),
+                                              &color_encoding)) {
+                errorfmt("JxlEncoderSetColorEncoding failed\n");
+            }
         }
     }
 

src/openexr.imageio/exroutput.cpp

@@ -13,6 +13,7 @@
 #include <numeric>
 
 #include <OpenImageIO/Imath.h>
+#include <OpenImageIO/color.h>
 #include <OpenImageIO/platform.h>
 
 #include <OpenEXR/IlmThreadPool.h>
@@ -1026,6 +1027,15 @@ OpenEXROutput::spec_to_header(ImageSpec& spec, int subimage,
         }
     }
 
+    // Set color interop ID from colorspace
+    if (spec.get_string_attribute("colorInteropID").empty()) {
+        const ColorConfig& colorconfig(ColorConfig::default_colorconfig());
+        string_view colorspace = spec.get_string_attribute("oiio:ColorSpace");
+        string_view interop_id = colorconfig.get_color_interop_id(colorspace);
+        if (!interop_id.empty())
+            spec.attribute("colorInteropID", interop_id);
+    }
+
     // Deal with all other params
     for (const auto& p : spec.extra_attribs)
         put_parameter(p.name().string(), p.type(), p.data(), header);

src/png.imageio/png_pvt.h

@@ -568,12 +568,30 @@ put_parameter(png_structp& sp, png_infop& ip, const std::string& _name,
         return true;
     }
 #endif
+
+    // Before handling general named metadata, suppress format-specific
+    // metadata hints meant for other formats that are not meant to be literal
+    // metadata written to the file. This includes anything with a namespace
+    // prefix of "oiio:" or the name of any other file format.
+    auto colonpos = name.find(':');
+    if (colonpos != std::string::npos) {
+        std::string prefix = Strutil::lower(name.substr(0, colonpos));
+        if (prefix != "png" && is_imageio_format_name(prefix))
+            return false;
+        if (prefix == "oiio")
+            return false;
+    }
+
     if (type == TypeDesc::STRING) {
+        // We can save arbitrary string metadata in multiple png text entries.
+        // Is that ok? Should we also do it for other types by converting to
+        // string?
         png_text t;
         t.compression = PNG_TEXT_COMPRESSION_NONE;
         t.key         = (char*)ustring(name).c_str();
         t.text        = *(char**)data;  // Already uniquified
         text.push_back(t);
+        return true;
     }
 
     return false;

testsuite/jxl/ref/out.txt

@@ -19,3 +19,26 @@ tahoe-icc.jxl        :  128 x   96, 3 channel, uint8 jpegxl
     ICCProfile:profile_size: 560
     ICCProfile:profile_version: "2.1.0"
     ICCProfile:rendering_intent: "Perceptual"
+Reading tahoe-cicp-pq.jxl
+tahoe-cicp-pq.jxl    :  128 x   96, 3 channel, uint8 jpegxl
+    SHA-1: 069F1A3E5567349C2D34E535B29913029EF1B09C
+    channel list: R, G, B
+    CICP: 9, 16, 0, 1
+    ICCProfile: 0, 0, 16, 248, 106, 120, 108, 32, 4, 64, 0, 0, 109, 110, 116, 114, ... [4344 x uint8]
+    ICCProfile:attributes: "Reflective, Glossy, Positive, Color"
+    ICCProfile:cmm_type: 1786276896
+    ICCProfile:color_space: "RGB"
+    ICCProfile:copyright: "CC0"
+    ICCProfile:creation_date: "2019:12:01 00:00:00"
+    ICCProfile:creator_signature: "6a786c20"
+    ICCProfile:device_class: "Display device profile"
+    ICCProfile:flags: "Not Embedded, Independent"
+    ICCProfile:manufacturer: "0"
+    ICCProfile:model: "0"
+    ICCProfile:platform_signature: "Apple Computer, Inc."
+    ICCProfile:profile_connection_space: "CIELAB"
+    ICCProfile:profile_description: "RGB_D65_202_Per_PeQ"
+    ICCProfile:profile_size: 4344
+    ICCProfile:profile_version: "4.4.0"
+    ICCProfile:rendering_intent: "Perceptual"
+    oiio:ColorSpace: "pq_rec2020_display"