OPAL  Version 3.18.8
PluginCodec_MediaFormat< NAME > Class Template Referenceabstract

#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 * GetRawFormat () const
 
__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
 
__inline void SetFlags (unsigned b, unsigned m=0)
 
__inline void SetPayloadType (unsigned p)
 
__inline void SetH323Capability (unsigned type, const void *data=NULL)
 
virtual bool IsValidForProtocol (const char *) const =0
 Determine if codec is valid for the specified protocol. More...
 
bool AdjustOptions (void *parm, unsigned *parmLen, bool(PluginCodec_MediaFormat::*adjuster)(OptionMap &original, OptionMap &changed) const) const
 Utility function to adjust option strings, used by ToNormalised()/ToCustomised(). More...
 
virtual bool ToNormalised (OptionMap &, OptionMap &) const =0
 Adjust normalised options calculated from codec specific options. More...
 
virtual bool ToCustomised (OptionMap &, OptionMap &) const =0
 
virtual void AdjustForVersion (unsigned version, const PluginCodec_Definition *) const
 

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)
 
static bool ClampResolution (PluginCodec_OptionMapBase &original, PluginCodec_OptionMapBase &changed, unsigned maxWidth, unsigned maxHeight, unsigned &maxMacroBlocks, const char *widthKey=PLUGINCODEC_OPTION_FRAME_WIDTH, const char *heightKey=PLUGINCODEC_OPTION_FRAME_HEIGHT, const char *maxWidthKey=PLUGINCODEC_OPTION_MAX_RX_FRAME_WIDTH, const char *maxHeightKey=PLUGINCODEC_OPTION_MAX_RX_FRAME_HEIGHT, const char *minWidthKey=PLUGINCODEC_OPTION_MIN_RX_FRAME_WIDTH, const char *minHeightKey=PLUGINCODEC_OPTION_MIN_RX_FRAME_HEIGHT)
 

Protected Member Functions

 PluginCodec_MediaFormat (const char *rawFormat, const char *formatName, const char *payloadName, const char *description, unsigned maxBandwidth, OptionsTable options, unsigned flags=PluginCodec_RTPTypeDynamic)
 

Protected Attributes

const char * m_rawFormat
 
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 *  rawFormat,
const char *  formatName,
const char *  payloadName,
const char *  description,
unsigned  maxBandwidth,
OptionsTable  options,
unsigned  flags = PluginCodec_RTPTypeDynamic 
)
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
template<typename NAME >
virtual void PluginCodec_MediaFormat< NAME >::AdjustForVersion ( unsigned  version,
const PluginCodec_Definition  
) const
inlinevirtual
template<typename NAME >
bool PluginCodec_MediaFormat< NAME >::AdjustOptions ( void *  parm,
unsigned *  parmLen,
bool(PluginCodec_MediaFormat< NAME >::*)(OptionMap &original, OptionMap &changed) const  adjuster 
) const
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
template<typename NAME >
__inline unsigned PluginCodec_MediaFormat< NAME >::GetFlags ( ) const
inline
template<typename NAME >
__inline const char* PluginCodec_MediaFormat< NAME >::GetFormatName ( ) const
inline
template<typename NAME >
__inline const void* PluginCodec_MediaFormat< NAME >::GetH323CapabilityData ( ) const
inline
template<typename NAME >
__inline unsigned char PluginCodec_MediaFormat< NAME >::GetH323CapabilityType ( ) const
inline
template<typename NAME >
__inline unsigned PluginCodec_MediaFormat< NAME >::GetMaxBandwidth ( ) const
inline
template<typename NAME >
__inline const void* PluginCodec_MediaFormat< NAME >::GetOptionsTable ( ) const
inline
template<typename NAME >
__inline const char* PluginCodec_MediaFormat< NAME >::GetPayloadName ( ) const
inline
template<typename NAME >
__inline unsigned char PluginCodec_MediaFormat< NAME >::GetPayloadType ( ) const
inline
template<typename NAME >
__inline const char* PluginCodec_MediaFormat< NAME >::GetRawFormat ( ) const
inline
template<typename NAME >
virtual bool PluginCodec_MediaFormat< NAME >::IsValidForProtocol ( const char *  ) const
pure virtual

Determine if codec is valid for the specified protocol.

template<typename NAME >
__inline void PluginCodec_MediaFormat< NAME >::SetFlags ( unsigned  b,
unsigned  m = 0 
)
inline
template<typename NAME >
__inline void PluginCodec_MediaFormat< NAME >::SetH323Capability ( unsigned  type,
const void *  data = NULL 
)
inline
template<typename NAME >
virtual bool PluginCodec_MediaFormat< NAME >::ToCustomised ( OptionMap ,
OptionMap  
) const
pure virtual
template<typename NAME >
virtual bool PluginCodec_MediaFormat< NAME >::ToNormalised ( OptionMap ,
OptionMap  
) const
pure virtual

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
template<typename NAME >
const char* PluginCodec_MediaFormat< NAME >::m_formatName
protected
template<typename NAME >
const void* PluginCodec_MediaFormat< NAME >::m_h323CapabilityData
protected
template<typename NAME >
unsigned PluginCodec_MediaFormat< NAME >::m_h323CapabilityType
protected
template<typename NAME >
unsigned PluginCodec_MediaFormat< NAME >::m_maxBandwidth
protected
template<typename NAME >
const char* PluginCodec_MediaFormat< NAME >::m_payloadName
protected
template<typename NAME >
unsigned PluginCodec_MediaFormat< NAME >::m_payloadType
protected
template<typename NAME >
const char* PluginCodec_MediaFormat< NAME >::m_rawFormat
protected

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