Make AudioOutputDevice restartable and reinitializable

media/audio/audio_output_device.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.
 //
 // Audio rendering unit utilizing audio output stream provided by browser
 // process through IPC.
 //
 // Relationship of classes.
 //
 //  AudioOutputController                AudioOutputDevice
@@ skipping 27 matching lines @@
 // state being used)
 //
 // AudioOutputDevice::Render => audio transport on audio thread =>
 //                               |
 // Stop --> ShutDownOnIOThread -------->  CloseStream -> Close
 //
 // This class utilizes several threads during its lifetime, namely:
 // 1. Creating thread.
 //    Must be the main render thread.
 // 2. Control thread (may be the main render thread or another thread).
-//    The methods: Start(), Stop(), Play(), Pause(), SetVolume()
-//    must be called on the same thread.
 // 3. IO thread (internal implementation detail - not exposed to public API)
 //    The thread within which this class receives all the IPC messages and
 //    IPC communications can only happen in this thread.
 // 4. Audio transport thread (See AudioDeviceThread).
 //    Responsible for calling the AudioThreadCallback implementation that in
 //    turn calls AudioRendererSink::RenderCallback which feeds audio samples to
 //    the audio layer in the browser process using sync sockets and shared
 //    memory.
 //
-// Implementation notes:
-// - The user must call Stop() before deleting the class instance.
+// NOTE: The user must call Stop() before deleting the class instance.
 
 #ifndef MEDIA_AUDIO_AUDIO_OUTPUT_DEVICE_H_
 #define MEDIA_AUDIO_AUDIO_OUTPUT_DEVICE_H_
 
 #include <memory>
 #include <string>
 
 #include "base/bind.h"
 #include "base/macros.h"
 #include "base/memory/shared_memory.h"
 #include "base/synchronization/waitable_event.h"
 #include "media/audio/audio_device_thread.h"
 #include "media/audio/audio_output_ipc.h"
 #include "media/audio/scoped_task_runner_observer.h"
 #include "media/base/audio_parameters.h"
 #include "media/base/audio_renderer_sink.h"
 #include "media/base/media_export.h"
 #include "media/base/output_device_info.h"
 
 namespace media {
 
 class MEDIA_EXPORT AudioOutputDevice
-    : NON_EXPORTED_BASE(public AudioRendererSink),
+    : NON_EXPORTED_BASE(public RestartableAudioRendererSink),
+      NON_EXPORTED_BASE(public AudioRendererSink::RenderCallback),
       NON_EXPORTED_BASE(public AudioOutputIPCDelegate),
       NON_EXPORTED_BASE(public ScopedTaskRunnerObserver) {
  public:
   // NOTE: Clients must call Initialize() before using.
   AudioOutputDevice(
       std::unique_ptr<AudioOutputIPC> ipc,
       const scoped_refptr<base::SingleThreadTaskRunner>& io_task_runner,
       int session_id,
       const std::string& device_id,
       const url::Origin& security_origin);
 
   // Request authorization to use the device specified in the constructor.
   void RequestDeviceAuthorization();
 
   // AudioRendererSink implementation.
   void Initialize(const AudioParameters& params,
-                  RenderCallback* callback) override;
+                  AudioRendererSink::RenderCallback* callback) override;
   void Start() override;
   void Stop() override;
   void Play() override;
   void Pause() override;
   bool SetVolume(double volume) override;
   OutputDeviceInfo GetOutputDeviceInfo() override;
 
   // Methods called on IO thread ----------------------------------------------
   // AudioOutputIPCDelegate methods.
   void OnStateChanged(AudioOutputIPCDelegateState state) override;
@@ skipping 16 matching lines @@
   enum State {
     IPC_CLOSED,       // No more IPCs can take place.
     IDLE,             // Not started.
     AUTHORIZING,      // Sent device authorization request, waiting for reply.
     AUTHORIZED,       // Successful device authorization received.
     CREATING_STREAM,  // Waiting for OnStreamCreated() to be called back.
     PAUSED,   // Paused.  OnStreamCreated() has been called.  Can Play()/Stop().
     PLAYING,  // Playing back.  Can Pause()/Stop().
   };
 
+  // media::AudioRendererSink::RenderCallback implementation.

[DaleCurtis, 2016/06/09 22:37:27]

I don't understand why you have this? Isn't this the same as
AudioOutputDevice::AudioThreadCallback::Process() ?

I'm a fan of making an OnRenderError() method, but you don't need to inherit
RenderCallback for this. The Render() method I would remove since you can do
that in ::Process() (it's only called there).

[Henrik Grunell, 2016/06/13 13:43:43]

The reason is to gate the callback here. After Stop() has returned we must
guarantee that there is no more callbacks. And to be able to serialize the
Initialize, Start and Stop, which they must be to make it restartable, the
stopping hack must go away. This makes the actual stopping of the thread
asynchronous and this is used to handle the new situation.

[DaleCurtis, 2016/06/13 18:52:32]

I'm sorry I don't understand. I don't see any reason why AudioOutputDevice needs
to implement the RenderCallback interface. You just need to protect callback_
with a lock.

+  // These two functions are called on the audio worker thread and passes calls
+  // through to |render_callback_| if it exists.
+  int Render(media::AudioBus* audio_bus,
+             uint32_t frames_delayed,
+             uint32_t frames_skipped) override;
+  void OnRenderError() override;
+
   // Methods called on IO thread ----------------------------------------------
   // The following methods are tasks posted on the IO thread that need to
   // be executed on that thread.  They use AudioOutputIPC to send IPC messages
   // upon state changes.
   void RequestDeviceAuthorizationOnIOThread();
-  void CreateStreamOnIOThread(const AudioParameters& params);
+  void InitializeOnIOThread(const AudioParameters& params);
+  void CreateStreamOnIOThread();
   void PlayOnIOThread();
   void PauseOnIOThread();
-  void ShutDownOnIOThread();
+  void StopOnIOThread();
   void SetVolumeOnIOThread(double volume);
 
   // base::MessageLoop::DestructionObserver implementation for the IO loop.
   // If the IO loop dies before we do, we shut down the audio thread from here.
   void WillDestroyCurrentMessageLoop() override;
 
   AudioParameters audio_parameters_;
 
-  RenderCallback* callback_;
+  // |callback_lock_| protects |render_callback_|. When held, only accessing
+  // |render_callback_| is allowed. In particular, no calls must be made on
+  // |audio_thread_| for the risk of deadlocks.
+  base::Lock render_callback_lock_;
+  AudioRendererSink::RenderCallback* render_callback_;
 
   // A pointer to the IPC layer that takes care of sending requests over to
   // the AudioRendererHost.  Only valid when state_ != IPC_CLOSED and must only
   // be accessed on the IO thread.
   std::unique_ptr<AudioOutputIPC> ipc_;
 
   // Current state (must only be accessed from the IO thread).  See comments for
   // State enum above.
   State state_;
 
@@ skipping 11 matching lines @@
   const std::string device_id_;
   const url::Origin security_origin_;
 
   // If |device_id_| is empty and |session_id_| is not, |matched_device_id_| is
   // received in OnDeviceAuthorized().
   std::string matched_device_id_;
 
   // Our audio thread callback class.  See source file for details.
   class AudioThreadCallback;
 
-  // In order to avoid a race between OnStreamCreated and Stop(), we use this
-  // guard to control stopping and starting the audio thread.
-  base::Lock audio_thread_lock_;
+  // The audio thread implementation.
   AudioDeviceThread audio_thread_;
-  std::unique_ptr<AudioOutputDevice::AudioThreadCallback> audio_callback_;
-
-  // Temporary hack to ignore OnStreamCreated() due to the user calling Stop()
-  // so we don't start the audio thread pointing to a potentially freed
-  // |callback_|.
-  //
-  // TODO(scherkus): Replace this by changing AudioRendererSink to either accept
-  // the callback via Start(). See http://crbug.com/151051 for details.
-  bool stopping_hack_;
+  std::unique_ptr<AudioOutputDevice::AudioThreadCallback>
+      audio_thread_callback_;
 
   base::WaitableEvent did_receive_auth_;
   AudioParameters output_params_;
   OutputDeviceStatus device_status_;
 
   DISALLOW_COPY_AND_ASSIGN(AudioOutputDevice);
 };
 
 }  // namespace media
 
 #endif  // MEDIA_AUDIO_AUDIO_OUTPUT_DEVICE_H_