![]() |
Visual Servoing Platform
version 3.2.0
|
#include <vpVideoWriter.h>
Public Member Functions | |
vpVideoWriter () | |
virtual | ~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 | setCodec (const int fourcc_codec) |
void | setFileName (const char *filename) |
void | setFileName (const std::string &filename) |
void | setFirstFrameIndex (const unsigned int first_frame) |
void | setFramerate (const double frame_rate) |
Class that enables to write easily a video file or a sequence of images.
This class has its own implementation to write a sequence of PGM and PPM images.
This class may benefit from optional 3rd parties:
The following example available in tutorial-video-recorder.cpp shows how this class can be used to record a video from a camera by default in an mpeg file.
The following example shows also how this class can be used 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 155 of file vpVideoWriter.h.
vpVideoWriter::vpVideoWriter | ( | ) |
Basic constructor.
Definition at line 54 of file vpVideoWriter.cpp.
|
virtual |
Basic destructor.
Definition at line 78 of file vpVideoWriter.cpp.
void vpVideoWriter::close | ( | ) |
Deallocates parameters use to write the video or the image sequence.
Definition at line 271 of file vpVideoWriter.cpp.
|
inline |
Gets the current frame index.
Definition at line 209 of file vpVideoWriter.h.
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 166 of file vpVideoWriter.cpp.
Sets all the parameters needed to write the video or the image sequence.
I | : One image with the right dimensions. |
Definition at line 131 of file vpVideoWriter.cpp.
|
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 218 of file vpVideoWriter.h.
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 238 of file vpVideoWriter.cpp.
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 205 of file vpVideoWriter.cpp.
|
inline |
Definition at line 224 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 91 of file vpVideoWriter.cpp.
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 124 of file vpVideoWriter.cpp.
|
inline |
Enables to set the first frame index.
first_frame | : The first frame index. |
Definition at line 234 of file vpVideoWriter.h.
|
inline |
Sets the framerate in Hz of the video when encoding.
frame_rate | : the expected framerate. |
By default the framerate is set to 25Hz.
Definition at line 243 of file vpVideoWriter.h.