Disable background video track behind a feature flag

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
@@ skipping 2535 matching lines @@
 }
 
 void HTMLMediaElement::togglePlayState() {
   if (paused())
     play();
   else
     pause();
 }
 
 AudioTrackList& HTMLMediaElement::audioTracks() {
-  DCHECK(RuntimeEnabledFeatures::audioVideoTracksEnabled());

[mlamouri (slow - plz ping), 2016/11/12 23:35:48]

Here and below, did you have to remove the checks? When is it called? At least,
in the case of audio, it sounds odd that it would be called.

[whywhat, 2016/11/14 21:50:12]

When the Media Tracks API is enabled, HTMLMediaElement creates default
placeholder tracks for the media so it's consistent and I want to create a
default video track to be able to unselect it. I'm not sure if creating just the
video track and ignoring the audio one would work and it would probably make the
existing code that creates the default tracks more complex.

See createPlaceholderTracksIfNecessary below.

   return *m_audioTracks;
 }
 
 void HTMLMediaElement::audioTrackChanged(AudioTrack* track) {
   BLINK_MEDIA_LOG << "audioTrackChanged(" << (void*)this
                   << ") trackId= " << String(track->id())
                   << " enabled=" << boolString(track->enabled());
   DCHECK(RuntimeEnabledFeatures::audioVideoTracksEnabled());
 
   audioTracks().scheduleChangeEvent();
@@ skipping 21 matching lines @@
     WebMediaPlayerClient::AudioTrackKind kind,
     const WebString& label,
     const WebString& language,
     bool enabled) {
   AtomicString kindString = AudioKindToString(kind);
   BLINK_MEDIA_LOG << "addAudioTrack(" << (void*)this << ", '" << (String)id
                   << "', ' " << (AtomicString)kindString << "', '"
                   << (String)label << "', '" << (String)language << "', "
                   << boolString(enabled) << ")";
 
-  if (!RuntimeEnabledFeatures::audioVideoTracksEnabled())
-    return blink::WebMediaPlayer::TrackId();
-
   AudioTrack* audioTrack =
       AudioTrack::create(id, kindString, label, language, enabled);
   audioTracks().add(audioTrack);
 
   return audioTrack->id();
 }
 
 void HTMLMediaElement::removeAudioTrack(WebMediaPlayer::TrackId trackId) {
   BLINK_MEDIA_LOG << "removeAudioTrack(" << (void*)this << ")";
 
-  if (!RuntimeEnabledFeatures::audioVideoTracksEnabled())
-    return;
-
   audioTracks().remove(trackId);
 }
 
 VideoTrackList& HTMLMediaElement::videoTracks() {
-  DCHECK(RuntimeEnabledFeatures::audioVideoTracksEnabled());
   return *m_videoTracks;
 }
 
 void HTMLMediaElement::selectedVideoTrackChanged(VideoTrack* track) {
   BLINK_MEDIA_LOG << "selectedVideoTrackChanged(" << (void*)this
                   << ") selectedTrackId="
                   << (track->selected() ? String(track->id()) : "none");
   DCHECK(RuntimeEnabledFeatures::audioVideoTracksEnabled());
 
   if (track->selected())
@@ skipping 14 matching lines @@
     WebMediaPlayerClient::VideoTrackKind kind,
     const WebString& label,
     const WebString& language,
     bool selected) {
   AtomicString kindString = VideoKindToString(kind);
   BLINK_MEDIA_LOG << "addVideoTrack(" << (void*)this << ", '" << (String)id
                   << "', '" << (AtomicString)kindString << "', '"
                   << (String)label << "', '" << (String)language << "', "
                   << boolString(selected) << ")";
 
-  if (!RuntimeEnabledFeatures::audioVideoTracksEnabled())
-    return blink::WebMediaPlayer::TrackId();
-
   // If another track was selected (potentially by the user), leave it selected.
   if (selected && videoTracks().selectedIndex() != -1)
     selected = false;
 
   VideoTrack* videoTrack =
       VideoTrack::create(id, kindString, label, language, selected);
   videoTracks().add(videoTrack);
 
   return videoTrack->id();
 }
 
 void HTMLMediaElement::removeVideoTrack(WebMediaPlayer::TrackId trackId) {
   BLINK_MEDIA_LOG << "removeVideoTrack(" << (void*)this << ")";
 
-  if (!RuntimeEnabledFeatures::audioVideoTracksEnabled())
-    return;
-
   videoTracks().remove(trackId);
 }
 
 void HTMLMediaElement::addTextTrack(WebInbandTextTrack* webTrack) {
   // 4.8.10.12.2 Sourcing in-band text tracks
   // 1. Associate the relevant data with a new text track and its corresponding
   // new TextTrack object.
   InbandTextTrack* textTrack = InbandTextTrack::create(webTrack);
 
   // 2. Set the new text track's kind, label, and language based on the
@@ skipping 505 matching lines @@
 void HTMLMediaElement::cancelledRemotePlaybackRequest() {
   if (remotePlaybackClient())
     remotePlaybackClient()->promptCancelled();
 }
 
 void HTMLMediaElement::remotePlaybackStarted() {
   if (remotePlaybackClient())
     remotePlaybackClient()->stateChanged(WebRemotePlaybackState::Connected);
 }
 
+void HTMLMediaElement::hidden() {
+  if (!RuntimeEnabledFeatures::backgroundVideoTrackOptimizationEnabled())
+    return;
+
+  webMediaPlayer()->selectedVideoTrackChanged(nullptr);

[mlamouri (slow - plz ping), 2016/11/12 23:35:48]

Here and below, you go from WMPI to HTMLMediaElement to then go back to WMPI.
Any reason why not implementing this directly in WMPI?

[whywhat, 2016/11/14 21:50:13]

1. I can restore the previously selected video track easily as HTMLMediaElement
has access to those.
2. It works with both WMPI and WMPA (I assume Sergey's implementation works with
both).
3. In WMPI I'd have to change updatePlayState_computePlayState to react to the
backgrounded state change while also playing and so on... It doesn't really deal
with selected tracks at all right now.

[sandersd (OOO until July 31), 2016/11/15 00:09:11]

This also looks strange from the WMPI side (which independently checks
IsHidden() to decide what to do). At the very least more comments are necessary
to explain those choices.

[whywhat, 2016/11/15 03:08:56]

More thoughts:

- WMPA doesn't implement selectedVideoTrackChanged and probably won't so my
argument 2 doesn't apply.

- I check IsHidden() in WMPI::selectedVideoTrackChanged because I didn't want to
add isHidden() to WMP interface or keep a m_isHidden boolean in
HTMLMediaElement. Perhaps the former would keep the code in HTMLMediaElement.

- If I were to implement the whole change in WMPI, I'd have to keep track of the
unselected video track id there which would not keep WMPI stateless. Maybe I
could add a method to WMPClient to get the current video track id?

WDYT?

+}
+
+void HTMLMediaElement::shown() {
+  if (!RuntimeEnabledFeatures::backgroundVideoTrackOptimizationEnabled())
+    return;
+
+  int selectedTrackIndex = m_videoTracks->selectedIndex();
+  if (selectedTrackIndex == -1)
+    return;
+
+  VideoTrack* track = m_videoTracks->anonymousIndexedGetter(selectedTrackIndex);
+  WebMediaPlayer::TrackId id = track->id();
+  webMediaPlayer()->selectedVideoTrackChanged(&id);
+}
+
 bool HTMLMediaElement::isAutoplayingMuted() {
   if (!isHTMLVideoElement() ||
       !RuntimeEnabledFeatures::autoplayMutedVideosEnabled()) {
     return false;
   }
 
   return !paused() && muted() && isLockedPendingUserGesture();
 }
 
 void HTMLMediaElement::requestReload(const WebURL& newUrl) {
@@ skipping 637 matching lines @@
 }
 
 DEFINE_TRACE_WRAPPERS(HTMLMediaElement) {
   visitor->traceWrappers(m_videoTracks);
   visitor->traceWrappers(m_audioTracks);
   visitor->traceWrappers(m_textTracks);
   HTMLElement::traceWrappers(visitor);
 }
 
 void HTMLMediaElement::createPlaceholderTracksIfNecessary() {
-  if (!RuntimeEnabledFeatures::audioVideoTracksEnabled())
+  if (!RuntimeEnabledFeatures::audioVideoTracksEnabled() &&
+      !RuntimeEnabledFeatures::backgroundVideoTrackOptimizationEnabled()) {
     return;
+  }
 
   // Create a placeholder audio track if the player says it has audio but it
   // didn't explicitly announce the tracks.
   if (hasAudio() && !audioTracks().length())
     addAudioTrack("audio", WebMediaPlayerClient::AudioTrackKindMain,
                   "Audio Track", "", true);
 
   // Create a placeholder video track if the player says it has video but it
   // didn't explicitly announce the tracks.
   if (hasVideo() && !videoTracks().length())
     addVideoTrack("video", WebMediaPlayerClient::VideoTrackKindMain,
                   "Video Track", "", true);
 }
 
 void HTMLMediaElement::selectInitialTracksIfNecessary() {
-  if (!RuntimeEnabledFeatures::audioVideoTracksEnabled())
+  if (!RuntimeEnabledFeatures::audioVideoTracksEnabled() &&
+      !RuntimeEnabledFeatures::backgroundVideoTrackOptimizationEnabled()) {
     return;
+  }
 
   // Enable the first audio track if an audio track hasn't been enabled yet.
   if (audioTracks().length() > 0 && !audioTracks().hasEnabledTrack())
     audioTracks().anonymousIndexedGetter(0)->setEnabled(true);
 
   // Select the first video track if a video track hasn't been selected yet.
   if (videoTracks().length() > 0 && videoTracks().selectedIndex() == -1)
     videoTracks().anonymousIndexedGetter(0)->setSelected(true);
 }
 
@@ skipping 295 matching lines @@
 
 IntRect HTMLMediaElement::AutoplayHelperClientImpl::absoluteBoundingBoxRect()
     const {
   IntRect result;
   if (LayoutObject* object = m_element->layoutObject())
     result = object->absoluteBoundingBoxRect();
   return result;
 }
 
 }  // namespace blink