WebVTT: Support 'auto' text position

Source/core/html/track/vtt/VTTCue.cpp

 /*
  * Copyright (c) 2013, Opera Software ASA. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 14 matching lines @@
  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  * OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "config.h"
 #include "core/html/track/vtt/VTTCue.h"
 
 #include "bindings/core/v8/ExceptionMessages.h"
 #include "bindings/core/v8/ExceptionStatePlaceholder.h"
+#include "bindings/core/v8/UnionTypesCore.h"
 #include "core/CSSPropertyNames.h"
 #include "core/CSSValueKeywords.h"
 #include "core/dom/DocumentFragment.h"
 #include "core/dom/NodeTraversal.h"
 #include "core/events/Event.h"
 #include "core/frame/UseCounter.h"
 #include "core/html/HTMLDivElement.h"
 #include "core/html/track/TextTrack.h"
 #include "core/html/track/TextTrackCueList.h"
 #include "core/html/track/vtt/VTTElement.h"
 #include "core/html/track/vtt/VTTParser.h"
 #include "core/html/track/vtt/VTTRegionList.h"
 #include "core/html/track/vtt/VTTScanner.h"
 #include "core/rendering/RenderVTTCue.h"
+#include "platform/FloatConversion.h"
 #include "platform/RuntimeEnabledFeatures.h"
 #include "platform/text/BidiResolver.h"
 #include "platform/text/TextRunIterator.h"
 #include "wtf/MathExtras.h"
 #include "wtf/text/StringBuilder.h"
 
 namespace blink {
 
+static const float autoPosition = -1;
 static const int undefinedPosition = -1;
 static const int undefinedSize = -1;
 
 static const CSSValueID displayWritingModeMap[] = {
     CSSValueHorizontalTb, CSSValueVerticalRl, CSSValueVerticalLr
 };
 static_assert(WTF_ARRAY_LENGTH(displayWritingModeMap) == VTTCue::NumberOfWritingDirections,
     "displayWritingModeMap should have the same number of elements as VTTCue::NumberOfWritingDirections");
 
 static const CSSValueID displayAlignmentMap[] = {
     CSSValueStart, CSSValueCenter, CSSValueEnd, CSSValueLeft, CSSValueRight
 };
 static_assert(WTF_ARRAY_LENGTH(displayAlignmentMap) == VTTCue::NumberOfAlignments,
     "displayAlignmentMap should have the same number of elements as VTTCue::NumberOfAlignments");
 
+static const String& autoKeyword()
+{
+    DEFINE_STATIC_LOCAL(const String, autoString, ("auto"));
+    return autoString;
+}
+
 static const String& startKeyword()
 {
     DEFINE_STATIC_LOCAL(const String, start, ("start"));
     return start;
 }
 
 static const String& middleKeyword()
 {
     DEFINE_STATIC_LOCAL(const String, middle, ("middle"));
     return middle;
@@ skipping 27 matching lines @@
     DEFINE_STATIC_LOCAL(const String, verticalrl, ("rl"));
     return verticalrl;
 }
 
 static const String& verticalGrowingRightKeyword()
 {
     DEFINE_STATIC_LOCAL(const String, verticallr, ("lr"));
     return verticallr;
 }
 
-static bool isInvalidPercentage(int value, ExceptionState& exceptionState)
+template<typename NumberType>
+static bool isInvalidPercentage(NumberType value, ExceptionState& exceptionState)
 {
     if (value < 0 || value > 100) {
-        exceptionState.throwDOMException(IndexSizeError, ExceptionMessages::indexOutsideRange("value", value, 0, ExceptionMessages::InclusiveBound, 100, ExceptionMessages::InclusiveBound));
+        exceptionState.throwDOMException(IndexSizeError, ExceptionMessages::indexOutsideRange<NumberType>("value", value, 0, ExceptionMessages::InclusiveBound, 100, ExceptionMessages::InclusiveBound));
         return true;
     }
     return false;
 }
 
 VTTCueBox::VTTCueBox(Document& document, VTTCue* cue)
     : HTMLDivElement(document)
     , m_cue(cue)
 {
     setShadowPseudoId(AtomicString("-webkit-media-text-track-display", AtomicString::ConstructFromLiteral));
@@ skipping 71 matching lines @@
 {
     visitor->trace(m_cue);
     HTMLDivElement::trace(visitor);
 }
 
 VTTCue::VTTCue(Document& document, double startTime, double endTime, const String& text)
     : TextTrackCue(startTime, endTime)
     , m_text(text)
     , m_linePosition(undefinedPosition)
     , m_computedLinePosition(undefinedPosition)
-    , m_textPosition(50)
+    , m_textPosition(autoPosition)
     , m_cueSize(100)
     , m_writingDirection(Horizontal)
     , m_cueAlignment(Middle)
     , m_vttNodeTree(nullptr)
     , m_cueBackgroundBox(HTMLDivElement::create(document))
     , m_displayDirection(CSSValueLtr)
     , m_displaySize(undefinedSize)
     , m_snapToLines(true)
     , m_displayTreeShouldChange(true)
     , m_notifyRegion(true)
@@ skipping 92 matching lines @@
     // Otherwise, set the text track cue line position to the new value.
     if (m_linePosition == position)
         return;
 
     cueWillChange();
     m_linePosition = position;
     m_computedLinePosition = calculateComputedLinePosition();
     cueDidChange();
 }
 
-void VTTCue::setPosition(int position, ExceptionState& exceptionState)
+bool VTTCue::textPositionIsAuto() const
 {
-    // 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 (isInvalidPercentage(position, exceptionState))
-        return;
+    return m_textPosition == autoPosition;
+}
+
+void VTTCue::position(DoubleOrString& result) const
+{
+    if (textPositionIsAuto())
+        result.setString(autoKeyword());
+    else
+        result.setDouble(m_textPosition);
+}
+
+void VTTCue::setPosition(const DoubleOrString& position, ExceptionState& exceptionState)
+{
+    float specifiedPosition = autoPosition;
+    if (position.isString()) {
+        // FIXME: Would be handled by bindings if the union had AutoKeyword and not DOMString.
+        if (position.getAsString() != autoKeyword())

[philipj_slow, 2015/01/15 09:08:57]

This should throw a TypeError, or whatever cue.align='bah' would throw.

[fs, 2015/01/15 10:07:16]

No, assigning an "invalid" enum value to an attribute does not throw (using it
as an argument does though.)

https://heycam.github.io/webidl/#dfn-enumeration-value (the Note)

[philipj_slow, 2015/01/19 14:44:26]

Acknowledged.

[fs, 2015/01/19 18:10:40]

Actually, now I'm not so sure anymore... [1] (step 4) seems to special case
enumerations ("If the type of the attribute is an enumeration"), but not unions
(with enumerations)...

So:

attribute Foo bar; // Does not throw
attribute (double or Foo) baz; // Throws

I think I'll just go with whatever the impl. thinks is god for now...

[1] http://heycam.github.io/webidl/#dfn-attribute-setter

+            return;
+    } else {
+        ASSERT(position.isDouble());
+        double doublePosition = position.getAsDouble();
+
+        // http://www.whatwg.org/specs/web-apps/current-work/multipage/the-video-element.html#dom-texttrackcue-position

[philipj_slow, 2015/01/15 09:08:57]

Broken link, should be http://dev.w3.org/html5/webvtt/#dfn-vttcue-position
Maybe put the spec text at the top of the function?

+        // 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 (isInvalidPercentage(doublePosition, exceptionState))
+            return;
+
+        specifiedPosition = narrowPrecisionToFloat(doublePosition);
+    }
 
     // Otherwise, set the text track cue line position to the new value.
-    if (m_textPosition == position)
+    if (m_textPosition == specifiedPosition)
         return;
 
     cueWillChange();
-    m_textPosition = position;
+    m_textPosition = specifiedPosition;
     cueDidChange();
 }
 
 void VTTCue::setSize(int size, ExceptionState& exceptionState)
 {
     // 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 (isInvalidPercentage(size, exceptionState))
         return;
@@ skipping 196 matching lines @@
                 node = NodeTraversal::nextSkippingChildren(*node);
                 continue;
             }
         }
 
         node = NodeTraversal::next(*node);
     }
     return isLeftToRightDirection(textDirection) ? CSSValueLtr : CSSValueRtl;
 }
 
+int VTTCue::calculateComputedTextPosition() const
+{
+    // http://dev.w3.org/html5/webvtt/#dfn-text-track-cue-computed-text-position
+
+    // 1. If the text track cue text position is numeric, then return the value
+    // of the text track cue text position and abort these steps. (Otherwise,
+    // the text track cue text position is the special value auto.)
+    if (!textPositionIsAuto())
+        return static_cast<int>(m_textPosition);

[philipj_slow, 2015/01/15 09:08:57]

Per spec there is no rounding of position to integer, just line in the
snap-to-lines case. I think it would be best to let the floats flow all the way
in this change, people would be justified in assuming that
'(cue.position=0.5)==0.5' implies that the layout also gets the float.

[fs, 2015/01/15 10:07:16]

I was trying to avoid "two steps at once" here by keeping the layout change as
small as possible. With the split, that's probably less of an issue though.

[philipj_slow, 2015/01/19 14:44:26]

As long as the whole change ends up in the same milestone so that the feature
detection works I'm OK with splitting across CLs as you see fit.

[fs, 2015/01/19 15:09:05]

Yes, that should be feasible. I'm currently looking at landing this as:

1) long->double
2) Update VTTCue.line
3) Update VTTCue.position

So still 2 CLs to go before returning to this one.

+
+    switch (m_cueAlignment) {
+    // 2. If the text track cue text alignment is start or left, return 0 and abort these steps.
+    case Start:
+    case Left:
+        return 0;
+    // 3. If the text track cue text alignment is end or right, return 100 and abort these steps.
+    case End:
+    case Right:
+        return 100;
+    // 4. If the text track cue text alignment is middle, return 50 and abort these steps.
+    case Middle:
+        return 50;
+    default:
+        ASSERT_NOT_REACHED();
+        return 0;
+    }
+}
+
 void VTTCue::calculateDisplayParameters()
 {
     createVTTNodeTree();
 
     // Steps 10.2, 10.3
     m_displayDirection = determineTextDirection(m_vttNodeTree.get());
 
     if (m_displayDirection == CSSValueRtl)
         UseCounter::count(document(), UseCounter::VTTCueRenderRtl);
 
     // 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'.
 
     // The above step is done through the writing direction static map.
 
     // 10.5 Determine the value of maximum size for cue as per the appropriate
     // rules from the following list:
-    int maximumSize = m_textPosition;
+    int computedTextPosition = calculateComputedTextPosition();
+    int maximumSize = computedTextPosition;
     if ((m_writingDirection == Horizontal && m_cueAlignment == Start && m_displayDirection == CSSValueLtr)
         || (m_writingDirection == Horizontal && m_cueAlignment == End && m_displayDirection == CSSValueRtl)
         || (m_writingDirection == Horizontal && m_cueAlignment == Left)
         || (m_writingDirection == VerticalGrowingLeft && (m_cueAlignment == Start || m_cueAlignment == Left))
         || (m_writingDirection == VerticalGrowingRight && (m_cueAlignment == Start || m_cueAlignment == Left))) {
-        maximumSize = 100 - m_textPosition;
+        maximumSize = 100 - computedTextPosition;
     } else if ((m_writingDirection == Horizontal && m_cueAlignment == End && m_displayDirection == CSSValueLtr)
         || (m_writingDirection == Horizontal && m_cueAlignment == Start && m_displayDirection == CSSValueRtl)
         || (m_writingDirection == Horizontal && m_cueAlignment == Right)
         || (m_writingDirection == VerticalGrowingLeft && (m_cueAlignment == End || m_cueAlignment == Right))
         || (m_writingDirection == VerticalGrowingRight && (m_cueAlignment == End || m_cueAlignment == Right))) {
-        maximumSize = m_textPosition;
+        maximumSize = computedTextPosition;
     } else if (m_cueAlignment == Middle) {
-        maximumSize = m_textPosition <= 50 ? m_textPosition : (100 - m_textPosition);
+        maximumSize = computedTextPosition <= 50 ? computedTextPosition : (100 - computedTextPosition);
         maximumSize = maximumSize * 2;
     } else {
         ASSERT_NOT_REACHED();
     }
 
     // 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);
 
     // FIXME: Understand why step 10.7 is missing (just a copy/paste error?)
     // Could be done within a spec implementation check - http://crbug.com/301580
 
     // 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) {
         switch (m_cueAlignment) {
         case Start:
             if (m_displayDirection == CSSValueLtr)
-                m_displayPosition.first = m_textPosition;
+                m_displayPosition.first = computedTextPosition;
             else
-                m_displayPosition.first = 100 - m_textPosition - m_displaySize;
+                m_displayPosition.first = 100 - computedTextPosition - m_displaySize;
             break;
         case End:
             if (m_displayDirection == CSSValueRtl)
-                m_displayPosition.first = 100 - m_textPosition;
+                m_displayPosition.first = 100 - computedTextPosition;
             else
-                m_displayPosition.first = m_textPosition - m_displaySize;
+                m_displayPosition.first = computedTextPosition - m_displaySize;
             break;
         case Left:
             if (m_displayDirection == CSSValueLtr)
-                m_displayPosition.first = m_textPosition;
+                m_displayPosition.first = computedTextPosition;
             else
-                m_displayPosition.first = 100 - m_textPosition;
+                m_displayPosition.first = 100 - computedTextPosition;
             break;
         case Right:
             if (m_displayDirection == CSSValueLtr)
-                m_displayPosition.first = m_textPosition - m_displaySize;
+                m_displayPosition.first = computedTextPosition - m_displaySize;
             else
-                m_displayPosition.first = 100 - m_textPosition - m_displaySize;
+                m_displayPosition.first = 100 - computedTextPosition - m_displaySize;
             break;
         case Middle:
             if (m_displayDirection == CSSValueLtr)
-                m_displayPosition.first = m_textPosition - m_displaySize / 2;
+                m_displayPosition.first = computedTextPosition - m_displaySize / 2;
             else
-                m_displayPosition.first = 100 - m_textPosition - m_displaySize / 2;
+                m_displayPosition.first = 100 - computedTextPosition - m_displaySize / 2;
             break;
         default:
             ASSERT_NOT_REACHED();
         }
     } else {
         // Cases for m_writingDirection being VerticalGrowing{Left|Right}
         switch (m_cueAlignment) {
         case Start:
         case Left:
-            m_displayPosition.second = m_textPosition;
+            m_displayPosition.second = computedTextPosition;
             break;
         case End:
         case Right:
-            m_displayPosition.second = m_textPosition - m_displaySize;
+            m_displayPosition.second = computedTextPosition - m_displaySize;
             break;
         case Middle:
-            m_displayPosition.second = m_textPosition - m_displaySize / 2;
+            m_displayPosition.second = computedTextPosition - m_displaySize / 2;
             break;
         default:
             ASSERT_NOT_REACHED();
         }
     }
 
     // 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();
 
@@ skipping 122 matching lines @@
 
     if (m_writingDirection != Horizontal)
         UseCounter::count(document(), UseCounter::VTTCueRenderVertical);
 
     if (!m_snapToLines)
         UseCounter::count(document(), UseCounter::VTTCueRenderSnapToLinesFalse);
 
     if (m_linePosition != undefinedPosition)
         UseCounter::count(document(), UseCounter::VTTCueRenderLineNotAuto);
 
-    if (m_textPosition != 50)
+    if (textPositionIsAuto())

[fs, 2015/01/14 13:13:40]

Changed this on the assumption that we want to check the default value (which
means this is slightly more narrow than the previous one.)

[philipj_slow, 2015/01/15 09:08:57]

Yeah. Too bad the name will suck, but oh well.

         UseCounter::count(document(), UseCounter::VTTCueRenderPositionNot50);
 
     if (m_cueSize != 100)
         UseCounter::count(document(), UseCounter::VTTCueRenderSizeNot100);
 
     if (m_cueAlignment != Middle)
         UseCounter::count(document(), UseCounter::VTTCueRenderAlignNotMiddle);
 
     RefPtrWillBeRawPtr<VTTCueBox> displayBox = getDisplayTree(videoSize);
     VTTRegion* region = 0;
@@ skipping 18 matching lines @@
             container.appendChild(regionNode);
 
         region->appendVTTCueBox(displayBox);
     }
 }
 
 std::pair<double, double> VTTCue::getPositionCoordinates() const
 {
     // This method is used for setting x and y when snap to lines is not set.
     std::pair<double, double> coordinates;
+    int computedTextPosition = calculateComputedTextPosition();
 
     if (m_writingDirection == Horizontal && m_displayDirection == CSSValueLtr) {
-        coordinates.first = m_textPosition;
+        coordinates.first = computedTextPosition;
         coordinates.second = m_computedLinePosition;
 
         return coordinates;
     }
 
     if (m_writingDirection == Horizontal && m_displayDirection == CSSValueRtl) {
-        coordinates.first = 100 - m_textPosition;
+        coordinates.first = 100 - computedTextPosition;
         coordinates.second = m_computedLinePosition;
 
         return coordinates;
     }
 
     if (m_writingDirection == VerticalGrowingLeft) {
         coordinates.first = 100 - m_computedLinePosition;
-        coordinates.second = m_textPosition;
+        coordinates.second = computedTextPosition;
 
         return coordinates;
     }
 
     if (m_writingDirection == VerticalGrowingRight) {
         coordinates.first = m_computedLinePosition;
-        coordinates.second = m_textPosition;
+        coordinates.second = computedTextPosition;
 
         return coordinates;
     }
 
     ASSERT_NOT_REACHED();
 
     return coordinates;
 }
 
 VTTCue::CueSetting VTTCue::settingName(VTTScanner& input)
@@ skipping 235 matching lines @@
 
 void VTTCue::trace(Visitor* visitor)
 {
     visitor->trace(m_vttNodeTree);
     visitor->trace(m_cueBackgroundBox);
     visitor->trace(m_displayTree);
     TextTrackCue::trace(visitor);
 }
 
 } // namespace blink