vidl2_ffmpeg_ostream Class Reference

#include <vidl2_ffmpeg_ostream.h>

Inheritance diagram for vidl2_ffmpeg_ostream:

List of all members.

---

Detailed Description

A video output stream to an encoded file using FFMPEG.

Definition at line 29 of file vidl2_ffmpeg_ostream.h.

Public Member Functions
	vidl2_ffmpeg_ostream ()
	Constructor.
	vidl2_ffmpeg_ostream (const vcl_string &filename, const vidl2_ffmpeg_ostream_params &params)
	Constructor - opens a stream.
virtual	~vidl2_ffmpeg_ostream ()
	Destructor.
virtual bool	open ()
	Open the stream.
virtual void	close ()
	Close the stream.
virtual bool	is_open () const
	Return true if the stream is open for writing.
virtual bool	write_frame (const vidl2_frame_sptr &frame)
	Write and image to the stream.
void	set_filename (const vcl_string &filename)
	Set the filename.
void	set_params (const vidl2_ffmpeg_ostream_params &params)
	Set the parameters.
vcl_string	filename () const
	Access the filename.
const vidl2_ffmpeg_ostream_params &	params () const
	Access the parameters.
void	ref ()
	Increment reference count.
void	unref ()
	Decrement reference count.
int	ref_count () const
	Number of objects referring to this data.
Private Attributes
pimpl *	os_
vcl_string	filename_
	The filename to open.
vidl2_ffmpeg_ostream_params	params_
	The parameters.
Classes
struct	pimpl

---

Constructor & Destructor Documentation

vidl2_ffmpeg_ostream::vidl2_ffmpeg_ostream

(

)

Constructor.

Definition at line 20 of file vidl2_ffmpeg_ostream_stub.txx.

vidl2_ffmpeg_ostream::vidl2_ffmpeg_ostream	(	const vcl_string &	filename,
		const vidl2_ffmpeg_ostream_params &	params
	)

Constructor - opens a stream.

Definition at line 26 of file vidl2_ffmpeg_ostream_stub.txx.

vidl2_ffmpeg_ostream::~vidl2_ffmpeg_ostream

(

)

[virtual]

Destructor.

Definition at line 35 of file vidl2_ffmpeg_ostream_stub.txx.

---

Member Function Documentation

bool vidl2_ffmpeg_ostream::open

(

)

[virtual]

Open the stream.

Definition at line 42 of file vidl2_ffmpeg_ostream_stub.txx.

void vidl2_ffmpeg_ostream::close

(

)

[virtual]

Close the stream.

Implements vidl2_ostream.

Definition at line 51 of file vidl2_ffmpeg_ostream_stub.txx.

bool vidl2_ffmpeg_ostream::is_open

(

)

const [virtual]

Return true if the stream is open for writing.

Implements vidl2_ostream.

Definition at line 58 of file vidl2_ffmpeg_ostream_stub.txx.

bool vidl2_ffmpeg_ostream::write_frame

(

const vidl2_frame_sptr &

frame

)

[virtual]

Write and image to the stream.

Return values:

false

if the image could not be written

Implements vidl2_ostream.

Definition at line 66 of file vidl2_ffmpeg_ostream_stub.txx.

void vidl2_ffmpeg_ostream::set_filename

(

const vcl_string &

filename

)

[inline]

Set the filename.

Definition at line 57 of file vidl2_ffmpeg_ostream.h.

void vidl2_ffmpeg_ostream::set_params

(

const vidl2_ffmpeg_ostream_params &

params

)

[inline]

Set the parameters.

Definition at line 60 of file vidl2_ffmpeg_ostream.h.

vcl_string vidl2_ffmpeg_ostream::filename

(

)

const [inline]

Access the filename.

Definition at line 63 of file vidl2_ffmpeg_ostream.h.

const vidl2_ffmpeg_ostream_params& vidl2_ffmpeg_ostream::params

(

)

const [inline]

Access the parameters.

Definition at line 66 of file vidl2_ffmpeg_ostream.h.

void vidl2_ostream::ref

(

)

[inline, inherited]

Increment reference count.

Definition at line 45 of file vidl2_ostream.h.

void vidl2_ostream::unref

(

)

[inline, inherited]

Decrement reference count.

Definition at line 48 of file vidl2_ostream.h.

int vidl2_ostream::ref_count

(

)

const [inline, inherited]

Number of objects referring to this data.

Definition at line 51 of file vidl2_ostream.h.

---

Member Data Documentation

pimpl* vidl2_ffmpeg_ostream::os_ [private]

Definition at line 72 of file vidl2_ffmpeg_ostream.h.

vcl_string vidl2_ffmpeg_ostream::filename_ [private]

The filename to open.

Definition at line 76 of file vidl2_ffmpeg_ostream.h.

vidl2_ffmpeg_ostream_params vidl2_ffmpeg_ostream::params_ [private]

The parameters.

Definition at line 79 of file vidl2_ffmpeg_ostream.h.

---

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

• contrib/brl/bbas/vidl2/vidl2_ffmpeg_ostream.h
• contrib/brl/bbas/vidl2/vidl2_ffmpeg_ostream_stub.txx
• contrib/brl/bbas/vidl2/vidl2_ffmpeg_ostream_v1.txx
• contrib/brl/bbas/vidl2/vidl2_ffmpeg_ostream_v2.txx

---