sipxmedialib  Version 3.3
List of all members
MpCodecInfo Class Reference

Static information describing a codec. More...

#include <MpCodecInfo.h>

Inheritance diagram for MpCodecInfo:
Inheritance graph
[legend]
Collaboration diagram for MpCodecInfo:
Collaboration graph
[legend]

Public Member Functions

Creators
 MpCodecInfo (const MppCodecInfoV1_1 &codecInfo, const MppCodecFmtpInfoV1_2 &fmtpInfo)
 Full constructor. More...
 
 MpCodecInfo (const MppCodecInfoV1_1 &codecInfo)
 Partial constructor. More...
 
Accessors
const char * getCodecManufacturer () const
 < characters and underscores. More...
 
const char * getCodecName () const
 Codec name (human readable). More...
 
const char * getCodecVersion () const
 Codec version (human readable). More...
 
unsigned getCodecType () const
 See CODEC_TYPE_* defines above. More...
 
const char * getMimeSubtype () const
 MIME subtype. More...
 
unsigned getFmtpsNum () const
 
const char ** getFmtps () const
 
unsigned getSampleRate () const
 
unsigned getNumChannels () const
 
unsigned getFramePacking () const
 See CODEC_FRAME_PACKING_* for details. More...
 
unsigned getMinBitrate () const
 Minimum bit rate for this codec (in bits per second). More...
 
unsigned getMaxBitrate () const
 Maximum bit rate for this codec (in bits per second). More...
 
unsigned getNumSamplesPerFrame () const
 
unsigned getMinFrameBytes () const
 
unsigned getMaxFrameBytes () const
 
unsigned getAlgorithmicDelay () const
 
Inquiry
UtlBoolean isSignalingCodec (void) const
 TRUE if codec could carry DTMF tones, FALSE otherwise. More...
 
UtlBoolean doesVadCng (void) const
 
UtlBoolean haveInternalPLC () const
 
UtlBoolean shouldSetMarker () const
 

Additional Inherited Members

- Protected Attributes inherited from MppCodecInfoV1_1
const char * codecManufacturer
 < characters and underscores. More...
 
const char * codecName
 Codec name (human readable). More...
 
const char * codecVersion
 Codec version (human readable). More...
 
unsigned codecType
 See CODEC_TYPE_* defines above. More...
 
const char * mimeSubtype
 MIME subtype. More...
 
unsigned fmtpsNum
 
const char ** fmtps
 
unsigned sampleRate
 
unsigned numChannels
 
unsigned framePacking
 See CODEC_FRAME_PACKING_* for details. More...
 
- Protected Attributes inherited from MppCodecFmtpInfoV1_2
unsigned signalingCodec
 TRUE if codec could carry DTMF tones, FALSE otherwise. More...
 
unsigned minBitrate
 Minimum bit rate for this codec (in bits per second). More...
 
unsigned maxBitrate
 Maximum bit rate for this codec (in bits per second). More...
 
unsigned numSamplesPerFrame
 
unsigned minFrameBytes
 
unsigned maxFrameBytes
 
unsigned packetLossConcealment
 See CODEC_PLC_* for details. More...
 
unsigned vadCng
 See CODEC_CNG_* for details. More...
 
unsigned algorithmicDelay
 
int mSetMarker
 

Detailed Description

Static information describing a codec.

Constructor & Destructor Documentation

MpCodecInfo ( const MppCodecInfoV1_1 codecInfo,
const MppCodecFmtpInfoV1_2 fmtpInfo 
)
inline

Full constructor.

MpCodecInfo ( const MppCodecInfoV1_1 codecInfo)
inline

Partial constructor.

Member Function Documentation

const char * getCodecManufacturer ( ) const
inline

< characters and underscores.

Codec manufacturer (human readable).

const char * getCodecName ( ) const
inline

Codec name (human readable).

const char * getCodecVersion ( ) const
inline

Codec version (human readable).

unsigned getCodecType ( ) const
inline

See CODEC_TYPE_* defines above.

const char * getMimeSubtype ( ) const
inline

MIME subtype.

unsigned getFmtpsNum ( ) const
inline

Number of elements in fmtps array. Set to 0 if codec does not need fmtp.

const char ** getFmtps ( ) const
inline

Array or recommended (supported) fmtp strings. Set to NULL if codec does not need fmtp.

unsigned getSampleRate ( ) const
inline

Sample rate for the PCM data expected by the codec in samples per second. Only 8kHz, 16kHz and 32kHz sample rates are supported.

unsigned getNumChannels ( ) const
inline

Number of channels supported by the codec. Only single-channel codecs are supported.

unsigned getFramePacking ( ) const
inline

See CODEC_FRAME_PACKING_* for details.

unsigned getMinBitrate ( ) const
inline

Minimum bit rate for this codec (in bits per second).

unsigned getMaxBitrate ( ) const
inline

Maximum bit rate for this codec (in bits per second).

unsigned getNumSamplesPerFrame ( ) const
inline

Number of PCM samples per input frame for frame-based codecs. For sample-based codecs should be equal to number of samples to generate integer number of bytes of encoded data (e.g. 1 for G.711, 2 for G.726-32, 4 for G.726-16, etc).

unsigned getMinFrameBytes ( ) const
inline

Minimum number of bytes produced after encoding numSamplesPerFrame samples of PCM data.

unsigned getMaxFrameBytes ( ) const
inline

Maximum number of bytes produced after encoding numSamplesPerFrame samples of PCM data.

unsigned getAlgorithmicDelay ( ) const
inline

Algorithmic delay (samples) of this encoder/decoder. Also known as codec lookahead. This should not include packaging delay (which equals to codec packet size). It will be taken into account independently. Counted in samples.

UtlBoolean isSignalingCodec ( void  ) const
inline

TRUE if codec could carry DTMF tones, FALSE otherwise.

UtlBoolean doesVadCng ( void  ) const
inline

UtlBoolean haveInternalPLC ( ) const
inline

UtlBoolean shouldSetMarker ( ) const
inline