OLD | NEW |
1 /* | 1 /* |
2 * Copyright (c) 2013 The WebRTC project authors. All Rights Reserved. | 2 * Copyright (c) 2013 The WebRTC project authors. All Rights Reserved. |
3 * | 3 * |
4 * Use of this source code is governed by a BSD-style license | 4 * Use of this source code is governed by a BSD-style license |
5 * that can be found in the LICENSE file in the root of the source | 5 * that can be found in the LICENSE file in the root of the source |
6 * tree. An additional intellectual property rights grant can be found | 6 * tree. An additional intellectual property rights grant can be found |
7 * in the file PATENTS. All contributing project authors may | 7 * in the file PATENTS. All contributing project authors may |
8 * be found in the AUTHORS file in the root of the source tree. | 8 * be found in the AUTHORS file in the root of the source tree. |
9 */ | 9 */ |
10 | 10 |
11 #ifndef WEBRTC_BASE_RATE_STATISTICS_H_ | 11 #ifndef WEBRTC_BASE_RATE_STATISTICS_H_ |
12 #define WEBRTC_BASE_RATE_STATISTICS_H_ | 12 #define WEBRTC_BASE_RATE_STATISTICS_H_ |
13 | 13 |
14 #include <memory> | |
15 | 14 |
16 #include "webrtc/base/optional.h" | 15 // This header is deprecated and is just left here temporarily during |
17 #include "webrtc/typedefs.h" | 16 // refactoring. See https://bugs.webrtc.org/7634 for more details. |
18 | 17 #include "webrtc/rtc_base/rate_statistics.h" |
19 namespace webrtc { | |
20 | |
21 class RateStatistics { | |
22 public: | |
23 static constexpr float kBpsScale = 8000.0f; | |
24 | |
25 // max_window_size_ms = Maximum window size in ms for the rate estimation. | |
26 // Initial window size is set to this, but may be changed | |
27 // to something lower by calling SetWindowSize(). | |
28 // scale = coefficient to convert counts/ms to desired unit | |
29 // ex: kBpsScale (8000) for bits/s if count represents bytes. | |
30 RateStatistics(int64_t max_window_size_ms, float scale); | |
31 ~RateStatistics(); | |
32 | |
33 // Reset instance to original state. | |
34 void Reset(); | |
35 | |
36 // Update rate with a new data point, moving averaging window as needed. | |
37 void Update(size_t count, int64_t now_ms); | |
38 | |
39 // Note that despite this being a const method, it still updates the internal | |
40 // state (moves averaging window), but it doesn't make any alterations that | |
41 // are observable from the other methods, as long as supplied timestamps are | |
42 // from a monotonic clock. Ie, it doesn't matter if this call moves the | |
43 // window, since any subsequent call to Update or Rate would still have moved | |
44 // the window as much or more. | |
45 rtc::Optional<uint32_t> Rate(int64_t now_ms) const; | |
46 | |
47 // Update the size of the averaging window. The maximum allowed value for | |
48 // window_size_ms is max_window_size_ms as supplied in the constructor. | |
49 bool SetWindowSize(int64_t window_size_ms, int64_t now_ms); | |
50 | |
51 private: | |
52 void EraseOld(int64_t now_ms); | |
53 bool IsInitialized() const; | |
54 | |
55 // Counters are kept in buckets (circular buffer), with one bucket | |
56 // per millisecond. | |
57 struct Bucket { | |
58 size_t sum; // Sum of all samples in this bucket. | |
59 size_t samples; // Number of samples in this bucket. | |
60 }; | |
61 std::unique_ptr<Bucket[]> buckets_; | |
62 | |
63 // Total count recorded in buckets. | |
64 size_t accumulated_count_; | |
65 | |
66 // The total number of samples in the buckets. | |
67 size_t num_samples_; | |
68 | |
69 // Oldest time recorded in buckets. | |
70 int64_t oldest_time_; | |
71 | |
72 // Bucket index of oldest counter recorded in buckets. | |
73 uint32_t oldest_index_; | |
74 | |
75 // To convert counts/ms to desired units | |
76 const float scale_; | |
77 | |
78 // The window sizes, in ms, over which the rate is calculated. | |
79 const int64_t max_window_size_ms_; | |
80 int64_t current_window_size_ms_; | |
81 }; | |
82 } // namespace webrtc | |
83 | 18 |
84 #endif // WEBRTC_BASE_RATE_STATISTICS_H_ | 19 #endif // WEBRTC_BASE_RATE_STATISTICS_H_ |
OLD | NEW |