Interface for the capture devices. More...

#include <captureinterface.h>

Inheritance diagram for cavapa_gui::CaptureInterface:

Public Types
enum	INTERFACE_TYPE { HTTP, OPENCV }
	Used to define the type of source interface.

Public Member Functions
	DISALLOW_COPY_AND_ASSIGN (CaptureInterface)
	Copy and assign of the class is not allowed.

virtual double	getBarrelCorrection ()=0
	Retrieves the barrel correction applied to the source. More...

virtual FrameCapture	getBuffered ()=0
	Retrieves the currently buffered frame. More...

virtual std::string	getDescription () const =0
	Retrieves the description of the device. More...

virtual int	getDeviceID () const =0
	Returns the ID number the device was initialized with. More...

virtual double	getFramerate () const =0
	Retrieves the capture device framerate. More...

virtual int	getMissedFrames () const =0
	Retrieves the logged frame misses. More...

virtual FrameCapture	getNext (bool skip, bool *error)=0
	Retrieves the next frame. More...

virtual std::string	getPath () const =0
	Retrieves the path given during the initialization. More...

virtual cv::Size	getResolution () const =0
	Retrieves the capture device resolution. More...

virtual int	getRetrievedFrames () const =0
	Retrieves the total logged frames. More...

virtual INTERFACE_TYPE	getType () const =0
	Retrieves the type of the device. More...

virtual bool	hasNew ()=0
	Checks whether the device has a new image to retrieve or not. More...

virtual bool	isOpen () const =0
	Checks whether the capturing device is open or not. More...

virtual bool	open (const std::string &path)=0
	Opens the video file or the stream. More...

virtual void	resetStats ()=0
	Resets the statistical counters. More...

virtual void	setBarrelCorrection (double amount)=0
	Sets the amount of the barrel correction to be applied. More...

virtual bool	setResolution (const cv::Size &new_size)=0
	Sets the capturing device resolution. More...

Detailed Description

Interface for the capture devices.

The inherits from this class are used by the actual video frame sources. The class represents the core functionality of device image retrieval.

The key functions of this abstract class are getNext() and open().

Author: Petri Partanen

Member Function Documentation

virtual double cavapa_gui::CaptureInterface::getBarrelCorrection ( )

pure virtual

Retrieves the barrel correction applied to the source.

Returns: The amount of the barrel correction.

Implemented in cavapa_gui::OpenCVCapture, and cavapa_gui::HTTPCapture.

virtual FrameCapture cavapa_gui::CaptureInterface::getBuffered ( )

pure virtual

Retrieves the currently buffered frame.

Returns: The buffered frame.

Remarks: This does not signal for a new image fetch from the device.

Implemented in cavapa_gui::OpenCVCapture, and cavapa_gui::HTTPCapture.

virtual std::string cavapa_gui::CaptureInterface::getDescription ( ) const

pure virtual

Retrieves the description of the device.

Returns: For the devices initialized with HW index, this will be the name of the HW device. For other devices this is the path given during initialization.

Implemented in cavapa_gui::OpenCVCapture, and cavapa_gui::HTTPCapture.

virtual int cavapa_gui::CaptureInterface::getDeviceID ( ) const

pure virtual

Returns the ID number the device was initialized with.

Returns: The device ID used in the initialization or UNKNOWN_DEVICE if not specified.

Implemented in cavapa_gui::OpenCVCapture, and cavapa_gui::HTTPCapture.

virtual double cavapa_gui::CaptureInterface::getFramerate ( ) const

pure virtual

Retrieves the capture device framerate.

Returns: The current framerate.

Implemented in cavapa_gui::HTTPCapture, and cavapa_gui::OpenCVCapture.

virtual int cavapa_gui::CaptureInterface::getMissedFrames ( ) const

pure virtual

Retrieves the logged frame misses.

A frame miss occurs everytime when getNext() is called and the previous retrieval was still ongoing.

Returns: The count of the missed frames.

Implemented in cavapa_gui::HTTPCapture, and cavapa_gui::OpenCVCapture.

virtual FrameCapture cavapa_gui::CaptureInterface::getNext	(	bool	skip,
		bool *	error
	)

pure virtual

Retrieves the next frame.

Basically it returns the currently buffered frame and signals the device to grab a new image for next call to the function. If the device has not returned from previous image grab the call is recorded as a missed frame.

Parameters

skip	Specifies if the frame can be skipped. When set to true, this will force the main thread to wait for a new image from the device. This can result in a huge lag if the device is not capable of retrieving images fast enough.
error	Will receive an error message if something went wrong.