OPAL  Version 3.10.10
PluginCodec< NAME > Class Template Referenceabstract

#include <opalplugin.hpp>

Public Member Functions

virtual ~PluginCodec ()
 
virtual bool Construct ()
 Complete construction of the plug in codec. More...
 
virtual bool Transcode (const void *fromPtr, unsigned &fromLen, void *toPtr, unsigned &toLen, unsigned &flags)=0
 Convert from one media format to another. More...
 
virtual bool GetStatistics (char *, unsigned)
 Gather any statistics as a string into the provide buffer. More...
 
virtual size_t GetOutputDataSize ()
 Get the required output buffer size to be passed into Transcode. More...
 
virtual bool SetInstanceID (const char *, unsigned)
 
virtual bool SetOptions (const char *const *options)
 Set all the options for the codec. More...
 
virtual bool OnChangedOptions ()
 Callback for if any options are changed. More...
 
virtual bool SetOption (const char *optionName, const char *optionValue)
 Set an individual option of teh given name. More...
 
template<typename T >
bool SetOptionUnsigned (T &oldValue, const char *optionValue, unsigned minimum, unsigned maximum=UINT_MAX)
 
bool SetOptionUnsigned (unsigned &oldValue, const char *optionValue, unsigned minimum, unsigned maximum=UINT_MAX)
 
template<typename T >
bool SetOptionBoolean (T &oldValue, const char *optionValue)
 
bool SetOptionBoolean (bool &oldValue, const char *optionValue)
 
bool SetOptionBit (int &oldValue, unsigned bit, const char *optionValue)
 
bool SetOptionBit (unsigned &oldValue, unsigned bit, const char *optionValue)
 

Static Public Member Functions

static bool Terminate ()
 
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)
 
static int ValidForProtocol (const PluginCodec_Definition *defn, void *, const char *, void *parm, unsigned *len)
 
static int SetInstanceID (const PluginCodec_Definition *, void *context, const char *, void *parm, unsigned *len)
 
static int GetStatistics (const PluginCodec_Definition *, void *context, const char *, void *parm, unsigned *len)
 
static int Terminate (const PluginCodec_Definition *, void *context, const char *, void *, unsigned *)
 
static struct
PluginCodec_ControlDefn
GetControls ()
 

Protected Member Functions

 PluginCodec (const PluginCodec_Definition *defn)
 

Protected Attributes

const PluginCodec_Definitionm_definition
 
bool m_optionsSame
 
unsigned m_maxBitRate
 
unsigned m_frameTime
 

Constructor & Destructor Documentation

template<typename NAME >
virtual PluginCodec< NAME >::~PluginCodec ( )
inlinevirtual

Member Function Documentation

template<typename NAME >
virtual bool PluginCodec< NAME >::Construct ( )
inlinevirtual

Complete construction of the plug in codec.

template<typename NAME >
template<class CodecClass >
static void* PluginCodec< NAME >::Create ( const PluginCodec_Definition defn)
inlinestatic

References PTRACE.

template<typename NAME >
static void PluginCodec< NAME >::Destroy ( const PluginCodec_Definition ,
void *  context 
)
inlinestatic
template<typename NAME >
static int PluginCodec< NAME >::FreeOptions ( const PluginCodec_Definition ,
void *  ,
const char *  ,
void *  parm,
unsigned *  len 
)
inlinestatic
template<typename NAME >
static int PluginCodec< NAME >::GetOptions ( const struct PluginCodec_Definition codec,
void *  ,
const char *  ,
void *  parm,
unsigned *  len 
)
inlinestatic
template<typename NAME >
virtual size_t PluginCodec< NAME >::GetOutputDataSize ( )
inlinevirtual

Get the required output buffer size to be passed into Transcode.

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

template<typename NAME >
static int PluginCodec< NAME >::GetOutputDataSize ( const PluginCodec_Definition ,
void *  context,
const char *  ,
void *  ,
unsigned *   
)
inlinestatic
template<typename NAME >
virtual bool PluginCodec< NAME >::GetStatistics ( char *  ,
unsigned   
)
inlinevirtual

Gather any statistics as a string into the provide buffer.

Referenced by PluginCodec< NAME >::GetControls(), and PluginCodec< NAME >::GetStatistics().

template<typename NAME >
static int PluginCodec< NAME >::GetStatistics ( const PluginCodec_Definition ,
void *  context,
const char *  ,
void *  parm,
unsigned *  len 
)
inlinestatic
template<typename NAME >
virtual bool PluginCodec< NAME >::OnChangedOptions ( )
inlinevirtual

