Implement media cast buttons

Source/core/html/shadow/MediaControls.cpp

 /*
  * Copyright (C) 2011, 2012 Apple Inc. All rights reserved.
  * Copyright (C) 2011, 2012 Google 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 41 matching lines @@
     , m_textDisplayContainer(nullptr)
     , m_overlayPlayButton(nullptr)
     , m_overlayEnclosure(nullptr)
     , m_playButton(nullptr)
     , m_currentTimeDisplay(nullptr)
     , m_timeline(nullptr)
     , m_muteButton(nullptr)
     , m_volumeSlider(nullptr)
     , m_toggleClosedCaptionsButton(nullptr)
     , m_fullScreenButton(nullptr)
+    , m_castButton(nullptr)
+    , m_overlayCastButton(nullptr)
     , m_durationDisplay(nullptr)
     , m_enclosure(nullptr)
     , m_hideMediaControlsTimer(this, &MediaControls::hideMediaControlsTimerFired)
     , m_isMouseOverControls(false)
     , m_isPausedForScrubbing(false)
     , m_wasLastEventTouch(false)
 {
 }
 
 PassRefPtrWillBeRawPtr<MediaControls> MediaControls::create(HTMLMediaElement& mediaElement)
 {
     RefPtrWillBeRawPtr<MediaControls> controls = adoptRefWillBeNoop(new MediaControls(mediaElement));
 
     if (controls->initializeControls())
         return controls.release();
 
     return nullptr;
 }
 
 bool MediaControls::initializeControls()
 {
     TrackExceptionState exceptionState;
 
+    RefPtrWillBeRawPtr<MediaControlOverlayEnclosureElement> overlayEnclosure = MediaControlOverlayEnclosureElement::create(*this);
+
     if (document().settings() && document().settings()->mediaControlsOverlayPlayButtonEnabled()) {
-        RefPtrWillBeRawPtr<MediaControlOverlayEnclosureElement> overlayEnclosure = MediaControlOverlayEnclosureElement::create(*this);
         RefPtrWillBeRawPtr<MediaControlOverlayPlayButtonElement> overlayPlayButton = MediaControlOverlayPlayButtonElement::create(*this);
         m_overlayPlayButton = overlayPlayButton.get();
         overlayEnclosure->appendChild(overlayPlayButton.release(), exceptionState);
         if (exceptionState.hadException())
             return false;
+    }
 
-        m_overlayEnclosure = overlayEnclosure.get();
-        appendChild(overlayEnclosure.release(), exceptionState);
-        if (exceptionState.hadException())
-            return false;
-    }
+    RefPtrWillBeRawPtr<MediaControlCastButtonElement> overlayCastButton = MediaControlCastButtonElement::create(*this, true);
+    m_overlayCastButton = overlayCastButton.get();
+    overlayEnclosure->appendChild(overlayCastButton.release(), exceptionState);
+    if (exceptionState.hadException())
+        return false;
+
+    m_overlayEnclosure = overlayEnclosure.get();
+    appendChild(overlayEnclosure.release(), exceptionState);
+    if (exceptionState.hadException())
+        return false;
 
     // Create an enclosing element for the panel so we can visually offset the controls correctly.
     RefPtrWillBeRawPtr<MediaControlPanelEnclosureElement> enclosure = MediaControlPanelEnclosureElement::create(*this);
 
     RefPtrWillBeRawPtr<MediaControlPanelElement> panel = MediaControlPanelElement::create(*this);
 
     RefPtrWillBeRawPtr<MediaControlPlayButtonElement> playButton = MediaControlPlayButtonElement::create(*this);
     m_playButton = playButton.get();
     panel->appendChild(playButton.release(), exceptionState);
     if (exceptionState.hadException())
@@ skipping 29 matching lines @@
     panel->appendChild(slider.release(), exceptionState);
     if (exceptionState.hadException())
         return false;
 
     RefPtrWillBeRawPtr<MediaControlToggleClosedCaptionsButtonElement> toggleClosedCaptionsButton = MediaControlToggleClosedCaptionsButtonElement::create(*this);
     m_toggleClosedCaptionsButton = toggleClosedCaptionsButton.get();
     panel->appendChild(toggleClosedCaptionsButton.release(), exceptionState);
     if (exceptionState.hadException())
         return false;
 
+    RefPtrWillBeRawPtr<MediaControlCastButtonElement> castButton = MediaControlCastButtonElement::create(*this, false);
+    m_castButton = castButton.get();
+    panel->appendChild(castButton.release(), exceptionState);
+    if (exceptionState.hadException())
+        return false;
+
     RefPtrWillBeRawPtr<MediaControlFullscreenButtonElement> fullscreenButton = MediaControlFullscreenButtonElement::create(*this);
     m_fullScreenButton = fullscreenButton.get();
     panel->appendChild(fullscreenButton.release(), exceptionState);
     if (exceptionState.hadException())
         return false;
 
     m_panel = panel.get();
     enclosure->appendChild(panel.release(), exceptionState);
     if (exceptionState.hadException())
         return false;
@@ skipping 25 matching lines @@
         m_volumeSlider->show();
     updateVolume();
 
     refreshClosedCaptionsButtonVisibility();
 
     if (mediaElement().hasVideo() && fullscreenIsSupported(document()))
         m_fullScreenButton->show();
     else
         m_fullScreenButton->hide();
 
+    refreshCastButtonVisibility();
     makeOpaque();
 }
 
 void MediaControls::show()
 {
     makeOpaque();
     m_panel->setIsDisplayed(true);
     m_panel->show();
     if (m_overlayPlayButton)
         m_overlayPlayButton->updateDisplayType();
 }
 
 void MediaControls::mediaElementFocused()
 {
     show();
-    stopHideMediaControlsTimer();
+    resetHideMediaControlsTimer();
 }
 
 void MediaControls::hide()
 {
     m_panel->setIsDisplayed(false);
     m_panel->hide();
     if (m_overlayPlayButton)
         m_overlayPlayButton->hide();
 }
 
@@ skipping 126 matching lines @@
         m_toggleClosedCaptionsButton->show();
     else
         m_toggleClosedCaptionsButton->hide();
 }
 
 void MediaControls::textTracksChanged()
 {
     refreshClosedCaptionsButtonVisibility();
 }
 
+void MediaControls::refreshCastButtonVisibility()
+{
+    if (mediaElement().hasRemoteRoutes()) {
+        // The reason for the autoplay test is that some pages (e.g. vimeo.com) have an autoplay background video, which
+        // doesn't autoplay on Chrome for Android (we prevent it) so starts paused. In such cases we don't want to automatically
+        // show the cast button, since it looks strange and is unlikely to correspond with anything the user wants to do.
+        // If a user does want to cast a paused autoplay video then they can still do so by touching or clicking on the
+        // video, which will cause the cast button to appear.
+        if (!mediaElement().shouldShowControls() && !mediaElement().autoplay() && mediaElement().paused()) {
+            showOverlayCastButton();
+        } else if (mediaElement().shouldShowControls()) {
+            m_overlayCastButton->hide();
+            m_castButton->show();
+        }
+    } else {
+        m_castButton->hide();
+        m_overlayCastButton->hide();
+    }
+}
+
+void MediaControls::showOverlayCastButton()
+{
+    m_overlayCastButton->show();
+    resetHideMediaControlsTimer();
+}
+
 void MediaControls::enteredFullscreen()
 {
     m_fullScreenButton->setIsFullscreen(true);
     stopHideMediaControlsTimer();
     startHideMediaControlsTimer();
 }
 
 void MediaControls::exitedFullscreen()
 {
     m_fullScreenButton->setIsFullscreen(false);
     stopHideMediaControlsTimer();
     startHideMediaControlsTimer();
 }
 
+void MediaControls::startedCasting()
+{
+    m_castButton->setIsPlayingRemotely(true);
+    m_overlayCastButton->setIsPlayingRemotely(true);
+}
+
+void MediaControls::stoppedCasting()
+{
+    m_castButton->setIsPlayingRemotely(false);
+    m_overlayCastButton->setIsPlayingRemotely(false);
+}
+
 void MediaControls::defaultEventHandler(Event* event)
 {
     HTMLDivElement::defaultEventHandler(event);
     m_wasLastEventTouch = event->isTouchEvent() || event->isGestureEvent()
         || (event->isMouseEvent() && toMouseEvent(event)->fromTouch());
 
     if (event->type() == EventTypeNames::mouseover) {
         if (!containsRelatedTarget(event)) {
             m_isMouseOverControls = true;
             if (!mediaElement().togglePlayStateWillPlay()) {
@@ skipping 29 matching lines @@
         return;
 
     unsigned behaviorFlags = IgnoreFocus | IgnoreVideoHover;
     if (m_wasLastEventTouch) {
         behaviorFlags |= IgnoreControlsHover;
     }
     if (!shouldHideMediaControls(behaviorFlags))
         return;
 
     makeTransparent();
+    m_overlayCastButton->hide();
 }
 
 void MediaControls::startHideMediaControlsTimer()
 {
     m_hideMediaControlsTimer.startOneShot(timeWithoutMouseMovementBeforeHidingMediaControls, FROM_HERE);
 }
 
 void MediaControls::stopHideMediaControlsTimer()
 {
     m_hideMediaControlsTimer.stop();
 }
 
+void MediaControls::resetHideMediaControlsTimer()
+{
+    stopHideMediaControlsTimer();
+    if (!mediaElement().paused())
+        startHideMediaControlsTimer();
+}
+
+
 const AtomicString& MediaControls::shadowPseudoId() const
 {
     DEFINE_STATIC_LOCAL(AtomicString, id, ("-webkit-media-controls"));
     return id;
 }
 
 bool MediaControls::containsRelatedTarget(Event* event)
 {
     if (!event->isMouseEvent())
         return false;
     EventTarget* relatedTarget = toMouseEvent(event)->relatedTarget();
     if (!relatedTarget)
         return false;
     return contains(relatedTarget->toNode());
 }
 
 void MediaControls::createTextTrackDisplay()
 {
     if (m_textDisplayContainer)
         return;
 
     RefPtrWillBeRawPtr<MediaControlTextTrackContainerElement> textDisplayContainer = MediaControlTextTrackContainerElement::create(*this);
     m_textDisplayContainer = textDisplayContainer.get();
 
     // Insert it before (behind) all other control elements.
-    if (m_overlayEnclosure && m_overlayPlayButton)
+    if (m_overlayPlayButton)
         m_overlayEnclosure->insertBefore(textDisplayContainer.release(), m_overlayPlayButton);
     else
-        insertBefore(textDisplayContainer.release(), m_enclosure);
+        m_overlayEnclosure->insertBefore(textDisplayContainer.release(), m_overlayCastButton);
 }
 
 void MediaControls::showTextTrackDisplay()
 {
     if (!m_textDisplayContainer)
         createTextTrackDisplay();
     m_textDisplayContainer->show();
 }
 
 void MediaControls::hideTextTrackDisplay()
@@ skipping 20 matching lines @@
     visitor->trace(m_overlayEnclosure);
     visitor->trace(m_playButton);
     visitor->trace(m_currentTimeDisplay);
     visitor->trace(m_timeline);
     visitor->trace(m_muteButton);
     visitor->trace(m_volumeSlider);
     visitor->trace(m_toggleClosedCaptionsButton);
     visitor->trace(m_fullScreenButton);
     visitor->trace(m_durationDisplay);
     visitor->trace(m_enclosure);
+    visitor->trace(m_castButton);
+    visitor->trace(m_overlayCastButton);
     HTMLDivElement::trace(visitor);
 }
 
 }