PlusLib  2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
vtkPlusMmfVideoSource Class Reference
DataCollection

Microsoft media foundation video digitizer. More...

#include <src/PlusDataCollection/MicrosoftMediaFoundation/vtkPlusMmfVideoSource.h>

Inheritance diagram for vtkPlusMmfVideoSource:
Inheritance graph
[legend]
Collaboration diagram for vtkPlusMmfVideoSource:
Collaboration graph
[legend]

Public Types

typedef vtkPlusDevice Superclass
 
- Public Types inherited from vtkPlusDevice
typedef vtkImageAlgorithm Superclass
 

Public Member Functions

std::wstring GetActiveDeviceName ()
 
virtual const char * GetClassName ()
 
void GetListOfCaptureDevices (std::vector< std::wstring > &deviceNames)
 
void GetListOfCaptureVideoFormats (std::vector< std::wstring > &videoModes, unsigned int deviceId)
 
std::wstring GetRequestedDeviceName ()
 
virtual int IsA (const char *type)
 
virtual bool IsTracker () const
 
void LogListOfCaptureDevices ()
 
void LogListOfCaptureVideoFormats (unsigned int deviceId)
 
virtual PlusStatus NotifyConfigured ()
 
virtual void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
virtual PlusStatus ReadConfiguration (vtkXMLDataElement *xmlElement)
 
virtual void SetRequestedDeviceId (unsigned int deviceId)
 
virtual void SetRequestedFrameSize (const FrameSizeType &frameSize)
 
virtual void SetRequestedStreamIndex (unsigned int streamIndex)
 
virtual void SetRequestedVideoFormat (const std::wstring &pixelFormatName)
 
virtual PlusStatus WriteConfiguration (vtkXMLDataElement *xmlElement)
 
- Public Member Functions inherited from vtkPlusDevice
PlusStatus AddFieldDataSource (vtkPlusDataSource *aSource)
 
PlusStatus AddInputChannel (vtkPlusChannel *aChannel)
 
PlusStatus AddOutputChannel (vtkPlusChannel *aChannel)
 
PlusStatus AddTool (vtkPlusDataSource *tool, bool requireUniquePortName=true)
 
PlusStatus AddVideoSource (vtkPlusDataSource *anImage)
 
void ClearAllBuffers ()
 
virtual PlusStatus Connect ()
 
virtual PlusStatus CreateDefaultOutputChannel (const char *channelId=NULL, bool addSource=true)
 
void DeepCopy (const vtkPlusDevice &device)
 
virtual PlusStatus Disconnect ()
 
virtual PlusStatus ForceUpdate ()
 
virtual double GetAcquisitionRate () const
 
virtual PlusStatus GetBufferSize (vtkPlusChannel &aChannel, int &outVal, const std::string &aSourceId=std::string(""))
 
virtual int GetConnected () const
 
virtual bool GetCorrectlyConfigured () const
 
PlusStatus GetDataSource (const char *aSourceId, vtkPlusDataSource *&aSource)
 
PlusStatus GetDataSource (const std::string &aSourceId, vtkPlusDataSource *&aSource)
 
virtual double GetDesiredTimestamp ()
 
virtual std::string GetDeviceId () const
 
PlusStatus GetFieldDataSource (const char *aSourceId, vtkPlusDataSource *&aSource) const
 
PlusStatus GetFieldDataSource (const std::string &aSourceId, vtkPlusDataSource *&aSource) const
 
DataSourceContainerConstIterator GetFieldDataSourcessIteratorBegin () const
 
DataSourceContainerConstIterator GetFieldDataSourcessIteratorEnd () const
 
PlusStatus GetFirstActiveOutputVideoSource (vtkPlusDataSource *&aVideoSource)
 
PlusStatus GetFirstActiveTool (vtkPlusDataSource *&aTool) const
 
PlusStatus GetFirstOutputChannel (vtkPlusChannel *&aChannel)
 
PlusStatus GetFirstVideoSource (vtkPlusDataSource *&anImage)
 
virtual unsigned long GetFrameNumber () const
 
