OPAL  Version 3.12.9
PluginVideoCodec< NAME > Class Template Reference

#include <opalplugin.hpp>

Inheritance diagram for PluginVideoCodec< NAME >:
Collaboration diagram for PluginVideoCodec< NAME >:

Public Types

enum  { DefaultWidth = 352, DefaultHeight = 288, MaxWidth = DefaultWidth*8, MaxHeight = DefaultHeight*8 }
 
- Public Types inherited from PluginCodec< NAME >
typedef
PluginCodec_MediaFormat< NAME > 
MediaFormat
 

Public Member Functions

 PluginVideoCodec (const PluginCodec_Definition *defn)
 
virtual size_t GetRawFrameSize (unsigned width, unsigned height)
 
- Public Member Functions inherited from PluginCodec< NAME >
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 GetActiveOptions (PluginCodec_OptionMap &)
 Get options that are "active" and may be different from the last SetOptions() call. More...
 
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 the 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)
 

Additional Inherited Members

- Static Public Member Functions inherited from PluginCodec< NAME >
static bool Terminate ()
 
template<class CodecClass >
static void * Create_s (const PluginCodec_Definition *defn)
 
static void Destroy_s (const PluginCodec_Definition *, void *context)
 
static int Transcode_s (const PluginCodec_Definition *, void *context, const void *fromPtr, unsigned *fromLen, void *toPtr, unsigned *toLen, unsigned int *flags)
 
static int GetOutputDataSize_s (const PluginCodec_Definition *, void *context, const char *, void *, unsigned *)
 
static int ToNormalised_s (const PluginCodec_Definition *defn, void *, const char *, void *parm, unsigned *len)
 
static int ToCustomised_s (const PluginCodec_Definition *defn, void *, const char *, void *parm, unsigned *len)
 
static int GetActiveOptions_s (const PluginCodec_Definition *, void *context, const char *, void *parm, unsigned *parmLen)
 
static int FreeOptions_s (const PluginCodec_Definition *, void *, const char *, void *parm, unsigned *len)
 
static int GetOptions_s (const struct PluginCodec_Definition *codec, void *, const char *, void *parm, unsigned *len)
 
static int SetOptions_s (const PluginCodec_Definition *, void *context, const char *, void *parm, unsigned *len)
 
static int ValidForProtocol_s (const PluginCodec_Definition *defn, void *, const char *, void *parm, unsigned *len)
 
static int SetInstanceID_s (const PluginCodec_Definition *, void *context, const char *, void *parm, unsigned *len)
 
static int GetStatistics_s (const PluginCodec_Definition *, void *context, const char *, void *parm, unsigned *len)
 
static int Terminate_s (const PluginCodec_Definition *, void *context, const char *, void *, unsigned *)
 
static struct
PluginCodec_ControlDefn
GetControls ()
 
- Protected Member Functions inherited from PluginCodec< NAME >
 PluginCodec (const PluginCodec_Definition *defn)
 
- Protected Attributes inherited from PluginCodec< NAME >
const PluginCodec_Definitionm_definition
 
bool m_optionsSame
 
unsigned m_maxBitRate
 
unsigned m_frameTime
 

Member Enumeration Documentation

template<typename NAME >
anonymous enum
Enumerator
DefaultWidth 
DefaultHeight 
MaxWidth 
MaxHeight 

Constructor & Destructor Documentation

template<typename NAME >
PluginVideoCodec< NAME >::PluginVideoCodec ( const PluginCodec_Definition defn)
inline

Member Function Documentation

template<typename NAME >
virtual size_t PluginVideoCodec< NAME >::GetRawFrameSize ( unsigned  width,
unsigned  height 
)
inlinevirtual

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