Clean up MediaSessionImpl state interfaces

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>
@@ skipping 51 matching lines @@
 // TODO(thakis,mlamouri): MediaSessionImpl isn't CONTENT_EXPORT'd because it
 // creates complicated build issues with WebContentsUserData being a
 // non-exported template, see https://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 MediaSessionImpl : public MediaSession,
                          public WebContentsObserver,
                          protected WebContentsUserData<MediaSessionImpl> {
  public:
   // Only visible to tests.

[whywhat, 2017/03/20 22:12:47]

nit: this comment is not true?
do we have a good comment that explains what ACTIVE/SUSPENDED/INACTIVE and
"actually paused" vs "paused" mean?

[Zhiqiang Zhang (Slow), 2017/03/22 13:52:51]

Done.
We already have it (audio_focus.md)

   enum class State { ACTIVE, SUSPENDED, INACTIVE };
 
   // Returns the MediaSessionImpl associated to this WebContents. Creates one if
   // none is currently available.
   CONTENT_EXPORT static MediaSessionImpl* Get(WebContents* web_contents);
 
   ~MediaSessionImpl() override;
 
 #if defined(OS_ANDROID)
   static MediaSession* FromJavaMediaSession(
@@ skipping 57 matching lines @@
   void RemoveObserver(MediaSessionObserver* observer) override;
 
   // 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;
 
   // Returns if the session is currently suspended.
-  // TODO(mlamouri): IsSuspended() below checks if the state is not ACTIVE
-  // instead of checking if the state is SUSPENDED. In order to not have to
-  // change all the callers and make the current refactoring ridiculously huge,
-  // this method is introduced temporarily and will be removed later.
-  CONTENT_EXPORT bool IsReallySuspended() const;
+  CONTENT_EXPORT bool IsSuspended() const;
 
-  // Returns if the session is currently suspended or inactive.
-  CONTENT_EXPORT bool IsSuspended() const;
+  // Returns if the session is actually paused, which is the combined result of
+  // |IsSuspended()| and the declared playback state of the routed service. This
+  // state should be used in the UI end
+  //
+  // TODO(zqzhang): Maybe also compute for IsControllable()? See
+  // https://crbug.com/674983.
+  CONTENT_EXPORT bool IsActuallyPaused() const;
 
   // Returns the audio focus type. The type is updated everytime after the
   // session requests audio focus.
   CONTENT_EXPORT AudioFocusManager::AudioFocusType audio_focus_type() const {
     return audio_focus_type_;
   }
 
   // Returns whether the session has Pepper instances.
   bool HasPepper() const;
 
@@ skipping 30 matching lines @@
   friend class content::WebContentsUserData<MediaSessionImpl>;
   friend class ::MediaSessionImplBrowserTest;
   friend class content::MediaSessionImplVisibilityBrowserTest;
   friend class content::AudioFocusManagerTest;
   friend class content::MediaSessionImplServiceRoutingTest;
   friend class content::MediaSessionImplStateObserver;
   friend class content::MediaSessionServiceImplBrowserTest;
 
   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 {
     PlayerIdentifier(MediaSessionPlayerObserver* observer, int player_id);
     PlayerIdentifier(const PlayerIdentifier&) = default;
 
     void operator=(const PlayerIdentifier&) = delete;
     bool operator==(const PlayerIdentifier& player_identifier) const;
@@ skipping 96 matching lines @@
   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_