Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Declare metadatas in Sdr registry #1350

Merged
merged 3 commits into from
Nov 22, 2022
Merged

Declare metadatas in Sdr registry #1350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d575886
Declare metadatas in Sdr registry #55
sebastienblor Nov 14, 2022
8cb2d9c
Improvements in the Sdr metadatas #55
sebastienblor Nov 19, 2022
b96ef16
Fix typo in the comments #55
sebastienblor Nov 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions common/constant_strings.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ ASTR2(renderPassPrimIdReader, "HdArnoldRenderPass_prim_id_reader");
ASTR2(renderPassPrimIdWriter, "HdArnoldRenderPass_prim_id_writer");
ASTR2(render_context, "RENDER_CONTEXT");
ASTR2(sidedness_prefix, "sidedness:");
ASTR2(ui_groups, "ui.groups");
ASTR2(visibility_prefix, "visibility:");

ASTR(AA_sample_clamp);
Expand All @@ -101,6 +102,7 @@ ASTR(crypto_asset);
ASTR(crypto_material);
ASTR(crypto_object);
ASTR(custom_attributes);
ASTR(desc);
ASTR(FLOAT);
ASTR(GI_diffuse_depth);
ASTR(GI_diffuse_samples);
Expand Down Expand Up @@ -215,6 +217,7 @@ ASTR(crease_idxs);
ASTR(crease_sharpness);
ASTR(curves);
ASTR(cylinder_light);
ASTR(dcc);
ASTR(defaultPrim);
ASTR(depth_pointer);
ASTR(diffuse);
Expand Down Expand Up @@ -256,6 +259,7 @@ ASTR(gaussian_filter);
ASTR(geometry);
ASTR(ginstance);
ASTR(grids);
ASTR(hide);
ASTR(husk);
ASTR(hydra);
ASTR(id);
Expand Down Expand Up @@ -298,6 +302,7 @@ ASTR(interactive_fps_min);
ASTR(interactive_target_fps);
ASTR(interactive_target_fps_min);
ASTR(ior);
ASTR(label);
ASTR(latlong);
ASTR(layer_enable_filtering);
ASTR(layer_half_precision);
Expand All @@ -306,6 +311,7 @@ ASTR(light_filter);
ASTR(light_group);
ASTR(light_path_expressions);
ASTR(linear);
ASTR(linkable);
ASTR(log_flags_console);
ASTR(log_flags_file);
ASTR(mask);
Expand Down Expand Up @@ -399,6 +405,8 @@ ASTR(shutter_start);
ASTR(sidedness);
ASTR(skydome_light);
ASTR(smoothing);
ASTR(softmax);
ASTR(softmin);
ASTR(specular);
ASTR(specularColor);
ASTR(specular_IOR);
Expand Down Expand Up @@ -437,6 +445,7 @@ ASTR(translation);
ASTR(transmission);
ASTR(twrap);
ASTR(uniform);
ASTR(usd);
ASTR(useMetadata);
ASTR(useSpecularWorkflow);
ASTR(use_light_group);
Expand Down
170 changes: 146 additions & 24 deletions ndr/parser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ TF_DEFINE_PRIVATE_TOKENS(_tokens,
(arnold)
((arnoldPrefix, "arnold:"))
((outputsPrefix, "outputs:"))
((uigroups, "ui:groups"))
(uimin)
(uimax)
(uisoftmin)
(uisoftmax)
(enumValues)
(binary));
// clang-format on

Expand Down Expand Up @@ -99,6 +105,86 @@ NdrArnoldParserPlugin::NdrArnoldParserPlugin() {}

NdrArnoldParserPlugin::~NdrArnoldParserPlugin() {}


void _ReadShaderAttribute(const UsdAttribute &attr, NdrPropertyUniquePtrVec &properties, const std::string &folder)
{
const TfToken& attrName = attr.GetName();
const std::string& attrNameStr = attrName.GetString();

// check if this attribute is an output #1121
bool isOutput = TfStringStartsWith(attrName, _tokens->outputsPrefix);
if (!isOutput && TfStringContains(attrNameStr, ":")) {
// In case `info:id` is set on the nodes.
return;
}

VtValue v;
attr.Get(&v);
// The utility function takes care of the conversion and figuring out
// parameter types, so we just have to blindly pass all required
// parameters.
VtDictionary customData = attr.GetCustomData();
NdrTokenMap metadata;
NdrTokenMap hints;

// For enum attributes, all enum fields should be set as "options"
// to this attribute
NdrOptionVec options;
auto it = customData.find(_tokens->enumValues);
if (it != customData.end()) {
VtStringArray enumValues = it->second.Get<VtStringArray>();
for (const auto &enumValue : enumValues) {
TfToken enumValTf(enumValue.c_str());
options.emplace_back(enumValTf, enumValTf);
}
}

// USD supports a builtin list of metadatas. Only these ones
// need to be declared in the "metadata" section.
static const auto supportedMetadatas = {
SdrPropertyMetadata->Page,
SdrPropertyMetadata->Connectable,
SdrPropertyMetadata->Label,
SdrPropertyMetadata->Role,
SdrPropertyMetadata->Help
};

if (!folder.empty()) {
metadata.insert({SdrPropertyMetadata->Page, folder});
}
for (const auto &m : supportedMetadatas) {
const auto it = customData.find(m);
if (it != customData.end())
metadata.insert({m, TfStringify(it->second)});
}

// For metadatas that aren't USD builtins, we need to set
// them as "hints", otherwise USD will complain
static const auto supportedHints = {
_tokens->uimin,
_tokens->uimax,
_tokens->uisoftmin,
_tokens->uisoftmax
};

for (const auto &h : supportedHints) {
const auto it = customData.find(h);
if (it != customData.end())
hints.insert({h, TfStringify(it->second)});
}

properties.emplace_back(SdrShaderPropertyUniquePtr(new ArnoldShaderProperty{
isOutput ? attr.GetBaseName() : attr.GetName(), // name
attr.GetTypeName(), // typeName
v, // defaultValue
isOutput, // isOutput
0, // arraySize
metadata, // metadata
hints, // hints
options // options
}));
}

