Lock scheme #4: Introduced the render sample queue for the aec and aecm

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.
  */
 
@@ skipping 22 matching lines @@
       return 2;
     case EchoControlMobile::kSpeakerphone:
       return 3;
     case EchoControlMobile::kLoudSpeakerphone:
       return 4;
   }
   assert(false);
   return -1;
 }
 
+AudioProcessing::Error MapError(int err) {
+  switch (err) {
+    case AECM_UNSUPPORTED_FUNCTION_ERROR:
+      return AudioProcessing::kUnsupportedFunctionError;
+    case AECM_NULL_POINTER_ERROR:
+      return AudioProcessing::kNullPointerError;
+    case AECM_BAD_PARAMETER_ERROR:
+      return AudioProcessing::kBadParameterError;
+    case AECM_BAD_PARAMETER_WARNING:
+      return AudioProcessing::kBadStreamParameterWarning;
+    default:
+      // AECM_UNSPECIFIED_ERROR
+      // AECM_UNINITIALIZED_ERROR
+      return AudioProcessing::kUnspecifiedError;
+  }
+}
 }  // namespace
 
+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)
-  : ProcessingComponent(),
-    apm_(apm),
-    crit_(crit),
-    routing_mode_(kSpeakerphone),
-    comfort_noise_enabled_(true),
-    external_echo_path_(NULL) {}
+    : ProcessingComponent(),
+      apm_(apm),
+      crit_(crit),
+      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) {
       delete [] external_echo_path_;
       external_echo_path_ = NULL;
     }
 }
 
 int EchoControlMobileImpl::ProcessRenderAudio(const AudioBuffer* audio) {
   if (!is_component_enabled()) {
     return apm_->kNoError;
   }
 
   assert(audio->num_frames_per_band() <= 160);
   assert(audio->num_channels() == apm_->num_reverse_channels());
 
   int err = apm_->kNoError;
 
   // The ordering convention must be followed to pass to the correct AECM.
   size_t handle_index = 0;
+  render_queue_buffer_.resize(0);

[kwiberg-webrtc, 2015/11/05 12:20:03]

.clear()

[peah-webrtc, 2015/11/06 06:55:04]

Done.

   for (int i = 0; i < apm_->num_output_channels(); i++) {
     for (int j = 0; j < audio->num_channels(); j++) {
       Handle* my_handle = static_cast<Handle*>(handle(handle_index));
-      err = WebRtcAecm_BufferFarend(
-          my_handle,
-          audio->split_bands_const(j)[kBand0To8kHz],
+      err = WebRtcAecm_GetBufferFarendError(
+          my_handle, audio->split_bands_const(j)[kBand0To8kHz],
           audio->num_frames_per_band());
 
-      if (err != apm_->kNoError) {
-        return GetHandleError(my_handle);  // TODO(ajm): warning possible?
-      }
+      if (err != apm_->kNoError)
+        return MapError(err);  // TODO(ajm): warning possible?);
+
+      // 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_);

[hlundin-webrtc, 2015/11/05 12:45:26]

Drop (void).

[peah-webrtc, 2015/11/06 06:55:04]

I think it is needed, as the Insert is annotated with  WARN_UNUSED_RESULT. Or is
there another way to work around that?

[hlundin-webrtc, 2015/11/06 07:05:13]

Acknowledged.

+
   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;
+  }
+
+  while (render_signal_queue_->Remove(&capture_queue_buffer_)) {
+    size_t handle_index = 0;
+    int buffer_index = 0;
+    const int num_frames_per_band =
+        capture_queue_buffer_.size() /
+        (apm_->num_output_channels() * apm_->num_reverse_channels());
+    for (int i = 0; i < apm_->num_output_channels(); i++) {
+      for (int j = 0; j < apm_->num_reverse_channels(); j++) {
+        Handle* my_handle = static_cast<Handle*>(handle(handle_index));
+        (void)WebRtcAecm_BufferFarend(my_handle,
+                                      &capture_queue_buffer_[buffer_index],
+                                      num_frames_per_band);
+
+        buffer_index += num_frames_per_band;
+        handle_index++;
+      }
+    }
+  }
+}
+
 int EchoControlMobileImpl::ProcessCaptureAudio(AudioBuffer* audio) {
   if (!is_component_enabled()) {
     return apm_->kNoError;
   }
 
   if (!apm_->was_stream_delay_set()) {
     return apm_->kStreamParameterNotSetError;
   }
 
   assert(audio->num_frames_per_band() <= 160);
@@ skipping 15 matching lines @@
     for (int j = 0; j < apm_->num_reverse_channels(); j++) {
       Handle* my_handle = static_cast<Handle*>(handle(handle_index));
       err = WebRtcAecm_Process(
           my_handle,
           noisy,
           clean,
           audio->split_bands(i)[kBand0To8kHz],
           audio->num_frames_per_band(),
           apm_->stream_delay_ms());
 
-      if (err != apm_->kNoError) {
-        return GetHandleError(my_handle);  // TODO(ajm): warning possible?
-      }
+      if (err != apm_->kNoError)
+        return MapError(err);
 
       handle_index++;
     }
   }
 
   return apm_->kNoError;
 }
 
 int EchoControlMobileImpl::Enable(bool enable) {
   CriticalSectionScoped crit_scoped(crit_);
@@ skipping 62 matching lines @@
   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));
-  if (WebRtcAecm_GetEchoPath(my_handle, echo_path, size_bytes) != 0) {
-      return GetHandleError(my_handle);
-  }
+  int32_t err = WebRtcAecm_GetEchoPath(my_handle, echo_path, size_bytes);
+  if (err != 0)
+    return MapError(err);
 
   return apm_->kNoError;
 }
 
 int EchoControlMobileImpl::Initialize() {
   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;
   }
 
-  return ProcessingComponent::Initialize();
+  int err = ProcessingComponent::Initialize();
+  if (err != apm_->kNoError) {
+    return err;
+  }
+
+  AllocateRenderQueue();
+
+  return apm_->kNoError;
+}
+
+void EchoControlMobileImpl::AllocateRenderQueue() {
+  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());

[hlundin-webrtc, 2015/11/05 12:45:26]

Same question again about 1UL.

[peah-webrtc, 2015/11/06 06:55:04]

Done.

+
+  // 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 {
   return WebRtcAecm_Create();
 }
 
 void EchoControlMobileImpl::DestroyHandle(void* handle) const {
   WebRtcAecm_Free(static_cast<Handle*>(handle));
 }
 
@@ skipping 24 matching lines @@
 
 int EchoControlMobileImpl::num_handles_required() const {
   return apm_->num_output_channels() *
          apm_->num_reverse_channels();
 }
 
 int EchoControlMobileImpl::GetHandleError(void* handle) const {
   assert(handle != NULL);
   return AudioProcessing::kUnspecifiedError;
 }
+

[hlundin-webrtc, 2015/11/05 12:45:26]

Why?

[peah-webrtc, 2015/11/06 06:55:04]

Done.

 }  // namespace webrtc