virtual double GetFrameTimeStamp () const
 
virtual PlusStatus GetImage (const std::string &requestedImageId, std::string &assignedImageId, const std::string &imageReferencFrameName, vtkImageData *imageData, vtkMatrix4x4 *ijkToReferenceTransform)
 
virtual PlusStatus GetImageMetaData (igsioCommon::ImageMetaDataList &imageMetaDataItems)
 
virtual US_IMAGE_TYPE GetImageType (vtkPlusChannel &aChannel)
 
PlusStatus GetInputDevices (std::vector< vtkPlusDevice * > &outDeviceList) const
 
PlusStatus GetInputDevicesRecursive (std::vector< vtkPlusDevice * > &outDeviceList) const
 
virtual PlusStatus GetInputFrameSize (vtkPlusChannel &aChannel, unsigned int &x, unsigned int &y, unsigned int &z) const
 
virtual PlusStatus GetInputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const
 
double GetInternalUpdateRate () const
 
virtual double GetLocalTimeOffsetSec () const
 
double GetMissingInputGracePeriodSec () const
 
virtual int GetNumberOfFieldDataSources () const
 
virtual int GetNumberOfTools () const
 
virtual int GetNumberOfVideoSources () const
 
PlusStatus GetOutputChannelByName (vtkPlusChannel *&aChannel, const char *aChannelId)
 
PlusStatus GetOutputChannelByName (vtkPlusChannel *&aChannel, const std::string &aChannelId)
 
ChannelContainerConstIterator GetOutputChannelsEnd () const
 
ChannelContainerIterator GetOutputChannelsEnd ()
 
ChannelContainerConstIterator GetOutputChannelsStart () const
 
ChannelContainerIterator GetOutputChannelsStart ()
 
virtual PlusStatus GetOutputFrameSize (vtkPlusChannel &aChannel, unsigned int &x, unsigned int &y, unsigned int &z) const
 
virtual PlusStatus GetOutputFrameSize (vtkPlusChannel &aChannel, FrameSizeType &dim) const
 
virtual std::string GetParameter (const std::string &key) const
 
virtual PlusStatus GetParameter (const std::string &key, std::string &outValue) const
 
virtual igsioCommon::VTKScalarPixelType GetPixelType (vtkPlusChannel &aChannel)
 
virtual std::string GetSdkVersion ()
 
virtual double GetStartTime ()
 
virtual double GetTimestampClosestToDesired ()
 
PlusStatus GetTool (const char *aToolSourceId, vtkPlusDataSource *&aTool) const
 
PlusStatus GetTool (const std::string &aToolSourceId, vtkPlusDataSource *&aTool) const
 
PlusStatus GetToolByPortName (const char *aPortName, vtkPlusDataSource *&aSource)
 
PlusStatus GetToolByPortName (const std::string &aPortName, vtkPlusDataSource *&aSource)
 
DataSourceContainerConstIterator GetToolIteratorBegin () const
 
DataSourceContainerConstIterator GetToolIteratorEnd () const
 
std::string GetToolReferenceFrameName () const
 
virtual int GetUpdateWithDesiredTimestamp ()
 
PlusStatus GetVideoSource (const char *aSourceId, vtkPlusDataSource *&aVideoSource)
 
PlusStatus GetVideoSourceByIndex (const unsigned int index, vtkPlusDataSource *&aVideoSource)
 
DataSourceContainerConstIterator GetVideoSourceIteratorBegin () const
 
DataSourceContainerConstIterator GetVideoSourceIteratorEnd () const
 
std::vector< vtkPlusDataSource * > GetVideoSources () const
 
PlusStatus GetVideoSourcesByPortName (const char *aPortName, std::vector< vtkPlusDataSource * > &sources)
 
PlusStatus GetVideoSourcesByPortName (const std::string &aPortName, std::vector< vtkPlusDataSource * > &sources)
 
virtual PlusStatus InternalUpdate ()
 
virtual bool IsConnected () const
 
virtual bool IsRecording () const
 
virtual bool IsResettable ()
 
virtual bool IsVirtual () const
 
