Improve detection of touch events when hiding media controls.

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 27 matching lines @@
 
 // If you change this value, then also update the corresponding value in
 // LayoutTests/media/media-controls.js.
 static const double timeWithoutMouseMovementBeforeHidingMediaControls = 3;
 
 static bool fullscreenIsSupported(const Document& document)
 {
     return !document.settings() || document.settings()->fullscreenSupported();
 }
 
-static bool deviceSupportsMouse(const Document& document)
-{
-    return !document.settings() || document.settings()->deviceSupportsMouse();
-}
-
 MediaControls::MediaControls(HTMLMediaElement& mediaElement)
     : HTMLDivElement(mediaElement.document())
     , m_mediaElement(&mediaElement)
     , m_panel(nullptr)
     , 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_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();
 
@@ skipping 135 matching lines @@
     m_panel->hide();
     if (m_overlayPlayButton)
         m_overlayPlayButton->hide();
 }
 
 void MediaControls::makeOpaque()
 {
     m_panel->makeOpaque();
 }
 
+void MediaControls::makeOpaqueIfNeeded(Event* event)
+{
+    // Fake mouse events generated by blink that do not derive from
+    // real input should not make the controls visible.
+    if (event->isMouseEvent() && toMouseEvent(event)->notFromInput())
+        return;
+
+    makeOpaque();
+}
+
 void MediaControls::makeTransparent()
 {
     m_panel->makeTransparent();
 }
 
 bool MediaControls::shouldHideMediaControls(unsigned behaviorFlags) const
 {
     // Never hide for a media element without visual representation.
     if (!mediaElement().hasVideo())
         return false;
@@ skipping 128 matching lines @@
 void MediaControls::exitedFullscreen()
 {
     m_fullScreenButton->setIsFullscreen(false);
     stopHideMediaControlsTimer();
     startHideMediaControlsTimer();
 }
 
 void MediaControls::defaultEventHandler(Event* event)
 {
     HTMLDivElement::defaultEventHandler(event);
+    m_wasLastEventTouch = event->isTouchEvent() || (event->isMouseEvent() && toMouseEvent(event)->fromTouch());

[Rick Byers, 2014/08/22 18:11:13]

Do you really want to consider touch events here?  Or would you be better off
bailing out of the function when event->isMouseEvent() is false (i.e. tracking
only whether the last mouse event was from touch).

If you want to handle all types of events in this logic, then you should
probably consider gesture events too (which always come from touch input).

[Ignacio Solla, 2014/08/26 13:40:53]

Good catch, I consider gesture events now too.

I assume that the cursor will hide with both gesture events, touch events and
fromTouch mouse events, so we need to track the last event, not just the last
mouse event. Otherwise we will still be showing the controls forever without the
mouse pointer hovering them.

[Rick Byers, 2014/08/26 15:25:46]

I see.  Seems fine to me.  Ideally maybe this would be more coupled to cursor
visibility state, but that's perhaps not currently reliable enough to take a
hard dependency on (I know tdanderson@ hit all sorts of edge cases on windows
where it was hard to know precisely).

[Ignacio Solla, 2014/08/26 17:30:42]

Acknowledged.

 
     if (event->type() == EventTypeNames::mouseover) {
         if (!containsRelatedTarget(event)) {
             m_isMouseOverControls = true;
             if (!mediaElement().togglePlayStateWillPlay()) {
-                makeOpaque();
+                makeOpaqueIfNeeded(event);
                 if (shouldHideMediaControls())
                     startHideMediaControlsTimer();
             }
         }
         return;
     }
 
     if (event->type() == EventTypeNames::mouseout) {
         if (!containsRelatedTarget(event)) {
             m_isMouseOverControls = false;
             stopHideMediaControlsTimer();
         }
         return;
     }
 
     if (event->type() == EventTypeNames::mousemove) {
         // When we get a mouse move, show the media controls, and start a timer
         // that will hide the media controls after a 3 seconds without a mouse move.
-        makeOpaque();
+        makeOpaqueIfNeeded(event);
         if (shouldHideMediaControls(IgnoreVideoHover))
             startHideMediaControlsTimer();
         return;
     }
 }
 
 void MediaControls::hideMediaControlsTimerFired(Timer<MediaControls>*)
 {
     if (mediaElement().togglePlayStateWillPlay())
         return;
 
     unsigned behaviorFlags = IgnoreFocus | IgnoreVideoHover;
-    // FIXME: improve this check, see http://www.crbug.com/401177.
-    if (!deviceSupportsMouse(document())) {
+    if (m_wasLastEventTouch) {
         behaviorFlags |= IgnoreControlsHover;
     }
     if (!shouldHideMediaControls(behaviorFlags))
         return;
 
     makeTransparent();
 }
 
 void MediaControls::startHideMediaControlsTimer()
 {
@@ skipping 71 matching lines @@
     visitor->trace(m_muteButton);
     visitor->trace(m_volumeSlider);
     visitor->trace(m_toggleClosedCaptionsButton);
     visitor->trace(m_fullScreenButton);
     visitor->trace(m_durationDisplay);
     visitor->trace(m_enclosure);
     HTMLDivElement::trace(visitor);
 }
 
 }