vidl2_dc1394_istream Class Reference

#include <vidl2_dc1394_istream.h>

Inheritance diagram for vidl2_dc1394_istream:

List of all members.

---

Detailed Description

A video input stream using libdc1394.

This stream uses the dc1394 API (v2.0) to stream video from a IEEE 1394 camera

Definition at line 34 of file vidl2_dc1394_istream.h.

Public Member Functions
	vidl2_dc1394_istream ()
	Constructor - default.
	vidl2_dc1394_istream (const vcl_string &filename)
	Constructor - from a filename.
virtual	~vidl2_dc1394_istream ()
	Destructor.
virtual bool	open (unsigned int num_dma_buffers=2, bool drop_frames=false, const vidl2_iidc1394_params &params=vidl2_iidc1394_params())
	Open a new stream using a filename.
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 bool	advance ()
	Advance to the next frame (but don't acquire an image).
virtual vidl2_frame_sptr	read_frame ()
	Read the next frame from the stream (advance and acquire).
virtual vidl2_frame_sptr	current_frame ()
	Return the current frame in the stream.
virtual bool	seek_frame (unsigned int frame_number)
	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.
Static Public Member Functions
static bool	valid_params (vidl2_iidc1394_params::valid_options &options)
	Probe the bus to determine the valid parameter options.
Private Attributes
pimpl *	is_
Classes
struct	pimpl

---

Constructor & Destructor Documentation

vidl2_dc1394_istream::vidl2_dc1394_istream

(

)

Constructor - default.

Definition at line 142 of file vidl2_dc1394_istream.cxx.

vidl2_dc1394_istream::vidl2_dc1394_istream

(

const vcl_string &

filename

)

Constructor - from a filename.

vidl2_dc1394_istream::~vidl2_dc1394_istream

(

)

[virtual]

Destructor.

Definition at line 151 of file vidl2_dc1394_istream.cxx.

---

Member Function Documentation

bool vidl2_dc1394_istream::open	(	unsigned int	num_dma_buffers = 2,
		bool	drop_frames = false,
		const vidl2_iidc1394_params &	params = vidl2_iidc1394_params()
	)			[virtual]

Open a new stream using a filename.

Definition at line 161 of file vidl2_dc1394_istream.cxx.

void vidl2_dc1394_istream::close

(

)

[virtual]

Close the stream.

Implements vidl2_istream.

Definition at line 308 of file vidl2_dc1394_istream.cxx.

bool vidl2_dc1394_istream::valid_params

(

vidl2_iidc1394_params::valid_options &

options

)

[static]

Probe the bus to determine the valid parameter options.

Definition at line 329 of file vidl2_dc1394_istream.cxx.

bool vidl2_dc1394_istream::is_open

(

)

const [virtual]

Return true if the stream is open for reading.

Implements vidl2_istream.

Definition at line 435 of file vidl2_dc1394_istream.cxx.

bool vidl2_dc1394_istream::is_valid

(

)

const [virtual]

Return true if the stream is in a valid state.

Implements vidl2_istream.

Definition at line 444 of file vidl2_dc1394_istream.cxx.

bool vidl2_dc1394_istream::is_seekable

(

)

const [virtual]

Return true if the stream support seeking.

Implements vidl2_istream.

Definition at line 453 of file vidl2_dc1394_istream.cxx.

int vidl2_dc1394_istream::num_frames

(

)

const [virtual]

Return the number of frames if known.

returns -1 for non-seekable streams

Implements vidl2_istream.

Definition at line 463 of file vidl2_dc1394_istream.cxx.

unsigned int vidl2_dc1394_istream::frame_number

(

)

const [virtual]

Return the current frame number.

Implements vidl2_istream.

Definition at line 472 of file vidl2_dc1394_istream.cxx.

bool vidl2_dc1394_istream::advance

(

)

[virtual]

Advance to the next frame (but don't acquire an image).

Implements vidl2_istream.

Definition at line 481 of file vidl2_dc1394_istream.cxx.

vidl2_frame_sptr vidl2_dc1394_istream::read_frame

(

)

[virtual]

Read the next frame from the stream (advance and acquire).

Implements vidl2_istream.

Definition at line 499 of file vidl2_dc1394_istream.cxx.

vidl2_frame_sptr vidl2_dc1394_istream::current_frame

(

)

[virtual]

Return the current frame in the stream.

Implements vidl2_istream.

Definition at line 509 of file vidl2_dc1394_istream.cxx.

bool vidl2_dc1394_istream::seek_frame

(

unsigned int

frame_number

)

[virtual]

Seek to the given frame number.

Returns:

true if successful

Implements vidl2_istream.

Definition at line 537 of file vidl2_dc1394_istream.cxx.

void vidl2_istream::ref

(

)

[inline, inherited]

Increment reference count.

Definition at line 67 of file vidl2_istream.h.

void vidl2_istream::unref

(

)

[inline, inherited]

Decrement reference count.

Definition at line 70 of file vidl2_istream.h.

int vidl2_istream::ref_count

(

)

const [inline, inherited]

Number of objects referring to this data.

Definition at line 73 of file vidl2_istream.h.

---

Member Data Documentation

pimpl* vidl2_dc1394_istream::is_ [private]

Definition at line 91 of file vidl2_dc1394_istream.h.

---

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

• contrib/brl/bbas/vidl2/vidl2_dc1394_istream.h
• contrib/brl/bbas/vidl2/vidl2_dc1394_istream.cxx

---