ossimVideoSource Class Reference

Pure virtual base class for all video sources – analogous to ossimImageSource. More...

#include <ossimVideoSource.h>

Inheritance diagram for ossimVideoSource:

Public Types
enum	SeekType { SEEK_NONE = 0, SEEK_RELATIVE = 1, SEEK_ABSOLUTE = 2 }
Public Types inherited from ossimConnectableObject
enum	ossimConnectableObjectDirectionType { CONNECTABLE_DIRECTION_NONE = 0, CONNECTABLE_DIRECTION_INPUT = 1, CONNECTABLE_DIRECTION_OUTPUT = 2 }
typedef std::vector< ossimRefPtr< ossimConnectableObject > >	ConnectableObjectList

Public Member Functions
virtual void	rewind ()
	For rewinding all active streams to beginning. More...
virtual bool	seek (ossim_float64 reference_time_sec, SeekType seekType)
	Seeks to the frame at time specified, according to the seekType (relative to active frame or absolute time from start of video). More...
virtual bool	nextFrame ()
	Seeks to start of next frame. Returns TRUE if successful. More...
virtual ossim_float64	duration () const
	Total length of video in seconds. More...
virtual ossim_uint32	getNumberOfFrames () const
	Total number of frames in video. More...
virtual ossim_float64	currentFrameTime () const
	Time in seconds from start of video of the current active frame, or NAN if no active frame. More...
virtual ossim_float64	videoFrameRate () const
	Nominal frames per second. More...
int	computeFrameNumber (double seconds_from_start) const
	Utility method for computing frame number from frame time. More...
double	computeFrameTime (ossim_uint32 frame_count) const
	Utility method for computing frame time from frame number. More...
virtual const ossimRefPtr< ossimVideoGeometry >	getVideoGeometry () const
	Access to video geometry object. More...
virtual const ossimRefPtr< ossimVideoImageHandler >	getCurrentFrame () const
	Access to current active frame. More...
const ossimIpt &	frameSize () const
	Nominal size of a frame in pixels. More...
virtual bool	canConnectMyInputTo (ossim_int32 index, const ossimConnectableObject *object) const
	Connections only to other video sources are allowed. More...
virtual bool	canConnectMyOutputTo (ossim_int32 index, const ossimConnectableObject *object) const
	Presently can only connect into an image chain via an ossimVideoImageSource bridge, or to another video source for video chains. More...
Public Member Functions inherited from ossimSource
	ossimSource (ossimObject *owner=0)
	ossimSource (ossimObject *owner, ossim_uint32 inputListSize, ossim_uint32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)
virtual	~ossimSource ()
virtual bool	isSourceEnabled () const
virtual void	enableSource ()
virtual void	disableSource ()
virtual bool	getEnableFlag () const
virtual void	setEnableFlag (bool flag)
virtual bool	isInitialized () const
virtual void	setInitializedFlag (bool flag)
virtual void	initialize ()
virtual void	setProperty (ossimRefPtr< ossimProperty > property)
virtual ossimRefPtr< ossimProperty >	getProperty (const ossimString &name) const
virtual void	getPropertyNames (std::vector< ossimString > &propertyNames) const
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
virtual std::ostream &	print (std::ostream &out) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...
Public Member Functions inherited from ossimConnectableObject
	ossimConnectableObject (ossimObject *owner=0)
	Base constructor of this object. More...
	ossimConnectableObject (ossimObject *owner, ossim_int32 inputListSize, ossim_int32 outputListSize, bool inputListIsFixedFlag=true, bool outputListIsFixedFlag=true)
virtual	~ossimConnectableObject ()
void	setId (const ossimId &id)
	All connectable objects will have id's. More...
const ossimId &	getId () const
	Will allow us to get this object's id. More...
const ossimObject *	getOwner () const
	Fetches the current owner, most likely a container but not limited to one. More...
virtual void	changeOwner (ossimObject *owner)
	Permits changing the object's owner. More...
virtual void	setDescription (const ossimString &description)
virtual ossimString	getDescription () const
virtual bool	isConnected (ossimConnectableObjectDirectionType direction=CONNECTABLE_DIRECTION_INPUT) const
	will check the direction specified to see if all slots are full. More...
	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findConnectableObject(const ossimId &id))
	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(RTTItypeid typeId, ossimConnectableObjectDirectionType directionType, bool recurse=true))
	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findObjectOfType(const ossimString &obj, ossimConnectableObjectDirectionType directionType, bool recurse=true))
	OSSIM_DEPRECATE_METHOD (virtual ossimConnectableObject *findInputObjectOfType(const ossimString &className))
