summaryrefslogtreecommitdiff
path: root/Source/WebCore/html/track/TextTrackCue.cpp
diff options
context:
space:
mode:
authorLorry Tar Creator <lorry-tar-importer@lorry>2016-04-10 09:28:39 +0000
committerLorry Tar Creator <lorry-tar-importer@lorry>2016-04-10 09:28:39 +0000
commit32761a6cee1d0dee366b885b7b9c777e67885688 (patch)
treed6bec92bebfb216f4126356e55518842c2f476a1 /Source/WebCore/html/track/TextTrackCue.cpp
parenta4e969f4965059196ca948db781e52f7cfebf19e (diff)
downloadWebKitGtk-tarball-32761a6cee1d0dee366b885b7b9c777e67885688.tar.gz
webkitgtk-2.4.11webkitgtk-2.4.11
Diffstat (limited to 'Source/WebCore/html/track/TextTrackCue.cpp')
-rw-r--r--Source/WebCore/html/track/TextTrackCue.cpp1039
1 files changed, 988 insertions, 51 deletions
diff --git a/Source/WebCore/html/track/TextTrackCue.cpp b/Source/WebCore/html/track/TextTrackCue.cpp
index a6b1dbb88..67ff91a98 100644
--- a/Source/WebCore/html/track/TextTrackCue.cpp
+++ b/Source/WebCore/html/track/TextTrackCue.cpp
@@ -1,6 +1,6 @@
/*
- * Copyright (C) 2011, 2013 Google Inc. All rights reserved.
- * Copyright (C) 2011, 2012, 2013, 2014 Apple Inc. All rights reserved.
+ * Copyright (C) 2011 Google Inc. All rights reserved.
+ * Copyright (C) 2011, 2012, 2013 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
@@ -43,43 +43,195 @@
#include "HTMLSpanElement.h"
#include "Logging.h"
#include "NodeTraversal.h"
+#include "RenderTextTrackCue.h"
#include "Text.h"
#include "TextTrack.h"
#include "TextTrackCueList.h"
-#include "VTTCue.h"
-#include "VTTRegionList.h"
+#include "WebVTTElement.h"
+#include "WebVTTParser.h"
#include <wtf/MathExtras.h>
#include <wtf/text/StringBuilder.h>
namespace WebCore {
static const int invalidCueIndex = -1;
+static const int undefinedPosition = -1;
-PassRefPtr<TextTrackCue> TextTrackCue::create(ScriptExecutionContext& context, double start, double end, const String& content)
+static const String& startKeyword()
{
- return create(context, MediaTime::createWithDouble(start), MediaTime::createWithDouble(end), content);
+ DEFINE_STATIC_LOCAL(const String, start, (ASCIILiteral("start")));
+ return start;
}
-PassRefPtr<TextTrackCue> TextTrackCue::create(ScriptExecutionContext& context, const MediaTime& start, const MediaTime& end, const String& content)
+static const String& middleKeyword()
{
- return VTTCue::create(context, start, end, content);
+ DEFINE_STATIC_LOCAL(const String, middle, (ASCIILiteral("middle")));
+ return middle;
}
-TextTrackCue::TextTrackCue(ScriptExecutionContext& context, const MediaTime& start, const MediaTime& end)
+static const String& endKeyword()
+{
+ DEFINE_STATIC_LOCAL(const String, end, (ASCIILiteral("end")));
+ return end;
+}
+
+static const String& horizontalKeyword()
+{
+ return emptyString();
+}
+
+static const String& verticalGrowingLeftKeyword()
+{
+ DEFINE_STATIC_LOCAL(const String, verticalrl, (ASCIILiteral("rl")));
+ return verticalrl;
+}
+
+static const String& verticalGrowingRightKeyword()
+{
+ DEFINE_STATIC_LOCAL(const String, verticallr, (ASCIILiteral("lr")));
+ return verticallr;
+}
+
+// ----------------------------
+
+TextTrackCueBox::TextTrackCueBox(Document& document, TextTrackCue* cue)
+ : HTMLElement(divTag, document)
+ , m_cue(cue)
+{
+ setPseudo(textTrackCueBoxShadowPseudoId());
+}
+
+TextTrackCue* TextTrackCueBox::getCue() const
+{
+ return m_cue;
+}
+
+void TextTrackCueBox::applyCSSProperties(const IntSize&)
+{
+ // FIXME: Apply all the initial CSS positioning properties. http://wkb.ug/79916
+
+ // 3.5.1 On the (root) List of WebVTT Node Objects:
+
+ // the 'position' property must be set to 'absolute'
+ setInlineStyleProperty(CSSPropertyPosition, CSSValueAbsolute);
+
+ // the 'unicode-bidi' property must be set to 'plaintext'
+ setInlineStyleProperty(CSSPropertyUnicodeBidi, CSSValueWebkitPlaintext);
+
+ // the 'direction' property must be set to direction
+ setInlineStyleProperty(CSSPropertyDirection, m_cue->getCSSWritingDirection());
+
+ // the 'writing-mode' property must be set to writing-mode
+ setInlineStyleProperty(CSSPropertyWebkitWritingMode, m_cue->getCSSWritingMode(), false);
+
+ std::pair<float, float> position = m_cue->getCSSPosition();
+
+ // the 'top' property must be set to top,
+ setInlineStyleProperty(CSSPropertyTop, static_cast<double>(position.second), CSSPrimitiveValue::CSS_PERCENTAGE);
+
+ // the 'left' property must be set to left
+ setInlineStyleProperty(CSSPropertyLeft, static_cast<double>(position.first), CSSPrimitiveValue::CSS_PERCENTAGE);
+
+ // the 'width' property must be set to width, and the 'height' property must be set to height
+ if (m_cue->vertical() == horizontalKeyword()) {
+ setInlineStyleProperty(CSSPropertyWidth, static_cast<double>(m_cue->getCSSSize()), CSSPrimitiveValue::CSS_PERCENTAGE);
+ setInlineStyleProperty(CSSPropertyHeight, CSSValueAuto);
+ } else {
+ setInlineStyleProperty(CSSPropertyWidth, CSSValueAuto);
+ setInlineStyleProperty(CSSPropertyHeight, static_cast<double>(m_cue->getCSSSize()), CSSPrimitiveValue::CSS_PERCENTAGE);
+ }
+
+ // The 'text-align' property on the (root) List of WebVTT Node Objects must
+ // be set to the value in the second cell of the row of the table below
+ // whose first cell is the value of the corresponding cue's text track cue
+ // alignment:
+ if (m_cue->align() == startKeyword())
+ setInlineStyleProperty(CSSPropertyTextAlign, CSSValueStart);
+ else if (m_cue->align() == endKeyword())
+ setInlineStyleProperty(CSSPropertyTextAlign, CSSValueEnd);
+ else
+ setInlineStyleProperty(CSSPropertyTextAlign, CSSValueCenter);
+
+ if (!m_cue->snapToLines()) {
+ // 10.13.1 Set up x and y:
+ // Note: x and y are set through the CSS left and top above.
+
+ // 10.13.2 Position the boxes in boxes such that the point x% along the
+ // width of the bounding box of the boxes in boxes is x% of the way
+ // across the width of the video's rendering area, and the point y%
+ // along the height of the bounding box of the boxes in boxes is y%
+ // of the way across the height of the video's rendering area, while
+ // maintaining the relative positions of the boxes in boxes to each
+ // other.
+ setInlineStyleProperty(CSSPropertyWebkitTransform,
+ String::format("translate(-%.2f%%, -%.2f%%)", position.first, position.second));
+
+ setInlineStyleProperty(CSSPropertyWhiteSpace, CSSValuePre);
+ }
+}
+
+const AtomicString& TextTrackCueBox::textTrackCueBoxShadowPseudoId()
+{
+ DEFINE_STATIC_LOCAL(const AtomicString, trackDisplayBoxShadowPseudoId, ("-webkit-media-text-track-display", AtomicString::ConstructFromLiteral));
+ return trackDisplayBoxShadowPseudoId;
+}
+
+RenderPtr<RenderElement> TextTrackCueBox::createElementRenderer(PassRef<RenderStyle> style)
+{
+ return createRenderer<RenderTextTrackCue>(*this, std::move(style));
+}
+
+// ----------------------------
+
+TextTrackCue::TextTrackCue(ScriptExecutionContext& context, double start, double end, const String& content)
: m_startTime(start)
, m_endTime(end)
+ , m_content(content)
+ , m_linePosition(undefinedPosition)
+ , m_computedLinePosition(undefinedPosition)
+ , m_textPosition(50)
+ , m_cueSize(100)
, m_cueIndex(invalidCueIndex)
, m_processingCueChanges(0)
+ , m_writingDirection(Horizontal)
+ , m_cueAlignment(Middle)
+ , m_webVTTNodeTree(0)
, m_track(0)
, m_scriptExecutionContext(context)
, m_isActive(false)
, m_pauseOnExit(false)
+ , m_snapToLines(true)
+ , m_cueBackgroundBox(HTMLSpanElement::create(spanTag, toDocument(context)))
+ , m_displayTreeShouldChange(true)
+ , m_displayDirection(CSSValueLtr)
{
ASSERT(m_scriptExecutionContext.isDocument());
+
+ // 4. If the text track cue writing direction is horizontal, then let
+ // writing-mode be 'horizontal-tb'. Otherwise, if the text track cue writing
+ // direction is vertical growing left, then let writing-mode be
+ // 'vertical-rl'. Otherwise, the text track cue writing direction is
+ // vertical growing right; let writing-mode be 'vertical-lr'.
+ m_displayWritingModeMap[Horizontal] = CSSValueHorizontalTb;
+ m_displayWritingModeMap[VerticalGrowingLeft] = CSSValueVerticalRl;
+ m_displayWritingModeMap[VerticalGrowingRight] = CSSValueVerticalLr;
}
TextTrackCue::~TextTrackCue()
{
+ removeDisplayTree();
+}
+
+PassRefPtr<TextTrackCueBox> TextTrackCue::createDisplayTree()
+{
+ return TextTrackCueBox::create(ownerDocument(), this);
+}
+
+TextTrackCueBox* TextTrackCue::displayTreeInternal()
+{
+ if (!m_displayTree)
+ m_displayTree = createDisplayTree();
+ return m_displayTree.get();
}
void TextTrackCue::willChange()
@@ -99,6 +251,8 @@ void TextTrackCue::didChange()
if (m_track)
m_track->cueDidChange(this);
+
+ m_displayTreeShouldChange = true;
}
TextTrack* TextTrackCue::track() const
@@ -130,14 +284,9 @@ void TextTrackCue::setStartTime(double value, ExceptionCode& ec)
}
// TODO(93143): Add spec-compliant behavior for negative time values.
- if (m_startTime.toDouble() == value || value < 0)
+ if (m_startTime == value || value < 0)
return;
- setStartTime(MediaTime::createWithDouble(value));
-}
-
-void TextTrackCue::setStartTime(const MediaTime& value)
-{
willChange();
m_startTime = value;
didChange();
@@ -152,14 +301,9 @@ void TextTrackCue::setEndTime(double value, ExceptionCode& ec)
}
// TODO(93143): Add spec-compliant behavior for negative time values.
- if (m_endTime.toDouble() == value || value < 0)
+ if (m_endTime == value || value < 0)
return;
- setEndTime(MediaTime::createWithDouble(value));
-}
-
-void TextTrackCue::setEndTime(const MediaTime& value)
-{
willChange();
m_endTime = value;
didChange();
@@ -173,6 +317,169 @@ void TextTrackCue::setPauseOnExit(bool value)
m_pauseOnExit = value;
}
+const String& TextTrackCue::vertical() const
+{
+ switch (m_writingDirection) {
+ case Horizontal:
+ return horizontalKeyword();
+ case VerticalGrowingLeft:
+ return verticalGrowingLeftKeyword();
+ case VerticalGrowingRight:
+ return verticalGrowingRightKeyword();
+ default:
+ ASSERT_NOT_REACHED();
+ return emptyString();
+ }
+}
+
+void TextTrackCue::setVertical(const String& value, ExceptionCode& ec)
+{
+ // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#dom-texttrackcue-vertical
+ // On setting, the text track cue writing direction must be set to the value given
+ // in the first cell of the row in the table above whose second cell is a
+ // case-sensitive match for the new value, if any. If none of the values match, then
+ // the user agent must instead throw a SyntaxError exception.
+
+ WritingDirection direction = m_writingDirection;
+ if (value == horizontalKeyword())
+ direction = Horizontal;
+ else if (value == verticalGrowingLeftKeyword())
+ direction = VerticalGrowingLeft;
+ else if (value == verticalGrowingRightKeyword())
+ direction = VerticalGrowingRight;
+ else
+ ec = SYNTAX_ERR;
+
+ if (direction == m_writingDirection)
+ return;
+
+ willChange();
+ m_writingDirection = direction;
+ didChange();
+}
+
+void TextTrackCue::setSnapToLines(bool value)
+{
+ if (m_snapToLines == value)
+ return;
+
+ willChange();
+ m_snapToLines = value;
+ didChange();
+}
+
+void TextTrackCue::setLine(int position, ExceptionCode& ec)
+{
+ // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#dom-texttrackcue-line
+ // On setting, if the text track cue snap-to-lines flag is not set, and the new
+ // value is negative or greater than 100, then throw an IndexSizeError exception.
+ if (!m_snapToLines && (position < 0 || position > 100)) {
+ ec = INDEX_SIZE_ERR;
+ return;
+ }
+
+ // Otherwise, set the text track cue line position to the new value.
+ if (m_linePosition == position)
+ return;
+
+ willChange();
+ m_linePosition = position;
+ m_computedLinePosition = calculateComputedLinePosition();
+ didChange();
+}
+
+void TextTrackCue::setPosition(int position, ExceptionCode& ec)
+{
+ // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#dom-texttrackcue-position
+ // On setting, if the new value is negative or greater than 100, then throw an IndexSizeError exception.
+ // Otherwise, set the text track cue text position to the new value.
+ if (position < 0 || position > 100) {
+ ec = INDEX_SIZE_ERR;
+ return;
+ }
+
+ // Otherwise, set the text track cue line position to the new value.
+ if (m_textPosition == position)
+ return;
+
+ willChange();
+ m_textPosition = position;
+ didChange();
+}
+
+void TextTrackCue::setSize(int size, ExceptionCode& ec)
+{
+ // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#dom-texttrackcue-size
+ // On setting, if the new value is negative or greater than 100, then throw an IndexSizeError
+ // exception. Otherwise, set the text track cue size to the new value.
+ if (size < 0 || size > 100) {
+ ec = INDEX_SIZE_ERR;
+ return;
+ }
+
+ // Otherwise, set the text track cue line position to the new value.
+ if (m_cueSize == size)
+ return;
+
+ willChange();
+ m_cueSize = size;
+ didChange();
+}
+
+const String& TextTrackCue::align() const
+{
+ switch (m_cueAlignment) {
+ case Start:
+ return startKeyword();
+ case Middle:
+ return middleKeyword();
+ case End:
+ return endKeyword();
+ default:
+ ASSERT_NOT_REACHED();
+ return emptyString();
+ }
+}
+
+void TextTrackCue::setAlign(const String& value, ExceptionCode& ec)
+{
+ // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#dom-texttrackcue-align
+ // On setting, the text track cue alignment must be set to the value given in the
+ // first cell of the row in the table above whose second cell is a case-sensitive
+ // match for the new value, if any. If none of the values match, then the user
+ // agent must instead throw a SyntaxError exception.
+
+ CueAlignment alignment = m_cueAlignment;
+ if (value == startKeyword())
+ alignment = Start;
+ else if (value == middleKeyword())
+ alignment = Middle;
+ else if (value == endKeyword())
+ alignment = End;
+ else
+ ec = SYNTAX_ERR;
+
+ if (alignment == m_cueAlignment)
+ return;
+
+ willChange();
+ m_cueAlignment = alignment;
+ didChange();
+}
+
+void TextTrackCue::setText(const String& text)
+{
+ if (m_content == text)
+ return;
+
+ willChange();
+ // Clear the document fragment but don't bother to create it again just yet as we can do that
+ // when it is requested.
+ m_webVTTNodeTree = 0;
+ m_content = text;
+ didChange();
+}
+
int TextTrackCue::cueIndex()
{
if (m_cueIndex == invalidCueIndex) {
@@ -190,7 +497,50 @@ void TextTrackCue::invalidateCueIndex()
m_cueIndex = invalidCueIndex;
}
-bool TextTrackCue::dispatchEvent(Event& event)
+void TextTrackCue::createWebVTTNodeTree()
+{
+ if (!m_webVTTNodeTree)
+ m_webVTTNodeTree = WebVTTParser::create(0, &m_scriptExecutionContext)->createDocumentFragmentFromCueText(m_content);
+}
+
+void TextTrackCue::copyWebVTTNodeToDOMTree(ContainerNode* webVTTNode, ContainerNode* parent)
+{
+ for (Node* node = webVTTNode->firstChild(); node; node = node->nextSibling()) {
+ RefPtr<Node> clonedNode;
+ if (node->isWebVTTElement())
+ clonedNode = toWebVTTElement(node)->createEquivalentHTMLElement(ownerDocument());
+ else
+ clonedNode = node->cloneNode(false);
+ parent->appendChild(clonedNode, ASSERT_NO_EXCEPTION);
+ if (node->isContainerNode())
+ copyWebVTTNodeToDOMTree(toContainerNode(node), toContainerNode(clonedNode.get()));
+ }
+}
+
+PassRefPtr<DocumentFragment> TextTrackCue::getCueAsHTML()
+{
+ createWebVTTNodeTree();
+ if (!m_webVTTNodeTree)
+ return 0;
+
+ RefPtr<DocumentFragment> clonedFragment = DocumentFragment::create(ownerDocument());
+ copyWebVTTNodeToDOMTree(m_webVTTNodeTree.get(), clonedFragment.get());
+ return clonedFragment.release();
+}
+
+PassRefPtr<DocumentFragment> TextTrackCue::createCueRenderingTree()
+{
+ RefPtr<DocumentFragment> clonedFragment;
+ createWebVTTNodeTree();
+ if (!m_webVTTNodeTree)
+ return 0;
+
+ clonedFragment = DocumentFragment::create(ownerDocument());
+ m_webVTTNodeTree->cloneChildNodes(clonedFragment.get());
+ return clonedFragment.release();
+}
+
+bool TextTrackCue::dispatchEvent(PassRefPtr<Event> event)
{
// When a TextTrack's mode is disabled: no cues are active, no events fired.
if (!track() || track()->mode() == TextTrack::disabledKeyword())
@@ -199,6 +549,18 @@ bool TextTrackCue::dispatchEvent(Event& event)
return EventTarget::dispatchEvent(event);
}
+#if ENABLE(WEBVTT_REGIONS)
+void TextTrackCue::setRegionId(const String& regionId)
+{
+ if (m_regionId == regionId)
+ return;
+
+ willChange();
+ m_regionId = regionId;
+ didChange();
+}
+#endif
+
bool TextTrackCue::isActive()
{
return m_isActive && track() && track()->mode() != TextTrack::disabledKeyword();
@@ -207,61 +569,636 @@ bool TextTrackCue::isActive()
void TextTrackCue::setIsActive(bool active)
{
m_isActive = active;
+
+ if (!active) {
+ if (!hasDisplayTree())
+ return;
+
+ // Remove the display tree as soon as the cue becomes inactive.
+ displayTreeInternal()->remove(ASSERT_NO_EXCEPTION);
+ }
}
-bool TextTrackCue::isOrderedBefore(const TextTrackCue* other) const
+int TextTrackCue::calculateComputedLinePosition()
{
- return startMediaTime() < other->startMediaTime() || (startMediaTime() == other->startMediaTime() && endMediaTime() > other->endMediaTime());
+ // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#text-track-cue-computed-line-position
+
+ // If the text track cue line position is numeric, then that is the text
+ // track cue computed line position.
+ if (m_linePosition != undefinedPosition)
+ return m_linePosition;
+
+ // If the text track cue snap-to-lines flag of the text track cue is not
+ // set, the text track cue computed line position is the value 100;
+ if (!m_snapToLines)
+ return 100;
+
+ // Otherwise, it is the value returned by the following algorithm:
+
+ // If cue is not associated with a text track, return -1 and abort these
+ // steps.
+ if (!track())
+ return -1;
+
+ // Let n be the number of text tracks whose text track mode is showing or
+ // showing by default and that are in the media element's list of text
+ // tracks before track.
+ int n = track()->trackIndexRelativeToRenderedTracks();
+
+ // Increment n by one.
+ n++;
+
+ // Negate n.
+ n = -n;
+
+ return n;
}
-bool TextTrackCue::cueContentsMatch(const TextTrackCue& cue) const
+static bool isCueParagraphSeparator(UChar character)
{
- if (cueType() != cue.cueType())
- return false;
+ // Within a cue, paragraph boundaries are only denoted by Type B characters,
+ // such as U+000A LINE FEED (LF), U+0085 NEXT LINE (NEL), and U+2029 PARAGRAPH SEPARATOR.
+ return u_charType(character) == U_PARAGRAPH_SEPARATOR;
+}
- if (id() != cue.id())
- return false;
+void TextTrackCue::determineTextDirection()
+{
+ DEFINE_STATIC_LOCAL(const String, rtTag, (ASCIILiteral("rt")));
+ createWebVTTNodeTree();
+ if (!m_webVTTNodeTree)
+ return;
- return true;
+ // Apply the Unicode Bidirectional Algorithm's Paragraph Level steps to the
+ // concatenation of the values of each WebVTT Text Object in nodes, in a
+ // pre-order, depth-first traversal, excluding WebVTT Ruby Text Objects and
+ // their descendants.
+ StringBuilder paragraphBuilder;
+ for (Node* node = m_webVTTNodeTree->firstChild(); node; node = NodeTraversal::next(node, m_webVTTNodeTree.get())) {
+ // FIXME: The code does not match the comment above. This does not actually exclude Ruby Text Object descendant.
+ if (!node->isTextNode() || node->localName() == rtTag)
+ continue;
+
+ paragraphBuilder.append(node->nodeValue());
+ }
+
+ String paragraph = paragraphBuilder.toString();
+ if (!paragraph.length())
+ return;
+
+ for (size_t i = 0; i < paragraph.length(); ++i) {
+ UChar current = paragraph[i];
+ if (!current || isCueParagraphSeparator(current))
+ return;
+
+ if (UChar current = paragraph[i]) {
+ UCharDirection charDirection = u_charDirection(current);
+ if (charDirection == U_LEFT_TO_RIGHT) {
+ m_displayDirection = CSSValueLtr;
+ return;
+ }
+ if (charDirection == U_RIGHT_TO_LEFT || charDirection == U_RIGHT_TO_LEFT_ARABIC) {
+ m_displayDirection = CSSValueRtl;
+ return;
+ }
+ }
+ }
}
-bool TextTrackCue::isEqual(const TextTrackCue& cue, TextTrackCue::CueMatchRules match) const
+void TextTrackCue::calculateDisplayParameters()
{
- if (cueType() != cue.cueType())
- return false;
+ // Steps 10.2, 10.3
+ determineTextDirection();
- if (match != IgnoreDuration && endMediaTime() != cue.endMediaTime())
- return false;
- if (!hasEquivalentStartTime(cue))
- return false;
- if (!cueContentsMatch(cue))
- return false;
+ // 10.4 If the text track cue writing direction is horizontal, then let
+ // block-flow be 'tb'. Otherwise, if the text track cue writing direction is
+ // vertical growing left, then let block-flow be 'lr'. Otherwise, the text
+ // track cue writing direction is vertical growing right; let block-flow be
+ // 'rl'.
+ m_displayWritingMode = m_displayWritingModeMap[m_writingDirection];
- return true;
+ // 10.5 Determine the value of maximum size for cue as per the appropriate
+ // rules from the following list:
+ int maximumSize = m_textPosition;
+ if ((m_writingDirection == Horizontal && m_cueAlignment == Start && m_displayDirection == CSSValueLtr)
+ || (m_writingDirection == Horizontal && m_cueAlignment == End && m_displayDirection == CSSValueRtl)
+ || (m_writingDirection == VerticalGrowingLeft && m_cueAlignment == Start)
+ || (m_writingDirection == VerticalGrowingRight && m_cueAlignment == Start)) {
+ maximumSize = 100 - m_textPosition;
+ } else if ((m_writingDirection == Horizontal && m_cueAlignment == End && m_displayDirection == CSSValueLtr)
+ || (m_writingDirection == Horizontal && m_cueAlignment == Start && m_displayDirection == CSSValueRtl)
+ || (m_writingDirection == VerticalGrowingLeft && m_cueAlignment == End)
+ || (m_writingDirection == VerticalGrowingRight && m_cueAlignment == End)) {
+ maximumSize = m_textPosition;
+ } else if (m_cueAlignment == Middle) {
+ maximumSize = m_textPosition <= 50 ? m_textPosition : (100 - m_textPosition);
+ maximumSize = maximumSize * 2;
+ }
+
+ // 10.6 If the text track cue size is less than maximum size, then let size
+ // be text track cue size. Otherwise, let size be maximum size.
+ m_displaySize = std::min(m_cueSize, maximumSize);
+
+ // 10.8 Determine the value of x-position or y-position for cue as per the
+ // appropriate rules from the following list:
+ if (m_writingDirection == Horizontal) {
+ if (m_cueAlignment == Start) {
+ if (m_displayDirection == CSSValueLtr)
+ m_displayPosition.first = m_textPosition;
+ else
+ m_displayPosition.first = 100 - m_textPosition - m_displaySize;
+ } else if (m_cueAlignment == End) {
+ if (m_displayDirection == CSSValueRtl)
+ m_displayPosition.first = 100 - m_textPosition;
+ else
+ m_displayPosition.first = m_textPosition - m_displaySize;
+ }
+ }
+
+ if ((m_writingDirection == VerticalGrowingLeft && m_cueAlignment == Start)
+ || (m_writingDirection == VerticalGrowingRight && m_cueAlignment == Start)) {
+ m_displayPosition.second = m_textPosition;
+ } else if ((m_writingDirection == VerticalGrowingLeft && m_cueAlignment == End)
+ || (m_writingDirection == VerticalGrowingRight && m_cueAlignment == End)) {
+ m_displayPosition.second = 100 - m_textPosition;
+ }
+
+ if (m_writingDirection == Horizontal && m_cueAlignment == Middle) {
+ if (m_displayDirection == CSSValueLtr)
+ m_displayPosition.first = m_textPosition - m_displaySize / 2;
+ else
+ m_displayPosition.first = 100 - m_textPosition - m_displaySize / 2;
+ }
+
+ if ((m_writingDirection == VerticalGrowingLeft && m_cueAlignment == Middle)
+ || (m_writingDirection == VerticalGrowingRight && m_cueAlignment == Middle))
+ m_displayPosition.second = m_textPosition - m_displaySize / 2;
+
+ // 10.9 Determine the value of whichever of x-position or y-position is not
+ // yet calculated for cue as per the appropriate rules from the following
+ // list:
+ if (m_snapToLines && m_displayPosition.second == undefinedPosition && m_writingDirection == Horizontal)
+ m_displayPosition.second = 0;
+
+ if (!m_snapToLines && m_displayPosition.second == undefinedPosition && m_writingDirection == Horizontal)
+ m_displayPosition.second = m_computedLinePosition;
+
+ if (m_snapToLines && m_displayPosition.first == undefinedPosition
+ && (m_writingDirection == VerticalGrowingLeft || m_writingDirection == VerticalGrowingRight))
+ m_displayPosition.first = 0;
+
+ if (!m_snapToLines && (m_writingDirection == VerticalGrowingLeft || m_writingDirection == VerticalGrowingRight))
+ m_displayPosition.first = m_computedLinePosition;
+
+ // A text track cue has a text track cue computed line position whose value
+ // is defined in terms of the other aspects of the cue.
+ m_computedLinePosition = calculateComputedLinePosition();
+}
+
+void TextTrackCue::markFutureAndPastNodes(ContainerNode* root, double previousTimestamp, double movieTime)
+{
+ DEFINE_STATIC_LOCAL(const String, timestampTag, (ASCIILiteral("timestamp")));
+
+ bool isPastNode = true;
+ double currentTimestamp = previousTimestamp;
+ if (currentTimestamp > movieTime)
+ isPastNode = false;
+
+ for (Node* child = root->firstChild(); child; child = NodeTraversal::next(child, root)) {
+ if (child->nodeName() == timestampTag) {
+ unsigned position = 0;
+ String timestamp = child->nodeValue();
+ double currentTimestamp = WebVTTParser::create(0, &m_scriptExecutionContext)->collectTimeStamp(timestamp, &position);
+ ASSERT(currentTimestamp != -1);
+
+ if (currentTimestamp > movieTime)
+ isPastNode = false;
+ }
+
+ if (child->isWebVTTElement()) {
+ toWebVTTElement(child)->setIsPastNode(isPastNode);
+ // Make an elemenet id match a cue id for style matching purposes.
+ if (!m_id.isEmpty())
+ toElement(child)->setIdAttribute(m_id);
+ }
+ }
}
-bool TextTrackCue::hasEquivalentStartTime(const TextTrackCue& cue) const
+void TextTrackCue::updateDisplayTree(double movieTime)
{
- MediaTime startTimeVariance = MediaTime::zeroTime();
- if (track())
- startTimeVariance = track()->startTimeVariance();
- else if (cue.track())
- startTimeVariance = cue.track()->startTimeVariance();
+ // The display tree may contain WebVTT timestamp objects representing
+ // timestamps (processing instructions), along with displayable nodes.
+
+ if (!track()->isRendered())
+ return;
+
+ // Clear the contents of the set.
+ m_cueBackgroundBox->removeChildren();
- return abs(abs(startMediaTime()) - abs(cue.startMediaTime())) <= startTimeVariance;
+ // Update the two sets containing past and future WebVTT objects.
+ RefPtr<DocumentFragment> referenceTree = createCueRenderingTree();
+ if (!referenceTree)
+ return;
+
+ markFutureAndPastNodes(referenceTree.get(), startTime(), movieTime);
+ m_cueBackgroundBox->appendChild(referenceTree);
}
-bool TextTrackCue::doesExtendCue(const TextTrackCue& cue) const
+TextTrackCueBox* TextTrackCue::getDisplayTree(const IntSize& videoSize)
{
- if (!cueContentsMatch(cue))
- return false;
+ RefPtr<TextTrackCueBox> displayTree = displayTreeInternal();
+ if (!m_displayTreeShouldChange || !track()->isRendered())
+ return displayTree.get();
+
+ // 10.1 - 10.10
+ calculateDisplayParameters();
+
+ // 10.11. Apply the terms of the CSS specifications to nodes within the
+ // following constraints, thus obtaining a set of CSS boxes positioned
+ // relative to an initial containing block:
+ displayTree->removeChildren();
+
+ // The document tree is the tree of WebVTT Node Objects rooted at nodes.
+
+ // The children of the nodes must be wrapped in an anonymous box whose
+ // 'display' property has the value 'inline'. This is the WebVTT cue
+ // background box.
+
+ // Note: This is contained by default in m_cueBackgroundBox.
+ m_cueBackgroundBox->setPseudo(cueShadowPseudoId());
+ displayTree->appendChild(m_cueBackgroundBox, ASSERT_NO_EXCEPTION);
+
+ // FIXME(BUG 79916): Runs of children of WebVTT Ruby Objects that are not
+ // WebVTT Ruby Text Objects must be wrapped in anonymous boxes whose
+ // 'display' property has the value 'ruby-base'.
+
+ // FIXME(BUG 79916): Text runs must be wrapped according to the CSS
+ // line-wrapping rules, except that additionally, regardless of the value of
+ // the 'white-space' property, lines must be wrapped at the edge of their
+ // containing blocks, even if doing so requires splitting a word where there
+ // is no line breaking opportunity. (Thus, normally text wraps as needed,
+ // but if there is a particularly long word, it does not overflow as it
+ // normally would in CSS, it is instead forcibly wrapped at the box's edge.)
+ displayTree->applyCSSProperties(videoSize);
+
+ m_displayTreeShouldChange = false;
+
+ // 10.15. Let cue's text track cue display state have the CSS boxes in
+ // boxes.
+ return displayTree.get();
+}
+
+void TextTrackCue::removeDisplayTree()
+{
+ if (!hasDisplayTree())
+ return;
+ displayTreeInternal()->remove(ASSERT_NO_EXCEPTION);
+}
+
+std::pair<double, double> TextTrackCue::getPositionCoordinates() const
+{
+ // This method is used for setting x and y when snap to lines is not set.
+ std::pair<double, double> coordinates;
+
+ if (m_writingDirection == Horizontal && m_displayDirection == CSSValueLtr) {
+ coordinates.first = m_textPosition;
+ coordinates.second = m_computedLinePosition;
+
+ return coordinates;
+ }
+
+ if (m_writingDirection == Horizontal && m_displayDirection == CSSValueRtl) {
+ coordinates.first = 100 - m_textPosition;
+ coordinates.second = m_computedLinePosition;
+
+ return coordinates;
+ }
+
+ if (m_writingDirection == VerticalGrowingLeft) {
+ coordinates.first = 100 - m_computedLinePosition;
+ coordinates.second = m_textPosition;
+
+ return coordinates;
+ }
+
+ if (m_writingDirection == VerticalGrowingRight) {
+ coordinates.first = m_computedLinePosition;
+ coordinates.second = m_textPosition;
- if (endMediaTime() != cue.startMediaTime())
+ return coordinates;
+ }
+
+ ASSERT_NOT_REACHED();
+
+ return coordinates;
+}
+
+TextTrackCue::CueSetting TextTrackCue::settingName(const String& name)
+{
+ DEFINE_STATIC_LOCAL(const String, verticalKeyword, (ASCIILiteral("vertical")));
+ DEFINE_STATIC_LOCAL(const String, lineKeyword, (ASCIILiteral("line")));
+ DEFINE_STATIC_LOCAL(const String, positionKeyword, (ASCIILiteral("position")));
+ DEFINE_STATIC_LOCAL(const String, sizeKeyword, (ASCIILiteral("size")));
+ DEFINE_STATIC_LOCAL(const String, alignKeyword, (ASCIILiteral("align")));
+#if ENABLE(WEBVTT_REGIONS)
+ DEFINE_STATIC_LOCAL(const String, regionIdKeyword, (ASCIILiteral("region")));
+#endif
+
+ if (name == verticalKeyword)
+ return Vertical;
+ else if (name == lineKeyword)
+ return Line;
+ else if (name == positionKeyword)
+ return Position;
+ else if (name == sizeKeyword)
+ return Size;
+ else if (name == alignKeyword)
+ return Align;
+#if ENABLE(WEBVTT_REGIONS)
+ else if (name == regionIdKeyword)
+ return RegionId;
+#endif
+
+ return None;
+}
+
+void TextTrackCue::setCueSettings(const String& input)
+{
+ m_settings = input;
+ unsigned position = 0;
+
+ while (position < input.length()) {
+
+ // The WebVTT cue settings part of a WebVTT cue consists of zero or more of the following components, in any order,
+ // separated from each other by one or more U+0020 SPACE characters or U+0009 CHARACTER TABULATION (tab) characters.
+ while (position < input.length() && WebVTTParser::isValidSettingDelimiter(input[position]))
+ position++;
+ if (position >= input.length())
+ break;
+
+ // When the user agent is to parse the WebVTT settings given by a string input for a text track cue cue,
+ // the user agent must run the following steps:
+ // 1. Let settings be the result of splitting input on spaces.
+ // 2. For each token setting in the list settings, run the following substeps:
+ // 1. If setting does not contain a U+003A COLON character (:), or if the first U+003A COLON character (:)
+ // in setting is either the first or last character of setting, then jump to the step labeled next setting.
+ unsigned endOfSetting = position;
+ String setting = WebVTTParser::collectWord(input, &endOfSetting);
+ CueSetting name;
+ size_t colonOffset = setting.find(':', 1);
+ if (colonOffset == notFound || colonOffset == 0 || colonOffset == setting.length() - 1)
+ goto NextSetting;
+
+ // 2. Let name be the leading substring of setting up to and excluding the first U+003A COLON character (:) in that string.
+ name = settingName(setting.substring(0, colonOffset));
+
+ // 3. Let value be the trailing substring of setting starting from the character immediately after the first U+003A COLON character (:) in that string.
+ position += colonOffset + 1;
+ if (position >= input.length())
+ break;
+
+ // 4. Run the appropriate substeps that apply for the value of name, as follows:
+ switch (name) {
+ case Vertical:
+ {
+ // If name is a case-sensitive match for "vertical"
+ // 1. If value is a case-sensitive match for the string "rl", then let cue's text track cue writing direction
+ // be vertical growing left.
+ String writingDirection = WebVTTParser::collectWord(input, &position);
+ if (writingDirection == verticalGrowingLeftKeyword())
+ m_writingDirection = VerticalGrowingLeft;
+
+ // 2. Otherwise, if value is a case-sensitive match for the string "lr", then let cue's text track cue writing
+ // direction be vertical growing right.
+ else if (writingDirection == verticalGrowingRightKeyword())
+ m_writingDirection = VerticalGrowingRight;
+ }
+ break;
+ case Line:
+ {
+ // 1-2 - Collect chars that are either '-', '%', or a digit.
+ // 1. If value contains any characters other than U+002D HYPHEN-MINUS characters (-), U+0025 PERCENT SIGN
+ // characters (%), and characters in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then jump
+ // to the step labeled next setting.
+ StringBuilder linePositionBuilder;
+ while (position < input.length() && (input[position] == '-' || input[position] == '%' || isASCIIDigit(input[position])))
+ linePositionBuilder.append(input[position++]);
+ if (position < input.length() && !WebVTTParser::isValidSettingDelimiter(input[position]))
+ break;
+
+ // 2. If value does not contain at least one character in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT
+ // NINE (9), then jump to the step labeled next setting.
+ // 3. If any character in value other than the first character is a U+002D HYPHEN-MINUS character (-), then
+ // jump to the step labeled next setting.
+ // 4. If any character in value other than the last character is a U+0025 PERCENT SIGN character (%), then
+ // jump to the step labeled next setting.
+ String linePosition = linePositionBuilder.toString();
+ if (linePosition.find('-', 1) != notFound || linePosition.reverseFind("%", linePosition.length() - 2) != notFound)
+ break;
+
+ // 5. If the first character in value is a U+002D HYPHEN-MINUS character (-) and the last character in value is a
+ // U+0025 PERCENT SIGN character (%), then jump to the step labeled next setting.
+ if (linePosition[0] == '-' && linePosition[linePosition.length() - 1] == '%')
+ break;
+
+ // 6. Ignoring the trailing percent sign, if any, interpret value as a (potentially signed) integer, and
+ // let number be that number.
+ // NOTE: toInt ignores trailing non-digit characters, such as '%'.
+ bool validNumber;
+ int number = linePosition.toInt(&validNumber);
+ if (!validNumber)
+ break;
+
+ // 7. If the last character in value is a U+0025 PERCENT SIGN character (%), but number is not in the range
+ // 0 ≤ number ≤ 100, then jump to the step labeled next setting.
+ // 8. Let cue's text track cue line position be number.
+ // 9. If the last character in value is a U+0025 PERCENT SIGN character (%), then let cue's text track cue
+ // snap-to-lines flag be false. Otherwise, let it be true.
+ if (linePosition[linePosition.length() - 1] == '%') {
+ if (number < 0 || number > 100)
+ break;
+
+ // 10 - If '%' then set snap-to-lines flag to false.
+ m_snapToLines = false;
+ }
+
+ m_linePosition = number;
+ }
+ break;
+ case Position:
+ {
+ // 1. If value contains any characters other than U+0025 PERCENT SIGN characters (%) and characters in the range
+ // U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then jump to the step labeled next setting.
+ // 2. If value does not contain at least one character in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9),
+ // then jump to the step labeled next setting.
+ String textPosition = WebVTTParser::collectDigits(input, &position);
+ if (textPosition.isEmpty())
+ break;
+ if (position >= input.length())
+ break;
+
+ // 3. If any character in value other than the last character is a U+0025 PERCENT SIGN character (%), then jump
+ // to the step labeled next setting.
+ // 4. If the last character in value is not a U+0025 PERCENT SIGN character (%), then jump to the step labeled
+ // next setting.
+ if (input[position++] != '%')
+ break;
+ if (position < input.length() && !WebVTTParser::isValidSettingDelimiter(input[position]))
+ break;
+
+ // 5. Ignoring the trailing percent sign, interpret value as an integer, and let number be that number.
+ // 6. If number is not in the range 0 ≤ number ≤ 100, then jump to the step labeled next setting.
+ // NOTE: toInt ignores trailing non-digit characters, such as '%'.
+ bool validNumber;
+ int number = textPosition.toInt(&validNumber);
+ if (!validNumber)
+ break;
+ if (number < 0 || number > 100)
+ break;
+
+ // 7. Let cue's text track cue text position be number.
+ m_textPosition = number;
+ }
+ break;
+ case Size:
+ {
+ // 1. If value contains any characters other than U+0025 PERCENT SIGN characters (%) and characters in the
+ // range U+0030 DIGIT ZERO (0) to U+0039 DIGIT NINE (9), then jump to the step labeled next setting.
+ // 2. If value does not contain at least one character in the range U+0030 DIGIT ZERO (0) to U+0039 DIGIT
+ // NINE (9), then jump to the step labeled next setting.
+ String cueSize = WebVTTParser::collectDigits(input, &position);
+ if (cueSize.isEmpty())
+ break;
+ if (position >= input.length())
+ break;
+
+ // 3. If any character in value other than the last character is a U+0025 PERCENT SIGN character (%),
+ // then jump to the step labeled next setting.
+ // 4. If the last character in value is not a U+0025 PERCENT SIGN character (%), then jump to the step
+ // labeled next setting.
+ if (input[position++] != '%')
+ break;
+ if (position < input.length() && !WebVTTParser::isValidSettingDelimiter(input[position]))
+ break;
+
+ // 5. Ignoring the trailing percent sign, interpret value as an integer, and let number be that number.
+ // 6. If number is not in the range 0 ≤ number ≤ 100, then jump to the step labeled next setting.
+ bool validNumber;
+ int number = cueSize.toInt(&validNumber);
+ if (!validNumber)
+ break;
+ if (number < 0 || number > 100)
+ break;
+
+ // 7. Let cue's text track cue size be number.
+ m_cueSize = number;
+ }
+ break;
+ case Align:
+ {
+ String cueAlignment = WebVTTParser::collectWord(input, &position);
+
+ // 1. If value is a case-sensitive match for the string "start", then let cue's text track cue alignment be start alignment.
+ if (cueAlignment == startKeyword())
+ m_cueAlignment = Start;
+
+ // 2. If value is a case-sensitive match for the string "middle", then let cue's text track cue alignment be middle alignment.
+ else if (cueAlignment == middleKeyword())
+ m_cueAlignment = Middle;
+
+ // 3. If value is a case-sensitive match for the string "end", then let cue's text track cue alignment be end alignment.
+ else if (cueAlignment == endKeyword())
+ m_cueAlignment = End;
+ }
+ break;
+#if ENABLE(WEBVTT_REGIONS)
+ case RegionId:
+ m_regionId = WebVTTParser::collectWord(input, &position);
+ break;
+#endif
+ case None:
+ break;
+ }
+
+NextSetting:
+ position = endOfSetting;
+ }
+#if ENABLE(WEBVTT_REGIONS)
+ // If cue's line position is not auto or cue's size is not 100 or cue's
+ // writing direction is not horizontal, but cue's region identifier is not
+ // the empty string, let cue's region identifier be the empty string.
+ if (m_regionId.isEmpty())
+ return;
+
+ if (m_linePosition != undefinedPosition || m_cueSize != 100 || m_writingDirection != Horizontal)
+ m_regionId = emptyString();
+#endif
+}
+
+CSSValueID TextTrackCue::getCSSWritingDirection() const
+{
+ return m_displayDirection;
+}
+
+CSSValueID TextTrackCue::getCSSWritingMode() const
+{
+ return m_displayWritingMode;
+}
+
+int TextTrackCue::getCSSSize() const
+{
+ return m_displaySize;
+}
+
+std::pair<double, double> TextTrackCue::getCSSPosition() const
+{
+ if (!m_snapToLines)
+ return getPositionCoordinates();
+
+ return m_displayPosition;
+}
+
+bool TextTrackCue::isEqual(const TextTrackCue& cue, CueMatchRules match) const
+{
+ if (cueType() != cue.cueType())
+ return false;
+
+ if (match != IgnoreDuration && m_endTime != cue.endTime())
+ return false;
+ if (m_startTime != cue.startTime())
+ return false;
+ if (m_content != cue.text())
+ return false;
+ if (m_settings != cue.cueSettings())
+ return false;
+ if (m_id != cue.id())
+ return false;
+ if (m_textPosition != cue.position())
+ return false;
+ if (m_linePosition != cue.line())
+ return false;
+ if (m_cueSize != cue.size())
+ return false;
+ if (align() != cue.align())
return false;
return true;
}
+bool TextTrackCue::isOrderedBefore(const TextTrackCue* other) const
+{
+ return startTime() < other->startTime() || (startTime() == other->startTime() && endTime() > other->endTime());
+}
+
+void TextTrackCue::setFontSize(int fontSize, const IntSize&, bool important)
+{
+ if (!hasDisplayTree() || !fontSize)
+ return;
+
+ LOG(Media, "TextTrackCue::setFontSize - setting cue font size to %i", fontSize);
+
+ displayTreeInternal()->setInlineStyleProperty(CSSPropertyFontSize, fontSize, CSSPrimitiveValue::CSS_PX, important);
+}
+
} // namespace WebCore
#endif