A video input stream from a list of images on disk. More...

#include <vidl_image_list_istream.h>

Inheritance diagram for vidl_image_list_istream:

Public Member Functions
	vidl_image_list_istream ()
	Constructor - default.
	vidl_image_list_istream (const vcl_string &glob)
	Constructor - from a file glob string.
	vidl_image_list_istream (const vcl_vector< vcl_string > &paths)
	Constructor - from a vector of file paths.
virtual	~vidl_image_list_istream ()
	Destructor.
virtual bool	open (const vcl_string &glob)
	Open a new stream using a file glob (see vul_file_iterator).
virtual bool	open (const vcl_vector< vcl_string > &paths)
	Open a new stream using a vector of file paths.
virtual void	close ()
	Close the stream.
virtual bool	is_open () const
	Return true if the stream is open for reading.
virtual bool	is_valid () const
	Return true if the stream is in a valid state.
virtual bool	is_seekable () const
	Return true if the stream support seeking.
virtual int	num_frames () const
	Return the number of frames if known.
virtual unsigned int	frame_number () const
	Return the current frame number.
virtual unsigned int	width () const
	Return the width of each frame.
virtual unsigned int	height () const
	Return the height of each frame.
virtual vidl_pixel_format	format () const
	Return the pixel format.
virtual double	frame_rate () const
	Return the frame rate (0.0 if unspecified).
virtual double	duration () const
	Return the duration in seconds (0.0 if unknown).
virtual bool	advance ()
	Advance to the next frame (but do not open the next image).
virtual vidl_frame_sptr	read_frame ()
	Read the next frame from the stream.
virtual vidl_frame_sptr	current_frame ()
	Return the current frame in the stream.
vcl_string	current_path () const
	Return the path to the current image in the stream.
virtual bool	seek_frame (unsigned int frame_number)
	Seek to the given frame number (but do not load the image).
void	ref ()
	Increment reference count.
void	unref ()
	Decrement reference count.
int	ref_count () const
	Number of objects referring to this data.
Private Attributes
vcl_vector< vcl_string >	image_paths_
	The vector of images.
unsigned int	index_
	The current index.
unsigned int	ni_
	The image width.
unsigned int	nj_
	The image height.
vidl_pixel_format	format_
	The pixel format.
vidl_frame_sptr	current_frame_
	The current frame (cached).

Detailed Description

A video input stream from a list of images on disk.

This istream will try to open and validate (but not read image data from) every file in a list of file paths. The paths to valid image files are maintained, but only one image is opened at a time. Keeping a list of open file descriptors (via vil_image_resource_sptr) was found to be problematic. The number of simultaneously open files is limited on many platforms. The paths are tested for validity at the "open" stage rather than the "stream" stage so that we have random access to the frames (i.e. the stream is seekable).

Definition at line 27 of file vidl_image_list_istream.h.

Constructor & Destructor Documentation

vidl_image_list_istream::vidl_image_list_istream ( )

Constructor - default.

Constructor.

Definition at line 30 of file vidl_image_list_istream.cxx.

vidl_image_list_istream::vidl_image_list_istream ( const vcl_string & glob )

Constructor - from a file glob string.

Constructor.

Definition at line 39 of file vidl_image_list_istream.cxx.

vidl_image_list_istream::vidl_image_list_istream ( const vcl_vector< vcl_string > & paths )

Constructor - from a vector of file paths.

Constructor.

Definition at line 50 of file vidl_image_list_istream.cxx.

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

Destructor.

Definition at line 41 of file vidl_image_list_istream.h.

Member Function Documentation

bool vidl_image_list_istream::advance ( void ) [virtual]

Advance to the next frame (but do not open the next image).

Advance to the next frame (but do not load the next image).

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation