Changeset 213161 in webkit

Timestamp:

Feb 28, 2017 11:42:20 AM (7 years ago)

Author:

mrajca@apple.com

Message:

Media: notify clients when autoplayed media ends without being paused
​https://bugs.webkit.org/show_bug.cgi?id=168852

Reviewed by Alex Christensen.

Source/WebCore:

Added API tests.

• html/HTMLMediaElement.cpp:

(WebCore::HTMLMediaElement::setReadyState):

Set state accordingly if we autoplayed or if playback was prevented.

(WebCore::HTMLMediaElement::play):

Update state if playback was prevented.

(WebCore::HTMLMediaElement::playInternal):

Update state if playback began without user interaction.

(WebCore::HTMLMediaElement::pauseInternal):

Update state.

(WebCore::HTMLMediaElement::mediaPlayerTimeChanged):

If playback ends and it began without user interaction, send a DidPlayMediaWithoutInterference event.

(WebCore::HTMLMediaElement::stopWithoutDestroyingMediaPlayer): Ditto.

• html/HTMLMediaElement.h:
• page/AutoplayEvent.h:

Source/WebKit2:

• UIProcess/API/C/WKPageUIClient.h:

Tools:

• TestWebKitAPI/Tests/WebKit2/js-play-with-controls.html:
• TestWebKitAPI/Tests/WebKit2Cocoa/WebsitePolicies.mm:

(TEST): Added.

Location:

trunk

Files:

• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/html/HTMLMediaElement.cpp (modified) (7 diffs)
• Source/WebCore/html/HTMLMediaElement.h (modified) (2 diffs)
• Source/WebCore/page/AutoplayEvent.h (modified) (1 diff)
• Source/WebKit2/ChangeLog (modified) (1 diff)
• Source/WebKit2/UIProcess/API/C/WKPageUIClient.h (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKit2/js-play-with-controls.html (modified) (1 diff)
• Tools/TestWebKitAPI/Tests/WebKit2Cocoa/WebsitePolicies.mm (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2017-02-24  Matt Rajca  <mrajca@apple.com>
+
+        Media: notify clients when autoplayed media ends without being paused
+        https://bugs.webkit.org/show_bug.cgi?id=168852
+
+        Reviewed by Alex Christensen.
+
+        Added API tests.
+
+        * html/HTMLMediaElement.cpp:
+        (WebCore::HTMLMediaElement::setReadyState):
+         Set state accordingly if we autoplayed or if playback was prevented.
+        (WebCore::HTMLMediaElement::play):
+         Update state if playback was prevented.
+        (WebCore::HTMLMediaElement::playInternal):
+         Update state if playback began without user interaction.
+        (WebCore::HTMLMediaElement::pauseInternal):
+         Update state.
+        (WebCore::HTMLMediaElement::mediaPlayerTimeChanged):
+         If playback ends and it began without user interaction, send a DidPlayMediaWithoutInterference event.
+        (WebCore::HTMLMediaElement::stopWithoutDestroyingMediaPlayer): Ditto.
+        * html/HTMLMediaElement.h:
+        * page/AutoplayEvent.h:
+
 2017-02-27  Dave Hyatt  <hyatt@apple.com>
 

trunk/Source/WebCore/html/HTMLMediaElement.cpp

@@ -2417 +2417 @@
             m_paused = false;
             invalidateCachedTime();
+            m_playbackWithoutUserGesture = PlaybackWithoutUserGesture::Started;
             m_playbackStartedTime = currentMediaTime().toDouble();
             scheduleEvent(eventNames().playEvent);
             scheduleNotifyAboutPlaying();
         } else if (success.value() == MediaPlaybackDenialReason::UserGestureRequired) {
-            m_preventedFromPlayingWithoutUserGesture = true;
+            m_playbackWithoutUserGesture = PlaybackWithoutUserGesture::Prevented;
 
             if (Page* page = document().page())
@@ -3105 +3106 @@
     if (!success) {
         if (success.value() == MediaPlaybackDenialReason::UserGestureRequired) {
-            m_preventedFromPlayingWithoutUserGesture = true;
+            m_playbackWithoutUserGesture = PlaybackWithoutUserGesture::Prevented;
 
             if (Page* page = document().page())
@@ -3137 +3138 @@
     if (!success) {
         if (success.value() == MediaPlaybackDenialReason::UserGestureRequired) {
-            m_preventedFromPlayingWithoutUserGesture = true;
+            m_playbackWithoutUserGesture = PlaybackWithoutUserGesture::Prevented;
 
             if (Page* page = document().page())
@@ -3208 +3209 @@
         scheduleResolvePendingPlayPromises();
 
-    if (ScriptController::processingUserGestureForMedia() && m_preventedFromPlayingWithoutUserGesture) {
-        if (Page* page = document().page())
-            page->chrome().client().handleAutoplayEvent(AutoplayEvent::DidPlayMediaPreventedFromPlaying);
-        m_preventedFromPlayingWithoutUserGesture = false;
-    }
+    if (ScriptController::processingUserGestureForMedia()) {
+        if (m_playbackWithoutUserGesture == PlaybackWithoutUserGesture::Prevented) {
+            if (Page* page = document().page())
+                page->chrome().client().handleAutoplayEvent(AutoplayEvent::DidPlayMediaPreventedFromPlaying);
+            m_playbackWithoutUserGesture = PlaybackWithoutUserGesture::None;
+        }
+    } else
+        m_playbackWithoutUserGesture = PlaybackWithoutUserGesture::Started;
 
     m_autoplaying = false;
@@ -3253 +3257 @@
 
     m_autoplaying = false;
+    m_playbackWithoutUserGesture = PlaybackWithoutUserGesture::None;
 
     if (!m_paused) {
@@ -4402 +4407 @@
                 if (!wasSeeking)
                     addBehaviorRestrictionsOnEndIfNecessary();
+
+                if (m_playbackWithoutUserGesture == PlaybackWithoutUserGesture::Started) {
+                    if (Page* page = document().page())
+                        page->chrome().client().handleAutoplayEvent(AutoplayEvent::DidEndMediaPlaybackWithoutUserInterference);
+                }
+                m_playbackWithoutUserGesture = PlaybackWithoutUserGesture::None;
             }
             // If the media element has a current media controller, then report the controller state
@@ -5157 +5168 @@
     setPausedInternal(true);
     m_mediaSession->clientWillPausePlayback();
+
+    if (m_playbackWithoutUserGesture == PlaybackWithoutUserGesture::Started) {
+        if (Page* page = document().page())
+            page->chrome().client().handleAutoplayEvent(AutoplayEvent::DidEndMediaPlaybackWithoutUserInterference);
+    }
+    m_playbackWithoutUserGesture = PlaybackWithoutUserGesture::None;
 
     userCancelledLoad();

trunk/Source/WebCore/html/HTMLMediaElement.h

@@ -975 +975 @@
     bool m_receivedLayoutSizeChanged : 1;
     bool m_hasEverNotifiedAboutPlaying : 1;
-    bool m_preventedFromPlayingWithoutUserGesture : 1;
 
     bool m_hasEverHadAudio : 1;
@@ -991 +990 @@
     bool m_haveVisibleTextTrack : 1;
     bool m_processingPreferenceChange : 1;
+
+    enum class PlaybackWithoutUserGesture { None, Started, Prevented };
+    PlaybackWithoutUserGesture m_playbackWithoutUserGesture;
 
     String m_subtitleTrackLanguage;

trunk/Source/WebCore/page/AutoplayEvent.h

@@ -31 +31 @@
     DidPreventMediaFromPlaying,
     DidPlayMediaPreventedFromPlaying,
+    DidEndMediaPlaybackWithoutUserInterference,
 };
 

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2017-02-24  Matt Rajca  <mrajca@apple.com>
+
+        Media: notify clients when autoplayed media ends without being paused
+        https://bugs.webkit.org/show_bug.cgi?id=168852
+
+        Reviewed by Alex Christensen.
+
+        * UIProcess/API/C/WKPageUIClient.h:
+
 2017-02-28  Csaba Osztrogonác  <ossy@webkit.org>
 

trunk/Source/WebKit2/UIProcess/API/C/WKPageUIClient.h

@@ -52 +52 @@
     kWKAutoplayEventDidPreventFromAutoplaying,
     kWKAutoplayEventDidPlayMediaPreventedFromAutoplaying,
+    kWKAutoplayEventDidEndMediaPlaybackWithoutUserInterference,
 };
 typedef uint32_t WKAutoplayEvent;

trunk/Tools/ChangeLog

@@ +1 @@
+2017-02-24  Matt Rajca  <mrajca@apple.com>
+
+        Media: notify clients when autoplayed media ends without being paused
+        https://bugs.webkit.org/show_bug.cgi?id=168852
+
+        Reviewed by Alex Christensen.
+
+        * TestWebKitAPI/Tests/WebKit2/js-play-with-controls.html:
+        * TestWebKitAPI/Tests/WebKit2Cocoa/WebsitePolicies.mm:
+        (TEST): Added.
+
 2017-02-28  Jonathan Bedard  <jbedard@apple.com>
 

trunk/Tools/TestWebKitAPI/Tests/WebKit2/js-play-with-controls.html

@@ -12 +12 @@
                 document.getElementById("video").play();
             }
+
+            function beganPlaying() {
+                try {
+                    window.webkit.messageHandlers.testHandler.postMessage("playing");
+                } catch(e) { }
+            }
+
+            function endedPlaying() {
+                try {
+                    window.webkit.messageHandlers.testHandler.postMessage("ended");
+                } catch(e) { }
+            }
         </script>
     </head>
     <body onload="pageLoaded()">
         <button onclick="play()">Play</button>
-        <video id="video" src="test.mp4" />
+        <video id="video" onplaying=beganPlaying() onended=endedPlaying() src="test.mp4" />
     </body>
 </html>

trunk/Tools/TestWebKitAPI/Tests/WebKit2Cocoa/WebsitePolicies.mm

@@ -317 +317 @@
     ASSERT_TRUE(receivedAutoplayEvent == std::nullopt);
 }
-#endif
-
-#endif
+
+TEST(WebKit2, WebsitePoliciesPlayingWithoutInterference)
+{
+    auto configuration = adoptNS([[WKWebViewConfiguration alloc] init]);
+    auto webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 336, 276) configuration:configuration.get()]);
+
+    auto delegate = adoptNS([[AutoplayPoliciesDelegate alloc] init]);
+    [delegate setAutoplayPolicyForURL:^(NSURL *) {
+        return _WKWebsiteAutoplayPolicyAllow;
+    }];
+    [webView setNavigationDelegate:delegate.get()];
+
+    WKPageUIClientV9 uiClient;
+    memset(&uiClient, 0, sizeof(uiClient));
+
+    uiClient.base.version = 9;
+    uiClient.handleAutoplayEvent = handleAutoplayEvent;
+
+    WKPageSetPageUIClient([webView _pageForTesting], &uiClient.base);
+
+    receivedAutoplayEvent = std::nullopt;
+    NSURLRequest *jsPlayRequest = [NSURLRequest requestWithURL:[[NSBundle mainBundle] URLForResource:@"js-play-with-controls" withExtension:@"html" subdirectory:@"TestWebKitAPI.resources"]];
+    [webView loadRequest:jsPlayRequest];
+    [webView waitForMessage:@"playing"];
+
+    ASSERT_TRUE(receivedAutoplayEvent == std::nullopt);
+
+    [webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"about:blank"]]];
+    runUntilReceivesAutoplayEvent(kWKAutoplayEventDidEndMediaPlaybackWithoutUserInterference);
+
+    receivedAutoplayEvent = std::nullopt;
+    [webView loadRequest:jsPlayRequest];
+    [webView waitForMessage:@"ended"];
+    runUntilReceivesAutoplayEvent(kWKAutoplayEventDidEndMediaPlaybackWithoutUserInterference);
+}
+#endif
+
+#endif