PluginCodec_MediaFormat< NAME > Class Template Reference

#include <opalplugin.hpp>

Inheritance diagram for PluginCodec_MediaFormat< NAME >:

Collaboration diagram for PluginCodec_MediaFormat< NAME >:

Public Types
typedef struct PluginCodec_Option const *const *	OptionsTable
typedef PluginCodec_OptionMap	OptionMap

Public Member Functions
virtual	~PluginCodec_MediaFormat ()
__inline const char *	GetFormatName () const
__inline const char *	GetPayloadName () const
__inline unsigned char	GetPayloadType () const
__inline const char *	GetDescription () const
__inline unsigned	GetMaxBandwidth () const
__inline unsigned char	GetH323CapabilityType () const
__inline const void *	GetH323CapabilityData () const
__inline unsigned	GetFlags () const
__inline const void *	GetOptionsTable () const
virtual bool	IsValidForProtocol (const char *)
	Determine if codec is valid for the specified protocol. More...
bool	AdjustOptions (void *parm, unsigned *parmLen, bool(PluginCodec_MediaFormat::*adjuster)(OptionMap &original, OptionMap &changed))
	Utility function to adjust option strings, used by ToNormalised()/ToCustomised(). More...
virtual bool	ToNormalised (OptionMap &, OptionMap &)
	Adjust normalised options calculated from codec specific options. More...
virtual bool	ToCustomised (OptionMap &, OptionMap &)
virtual void	AdjustForVersion (unsigned version, const PluginCodec_Definition *)

Static Public Member Functions
static void	AdjustAllForVersion (unsigned version, const PluginCodec_Definition *definitions, size_t size)
Static Public Member Functions inherited from PluginCodec_Utilities
static unsigned	String2Unsigned (const std::string &str)
static void	AppendUnsigned2String (unsigned value, std::string &str)
static void	Unsigned2String (unsigned value, std::string &str)
static void	Change (const char *value, PluginCodec_OptionMapBase &original, PluginCodec_OptionMapBase &changed, const char *option)
static void	Change (unsigned value, PluginCodec_OptionMapBase &original, PluginCodec_OptionMapBase &changed, const char *option)
static void	ClampMax (unsigned maximum, PluginCodec_OptionMapBase &original, PluginCodec_OptionMapBase &changed, const char *option, bool forceIfZero=false)
static void	ClampMin (unsigned minimum, PluginCodec_OptionMapBase &original, PluginCodec_OptionMapBase &changed, const char *option)
static unsigned	GetMacroBlocks (unsigned width, unsigned height)
static bool	ClampResolution (unsigned &width, unsigned &height, unsigned &maxFrameSize)

Protected Member Functions
	PluginCodec_MediaFormat (const char *formatName, const char *payloadName, const char *description, unsigned maxBandwidth, OptionsTable options)

Protected Attributes
const char *	m_formatName
const char *	m_payloadName
unsigned	m_payloadType
const char *	m_description
unsigned	m_maxBandwidth
unsigned	m_h323CapabilityType
const void *	m_h323CapabilityData
unsigned	m_flags
OptionsTable	m_options

Member Typedef Documentation

template<typename NAME >

typedef PluginCodec_OptionMap PluginCodec_MediaFormat< NAME >::OptionMap

template<typename NAME >

typedef struct PluginCodec_Option const* const* PluginCodec_MediaFormat< NAME >::OptionsTable

Constructor & Destructor Documentation

template<typename NAME >

PluginCodec_MediaFormat< NAME >::PluginCodec_MediaFormat ( const char *  formatName, const char *  payloadName, const char *  description, unsigned  maxBandwidth, OptionsTable  options  )

inlineprotected

template<typename NAME >

virtual PluginCodec_MediaFormat< NAME >::~PluginCodec_MediaFormat ( )

inlinevirtual

Member Function Documentation

template<typename NAME >

static void PluginCodec_MediaFormat< NAME >::AdjustAllForVersion ( unsigned  version, const PluginCodec_Definition *  definitions, size_t  size  )

inlinestatic

References PluginCodec_MediaFormat< NAME >::AdjustForVersion(), and PluginCodec_GetCodecFunction::userData.

template<typename NAME >

virtual void PluginCodec_MediaFormat< NAME >::AdjustForVersion ( unsigned  version, const PluginCodec_Definition *    )

inlinevirtual

References PluginCodec_MediaFormat< NAME >::m_options, PLUGIN_CODEC_VERSION_INTERSECT, and PLUGINCODEC_MEDIA_PACKETIZATIONS.

Referenced by PluginCodec_MediaFormat< NAME >::AdjustAllForVersion().

template<typename NAME >

bool PluginCodec_MediaFormat< NAME >::AdjustOptions ( void *  parm, unsigned *  parmLen, bool(PluginCodec_MediaFormat< NAME >::*)(OptionMap &original, OptionMap &changed)  adjuster  )

