Send AndroidOverlay routing token from WMPI to AVDA.

media/blink/webmediaplayer_impl.h

 // Copyright 2013 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 MEDIA_BLINK_WEBMEDIAPLAYER_IMPL_H_
 #define MEDIA_BLINK_WEBMEDIAPLAYER_IMPL_H_
 
 #include <stdint.h>
 
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "base/cancelable_callback.h"
 #include "base/compiler_specific.h"
 #include "base/macros.h"
 #include "base/memory/linked_ptr.h"
 #include "base/memory/memory_pressure_listener.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/weak_ptr.h"
 #include "base/optional.h"
 #include "base/threading/thread.h"
 #include "base/time/default_tick_clock.h"
 #include "base/time/time.h"
 #include "base/timer/elapsed_timer.h"
 #include "base/timer/timer.h"
 #include "build/build_config.h"
 #include "media/base/media_observer.h"
 #include "media/base/media_tracks.h"
+#include "media/base/overlay_info.h"
 #include "media/base/pipeline_impl.h"
 #include "media/base/renderer_factory_selector.h"
 #include "media/base/surface_manager.h"
 #include "media/base/text_track.h"
 #include "media/blink/buffered_data_source_host_impl.h"
 #include "media/blink/media_blink_export.h"
 #include "media/blink/multibuffer_data_source.h"
 #include "media/blink/video_frame_compositor.h"
 #include "media/blink/webmediaplayer_delegate.h"
 #include "media/blink/webmediaplayer_params.h"
@@ skipping 205 matching lines @@
     bool is_suspended;
   };
 
  private:
   friend class WebMediaPlayerImplTest;
   friend class WebMediaPlayerImplBackgroundBehaviorTest;
 
   void EnableOverlay();
   void DisableOverlay();
 
+  // Do we have overlay information?  For CVV, this is a surface id.  For
+  // AndroidOverlay, this is the routing token.
+  bool HaveOverlayInfo();
+
+  // Send the overlay's SurfaceID or routing token.  If the decoder didn't
+  // supply a callback for it, then do nothing.
+  void SendOverlayInfoToDecoder();
+
   void OnPipelineSuspended();
   void OnBeforePipelineResume();
   void OnPipelineResumed();
   void OnDemuxerOpened();
 
   // Pipeline::Client overrides.
   void OnError(PipelineStatus status) override;
   void OnEnded() override;
   void OnMetadata(PipelineMetadata metadata) override;
   void OnBufferingStateChange(BufferingState state) override;
@@ skipping 17 matching lines @@
 
   // Called after asynchronous initialization of a data source completed.
   void DataSourceInitialized(bool success);
 
   // Called when the data source is downloading or paused.
   void NotifyDownloading(bool is_downloading);
 
   // Called by SurfaceManager when a surface is created.
   void OnSurfaceCreated(int surface_id);
 
+  // Called by RenderFrameImpl with the overlay routing token, if we request it.
+  void OnOverlayRoutingToken(const base::UnguessableToken& token);
+
   // Called by GpuVideoDecoder on Android to request a surface to render to (if
   // necessary).
-  void OnSurfaceRequested(bool decoder_requires_restart_for_overlay,
-                          const SurfaceCreatedCB& surface_created_cb);
+  void OnOverlayInfoRequested(
+      bool decoder_requires_restart_for_overlay,
+      const ProvideOverlayInfoCB& provide_overlay_info_cb);
 
   // Creates a Renderer via the |renderer_factory_selector_|.
   std::unique_ptr<Renderer> CreateRenderer();
 
   // Finishes starting the pipeline due to a call to load().
   void StartPipeline();
 
   // Restart the player/pipeline as soon as possible. This will destroy the
   // current renderer, if any, and create a new one via the RendererFactory; and
   // then seek to resume playback at the current position.
@@ skipping 331 matching lines @@
   SurfaceManager* surface_manager_;
 
   // For canceling ongoing surface creation requests when exiting fullscreen.
   base::CancelableCallback<void(int)> surface_created_cb_;
 
   // The current overlay surface id. Populated, possibly with kNoSurfaceID if
   // we're not supposed to use an overlay, unless we have an outstanding surface
   // request to the SurfaceManager.
   base::Optional<int> overlay_surface_id_;
 
-  // If a surface is requested before it's finished being created, the request
-  // is saved and satisfied once the surface is available. If the decoder does
-  // not require restart to change surfaces, this is callback is kept until
-  // cleared by the decoder.
-  SurfaceCreatedCB set_surface_cb_;
+  // For canceling AndroidOverlay routing token requests.
+  base::CancelableCallback<void(const base::UnguessableToken&)>
+      token_available_cb_;
+
+  // If overlay info is requested before we have it, then the request is saved
+  // and satisfied once the overlay info is available. If the decoder does not
+  // require restart to change surfaces, this is callback is kept until cleared
+  // by the decoder.
+  ProvideOverlayInfoCB provide_overlay_info_cb_;
 
   // On Android an overlay surface means using
   // SurfaceView instead of SurfaceTexture.
 
   // Use overlays for all video.
   bool force_video_overlays_;
 
-  // Use overlays for fullscreen video.
-  // (Implied if |force_video_overlays_| is true.)
-  bool enable_fullscreen_video_overlays_;
-
   // Suppresses calls to OnPipelineError() after destruction / shutdown has been
   // started; prevents us from spuriously logging errors that are transient or
   // unimportant.
   bool suppress_destruction_errors_;
 
   // If true, the media pipeline can be suspended.
   const bool suspend_enabled_;
 
   // Used for HLS playback and in certain fallback paths (e.g. on older devices
   // that can't support the unified media pipeline).
@@ skipping 64 matching lines @@
   // Whether embedded media experience is currently enabled.
   bool embedded_media_experience_enabled_ = false;
 
   gfx::Size last_uploaded_frame_size_;
   base::TimeDelta last_uploaded_frame_timestamp_;
 
   base::CancelableCallback<void(base::TimeTicks)> frame_time_report_cb_;
 
   bool initial_video_height_recorded_ = false;
 
+  enum class OverlayMode {
+    // All overlays are turned off.
+    kNoOverlays,
+
+    // Use ContentVideoView for overlays.
+    kUseContentVideoView,
+
+    // Use AndroidOverlay for overlays.
+    kUseAndroidOverlay,
+  };
+
+  OverlayMode overlay_mode_ = OverlayMode::kNoOverlays;
+
+  // Optional callback to request the routing token for AndroidOverlay.
+  RequestRoutingTokenCallback request_routing_token_cb_;
+
+  // Routing token, if we have one.  No value if we have a request pending to
+  // get it via |request_routing_token_cb_|.  A null token indicates that we
+  // have no token, which can't be sent via IPC.

[tguilbert, 2017/05/08 23:10:29]

Can you clarify the states in this comment? IIUC,
if has_value, we have one.
if !has_value, we are waiting for one
if has_value and value.is_empty, we never requested the token, and we can't send
it?

NINJA EDIT: I think that the thing that confused me is the 'A null token'. Can
you change it to An empty token?

[liberato (no reviews please), 2017/05/09 16:55:37]

s/null/empty/: Done

for has_value && is_empty, we did request a token, but the answer was "no".

+  base::Optional<base::UnguessableToken> overlay_routing_token_;
+
   DISALLOW_COPY_AND_ASSIGN(WebMediaPlayerImpl);
 };
 
 }  // namespace media
 
 #endif  // MEDIA_BLINK_WEBMEDIAPLAYER_IMPL_H_