Split MediaContentType and AudioFocusType

content/browser/media/session/media_session.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_H_
 #define CONTENT_BROWSER_MEDIA_SESSION_MEDIA_SESSION_H_
 
 #include <stddef.h>
 
 #include "base/callback_list.h"
 #include "base/id_map.h"
 #include "base/macros.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/web_contents_observer.h"
 #include "content/public/browser/web_contents_user_data.h"
 #include "content/public/common/media_metadata.h"
 
 class MediaSessionBrowserTest;
 
+namespace media {
+enum class MediaContentType;
+}  // namespace media
+
 namespace content {
 
 class AudioFocusManagerTest;
 class MediaSessionDelegate;
 class MediaSessionObserver;
 class MediaSessionStateObserver;
 class MediaSessionVisibilityBrowserTest;
 
 // MediaSession manages the media session and audio focus for a given
 // WebContents. It is requesting the audio focus, pausing when requested by the
 // system and dropping it on demand.
 // The audio focus can be of two types: Transient or Content. A Transient audio
 // focus will allow other players to duck instead of pausing and will be
 // declared as temporary to the system. A Content audio focus will not be
 // declared as temporary and will not allow other players to duck. If a given
 // WebContents can only have one audio focus at a time, it will be Content in
 // case of Transient and Content audio focus are both requested.
 // TODO(thakis,mlamouri): MediaSession isn't CONTENT_EXPORT'd because it creates
 // complicated build issues with WebContentsUserData being a non-exported
 // template, see htttps://crbug.com/589840. As a result, the class uses
 // CONTENT_EXPORT for methods that are being used from tests. CONTENT_EXPORT
 // should be moved back to the class when the Windows build will work with it.
 class MediaSession : public WebContentsObserver,
                      protected WebContentsUserData<MediaSession> {
  public:
-  enum class Type {
-    Content,
-    Transient
-  };
-
   enum class SuspendType {
     // Suspended by the system because a transient sound needs to be played.
     SYSTEM,
     // Suspended by the UI.
     UI,
     // Suspended by the page via script or user interaction.
     CONTENT,
   };
 
   // Returns the MediaSession associated to this WebContents. Creates one if
   // none is currently available.
   CONTENT_EXPORT static MediaSession* Get(WebContents* web_contents);
 
   ~MediaSession() override;
 
   void SetMetadata(const MediaMetadata& metadata);
   const MediaMetadata& metadata() const { return metadata_; }
 
   // 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(MediaSessionObserver* observer,
-                                int player_id, Type type);
+                                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.
   CONTENT_EXPORT void RemovePlayer(MediaSessionObserver* observer,
                                    int player_id);
 
   // Removes all the players associated with |observer|. Abandons audio focus if
   // these were the last players in the session.
   CONTENT_EXPORT void RemovePlayers(MediaSessionObserver* observer);
 
   // Record that the session was ducked.
   void RecordSessionDuck();
 
   // Called when a player is paused in the content.
   // If the paused player is the last player, we suspend the MediaSession.
   // Otherwise, the paused player will be removed from the MediaSession.
   CONTENT_EXPORT void OnPlayerPaused(MediaSessionObserver* observer,
                                      int player_id);
 
   // Resume the media session.
   // |type| represents the origin of the request.
-  CONTENT_EXPORT void Resume(SuspendType type);
+  CONTENT_EXPORT void Resume(SuspendType suspend_type);
 
   // Suspend the media session.
   // |type| represents the origin of the request.
-  CONTENT_EXPORT void Suspend(SuspendType type);
+  CONTENT_EXPORT void Suspend(SuspendType suspend_type);
 
   // Stop the media session.
   // |type| represents the origin of the request.
-  CONTENT_EXPORT void Stop(SuspendType type);
+  CONTENT_EXPORT void Stop(SuspendType suspend_type);
 
   // Change the volume multiplier of the session to |volume_multiplier|.
   CONTENT_EXPORT void SetVolumeMultiplier(double volume_multiplier);
 
   // Returns if the session can be controlled by Resume() and Suspend calls
   // above.
   CONTENT_EXPORT bool IsControllable() const;
 
   // Returns if the session is currently active.
   CONTENT_EXPORT bool IsActive() const;
@@ skipping 11 matching lines @@
  private:
   friend class content::WebContentsUserData<MediaSession>;
   friend class ::MediaSessionBrowserTest;
   friend class content::MediaSessionVisibilityBrowserTest;
   friend class content::AudioFocusManagerTest;
   friend class content::MediaSessionStateObserver;
 
   CONTENT_EXPORT void SetDelegateForTests(
       std::unique_ptr<MediaSessionDelegate> delegate);
   CONTENT_EXPORT bool IsActiveForTest() const;
-  CONTENT_EXPORT Type audio_focus_type_for_test() const;
+  CONTENT_EXPORT AudioFocusManager::AudioFocusType audio_focus_type_for_test()
+      const;
   CONTENT_EXPORT void RemoveAllPlayersForTest();
   CONTENT_EXPORT MediaSessionUmaHelper* uma_helper_for_test();
 
   enum class State {
     ACTIVE,
     SUSPENDED,
     INACTIVE
   };
 
   // Representation of a player for the MediaSession.
@@ skipping 12 matching lines @@
     MediaSessionObserver* observer;
     int player_id;
   };
   using PlayersMap = base::hash_set<PlayerIdentifier, PlayerIdentifier::Hash>;
   using StateChangedCallback = base::Callback<void(State)>;
 
   CONTENT_EXPORT explicit MediaSession(WebContents* web_contents);
 
   void Initialize();
 
-  CONTENT_EXPORT void OnSuspendInternal(SuspendType type, State new_state);
-  CONTENT_EXPORT void OnResumeInternal(SuspendType type);
+  CONTENT_EXPORT void OnSuspendInternal(SuspendType suspend_type,
+                                        State new_state);
+  CONTENT_EXPORT void OnResumeInternal(SuspendType suspend_type);
 
   // Requests audio focus to the MediaSessionDelegate.
   // Returns whether the request was granted.
-  bool RequestSystemAudioFocus(Type type);
+  bool RequestSystemAudioFocus(
+      AudioFocusManager::AudioFocusType audio_focus_type);
 
   // To be called after a call to AbandonAudioFocus() in order request the
   // delegate to abandon the audio focus.
   void AbandonSystemAudioFocusIfNeeded();
 
   // Notifies WebContents about the state change of the media session.
   void UpdateWebContents();
 
   // Internal method that should be used instead of setting audio_focus_state_.
   // It sets audio_focus_state_ and notifies observers about the state change.
   void SetAudioFocusState(State audio_focus_state);
 
   // Registers a MediaSession state change callback.
   CONTENT_EXPORT std::unique_ptr<base::CallbackList<void(State)>::Subscription>
   RegisterMediaSessionStateChangedCallbackForTest(
       const StateChangedCallback& cb);
 
   std::unique_ptr<MediaSessionDelegate> delegate_;
   PlayersMap players_;
 
   State audio_focus_state_;
   SuspendType suspend_type_;
-  Type audio_focus_type_;
+  AudioFocusManager::AudioFocusType audio_focus_type_;
 
   MediaSessionUmaHelper uma_helper_;
 
   // The volume multiplier of this session. All players in this session should
   // multiply their volume with this multiplier to get the effective volume.
   double volume_multiplier_;
 
   MediaMetadata metadata_;
   base::CallbackList<void(State)> media_session_state_listeners_;
 
   DISALLOW_COPY_AND_ASSIGN(MediaSession);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_MEDIA_SESSION_MEDIA_SESSION_H_