A sink for user code to accept raw video frames as OpenCV images. More...

#include <cscore_raw_cv.h>

Inheritance diagram for cs::RawCvSink:

Public Member Functions
	RawCvSink ()=default

	RawCvSink (std::string_view name)
	Create a sink for accepting OpenCV images. More...

	RawCvSink (std::string_view name, std::function< void(uint64_t time)> processFrame)
	Create a sink for accepting OpenCV images in a separate thread. More...

uint64_t	GrabFrame (cv::Mat &image, double timeout=0.225)
	Wait for the next frame and get the image. More...

uint64_t	GrabFrameNoTimeout (cv::Mat &image)
	Wait for the next frame and get the image. More...

uint64_t	GrabFrameDirect (cv::Mat &image, double timeout=0.225)
	Wait for the next frame and get the image. More...

uint64_t	GrabFrameNoTimeoutDirect (cv::Mat &image)
	Wait for the next frame and get the image. More...

Public Member Functions inherited from cs::RawSink
	RawSink ()=default

	RawSink (std::string_view name)
	Create a sink for accepting raw images. More...

	RawSink (std::string_view name, std::function< void(uint64_t time)> processFrame)
	Create a sink for accepting raws images in a separate thread. More...

Public Member Functions inherited from cs::ImageSink
void	SetDescription (std::string_view description)
	Set sink description. More...

std::string	GetError () const
	Get error string. More...

void	SetEnabled (bool enabled)
	Enable or disable getting new frames. More...

Public Member Functions inherited from cs::VideoSink
	VideoSink () noexcept=default

	VideoSink (const VideoSink &sink)

	VideoSink (VideoSink &&sink) noexcept

VideoSink &	operator= (VideoSink other) noexcept

	~VideoSink ()

	operator bool () const

int	GetHandle () const

bool	operator== (const VideoSink &other) const

Kind	GetKind () const
	Get the kind of the sink. More...

std::string	GetName () const
	Get the name of the sink. More...

std::string	GetDescription () const
	Get the sink description. More...

VideoProperty	GetProperty (std::string_view name)
	Get a property of the sink. More...

std::vector< VideoProperty >	EnumerateProperties () const
	Enumerate all properties of this sink. More...

bool	SetConfigJson (std::string_view config)
	Set properties from a JSON configuration string. More...

bool	SetConfigJson (const wpi::json &config)
	Set properties from a JSON configuration object. More...

std::string	GetConfigJson () const
	Get a JSON configuration string. More...

wpi::json	GetConfigJsonObject () const
	Get a JSON configuration object. More...

void	SetSource (VideoSource source)
	Configure which source should provide frames to this sink. More...

VideoSource	GetSource () const
	Get the connected source. More...

VideoProperty	GetSourceProperty (std::string_view name)
	Get a property of the associated source. More...

CS_Status	GetLastStatus () const

Additional Inherited Members
Public Types inherited from cs::VideoSink
enum	Kind { kUnknown = CS_SINK_UNKNOWN , kMjpeg = CS_SINK_MJPEG , kCv = CS_SINK_CV }

Static Public Member Functions inherited from cs::VideoSink
static std::vector< VideoSink >	EnumerateSinks ()
	Enumerate all existing sinks. More...

Protected Member Functions inherited from cs::RawSink
uint64_t	GrabFrame (RawFrame &image, double timeout=0.225) const
	Wait for the next frame and get the image. More...

uint64_t	GrabFrameNoTimeout (RawFrame &image) const
	Wait for the next frame and get the image. More...

Protected Member Functions inherited from cs::ImageSink
	ImageSink ()=default

Protected Member Functions inherited from cs::VideoSink
	VideoSink (CS_Sink handle)

Protected Attributes inherited from cs::VideoSink
CS_Status	m_status = 0

CS_Sink	m_handle {0}

Detailed Description

A sink for user code to accept raw video frames as OpenCV images.

If you are using the WPILib OpenCV builds, do not use this, and instead include "cscore_cv.h" to get a more performant version.

This is not dependent on any opencv binary ABI, and can be used with versions of OpenCV that are not 3. If using OpenCV 3, use CvSink.

Constructor & Destructor Documentation

◆ RawCvSink() [1/3]

cs::RawCvSink::RawCvSink ( )

default

◆ RawCvSink() [2/3]

cs::RawCvSink::RawCvSink ( std::string_view name )

inlineexplicit

Create a sink for accepting OpenCV images.

WaitForFrame() must be called on the created sink to get each new image.

Parameters

name	Source name (arbitrary unique identifier)

◆ RawCvSink() [3/3]

cs::RawCvSink::RawCvSink	(	std::string_view	name,
		std::function< void(uint64_t time)>	processFrame
	)

inline

Create a sink for accepting OpenCV images in a separate thread.

A thread will be created that calls WaitForFrame() and calls the processFrame() callback each time a new frame arrives.

Parameters

name	Source name (arbitrary unique identifier)
processFrame	Frame processing function; will be called with a time=0 if an error occurred. processFrame should call GetImage() or GetError() as needed, but should not call (except in very unusual circumstances) WaitForImage().

Member Function Documentation

◆ GrabFrame()

uint64_t cs::RawCvSink::GrabFrame	(	cv::Mat &	image,
		double	timeout = `0.225`
	)

inline

Wait for the next frame and get the image.

Times out (returning 0) after timeout seconds. The provided image will have three 8-bit channels stored in BGR order.

Returns: Frame time, or 0 on error (call GetError() to obtain the error message); the frame time is in the same time base as wpi::Now(), and is in 1 us increments.

◆ GrabFrameDirect()

uint64_t cs::RawCvSink::GrabFrameDirect	(	cv::Mat &	image,
		double	timeout = `0.225`
	)

inline

Wait for the next frame and get the image.

Times out (returning 0) after timeout seconds. The provided image will have three 8-bit channels stored in BGR order.

Returns: Frame time, or 0 on error (call GetError() to obtain the error message); the frame time is in the same time base as wpi::Now(), and is in 1 us increments.

◆ GrabFrameNoTimeout()

uint64_t cs::RawCvSink::GrabFrameNoTimeout ( cv::Mat & image )

inline

Wait for the next frame and get the image.

May block forever. The provided image will have three 8-bit channels stored in BGR order.

Returns: Frame time, or 0 on error (call GetError() to obtain the error message); the frame time is in the same time base as wpi::Now(), and is in 1 us increments.

◆ GrabFrameNoTimeoutDirect()

uint64_t cs::RawCvSink::GrabFrameNoTimeoutDirect ( cv::Mat & image )

inline

Wait for the next frame and get the image.

May block forever. The provided image will have three 8-bit channels stored in BGR order.

Returns: Frame time, or 0 on error (call GetError() to obtain the error message); the frame time is in the same time base as wpi::Now(), and is in 1 us increments.

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

cscore_raw_cv.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RawCvSink() [1/3]

◆ RawCvSink() [2/3]

◆ RawCvSink() [3/3]

Member Function Documentation

◆ GrabFrame()

◆ GrabFrameDirect()

◆ GrabFrameNoTimeout()

◆ GrabFrameNoTimeoutDirect()