<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[213246] trunk</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/213246">213246</a></dd>
<dt>Author</dt> <dd>mrajca@apple.com</dd>
<dt>Date</dt> <dd>2017-03-01 14:43:04 -0800 (Wed, 01 Mar 2017)</dd>
</dl>
<h3>Log Message</h3>
<pre>Media: notify clients when autoplayed media is muted
https://bugs.webkit.org/show_bug.cgi?id=168987
Reviewed by Alex Christensen.
Source/WebCore:
Added API tests.
* html/HTMLMediaElement.cpp:
(WebCore::HTMLMediaElement::setMuted):
(WebCore::HTMLMediaElement::pageMutedStateDidChange):
* 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.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebCoreChangeLog">trunk/Source/WebCore/ChangeLog</a></li>
<li><a href="#trunkSourceWebCorehtmlHTMLMediaElementcpp">trunk/Source/WebCore/html/HTMLMediaElement.cpp</a></li>
<li><a href="#trunkSourceWebCorepageAutoplayEventh">trunk/Source/WebCore/page/AutoplayEvent.h</a></li>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICWKPageUIClienth">trunk/Source/WebKit2/UIProcess/API/C/WKPageUIClient.h</a></li>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
<li><a href="#trunkToolsTestWebKitAPITestsWebKit2jsplaywithcontrolshtml">trunk/Tools/TestWebKitAPI/Tests/WebKit2/js-play-with-controls.html</a></li>
<li><a href="#trunkToolsTestWebKitAPITestsWebKit2CocoaWebsitePoliciesmm">trunk/Tools/TestWebKitAPI/Tests/WebKit2Cocoa/WebsitePolicies.mm</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebCoreChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/ChangeLog (213245 => 213246)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/ChangeLog        2017-03-01 22:39:31 UTC (rev 213245)
+++ trunk/Source/WebCore/ChangeLog        2017-03-01 22:43:04 UTC (rev 213246)
</span><span class="lines">@@ -1,3 +1,17 @@
</span><ins>+2017-02-28 Matt Rajca <mrajca@apple.com>
+
+ Media: notify clients when autoplayed media is muted
+ https://bugs.webkit.org/show_bug.cgi?id=168987
+
+ Reviewed by Alex Christensen.
+
+ Added API tests.
+
+ * html/HTMLMediaElement.cpp:
+ (WebCore::HTMLMediaElement::setMuted):
+ (WebCore::HTMLMediaElement::pageMutedStateDidChange):
+ * page/AutoplayEvent.h:
+
</ins><span class="cx"> 2017-03-01 Commit Queue <commit-queue@webkit.org>
</span><span class="cx">
</span><span class="cx"> Unreviewed, rolling out r213226.
</span></span></pre></div>
<a id="trunkSourceWebCorehtmlHTMLMediaElementcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/html/HTMLMediaElement.cpp (213245 => 213246)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/html/HTMLMediaElement.cpp        2017-03-01 22:39:31 UTC (rev 213245)
+++ trunk/Source/WebCore/html/HTMLMediaElement.cpp        2017-03-01 22:43:04 UTC (rev 213246)
</span><span class="lines">@@ -3350,9 +3350,19 @@
</span><span class="cx"> m_muted = muted;
</span><span class="cx"> m_explicitlyMuted = true;
</span><span class="cx">
</span><del>- if (ScriptController::processingUserGestureForMedia())
</del><ins>+ if (ScriptController::processingUserGestureForMedia()) {
</ins><span class="cx"> removeBehaviorsRestrictionsAfterFirstUserGesture(MediaElementSession::AllRestrictions & ~MediaElementSession::RequireUserGestureToControlControlsManager);
</span><span class="cx">
</span><ins>+ if (hasAudio() && m_muted) {
+ if (m_playbackWithoutUserGesture == PlaybackWithoutUserGesture::Started) {
+ if (Page* page = document().page())
+ page->chrome().client().handleAutoplayEvent(AutoplayEvent::UserDidInterfereWithPlayback);
+ }
+
+ m_playbackWithoutUserGesture = PlaybackWithoutUserGesture::None;
+ }
+ }
+
</ins><span class="cx"> // Avoid recursion when the player reports volume changes.
</span><span class="cx"> if (!processingMediaPlayerCallback()) {
</span><span class="cx"> if (m_player) {
</span><span class="lines">@@ -7088,6 +7098,17 @@
</span><span class="cx"> void HTMLMediaElement::pageMutedStateDidChange()
</span><span class="cx"> {
</span><span class="cx"> updateVolume();
</span><ins>+
+ if (Page* page = document().page()) {
+ if (hasAudio() && !muted() && page->isAudioMuted()) {
+ if (m_playbackWithoutUserGesture == PlaybackWithoutUserGesture::Started) {
+ if (Page* page = document().page())
+ page->chrome().client().handleAutoplayEvent(AutoplayEvent::UserDidInterfereWithPlayback);
+ }
+
+ m_playbackWithoutUserGesture = PlaybackWithoutUserGesture::None;
+ }
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> bool HTMLMediaElement::effectiveMuted() const
</span></span></pre></div>
<a id="trunkSourceWebCorepageAutoplayEventh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebCore/page/AutoplayEvent.h (213245 => 213246)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebCore/page/AutoplayEvent.h        2017-03-01 22:39:31 UTC (rev 213245)
+++ trunk/Source/WebCore/page/AutoplayEvent.h        2017-03-01 22:43:04 UTC (rev 213246)
</span><span class="lines">@@ -31,6 +31,7 @@
</span><span class="cx"> DidPreventMediaFromPlaying,
</span><span class="cx"> DidPlayMediaPreventedFromPlaying,
</span><span class="cx"> DidEndMediaPlaybackWithoutUserInterference,
</span><ins>+ UserDidInterfereWithPlayback,
</ins><span class="cx"> };
</span><span class="cx">
</span><span class="cx"> } // namespace WebCore
</span></span></pre></div>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (213245 => 213246)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog        2017-03-01 22:39:31 UTC (rev 213245)
+++ trunk/Source/WebKit2/ChangeLog        2017-03-01 22:43:04 UTC (rev 213246)
</span><span class="lines">@@ -1,3 +1,12 @@
</span><ins>+2017-02-28 Matt Rajca <mrajca@apple.com>
+
+ Media: notify clients when autoplayed media is muted
+ https://bugs.webkit.org/show_bug.cgi?id=168987
+
+ Reviewed by Alex Christensen.
+
+ * UIProcess/API/C/WKPageUIClient.h:
+
</ins><span class="cx"> 2017-03-01 Brady Eidson <beidson@apple.com>
</span><span class="cx">
</span><span class="cx"> Add SPI to create WebsiteDataStore objects pointing to custom paths.
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICWKPageUIClienth"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/C/WKPageUIClient.h (213245 => 213246)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/C/WKPageUIClient.h        2017-03-01 22:39:31 UTC (rev 213245)
+++ trunk/Source/WebKit2/UIProcess/API/C/WKPageUIClient.h        2017-03-01 22:43:04 UTC (rev 213246)
</span><span class="lines">@@ -52,6 +52,7 @@
</span><span class="cx"> kWKAutoplayEventDidPreventFromAutoplaying,
</span><span class="cx"> kWKAutoplayEventDidPlayMediaPreventedFromAutoplaying,
</span><span class="cx"> kWKAutoplayEventDidEndMediaPlaybackWithoutUserInterference,
</span><ins>+ kWKAutoplayEventUserDidInterfereWithPlayback,
</ins><span class="cx"> };
</span><span class="cx"> typedef uint32_t WKAutoplayEvent;
</span><span class="cx">
</span></span></pre></div>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (213245 => 213246)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog        2017-03-01 22:39:31 UTC (rev 213245)
+++ trunk/Tools/ChangeLog        2017-03-01 22:43:04 UTC (rev 213246)
</span><span class="lines">@@ -1,3 +1,14 @@
</span><ins>+2017-02-28 Matt Rajca <mrajca@apple.com>
+
+ Media: notify clients when autoplayed media is muted
+ https://bugs.webkit.org/show_bug.cgi?id=168987
+
+ Reviewed by Alex Christensen.
+
+ * TestWebKitAPI/Tests/WebKit2/js-play-with-controls.html:
+ * TestWebKitAPI/Tests/WebKit2Cocoa/WebsitePolicies.mm:
+ (TEST): Added.
+
</ins><span class="cx"> 2017-03-01 Brady Eidson <beidson@apple.com>
</span><span class="cx">
</span><span class="cx"> Add SPI to create WebsiteDataStore objects pointing to custom paths.
</span></span></pre></div>
<a id="trunkToolsTestWebKitAPITestsWebKit2jsplaywithcontrolshtml"></a>
<div class="modfile"><h4>Modified: trunk/Tools/TestWebKitAPI/Tests/WebKit2/js-play-with-controls.html (213245 => 213246)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/TestWebKitAPI/Tests/WebKit2/js-play-with-controls.html        2017-03-01 22:39:31 UTC (rev 213245)
+++ trunk/Tools/TestWebKitAPI/Tests/WebKit2/js-play-with-controls.html        2017-03-01 22:43:04 UTC (rev 213246)
</span><span class="lines">@@ -12,6 +12,10 @@
</span><span class="cx"> document.getElementById("video").play();
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ function mute() {
+ document.getElementById("video").muted = true;
+ }
+
</ins><span class="cx"> function beganPlaying() {
</span><span class="cx"> try {
</span><span class="cx"> window.webkit.messageHandlers.testHandler.postMessage("playing");
</span><span class="lines">@@ -27,6 +31,7 @@
</span><span class="cx"> </head>
</span><span class="cx"> <body onload="pageLoaded()">
</span><span class="cx"> <button onclick="play()">Play</button>
</span><ins>+ <button onclick="mute()">Mute</button>
</ins><span class="cx"> <video id="video" onplaying=beganPlaying() onended=endedPlaying() src="test.mp4" />
</span><span class="cx"> </body>
</span><span class="cx"> </html>
</span></span></pre></div>
<a id="trunkToolsTestWebKitAPITestsWebKit2CocoaWebsitePoliciesmm"></a>
<div class="modfile"><h4>Modified: trunk/Tools/TestWebKitAPI/Tests/WebKit2Cocoa/WebsitePolicies.mm (213245 => 213246)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/TestWebKitAPI/Tests/WebKit2Cocoa/WebsitePolicies.mm        2017-03-01 22:39:31 UTC (rev 213245)
+++ trunk/Tools/TestWebKitAPI/Tests/WebKit2Cocoa/WebsitePolicies.mm        2017-03-01 22:43:04 UTC (rev 213246)
</span><span class="lines">@@ -27,6 +27,7 @@
</span><span class="cx">
</span><span class="cx"> #import "PlatformUtilities.h"
</span><span class="cx"> #import "TestWKWebView.h"
</span><ins>+#import <WebKit/WKPagePrivate.h>
</ins><span class="cx"> #import <WebKit/WKUserContentControllerPrivate.h>
</span><span class="cx"> #import <WebKit/WKWebViewPrivate.h>
</span><span class="cx"> #import <WebKit/_WKUserContentExtensionStorePrivate.h>
</span><span class="lines">@@ -351,6 +352,45 @@
</span><span class="cx"> [webView waitForMessage:@"ended"];
</span><span class="cx"> runUntilReceivesAutoplayEvent(kWKAutoplayEventDidEndMediaPlaybackWithoutUserInterference);
</span><span class="cx"> }
</span><ins>+
+TEST(WebKit2, WebsitePoliciesUserInterferenceWithPlaying)
+{
+ 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);
+
+ WKPageSetMuted([webView _pageForTesting], kWKMediaAudioMuted);
+ runUntilReceivesAutoplayEvent(kWKAutoplayEventUserDidInterfereWithPlayback);
+
+ receivedAutoplayEvent = std::nullopt;
+ [webView loadRequest:jsPlayRequest];
+ [webView waitForMessage:@"playing"];
+ ASSERT_TRUE(receivedAutoplayEvent == std::nullopt);
+
+ const NSPoint muteButtonClickPoint = NSMakePoint(80, 256);
+ [webView mouseDownAtPoint:muteButtonClickPoint simulatePressure:NO];
+ [webView mouseUpAtPoint:muteButtonClickPoint];
+ runUntilReceivesAutoplayEvent(kWKAutoplayEventUserDidInterfereWithPlayback);
+}
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> #endif
</span></span></pre>
</div>
</div>
</body>
</html>