#include <mitkVideoSource.h>

Inheritance diagram for mitk::VideoSource:

Collaboration diagram for mitk::VideoSource:

Public Member Functions
	mitkClassMacroItkParent (VideoSource, itk::Object)

virtual void	FetchFrame ()

virtual unsigned char *	GetVideoTexture ()=0

virtual void	StartCapturing ()

virtual void	StopCapturing ()

virtual bool	IsCapturingEnabled () const

virtual int	GetImageWidth ()

virtual int	GetImageHeight ()

virtual unsigned long	GetFrameCount () const

virtual bool	GetCapturePaused () const

virtual void	PauseCapturing ()

Protected Member Functions
	VideoSource ()

	~VideoSource () override

Protected Attributes
unsigned char *	m_CurrentVideoTexture

int	m_CaptureWidth

int	m_CaptureHeight

bool	m_CapturingInProcess

unsigned long	m_FrameCount

bool	m_CapturePaused

Detailed Description

Simple base class for acquiring video data.

Definition at line 27 of file mitkVideoSource.h.

Constructor & Destructor Documentation

◆ VideoSource()

mitk::VideoSource::VideoSource ( )

protected

init member

Definition at line 15 of file mitkVideoSource.cpp.

◆ ~VideoSource()

mitk::VideoSource::~VideoSource ( )

overrideprotected

deletes m_CurrentVideoTexture (if not 0)

Definition at line 25 of file mitkVideoSource.cpp.

References m_CurrentVideoTexture.

Member Function Documentation

◆ FetchFrame()

void mitk::VideoSource::FetchFrame ( )

virtual

assigns the grabbing devices for acquiring the next frame. in this base implementation it does nothing except incrementing m_FrameCount

Reimplemented in mitk::OpenCVVideoSource, and mitk::VideoInputSource.

Definition at line 50 of file mitkVideoSource.cpp.

References m_FrameCount.

Referenced by QmitkVideoBackground::AddRenderWindow().

◆ GetCapturePaused()

bool mitk::VideoSource::GetCapturePaused ( ) const

virtual

Returns: true, if capturing is currently paused, false otherwise

Definition at line 71 of file mitkVideoSource.cpp.

References m_CapturePaused.

Referenced by QmitkOpenCVVideoControls::on_VideoProgressSlider_sliderPressed(), QmitkOpenCVVideoControls::on_VideoProgressSlider_sliderReleased(), and QmitkOpenCVVideoControls::Play().

◆ GetFrameCount()

unsigned long mitk::VideoSource::GetFrameCount ( ) const

virtual

Returns: the current frame count

Definition at line 66 of file mitkVideoSource.cpp.

References m_FrameCount.

◆ GetImageHeight()

int mitk::VideoSource::GetImageHeight ( )

virtual

Returns: the current frame height (might be 0 if unknown)

Definition at line 61 of file mitkVideoSource.cpp.

References m_CaptureHeight.

Referenced by QmitkVideoBackground::AddRenderWindow(), and QmitkVideoBackground::Modified().

◆ GetImageWidth()

int mitk::VideoSource::GetImageWidth ( )

virtual

Returns: the current frame width (might be 0 if unknown)

Definition at line 56 of file mitkVideoSource.cpp.

References m_CaptureWidth.

Referenced by QmitkVideoBackground::AddRenderWindow().

◆ GetVideoTexture()

virtual unsigned char* mitk::VideoSource::GetVideoTexture ( )

pure virtual

Returns: a pointer to the image data array for opengl rendering.

Implemented in mitk::OpenCVVideoSource.

Referenced by QmitkVideoBackground::UpdateVideo().

◆ IsCapturingEnabled()

bool mitk::VideoSource::IsCapturingEnabled ( ) const

virtual

Returns: true if video capturing is active.

See also: m_CapturingInProcess

Definition at line 45 of file mitkVideoSource.cpp.

References m_CapturingInProcess.

Referenced by QmitkOpenCVVideoControls::Play(), and QmitkOpenCVVideoControls::~QmitkOpenCVVideoControls().

◆ mitkClassMacroItkParent()

mitk::VideoSource::mitkClassMacroItkParent	(	VideoSource	,
		itk::Object
	)

Smart pointer defs

◆ PauseCapturing()

void mitk::VideoSource::PauseCapturing ( )

virtual

toggles m_CapturePaused In Subclasses this function can be overwritten to take measurs to provide a pause image, BUT DO NOT FORGET TO TOGGLE m_CapturePaused

Reimplemented in mitk::OpenCVVideoSource.

Definition at line 76 of file mitkVideoSource.cpp.

References m_CapturePaused.

◆ StartCapturing()

void mitk::VideoSource::StartCapturing ( )

virtual

advices this class to start the video capturing. in this base implementation: toggles m_CapturingInProcess, resets m_FrameCount ATTENTION: this should be also done in subclasses overwriting this method

