2009-08-25 Eric Carlson <eric.carlson@apple.com>
[WebKit-https.git] / WebCore / rendering / RenderMedia.h
1 /*
2  * Copyright (C) 2007, 2008, 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  * 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 #ifndef RenderMedia_h
27 #define RenderMedia_h
28
29 #if ENABLE(VIDEO)
30
31 #include "RenderReplaced.h"
32 #include "Timer.h"
33
34 namespace WebCore {
35     
36 class HTMLInputElement;
37 class HTMLMediaElement;
38 class MediaControlMuteButtonElement;
39 class MediaControlPlayButtonElement;
40 class MediaControlSeekButtonElement;
41 class MediaControlRewindButtonElement;
42 class MediaControlReturnToRealtimeButtonElement;
43 class MediaControlTimelineElement;
44 class MediaControlVolumeSliderElement;
45 class MediaControlFullscreenButtonElement;
46 class MediaControlTimeDisplayElement;
47 class MediaControlStatusDisplayElement;
48 class MediaControlTimelineContainerElement;
49 class MediaControlVolumeSliderContainerElement;
50 class MediaControlElement;
51 class MediaPlayer;
52
53 class RenderMedia : public RenderReplaced {
54 public:
55     RenderMedia(HTMLMediaElement*);
56     RenderMedia(HTMLMediaElement*, const IntSize& intrinsicSize);
57     virtual ~RenderMedia();
58     
59     const RenderObjectChildList* children() const { return &m_children; }
60     RenderObjectChildList* children() { return &m_children; }
61
62     HTMLMediaElement* mediaElement() const;
63     MediaPlayer* player() const;
64
65     bool shouldShowTimeDisplayControls() const;
66
67     void updateFromElement();
68     void updatePlayer();
69     void updateControls();
70     void updateTimeDisplay();
71     
72     void forwardEvent(Event*);
73
74 protected:
75     virtual void layout();
76
77 private:
78     virtual RenderObjectChildList* virtualChildren() { return children(); }
79     virtual const RenderObjectChildList* virtualChildren() const { return children(); }
80
81     virtual void destroy();
82     
83     virtual const char* renderName() const { return "RenderMedia"; }
84     virtual bool isMedia() const { return true; }
85
86     virtual int lowestPosition(bool includeOverflowInterior = true, bool includeSelf = true) const;
87     virtual int rightmostPosition(bool includeOverflowInterior = true, bool includeSelf = true) const;
88     virtual int leftmostPosition(bool includeOverflowInterior = true, bool includeSelf = true) const;
89
90     void createControlsShadowRoot();
91     void destroyControlsShadowRoot();
92     void createPanel();
93     void createMuteButton();
94     void createPlayButton();
95     void createSeekBackButton();
96     void createSeekForwardButton();
97     void createRewindButton();
98     void createReturnToRealtimeButton();
99     void createStatusDisplay();
100     void createTimelineContainer();
101     void createTimeline();
102     void createVolumeSliderContainer();
103     void createVolumeSlider();
104     void createCurrentTimeDisplay();
105     void createTimeRemainingDisplay();
106     void createFullscreenButton();
107     
108     void timeUpdateTimerFired(Timer<RenderMedia>*);
109     
110     void updateControlVisibility();
111     void changeOpacity(HTMLElement*, float opacity);
112     void opacityAnimationTimerFired(Timer<RenderMedia>*);
113
114     void updateVolumeSliderContainer(bool visible);
115
116     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
117
118     RefPtr<HTMLElement> m_controlsShadowRoot;
119     RefPtr<MediaControlElement> m_panel;
120     RefPtr<MediaControlMuteButtonElement> m_muteButton;
121     RefPtr<MediaControlPlayButtonElement> m_playButton;
122     RefPtr<MediaControlSeekButtonElement> m_seekBackButton;
123     RefPtr<MediaControlSeekButtonElement> m_seekForwardButton;
124     RefPtr<MediaControlRewindButtonElement> m_rewindButton;
125     RefPtr<MediaControlReturnToRealtimeButtonElement> m_returnToRealtimeButton;
126     RefPtr<MediaControlTimelineElement> m_timeline;
127     RefPtr<MediaControlVolumeSliderElement> m_volumeSlider;
128     RefPtr<MediaControlFullscreenButtonElement> m_fullscreenButton;
129     RefPtr<MediaControlTimelineContainerElement> m_timelineContainer;
130     RefPtr<MediaControlVolumeSliderContainerElement> m_volumeSliderContainer;
131     RefPtr<MediaControlTimeDisplayElement> m_currentTimeDisplay;
132     RefPtr<MediaControlTimeDisplayElement> m_timeRemainingDisplay;
133     RefPtr<MediaControlStatusDisplayElement> m_statusDisplay;
134     RenderObjectChildList m_children;
135     Node* m_lastUnderNode;
136     Node* m_nodeUnderMouse;
137     
138     Timer<RenderMedia> m_timeUpdateTimer;
139     Timer<RenderMedia> m_opacityAnimationTimer;
140     bool m_mouseOver;
141     double m_opacityAnimationStartTime;
142     double m_opacityAnimationDuration;
143     float m_opacityAnimationFrom;
144     float m_opacityAnimationTo;
145 };
146
147 inline RenderMedia* toRenderMedia(RenderObject* object)
148 {
149     ASSERT(!object || object->isMedia());
150     return static_cast<RenderMedia*>(object);
151 }
152
153 // This will catch anyone doing an unnecessary cast.
154 void toRenderMedia(const RenderMedia*);
155
156 } // namespace WebCore
157
158 #endif
159 #endif // RenderMedia_h