metrics.h

Go to the documentation of this file.

/*
 * metrics.h
 *
 * E-Model implementation
 *
 * Open Phone Abstraction Library (OPAL)
 *
 * Copyright (c) 2010 Universidade Federal do Amazonas
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * Contributor(s): ______________________________________.
 */

#ifndef OPAL_RTP_METRICS_H
#define OPAL_RTP_METRICS_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <opal_config.h>

#if OPAL_RTCP_XR

#include <rtp/rtp_session.h>

#include <list>

class RTP_Session;
class RTP_DataFrame;

// RTCP-XR - VoIP Metrics Report Block

class RTP_MetricsReport : public PObject
{
    PCLASSINFO(RTP_MetricsReport, PObject);
  public:
    RTP_MetricsReport(const RTP_ControlFrame::MetricsReport & mr);
#if PTRACING
    void PrintOn(ostream &) const;
#endif

    RTP_SyncSourceId sourceIdentifier;
    float            lossRate;       /* percentage of RTP data packets lost */ 
    float            discardRate;    /* percentage of RTP data packets discarded */
    float            burstDensity;   /* percentage of RTP data packets within burst periods */
    float            gapDensity;     /* percentage of RTP data packets within inter-burst gaps */
    unsigned         roundTripDelay; /* the most recently calculated round trip time */    
    unsigned         RFactor;        /* voice quality metric of the call */
    unsigned         mosLQ;          /* MOS for listen quality */
    unsigned         mosCQ;          /* MOS for conversational quality */
    unsigned         jbNominal;      /* current nominal jitter buffer delay, in ms */ 
    unsigned         jbMaximum;      /* current maximum jitter buffer delay, in ms */
    unsigned         jbAbsolute;     /* current absolute maximum jitter buffer delay, in ms */
};


class RTCP_XR_Metrics : public PObject
{
    PCLASSINFO(RTCP_XR_Metrics, PObject);
  protected:
    RTCP_XR_Metrics(
      float    Ie,
      float    Bpl,
      float    lookAheadTime,
      PINDEX   payloadSize,
      unsigned payloadBitrate
    );

  public:
    static RTCP_XR_Metrics * Create(const RTP_DataFrame & frame);

    ~RTCP_XR_Metrics();

    enum PacketEvent {
      PACKET_RECEIVED,
      PACKET_DISCARDED,
      PACKET_LOST
    };

    enum PeriodType {
      GAP,     /* a period of low packet losses and/or discards */
      BURST,   /* a period of a high proportion of packet losses and/or discards */
    };

    /* A period of time, which can be a burst or a gap */
    typedef struct TimePeriod {
      PeriodType      type;
      PTimeInterval   duration;
    } TimePeriod;

    typedef struct IdPeriod {
      PTimeInterval duration;
      float         Id;
    } IdPeriod;

    typedef struct IePeriod {
      PeriodType    type;
      PTimeInterval duration;
      float         Ieff;
    } IePeriod;

    enum QualityType {
      LQ,  /* Listening Quality, not include the effects of delay */
      CQ   /* Conversational Quality, include the effects of delay */
    };

    void SetJitterDelay(
      unsigned delay   
    );

    void OnPacketReceived();

    void OnPacketDiscarded();

    void OnPacketLost();

    void OnPacketLost(
      unsigned dropped   
    );

    void OnRxSenderReport(
      const PTime & lastTimestamp,  
      const PTimeInterval & delay   
    );

    unsigned GetLossRate() const;

    unsigned GetDiscardRate() const;

    unsigned GetBurstDensity() const;

    unsigned GetGapDensity() const;

    unsigned GetBurstDuration() const;

    unsigned GetGapDuration() const;

    unsigned GetRoundTripDelay() const;

    unsigned GetEndSystemDelay() const;

    unsigned GetRFactor() const;

    unsigned GetMOS_LQ() const;

    unsigned GetMOS_CQ() const;

    // Internal functions
    void InsertMetricsReport(
      RTP_ControlFrame & report,
      const OpalRTPSession & session,
      RTP_SyncSourceId syncSourceOut,
      OpalJitterBuffer * jitter
    );


  protected:
    void Markov(
      PacketEvent event   
    );

    void ResetCounters();

    unsigned GetRFactor(
      QualityType qt   
    ) const;

    unsigned GetEndOfCallRFactor() const;

    float GetMOS(
      QualityType qt   
    ) const;

    float GetEndOfCallMOS() const;

    float GetIdFactor() const;

    float GetPonderateId() const;

    float GetIeff(
      PeriodType type   
    ) const;

    float GetEndOfCallIe() const;

    float GetPonderateIe() const;

    TimePeriod CreateTimePeriod(
      PeriodType type,        
      const PTime & beginTimestamp,   
      const PTime & endTimestamp      
    );

    IdPeriod CreateIdPeriod(
      const PTime & beginTimestamp,   
      const PTime & endTimestamp      
    );

    IePeriod CreateIePeriod(
      const TimePeriod & timePeriod   
    );

    /* data associated with the payload */
    float    m_Ie;              /* equipment impairment factor for the codec utilized */
    float    m_Bpl;             /* robustness factor for the codec utilized */
    float    m_lookAheadTime;   /* codec lookahead time */
    PINDEX   m_payloadSize;
    unsigned m_payloadBitrate;

    unsigned m_gmin;                    /* gap threshold */
    unsigned m_lostInBurst;             /* number of lost packets within the current burst */
    unsigned m_packetsReceived;         /* packets received since the beggining of the reception */
    unsigned m_packetsSinceLastLoss;    /* packets received since the last loss or discard event */
    unsigned m_packetsLost;             /* packets lost since the beggining of the reception */
    unsigned m_packetsDiscarded;        /* packets discarded since the beggining of the receptions */
    unsigned m_srPacketsReceived;       /* count of SR packets received */

    unsigned m_packetsReceivedInGap;    /* packets received within gap periods */
    unsigned m_packetsLostInGap;        /* packets lost within gap periods */

    unsigned m_packetsReceivedInBurst;  /* packets received within burst periods */
    unsigned m_packetsLostInBurst;      /* packets lost within burst periods */

    unsigned c5;
    unsigned c11;
    unsigned c13;
    unsigned c14;
    unsigned c22;
    unsigned c23;
    unsigned c31;
    unsigned c32;
    unsigned c33;

    /* variables to calculate round trip delay */
    PTime         m_lsrTime;
    PTimeInterval m_dlsrTime;
    PTime         m_arrivalTime;

    unsigned m_jitterDelay;  /* jitter buffer delay, in milliseconds */
    float    m_lastId;       /* last Id calculated */
    float    m_lastIe;       /* last Ie calculated */

    std::list<TimePeriod> m_timePeriods;
    std::list<IePeriod>   m_iePeriods;
    std::list<IdPeriod>   m_idPeriods;

    PeriodType m_currentPeriodType;           /* indicates if we are within a gap or burst */
    PTime m_periodBeginTimestamp;             /* timestamp of the beginning of the gap or burst period */
    PTime m_lastLossTimestamp;                /* timestamp of the last loss */
    PTime m_lastLossInBurstTimestamp;         /* timestamp of the last loss within a burst period */
    PTime m_lastJitterBufferChangeTimestamp;  /* timestamp of the last change in jitter buffer size */

};


#endif // OPAL_RTCP_XR

#endif // OPAL_METRICS_H