1ea03d0138077c43a1288e3d082057d949f09bf6
[WebKit-https.git] / Source / WebCore / html / track / TextTrackCue.h
1 /*
2  * Copyright (C) 2011 Google Inc.  All rights reserved.
3  * Copyright (C) 2012, 2013, 2014 Apple 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 are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #ifndef TextTrackCue_h
33 #define TextTrackCue_h
34
35 #if ENABLE(VIDEO_TRACK)
36
37 #include "EventTarget.h"
38 #include "HTMLElement.h"
39 #include <wtf/MediaTime.h>
40 #include <wtf/NeverDestroyed.h>
41 #include <wtf/RefCounted.h>
42
43 namespace WebCore {
44
45 class TextTrack;
46
47 class TextTrackCue : public RefCounted<TextTrackCue>, public EventTargetWithInlineData {
48 public:
49     static const AtomicString& cueShadowPseudoId()
50     {
51         static NeverDestroyed<const AtomicString> cue("cue", AtomicString::ConstructFromLiteral);
52         return cue;
53     }
54
55     virtual ~TextTrackCue();
56
57     TextTrack* track() const;
58     void setTrack(TextTrack*);
59
60     const String& id() const { return m_id; }
61     void setId(const String&);
62
63     MediaTime startMediaTime() const { return m_startTime; }
64     double startTime() const { return startMediaTime().toDouble(); }
65     void setStartTime(const MediaTime&);
66     void setStartTime(double, ExceptionCode&);
67
68     MediaTime endMediaTime() const { return m_endTime; }
69     double endTime() const { return endMediaTime().toDouble(); }
70     void setEndTime(const MediaTime&);
71     void setEndTime(double, ExceptionCode&);
72
73     bool pauseOnExit() const { return m_pauseOnExit; }
74     void setPauseOnExit(bool);
75
76     int cueIndex();
77     void invalidateCueIndex();
78
79     using EventTarget::dispatchEvent;
80     bool dispatchEvent(Event&) override;
81
82     bool isActive();
83     virtual void setIsActive(bool);
84
85     EventTargetInterface eventTargetInterface() const final { return TextTrackCueEventTargetInterfaceType; }
86     ScriptExecutionContext* scriptExecutionContext() const final { return &m_scriptExecutionContext; }
87
88     virtual bool isOrderedBefore(const TextTrackCue*) const;
89     virtual bool isPositionedAbove(const TextTrackCue* cue) const { return isOrderedBefore(cue); }
90
91     bool hasEquivalentStartTime(const TextTrackCue&) const;
92
93     enum CueType {
94         Data,
95         Generic,
96         WebVTT
97     };
98     virtual CueType cueType() const = 0;
99     virtual bool isRenderable() const { return false; }
100
101     enum CueMatchRules {
102         MatchAllFields,
103         IgnoreDuration,
104     };
105     virtual bool isEqual(const TextTrackCue&, CueMatchRules) const;
106     virtual bool cueContentsMatch(const TextTrackCue&) const;
107     virtual bool doesExtendCue(const TextTrackCue&) const;
108
109     void willChange();
110     virtual void didChange();
111
112     using RefCounted<TextTrackCue>::ref;
113     using RefCounted<TextTrackCue>::deref;
114
115 protected:
116     TextTrackCue(ScriptExecutionContext&, const MediaTime& start, const MediaTime& end);
117
118     Document& ownerDocument() { return downcast<Document>(m_scriptExecutionContext); }
119
120 private:
121
122     void refEventTarget() final { ref(); }
123     void derefEventTarget() final { deref(); }
124
125     String m_id;
126     MediaTime m_startTime;
127     MediaTime m_endTime;
128     int m_cueIndex;
129     int m_processingCueChanges;
130
131     TextTrack* m_track;
132
133     ScriptExecutionContext& m_scriptExecutionContext;
134
135     bool m_isActive : 1;
136     bool m_pauseOnExit : 1;
137 };
138
139 } // namespace WebCore
140
141 #endif
142 #endif