989f37347a87c040048e11ffc32456e31123f381
[WebKit-https.git] / Source / WebCore / html / track / VTTCue.h
1 /*
2  * Copyright (C) 2011, 2013 Google Inc.  All rights reserved.
3  * Copyright (C) 2012-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 VTTCue_h
33 #define VTTCue_h
34
35 #if ENABLE(VIDEO_TRACK)
36
37 #include "EventTarget.h"
38 #include "HTMLElement.h"
39 #include "TextTrackCue.h"
40
41 namespace WebCore {
42
43 class DocumentFragment;
44 class HTMLDivElement;
45 class HTMLSpanElement;
46 class ScriptExecutionContext;
47 class VTTCue;
48 class VTTScanner;
49 class WebVTTCueData;
50
51 // ----------------------------
52
53 class VTTCueBox : public HTMLElement {
54 public:
55     static Ref<VTTCueBox> create(Document&, VTTCue&);
56
57     VTTCue* getCue() const;
58     virtual void applyCSSProperties(const IntSize& videoSize);
59
60     static const AtomicString& vttCueBoxShadowPseudoId();
61     void setFontSizeFromCaptionUserPrefs(int fontSize) { m_fontSizeFromCaptionUserPrefs = fontSize; }
62
63 protected:
64     VTTCueBox(Document&, VTTCue&);
65
66     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) final;
67
68     VTTCue& m_cue;
69     int m_fontSizeFromCaptionUserPrefs;
70 };
71
72 // ----------------------------
73
74 class VTTCue : public TextTrackCue {
75 public:
76     static Ref<VTTCue> create(ScriptExecutionContext& context, double start, double end, const String& content)
77     {
78         return create(context, MediaTime::createWithDouble(start), MediaTime::createWithDouble(end), content);
79     }
80
81     static Ref<VTTCue> create(ScriptExecutionContext& context, const MediaTime& start, const MediaTime& end, const String& content)
82     {
83         return adoptRef(*new VTTCue(context, start, end, content));
84     }
85
86     static Ref<VTTCue> create(ScriptExecutionContext&, const WebVTTCueData&);
87
88     static const AtomicString& cueBackdropShadowPseudoId();
89
90     virtual ~VTTCue();
91
92     const String& vertical() const;
93     void setVertical(const String&, ExceptionCode&);
94
95     bool snapToLines() const { return m_snapToLines; }
96     void setSnapToLines(bool);
97
98     double line() const { return m_linePosition; }
99     virtual void setLine(double, ExceptionCode&);
100
101     double position() const { return m_textPosition; }
102     virtual void setPosition(double, ExceptionCode&);
103
104     int size() const { return m_cueSize; }
105     virtual void setSize(int, ExceptionCode&);
106
107     const String& align() const;
108     void setAlign(const String&, ExceptionCode&);
109
110     const String& text() const { return m_content; }
111     void setText(const String&);
112
113     const String& cueSettings() const { return m_settings; }
114     void setCueSettings(const String&);
115
116     RefPtr<DocumentFragment> getCueAsHTML();
117     RefPtr<DocumentFragment> createCueRenderingTree();
118
119     const String& regionId() const { return m_regionId; }
120     void setRegionId(const String&);
121     void notifyRegionWhenRemovingDisplayTree(bool);
122
123     void setIsActive(bool) override;
124
125     bool hasDisplayTree() const { return m_displayTree; }
126     VTTCueBox* getDisplayTree(const IntSize& videoSize, int fontSize);
127     HTMLSpanElement* element() const { return m_cueHighlightBox.get(); }
128
129     void updateDisplayTree(const MediaTime&);
130     void removeDisplayTree();
131     void markFutureAndPastNodes(ContainerNode*, const MediaTime&, const MediaTime&);
132
133     int calculateComputedLinePosition();
134     std::pair<double, double> getPositionCoordinates() const;
135
136     std::pair<double, double> getCSSPosition() const;
137
138     CSSValueID getCSSAlignment() const;
139     int getCSSSize() const;
140     CSSValueID getCSSWritingDirection() const;
141     CSSValueID getCSSWritingMode() const;
142
143     enum WritingDirection {
144         Horizontal = 0,
145         VerticalGrowingLeft,
146         VerticalGrowingRight,
147         NumberOfWritingDirections
148     };
149     WritingDirection getWritingDirection() const { return m_writingDirection; }
150
151     enum CueAlignment {
152         Start = 0,
153         Middle,
154         End,
155         Left,
156         Right,
157         NumberOfAlignments
158     };
159     CueAlignment getAlignment() const { return m_cueAlignment; }
160
161     virtual void setFontSize(int, const IntSize&, bool important);
162
163     bool isEqual(const TextTrackCue&, CueMatchRules) const override;
164     bool cueContentsMatch(const TextTrackCue&) const override;
165     bool doesExtendCue(const TextTrackCue&) const override;
166
167     CueType cueType() const override { return WebVTT; }
168     bool isRenderable() const final { return true; }
169
170     void didChange() override;
171
172 protected:
173     VTTCue(ScriptExecutionContext&, const MediaTime& start, const MediaTime& end, const String& content);
174     VTTCue(ScriptExecutionContext&, const WebVTTCueData&);
175
176     virtual PassRefPtr<VTTCueBox> createDisplayTree();
177     VTTCueBox* displayTreeInternal();
178
179 private:
180     void initialize(ScriptExecutionContext&);
181     void createWebVTTNodeTree();
182     void copyWebVTTNodeToDOMTree(ContainerNode* WebVTTNode, ContainerNode* root);
183
184     void parseSettings(const String&);
185
186     void determineTextDirection();
187     void calculateDisplayParameters();
188
189     enum CueSetting {
190         None,
191         Vertical,
192         Line,
193         Position,
194         Size,
195         Align,
196         RegionId
197     };
198     CueSetting settingName(VTTScanner&);
199
200     String m_content;
201     String m_settings;
202     double m_linePosition;
203     double m_computedLinePosition;
204     double m_textPosition;
205     int m_cueSize;
206
207     WritingDirection m_writingDirection;
208     CueAlignment m_cueAlignment;
209     String m_regionId;
210
211     RefPtr<DocumentFragment> m_webVTTNodeTree;
212     RefPtr<HTMLSpanElement> m_cueHighlightBox;
213     RefPtr<HTMLDivElement> m_cueBackdropBox;
214     RefPtr<VTTCueBox> m_displayTree;
215
216     CSSValueID m_displayDirection;
217     int m_displaySize;
218     std::pair<float, float> m_displayPosition;
219
220     MediaTime m_originalStartTime;
221
222     bool m_snapToLines : 1;
223     bool m_displayTreeShouldChange : 1;
224     bool m_notifyRegion : 1;
225 };
226
227 VTTCue* toVTTCue(TextTrackCue*);
228 const VTTCue* toVTTCue(const TextTrackCue*);
229
230 } // namespace WebCore
231
232 #endif
233 #endif