Config.cpp

// SPDX-License-Identifier: BSD-3-Clause
// Copyright Contributors to the OpenColorIO Project.


#include <cstdlib>
#include <cstring>
#include <set>
#include <sstream>
#include <fstream>
#include <utility>
#include <vector>
#include <regex>
#include <functional>
#include <algorithm>
#include <exception>

#include <pystring.h>

#include <OpenColorIO/OpenColorIO.h>

#include "ConfigUtils.h"
#include "ContextVariableUtils.h"
#include "Display.h"
#include "fileformats/FileFormatICC.h"
#include "FileRules.h"
#include "HashUtils.h"
#include "Logging.h"
#include "LookParse.h"
#include "MathUtils.h"
#include "Mutex.h"
#include "OCIOYaml.h"
#include "OCIOZArchive.h"
#include "ParseUtils.h"
#include "PathUtils.h"
#include "Platform.h"
#include "PrivateTypes.h"
#include "Processor.h"
#include "utils/StringUtils.h"
#include "ViewingRules.h"
#include "SystemMonitor.h"

namespace OCIO_NAMESPACE
{

const char * OCIO_CONFIG_ENVVAR               = "OCIO";
const char * OCIO_ACTIVE_DISPLAYS_ENVVAR      = "OCIO_ACTIVE_DISPLAYS";
const char * OCIO_ACTIVE_VIEWS_ENVVAR         = "OCIO_ACTIVE_VIEWS";
const char * OCIO_INACTIVE_COLORSPACES_ENVVAR = "OCIO_INACTIVE_COLORSPACES";
const char * OCIO_OPTIMIZATION_FLAGS_ENVVAR   = "OCIO_OPTIMIZATION_FLAGS";
const char * OCIO_USER_CATEGORIES_ENVVAR      = "OCIO_USER_CATEGORIES";

// Default filename (with extension) of a config and archived config.
const char * OCIO_CONFIG_DEFAULT_NAME         = "config";
const char * OCIO_CONFIG_DEFAULT_FILE_EXT     = ".ocio";
const char * OCIO_CONFIG_ARCHIVE_FILE_EXT     = ".ocioz";

// A shared view using this for the color space name will use a display color space that
// has the same name as the display the shared view is used by.
const char * OCIO_VIEW_USE_DISPLAY_NAME       = "<USE_DISPLAY_NAME>";

const char * OCIO_BUILTIN_URI_PREFIX          = "ocio://";

namespace
{

// These are the 709 primaries specified by the ASC.
constexpr double DEFAULT_LUMA_COEFF_R = 0.2126;
constexpr double DEFAULT_LUMA_COEFF_G = 0.7152;
constexpr double DEFAULT_LUMA_COEFF_B = 0.0722;


constexpr char INTERNAL_RAW_PROFILE[] =
    "ocio_profile_version: 2\n"
    "strictparsing: false\n"
    "roles:\n"
    "  default: raw\n"
    "file_rules:\n"
    "  - !<Rule> {name: Default, colorspace: default}\n"
    "displays:\n"
    "  sRGB:\n"
    "  - !<View> {name: Raw, colorspace: raw}\n"
    "colorspaces:\n"
    "  - !<ColorSpace>\n"
    "      name: raw\n"
    "      family: raw\n"
    "      equalitygroup:\n"
    "      bitdepth: 32f\n"
    "      isdata: true\n"
    "      allocation: uniform\n"
    "      description: 'A raw color space. Conversions to and from this space are no-ops.'\n";

} // anon.


///////////////////////////////////////////////////////////////////////////

const char * GetVersion()
{
    return OCIO_VERSION_FULL_STR;
}

int GetVersionHex()
{
    return OCIO_VERSION_HEX;
}

namespace
{
ConstConfigRcPtr g_currentConfig;
Mutex g_currentConfigLock;
}

ConstConfigRcPtr GetCurrentConfig()
{
    AutoMutex lock(g_currentConfigLock);

    if(!g_currentConfig)
    {
        g_currentConfig = Config::CreateFromEnv();
    }

    return g_currentConfig;
}

void SetCurrentConfig(const ConstConfigRcPtr & config)
{
    AutoMutex lock(g_currentConfigLock);

    g_currentConfig = config->createEditableCopy();
}

namespace
{

// Environment
const char* LookupEnvironment(const StringMap & env, const std::string & name)
{
    StringMap::const_iterator iter = env.find(name);
    if(iter == env.end()) return "";
    return iter->second.c_str();
}

// Roles
// (lower case role name: colorspace name)
const char* LookupRole(const StringMap & roles, const std::string & rolename)
{
    StringMap::const_iterator iter = roles.find(StringUtils::Lower(rolename));
    if(iter == roles.end()) return "";
    return iter->second.c_str();
}

void GetFileReferences(std::set<std::string> & files, const ConstTransformRcPtr & transform)
{
    if(!transform) return;

    if(ConstGroupTransformRcPtr groupTransform =
        DynamicPtrCast<const GroupTransform>(transform))
    {
        for(int i=0; i<groupTransform->getNumTransforms(); ++i)
        {
            GetFileReferences(files, groupTransform->getTransform(i));
        }
    }
    else if(ConstFileTransformRcPtr fileTransform =
        DynamicPtrCast<const FileTransform>(transform))
    {
        files.insert(fileTransform->getSrc());
    }
}

// Return the list of all color spaces referenced by the transform (including all sub-transforms in
// a group). All legal context variables are expanded, so if any are remaining, the caller may want
// to throw.
void GetColorSpaceReferences(std::set<std::string> & colorSpaceNames,
                             const ConstTransformRcPtr & transform,
                             const ConstContextRcPtr & context)
{
    if(!transform) return;

    if(ConstGroupTransformRcPtr groupTransform =
        DynamicPtrCast<const GroupTransform>(transform))
    {
        for(int i=0; i<groupTransform->getNumTransforms(); ++i)
        {
            GetColorSpaceReferences(colorSpaceNames, groupTransform->getTransform(i), context);
        }
    }
    else if(ConstColorSpaceTransformRcPtr colorSpaceTransform =
        DynamicPtrCast<const ColorSpaceTransform>(transform))
    {
        colorSpaceNames.insert(context->resolveStringVar(colorSpaceTransform->getSrc()));
        colorSpaceNames.insert(context->resolveStringVar(colorSpaceTransform->getDst()));
    }
    else if(ConstDisplayViewTransformRcPtr displayViewTransform =
        DynamicPtrCast<const DisplayViewTransform>(transform))
    {
        colorSpaceNames.insert(displayViewTransform->getSrc());
    }
    else if(ConstLookTransformRcPtr lookTransform =
        DynamicPtrCast<const LookTransform>(transform))
    {
        colorSpaceNames.insert(lookTransform->getSrc());
        colorSpaceNames.insert(lookTransform->getDst());
    }
}

// Views are stored in two vectors of objects, using pointers to temporarily group them.
typedef std::vector<const View *> ViewPtrVec;

StringUtils::StringVec GetViewNames(const ViewPtrVec & views)
{
    StringUtils::StringVec viewNames;
    for (const auto & view : views)
    {
        viewNames.push_back(view->m_name);
    }
    return viewNames;
}

std::ostringstream GetDisplayViewPrefixErrorMsg(const std::string & display, const View & view)
{
    std::ostringstream oss;
    oss << "Config failed display view validation. ";
    if (display.empty())
    {
        oss << "Shared ";
    }
    else
    {
        oss << "Display '" << display << "' has a ";
    }
    if (view.m_name.empty())
    {
        oss << "view with an empty name.";
    }
    else
    {
        oss << "view '" << view.m_name << "' ";
    }
    return oss;
}

static constexpr unsigned FirstSupportedMajorVersion = 1;
static constexpr unsigned LastSupportedMajorVersion = OCIO_VERSION_MAJOR;

// For each major version keep the most recent minor.
static const unsigned int LastSupportedMinorVersion[] = {0, // Version 1
                                                         5  // Version 2
                                                         };

} // namespace

class Config::Impl
{
public:
    enum Validation
    {
        VALIDATION_UNKNOWN = 0,
        VALIDATION_PASSED,
        VALIDATION_FAILED
    };

    unsigned int m_majorVersion;
    unsigned int m_minorVersion;
    StringMap m_env;
    ContextRcPtr m_context;
    std::string m_name;
    static constexpr char DefaultFamilySeparator = '/';
    char m_familySeparator = DefaultFamilySeparator;
    std::string m_description;

    // The final list of inactive color spaces is built from several inputs.
    // An API request (using Config::setInactiveColorSpaces()) always supersedes
    // the list from the env. variable (i.e. OCIO_INACTIVE_COLORSPACES_ENVVAR) which
    // supersedes the list from the config. file (i.e. inactive_colorspaces).
    //
    // Refer to Config::Impl::refreshActiveColorSpaces() to have the implementation details.

    ColorSpaceSetRcPtr m_allColorSpaces; // All the color spaces (i.e. no filtering).
    StringUtils::StringVec m_activeColorSpaceNames; // Active color space names.
    StringUtils::StringVec m_inactiveColorSpaceNames; // inactive color space names.

    // Inactive color space or named transform filter from API request.
    std::string m_inactiveColorSpaceNamesAPI;
    // Inactive color space or named transform filter from env. variable.
    std::string m_inactiveColorSpaceNamesEnv;
    // Inactive color space or named transform filter from config. file.
    std::string m_inactiveColorSpaceNamesConf;

    StringMap m_roles;
    LookVec m_looksList;

    DisplayMap m_displays;
    StringUtils::StringVec m_activeDisplays;
    StringUtils::StringVec m_activeDisplaysEnvOverride;
    StringUtils::StringVec m_activeViews;
    StringUtils::StringVec m_activeViewsEnvOverride;
    ViewVec m_sharedViews;
    ViewingRulesRcPtr m_viewingRules;

    // List of views attached to the virtual display.
    Display m_virtualDisplay;

    std::vector<ViewTransformRcPtr> m_viewTransforms;
    std::string m_defaultViewTransform;

    mutable std::string m_activeDisplaysStr;
    mutable std::string m_activeViewsStr;
    mutable StringUtils::StringVec m_displayCache;

    // All the named transforms(i.e. no filtering).
    std::vector<ConstNamedTransformRcPtr> m_allNamedTransforms;
    // Active named transform names.
    StringUtils::StringVec m_activeNamedTransformNames;
    // Inactive named transform names.
    StringUtils::StringVec m_inactiveNamedTransformNames;

    // Misc
    std::vector<double> m_defaultLumaCoefs;
    bool m_strictParsing;

    mutable Validation m_validation;
    mutable std::string m_validationtext;

    mutable Mutex m_cacheidMutex;
    mutable StringMap m_cacheids;
    mutable std::string m_cacheidnocontext;
    FileRulesRcPtr m_fileRules;

    mutable ProcessorCacheFlags m_cacheFlags { PROCESSOR_CACHE_DEFAULT };
    mutable ProcessorCache<std::size_t, ProcessorRcPtr> m_processorCache;

    Impl() :
        m_majorVersion(LastSupportedMajorVersion),
        m_minorVersion(LastSupportedMinorVersion[LastSupportedMajorVersion - 1]),
        m_context(Context::Create()),
        m_allColorSpaces(ColorSpaceSet::Create()),
        m_viewingRules(ViewingRules::Create()),
        m_strictParsing(true),
        m_validation(VALIDATION_UNKNOWN),
        m_fileRules(FileRules::Create())
    {
        std::string activeDisplays;
        Platform::Getenv(OCIO_ACTIVE_DISPLAYS_ENVVAR, activeDisplays);
        activeDisplays = StringUtils::Trim(activeDisplays);
        if (!activeDisplays.empty())
        {
            m_activeDisplaysEnvOverride = SplitStringEnvStyle(activeDisplays);
        }

        std::string activeViews;
        Platform::Getenv(OCIO_ACTIVE_VIEWS_ENVVAR, activeViews);
        activeViews = StringUtils::Trim(activeViews);
        if (!activeViews.empty())
        {
            m_activeViewsEnvOverride = SplitStringEnvStyle(activeViews);
        }

        m_defaultLumaCoefs.resize(3);
        m_defaultLumaCoefs[0] = DEFAULT_LUMA_COEFF_R;
        m_defaultLumaCoefs[1] = DEFAULT_LUMA_COEFF_G;
        m_defaultLumaCoefs[2] = DEFAULT_LUMA_COEFF_B;

        Platform::Getenv(OCIO_INACTIVE_COLORSPACES_ENVVAR, m_inactiveColorSpaceNamesEnv);
        m_inactiveColorSpaceNamesEnv = StringUtils::Trim(m_inactiveColorSpaceNamesEnv);

        m_processorCache.enable((m_cacheFlags & PROCESSOR_CACHE_ENABLED) == PROCESSOR_CACHE_ENABLED);

        // This is used to allow the YAML writer to not save any virtual displays that were
        // instantiated.
        m_virtualDisplay.m_temporary = true;
    }

    ~Impl() = default;
    Impl(const Impl&) = delete;

    Impl& operator= (const Impl & rhs)
    {
        if(this!=&rhs)
        {
            m_majorVersion = rhs.m_majorVersion;
            m_minorVersion = rhs.m_minorVersion;

            m_env = rhs.m_env;
            m_context = rhs.m_context->createEditableCopy();
            m_name = rhs.m_name;
            m_familySeparator = rhs.m_familySeparator;
            m_description = rhs.m_description;

            // Deep copy the colorspaces.
            m_allColorSpaces = rhs.m_allColorSpaces->createEditableCopy();
            m_activeColorSpaceNames       = rhs.m_activeColorSpaceNames;
            m_inactiveColorSpaceNames     = rhs.m_inactiveColorSpaceNames;
            m_inactiveColorSpaceNamesConf = rhs.m_inactiveColorSpaceNamesConf;
            m_inactiveColorSpaceNamesEnv  = rhs.m_inactiveColorSpaceNamesEnv;
            m_inactiveColorSpaceNamesAPI  = rhs.m_inactiveColorSpaceNamesAPI;

            // Deep copy the looks.
            m_looksList.clear();
            m_looksList.reserve(rhs.m_looksList.size());
            for (const auto & look : rhs.m_looksList)
            {
                m_looksList.push_back(look->createEditableCopy());
            }

            // Assignment operator will suffice for these.
            m_roles = rhs.m_roles;

            m_allNamedTransforms.clear();
            m_allNamedTransforms.reserve(rhs.m_allNamedTransforms.size());
            for (const auto & nt : rhs.m_allNamedTransforms)
            {
                m_allNamedTransforms.push_back(nt->createEditableCopy());
            }
            m_activeNamedTransformNames = rhs.m_activeNamedTransformNames;
            m_inactiveNamedTransformNames = rhs.m_inactiveNamedTransformNames;

            m_displays = rhs.m_displays;
            m_activeDisplays = rhs.m_activeDisplays;
            m_activeViews = rhs.m_activeViews;
            m_activeViewsEnvOverride = rhs.m_activeViewsEnvOverride;
            m_activeDisplaysEnvOverride = rhs.m_activeDisplaysEnvOverride;
            m_activeDisplaysStr = rhs.m_activeDisplaysStr;
            m_displayCache = rhs.m_displayCache;
            m_viewingRules = rhs.m_viewingRules->createEditableCopy();
            m_sharedViews = rhs.m_sharedViews;

            m_virtualDisplay = rhs.m_virtualDisplay;

            // Deep copy view transforms.
            m_viewTransforms.clear();
            m_viewTransforms.reserve(rhs.m_viewTransforms.size());
            for (const auto & vt : rhs.m_viewTransforms)
            {
                m_viewTransforms.push_back(vt->createEditableCopy());
            }
            m_defaultViewTransform = rhs.m_defaultViewTransform;
            m_defaultLumaCoefs = rhs.m_defaultLumaCoefs;
            m_strictParsing = rhs.m_strictParsing;

            m_validation = rhs.m_validation;
            m_validationtext = rhs.m_validationtext;

            m_cacheids = rhs.m_cacheids;
            m_cacheidnocontext = rhs.m_cacheidnocontext;

            m_fileRules = rhs.m_fileRules->createEditableCopy();
            
            m_cacheFlags = rhs.m_cacheFlags;

            m_processorCache.clear();
            m_processorCache.enable((m_cacheFlags & PROCESSOR_CACHE_ENABLED) == PROCESSOR_CACHE_ENABLED);
        }
        return *this;
    }

    ConstColorSpaceRcPtr getColorSpace(const char * name) const
    {
        // Check to see if the name is a color space.
        ConstColorSpaceRcPtr cs = m_allColorSpaces->getColorSpace(name);
        if (!cs)
        {
            // Check to see if the name is a role.
            const char * csname = LookupRole(m_roles, name);
            cs = m_allColorSpaces->getColorSpace(csname);
        }

        return cs;
    }

    // Only search for a color space name (i.e. not for a role name).
    int getColorSpaceIndex(const char * csname) const
    {
        return m_allColorSpaces->getColorSpaceIndex(csname);
    }

    // Only search for a color space name (i.e. not for a role name).
    bool hasColorSpace(const char * csname) const
    {
        return m_allColorSpaces->hasColorSpace(csname);
    }

    ConstNamedTransformRcPtr getNamedTransform(const char * name) const noexcept
    {
        size_t index = getNamedTransformIndex(name);
        if (index >= m_allNamedTransforms.size())
        {
            return ConstNamedTransformRcPtr();
        }

        return m_allNamedTransforms[index];
    }

    size_t getNamedTransformIndex(const char * name) const noexcept
    {
        if (name && *name)
        {
            const std::string str = StringUtils::Lower(name);
            for (size_t idx = 0; idx < m_allNamedTransforms.size(); ++idx)
            {
                if (StringUtils::Lower(m_allNamedTransforms[idx]->getName()) == str)
                {
                    return idx;
                }
                const auto numAliases = m_allNamedTransforms[idx]->getNumAliases();
                for (size_t alias = 0; alias < numAliases; ++alias)
                {
                    if (StringUtils::Lower(m_allNamedTransforms[idx]->getAlias(alias)) == str)
                    {
                        return idx;
                    }
                }
            }
        }
        return static_cast<size_t>(-1);
    }

    enum InactiveType
    {
        INACTIVE_COLORSPACE =0,
        INACTIVE_NAMEDTRANSFORM,
        INACTIVE_ALL
    };
    StringUtils::StringVec buildInactiveNamesList(InactiveType type) const;
    void refreshActiveColorSpaces();

    ConstViewTransformRcPtr getViewTransform(const char * name) const noexcept
    {
        const std::string namelower = StringUtils::Lower(name);

        for (const auto & vt : m_viewTransforms)
        {
            if (StringUtils::Lower(vt->getName()) == namelower)
            {
                return vt;
            }
        }

        return ConstViewTransformRcPtr();
    }

    ConstLookRcPtr getLook(const char * name) const
    {
        const std::string namelower = StringUtils::Lower(name);

        for (const auto & look : m_looksList)
        {
            if (StringUtils::Lower(look->getName()) == namelower)
            {
                return look;
            }
        }

        return ConstLookRcPtr();
    }

    ViewPtrVec getViews(const Display & display) const
    {
        ViewPtrVec views;
        for (const auto & view : display.m_views)
        {
            views.push_back(&view);
        }

        for (const auto & shared : display.m_sharedViews)
        {
            ViewVec::const_iterator sharedView = FindView(m_sharedViews, shared.c_str());
            if (sharedView != m_sharedViews.end())
            {
                const View * viewPtr = &(*sharedView);
                views.push_back(viewPtr);
            }
        }
        return views;
    }

    // Any time you modify the state of the config, you must call this
    // to reset internal cache states.  You also should do this in a
    // thread safe manner by acquiring the m_cacheidMutex.
    void resetCacheIDs();

    // Get all internal transforms (to generate cacheIDs, validation, etc).
    // This currently crawls colorspaces + looks + view transforms.
    void getAllInternalTransforms(ConstTransformVec & transformVec) const;

    static ConstConfigRcPtr Read(std::istream & istream, const char * filename);
    static ConstConfigRcPtr Read(std::istream & istream, ConfigIOProxyRcPtr ciop);

    // Validate view object that can be a config defined shared view or a display-defined view.
    void validateView(const std::string & display, const View & view, bool checkUseDisplayName) const
    {
        if (view.m_name.empty())
        {
            std::ostringstream os{ GetDisplayViewPrefixErrorMsg(display, view) };
            m_validationtext = os.str();
            throw Exception(m_validationtext.c_str());
        }

        const bool sharedViewWithViewTransform = display.empty() && !view.m_viewTransform.empty();

        // Validate color space name is not empty.
        if (view.m_colorspace.empty())
        {
            std::ostringstream os{ GetDisplayViewPrefixErrorMsg(display, view) };
            os << "does not refer to a color space.";
            m_validationtext = os.str();
            throw Exception(m_validationtext.c_str());
        }

        if (checkUseDisplayName)
        {
            // USE_DISPLAY_NAME can only be used by shared views.
            if (!sharedViewWithViewTransform && view.useDisplayNameForColorspace())
            {
                std::ostringstream os{ GetDisplayViewPrefixErrorMsg(display, view) };
                os << "can not use '" << OCIO_VIEW_USE_DISPLAY_NAME;
                os << "' keyword for the color space name.";
                m_validationtext = os.str();
                throw Exception(m_validationtext.c_str());
            }
        }

        // If USE_DISPLAY_NAME is not present, a valid color space must be specified.
        if (!view.useDisplayNameForColorspace() &&
            !hasColorSpace(view.m_colorspace.c_str()) &&
            !getNamedTransform(view.m_colorspace.c_str()))
        {
            std::ostringstream os{ GetDisplayViewPrefixErrorMsg(display, view) };
            os << "that refers to a color space or a named transform, '" << view.m_colorspace;
            os << "', which is not defined.";
            m_validationtext = os.str();
            throw Exception(m_validationtext.c_str());
        }

        // If there is a view transform, it must exist (or be a named transform) and its color
        // space must be a display-referred color space.
        if (!view.m_viewTransform.empty())
        {
            if (!getNamedTransform(view.m_viewTransform.c_str()))
            {
                if (!getViewTransform(view.m_viewTransform.c_str()))
                {
                    std::ostringstream os{ GetDisplayViewPrefixErrorMsg(display, view) };
                    os << "that refers to a view transform, '" << view.m_viewTransform << "', ";
                    os << "which is neither a view transform nor a named transform.";
                    m_validationtext = os.str();
                    throw Exception(m_validationtext.c_str());
                }
            }
            const char * displayCS = view.m_colorspace.c_str();
            if (view.useDisplayNameForColorspace())
            {
                displayCS = display.c_str();
            }
            auto cs = getColorSpace(displayCS);
            if (cs && cs->getReferenceSpaceType() != REFERENCE_SPACE_DISPLAY)
            {
                std::ostringstream os{ GetDisplayViewPrefixErrorMsg(display, view) };
                os << "refers to a color space, '" << std::string(displayCS) << "', ";
                os << "that is not a display-referred color space.";
                m_validationtext = os.str();
                throw Exception(m_validationtext.c_str());
            }
        }

        // Confirm looks references exist.
        LookParseResult looks;
        const LookParseResult::Options & options = looks.parse(view.m_looks);

        for (const auto & option : options)
        {
            for (const auto & token : option)
            {
                const std::string look = token.name;

                if (!look.empty() && !getLook(look.c_str()))
                {
                    std::ostringstream os{ GetDisplayViewPrefixErrorMsg(display, view) };
                    os << "refers to a look, '" << look << "', ";
                    os << "which is not defined.";
                    m_validationtext = os.str();
                    throw Exception(m_validationtext.c_str());
                }
            }
        }

        if (!view.m_rule.empty())
        {
            size_t ruleIndex{ 0 };
            if (!FindRule(m_viewingRules, view.m_rule, ruleIndex))
            {
                std::ostringstream os{ GetDisplayViewPrefixErrorMsg(display, view) };
                os << "refers to a viewing rule, '" << view.m_rule << "', ";
                os << "which is not defined.";
                m_validationtext = os.str();
                throw Exception(m_validationtext.c_str());
            }
        }
    }

