Added code to enable the first caption track if the user has requested captions and one such track …

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 918 matching lines @@
 
     // 12 - Further sort tasks in events that have the same time by the
     // relative text track cue order of the text track cues associated
     // with these tasks.
     return a.second->cueIndex() - b.second->cueIndex() < 0;
 }
 
 
 void HTMLMediaElement::updateActiveTextTrackCues(double movieTime)
 {
-    LOG(Media, "HTMLMediaElement::updateActiveTextTracks");
+    LOG(Media, "HTMLMediaElement::updateActiveTextTrackCues");
 
     // 4.8.10.8 Playing the media resource
 
     //  If the current playback position changes while the steps are running,
     //  then the user agent must wait for the steps to complete, and then must
     //  immediately rerun the steps.
     if (ignoreTrackDisplayUpdateRequests())
         return;
 
     // 1 - Let current cues be a list of cues, initialized to contain all the
@@ skipping 195 matching lines @@
 
         m_asyncEventQueue->enqueueEvent(event.release());
 
         // ... if the text track has a corresponding track element, to then fire a
         // simple event named cuechange at the track element as well.
         if (affectedTracks[i]->trackType() == TextTrack::TrackElement) {
             RefPtr<Event> event = Event::create(eventNames().cuechangeEvent, false, false);
             HTMLTrackElement* trackElement = static_cast<LoadableTextTrack*>(affectedTracks[i])->trackElement();
             ASSERT(trackElement);
             event->setTarget(trackElement);
-            
+
             m_asyncEventQueue->enqueueEvent(event.release());
         }
     }
 
     // 16 - Set the text track cue active flag of all the cues in the current
     // cues, and unset the text track cue active flag of all the cues in the
     // other cues.
     for (size_t i = 0; i < currentCuesSize; ++i)
         currentCues[i].data()->setIsActive(true);
 
@@ skipping 59 matching lines @@
             if (track->mode() != TextTrack::disabledKeyword()) {
                 if (trackElement->readyState() == HTMLTrackElement::LOADED)
                     textTrackAddCues(track, track->cues());
 
                 // If this is the first added track, create the list of text tracks.
                 if (!m_textTracks)
                   m_textTracks = TextTrackList::create(this, ActiveDOMObject::scriptExecutionContext());
             }
             break;
         }
-    }
+    } else if (track->trackType() == TextTrack::AddTrack && track->mode() != TextTrack::disabledKeyword())
+        textTrackAddCues(track, track->cues());
 
 #if USE(PLATFORM_TEXT_TRACK_MENU)
     if (platformTextTrackMenu())
         platformTextTrackMenu()->trackWasSelected(track->platformTextTrack());
 #endif
