summaryrefslogtreecommitdiffstats
path: root/third_party/libwebrtc/rtc_base/frequency_tracker.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /third_party/libwebrtc/rtc_base/frequency_tracker.h
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/libwebrtc/rtc_base/frequency_tracker.h')
-rw-r--r--third_party/libwebrtc/rtc_base/frequency_tracker.h56
1 files changed, 56 insertions, 0 deletions
diff --git a/third_party/libwebrtc/rtc_base/frequency_tracker.h b/third_party/libwebrtc/rtc_base/frequency_tracker.h
new file mode 100644
index 0000000000..3ee2ab0e1a
--- /dev/null
+++ b/third_party/libwebrtc/rtc_base/frequency_tracker.h
@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2023 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 RTC_BASE_FREQUENCY_TRACKER_H_
+#define RTC_BASE_FREQUENCY_TRACKER_H_
+
+#include <stddef.h>
+#include <stdint.h>
+
+#include "absl/types/optional.h"
+#include "api/units/frequency.h"
+#include "api/units/time_delta.h"
+#include "api/units/timestamp.h"
+#include "rtc_base/rate_statistics.h"
+#include "rtc_base/system/rtc_export.h"
+
+namespace webrtc {
+// Class to estimate frequency (e.g. frame rate) over running window.
+// Timestamps used in Update() and Rate() must never decrease for two
+// consecutive calls.
+// This class is thread unsafe.
+class RTC_EXPORT FrequencyTracker {
+ public:
+ explicit FrequencyTracker(TimeDelta window_size);
+
+ FrequencyTracker(const FrequencyTracker&) = default;
+ FrequencyTracker(FrequencyTracker&&) = default;
+ FrequencyTracker& operator=(const FrequencyTracker&) = delete;
+ FrequencyTracker& operator=(FrequencyTracker&&) = delete;
+
+ ~FrequencyTracker() = default;
+
+ // Reset instance to original state.
+ void Reset() { impl_.Reset(); }
+
+ // Update rate with a new data point, moving averaging window as needed.
+ void Update(int64_t count, Timestamp now);
+ void Update(Timestamp now) { Update(1, now); }
+
+ // Returns rate, moving averaging window as needed.
+ // Returns nullopt when rate can't be measured.
+ absl::optional<Frequency> Rate(Timestamp now) const;
+
+ private:
+ RateStatistics impl_;
+};
+} // namespace webrtc
+
+#endif // RTC_BASE_FREQUENCY_TRACKER_H_