OPAL  Version 3.18.8
Data Structures | Macros | Typedefs | Functions | Variables
opalplugin.hpp File Reference
#include "opalplugin.h"
#include <string.h>
#include <stdlib.h>
#include <limits.h>
#include <stdio.h>
#include <map>
#include <string>
#include <sstream>
Include dependency graph for opalplugin.hpp:

Go to the source code of this file.

Data Structures

class  PluginCodec_RTP
 
class  PluginCodec_Utilities
 
class  PluginCodec_OptionMap
 
class  PluginCodec_MediaFormat< NAME >
 
class  PluginCodec_AudioFormat< NAME >
 
class  PluginCodec_VideoFormat< NAME >
 
class  PluginCodec< NAME >
 
class  PluginVideoCodec< NAME >
 
class  PluginVideoEncoder< NAME >
 
class  PluginVideoDecoder< NAME >
 
struct  PluginVideoDecoder< NAME >::OutputImagePlaneInfo
 

Macros

#define PLUGINCODEC_TRACING   1
 
#define PLUGINCODEC_CONTROL_LOG_FUNCTION_DEF
 
#define PLUGINCODEC_CONTROL_LOG_FUNCTION_INC   { PLUGINCODEC_CONTROL_SET_LOG_FUNCTION, PluginCodec_SetLogFunction },
 
#define PTRACE_CHECK(level)   (PluginCodec_LogFunctionInstance != NULL && PluginCodec_LogFunctionInstance(level, NULL, 0, NULL, NULL))
 
#define PTRACE(level, section, args)
 
#define OPAL_PLUGIN_CLAMPED_RESOLUTION(width, height)   { width, height, ((width+15)/16) * ((height+15)/16) }
 
#define PLUGINCODEC_KNOWN_CODEC_CXX(MediaType,Name,Description,EncoderClass,DecoderClass)
 Declare a "known by OPAL" codec using C++ support classes. More...
 
#define PLUGINCODEC_AUDIO_CODEC_CXX(MediaFormat,EncoderClass,DecoderClass)
 Declare an audio codec using C++ support classes. More...
 
#define PLUGINCODEC_VIDEO_CODEC_CXX(MediaFormat,EncoderClass,DecoderClass)
 Declare a video codec using C++ support classes. More...
 
#define PLUGIN_CODEC_IMPLEMENT_CXX(NAME, table)
 

Typedefs

typedef std::map< std::string,
std::string > 		PluginCodec_OptionMapBase
 

Functions

int PluginCodec_SetLogFunction (const PluginCodec_Definition *, void *, const char *, void *parm, unsigned *len)
 

Variables

PluginCodec_LogFunction PluginCodec_LogFunctionInstance
 

Macro Definition Documentation

#define OPAL_PLUGIN_CLAMPED_RESOLUTION (   width,
  height 
)    { width, height, ((width+15)/16) * ((height+15)/16) }

Referenced by PluginCodec_Utilities::ClampResolution().