-    
+
     configureTextTrackDisplay();
     updateActiveTextTrackCues(currentTime());
 }
 
 void HTMLMediaElement::textTrackKindChanged(TextTrack* track)
 {
     if (track->kind() != TextTrack::captionsKeyword() && track->kind() != TextTrack::subtitlesKeyword() && track->mode() == TextTrack::showingKeyword())
         track->setMode(TextTrack::hiddenKeyword());
 }
 
 void HTMLMediaElement::beginIgnoringTrackDisplayUpdateRequests()
 {
     ++m_ignoreTrackDisplayUpdate;
 }
 
 void HTMLMediaElement::endIgnoringTrackDisplayUpdateRequests()
 {
     ASSERT(m_ignoreTrackDisplayUpdate);
     --m_ignoreTrackDisplayUpdate;
     if (!m_ignoreTrackDisplayUpdate && m_inActiveDocument)
         updateActiveTextTrackCues(currentTime());
 }
 
 void HTMLMediaElement::textTrackAddCues(TextTrack*, const TextTrackCueList* cues) 
 {
+    LOG(Media, "HTMLMediaElement::textTrackAddCues");
+
     TrackDisplayUpdateScope scope(this);
     for (size_t i = 0; i < cues->length(); ++i)
         textTrackAddCue(cues->item(i)->track(), cues->item(i));
 }
 
 void HTMLMediaElement::textTrackRemoveCues(TextTrack*, const TextTrackCueList* cues) 
 {
+    LOG(Media, "HTMLMediaElement::textTrackRemoveCues");
+
     TrackDisplayUpdateScope scope(this);
     for (size_t i = 0; i < cues->length(); ++i)
         textTrackRemoveCue(cues->item(i)->track(), cues->item(i));
 }
 
 void HTMLMediaElement::textTrackAddCue(TextTrack*, PassRefPtr<TextTrackCue> cue)
 {
     // Negative duration cues need be treated in the interval tree as
     // zero-length cues.
     double endTime = max(cue->startTime(), cue->endTime());
 
     CueInterval interval = m_cueTree.createInterval(cue->startTime(), endTime, cue.get());
     if (!m_cueTree.contains(interval))
         m_cueTree.add(interval);
     updateActiveTextTrackCues(currentTime());
 }
 
 void HTMLMediaElement::textTrackRemoveCue(TextTrack*, PassRefPtr<TextTrackCue> cue)
 {
     // Negative duration cues need to be treated in the interval tree as
     // zero-length cues.
     double endTime = max(cue->startTime(), cue->endTime());
 
     CueInterval interval = m_cueTree.createInterval(cue->startTime(), endTime, cue.get());
     m_cueTree.remove(interval);
 
     size_t index = m_currentlyActiveCues.find(interval);
-    if (index != notFound)
+    if (index != notFound) {
         m_currentlyActiveCues.remove(index);
+        cue->setIsActive(false);
+    }
 
     cue->removeDisplayTree();
     updateActiveTextTrackCues(currentTime());
 }
 
 
 bool HTMLMediaElement::isSafeToLoadURL(const KURL& url, InvalidURLAction actionIfInvalid)
 {
     if (!url.isValid()) {
         LOG(Media, "HTMLMediaElement::isSafeToLoadURL(%s) -> FALSE because url is invalid", urlForLoggingMedia(url).utf8().data());
@@ skipping 1539 matching lines @@
         return false;
 
     CaptionUserPreferences* captionPreferences = page->group().captionPreferences();
     return captionPreferences->userHasCaptionPreferences() && captionPreferences->shouldShowCaptions();
 }
 
 void HTMLMediaElement::configureTextTrackGroup(const TrackGroup& group)
 {
     ASSERT(group.tracks.size());
 
+    LOG(Media, "HTMLMediaElement::configureTextTrackGroup(%d)", group.kind);
+
     Page* page = document()->page();
     CaptionUserPreferences* captionPreferences = page? page->group().captionPreferences() : 0;
 
     // First, find the track in the group that should be enabled (if any).
     Vector<RefPtr<TextTrack> > currentlyEnabledTracks;
     RefPtr<TextTrack> trackToEnable;
     RefPtr<TextTrack> defaultTrack;
     RefPtr<TextTrack> fallbackTrack;
     int highestTrackScore = 0;
     for (size_t i = 0; i < group.tracks.size(); ++i) {
@@ skipping 28 matching lines @@
             //    Let the text track mode be showing by default.
             defaultTrack = textTrack;
         }
     }
 
     if (!trackToEnable && defaultTrack)
         trackToEnable = defaultTrack;
 
     // If no track matches the user's preferred language and non was marked 'default', enable the first track
     // because the user has explicitly stated a preference for this kind of track.
+    if (!fallbackTrack && m_closedCaptionsVisible && group.kind == TrackGroup::CaptionsAndSubtitles)
+        fallbackTrack = group.tracks[0];
+
     if (!trackToEnable && fallbackTrack)
         trackToEnable = fallbackTrack;
 
     if (currentlyEnabledTracks.size()) {
         for (size_t i = 0; i < currentlyEnabledTracks.size(); ++i) {
             RefPtr<TextTrack> textTrack = currentlyEnabledTracks[i];
             if (textTrack != trackToEnable)
                 textTrack->setMode(TextTrack::disabledKeyword());
         }
     }
 
     if (trackToEnable)
         trackToEnable->setMode(TextTrack::showingKeyword());
-
-    m_processingPreferenceChange = false;
 }
 
 void HTMLMediaElement::setSelectedTextTrack(TextTrack* trackToSelect)
 {
     TextTrackList* trackList = textTracks();
     if (!trackList || !trackList->length())
         return;
     if (trackToSelect && !trackList->contains(trackToSelect))
         return;
 
@@ skipping 940 matching lines @@
     return false;
 }
 
 bool HTMLMediaElement::closedCaptionsVisible() const
 {
     return m_closedCaptionsVisible;
 }
 
 void HTMLMediaElement::updateTextTrackDisplay()
 {
+    LOG(Media, "HTMLMediaElement::updateTextTrackDisplay");
+
     if (!hasMediaControls() && !createMediaControls())
         return;
-    
+
     mediaControls()->updateTextTrackDisplay();
 }
 
 void HTMLMediaElement::setClosedCaptionsVisible(bool closedCaptionVisible)
 {
     LOG(Media, "HTMLMediaElement::setClosedCaptionsVisible(%s)", boolString(closedCaptionVisible));
 
     if (!m_player || !hasClosedCaptions())
         return;
 
     m_closedCaptionsVisible = closedCaptionVisible;
     m_player->setClosedCaptionsVisible(closedCaptionVisible);
 
     if (RuntimeEnabledFeatures::webkitVideoTrackEnabled()) {
         m_processingPreferenceChange = true;
         markCaptionAndSubtitleTracksAsUnconfigured();
+        m_processingPreferenceChange = false;
+
         updateTextTrackDisplay();
     }
 }
 
 void HTMLMediaElement::setWebkitClosedCaptionsVisible(bool visible)
 {
     setClosedCaptionsVisible(visible);
 }
 
 bool HTMLMediaElement::webkitClosedCaptionsVisible() const
