PluginCodec Class Reference

#include <opalplugin.hpp>

Public Member Functions
virtual	~PluginCodec ()
virtual bool	Construct ()
virtual bool	Transcode (const void *fromPtr, unsigned &fromLen, void *toPtr, unsigned &toLen, unsigned &flags)=0
virtual size_t	GetOutputDataSize ()
virtual bool	SetOptions (const char *const *options)
virtual bool	OnChangedOptions ()
virtual bool	SetOption (const char *optionName, const char *optionValue)
bool	SetOptionUnsigned (unsigned &oldValue, const char *optionValue, unsigned minimum, unsigned maximum=UINT_MAX)
bool	SetOptionBoolean (bool &oldValue, const char *optionValue)
bool	SetOptionBit (unsigned &oldValue, unsigned bit, const char *optionValue)
Static Public Member Functions
template<class CodecClass>
static void *	Create (const PluginCodec_Definition *defn)
static void	Destroy (const PluginCodec_Definition *, void *context)
static int	Transcode (const PluginCodec_Definition *, void *context, const void *fromPtr, unsigned *fromLen, void *toPtr, unsigned *toLen, unsigned int *flags)
static int	GetOutputDataSize (const PluginCodec_Definition *, void *context, const char *, void *, unsigned *)
static int	ToNormalised (const PluginCodec_Definition *defn, void *, const char *, void *parm, unsigned *len)
static int	ToCustomised (const PluginCodec_Definition *defn, void *, const char *, void *parm, unsigned *len)
static int	FreeOptions (const PluginCodec_Definition *, void *, const char *, void *parm, unsigned *len)
static int	GetOptions (const struct PluginCodec_Definition *codec, void *, const char *, void *parm, unsigned *len)
static int	SetOptions (const PluginCodec_Definition *, void *context, const char *, void *parm, unsigned *len)
Protected Member Functions
	PluginCodec (const PluginCodec_Definition *defn)
Protected Attributes
const PluginCodec_Definition *	m_definition
bool	m_optionsSame
unsigned	m_maxBitRate
unsigned	m_frameTime

---

Constructor & Destructor Documentation

PluginCodec::PluginCodec

(

const PluginCodec_Definition *

defn

)

[inline, protected]

virtual PluginCodec::~PluginCodec

(

)

[inline, virtual]

---

Member Function Documentation

virtual bool PluginCodec::Construct

(

)

[inline, virtual]

template<class CodecClass>

static void* PluginCodec::Create

(

const PluginCodec_Definition *

defn

)

[inline, static]

static void PluginCodec::Destroy	(	const PluginCodec_Definition *	,
		void *	context
	)			[inline, static]

static int PluginCodec::FreeOptions	(	const PluginCodec_Definition *	,
		void *	,
		const char *	,
		void *	parm,
		unsigned *	len
	)			[inline, static]

static int PluginCodec::GetOptions	(	const struct PluginCodec_Definition *	codec,
		void *	,
		const char *	,
		void *	parm,
		unsigned *	len
	)			[inline, static]

static int PluginCodec::GetOutputDataSize	(	const PluginCodec_Definition *	,
		void *	context,
		const char *	,
		void *	,
		unsigned *
	)			[inline, static]

virtual size_t PluginCodec::GetOutputDataSize

(

)

[inline, virtual]

virtual bool PluginCodec::OnChangedOptions

(

)

[inline, virtual]

virtual bool PluginCodec::SetOption	(	const char *	optionName,
		const char *	optionValue
	)			[inline, virtual]

bool PluginCodec::SetOptionBit	(	unsigned &	oldValue,
		unsigned	bit,
		const char *	optionValue
	)			[inline]

bool PluginCodec::SetOptionBoolean	(	bool &	oldValue,
		const char *	optionValue
	)			[inline]

static int PluginCodec::SetOptions	(	const PluginCodec_Definition *	,
		void *	context,
		const char *	,
		void *	parm,
		unsigned *	len
	)			[inline, static]

virtual bool PluginCodec::SetOptions

(

const char *const *

options

)

[inline, virtual]

bool PluginCodec::SetOptionUnsigned	(	unsigned &	oldValue,
		const char *	optionValue,
		unsigned	minimum,
		unsigned	maximum = UINT_MAX
	)			[inline]

static int PluginCodec::ToCustomised	(	const PluginCodec_Definition *	defn,
		void *	,
		const char *	,
		void *	parm,
		unsigned *	len
	)			[inline, static]

static int PluginCodec::ToNormalised	(	const PluginCodec_Definition *	defn,
		void *	,
		const char *	,
		void *	parm,
		unsigned *	len
	)			[inline, static]

static int PluginCodec::Transcode	(	const PluginCodec_Definition *	,
		void *	context,
		const void *	fromPtr,
		unsigned *	fromLen,
		void *	toPtr,
		unsigned *	toLen,
		unsigned int *	flags
	)			[inline, static]

virtual bool PluginCodec::Transcode	(	const void *	fromPtr,
		unsigned &	fromLen,
		void *	toPtr,
		unsigned &	toLen,
		unsigned &	flags
	)			[pure virtual]

---

Field Documentation

const PluginCodec_Definition* PluginCodec::m_definition [protected]

unsigned PluginCodec::m_frameTime [protected]

unsigned PluginCodec::m_maxBitRate [protected]

bool PluginCodec::m_optionsSame [protected]

---

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

• opalplugin.hpp

---