More Simulation Framework features

webrtc/modules/remote_bitrate_estimator/test/bwe.h

 /*
  *  Copyright (c) 2015 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #ifndef WEBRTC_MODULES_REMOTE_BITRATE_ESTIMATOR_TEST_BWE_H_
 #define WEBRTC_MODULES_REMOTE_BITRATE_ESTIMATOR_TEST_BWE_H_
 
 #include <sstream>
 
 #include "webrtc/modules/remote_bitrate_estimator/test/packet.h"
 #include "webrtc/modules/bitrate_controller/include/bitrate_controller.h"
+#include "webrtc/modules/remote_bitrate_estimator/test/bwe_test_framework.h"
 
 namespace webrtc {
 namespace testing {
 namespace bwe {
 
 // Holds only essential information about packets to be saved for
 // further use, e.g. for calculating packet loss and receiving rate.
 struct PacketIdentifierNode {
   PacketIdentifierNode(uint16_t sequence_number,
                        int64_t send_time_ms,
@@ skipping 31 matching lines @@
   PacketNodeIt begin() { return list_.begin(); }
   PacketNodeIt end() { return list_.end(); }
   bool empty() { return list_.empty(); }
   size_t size() { return list_.size(); }
   // Gets the latest arrived sequence number.
   uint16_t find_max() { return map_.rbegin()->first; }
   // Gets the first arrived sequence number still saved in the LinkedSet.
   uint16_t find_min() { return map_.begin()->first; }
   // Gets the lowest saved sequence number that is >= than the input key.
   uint16_t lower_bound(uint16_t key) { return map_.lower_bound(key)->first; }
-  // Gets the highest saved sequence number that is <= than the input key.
-  uint16_t upper_bound(uint16_t key) { return map_.upper_bound(key)->first; }
+  // Gets the highest saved sequence number that is < than the input key.
+  uint16_t upper_bound(uint16_t key) {

[stefan-webrtc, 2015/06/25 14:44:04]

Isn't it very confusing to call this upper_bound now that it is not the
upper_bound? :)

[magalhaesc, 2015/07/01 12:48:40]

I agree.

For a set containing values {2, 1, 0, 65535, 65534}, 
"lower_bound" returns 65534
"upper_bound" returns 2

So I renamed those methods "OldestSeqNumber" and "NewestSeqNumber" (not time
based), what do you think?

I also added unittests for them.

+    return (--map_.lower_bound(key))->first;
+  }
   size_t capacity() { return capacity_; }
+  void Clear() {
+    map_.clear();
+    list_.clear();
+  }
 
  private:
   // Pop oldest element from the back of the list and remove it from the map.
   void RemoveTail();
   // Add new element to the front of the list and insert it in the map.
   void UpdateHead(PacketIdentifierNode* new_head);
   size_t capacity_;
   std::map<uint16_t, PacketNodeIt> map_;
   std::list<PacketIdentifierNode*> list_;
 };
 
-const int kMinBitrateKbps = 150;
-const int kMaxBitrateKbps = 3000;
+const int kMinBitrateKbps = 50;
+const int kMaxBitrateKbps = 2500;
 
 class BweSender : public Module {
  public:
-  BweSender() {}
+  BweSender() : running_(true) {}
   virtual ~BweSender() {}
 
   virtual int GetFeedbackIntervalMs() const = 0;
   virtual void GiveFeedback(const FeedbackPacket& feedback) = 0;
   virtual void OnPacketsSent(const Packets& packets) = 0;
+  virtual void Pause();
+  virtual void Resume();
+
+ protected:
+  bool running_;
+  int bitrate_kbps_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(BweSender);
 };
 
 class BweReceiver {
  public:
   explicit BweReceiver(int flow_id);
   virtual ~BweReceiver() {}
 
   virtual void ReceivePacket(int64_t arrival_time_ms,
                              const MediaPacket& media_packet) {}
   virtual FeedbackPacket* GetFeedback(int64_t now_ms) { return NULL; }
 
-  float GlobalPacketLossRatio();
+  float GlobalReceiverPacketLossRatio();
+  float LinkedSetPacketLossRatio();

[stefan-webrtc, 2015/06/25 14:44:03]

It's not clear what this is supposed to be used for. What is different between
this, Global and Recent?

[stefan-webrtc, 2015/06/25 14:44:04]

Should be private I think? Maybe other methods as well?

[magalhaesc, 2015/07/01 12:48:40]

The only difference is the amount of packets considered:

-- RecentPacketLossRatio
Only packets in the latest time window (here = 500ms)
Used to plot packet loss dynamics.

-- LinkedSetPacketLoss
All packets stored in the LinkedSet, up to 10000.
Used to update global loss account whenever the set is filled and cleared.

-- GlobalPacketLoss
Computes the packet loss during an entire simulation, up to 4 billion packets.

[magalhaesc, 2015/07/01 12:48:40]

Yes, some methods are private now.

   float RecentPacketLossRatio();
+  size_t RecentReceivingRate();
+  uint32_t RecentKbps() {
+    return (rate_counter_.bits_per_second() + 500) / 1000;
+  }

[stefan-webrtc, 2015/06/25 14:44:03]

Do we need both RecentKbps and RecentReceivingRate()?

[magalhaesc, 2015/07/01 12:48:39]

No, we don't.
RecentReceivingRate will be removed.

   size_t GetSetCapacity() { return received_packets_.capacity(); }
+  void UpdateLossAccount();

[stefan-webrtc, 2015/06/25 14:44:04]

Just UpdateLoss()

[magalhaesc, 2015/07/01 12:48:40]

Done.

+  void ClearSet();
 
   static const int64_t kPacketLossTimeWindowMs = 500;
+  static const int64_t kReceivingRateTimeWindowMs = 1000;
+
+  // Used for calculating global packet loss ratio.
+  uint32_t num_previous_total_packets_;
+  uint32_t num_previous_lost_packets_;
 
  protected:
   int flow_id_;
   // Deals with packets sent more than once.
   LinkedSet received_packets_;
+  // Used for calculating recent receiving rate.
+  RateCounter rate_counter_;
 };
 
 enum BandwidthEstimatorType {
-  kNullEstimator,
+  kNullEstimator = 0,
   kNadaEstimator,
   kRembEstimator,
   kFullSendSideEstimator,
   kTcpEstimator
 };
 
+const std::string bwe_names[] = {"Null", "NADA", "REMB", "GCC", "TCP"};
+
 int64_t GetAbsSendTimeInMs(uint32_t abs_send_time);
 
 BweSender* CreateBweSender(BandwidthEstimatorType estimator,
                            int kbps,
                            BitrateObserver* observer,
                            Clock* clock);
 
 BweReceiver* CreateBweReceiver(BandwidthEstimatorType type,
                                int flow_id,
                                bool plot);
 }  // namespace bwe
 }  // namespace testing
 }  // namespace webrtc
 #endif  // WEBRTC_MODULES_REMOTE_BITRATE_ESTIMATOR_TEST_BWE_H_