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