Autoplay experiment metric fixes and additions.

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

 /*
  * 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 50 matching lines @@
 class WebInbandTextTrack;
 class WebLayer;
 
 class CORE_EXPORT HTMLMediaElement : public HTMLElement, public WillBeHeapSupplementable<HTMLMediaElement>, public ActiveDOMObject, private WebMediaPlayerClient {
     DEFINE_WRAPPERTYPEINFO();
     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(HTMLMediaElement);
     WILL_BE_USING_PRE_FINALIZER(HTMLMediaElement, dispose);
 public:
     static WebMimeRegistry::SupportsType supportsType(const ContentType&);
 
-    enum class RecordMetricsBehavior {

[philipj_slow, 2016/02/25 10:53:49]

Given that's it's used for other things as well now, can we leave it here and
"using" it from AutoplayExperimentHelper instead?

[liberato (no reviews please), 2016/02/25 15:30:31]

Done.  luckily, the autoplay helper only ever sent DoNotRecord, so i just
removed it from Client::shouldAutoplay().  otherwise, the forward declaration
would have been hard since it's nested in HTMLMediaElement.

-        DoNotRecord,
-        DoRecord
-    };
-
     static void setMediaStreamRegistry(URLRegistry*);
     static bool isMediaStreamURL(const String& url);
 
     DECLARE_VIRTUAL_TRACE();
     void clearWeakMembers(Visitor*);
     WebMediaPlayer* webMediaPlayer() const
     {
         return m_webMediaPlayer.get();
     }
 
@@ skipping 44 matching lines @@
     bool paused() const;
     double defaultPlaybackRate() const;
     void setDefaultPlaybackRate(double);
     double playbackRate() const;
     void setPlaybackRate(double);
     void updatePlaybackRate();
     TimeRanges* played();
     TimeRanges* seekable() const;
     bool ended() const;
     bool autoplay() const;
+    using RecordMetricsBehavior = AutoplayExperimentHelper::Client::RecordMetricsBehavior;
     bool shouldAutoplay(const RecordMetricsBehavior = RecordMetricsBehavior::DoNotRecord);
     bool loop() const;
     void setLoop(bool);
     void play();
     void pause();
     void requestRemotePlayback();
     void requestRemotePlaybackControl();
 
     // statistics
     unsigned webkitAudioDecodedByteCount() const;
@@ skipping 117 matching lines @@
     bool isURLAttribute(const Attribute&) const override;
     void attach(const AttachContext& = AttachContext()) override;
 
     void didMoveToNewDocument(Document& oldDocument) override;
     virtual KURL posterImageURL() const { return KURL(); }
 
     enum DisplayMode { Unknown, Poster, Video };
     DisplayMode displayMode() const { return m_displayMode; }
     virtual void setDisplayMode(DisplayMode mode) { m_displayMode = mode; }
 
+    void recordAutoplayMetric(AutoplayMetrics);
+
 private:
     void resetMediaPlayerAndMediaSource();
 
     bool alwaysCreateUserAgentShadowRoot() const final { return true; }
     bool areAuthorShadowsAllowed() const final { return false; }
 
     bool supportsFocus() const final;
     bool isMouseFocusable() const final;
     bool layoutObjectIsNeeded(const ComputedStyle&) override;
     LayoutObject* createLayoutObject(const ComputedStyle&) override;
@@ skipping 85 matching lines @@
     void deferredLoadTimerFired(Timer<HTMLMediaElement>*);
 
     void markCaptionAndSubtitleTracksAsUnconfigured();
 
     // This does not check user gesture restrictions.
     void playInternal();
 
     // This does not change the buffering strategy.
     void pauseInternal();
 
-    // If we are about to enter a paused state, call this to record
-    // autoplay metrics.  If we were already in a stopped state, then
-    // this does nothing.
-    void recordMetricsIfPausing();
-    // 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;
-    void autoplayMediaEncountered();
     void allowVideoRendering();
 
     void updateVolume();
     void updatePlayState();
     bool potentiallyPlaying() const;
     bool stoppedDueToErrors() const;
     bool couldPlayIfEnoughData() const;
 
     // Generally the presence of the loop attribute should be considered to mean playback
     // has not "ended", as "ended" and "looping" are mutually exclusive. See
@@ skipping 11 matching lines @@
     TextTrackContainer& ensureTextTrackContainer();
 
     void* preDispatchEventHandler(Event*) final;
 
     void changeNetworkStateFromLoadingToIdle();
 
     bool isAutoplaying() const { return m_autoplaying; }
 
     void setAllowHiddenVolumeControls(bool);
 
-    void recordAutoplayMetric(AutoplayMetrics);
-
     WebMediaPlayer::CORSMode corsMode() const;
 
     // Returns the "direction of playback" value as specified in the HTML5 spec.
     enum DirectionOfPlayback { Backward, Forward };
     DirectionOfPlayback directionOfPlayback() const;
 
     // Creates placeholder AudioTrack and/or VideoTrack objects when WebMemediaPlayer objects
     // advertise they have audio and/or video, but don't explicitly signal them via
     // addAudioTrack() and addVideoTrack().
     // FIXME: Remove this once all WebMediaPlayer implementations properly report their track info.
     void createPlaceholderTracksIfNecessary();
 
     // Sets the selected/enabled tracks if they aren't set before we initially
     // transition to HAVE_METADATA.
     void selectInitialTracksIfNecessary();
 
     // Return true if and only if we require a user gesture before letting
     // the media play.
     bool isUserGestureRequiredForPlay() const;
+
+    // If the user gesture is required, then this will remove it.  Note that
+    // one should not generally call this method directly; use the one on
+    // m_helper and give it a reason.
     void removeUserGestureRequirement();
-    void setInitialPlayWithoutUserGestures(bool);
 
     void setNetworkState(NetworkState);
 
     void audioTracksTimerFired(Timer<HTMLMediaElement>*);
 
     // TODO(liberato): remove once autoplay gesture override experiment concludes.
     void triggerAutoplayViewportCheckForTesting();
 
     UnthrottledTimer<HTMLMediaElement> m_loadTimer;
     UnthrottledTimer<HTMLMediaElement> m_progressEventTimer;
@@ skipping 84 matching lines @@
 
     bool m_closedCaptionsVisible : 1;
 
     bool m_havePreparedToPlay : 1;
 
     bool m_tracksAreReady : 1;
     bool m_processingPreferenceChange : 1;
     bool m_remoteRoutesAvailable : 1;
     bool m_playingRemotely : 1;
     bool m_isFinalizing : 1;
-    bool m_initialPlayWithoutUserGesture : 1;
-    bool m_autoplayMediaCounted : 1;
     // Whether this element is in overlay fullscreen mode.
     bool m_inOverlayFullscreenVideo : 1;
 
     PersistentWillBeMember<AudioTrackList> m_audioTracks;
     PersistentWillBeMember<VideoTrackList> m_videoTracks;
     PersistentWillBeMember<TextTrackList> m_textTracks;
     PersistentHeapVectorWillBeHeapVector<Member<TextTrack>> m_textTracksWhenResourceSelectionBegan;
 
     OwnPtrWillBeMember<CueTimeline> m_cueTimeline;
 
@@ skipping 44 matching lines @@
         DECLARE_TRACE();
 
     private:
         WebAudioSourceProvider* m_webAudioSourceProvider;
         PersistentWillBeMember<AudioClientImpl> m_client;
         Mutex provideInputLock;
     };
 
     AudioSourceProviderImpl m_audioSourceProvider;
 
+    class AutoplayHelperClientImpl;
+
     friend class Internals;
     friend class TrackDisplayUpdateScope;
     friend class AutoplayExperimentHelper;
     friend class MediaControlsTest;
 
-    AutoplayExperimentHelper m_autoplayHelper;
+    OwnPtrWillBeMember<AutoplayExperimentHelper::Client> m_autoplayHelperClient;
+    OwnPtrWillBeMember<AutoplayExperimentHelper> m_autoplayHelper;
 
     static URLRegistry* s_mediaStreamRegistry;
 };
 
 inline bool isHTMLMediaElement(const HTMLElement& element)
 {
     return isHTMLAudioElement(element) || isHTMLVideoElement(element);
 }
 
 DEFINE_HTMLELEMENT_TYPE_CASTS_WITH_FUNCTION(HTMLMediaElement);
 
 } // namespace blink
 
 #endif // HTMLMediaElement_h