initial import
[vuplus_webkit] / Source / WebCore / accessibility / AccessibilityMediaControls.cpp
1 /*
2  * Copyright (C) 2009 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  *
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  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29
30 #include "config.h"
31
32 #if ENABLE(VIDEO)
33
34 #include "AccessibilityMediaControls.h"
35
36 #include "AXObjectCache.h"
37 #include "HTMLInputElement.h"
38 #include "HTMLNames.h"
39 #include "LocalizedStrings.h"
40 #include "MediaControlElements.h"
41 #include "RenderObject.h"
42 #include "RenderSlider.h"
43
44 namespace WebCore {
45
46 using namespace HTMLNames;
47
48
49 AccessibilityMediaControl::AccessibilityMediaControl(RenderObject* renderer)
50     : AccessibilityRenderObject(renderer)
51 {
52 }
53
54 PassRefPtr<AccessibilityObject> AccessibilityMediaControl::create(RenderObject* renderer)
55 {
56     ASSERT(renderer->node() && renderer->node()->isMediaControlElement());
57
58     Node* node = renderer->node();
59     MediaControlElementType controlType;
60
61     if (node->hasTagName(inputTag))
62         controlType = static_cast<MediaControlInputElement*>(node)->displayType();
63     else
64         controlType = static_cast<MediaControlElement*>(node)->displayType();
65
66     switch (controlType) {
67     case MediaSlider:
68         return AccessibilityMediaTimeline::create(renderer);
69
70     case MediaCurrentTimeDisplay:
71     case MediaTimeRemainingDisplay:
72         return AccessibilityMediaTimeDisplay::create(renderer);
73
74     case MediaControlsPanel:
75         return AccessibilityMediaControlsContainer::create(renderer);
76
77     default:
78         return adoptRef(new AccessibilityMediaControl(renderer));
79     }
80 }
81
82 MediaControlElementType AccessibilityMediaControl::controlType() const
83 {
84     if (!renderer() || !renderer()->node())
85         return MediaTimelineContainer; // Timeline container is not accessible.
86
87     Node* node = renderer()->node();
88
89     if (node->hasTagName(inputTag))
90         return static_cast<MediaControlInputElement*>(node)->displayType();
91
92     return static_cast<MediaControlElement*>(node)->displayType();
93 }
94
95 String AccessibilityMediaControl::controlTypeName() const
96 {
97     DEFINE_STATIC_LOCAL(const String, mediaFullscreenButtonName, ("FullscreenButton"));
98     DEFINE_STATIC_LOCAL(const String, mediaMuteButtonName, ("MuteButton"));
99     DEFINE_STATIC_LOCAL(const String, mediaPlayButtonName, ("PlayButton"));
100     DEFINE_STATIC_LOCAL(const String, mediaSeekBackButtonName, ("SeekBackButton"));
101     DEFINE_STATIC_LOCAL(const String, mediaSeekForwardButtonName, ("SeekForwardButton"));
102     DEFINE_STATIC_LOCAL(const String, mediaRewindButtonName, ("RewindButton"));
103     DEFINE_STATIC_LOCAL(const String, mediaReturnToRealtimeButtonName, ("ReturnToRealtimeButton"));
104     DEFINE_STATIC_LOCAL(const String, mediaUnMuteButtonName, ("UnMuteButton"));
105     DEFINE_STATIC_LOCAL(const String, mediaPauseButtonName, ("PauseButton"));
106     DEFINE_STATIC_LOCAL(const String, mediaStatusDisplayName, ("StatusDisplay"));
107     DEFINE_STATIC_LOCAL(const String, mediaCurrentTimeDisplay, ("CurrentTimeDisplay"));
108     DEFINE_STATIC_LOCAL(const String, mediaTimeRemainingDisplay, ("TimeRemainingDisplay"));
109     DEFINE_STATIC_LOCAL(const String, mediaShowClosedCaptionsButtonName, ("ShowClosedCaptionsButton"));
110     DEFINE_STATIC_LOCAL(const String, mediaHideClosedCaptionsButtonName, ("HideClosedCaptionsButton"));
111
112     switch (controlType()) {
113     case MediaFullscreenButton:
114         return mediaFullscreenButtonName;
115     case MediaMuteButton:
116         return mediaMuteButtonName;
117     case MediaPlayButton:
118         return mediaPlayButtonName;
119     case MediaSeekBackButton:
120         return mediaSeekBackButtonName;
121     case MediaSeekForwardButton:
122         return mediaSeekForwardButtonName;
123     case MediaRewindButton:
124         return mediaRewindButtonName;
125     case MediaReturnToRealtimeButton:
126         return mediaReturnToRealtimeButtonName;
127     case MediaUnMuteButton:
128         return mediaUnMuteButtonName;
129     case MediaPauseButton:
130         return mediaPauseButtonName;
131     case MediaStatusDisplay:
132         return mediaStatusDisplayName;
133     case MediaCurrentTimeDisplay:
134         return mediaCurrentTimeDisplay;
135     case MediaTimeRemainingDisplay:
136         return mediaTimeRemainingDisplay;
137     case MediaShowClosedCaptionsButton:
138         return mediaShowClosedCaptionsButtonName;
139     case MediaHideClosedCaptionsButton:
140         return mediaHideClosedCaptionsButtonName;
141
142     default:
143         break;
144     }
145
146     return String();
147 }
148
149 String AccessibilityMediaControl::title() const
150 {
151     DEFINE_STATIC_LOCAL(const String, controlsPanel, ("ControlsPanel"));
152
153     if (controlType() == MediaControlsPanel)
154         return localizedMediaControlElementString(controlsPanel);
155
156     return AccessibilityRenderObject::title();
157 }
158
159 String AccessibilityMediaControl::accessibilityDescription() const
160 {
161     return localizedMediaControlElementString(controlTypeName());
162 }
163
164 String AccessibilityMediaControl::helpText() const
165 {
166     return localizedMediaControlElementHelpText(controlTypeName());
167 }
168
169 bool AccessibilityMediaControl::accessibilityIsIgnored() const
170 {
171     if (!m_renderer || !m_renderer->style() || m_renderer->style()->visibility() != VISIBLE || controlType() == MediaTimelineContainer)
172         return true;
173
174     return false;
175 }
176
177 AccessibilityRole AccessibilityMediaControl::roleValue() const
178 {
179     switch (controlType()) {
180     case MediaFullscreenButton:
181     case MediaMuteButton:
182     case MediaPlayButton:
183     case MediaSeekBackButton:
184     case MediaSeekForwardButton:
185     case MediaRewindButton:
186     case MediaReturnToRealtimeButton:
187     case MediaUnMuteButton:
188     case MediaPauseButton:
189     case MediaShowClosedCaptionsButton:
190     case MediaHideClosedCaptionsButton:
191         return ButtonRole;
192
193     case MediaStatusDisplay:
194         return StaticTextRole;
195
196     case MediaTimelineContainer:
197         return GroupRole;
198
199     default:
200         break;
201     }
202
203     return UnknownRole;
204 }
205
206
207
208 //
209 // AccessibilityMediaControlsContainer
210
211 AccessibilityMediaControlsContainer::AccessibilityMediaControlsContainer(RenderObject* renderer)
212     : AccessibilityMediaControl(renderer)
213 {
214 }
215
216 PassRefPtr<AccessibilityObject> AccessibilityMediaControlsContainer::create(RenderObject* renderer)
217 {
218     return adoptRef(new AccessibilityMediaControlsContainer(renderer));
219 }
220
221 String AccessibilityMediaControlsContainer::accessibilityDescription() const
222 {
223     return localizedMediaControlElementString(elementTypeName());
224 }
225
226 String AccessibilityMediaControlsContainer::helpText() const
227 {
228     return localizedMediaControlElementHelpText(elementTypeName());
229 }
230
231 bool AccessibilityMediaControlsContainer::controllingVideoElement() const
232 {
233     if (!m_renderer->node())
234         return true;
235
236     MediaControlTimeDisplayElement* element = static_cast<MediaControlTimeDisplayElement*>(m_renderer->node());
237
238     return element->mediaElement()->isVideo();
239 }
240
241 const String AccessibilityMediaControlsContainer::elementTypeName() const
242 {
243     DEFINE_STATIC_LOCAL(const String, videoElement, ("VideoElement"));
244     DEFINE_STATIC_LOCAL(const String, audioElement, ("AudioElement"));
245
246     if (controllingVideoElement())
247         return videoElement;
248     return audioElement;
249 }
250
251
252 //
253 // AccessibilityMediaTimeline
254
255 AccessibilityMediaTimeline::AccessibilityMediaTimeline(RenderObject* renderer)
256     : AccessibilitySlider(renderer)
257 {
258 }
259
260 PassRefPtr<AccessibilityObject> AccessibilityMediaTimeline::create(RenderObject* renderer)
261 {
262     return adoptRef(new AccessibilityMediaTimeline(renderer));
263 }
264
265 String AccessibilityMediaTimeline::valueDescription() const
266 {
267     ASSERT(m_renderer->node()->hasTagName(inputTag));
268
269     float time = static_cast<HTMLInputElement*>(m_renderer->node())->value().toFloat();
270     return localizedMediaTimeDescription(time);
271 }
272
273 String AccessibilityMediaTimeline::helpText() const
274 {
275     DEFINE_STATIC_LOCAL(const String, slider, ("Slider"));
276     return localizedMediaControlElementHelpText(slider);
277 }
278
279
280 //
281 // AccessibilityMediaTimeDisplay
282
283 AccessibilityMediaTimeDisplay::AccessibilityMediaTimeDisplay(RenderObject* renderer)
284     : AccessibilityMediaControl(renderer)
285 {
286 }
287
288 PassRefPtr<AccessibilityObject> AccessibilityMediaTimeDisplay::create(RenderObject* renderer)
289 {
290     return adoptRef(new AccessibilityMediaTimeDisplay(renderer));
291 }
292
293 bool AccessibilityMediaTimeDisplay::accessibilityIsIgnored() const
294 {
295     if (!m_renderer || !m_renderer->style() || m_renderer->style()->visibility() != VISIBLE)
296         return true;
297
298     return !m_renderer->style()->width().value();
299 }
300
301 String AccessibilityMediaTimeDisplay::accessibilityDescription() const
302 {
303     DEFINE_STATIC_LOCAL(const String, currentTimeDisplay, ("CurrentTimeDisplay"));
304     DEFINE_STATIC_LOCAL(const String, timeRemainingDisplay, ("TimeRemainingDisplay"));
305
306     if (controlType() == MediaCurrentTimeDisplay)
307         return localizedMediaControlElementString(currentTimeDisplay);
308
309     return localizedMediaControlElementString(timeRemainingDisplay);
310 }
311
312 String AccessibilityMediaTimeDisplay::stringValue() const
313 {
314     if (!m_renderer || !m_renderer->node())
315         return String();
316
317     MediaControlTimeDisplayElement* element = static_cast<MediaControlTimeDisplayElement*>(m_renderer->node());
318     float time = element->currentValue();
319     return localizedMediaTimeDescription(fabsf(time));
320 }
321
322 } // namespace WebCore
323
324 #endif // ENABLE(VIDEO)