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

Video-for-Windows video digitizer. More...

#include <vtkWin32VideoSource.h>

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

Public Types

typedef vtkVideoSource Superclass
- Public Types inherited from vtkVideoSource
typedef vtkImageAlgorithm Superclass
- Public Types inherited from vtkImageAlgorithm
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 Record ()
void Play ()
void Stop ()
void Grab ()
void SetFrameRate (float rate)
void SetOutputFormat (int format)
void VideoFormatDialog ()
void VideoSourceDialog ()
void Initialize ()
void ReleaseSystemResources ()
void SetFrameSize (int x, int y, int z)
virtual void SetFrameSize (int dim[3])
void SetPreview (int p)
virtual void PreviewOn ()
virtual void PreviewOff ()
virtual int GetPreview ()
void LocalInternalGrab (void *)
void OnParentWndDestroy ()
- Public Member Functions inherited from vtkVideoSource
virtual void Rewind ()
virtual void FastForward ()
virtual void Seek (int n)
virtual double GetFrameTimeStamp (int frame)
double GetFrameTimeStamp ()
virtual void InternalGrab ()
virtual int GetRecording ()
virtual int GetPlaying ()
virtual int * GetFrameSize ()
virtual void GetFrameSize (int &, int &, int &)
virtual void GetFrameSize (int[3])
virtual float GetFrameRate ()
void SetOutputFormatToLuminance ()
void SetOutputFormatToRGB ()
void SetOutputFormatToRGBA ()
virtual int GetOutputFormat ()
virtual void SetFrameBufferSize (int FrameBufferSize)
virtual int GetFrameBufferSize ()
virtual void SetNumberOfOutputFrames (int)
virtual int GetNumberOfOutputFrames ()
virtual void AutoAdvanceOn ()
virtual void AutoAdvanceOff ()
virtual void SetAutoAdvance (int)
virtual int GetAutoAdvance ()
virtual void SetClipRegion (int r[6])
virtual void SetClipRegion (int x0, int x1, int y0, int y1, int z0, int z1)
virtual int * GetClipRegion ()
virtual void GetClipRegion (int &, int &, int &, int &, int &, int &)
virtual void GetClipRegion (int[6])
virtual void SetOutputWholeExtent (int, int, int, int, int, int)
virtual void SetOutputWholeExtent (int[6])
virtual int * GetOutputWholeExtent ()
virtual void GetOutputWholeExtent (int &, int &, int &, int &, int &, int &)
virtual void GetOutputWholeExtent (int[6])
virtual void SetDataSpacing (double, double, double)
virtual void SetDataSpacing (double[3])
virtual double * GetDataSpacing ()
virtual void GetDataSpacing (double &, double &, double &)
virtual void GetDataSpacing (double[3])
virtual void SetDataOrigin (double, double, double)
virtual void SetDataOrigin (double[3])
virtual double * GetDataOrigin ()
virtual void GetDataOrigin (double &, double &, double &)
virtual void GetDataOrigin (double[3])
virtual void SetOpacity (float)
virtual float GetOpacity ()
virtual int GetFrameCount ()
virtual void SetFrameCount (int)
virtual int GetFrameIndex ()
virtual int GetInitialized ()
void SetStartTimeStamp (double t)
double GetStartTimeStamp ()
- Public Member Functions inherited from vtkImageAlgorithm
vtkDataObjectGetInput (int port)
vtkDataObjectGetInput ()
vtkImageDataGetImageDataInput (int port)
vtkImageDataGetOutput ()
vtkImageDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
virtual void AddInput (vtkDataObject *)
virtual void AddInput (int, vtkDataObject *)
- 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)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
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 ()
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)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
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 vtkWin32VideoSourceNew ()
static int IsTypeOf (const char *type)
static vtkWin32VideoSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkWin32VideoSource ()
 ~vtkWin32VideoSource ()
void CheckBuffer ()
void UnpackRasterLine (char *outptr, char *inptr, int start, int count)
void DoVFWFormatSetup ()
void DoVFWFormatCheck ()
- Protected Member Functions inherited from vtkVideoSource
 vtkVideoSource ()
 ~vtkVideoSource ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void UpdateFrameBuffer ()
virtual void AdvanceFrameBuffer (int n)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 ~vtkImageAlgorithm ()
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void AllocateOutputData (vtkImageData *out, int *uExtent)
virtual vtkImageDataAllocateOutputData (vtkDataObject *out)
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- 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 vtkExecutiveCreateDefaultExecutive ()
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)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

char WndClassName [16]
int BitMapSize
int Preview
vtkWin32VideoSourceInternal * Internal
- Protected Attributes inherited from vtkVideoSource
int Initialized
int FrameSize [3]
int ClipRegion [6]
int OutputWholeExtent [6]
double DataSpacing [3]
double DataOrigin [3]
int OutputFormat
int NumberOfScalarComponents
int FrameOutputExtent [6]
int LastNumberOfScalarComponents
int LastOutputExtent [6]
int Recording
int Playing
float FrameRate
int FrameCount
int FrameIndex
double StartTimeStamp
double FrameTimeStamp
int AutoAdvance
int NumberOfOutputFrames
float Opacity
int FlipFrames
int OutputNeedsInitialization
vtkMultiThreaderPlayerThreader
int PlayerThreadId
vtkCriticalSectionFrameBufferMutex
int FrameBufferBitsPerPixel
int FrameBufferRowAlignment
int FrameBufferExtent [6]
int FrameBufferSize
int FrameBufferIndex
void ** FrameBuffer
double * FrameBufferTimeStamps

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- 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

