Reland: Measure whether muted videos that started playing with play() become visible at some point

third_party/WebKit/Source/core/html/HTMLMediaElement.cpp

 /*
  * Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 Apple 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
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 26 matching lines @@
 #include "core/dom/ElementTraversal.h"
 #include "core/dom/ElementVisibilityObserver.h"
 #include "core/dom/Fullscreen.h"
 #include "core/dom/shadow/ShadowRoot.h"
 #include "core/events/Event.h"
 #include "core/frame/FrameView.h"
 #include "core/frame/LocalFrame.h"
 #include "core/frame/Settings.h"
 #include "core/frame/UseCounter.h"
 #include "core/frame/csp/ContentSecurityPolicy.h"
+#include "core/html/AutoplayUmaHelper.h"
 #include "core/html/HTMLMediaSource.h"
 #include "core/html/HTMLSourceElement.h"
 #include "core/html/HTMLTrackElement.h"
 #include "core/html/MediaError.h"
 #include "core/html/MediaFragmentURIParser.h"
 #include "core/html/TimeRanges.h"
 #include "core/html/shadow/MediaControls.h"
 #include "core/html/track/AudioTrack.h"
 #include "core/html/track/AudioTrackList.h"
 #include "core/html/track/AutomaticTrackSelection.h"
@@ skipping 217 matching lines @@
     case WebMediaPlayer::PreloadMetaData:
         return "metadata";
     case WebMediaPlayer::PreloadAuto:
         return "auto";
     }
 
     NOTREACHED();
     return String();
 }
 
-// These values are used for histograms. Do not reorder.
-enum AutoplaySource {
-    // Autoplay comes from HTMLMediaElement `autoplay` attribute.
-    AutoplaySourceAttribute = 0,
-    // Autoplay comes from `play()` method.
-    AutoplaySourceMethod = 1,
-    // This enum value must be last.
-    NumberOfAutoplaySources = 2,
-};
-
 } // anonymous namespace
 
 class HTMLMediaElement::AutoplayHelperClientImpl :
     public AutoplayExperimentHelper::Client {
 
 public:
     static AutoplayHelperClientImpl* create(HTMLMediaElement* element)
     {
         return new AutoplayHelperClientImpl(element);
     }
@@ skipping 137 matching lines @@
     , m_playingRemotely(false)
     , m_inOverlayFullscreenVideo(false)
     , m_audioTracks(AudioTrackList::create(*this))
     , m_videoTracks(VideoTrackList::create(*this))
     , m_textTracks(nullptr)
     , m_playPromiseResolveTask(CancellableTaskFactory::create(this, &HTMLMediaElement::resolveScheduledPlayPromises))
     , m_playPromiseRejectTask(CancellableTaskFactory::create(this, &HTMLMediaElement::rejectScheduledPlayPromises))
     , m_audioSourceNode(nullptr)
     , m_autoplayHelperClient(AutoplayHelperClientImpl::create(this))
     , m_autoplayHelper(AutoplayExperimentHelper::create(m_autoplayHelperClient.get()))
+    , m_autoplayUmaHelper(AutoplayUmaHelper::create(this))
     , m_remotePlaybackClient(nullptr)
     , m_autoplayVisibilityObserver(nullptr)
 {
     ThreadState::current()->registerPreFinalizer(this);
 
     BLINK_MEDIA_LOG << "HTMLMediaElement(" << (void*)this << ")";
 
     // If any experiment is enabled, then we want to enable a user gesture by
     // default, otherwise the experiment does nothing.
     if ((document.settings() && document.settings()->mediaPlaybackRequiresUserGesture())
@@ skipping 29 matching lines @@
     // doesn't get dispatched during the object destruction.
     // See Document::isDelayingLoadEvent().
     // Also see http://crbug.com/275223 for more details.
     clearMediaPlayerAndAudioSourceProviderClientWithoutLocking();
 }
 
 void HTMLMediaElement::didMoveToNewDocument(Document& oldDocument)
 {
     BLINK_MEDIA_LOG << "didMoveToNewDocument(" << (void*)this << ")";
 
+    m_autoplayUmaHelper->didMoveToNewDocument(oldDocument);
     // If any experiment is enabled, then we want to enable a user gesture by
     // default, otherwise the experiment does nothing.
     bool oldDocumentRequiresUserGesture = (oldDocument.settings() && oldDocument.settings()->mediaPlaybackRequiresUserGesture())
         || m_autoplayHelper->isExperimentEnabled();
     bool newDocumentRequiresUserGesture = (document().settings() && document().settings()->mediaPlaybackRequiresUserGesture())
         || m_autoplayHelper->isExperimentEnabled();
     if (newDocumentRequiresUserGesture && !oldDocumentRequiresUserGesture) {
         m_lockedPendingUserGesture = true;
     }
 
@@ skipping 1130 matching lines @@
 
     if (m_readyState == kHaveEnoughData && oldState < kHaveEnoughData && tracksAreReady) {
         if (oldState <= kHaveCurrentData) {
             scheduleEvent(EventTypeNames::canplay);
             if (isPotentiallyPlaying)
                 scheduleNotifyPlaying();
         }
 
         // Check for autoplay, and record metrics about it if needed.
         if (shouldAutoplay(RecordMetricsBehavior::DoRecord)) {
-            recordAutoplaySourceMetric(AutoplaySourceAttribute);
+            m_autoplayUmaHelper->onAutoplayInitiated(AutoplaySource::Attribute);
 
             // If the autoplay experiment says that it's okay to play now,
             // then don't require a user gesture.
             m_autoplayHelper->becameReadyToPlay();
 
             if (!isGestureNeededForPlayback()) {
                 if (isHTMLVideoElement() && muted() && RuntimeEnabledFeatures::autoplayMutedVideosEnabled()) {
                     // We might end up in a situation where the previous
                     // observer didn't had time to fire yet. We can avoid
                     // creating a new one in this case.
@@ skipping 432 matching lines @@
     return promise;
 }
 
 Nullable<ExceptionCode> HTMLMediaElement::play()
 {
     BLINK_MEDIA_LOG << "play(" << (void*)this << ")";
 
     m_autoplayHelper->playMethodCalled();
 
     if (!UserGestureIndicator::processingUserGesture()) {
-        recordAutoplaySourceMetric(AutoplaySourceMethod);
+        m_autoplayUmaHelper->onAutoplayInitiated(AutoplaySource::Method);
         if (isGestureNeededForPlayback()) {
             // If playback is deferred, then don't start playback but don't
             // fail yet either.
             if (m_autoplayHelper->isPlaybackDeferred())
                 return nullptr;
 
             // If we're already playing, then this play would do nothing anyway.
             // Call playInternal to handle scheduling the promise resolution.
             if (!m_paused) {
                 playInternal();
@@ skipping 194 matching lines @@
 
     updateVolume();
 
     scheduleEvent(EventTypeNames::volumechange);
 
     // If an element autoplayed while muted, it needs to be unlocked to unmute,
     // otherwise, it will be paused.
     if (wasAutoplayingMuted) {
         if (isGestureNeededForPlayback()) {
             pause();
-            recordAutoplayUnmuteStatus(AutoplayUnmuteActionFailure);
+            m_autoplayUmaHelper->recordAutoplayUnmuteStatus(AutoplayUnmuteActionStatus::Failure);
         } else {
-            recordAutoplayUnmuteStatus(AutoplayUnmuteActionSuccess);
+            m_autoplayUmaHelper->recordAutoplayUnmuteStatus(AutoplayUnmuteActionStatus::Success);
         }
     }
 }
 
 void HTMLMediaElement::updateVolume()
 {
     if (webMediaPlayer())
         webMediaPlayer()->setVolume(effectiveMediaVolume());
 
     if (mediaControls())
@@ skipping 1333 matching lines @@
     visitor->trace(m_videoTracks);
     visitor->trace(m_cueTimeline);
     visitor->trace(m_textTracks);
     visitor->trace(m_textTracksWhenResourceSelectionBegan);
     visitor->trace(m_playPromiseResolvers);
     visitor->trace(m_playPromiseResolveList);
     visitor->trace(m_playPromiseRejectList);
     visitor->trace(m_audioSourceProvider);
     visitor->trace(m_autoplayHelperClient);
     visitor->trace(m_autoplayHelper);
+    visitor->trace(m_autoplayUmaHelper);
     visitor->trace(m_srcObject);
     visitor->trace(m_autoplayVisibilityObserver);
     visitor->template registerWeakMembers<HTMLMediaElement, &HTMLMediaElement::clearWeakMembers>(this);
     Supplementable<HTMLMediaElement>::trace(visitor);
     HTMLElement::trace(visitor);
     ActiveDOMObject::trace(visitor);
 }
 
 DEFINE_TRACE_WRAPPERS(HTMLMediaElement)
 {
@@ skipping 200 matching lines @@
 {
     if (isHTMLVideoElement()) {
         DEFINE_STATIC_LOCAL(EnumerationHistogram, histogram, ("Media.Controls.Show.Video", MediaControlsShowMax));
         return histogram;
     }
 
     DEFINE_STATIC_LOCAL(EnumerationHistogram, histogram, ("Media.Controls.Show.Audio", MediaControlsShowMax));
     return histogram;
 }
 
-void HTMLMediaElement::recordAutoplaySourceMetric(int source)
-{
-    DEFINE_STATIC_LOCAL(EnumerationHistogram, videoHistogram, ("Media.Video.Autoplay", NumberOfAutoplaySources));
-    DEFINE_STATIC_LOCAL(EnumerationHistogram, mutedVideoHistogram, ("Media.Video.Autoplay.Muted", NumberOfAutoplaySources));
-    DEFINE_STATIC_LOCAL(EnumerationHistogram, audioHistogram, ("Media.Audio.Autoplay", NumberOfAutoplaySources));
-
-    if (isHTMLVideoElement()) {
-        videoHistogram.count(source);
-        if (muted())
-            mutedVideoHistogram.count(source);
-    } else {
-        audioHistogram.count(source);
-    }
-}
-
-void HTMLMediaElement::recordAutoplayUnmuteStatus(AutoplayUnmuteActionStatus status)
-{
-    DEFINE_STATIC_LOCAL(EnumerationHistogram, autoplayUnmuteHistogram, ("Media.Video.Autoplay.Muted.UnmuteAction", AutoplayUnmuteActionMax));
-
-    autoplayUnmuteHistogram.count(status);
-}
-
 void HTMLMediaElement::onVisibilityChangedForAutoplay(bool isVisible)
 {
     if (!isVisible)
         return;
 
     if (shouldAutoplay()) {
         m_paused = false;
         invalidateCachedTime();
         scheduleEvent(EventTypeNames::play);
         scheduleNotifyPlaying();
@@ skipping 115 matching lines @@
 
 IntRect HTMLMediaElement::AutoplayHelperClientImpl::absoluteBoundingBoxRect() const
 {
     IntRect result;
     if (LayoutObject* object = m_element->layoutObject())
         result = object->absoluteBoundingBoxRect();
     return result;
 }
 
 } // namespace blink