AudioVideo plugin. More...

#include <AVReaderPlugin.hpp>

Inheritance diagram for tuttle::plugin::av::reader::AVReaderPlugin:

Collaboration diagram for tuttle::plugin::av::reader::AVReaderPlugin:

Public Member Functions
	AVReaderPlugin (OfxImageEffectHandle handle)
bool	ensureVideoIsOpen ()
	Open the video if not already opened.
AVReaderParams	getProcessParams () const
void	updateVisibleTools ()
void	changedParam (const OFX::InstanceChangedArgs &args, const std::string &paramName)
	called when a param has just had its value changed
bool	getRegionOfDefinition (const OFX::RegionOfDefinitionArguments &args, OfxRectD &rod)
	The get RoD action.
void	getClipPreferences (OFX::ClipPreferencesSetter &clipPreferences)
	get the clip preferences
bool	getTimeDomain (OfxRangeD &range)
	what is the time domain of this effect, valid only in the general context
void	beginSequenceRender (const OFX::BeginSequenceRenderArguments &args)
	client begin sequence render function
void	render (const OFX::RenderArguments &args)
	The overridden render function.
void	endSequenceRender (const OFX::EndSequenceRenderArguments &args)
	client end sequence render function
Data Fields
OFX::Clip *	_clipDst
	Destination image clip.
OFX::StringParam *	_paramFilepath
	video filepath
OFX::BooleanParam *	_paramUseCustomSAR
	Keep sample aspect ratio.
OFX::DoubleParam *	_paramCustomSAR
	Custom SAR to use.
bool	_errorInFile
bool	_initReader
LibAVVideoReader	_reader

Detailed Description

AudioVideo plugin.

Definition at line 25 of file AVReaderPlugin.hpp.

Constructor & Destructor Documentation

tuttle::plugin::av::reader::AVReaderPlugin::AVReaderPlugin ( OfxImageEffectHandle handle )

Definition at line 18 of file AVReaderPlugin.cpp.

References _clipDst, tuttle::plugin::ReaderPlugin::_paramBitDepth, _paramCustomSAR, _paramFilepath, _paramUseCustomSAR, OFX::ParamSet::fetchBooleanParam(), OFX::ParamSet::fetchChoiceParam(), OFX::ImageEffect::fetchClip(), OFX::ParamSet::fetchDoubleParam(), OFX::ParamSet::fetchStringParam(), kOfxImageEffectOutputClipName, tuttle::plugin::av::reader::kParamCustomSAR, tuttle::plugin::av::reader::kParamUseCustomSAR, tuttle::plugin::kTuttlePluginBitDepth, tuttle::plugin::kTuttlePluginFilename, OFX::ImageEffect::setSequentialRender(), and updateVisibleTools().

Here is the call graph for this function:

Member Function Documentation

void tuttle::plugin::av::reader::AVReaderPlugin::beginSequenceRender ( const OFX::BeginSequenceRenderArguments & args ) [virtual]

client begin sequence render function

Reimplemented from OFX::ImageEffect.

Definition at line 160 of file AVReaderPlugin.cpp.

References ensureVideoIsOpen().

Here is the call graph for this function:

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

called when a param has just had its value changed

Reimplemented from tuttle::plugin::ReaderPlugin.

Definition at line 67 of file AVReaderPlugin.cpp.

References _errorInFile, _paramCustomSAR, _paramUseCustomSAR, OFX::BooleanParam::getValue(), tuttle::plugin::av::reader::kParamCustomSAR, tuttle::plugin::av::reader::kParamUseCustomSAR, tuttle::plugin::kTuttlePluginFilename, OFX::Param::setIsSecretAndDisabled(), and OFX::BooleanParam::setValue().

Referenced by updateVisibleTools().

Here is the call graph for this function:

void tuttle::plugin::av::reader::AVReaderPlugin::endSequenceRender ( const OFX::EndSequenceRenderArguments & args ) [virtual]

client end sequence render function

client end sequence render function, this is one of the few that must be set

Reimplemented from OFX::ImageEffect.

Definition at line 201 of file AVReaderPlugin.cpp.

References _reader, and tuttle::plugin::av::LibAVVideoReader::close().

Here is the call graph for this function:

bool tuttle::plugin::av::reader::AVReaderPlugin::ensureVideoIsOpen ( )

Open the video if not already opened.

Returns:: If the video file is now open, else the file doesn't exist, is unrecognized or is corrupted.

Definition at line 54 of file AVReaderPlugin.cpp.

References _errorInFile, _paramFilepath, _reader, OFX::StringParam::getValue(), tuttle::plugin::av::LibAVVideoReader::isOpen(), and tuttle::plugin::av::LibAVVideoReader::open().

Referenced by beginSequenceRender(), getClipPreferences(), getRegionOfDefinition(), getTimeDomain(), and render().

Here is the call graph for this function:

void tuttle::plugin::av::reader::AVReaderPlugin::getClipPreferences ( OFX::ClipPreferencesSetter & clipPreferences ) [virtual]

get the clip preferences

Todo:: tuttle: some video format may need other bit depth (how we can detect this ?)

Reimplemented from tuttle::plugin::ReaderPlugin.

Definition at line 92 of file AVReaderPlugin.cpp.

References _clipDst, _paramCustomSAR, _paramUseCustomSAR, _reader, tuttle::plugin::av::LibAVVideoReader::aspectRatio(), OFX::eBitDepthUByte, OFX::eFieldLower, OFX::eFieldNone, OFX::eFieldUpper, tuttle::plugin::av::eInterlacmentLower, tuttle::plugin::av::eInterlacmentNone, tuttle::plugin::av::eInterlacmentUpper, ensureVideoIsOpen(), tuttle::plugin::eParamReaderBitDepthAuto, OFX::ePixelComponentRGBA, tuttle::plugin::av::LibAVVideoReader::fps(), tuttle::plugin::ReaderPlugin::getExplicitBitDepthConversion(), OFX::DoubleParam::getValue(), OFX::BooleanParam::getValue(), tuttle::plugin::av::LibAVVideoReader::interlacment(), 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:

AVReaderParams tuttle::plugin::av::reader::AVReaderPlugin::getProcessParams ( ) const

Definition at line 41 of file AVReaderPlugin.cpp.

References tuttle::plugin::av::reader::AVReaderParams::_filepath, _paramFilepath, and OFX::StringParam::getValue().

Here is the call graph for this function:

bool tuttle::plugin::av::reader::AVReaderPlugin::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.

Implements tuttle::plugin::ReaderPlugin.

Definition at line 145 of file AVReaderPlugin.cpp.

References _paramCustomSAR, _paramUseCustomSAR, _reader, tuttle::plugin::av::LibAVVideoReader::aspectRatio(), ensureVideoIsOpen(), OFX::DoubleParam::getValue(), OFX::BooleanParam::getValue(), tuttle::plugin::av::LibAVVideoReader::height(), tuttle::plugin::av::LibAVVideoReader::width(), OfxRectD::x1, OfxRectD::x2, OfxRectD::y1, and OfxRectD::y2.