vidl2_ffmpeg_istream Class Reference

#include <vidl2_ffmpeg_istream.h>

Inheritance diagram for vidl2_ffmpeg_istream:

List of all members.

---

Detailed Description

A video input stream using FFMPEG to decoded files.

Definition at line 24 of file vidl2_ffmpeg_istream.h.

Public Member Functions
	vidl2_ffmpeg_istream ()
	Constructor - default.
	vidl2_ffmpeg_istream (const vcl_string &filename)
	Constructor - from a filename.
virtual	~vidl2_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 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.
Private Attributes
pimpl *	is_
Classes
struct	pimpl

---

Constructor & Destructor Documentation

vidl2_ffmpeg_istream::vidl2_ffmpeg_istream

(

)

Constructor - default.

Definition at line 20 of file vidl2_ffmpeg_istream_stub.txx.

vidl2_ffmpeg_istream::vidl2_ffmpeg_istream

(

const vcl_string &

filename

)

Constructor - from a filename.

Definition at line 25 of file vidl2_ffmpeg_istream_stub.txx.

vidl2_ffmpeg_istream::~vidl2_ffmpeg_istream

(

)

[virtual]

Destructor.

Definition at line 31 of file vidl2_ffmpeg_istream_stub.txx.

---

Member Function Documentation

bool vidl2_ffmpeg_istream::open

(

const vcl_string &

filename

)

[virtual]

Open a new stream using a filename.

Definition at line 37 of file vidl2_ffmpeg_istream_stub.txx.

void vidl2_ffmpeg_istream::close

(

)

[virtual]

Close the stream.

Implements vidl2_istream.

Definition at line 45 of file vidl2_ffmpeg_istream_stub.txx.

bool vidl2_ffmpeg_istream::is_open

(

)

const [virtual]

Return true if the stream is open for reading.

Implements vidl2_istream.

Definition at line 52 of file vidl2_ffmpeg_istream_stub.txx.

bool vidl2_ffmpeg_istream::is_valid

(

)

const [virtual]

Return true if the stream is in a valid state.

Implements vidl2_istream.

Definition at line 59 of file vidl2_ffmpeg_istream_stub.txx.

bool vidl2_ffmpeg_istream::is_seekable

(

)

const [virtual]

Return true if the stream support seeking.

Implements vidl2_istream.

Definition at line 67 of file vidl2_ffmpeg_istream_stub.txx.

unsigned int vidl2_ffmpeg_istream::frame_number

(

)

const [virtual]

Return the current frame number.

Implements vidl2_istream.

Definition at line 74 of file vidl2_ffmpeg_istream_stub.txx.

bool vidl2_ffmpeg_istream::advance

(

)

[virtual]

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

Implements vidl2_istream.

Definition at line 81 of file vidl2_ffmpeg_istream_stub.txx.

vidl2_frame_sptr vidl2_ffmpeg_istream::read_frame

(

)

[virtual]

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

Implements vidl2_istream.

Definition at line 89 of file vidl2_ffmpeg_istream_stub.txx.

vidl2_frame_sptr vidl2_ffmpeg_istream::current_frame

(

)

[virtual]

Return the current frame in the stream.

Implements vidl2_istream.

Definition at line 96 of file vidl2_ffmpeg_istream_stub.txx.

bool vidl2_ffmpeg_istream::seek_frame

(

unsigned int

frame_number

)

[virtual]

Seek to the given frame number.

Returns:

true if successful

Implements vidl2_istream.

Definition at line 104 of file vidl2_ffmpeg_istream_stub.txx.

void vidl2_istream::ref

(

)

[inline, inherited]

Increment reference count.

Definition at line 63 of file vidl2_istream.h.

void vidl2_istream::unref

(

)

[inline, inherited]

Decrement reference count.

Definition at line 66 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.

---

Member Data Documentation

pimpl* vidl2_ffmpeg_istream::is_ [private]

Definition at line 71 of file vidl2_ffmpeg_istream.h.

---

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

• contrib/brl/bbas/vidl2/vidl2_ffmpeg_istream.h
• contrib/brl/bbas/vidl2/vidl2_ffmpeg_istream_stub.txx
• contrib/brl/bbas/vidl2/vidl2_ffmpeg_istream_v1.txx
• contrib/brl/bbas/vidl2/vidl2_ffmpeg_istream_v2.txx

---