OPAL  Version 3.18.8
PluginVideoEncoder< NAME > Class Template Reference

#include <opalplugin.hpp>

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

Public Member Functions

 PluginVideoEncoder (const PluginCodec_Definition *defn)
 
virtual size_t GetOutputDataSize ()
 Get the required output buffer size to be passed into Transcode. More...
 
virtual bool SetOption (const char *optionName, const char *optionValue)
 Set an individual option of the given name. More...
 
virtual bool GetActiveOptions (PluginCodec_OptionMap &options)
 Get options that are "active" and may be different from the last SetOptions() call. More...
 
virtual size_t GetPacketSpace (const PluginCodec_RTP &rtp, size_t total)
 
- Public Member Functions inherited from PluginVideoCodec< NAME >
 PluginVideoCodec (const PluginCodec_Definition *defn)
 
virtual int GetStatistics (char *bufferPtr, unsigned bufferSize)
 Gather any statistics as a string into the provide buffer. More...
 
virtual size_t GetRawFrameSize (unsigned width, unsigned height)
 
__inline unsigned GetMaxWidth () const
 
__inline unsigned GetMaxHeight () const
 
__inline unsigned GetWidth () const
 
__inline unsigned GetHeight () const
 
- 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 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...
 
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)
 

Protected Attributes

unsigned m_maxRTPSize
 
unsigned m_tsto
 
unsigned m_keyFramePeriod
 
- Protected Attributes inherited from PluginVideoCodec< NAME >
unsigned m_maxWidth
 
unsigned m_maxHeight
 
unsigned m_width
 
unsigned m_height
 
- Protected Attributes inherited from PluginCodec< NAME >
const PluginCodec_Definitionm_definition
 
bool m_optionsSame
 
unsigned m_maxBitRate
 
unsigned m_frameTime
 

Additional Inherited Members

- Public Types inherited from PluginVideoCodec< NAME >
enum  { DefaultWidth = 352, DefaultHeight = 288 }
 
- Public Types inherited from PluginCodec< NAME >
typedef
PluginCodec_MediaFormat< NAME > 
MediaFormat
 
- 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 ()
 
- 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 inherited from PluginCodec< NAME >
 PluginCodec (const PluginCodec_Definition *defn)
 

Constructor & Destructor Documentation

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

Member Function Documentation

template<typename NAME >
virtual bool PluginVideoEncoder< NAME >::GetActiveOptions ( PluginCodec_OptionMap options)
inlinevirtual

Get options that are "active" and may be different from the last SetOptions() call.

Reimplemented from PluginCodec< NAME >.

References PluginCodec< NAME >::m_frameTime, PLUGINCODEC_OPTION_FRAME_TIME, and PluginCodec_OptionMap::SetUnsigned().

template<typename NAME >
virtual size_t PluginVideoEncoder< NAME >::GetOutputDataSize ( )
inlinevirtual

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

Reimplemented from PluginCodec< NAME >.

References PluginVideoEncoder< NAME >::m_maxRTPSize.

template<typename NAME >
virtual size_t PluginVideoEncoder< NAME >::GetPacketSpace ( const PluginCodec_RTP rtp,
size_t  total 
)
inlinevirtual

Field Documentation

template<typename NAME >
unsigned PluginVideoEncoder< NAME >::m_keyFramePeriod
protected
template<typename NAME >
unsigned PluginVideoEncoder< NAME >::m_tsto
protected

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