Support text track selection in video controls

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 41 matching lines @@
     , m_mediaElement(&mediaElement)
     , m_panel(nullptr)
     , m_overlayPlayButton(nullptr)
     , m_overlayEnclosure(nullptr)
     , m_playButton(nullptr)
     , m_currentTimeDisplay(nullptr)
     , m_timeline(nullptr)
     , m_muteButton(nullptr)
     , m_volumeSlider(nullptr)
     , m_toggleClosedCaptionsButton(nullptr)
+    , m_closedCaptionsTrackListContainer(nullptr)
+    , m_closedCaptionsTrackList(nullptr)
     , m_fullScreenButton(nullptr)
     , m_castButton(nullptr)
     , m_overlayCastButton(nullptr)
     , m_durationDisplay(nullptr)
     , m_enclosure(nullptr)
     , m_hideMediaControlsTimer(this, &MediaControls::hideMediaControlsTimerFired)
     , m_hideTimerBehaviorFlags(IgnoreNone)
     , m_isMouseOverControls(false)
     , m_isPausedForScrubbing(false)
 {
@@ skipping 16 matching lines @@
 // | \-MediaControlCastButtonElement                   (-internal-media-controls-overlay-cast-button)
 // \-MediaControlPanelEnclosureElement                 (-webkit-media-controls-enclosure)
 //   \-MediaControlPanelElement                        (-webkit-media-controls-panel)
 //     +-MediaControlPlayButtonElement                 (-webkit-media-controls-play-button)
 //     +-MediaControlTimelineElement                   (-webkit-media-controls-timeline)
 //     +-MediaControlCurrentTimeDisplayElement         (-webkit-media-controls-current-time-display)
 //     +-MediaControlTimeRemainingDisplayElement       (-webkit-media-controls-time-remaining-display)
 //     +-MediaControlMuteButtonElement                 (-webkit-media-controls-mute-button)
 //     +-MediaControlVolumeSliderElement               (-webkit-media-controls-volume-slider)
 //     +-MediaControlToggleClosedCaptionsButtonElement (-webkit-media-controls-toggle-closed-captions-button)
+//     +-MediaControlClosedCaptionsTrackListContainerElement (-webkit-media-controls-closed-captions-track-list-container)
+//     +-MediaControlClosedCaptionsTrackListElement    (-webkit-media-controls-closed-captions-track-list)
 //     +-MediaControlCastButtonElement                 (-internal-media-controls-cast-button)
 //     \-MediaControlFullscreenButtonElement           (-webkit-media-controls-fullscreen-button)
 void MediaControls::initializeControls()
 {
     RefPtrWillBeRawPtr<MediaControlOverlayEnclosureElement> overlayEnclosure = MediaControlOverlayEnclosureElement::create(*this);
 
     if (document().settings() && document().settings()->mediaControlsOverlayPlayButtonEnabled()) {
         RefPtrWillBeRawPtr<MediaControlOverlayPlayButtonElement> overlayPlayButton = MediaControlOverlayPlayButtonElement::create(*this);
         m_overlayPlayButton = overlayPlayButton.get();
         overlayEnclosure->appendChild(overlayPlayButton.release());
@@ skipping 33 matching lines @@
     panel->appendChild(muteButton.release());
 
     RefPtrWillBeRawPtr<MediaControlVolumeSliderElement> slider = MediaControlVolumeSliderElement::create(*this);
     m_volumeSlider = slider.get();
     panel->appendChild(slider.release());
 
     RefPtrWillBeRawPtr<MediaControlToggleClosedCaptionsButtonElement> toggleClosedCaptionsButton = MediaControlToggleClosedCaptionsButtonElement::create(*this);
     m_toggleClosedCaptionsButton = toggleClosedCaptionsButton.get();
     panel->appendChild(toggleClosedCaptionsButton.release());
 
+    RefPtrWillBeRawPtr<MediaControlClosedCaptionsTrackListContainerElement> closedCaptionsTrackListContainer =
+        MediaControlClosedCaptionsTrackListContainerElement::create(*this);
+    m_closedCaptionsTrackListContainer = closedCaptionsTrackListContainer.get();
+    RefPtrWillBeRawPtr<MediaControlClosedCaptionsTrackListElement> closedCaptionsTrackList =
+        MediaControlClosedCaptionsTrackListElement::create(*this);
+    m_closedCaptionsTrackList = closedCaptionsTrackList.get();
+    m_closedCaptionsTrackListContainer->appendChild(closedCaptionsTrackList.release());
+    panel->appendChild(closedCaptionsTrackListContainer.release());
+
     RefPtrWillBeRawPtr<MediaControlCastButtonElement> castButton = MediaControlCastButtonElement::create(*this, false);
     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());
@@ skipping 186 matching lines @@
 }
 
 void MediaControls::refreshClosedCaptionsButtonVisibility()
 {
     if (mediaElement().hasClosedCaptions())
         m_toggleClosedCaptionsButton->show();
     else
         m_toggleClosedCaptionsButton->hide();
 }
 
+void MediaControls::toggleClosedCaptionsTrackList()
+{
+    if (!mediaElement().hasClosedCaptions() || !m_closedCaptionsTrackListContainer)

[fs, 2015/04/14 12:34:57]

m_closedCaptionsTrackListContainer is always created/set when creating the
controls, so this check seems redundant.

Also, what if the tracks are removed when the menu is open - what handles that.

[srivats, 2015/04/16 23:37:20]

Removed
If the tracks are removed while the menu is open, the user can still click on
the items in the track list but they don't do anything functionally(shows
checkmark). Once the menu is dismissed, you can't bring it back up again unless
new tracks are added cause there is no CC button anymore and no tracks to show.

+        return;
+
+    bool isTrackListVisible = m_closedCaptionsTrackListContainer->isVisible();
+    // Media controls panel has overflow set to hidden. To display track list,

[fs, 2015/04/14 12:34:57]

Maybe this is an indication that the menu should not be within the panel then?

[srivats, 2015/04/16 23:37:20]

Seems logical to be a part of media controls because the CC button brings this
menu up. Do you have an alternate approach for this?

[fs, 2015/04/17 11:54:46]

Well, first, a menu that's part of the page has a few issue in that it may end
up being clipped by the viewport... (compare for instance with <select>)

Ignoring that though, it should be possible to stack the text track menu on top
of the panel, since its layout is independent (AFAICS). Therë́'s already lots of
other "overlays" present in the control shadow tree.

[srivats, 2015/04/21 01:48:55]

Moved it out of media controls panel and added it to the enclosure instead.

+    // overflow has to be set to visible.
+    m_panel->setInlineStyleProperty(CSSPropertyOverflow, CSSValueVisible, isTrackListVisible);
+    if (isTrackListVisible) {
+        m_closedCaptionsTrackListContainer->hide();
+        m_closedCaptionsTrackList->hide();
+    } else {
+        m_closedCaptionsTrackListContainer->show();
+        m_closedCaptionsTrackList->refreshTextTrackListMenu();
+        m_closedCaptionsTrackList->show();
+    }
+}
+
 static Element* elementFromCenter(Element& element)
 {
     RefPtrWillBeRawPtr<ClientRect> clientRect = element.getBoundingClientRect();
     int centerX = static_cast<int>((clientRect->left() + clientRect->right()) / 2);
     int centerY = static_cast<int>((clientRect->top() + clientRect->bottom()) / 2);
 
     return element.document().elementFromPoint(centerX , centerY);
 }
 
 void MediaControls::tryShowOverlayCastButton()
@@ skipping 162 matching lines @@
     visitor->trace(m_toggleClosedCaptionsButton);
     visitor->trace(m_fullScreenButton);
     visitor->trace(m_durationDisplay);
     visitor->trace(m_enclosure);
     visitor->trace(m_castButton);
     visitor->trace(m_overlayCastButton);
     HTMLDivElement::trace(visitor);
 }
 
 }