virtual int OutputChannelCount () const
 
virtual PlusStatus Probe ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual PlusStatus Reset ()
 
virtual PlusStatus SendText (const std::string &textToSend, std::string *textReceived=NULL)
 
PlusStatus SetAcquisitionRate (double aRate)
 
virtual PlusStatus SetBufferSize (vtkPlusChannel &aChannel, int FrameBufferSize, const std::string &aSourceId=std::string(""))
 
virtual void SetDataCollector (vtkPlusDataCollector *_arg)
 
virtual void SetDesiredTimestamp (double)
 
void SetDeviceId (const std::string &id)
 
void SetFieldDataSourcesBufferSize (int aBufferSize)
 
virtual PlusStatus SetImageType (vtkPlusChannel &aChannel, US_IMAGE_TYPE imageType)
 
virtual PlusStatus SetInputFrameSize (vtkPlusDataSource &aSource, unsigned int x, unsigned int y, unsigned int z)
 
virtual void SetLocalTimeOffsetSec (double aTimeOffsetSec)
 
virtual void SetMissingInputGracePeriodSec (double)
 
virtual PlusStatus SetParameter (const std::string &key, const std::string &value)
 
virtual PlusStatus SetPixelType (vtkPlusChannel &aChannel, igsioCommon::VTKScalarPixelType pixelType)
 
virtual void SetStartTime (double startTime)
 
void SetToolReferenceFrameName (const std::string &frameName)
 
void SetToolsBufferSize (int aBufferSize)
 
virtual void SetUpdateWithDesiredTimestamp (int)
 
virtual PlusStatus StartRecording ()
 
virtual PlusStatus StopRecording ()
 
virtual void UpdateWithDesiredTimestampOff ()
 
virtual void UpdateWithDesiredTimestampOn ()
 
virtual PlusStatus WriteToolsToSequenceFile (const std::string &filename, bool useCompression=false)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPlusMmfVideoSource * New ()
 
static vtkPlusMmfVideoSource * SafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPlusDevice
static PlusStatus GetToolReferenceFrameFromTrackedFrame (igsioTrackedFrame &aFrame, std::string &aToolReferenceFrameName)
 
static int IsTypeOf (const char *type)
 
static vtkPlusDevice * New ()
 
static vtkPlusDevice * SafeDownCast (vtkObject *o)
 

Protected Member Functions

PlusStatus AddFrame (unsigned char *bufferData, DWORD bufferSize)
 
std::wstring GetCaptureDeviceName (unsigned int deviceId)
 
virtual PlusStatus InternalConnect ()
 
virtual PlusStatus InternalDisconnect ()
 
virtual PlusStatus InternalStartRecording ()
 
virtual PlusStatus InternalStopRecording ()
 
PlusStatus UpdateFrameSize ()
 
 vtkPlusMmfVideoSource ()
 
 ~vtkPlusMmfVideoSource ()
 
- Protected Member Functions inherited from vtkPlusDevice
virtual PlusStatus AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, const igsioVideoFrame &frame, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)
 
virtual PlusStatus AddVideoItemToVideoSources (const std::vector< vtkPlusDataSource * > &videoSources, void *imageDataPtr, US_IMAGE_ORIENTATION usImageOrientation, const FrameSizeType &frameSizeInPx, igsioCommon::VTKScalarPixelType pixelType, unsigned int numberOfScalarComponents, US_IMAGE_TYPE imageType, int numberOfBytesToSkip, long frameNumber, double unfilteredTimestamp=UNDEFINED_TIMESTAMP, double filteredTimestamp=UNDEFINED_TIMESTAMP, const igsioFieldMapType *customFields=NULL)
 
PlusStatus EnsureUniqueDataSourceId (const std::string &aSourceId)
 
vtkXMLDataElement * FindInputChannelElement (vtkXMLDataElement *rootXMLElement, const char *aChannelId)
 
vtkXMLDataElement * FindOutputChannelElement (vtkXMLDataElement *rootXMLElement, const char *aChannelId)
 
