DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (c68fe15a81fc)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
<!DOCTYPE HTML>
<html>
<head>
  <title>Test for Bug 833386 - HTMLTrackElement</title>
  <script src="/tests/SimpleTest/SimpleTest.js"></script>
  <script type="text/javascript" src="manifest.js"></script>
  <link rel="stylesheet" type="text/css" href="/tests/SimpleTest/test.css"/>
</head>
<body>
<video id="v" src="seek.webm" preload="metadata">
  <track src="basic.vtt" kind="subtitles" id="default" default>
</video>
<script type="text/javascript">
/**
 * This test is used to test the VTTCue's different behaviors and check whether
 * cues would be activatived correctly during video playback.
 */
var video = document.getElementById("v");
var trackElement = document.getElementById("default");

async function runTest() {
  await waitUntiTrackLoaded();
  checkCueDefinition();
  checkFirstCueParsedContent();
  checkCueStartTimeAndEndtime();
  checkCueSizeAndPosition();
  checkCueSnapToLines();
  checkCueAlignmentAndWritingDirection();
  checkCueLine();
  checkCreatingNewCue();
  checkRemoveNonExistCue();
  checkActiveCues();
  checkCueRegion();
  await checkCActiveCuesDuringVideoPlaying();
  SimpleTest.finish();
}

SimpleTest.waitForExplicitFinish();
SpecialPowers.pushPrefEnv({"set": [["media.webvtt.regions.enabled", true]]},
                            runTest);
/**
 * The following are test helper functions.
 */
async function waitUntiTrackLoaded() {
  if (trackElement.readyState != 2) {
    info(`wait until the track finishes loading`);
    await once(trackElement, "load");
  }
  is(trackElement.readyState, 2, "Track::ReadyState should be set to LOADED.");
  is(trackElement.track.cues.length, 6, "Cue list length should be 6.");
}

function checkCueDefinition() {
  // Check that the typedef of TextTrackCue works in Gecko.
  isnot(window.TextTrackCue, undefined, "TextTrackCue should be defined.");
  isnot(window.VTTCue, undefined, "VTTCue should be defined.");
}

function checkFirstCueParsedContent() {
  // Check if first cue was parsed correctly.
  const cue = trackElement.track.cues[0];
  ok(cue instanceof TextTrackCue, "Cue should be an instanceof TextTrackCue.");
  ok(cue instanceof VTTCue, "Cue should be an instanceof VTTCue.");
  is(cue.id, "1", "Cue's ID should be 1.");
  is(cue.startTime, 0.5, "Cue's start time should be 0.5.");
  is(cue.endTime, 0.7, "Cue's end time should be 0.7.");
  is(cue.pauseOnExit, false, "Cue's pause on exit flag should be false.");
  is(cue.text, "This", "Cue's text should be set correctly.");
  is(cue.track, trackElement.track, "Cue's track should be defined.");
  cue.track = null;
  isnot(cue.track, null, "Cue's track should not be able to be set.");
}

function checkCueStartTimeAndEndtime() {
  const cueList = trackElement.track.cues;
  // Check that all cue times were not rounded
  is(cueList[1].startTime, 1.2, "Second cue's start time should be 1.2.");
  is(cueList[1].endTime, 2.4, "Second cue's end time should be 2.4.");
  is(cueList[2].startTime, 2, "Third cue's start time should be 2.");
  is(cueList[2].endTime, 3.5, "Third cue's end time should be 3.5.");
  is(cueList[3].startTime, 2.71, "Fourth cue's start time should be 2.71.");
  is(cueList[3].endTime, 2.91, "Fourth cue's end time should be 2.91.");
  is(cueList[4].startTime, 3.217, "Fifth cue's start time should be 3.217.");
  is(cueList[4].endTime, 3.989, "Fifth cue's end time should be 3.989.");
  is(cueList[5].startTime, 3.217, "Sixth cue's start time should be 3.217.");
  is(cueList[5].endTime, 3.989, "Sixth cue's end time should be 3.989.");

  // Check that Cue setters are working correctly.
  const cue = trackElement.track.cues[0];
  cue.id = "Cue 01";
  is(cue.id, "Cue 01", "Cue's ID should be 'Cue 01'.");
  cue.startTime = 0.51;
  is(cue.startTime, 0.51, "Cue's start time should be 0.51.");
  cue.endTime = 0.71;
  is(cue.endTime, 0.71, "Cue's end time should be 0.71.");
  cue.pauseOnExit = true;
  is(cue.pauseOnExit, true, "Cue's pause on exit flag should be true.");
  video.addEventListener("pause", function() {
    video.play();
  }, {once: true});
}

