media/base/android/media_player_bridge.h

   1 // Copyright (c) 2012 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 MEDIA_BASE_ANDROID_MEDIA_PLAYER_BRIDGE_H_
   6 #define MEDIA_BASE_ANDROID_MEDIA_PLAYER_BRIDGE_H_
   7
   8 #include <jni.h>
   9 #include <map>
  10 #include <string>
  11
  12 #include "base/android/scoped_java_ref.h"
  13 #include "base/callback.h"
  14 #include "base/memory/scoped_ptr.h"
  15 #include "base/memory/weak_ptr.h"
  16 #include "base/time/time.h"
  17 #include "base/timer/timer.h"
  18 #include "media/base/android/media_player_android.h"
  19 #include "media/base/android/media_player_listener.h"
  20 #include "url/gurl.h"
  21
  22 namespace media {
  23
  24 class MediaPlayerManager;
  25
  26 // This class serves as a bridge between the native code and Android MediaPlayer
  27 // Java class. For more information on Android MediaPlayer, check
  28 // http://developer.android.com/reference/android/media/MediaPlayer.html
  29 // The actual Android MediaPlayer instance is created lazily when Start(),
  30 // Pause(), SeekTo() gets called. As a result, media information may not
  31 // be available until one of those operations is performed. After that, we
  32 // will cache those information in case the mediaplayer gets released.
  33 // The class uses the corresponding MediaPlayerBridge Java class to talk to
  34 // the Android MediaPlayer instance.
  35 class MEDIA_EXPORT MediaPlayerBridge : public MediaPlayerAndroid {
  36  public:
  37   static bool RegisterMediaPlayerBridge(JNIEnv* env);
  38
  39   // Construct a MediaPlayerBridge object. This object needs to call |manager|'s
  40   // RequestMediaResources() before decoding the media stream. This allows
  41   // |manager| to track unused resources and free them when needed. On the other
  42   // hand, it needs to call ReleaseMediaResources() when it is done with
  43   // decoding. MediaPlayerBridge also forwards Android MediaPlayer callbacks to
  44   // the |manager| when needed.
  45   MediaPlayerBridge(int player_id,
  46                     const GURL& url,
  47                     const GURL& first_party_for_cookies,
  48                     const std::string& user_agent,
  49                     bool hide_url_log,
  50                     MediaPlayerManager* manager,
  51                     const RequestMediaResourcesCB& request_media_resources_cb,
  52                     const ReleaseMediaResourcesCB& release_media_resources_cb);
  53   virtual ~MediaPlayerBridge();
  54
  55   // Initialize this object and extract the metadata from the media.
  56   virtual void Initialize();
  57
  58   // MediaPlayerAndroid implementation.
  59   virtual void SetVideoSurface(gfx::ScopedJavaSurface surface) OVERRIDE;
  60   virtual void Start() OVERRIDE;
  61   virtual void Pause(bool is_media_related_action ALLOW_UNUSED) OVERRIDE;
  62   virtual void SeekTo(base::TimeDelta timestamp) OVERRIDE;
  63   virtual void Release() OVERRIDE;
  64   virtual void SetVolume(double volume) OVERRIDE;
  65   virtual int GetVideoWidth() OVERRIDE;
  66   virtual int GetVideoHeight() OVERRIDE;
  67   virtual base::TimeDelta GetCurrentTime() OVERRIDE;
  68   virtual base::TimeDelta GetDuration() OVERRIDE;
  69   virtual bool IsPlaying() OVERRIDE;
  70   virtual bool CanPause() OVERRIDE;
  71   virtual bool CanSeekForward() OVERRIDE;
  72   virtual bool CanSeekBackward() OVERRIDE;
  73   virtual bool IsPlayerReady() OVERRIDE;
  74   virtual GURL GetUrl() OVERRIDE;
  75   virtual GURL GetFirstPartyForCookies() OVERRIDE;
  76   virtual bool IsSurfaceInUse() const OVERRIDE;
  77
  78   // MediaPlayerListener callbacks.
  79   void OnVideoSizeChanged(int width, int height);
  80   void OnMediaError(int error_type);
  81   void OnBufferingUpdate(int percent);
  82   void OnPlaybackComplete();
  83   void OnMediaInterrupted();
  84   void OnSeekComplete();
  85   void OnDidSetDataUriDataSource(JNIEnv* env, jobject obj, jboolean success);
  86
  87  protected:
  88   void SetJavaMediaPlayerBridge(jobject j_media_player_bridge);
  89   base::android::ScopedJavaLocalRef<jobject> GetJavaMediaPlayerBridge();
  90   void SetMediaPlayerListener();
  91   void SetDuration(base::TimeDelta time);
  92
  93   virtual void PendingSeekInternal(const base::TimeDelta& time);
  94
  95   // Prepare the player for playback, asynchronously. When succeeds,
  96   // OnMediaPrepared() will be called. Otherwise, OnMediaError() will
  97   // be called with an error type.
  98   virtual void Prepare();
  99   void OnMediaPrepared();
 100
 101   // Create the corresponding Java class instance.
 102   virtual void CreateJavaMediaPlayerBridge();
 103
 104   // Get allowed operations from the player.
 105   virtual base::android::ScopedJavaLocalRef<jobject> GetAllowedOperations();
 106
 107  private:
 108   friend class MediaPlayerListener;
 109
 110   // Set the data source for the media player.
 111   void SetDataSource(const std::string& url);
 112
 113   // Functions that implements media player control.
 114   void StartInternal();
 115   void PauseInternal();
 116   void SeekInternal(base::TimeDelta time);
 117
 118   // Called when |time_update_timer_| fires.
 119   void OnTimeUpdateTimerFired();
 120
 121   // Update allowed operations from the player.
 122   void UpdateAllowedOperations();
 123
 124   // Callback function passed to |resource_getter_|. Called when the cookies
 125   // are retrieved.
 126   void OnCookiesRetrieved(const std::string& cookies);
 127
 128   // Extract the media metadata from a url, asynchronously.
 129   // OnMediaMetadataExtracted() will be called when this call finishes.
 130   void ExtractMediaMetadata(const std::string& url);
 131   void OnMediaMetadataExtracted(base::TimeDelta duration, int width, int height,
 132                                 bool success);
 133
 134   // Whether the player is prepared for playback.
 135   bool prepared_;
 136
 137   // Pending play event while player is preparing.
 138   bool pending_play_;
 139
 140   // Pending seek time while player is preparing.
 141   base::TimeDelta pending_seek_;
 142
 143   // Url for playback.
 144   GURL url_;
 145
 146   // First party url for cookies.
 147   GURL first_party_for_cookies_;
 148
 149   // User agent string to be used for media player.
 150   const std::string user_agent_;
 151
 152   // Hide url log from media player.
 153   bool hide_url_log_;
 154
 155   // Stats about the media.
 156   base::TimeDelta duration_;
 157   int width_;
 158   int height_;
 159
 160   // Meta data about actions can be taken.
 161   bool can_pause_;
 162   bool can_seek_forward_;
 163   bool can_seek_backward_;
 164
 165   // Cookies for |url_|.
 166   std::string cookies_;
 167
 168   // Java MediaPlayerBridge instance.
 169   base::android::ScopedJavaGlobalRef<jobject> j_media_player_bridge_;
 170
 171   base::RepeatingTimer<MediaPlayerBridge> time_update_timer_;
 172
 173   // Listener object that listens to all the media player events.
 174   scoped_ptr<MediaPlayerListener> listener_;
 175
 176   // Whether player is currently using a surface.
 177   bool is_surface_in_use_;
 178
 179   // Weak pointer passed to |listener_| for callbacks.
 180   // NOTE: Weak pointers must be invalidated before all other member variables.
 181   base::WeakPtrFactory<MediaPlayerBridge> weak_factory_;
 182
 183   DISALLOW_COPY_AND_ASSIGN(MediaPlayerBridge);
 184 };
 185
 186 }  // namespace media
 187
 188 #endif  // MEDIA_BASE_ANDROID_MEDIA_PLAYER_BRIDGE_H_