libcvd
Public Member Functions | List of all members
CVD::VFB::RawVideoFileBuffer Class Reference

Internal (non type-safe) class used by VideoFileBuffer This does the real interfacing with the ffmpeg library. More...

#include <videofilebuffer.h>

Public Member Functions

 RawVideoFileBuffer (const std::string &file, const std::string &formatname, bool is_rgb, bool verbose, const std::map< std::string, std::string > &)
 Construct a video buffer to play this file. More...
 
ImageRef size ()
 The size of the VideoFrames returned by this buffer.
 
void * get_frame ()
 Returns the next frame from the buffer. This function blocks until a frame is ready.
 
void put_frame (void *f)
 Tell the buffer that you are finished with this frame. More...
 
bool frame_pending ()
 Is there a frame waiting in the buffer? This function does not block.
 
void seek_to (double t)
 Go to a particular point in the video buffer (only implemented in buffers of recorded video) More...
 
void on_end_of_buffer (VideoBufferFlags::OnEndOfBuffer behaviour)
 What should the buffer do when it reaches the end of the list of files? More...
 
double frames_per_second ()
 What is the (expected) frame rate of this video buffer, in frames per second?
 
std::string file_name ()
 What is the path to the video file?
 

Detailed Description

Internal (non type-safe) class used by VideoFileBuffer This does the real interfacing with the ffmpeg library.

Constructor & Destructor Documentation

◆ RawVideoFileBuffer()

CVD::VFB::RawVideoFileBuffer::RawVideoFileBuffer ( const std::string &  file,
const std::string &  formatname,
bool  is_rgb,
bool  verbose,
const std::map< std::string, std::string > &   
)

Construct a video buffer to play this file.

Public implementation of RawVideoFileBuffer.

Parameters
fileThe path to the video file
is_rgbIs RGB data wanted?

Member Function Documentation

◆ on_end_of_buffer()

void CVD::VFB::RawVideoFileBuffer::on_end_of_buffer ( VideoBufferFlags::OnEndOfBuffer  behaviour)

What should the buffer do when it reaches the end of the list of files?

Parameters
behaviourThe desired behaviour

◆ put_frame()

void CVD::VFB::RawVideoFileBuffer::put_frame ( void *  f)

Tell the buffer that you are finished with this frame.

Parameters
fThe frame that you are finished with.

◆ seek_to()

void CVD::VFB::RawVideoFileBuffer::seek_to ( double  t)

Go to a particular point in the video buffer (only implemented in buffers of recorded video)

Parameters
tThe frame time in seconds

The documentation for this class was generated from the following files: