Add probe logging to RtcEventLog.

webrtc/logging/rtc_event_log/rtc_event_log.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.
  */
 
@@ skipping 18 matching lines @@
 namespace rtclog {
 class EventStream;
 }  // namespace rtclog
 
 class Clock;
 class RtcEventLogImpl;
 
 enum class MediaType;
 
 enum PacketDirection { kIncomingPacket = 0, kOutgoingPacket };
+enum ProbeFailureReason {
+  kInvalidSendReceiveInterval,
+  kInvalidSendReceiveRatio,
+  kTimeout
+};
 
 class RtcEventLog {
  public:
   virtual ~RtcEventLog() {}
 
   // Factory method to create an RtcEventLog object.
   static std::unique_ptr<RtcEventLog> Create();
   // TODO(nisse): webrtc::Clock is deprecated. Delete this method and
   // above forward declaration of Clock when
   // webrtc/system_wrappers/include/clock.h is deleted.
@@ skipping 46 matching lines @@
   virtual void LogAudioSendStreamConfig(
       const webrtc::AudioSendStream::Config& config) = 0;
 
   // Logs the header of an incoming or outgoing RTP packet. packet_length
   // is the total length of the packet, including both header and payload.
   virtual void LogRtpHeader(PacketDirection direction,
                             MediaType media_type,
                             const uint8_t* header,
                             size_t packet_length) = 0;
 
+  // Same as above but used on the sender side to log packets that are part of
+  // a probe cluster.
+  virtual void LogRtpHeader(PacketDirection direction,
+                            MediaType media_type,
+                            const uint8_t* header,
+                            size_t packet_length,
+                            int probe_cluster_id) = 0;
+
   // Logs an incoming or outgoing RTCP packet.
   virtual void LogRtcpPacket(PacketDirection direction,
                              MediaType media_type,
                              const uint8_t* packet,
                              size_t length) = 0;
 
   // Logs an audio playout event.
   virtual void LogAudioPlayout(uint32_t ssrc) = 0;
 
   // Logs a bitrate update from the bandwidth estimator based on packet loss.
   virtual void LogLossBasedBweUpdate(int32_t bitrate_bps,
                                      uint8_t fraction_loss,
                                      int32_t total_packets) = 0;
 
   // Logs a bitrate update from the bandwidth estimator based on delay changes.
   virtual void LogDelayBasedBweUpdate(int32_t bitrate_bps,
                                       BandwidthUsage detector_state) = 0;
 
   // Logs audio encoder re-configuration driven by audio network adaptor.
   virtual void LogAudioNetworkAdaptation(
       const AudioNetworkAdaptor::EncoderRuntimeConfig& config) = 0;
 
+  // Logs when a probe cluster is created.
+  virtual void LogProbeClusterCreated(int id,
+                                      int bitrate_bps,
+                                      int min_probes,
+                                      int min_bytes) = 0;
+
+  // Logs the result of a successful probing attempt.
+  virtual void LogProbeResultSuccess(int id, int bitrate_bps) = 0;
+
+  // Logs the result of an unsuccessful probing attempt.
+  virtual void LogProbeResultFailure(int id,
+                                     ProbeFailureReason failure_reason) = 0;
+
   // Reads an RtcEventLog file and returns true when reading was successful.
   // The result is stored in the given EventStream object.
   // The order of the events in the EventStream is implementation defined.
   // The current implementation writes a LOG_START event, then the old
   // configurations, then the remaining events in timestamp order and finally
   // a LOG_END event. However, this might change without further notice.
   // TODO(terelius): Change result type to a vector?
   static bool ParseRtcEventLog(const std::string& file_name,
                                rtclog::EventStream* result);
 };
@@ skipping 13 matching lines @@
   void LogVideoSendStreamConfig(
       const VideoSendStream::Config& config) override {}
   void LogAudioReceiveStreamConfig(
       const AudioReceiveStream::Config& config) override {}
   void LogAudioSendStreamConfig(
       const AudioSendStream::Config& config) override {}
   void LogRtpHeader(PacketDirection direction,
                     MediaType media_type,
                     const uint8_t* header,
                     size_t packet_length) override {}
+  void LogRtpHeader(PacketDirection direction,
+                    MediaType media_type,
+                    const uint8_t* header,
+                    size_t packet_length,
+                    int probe_cluster_id) override {}
   void LogRtcpPacket(PacketDirection direction,
                      MediaType media_type,
                      const uint8_t* packet,
                      size_t length) override {}
   void LogAudioPlayout(uint32_t ssrc) override {}
   void LogLossBasedBweUpdate(int32_t bitrate_bps,
                              uint8_t fraction_loss,
                              int32_t total_packets) override {}
   void LogDelayBasedBweUpdate(int32_t bitrate_bps,
                               BandwidthUsage detector_state) override {}
   void LogAudioNetworkAdaptation(
       const AudioNetworkAdaptor::EncoderRuntimeConfig& config) override {}
+  void LogProbeClusterCreated(int id,
+                              int bitrate_bps,
+                              int min_probes,
+                              int min_bytes) override{};
+  void LogProbeResultSuccess(int id, int bitrate_bps) override{};
+  void LogProbeResultFailure(int id,
+                             ProbeFailureReason failure_reason) override{};
 };
 
 }  // namespace webrtc
 
 #endif  // WEBRTC_LOGGING_RTC_EVENT_LOG_RTC_EVENT_LOG_H_