BWE Simulation Framework: Standard plot logging

webrtc/modules/remote_bitrate_estimator/test/packet_receiver.cc

 /*
  *  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.
  */
 
@@ skipping 14 matching lines @@
 namespace bwe {
 
 PacketReceiver::PacketReceiver(PacketProcessorListener* listener,
                                int flow_id,
                                BandwidthEstimatorType bwe_type,
                                bool plot_delay,
                                bool plot_bwe,
                                MetricRecorder* metric_recorder)
     : PacketProcessor(listener, flow_id, kReceiver),
       bwe_receiver_(CreateBweReceiver(bwe_type, flow_id, plot_bwe)),
-      metric_recorder_(metric_recorder) {
+      metric_recorder_(metric_recorder),
+      plot_delay_(plot_delay),
+      last_delay_plot_ms_(0),
+      delay_prefix_("Delay_ms#d") {

[stefan-webrtc, 2015/07/24 09:30:43]

What is #d?

[magalhaesc, 2015/07/24 13:51:40]

Replaced with #2, alignment with the right axis.

   if (metric_recorder_ != nullptr) {
     // Setup the prefix ststd::rings used when logging.
     std::vector<std::string> prefixes;
 
-    std::stringstream ss1;
-    ss1 << "Throughput_kbps_" << flow_id << "#2";
-    prefixes.push_back(ss1.str());  // Throughput.
-
-    std::stringstream ss2;
-    ss2 << "Delay_ms_" << flow_id << "#2";
-    prefixes.push_back(ss2.str());  // Delay.
-
-    std::stringstream ss3;
-    ss3 << "Packet_Loss_" << flow_id << "#2";
-    prefixes.push_back(ss3.str());  // Loss.
-
-    std::stringstream ss4;
-    ss4 << "Objective_function_" << flow_id << "#2";
-    prefixes.push_back(ss4.str());  // Objective.
+    prefixes.push_back("Throughput_kbps#2");      // Throughput.

[stefan-webrtc, 2015/07/24 09:30:42]

I find it odd that this is on #2 and not #1. Could you elaborate? I kind of
would like to keep the flow_id in the name as well if possible, so that it's
easy to see what flow has what rate. We can discuss if this is hard to get
right.

[magalhaesc, 2015/07/24 13:51:40]

Done, Adopting #1 for left axis alignment.

The flow_id was being printed twice in every line. So now we kept the
BWE_TEST_LOGGING_CONTEXT(*flow_ids().begin());

What was Receiver_FLOWID_Throughput_FLOWID#1
is now Receiver_FLOWID_Throughput#1

Is that ok?

[stefan-webrtc, 2015/07/24 14:06:55]

Sounds good

+    prefixes.push_back("Delay_ms_#2");            // Delay.

[stefan-webrtc, 2015/07/24 09:30:42]

Should Delay_ms_#2 be the same format as Delay_ms#d?

[magalhaesc, 2015/07/24 13:51:40]

The metric recorder uses separate figure_id for each plot (which turns out into
separate boxes in plot_dynamics.py and separated windows in plot_dynamics.sh).

In this case we will need only one axis label, so the delay will be alignment
with the left side.

WDYT?

[stefan-webrtc, 2015/07/24 14:06:55]

Sounds good.

+    prefixes.push_back("Packet_Loss_#2");         // Loss.
+    prefixes.push_back("Objective_function_#2");  // Objective.
 
     // Plot Total/PerFlow Available capacity together with throughputs.
-    std::stringstream ss5;
-    ss5 << "Throughput_kbps" << flow_id << "#1";
-    prefixes.push_back(ss5.str());  // Total Available.
-    prefixes.push_back(ss5.str());  // Available per flow.
+    prefixes.push_back("Throughput_kbps#1");  // Total Available.
+    prefixes.push_back("Throughput_kbps#1");  // Available per flow.
 
     metric_recorder_->SetPlotInformation(prefixes);
   }
 }
 
 PacketReceiver::PacketReceiver(PacketProcessorListener* listener,
                                int flow_id,
                                BandwidthEstimatorType bwe_type,
                                bool plot_delay,
                                bool plot_bwe)
@@ skipping 24 matching lines @@
       // time once packet reaches the estimator.
       int64_t arrival_time_ms = media_packet->send_time_ms();
       int64_t send_time_ms = media_packet->creation_time_ms();
       delay_stats_.Push(arrival_time_ms - send_time_ms);
 
       if (metric_recorder_ != nullptr) {
         metric_recorder_->UpdateTime(arrival_time_ms);
         UpdateMetrics(arrival_time_ms, send_time_ms,
                       media_packet->payload_size());
         metric_recorder_->PlotAllDynamics();
+      } else if (plot_delay_) {
+        PlotDelay(arrival_time_ms, send_time_ms);
       }
 
       bwe_receiver_->ReceivePacket(arrival_time_ms, *media_packet);
       FeedbackPacket* fb = bwe_receiver_->GetFeedback(arrival_time_ms);
       if (fb)
         feedback.push_back(fb);
       delete media_packet;
       it = in_out->erase(it);
     } else {
       ++it;
     }
   }
   // Insert feedback packets to be sent back to the sender.
   in_out->merge(feedback, DereferencingComparator<Packet>);
 }
 
 void PacketReceiver::UpdateMetrics(int64_t arrival_time_ms,
                                    int64_t send_time_ms,
                                    size_t payload_size) {
   metric_recorder_->UpdateThroughput(bwe_receiver_->RecentKbps(), payload_size);
   metric_recorder_->UpdateDelay(arrival_time_ms - send_time_ms);
   metric_recorder_->UpdateLoss(bwe_receiver_->RecentPacketLossRatio());
   metric_recorder_->UpdateObjective();
 }
 
+void PacketReceiver::PlotDelay(int64_t arrival_time_ms, int64_t send_time_ms) {
+  const int64_t kDelayPlotIntervalMs = 100;
+  if (arrival_time_ms >= last_delay_plot_ms_ + kDelayPlotIntervalMs) {
+    BWE_TEST_LOGGING_PLOT(0, delay_prefix_, arrival_time_ms,
+                          arrival_time_ms - send_time_ms);
+    last_delay_plot_ms_ = arrival_time_ms;
+  }
+}
+
 float PacketReceiver::GlobalPacketLoss() {
   return bwe_receiver_->GlobalReceiverPacketLossRatio();
 }
 
 Stats<double> PacketReceiver::GetDelayStats() const {
   return delay_stats_;
 }
 }  // namespace bwe
 }  // namespace testing
 }  // namespace webrtc