src/contrib/delay-jitter-estimation.cc
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Wed, 03 Jun 2009 08:49:40 +0200
changeset 4502 07d34c0d8d18
parent 3208 1a754d09c4ba
child 7040 444bb5c76bff
permissions -rw-r--r--
new tags
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     1
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     2
#include "delay-jitter-estimation.h"
3041
a624276a897b mtag -> tag
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3040
diff changeset
     3
#include "ns3/tag.h"
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     4
#include "ns3/simulator.h"
3038
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
     5
#include "ns3/string.h"
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     6
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
     7
namespace ns3 {
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
     8
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
     9
class DelayJitterEstimationTimestampTag : public Tag
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    10
{
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    11
public:
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    12
  DelayJitterEstimationTimestampTag ();
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    13
  static TypeId GetTypeId (void);
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    14
  virtual TypeId GetInstanceTypeId (void) const;
3038
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    15
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    16
  virtual uint32_t GetSerializedSize (void) const;
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    17
  virtual void Serialize (TagBuffer i) const;
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    18
  virtual void Deserialize (TagBuffer i);
3208
1a754d09c4ba bug 200: Packet::PrintTags is not implemented.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3084
diff changeset
    19
  virtual void Print (std::ostream &os) const;
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    20
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    21
  Time GetTxTime (void) const;
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    22
private:
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    23
  uint64_t m_creationTime;
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    24
};
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    25
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    26
DelayJitterEstimationTimestampTag::DelayJitterEstimationTimestampTag ()
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    27
  : m_creationTime (Simulator::Now ().GetTimeStep ())
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    28
{}
3038
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    29
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    30
TypeId 
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    31
DelayJitterEstimationTimestampTag::GetTypeId (void)
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    32
{
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    33
  static TypeId tid = TypeId ("anon::DelayJitterEstimationTimestampTag")
3040
e11e106c7c19 Mtag -> Tag
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3038
diff changeset
    34
    .SetParent<Tag> ()
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    35
    .AddConstructor<DelayJitterEstimationTimestampTag> ()
3038
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    36
    .AddAttribute ("CreationTime",
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    37
		   "The time at which the timestamp was created",
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    38
		   StringValue ("0.0s"),
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    39
		   MakeTimeAccessor (&DelayJitterEstimationTimestampTag::GetTxTime),
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    40
		   MakeTimeChecker ())
3038
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    41
    ;
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    42
  return tid;
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    43
}
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    44
TypeId 
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    45
DelayJitterEstimationTimestampTag::GetInstanceTypeId (void) const
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    46
{
3038
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    47
  return GetTypeId ();
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    48
}
3038
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    49
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    50
uint32_t 
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    51
DelayJitterEstimationTimestampTag::GetSerializedSize (void) const
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    52
{
3038
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    53
  return 8;
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    54
}
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    55
void 
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    56
DelayJitterEstimationTimestampTag::Serialize (TagBuffer i) const
3038
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    57
{
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    58
  i.WriteU64 (m_creationTime);
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    59
}
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    60
void 
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    61
DelayJitterEstimationTimestampTag::Deserialize (TagBuffer i)
3038
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    62
{
5962e2962fa9 convert to new tag API.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2287
diff changeset
    63
  m_creationTime = i.ReadU64 ();
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    64
}
3208
1a754d09c4ba bug 200: Packet::PrintTags is not implemented.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3084
diff changeset
    65
void 
1a754d09c4ba bug 200: Packet::PrintTags is not implemented.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3084
diff changeset
    66
DelayJitterEstimationTimestampTag::Print (std::ostream &os) const
1a754d09c4ba bug 200: Packet::PrintTags is not implemented.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3084
diff changeset
    67
{
1a754d09c4ba bug 200: Packet::PrintTags is not implemented.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3084
diff changeset
    68
  os << "CreationTime=" << m_creationTime;
1a754d09c4ba bug 200: Packet::PrintTags is not implemented.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3084
diff changeset
    69
}
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    70
Time 
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    71
DelayJitterEstimationTimestampTag::GetTxTime (void) const
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    72
{
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    73
  return TimeStep (m_creationTime);
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    74
}
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    75
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    76
DelayJitterEstimation::DelayJitterEstimation ()
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    77
  : m_previousRx (Simulator::Now ()),
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    78
    m_previousRxTx (Simulator::Now ()),
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    79
    m_jitter (Seconds (0.0)),
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    80
    m_delay (Seconds (0.0))
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    81
{}
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    82
void 
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    83
DelayJitterEstimation::PrepareTx (Ptr<const Packet> packet)
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    84
{
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    85
  DelayJitterEstimationTimestampTag tag;
4502
07d34c0d8d18 new tags
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3208
diff changeset
    86
  packet->AddByteTag (tag);
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    87
}
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    88
void 
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    89
DelayJitterEstimation::RecordRx (Ptr<const Packet> packet)
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    90
{
3084
3d83c2088c85 avoid warning with g++ 4.1.2
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3041
diff changeset
    91
  DelayJitterEstimationTimestampTag tag;
2281
1e9dd91f666f fix optimized build
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2265
diff changeset
    92
  bool found;
4502
07d34c0d8d18 new tags
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 3208
diff changeset
    93
  found = packet->FindFirstMatchingByteTag (tag);
2287
363c7065ce0e it is possible to receive packets which are not tagged. ignore them rather than crash.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2281
diff changeset
    94
  if (!found)
363c7065ce0e it is possible to receive packets which are not tagged. ignore them rather than crash.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2281
diff changeset
    95
    {
363c7065ce0e it is possible to receive packets which are not tagged. ignore them rather than crash.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2281
diff changeset
    96
      return;
363c7065ce0e it is possible to receive packets which are not tagged. ignore them rather than crash.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2281
diff changeset
    97
    }
2265
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    98
  tag.GetTxTime ();
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
    99
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   100
  Time delta = (Simulator::Now () - m_previousRx) - (tag.GetTxTime () - m_previousRxTx);
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   101
  m_jitter += (Abs (delta) - m_jitter ) / Scalar (16.0);
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   102
  m_previousRx = Simulator::Now ();
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   103
  m_previousRxTx = tag.GetTxTime ();
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   104
  m_delay = Simulator::Now () - tag.GetTxTime ();
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   105
}
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   106
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   107
Time 
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   108
DelayJitterEstimation::GetLastDelay (void) const
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   109
{
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   110
  return m_delay;
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   111
}
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   112
Time
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   113
DelayJitterEstimation::GetLastJitter (void) const
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   114
{
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   115
  return m_jitter;
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   116
}
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   117
190a2d913472 estimation delay and jitter
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
diff changeset
   118
} // namespace ns3