gecko/content/media/test/manifest.js
Ralph Giles 28dc7fce2d Bug 778050 - Support Opus tag metadata. r=derf
Remember parsed comments from the OpusTags header in
an array member variable. Add a method to generate
the nsHTMLMediaElement::MetadataTags hash table from
those entries, performing the same validatation we
do for Vorbis.

This feature is tested by adding the existing opus
test file to gMetadataTests.

IsValidVorbisTagName is moved to a static method
on nsOggCodecState so it can be shared among the
subclasses and easily called externally.

MetadataTags generation for Vorbis streams is moved
to the same method name on nsVorbisState to allow
sharing of the parsing and validation code as much
as possible, since both formats use the same scheme.

It's arguable whether contrustuction better belongs to
nsOggReader or to the nsCodecState subclasses, since in
theory the various multiplexed streams interact in
determining the canonical tag list, but it is the
per-codec streams which contain the metadata in Ogg.
2012-09-17 18:42:36 -04:00

564 lines
22 KiB
JavaScript

// In each list of tests below, test file types that are not supported should
// be ignored. To make sure tests respect that, we include a file of type
// "bogus/duh" in each list.
// These are small test files, good for just seeing if something loads. We
// really only need one test file per backend here.
var gSmallTests = [
{ name:"small-shot.ogg", type:"audio/ogg", duration:0.276 },
{ name:"r11025_s16_c1.wav", type:"audio/x-wav", duration:1.0 },
{ name:"320x240.ogv", type:"video/ogg", width:320, height:240, duration:0.266 },
{ name:"seek.webm", type:"video/webm", width:320, height:240, duration:3.966 },
{ name:"detodos.opus", type:"audio/ogg; codecs=opus", duration:2.9135 },
{ name:"gizmo.mp4", type:"video/mp4", duration:5.0 },
{ name:"bogus.duh", type:"bogus/duh" }
];
// Used by test_progress to ensure we get the correct progress information
// during resource download.
var gProgressTests = [
{ name:"r11025_u8_c1.wav", type:"audio/x-wav", duration:1.0, size:11069 },
{ name:"big.wav", type:"audio/x-wav", duration:9.278981, size:102444 },
{ name:"seek.ogv", type:"video/ogg", duration:3.966, size:285310 },
{ name:"320x240.ogv", type:"video/ogg", width:320, height:240, duration:0.266, size:28942 },
{ name:"seek.webm", type:"video/webm", duration:3.966, size:215529 },
{ name:"gizmo.mp4", type:"video/mp4", duration:5.0, size:383631 },
{ name:"bogus.duh", type:"bogus/duh" }
];
// Used by test_played.html
var gPlayedTests = [
{ name:"big.wav", type:"audio/x-wav", duration:9.0 },
{ name:"sound.ogg", type:"audio/ogg", duration:4.0 },
{ name:"seek.ogv", type:"video/ogg", duration:3.966 },
{ name:"seek.webm", type:"video/webm", duration:3.966 },
{ name:"gizmo.mp4", type:"video/mp4", duration:5.0 },
];
// Used by test_mozLoadFrom. Need one test file per decoder backend, plus
// anything for testing clone-specific bugs.
var cloneKey = Math.floor(Math.random()*100000000);
var gCloneTests = gSmallTests.concat([
// Actual duration is ~200ms, we have Content-Duration lie about it.
{ name:"bug520908.ogv", type:"video/ogg", duration:9000 },
// short-video is more like 1s, so if you load this twice you'll get an unexpected duration
{ name:"dynamic_resource.sjs?key=" + cloneKey + "&res1=320x240.ogv&res2=short-video.ogv",
type:"video/ogg", duration:0.266 },
]);
// Used by test_play_twice. Need one test file per decoder backend, plus
// anything for testing bugs that occur when replying a played file.
var gReplayTests = gSmallTests.concat([
{ name:"bug533822.ogg", type:"audio/ogg" },
]);
// Used by test_paused_after_ended. Need one test file per decoder backend, plus
// anything for testing bugs that occur when replying a played file.
var gPausedAfterEndedTests = gSmallTests.concat([
{ name:"r11025_u8_c1.wav", type:"audio/x-wav", duration:1.0 },
{ name:"small-shot.ogg", type:"video/ogg", duration:0.276 }
]);
// Test the mozHasAudio property
var gMozHasAudioTests = [
{ name:"big.wav", type:"audio/x-wav", duration:9.278981, size:102444, hasAudio:undefined },
{ name:"320x240.ogv", type:"video/ogg", width:320, height:240, duration:0.266, size:28942, hasAudio:false },
{ name:"short-video.ogv", type:"video/ogg", duration:1.081, hasAudio:true },
{ name:"seek.webm", type:"video/webm", duration:3.966, size:215529, hasAudio:false },
{ name:"bogus.duh", type:"bogus/duh" }
];
// These are files that we want to make sure we can play through. We can
// also check metadata. Put files of the same type together in this list so if
// something crashes we have some idea of which backend is responsible.
// Used by test_playback, which expects no error event and one ended event.
var gPlayTests = [
// 8-bit samples
{ name:"r11025_u8_c1.wav", type:"audio/x-wav", duration:1.0 },
// 8-bit samples, file is truncated
{ name:"r11025_u8_c1_trunc.wav", type:"audio/x-wav", duration:1.8 },
// file has trailing non-PCM data
{ name:"r11025_s16_c1_trailing.wav", type:"audio/x-wav", duration:1.0 },
// file with list chunk
{ name:"r16000_u8_c1_list.wav", type:"audio/x-wav", duration:4.2 },
// Ogg stream without eof marker
{ name:"bug461281.ogg", type:"application/ogg", duration:2.208 },
// oggz-chop stream
{ name:"bug482461.ogv", type:"video/ogg", duration:4.34 },
// Theora only oggz-chop stream
{ name:"bug482461-theora.ogv", type:"video/ogg", duration:4.138 },
// With first frame a "duplicate" (empty) frame.
{ name:"bug500311.ogv", type:"video/ogg", duration:1.96 },
// Small audio file
{ name:"small-shot.ogg", type:"video/ogg", duration:0.276 },
// More audio in file than video.
{ name:"short-video.ogv", type:"video/ogg", duration:1.081 },
// First Theora data packet is zero bytes.
{ name:"bug504613.ogv", type:"video/ogg", duration:Number.NaN },
// Multiple audio streams.
{ name:"bug516323.ogv", type:"video/ogg", duration:4.208 },
// oggz-chop with non-keyframe as first frame
{ name:"bug556821.ogv", type:"video/ogg", duration:2.551 },
// Encoded with vorbis beta1, includes unusually sized codebooks
{ name:"beta-phrasebook.ogg", type:"audio/ogg", duration:4.01 },
// Small file, only 1 frame with audio only.
{ name:"bug520493.ogg", type:"audio/ogg", duration:0.458 },
// Small file with vorbis comments with 0 length values and names.
{ name:"bug520500.ogg", type:"audio/ogg", duration:0.123 },
// Various weirdly formed Ogg files
{ name:"bug499519.ogv", type:"video/ogg", duration:0.24 },
{ name:"bug506094.ogv", type:"video/ogg", duration:0 },
{ name:"bug498855-1.ogv", type:"video/ogg", duration:0.24 },
{ name:"bug498855-2.ogv", type:"video/ogg", duration:0.24 },
{ name:"bug498855-3.ogv", type:"video/ogg", duration:0.24 },
{ name:"bug504644.ogv", type:"video/ogg", duration:1.6 },
{ name:"chain.ogv", type:"video/ogg", duration:Number.NaN },
{ name:"bug523816.ogv", type:"video/ogg", duration:0.533 },
{ name:"bug495129.ogv", type:"video/ogg", duration:2.41 },
{ name:"bug498380.ogv", type:"video/ogg", duration:0.533 },
{ name:"bug495794.ogg", type:"audio/ogg", duration:0.3 },
{ name:"bug557094.ogv", type:"video/ogg", duration:0.24 },
{ name:"multiple-bos.ogg", type:"video/ogg", duration:0.431 },
{ name:"audio-overhang.ogg", type:"audio/ogg", duration:2.3 },
{ name:"video-overhang.ogg", type:"audio/ogg", duration:3.966 },
// bug461281.ogg with the middle second chopped out.
{ name:"audio-gaps.ogg", type:"audio/ogg", duration:2.208 },
// Test playback/metadata work after a redirect
{ name:"redirect.sjs?domain=mochi.test:8888&file=320x240.ogv",
type:"video/ogg", duration:0.266 },
// Test playback of a webm file
{ name:"seek.webm", type:"video/webm", duration:3.966 },
// Test playback of a WebM file with non-zero start time.
{ name:"split.webm", type:"video/webm", duration:1.967 },
// Test playback of a raw file
{ name:"seek.yuv", type:"video/x-raw-yuv", duration:1.833 },
// A really short, low sample rate, single channel file. This tests whether
// we can handle playing files when only push very little audio data to the
// hardware.
{ name:"spacestorm-1000Hz-100ms.ogg", type:"audio/ogg", duration:0.099 },
// Opus data in an ogg container
{ name:"detodos.opus", type:"audio/ogg; codecs=opus", duration:2.9135 },
{ name:"gizmo.mp4", type:"video/mp4", duration:5.0 },
// Invalid file
{ name:"bogus.duh", type:"bogus/duh", duration:Number.NaN }
];
// A file for each type we can support.
var gSnifferTests = [
{ name:"big.wav", type:"audio/x-wav", duration:9.278981, size:102444 },
{ name:"320x240.ogv", type:"video/ogg", width:320, height:240, duration:0.233, size:28942 },
{ name:"seek.webm", type:"video/webm", duration:3.966, size:215529 },
{ name:"short.mp4", type:"video/mp4", duration:0.2, size:29435},
// A mp3 file with id3 tags.
{ name:"id3tags.mp3", type:"audio/mpeg", duration:0.28, size:3530},
{ name:"bogus.duh", type:"bogus/duh" }
];
// Converts a path/filename to a file:// URI which we can load from disk.
// Optionally checks whether the file actually exists on disk at the location
// we've specified.
function fileUriToSrc(path, mustExist) {
// android mochitest doesn't support file://
if (navigator.appVersion.indexOf("Android") != -1)
return path;
const Ci = Components.interfaces;
const Cc = SpecialPowers.wrap(Components).classes;
const Cr = SpecialPowers.wrap(Components).results;
var dirSvc = Cc["@mozilla.org/file/directory_service;1"].
getService(Ci.nsIProperties);
var f = dirSvc.get("CurWorkD", Ci.nsILocalFile);
var split = path.split("/");
for(var i = 0; i < split.length; ++i) {
f.append(split[i]);
}
if (mustExist && !f.exists()) {
ok(false, "We expected '" + path + "' to exist, but it doesn't!");
}
return f.path;
}
// Returns true if two nsTimeRanges are equal, false otherwise
function range_equals(r1, r2) {
if (r1.length != r2.length) {
return false;
}
for (var i = 0; i < r1.length; i++) {
if (r1.start(i) != r2.start(i) || r1.end(i) != r2.end(i)) {
return false;
}
}
return true;
}
// These are URIs to files that we use to check that we don't leak any state
// or other information such that script can determine stuff about a user's
// environment. Used by test_info_leak.
var gInfoLeakTests = [
{
type: 'video/ogg',
src: fileUriToSrc("tests/content/media/test/320x240.ogv", true),
},{
type: 'video/ogg',
src: fileUriToSrc("tests/content/media/test/404.ogv", false),
}, {
type: 'audio/x-wav',
src: fileUriToSrc("tests/content/media/test/r11025_s16_c1.wav", true),
}, {
type: 'audio/x-wav',
src: fileUriToSrc("tests/content/media/test/404.wav", false),
}, {
type: 'audio/ogg',
src: fileUriToSrc("tests/content/media/test/bug461281.ogg", true),
}, {
type: 'audio/ogg',
src: fileUriToSrc("tests/content/media/test/404.ogg", false),
}, {
type: 'video/webm',
src: fileUriToSrc("tests/content/media/test/seek.webm", true),
}, {
type: 'video/webm',
src: fileUriToSrc("tests/content/media/test/404.webm", false),
}, {
type: 'video/ogg',
src: 'http://localhost/404.ogv',
}, {
type: 'audio/x-wav',
src: 'http://localhost/404.wav',
}, {
type: 'video/webm',
src: 'http://localhost/404.webm',
}, {
type: 'video/ogg',
src: 'http://example.com/tests/content/media/test/test_info_leak.html'
}, {
type: 'audio/ogg',
src: 'http://example.com/tests/content/media/test/test_info_leak.html'
}
];
// These are files that must fire an error during load or playback, and do not
// cause a crash. Put files of the same type together in this list so if
// something crashes we have some idea of which backend is responsible. Used
// by test_playback_errors, which expects one error event and no ended event.
// Put files of the same type together in this list so if something crashes
// we have some idea of which backend is responsible.
var gErrorTests = [
{ name:"bogus.wav", type:"audio/x-wav" },
{ name:"bogus.ogv", type:"video/ogg" },
{ name:"448636.ogv", type:"video/ogg" },
{ name:"bug504843.ogv", type:"video/ogg" },
{ name:"bug501279.ogg", type:"audio/ogg" },
{ name:"bug580982.webm", type:"video/webm" },
{ name:"bug603918.webm", type:"video/webm" },
{ name:"bug604067.webm", type:"video/webm" },
{ name:"bogus.duh", type:"bogus/duh" }
];
// These are files that have nontrivial duration and are useful for seeking within.
var gSeekTests = [
{ name:"r11025_s16_c1.wav", type:"audio/x-wav", duration:1.0 },
{ name:"audio.wav", type:"audio/x-wav", duration:0.031247 },
{ name:"seek.ogv", type:"video/ogg", duration:3.966 },
{ name:"320x240.ogv", type:"video/ogg", duration:0.266 },
{ name:"seek.webm", type:"video/webm", duration:3.966 },
{ name:"bug516323.indexed.ogv", type:"video/ogg", duration:4.208 },
{ name:"split.webm", type:"video/webm", duration:1.967 },
{ name:"detodos.opus", type:"audio/ogg; codecs=opus", duration:2.9135 },
{ name:"bogus.duh", type:"bogus/duh", duration:123 }
];
// These are files suitable for using with a "new Audio" constructor.
var gAudioTests = [
{ name:"r11025_s16_c1.wav", type:"audio/x-wav", duration:1.0 },
{ name:"sound.ogg", type:"audio/ogg" },
{ name:"bogus.duh", type:"bogus/duh", duration:123 }
];
// These files ensure our handling of 404 errors is consistent across the
// various backends.
var g404Tests = [
{ name:"404.wav", type:"audio/x-wav" },
{ name:"404.ogv", type:"video/ogg" },
{ name:"404.oga", type:"audio/ogg" },
{ name:"404.webm", type:"video/webm" },
{ name:"bogus.duh", type:"bogus/duh" }
];
// These are files suitable for testing various decoder failures that are
// expected to fire MEDIA_ERR_DECODE. Used by test_decode_error, which expects
// an error and emptied event, and no loadedmetadata or ended event.
var gDecodeErrorTests = [
// Valid files with unsupported codecs
{ name:"r11025_msadpcm_c1.wav", type:"audio/x-wav" },
{ name:"dirac.ogg", type:"video/ogg" },
// Invalid files
{ name:"bogus.wav", type:"audio/x-wav" },
{ name:"bogus.ogv", type:"video/ogg" },
{ name:"bogus.duh", type:"bogus/duh" }
];
// These are files that are used for media fragments tests
var gFragmentTests = [
{ name:"big.wav", type:"audio/x-wav", duration:9.278981, size:102444 }
];
// These are files with non-trivial tag sets.
// Used by test_metadata.html.
var gMetadataTests = [
// Ogg Vorbis files
{ name:"short-video.ogv", tags: {
TITLE:"Lepidoptera",
ARTIST:"Epoq",
ALBUM:"Kahvi Collective",
DATE:"2002",
COMMENT:"http://www.kahvi.org",
}
},
{ name:"bug516323.ogv", tags: {
GENRE:"Open Movie",
ENCODER:"Audacity",
TITLE:"Elephants Dream",
ARTIST:"Silvia Pfeiffer",
COMMENTS:"Audio Description"
}
},
{ name:"bug516323.indexed.ogv", tags: {
GENRE:"Open Movie",
ENCODER:"Audacity",
TITLE:"Elephants Dream",
ARTIST:"Silvia Pfeiffer",
COMMENTS:"Audio Description"
}
},
{ name:"detodos.opus", tags: {
title:"De todos. Para todos.",
artist:"Mozilla.org"
}
},
{ name:"sound.ogg", tags: { } },
{ name:"badtags.ogg", tags: {
// We list only the valid tags here, and verify
// the invalid ones are filtered out.
title:"Invalid comments test file",
empty:"",
"":"empty",
"{- [(`!@\"#$%^&')] -}":"valid tag name, surprisingly"
// The file also includes the following invalid tags.
// "A description with no separator is a common problem.",
// "雨":"Likely, but an invalid key (non-ascii).",
// "not\nval\x1fid":"invalid tag name",
// "not~valid":"this isn't a valid name either",
// "not-utf-8":"invalid sequences: \xff\xfe\xfa\xfb\0eol"
}
}
];
function checkMetadata(msg, e, test) {
if (test.width) {
is(e.videoWidth, test.width, msg + " video width");
}
if (test.height) {
is(e.videoHeight, test.height, msg + " video height");
}
if (test.duration) {
ok(Math.abs(e.duration - test.duration) < 0.1,
msg + " duration (" + e.duration + ") should be around " + test.duration);
}
}
// Returns the first test from candidates array which we can play with the
// installed video backends.
function getPlayableVideo(candidates) {
var v = document.createElement("video");
var resources = candidates.filter(function(x){return /^video/.test(x.type) && v.canPlayType(x.type);});
if (resources.length > 0)
return resources[0];
return null;
}
function getPlayableAudio(candidates) {
var v = document.createElement("audio");
var resources = candidates.filter(function(x){return /^audio/.test(x.type) && v.canPlayType(x.type);});
if (resources.length > 0)
return resources[0];
return null;
}
// Number of tests to run in parallel. Warning: Each media element requires
// at least 3 threads (4 on Linux), and on Linux each thread uses 10MB of
// virtual address space. Beware!
var PARALLEL_TESTS = 2;
// When true, we'll loop forever on whatever test we run. Use this to debug
// intermittent test failures.
const DEBUG_TEST_LOOP_FOREVER = false;
// Manages a run of media tests. Runs them in chunks in order to limit
// the number of media elements/threads running in parallel. This limits peak
// memory use, particularly on Linux x86 where thread stacks use 10MB of
// virtual address space.
// Usage:
// 1. Create a new MediaTestManager object.
// 2. Create a test startTest function. This takes a test object and a token,
// and performs anything necessary to start the test. The test object is an
// element in one of the g*Tests above. Your startTest function must call
// MediaTestManager.start(token) if it starts a test. The test object is
// guaranteed to be playable by our supported decoders; you don't need to
// check canPlayType.
// 3. When your tests finishes, call MediaTestManager.finished(), passing
// the token back to the manager. The manager may either start the next run
// or end the mochitest if all the tests are done.
function MediaTestManager() {
// Sets up a MediaTestManager to runs through the 'tests' array, which needs
// to be one of, or have the same fields as, the g*Test arrays of tests. Uses
// the user supplied 'startTest' function to initialize the test. This
// function must accept two arguments, the test entry from the 'tests' array,
// and a token. Call MediaTestManager.started(token) if you start the test,
// and MediaTestManager.finished(token) when the test finishes. You don't have
// to start every test, but if you call started() you *must* call finish()
// else you'll timeout.
this.runTests = function(tests, startTest) {
this.startTime = new Date();
SimpleTest.info("Started " + this.startTime + " (" + this.startTime.getTime()/1000 + "s)");
this.testNum = 0;
this.tests = tests;
this.startTest = startTest;
this.tokens = [];
this.isShutdown = false;
this.numTestsRunning = 0;
// Always wait for explicit finish.
SimpleTest.waitForExplicitFinish();
this.nextTest();
}
// Registers that the test corresponding to 'token' has been started.
// Don't call more than once per token.
this.started = function(token) {
this.tokens.push(token);
this.numTestsRunning++;
is(this.numTestsRunning, this.tokens.length, "[started " + token + "] Length of array should match number of running tests");
}
// Registers that the test corresponding to 'token' has finished. Call when
// you've finished your test. If all tests are complete this will finish the
// run, otherwise it may start up the next run. It's ok to call multiple times
// per token.
this.finished = function(token) {
var i = this.tokens.indexOf(token);
if (i != -1) {
// Remove the element from the list of running tests.
this.tokens.splice(i, 1);
}
this.numTestsRunning--;
is(this.numTestsRunning, this.tokens.length, "[finished " + token + "] Length of array should match number of running tests");
if (this.tokens.length < PARALLEL_TESTS) {
this.nextTest();
}
}
// Starts the next batch of tests, or finishes if they're all done.
// Don't call this directly, call finished(token) when you're done.
this.nextTest = function() {
// Force a GC after every completed testcase. This ensures that any decoders
// with live threads waiting for the GC are killed promptly, to free up the
// thread stacks' address space.
SpecialPowers.forceGC();
while (this.testNum < this.tests.length && this.tokens.length < PARALLEL_TESTS) {
var test = this.tests[this.testNum];
var token = (test.name ? (test.name + "-"): "") + this.testNum;
this.testNum++;
if (DEBUG_TEST_LOOP_FOREVER && this.testNum == this.tests.length) {
this.testNum = 0;
}
// Ensure we can play the resource type.
if (test.type && !document.createElement('video').canPlayType(test.type))
continue;
// Do the init. This should start the test.
this.startTest(test, token);
}
if (this.testNum == this.tests.length &&
!DEBUG_TEST_LOOP_FOREVER &&
this.tokens.length == 0 &&
!this.isShutdown)
{
this.isShutdown = true;
if (this.onFinished) {
this.onFinished();
}
mediaTestCleanup();
var end = new Date();
SimpleTest.info("Finished at " + end + " (" + (end.getTime() / 1000) + "s)");
SimpleTest.info("Running time: " + (end.getTime() - this.startTime.getTime())/1000 + "s");
SimpleTest.finish();
return;
}
}
}
// Ensures we've got no active video or audio elements in the document, and
// forces a GC to release the address space reserved by the decoders' threads'
// stacks.
function mediaTestCleanup() {
var V = document.getElementsByTagName("video");
for (i=0; i<V.length; i++) {
V[i].parentNode.removeChild(V[i]);
V[i] = null;
}
var A = document.getElementsByTagName("audio");
for (i=0; i<A.length; i++) {
A[i].parentNode.removeChild(A[i]);
A[i] = null;
}
SpecialPowers.forceGC();
}
(function() {
// Ensure that preload preferences are comsistent
var prefService = SpecialPowers.wrap(Components)
.classes["@mozilla.org/preferences-service;1"]
.getService(Components.interfaces.nsIPrefService);
var branch = prefService.getBranch("media.");
var oldDefault = 2;
var oldAuto = 3;
var oldOpus = undefined;
try {
oldDefault = branch.getIntPref("preload.default");
oldAuto = branch.getIntPref("preload.auto");
oldOpus = branch.getBoolPref("opus.enabled");
} catch(ex) { }
branch.setIntPref("preload.default", 2); // preload_metadata
branch.setIntPref("preload.auto", 3); // preload_enough
// test opus playback iff the pref exists
if (oldOpus !== undefined)
branch.setBoolPref("opus.enabled", true);
window.addEventListener("unload", function() {
branch.setIntPref("preload.default", oldDefault);
branch.setIntPref("preload.auto", oldAuto);
if (oldOpus !== undefined)
branch.setBoolPref("opus.enabled", oldOpus);
}, false);
})();