#include <ReaderPlugin.hpp>

Inheritance diagram for tuttle::plugin::ReaderPlugin:

Collaboration diagram for tuttle::plugin::ReaderPlugin:

Public Member Functions
	ReaderPlugin (OfxImageEffectHandle handle)
virtual	~ReaderPlugin ()=0
virtual void	changedParam (const OFX::InstanceChangedArgs &args, const std::string &paramName)
	called when a param has just had its value changed
virtual bool	getRegionOfDefinition (const OFX::RegionOfDefinitionArguments &args, OfxRectD &rod)=0
	The get RoD action.
virtual void	getClipPreferences (OFX::ClipPreferencesSetter &clipPreferences)
	get the clip preferences
virtual bool	getTimeDomain (OfxRangeD &range)
	what is the time domain of this effect, valid only in the general context
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	getAbsoluteFirstFilename () const
OfxTime	getFirstTime () const
OfxTime	getLastTime () const
EParamReaderBitDepth	getExplicitBitDepthConversion () const
EParamReaderChannel	getExplicitChannelConversion () const
OFX::EBitDepth	getOfxExplicitConversion () const
Data Fields
OFX::Clip *	_clipDst
user parameters
OFX::StringParam *	_paramFilepath
	File path.
OFX::ChoiceParam *	_paramBitDepth
	Explicit bit depth conversion.
OFX::ChoiceParam *	_paramChannel
Protected Member Functions
virtual bool	varyOnTime () const
Private Attributes
bool	_isSequence
sequenceParser::Sequence	_filePattern
	Filename pattern manager.

Detailed Description

Definition at line 16 of file ReaderPlugin.hpp.

Constructor & Destructor Documentation

tuttle::plugin::ReaderPlugin::ReaderPlugin ( OfxImageEffectHandle handle )

Definition at line 8 of file ReaderPlugin.cpp.

References _clipDst, _filePattern, _isSequence, _paramBitDepth, _paramChannel, _paramFilepath, OFX::ParamSet::fetchChoiceParam(), OFX::ImageEffect::fetchClip(), OFX::ParamSet::fetchStringParam(), OFX::StringParam::getValue(), sequenceParser::Sequence::initFromDetection(), kOfxImageEffectOutputClipName, tuttle::plugin::kTuttlePluginBitDepth, tuttle::plugin::kTuttlePluginChannel, and tuttle::plugin::kTuttlePluginFilename.

Here is the call graph for this function:

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

Definition at line 18 of file ReaderPlugin.cpp.

Member Function Documentation

void tuttle::plugin::ReaderPlugin::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 21 of file ReaderPlugin.cpp.

References _filePattern, _isSequence, _paramFilepath, OFX::StringParam::getValue(), sequenceParser::Sequence::initFromDetection(), and tuttle::plugin::kTuttlePluginFilename.

Here is the call graph for this function:

std::string tuttle::plugin::ReaderPlugin::getAbsoluteFilenameAt ( const OfxTime time ) const [inline]

Definition at line 31 of file ReaderPlugin.hpp.

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

Here is the call graph for this function:

std::string tuttle::plugin::ReaderPlugin::getAbsoluteFirstFilename ( ) const [inline]

Definition at line 46 of file ReaderPlugin.hpp.

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

Referenced by getClipPreferences(), tuttle::plugin::dpx::reader::DPXReaderPlugin::getClipPreferences(), tuttle::plugin::openImageIO::reader::OpenImageIOReaderPlugin::getClipPreferences(), tuttle::plugin::imagemagick::reader::ImageMagickReaderPlugin::getClipPreferences(), tuttle::plugin::png::reader::PngReaderPlugin::getClipPreferences(), and tuttle::plugin::exr::reader::EXRReaderPlugin::updateCombos().

Here is the call graph for this function:

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

get the clip preferences

Reimplemented from OFX::ImageEffect.

Definition at line 29 of file ReaderPlugin.cpp.

Here is the call graph for this function:

EParamReaderBitDepth tuttle::plugin::ReaderPlugin::getExplicitBitDepthConversion ( ) const [inline]

Definition at line 70 of file ReaderPlugin.hpp.

References _paramBitDepth, and OFX::ChoiceParam::getValue().

Here is the call graph for this function:

EParamReaderChannel tuttle::plugin::ReaderPlugin::getExplicitChannelConversion ( ) const [inline]

Definition at line 76 of file ReaderPlugin.hpp.

References _paramChannel, and OFX::ChoiceParam::getValue().

Referenced by getClipPreferences(), tuttle::plugin::openImageIO::reader::OpenImageIOReaderPlugin::getClipPreferences(), tuttle::plugin::png::reader::PngReaderPlugin::getClipPreferences(), tuttle::plugin::jpeg::reader::JpegReaderPlugin::getClipPreferences(), tuttle::plugin::imagemagick::reader::ImageMagickReaderPlugin::getClipPreferences(), tuttle::plugin::jpeg2000::reader::Jpeg2000ReaderPlugin::getClipPreferences(), tuttle::plugin::turboJpeg::reader::TurboJpegReaderPlugin::getClipPreferences(), and tuttle::plugin::exr::reader::EXRReaderPlugin::getClipPreferences().

Here is the call graph for this function:

OfxTime tuttle::plugin::ReaderPlugin::getFirstTime ( ) const [inline]

Definition at line 54 of file ReaderPlugin.hpp.

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

Referenced by tuttle::plugin::jpeg2000::reader::Jpeg2000ReaderPlugin::getClipPreferences(), tuttle::plugin::jpeg2000::reader::Jpeg2000ReaderPlugin::getProcessParams(), and getTimeDomain().

Here is the call graph for this function:

OfxTime tuttle::plugin::ReaderPlugin::getLastTime ( ) const [inline]

Definition at line 62 of file ReaderPlugin.hpp.

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

Referenced by tuttle::plugin::jpeg2000::reader::Jpeg2000ReaderPlugin::getProcessParams(), and getTimeDomain().

Here is the call graph for this function:

OFX::EBitDepth tuttle::plugin::ReaderPlugin::getOfxExplicitConversion ( ) const [inline]

Definition at line 81 of file ReaderPlugin.hpp.

References OFX::eBitDepthFloat, OFX::eBitDepthNone, OFX::eBitDepthUByte, OFX::eBitDepthUShort, tuttle::plugin::eParamReaderBitDepthAuto, tuttle::plugin::eParamReaderBitDepthByte, tuttle::plugin::eParamReaderBitDepthFloat, tuttle::plugin::eParamReaderBitDepthShort, and getExplicitBitDepthConversion().

Referenced by tuttle::plugin::jpeg2000::reader::Jpeg2000ReaderPlugin::getClipPreferences().

Here is the call graph for this function:

virtual bool tuttle::plugin::ReaderPlugin::getRegionOfDefinition	(	const OFX::RegionOfDefinitionArguments &	args,
		OfxRectD &	rod
	)		`[pure 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.