#define PLUGIN_CODEC_IMPLEMENT_CXX (   NAME,
  table 
)
Value:
extern "C" { \
PLUGIN_CODEC_IMPLEMENT(NAME) \
PLUGIN_CODEC_DLL_API struct PluginCodec_Definition * PLUGIN_CODEC_GET_CODEC_FN(unsigned * count, unsigned version) { \
if (version < PLUGIN_CODEC_VERSION_OPTIONS) return NULL; \
*count = sizeof(table)/sizeof(struct PluginCodec_Definition); \
PluginCodec_MediaFormat<NAME>::AdjustAllForVersion(version, table, *count); \
return table; \
} \
}
PluginCodec_Definition
Definition: opalplugin.h:339
PLUGIN_CODEC_GET_CODEC_FN
#define PLUGIN_CODEC_GET_CODEC_FN
Definition: opalplugin.h:95
PluginCodec_MediaFormat
Definition: opalplugin.hpp:424
PLUGIN_CODEC_IMPLEMENT
#define PLUGIN_CODEC_IMPLEMENT(name)
Definition: opalplugin.h:1004
PluginCodec_Definition::version
unsigned int version
Definition: opalplugin.h:340
PLUGIN_CODEC_VERSION_OPTIONS
#define PLUGIN_CODEC_VERSION_OPTIONS
Definition: opalplugin.h:86
PLUGIN_CODEC_DLL_API
#define PLUGIN_CODEC_DLL_API
Definition: opalplugin.h:73
#define PLUGINCODEC_AUDIO_CODEC_CXX (   MediaFormat,
  EncoderClass,
  DecoderClass 
)
Value:
PLUGINCODEC_CODEC_PAIR(MediaFormat.GetFormatName(), \
MediaFormat.GetPayloadName(), \
MediaFormat.GetDescription(), \
MediaFormat.GetSampleRate(), \
MediaFormat.GetMaxBandwidth(), \
MediaFormat.GetFrameTime(), \
MediaFormat.GetSamplesPerFrame(), \
MediaFormat.GetBytesPerFrame(), \
MediaFormat.GetRecommendedFramesPerPacket(), \
MediaFormat.GetMaxFramesPerPacket(), \
MediaFormat.GetPayloadType(), \
MediaFormat.GetH323CapabilityType(), \
MediaFormat.GetH323CapabilityData(), \
EncoderClass::Create_s<EncoderClass>, \
EncoderClass::Destroy_s, \
EncoderClass::Transcode_s, \
DecoderClass::Create_s<DecoderClass>, \
DecoderClass::Destroy_s, \
DecoderClass::Transcode_s, \
DecoderClass::GetControls(), /* Note doesn't matter if encoder or decoder */ \
MediaFormat.GetFlags(), \
MediaFormat.GetRawFormat(), \
&MediaFormat)
PLUGINCODEC_CODEC_PAIR
#define PLUGINCODEC_CODEC_PAIR(MediaFormat,PayloadName,Description,SampleRate,BitsPerSecond,FrameTime,p1, p2, p3, p4, PayloadType,H323type,H323data,CreateEncoder,DestroyEncoder, EncodeMedia,CreateDecoder,DestroyDecoder, DecodeMedia,ControlsTable,Flags,RawFormat,UserData)
Declare a pair of plug in definition entries for a codec.
Definition: opalplugin.h:448

Declare an audio codec using C++ support classes.

< PluginCodec_VideoFormat instance < Encoder class name < Decoder class name

#define PLUGINCODEC_CONTROL_LOG_FUNCTION_DEF
Value:
PluginCodec_LogFunction PluginCodec_LogFunctionInstance; \
int PluginCodec_SetLogFunction(const PluginCodec_Definition *, void *, const char *, void * parm, unsigned * len) \
{ \
if (len == NULL || *len != sizeof(PluginCodec_LogFunction)) \
return false; \
\
PluginCodec_LogFunctionInstance = (PluginCodec_LogFunction)parm; \
if (PluginCodec_LogFunctionInstance != NULL) \
PluginCodec_LogFunctionInstance(4, __FILE__, __LINE__, "Plugin", "Started logging."); \
\
return true; \
} \
PluginCodec_Definition
Definition: opalplugin.h:339
PluginCodec_Definition::parm
union PluginCodec_Definition::_parm parm
PluginCodec_LogFunction
int(* PluginCodec_LogFunction)(unsigned level, const char *file, unsigned line, const char *section, const char *log)
Definition: opalplugin.h:237
PluginCodec_LogFunctionInstance
PluginCodec_LogFunction PluginCodec_LogFunctionInstance
PluginCodec_SetLogFunction
int PluginCodec_SetLogFunction(const PluginCodec_Definition *, void *, const char *, void *parm, unsigned *len)
#define PLUGINCODEC_CONTROL_LOG_FUNCTION_INC   { PLUGINCODEC_CONTROL_SET_LOG_FUNCTION, PluginCodec_SetLogFunction },

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

#define PLUGINCODEC_KNOWN_CODEC_CXX (   MediaType,
  Name,
  Description,
  EncoderClass,
  DecoderClass 
)
Value:
PLUGINCODEC_CODEC_PAIR(Name, \
NULL, \
Description, \
0, \
0, \
0, \
0, \
0, \
0, \
0, \
0, \
0, \
0, \
EncoderClass::Create_s<EncoderClass>, \
EncoderClass::Destroy_s, \
EncoderClass::Transcode_s, \
DecoderClass::Create_s<DecoderClass>, \
DecoderClass::Destroy_s, \
DecoderClass::Transcode_s, \
DecoderClass::GetControls(), /* Note doesn't matter if encoder or decoder */ \
PluginCodec_MediaTypeKnown, \
PLUGINCODEC_RAW_##MediaType, \
NULL)
PLUGINCODEC_CODEC_PAIR
#define PLUGINCODEC_CODEC_PAIR(MediaFormat,PayloadName,Description,SampleRate,BitsPerSecond,FrameTime,p1, p2, p3, p4, PayloadType,H323type,H323data,CreateEncoder,DestroyEncoder, EncodeMedia,CreateDecoder,DestroyDecoder, DecodeMedia,ControlsTable,Flags,RawFormat,UserData)
Declare a pair of plug in definition entries for a codec.
Definition: opalplugin.h:448
PluginCodec_MediaTypeKnown
Definition: opalplugin.h:149

