seqnumvalidator.h

Go to the documentation of this file.

// ##########################################################################
// ####                                                                  ####
// ####                      RTP Audio Server Project                    ####
// ####                    ============================                  ####
// ####                                                                  ####
// #### Sequence Number Validator                                        ####
// ####                                                                  ####
// ####           Copyright (C) 1999-2012 by Thomas Dreibholz            ####
// ####                                                                  ####
// #### Contact:                                                         ####
// ####    EMail: dreibh@iem.uni-due.de                                  ####
// ####    WWW:   https://www.nntb.no/~dreibh/rtpaudio                ####
// ####                                                                  ####
// #### ---------------------------------------------------------------- ####
// ####                                                                  ####
// #### This program is free software: you can redistribute it and/or    ####
// #### modify it under the terms of the GNU General Public License as   ####
// #### published by the Free Software Foundation, either version 3 of   ####
// #### the License, or (at your option) any later version.              ####
// ####                                                                  ####
// #### This program is distributed in the hope that it will be useful,  ####
// #### but WITHOUT ANY WARRANTY; without even the implied warranty of   ####
// #### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    ####
// #### GNU General Public License for more details.                     ####
// ####                                                                  ####
// #### You should have received a copy of the GNU General Public        ####
// #### License along with this program.  If not, see                    ####
// #### <http://www.gnu.org/licenses/>.                                  ####
// ####                                                                  ####
// ##########################################################################
// $Id: seqnumvalidator.h 1286 2011-12-18 13:43:16Z dreibh $


#ifndef SEQNUMVALIDATOR_H
#define SEQNUMVALIDATOR_H


#include "tdsystem.h"


class SeqNumValidator
{
   // ====== Constructor ====================================================
   public:
   SeqNumValidator(const cardinal minSequential = 2,
                   const cardinal maxMisorder   = 100,
                   const cardinal maxDropout    = 3000,
                   const card64   seqMod        = (1 << 16));


   // ====== Status functions ===============================================
   inline card64 getPacketsReceived() const;

   inline card64 getPacketsLost() const;

   inline card64 getLastSeqNum() const;

   inline double getFractionLost() const;

   inline double getJitter() const;


   // ====== Sequence number validation =====================================
   enum ValidationResult {
      Valid           = 0,
      SourceProbation = 1,
      Jumped          = 2,
      Invalid         = 10,
      DuplicatePacket = Invalid + 0,
      InvalidSeqNum   = Invalid + 1
   };
   ValidationResult validate(const card64 sequenceNumber,
                             const card32 packetTimeStamp = 0);

   void reset();

   double calculateFractionLost();


   // ====== Private data ===================================================
   private:
   inline void init(const card64 sequenceNumber);


   card64   SeqMod;                // Constants.
   cardinal MaxDropout;
   cardinal MaxMisorder;
   cardinal MinSequential;

   card64   PrevPacketTimeStamp;   // Time stamp of previous packet.
   card64   PrevPacketArrivalTime; // Arrival time of previous packet.
   double   Jitter;                // Estimated jitter.
   double   FractionLost;          // Fraction lost.

   card64   MaxSeq;                // Highest seq. number seen.
   card64   BaseSeq;               // Base seq. number.
   card64   BadSeq;                // Last 'bad' seq. number + 1.
   card32   Probation;             // Sequential packets till source is valid.

   card64   Cycles;                // Shifted count of seq. number cycles.
   card64   Received;              // Packets received.
   card64   ReceivedPrior;         // Packet received at last interval.
   card64   ExpectedPrior;         // Packet expected at last interval.

   bool     Uninitialized;         // Waiting for the first valid seq. number.
};


#include "seqnumvalidator.icc"


#endif