Namespaces
namespace	samdo
Typedefs
typedef std::pair < ttl::ofx::attribute::OfxhClipImage *, std::string >	ClipAndConnection
Functions
std::string	retrieveNodeFullname (const std::string &userId)
void	setParametersForNode (const std::vector< std::string > parameters, ttl::Graph::Node &currentNode, std::vector< ClipAndConnection > &clipsToConnect, const bool isDummyNode=false, bool orderedParams=true)
void	connectClips (const std::vector< ttl::Graph::Node * > nodes, const std::vector< ClipAndConnection > clipsToConnect, ttl::Graph::Node &currentNode, ttl::Graph &graph, const std::vector< std::string > idNames)
std::vector< std::string >	getStringValues (const tuttle::host::ofx::property::OfxhProperty &prop)
	Get all values of the property as a vector of strings.
std::string	getFormattedStringValue (const tuttle::host::ofx::property::OfxhProperty &prop)
	Return a string to represent the property value or values. If multiple values, return a string like "a,b,c".
void	coutProperties (const ttl::Graph::Node &node)
void	coutClipsWithDetails (const ttl::Graph::Node &node)
void	coutClips (const ttl::Graph::Node &node)
void	coutParameterValues (std::ostream &os, const ttl::ofx::attribute::OfxhParam &param)
void	coutParameterWithDetails (const ttl::ofx::attribute::OfxhParam &param)
void	coutParametersWithDetails (const ttl::Graph::Node &node)
void	coutParameters (const ttl::Graph::Node &node)
bfs::path	retrieveToolFullPath (const std::string &toolName, const std::vector< bfs::path > &searchPaths)
std::vector< bfs::path >	retrieveSearchPaths (const bfs::path &samDirectory)
std::vector< bfs::path >	retrieveAllSamCommands (const bfs::path &dir)
std::vector< bfs::path >	retrieveAllSamCommands (const std::vector< bfs::path > &dirs)
Variables
static const char *const	kUrlTuttleofxProject = "http://sites.google.com/site/tuttleofx"
static const char *const	kAllOptionLongName = "all"
	options with short-cut
static const char *const	kAllOptionString = "all,a"
static const char *const	kAllOptionMessage = "do not ignore entries starting with ."
static const char *const	kAttributesOptionLongName = "attributes"
static const char *const	kAttributesOptionString = "attributes,A"
static const char *const	kAttributesOptionMessage = "show all attributes: parameters+clips"
static const char *const	kCommandsOptionLongName = "commands"
static const char *const	kCommandsOptionString = "commands,c"
static const char *const	kCommandsOptionMessage = "show list of all available sam commands"
static const char *const	kDirectoriesOptionLongName = "directories"
static const char *const	kDirectoriesOptionString = "directories,d"
static const char *const	kDirectoriesOptionMessage = "handle directories"
static const char *const	kExpressionOptionLongName = "expression"
static const char *const	kExpressionOptionString = "expression,e"
static const char *const	kExpressionOptionMessage = "use a specific pattern, ex: .jpg,.png"
static const char *const	kFilesOptionLongName = "files"
static const char *const	kFilesOptionString = "files,f"
static const char *const	kFilesOptionMessage = "handle files"
static const char *const	kFilterOptionLongName = "filter"
static const char *const	kFilterOptionString = "filter,F"
static const char *const	kFilterOptionMessage = "filtering the output for research a plugin. ex: -f \"blur,tuttle*\""
static const char *const	kHelpOptionLongName = "help"
static const char *const	kHelpOptionString = "help,h"
static const char *const	kHelpOptionMessage = "display help"
static const char *const	kInputOptionLongName = "input"
static const char *const	kInputOptionString = "input,i"
static const char *const	kInputOptionMessage = "input pathname: directory, file or sequence pattern"
static const char *const	kIgnoreOptionLongName = "ignore"
static const char *const	kIgnoreOptionString = "ignore,I"
static const char *const	kIgnoreOptionMessage = "ignore the specified sequence"
static const char *const	kLongListingOptionLongName = "long-listing"
static const char *const	kLongListingOptionString = "long-listing,l"
static const char *const	kLongListingOptionMessage = "use a long listing format"
static const char *const	kNodesOptionLongName = "nodes"
static const char *const	kNodesOptionString = "nodes,n"
static const char *const	kNodesOptionMessage = "list all avalaible node"
static const char *const	kOffsetOptionLongName = "offset"
static const char *const	kOffsetOptionString = "offset,o"
static const char *const	kOffsetOptionMessage = "retime the sequence with the given offset. ex: -o 1, -o"
static const char *const	kPathOptionLongName = "path"
static const char *const	kPathOptionString = "path,p"
static const char *const	kPathOptionMessage = "display the absolute path of each object"
static const char *const	kQuietOptionLongName = "quiet"
static const char *const	kQuietOptionString = "quiet,Q"
static const char *const	kQuietOptionMessage = "don't print commands"
static const char *const	kRangeOptionLongName = "range"
static const char *const	kRangeOptionString = "range,r"
static const char *const	kRangeOptionMessage = "processing range (used only if input is a sequence pattern)"
static const char *const	kRecursiveOptionLongName = "recursive"
static const char *const	kRecursiveOptionString = "recursive,R"
static const char *const	kRecursiveOptionMessage = "handle directories and their content recursively"
static const char *const	kSequencesOptionLongName = "sequences"
static const char *const	kSequencesOptionString = "sequences,s"
static const char *const	kSequencesOptionMessage = "handle sequences"
static const char *const	kVersionOptionLongName = "version"
static const char *const	kVersionOptionString = "version,v"
static const char *const	kVersionOptionMessage = "display version"
static const char *const	kVerboseOptionLongName = "verbose"
static const char *const	kVerboseOptionString = "verbose,V"
static const char *const	kVerboseOptionMessage = "verbose level (trace=0, debug=1, warning=2, error=3, fatal=4)"
static const char *const	kBinariesListOptionLongName = "binaries-list"
	options without short-cut
