pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2013 The WebRTC project authors. All Rights Reserved. |
| 3 | * |
| 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 |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
| 9 | */ |
| 10 | |
Mirko Bonadei | 92ea95e | 2017-09-15 04:47:31 | [diff] [blame] | 11 | #ifndef MODULES_REMOTE_BITRATE_ESTIMATOR_INTER_ARRIVAL_H_ |
| 12 | #define MODULES_REMOTE_BITRATE_ESTIMATOR_INTER_ARRIVAL_H_ |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 13 | |
Niels Möller | a12c42a | 2018-07-25 14:05:48 | [diff] [blame] | 14 | #include <stddef.h> |
| 15 | #include <stdint.h> |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 16 | |
Mirko Bonadei | 92ea95e | 2017-09-15 04:47:31 | [diff] [blame] | 17 | #include "rtc_base/constructormagic.h" |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 18 | |
| 19 | namespace webrtc { |
| 20 | |
| 21 | // Helper class to compute the inter-arrival time delta and the size delta |
| 22 | // between two timestamp groups. A timestamp is a 32 bit unsigned number with |
| 23 | // a client defined rate. |
| 24 | class InterArrival { |
| 25 | public: |
stefan | 5e12d36 | 2016-07-11 08:44:02 | [diff] [blame] | 26 | // After this many packet groups received out of order InterArrival will |
| 27 | // reset, assuming that clocks have made a jump. |
| 28 | static constexpr int kReorderedResetThreshold = 3; |
| 29 | static constexpr int64_t kArrivalTimeOffsetThresholdMs = 3000; |
| 30 | |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 31 | // A timestamp group is defined as all packets with a timestamp which are at |
stefan | 64c0a0a | 2015-11-27 09:02:31 | [diff] [blame] | 32 | // most timestamp_group_length_ticks older than the first timestamp in that |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 33 | // group. |
| 34 | InterArrival(uint32_t timestamp_group_length_ticks, |
| 35 | double timestamp_to_ms_coeff, |
| 36 | bool enable_burst_grouping); |
| 37 | |
| 38 | // This function returns true if a delta was computed, or false if the current |
| 39 | // group is still incomplete or if only one group has been completed. |
| 40 | // |timestamp| is the timestamp. |
| 41 | // |arrival_time_ms| is the local time at which the packet arrived. |
stefan | 64c0a0a | 2015-11-27 09:02:31 | [diff] [blame] | 42 | // |packet_size| is the size of the packet. |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 43 | // |timestamp_delta| (output) is the computed timestamp delta. |
| 44 | // |arrival_time_delta_ms| (output) is the computed arrival-time delta. |
stefan | 64c0a0a | 2015-11-27 09:02:31 | [diff] [blame] | 45 | // |packet_size_delta| (output) is the computed size delta. |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 46 | bool ComputeDeltas(uint32_t timestamp, |
| 47 | int64_t arrival_time_ms, |
stefan | 5e12d36 | 2016-07-11 08:44:02 | [diff] [blame] | 48 | int64_t system_time_ms, |
stefan | 64c0a0a | 2015-11-27 09:02:31 | [diff] [blame] | 49 | size_t packet_size, |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 50 | uint32_t* timestamp_delta, |
stefan | 64c0a0a | 2015-11-27 09:02:31 | [diff] [blame] | 51 | int64_t* arrival_time_delta_ms, |
| 52 | int* packet_size_delta); |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 53 | |
| 54 | private: |
| 55 | struct TimestampGroup { |
stefan | 64c0a0a | 2015-11-27 09:02:31 | [diff] [blame] | 56 | TimestampGroup() |
Sebastian Jansson | be20ef7 | 2018-09-06 10:32:31 | [diff] [blame] | 57 | : size(0), |
| 58 | first_timestamp(0), |
| 59 | timestamp(0), |
| 60 | first_arrival_ms(-1), |
| 61 | complete_time_ms(-1) {} |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 62 | |
Yves Gerey | 665174f | 2018-06-19 13:03:05 | [diff] [blame] | 63 | bool IsFirstPacket() const { return complete_time_ms == -1; } |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 64 | |
stefan | 64c0a0a | 2015-11-27 09:02:31 | [diff] [blame] | 65 | size_t size; |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 66 | uint32_t first_timestamp; |
| 67 | uint32_t timestamp; |
Sebastian Jansson | be20ef7 | 2018-09-06 10:32:31 | [diff] [blame] | 68 | int64_t first_arrival_ms; |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 69 | int64_t complete_time_ms; |
stefan | 5e12d36 | 2016-07-11 08:44:02 | [diff] [blame] | 70 | int64_t last_system_time_ms; |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 71 | }; |
| 72 | |
| 73 | // Returns true if the packet with timestamp |timestamp| arrived in order. |
| 74 | bool PacketInOrder(uint32_t timestamp); |
| 75 | |
| 76 | // Returns true if the last packet was the end of the current batch and the |
| 77 | // packet with |timestamp| is the first of a new batch. |
| 78 | bool NewTimestampGroup(int64_t arrival_time_ms, uint32_t timestamp) const; |
| 79 | |
| 80 | bool BelongsToBurst(int64_t arrival_time_ms, uint32_t timestamp) const; |
| 81 | |
stefan | 5e12d36 | 2016-07-11 08:44:02 | [diff] [blame] | 82 | void Reset(); |
| 83 | |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 84 | const uint32_t kTimestampGroupLengthTicks; |
| 85 | TimestampGroup current_timestamp_group_; |
| 86 | TimestampGroup prev_timestamp_group_; |
| 87 | double timestamp_to_ms_coeff_; |
| 88 | bool burst_grouping_; |
stefan | 5e12d36 | 2016-07-11 08:44:02 | [diff] [blame] | 89 | int num_consecutive_reordered_packets_; |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 90 | |
henrikg | 3c089d7 | 2015-09-16 12:37:44 | [diff] [blame] | 91 | RTC_DISALLOW_IMPLICIT_CONSTRUCTORS(InterArrival); |
pbos@webrtc.org | 9f79fe6 | 2014-12-04 15:34:06 | [diff] [blame] | 92 | }; |
| 93 | } // namespace webrtc |
| 94 | |
Mirko Bonadei | 92ea95e | 2017-09-15 04:47:31 | [diff] [blame] | 95 | #endif // MODULES_REMOTE_BITRATE_ESTIMATOR_INTER_ARRIVAL_H_ |