CVD::VFB::RawVideoFileBuffer Class Reference

#include <videofilebuffer.h>

List of all members.

---

Detailed Description

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

Definition at line 113 of file videofilebuffer.h.

Public Member Functions
	RawVideoFileBuffer (const std::string &file, bool is_rgb)
ImageRef	size ()
void *	get_frame ()
void	put_frame (void *f)
bool	frame_pending ()
void	seek_to (double t)
void	on_end_of_buffer (VideoBufferFlags::OnEndOfBuffer behaviour)
double	frames_per_second ()
std::string	file_name ()
std::string	codec_name ()

---

Constructor & Destructor Documentation

CVD::VFB::RawVideoFileBuffer::RawVideoFileBuffer	(	const std::string &	file,
		bool	is_rgb
	)

Construct a video buffer to play this file.

Parameters:

	file	The path to the video file
	is_rgb	Is RGB data wanted?

---

Member Function Documentation

ImageRef CVD::VFB::RawVideoFileBuffer::size

(

)

[inline]

The size of the VideoFrames returned by this buffer.

Definition at line 123 of file videofilebuffer.h.

Referenced by CVD::VideoFileBuffer< T >::size().

void* CVD::VFB::RawVideoFileBuffer::get_frame

(

)

Returns the next frame from the buffer. This function blocks until a frame is ready.

Referenced by CVD::VideoFileBuffer< T >::get_frame().

void CVD::VFB::RawVideoFileBuffer::put_frame

(

void *

f

)

Tell the buffer that you are finished with this frame.

Parameters:

f

The frame that you are finished with.

Referenced by CVD::VideoFileBuffer< T >::put_frame().

bool CVD::VFB::RawVideoFileBuffer::frame_pending

(

)

[inline]

Is there a frame waiting in the buffer? This function does not block.

Definition at line 135 of file videofilebuffer.h.

Referenced by CVD::VideoFileBuffer< T >::frame_pending().

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:

t

The frame time in seconds

Referenced by CVD::VideoFileBuffer< T >::seek_to().

void CVD::VFB::RawVideoFileBuffer::on_end_of_buffer

(

VideoBufferFlags::OnEndOfBuffer

behaviour

)

[inline]

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

Parameters:

behaviour

The desired behaviour

Definition at line 146 of file videofilebuffer.h.

Referenced by CVD::VideoFileBuffer< T >::on_end_of_buffer().

double CVD::VFB::RawVideoFileBuffer::frames_per_second

(

)

[inline]

What is the (expected) frame rate of this video buffer, in frames per second?

Definition at line 152 of file videofilebuffer.h.

Referenced by CVD::VideoFileBuffer< T >::frame_rate().

std::string CVD::VFB::RawVideoFileBuffer::file_name

(

)

[inline]

What is the path to the video file?

Definition at line 162 of file videofilebuffer.h.

Referenced by CVD::VideoFileBuffer< T >::file_name().

std::string CVD::VFB::RawVideoFileBuffer::codec_name

(

)

[inline]

What codec is being used to decode this video?

Definition at line 168 of file videofilebuffer.h.

Referenced by CVD::VideoFileBuffer< T >::codec_name().

---

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

• cvd/videofilebuffer.h

---