Make the default image state an image input config and image cache attribute

Rather than a global attribute, so that different parts of a multithreaded
application can use different behavior.

Signed-off-by: Brecht Van Lommel <[email protected]>

Author: brechtvl

src/bmp.imageio/bmpinput.cpp

@@ -35,6 +35,7 @@ class BmpInput final : public ImageInput {
                               void* data) override;
 
 private:
+    std::string m_image_state_default;  // Default image state for color space
     int64_t m_padded_scanline_size;
     int m_pad_size;
     bmp_pvt::BmpFileHeader m_bmp_header;
@@ -153,6 +154,9 @@ BmpInput::open(const std::string& name, ImageSpec& newspec,
     // this behavior off.
     bool monodetect = config["bmp:monochrome_detect"].get<int>(1);
 
+    m_image_state_default = config.get_string_attribute(
+        "oiio:ImageStateDefault");
+
     ioproxy_retrieve_from_config(config);
     if (!ioproxy_use_or_open(name))
         return false;
@@ -265,7 +269,8 @@ BmpInput::open(const std::string& name, ImageSpec& newspec,
     // display, so assume it's sRGB. This is not really correct -- see the
     // comments below.
     const bool erase_other_attributes = false;
-    pvt::set_colorspace_srgb(m_spec, erase_other_attributes);
+    pvt::set_colorspace_srgb(m_spec, m_image_state_default,
+                             erase_other_attributes);
 #if 0
     if (m_dib_header.size >= WINDOWS_V4
         && m_dib_header.cs_type == CSType::CalibratedRGB) {

src/cineon.imageio/cineoninput.cpp

@@ -182,13 +182,14 @@ CineonInput::open(const std::string& name, ImageSpec& newspec)
         // either grayscale or printing density
         if (!std::isinf(m_cin.header.Gamma()) && m_cin.header.Gamma() != 0.0f)
             // actual gamma value is read later on
-            set_colorspace_rec709_gamma(m_spec, float(m_cin.header.Gamma()));
+            pvt::set_colorspace_rec709_gamma(m_spec,
+                                             float(m_cin.header.Gamma()));
         break;
     }
 
     // gamma exponent
     if (!std::isinf(m_cin.header.Gamma()) && m_cin.header.Gamma() != 0.0f)
-        set_colorspace_rec709_gamma(m_spec, float(m_cin.header.Gamma()));
+        pvt::set_colorspace_rec709_gamma(m_spec, float(m_cin.header.Gamma()));
 #endif
 
     // general metadata

src/dds.imageio/ddsinput.cpp

@@ -61,8 +61,9 @@ class DDSInput final : public ImageInput {
                           void* data) override;
 
 private:
-    std::string m_filename;            ///< Stash the filename
-    std::vector<unsigned char> m_buf;  ///< Buffer the image pixels
+    std::string m_filename;             ///< Stash the filename
+    std::string m_image_state_default;  ///< Default image state for color space
+    std::vector<unsigned char> m_buf;   ///< Buffer the image pixels
     int m_subimage;
     int m_miplevel;
     int m_nchans;               ///< Number of colour channels in image
@@ -412,6 +413,8 @@ DDSInput::open(const std::string& name, ImageSpec& newspec,
                const ImageSpec& config)
 {
     ioproxy_retrieve_from_config(config);
+    m_image_state_default = config.get_string_attribute(
+        "oiio:ImageStateDefault");
     return open(name, newspec);
 }
 
@@ -845,7 +848,7 @@ DDSInput::seek_subimage(int subimage, int miplevel)
     }
 
     if (is_srgb) {
-        pvt::set_colorspace_srgb(m_spec);
+        pvt::set_colorspace_srgb(m_spec, m_image_state_default);
     } else if (!is_srgb
                && (basetype == TypeDesc::HALF || basetype == TypeDesc::FLOAT)) {
         // linear color space for HDR-ish images

src/doc/builtinplugins.rst

@@ -87,6 +87,11 @@ options are supported:
      - ptr
      - Pointer to a ``Filesystem::IOProxy`` that will handle the I/O, for
        example by reading from memory rather than the file system.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 **Configuration settings for BMP output**
 
@@ -211,6 +216,11 @@ attributes are supported:
      - ptr
      - Pointer to a ``Filesystem::IOProxy`` that will handle the I/O, for
        example by reading from memory rather than the file system.    
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 Additionally, an integer ``dds:bc5normal`` global attribute is supported
 to control behaviour of images compressed in BC5/ATI2 compression format.
@@ -294,6 +304,11 @@ options are supported:
    * - ``oiio:subimages``
      - int
      - The number of "image elements" (subimages) in the file.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 
 **Configuration settings for DPX output**
@@ -618,6 +633,11 @@ options are supported:
      - ptr
      - Pointer to a ``Filesystem::IOProxy`` that will handle the I/O, for
        example by reading from memory rather than the file system.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 **Configuration settings for GIF output**
 
@@ -727,6 +747,11 @@ options are supported:
        orientation of the image). If this hint is set to 0, the pixels will be
        left in their orientation as stored in the file, and the "Orientation"
        metadata will reflect that.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 **Configuration settings for HDR output**
 
@@ -807,6 +832,12 @@ attributes are supported:
        having Orientation 1). If zero, then libheif will not reorient the
        image and the Orientation metadata will be set to reflect the camera
        orientation.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
