Audio output debug recording.

media/audio/audio_manager.h

 // 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.
 
 #ifndef MEDIA_AUDIO_AUDIO_MANAGER_H_
 #define MEDIA_AUDIO_AUDIO_MANAGER_H_
 
 #include <memory>
 #include <string>
 
 #include "base/callback_forward.h"
+#include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
 #include "base/sequenced_task_runner_helpers.h"
 #include "base/strings/string16.h"
 #include "build/build_config.h"
 #include "media/audio/audio_device_description.h"
 #include "media/audio/audio_logging.h"
 #include "media/base/audio_parameters.h"
 
 namespace base {
+class FilePath;
 class SingleThreadTaskRunner;
 }
 
 namespace media {
 
 class AudioInputStream;
 class AudioManager;
 class AudioOutputStream;
 
 class MEDIA_EXPORT AudioManagerDeleter {
@@ skipping 19 matching lines @@
   // The manager will use |task_runner| for audio IO. This same task runner
   // is returned by GetTaskRunner().
   // On OS_MACOSX, CoreAudio requires that |task_runner| must belong to the
   // main thread of the process, which in our case is sadly the browser UI
   // thread. Failure to execute calls on the right thread leads to crashes and
   // odd behavior. See http://crbug.com/158170.
   //
   // The manager will use |worker_task_runner| for heavyweight tasks.
   // The |worker_task_runner| may be the same as |task_runner|. This same
   // task runner is returned by GetWorkerTaskRunner.
+  //
+  // |file_task_runner| is used for audio debug recordings and is the task
+  // runner to do file output operations on.
   static ScopedAudioManagerPtr Create(
       scoped_refptr<base::SingleThreadTaskRunner> task_runner,
       scoped_refptr<base::SingleThreadTaskRunner> worker_task_runner,
+      scoped_refptr<base::SingleThreadTaskRunner> file_task_runner,
       AudioLogFactory* audio_log_factory);
 
   // A convenience wrapper of AudioManager::Create for testing.
   // The given |task_runner| is shared for both audio io and heavyweight tasks.
   static ScopedAudioManagerPtr CreateForTesting(
       scoped_refptr<base::SingleThreadTaskRunner> task_runner);
 
   // Starts monitoring AudioManager task runner for hangs.
   // Runs the monitor on the given |task_runner|, which must be different from
   // AudioManager::GetTaskRunner to be meaningful.
@@ skipping 158 matching lines @@
   // an empty string. Must be called on the audio worker thread (see
   // GetTaskRunner()).
   virtual std::string GetAssociatedOutputDeviceID(
       const std::string& input_device_id) = 0;
 
   // Create a new AudioLog object for tracking the behavior for one or more
   // instances of the given component.  See AudioLogFactory for more details.
   virtual std::unique_ptr<AudioLog> CreateAudioLog(
       AudioLogFactory::AudioComponent component) = 0;
 
+  // Enable output debug recording. InitializeOutputDebugRecording() must be
+  // called before this function.
+  // TODO(grunell): Control input debug recording via these functions too.
+  virtual void EnableOutputDebugRecording(
+      const base::FilePath& base_file_name) = 0;
+
+  // Disable output debug recording.
+  virtual void DisableOutputDebugRecording() = 0;
+
   // Gets the name of the audio manager (e.g., Windows, Mac, PulseAudio).
   virtual const char* GetName() = 0;
 
   // Limits the number of streams that can be created for testing purposes.
   virtual void SetMaxStreamCountForTesting(int max_input, int max_output);
 
  protected:
+  FRIEND_TEST_ALL_PREFIXES(AudioManagerTest, AudioDebugRecording);
+
   AudioManager(scoped_refptr<base::SingleThreadTaskRunner> task_runner,
                scoped_refptr<base::SingleThreadTaskRunner> worker_task_runner);
   virtual ~AudioManager();
 
+  // Initializes output debug recording. Can be called on any thread; will post
+  // to the audio thread if not called on it.
+  virtual void InitializeOutputDebugRecording(
+      scoped_refptr<base::SingleThreadTaskRunner> file_task_runner) = 0;
+
  private:
   friend class base::DeleteHelper<AudioManager>;
   friend class AudioManagerDeleter;
 
   scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
   scoped_refptr<base::SingleThreadTaskRunner> worker_task_runner_;
   DISALLOW_COPY_AND_ASSIGN(AudioManager);
 };
 
 }  // namespace media
 
 #endif  // MEDIA_AUDIO_AUDIO_MANAGER_H_