Merging adsk_contrib/make-interchange-roles-required-for-future-config-version into this new branch as one commit in order to clean up the commits. (#1711)

Signed-off-by: Cedrik Fuoco <[email protected]>

Signed-off-by: Cedrik Fuoco <[email protected]>

Author: cedrik-fuoco-adsk

src/OpenColorIO/Config.cpp

@@ -243,7 +243,7 @@ static constexpr unsigned LastSupportedMajorVersion = OCIO_VERSION_MAJOR;
 
 // For each major version keep the most recent minor.
 static const unsigned int LastSupportedMinorVersion[] = {0, // Version 1
-                                                         1  // Version 2
+                                                         2  // Version 2
                                                          };
 
 } // namespace
@@ -1368,7 +1368,8 @@ void Config::validate() const
 
     StringSet existingColorSpaces;
 
-    bool hasDisplayReferredColorspace = false;
+    bool hasDisplayReferredColorspace   = false;
+    bool hasSceneReferredColorspace     = false;
 
     // Confirm all ColorSpaces are valid.
     for(int i=0; i<getImpl()->m_allColorSpaces->getNumColorSpaces(); ++i)
@@ -1415,13 +1416,18 @@ void Config::validate() const
 
         const std::string namelower = StringUtils::Lower(name);
         existingColorSpaces.insert(namelower);
+
         if (cs->getReferenceSpaceType() == REFERENCE_SPACE_DISPLAY)
         {
             hasDisplayReferredColorspace = true;
         }
+        else if (cs->getReferenceSpaceType() == REFERENCE_SPACE_SCENE)
+        {
+            hasSceneReferredColorspace = true;
+        }
     }
 
-    // Confirm all roles are valid.
+    // Confirm all roles used by the config are valid and that essential roles are present.
     {
         for(StringMap::const_iterator iter = getImpl()->m_roles.begin(),
             end = getImpl()->m_roles.end(); iter!=end; ++iter)
@@ -1451,6 +1457,107 @@ void Config::validate() const
 
             // AddColorSpace, addNamedTransform & setRole already check there is no name conflict.
         }
+
+
+        // Check for interchange roles requirements - scene-referred and display-referred.
+        if (getMajorVersion() >= 2 && getMinorVersion() >= 2)
+        {
+            bool hasRoleSceneLinear                 = false;
+            bool hasRoleCompositingLog              = false;
+            bool hasRoleColorTiming                 = false;
+
+            bool hasRoleAcesInterchange             = false;
+            bool acesInterHasSceneRefColorspace     = false;
+            bool hasRoleCieXyzD65Interchange        = false;
+            bool cieInterHasDisplayRefColorspace    = false;
+
+            for (auto const& role : getImpl()->m_roles)
+            {
+                if (Platform::Strcasecmp(role.first.c_str(), ROLE_SCENE_LINEAR) == 0)
+                {
+                    hasRoleSceneLinear = true;
+                }
+                else if (Platform::Strcasecmp(role.first.c_str(), ROLE_COMPOSITING_LOG ) == 0)
+                {
+                    hasRoleCompositingLog = true;
+                }
+                else if (Platform::Strcasecmp(role.first.c_str(), ROLE_COLOR_TIMING) == 0)
+                {
+                    hasRoleColorTiming = true;
+                }
+                else if (Platform::Strcasecmp(role.first.c_str(), ROLE_INTERCHANGE_SCENE) == 0)
+                {
+                    hasRoleAcesInterchange = true;
+
+                    ConstColorSpaceRcPtr cs = getColorSpace(role.second.c_str());
+                    acesInterHasSceneRefColorspace = 
+                        cs->getReferenceSpaceType() == REFERENCE_SPACE_SCENE;
+                }
+                else if (Platform::Strcasecmp(role.first.c_str(), ROLE_INTERCHANGE_DISPLAY) == 0)
+                {
+                    hasRoleCieXyzD65Interchange = true;
+
+                    ConstColorSpaceRcPtr cs = getColorSpace(role.second.c_str());
+                    cieInterHasDisplayRefColorspace = 
+                        cs->getReferenceSpaceType() == REFERENCE_SPACE_DISPLAY;
+                }
+            }
+
+            // All LogError below are technically a validation failure, but only logging a message 
+            // rather than throwing (for now). This is to make it possible for upgradeToLatestVersion
+            // to always result in a config that does not fail validation.
+
+            if (!hasRoleSceneLinear)
+            {
+                std::ostringstream os;
+                os << "The scene_linear role is required for a config version 2.2 or higher.";
+                LogError(os.str());
+            }
+
+            if (!hasRoleCompositingLog)
+            {
+                std::ostringstream os;
+                os << "The compositing_log role is required for a config version 2.2 or higher.";
+                LogError(os.str());
+            }
+
+            if (!hasRoleColorTiming)
+            {
+                std::ostringstream os;
+                os << "The color_timing role is required for a config version 2.2 or higher.";
+                LogError(os.str());
+            }
+
+            if (hasSceneReferredColorspace && !hasRoleAcesInterchange)
+            {
+                std::ostringstream os;
+                os << "The aces_interchange role is required when there are scene-referred";
+                os << " color spaces and the config version is 2.2 or higher.";
+                LogError(os.str());
+            }
+            else if (hasRoleAcesInterchange && 
+                     !acesInterHasSceneRefColorspace)
+            {
+                std::ostringstream os;
+                os << "The aces_interchange role must be a scene-referred color space.";
+                LogError(os.str());
+            }
+
+            if (hasDisplayReferredColorspace && !hasRoleCieXyzD65Interchange)
+            {
+                std::ostringstream os;
+                os << "The cie_xyz_d65_interchange role is required when there are";
+                os << " display-referred color spaces and the config version is 2.2 or higher.";
+                LogError(os.str());
+            }
+            else if (hasRoleCieXyzD65Interchange && 
+                     !cieInterHasDisplayRefColorspace)
+            {
+                std::ostringstream os;
+                os << "The cie_xyz_d65_interchange role must be a display-referred color space.";
+                LogError(os.str());
+            }
+        }
     }
 
     // Confirm all inactive color spaces or named transforms exist.
@@ -4858,7 +4965,6 @@ void Config::Impl::checkVersionConsistency() const
     {
         throw Exception("Only version 2 (or higher) can have NamedTransforms.");
     }
-
 }
 
 void Config::setConfigIOProxy(ConfigIOProxyRcPtr ciop)

src/OpenColorIO/Logging.cpp

@@ -153,6 +153,20 @@ void LogMessage(LoggingLevel level, const char * message)
     }
 }
 
+void LogError(const std::string & text)
+{
+    AutoMutex lock(g_logmutex);
+    InitLogging();
+
+    // Did not add a LOGGING_LEVEL_ERROR since the enum values are part of the user-facing 
+    // documentation and it is therefore difficult to insert an ERROR value since it would 
+    // naturally need to fall between 0 and 1. But there is no need since presumably users 
+    // that want to see warnings would also want to see errors.
+    if(g_logginglevel<LOGGING_LEVEL_WARNING) return;
+
+    LogMessage("[OpenColorIO Error]: ", text);
+}
+
 void LogWarning(const std::string & text)
 {
     AutoMutex lock(g_logmutex);

src/OpenColorIO/Logging.h

@@ -11,6 +11,7 @@
 
 namespace OCIO_NAMESPACE
 {
+void LogError(const std::string & text);
 void LogWarning(const std::string & text);
 void LogInfo(const std::string & text);
 void LogDebug(const std::string & text);