VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkFFMPEGWriter Class Reference

Uses the FFMPEG library to write video files. More...

#include <vtkFFMPEGWriter.h>

Inheritance diagram for vtkFFMPEGWriter:
Inheritance graph
[legend]
Collaboration diagram for vtkFFMPEGWriter:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkGenericMovieWriter Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkFFMPEGWriterNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
void Start ()
void Write ()
void End ()
virtual void SetQuality (int)
virtual int GetQuality ()
virtual void SetCompression (bool)
virtual bool GetCompression ()
virtual void CompressionOn ()
virtual void CompressionOff ()
virtual void SetRate (int)
virtual int GetRate ()
virtual void SetBitRate (int)
virtual int GetBitRate ()
virtual void SetBitRateTolerance (int)
virtual int GetBitRateTolerance ()

Static Public Member Functions

static vtkFFMPEGWriterNew ()
static int IsTypeOf (const char *type)
static vtkFFMPEGWriterSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkFFMPEGWriter ()
 ~vtkFFMPEGWriter ()

Protected Attributes

vtkFFMPEGWriterInternal * Internals
int Initialized
int Quality
int Rate
int BitRate
int BitRateTolerance
bool Compression

Detailed Description

Uses the FFMPEG library to write video files.

vtkFFMPEGWriter is an adapter that allows VTK to use the LGPL'd FFMPEG library to write movie files. FFMPEG can create a variety of multimedia file formats and can use a variety of encoding algorithms (codecs). This class creates .avi files containing MP43 encoded video without audio.

The FFMPEG multimedia library source code can be obtained from the sourceforge web site at http://ffmpeg.sourceforge.net/download.php or is a tarball along with installation instructions at http://www.vtk.org/files/support/ffmpeg_source.tar.gz

Tests:
vtkFFMPEGWriter (Tests)

Definition at line 42 of file vtkFFMPEGWriter.h.


Member Typedef Documentation

Reimplemented from vtkGenericMovieWriter.

Definition at line 46 of file vtkFFMPEGWriter.h.


Constructor & Destructor Documentation


Member Function Documentation

static vtkFFMPEGWriter* vtkFFMPEGWriter::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

static int vtkFFMPEGWriter::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkGenericMovieWriter.

virtual int vtkFFMPEGWriter::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkGenericMovieWriter.

Reimplemented from vtkGenericMovieWriter.

virtual vtkObjectBase* vtkFFMPEGWriter::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkGenericMovieWriter.

Reimplemented from vtkGenericMovieWriter.

void vtkFFMPEGWriter::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkGenericMovieWriter.

void vtkFFMPEGWriter::Start ( ) [virtual]

These methods start writing an Movie file, write a frame to the file and then end the writing process.

Implements vtkGenericMovieWriter.

void vtkFFMPEGWriter::Write ( ) [virtual]

These methods start writing an Movie file, write a frame to the file and then end the writing process.

Implements vtkGenericMovieWriter.

void vtkFFMPEGWriter::End ( ) [virtual]

These methods start writing an Movie file, write a frame to the file and then end the writing process.

Implements vtkGenericMovieWriter.

virtual void vtkFFMPEGWriter::SetQuality ( int  ) [virtual]

Set/Get the compression quality. 0 means worst quality and smallest file size 2 means best quality and largest file size

virtual int vtkFFMPEGWriter::GetQuality ( ) [virtual]

Set/Get the compression quality. 0 means worst quality and smallest file size 2 means best quality and largest file size

virtual void vtkFFMPEGWriter::SetCompression ( bool  ) [virtual]

Turns on(the default) or off compression. Turning off compression overrides quality setting.

virtual bool vtkFFMPEGWriter::GetCompression ( ) [virtual]

Turns on(the default) or off compression. Turning off compression overrides quality setting.

virtual void vtkFFMPEGWriter::CompressionOn ( ) [virtual]

Turns on(the default) or off compression. Turning off compression overrides quality setting.

virtual void vtkFFMPEGWriter::CompressionOff ( ) [virtual]

Turns on(the default) or off compression. Turning off compression overrides quality setting.

virtual void vtkFFMPEGWriter::SetRate ( int  ) [virtual]

Set/Get the frame rate, in frame/s.

virtual int vtkFFMPEGWriter::GetRate ( ) [virtual]

Set/Get the frame rate, in frame/s.

virtual void vtkFFMPEGWriter::SetBitRate ( int  ) [virtual]

Set/Get the bit-rate

virtual int vtkFFMPEGWriter::GetBitRate ( ) [virtual]

Set/Get the bit-rate

virtual void vtkFFMPEGWriter::SetBitRateTolerance ( int  ) [virtual]

Set/Get the bit-rate tolerance

Set/Get the bit-rate tolerance


Member Data Documentation

vtkFFMPEGWriterInternal* vtkFFMPEGWriter::Internals [protected]

Definition at line 94 of file vtkFFMPEGWriter.h.

Definition at line 96 of file vtkFFMPEGWriter.h.

Definition at line 97 of file vtkFFMPEGWriter.h.

Definition at line 98 of file vtkFFMPEGWriter.h.

Definition at line 99 of file vtkFFMPEGWriter.h.

Definition at line 100 of file vtkFFMPEGWriter.h.

bool vtkFFMPEGWriter::Compression [protected]

Definition at line 101 of file vtkFFMPEGWriter.h.


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