vtkXMLDataElement * FindThisDeviceElement (vtkXMLDataElement *rootXMLElement)
 
virtual vtkPlusDataCollector * GetDataCollector ()
 
double GetRecordingStartTime () const
 
bool GetStartThreadForInternalUpdates () const
 
bool HasGracePeriodExpired ()
 
virtual void InternalWriteInputChannels (vtkXMLDataElement *rootXMLElement)
 
virtual void InternalWriteOutputChannels (vtkXMLDataElement *rootXMLElement)
 
virtual void SetCorrectlyConfigured (bool)
 
virtual void SetRecordingStartTime (double)
 
virtual void SetStartThreadForInternalUpdates (bool)
 
virtual PlusStatus ToolTimeStampedUpdate (const std::string &aToolSourceId, vtkMatrix4x4 *matrix, ToolStatus status, unsigned long frameNumber, double unfilteredtimestamp, const igsioFieldMapType *customFields=NULL)
 
virtual PlusStatus ToolTimeStampedUpdateWithoutFiltering (const std::string &aToolSourceId, vtkMatrix4x4 *matrix, ToolStatus status, double unfilteredtimestamp, double filteredtimestamp, const igsioFieldMapType *customFields=NULL)
 
 vtkPlusDevice ()
 
virtual ~vtkPlusDevice ()
 

Protected Attributes

VideoFormat ActiveVideoFormat
 
int FrameIndex
 
MmfVideoSourceReader * MmfSourceReader
 
vtkSmartPointer< vtkIGSIORecursiveCriticalSection > Mutex
 
VideoFormat RequestedVideoFormat
 
igsioVideoFrame UncompressedVideoFrame
 
- Protected Attributes inherited from vtkPlusDevice
double AcquisitionRate
 
int Connected
 
bool CorrectlyConfigured
 
StreamBufferItem * CurrentStreamBufferItem
 
vtkPlusDataCollector * DataCollector
 
double DesiredTimestamp
 
std::string DeviceId
 
DataSourceContainer Fields
 
unsigned long FrameNumber
 
double FrameTimeStamp
 
ChannelContainer InputChannels
 
double LocalTimeOffsetSec
 
double MissingInputGracePeriodSec
 
ChannelContainer OutputChannels
 
int OutputNeedsInitialization
 
std::map< std::string, std::string > Parameters
 
int Recording
 
double RecordingStartTime
 
std::set< std::string > ReportedUnknownTools
 
bool RequireImageOrientationInConfiguration
 
bool RequirePortNameInDeviceSetConfiguration
 
bool StartThreadForInternalUpdates
 
bool ThreadAlive
 
vtkMultiThreader * Threader
 
int ThreadId
 
double TimestampClosestToDesired
 
std::string ToolReferenceFrameName
 
DataSourceContainer Tools
 
int UpdateWithDesiredTimestamp
 
DataSourceContainer VideoSources
 

Friends

class MmfVideoSourceReader
 

Additional Inherited Members

- Public Attributes inherited from vtkPlusDevice
double InternalUpdateRate
 
vtkIGSIORecursiveCriticalSection * UpdateMutex
 
vtkTimeStamp UpdateTime
 
- Static Public Attributes inherited from vtkPlusDevice
static const std::string BMODE_PORT_NAME = "B"
 
static const std::string PARAMETER_XML_ELEMENT_TAG = "Parameter"
 
static const std::string PARAMETERS_XML_ELEMENT_TAG = "Parameters"
 
static const std::string RFMODE_PORT_NAME = "Rf"
 
- Static Protected Member Functions inherited from vtkPlusDevice
static void * vtkDataCaptureThread (vtkMultiThreader::ThreadInfo *data)
 
- Static Protected Attributes inherited from vtkPlusDevice
static const int VIRTUAL_DEVICE_FRAME_RATE = 50
 

Detailed Description

Microsoft media foundation video digitizer.

Media foundation require Microsoft Windows SDK 7.1 or later. Download here

See also
vtkPlusDevice

Definition at line 38 of file vtkPlusMmfVideoSource.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPlusDevice vtkPlusMmfVideoSource::Superclass

