Add new event type to RtcEventLog
Alr state is now logged by the pacer. To avoid confusion,
loopback tools will now create two separate rtc event
logs for sender and receiver calls.
Bug: webrtc:8287, webrtc:8588
Change-Id: Ib3e47d109c3a65a7ed069b9a613e6a08fe6a2f30
Reviewed-on: https://webrtc-review.googlesource.com/26880
Reviewed-by: Erik Språng <sprang@webrtc.org>
Reviewed-by: Björn Terelius <terelius@webrtc.org>
Reviewed-by: Philip Eliasson <philipel@webrtc.org>
Commit-Queue: Ilya Nikolaevskiy <ilnik@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#21084}diff --git a/logging/BUILD.gn b/logging/BUILD.gn
index 9588778..7d464a6 100644
--- a/logging/BUILD.gn
+++ b/logging/BUILD.gn
@@ -25,6 +25,8 @@
rtc_source_set("rtc_event_log_api") {
sources = [
"rtc_event_log/events/rtc_event.h",
+ "rtc_event_log/events/rtc_event_alr_state.cc",
+ "rtc_event_log/events/rtc_event_alr_state.h",
"rtc_event_log/events/rtc_event_audio_network_adaptation.cc",
"rtc_event_log/events/rtc_event_audio_network_adaptation.h",
"rtc_event_log/events/rtc_event_audio_playout.cc",
diff --git a/logging/rtc_event_log/encoder/rtc_event_log_encoder_legacy.cc b/logging/rtc_event_log/encoder/rtc_event_log_encoder_legacy.cc
index 36cca88..dd4abd9 100644
--- a/logging/rtc_event_log/encoder/rtc_event_log_encoder_legacy.cc
+++ b/logging/rtc_event_log/encoder/rtc_event_log_encoder_legacy.cc
@@ -10,6 +10,7 @@
#include "logging/rtc_event_log/encoder/rtc_event_log_encoder_legacy.h"
+#include "logging/rtc_event_log/events/rtc_event_alr_state.h"
#include "logging/rtc_event_log/events/rtc_event_audio_network_adaptation.h"
#include "logging/rtc_event_log/events/rtc_event_audio_playout.h"
#include "logging/rtc_event_log/events/rtc_event_audio_receive_stream_config.h"
@@ -114,6 +115,11 @@
return EncodeAudioNetworkAdaptation(rtc_event);
}
+ case RtcEvent::Type::AlrStateEvent: {
+ auto& rtc_event = static_cast<const RtcEventAlrState&>(event);
+ return EncodeAlrState(rtc_event);
+ }
+
case RtcEvent::Type::AudioPlayout: {
auto& rtc_event = static_cast<const RtcEventAudioPlayout&>(event);
return EncodeAudioPlayout(rtc_event);
@@ -204,6 +210,17 @@
return "";
}
+std::string RtcEventLogEncoderLegacy::EncodeAlrState(
+ const RtcEventAlrState& event) {
+ rtclog::Event rtclog_event;
+ rtclog_event.set_timestamp_us(event.timestamp_us_);
+ rtclog_event.set_type(rtclog::Event::ALR_STATE_EVENT);
+
+ auto alr_state = rtclog_event.mutable_alr_state();
+ alr_state->set_in_alr(event.in_alr_);
+ return Serialize(&rtclog_event);
+}
+
std::string RtcEventLogEncoderLegacy::EncodeAudioNetworkAdaptation(
const RtcEventAudioNetworkAdaptation& event) {
rtclog::Event rtclog_event;
diff --git a/logging/rtc_event_log/encoder/rtc_event_log_encoder_legacy.h b/logging/rtc_event_log/encoder/rtc_event_log_encoder_legacy.h
index b0909e2..f4d3355 100644
--- a/logging/rtc_event_log/encoder/rtc_event_log_encoder_legacy.h
+++ b/logging/rtc_event_log/encoder/rtc_event_log_encoder_legacy.h
@@ -42,6 +42,7 @@
class RtcEventRtpPacketOutgoing;
class RtcEventVideoReceiveStreamConfig;
class RtcEventVideoSendStreamConfig;
+class RtcEventAlrState;
class RtpPacket;
class RtcEventLogEncoderLegacy final : public RtcEventLogEncoder {
@@ -52,6 +53,7 @@
private:
// Encoding entry-point for the various RtcEvent subclasses.
+ std::string EncodeAlrState(const RtcEventAlrState& event);
std::string EncodeAudioNetworkAdaptation(
const RtcEventAudioNetworkAdaptation& event);
std::string EncodeAudioPlayout(const RtcEventAudioPlayout& event);
diff --git a/logging/rtc_event_log/events/rtc_event.h b/logging/rtc_event_log/events/rtc_event.h
index 2fe77b5..186e065 100644
--- a/logging/rtc_event_log/events/rtc_event.h
+++ b/logging/rtc_event_log/events/rtc_event.h
@@ -30,6 +30,7 @@
// superclass, but the *actual* information - rtclog::StreamConfig, etc. -
// is kept separate.
enum class Type {
+ AlrStateEvent,
AudioNetworkAdaptation,
AudioPlayout,
AudioReceiveStreamConfig,
diff --git a/logging/rtc_event_log/events/rtc_event_alr_state.cc b/logging/rtc_event_log/events/rtc_event_alr_state.cc
new file mode 100644
index 0000000..e329079
--- /dev/null
+++ b/logging/rtc_event_log/events/rtc_event_alr_state.cc
@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2017 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.
+ */
+
+#include "logging/rtc_event_log/events/rtc_event_alr_state.h"
+
+namespace webrtc {
+
+RtcEventAlrState::RtcEventAlrState(bool in_alr) : in_alr_(in_alr) {}
+
+RtcEventAlrState::~RtcEventAlrState() = default;
+
+RtcEvent::Type RtcEventAlrState::GetType() const {
+ return RtcEvent::Type::AlrStateEvent;
+}
+
+bool RtcEventAlrState::IsConfigEvent() const {
+ return false;
+}
+
+} // namespace webrtc
diff --git a/logging/rtc_event_log/events/rtc_event_alr_state.h b/logging/rtc_event_log/events/rtc_event_alr_state.h
new file mode 100644
index 0000000..d07f3f2
--- /dev/null
+++ b/logging/rtc_event_log/events/rtc_event_alr_state.h
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2017 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 LOGGING_RTC_EVENT_LOG_EVENTS_RTC_EVENT_ALR_STATE_H_
+#define LOGGING_RTC_EVENT_LOG_EVENTS_RTC_EVENT_ALR_STATE_H_
+
+#include "logging/rtc_event_log/events/rtc_event.h"
+
+#include "typedefs.h" // NOLINT(build/include)
+
+namespace webrtc {
+
+class RtcEventAlrState final : public RtcEvent {
+ public:
+ explicit RtcEventAlrState(bool in_alr);
+ ~RtcEventAlrState() override;
+
+ Type GetType() const override;
+
+ bool IsConfigEvent() const override;
+
+ const bool in_alr_;
+};
+
+} // namespace webrtc
+#endif // LOGGING_RTC_EVENT_LOG_EVENTS_RTC_EVENT_ALR_STATE_H_
diff --git a/logging/rtc_event_log/rtc_event_log.proto b/logging/rtc_event_log/rtc_event_log.proto
index b9053ae..8d2e22a 100644
--- a/logging/rtc_event_log/rtc_event_log.proto
+++ b/logging/rtc_event_log/rtc_event_log.proto
@@ -40,6 +40,7 @@
AUDIO_NETWORK_ADAPTATION_EVENT = 16;
BWE_PROBE_CLUSTER_CREATED_EVENT = 17;
BWE_PROBE_RESULT_EVENT = 18;
+ ALR_STATE_EVENT = 19;
}
// required - Indicates the type of this event
@@ -81,6 +82,9 @@
// required if type == BWE_PROBE_RESULT_EVENT
BweProbeResult probe_result = 18;
+
+ // required if type == ALR_STATE_EVENT
+ AlrState alr_state = 19;
}
}
@@ -314,3 +318,8 @@
// optional - but required if result == SUCCESS. The resulting bitrate in bps.
optional uint64 bitrate_bps = 3;
}
+
+message AlrState {
+ // required - If we are in ALR or not.
+ optional bool in_alr = 1;
+}
diff --git a/logging/rtc_event_log/rtc_event_log2stats.cc b/logging/rtc_event_log/rtc_event_log2stats.cc
index 7373736..f38322d 100644
--- a/logging/rtc_event_log/rtc_event_log2stats.cc
+++ b/logging/rtc_event_log/rtc_event_log2stats.cc
@@ -164,6 +164,8 @@
return "BWE_PROBE_CREATED";
case webrtc::rtclog::Event::BWE_PROBE_RESULT_EVENT:
return "BWE_PROBE_RESULT";
+ case webrtc::rtclog::Event::ALR_STATE_EVENT:
+ return "ALR_STATE_EVENT";
}
RTC_NOTREACHED();
return "UNKNOWN_EVENT";
diff --git a/logging/rtc_event_log/rtc_event_log2text.cc b/logging/rtc_event_log/rtc_event_log2text.cc
index dca0823..42ff732 100644
--- a/logging/rtc_event_log/rtc_event_log2text.cc
+++ b/logging/rtc_event_log/rtc_event_log2text.cc
@@ -785,6 +785,17 @@
event_recognized = true;
break;
}
+
+ case webrtc::ParsedRtcEventLog::ALR_STATE_EVENT: {
+ if (FLAG_bwe) {
+ webrtc::ParsedRtcEventLog::AlrStateEvent alr_state =
+ parsed_stream.GetAlrState(i);
+ std::cout << parsed_stream.GetTimestamp(i) << "\tALR_STATE"
+ << "\tin_alr=" << alr_state.in_alr << std::endl;
+ }
+ event_recognized = true;
+ break;
+ }
}
if (!event_recognized) {
diff --git a/logging/rtc_event_log/rtc_event_log_parser.cc b/logging/rtc_event_log/rtc_event_log_parser.cc
index 38697e9..194da57 100644
--- a/logging/rtc_event_log/rtc_event_log_parser.cc
+++ b/logging/rtc_event_log/rtc_event_log_parser.cc
@@ -74,6 +74,8 @@
return ParsedRtcEventLog::EventType::BWE_PROBE_CLUSTER_CREATED_EVENT;
case rtclog::Event::BWE_PROBE_RESULT_EVENT:
return ParsedRtcEventLog::EventType::BWE_PROBE_RESULT_EVENT;
+ case rtclog::Event::ALR_STATE_EVENT:
+ return ParsedRtcEventLog::EventType::ALR_STATE_EVENT;
}
return ParsedRtcEventLog::EventType::UNKNOWN_EVENT;
}
@@ -652,6 +654,22 @@
return res;
}
+ParsedRtcEventLog::AlrStateEvent ParsedRtcEventLog::GetAlrState(
+ size_t index) const {
+ RTC_CHECK_LT(index, GetNumberOfEvents());
+ const rtclog::Event& event = events_[index];
+ RTC_CHECK(event.has_type());
+ RTC_CHECK_EQ(event.type(), rtclog::Event::ALR_STATE_EVENT);
+ RTC_CHECK(event.has_alr_state());
+ const rtclog::AlrState& alr_event = event.alr_state();
+ AlrStateEvent res;
+ res.timestamp = GetTimestamp(index);
+ RTC_CHECK(alr_event.has_in_alr());
+ res.in_alr = alr_event.in_alr();
+
+ return res;
+}
+
// Returns the MediaType for registered SSRCs. Search from the end to use last
// registered types first.
ParsedRtcEventLog::MediaType ParsedRtcEventLog::GetMediaType(
diff --git a/logging/rtc_event_log/rtc_event_log_parser.h b/logging/rtc_event_log/rtc_event_log_parser.h
index 8192c30..6438918 100644
--- a/logging/rtc_event_log/rtc_event_log_parser.h
+++ b/logging/rtc_event_log/rtc_event_log_parser.h
@@ -65,6 +65,11 @@
BandwidthUsage detector_state;
};
+ struct AlrStateEvent {
+ uint64_t timestamp;
+ bool in_alr;
+ };
+
enum EventType {
UNKNOWN_EVENT = 0,
LOG_START = 1,
@@ -80,7 +85,8 @@
AUDIO_SENDER_CONFIG_EVENT = 11,
AUDIO_NETWORK_ADAPTATION_EVENT = 16,
BWE_PROBE_CLUSTER_CREATED_EVENT = 17,
- BWE_PROBE_RESULT_EVENT = 18
+ BWE_PROBE_RESULT_EVENT = 18,
+ ALR_STATE_EVENT = 19
};
enum class MediaType { ANY, AUDIO, VIDEO, DATA };
@@ -180,6 +186,8 @@
MediaType GetMediaType(uint32_t ssrc, PacketDirection direction) const;
+ AlrStateEvent GetAlrState(size_t index) const;
+
private:
rtclog::StreamConfig GetVideoReceiveConfig(const rtclog::Event& event) const;
std::vector<rtclog::StreamConfig> GetVideoSendConfig(
