Add sender controlled playout delay limits

webrtc/modules/video_coding/timing.cc

 /*
  *  Copyright (c) 2011 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
@@ skipping 10 matching lines @@
 namespace webrtc {
 
 VCMTiming::VCMTiming(Clock* clock, VCMTiming* master_timing)
     : crit_sect_(CriticalSectionWrapper::CreateCriticalSection()),
       clock_(clock),
       master_(false),
       ts_extrapolator_(),
       codec_timer_(new VCMCodecTimer()),
       render_delay_ms_(kDefaultRenderDelayMs),
       min_playout_delay_ms_(0),
+      max_playout_delay_ms_(10000),
       jitter_delay_ms_(0),
       current_delay_ms_(0),
       last_decode_ms_(0),
       prev_frame_timestamp_(0),
       num_decoded_frames_(0),
       num_delayed_decoded_frames_(0),
       first_decoded_frame_ms_(-1),
       sum_missed_render_deadline_ms_(0) {
   if (master_timing == NULL) {
     master_ = true;
@@ skipping 43 matching lines @@
   jitter_delay_ms_ = 0;
   current_delay_ms_ = 0;
   prev_frame_timestamp_ = 0;
 }
 
 void VCMTiming::ResetDecodeTime() {
   CriticalSectionScoped lock(crit_sect_);
   codec_timer_.reset(new VCMCodecTimer());
 }
 
-void VCMTiming::set_render_delay(uint32_t render_delay_ms) {
+void VCMTiming::set_render_delay(int render_delay_ms) {
   CriticalSectionScoped cs(crit_sect_);
   render_delay_ms_ = render_delay_ms;
 }
 
-void VCMTiming::set_min_playout_delay(uint32_t min_playout_delay_ms) {
+void VCMTiming::set_min_playout_delay(int min_playout_delay_ms) {
   CriticalSectionScoped cs(crit_sect_);
   min_playout_delay_ms_ = min_playout_delay_ms;
 }
 
-void VCMTiming::SetJitterDelay(uint32_t jitter_delay_ms) {
+int VCMTiming::min_playout_delay() {
+  CriticalSectionScoped cs(crit_sect_);
+  return min_playout_delay_ms_;
+}
+
+void VCMTiming::set_max_playout_delay(int max_playout_delay_ms) {
+  CriticalSectionScoped cs(crit_sect_);
+  max_playout_delay_ms_ = max_playout_delay_ms;
+}
+
+int VCMTiming::max_playout_delay() {
+  CriticalSectionScoped cs(crit_sect_);
+  return max_playout_delay_ms_;
+}
+
+void VCMTiming::SetJitterDelay(int jitter_delay_ms) {
   CriticalSectionScoped cs(crit_sect_);
   if (jitter_delay_ms != jitter_delay_ms_) {
     jitter_delay_ms_ = jitter_delay_ms;
     // When in initial state, set current delay to minimum delay.
     if (current_delay_ms_ == 0) {
       current_delay_ms_ = jitter_delay_ms_;
     }
   }
 }
 
 void VCMTiming::UpdateCurrentDelay(uint32_t frame_timestamp) {
   CriticalSectionScoped cs(crit_sect_);
-  uint32_t target_delay_ms = TargetDelayInternal();
+  int target_delay_ms = TargetDelayInternal();
 
   if (current_delay_ms_ == 0) {
     // Not initialized, set current delay to target.
     current_delay_ms_ = target_delay_ms;
   } else if (target_delay_ms != current_delay_ms_) {
     int64_t delay_diff_ms =
         static_cast<int64_t>(target_delay_ms) - current_delay_ms_;
     // Never change the delay with more than 100 ms every second. If we're
     // changing the delay in too large steps we will get noticeable freezes. By
     // limiting the change we can increase the delay in smaller steps, which
@@ skipping 12 matching lines @@
     }
     if (max_change_ms <= 0) {
       // Any changes less than 1 ms are truncated and
       // will be postponed. Negative change will be due
       // to reordering and should be ignored.
       return;
     }
     delay_diff_ms = std::max(delay_diff_ms, -max_change_ms);
     delay_diff_ms = std::min(delay_diff_ms, max_change_ms);
 
-    current_delay_ms_ = current_delay_ms_ + static_cast<int32_t>(delay_diff_ms);
+    current_delay_ms_ = current_delay_ms_ + delay_diff_ms;
   }
   prev_frame_timestamp_ = frame_timestamp;
 }
 
 void VCMTiming::UpdateCurrentDelay(int64_t render_time_ms,
                                    int64_t actual_decode_time_ms) {
   CriticalSectionScoped cs(crit_sect_);
   uint32_t target_delay_ms = TargetDelayInternal();
   int64_t delayed_ms =
       actual_decode_time_ms -
       (render_time_ms - RequiredDecodeTimeMs() - render_delay_ms_);
   if (delayed_ms < 0) {
     return;
   }
   if (current_delay_ms_ + delayed_ms <= target_delay_ms) {
-    current_delay_ms_ += static_cast<uint32_t>(delayed_ms);
+    current_delay_ms_ += delayed_ms;
   } else {
     current_delay_ms_ = target_delay_ms;
   }
 }
 
 int32_t VCMTiming::StopDecodeTimer(uint32_t time_stamp,
                                    int32_t decode_time_ms,
                                    int64_t now_ms,
                                    int64_t render_time_ms) {
   CriticalSectionScoped cs(crit_sect_);
@@ skipping 27 matching lines @@
 }
 
 int64_t VCMTiming::RenderTimeMsInternal(uint32_t frame_timestamp,
                                         int64_t now_ms) const {
   int64_t estimated_complete_time_ms =
       ts_extrapolator_->ExtrapolateLocalTime(frame_timestamp);
   if (estimated_complete_time_ms == -1) {
     estimated_complete_time_ms = now_ms;
   }
 
-  // Make sure that we have at least the playout delay.
-  uint32_t actual_delay = std::max(current_delay_ms_, min_playout_delay_ms_);
+  if (min_playout_delay_ms_ == 0 && max_playout_delay_ms_ == 0) {
+    // Render as soon as possible
+    return now_ms;
+  }
+
+  // Make sure the actual delay stays in the range of |min_playout_delay_ms_|
+  // and |max_playout_delay_ms_|.
+  int actual_delay = std::max(current_delay_ms_, min_playout_delay_ms_);
+  actual_delay = std::min(actual_delay, max_playout_delay_ms_);
   return estimated_complete_time_ms + actual_delay;
 }
 
 // Must be called from inside a critical section.
-int64_t VCMTiming::RequiredDecodeTimeMs() const {
-  const int64_t decode_time_ms = codec_timer_->RequiredDecodeTimeMs();
+int VCMTiming::RequiredDecodeTimeMs() const {
+  const int decode_time_ms = codec_timer_->RequiredDecodeTimeMs();
   assert(decode_time_ms >= 0);
   return decode_time_ms;
 }
 
 uint32_t VCMTiming::MaxWaitingTime(int64_t render_time_ms,
                                    int64_t now_ms) const {
   CriticalSectionScoped cs(crit_sect_);
 
   const int64_t max_wait_time_ms =
       render_time_ms - now_ms - RequiredDecodeTimeMs() - render_delay_ms_;
@@ skipping 15 matching lines @@
   } else if (required_decode_time_ms == 0) {
     // Decode time is less than 1, set to 1 for now since
     // we don't have any better precision. Count ticks later?
     required_decode_time_ms = 1;
   }
   return static_cast<int64_t>(available_processing_time_ms) -
              required_decode_time_ms >
          0;
 }
 
-uint32_t VCMTiming::TargetVideoDelay() const {
+int VCMTiming::TargetVideoDelay() const {
   CriticalSectionScoped cs(crit_sect_);
   return TargetDelayInternal();
 }
 
-uint32_t VCMTiming::TargetDelayInternal() const {
+int VCMTiming::TargetDelayInternal() const {
   return std::max(min_playout_delay_ms_,
-                  jitter_delay_ms_ +
-                      static_cast<uint32_t>(RequiredDecodeTimeMs()) +
-                      render_delay_ms_);
+                  jitter_delay_ms_ + RequiredDecodeTimeMs() + render_delay_ms_);
 }
 
 void VCMTiming::GetTimings(int* decode_ms,
                            int* max_decode_ms,
                            int* current_delay_ms,
                            int* target_delay_ms,
                            int* jitter_buffer_ms,
                            int* min_playout_delay_ms,
                            int* render_delay_ms) const {
   CriticalSectionScoped cs(crit_sect_);
   *decode_ms = last_decode_ms_;
-  *max_decode_ms = static_cast<int>(RequiredDecodeTimeMs());
+  *max_decode_ms = RequiredDecodeTimeMs();
   *current_delay_ms = current_delay_ms_;
   *target_delay_ms = TargetDelayInternal();
   *jitter_buffer_ms = jitter_delay_ms_;
   *min_playout_delay_ms = min_playout_delay_ms_;
   *render_delay_ms = render_delay_ms_;
 }
 
 }  // namespace webrtc