@@ skipping 118 matching lines @@
 
     if (!hasMediaControls() && !createMediaControls())
         return;
 
     mediaControls()->show();
 }
 
 void HTMLMediaElement::configureTextTrackDisplay()
 {
     ASSERT(m_textTracks);
+    LOG(Media, "HTMLMediaElement::configureTextTrackDisplay");
 
     if (m_processingPreferenceChange)
         return;
 
     bool haveVisibleTextTrack = false;
     for (unsigned i = 0; i < m_textTracks->length(); ++i) {
         if (m_textTracks->item(i)->mode() == TextTrack::showingKeyword()) {
             haveVisibleTextTrack = true;
             break;
         }
     }
 
     if (m_haveVisibleTextTrack == haveVisibleTextTrack)
         return;
     m_haveVisibleTextTrack = haveVisibleTextTrack;
     m_closedCaptionsVisible = m_haveVisibleTextTrack;
 
     if (!m_haveVisibleTextTrack && !hasMediaControls())
         return;
     if (!hasMediaControls() && !createMediaControls())
         return;
 
     mediaControls()->changedClosedCaptionsVisibility();
-    
+
     if (RuntimeEnabledFeatures::webkitVideoTrackEnabled())
         updateTextTrackDisplay();
 }
 
 void HTMLMediaElement::captionPreferencesChanged()
 {
     if (!isVideo())
         return;
 
     if (hasMediaControls())
         mediaControls()->textTrackPreferencesChanged();
 
     setClosedCaptionsVisible(userPrefersCaptions());
 }
 
 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).
     for (unsigned i = 0; i < m_textTracks->length(); ++i) {
-        
         RefPtr<TextTrack> textTrack = m_textTracks->item(i);
         String kind = textTrack->kind();
 
         if (kind == TextTrack::subtitlesKeyword() || kind == TextTrack::captionsKeyword())
             textTrack->setHasBeenConfigured(false);
     }
     configureTextTracks();
 }
 
 
@@ skipping 335 matching lines @@
     info.addMember(m_mediaController, "mediaController");
 
 #if ENABLE(WEB_AUDIO)
     info.addMember(m_audioSourceNode, "audioSourceNode");
 #endif
 
 }
 
 }
 #endif