Audio input debug recording refactoring to reduce thread hops and simplify object ownership

media/audio/audio_input_controller.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_INPUT_CONTROLLER_H_
 #define MEDIA_AUDIO_AUDIO_INPUT_CONTROLLER_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
@@ skipping 167 matching lines @@
   // The audio device will be created on the audio thread, and when that is
   // done, the event handler will receive an OnCreated() call from that same
   // thread. |user_input_monitor| is used for typing detection and can be NULL.
   static scoped_refptr<AudioInputController> CreateLowLatency(
       AudioManager* audio_manager,
       EventHandler* event_handler,
       const AudioParameters& params,
       const std::string& device_id,
       // External synchronous writer for audio controller.
       SyncWriter* sync_writer,
+      std::unique_ptr<AudioInputWriter> debug_writer,

[Henrik Grunell, 2016/10/13 07:26:11]

It seems unnecessary to always pass a debug writer. Could it be created and
passed when enabling as before?

       UserInputMonitor* user_input_monitor,
       const bool agc_is_enabled);
 
   // Factory method for creating an AudioInputController with an existing
   // |stream| for low-latency mode, taking ownership of |stream|. The stream
   // will be opened on the audio thread, and when that is done, the event
   // handler will receive an OnCreated() call from that same thread.
   // |user_input_monitor| is used for typing detection and can be NULL.
   static scoped_refptr<AudioInputController> CreateForStream(
       const scoped_refptr<base::SingleThreadTaskRunner>& task_runner,
       EventHandler* event_handler,
       AudioInputStream* stream,
       // External synchronous writer for audio controller.
       SyncWriter* sync_writer,
+      std::unique_ptr<AudioInputWriter> debug_writer,
       UserInputMonitor* user_input_monitor);
 
   // Starts recording using the created audio input stream.
   // This method is called on the creator thread.
   virtual void Record();
 
   // Closes the audio input stream. The state is changed and the resources
   // are freed on the audio thread. |closed_task| is then executed on the thread
   // that called Close().
   // Callbacks (EventHandler and SyncWriter) must exist until |closed_task|
@@ skipping 11 matching lines @@
   // device-specific implementation.
   void OnData(AudioInputStream* stream,
               const AudioBus* source,
               uint32_t hardware_delay_bytes,
               double volume) override;
   void OnError(AudioInputStream* stream) override;
 
   bool SharedMemoryAndSyncSocketMode() const { return sync_writer_ != NULL; }
 
   // Enable debug recording of audio input.
-  void EnableDebugRecording(AudioInputWriter* input_writer);
+  void EnableDebugRecording(const base::FilePath& file_name);
 
-  // Disbale debug recording of audio input. Must be called before owner of
-  // |input_writer| deletes it.
-  void DisableDebugRecording(const base::Closure& callback);
+  // Disable debug recording of audio input.
+  void DisableDebugRecording();
 
  protected:
   friend class base::RefCountedThreadSafe<AudioInputController>;
 
   // Used to log the result of capture startup.
   // This was previously logged as a boolean with only the no callback and OK
   // options. The enum order is kept to ensure backwards compatibility.
   // Elements in this enum should not be deleted or rearranged; the only
   // permitted operation is to add new elements before
   // CAPTURE_STARTUP_RESULT_MAX and update CAPTURE_STARTUP_RESULT_MAX.
@@ skipping 33 matching lines @@
     SILENCE_STATE_NO_MEASUREMENT = 0,
     SILENCE_STATE_ONLY_AUDIO = 1,
     SILENCE_STATE_ONLY_SILENCE = 2,
     SILENCE_STATE_AUDIO_AND_SILENCE = 3,
     SILENCE_STATE_MAX = SILENCE_STATE_AUDIO_AND_SILENCE
   };
 #endif
 
   AudioInputController(EventHandler* handler,
                        SyncWriter* sync_writer,
+                       std::unique_ptr<AudioInputWriter> debug_writer,
                        UserInputMonitor* user_input_monitor,
                        const bool agc_is_enabled);
   ~AudioInputController() override;
 
   // Methods called on the audio thread (owned by the AudioManager).
   void DoCreate(AudioManager* audio_manager,
                 const AudioParameters& params,
                 const std::string& device_id);
   void DoCreateForLowLatency(AudioManager* audio_manager,
                              const AudioParameters& params,
@@ skipping 17 matching lines @@
   // Logs the silence state as UMA stat.
   void LogSilenceState(SilenceState value);
 #endif
 
   // Logs the result of creating an AudioInputController.
   // Only logs once, even if it is called several times.
   void LogCaptureStartupResult(CaptureStartupResult result);
 
   // Enable and disable debug recording of audio input. Called on the audio
   // thread.
-  void DoEnableDebugRecording(AudioInputWriter* input_writer);
+  void DoEnableDebugRecording(const base::FilePath& file_name);
   void DoDisableDebugRecording();
 
   // Called on the audio thread.
   void WriteInputDataForDebugging(std::unique_ptr<AudioBus> data);
 
   // Called by the stream with log messages.
   void LogMessage(const std::string& message);
 
   // Gives access to the task runner of the creating thread.
   scoped_refptr<base::SingleThreadTaskRunner> creator_task_runner_;
@@ skipping 44 matching lines @@
   // The silence report sent as UMA stat at the end of a session.
   SilenceState silence_state_;
 #endif
 
   size_t prev_key_down_count_;
 
   // Time when a low-latency stream is created.
   base::TimeTicks low_latency_create_time_;
 
   // Used for audio debug recordings. Accessed on audio thread.
-  AudioInputWriter* input_writer_;
+  const std::unique_ptr<AudioInputWriter> debug_writer_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(AudioInputController);
 };
 
 }  // namespace media
 
 #endif  // MEDIA_AUDIO_AUDIO_INPUT_CONTROLLER_H_