Don't collect 'other tracks' in HTMLMediaElement::configureTextTracks

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
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 662 matching lines @@
 {
 #if LOG_MEDIA_EVENTS
     WTF_LOG(Media, "HTMLMediaElement::scheduleEvent(%p) - scheduling '%s'", this, event->type().ascii().data());
 #endif
     m_asyncEventQueue->enqueueEvent(event);
 }
 
 void HTMLMediaElement::loadTimerFired(Timer<HTMLMediaElement>*)
 {
     if (m_pendingActionFlags & LoadTextTrackResource)
-        configureTextTracks();
+        honorUserPreferencesForAutomaticTextTrackSelection();
 
     if (m_pendingActionFlags & LoadMediaResource) {
         if (m_loadState == LoadingFromSourceElement)
             loadNextSourceChild();
         else
             loadInternal();
     }
 
     m_pendingActionFlags = 0;
 }
@@ skipping 1978 matching lines @@
     // as follows, based on the type of the media resource:
     // 5. Populate the new text track's list of cues with the cues parsed so far, folllowing the guidelines for exposing
     // cues, and begin updating it dynamically as necessary.
     //   - Thess are all done by the media engine.
 
     // 6. Set the new text track's readiness state to loaded.
     textTrack->setReadinessState(TextTrack::Loaded);
 
     // 7. Set the new text track's mode to the mode consistent with the user's preferences and the requirements of
     // the relevant specification for the data.
-    //  - This will happen in configureTextTracks()
+    //  - This will happen in honorUserPreferencesForAutomaticTextTrackSelection()
     scheduleDelayedAction(LoadTextTrackResource);
 
     // 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.get());
 }
 
 void HTMLMediaElement::mediaPlayerDidRemoveTextTrack(WebInbandTextTrack* webTrack)
@@ skipping 152 matching lines @@
 }
 
 static int textTrackSelectionScore(const TextTrack& track)
 {
     if (track.kind() != TextTrack::captionsKeyword() && track.kind() != TextTrack::subtitlesKeyword())
         return 0;
 
     return textTrackLanguageSelectionScore(track);
 }
 
-void HTMLMediaElement::configureTextTrackGroup(const TrackGroup& group)
+void HTMLMediaElement::performAutomaticTextTrackSelection(const TrackGroup& group)
 {
     ASSERT(group.tracks.size());
 
     WTF_LOG(Media, "HTMLMediaElement::configureTextTrackGroup(%p, %d)", this, group.kind);
 
     // First, find the track in the group that should be enabled (if any).
     WillBeHeapVector<RefPtrWillBeMember<TextTrack>> currentlyEnabledTracks;
     RefPtrWillBeRawPtr<TextTrack> trackToEnable = nullptr;
     RefPtrWillBeRawPtr<TextTrack> defaultTrack = nullptr;
     RefPtrWillBeRawPtr<TextTrack> fallbackTrack = nullptr;
@@ skipping 48 matching lines @@
             RefPtrWillBeRawPtr<TextTrack> textTrack = currentlyEnabledTracks[i];
             if (textTrack != trackToEnable)
                 textTrack->setMode(TextTrack::disabledKeyword());
         }
     }
 
     if (trackToEnable)
         trackToEnable->setMode(TextTrack::showingKeyword());
 }
 
-void HTMLMediaElement::configureMetadataTextTrackGroup(const TrackGroup& group)
+void HTMLMediaElement::enableDefaultMetadataTextTracks(const TrackGroup& group)
 {
     ASSERT(group.tracks.size());
 
     // https://html.spec.whatwg.org/multipage/embedded-content.html#honor-user-preferences-for-automatic-text-track-selection
 
     // 4. If there are any text tracks in the media element's list of text
     // tracks whose text track kind is metadata that correspond to track
     // elements with a default attribute set whose text track mode is set to
     // disabled, then set the text track mode of all such tracks to hidden
     for (auto& textTrack : group.tracks) {
         if (textTrack->mode() != TextTrack::disabledKeyword())
             continue;
         if (!textTrack->isDefault())
             continue;
         textTrack->setMode(TextTrack::hiddenKeyword());
     }
 }
 
