Use NeverDestroyed instead of DEPRECATED_DEFINE_STATIC_LOCAL
[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 PassRefPtr<TextTrackCue> create(ScriptExecutionContext&, double start, double end, const String& content);
50     static PassRefPtr<TextTrackCue> create(ScriptExecutionContext&, const MediaTime& start, const MediaTime& end, const String& content);
51
52     static const AtomicString& cueShadowPseudoId()
53     {
54         static NeverDestroyed<const AtomicString> cue("cue", AtomicString::ConstructFromLiteral);
55         return cue;
56     }
57
58     virtual ~TextTrackCue();
59
60     TextTrack* track() const;
61     void setTrack(TextTrack*);
62
63     const String& id() const { return m_id; }
64     void setId(const String&);
65
66     MediaTime startMediaTime() const { return m_startTime; }
67     double startTime() const { return startMediaTime().toDouble(); }
68     void setStartTime(const MediaTime&);
69     void setStartTime(double, ExceptionCode&);
70
71     MediaTime endMediaTime() const { return m_endTime; }
72     double endTime() const { return endMediaTime().toDouble(); }
73     void setEndTime(const MediaTime&);
74     void setEndTime(double, ExceptionCode&);
75
76     bool pauseOnExit() const { return m_pauseOnExit; }
77     void setPauseOnExit(bool);
78
79     int cueIndex();
80     void invalidateCueIndex();
81
82     using EventTarget::dispatchEvent;
83     virtual bool dispatchEvent(Event&) override;
84
85     bool isActive();
86     virtual void setIsActive(bool);
87
88     virtual EventTargetInterface eventTargetInterface() const override final { return TextTrackCueEventTargetInterfaceType; }
89     virtual ScriptExecutionContext* scriptExecutionContext() const override final { return &m_scriptExecutionContext; }
90
91     virtual bool isOrderedBefore(const TextTrackCue*) const;
92     virtual bool isPositionedAbove(const TextTrackCue* cue) const { return isOrderedBefore(cue); }
93
94     bool hasEquivalentStartTime(const TextTrackCue&) const;
95
96     enum CueType {
97         Data,
98         Generic,
99         WebVTT
100     };
101     virtual CueType cueType() const = 0;
102     virtual bool isRenderable() const { return false; }
103
104     enum CueMatchRules {
105         MatchAllFields,
106         IgnoreDuration,
107     };
108     virtual bool isEqual(const TextTrackCue&, CueMatchRules) const;
109     virtual bool cueContentsMatch(const TextTrackCue&) const;
110     virtual bool doesExtendCue(const TextTrackCue&) const;
111
112     void willChange();
113     virtual void didChange();
114
115     using RefCounted<TextTrackCue>::ref;
116     using RefCounted<TextTrackCue>::deref;
117
118 protected:
119     TextTrackCue(ScriptExecutionContext&, const MediaTime& start, const MediaTime& end);
120
121     Document& ownerDocument() { return downcast<Document>(m_scriptExecutionContext); }
122
123 private:
124
125     virtual void refEventTarget() override final { ref(); }
126     virtual void derefEventTarget() override final { deref(); }
127
128     String m_id;
129     MediaTime m_startTime;
130     MediaTime m_endTime;
131     int m_cueIndex;
132     int m_processingCueChanges;
133
134     TextTrack* m_track;
135
136     ScriptExecutionContext& m_scriptExecutionContext;
137
138     bool m_isActive : 1;
139     bool m_pauseOnExit : 1;
140 };
141
142 } // namespace WebCore
143
144 #endif
145 #endif