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 115 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;
-    enum class RecordMetricsBehavior { DoNotRecord, DoRecord };
-    bool shouldAutoplay(const RecordMetricsBehavior = RecordMetricsBehavior::DoNotRecord);
+    bool shouldAutoplay(const AutoplayExperimentHelper::Client::RecordMetricsBehavior = AutoplayExperimentHelper::Client::RecordMetricsBehavior::DoNotRecord);

[philipj_slow, 2016/01/12 15:12:19]

Can using RecordMetricsBehavior =
AutoplayExperimentHelper::Client::RecordMetricsBehavior make this simpler, or
does RecordMetricsBehavior::DoNotRecord then not work?

[liberato (no reviews please), 2016/01/29 08:25:25]

seems to work.  good idea.

[philipj_slow, 2016/02/02 08:08:15]

Isn't it possible to also replace
AutoplayExperimentHelper::Client::RecordMetricsBehavior with just
RecordMetricsBehavior? If the using keyword only helps a single instance, then I
think it's not worth it.

[liberato (no reviews please), 2016/02/24 18:44:05]

Done.  in the interim, RecordMetricsBehavior was used elsewhere, so i also
renamed '...SandboxFailure' back to just 'DoRecord'.  there was no need to keep
it separate.

     bool loop() const;
     void setLoop(bool);
     void play();
     void pause();
     void requestRemotePlayback();
     void requestRemotePlaybackControl();
 
     // statistics
     unsigned webkitAudioDecodedByteCount() const;
     unsigned webkitVideoDecodedByteCount() const;
@@ skipping 116 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 87 matching lines @@
     bool m_completelyLoaded : 1;
     bool m_havePreparedToPlay : 1;
     bool m_delayingLoadForPreloadNone : 1;
 
     bool m_tracksAreReady : 1;
     bool m_haveVisibleTextTrack : 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 49 matching lines @@
         Mutex provideInputLock;
     };
 
     AudioSourceProviderImpl m_audioSourceProvider;
 
     friend class Internals;
     friend class TrackDisplayUpdateScope;
     friend class AutoplayExperimentHelper;
     friend class MediaControlsTest;
 
-    AutoplayExperimentHelper m_autoplayHelper;
+    class AutoplayHelperClientImpl : public AutoplayExperimentHelper::Client {
+    public:
+        AutoplayHelperClientImpl(HTMLMediaElement& element) : m_element(element) {}
+        virtual ~AutoplayHelperClientImpl();
+
+        double currentTime() const override { return m_element.currentTime(); }
+        double duration() const override { return m_element.duration(); }
+        bool paused() const override { return m_element.paused(); }
+        bool muted() const override { return m_element.muted(); }
+        void setMuted(bool muted) override { m_element.setMuted(muted); }
+        void playInternal() override { m_element.playInternal(); }
+        bool isUserGestureRequiredForPlay() const override { return m_element.isUserGestureRequiredForPlay(); }
+        void removeUserGestureRequirement() override { m_element.removeUserGestureRequirement(); }
+        void recordAutoplayMetric(AutoplayMetrics metric) override { m_element.recordAutoplayMetric(metric); }
+        bool shouldAutoplay(RecordMetricsBehavior behavior) override { return m_element.shouldAutoplay(behavior); }
+        bool isHTMLVideoElement() const override { return m_element.isHTMLVideoElement(); }
+        bool isHTMLAudioElement() const override { return m_element.isHTMLAudioElement(); }
+
+        // Document
+        bool isLegacyViewportType() override;
+        PageVisibilityState pageVisibilityState() const override;
+        WTF::String autoplayExperimentMode() const override;
+
+        // LayoutObject
+        void setRequestPositionUpdates(bool) override;
+        IntRect absoluteBoundingBoxRect() const override;
+
+    private:
+        HTMLMediaElement& m_element;
+    };
+
+    AutoplayExperimentHelper::Client* m_autoplayHelperClient;

[philipj_slow, 2016/01/12 15:12:19]

Why can't both of these be references still?

[liberato (no reviews please), 2016/01/29 08:25:25]

i don't like relying on destruction order, since it's too easy to accidentally
reorder the members.

i'll update to OwnPtr.

[philipj_slow, 2016/02/02 08:08:15]

Not sure why I said "references still" when it was originally an
"AutoplayExperimentHelper m_autoplayHelper", but this still needs to be fixed in
some way.

+    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