content/browser/media/android/browser_media_player_manager.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_BROWSER_MEDIA_ANDROID_BROWSER_MEDIA_PLAYER_MANAGER_H_
   6 #define CONTENT_BROWSER_MEDIA_ANDROID_BROWSER_MEDIA_PLAYER_MANAGER_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/callback.h"
  10 #include "base/memory/scoped_ptr.h"
  11 #include "base/memory/scoped_vector.h"
  12 #include "base/time/time.h"
  13 #include "content/browser/android/content_video_view.h"
  14 #include "content/common/content_export.h"
  15 #include "content/common/media/media_player_messages_enums_android.h"
  16 #include "content/public/browser/android/content_view_core.h"
  17 #include "ipc/ipc_message.h"
  18 #include "media/base/android/media_player_android.h"
  19 #include "media/base/android/media_player_manager.h"
  20 #include "media/base/android/media_url_interceptor.h"
  21 #include "ui/gfx/geometry/rect_f.h"
  22 #include "url/gurl.h"
  23
  24 namespace media {
  25 class DemuxerAndroid;
  26 }
  27
  28 struct MediaPlayerHostMsg_Initialize_Params;
  29
  30 namespace content {
  31 class BrowserDemuxerAndroid;
  32 class ContentViewCoreImpl;
  33 class ExternalVideoSurfaceContainer;
  34 class MediaPlayersObserver;
  35 class RenderFrameHost;
  36 class WebContents;
  37
  38 // This class manages all the MediaPlayerAndroid objects.
  39 // It receives control operations from the the render process, and forwards
  40 // them to corresponding MediaPlayerAndroid object. Callbacks from
  41 // MediaPlayerAndroid objects are converted to IPCs and then sent to the render
  42 // process.
  43 class CONTENT_EXPORT BrowserMediaPlayerManager
  44     : public media::MediaPlayerManager {
  45  public:
  46   // Permits embedders to provide an extended version of the class.
  47   typedef BrowserMediaPlayerManager* (*Factory)(RenderFrameHost*,
  48                                                 MediaPlayersObserver*);
  49   static void RegisterFactory(Factory factory);
  50
  51   // Permits embedders to handle custom urls.
  52   static void RegisterMediaUrlInterceptor(
  53       media::MediaUrlInterceptor* media_url_interceptor);
  54
  55   // Returns a new instance using the registered factory if available.
  56   static BrowserMediaPlayerManager* Create(
  57       RenderFrameHost* rfh,
  58       MediaPlayersObserver* audio_monitor);
  59
  60   ContentViewCore* GetContentViewCore() const;
  61
  62   ~BrowserMediaPlayerManager() override;
  63
  64   // Fullscreen video playback controls.
  65   virtual void ExitFullscreen(bool release_media_player);
  66   virtual void SetVideoSurface(gfx::ScopedJavaSurface surface);
  67
  68   // Called when browser player wants the renderer media element to seek.
  69   // Any actual seek started by renderer will be handled by browser in OnSeek().
  70   void OnSeekRequest(int player_id, const base::TimeDelta& time_to_seek);
  71
  72   // Stops and releases every media managed by this class.
  73   void ReleaseAllMediaPlayers();
  74
  75   // media::MediaPlayerManager overrides.
  76   void OnTimeUpdate(int player_id,
  77                     base::TimeDelta current_timestamp,
  78                     base::TimeTicks current_time_ticks) override;
  79   void OnMediaMetadataChanged(int player_id,
  80                               base::TimeDelta duration,
  81                               int width,
  82                               int height,
  83                               bool success) override;
  84   void OnPlaybackComplete(int player_id) override;
  85   void OnMediaInterrupted(int player_id) override;
  86   void OnBufferingUpdate(int player_id, int percentage) override;
  87   void OnSeekComplete(int player_id,
  88                       const base::TimeDelta& current_time) override;
  89   void OnError(int player_id, int error) override;
  90   void OnVideoSizeChanged(int player_id, int width, int height) override;
  91   void OnAudibleStateChanged(
  92       int player_id, bool is_audible_now) override;
  93   void OnWaitingForDecryptionKey(int player_id) override;
  94
  95   media::MediaResourceGetter* GetMediaResourceGetter() override;
  96   media::MediaUrlInterceptor* GetMediaUrlInterceptor() override;
  97   media::MediaPlayerAndroid* GetFullscreenPlayer() override;
  98   media::MediaPlayerAndroid* GetPlayer(int player_id) override;
  99   void RequestFullScreen(int player_id) override;
 100 #if defined(VIDEO_HOLE)
 101   void AttachExternalVideoSurface(int player_id, jobject surface);
 102   void DetachExternalVideoSurface(int player_id);
 103   void OnFrameInfoUpdated();
 104 #endif  // defined(VIDEO_HOLE)
 105
 106   // Message handlers.
 107   virtual void OnEnterFullscreen(int player_id);
 108   virtual void OnExitFullscreen(int player_id);
 109   virtual void OnInitialize(
 110       const MediaPlayerHostMsg_Initialize_Params& media_player_params);
 111   virtual void OnStart(int player_id);
 112   virtual void OnSeek(int player_id, const base::TimeDelta& time);
 113   virtual void OnPause(int player_id, bool is_media_related_action);
 114   virtual void OnSetVolume(int player_id, double volume);
 115   virtual void OnSetPoster(int player_id, const GURL& poster);
 116   virtual void OnReleaseResources(int player_id);
 117   virtual void OnDestroyPlayer(int player_id);
 118   virtual void OnRequestRemotePlayback(int player_id);
 119   virtual void OnRequestRemotePlaybackControl(int player_id);
 120   virtual void ReleaseFullscreenPlayer(media::MediaPlayerAndroid* player);
 121 #if defined(VIDEO_HOLE)
 122   void OnNotifyExternalSurface(
 123       int player_id, bool is_request, const gfx::RectF& rect);
 124 #endif  // defined(VIDEO_HOLE)
 125
 126  protected:
 127   // Clients must use Create() or subclass constructor.
 128   BrowserMediaPlayerManager(RenderFrameHost* render_frame_host,
 129                             MediaPlayersObserver* audio_monitor);
 130
 131   WebContents* web_contents() const { return web_contents_; }
 132
 133   // Adds a given player to the list.
 134   void AddPlayer(media::MediaPlayerAndroid* player);
 135
 136   // Removes the player with the specified id.
 137   void RemovePlayer(int player_id);
 138
 139   // Replaces a player with the specified id with a given MediaPlayerAndroid
 140   // object. This will also return the original MediaPlayerAndroid object that
 141   // was replaced.
 142   scoped_ptr<media::MediaPlayerAndroid> SwapPlayer(
 143       int player_id,
 144       media::MediaPlayerAndroid* player);
 145
 146   int RoutingID();
 147
 148   // Helper function to send messages to RenderFrameObserver.
 149   bool Send(IPC::Message* msg);
 150
 151  private:
 152   // Constructs a MediaPlayerAndroid object.
 153   media::MediaPlayerAndroid* CreateMediaPlayer(
 154       const MediaPlayerHostMsg_Initialize_Params& media_player_params,
 155       bool hide_url_log,
 156       media::MediaPlayerManager* manager,
 157       BrowserDemuxerAndroid* demuxer);
 158
 159   // MediaPlayerAndroid must call this before it is going to decode
 160   // media streams. This helps the manager object maintain an array
 161   // of active MediaPlayerAndroid objects and release the resources
 162   // when needed. Currently we only count video resources as they are
 163   // constrained by hardware and memory limits.
 164   virtual void OnMediaResourcesRequested(int player_id);
 165
 166   // Called when a player releases all decoding resources.
 167   void ReleaseMediaResources(int player_id);
 168
 169   // Releases the player. However, don't remove it from |players_|.
 170   void ReleasePlayer(media::MediaPlayerAndroid* player);
 171
 172 #if defined(VIDEO_HOLE)
 173   void ReleasePlayerOfExternalVideoSurfaceIfNeeded(int future_player);
 174   void OnRequestExternalSurface(int player_id, const gfx::RectF& rect);
 175 #endif  // defined(VIDEO_HOLE)
 176
 177   RenderFrameHost* const render_frame_host_;
 178
 179   MediaPlayersObserver* audio_monitor_;
 180
 181   // An array of managed players.
 182   ScopedVector<media::MediaPlayerAndroid> players_;
 183
 184   // The fullscreen video view object or NULL if video is not played in
 185   // fullscreen.
 186   scoped_ptr<ContentVideoView> video_view_;
 187
 188 #if defined(VIDEO_HOLE)
 189   scoped_ptr<ExternalVideoSurfaceContainer> external_video_surface_container_;
 190 #endif
 191
 192   // Player ID of the fullscreen media player.
 193   int fullscreen_player_id_;
 194
 195   // Whether the fullscreen player has been Release()-d.
 196   bool fullscreen_player_is_released_;
 197
 198   WebContents* const web_contents_;
 199
 200   // Object for retrieving resources media players.
 201   scoped_ptr<media::MediaResourceGetter> media_resource_getter_;
 202
 203   // NOTE: Weak pointers must be invalidated before all other member variables.
 204   base::WeakPtrFactory<BrowserMediaPlayerManager> weak_ptr_factory_;
 205
 206   DISALLOW_COPY_AND_ASSIGN(BrowserMediaPlayerManager);
 207 };
 208
 209 }  // namespace content
 210
 211 #endif  // CONTENT_BROWSER_MEDIA_ANDROID_BROWSER_MEDIA_PLAYER_MANAGER_H_