    // Check a shared view used in a display. View itself has already been checked.
    void validateSharedView(const std::string & display, 
                            const ViewVec & viewsOfDisplay,
                            const std::string & sharedView,
                            bool checkUseDisplayName) const
    {
        // Is the name already used for a display-defined view?
        // This should never happen because this is checked when adding a view.
        const auto viewIt = FindView(viewsOfDisplay, sharedView);
        if (viewIt != viewsOfDisplay.end())
        {
            std::ostringstream os;
            os << "Config failed view validation. ";
            os << "The display '" << display << "' ";
            os << "contains a shared view '" << sharedView;
            os << "' that is already defined as a view.";
            m_validationtext = os.str();
            throw Exception(m_validationtext.c_str());
        }

        // Is the shared view defined?
        const auto sharedViewIt = FindView(m_sharedViews, sharedView);
        if (sharedViewIt == m_sharedViews.end())
        {
            std::ostringstream os;
            os << "Config failed view validation. ";
            os << "The display '" << display << "' ";
            os << "contains a shared view '" << sharedView;
            os << "' that is not defined.";
            m_validationtext = os.str();
            throw Exception(m_validationtext.c_str());
        }
        else if (checkUseDisplayName)
        {
            const auto view = *sharedViewIt;
            if (!view.m_viewTransform.empty() && view.useDisplayNameForColorspace())
            {
                // Shared views using a view transform can omit the colorspace, in that case
                // the color space to use should be named from the display.
                const auto displayCS = getColorSpace(display.c_str());
                if (!displayCS)
                {
                    std::ostringstream os;
                    os << "Config failed view validation. The display '" << display << "' ";
                    os << "contains a shared view '" << (*sharedViewIt).m_name;
                    os << "' which does not define a color space and there is "
                          "no color space that matches the display name.";
                    m_validationtext = os.str();
                    throw Exception(m_validationtext.c_str());
                }
                if (displayCS->getReferenceSpaceType() != REFERENCE_SPACE_DISPLAY)
                {
                    std::ostringstream os;
                    os << "Config failed view validation. The display '" << display << "' ";
                    os << "contains a shared view '" << (*sharedViewIt).m_name;
                    os << "' that refers to a color space, '" << display << "', ";
                    os << "that is not a display-referred color space.";
                    m_validationtext = os.str();
                    throw Exception(m_validationtext.c_str());
                }
            }
        }
    }

    void setInactiveColorSpaces(const char * inactiveColorSpaces)
    {
        m_inactiveColorSpaceNamesConf
            = StringUtils::Trim(std::string(inactiveColorSpaces ? inactiveColorSpaces : ""));

        // An API request must always supersede the two other lists. Filling the
        // m_inactiveColorSpaceNamesAPI list highlights the API request precedence.
        m_inactiveColorSpaceNamesAPI = m_inactiveColorSpaceNamesConf;

        AutoMutex lock(m_cacheidMutex);
        resetCacheIDs();
        refreshActiveColorSpaces();
    }

    void checkVersionConsistency(ConstTransformRcPtr & transform) const;
    void checkVersionConsistency() const;

    const View * getView(const char * display, const char * view) const
    {
        if (!view || !*view) return nullptr;

        bool searchShared = !display || !*display;

        DisplayMap::const_iterator iter = m_displays.end();
        if (!searchShared)
        {
            iter = FindDisplay(m_displays, display);
            if (iter == m_displays.end()) return nullptr;

            const StringUtils::StringVec & sharedViews = iter->second.m_sharedViews;
            searchShared = StringUtils::Contain(sharedViews, view);
        }

        const ViewVec & views = searchShared ? m_sharedViews : iter->second.m_views;
        const auto & viewIt = FindView(views, view);

        if (viewIt != views.end())
        {
            return &(*viewIt);
        }
        return nullptr;
    }

    // Filter/reorder views using the active views if defined.
    StringUtils::StringVec getActiveViews(const StringUtils::StringVec & views) const
    {
        StringUtils::StringVec activeViews;
        if (!m_activeViewsEnvOverride.empty())
        {
            const StringUtils::StringVec orderedViews
                = IntersectStringVecsCaseIgnore(m_activeViewsEnvOverride, views);

            if (!orderedViews.empty())
            {
                activeViews = orderedViews;
            }
        }
        else if (!m_activeViews.empty())
        {
            const StringUtils::StringVec orderedViews
                = IntersectStringVecsCaseIgnore(m_activeViews, views);

            if (!orderedViews.empty())
            {
                activeViews = orderedViews;
            }
        }

        if (activeViews.empty())
        {
            activeViews = views;
        }
        return activeViews;
    }

    // Get all active views from a display with a rule that refers to color space or an encoding
    // referred by color space. Note that views that do not have viewing rules are all returned.
    // ViewNames, created from views, is returned as parameter.
    StringUtils::StringVec getFilteredViews(StringUtils::StringVec & viewNames,
                                            const ViewPtrVec & views,
                                            const char * imageCSName) const
    {
        ConstColorSpaceRcPtr imageColorSpace = getColorSpace(imageCSName);
        if (!imageColorSpace)
        {
            std::ostringstream os;
            os << "Could not find source color space '" << imageCSName << "'.";
            throw Exception(os.str().c_str());
        }

        const std::string viewEncoding{ imageColorSpace->getEncoding() };

        viewNames = GetViewNames(views);
        StringUtils::StringVec activeViews = getActiveViews(viewNames);

        const std::string imageColorSpaceName{ StringUtils::Lower(imageCSName) };
        StringUtils::StringVec filteredActiveViews;
        for (const auto & view : activeViews)
        {
            const auto idx = FindInStringVecCaseIgnore(viewNames, view);
            const auto & ruleName = views[idx]->m_rule;
            size_t ruleIdx{ 0 };
            if (ruleName.empty())
            {
                // Include all views that do not have a rule.
                filteredActiveViews.push_back(view);
            }
            else if (FindRule(m_viewingRules, ruleName, ruleIdx))
            {
                const size_t numcs = m_viewingRules->getNumColorSpaces(ruleIdx);
                bool added = false;
                for (size_t csIdx = 0; csIdx < numcs; ++csIdx)
                {
                    // Rule can use role names.
                    const char * rolename = m_viewingRules->getColorSpace(ruleIdx, csIdx);
                    const char * csname = LookupRole(m_roles, rolename);

                    const std::string csName{ *csname ? csname : rolename  };
                    if (StringUtils::Lower(csName) == imageColorSpaceName)
                    {
                        // Include a view if its rule contains the image's color space.
                        filteredActiveViews.push_back(view);
                        added = true;
                        break;
                    }
                }
                if (!added && !viewEncoding.empty())
                {
                    const size_t numEnc = m_viewingRules->getNumEncodings(ruleIdx);
                    for (size_t encIdx = 0; encIdx < numEnc; ++encIdx)
                    {
                        const std::string encName{ m_viewingRules->getEncoding(ruleIdx, encIdx) };
                        if (StringUtils::Lower(encName) == viewEncoding)
                        {
                            // Include a view if its rule contains the image's color space encoding.
                            filteredActiveViews.push_back(view);
                            break;
                        }
                    }
                }
            }
        }
        return filteredActiveViews;
    }

    void updateDisplayCache() const
    {
        if (m_displayCache.empty())
        {
            ComputeDisplays(m_displayCache,
                            m_displays,
                            m_activeDisplays,
                            m_activeDisplaysEnvOverride);
        }

    }

    ProcessorCacheFlags getProcessorCacheFlags() const noexcept
    {
        return m_cacheFlags;
    }

    void setProcessorCacheFlags(ProcessorCacheFlags flags) const noexcept
    {
        m_cacheFlags = flags;
        m_processorCache.enable((m_cacheFlags & PROCESSOR_CACHE_ENABLED) == PROCESSOR_CACHE_ENABLED);
    }

    ConstProcessorRcPtr getProcessorWithoutCaching(
        const Config & config,
        const ConstTransformRcPtr & transform, 
        TransformDirection direction) const
    {
        if (!transform)
        {
            throw Exception("Config::GetProcessor failed. Transform is null.");
        }
        
        ProcessorRcPtr processor = Processor::Create();
        processor->getImpl()->setProcessorCacheFlags(PROCESSOR_CACHE_OFF);
        processor->getImpl()->setTransform(config, m_context, transform, direction);
        return processor;
    }
 
    int instantiateDisplay(const std::string & monitorName,
                           const std::string & monitorDescription,
                           const std::string & ICCProfileFilepath)
    {
        if (ICCProfileFilepath.empty())
        {
            throw Exception("The ICC Profile filepath cannot be null.");
        }

        if (monitorDescription.empty())
        {
            throw Exception("The monitor description cannot be null.");
        }

        std::string envContent;
        if (Platform::Getenv(OCIO_ACTIVE_DISPLAYS_ENVVAR, envContent))
        {
            std::ostringstream oss;
            oss << "Cannot instantiate a virtual display because the list of active displays is "
                << "defined by "
                << OCIO_ACTIVE_DISPLAYS_ENVVAR
                << " = "
                << envContent
                << ".";
            throw Exception(oss.str().c_str());
        }

        std::string colorSpaceName = monitorDescription;
        // The monitor name is null if the display is instantiated from an ICC filepath.
        if (!monitorName.empty())
        {
            colorSpaceName += " [" + monitorName + "]";
        }

        // The $ is forbidden for color space names i.e. reserved for context variables.
        StringUtils::ReplaceInPlace(colorSpaceName, "$", "_");
        // The % is forbidden for color space names i.e. reserved for context variables.
        StringUtils::ReplaceInPlace(colorSpaceName, "%", "_");

        // Check if the virtual display definition is present.

        if (m_virtualDisplay.m_views.size() == 0
            && m_virtualDisplay.m_sharedViews.size() == 0)
        {
            throw Exception("The virtual display information to instantiate a display is missing.");
        }

        int absoluteDisplayIndex = -1;

        try
        {
            // Create the (display, view) pairs with the display color space implemented using
            // a FileTransform pointing to the ICC Profile.

            DisplayMap::iterator iter = FindDisplay(m_displays, colorSpaceName.c_str());
            if (iter == m_displays.end())
            {
                const size_t curSize = m_displays.size();
                m_displays.resize(curSize + 1);
                m_displays[curSize].first  = colorSpaceName;
                m_displays[curSize].second = m_virtualDisplay;

                absoluteDisplayIndex = static_cast<int>(curSize);
            }
            else
            {
                iter->second = m_virtualDisplay;

                absoluteDisplayIndex = static_cast<int>(iter - m_displays.begin());
            }

            // Add the corresponding display color space.

            ColorSpaceRcPtr cs = ColorSpace::Create(REFERENCE_SPACE_DISPLAY);
            cs->setName(colorSpaceName.c_str());
            FileTransformRcPtr file = FileTransform::Create();
            file->setSrc(ICCProfileFilepath.c_str());
            std::ostringstream oss;
            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);
        }
        catch(const Exception & /* ex */)
        {
            DisplayMap::iterator iter = FindDisplay(m_displays, colorSpaceName);
            if (iter!=m_displays.end())
            {
                m_displays.erase(iter);
            }

            m_allColorSpaces->removeColorSpace(colorSpaceName.c_str());

            throw;
        }

        // The display must be active.

        if (!m_activeDisplays.empty()
            && !m_activeDisplays[0].empty() 
            && !StringUtils::Contain(m_activeDisplays, colorSpaceName))
        {
            m_activeDisplays.push_back(colorSpaceName);
        }

        // The views must be active.

        if (!m_activeViews.empty() && !m_activeViews[0].empty())
        {
            for (const auto & view : m_displays[absoluteDisplayIndex].second.m_views)
            {
                if (!StringUtils::Contain(m_activeViews, view.m_name))
                {
                    m_activeViews.push_back(view.m_name);
                }
            }

            for (const auto & viewName : m_displays[absoluteDisplayIndex].second.m_sharedViews)
            {
                if (!StringUtils::Contain(m_activeViews, viewName))
                {
                    m_activeViews.push_back(viewName);
                }
            }
        }

        // Force to refresh of all caches.

        m_displayCache.clear();

        ComputeDisplays(m_displayCache,
                        m_displays,
                        m_activeDisplays,
                        m_activeDisplaysEnvOverride);

        AutoMutex lock(m_cacheidMutex);
        resetCacheIDs();

        refreshActiveColorSpaces();

        // Find the relative display index i.e. the index in the active display list.

        for (size_t idx = 0; idx < m_displayCache.size(); ++idx)
        {
            if (0==strcmp(m_displayCache[idx].c_str(), colorSpaceName.c_str()))
            {
                return static_cast<int>(idx);
            }
        }

        // That should never happen.
        return -1;
    }
};



// Instantiate the cache with the right types.
extern template class ProcessorCache<std::size_t, ProcessorRcPtr>;


///////////////////////////////////////////////////////////////////////////

ConfigRcPtr Config::Create()
{
    return ConfigRcPtr(new Config(), &deleter);
}

void Config::deleter(Config* c)
{
    delete c;
}

ConstConfigRcPtr Config::CreateRaw()
{
    std::istringstream istream;
    istream.str(INTERNAL_RAW_PROFILE);

    return CreateFromStream(istream);
}

ConstConfigRcPtr Config::CreateFromEnv()
{
    std::string file;
    Platform::Getenv(OCIO_CONFIG_ENVVAR, file);

    // File may be one of the following:
    //   1) Path to a config file (e.g. /home/user/ocio/config.ocio)
    //   2) Path to an archived config file (e.g. /home/user/ocio/archived_config.ocioz)
    //   3) URI to a built-in config (e.g. ocio://cg-config-v0.1.0_aces-v1.3_ocio-v2.1.1)
    if(!file.empty()) return CreateFromFile(file.c_str());

    static const char err[] =
        "Color management disabled. (Specify the $OCIO environment variable to enable.)";

    LogInfo(err);

    return CreateRaw();
}

ConstConfigRcPtr Config::CreateFromFile(const char * filename)
{
    if (!filename || !*filename)
    {
        throw ExceptionMissingFile ("The config filepath is missing.");
    }

    // Check for URI Pattern: ocio://<config name>
    static const std::regex uriPattern(R"(ocio:\/\/([^\s]+))");
    std::smatch match;
    const std::string uri = filename;
    if (std::regex_search(uri, match, uriPattern))
    {
        return CreateFromBuiltinConfig(uri.c_str());
    }

    std::ifstream ifstream = Platform::CreateInputFileStream(
        filename, 
        std::ios_base::in | std::ios_base::binary
    );

    if (ifstream.fail())
    {
        std::ostringstream os;
        os << "Error could not read '" << filename;
        os << "' OCIO profile.";
        throw Exception (os.str().c_str());
    }

    char magicNumber[2] = { 0 };
    if (ifstream.read(magicNumber, 2))
    {
        // Check if it is an OCIOZ archive.
        if (magicNumber[0] == 'P' && magicNumber[1] == 'K')
        {
            // Closing ifstream even though it should be closed by ifstream destructor (RAII).
            ifstream.close();

            // The file should be an OCIOZ archive file.

            auto ciop = std::make_shared<CIOPOciozArchive>();
            // Store archive absolute path.
            ciop->setArchiveAbsPath(filename);
            // Build the entries map.
            ciop->buildEntries();
            return CreateFromConfigIOProxy(ciop);
        }
    } 

    // Not an OCIOZ archive. Continue as usual.
    ifstream.clear();
    ifstream.seekg(0);
    return Config::Impl::Read(ifstream, filename);
}

ConstConfigRcPtr Config::CreateFromStream(std::istream & istream)
{
    return Config::Impl::Read(istream, nullptr);
}

ConstConfigRcPtr Config::CreateFromConfigIOProxy(ConfigIOProxyRcPtr ciop)
{
    ConstConfigRcPtr config = nullptr;

    // Get a stream of the config.
    std::string configStr = ciop->getConfigData();
    std::stringstream configStream(configStr);
    config = Config::Impl::Read(configStream, ciop);

    if (config == nullptr)
    {
        std::ostringstream os;
        os << "Could not create config using ConfigIOProxy.";
        throw Exception (os.str().c_str());
    }
    
    return config;
}

ConstConfigRcPtr Config::CreateFromBuiltinConfig(const char * configName)
{
    std::string builtinConfigName = configName;
    
    // Normalize the input to the URI format.
    if (!StringUtils::StartsWith(builtinConfigName, OCIO_BUILTIN_URI_PREFIX))
    {
        builtinConfigName = std::string(OCIO_BUILTIN_URI_PREFIX) + builtinConfigName;
    }

    // Resolve the URI if needed.
    const std::string uri = ResolveConfigPath(builtinConfigName.c_str());

    // Check if the config path starts with ocio://
    static const std::regex uriPattern(R"(ocio:\/\/([^\s]+))");
    std::smatch match;
    if (std::regex_search(uri, match, uriPattern))
    {
        // Store config path without the "ocio://" prefix, if present.
        builtinConfigName = match.str(1).c_str();
    }

    ConstConfigRcPtr builtinConfig;
    const BuiltinConfigRegistry & reg = BuiltinConfigRegistry::Get();

    // getBuiltinConfigByName will throw if config name not found.
    const char * builtinConfigStr = reg.getBuiltinConfigByName(builtinConfigName.c_str());
    std::istringstream iss;
    iss.str(builtinConfigStr);
    builtinConfig = Config::CreateFromStream(iss);

    return builtinConfig;
}

///////////////////////////////////////////////////////////////////////////

Config::Config()
: m_impl(new Config::Impl())
{
}

Config::~Config()
{
    delete m_impl;
    m_impl = nullptr;
}

unsigned Config::getMajorVersion() const
{
    return m_impl->m_majorVersion;
}

