Start documenting the threading model

webrtc/video/video_receive_stream.cc

 /*
  *  Copyright (c) 2013 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.
  */
 
 #include "webrtc/video/video_receive_stream.h"
 
 #include <stdlib.h>
 
 #include <set>
 #include <string>
 #include <utility>
 
 #include "webrtc/base/checks.h"
 #include "webrtc/base/location.h"
 #include "webrtc/base/logging.h"
 #include "webrtc/base/optional.h"
+#include "webrtc/base/timeutils.h"
 #include "webrtc/base/trace_event.h"
 #include "webrtc/common_video/h264/profile_level_id.h"
 #include "webrtc/common_video/libyuv/include/webrtc_libyuv.h"
 #include "webrtc/modules/rtp_rtcp/include/rtp_receiver.h"
 #include "webrtc/modules/rtp_rtcp/include/rtp_rtcp.h"
 #include "webrtc/modules/utility/include/process_thread.h"
 #include "webrtc/modules/video_coding/frame_object.h"
 #include "webrtc/modules/video_coding/include/video_coding.h"
 #include "webrtc/modules/video_coding/jitter_estimator.h"
 #include "webrtc/modules/video_coding/timing.h"
@@ skipping 196 matching lines @@
 
   process_thread_->RegisterModule(&video_receiver_, RTC_FROM_HERE);
   process_thread_->RegisterModule(&rtp_stream_sync_, RTC_FROM_HERE);
 }
 
 VideoReceiveStream::~VideoReceiveStream() {
   RTC_DCHECK_RUN_ON(&worker_thread_checker_);
   LOG(LS_INFO) << "~VideoReceiveStream: " << config_.ToString();
   Stop();
 
+  LOG(LS_INFO) << "~VideoReceiveStream: DeRegisterModule rtp_stream_sync_.";
   process_thread_->DeRegisterModule(&rtp_stream_sync_);
+  LOG(LS_INFO) << "~VideoReceiveStream: DeRegisterModule video_receiver_.";
   process_thread_->DeRegisterModule(&video_receiver_);
+
+  LOG(LS_INFO) << "~VideoReceiveStream: Modules DeRegistered.";
 }
 
 void VideoReceiveStream::SignalNetworkState(NetworkState state) {
   RTC_DCHECK_RUN_ON(&worker_thread_checker_);
   rtp_stream_receiver_.SignalNetworkState(state);
 }
 
 
 bool VideoReceiveStream::DeliverRtcp(const uint8_t* packet, size_t length) {
   return rtp_stream_receiver_.DeliverRtcp(packet, length);
@@ skipping 52 matching lines @@
   }
 
   video_stream_decoder_.reset(new VideoStreamDecoder(
       &video_receiver_, &rtp_stream_receiver_, &rtp_stream_receiver_,
       rtp_stream_receiver_.IsRetransmissionsEnabled(), protected_by_fec,
       &stats_proxy_, renderer));
   // Register the channel to receive stats updates.
   call_stats_->RegisterStatsObserver(video_stream_decoder_.get());
   // Start the decode thread
   decode_thread_.Start();
