OpenPose  1.0.0rc2
OpenPose: A Real-Time Multi-Person Key-Point Detection And Multi-Threading C++ Library
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Macros
Public Member Functions | Protected Member Functions | List of all members
op::VideoCaptureReader Class Referenceabstract

#include <videoCaptureReader.hpp>

Inherits op::Producer.

Inherited by op::IpCameraReader, op::VideoReader, and op::WebcamReader.

Public Member Functions

 VideoCaptureReader (const int index, const bool throwExceptionIfNoOpened)
 
 VideoCaptureReader (const std::string &path, const ProducerType producerType)
 
virtual ~VideoCaptureReader ()
 
virtual std::string getFrameName ()=0
 
bool isOpened () const
 
void release ()
 
virtual double get (const int capProperty)=0
 
virtual void set (const int capProperty, const double value)=0
 
double get (const ProducerProperty property)
 
void set (const ProducerProperty property, const double value)
 
- Public Member Functions inherited from op::Producer
 Producer (const ProducerType type)
 
virtual ~Producer ()
 
cv::Mat getFrame ()
 
void setProducerFpsMode (const ProducerFpsMode fpsMode)
 
ProducerType getType ()
 

Protected Member Functions

virtual cv::Mat getRawFrame ()=0
 
- Protected Member Functions inherited from op::Producer
void checkFrameIntegrity (cv::Mat &frame)
 
void flipAndRotate (cv::Mat &cvMat) const
 
void ifEndedResetOrRelease ()
 
void keepDesiredFrameRate ()
 

Detailed Description

VideoCaptureReader is an abstract class to extract frames from a cv::VideoCapture source (video file, webcam stream, etc.). It has the basic and common functions of the cv::VideoCapture class (e.g. get, set, etc.).

Constructor & Destructor Documentation

op::VideoCaptureReader::VideoCaptureReader ( const int  index,
const bool  throwExceptionIfNoOpened 
)
explicit

This constructor of VideoCaptureReader wraps cv::VideoCapture(const int).

Parameters
indexconst int indicating the cv::VideoCapture constructor int argument, in the range [0, 9].
op::VideoCaptureReader::VideoCaptureReader ( const std::string &  path,
const ProducerType  producerType 
)
explicit

This constructor of VideoCaptureReader wraps cv::VideoCapture(const std::string).

Parameters
pathconst std::string indicating the cv::VideoCapture constructor string argument.
producerTypeconst std::string indicating whether the frame source is an IP camera or video.
virtual op::VideoCaptureReader::~VideoCaptureReader ( )
virtual

Destructor of VideoCaptureReader. It releases the cv::VideoCapture member. It is virtual so that any children class can implement its own destructor.

Member Function Documentation

virtual double op::VideoCaptureReader::get ( const int  capProperty)
pure virtual

This function is a wrapper of cv::VideoCapture::get. It allows getting different properties of the Producer (fps, width, height, etc.). See the OpenCV documentation for all the available properties.

Parameters
capPropertyint indicating the property to be modified.
Returns
double returning the property value.

Implements op::Producer.

Implemented in op::WebcamReader, op::VideoReader, and op::IpCameraReader.

double op::VideoCaptureReader::get ( const ProducerProperty  property)
inlinevirtual

Implements op::Producer.

virtual std::string op::VideoCaptureReader::getFrameName ( )
pure virtual

This function returns a unique frame name (e.g. the frame number for video, the frame counter for webcam, the image name for image directory reader, etc.).

Returns
std::string with an unique frame name.

Implements op::Producer.

Implemented in op::WebcamReader, op::VideoReader, and op::IpCameraReader.

virtual cv::Mat op::VideoCaptureReader::getRawFrame ( )
protectedpure virtual

Function to be defined by its children class. It retrieves and returns a new frame from the frames producer.

Returns
cv::Mat with the new frame.

Implements op::Producer.

bool op::VideoCaptureReader::isOpened ( ) const
inlinevirtual

This function returns whether the Producer instance is still opened and able to retrieve more frames.

Returns
bool indicating whether the Producer is opened.

Implements op::Producer.

void op::VideoCaptureReader::release ( )
virtual

This function releases and closes the Producer. After it is called, no more frames can be retrieved from Producer::getFrame.

Implements op::Producer.

virtual void op::VideoCaptureReader::set ( const int  capProperty,
const double  value 
)
pure virtual

This function is a wrapper of cv::VideoCapture::set. It allows setting different properties of the Producer (fps, width, height, etc.). See the OpenCV documentation for all the available properties.

Parameters
capPropertyint indicating the property to be modified.
valuedouble indicating the new value to be assigned.

Implements op::Producer.

Implemented in op::WebcamReader, op::VideoReader, and op::IpCameraReader.

void op::VideoCaptureReader::set ( const ProducerProperty  property,
const double  value 
)
inlinevirtual

Implements op::Producer.

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