#include <svlVideoIO.h>

Inheritance diagram for svlVideoCodecBase:

Public Member Functions
	svlVideoCodecBase ()

virtual	~svlVideoCodecBase ()

const std::string &	GetEncoderName () const

const std::string &	GetExtensions () const

bool	IsMultithreaded () const

bool	IsVariableFramerate () const

virtual int	Open (const std::string &filename, unsigned int &width, unsigned int &height, double &framerate)=0

virtual int	Create (const std::string &filename, const unsigned int width, const unsigned int height, const double framerate)=0

virtual int	Close ()=0

virtual int	GetBegPos () const =0

virtual int	GetEndPos () const =0

virtual int	GetPos () const =0

virtual int	SetPos (const int pos)

virtual double	GetBegTime () const

virtual double	GetEndTime () const

virtual double	GetTimeAtPos (const int pos) const

virtual int	GetPosAtTime (const double time) const

virtual svlVideoIO::Compression *	GetCompression () const

virtual int	SetCompression (const svlVideoIO::Compression *compression)

virtual int	DialogCompression ()

virtual int	DialogCompression (const std::string &filename)

virtual double	GetTimestamp () const =0

virtual int	SetTimestamp (const double timestamp)

virtual int	Read (svlProcInfo *procInfo, svlSampleImage &image, const unsigned int videoch, const bool noresize=false)=0

virtual int	Write (svlProcInfo *procInfo, const svlSampleImage &image, const unsigned int videoch)=0

virtual void	SetExtension (const std::string &extension)=0

virtual void	SetEncoderID (const int &encoder_id)=0

virtual void	SetCompressionLevel (const int &compr_level)=0

virtual void	SetQualityBased (const bool &enabled)=0

virtual void	SetTargetQuantizer (const double &target_quant)=0

virtual void	SetDatarate (const int &datarate)=0

virtual void	SetKeyFrameEvery (const int &key_every)=0

virtual void	IsCompressionLevelEnabled (bool &enabled) const =0

virtual void	IsEncoderListEnabled (bool &enabled) const =0

virtual void	IsTargetQuantizerEnabled (bool &enabled) const =0

virtual void	IsDatarateEnabled (bool &enabled) const =0

virtual void	IsKeyFrameEveryEnabled (bool &enabled) const =0

virtual void	GetCompressionLevel (int &compr_level) const =0

virtual void	GetEncoderList (std::string &encoder_list) const =0

virtual void	GetEncoderID (int &encoder_id) const =0

virtual void	GetQualityBased (bool &enabled) const =0

virtual void	GetTargetQuantizer (double &target_quant) const =0

virtual void	GetDatarate (int &datarate) const =0

virtual void	GetKeyFrameEvery (int &key_every) const =0

Public Member Functions inherited from mtsComponent
	mtsComponent (const std::string &deviceName)

virtual	~mtsComponent ()

const std::string &	GetName (void) const

void	GetName (std::string &placeHolder) const

void	SetName (const std::string &componentName)

virtual void	Configure (const std::string &filename="")

virtual void	Create (void)

bool	CreateAndWait (double timeoutInSeconds)

virtual void	Start (void)

bool	StartAndWait (double timeoutInSeconds)

virtual void	Suspend (void)

virtual void	Kill (void)

bool	KillAndWait (double timeoutInSeconds)

virtual void	Startup (void)

virtual void	Cleanup (void)

mtsInterfaceProvided *	AddInterfaceProvided (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY)

virtual mtsInterfaceProvided *	AddInterfaceProvidedWithoutSystemEvents (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY, bool isProxy=false)

CISST_DEPRECATED mtsInterfaceProvided *	AddProvidedInterface (const std::string &interfaceProvidedName)

virtual mtsInterfaceOutput *	AddInterfaceOutput (const std::string &interfaceOutputName)

bool	InterfaceExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const

bool	InterfaceProvidedOrOutputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const

bool	InterfaceRequiredOrInputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const

