VidFile Class Reference

#include <vid_file.h>

Classes
class	EndOfStreamException
class	Exception
class	FileOpenException
class	FrameDecodeException
class	UnsupportedCodecException

Public Member Functions
	VidFile () throw ()
	~VidFile ()
bool	isOpen () const throw ()
void	open (const std::string &path, size_t maxDimension=65535, bool forcePOT=false) throw (Exception)
void	close () throw ()
bool	seek (float time) throw (Exception)
float	getFrameRate () const throw ()
float	getDuration () const throw ()
int	getWidth () const throw ()
int	getHeight () const throw ()
void *	getFrameBuffer () const throw ()
int	getFrameBufferStride () const throw ()

Detailed Description

Definition at line 13 of file vid_file.h.

Constructor & Destructor Documentation

VidFile::VidFile	(	)
throw	(
	)

Definition at line 380 of file vid_file.cpp.

                          :
    impl( NULL )
{}

VidFile::~VidFile

(

)

Definition at line 384 of file vid_file.cpp.

{
    if (impl)
        delete impl;
}

Member Function Documentation

void VidFile::close	(	)
throw	(
	)

Definition at line 405 of file vid_file.cpp.

{
    if (impl) {
        delete impl;
        impl = 0;
    }
}

float VidFile::getDuration	(	)		const
throw	(
	)

Definition at line 418 of file vid_file.cpp.

Referenced by AnimatedTexture::LoadVideoSource().

{
    return impl ? impl->duration : 0;
}

void * VidFile::getFrameBuffer	(	)		const
throw	(
	)

Definition at line 433 of file vid_file.cpp.

Referenced by AnimatedTexture::LoadVideoSource().

{
    return impl ? impl->frameBuffer : 0;
}

int VidFile::getFrameBufferStride	(	)		const
throw	(
	)

Definition at line 438 of file vid_file.cpp.

{
    return impl ? impl->frameBufferStride : 0;
}

float VidFile::getFrameRate	(	)		const
throw	(
	)

Definition at line 413 of file vid_file.cpp.

Referenced by AnimatedTexture::LoadVideoSource().

{
    return impl ? impl->frameRate : 0;
}

int VidFile::getHeight	(	)		const
throw	(
	)

Definition at line 428 of file vid_file.cpp.

Referenced by AnimatedTexture::LoadVideoSource().

{
    return impl ? impl->height : 0;
}

int VidFile::getWidth	(	)		const
throw	(
	)

Definition at line 423 of file vid_file.cpp.

Referenced by AnimatedTexture::LoadVideoSource().

{
    return impl ? impl->width : 0;
}

bool VidFile::isOpen	(	)		const
throw	(
	)

Definition at line 390 of file vid_file.cpp.

{
    return impl != NULL;
}

void VidFile::open	(	const std::string &	path,
		size_t	maxDimension = 65535,
		bool	forcePOT = false
	)
throw	(	Exception
	)

Definition at line 395 of file vid_file.cpp.

Referenced by AnimatedTexture::LoadVideoSource().

{
#ifdef HAVE_FFMPEG
    if (!impl)
        impl = new VidFileImpl( maxDimension, forcePOT );
    if (impl)
        impl->open( path );
#endif
}

bool VidFile::seek	(	float	time)
throw	(	Exception
	)

Seeks to the specified time true if frame changed, false otherwise. EndOfStreamException when time lays past the end. FrameDecodeException when an error occurs during frame decode.

Definition at line 443 of file vid_file.cpp.

Referenced by AnimatedTexture::MakeActive().

{
    return (impl != 0) && impl->seek( time );
}

---

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

• src/gfx/vid_file.h
• src/gfx/vid_file.cpp