A video input stream using FFMPEG to decoded files. More...
#include <vidl_ffmpeg_istream.h>
Classes | |
| struct | pimpl |
Public Member Functions | |
| vidl_ffmpeg_istream () | |
| Constructor - default. | |
| vidl_ffmpeg_istream (const vcl_string &filename) | |
| Constructor - from a filename. | |
| virtual | ~vidl_ffmpeg_istream () |
| Destructor. | |
| virtual bool | open (const vcl_string &filename) |
| 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 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 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 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 | |
| pimpl * | is_ |
Detailed Description
A video input stream using FFMPEG to decoded files.
Definition at line 24 of file vidl_ffmpeg_istream.h.
Constructor & Destructor Documentation
| vidl_ffmpeg_istream::vidl_ffmpeg_istream | ( | ) |
| vidl_ffmpeg_istream::vidl_ffmpeg_istream | ( | const vcl_string & | filename | ) |
Constructor - from a filename.
Definition at line 25 of file vidl_ffmpeg_istream_stub.txx.
| vidl_ffmpeg_istream::~vidl_ffmpeg_istream | ( | ) | [virtual] |
Destructor.
Definition at line 31 of file vidl_ffmpeg_istream_stub.txx.
Member Function Documentation
| bool vidl_ffmpeg_istream::advance | ( | void | ) | [virtual] |
Advance to the next frame (but don't acquire an image).
Implements vidl_istream.
Definition at line 134 of file vidl_ffmpeg_istream_stub.txx.
| void vidl_ffmpeg_istream::close | ( | void | ) | [virtual] |
Close the stream.
Implements vidl_istream.
Definition at line 45 of file vidl_ffmpeg_istream_stub.txx.
| vidl_frame_sptr vidl_ffmpeg_istream::current_frame | ( | void | ) | [virtual] |
Return the current frame in the stream.
Implements vidl_istream.
Definition at line 149 of file vidl_ffmpeg_istream_stub.txx.
| double vidl_ffmpeg_istream::duration | ( | ) | const [virtual] |
Return the duration in seconds (0.0 if unknown).
Implements vidl_istream.
Definition at line 126 of file vidl_ffmpeg_istream_stub.txx.
| vidl_pixel_format vidl_ffmpeg_istream::format | ( | ) | const [virtual] |
Return the pixel format.
Implements vidl_istream.
Definition at line 108 of file vidl_ffmpeg_istream_stub.txx.
| unsigned int vidl_ffmpeg_istream::frame_number | ( | ) | const [virtual] |
Return the current frame number.
Implements vidl_istream.
Definition at line 81 of file vidl_ffmpeg_istream_stub.txx.
| double vidl_ffmpeg_istream::frame_rate | ( | ) | const [virtual] |
Return the frame rate (FPS, 0.0 if unspecified).
Return the frame rate (0.0 if unspecified).
Implements vidl_istream.
Definition at line 117 of file vidl_ffmpeg_istream_stub.txx.
| unsigned int vidl_ffmpeg_istream::height | ( | ) | const [virtual] |
Return the height of each frame.
Implements vidl_istream.
Definition at line 99 of file vidl_ffmpeg_istream_stub.txx.
| bool vidl_ffmpeg_istream::is_open | ( | ) | const [virtual] |
Return true if the stream is open for reading.
Implements vidl_istream.
Definition at line 52 of file vidl_ffmpeg_istream_stub.txx.
| bool vidl_ffmpeg_istream::is_seekable | ( | ) | const [virtual] |
Return true if the stream support seeking.
Implements vidl_istream.
Definition at line 67 of file vidl_ffmpeg_istream_stub.txx.
| bool vidl_ffmpeg_istream::is_valid | ( | void | ) | const [virtual] |
Return true if the stream is in a valid state.
Implements vidl_istream.
Definition at line 59 of file vidl_ffmpeg_istream_stub.txx.
| int vidl_ffmpeg_istream::num_frames | ( | ) | const [virtual] |
Return the number of frames if known.
returns -1 for non-seekable streams
- Returns:
- -1 for non-seekable streams
Implements vidl_istream.
Definition at line 74 of file vidl_ffmpeg_istream_stub.txx.
| bool vidl_ffmpeg_istream::open | ( | const vcl_string & | filename | ) | [virtual] |
Open a new stream using a filename.
Definition at line 37 of file vidl_ffmpeg_istream_stub.txx.
| vidl_frame_sptr vidl_ffmpeg_istream::read_frame | ( | void | ) | [virtual] |
Read the next frame from the stream (advance and acquire).
Read the next frame from the stream.
Implements vidl_istream.
Definition at line 142 of file vidl_ffmpeg_istream_stub.txx.
| 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.
| bool vidl_ffmpeg_istream::seek_frame | ( | unsigned int | frame | ) | [virtual] |
Seek to the given frame number.
- Returns:
- true if successful
Implements vidl_istream.
Definition at line 157 of file vidl_ffmpeg_istream_stub.txx.
| void vidl_istream::unref | ( | ) | [inline, inherited] |
Decrement reference count.
Definition at line 90 of file vidl_istream.h.
| unsigned int vidl_ffmpeg_istream::width | ( | ) | const [virtual] |
Return the width of each frame.
Implements vidl_istream.
Definition at line 90 of file vidl_ffmpeg_istream_stub.txx.
Member Data Documentation
pimpl* vidl_ffmpeg_istream::is_ [private] |
Definition at line 90 of file vidl_ffmpeg_istream.h.
The documentation for this class was generated from the following files:
- core/vidl/vidl_ffmpeg_istream.h
- core/vidl/vidl_ffmpeg_istream_stub.txx
- core/vidl/vidl_ffmpeg_istream_v1.txx
- core/vidl/vidl_ffmpeg_istream_v2.txx
- core/vidl/vidl_ffmpeg_istream_v3.txx
