Adsk Contrib - Enhance active display/view list API (#2186)

* Enhance active display/view list API

Signed-off-by: Doug Walker <[email protected]>

* Update ocioview to use new API

Signed-off-by: Doug Walker <[email protected]>

* Fix python arg name

Signed-off-by: Doug Walker <[email protected]>

---------

Signed-off-by: Doug Walker <[email protected]>

Author: doug-walker

include/OpenColorIO/OpenColorIO.h

@@ -1096,37 +1096,78 @@ class OCIOEXPORT Config
     /**
      * \brief
      * 
-     * $OCIO_ACTIVE_DISPLAYS envvar can, at runtime, optionally override the
-     * allowed displays. It is a comma or colon delimited list. Active displays
-     * that are not in the specified profile will be ignored, and the
-     * left-most defined display will be the default.
-     * 
-     * Comma-delimited list of names to filter and order the active displays.
+     * The Active Displays list allows end users, config authors, and client apps to filter and
+     * reorder of the list of displays available in a user-interface. The list may be left empty
+     * to indicate all displays are active.
+     *
+     * The first active display is the config's Default Display.
+     *
+     * If the active list would remove all displays from a config, it is ignored (though the
+     * config won't validate).
+     *
+     * When serialized in the config, commas are used as separators. However, if a display name
+     * contains a comma, the name will be enclosed in quotes so its comma is not a separator.
      * 
-     * \note
-     *      The setter does not override the envvar.  The getter does not take into
-     *      account the envvar value and thus may not represent what the user is seeing.
+     * The OCIO_ACTIVE_DISPLAYS environment variable will override the active list specified in
+     * the config file as well as any modifications made by the client app. These functions
+     * only get and set what is in the config object and do not take into account the override
+     * and thus may not represent the actual user experience.
      */
+    /// Set all active displays at once as a comma or colon delimited string. This replaces any
+    /// previous contents of the list.
     void setActiveDisplays(const char * displays);
+    /// Get a string with all active displays (as it would appear in a config file).
+    /// Commas are always used as the separator.
     const char * getActiveDisplays() const;
+    /// Get the number of active displays.
+    int getNumActiveDisplays() const;
+    /// Get a single active display, by index. Returns nullptr if the index is out of range.
+    const char * getActiveDisplay(int index) const;
+    /// Add a single active display to the end of the list. If the display is already present,
+    /// no action is taken.
+    void addActiveDisplay(const char * display);
+    /// Remove a single display. Will throw if the display is not present.
+    void removeActiveDisplay(const char * display);
+    /// Clear the active displays list.
+    void clearActiveDisplays();
 
     /**
      * \brief
      * 
-     * $OCIO_ACTIVE_VIEWS envvar can, at runtime, optionally override the allowed views.
-     * It is a comma or colon delimited list.
-     * Active views that are not in the specified profile will be ignored, and the
-     * left-most defined view will be the default.
-     * 
-     * Comma-delimited list of names to filter and order the active views.
+     * The Active Views list allows end users, config authors, and client apps to filter and
+     * reorder of the list of views available in a user-interface. The list may be left empty
+     * to indicate all views are active.
+     *
+     * The first active view for a display is its Default View.
+     *
+     * If the active list would remove all views from a display, the list is ignored for that
+     * display and all views are shown for it.
+     *
+     * When serialized in the config, commas are used as separators. However, if a view name
+     * contains a comma, the name will be enclosed in quotes so its comma is not a separator.
      * 
-     * \note
-     *     The setter does not override the envvar. The getter does not take
-     *     into account the envvar value and thus may not represent what the
-     *     user is seeing.
+     * The OCIO_ACTIVE_VIEWS environment variable will override the active list specified in
+     * the config file as well as any modifications made by the client app. These functions
+     * only get and set what is in the config object and do not take into account the override
+     * and thus may not represent the actual user experience.
      */
+    /// Set all active views at once as a comma or colon delimited string. This replaces any
+    /// previous contents of the list.
     void setActiveViews(const char * views);
+    /// Get a string with all active views (as it would appear in a config file).
+    /// Commas are always used as the separator.
     const char * getActiveViews() const;
+    /// Get the number of active views.
+    int getNumActiveViews() const;
+    /// Get a single active view, by index. Returns nullptr if the index is out of range.
+    const char * getActiveView(int index) const;
+    /// Add a single active view to the end of the list. If the view is already present,
+    /// no action is taken.
+    void addActiveView(const char * view);
+    /// Remove a single view. Will throw if the view is not present.
+    void removeActiveView(const char * view);
+    /// Clear the active views list.
+    void clearActiveViews();
 
     /// Get all displays in the config, ignoring the active_displays list.
     int getNumDisplaysAll() const noexcept;

src/OpenColorIO/Config.cpp

@@ -1029,6 +1029,7 @@ class Config::Impl
             oss << "Profile description: " << monitorDescription;
             cs->setDescription(oss.str().c_str());
             cs->setTransform(file, COLORSPACE_DIR_FROM_REFERENCE);
+            cs->setEncoding("sdr-video");
 
             // Note that it adds it or updates the existing one.
             m_allColorSpaces->addColorSpace(cs);
@@ -3386,7 +3387,7 @@ void Config::removeSharedView(const char * view)
     {
         std::ostringstream os;
         os << "Shared view could not be removed from config. A shared view named '"
-           << view << "' could be be found.";
+           << view << "' could not be found.";
         throw Exception(os.str().c_str());
     }
 }
