Allow MediaSession in iframes to be routed

content/browser/media/session/media_session_impl.h

 // Copyright 2015 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 CONTENT_BROWSER_MEDIA_SESSION_MEDIA_SESSION_IMPL_H_
 #define CONTENT_BROWSER_MEDIA_SESSION_MEDIA_SESSION_IMPL_H_
 
 #include <stddef.h>
 
+#include <map>
+#include <set>
+
 #include "base/callback_list.h"
 #include "base/id_map.h"
 #include "base/macros.h"
 #include "base/observer_list.h"
 #include "base/optional.h"
 #include "content/browser/media/session/audio_focus_manager.h"
 #include "content/browser/media/session/media_session_uma_helper.h"
 #include "content/common/content_export.h"
 #include "content/public/browser/media_session.h"
 #include "content/public/browser/media_session_observer.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/browser/web_contents_user_data.h"
 #include "content/public/common/media_metadata.h"
 
 #if defined(OS_ANDROID)
 #include "base/android/scoped_java_ref.h"
 #endif  // defined(OS_ANDROID)
 
 class MediaSessionImplBrowserTest;
 
 namespace media {
 enum class MediaContentType;
 }  // namespace media
 
 namespace content {
 
 class AudioFocusDelegate;
 class AudioFocusManagerTest;
+class MediaSessionImplServiceRoutingTest;
 class MediaSessionImplStateObserver;
 class MediaSessionImplVisibilityBrowserTest;
 class MediaSessionObserver;
 class MediaSessionPlayerObserver;
 class MediaSessionServiceImpl;
 
 #if defined(OS_ANDROID)
 class MediaSessionAndroid;
 #endif  // defined(OS_ANDROID)
 
@@ skipping 29 matching lines @@
   static MediaSession* FromJavaMediaSession(
       const base::android::JavaRef<jobject>& j_media_session);
   MediaSessionAndroid* session_android() const {
     return session_android_.get();
   }
 #endif  // defined(OS_ANDROID)
 
   void AddObserver(MediaSessionObserver* observer);
   void RemoveObserver(MediaSessionObserver* observer);
 
-  void SetMetadata(const base::Optional<MediaMetadata>& metadata);
-  const base::Optional<MediaMetadata>& metadata() const { return metadata_; }
+  void NotifyMediaSessionMetadataChange(
+      const base::Optional<MediaMetadata>& metadata);
+  void NotifyMediaSessionActionsChange(
+      const std::set<blink::mojom::MediaSessionAction>& actions);
 
   // Adds the given player to the current media session. Returns whether the
   // player was successfully added. If it returns false, AddPlayer() should be
   // called again later.
   CONTENT_EXPORT bool AddPlayer(MediaSessionPlayerObserver* observer,
                                 int player_id,
                                 media::MediaContentType media_content_type);
 
   // Removes the given player from the current media session. Abandons audio
   // focus if that was the last player in the session.
@@ skipping 18 matching lines @@
   CONTENT_EXPORT void Resume(MediaSession::SuspendType suspend_type) override;
 
   // Suspend the media session.
   // |type| represents the origin of the request.
   CONTENT_EXPORT void Suspend(MediaSession::SuspendType suspend_type) override;
 
   // Stop the media session.
   // |type| represents the origin of the request.
   CONTENT_EXPORT void Stop(MediaSession::SuspendType suspend_type) override;
 
-  // Received a media session action and forward to blink::MediaSession.
-  void DidReceiveAction(blink::mojom::MediaSessionAction action) override;
-
-  // Called when an action is enabled in blink::MediaSession. This method will
-  // notify the observers that the action is enabled.
-  void OnMediaSessionEnabledAction(blink::mojom::MediaSessionAction action);
-
-  // Called when an action is disabled in blink::MediaSession. This method will
-  // notify the observers that the action is disabled.
-  void OnMediaSessionDisabledAction(blink::mojom::MediaSessionAction action);
-
   // Let the media session start ducking such that the volume multiplier is
   // reduced.
   CONTENT_EXPORT void StartDucking();
 
   // Let the media session stop ducking such that the volume multiplier is
   // recovered.
   CONTENT_EXPORT void StopDucking();
 
   // Returns if the session can be controlled by Resume() and Suspend calls
   // above.
@@ skipping 17 matching lines @@
   CONTENT_EXPORT AudioFocusManager::AudioFocusType audio_focus_type() const {
     return audio_focus_type_;
   }
 
   // Returns whether the session has Pepper instances.
   bool HasPepper() const;
 
   // WebContentsObserver implementation
   void WebContentsDestroyed() override;
 
-  // Sets the associated MediaSessionService for communicating with
-  // blink::MediaSession.
-  MediaSessionServiceImpl* GetMediaSessionService() { return service_; }
-  void SetMediaSessionService(MediaSessionServiceImpl* service);
+  // MediaSessionService-related methods
+
+  // Called when a MediaSessionService is created, which registers itself to
+  // this session.
+  void OnServiceCreated(MediaSessionServiceImpl* service);
+  // Called when a MediaSessionService is destroyed, which unregisters itself
+  // from this session.
+  void OnServiceDestroyed(MediaSessionServiceImpl* service);
+
+  // Called when the metadata of a MediaSessionService has changed. Will notify
+  // observers if the service is currently routed.
+  void OnMediaSessionMetadataChanged(MediaSessionServiceImpl* service);
+  // Called when the actions of a MediaSessionService has changed. Will notify
+  // observers if the service is currently routed.
+  void OnMediaSessionActionsChanged(MediaSessionServiceImpl* service);
+
+  // Called when a MediaSessionAction is received. The action will be forwarded
+  // to blink::MediaSession corresponding to the current routed service.
+  void DidReceiveAction(blink::mojom::MediaSessionAction action) override;
 
  private:
   friend class content::WebContentsUserData<MediaSessionImpl>;
   friend class ::MediaSessionImplBrowserTest;
   friend class content::MediaSessionImplVisibilityBrowserTest;
   friend class content::AudioFocusManagerTest;
+  friend class content::MediaSessionImplServiceRoutingTest;
   friend class content::MediaSessionImplStateObserver;
 
   CONTENT_EXPORT void SetDelegateForTests(
       std::unique_ptr<AudioFocusDelegate> delegate);
   CONTENT_EXPORT bool IsActiveForTest() const;
   CONTENT_EXPORT void RemoveAllPlayersForTest();
   CONTENT_EXPORT MediaSessionUmaHelper* uma_helper_for_test();
 
   // Representation of a player for the MediaSessionImpl.
   struct PlayerIdentifier {
@@ skipping 49 matching lines @@
   CONTENT_EXPORT std::unique_ptr<base::CallbackList<void(State)>::Subscription>
   RegisterMediaSessionStateChangedCallbackForTest(
       const StateChangedCallback& cb);
 
   CONTENT_EXPORT bool AddPepperPlayer(MediaSessionPlayerObserver* observer,
                                       int player_id);
 
   CONTENT_EXPORT bool AddOneShotPlayer(MediaSessionPlayerObserver* observer,
                                        int player_id);
 
+  // MediaSessionService-related methods
+
+  // Called when the routed service may have changed.
+  void UpdateRoutedService();
+
+  // Returns whether the frame |rfh| uses MediaSession API.
+  bool IsServiceActiveForRenderFrameHost(RenderFrameHost* rfh);
+
+  // Compute the MediaSessionService that should be routed, which will be used
+  // to update |routed_service_|.
+  CONTENT_EXPORT MediaSessionServiceImpl* ComputeServiceForRouting();
+
   std::unique_ptr<AudioFocusDelegate> delegate_;
   PlayersMap normal_players_;
   PlayersMap pepper_players_;
   PlayersMap one_shot_players_;
 
   State audio_focus_state_;
   MediaSession::SuspendType suspend_type_;
   AudioFocusManager::AudioFocusType audio_focus_type_;
 
   MediaSessionUmaHelper uma_helper_;
 
   // The ducking state of this media session. The initial value is |false|, and
   // is set to |true| after StartDucking(), and will be set to |false| after
   // StopDucking().
   bool is_ducking_;
 
-  base::Optional<MediaMetadata> metadata_;
   base::CallbackList<void(State)> media_session_state_listeners_;
 
   base::ObserverList<MediaSessionObserver> observers_;
 
 #if defined(OS_ANDROID)
   std::unique_ptr<MediaSessionAndroid> session_android_;
 #endif  // defined(OS_ANDROID)
 
-  // The MediaSessionService this session is associated with (the service of the
-  // top-level frame).
-  MediaSessionServiceImpl* service_;
+  // MediaSessionService-related fields
+  using ServicesMap = std::map<RenderFrameHost*, MediaSessionServiceImpl*>;
+
+  // The collection of all managed services (non-owned pointers). The services
+  // are owned by RenderFrameHost and should be registered on creation and
+  // unregistered on destroy.
+  ServicesMap services_;
+  // The currently routed service (non-owned pointer).
+  MediaSessionServiceImpl* routed_service_;
 
   DISALLOW_COPY_AND_ASSIGN(MediaSessionImpl);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_MEDIA_SESSION_MEDIA_SESSION_IMPL_H_