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

Superclass of video input devices for VTK. More...

#include <vtkVideoSource.h>

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

Public Types

typedef vtkImageAlgorithm Superclass
 
- Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkVideoSourceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Record ()
 Record incoming video at the specified FrameRate. More...
 
virtual void Play ()
 Play through the 'tape' sequentially at the specified frame rate. More...
 
virtual void Stop ()
 Stop recording or playing. More...
 
virtual void Rewind ()
 Rewind to the frame with the earliest timestamp. More...
 
virtual void FastForward ()
 FastForward to the last frame that was recorded (i.e. More...
 
virtual void Seek (int n)
 Seek forwards or backwards by the specified number of frames (positive is forward, negative is backward). More...
 
virtual void Grab ()
 Grab a single video frame. More...
 
virtual double GetFrameTimeStamp (int frame)
 Get a time stamp in seconds (resolution of milliseconds) for a video frame. More...
 
double GetFrameTimeStamp ()
 Get a time stamp in seconds (resolution of milliseconds) for the Output. More...
 
virtual void ReleaseSystemResources ()
 Release the video driver. More...
 
virtual void InternalGrab ()
 The internal function which actually does the grab. More...
 
virtual int GetRecording ()
 Are we in record mode? (record mode and play mode are mutually exclusive). More...
 
virtual int GetPlaying ()
 Are we in play mode? (record mode and play mode are mutually exclusive). More...
 
virtual void SetFrameSize (int x, int y, int z)
 Set the full-frame size. More...
 
virtual void SetFrameSize (int dim[3])
 Set the full-frame size. More...
 
virtual intGetFrameSize ()
 Set the full-frame size. More...
 
virtual void GetFrameSize (int &, int &, int &)
 Set the full-frame size. More...
 
virtual void GetFrameSize (int[3])
 Set the full-frame size. More...
 
virtual void SetFrameRate (float rate)
 Request a particular frame rate (default 30 frames per second). More...
 
virtual float GetFrameRate ()
 Request a particular frame rate (default 30 frames per second). More...
 
virtual void SetOutputFormat (int format)
 Set the output format. More...
 
void SetOutputFormatToLuminance ()
 Set the output format. More...
 
void SetOutputFormatToRGB ()
 Set the output format. More...
 
void SetOutputFormatToRGBA ()
 Set the output format. More...
 
virtual int GetOutputFormat ()
 Set the output format. More...
 
virtual void SetFrameBufferSize (int FrameBufferSize)
 Set size of the frame buffer, i.e. More...
 
virtual int GetFrameBufferSize ()
 Set size of the frame buffer, i.e. More...
 
virtual void SetNumberOfOutputFrames (int)
 Set the number of frames to copy to the output on each execute. More...
 
virtual int GetNumberOfOutputFrames ()
 Set the number of frames to copy to the output on each execute. More...
 
virtual void AutoAdvanceOn ()
 Set whether to automatically advance the buffer before each grab. More...
 
virtual void AutoAdvanceOff ()
 Set whether to automatically advance the buffer before each grab. More...
 
virtual void SetAutoAdvance (vtkTypeBool)
 Set whether to automatically advance the buffer before each grab. More...
 
virtual vtkTypeBool GetAutoAdvance ()
 Set whether to automatically advance the buffer before each grab. More...
 
virtual void SetClipRegion (int r[6])
 Set the clip rectangle for the frames. More...
 
virtual void SetClipRegion (int x0, int x1, int y0, int y1, int z0, int z1)
 Set the clip rectangle for the frames. More...
 
virtual intGetClipRegion ()
 Set the clip rectangle for the frames. More...
 
virtual void GetClipRegion (int &, int &, int &, int &, int &, int &)
 Set the clip rectangle for the frames. More...
 
virtual void GetClipRegion (int[6])
 Set the clip rectangle for the frames. More...
 
virtual void SetOutputWholeExtent (int, int, int, int, int, int)
 Get/Set the WholeExtent of the output. More...
 
virtual void SetOutputWholeExtent (int[6])
 Get/Set the WholeExtent of the output. More...
 
virtual intGetOutputWholeExtent ()
 Get/Set the WholeExtent of the output. More...
 
virtual void GetOutputWholeExtent (int &, int &, int &, int &, int &, int &)
 Get/Set the WholeExtent of the output. More...
 
virtual void GetOutputWholeExtent (int[6])
 Get/Set the WholeExtent of the output. More...
 
virtual void SetDataSpacing (double, double, double)
 Set/Get the pixel spacing. More...
 
virtual void SetDataSpacing (double[3])
 Set/Get the pixel spacing. More...
 
virtual doubleGetDataSpacing ()
 Set/Get the pixel spacing. More...
 
virtual void GetDataSpacing (double &, double &, double &)
 Set/Get the pixel spacing. More...
 
virtual void GetDataSpacing (double[3])
 Set/Get the pixel spacing. More...
 
virtual void SetDataOrigin (double, double, double)
 Set/Get the coordinates of the lower, left corner of the frame. More...
 
virtual void SetDataOrigin (double[3])
 Set/Get the coordinates of the lower, left corner of the frame. More...
 
virtual doubleGetDataOrigin ()
 Set/Get the coordinates of the lower, left corner of the frame. More...
 
virtual void GetDataOrigin (double &, double &, double &)
 Set/Get the coordinates of the lower, left corner of the frame. More...
 
virtual void GetDataOrigin (double[3])
 Set/Get the coordinates of the lower, left corner of the frame. More...
 
virtual void SetOpacity (float)
 For RGBA output only (4 scalar components), set the opacity. More...
 
virtual float GetOpacity ()
 For RGBA output only (4 scalar components), set the opacity. More...
 
virtual int GetFrameCount ()
 This value is incremented each time a frame is grabbed. More...
 
virtual void SetFrameCount (int)
 This value is incremented each time a frame is grabbed. More...
 
virtual int GetFrameIndex ()
 Get the frame index relative to the 'beginning of the tape'. More...
 
virtual void Initialize ()
 Initialize the hardware. More...
 
virtual int GetInitialized ()
 Initialize the hardware. More...
 
void SetStartTimeStamp (double t)
 And internal variable which marks the beginning of a Record session. More...
 
double GetStartTimeStamp ()
 And internal variable which marks the beginning of a Record session. More...
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Process a request from the executive. More...
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkImageDataGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
vtkDataObjectGetInput (int port)
 Get a data object for one of the input port connections. More...
 
vtkDataObjectGetInput ()
 Get a data object for one of the input port connections. More...
 
vtkImageDataGetImageDataInput (int port)
 Get a data object for one of the input port connections. More...
 
virtual void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
virtual void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkVideoSourceNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVideoSourceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkVideoSource ()
 
 ~vtkVideoSource () override
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses can reimplement this method to collect information from their inputs and set information for their outputs. More...
 
virtual void UpdateFrameBuffer ()
 These methods can be overridden in subclasses. More...
 
virtual void AdvanceFrameBuffer (int n)
 These methods can be overridden in subclasses. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 These methods can be overridden in subclasses. More...
 
virtual void UnpackRasterLine (char *outPtr, char *rowPtr, int start, int count)
 These methods can be overridden in subclasses. More...
 
- Protected Member Functions inherited from vtkImageAlgorithm
 vtkImageAlgorithm ()
 
 ~vtkImageAlgorithm () override
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections. More...
 
virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 Convenience method to copy the scalar type and number of components from the input data to the output data. More...
 
virtual void ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
 This is a convenience method that is implemented in many subclasses instead of RequestData. More...
 
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
 Copy the other point and cell data. More...
 
virtual void ExecuteData (vtkDataObject *output)
 This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
 
virtual void Execute ()
 This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...
 
virtual void AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
 Allocate the output data. More...
 
virtual vtkImageDataAllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
 Allocate the output data. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

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
 
double StartTimeStamp
 
double FrameTimeStamp
 
vtkTypeBool AutoAdvance
 
int NumberOfOutputFrames
 
float Opacity
 
int FlipFrames
 
int OutputNeedsInitialization
 
vtkMultiThreaderPlayerThreader
 
int PlayerThreadId
 
vtkCriticalSectionFrameBufferMutex
 
int FrameBufferBitsPerPixel
 
int FrameBufferRowAlignment
 
int FrameBufferExtent [6]
 
int FrameBufferSize
 
int FrameBufferIndex
 
int FrameIndex
 
void ** FrameBuffer
 
doubleFrameBufferTimeStamps
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Superclass of video input devices for VTK.

vtkVideoSource is a superclass for video input interfaces for VTK. The goal is to provide an interface which is very similar to the interface of a VCR, where the 'tape' is an internal frame buffer capable of holding a preset number of video frames. Specialized versions of this class record input from various video input sources. This base class records input from a noise source.

Warning
You must call the ReleaseSystemResources() method before the application exits. Otherwise the application might hang while trying to exit.
See also
vtkWin32VideoSource vtkMILVideoSource

Definition at line 43 of file vtkVideoSource.h.

Member Typedef Documentation

Definition at line 47 of file vtkVideoSource.h.

Constructor & Destructor Documentation

vtkVideoSource::vtkVideoSource ( )
protected
vtkVideoSource::~vtkVideoSource ( )
overrideprotected

Member Function Documentation

static vtkVideoSource* vtkVideoSource::New ( )
static
static vtkTypeBool vtkVideoSource::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkVideoSource::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 vtkImageAlgorithm.

Reimplemented in vtkFFMPEGVideoSource, vtkMILVideoSource, and vtkWin32VideoSource.

static vtkVideoSource* vtkVideoSource::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkVideoSource::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkFFMPEGVideoSource, vtkMILVideoSource, and vtkWin32VideoSource.

vtkVideoSource* vtkVideoSource::NewInstance ( ) const
void vtkVideoSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

Reimplemented in vtkWin32VideoSource.

virtual void vtkVideoSource::Record ( )
virtual

Record incoming video at the specified FrameRate.

The recording continues indefinitely until Stop() is called.

Reimplemented in vtkFFMPEGVideoSource, vtkMILVideoSource, and vtkWin32VideoSource.

virtual void vtkVideoSource::Play ( )
virtual

Play through the 'tape' sequentially at the specified frame rate.

If you have just finished Recoding, you should call Rewind() first.

Reimplemented in vtkFFMPEGVideoSource, vtkMILVideoSource, and vtkWin32VideoSource.

virtual void vtkVideoSource::Stop ( )
virtual

Stop recording or playing.

Reimplemented in vtkFFMPEGVideoSource, vtkMILVideoSource, and vtkWin32VideoSource.

virtual void vtkVideoSource::Rewind ( )
virtual

Rewind to the frame with the earliest timestamp.

Record operations will start on the following frame, therefore if you want to re-record over this frame you must call Seek(-1) before calling Grab() or Record().

virtual void vtkVideoSource::FastForward ( )
virtual

FastForward to the last frame that was recorded (i.e.

to the frame that has the most recent timestamp).

virtual void vtkVideoSource::Seek ( int  n)
virtual

Seek forwards or backwards by the specified number of frames (positive is forward, negative is backward).

virtual void vtkVideoSource::Grab ( )
virtual

Grab a single video frame.

Reimplemented in vtkFFMPEGVideoSource, vtkMILVideoSource, and vtkWin32VideoSource.

virtual int vtkVideoSource::GetRecording ( )
virtual

Are we in record mode? (record mode and play mode are mutually exclusive).

virtual int vtkVideoSource::GetPlaying ( )
virtual

Are we in play mode? (record mode and play mode are mutually exclusive).

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

Set the full-frame size.

This must be an allowed size for the device, the device may either refuse a request for an illegal frame size or automatically choose a new frame size. The default is usually 320x240x1, but can be device specific. The 'depth' should always be 1 (unless you have a device that can handle 3D acquisition).

Reimplemented in vtkFFMPEGVideoSource, vtkMILVideoSource, and vtkWin32VideoSource.

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

Set the full-frame size.

This must be an allowed size for the device, the device may either refuse a request for an illegal frame size or automatically choose a new frame size. The default is usually 320x240x1, but can be device specific. The 'depth' should always be 1 (unless you have a device that can handle 3D acquisition).

Reimplemented in vtkFFMPEGVideoSource, and vtkWin32VideoSource.

Definition at line 117 of file vtkVideoSource.h.

virtual int* vtkVideoSource::GetFrameSize ( )
virtual

Set the full-frame size.

This must be an allowed size for the device, the device may either refuse a request for an illegal frame size or automatically choose a new frame size. The default is usually 320x240x1, but can be device specific. The 'depth' should always be 1 (unless you have a device that can handle 3D acquisition).

virtual void vtkVideoSource::GetFrameSize ( int ,
int ,
int  
)
virtual

Set the full-frame size.

This must be an allowed size for the device, the device may either refuse a request for an illegal frame size or automatically choose a new frame size. The default is usually 320x240x1, but can be device specific. The 'depth' should always be 1 (unless you have a device that can handle 3D acquisition).

virtual void vtkVideoSource::GetFrameSize ( int  [3])
virtual

Set the full-frame size.

This must be an allowed size for the device, the device may either refuse a request for an illegal frame size or automatically choose a new frame size. The default is usually 320x240x1, but can be device specific. The 'depth' should always be 1 (unless you have a device that can handle 3D acquisition).

virtual void vtkVideoSource::SetFrameRate ( float  rate)
virtual

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

Reimplemented in vtkFFMPEGVideoSource, and vtkWin32VideoSource.

virtual float vtkVideoSource::GetFrameRate ( )
virtual

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

virtual void vtkVideoSource::SetOutputFormat ( int  format)
virtual

Set the output format.

This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.

Reimplemented in vtkFFMPEGVideoSource, vtkMILVideoSource, and vtkWin32VideoSource.

void vtkVideoSource::SetOutputFormatToLuminance ( )
inline

Set the output format.

This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.

Definition at line 136 of file vtkVideoSource.h.

void vtkVideoSource::SetOutputFormatToRGB ( )
inline

Set the output format.

This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.

Definition at line 137 of file vtkVideoSource.h.

void vtkVideoSource::SetOutputFormatToRGBA ( )
inline

Set the output format.

This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.

Definition at line 138 of file vtkVideoSource.h.

virtual int vtkVideoSource::GetOutputFormat ( )
virtual

Set the output format.

This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.

virtual void vtkVideoSource::SetFrameBufferSize ( int  FrameBufferSize)
virtual

Set size of the frame buffer, i.e.

the number of frames that the 'tape' can store.

virtual int vtkVideoSource::GetFrameBufferSize ( )
virtual

Set size of the frame buffer, i.e.

the number of frames that the 'tape' can store.

virtual void vtkVideoSource::SetNumberOfOutputFrames ( int  )
virtual

Set the number of frames to copy to the output on each execute.

The frames will be concatenated along the Z dimension, with the most recent frame first. Default: 1

virtual int vtkVideoSource::GetNumberOfOutputFrames ( )
virtual

Set the number of frames to copy to the output on each execute.

The frames will be concatenated along the Z dimension, with the most recent frame first. Default: 1

virtual void vtkVideoSource::AutoAdvanceOn ( )
virtual

Set whether to automatically advance the buffer before each grab.

Default: on

virtual void vtkVideoSource::AutoAdvanceOff ( )
virtual

Set whether to automatically advance the buffer before each grab.

Default: on

virtual void vtkVideoSource::SetAutoAdvance ( vtkTypeBool  )
virtual

Set whether to automatically advance the buffer before each grab.

Default: on

virtual vtkTypeBool vtkVideoSource::GetAutoAdvance ( )
virtual

Set whether to automatically advance the buffer before each grab.

Default: on

virtual void vtkVideoSource::SetClipRegion ( int  r[6])
inlinevirtual

Set the clip rectangle for the frames.

The video will be clipped before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).

