A class for writing videos. More...
#include <mvl2_video_writer.h>
Public Member Functions | |
| mvl2_video_writer () | |
| Dflt ctor. | |
| virtual | ~mvl2_video_writer () |
| Destructor. | |
| virtual bool | set_codec (char, char, char, char)=0 |
| Set the video codec fourcc. | |
| virtual bool | open (int width, int height, vcl_string format, vcl_string file_name)=0 |
| Initialize the file (format can be Grey, RGB, or more complex). | |
| virtual void | close () |
| Tidy up and close the file. | |
| virtual bool | is_opened () const |
| Check whether camera is initialised. | |
| virtual int | get_width () const |
| Return width of image (in pixels). | |
| virtual int | get_height () const |
| Return height of image (in pixels). | |
| virtual int | get_frame_number () const |
| Return the index of the current frame. | |
| virtual double | get_frame_rate () const |
| Return the frame rate in frames per second. | |
| virtual void | set_frame_rate (double frame_rate)=0 |
| Set the frame rate in frames per second. | |
| virtual void | set_quality (int qual)=0 |
| Set the quality of the recorded video. | |
| virtual void | write_frame (vil_image_view< vxl_byte > &image)=0 |
| Put frame data into the given image. | |
| virtual vcl_string | is_a () const |
| Name of the class. | |
| virtual mvl2_video_writer * | clone () const =0 |
| Create a copy on the heap and return base class pointer. | |
Protected Attributes | |
| bool | use_colour_ |
| bool | is_initialized_ |
| int | current_frame_ |
| double | frame_rate_ |
| int | width_ |
| int | height_ |
| int | quality_ |
| bool | firstcall_ |
Detailed Description
A class for writing videos.
Definition at line 23 of file mvl2_video_writer.h.
Constructor & Destructor Documentation
| mvl2_video_writer::mvl2_video_writer | ( | ) | [inline] |
Dflt ctor.
Definition at line 28 of file mvl2_video_writer.h.
| virtual mvl2_video_writer::~mvl2_video_writer | ( | ) | [inline, virtual] |
Destructor.
Definition at line 31 of file mvl2_video_writer.h.
Member Function Documentation
| virtual mvl2_video_writer* mvl2_video_writer::clone | ( | ) | const [pure virtual] |
Create a copy on the heap and return base class pointer.
Implemented in mvl2_video_to_avi, and mvl2_video_to_avi.
| virtual void mvl2_video_writer::close | ( | ) | [inline, virtual] |
Tidy up and close the file.
Reimplemented in mvl2_video_to_avi, and mvl2_video_to_avi.
Definition at line 42 of file mvl2_video_writer.h.
| virtual int mvl2_video_writer::get_frame_number | ( | ) | const [inline, virtual] |
Return the index of the current frame.
Definition at line 54 of file mvl2_video_writer.h.
| virtual double mvl2_video_writer::get_frame_rate | ( | ) | const [inline, virtual] |
Return the frame rate in frames per second.
Reimplemented in mvl2_video_to_avi, and mvl2_video_to_avi.
Definition at line 57 of file mvl2_video_writer.h.
| virtual int mvl2_video_writer::get_height | ( | ) | const [inline, virtual] |
Return height of image (in pixels).
Reimplemented in mvl2_video_to_avi, and mvl2_video_to_avi.
Definition at line 51 of file mvl2_video_writer.h.
| virtual int mvl2_video_writer::get_width | ( | ) | const [inline, virtual] |
Return width of image (in pixels).
Reimplemented in mvl2_video_to_avi, and mvl2_video_to_avi.
Definition at line 48 of file mvl2_video_writer.h.
| virtual vcl_string mvl2_video_writer::is_a | ( | ) | const [inline, virtual] |
Name of the class.
Reimplemented in mvl2_video_to_avi, and mvl2_video_to_avi.
Definition at line 69 of file mvl2_video_writer.h.
| virtual bool mvl2_video_writer::is_opened | ( | ) | const [inline, virtual] |
Check whether camera is initialised.
Reimplemented in mvl2_video_to_avi, and mvl2_video_to_avi.
Definition at line 45 of file mvl2_video_writer.h.
| virtual bool mvl2_video_writer::open | ( | int | width, |
| int | height, | ||
| vcl_string | format, | ||
| vcl_string | file_name | ||
| ) | [pure virtual] |
Initialize the file (format can be Grey, RGB, or more complex).
Implemented in mvl2_video_to_avi, and mvl2_video_to_avi.
| virtual bool mvl2_video_writer::set_codec | ( | char | , |
| char | , | ||
| char | , | ||
| char | |||
| ) | [pure virtual] |
Set the video codec fourcc.
return true if it is a correct codec
Implemented in mvl2_video_to_avi, and mvl2_video_to_avi.
| virtual void mvl2_video_writer::set_frame_rate | ( | double | frame_rate | ) | [pure virtual] |
Set the frame rate in frames per second.
Implemented in mvl2_video_to_avi, and mvl2_video_to_avi.
| virtual void mvl2_video_writer::set_quality | ( | int | qual | ) | [pure virtual] |
Set the quality of the recorded video.
Implemented in mvl2_video_to_avi, and mvl2_video_to_avi.
| virtual void mvl2_video_writer::write_frame | ( | vil_image_view< vxl_byte > & | image | ) | [pure virtual] |
Put frame data into the given image.
Implemented in mvl2_video_to_avi, and mvl2_video_to_avi.
Member Data Documentation
int mvl2_video_writer::current_frame_ [protected] |
Definition at line 78 of file mvl2_video_writer.h.
bool mvl2_video_writer::firstcall_ [protected] |
Definition at line 83 of file mvl2_video_writer.h.
double mvl2_video_writer::frame_rate_ [protected] |
Reimplemented in mvl2_video_to_avi.
Definition at line 79 of file mvl2_video_writer.h.
int mvl2_video_writer::height_ [protected] |
Definition at line 81 of file mvl2_video_writer.h.
bool mvl2_video_writer::is_initialized_ [protected] |
Definition at line 77 of file mvl2_video_writer.h.
int mvl2_video_writer::quality_ [protected] |
Definition at line 82 of file mvl2_video_writer.h.
bool mvl2_video_writer::use_colour_ [protected] |
Definition at line 76 of file mvl2_video_writer.h.
int mvl2_video_writer::width_ [protected] |
Definition at line 80 of file mvl2_video_writer.h.
The documentation for this class was generated from the following file:
- contrib/mul/mvl2/mvl2_video_writer.h
