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