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