CC Button doesn't always show up
[WebKit-https.git] / Source / WebCore / html / shadow / MediaControls.h
1 /*
2  * Copyright (C) 2011, 2012 Apple Inc. All rights reserved.
3  * Copyright (C) 2011, 2012 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 #ifndef MediaControls_h
28 #define MediaControls_h
29
30 #if ENABLE(VIDEO)
31
32 #include "Chrome.h"
33 #include "HTMLDivElement.h"
34 #include "HTMLMediaElement.h"
35 #include "HTMLNames.h"
36 #include "MediaControlElements.h"
37 #include "MouseEvent.h"
38 #include "Page.h"
39 #include "RenderTheme.h"
40 #include "Text.h"
41 #include <wtf/RefPtr.h>
42
43 #if ENABLE(VIDEO_TRACK)
44 #include "TextTrackCue.h"
45 #endif
46
47 namespace WebCore {
48
49 class Document;
50 class Event;
51 class Page;
52 class MediaPlayer;
53
54 class RenderBox;
55 class RenderMedia;
56
57 // An abstract class with the media control elements that all ports support.
58 class MediaControls : public HTMLDivElement {
59   public:
60     virtual ~MediaControls() {}
61
62     // This function is to be implemented in your port-specific media
63     // controls implementation since it will return a child instance.
64     static PassRefPtr<MediaControls> create(Document*);
65
66     virtual void setMediaController(MediaControllerInterface*);
67
68     virtual void reset();
69     virtual void reportedError();
70     virtual void loadedMetadata();
71
72     virtual void show();
73     virtual void hide();
74     virtual void makeOpaque();
75     virtual void makeTransparent();
76     virtual bool shouldHideControls();
77
78     virtual void bufferingProgressed();
79     virtual void playbackStarted();
80     virtual void playbackProgressed();
81     virtual void playbackStopped();
82
83     virtual void updateStatusDisplay() { };
84     virtual void updateCurrentTimeDisplay();
85     virtual void showVolumeSlider();
86
87     virtual void changedMute();
88     virtual void changedVolume();
89
90     virtual void changedClosedCaptionsVisibility();
91     virtual void toggleClosedCaptionTrackList() { }
92     virtual void closedCaptionTracksChanged();
93
94     virtual void enteredFullscreen();
95     virtual void exitedFullscreen();
96
97     virtual bool willRespondToMouseMoveEvents() OVERRIDE { return true; }
98
99     virtual void hideFullscreenControlsTimerFired(Timer<MediaControls>*);
100     virtual void startHideFullscreenControlsTimer();
101     virtual void stopHideFullscreenControlsTimer();
102
103 #if ENABLE(VIDEO_TRACK)
104     virtual void createTextTrackDisplay();
105     virtual void showTextTrackDisplay();
106     virtual void hideTextTrackDisplay();
107     virtual void updateTextTrackDisplay();
108 #endif
109
110 protected:
111     explicit MediaControls(Document*);
112
113     virtual void defaultEventHandler(Event*);
114
115     virtual bool containsRelatedTarget(Event*);
116
117     MediaControllerInterface* m_mediaController;
118
119     // Container for the media control elements.
120     MediaControlPanelElement* m_panel;
121
122     // Container for the text track cues.
123 #if ENABLE(VIDEO_TRACK)
124     MediaControlTextTrackContainerElement* m_textDisplayContainer;
125 #endif
126
127     // Media control elements.
128     MediaControlPlayButtonElement* m_playButton;
129     MediaControlCurrentTimeDisplayElement* m_currentTimeDisplay;
130     MediaControlTimelineElement* m_timeline;
131     MediaControlPanelMuteButtonElement* m_panelMuteButton;
132     MediaControlPanelVolumeSliderElement* m_volumeSlider;
133     MediaControlToggleClosedCaptionsButtonElement* m_toggleClosedCaptionsButton;
134     MediaControlFullscreenButtonElement* m_fullScreenButton;
135
136     Timer<MediaControls> m_hideFullscreenControlsTimer;
137     bool m_isFullscreen;
138     bool m_isMouseOverControls;
139
140 private:
141     virtual bool isMediaControls() const { return true; }
142
143     virtual const AtomicString& shadowPseudoId() const;
144 };
145
146 inline MediaControls* toMediaControls(Node* node)
147 {
148     ASSERT(!node || node->isMediaControls());
149     return static_cast<MediaControls*>(node);
150 }
151
152 // This will catch anyone doing an unneccessary cast.
153 void toMediaControls(const MediaControls*);
154
155 }
156
157 #endif
158
159 #endif