Autoplay experiment metric fixes and additions.

third_party/WebKit/Source/core/html/AutoplayExperimentHelper.h

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef AutoplayExperimentHelper_h
 #define AutoplayExperimentHelper_h
 
 #include "core/page/Page.h"
 #include "platform/Timer.h"
 #include "platform/geometry/IntRect.h"
@@ skipping 44 matching lines @@
 
     // play() failed to play due to gesture requirement.
     PlayMethodFailed = 10,
 
     // Some play, whether user initiated or not, started.
     AnyPlaybackStarted = 11,
     // Some play, whether user initiated or not, paused.
     AnyPlaybackPaused = 12,
     // Some playback, whether user initiated or not, bailed out early.
     AnyPlaybackBailout = 13,
+    // Some playback, whether user initiated or not, played to completion.
+    AnyPlaybackComplete = 14,
+
+    // Number of audio elements detected that reach the resource fetch algorithm.
+    AnyAudioElement = 15,
+    // Numer of video elements detected that reach the resource fetch algorithm.
+    AnyVideoElement = 16,
+
+    // User gesture was bypassed, and playback started, and media played to
+    // completion without a user-initiated pause.
+    AutoplayComplete = 17,
+
+    // Autoplay started after the gesture requirement was removed by a
+    // user gesture load().
+    GesturelessPlaybackEnabledByLoad = 18,
+
+    // Gestureless playback started after the gesture requirement was removed
+    // because src is media stream.
+    GesturelessPlaybackEnabledByStream = 19,
+
+    // Gestureless playback was started, but it is unknown why a user gesture
+    // was not required.  This includes the case where none is ever required.
+    GesturelessPlaybackUnknownReason = 20,
+
+    // Gestureless playback was enabled by a user gesture play() call.
+    GesturelessPlaybackEnabledByPlayMethod = 21,
 
     // This enum value must be last.
     NumberOfAutoplayMetrics,
 };
 
 class AutoplayExperimentHelper final {
     DISALLOW_NEW_EXCEPT_PLACEMENT_NEW();
 public:
     explicit AutoplayExperimentHelper(HTMLMediaElement&);
     ~AutoplayExperimentHelper();
 
     void becameReadyToPlay();
     void playMethodCalled();
     void pauseMethodCalled();
+    void loadMethodCalled();
     void mutedChanged();
     void positionChanged(const IntRect&);
     void updatePositionNotificationRegistration();
+    void recordSandboxFailure();
+    void loadingStarted();
+    void playbackStarted();
+    void playbackEnded();
+    void initialPlayWithUserGesture();
+    void setGestureRemovalReason(AutoplayMetrics);
 
     void triggerAutoplayViewportCheckForTesting();
 
     enum Mode {
         // Do not enable the autoplay experiment.
         ExperimentOff = 0,
         // Enable gestureless autoplay for video elements.
         ForVideo      = 1 << 0,
         // Enable gestureless autoplay for audio elements.
         ForAudio      = 1 << 1,
@@ skipping 38 matching lines @@
     // requires it, else do nothing.
     void muteIfNeeded();
 
     // Maybe override the requirement for a user gesture, and start playing
     // autoplay media.  Returns true if only if it starts playback.
     bool maybeStartPlaying();
 
     // Configure internal state to record that the autoplay experiment is
     // going to start playback.  This doesn't actually start playback, since
     // there are several different cases.
-    void prepareToPlay(AutoplayMetrics);
+    void prepareToAutoplay(AutoplayMetrics);
+
+    // Record that an attempt to play without a user gesture has happened.
+    // If there is not a user gesture requirement, then record why there
+    // is no such requirement, with the expectation that playback will start.
+    // This method takes no action after it is called once.
+    void autoplayMediaEncountered();
+
+    // If we are about to enter a paused state, call this to record
+    // autoplay metrics.
+    void recordMetricsBeforePause();
 
     // Process a timer for checking visibility.
     void viewportTimerFired(Timer<AutoplayExperimentHelper>*);
 
     // Return our media element's document.
     Document& document() const;
 
     HTMLMediaElement& element() const;
 
+    bool isUserGestureRequiredForPlay() const;
+
     inline bool enabled(Mode mode) const
     {
         return ((int)m_mode) & ((int)mode);
     }
 
     Mode fromString(const String& mode);
 
+    void recordAutoplayMetric(AutoplayMetrics);
+
+    // Could stopping at this point be considered a bailout of playback?
+    // (as in, "The user really didn't want to play this").
+    bool isBailout() const;
+
     RawPtrWillBeMember<HTMLMediaElement> m_element;
 
     Mode m_mode;
 
     // Autoplay experiment state.
     // True if we've received a play() without a pause().
     bool m_playPending : 1;
 
     // Are we registered with the view for position updates?
     bool m_registeredWithLayoutObject : 1;
 
     // According to our last position update, are we in the viewport?
     bool m_wasInViewport : 1;
 
+    // Have we counted this autoplay media in the metrics yet?
+    bool m_autoplayMediaCounted : 1;
+
+    // Did the first playback of the media occur without a user gesture?
+    bool m_initialPlayWithoutUserGesture : 1;
+
+    // Did we record that this media element exists in the metrics yet?
+    bool m_recordedElement : 1;
+
     // According to our last position update, where was our element?
     IntRect m_lastLocation;
     IntRect m_lastVisibleRect;
 
     // When was m_lastLocation set?
     double m_lastLocationUpdateTime;
 
     Timer<AutoplayExperimentHelper> m_viewportTimer;
+
+    // Reason that autoplay would be allowed to proceed without a user gesture.
+    AutoplayMetrics m_autoplayDeferredMetric;
 };
 
 inline AutoplayExperimentHelper::Mode& operator|=(AutoplayExperimentHelper::Mode& a,
     const AutoplayExperimentHelper::Mode& b)
 {
     a = static_cast<AutoplayExperimentHelper::Mode>(static_cast<int>(a) | static_cast<int>(b));
     return a;
 }
 
 
 } // namespace blink
 
 #endif // AutoplayExperimentHelper_h