Implement overlap-avoidance for in-band text track cues.
[WebKit-https.git] / Source / WebCore / html / track / TextTrackCue.cpp
1 /*
2  * Copyright (C) 2011 Google Inc.  All rights reserved.
3  * Copyright (C) 2011, 2012, 2013 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 #include "config.h"
33
34 #if ENABLE(VIDEO_TRACK)
35
36 #include "TextTrackCue.h"
37
38 #include "CSSPropertyNames.h"
39 #include "CSSValueKeywords.h"
40 #include "DocumentFragment.h"
41 #include "Event.h"
42 #include "HTMLDivElement.h"
43 #include "HTMLSpanElement.h"
44 #include "Logging.h"
45 #include "NodeTraversal.h"
46 #include "RenderTextTrackCue.h"
47 #include "Text.h"
48 #include "TextTrack.h"
49 #include "TextTrackCueList.h"
50 #include "WebVTTElement.h"
51 #include "WebVTTParser.h"
52 #include <wtf/MathExtras.h>
53 #include <wtf/text/StringBuilder.h>
54
55 namespace WebCore {
56
57 static const int invalidCueIndex = -1;
58 static const int undefinedPosition = -1;
59 static const int autoSize = 0;
60
61 static const String& startKeyword()
62 {
63     DEFINE_STATIC_LOCAL(const String, start, (ASCIILiteral("start")));
64     return start;
65 }
66
67 static const String& middleKeyword()
68 {
69     DEFINE_STATIC_LOCAL(const String, middle, (ASCIILiteral("middle")));
70     return middle;
71 }
72
73 static const String& endKeyword()
74 {
75     DEFINE_STATIC_LOCAL(const String, end, (ASCIILiteral("end")));
76     return end;
77 }
78
79 static const String& horizontalKeyword()
80 {
81     return emptyString();
82 }
83
84 static const String& verticalGrowingLeftKeyword()
85 {
86     DEFINE_STATIC_LOCAL(const String, verticalrl, (ASCIILiteral("rl")));
87     return verticalrl;
88 }
89
90 static const String& verticalGrowingRightKeyword()
91 {
92     DEFINE_STATIC_LOCAL(const String, verticallr, (ASCIILiteral("lr")));
93     return verticallr;
94 }
95
96 // ----------------------------
97
98 TextTrackCueBox::TextTrackCueBox(Document* document, TextTrackCue* cue)
99     : HTMLElement(divTag, document)
100     , m_cue(cue)
101 {
102     setPseudo(textTrackCueBoxShadowPseudoId());
103 }
104
105 TextTrackCue* TextTrackCueBox::getCue() const
106 {
107     return m_cue;
108 }
109
110 void TextTrackCueBox::applyCSSProperties(const IntSize&)
111 {
112     // FIXME: Apply all the initial CSS positioning properties. http://wkb.ug/79916
113
114     // 3.5.1 On the (root) List of WebVTT Node Objects:
115
116     // the 'position' property must be set to 'absolute'
117     setInlineStyleProperty(CSSPropertyPosition, CSSValueAbsolute);
118
119     //  the 'unicode-bidi' property must be set to 'plaintext'
120     setInlineStyleProperty(CSSPropertyUnicodeBidi, CSSValueWebkitPlaintext);
121
122     // the 'direction' property must be set to direction
123     setInlineStyleProperty(CSSPropertyDirection, m_cue->getCSSWritingDirection());
124
125     // the 'writing-mode' property must be set to writing-mode
126     setInlineStyleProperty(CSSPropertyWebkitWritingMode, m_cue->getCSSWritingMode(), false);
127
128     std::pair<float, float> position = m_cue->getCSSPosition();
129
130     // the 'top' property must be set to top,
131     setInlineStyleProperty(CSSPropertyTop, static_cast<double>(position.second), CSSPrimitiveValue::CSS_PERCENTAGE);
132
133     // the 'left' property must be set to left
134     setInlineStyleProperty(CSSPropertyLeft, static_cast<double>(position.first), CSSPrimitiveValue::CSS_PERCENTAGE);
135
136     // the 'width' property must be set to width, and the 'height' property  must be set to height
137     if (m_cue->vertical() == horizontalKeyword()) {
138         setInlineStyleProperty(CSSPropertyWidth, static_cast<double>(m_cue->getCSSSize()), CSSPrimitiveValue::CSS_PERCENTAGE);
139         setInlineStyleProperty(CSSPropertyHeight, CSSValueAuto);
140     } else {
141         setInlineStyleProperty(CSSPropertyWidth, CSSValueAuto);
142         setInlineStyleProperty(CSSPropertyHeight, static_cast<double>(m_cue->getCSSSize()),  CSSPrimitiveValue::CSS_PERCENTAGE);
143     }
144
145     // The 'text-align' property on the (root) List of WebVTT Node Objects must
146     // be set to the value in the second cell of the row of the table below
147     // whose first cell is the value of the corresponding cue's text track cue
148     // alignment:
149     if (m_cue->align() == startKeyword())
150         setInlineStyleProperty(CSSPropertyTextAlign, CSSValueStart);
151     else if (m_cue->align() == endKeyword())
152         setInlineStyleProperty(CSSPropertyTextAlign, CSSValueEnd);
153     else
154         setInlineStyleProperty(CSSPropertyTextAlign, CSSValueCenter);
155
156     if (!m_cue->snapToLines()) {
157         // 10.13.1 Set up x and y:
158         // Note: x and y are set through the CSS left and top above.
159
160         // 10.13.2 Position the boxes in boxes such that the point x% along the
161         // width of the bounding box of the boxes in boxes is x% of the way
162         // across the width of the video's rendering area, and the point y%
163         // along the height of the bounding box of the boxes in boxes is y%
164         // of the way across the height of the video's rendering area, while
165         // maintaining the relative positions of the boxes in boxes to each
166         // other.
167         setInlineStyleProperty(CSSPropertyWebkitTransform,
168                 String::format("translate(-%.2f%%, -%.2f%%)", position.first, position.second));
169
170         setInlineStyleProperty(CSSPropertyWhiteSpace, CSSValuePre);
171     }
172 }
173
174 const AtomicString& TextTrackCueBox::textTrackCueBoxShadowPseudoId()
175 {
176     DEFINE_STATIC_LOCAL(const AtomicString, trackDisplayBoxShadowPseudoId, ("-webkit-media-text-track-display", AtomicString::ConstructFromLiteral));
177     return trackDisplayBoxShadowPseudoId;
178 }
179
180 RenderObject* TextTrackCueBox::createRenderer(RenderArena* arena, RenderStyle*)
181 {
182     return new (arena) RenderTextTrackCue(this);
183 }
184
185 // ----------------------------
186
187 TextTrackCue::TextTrackCue(ScriptExecutionContext* context, double start, double end, const String& content)
188     : m_startTime(start)
189     , m_endTime(end)
190     , m_content(content)
191     , m_linePosition(undefinedPosition)
192     , m_computedLinePosition(undefinedPosition)
193     , m_textPosition(50)
194     , m_cueSize(100)
195     , m_cueIndex(invalidCueIndex)
196     , m_processingCueChanges(0)
197     , m_writingDirection(Horizontal)
198     , m_cueAlignment(Middle)
199     , m_webVTTNodeTree(0)
200     , m_track(0)
201     , m_scriptExecutionContext(context)
202     , m_isActive(false)
203     , m_pauseOnExit(false)
204     , m_snapToLines(true)
205     , m_cueBackgroundBox(HTMLSpanElement::create(spanTag, toDocument(context)))
206     , m_displayTreeShouldChange(true)
207     , m_displayDirection(CSSValueLtr)
208 {
209     ASSERT(m_scriptExecutionContext->isDocument());
210
211     // 4. If the text track cue writing direction is horizontal, then let
212     // writing-mode be 'horizontal-tb'. Otherwise, if the text track cue writing
213     // direction is vertical growing left, then let writing-mode be
214     // 'vertical-rl'. Otherwise, the text track cue writing direction is
215     // vertical growing right; let writing-mode be 'vertical-lr'.
216     m_displayWritingModeMap[Horizontal] = CSSValueHorizontalTb;
217     m_displayWritingModeMap[VerticalGrowingLeft] = CSSValueVerticalRl;
218     m_displayWritingModeMap[VerticalGrowingRight] = CSSValueVerticalLr;
219 }
220
221 TextTrackCue::~TextTrackCue()
222 {
223     removeDisplayTree();
224 }
225
226 PassRefPtr<TextTrackCueBox> TextTrackCue::createDisplayTree()
227 {
228     return TextTrackCueBox::create(ownerDocument(), this);
229 }
230
231 TextTrackCueBox* TextTrackCue::displayTreeInternal()
232 {
233     if (!m_displayTree)
234         m_displayTree = createDisplayTree();
235     return m_displayTree.get();
236 }
237
238 void TextTrackCue::willChange()
239 {
240     if (++m_processingCueChanges > 1)
241         return;
242
243     if (m_track)
244         m_track->cueWillChange(this);
245 }
246
247 void TextTrackCue::didChange()
248 {
249     ASSERT(m_processingCueChanges);
250     if (--m_processingCueChanges)
251         return;
252
253     if (m_track)
254         m_track->cueDidChange(this);
255
256     m_displayTreeShouldChange = true;
257 }
258
259 TextTrack* TextTrackCue::track() const
260 {
261     return m_track;
262 }
263
264 void TextTrackCue::setTrack(TextTrack* track)
265 {
266     m_track = track;
267 }
268
269 void TextTrackCue::setId(const String& id)
270 {
271     if (m_id == id)
272         return;
273
274     willChange();
275     m_id = id;
276     didChange();
277 }
278
279 void TextTrackCue::setStartTime(double value, ExceptionCode& ec)
280 {
281     // NaN, Infinity and -Infinity values should trigger a TypeError.
282     if (std::isinf(value) || std::isnan(value)) {
283         ec = TypeError;
284         return;
285     }
286     
287     // TODO(93143): Add spec-compliant behavior for negative time values.
288     if (m_startTime == value || value < 0)
289         return;
290
291     willChange();
292     m_startTime = value;
293     didChange();
294 }
295     
296 void TextTrackCue::setEndTime(double value, ExceptionCode& ec)
297 {
298     // NaN, Infinity and -Infinity values should trigger a TypeError.
299     if (std::isinf(value) || std::isnan(value)) {
300         ec = TypeError;
301         return;
302     }
303
304     // TODO(93143): Add spec-compliant behavior for negative time values.
305     if (m_endTime == value || value < 0)
306         return;
307
308     willChange();
309     m_endTime = value;
310     didChange();
311 }
312     
313 void TextTrackCue::setPauseOnExit(bool value)
314 {
315     if (m_pauseOnExit == value)
316         return;
317     
318     m_pauseOnExit = value;
319 }
320
321 const String& TextTrackCue::vertical() const
322 {
323     switch (m_writingDirection) {
324     case Horizontal: 
325         return horizontalKeyword();
326     case VerticalGrowingLeft:
327         return verticalGrowingLeftKeyword();
328     case VerticalGrowingRight:
329         return verticalGrowingRightKeyword();
330     default:
331         ASSERT_NOT_REACHED();
332         return emptyString();
333     }
334 }
335
336 void TextTrackCue::setVertical(const String& value, ExceptionCode& ec)
337 {
338     // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#dom-texttrackcue-vertical
339     // On setting, the text track cue writing direction must be set to the value given 
340     // in the first cell of the row in the table above whose second cell is a 
341     // case-sensitive match for the new value, if any. If none of the values match, then
342     // the user agent must instead throw a SyntaxError exception.
343     
344     WritingDirection direction = m_writingDirection;
345     if (value == horizontalKeyword())
346         direction = Horizontal;
347     else if (value == verticalGrowingLeftKeyword())
348         direction = VerticalGrowingLeft;
349     else if (value == verticalGrowingRightKeyword())
350         direction = VerticalGrowingRight;
351     else
352         ec = SYNTAX_ERR;
353     
354     if (direction == m_writingDirection)
355         return;
356
357     willChange();
358     m_writingDirection = direction;
359     didChange();
360 }
361
362 void TextTrackCue::setSnapToLines(bool value)
363 {
364     if (m_snapToLines == value)
365         return;
366     
367     willChange();
368     m_snapToLines = value;
369     didChange();
370 }
371
372 void TextTrackCue::setLine(int position, ExceptionCode& ec)
373 {
374     // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#dom-texttrackcue-line
375     // On setting, if the text track cue snap-to-lines flag is not set, and the new
376     // value is negative or greater than 100, then throw an IndexSizeError exception.
377     if (!m_snapToLines && (position < 0 || position > 100)) {
378         ec = INDEX_SIZE_ERR;
379         return;
380     }
381
382     // Otherwise, set the text track cue line position to the new value.
383     if (m_linePosition == position)
384         return;
385
386     willChange();
387     m_linePosition = position;
388     m_computedLinePosition = calculateComputedLinePosition();
389     didChange();
390 }
391
392 void TextTrackCue::setPosition(int position, ExceptionCode& ec)
393 {
394     // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#dom-texttrackcue-position
395     // On setting, if the new value is negative or greater than 100, then throw an IndexSizeError exception.
396     // Otherwise, set the text track cue text position to the new value.
397     if (position < 0 || position > 100) {
398         ec = INDEX_SIZE_ERR;
399         return;
400     }
401     
402     // Otherwise, set the text track cue line position to the new value.
403     if (m_textPosition == position)
404         return;
405     
406     willChange();
407     m_textPosition = position;
408     didChange();
409 }
410
411 void TextTrackCue::setSize(int size, ExceptionCode& ec)
412 {
413     // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#dom-texttrackcue-size
414     // On setting, if the new value is negative or greater than 100, then throw an IndexSizeError
415     // exception. Otherwise, set the text track cue size to the new value.
416     if (size < 0 || size > 100) {
417         ec = INDEX_SIZE_ERR;
418         return;
419     }
420     
421     // Otherwise, set the text track cue line position to the new value.
422     if (m_cueSize == size)
423         return;
424     
425     willChange();
426     m_cueSize = size;
427     didChange();
428 }
429
430 const String& TextTrackCue::align() const
431 {
432     switch (m_cueAlignment) {
433     case Start:
434         return startKeyword();
435     case Middle:
436         return middleKeyword();
437     case End:
438         return endKeyword();
439     default:
440         ASSERT_NOT_REACHED();
441         return emptyString();
442     }
443 }
444
445 void TextTrackCue::setAlign(const String& value, ExceptionCode& ec)
446 {
447     // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#dom-texttrackcue-align
448     // On setting, the text track cue alignment must be set to the value given in the 
449     // first cell of the row in the table above whose second cell is a case-sensitive
450     // match for the new value, if any. If none of the values match, then the user
451     // agent must instead throw a SyntaxError exception.
452     
453     CueAlignment alignment = m_cueAlignment;
454     if (value == startKeyword())
455         alignment = Start;
456     else if (value == middleKeyword())
457         alignment = Middle;
458     else if (value == endKeyword())
459         alignment = End;
460     else
461         ec = SYNTAX_ERR;
462     
463     if (alignment == m_cueAlignment)
464         return;
465
466     willChange();
467     m_cueAlignment = alignment;
468     didChange();
469 }
470     
471 void TextTrackCue::setText(const String& text)
472 {
473     if (m_content == text)
474         return;
475     
476     willChange();
477     // Clear the document fragment but don't bother to create it again just yet as we can do that
478     // when it is requested.
479     m_webVTTNodeTree = 0;
480     m_content = text;
481     didChange();
482 }
483
484 int TextTrackCue::cueIndex()
485 {
486     if (m_cueIndex == invalidCueIndex)
487         m_cueIndex = track()->cues()->getCueIndex(this);
488
489     return m_cueIndex;
490 }
491
492 void TextTrackCue::invalidateCueIndex()
493 {
494     m_cueIndex = invalidCueIndex;
495 }
496
497 void TextTrackCue::createWebVTTNodeTree()
498 {
499     if (!m_webVTTNodeTree)
500         m_webVTTNodeTree = WebVTTParser::create(0, m_scriptExecutionContext)->createDocumentFragmentFromCueText(m_content);
501 }
502
503 void TextTrackCue::copyWebVTTNodeToDOMTree(ContainerNode* webVTTNode, ContainerNode* parent)
504 {
505     for (Node* node = webVTTNode->firstChild(); node; node = node->nextSibling()) {
506         RefPtr<Node> clonedNode;
507         if (node->isWebVTTElement())
508             clonedNode = toWebVTTElement(node)->createEquivalentHTMLElement(ownerDocument());
509         else
510             clonedNode = node->cloneNode(false);
511         parent->appendChild(clonedNode, ASSERT_NO_EXCEPTION);
512         if (node->isContainerNode())
513             copyWebVTTNodeToDOMTree(toContainerNode(node), toContainerNode(clonedNode.get()));
514     }
515 }
516
517 PassRefPtr<DocumentFragment> TextTrackCue::getCueAsHTML()
518 {
519     createWebVTTNodeTree();
520     if (!m_webVTTNodeTree)
521         return 0;
522
523     RefPtr<DocumentFragment> clonedFragment = DocumentFragment::create(ownerDocument());
524     copyWebVTTNodeToDOMTree(m_webVTTNodeTree.get(), clonedFragment.get());
525     return clonedFragment.release();
526 }
527
528 PassRefPtr<DocumentFragment> TextTrackCue::createCueRenderingTree()
529 {
530     RefPtr<DocumentFragment> clonedFragment;
531     createWebVTTNodeTree();
532     if (!m_webVTTNodeTree)
533         return 0;
534
535     clonedFragment = DocumentFragment::create(ownerDocument());
536     m_webVTTNodeTree->cloneChildNodes(clonedFragment.get());
537     return clonedFragment.release();
538 }
539
540 bool TextTrackCue::dispatchEvent(PassRefPtr<Event> event)
541 {
542     // When a TextTrack's mode is disabled: no cues are active, no events fired.
543     if (!track() || track()->mode() == TextTrack::disabledKeyword())
544         return false;
545
546     return EventTarget::dispatchEvent(event);
547 }
548
549 #if ENABLE(WEBVTT_REGIONS)
550 void TextTrackCue::setRegionId(const String& regionId)
551 {
552     if (m_regionId == regionId)
553         return;
554
555     willChange();
556     m_regionId = regionId;
557     didChange();
558 }
559 #endif
560
561 bool TextTrackCue::isActive()
562 {
563     return m_isActive && track() && track()->mode() != TextTrack::disabledKeyword();
564 }
565
566 void TextTrackCue::setIsActive(bool active)
567 {
568     m_isActive = active;
569
570     if (!active) {
571         // Remove the display tree as soon as the cue becomes inactive.
572         displayTreeInternal()->remove(ASSERT_NO_EXCEPTION);
573     }
574 }
575
576 int TextTrackCue::calculateComputedLinePosition()
577 {
578     // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#text-track-cue-computed-line-position
579
580     // If the text track cue line position is numeric, then that is the text
581     // track cue computed line position.
582     if (m_linePosition != undefinedPosition)
583         return m_linePosition;
584
585     // If the text track cue snap-to-lines flag of the text track cue is not
586     // set, the text track cue computed line position is the value 100;
587     if (!m_snapToLines)
588         return 100;
589
590     // Otherwise, it is the value returned by the following algorithm:
591
592     // If cue is not associated with a text track, return -1 and abort these
593     // steps.
594     if (!track())
595         return -1;
596
597     // Let n be the number of text tracks whose text track mode is showing or
598     // showing by default and that are in the media element's list of text
599     // tracks before track.
600     int n = track()->trackIndexRelativeToRenderedTracks();
601
602     // Increment n by one.
603     n++;
604
605     // Negate n.
606     n = -n;
607
608     return n;
609 }
610
611 static bool isCueParagraphSeparator(UChar character)
612 {
613     // Within a cue, paragraph boundaries are only denoted by Type B characters,
614     // such as U+000A LINE FEED (LF), U+0085 NEXT LINE (NEL), and U+2029 PARAGRAPH SEPARATOR.
615     return WTF::Unicode::category(character) & WTF::Unicode::Separator_Paragraph;
616 }
617
618 void TextTrackCue::determineTextDirection()
619 {
620     DEFINE_STATIC_LOCAL(const String, rtTag, (ASCIILiteral("rt")));
621     createWebVTTNodeTree();
622     if (!m_webVTTNodeTree)
623         return;
624
625     // Apply the Unicode Bidirectional Algorithm's Paragraph Level steps to the
626     // concatenation of the values of each WebVTT Text Object in nodes, in a
627     // pre-order, depth-first traversal, excluding WebVTT Ruby Text Objects and
628     // their descendants.
629     StringBuilder paragraphBuilder;
630     for (Node* node = m_webVTTNodeTree->firstChild(); node; node = NodeTraversal::next(node, m_webVTTNodeTree.get())) {
631         if (!node->isTextNode() || node->localName() == rtTag)
632             continue;
633
634         paragraphBuilder.append(node->nodeValue());
635     }
636
637     String paragraph = paragraphBuilder.toString();
638     if (!paragraph.length())
639         return;
640
641     for (size_t i = 0; i < paragraph.length(); ++i) {
642         UChar current = paragraph[i];
643         if (!current || isCueParagraphSeparator(current))
644             return;
645
646         if (UChar current = paragraph[i]) {
647             WTF::Unicode::Direction charDirection = WTF::Unicode::direction(current);
648             if (charDirection == WTF::Unicode::LeftToRight) {
649                 m_displayDirection = CSSValueLtr;
650                 return;
651             }
652             if (charDirection == WTF::Unicode::RightToLeft
653                 || charDirection == WTF::Unicode::RightToLeftArabic) {
654                 m_displayDirection = CSSValueRtl;
655                 return;
656             }
657         }
658     }
659 }
660
661 void TextTrackCue::calculateDisplayParameters()
662 {
663     // Steps 10.2, 10.3
664     determineTextDirection();
665
666     // 10.4 If the text track cue writing direction is horizontal, then let
667     // block-flow be 'tb'. Otherwise, if the text track cue writing direction is
668     // vertical growing left, then let block-flow be 'lr'. Otherwise, the text
669     // track cue writing direction is vertical growing right; let block-flow be
670     // 'rl'.
671     m_displayWritingMode = m_displayWritingModeMap[m_writingDirection];
672
673     // 10.5 Determine the value of maximum size for cue as per the appropriate
674     // rules from the following list:
675     int maximumSize = m_textPosition;
676     if ((m_writingDirection == Horizontal && m_cueAlignment == Start && m_displayDirection == CSSValueLtr)
677             || (m_writingDirection == Horizontal && m_cueAlignment == End && m_displayDirection == CSSValueRtl)
678             || (m_writingDirection == VerticalGrowingLeft && m_cueAlignment == Start)
679             || (m_writingDirection == VerticalGrowingRight && m_cueAlignment == Start)) {
680         maximumSize = 100 - m_textPosition;
681     } else if ((m_writingDirection == Horizontal && m_cueAlignment == End && m_displayDirection == CSSValueLtr)
682             || (m_writingDirection == Horizontal && m_cueAlignment == Start && m_displayDirection == CSSValueRtl)
683             || (m_writingDirection == VerticalGrowingLeft && m_cueAlignment == End)
684             || (m_writingDirection == VerticalGrowingRight && m_cueAlignment == End)) {
685         maximumSize = m_textPosition;
686     } else if (m_cueAlignment == Middle) {
687         maximumSize = m_textPosition <= 50 ? m_textPosition : (100 - m_textPosition);
688         maximumSize = maximumSize * 2;
689     }
690
691     // 10.6 If the text track cue size is less than maximum size, then let size
692     // be text track cue size. Otherwise, let size be maximum size.
693     m_displaySize = std::min(m_cueSize, maximumSize);
694
695     // 10.8 Determine the value of x-position or y-position for cue as per the
696     // appropriate rules from the following list:
697     if (m_writingDirection == Horizontal) {
698         if (m_cueAlignment == Start) {
699             if (m_displayDirection == CSSValueLtr)
700                 m_displayPosition.first = m_textPosition;
701             else
702                 m_displayPosition.first = 100 - m_textPosition - m_displaySize;
703         } else if (m_cueAlignment == End) {
704             if (m_displayDirection == CSSValueRtl)
705                 m_displayPosition.first = 100 - m_textPosition;
706             else
707                 m_displayPosition.first = m_textPosition - m_displaySize;
708         }
709     }
710
711     if ((m_writingDirection == VerticalGrowingLeft && m_cueAlignment == Start)
712             || (m_writingDirection == VerticalGrowingRight && m_cueAlignment == Start)) {
713         m_displayPosition.second = m_textPosition;
714     } else if ((m_writingDirection == VerticalGrowingLeft && m_cueAlignment == End)
715             || (m_writingDirection == VerticalGrowingRight && m_cueAlignment == End)) {
716         m_displayPosition.second = 100 - m_textPosition;
717     }
718
719     if (m_writingDirection == Horizontal && m_cueAlignment == Middle) {
720         if (m_displayDirection == CSSValueLtr)
721             m_displayPosition.first = m_textPosition - m_displaySize / 2;
722         else
723            m_displayPosition.first = 100 - m_textPosition - m_displaySize / 2;
724     }
725
726     if ((m_writingDirection == VerticalGrowingLeft && m_cueAlignment == Middle)
727         || (m_writingDirection == VerticalGrowingRight && m_cueAlignment == Middle))
728         m_displayPosition.second = m_textPosition - m_displaySize / 2;
729
730     // 10.9 Determine the value of whichever of x-position or y-position is not
731     // yet calculated for cue as per the appropriate rules from the following
732     // list:
733     if (m_snapToLines && m_displayPosition.second == undefinedPosition && m_writingDirection == Horizontal)
734         m_displayPosition.second = 0;
735
736     if (!m_snapToLines && m_displayPosition.second == undefinedPosition && m_writingDirection == Horizontal)
737         m_displayPosition.second = m_computedLinePosition;
738
739     if (m_snapToLines && m_displayPosition.first == undefinedPosition
740             && (m_writingDirection == VerticalGrowingLeft || m_writingDirection == VerticalGrowingRight))
741         m_displayPosition.first = 0;
742
743     if (!m_snapToLines && (m_writingDirection == VerticalGrowingLeft || m_writingDirection == VerticalGrowingRight))
744         m_displayPosition.first = m_computedLinePosition;
745
746     // A text track cue has a text track cue computed line position whose value
747     // is defined in terms of the other aspects of the cue.
748     m_computedLinePosition = calculateComputedLinePosition();
749 }
750     
751 void TextTrackCue::markFutureAndPastNodes(ContainerNode* root, double previousTimestamp, double movieTime)
752 {
753     DEFINE_STATIC_LOCAL(const String, timestampTag, (ASCIILiteral("timestamp")));
754     
755     bool isPastNode = true;
756     double currentTimestamp = previousTimestamp;
757     if (currentTimestamp > movieTime)
758         isPastNode = false;
759     
760     for (Node* child = root->firstChild(); child; child = NodeTraversal::next(child, root)) {
761         if (child->nodeName() == timestampTag) {
762             unsigned position = 0;
763             String timestamp = child->nodeValue();
764             double currentTimestamp = WebVTTParser::create(0, m_scriptExecutionContext)->collectTimeStamp(timestamp, &position);
765             ASSERT(currentTimestamp != -1);
766             
767             if (currentTimestamp > movieTime)
768                 isPastNode = false;
769         }
770         
771         if (child->isWebVTTElement()) {
772             toWebVTTElement(child)->setIsPastNode(isPastNode);
773             // Make an elemenet id match a cue id for style matching purposes.
774             if (!m_id.isEmpty())
775                 toElement(child)->setIdAttribute(AtomicString(m_id.characters(), m_id.length()));
776         }
777     }
778 }
779
780 void TextTrackCue::updateDisplayTree(double movieTime)
781 {
782     // The display tree may contain WebVTT timestamp objects representing
783     // timestamps (processing instructions), along with displayable nodes.
784
785     if (!track()->isRendered())
786       return;
787
788     // Clear the contents of the set.
789     m_cueBackgroundBox->removeChildren();
790
791     // Update the two sets containing past and future WebVTT objects.
792     RefPtr<DocumentFragment> referenceTree = createCueRenderingTree();
793     if (!referenceTree)
794         return;
795
796     markFutureAndPastNodes(referenceTree.get(), startTime(), movieTime);
797     m_cueBackgroundBox->appendChild(referenceTree);
798 }
799
800 TextTrackCueBox* TextTrackCue::getDisplayTree(const IntSize& videoSize)
801 {
802     RefPtr<TextTrackCueBox> displayTree = displayTreeInternal();
803     if (!m_displayTreeShouldChange || !track()->isRendered())
804         return displayTree.get();
805
806     // 10.1 - 10.10
807     calculateDisplayParameters();
808
809     // 10.11. Apply the terms of the CSS specifications to nodes within the
810     // following constraints, thus obtaining a set of CSS boxes positioned
811     // relative to an initial containing block:
812     displayTree->removeChildren();
813
814     // The document tree is the tree of WebVTT Node Objects rooted at nodes.
815
816     // The children of the nodes must be wrapped in an anonymous box whose
817     // 'display' property has the value 'inline'. This is the WebVTT cue
818     // background box.
819
820     // Note: This is contained by default in m_cueBackgroundBox.
821     m_cueBackgroundBox->setPseudo(cueShadowPseudoId());
822     displayTree->appendChild(m_cueBackgroundBox, ASSERT_NO_EXCEPTION, AttachLazily);
823
824     // FIXME(BUG 79916): Runs of children of WebVTT Ruby Objects that are not
825     // WebVTT Ruby Text Objects must be wrapped in anonymous boxes whose
826     // 'display' property has the value 'ruby-base'.
827
828     // FIXME(BUG 79916): Text runs must be wrapped according to the CSS
829     // line-wrapping rules, except that additionally, regardless of the value of
830     // the 'white-space' property, lines must be wrapped at the edge of their
831     // containing blocks, even if doing so requires splitting a word where there
832     // is no line breaking opportunity. (Thus, normally text wraps as needed,
833     // but if there is a particularly long word, it does not overflow as it
834     // normally would in CSS, it is instead forcibly wrapped at the box's edge.)
835     displayTree->applyCSSProperties(videoSize);
836
837     m_displayTreeShouldChange = false;
838
839     // 10.15. Let cue's text track cue display state have the CSS boxes in
840     // boxes.
841     return displayTree.get();
842 }
843
844 void TextTrackCue::removeDisplayTree()
845 {
846     displayTreeInternal()->remove(ASSERT_NO_EXCEPTION);
847 }
848
849 std::pair<double, double> TextTrackCue::getPositionCoordinates() const
850 {
851     // This method is used for setting x and y when snap to lines is not set.
852     std::pair<double, double> coordinates;
853
854     if (m_writingDirection == Horizontal && m_displayDirection == CSSValueLtr) {
855         coordinates.first = m_textPosition;
856         coordinates.second = m_computedLinePosition;
857
858         return coordinates;
859     }
860
861     if (m_writingDirection == Horizontal && m_displayDirection == CSSValueRtl) {
862         coordinates.first = 100 - m_textPosition;
863         coordinates.second = m_computedLinePosition;
864
865         return coordinates;
866     }
867
868     if (m_writingDirection == VerticalGrowingLeft) {
869         coordinates.first = 100 - m_computedLinePosition;
870         coordinates.second = m_textPosition;
871
872         return coordinates;
873     }
874
875     if (m_writingDirection == VerticalGrowingRight) {
876         coordinates.first = m_computedLinePosition;
877         coordinates.second = m_textPosition;
878
879         return coordinates;
880     }
881
882     ASSERT_NOT_REACHED();
883
884     return coordinates;
885 }
886
887 TextTrackCue::CueSetting TextTrackCue::settingName(const String& name)
888 {
889     DEFINE_STATIC_LOCAL(const String, verticalKeyword, (ASCIILiteral("vertical")));
890     DEFINE_STATIC_LOCAL(const String, lineKeyword, (ASCIILiteral("line")));
891     DEFINE_STATIC_LOCAL(const String, positionKeyword, (ASCIILiteral("position")));
892     DEFINE_STATIC_LOCAL(const String, sizeKeyword, (ASCIILiteral("size")));
893     DEFINE_STATIC_LOCAL(const String, alignKeyword, (ASCIILiteral("align")));
894 #if ENABLE(WEBVTT_REGIONS)
895     DEFINE_STATIC_LOCAL(const String, regionIdKeyword, (ASCIILiteral("region")));
896 #endif
897
898     if (name == verticalKeyword)
899         return Vertical;
900     else if (name == lineKeyword)
901         return Line;
902     else if (name == positionKeyword)
903         return Position;
904     else if (name == sizeKeyword)
905         return Size;
906     else if (name == alignKeyword)
907         return Align;
908 #if ENABLE(WEBVTT_REGIONS)
909     else if (name == regionIdKeyword)
910         return RegionId;
911 #endif
912
913     return None;
914 }
915
916 void TextTrackCue::setCueSettings(const String& input)
917 {
918     m_settings = input;
919     unsigned position = 0;
920
921     while (position < input.length()) {
922
923         // The WebVTT cue settings part of a WebVTT cue consists of zero or more of the following components, in any order, 
924         // separated from each other by one or more U+0020 SPACE characters or U+0009 CHARACTER TABULATION (tab) characters. 
925         while (position < input.length() && WebVTTParser::isValidSettingDelimiter(input[position]))
926             position++;
927         if (position >= input.length())
928             break;
929
930         // When the user agent is to parse the WebVTT settings given by a string input for a text track cue cue, 
931         // the user agent must run the following steps:
932         // 1. Let settings be the result of splitting input on spaces.
933         // 2. For each token setting in the list settings, run the following substeps:
934         //    1. If setting does not contain a U+003A COLON character (:), or if the first U+003A COLON character (:) 
935         //       in setting is either the first or last character of setting, then jump to the step labeled next setting.
936         unsigned endOfSetting = position;
937         String setting = WebVTTParser::collectWord(input, &endOfSetting);
938         CueSetting name;
939         size_t colonOffset = setting.find(':', 1);
940         if (colonOffset == notFound || colonOffset == 0 || colonOffset == setting.length() - 1)
941             goto NextSetting;
942
943         // 2. Let name be the leading substring of setting up to and excluding the first U+003A COLON character (:) in that string.
944         name = settingName(setting.substring(0, colonOffset));
945
946         // 3. Let value be the trailing substring of setting starting from the character immediately after the first U+003A COLON character (:) in that string.
947         position += colonOffset + 1;
948         if (position >= input.length())
949             break;
950
951         // 4. Run the appropriate substeps that apply for the value of name, as follows:
952         switch (name) {
953         case Vertical:
954             {
955             // If name is a case-sensitive match for "vertical"
956             // 1. If value is a case-sensitive match for the string "rl", then let cue's text track cue writing direction 
957             //    be vertical growing left.
958             String writingDirection = WebVTTParser::collectWord(input, &position);
959             if (writingDirection == verticalGrowingLeftKeyword())
960                 m_writingDirection = VerticalGrowingLeft;
961             
962             // 2. Otherwise, if value is a case-sensitive match for the string "lr", then let cue's text track cue writing 
963             //    direction be vertical growing right.
964             else if (writingDirection == verticalGrowingRightKeyword())
965                 m_writingDirection = VerticalGrowingRight;
966             }
967             break;
968         case Line:
969             {
970             // 1-2 - Collect chars that are either '-', '%', or a digit.
971             // 1. If value contains any characters other than U+002D HYPHEN-MINUS characters (-), U+0025 PERCENT SIGN 
972             //    characters (%), and characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then jump
973             //    to the step labeled next setting.
974             StringBuilder linePositionBuilder;
975             while (position < input.length() && (input[position] == '-' || input[position] == '%' || isASCIIDigit(input[position])))
976                 linePositionBuilder.append(input[position++]);
977             if (position < input.length() && !WebVTTParser::isValidSettingDelimiter(input[position]))
978                 break;
979
980             // 2. If value does not contain at least one character in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT 
981             //    NINE (9), then jump to the step labeled next setting.
982             // 3. If any character in value other than the first character is a U+002D HYPHEN-MINUS character (-), then 
983             //    jump to the step labeled next setting.
984             // 4. If any character in value other than the last character is a U+0025 PERCENT SIGN character (%), then
985             //    jump to the step labeled next setting.
986             String linePosition = linePositionBuilder.toString();
987             if (linePosition.find('-', 1) != notFound || linePosition.reverseFind("%", linePosition.length() - 2) != notFound)
988                 break;
989
990             // 5. If the first character in value is a U+002D HYPHEN-MINUS character (-) and the last character in value is a 
991             //    U+0025 PERCENT SIGN character (%), then jump to the step labeled next setting.
992             if (linePosition[0] == '-' && linePosition[linePosition.length() - 1] == '%')
993                 break;
994
995             // 6. Ignoring the trailing percent sign, if any, interpret value as a (potentially signed) integer, and 
996             //    let number be that number. 
997             // NOTE: toInt ignores trailing non-digit characters, such as '%'.
998             bool validNumber;
999             int number = linePosition.toInt(&validNumber);
1000             if (!validNumber)
1001                 break;
1002
1003             // 7. If the last character in value is a U+0025 PERCENT SIGN character (%), but number is not in the range 
1004             //    0 ≤ number ≤ 100, then jump to the step labeled next setting.
1005             // 8. Let cue's text track cue line position be number.
1006             // 9. If the last character in value is a U+0025 PERCENT SIGN character (%), then let cue's text track cue 
1007             //    snap-to-lines flag be false. Otherwise, let it be true.
1008             if (linePosition[linePosition.length() - 1] == '%') {
1009                 if (number < 0 || number > 100)
1010                     break;
1011
1012                 // 10 - If '%' then set snap-to-lines flag to false.
1013                 m_snapToLines = false;
1014             }
1015
1016             m_linePosition = number;
1017             }
1018             break;
1019         case Position:
1020             {
1021             // 1. If value contains any characters other than U+0025 PERCENT SIGN characters (%) and characters in the range 
1022             //    U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then jump to the step labeled next setting.
1023             // 2. If value does not contain at least one character in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9),
1024             //    then jump to the step labeled next setting.
1025             String textPosition = WebVTTParser::collectDigits(input, &position);
1026             if (textPosition.isEmpty())
1027                 break;
1028             if (position >= input.length())
1029                 break;
1030
1031             // 3. If any character in value other than the last character is a U+0025 PERCENT SIGN character (%), then jump
1032             //    to the step labeled next setting.
1033             // 4. If the last character in value is not a U+0025 PERCENT SIGN character (%), then jump to the step labeled
1034             //    next setting.
1035             if (input[position++] != '%')
1036                 break;
1037             if (position < input.length() && !WebVTTParser::isValidSettingDelimiter(input[position]))
1038                 break;
1039
1040             // 5. Ignoring the trailing percent sign, interpret value as an integer, and let number be that number.
1041             // 6. If number is not in the range 0 ≤ number ≤ 100, then jump to the step labeled next setting.
1042             // NOTE: toInt ignores trailing non-digit characters, such as '%'.
1043             bool validNumber;
1044             int number = textPosition.toInt(&validNumber);
1045             if (!validNumber)
1046                 break;
1047             if (number < 0 || number > 100)
1048               break;
1049
1050             // 7. Let cue's text track cue text position be number.
1051             m_textPosition = number;
1052             }
1053             break;
1054         case Size:
1055             {
1056             // 1. If value contains any characters other than U+0025 PERCENT SIGN characters (%) and characters in the
1057             //    range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then jump to the step labeled next setting.
1058             // 2. If value does not contain at least one character in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT 
1059             //    NINE (9), then jump to the step labeled next setting.
1060             String cueSize = WebVTTParser::collectDigits(input, &position);
1061             if (cueSize.isEmpty())
1062                 break;
1063             if (position >= input.length())
1064                 break;
1065
1066             // 3. If any character in value other than the last character is a U+0025 PERCENT SIGN character (%),
1067             //    then jump to the step labeled next setting.
1068             // 4. If the last character in value is not a U+0025 PERCENT SIGN character (%), then jump to the step
1069             //    labeled next setting.
1070             if (input[position++] != '%')
1071                 break;
1072             if (position < input.length() && !WebVTTParser::isValidSettingDelimiter(input[position]))
1073                 break;
1074
1075             // 5. Ignoring the trailing percent sign, interpret value as an integer, and let number be that number.
1076             // 6. If number is not in the range 0 ≤ number ≤ 100, then jump to the step labeled next setting.
1077             bool validNumber;
1078             int number = cueSize.toInt(&validNumber);
1079             if (!validNumber)
1080                 break;
1081             if (number < 0 || number > 100)
1082                 break;
1083
1084             // 7. Let cue's text track cue size be number.
1085             m_cueSize = number;
1086             }
1087             break;
1088         case Align:
1089             {
1090             String cueAlignment = WebVTTParser::collectWord(input, &position);
1091
1092             // 1. If value is a case-sensitive match for the string "start", then let cue's text track cue alignment be start alignment.
1093             if (cueAlignment == startKeyword())
1094                 m_cueAlignment = Start;
1095
1096             // 2. If value is a case-sensitive match for the string "middle", then let cue's text track cue alignment be middle alignment.
1097             else if (cueAlignment == middleKeyword())
1098                 m_cueAlignment = Middle;
1099
1100             // 3. If value is a case-sensitive match for the string "end", then let cue's text track cue alignment be end alignment.
1101             else if (cueAlignment == endKeyword())
1102                 m_cueAlignment = End;
1103             }
1104             break;
1105 #if ENABLE(WEBVTT_REGIONS)
1106         case RegionId:
1107             m_regionId = WebVTTParser::collectWord(input, &position);
1108             break;
1109 #endif
1110         case None:
1111             break;
1112         }
1113
1114 NextSetting:
1115         position = endOfSetting;
1116     }
1117 #if ENABLE(WEBVTT_REGIONS)
1118     // If cue's line position is not auto or cue's size is not 100 or cue's
1119     // writing direction is not horizontal, but cue's region identifier is not
1120     // the empty string, let cue's region identifier be the empty string.
1121     if (m_regionId.isEmpty())
1122         return;
1123
1124     if (m_linePosition != undefinedPosition || m_cueSize != 100 || m_writingDirection != Horizontal)
1125         m_regionId = emptyString();
1126 #endif
1127 }
1128
1129 int TextTrackCue::getCSSWritingDirection() const
1130 {
1131     return m_displayDirection;
1132 }
1133
1134 int TextTrackCue::getCSSWritingMode() const
1135 {
1136     return m_displayWritingMode;
1137 }
1138
1139 int TextTrackCue::getCSSSize() const
1140 {
1141     return m_displaySize;
1142 }
1143
1144 std::pair<double, double> TextTrackCue::getCSSPosition() const
1145 {
1146     if (!m_snapToLines)
1147         return getPositionCoordinates();
1148
1149     return m_displayPosition;
1150 }
1151
1152 const AtomicString& TextTrackCue::interfaceName() const
1153 {
1154     return eventNames().interfaceForTextTrackCue;
1155 }
1156
1157 ScriptExecutionContext* TextTrackCue::scriptExecutionContext() const
1158 {
1159     return m_scriptExecutionContext;
1160 }
1161
1162 EventTargetData* TextTrackCue::eventTargetData()
1163 {
1164     return &m_eventTargetData;
1165 }
1166
1167 EventTargetData* TextTrackCue::ensureEventTargetData()
1168 {
1169     return &m_eventTargetData;
1170 }
1171
1172 bool TextTrackCue::isEqual(const TextTrackCue& cue, CueMatchRules match) const
1173 {
1174     if (cueType() != cue.cueType())
1175         return false;
1176     
1177     if (match != IgnoreDuration && m_endTime != cue.endTime())
1178         return false;
1179     if (m_startTime != cue.startTime())
1180         return false;
1181     if (m_content != cue.text())
1182         return false;
1183     if (m_settings != cue.cueSettings())
1184         return false;
1185     if (m_id != cue.id())
1186         return false;
1187     if (m_textPosition != cue.position())
1188         return false;
1189     if (m_linePosition != cue.line())
1190         return false;
1191     if (m_cueSize != cue.size())
1192         return false;
1193     if (align() != cue.align())
1194         return false;
1195     
1196     return true;
1197 }
1198
1199 bool TextTrackCue::isOrderedBefore(const TextTrackCue* other) const
1200 {
1201     return startTime() < other->startTime() || (startTime() == other->startTime() && endTime() > other->endTime());
1202 }
1203
1204 void TextTrackCue::setFontSize(int fontSize, const IntSize&, bool important)
1205 {
1206     if (!hasDisplayTree() || !fontSize)
1207         return;
1208     
1209     LOG(Media, "TextTrackCue::setFontSize - setting cue font size to %i", fontSize);
1210
1211     displayTreeInternal()->setInlineStyleProperty(CSSPropertyFontSize, String::number(fontSize) + "px", important);
1212 }
1213
1214 } // namespace WebCore
1215
1216 #endif