[Blink>Media] Moving autoplay logic to AutoplayPolicy

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
@@ skipping 33 matching lines @@
 #include "platform/audio/AudioSourceProvider.h"
 #include "platform/network/mime/MIMETypeRegistry.h"
 #include "public/platform/WebAudioSourceProviderClient.h"
 #include "public/platform/WebMediaPlayerClient.h"
 
 namespace blink {
 
 class AudioSourceProviderClient;
 class AudioTrack;
 class AudioTrackList;
+class AutoplayPolicy;
 class AutoplayUmaHelper;
 class ContentType;
 class CueTimeline;
-class ElementVisibilityObserver;
 class EnumerationHistogram;
 class Event;
 class ExceptionState;
 class HTMLMediaElementControlsList;
 class HTMLSourceElement;
 class HTMLTrackElement;
 class KURL;
 class MediaError;
 class MediaStreamDescriptor;
 class HTMLMediaSource;
@@ skipping 255 matching lines @@
 
   void VideoWillBeDrawnToCanvas() const;
 
   WebRemotePlaybackClient* RemotePlaybackClient() {
     return remote_playback_client_;
   }
   const WebRemotePlaybackClient* RemotePlaybackClient() const {
     return remote_playback_client_;
   }
 
+  const AutoplayPolicy& autoplay_policy() const { return *autoplay_policy_; }
+  AutoplayUmaHelper& autoplay_uma_helper() { return *autoplay_uma_helper_; }

[mlamouri (slow - plz ping), 2017/04/18 13:28:28]

For some reasons, Blink coding style doesn't allow foo_bar(). Instead, it
recommends FooBar() which IMO is terrible because of the name clash with
constructors. Can you name these GetFooBar()?

[Zhiqiang Zhang (Slow), 2017/04/18 16:56:44]

Done.

+
  protected:
   HTMLMediaElement(const QualifiedName&, Document&);
   ~HTMLMediaElement() override;
   void Dispose();
 
   void ParseAttribute(const AttributeModificationParams&) override;
   void FinishParsingChildren() final;
   bool IsURLAttribute(const Attribute&) const override;
   void AttachLayoutTree(const AttachContext& = AttachContext()) override;
 
@@ skipping 174 matching lines @@
   // 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 kHaveMetadata.
   void SelectInitialTracksIfNecessary();
 
-  // Return true if and only if a user gesture is required to unlock this
-  // media element for unrestricted autoplay / script control.  Don't confuse
-  // this with isGestureNeededForPlayback().  The latter is usually what one
-  // should use, if checking to see if an action is allowed.
-  bool IsLockedPendingUserGesture() const;
-
-  bool IsLockedPendingUserGestureIfCrossOriginExperimentEnabled() 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 UnlockUserGesture();
-
-  // Return true if and only if a user gesture is requried for playback.  Even
-  // if isLockedPendingUserGesture() return true, this might return false if
-  // the requirement is currently overridden.  This does not check if a user
-  // gesture is currently being processed.
-  bool IsGestureNeededForPlayback() const;
-
-  bool IsGestureNeededForPlaybackIfCrossOriginExperimentEnabled() const;
-
-  bool IsGestureNeededForPlaybackIfPendingUserGestureIsLocked() const;
-
-  // Return true if and only if the settings allow autoplay of media on this
-  // frame.
-  bool IsAutoplayAllowedPerSettings() const;
-
   void SetNetworkState(NetworkState);
 
   void AudioTracksTimerFired(TimerBase*);
 
   void ScheduleResolvePlayPromises();
   void ScheduleRejectPlayPromises(ExceptionCode);
   void ScheduleNotifyPlaying();
   void ResolveScheduledPlayPromises();
   void RejectScheduledPlayPromises();
   void RejectPlayPromises(ExceptionCode, const String&);
   void RejectPlayPromisesInternal(ExceptionCode, const String&);
 
   EnumerationHistogram& ShowControlsHistogram() const;
 
-  void OnVisibilityChangedForAutoplay(bool is_visible);
-
   void ViewportFillDebouncerTimerFired(TimerBase*);
 
   TaskRunnerTimer<HTMLMediaElement> load_timer_;
   TaskRunnerTimer<HTMLMediaElement> progress_event_timer_;
   TaskRunnerTimer<HTMLMediaElement> playback_progress_timer_;
   TaskRunnerTimer<HTMLMediaElement> audio_tracks_timer_;
   TaskRunnerTimer<HTMLMediaElement> viewport_fill_debouncer_timer_;
   TaskRunnerTimer<HTMLMediaElement> check_viewport_intersection_timer_;
 
   Member<TimeRanges> played_time_ranges_;
@@ skipping 65 matching lines @@
   // scripts are running. See setOfficialPlaybackPosition().
   mutable double official_playback_position_;
   mutable bool official_playback_position_needs_update_;
 
   double fragment_end_time_;
 
   typedef unsigned PendingActionFlags;
   PendingActionFlags pending_action_flags_;
 
   // FIXME: HTMLMediaElement has way too many state bits.
-  bool locked_pending_user_gesture_ : 1;
-  bool locked_pending_user_gesture_if_cross_origin_experiment_enabled_ : 1;
   bool playing_ : 1;
   bool should_delay_load_event_ : 1;
   bool have_fired_loaded_data_ : 1;
   bool can_autoplay_ : 1;
   bool muted_ : 1;
   bool paused_ : 1;
   bool seeking_ : 1;
 
   // data has not been loaded since sending a "stalled" event
   bool sent_stalled_event_ : 1;
@@ skipping 71 matching lines @@
     DECLARE_TRACE();
 
    private:
     WebAudioSourceProvider* web_audio_source_provider_;
     Member<AudioClientImpl> client_;
     Mutex provide_input_lock;
   };
 
   AudioSourceProviderImpl audio_source_provider_;
 
-  friend class AutoplayUmaHelper;  // for isAutoplayAllowedPerSettings
+  friend class AutoplayPolicy;
   friend class AutoplayUmaHelperTest;
   friend class Internals;
   friend class TrackDisplayUpdateScope;
   friend class MediaControlsImplTest;
   friend class HTMLMediaElementTest;
   friend class HTMLMediaElementEventListenersTest;
   friend class HTMLVideoElement;
   friend class MediaControlsOrientationLockDelegateTest;
 
+  Member<AutoplayPolicy> autoplay_policy_;
   Member<AutoplayUmaHelper> autoplay_uma_helper_;

[mlamouri (slow - plz ping), 2017/04/18 13:28:28]

How hard would it be to move `autoplay_uma_helper_` in AutoplayPolicy?

[Zhiqiang Zhang (Slow), 2017/04/18 16:56:44]

Makes sense. Done :)

 
   WebRemotePlaybackClient* remote_playback_client_;
 
-  // class AutoplayVisibilityObserver;
-  Member<ElementVisibilityObserver> autoplay_visibility_observer_;
-
   IntRect current_intersect_rect_;
 
   Member<MediaControls> media_controls_;
   Member<HTMLMediaElementControlsList> controls_list_;
 
   static URLRegistry* media_stream_registry_;
 };
 
 inline bool IsHTMLMediaElement(const HTMLElement& element) {
   return isHTMLAudioElement(element) || isHTMLVideoElement(element);
 }
 
 DEFINE_HTMLELEMENT_TYPE_CASTS_WITH_FUNCTION(HTMLMediaElement);
 
 }  // namespace blink
 
 #endif  // HTMLMediaElement_h