@@ -4115,6 +4116,14 @@ void Config::setActiveDisplays(const char * displays)
     getImpl()->m_activeDisplays.clear();
     getImpl()->m_activeDisplays = SplitStringEnvStyle(displays);
 
+    // SplitStringEnvStyle needs to always return a result, even if empty, for look parsing.
+    // However, this does not count as an active display, so delete it.
+    if( getImpl()->m_activeDisplays.size() == 1 && 
+        getImpl()->m_activeDisplays[0].empty() )
+    {
+        getImpl()->m_activeDisplays.clear();
+    }
+
     getImpl()->m_displayCache.clear();
 
     AutoMutex lock(getImpl()->m_cacheidMutex);
@@ -4127,11 +4136,94 @@ const char * Config::getActiveDisplays() const
     return getImpl()->m_activeDisplaysStr.c_str();
 }
 
+void Config::addActiveDisplay(const char * display)
+{
+    if( !display || !display[0] )
+    {
+        throw Exception("Active display could not be added to config, display name was empty");
+    }
+    
+    auto it = std::find(getImpl()->m_activeDisplays.begin(),
+                        getImpl()->m_activeDisplays.end(), display);
+
+    if( it != getImpl()->m_activeDisplays.end() )
+    {
+        // Display is already present.
+        return;
+    }
+
+    getImpl()->m_activeDisplays.push_back(display);
+
+    getImpl()->m_displayCache.clear();
+    AutoMutex lock(getImpl()->m_cacheidMutex);
+    getImpl()->resetCacheIDs();
+}
+
+void Config::removeActiveDisplay(const char * display)
+{
+    if( !display || !display[0] )
+    {
+        throw Exception("Active display could not be removed from config, display name was empty.");
+    }
+        
+    auto it = std::find( getImpl()->m_activeDisplays.begin(),
+                         getImpl()->m_activeDisplays.end(), display );
+
+    if( it != getImpl()->m_activeDisplays.end() )
+    {
+        getImpl()->m_activeDisplays.erase(it);
+    }
+    else
+    {
+        std::ostringstream os;
+        os << "Active display could not be removed from config, display '"
+           << display << "' was not found.";
+        throw Exception(os.str().c_str());
+    }
+
+    getImpl()->m_displayCache.clear();
+    AutoMutex lock(getImpl()->m_cacheidMutex);
+    getImpl()->resetCacheIDs();
+}
+
+void Config::clearActiveDisplays()
+{
+    getImpl()->m_activeDisplays.clear();
+
+    getImpl()->m_displayCache.clear();
+    AutoMutex lock(getImpl()->m_cacheidMutex);
+    getImpl()->resetCacheIDs();
+}
+
+const char * Config::getActiveDisplay( int index ) const
+{
+    if( index<0 || 
+        index >= static_cast<int>(getImpl()->m_activeDisplays.size()))
+    {
+        return nullptr;
+    }
+
+    return getImpl()->m_activeDisplays[index].c_str();
+}
+
+int Config::getNumActiveDisplays() const
+{
+    return static_cast<int>(getImpl()->m_activeDisplays.size());
+}
+
 void Config::setActiveViews(const char * views)
 {
     getImpl()->m_activeViews.clear();
     getImpl()->m_activeViews = SplitStringEnvStyle(views);
 
+    // SplitStringEnvStyle needs to always return a result, even if empty, for look parsing.
+    // However, this does not count as an active view, so delete it.
+    if( getImpl()->m_activeViews.size() == 1 && 
+        getImpl()->m_activeViews[0].empty() )
+    {
+        getImpl()->m_activeViews.clear();
+    }
+
     getImpl()->m_displayCache.clear();
 
     AutoMutex lock(getImpl()->m_cacheidMutex);
@@ -4144,6 +4236,81 @@ const char * Config::getActiveViews() const
     return getImpl()->m_activeViewsStr.c_str();
 }
 