Video-for-Windows video digitizer.

vtkWin32VideoSource grabs frames or streaming video from a Video for Windows compatible device on the Win32 platform.

Warning
With some capture cards, if this class is leaked and ReleaseSystemResources is not called, you may have to reboot before you can capture again. vtkVideoSource used to keep a global list and delete the video sources if your program leaked, due to exit crashes that was removed.
See Also
vtkVideoSource vtkMILVideoSource
Tests:
vtkWin32VideoSource (Tests)

Definition at line 40 of file vtkWin32VideoSource.h.

Member Typedef Documentation

Definition at line 44 of file vtkWin32VideoSource.h.

Constructor & Destructor Documentation

vtkWin32VideoSource::vtkWin32VideoSource ( )
protected
vtkWin32VideoSource::~vtkWin32VideoSource ( )
protected

Member Function Documentation

static vtkWin32VideoSource* vtkWin32VideoSource::New ( )
static

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

Reimplemented from vtkVideoSource.

virtual const char* vtkWin32VideoSource::GetClassName ( )
virtual

Reimplemented from vtkVideoSource.

static int vtkWin32VideoSource::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 vtkVideoSource.

virtual int vtkWin32VideoSource::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 vtkVideoSource.

static vtkWin32VideoSource* vtkWin32VideoSource::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkVideoSource.

void vtkWin32VideoSource::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 vtkVideoSource.

void vtkWin32VideoSource::Record ( )
virtual

Standard VCR functionality: Record incoming video.

Reimplemented from vtkVideoSource.

void vtkWin32VideoSource::Play ( )
virtual

Standard VCR functionality: Play recorded video.

Reimplemented from vtkVideoSource.

void vtkWin32VideoSource::Stop ( )
virtual

Standard VCR functionality: Stop recording or playing.

Reimplemented from vtkVideoSource.

void vtkWin32VideoSource::Grab ( )
virtual

Grab a single video frame.

Reimplemented from vtkVideoSource.

void vtkWin32VideoSource::SetFrameSize ( int  x,
int  y,
int  z 
)
virtual

Request a particular frame size (set the third value to 1).

Reimplemented from vtkVideoSource.

virtual void vtkWin32VideoSource::SetFrameSize ( int  dim[3])
inlinevirtual

Request a particular frame size (set the third value to 1).

Reimplemented from vtkVideoSource.

Definition at line 62 of file vtkWin32VideoSource.h.

void vtkWin32VideoSource::SetFrameRate ( float  rate)
virtual

Request a particular frame rate (default 30 frames per second).

Reimplemented from vtkVideoSource.

void vtkWin32VideoSource::SetOutputFormat ( int  format)
virtual

Request a particular output format (default: VTK_RGB).

Reimplemented from vtkVideoSource.

void vtkWin32VideoSource::SetPreview ( int  p)

Turn on/off the preview (overlay) window.

virtual void vtkWin32VideoSource::PreviewOn ( )
virtual

Turn on/off the preview (overlay) window.

virtual void vtkWin32VideoSource::PreviewOff ( )
virtual

Turn on/off the preview (overlay) window.

virtual int vtkWin32VideoSource::GetPreview ( )
virtual

Turn on/off the preview (overlay) window.

void vtkWin32VideoSource::VideoFormatDialog ( )

Bring up a modal dialog box for video format selection.

void vtkWin32VideoSource::VideoSourceDialog ( )

Bring up a modal dialog box for video input selection.

void vtkWin32VideoSource::Initialize ( )
virtual

Initialize the driver (this is called automatically when the first grab is done).

Reimplemented from vtkVideoSource.

void vtkWin32VideoSource::ReleaseSystemResources ( )
virtual

Free the driver (this is called automatically inside the destructor).

Reimplemented from vtkVideoSource.

void vtkWin32VideoSource::LocalInternalGrab ( void *  )

For internal use only

void vtkWin32VideoSource::OnParentWndDestroy ( )

For internal use only

void vtkWin32VideoSource::CheckBuffer ( )
protected
void vtkWin32VideoSource::UnpackRasterLine ( char *  outPtr,
char *  rowPtr,
int  start,
int  count 
)
protectedvirtual

These methods can be overridden in subclasses

Reimplemented from vtkVideoSource.

void vtkWin32VideoSource::DoVFWFormatSetup ( )
protected
void vtkWin32VideoSource::DoVFWFormatCheck ( )
protected

Member Data Documentation

char vtkWin32VideoSource::WndClassName[16]
protected

Definition at line 102 of file vtkWin32VideoSource.h.

int vtkWin32VideoSource::BitMapSize
protected

Definition at line 103 of file vtkWin32VideoSource.h.

int vtkWin32VideoSource::Preview
protected

Definition at line 104 of file vtkWin32VideoSource.h.

vtkWin32VideoSourceInternal* vtkWin32VideoSource::Internal
protected

Definition at line 106 of file vtkWin32VideoSource.h.


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