Major AEC3 render pipeline changes

webrtc/modules/audio_processing/aec3/echo_canceller3.cc

 /*
  *  Copyright (c) 2016 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/aec3/echo_canceller3.h"
 
 #include <sstream>
 
 #include "webrtc/base/atomicops.h"
 #include "webrtc/modules/audio_processing/logging/apm_data_dumper.h"
 
 namespace webrtc {
 
 namespace {
 
+enum class EchoCanceller3ApiCall { kCapture, kRender };
+
 bool DetectSaturation(rtc::ArrayView<const float> y) {
   for (auto y_k : y) {
     if (y_k >= 32700.0f || y_k <= -32700.0f) {
       return true;
     }
   }
   return false;
 }
 
 void FillSubFrameView(AudioBuffer* frame,
@@ skipping 47 matching lines @@
   if (!capture_blocker->IsBlockAvailable()) {
     return;
   }
 
   capture_blocker->ExtractBlock(block);
   block_processor->ProcessCapture(level_change, saturated_microphone_signal,
                                   block);
   output_framer->InsertBlock(*block);
 }
 
-bool BufferRenderFrameContent(
+void BufferRenderFrameContent(
     std::vector<std::vector<float>>* render_frame,
     size_t sub_frame_index,
     FrameBlocker* render_blocker,
     BlockProcessor* block_processor,
     std::vector<std::vector<float>>* block,
     std::vector<rtc::ArrayView<float>>* sub_frame_view) {
   FillSubFrameView(render_frame, sub_frame_index, sub_frame_view);
   render_blocker->InsertSubFrameAndExtractBlock(*sub_frame_view, block);
-  return block_processor->BufferRender(block);
+  block_processor->BufferRender(*block);
 }
 
-bool BufferRemainingRenderFrameContent(FrameBlocker* render_blocker,
+void BufferRemainingRenderFrameContent(FrameBlocker* render_blocker,
                                        BlockProcessor* block_processor,
                                        std::vector<std::vector<float>>* block) {
   if (!render_blocker->IsBlockAvailable()) {
-    return true;
+    return;
   }
   render_blocker->ExtractBlock(block);
-  return block_processor->BufferRender(block);
+  block_processor->BufferRender(*block);
 }
 
-void CopyLowestBandIntoFrame(AudioBuffer* buffer,
-                             size_t num_bands,
-                             size_t frame_length,
-                             std::vector<std::vector<float>>* frame) {
+void CopyBufferIntoFrame(AudioBuffer* buffer,
+                         size_t num_bands,
+                         size_t frame_length,
+                         std::vector<std::vector<float>>* frame) {
   RTC_DCHECK_EQ(num_bands, frame->size());
   RTC_DCHECK_EQ(frame_length, (*frame)[0].size());
-  rtc::ArrayView<float> buffer_view(&buffer->channels_f()[0][0], frame_length);
-  std::copy(buffer_view.begin(), buffer_view.end(), (*frame)[0].begin());
+  for (size_t k = 0; k < num_bands; ++k) {
+    rtc::ArrayView<float> buffer_view(&buffer->split_bands_f(0)[k][0],
+                                      frame_length);
+    std::copy(buffer_view.begin(), buffer_view.end(), (*frame)[k].begin());
+  }
 }
 
 // [B,A] = butter(2,100/4000,'high')
 const CascadedBiQuadFilter::BiQuadCoefficients
     kHighPassFilterCoefficients_8kHz = {{0.94598f, -1.89195f, 0.94598f},
                                         {-1.88903f, 0.89487f}};
 const int kNumberOfHighPassBiQuads_8kHz = 1;
 
 // [B,A] = butter(2,100/8000,'high')
 const CascadedBiQuadFilter::BiQuadCoefficients
     kHighPassFilterCoefficients_16kHz = {{0.97261f, -1.94523f, 0.97261f},
                                          {-1.94448f, 0.94598f}};
 const int kNumberOfHighPassBiQuads_16kHz = 1;
 
-static constexpr size_t kRenderTransferQueueSize = 30;
-
 }  // namespace
 
 class EchoCanceller3::RenderWriter {
  public:
   RenderWriter(ApmDataDumper* data_dumper,
                SwapQueue<std::vector<std::vector<float>>,
                          Aec3RenderQueueItemVerifier>* render_transfer_queue,
                std::unique_ptr<CascadedBiQuadFilter> render_highpass_filter,
                int sample_rate_hz,
                int frame_length,
                int num_bands);
   ~RenderWriter();
-  bool Insert(AudioBuffer* render);
+  void Insert(AudioBuffer* render);
 
  private:
   ApmDataDumper* data_dumper_;
   const int sample_rate_hz_;
   const size_t frame_length_;
   const int num_bands_;
   std::unique_ptr<CascadedBiQuadFilter> render_highpass_filter_;
   std::vector<std::vector<float>> render_queue_input_frame_;
   SwapQueue<std::vector<std::vector<float>>, Aec3RenderQueueItemVerifier>*
       render_transfer_queue_;
@@ skipping 14 matching lines @@
       num_bands_(num_bands),
       render_highpass_filter_(std::move(render_highpass_filter)),
       render_queue_input_frame_(num_bands_,
                                 std::vector<float>(frame_length_, 0.f)),
       render_transfer_queue_(render_transfer_queue) {
   RTC_DCHECK(data_dumper);
 }
 
 EchoCanceller3::RenderWriter::~RenderWriter() = default;
 
-bool EchoCanceller3::RenderWriter::Insert(AudioBuffer* input) {
+void EchoCanceller3::RenderWriter::Insert(AudioBuffer* input) {
   RTC_DCHECK_EQ(1, input->num_channels());
   RTC_DCHECK_EQ(frame_length_, input->num_frames_per_band());
   data_dumper_->DumpWav("aec3_render_input", frame_length_,
-                        &input->channels_f()[0][0],
+                        &input->split_bands_f(0)[0][0],
                         LowestBandRate(sample_rate_hz_), 1);
 
-  CopyLowestBandIntoFrame(input, num_bands_, frame_length_,
-                          &render_queue_input_frame_);
+  CopyBufferIntoFrame(input, num_bands_, frame_length_,
+                      &render_queue_input_frame_);
 
   if (render_highpass_filter_) {
     render_highpass_filter_->Process(render_queue_input_frame_[0]);
   }
 
-  return render_transfer_queue_->Insert(&render_queue_input_frame_);
+  // TODO(peah): Change this two-step static cast once the CL for handling the
+  // bug causing this to fail in cc has landed.
+  bool result = render_transfer_queue_->Insert(&render_queue_input_frame_);
+  static_cast<void>(result);
 }
 
 int EchoCanceller3::instance_count_ = 0;
 
 EchoCanceller3::EchoCanceller3(int sample_rate_hz, bool use_highpass_filter)
     : EchoCanceller3(sample_rate_hz,
                      use_highpass_filter,
                      std::unique_ptr<BlockProcessor>(
                          BlockProcessor::Create(sample_rate_hz))) {}
 EchoCanceller3::EchoCanceller3(int sample_rate_hz,
@@ skipping 38 matching lines @@
       new RenderWriter(data_dumper_.get(), &render_transfer_queue_,
                        std::move(render_highpass_filter), sample_rate_hz_,
                        frame_length_, num_bands_));
 
   RTC_DCHECK_EQ(num_bands_, std::max(sample_rate_hz_, 16000) / 16000);
   RTC_DCHECK_GE(kMaxNumBands, num_bands_);
 }
 
 EchoCanceller3::~EchoCanceller3() = default;
 
-bool EchoCanceller3::AnalyzeRender(AudioBuffer* render) {
+void EchoCanceller3::AnalyzeRender(AudioBuffer* render) {
   RTC_DCHECK_RUNS_SERIALIZED(&render_race_checker_);
   RTC_DCHECK(render);
+  data_dumper_->DumpRaw("aec3_call_order",
+                        static_cast<int>(EchoCanceller3ApiCall::kRender));
+
   return render_writer_->Insert(render);
 }
 
 void EchoCanceller3::AnalyzeCapture(AudioBuffer* capture) {
   RTC_DCHECK_RUNS_SERIALIZED(&capture_race_checker_);
   RTC_DCHECK(capture);
   data_dumper_->DumpWav("aec3_capture_analyze_input", capture->num_frames(),
                         capture->channels_f()[0], sample_rate_hz_, 1);
 
   saturated_microphone_signal_ = false;
   for (size_t k = 0; k < capture->num_channels(); ++k) {
     saturated_microphone_signal_ |=
         DetectSaturation(rtc::ArrayView<const float>(capture->channels_f()[k],
                                                      capture->num_frames()));
     if (saturated_microphone_signal_) {
       break;
     }
   }
 }
 
 void EchoCanceller3::ProcessCapture(AudioBuffer* capture, bool level_change) {
   RTC_DCHECK_RUNS_SERIALIZED(&capture_race_checker_);
   RTC_DCHECK(capture);
   RTC_DCHECK_EQ(1u, capture->num_channels());
   RTC_DCHECK_EQ(num_bands_, capture->num_bands());
   RTC_DCHECK_EQ(frame_length_, capture->num_frames_per_band());
+  data_dumper_->DumpRaw("aec3_call_order",
+                        static_cast<int>(EchoCanceller3ApiCall::kCapture));
 
   rtc::ArrayView<float> capture_lower_band =
       rtc::ArrayView<float>(&capture->split_bands_f(0)[0][0], frame_length_);
 
   data_dumper_->DumpWav("aec3_capture_input", capture_lower_band,
                         LowestBandRate(sample_rate_hz_), 1);
 
-  const bool successful_buffering = EmptyRenderQueue();
-  RTC_DCHECK(successful_buffering);
+  EmptyRenderQueue();
 
   if (capture_highpass_filter_) {
     capture_highpass_filter_->Process(capture_lower_band);
   }
 
   ProcessCaptureFrameContent(
       capture, level_change, saturated_microphone_signal_, 0, &capture_blocker_,
       &output_framer_, block_processor_.get(), &block_, &sub_frame_view_);
 
   if (sample_rate_hz_ != 8000) {
@@ skipping 18 matching lines @@
   ss << "{"
      << "enabled: " << (config.enabled ? "true" : "false") << "}";
   return ss.str();
 }
 
 bool EchoCanceller3::Validate(
     const AudioProcessing::Config::EchoCanceller3& config) {
   return true;
 }
 
-bool EchoCanceller3::EmptyRenderQueue() {
+void EchoCanceller3::EmptyRenderQueue() {
   RTC_DCHECK_RUNS_SERIALIZED(&capture_race_checker_);
-  bool successful_buffering = true;
   bool frame_to_buffer =
       render_transfer_queue_.Remove(&render_queue_output_frame_);
   while (frame_to_buffer) {
-    successful_buffering =
-        BufferRenderFrameContent(&render_queue_output_frame_, 0,
-                                 &render_blocker_, block_processor_.get(),
-                                 &block_, &sub_frame_view_) &&
-        successful_buffering;
+    BufferRenderFrameContent(&render_queue_output_frame_, 0, &render_blocker_,
+                             block_processor_.get(), &block_, &sub_frame_view_);
 
     if (sample_rate_hz_ != 8000) {
-      successful_buffering =
-          BufferRenderFrameContent(&render_queue_output_frame_, 1,
-                                   &render_blocker_, block_processor_.get(),
-                                   &block_, &sub_frame_view_) &&
-          successful_buffering;
+      BufferRenderFrameContent(&render_queue_output_frame_, 1, &render_blocker_,
+                               block_processor_.get(), &block_,
+                               &sub_frame_view_);
     }
 
-    successful_buffering =
-        BufferRemainingRenderFrameContent(&render_blocker_,
-                                          block_processor_.get(), &block_) &&
-        successful_buffering;
+    BufferRemainingRenderFrameContent(&render_blocker_, block_processor_.get(),
+                                      &block_);
 
     frame_to_buffer =
         render_transfer_queue_.Remove(&render_queue_output_frame_);
   }
-  return successful_buffering;
 }
 
 }  // namespace webrtc