vtkFFMPEGWriter Class Reference

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

#include <vtkFFMPEGWriter.h>

Inheritance diagram for vtkFFMPEGWriter:

Collaboration diagram for vtkFFMPEGWriter:

Public Types
typedef vtkGenericMovieWriter	Superclass
Public Types inherited from vtkGenericMovieWriter
enum	MovieWriterErrorIds {   UserError = 40000, InitError, NoInputError, CanNotCompress,   CanNotFormat, ChangedResolutionError }
typedef vtkImageAlgorithm	Superclass
Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkFFMPEGWriter *	NewInstance () 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 ()
Public Member Functions inherited from vtkGenericMovieWriter
vtkGenericMovieWriter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
virtual int	GetError ()
Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () const
vtkImageData *	GetOutput ()
vtkImageData *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetInput ()
vtkImageData *	GetImageDataInput (int port)
virtual void	AddInputData (vtkDataObject *)
virtual void	AddInputData (int, vtkDataObject *)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkFFMPEGWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkFFMPEGWriter *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkGenericMovieWriter
static int	IsTypeOf (const char *type)
static vtkGenericMovieWriter *	SafeDownCast (vtkObjectBase *o)
static const char *	GetStringFromErrorCode (unsigned long event)
Static Public Member Functions inherited from vtkImageAlgorithm
static int	IsTypeOf (const char *type)
static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkFFMPEGWriter ()
	~vtkFFMPEGWriter ()
Protected Member Functions inherited from vtkGenericMovieWriter
	vtkGenericMovieWriter ()
	~vtkGenericMovieWriter ()
Protected Member Functions inherited from vtkImageAlgorithm
	vtkImageAlgorithm ()
	~vtkImageAlgorithm ()
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void	CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void	ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
virtual void	ExecuteData (vtkDataObject *output)
virtual void	Execute ()
virtual void	AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
virtual vtkImageData *	AllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
virtual void	CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
virtual void	SetErrorCode (unsigned long)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkFFMPEGWriterInternal *	Internals
int	Initialized
int	Quality
int	Rate
int	BitRate
int	BitRateTolerance
bool	Compression
Protected Attributes inherited from vtkGenericMovieWriter
char *	FileName
int	Error
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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

typedef vtkGenericMovieWriter vtkFFMPEGWriter::Superclass

Definition at line 46 of file vtkFFMPEGWriter.h.

Constructor & Destructor Documentation

vtkFFMPEGWriter::vtkFFMPEGWriter ( )

protected

vtkFFMPEGWriter::~vtkFFMPEGWriter ( )

protected

Member Function Documentation

static vtkFFMPEGWriter* vtkFFMPEGWriter::New ( )

static

static int vtkFFMPEGWriter::IsTypeOf ( const char *  type )

static

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.

static vtkFFMPEGWriter* vtkFFMPEGWriter::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkFFMPEGWriter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGenericMovieWriter.

vtkFFMPEGWriter* vtkFFMPEGWriter::NewInstance

(

)

const

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 vtkImageAlgorithm.

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

virtual int vtkFFMPEGWriter::GetBitRateTolerance ( )

virtual

Set/Get the bit-rate tolerance

Member Data Documentation

vtkFFMPEGWriterInternal* vtkFFMPEGWriter::Internals

protected

Definition at line 94 of file vtkFFMPEGWriter.h.

int vtkFFMPEGWriter::Initialized

protected

Definition at line 96 of file vtkFFMPEGWriter.h.

int vtkFFMPEGWriter::Quality

protected

Definition at line 97 of file vtkFFMPEGWriter.h.

int vtkFFMPEGWriter::Rate

protected

Definition at line 98 of file vtkFFMPEGWriter.h.

int vtkFFMPEGWriter::BitRate

protected

Definition at line 99 of file vtkFFMPEGWriter.h.

int vtkFFMPEGWriter::BitRateTolerance

protected

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:

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/FFMPEG/vtkFFMPEGWriter.h