Changeset 147355 in webkit

Timestamp:

Apr 1, 2013 1:10:48 PM (11 years ago)

Author:

vcarbune@chromium.org

Message:

TextTrackCue Extension for WebVTT Regions
​https://bugs.webkit.org/show_bug.cgi?id=109821

Reviewed by Eric Carlson.

Source/WebCore:

The TextTrackCue gets a new attribute and setting, regionId, which specifies
to which region the cue belongs to. The attribute is guarded by WEBVTT_REGIONS
and is by default disabled in ports.

Test: media/track/regions-webvtt/text-track-cue-region-attribute.html

• html/track/TextTrackCue.cpp:

(WebCore::TextTrackCue::TextTrackCue): Added member variable for the regionId attribute.
(WebCore):
(WebCore::TextTrackCue::setRegionId): Setter for the regionId attribute.
(WebCore::TextTrackCue::settingName): Added RegionId setting name.
(WebCore::TextTrackCue::setCueSettings): Parsed the "region:" cue setting.

• html/track/TextTrackCue.h:

(TextTrackCue):
(WebCore::TextTrackCue::regionId): Getter for the regionId attribute.

• html/track/TextTrackCue.idl: Updated to match the WebVTT Regions Extension.

LayoutTests:

• media/track/captions-webvtt/header-regions.vtt: Updated to include cues with

settings for which the "region:" setting should be ignored (for backwards compatibility
regarding WebVTT rendering rules).

• media/track/regions-webvtt/text-track-cue-region-attribute-expected.txt: Added.
• media/track/regions-webvtt/text-track-cue-region-attribute.html: Added.

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/media/track/captions-webvtt/header-regions.vtt (modified) (1 diff)
• LayoutTests/media/track/regions-webvtt/text-track-cue-region-attribute-expected.txt (added)
• LayoutTests/media/track/regions-webvtt/text-track-cue-region-attribute.html (added)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/html/track/TextTrackCue.cpp (modified) (5 diffs)
• Source/WebCore/html/track/TextTrackCue.h (modified) (4 diffs)
• Source/WebCore/html/track/TextTrackCue.idl (modified) (2 diffs)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2013-04-01  Victor Carbune  <vcarbune@chromium.org>
+
+        TextTrackCue Extension for WebVTT Regions
+        https://bugs.webkit.org/show_bug.cgi?id=109821
+
+        Reviewed by Eric Carlson.
+
+        * media/track/captions-webvtt/header-regions.vtt: Updated to include cues with
+        settings for which the "region:" setting should be ignored (for backwards compatibility
+        regarding WebVTT rendering rules).
+        * media/track/regions-webvtt/text-track-cue-region-attribute-expected.txt: Added.
+        * media/track/regions-webvtt/text-track-cue-region-attribute.html: Added.
+
 2013-04-01  Nate Chapin  <japhet@chromium.org>
 

trunk/LayoutTests/media/track/captions-webvtt/header-regions.vtt

@@ -9 +9 @@
 
 1
-00:00:00.000 --> 00:00:02.500
+00:00:00.000 --> 00:00:02.500 region:someregionattributeid
 We are in New York City
+
+2
+00:00:00.000 --> 00:00:02.500 line:5 region:ignored_attribute_value
+Line is specified, Region should be ignored.
+
+3
+00:00:00.000 --> 00:00:02.500 size:10% region:ignored_attribute_value
+Size is specified, Region should be ignored.
+
+4
+00:00:00.000 --> 00:00:02.500 vertical:lr region:ignored_attribute_value
+Vertical is specified, Region should be ignored.

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2013-04-01  Victor Carbune  <vcarbune@chromium.org>
+
+        TextTrackCue Extension for WebVTT Regions
+        https://bugs.webkit.org/show_bug.cgi?id=109821
+
+        Reviewed by Eric Carlson.
+
+        The TextTrackCue gets a new attribute and setting, regionId, which specifies
+        to which region the cue belongs to. The attribute is guarded by WEBVTT_REGIONS
+        and is by default disabled in ports.
+
+        Test: media/track/regions-webvtt/text-track-cue-region-attribute.html
+
+        * html/track/TextTrackCue.cpp:
+        (WebCore::TextTrackCue::TextTrackCue): Added member variable for the regionId attribute.
+        (WebCore):
+        (WebCore::TextTrackCue::setRegionId): Setter for the regionId attribute.
+        (WebCore::TextTrackCue::settingName): Added RegionId setting name.
+        (WebCore::TextTrackCue::setCueSettings): Parsed the "region:" cue setting.
+        * html/track/TextTrackCue.h:
+        (TextTrackCue):
+        (WebCore::TextTrackCue::regionId): Getter for the regionId attribute.
+        * html/track/TextTrackCue.idl: Updated to match the WebVTT Regions Extension.
+
 2013-03-05  Anders Carlsson  <andersca@apple.com>
 

trunk/Source/WebCore/html/track/TextTrackCue.cpp

@@ -535 +535 @@
 }
 
+#if ENABLE(WEBVTT_REGIONS)
+void TextTrackCue::setRegionId(const String& regionId)
+{
+    if (m_regionId == regionId)
+        return;
+
+    cueWillChange();
+    m_regionId = regionId;
+    cueDidChange();
+}
+#endif
+
 bool TextTrackCue::isActive()
 {
@@ -863 +875 @@
     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)
@@ -874 +889 @@
     else if (name == alignKeyword)
         return Align;
+#if ENABLE(WEBVTT_REGIONS)
+    else if (name == regionIdKeyword)
+        return RegionId;
+#endif
 
     return None;
@@ -1067 +1086 @@
             }
             break;
+#if ENABLE(WEBVTT_REGIONS)
+        case RegionId:
+            m_regionId = WebVTTParser::collectWord(input, &position);
+            break;
+#endif
         case None:
             break;
@@ -1074 +1098 @@
         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
 }
 

trunk/Source/WebCore/html/track/TextTrackCue.h

@@ -136 +136 @@
     virtual bool dispatchEvent(PassRefPtr<Event>) OVERRIDE;
 
+#if ENABLE(WEBVTT_REGIONS)
+    const String& regionId() const { return m_regionId; }
+    void setRegionId(const String&);
+#endif
+
     bool isActive();
     void setIsActive(bool);
@@ -205 +210 @@
 
 private:
+    void createWebVTTNodeTree();
+    void copyWebVTTNodeToDOMTree(ContainerNode* WebVTTNode, ContainerNode* root);
+
     std::pair<double, double> getPositionCoordinates() const;
     void parseSettings(const String&);
@@ -217 +225 @@
     virtual void derefEventTarget() { deref(); }
 
-    enum CueSetting { None, Vertical, Line, Position, Size, Align };
+    enum CueSetting {
+        None,
+        Vertical,
+        Line,
+        Position,
+        Size,
+        Align,
+#if ENABLE(WEBVTT_REGIONS)
+        RegionId
+#endif
+    };
     CueSetting settingName(const String&);
 
@@ -258 +276 @@
 
     std::pair<float, float> m_displayPosition;
-
-    void createWebVTTNodeTree();
-    void copyWebVTTNodeToDOMTree(ContainerNode* WebVTTNode, ContainerNode* root);
+#if ENABLE(WEBVTT_REGIONS)
+    String m_regionId;
+#endif
 };
 

trunk/Source/WebCore/html/track/TextTrackCue.idl

@@ -58 +58 @@
     attribute DOMString text;
     DocumentFragment getCueAsHTML();
-    
+
     attribute EventListener onenter;
     attribute EventListener onexit;
-    
+
     // EventTarget interface
     void addEventListener(in DOMString type, 
@@ -71 +71 @@
     boolean dispatchEvent(in Event evt)
         raises(EventException);
+
+#if defined(ENABLE_WEBVTT_REGIONS) && ENABLE_WEBVTT_REGIONS
+    attribute DOMString regionId;
+#endif
 };