Definition at line 179 of file vtkVideoSource.h.

virtual void vtkVideoSource::SetClipRegion ( int  x0,
int  x1,
int  y0,
int  y1,
int  z0,
int  z1 
)
virtual

Set the clip rectangle for the frames.

The video will be clipped before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).

virtual int* vtkVideoSource::GetClipRegion ( )
virtual

Set the clip rectangle for the frames.

The video will be clipped before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).

virtual void vtkVideoSource::GetClipRegion ( int ,
int ,
int ,
int ,
int ,
int  
)
virtual

Set the clip rectangle for the frames.

The video will be clipped before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).

virtual void vtkVideoSource::GetClipRegion ( int  [6])
virtual

Set the clip rectangle for the frames.

The video will be clipped before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).

virtual void vtkVideoSource::SetOutputWholeExtent ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
)
virtual

Get/Set the WholeExtent of the output.

This can be used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be copied to the output.

virtual void vtkVideoSource::SetOutputWholeExtent ( int  [6])
virtual

Get/Set the WholeExtent of the output.

This can be used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be copied to the output.

virtual int* vtkVideoSource::GetOutputWholeExtent ( )
virtual

Get/Set the WholeExtent of the output.

This can be used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be copied to the output.

virtual void vtkVideoSource::GetOutputWholeExtent ( int ,
int ,
int ,
int ,
int ,
int  
)
virtual

Get/Set the WholeExtent of the output.

This can be used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be copied to the output.

virtual void vtkVideoSource::GetOutputWholeExtent ( int  [6])
virtual

Get/Set the WholeExtent of the output.

This can be used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be copied to the output.

virtual void vtkVideoSource::SetDataSpacing ( double  ,
double  ,
double   
)
virtual

Set/Get the pixel spacing.

Default: (1.0,1.0,1.0)

virtual void vtkVideoSource::SetDataSpacing ( double  [3])
virtual

Set/Get the pixel spacing.

Default: (1.0,1.0,1.0)

virtual double* vtkVideoSource::GetDataSpacing ( )
virtual

Set/Get the pixel spacing.

Default: (1.0,1.0,1.0)

virtual void vtkVideoSource::GetDataSpacing ( double ,
double ,
double  
)
virtual

Set/Get the pixel spacing.

Default: (1.0,1.0,1.0)

virtual void vtkVideoSource::GetDataSpacing ( double  [3])
virtual

Set/Get the pixel spacing.

Default: (1.0,1.0,1.0)

virtual void vtkVideoSource::SetDataOrigin ( double  ,
double  ,
double   
)
virtual

Set/Get the coordinates of the lower, left corner of the frame.

Default: (0.0,0.0,0.0)

virtual void vtkVideoSource::SetDataOrigin ( double  [3])
virtual

Set/Get the coordinates of the lower, left corner of the frame.

Default: (0.0,0.0,0.0)

virtual double* vtkVideoSource::GetDataOrigin ( )
virtual

Set/Get the coordinates of the lower, left corner of the frame.

Default: (0.0,0.0,0.0)

virtual void vtkVideoSource::GetDataOrigin ( double ,
double ,
double  
)
virtual

Set/Get the coordinates of the lower, left corner of the frame.

Default: (0.0,0.0,0.0)

virtual void vtkVideoSource::GetDataOrigin ( double  [3])
virtual

Set/Get the coordinates of the lower, left corner of the frame.

Default: (0.0,0.0,0.0)

virtual void vtkVideoSource::SetOpacity ( float  )
virtual

For RGBA output only (4 scalar components), set the opacity.

This will not modify the existing contents of the framebuffer, only subsequently grabbed frames.

virtual float vtkVideoSource::GetOpacity ( )
virtual

For RGBA output only (4 scalar components), set the opacity.

This will not modify the existing contents of the framebuffer, only subsequently grabbed frames.

virtual int vtkVideoSource::GetFrameCount ( )
virtual

This value is incremented each time a frame is grabbed.

reset it to zero (or any other value) at any time.

virtual void vtkVideoSource::SetFrameCount ( int  )
virtual

This value is incremented each time a frame is grabbed.

reset it to zero (or any other value) at any time.

virtual int vtkVideoSource::GetFrameIndex ( )
virtual

Get the frame index relative to the 'beginning of the tape'.

This value wraps back to zero if it increases past the FrameBufferSize.

virtual double vtkVideoSource::GetFrameTimeStamp ( int  frame)
virtual

Get a time stamp in seconds (resolution of milliseconds) for a video frame.

Time began on Jan 1, 1970. You can specify a number (negative or positive) to specify the position of the video frame relative to the current frame.

double vtkVideoSource::GetFrameTimeStamp ( )
inline

Get a time stamp in seconds (resolution of milliseconds) for the Output.

Time began on Jan 1, 1970. This timestamp is only valid after the Output has been Updated.

Definition at line 257 of file vtkVideoSource.h.

virtual void vtkVideoSource::Initialize ( )
virtual

Initialize the hardware.

This is called automatically on the first Update or Grab.

Reimplemented in vtkMILVideoSource, vtkFFMPEGVideoSource, and vtkWin32VideoSource.

virtual int vtkVideoSource::GetInitialized ( )
inlinevirtual

Initialize the hardware.

This is called automatically on the first Update or Grab.

Definition at line 265 of file vtkVideoSource.h.

virtual void vtkVideoSource::ReleaseSystemResources ( )
virtual

Release the video driver.

This method must be called before application exit, or else the application might hang during exit.

Reimplemented in vtkMILVideoSource, vtkFFMPEGVideoSource, and vtkWin32VideoSource.

virtual void vtkVideoSource::InternalGrab ( )
virtual

The internal function which actually does the grab.

You will definitely want to override this if you develop a vtkVideoSource subclass.

Reimplemented in vtkMILVideoSource, and vtkFFMPEGVideoSource.

void vtkVideoSource::SetStartTimeStamp ( double  t)
inline

And internal variable which marks the beginning of a Record session.

These methods are for internal use only.

Definition at line 287 of file vtkVideoSource.h.

double vtkVideoSource::GetStartTimeStamp ( )
inline

And internal variable which marks the beginning of a Record session.

These methods are for internal use only.

Definition at line 288 of file vtkVideoSource.h.

int vtkVideoSource::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

virtual void vtkVideoSource::UpdateFrameBuffer ( )
protectedvirtual

These methods can be overridden in subclasses.

virtual void vtkVideoSource::AdvanceFrameBuffer ( int  n)
protectedvirtual

These methods can be overridden in subclasses.

int vtkVideoSource::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

These methods can be overridden in subclasses.

Reimplemented from vtkImageAlgorithm.

virtual void vtkVideoSource::UnpackRasterLine ( char *  outPtr,
char *  rowPtr,
int  start,
int  count 
)
protectedvirtual

These methods can be overridden in subclasses.

Reimplemented in vtkWin32VideoSource.

Member Data Documentation

int vtkVideoSource::Initialized
protected

Definition at line 296 of file vtkVideoSource.h.

int vtkVideoSource::FrameSize[3]
protected

Definition at line 298 of file vtkVideoSource.h.

int vtkVideoSource::ClipRegion[6]
protected

Definition at line 299 of file vtkVideoSource.h.

int vtkVideoSource::OutputWholeExtent[6]
protected

Definition at line 300 of file vtkVideoSource.h.

double vtkVideoSource::DataSpacing[3]
protected

Definition at line 301 of file vtkVideoSource.h.

double vtkVideoSource::DataOrigin[3]
protected

Definition at line 302 of file vtkVideoSource.h.

int vtkVideoSource::OutputFormat
protected

Definition at line 303 of file vtkVideoSource.h.

int vtkVideoSource::NumberOfScalarComponents
protected

Definition at line 305 of file vtkVideoSource.h.

int vtkVideoSource::FrameOutputExtent[6]
protected

Definition at line 308 of file vtkVideoSource.h.

int vtkVideoSource::LastNumberOfScalarComponents
protected

Definition at line 312 of file vtkVideoSource.h.

int vtkVideoSource::LastOutputExtent[6]
protected

Definition at line 313 of file vtkVideoSource.h.

int vtkVideoSource::Recording
protected

Definition at line 315 of file vtkVideoSource.h.

int vtkVideoSource::Playing
protected

Definition at line 316 of file vtkVideoSource.h.

float vtkVideoSource::FrameRate
protected

Definition at line 317 of file vtkVideoSource.h.

int vtkVideoSource::FrameCount
protected

Definition at line 318 of file vtkVideoSource.h.

double vtkVideoSource::StartTimeStamp
protected

Definition at line 320 of file vtkVideoSource.h.

double vtkVideoSource::FrameTimeStamp
protected

Definition at line 321 of file vtkVideoSource.h.

vtkTypeBool vtkVideoSource::AutoAdvance
protected

Definition at line 323 of file vtkVideoSource.h.

int vtkVideoSource::NumberOfOutputFrames
protected

Definition at line 324 of file vtkVideoSource.h.

float vtkVideoSource::Opacity
protected

Definition at line 326 of file vtkVideoSource.h.

int vtkVideoSource::FlipFrames
protected

Definition at line 329 of file vtkVideoSource.h.

int vtkVideoSource::OutputNeedsInitialization
protected

Definition at line 332 of file vtkVideoSource.h.

vtkMultiThreader* vtkVideoSource::PlayerThreader
protected

Definition at line 335 of file vtkVideoSource.h.

int vtkVideoSource::PlayerThreadId
protected

Definition at line 336 of file vtkVideoSource.h.

vtkCriticalSection* vtkVideoSource::FrameBufferMutex
protected

Definition at line 340 of file vtkVideoSource.h.

int vtkVideoSource::FrameBufferBitsPerPixel
protected

Definition at line 344 of file vtkVideoSource.h.

int vtkVideoSource::FrameBufferRowAlignment
protected

Definition at line 346 of file vtkVideoSource.h.

int vtkVideoSource::FrameBufferExtent[6]
protected

Definition at line 349 of file vtkVideoSource.h.

int vtkVideoSource::FrameBufferSize
protected

Definition at line 351 of file vtkVideoSource.h.

int vtkVideoSource::FrameBufferIndex
protected

Definition at line 355 of file vtkVideoSource.h.

int vtkVideoSource::FrameIndex
protected

Definition at line 359 of file vtkVideoSource.h.

void** vtkVideoSource::FrameBuffer
protected

Definition at line 362 of file vtkVideoSource.h.

double* vtkVideoSource::FrameBufferTimeStamps
protected

Definition at line 363 of file vtkVideoSource.h.


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