#include <mediafmt.h>
Inheritance diagram for OpalMediaFormat:
Public Types | |
AudioClockRate = 8000 | |
8kHz sample rate | |
VideoClockRate = 90000 | |
90kHz sample rate | |
enum | StandardClockRate { AudioClockRate = 8000, VideoClockRate = 90000 } |
Public Member Functions | |
OpalMediaFormat (const OpalMediaFormat &c) | |
OpalMediaFormat & | operator= (const OpalMediaFormat &c) |
virtual | ~OpalMediaFormat () |
virtual PBoolean | MakeUnique () |
OpalMediaFormat (OpalMediaFormatInternal *info=NULL) | |
OpalMediaFormat (const char *fullName, const OpalMediaType &mediaType, RTP_DataFrame::PayloadTypes rtpPayloadType, const char *encodingName, PBoolean needsJitter, unsigned bandwidth, PINDEX frameSize, unsigned frameTime, unsigned clockRate, time_t timeStamp=0) | |
OpalMediaFormat (RTP_DataFrame::PayloadTypes rtpPayloadType, unsigned clockRate, const char *rtpEncodingName=NULL, const char *protocol=NULL) | |
OpalMediaFormat (const char *wildcard) | |
OpalMediaFormat (const PString &wildcard) | |
OpalMediaFormat & | operator= (RTP_DataFrame::PayloadTypes rtpPayloadType) |
OpalMediaFormat & | operator= (const char *wildcard) |
OpalMediaFormat & | operator= (const PString &wildcard) |
virtual PObject * | Clone () const |
virtual Comparison | Compare (const PObject &obj) const |
virtual void | PrintOn (ostream &strm) const |
virtual void | ReadFrom (istream &strm) |
bool | ToNormalisedOptions () |
bool | ToCustomisedOptions () |
bool | Update (const OpalMediaFormat &mediaFormat) |
bool | Merge (const OpalMediaFormat &mediaFormat) |
bool | ValidateMerge (const OpalMediaFormat &mediaFormat) const |
PString | GetName () const |
PBoolean | IsValid () const |
PBoolean | IsTransportable () const |
RTP_DataFrame::PayloadTypes | GetPayloadType () const |
void | SetPayloadType (RTP_DataFrame::PayloadTypes type) |
const char * | GetEncodingName () const |
OpalMediaType | GetMediaType () const |
bool | NeedsJitterBuffer () const |
unsigned | GetBandwidth () const |
PINDEX | GetFrameSize () const |
unsigned | GetFrameTime () const |
unsigned | GetTimeUnits () const |
unsigned | GetClockRate () const |
PStringToString | GetOptions () const |
PINDEX | GetOptionCount () const |
const OpalMediaOption & | GetOption (PINDEX index) const |
bool | GetOptionValue (const PString &name, PString &value) const |
bool | SetOptionValue (const PString &name, const PString &value) |
bool | GetOptionBoolean (const PString &name, bool dflt=PFalse) const |
bool | SetOptionBoolean (const PString &name, bool value) |
int | GetOptionInteger (const PString &name, int dflt=0) const |
bool | SetOptionInteger (const PString &name, int value) |
double | GetOptionReal (const PString &name, double dflt=0) const |
bool | SetOptionReal (const PString &name, double value) |
PINDEX | GetOptionEnum (const PString &name, PINDEX dflt=0) const |
bool | SetOptionEnum (const PString &name, PINDEX value) |
PString | GetOptionString (const PString &name, const PString &dflt=PString::Empty()) const |
bool | SetOptionString (const PString &name, const PString &value) |
bool | GetOptionOctets (const PString &name, PBYTEArray &octets) const |
bool | SetOptionOctets (const PString &name, const PBYTEArray &octets) |
bool | SetOptionOctets (const PString &name, const BYTE *data, PINDEX length) |
bool | AddOption (OpalMediaOption *option, PBoolean overwrite=PFalse) |
bool | HasOption (const PString &name) const |
OpalMediaOption * | FindOption (const PString &name) const |
bool | IsValidForProtocol (const PString &protocol) const |
time_t | GetCodecVersionTime () const |
ostream & | PrintOptions (ostream &strm) const |
void | AdjustVideoArgs (PVideoDevice::OpenArgs &args) const |
virtual PBoolean | IsEmpty () const |
operator PString () const | |
operator const char * () const | |
bool | operator== (const char *other) const |
bool | operator!= (const char *other) const |
bool | operator== (const PString &other) const |
bool | operator!= (const PString &other) const |
bool | operator== (const OpalMediaFormat &other) const |
bool | operator!= (const OpalMediaFormat &other) const |
Static Public Member Functions | |
static const PString & | NeedsJitterOption () |
static const PString & | MaxBitRateOption () |
static const PString & | TargetBitRateOption () |
static const PString & | MaxFrameSizeOption () |
static const PString & | FrameTimeOption () |
static const PString & | ClockRateOption () |
static const PString & | ProtocolOption () |
static const PString & | MaxTxPacketSizeOption () |
static OpalMediaFormatList | GetMatchingRegisteredMediaFormats (RTP_DataFrame::PayloadTypes rtpPayloadType, const unsigned clockRate, const char *rtpEncodingName=NULL, const char *protocol=NULL) |
static OpalMediaFormatList | GetAllRegisteredMediaFormats () |
static void | GetAllRegisteredMediaFormats (OpalMediaFormatList ©) |
static bool | SetRegisteredMediaFormat (const OpalMediaFormat &mediaFormat) |
static const PString & | MediaPacketizationOption () |
static const PString & | MediaPacketizationsOption () |
Protected Member Functions | |
virtual void | DestroyContents () |
virtual void | AssignContents (const PContainer &c) |
void | Construct (OpalMediaFormatInternal *info) |
Protected Attributes | |
OpalMediaFormatInternal * | m_info |
PMutex | m_mutex |
Friends | |
class | OpalMediaFormatInternal |
class | OpalMediaFormatList |
bool | operator== (const char *other, const OpalMediaFormat &fmt) |
bool | operator!= (const char *other, const OpalMediaFormat &fmt) |
bool | operator== (const PString &other, const OpalMediaFormat &fmt) |
bool | operator!= (const PString &other, const OpalMediaFormat &fmt) |
OpalMediaFormat::OpalMediaFormat | ( | const OpalMediaFormat & | c | ) | [inline] |
virtual OpalMediaFormat::~OpalMediaFormat | ( | ) | [inline, virtual] |
OpalMediaFormat::OpalMediaFormat | ( | OpalMediaFormatInternal * | info = NULL |
) |
Default constructor creates a PCM-16 media format.
OpalMediaFormat::OpalMediaFormat | ( | const char * | fullName, | |
const OpalMediaType & | mediaType, | |||
RTP_DataFrame::PayloadTypes | rtpPayloadType, | |||
const char * | encodingName, | |||
PBoolean | needsJitter, | |||
unsigned | bandwidth, | |||
PINDEX | frameSize, | |||
unsigned | frameTime, | |||
unsigned | clockRate, | |||
time_t | timeStamp = 0 | |||
) |
This form of the constructor will register the full details of the media format into an internal database. This would typically be used as a static global. In fact it would be very dangerous for an instance to use this constructor in any other way, especially local variables.
If the rtpPayloadType is RTP_DataFrame::DynamicBase, then the RTP payload type is actually set to the first unused dynamic RTP payload type that is in the registers set of media formats.
The frameSize parameter indicates that the media format has a maximum size for each data frame, eg G.723.1 frames are no more than 24 bytes long. If zero then there is no intrinsic maximum, eg G.711.
fullName | Full name of media format |
mediaType | media type for this format |
rtpPayloadType | RTP payload type code |
encodingName | RTP encoding name |
needsJitter | Indicate format requires a jitter buffer |
bandwidth | Bandwidth in bits/second |
frameSize | Size of frame in bytes (if applicable) |
frameTime | Time for frame in RTP units (if applicable) |
clockRate | Clock rate for data (if applicable) |
timeStamp | timestamp (for versioning) |
OpalMediaFormat::OpalMediaFormat | ( | RTP_DataFrame::PayloadTypes | rtpPayloadType, | |
unsigned | clockRate, | |||
const char * | rtpEncodingName = NULL , |
|||
const char * | protocol = NULL | |||
) |
Construct a media format, searching database for information. This constructor will search through the RegisteredMediaFormats list for the match of the payload type, if found the other information fields are set from the database. If not found then the ancestor string is set to the empty string.
Note it is impossible to determine the order of registration so this should not be relied on.
rtpPayloadType | RTP payload type code |
clockRate | clock rate |
rtpEncodingName | RTP payload type name |
protocol | valid protocol (if NULL, then all) |
OpalMediaFormat::OpalMediaFormat | ( | const char * | wildcard | ) |
Construct a media format, searching database for information. This constructor will search through the RegisteredMediaFormats list for the wildcard match of the parameter string, if found the other information fields are set from the database. If not found then the ancestor string is set to the empty string.
The wildcard string is a simple substring match using the '*' character. For example: "G.711*" would match the first of "G.711-uLaw-64k" and "G.711-ALaw-64k" to have been registered.
Note it is impossible to determine the order of registration so this should not be relied on.
wildcard | Wildcard name to search for |
OpalMediaFormat::OpalMediaFormat | ( | const PString & | wildcard | ) |
Construct a media format, searching database for information. This constructor will search through the RegisteredMediaFormats list for the wildcard match of the parameter string, if found the other information fields are set from the database. If not found then the ancestor string is set to the empty string.
The wildcard string is a simple substring match using the '*' character. For example: "G.711*" would match the first of "G.711-uLaw-64k" and "G.711-ALaw-64k" to have been registered.
Note it is impossible to determine the order of registration so this should not be relied on.
wildcard | Wildcard name to search for |
bool OpalMediaFormat::AddOption | ( | OpalMediaOption * | option, | |
PBoolean | overwrite = PFalse | |||
) | [inline] |
Add a new option to this media format
void OpalMediaFormat::AdjustVideoArgs | ( | PVideoDevice::OpenArgs & | args | ) | const |
Adjust the video device arguments from the media format.
args | Videoo device arguments to adjust |
virtual void OpalMediaFormat::AssignContents | ( | const PContainer & | c | ) | [protected, virtual] |
static const PString& OpalMediaFormat::ClockRateOption | ( | ) | [static] |
virtual PObject* OpalMediaFormat::Clone | ( | ) | const [virtual] |
Create a copy of the media format.
Reimplemented in OpalH224MediaFormat.
virtual Comparison OpalMediaFormat::Compare | ( | const PObject & | obj | ) | const [virtual] |
Compare two media formats.
void OpalMediaFormat::Construct | ( | OpalMediaFormatInternal * | info | ) | [protected] |
virtual void OpalMediaFormat::DestroyContents | ( | ) | [protected, virtual] |
OpalMediaOption* OpalMediaFormat::FindOption | ( | const PString & | name | ) | const [inline] |
Get a pointer to the specified media format option. Returns NULL if thee option does not exist.
static const PString& OpalMediaFormat::FrameTimeOption | ( | ) | [static] |
static void OpalMediaFormat::GetAllRegisteredMediaFormats | ( | OpalMediaFormatList & | copy | ) | [static] |
copy | List to receive the copy of the master list |
static OpalMediaFormatList OpalMediaFormat::GetAllRegisteredMediaFormats | ( | ) | [static] |
Get a copy of the list of media formats that have been registered.
unsigned OpalMediaFormat::GetBandwidth | ( | ) | const [inline] |
Get the average bandwidth used in bits/second.
unsigned OpalMediaFormat::GetClockRate | ( | ) | const [inline] |
Get the clock rate in Hz for this format.
time_t OpalMediaFormat::GetCodecVersionTime | ( | ) | const [inline] |
const char* OpalMediaFormat::GetEncodingName | ( | ) | const [inline] |
Get the RTP encoding name that is to be used for this media format.
PINDEX OpalMediaFormat::GetFrameSize | ( | ) | const [inline] |
Get the maximum frame size in bytes. If this returns zero then the media format has no intrinsic maximum frame size, eg a video format would return zero but G.723.1 would return 24.
unsigned OpalMediaFormat::GetFrameTime | ( | ) | const [inline] |
Get the frame time in RTP timestamp units. If this returns zero then the media format is not real time and has no intrinsic timing eg T.120
static OpalMediaFormatList OpalMediaFormat::GetMatchingRegisteredMediaFormats | ( | RTP_DataFrame::PayloadTypes | rtpPayloadType, | |
const unsigned | clockRate, | |||
const char * | rtpEncodingName = NULL , |
|||
const char * | protocol = NULL | |||
) | [static] |
Create a media format list containing all of the registered media formats matching the encoding name and clock rate, or the payload type.
rtpPayloadType | RTP payload type code |
clockRate | clock rate |
rtpEncodingName | RTP payload type name |
protocol | protocol to be valid for (if NULL, then all) |
OpalMediaType OpalMediaFormat::GetMediaType | ( | ) | const [inline] |
Get the media type for this format
PString OpalMediaFormat::GetName | ( | ) | const [inline] |
Get the name of the format
const OpalMediaOption& OpalMediaFormat::GetOption | ( | PINDEX | index | ) | const [inline] |
Get the option instance at the specified index. This contains the description and value for the option.
index | Index of option in list to get |
bool OpalMediaFormat::GetOptionBoolean | ( | const PString & | name, | |
bool | dflt = PFalse | |||
) | const [inline] |
Get the option value of the specified name as a boolean. The default value is returned if the option is not present.
name | Option name |
dflt | Default value if option not present |
PINDEX OpalMediaFormat::GetOptionCount | ( | ) | const [inline] |
Get the number of options this media format has.
PINDEX OpalMediaFormat::GetOptionEnum | ( | const PString & | name, | |
PINDEX | dflt = 0 | |||
) | const [inline] |
Get the option value of the specified name as an index into an enumeration list. The default value is returned if the option is not present.
name | Option name |
dflt | Default value if option not present |
int OpalMediaFormat::GetOptionInteger | ( | const PString & | name, | |
int | dflt = 0 | |||
) | const [inline] |
Get the option value of the specified name as an integer. The default value is returned if the option is not present.
name | Option name |
dflt | Default value if option not present |
bool OpalMediaFormat::GetOptionOctets | ( | const PString & | name, | |
PBYTEArray & | octets | |||
) | const [inline] |
Get the option value of the specified name as an octet array. Returns PFalse if not present.
name | Option name |
octets | Octets in option |
double OpalMediaFormat::GetOptionReal | ( | const PString & | name, | |
double | dflt = 0 | |||
) | const [inline] |
Get the option value of the specified name as a real. The default value is returned if the option is not present.
name | Option name |
dflt | Default value if option not present |
PStringToString OpalMediaFormat::GetOptions | ( | ) | const [inline] |
Get all of the option values of the format as a dictionary. Each entry is a name value pair.
PString OpalMediaFormat::GetOptionString | ( | const PString & | name, | |
const PString & | dflt = PString::Empty() | |||
) | const [inline] |
Get the option value of the specified name as a string. The default value is returned if the option is not present.
name | Option name |
dflt | Default value if option not present |
bool OpalMediaFormat::GetOptionValue | ( | const PString & | name, | |
PString & | value | |||
) | const [inline] |
Get the option value of the specified name as a string.
Returns false of the option is not present.
name | Option name |
value | String to receive option value |
RTP_DataFrame::PayloadTypes OpalMediaFormat::GetPayloadType | ( | ) | const [inline] |
Get the RTP payload type that is to be used for this media format. This will either be an intrinsic one for the media format eg GSM or it will be automatically calculated as a dynamic media format that will be uniqueue amongst the registered media formats.
unsigned OpalMediaFormat::GetTimeUnits | ( | ) | const [inline] |
Get the number of RTP timestamp units per millisecond.
bool OpalMediaFormat::HasOption | ( | const PString & | name | ) | const [inline] |
Determine if media format has the specified option.
virtual PBoolean OpalMediaFormat::IsEmpty | ( | ) | const [inline, virtual] |
PBoolean OpalMediaFormat::IsTransportable | ( | ) | const [inline] |
Return PTrue if media format info may be sent via RTP. Some formats are internal use only and are never transported "over the wire".
PBoolean OpalMediaFormat::IsValid | ( | ) | const [inline] |
Return PTrue if media format info is valid. This may be used if the single string constructor is used to check that it matched something in the registered media formats database.
bool OpalMediaFormat::IsValidForProtocol | ( | const PString & | protocol | ) | const [inline] |
Returns PTrue if the media format is valid for the protocol specified This allow plugin codecs to customise which protocols they are valid for The default implementation returns true unless the protocol is H.323 and the rtpEncodingName is NULL
Reimplemented in OpalH224MediaFormat.
virtual PBoolean OpalMediaFormat::MakeUnique | ( | ) | [virtual] |
static const PString& OpalMediaFormat::MaxBitRateOption | ( | ) | [static] |
static const PString& OpalMediaFormat::MaxFrameSizeOption | ( | ) | [static] |
static const PString& OpalMediaFormat::MaxTxPacketSizeOption | ( | ) | [static] |
Get the name of the OpalMediaOption indicating the maximum RTP payload size.
static const PString& OpalMediaFormat::MediaPacketizationOption | ( | ) | [static] |
static const PString& OpalMediaFormat::MediaPacketizationsOption | ( | ) | [static] |
bool OpalMediaFormat::Merge | ( | const OpalMediaFormat & | mediaFormat | ) |
Merge with another media format. This will alter and validate the options for this media format according to the merge rule for each option. The parameter is typically a "capability" while the current object isthe proposed channel format. This if the current object has a tx number of frames of 3, but the parameter has a value of 1, then the current object will be set to 1.
Returns PFalse if the media formats are incompatible and cannot be merged.
bool OpalMediaFormat::NeedsJitterBuffer | ( | ) | const [inline] |
Determine if the media format requires a jitter buffer. As a rule an audio codec needs a jitter buffer and all others do not.
static const PString& OpalMediaFormat::NeedsJitterOption | ( | ) | [static] |
OpalMediaFormat::operator const char * | ( | ) | const [inline] |
OpalMediaFormat::operator PString | ( | ) | const [inline] |
bool OpalMediaFormat::operator!= | ( | const OpalMediaFormat & | other | ) | const [inline] |
bool OpalMediaFormat::operator!= | ( | const PString & | other | ) | const [inline] |
bool OpalMediaFormat::operator!= | ( | const char * | other | ) | const [inline] |
OpalMediaFormat& OpalMediaFormat::operator= | ( | const PString & | wildcard | ) |
Search for the specified format name. This is equivalent to going fmt = OpalMediaFormat(search);
wildcard | Wildcard name to search for |
OpalMediaFormat& OpalMediaFormat::operator= | ( | const char * | wildcard | ) |
Search for the specified format name. This is equivalent to going fmt = OpalMediaFormat(search);
wildcard | Wildcard name to search for |
OpalMediaFormat& OpalMediaFormat::operator= | ( | RTP_DataFrame::PayloadTypes | rtpPayloadType | ) |
Search for the specified format type. This is equivalent to going fmt = OpalMediaFormat(rtpPayloadType);
rtpPayloadType | RTP payload type code |
OpalMediaFormat& OpalMediaFormat::operator= | ( | const OpalMediaFormat & | c | ) | [inline] |
bool OpalMediaFormat::operator== | ( | const OpalMediaFormat & | other | ) | const [inline] |
bool OpalMediaFormat::operator== | ( | const PString & | other | ) | const [inline] |
bool OpalMediaFormat::operator== | ( | const char * | other | ) | const [inline] |
virtual void OpalMediaFormat::PrintOn | ( | ostream & | strm | ) | const [virtual] |
Print media format. Note if the user specifies a width (using setw() for example) of -1, then a details multi-line output of all the options for the format is included.
ostream& OpalMediaFormat::PrintOptions | ( | ostream & | strm | ) | const [inline] |
static const PString& OpalMediaFormat::ProtocolOption | ( | ) | [static] |
Get the name of the OpalMediaOption indicating the protocol the format is being used on.
virtual void OpalMediaFormat::ReadFrom | ( | istream & | strm | ) | [virtual] |
Read media format.
bool OpalMediaFormat::SetOptionBoolean | ( | const PString & | name, | |
bool | value | |||
) | [inline] |
Set the option value of the specified name as a boolean. Note the option will not be added if it does not exist, the option must be explicitly added using AddOption().
Returns false of the option is not present or is not of the same type.
name | Option name |
value | New value for option |
bool OpalMediaFormat::SetOptionEnum | ( | const PString & | name, | |
PINDEX | value | |||
) | [inline] |
Set the option value of the specified name as an index into an enumeration. Note the option will not be added if it does not exist, the option must be explicitly added using AddOption().
Returns false of the option is not present or is not of the same type.
name | Option name |
value | New value for option |
bool OpalMediaFormat::SetOptionInteger | ( | const PString & | name, | |
int | value | |||
) | [inline] |
Set the option value of the specified name as an integer. Note the option will not be added if it does not exist, the option must be explicitly added using AddOption().
Returns false of the option is not present, not of the same type or is putside the allowable range.
name | Option name |
value | New value for option |
bool OpalMediaFormat::SetOptionOctets | ( | const PString & | name, | |
const BYTE * | data, | |||
PINDEX | length | |||
) | [inline] |
name | Option name |
data | Octets in option |
length | Number of octets |
bool OpalMediaFormat::SetOptionOctets | ( | const PString & | name, | |
const PBYTEArray & | octets | |||
) | [inline] |
Set the option value of the specified name as an octet array. Note the option will not be added if it does not exist, the option must be explicitly added using AddOption().
Returns false of the option is not present or is not of the same type.
name | Option name |
octets | Octets in option |
bool OpalMediaFormat::SetOptionReal | ( | const PString & | name, | |
double | value | |||
) | [inline] |
Set the option value of the specified name as a real. Note the option will not be added if it does not exist, the option must be explicitly added using AddOption().
Returns false of the option is not present or is not of the same type.
name | Option name |
value | New value for option |
bool OpalMediaFormat::SetOptionString | ( | const PString & | name, | |
const PString & | value | |||
) | [inline] |
Set the option value of the specified name as a string. Note the option will not be added if it does not exist, the option must be explicitly added using AddOption().
Returns false of the option is not present or is not of the same type.
name | Option name |
value | New value for option |
bool OpalMediaFormat::SetOptionValue | ( | const PString & | name, | |
const PString & | value | |||
) | [inline] |
Set the option value of the specified name as a string. Note the option will not be added if it does not exist, the option must be explicitly added using AddOption().
Returns false of the option is not present.
name | Option name |
value | New option value as string |
void OpalMediaFormat::SetPayloadType | ( | RTP_DataFrame::PayloadTypes | type | ) | [inline] |
static bool OpalMediaFormat::SetRegisteredMediaFormat | ( | const OpalMediaFormat & | mediaFormat | ) | [static] |
Set the options on the master format list entry. The media format must already be registered. Returns false if not.
mediaFormat | Media format to copy to master list |
static const PString& OpalMediaFormat::TargetBitRateOption | ( | ) | [static] |
bool OpalMediaFormat::ToCustomisedOptions | ( | ) |
This will do the reverse of ToNormalisedOptions, translating the OPAL "normalised" options to codec specific "custom" options.
bool OpalMediaFormat::ToNormalisedOptions | ( | ) |
This will translate the codec specific "custom" options to OPAL "normalised" options, e.g. For H.261 "QCIF MPI"="1", "CIF MPI"="5" would be translated to "Frame Width"="176", "Frame Height"="144".
bool OpalMediaFormat::Update | ( | const OpalMediaFormat & | mediaFormat | ) |
Update media format information.
bool OpalMediaFormat::ValidateMerge | ( | const OpalMediaFormat & | mediaFormat | ) | const |
Return true if the given mediaFormat will successfully merge.
friend class OpalMediaFormatInternal [friend] |
friend class OpalMediaFormatList [friend] |
bool operator!= | ( | const PString & | other, | |
const OpalMediaFormat & | fmt | |||
) | [friend] |
bool operator!= | ( | const char * | other, | |
const OpalMediaFormat & | fmt | |||
) | [friend] |
bool operator== | ( | const PString & | other, | |
const OpalMediaFormat & | fmt | |||
) | [friend] |
bool operator== | ( | const char * | other, | |
const OpalMediaFormat & | fmt | |||
) | [friend] |
OpalMediaFormatInternal* OpalMediaFormat::m_info [protected] |
PMutex OpalMediaFormat::m_mutex [protected] |