commit 180663835647ab9427efdedb40275704afb98cc8
author mrajca@apple.com <mrajca@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc> Fri Jan 04 19:45:09 2019 +0000
committer mrajca@apple.com <mrajca@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc> Fri Jan 04 19:45:09 2019 +0000
tree 62616207b0285d57052f550ae3402c238bc36375
parent 619a8b9fa8c1f2487981e786178d656b8244f87b

Make DidPlayMediaPreventedFromPlaying autoplay event more generic.
https://bugs.webkit.org/show_bug.cgi?id=193128
rdar://34554231

Reviewed by Jer Noble.

Today, the "DidPlayMediaPreventedFromPlaying" autoplay event is only sent for
media prevented from autoplaying. It could be generalized to a "DidPlayMediaWithUserGesture"
event along with a flag that indicates whether or not autoplay was actually prevented.
Source/WebCore:

Moreover, we can include a flag that indicates whether the media element in question
is main content. Clients will then know in more cases when media was played with a user
gesture, whether or not it has audio, as well as its main content status. While the main
content heuristics may not be perfect, they covered the top 20 video-centric websites that
this was tested with and are meant to be used by clients for data evaluation purposes.

As part of this, the PlaybackWithoutUserGesture enum was renamed to AutoplayEventPlaybackState
since it now also applies to cases where there is a user gesture. The
`m_playbackWithoutUserGestureStartedTime` member variable was also removed in favor of
`playbackStartedTime` which also covers all the cases we care about.

Tests: existing API tests were updated to reflect the new names. New API tests
were added for the new case in which the "DidPlayMediaWithUserGesture" event is sent.

* html/HTMLMediaElement.cpp:
(WebCore::convertEnumerationToString): Update to new enum cases.
(WebCore::HTMLMediaElement::setReadyState): Ditto.
(WebCore::HTMLMediaElement::play): Ditto.
(WebCore::HTMLMediaElement::playInternal): Also cover the case where
 playback was not prevented but there was a user gesture.
(WebCore::HTMLMediaElement::pauseInternal): Use new name.
(WebCore::HTMLMediaElement::setVolume): Use new name.
(WebCore::HTMLMediaElement::playbackProgressTimerFired): Dispatch the
 DidPlayMediaWithUserGesture event when playback was started with a user
 gesture as well.
(WebCore::HTMLMediaElement::mediaPlayerDidAddAudioTrack): Use new name.
(WebCore::HTMLMediaElement::mediaPlayerTimeChanged): Ditto.
(WebCore::HTMLMediaElement::mediaPlayerCharacteristicChanged): Ditto.
(WebCore::HTMLMediaElement::stopWithoutDestroyingMediaPlayer): Ditto.
(WebCore::HTMLMediaElement::handleAutoplayEvent): Pass along new media state.
(WebCore::HTMLMediaElement::userDidInterfereWithAutoplay): Use new name.
(WebCore::HTMLMediaElement::setAutoplayEventPlaybackState): Stop setting
 m_playbackWithoutUserGestureStartedTime in favor of using playbackStartedTime.
(WebCore::HTMLMediaElement::updateShouldPlay): Use new name.
(WebCore::HTMLMediaElement::setPlaybackWithoutUserGesture): Renamed.
* html/HTMLMediaElement.h:
(WTF::LogArgument<WebCore::HTMLMediaElement::AutoplayEventPlaybackState>::toString): Renamed from...
(WTF::LogArgument<WebCore::HTMLMediaElement::PlaybackWithoutUserGesture>::toString):
* html/MediaElementSession.cpp:
(WebCore::MediaElementSession::isMainContentForPurposesOfAutoplayEvents const): Don't
 do the hit testing check for the purposes of autoplay events. It seems to fail on the
 basic Vimeo player due to overlapping divs.
(WebCore::isElementMainContentForPurposesOfAutoplay):
(WebCore::MediaElementSession::updateIsMainContent const): Keep the existing behavior
 here of hit testing.
(WebCore::isMainContentForPurposesOfAutoplay): Renamed.
* html/MediaElementSession.h:
* page/AutoplayEvent.h:

Source/WebKit:

Tests: existing API tests were updated to reflect the new names. New API tests
were added for the new case in which the "DidPlayMediaWithUserGesture" event is sent.

* Shared/WebCoreArgumentCoders.h: Take into account new flags.
* UIProcess/API/C/WKPage.cpp: Ditto.
(WKPageSetPageUIClient):
* UIProcess/API/C/WKPageUIClient.h: Ditto.
* UIProcess/API/Cocoa/WKUIDelegatePrivate.h: Ditto.
* UIProcess/Cocoa/UIDelegate.mm: Ditto.
(WebKit::toWKAutoplayEventFlags):
(WebKit::toWKAutoplayEvent):

Tools:

Tests: existing API tests were updated to reflect the new names. New API tests
were added for the new case in which the "DidPlayMediaWithUserGesture" event is sent.

* TestWebKitAPI/TestWebKitAPI.xcodeproj/project.pbxproj:
* TestWebKitAPI/Tests/WebKit/long-test.mp4: Added.
* TestWebKitAPI/Tests/WebKitCocoa/WebsitePolicies.mm:
(TEST):
* TestWebKitAPI/Tests/WebKitCocoa/audio-with-play-button.html: Added.
* TestWebKitAPI/Tests/WebKitCocoa/video-with-play-button.html: Added.

git-svn-id: http://svn.webkit.org/repository/webkit/trunk@239625 268f45cc-cd09-0410-ab3c-d52691b4dbfc