static const char *const	kBinariesListOptionString = kBinariesListOptionLongName
static const char *const	kBinariesListOptionMessage = "show list of all available sam binaries"
static const char *const	kBriefOptionLongName = "brief"
static const char *const	kBriefOptionString = kBriefOptionLongName
static const char *const	kBriefOptionMessage = "display a brief summary of the tool"
static const char *const	kClipOptionLongName = "clip"
static const char *const	kClipOptionString = kClipOptionLongName
static const char *const	kClipOptionMessage = "display clip informations"
static const char *const	kClipsOptionLongName = "clips"
static const char *const	kClipsOptionString = kClipsOptionLongName
static const char *const	kClipsOptionMessage = "list clips of the OpenFX plugin"
static const char *const	kColorOptionLongName = "color"
static const char *const	kColorOptionString = kColorOptionLongName
static const char *const	kColorOptionMessage = "display the output with colors"
static const char *const	kCommandsListOptionLongName = "commands-list"
static const char *const	kCommandsListOptionString = kCommandsListOptionLongName
static const char *const	kCommandsListOptionMessage = "show list of all available sam commands"
static const char *const	kContinueOnErrorOptionLongName = "continue-on-error"
static const char *const	kContinueOnErrorOptionString = kContinueOnErrorOptionLongName
static const char *const	kContinueOnErrorOptionMessage = "continue on error"
static const char *const	kDisableProcessOptionLongName = "disable-process"
static const char *const	kDisableProcessOptionString = kDisableProcessOptionLongName
static const char *const	kDisableProcessOptionMessage = "run the command line without computing images (verbose enable)."
static const char *const	kForceIdentityNodesProcessOptionLongName = "force-identity-nodes-process"
static const char *const	kForceIdentityNodesProcessOptionString = kForceIdentityNodesProcessOptionLongName
static const char *const	kForceIdentityNodesProcessOptionMessage = "force identity nodes process (debug option for plugin developers only)"
static const char *const	kEnableColorOptionLongName = "enable-color"
static const char *const	kEnableColorOptionString = kEnableColorOptionLongName
static const char *const	kEnableColorOptionMessage = "enable or disable color"
static const char *const	kExpertOptionLongName = "expert"
static const char *const	kExpertOptionString = kExpertOptionLongName
static const char *const	kExpertOptionMessage = "show expert user options"
static const char *const	kFirstImageOptionLongName = "first-image"
static const char *const	kFirstImageOptionString = kFirstImageOptionLongName
static const char *const	kFirstImageOptionMessage = "specify the first image"
static const char *const	kFormatOptionLongName = "format"
static const char *const	kFormatOptionString = kFormatOptionLongName
static const char *const	kFormatOptionMessage = "display supported formats"
static const char *const	kFullDisplayOptionLongName = "full-display"
static const char *const	kFullDisplayOptionString = kFullDisplayOptionLongName
static const char *const	kFullDisplayOptionMessage = "display everything =directories, files, sequences"
static const char *const	kFullRMPathOptionLongName = "full-rm"
static const char *const	kFullRMPathOptionString = kFullRMPathOptionLongName
static const char *const	kFullRMPathOptionMessage = "remove everything =directories, files, sequences"
static const char *const	kGeneratorArgsOptionLongName = "generator-args"
static const char *const	kGeneratorArgsOptionString = kGeneratorArgsOptionLongName
static const char *const	kGeneratorArgsOptionMessage = "properties of generator plugin"
static const char *const	kIdOptionLongName = "id"
static const char *const	kIdOptionString = kIdOptionLongName
static const char *const	kIdOptionMessage = "set a name/id to the node"
static const char *const	kInputDirOptionLongName = "input-dir"
static const char *const	kInputDirOptionString = kInputDirOptionLongName
static const char *const	kInputDirOptionMessage = "input directories"
static const char *const	kInputFirstOptionLongName = "input-first"
static const char *const	kInputFirstOptionString = kInputFirstOptionLongName
static const char *const	kInputFirstOptionMessage = "specify the first input image in order to select a sub-range of the input sequence"
static const char *const	kInputLastOptionLongName = "input-last"
static const char *const	kInputLastOptionString = kInputLastOptionLongName
static const char *const	kInputLastOptionMessage = "specify the last input image in order to select a sub-range of the input sequence"
static const char *const	kLastImageOptionLongName = "last-image"
static const char *const	kLastImageOptionString = kLastImageOptionLongName
static const char *const	kLastImageOptionMessage = "specify the last image"
static const char *const	kNodesListOptionLongName = "nodes-script"
static const char *const	kNodesListOptionString = kNodesListOptionLongName
static const char *const	kNodesListOptionMessage = "show list of all available nodes (formatted for scripting)"
static const char *const	kOutputFirstOptionLongName = "output-first"
static const char *const	kOutputFirstOptionString = kOutputFirstOptionLongName
static const char *const	kOutputFirstOptionMessage = "specify the first output image, in order to select a sub-range of the output sequence"
static const char *const	kOutputLastOptionLongName = "output-last"
static const char *const	kOutputLastOptionString = kOutputLastOptionLongName
static const char *const	kOutputLastOptionMessage = "specify the last output image, in order to select a sub-range of the output sequence"
static const char *const	kParametersOptionLongName = "parameters-list"
static const char *const	kParametersOptionString = kParametersOptionLongName
static const char *const	kParametersOptionMessage = "list parameters of the OpenFX plugin"
static const char *const	kParametersReduxOptionLongName = "parameters-redux-list"
static const char *const	kParametersReduxOptionString = kParametersReduxOptionLongName
static const char *const	kParametersReduxOptionMessage = "list parameters of the OpenFX plugin (redux informations)"
static const char *const	kParamDefaultOptionLongName = "param-default"
static const char *const	kParamDefaultOptionString = kParamDefaultOptionLongName
static const char *const	kParamDefaultOptionMessage = "parameter default value"
static const char *const	kParamGroupOptionLongName = "param-group"
static const char *const	kParamGroupOptionString = kParamGroupOptionLongName
static const char *const	kParamGroupOptionMessage = "group of the OpenFX plugin"
static const char *const	kParamInfosOptionLongName = "param-infos"
static const char *const	kParamInfosOptionString = kParamInfosOptionLongName
static const char *const	kParamInfosOptionMessage = "display parameter informations"
static const char *const	kParamPossibleValuesOptionLongName = "param-possible-values"
static const char *const	kParamPossibleValuesOptionString = kParamPossibleValuesOptionLongName
static const char *const	kParamPossibleValuesOptionMessage = "possible parameter values"
static const char *const	kParamTypeOptionLongName = "param-type"
static const char *const	kParamTypeOptionString = kParamTypeOptionLongName
static const char *const	kParamTypeOptionMessage = "parameter type"
static const char *const	kParamValuesOptionLongName = "param-values"
static const char *const	kParamValuesOptionString = kParamValuesOptionLongName
static const char *const	kParamValuesOptionMessage = "display parameter values"
static const char *const	kPropertiesOptionLongName = "properties"
static const char *const	kPropertiesOptionString = kPropertiesOptionLongName
static const char *const	kPropertiesOptionMessage = "list properties of the OpenFX plugin"
static const char *const	kPluginsOptionLongName = "plugins"
static const char *const	kPluginsOptionString = kPropertiesOptionLongName
static const char *const	kPluginsOptionMessage = "list of associated plugins for this dummy node"
static const char *const	kReaderOptionLongName = "reader"
static const char *const	kReaderOptionString = kReaderOptionLongName
static const char *const	kReaderOptionMessage = "specify reader node with identifier \"tuttle.XXXreader\""
static const char *const	kRelativePathOptionLongName = "relative-path"
static const char *const	kRelativePathOptionString = kRelativePathOptionLongName
static const char *const	kRelativePathOptionMessage = "display the relative path of each object"
static const char *const	kStopOnMissingFileOptionLongName = "stop-on-missing-file"
static const char *const	kStopOnMissingFileOptionString = kStopOnMissingFileOptionLongName
static const char *const	kStopOnMissingFileOptionMessage = "stop on missing file"
static const char *const	kNbCoresOptionLongName = "nb-cores"
static const char *const	kNbCoresOptionString = kNbCoresOptionLongName
static const char *const	kNbCoresOptionMessage = "set a fix number of CPUs"
static const char *const	kRenderScaleOptionLongName = "renderscale"
static const char *const	kRenderScaleOptionString = kRenderScaleOptionLongName
static const char *const	kRenderScaleOptionMessage = "specify render scale"
static const char *const	kScriptOptionLongName = "script"
static const char *const	kScriptOptionString = kScriptOptionLongName
static const char *const	kScriptOptionMessage = "format the output such as it could be dump in a file and be used as a script"
bool	wasSthgDumped = false

