Make FakeEncoder and FakeH264Encoder thread safe.

webrtc/test/fake_encoder.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/test/fake_encoder.h"
 
+#include <string.h>
+
 #include <algorithm>
+#include <memory>
 
 #include "webrtc/base/atomicops.h"
 #include "webrtc/base/checks.h"
+#include "webrtc/common_types.h"
 #include "webrtc/modules/video_coding/include/video_codec_interface.h"
 #include "webrtc/system_wrappers/include/sleep.h"
 #include "webrtc/test/gtest.h"
 
 namespace webrtc {
 namespace test {
 
 FakeEncoder::FakeEncoder(Clock* clock)
     : clock_(clock),
-      callback_(NULL),
+      callback_(nullptr),
       max_target_bitrate_kbps_(-1),
       last_encode_time_ms_(0) {
   // Generate some arbitrary not-all-zero data
   for (size_t i = 0; i < sizeof(encoded_buffer_); ++i) {
     encoded_buffer_[i] = static_cast<uint8_t>(i);
   }
 }
 
 FakeEncoder::~FakeEncoder() {}
 
 void FakeEncoder::SetMaxBitrate(int max_kbps) {
   RTC_DCHECK_GE(max_kbps, -1);  // max_kbps == -1 disables it.
+  rtc::CritScope cs(&crit_sect_);
   max_target_bitrate_kbps_ = max_kbps;
 }
 
 int32_t FakeEncoder::InitEncode(const VideoCodec* config,
                                 int32_t number_of_cores,
                                 size_t max_payload_size) {
+  rtc::CritScope cs(&crit_sect_);
   config_ = *config;
   target_bitrate_.SetBitrate(0, 0, config_.startBitrate * 1000);
   return 0;
 }
 
 int32_t FakeEncoder::Encode(const VideoFrame& input_image,
                             const CodecSpecificInfo* codec_specific_info,
                             const std::vector<FrameType>* frame_types) {
-  RTC_DCHECK_GT(config_.maxFramerate, 0);
-  int64_t time_since_last_encode_ms = 1000 / config_.maxFramerate;
+  unsigned char max_framerate;
+  unsigned char num_simulcast_streams;
+  SimulcastStream simulcast_streams[kMaxSimulcastStreams];
+  EncodedImageCallback* callback;
+  uint32_t target_bitrate_sum_kbps;
+  int max_target_bitrate_kbps;
+  int64_t last_encode_time_ms;
+  size_t num_encoded_bytes;
+  {
+    rtc::CritScope cs(&crit_sect_);
+    max_framerate = config_.maxFramerate;
+    num_simulcast_streams = config_.numberOfSimulcastStreams;
+    for (int i = 0; i < num_simulcast_streams; ++i) {
+      simulcast_streams[i] = config_.simulcastStream[i];
+    }
+    callback = callback_;
+    target_bitrate_sum_kbps = target_bitrate_.get_sum_kbps();
+    max_target_bitrate_kbps = max_target_bitrate_kbps_;
+    last_encode_time_ms = last_encode_time_ms_;
+    num_encoded_bytes = sizeof(encoded_buffer_);
+  }
+
   int64_t time_now_ms = clock_->TimeInMilliseconds();
-  const bool first_encode = last_encode_time_ms_ == 0;
+  const bool first_encode = (last_encode_time_ms == 0);
+  RTC_DCHECK_GT(max_framerate, 0);
+  int64_t time_since_last_encode_ms = 1000 / max_framerate;
   if (!first_encode) {
     // For all frames but the first we can estimate the display time by looking
     // at the display time of the previous frame.
-    time_since_last_encode_ms = time_now_ms - last_encode_time_ms_;
+    time_since_last_encode_ms = time_now_ms - last_encode_time_ms;
   }
-  if (time_since_last_encode_ms > 3 * 1000 / config_.maxFramerate) {
+  if (time_since_last_encode_ms > 3 * 1000 / max_framerate) {
     // Rudimentary check to make sure we don't widely overshoot bitrate target
     // when resuming encoding after a suspension.
-    time_since_last_encode_ms = 3 * 1000 / config_.maxFramerate;
+    time_since_last_encode_ms = 3 * 1000 / max_framerate;
   }
 
-  size_t bits_available = static_cast<size_t>(target_bitrate_.get_sum_kbps() *
-                                              time_since_last_encode_ms);
-  size_t min_bits = static_cast<size_t>(
-      config_.simulcastStream[0].minBitrate * time_since_last_encode_ms);
+  size_t bits_available =
+      static_cast<size_t>(target_bitrate_sum_kbps * time_since_last_encode_ms);
+  size_t min_bits = static_cast<size_t>(simulcast_streams[0].minBitrate *
+                                        time_since_last_encode_ms);
+
   if (bits_available < min_bits)
     bits_available = min_bits;
   size_t max_bits =
-      static_cast<size_t>(max_target_bitrate_kbps_ * time_since_last_encode_ms);
+      static_cast<size_t>(max_target_bitrate_kbps * time_since_last_encode_ms);
   if (max_bits > 0 && max_bits < bits_available)
     bits_available = max_bits;
-  last_encode_time_ms_ = time_now_ms;
 
-  RTC_DCHECK_GT(config_.numberOfSimulcastStreams, 0);
-  for (unsigned char i = 0; i < config_.numberOfSimulcastStreams; ++i) {
+  {
+    rtc::CritScope cs(&crit_sect_);
+    last_encode_time_ms_ = time_now_ms;
+  }
+
+  RTC_DCHECK_GT(num_simulcast_streams, 0);
+  for (unsigned char i = 0; i < num_simulcast_streams; ++i) {
     CodecSpecificInfo specifics;
     memset(&specifics, 0, sizeof(specifics));
     specifics.codecType = kVideoCodecGeneric;
     specifics.codecSpecific.generic.simulcast_idx = i;
     size_t min_stream_bits = static_cast<size_t>(
-        config_.simulcastStream[i].minBitrate * time_since_last_encode_ms);
+        simulcast_streams[i].minBitrate * time_since_last_encode_ms);
     size_t max_stream_bits = static_cast<size_t>(
-        config_.simulcastStream[i].maxBitrate * time_since_last_encode_ms);
+        simulcast_streams[i].maxBitrate * time_since_last_encode_ms);
     size_t stream_bits = (bits_available > max_stream_bits) ? max_stream_bits :
         bits_available;
     size_t stream_bytes = (stream_bits + 7) / 8;
     if (first_encode) {
       // The first frame is a key frame and should be larger.
       // TODO(holmer): The FakeEncoder should store the bits_available between
       // encodes so that it can compensate for oversized frames.
       stream_bytes *= 10;
     }
-    if (stream_bytes > sizeof(encoded_buffer_))
-      stream_bytes = sizeof(encoded_buffer_);
+    if (stream_bytes > num_encoded_bytes)
+      stream_bytes = num_encoded_bytes;
 
     // Always encode something on the first frame.
     if (min_stream_bits > bits_available && i > 0)
       continue;
-    EncodedImage encoded(
-        encoded_buffer_, stream_bytes, sizeof(encoded_buffer_));
+
+    std::unique_ptr<uint8_t[]> encoded_buffer(new uint8_t[num_encoded_bytes]);
+    memcpy(encoded_buffer.get(), encoded_buffer_, num_encoded_bytes);
+    EncodedImage encoded(encoded_buffer.get(), stream_bytes, num_encoded_bytes);
     encoded._timeStamp = input_image.timestamp();
     encoded.capture_time_ms_ = input_image.render_time_ms();
     encoded._frameType = (*frame_types)[i];
-    encoded._encodedWidth = config_.simulcastStream[i].width;
-    encoded._encodedHeight = config_.simulcastStream[i].height;
+    encoded._encodedWidth = simulcast_streams[i].width;
+    encoded._encodedHeight = simulcast_streams[i].height;
     encoded.rotation_ = input_image.rotation();
-    RTC_DCHECK(callback_ != NULL);
     specifics.codec_name = ImplementationName();
-    if (callback_->OnEncodedImage(encoded, &specifics, NULL).error !=
+    RTC_DCHECK(callback);
+    if (callback->OnEncodedImage(encoded, &specifics, nullptr).error !=
         EncodedImageCallback::Result::OK) {
       return -1;
     }
     bits_available -= std::min(encoded._length * 8, bits_available);
   }
   return 0;
 }
 
 int32_t FakeEncoder::RegisterEncodeCompleteCallback(
     EncodedImageCallback* callback) {
+  rtc::CritScope cs(&crit_sect_);
   callback_ = callback;
   return 0;
 }
 
 int32_t FakeEncoder::Release() { return 0; }
 
 int32_t FakeEncoder::SetChannelParameters(uint32_t packet_loss, int64_t rtt) {
   return 0;
 }
 
 int32_t FakeEncoder::SetRateAllocation(const BitrateAllocation& rate_allocation,
                                        uint32_t framerate) {
+  rtc::CritScope cs(&crit_sect_);
   target_bitrate_ = rate_allocation;
   return 0;
 }
 
 const char* FakeEncoder::kImplementationName = "fake_encoder";
 const char* FakeEncoder::ImplementationName() const {
   return kImplementationName;
 }
 
 FakeH264Encoder::FakeH264Encoder(Clock* clock)
-    : FakeEncoder(clock), callback_(NULL), idr_counter_(0) {
+    : FakeEncoder(clock), callback_(nullptr), idr_counter_(0) {
   FakeEncoder::RegisterEncodeCompleteCallback(this);
 }
 
 int32_t FakeH264Encoder::RegisterEncodeCompleteCallback(
     EncodedImageCallback* callback) {
+  rtc::CritScope cs(&local_crit_sect_);
   callback_ = callback;
   return 0;
 }
 
 EncodedImageCallback::Result FakeH264Encoder::OnEncodedImage(
     const EncodedImage& encoded_image,
     const CodecSpecificInfo* codec_specific_info,
     const RTPFragmentationHeader* fragments) {
   const size_t kSpsSize = 8;
   const size_t kPpsSize = 11;
   const int kIdrFrequency = 10;
+  EncodedImageCallback* callback;
+  int current_idr_counter;
+  {
+    rtc::CritScope cs(&local_crit_sect_);
+    callback = callback_;
+    current_idr_counter = idr_counter_;
+    ++idr_counter_;
+  }
   RTPFragmentationHeader fragmentation;
-  if (idr_counter_++ % kIdrFrequency == 0 &&
+  if (current_idr_counter % kIdrFrequency == 0 &&
       encoded_image._length > kSpsSize + kPpsSize + 1) {
     const size_t kNumSlices = 3;
     fragmentation.VerifyAndAllocateFragmentationHeader(kNumSlices);
     fragmentation.fragmentationOffset[0] = 0;
     fragmentation.fragmentationLength[0] = kSpsSize;
     fragmentation.fragmentationOffset[1] = kSpsSize;
     fragmentation.fragmentationLength[1] = kPpsSize;
     fragmentation.fragmentationOffset[2] = kSpsSize + kPpsSize;
     fragmentation.fragmentationLength[2] =
         encoded_image._length - (kSpsSize + kPpsSize);
@@ skipping 19 matching lines @@
       encoded_image._buffer[i] = value++;
     } else {
       ++fragment_counter;
     }
   }
   CodecSpecificInfo specifics;
   memset(&specifics, 0, sizeof(specifics));
   specifics.codecType = kVideoCodecH264;
   specifics.codecSpecific.H264.packetization_mode =
       H264PacketizationMode::NonInterleaved;
-  return callback_->OnEncodedImage(encoded_image, &specifics, &fragmentation);
+  RTC_DCHECK(callback);
+  return callback->OnEncodedImage(encoded_image, &specifics, &fragmentation);
 }
 
 DelayedEncoder::DelayedEncoder(Clock* clock, int delay_ms)
     : test::FakeEncoder(clock),
       delay_ms_(delay_ms) {}
 
 void DelayedEncoder::SetDelay(int delay_ms) {
-  rtc::CritScope lock(&lock_);
+  rtc::CritScope cs(&local_crit_sect_);
   delay_ms_ = delay_ms;
 }
 
 int32_t DelayedEncoder::Encode(const VideoFrame& input_image,
                                const CodecSpecificInfo* codec_specific_info,
                                const std::vector<FrameType>* frame_types) {
   int delay_ms = 0;
   {
-    rtc::CritScope lock(&lock_);
+    rtc::CritScope cs(&local_crit_sect_);
     delay_ms = delay_ms_;
   }
   SleepMs(delay_ms);
   return FakeEncoder::Encode(input_image, codec_specific_info, frame_types);
 }
 
-MultiThreadedFakeH264Encoder::MultiThreadedFakeH264Encoder(Clock* clock)
+MultithreadedFakeH264Encoder::MultithreadedFakeH264Encoder(Clock* clock)
     : test::FakeH264Encoder(clock),
       current_queue_(0),
       queue1_("Queue 1"),
       queue2_("Queue 2") {}
 
-MultiThreadedFakeH264Encoder::~MultiThreadedFakeH264Encoder() = default;
+MultithreadedFakeH264Encoder::~MultithreadedFakeH264Encoder() = default;
 
-class MultiThreadedFakeH264Encoder::EncodeTask : public rtc::QueuedTask {
+class MultithreadedFakeH264Encoder::EncodeTask : public rtc::QueuedTask {
  public:
-  EncodeTask(MultiThreadedFakeH264Encoder* encoder,
+  EncodeTask(MultithreadedFakeH264Encoder* encoder,
              const VideoFrame& input_image,
              const CodecSpecificInfo* codec_specific_info,
              const std::vector<FrameType>* frame_types)
       : encoder_(encoder),
         input_image_(input_image),
         codec_specific_info_(),
         frame_types_(*frame_types) {
     if (codec_specific_info)
       codec_specific_info_ = *codec_specific_info;
   }
 
  private:
   bool Run() override {
     encoder_->EncodeCallback(input_image_, &codec_specific_info_,
                              &frame_types_);
     return true;
   }
 
-  MultiThreadedFakeH264Encoder* const encoder_;
+  MultithreadedFakeH264Encoder* const encoder_;
   VideoFrame input_image_;
   CodecSpecificInfo codec_specific_info_;
   std::vector<FrameType> frame_types_;
 };
 
-int32_t MultiThreadedFakeH264Encoder::Encode(
+int32_t MultithreadedFakeH264Encoder::Encode(
     const VideoFrame& input_image,
     const CodecSpecificInfo* codec_specific_info,
     const std::vector<FrameType>* frame_types) {
   int current_queue = rtc::AtomicOps::Increment(&current_queue_);
   rtc::TaskQueue& queue = (current_queue % 2 == 0) ? queue1_ : queue2_;
 
   queue.PostTask(std::unique_ptr<rtc::QueuedTask>(
       new EncodeTask(this, input_image, codec_specific_info, frame_types)));
 
   return 0;
 }
 
-int32_t MultiThreadedFakeH264Encoder::EncodeCallback(
+int32_t MultithreadedFakeH264Encoder::EncodeCallback(
     const VideoFrame& input_image,
     const CodecSpecificInfo* codec_specific_info,
     const std::vector<FrameType>* frame_types) {
   return FakeH264Encoder::Encode(input_image, codec_specific_info, frame_types);
 }
 
 }  // namespace test
 }  // namespace webrtc