RTCP_XR_Metrics Class Reference

#include <metrics.h>

Public Types

enum  PacketEvent { PACKET_RECEIVED, PACKET_DISCARDED, PACKET_LOST }
enum  PeriodType { GAP, BURST }
enum  QualityType { LQ, CQ }

Public Member Functions

 RTCP_XR_Metrics ()
 ~RTCP_XR_Metrics ()
void SetPayloadInfo (RTP_DataFrame frame)
void SetJitterDelay (DWORD delay)
void OnPacketReceived ()
void OnPacketDiscarded ()
void OnPacketLost ()
void OnPacketLost (DWORD dropped)
void OnRxSenderReport (PUInt32b lsr, PUInt32b dlsr)
BYTE GetLossRate ()
BYTE GetDiscardRate ()
BYTE GetBurstDensity ()
BYTE GetGapDensity ()
PUInt16b GetBurstDuration ()
PUInt16b GetGapDuration ()
PUInt16b GetRoundTripDelay ()
PUInt16b GetEndSystemDelay ()
BYTE RFactor ()
BYTE MOS_LQ ()
BYTE MOS_CQ ()

Data Fields

std::list< TimePeriodtimePeriods
std::list< IePeriodiePeriods
std::list< IdPeriodidPeriods

Detailed Description

This is a class used to calculate voice quality metrics acording to the E-Model, proposed by ITU-T G.107 recomendation.


Member Enumeration Documentation

Enumerator:
PACKET_RECEIVED 
PACKET_DISCARDED 
PACKET_LOST 
Enumerator:
GAP 
BURST 
Enumerator:
LQ 
CQ 

Constructor & Destructor Documentation

RTCP_XR_Metrics::RTCP_XR_Metrics (  ) 
RTCP_XR_Metrics::~RTCP_XR_Metrics (  ) 

Member Function Documentation

BYTE RTCP_XR_Metrics::GetBurstDensity (  ) 

Get the fraction of RTP packets lost/discarded within burst periods since the beginning of the reception.

PUInt16b RTCP_XR_Metrics::GetBurstDuration (  ) 

Get the mean duration, in milliseconds, of burst periods since the beginning of the reception.

BYTE RTCP_XR_Metrics::GetDiscardRate (  ) 

Get the fraction of RTP packets discarded since the beginning of the reception.

PUInt16b RTCP_XR_Metrics::GetEndSystemDelay (  ) 

Get the most recently estimated end system delay, expressed in millisecond.

BYTE RTCP_XR_Metrics::GetGapDensity (  ) 

Get the fraction of RTP packets lost/discarded within gap periods since the beginning of the reception.

PUInt16b RTCP_XR_Metrics::GetGapDuration (  ) 

Get the mean duration, in milliseconds, of gap periods since the beginning of the reception.

BYTE RTCP_XR_Metrics::GetLossRate (  ) 

Get the fraction of RTP packets lost since the beginning of the reception.

PUInt16b RTCP_XR_Metrics::GetRoundTripDelay (  ) 

Get the most recently calculated round trip time between RTP interfaces, expressed in millisecond.

BYTE RTCP_XR_Metrics::MOS_CQ (  ) 

Get the estimated MOS score for conversational quality of the current RTP session, expressed in the range of 10 to 50. This metric includes the effects of delay.

BYTE RTCP_XR_Metrics::MOS_LQ (  ) 

Get the estimated MOS score for listening quality of the current RTP session, expressed in the range of 10 to 50. This metric not includes the effects of delay.

void RTCP_XR_Metrics::OnPacketDiscarded (  ) 

Called when a packet is discarded.

void RTCP_XR_Metrics::OnPacketLost ( DWORD  dropped  ) 

Called when several packets are lost.

Parameters:
dropped Number of lost packets.
void RTCP_XR_Metrics::OnPacketLost (  ) 

Called when a packet is lost.

void RTCP_XR_Metrics::OnPacketReceived (  ) 

Called when a packet is received.

void RTCP_XR_Metrics::OnRxSenderReport ( PUInt32b  lsr,
PUInt32b  dlsr 
)

Called when a Sender Report is receveid.

Parameters:
lsr "Last SR" field of the received SR.
dlsr "Delay since the last SR" field of the received SR.
BYTE RTCP_XR_Metrics::RFactor (  ) 

Get the R factor for the current RTP session, expressed in the range of 0 to 100.

void RTCP_XR_Metrics::SetJitterDelay ( DWORD  delay  ) 

Set the jitter buffer delay. This must be called to obtain the Id parameter.

Parameters:
delay The jitter buffer delay in milliseconds
void RTCP_XR_Metrics::SetPayloadInfo ( RTP_DataFrame  frame  ) 

Set the payload information. This must be called to obtain bitrate and E-Model parameters.

Parameters:
frame Frame from which we get the payload info

Field Documentation


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

Generated on 5 Jun 2012 for OPAL by  doxygen 1.6.1