NdrNodeUniquePtr NdrArnoldParserPlugin::Parse(const NdrNodeDiscoveryResult& discoveryResult)
{
auto shaderDefs = NdrArnoldGetShaderDefs();
Expand All @@ -118,39 +204,75 @@ NdrNodeUniquePtr NdrArnoldParserPlugin::Parse(const NdrNodeDiscoveryResult& disc
NdrPropertyUniquePtrVec properties;
const auto props = prim.GetAuthoredProperties();
properties.reserve(props.size());

VtDictionary primCustomData = prim.GetCustomData();
// keep track of which attributes were declared, to avoid
// doing it twice for the same parameter
std::unordered_set<std::string> declaredAttributes;

// If this node entry has a metadata ui.groups, we use it to determine
// the UI grouping and ordering. We will expect it to be defined as e.g. :
// "Base: base base_color metalness, Specular: specular specular_color"
if (primCustomData.find(_tokens->uigroups) != primCustomData.end()) {
VtValue groupsVal = primCustomData[_tokens->uigroups];
// Get ui.groups metadata as a string
std::string uigroupsStr = groupsVal.Get<std::string>();
if (!uigroupsStr.empty()) {
// First, split for each group, with the "," separator
const auto uigroupList = TfStringSplit(uigroupsStr, ",");
for (const auto& uigroupElem : uigroupList) {
if (uigroupElem.empty())
continue;
// The first part before ":" represents the group UI label,
// the second contains the ordered list of attributes included
// in this group
const auto uigroupSplit = TfStringSplit(uigroupElem, ":");
// If no ":" separator is found, we use this to set the attribute ordering
// but no label is set.
std::string folder = (uigroupSplit.size() > 1) ? uigroupSplit[0] : "";
std::string uigroupAttrs = uigroupSplit.back();

// The list of attributes for a given group is separated by spaces
const auto &uigroupAttrList = TfStringSplit(uigroupAttrs, " ");
for (const auto& uigroupAttr : uigroupAttrList) {
if (uigroupAttr.empty())
continue;

// if this attribute was previously declared, skip it
if (declaredAttributes.find(uigroupAttr) != declaredAttributes.end())
continue;

// Add this attribute to the properties list
declaredAttributes.insert(uigroupAttr);
UsdAttribute attr = prim.GetAttribute(TfToken(uigroupAttr.c_str()));
if (attr) {
_ReadShaderAttribute(attr, properties, folder);
}
}
}
}
}

// Now loop over all usd properties that were declared, and add
// the ones that weren't added previously with ui.groups
for (const UsdProperty& property : props) {
const TfToken& propertyName = property.GetName();
const std::string& propertyNameStr = propertyName.GetString();

TfToken outputName;
// check if this attribute is an output #1121
bool isOutput = TfStringStartsWith(propertyName, _tokens->outputsPrefix);

if (!isOutput && TfStringContains(propertyNameStr, ":")) {
// In case `info:id` is set on the nodes.
continue;
}
const auto propertyStack = property.GetPropertyStack();
if (propertyStack.empty()) {
continue;
}

const auto attr = prim.GetAttribute(propertyName);
VtValue v;
attr.Get(&v);
// The utility function takes care of the conversion and figuring out
// parameter types, so we just have to blindly pass all required
// parameters.
// TODO(pal): Read metadata and hints.
properties.emplace_back(SdrShaderPropertyUniquePtr(new ArnoldShaderProperty{
isOutput ? property.GetBaseName() : propertyName, // name
attr.GetTypeName(), // typeName
v, // defaultValue
isOutput, // isOutput
0, // arraySize
NdrTokenMap(), // metadata
NdrTokenMap(), // hints
NdrOptionVec() // options
}));
// If this attribute was already declared in the above code
// for ui.groups, we don't want to declare it again
if (declaredAttributes.find(propertyNameStr) != declaredAttributes.end())
continue;

declaredAttributes.insert(propertyNameStr);
_ReadShaderAttribute(attr, properties, "");

}

return NdrNodeUniquePtr(new SdrShaderNode(
Expand Down
Loading