From d8bbc7858622b6d9c278469aab701ca0b609cddf Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 15 May 2024 05:35:49 +0200 Subject: Merging upstream version 126.0. Signed-off-by: Daniel Baumann --- third_party/libwebrtc/api/stats/rtc_stats.h | 329 ++++++---------------------- 1 file changed, 67 insertions(+), 262 deletions(-) (limited to 'third_party/libwebrtc/api/stats/rtc_stats.h') diff --git a/third_party/libwebrtc/api/stats/rtc_stats.h b/third_party/libwebrtc/api/stats/rtc_stats.h index 6cc39a309f..edd293f5c9 100644 --- a/third_party/libwebrtc/api/stats/rtc_stats.h +++ b/third_party/libwebrtc/api/stats/rtc_stats.h @@ -20,7 +20,8 @@ #include #include -#include "absl/types/optional.h" +#include "api/stats/attribute.h" +#include "api/stats/rtc_stats_member.h" #include "api/units/timestamp.h" #include "rtc_base/checks.h" #include "rtc_base/system/rtc_export.h" @@ -28,8 +29,6 @@ namespace webrtc { -class RTCStatsMemberInterface; - // Abstract base class for RTCStats-derived dictionaries, see // https://w3c.github.io/webrtc-stats/. // @@ -40,8 +39,8 @@ class RTCStatsMemberInterface; // Use the `WEBRTC_RTCSTATS_IMPL` macro when implementing subclasses, see macro // for details. // -// Derived classes list their dictionary members, RTCStatsMember, as public -// fields, allowing the following: +// Derived classes list their dictionary attributes (RTCStatsMember to soon +// be replaced by absl::optional) as public fields, allowing the following: // // RTCFooStats foo("fooId", Timestamp::Micros(GetCurrentTime())); // foo.bar = 42; @@ -49,17 +48,18 @@ class RTCStatsMemberInterface; // foo.baz->push_back("hello world"); // uint32_t x = *foo.bar; // -// Pointers to all the members are available with `Members`, allowing iteration: +// Pointers to all the attributes are available with `Attributes()`, allowing +// iteration: // -// for (const RTCStatsMemberInterface* member : foo.Members()) { -// printf("%s = %s\n", member->name(), member->ValueToString().c_str()); +// for (const auto& attribute : foo.Attributes()) { +// printf("%s = %s\n", attribute.name(), attribute.ValueToString().c_str()); // } class RTC_EXPORT RTCStats { public: RTCStats(const std::string& id, Timestamp timestamp) : id_(id), timestamp_(timestamp) {} - - virtual ~RTCStats() {} + RTCStats(const RTCStats& other); + virtual ~RTCStats(); virtual std::unique_ptr copy() const = 0; @@ -69,18 +69,30 @@ class RTC_EXPORT RTCStats { // Returns the static member variable `kType` of the implementing class. virtual const char* type() const = 0; - // Returns a vector of pointers to all the `RTCStatsMemberInterface` members - // of this class. This allows for iteration of members. For a given class, - // `Members` always returns the same members in the same order. - std::vector Members() const; + // Returns all attributes of this stats object, i.e. a list of its individual + // metrics as viewed via the Attribute wrapper. + std::vector Attributes() const; + template + Attribute GetAttribute(const RTCStatsMember& stat) const { + for (const auto& attribute : Attributes()) { + if (!attribute.holds_alternative()) { + continue; + } + if (absl::get*>(attribute.as_variant()) == + &stat) { + return attribute; + } + } + RTC_CHECK_NOTREACHED(); + } // Checks if the two stats objects are of the same type and have the same - // member values. Timestamps are not compared. These operators are exposed for - // testing. + // attribute values. Timestamps are not compared. These operators are exposed + // for testing. bool operator==(const RTCStats& other) const; bool operator!=(const RTCStats& other) const; // Creates a JSON readable string representation of the stats - // object, listing all of its members (names and values). + // object, listing all of its attributes (names and values). std::string ToJson() const; // Downcasts the stats object to an `RTCStats` subclass `T`. DCHECKs that the @@ -92,12 +104,8 @@ class RTC_EXPORT RTCStats { } protected: - // Gets a vector of all members of this `RTCStats` object, including members - // derived from parent classes. `additional_capacity` is how many more members - // shall be reserved in the vector (so that subclasses can allocate a vector - // with room for both parent and child members without it having to resize). - virtual std::vector - MembersOfThisObjectAndAncestors(size_t additional_capacity) const; + virtual std::vector AttributesImpl( + size_t additional_capacity) const; std::string const id_; Timestamp timestamp_; @@ -109,9 +117,8 @@ class RTC_EXPORT RTCStats { // // These macros declare (in _DECL) and define (in _IMPL) the static `kType` and // overrides methods as required by subclasses of `RTCStats`: `copy`, `type` and -// `MembersOfThisObjectAndAncestors`. The |...| argument is a list of addresses -// to each member defined in the implementing class. The list must have at least -// one member. +// `AttributesImpl`. The |...| argument is a list of addresses to each attribute +// defined in the implementing class. The list must have at least one attribute. // // (Since class names need to be known to implement these methods this cannot be // part of the base `RTCStats`. While these methods could be implemented using @@ -144,247 +151,45 @@ class RTC_EXPORT RTCStats { // bar("bar") { // } // -#define WEBRTC_RTCSTATS_DECL() \ - protected: \ - std::vector \ - MembersOfThisObjectAndAncestors(size_t local_var_additional_capacity) \ - const override; \ - \ - public: \ - static const char kType[]; \ - \ - std::unique_ptr copy() const override; \ - const char* type() const override - -#define WEBRTC_RTCSTATS_IMPL(this_class, parent_class, type_str, ...) \ - const char this_class::kType[] = type_str; \ - \ - std::unique_ptr this_class::copy() const { \ - return std::make_unique(*this); \ - } \ - \ - const char* this_class::type() const { \ - return this_class::kType; \ - } \ - \ - std::vector \ - this_class::MembersOfThisObjectAndAncestors( \ - size_t local_var_additional_capacity) const { \ - const webrtc::RTCStatsMemberInterface* local_var_members[] = { \ - __VA_ARGS__}; \ - size_t local_var_members_count = \ - sizeof(local_var_members) / sizeof(local_var_members[0]); \ - std::vector \ - local_var_members_vec = parent_class::MembersOfThisObjectAndAncestors( \ - local_var_members_count + local_var_additional_capacity); \ - RTC_DCHECK_GE( \ - local_var_members_vec.capacity() - local_var_members_vec.size(), \ - local_var_members_count + local_var_additional_capacity); \ - local_var_members_vec.insert(local_var_members_vec.end(), \ - &local_var_members[0], \ - &local_var_members[local_var_members_count]); \ - return local_var_members_vec; \ - } - -// A version of WEBRTC_RTCSTATS_IMPL() where "..." is omitted, used to avoid a -// compile error on windows. This is used if the stats dictionary does not -// declare any members of its own (but perhaps its parent dictionary does). -#define WEBRTC_RTCSTATS_IMPL_NO_MEMBERS(this_class, parent_class, type_str) \ - const char this_class::kType[] = type_str; \ - \ - std::unique_ptr this_class::copy() const { \ - return std::make_unique(*this); \ - } \ +#define WEBRTC_RTCSTATS_DECL() \ + protected: \ + std::vector AttributesImpl(size_t additional_capacity) \ + const override; \ \ - const char* this_class::type() const { \ - return this_class::kType; \ - } \ + public: \ + static const char kType[]; \ \ - std::vector \ - this_class::MembersOfThisObjectAndAncestors( \ - size_t local_var_additional_capacity) const { \ - return parent_class::MembersOfThisObjectAndAncestors(0); \ - } - -// Interface for `RTCStats` members, which have a name and a value of a type -// defined in a subclass. Only the types listed in `Type` are supported, these -// are implemented by `RTCStatsMember`. The value of a member may be -// undefined, the value can only be read if `is_defined`. -class RTCStatsMemberInterface { - public: - // Member value types. - enum Type { - kBool, // bool - kInt32, // int32_t - kUint32, // uint32_t - kInt64, // int64_t - kUint64, // uint64_t - kDouble, // double - kString, // std::string - - kSequenceBool, // std::vector - kSequenceInt32, // std::vector - kSequenceUint32, // std::vector - kSequenceInt64, // std::vector - kSequenceUint64, // std::vector - kSequenceDouble, // std::vector - kSequenceString, // std::vector - - kMapStringUint64, // std::map - kMapStringDouble, // std::map - }; - - virtual ~RTCStatsMemberInterface() {} - - const char* name() const { return name_; } - virtual Type type() const = 0; - virtual bool is_sequence() const = 0; - virtual bool is_string() const = 0; - virtual bool is_defined() const = 0; - // Type and value comparator. The names are not compared. These operators are - // exposed for testing. - bool operator==(const RTCStatsMemberInterface& other) const { - return IsEqual(other); - } - bool operator!=(const RTCStatsMemberInterface& other) const { - return !(*this == other); - } - virtual std::string ValueToString() const = 0; - // This is the same as ValueToString except for kInt64 and kUint64 types, - // where the value is represented as a double instead of as an integer. - // Since JSON stores numbers as floating point numbers, very large integers - // cannot be accurately represented, so we prefer to display them as doubles - // instead. - virtual std::string ValueToJson() const = 0; - - template - const T& cast_to() const { - RTC_DCHECK_EQ(type(), T::StaticType()); - return static_cast(*this); - } - - protected: - explicit RTCStatsMemberInterface(const char* name) : name_(name) {} - - virtual bool IsEqual(const RTCStatsMemberInterface& other) const = 0; - - const char* const name_; -}; - -// Template implementation of `RTCStatsMemberInterface`. -// The supported types are the ones described by -// `RTCStatsMemberInterface::Type`. -template -class RTCStatsMember : public RTCStatsMemberInterface { - public: - explicit RTCStatsMember(const char* name) - : RTCStatsMemberInterface(name), value_() {} - RTCStatsMember(const char* name, const T& value) - : RTCStatsMemberInterface(name), value_(value) {} - RTCStatsMember(const char* name, T&& value) - : RTCStatsMemberInterface(name), value_(std::move(value)) {} - explicit RTCStatsMember(const RTCStatsMember& other) - : RTCStatsMemberInterface(other.name_), value_(other.value_) {} - explicit RTCStatsMember(RTCStatsMember&& other) - : RTCStatsMemberInterface(other.name_), value_(std::move(other.value_)) {} - - static Type StaticType(); - Type type() const override { return StaticType(); } - bool is_sequence() const override; - bool is_string() const override; - bool is_defined() const override { return value_.has_value(); } - std::string ValueToString() const override; - std::string ValueToJson() const override; - - template - inline T ValueOrDefault(U default_value) const { - return value_.value_or(default_value); - } - - // Assignment operators. - T& operator=(const T& value) { - value_ = value; - return value_.value(); - } - T& operator=(const T&& value) { - value_ = std::move(value); - return value_.value(); - } - - // Getter methods that look the same as absl::optional. Please prefer these - // in order to unblock replacing RTCStatsMember with absl::optional in - // the future (https://crbug.com/webrtc/15164). - bool has_value() const { return value_.has_value(); } - const T& value() const { return value_.value(); } - T& value() { return value_.value(); } - T& operator*() { - RTC_DCHECK(value_); - return *value_; - } - const T& operator*() const { - RTC_DCHECK(value_); - return *value_; - } - T* operator->() { - RTC_DCHECK(value_); - return &(*value_); - } - const T* operator->() const { - RTC_DCHECK(value_); - return &(*value_); - } + std::unique_ptr copy() const override; \ + const char* type() const override - protected: - bool IsEqual(const RTCStatsMemberInterface& other) const override { - if (type() != other.type()) - return false; - const RTCStatsMember& other_t = - static_cast&>(other); - return value_ == other_t.value_; +#define WEBRTC_RTCSTATS_IMPL(this_class, parent_class, type_str, ...) \ + const char this_class::kType[] = type_str; \ + \ + std::unique_ptr this_class::copy() const { \ + return std::make_unique(*this); \ + } \ + \ + const char* this_class::type() const { \ + return this_class::kType; \ + } \ + \ + std::vector this_class::AttributesImpl( \ + size_t additional_capacity) const { \ + webrtc::AttributeInit attribute_inits[] = {__VA_ARGS__}; \ + size_t attribute_inits_size = \ + sizeof(attribute_inits) / sizeof(attribute_inits[0]); \ + std::vector attributes = parent_class::AttributesImpl( \ + attribute_inits_size + additional_capacity); \ + for (size_t i = 0; i < attribute_inits_size; ++i) { \ + attributes.push_back(absl::visit( \ + [&](const auto* field) { \ + return Attribute(attribute_inits[i].name, field); \ + }, \ + attribute_inits[i].variant)); \ + } \ + return attributes; \ } - private: - absl::optional value_; -}; - -namespace rtc_stats_internal { - -typedef std::map MapStringUint64; -typedef std::map MapStringDouble; - -} // namespace rtc_stats_internal - -#define WEBRTC_DECLARE_RTCSTATSMEMBER(T) \ - template <> \ - RTC_EXPORT RTCStatsMemberInterface::Type RTCStatsMember::StaticType(); \ - template <> \ - RTC_EXPORT bool RTCStatsMember::is_sequence() const; \ - template <> \ - RTC_EXPORT bool RTCStatsMember::is_string() const; \ - template <> \ - RTC_EXPORT std::string RTCStatsMember::ValueToString() const; \ - template <> \ - RTC_EXPORT std::string RTCStatsMember::ValueToJson() const; \ - extern template class RTC_EXPORT_TEMPLATE_DECLARE(RTC_EXPORT) \ - RTCStatsMember - -WEBRTC_DECLARE_RTCSTATSMEMBER(bool); -WEBRTC_DECLARE_RTCSTATSMEMBER(int32_t); -WEBRTC_DECLARE_RTCSTATSMEMBER(uint32_t); -WEBRTC_DECLARE_RTCSTATSMEMBER(int64_t); -WEBRTC_DECLARE_RTCSTATSMEMBER(uint64_t); -WEBRTC_DECLARE_RTCSTATSMEMBER(double); -WEBRTC_DECLARE_RTCSTATSMEMBER(std::string); -WEBRTC_DECLARE_RTCSTATSMEMBER(std::vector); -WEBRTC_DECLARE_RTCSTATSMEMBER(std::vector); -WEBRTC_DECLARE_RTCSTATSMEMBER(std::vector); -WEBRTC_DECLARE_RTCSTATSMEMBER(std::vector); -WEBRTC_DECLARE_RTCSTATSMEMBER(std::vector); -WEBRTC_DECLARE_RTCSTATSMEMBER(std::vector); -WEBRTC_DECLARE_RTCSTATSMEMBER(std::vector); -WEBRTC_DECLARE_RTCSTATSMEMBER(rtc_stats_internal::MapStringUint64); -WEBRTC_DECLARE_RTCSTATSMEMBER(rtc_stats_internal::MapStringDouble); - } // namespace webrtc #endif // API_STATS_RTC_STATS_H_ -- cgit v1.2.3