ofxCore.h

Go to the documentation of this file.

#ifndef _ofxCore_h_
#define _ofxCore_h_

/*
Software License :

Copyright (c) 2003-2004, The Foundry Visionmongers Ltd. All rights reserved.

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.
*/


#include "stddef.h" // for size_t

#ifdef __cplusplus
extern "C" {
#endif

#if defined(WIN32) || defined(WIN64)
        #define OfxExport extern __declspec(dllexport)
#else
        #define OfxExport extern
#endif

typedef struct OfxPropertySetStruct *OfxPropertySetHandle;

typedef int OfxStatus;

typedef struct OfxHost {
  OfxPropertySetHandle host;

  void *(*fetchSuite)(OfxPropertySetHandle host, const char *suiteName, int suiteVersion);
} OfxHost;


typedef  OfxStatus (OfxPluginEntryPoint)(const char *action, const void *handle, OfxPropertySetHandle inArgs, OfxPropertySetHandle outArgs);

typedef struct OfxPlugin {
  const char            *pluginApi;

  int            apiVersion;

  const char            *pluginIdentifier; 
  
  unsigned int   pluginVersionMajor;
  
  unsigned int   pluginVersionMinor;

  void     (*setHost)(OfxHost *host);
 
  OfxPluginEntryPoint *mainEntry;
} OfxPlugin;


#define  kOfxActionLoad "OfxActionLoad"

#define kOfxActionDescribe "OfxActionDescribe"

#define kOfxActionUnload "OfxActionUnload"

#define kOfxActionPurgeCaches                 "OfxActionPurgeCaches"

#define kOfxActionSyncPrivateData                 "OfxActionSyncPrivateData"

#define kOfxActionCreateInstance        "OfxActionCreateInstance"

#define kOfxActionDestroyInstance       "OfxActionDestroyInstance"

#define kOfxActionInstanceChanged "OfxActionInstanceChanged"

#define kOfxActionBeginInstanceChanged "OfxActionBeginInstanceChanged"

#define kOfxActionEndInstanceChanged "OfxActionEndInstanceChanged"

#define kOfxActionBeginInstanceEdit "OfxActionBeginInstanceEdit"

#define kOfxActionEndInstanceEdit "OfxActionEndInstanceEdit"

OfxExport OfxPlugin *OfxGetPlugin(int nth);

OfxExport int OfxGetNumberOfPlugins(void);



#define kOfxPropTime "OfxPropTime"

#define kOfxPropIsInteractive "OfxPropIsInteractive"

#define kOfxPluginPropFilePath "OfxPluginPropFilePath"

#define kOfxPropInstanceData "OfxPropInstanceData"

#define kOfxPropType "OfxPropType"

#define kOfxPropName "OfxPropName"

#define kOfxPropLabel "OfxPropLabel"


#define kOfxPropShortLabel "OfxPropShortLabel"

#define kOfxPropLongLabel "OfxPropLongLabel"

#define kOfxPropChangeReason "OfxPropChangeReason"

#define kOfxPropEffectInstance "OfxPropEffectInstance"


#define kOfxChangeUserEdited "OfxChangeUserEdited"

#define kOfxChangePluginEdited "OfxChangePluginEdited"

#define kOfxChangeTime "OfxChangeTime"

typedef double OfxTime;

typedef struct OfxRangeI {
  int min, max;
} OfxRangeI;

typedef struct OfxRangeD {
  double min, max;
} OfxRangeD;

typedef struct OfxPointI {
  int x, y;
} OfxPointI;

typedef struct OfxPointD {
  double x, y;
} OfxPointD;

#define kOfxFlagInfiniteMax ((int)((1 << (sizeof(int)*8 - 1)) - 1))

#define kOfxFlagInfiniteMin ((int)(-kOfxFlagInfiniteMax - 1))

typedef struct OfxRectI {
  int x1, y1, x2, y2;
} OfxRectI;

typedef struct OfxRectD {
  double x1, y1, x2, y2;
} OfxRectD;

typedef struct OfxRGBAColourB {
  unsigned char r, g, b, a;
}OfxRGBAColourB;

typedef struct OfxRGBAColourS {
  unsigned short r, g, b, a;
}OfxRGBAColourS;

typedef struct OfxRGBAColourF {
  float r, g, b, a;
}OfxRGBAColourF;


typedef struct OfxRGBAColourD {
  double r, g, b, a;
}OfxRGBAColourD;


typedef struct OfxYUVAColourB {
  unsigned char y, u, v, a;
}OfxYUVAColourB;

typedef struct OfxYUVAColourS {
  unsigned short y, u, v, a;
}OfxYUVAColourS;

typedef struct OfxYUVAColourF {
  float y, u, v, a;
}OfxYUVAColourF;


#define kOfxBitDepthNone "OfxBitDepthNone"

#define kOfxBitDepthByte "OfxBitDepthByte"

#define kOfxBitDepthShort "OfxBitDepthShort"

#define kOfxBitDepthFloat "OfxBitDepthFloat"



#define kOfxStatOK 0

#define kOfxStatFailed  ((int)1)

#define kOfxStatErrFatal ((int)2)

#define kOfxStatErrUnknown ((int)3)

#define kOfxStatErrMissingHostFeature ((int) 4)

#define kOfxStatErrUnsupported ((int) 5)

#define kOfxStatErrExists  ((int) 6)

#define kOfxStatErrFormat ((int) 7)

#define kOfxStatErrMemory  ((int) 8)

#define kOfxStatErrBadHandle ((int) 9)

#define kOfxStatErrBadIndex ((int)10)

#define kOfxStatErrValue ((int) 11)

#define kOfxStatReplyYes ((int) 12)

#define kOfxStatReplyNo ((int) 13)

#define kOfxStatReplyDefault ((int) 14)


#ifdef __cplusplus
}
#endif

#endif

---

Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:

1. Redistributions of the document must retain the above copyright notice and this list of conditions.
2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Automatic documentation generated by DOxygen.