#include <vidl_v4l_istream.h>
Public Member Functions | |
| vidl_v4l_istream () | |
| vidl_v4l_istream (const vcl_string &device_name) | |
| vidl_v4l_istream (const vcl_string &device_name, const vidl_v4l_params p) | |
| virtual | ~vidl_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 int | num_frames () const |
| Return the number of frames if known. | |
| 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 (FPS, 0.0 if unspecified). | |
| virtual double | duration () const |
| Return the duration in seconds (0.0 if unknown). | |
| 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 vidl_v4l_params &p) |
| set the params for the device. | |
| vidl_v4l_params | get_params () |
| virtual bool | advance () |
| Advance to the next frame (but don't acquire an image). | |
| virtual vidl_frame_sptr | read_frame () |
| Read the next frame from the stream (advance and acquire). | |
| virtual vidl_frame_sptr | current_frame () |
| Return the current frame in the stream. | |
| virtual bool | seek_frame (unsigned int) |
| 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 | |
| struct video_capability | vc |
| struct video_window | vw |
| struct video_picture | vp |
| struct video_mbuf | vm |
| struct video_mmap | mm |
| vidl_frame_sptr | cur_frame_ |
| vidl_v4l_params | defaults_ |
| vidl_v4l_params | params_ |
| int | fd_ |
| unsigned int | frame_number_ |
| void * | buf |
Detailed Description
Definition at line 36 of file vidl_v4l_istream.h.
Constructor & Destructor Documentation
| vidl_v4l_istream::vidl_v4l_istream | ( | ) | [inline] |
Definition at line 40 of file vidl_v4l_istream.h.
| vidl_v4l_istream::vidl_v4l_istream | ( | const vcl_string & | device_name | ) | [inline] |
Definition at line 45 of file vidl_v4l_istream.h.
| vidl_v4l_istream::vidl_v4l_istream | ( | const vcl_string & | device_name, |
| const vidl_v4l_params | p | ||
| ) | [inline] |
Definition at line 50 of file vidl_v4l_istream.h.
| vidl_v4l_istream::~vidl_v4l_istream | ( | ) | [virtual] |
Destructor.
Definition at line 19 of file vidl_v4l_istream.cxx.
Member Function Documentation
| bool vidl_v4l_istream::advance | ( | void | ) | [virtual] |
Advance to the next frame (but don't acquire an image).
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 vidl_dc1394_istream as a model here which clearly advances and acquires - contrary to the first sentence description
Implements vidl_istream.
Definition at line 216 of file vidl_v4l_istream.cxx.
| void vidl_v4l_istream::close | ( | void | ) | [virtual] |
Close the stream.
close the stream.
Implements vidl_istream.
Definition at line 107 of file vidl_v4l_istream.cxx.
| virtual vidl_frame_sptr vidl_v4l_istream::current_frame | ( | void | ) | [inline, virtual] |
Return the current frame in the stream.
Implements vidl_istream.
Definition at line 108 of file vidl_v4l_istream.h.
| virtual double vidl_v4l_istream::duration | ( | ) | const [inline, virtual] |
Return the duration in seconds (0.0 if unknown).
Implements vidl_istream.
Definition at line 86 of file vidl_v4l_istream.h.
| vidl_pixel_format vidl_v4l_istream::format | ( | ) | const [virtual] |
Return the pixel format.
Implements vidl_istream.
Definition at line 276 of file vidl_v4l_istream.cxx.
| virtual unsigned int vidl_v4l_istream::frame_number | ( | ) | const [inline, virtual] |
Return the current frame number.
Implements vidl_istream.
Definition at line 89 of file vidl_v4l_istream.h.
| double vidl_v4l_istream::frame_rate | ( | ) | const [virtual] |
Return the frame rate (FPS, 0.0 if unspecified).
Implements vidl_istream.
Definition at line 285 of file vidl_v4l_istream.cxx.
| vidl_v4l_params vidl_v4l_istream::get_params | ( | ) | [inline] |
Definition at line 99 of file vidl_v4l_istream.h.
| unsigned int vidl_v4l_istream::height | ( | ) | const [virtual] |
Return the height of each frame.
Implements vidl_istream.
Definition at line 267 of file vidl_v4l_istream.cxx.
| bool vidl_v4l_istream::is_open | ( | ) | const [virtual] |
Return true if the stream is open for reading.
return true if the stream is open for reading.
Implements vidl_istream.
Definition at line 95 of file vidl_v4l_istream.cxx.
| virtual bool vidl_v4l_istream::is_seekable | ( | ) | const [inline, virtual] |
Return true if the stream support seeking.
Implements vidl_istream.
Definition at line 67 of file vidl_v4l_istream.h.
| bool vidl_v4l_istream::is_valid | ( | void | ) | const [virtual] |
Return true if the stream is in a valid state.
return true if the stream is in a valid state.
Implements vidl_istream.
Definition at line 101 of file vidl_v4l_istream.cxx.
| virtual int vidl_v4l_istream::num_frames | ( | ) | const [inline, virtual] |
Return the number of frames if known.
returns -1 for non-seekable streams
Implements vidl_istream.
Definition at line 71 of file vidl_v4l_istream.h.
| bool vidl_v4l_istream::open | ( | const vcl_string & | device_name | ) |
| vidl_frame_sptr vidl_v4l_istream::read_frame | ( | void | ) | [virtual] |
Read the next frame from the stream (advance and acquire).
Read the next frame from the stream.
Not sure why this one is needed ...
Implements vidl_istream.
Definition at line 249 of file vidl_v4l_istream.cxx.
| void vidl_istream::ref | ( | ) | [inline, inherited] |
Increment reference count.
Definition at line 87 of file vidl_istream.h.
| int vidl_istream::ref_count | ( | ) | const [inline, inherited] |
Number of objects referring to this data.
Definition at line 93 of file vidl_istream.h.
| virtual bool vidl_v4l_istream::seek_frame | ( | unsigned int | ) | [inline, virtual] |
Seek to the given frame number.
- Returns:
- true if successful
Implements vidl_istream.
Definition at line 112 of file vidl_v4l_istream.h.
| bool vidl_v4l_istream::set_params | ( | const vidl_v4l_params & | p | ) |
set the params for the device.
set the parameters for this stream.
If all the parameters are set as requested, return true; else return false
Definition at line 115 of file vidl_v4l_istream.cxx.
| void vidl_istream::unref | ( | ) | [inline, inherited] |
Decrement reference count.
Definition at line 90 of file vidl_istream.h.
| unsigned int vidl_v4l_istream::width | ( | ) | const [virtual] |
Return the width of each frame.
Implements vidl_istream.
Definition at line 258 of file vidl_v4l_istream.cxx.
Member Data Documentation
void* vidl_v4l_istream::buf [private] |
Definition at line 124 of file vidl_v4l_istream.h.
vidl_frame_sptr vidl_v4l_istream::cur_frame_ [mutable, private] |
Definition at line 119 of file vidl_v4l_istream.h.
vidl_v4l_params vidl_v4l_istream::defaults_ [private] |
Definition at line 120 of file vidl_v4l_istream.h.
int vidl_v4l_istream::fd_ [private] |
Definition at line 122 of file vidl_v4l_istream.h.
unsigned int vidl_v4l_istream::frame_number_ [private] |
Definition at line 123 of file vidl_v4l_istream.h.
struct video_mmap vidl_v4l_istream::mm [private] |
Definition at line 118 of file vidl_v4l_istream.h.
vidl_v4l_params vidl_v4l_istream::params_ [private] |
Definition at line 121 of file vidl_v4l_istream.h.
struct video_capability vidl_v4l_istream::vc [private] |
Definition at line 114 of file vidl_v4l_istream.h.
struct video_mbuf vidl_v4l_istream::vm [private] |
Definition at line 117 of file vidl_v4l_istream.h.
struct video_picture vidl_v4l_istream::vp [private] |
Definition at line 116 of file vidl_v4l_istream.h.
struct video_window vidl_v4l_istream::vw [private] |
Definition at line 115 of file vidl_v4l_istream.h.
The documentation for this class was generated from the following files:
- core/vidl/vidl_v4l_istream.h
- core/vidl/vidl_v4l_istream.cxx
