vidl_ffmpeg_ostream Class Reference

A video output stream to an encoded file using FFMPEG. More...

#include <vidl_ffmpeg_ostream.h>

Inheritance diagram for vidl_ffmpeg_ostream:

Inheritance graph

List of all members.

Classes
struct	pimpl
Public Member Functions
	vidl_ffmpeg_ostream ()
	Constructor.
	vidl_ffmpeg_ostream (const vcl_string &filenam, const vidl_ffmpeg_ostream_params &parms)
	Constructor - opens a stream.
virtual	~vidl_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 vidl_frame_sptr &frame)
	Write and image to the stream.
void	set_filename (const vcl_string &filenam)
	Set the filename.
void	set_params (const vidl_ffmpeg_ostream_params &parms)
	Set the parameters.
vcl_string	filename () const
	Access the filename.
const vidl_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.
vidl_ffmpeg_ostream_params	params_
	The parameters.

Detailed Description

A video output stream to an encoded file using FFMPEG.

Definition at line 29 of file vidl_ffmpeg_ostream.h.

Constructor & Destructor Documentation

vidl_ffmpeg_ostream::vidl_ffmpeg_ostream ( )

Constructor.

Definition at line 20 of file vidl_ffmpeg_ostream_stub.txx.

vidl_ffmpeg_ostream::vidl_ffmpeg_ostream	(	const vcl_string &	filenam,
		const vidl_ffmpeg_ostream_params &	parms
	)

Constructor - opens a stream.

Definition at line 26 of file vidl_ffmpeg_ostream_stub.txx.

vidl_ffmpeg_ostream::~vidl_ffmpeg_ostream ( ) [virtual]

Destructor.

Definition at line 35 of file vidl_ffmpeg_ostream_stub.txx.

Member Function Documentation

void vidl_ffmpeg_ostream::close ( void ) [virtual]

Close the stream.

Implements vidl_ostream.

Definition at line 51 of file vidl_ffmpeg_ostream_stub.txx.

vcl_string vidl_ffmpeg_ostream::filename ( ) const [inline]

Access the filename.

Definition at line 63 of file vidl_ffmpeg_ostream.h.

bool vidl_ffmpeg_ostream::is_open ( ) const [virtual]

Return true if the stream is open for writing.

Implements vidl_ostream.

Definition at line 58 of file vidl_ffmpeg_ostream_stub.txx.

bool vidl_ffmpeg_ostream::open ( ) [virtual]

Open the stream.

Definition at line 42 of file vidl_ffmpeg_ostream_stub.txx.

const vidl_ffmpeg_ostream_params& vidl_ffmpeg_ostream::params ( ) const [inline]

Access the parameters.

Definition at line 66 of file vidl_ffmpeg_ostream.h.

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

Increment reference count.

Definition at line 45 of file vidl_ostream.h.

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

Number of objects referring to this data.

Definition at line 51 of file vidl_ostream.h.

void vidl_ffmpeg_ostream::set_filename ( const vcl_string & filenam ) [inline]

Set the filename.

Definition at line 57 of file vidl_ffmpeg_ostream.h.

void vidl_ffmpeg_ostream::set_params ( const vidl_ffmpeg_ostream_params & parms ) [inline]

Set the parameters.

Definition at line 60 of file vidl_ffmpeg_ostream.h.

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

Decrement reference count.

Definition at line 48 of file vidl_ostream.h.

bool vidl_ffmpeg_ostream::write_frame ( const vidl_frame_sptr & frame ) [virtual]

Write and image to the stream.

Return values:

false if the image could not be written

Implements vidl_ostream.

Definition at line 66 of file vidl_ffmpeg_ostream_stub.txx.

Member Data Documentation

vcl_string vidl_ffmpeg_ostream::filename_ [private]

The filename to open.

Definition at line 75 of file vidl_ffmpeg_ostream.h.

pimpl* vidl_ffmpeg_ostream::os_ [private]

Definition at line 71 of file vidl_ffmpeg_ostream.h.

vidl_ffmpeg_ostream_params vidl_ffmpeg_ostream::params_ [private]

The parameters.

Definition at line 78 of file vidl_ffmpeg_ostream.h.

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