#include <opalplugin.hpp>

Inheritance diagram for PluginCodec_AudioFormat< NAME >:

Collaboration diagram for PluginCodec_AudioFormat< NAME >:

Public Types
typedef PluginCodec_MediaFormat< NAME >	Parent

typedef Parent::OptionsTable	OptionsTable

Public Types inherited from PluginCodec_MediaFormat< NAME >
typedef struct PluginCodec_Option const const	OptionsTable

typedef PluginCodec_OptionMap	OptionMap

Public Member Functions
__inline unsigned	GetSamplesPerFrame () const

__inline unsigned	GetBytesPerFrame () const

__inline unsigned	GetSampleRate () const

__inline unsigned	GetFrameTime () const

__inline unsigned	GetRecommendedFramesPerPacket () const

__inline unsigned	GetMaxFramesPerPacket () const

Public Member Functions inherited from PluginCodec_MediaFormat< NAME >
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

Protected Member Functions
	PluginCodec_AudioFormat (const char formatName, const char payloadName, const char *description, unsigned samplesPerFrame, unsigned bytesPerFrame, unsigned sampleRate=8000, OptionsTable options=NULL)

__inline PluginCodec_AudioFormat &	SetFlags (unsigned b, unsigned m=0)

__inline PluginCodec_AudioFormat &	SetPayloadType (unsigned p)

__inline PluginCodec_AudioFormat &	SetH323Capability (unsigned type, const void *data=NULL)

__inline PluginCodec_AudioFormat &	SetMaxFramesPerPacket (unsigned p)

__inline PluginCodec_AudioFormat &	SetChannels (unsigned n)

Protected Member Functions inherited from 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)

Protected Attributes
unsigned	m_samplesPerFrame

unsigned	m_bytesPerFrame

unsigned	m_sampleRate

unsigned	m_recommendedFramesPerPacket

unsigned	m_maxFramesPerPacket

unsigned	m_frameTime

Protected Attributes inherited from PluginCodec_MediaFormat< NAME >
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

Additional Inherited Members
Static Public Member Functions inherited from PluginCodec_MediaFormat< NAME >
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)

Member Typedef Documentation

template<typename NAME >

typedef Parent::OptionsTable PluginCodec_AudioFormat< NAME >::OptionsTable

template<typename NAME >

typedef PluginCodec_MediaFormat<NAME> PluginCodec_AudioFormat< NAME >::Parent

Constructor & Destructor Documentation

template<typename NAME >

PluginCodec_AudioFormat< NAME >::PluginCodec_AudioFormat	(	const char *	formatName,
		const char *	payloadName,
		const char *	description,
		unsigned	samplesPerFrame,
		unsigned	bytesPerFrame,
		unsigned	sampleRate = `8000`,
		OptionsTable	options = `NULL`
	)