OPAL  Version 3.10.10
PluginCodec_MediaFormat Class Referenceabstract

#include <opalplugin.hpp>

Public Types

typedef struct PluginCodec_Option const *const * OptionsTable
 
typedef std::map< std::string, std::string > OptionMap
 

Public Member Functions

virtual ~PluginCodec_MediaFormat ()
 
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 &original, OptionMap &changed)=0
 Adjust normalised options calculated from codec specific options. More...
 
virtual bool ToCustomised (OptionMap &original, OptionMap &changed)=0
 
virtual void AdjustForVersion (unsigned version, const PluginCodec_Definition *)
 

Static Public Member Functions

static void Change (const char *value, OptionMap &original, OptionMap &changed, const char *option)
 
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 (unsigned value, OptionMap &original, OptionMap &changed, const char *option)
 
static void ClampMax (unsigned maximum, OptionMap &original, OptionMap &changed, const char *option)
 
static void ClampMin (unsigned minimum, OptionMap &original, OptionMap &changed, const char *option)
 
static void AdjustAllForVersion (unsigned version, const PluginCodec_Definition *definitions, size_t size)
 

Protected Member Functions

 PluginCodec_MediaFormat (OptionsTable options)
 

Protected Attributes

OptionsTable m_options
 

Member Typedef Documentation

◆ OptionMap

typedef std::map<std::string, std::string> PluginCodec_MediaFormat::OptionMap

◆ OptionsTable

Constructor & Destructor Documentation

◆ PluginCodec_MediaFormat()

PluginCodec_MediaFormat::PluginCodec_MediaFormat ( OptionsTable  options)
inlineprotected

◆ ~PluginCodec_MediaFormat()

virtual PluginCodec_MediaFormat::~PluginCodec_MediaFormat ( )
inlinevirtual

Member Function Documentation

◆ AdjustAllForVersion()

static void PluginCodec_MediaFormat::AdjustAllForVersion ( unsigned  version,
const PluginCodec_Definition definitions,
size_t  size 
)
inlinestatic

◆ AdjustForVersion()

virtual void PluginCodec_MediaFormat::AdjustForVersion ( unsigned  version,
const PluginCodec_Definition  
)
inlinevirtual

◆ AdjustOptions()

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

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

References PTRACE, ToCustomised(), and ToNormalised().

◆ AppendUnsigned2String()

static void PluginCodec_MediaFormat::AppendUnsigned2String ( unsigned  value,
std::string &  str 
)
inlinestatic

Referenced by Unsigned2String().

◆ Change() [1/2]

static void PluginCodec_MediaFormat::Change ( const char *  value,
OptionMap original,
OptionMap changed,
const char *  option 
)
inlinestatic

◆ Change() [2/2]

static void PluginCodec_MediaFormat::Change ( unsigned  value,
OptionMap original,
OptionMap changed,
const char *  option 
)
inlinestatic

◆ ClampMax()

static void PluginCodec_MediaFormat::ClampMax ( unsigned  maximum,
OptionMap original,
OptionMap changed,
const char *  option 
)
inlinestatic

◆ ClampMin()

static void PluginCodec_MediaFormat::ClampMin ( unsigned  minimum,
OptionMap original,
OptionMap changed,
const char *  option 
)
inlinestatic

◆ GetOptionsTable()

const void* PluginCodec_MediaFormat::GetOptionsTable ( ) const
inline

References m_options.

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

◆ IsValidForProtocol()

virtual bool PluginCodec_MediaFormat::IsValidForProtocol ( const char *  )
inlinevirtual

Determine if codec is valid for the specified protocol.

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

◆ String2Unsigned()

static unsigned PluginCodec_MediaFormat::String2Unsigned ( const std::string &  str)
inlinestatic

Referenced by Change(), ClampMax(), and ClampMin().

◆ ToCustomised()

virtual bool PluginCodec_MediaFormat::ToCustomised ( OptionMap original,
OptionMap changed 
)
pure virtual

◆ ToNormalised()

virtual bool PluginCodec_MediaFormat::ToNormalised ( OptionMap original,
OptionMap changed 
)
pure virtual

Adjust normalised options calculated from codec specific options.

Referenced by AdjustOptions(), and PluginCodec< NAME >::ToNormalised().

◆ Unsigned2String()

static void PluginCodec_MediaFormat::Unsigned2String ( unsigned  value,
std::string &  str 
)
inlinestatic

References AppendUnsigned2String().

Referenced by Change(), ClampMax(), and ClampMin().

Field Documentation

◆ m_options

OptionsTable PluginCodec_MediaFormat::m_options
protected

Referenced by GetOptionsTable().


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