ofxImageEffect.h

Go to the documentation of this file.

#ifndef _ofxImageEffect_h_
#define _ofxImageEffect_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 "ofxCore.h"
#include "ofxParam.h"
#include "ofxInteract.h"
#include "ofxMessage.h"
#include "ofxMemory.h"
#include "ofxMultiThread.h"
#include "ofxInteract.h"


#ifdef __cplusplus
extern "C" {
#endif

#define kOfxImageEffectPluginApi "OfxImageEffectPluginAPI"

#define kOfxImageEffectPluginApiVersion 1

typedef struct OfxImageEffectStruct *OfxImageEffectHandle;

typedef struct OfxImageClipStruct *OfxImageClipHandle;

typedef struct OfxImageMemoryStruct *OfxImageMemoryHandle;

#define kOfxImageComponentNone "OfxImageComponentNone"

#define kOfxImageComponentRGBA "OfxImageComponentRGBA"

#define kOfxImageComponentAlpha "OfxImageComponentAlpha"

#define kOfxImageComponentYUVA "OfxImageComponentYUVA"

#define kOfxImageEffectContextGenerator "OfxImageEffectContextGenerator"

#define kOfxImageEffectContextFilter "OfxImageEffectContextFilter"

#define kOfxImageEffectContextTransition "OfxImageEffectContextTransition"

#define kOfxImageEffectContextPaint "OfxImageEffectContextPaint"

#define kOfxImageEffectContextGeneral "OfxImageEffectContextGeneral"

#define kOfxImageEffectContextRetimer "OfxImageEffectContextRetimer"

#define kOfxTypeImageEffectHost "OfxTypeImageEffectHost"

#define kOfxTypeImageEffect "OfxTypeImageEffect"

#define kOfxTypeImageEffectInstance "OfxTypeImageEffectInstance"

#define kOfxTypeClip "OfxTypeClip"

#define kOfxTypeImage "OfxTypeImage"


#define kOfxImageEffectActionGetRegionOfDefinition        "OfxImageEffectActionGetRegionOfDefinition"

#define kOfxImageEffectActionGetRegionsOfInterest         "OfxImageEffectActionGetRegionsOfInterest"

#define kOfxImageEffectActionGetTimeDomain                "OfxImageEffectActionGetTimeDomain"

#define kOfxImageEffectActionGetFramesNeeded              "OfxImageEffectActionGetFramesNeeded"

#define kOfxImageEffectActionGetClipPreferences       "OfxImageEffectActionGetClipPreferences"

#define kOfxImageEffectActionIsIdentity            "OfxImageEffectActionIsIdentity"

#define kOfxImageEffectActionRender                "OfxImageEffectActionRender"

#define kOfxImageEffectActionBeginSequenceRender   "OfxImageEffectActionBeginSequenceRender"

#define kOfxImageEffectActionEndSequenceRender      "OfxImageEffectActionEndSequenceRender"

#define kOfxImageEffectActionDescribeInContext     "OfxImageEffectActionDescribeInContext"


#define kOfxImageEffectPropSupportedContexts "OfxImageEffectPropSupportedContexts"

#define kOfxImageEffectPropPluginHandle "OfxImageEffectPropPluginHandle"

#define kOfxImageEffectHostPropIsBackground "OfxImageEffectHostPropIsBackground"

#define kOfxImageEffectPluginPropSingleInstance "OfxImageEffectPluginPropSingleInstance"

#define kOfxImageEffectPluginRenderThreadSafety "OfxImageEffectPluginRenderThreadSafety"

#define kOfxImageEffectRenderUnsafe "OfxImageEffectRenderUnsafe"

#define kOfxImageEffectRenderInstanceSafe "OfxImageEffectRenderInstanceSafe"

#define kOfxImageEffectRenderFullySafe "OfxImageEffectRenderFullySafe"

#define kOfxImageEffectPluginPropHostFrameThreading "OfxImageEffectPluginPropHostFrameThreading"

#define kOfxImageEffectPropSupportsMultipleClipDepths "OfxImageEffectPropMultipleClipDepths"

#define kOfxImageEffectPropSupportsMultipleClipPARs "OfxImageEffectPropSupportsMultipleClipPARs"


#define kOfxImageEffectPropClipPreferencesSlaveParam "OfxImageEffectPropClipPreferencesSlaveParam"

#define kOfxImageEffectPropSetableFrameRate "OfxImageEffectPropSetableFrameRate"

#define kOfxImageEffectPropSetableFielding "OfxImageEffectPropSetableFielding"

#define kOfxImageEffectInstancePropSequentialRender "OfxImageEffectInstancePropSequentialRender"

#define kOfxImageEffectPluginPropGrouping "OfxImageEffectPluginPropGrouping"

#define kOfxImageEffectPropSupportsOverlays "OfxImageEffectPropSupportsOverlays"

#define kOfxImageEffectPluginPropOverlayInteractV1 "OfxImageEffectPluginPropOverlayInteractV1"

#define kOfxImageEffectPropSupportsMultiResolution "OfxImageEffectPropSupportsMultiResolution"

#define kOfxImageEffectPropSupportsTiles "OfxImageEffectPropSupportsTiles"

#define kOfxImageEffectPropInAnalysis "OfxImageEffectPropInAnalysis"

#define kOfxImageEffectPropTemporalClipAccess "OfxImageEffectPropTemporalClipAccess"

#define kOfxImageEffectPropContext "OfxImageEffectPropContext"

#define kOfxImageEffectPropPixelDepth "OfxImageEffectPropPixelDepth"

#define kOfxImageEffectPropComponents "OfxImageEffectPropComponents"

#define kOfxImagePropUniqueIdentifier "OfxImagePropUniqueIdentifier"

#define kOfxImageClipPropContinuousSamples "OfxImageClipPropContinuousSamples"

#define kOfxImageClipPropUnmappedPixelDepth "OfxImageClipPropUnmappedPixelDepth"

#define kOfxImageClipPropUnmappedComponents "OfxImageClipPropUnmappedComponents"

#define kOfxImageEffectPropPreMultiplication "OfxImageEffectPropPreMultiplication"

#define kOfxImageOpaque  "OfxImageOpaque"

#define kOfxImagePreMultiplied "OfxImageAlphaPremultiplied"

#define kOfxImageUnPreMultiplied "OfxImageAlphaUnPremultiplied"


#define kOfxImageEffectPropSupportedPixelDepths "OfxImageEffectPropSupportedPixelDepths"

#define kOfxImageEffectPropSupportedComponents "OfxImageEffectPropSupportedComponents"

#define kOfxImageClipPropOptional "OfxImageClipPropOptional"

#define kOfxImageClipPropIsMask "OfxImageClipPropIsMask"


#define kOfxImagePropPixelAspectRatio "OfxImagePropPixelAspectRatio"

#define kOfxImageEffectPropFrameRate "OfxImageEffectPropFrameRate"

#define kOfxImageEffectPropUnmappedFrameRate "OfxImageEffectPropUnmappedFrameRate"

#define kOfxImageEffectPropFrameStep "OfxImageEffectPropFrameStep"

#define kOfxImageEffectPropFrameRange "OfxImageEffectPropFrameRange"


#define kOfxImageEffectPropUnmappedFrameRange "OfxImageEffectPropUnmappedFrameRange"

#define kOfxImageClipPropConnected "OfxImageClipPropConnected"

#define kOfxImageEffectFrameVarying "OfxImageEffectFrameVarying"

#define kOfxImageEffectPropRenderScale "OfxImageEffectPropRenderScale"

#define kOfxImageEffectPropProjectExtent "OfxImageEffectPropProjectExtent"

#define kOfxImageEffectPropProjectSize "OfxImageEffectPropProjectSize"

#define kOfxImageEffectPropProjectOffset "OfxImageEffectPropProjectOffset"

#define kOfxImageEffectPropProjectPixelAspectRatio "OfxImageEffectPropPixelAspectRatio"

#define kOfxImageEffectInstancePropEffectDuration "OfxImageEffectInstancePropEffectDuration"

#define kOfxImageClipPropFieldOrder "OfxImageClipPropFieldOrder"

#define kOfxImagePropData "OfxImagePropData"

#define kOfxImagePropBounds "OfxImagePropBounds"

#define kOfxImagePropRegionOfDefinition "OfxImagePropRegionOfDefinition"

#define kOfxImagePropRowBytes "OfxImagePropRowBytes"


#define kOfxImagePropField "OfxImagePropField"

#define kOfxImageEffectPluginPropFieldRenderTwiceAlways "OfxImageEffectPluginPropFieldRenderTwiceAlways"

#define kOfxImageClipPropFieldExtraction "OfxImageClipPropFieldExtraction"

#define kOfxImageEffectPropFieldToRender "OfxImageEffectPropFieldToRender"

#define kOfxImageEffectPropRegionOfDefinition "OfxImageEffectPropRegionOfDefinition"

#define kOfxImageEffectPropRegionOfInterest "OfxImageEffectPropRegionOfInterest"

#define kOfxImageEffectPropRenderWindow "OfxImageEffectPropRenderWindow"


#define kOfxImageFieldNone "OfxFieldNone"

#define kOfxImageFieldLower "OfxFieldLower"

#define kOfxImageFieldUpper "OfxFieldUpper"

#define kOfxImageFieldBoth "OfxFieldBoth"

#define kOfxImageFieldSingle "OfxFieldSingle"

#define kOfxImageFieldDoubled "OfxFieldDoubled"


#define kOfxImageEffectOutputClipName "Output"

#define kOfxImageEffectSimpleSourceClipName "Source"

#define kOfxImageEffectTransitionSourceFromClipName "SourceFrom"

#define kOfxImageEffectTransitionSourceToClipName "SourceTo"

#define kOfxImageEffectRetimerParamName "SourceTime"




#define kOfxImageEffectSuite "OfxImageEffectSuite"

typedef struct OfxImageEffectSuiteV1 {  
  OfxStatus (*getPropertySet)(OfxImageEffectHandle imageEffect,
                              OfxPropertySetHandle *propHandle);

  OfxStatus (*getParamSet)(OfxImageEffectHandle imageEffect,
                           OfxParamSetHandle *paramSet);


  OfxStatus (*clipDefine)(OfxImageEffectHandle imageEffect,
                          const char *name,      
                          OfxPropertySetHandle *propertySet);

  OfxStatus (*clipGetHandle)(OfxImageEffectHandle imageEffect,
                             const char *name,
                             OfxImageClipHandle *clip,
                             OfxPropertySetHandle *propertySet);

  OfxStatus (*clipGetPropertySet)(OfxImageClipHandle clip,
                                  OfxPropertySetHandle *propHandle);

  OfxStatus (*clipGetImage)(OfxImageClipHandle clip,
                            OfxTime       time,
                            OfxRectD     *region,
                            OfxPropertySetHandle   *imageHandle);
  
  OfxStatus (*clipReleaseImage)(OfxPropertySetHandle imageHandle);
  

  OfxStatus (*clipGetRegionOfDefinition)(OfxImageClipHandle clip,
                                         OfxTime time,
                                         OfxRectD *bounds);

  int (*abort)(OfxImageEffectHandle imageEffect);

  OfxStatus (*imageMemoryAlloc)(OfxImageEffectHandle instanceHandle, 
                                size_t nBytes,
                                OfxImageMemoryHandle *memoryHandle);
        
  OfxStatus (*imageMemoryFree)(OfxImageMemoryHandle memoryHandle);

  OfxStatus (*imageMemoryLock)(OfxImageMemoryHandle memoryHandle,
                               void **returnedPtr);

  OfxStatus (*imageMemoryUnlock)(OfxImageMemoryHandle memoryHandle);

} OfxImageEffectSuiteV1;



#define kOfxStatErrImageFormat ((int) 1000)



#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.