vidl2_v4l_istream Class Reference

#include <vidl2_v4l_istream.h>

Inheritance diagram for vidl2_v4l_istream:

[legend]List of all members.

---

Detailed Description

Definition at line 40 of file vidl2_v4l_istream.h.

Public Member Functions
	vidl2_v4l_istream ()
	Constructor.
	vidl2_v4l_istream (const vcl_string &device_name)
	vidl2_v4l_istream (const vcl_string &device_name, const vidl2_v4l_params p)
virtual	~vidl2_v4l_istream ()
	Destructor.
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 unsigned int	frame_number () const
	Return the current frame number.
bool	open (const vcl_string &device_name)
	Open.
virtual void	close ()
	Close the stream.
bool	set_params (const vidl2_v4l_params &p)
	set the params for the device.
vidl2_v4l_params	get_params ()
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.
Private Attributes
video_capability	vc
video_window	vw
video_picture	vp
video_mbuf	vm
video_mmap	mm
vidl2_frame_sptr	cur_frame_
vidl2_v4l_params	defaults_
vidl2_v4l_params	params_
int	fd_
unsigned int	frame_number_
void *	buf

---

Constructor & Destructor Documentation

vidl2_v4l_istream::vidl2_v4l_istream (   )  [inline]

Constructor. Definition at line 44 of file vidl2_v4l_istream.h.

vidl2_v4l_istream::vidl2_v4l_istream (  const vcl_string &  device_name  )  [inline]

Definition at line 49 of file vidl2_v4l_istream.h.

vidl2_v4l_istream::vidl2_v4l_istream (  const vcl_string &  device_name, const vidl2_v4l_params  p )  [inline]

Definition at line 54 of file vidl2_v4l_istream.h.

vidl2_v4l_istream::~vidl2_v4l_istream (   )  [virtual]

Destructor. Definition at line 17 of file vidl2_v4l_istream.cxx.

---

Member Function Documentation

bool vidl2_v4l_istream::advance (  void   )  [virtual]

Advance to the next frame (but don't acquire an image). I'm quite confused by this description - I don't even know what it means. I'm using the vidl2_dc1394_istream as a model here which clearly advances and acquires - contrary to the first sentence description Implements vidl2_istream. Definition at line 214 of file vidl2_v4l_istream.cxx.

void vidl2_v4l_istream::close (   )  [virtual]

Close the stream. Implements vidl2_istream. Definition at line 105 of file vidl2_v4l_istream.cxx.

virtual vidl2_frame_sptr vidl2_v4l_istream::current_frame (  void   )  [inline, virtual]

Return the current frame in the stream. Implements vidl2_istream. Definition at line 93 of file vidl2_v4l_istream.h.

virtual unsigned int vidl2_v4l_istream::frame_number (   )  const [inline, virtual]

Return the current frame number. Implements vidl2_istream. Definition at line 74 of file vidl2_v4l_istream.h.

vidl2_v4l_params vidl2_v4l_istream::get_params (   )  [inline]

Definition at line 84 of file vidl2_v4l_istream.h.

bool vidl2_v4l_istream::is_open (   )  const [virtual]

Return true if the stream is open for reading. Implements vidl2_istream. Definition at line 93 of file vidl2_v4l_istream.cxx.

virtual bool vidl2_v4l_istream::is_seekable (   )  const [inline, virtual]

Return true if the stream support seeking. Implements vidl2_istream. Definition at line 71 of file vidl2_v4l_istream.h.

bool vidl2_v4l_istream::is_valid (   )  const [virtual]

Return true if the stream is in a valid state. Implements vidl2_istream. Definition at line 99 of file vidl2_v4l_istream.cxx.

bool vidl2_v4l_istream::open (  const vcl_string &  device_name  )

Open. Definition at line 23 of file vidl2_v4l_istream.cxx.

vidl2_frame_sptr vidl2_v4l_istream::read_frame (  void   )  [virtual]

Read the next frame from the stream (advance and acquire). Not sure why this one is needed ... Implements vidl2_istream. Definition at line 247 of file vidl2_v4l_istream.cxx.

void vidl2_istream::ref (   )  [inline, inherited]

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

int vidl2_istream::ref_count (   )  const [inline, inherited]

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

virtual bool vidl2_v4l_istream::seek_frame (  unsigned int  frame_number  )  [inline, virtual]

Seek to the given frame number. Returns: true if successful Implements vidl2_istream. Definition at line 97 of file vidl2_v4l_istream.h.

bool vidl2_v4l_istream::set_params (  const vidl2_v4l_params &  p  )

set the params for the device. If all the parameters are set as requested, return true; else return false Definition at line 113 of file vidl2_v4l_istream.cxx.

void vidl2_istream::unref (   )  [inline, inherited]

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

---

Member Data Documentation

void* vidl2_v4l_istream::buf [private]

Definition at line 109 of file vidl2_v4l_istream.h.

vidl2_frame_sptr vidl2_v4l_istream::cur_frame_ [mutable, private]

Definition at line 104 of file vidl2_v4l_istream.h.

vidl2_v4l_params vidl2_v4l_istream::defaults_ [private]

Definition at line 105 of file vidl2_v4l_istream.h.

int vidl2_v4l_istream::fd_ [private]

Definition at line 107 of file vidl2_v4l_istream.h.

unsigned int vidl2_v4l_istream::frame_number_ [private]

Definition at line 108 of file vidl2_v4l_istream.h.

struct video_mmap vidl2_v4l_istream::mm [private]

Definition at line 103 of file vidl2_v4l_istream.h.

vidl2_v4l_params vidl2_v4l_istream::params_ [private]

Definition at line 106 of file vidl2_v4l_istream.h.

struct video_capability vidl2_v4l_istream::vc [private]

Definition at line 99 of file vidl2_v4l_istream.h.

struct video_mbuf vidl2_v4l_istream::vm [private]

Definition at line 102 of file vidl2_v4l_istream.h.

struct video_picture vidl2_v4l_istream::vp [private]

Definition at line 101 of file vidl2_v4l_istream.h.

struct video_window vidl2_v4l_istream::vw [private]

Definition at line 100 of file vidl2_v4l_istream.h.

---

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

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

---