Simple class that encpasulates information about a video frame. More...
#include <Video/VideoFrame.H>
Classes | |
| class | Storage |
| Abstract base class for various storage back-ends. More... | |
Public Member Functions | |
| VideoFrame () | |
| Default constructor; be sure to initialize before use, though! | |
| VideoFrame (const byte *data, const size_t length, const Dims &dims, const VideoFormat mode, const bool byteswap, const bool strictLength) | |
| Construct by borrowing 'data' buffer. | |
| VideoFrame (const ArrayHandle< byte > &hdl, const Dims &dims, const VideoFormat mode, const bool byteswap) | |
| Construct with all information needed to convert to RGB, save to disk, etc. | |
| VideoFrame (const Image< byte > &gray) | |
| Construct from a grayscale image (using VIDFMT_GREY). | |
| VideoFrame (const Image< PixRGB< byte > > &rgb) | |
| Construct from an RGB image (using VIDFMT_RGB24). | |
| VideoFrame (const Image< PixVideoYUV< byte > > &yuv) | |
| Construct from a VideoYUV image (using VIDFMT_YUV24). | |
| ~VideoFrame () | |
| Destructor. | |
| VideoFrame (const VideoFrame &that) | |
| Copy constructor. | |
| VideoFrame & | operator= (const VideoFrame &that) |
| Assignment operator. | |
| bool | initialized () const |
| Check if we have any data. | |
| const byte * | getBuffer () const |
| Get the raw buffer pointer. | |
| size_t | getBufSize () const |
| Get the length of the buffer. | |
| const Dims & | getDims () const |
| Get the dimensions of the frame. | |
| VideoFormat | getMode () const |
| Get the video mode. | |
| bool | getByteSwap () const |
| Get the byteswap state. | |
| VideoFrame | makeBobDeinterlaced (int in_bottom_field) const |
| Deinterlace the frame using the "bob" method. | |
| VideoFrame | getFlippedHoriz () const |
| Flip the frame in the horizontal direction. | |
| std::string | diskDumpMmap (const char *fstem, bool flush=false) const |
| Dump the frame to a disk file using mmap(). | |
| std::string | diskDumpStdio (const char *fstem, bool flush=false) const |
| Dump the frame to a disk file using posix io functions. | |
| Image< PixRGB< byte > > | toRgb () const |
| Convert the buffer to RGB, according to its video mode. | |
| Image< PixRGB< uint16 > > | toRgbU16 () const |
| void | toYuvComponents (Image< byte > &y, Image< byte > &u, Image< byte > &v) const |
| Extract individual Y/U/V component images from the buffer, if possible. | |
Static Public Member Functions | |
| static VideoFrame | fromFile (const char *fname, const Dims &dims, const VideoFormat mode, const bool byteswap, const bool strictLength=false) |
| Pseudo-constructor that builds a VideoFrame from a raw file. | |
| static VideoFrame | fromStream (std::istream &strm, const Dims &dims, const VideoFormat mode, const bool byteswap, const bool fail_is_fatal=true) |
| Pseudo-constructor that builds a VideoFrame from an input stream. | |
| static VideoFrame | deepCopyOf (const VideoFrame &original) |
| Make a new VideoFrame object with an internal private copy of the frame data. | |
Simple class that encpasulates information about a video frame.
This includes information about the format in which the frame is encoded, its size, and of course the raw framebuffer data itself.
NOTE: The purpose of this class is to take the place of just passing raw buffer pointers around; instead, we wrap the buffer pointer along with associated descriptive information. However, BEWARE that we have no strong safeguards to ensure that the internal buffer pointer stays "live" for very long. If you want to keep a VideoFrame object around for a "long" time (say, holding it for longer than the function call in which you received it in the first place), then you should call deepCopyOf() on it to get a safe VideoFrame; that way the VideoFrame will make an internal private copy of the frame buffer which can live as long as the object lives without becoming corrupted.
Definition at line 71 of file VideoFrame.H.
| VideoFrame::VideoFrame | ( | ) |
Default constructor; be sure to initialize before use, though!
Definition at line 217 of file VideoFrame.C.
Referenced by deepCopyOf(), fromStream(), getFlippedHoriz(), and makeBobDeinterlaced().
| VideoFrame::VideoFrame | ( | const byte * | data, | |
| const size_t | length, | |||
| const Dims & | dims, | |||
| const VideoFormat | mode, | |||
| const bool | byteswap, | |||
| const bool | strictLength | |||
| ) |
Construct by borrowing 'data' buffer.
The caller is responsible for ensuring that 'data' points to valid memory for as long as the VideoFrame object lives, and for freeing/deleting 'data' afterwards. If you need to hold on to the frame for a long time, then call deepCopyOf() to get a VideoFrame that can be safely held.
Definition at line 229 of file VideoFrame.C.
| VideoFrame::VideoFrame | ( | const ArrayHandle< byte > & | hdl, | |
| const Dims & | dims, | |||
| const VideoFormat | mode, | |||
| const bool | byteswap | |||
| ) |
Construct with all information needed to convert to RGB, save to disk, etc.
Definition at line 246 of file VideoFrame.C.
Construct from a grayscale image (using VIDFMT_GREY).
Definition at line 261 of file VideoFrame.C.
Construct from an RGB image (using VIDFMT_RGB24).
Definition at line 275 of file VideoFrame.C.
References ASSERT.
| VideoFrame::VideoFrame | ( | const Image< PixVideoYUV< byte > > & | yuv | ) | [explicit] |
Construct from a VideoYUV image (using VIDFMT_YUV24).
Definition at line 290 of file VideoFrame.C.
References ASSERT.
| VideoFrame::~VideoFrame | ( | ) |
Destructor.
Definition at line 305 of file VideoFrame.C.
| VideoFrame::VideoFrame | ( | const VideoFrame & | that | ) |
Copy constructor.
Definition at line 311 of file VideoFrame.C.
| VideoFrame VideoFrame::deepCopyOf | ( | const VideoFrame & | original | ) | [static] |
Make a new VideoFrame object with an internal private copy of the frame data.
This allows the returned VideoFrame object to be long-lived (on the other hand, the original VideoFrame's buffer is prone to being eventually overwritten by the frame grabber or movie stream that originally produced it).
Definition at line 390 of file VideoFrame.C.
References rutz::scoped_ptr< T >::get(), getBufSize(), initialized(), and VideoFrame().
Referenced by DisplayController::setBackground().
| std::string VideoFrame::diskDumpMmap | ( | const char * | fstem, | |
| bool | flush = false | |||
| ) | const |
Dump the frame to a disk file using mmap().
A filename extension appropriate to the frame's VideoFormat will be added to the given filename stem.
Returns the full filename of the file that was actually written.
| flush | if true, then do an fsync() on the file before returning |
Definition at line 659 of file VideoFrame.C.
References ASSERT, getBuffer(), and getBufSize().
Referenced by YuvWriter::writeFrame().
| std::string VideoFrame::diskDumpStdio | ( | const char * | fstem, | |
| bool | flush = false | |||
| ) | const |
Dump the frame to a disk file using posix io functions.
A filename extension appropriate to the frame's VideoFormat will be added to the given filename stem.
Returns the full filename of the file that was actually written.
| flush | if true, then do an fsync() on the file before returning |
Definition at line 703 of file VideoFrame.C.
References getBuffer(), and getBufSize().
| VideoFrame VideoFrame::fromFile | ( | const char * | fname, | |
| const Dims & | dims, | |||
| const VideoFormat | mode, | |||
| const bool | byteswap, | |||
| const bool | strictLength = false | |||
| ) | [static] |
Pseudo-constructor that builds a VideoFrame from a raw file.
| strictLength | if true, then we will throw an error if the data length of the file is larger the length that would be expected based on the given Dims and VideoFormat; if the file length is too small, we will unconditionally throw an error regardless of whether strictLength is true |
Definition at line 343 of file VideoFrame.C.
References rutz::scoped_ptr< T >::reset().
Referenced by YuvParser::getFrame().
| VideoFrame VideoFrame::fromStream | ( | std::istream & | strm, | |
| const Dims & | dims, | |||
| const VideoFormat | mode, | |||
| const bool | byteswap, | |||
| const bool | fail_is_fatal = true | |||
| ) | [static] |
Pseudo-constructor that builds a VideoFrame from an input stream.
Definition at line 365 of file VideoFrame.C.
References ArrayData< T >::dataw(), getFrameSize(), NO_INIT, ArrayHandle< T >::uniq(), and VideoFrame().
Referenced by YuvParser::getFrame(), and MrawvDecoder::readFrame().
| const byte* VideoFrame::getBuffer | ( | void | ) | const [inline] |
Get the raw buffer pointer.
Definition at line 136 of file VideoFrame.H.
Referenced by GenericFrame::asGrayU8Layout(), GenericFrame::asGrayU8NTSCLayout(), convertVideoFrameToAVFrame(), diskDumpMmap(), diskDumpStdio(), SDLdisplay::displayVideoOverlay(), SDLdisplay::displayVideoOverlay_image(), SDLdisplay::displayVideoOverlay_patch(), SDLdisplay::displayVideoOverlay_pos(), getFlippedHoriz(), makeBobDeinterlaced(), operator==(), toYuvComponents(), MgzEncoder::writeFrame(), MgzJEncoder::writeFrame(), and MrawvEncoder::writeFrame().
| size_t VideoFrame::getBufSize | ( | ) | const |
Get the length of the buffer.
Definition at line 415 of file VideoFrame.C.
References ASSERT, and getFrameSize().
Referenced by deepCopyOf(), diskDumpMmap(), diskDumpStdio(), operator==(), toRgb(), MgzEncoder::writeFrame(), MgzJEncoder::writeFrame(), and MrawvEncoder::writeFrame().
| bool VideoFrame::getByteSwap | ( | ) | const [inline] |
Get the byteswap state.
Definition at line 148 of file VideoFrame.H.
Referenced by GenericFrame::frameSpec(), getFlippedHoriz(), makeBobDeinterlaced(), MgzEncoder::writeFrame(), and MgzJEncoder::writeFrame().
| const Dims& VideoFrame::getDims | ( | ) | const [inline] |
Get the dimensions of the frame.
Definition at line 142 of file VideoFrame.H.
Referenced by GenericFrame::asGrayU8Layout(), GenericFrame::asGrayU8NTSCLayout(), convertVideoFrameToAVFrame(), SDLdisplay::displayVideoOverlay(), SDLdisplay::displayVideoOverlay_image(), SDLdisplay::displayVideoOverlay_patch(), SDLdisplay::displayVideoOverlay_pos(), GenericFrame::getDims(), getFlippedHoriz(), makeBobDeinterlaced(), and toYuvComponents().
| VideoFrame VideoFrame::getFlippedHoriz | ( | ) | const |
Flip the frame in the horizontal direction.
For now, this only works with VIDFMT_YUV420P frames (which are typically read from ffmpeg and displayed in SDL).
Definition at line 591 of file VideoFrame.C.
References ArrayData< T >::dataw(), getBuffer(), getByteSwap(), getDims(), getFrameSize(), getMode(), Dims::h(), NO_INIT, ArrayHandle< T >::uniq(), VideoFrame(), and Dims::w().
| VideoFormat VideoFrame::getMode | ( | ) | const [inline] |
Get the video mode.
Definition at line 145 of file VideoFrame.H.
Referenced by GenericFrame::asGrayU8Layout(), GenericFrame::asGrayU8NTSCLayout(), coerceVideoFormat(), convertVideoFrameToAVFrame(), SDLdisplay::displayVideoOverlay(), SDLdisplay::displayVideoOverlay_image(), SDLdisplay::displayVideoOverlay_patch(), SDLdisplay::displayVideoOverlay_pos(), LuminanceOfilt::filterFrame(), ColorizeOfilt::filterFrame(), CoerceVideoFormatOfilt::filterFrame(), GenericFrame::frameSpec(), getFlippedHoriz(), makeBobDeinterlaced(), operator==(), toYuvComponents(), MgzEncoder::writeFrame(), MgzJEncoder::writeFrame(), and SDLdisplayStream::writeFrame().
| bool VideoFrame::initialized | ( | ) | const [inline] |
Check if we have any data.
Definition at line 133 of file VideoFrame.H.
References Dims::isNonEmpty().
Referenced by GenericFrame::asVideo(), cacheFrame(), deepCopyOf(), HalfFieldDeinterlacer< BottomField >::readFrame(), and BobDeinterlacer::readFrame().
| VideoFrame VideoFrame::makeBobDeinterlaced | ( | int | in_bottom_field | ) | const |
Deinterlace the frame using the "bob" method.
| in_bottom_field | determines whether to return the rescaled top field or rescaled bottom field |
Definition at line 537 of file VideoFrame.C.
References ArrayData< T >::dataw(), getBuffer(), getByteSwap(), getDims(), getFrameSize(), getMode(), getScanlineWidth(), Dims::h(), NO_INIT, ArrayHandle< T >::uniq(), VideoFrame(), and Dims::w().
Referenced by BobDeinterlacer::readFrame(), and HalfFieldDeinterlacer< BottomField >::readFrame().
| VideoFrame & VideoFrame::operator= | ( | const VideoFrame & | that | ) |
Assignment operator.
Definition at line 326 of file VideoFrame.C.
References rutz::scoped_ptr< T >::get(), and rutz::scoped_ptr< T >::reset().
Convert the buffer to RGB, according to its video mode.
Definition at line 731 of file VideoFrame.C.
References fromARGB(), fromBayer(), fromMono(), fromRGB(), fromRGB555(), fromRGB565(), fromVideoMJPEG(), fromVideoYUV24(), fromVideoYUV410P(), fromVideoYUV411(), fromVideoYUV411P(), fromVideoYUV444(), fromVideoYUV444P(), and getBufSize().
Referenced by GenericFrame::asRgbU8Layout(), convertAVFrameToRGB(), and operator==().
Extract individual Y/U/V component images from the buffer, if possible.
This function will LFATAL() if the VideoFrame data is in a non-YUV mode (such as RGB or grayscale), so you need to check the data mode is appropriate before trying to call this function.
Depending on the data mode, the individual component images may not be all the same size; in particular, the y component is likely to be at the full image size, while the u and v components may be downscaled by a factor of 2 or 4. So, you will need to check the Dims of the result images before doing further processing with them.
Definition at line 805 of file VideoFrame.C.
References getBuffer(), getDims(), getMode(), and Dims::sz().
1.6.3