ViSP
2.7.0
|
#include <vpVideoWriter.h>
Public Member Functions | |
vpVideoWriter () | |
~vpVideoWriter () | |
void | close () |
unsigned int | getCurrentFrameIndex () const |
void | open (vpImage< vpRGBa > &I) |
void | open (vpImage< unsigned char > &I) |
void | resetFrameCounter () |
void | saveFrame (vpImage< vpRGBa > &I) |
void | saveFrame (vpImage< unsigned char > &I) |
void | setBitRate (const unsigned int bit_rate) |
void | setCodec (const CodecID codec) |
void | setFileName (const char *filename) |
void | setFileName (const std::string &filename) |
void | setFirstFrameIndex (const unsigned int firstFrame) |
Class that enables to write easily a video file or a sequence of images.
The following example shows how this class is really easy to use. It enable to write an image sequence. The images are stored in the folder "./image" and are named "image0000.jpeg", "image0001.jpeg", "image0002.jpeg", ...
The other following example explains how to use the class to write directly an mpeg file.
Definition at line 133 of file vpVideoWriter.h.
vpVideoWriter::vpVideoWriter | ( | ) |
Basic constructor.
Definition at line 54 of file vpVideoWriter.cpp.
vpVideoWriter::~vpVideoWriter | ( | ) |
Basic destructor.
Definition at line 71 of file vpVideoWriter.cpp.
void vpVideoWriter::close | ( | ) |
Deallocates parameters use to write the video or the image sequence.
Definition at line 290 of file vpVideoWriter.cpp.
References vpFFMPEG::endWrite(), vpException::notInitialized, and vpERROR_TRACE.
|
inline |
Gets the current frame index.
Definition at line 190 of file vpVideoWriter.h.
Sets all the parameters needed to write the video or the image sequence.
I | : One image with the right dimensions. |
Definition at line 119 of file vpVideoWriter.cpp.
References vpException::fatalError, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpException::ioError, vpImageException::noFileNameError, vpFFMPEG::openEncoder(), vpFFMPEG::setBitRate(), and vpERROR_TRACE.
void vpVideoWriter::open | ( | vpImage< unsigned char > & | I | ) |
Sets all the parameters needed to write the video or the image sequence.
I | : One image with the right dimensions. |
Definition at line 167 of file vpVideoWriter.cpp.
References vpException::fatalError, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpException::ioError, vpImageException::noFileNameError, vpFFMPEG::openEncoder(), vpFFMPEG::setBitRate(), and vpERROR_TRACE.
|
inline |
Reset the frame counter and sets it to the first image index.
By default the first frame index is set to 0.
Definition at line 199 of file vpVideoWriter.h.
Saves the image as a frame of the video or as an image belonging to the image sequence.
Each time this method is used, the frame counter is incremented and thus the file name change for the case of an image sequence.
I | : The image which has to be saved |
Definition at line 217 of file vpVideoWriter.cpp.
References vpException::notInitialized, vpFFMPEG::saveFrame(), vpERROR_TRACE, and vpImageIo::write().
void vpVideoWriter::saveFrame | ( | vpImage< unsigned char > & | I | ) |
Saves the image as a frame of the video or as an image belonging to the image sequence.
Each time this method is used, the frame counter is incremented and thus the file name change for the case of an image sequence.
I | : The image which has to be saved |
Definition at line 256 of file vpVideoWriter.cpp.
References vpException::notInitialized, vpFFMPEG::saveFrame(), vpERROR_TRACE, and vpImageIo::write().
|
inline |
Sets the bit rate of the video when writing.
bit_rate | : the expected bit rate. |
By default the bit rate is set to 500 000.
Definition at line 212 of file vpVideoWriter.h.
|
inline |
Sets the codec used to encode the video.
codec | : the expected codec. |
By default the codec is set to CODEC_ID_MPEG1VIDEO. But you can use one of the CodecID proposed by ffmpeg such as : CODEC_ID_MPEG2VIDEO, CODEC_ID_MPEG2VIDEO_XVMC, CODEC_ID_MPEG4, CODEC_ID_H264, ... (More CodecID can be found in the ffmpeg documentation).
Of course to use the codec it must be installed on your computer.
Definition at line 223 of file vpVideoWriter.h.
void vpVideoWriter::setFileName | ( | const char * | filename | ) |
It enables to set the path and the name of the files which will be saved.
If you want to write a sequence of images, corresponds to the path followed by the image name template. For exemple, if you want to write different images named image0001.jpeg, image0002.jpg, ... and located in the folder /local/image, will be "/local/image/image%04d.jpg".
filename | : filename template of an image sequence. |
Definition at line 87 of file vpVideoWriter.cpp.
References vpImageException::noFileNameError, and vpERROR_TRACE.
Referenced by setFileName().
void vpVideoWriter::setFileName | ( | const std::string & | filename | ) |
It enables to set the path and the name of the files which will be saved.
If you want to write a sequence of images, corresponds to the path followed by the image name template. For exemple, if you want to write different images named image0001.jpeg, image0002.jpg, ... and located in the folder /local/image, will be "/local/image/image%04d.jpg".
filename | : filename template of an image sequence. |
Definition at line 109 of file vpVideoWriter.cpp.
References setFileName().
|
inline |
Enables to set the first frame index.
firstFrame | : The first frame index. |
Definition at line 233 of file vpVideoWriter.h.