Definition at line 52 of file vtkPlusMmfVideoSource.h.

Constructor & Destructor Documentation

◆ vtkPlusMmfVideoSource()

vtkPlusMmfVideoSource::vtkPlusMmfVideoSource ( )
protected

Constructor

Definition at line 246 of file vtkPlusMmfVideoSource.cxx.

◆ ~vtkPlusMmfVideoSource()

vtkPlusMmfVideoSource::~vtkPlusMmfVideoSource ( )
protected

Destructor

Definition at line 269 of file vtkPlusMmfVideoSource.cxx.

Member Function Documentation

◆ AddFrame()

PlusStatus vtkPlusMmfVideoSource::AddFrame ( unsigned char *  bufferData,
DWORD  bufferSize 
)
protected

Definition at line 603 of file vtkPlusMmfVideoSource.cxx.

◆ GetActiveDeviceName()

std::wstring vtkPlusMmfVideoSource::GetActiveDeviceName ( )

Definition at line 597 of file vtkPlusMmfVideoSource.cxx.

◆ GetCaptureDeviceName()

std::wstring vtkPlusMmfVideoSource::GetCaptureDeviceName ( unsigned int  deviceId)
protected

Definition at line 725 of file vtkPlusMmfVideoSource.cxx.

◆ GetClassName()

virtual const char* vtkPlusMmfVideoSource::GetClassName ( )
virtual

Reimplemented from vtkPlusDevice.

◆ GetListOfCaptureDevices()

void vtkPlusMmfVideoSource::GetListOfCaptureDevices ( std::vector< std::wstring > &  deviceNames)

Definition at line 558 of file vtkPlusMmfVideoSource.cxx.

◆ GetListOfCaptureVideoFormats()

void vtkPlusMmfVideoSource::GetListOfCaptureVideoFormats ( std::vector< std::wstring > &  videoModes,
unsigned int  deviceId 
)

Definition at line 564 of file vtkPlusMmfVideoSource.cxx.

◆ GetRequestedDeviceName()

std::wstring vtkPlusMmfVideoSource::GetRequestedDeviceName ( )

Definition at line 591 of file vtkPlusMmfVideoSource.cxx.

◆ InternalConnect()

PlusStatus vtkPlusMmfVideoSource::InternalConnect ( )
protectedvirtual

Device-specific connect

Reimplemented from vtkPlusDevice.

Definition at line 284 of file vtkPlusMmfVideoSource.cxx.

◆ InternalDisconnect()

PlusStatus vtkPlusMmfVideoSource::InternalDisconnect ( )
protectedvirtual

Device-specific disconnect

Reimplemented from vtkPlusDevice.

Definition at line 352 of file vtkPlusMmfVideoSource.cxx.

◆ InternalStartRecording()

PlusStatus vtkPlusMmfVideoSource::InternalStartRecording ( )
protectedvirtual

Device-specific recording start

Reimplemented from vtkPlusDevice.

Definition at line 363 of file vtkPlusMmfVideoSource.cxx.

◆ InternalStopRecording()

PlusStatus vtkPlusMmfVideoSource::InternalStopRecording ( )
protectedvirtual

Device-specific recording stop

Reimplemented from vtkPlusDevice.

Definition at line 414 of file vtkPlusMmfVideoSource.cxx.

◆ IsA()

virtual int vtkPlusMmfVideoSource::IsA ( const char *  type)
virtual

Reimplemented from vtkPlusDevice.

◆ IsTracker()

virtual bool vtkPlusMmfVideoSource::IsTracker ( ) const
inlinevirtual

Is this device a tracker

Reimplemented from vtkPlusDevice.

Definition at line 73 of file vtkPlusMmfVideoSource.h.

◆ IsTypeOf()

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

◆ LogListOfCaptureDevices()

void vtkPlusMmfVideoSource::LogListOfCaptureDevices ( )

Definition at line 712 of file vtkPlusMmfVideoSource.cxx.

◆ LogListOfCaptureVideoFormats()