Callback for if any options are changed.

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

template<typename NAME >
virtual bool PluginCodec< NAME >::SetInstanceID ( const char *  ,
unsigned   
)
inlinevirtual

Set the instance ID for the codec. This is used to match up the encode and decoder pairs of instances for a given call. While most codecs like G.723.1 are purely unidirectional, some a bidirectional and have information flow between encoder and decoder.

Referenced by PluginCodec< NAME >::GetControls(), and PluginCodec< NAME >::SetInstanceID().

template<typename NAME >
static int PluginCodec< NAME >::SetInstanceID ( const PluginCodec_Definition ,
void *  context,
const char *  ,
void *  parm,
unsigned *  len 
)
inlinestatic
template<typename NAME >
virtual bool PluginCodec< NAME >::SetOption ( const char *  optionName,
const char *  optionValue 
)
inlinevirtual
template<typename NAME >
bool PluginCodec< NAME >::SetOptionBit ( int &  oldValue,
unsigned  bit,
const char *  optionValue 
)
inline
template<typename NAME >
bool PluginCodec< NAME >::SetOptionBit ( unsigned &  oldValue,
unsigned  bit,
const char *  optionValue 
)
inline
template<typename NAME >
template<typename T >
bool PluginCodec< NAME >::SetOptionBoolean ( T &  oldValue,
const char *  optionValue 
)
inline
template<typename NAME >
bool PluginCodec< NAME >::SetOptionBoolean ( bool &  oldValue,
const char *  optionValue 
)
inline
template<typename NAME >
virtual bool PluginCodec< NAME >::SetOptions ( const char *const *  options)
inlinevirtual
template<typename NAME >
static int PluginCodec< NAME >::SetOptions ( const PluginCodec_Definition ,
void *  context,
const char *  ,
void *  parm,
unsigned *  len 
)
inlinestatic
template<typename NAME >
template<typename T >
bool PluginCodec< NAME >::SetOptionUnsigned ( T &  oldValue,
const char *  optionValue,
unsigned  minimum,
unsigned  maximum = UINT_MAX 
)
inline
template<typename NAME >
bool PluginCodec< NAME >::SetOptionUnsigned ( unsigned &  oldValue,
const char *  optionValue,
unsigned  minimum,
unsigned  maximum = UINT_MAX 
)
inline
template<typename NAME >
static bool PluginCodec< NAME >::Terminate ( )
inlinestatic

Terminate operation of plug in codec. This is generally not needed but sometimes (e.g. fax) there is some clean up required to be done on completion of the codec run.

Referenced by PluginCodec< NAME >::GetControls(), and PluginCodec< NAME >::Terminate().

template<typename NAME >
static int PluginCodec< NAME >::Terminate ( const PluginCodec_Definition ,
void *  context,
const char *  ,
void *  ,
unsigned *   
)
inlinestatic
template<typename NAME >
static int PluginCodec< NAME >::ToCustomised ( const PluginCodec_Definition defn,
void *  ,
const char *  ,
void *  parm,
unsigned *  len 
)
inlinestatic
template<typename NAME >
static int PluginCodec< NAME >::ToNormalised ( const PluginCodec_Definition defn,
void *  ,
const char *  ,
void *  parm,
unsigned *  len 
)
inlinestatic
template<typename NAME >
virtual bool PluginCodec< NAME >::Transcode ( const void *  fromPtr,
unsigned &  fromLen,
void *  toPtr,
unsigned &  toLen,
unsigned &  flags 
)
pure virtual

Convert from one media format to another.

template<typename NAME >
static int PluginCodec< NAME >::Transcode ( const PluginCodec_Definition ,
void *  context,
const void *  fromPtr,
unsigned *  fromLen,
void *  toPtr,
unsigned *  toLen,
unsigned int *  flags 
)
inlinestatic

References PTRACE.

template<typename NAME >
static int PluginCodec< NAME >::ValidForProtocol ( const PluginCodec_Definition defn,
void *  ,
const char *  ,
void *  parm,
unsigned *  len 
)
inlinestatic

Field Documentation

template<typename NAME >
const PluginCodec_Definition* PluginCodec< NAME >::m_definition
protected
template<typename NAME >
unsigned PluginCodec< NAME >::m_frameTime
protected
template<typename NAME >
unsigned PluginCodec< NAME >::m_maxBitRate
protected

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