vidl2_istream Class Reference

#include <vidl2_istream.h>

Inheritance diagram for vidl2_istream:

[legend]List of all members.

---

Detailed Description

A base class for input video streams.

Definition at line 18 of file vidl2_istream.h.

Public Member Functions
	vidl2_istream ()
	Constructor.
virtual	~vidl2_istream ()
	Destructor.
virtual bool	is_open () const =0
	Return true if the stream is open for reading.
virtual bool	is_valid () const =0
	Return true if the stream is in a valid state.
virtual bool	is_seekable () const =0
	Return true if the stream support seeking.
virtual unsigned int	frame_number () const =0
	Return the current frame number.
virtual void	close ()=0
	Close the stream.
virtual bool	advance ()=0
	Advance to the next frame (but don't acquire an image).
virtual vidl2_frame_sptr	read_frame ()=0
	Read the next frame from the stream (advance and acquire).
virtual vidl2_frame_sptr	current_frame ()=0
	Return the current frame in the stream.
virtual bool	seek_frame (unsigned int frame_number)=0
	Seek to the given frame number.
void	ref ()
	Increment reference count.
void	unref ()
	Decrement reference count.
int	ref_count () const
	Number of objects referring to this data.
Private Member Functions
	vidl2_istream (const vidl2_istream &other)
	prevent deep copying a stream.
Private Attributes
int	ref_count_

---

Constructor & Destructor Documentation

vidl2_istream::vidl2_istream (   )  [inline]

Constructor. Definition at line 22 of file vidl2_istream.h.

virtual vidl2_istream::~vidl2_istream (   )  [inline, virtual]

Destructor. Definition at line 24 of file vidl2_istream.h.

vidl2_istream::vidl2_istream (  const vidl2_istream &  other  )  [inline, private]

prevent deep copying a stream. Definition at line 56 of file vidl2_istream.h.

---

Member Function Documentation

virtual bool vidl2_istream::advance (   )  [pure virtual]

Advance to the next frame (but don't acquire an image). Implemented in vidl2_dc1394_istream, vidl2_dshow_file_istream, vidl2_dshow_live_istream< ParamsObject >, vidl2_ffmpeg_istream, vidl2_image_list_istream, and vidl2_v4l_istream.

virtual void vidl2_istream::close (   )  [pure virtual]

Close the stream. Implemented in vidl2_dc1394_istream, vidl2_dshow_file_istream, vidl2_dshow_live_istream< ParamsObject >, vidl2_ffmpeg_istream, vidl2_image_list_istream, and vidl2_v4l_istream.

virtual vidl2_frame_sptr vidl2_istream::current_frame (   )  [pure virtual]

Return the current frame in the stream. Implemented in vidl2_dc1394_istream, vidl2_dshow_file_istream, vidl2_dshow_live_istream< ParamsObject >, vidl2_ffmpeg_istream, vidl2_image_list_istream, and vidl2_v4l_istream.

virtual unsigned int vidl2_istream::frame_number (   )  const [pure virtual]

Return the current frame number. Implemented in vidl2_dc1394_istream, vidl2_dshow_file_istream, vidl2_dshow_live_istream< ParamsObject >, vidl2_ffmpeg_istream, vidl2_image_list_istream, and vidl2_v4l_istream.

virtual bool vidl2_istream::is_open (   )  const [pure virtual]

Return true if the stream is open for reading. Implemented in vidl2_dc1394_istream, vidl2_dshow_file_istream, vidl2_dshow_live_istream< ParamsObject >, vidl2_ffmpeg_istream, vidl2_image_list_istream, and vidl2_v4l_istream.

virtual bool vidl2_istream::is_seekable (   )  const [pure virtual]

Return true if the stream support seeking. Implemented in vidl2_dc1394_istream, vidl2_dshow_file_istream, vidl2_dshow_live_istream< ParamsObject >, vidl2_ffmpeg_istream, vidl2_image_list_istream, and vidl2_v4l_istream.

virtual bool vidl2_istream::is_valid (   )  const [pure virtual]

Return true if the stream is in a valid state. Implemented in vidl2_dc1394_istream, vidl2_dshow_file_istream, vidl2_dshow_live_istream< ParamsObject >, vidl2_ffmpeg_istream, vidl2_image_list_istream, and vidl2_v4l_istream.

virtual vidl2_frame_sptr vidl2_istream::read_frame (   )  [pure virtual]

Read the next frame from the stream (advance and acquire). Implemented in vidl2_dc1394_istream, vidl2_dshow_file_istream, vidl2_dshow_live_istream< ParamsObject >, vidl2_ffmpeg_istream, vidl2_image_list_istream, and vidl2_v4l_istream.

void vidl2_istream::ref (   )  [inline]

Increment reference count. Definition at line 63 of file vidl2_istream.h.

int vidl2_istream::ref_count (   )  const [inline]

Number of objects referring to this data. Definition at line 69 of file vidl2_istream.h.

virtual bool vidl2_istream::seek_frame (  unsigned int  frame_number  )  [pure virtual]

Seek to the given frame number. Returns: true if successful Implemented in vidl2_dc1394_istream, vidl2_dshow_file_istream, vidl2_dshow_live_istream< ParamsObject >, vidl2_ffmpeg_istream, vidl2_image_list_istream, and vidl2_v4l_istream.

void vidl2_istream::unref (   )  [inline]

Decrement reference count. Definition at line 66 of file vidl2_istream.h.

---

Member Data Documentation

int vidl2_istream::ref_count_ [private]

Definition at line 72 of file vidl2_istream.h.

---

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

• contrib/brl/bbas/vidl2/vidl2_istream.h

---