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