Support text track selection in video controls

third_party/WebKit/Source/core/html/shadow/MediaControls.cpp

 /*
  * Copyright (C) 2011, 2012 Apple Inc. All rights reserved.
  * Copyright (C) 2011, 2012 Google 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 94 matching lines @@
     , m_overlayCastButton(nullptr)
     , m_enclosure(nullptr)
     , m_panel(nullptr)
     , m_playButton(nullptr)
     , m_timeline(nullptr)
     , m_currentTimeDisplay(nullptr)
     , m_durationDisplay(nullptr)
     , m_muteButton(nullptr)
     , m_volumeSlider(nullptr)
     , m_toggleClosedCaptionsButton(nullptr)
+    , m_textTrackList(nullptr)
     , m_castButton(nullptr)
     , m_fullScreenButton(nullptr)
     , m_hideMediaControlsTimer(this, &MediaControls::hideMediaControlsTimerFired)
     , m_hideTimerBehaviorFlags(IgnoreNone)
     , m_isMouseOverControls(false)
     , m_isPausedForScrubbing(false)
     , m_panelWidthChangedTimer(this, &MediaControls::panelWidthChangedTimerFired)
     , m_panelWidth(0)
     , m_allowHiddenVolumeControls(RuntimeEnabledFeatures::newMediaPlaybackUiEnabled())
 {
@@ skipping 19 matching lines @@
 //     +-MediaControlPlayButtonElement                 (-webkit-media-controls-play-button)
 //     | {if !RTE::newMediaPlaybackUi()}
 //     +-MediaControlTimelineElement                   (-webkit-media-controls-timeline)
 //     +-MediaControlCurrentTimeDisplayElement         (-webkit-media-controls-current-time-display)
 //     +-MediaControlTimeRemainingDisplayElement       (-webkit-media-controls-time-remaining-display)
 //     | {if RTE::newMediaPlaybackUi()}
 //     +-MediaControlTimelineElement                   (-webkit-media-controls-timeline)
 //     +-MediaControlMuteButtonElement                 (-webkit-media-controls-mute-button)
 //     +-MediaControlVolumeSliderElement               (-webkit-media-controls-volume-slider)
 //     +-MediaControlToggleClosedCaptionsButtonElement (-webkit-media-controls-toggle-closed-captions-button)
+//     +-MediaControlTextTrackListElement              (-internal-media-controls-text-track-list)
+//     | +-MediaControlTextTrackListHeader             (-internal-media-controls-text-track-list-header)

[fs, 2016/02/23 13:16:44]

Maybe add some indication that there can one/zero or more of some of these.
Likewise either/or etc.

[srivats, 2016/02/24 05:20:17]

Would a comment be appropriate here?
The structure looks very simple with no comments for any of the other elements.

[fs, 2016/02/24 10:14:57]

Could be something like:

N*MediaControlTextTrackList...

or

| <for each renderable track>
+-MediaControlTextTrackList...

or

+-MediaControlTextTrackList...<0>
+-...
+-MediaControlTextTrackList...<N-1>

or some variant thereof. Bonus points if it actually somewhat captures the
actual DOM structure.

[srivats, 2016/02/25 21:47:56]

Done.

+//     | +-MediaControlTextTrackListItem               (-internal-media-controls-text-track-list-item)

[fs, 2016/02/23 13:16:44]

uNit: I think we've used '\' for these kinds of "turns" elsewhere.

[srivats, 2016/02/24 05:20:17]

Done.

+//       | +-MediaControlTextTrackListItemInput        (-internal-media-controls-text-track-list-item-input)
+//       | +-MediaControlTextTrackListItemCaptions     (-internal-media-controls-text-track-list-kind-captions)
+//       | +-MediaControlTextTrackListItemSubtitles    (-internal-media-controls-text-track-list-kind-subtitles)
 //     +-MediaControlCastButtonElement                 (-internal-media-controls-cast-button)
 //     \-MediaControlFullscreenButtonElement           (-webkit-media-controls-fullscreen-button)
 void MediaControls::initializeControls()
 {
     const bool useNewUi = RuntimeEnabledFeatures::newMediaPlaybackUiEnabled();
     RefPtrWillBeRawPtr<MediaControlOverlayEnclosureElement> overlayEnclosure = MediaControlOverlayEnclosureElement::create(*this);
 
     if (document().settings() && document().settings()->mediaControlsOverlayPlayButtonEnabled()) {
         RefPtrWillBeRawPtr<MediaControlOverlayPlayButtonElement> overlayPlayButton = MediaControlOverlayPlayButtonElement::create(*this);
         m_overlayPlayButton = overlayPlayButton.get();
@@ skipping 54 matching lines @@
     m_castButton = castButton.get();
     panel->appendChild(castButton.release());
 
     RefPtrWillBeRawPtr<MediaControlFullscreenButtonElement> fullscreenButton = MediaControlFullscreenButtonElement::create(*this);
     m_fullScreenButton = fullscreenButton.get();
     panel->appendChild(fullscreenButton.release());
 
     m_panel = panel.get();
     enclosure->appendChild(panel.release());
 
+    RefPtrWillBeRawPtr<MediaControlTextTrackListElement> textTrackList = MediaControlTextTrackListElement::create(*this);
+    m_textTrackList = textTrackList.get();
+    enclosure->appendChild(textTrackList.release());
+
     m_enclosure = enclosure.get();
     appendChild(enclosure.release());
 }
 
 void MediaControls::reset()
 {
     const bool useNewUi = RuntimeEnabledFeatures::newMediaPlaybackUiEnabled();
     BatchedControlUpdate batch(this);
 
     m_allowHiddenVolumeControls = useNewUi;
@@ skipping 206 matching lines @@
 {
     m_toggleClosedCaptionsButton->updateDisplayType();
 }
 
 void MediaControls::refreshClosedCaptionsButtonVisibility()
 {
     m_toggleClosedCaptionsButton->setIsWanted(mediaElement().hasClosedCaptions());
     BatchedControlUpdate batch(this);
 }
 
+void MediaControls::toggleTextTrackList()
+{
+    if (!mediaElement().hasClosedCaptions())
+        return;
+
+    if (!m_textTrackList->isHidden()) {
+        m_textTrackList->setIsWanted(false);

[fs, 2016/02/23 13:16:44]

I'm not sure the "is wanted" mechanism is really appropriate for this list? I
mean it probably works, but it sort of suggests that it operates within the same
"constraints" system as the control buttons - which I don't think it does? Maybe
hide this semantic twist in a helper method?

[srivats, 2016/02/24 05:20:18]

Added a wrapper that calls setIsWanted within that. I still feel this is a bit
redundant though.

[fs, 2016/02/24 10:14:57]

Well, the refresh call could be handled by the helper too and then we'd just
have:

m_textTrackList->displayTextTrackList(m_textTrackList->isHidden());

here (and having TextTrackList in the method name might be a bit redundant...)

[srivats, 2016/02/25 21:47:56]

Done.

+    } else {
+        m_textTrackList->refreshTextTrackListMenu();
+        m_textTrackList->setIsWanted(true);
+    }
+}
+
 void MediaControls::refreshCastButtonVisibility()
 {
     refreshCastButtonVisibilityWithoutUpdate();
     BatchedControlUpdate batch(this);
 }
 
 void MediaControls::refreshCastButtonVisibilityWithoutUpdate()
 {
     if (!shouldShowCastButton(mediaElement())) {
         m_castButton->setIsWanted(false);
@@ skipping 279 matching lines @@
     visitor->trace(m_overlayEnclosure);
     visitor->trace(m_playButton);
     visitor->trace(m_currentTimeDisplay);
     visitor->trace(m_timeline);
     visitor->trace(m_muteButton);
     visitor->trace(m_volumeSlider);
     visitor->trace(m_toggleClosedCaptionsButton);
     visitor->trace(m_fullScreenButton);
     visitor->trace(m_durationDisplay);
     visitor->trace(m_enclosure);
+    visitor->trace(m_textTrackList);
     visitor->trace(m_castButton);
     visitor->trace(m_overlayCastButton);
     HTMLDivElement::trace(visitor);
 }
 
 } // namespace blink