InputBuffer plugin. More...

#include <InputBufferPlugin.hpp>

Inheritance diagram for tuttle::plugin::inputBuffer::InputBufferPlugin:

Collaboration diagram for tuttle::plugin::inputBuffer::InputBufferPlugin:

Public Types
typedef float	Scalar
Public Member Functions
	InputBufferPlugin (OfxImageEffectHandle handle)
	~InputBufferPlugin ()
InputBufferProcessParams	getProcessParams (const OfxTime time) const
void	changedParam (const OFX::InstanceChangedArgs &args, const std::string &paramName)
	called when a param has just had its value changed
bool	getTimeDomain (OfxRangeD &range)
	what is the time domain of this effect, valid only in the general context
void	getClipPreferences (OFX::ClipPreferencesSetter &clipPreferences)
	get the clip preferences
bool	getRegionOfDefinition (const OFX::RegionOfDefinitionArguments &args, OfxRectD &rod)
	The get RoD action.
void	render (const OFX::RenderArguments &args)
	The overridden render function.
Data Fields
OFX::Clip *	_clipDst
	Destination image clip.
OFX::ChoiceParam *	_paramInputMode
OFX::StringParam *	_paramInputBufferPointer
OFX::StringParam *	_paramInputCallbackPointer
OFX::StringParam *	_paramInputCallbackCustomData
OFX::StringParam *	_paramInputCallbackDestroyCustomData
OFX::Int2DParam *	_paramSize
OFX::IntParam *	_paramRowByteSize
OFX::DoubleParam *	_paramPixelAspectRatio
OFX::DoubleParam *	_paramFramerate
OFX::ChoiceParam *	_paramPixelComponents
OFX::ChoiceParam *	_paramBitDepth
OFX::ChoiceParam *	_paramField
OFX::ChoiceParam *	_paramOrientation
OFX::Double2DParam *	_paramTimeDomain
Private Member Functions
void	callbackMode_updateImage (const OfxTime time, const InputBufferProcessParams &params)
	We call this function each time we need to know something about the image, the size, the buffer, etc. And this function ensures to get valid values, and is responsible to call the callback only once for a given input time.
Private Attributes
CustomDataPtr	_tempStoreCustomDataPtr

OfxTime	_callbackMode_time
	Store temporary values (between actions). We ensure that we call the get image callback only once, but we need the values multiple times.
OfxPointI	_callbackMode_imgSize
int	_callbackMode_rowSizeBytes
unsigned char *	_callbackMode_imgPointer

Detailed Description

InputBuffer plugin.

Definition at line 37 of file InputBufferPlugin.hpp.

Member Typedef Documentation

typedef float tuttle::plugin::inputBuffer::InputBufferPlugin::Scalar

Definition at line 40 of file InputBufferPlugin.hpp.

Constructor & Destructor Documentation

tuttle::plugin::inputBuffer::InputBufferPlugin::InputBufferPlugin ( OfxImageEffectHandle handle )

Definition at line 61 of file InputBufferPlugin.cpp.

Here is the call graph for this function:

tuttle::plugin::inputBuffer::InputBufferPlugin::~InputBufferPlugin ( )

Definition at line 93 of file InputBufferPlugin.cpp.

Member Function Documentation

void tuttle::plugin::inputBuffer::InputBufferPlugin::callbackMode_updateImage	(	const OfxTime	time,
		const InputBufferProcessParams &	params
	)		`[private]`

We call this function each time we need to know something about the image, the size, the buffer, etc. And this function ensures to get valid values, and is responsible to call the callback only once for a given input time.

Definition at line 234 of file InputBufferPlugin.cpp.

References _callbackMode_imgPointer, _callbackMode_imgSize, _callbackMode_rowSizeBytes, _callbackMode_time, tuttle::plugin::inputBuffer::InputBufferProcessParams::_callbackPtr, tuttle::plugin::inputBuffer::InputBufferProcessParams::_customDataPtr, OfxPointI::x, and OfxPointI::y.

Referenced by getRegionOfDefinition(), and render().

void tuttle::plugin::inputBuffer::InputBufferPlugin::changedParam	(	const OFX::InstanceChangedArgs &	args,
		const std::string &	paramName
	)		`[virtual]`