Typedef Documentation

typedef std::pair<ttl::ofx::attribute::OfxhClipImage*, std::string> sam::ClipAndConnection

Definition at line 74 of file node.hpp.

Function Documentation

void sam::connectClips	(	const std::vector< ttl::Graph::Node * >	nodes,
		const std::vector< ClipAndConnection >	clipsToConnect,
		ttl::Graph::Node &	currentNode,
		ttl::Graph &	graph,
		const std::vector< std::string >	idNames
	)

Todo:: We only check if we have more than one clip (assuming that it's the default "Output" clip...) instead of checking the number of input clips...

Definition at line 205 of file node.hpp.

References tuttle::host::Graph::connect(), tuttle::host::Graph::getNode(), and tuttle::quotes().

Referenced by main().

Here is the call graph for this function:

void sam::coutClips ( const ttl::Graph::Node & node )

Definition at line 105 of file node_io.hpp.

References clips, and TUTTLE_LOG_INFO.

Referenced by main().

void sam::coutClipsWithDetails ( const ttl::Graph::Node & node )

Todo:

Definition at line 64 of file node_io.hpp.

References clips, tuttle::common::Color::get(), kOfxImageClipPropOptional, and TUTTLE_LOG_INFO.

Referenced by displayNodeHelp(), and main().

Here is the call graph for this function:

void sam::coutParameters ( const ttl::Graph::Node & node )

Definition at line 318 of file node_io.hpp.

References TUTTLE_LOG_INFO.

Referenced by main().

void sam::coutParametersWithDetails ( const ttl::Graph::Node & node )

Definition at line 303 of file node_io.hpp.

References coutParameterWithDetails().

Referenced by displayNodeHelp(), and main().

Here is the call graph for this function:

void sam::coutParameterValues	(	std::ostream &	os,
		const ttl::ofx::attribute::OfxhParam &	param
	)

Definition at line 114 of file node_io.hpp.

References tuttle::host::ofx::property::OfxhProperty::getDimension(), getFormattedStringValue(), tuttle::host::ofx::property::OfxhProperty::getStringValue(), kOfxParamPropChoiceOption, kOfxParamPropDefault, kOfxParamPropDisplayMax, and kOfxParamPropDisplayMin.

Referenced by main().

Here is the call graph for this function:

void sam::coutParameterWithDetails ( const ttl::ofx::attribute::OfxhParam & param )

Definition at line 189 of file node_io.hpp.

References tuttle::host::ofx::property::ePropTypeInt, tuttle::common::Color::get(), getFormattedStringValue(), getStringValues(), tuttle::host::ofx::property::OfxhProperty::getType(), kOfxParamPropChoiceLabelOption, kOfxParamPropChoiceOption, kOfxParamPropDefault, kOfxParamPropDisplayMax, kOfxParamPropDisplayMin, kOfxParamPropHint, kOfxParamTypeChoice, kOfxParamTypeGroup, kOfxParamTypePage, kOfxParamTypePushButton, and TUTTLE_LOG_INFO.

Referenced by coutParametersWithDetails().

Here is the call graph for this function:

void sam::coutProperties ( const ttl::Graph::Node & node )

Todo:

Definition at line 43 of file node_io.hpp.

References tuttle::common::Color::get(), and TUTTLE_LOG_INFO.

Referenced by main().

Here is the call graph for this function:

std::string sam::getFormattedStringValue ( const tuttle::host::ofx::property::OfxhProperty & prop )

Return a string to represent the property value or values. If multiple values, return a string like "a,b,c".

Definition at line 35 of file node_io.hpp.

References getStringValues().

Referenced by coutParameterValues(), coutParameterWithDetails(), and main().

Here is the call graph for this function:

std::vector<std::string> sam::getStringValues ( const tuttle::host::ofx::property::OfxhProperty & prop )

Get all values of the property as a vector of strings.

Definition at line 21 of file node_io.hpp.

References tuttle::host::ofx::property::OfxhProperty::getDimension(), and tuttle::host::ofx::property::OfxhProperty::getStringValue().

Referenced by coutParameterWithDetails(), getFormattedStringValue(), and isContextSupported().

Here is the call graph for this function:

std::vector<bfs::path> sam::retrieveAllSamCommands ( const bfs::path & dir )

Definition at line 56 of file main.cpp.

Referenced by main(), and retrieveAllSamCommands().

std::vector<bfs::path> sam::retrieveAllSamCommands ( const std::vector< bfs::path > & dirs )

Definition at line 74 of file main.cpp.

References retrieveAllSamCommands().

Here is the call graph for this function:

std::string sam::retrieveNodeFullname ( const std::string & userId ) [inline]

Definition at line 14 of file node.hpp.

References tuttle::host::core().

Referenced by main().

Here is the call graph for this function:

std::vector<bfs::path> sam::retrieveSearchPaths ( const bfs::path & samDirectory )

Definition at line 40 of file main.cpp.

Referenced by main().

bfs::path sam::retrieveToolFullPath	(	const std::string &	toolName,
		const std::vector< bfs::path > &	searchPaths
	)

Todo:: exception ?

Definition at line 21 of file main.cpp.

References TUTTLE_LOG_ERROR.

Referenced by main().

void sam::setParametersForNode	(	const std::vector< std::string >	parameters,
		ttl::Graph::Node &	currentNode,
		std::vector< ClipAndConnection > &	clipsToConnect,
		const bool	isDummyNode = `false`,
		bool	orderedParams = `true`
	)