Media Controls: Use events to update controls for closed captions.

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 1223 matching lines @@
 void HTMLMediaElement::textTrackReadyStateChanged(TextTrack* track) {
   if (webMediaPlayer() &&
       m_textTracksWhenResourceSelectionBegan.contains(track)) {
     if (track->getReadinessState() != TextTrack::Loading)
       setReadyState(static_cast<ReadyState>(webMediaPlayer()->getReadyState()));
   } else {
     // The track readiness state might have changed as a result of the user
     // clicking the captions button. In this case, a check whether all the
     // resources have failed loading should be done in order to hide the CC
     // button.
+    // TODO(mlamouri): when an HTMLTrackElement fails to load, it is not
+    // propagated to the TextTrack object in a web exposed fashion. We have to
+    // keep relying on a custom glue to the controls while this is taken care
+    // of on the web side. See https://crbug.com/669977
     if (mediaControls() &&
-        track->getReadinessState() == TextTrack::FailedToLoad)
-      mediaControls()->refreshClosedCaptionsButtonVisibility();
+        track->getReadinessState() == TextTrack::FailedToLoad) {
+      mediaControls()->onTrackElementFailedToLoad();
+    }
   }
 }
 
 void HTMLMediaElement::textTrackModeChanged(TextTrack* track) {
   // Mark this track as "configured" so configureTextTracks won't change the
   // mode again.
   if (track->trackType() == TextTrack::TrackElement)
     track->setHasBeenConfigured(true);
 
   configureTextTrackDisplay();
@@ skipping 428 matching lines @@
           m_autoplaying = false;
         }
       }
     }
 
     scheduleEvent(EventTypeNames::canplaythrough);
 
     shouldUpdateDisplayState = true;
   }
 