void vtkPlusMmfVideoSource::LogListOfCaptureVideoFormats ( unsigned int  deviceId)

Definition at line 700 of file vtkPlusMmfVideoSource.cxx.

◆ New()

static vtkPlusMmfVideoSource* vtkPlusMmfVideoSource::New ( )
static

◆ NotifyConfigured()

PlusStatus vtkPlusMmfVideoSource::NotifyConfigured ( )
virtual

Verify the device is correctly configured

Reimplemented from vtkPlusDevice.

Definition at line 428 of file vtkPlusMmfVideoSource.cxx.

◆ PrintSelf()

void vtkPlusMmfVideoSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkPlusDevice.

Definition at line 276 of file vtkPlusMmfVideoSource.cxx.

◆ ReadConfiguration()

PlusStatus vtkPlusMmfVideoSource::ReadConfiguration ( vtkXMLDataElement *  rootXMLElement)
virtual

Read main configuration from xml data

Reimplemented from vtkPlusDevice.

Definition at line 472 of file vtkPlusMmfVideoSource.cxx.

◆ SafeDownCast()

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

◆ SetRequestedDeviceId()

void vtkPlusMmfVideoSource::SetRequestedDeviceId ( unsigned int  deviceId)
virtual

Definition at line 552 of file vtkPlusMmfVideoSource.cxx.

◆ SetRequestedFrameSize()

void vtkPlusMmfVideoSource::SetRequestedFrameSize ( const FrameSizeType &  frameSize)
virtual

Definition at line 546 of file vtkPlusMmfVideoSource.cxx.

◆ SetRequestedStreamIndex()

void vtkPlusMmfVideoSource::SetRequestedStreamIndex ( unsigned int  streamIndex)
virtual

Definition at line 540 of file vtkPlusMmfVideoSource.cxx.

◆ SetRequestedVideoFormat()

void vtkPlusMmfVideoSource::SetRequestedVideoFormat ( const std::wstring &  pixelFormatName)
virtual

Definition at line 534 of file vtkPlusMmfVideoSource.cxx.

◆ UpdateFrameSize()

PlusStatus vtkPlusMmfVideoSource::UpdateFrameSize ( )
protected

Definition at line 441 of file vtkPlusMmfVideoSource.cxx.

◆ WriteConfiguration()

PlusStatus vtkPlusMmfVideoSource::WriteConfiguration ( vtkXMLDataElement *  config)
virtual

Write main configuration to xml data

Reimplemented from vtkPlusDevice.

Definition at line 512 of file vtkPlusMmfVideoSource.cxx.

Friends And Related Function Documentation

◆ MmfVideoSourceReader

friend class MmfVideoSourceReader
friend

Definition at line 40 of file vtkPlusMmfVideoSource.h.

Member Data Documentation

◆ ActiveVideoFormat

VideoFormat vtkPlusMmfVideoSource::ActiveVideoFormat
protected

Definition at line 104 of file vtkPlusMmfVideoSource.h.

◆ FrameIndex

int vtkPlusMmfVideoSource::FrameIndex
protected

Definition at line 99 of file vtkPlusMmfVideoSource.h.

◆ MmfSourceReader

MmfVideoSourceReader* vtkPlusMmfVideoSource::MmfSourceReader
protected

Definition at line 106 of file vtkPlusMmfVideoSource.h.

◆ Mutex

vtkSmartPointer<vtkIGSIORecursiveCriticalSection> vtkPlusMmfVideoSource::Mutex
protected

Definition at line 101 of file vtkPlusMmfVideoSource.h.

◆ RequestedVideoFormat

VideoFormat vtkPlusMmfVideoSource::RequestedVideoFormat
protected

Definition at line 103 of file vtkPlusMmfVideoSource.h.

◆ UncompressedVideoFrame

igsioVideoFrame vtkPlusMmfVideoSource::UncompressedVideoFrame
protected

Definition at line 102 of file vtkPlusMmfVideoSource.h.

The documentation for this class was generated from the following files:
Generated on Fri Nov 15 2024 01:48:19 for PlusLib by   doxygen 1.8.15