Add kOfxImageEffectPluginPropObsolete for issue #221

include/ofxImageEffect.h

@@ -942,6 +942,19 @@ This is purely a user interface hint for the host so it can group related effect
 */
 #define kOfxImageEffectPluginPropGrouping "OfxImageEffectPluginPropGrouping"
 
+/** @brief Indicates whether the plugin should be hidden in the host's OFX browser UI.
+
+If set to 1, this indicates the plugin has been made obsolete by a different version of the same plugin contained in the same bundle (i.e. same pluginIdentifier but different pluginVersionMajor and/or pluginVersionMinor). At least one version of the plugin in the bundle (typically the newest) must have this property omitted or set to 0.
+
+   - Valid Values -
+       - 0 - the host will show the plugin in its OFX browser UI,
+       - 1 - the host will not show the plugin in its OFX browser UI.
+    @propdef
+    type: bool
+    dimension: 1
+*/
+#define kOfxImageEffectPluginPropObsolete "OfxImageEffectPluginPropObsolete"
+
 /** @brief Indicates whether a host support image effect \ref ImageEffectOverlays.
 
    - Valid Values - This must be one of
@@ -2046,6 +2059,7 @@ They range from 1000 until 1999
       - OfxPropPluginDescription | host_optional=true
       - OfxImageEffectPropSupportedContexts
       - OfxImageEffectPluginPropGrouping
+      - OfxImageEffectPluginPropObsolete
       - OfxImageEffectPluginPropSingleInstance
       - OfxImageEffectPluginRenderThreadSafety
       - OfxImageEffectPluginPropHostFrameThreading

openfx-cpp/include/openfx/ofxPropSetAccessors.h

@@ -408,6 +408,11 @@ class EffectDescriptor : public PropertySetAccessor {
         return *this;
     }
 
+    EffectDescriptor& setImageEffectPluginPropObsolete(bool value, bool error_if_missing = true) {
+        props_.set<PropId::OfxImageEffectPluginPropObsolete>(value, 0, error_if_missing);
+        return *this;
+    }
+
     EffectDescriptor& setImageEffectPluginPropSingleInstance(bool value, bool error_if_missing = true) {
         props_.set<PropId::OfxImageEffectPluginPropSingleInstance>(value, 0, error_if_missing);
         return *this;

openfx-cpp/include/openfx/ofxPropSetAccessorsHost.h

@@ -427,6 +427,10 @@ class EffectDescriptor : public PropertySetAccessor {
         return props_.get<PropId::OfxImageEffectPluginPropGrouping>(0, error_if_missing);
     }
 
+    bool imageEffectPluginPropObsolete(bool error_if_missing = true) const {
+        return props_.get<PropId::OfxImageEffectPluginPropObsolete>(0, error_if_missing);
+    }
+
     bool imageEffectPluginPropSingleInstance(bool error_if_missing = true) const {
         return props_.get<PropId::OfxImageEffectPluginPropSingleInstance>(0, error_if_missing);
     }

openfx-cpp/include/openfx/ofxPropsBySet.h

@@ -84,6 +84,7 @@ static inline const std::map<const char *, std::vector<Prop>> prop_sets {
    { "OfxPropPluginDescription", prop_defs[PropId::OfxPropPluginDescription], false, true, true },
    { "OfxImageEffectPropSupportedContexts", prop_defs[PropId::OfxImageEffectPropSupportedContexts], false, true, false },
    { "OfxImageEffectPluginPropGrouping", prop_defs[PropId::OfxImageEffectPluginPropGrouping], false, true, false },
+   { "OfxImageEffectPluginPropObsolete", prop_defs[PropId::OfxImageEffectPluginPropObsolete], false, true, false },
    { "OfxImageEffectPluginPropSingleInstance", prop_defs[PropId::OfxImageEffectPluginPropSingleInstance], false, true, false },
    { "OfxImageEffectPluginRenderThreadSafety", prop_defs[PropId::OfxImageEffectPluginRenderThreadSafety], false, true, false },
    { "OfxImageEffectPluginPropHostFrameThreading", prop_defs[PropId::OfxImageEffectPluginPropHostFrameThreading], false, true, false },