Move HTML canvas and tracks from ExceptionCode to Exception
[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 #pragma once
33
34 #if ENABLE(VIDEO_TRACK)
35
36 #include "Document.h"
37 #include <wtf/MediaTime.h>
38
39 namespace WebCore {
40
41 class TextTrack;
42
43 class TextTrackCue : public RefCounted<TextTrackCue>, public EventTargetWithInlineData {
44 public:
45     static const AtomicString& cueShadowPseudoId();
46
47     TextTrack* track() const;
48     void setTrack(TextTrack*);
49
50     const String& id() const { return m_id; }
51     void setId(const String&);
52
53     double startTime() const { return startMediaTime().toDouble(); }
54     void setStartTime(double);
55
56     double endTime() const { return endMediaTime().toDouble(); }
57     void setEndTime(double);
58
59     bool pauseOnExit() const { return m_pauseOnExit; }
60     void setPauseOnExit(bool);
61
62     MediaTime startMediaTime() const { return m_startTime; }
63     void setStartTime(const MediaTime&);
64
65     MediaTime endMediaTime() const { return m_endTime; }
66     void setEndTime(const MediaTime&);
67
68     int cueIndex();
69     void invalidateCueIndex();
70
71     bool isActive();
72     virtual void setIsActive(bool);
73
74     virtual bool isOrderedBefore(const TextTrackCue*) const;
75     virtual bool isPositionedAbove(const TextTrackCue* cue) const { return isOrderedBefore(cue); }
76
77     bool hasEquivalentStartTime(const TextTrackCue&) const;
78
79     enum CueType { Data, Generic, WebVTT };
80     virtual CueType cueType() const = 0;
81     virtual bool isRenderable() const { return false; }
82
83     enum CueMatchRules { MatchAllFields, IgnoreDuration };
84     virtual bool isEqual(const TextTrackCue&, CueMatchRules) const;
85 private:
86     virtual bool cueContentsMatch(const TextTrackCue&) const;
87 public:
88     virtual bool doesExtendCue(const TextTrackCue&) const;
89
90     void willChange();
91     virtual void didChange();
92
93     using RefCounted::ref;
94     using RefCounted::deref;
95
96 protected:
97     TextTrackCue(ScriptExecutionContext&, const MediaTime& start, const MediaTime& end);
98
99     Document& ownerDocument() { return downcast<Document>(m_scriptExecutionContext); }
100
101 private:
102     void refEventTarget() final { ref(); }
103     void derefEventTarget() final { deref(); }
104
105     using EventTarget::dispatchEvent;
106     bool dispatchEvent(Event&) final;
107
108     EventTargetInterface eventTargetInterface() const final { return TextTrackCueEventTargetInterfaceType; }
109     ScriptExecutionContext* scriptExecutionContext() const final { return &m_scriptExecutionContext; }
110
111     String m_id;
112     MediaTime m_startTime;
113     MediaTime m_endTime;
114     int m_cueIndex;
115     int m_processingCueChanges;
116
117     TextTrack* m_track;
118
119     ScriptExecutionContext& m_scriptExecutionContext;
120
121     bool m_isActive : 1;
122     bool m_pauseOnExit : 1;
123 };
124
125 } // namespace WebCore
126
127 #endif