-void HTMLMediaElement::configureTextTracks()
+void HTMLMediaElement::honorUserPreferencesForAutomaticTextTrackSelection()
 {
     TrackGroup captionAndSubtitleTracks(TrackGroup::CaptionsAndSubtitles);
     TrackGroup descriptionTracks(TrackGroup::Description);
     TrackGroup chapterTracks(TrackGroup::Chapter);
     TrackGroup metadataTracks(TrackGroup::Metadata);
-    TrackGroup otherTracks(TrackGroup::Other);
 
     if (!m_textTracks)
         return;
 
     for (size_t i = 0; i < m_textTracks->length(); ++i) {
         RefPtrWillBeRawPtr<TextTrack> textTrack = m_textTracks->item(i);
         if (!textTrack)
             continue;
 
         String kind = textTrack->kind();
         TrackGroup* currentGroup;
-        if (kind == TextTrack::subtitlesKeyword() || kind == TextTrack::captionsKeyword())
+        if (kind == TextTrack::subtitlesKeyword() || kind == TextTrack::captionsKeyword()) {
             currentGroup = &captionAndSubtitleTracks;
-        else if (kind == TextTrack::descriptionsKeyword())
+        } else if (kind == TextTrack::descriptionsKeyword()) {
             currentGroup = &descriptionTracks;
-        else if (kind == TextTrack::chaptersKeyword())
+        } else if (kind == TextTrack::chaptersKeyword()) {
             currentGroup = &chapterTracks;
-        else if (kind == TextTrack::metadataKeyword())
+        } else {
+            ASSERT(kind == TextTrack::metadataKeyword());
             currentGroup = &metadataTracks;
-        else
-            currentGroup = &otherTracks;
+        }
 
         if (!currentGroup->visibleTrack && textTrack->mode() == TextTrack::showingKeyword())
             currentGroup->visibleTrack = textTrack;
         if (!currentGroup->defaultTrack && textTrack->isDefault())
             currentGroup->defaultTrack = textTrack;
 
         // Do not add this track to the group if it has already been automatically configured
-        // as we only want to call configureTextTrack once per track so that adding another
-        // track after the initial configuration doesn't reconfigure every track - only those
-        // that should be changed by the new addition. For example all metadata tracks are
+        // as we only want to perform selection once per track so that adding another track
+        // after the initial configuration doesn't reconfigure every track - only those that
+        // should be changed by the new addition. For example all metadata tracks are
         // disabled by default, and we don't want a track that has been enabled by script
         // to be disabled automatically when a new metadata track is added later.
         if (textTrack->hasBeenConfigured())
             continue;
 
         if (textTrack->language().length())
             currentGroup->hasSrcLang = true;
         currentGroup->tracks.append(textTrack);
     }
 
     if (captionAndSubtitleTracks.tracks.size())
-        configureTextTrackGroup(captionAndSubtitleTracks);
+        performAutomaticTextTrackSelection(captionAndSubtitleTracks);
     if (descriptionTracks.tracks.size())
-        configureTextTrackGroup(descriptionTracks);
+        performAutomaticTextTrackSelection(descriptionTracks);
     if (chapterTracks.tracks.size())
-        configureTextTrackGroup(chapterTracks);
+        performAutomaticTextTrackSelection(chapterTracks);
     if (metadataTracks.tracks.size())
-        configureMetadataTextTrackGroup(metadataTracks);
-    if (otherTracks.tracks.size())
-        configureTextTrackGroup(otherTracks);
+        enableDefaultMetadataTextTracks(metadataTracks);
 
     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.
     RefPtrWillBeRawPtr<HTMLSourceElement> currentSourceNode = m_currentSourceNode;
     RefPtrWillBeRawPtr<Node> nextNode = m_nextChildNodeToConsider;
@@ skipping 705 matching lines @@
 {
     WTF_LOG(Media, "HTMLMediaElement::setClosedCaptionsVisible(%p, %s)", this, boolString(closedCaptionVisible));
 
     if (!m_player || !hasClosedCaptions())
         return;
 
     m_closedCaptionsVisible = closedCaptionVisible;
 
     markCaptionAndSubtitleTracksAsUnconfigured();
     m_processingPreferenceChange = true;
-    configureTextTracks();
+    honorUserPreferencesForAutomaticTextTrackSelection();
     m_processingPreferenceChange = false;
 
     updateTextTrackDisplay();
 }
 
 unsigned HTMLMediaElement::webkitAudioDecodedByteCount() const
 {
     if (!webMediaPlayer())
         return 0;
     return webMediaPlayer()->audioDecodedByteCount();
@@ skipping 107 matching lines @@
 
     updateActiveTextTrackCues(currentTime());
     updateTextTrackDisplay();
 }
 
 void HTMLMediaElement::markCaptionAndSubtitleTracksAsUnconfigured()
 {
     if (!m_textTracks)
         return;
 
-    // Mark all tracks as not "configured" so that configureTextTracks()
-    // will reconsider which tracks to display in light of new user preferences
-    // (e.g. default tracks should not be displayed if the user has turned off
-    // captions and non-default tracks should be displayed based on language
-    // preferences if the user has turned captions on).
+    // Mark all tracks as not "configured" so that
+    // honorUserPreferencesForAutomaticTextTrackSelection() will reconsider
+    // which tracks to display in light of new user preferences (e.g. default
+    // tracks should not be displayed if the user has turned off captions and
+    // non-default tracks should be displayed based on language preferences if
+    // the user has turned captions on).
     for (unsigned i = 0; i < m_textTracks->length(); ++i) {
         RefPtrWillBeRawPtr<TextTrack> textTrack = m_textTracks->item(i);
         String kind = textTrack->kind();
 
         if (kind == TextTrack::subtitlesKeyword() || kind == TextTrack::captionsKeyword())
             textTrack->setHasBeenConfigured(false);
     }
 }
 
 void* HTMLMediaElement::preDispatchEventHandler(Event* event)
@@ skipping 244 matching lines @@
 
 #if ENABLE(WEB_AUDIO)
 void HTMLMediaElement::clearWeakMembers(Visitor* visitor)
 {
     if (!visitor->isAlive(m_audioSourceNode) && audioSourceProvider())
         audioSourceProvider()->setClient(nullptr);
 }
 #endif
 
 }