+void Config::addActiveView(const char * view)
+{
+    if( !view || !view[0] )
+    {
+        throw Exception("Active view could not be added to config, view name was empty.");
+    }
+
+    auto it = std::find(getImpl()->m_activeViews.begin(),
+                        getImpl()->m_activeViews.end(), view);
+
+    if( it != getImpl()->m_activeViews.end() )
+    {
+        // View is already present.
+        return;
+    }
+
+    getImpl()->m_activeViews.push_back(view);
+
+    getImpl()->m_displayCache.clear();
+    AutoMutex lock(getImpl()->m_cacheidMutex);
+    getImpl()->resetCacheIDs();
+}
+
+void Config::removeActiveView(const char * view)
+{
+    if( !view || !view[0] )
+    {
+        throw Exception("Active view could not be removed from config, view name was empty.");
+    }
+        
+    auto it = std::find( getImpl()->m_activeViews.begin(),
+                         getImpl()->m_activeViews.end(), view );
+
+    if(it!=getImpl()->m_activeViews.end())
+    {
+            getImpl()->m_activeViews.erase(it);
+    }
+    else
+    {
+            std::ostringstream os;
+            os << "Active view could not be removed from config, view '"
+               << view << "' was not found.";
+            throw Exception(os.str().c_str());
+    }
+
+    getImpl()->m_displayCache.clear();
+    AutoMutex lock(getImpl()->m_cacheidMutex);
+    getImpl()->resetCacheIDs();
+}
+
+void Config::clearActiveViews()
+{
+    getImpl()->m_activeViews.clear();
+
+    getImpl()->m_displayCache.clear();
+    AutoMutex lock(getImpl()->m_cacheidMutex);
+    getImpl()->resetCacheIDs();
+}
+
+const char * Config::getActiveView( int index ) const
+{
+    if( index<0 || 
+        index >= static_cast<int>(getImpl()->m_activeViews.size()))
+    {
+        return nullptr;
+    }
+
+    return getImpl()->m_activeViews[index].c_str();
+}
+
+int Config::getNumActiveViews() const
+{
+    return static_cast<int>(getImpl()->m_activeViews.size());
+}
+
 int Config::getNumDisplaysAll() const noexcept
 {
     return static_cast<int>(getImpl()->m_displays.size());

src/OpenColorIO/OCIOYaml.cpp

@@ -5061,13 +5061,26 @@ inline void save(YAML::Emitter & out, const Config & config)
     out << YAML::Newline;
     out << YAML::Key << "active_displays";
     StringUtils::StringVec active_displays;
-    if(config.getActiveDisplays() != NULL && strlen(config.getActiveDisplays()) > 0)
-        active_displays = SplitStringEnvStyle(config.getActiveDisplays());
+    int nDisplays = config.getNumActiveDisplays();
+    active_displays.reserve( nDisplays );
+    for (int i = 0; i < nDisplays; i++)
+    {
+        active_displays.push_back(config.getActiveDisplay(i));
+    }
+
+    // The YAML library will wrap names that use a comma in quotes.
     out << YAML::Value << YAML::Flow << active_displays;
+
     out << YAML::Key << "active_views";
     StringUtils::StringVec active_views;
-    if(config.getActiveViews() != NULL && strlen(config.getActiveViews()) > 0)
-        active_views = SplitStringEnvStyle(config.getActiveViews());
+    int nViews = config.getNumActiveViews();
+    active_views.reserve( nViews );
+    for (int i = 0; i < nViews; i++)
+    {
+        active_views.push_back(config.getActiveView(i));
+    }
+    
+    // The YAML library will wrap names that use a comma in quotes.
     out << YAML::Value << YAML::Flow << active_views;
 
     const std::string inactiveCSs = config.getInactiveColorSpaces();