mtsInterfaceProvided *	GetInterfaceProvided (const std::string &interfaceProvidedName) const

mtsInterfaceOutput *	GetInterfaceOutput (const std::string &interfaceOutputName) const

size_t	GetNumberOfInterfacesProvided (void) const

size_t	GetNumberOfInterfacesOutput (void) const

bool	RemoveInterfaceProvided (const std::string &interfaceProvidedName, const bool skipDisconnect=false)

mtsInterfaceRequired *	AddInterfaceRequired (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)

virtual mtsInterfaceRequired *	AddInterfaceRequiredWithoutSystemEventHandlers (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)

CISST_DEPRECATED mtsInterfaceRequired *	AddRequiredInterface (const std::string &requiredInterfaceName)

virtual mtsInterfaceInput *	AddInterfaceInput (const std::string &interfaceInputName)

const mtsInterfaceProvided *	GetInterfaceProvidedFor (const std::string &interfaceRequiredName)

mtsInterfaceRequired *	GetInterfaceRequired (const std::string &interfaceRequiredName)

mtsInterfaceInput *	GetInterfaceInput (const std::string &interfaceInputName) const

size_t	GetNumberOfInterfacesRequired (void) const

size_t	GetNumberOfInterfacesInput (void) const

bool	RemoveInterfaceRequired (const std::string &interfaceRequiredName, const bool skipDisconnect=false)

const mtsManagerComponentServices *	GetManagerComponentServices (void) const

mtsManagerComponentServices *	GetManagerComponentServices (void)

mtsStateTable *	GetStateTable (const std::string &stateTableName)

bool	AddStateTable (mtsStateTable *existingStateTable, bool addInterfaceProvided=true)

void	UseSeparateLogFileDefault (bool forwardToLogger=true)

void	UseSeparateLogFileDefaultWithDate (bool forwardToLogger=true)

void	UseSeparateLogFile (const std::string &filename, bool forwardToLogger=true)

cmnLogger::StreamBufType *	GetLogMultiplexer (void) const

bool	IsRunning (void) const

bool CISST_DEPRECATED	Running (void) const

bool	IsStarted (void) const

bool	IsTerminated (void) const

bool	IsEndTask (void) const

const mtsComponentState &	GetState (void) const

void	GetState (mtsComponentState &state) const

void	ToStream (std::ostream &outputStream) const

bool	SetReplayMode (void)

bool	SetReplayData (const std::string &stateTableName, const std::string &fileName)

bool	SetReplayTime (const double time)

std::vector< std::string >	GetNamesOfInterfacesProvidedOrOutput (void) const

std::vector< std::string >	GetNamesOfInterfacesProvided (void) const

std::vector< std::string >	GetNamesOfInterfacesOutput (void) const

std::vector< std::string >	GetNamesOfInterfacesRequiredOrInput (void) const

std::vector< std::string >	GetNamesOfInterfacesRequired (void) const

std::vector< std::string >	GetNamesOfInterfacesInput (void) const

Public Member Functions inherited from cmnGenericObject
virtual	~cmnGenericObject (void)

virtual const cmnClassServicesBase *	Services (void) const =0

bool	ReconstructFrom (const cmnGenericObject &other)

std::string	ToString (void) const

virtual void	ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const

virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')

virtual void	SerializeRaw (std::ostream &outputStream) const

virtual void	DeSerializeRaw (std::istream &inputStream)

virtual size_t	ScalarNumber (void) const

virtual bool	ScalarNumberIsFixed (void) const

virtual double	Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)

virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Protected Member Functions
void	SetName (const std::string &name)

void	SetExtensionList (const std::string &list)

void	SetMultithreaded (bool multithreaded)

void	SetVariableFramerate (bool variableframerate)

Protected Member Functions inherited from mtsComponent
	mtsComponent (void)

	mtsComponent (const mtsComponent &other)

void	Initialize (void)

mtsInterfaceRequired *	AddInterfaceRequiredExisting (const std::string &interfaceRequiredName, mtsInterfaceRequired *interfaceRequired)

