2 * Copyright (C) 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
3 * Copyright (C) 2011 Google Inc. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include "MediaControlRootElement.h"
33 #include "HTMLMediaElement.h"
34 #include "HTMLNames.h"
35 #include "MediaControlElements.h"
36 #include "MouseEvent.h"
38 #include "RenderTheme.h"
41 #if ENABLE(VIDEO_TRACK)
42 #include "TextTrackCue.h"
49 static const double timeWithoutMouseMovementBeforeHidingControls = 3;
51 MediaControlRootElement::MediaControlRootElement(Document* document)
52 : MediaControls(document)
53 , m_mediaController(0)
56 , m_returnToRealTimeButton(0)
58 , m_currentTimeDisplay(0)
60 , m_timeRemainingDisplay(0)
61 , m_timelineContainer(0)
63 , m_seekForwardButton(0)
64 , m_toggleClosedCaptionsButton(0)
65 , m_panelMuteButton(0)
67 , m_volumeSliderMuteButton(0)
68 , m_volumeSliderContainer(0)
69 , m_fullScreenButton(0)
70 , m_fullScreenMinVolumeButton(0)
71 , m_fullScreenVolumeSlider(0)
72 , m_fullScreenMaxVolumeButton(0)
74 #if ENABLE(VIDEO_TRACK)
75 , m_textDisplayContainer(0)
77 #if ENABLE(TIZEN_GSTREAMER_VIDEO)
78 , m_hideControlsTimer(this, &MediaControlRootElement::hideControlsTimerFired)
80 , m_hideFullscreenControlsTimer(this, &MediaControlRootElement::hideFullscreenControlsTimerFired)
82 , m_isMouseOverControls(false)
83 , m_isFullscreen(false)
87 PassRefPtr<MediaControls> MediaControls::create(Document* document)
89 return MediaControlRootElement::create(document);
92 PassRefPtr<MediaControlRootElement> MediaControlRootElement::create(Document* document)
94 if (!document->page())
97 RefPtr<MediaControlRootElement> controls = adoptRef(new MediaControlRootElement(document));
99 RefPtr<MediaControlPanelElement> panel = MediaControlPanelElement::create(document);
103 RefPtr<MediaControlRewindButtonElement> rewindButton = MediaControlRewindButtonElement::create(document);
104 controls->m_rewindButton = rewindButton.get();
105 panel->appendChild(rewindButton.release(), ec, true);
109 RefPtr<MediaControlPlayButtonElement> playButton = MediaControlPlayButtonElement::create(document);
110 controls->m_playButton = playButton.get();
111 panel->appendChild(playButton.release(), ec, true);
115 RefPtr<MediaControlReturnToRealtimeButtonElement> returnToRealtimeButton = MediaControlReturnToRealtimeButtonElement::create(document);
116 controls->m_returnToRealTimeButton = returnToRealtimeButton.get();
117 panel->appendChild(returnToRealtimeButton.release(), ec, true);
121 if (document->page()->theme()->usesMediaControlStatusDisplay()) {
122 RefPtr<MediaControlStatusDisplayElement> statusDisplay = MediaControlStatusDisplayElement::create(document);
123 controls->m_statusDisplay = statusDisplay.get();
124 panel->appendChild(statusDisplay.release(), ec, true);
129 RefPtr<MediaControlTimelineContainerElement> timelineContainer = MediaControlTimelineContainerElement::create(document);
131 RefPtr<MediaControlCurrentTimeDisplayElement> currentTimeDisplay = MediaControlCurrentTimeDisplayElement::create(document);
132 controls->m_currentTimeDisplay = currentTimeDisplay.get();
133 timelineContainer->appendChild(currentTimeDisplay.release(), ec, true);
137 RefPtr<MediaControlTimelineElement> timeline = MediaControlTimelineElement::create(document, controls.get());
138 controls->m_timeline = timeline.get();
139 timelineContainer->appendChild(timeline.release(), ec, true);
143 RefPtr<MediaControlTimeRemainingDisplayElement> timeRemainingDisplay = MediaControlTimeRemainingDisplayElement::create(document);
144 controls->m_timeRemainingDisplay = timeRemainingDisplay.get();
145 timelineContainer->appendChild(timeRemainingDisplay.release(), ec, true);
149 controls->m_timelineContainer = timelineContainer.get();
150 panel->appendChild(timelineContainer.release(), ec, true);
154 // FIXME: Only create when needed <http://webkit.org/b/57163>
155 RefPtr<MediaControlSeekBackButtonElement> seekBackButton = MediaControlSeekBackButtonElement::create(document);
156 controls->m_seekBackButton = seekBackButton.get();
157 panel->appendChild(seekBackButton.release(), ec, true);
161 // FIXME: Only create when needed <http://webkit.org/b/57163>
162 RefPtr<MediaControlSeekForwardButtonElement> seekForwardButton = MediaControlSeekForwardButtonElement::create(document);
163 controls->m_seekForwardButton = seekForwardButton.get();
164 panel->appendChild(seekForwardButton.release(), ec, true);
168 if (document->page()->theme()->supportsClosedCaptioning()) {
169 RefPtr<MediaControlToggleClosedCaptionsButtonElement> toggleClosedCaptionsButton = MediaControlToggleClosedCaptionsButtonElement::create(document);
170 controls->m_toggleClosedCaptionsButton = toggleClosedCaptionsButton.get();
171 panel->appendChild(toggleClosedCaptionsButton.release(), ec, true);
176 // FIXME: Only create when needed <http://webkit.org/b/57163>
177 RefPtr<MediaControlFullscreenButtonElement> fullScreenButton = MediaControlFullscreenButtonElement::create(document, controls.get());
178 controls->m_fullScreenButton = fullScreenButton.get();
179 panel->appendChild(fullScreenButton.release(), ec, true);
181 // The mute button and the slider element should be in the same div.
182 RefPtr<HTMLDivElement> panelVolumeControlContainer = HTMLDivElement::create(document);
184 if (document->page()->theme()->usesMediaControlVolumeSlider()) {
185 RefPtr<MediaControlVolumeSliderContainerElement> volumeSliderContainer = MediaControlVolumeSliderContainerElement::create(document);
187 RefPtr<MediaControlVolumeSliderElement> slider = MediaControlVolumeSliderElement::create(document);
188 controls->m_volumeSlider = slider.get();
189 volumeSliderContainer->appendChild(slider.release(), ec, true);
193 // This is a duplicate mute button, which is visible in some ports at the bottom of the volume bar.
194 // It's important only when the volume bar is displayed below the controls.
195 RefPtr<MediaControlVolumeSliderMuteButtonElement> volumeSliderMuteButton = MediaControlVolumeSliderMuteButtonElement::create(document);
196 controls->m_volumeSliderMuteButton = volumeSliderMuteButton.get();
197 volumeSliderContainer->appendChild(volumeSliderMuteButton.release(), ec, true);
202 controls->m_volumeSliderContainer = volumeSliderContainer.get();
203 panelVolumeControlContainer->appendChild(volumeSliderContainer.release(), ec, true);
208 RefPtr<MediaControlPanelMuteButtonElement> panelMuteButton = MediaControlPanelMuteButtonElement::create(document, controls.get());
209 controls->m_panelMuteButton = panelMuteButton.get();
210 panelVolumeControlContainer->appendChild(panelMuteButton.release(), ec, true);
214 panel->appendChild(panelVolumeControlContainer, ec, true);
218 // FIXME: Only create when needed <http://webkit.org/b/57163>
219 RefPtr<MediaControlFullscreenVolumeMinButtonElement> fullScreenMinVolumeButton = MediaControlFullscreenVolumeMinButtonElement::create(document);
220 controls->m_fullScreenMinVolumeButton = fullScreenMinVolumeButton.get();
221 panel->appendChild(fullScreenMinVolumeButton.release(), ec, true);
225 RefPtr<MediaControlFullscreenVolumeSliderElement> fullScreenVolumeSlider = MediaControlFullscreenVolumeSliderElement::create(document);
226 controls->m_fullScreenVolumeSlider = fullScreenVolumeSlider.get();
227 panel->appendChild(fullScreenVolumeSlider.release(), ec, true);
231 RefPtr<MediaControlFullscreenVolumeMaxButtonElement> fullScreenMaxVolumeButton = MediaControlFullscreenVolumeMaxButtonElement::create(document);
232 controls->m_fullScreenMaxVolumeButton = fullScreenMaxVolumeButton.get();
233 panel->appendChild(fullScreenMaxVolumeButton.release(), ec, true);
237 controls->m_panel = panel.get();
238 controls->appendChild(panel.release(), ec, true);
242 return controls.release();
245 void MediaControlRootElement::setMediaController(MediaControllerInterface* controller)
247 if (m_mediaController == controller)
249 m_mediaController = controller;
252 m_rewindButton->setMediaController(controller);
254 m_playButton->setMediaController(controller);
255 if (m_returnToRealTimeButton)
256 m_returnToRealTimeButton->setMediaController(controller);
258 m_statusDisplay->setMediaController(controller);
259 if (m_currentTimeDisplay)
260 m_currentTimeDisplay->setMediaController(controller);
262 m_timeline->setMediaController(controller);
263 if (m_timeRemainingDisplay)
264 m_timeRemainingDisplay->setMediaController(controller);
265 if (m_timelineContainer)
266 m_timelineContainer->setMediaController(controller);
267 if (m_seekBackButton)
268 m_seekBackButton->setMediaController(controller);
269 if (m_seekForwardButton)
270 m_seekForwardButton->setMediaController(controller);
271 if (m_toggleClosedCaptionsButton)
272 m_toggleClosedCaptionsButton->setMediaController(controller);
273 if (m_panelMuteButton)
274 m_panelMuteButton->setMediaController(controller);
276 m_volumeSlider->setMediaController(controller);
277 if (m_volumeSliderMuteButton)
278 m_volumeSliderMuteButton->setMediaController(controller);
279 if (m_volumeSliderContainer)
280 m_volumeSliderContainer->setMediaController(controller);
281 if (m_fullScreenButton)
282 m_fullScreenButton->setMediaController(controller);
283 if (m_fullScreenMinVolumeButton)
284 m_fullScreenMinVolumeButton->setMediaController(controller);
285 if (m_fullScreenVolumeSlider)
286 m_fullScreenVolumeSlider->setMediaController(controller);
287 if (m_fullScreenMaxVolumeButton)
288 m_fullScreenMaxVolumeButton->setMediaController(controller);
290 m_panel->setMediaController(controller);
291 #if ENABLE(VIDEO_TRACK)
292 if (m_textDisplayContainer)
293 m_textDisplayContainer->setMediaController(controller);
298 void MediaControlRootElement::show()
300 m_panel->setIsDisplayed(true);
304 void MediaControlRootElement::hide()
306 m_panel->setIsDisplayed(false);
308 m_volumeSliderContainer->hide();
311 void MediaControlRootElement::makeOpaque()
313 m_panel->makeOpaque();
316 void MediaControlRootElement::makeTransparent()
318 m_panel->makeTransparent();
319 m_volumeSliderContainer->hide();
322 void MediaControlRootElement::reset()
324 Page* page = document()->page();
328 updateStatusDisplay();
330 if (m_mediaController->supportsFullscreen())
331 m_fullScreenButton->show();
333 m_fullScreenButton->hide();
335 float duration = m_mediaController->duration();
336 if (isfinite(duration) || page->theme()->hasOwnDisabledStateHandlingFor(MediaSliderPart)) {
337 m_timeline->setDuration(duration);
338 m_timelineContainer->show();
339 m_timeline->setPosition(m_mediaController->currentTime());
342 m_timelineContainer->hide();
344 if (m_mediaController->hasAudio() || page->theme()->hasOwnDisabledStateHandlingFor(MediaMuteButtonPart))
345 m_panelMuteButton->show();
347 m_panelMuteButton->hide();
350 m_volumeSlider->setVolume(m_mediaController->volume());
352 if (m_toggleClosedCaptionsButton) {
353 if (m_mediaController->hasClosedCaptions())
354 m_toggleClosedCaptionsButton->show();
356 m_toggleClosedCaptionsButton->hide();
359 m_playButton->updateDisplayType();
361 #if ENABLE(FULLSCREEN_API)
362 if (m_fullScreenVolumeSlider)
363 m_fullScreenVolumeSlider->setVolume(m_mediaController->volume());
365 if (m_isFullscreen) {
366 if (m_mediaController->isLiveStream()) {
367 m_seekBackButton->hide();
368 m_seekForwardButton->hide();
369 m_rewindButton->show();
370 m_returnToRealTimeButton->show();
372 m_seekBackButton->show();
373 m_seekForwardButton->show();
374 m_rewindButton->hide();
375 m_returnToRealTimeButton->hide();
379 if (!m_mediaController->isLiveStream()) {
380 m_returnToRealTimeButton->hide();
381 m_rewindButton->show();
383 m_returnToRealTimeButton->show();
384 m_rewindButton->hide();
390 void MediaControlRootElement::playbackStarted()
392 m_playButton->updateDisplayType();
393 m_timeline->setPosition(m_mediaController->currentTime());
396 #if ENABLE(TIZEN_GSTREAMER_VIDEO)
397 m_hideControlsTimer.startOneShot(timeWithoutMouseMovementBeforeHidingControls);
400 startHideFullscreenControlsTimer();
404 void MediaControlRootElement::playbackProgressed()
406 m_timeline->setPosition(m_mediaController->currentTime());
409 #if !ENABLE(TIZEN_GSTREAMER_VIDEO)
410 if (!m_isMouseOverControls && m_mediaController->hasVideo())
415 void MediaControlRootElement::playbackStopped()
417 m_playButton->updateDisplayType();
418 m_timeline->setPosition(m_mediaController->currentTime());
422 #if ENABLE(TIZEN_GSTREAMER_VIDEO)
423 m_hideControlsTimer.stop();
425 stopHideFullscreenControlsTimer();
429 void MediaControlRootElement::updateTimeDisplay()
431 float now = m_mediaController->currentTime();
432 float duration = m_mediaController->duration();
434 Page* page = document()->page();
438 // Allow the theme to format the time.
440 m_currentTimeDisplay->setInnerText(page->theme()->formatMediaControlsCurrentTime(now, duration), ec);
441 m_currentTimeDisplay->setCurrentValue(now);
443 #if ENABLE(TIZEN_GSTREAMER_VIDEO)
444 m_timeRemainingDisplay->setInnerText(page->theme()->formatMediaControlsTime(duration), ec);
445 m_timeRemainingDisplay->setCurrentValue(duration);
447 m_timeRemainingDisplay->setInnerText(page->theme()->formatMediaControlsRemainingTime(now, duration), ec);
448 m_timeRemainingDisplay->setCurrentValue(now - duration);
452 void MediaControlRootElement::reportedError()
454 Page* page = document()->page();
458 if (!page->theme()->hasOwnDisabledStateHandlingFor(MediaSliderPart))
459 m_timelineContainer->hide();
461 if (!page->theme()->hasOwnDisabledStateHandlingFor(MediaMuteButtonPart))
462 m_panelMuteButton->hide();
464 m_fullScreenButton->hide();
466 if (m_volumeSliderContainer)
467 m_volumeSliderContainer->hide();
468 if (m_toggleClosedCaptionsButton && !page->theme()->hasOwnDisabledStateHandlingFor(MediaToggleClosedCaptionsButtonPart))
469 m_toggleClosedCaptionsButton->hide();
472 void MediaControlRootElement::updateStatusDisplay()
475 m_statusDisplay->update();
478 void MediaControlRootElement::loadedMetadata()
480 if (m_statusDisplay && m_mediaController->isLiveStream())
481 m_statusDisplay->hide();
486 void MediaControlRootElement::changedClosedCaptionsVisibility()
488 if (m_toggleClosedCaptionsButton)
489 m_toggleClosedCaptionsButton->updateDisplayType();
492 void MediaControlRootElement::changedMute()
494 m_panelMuteButton->changedMute();
495 if (m_volumeSliderMuteButton)
496 m_volumeSliderMuteButton->changedMute();
499 void MediaControlRootElement::changedVolume()
502 m_volumeSlider->setVolume(m_mediaController->volume());
505 void MediaControlRootElement::enteredFullscreen()
507 m_isFullscreen = true;
509 if (m_mediaController->isLiveStream()) {
510 m_seekBackButton->hide();
511 m_seekForwardButton->hide();
512 m_rewindButton->show();
513 m_returnToRealTimeButton->show();
515 m_seekBackButton->show();
516 m_seekForwardButton->show();
517 m_rewindButton->hide();
518 m_returnToRealTimeButton->hide();
521 m_panel->setCanBeDragged(true);
522 m_fullScreenButton->setIsFullscreen(true);
524 if (Page* page = document()->page()) {
525 page->chrome()->setCursorHiddenUntilMouseMoves(true);
527 #if ENABLE(TIZEN_GSTREAMER_VIDEO) && ENABLE(TIZEN_WEBKIT2_HISTORICAL_RESTORE_VISIBLE_CONTENT_RECT)
528 float scaleFactor = page->chrome()->contentsScaleFactor();
530 m_panel->setInlineStyleProperty(CSSPropertyZoom, 1 / scaleFactor, CSSPrimitiveValue::CSS_NUMBER);
534 #if !ENABLE(TIZEN_GSTREAMER_VIDEO)
535 startHideFullscreenControlsTimer();
539 void MediaControlRootElement::exitedFullscreen()
541 m_isFullscreen = false;
543 // "show" actually means removal of display:none style, so we are just clearing styles
544 // when exiting fullscreen.
545 // FIXME: Clarify naming of show/hide <http://webkit.org/b/58157>
546 m_rewindButton->show();
547 m_seekBackButton->show();
548 m_seekForwardButton->show();
549 m_returnToRealTimeButton->show();
551 m_panel->setCanBeDragged(false);
552 m_fullScreenButton->setIsFullscreen(false);
554 // We will keep using the panel, but we want it to go back to the standard position.
555 // This will matter right away because we use the panel even when not fullscreen.
556 // And if we reenter fullscreen we also want the panel in the standard position.
557 m_panel->resetPosition();
559 #if ENABLE(TIZEN_GSTREAMER_VIDEO) && ENABLE(TIZEN_WEBKIT2_HISTORICAL_RESTORE_VISIBLE_CONTENT_RECT)
560 m_panel->removeInlineStyleProperty(CSSPropertyZoom);
563 #if !ENABLE(TIZEN_GSTREAMER_VIDEO)
564 stopHideFullscreenControlsTimer();
568 void MediaControlRootElement::showVolumeSlider()
570 if (!m_mediaController->hasAudio())
573 if (m_volumeSliderContainer)
574 m_volumeSliderContainer->show();
577 bool MediaControlRootElement::shouldHideControls()
579 return !m_panel->hovered();
582 bool MediaControlRootElement::containsRelatedTarget(Event* event)
584 if (!event->isMouseEvent())
586 EventTarget* relatedTarget = static_cast<MouseEvent*>(event)->relatedTarget();
589 return contains(relatedTarget->toNode());
592 void MediaControlRootElement::defaultEventHandler(Event* event)
594 MediaControls::defaultEventHandler(event);
596 #if ENABLE(TIZEN_GSTREAMER_VIDEO)
597 if (event->type() == eventNames().clickEvent && m_mediaController->hasVideo()) {
598 if (!containsRelatedTarget(event)) {
599 if (m_panel->isOpaque())
603 m_hideControlsTimer.startOneShot(timeWithoutMouseMovementBeforeHidingControls);
608 if (event->type() == eventNames().mouseoverEvent) {
609 if (!containsRelatedTarget(event)) {
610 m_isMouseOverControls = true;
611 if (!m_mediaController->canPlay()) {
613 if (shouldHideControls())
614 startHideFullscreenControlsTimer();
617 } else if (event->type() == eventNames().mouseoutEvent) {
618 if (!containsRelatedTarget(event)) {
619 m_isMouseOverControls = false;
620 stopHideFullscreenControlsTimer();
622 } else if (event->type() == eventNames().mousemoveEvent) {
623 if (m_isFullscreen) {
624 // When we get a mouse move in fullscreen mode, show the media controls, and start a timer
625 // that will hide the media controls after a 3 seconds without a mouse move.
627 if (shouldHideControls())
628 startHideFullscreenControlsTimer();
634 #if ENABLE(TIZEN_GSTREAMER_VIDEO)
635 void MediaControlRootElement::hideControlsTimerFired(Timer<MediaControlRootElement>*)
637 if (m_mediaController->paused())
640 if (!m_mediaController->hasVideo())
643 if (Page* page = document()->page())
644 page->chrome()->setCursorHiddenUntilMouseMoves(true);
649 void MediaControlRootElement::startHideFullscreenControlsTimer()
654 m_hideFullscreenControlsTimer.startOneShot(timeWithoutMouseMovementBeforeHidingControls);
657 void MediaControlRootElement::hideFullscreenControlsTimerFired(Timer<MediaControlRootElement>*)
659 if (m_mediaController->paused())
665 if (!shouldHideControls())
668 if (Page* page = document()->page())
669 page->chrome()->setCursorHiddenUntilMouseMoves(true);
674 void MediaControlRootElement::stopHideFullscreenControlsTimer()
676 m_hideFullscreenControlsTimer.stop();
680 #if ENABLE(VIDEO_TRACK)
681 void MediaControlRootElement::createTextTrackDisplay()
683 if (m_textDisplayContainer)
686 RefPtr<MediaControlTextTrackContainerElement> textDisplayContainer = MediaControlTextTrackContainerElement::create(document());
687 m_textDisplayContainer = textDisplayContainer.get();
689 // Insert it before the first controller element so it always displays behind the controls.
691 insertBefore(textDisplayContainer.release(), m_panel, ec, true);
694 void MediaControlRootElement::showTextTrackDisplay()
696 if (!m_textDisplayContainer)
697 createTextTrackDisplay();
698 m_textDisplayContainer->show();
701 void MediaControlRootElement::hideTextTrackDisplay()
703 if (!m_textDisplayContainer)
704 createTextTrackDisplay();
705 m_textDisplayContainer->hide();
708 void MediaControlRootElement::updateTextTrackDisplay()
710 if (!m_textDisplayContainer)
711 createTextTrackDisplay();
713 m_textDisplayContainer->updateDisplay();
718 const AtomicString& MediaControlRootElement::shadowPseudoId() const
720 DEFINE_STATIC_LOCAL(AtomicString, id, ("-webkit-media-controls"));
724 void MediaControlRootElement::bufferingProgressed()
726 // We only need to update buffering progress when paused, during normal
727 // playback playbackProgressed() will take care of it.
728 if (m_mediaController->paused())
729 m_timeline->setPosition(m_mediaController->currentTime());