media/blink/webmediaplayer_impl.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 MEDIA_BLINK_WEBMEDIAPLAYER_IMPL_H_
   6 #define MEDIA_BLINK_WEBMEDIAPLAYER_IMPL_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12 #include "base/compiler_specific.h"
  13 #include "base/memory/ref_counted.h"
  14 #include "base/memory/scoped_ptr.h"
  15 #include "base/memory/weak_ptr.h"
  16 #include "base/threading/thread.h"
  17 #include "media/base/audio_renderer_sink.h"
  18 #include "media/base/cdm_factory.h"
  19 #include "media/base/media_export.h"
  20 #include "media/base/pipeline.h"
  21 #include "media/base/renderer.h"
  22 #include "media/base/text_track.h"
  23 #include "media/blink/buffered_data_source.h"
  24 #include "media/blink/buffered_data_source_host_impl.h"
  25 #include "media/blink/encrypted_media_player_support.h"
  26 #include "media/blink/video_frame_compositor.h"
  27 #include "media/filters/skcanvas_video_renderer.h"
  28 #include "third_party/WebKit/public/platform/WebAudioSourceProvider.h"
  29 #include "third_party/WebKit/public/platform/WebContentDecryptionModuleResult.h"
  30 #include "third_party/WebKit/public/platform/WebGraphicsContext3D.h"
  31 #include "third_party/WebKit/public/platform/WebMediaPlayer.h"
  32 #include "third_party/WebKit/public/platform/WebMediaPlayerClient.h"
  33 #include "url/gurl.h"
  34
  35 namespace blink {
  36 class WebLocalFrame;
  37 }
  38
  39 namespace base {
  40 class SingleThreadTaskRunner;
  41 }
  42
  43 namespace cc_blink {
  44 class WebLayerImpl;
  45 }
  46
  47 namespace media {
  48
  49 class AudioHardwareConfig;
  50 class ChunkDemuxer;
  51 class GpuVideoAcceleratorFactories;
  52 class MediaLog;
  53 class VideoFrameCompositor;
  54 class WebAudioSourceProviderImpl;
  55 class WebMediaPlayerDelegate;
  56 class WebMediaPlayerParams;
  57 class WebTextTrackImpl;
  58
  59 // The canonical implementation of blink::WebMediaPlayer that's backed by
  60 // Pipeline. Handles normal resource loading, Media Source, and
  61 // Encrypted Media.
  62 class MEDIA_EXPORT WebMediaPlayerImpl
  63     : public NON_EXPORTED_BASE(blink::WebMediaPlayer),
  64       public base::SupportsWeakPtr<WebMediaPlayerImpl> {
  65  public:
  66   // Constructs a WebMediaPlayer implementation using Chromium's media stack.
  67   // |delegate| may be null. |renderer| may also be null, in which case an
  68   // internal renderer will be created.
  69   // TODO(xhwang): Drop the internal renderer path and always pass in a renderer
  70   // here.
  71   WebMediaPlayerImpl(blink::WebLocalFrame* frame,
  72                      blink::WebMediaPlayerClient* client,
  73                      base::WeakPtr<WebMediaPlayerDelegate> delegate,
  74                      scoped_ptr<Renderer> renderer,
  75                      scoped_ptr<CdmFactory> cdm_factory,
  76                      const WebMediaPlayerParams& params);
  77   virtual ~WebMediaPlayerImpl();
  78
  79   virtual void load(LoadType load_type,
  80                     const blink::WebURL& url,
  81                     CORSMode cors_mode);
  82
  83   // Playback controls.
  84   virtual void play();
  85   virtual void pause();
  86   virtual bool supportsSave() const;
  87   virtual void seek(double seconds);
  88   virtual void setRate(double rate);
  89   virtual void setVolume(double volume);
  90   virtual void setPreload(blink::WebMediaPlayer::Preload preload);
  91   virtual blink::WebTimeRanges buffered() const;
  92   virtual blink::WebTimeRanges seekable() const;
  93
  94   // Methods for painting.
  95   virtual void paint(blink::WebCanvas* canvas,
  96                      const blink::WebRect& rect,
  97                      unsigned char alpha,
  98                      SkXfermode::Mode mode);
  99
 100   // True if the loaded media has a playable video/audio track.
 101   virtual bool hasVideo() const;
 102   virtual bool hasAudio() const;
 103
 104   // Dimensions of the video.
 105   virtual blink::WebSize naturalSize() const;
 106
 107   // Getters of playback state.
 108   virtual bool paused() const;
 109   virtual bool seeking() const;
 110   virtual double duration() const;
 111   virtual double timelineOffset() const;
 112   virtual double currentTime() const;
 113
 114   // Internal states of loading and network.
 115   // TODO(hclam): Ask the pipeline about the state rather than having reading
 116   // them from members which would cause race conditions.
 117   virtual blink::WebMediaPlayer::NetworkState networkState() const;
 118   virtual blink::WebMediaPlayer::ReadyState readyState() const;
 119
 120   virtual bool didLoadingProgress();
 121
 122   virtual bool hasSingleSecurityOrigin() const;
 123   virtual bool didPassCORSAccessCheck() const;
 124
 125   virtual double mediaTimeForTimeValue(double timeValue) const;
 126
 127   virtual unsigned decodedFrameCount() const;
 128   virtual unsigned droppedFrameCount() const;
 129   virtual unsigned audioDecodedByteCount() const;
 130   virtual unsigned videoDecodedByteCount() const;
 131
 132   virtual bool copyVideoTextureToPlatformTexture(
 133       blink::WebGraphicsContext3D* web_graphics_context,
 134       unsigned int texture,
 135       unsigned int level,
 136       unsigned int internal_format,
 137       unsigned int type,
 138       bool premultiply_alpha,
 139       bool flip_y);
 140
 141   virtual blink::WebAudioSourceProvider* audioSourceProvider();
 142
 143   virtual MediaKeyException generateKeyRequest(
 144       const blink::WebString& key_system,
 145       const unsigned char* init_data,
 146       unsigned init_data_length);
 147
 148   virtual MediaKeyException addKey(const blink::WebString& key_system,
 149                                    const unsigned char* key,
 150                                    unsigned key_length,
 151                                    const unsigned char* init_data,
 152                                    unsigned init_data_length,
 153                                    const blink::WebString& session_id);
 154
 155   virtual MediaKeyException cancelKeyRequest(
 156       const blink::WebString& key_system,
 157       const blink::WebString& session_id);
 158
 159   // TODO(jrummell): Remove this method once Blink updated to use the other
 160   // method.
 161   virtual void setContentDecryptionModule(
 162       blink::WebContentDecryptionModule* cdm);
 163   virtual void setContentDecryptionModule(
 164       blink::WebContentDecryptionModule* cdm,
 165       blink::WebContentDecryptionModuleResult result);
 166
 167   void OnPipelineSeeked(bool time_changed, PipelineStatus status);
 168   void OnPipelineEnded();
 169   void OnPipelineError(PipelineStatus error);
 170   void OnPipelineMetadata(PipelineMetadata metadata);
 171   void OnPipelineBufferingStateChanged(BufferingState buffering_state);
 172   void OnDemuxerOpened();
 173   void OnAddTextTrack(const TextTrackConfig& config,
 174                       const AddTextTrackDoneCB& done_cb);
 175
 176  private:
 177   // Called after |defer_load_cb_| has decided to allow the load. If
 178   // |defer_load_cb_| is null this is called immediately.
 179   void DoLoad(LoadType load_type,
 180               const blink::WebURL& url,
 181               CORSMode cors_mode);
 182
 183   // Called after asynchronous initialization of a data source completed.
 184   void DataSourceInitialized(bool success);
 185
 186   // Called when the data source is downloading or paused.
 187   void NotifyDownloading(bool is_downloading);
 188
 189   // Creates a Renderer that will be used by the |pipeline_|.
 190   scoped_ptr<Renderer> CreateRenderer();
 191
 192   // Finishes starting the pipeline due to a call to load().
 193   void StartPipeline();
 194
 195   // Helpers that set the network/ready state and notifies the client if
 196   // they've changed.
 197   void SetNetworkState(blink::WebMediaPlayer::NetworkState state);
 198   void SetReadyState(blink::WebMediaPlayer::ReadyState state);
 199
 200   // Gets the duration value reported by the pipeline.
 201   double GetPipelineDuration() const;
 202
 203   // Callbacks from |pipeline_| that are forwarded to |client_|.
 204   void OnDurationChanged();
 205   void OnNaturalSizeChanged(gfx::Size size);
 206   void OnOpacityChanged(bool opaque);
 207
 208   // Called by VideoRendererImpl on its internal thread with the new frame to be
 209   // painted.
 210   void FrameReady(const scoped_refptr<VideoFrame>& frame);
 211
 212   // Returns the current video frame from |compositor_|. Blocks until the
 213   // compositor can return the frame.
 214   scoped_refptr<VideoFrame> GetCurrentFrameFromCompositor();
 215
 216   blink::WebLocalFrame* frame_;
 217
 218   // TODO(hclam): get rid of these members and read from the pipeline directly.
 219   blink::WebMediaPlayer::NetworkState network_state_;
 220   blink::WebMediaPlayer::ReadyState ready_state_;
 221
 222   // Preload state for when |data_source_| is created after setPreload().
 223   BufferedDataSource::Preload preload_;
 224
 225   // Task runner for posting tasks on Chrome's main thread. Also used
 226   // for DCHECKs so methods calls won't execute in the wrong thread.
 227   const scoped_refptr<base::SingleThreadTaskRunner> main_task_runner_;
 228
 229   scoped_refptr<base::SingleThreadTaskRunner> media_task_runner_;
 230   scoped_refptr<MediaLog> media_log_;
 231   Pipeline pipeline_;
 232
 233   // The LoadType passed in the |load_type| parameter of the load() call.
 234   LoadType load_type_;
 235
 236   // Cache of metadata for answering hasAudio(), hasVideo(), and naturalSize().
 237   PipelineMetadata pipeline_metadata_;
 238
 239   // Whether the video is known to be opaque or not.
 240   bool opaque_;
 241
 242   // Playback state.
 243   //
 244   // TODO(scherkus): we have these because Pipeline favours the simplicity of a
 245   // single "playback rate" over worrying about paused/stopped etc...  It forces
 246   // all clients to manage the pause+playback rate externally, but is that
 247   // really a bad thing?
 248   //
 249   // TODO(scherkus): since SetPlaybackRate(0) is asynchronous and we don't want
 250   // to hang the render thread during pause(), we record the time at the same
 251   // time we pause and then return that value in currentTime().  Otherwise our
 252   // clock can creep forward a little bit while the asynchronous
 253   // SetPlaybackRate(0) is being executed.
 254   bool paused_;
 255   bool seeking_;
 256   double playback_rate_;
 257   base::TimeDelta paused_time_;
 258
 259   // TODO(scherkus): Replace with an explicit ended signal to HTMLMediaElement,
 260   // see http://crbug.com/409280
 261   bool ended_;
 262
 263   // Seek gets pending if another seek is in progress. Only last pending seek
 264   // will have effect.
 265   bool pending_seek_;
 266   double pending_seek_seconds_;
 267
 268   // Tracks whether to issue time changed notifications during buffering state
 269   // changes.
 270   bool should_notify_time_changed_;
 271
 272   blink::WebMediaPlayerClient* client_;
 273
 274   base::WeakPtr<WebMediaPlayerDelegate> delegate_;
 275
 276   base::Callback<void(const base::Closure&)> defer_load_cb_;
 277
 278   // Factories for supporting video accelerators. May be null.
 279   scoped_refptr<GpuVideoAcceleratorFactories> gpu_factories_;
 280
 281   // Routes audio playback to either AudioRendererSink or WebAudio.
 282   scoped_refptr<WebAudioSourceProviderImpl> audio_source_provider_;
 283
 284   bool supports_save_;
 285
 286   // These two are mutually exclusive:
 287   //   |data_source_| is used for regular resource loads.
 288   //   |chunk_demuxer_| is used for Media Source resource loads.
 289   //
 290   // |demuxer_| will contain the appropriate demuxer based on which resource
 291   // load strategy we're using.
 292   scoped_ptr<BufferedDataSource> data_source_;
 293   scoped_ptr<Demuxer> demuxer_;
 294   ChunkDemuxer* chunk_demuxer_;
 295
 296   BufferedDataSourceHostImpl buffered_data_source_host_;
 297
 298   // Video rendering members.
 299   scoped_refptr<base::SingleThreadTaskRunner> compositor_task_runner_;
 300   VideoFrameCompositor* compositor_;  // Deleted on |compositor_task_runner_|.
 301   SkCanvasVideoRenderer skcanvas_video_renderer_;
 302
 303   // The compositor layer for displaying the video content when using composited
 304   // playback.
 305   scoped_ptr<cc_blink::WebLayerImpl> video_weblayer_;
 306
 307   // Text track objects get a unique index value when they're created.
 308   int text_track_index_;
 309
 310   EncryptedMediaPlayerSupport encrypted_media_support_;
 311
 312   const AudioHardwareConfig& audio_hardware_config_;
 313
 314   scoped_ptr<Renderer> renderer_;
 315
 316   DISALLOW_COPY_AND_ASSIGN(WebMediaPlayerImpl);
 317 };
 318
 319 }  // namespace media
 320
 321 #endif  // MEDIA_BLINK_WEBMEDIAPLAYER_IMPL_H_