Audio output debug recording.

media/audio/audio_output_resampler.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "media/audio/audio_output_resampler.h"
 
 #include <stdint.h>
 
 #include <algorithm>
 #include <string>
@@ skipping 15 matching lines @@
 #include "media/base/audio_timestamp_helper.h"
 #include "media/base/limits.h"
 
 namespace media {
 
 class OnMoreDataConverter
     : public AudioOutputStream::AudioSourceCallback,
       public AudioConverter::InputCallback {
  public:
   OnMoreDataConverter(const AudioParameters& input_params,
-                      const AudioParameters& output_params);
+                      const AudioParameters& output_params,
+                      std::unique_ptr<AudioDebugRecorder> debug_recorder);
   ~OnMoreDataConverter() override;
 
   // AudioSourceCallback interface.
   int OnMoreData(base::TimeDelta delay,
                  base::TimeTicks delay_timestamp,
                  int prior_frames_skipped,
                  AudioBus* dest) override;
   void OnError(AudioOutputStream* stream) override;
 
   // Sets |source_callback_|.  If this is not a new object, then Stop() must be
   // called before Start().
   void Start(AudioOutputStream::AudioSourceCallback* callback);
 
   // Clears |source_callback_| and flushes the resampler.
   void Stop();
 
   bool started() const { return source_callback_ != nullptr; }
 
   bool error_occurred() const { return error_occurred_; }
 
+  const AudioParameters& output_params() const { return output_params_; }
+
  private:
   // AudioConverter::InputCallback implementation.
   double ProvideInput(AudioBus* audio_bus, uint32_t frames_delayed) override;
 
   // Ratio of input bytes to output bytes used to correct playback delay with
   // regard to buffering and resampling.
   const double io_ratio_;
 
   // Source callback.
   AudioOutputStream::AudioSourceCallback* source_callback_;
 
   // Last |delay| and |delay_timestamp| received via OnMoreData(). Used to
   // correct playback delay in ProvideInput() before calling |source_callback_|.
   base::TimeDelta current_delay_;
   base::TimeTicks current_delay_timestamp_;
 
   const int input_samples_per_second_;
 
   // Handles resampling, buffering, and channel mixing between input and output
   // parameters.
   AudioConverter audio_converter_;
 
   // True if OnError() was ever called.  Should only be read if the underlying
   // stream has been stopped.
   bool error_occurred_;
 
-  // Information about input and output buffer sizes to be traced.
+  // Information about input buffer sizes to be traced.
   const int input_buffer_size_;
-  const int output_buffer_size_;
+
+  // Output parameters used for buffer size tracing and for users to get.
+  const AudioParameters output_params_;
+
+  // For audio debug recordings.
+  std::unique_ptr<AudioDebugRecorder> debug_recorder_;
 
   DISALLOW_COPY_AND_ASSIGN(OnMoreDataConverter);
 };
 
 // Record UMA statistics for hardware output configuration.
 static void RecordStats(const AudioParameters& output_params) {
   // Note the 'PRESUBMIT_IGNORE_UMA_MAX's below, these silence the PRESUBMIT.py
   // check for uma enum max usage, since we're abusing UMA_HISTOGRAM_ENUMERATION
   // to report a discrete value.
   UMA_HISTOGRAM_ENUMERATION(
@@ skipping 112 matching lines @@
 
   output_params_ = AudioParameters(
       AudioParameters::AUDIO_PCM_LINEAR, params_.channel_layout(),
       params_.sample_rate(), params_.bits_per_sample(),
       frames_per_buffer);
   device_id_ = "";
   Initialize();
 #endif
 }
 
-AudioOutputResampler::AudioOutputResampler(AudioManager* audio_manager,
-                                           const AudioParameters& input_params,
-                                           const AudioParameters& output_params,
-                                           const std::string& output_device_id,
-                                           const base::TimeDelta& close_delay)
+AudioOutputResampler::AudioOutputResampler(
+    AudioManager* audio_manager,
+    const AudioParameters& input_params,
+    const AudioParameters& output_params,
+    const std::string& output_device_id,
+    base::TimeDelta close_delay,
+    const RegisterDebugRecordingSourceCallback&
+        register_debug_recording_source_callback)
     : AudioOutputDispatcher(audio_manager, input_params, output_device_id),
       close_delay_(close_delay),
       output_params_(output_params),
       original_output_params_(output_params),
       streams_opened_(false),
       reinitialize_timer_(FROM_HERE,
                           close_delay_,
                           base::Bind(&AudioOutputResampler::Reinitialize,
                                      base::Unretained(this)),
                           false),
+      register_debug_recording_source_callback_(
+          register_debug_recording_source_callback),
       weak_factory_(this) {
   DCHECK(input_params.IsValid());
   DCHECK(output_params.IsValid());
   DCHECK_EQ(output_params_.format(), AudioParameters::AUDIO_PCM_LOW_LATENCY);
 
   // Record UMA statistics for the hardware configuration.
   RecordStats(output_params);
 
   Initialize();
 }
@@ skipping 91 matching lines @@
 }
 
 bool AudioOutputResampler::StartStream(
     AudioOutputStream::AudioSourceCallback* callback,
     AudioOutputProxy* stream_proxy) {
   DCHECK(task_runner_->BelongsToCurrentThread());
 
   OnMoreDataConverter* resampler_callback = nullptr;
   CallbackMap::iterator it = callbacks_.find(stream_proxy);
   if (it == callbacks_.end()) {
-    resampler_callback = new OnMoreDataConverter(params_, output_params_);
+    std::unique_ptr<AudioDebugRecorder> debug_recorder =
+        register_debug_recording_source_callback_.Run(output_params_);
+    resampler_callback = new OnMoreDataConverter(params_, output_params_,
+                                                 std::move(debug_recorder));
     callbacks_[stream_proxy] =
         base::WrapUnique<OnMoreDataConverter>(resampler_callback);
   } else {
     resampler_callback = it->second.get();
   }
 
   resampler_callback->Start(callback);
   bool result = dispatcher_->StartStream(resampler_callback, stream_proxy);
   if (!result)
     resampler_callback->Stop();
@@ skipping 44 matching lines @@
   // Now that StopStream() has completed the underlying physical stream should
   // be stopped and no longer calling OnMoreData(), making it safe to Stop() the
   // OnMoreDataConverter.
   callback->Stop();
 
   // Destroy idle streams if any errors occurred during output; this ensures
   // bad streams will not be reused.  Note: Errors may occur during the Stop()
   // call above.
   if (callback->error_occurred())
     dispatcher_->CloseAllIdleStreams();
+
+  // TODO BEFORE COMMIT: I think we need to clear the recorder wrapper here and
+  // register again at start. Seems like converters are re-used.

[o1ka, 2017/01/31 11:00:11]

Please figure this out. Now we register recording on each start, but never
unregister it. 

[Henrik Grunell, 2017/02/08 11:29:38]

I've looked into this now. We should unregister when closing stream as done now
(when the converter is destroyed) because Start() and Stop() is used to pause
and restart a stream. I think the semantics makes sense too; a stream is
connected to a recorder. As long as a stream is alive, the data going through it
is fed to the recorder. Wdyt?

 }
 
