OLD | NEW |
1 /* | 1 /* |
2 * Copyright (c) 2017 The WebRTC project authors. All Rights Reserved. | 2 * Copyright (c) 2017 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_API_VIDEO_VIDEO_TIMING_H_ | 11 #ifndef WEBRTC_API_VIDEO_VIDEO_TIMING_H_ |
12 #define WEBRTC_API_VIDEO_VIDEO_TIMING_H_ | 12 #define WEBRTC_API_VIDEO_VIDEO_TIMING_H_ |
13 | 13 |
14 #include <stdint.h> | 14 #include <stdint.h> |
15 | 15 |
16 #include <limits> | |
17 #include <string> | 16 #include <string> |
18 | 17 |
19 #include "webrtc/rtc_base/checks.h" | 18 #include "webrtc/rtc_base/checks.h" |
20 #include "webrtc/rtc_base/safe_conversions.h" | 19 #include "webrtc/rtc_base/safe_conversions.h" |
21 | 20 |
22 namespace webrtc { | 21 namespace webrtc { |
23 | 22 |
24 enum TimingFrameFlags : uint8_t { | |
25 kDefault = 0, // No flags set (used by old protocol) | |
26 kTriggeredByTimer = 1 << 0, // Frame marked for tracing by periodic timer. | |
27 kTriggeredBySize = 1 << 1, // Frame marked for tracing due to size. | |
28 kInvalid = std::numeric_limits<uint8_t>::max() // Invalid, ignore! | |
29 }; | |
30 | |
31 // Video timing timestamps in ms counted from capture_time_ms of a frame. | 23 // Video timing timestamps in ms counted from capture_time_ms of a frame. |
32 // This structure represents data sent in video-timing RTP header extension. | 24 // This structure represents data sent in video-timing RTP header extension. |
33 struct VideoSendTiming { | 25 struct VideoSendTiming { |
34 // Offsets of the fields in the RTP header extension, counting from the first | 26 static const uint8_t kEncodeStartDeltaIdx = 0; |
35 // byte after the one-byte header. | 27 static const uint8_t kEncodeFinishDeltaIdx = 1; |
36 static constexpr uint8_t kFlagsOffset = 0; | 28 static const uint8_t kPacketizationFinishDeltaIdx = 2; |
37 static constexpr uint8_t kEncodeStartDeltaOffset = 1; | 29 static const uint8_t kPacerExitDeltaIdx = 3; |
38 static constexpr uint8_t kEncodeFinishDeltaOffset = 3; | 30 static const uint8_t kNetworkTimestampDeltaIdx = 4; |
39 static constexpr uint8_t kPacketizationFinishDeltaOffset = 5; | 31 static const uint8_t kNetwork2TimestampDeltaIdx = 5; |
40 static constexpr uint8_t kPacerExitDeltaOffset = 7; | |
41 static constexpr uint8_t kNetworkTimestampDeltaOffset = 9; | |
42 static constexpr uint8_t kNetwork2TimestampDeltaOffset = 11; | |
43 | 32 |
44 // Returns |time_ms - base_ms| capped at max 16-bit value. | 33 // Returns |time_ms - base_ms| capped at max 16-bit value. |
45 // Used to fill this data structure as per | 34 // Used to fill this data structure as per |
46 // https://webrtc.org/experiments/rtp-hdrext/video-timing/ extension stores | 35 // https://webrtc.org/experiments/rtp-hdrext/video-timing/ extension stores |
47 // 16-bit deltas of timestamps from packet capture time. | 36 // 16-bit deltas of timestamps from packet capture time. |
48 static uint16_t GetDeltaCappedMs(int64_t base_ms, int64_t time_ms) { | 37 static uint16_t GetDeltaCappedMs(int64_t base_ms, int64_t time_ms) { |
49 RTC_DCHECK_GE(time_ms, base_ms); | 38 RTC_DCHECK_GE(time_ms, base_ms); |
50 return rtc::saturated_cast<uint16_t>(time_ms - base_ms); | 39 return rtc::saturated_cast<uint16_t>(time_ms - base_ms); |
51 } | 40 } |
52 | 41 |
53 uint16_t encode_start_delta_ms; | 42 uint16_t encode_start_delta_ms; |
54 uint16_t encode_finish_delta_ms; | 43 uint16_t encode_finish_delta_ms; |
55 uint16_t packetization_finish_delta_ms; | 44 uint16_t packetization_finish_delta_ms; |
56 uint16_t pacer_exit_delta_ms; | 45 uint16_t pacer_exit_delta_ms; |
57 uint16_t network_timstamp_delta_ms; | 46 uint16_t network_timstamp_delta_ms; |
58 uint16_t network2_timstamp_delta_ms; | 47 uint16_t network2_timstamp_delta_ms; |
59 uint8_t flags; | 48 bool is_timing_frame; |
60 }; | 49 }; |
61 | 50 |
62 // Used to report precise timings of a 'timing frames'. Contains all important | 51 // Used to report precise timings of a 'timing frames'. Contains all important |
63 // timestamps for a lifetime of that specific frame. Reported as a string via | 52 // timestamps for a lifetime of that specific frame. Reported as a string via |
64 // GetStats(). Only frame which took the longest between two GetStats calls is | 53 // GetStats(). Only frame which took the longest between two GetStats calls is |
65 // reported. | 54 // reported. |
66 struct TimingFrameInfo { | 55 struct TimingFrameInfo { |
67 TimingFrameInfo(); | 56 TimingFrameInfo(); |
68 | 57 |
69 // Returns end-to-end delay of a frame, if sender and receiver timestamps are | 58 // Returns end-to-end delay of a frame, if sender and receiver timestamps are |
70 // synchronized, -1 otherwise. | 59 // synchronized, -1 otherwise. |
71 int64_t EndToEndDelay() const; | 60 int64_t EndToEndDelay() const; |
72 | 61 |
73 // Returns true if current frame took longer to process than |other| frame. | 62 // Returns true if current frame took longer to process than |other| frame. |
74 // If other frame's clocks are not synchronized, current frame is always | 63 // If other frame's clocks are not synchronized, current frame is always |
75 // preferred. | 64 // preferred. |
76 bool IsLongerThan(const TimingFrameInfo& other) const; | 65 bool IsLongerThan(const TimingFrameInfo& other) const; |
77 | 66 |
78 // Returns true if flags are set to indicate this frame was marked for tracing | |
79 // due to the size being outside some limit. | |
80 bool IsOutlier() const; | |
81 | |
82 // Returns true if flags are set to indicate this frame was marked fro tracing | |
83 // due to cyclic timer. | |
84 bool IsTimerTriggered() const; | |
85 | |
86 // Returns true if the timing data is marked as invalid, in which case it | |
87 // should be ignored. | |
88 bool IsInvalid() const; | |
89 | |
90 std::string ToString() const; | 67 std::string ToString() const; |
91 | 68 |
92 uint32_t rtp_timestamp; // Identifier of a frame. | 69 uint32_t rtp_timestamp; // Identifier of a frame. |
93 // All timestamps below are in local monotonous clock of a receiver. | 70 // All timestamps below are in local monotonous clock of a receiver. |
94 // If sender clock is not yet estimated, sender timestamps | 71 // If sender clock is not yet estimated, sender timestamps |
95 // (capture_time_ms ... pacer_exit_ms) are negative values, still | 72 // (capture_time_ms ... pacer_exit_ms) are negative values, still |
96 // relatively correct. | 73 // relatively correct. |
97 int64_t capture_time_ms; // Captrue time of a frame. | 74 int64_t capture_time_ms; // Captrue time of a frame. |
98 int64_t encode_start_ms; // Encode start time. | 75 int64_t encode_start_ms; // Encode start time. |
99 int64_t encode_finish_ms; // Encode completion time. | 76 int64_t encode_finish_ms; // Encode completion time. |
100 int64_t packetization_finish_ms; // Time when frame was passed to pacer. | 77 int64_t packetization_finish_ms; // Time when frame was passed to pacer. |
101 int64_t pacer_exit_ms; // Time when last packet was pushed out of pacer. | 78 int64_t pacer_exit_ms; // Time when last packet was pushed out of pacer. |
102 // Two in-network RTP processor timestamps: meaning is application specific. | 79 // Two in-network RTP processor timestamps: meaning is application specific. |
103 int64_t network_timestamp_ms; | 80 int64_t network_timestamp_ms; |
104 int64_t network2_timestamp_ms; | 81 int64_t network2_timestamp_ms; |
105 int64_t receive_start_ms; // First received packet time. | 82 int64_t receive_start_ms; // First received packet time. |
106 int64_t receive_finish_ms; // Last received packet time. | 83 int64_t receive_finish_ms; // Last received packet time. |
107 int64_t decode_start_ms; // Decode start time. | 84 int64_t decode_start_ms; // Decode start time. |
108 int64_t decode_finish_ms; // Decode completion time. | 85 int64_t decode_finish_ms; // Decode completion time. |
109 int64_t render_time_ms; // Proposed render time to insure smooth playback. | 86 int64_t render_time_ms; // Proposed render time to insure smooth playback. |
110 | |
111 uint8_t flags; // Flags indicating validity and/or why tracing was triggered. | |
112 }; | 87 }; |
113 | 88 |
114 } // namespace webrtc | 89 } // namespace webrtc |
115 | 90 |
116 #endif // WEBRTC_API_VIDEO_VIDEO_TIMING_H_ | 91 #endif // WEBRTC_API_VIDEO_VIDEO_TIMING_H_ |
OLD | NEW |