Switch stream creation and closing in Chrome audio rendering from IPC to Mojo

content/browser/renderer_host/media/audio_renderer_host.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.
 //
 // AudioRendererHost serves audio related requests from AudioRenderer which
 // lives inside the render process and provide access to audio hardware.
 //
 // This class is owned by RenderProcessHostImpl, and instantiated on UI
 // thread, but all other operations and method calls happen on IO thread, so we
 // need to be extra careful about the lifetime of this object. AudioManager is a
@@ skipping 33 matching lines @@
 
 #include <map>
 #include <memory>
 #include <string>
 #include <utility>
 
 #include "base/atomic_ref_count.h"
 #include "base/gtest_prod_util.h"
 #include "base/macros.h"
 #include "base/memory/ref_counted.h"
+#include "base/memory/shared_memory.h"
 #include "base/process/process.h"
 #include "base/sequenced_task_runner_helpers.h"
 #include "content/browser/renderer_host/media/audio_output_device_enumerator.h"
 #include "content/common/content_export.h"
 #include "content/public/browser/browser_message_filter.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/resource_context.h"
 #include "media/audio/audio_io.h"
 #include "media/audio/audio_logging.h"
 #include "media/audio/audio_output_controller.h"
 #include "media/audio/simple_sources.h"
+#include "media/mojo/interfaces/audio_output.mojom.h"
 #include "url/origin.h"
 
 namespace media {
 class AudioManager;
 class AudioParameters;
 }
 
 namespace content {
 
 class AudioMirroringManager;
+class AudioOutputImpl;
+class AudioOutputStreamImpl;
 class MediaInternals;
 class MediaStreamManager;
 class MediaStreamUIProxy;
 class ResourceContext;
 
 class CONTENT_EXPORT AudioRendererHost : public BrowserMessageFilter {
  public:
   // Called from UI thread from the owner of this object.
   AudioRendererHost(int render_process_id,
                     media::AudioManager* audio_manager,
@@ skipping 14 matching lines @@
 
   // Returns true if any streams managed by this host are actively playing.  Can
   // be called from any thread.
   bool HasActiveAudio();
 
   // Returns true if any streams managed by the RenderFrame identified by
   // |render_frame_id| are actively playing. Can be called from any thread.
   bool RenderFrameHasActiveAudio(int render_frame_id) const;
 
  private:
+  friend class AudioEntry;

[Henrik Grunell, 2016/05/02 12:12:23]

This should not be needed. Anything that needs to be accessed should go through
getter/setter functions.

[rchtara, 2016/05/23 16:38:17]

Done.

+  friend class AudioOutputImpl;
+  friend class AudioOutputStreamImpl;
   friend class AudioRendererHostTest;
   friend class BrowserThread;
   friend class base::DeleteHelper<AudioRendererHost>;
   friend class MockAudioRendererHost;
   friend class TestAudioRendererHost;
   FRIEND_TEST_ALL_PREFIXES(AudioRendererHostTest, CreateMockStream);
   FRIEND_TEST_ALL_PREFIXES(AudioRendererHostTest, MockStreamDataConversation);
 
   class AudioEntry;
   typedef std::map<int, AudioEntry*> AudioEntryMap;
@@ skipping 25 matching lines @@
   // parameters via the NotifyDeviceAuthorized message.
   void OnRequestDeviceAuthorization(int stream_id,
                                     int render_frame_id,
                                     int session_id,
                                     const std::string& device_id,
                                     const url::Origin& gurl_security_origin);
 
   // Creates an audio output stream with the specified format.
   // Upon success/failure, the peer is notified via the NotifyStreamCreated
   // message.
-  void OnCreateStream(int stream_id,
-                      int render_frame_id,
-                      const media::AudioParameters& params);
+  void CreateStream(
+      int stream_id,
+      int render_frame_id,
+      const media::AudioParameters& params,
+      const media::interfaces::AudioOutput::CreateStreamCallback& callback);
 
   // Play the audio stream referenced by |stream_id|.
   void OnPlayStream(int stream_id);
 
   // Pause the audio stream referenced by |stream_id|.
   void OnPauseStream(int stream_id);
 
   // Close the audio stream referenced by |stream_id|.
   void OnCloseStream(int stream_id);
 
   // Set the volume of the audio stream referenced by |stream_id|.
   void OnSetVolume(int stream_id, double volume);
 
   // Helper methods.
 
   // Proceed with device authorization after checking permissions.
   void OnDeviceAuthorized(int stream_id,
                           const std::string& device_id,
                           const GURL& security_origin,
                           bool have_access);
 
   // Proceed with device authorization after translating device ID.
   void OnDeviceIDTranslated(int stream_id,
                             bool device_found,
                             const AudioOutputDeviceInfo& device_info);
 
   // Start the actual creation of an audio stream, after the device
   // authorization process is complete.
-  void DoCreateStream(int stream_id,
-                      int render_frame_id,
-                      const media::AudioParameters& params,
-                      const std::string& device_unique_id);
+  void DoCreateStream(
+      int stream_id,
+      int render_frame_id,
+      const media::AudioParameters& params,
+      const std::string& device_unique_id,
+      const media::interfaces::AudioOutput::CreateStreamCallback& callback);
 
   // Complete the process of creating an audio stream. This will set up the
   // shared memory or shared socket in low latency mode and send the
   // NotifyStreamCreated message to the peer.
-  void DoCompleteCreation(int stream_id);
+  void DoCompleteCreation(
+      int stream_id,
+      const media::interfaces::AudioOutput::CreateStreamCallback& callback);
 
   // Send playing/paused status to the renderer.
   void DoNotifyStreamStateChanged(int stream_id, bool is_playing);
 
   RenderProcessHost::AudioOutputControllerList DoGetOutputControllers() const;
 
   // Send an error message to the renderer.
   void SendErrorMessage(int stream_id);
 
   // Delete an audio entry, notifying observers first.  This is called by
   // AudioOutputController after it has closed.
   void DeleteEntry(std::unique_ptr<AudioEntry> entry);
 
   // Send an error message to the renderer, then close the stream.
   void ReportErrorAndClose(int stream_id);
 
+  // Send an error message to the renderer, then close the stream.

[Henrik Grunell, 2016/05/02 12:12:23]

Change "renderer" to "client", it's more generic.

[rchtara, 2016/05/23 16:38:17]

Done.

+  void ReportErrorAndCloseStream(
+      int stream_id,
+      const media::interfaces::AudioOutput::CreateStreamCallback& callback);
+
   // A helper method to look up a AudioEntry identified by |stream_id|.
   // Returns NULL if not found.
   AudioEntry* LookupById(int stream_id);
 
   // A helper method to update the number of playing streams and alert the
   // ResourceScheduler when the renderer starts or stops playing an audiostream.
   void UpdateNumPlayingStreams(AudioEntry* entry, bool is_playing);
 
   // Check if the renderer process has access to the requested output device.
   void CheckOutputDeviceAccess(int render_frame_id,
@@ skipping 15 matching lines @@
   // Helper method to check if the authorization procedure for stream
   // |stream_id| has started.
   bool IsAuthorizationStarted(int stream_id);
 
   // ID of the RenderProcessHost that owns this instance.
   const int render_process_id_;
 
   media::AudioManager* const audio_manager_;
   AudioMirroringManager* const mirroring_manager_;
   std::unique_ptr<media::AudioLog> audio_log_;
+  AudioOutputImpl* audio_output_impl_;

[Henrik Grunell, 2016/05/02 12:12:23]

Add a comment about this. In that also explain how a raw pointer is safe, i.e.
why it outlives |this|.

 
   // Used to access to AudioInputDeviceManager.
   MediaStreamManager* media_stream_manager_;
 
   // A map of stream IDs to audio sources.
   AudioEntryMap audio_entries_;
 
   // The number of streams in the playing state. Atomic read safe from any
   // thread, but should only be updated from the IO thread.
   base::AtomicRefCount num_playing_streams_;
 
   // Salt required to translate renderer device IDs to raw device unique IDs
   ResourceContext::SaltCallback salt_callback_;
 
   // Map of device authorizations for streams that are not yet created
   // The key is the stream ID, and the value is a pair. The pair's first element
   // is a bool that is true if the authorization process completes successfully.
   // The second element contains the unique ID of the authorized device.
   std::map<int, std::pair<bool, std::string>> authorizations_;
 
   // The maximum number of simultaneous streams during the lifetime of this
   // host. Reported as UMA stat at shutdown.
   size_t max_simultaneous_streams_;
 
+  media::interfaces::AudioOutputStreamPtr stream_ptr_;

[Henrik Grunell, 2016/05/02 12:12:23]

Add comment.

[rchtara, 2016/05/23 16:38:17]

Done.

+
   DISALLOW_COPY_AND_ASSIGN(AudioRendererHost);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_MEDIA_AUDIO_RENDERER_HOST_H_