PNGParallelRecordingStrategy Class Reference

Concrete strategy for a PNG image recording. More...

#include <VisionX/libraries/imrec/record/strats/PNGParallelRecordingStrategy.h>

Inheritance diagram for PNGParallelRecordingStrategy:

Public Member Functions
	PNGParallelRecordingStrategy ()
	PNGParallelRecordingStrategy (const std::filesystem::path &filePath, const std::string &file_name, unsigned int png_compression=9, unsigned int thread_pool_size=1)
void	recordFrame (const cv::Mat &frame, std::chrono::microseconds timestamp) override
	Adds the given frame to the recording.
void	recordFrameAsync (std::filesystem::path path, const cv::Mat &frame)
void	startRecording () override
	Starts the recording manually if constructed empty.
void	stopRecording () override
	Stops the recording.
	~PNGParallelRecordingStrategy () override
Public Member Functions inherited from AbstractSequencedRecordingStrategy
	AbstractSequencedRecordingStrategy ()
	Default constructor to manually start the recording.
	AbstractSequencedRecordingStrategy (const std::filesystem::path &filePath, const std::filesystem::path &ext)
std::filesystem::path	getDotExtension () const override
	Gets the extension plus preceeded dot of the configured file (e.g.
std::filesystem::path	getMetadataPath () const override
	~AbstractSequencedRecordingStrategy () override
	Destruct the recording strategy.
Public Member Functions inherited from AbstractRecordingStrategy
	AbstractRecordingStrategy ()
	Default constructor to start the recording manually.
	AbstractRecordingStrategy (const std::filesystem::path &filePath)
	Constructor for any recording strategy, immediately starting the recording.
virtual std::filesystem::path	getFilePath () const
	Gets the raw file path for the recording as configured.
virtual std::filesystem::path	getPath () const
	Gets the path to the recording without filename.
virtual std::filesystem::path	getStem () const
	Gets the stem of the configured file (filename without extension)
virtual bool	isRecording () const
	Indicates whether this instance is already initialised for recording.
virtual void	recordFrame (const CByteImage &frame, std::chrono::microseconds timestamp)
	Adds the given frame to the recording.
virtual void	writeMetadataDatetime (const std::string &var_name, std::chrono::microseconds timestamp)
virtual std::tuple< unsigned int, std::string >	writeMetadataFrame (const CByteImage &frame, std::chrono::microseconds timestamp)
virtual std::tuple< unsigned int, std::string >	writeMetadataFrame (const cv::Mat &frame, std::chrono::microseconds timestamp)
virtual void	writeMetadataLine (const std::string &var_name, std::string_view var_type, std::string_view var_value)
virtual	~AbstractRecordingStrategy ()
	Destructor.

Static Public Member Functions
static void	recordSnapshot (const CByteImage &image, const std::filesystem::path &path)
static void	recordSnapshot (const cv::Mat &image, const std::filesystem::path &path)

Protected Attributes
unsigned int	m_png_compression
std::atomic< unsigned int >	m_pool_current_size
std::condition_variable	m_pool_cv
unsigned int	m_pool_max_size
std::mutex	m_pool_mutex
std::mutex	m_record_frame_mutex
Protected Attributes inherited from AbstractRecordingStrategy
std::filesystem::path	m_file_path
	Path to where the recording file should be written to.

Additional Inherited Members
Protected Member Functions inherited from AbstractSequencedRecordingStrategy
std::filesystem::path	deriveFramePath (const unsigned int sequence_number, const std::string &frame_name)
	Returns the next sequenced full path and increments the sequence number.

Detailed Description

Concrete strategy for a PNG image recording.

Constructor & Destructor Documentation

PNGParallelRecordingStrategy() [1/2]

PNGParallelRecordingStrategy

(

)

PNGParallelRecordingStrategy() [2/2]

PNGParallelRecordingStrategy	(	const std::filesystem::path &	filePath,
		const std::string &	file_name,
		unsigned int	png_compression = 9,
		unsigned int	thread_pool_size = 1 )

~PNGParallelRecordingStrategy()

~PNGParallelRecordingStrategy ( )

override

Member Function Documentation

recordFrame()

void recordFrame ( const cv::Mat & frame, std::chrono::microseconds timestamp )

overridevirtual

Adds the given frame to the recording.

Parameters

frame

Frame to be added

Reimplemented from AbstractRecordingStrategy.

recordFrameAsync()

void recordFrameAsync	(	std::filesystem::path	path,
		const cv::Mat &	frame )

recordSnapshot() [1/2]

void recordSnapshot ( const CByteImage & image, const std::filesystem::path & path )

static

recordSnapshot() [2/2]

void recordSnapshot ( const cv::Mat & image, const std::filesystem::path & path )

static

startRecording()

void startRecording ( )

overridevirtual

Starts the recording manually if constructed empty.

Parameters

filePath	Path to where the recording file should be written to
fps	Amount of frames being recorded per second

Reimplemented from AbstractSequencedRecordingStrategy.

stopRecording()

void stopRecording ( )

overridevirtual

Stops the recording.

Reimplemented from AbstractRecordingStrategy.

Member Data Documentation

m_png_compression

unsigned int m_png_compression

protected

m_pool_current_size

std::atomic<unsigned int> m_pool_current_size

protected

m_pool_cv

std::condition_variable m_pool_cv

protected

m_pool_max_size

unsigned int m_pool_max_size

protected

m_pool_mutex

std::mutex m_pool_mutex

protected

m_record_frame_mutex

std::mutex m_record_frame_mutex

protected

---

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

• VisionX/libraries/imrec/record/strats/PNGParallelRecordingStrategy.h
• VisionX/libraries/imrec/record/strats/PNGParallelRecordingStrategy.cpp