-OnMoreDataConverter::OnMoreDataConverter(const AudioParameters& input_params,
-                                         const AudioParameters& output_params)
+OnMoreDataConverter::OnMoreDataConverter(
+    const AudioParameters& input_params,
+    const AudioParameters& output_params,
+    std::unique_ptr<AudioDebugRecorder> debug_recorder)
     : io_ratio_(static_cast<double>(input_params.GetBytesPerSecond()) /
                 output_params.GetBytesPerSecond()),
       source_callback_(nullptr),
       input_samples_per_second_(input_params.sample_rate()),
       audio_converter_(input_params, output_params, false),
       error_occurred_(false),
       input_buffer_size_(input_params.frames_per_buffer()),
-      output_buffer_size_(output_params.frames_per_buffer()) {
+      output_params_(output_params),
+      debug_recorder_(std::move(debug_recorder)) {
   RecordRebufferingStats(input_params, output_params);
 }
 
 OnMoreDataConverter::~OnMoreDataConverter() {
   // Ensure Stop() has been called so we don't end up with an AudioOutputStream
   // calling back into OnMoreData() after destruction.
   CHECK(!source_callback_);
 }
 
 void OnMoreDataConverter::Start(
@@ skipping 11 matching lines @@
   CHECK(source_callback_);
   source_callback_ = nullptr;
   audio_converter_.RemoveInput(this);
 }
 
 int OnMoreDataConverter::OnMoreData(base::TimeDelta delay,
                                     base::TimeTicks delay_timestamp,
                                     int /* prior_frames_skipped */,
                                     AudioBus* dest) {
   TRACE_EVENT2("audio", "OnMoreDataConverter::OnMoreData", "input buffer size",
-               input_buffer_size_, "output buffer size", output_buffer_size_);
+               input_buffer_size_, "output buffer size",
+               output_params_.frames_per_buffer());
   current_delay_ = delay;
   current_delay_timestamp_ = delay_timestamp;
   audio_converter_.Convert(dest);
 
+  if (debug_recorder_)

[o1ka, 2017/01/31 11:00:11]

If you are going to unregistered in Stop, there may be a race here.

[Henrik Grunell, 2017/02/08 11:29:38]

See above comment - won't unregister in Stop().

+    debug_recorder_->OnData(dest);
+
   // Always return the full number of frames requested, ProvideInput()
   // will pad with silence if it wasn't able to acquire enough data.
   return dest->frames();
 }
 
 double OnMoreDataConverter::ProvideInput(AudioBus* dest,
                                          uint32_t frames_delayed) {
   base::TimeDelta new_delay =
       current_delay_ + AudioTimestampHelper::FramesToTime(
                            frames_delayed, input_samples_per_second_);
   // Retrieve data from the original callback.
   const int frames = source_callback_->OnMoreData(
       new_delay, current_delay_timestamp_, 0, dest);
 
   // Zero any unfilled frames if anything was filled, otherwise we'll just
   // return a volume of zero and let AudioConverter drop the output.
   if (frames > 0 && frames < dest->frames())
     dest->ZeroFramesPartial(frames, dest->frames() - frames);
   return frames > 0 ? 1 : 0;
 }
 
 void OnMoreDataConverter::OnError(AudioOutputStream* stream) {
   error_occurred_ = true;
   source_callback_->OnError(stream);
 }
 
 }  // namespace media