Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Member Functions | Private Attributes
mrpt::vision::CVideoFileWriter Class Reference

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:

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:

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

Definition at line 43 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::img::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 CVideoFileWriteroperator<< (const mrpt::img::CImage &img) const
 Write image to the video file. More...
 
bool writeImage (const mrpt::img::CImage &img) const
 Write image to the video file (method function, alternative to the operator <<). More...
 

Private Attributes

mrpt::void_ptr_noncopy m_video
 A pointer to CvVideoWriter. More...
 
mrpt::img::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 30 of file CVideoFileWriter.cpp.

◆ ~CVideoFileWriter()

CVideoFileWriter::~CVideoFileWriter ( )
virtual

Destructor.

Definition at line 34 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 90 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 102 of file CVideoFileWriter.cpp.

References M_WRITER.

◆ open()

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

Open a file for writing the video.

Parameters
out_fileThe video file to create for output.
fourccThe video codec, as a string. See notes below. fps The video FPS (frames per seconds).
frameSizeThe size of the video frames. All subsequent images must be of this size.
isColorSet 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 38 of file CVideoFileWriter.cpp.

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

◆ operator<<()

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

Write image to the video file.

Exceptions
std::exceptionOn any error

Definition at line 114 of file CVideoFileWriter.cpp.

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

◆ writeImage()

bool CVideoFileWriter::writeImage ( const mrpt::img::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::non_copiable_ptr_basic< T >::get(), m_img_size, m_video, and M_WRITER.

Member Data Documentation

◆ m_img_size

mrpt::img::TImageSize mrpt::vision::CVideoFileWriter::m_img_size
private

A copy of the video size.

Definition at line 49 of file CVideoFileWriter.h.

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

◆ m_video

mrpt::void_ptr_noncopy mrpt::vision::CVideoFileWriter::m_video
private

A pointer to CvVideoWriter.

Definition at line 47 of file CVideoFileWriter.h.

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




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at lun oct 28 00:14:14 CET 2019