Reimplemented in mitk::OpenCVVideoSource, and mitk::VideoInputSource.

Definition at line 31 of file mitkVideoSource.cpp.

References m_CapturingInProcess, and m_FrameCount.

◆ StopCapturing()

void mitk::VideoSource::StopCapturing ( )

virtual

advices this class to stop the video capturing. in this base implementation: toggles m_CapturingInProcess, resets m_FrameCount ATTENTION: this should be also done in subclasses overwriting this method

Reimplemented in mitk::OpenCVVideoSource, and mitk::VideoInputSource.

Definition at line 38 of file mitkVideoSource.cpp.

References m_CapturingInProcess, and m_FrameCount.

Member Data Documentation

◆ m_CaptureHeight

int mitk::VideoSource::m_CaptureHeight

protected

should be filled when the first frame is available default: 0

Definition at line 112 of file mitkVideoSource.h.

Referenced by mitk::OpenCVVideoSource::EnableOnlineImageUndistortion(), mitk::VideoInputSource::FetchFrame(), mitk::OpenCVVideoSource::FetchFrame(), mitk::OpenCVVideoSource::GetCurrentFrameAsItkHSVPixelImage(), GetImageHeight(), mitk::OpenCVVideoSource::Reset(), mitk::VideoInputSource::StartCapturing(), mitk::OpenCVVideoSource::UpdateVideoTexture(), and mitk::VideoInputSource::VideoInputSource().

◆ m_CapturePaused

bool mitk::VideoSource::m_CapturePaused

protected

Saves if the capturing is currently paused, i.e. this will not fetch any further frames but provide the current frame as long as m_CapturePaused is true default: false

Definition at line 133 of file mitkVideoSource.h.

Referenced by mitk::VideoInputSource::FetchFrame(), mitk::OpenCVVideoSource::FetchFrame(), GetCapturePaused(), PauseCapturing(), mitk::OpenCVVideoSource::PauseCapturing(), mitk::OpenCVVideoSource::Reset(), and mitk::OpenCVVideoSource::StopCapturing().

◆ m_CaptureWidth

int mitk::VideoSource::m_CaptureWidth

protected

should be filled when the first frame is available default: 0

Definition at line 106 of file mitkVideoSource.h.

Referenced by mitk::OpenCVVideoSource::EnableOnlineImageUndistortion(), mitk::VideoInputSource::FetchFrame(), mitk::OpenCVVideoSource::FetchFrame(), mitk::OpenCVVideoSource::GetCurrentFrameAsItkHSVPixelImage(), GetImageWidth(), mitk::OpenCVVideoSource::Reset(), mitk::VideoInputSource::StartCapturing(), mitk::OpenCVVideoSource::UpdateVideoTexture(), and mitk::VideoInputSource::VideoInputSource().

◆ m_CapturingInProcess

bool mitk::VideoSource::m_CapturingInProcess

protected

saves if capturing is in procress default: false

Definition at line 118 of file mitkVideoSource.h.

Referenced by mitk::VideoInputSource::FetchFrame(), mitk::OpenCVVideoSource::FetchFrame(), IsCapturingEnabled(), mitk::VideoInputSource::StartCapturing(), StartCapturing(), mitk::OpenCVVideoSource::StartCapturing(), mitk::VideoInputSource::StopCapturing(), StopCapturing(), mitk::OpenCVVideoSource::StopCapturing(), mitk::VideoInputSource::VideoInputSource(), and mitk::VideoInputSource::~VideoInputSource().

◆ m_CurrentVideoTexture

unsigned char* mitk::VideoSource::m_CurrentVideoTexture

protected

finally this is what the video source must create: a video texture pointer default: 0

Definition at line 100 of file mitkVideoSource.h.

Referenced by ~VideoSource().

◆ m_FrameCount

unsigned long mitk::VideoSource::m_FrameCount

protected

Saves the current frame count. Incremented in FetchFrame(). Resetted to 0 when StartCapturing() or StopCapturing() is called. default: 0

Definition at line 125 of file mitkVideoSource.h.

Referenced by FetchFrame(), mitk::OpenCVVideoSource::FetchFrame(), GetFrameCount(), mitk::OpenCVVideoSource::Reset(), StartCapturing(), and StopCapturing().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VideoSource()

◆ ~VideoSource()

Member Function Documentation

◆ FetchFrame()

◆ GetCapturePaused()

◆ GetFrameCount()

◆ GetImageHeight()

◆ GetImageWidth()

◆ GetVideoTexture()

◆ IsCapturingEnabled()

◆ mitkClassMacroItkParent()

◆ PauseCapturing()

◆ StartCapturing()

◆ StopCapturing()

Member Data Documentation

◆ m_CaptureHeight

◆ m_CapturePaused

◆ m_CaptureWidth

◆ m_CapturingInProcess

◆ m_CurrentVideoTexture

◆ m_FrameCount