+
 
 **Configuration settings for HEIF output**
 
@@ -871,6 +902,11 @@ attributes are supported:
      - ptr
      - Pointer to a ``Filesystem::IOProxy`` that will handle the I/O, for
        example by reading from memory rather than the file system.    
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 **Configuration settings for ICO output**
 
@@ -947,6 +983,11 @@ options are supported:
      - ptr
      - Pointer to a ``Filesystem::IOProxy`` that will handle the I/O, for
        example by reading from memory rather than the file system.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 **Configuration settings for IFF output**
 
@@ -1063,6 +1104,11 @@ attributes are supported:
      - ptr
      - Pointer to a ``Filesystem::IOProxy`` that will handle the I/O, for
        example by reading from memory rather than the file system.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 **Configuration settings for JPEG output**
 
@@ -1195,6 +1241,11 @@ attributes are supported:
      - ptr
      - Pointer to a ``Filesystem::IOProxy`` that will handle the I/O, for
        example by reading from memory rather than the file system.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 If OpenJPH is installed, the reader will attempt to read the file first with 
 the OpenJPH library, and if that fails, it will fall back to the OpenJPEG library.
@@ -1302,6 +1353,11 @@ attributes are supported:
      - ptr
      - Pointer to a ``Filesystem::IOProxy`` that will handle the I/O, for
        example by reading from memory rather than the file system.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 **Configuration settings for JPEG XL output**
 
@@ -1837,6 +1893,11 @@ attributes are supported:
      - ptr
      - Pointer to a ``Filesystem::IOProxy`` that will handle the I/O, for
        example by reading from memory rather than the file system.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
    * - ``png:linear_premult``
      - int
      - If nonzero, will convert  or gamma-encoded values to linear color
@@ -2317,6 +2378,11 @@ options are supported:
        initialization. This populates the image attributes which depend on the
        pixel values.
        (Default: 0)
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 |
 
@@ -2424,6 +2490,11 @@ options are supported:
      - ptr
      - Pointer to a ``Filesystem::IOProxy`` that will handle the I/O, for
        example by reading from memory rather than the file system.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 **Configuration settings for RLA output**
 
@@ -2674,6 +2745,11 @@ attributes are supported:
        cause the reader to leave alpha unassociated (versus the default of
        premultiplying color channels by alpha if the alpha channel is
        unassociated).
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 **Configuration settings for Targa output**
 
@@ -2842,6 +2918,11 @@ options are supported:
      - ptr
      - Pointer to a ``Filesystem::IOProxy`` that will handle the I/O, for
        example by reading from memory rather than the file system.
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 **Configuration settings for TIFF output**
 
@@ -3152,6 +3233,11 @@ attributes are supported:
      - If nonzero, will leave alpha unassociated (versus the default of
        premultiplying color channels by alpha if the alpha channel is
        unassociated).
+   * - ``oiio:ImageStateDefault``
+     - string
+     - If ``scene`` or ``display``, prefer to assign the image a scene or
+       display referred ``oiio:ColorSpace``. The default is ``display``,
+       while ``scene`` is more common for textures.
 
 **Configuration settings for WebP output**
 

src/dpx.imageio/dpxinput.cpp