mtsInterfaceRequired *	AddInterfaceRequiredUsingMailbox (const std::string &interfaceRequiredName, mtsMailBox *mailBox, mtsRequiredType required)

mtsInterfaceProvided *	AddInterfaceProvidedUsingMailbox (const std::string &interfaceProvidedName, mtsMailBox *mailBox)

mtsInterfaceInput *	AddInterfaceInputExisting (const std::string &interfaceInputName, mtsInterfaceInput *interfaceInput)

mtsInterfaceOutput *	AddInterfaceOutputExisting (const std::string &interfaceOutputName, mtsInterfaceOutput *interfaceOutput)

void	KillSeparateLogFile (void)

virtual bool	WaitForState (mtsComponentState desiredState, double timeout)

size_t	ProcessMailBoxes (InterfacesProvidedMapType &interfaces)

size_t	ProcessQueuedCommands (void)

size_t	ProcessQueuedEvents (void)

mtsInterfaceRequired *	EnableDynamicComponentManagement (void)
	Enable support for dynamic component management services. More...

bool	AddInterfaceInternal (const bool useMangerComponentServices=false)
	Add internal interfaces. More...

void	InterfaceInternalCommands_GetEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)

void	InterfaceInternalCommands_AddObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)

void	InterfaceInternalCommands_RemoveEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)

void	InterfaceInternalCommands_RemoveObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)

void	InterfaceInternalCommands_ComponentCreate (const mtsDescriptionComponent &componentDescription, bool &result)

void	InterfaceInternalCommands_ComponentStartOther (const mtsComponentStatusControl &arg)

Protected Attributes
svlVideoIO::Compression *	Codec

Protected Attributes inherited from mtsComponent
std::string	Name

mtsComponentState	State

mtsInterfaceProvided *	InterfaceProvidedToManager

bool	UseSeparateLogFileFlag

cmnLogger::StreamBufType *	LoDMultiplexerStreambuf

std::ofstream *	LogFile

StateTableMapType	StateTables

mtsManagerComponentServices *	ManagerComponentServices

mtsFunctionWrite	EventGeneratorChangeState

bool	ReplayMode

InterfacesProvidedMapType	InterfacesProvided

InterfacesOutputMapType	InterfacesOutput

InterfacesRequiredMapType	InterfacesRequired

InterfacesInputMapType	InterfacesInput

Additional Inherited Members
Public Types inherited from mtsComponent
typedef mtsComponent	ThisType

Protected Types inherited from mtsComponent
typedef cmnNamedMap < mtsStateTable >	StateTableMapType

typedef cmnNamedMap < mtsInterfaceProvided >	InterfacesProvidedMapType

typedef cmnNamedMap < mtsInterfaceOutput >	InterfacesOutputMapType

typedef cmnNamedMap < mtsInterfaceRequired >	InterfacesRequiredMapType

typedef cmnNamedMap < mtsInterfaceInput >	InterfacesInputMapType

Constructor & Destructor Documentation

svlVideoCodecBase::svlVideoCodecBase ( )

virtual svlVideoCodecBase::~svlVideoCodecBase ( )

virtual

Member Function Documentation

virtual int svlVideoCodecBase::Close ( )

pure virtual

virtual int svlVideoCodecBase::Create	(	const std::string &	filename,
		const unsigned int	width,
		const unsigned int	height,
		const double	framerate
	)

pure virtual

virtual int svlVideoCodecBase::DialogCompression ( )

virtual

virtual int svlVideoCodecBase::DialogCompression ( const std::string & filename )

virtual

virtual int svlVideoCodecBase::GetBegPos ( ) const

pure virtual

virtual double svlVideoCodecBase::GetBegTime ( ) const

virtual

virtual svlVideoIO::Compression* svlVideoCodecBase::GetCompression ( ) const

virtual

virtual void svlVideoCodecBase::GetCompressionLevel ( int & compr_level ) const

pure virtual

virtual void svlVideoCodecBase::GetDatarate ( int & datarate ) const

