Media Controls: change how the MediaControls object is created and handled.

third_party/WebKit/Source/core/html/HTMLMediaElement.cpp

 /*
  * Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 Apple Inc. All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
@@ skipping 402 matching lines @@
       m_processingPreferenceChange(false),
       m_playingRemotely(false),
       m_inOverlayFullscreenVideo(false),
       m_mostlyFillingViewport(false),
       m_audioTracks(this, AudioTrackList::create(*this)),
       m_videoTracks(this, VideoTrackList::create(*this)),
       m_textTracks(this, nullptr),
       m_audioSourceNode(nullptr),
       m_autoplayUmaHelper(AutoplayUmaHelper::create(this)),
       m_remotePlaybackClient(nullptr),
-      m_autoplayVisibilityObserver(nullptr) {
+      m_autoplayVisibilityObserver(nullptr),
+      m_mediaControls(nullptr) {
   BLINK_MEDIA_LOG << "HTMLMediaElement(" << (void*)this << ")";
 
   m_lockedPendingUserGesture = computeLockedPendingUserGesture(document);
   m_lockedPendingUserGestureIfCrossOriginExperimentEnabled =
       isDocumentCrossOrigin(document);
 
   LocalFrame* frame = document.frame();
   if (frame) {
     m_remotePlaybackClient =
         frame->loader().client()->createWebRemotePlaybackClient(*this);
@@ skipping 97 matching lines @@
                     << ", srcAttr, old=" << oldValue << ", new=" << value
                     << ")";
     // Trigger a reload, as long as the 'src' attribute is present.
     if (!value.isNull()) {
       m_ignorePreloadNone = false;
       invokeLoadAlgorithm();
     }
   } else if (name == controlsAttr) {
     UseCounter::count(document(),
                       UseCounter::HTMLMediaElementControlsAttribute);
-    configureMediaControls();
+    updateControlsVisibility();
   } else if (name == preloadAttr) {
     setPlayerPreload();
   } else if (name == disableremoteplaybackAttr) {
     // This attribute is an extension described in the Remote Playback API spec.
     // Please see: https://w3c.github.io/remote-playback
     UseCounter::count(document(), UseCounter::DisableRemotePlaybackAttribute);
     if (oldValue != value) {
       if (m_webMediaPlayer)
         m_webMediaPlayer->requestRemotePlaybackDisabled(!value.isNull());
       // TODO(mlamouri): there is no direct API to expose if
@@ skipping 34 matching lines @@
         m_networkState == kNetworkEmpty) {
       m_ignorePreloadNone = false;
       invokeLoadAlgorithm();
     }
   }
 
   return InsertionShouldCallDidNotifySubtreeInsertions;
 }
 
 void HTMLMediaElement::didNotifySubtreeInsertionsToDocument() {
-  configureMediaControls();
+  updateControlsVisibility();
 }
 
 void HTMLMediaElement::removedFrom(ContainerNode* insertionPoint) {
   BLINK_MEDIA_LOG << "removedFrom(" << (void*)this << ", " << insertionPoint
                   << ")";
 
   HTMLElement::removedFrom(insertionPoint);
   if (insertionPoint->inActiveDocument()) {
-    configureMediaControls();
+    updateControlsVisibility();
     if (m_networkState > kNetworkEmpty)
       pauseInternal();
   }
 }
 
 void HTMLMediaElement::attachLayoutTree(const AttachContext& context) {
   HTMLElement::attachLayoutTree(context);
 
   if (layoutObject())
     layoutObject()->updateFromElement();
@@ skipping 2808 matching lines @@
     return true;
 
   return false;
 }
 
 bool HTMLMediaElement::isFullscreen() const {
   return Fullscreen::isFullscreenElement(*this);
 }
 
 void HTMLMediaElement::didEnterFullscreen() {
-  configureMediaControls();
+  updateControlsVisibility();
+
   // FIXME: There is no embedder-side handling in layout test mode.
   if (webMediaPlayer() && !LayoutTestSupport::isRunningLayoutTest())
     webMediaPlayer()->enteredFullscreen();
   // Cache this in case the player is destroyed before leaving fullscreen.
   m_inOverlayFullscreenVideo = usesOverlayFullscreenVideo();
   if (m_inOverlayFullscreenVideo)
     document().layoutViewItem().compositor()->setNeedsCompositingUpdate(
         CompositingUpdateRebuildTree);
 }
 
 void HTMLMediaElement::didExitFullscreen() {
-  configureMediaControls();
+  updateControlsVisibility();
+
   if (webMediaPlayer())
     webMediaPlayer()->exitedFullscreen();
   if (m_inOverlayFullscreenVideo)
     document().layoutViewItem().compositor()->setNeedsCompositingUpdate(
         CompositingUpdateRebuildTree);
   m_inOverlayFullscreenVideo = false;
 }
 
 WebLayer* HTMLMediaElement::platformLayer() const {
   return m_webLayer;
@@ skipping 140 matching lines @@
                   << boolString(shouldDelay) << ")";
 
   m_shouldDelayLoadEvent = shouldDelay;
   if (shouldDelay)
     document().incrementLoadEventDelayCount();
   else
     document().decrementLoadEventDelayCount();
 }
 
 MediaControls* HTMLMediaElement::mediaControls() const {
-  if (ShadowRoot* shadowRoot = userAgentShadowRoot()) {
-    Node* lastChild = shadowRoot->lastChild();
-    if (lastChild && lastChild->isMediaControls())
-      return toMediaControls(lastChild);
-  }
-
-  return nullptr;
+  return m_mediaControls;
 }
 
 void HTMLMediaElement::ensureMediaControls() {
   if (mediaControls())
     return;
 
-  MediaControls* mediaControls = MediaControls::create(*this);
-  mediaControls->reset();
-
   ShadowRoot& shadowRoot = ensureUserAgentShadowRoot();
-  assertShadowRootChildren(shadowRoot);
+  m_mediaControls = MediaControls::create(*this, shadowRoot);
 
   // The media controls should be inserted after the text track container,
-  // so that they are rendered in front of captions and subtitles.
-  shadowRoot.appendChild(mediaControls);
-
+  // so that they are rendered in front of captions and subtitles. This check
+  // is verifying the contract.
   assertShadowRootChildren(shadowRoot);
-
-  if (!shouldShowControls() || !isConnected())
-    mediaControls->hide();
 }
 
-void HTMLMediaElement::configureMediaControls() {
+void HTMLMediaElement::updateControlsVisibility() {
   if (!isConnected()) {
     if (mediaControls())
       mediaControls()->hide();
     return;
   }
 
   ensureMediaControls();
+  // TODO(mlamouri): this doesn't sound needed but the following tests, on
+  // Android fails when removed:
+  // fullscreen/compositor-touch-hit-rects-fullscreen-video-controls.html
   mediaControls()->reset();
 
   if (shouldShowControls(RecordMetricsBehavior::DoRecord))
     mediaControls()->show();
   else
     mediaControls()->hide();
 }
 
 CueTimeline& HTMLMediaElement::cueTimeline() {
   if (!m_cueTimeline)
@@ skipping 97 matching lines @@
   visitor->trace(m_cueTimeline);
   visitor->trace(m_textTracks);
   visitor->trace(m_textTracksWhenResourceSelectionBegan);
   visitor->trace(m_playPromiseResolvers);
   visitor->trace(m_playPromiseResolveList);
   visitor->trace(m_playPromiseRejectList);
   visitor->trace(m_audioSourceProvider);
   visitor->trace(m_autoplayUmaHelper);
   visitor->trace(m_srcObject);
   visitor->trace(m_autoplayVisibilityObserver);
+  visitor->trace(m_mediaControls);
   visitor->template registerWeakMembers<HTMLMediaElement,
                                         &HTMLMediaElement::clearWeakMembers>(
       this);
   Supplementable<HTMLMediaElement>::trace(visitor);
   HTMLElement::trace(visitor);
   SuspendableObject::trace(visitor);
 }
 
 DEFINE_TRACE_WRAPPERS(HTMLMediaElement) {
   visitor->traceWrappers(m_videoTracks);
@@ skipping 341 matching lines @@
       kMostlyFillViewportBecomeStableSeconds, BLINK_FROM_HERE);
 }
 
 void HTMLMediaElement::viewportFillDebouncerTimerFired(TimerBase*) {
   m_mostlyFillingViewport = true;
   if (m_webMediaPlayer)
     m_webMediaPlayer->becameDominantVisibleContent(m_mostlyFillingViewport);
 }
 
 }  // namespace blink