called when a param has just had its value changed

Reimplemented from OFX::ImageEffect.

Definition at line 159 of file InputBufferPlugin.cpp.

References tuttle::plugin::inputBuffer::InputBufferProcessParams::_callbackDestroyPtr, _paramInputBufferPointer, _paramInputCallbackCustomData, _paramInputCallbackPointer, _paramInputMode, _tempStoreCustomDataPtr, tuttle::plugin::inputBuffer::eParamInputModeBufferPointer, tuttle::plugin::inputBuffer::eParamInputModeCallbackPointer, getProcessParams(), OFX::StringParam::getValue(), OFX::ChoiceParam::getValue(), tuttle::plugin::inputBuffer::kParamInputBufferPointer, tuttle::plugin::inputBuffer::kParamInputCallbackPointer, tuttle::plugin::inputBuffer::kParamInputCustomData, tuttle::plugin::inputBuffer::kParamInputMode, OFX::Param::setIsSecretAndDisabled(), OFX::ChoiceParam::setValue(), tuttle::plugin::memoryBuffer::stringToPointer(), and OFX::InstanceChangedArgs::time.

Referenced by InputBufferPlugin().

Here is the call graph for this function:

void tuttle::plugin::inputBuffer::InputBufferPlugin::getClipPreferences ( OFX::ClipPreferencesSetter & clipPreferences ) [virtual]

get the clip preferences

Reimplemented from OFX::ImageEffect.

Definition at line 193 of file InputBufferPlugin.cpp.

References tuttle::plugin::inputBuffer::InputBufferProcessParams::_bitDepth, _clipDst, tuttle::plugin::inputBuffer::InputBufferProcessParams::_field, tuttle::plugin::inputBuffer::InputBufferProcessParams::_framerate, tuttle::plugin::inputBuffer::InputBufferProcessParams::_mode, _paramTimeDomain, tuttle::plugin::inputBuffer::InputBufferProcessParams::_pixelAspectRatio, tuttle::plugin::inputBuffer::InputBufferProcessParams::_pixelComponents, tuttle::plugin::inputBuffer::eParamInputModeCallbackPointer, getProcessParams(), OFX::Double2DParam::getValue(), OfxRangeD::max, OfxRangeD::min, OFX::ClipPreferencesSetter::setClipBitDepth(), OFX::ClipPreferencesSetter::setClipComponents(), OFX::ClipPreferencesSetter::setOutputFielding(), OFX::ClipPreferencesSetter::setOutputFrameRate(), OFX::ClipPreferencesSetter::setOutputFrameVarying(), and OFX::ClipPreferencesSetter::setPixelAspectRatio().

Here is the call graph for this function:

InputBufferProcessParams tuttle::plugin::inputBuffer::InputBufferPlugin::getProcessParams ( const OfxTime time ) const

Definition at line 97 of file InputBufferPlugin.cpp.

Referenced by changedParam(), getClipPreferences(), getRegionOfDefinition(), and render().

Here is the call graph for this function:

bool tuttle::plugin::inputBuffer::InputBufferPlugin::getRegionOfDefinition	(	const OFX::RegionOfDefinitionArguments &	args,
		OfxRectD &	rod
	)		`[virtual]`

The get RoD action.

If the effect wants change the rod from the default value (which is the union of RoD's of all input clips) it should set the rod argument and return true.

This is all in cannonical coordinates.

Reimplemented from OFX::ImageEffect.

Definition at line 207 of file InputBufferPlugin.cpp.

References _callbackMode_imgSize, tuttle::plugin::inputBuffer::InputBufferProcessParams::_mode, _paramSize, callbackMode_updateImage(), tuttle::plugin::inputBuffer::eParamInputModeBufferPointer, tuttle::plugin::inputBuffer::eParamInputModeCallbackPointer, getProcessParams(), OFX::Int2DParam::getValueAtTime(), OFX::RegionOfDefinitionArguments::time, OfxPointI::x, OfxRectD::x1, OfxRectD::x2, OfxPointI::y, OfxRectD::y1, and OfxRectD::y2.