Blender V5.3
usd_colorspace_utils.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2026 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
6
7#include <pxr/usd/sdf/types.h>
8#include <pxr/usd/usd/colorSpaceAPI.h>
9
10#include "BLI_string_utf8.hh"
11
12#include "DNA_image_types.h"
13
15
16namespace blender::io::usd {
17
18namespace usdtokens {
19static const pxr::TfToken sourceColorSpace("sourceColorSpace", pxr::TfToken::Immortal);
20static const pxr::TfToken auto_("auto", pxr::TfToken::Immortal);
21static const pxr::TfToken sRGB("sRGB", pxr::TfToken::Immortal);
22static const pxr::TfToken data("data", pxr::TfToken::Immortal);
23static const pxr::TfToken raw("raw", pxr::TfToken::Immortal);
24static const pxr::TfToken RAW("RAW", pxr::TfToken::Immortal);
25} // namespace usdtokens
26
28{
29 const char *scene_linear_name = IMB_colormanagement_role_colorspace_name_get(
31 const ColorSpace *cs = IMB_colormanagement_space_get_named(scene_linear_name);
33 return (interop_id.is_empty()) ? pxr::TfToken() : pxr::TfToken(interop_id);
34}
35
36void colorspace_apply_to_prim(const pxr::UsdPrim &prim)
37{
38 const pxr::TfToken interop_id = colorspace_scene_linear_interop_id();
39 if (interop_id.IsEmpty()) {
40 return;
41 }
42 pxr::UsdColorSpaceAPI cs_api = pxr::UsdColorSpaceAPI::Apply(prim);
43 cs_api.CreateColorSpaceNameAttr(pxr::VtValue(interop_id));
44}
45
46static const ColorSpace *colorspace_from_attr(const pxr::UsdAttribute &attr)
47{
48 pxr::TfToken cs_name = pxr::UsdColorSpaceAPI::ComputeColorSpaceName(attr);
49 if (cs_name.IsEmpty()) {
50 return nullptr;
51 }
52
53 const ColorSpace *cs = IMB_colormanagement_space_get_named(cs_name.GetText());
56 {
57 return nullptr;
58 }
59
60 return cs;
61}
62
63void colorspace_attr_to_scene_linear(const pxr::UsdAttribute &attr, pxr::GfVec3f &color)
64{
65 const ColorSpace *cs = colorspace_from_attr(attr);
66 if (cs) {
68 }
69}
70
71void colorspace_attr_to_scene_linear(const pxr::UsdAttribute &attr, ColorGeometry4f &color)
72{
73 const ColorSpace *cs = colorspace_from_attr(attr);
74 if (cs) {
76 }
77}
78
79void colorspace_attr_to_scene_linear(const pxr::UsdAttribute &attr,
81{
82 const ColorSpace *cs = colorspace_from_attr(attr);
83 if (cs && !colors.is_empty()) {
84 IMB_colormanagement_colorspace_to_scene_linear(&colors[0].r, colors.size(), 1, 4, cs, false);
85 }
86}
87
88static pxr::TfToken get_source_color_space(const pxr::UsdShadeShader &usd_shader)
89{
90 if (!usd_shader) {
91 return pxr::TfToken();
92 }
93
94 pxr::UsdShadeInput color_space_input = usd_shader.GetInput(usdtokens::sourceColorSpace);
95
96 if (!color_space_input) {
97 return pxr::TfToken();
98 }
99
100 pxr::VtValue color_space_val;
101 if (color_space_input.Get(&color_space_val) && color_space_val.IsHolding<pxr::TfToken>()) {
102 return color_space_val.UncheckedGet<pxr::TfToken>();
103 }
104
105 return pxr::TfToken();
106}
107
108void colorspace_to_image_texture(const pxr::UsdShadeShader &usd_shader,
109 const pxr::UsdShadeInput &file_input,
110 const bool is_data,
111 Image *image)
112{
113 /* Set texture color space.
114 * TODO(makowalski): For now, just checking for RAW color space,
115 * assuming sRGB otherwise, but more complex logic might be
116 * required if the color space is "auto". */
117 pxr::TfToken color_space = get_source_color_space(usd_shader);
118
119 if (color_space.IsEmpty()) {
120 color_space = file_input.GetAttr().GetColorSpace();
121 }
122
123 if (color_space.IsEmpty()) {
124 color_space = pxr::UsdColorSpaceAPI::ComputeColorSpaceName(usd_shader.GetPrim());
125 }
126
127 if (color_space.IsEmpty()) {
128 /* At this point, assume the "auto" space and translate accordingly. */
129 color_space = usdtokens::auto_;
130 }
131
132 if (color_space == usdtokens::auto_) {
133 /* If it's auto, determine whether to apply color correction based
134 * on incoming connection (passed in from outer functions). */
136 &image->colorspace_settings,
139 }
140
141 else if (color_space == usdtokens::sRGB) {
144 }
145 /* Due to there being a lot of non-compliant USD assets out there, this is
146 * a special case where we need to check for different spellings here.
147 * On write, we are *only* using the correct, lower-case "raw" token. */
148 else if (ELEM(color_space, usdtokens::data, usdtokens::RAW, usdtokens::raw)) {
150 &image->colorspace_settings,
152 }
153 else {
154 const ColorSpace *cs = IMB_colormanagement_space_get_named(color_space.GetText());
155 if (cs) {
158 }
159 }
160}
161
162void colorspace_from_image_texture(const Image *image, pxr::UsdShadeShader &shader)
163{
164 if (!image) {
165 return;
166 }
167
168 /* Write sourceColorSpace input for backward compatibility with older USD readers. */
169 if (IMB_colormanagement_space_name_is_data(image->colorspace_settings.name)) {
170 shader.CreateInput(usdtokens::sourceColorSpace, pxr::SdfValueTypeNames->Token)
171 .Set(usdtokens::raw);
172 }
173 else if (IMB_colormanagement_space_name_is_srgb(image->colorspace_settings.name)) {
174 shader.CreateInput(usdtokens::sourceColorSpace, pxr::SdfValueTypeNames->Token)
175 .Set(usdtokens::sRGB);
176 }
177
178 /* Write ColorSpaceAPI with the interop ID, which supports any colorspace. */
179 const ColorSpace *cs = IMB_colormanagement_space_get_named(image->colorspace_settings.name);
180 if (cs) {
182 if (!interop_id.is_empty()) {
183 pxr::UsdColorSpaceAPI cs_api = pxr::UsdColorSpaceAPI::Apply(shader.GetPrim());
184 cs_api.CreateColorSpaceNameAttr(pxr::VtValue(pxr::TfToken(interop_id)));
185 }
186 }
187}
188
189} // namespace blender::io::usd
#define ELEM(...)
constexpr int64_t size() const
Definition BLI_span.hh:499
constexpr bool is_empty() const
Definition BLI_span.hh:515
constexpr bool is_empty() const
static const pxr::TfToken sRGB("sRGB", pxr::TfToken::Immortal)
static const pxr::TfToken data("data", pxr::TfToken::Immortal)
static const pxr::TfToken raw("raw", pxr::TfToken::Immortal)
static const pxr::TfToken sourceColorSpace("sourceColorSpace", pxr::TfToken::Immortal)
static const pxr::TfToken auto_("auto", pxr::TfToken::Immortal)
static const pxr::TfToken RAW("RAW", pxr::TfToken::Immortal)
void colorspace_from_image_texture(const Image *image, pxr::UsdShadeShader &shader)
void colorspace_attr_to_scene_linear(const pxr::UsdAttribute &attr, pxr::GfVec3f &color)
static pxr::TfToken get_source_color_space(const pxr::UsdShadeShader &usd_shader)
void colorspace_to_image_texture(const pxr::UsdShadeShader &usd_shader, const pxr::UsdShadeInput &file_input, const bool is_data, Image *image)
void colorspace_apply_to_prim(const pxr::UsdPrim &prim)
static const ColorSpace * colorspace_from_attr(const pxr::UsdAttribute &attr)
pxr::TfToken colorspace_scene_linear_interop_id()
bool IMB_colormanagement_space_is_scene_linear(const ColorSpace *colorspace)
void IMB_colormanagement_colorspace_to_scene_linear_v3(float pixel[3], const ColorSpace *colorspace)
const char * IMB_colormanagement_role_colorspace_name_get(int role)
void IMB_colormanagement_colorspace_settings_set(ColorManagedColorspaceSettings *settings, const char *name)
const char * IMB_colormanagement_colorspace_get_name(const ColorSpace *colorspace)
void IMB_colormanagement_colorspace_to_scene_linear_v4(float pixel[4], bool predivide, const ColorSpace *colorspace)
const char * IMB_colormanagement_srgb_colorspace_name_get()
bool IMB_colormanagement_space_is_data(const ColorSpace *colorspace)
StringRefNull IMB_colormanagement_space_get_interop_id(const ColorSpace *colorspace)
const ColorSpace * IMB_colormanagement_space_get_named(const char *name)
ColorSceneLinear4f< eAlpha::Premultiplied > ColorGeometry4f
bool IMB_colormanagement_space_name_is_data(const char *name)
void IMB_colormanagement_colorspace_to_scene_linear(float *buffer, int width, int height, int channels, const ColorSpace *colorspace, bool predivide)
ocio::ColorSpace ColorSpace
Definition BLF_api.hh:42
bool IMB_colormanagement_space_name_is_srgb(const char *name)