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