Declare a "known by OPAL" codec using C++ support classes.

< Media type (AUDIO or VIDEO) < Media format name < Description of codec < Encoder class name < Decoder class name

#define PLUGINCODEC_TRACING   1
#define PLUGINCODEC_VIDEO_CODEC_CXX (   MediaFormat,
  EncoderClass,
  DecoderClass 
)
Value:
PLUGINCODEC_CODEC_PAIR(MediaFormat.GetFormatName(), \
MediaFormat.GetPayloadName(), \
MediaFormat.GetDescription(), \
PLUGINCODEC_VIDEO_CLOCK, \
MediaFormat.GetMaxBandwidth(), \
1000000/PLUGINCODEC_MAX_FRAME_RATE, \
MediaFormat.GetMaxWidth(), \
MediaFormat.GetMaxHeight(), \
0,PLUGINCODEC_MAX_FRAME_RATE, \
MediaFormat.GetPayloadType(), \
MediaFormat.GetH323CapabilityType(), \
MediaFormat.GetH323CapabilityData(), \
EncoderClass::Create_s<EncoderClass>, \
EncoderClass::Destroy_s, \
EncoderClass::Transcode_s, \
DecoderClass::Create_s<DecoderClass>, \
DecoderClass::Destroy_s, \
DecoderClass::Transcode_s, \
DecoderClass::GetControls(), /* Note doesn't matter if encoder or decoder */ \
MediaFormat.GetFlags(), \
MediaFormat.GetRawFormat(), \
&MediaFormat)
PLUGINCODEC_CODEC_PAIR
#define PLUGINCODEC_CODEC_PAIR(MediaFormat,PayloadName,Description,SampleRate,BitsPerSecond,FrameTime,p1, p2, p3, p4, PayloadType,H323type,H323data,CreateEncoder,DestroyEncoder, EncodeMedia,CreateDecoder,DestroyDecoder, DecodeMedia,ControlsTable,Flags,RawFormat,UserData)
Declare a pair of plug in definition entries for a codec.
Definition: opalplugin.h:448
PLUGINCODEC_VIDEO_CLOCK
#define PLUGINCODEC_VIDEO_CLOCK
Definition: opalplugin.h:406
PLUGINCODEC_MAX_FRAME_RATE
#define PLUGINCODEC_MAX_FRAME_RATE
Definition: opalplugin.h:407

Declare a video codec using C++ support classes.

< PluginCodec_VideoFormat instance < Encoder class name < Decoder class name

#define PTRACE (   level,
  section,
  args 
)
Value:
if (PTRACE_CHECK(level)) { \
std::ostringstream ptrace_strm; ptrace_strm << args; \
PluginCodec_LogFunctionInstance(level, __FILE__, __LINE__, section, ptrace_strm.str().c_str()); \
} else (void)0
PTRACE_CHECK
#define PTRACE_CHECK(level)
Definition: opalplugin.hpp:82
PluginCodec_LogFunctionInstance
PluginCodec_LogFunction PluginCodec_LogFunctionInstance

Referenced by PluginCodec_MediaFormat< NAME >::AdjustOptions(), PluginCodec_Utilities::ClampResolution(), PluginCodec< NAME >::Create_s(), PluginCodec< NAME >::GetActiveOptions_s(), PluginCodec_OptionMap::GetOptions(), PluginCodec< NAME >::PluginCodec(), OpalPluginTranscoderFactory< TranscoderClass >::Register(), PluginCodec< NAME >::SetOptions(), PluginCodec< NAME >::Transcode_s(), and SIPTimeoutWorkItem< Target_T >::Work().

#define PTRACE_CHECK (   level)    (PluginCodec_LogFunctionInstance != NULL && PluginCodec_LogFunctionInstance(level, NULL, 0, NULL, NULL))

Typedef Documentation

typedef std::map<std::string, std::string> PluginCodec_OptionMapBase

Function Documentation

int PluginCodec_SetLogFunction ( const PluginCodec_Definition *  ,
void *  ,
const char *  ,
void *  parm,
unsigned *  len 
)

Variable Documentation

PluginCodec_LogFunction PluginCodec_LogFunctionInstance