BmpVideoSource Class Reference
[Videosource: Video acquisition abstraction]
Load a sequence of images using a "printf" pattern.
More...
#include <bmpvideosource.h>
Public Member Functions | |
| BmpVideoSource (char *genericFilename, int first, int last) | |
| virtual bool | initialize () |
| initialized the video source. | |
| virtual bool | getFrame (IplImage *dst) |
| get the next frame and convert it to the format described in "dst". | |
| void | getSize (int &width, int &height) |
| return width and height of images coming from the video source. | |
| virtual | ~BmpVideoSource () |
| virtual void | start () |
| Start the video source: getFrame() will provide each time a different image. | |
| virtual void | stop () |
| Pause the source. | |
| virtual bool | isPlaying () |
| return false if the source is paused. | |
| virtual const char * | getStreamName () const |
| Returns a string describing the stream. | |
| virtual const char * | getStreamType () const |
| Returns a string describing the type of the stream. | |
| virtual int | getId () |
| This method is usefull only for video files, not grabbing hardware. | |
Detailed Description
Load a sequence of images using a "printf" pattern.cvLoadImage is used, so many file format are supported.
Definition at line 12 of file bmpvideosource.h.
Constructor & Destructor Documentation
| BmpVideoSource::BmpVideoSource | ( | char * | genericFilename, | |
| int | first, | |||
| int | last | |||
| ) |
Definition at line 26 of file bmpvideosource.cpp.
| BmpVideoSource::~BmpVideoSource | ( | ) | [virtual] |
Definition at line 121 of file bmpvideosource.cpp.
Member Function Documentation
| bool BmpVideoSource::getFrame | ( | IplImage * | dst | ) | [virtual] |
get the next frame and convert it to the format described in "dst".
The image will be deinterlaced, scaled, and color converted to match dst.
- Parameters:
-
dst the image to copy the frame into.
- Returns:
- true on success, false on error.
Implements VideoSource.
Definition at line 67 of file bmpvideosource.cpp.
| int BmpVideoSource::getId | ( | ) | [virtual] |
This method is usefull only for video files, not grabbing hardware.
It returns a the number of the last frame provided by getFrame().
- Returns:
- the unique frame number or -1 if the video source does not support frame counting.
Reimplemented from VideoSource.
Definition at line 115 of file bmpvideosource.cpp.
| void BmpVideoSource::getSize | ( | int & | width, | |
| int & | height | |||
| ) | [virtual] |
return width and height of images coming from the video source.
Implements VideoSource.
Definition at line 133 of file bmpvideosource.cpp.
| virtual const char* BmpVideoSource::getStreamName | ( | ) | const [inline, virtual] |
Returns a string describing the stream.
If the source comes from a file, the filename is returned.
Implements VideoSource.
Definition at line 23 of file bmpvideosource.h.
| virtual const char* BmpVideoSource::getStreamType | ( | ) | const [inline, virtual] |
Returns a string describing the type of the stream.
For example: BmpFile, AviFile, DShowCB...
Implements VideoSource.
Definition at line 24 of file bmpvideosource.h.
| bool BmpVideoSource::initialize | ( | ) | [virtual] |
initialized the video source.
Has to be called before any other method.
- Returns:
- true on success, false on error.
Implements VideoSource.
Definition at line 35 of file bmpvideosource.cpp.
References start().
Referenced by BmpFactory::construct().
| virtual bool BmpVideoSource::isPlaying | ( | ) | [inline, virtual] |
return false if the source is paused.
Implements VideoSource.
Definition at line 22 of file bmpvideosource.h.
| void BmpVideoSource::start | ( | ) | [virtual] |
Start the video source: getFrame() will provide each time a different image.
After calling initialize(), the video source is playing.
Implements VideoSource.
Definition at line 124 of file bmpvideosource.cpp.
Referenced by initialize().
| void BmpVideoSource::stop | ( | ) | [virtual] |
Pause the source.
The getFrame() method will always provide the current frame.
Implements VideoSource.
Definition at line 128 of file bmpvideosource.cpp.
The documentation for this class was generated from the following files:
- videosource/bmpvideosource.h
- videosource/bmpvideosource.cpp
