Lock scheme #8: Introduced the new locking scheme

webrtc/modules/audio_processing/echo_control_mobile_impl.h

+

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

No

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

Done.

 /*
  *  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.
  */
 
 #ifndef WEBRTC_MODULES_AUDIO_PROCESSING_ECHO_CONTROL_MOBILE_IMPL_H_
 #define WEBRTC_MODULES_AUDIO_PROCESSING_ECHO_CONTROL_MOBILE_IMPL_H_
 
 #include "webrtc/base/scoped_ptr.h"
+#include "webrtc/base/thread_annotations.h"

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

Not used.

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

Done.

 #include "webrtc/base/thread_checker.h"
 #include "webrtc/common_audio/swap_queue.h"
 #include "webrtc/modules/audio_processing/include/audio_processing.h"
 #include "webrtc/modules/audio_processing/processing_component.h"
 
 namespace webrtc {
 
 namespace {
 // Functor to use when supplying a verifier function for the queue item
 // verifcation.
@@ skipping 11 matching lines @@
 };
 
 }  // namespace anonymous
 
 class AudioBuffer;
 class CriticalSectionWrapper;
 
 class EchoControlMobileImpl : public EchoControlMobile,
                               public ProcessingComponent {
  public:
+  // Called holding both the render and capture locks.
   EchoControlMobileImpl(const AudioProcessing* apm,
-                        CriticalSectionWrapper* crit,
+                        rtc::CriticalSection* crit_render,
+                        rtc::CriticalSection* crit_capture,
                         rtc::ThreadChecker* render_thread_checker);
-  virtual ~EchoControlMobileImpl();
 
-  int ProcessRenderAudio(const AudioBuffer* audio);
-  int ProcessCaptureAudio(AudioBuffer* audio);
+  virtual ~EchoControlMobileImpl();  // Called holding both the render and
+                                     // capture locks.
+
+  int ProcessRenderAudio(

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

Again, please restore the one-line definitions where possible, and put the
comment on a separate line if needed.

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

Done.

+      const AudioBuffer* audio);  // Called holding the render lock.
+  int ProcessCaptureAudio(
+      AudioBuffer* audio);  // Called holding the capture lock.
 
   // EchoControlMobile implementation.
-  bool is_enabled() const override;
-  RoutingMode routing_mode() const override;
-  bool is_comfort_noise_enabled() const override;
+  bool is_enabled() const override;                // Aquires the capture lock.
+  RoutingMode routing_mode() const override;       // Aquires the capture lock.
+  bool is_comfort_noise_enabled() const override;  // Aquires the capture lock.
 
   // ProcessingComponent implementation.
-  int Initialize() override;
+  int Initialize()
+      override;  // Called holding both the render and capture locks.
 
   // Reads render side data that has been queued on the render call.
-  void ReadQueuedRenderData();
+  void ReadQueuedRenderData();  // Called holding the capture lock.
 
  private:
   static const size_t kAllowedValuesOfSamplesPerFrame1 = 80;
   static const size_t kAllowedValuesOfSamplesPerFrame2 = 160;
   // TODO(peah): Decrease this once we properly handle hugely unbalanced
   // reverse and forward call numbers.
   static const size_t kMaxNumFramesToBuffer = 100;
 
   // EchoControlMobile implementation.
-  int Enable(bool enable) override;
-  int set_routing_mode(RoutingMode mode) override;
-  int enable_comfort_noise(bool enable) override;
-  int SetEchoPath(const void* echo_path, size_t size_bytes) override;
-  int GetEchoPath(void* echo_path, size_t size_bytes) const override;
+  int Enable(
+      bool enable) override;  // Aquires both the render and capture locks.
+  int set_routing_mode(RoutingMode mode) override;  // Aquires the capture lock.
+  int enable_comfort_noise(bool enable) override;   // Aquires the capture lock.
+  int SetEchoPath(const void* echo_path, size_t size_bytes)
+      override;  // Aquires both the capture and render locks.
+  int GetEchoPath(void* echo_path, size_t size_bytes)
+      const override;  // Aquires the capture lock.
 
   // ProcessingComponent implementation.
-  void* CreateHandle() const override;
-  int InitializeHandle(void* handle) const override;
-  int ConfigureHandle(void* handle) const override;
-  void DestroyHandle(void* handle) const override;
-  int num_handles_required() const override;
-  int GetHandleError(void* handle) const override;
+  void* CreateHandle()
+      const override;  // Called holding both the render and capture locks.
+  int InitializeHandle(void* handle)
+      const override;  // Called holding both the render and capture locks.
+  int ConfigureHandle(void* handle)
+      const override;  // Called holding both the render and capture locks.
+  void DestroyHandle(void* handle)
+      const override;  // Called holding both the render and capture locks.
+  int num_handles_required()
+      const override;  // Called holding both the render and capture locks.
+  int GetHandleError(void* handle)
+      const override;  // Called holding both the render and capture locks.
 
-  void AllocateRenderQueue();
+  void
+  AllocateRenderQueue();  // Called holding both the render and capture locks.
 
   const AudioProcessing* apm_;
-  CriticalSectionWrapper* crit_;
+  rtc::CriticalSection* const crit_render_;
+  rtc::CriticalSection* const crit_capture_;
   const rtc::ThreadChecker* const render_thread_checker_;
   RoutingMode routing_mode_;
   bool comfort_noise_enabled_;
   unsigned char* external_echo_path_;
 
   size_t render_queue_element_max_size_;
   std::vector<int16_t> render_queue_buffer_;
   std::vector<int16_t> capture_queue_buffer_;
-  rtc::scoped_ptr<SwapQueue<std::vector<int16_t>, AecmRenderQueueItemVerifier>>
-      render_signal_queue_;
+  rtc::scoped_ptr<SwapQueue<std::vector<int16_t>, AecmRenderQueueItemVerifier> >
+      render_signal_queue_;  // Lock protection not needed.
 };
 }  // namespace webrtc
 
 #endif  // WEBRTC_MODULES_AUDIO_PROCESSING_ECHO_CONTROL_MOBILE_IMPL_H_