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.

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

Adsk Contrib - Fix NamedTransform context var issue #1905

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
59 changes: 53 additions & 6 deletions src/OpenColorIO/transforms/ColorSpaceTransform.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -184,15 +184,15 @@ void BuildColorSpaceOps(OpRcPtrVec & ops,

if (!src)
{
srcNamedTransform = config.getNamedTransform(srcName.c_str());
srcNamedTransform = config.getNamedTransform( context->resolveStringVar(srcName.c_str()) );
if (!srcNamedTransform)
{
ThrowMissingCS(srcName.c_str());
}
}
if (!dst)
{
dstNamedTransform = config.getNamedTransform(dstName.c_str());
dstNamedTransform = config.getNamedTransform( context->resolveStringVar(dstName.c_str()) );
if (!dstNamedTransform)
{
ThrowMissingCS(dstName.c_str());
Expand Down Expand Up @@ -393,6 +393,31 @@ void BuildReferenceConversionOps(OpRcPtrVec & ops,
}
}

bool CollectContextVariables(const Config & config,
const Context & context,
ConstNamedTransformRcPtr & nt,
ContextRcPtr & usedContextVars)
{
bool foundContextVars = false;

if (nt)
{
ConstTransformRcPtr to = nt->getTransform(TRANSFORM_DIR_FORWARD);
if (to && CollectContextVariables(config, context, to, usedContextVars))
{
foundContextVars = true;
}

ConstTransformRcPtr from = nt->getTransform(TRANSFORM_DIR_INVERSE);
if (from && CollectContextVariables(config, context, from, usedContextVars))
{
foundContextVars = true;
}
}

return foundContextVars;
}

bool CollectContextVariables(const Config & config,
const Context & context,
ConstColorSpaceRcPtr & cs,
Expand Down Expand Up @@ -441,15 +466,37 @@ bool CollectContextVariables(const Config & config,
}

ConstColorSpaceRcPtr src = config.getColorSpace(srcName.c_str());
if (CollectContextVariables(config, context, src, usedContextVars))
if (src)
{
foundContextVars = true;
if (CollectContextVariables(config, context, src, usedContextVars))
{
foundContextVars = true;
}
}
else
{
ConstNamedTransformRcPtr nt_src = config.getNamedTransform(srcName.c_str());
if (CollectContextVariables(config, context, nt_src, usedContextVars))
{
foundContextVars = true;
}
}

ConstColorSpaceRcPtr dst = config.getColorSpace(dstName.c_str());
if (CollectContextVariables(config, context, dst, usedContextVars))
if (dst)
{
foundContextVars = true;
if (CollectContextVariables(config, context, dst, usedContextVars))
{
foundContextVars = true;
}
}
else
{
ConstNamedTransformRcPtr nt_dst = config.getNamedTransform(dstName.c_str());
if (CollectContextVariables(config, context, nt_dst, usedContextVars))
{
foundContextVars = true;
}
}

return foundContextVars;
Expand Down
27 changes: 26 additions & 1 deletion tests/cpu/Config_tests.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1452,7 +1452,7 @@ OCIO_ADD_TEST(Config, context_variable_with_colorspacename)

// Set $VAR3 and check again.

OCIO_CHECK_NO_THROW(cfg->addEnvironmentVar("VAR3", "cs1"));
OCIO_CHECK_NO_THROW(cfg->addEnvironmentVar("VAR3", "file.clf"));
OCIO_CHECK_NO_THROW(cfg->validate());
}

Expand Down Expand Up @@ -1537,6 +1537,31 @@ OCIO_ADD_TEST(Config, context_variable_with_colorspacename)
OCIO::Exception,
"Color space '$VAR3' could not be found.");
}

// Repeat the test using a NamedTransform for one of the color spaces.

{
std::string configStr
= std::string(CONFIG)
+ " from_scene_reference: !<ColorSpaceTransform> {src: $VAR3, dst: cs1}\n"
+ "named_transforms:\n"
+ " - !<NamedTransform>\n"
+ " name: nt1\n"
+ " transform: !<RangeTransform> {min_in_value: 0, min_out_value: 0}\n";

std::istringstream iss;
iss.str(configStr);

OCIO::ConfigRcPtr cfg;
OCIO_CHECK_NO_THROW(cfg = OCIO::Config::CreateFromStream(iss)->createEditableCopy());

OCIO_CHECK_NO_THROW(cfg->addEnvironmentVar("VAR3", "nt1"));
OCIO_CHECK_NO_THROW(cfg->validate());

OCIO::ContextRcPtr ctx;
OCIO_CHECK_NO_THROW(ctx = cfg->getCurrentContext()->createEditableCopy());
OCIO_CHECK_NO_THROW(cfg->getProcessor(ctx, "cs1", "cs2"));
}
}

OCIO_ADD_TEST(Config, context_variable_with_role)
Expand Down
18 changes: 18 additions & 0 deletions tests/cpu/transforms/ColorSpaceTransform_tests.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -834,6 +834,24 @@ OCIO_ADD_TEST(ColorSpaceTransform, context_variables)
OCIO_CHECK_EQUAL(std::string("ENV1"), usedContextVars->getStringVarNameByIndex(0));
OCIO_CHECK_EQUAL(std::string("exposure_contrast_linear.ctf"),
usedContextVars->getStringVarByIndex(0));

// Case 5 - Context variable indirectly used via a NamedTransform.

OCIO::NamedTransformRcPtr namedTransform = OCIO::NamedTransform::Create();
namedTransform->setName("nt");
OCIO::FileTransformRcPtr file2 = OCIO::FileTransform::Create();
file2->setSrc("$ENV1");
namedTransform->setTransform(file2, OCIO::TRANSFORM_DIR_FORWARD);
OCIO_CHECK_NO_THROW(cfg->addNamedTransform(namedTransform));

// 'cst' now uses 'nt' which is a NamedTransform whose transform uses a context variable.
cst->setSrc("nt");
usedContextVars = OCIO::Context::Create(); // New & empty instance.
OCIO_CHECK_ASSERT(OCIO::CollectContextVariables(*cfg, *ctx, *cst, usedContextVars));
OCIO_CHECK_EQUAL(1, usedContextVars->getNumStringVars());
OCIO_CHECK_EQUAL(std::string("ENV1"), usedContextVars->getStringVarNameByIndex(0));
OCIO_CHECK_EQUAL(std::string("exposure_contrast_linear.ctf"),
usedContextVars->getStringVarByIndex(0));
}

// Please see (Config, named_transform_processor) in NamedTransform_tests.cpp for coverage of
Expand Down