Lock scheme #8: Introduced the new locking scheme

webrtc/modules/audio_processing/echo_control_mobile_impl.cc

 /*
  *  Copyright (c) 2012 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/modules/audio_processing/echo_control_mobile_impl.h"
 
 #include <assert.h>
 #include <string.h>
 
+#include "webrtc/base/criticalsection.h"
 #include "webrtc/modules/audio_processing/aecm/include/echo_control_mobile.h"
 #include "webrtc/modules/audio_processing/audio_buffer.h"
-#include "webrtc/system_wrappers/include/critical_section_wrapper.h"
 #include "webrtc/system_wrappers/include/logging.h"
 
 namespace webrtc {
 
 typedef void Handle;
 
 namespace {
 int16_t MapSetting(EchoControlMobile::RoutingMode mode) {
   switch (mode) {
     case EchoControlMobile::kQuietEarpieceOrHeadset:
@@ skipping 31 matching lines @@
 
 const size_t EchoControlMobileImpl::kAllowedValuesOfSamplesPerFrame1;
 const size_t EchoControlMobileImpl::kAllowedValuesOfSamplesPerFrame2;
 
 size_t EchoControlMobile::echo_path_size_bytes() {
     return WebRtcAecm_echo_path_size_bytes();
 }
 
 EchoControlMobileImpl::EchoControlMobileImpl(
     const AudioProcessing* apm,
-    CriticalSectionWrapper* crit,
+    rtc::CriticalSection* crit_render,
+    rtc::CriticalSection* crit_capture,
     rtc::ThreadChecker* render_thread_checker)
     : ProcessingComponent(),
       apm_(apm),
-      crit_(crit),
+      crit_render_(crit_render),
+      crit_capture_(crit_capture),
       render_thread_checker_(render_thread_checker),
       routing_mode_(kSpeakerphone),
       comfort_noise_enabled_(true),
       external_echo_path_(NULL),
       render_queue_element_max_size_(0) {
   AllocateRenderQueue();
 }
 
 EchoControlMobileImpl::~EchoControlMobileImpl() {
     if (external_echo_path_ != NULL) {
@@ skipping 29 matching lines @@
       // Buffer the samples in the render queue.
       render_queue_buffer_.insert(render_queue_buffer_.end(),
                                   audio->split_bands_const(j)[kBand0To8kHz],
                                   (audio->split_bands_const(j)[kBand0To8kHz] +
                                    audio->num_frames_per_band()));
 
       handle_index++;
     }
   }
 
-  // Check of success is temporarily disabled as it breaks a unit test.
-  // TODO(peah): Will be fixed in the next CL.
-  (void)render_signal_queue_->Insert(&render_queue_buffer_);
+  // Insert the samples into the queue.
+  bool success = render_signal_queue_->Insert(&render_queue_buffer_);
+  if (!success) {

[hlundin-webrtc, 2015/11/05 16:11:22]

if (!render_signal_queue_->Insert(&render_queue_buffer_)) {

[peah-webrtc, 2015/11/06 09:54:32]

Done.

+    // The data queue is full and needs to be emptied.
+    {
+      rtc::CritScope cs_capture(crit_capture_);
+      ReadQueuedRenderData();
+    }
+
+    // Retry the insert (should always work).
+    RTC_DCHECK_EQ(render_signal_queue_->Insert(&render_queue_buffer_), true);
+  }
 
   return apm_->kNoError;
 }
 
 // Read chunks of data that were received and queued on the render side from
 // a queue. All the data chunks are buffered into the farend signal of the AEC.
 void EchoControlMobileImpl::ReadQueuedRenderData() {
   if (!is_component_enabled()) {
     return;
   }
@@ skipping 57 matching lines @@
         return MapError(err);
 
       handle_index++;
     }
   }
 
   return apm_->kNoError;
 }
 
 int EchoControlMobileImpl::Enable(bool enable) {
-  CriticalSectionScoped crit_scoped(crit_);
+  // Run in a single-threaded manner
+  rtc::CritScope cs_render(crit_render_);
+  rtc::CritScope cs_capture(crit_capture_);
   // Ensure AEC and AECM are not both enabled.
   if (enable && apm_->echo_cancellation()->is_enabled()) {
     return apm_->kBadParameterError;
   }
 
   return EnableComponent(enable);
 }
 
 bool EchoControlMobileImpl::is_enabled() const {
+  rtc::CritScope cs(crit_capture_);
   return is_component_enabled();
 }
 
 int EchoControlMobileImpl::set_routing_mode(RoutingMode mode) {
-  CriticalSectionScoped crit_scoped(crit_);
+  rtc::CritScope cs(crit_capture_);
   if (MapSetting(mode) == -1) {
     return apm_->kBadParameterError;
   }
 
   routing_mode_ = mode;
   return Configure();
 }
 
 EchoControlMobile::RoutingMode EchoControlMobileImpl::routing_mode()
     const {
+  rtc::CritScope cs(crit_capture_);
   return routing_mode_;
 }
 
 int EchoControlMobileImpl::enable_comfort_noise(bool enable) {
-  CriticalSectionScoped crit_scoped(crit_);
+  rtc::CritScope cs(crit_capture_);
   comfort_noise_enabled_ = enable;
   return Configure();
 }
 
 bool EchoControlMobileImpl::is_comfort_noise_enabled() const {
+  rtc::CritScope cs(crit_capture_);
   return comfort_noise_enabled_;
 }
 
 int EchoControlMobileImpl::SetEchoPath(const void* echo_path,
                                        size_t size_bytes) {
-  CriticalSectionScoped crit_scoped(crit_);
+  rtc::CritScope cs_render(crit_render_);
+  rtc::CritScope cs_capture(crit_capture_);
   if (echo_path == NULL) {
     return apm_->kNullPointerError;
   }
   if (size_bytes != echo_path_size_bytes()) {
     // Size mismatch
     return apm_->kBadParameterError;
   }
 
   if (external_echo_path_ == NULL) {
     external_echo_path_ = new unsigned char[size_bytes];
   }
   memcpy(external_echo_path_, echo_path, size_bytes);
 
   return Initialize();
 }
 
 int EchoControlMobileImpl::GetEchoPath(void* echo_path,
                                        size_t size_bytes) const {
-  CriticalSectionScoped crit_scoped(crit_);
+  rtc::CritScope cs(crit_capture_);
   if (echo_path == NULL) {
     return apm_->kNullPointerError;
   }
   if (size_bytes != echo_path_size_bytes()) {
     // Size mismatch
     return apm_->kBadParameterError;
   }
   if (!is_component_enabled()) {
     return apm_->kNotEnabledError;
   }
 
   // Get the echo path from the first channel
   Handle* my_handle = static_cast<Handle*>(handle(0));
   int32_t err = WebRtcAecm_GetEchoPath(my_handle, echo_path, size_bytes);
   if (err != 0)
     return MapError(err);
 
   return apm_->kNoError;
 }
 
 int EchoControlMobileImpl::Initialize() {
+  // Only called from within APM, hence no locking is needed.
   if (!is_component_enabled()) {
     return apm_->kNoError;
   }
 
   if (apm_->proc_sample_rate_hz() > apm_->kSampleRate16kHz) {
     LOG(LS_ERROR) << "AECM only supports 16 kHz or lower sample rates";
     return apm_->kBadSampleRateError;
   }
 
   int err = ProcessingComponent::Initialize();
   if (err != apm_->kNoError) {
     return err;
   }
 
   AllocateRenderQueue();
 
   return apm_->kNoError;
 }
 
 void EchoControlMobileImpl::AllocateRenderQueue() {
+  // Only called from within APM, hence no locking is needed.
   const size_t max_frame_size = std::max(kAllowedValuesOfSamplesPerFrame1,
                                          kAllowedValuesOfSamplesPerFrame2);
   const size_t new_render_queue_element_max_size =
       std::max(1UL, max_frame_size * num_handles_required());
 
   // Reallocate the queue if the queue item size is too small to fit the
   // data to put in the queue.
   if (new_render_queue_element_max_size > render_queue_element_max_size_) {
     render_queue_element_max_size_ = new_render_queue_element_max_size;
 
     std::vector<int16_t> template_queue_element(render_queue_element_max_size_);
 
     render_signal_queue_.reset(
         new SwapQueue<std::vector<int16_t>, AecmRenderQueueItemVerifier>(
             kMaxNumFramesToBuffer,
             AecmRenderQueueItemVerifier(render_queue_element_max_size_),
             template_queue_element));
   } else {
     render_signal_queue_->Clear();
   }
 
   render_queue_buffer_.resize(new_render_queue_element_max_size);
   capture_queue_buffer_.resize(new_render_queue_element_max_size);
 }
 
 void* EchoControlMobileImpl::CreateHandle() const {
+  // Only called from within APM, hence no locking is needed.
   return WebRtcAecm_Create();
 }
 
 void EchoControlMobileImpl::DestroyHandle(void* handle) const {
+  // Only called from within APM, hence no locking is needed.
   WebRtcAecm_Free(static_cast<Handle*>(handle));
 }
 
 int EchoControlMobileImpl::InitializeHandle(void* handle) const {
+  // Only called from within APM, hence no locking is needed.
   assert(handle != NULL);
   Handle* my_handle = static_cast<Handle*>(handle);
   if (WebRtcAecm_Init(my_handle, apm_->proc_sample_rate_hz()) != 0) {
     return GetHandleError(my_handle);
   }
   if (external_echo_path_ != NULL) {
     if (WebRtcAecm_InitEchoPath(my_handle,
                                 external_echo_path_,
                                 echo_path_size_bytes()) != 0) {
       return GetHandleError(my_handle);
     }
   }
 
   return apm_->kNoError;
 }
 
 int EchoControlMobileImpl::ConfigureHandle(void* handle) const {
+  // Only called from within APM, hence no locking is needed.
   AecmConfig config;
   config.cngMode = comfort_noise_enabled_;
   config.echoMode = MapSetting(routing_mode_);
 
   return WebRtcAecm_set_config(static_cast<Handle*>(handle), config);
 }
 
 int EchoControlMobileImpl::num_handles_required() const {
+  // Only called from within APM, hence no locking is needed.
   return apm_->num_output_channels() *
          apm_->num_reverse_channels();
 }
 
 int EchoControlMobileImpl::GetHandleError(void* handle) const {
+  // Only called from within APM, hence no locking is needed.
   assert(handle != NULL);
   return AudioProcessing::kUnspecifiedError;
 }
 
 }  // namespace webrtc