ofxsSupportPrivate.h

Go to the documentation of this file.

/*
OFX Support Library, a library that skins the OFX plug-in API with C++ classes.
Copyright (C) 2004-2005 The Foundry Visionmongers Ltd
Author Bruno Nicoletti bruno@thefoundry.co.uk

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name The Foundry Visionmongers Ltd, nor the names of its 
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The Foundry Visionmongers Ltd
1 Wardour St
London W1D 6PA
England



*/

#ifndef _ofxsSupportPrivate_H_
#define _ofxsSupportPrivate_H_

#include "ofxsInteract.h"
#include "ofxsImageEffect.h"
#include "ofxsLog.h"
#include "ofxsMultiThread.h"

namespace OFX {

  FieldEnum mapStrToFieldEnum(const std::string &str)  throw(std::invalid_argument);


  ContextEnum mapToContextEnum(const std::string &s) throw(std::invalid_argument);

  namespace Private {
    extern OfxHost *gHost;

    extern OfxImageEffectSuiteV1 *gEffectSuite;

    extern OfxPropertySuiteV1    *gPropSuite;

    extern OfxInteractSuiteV1    *gInteractSuite;

    extern OfxParameterSuiteV1   *gParamSuite;

    extern OfxMemorySuiteV1      *gMemorySuite;

    extern OfxMultiThreadSuiteV1 *gThreadSuite;

    extern OfxMessageSuiteV1     *gMessageSuite;

    extern OfxProgressSuiteV1     *gProgressSuite;

    extern OfxTimeLineSuiteV1     *gTimeLineSuite;

    void loadAction(void);

    void unloadAction(void);

    void setHost(OfxHost *host);

    ImageEffect *retrieveImageEffectPointer(OfxImageEffectHandle handle);

    OFX::PropertySet
      fetchEffectProps(OfxImageEffectHandle handle);

    typedef std::map<ContextEnum, ImageEffectDescriptor*> EffectContextMap;
    typedef std::map<std::string, EffectContextMap> EffectDescriptorMap;
    extern EffectDescriptorMap gEffectDescriptors;
  };

  namespace Validation {

    struct ValueHolder {
      std::string  vString;
      int    vInt;
      double vDouble;
      void  *vPointer;

      ValueHolder(void) {}
      ValueHolder(char  *s) : vString(s) {}
      ValueHolder(const std::string &s) : vString(s) {}
      ValueHolder(int    i) : vInt(i) {}
      ValueHolder(double d) : vDouble(d) {}
      ValueHolder(void  *p) : vPointer(p) {}

      ValueHolder &operator = (char *v)  {vString = v; return *this;}
      ValueHolder &operator = (std::string v)  {vString = v; return *this;}
      ValueHolder &operator = (void *v)  {vPointer = v; return *this;}
      ValueHolder &operator = (int v)    {vInt = v; return *this;}
      ValueHolder &operator = (double v) {vDouble = v; return *this;}

      operator const char * () {return vString.c_str();}
      operator std::string &() {return vString;}
      operator int    &() {return vInt;}
      operator double &() {return vDouble;}
      operator void * &() {return vPointer;}
    };

    enum DescriptionTag {
      eDescDefault,  
      eDescFinished  
    };

    class PropertyDescription
    {
    public :
      std::string _name;

      bool _exists;

      int      _dimension;

      OFX::PropertyTypeEnum _ilk;

      std::vector<ValueHolder> _defaultValue; 

    public :
      PropertyDescription(char *name, OFX::PropertyTypeEnum ilk, int dimension, ...);

      virtual ~PropertyDescription(void) {}

      void validate(bool checkDefaults, PropertySet &propSet);
    };

    class PropertySetDescription {
    protected :
      std::string           _setName;

      std::vector<PropertyDescription *> _descriptions;

      std::vector<PropertyDescription *> _deleteThese;

    public :
      PropertySetDescription(char *setName, ...);// [PropertyDescription *v, int nSetToThese]

      virtual ~PropertySetDescription();

      void addProperty(PropertyDescription *desc, bool deleteOnDestruction = true);

      void validate(PropertySet &propSet, bool checkDefaults = true, bool logOrdinaryMessages = false); 
    };


    void
      validateHostProperties(OfxHost *host);

    void
      validatePluginDescriptorProperties(PropertySet props);

    void
      validatePluginInstanceProperties(PropertySet props);

    void
      validateClipDescriptorProperties(PropertySet props);

    void
      validateClipInstanceProperties(PropertySet props);

    void
      validateImageProperties(PropertySet props);

    void
      validateActionArgumentsProperties(const std::string &action, PropertySet inArgs, PropertySet outArgs);

    void
      validateParameterProperties(ParamTypeEnum paramType, 
      OFX::PropertySet paramProps,
      bool checkDefaults);

    void initialise(void);
  };

};

#endif

---