H3DVideoClipDecoderNode is a virtual base class for classes decoding video clips making new frames available to render. More...

#include <H3D/H3DVideoClipDecoderNode.h>

Inheritance diagram for H3D::H3DVideoClipDecoderNode:

Classes
struct	DecoderRegistration
	Class used to register a class to the registered file readers. More...

Public Types
typedef bool(*	SupportsFileFunc) (const string &url)
	Function ptr type for

Public Types inherited from H3D::Node
typedef std::map< Node , Node >	DeepCopyMap
	A map type used during a deep copy clone() to map from original nodes to cloned nodes.

Public Member Functions
	H3DVideoClipDecoderNode ()
	Constructor.

virtual bool	loadClip (const string &url)=0
	Pure virtual function to load an video clip from a url. More...

virtual bool	haveNewFrame ()=0
	Returns true when a new frame is available.

virtual void	getNewFrame (unsigned char *buffer)=0
	Get the new frame. The buffer must be at least getFrameSize() bytes.

virtual unsigned int	getFrameSize ()=0
	The size in bytes of the current frame.

virtual unsigned int	getFrameWidth ()=0
	The width in pixels of the current frame.

virtual unsigned int	getFrameHeight ()=0
	The height in pixels of the current frame.

virtual Image::PixelType	getFramePixelType ()=0
	The pixel type of the current frame.

virtual unsigned int	getFrameByteAlignment ()
	The byte alignment of each row in the buffer data from getNewFrame.

virtual Image::PixelComponentType	getFramePixelComponentType ()=0
	The pixel component type of the current frame.

virtual unsigned int	getFrameBitsPerPixel ()=0
	Get the number of bits per pixel in the current frame.

virtual void	startPlaying ()=0
	Start decoding the video clip.

virtual void	stopPlaying ()=0
	Stop decoding the video clip and set the position to the start position.

virtual void	pausePlaying ()=0
	Pause the decoding of the video clip.

virtual void	setLooping (bool on)=0
	Set whether the clip should loop and start from the start again when the end has been reached.

virtual H3DTime	getPosition ()=0
	Get the current position in the clip (in seconds from start position)

virtual void	setPosition (H3DTime pos)=0
	Set the current position in the clip(in seconds from start position)

virtual bool	setRate (double r)=0
	Set the playback rate. More...

virtual H3DTime	getDuration ()=0
	Returns the duration in seconds at normal play rate of the currently loaded video clip.

PlayStatus	getPlayStatus ()
	Returns the current play status.

virtual string	defaultXMLContainerField ()
	Returns the default xml containerField attribute value. More...

Public Member Functions inherited from H3D::Node
	Node ()
	Constructor.

virtual Node *	clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL)
	Returns a new instance of this node type with the same state as this one. More...

virtual	~Node ()
	Destructor.

X3DPrototypeInstance *	getProtoInstanceParent ()
	If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More...

void	setProtoInstanceParent (X3DPrototypeInstance *p)
	Set the X3DPrototypeInstance this node is the the root node if applicaple.

virtual void	render ()
	the render() function is used for the depth-first rendering traversal of the scene-graph. More...

virtual void	traverseSG (TraverseInfo &ti)
	traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More...

virtual bool	lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result)
	Detect intersection between a line segment and the Node. More...

virtual void	closestPoint (const Vec3f &p, NodeIntersectResult &result)
	Find closest point on Node to p. More...

virtual bool	movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)
	Detect collision between a moving sphere and the Node. More...

virtual Field *	getField (const string &_name) const
	return a pointer to the field specified by name within this instance

int	addDestructCallback (void(func)(Node , void ), void args)
	Add a callback function to be run on destruction of node. More...

int	removeDestructCallback (void(func)(Node , void ), void args)
	Add a callback function to be run on destruction of node. More...

Static Public Member Functions
static H3DVideoClipDecoderNode *	getSupportedDecoder (const string &url)
	Given an url to a file, it returns an instance of a H3DVideoClipDecoderNode class that can handle that file type. More...

static void	registerDecoder (const string &name, CreateNodeFunc create, SupportsFileFunc supports)
	Register a decoder that can then be returned by getSupportedDecoder(). More...

static void	registerDecoder (const DecoderRegistration &fr)
	Register a file reader that can then be returned by getSupportedDecoder().

Static Public Member Functions inherited from H3D::Node
static unsigned int	nrNodesAlive ()
	Returns the nr of nodes currently alive, i.e. nodes created but not destructed.

static int	nrNodesCreated ()
	Returns the number of nodes created in total since the start of the program.

Additional Inherited Members
Protected Member Functions inherited from H3D::Node
void	cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap)
	A helper function for the clone() method. More...

Static Protected Member Functions inherited from H3D::Node
static Node *	getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
	A helper function for nodes that implement clone() More...

Detailed Description

H3DVideoClipDecoderNode is a virtual base class for classes decoding video clips making new frames available to render.

Member Function Documentation

◆ defaultXMLContainerField()

virtual string H3D::H3DVideoClipDecoderNode::defaultXMLContainerField ( )

inlinevirtual

Returns the default xml containerField attribute value.

For this node it is "imageLoader".

Reimplemented from H3D::Node.

◆ getSupportedDecoder()

H3DVideoClipDecoderNode * H3DVideoClipDecoderNode::getSupportedDecoder ( const string & url )

static

Given an url to a file, it returns an instance of a H3DVideoClipDecoderNode class that can handle that file type.

If no such class is registered NULL is returns.

◆ loadClip()

virtual bool H3D::H3DVideoClipDecoderNode::loadClip ( const string & url )

pure virtual

Pure virtual function to load an video clip from a url.

Returns true on success.

Implemented in H3D::FFmpegDecoder, and H3D::DirectShowDecoder.

◆ registerDecoder()

static void H3D::H3DVideoClipDecoderNode::registerDecoder	(	const string &	name,
		CreateNodeFunc	create,
		SupportsFileFunc	supports
	)

inlinestatic

Register a decoder that can then be returned by getSupportedDecoder().

Parameters

name	The name of the class
create	A function for creating an instance of that class.
supports	A function to determine if the class supports a given file type.

◆ setRate()

virtual bool H3D::H3DVideoClipDecoderNode::setRate ( double r )

pure virtual

Set the playback rate.

A rate of 1 means normal playback speed, 2 double. Negative values means playing backwards.

Returns: true if the new rate is supported by the decoder.

Implemented in H3D::FFmpegDecoder, and H3D::DirectShowDecoder.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions