Change the volume slider to horizontal rendering for Chrome video controls.
[WebKit-https.git] / Source / WebCore / html / shadow / MediaControlRootElementChromium.cpp
1 /*
2  * Copyright (C) 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2011 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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.
25  */
26
27 #include "config.h"
28
29 #if ENABLE(VIDEO)
30 #include "MediaControlRootElementChromium.h"
31
32 #include "HTMLDivElement.h"
33 #include "HTMLMediaElement.h"
34 #include "HTMLNames.h"
35 #include "MediaControlElements.h"
36 #include "MouseEvent.h"
37 #include "Page.h"
38 #include "RenderTheme.h"
39 #include "Text.h"
40
41 #if ENABLE(VIDEO_TRACK)
42 #include "TextTrackCue.h"
43 #endif
44
45 using namespace std;
46
47 namespace WebCore {
48
49 MediaControlChromiumEnclosureElement::MediaControlChromiumEnclosureElement(Document* document)
50     : HTMLDivElement(HTMLNames::divTag, document->document())
51     , m_mediaController(0)
52 {
53 }
54
55 PassRefPtr<MediaControlChromiumEnclosureElement> MediaControlChromiumEnclosureElement::create(Document* document)
56 {
57     return adoptRef(new MediaControlChromiumEnclosureElement(document));
58 }
59
60 const AtomicString& MediaControlChromiumEnclosureElement::shadowPseudoId() const
61 {
62     DEFINE_STATIC_LOCAL(AtomicString, id, ("-webkit-media-controls-enclosure"));
63     return id;
64 }
65
66 MediaControlRootElementChromium::MediaControlRootElementChromium(Document* document)
67     : MediaControls(document)
68     , m_mediaController(0)
69     , m_playButton(0)
70     , m_currentTimeDisplay(0)
71     , m_timeline(0)
72     , m_timelineContainer(0)
73     , m_panelMuteButton(0)
74     , m_volumeSlider(0)
75 #if ENABLE(FULLSCREEN_MEDIA_CONTROLS)
76     , m_fullscreenButton(0)
77 #endif
78     , m_panel(0)
79     , m_enclosure(0)
80 #if ENABLE(VIDEO_TRACK)
81     , m_textDisplayContainer(0)
82 #endif
83     , m_opaque(true)
84     , m_isMouseOverControls(false)
85 {
86 }
87
88 PassRefPtr<MediaControls> MediaControls::create(Document* document)
89 {
90     return MediaControlRootElementChromium::create(document);
91 }
92
93 PassRefPtr<MediaControlRootElementChromium> MediaControlRootElementChromium::create(Document* document)
94 {
95     if (!document->page())
96         return 0;
97
98     RefPtr<MediaControlRootElementChromium> controls = adoptRef(new MediaControlRootElementChromium(document));
99
100     // Create an enclosing element for the panel so we can visually offset the controls correctly.
101     RefPtr<MediaControlChromiumEnclosureElement> enclosure = MediaControlChromiumEnclosureElement::create(document);
102
103     RefPtr<MediaControlPanelElement> panel = MediaControlPanelElement::create(document);
104
105     ExceptionCode ec;
106
107     RefPtr<MediaControlPlayButtonElement> playButton = MediaControlPlayButtonElement::create(document);
108     controls->m_playButton = playButton.get();
109     panel->appendChild(playButton.release(), ec, true);
110     if (ec)
111         return 0;
112
113     RefPtr<MediaControlTimelineContainerElement> timelineContainer = MediaControlTimelineContainerElement::create(document);
114
115     RefPtr<MediaControlTimelineElement> timeline = MediaControlTimelineElement::create(document, controls.get());
116     controls->m_timeline = timeline.get();
117     timelineContainer->appendChild(timeline.release(), ec, true);
118     if (ec)
119         return 0;
120
121     RefPtr<MediaControlCurrentTimeDisplayElement> currentTimeDisplay = MediaControlCurrentTimeDisplayElement::create(document);
122     controls->m_currentTimeDisplay = currentTimeDisplay.get();
123     timelineContainer->appendChild(currentTimeDisplay.release(), ec, true);
124     if (ec)
125         return 0;
126
127     controls->m_timelineContainer = timelineContainer.get();
128     panel->appendChild(timelineContainer.release(), ec, true);
129     if (ec)
130         return 0;
131
132     RefPtr<MediaControlPanelMuteButtonElement> panelMuteButton = MediaControlPanelMuteButtonElement::create(document, controls.get());
133     controls->m_panelMuteButton = panelMuteButton.get();
134     panel->appendChild(panelMuteButton.release(), ec, true);
135     if (ec)
136         return 0;
137
138     RefPtr<MediaControlVolumeSliderElement> slider = MediaControlVolumeSliderElement::create(document);
139     controls->m_volumeSlider = slider.get();
140     panel->appendChild(slider.release(), ec, true);
141     if (ec)
142         return 0;
143
144 #if ENABLE(FULLSCREEN_MEDIA_CONTROLS)
145     RefPtr<MediaControlFullscreenButtonElement> fullscreenButton = MediaControlFullscreenButtonElement::create(document, controls.get());
146     controls->m_fullscreenButton = fullscreenButton.get();
147     panel->appendChild(fullscreenButton.release(), ec, true);
148     if (ec)
149         return 0;
150 #endif
151
152     controls->m_panel = panel.get();
153     enclosure->appendChild(panel.release(), ec, true);
154     if (ec)
155         return 0;
156
157     controls->m_enclosure = enclosure.get();
158     controls->appendChild(enclosure.release(), ec, true);
159     if (ec)
160         return 0;
161
162     return controls.release();
163 }
164
165 void MediaControlRootElementChromium::setMediaController(MediaControllerInterface* controller)
166 {
167     if (m_mediaController == controller)
168         return;
169     m_mediaController = controller;
170
171     if (m_playButton)
172         m_playButton->setMediaController(controller);
173     if (m_currentTimeDisplay)
174         m_currentTimeDisplay->setMediaController(controller);
175     if (m_timeline)
176         m_timeline->setMediaController(controller);
177     if (m_timelineContainer)
178         m_timelineContainer->setMediaController(controller);
179     if (m_panelMuteButton)
180         m_panelMuteButton->setMediaController(controller);
181     if (m_volumeSlider)
182         m_volumeSlider->setMediaController(controller);
183 #if ENABLE(FULLSCREEN_MEDIA_CONTROLS)
184     if (m_fullscreenButton)
185         m_fullscreenButton->setMediaController(controller);
186 #endif
187     if (m_panel)
188         m_panel->setMediaController(controller);
189     if (m_enclosure)
190         m_enclosure->setMediaController(controller);
191 #if ENABLE(VIDEO_TRACK)
192     if (m_textDisplayContainer)
193         m_textDisplayContainer->setMediaController(controller);
194 #endif
195     reset();
196 }
197
198 void MediaControlRootElementChromium::show()
199 {
200     m_panel->setIsDisplayed(true);
201     m_panel->show();
202 }
203
204 void MediaControlRootElementChromium::hide()
205 {
206     m_panel->setIsDisplayed(false);
207     m_panel->hide();
208 }
209
210 void MediaControlRootElementChromium::makeOpaque()
211 {
212     m_panel->makeOpaque();
213 }
214
215 void MediaControlRootElementChromium::makeTransparent()
216 {
217     m_panel->makeTransparent();
218 }
219
220 void MediaControlRootElementChromium::reset()
221 {
222     Page* page = document()->page();
223     if (!page)
224         return;
225
226     updateStatusDisplay();
227
228     float duration = m_mediaController->duration();
229     m_timeline->setDuration(duration);
230     m_timelineContainer->show();
231     m_timeline->setPosition(m_mediaController->currentTime());
232     updateTimeDisplay();
233
234     m_panelMuteButton->show();
235
236     if (m_volumeSlider)
237         m_volumeSlider->setVolume(m_mediaController->volume());
238
239 #if ENABLE(FULLSCREEN_MEDIA_CONTROLS)
240     m_fullscreenButton->show();
241 #endif
242     makeOpaque();
243 }
244
245 void MediaControlRootElementChromium::playbackStarted()
246 {
247     m_playButton->updateDisplayType();
248     m_timeline->setPosition(m_mediaController->currentTime());
249     updateTimeDisplay();
250 }
251
252 void MediaControlRootElementChromium::playbackProgressed()
253 {
254     m_timeline->setPosition(m_mediaController->currentTime());
255     updateTimeDisplay();
256
257     if (!m_isMouseOverControls && m_mediaController->hasVideo())
258         makeTransparent();
259 }
260
261 void MediaControlRootElementChromium::playbackStopped()
262 {
263     m_playButton->updateDisplayType();
264     m_timeline->setPosition(m_mediaController->currentTime());
265     updateTimeDisplay();
266     makeOpaque();
267 }
268
269 void MediaControlRootElementChromium::updateTimeDisplay()
270 {
271     float now = m_mediaController->currentTime();
272     float duration = m_mediaController->duration();
273
274     Page* page = document()->page();
275     if (!page)
276         return;
277
278     // Allow the theme to format the time.
279     ExceptionCode ec;
280     m_currentTimeDisplay->setInnerText(page->theme()->formatMediaControlsCurrentTime(now, duration), ec);
281     m_currentTimeDisplay->setCurrentValue(now);
282 }
283
284 void MediaControlRootElementChromium::reportedError()
285 {
286     Page* page = document()->page();
287     if (!page)
288         return;
289
290     m_timelineContainer->hide();
291     m_panelMuteButton->hide();
292 #if ENABLE(FULLSCREEN_MEDIA_CONTROLS)
293     m_fullscreenButton->hide();
294 #endif
295     m_volumeSlider->hide();
296 }
297
298 void MediaControlRootElementChromium::updateStatusDisplay()
299 {
300 }
301
302 bool MediaControlRootElementChromium::shouldHideControls()
303 {
304     return !m_panel->hovered();
305 }
306
307 void MediaControlRootElementChromium::loadedMetadata()
308 {
309     reset();
310 }
311
312 bool MediaControlRootElementChromium::containsRelatedTarget(Event* event)
313 {
314     if (!event->isMouseEvent())
315         return false;
316     EventTarget* relatedTarget = static_cast<MouseEvent*>(event)->relatedTarget();
317     if (!relatedTarget)
318         return false;
319     return contains(relatedTarget->toNode());
320 }
321
322 void MediaControlRootElementChromium::defaultEventHandler(Event* event)
323 {
324     MediaControls::defaultEventHandler(event);
325
326     if (event->type() == eventNames().mouseoverEvent) {
327         if (!containsRelatedTarget(event)) {
328             m_isMouseOverControls = true;
329             if (!m_mediaController->canPlay())
330                 makeOpaque();
331         }
332     } else if (event->type() == eventNames().mouseoutEvent) {
333         if (!containsRelatedTarget(event))
334             m_isMouseOverControls = false;
335     }
336 }
337
338 void MediaControlRootElementChromium::changedClosedCaptionsVisibility()
339 {
340 }
341
342 void MediaControlRootElementChromium::changedMute()
343 {
344     m_panelMuteButton->changedMute();
345 }
346
347 void MediaControlRootElementChromium::changedVolume()
348 {
349     m_volumeSlider->setVolume(m_mediaController->volume());
350 }
351
352 void MediaControlRootElementChromium::enteredFullscreen()
353 {
354 }
355
356 void MediaControlRootElementChromium::exitedFullscreen()
357 {
358 }
359
360 void MediaControlRootElementChromium::showVolumeSlider()
361 {
362     if (!m_mediaController->hasAudio())
363         return;
364
365     m_volumeSlider->show();
366 }
367
368 #if ENABLE(VIDEO_TRACK)
369 void MediaControlRootElementChromium::createTextTrackDisplay()
370 {
371     if (m_textDisplayContainer)
372         return;
373
374     RefPtr<MediaControlTextTrackContainerElement> textDisplayContainer = MediaControlTextTrackContainerElement::create(document());
375     m_textDisplayContainer = textDisplayContainer.get();
376
377     // Insert it before the first controller element so it always displays behind the controls.
378     insertBefore(textDisplayContainer.release(), m_enclosure, ASSERT_NO_EXCEPTION, true);
379 }
380
381 void MediaControlRootElementChromium::showTextTrackDisplay()
382 {
383     if (!m_textDisplayContainer)
384         createTextTrackDisplay();
385     m_textDisplayContainer->show();
386 }
387
388 void MediaControlRootElementChromium::hideTextTrackDisplay()
389 {
390     if (!m_textDisplayContainer)
391         createTextTrackDisplay();
392     m_textDisplayContainer->hide();
393 }
394
395 void MediaControlRootElementChromium::updateTextTrackDisplay()
396 {
397     if (!m_textDisplayContainer)
398         createTextTrackDisplay();
399
400     m_textDisplayContainer->updateDisplay();
401 }
402 #endif
403
404 const AtomicString& MediaControlRootElementChromium::shadowPseudoId() const
405 {
406     DEFINE_STATIC_LOCAL(AtomicString, id, ("-webkit-media-controls"));
407     return id;
408 }
409
410 void MediaControlRootElementChromium::bufferingProgressed()
411 {
412     // We only need to update buffering progress when paused, during normal
413     // playback playbackProgressed() will take care of it.
414     if (m_mediaController->paused())
415         m_timeline->setPosition(m_mediaController->currentTime());
416 }
417
418 }
419
420 #endif