ofxsCore.h

Go to the documentation of this file.

#ifndef _ofxsCore_H_
#define _ofxsCore_H_
/*
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



*/


#ifdef _MSC_VER
#pragma warning( disable : 4290 )
#endif

#include "ofxCore.h"
#include "ofxImageEffect.h"
#include "ofxInteract.h"
#include "ofxKeySyms.h"
#include "ofxMemory.h"
#include "ofxMessage.h"
#include "ofxMultiThread.h"
#include "ofxParam.h"
#include "ofxProperty.h"

#include <assert.h>
#include <vector>
#include <string>
#include <map>
#include <exception>
#include <stdexcept>
#include <sstream>

#ifdef OFX_CLIENT_EXCEPTION_HEADER
#include OFX_CLIENT_EXCEPTION_HEADER
#endif

struct OfxRGBColourB {
  unsigned char r, g, b;
};

struct OfxRGBColourS {
  unsigned short r, g, b;
};

struct OfxRGBColourF {
  float r, g, b;
};

struct OfxRGBColourD {
  double r, g, b;
};

struct Ofx3DPointI {
  int x, y, z;
};

struct Ofx3DPointD {
  double x, y, z;
};

#define mDeclareProtectedAssignAndCC(CLASS) \
  CLASS &operator=(const CLASS &v1) {assert(false); return *this;}      \
  CLASS(const CLASS &v) {assert(false); } 

namespace OFX {
  class PropertySet;

  enum PropertyTypeEnum {
    ePointer,
    eInt,
    eString,
    eDouble
  };

  enum InstanceChangeReason {
    eChangeUserEdit,    
    eChangePluginEdit,  
    eChangeTime         
  };

  char * mapStatusToString(OfxStatus stat);

  namespace Exception {

    class Suite : public std::exception {
    protected :
      OfxStatus _status;
    public :
      Suite(OfxStatus s) : _status(s) {}
      OfxStatus status(void) {return _status;}
      operator OfxStatus() {return _status;}

      virtual const char * what () const throw () {return mapStatusToString(_status);}

    };

    class PropertyUnknownToHost : public std::exception {
    protected :
      std::string _what;
    public :
      PropertyUnknownToHost(const char *what) : _what(what) {}
      virtual ~PropertyUnknownToHost() throw() {}

      virtual const char * what () const throw ()
      {
        return _what.c_str();
      }
    };

    class PropertyValueIllegalToHost : public std::exception {
    protected :
      std::string _what;
    public :
      PropertyValueIllegalToHost(const char *what) : _what(what) {}
      virtual ~PropertyValueIllegalToHost() throw() {}

      virtual const char * what () const throw ()
      {
        return _what.c_str();
      }
    };

    class TypeRequest : public std::exception {
    protected :
      std::string _what;
    public :
      TypeRequest(const char *what) : _what(what) {}
      virtual ~TypeRequest() throw() {}

      virtual const char * what () const throw ()
      {
        return _what.c_str();
      }
    };

    // These exceptions are to be thrown by the plugin if it hits a problem, the
    // code managing the main entry will trap the exception and return a suitable 
    // status code to the host.

    class HostInadequate : public std::exception {
    protected :
      std::string _what;
    public :
      HostInadequate(char *what) : _what(what) {}
      virtual ~HostInadequate() throw() {}

      virtual const char * what () const throw ()
      {
        return _what.c_str();
      }
    };

  }; // end of Exception namespace

  void 
    throwSuiteStatusException(OfxStatus stat) 
    throw(OFX::Exception::Suite, std::bad_alloc);

  void 
    throwHostMissingSuiteException(std::string name) 
    throw(OFX::Exception::Suite);

  class ImageEffectDescriptor;
  class ImageEffect;

  class PropertySet {
  protected :
    OfxPropertySetHandle _propHandle;

    static int _gPropLogging;

    static bool _gThrowOnUnsupported;

  public :
    static void propEnableLogging(void)  {++_gPropLogging;}

    static void propDisableLogging(void) {--_gPropLogging;}

    static void setThrowOnUnsupportedProperties(bool v) {_gThrowOnUnsupported = v;}

    static bool getThrowOnUnsupportedProperties(void) {return _gThrowOnUnsupported;}

    PropertySet(OfxPropertySetHandle h = 0) : _propHandle(h) {}
    virtual ~PropertySet();

    void propSetHandle(OfxPropertySetHandle h) { _propHandle = h;}

    OfxPropertySetHandle propSetHandle(void) {return _propHandle;}

    int  propGetDimension(const char* property, bool throwOnFailure = true) const throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite);
    void propReset(const char* property) throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost,
      OFX::Exception::Suite);

    // set single values
    void propSetPointer(const char* property, void *value, int idx, bool throwOnFailure = true) throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite);
    void propSetString(const char* property, const std::string &value, int idx, bool throwOnFailure = true) throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite);
    void propSetDouble(const char* property, double value, int idx, bool throwOnFailure = true) throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite);
    void propSetInt(const char* property, int value, int idx, bool throwOnFailure = true) throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite);

    void propSetPointer(const char* property, void *value, bool throwOnFailure = true) throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite)
    {propSetPointer(property, value, 0, throwOnFailure);}

    void propSetString(const char* property, const std::string &value, bool throwOnFailure = true) throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite)
    {propSetString(property, value, 0, throwOnFailure);}

    void propSetDouble(const char* property, double value, bool throwOnFailure = true) throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite)
    {propSetDouble(property, value, 0, throwOnFailure);}

    void propSetInt(const char* property, int value, bool throwOnFailure = true) throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite)
    {propSetInt(property, value, 0, throwOnFailure);}


    void       *propGetPointer(const char* property, int idx, bool throwOnFailure = true) const throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite);

    std::string propGetString(const char* property, int idx, bool throwOnFailure = true) const throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite);
    double      propGetDouble(const char* property, int idx, bool throwOnFailure = true) const throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite);

    int propGetInt(const char* property, int idx, bool throwOnFailure = true) const throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite);

    void* propGetPointer(const char* property, bool throwOnFailure = true) const throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite)
    {
      return propGetPointer(property, 0, throwOnFailure); 
    }

    std::string propGetString(const char* property, bool throwOnFailure = true) const throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite)
    {
      return propGetString(property, 0, throwOnFailure); 
    }

    double propGetDouble(const char* property, bool throwOnFailure = true) const throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite)
    {
      return propGetDouble(property, 0, throwOnFailure); 
    }

    int propGetInt(const char* property, bool throwOnFailure = true) const throw(std::bad_alloc, 
      OFX::Exception::PropertyUnknownToHost, 
      OFX::Exception::PropertyValueIllegalToHost, 
      OFX::Exception::Suite)
    {
      return propGetInt(property, 0, throwOnFailure); 
    }
  };

  // forward decl of the image effect
  class ImageEffect;

  namespace Memory {
    void *alloc(size_t nBytes,
      ImageEffect *handle = 0) throw(std::bad_alloc);

    void free(void *ptr) throw();

  };
};

// undeclare the protected assign and CC macro
#undef mDeclareProtectedAssignAndCC

#endif

---