Files
shaka-player/spec/vtt_text_parser_spec.js
T
Joey Parrish c934f426d8 Add new error type
This error type will be used for all internal errors, and will rely
on numeric error codes which can be easily checked by the application.

This also changes PSSH parsing to throw on errors instead of retaining
partial data.

Issue #201
b/25306826

Change-Id: I19d23d99d4ee72cb31fe5f233bac57a3a9cfc283
2015-12-04 10:26:08 -08:00

285 lines
8.7 KiB
JavaScript

/**
* @license
* Copyright 2015 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
goog.require('shaka.media.VttTextParser');
goog.require('shaka.util.Error');
goog.require('shaka.util.Uint8ArrayUtils');
describe('VttTextParser', function() {
var mockCue = false;
beforeAll(function() {
// Mock out VTTCue if not supported. These tests don't actually need
// VTTCue to do anything, this simply verifies the value of its members.
if (!window.VTTCue) {
mockCue = true;
window.VTTCue = function(start, end, text) {
this.startTime = start;
this.endTime = end;
this.text = text;
};
}
});
afterAll(function() {
// Delete our mock.
if (mockCue) {
delete window.VTTCue;
}
});
it('supports no cues', function() {
verifyHelper([], 'WEBVTT');
});
it('supports initial comments', function() {
verifyHelper([], 'WEBVTT - Comments');
});
it('supports comment blocks', function() {
verifyHelper([],
'WEBVTT\n\n' +
'NOTE\n' +
'This is a comment block');
});
it('supports comment blocks with inital comment', function() {
verifyHelper([],
'WEBVTT\n\n' +
'NOTE - A header comment\n' +
'This is a comment block');
});
it('supports cues with no settings', function() {
verifyHelper(
[
{start: 20, end: 40, text: 'Test', id: '1'},
{start: 40, end: 50, text: 'Test2', id: '2'}
],
'WEBVTT\n\n' +
'1\n' +
'00:00:20.000 --> 00:00:40.000\n' +
'Test\n\n' +
'2\n' +
'00:00:40.000 --> 00:00:50.000\n' +
'Test2');
});
it('supports cues with no ID', function() {
verifyHelper(
[
{start: 20, end: 40, text: 'Test'},
{start: 40, end: 50, text: 'Test2'}
],
'WEBVTT\n\n' +
'00:00:20.000 --> 00:00:40.000\n' +
'Test\n\n' +
'00:00:40.000 --> 00:00:50.000\n' +
'Test2');
});
it('supports comments within cues', function() {
verifyHelper(
[
{start: 20, end: 40, text: 'Test'},
{start: 40, end: 50, text: 'Test2'}
],
'WEBVTT\n\n' +
'00:00:20.000 --> 00:00:40.000\n' +
'Test\n\n' +
'NOTE\n' +
'This is a note\n\n' +
'00:00:40.000 --> 00:00:50.000\n' +
'Test2');
});
it('supports non-integer timecodes', function() {
verifyHelper(
[
{start: 20.1, end: 40.505, text: 'Test'}
],
'WEBVTT\n\n' +
'00:00:20.100 --> 00:00:40.505\n' +
'Test');
});
it('supports large timecodes', function() {
verifyHelper(
[
{start: 20, end: 108000, text: 'Test'}
],
'WEBVTT\n\n' +
'00:00:20.000 --> 30:00:00.000\n' +
'Test');
});
it('requires header', function() {
errorHelper(shaka.util.Error.Code.INVALID_TEXT_HEADER,
'');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_HEADER,
'00:00:00.000 --> 00:00:00.020\nTest');
});
it('invalid time values', function() {
errorHelper(shaka.util.Error.Code.INVALID_TEXT_CUE,
'WEBVTT\n\n00.020 --> 0:00.040\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_CUE,
'WEBVTT\n\n0:00.020 --> 0:00.040\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_CUE,
'WEBVTT\n\n00:00.20 --> 0:00.040\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_CUE,
'WEBVTT\n\n00:100.20 --> 0:00.040\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_CUE,
'WEBVTT\n\n00:00.020 --> 0:00.040\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_CUE,
'WEBVTT\n\n00:00:00:00.020 --> 0:00.040\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_CUE,
'WEBVTT\n\n00:61.020 --> 0:00.040\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_CUE,
'WEBVTT\n\n61:00.020 --> 0:00.040\nTest');
});
it('supports vertical setting', function() {
verifyHelper(
[
{start: 20, end: 40, text: 'Test', vertical: 'rl'},
{start: 40, end: 50, text: 'Test2', vertical: 'lr'}
],
'WEBVTT\n\n' +
'00:00:20.000 --> 00:00:40.000 vertical:rl\n' +
'Test\n\n' +
'00:00:40.000 --> 00:00:50.000 vertical:lr\n' +
'Test2');
});
it('supports line setting', function() {
verifyHelper(
[
{start: 20, end: 40, text: 'Test', line: 0},
{start: 40, end: 50, text: 'Test2', line: -1}
] ,
'WEBVTT\n\n' +
'00:00:20.000 --> 00:00:40.000 line:0\n' +
'Test\n\n' +
'00:00:40.000 --> 00:00:50.000 line:-1\n' +
'Test2');
});
it('supports position setting', function() {
verifyHelper(
[
{start: 20, end: 40, text: 'Test2', position: 45}
],
'WEBVTT\n\n' +
'00:00:20.000 --> 00:00:40.000 position:45%\n' +
'Test2');
});
it('supports size setting', function() {
verifyHelper(
[
{start: 20, end: 40, text: 'Test', size: 56}
],
'WEBVTT\n\n' +
'00:00:20.000 --> 00:00:40.000 size:56%\n' +
'Test');
});
it('supports align setting', function() {
verifyHelper(
[
{start: 20, end: 40, text: 'Test', align: 'middle'}
],
'WEBVTT\n\n' +
'00:00:20.000 --> 00:00:40.000 align:middle\n' +
'Test');
});
it('supports multiple settings', function() {
verifyHelper(
[
{
start: 20,
end: 40,
text: 'Test',
align: 'middle',
size: 56,
vertical: 'lr'
}
],
'WEBVTT\n\n' +
'00:00:20.000 --> 00:00:40.000 align:middle size:56% vertical:lr\n' +
'Test');
});
it('invalid settings', function() {
errorHelper(shaka.util.Error.Code.INVALID_TEXT_SETTINGS,
'WEBVTT\n\n00:00.000 --> 00:00.010 vertical:es\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_SETTINGS,
'WEBVTT\n\n00:00.000 --> 00:00.010 vertical:\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_SETTINGS,
'WEBVTT\n\n00:00.000 --> 00:00.010 vertical\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_SETTINGS,
'WEBVTT\n\n00:00.000 --> 00:00.010 line:-3%\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_SETTINGS,
'WEBVTT\n\n00:00.000 --> 00:00.010 line:105%\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_SETTINGS,
'WEBVTT\n\n00:00.000 --> 00:00.010 line:45%%\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_SETTINGS,
'WEBVTT\n\n00:00.000 --> 00:00.010 align:10\nTest');
errorHelper(shaka.util.Error.Code.INVALID_TEXT_SETTINGS,
'WEBVTT\n\n00:00.000 --> 00:00.010 align:foo\nTest');
});
function verifyHelper(cues, string) {
var data = shaka.util.Uint8ArrayUtils.fromString(string).buffer;
var result = shaka.media.VttTextParser(data);
expect(result).toBeTruthy();
expect(result.length).toBe(cues.length);
for (var i = 0; i < cues.length; i++) {
expect(result[i].startTime).toBe(cues[i].start);
expect(result[i].endTime).toBe(cues[i].end);
expect(result[i].text).toBe(cues[i].text);
if (cues[i].id)
expect(result[i].id).toBe(cues[i].id);
if (cues[i].vertical)
expect(result[i].vertical).toBe(cues[i].vertical);
if (cues[i].line)
expect(result[i].line).toBe(cues[i].line);
if (cues[i].align)
expect(result[i].align).toBe(cues[i].align);
if (cues[i].size)
expect(result[i].size).toBe(cues[i].size);
if (cues[i].position)
expect(result[i].position).toBe(cues[i].position);
}
}
function errorHelper(code, string) {
var data = shaka.util.Uint8ArrayUtils.fromString(string).buffer;
try {
var result = shaka.media.VttTextParser(data);
fail('Invalid WebVTT file supported');
} catch (e) {
expect(e instanceof shaka.util.Error).toBe(true);
expect(e.category).toBe(shaka.util.Error.Category.TEXT);
expect(e.code).toBe(code);
}
}
});