sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [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 06:47:31 +0200 | [diff] [blame] | 11 | #ifndef VIDEO_RECEIVE_STATISTICS_PROXY_H_ |
| 12 | #define VIDEO_RECEIVE_STATISTICS_PROXY_H_ |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 13 | |
sprang | 0ab8e81 | 2016-02-24 01:35:40 -0800 | [diff] [blame] | 14 | #include <map> |
Ilya Nikolaevskiy | 94150ee | 2018-05-23 11:53:19 +0200 | [diff] [blame] | 15 | #include <memory> |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 16 | #include <string> |
Ilya Nikolaevskiy | daa4f7a | 2017-10-06 12:29:47 +0200 | [diff] [blame] | 17 | #include <vector> |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 18 | |
Danil Chapovalov | b9b146c | 2018-06-15 12:28:07 +0200 | [diff] [blame] | 19 | #include "absl/types/optional.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 20 | #include "call/video_receive_stream.h" |
Mirko Bonadei | 7120742 | 2017-09-15 13:58:09 +0200 | [diff] [blame] | 21 | #include "common_types.h" // NOLINT(build/include) |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 22 | #include "common_video/include/frame_callback.h" |
| 23 | #include "modules/video_coding/include/video_coding_defines.h" |
| 24 | #include "rtc_base/criticalsection.h" |
Karl Wiberg | 65c3922 | 2017-11-22 12:25:14 +0100 | [diff] [blame] | 25 | #include "rtc_base/numerics/histogram_percentile_counter.h" |
| 26 | #include "rtc_base/numerics/moving_max_counter.h" |
Ilya Nikolaevskiy | 0beed5d | 2018-05-22 10:54:30 +0200 | [diff] [blame] | 27 | #include "rtc_base/numerics/sample_counter.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 28 | #include "rtc_base/rate_statistics.h" |
| 29 | #include "rtc_base/ratetracker.h" |
| 30 | #include "rtc_base/thread_annotations.h" |
Tommi | 132e28e | 2018-02-24 17:57:33 +0100 | [diff] [blame] | 31 | #include "rtc_base/thread_checker.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 32 | #include "video/quality_threshold.h" |
| 33 | #include "video/report_block_stats.h" |
| 34 | #include "video/stats_counter.h" |
Ilya Nikolaevskiy | 94150ee | 2018-05-23 11:53:19 +0200 | [diff] [blame] | 35 | #include "video/video_quality_observer.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 36 | #include "video/video_stream_decoder.h" |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 37 | |
| 38 | namespace webrtc { |
| 39 | |
| 40 | class Clock; |
asapersson | 86b0160 | 2015-10-20 23:55:26 -0700 | [diff] [blame] | 41 | struct CodecSpecificInfo; |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 42 | |
pbos | f42376c | 2015-08-28 07:35:32 -0700 | [diff] [blame] | 43 | class ReceiveStatisticsProxy : public VCMReceiveStatisticsCallback, |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 44 | public RtcpStatisticsCallback, |
pbos@webrtc.org | 1d0fa5d | 2015-02-19 12:47:00 +0000 | [diff] [blame] | 45 | public RtcpPacketTypeCounterObserver, |
philipel | a45102f | 2017-02-22 05:30:39 -0800 | [diff] [blame] | 46 | public StreamDataCountersCallback, |
| 47 | public CallStatsObserver { |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 48 | public: |
Tommi | 733b547 | 2016-06-10 17:58:01 +0200 | [diff] [blame] | 49 | ReceiveStatisticsProxy(const VideoReceiveStream::Config* config, |
sprang | 0ab8e81 | 2016-02-24 01:35:40 -0800 | [diff] [blame] | 50 | Clock* clock); |
Mirko Bonadei | 8fdcac3 | 2018-08-28 16:30:18 +0200 | [diff] [blame^] | 51 | ~ReceiveStatisticsProxy() override; |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 52 | |
| 53 | VideoReceiveStream::Stats GetStats() const; |
| 54 | |
Danil Chapovalov | b9b146c | 2018-06-15 12:28:07 +0200 | [diff] [blame] | 55 | void OnDecodedFrame(absl::optional<uint8_t> qp, |
Ilya Nikolaevskiy | 94150ee | 2018-05-23 11:53:19 +0200 | [diff] [blame] | 56 | int width, |
| 57 | int height, |
| 58 | VideoContentType content_type); |
asapersson | de9e5ff | 2016-11-02 07:14:03 -0700 | [diff] [blame] | 59 | void OnSyncOffsetUpdated(int64_t sync_offset_ms, double estimated_freq_khz); |
asapersson | 1490f7a | 2016-09-23 02:09:46 -0700 | [diff] [blame] | 60 | void OnRenderedFrame(const VideoFrame& frame); |
pbos | f42376c | 2015-08-28 07:35:32 -0700 | [diff] [blame] | 61 | void OnIncomingPayloadType(int payload_type); |
Peter Boström | b7d9a97 | 2015-12-18 16:01:11 +0100 | [diff] [blame] | 62 | void OnDecoderImplementationName(const char* implementation_name); |
pbos | f42376c | 2015-08-28 07:35:32 -0700 | [diff] [blame] | 63 | void OnIncomingRate(unsigned int framerate, unsigned int bitrate_bps); |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 64 | |
asapersson | 86b0160 | 2015-10-20 23:55:26 -0700 | [diff] [blame] | 65 | void OnPreDecode(const EncodedImage& encoded_image, |
| 66 | const CodecSpecificInfo* codec_specific_info); |
| 67 | |
Ilya Nikolaevskiy | d397a0d | 2018-02-21 15:57:09 +0100 | [diff] [blame] | 68 | void OnUniqueFramesCounted(int num_unique_frames); |
| 69 | |
sprang | 3e86e7e | 2017-08-22 09:23:28 -0700 | [diff] [blame] | 70 | // Indicates video stream has been paused (no incoming packets). |
| 71 | void OnStreamInactive(); |
| 72 | |
asapersson | d89920b | 2015-07-22 06:52:00 -0700 | [diff] [blame] | 73 | // Overrides VCMReceiveStatisticsCallback. |
kjellander@webrtc.org | 14665ff | 2015-03-04 12:58:35 +0000 | [diff] [blame] | 74 | void OnReceiveRatesUpdated(uint32_t bitRate, uint32_t frameRate) override; |
| 75 | void OnFrameCountsUpdated(const FrameCounts& frame_counts) override; |
| 76 | void OnDiscardedPacketsUpdated(int discarded_packets) override; |
ilnik | 6d5b4d6 | 2017-08-30 03:32:14 -0700 | [diff] [blame] | 77 | void OnCompleteFrame(bool is_keyframe, |
| 78 | size_t size_bytes, |
| 79 | VideoContentType content_type) override; |
philipel | a45102f | 2017-02-22 05:30:39 -0800 | [diff] [blame] | 80 | void OnFrameBufferTimingsUpdated(int decode_ms, |
| 81 | int max_decode_ms, |
| 82 | int current_delay_ms, |
| 83 | int target_delay_ms, |
| 84 | int jitter_buffer_ms, |
| 85 | int min_playout_delay_ms, |
| 86 | int render_delay_ms) override; |
pbos@webrtc.org | 5570769 | 2014-12-19 15:45:03 +0000 | [diff] [blame] | 87 | |
ilnik | 2edc684 | 2017-07-06 03:06:50 -0700 | [diff] [blame] | 88 | void OnTimingFrameInfoUpdated(const TimingFrameInfo& info) override; |
| 89 | |
pbos@webrtc.org | ce4e9a3 | 2014-12-18 13:50:16 +0000 | [diff] [blame] | 90 | // Overrides RtcpStatisticsCallback. |
kjellander@webrtc.org | 14665ff | 2015-03-04 12:58:35 +0000 | [diff] [blame] | 91 | void StatisticsUpdated(const webrtc::RtcpStatistics& statistics, |
| 92 | uint32_t ssrc) override; |
| 93 | void CNameChanged(const char* cname, uint32_t ssrc) override; |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 94 | |
asapersson | d89920b | 2015-07-22 06:52:00 -0700 | [diff] [blame] | 95 | // Overrides RtcpPacketTypeCounterObserver. |
kjellander@webrtc.org | 14665ff | 2015-03-04 12:58:35 +0000 | [diff] [blame] | 96 | void RtcpPacketTypesCounterUpdated( |
pbos@webrtc.org | 1d0fa5d | 2015-02-19 12:47:00 +0000 | [diff] [blame] | 97 | uint32_t ssrc, |
kjellander@webrtc.org | 14665ff | 2015-03-04 12:58:35 +0000 | [diff] [blame] | 98 | const RtcpPacketTypeCounter& packet_counter) override; |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 99 | // Overrides StreamDataCountersCallback. |
kjellander@webrtc.org | 14665ff | 2015-03-04 12:58:35 +0000 | [diff] [blame] | 100 | void DataCountersUpdated(const webrtc::StreamDataCounters& counters, |
| 101 | uint32_t ssrc) override; |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 102 | |
philipel | a45102f | 2017-02-22 05:30:39 -0800 | [diff] [blame] | 103 | // Implements CallStatsObserver. |
| 104 | void OnRttUpdate(int64_t avg_rtt_ms, int64_t max_rtt_ms) override; |
| 105 | |
Tommi | 132e28e | 2018-02-24 17:57:33 +0100 | [diff] [blame] | 106 | // Notification methods that are used to check our internal state and validate |
| 107 | // threading assumptions. These are called by VideoReceiveStream. |
| 108 | void DecoderThreadStarting(); |
| 109 | void DecoderThreadStopped(); |
| 110 | |
pbos@webrtc.org | ce4e9a3 | 2014-12-18 13:50:16 +0000 | [diff] [blame] | 111 | private: |
asapersson | 86b0160 | 2015-10-20 23:55:26 -0700 | [diff] [blame] | 112 | struct QpCounters { |
Ilya Nikolaevskiy | 0beed5d | 2018-05-22 10:54:30 +0200 | [diff] [blame] | 113 | rtc::SampleCounter vp8; |
asapersson | 86b0160 | 2015-10-20 23:55:26 -0700 | [diff] [blame] | 114 | }; |
asapersson | d89920b | 2015-07-22 06:52:00 -0700 | [diff] [blame] | 115 | |
ilnik | 6d5b4d6 | 2017-08-30 03:32:14 -0700 | [diff] [blame] | 116 | struct ContentSpecificStats { |
Ilya Nikolaevskiy | daa4f7a | 2017-10-06 12:29:47 +0200 | [diff] [blame] | 117 | ContentSpecificStats(); |
Mirko Bonadei | 8fdcac3 | 2018-08-28 16:30:18 +0200 | [diff] [blame^] | 118 | ~ContentSpecificStats(); |
Ilya Nikolaevskiy | daa4f7a | 2017-10-06 12:29:47 +0200 | [diff] [blame] | 119 | |
ilnik | 6d5b4d6 | 2017-08-30 03:32:14 -0700 | [diff] [blame] | 120 | void Add(const ContentSpecificStats& other); |
| 121 | |
Ilya Nikolaevskiy | 0beed5d | 2018-05-22 10:54:30 +0200 | [diff] [blame] | 122 | rtc::SampleCounter e2e_delay_counter; |
| 123 | rtc::SampleCounter interframe_delay_counter; |
ilnik | 6d5b4d6 | 2017-08-30 03:32:14 -0700 | [diff] [blame] | 124 | int64_t flow_duration_ms = 0; |
| 125 | int64_t total_media_bytes = 0; |
Ilya Nikolaevskiy | 0beed5d | 2018-05-22 10:54:30 +0200 | [diff] [blame] | 126 | rtc::SampleCounter received_width; |
| 127 | rtc::SampleCounter received_height; |
| 128 | rtc::SampleCounter qp_counter; |
ilnik | 6d5b4d6 | 2017-08-30 03:32:14 -0700 | [diff] [blame] | 129 | FrameCounts frame_counts; |
Ilya Nikolaevskiy | ed23be9 | 2017-10-12 12:38:01 +0200 | [diff] [blame] | 130 | rtc::HistogramPercentileCounter interframe_delay_percentiles; |
ilnik | 6d5b4d6 | 2017-08-30 03:32:14 -0700 | [diff] [blame] | 131 | }; |
| 132 | |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 133 | void UpdateHistograms() RTC_EXCLUSIVE_LOCKS_REQUIRED(crit_); |
asapersson | d89920b | 2015-07-22 06:52:00 -0700 | [diff] [blame] | 134 | |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 135 | void QualitySample() RTC_EXCLUSIVE_LOCKS_REQUIRED(crit_); |
palmkvist | 349092b | 2016-12-13 02:45:57 -0800 | [diff] [blame] | 136 | |
asapersson | 0255acb | 2017-03-28 02:44:58 -0700 | [diff] [blame] | 137 | // Removes info about old frames and then updates the framerate. |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 138 | void UpdateFramerate(int64_t now_ms) const |
| 139 | RTC_EXCLUSIVE_LOCKS_REQUIRED(crit_); |
philipel | a45102f | 2017-02-22 05:30:39 -0800 | [diff] [blame] | 140 | |
pbos@webrtc.org | de1429e | 2014-04-28 13:00:21 +0000 | [diff] [blame] | 141 | Clock* const clock_; |
Tommi | 733b547 | 2016-06-10 17:58:01 +0200 | [diff] [blame] | 142 | // Ownership of this object lies with the owner of the ReceiveStatisticsProxy |
| 143 | // instance. Lifetime is guaranteed to outlive |this|. |
| 144 | // TODO(tommi): In practice the config_ reference is only used for accessing |
brandtr | b5f2c3f | 2016-10-04 23:28:39 -0700 | [diff] [blame] | 145 | // config_.rtp.ulpfec.ulpfec_payload_type. Instead of holding a pointer back, |
Tommi | 733b547 | 2016-06-10 17:58:01 +0200 | [diff] [blame] | 146 | // we could just store the value of ulpfec_payload_type and change the |
| 147 | // ReceiveStatisticsProxy() ctor to accept a const& of Config (since we'll |
| 148 | // then no longer store a pointer to the object). |
| 149 | const VideoReceiveStream::Config& config_; |
asapersson | 4374a09 | 2016-07-27 00:39:09 -0700 | [diff] [blame] | 150 | const int64_t start_ms_; |
pbos@webrtc.org | de1429e | 2014-04-28 13:00:21 +0000 | [diff] [blame] | 151 | |
pbos | 5ad935c | 2016-01-25 03:52:44 -0800 | [diff] [blame] | 152 | rtc::CriticalSection crit_; |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 153 | int64_t last_sample_time_ RTC_GUARDED_BY(crit_); |
| 154 | QualityThreshold fps_threshold_ RTC_GUARDED_BY(crit_); |
| 155 | QualityThreshold qp_threshold_ RTC_GUARDED_BY(crit_); |
| 156 | QualityThreshold variance_threshold_ RTC_GUARDED_BY(crit_); |
Ilya Nikolaevskiy | 0beed5d | 2018-05-22 10:54:30 +0200 | [diff] [blame] | 157 | rtc::SampleCounter qp_sample_ RTC_GUARDED_BY(crit_); |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 158 | int num_bad_states_ RTC_GUARDED_BY(crit_); |
| 159 | int num_certain_states_ RTC_GUARDED_BY(crit_); |
| 160 | mutable VideoReceiveStream::Stats stats_ RTC_GUARDED_BY(crit_); |
| 161 | RateStatistics decode_fps_estimator_ RTC_GUARDED_BY(crit_); |
| 162 | RateStatistics renders_fps_estimator_ RTC_GUARDED_BY(crit_); |
| 163 | rtc::RateTracker render_fps_tracker_ RTC_GUARDED_BY(crit_); |
| 164 | rtc::RateTracker render_pixel_tracker_ RTC_GUARDED_BY(crit_); |
| 165 | rtc::RateTracker total_byte_tracker_ RTC_GUARDED_BY(crit_); |
Ilya Nikolaevskiy | 0beed5d | 2018-05-22 10:54:30 +0200 | [diff] [blame] | 166 | rtc::SampleCounter sync_offset_counter_ RTC_GUARDED_BY(crit_); |
| 167 | rtc::SampleCounter decode_time_counter_ RTC_GUARDED_BY(crit_); |
| 168 | rtc::SampleCounter jitter_buffer_delay_counter_ RTC_GUARDED_BY(crit_); |
| 169 | rtc::SampleCounter target_delay_counter_ RTC_GUARDED_BY(crit_); |
| 170 | rtc::SampleCounter current_delay_counter_ RTC_GUARDED_BY(crit_); |
| 171 | rtc::SampleCounter delay_counter_ RTC_GUARDED_BY(crit_); |
Ilya Nikolaevskiy | 94150ee | 2018-05-23 11:53:19 +0200 | [diff] [blame] | 172 | std::unique_ptr<VideoQualityObserver> video_quality_observer_ |
| 173 | RTC_GUARDED_BY(crit_); |
ilnik | a79cc28 | 2017-08-23 05:24:10 -0700 | [diff] [blame] | 174 | mutable rtc::MovingMaxCounter<int> interframe_delay_max_moving_ |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 175 | RTC_GUARDED_BY(crit_); |
ilnik | 6d5b4d6 | 2017-08-30 03:32:14 -0700 | [diff] [blame] | 176 | std::map<VideoContentType, ContentSpecificStats> content_specific_stats_ |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 177 | RTC_GUARDED_BY(crit_); |
| 178 | MaxCounter freq_offset_counter_ RTC_GUARDED_BY(crit_); |
| 179 | int64_t first_report_block_time_ms_ RTC_GUARDED_BY(crit_); |
| 180 | ReportBlockStats report_block_stats_ RTC_GUARDED_BY(crit_); |
Tommi | 132e28e | 2018-02-24 17:57:33 +0100 | [diff] [blame] | 181 | QpCounters qp_counters_ RTC_GUARDED_BY(decode_thread_); |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 182 | std::map<uint32_t, StreamDataCounters> rtx_stats_ RTC_GUARDED_BY(crit_); |
| 183 | int64_t avg_rtt_ms_ RTC_GUARDED_BY(crit_); |
| 184 | mutable std::map<int64_t, size_t> frame_window_ RTC_GUARDED_BY(&crit_); |
| 185 | VideoContentType last_content_type_ RTC_GUARDED_BY(&crit_); |
Ilya Nikolaevskiy | 94150ee | 2018-05-23 11:53:19 +0200 | [diff] [blame] | 186 | VideoCodecType last_codec_type_ RTC_GUARDED_BY(&crit_); |
Danil Chapovalov | b9b146c | 2018-06-15 12:28:07 +0200 | [diff] [blame] | 187 | absl::optional<int64_t> first_decoded_frame_time_ms_ RTC_GUARDED_BY(&crit_); |
| 188 | absl::optional<int64_t> last_decoded_frame_time_ms_ RTC_GUARDED_BY(&crit_); |
Åsa Persson | 81327d5 | 2018-06-05 13:34:33 +0200 | [diff] [blame] | 189 | size_t num_delayed_frames_rendered_ RTC_GUARDED_BY(&crit_); |
| 190 | int64_t sum_missed_render_deadline_ms_ RTC_GUARDED_BY(&crit_); |
ilnik | 75204c5 | 2017-09-04 03:35:40 -0700 | [diff] [blame] | 191 | // Mutable because calling Max() on MovingMaxCounter is not const. Yet it is |
| 192 | // called from const GetStats(). |
| 193 | mutable rtc::MovingMaxCounter<TimingFrameInfo> timing_frame_info_counter_ |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 194 | RTC_GUARDED_BY(&crit_); |
Danil Chapovalov | b9b146c | 2018-06-15 12:28:07 +0200 | [diff] [blame] | 195 | absl::optional<int> num_unique_frames_ RTC_GUARDED_BY(crit_); |
Tommi | 132e28e | 2018-02-24 17:57:33 +0100 | [diff] [blame] | 196 | rtc::ThreadChecker decode_thread_; |
| 197 | rtc::ThreadChecker network_thread_; |
| 198 | rtc::ThreadChecker main_thread_; |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 199 | }; |
| 200 | |
sprang@webrtc.org | 0931570 | 2014-02-07 12:06:29 +0000 | [diff] [blame] | 201 | } // namespace webrtc |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 202 | #endif // VIDEO_RECEIVE_STATISTICS_PROXY_H_ |