-  if (shouldUpdateDisplayState) {
+  if (shouldUpdateDisplayState)
     updateDisplayState();
-    if (mediaControls())
-      mediaControls()->refreshClosedCaptionsButtonVisibility();
-  }
 
   updatePlayState();
   cueTimeline().updateActiveCues(currentTime());
 }
 
 void HTMLMediaElement::progressEventTimerFired(TimerBase*) {
   if (m_networkState != kNetworkLoading)
     return;
 
   double time = WTF::currentTime();
@@ skipping 880 matching lines @@
   // preferences and the requirements of the relevant specification for the
   // data.
   //  - This will happen in honorUserPreferencesForAutomaticTextTrackSelection()
   scheduleTextTrackResourceLoad();
 
   // 8. Add the new text track to the media element's list of text tracks.
   // 9. Fire an event with the name addtrack, that does not bubble and is not
   // cancelable, and that uses the TrackEvent interface, with the track
   // attribute initialized to the text track's TextTrack object, at the media
   // element's textTracks attribute's TextTrackList object.
-  addTextTrack(textTrack);
+  textTracks()->append(textTrack);
 }
 
 void HTMLMediaElement::removeTextTrack(WebInbandTextTrack* webTrack) {
   if (!m_textTracks)
     return;
 
   // This cast is safe because we created the InbandTextTrack with the
   // WebInbandTextTrack passed to mediaPlayerDidAddTextTrack.
   InbandTextTrack* textTrack =
       static_cast<InbandTextTrack*>(webTrack->client());
   if (!textTrack)
     return;
 
-  removeTextTrack(textTrack);
-}
-
-void HTMLMediaElement::textTracksChanged() {
-  if (mediaControls())
-    mediaControls()->refreshClosedCaptionsButtonVisibility();
-}
-
-void HTMLMediaElement::addTextTrack(TextTrack* track) {
-  textTracks()->append(track);
-
-  textTracksChanged();
-}
-
-void HTMLMediaElement::removeTextTrack(TextTrack* track) {
-  m_textTracks->remove(track);
-
-  textTracksChanged();
+  m_textTracks->remove(textTrack);
 }
 
 void HTMLMediaElement::forgetResourceSpecificTracks() {
   // Implements the "forget the media element's media-resource-specific tracks"
   // algorithm.  The order is explicitly specified as text, then audio, and
   // finally video.  Also 'removetrack' events should not be fired.
   if (m_textTracks) {
     TrackDisplayUpdateScope scope(this->cueTimeline());
     m_textTracks->removeAllInbandTracks();
-    textTracksChanged();
   }
 
   m_audioTracks->removeAll();
   m_videoTracks->removeAll();
 
   m_audioTracksTimer.stop();
 }
 
 TextTrack* HTMLMediaElement::addTextTrack(const AtomicString& kind,
                                           const AtomicString& label,
@@ skipping 12 matching lines @@
   TextTrack* textTrack = TextTrack::create(kind, label, language);
   //    ..., its text track readiness state to the text track loaded state, ...
   textTrack->setReadinessState(TextTrack::Loaded);
 
   // 3. Add the new text track to the media element's list of text tracks.
   // 4. Queue a task to fire a trusted event with the name addtrack, that
   //    does not bubble and is not cancelable, and that uses the TrackEvent
   //    interface, with the track attribute initialised to the new text
   //    track's TextTrack object, at the media element's textTracks
   //    attribute's TextTrackList object.
-  addTextTrack(textTrack);
+  textTracks()->append(textTrack);
 
   // Note: Due to side effects when changing track parameters, we have to
   // first append the track to the text track list.
   // FIXME: Since setMode() will cause a 'change' event to be queued on the
   // same task source as the 'addtrack' event (see above), the order is
   // wrong. (The 'change' event shouldn't be fired at all in this case...)
 
   // ..., its text track mode to the text track hidden mode, ...
   textTrack->setMode(TextTrack::hiddenKeyword());
 
@@ skipping 11 matching lines @@
 void HTMLMediaElement::didAddTrackElement(HTMLTrackElement* trackElement) {
   // 4.8.10.12.3 Sourcing out-of-band text tracks
   // When a track element's parent element changes and the new parent is a media
   // element, then the user agent must add the track element's corresponding
   // text track to the media element's list of text tracks ... [continues in
   // TextTrackList::append]
   TextTrack* textTrack = trackElement->track();
   if (!textTrack)
     return;
 
-  addTextTrack(textTrack);
+  textTracks()->append(textTrack);
 
   // Do not schedule the track loading until parsing finishes so we don't start
   // before all tracks in the markup have been added.
   if (isFinishedParsingChildren())
     scheduleTextTrackResourceLoad();
 }
 
 void HTMLMediaElement::didRemoveTrackElement(HTMLTrackElement* trackElement) {
   KURL url = trackElement->getNonEmptyURLAttribute(srcAttr);
   BLINK_MEDIA_LOG << "didRemoveTrackElement(" << (void*)this << ") - 'src' is "
                   << urlForLoggingMedia(url);
 
   TextTrack* textTrack = trackElement->track();
   if (!textTrack)
     return;
 
   textTrack->setHasBeenConfigured(false);
 
   if (!m_textTracks)
     return;
 
   // 4.8.10.12.3 Sourcing out-of-band text tracks
   // When a track element's parent element changes and the old parent was a
   // media element, then the user agent must remove the track element's
   // corresponding text track from the media element's list of text tracks.
-  removeTextTrack(textTrack);
+  m_textTracks->remove(textTrack);
 
   size_t index = m_textTracksWhenResourceSelectionBegan.find(textTrack);
   if (index != kNotFound)
     m_textTracksWhenResourceSelectionBegan.remove(index);
 }
 
 void HTMLMediaElement::honorUserPreferencesForAutomaticTextTrackSelection() {
   if (!m_textTracks || !m_textTracks->length())
     return;
 
   if (!m_shouldPerformAutomaticTrackSelection)
     return;
 
   AutomaticTrackSelection::Configuration configuration;
   if (m_processingPreferenceChange)
     configuration.disableCurrentlyEnabledTracks = true;
   if (m_textTracksVisible)
     configuration.forceEnableSubtitleOrCaptionTrack = true;
 
   Settings* settings = document().settings();
   if (settings)
     configuration.textTrackKindUserPreference =
         settings->textTrackKindUserPreference();
 
   AutomaticTrackSelection trackSelection(configuration);
   trackSelection.perform(*m_textTracks);
-
-  textTracksChanged();
 }
 
 bool HTMLMediaElement::havePotentialSourceChild() {
   // Stash the current <source> node and next nodes so we can restore them after
   // checking to see there is another potential.
   HTMLSourceElement* currentSourceNode = m_currentSourceNode;
   Node* nextNode = m_nextChildNodeToConsider;
 
   KURL nextURL = selectNextSourceChild(0, DoNothing);
 
@@ skipping 642 matching lines @@
     document().layoutViewItem().compositor()->setNeedsCompositingUpdate(
         CompositingUpdateRebuildTree);
   m_inOverlayFullscreenVideo = false;
 }
 
 WebLayer* HTMLMediaElement::platformLayer() const {
   return m_webLayer;
 }
 
 bool HTMLMediaElement::hasClosedCaptions() const {
-  if (m_textTracks) {
-    for (unsigned i = 0; i < m_textTracks->length(); ++i) {
-      if (m_textTracks->anonymousIndexedGetter(i)->canBeRendered())
-        return true;
-    }
+  if (!m_textTracks)
+    return false;
+
+  for (unsigned i = 0; i < m_textTracks->length(); ++i) {
+    if (m_textTracks->anonymousIndexedGetter(i)->canBeRendered())
+      return true;
   }
+
   return false;
 }
 
 bool HTMLMediaElement::textTracksVisible() const {
   return m_textTracksVisible;
 }
 
 static void assertShadowRootChildren(ShadowRoot& shadowRoot) {
 #if DCHECK_IS_ON()
   // There can be up to two children, either or both of the text
@@ skipping 186 matching lines @@
 
   if (m_processingPreferenceChange)
     return;
 
   bool haveVisibleTextTrack = m_textTracks->hasShowingTracks();
   m_textTracksVisible = haveVisibleTextTrack;
 
   if (!haveVisibleTextTrack && !mediaControls())
     return;
 
-  if (mediaControls())
-    mediaControls()->changedClosedCaptionsVisibility();
-
   cueTimeline().updateActiveCues(currentTime());
 
   // Note: The "time marches on" algorithm (updateActiveCues) runs the "rules
   // for updating the text track rendering" (updateTextTrackDisplay) only for
   // "affected tracks", i.e. tracks where the the active cues have changed.
   // This misses cues in tracks that changed mode between hidden and showing.
   // This appears to be a spec bug, which we work around here:
   // https://www.w3.org/Bugs/Public/show_bug.cgi?id=28236
   updateTextTrackDisplay();
 }
@@ skipping 379 matching lines @@
 
 DEFINE_TRACE(HTMLMediaElement::AudioClientImpl) {
   visitor->trace(m_client);
 }
 
 DEFINE_TRACE(HTMLMediaElement::AudioSourceProviderImpl) {
   visitor->trace(m_client);
 }
 
 }  // namespace blink