-#if !defined(WEBRTC_ANDROID)
-  // On android, the decoding happens on a different thread and frames
-  // are delivered on that thread (that in itself needs to be fixed).
-  // In any event, the actual decoding work is higher priority than the
-  // |decode_thread_| on Android, so we only raise the deocode priority on
-  // platforms other than Android.
-  decode_thread_.SetPriority(rtc::kHighestPriority);
-#endif
   rtp_stream_receiver_.StartReceive();
 }
 
 void VideoReceiveStream::Stop() {
   RTC_DCHECK_RUN_ON(&worker_thread_checker_);
+  LOG(LS_INFO) << "VideoReceiveStream::Stop: StopReceive";
   rtp_stream_receiver_.StopReceive();
   // TriggerDecoderShutdown will release any waiting decoder thread and make it
   // stop immediately, instead of waiting for a timeout. Needs to be called
   // before joining the decoder thread thread.
+  LOG(LS_INFO) << "VideoReceiveStream::Stop: TriggerDecoderShutdown";
   video_receiver_.TriggerDecoderShutdown();
 
+  LOG(LS_INFO) << "VideoReceiveStream::Stop: frame_buffer_";
   frame_buffer_->Stop();
+  LOG(LS_INFO) << "VideoReceiveStream::Stop: call_stats_";
   call_stats_->DeregisterStatsObserver(&rtp_stream_receiver_);
 
   if (decode_thread_.IsRunning()) {
+    LOG(LS_INFO) << "VideoReceiveStream::Stop: decode_thread_";
     decode_thread_.Stop();
     // Deregister external decoders so they are no longer running during
     // destruction. This effectively stops the VCM since the decoder thread is
     // stopped, the VCM is deregistered and no asynchronous decoder threads are
     // running.
     for (const Decoder& decoder : config_.decoders)
       video_receiver_.RegisterExternalDecoder(nullptr, decoder.payload_type);
   }
 
+  LOG(LS_INFO) << "VideoReceiveStream::Stop: call_stats_";
   call_stats_->DeregisterStatsObserver(video_stream_decoder_.get());
+  LOG(LS_INFO) << "VideoReceiveStream::Stop: video_stream_decoder_";
   video_stream_decoder_.reset();
+  LOG(LS_INFO) << "VideoReceiveStream::Stop: incoming_video_stream_";
   incoming_video_stream_.reset();
+  LOG(LS_INFO) << "VideoReceiveStream::Stop: transport_adapter_";
   transport_adapter_.Disable();
+  LOG(LS_INFO) << "VideoReceiveStream::Stop: done";
 }
 
 VideoReceiveStream::Stats VideoReceiveStream::GetStats() const {
   return stats_proxy_.GetStats();
 }
 
 void VideoReceiveStream::EnableEncodedFrameRecording(rtc::PlatformFile file,
                                                      size_t byte_limit) {
   {
     rtc::CritScope lock(&ivf_writer_lock_);
@@ skipping 111 matching lines @@
 uint32_t VideoReceiveStream::GetPlayoutTimestamp() const {
   RTC_NOTREACHED();
   return 0;
 }
 
 void VideoReceiveStream::SetMinimumPlayoutDelay(int delay_ms) {
   RTC_DCHECK_RUN_ON(&module_process_thread_checker_);
   video_receiver_.SetMinimumPlayoutDelay(delay_ms);
 }
 
-bool VideoReceiveStream::DecodeThreadFunction(void* ptr) {
-  return static_cast<VideoReceiveStream*>(ptr)->Decode();
+void VideoReceiveStream::DecodeThreadFunction(void* ptr) {
+  while (static_cast<VideoReceiveStream*>(ptr)->Decode()) {
+  }
 }
 
 bool VideoReceiveStream::Decode() {
   TRACE_EVENT0("webrtc", "VideoReceiveStream::Decode");
   static const int kMaxWaitForFrameMs = 3000;
   std::unique_ptr<video_coding::FrameObject> frame;
-  video_coding::FrameBuffer::ReturnReason res =
-      frame_buffer_->NextFrame(kMaxWaitForFrameMs, &frame);
+
+  video_coding::FrameBuffer::ReturnReason res;
+#if defined(WEBRTC_ANDROID)
+  static const int kPollIntervalMs = 10;
+  int time_remaining = kMaxWaitForFrameMs;
+  do {
+    res = frame_buffer_->NextFrame(kPollIntervalMs, &frame);
+    if (res != video_coding::FrameBuffer::ReturnReason::kTimeout)
+      break;
+    time_remaining -= kPollIntervalMs;
+    video_receiver_.PollDecodedFrames();
+  } while (time_remaining > 0);
+#else
+  res = frame_buffer_->NextFrame(kMaxWaitForFrameMs, &frame);
+#endif
 
   if (res == video_coding::FrameBuffer::ReturnReason::kStopped)
     return false;
 
   if (frame) {
-    if (video_receiver_.Decode(frame.get()) == VCM_OK)
+    auto ret = video_receiver_.Decode(frame.get());
+    if (ret == VCM_OK) {
       rtp_stream_receiver_.FrameDecoded(frame->picture_id);
+    } else {
+      printf("ret = %i\n", ret);
+    }
   } else {
+    RTC_DCHECK_EQ(res, video_coding::FrameBuffer::ReturnReason::kTimeout);
     LOG(LS_WARNING) << "No decodable frame in " << kMaxWaitForFrameMs
                     << " ms, requesting keyframe.";
     RequestKeyFrame();
   }
+
   return true;
 }
 }  // namespace internal
 }  // namespace webrtc