function checkCueSizeAndPosition() {
  function checkPercentageValue(prop, initialVal) {
    ok(prop in cue, prop + " should be a property on VTTCue.");
    cue[prop] = initialVal;
    is(cue[prop], initialVal, `Cue's ${prop} should initially be ${initialVal}`);
    [ 101, -1 ].forEach(function(val) {
      let exceptionHappened = false;
      try {
        cue[prop] = val;
      } catch(e) {
        exceptionHappened = true;
        is(e.name, "IndexSizeError", "Should have thrown IndexSizeError.");
      }
      ok(exceptionHappened, "Exception should have happened.");
    });
  }

  const cue = trackElement.track.cues[0];
  checkPercentageValue("size", 100.0);
  cue.size = 50.5;
  is(cue.size, 50.5, "Cue's size should be 50.5.")

  // Check cue.position
  checkPercentageValue("position", "auto");
  cue.position = 50.5;
  is(cue.position, 50.5, "Cue's position value should now be 50.5.");
}

function checkCueSnapToLines() {
  const cue = trackElement.track.cues[0];
  ok(cue.snapToLines, "Cue's snapToLines should be set by set.");
  cue.snapToLines = false;
  ok(!cue.snapToLines, "Cue's snapToLines should not be set.");
}

function checkCueAlignmentAndWritingDirection() {
  function checkEnumValue(prop, initialVal, acceptedValues) {
    ok(prop in cue, `${prop} should be a property on VTTCue.`);
    is(cue[prop], initialVal, `Cue's ${prop} should be ${initialVal}`);
    cue[prop] = "bogus";
    is(cue[prop], initialVal, `Cue's ${prop} should be ${initialVal}`);
    acceptedValues.forEach(function(val) {
      cue[prop] = val;
      is(cue[prop], val, `Cue's ${prop} should be ${val}`);
      if (typeof val === "string") {
        cue[prop] = val.toUpperCase();
        is(cue[prop], val, `Cue's ${prop} should be ${val}`);
      }
    });
  }

  const cue = trackElement.track.cues[0];
  checkEnumValue("align", "center", [ "start", "left", "center", "right", "end" ]);
  checkEnumValue("lineAlign", "start", [ "start", "center", "end" ]);
  checkEnumValue("vertical", "", [ "", "lr", "rl" ]);

  cue.lineAlign = "center";
  is(cue.lineAlign, "center", "Cue's line align should be center.");
  cue.lineAlign = "START";
  is(cue.lineAlign, "center", "Cue's line align should be center.");
  cue.lineAlign = "end";
  is(cue.lineAlign, "end", "Cue's line align should be end.");

  // Check that cue position align works properly
  is(cue.positionAlign, "auto", "Cue's default position alignment should be auto.");

  cue.positionAlign = "line-left";
  is(cue.positionAlign, "line-left", "Cue's position align should be line-left.");
  cue.positionAlign = "auto";
  is(cue.positionAlign, "auto", "Cue's position align should be auto.");
  cue.positionAlign = "line-right";
  is(cue.positionAlign, "line-right", "Cue's position align should be line-right.");
}

function checkCueLine() {
  const cue = trackElement.track.cues[0];
  // Check cue.line
  is(cue.line, "auto", "Cue's line value should initially be auto.");
  cue.line = 0.5;
  is(cue.line, 0.5, "Cue's line value should now be 0.5.");
  cue.line = "auto";
  is(cue.line, "auto", "Cue's line value should now be auto.");
}