pure virtual

virtual void svlVideoCodecBase::GetEncoderID ( int & encoder_id ) const

pure virtual

virtual void svlVideoCodecBase::GetEncoderList ( std::string & encoder_list ) const

pure virtual

const std::string& svlVideoCodecBase::GetEncoderName ( ) const

virtual int svlVideoCodecBase::GetEndPos ( ) const

pure virtual

virtual double svlVideoCodecBase::GetEndTime ( ) const

virtual

const std::string& svlVideoCodecBase::GetExtensions ( ) const

virtual void svlVideoCodecBase::GetKeyFrameEvery ( int & key_every ) const

pure virtual

virtual int svlVideoCodecBase::GetPos ( ) const

pure virtual

virtual int svlVideoCodecBase::GetPosAtTime ( const double time ) const

virtual

virtual void svlVideoCodecBase::GetQualityBased ( bool & enabled ) const

pure virtual

virtual void svlVideoCodecBase::GetTargetQuantizer ( double & target_quant ) const

pure virtual

virtual double svlVideoCodecBase::GetTimeAtPos ( const int pos ) const

virtual

virtual double svlVideoCodecBase::GetTimestamp ( ) const

pure virtual

virtual void svlVideoCodecBase::IsCompressionLevelEnabled ( bool & enabled ) const

pure virtual

virtual void svlVideoCodecBase::IsDatarateEnabled ( bool & enabled ) const

pure virtual

virtual void svlVideoCodecBase::IsEncoderListEnabled ( bool & enabled ) const

pure virtual

virtual void svlVideoCodecBase::IsKeyFrameEveryEnabled ( bool & enabled ) const

pure virtual

bool svlVideoCodecBase::IsMultithreaded ( ) const

virtual void svlVideoCodecBase::IsTargetQuantizerEnabled ( bool & enabled ) const

pure virtual

bool svlVideoCodecBase::IsVariableFramerate ( ) const

virtual int svlVideoCodecBase::Open	(	const std::string &	filename,
		unsigned int &	width,
		unsigned int &	height,
		double &	framerate
	)

pure virtual

virtual int svlVideoCodecBase::Read	(	svlProcInfo *	procInfo,
		svlSampleImage &	image,
		const unsigned int	videoch,
		const bool	noresize = `false`
	)

pure virtual

virtual int svlVideoCodecBase::SetCompression ( const svlVideoIO::Compression * compression )

virtual

virtual void svlVideoCodecBase::SetCompressionLevel ( const int & compr_level )

pure virtual

virtual void svlVideoCodecBase::SetDatarate ( const int & datarate )

pure virtual

virtual void svlVideoCodecBase::SetEncoderID ( const int & encoder_id )

pure virtual

virtual void svlVideoCodecBase::SetExtension ( const std::string & extension )

pure virtual

void svlVideoCodecBase::SetExtensionList ( const std::string & list )

protected

virtual void svlVideoCodecBase::SetKeyFrameEvery ( const int & key_every )

pure virtual

void svlVideoCodecBase::SetMultithreaded ( bool multithreaded )

protected

void svlVideoCodecBase::SetName ( const std::string & name )

protected

virtual int svlVideoCodecBase::SetPos ( const int pos )

virtual

virtual void svlVideoCodecBase::SetQualityBased ( const bool & enabled )

pure virtual

virtual void svlVideoCodecBase::SetTargetQuantizer ( const double & target_quant )

pure virtual

virtual int svlVideoCodecBase::SetTimestamp ( const double timestamp )

virtual

void svlVideoCodecBase::SetVariableFramerate ( bool variableframerate )

protected

virtual int svlVideoCodecBase::Write	(	svlProcInfo *	procInfo,
		const svlSampleImage &	image,
		const unsigned int	videoch
	)

pure virtual

Member Data Documentation

svlVideoIO::Compression* svlVideoCodecBase::Codec

protected

The documentation for this class was generated from the following file:

/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstStereoVision/svlVideoIO.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation