Detailed Description

An output stream which takes a sequence of images and writes a video file in any of a given of compatible formats.

The output file is open when calling "open", and it's closed at destructor or after calling "close".

Example of usage:

CVideoFileWriter  vid;
vid.open("test.avi",15,TPixelCoord(320,200), "MJPG");
CImage  img(320,200);
vid << img;
vid.close;

There are two methods for adding frames to the video:

The operator <<: Which will raise an exception on any error.
The method writeImage, which does not raise any exception on errors.

Note: This class is a wrapper for OpenCV's CvVideoWriter.

Definition at line 41 of file CVideoFileWriter.h.

#include <mrpt/vision/CVideoFileWriter.h>

Public Member Functions
	CVideoFileWriter ()
	Default constructor, which does not open any file. More...

virtual	~CVideoFileWriter ()
	Destructor. More...

bool	open (const std::string &out_file, double fps, const mrpt::utils::TImageSize &frameSize, const std::string &fourcc=std::string(""), bool isColor=true)
	Open a file for writing the video. More...

void	close ()
	Finish the file writing and close the file output. More...

bool	isOpen () const
	Return true if already successfully open with open() and not closed yet. More...

const CVideoFileWriter &	operator<< (const mrpt::utils::CImage &img) const
	Write image to the video file. More...

bool	writeImage (const mrpt::utils::CImage &img) const
	Write image to the video file (method function, alternative to the operator <<). More...

Private Attributes
mrpt::utils::void_ptr_noncopy	m_video
	A pointer to CvVideoWriter. More...

mrpt::utils::TImageSize	m_img_size
	A copy of the video size. More...

Constructor & Destructor Documentation

◆ CVideoFileWriter()

CVideoFileWriter::CVideoFileWriter ( )

Default constructor, which does not open any file.

Definition at line 29 of file CVideoFileWriter.cpp.

◆ ~CVideoFileWriter()

CVideoFileWriter::~CVideoFileWriter ( )

virtual

Destructor.

Definition at line 36 of file CVideoFileWriter.cpp.

References close().

Member Function Documentation

◆ close()

void CVideoFileWriter::close ( )

Finish the file writing and close the file output.

Definition at line 94 of file CVideoFileWriter.cpp.

References M_WRITER, and M_WRITER_PTR.

Referenced by open(), and ~CVideoFileWriter().

◆ isOpen()

bool CVideoFileWriter::isOpen ( ) const

Return true if already successfully open with open() and not closed yet.

Definition at line 106 of file CVideoFileWriter.cpp.

References M_WRITER.

◆ open()

bool CVideoFileWriter::open	(	const std::string &	out_file,
		double	fps,
		const mrpt::utils::TImageSize &	frameSize,
		const std::string &	fourcc = `std::string("")`,
		bool	isColor = `true`
	)

Open a file for writing the video.

Parameters

out_file	The video file to create for output.
fourcc	The video codec, as a string. See notes below. fps The video FPS (frames per seconds).
frameSize	The size of the video frames. All subsequent images must be of this size.
isColor	Set to false to create a grayscale video.

Note: If fourcc is left as an empty string a default codec will be seleceted (e.g. "IYUV").; Other valid values for "fourcc" are: "PIM1" -> MPEG1, "MJPG" -> Motion JPEG, "XVID", etc...

Returns: false on any error, true on success.

Definition at line 44 of file CVideoFileWriter.cpp.

References close(), mrpt::utils::non_copiable_ptr_basic< T >::get(), m_img_size, m_video, mrpt::utils::TPixelCoord::x, and mrpt::utils::TPixelCoord::y.

◆ operator<<()

const CVideoFileWriter & CVideoFileWriter::operator<< ( const mrpt::utils::CImage & img ) const

Write image to the video file.

Exceptions

std::exception On any error

Definition at line 119 of file CVideoFileWriter.cpp.

References mrpt::format(), mrpt::utils::non_copiable_ptr_basic< T >::get(), m_img_size, m_video, M_WRITER, THROW_EXCEPTION, mrpt::utils::TPixelCoord::x, and mrpt::utils::TPixelCoord::y.

◆ writeImage()

bool CVideoFileWriter::writeImage ( const mrpt::utils::CImage & img ) const

Write image to the video file (method function, alternative to the operator <<).

Returns: false on any error

Definition at line 137 of file CVideoFileWriter.cpp.

References mrpt::format(), mrpt::utils::non_copiable_ptr_basic< T >::get(), m_img_size, m_video, M_WRITER, mrpt::utils::TPixelCoord::x, and mrpt::utils::TPixelCoord::y.

Member Data Documentation

◆ m_img_size

mrpt::utils::TImageSize mrpt::vision::CVideoFileWriter::m_img_size

private

A copy of the video size.

Definition at line 45 of file CVideoFileWriter.h.

Referenced by open(), operator<<(), and writeImage().

◆ m_video

mrpt::utils::void_ptr_noncopy mrpt::vision::CVideoFileWriter::m_video