a0131ddffbc92aaf5669c095b9b06a523fef6db5
[WebKit-https.git] / Source / WebCore / Modules / mediacontrols / MediaControlsHost.cpp
1 /*
2  * Copyright (C) 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27
28 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
29
30 #include "MediaControlsHost.h"
31
32 #include "CaptionUserPreferences.h"
33 #include "Element.h"
34 #include "HTMLMediaElement.h"
35 #include "MediaControlElements.h"
36 #include "Page.h"
37 #include "PageGroup.h"
38 #include "TextTrack.h"
39 #include "TextTrackList.h"
40
41 namespace WebCore {
42
43 const AtomicString& MediaControlsHost::automaticKeyword()
44 {
45     DEFINE_STATIC_LOCAL(const AtomicString, automatic, ("automatic", AtomicString::ConstructFromLiteral));
46     return automatic;
47 }
48
49 const AtomicString& MediaControlsHost::forcedOnlyKeyword()
50 {
51     DEFINE_STATIC_LOCAL(const AtomicString, forcedOn, ("forced-only", AtomicString::ConstructFromLiteral));
52     return forcedOn;
53 }
54
55 const AtomicString& MediaControlsHost::alwaysOnKeyword()
56 {
57     DEFINE_STATIC_LOCAL(const AtomicString, alwaysOn, ("always-on", AtomicString::ConstructFromLiteral));
58     return alwaysOn;
59 }
60
61 PassRefPtr<MediaControlsHost> MediaControlsHost::create(HTMLMediaElement* mediaElement)
62 {
63     return adoptRef(new MediaControlsHost(mediaElement));
64 }
65
66 MediaControlsHost::MediaControlsHost(HTMLMediaElement* mediaElement)
67     : m_mediaElement(mediaElement)
68 {
69     ASSERT(mediaElement);
70 }
71
72 MediaControlsHost::~MediaControlsHost()
73 {
74 }
75
76 Vector<RefPtr<TextTrack>> MediaControlsHost::sortedTrackListForMenu(TextTrackList* trackList)
77 {
78     if (!trackList)
79         return Vector<RefPtr<TextTrack>>();
80
81     Page* page = m_mediaElement->document().page();
82     if (!page)
83         return Vector<RefPtr<TextTrack>>();
84
85     CaptionUserPreferences* captionPreferences = page->group().captionPreferences();
86     return captionPreferences->sortedTrackListForMenu(trackList);
87 }
88
89 String MediaControlsHost::displayNameForTrack(TextTrack* track)
90 {
91     if (!track)
92         return emptyString();
93
94     Page* page = m_mediaElement->document().page();
95     if (!page)
96         return emptyString();
97
98     CaptionUserPreferences* captionPreferences = page->group().captionPreferences();
99     return captionPreferences->displayNameForTrack(track);
100 }
101
102 TextTrack* MediaControlsHost::captionMenuOffItem()
103 {
104     return TextTrack::captionMenuOffItem();
105 }
106
107 TextTrack* MediaControlsHost::captionMenuAutomaticItem()
108 {
109     return TextTrack::captionMenuAutomaticItem();
110 }
111
112 AtomicString MediaControlsHost::captionDisplayMode()
113 {
114     Page* page = m_mediaElement->document().page();
115     if (!page)
116         return emptyAtom;
117
118     switch (page->group().captionPreferences()->captionDisplayMode()) {
119     case CaptionUserPreferences::Automatic:
120         return automaticKeyword();
121     case CaptionUserPreferences::ForcedOnly:
122         return forcedOnlyKeyword();
123     case CaptionUserPreferences::AlwaysOn:
124         return alwaysOnKeyword();
125     default:
126         ASSERT_NOT_REACHED();
127         return emptyAtom;
128     }
129 }
130
131 void MediaControlsHost::setSelectedTextTrack(TextTrack* track)
132 {
133     m_mediaElement->setSelectedTextTrack(track);
134 }
135
136 Element* MediaControlsHost::textTrackContainer()
137 {
138     if (!m_textTrackContainer) {
139         m_textTrackContainer = MediaControlTextTrackContainerElement::create(m_mediaElement->document());
140         m_textTrackContainer->setMediaController(m_mediaElement);
141     }
142     return m_textTrackContainer.get();
143 }
144
145 void MediaControlsHost::updateTextTrackContainer()
146 {
147     if (m_textTrackContainer)
148         m_textTrackContainer->updateDisplay();
149 }
150
151 bool MediaControlsHost::mediaPlaybackAllowsInline() const
152 {
153     return !m_mediaElement->mediaSession().requiresFullscreenForVideoPlayback(*m_mediaElement);
154 }
155
156 bool MediaControlsHost::supportsFullscreen()
157 {
158     return m_mediaElement->supportsFullscreen();
159 }
160
161 bool MediaControlsHost::userGestureRequired() const
162 {
163     return !m_mediaElement->mediaSession().playbackPermitted(*m_mediaElement);
164 }
165
166 }
167
168 #endif