function checkCreatingNewCue() {
  const cueList = trackElement.track.cues;

  // Check that we can create and add new VTTCues
  let vttCue = new VTTCue(3.999, 4, "foo");
  is(vttCue.track, null, "Cue's track should be null.");
  trackElement.track.addCue(vttCue);
  is(vttCue.track, trackElement.track, "Cue's track should be defined.");
  is(cueList.length, 7, "Cue list length should now be 7.");

  // Check that new VTTCue was added correctly
  let cue = cueList[6];
  is(cue.startTime, 3.999, "Cue's start time should be 3.999.");
  is(cue.endTime, 4, "Cue's end time should be 4.");
  is(cue.text, "foo", "Cue's text should be foo.");

  // Adding the same cue again should not increase the cue count.
  trackElement.track.addCue(vttCue);
  is(cueList.length, 7, "Cue list length should be 7.");

  // Check that we are able to remove cues.
  trackElement.track.removeCue(cue);
  is(cueList.length, 6, "Cue list length should be 6.");
}

function checkRemoveNonExistCue() {
  is(trackElement.track.cues.length, 6, "Cue list length should be 6.");
  let exceptionHappened = false;
  try {
    // We should not be able to remove a cue that is not in the list.
    trackElement.track.removeCue(new VTTCue(1, 2, "foo"));
  } catch (e) {
    // "NotFoundError" should be thrown when trying to remove a cue that is
    // not in the list.
    is(e.name, "NotFoundError", "Should have thrown NotFoundError.");
    exceptionHappened = true;
  }
  // If this is false then we did not throw an error and probably removed a cue
  // when we shouln't have.
  ok(exceptionHappened, "Exception should have happened.");
  is(trackElement.track.cues.length, 6, "Cue list length should still be 6.");
}

function checkActiveCues() {
  video.currentTime = 2;
  isnot(trackElement.track.activeCues, null);

  trackElement.track.mode = "disabled";
  is(trackElement.track.activeCues, null, "No active cue when track is disabled.");
  trackElement.track.mode = "showing";
}

function checkCueRegion() {
  let regionInfo = [
    { lines: 2, width: 30 },
    { lines: 4, width: 20 },
    { lines: 2, width: 30 }
  ];

  for (let i = 0; i < regionInfo.length; i++) {
    let cue = trackElement.track.cues[i];
    isnot(cue.region, null, `Cue at ${i} should have a region.`);
    for (let key in regionInfo[i]) {
      is(cue.region[key], regionInfo[i][key],
         `Region should have a ${key} property with a value of ${regionInfo[i][key]}`);
    }
  }
}

async function checkCActiveCuesDuringVideoPlaying() {
  // Test TextTrack::ActiveCues.
  let cueInfo = [
    { startTime: 0.51, endTime: 0.71, ids: ["Cue 01"] },
    { startTime: 0.72, endTime: 1.19, ids: [] },
    { startTime: 1.2, endTime: 1.9, ids: [2] },
    { startTime: 2, endTime: 2.4, ids: [2, 2.5] },
    { startTime: 2.41, endTime: 2.70, ids: [2.5] },
    { startTime: 2.71, endTime: 2.91, ids: [2.5, 3] },
    { startTime: 2.92, endTime: 3.216, ids: [2.5] },
    { startTime: 3.217, endTime: 3.5, ids: [2.5, 4, 5] },
    { startTime: 3.51, endTime: 3.989, ids: [4, 5] },
    { startTime: 3.99, endTime: 4, ids: [] }
  ];

  video.addEventListener("timeupdate", function() {
    let activeCues = trackElement.track.activeCues,
        playbackTime = video.currentTime;

    for (let i = 0; i < cueInfo.length; i++) {
      let cue = cueInfo[i];
      if (playbackTime >= cue.startTime && playbackTime < cue.endTime) {
        is(activeCues.length, cue.ids.length, `There should be ${cue.ids.length} currently active cue(s).`);
        for (let j = 0; j < cue.ids.length; j++) {
          isnot(activeCues.getCueById(cue.ids[j]), undefined,
                `The cue with ID ${cue.ids[j]} should be active.`);
        }
        break;
      }
    }
  });

  info(`start video from 0s.`);
  video.currentTime = 0;
  video.play();
  await once(video, "playing");
  info(`video starts playing.`);
  await once(video, "ended");
}

</script>
</body>
</html>