virtual ossim_int32	findInputIndex (const ossimConnectableObject *object)
	Return a valid index of the input list if the passed in object is found else return -1. More...
virtual ossim_int32	findInputIndex (const ossimId &id)
	Return a valid index of the input list if the passed id is found else return -1. More...
virtual ossim_int32	findOutputIndex (const ossimConnectableObject *object)
	Return a valid index of the output list if the passed in object is found else return -1. More...
virtual ossim_int32	findOutputIndex (const ossimId &id)
	Return a valid index of the output list if the passed in object is found else return -1. More...
virtual ossim_int32	getMyInputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...
virtual ossim_int32	getMyOutputIndexToConnectTo (ossimConnectableObject *object) const
	Should return the first available index to connect to. More...
virtual void	disconnect (ossimConnectableObject *object=0)
	Will disconnect the object passed in. More...
virtual void	disconnect (const ossimId &id)
	Will disconnect the object passed in. More...
virtual ossimRefPtr< ossimConnectableObject >	disconnectMyInput (ossim_int32 inputIndex, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given input index and generate a connection event. More...
virtual void	disconnectMyInput (ossimConnectableObject *input, bool disconnectOutputFlag=true, bool createEventFlag=true)
	Finds the index of the passed in input and calls disconnectMyInput(inputIndex, disconnectOutputFlag, createEventFlag);. More...
virtual void	disconnectMyInputs (ConnectableObjectList &inputList, bool disconnectOutputFlag=true, bool createEventFlag=true)
virtual ossimRefPtr< ossimConnectableObject >	disconnectMyOutput (ossim_int32 outputIndex, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the object at the given output index and generate a connection event. More...
virtual void	disconnectMyOutput (ossimConnectableObject *output, bool disconnectInputFlag=true, bool createEventFlag=true)
	Will disconnect the output object. More...
virtual void	disconnectMyOutputs (ConnectableObjectList &outputList, bool disconnectOutputFlag=true, bool createEventFlag=true)
virtual void	disconnectAllInputs ()
	Will disconnect all of the input objects. More...
virtual void	disconnectAllOutputs ()
	Will disconnect all of the output objects. More...
virtual ossim_int32	connectMyInputTo (ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will try to connect this objects input to the passed in object. More...
virtual ossim_int32	connectMyInputTo (ossim_int32 inputIndex, ossimConnectableObject *inputObject, bool makeOutputConnection=true, bool createEventFlag=true)
	Will connect the specified input to the passed in object. More...
virtual bool	connectMyInputTo (ConnectableObjectList &inputList, bool makeOutputConnection=true, bool createEventFlag=true)
virtual ossim_int32	connectMyOutputTo (ossimConnectableObject *outputObject, bool makeInputConnection=true, bool createEventFlag=true)
	Will try to connect this objects output to the passed in object. More...
virtual bool	connectMyOutputTo (ConnectableObjectList &outputList, bool makeInputConnection=true, bool createEventFlag=true)
virtual bool	connectInputList (ConnectableObjectList &inputList)
	Will disconnect itself from all inputs and reset to the passed in input list. More...
virtual bool	connectOutputList (ConnectableObjectList &outputList)
	Will disconnect itself from all outputs and reset to the passed in output list. More...
virtual ossim_uint32	getNumberOfInputs () const
	Returns the number of input objects. More...
virtual ossim_uint32	getNumberOfOutputs () const
	Return the number of output objects. More...
ossimConnectableObject *	getInput (ossim_uint32 index=0)
	returns the object at the specified index. More...
const ossimConnectableObject *	getInput (ossim_uint32 index=0) const
	returns the object at the specified index. More...
ossimConnectableObject *	getOutput (ossim_uint32 index=0)
	returns the object at the specified index. More...
const ossimConnectableObject *	getOutput (ossim_uint32 index=0) const
	returns the object at the specified index. More...
virtual void	setNumberOfInputs (ossim_int32 numberOfInputs)
	Will set the number of inputs. More...
virtual bool	getInputListIsFixedFlag () const
virtual bool	getOutputListIsFixedFlag () const
virtual void	setNumberOfOutputs (ossim_int32 numberOfInputs)
	Will set the number of outputs. More...
const ConnectableObjectList &	getInputList () const
const ConnectableObjectList &	getOutputList () const
ConnectableObjectList &	getInputList ()
ConnectableObjectList &	getOutputList ()
	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const RTTItypeid &typeInfo, bool recurse=true))
	OSSIM_DEPRECATE_METHOD (virtual void findAllObjectsOfType(ConnectableObjectList &result, const ossimString &className, bool recurse=true))
virtual void	propagateEventToOutputs (ossimEvent &event)
virtual void	propagateEventToInputs (ossimEvent &event)
virtual void	setProperty (const ossimString &name, const ossimString &value)
virtual ossim_uint32	saveStateOfAllInputs (ossimKeywordlist &kwl, bool saveThisStateFlag=true, ossim_uint32 objectIndex=1, const char *prefix=0) const
	Save the state of all inputs to a keyword list. More...
virtual bool	fillContainer (ossimConnectableContainer &container)
	Inserts this object and all of its children and inputs into the container provided. More...
bool	moveInputUp (const ossimId &id)
	Moves the input connection matching id up one in the connection list. More...
bool	moveInputDown (const ossimId &id)
	Moves the input connection matching id down one in the connection list. More...
bool	moveInputToTop (const ossimId &id)
	Moves the input connection matching id to the top of the connection list. More...
bool	moveInputToBottom (const ossimId &id)
	Moves the input connection matching id to the bottom of the connection list. More...
virtual void	accept (ossimVisitor &visitor)
	We will add a visitor interface for all connectable objects. More...
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimObject *	dup () const
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getClassName () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const
Public Member Functions inherited from ossimListenerManager
	ossimListenerManager ()
virtual	~ossimListenerManager ()
virtual void	fireEvent (ossimEvent &event)
virtual bool	addListener (ossimListener *listener)
virtual bool	removeListener (ossimListener *listener)
virtual bool	findListener (ossimListener *listener)
Public Member Functions inherited from ossimPropertyInterface
	ossimPropertyInterface ()
virtual	~ossimPropertyInterface ()
virtual ossimString	getPropertyValueAsString (const ossimString &name) const
void	getPropertyList (std::vector< ossimRefPtr< ossimProperty > > &propertyList) const
void	setProperties (std::vector< ossimRefPtr< ossimProperty > > &propertyList)
Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()
virtual	~ossimErrorStatusInterface ()
virtual ossimErrorCode	getErrorStatus () const
virtual ossimString	getErrorStatusString () const
virtual void	setErrorStatus (ossimErrorCode error_status) const
virtual void	setErrorStatus () const
virtual void	clearErrorStatus () const
bool	hasError () const

Protected Member Functions
	ossimVideoSource ()
	Default constructor. More...
Protected Member Functions inherited from ossimSource
	ossimSource (const ossimSource &rhs)
const ossimSource &	operator= (const ossimSource &rhs)
Protected Member Functions inherited from ossimConnectableObject
ossimConnectableObject *	findObjectOfType (ConnectableObjectList *connectableList, ossimVisitor &visitor)
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()
Protected Member Functions inherited from ossimListenerManager
	ossimListenerManager (const ossimListenerManager &rhs)

Protected Attributes
ossimIpt	m_frameSize
	in pixels More...
Protected Attributes inherited from ossimSource
bool	theEnableFlag
bool	theInitializedFlag
Protected Attributes inherited from ossimConnectableObject
ossimId	theId
ossimString	theDescription
ossimObject *	theOwner
bool	theInputListIsFixedFlag
	Indicates whether the theInputObjectList is fixed. More...
bool	theOutputListIsFixedFlag
	Indicates whether the theOutputObjectList is fixed. More...
ConnectableObjectList	theInputObjectList
	Holds a list of input objects. More...
ConnectableObjectList	theOutputObjectList
	Holds a list of output objects. More...
Protected Attributes inherited from ossimListenerManager
std::list< ossimListener * >	theListenerList
bool	theEnabledFlag
std::list< ossimListener * >	theDelayedAdd
std::list< ossimListener * >	theDelayedRemove
bool	theFireEventFlag
Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Detailed Description

Pure virtual base class for all video sources – analogous to ossimImageSource.

Definition at line 27 of file ossimVideoSource.h.

Member Enumeration Documentation

SeekType

enum ossimVideoSource::SeekType

Enumerator
SEEK_NONE
SEEK_RELATIVE
SEEK_ABSOLUTE

Definition at line 31 of file ossimVideoSource.h.

   {
      SEEK_NONE     = 0,
      SEEK_RELATIVE = 1,
      SEEK_ABSOLUTE = 2
   };

Constructor & Destructor Documentation

ossimVideoSource()

ossimVideoSource::ossimVideoSource ( )

protected

Default constructor.

Definition at line 23 of file ossimVideoSource.cpp.

{ }

Member Function Documentation

canConnectMyInputTo()

bool ossimVideoSource::canConnectMyInputTo ( ossim_int32  index, const ossimConnectableObject *  object  ) const

virtual

Connections only to other video sources are allowed.

Implements ossimConnectableObject.

Reimplemented in ossimVideoHandler.

Definition at line 155 of file ossimVideoSource.cpp.

References PTR_CAST.

{
   if (object && (index == 0) && PTR_CAST(ossimVideoSource, object))
      return true;
   // else
   return false;
}

canConnectMyOutputTo()

bool ossimVideoSource::canConnectMyOutputTo ( ossim_int32  index, const ossimConnectableObject *  object  ) const

virtual

Presently can only connect into an image chain via an ossimVideoImageSource bridge, or to another video source for video chains.

Returns TRUE if connection possible.

Reimplemented from ossimConnectableObject.

Definition at line 168 of file ossimVideoSource.cpp.

References PTR_CAST.

{
   if (!object || (index != 0))
      return false;

   if (PTR_CAST(ossimVideoSource, object))
      return true;

   if (PTR_CAST(ossimVideoImageSource, object))
      return true;

   if (PTR_CAST(ossimVideoImageHandler, object))
      return true;

   return false;
}

computeFrameNumber()

int ossimVideoSource::computeFrameNumber

(

double

seconds_from_start

)

const

Utility method for computing frame number from frame time.

Returns

Returns frame number corresponding to the time (sec) from start of video or -1 if time is outside valid window.

Definition at line 131 of file ossimVideoSource.cpp.

References videoFrameRate().

Referenced by ossimVideoImageHandler::getNumberOfEntries(), and getNumberOfFrames().

{
   double frame_rate = videoFrameRate();
   if (frame_rate > 0.0)
      return (int) seconds_from_start*frame_rate;
   // else
   return -1;
}

computeFrameTime()

double ossimVideoSource::computeFrameTime

(

ossim_uint32

frame_count

)

const

Utility method for computing frame time from frame number.

Returns

Returns frame time (sec) from start of video corresponding to the frame count, or NaN if frame count is invalid.

Definition at line 143 of file ossimVideoSource.cpp.

References ossim::nan(), and videoFrameRate().

Referenced by ossimVideoImageHandler::getImageGeometry(), and ossimVideoImageHandler::setCurrentEntry().

{
   double frame_rate = videoFrameRate();
   if (frame_rate > 0.0)
      return frame_count/frame_rate;
   // else
   return ossim::nan();
}

currentFrameTime()

ossim_float64 ossimVideoSource::currentFrameTime ( ) const

virtual

Time in seconds from start of video of the current active frame, or NAN if no active frame.

Reimplemented in ossimVideoHandler.

Definition at line 76 of file ossimVideoSource.cpp.

References currentFrameTime(), ossimConnectableObject::getInput(), and PTR_CAST.

Referenced by currentFrameTime().

{
   ossimVideoSource* inter = PTR_CAST(ossimVideoSource, getInput(0));
   if (inter)
      return inter->currentFrameTime();

   return 0.0;
}

duration()

ossim_float64 ossimVideoSource::duration ( ) const

virtual

Total length of video in seconds.

Reimplemented in ossimVideoHandler.

Definition at line 64 of file ossimVideoSource.cpp.

References duration(), ossimConnectableObject::getInput(), and PTR_CAST.

Referenced by duration(), getNumberOfFrames(), and ossimVideoImageSource::setFrameTime().

{
   ossimVideoSource* inter = PTR_CAST(ossimVideoSource, getInput(0));
   if (inter)
      return inter->duration();

   return 0.0;
}

frameSize()

const ossimIpt& ossimVideoSource::frameSize ( ) const

inline

Nominal size of a frame in pixels.

Definition at line 81 of file ossimVideoSource.h.

Referenced by ossimVideoImageHandler::getNumberOfLines(), ossimVideoImageHandler::getNumberOfSamples(), and ossimVideoImageSource::initialize().

{ return m_frameSize; }

getCurrentFrame()

const ossimRefPtr< ossimVideoImageHandler > ossimVideoSource::getCurrentFrame ( ) const

virtual

Access to current active frame.

Definition at line 112 of file ossimVideoSource.cpp.

{
   //STUB
   return NULL;
}

getNumberOfFrames()

ossim_uint32 ossimVideoSource::getNumberOfFrames ( ) const

virtual

Total number of frames in video.

Definition at line 121 of file ossimVideoSource.cpp.

References computeFrameNumber(), and duration().

{
   // Base class implementation just computes number of frames from duration:
   ossim_uint32 num_frames = (ossim_uint32) computeFrameNumber(duration());
   return num_frames;
}

getVideoGeometry()

const ossimRefPtr< ossimVideoGeometry > ossimVideoSource::getVideoGeometry ( ) const

virtual

Access to video geometry object.

Reimplemented in ossimVideoHandler.

Definition at line 100 of file ossimVideoSource.cpp.

References ossimConnectableObject::getInput(), getVideoGeometry(), and PTR_CAST.

Referenced by ossimVideoImageSource::getImageGeometry(), and getVideoGeometry().

{
   ossimVideoSource* inter = PTR_CAST(ossimVideoSource, getInput(0));
   if (inter)
      return inter->getVideoGeometry();

   return NULL;
}

nextFrame()

bool ossimVideoSource::nextFrame ( )

virtual

Seeks to start of next frame. Returns TRUE if successful.

Definition at line 52 of file ossimVideoSource.cpp.

References ossimConnectableObject::getInput(), nextFrame(), and PTR_CAST.

Referenced by nextFrame().

{
   ossimVideoSource* inter = PTR_CAST(ossimVideoSource, getInput(0));
   if (inter)
      return inter->nextFrame();

   return false;
}

rewind()

void ossimVideoSource::rewind ( )

virtual

For rewinding all active streams to beginning.

Reimplemented in ossimVideoHandler.

Definition at line 29 of file ossimVideoSource.cpp.

References ossimConnectableObject::getInput(), PTR_CAST, and rewind().

Referenced by rewind().

{
   ossimVideoSource* inter = PTR_CAST(ossimVideoSource, getInput(0));
   if (inter)
      inter->rewind();
}

seek()

bool ossimVideoSource::seek ( ossim_float64  reference_time_sec, SeekType  seekType  )

virtual

Seeks to the frame at time specified, according to the seekType (relative to active frame or absolute time from start of video).

Returns TRUE if successful.

Reimplemented in ossimVideoHandler.

Definition at line 40 of file ossimVideoSource.cpp.

References ossimConnectableObject::getInput(), PTR_CAST, and seek().

Referenced by seek(), and ossimVideoImageSource::setFrameTime().

{
   ossimVideoSource* inter = PTR_CAST(ossimVideoSource, getInput(0));
   if (inter)
      return inter->seek(reference_time_sec, seekType);
   
   return false;
}

videoFrameRate()

ossim_float64 ossimVideoSource::videoFrameRate ( ) const

virtual

Nominal frames per second.

Reimplemented in ossimVideoHandler.

Definition at line 88 of file ossimVideoSource.cpp.

References ossimConnectableObject::getInput(), PTR_CAST, and videoFrameRate().

Referenced by computeFrameNumber(), computeFrameTime(), and videoFrameRate().

{
   ossimVideoSource* inter = PTR_CAST(ossimVideoSource, getInput(0));
   if (inter)
      return inter->videoFrameRate();

   return 0.0;
}

Member Data Documentation

m_frameSize

ossimIpt ossimVideoSource::m_frameSize

protected

in pixels

Definition at line 97 of file ossimVideoSource.h.

---

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

• ossimVideoSource.h
• ossimVideoSource.cpp