TuttleOFX
1
|
The core 'OFX Support' namespace, used by plugin implementations. All code for these are defined in the common support libraries. More...
Namespaces | |
namespace | Exception |
namespace for OFX support lib exceptions, all derive from std::exception, calling it | |
namespace | Log |
this namespace wraps up logging functionality | |
namespace | memory |
Namespace for general purpose memory allocation. | |
namespace | Message |
namespace | MultiThread |
Multi thread namespace. | |
namespace | Plugin |
The OFX::Plugin namespace. All the functions in here needs to be defined by each plugin that uses the support libs. | |
namespace | Private |
OFX::Private namespace, for things private to the support library code here generally calls image effect class members. | |
namespace | Validation |
The validation code has its own namespace. | |
Data Structures | |
class | PropertySet |
This class wraps up an OFX property set. More... | |
class | PluginFactory |
class | FactoryMainEntryHelper |
class | PluginFactoryHelper |
struct | ImageEffectHostDescription |
A class that lists all the properties of a host. More... | |
class | ClipDescriptor |
Wraps up a clip. More... | |
class | ImageEffectDescriptor |
Wraps up an effect descriptor, used in the describe actions. More... | |
class | Image |
Wraps up an image. More... | |
class | Clip |
Wraps up a clip instance. More... | |
class | ImageMemory |
Class that skins image memory allocation. More... | |
struct | RenderArguments |
POD struct to pass rendering arguments into ImageEffect::render and OFX::ImageEffect::isIdentity. More... | |
struct | BeginSequenceRenderArguments |
POD struct to pass arguments into OFX::ImageEffect::render. More... | |
struct | EndSequenceRenderArguments |
POD struct to pass arguments into OFX::ImageEffect::beginSequenceRender. More... | |
struct | RegionOfDefinitionArguments |
POD struct to pass arguments into OFX::ImageEffect::getRegionOfDefinition. More... | |
struct | RegionsOfInterestArguments |
POD struct to pass arguments into OFX::ImageEffect::getRegionsOfInterest. More... | |
class | RegionOfInterestSetter |
Class used to set regions of interest on a clip in OFX::ImageEffect::getRegionsOfInterest. More... | |
struct | FramesNeededArguments |
POD struct to pass arguments into OFX::ImageEffect::getFramesNeeded. More... | |
class | FramesNeededSetter |
Class used to set the frames needed to render a single frame of a clip in OFX::ImageEffect::getFramesNeeded. More... | |
class | ClipPreferencesSetter |
Class used to set the clip preferences of the effect. More... | |
struct | InstanceChangedArgs |
POD data structure passing in the instance changed args. More... | |
class | ImageEffect |
Wraps up an effect instance, plugin implementations need to inherit from this. More... | |
struct | InteractArgs |
all image effect interacts have these argumens More... | |
struct | DrawArgs |
struct to pass arguments into OFX::Interact::draw More... | |
struct | PenArgs |
POD to pass arguments into OFX::Interact pen actions. More... | |
struct | KeyArgs |
struct to pass arguments into OFX::Interact key actions More... | |
struct | FocusArgs |
struct to pass arguments into OFX::Interact focus actions More... | |
class | InteractI |
class | Interact |
Wraps up an OFX interact object for an Image Effect. It won't work for any other plug-in type at present (it would need to be broken into a hierarchy of classes). More... | |
class | OverlayInteract |
an interact for an image effect overlay More... | |
class | InteractDescriptor |
class | NoOverlayDescriptor |
class | ParamInteractDescriptor |
class | ParamInteract |
class | EffectInteractWrap |
class | ParamInteractWrap |
class | InteractMainEntry |
class | DefaultEffectOverlayWrap |
class | DefaultParamInteractWrap |
class | ParamDescriptor |
Base class for all param descriptors. More... | |
class | DummyParamDescriptor |
Used to implement dummy parameters for page positioning commands. More... | |
class | ValueParamDescriptor |
Wraps up a value holding param. More... | |
class | StringParamDescriptor |
Wraps up a string param. More... | |
class | IntParamDescriptor |
Wraps up an integer param. More... | |
class | Int2DParamDescriptor |
Wraps up an 2d integer param. More... | |
class | Int3DParamDescriptor |
Wraps up an 3d integer param. More... | |
class | BaseDoubleParamDescriptor |
Common base to all double param types. More... | |
class | DoubleParamDescriptor |
Wraps up a double param. More... | |
class | Double2DParamDescriptor |
Wraps up a 2D double param. More... | |
class | Double3DParamDescriptor |
Wraps up a 3D double param. More... | |
class | RGBParamDescriptor |
Wraps up an RGB colour param. More... | |
class | RGBAParamDescriptor |
Wraps up an RGBA colour param. More... | |
class | BooleanParamDescriptor |
Wraps up a boolean param. More... | |
class | ChoiceParamDescriptor |
Wraps up a choice param. More... | |
class | GroupParamDescriptor |
Wraps up a group param, not much to it really. More... | |
class | PageParamDescriptor |
Wraps up a page param, not much to it really. More... | |
class | PushButtonParamDescriptor |
Wraps up a push button param, not much to it at all. More... | |
class | ParametricParamDescriptor |
Wraps up a push button param, not much to it at all. More... | |
class | CustomParamDescriptor |
Wraps up a custom param, haven't added animation support yet. More... | |
class | ParamSetDescriptor |
Describes a set of properties. More... | |
class | Attribute |
class | Param |
Base class for all param instances. More... | |
class | ValueParam |
Wraps up a value holding param. More... | |
class | IntParam |
Wraps up an integer param. More... | |
class | Int2DParam |
Wraps up an integer param. More... | |
class | Int3DParam |
Wraps up an integer param. More... | |
class | BaseDoubleParam |
Common base to all double param types. More... | |
class | DoubleParam |
Wraps up an doubleeger param. More... | |
class | Double2DParam |
Wraps up an doubleeger param. More... | |
class | Double3DParam |
Wraps up an doubleeger param. More... | |
class | RGBParam |
Wraps up an RGB param. More... | |
class | RGBAParam |
Wraps up an RGB param. More... | |
class | StringParam |
Wraps up a string param. More... | |
class | ChoiceParam |
Wraps up a choice param. More... | |
class | BooleanParam |
Wraps up a boolean param. More... | |
class | GroupParam |
Wraps up a group param. More... | |
class | PageParam |
Wraps up a group param. More... | |
class | CustomParam |
Wraps up a custom param, not animation support yet. More... | |
class | PushButtonParam |
Wraps up a push button param, not much to it at all. More... | |
class | ParametricParam |
Wraps up a parametric param. More... | |
class | CameraParam |
Wraps up a camera param. More... | |
class | ParamSet |
A set of parameters in a plugin instance. More... | |
struct | OfxPlugInfo |
Typedefs | |
typedef std::vector < PluginFactory * > | PluginFactoryArray |
typedef InteractDescriptor | EffectOverlayDescriptor |
typedef std::map< std::string, OfxPlugInfo > | OfxPlugInfoMap |
typedef std::vector< OfxPlugin * > | OfxPluginArray |
typedef ::boost::error_info < struct tag_ofxStatus,::OfxStatus > | ofxStatus |
Enumerations | |
enum | PropertyTypeEnum { ePointer, eInt, eString, eDouble } |
Enumerates the different types a property can be. More... | |
enum | InstanceChangeReason { eChangeUserEdit, eChangePluginEdit, eChangeTime } |
Enumerates the reasons a plug-in instance may have had one of its values changed. More... | |
enum | EContext { eContextNone, eContextGenerator, eContextFilter, eContextTransition, eContextPaint, eContextGeneral, eContextRetimer, eContextReader, eContextWriter } |
Enumerates the contexts a plugin can be used in. More... | |
enum | EBitDepth { eBitDepthCustom = -1, eBitDepthNone = 0, eBitDepthUByte = 1, eBitDepthUShort = 2, eBitDepthFloat = 3 } |
Enumerates the pixel depths supported. More... | |
enum | EPixelComponent { ePixelComponentNone, ePixelComponentRGBA, ePixelComponentRGB, ePixelComponentAlpha, ePixelComponentCustom } |
Enumerates the component types supported. More... | |
enum | EFieldExtraction { eFieldExtractBoth, eFieldExtractSingle, eFieldExtractDoubled } |
Enumerates the ways a fielded image can be extracted from a clip. More... | |
enum | ERenderSafety { eRenderUnsafe, eRenderInstanceSafe, eRenderFullySafe } |
Enumerates the kind of render thread safety a plugin has. More... | |
enum | EField { eFieldNone, eFieldBoth, eFieldLower, eFieldUpper } |
Enumerates the fields present in an image. More... | |
enum | EPreMultiplication { eImageOpaque, eImagePreMultiplied, eImageUnPreMultiplied } |
enum | ParamTypeEnum { eDummyParam, eStringParam, eIntParam, eInt2DParam, eInt3DParam, eDoubleParam, eDouble2DParam, eDouble3DParam, eRGBParam, eRGBAParam, eBooleanParam, eChoiceParam, eCustomParam, eGroupParam, ePageParam, ePushButtonParam, eParametricParam, eCameraParam } |
Enumerates the different types of parameter. More... | |
enum | CacheInvalidationEnum { eCacheInvalidateValueChange, eCacheInvalidateValueChangeToEnd, eCacheInvalidateValueAll } |
Enumerates the different types of cache invalidation. More... | |
enum | KeySearchEnum { eKeySearchBackwards, eKeySearchNear, eKeySearchForwards } |
Enumerates how we search for keys in an animating parameter. More... | |
enum | StringTypeEnum { eStringTypeSingleLine, eStringTypeMultiLine, eStringTypeFilePath, eStringTypeDirectoryPath, eStringTypeLabel } |
Enumerates the differing types of string params. More... | |
enum | DoubleTypeEnum { eDoubleTypePlain, eDoubleTypeAngle, eDoubleTypeScale, eDoubleTypeTime, eDoubleTypeAbsoluteTime, eDoubleTypeNormalisedX, eDoubleTypeNormalisedY, eDoubleTypeNormalisedXAbsolute, eDoubleTypeNormalisedYAbsolute, eDoubleTypeNormalisedXY, eDoubleTypeNormalisedXYAbsolute } |
Enumerates the differing types of double params. More... | |
enum | ELayoutHint { eLayoutHintNormal = kOfxParamPropLayoutHintNormal, eLayoutHintDivider = kOfxParamPropLayoutHintDivider, eLayoutHintNoNewLine = kOfxParamPropLayoutHintNoNewLine } |
Functions | |
std::string | mapStatusToString (const OfxStatus stat) |
maps a status to a string for debugging purposes, note a c-str for printf | |
void | throwSuiteStatusException (OfxStatus stat) |
Throws an OFX::Exception::Suite depending on the status flag passed in. | |
void | throwHostMissingSuiteException (const std::string &name) |
const std::string | mapContextEnumToString (const EContext s) |
map a std::string to a context | |
const std::string | mapBitDepthEnumToString (const EBitDepth e) |
std::string | mapPixelComponentEnumToString (const EPixelComponent e) |
std::string | mapFieldEnumToString (const EField e) |
std::string | mapPreMultiplicationEnumToString (const EPreMultiplication e) |
void * | fetchSuite (const char *suiteName, int suiteVersion, bool optional=false) |
Fetch's a suite from the host and logs errors. | |
ImageEffectHostDescription * | getImageEffectHostDescription () |
retrieve the host description | |
const char * | mapParamTypeEnumToString (ParamTypeEnum v) |
turns a ParamTypeEnum into the char * that raw OFX uses | |
template<class ParamType > | |
ParamTypeEnum | mapParamTypeToEnum () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< StringParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< IntParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< Int2DParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< Int3DParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< DoubleParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< Double2DParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< Double3DParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< RGBParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< RGBAParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< BooleanParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< ChoiceParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< CustomParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< GroupParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< PageParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< PushButtonParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< ParametricParam > () |
template<> | |
ParamTypeEnum | mapParamTypeToEnum< CameraParam > () |
template<class ParamType > | |
ParamTypeEnum | mapParamTypeToEnumFrom (const ParamType &) |
template<class ParamType > | |
ParamTypeEnum | mapParamTypeToEnumFrom (const ParamType *) |
EContext | mapContextStringToEnum (const std::string &s) |
map a std::string to a context | |
const std::string | mapMessageTypeEnumToString (const OFX::Message::EMessageType type) |
OFX::Message::EMessageReply | mapMessageReplyStatusToEnum (const OfxStatus stat) |
OfxStatus | mapMessageReplyEnumToStatus (const OFX::Message::EMessageReply stat) |
InstanceChangeReason | mapInstanceChangedReasonStringToEnum (const std::string &s) |
map a std::string to a context | |
EBitDepth | mapBitDepthStringToEnum (const std::string &str) |
turns a bit depth string into and enum | |
EPixelComponent | mapPixelComponentStringToEnum (const std::string &str) |
turns a pixel component string into and enum | |
EPreMultiplication | mapPreMultiplicationStringToEnum (const std::string &str) |
turns a premultiplication string into and enum | |
EField | mapFieldStringToEnum (const std::string &str) |
turns a field string into and enum | |
static OfxPointD | getPixelScale (const PropertySet &props) |
fetch a pixel scale out of the property set | |
static OfxPointD | getRenderScale (const PropertySet &props) |
fetch a render scale out of the property set | |
static OfxRGBColourD | getBackgroundColour (const PropertySet &props) |
fetch a background colour out of the property set | |
static ImageEffect * | retrieveEffectFromInteractHandle (OfxInteractHandle handle) |
retrieves the image effect pointer from the interact handle | |
bool | isEqual (const char *t1, const char *t2) |
ParamTypeEnum | mapParamTypeStringToEnum (const char *v) |
void | throwPropertyException (OfxStatus stat, const std::string &propName) |
std::string | to_string (const ofxStatus &e) |
Variables | |
static const OfxPointD | kNoRenderScale = { 1.0, 1.0 } |
OFX::PluginFactoryArray | plugIDs |
The core 'OFX Support' namespace, used by plugin implementations. All code for these are defined in the common support libraries.
Namespace private to the ofx support library.
OFX namespace.
This file contains code that skins the ofx param suite.
This file contains code that skins the ofx interact suite (for image effects)
This file contains code that skins the ofx effect suite.
Definition at line 252 of file ofxsInteract.h.
typedef std::vector<OfxPlugin*> OFX::OfxPluginArray |
Definition at line 80 of file ofxsImageEffect.cpp.
typedef std::map<std::string, OfxPlugInfo> OFX::OfxPlugInfoMap |
Definition at line 79 of file ofxsImageEffect.cpp.
typedef ::boost::error_info<struct tag_ofxStatus, ::OfxStatus> OFX::ofxStatus |
Definition at line 55 of file exceptions.hpp.
typedef std::vector<PluginFactory*> OFX::PluginFactoryArray |
Definition at line 245 of file ofxsImageEffect.h.
Enumerates the different types of cache invalidation.
Definition at line 139 of file ofxsParam.h.
enum OFX::DoubleTypeEnum |
Enumerates the differing types of double params.
Definition at line 165 of file ofxsParam.h.
enum OFX::EBitDepth |
Enumerates the pixel depths supported.
eBitDepthCustom |
some non standard bit depth |
eBitDepthNone |
bit depth that indicates no data is present |
eBitDepthUByte | |
eBitDepthUShort | |
eBitDepthFloat |
Definition at line 108 of file ofxsImageEffect.h.
enum OFX::EContext |
Enumerates the contexts a plugin can be used in.
eContextNone | |
eContextGenerator | |
eContextFilter | |
eContextTransition | |
eContextPaint | |
eContextGeneral | |
eContextRetimer | |
eContextReader | |
eContextWriter |
Definition at line 92 of file ofxsImageEffect.h.
enum OFX::EField |
Enumerates the fields present in an image.
eFieldNone |
unfielded image |
eFieldBoth |
fielded image with both fields present |
eFieldLower |
only the spatially lower field is present |
eFieldUpper |
only the spatially upper field is present |
Definition at line 148 of file ofxsImageEffect.h.
Enumerates the ways a fielded image can be extracted from a clip.
Definition at line 132 of file ofxsImageEffect.h.
enum OFX::ELayoutHint |
Definition at line 180 of file ofxsParam.h.
enum OFX::EPixelComponent |
Enumerates the component types supported.
ePixelComponentNone | |
ePixelComponentRGBA | |
ePixelComponentRGB | |
ePixelComponentAlpha | |
ePixelComponentCustom |
some non standard pixel type |
Definition at line 120 of file ofxsImageEffect.h.
eImageOpaque |
the image is opaque and so has no premultiplication state |
eImagePreMultiplied |
the image is premultiplied by it's alpha |
eImageUnPreMultiplied |
the image is unpremultiplied |
Definition at line 158 of file ofxsImageEffect.h.
enum OFX::ERenderSafety |
Enumerates the kind of render thread safety a plugin has.
Definition at line 140 of file ofxsImageEffect.h.
Enumerates the reasons a plug-in instance may have had one of its values changed.
Definition at line 219 of file ofxsCore.h.
enum OFX::KeySearchEnum |
Enumerates how we search for keys in an animating parameter.
Definition at line 147 of file ofxsParam.h.
enum OFX::ParamTypeEnum |
Enumerates the different types of parameter.
Definition at line 116 of file ofxsParam.h.
Enumerates the different types a property can be.
Definition at line 210 of file ofxsCore.h.
enum OFX::StringTypeEnum |
Enumerates the differing types of string params.
eStringTypeSingleLine | |
eStringTypeMultiLine | |
eStringTypeFilePath | |
eStringTypeDirectoryPath | |
eStringTypeLabel |
Definition at line 155 of file ofxsParam.h.
void * OFX::fetchSuite | ( | const char * | suiteName, |
int | suiteVersion, | ||
bool | optional = false |
||
) |
Fetch's a suite from the host and logs errors.
All the standard suites are fetched by the support code, you should use this to fetch any extra non-standard suites.
Definition at line 2770 of file ofxsImageEffect.cpp.
References OFX::Log::error(), OfxHost::fetchSuite, OFX::Private::gHost, and OFX::Log::warning().
Referenced by OFX::Private::loadAction().
static OfxRGBColourD OFX::getBackgroundColour | ( | const PropertySet & | props | ) | [static] |
fetch a background colour out of the property set
Definition at line 75 of file ofxsInteract.cpp.
References OfxRGBColourD::b, OfxRGBColourD::g, kOfxInteractPropBackgroundColour, OFX::PropertySet::propGetDouble(), and OfxRGBColourD::r.
Referenced by OFX::DrawArgs::DrawArgs(), and OFX::FocusArgs::FocusArgs().
ImageEffectHostDescription * OFX::getImageEffectHostDescription | ( | ) |
retrieve the host description
Definition at line 115 of file ofxsImageEffect.cpp.
References OFX::Private::gHostDescription, and OFX::Private::gHostDescriptionHasInit.
Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), OFX::ClipPreferencesSetter::ClipPreferencesSetter(), tuttle::plugin::describeGeneratorParamsInContext(), tuttle::plugin::describeReaderParamsInContext(), tuttle::plugin::ReaderPlugin::getClipPreferences(), tuttle::plugin::openImageIO::reader::OpenImageIOReaderPlugin::getClipPreferences(), tuttle::plugin::jpeg::reader::JpegReaderPlugin::getClipPreferences(), tuttle::plugin::imagemagick::reader::ImageMagickReaderPlugin::getClipPreferences(), tuttle::plugin::png::reader::PngReaderPlugin::getClipPreferences(), tuttle::plugin::turboJpeg::reader::TurboJpegReaderPlugin::getClipPreferences(), tuttle::plugin::exr::reader::EXRReaderPlugin::getClipPreferences(), OFX::Validation::initialise(), tuttle::plugin::WriterPlugin::isIdentity(), tuttle::plugin::swscale::SwscalePlugin::render(), tuttle::plugin::inputBuffer::InputBufferPlugin::render(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::render(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::render(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::render(), tuttle::plugin::histogram::HistogramPlugin::render(), OFX::GroupParamDescriptor::setAsTab(), tuttle::plugin::ImageGilFilterProcessor< SView, DView >::setup(), tuttle::plugin::bitDepth::BitDepthProcess< SView, DView >::setup(), tuttle::plugin::ImageFilterProcessor::setup(), tuttle::plugin::quality::DiffProcess< View >::setup(), tuttle::plugin::fade::FadeProcess< View >::setup(), tuttle::plugin::merge::MergeProcess< View, Functor >::setup(), tuttle::plugin::pushPixel::PushPixelProcess< View >::setup(), tuttle::plugin::colorTransfer::ColorTransferProcess< View >::setup(), tuttle::plugin::text::TextProcess< View, Functor >::setup(), and tuttle::plugin::ImageProcessor::setup().
static OfxPointD OFX::getPixelScale | ( | const PropertySet & | props | ) | [static] |
fetch a pixel scale out of the property set
Definition at line 55 of file ofxsInteract.cpp.
References kOfxInteractPropPixelScale, OFX::PropertySet::propGetDouble(), OfxPointD::x, and OfxPointD::y.
Referenced by OFX::DrawArgs::DrawArgs(), OFX::FocusArgs::FocusArgs(), and OFX::PenArgs::PenArgs().
static OfxPointD OFX::getRenderScale | ( | const PropertySet & | props | ) | [static] |
fetch a render scale out of the property set
Definition at line 65 of file ofxsInteract.cpp.
References kOfxImageEffectPropRenderScale, OFX::PropertySet::propGetDouble(), OfxPointD::x, and OfxPointD::y.
Referenced by OFX::InteractArgs::InteractArgs(), and OFX::KeyArgs::KeyArgs().
bool OFX::isEqual | ( | const char * | t1, |
const char * | t2 | ||
) |
Definition at line 82 of file ofxsParams.cpp.
Referenced by mapParamTypeStringToEnum().
const std::string OFX::mapBitDepthEnumToString | ( | const EBitDepth | e | ) |
Definition at line 262 of file ofxsImageEffect.cpp.
References eBitDepthCustom, eBitDepthFloat, eBitDepthNone, eBitDepthUByte, eBitDepthUShort, kOfxBitDepthByte, kOfxBitDepthFloat, kOfxBitDepthNone, and kOfxBitDepthShort.
Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), tuttle::plugin::doGilRender(), tuttle::plugin::doGilRender2(), main(), tuttle::plugin::bitDepth::BitDepthPlugin::render(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::render(), tuttle::plugin::nlmDenoiser::NLMDenoiserPlugin::render(), tuttle::plugin::ocio::lut::OCIOLutPlugin::render(), tuttle::plugin::ocio::colorspace::OCIOColorSpacePlugin::render(), tuttle::plugin::text::TextPlugin::render(), tuttle::plugin::merge::MergePlugin::render(), tuttle::plugin::normalize::NormalizePlugin::render(), tuttle::plugin::pinning::PinningPlugin::render(), tuttle::plugin::warp::WarpPlugin::render(), tuttle::plugin::colorGradient::ColorGradientPlugin::renderFunctor(), tuttle::host::ofx::attribute::OfxhClipImage::setBitDepth(), OFX::ClipPreferencesSetter::setClipBitDepth(), and tuttle::plugin::bitDepth::BitDepthPlugin::setupDestView().
EBitDepth OFX::mapBitDepthStringToEnum | ( | const std::string & | str | ) |
turns a bit depth string into and enum
Definition at line 238 of file ofxsImageEffect.cpp.
References eBitDepthCustom, eBitDepthFloat, eBitDepthNone, eBitDepthUByte, eBitDepthUShort, kOfxBitDepthByte, kOfxBitDepthFloat, kOfxBitDepthNone, and kOfxBitDepthShort.
Referenced by OFX::Private::fetchHostDescription(), tuttle::host::ofx::attribute::OfxhClipImage::getBitDepth(), OFX::Clip::getPixelDepth(), OFX::Clip::getUnmappedPixelDepth(), OFX::Image::Image(), and tuttle::host::ofx::attribute::OfxhClipImage::setBitDepthStringIfUpperAndNotModifiedByPlugin().
const std::string OFX::mapContextEnumToString | ( | const EContext | s | ) |
map a std::string to a context
Definition at line 148 of file ofxsImageEffect.cpp.
References eContextFilter, eContextGeneral, eContextGenerator, eContextNone, eContextPaint, eContextReader, eContextRetimer, eContextTransition, eContextWriter, OFX::Log::error(), kOfxImageEffectContextFilter, kOfxImageEffectContextGeneral, kOfxImageEffectContextGenerator, kOfxImageEffectContextPaint, kOfxImageEffectContextReader, kOfxImageEffectContextRetimer, kOfxImageEffectContextTransition, and kOfxImageEffectContextWriter.
Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam().
EContext OFX::mapContextStringToEnum | ( | const std::string & | s | ) |
map a std::string to a context
map a std::string to a context enum
Definition at line 124 of file ofxsImageEffect.cpp.
References eContextFilter, eContextGeneral, eContextGenerator, eContextPaint, eContextReader, eContextRetimer, eContextTransition, eContextWriter, OFX::Log::error(), kOfxImageEffectContextFilter, kOfxImageEffectContextGeneral, kOfxImageEffectContextGenerator, kOfxImageEffectContextPaint, kOfxImageEffectContextReader, kOfxImageEffectContextRetimer, kOfxImageEffectContextTransition, and kOfxImageEffectContextWriter.
Referenced by OFX::Private::fetchHostDescription(), OFX::ImageEffect::ImageEffect(), and OFX::Private::mainEntryStr().
std::string OFX::mapFieldEnumToString | ( | const EField | e | ) |
Definition at line 381 of file ofxsImageEffect.cpp.
References eFieldBoth, eFieldLower, eFieldNone, eFieldUpper, kOfxImageFieldBoth, kOfxImageFieldLower, kOfxImageFieldNone, and kOfxImageFieldUpper.
EField OFX::mapFieldStringToEnum | ( | const std::string & | str | ) |
turns a field string into and enum
Definition at line 359 of file ofxsImageEffect.cpp.
References eFieldBoth, eFieldLower, eFieldNone, eFieldUpper, kOfxImageFieldBoth, kOfxImageFieldLower, kOfxImageFieldNone, and kOfxImageFieldUpper.
Referenced by OFX::Clip::getFieldOrder(), and OFX::Private::getRenderActionArguments().
InstanceChangeReason OFX::mapInstanceChangedReasonStringToEnum | ( | const std::string & | s | ) |
map a std::string to a context
Definition at line 224 of file ofxsImageEffect.cpp.
References eChangePluginEdit, eChangeTime, eChangeUserEdit, OFX::Log::error(), kOfxChangePluginEdited, kOfxChangeTime, and kOfxChangeUserEdited.
Referenced by OFX::Private::beginInstanceChangedAction(), OFX::Private::endInstanceChangedAction(), and OFX::Private::instanceChangedAction().
OfxStatus OFX::mapMessageReplyEnumToStatus | ( | const OFX::Message::EMessageReply | stat | ) |
Definition at line 206 of file ofxsImageEffect.cpp.
References OFX::Message::eMessageReplyFailed, OFX::Message::eMessageReplyNo, OFX::Message::eMessageReplyOK, OFX::Message::eMessageReplyYes, OFX::Log::error(), kOfxStatFailed, kOfxStatOK, kOfxStatReplyNo, and kOfxStatReplyYes.
OFX::Message::EMessageReply OFX::mapMessageReplyStatusToEnum | ( | const OfxStatus | stat | ) |
Definition at line 192 of file ofxsImageEffect.cpp.
References OFX::Message::eMessageReplyFailed, OFX::Message::eMessageReplyNo, OFX::Message::eMessageReplyOK, OFX::Message::eMessageReplyYes, OFX::Log::error(), kOfxStatFailed, kOfxStatOK, kOfxStatReplyNo, and kOfxStatReplyYes.
Referenced by OFX::ImageEffect::sendMessage().
const std::string OFX::mapMessageTypeEnumToString | ( | const OFX::Message::EMessageType | type | ) |
Definition at line 176 of file ofxsImageEffect.cpp.
References OFX::Message::eMessageError, OFX::Message::eMessageFatal, OFX::Message::eMessageLog, OFX::Message::eMessageMessage, OFX::Message::eMessageQuestion, OFX::Log::error(), kOfxMessageError, kOfxMessageFatal, kOfxMessageLog, kOfxMessageMessage, and kOfxMessageQuestion.
Referenced by OFX::ImageEffect::sendMessage().
const char * OFX::mapParamTypeEnumToString | ( | ParamTypeEnum | v | ) |
turns a ParamTypeEnum into the char * that raw OFX uses
Definition at line 57 of file ofxsParams.cpp.
References eBooleanParam, eChoiceParam, eCustomParam, eDouble2DParam, eDouble3DParam, eDoubleParam, eGroupParam, eInt2DParam, eInt3DParam, eIntParam, ePageParam, eParametricParam, ePushButtonParam, eRGBAParam, eRGBParam, eStringParam, kOfxParamTypeBoolean, kOfxParamTypeChoice, kOfxParamTypeCustom, kOfxParamTypeDouble, kOfxParamTypeDouble2D, kOfxParamTypeDouble3D, kOfxParamTypeGroup, kOfxParamTypeInteger, kOfxParamTypeInteger2D, kOfxParamTypeInteger3D, kOfxParamTypePage, kOfxParamTypeParametric, kOfxParamTypePushButton, kOfxParamTypeRGB, kOfxParamTypeRGBA, and kOfxParamTypeString.
Referenced by OFX::ParamSetDescriptor::defineRawParam(), and OFX::ParamSet::fetchRawParam().
ParamTypeEnum OFX::mapParamTypeStringToEnum | ( | const char * | v | ) |
Definition at line 87 of file ofxsParams.cpp.
References eBooleanParam, eChoiceParam, eCustomParam, eDouble2DParam, eDouble3DParam, eDoubleParam, eGroupParam, eInt2DParam, eInt3DParam, eIntParam, ePageParam, eParametricParam, ePushButtonParam, eRGBAParam, eRGBParam, eStringParam, isEqual(), kOfxParamTypeBoolean, kOfxParamTypeChoice, kOfxParamTypeCustom, kOfxParamTypeDouble, kOfxParamTypeDouble2D, kOfxParamTypeDouble3D, kOfxParamTypeGroup, kOfxParamTypeInteger, kOfxParamTypeInteger2D, kOfxParamTypeInteger3D, kOfxParamTypePage, kOfxParamTypeParametric, kOfxParamTypePushButton, kOfxParamTypeRGB, kOfxParamTypeRGBA, and kOfxParamTypeString.
Referenced by OFX::ParamSet::getParam(), and OFX::ParamSet::getParamType().
ParamTypeEnum OFX::mapParamTypeToEnum | ( | ) | [inline] |
Definition at line 1788 of file ofxsParam.h.
References eDummyParam.
ParamTypeEnum OFX::mapParamTypeToEnum< BooleanParam > | ( | ) | [inline] |
Definition at line 1838 of file ofxsParam.h.
References eBooleanParam.
ParamTypeEnum OFX::mapParamTypeToEnum< CameraParam > | ( | ) | [inline] |
Definition at line 1873 of file ofxsParam.h.
References eCameraParam.
ParamTypeEnum OFX::mapParamTypeToEnum< ChoiceParam > | ( | ) | [inline] |
Definition at line 1843 of file ofxsParam.h.
References eChoiceParam.
ParamTypeEnum OFX::mapParamTypeToEnum< CustomParam > | ( | ) | [inline] |
Definition at line 1848 of file ofxsParam.h.
References eCustomParam.
ParamTypeEnum OFX::mapParamTypeToEnum< Double2DParam > | ( | ) | [inline] |
Definition at line 1818 of file ofxsParam.h.
References eDouble2DParam.
ParamTypeEnum OFX::mapParamTypeToEnum< Double3DParam > | ( | ) | [inline] |
Definition at line 1823 of file ofxsParam.h.
References eDouble3DParam.
ParamTypeEnum OFX::mapParamTypeToEnum< DoubleParam > | ( | ) | [inline] |
Definition at line 1813 of file ofxsParam.h.
References eDoubleParam.
ParamTypeEnum OFX::mapParamTypeToEnum< GroupParam > | ( | ) | [inline] |
Definition at line 1853 of file ofxsParam.h.
References eGroupParam.
ParamTypeEnum OFX::mapParamTypeToEnum< Int2DParam > | ( | ) | [inline] |
Definition at line 1803 of file ofxsParam.h.
References eInt2DParam.
ParamTypeEnum OFX::mapParamTypeToEnum< Int3DParam > | ( | ) | [inline] |
Definition at line 1808 of file ofxsParam.h.
References eInt3DParam.
ParamTypeEnum OFX::mapParamTypeToEnum< IntParam > | ( | ) | [inline] |
Definition at line 1798 of file ofxsParam.h.
References eIntParam.
ParamTypeEnum OFX::mapParamTypeToEnum< PageParam > | ( | ) | [inline] |
Definition at line 1858 of file ofxsParam.h.
References ePageParam.
ParamTypeEnum OFX::mapParamTypeToEnum< ParametricParam > | ( | ) | [inline] |
Definition at line 1868 of file ofxsParam.h.
References eParametricParam.
ParamTypeEnum OFX::mapParamTypeToEnum< PushButtonParam > | ( | ) | [inline] |
Definition at line 1863 of file ofxsParam.h.
References ePushButtonParam.
ParamTypeEnum OFX::mapParamTypeToEnum< RGBAParam > | ( | ) | [inline] |
Definition at line 1833 of file ofxsParam.h.
References eRGBAParam.
ParamTypeEnum OFX::mapParamTypeToEnum< RGBParam > | ( | ) | [inline] |
Definition at line 1828 of file ofxsParam.h.
References eRGBParam.
ParamTypeEnum OFX::mapParamTypeToEnum< StringParam > | ( | ) | [inline] |
Definition at line 1793 of file ofxsParam.h.
References eStringParam.
ParamTypeEnum OFX::mapParamTypeToEnumFrom | ( | const ParamType & | ) | [inline] |
Definition at line 1879 of file ofxsParam.h.
ParamTypeEnum OFX::mapParamTypeToEnumFrom | ( | const ParamType * | ) | [inline] |
Definition at line 1884 of file ofxsParam.h.
std::string OFX::mapPixelComponentEnumToString | ( | const EPixelComponent | e | ) |
Definition at line 306 of file ofxsImageEffect.cpp.
References ePixelComponentAlpha, ePixelComponentCustom, ePixelComponentNone, ePixelComponentRGB, ePixelComponentRGBA, kOfxImageComponentAlpha, kOfxImageComponentNone, kOfxImageComponentRGB, and kOfxImageComponentRGBA.
Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), tuttle::plugin::doGilRender(), tuttle::plugin::doGilRender2(), main(), tuttle::plugin::bitDepth::BitDepthPlugin::render(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::render(), tuttle::plugin::imagemagick::reader::ImageMagickReaderPlugin::render(), tuttle::plugin::imagemagick::writer::ImageMagickWriterPlugin::render(), tuttle::plugin::idKeyer::IdKeyerPlugin::render(), tuttle::plugin::dpx::reader::DPXReaderPlugin::render(), tuttle::plugin::nlmDenoiser::NLMDenoiserPlugin::render(), tuttle::plugin::invert::InvertPlugin::render(), tuttle::plugin::ocio::lut::OCIOLutPlugin::render(), tuttle::plugin::basicKeyer::BasicKeyerPlugin::render(), tuttle::plugin::ocio::colorspace::OCIOColorSpacePlugin::render(), tuttle::plugin::colorTransfer::ColorTransferPlugin::render(), tuttle::plugin::ctl::CTLPlugin::render(), tuttle::plugin::text::TextPlugin::render(), tuttle::plugin::merge::MergePlugin::render(), tuttle::plugin::normalize::NormalizePlugin::render(), tuttle::plugin::warp::WarpPlugin::render(), tuttle::plugin::colorGradient::ColorGradientPlugin::renderFunctor(), tuttle::host::ofx::attribute::OfxhClipImage::setComponents(), and tuttle::plugin::bitDepth::BitDepthPlugin::setupDestView().
EPixelComponent OFX::mapPixelComponentStringToEnum | ( | const std::string & | str | ) |
turns a pixel component string into and enum
Definition at line 282 of file ofxsImageEffect.cpp.
References ePixelComponentAlpha, ePixelComponentCustom, ePixelComponentNone, ePixelComponentRGB, ePixelComponentRGBA, kOfxImageComponentAlpha, kOfxImageComponentNone, kOfxImageComponentRGB, and kOfxImageComponentRGBA.
Referenced by OFX::Private::fetchHostDescription(), tuttle::host::ofx::attribute::OfxhClipImage::getComponents(), OFX::Clip::getPixelComponents(), OFX::Clip::getUnmappedPixelComponents(), and OFX::Image::Image().
std::string OFX::mapPreMultiplicationEnumToString | ( | const EPreMultiplication | e | ) |
Definition at line 343 of file ofxsImageEffect.cpp.
References eImageOpaque, eImagePreMultiplied, eImageUnPreMultiplied, kOfxImageOpaque, kOfxImagePreMultiplied, and kOfxImageUnPreMultiplied.
EPreMultiplication OFX::mapPreMultiplicationStringToEnum | ( | const std::string & | str | ) |
turns a premultiplication string into and enum
Definition at line 325 of file ofxsImageEffect.cpp.
References eImageOpaque, eImagePreMultiplied, eImageUnPreMultiplied, kOfxImageOpaque, kOfxImagePreMultiplied, and kOfxImageUnPreMultiplied.
Referenced by OFX::Clip::getPreMultiplication(), and OFX::Image::Image().
std::string OFX::mapStatusToString | ( | const OfxStatus | stat | ) |
maps a status to a string for debugging purposes, note a c-str for printf
maps status to a string
Definition at line 71 of file ofxsCore.cpp.
References kOfxStatErrBadHandle, kOfxStatErrBadIndex, kOfxStatErrExists, kOfxStatErrFatal, kOfxStatErrFormat, kOfxStatErrImageFormat, kOfxStatErrMemory, kOfxStatErrMissingHostFeature, kOfxStatErrUnknown, kOfxStatErrUnsupported, kOfxStatErrValue, kOfxStatFailed, kOfxStatOK, kOfxStatReplyDefault, kOfxStatReplyNo, and kOfxStatReplyYes.
Referenced by tuttle::host::ofx::OfxhException::getStatusStr(), OFX::PropertySet::propGetDimension(), OFX::PropertySet::propGetDouble(), OFX::PropertySet::propGetInt(), OFX::PropertySet::propGetPointer(), OFX::PropertySet::propGetString(), OFX::PropertySet::propReset(), OFX::PropertySet::propSetDouble(), OFX::PropertySet::propSetInt(), OFX::PropertySet::propSetPointer(), OFX::PropertySet::propSetString(), and to_string().
static ImageEffect* OFX::retrieveEffectFromInteractHandle | ( | OfxInteractHandle | handle | ) | [static] |
retrieves the image effect pointer from the interact handle
Definition at line 86 of file ofxsInteract.cpp.
References OFX::Private::gInteractSuite, OfxInteractSuiteV1::interactGetPropertySet, kOfxPropEffectInstance, OFX::PropertySet::propGetPointer(), OFX::Private::retrieveImageEffectPointer(), and throwSuiteStatusException().
Referenced by OFX::Interact::Interact(), and OFX::Private::interactMainEntry().
void OFX::throwHostMissingSuiteException | ( | const std::string & | name | ) |
Definition at line 65 of file ofxsCore.cpp.
References kOfxStatErrUnsupported.
Referenced by OFX::ValueParam::deleteAllKeys(), OFX::ValueParam::deleteKeyAtTime(), OFX::DoubleParam::differentiate(), OFX::Double2DParam::differentiate(), OFX::Double3DParam::differentiate(), OFX::ValueParam::getKeyIndex(), OFX::ValueParam::getKeyTime(), OFX::ValueParam::getNumKeys(), OFX::DoubleParam::integrate(), OFX::Double2DParam::integrate(), OFX::Double3DParam::integrate(), OFX::ImageEffect::sendMessage(), OFX::IntParam::setValueAtTime(), OFX::Int2DParam::setValueAtTime(), OFX::Int3DParam::setValueAtTime(), OFX::DoubleParam::setValueAtTime(), OFX::Double2DParam::setValueAtTime(), OFX::Double3DParam::setValueAtTime(), OFX::RGBParam::setValueAtTime(), OFX::RGBAParam::setValueAtTime(), OFX::StringParam::setValueAtTime(), OFX::ChoiceParam::setValueAtTime(), OFX::BooleanParam::setValueAtTime(), and OFX::CustomParam::setValueAtTime().
void OFX::throwPropertyException | ( | OfxStatus | stat, |
const std::string & | propName | ||
) |
Definition at line 44 of file ofxsProperty.cpp.
References OFX::PropertySet::getThrowOnUnsupportedProperties(), kOfxStatErrBadHandle, kOfxStatErrBadIndex, kOfxStatErrMemory, kOfxStatErrUnknown, kOfxStatErrUnsupported, kOfxStatErrValue, kOfxStatOK, kOfxStatReplyDefault, kOfxStatReplyNo, kOfxStatReplyYes, and throwSuiteStatusException().
Referenced by OFX::PropertySet::propGetDimension(), OFX::PropertySet::propGetDouble(), OFX::PropertySet::propGetInt(), OFX::PropertySet::propGetPointer(), OFX::PropertySet::propGetString(), OFX::PropertySet::propReset(), OFX::PropertySet::propSetDouble(), OFX::PropertySet::propSetInt(), OFX::PropertySet::propSetPointer(), and OFX::PropertySet::propSetString().
void OFX::throwSuiteStatusException | ( | OfxStatus | stat | ) |
Throws an OFX::Exception::Suite depending on the status flag passed in.
Throws an OFX::Exception depending on the status flag passed in.
Definition at line 46 of file ofxsCore.cpp.
References kOfxStatErrMemory, kOfxStatOK, kOfxStatReplyDefault, kOfxStatReplyNo, and kOfxStatReplyYes.
Referenced by OFX::ParametricParam::addControlPoint(), OFX::ImageMemory::alloc(), OFX::ParamSet::beginEditBlock(), OFX::Private::checkMainHandles(), OFX::ParamSetDescriptor::defineRawParam(), OFX::ValueParam::deleteAllKeys(), OFX::ParametricParam::deleteControlPoint(), OFX::ValueParam::deleteKeyAtTime(), OFX::DoubleParam::differentiate(), OFX::Double2DParam::differentiate(), OFX::Double3DParam::differentiate(), OFX::ParamSet::endEditBlock(), OFX::ImageEffect::fetchClip(), OFX::Private::fetchEffectProps(), OFX::Clip::fetchImage(), OFX::ParamSet::fetchRawCameraParam(), OFX::ParamSet::fetchRawParam(), OFX::Clip::getCanonicalRod(), OFX::ValueParam::getKeyIndex(), OFX::ValueParam::getKeyTime(), OFX::ParametricParam::getNControlPoints(), OFX::ParametricParam::getNthControlPoints(), OFX::ValueParam::getNumKeys(), OFX::ParamSet::getParam(), OFX::ParamSet::getParamType(), OFX::StringParam::getPointerValue(), OFX::StringParam::getPointerValueAtTime(), OFX::IntParam::getValue(), OFX::Int2DParam::getValue(), OFX::Int3DParam::getValue(), OFX::DoubleParam::getValue(), OFX::Double2DParam::getValue(), OFX::Double3DParam::getValue(), OFX::RGBParam::getValue(), OFX::RGBAParam::getValue(), OFX::ChoiceParam::getValue(), OFX::BooleanParam::getValue(), OFX::CustomParam::getValue(), OFX::ParametricParam::getValue(), OFX::IntParam::getValueAtTime(), OFX::Int2DParam::getValueAtTime(), OFX::Int3DParam::getValueAtTime(), OFX::DoubleParam::getValueAtTime(), OFX::Double2DParam::getValueAtTime(), OFX::Double3DParam::getValueAtTime(), OFX::RGBParam::getValueAtTime(), OFX::RGBAParam::getValueAtTime(), OFX::ChoiceParam::getValueAtTime(), OFX::BooleanParam::getValueAtTime(), OFX::CustomParam::getValueAtTime(), OFX::ImageEffect::ImageEffect(), OFX::ImageEffectDescriptor::ImageEffectDescriptor(), OFX::DoubleParam::integrate(), OFX::Double2DParam::integrate(), OFX::Double3DParam::integrate(), OFX::Interact::Interact(), OFX::Private::interactMainEntry(), OFX::MultiThread::Mutex::lock(), OFX::ImageMemory::lock(), OFX::MultiThread::Processor::multiThread(), OFX::MultiThread::Mutex::Mutex(), OFX::Param::Param(), OFX::Interact::requestRedraw(), retrieveEffectFromInteractHandle(), OFX::Private::retrieveImageEffectPointer(), OFX::Private::retrieveInteractPointer(), OFX::ParametricParam::setNthControlPoints(), OFX::ParamSetDescriptor::setOfxParamSetHandle(), OFX::ParamSet::setParamSetHandle(), OFX::IntParam::setValue(), OFX::Int2DParam::setValue(), OFX::Int3DParam::setValue(), OFX::DoubleParam::setValue(), OFX::Double2DParam::setValue(), OFX::Double3DParam::setValue(), OFX::RGBParam::setValue(), OFX::RGBAParam::setValue(), OFX::StringParam::setValue(), OFX::ChoiceParam::setValue(), OFX::BooleanParam::setValue(), OFX::CustomParam::setValue(), OFX::IntParam::setValueAtTime(), OFX::Int2DParam::setValueAtTime(), OFX::Int3DParam::setValueAtTime(), OFX::DoubleParam::setValueAtTime(), OFX::Double2DParam::setValueAtTime(), OFX::Double3DParam::setValueAtTime(), OFX::RGBParam::setValueAtTime(), OFX::RGBAParam::setValueAtTime(), OFX::StringParam::setValueAtTime(), OFX::ChoiceParam::setValueAtTime(), OFX::BooleanParam::setValueAtTime(), OFX::CustomParam::setValueAtTime(), OFX::Interact::swapBuffers(), throwPropertyException(), and OFX::MultiThread::Mutex::unlock().
std::string OFX::to_string | ( | const ofxStatus & | e | ) | [inline] |
Definition at line 56 of file exceptions.hpp.
References mapStatusToString().
Referenced by tuttle::host::Core::preload().
const OfxPointD OFX::kNoRenderScale = { 1.0, 1.0 } [static] |
Definition at line 916 of file ofxsImageEffect.h.
Definition at line 63 of file ofxsImageEffect.cpp.
Referenced by init(), and OfxGetNumberOfPlugins().