Skip to content

Add methods to get all views, ignoring active views list #2348

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

Open
lijenicol wants to merge 1 commit into
base: main
Choose a base branch
from
+95 −1
Open

Add methods to get all views, ignoring active views list #2348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions include/OpenColorIO/OpenColorIO.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -886,6 +886,14 @@ class OCIOEXPORT Config
int getNumViews(const char * display) const;
const char * getView(const char * display, int index) const;

/**
* Return the number of views, ignoring the active_views list, attached to the
* display including the number of shared views if any. Return 0 if display
* does not exist.
*/
int getNumViewsAll(const char * display) const;
const char * getViewAll(const char * display, int index) const;

/**
* If the config has ViewingRules, get the number of active Views for this
* colorspace. (If there are no rules, it returns all of them.)
Expand Down
29 changes: 29 additions & 0 deletions src/OpenColorIO/Config.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3509,6 +3509,35 @@ const char * Config::getView(const char * display, int index) const
return "";
}

int Config::getNumViewsAll(const char * display) const
{
if (!display || !*display) return 0;

DisplayMap::const_iterator iter = FindDisplay(getImpl()->m_displays, display);
if(iter == getImpl()->m_displays.end()) return 0;

const ViewPtrVec views = getImpl()->getViews(iter->second);

return static_cast<int>(views.size());
}

const char * Config::getViewAll(const char * display, int index) const
{
if (!display || !*display || index < 0) return "";

DisplayMap::const_iterator iter = FindDisplay(getImpl()->m_displays, display);
if(iter == getImpl()->m_displays.end()) return "";

const ViewPtrVec views = getImpl()->getViews(iter->second);

if(static_cast<size_t>(index) < views.size())
{
return views[index]->m_name.c_str();
}

return "";
}

int Config::getNumViews(const char * display, const char * colorspace) const
{
if (!display || !*display || !colorspace || !*colorspace) return 0;
Expand Down
59 changes: 58 additions & 1 deletion tests/cpu/Config_tests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3538,19 +3538,30 @@ OCIO_ADD_TEST(Config, view)
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(is));
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_1")), "View_1");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_1"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_1"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 0)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 1)), "View_2");
// Invalid index.
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 0)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 1)), "View_2");
// Invalid indexes.
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 42)), "");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", -1)), "");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 42)), "");

OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_2")), "View_2");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_2"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_2"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_2", 0)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_2", 1)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 0)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 1)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_3")), "View_3");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_3"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_3"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_3", 1)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 1)), "View_1");

std::stringstream ss;
ss << *config.get();
Expand All @@ -3571,14 +3582,23 @@ OCIO_ADD_TEST(Config, view)
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_1")), "View_1");
// The active views list is ignored, for a display, if it would remove all views.
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_1"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_1"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 0)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 1)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 0)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 1)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_2")), "View_3");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_2"), 1);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_2"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_2", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 0)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 1)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_3")), "View_3");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_3"), 1);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_3"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 1)), "View_1");

OCIO_REQUIRE_EQUAL(config->getNumViews(OCIO::VIEW_DISPLAY_DEFINED, "sRGB_1"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViews(OCIO::VIEW_DISPLAY_DEFINED, "sRGB_2"), 2);
Expand All @@ -3603,16 +3623,26 @@ OCIO_ADD_TEST(Config, view)
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(is));
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_1")), "View_2");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_1"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_1"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 0)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 1)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 0)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 1)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_2")), "View_3");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_2"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_2"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_2", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_2", 1)), "View_2");
// Ignore view ordering from active views list.
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 0)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 1)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_3")), "View_3");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_3"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_3"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_3", 1)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 1)), "View_1");
}

{
Expand All @@ -3630,14 +3660,23 @@ OCIO_ADD_TEST(Config, view)
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(is));
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_1")), "View_2");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_1"), 1);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_1"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 0)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 0)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 1)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_2")), "View_3");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_2"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_2"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_2", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_2", 1)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 0)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 1)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_3")), "View_3");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_3"), 1);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_3"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 1)), "View_1");
}

{
Expand All @@ -3656,16 +3695,25 @@ OCIO_ADD_TEST(Config, view)
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(is));
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_1")), "View_1");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_1"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_1"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 0)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 1)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 0)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 1)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_2")), "View_2");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_2"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_2"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_2", 0)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_2", 1)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 0)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 1)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_3")), "View_3");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_3"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_3"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_3", 1)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 1)), "View_1");
}

{
Expand All @@ -3684,16 +3732,25 @@ OCIO_ADD_TEST(Config, view)
OCIO_CHECK_NO_THROW(config = OCIO::Config::CreateFromStream(is));
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_1")), "View_1");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_1"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_1"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 0)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_1", 1)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 0)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_1", 1)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_2")), "View_2");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_2"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_2"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_2", 0)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_2", 1)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 0)), "View_2");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_2", 1)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getDefaultView("sRGB_3")), "View_3");
OCIO_REQUIRE_EQUAL(config->getNumViews("sRGB_3"), 2);
OCIO_REQUIRE_EQUAL(config->getNumViewsAll("sRGB_3"), 2);
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getView("sRGB_3", 1)), "View_1");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 0)), "View_3");
OCIO_CHECK_EQUAL(std::string(config->getViewAll("sRGB_3", 1)), "View_1");
}
}

Expand Down
Loading