#include <WriterPlugin.hpp>

Inheritance diagram for tuttle::plugin::WriterPlugin:

Collaboration diagram for tuttle::plugin::WriterPlugin:

Public Member Functions
	WriterPlugin (OfxImageEffectHandle handle)
virtual	~WriterPlugin ()=0
virtual void	changedParam (const OFX::InstanceChangedArgs &args, const std::string &paramName)
	called when a param has just had its value changed
virtual void	getClipPreferences (OFX::ClipPreferencesSetter &clipPreferences)
	get the clip preferences
virtual bool	isIdentity (const OFX::RenderArguments &args, OFX::Clip *&identityClip, double &identityTime)
	client is identity function, returns the clip and time for the identity function
virtual void	beginSequenceRender (const OFX::BeginSequenceRenderArguments &args)
	client begin sequence render function
virtual void	render (const OFX::RenderArguments &args)
	client render function, this is one of the few that must be overridden
std::string	getAbsoluteFilenameAt (const OfxTime time) const
std::string	getAbsoluteDirectory () const
std::string	getAbsoluteFirstFilename () const
OfxTime	getFirstTime () const
OfxTime	getLastTime () const
Data Fields

OFX::Clip *	_clipSrc
	Input image clip.
OFX::Clip *	_clipDst
	Ouput image clip.
OFX::PushButtonParam *	_paramRenderButton
	Render push button.
OFX::StringParam *	_paramFilepath
	Target file path.
OFX::BooleanParam *	_paramRenderAlways
	Render always.
OFX::ChoiceParam *	_paramBitDepth
	Bit depth.
OFX::IntParam *	_paramForceNewRender
	Hack parameter, to force a new rendering.
OFX::BooleanParam *	_paramPremult
Protected Member Functions
bool	varyOnTime () const
Private Attributes
bool	_isSequence
sequenceParser::Sequence	_filePattern
	Filename pattern manager.
bool	_oneRender
OfxTime	_oneRenderAtTime

Detailed Description

Definition at line 24 of file WriterPlugin.hpp.

Constructor & Destructor Documentation

tuttle::plugin::WriterPlugin::WriterPlugin ( OfxImageEffectHandle handle )

Definition at line 14 of file WriterPlugin.cpp.

References _clipDst, _clipSrc, _filePattern, _isSequence, _paramBitDepth, _paramFilepath, _paramForceNewRender, _paramPremult, _paramRenderAlways, _paramRenderButton, OFX::ParamSet::fetchBooleanParam(), OFX::ParamSet::fetchChoiceParam(), OFX::ImageEffect::fetchClip(), OFX::ParamSet::fetchIntParam(), OFX::ParamSet::fetchPushButtonParam(), OFX::ParamSet::fetchStringParam(), OFX::StringParam::getValue(), sequenceParser::Sequence::initFromDetection(), kOfxImageEffectOutputClipName, kOfxImageEffectSimpleSourceClipName, tuttle::plugin::kParamPremultiplied, tuttle::plugin::kParamWriterForceNewRender, tuttle::plugin::kParamWriterRender, tuttle::plugin::kParamWriterRenderAlways, tuttle::plugin::kTuttlePluginBitDepth, and tuttle::plugin::kTuttlePluginFilename.

Here is the call graph for this function:

tuttle::plugin::WriterPlugin::~WriterPlugin ( ) [pure virtual]

Definition at line 30 of file WriterPlugin.cpp.

Member Function Documentation

void tuttle::plugin::WriterPlugin::beginSequenceRender ( const OFX::BeginSequenceRenderArguments & args ) [virtual]

client begin sequence render function

Reimplemented from OFX::ImageEffect.

Reimplemented in tuttle::plugin::av::writer::AVWriterPlugin.

Definition at line 75 of file WriterPlugin.cpp.

References getAbsoluteDirectory().

Here is the call graph for this function:

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

called when a param has just had its value changed

Reimplemented from OFX::ImageEffect.

Reimplemented in tuttle::plugin::av::writer::AVWriterPlugin, tuttle::plugin::dpx::writer::DPXWriterPlugin, and tuttle::plugin::jpeg2000::writer::Jpeg2000WriterPlugin.

Definition at line 34 of file WriterPlugin.cpp.

References _filePattern, _isSequence, _oneRender, _oneRenderAtTime, _paramFilepath, _paramForceNewRender, OFX::IntParam::getValue(), OFX::StringParam::getValue(), sequenceParser::Sequence::initFromDetection(), tuttle::plugin::kParamWriterRender, tuttle::plugin::kTuttlePluginFilename, OFX::IntParam::setValue(), and OFX::InstanceChangedArgs::time.

Here is the call graph for this function:

std::string tuttle::plugin::WriterPlugin::getAbsoluteDirectory ( ) const [inline]

Definition at line 57 of file WriterPlugin.hpp.

References _filePattern, _isSequence, _paramFilepath, sequenceParser::FileObject::getAbsoluteDirectory(), and OFX::StringParam::getValue().

Referenced by beginSequenceRender().

Here is the call graph for this function:

std::string Sequence::getAbsoluteFilenameAt ( const OfxTime time ) const [inline]

Definition at line 49 of file WriterPlugin.hpp.

References _filePattern, _isSequence, _paramFilepath, sequenceParser::Sequence::getAbsoluteFilenameAt(), and OFX::StringParam::getValue().

Here is the call graph for this function:

std::string Sequence::getAbsoluteFirstFilename ( ) const [inline]

Definition at line 71 of file WriterPlugin.hpp.

References _filePattern, _isSequence, _paramFilepath, sequenceParser::Sequence::getAbsoluteFirstFilename(), and OFX::StringParam::getValue().

Here is the call graph for this function:

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

get the clip preferences

Reimplemented from OFX::ImageEffect.

Reimplemented in tuttle::plugin::av::writer::AVWriterPlugin.

Definition at line 49 of file WriterPlugin.cpp.

References OFX::ClipPreferencesSetter::setOutputFrameVarying(), and varyOnTime().

Here is the call graph for this function:

Time Sequence::getFirstTime ( ) const [inline]

Definition at line 79 of file WriterPlugin.hpp.

References _filePattern, _isSequence, sequenceParser::Sequence::getFirstTime(), and kOfxFlagInfiniteMin.

Here is the call graph for this function:

Time Sequence::getLastTime ( ) const [inline]

Definition at line 87 of file WriterPlugin.hpp.

References _filePattern, _isSequence, sequenceParser::Sequence::getLastTime(), and kOfxFlagInfiniteMax.

Here is the call graph for this function:

bool tuttle::plugin::WriterPlugin::isIdentity	(	const OFX::RenderArguments &	args,
		OFX::Clip *&	identityClip,
		double &	identityTime
	)		`[virtual]`

client is identity function, returns the clip and time for the identity function

If the effect would do no processing for the given param set and render arguments, then this function should return true and set the identityClip pointer to point to the clip that is the identity and identityTime to be the time at which to access the clip for the identity operation.

Reimplemented from OFX::ImageEffect.

Reimplemented in tuttle::plugin::av::writer::AVWriterPlugin.

Definition at line 55 of file WriterPlugin.cpp.

References _clipSrc, _oneRender, _oneRenderAtTime, _paramRenderAlways, OFX::getImageEffectHostDescription(), OFX::BooleanParam::getValue(), and OFX::RenderArguments::time.

Here is the call graph for this function: