Superclass of video input devices for VTK. More...
#include <vtkVideoSource.h>
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 42 of file vtkVideoSource.h.
Member Typedef Documentation
Reimplemented from vtkImageAlgorithm.
Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.
Definition at line 46 of file vtkVideoSource.h.
Constructor & Destructor Documentation
| vtkVideoSource::vtkVideoSource | ( | ) | [protected] |
| vtkVideoSource::~vtkVideoSource | ( | ) | [protected] |
Member Function Documentation
| static vtkVideoSource* vtkVideoSource::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.
| static int vtkVideoSource::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 vtkImageAlgorithm.
Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.
| virtual int 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 vtkMILVideoSource, and vtkWin32VideoSource.
| static vtkVideoSource* vtkVideoSource::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkImageAlgorithm.
Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.
| virtual vtkObjectBase* vtkVideoSource::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkImageAlgorithm.
Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.
| vtkVideoSource* vtkVideoSource::NewInstance | ( | ) | const |
Reimplemented from vtkImageAlgorithm.
Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.
| void vtkVideoSource::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.
Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.
| virtual void vtkVideoSource::Record | ( | ) | [virtual] |
Record incoming video at the specified FrameRate. The recording continues indefinitely until Stop() is called.
Reimplemented in 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 vtkMILVideoSource, and vtkWin32VideoSource.
| virtual void vtkVideoSource::Stop | ( | ) | [virtual] |
Stop recording or playing.
Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.
| virtual void vtkVideoSource::Rewind | ( | ) | [virtual] |
| 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 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 vtkMILVideoSource, and vtkWin32VideoSource.
| virtual void vtkVideoSource::SetFrameSize | ( | int | dim[3] | ) | [inline, 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 vtkWin32VideoSource.
Definition at line 96 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 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 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 111 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 112 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 113 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 | ( | int | ) | [virtual] |
Set whether to automatically advance the buffer before each grab. Default: on
| virtual int vtkVideoSource::GetAutoAdvance | ( | ) | [virtual] |
Set whether to automatically advance the buffer before each grab. Default: on
| virtual void vtkVideoSource::SetClipRegion | ( | int | r[6] | ) | [inline, 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).
Definition at line 145 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).
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 206 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, and vtkWin32VideoSource.
| virtual int vtkVideoSource::GetInitialized | ( | ) | [inline, virtual] |
Initialize the hardware. This is called automatically on the first Update or Grab.
Definition at line 212 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, 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.
| 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 227 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 228 of file vtkVideoSource.h.
| virtual int vtkVideoSource::RequestInformation | ( | vtkInformation * | request, |
| vtkInformationVector ** | inputVector, | ||
| vtkInformationVector * | outputVector | ||
| ) | [protected, virtual] |
Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.
Reimplemented from vtkImageAlgorithm.
| virtual void vtkVideoSource::UpdateFrameBuffer | ( | ) | [protected, virtual] |
These methods can be overridden in subclasses
| virtual void vtkVideoSource::AdvanceFrameBuffer | ( | int | n | ) | [protected, virtual] |
These methods can be overridden in subclasses
| virtual int vtkVideoSource::RequestData | ( | vtkInformation * | , |
| vtkInformationVector ** | , | ||
| vtkInformationVector * | |||
| ) | [protected, virtual] |
These methods can be overridden in subclasses
Reimplemented from vtkImageAlgorithm.
| virtual void vtkVideoSource::UnpackRasterLine | ( | char * | outPtr, |
| char * | rowPtr, | ||
| int | start, | ||
| int | count | ||
| ) | [protected, virtual] |
These methods can be overridden in subclasses
Reimplemented in vtkWin32VideoSource.
Member Data Documentation
int vtkVideoSource::Initialized [protected] |
Definition at line 236 of file vtkVideoSource.h.
int vtkVideoSource::FrameSize[3] [protected] |
Definition at line 238 of file vtkVideoSource.h.
int vtkVideoSource::ClipRegion[6] [protected] |
Definition at line 239 of file vtkVideoSource.h.
int vtkVideoSource::OutputWholeExtent[6] [protected] |
Definition at line 240 of file vtkVideoSource.h.
double vtkVideoSource::DataSpacing[3] [protected] |
Definition at line 241 of file vtkVideoSource.h.
double vtkVideoSource::DataOrigin[3] [protected] |
Definition at line 242 of file vtkVideoSource.h.
int vtkVideoSource::OutputFormat [protected] |
Definition at line 243 of file vtkVideoSource.h.
int vtkVideoSource::NumberOfScalarComponents [protected] |
Definition at line 245 of file vtkVideoSource.h.
int vtkVideoSource::FrameOutputExtent[6] [protected] |
Definition at line 248 of file vtkVideoSource.h.
int vtkVideoSource::LastNumberOfScalarComponents [protected] |
Definition at line 252 of file vtkVideoSource.h.
int vtkVideoSource::LastOutputExtent[6] [protected] |
Definition at line 253 of file vtkVideoSource.h.
int vtkVideoSource::Recording [protected] |
Definition at line 255 of file vtkVideoSource.h.
int vtkVideoSource::Playing [protected] |
Definition at line 256 of file vtkVideoSource.h.
float vtkVideoSource::FrameRate [protected] |
Definition at line 257 of file vtkVideoSource.h.
int vtkVideoSource::FrameCount [protected] |
Definition at line 258 of file vtkVideoSource.h.
int vtkVideoSource::FrameIndex [protected] |
Definition at line 259 of file vtkVideoSource.h.
double vtkVideoSource::StartTimeStamp [protected] |
Definition at line 260 of file vtkVideoSource.h.
double vtkVideoSource::FrameTimeStamp [protected] |
Definition at line 261 of file vtkVideoSource.h.
int vtkVideoSource::AutoAdvance [protected] |
Definition at line 263 of file vtkVideoSource.h.
int vtkVideoSource::NumberOfOutputFrames [protected] |
Definition at line 264 of file vtkVideoSource.h.
float vtkVideoSource::Opacity [protected] |
Definition at line 266 of file vtkVideoSource.h.
int vtkVideoSource::FlipFrames [protected] |
Definition at line 269 of file vtkVideoSource.h.
int vtkVideoSource::OutputNeedsInitialization [protected] |
Definition at line 272 of file vtkVideoSource.h.
vtkMultiThreader* vtkVideoSource::PlayerThreader [protected] |
Definition at line 275 of file vtkVideoSource.h.
int vtkVideoSource::PlayerThreadId [protected] |
Definition at line 276 of file vtkVideoSource.h.
vtkCriticalSection* vtkVideoSource::FrameBufferMutex [protected] |
Definition at line 280 of file vtkVideoSource.h.
int vtkVideoSource::FrameBufferBitsPerPixel [protected] |
Definition at line 284 of file vtkVideoSource.h.
int vtkVideoSource::FrameBufferRowAlignment [protected] |
Definition at line 286 of file vtkVideoSource.h.
int vtkVideoSource::FrameBufferExtent[6] [protected] |
Definition at line 289 of file vtkVideoSource.h.
int vtkVideoSource::FrameBufferSize [protected] |
Definition at line 291 of file vtkVideoSource.h.
int vtkVideoSource::FrameBufferIndex [protected] |
Definition at line 292 of file vtkVideoSource.h.
void** vtkVideoSource::FrameBuffer [protected] |
Definition at line 293 of file vtkVideoSource.h.
double* vtkVideoSource::FrameBufferTimeStamps [protected] |
Definition at line 294 of file vtkVideoSource.h.
The documentation for this class was generated from the following file:
- dox/IO/Video/vtkVideoSource.h
