blob: 21f4a3dc71159f99e0e93a129998cff2186e62fe [file] [log] [blame]
niklase@google.com470e71d2011-07-07 08:21:25 +00001/*
2 * Copyright (c) 2011 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
Henrik Kjellander2557b862015-11-18 22:00:21 +010011#include "webrtc/modules/video_coding/timing.h"
stefan@webrtc.orga678a3b2013-01-21 07:42:11 +000012
philipel5908c712015-12-21 08:23:20 -080013#include <algorithm>
14
Henrik Kjellander2557b862015-11-18 22:00:21 +010015#include "webrtc/modules/video_coding/internal_defines.h"
16#include "webrtc/modules/video_coding/jitter_buffer_common.h"
Henrik Kjellander98f53512015-10-28 18:17:40 +010017#include "webrtc/system_wrappers/include/clock.h"
18#include "webrtc/system_wrappers/include/metrics.h"
19#include "webrtc/system_wrappers/include/timestamp_extrapolator.h"
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +000020
niklase@google.com470e71d2011-07-07 08:21:25 +000021namespace webrtc {
22
philipel5908c712015-12-21 08:23:20 -080023VCMTiming::VCMTiming(Clock* clock, VCMTiming* master_timing)
kthelgasond701dfd2017-03-27 07:24:57 -070024 : clock_(clock),
25 master_(false),
26 ts_extrapolator_(),
27 codec_timer_(new VCMCodecTimer()),
28 render_delay_ms_(kDefaultRenderDelayMs),
29 min_playout_delay_ms_(0),
30 max_playout_delay_ms_(10000),
31 jitter_delay_ms_(0),
32 current_delay_ms_(0),
33 last_decode_ms_(0),
34 prev_frame_timestamp_(0),
35 num_decoded_frames_(0),
36 num_delayed_decoded_frames_(0),
37 first_decoded_frame_ms_(-1),
38 sum_missed_render_deadline_ms_(0) {
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +000039 if (master_timing == NULL) {
40 master_ = true;
wu@webrtc.org66773a02014-05-07 17:09:44 +000041 ts_extrapolator_ = new TimestampExtrapolator(clock_->TimeInMilliseconds());
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +000042 } else {
43 ts_extrapolator_ = master_timing->ts_extrapolator_;
44 }
niklase@google.com470e71d2011-07-07 08:21:25 +000045}
46
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +000047VCMTiming::~VCMTiming() {
asapersson@webrtc.orgf2447602014-12-09 14:13:26 +000048 UpdateHistograms();
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +000049 if (master_) {
50 delete ts_extrapolator_;
51 }
niklase@google.com470e71d2011-07-07 08:21:25 +000052}
53
asapersson@webrtc.orgf2447602014-12-09 14:13:26 +000054void VCMTiming::UpdateHistograms() const {
kthelgasond701dfd2017-03-27 07:24:57 -070055 rtc::CritScope cs(&crit_sect_);
asapersson@webrtc.orgf2447602014-12-09 14:13:26 +000056 if (num_decoded_frames_ == 0) {
57 return;
58 }
59 int64_t elapsed_sec =
60 (clock_->TimeInMilliseconds() - first_decoded_frame_ms_) / 1000;
61 if (elapsed_sec < metrics::kMinRunTimeInSeconds) {
62 return;
63 }
asapersson1d02d3e2016-09-09 22:40:25 -070064 RTC_HISTOGRAM_COUNTS_100(
asapersson53805322015-12-21 01:46:20 -080065 "WebRTC.Video.DecodedFramesPerSecond",
asapersson@webrtc.orgf2447602014-12-09 14:13:26 +000066 static_cast<int>((num_decoded_frames_ / elapsed_sec) + 0.5f));
asapersson1d02d3e2016-09-09 22:40:25 -070067 RTC_HISTOGRAM_PERCENTAGE(
asapersson53805322015-12-21 01:46:20 -080068 "WebRTC.Video.DelayedFramesToRenderer",
asapersson@webrtc.orgf2447602014-12-09 14:13:26 +000069 num_delayed_decoded_frames_ * 100 / num_decoded_frames_);
70 if (num_delayed_decoded_frames_ > 0) {
asapersson1d02d3e2016-09-09 22:40:25 -070071 RTC_HISTOGRAM_COUNTS_1000(
asapersson@webrtc.orgf2447602014-12-09 14:13:26 +000072 "WebRTC.Video.DelayedFramesToRenderer_AvgDelayInMs",
asapersson53805322015-12-21 01:46:20 -080073 sum_missed_render_deadline_ms_ / num_delayed_decoded_frames_);
asapersson@webrtc.orgf2447602014-12-09 14:13:26 +000074 }
75}
76
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +000077void VCMTiming::Reset() {
kthelgasond701dfd2017-03-27 07:24:57 -070078 rtc::CritScope cs(&crit_sect_);
wu@webrtc.orged4cb562014-05-06 04:50:49 +000079 ts_extrapolator_->Reset(clock_->TimeInMilliseconds());
magjed2943f012016-03-22 05:12:09 -070080 codec_timer_.reset(new VCMCodecTimer());
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +000081 render_delay_ms_ = kDefaultRenderDelayMs;
mikhal@webrtc.orgadc64a72013-05-30 16:20:18 +000082 min_playout_delay_ms_ = 0;
83 jitter_delay_ms_ = 0;
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +000084 current_delay_ms_ = 0;
85 prev_frame_timestamp_ = 0;
niklase@google.com470e71d2011-07-07 08:21:25 +000086}
87
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +000088void VCMTiming::ResetDecodeTime() {
kthelgasond701dfd2017-03-27 07:24:57 -070089 rtc::CritScope cs(&crit_sect_);
magjed2943f012016-03-22 05:12:09 -070090 codec_timer_.reset(new VCMCodecTimer());
niklase@google.com470e71d2011-07-07 08:21:25 +000091}
92
isheriff6b4b5f32016-06-08 00:24:21 -070093void VCMTiming::set_render_delay(int render_delay_ms) {
kthelgasond701dfd2017-03-27 07:24:57 -070094 rtc::CritScope cs(&crit_sect_);
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +000095 render_delay_ms_ = render_delay_ms;
niklase@google.com470e71d2011-07-07 08:21:25 +000096}
97
isheriff6b4b5f32016-06-08 00:24:21 -070098void VCMTiming::set_min_playout_delay(int min_playout_delay_ms) {
kthelgasond701dfd2017-03-27 07:24:57 -070099 rtc::CritScope cs(&crit_sect_);
mikhal@webrtc.orgadc64a72013-05-30 16:20:18 +0000100 min_playout_delay_ms_ = min_playout_delay_ms;
niklase@google.com470e71d2011-07-07 08:21:25 +0000101}
102
isheriff6b4b5f32016-06-08 00:24:21 -0700103int VCMTiming::min_playout_delay() {
kthelgasond701dfd2017-03-27 07:24:57 -0700104 rtc::CritScope cs(&crit_sect_);
isheriff6b4b5f32016-06-08 00:24:21 -0700105 return min_playout_delay_ms_;
106}
107
108void VCMTiming::set_max_playout_delay(int max_playout_delay_ms) {
kthelgasond701dfd2017-03-27 07:24:57 -0700109 rtc::CritScope cs(&crit_sect_);
isheriff6b4b5f32016-06-08 00:24:21 -0700110 max_playout_delay_ms_ = max_playout_delay_ms;
111}
112
113int VCMTiming::max_playout_delay() {
kthelgasond701dfd2017-03-27 07:24:57 -0700114 rtc::CritScope cs(&crit_sect_);
isheriff6b4b5f32016-06-08 00:24:21 -0700115 return max_playout_delay_ms_;
116}
117
118void VCMTiming::SetJitterDelay(int jitter_delay_ms) {
kthelgasond701dfd2017-03-27 07:24:57 -0700119 rtc::CritScope cs(&crit_sect_);
mikhal@webrtc.orgadc64a72013-05-30 16:20:18 +0000120 if (jitter_delay_ms != jitter_delay_ms_) {
mikhal@webrtc.orgadc64a72013-05-30 16:20:18 +0000121 jitter_delay_ms_ = jitter_delay_ms;
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000122 // When in initial state, set current delay to minimum delay.
123 if (current_delay_ms_ == 0) {
mikhal@webrtc.orgadc64a72013-05-30 16:20:18 +0000124 current_delay_ms_ = jitter_delay_ms_;
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000125 }
126 }
niklase@google.com470e71d2011-07-07 08:21:25 +0000127}
128
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000129void VCMTiming::UpdateCurrentDelay(uint32_t frame_timestamp) {
kthelgasond701dfd2017-03-27 07:24:57 -0700130 rtc::CritScope cs(&crit_sect_);
isheriff6b4b5f32016-06-08 00:24:21 -0700131 int target_delay_ms = TargetDelayInternal();
niklase@google.com470e71d2011-07-07 08:21:25 +0000132
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000133 if (current_delay_ms_ == 0) {
134 // Not initialized, set current delay to target.
135 current_delay_ms_ = target_delay_ms;
136 } else if (target_delay_ms != current_delay_ms_) {
philipel5908c712015-12-21 08:23:20 -0800137 int64_t delay_diff_ms =
138 static_cast<int64_t>(target_delay_ms) - current_delay_ms_;
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000139 // Never change the delay with more than 100 ms every second. If we're
140 // changing the delay in too large steps we will get noticeable freezes. By
141 // limiting the change we can increase the delay in smaller steps, which
142 // will be experienced as the video is played in slow motion. When lowering
143 // the delay the video will be played at a faster pace.
144 int64_t max_change_ms = 0;
145 if (frame_timestamp < 0x0000ffff && prev_frame_timestamp_ > 0xffff0000) {
146 // wrap
philipel5908c712015-12-21 08:23:20 -0800147 max_change_ms = kDelayMaxChangeMsPerS *
148 (frame_timestamp + (static_cast<int64_t>(1) << 32) -
149 prev_frame_timestamp_) /
150 90000;
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000151 } else {
152 max_change_ms = kDelayMaxChangeMsPerS *
philipel5908c712015-12-21 08:23:20 -0800153 (frame_timestamp - prev_frame_timestamp_) / 90000;
niklase@google.com470e71d2011-07-07 08:21:25 +0000154 }
philipelfd5a20f2016-11-15 00:57:57 -0800155
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000156 if (max_change_ms <= 0) {
157 // Any changes less than 1 ms are truncated and
158 // will be postponed. Negative change will be due
159 // to reordering and should be ignored.
160 return;
161 }
162 delay_diff_ms = std::max(delay_diff_ms, -max_change_ms);
163 delay_diff_ms = std::min(delay_diff_ms, max_change_ms);
mikhal@webrtc.org6faba6e2013-04-30 15:39:34 +0000164
isheriff6b4b5f32016-06-08 00:24:21 -0700165 current_delay_ms_ = current_delay_ms_ + delay_diff_ms;
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000166 }
167 prev_frame_timestamp_ = frame_timestamp;
niklase@google.com470e71d2011-07-07 08:21:25 +0000168}
169
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000170void VCMTiming::UpdateCurrentDelay(int64_t render_time_ms,
171 int64_t actual_decode_time_ms) {
kthelgasond701dfd2017-03-27 07:24:57 -0700172 rtc::CritScope cs(&crit_sect_);
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000173 uint32_t target_delay_ms = TargetDelayInternal();
magjed2943f012016-03-22 05:12:09 -0700174 int64_t delayed_ms =
175 actual_decode_time_ms -
176 (render_time_ms - RequiredDecodeTimeMs() - render_delay_ms_);
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000177 if (delayed_ms < 0) {
178 return;
179 }
180 if (current_delay_ms_ + delayed_ms <= target_delay_ms) {
isheriff6b4b5f32016-06-08 00:24:21 -0700181 current_delay_ms_ += delayed_ms;
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000182 } else {
183 current_delay_ms_ = target_delay_ms;
184 }
niklase@google.com470e71d2011-07-07 08:21:25 +0000185}
186
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000187int32_t VCMTiming::StopDecodeTimer(uint32_t time_stamp,
Per327d8ba2015-11-10 14:00:27 +0100188 int32_t decode_time_ms,
asapersson@webrtc.orgf2447602014-12-09 14:13:26 +0000189 int64_t now_ms,
190 int64_t render_time_ms) {
kthelgasond701dfd2017-03-27 07:24:57 -0700191 rtc::CritScope cs(&crit_sect_);
magjed2943f012016-03-22 05:12:09 -0700192 codec_timer_->AddTiming(decode_time_ms, now_ms);
Per327d8ba2015-11-10 14:00:27 +0100193 assert(decode_time_ms >= 0);
194 last_decode_ms_ = decode_time_ms;
asapersson@webrtc.orgf2447602014-12-09 14:13:26 +0000195
196 // Update stats.
197 ++num_decoded_frames_;
198 if (num_decoded_frames_ == 1) {
199 first_decoded_frame_ms_ = now_ms;
200 }
201 int time_until_rendering_ms = render_time_ms - render_delay_ms_ - now_ms;
202 if (time_until_rendering_ms < 0) {
203 sum_missed_render_deadline_ms_ += -time_until_rendering_ms;
204 ++num_delayed_decoded_frames_;
205 }
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000206 return 0;
niklase@google.com470e71d2011-07-07 08:21:25 +0000207}
208
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000209void VCMTiming::IncomingTimestamp(uint32_t time_stamp, int64_t now_ms) {
kthelgasond701dfd2017-03-27 07:24:57 -0700210 rtc::CritScope cs(&crit_sect_);
stefan@webrtc.org34c5da62014-04-11 14:08:35 +0000211 ts_extrapolator_->Update(now_ms, time_stamp);
niklase@google.com470e71d2011-07-07 08:21:25 +0000212}
213
philipel5908c712015-12-21 08:23:20 -0800214int64_t VCMTiming::RenderTimeMs(uint32_t frame_timestamp,
215 int64_t now_ms) const {
kthelgasond701dfd2017-03-27 07:24:57 -0700216 rtc::CritScope cs(&crit_sect_);
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000217 const int64_t render_time_ms = RenderTimeMsInternal(frame_timestamp, now_ms);
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000218 return render_time_ms;
niklase@google.com470e71d2011-07-07 08:21:25 +0000219}
220
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000221int64_t VCMTiming::RenderTimeMsInternal(uint32_t frame_timestamp,
222 int64_t now_ms) const {
223 int64_t estimated_complete_time_ms =
philipel5908c712015-12-21 08:23:20 -0800224 ts_extrapolator_->ExtrapolateLocalTime(frame_timestamp);
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000225 if (estimated_complete_time_ms == -1) {
226 estimated_complete_time_ms = now_ms;
227 }
mikhal@webrtc.org6faba6e2013-04-30 15:39:34 +0000228
isheriff6b4b5f32016-06-08 00:24:21 -0700229 if (min_playout_delay_ms_ == 0 && max_playout_delay_ms_ == 0) {
230 // Render as soon as possible
231 return now_ms;
232 }
233
234 // Make sure the actual delay stays in the range of |min_playout_delay_ms_|
235 // and |max_playout_delay_ms_|.
236 int actual_delay = std::max(current_delay_ms_, min_playout_delay_ms_);
237 actual_delay = std::min(actual_delay, max_playout_delay_ms_);
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000238 return estimated_complete_time_ms + actual_delay;
niklase@google.com470e71d2011-07-07 08:21:25 +0000239}
240
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000241// Must be called from inside a critical section.
isheriff6b4b5f32016-06-08 00:24:21 -0700242int VCMTiming::RequiredDecodeTimeMs() const {
243 const int decode_time_ms = codec_timer_->RequiredDecodeTimeMs();
stefan@webrtc.org34c5da62014-04-11 14:08:35 +0000244 assert(decode_time_ms >= 0);
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000245 return decode_time_ms;
niklase@google.com470e71d2011-07-07 08:21:25 +0000246}
247
philipel5908c712015-12-21 08:23:20 -0800248uint32_t VCMTiming::MaxWaitingTime(int64_t render_time_ms,
249 int64_t now_ms) const {
kthelgasond701dfd2017-03-27 07:24:57 -0700250 rtc::CritScope cs(&crit_sect_);
niklase@google.com470e71d2011-07-07 08:21:25 +0000251
philipel5908c712015-12-21 08:23:20 -0800252 const int64_t max_wait_time_ms =
magjed2943f012016-03-22 05:12:09 -0700253 render_time_ms - now_ms - RequiredDecodeTimeMs() - render_delay_ms_;
niklase@google.com470e71d2011-07-07 08:21:25 +0000254
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000255 if (max_wait_time_ms < 0) {
256 return 0;
257 }
258 return static_cast<uint32_t>(max_wait_time_ms);
niklase@google.com470e71d2011-07-07 08:21:25 +0000259}
260
philipel5908c712015-12-21 08:23:20 -0800261bool VCMTiming::EnoughTimeToDecode(
262 uint32_t available_processing_time_ms) const {
kthelgasond701dfd2017-03-27 07:24:57 -0700263 rtc::CritScope cs(&crit_sect_);
magjed2943f012016-03-22 05:12:09 -0700264 int64_t required_decode_time_ms = RequiredDecodeTimeMs();
265 if (required_decode_time_ms < 0) {
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000266 // Haven't decoded any frames yet, try decoding one to get an estimate
267 // of the decode time.
268 return true;
magjed2943f012016-03-22 05:12:09 -0700269 } else if (required_decode_time_ms == 0) {
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000270 // Decode time is less than 1, set to 1 for now since
271 // we don't have any better precision. Count ticks later?
magjed2943f012016-03-22 05:12:09 -0700272 required_decode_time_ms = 1;
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000273 }
magjed2943f012016-03-22 05:12:09 -0700274 return static_cast<int64_t>(available_processing_time_ms) -
275 required_decode_time_ms >
philipel5908c712015-12-21 08:23:20 -0800276 0;
niklase@google.com470e71d2011-07-07 08:21:25 +0000277}
278
isheriff6b4b5f32016-06-08 00:24:21 -0700279int VCMTiming::TargetVideoDelay() const {
kthelgasond701dfd2017-03-27 07:24:57 -0700280 rtc::CritScope cs(&crit_sect_);
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000281 return TargetDelayInternal();
niklase@google.com470e71d2011-07-07 08:21:25 +0000282}
283
isheriff6b4b5f32016-06-08 00:24:21 -0700284int VCMTiming::TargetDelayInternal() const {
mikhal@webrtc.orgadc64a72013-05-30 16:20:18 +0000285 return std::max(min_playout_delay_ms_,
isheriff6b4b5f32016-06-08 00:24:21 -0700286 jitter_delay_ms_ + RequiredDecodeTimeMs() + render_delay_ms_);
niklase@google.com470e71d2011-07-07 08:21:25 +0000287}
288
asapersson8d560882016-12-22 01:26:18 -0800289bool VCMTiming::GetTimings(int* decode_ms,
fischman@webrtc.org37bb4972013-10-23 23:59:45 +0000290 int* max_decode_ms,
291 int* current_delay_ms,
292 int* target_delay_ms,
293 int* jitter_buffer_ms,
294 int* min_playout_delay_ms,
295 int* render_delay_ms) const {
kthelgasond701dfd2017-03-27 07:24:57 -0700296 rtc::CritScope cs(&crit_sect_);
fischman@webrtc.org37bb4972013-10-23 23:59:45 +0000297 *decode_ms = last_decode_ms_;
isheriff6b4b5f32016-06-08 00:24:21 -0700298 *max_decode_ms = RequiredDecodeTimeMs();
fischman@webrtc.org37bb4972013-10-23 23:59:45 +0000299 *current_delay_ms = current_delay_ms_;
300 *target_delay_ms = TargetDelayInternal();
301 *jitter_buffer_ms = jitter_delay_ms_;
302 *min_playout_delay_ms = min_playout_delay_ms_;
303 *render_delay_ms = render_delay_ms_;
asapersson8d560882016-12-22 01:26:18 -0800304 return (num_decoded_frames_ > 0);
fischman@webrtc.org37bb4972013-10-23 23:59:45 +0000305}
306
mikhal@webrtc.org2eaf98b2013-05-21 17:58:43 +0000307} // namespace webrtc