VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
vtkOggTheoraWriter Class Reference

Uses the ogg and theora libraries to write video files. More...

#include <vtkOggTheoraWriter.h>

Inheritance diagram for vtkOggTheoraWriter:
[legend]
Collaboration diagram for vtkOggTheoraWriter:
[legend]

Public Types

typedef vtkGenericMovieWriter Superclass
- Public Types inherited from vtkGenericMovieWriter
enum  MovieWriterErrorIds {
  UserError = 40000, InitError, NoInputError, CanNotCompress,
  CanNotFormat, ChangedResolutionError
}
typedef vtkProcessObject Superclass
- Public Types inherited from vtkProcessObject
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Start ()
void Write ()
void End ()
virtual void SetQuality (int)
virtual int GetQuality ()
virtual void SetRate (int)
virtual int GetRate ()
- Public Member Functions inherited from vtkGenericMovieWriter
virtual void SetInput (vtkImageData *input)
virtual vtkImageDataGetInput ()
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual int GetError ()
- Public Member Functions inherited from vtkProcessObject
void SqueezeInputArray ()
void RemoveAllInputs ()
vtkDataObject ** GetInputs ()
int GetNumberOfInputs ()
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetNumberOfInputConnections (int port, int n)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
vtkDataObjectGetOutputDataObject (int port)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
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)
vtkDataObjectGetInputDataObject (int port, int connection)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkOggTheoraWriterNew ()
static int IsTypeOf (const char *type)
static vtkOggTheoraWriterSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkGenericMovieWriter
static const char * GetStringFromErrorCode (unsigned long event)

Protected Attributes

vtkOggTheoraWriterInternal * Internals
int Initialized
int Quality
int Rate
int Subsampling
- Protected Attributes inherited from vtkGenericMovieWriter
char * FileName
int Error
- Protected Attributes inherited from vtkProcessObject
int NumberOfInputs
int NumberOfRequiredInputs
vtkDataObject ** Inputs
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
double Progress
char * ProgressText
unsigned long ErrorCode
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers
virtual void SetSubsampling (int)
virtual int GetSubsampling ()
virtual void SubsamplingOn ()
virtual void SubsamplingOff ()
 vtkOggTheoraWriter ()
 ~vtkOggTheoraWriter ()

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Protected Member Functions inherited from vtkGenericMovieWriter
 vtkGenericMovieWriter ()
 ~vtkGenericMovieWriter ()
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

Detailed Description

Uses the ogg and theora libraries to write video files.

vtkOggTheoraWriter is an adapter that allows VTK to use the ogg and theora libraries to write movie files. This class creates .ogv files containing theora encoded video without audio.

This implementation is based on vtkFFMPEGWriter and uses some code derived from the encoder example distributed with libtheora.

Tests:
vtkOggTheoraWriter (Tests)

Definition at line 38 of file vtkOggTheoraWriter.h.

Member Typedef Documentation

Definition at line 42 of file vtkOggTheoraWriter.h.

Constructor & Destructor Documentation

vtkOggTheoraWriter::vtkOggTheoraWriter ( )
protected

Is the video to be encoded using 4:2:0 subsampling?

vtkOggTheoraWriter::~vtkOggTheoraWriter ( )
protected

Is the video to be encoded using 4:2:0 subsampling?

Member Function Documentation

static vtkOggTheoraWriter* vtkOggTheoraWriter::New ( )
static

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

Reimplemented from vtkAlgorithm.

virtual const char* vtkOggTheoraWriter::GetClassName ( )
virtual

Reimplemented from vtkGenericMovieWriter.

static int vtkOggTheoraWriter::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 vtkOggTheoraWriter::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 vtkOggTheoraWriter* vtkOggTheoraWriter::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkGenericMovieWriter.

void vtkOggTheoraWriter::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 vtkOggTheoraWriter::Start ( )
virtual

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

Implements vtkGenericMovieWriter.

void vtkOggTheoraWriter::Write ( )
virtual

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

Implements vtkGenericMovieWriter.

void vtkOggTheoraWriter::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 vtkOggTheoraWriter::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 vtkOggTheoraWriter::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 vtkOggTheoraWriter::SetRate ( int  )
virtual

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

virtual int vtkOggTheoraWriter::GetRate ( )
virtual

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

virtual void vtkOggTheoraWriter::SetSubsampling ( int  )
virtual

Is the video to be encoded using 4:2:0 subsampling?

virtual int vtkOggTheoraWriter::GetSubsampling ( )
virtual

Is the video to be encoded using 4:2:0 subsampling?

virtual void vtkOggTheoraWriter::SubsamplingOn ( )
virtual

Is the video to be encoded using 4:2:0 subsampling?

virtual void vtkOggTheoraWriter::SubsamplingOff ( )
virtual

Is the video to be encoded using 4:2:0 subsampling?

Member Data Documentation

vtkOggTheoraWriterInternal* vtkOggTheoraWriter::Internals
protected

Definition at line 76 of file vtkOggTheoraWriter.h.

int vtkOggTheoraWriter::Initialized
protected

Definition at line 78 of file vtkOggTheoraWriter.h.

int vtkOggTheoraWriter::Quality
protected

Definition at line 79 of file vtkOggTheoraWriter.h.

int vtkOggTheoraWriter::Rate
protected

Definition at line 80 of file vtkOggTheoraWriter.h.

int vtkOggTheoraWriter::Subsampling
protected

Definition at line 81 of file vtkOggTheoraWriter.h.


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