void Config::setMajorVersion(unsigned int version)
{
    if (version <  FirstSupportedMajorVersion
        || version >  LastSupportedMajorVersion)
    {
        std::ostringstream os;
            os << "The version is " << version
            << " where supported versions start at "
            << FirstSupportedMajorVersion
            << " and end at "
            << LastSupportedMajorVersion
            << ".";
            throw Exception(os.str().c_str());
    }
    m_impl->m_majorVersion = version;
    m_impl->m_minorVersion = LastSupportedMinorVersion[version - 1];

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

unsigned Config::getMinorVersion() const
{
    return m_impl->m_minorVersion;
}

void Config::setMinorVersion(unsigned int version)
{
    const unsigned int maxMinor = LastSupportedMinorVersion[m_impl->m_majorVersion - 1];
    if (version > maxMinor)
    {
        std::ostringstream os;
        os << "The minor version " << version
            << " is not supported for major version "
            << m_impl->m_majorVersion
            << ". Maximum minor version is " << maxMinor << ".";
        throw Exception(os.str().c_str());
    }
    m_impl->m_minorVersion = version;
}

void Config::setVersion(unsigned int major, unsigned int minor)
{
    setMajorVersion(major);
    setMinorVersion(minor);
}

void Config::upgradeToLatestVersion() noexcept
{
    const auto wasVersion = m_impl->m_majorVersion;
    if (wasVersion != LastSupportedMajorVersion)
    {
        if (wasVersion == 1)
        {
            UpdateFileRulesFromV1ToV2(*this, m_impl->m_fileRules);

            // The instance version is now 2.0
            m_impl->m_majorVersion = 2;
            m_impl->m_minorVersion = 0;
        }

        static_assert(LastSupportedMajorVersion == 2, "Config: Handle newer versions");
        setMajorVersion(LastSupportedMajorVersion);
        setMinorVersion(LastSupportedMinorVersion[LastSupportedMajorVersion - 1]);
    }
}

ConfigRcPtr Config::createEditableCopy() const
{
    ConfigRcPtr config = Config::Create();
    *config->m_impl = *m_impl;
    return config;
}

void Config::validate() const
{
    if(getImpl()->m_validation == Impl::VALIDATION_PASSED) return;
    if(getImpl()->m_validation == Impl::VALIDATION_FAILED)
    {
        throw Exception(getImpl()->m_validationtext.c_str());
    }

    getImpl()->m_validation = Impl::VALIDATION_FAILED;
    getImpl()->m_validationtext = "";

    ///// PREDEFINED CONTEXT VARIABLES

    // Only the 'predefined' mode imposes to have all the context variables explicitely defined
    // in the config file. The 'all' mode exclusively relies on the environment variables.
    if (getMajorVersion() >= 2
        && getImpl()->m_context->getEnvironmentMode() == ENV_ENVIRONMENT_LOAD_PREDEFINED)
    {
        for (const auto & env : getImpl()->m_env)
        {
            const std::string ctxValue = env.second;

            if (ContainsContextVariables(ctxValue))
            {
                // When a context variable default value contains another context variable, the
                // only legal case is ENV = $ENV. It means that there is no default value i.e. an
                // system env. variable must exist.

                const std::string ctxVariable1 = std::string("$")  + env.first;
                const std::string ctxVariable2 = std::string("${") + env.first + std::string("}");
                const std::string ctxVariable3 = std::string("%")  + env.first + std::string("%");

                const bool isValid = (ctxVariable1 == ctxValue)
                                        || (ctxVariable2 == ctxValue)
                                        || (ctxVariable3 == ctxValue);

                if (!isValid)
                {
                    std::ostringstream oss;
                    oss << "Unresolved context variable in environment declaration '"
                        << env.first << " = "
                        << env.second << "'.";
                    throw Exception(oss.str().c_str());
                }
            }
        }
    }

    ///// COLORSPACES

    StringSet existingColorSpaces;

    bool hasDisplayReferredColorspace   = false;
    bool hasSceneReferredColorspace     = false;

    // Confirm all ColorSpaces are valid.
    for(int i=0; i<getImpl()->m_allColorSpaces->getNumColorSpaces(); ++i)
    {
        const auto cs = getImpl()->m_allColorSpaces->getColorSpaceByIndex(i);
        if (!cs)
        {
            std::ostringstream os;
            os << "Config failed color space validation. ";
            os << "The color space at index " << i << " is null.";
            getImpl()->m_validationtext = os.str();
            throw Exception(getImpl()->m_validationtext.c_str());
        }

        const char * name = cs->getName();
        // Name is not empty and unique (checked by addColorSpace ).

        // Retest that name does not contain reserved characters (vesion might have change).
        if (getMajorVersion() >= 2 && ContainsContextVariableToken(name))
        {
            std::ostringstream oss;
            oss << "Config failed color space validation. "
                << "A color space name '"
                << name
                << "' cannot contain a context variable reserved token i.e. % or $.";

            getImpl()->m_validationtext = oss.str();
            throw Exception(getImpl()->m_validationtext.c_str());
        }

        const size_t numAliases = cs->getNumAliases();
        if (numAliases && getMajorVersion() < 2)
        {
            std::ostringstream oss;
            oss << "Config failed color space validation. "
                << "Aliases may not be used in a v1 config.  Color space name: '" << name << "'.";

            getImpl()->m_validationtext = oss.str();
            throw Exception(getImpl()->m_validationtext.c_str());
        }

        // Make sure that all used interopIDs are available in this config.
        const char* interop = cs->getInteropID();
        if(interop && *interop)
        {
            if(!getColorSpace(interop))
            {
                std::ostringstream os;
                os << "Config failed color space validation. ";
                os << "The color space '" << name << "' ";
                os << "refers to an interop ID, '" << interop << "', ";
                os << "which is not a color space name or alias.";
                getImpl()->m_validationtext = os.str();
                throw Exception(getImpl()->m_validationtext.c_str());
            }
        }

        // AddColorSpace, addNamedTransform & setRole already check there is no name & alias
        // conflict.

        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 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)
        {
            // Retest in case version did change.
            if (getMajorVersion() >= 2 && ContainsContextVariableToken(iter->first))
            {
                std::ostringstream oss;
                oss << "Config failed role validation. "
                    << "A role name '"
                    << iter->first
                    << "' cannot contain a context variable reserved token i.e. % or $.";
                getImpl()->m_validationtext = oss.str();
                throw Exception(getImpl()->m_validationtext.c_str());
            }

            if(!getImpl()->hasColorSpace(iter->second.c_str()))
            {
                std::ostringstream os;
                os << "Config failed role validation. ";
                os << "The role '" << iter->first << "' ";
                os << "refers to a color space, '" << iter->second << "', ";
                os << "which is not defined.";
                getImpl()->m_validationtext = os.str();
                throw Exception(getImpl()->m_validationtext.c_str());
            }

            // AddColorSpace, addNamedTransform & setRole already check there is no name conflict.
        }


        // Check for interchange roles requirements - scene-referred and display-referred.
        unsigned int versionHex = (getMajorVersion() << 24) | (getMinorVersion() << 16);
        if (versionHex >= 0x02020000u)  // v2.2 or higher
        {
            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.
    const StringUtils::StringVec inactiveColorSpaceNames
        = getImpl()->buildInactiveNamesList(Impl::INACTIVE_ALL);

    for (const auto & name : inactiveColorSpaceNames)
    {
        if (!getImpl()->getColorSpace(name.c_str()))
        {
            if (!getImpl()->getNamedTransform(name.c_str()))
            {
                std::ostringstream os;
                os << "Inactive '" << name << "' is neither a color space nor a named transform.";
                LogInfo(os.str());
            }
        }
    }

    ///// DISPLAYS / VIEWS

    // Viewing rules.

     try
     {
         auto colorSpaceAccessor = std::bind(&Config::getColorSpace, this, std::placeholders::_1);
         getImpl()->m_viewingRules->getImpl()->validate(colorSpaceAccessor,
                                                           getImpl()->m_allColorSpaces);
     }
     catch (const Exception & e)
     {
         std::ostringstream os;
         os << "Config failed validation. Viewing rules failed validation with: ";
         os << e.what();
         getImpl()->m_validationtext = os.str();
         throw Exception(getImpl()->m_validationtext.c_str());
     }

    // Shared views.
    for (const auto & view : getImpl()->m_sharedViews)
    {
        getImpl()->validateView("", view, true);
    }

    int numdisplays = 0;

    // Confirm all Display transforms refer to colorspaces that exist.
    for(DisplayMap::const_iterator iter = getImpl()->m_displays.begin();
        iter != getImpl()->m_displays.end();
        ++iter)
    {
        const std::string display = iter->first;
        const ViewVec & views = iter->second.m_views;
        const StringUtils::StringVec & sharedViews = iter->second.m_sharedViews;
        if(views.empty() && sharedViews.empty())
        {
            std::ostringstream os;
            os << "Config failed display validation. ";
            os << "The display '" << display << "' ";
            os << "does not define any views.";
            getImpl()->m_validationtext = os.str();
            throw Exception(getImpl()->m_validationtext.c_str());
        }
        ++numdisplays;

        // Confirm shared view exist and do not conflict with views.
        for (const auto & sharedView : sharedViews)
        {
            getImpl()->validateSharedView(display, views, sharedView, true);
        }

        // Confirm view references exist.
        for(const auto & view : views)
        {
            getImpl()->validateView(display, view, true);
        }
    }

    // Confirm at least one display entry exists.
    if (numdisplays == 0)
    {
        std::ostringstream os;
        os << "Config failed display validation. ";
        os << "No displays are specified.";
        getImpl()->m_validationtext = os.str();
        throw Exception(getImpl()->m_validationtext.c_str());
    }


    ///// VIRTUAL DISPLAY.

    if (getMajorVersion() >= 2)
    {
        // Confirm shared view exist and do not conflict with views.
        for (const auto & sharedView : getImpl()->m_virtualDisplay.m_sharedViews)
        {
            // Bypass the <USE_DISPLAY_NAME> validation.
            getImpl()->validateSharedView("virtual_display",
                                          getImpl()->m_virtualDisplay.m_views,
                                          sharedView,
                                          false);
        }

        // Confirm view references exist.
        for(const auto & view : getImpl()->m_virtualDisplay.m_views)
        {
            // Bypass the <USE_DISPLAY_NAME> validation.
            getImpl()->validateView("virtual_display", view, false);
        }
    }


    ///// ACTIVE DISPLAYS & VIEWS

    StringUtils::StringVec displays;
    for (DisplayMap::const_iterator iter = getImpl()->m_displays.begin();
         iter != getImpl()->m_displays.end();
         ++iter)
    {
        displays.push_back(iter->first);
    }


    if (!getImpl()->m_activeDisplaysEnvOverride.empty())
    {
        const bool useAllDisplays
            = getImpl()->m_activeDisplaysEnvOverride.size()==1
                && getImpl()->m_activeDisplaysEnvOverride[0] == "";

        if (!useAllDisplays)
        {
            const StringUtils::StringVec orderedDisplays
                = IntersectStringVecsCaseIgnore(getImpl()->m_activeDisplaysEnvOverride, displays);
            if (orderedDisplays.empty())
            {
                std::ostringstream os;
                os << "The content of the env. variable for the list of active displays ["
                   << JoinStringEnvStyle(getImpl()->m_activeDisplaysEnvOverride)
                   << "] is invalid.";
                getImpl()->m_validationtext = os.str();
                throw Exception(getImpl()->m_validationtext.c_str());
            }
            if (orderedDisplays.size()!=getImpl()->m_activeDisplaysEnvOverride.size())
            {
                std::ostringstream os;
                os << "The content of the env. variable for the list of active displays ["
                   << JoinStringEnvStyle(getImpl()->m_activeDisplaysEnvOverride)
                   << "] contains invalid display name(s).";
                getImpl()->m_validationtext = os.str();
                throw Exception(getImpl()->m_validationtext.c_str());
            }
        }
    }
    else if (!getImpl()->m_activeDisplays.empty())
    {
        const bool useAllDisplays = getImpl()->m_activeDisplays.size() == 1 &&
                                    getImpl()->m_activeDisplays[0] == "";

        if (!useAllDisplays)
        {
            const StringUtils::StringVec orderedDisplays
                = IntersectStringVecsCaseIgnore(getImpl()->m_activeDisplays, displays);
            if (orderedDisplays.empty())
            {
                std::ostringstream os;
                os << "The list of active displays ["
                   << JoinStringEnvStyle(getImpl()->m_activeDisplays)
                   << "] from the config file is invalid.";
                getImpl()->m_validationtext = os.str();
                throw Exception(getImpl()->m_validationtext.c_str());
            }
            if (orderedDisplays.size()!=getImpl()->m_activeDisplays.size())
            {
                std::ostringstream os;
                os << "The list of active displays ["
                   << JoinStringEnvStyle(getImpl()->m_activeDisplays)
                   << "] from the config file contains invalid display name(s).";
                getImpl()->m_validationtext = os.str();
                throw Exception(getImpl()->m_validationtext.c_str());
            }
        }
    }

    // TODO: Add validation for active views.


    ///// TRANSFORMS


    // Confirm for all transforms that reference internal color spaces,
    // the named color space exists and that all transforms are valid.
    {
        ConstTransformVec allTransforms;
        getImpl()->getAllInternalTransforms(allTransforms);

        ConstContextRcPtr context = getCurrentContext();

        std::set<std::string> colorSpaceNames;
        for (const auto & transform : allTransforms)
        {
            transform->validate();
            GetColorSpaceReferences(colorSpaceNames, transform, context);
        }

        for (const auto & name : colorSpaceNames)
        {
            // Check to see if the name is a color space.
            if (!getImpl()->hasColorSpace(name.c_str()))
            {
                // As a role name forbids the use of context variable keywords and
                // GetColorSpaceReferences() should expand context variables, throw if a context
                // variable keyword is still present.
                if (ContainsContextVariables(name.c_str()))
                {
                    std::ostringstream oss;
                    oss << "Config failed transform validation. "
                        << "This config references a color space '"
                        << name << "' using an unknown context variable.";

                    getImpl()->m_validationtext = oss.str();
                    throw Exception(getImpl()->m_validationtext.c_str());
                }

                // Check to see if the name is a role.
                const char * csname = LookupRole(getImpl()->m_roles, name);

                std::ostringstream os;
                os << "Config failed transform validation. ";
                os << "This config references a color space, '";

                if (!csname || !*csname)
                {
                    // It's not a role, check to see if it's a named transform.
                    if (!getImpl()->getNamedTransform(name.c_str()))
                    {
                        // It's not a color space, a role, or a named transform.
                        os << name << "', which is not defined.";
                        getImpl()->m_validationtext = os.str();
                        throw Exception(getImpl()->m_validationtext.c_str());
                    }
                }
                else if(!getImpl()->hasColorSpace(csname))
                {
                    // It's a role, but the color space it points to doesn't exist.
                    os << csname << "' (for role '" << name << "'), which is not defined.";
                    getImpl()->m_validationtext = os.str();
                    throw Exception(getImpl()->m_validationtext.c_str());
                }
            }
        }
    }

    ///// LOOKS

    // For all looks, confirm the process space exists and the look is named.
    for(unsigned int i=0; i<getImpl()->m_looksList.size(); ++i)
    {
        const char * lookName = getImpl()->m_looksList[i]->getName();
        if (!lookName || !*lookName)
        {
            std::ostringstream os;
            os << "Config failed Look validation. ";
            os << "The look at index '" << i << "' ";
            os << "does not specify a name.";
            getImpl()->m_validationtext = os.str();
            throw Exception(getImpl()->m_validationtext.c_str());
        }

        const char * processSpace = getImpl()->m_looksList[i]->getProcessSpace();
        if (!processSpace || !*processSpace)
        {
            std::ostringstream os;
            os << "Config failed Look validation. ";
            os << "The look '" << lookName << "' ";
            os << "does not specify a process space.";
            getImpl()->m_validationtext = os.str();
            throw Exception(getImpl()->m_validationtext.c_str());
        }

        if (!getImpl()->hasColorSpace(processSpace))
        {
            // Check to see if the processSpace is a role.
            const char * csname = LookupRole(getImpl()->m_roles, processSpace);

            std::ostringstream os;
            os << "Config failed Look validation. ";
            os << "The look '" << lookName << "' ";
            os << "specifies a process color space, '";

            if (!csname || !*csname)
            {
                os << processSpace << "', which is not defined.";
                getImpl()->m_validationtext = os.str();
                throw Exception(getImpl()->m_validationtext.c_str());
            }
            else if (!getImpl()->hasColorSpace(csname))
            {
                os << csname << "' (for role '" << processSpace << "'), which is not defined.";
                getImpl()->m_validationtext = os.str();
                throw Exception(getImpl()->m_validationtext.c_str());
            }
        }
    }

    ///// ViewTransforms

    if (!getImpl()->m_viewTransforms.empty())
    {
        // Note: Config::addViewTransform validates that view_transforms have a unique, non-empty
        // name and define a transform.

        auto fromScene = getDefaultSceneToDisplayViewTransform();
        // If there are view transforms, there must be one from the scene reference space.
        if (!fromScene)
        {
            getImpl()->m_validationtext = "Config failed validation. If there are view_transforms, "
                                      "at least one must use the scene reference space.";
            throw Exception(getImpl()->m_validationtext.c_str());
        }
    }
    else if (hasDisplayReferredColorspace)
    {
        getImpl()->m_validationtext = "Config failed validation. If there are display-referred "
                                  "color spaces, there must be view_transforms.";
        throw Exception(getImpl()->m_validationtext.c_str());
    }

    if (!getImpl()->m_defaultViewTransform.empty())
    {
        const auto vt = getDefaultSceneToDisplayViewTransform();
        if (!vt || !StringUtils::Compare(vt->getName(), getImpl()->m_defaultViewTransform))
        {
            std::ostringstream os;
            os << "Config failed validation. Default view transform is defined as: '";
            os << getImpl()->m_defaultViewTransform << "' but this does not correspond to ";
            os << "an existing scene-referred view transform.";
            getImpl()->m_validationtext = os.str();
            throw Exception(getImpl()->m_validationtext.c_str());
        }
    }

    ///// FileRules

    try
    {
        getImpl()->m_fileRules->getImpl()->validate(*this);
    }
    catch (const Exception & e)
    {
        std::ostringstream os;
        os << "Config failed validation. File rules failed with: ";
        os << e.what();
        getImpl()->m_validationtext = os.str();
        throw Exception(getImpl()->m_validationtext.c_str());
    }

    ///// Resolve all file Transforms using context variables.

    {
        ConstTransformVec allTransforms;
        getImpl()->getAllInternalTransforms(allTransforms);

        std::set<std::string> files;
        for (const auto & transform : allTransforms)
        {
            GetFileReferences(files, transform);
        }

        // Check that at least one of the search paths can be resolved into a valid path.
        // Note that a search path without context variable(s) always correctly resolves.

        if (!files.empty())
        {
            bool foundOne = false;
            std::string errMsg("Config failed search path validation.");

            for (int idx = 0; idx < getImpl()->m_context->getNumSearchPaths(); ++idx)
            {
                const char * path = getImpl()->m_context->getSearchPath(idx);
                if (!path || !*path)
                {
                    errMsg += " The search_path must not be an empty string if there are FileTransforms.";
                    continue;
                }

                const std::string resolvedSearchPath = getImpl()->m_context->resolveStringVar(path);
                if (ContainsContextVariables(resolvedSearchPath))
                {
                    std::ostringstream oss;

                    oss << "  The search_path '" << path << "' cannot be resolved";

                    if (path != resolvedSearchPath)
                    {
                        // Adjust the error message when the search_path is defined with
                        // some context variable(s).
                        oss << " by '" << resolvedSearchPath << "'";
                    }

                    oss << ".";
                    errMsg += oss.str();
                    continue;
                }

                foundOne = true;
            }

            // After looping over all the search paths, none of them can be successfully resolved.
            if (!foundOne)
            {
                if (getImpl()->m_context->getNumSearchPaths() == 0)
                {
                    errMsg += " The search_path must not be empty if there are FileTransforms.";
                }
                getImpl()->m_validationtext = errMsg;
                throw Exception(errMsg.c_str());
            }
        }

        // Expand all file transform paths.

        for (const auto & file : files)
        {
            // Resolve the file name without testing if it exists (which could add an unnecessary
            // performance hit).
            const std::string resolvedFile = getImpl()->m_context->resolveStringVar(file.c_str());
            if (resolvedFile.empty() || ContainsContextVariables(resolvedFile))
            {
                std::ostringstream oss;
                oss << "Config failed validation expanding file transform paths. ";
                oss << "The file transform source cannot be resolved: '";
                
                if (file != resolvedFile)
                {
                    oss << file << "' vs. '" << resolvedFile << "'.";
                }
                else
                {
                    oss << file << "'.";
                }

                getImpl()->m_validationtext = oss.str();

                throw Exception(oss.str().c_str());
            }
        }
    }

    ///// NamedTransforms

    // As Config::addNamedTransform() already validates some properties of the instance
    // (i.e. name is not null, at least forward or inverse transform exits, etc.), the code below
    // only has to validate name conflicts. The NamedTransform name can not use a role,
    // a color space, a look, or a view transform name.  All transforms are validated above.

    for (const auto & nt : getImpl()->m_allNamedTransforms)
    {
        const char * name = nt->getName();

        if (getLook(name))
        {
            std::ostringstream os;
            os << "Config failed validation. NamedTransform can't be named '";
            os << std::string(name) << "'. This name is already used for a look.";
            getImpl()->m_validationtext = os.str();
            throw Exception(getImpl()->m_validationtext.c_str());
        }
        if (getViewTransform(name))
        {
            std::ostringstream os;
            os << "Config failed validation. NamedTransform can't be named '";
            os << std::string(name);
            os << "'. This name is already used for a view transform.";
            getImpl()->m_validationtext = os.str();
            throw Exception(getImpl()->m_validationtext.c_str());
        }

        // AddColorSpace, addNamedTransform & setRole already check there is no name & alias
        // conflict.
    }

    ///// Check new features are not used with older config versions.

    getImpl()->checkVersionConsistency();


    // Everything is groovy.
    getImpl()->m_validation = Impl::VALIDATION_PASSED;
}

///////////////////////////////////////////////////////////////////////////

const char * Config::getName() const noexcept
{
    return getImpl()->m_name.c_str();
}

void Config::setName(const char * name) noexcept
{
    getImpl()->m_name = (name ? name : "");
}

///////////////////////////////////////////////////////////////////////////

char Config::getFamilySeparator() const
{
    return getImpl()->m_familySeparator;
}

char Config::GetDefaultFamilySeparator() noexcept
{
    return Impl::DefaultFamilySeparator;
}

void Config::setFamilySeparator(char separator)
{
    const int val = (int)separator;
    if (val!=0 && (val<32 || val>126))
    {
        std::string err("Invalid family separator '");
        err += separator;
        err += "'.";

        throw Exception(err.c_str());
    }

    getImpl()->m_familySeparator = separator;
}

///////////////////////////////////////////////////////////////////////////

const char * Config::getDescription() const
{
    return getImpl()->m_description.c_str();
}

void Config::setDescription(const char * description)
{
    getImpl()->m_description = (description ? description : "");
}

// RESOURCES //////////////////////////////////////////////////////////////

ConstContextRcPtr Config::getCurrentContext() const
{
    return getImpl()->m_context;
}

void Config::addEnvironmentVar(const char * name, const char * defaultValue)
{
    if (!name || !*name)
    {
        return;
    }

    // Note: Only a null default value removes the entry.

    if (defaultValue)
    {
        getImpl()->m_env[std::string(name)] = std::string(defaultValue);
        getImpl()->m_context->setStringVar(name, defaultValue);
    }
    else
    {
        StringMap::const_iterator iter = getImpl()->m_env.find(std::string(name));
        if(iter != getImpl()->m_env.end()) getImpl()->m_env.erase(iter);
        getImpl()->m_context->setStringVar(name, nullptr);
    }

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

int Config::getNumEnvironmentVars() const
{
    return static_cast<int>(getImpl()->m_env.size());
}

const char * Config::getEnvironmentVarNameByIndex(int index) const
{
    if(index < 0 || index >= (int)getImpl()->m_env.size()) return "";
    StringMap::const_iterator iter = getImpl()->m_env.begin();
    for(int i = 0; i < index; ++i) ++iter;
    return iter->first.c_str();
}

const char * Config::getEnvironmentVarDefault(const char * name) const
{
    if (!name || !*name) return "";
    return LookupEnvironment(getImpl()->m_env, name);
}

void Config::clearEnvironmentVars()
{
    getImpl()->m_env.clear();
    getImpl()->m_context->clearStringVars();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

void Config::setEnvironmentMode(EnvironmentMode mode) noexcept
{
    getImpl()->m_context->setEnvironmentMode(mode);

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

EnvironmentMode Config::getEnvironmentMode() const noexcept
{
    return getImpl()->m_context->getEnvironmentMode();
}

void Config::loadEnvironment() noexcept
{
    getImpl()->m_context->loadEnvironment();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

const char * Config::getSearchPath() const
{
    return getImpl()->m_context->getSearchPath();
}

void Config::setSearchPath(const char * path)
{
    getImpl()->m_context->setSearchPath(path ? path : "");

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

int Config::getNumSearchPaths() const
{
    return getImpl()->m_context->getNumSearchPaths();
}

const char * Config::getSearchPath(int index) const
{
    return getImpl()->m_context->getSearchPath(index);
}

void Config::clearSearchPaths()
{
    getImpl()->m_context->clearSearchPaths();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

void Config::addSearchPath(const char * path)
{
    if (!path || !*path) return;
    getImpl()->m_context->addSearchPath(path);

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

const char * Config::getWorkingDir() const
{
    return getImpl()->m_context->getWorkingDir();
}

void Config::setWorkingDir(const char * dirname)
{
    getImpl()->m_context->setWorkingDir(dirname ? dirname : "");

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}


///////////////////////////////////////////////////////////////////////////

ColorSpaceSetRcPtr Config::getColorSpaces(const char * category) const
{
    ColorSpaceSetRcPtr res = ColorSpaceSet::Create();

    // Loop on the list of active color spaces.

    for(int idx=0; idx<getNumColorSpaces(); ++idx)
    {
        const char * csName = getColorSpaceNameByIndex(idx);
        ConstColorSpaceRcPtr cs = getImpl()->m_allColorSpaces->getColorSpace(csName);
        if(!category || !*category || cs->hasCategory(category))
        {
            res->addColorSpace(cs);
        }
    }

    return res;
}

namespace
{
bool MatchReferenceType(SearchReferenceSpaceType st, ReferenceSpaceType t)
{
    switch (st)
    {
    case SEARCH_REFERENCE_SPACE_SCENE:
        return t == REFERENCE_SPACE_SCENE;
    case SEARCH_REFERENCE_SPACE_DISPLAY:
        return t == REFERENCE_SPACE_DISPLAY;
    case SEARCH_REFERENCE_SPACE_ALL:
        return true;
    }
    return false;
}
}

int Config::getNumColorSpaces(SearchReferenceSpaceType searchReferenceType,
                              ColorSpaceVisibility visibility) const
{
    int res = 0;
    switch (visibility)
    {
    case COLORSPACE_ALL:
    {
        const int nbCS = getImpl()->m_allColorSpaces->getNumColorSpaces();
        if (searchReferenceType == SEARCH_REFERENCE_SPACE_ALL)
        {
            return nbCS;
        }
        for (int i = 0; i < nbCS; ++i)
        {
            auto cs = getImpl()->m_allColorSpaces->getColorSpaceByIndex(i);
            if (MatchReferenceType(searchReferenceType, cs->getReferenceSpaceType()))
            {
                ++res;
            }
        }
        break;
    }
    case COLORSPACE_ACTIVE:
    {
        const size_t nbCS = getImpl()->m_activeColorSpaceNames.size();
        if (searchReferenceType == SEARCH_REFERENCE_SPACE_ALL)
        {
            return (int)nbCS;
        }
        for (auto csname : getImpl()->m_activeColorSpaceNames)
        {
            auto cs = getColorSpace(csname.c_str());
            if (MatchReferenceType(searchReferenceType, cs->getReferenceSpaceType()))
            {
                ++res;
            }
        }
        break;
    }
    case COLORSPACE_INACTIVE:
    {
        const auto ics = getImpl()->m_inactiveColorSpaceNames.size();
        if (searchReferenceType == SEARCH_REFERENCE_SPACE_ALL)
        {
            return (int)ics;
        }
        for (auto csname : getImpl()->m_inactiveColorSpaceNames)
        {
            auto cs = getColorSpace(csname.c_str());
            if (MatchReferenceType(searchReferenceType, cs->getReferenceSpaceType()))
            {
                ++res;
            }
        }
        break;
    }
    }

    return res;
}

const char * Config::getColorSpaceNameByIndex(SearchReferenceSpaceType searchReferenceType,
                                              ColorSpaceVisibility visibility, int index) const
{
    if (index < 0)
    {
        return "";
    }

    int current = 0;
    switch (visibility)
    {
    case COLORSPACE_ALL:
    {
        if (searchReferenceType == SEARCH_REFERENCE_SPACE_ALL)
        {
            if (index < getImpl()->m_allColorSpaces->getNumColorSpaces())
            {
                return getImpl()->m_allColorSpaces->getColorSpaceNameByIndex(index);
            }
            else
            {
                return "";
            }
        }
        const int nbCS = getImpl()->m_allColorSpaces->getNumColorSpaces();
        for (int i = 0; i < nbCS; ++i)
        {
            auto cs = getImpl()->m_allColorSpaces->getColorSpaceByIndex(i);
            if (MatchReferenceType(searchReferenceType, cs->getReferenceSpaceType()))
            {
                if (current == index)
                {
                    return cs->getName();
                }
                ++current;
            }
        }
        break;
    }
    case COLORSPACE_ACTIVE:
    {
        if (searchReferenceType == SEARCH_REFERENCE_SPACE_ALL)
        {
            if (index < (int)getImpl()->m_activeColorSpaceNames.size())
            {
                return getImpl()->m_activeColorSpaceNames[index].c_str();
            }
            else
            {
                return "";
            }
        }
        const int nbCS = (int)getImpl()->m_activeColorSpaceNames.size();
        for (int i = 0; i < nbCS; ++i)
        {
            auto csname = getImpl()->m_activeColorSpaceNames[i];
            auto cs = getColorSpace(csname.c_str());
            if (MatchReferenceType(searchReferenceType, cs->getReferenceSpaceType()))
            {
                if (current == index)
                {
                    return cs->getName();
                }
                ++current;
            }
        }
        break;
    }
    case COLORSPACE_INACTIVE:
    {
        if (searchReferenceType == SEARCH_REFERENCE_SPACE_ALL)
        {
            if (index < (int)getImpl()->m_inactiveColorSpaceNames.size())
            {
                return getImpl()->m_inactiveColorSpaceNames[index].c_str();
            }
            else
            {
                return "";
            }
        }
        const int nbCS = (int)getImpl()->m_inactiveColorSpaceNames.size();
        for (int i = 0; i < nbCS; ++i)
        {
            auto csname = getImpl()->m_inactiveColorSpaceNames[i];
            auto cs = getColorSpace(csname.c_str());
            if (MatchReferenceType(searchReferenceType, cs->getReferenceSpaceType()))
            {
                if (current == index)
                {
                    return cs->getName();
                }
                ++current;
            }
        }
        break;
    }
    }

    return "";
}

// Note: works from the list of all color spaces.
ConstColorSpaceRcPtr Config::getColorSpace(const char * name) const
{
    return getImpl()->getColorSpace(name);
}

const char * Config::getCanonicalName(const char * name) const
{
    ConstColorSpaceRcPtr cs = getColorSpace(name);
    if (cs)
    {
        return cs->getName();
    }
    ConstNamedTransformRcPtr nt = getNamedTransform(name);
    if (nt)
    {
        return nt->getName();
    }
    return "";
}

int Config::getNumColorSpaces() const
{
    return getNumColorSpaces(SEARCH_REFERENCE_SPACE_ALL, COLORSPACE_ACTIVE);
}

const char * Config::getColorSpaceNameByIndex(int index) const
{
    return getColorSpaceNameByIndex(SEARCH_REFERENCE_SPACE_ALL, COLORSPACE_ACTIVE, index);
}

int Config::getIndexForColorSpace(const char * name) const
{
    ConstColorSpaceRcPtr cs = getColorSpace(name);
    if (!cs)
    {
        return -1;
    }

    // Check to see if the name is an active color space.
    for (int idx = 0; idx < getNumColorSpaces(SEARCH_REFERENCE_SPACE_ALL,
                                              COLORSPACE_ACTIVE); ++idx)
    {
        if (strcmp(getColorSpaceNameByIndex(SEARCH_REFERENCE_SPACE_ALL, COLORSPACE_ACTIVE, idx),
                   cs->getName()) == 0)
        {
            return idx;
        }
    }

    // Requests for an inactive color space or a role mapping
    // to an inactive color space will both fail.
    return -1;
}

void Config::setInactiveColorSpaces(const char * inactiveColorSpaces)
{
    getImpl()->setInactiveColorSpaces(inactiveColorSpaces);
}

const char * Config::getInactiveColorSpaces() const
{
    return getImpl()->m_inactiveColorSpaceNamesConf.c_str();
}

bool Config::isInactiveColorSpace(const char * colorspace) const noexcept
{
    StringUtils::StringVec svec;
    pystring::split(getImpl()->m_inactiveColorSpaceNamesConf.c_str(), svec, ", ");

    for (size_t i = 0; i < svec.size(); i++)
    {
        if (StringUtils::Compare(colorspace, svec.at(i)))
        {
            // Colorspace is inactive.
            return true;
        }
    }
    return false;
}

void Config::addColorSpace(const ConstColorSpaceRcPtr & original)
{
    const std::string name(original->getName());
    if (name.empty())
    {
        throw Exception("Color space must have a non-empty name.");
    }

    // Check this is not an existing role or named transform.
    if (hasRole(name.c_str()))
    {
        std::ostringstream os;
        os << "Cannot add '" << name << "' color space, there is already a role with this "
              "name.";
        throw Exception(os.str().c_str());
    }
    auto nt = getNamedTransform(name.c_str());
    if (nt)
    {
        std::ostringstream os;
        os << "Cannot add '" << name << "' color space, there is already a named transform using "
            "this name as a name or as an alias: '" << nt->getName() << "'.";
        throw Exception(os.str().c_str());
    }

    if (getMajorVersion() >= 2 && ContainsContextVariableToken(name))
    {
        std::ostringstream oss;
        oss << "A color space name '" << name
            << "' cannot contain a context variable reserved token i.e. % or $.";

        throw Exception(oss.str().c_str());
    }

    const size_t numAliases = original->getNumAliases();
    for (size_t aidx = 0; aidx < numAliases; ++aidx)
    {
        const char * alias = original->getAlias(aidx);

        if (hasRole(alias))
        {
            std::ostringstream os;
            os << "Cannot add '" << name << "' color space, it has an alias '" << alias
               << "' and there is already a role with this name.";
            throw Exception(os.str().c_str());
        }
        auto nt = getNamedTransform(alias);
        if (nt)
        {
            std::ostringstream os;
            os << "Cannot add '" << name << "' color space, it has an alias '" << alias
               << "' and there is already a named transform using this name as a name or as "
                  "an alias: '" << nt->getName() << "'.";
            throw Exception(os.str().c_str());
        }
        if (ContainsContextVariableToken(alias))
        {
            std::ostringstream os;
            os << "Cannot add '" << name << "' color space, it has an alias '" << alias
                << "' that cannot contain a context variable reserved token i.e. % or $.";

            throw Exception(os.str().c_str());
        }
    }

    // This is verifying that name and aliases are fine with other color spaces.
    getImpl()->m_allColorSpaces->addColorSpace(original);

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
    getImpl()->refreshActiveColorSpaces();
}

void Config::removeColorSpace(const char * name)
{
    getImpl()->m_allColorSpaces->removeColorSpace(name);

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
    getImpl()->refreshActiveColorSpaces();
}

bool Config::isColorSpaceUsed(const char * name) const noexcept
{
    // Check if a color space is used somewhere in the config other than where it is defined,
    // for example, in a display/view, look, or ColorSpaceTransform.  If the color space is
    // defined in the config, but not used elsewhere, this function returns false.

    if (!name || !*name) return false;

    // Check for all color spaces, looks and view transforms.

    ConstTransformVec allTransforms;
    getImpl()->getAllInternalTransforms(allTransforms);

    std::set<std::string> colorSpaceNames;
    for (const auto & transform : allTransforms)
    {
        ConstContextRcPtr context = getCurrentContext();
        GetColorSpaceReferences(colorSpaceNames, transform, context);
    }

    for (const auto & csName : colorSpaceNames)
    {
        if (0 == Platform::Strcasecmp(name, csName.c_str()))
        {
            return true;
        }
    }

    // Check for roles.

    const int numRoles = getNumRoles();
    for (int idx = 0; idx < numRoles; ++idx)
    {
        const char * roleName = getRoleName(idx);
        const char * csName = LookupRole(getImpl()->m_roles, roleName);
        if (0 == Platform::Strcasecmp(csName, name))
        {
            return true;
        }
    }

    // Check for all shared views.

    for (const auto & view : getImpl()->m_sharedViews)
    {
        const char * csName = view.m_colorspace.c_str();
        if (0 == Platform::Strcasecmp(csName, name))
        {
            return true;
        }
    }

    // Check for all (display, view) pairs (i.e. active and inactive ones).

    for (const auto & display : getImpl()->m_displays)
    {
        const char * dispName = display.first.c_str();
        for (const auto & view : display.second.m_views)
        {
            const char * viewName = view.m_name.c_str();
            const char * csName = getDisplayViewColorSpaceName(dispName, viewName);
            if (0 == Platform::Strcasecmp(csName, name))
            {
                return true;
            }
        }
        for (const auto & sharedView : display.second.m_sharedViews)
        {
            auto viewIt = FindView(getImpl()->m_sharedViews, sharedView);
            if (viewIt != getImpl()->m_sharedViews.end())
            {
                if (!((*viewIt).m_viewTransform.empty()) &&
                    (*viewIt).useDisplayNameForColorspace())
                {
                    if (0 == Platform::Strcasecmp(dispName, name))
                    {
                        return true;
                    }
                }
            }
        }
    }

    // Check for 'process_space' from look.

    const int numLooks = getNumLooks();
    for (int idx = 0; idx < numLooks; ++idx)
    {
        const char * lookName = getLookNameByIndex(idx);

        ConstLookRcPtr l = getLook(lookName);
        if (0 == Platform::Strcasecmp(l->getProcessSpace(), name))
        {
            return true;
        }
    }

    // Check the file rules.

    ConstFileRulesRcPtr rules = getFileRules();

    const size_t numRules = rules->getNumEntries();
    for (size_t idx = 0; idx < numRules; ++idx)
    {
        const char * csName = rules->getColorSpace(idx);
        if (0 == Platform::Strcasecmp(csName, name))
        {
            return true;
        }
    }

    return false;
}

void Config::clearColorSpaces()
{
    getImpl()->m_allColorSpaces->clearColorSpaces();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
    getImpl()->refreshActiveColorSpaces();
}

///////////////////////////////////////////////////////////////////////////

bool Config::isColorSpaceLinear(const char * colorSpace, ReferenceSpaceType referenceSpaceType) const
{
    auto cs = getColorSpace(colorSpace);

    if (cs == nullptr)
    {
        std::ostringstream os;
        os << "Could not test colorspace linearity. Colorspace " << colorSpace << " does not exist.";
        throw Exception(os.str().c_str()); 
    }

    if (cs->isData())
    {
        return false;
    }

    // Colorspace is not linear if the types are opposite.
    if (cs->getReferenceSpaceType() != referenceSpaceType)
    {
        return false;
    }

    std::string encoding = cs->getEncoding();
    if (!encoding.empty())
    {
        // Check the encoding value if it is set.        
        if ((StringUtils::Compare(cs->getEncoding(), "scene-linear") && 
            referenceSpaceType == REFERENCE_SPACE_SCENE) || 
            (StringUtils::Compare(cs->getEncoding(), "display-linear") && 
            referenceSpaceType == REFERENCE_SPACE_DISPLAY))
        {
            return true;
        }
        else
        {
            return false;
        }
    }

    // We want to assess linearity over at least a reasonable range of values, so use a very dark 
    // value and a very bright value. Test neutral, red, green, and blue points to detect situations 
    // where the neutral may be linear but there is non-linearity off the neutral axis.
    auto evaluate = [](const Config & config, ConstTransformRcPtr &t) -> bool
    {
        std::vector<float> img = 
        { 
            0.0625f, 0.0625f, 0.0625f, 4.f, 4.f, 4.f,
            0.0625f, 0.f, 0.f, 4.f, 0.f, 0.f,
            0.f, 0.0625f, 0.f, 0.f, 4.f, 0.f,
            0.f, 0.f, 0.0625f, 0.f, 0.f, 4.f
        };
        std::vector<float> dst(img.size(), 0.f);

        PackedImageDesc desc(&img[0], 8, 1, CHANNEL_ORDERING_RGB);
        PackedImageDesc descDst(&dst[0], 8, 1, CHANNEL_ORDERING_RGB);

        auto procToReference = config.getImpl()->getProcessorWithoutCaching(
            config, t, TRANSFORM_DIR_FORWARD
        );

        // TODO: It could be useful to try and avoid evaluating points through ops that are
        // expensive but highly unlikely to be linear (with inverse Lut3D being the prime example).
        // There are some heuristics that are used in ConfigUtils.cpp that are intended to filter
        // out color spaces from consideration before a processor is even calculated.  However,
        // those are not entirely appropriate here since one could imagine wanting to know if a
        // color space involving a FileTransform (an ASC CDL being a good example) is linear.
        // Likewise, one might want to know whether a color space involving a Look or ColorSpace
        // Transform is linear (both of those are filtered out by the ConfigUtils heuristics).
        // It seems like the right approach here is to go ahead and build the processor and
        // thereby convert File/Look/ColorSpace Transforms into ops.  But currently there is
        // no method on the Processor class to know if it contains a Lut3D.  There is the
        // ProcessorMetadata files list, though that is not as precise.  For example, it would
        // not say if a CLF or CTF file contains a Lut3D or just a matrix.  Probably the best
        // solution would be to have each op sub-class provide an isLinear method and then
        // surface that on the Processor class, iterating over each op in the Processor.

        auto optCPUProc = procToReference->getOptimizedCPUProcessor(OPTIMIZATION_NONE);
        optCPUProc->apply(desc, descDst);

        float absError      = 1e-5f;
        float multiplier    = 64.f;
        bool ret            = true;

        // Test the first RGB pair.
        ret &= EqualWithAbsError(dst[0]*multiplier, dst[3], absError);
        ret &= EqualWithAbsError(dst[1]*multiplier, dst[4], absError);
        ret &= EqualWithAbsError(dst[2]*multiplier, dst[5], absError);

        // Test the second RGB pair.
        ret &= EqualWithAbsError(dst[6]*multiplier, dst[9], absError);
        ret &= EqualWithAbsError(dst[7]*multiplier, dst[10], absError);
        ret &= EqualWithAbsError(dst[8]*multiplier, dst[11], absError);

        // Test the third RGB pair.
        ret &= EqualWithAbsError(dst[12]*multiplier, dst[15], absError);
        ret &= EqualWithAbsError(dst[13]*multiplier, dst[16], absError);
        ret &= EqualWithAbsError(dst[14]*multiplier, dst[17], absError);

        // Test the fourth RGB pair.
        ret &= EqualWithAbsError(dst[18]*multiplier, dst[21], absError);
        ret &= EqualWithAbsError(dst[19]*multiplier, dst[22], absError);
        ret &= EqualWithAbsError(dst[20]*multiplier, dst[23], absError);

        return ret;
    };
    
    ConstTransformRcPtr transformToReference = cs->getTransform(COLORSPACE_DIR_TO_REFERENCE);
    ConstTransformRcPtr transformFromReference = cs->getTransform(COLORSPACE_DIR_FROM_REFERENCE);
    if ((transformToReference && transformFromReference) || transformToReference)
    {
        // Color space has a transform for the to-reference direction, or both directions.
        return evaluate(*this, transformToReference);
    }
    else if (transformFromReference)
    {
        // Color space only has a transform for the from-reference direction.
        return evaluate(*this, transformFromReference);
    }

    // Color space matches the desired reference space type, is not a data space, and has no 
    // transforms, so it is equivalent to the reference space and hence linear.
    return true;
}

void Config::IdentifyInterchangeSpace(const char ** srcInterchange,
                                      const char ** builtinInterchange,
                                      const ConstConfigRcPtr & srcConfig,
                                      const char * srcColorSpaceName,
                                      const ConstConfigRcPtr & builtinConfig,
                                      const char * builtinColorSpaceName)
{
    // This will throw if it is unable to identify the interchange spaces.
    ConfigUtils::IdentifyInterchangeSpace(srcInterchange, 
                                          builtinInterchange, 
                                          srcConfig, 
                                          srcColorSpaceName, 
                                          builtinConfig,
                                          builtinColorSpaceName);
}

const char * Config::IdentifyBuiltinColorSpace(const ConstConfigRcPtr & srcConfig,
                                               const ConstConfigRcPtr & builtinConfig,
                                               const char * builtinColorSpaceName)
{
    // This will throw if it is unable to identify the interchange spaces.
    return ConfigUtils::IdentifyBuiltinColorSpace(srcConfig,
                                                  builtinConfig,
                                                  builtinColorSpaceName);
}

///////////////////////////////////////////////////////////////////////////

const char * Config::parseColorSpaceFromString(const char * str) const
{
    int rightMostColorSpaceIndex = ParseColorSpaceFromString(*this, str);

    // Index is using all color spaces.
    if(rightMostColorSpaceIndex>=0)
    {
        return getImpl()->m_allColorSpaces->getColorSpaceNameByIndex(rightMostColorSpaceIndex);
    }

    if(!getImpl()->m_strictParsing)
    {
        // Is a default role defined?
        const char* csname = LookupRole(getImpl()->m_roles, ROLE_DEFAULT);
        if(csname && *csname)
        {
            const int csindex = getImpl()->getColorSpaceIndex(csname);
            if (-1 != csindex)
            {
                // This is necessary to not return a reference to a local variable.
                return getImpl()->m_allColorSpaces->getColorSpaceNameByIndex(csindex);
            }
        }
    }

    return "";
}

bool Config::isStrictParsingEnabled() const
{
    return getImpl()->m_strictParsing;
}

void Config::setStrictParsingEnabled(bool enabled)
{
    getImpl()->m_strictParsing = enabled;

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

// Roles
void Config::setRole(const char * role, const char * colorSpaceName)
{
    if (!role || !*role)
    {
        throw Exception("The role name is null.");
    }

    // Set the role.
    if (colorSpaceName)
    {
        if (!hasRole(role))
        {
            if (getColorSpace(role))
            {
                std::ostringstream os;
                os << "Cannot add '" << role << "' role, there is already a color space using this "
                    "as a name or an alias.";
                throw Exception(os.str().c_str());
            }
            if (getNamedTransform(role))
            {
                std::ostringstream os;
                os << "Cannot add '" << role << "' role, there is already a named transform using "
                    "this as a name or an alias.";
                throw Exception(os.str().c_str());
            }
            if (getMajorVersion() >= 2 && ContainsContextVariableToken(role))
            {
                std::ostringstream os;
                os << "Role name '" << role
                   << "' cannot contain a context variable reserved token i.e. % or $.";
                throw Exception(os.str().c_str());
            }

        }
        getImpl()->m_roles[StringUtils::Lower(role)] = std::string(colorSpaceName);
    }
    // Unset the role.
    else
    {
        StringMap::iterator iter = getImpl()->m_roles.find(StringUtils::Lower(role));
        if(iter != getImpl()->m_roles.end())
        {
            getImpl()->m_roles.erase(iter);
        }
    }

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

int Config::getNumRoles() const
{
    return static_cast<int>(getImpl()->m_roles.size());
}

bool Config::hasRole(const char * role) const
{
    if (!role || !*role) return false;
    const char* rname = LookupRole(getImpl()->m_roles, role);
    return  rname && *rname;
}

const char * Config::getRoleName(int index) const
{
    if(index < 0 || index >= (int)getImpl()->m_roles.size()) return "";
    StringMap::const_iterator iter = getImpl()->m_roles.begin();
    for(int i = 0; i < index; ++i) ++iter;
    return iter->first.c_str();
}

const char * Config::getRoleColorSpace(int index) const
{
    return LookupRole(getImpl()->m_roles, getRoleName(index));
}

const char * Config::getRoleColorSpace(const char * roleName) const noexcept
{
    if (!roleName || !roleName[0]) return "";
    return LookupRole(getImpl()->m_roles, roleName);
}

///////////////////////////////////////////////////////////////////////////
//
// Named Transforms


int Config::getNumNamedTransforms(NamedTransformVisibility visibility) const noexcept
{
    int res = 0;
    switch (visibility)
    {
    case NAMEDTRANSFORM_ALL:
    {
        res = (int)getImpl()->m_allNamedTransforms.size();
        break;
    }
    case NAMEDTRANSFORM_ACTIVE:
    {
        res = (int)getImpl()->m_activeNamedTransformNames.size();
        break;
    }
    case NAMEDTRANSFORM_INACTIVE:
    {
        res = (int)getImpl()->m_inactiveNamedTransformNames.size();
        break;
    }
    }

    return res;

}

const char * Config::getNamedTransformNameByIndex(NamedTransformVisibility visibility,
                                                  int index) const noexcept
{
    if (index < 0)
    {
        return "";
    }

    switch (visibility)
    {
    case NAMEDTRANSFORM_ALL:
    {
        if (index < (int)getImpl()->m_allNamedTransforms.size())
        {
            return getImpl()->m_allNamedTransforms[index]->getName();
        }
        return "";
    }
    case NAMEDTRANSFORM_ACTIVE:
    {
        if (index < (int)getImpl()->m_activeNamedTransformNames.size())
        {
            return getImpl()->m_activeNamedTransformNames[index].c_str();
        }
        return "";
    }
    case NAMEDTRANSFORM_INACTIVE:
    {
        if (index < (int)getImpl()->m_inactiveNamedTransformNames.size())
        {
            return getImpl()->m_inactiveNamedTransformNames[index].c_str();
        }
        return "";
    }
    }

    return "";
}

ConstNamedTransformRcPtr Config::getNamedTransform(const char * name) const noexcept
{
    // Use all named transforms.
    return getImpl()->getNamedTransform(name);
}

int Config::getNumNamedTransforms() const noexcept
{
    return getNumNamedTransforms(NAMEDTRANSFORM_ACTIVE);
}

const char * Config::getNamedTransformNameByIndex(int index) const noexcept
{
    return getNamedTransformNameByIndex(NAMEDTRANSFORM_ACTIVE, index);
}

int Config::getIndexForNamedTransform(const char * name) const noexcept
{
    ConstNamedTransformRcPtr nt = getNamedTransform(name);
    if (!nt)
    {
        return -1;
    }

    // Check to see if the name is an active named transform.
    const auto num = getNumNamedTransforms(NAMEDTRANSFORM_ACTIVE);
    for (int idx = 0; idx < num; ++idx)
    {
        if (strcmp(getNamedTransformNameByIndex(NAMEDTRANSFORM_ACTIVE, idx), nt->getName()) == 0)
        {
            return idx;
        }
    }

    // Requests for an inactive named transform or an inactive color space will both fail.
    return -1;

}

void Config::addNamedTransform(const ConstNamedTransformRcPtr & nt)
{
    if (!nt)
    {
        throw Exception("Named transform is null.");
    }
    const std::string name(nt->getName());
    if (name.empty())
    {
        throw Exception("Named transform must have a non-empty name.");
    }
    if (!nt->getTransform(TRANSFORM_DIR_FORWARD) &&
        !nt->getTransform(TRANSFORM_DIR_INVERSE))
    {
        throw Exception("Named transform must define at least one transform.");
    }

    if (hasRole(name.c_str()))
    {
        std::ostringstream os;
        os << "Cannot add '" << name << "' named transform, there is already a role with this "
              "name.";
        throw Exception(os.str().c_str());
    }
    auto cs = getColorSpace(name.c_str());
    if (cs)
    {
        std::ostringstream os;
        os << "Cannot add '" << name << "' named transform, there is already a color space using "
              "this name as a name or as an alias: '" << cs->getName() << "'.";
        throw Exception(os.str().c_str());
    }

    if (ContainsContextVariableToken(name))
    {
        std::ostringstream oss;
        oss << "A named transform name '" << name
            << "' cannot contain a context variable reserved token i.e. % or $.";

        throw Exception(oss.str().c_str());
    }

    size_t existing = getImpl()->getNamedTransformIndex(name.c_str());

    size_t replaceIdx = (size_t)-1;
    const auto numNT = getImpl()->m_allNamedTransforms.size();
    if (existing < numNT)
    {
        const std::string existingName{ getImpl()->m_allNamedTransforms[existing]->getName() };
        if (!StringUtils::Compare(existingName, name))
        {
            std::ostringstream os;
            os << "Cannot add '" << name << "' named transform, existing named transform, '";
            os << existingName << "' is using this name as an alias.";
            throw Exception(os.str().c_str());
        }
        // There is a named transform with the same name that will be replaced (if new named
        // transform can be used).
        replaceIdx = existing;
    }

    const size_t numAliases = nt->getNumAliases();
    for (size_t aidx = 0; aidx < numAliases; ++aidx)
    {
        const char * alias = nt->getAlias(aidx);

        if (hasRole(alias))
        {
            std::ostringstream os;
            os << "Cannot add '" << name << "' named transform, it has an alias '" << alias
               << "' and there is already a role with this name.";
            throw Exception(os.str().c_str());
        }
        auto cs = getColorSpace(alias);
        if (cs)
        {
            std::ostringstream os;
            os << "Cannot add '" << name << "' named transform, it has an alias '" << alias
               << "' and there is already a color space using this name as a name or as "
                  "an alias: '" << cs->getName() << "'.";
            throw Exception(os.str().c_str());
        }
        if (ContainsContextVariableToken(alias))
        {
            std::ostringstream oss;
            oss << "Cannot add '" << name << "' named transform, it has an alias '" << alias
                << "' that cannot contain a context variable reserved token i.e. % or $.";

            throw Exception(oss.str().c_str());
        }

        existing = getImpl()->getNamedTransformIndex(alias);
        // Is an alias of the named transform already used by a named transform?
        // Skip existing named transform that might be replaced.
        if (existing != replaceIdx && existing < numNT)
        {
            const std::string existingName{ getImpl()->m_allNamedTransforms[existing]->getName() };
            std::ostringstream os;
            os << "Cannot add '" << name << "' named transform, it has '" << alias;
            os << "' alias and existing named transform, '";
            os << existingName << "' is using the same alias.";
            throw Exception(os.str().c_str());
        }
    }

    if (replaceIdx < numNT)
    {
        const std::string existingName{ getImpl()->m_allNamedTransforms[replaceIdx]->getName() };
        if (!StringUtils::Compare(existingName, name))
        {
            std::ostringstream os;
            os << "Cannot add '" << name << "' named transform, existing named transform, '";
            os << existingName << "' is using this name as an alias.";
            throw Exception(os.str().c_str());
        }
        NamedTransformRcPtr copy = nt->createEditableCopy();
        ConstNamedTransformRcPtr namedTransformCopy = copy;
        // Safe to swap, copy is not used after.
        getImpl()->m_allNamedTransforms[replaceIdx].swap(namedTransformCopy);
    }
    else
    {
        NamedTransformRcPtr copy = nt->createEditableCopy();
        ConstNamedTransformRcPtr namedTransformCopy = copy;
        getImpl()->m_allNamedTransforms.push_back(namedTransformCopy);
    }

    getImpl()->resetCacheIDs();
    getImpl()->refreshActiveColorSpaces();
}

void Config::removeNamedTransform(const char * name)
{
    const std::string nameToSearch = StringUtils::Lower(name);
    if (nameToSearch.empty()) return;

    for (auto itr = getImpl()->m_allNamedTransforms.begin(); itr != getImpl()->m_allNamedTransforms.end(); ++itr)
    {
        if (StringUtils::Lower((*itr)->getName()) == nameToSearch)
        {
            getImpl()->m_allNamedTransforms.erase(itr);
            return;
        }
    }

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
    getImpl()->refreshActiveColorSpaces();
}

void Config::clearNamedTransforms()
{
    getImpl()->m_allNamedTransforms.clear();

    getImpl()->resetCacheIDs();
    getImpl()->refreshActiveColorSpaces();
}

///////////////////////////////////////////////////////////////////////////
//
// Display/View Registration


ConstViewingRulesRcPtr Config::getViewingRules() const noexcept
{
    return getImpl()->m_viewingRules;
}

void Config::setViewingRules(ConstViewingRulesRcPtr viewingRules)
{
    getImpl()->m_viewingRules = viewingRules->createEditableCopy();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

bool Config::isViewShared(const char * dispName, const char * viewName) const
{
    if (!viewName || !*viewName) return false;

    for (int v = 0; v < getNumViews(VIEW_SHARED, dispName); v++)
    {
        const char * sharedViewName = getView(VIEW_SHARED, dispName, v);
        if (sharedViewName && *sharedViewName && Platform::Strcasecmp(sharedViewName, viewName) == 0)
        {
            return true;
        }
    }

    return false;
}

void Config::addSharedView(const char * view, const char * viewTransform,
                           const char * colorSpace, const char * looks,
                           const char * rule, const char * description)
{
    if (!view || !*view)
    {
        throw Exception("Shared view could not be added to config, view name has to be a "
                        "non-empty name.");
    }

    if (!colorSpace || !*colorSpace)
    {
        throw Exception("Shared view could not be added to config, color space name has to be a "
                        "non-empty name.");
    }

    ViewVec & views = getImpl()->m_sharedViews;
    AddView(views, view, viewTransform, colorSpace, looks, rule, description);

    getImpl()->m_displayCache.clear();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

void Config::removeSharedView(const char * view)
{
    if (!view || !*view)
    {
        throw Exception("Shared view could not be removed from config, view name has to be "
                        "a non-empty name.");
    }
    ViewVec & views = getImpl()->m_sharedViews;
    auto viewIt = FindView(views, view);

    if (viewIt != views.end())
    {
        views.erase(viewIt);

        getImpl()->m_displayCache.clear();

        AutoMutex lock(getImpl()->m_cacheidMutex);
        getImpl()->resetCacheIDs();
    }
    else
    {
        std::ostringstream os;
        os << "Shared view could not be removed from config. A shared view named '"
           << view << "' could not be found.";
        throw Exception(os.str().c_str());
    }
}

void Config::clearSharedViews()
{
    int numViews = getNumViews(VIEW_SHARED, nullptr);
    for (int v = numViews - 1; v >= 0; v--)
    {
        const char * sharedViewName = getView(VIEW_SHARED, nullptr, v);
        if (sharedViewName && *sharedViewName)
        {
            removeSharedView(sharedViewName);
        }
    }
}

const char * Config::getDefaultDisplay() const
{
    return getDisplay(0);
}

int Config::getNumDisplays() const
{
    getImpl()->updateDisplayCache();

    return static_cast<int>(getImpl()->m_displayCache.size());
}

const char * Config::getDisplay(int index) const
{
    getImpl()->updateDisplayCache();

    if(index>=0 && index < static_cast<int>(getImpl()->m_displayCache.size()))
    {
        return getImpl()->m_displayCache[index].c_str();
    }

    return "";
}

const char * Config::getDefaultView(const char * display) const
{
    return getView(display, 0);
}

const char * Config::getDefaultView(const char * display, const char * colorspaceName) const
{
    return getView(display, colorspaceName, 0);
}

int Config::getNumViews(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);

    const StringUtils::StringVec masterViews{ GetViewNames(views) };
    StringUtils::StringVec activeViews = getImpl()->getActiveViews(masterViews);
    return static_cast<int>(activeViews.size());
}

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

    // Include all displays, do not limit to active displays. Consider active views only.
    DisplayMap::const_iterator iter = FindDisplay(getImpl()->m_displays, display);
    if(iter == getImpl()->m_displays.end()) return "";

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

    const StringUtils::StringVec masterViews{ GetViewNames(views) };
    StringUtils::StringVec activeViews = getImpl()->getActiveViews(masterViews);

    if (index < 0 || static_cast<size_t>(index) >= activeViews.size())
    {
        return "";
    }
    int idx = FindInStringVecCaseIgnore(masterViews, activeViews[index]);

    if(idx >= 0 && static_cast<size_t>(idx) < views.size())
    {
        return views[idx]->m_name.c_str();
    }

    return "";
}

int Config::getNumViews(const char * display, const char * colorspace) const
{
    if (!display || !*display || !colorspace || !*colorspace) 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);

    StringUtils::StringVec viewNames;
    const StringUtils::StringVec filteredViews{ getImpl()->getFilteredViews(viewNames,
                                                                            views,
                                                                            colorspace) };

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

const char * Config::getView(const char * display, const char * colorspace, int index) const
{
    if (!display || !*display || !colorspace || !*colorspace) return "";

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

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

    StringUtils::StringVec viewNames;
    const StringUtils::StringVec filteredViews{ getImpl()->getFilteredViews(viewNames,
                                                                            views,
                                                                            colorspace) };
    int idx = index;

    if (!filteredViews.empty())
    {
        if (index < 0 || static_cast<size_t>(index) >= filteredViews.size())
        {
            return "";
        }
        idx = FindInStringVecCaseIgnore(viewNames, filteredViews[index]);
    }

    if (idx >= 0 && static_cast<size_t>(idx) < views.size())
    {
        return views[idx]->m_name.c_str();
    }

    if (!views.empty())
    {
        return views[0]->m_name.c_str();
    }

    return "";
}


bool Config::AreViewsEqual(const ConstConfigRcPtr & first,
                           const ConstConfigRcPtr & second,
                           const char * dispName,               // may be empty or nullptr for shared views
                           const char * viewName)
{
    // It's ok to call this even for displays/views that don't exist, it will simply return false.

    // Note that this will return true even if the view is display-defined in one config and a reference
    // to a shared view in the other config (both within the same display), as long as the contents match.

    // These calls return null if either the display or view doesn't exist (regardless if it's active).
    const char * cs1 = first->getDisplayViewColorSpaceName(dispName, viewName);
    const char * cs2 = second->getDisplayViewColorSpaceName(dispName, viewName);

    // If the color space is not null, the display and view exist.
    if (cs1 && *cs1 && cs2 && *cs2)
    {
        // Both configs have a display and view by this name, now check the contents.
        if (Platform::Strcasecmp(cs1, cs2) == 0)
        {
            // Note the remaining strings may be empty in a valid view.
            // Intentionally not checking the description since it is not a functional difference.
            if ( (Platform::Strcasecmp(first->getDisplayViewLooks(dispName, viewName),
                                       second->getDisplayViewLooks(dispName, viewName)) == 0) &&
                 (Platform::Strcasecmp(first->getDisplayViewTransformName(dispName, viewName),
                                       second->getDisplayViewTransformName(dispName, viewName)) == 0) &&
                 (Platform::Strcasecmp(first->getDisplayViewRule(dispName, viewName),
                                       second->getDisplayViewRule(dispName, viewName)) == 0) )
            {
                return true;
            }
        }
    }
    return false;
}

const char * Config::getDisplayViewTransformName(const char * display, const char * view) const
{
    const View * viewPtr = getImpl()->getView(display, view);

    if (!viewPtr) return "";
    return viewPtr->m_viewTransform.c_str();
}

const char * Config::getDisplayViewColorSpaceName(const char * display, const char * view) const
{
    const View * viewPtr = getImpl()->getView(display, view);

    if (!viewPtr) return "";
    return viewPtr->m_colorspace.c_str();
}

const char * Config::getDisplayViewLooks(const char * display, const char * view) const
{
    const View * viewPtr = getImpl()->getView(display, view);

    if (!viewPtr) return "";
    return viewPtr->m_looks.c_str();
}

const char * Config::getDisplayViewRule(const char * display, const char * view) const noexcept
{
    const View * viewPtr = getImpl()->getView(display, view);

    return viewPtr ? viewPtr->m_rule.c_str() : "";
}

const char * Config::getDisplayViewDescription(const char * display, const char * view) const noexcept
{
    const View * viewPtr = getImpl()->getView(display, view);

    return viewPtr ? viewPtr->m_description.c_str() : "";
}

bool Config::hasView(const char * dispName, const char * viewName) const
{
    // This returns null if either the display or view doesn't exist.
    // It works regardless of whether the display or view are active,
    // and it works regardless of whether the view is display-defined
    // or if the display has this as a shared view.
    //
    // It will only check config level shared views if dispName is null.
    // It will not check config level shared views if dispName is not null.
    const char * cs = getDisplayViewColorSpaceName(dispName, viewName);

    // All views must have a color space, so if it's not empty, the view exists.
    return (cs && *cs);
}

void Config::addDisplaySharedView(const char * display, const char * sharedView)
{
    if (!display || !*display)
    {
        throw Exception("Shared view could not be added to display: non-empty display name "
                        "is needed.");
    }
    if (!sharedView || !*sharedView)
    {
        throw Exception("Shared view could not be added to display: non-empty view name "
                        "is needed.");
    }

    bool invalidateCache = false;
    DisplayMap::iterator iter = FindDisplay(getImpl()->m_displays, display);
    if (iter == getImpl()->m_displays.end())
    {
        const auto curSize = getImpl()->m_displays.size();
        getImpl()->m_displays.resize(curSize + 1);
        getImpl()->m_displays[curSize].first = display;
        iter = std::prev(getImpl()->m_displays.end());
        invalidateCache = true;
    }

    const ViewVec & existingViews = iter->second.m_views;
    auto viewIt = FindView(existingViews, sharedView);
    if (viewIt != existingViews.end())
    {
        std::ostringstream os;
        os << "There is already a view named '" << sharedView;
        os << "' in the display '" << display << "'.";
        throw Exception(os.str().c_str());
    }

    StringUtils::StringVec & views = iter->second.m_sharedViews;
    if (StringUtils::Contain(views, sharedView))
    {
        std::ostringstream os;
        os << "There is already a shared view named '" << sharedView;
        os << "' in the display '" << display << "'.";
        throw Exception(os.str().c_str());
    }
    views.push_back(sharedView);
    if (invalidateCache)
    {
        getImpl()->m_displayCache.clear();
    }
    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

void Config::addDisplayView(const char * display, const char * view,
                            const char * colorSpace, const char * looks)
{
    addDisplayView(display, view, nullptr, colorSpace, looks, nullptr, nullptr);
}

void Config::addDisplayView(const char * display, const char * view, const char * viewTransform,
                            const char * colorSpace, const char * looks,
                            const char * rule, const char * description)
{
    if (!display || !*display)
    {
        throw Exception("View could not be added to display in config: a non-empty display "
                        "name is needed.");
    }
    if (!view || !*view)
    {
        throw Exception("View could not be added to display in config: a non-empty view "
                        "name is needed.");
    }
    if (!colorSpace || !*colorSpace)
    {
        throw Exception("View could not be added to display in config: a non-empty color space "
                        "name is needed.");
    }

    DisplayMap::iterator iter = FindDisplay(getImpl()->m_displays, display);
    if (iter == getImpl()->m_displays.end())
    {
        const auto curSize = getImpl()->m_displays.size();
        getImpl()->m_displays.resize(curSize + 1);
        getImpl()->m_displays[curSize].first = display;
        getImpl()->m_displays[curSize].second.m_views.push_back(View(view, viewTransform,
                                                                     colorSpace, looks, rule,
                                                                     description));
        getImpl()->m_displayCache.clear();
    }
    else
    {
        if (StringUtils::Contain(iter->second.m_sharedViews, view))
        {
            std::ostringstream os;
            os << "There is already a shared view named '" << view;
            os << "' in the display '" << display << "'.";
            throw Exception(os.str().c_str());
        }

        ViewVec & views = iter->second.m_views;
        AddView(views, view, viewTransform, colorSpace, looks, rule, description);
    }

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

void Config::removeDisplayView(const char * display, const char * view)
{
    if (!display || !*display)
    {
        throw Exception("Can't remove a view from a display with an empty display name.");
    }
    if (!view || !*view)
    {
        throw Exception("Can't remove a view from a display with an empty view name.");
    }

    const std::string displayNameRef(display);

    // Check if the display exists.

    DisplayMap::iterator iter = FindDisplay(getImpl()->m_displays, display);
    if (iter==getImpl()->m_displays.end())
    {
        std::ostringstream os;
        os << "Could not find a display named '" << display << "' to be removed from config.";
        throw Exception(os.str().c_str());
    }

    ViewVec & views = iter->second.m_views;
    StringUtils::StringVec & sharedViews = iter->second.m_sharedViews;

    const std::string viewNameRef(view);
    if (!StringUtils::Remove(sharedViews, view))
    {
        // view is not a shared view.
        // Is it a view?
        auto viewIt = FindView(views, view);
        if (viewIt == views.end())
        {
            std::ostringstream os;
            os << "Could not find a view named '" << view;
            os << " to be removed from the display named '" << display << "'.";
            throw Exception(os.str().c_str());
        }

        views.erase(viewIt);
    }

    // Check if the display needs to be removed also.
    if (views.empty() && sharedViews.empty())
    {
        getImpl()->m_displays.erase(iter);
    }

    getImpl()->m_displayCache.clear();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

void Config::clearDisplays()
{
    getImpl()->m_displays.clear();
    getImpl()->m_displayCache.clear();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

bool Config::hasVirtualView(const char * viewName) const
{
    const char * cs = getVirtualDisplayViewColorSpaceName(viewName);

    // All views must have a color space, so if it's not empty, the view exists.
    return (cs && *cs);
}

bool Config::isVirtualViewShared(const char * viewName) const
{
    if (!viewName || !*viewName) return false;

    for (int v = 0; v < getVirtualDisplayNumViews(VIEW_SHARED); v++)
    {
        const char * sharedViewName = getVirtualDisplayView(VIEW_SHARED, v);
        if (sharedViewName && *sharedViewName && Platform::Strcasecmp(sharedViewName, viewName) == 0)
        {
            return true;
        }
    }

    return false;
}

void Config::addVirtualDisplayView(const char * view,
                                   const char * viewTransform,
                                   const char * colorSpace,
                                   const char * looks,
                                   const char * rule,
                                   const char * description)
{
    if (!view || !*view)
    {
        throw Exception("View could not be added to virtual_display in config: a non-empty view "
                        "name is needed.");
    }

    if (!colorSpace || !*colorSpace)
    {
        throw Exception("View could not be added to virtual_display in config: a non-empty color "
                        "space name is needed.");
    }

    ViewVec::const_iterator iter = FindView(getImpl()->m_virtualDisplay.m_views, view);
    if (iter != getImpl()->m_virtualDisplay.m_views.end())
    {
        std::ostringstream oss;
        oss << "View could not be added to virtual_display in config: View '"
            << view
            << "' already exists.";
        throw Exception(oss.str().c_str());
    }

    getImpl()->m_virtualDisplay.m_views.push_back(
        View(view, viewTransform, colorSpace, looks, rule, description));

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

void Config::addVirtualDisplaySharedView(const char * sharedView)
{
    if (!sharedView || !*sharedView)
    {
        throw Exception("Shared view could not be added to virtual_display: "
                        "non-empty view name is needed.");
    }

    StringUtils::StringVec & views = getImpl()->m_virtualDisplay.m_sharedViews;
    if (StringUtils::Contain(views, sharedView))
    {
        std::ostringstream oss;
        oss << "Shared view could not be added to virtual_display: "
            << "There is already a shared view named '"
            << sharedView << "'.";
        throw Exception(oss.str().c_str());
    }

    views.push_back(sharedView);

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

int Config::getVirtualDisplayNumViews(ViewType type) const noexcept
{
    switch(type)
    {
        case VIEW_DISPLAY_DEFINED:
            return static_cast<int>(getImpl()->m_virtualDisplay.m_views.size());
        case VIEW_SHARED:
            return static_cast<int>(getImpl()->m_virtualDisplay.m_sharedViews.size());
    }

    return 0;
}

const char * Config::getVirtualDisplayView(ViewType type, int index) const noexcept
{
    switch(type)
    {
        case VIEW_DISPLAY_DEFINED:
        {
            const ViewVec & views = getImpl()->m_virtualDisplay.m_views;
            if (index >= 0 && index < static_cast<int>(views.size()))
            {
                return views[index].m_name.c_str();
            }
            break;
        }
        case VIEW_SHARED:
        {
            const StringUtils::StringVec & views = getImpl()->m_virtualDisplay.m_sharedViews;
            if (index >= 0 && index < static_cast<int>(views.size()))
            {
                return views[index].c_str();
            }
            break;
        }
    }

    return "";
}

bool Config::AreVirtualViewsEqual(const ConstConfigRcPtr & first,
                                  const ConstConfigRcPtr & second,
                                  const char * viewName)
{
    const char * cs1 = first->getVirtualDisplayViewColorSpaceName(viewName);
    const char * cs2 = second->getVirtualDisplayViewColorSpaceName(viewName);

    // If the color space is not null, the display and view exist.
    if (cs1 && *cs1 && cs2 && *cs2)
    {
        if (Platform::Strcasecmp(cs1, cs2) == 0)
        {
            // Note the remaining strings may be empty in a valid view.
            // Intentionally not checking the description since it is not a functional difference.
            if ( (Platform::Strcasecmp(first->getVirtualDisplayViewLooks(viewName),
                                       second->getVirtualDisplayViewLooks(viewName)) == 0) &&
                 (Platform::Strcasecmp(first->getVirtualDisplayViewTransformName(viewName),
                                       second->getVirtualDisplayViewTransformName(viewName)) == 0) &&
                 (Platform::Strcasecmp(first->getVirtualDisplayViewRule(viewName),
                                       second->getVirtualDisplayViewRule(viewName)) == 0) )
            {
                return true;
            }
        }
    }
    return false;
}

const char * Config::getVirtualDisplayViewTransformName(const char * view) const noexcept
{
    if (!view) return "";

    // Get the view transform name for the case where a virtual view is shared.
    if (isVirtualViewShared(view))
    {
        return getDisplayViewTransformName(nullptr, view);
    }

    ViewVec::const_iterator iter = FindView(getImpl()->m_virtualDisplay.m_views, view);
    if (iter != getImpl()->m_virtualDisplay.m_views.end())
    {
        return iter->m_viewTransform.c_str();
    }

    return "";
}

const char * Config::getVirtualDisplayViewColorSpaceName(const char * view) const noexcept
{
    if (!view) return "";

    // Get the colorspace name for the case where a virtual view is shared.
    if (isVirtualViewShared(view))
    {
        return getDisplayViewColorSpaceName(nullptr, view);
    }

    ViewVec::const_iterator iter = FindView(getImpl()->m_virtualDisplay.m_views, view);
    if (iter != getImpl()->m_virtualDisplay.m_views.end())
    {
        return iter->m_colorspace.c_str();
    }

    return "";
}

const char * Config::getVirtualDisplayViewLooks(const char * view) const noexcept
{
    if (!view) return "";

    // Get the view looks for the case where a virtual view is shared
    if (isVirtualViewShared(view))
    {
        return getDisplayViewLooks(nullptr, view);
    }

    ViewVec::const_iterator iter = FindView(getImpl()->m_virtualDisplay.m_views, view);
    if (iter != getImpl()->m_virtualDisplay.m_views.end())
    {
        return iter->m_looks.c_str();
    }

    return "";
}

const char * Config::getVirtualDisplayViewRule(const char * view) const noexcept
{
    if (!view) return "";

    // Get the view rule for the case where a virtual view is shared
    if (isVirtualViewShared(view))
    {
        return getDisplayViewRule(nullptr, view);
    }

    ViewVec::const_iterator iter = FindView(getImpl()->m_virtualDisplay.m_views, view);
    if (iter != getImpl()->m_virtualDisplay.m_views.end())
    {
        return iter->m_rule.c_str();
    }

    return "";
}

const char * Config::getVirtualDisplayViewDescription(const char * view) const noexcept
{
    if (!view) return "";

    // Get the view description for the case where a virtual view is shared
    if (isVirtualViewShared(view))
    {
        return getDisplayViewDescription(nullptr, view);
    }

    ViewVec::const_iterator iter = FindView(getImpl()->m_virtualDisplay.m_views, view);
    if (iter != getImpl()->m_virtualDisplay.m_views.end())
    {
        return iter->m_description.c_str();
    }

    return "";
}

void Config::removeVirtualDisplayView(const char * view) noexcept
{
    if (!view) return;

    ViewVec::const_iterator iter = FindView(getImpl()->m_virtualDisplay.m_views, view);
    if (iter != getImpl()->m_virtualDisplay.m_views.end())
    {
        ViewVec & views = getImpl()->m_virtualDisplay.m_views;

        const auto it = std::find_if(views.begin(), views.end(), 
                                     [view](const View & v) 
                                     { 
                                        return StringUtils::Compare(v.m_name.c_str(), view); 
                                     });
        if (it!=views.end())
        {
            views.erase(it);

            AutoMutex lock(getImpl()->m_cacheidMutex);
            getImpl()->resetCacheIDs();
            return;
        }
    }

    if (StringUtils::Remove(getImpl()->m_virtualDisplay.m_sharedViews, view))
    {
        AutoMutex lock(getImpl()->m_cacheidMutex);
        getImpl()->resetCacheIDs();
        return;
    }
}

void Config::clearVirtualDisplay() noexcept
{
    getImpl()->m_virtualDisplay.m_views.clear();
    getImpl()->m_virtualDisplay.m_sharedViews.clear();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

int Config::instantiateDisplayFromMonitorName(const char * monitorName)
{
    if (!monitorName || !*monitorName)
    {
        throw Exception("The system monitor name cannot be null.");
    }

    const std::string ICCProfileFilepath
        = SystemMonitorsImpl::GetICCProfileFromMonitorName(monitorName);
    
    const std::string monitorDescription
        = GetProfileDescriptionFromICCProfile(ICCProfileFilepath.c_str());

    return getImpl()->instantiateDisplay(monitorName, monitorDescription, ICCProfileFilepath);
}

int Config::instantiateDisplayFromICCProfile(const char * ICCProfileFilepath)
{
    if (!ICCProfileFilepath || !*ICCProfileFilepath)
    {
        throw Exception("The ICC profile filepath cannot be null.");
    }

    const std::string monitorDescription
        = GetProfileDescriptionFromICCProfile(ICCProfileFilepath);

    return getImpl()->instantiateDisplay("", monitorDescription, ICCProfileFilepath);
}

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);
    getImpl()->resetCacheIDs();
}

const char * Config::getActiveDisplays() const
{
    getImpl()->m_activeDisplaysStr = JoinStringEnvStyle(getImpl()->m_activeDisplays);
    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);
    getImpl()->resetCacheIDs();
}

const char * Config::getActiveViews() const
{
    getImpl()->m_activeViewsStr = JoinStringEnvStyle(getImpl()->m_activeViews);
    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());
}

const char * Config::getDisplayAll(int index) const noexcept
{
    if (index >= 0 || index < static_cast<int>(getImpl()->m_displays.size()))
    {
        return getImpl()->m_displays[index].first.c_str();
    }

    return "";
}

int Config::getDisplayAllByName(const char * name) const noexcept
{
    if (!name || !*name)
    {
        return -1;
    }

    for (size_t idx = 0; idx < getImpl()->m_displays.size(); ++idx)
    {
        if (0==strcmp(name, getImpl()->m_displays[idx].first.c_str()))
        {
            return static_cast<int>(idx);
        }
    }
    
    return -1;
}

bool Config::isDisplayTemporary(int index) const noexcept
{
    if (index >= 0 || index < static_cast<int>(getImpl()->m_displays.size()))
    {
        return getImpl()->m_displays[index].second.m_temporary;
    }

    return false;
}

void Config::setDisplayTemporary(int index, bool isTemporary) noexcept
{
    if (index >= 0 || index < static_cast<int>(getImpl()->m_displays.size()))
    {
        getImpl()->m_displays[index].second.m_temporary = isTemporary;

        getImpl()->m_displayCache.clear();
        AutoMutex lock(getImpl()->m_cacheidMutex);
        getImpl()->resetCacheIDs();
    }
}

int Config::getNumViews(ViewType type, const char * display) const
{
    if (!display || !*display)
    {
        return static_cast<int>(getImpl()->m_sharedViews.size());
    }

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

    switch (type)
    {
    case VIEW_SHARED:
        return static_cast<int>(iter->second.m_sharedViews.size());
    case VIEW_DISPLAY_DEFINED:
        return static_cast<int>(iter->second.m_views.size());
    }

    return 0;
}

const char * Config::getView(ViewType type, const char * display, int index) const
{
    if (!display || !*display)
    {
        if (index >= 0 || index < static_cast<int>(getImpl()->m_sharedViews.size()))
        {
            return getImpl()->m_sharedViews[index].m_name.c_str();
        }
        return "";
    }

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

    switch (type)
    {
    case VIEW_SHARED:
    {
        const StringUtils::StringVec & views = iter->second.m_sharedViews;
        if (index >= 0 && index < static_cast<int>(views.size()))
        {
            return views[index].c_str();
        }
        break;
    }
    case VIEW_DISPLAY_DEFINED:
    {
        const ViewVec & views = iter->second.m_views;
        if (index >= 0 && index < static_cast<int>(views.size()))
        {
            return views[index].m_name.c_str();
        }
        break;
    }
    }

    return "";
}

///////////////////////////////////////////////////////////////////////////

void Config::getDefaultLumaCoefs(double * c3) const
{
    memcpy(c3, &getImpl()->m_defaultLumaCoefs[0], 3*sizeof(double));
}

void Config::setDefaultLumaCoefs(const double * c3)
{
    memcpy(&getImpl()->m_defaultLumaCoefs[0], c3, 3*sizeof(double));

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

///////////////////////////////////////////////////////////////////////////

ConstLookRcPtr Config::getLook(const char * name) const
{
    return getImpl()->getLook(name);
}

int Config::getNumLooks() const
{
    return static_cast<int>(getImpl()->m_looksList.size());
}

const char * Config::getLookNameByIndex(int index) const
{
    if(index<0 || index>=static_cast<int>(getImpl()->m_looksList.size()))
    {
        return "";
    }

    return getImpl()->m_looksList[index]->getName();
}

void Config::addLook(const ConstLookRcPtr & look)
{
    const std::string name = look->getName();
    if(name.empty())
        throw Exception("Cannot addLook with an empty name.");

    const std::string namelower = StringUtils::Lower(name);

    // If the look exists, replace it
    for(unsigned int i=0; i<getImpl()->m_looksList.size(); ++i)
    {
        if(StringUtils::Lower(getImpl()->m_looksList[i]->getName()) == namelower)
        {
            getImpl()->m_looksList[i] = look->createEditableCopy();

            AutoMutex lock(getImpl()->m_cacheidMutex);
            getImpl()->resetCacheIDs();

            return;
        }
    }

    // Otherwise, add it
    getImpl()->m_looksList.push_back(look->createEditableCopy());

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

void Config::clearLooks()
{
    getImpl()->m_looksList.clear();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

///////////////////////////////////////////////////////////////////////////

int Config::getNumViewTransforms() const noexcept
{
    return static_cast<int>(getImpl()->m_viewTransforms.size());
}

ConstViewTransformRcPtr Config::getViewTransform(const char * name) const noexcept
{
    return getImpl()->getViewTransform(name);
}

const char * Config::getViewTransformNameByIndex(int index) const noexcept
{
    if (index<0 || index >= static_cast<int>(getImpl()->m_viewTransforms.size()))
    {
        return "";
    }

    return getImpl()->m_viewTransforms[index]->getName();
}

ConstViewTransformRcPtr Config::getDefaultSceneToDisplayViewTransform() const
{
    // The default view transform between the main reference space (scene-referred) and the
    // display-referred space if it is not defined, it is the first one in the list that uses
    // a scene-referred reference space.

    if (!getImpl()->m_defaultViewTransform.empty())
    {
        const auto vt = getImpl()->getViewTransform(getImpl()->m_defaultViewTransform.c_str());
        if (vt)
        {
            if (vt->getReferenceSpaceType() == REFERENCE_SPACE_SCENE)
            {
                return vt;
            }
        }
    }
    for (const auto & viewTransform : getImpl()->m_viewTransforms)
    {
        if (viewTransform->getReferenceSpaceType() == REFERENCE_SPACE_SCENE)
        {
            return viewTransform;
        }
    }
    return ConstViewTransformRcPtr();
}

const char * Config::getDefaultViewTransformName() const noexcept
{
    return getImpl()->m_defaultViewTransform.c_str();
}

void Config::setDefaultViewTransformName(const char * defaultVT) noexcept
{
    getImpl()->m_defaultViewTransform = defaultVT ? defaultVT : "";

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

void Config::addViewTransform(const ConstViewTransformRcPtr & viewTransform)
{
    const std::string name = viewTransform->getName();
    if (name.empty())
    {
        throw Exception("Cannot add view transform with an empty name.");
    }

    if (!viewTransform->getTransform(VIEWTRANSFORM_DIR_TO_REFERENCE) &&
        !viewTransform->getTransform(VIEWTRANSFORM_DIR_FROM_REFERENCE))
    {
        std::ostringstream os;
        os << "Cannot add view transform '" << name << "' with no transform.";
        throw Exception(os.str().c_str());
    }

    const std::string namelower = StringUtils::Lower(name);

    bool addIt = true;

    // If the view transform exists, replace it.
    for (auto && vt : getImpl()->m_viewTransforms)
    {
        if (StringUtils::Lower(vt->getName()) == namelower)
        {
            vt = viewTransform->createEditableCopy();
            addIt = false;
            break;
        }
    }

    // Otherwise, add it.
    if (addIt)
    {
        getImpl()->m_viewTransforms.push_back(viewTransform->createEditableCopy());
    }

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

void Config::clearViewTransforms()
{
    getImpl()->m_viewTransforms.clear();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

///////////////////////////////////////////////////////////////////////////

ConstFileRulesRcPtr Config::getFileRules() const noexcept
{
    return getImpl()->m_fileRules;
}

void Config::setFileRules(ConstFileRulesRcPtr fileRules)
{
    getImpl()->m_fileRules = fileRules->createEditableCopy();

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

const char * Config::getColorSpaceFromFilepath(const char * filePath) const
{
    return getImpl()->m_fileRules->getImpl()->getColorSpaceFromFilepath(*this,
                                                                        filePath ? filePath : "");
}

const char * Config::getColorSpaceFromFilepath(const char * filePath, size_t & ruleIndex) const
{
    return getImpl()->m_fileRules->getImpl()->getColorSpaceFromFilepath(*this,
                                                                        filePath ? filePath : "",
                                                                        ruleIndex);
}

bool Config::filepathOnlyMatchesDefaultRule(const char * filePath) const
{
    return getImpl()->m_fileRules->getImpl()->filepathOnlyMatchesDefaultRule(*this,
                                                                             filePath ? filePath : "");
}


///////////////////////////////////////////////////////////////////////////
//  GetProcessor

ConstProcessorRcPtr Config::getProcessor(const ConstColorSpaceRcPtr & src,
                                         const ConstColorSpaceRcPtr & dst) const
{
    ConstContextRcPtr context = getCurrentContext();
    return getProcessor(context, src, dst);
}

ConstProcessorRcPtr Config::getProcessor(const ConstContextRcPtr & context,
                                         const ConstColorSpaceRcPtr & src,
                                         const ConstColorSpaceRcPtr & dst) const
{
    if (!src)
    {
        throw Exception("Config::GetProcessor failed. Source color space is null.");
    }

    if (!dst)
    {
        throw Exception("Config::GetProcessor failed. Destination color space is null.");
    }

    ColorSpaceTransformRcPtr transform = ColorSpaceTransform::Create();
    transform->setSrc(src->getName());
    transform->setDst(dst->getName());
    return getProcessor(context, transform, TRANSFORM_DIR_FORWARD);
}

ConstProcessorRcPtr Config::getProcessor(const char * srcName, const char * dstName) const
{
    ConstContextRcPtr context = getCurrentContext();
    return getProcessor(context, srcName, dstName);
}

// Names can be color space name or role name
ConstProcessorRcPtr Config::getProcessor(const ConstContextRcPtr & context,
                                         const char * srcName,
                                         const char * dstName) const
{
    auto csTransform = ColorSpaceTransform::Create();
    csTransform->setSrc(srcName);
    csTransform->setDst(dstName);
    return getProcessor(context, csTransform, TRANSFORM_DIR_FORWARD);
}


ConstProcessorRcPtr Config::getProcessor(const char * srcColorSpaceName,
                                         const char * display,
                                         const char * view,
                                         TransformDirection direction) const
{
    ConstContextRcPtr context = getCurrentContext();
    return getProcessor(context, srcColorSpaceName, display, view, direction);
}

ConstProcessorRcPtr Config::getProcessor(const ConstContextRcPtr & context,
                                         const char * srcColorSpaceName,
                                         const char * display,
                                         const char * view,
                                         TransformDirection direction) const
{
    auto dt = DisplayViewTransform::Create();
    dt->setSrc(srcColorSpaceName);
    dt->setDisplay(display);
    dt->setView(view);
    dt->validate();
    return getProcessor(context, dt, direction);
}

ConstProcessorRcPtr Config::getProcessor(const ConstNamedTransformRcPtr & namedTransform,
                                         TransformDirection direction) const
{
    ConstContextRcPtr context = getCurrentContext();
    return getProcessor(context, namedTransform, direction);
}

ConstProcessorRcPtr Config::getProcessor(const ConstContextRcPtr & context,
                                         const ConstNamedTransformRcPtr & namedTransform,
                                         TransformDirection direction) const
{
    // This gets or calculates the named transform in the requested direction. The result
    // is always applied in the forward direction.
    auto transform = NamedTransform::GetTransform(namedTransform, direction);
    return getProcessor(context, transform, TRANSFORM_DIR_FORWARD);
}

ConstProcessorRcPtr Config::getProcessor(const char * namedTransformName,
                                         TransformDirection direction) const
{
    ConstContextRcPtr context = getCurrentContext();
    return getProcessor(context, namedTransformName, direction);
}

ConstProcessorRcPtr Config::getProcessor(const ConstContextRcPtr & context,
                                         const char * namedTransformName,
                                         TransformDirection direction) const
{
    ConstNamedTransformRcPtr namedTransform = getNamedTransform(namedTransformName);
    return getProcessor(context, namedTransform, direction);
}

ConstProcessorRcPtr Config::getProcessor(const ConstTransformRcPtr & transform) const
{
    return getProcessor(transform, TRANSFORM_DIR_FORWARD);
}

ConstProcessorRcPtr Config::getProcessor(const ConstTransformRcPtr & transform,
                                         TransformDirection direction) const
{
    ConstContextRcPtr context = getCurrentContext();
    return getProcessor(context, transform, direction);
}

ConstProcessorRcPtr Config::getProcessor(const ConstContextRcPtr & context,
                                         const ConstTransformRcPtr & transform,
                                         TransformDirection direction) const
{
    if (!context)
    {
        throw Exception("Config::GetProcessor failed. Context is null.");
    }

    if (!transform)
    {
        throw Exception("Config::GetProcessor failed. Transform is null.");
    }


    // The goal of the usedContext is to only contain the context vars that are actually used for
    // this transform.  This allows the cache to be more efficient. However, there are still some
    // various TODOs since the usedContext will sometimes contain more vars than are needed.

    ContextRcPtr usedContext = Context::Create();
    usedContext->setSearchPath(context->getSearchPath());
    usedContext->setWorkingDir(context->getWorkingDir());
    usedContext->setConfigIOProxy(context->getConfigIOProxy());

    const bool needContextVariables = CollectContextVariables(*this, *context, transform, usedContext);

    // Create helper method.
    auto CreateProcessor = [](const Config & config, 
                              const ConstContextRcPtr & context,
                              const ConstTransformRcPtr & transform,
                              TransformDirection direction) -> ProcessorRcPtr
    {
        ProcessorRcPtr processor = Processor::Create();
        processor->getImpl()->setProcessorCacheFlags(config.getImpl()->m_cacheFlags);
        processor->getImpl()->setTransform(config, context, transform, direction);
        processor->getImpl()->computeMetadata();
        return processor;
    };

    if (getImpl()->m_processorCache.isEnabled())
    {
        AutoMutex guard(getImpl()->m_processorCache.lock());

        // Note that the key includes a string description of the transform which does not include
        // all the LUT entries (just the arguments of the FileTransforms for LUTs).
        std::ostringstream oss;
        oss << (needContextVariables ? std::string(usedContext->getCacheID()) : "")
            << *transform
            << direction;

        const std::size_t key = std::hash<std::string>{}(oss.str());

        // As the entry is a shared pointer instance, having an empty one means that the entry does
        // not exist in the cache. So, it provides a fast existence check & access in one call.
        ProcessorRcPtr & processor = getImpl()->m_processorCache[key];
        if (!processor)
        {
            ProcessorRcPtr proc = CreateProcessor(*this, context, transform, direction);

            const bool doFallback = !Platform::isEnvPresent(OCIO_DISABLE_CACHE_FALLBACK);
            if (doFallback)
            {
                // If an entry with the same cache ID already exists in the cache then reuse it
                // instead of the newly created one. Even with different context, the same
                // processor could be created (e.g. the processor creation does not rely on some
                // context variables).

                // The benefit to using the existing one is that it may already have an optimized
                // Processor, CPUProcessor, or GPUProcessor inside it.

                // TODO: With the original context part of the cache data, the code could first
                // compare the two contexts before doing the lengthy Processor::getCacheID()
                // computation.

                for (auto & entry : getImpl()->m_processorCache)
                {
                    if (entry.second && 0 == strcmp(entry.second->getCacheID(), proc->getCacheID()))
                    {
                        processor = entry.second;
                        break;
                    }
                }
            }

            if (!processor)
            {
                processor = proc;
            }
        }

        return processor;
    }
    else
    {
        return CreateProcessor(*this, context, transform, direction);
    }
}

ConstProcessorRcPtr Config::GetProcessorFromConfigs(const ConstConfigRcPtr & srcConfig,
                                                    const char * srcName,
                                                    const ConstConfigRcPtr & dstConfig,
                                                    const char * dstName)
{
    return GetProcessorFromConfigs(srcConfig->getCurrentContext(), srcConfig, srcName,
                                   dstConfig->getCurrentContext(), dstConfig, dstName);
}

ConstProcessorRcPtr Config::GetProcessorFromConfigs(const ConstContextRcPtr & srcContext,
                                                    const ConstConfigRcPtr & srcConfig,
                                                    const char * srcName,
                                                    const ConstContextRcPtr & dstContext,
                                                    const ConstConfigRcPtr & dstConfig,
                                                    const char * dstName)
{
    // Extract the appropriate interchange roles based on the reference space type of the
    // source and destination color spaces.  Note that no heuristics are attempted.  If these
    // roles are missing, an exception is raised.  (Note that the names of the returned color
    // spaces should not depend on the context arguments above.)
    const char * srcInterchangeName = nullptr;
    const char * dstInterchangeName = nullptr;
    ReferenceSpaceType interchangeType;
    if( !ConfigUtils::GetInterchangeRolesForColorSpaceConversion(&srcInterchangeName, 
                                                                 &dstInterchangeName, 
                                                                 interchangeType,
                                                                 srcConfig, srcName, 
                                                                 dstConfig, dstName) )
    {
        const char * interchangeRoleName = (interchangeType == REFERENCE_SPACE_SCENE)
                                           ? ROLE_INTERCHANGE_SCENE : ROLE_INTERCHANGE_DISPLAY;
        std::ostringstream os;
        os << "The required role '" << interchangeRoleName << "' is missing from the source and/or "
           << "destination config.";
        throw Exception(os.str().c_str());
    }

    return GetProcessorFromConfigs(srcContext, srcConfig, srcName, srcInterchangeName,
                                   dstContext, dstConfig, dstName, dstInterchangeName);
}

ConstProcessorRcPtr Config::GetProcessorFromConfigs(const ConstConfigRcPtr & srcConfig,
                                                    const char * srcName,
                                                    const char * srcInterchangeName,
                                                    const ConstConfigRcPtr & dstConfig,
                                                    const char * dstName,
                                                    const char * dstInterchangeName)
{
    return GetProcessorFromConfigs(srcConfig->getCurrentContext(), srcConfig, srcName, srcInterchangeName,
                                   dstConfig->getCurrentContext(), dstConfig, dstName, dstInterchangeName);
}

ConstProcessorRcPtr Config::GetProcessorFromConfigs(const ConstContextRcPtr & srcContext,
                                                    const ConstConfigRcPtr & srcConfig,
                                                    const char * srcName,
                                                    const char * srcInterchangeName,
                                                    const ConstContextRcPtr & dstContext,
                                                    const ConstConfigRcPtr & dstConfig,
                                                    const char * dstName,
                                                    const char * dstInterchangeName)
{
    ConstColorSpaceRcPtr srcColorSpace = srcConfig->getColorSpace(srcName);
    if (!srcColorSpace)
    {
        std::ostringstream os;
        os << "Could not find source color space '" << srcName << "'.";
        throw Exception(os.str().c_str());
    }

    ConstColorSpaceRcPtr srcExCs = srcConfig->getColorSpace(srcInterchangeName);
    if (!srcExCs)
    {
        std::ostringstream os;
        os << "Could not find source interchange color space '" << srcInterchangeName << "'.";
        throw Exception(os.str().c_str());
    }

    ConstColorSpaceRcPtr dstColorSpace = dstConfig->getColorSpace(dstName);
    if (!dstColorSpace)
    {
        std::ostringstream os;
        os << "Could not find destination color space '" << dstName << "'.";
        throw Exception(os.str().c_str());
    }

    ConstColorSpaceRcPtr dstExCs = dstConfig->getColorSpace(dstInterchangeName);
    if (!dstExCs)
    {
        std::ostringstream os;
        os << "Could not find destination interchange color space '" << dstInterchangeName << "'.";
        throw Exception(os.str().c_str());
    }

    auto p1 = srcConfig->getProcessor(srcContext, srcColorSpace, srcExCs);
    if (!p1)
    {
        throw Exception("Can't create the processor for the source config and "
            "the source color space.");
    }

    auto p2 = dstConfig->getProcessor(dstContext, dstExCs, dstColorSpace);
    if (!p2)
    {
        throw Exception("Can't create the processor for the destination config "
            "and the destination color space.");
    }

    ProcessorRcPtr processor = Processor::Create();
    processor->getImpl()->setProcessorCacheFlags(srcConfig->getImpl()->m_cacheFlags);

    // If either of the color spaces are data spaces, its corresponding processor
    // will be empty, but need to make sure the entire result is also empty to
    // better match the semantics of how data spaces are handled.
    if (!srcColorSpace->isData() && !dstColorSpace->isData())
    {
        processor->getImpl()->concatenate(p1, p2);
    }
    return processor;
}

ConstProcessorRcPtr Config::GetProcessorFromConfigs(const ConstConfigRcPtr & srcConfig,
                                                    const char * srcName,
                                                    const ConstConfigRcPtr & dstConfig,
                                                    const char * dstDisplay,
                                                    const char * dstView,
                                                    TransformDirection direction)
{
    return GetProcessorFromConfigs(srcConfig->getCurrentContext(), srcConfig, srcName,
                                   dstConfig->getCurrentContext(), dstConfig, dstDisplay, dstView, direction);
}

ConstProcessorRcPtr Config::GetProcessorFromConfigs(const ConstContextRcPtr & srcContext,
                                                    const ConstConfigRcPtr & srcConfig,
                                                    const char * srcName,
                                                    const ConstContextRcPtr & dstContext,
                                                    const ConstConfigRcPtr & dstConfig,
                                                    const char * dstDisplay,
                                                    const char * dstView,
                                                    TransformDirection direction)
{
    ConstColorSpaceRcPtr srcColorSpace = srcConfig->getColorSpace(srcName);
    if (!srcColorSpace)
    {
        std::ostringstream os;
        os << "Could not find source color space '" << srcName << "'.";
        throw Exception(os.str().c_str());
    }

    const bool sceneReferred = (srcColorSpace->getReferenceSpaceType() == REFERENCE_SPACE_SCENE);
    const char* exchangeRoleName = sceneReferred ? ROLE_INTERCHANGE_SCENE : ROLE_INTERCHANGE_DISPLAY;
    const char* srcExName = LookupRole(srcConfig->getImpl()->m_roles, exchangeRoleName);
    if (!srcExName || !*srcExName)
    {
        std::ostringstream os;
        os << "The role '" << exchangeRoleName << "' is missing in the source config.";
        throw Exception(os.str().c_str());
    }
    ConstColorSpaceRcPtr srcExCs = srcConfig->getColorSpace(srcExName);
    if (!srcExCs)
    {
        std::ostringstream os;
        os << "The role '" << exchangeRoleName << "' refers to color space '" << srcExName;
        os << "' that is missing in the source config.";
        throw Exception(os.str().c_str());
    }

    const char* dstExName = LookupRole(dstConfig->getImpl()->m_roles, exchangeRoleName);
    if (!dstExName || !*dstExName)
    {
        std::ostringstream os;
        os << "The role '" << exchangeRoleName << "' is missing in the destination config.";
        throw Exception(os.str().c_str());
    }
    ConstColorSpaceRcPtr dstExCs = dstConfig->getColorSpace(dstExName);
    if (!dstExCs)
    {
        std::ostringstream os;
        os << "The role '" << exchangeRoleName << "' refers to color space '" << dstExName;
        os << "' that is missing in the destination config.";
        throw Exception(os.str().c_str());
    }

    return GetProcessorFromConfigs(srcContext, srcConfig, srcName, srcExName,
                                   dstContext, dstConfig, dstDisplay, dstView, dstExName, direction);
}

ConstProcessorRcPtr Config::GetProcessorFromConfigs(const ConstConfigRcPtr& srcConfig,
                                                    const char * srcName,
                                                    const char * srcInterchangeName,
                                                    const ConstConfigRcPtr & dstConfig,
                                                    const char * dstDisplay,
                                                    const char * dstView,
                                                    const char* dstInterchangeName,
                                                    TransformDirection direction)
{
    return GetProcessorFromConfigs(srcConfig->getCurrentContext(), srcConfig, srcName, srcInterchangeName,
                                   dstConfig->getCurrentContext(), dstConfig, dstDisplay, dstView, dstInterchangeName, direction);
}

ConstProcessorRcPtr Config::GetProcessorFromConfigs(const ConstContextRcPtr & srcContext,
                                                    const ConstConfigRcPtr & srcConfig,
                                                    const char * srcName,
                                                    const char * srcInterchangeName,
                                                    const ConstContextRcPtr & dstContext,
                                                    const ConstConfigRcPtr & dstConfig,
                                                    const char * dstDisplay,
                                                    const char * dstView,
                                                    const char * dstInterchangeName,
                                                    TransformDirection direction)
{
    ConstColorSpaceRcPtr srcColorSpace = srcConfig->getColorSpace(srcName);
    if (!srcColorSpace)
    {
        std::ostringstream os;
        os << "Could not find source color space '" << srcName << "'.";
        throw Exception(os.str().c_str());
    }

    ConstColorSpaceRcPtr srcExCs = srcConfig->getColorSpace(srcInterchangeName);
    if (!srcExCs)
    {
        std::ostringstream os;
        os << "Could not find source interchange color space '" << srcInterchangeName << "'.";
        throw Exception(os.str().c_str());
    }

    if (direction == TRANSFORM_DIR_INVERSE)
    {
        std::swap(srcColorSpace, srcExCs);
    }
    auto p1 = srcConfig->getProcessor(srcContext, srcColorSpace, srcExCs);
    if (!p1)
    {
        throw Exception("Can't create the processor for the source config and "
            "the source color space.");
    }

    const char* csName = dstConfig->getDisplayViewColorSpaceName(dstDisplay, dstView);
    const char* displayColorSpaceName = View::UseDisplayName(csName) ? dstDisplay : csName;
    ConstColorSpaceRcPtr displayColorSpace = dstConfig->getColorSpace(displayColorSpaceName);
    if (!displayColorSpace)
    {
        throw Exception("Can't create the processor for the destination config: "
            "display color space not found.");
    }

    auto p2 = dstConfig->getProcessor(dstContext, dstInterchangeName, dstDisplay, dstView, direction);
    if (!p2)
    {
        throw Exception("Can't create the processor for the destination config "
            "and the destination display view transform.");
    }

    ProcessorRcPtr processor = Processor::Create();
    processor->getImpl()->setProcessorCacheFlags(srcConfig->getImpl()->m_cacheFlags);

    // If either of the color spaces are data spaces, its corresponding processor
    // will be empty, but need to make sure the entire result is also empty to
    // better match the semantics of how data spaces are handled.
    if (!srcColorSpace->isData() && !displayColorSpace->isData())
    {
        if (direction == TRANSFORM_DIR_INVERSE)
        {
            std::swap(p1, p2);
        }
        processor->getImpl()->concatenate(p1, p2);
    }
    return processor;
}

static ConstProcessorRcPtr GetProcessorToBuiltinCS(ConstConfigRcPtr srcConfig,
                                                   const char * srcColorSpaceName, 
                                                   const char * builtinColorSpaceName,
                                                   TransformDirection direction)
{
    // Use the Default config as the Built-in config to interpret the known color space name.        
    ConstConfigRcPtr builtinConfig = Config::CreateFromFile("ocio://default");

    if (builtinConfig->getColorSpace(builtinColorSpaceName) == nullptr)
    {
        std::ostringstream os;
        os  << "Built-in config does not contain the requested color space: " 
            << builtinColorSpaceName << ".";
        throw Exception(os.str().c_str());
    }

    const char * srcInterchange = nullptr;
    const char * builtinInterchange = nullptr;
    Config::IdentifyInterchangeSpace(&srcInterchange, 
                                     &builtinInterchange,
                                     srcConfig,
                                     srcColorSpaceName, 
                                     builtinConfig,
                                     builtinColorSpaceName);

    if (builtinInterchange && builtinInterchange[0])
    {
        ConstProcessorRcPtr proc;
        if (direction == TRANSFORM_DIR_FORWARD)
        {
            proc = Config::GetProcessorFromConfigs(srcConfig,
                                                   srcColorSpaceName,
                                                   srcInterchange,
                                                   builtinConfig,
                                                   builtinColorSpaceName,
                                                   builtinInterchange);
        }
        else if (direction == TRANSFORM_DIR_INVERSE)
        {
            proc = Config::GetProcessorFromConfigs(builtinConfig,
                                                   builtinColorSpaceName,
                                                   builtinInterchange,
                                                   srcConfig,
                                                   srcColorSpaceName,
                                                   srcInterchange);
        }
        return proc;
    }

    std::ostringstream os;
    os  << "Heuristics were not able to find a known color space in the provided config.\n"
        << "Please set the interchange roles in the config.";
    throw Exception(os.str().c_str());
}

ConstProcessorRcPtr Config::GetProcessorToBuiltinColorSpace(ConstConfigRcPtr srcConfig,
                                                            const char * srcColorSpaceName, 
                                                            const char * builtinColorSpaceName)
{
    return GetProcessorToBuiltinCS(srcConfig,
                                   srcColorSpaceName, 
                                   builtinColorSpaceName,
                                   TRANSFORM_DIR_FORWARD);
}

ConstProcessorRcPtr Config::GetProcessorFromBuiltinColorSpace(const char * builtinColorSpaceName,
                                                              ConstConfigRcPtr srcConfig,
                                                              const char * srcColorSpaceName)
{
    return GetProcessorToBuiltinCS(srcConfig,
                                   srcColorSpaceName, 
                                   builtinColorSpaceName,
                                   TRANSFORM_DIR_INVERSE);
}

///////////////////////////////////////////////////////////////////////////

std::ostream& operator<< (std::ostream& os, const Config& config)
{
    config.serialize(os);
    return os;
}

///////////////////////////////////////////////////////////////////////////
//  CacheID

const char * Config::getCacheID() const
{
    return getCacheID(getCurrentContext());
}

const char * Config::getCacheID(const ConstContextRcPtr & context) const
{
    AutoMutex lock(getImpl()->m_cacheidMutex);

    // A null context will use the empty cacheid
    std::string contextcacheid;
    if(context) contextcacheid = context->getCacheID();

    StringMap::const_iterator cacheiditer = getImpl()->m_cacheids.find(contextcacheid);
    if(cacheiditer != getImpl()->m_cacheids.end())
    {
        return cacheiditer->second.c_str();
    }

    // Include the hash of the yaml config serialization
    if(getImpl()->m_cacheidnocontext.empty())
    {
        std::ostringstream cacheid;
        serialize(cacheid);
        const std::string fullstr = cacheid.str();
        getImpl()->m_cacheidnocontext = CacheIDHash(fullstr.c_str(), fullstr.size());
    }

    // Also include all file references, using the context (if specified)
    std::string fileReferencesFastHash;
    if(context)
    {
        std::ostringstream filehash;

        ConstTransformVec allTransforms;
        getImpl()->getAllInternalTransforms(allTransforms);

        std::set<std::string> files;
        for(const auto & transform : allTransforms)
        {
            GetFileReferences(files, transform);
        }

        for(const auto & iter : files)
        {
            if(iter.empty()) continue;

            filehash << iter << "=";

            try
            {
                const std::string resolvedLocation = context->resolveFileLocation(iter.c_str());
                filehash << GetFastFileHash(resolvedLocation, *context) << " ";
            }
            catch(...)
            {
                filehash << "? ";
                continue;
            }
        }

        const std::string fullstr = filehash.str();
        fileReferencesFastHash = CacheIDHash(fullstr.c_str(), fullstr.size());
    }

    getImpl()->m_cacheids[contextcacheid] = getImpl()->m_cacheidnocontext + ":" + fileReferencesFastHash;
    return getImpl()->m_cacheids[contextcacheid].c_str();
}

///////////////////////////////////////////////////////////////////////////
//  Serialization

void Config::serialize(std::ostream& os) const
{
    try
    {
        getImpl()->checkVersionConsistency();

        OCIOYaml::Write(os, *this);
    }
    catch (const std::exception & e)
    {
        std::ostringstream error;
        error << "Error building YAML: " << e.what();
        throw Exception(error.str().c_str());
    }
}

ProcessorCacheFlags Config::getProcessorCacheFlags() const noexcept
{
    return getImpl()->getProcessorCacheFlags();
}

void Config::setProcessorCacheFlags(ProcessorCacheFlags flags) const noexcept
{
    getImpl()->setProcessorCacheFlags(flags);
}

void Config::clearProcessorCache() noexcept
{
    getImpl()->m_processorCache.clear();
}

///////////////////////////////////////////////////////////////////////////
//  Config::Impl

StringUtils::StringVec Config::Impl::buildInactiveNamesList(InactiveType type) const
{
    StringUtils::StringVec inactiveNames;

    // An API request always supersedes the other lists.
    if (!m_inactiveColorSpaceNamesAPI.empty())
    {
        inactiveNames = StringUtils::Split(m_inactiveColorSpaceNamesAPI, ',');
    }
    // The env. variable only supersedes the config list.
    else if (!m_inactiveColorSpaceNamesEnv.empty())
    {
        inactiveNames = StringUtils::Split(m_inactiveColorSpaceNamesEnv, ',');
    }
    else if (!m_inactiveColorSpaceNamesConf.empty())
    {
        inactiveNames = StringUtils::Split(m_inactiveColorSpaceNamesConf, ',');
    }

    StringUtils::StringVec res;
    for (auto & v : inactiveNames)
    {
        v = StringUtils::Trim(v);
        switch (type)
        {
        case INACTIVE_COLORSPACE:
        {
            const auto & cs = getColorSpace(v.c_str());
            // Only add existing items.
            if (cs)
            {
                // Use the canonical name (alias or role might have been used).
                res.push_back(cs->getName());
            }
            break;
        }
        case INACTIVE_NAMEDTRANSFORM:
        {
            const auto & nt = getNamedTransform(v.c_str());
            // Only add existing items.
            if (nt)
            {
                // Use the canonical name (alias might have been used).
                res.push_back(nt->getName());
            }
            break;
        }
        case INACTIVE_ALL:
        {
            // This is only used to verify that all items of the list do exists (only used by the
            // validate() function.
            res.push_back(v);
            break;
        }
        }
    }

    return res;
}

void Config::Impl::refreshActiveColorSpaces()
{
    m_activeColorSpaceNames.clear();
    m_activeNamedTransformNames.clear();

    m_inactiveColorSpaceNames = buildInactiveNamesList(Impl::INACTIVE_COLORSPACE);

    for (int i = 0; i < m_allColorSpaces->getNumColorSpaces(); ++i)
    {
        ConstColorSpaceRcPtr cs = m_allColorSpaces->getColorSpaceByIndex(i);
        const std::string name(cs->getName());

        bool isActive = true;

        for (const auto & csName : m_inactiveColorSpaceNames)
        {
            if (csName==name)
            {
                isActive = false;
                break;
            }
        }

        if (isActive)
        {
            m_activeColorSpaceNames.push_back(cs->getName());
        }
    }

    m_inactiveNamedTransformNames = buildInactiveNamesList(Impl::INACTIVE_NAMEDTRANSFORM);

    for (const auto & nt : m_allNamedTransforms)
    {
        const std::string name(nt->getName());

        bool isActive = true;

        for (const auto & csName : m_inactiveNamedTransformNames)
        {
            if (csName == name)
            {
                isActive = false;
                break;
            }
        }

        if (isActive)
        {
            m_activeNamedTransformNames.push_back(nt->getName());
        }
    }
}

void Config::Impl::resetCacheIDs()
{
    m_cacheids.clear();
    m_cacheidnocontext = "";
    m_validation = VALIDATION_UNKNOWN;
    m_validationtext = "";

    // As any changes could impact the cache keys, it's better to always flush the cache
    // of processors to not keep in memory useless instances.
    m_processorCache.clear();
}

void Config::Impl::getAllInternalTransforms(ConstTransformVec & transformVec) const
{
    // Grab all transforms from the ColorSpaces.

    for (int i = 0; i < m_allColorSpaces->getNumColorSpaces(); ++i)
    {
        ConstTransformRcPtr tr
            = m_allColorSpaces->getColorSpaceByIndex(i)->getTransform(COLORSPACE_DIR_TO_REFERENCE);
        if (tr)
        {
            transformVec.push_back(tr);
        }

        tr = m_allColorSpaces->getColorSpaceByIndex(i)->getTransform(COLORSPACE_DIR_FROM_REFERENCE);
        if (tr)
        {
            transformVec.push_back(tr);
        }
    }

    // Grab all transforms from the Looks.

    for (const auto & look : m_looksList)
    {
        ConstTransformRcPtr tr = look->getTransform();
        if (tr)
        {
            transformVec.push_back(tr);
        }

        tr = look->getInverseTransform();
        if (tr)
        {
            transformVec.push_back(tr);
        }
    }

    // Grab all transforms from the view transforms.

    for (const auto & vt : m_viewTransforms)
    {
        ConstTransformRcPtr tr = vt->getTransform(VIEWTRANSFORM_DIR_TO_REFERENCE);
        if (tr)
        {
            transformVec.push_back(tr);
        }

        tr = vt->getTransform(VIEWTRANSFORM_DIR_FROM_REFERENCE);
        if (tr)
        {
            transformVec.push_back(tr);
        }
    }

    // Grab all transforms from the named transforms.

    for (const auto & nt : m_allNamedTransforms)
    {
        ConstTransformRcPtr tr = nt->getTransform(TRANSFORM_DIR_FORWARD);
        if (tr)
        {
            transformVec.push_back(tr);
        }

        tr = nt->getTransform(TRANSFORM_DIR_INVERSE);
        if (tr)
        {
            transformVec.push_back(tr);
        }
    }
}

ConstConfigRcPtr Config::Impl::Read(std::istream & istream, const char * filename)
{
    ConfigRcPtr config = Config::Create();
    OCIOYaml::Read(istream, config, filename);

    config->getImpl()->checkVersionConsistency();

    // An API request always supersedes the env. variable. As the OCIOYaml helper methods
    // use the Config public API, the variable reset highlights that only the
    // env. variable and the config contents are valid after a config file read.
    config->getImpl()->m_inactiveColorSpaceNamesAPI.clear();
    config->getImpl()->refreshActiveColorSpaces();

    return config;
}

ConstConfigRcPtr Config::Impl::Read(std::istream & istream, ConfigIOProxyRcPtr ciop)
{
    ConfigRcPtr config = Config::Create();
    // Passing special string for the file path to enable the parser to provide a more
    // meaningful error message if a problem is encountered.  (The working directory is not
    // set to this string.)
    OCIOYaml::Read(istream, config, "from Archive/ConfigIOProxy");

    config->getImpl()->checkVersionConsistency();

    // An API request always supersedes the env. variable. As the OCIOYaml helper methods
    // use the Config public API, the variable reset highlights that only the
    // env. variable and the config contents are valid after a config file read.
    config->getImpl()->m_inactiveColorSpaceNamesAPI.clear();
    config->getImpl()->refreshActiveColorSpaces();

    // Set the ConfigIOProxy object.
    config->setConfigIOProxy(ciop);

    return config;
}

void Config::Impl::checkVersionConsistency(ConstTransformRcPtr & transform) const
{
    if (transform)
    {
        if (ConstBuiltinTransformRcPtr blt = DynamicPtrCast<const BuiltinTransform>(transform))
        {
            if (m_majorVersion < 2)
            {
                throw Exception("Only config version 2 (or higher) can have BuiltinInTransform.");
            }

            if (m_majorVersion == 2 && m_minorVersion < 1
                    && 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-LMT - ACES 1.3 Reference Gamut Compression"))
            {
                throw Exception("Only config version 2.1 (or higher) can have "
                                "BuiltinTransform style 'ACES-LMT - ACES 1.3 Reference Gamut Compression'.");
            }
            if (m_majorVersion == 2 && m_minorVersion < 2 
                    && (   0 == Platform::Strcasecmp(blt->getStyle(), "ARRI_LOGC4_to_ACES2065-1")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "CURVE - CANON_CLOG2_to_LINEAR")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "CURVE - CANON_CLOG3_to_LINEAR") )
                )
            {
                std::ostringstream os;
                os << "Only config version 2.2 (or higher) can have BuiltinTransform style '"
                   << blt->getStyle() << "'.";
                throw Exception(os.str().c_str());
            }
            if (m_majorVersion == 2 && m_minorVersion < 3
                    && 0 == Platform::Strcasecmp(blt->getStyle(), "DISPLAY - CIE-XYZ-D65_to_DisplayP3"))
            {
                throw Exception("Only config version 2.3 (or higher) can have "
                                "BuiltinTransform style 'DISPLAY - CIE-XYZ-D65_to_DisplayP3'.");
            }
            if (m_majorVersion == 2 && m_minorVersion < 4 
                    && (   0 == Platform::Strcasecmp(blt->getStyle(), "APPLE_LOG_to_ACES2065-1")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "CURVE - APPLE_LOG_to_LINEAR")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "CURVE - HLG-OETF")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "CURVE - HLG-OETF-INVERSE")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "DISPLAY - CIE-XYZ-D65_to_DCDM-D65")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "DISPLAY - CIE-XYZ-D65_to_ST2084-DCDM-D65")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - SDR-100nit-REC709_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - SDR-100nit-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-108nit-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-300nit-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-500nit-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-1000nit-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-2000nit-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-4000nit-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-500nit-REC2020_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-1000nit-REC2020_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-2000nit-REC2020_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-4000nit-REC2020_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - SDR-100nit-REC709-D60-in-REC709-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - SDR-100nit-REC709-D60-in-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - SDR-100nit-REC709-D60-in-REC2020-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - SDR-100nit-P3-D60-in-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - SDR-100nit-P3-D60-in-XYZ-E_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-108nit-P3-D60-in-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-300nit-P3-D60-in-XYZ-E_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-500nit-P3-D60-in-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-1000nit-P3-D60-in-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-2000nit-P3-D60-in-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-4000nit-P3-D60-in-P3-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-500nit-P3-D60-in-REC2020-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-1000nit-P3-D60-in-REC2020-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-2000nit-P3-D60-in-REC2020-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-4000nit-P3-D60-in-REC2020-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-500nit-REC2020-D60-in-REC2020-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-1000nit-REC2020-D60-in-REC2020-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-2000nit-REC2020-D60-in-REC2020-D65_2.0")
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "ACES-OUTPUT - ACES2065-1_to_CIE-XYZ-D65 - HDR-4000nit-REC2020-D60-in-REC2020-D65_2.0")
                        // NB: This one was added in OCIO 2.4.1.
                        || 0 == Platform::Strcasecmp(blt->getStyle(), "DISPLAY - CIE-XYZ-D65_to_DisplayP3-HDR") )
                )
            {
                std::ostringstream os;
                os << "Only config version 2.4 (or higher) can have BuiltinTransform style '"
                   << blt->getStyle() << "'.";
                throw Exception(os.str().c_str());
            }
        }
        else if (ConstCDLTransformRcPtr cdl = DynamicPtrCast<const CDLTransform>(transform))
        {
            if (m_majorVersion < 2 && cdl->getStyle() != CDL_TRANSFORM_DEFAULT)
            {
                throw Exception("Only config version 2 (or higher) can have style for "
                                "CDLTransform.");
            }
        }
        else if (DynamicPtrCast<const DisplayViewTransform>(transform))
        {
            if (m_majorVersion < 2)
            {
                throw Exception("Only config version 2 (or higher) can have DisplayViewTransform.");
            }
        }
        else if (ConstExponentTransformRcPtr ex =
                 DynamicPtrCast<const ExponentTransform>(transform))
        {
            if (m_majorVersion < 2 && ex->getNegativeStyle() != NEGATIVE_CLAMP)
            {
                throw Exception("Config version 1 only supports ExponentTransform clamping "
                                "negative values.");
            }
        }
        else if (DynamicPtrCast<const ExponentWithLinearTransform>(transform))
        {
            if (m_majorVersion < 2)
            {
                throw Exception("Only config version 2 (or higher) can have "
                                "ExponentWithLinearTransform.");
            }
        }
        else if (DynamicPtrCast<const ExposureContrastTransform>(transform))
        {
            if (m_majorVersion < 2)
            {
                throw Exception("Only config version 2 (or higher) can have "
                                "ExposureContrastTransform.");
            }
        }
        else if (ConstFileTransformRcPtr ft = DynamicPtrCast<const FileTransform>(transform))
        {
            if (m_majorVersion < 2)
            {
                if (ft->getInterpolation() == INTERP_CUBIC)
                {
                    throw Exception("Only config version 2 (or higher) can use 'cubic' "
                                    "interpolation with FileTransform.");
                }
                if (ft->getCDLStyle() != CDL_TRANSFORM_DEFAULT)
                {
                    throw Exception("Only config version 2 (or higher) can use CDL style' "
                                    "for FileTransform.");
                }
            }
        }
        else if (ConstFixedFunctionTransformRcPtr ff = DynamicPtrCast<const FixedFunctionTransform>(transform))
        {
            auto ffstyle = ff->getStyle();
            if (m_majorVersion < 2)
            {
                throw Exception("Only config version 2 (or higher) can have "
                                "FixedFunctionTransform.");
            }

            if (m_majorVersion == 2 && m_minorVersion < 1 && ffstyle == FIXED_FUNCTION_ACES_GAMUT_COMP_13)
            {
                throw Exception("Only config version 2.1 (or higher) can have "
                                "FixedFunctionTransform style 'ACES_GAMUT_COMP_13'.");
            }

            if (m_majorVersion == 2 && m_minorVersion < 4 )
            {
                if( ffstyle == FIXED_FUNCTION_LIN_TO_PQ  || 
                    ffstyle == FIXED_FUNCTION_LIN_TO_GAMMA_LOG || 
                    ffstyle == FIXED_FUNCTION_LIN_TO_DOUBLE_LOG ||
                    ffstyle == FIXED_FUNCTION_ACES_OUTPUT_TRANSFORM_20 ||
                    ffstyle == FIXED_FUNCTION_ACES_RGB_TO_JMH_20 ||
                    ffstyle == FIXED_FUNCTION_ACES_TONESCALE_COMPRESS_20 ||
                    ffstyle == FIXED_FUNCTION_ACES_GAMUT_COMPRESS_20 )
                {
                    std::ostringstream ss;
                    ss << "Only config version 2.4 (or higher) can have FixedFunctionTransform style '" 
                       << FixedFunctionStyleToString(ffstyle) << "'.";
                    throw Exception(ss.str().c_str());
                }
            }

            if (m_majorVersion == 2 && m_minorVersion < 5 )
            {
                if( ffstyle == FIXED_FUNCTION_RGB_TO_HSY_LIN  || 
                    ffstyle == FIXED_FUNCTION_RGB_TO_HSY_LOG ||
                    ffstyle == FIXED_FUNCTION_RGB_TO_HSY_VID )
                {
                    std::ostringstream ss;
                    ss << "Only config version 2.5 (or higher) can have FixedFunctionTransform style '" 
                       << FixedFunctionStyleToString(ffstyle) << "'.";
                    throw Exception(ss.str().c_str());
                }
            }
        }
        else if (DynamicPtrCast<const GradingPrimaryTransform>(transform))
        {
            if (m_majorVersion < 2)
            {
                throw Exception("Only config version 2 (or higher) can have "
                                "GradingPrimaryTransform.");
            }
        }
        else if (DynamicPtrCast<const GradingRGBCurveTransform>(transform))
        {
            if (m_majorVersion < 2)
            {
                throw Exception("Only config version 2 (or higher) can have "
                                "GradingRGBCurveTransform.");
            }
        }
        else if (DynamicPtrCast<const GradingHueCurveTransform>(transform))
        {
            if (m_majorVersion == 2 && m_minorVersion < 5 )
            {
                throw Exception("Only config version 2.5 (or higher) can have "
                                "GradingHueCurveTransform.");
            }
        }
        else if (DynamicPtrCast<const GradingToneTransform>(transform))
        {
            if (m_majorVersion < 2)
            {
                throw Exception("Only config version 2 (or higher) can have "
                                "GradingToneTransform.");
            }
        }
        else if (DynamicPtrCast<const LogAffineTransform>(transform))
        {
            if (m_majorVersion < 2)
            {
                throw Exception("Only config version 2 (or higher) can have LogAffineTransform.");
            }
        }
        else if (DynamicPtrCast<const LogCameraTransform>(transform))
        {
            if (m_majorVersion < 2)
            {
                throw Exception("Only config version 2 (or higher) can have LogCameraTransform.");
            }
        }
        else if (DynamicPtrCast<const RangeTransform>(transform))
        {
            if (m_majorVersion < 2)
            {
                throw Exception("Only config version 2 (or higher) can have RangeTransform.");
            }
        }
        else if (ConstGroupTransformRcPtr grp = DynamicPtrCast<const GroupTransform>(transform))
        {
            const int numTransforms = grp->getNumTransforms();
            for (int idx = 0; idx < numTransforms; ++idx)
            {
                ConstTransformRcPtr tr = grp->getTransform(idx);
                checkVersionConsistency(tr);
            }
        }
    }
}

void Config::Impl::checkVersionConsistency() const
{
    unsigned int hexVersion = (m_majorVersion << 24) | (m_minorVersion << 16);

    // Check for the Transforms.

    ConstTransformVec transforms;
    getAllInternalTransforms(transforms);

    for (auto & transform : transforms)
    {
        checkVersionConsistency(transform);
    }

    // Check for the family separator.

    if (m_majorVersion < 2 && m_familySeparator != '/')
    {
        throw Exception("Only version 2 (or higher) can have a family separator.");
    }

    // Check for the file rules.

    if (m_majorVersion < 2 && m_fileRules->getNumEntries() > 2)
    {
        throw Exception("Only version 2 (or higher) can have file rules.");
    }

    // Check for inactive color spaces.

    if (m_majorVersion < 2 && !m_inactiveColorSpaceNamesConf.empty())
    {
        throw Exception("Only version 2 (or higher) can have inactive color spaces.");
    }

    // Check for ViewingRules.

    if (m_majorVersion < 2 && m_viewingRules->getNumEntries() != 0)
    {
        throw Exception("Only version 2 (or higher) can have viewing rules.");
    }

    // Check for shared views.

    if (m_majorVersion < 2)
    {
        if (m_sharedViews.size() != 0)
        {
            throw Exception("Only version 2 (or higher) can have shared views.");
        }
        for (const auto & display : m_displays)
        {
            const StringUtils::StringVec & sharedViews = display.second.m_sharedViews;
            if (!sharedViews.empty())
            {
                std::ostringstream os;
                os << "Config failed validation. The display '" << display.first << "' ";
                os << "uses shared views and config version is less than 2.";
                throw Exception(os.str().c_str());
            }
        }
    }

    // Check for virtual display.

    if (m_majorVersion < 2)
    {
        if (m_virtualDisplay.m_views.size() != 0 || m_virtualDisplay.m_sharedViews.size() != 0)
        {
            throw Exception("Only version 2 (or higher) can have a virtual display.");
        }
    }

    // Check ColorSpace properties.

    const int nbCS = m_allColorSpaces->getNumColorSpaces();
    for (int i = 0; i < nbCS; ++i)
    {
        // Check for display color spaces.

        const auto & cs = m_allColorSpaces->getColorSpaceByIndex(i);
        if (m_majorVersion < 2) 
        {
            if (MatchReferenceType(SEARCH_REFERENCE_SPACE_DISPLAY, cs->getReferenceSpaceType())) 
            {
                throw Exception("Only version 2 (or higher) can have DisplayColorSpaces.");
            }
        } 

        // Check for new color space attributes.

        if (m_majorVersion < 2) 
        {
            if (*cs->getInteropID())
            {
                std::ostringstream os;
                os << "Config failed validation. The color space '" << cs->getName() << "' ";
                os << "has non-empty InteropID and config version is less than 2.0.";
                throw Exception(os.str().c_str());
            }
        }

        if (hexVersion < 0x02050000) 
        {
            if (cs->getInterchangeAttributes().size()>0)
            {
                std::ostringstream os;
                os << "Config failed validation. The color space '" << cs->getName() << "' ";
                os << "has non-empty interchange attributes and config version is less than 2.5.";
                throw Exception(os.str().c_str());
            }
        }
    }

    // Check for the ViewTransforms.

    if (m_majorVersion < 2 && (m_viewTransforms.size() != 0 || !m_defaultViewTransform.empty()))
    {
        throw Exception("Only version 2 (or higher) can have ViewTransforms.");
    }

    // Check for new ViewTransform properties.

    if (hexVersion < 0x02050000) 
    {
        for (const auto& vt : m_viewTransforms)
        {
            if (vt->getInterchangeAttributes().size()>0)
            {
                std::ostringstream os;
                os << "Config failed validation. The view transform '" << vt->getName() << "' ";
                os << "has non-empty interchange attributes and config version is less than 2.5.";
                throw Exception(os.str().c_str());
            }
        }
    }

    // Check for new Look properties.

    if (hexVersion < 0x02050000) 
    {
        for (const auto& look : m_looksList)
        {
            if (look->getInterchangeAttributes().size()>0)
            {
                std::ostringstream os;
                os << "Config failed validation. The look '" << look->getName() << "' ";
                os << "has non-empty interchange attributes and config version is less than 2.5.";
                throw Exception(os.str().c_str());
            }
        }
    }

    // Check for the NamedTransforms.

    if (m_majorVersion < 2 && m_allNamedTransforms.size() != 0)
    {
        throw Exception("Only version 2 (or higher) can have NamedTransforms.");
    }
}

void Config::setConfigIOProxy(ConfigIOProxyRcPtr ciop)
{
    getImpl()->m_context->setConfigIOProxy(ciop);

    AutoMutex lock(getImpl()->m_cacheidMutex);
    getImpl()->resetCacheIDs();
}

ConfigIOProxyRcPtr Config::getConfigIOProxy() const
{
    return getImpl()->m_context->getConfigIOProxy();
}

bool Config::isArchivable() const
{
    ConstContextRcPtr context = getCurrentContext();

    // Current archive implementation needs a working directory to look for LUT files and 
    // working directory must be an absolute path.
    const char * workingDirectory = getWorkingDir();
    if ((workingDirectory && !workingDirectory[0]) || !pystring::os::path::isabs(workingDirectory))
    {
        return false;
    }

    // Utility lambda to check the following criteria.
    auto validatePathForArchiving = [](const std::string & path) 
    {
        // Using the normalized path.
        const std::string normPath = pystring::os::path::normpath(path);
        if (    
                // 1) Path may not be absolute.
                pystring::os::path::isabs(normPath)  || 
                // 2) Path may not start with double dot ".." (going above working directory).
                pystring::startswith(normPath, "..") ||
                // 3) A context variable may not be located at the start of the path.
                (ContainsContextVariables(path) && 
                (StringUtils::Find(path, "$") == 0 || 
                 StringUtils::Find(path, "%") == 0)))
        {
            return false;
        }

        return true;
    };

    ///////////////////////////////
    // Search path verification. //
    ///////////////////////////////
    // Check that search paths are not absolute nor have context variables outside of config 
    // working directory.
    int numSearchPaths = getNumSearchPaths();
    for (int i = 0; i < numSearchPaths; i++)
    {
        std::string currentPath = getSearchPath(i);
        if (!validatePathForArchiving(currentPath))
        {
            // Exit and return false.
            return false;
        }
    }

    /////////////////////////////////
    // FileTransform verification. //
    /////////////////////////////////
    ConstTransformVec allTransforms;
    getImpl()->getAllInternalTransforms(allTransforms);

    std::set<std::string> files;
    for(const auto & transform : allTransforms)
    {
        GetFileReferences(files, transform);
    }

    // Check that FileTransform sources are not absolute nor have context variables outside of 
    // config working directory.
    for (const auto & path : files)
    {
        if (!validatePathForArchiving(path))
        {
            // Exit and return false.
            return false;
        }
    }

    return true;
}

void Config::archive(std::ostream & ostream) const
{
    // Using utility functions in OCIOZArchive.cpp.
    archiveConfig(ostream, *this, getCurrentContext()->getWorkingDir());
}

} // namespace OCIO_NAMESPACE