inline

Utility function to adjust option strings, used by ToNormalised()/ToCustomised().

References PluginCodec_OptionMap::GetOptions(), and PTRACE.

template<typename NAME >

__inline const char* PluginCodec_MediaFormat< NAME >::GetDescription ( ) const

inline

References PluginCodec_MediaFormat< NAME >::m_description.

template<typename NAME >

__inline unsigned PluginCodec_MediaFormat< NAME >::GetFlags ( ) const

inline

References PluginCodec_MediaFormat< NAME >::m_flags.

template<typename NAME >

__inline const char* PluginCodec_MediaFormat< NAME >::GetFormatName ( ) const

inline

References PluginCodec_MediaFormat< NAME >::m_formatName.

template<typename NAME >

__inline const void* PluginCodec_MediaFormat< NAME >::GetH323CapabilityData ( ) const

inline

References PluginCodec_MediaFormat< NAME >::m_h323CapabilityData.

template<typename NAME >

__inline unsigned char PluginCodec_MediaFormat< NAME >::GetH323CapabilityType ( ) const

inline

References PluginCodec_MediaFormat< NAME >::m_h323CapabilityType.

template<typename NAME >

__inline unsigned PluginCodec_MediaFormat< NAME >::GetMaxBandwidth ( ) const

inline

References PluginCodec_MediaFormat< NAME >::m_maxBandwidth.

template<typename NAME >

__inline const void* PluginCodec_MediaFormat< NAME >::GetOptionsTable ( ) const

inline

References PluginCodec_MediaFormat< NAME >::m_options.

template<typename NAME >

__inline const char* PluginCodec_MediaFormat< NAME >::GetPayloadName ( ) const

inline

References PluginCodec_MediaFormat< NAME >::m_payloadName.

template<typename NAME >

__inline unsigned char PluginCodec_MediaFormat< NAME >::GetPayloadType ( ) const

inline

References PluginCodec_MediaFormat< NAME >::m_payloadType.

template<typename NAME >

virtual bool PluginCodec_MediaFormat< NAME >::IsValidForProtocol ( const char *  )

inlinevirtual

Determine if codec is valid for the specified protocol.

template<typename NAME >

virtual bool PluginCodec_MediaFormat< NAME >::ToCustomised ( OptionMap &  , OptionMap &    )

inlinevirtual

Referenced by PluginCodec< NAME >::ToCustomised_s().

template<typename NAME >

virtual bool PluginCodec_MediaFormat< NAME >::ToNormalised ( OptionMap &  , OptionMap &    )

inlinevirtual

Adjust normalised options calculated from codec specific options.

Referenced by PluginCodec< NAME >::ToNormalised_s().

Field Documentation

template<typename NAME >

const char* PluginCodec_MediaFormat< NAME >::m_description

protected

Referenced by PluginCodec_MediaFormat< NAME >::GetDescription().

template<typename NAME >

unsigned PluginCodec_MediaFormat< NAME >::m_flags

protected

Referenced by PluginCodec_MediaFormat< NAME >::GetFlags(), PluginCodec_AudioFormat< NAME >::PluginCodec_AudioFormat(), and PluginCodec_VideoFormat< NAME >::PluginCodec_VideoFormat().

template<typename NAME >

const char* PluginCodec_MediaFormat< NAME >::m_formatName

protected

Referenced by PluginCodec_MediaFormat< NAME >::GetFormatName().

template<typename NAME >

const void* PluginCodec_MediaFormat< NAME >::m_h323CapabilityData

protected

Referenced by PluginCodec_MediaFormat< NAME >::GetH323CapabilityData().

template<typename NAME >

unsigned PluginCodec_MediaFormat< NAME >::m_h323CapabilityType

protected

Referenced by PluginCodec_MediaFormat< NAME >::GetH323CapabilityType().

template<typename NAME >

unsigned PluginCodec_MediaFormat< NAME >::m_maxBandwidth

protected

Referenced by PluginCodec_MediaFormat< NAME >::GetMaxBandwidth().

template<typename NAME >

OptionsTable PluginCodec_MediaFormat< NAME >::m_options

protected

Referenced by PluginCodec_MediaFormat< NAME >::AdjustForVersion(), and PluginCodec_MediaFormat< NAME >::GetOptionsTable().

template<typename NAME >

const char* PluginCodec_MediaFormat< NAME >::m_payloadName

protected

Referenced by PluginCodec_MediaFormat< NAME >::GetPayloadName().

template<typename NAME >

unsigned PluginCodec_MediaFormat< NAME >::m_payloadType

protected

Referenced by PluginCodec_MediaFormat< NAME >::GetPayloadType().

---

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

• opalplugin.hpp