@@ -61,6 +61,7 @@ class DPXInput final : public ImageInput {
     dpx::Reader m_dpx;
     std::vector<unsigned char> m_userBuf;
     bool m_rawcolor;
+    std::string m_image_state_default;
     std::vector<unsigned char> m_decodebuf;  // temporary decode buffer
 
     /// Reset everything to initial state
@@ -171,6 +172,8 @@ DPXInput::open(const std::string& name, ImageSpec& newspec,
                  || config.get_int_attribute("dpx:RawData")  // deprecated
                  || config.get_int_attribute("oiio:RawColor");
     ioproxy_retrieve_from_config(config);
+    m_image_state_default = config.get_string_attribute(
+        "oiio:ImageStateDefault");
     return open(name, newspec);
 }
 
@@ -316,10 +319,14 @@ DPXInput::seek_subimage(int subimage, int miplevel)
     switch (m_dpx.header.Transfer(subimage)) {
     case dpx::kLinear: m_spec.set_colorspace("lin_rec709_scene"); break;
     case dpx::kLogarithmic: m_spec.set_colorspace("KodakLog"); break;
-    case dpx::kITUR709: pvt::set_colorspace_srgb(m_spec); break;
+    case dpx::kITUR709:
+        pvt::set_colorspace_srgb(m_spec, m_image_state_default);
+        break;
     case dpx::kUserDefined:
         if (!std::isnan(m_dpx.header.Gamma()) && m_dpx.header.Gamma() != 0) {
-            set_colorspace_rec709_gamma(m_spec, float(m_dpx.header.Gamma()));
+            pvt::set_colorspace_rec709_gamma(m_spec,
+                                             float(m_dpx.header.Gamma()),
+                                             m_image_state_default);
             break;
         }
         // intentional fall-through

src/ffmpeg.imageio/ffmpeginput.cpp

@@ -91,6 +91,8 @@ class FFmpegInput final : public ImageInput {
     }
     bool valid_file(const std::string& name) const override;
     bool open(const std::string& name, ImageSpec& spec) override;
+    bool open(const std::string& name, ImageSpec& spec,
+              const ImageSpec& config) override;
     bool close(void) override;
     int current_subimage(void) const override
     {
@@ -133,6 +135,7 @@ class FFmpegInput final : public ImageInput {
     bool m_codec_cap_delay;
     bool m_read_frame;
     int64_t m_start_time;
+    std::string m_image_state_default;
 
     // init to initialize state
     void init(void)
@@ -212,6 +215,14 @@ FFmpegInput::valid_file(const std::string& name) const
 }
 
 
+bool
+FFmpegInput::open(const std::string& name, ImageSpec& spec,
+                  const ImageSpec& config)
+{
+    m_image_state_default = config.get_string_attribute(
+        "oiio:ImageStateDefault");
+    return open(name, spec);
+}
 
 bool
 FFmpegInput::open(const std::string& name, ImageSpec& spec)
@@ -550,7 +561,7 @@ FFmpegInput::open(const std::string& name, ImageSpec& spec)
         = { m_codec_context->color_primaries, m_codec_context->color_trc,
             m_codec_context->colorspace,
             m_codec_context->color_range == AVCOL_RANGE_MPEG ? 0 : 1 };
-    pvt::set_colorspace_cicp(m_spec, cicp);
+    pvt::set_colorspace_cicp(m_spec, cicp, m_image_state_default);
 
     m_nsubimages = m_frames;
     spec         = m_spec;

src/gif.imageio/gifinput.cpp

@@ -65,10 +65,11 @@ class GIFInput final : public ImageInput {
     }
 
 private:
-    std::string m_filename;          ///< Stash the filename
-    GifFileType* m_gif_file;         ///< GIFLIB handle
-    int m_transparent_color;         ///< Transparent color index
-    int m_subimage;                  ///< Current subimage index
+    std::string m_filename;             ///< Stash the filename
+    std::string m_image_state_default;  ///< Default image state for color space
+    GifFileType* m_gif_file;            ///< GIFLIB handle
+    int m_transparent_color;            ///< Transparent color index
+    int m_subimage;                     ///< Current subimage index
     int m_disposal_method;           ///< Disposal method of current subimage.
                                      ///  Indicates what to do with canvas
                                      ///  before drawing the _next_ subimage.
@@ -173,6 +174,8 @@ bool
 GIFInput::open(const std::string& name, ImageSpec& newspec,
                const ImageSpec& config)
 {
+    m_image_state_default = config.get_string_attribute(
+        "oiio:ImageStateDefault");
     // Check 'config' for any special requests
     ioproxy_retrieve_from_config(config);
     ioseek(0);
@@ -261,7 +264,7 @@ GIFInput::read_subimage_metadata(ImageSpec& newspec)
     newspec.nchannels = 4;
     newspec.default_channel_names();
     newspec.alpha_channel = 4;
-    pvt::set_colorspace_srgb(newspec);
+    pvt::set_colorspace_srgb(newspec, m_image_state_default);
 
     m_previous_disposal_method = m_disposal_method;
     m_disposal_method          = DISPOSAL_UNSPECIFIED;