Move audio frame memory handling inside AudioMixer.

webrtc/modules/audio_mixer/audio_mixer_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_mixer/audio_mixer_impl.h"
 
 #include <algorithm>
 #include <functional>
 #include <utility>
 
 #include "webrtc/base/logging.h"
 #include "webrtc/modules/audio_mixer/audio_frame_manipulator.h"
 #include "webrtc/modules/utility/include/audio_frame_operations.h"
 
 namespace webrtc {
 namespace {
 
 struct SourceFrame {
-  SourceFrame(AudioMixerImpl::SourceStatus* source_status,
+  SourceFrame(AudioMixerImpl::SourceStatusWithFrame* source_status_with_frame,
               AudioFrame* audio_frame,
               bool muted)
-      : source_status(source_status), audio_frame(audio_frame), muted(muted) {
-    RTC_DCHECK(source_status);
+      : source_status_with_frame(source_status_with_frame),
+        audio_frame(audio_frame),
+        muted(muted) {
+    RTC_DCHECK(source_status_with_frame);
     RTC_DCHECK(audio_frame);
     if (!muted) {
       energy = AudioMixerCalculateEnergy(*audio_frame);
     }
   }
 
-  SourceFrame(AudioMixerImpl::SourceStatus* source_status,
+  SourceFrame(AudioMixerImpl::SourceStatusWithFrame* source_status_with_frame,
               AudioFrame* audio_frame,
               bool muted,
               uint32_t energy)
-      : source_status(source_status),
+      : source_status_with_frame(source_status_with_frame),
         audio_frame(audio_frame),
         muted(muted),
         energy(energy) {
-    RTC_DCHECK(source_status);
+    RTC_DCHECK(source_status_with_frame);
     RTC_DCHECK(audio_frame);
   }
 
-  AudioMixerImpl::SourceStatus* source_status = nullptr;
+  AudioMixerImpl::SourceStatusWithFrame* source_status_with_frame = nullptr;
   AudioFrame* audio_frame = nullptr;
   bool muted = true;
   uint32_t energy = 0;
 };
 
 // ShouldMixBefore(a, b) is used to select mixer sources.
 bool ShouldMixBefore(const SourceFrame& a, const SourceFrame& b) {
   if (a.muted != b.muted) {
     return b.muted;
   }
 
   const auto a_activity = a.audio_frame->vad_activity_;
   const auto b_activity = b.audio_frame->vad_activity_;
 
   if (a_activity != b_activity) {
     return a_activity == AudioFrame::kVadActive;
   }
 
   return a.energy > b.energy;
 }
 
 void RampAndUpdateGain(
     const std::vector<SourceFrame>& mixed_sources_and_frames) {
   for (const auto& source_frame : mixed_sources_and_frames) {
-    float target_gain = source_frame.source_status->is_mixed ? 1.0f : 0.0f;
-    Ramp(source_frame.source_status->gain, target_gain,
+    float target_gain =
+        source_frame.source_status_with_frame->is_mixed ? 1.0f : 0.0f;
+    Ramp(source_frame.source_status_with_frame->gain, target_gain,
          source_frame.audio_frame);
-    source_frame.source_status->gain = target_gain;
+    source_frame.source_status_with_frame->gain = target_gain;
   }
 }
 
 // Mix the AudioFrames stored in audioFrameList into mixed_audio.
 int32_t MixFromList(AudioFrame* mixed_audio,
                     const AudioFrameList& audio_frame_list,
                     bool use_limiter) {
   if (audio_frame_list.empty()) {
     return 0;
   }
@@ skipping 22 matching lines @@
       // Divide by two to avoid saturation in the mixing.
       // This is only meaningful if the limiter will be used.
       *frame >>= 1;
     }
     RTC_DCHECK_EQ(frame->num_channels_, mixed_audio->num_channels_);
     *mixed_audio += *frame;
   }
   return 0;
 }
 
-AudioMixerImpl::SourceStatusList::const_iterator FindSourceInList(
+AudioMixerImpl::SourceStatusWithFrameList::const_iterator FindSourceInList(
     AudioMixerImpl::Source const* audio_source,
-    AudioMixerImpl::SourceStatusList const* audio_source_list) {
-  return std::find_if(audio_source_list->begin(), audio_source_list->end(),
-                      [audio_source](const AudioMixerImpl::SourceStatus& p) {
-                        return p.audio_source == audio_source;
-                      });
+    AudioMixerImpl::SourceStatusWithFrameList const* audio_source_list) {
+  return std::find_if(
+      audio_source_list->begin(), audio_source_list->end(),
+      [audio_source](
+          const std::unique_ptr<AudioMixerImpl::SourceStatusWithFrame>& p) {
+        return p->audio_source == audio_source;
+      });
 }
 
 // TODO(aleloi): remove non-const version when WEBRTC only supports modern STL.
-AudioMixerImpl::SourceStatusList::iterator FindSourceInList(
+AudioMixerImpl::SourceStatusWithFrameList::iterator FindSourceInList(
     AudioMixerImpl::Source const* audio_source,
-    AudioMixerImpl::SourceStatusList* audio_source_list) {
-  return std::find_if(audio_source_list->begin(), audio_source_list->end(),
-                      [audio_source](const AudioMixerImpl::SourceStatus& p) {
-                        return p.audio_source == audio_source;
-                      });
+    AudioMixerImpl::SourceStatusWithFrameList* audio_source_list) {
+  return std::find_if(
+      audio_source_list->begin(), audio_source_list->end(),
+      [audio_source](
+          const std::unique_ptr<AudioMixerImpl::SourceStatusWithFrame>& p) {
+        return p->audio_source == audio_source;
+      });
 }
 
 }  // namespace
 
 AudioMixerImpl::AudioMixerImpl(std::unique_ptr<AudioProcessing> limiter)
     : audio_source_list_(),
       use_limiter_(true),
       time_stamp_(0),
       limiter_(std::move(limiter)) {
   SetOutputFrequency(kDefaultFrequency);
@@ skipping 92 matching lines @@
   RTC_DCHECK_RUN_ON(&thread_checker_);
   return output_frequency_;
 }
 
 bool AudioMixerImpl::AddSource(Source* audio_source) {
   RTC_DCHECK(audio_source);
   rtc::CritScope lock(&crit_);
   RTC_DCHECK(FindSourceInList(audio_source, &audio_source_list_) ==
              audio_source_list_.end())
       << "Source already added to mixer";
-  audio_source_list_.emplace_back(audio_source, false, 0);
+  audio_source_list_.emplace_back(
+      new SourceStatusWithFrame(audio_source, false, 0));
   return true;
 }
 
 bool AudioMixerImpl::RemoveSource(Source* audio_source) {
   RTC_DCHECK(audio_source);
   rtc::CritScope lock(&crit_);
   const auto iter = FindSourceInList(audio_source, &audio_source_list_);
   RTC_DCHECK(iter != audio_source_list_.end()) << "Source not present in mixer";
   audio_source_list_.erase(iter);
   return true;
 }
 
 AudioFrameList AudioMixerImpl::GetAudioFromSources() {
   RTC_DCHECK_RUN_ON(&thread_checker_);
   AudioFrameList result;
   std::vector<SourceFrame> audio_source_mixing_data_list;
   std::vector<SourceFrame> ramp_list;
 
-  // Get audio source audio and put it in the struct vector.
+  // Get audio from the audio sources and put it in the SourceFrame vector.

[aleloi, 2016/10/14 15:34:44]

This comment doesn't have to do anything with the rest of the CL. I thought it
was confusing.

[kwiberg-webrtc, 2016/10/14 19:59:32]

Acknowledged.

   for (auto& source_and_status : audio_source_list_) {
-    auto audio_frame_with_info =
-        source_and_status.audio_source->GetAudioFrameWithInfo(
-            static_cast<int>(OutputFrequency()));
-
-    const auto audio_frame_info = audio_frame_with_info.audio_frame_info;
-    AudioFrame* audio_source_audio_frame = audio_frame_with_info.audio_frame;
+    AudioFrame* const audio_source_audio_frame =
+        &source_and_status->audio_frame;
+    const auto audio_frame_info =
+        source_and_status->audio_source->GetAudioFrameWithInfo(
+            OutputFrequency(), audio_source_audio_frame);
 
     if (audio_frame_info == Source::AudioFrameInfo::kError) {
       LOG_F(LS_WARNING) << "failed to GetAudioFrameWithInfo() from source";
       continue;
     }
     audio_source_mixing_data_list.emplace_back(
-        &source_and_status, audio_source_audio_frame,
+        // Using get() is OK here, since audio_source_mixing_data_list is
+        // local and no SourceStatus pointers leak outside of
+        // this method (they are passed to Ramp, but are not leaked
+        // from there)
+        source_and_status.get(), audio_source_audio_frame,
         audio_frame_info == Source::AudioFrameInfo::kMuted);
   }
 
   // Sort frames by sorting function.
   std::sort(audio_source_mixing_data_list.begin(),
             audio_source_mixing_data_list.end(), ShouldMixBefore);
 
   int max_audio_frame_counter = kMaximumAmountOfMixedAudioSources;
 
   // Go through list in order and put unmuted frames in result list.
   for (const auto& p : audio_source_mixing_data_list) {
     // Filter muted.
     if (p.muted) {
-      p.source_status->is_mixed = false;
+      p.source_status_with_frame->is_mixed = false;
       continue;
     }
 
     // Add frame to result vector for mixing.
     bool is_mixed = false;
     if (max_audio_frame_counter > 0) {
       --max_audio_frame_counter;
       result.push_back(p.audio_frame);
-      ramp_list.emplace_back(p.source_status, p.audio_frame, false, -1);
+      ramp_list.emplace_back(p.source_status_with_frame, p.audio_frame, false,
+                             -1);
       is_mixed = true;
     }
-    p.source_status->is_mixed = is_mixed;
+    p.source_status_with_frame->is_mixed = is_mixed;
   }
   RampAndUpdateGain(ramp_list);
   return result;
 }
 
 
 bool AudioMixerImpl::LimitMixedAudio(AudioFrame* mixed_audio) const {
   RTC_DCHECK_RUN_ON(&thread_checker_);
   if (!use_limiter_) {
     return true;
@@ skipping 23 matching lines @@
 }
 
 bool AudioMixerImpl::GetAudioSourceMixabilityStatusForTest(
     AudioMixerImpl::Source* audio_source) const {
   RTC_DCHECK_RUN_ON(&thread_checker_);
   rtc::CritScope lock(&crit_);
 
   const auto non_anonymous_iter =
       FindSourceInList(audio_source, &audio_source_list_);
   if (non_anonymous_iter != audio_source_list_.end()) {
-    return non_anonymous_iter->is_mixed;
+    return (*non_anonymous_iter)->is_mixed;
   }
 
   LOG(LS_ERROR) << "Audio source unknown";
   return false;
 }
 }  // namespace webrtc