Add new lines in TTML cues with nested <br> tags (#584)

Sanborn Hilland · ismena · commit 396c5f6ad9bf · 2016-12-15T13:58:20.000-08:00
This modifies the fix from #572. Streams that also have <br> tags nested in <span> tags were getting missed by #572.
diff --git a/lib/media/ttml_text_parser.js b/lib/media/ttml_text_parser.js
@@ -193,15 +193,6 @@ shaka.media.TtmlTextParser.getLeafNodes_ = function(element) {
     return result;
 
   var childNodes = element.childNodes;
-  if (element.nodeName == 'p') {
-    // Replace <br> inside a <p> paragraph with a newline character.
-    // The <br> node is later on skipped
-    for (var j = 0; j < childNodes.length; j++) {
-      if (childNodes[j].nodeName == 'br' && j > 0) {
-        childNodes[j - 1].textContent += '\n';
-      }
-    }
-  }
   for (var i = 0; i < childNodes.length; i++) {
     // Currently we don't support styles applicable to span
     // elements, so they are ignored
@@ -228,6 +219,25 @@ shaka.media.TtmlTextParser.getLeafNodes_ = function(element) {
 };
 
 
+/**
+ * Insert \n where <br> tags are found
+ *
+ * @param {!Node} element
+ * @private
+ */
+shaka.media.TtmlTextParser.addNewLines_ = function(element) {
+  var childNodes = element.childNodes;
+
+  for (var i = 0; i < childNodes.length; i++) {
+    if (childNodes[i].nodeName == 'br' && i > 0) {
+      childNodes[i - 1].textContent += '\n';
+    } else if (childNodes[i].childNodes.length > 0) {
+      shaka.media.TtmlTextParser.addNewLines_(childNodes[i]);
+    }
+  }
+};
+
+
 /**
  * Parses an Element into a TextTrackCue or VTTCue.
  *
@@ -251,6 +261,8 @@ shaka.media.TtmlTextParser.parseCue_ = function(
       cueElement.textContent == '')
     return null;
 
+  shaka.media.TtmlTextParser.addNewLines_(cueElement);
+
   // Get time
   var start = shaka.media.TtmlTextParser.parseTime_(
       cueElement.getAttribute('begin'), rateInfo);
diff --git a/test/media/ttml_text_parser_unit.js b/test/media/ttml_text_parser_unit.js
@@ -386,13 +386,19 @@ describe('TtmlTextParser', function() {
         '</tt>');
   });
 
-  it('inserts a newline on br in a p block', function() {
+  it('inserts newline characters into <br> tags', function() {
     verifyHelper(
         [
           {start: 62.05, end: 3723.2, text: 'Line1\nLine2'}
         ],
         '<tt><body><p begin="01:02.05" ' +
         'end="01:02:03.200">Line1<br/>Line2</p></body></tt>');
+    verifyHelper(
+        [
+          {start: 62.05, end: 3723.2, text: 'Line1\nLine2'}
+        ],
+        '<tt><body><p begin="01:02.05" ' +
+        'end="01:02:03.200"><span>Line1<br/>Line2</span></p></body></tt>');
   });
 
   it('parses cue alignment from textAlign attribute', function() {
