popcorn-js/popcorn.js

1198 строки
32 KiB
JavaScript
Исходник Обычный вид История

/*
* popcorn.js version @VERSION
* http://popcornjs.org
*
* Copyright 2011, Mozilla Foundation
* Licensed under the MIT license
*/
(function(global, document) {
2010-12-04 23:54:38 +03:00
// Cache refs to speed up calls to native utils
2011-02-14 21:38:50 +03:00
var
forEach = Array.prototype.forEach,
hasOwn = Object.prototype.hasOwnProperty,
2010-12-04 23:54:38 +03:00
slice = Array.prototype.slice,
toString = Object.prototype.toString,
2010-12-04 23:54:38 +03:00
// ID string matching
2011-02-14 21:38:50 +03:00
rIdExp = /^(#([\w\-\_\.]+))$/,
2011-03-18 18:33:05 +03:00
// Ready fn cache
2011-02-14 21:38:50 +03:00
readyStack = [],
readyBound = false,
readyFired = false,
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
2011-03-18 18:33:05 +03:00
// Declare constructor
2011-02-14 21:38:50 +03:00
// Returns an instance object.
2010-12-04 23:54:38 +03:00
Popcorn = function( entity ) {
2010-12-06 01:37:33 +03:00
// Return new Popcorn object
2010-12-04 23:54:38 +03:00
return new Popcorn.p.init( entity );
};
// Instance caching
2011-02-02 01:52:07 +03:00
Popcorn.instances = [];
Popcorn.instanceIds = {};
Popcorn.removeInstance = function( instance ) {
// If called prior to any instances being created
// Return early to avoid splicing on nothing
if ( !Popcorn.instances.length ) {
return;
}
// Remove instance from Popcorn.instances
Popcorn.instances.splice( Popcorn.instanceIds[ instance.id ], 1 );
// Delete the instance id key
delete Popcorn.instanceIds[ instance.id ];
// Return current modified instances
return Popcorn.instances;
2011-02-02 01:52:07 +03:00
};
// Addes a Popcorn instance to the Popcorn instance array
Popcorn.addInstance = function( instance ) {
var instanceLen = Popcorn.instances.length,
2011-03-24 17:09:20 +03:00
instanceId = instance.media.id && instance.media.id;
2011-03-24 17:09:20 +03:00
// If the media element has its own `id` use it, otherwise provide one
// Ensure that instances have unique ids and unique entries
// Uses `in` operator to avoid false positives on 0
2011-03-18 18:33:05 +03:00
instance.id = !( instanceId in Popcorn.instanceIds ) && instanceId ||
"__popcorn" + instanceLen;
// Create a reference entry for this instance
Popcorn.instanceIds[ instance.id ] = instanceLen;
// Add this instance to the cache
Popcorn.instances.push( instance );
// Return the current modified instances
return Popcorn.instances;
2011-02-02 01:52:07 +03:00
};
2010-12-04 23:54:38 +03:00
// Request Popcorn object instance by id
Popcorn.getInstanceById = function( id ) {
return Popcorn.instances[ Popcorn.instanceIds[ id ] ];
2011-02-02 01:52:07 +03:00
};
// Remove Popcorn object instance by id
Popcorn.removeInstanceById = function( id ) {
return Popcorn.removeInstance( Popcorn.instances[ Popcorn.instanceIds[ id ] ] );
};
2011-02-14 21:38:50 +03:00
// Declare a shortcut (Popcorn.p) to and a definition of
// the new prototype for our Popcorn constructor
2010-12-04 23:54:38 +03:00
Popcorn.p = Popcorn.prototype = {
init: function( entity ) {
var matches;
2011-02-14 21:38:50 +03:00
// Supports Popcorn(function () { /../ })
// Originally proposed by Daniel Brooks
2011-02-14 21:38:50 +03:00
2010-12-20 18:01:13 +03:00
if ( typeof entity === "function" ) {
2011-02-14 21:38:50 +03:00
// If document ready has already fired
if ( document.readyState === "interactive" || document.readyState === "complete" ) {
2011-02-14 21:38:50 +03:00
entity(document, Popcorn);
2011-02-14 21:38:50 +03:00
return;
}
2011-03-18 18:33:05 +03:00
// Add `entity` fn to ready stack
readyStack.push( entity );
// This process should happen once per page load
if ( !readyBound ) {
// set readyBound flag
readyBound = true;
var DOMContentLoaded = function () {
2011-02-14 21:38:50 +03:00
readyFired = true;
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
// Remove global DOM ready listener
document.removeEventListener( "DOMContentLoaded", DOMContentLoaded, false );
// Execute all ready function in the stack
for ( var i = 0; i < readyStack.length; i++ ) {
readyStack[i].call( document, Popcorn );
2010-12-04 23:54:38 +03:00
}
// GC readyStack
2011-02-14 21:38:50 +03:00
readyStack = null;
};
2011-03-18 18:33:05 +03:00
// Register global DOM ready listener
document.addEventListener( "DOMContentLoaded", DOMContentLoaded, false);
}
2011-02-14 21:38:50 +03:00
return;
2010-12-20 18:01:13 +03:00
}
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
// Check if entity is a valid string id
2010-12-04 23:54:38 +03:00
matches = rIdExp.exec( entity );
2011-02-14 21:38:50 +03:00
2011-03-24 17:09:20 +03:00
// Get media element by id or object reference
this.media = matches && matches.length && matches[ 2 ] ?
2011-03-12 00:32:45 +03:00
document.getElementById( matches[ 2 ] ) :
entity;
2011-02-14 21:38:50 +03:00
2011-03-24 17:09:20 +03:00
// Create an audio or video element property reference
this[ ( this.media.tagName && this.media.tagName.toLowerCase() ) || "video" ] = this.media;
2011-03-24 17:09:20 +03:00
2011-03-18 18:33:05 +03:00
// Register new instance
Popcorn.addInstance( this );
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
this.data = {
2010-12-16 21:44:19 +03:00
history: [],
2010-12-04 23:54:38 +03:00
events: {},
trackEvents: {
2011-02-16 00:55:52 +03:00
byStart: [{
start: -1,
end: -1
}],
byEnd: [{
start: -1,
end: -1
}],
2010-12-07 19:15:30 +03:00
startIndex: 0,
2010-12-10 02:18:12 +03:00
endIndex: 0,
2010-12-07 19:15:30 +03:00
previousUpdateTime: 0
}
2010-12-04 23:54:38 +03:00
};
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
// Wrap true ready check
2010-12-14 00:38:57 +03:00
var isReady = function( that ) {
2010-12-10 19:53:47 +03:00
2011-03-24 17:09:20 +03:00
if ( that.media.readyState >= 2 ) {
2011-03-18 18:33:05 +03:00
// Adding padding to the front and end of the arrays
// this is so we do not fall off either end
2010-12-10 19:53:47 +03:00
2011-03-24 17:09:20 +03:00
var duration = that.media.duration;
2011-03-18 18:33:05 +03:00
// Check for no duration info (NaN)
2011-02-16 20:06:45 +03:00
var videoDurationPlus = duration != duration ? Number.MAX_VALUE : duration + 1;
2010-12-14 00:43:24 +03:00
Popcorn.addTrackEvent( that, {
start: videoDurationPlus,
end: videoDurationPlus
});
2011-02-14 21:38:50 +03:00
2011-03-24 17:09:20 +03:00
that.media.addEventListener( "timeupdate", function( event ) {
2010-12-10 02:18:12 +03:00
var currentTime = this.currentTime,
previousTime = that.data.trackEvents.previousUpdateTime,
tracks = that.data.trackEvents,
2010-12-10 02:18:12 +03:00
tracksByEnd = tracks.byEnd,
tracksByStart = tracks.byStart;
2011-03-18 18:33:05 +03:00
// Playbar advancing
2010-12-14 00:43:24 +03:00
if ( previousTime < currentTime ) {
2010-12-10 02:18:12 +03:00
2011-02-16 00:55:52 +03:00
while ( tracksByEnd[ tracks.endIndex ] && tracksByEnd[ tracks.endIndex ].end <= currentTime ) {
2011-03-18 18:33:05 +03:00
// If plugin does not exist on this instance, remove it
2011-02-16 00:55:52 +03:00
if ( !tracksByEnd[ tracks.endIndex ]._natives || !!that[ tracksByEnd[ tracks.endIndex ]._natives.type ] ) {
if ( tracksByEnd[ tracks.endIndex ]._running === true ) {
tracksByEnd[ tracks.endIndex ]._running = false;
tracksByEnd[ tracks.endIndex ]._natives.end.call( that, event, tracksByEnd[ tracks.endIndex ] );
}
tracks.endIndex++;
} else {
// remove track event
Popcorn.removeTrackEvent( that, tracksByEnd[ tracks.endIndex ]._id );
return;
2010-12-10 02:18:12 +03:00
}
}
2011-02-16 00:55:52 +03:00
while ( tracksByStart[ tracks.startIndex ] && tracksByStart[ tracks.startIndex ].start <= currentTime ) {
2011-03-18 18:33:05 +03:00
// If plugin does not exist on this instance, remove it
2011-02-16 00:55:52 +03:00
if ( !tracksByStart[ tracks.startIndex ]._natives || !!that[ tracksByStart[ tracks.startIndex ]._natives.type ] ) {
if ( tracksByStart[ tracks.startIndex ].end > currentTime && tracksByStart[ tracks.startIndex ]._running === false ) {
tracksByStart[ tracks.startIndex ]._running = true;
tracksByStart[ tracks.startIndex ]._natives.start.call( that, event, tracksByStart[ tracks.startIndex ] );
}
tracks.startIndex++;
} else {
// remove track event
Popcorn.removeTrackEvent( that, tracksByStart[ tracks.startIndex ]._id );
return;
2010-12-10 02:18:12 +03:00
}
}
// Playbar receding
2010-12-14 00:43:24 +03:00
} else if ( previousTime > currentTime ) {
2010-12-10 02:18:12 +03:00
2011-02-16 00:55:52 +03:00
while ( tracksByStart[ tracks.startIndex ] && tracksByStart[ tracks.startIndex ].start > currentTime ) {
// if plugin does not exist on this instance, remove it
if ( !tracksByStart[ tracks.startIndex ]._natives || !!that[ tracksByStart[ tracks.startIndex ]._natives.type ] ) {
if ( tracksByStart[ tracks.startIndex ]._running === true ) {
tracksByStart[ tracks.startIndex ]._running = false;
tracksByStart[ tracks.startIndex ]._natives.end.call( that, event, tracksByStart[ tracks.startIndex ] );
}
tracks.startIndex--;
} else {
// remove track event
Popcorn.removeTrackEvent( that, tracksByStart[ tracks.startIndex ]._id );
return;
2010-12-10 02:18:12 +03:00
}
}
2011-02-14 21:38:50 +03:00
2011-02-16 00:55:52 +03:00
while ( tracksByEnd[ tracks.endIndex ] && tracksByEnd[ tracks.endIndex ].end > currentTime ) {
// if plugin does not exist on this instance, remove it
if ( !tracksByEnd[ tracks.endIndex ]._natives || !!that[ tracksByEnd[ tracks.endIndex ]._natives.type ] ) {
if ( tracksByEnd[ tracks.endIndex ].start <= currentTime && tracksByEnd[ tracks.endIndex ]._running === false ) {
tracksByEnd[ tracks.endIndex ]._running = true;
tracksByEnd[ tracks.endIndex ]._natives.start.call( that, event, tracksByEnd[tracks.endIndex] );
}
tracks.endIndex--;
} else {
// remove track event
Popcorn.removeTrackEvent( that, tracksByEnd[ tracks.endIndex ]._id );
return;
2010-12-10 02:18:12 +03:00
}
}
2011-02-14 21:38:50 +03:00
}
2011-03-18 18:33:05 +03:00
2010-12-10 02:18:12 +03:00
tracks.previousUpdateTime = currentTime;
2011-02-14 21:38:50 +03:00
2010-12-10 02:18:12 +03:00
}, false);
2010-12-07 19:15:30 +03:00
} else {
2010-12-20 18:59:32 +03:00
global.setTimeout( function() {
2010-12-14 00:43:24 +03:00
isReady( that );
2010-12-10 22:50:49 +03:00
}, 1);
2010-12-07 19:15:30 +03:00
}
2010-12-10 02:18:12 +03:00
};
2010-12-10 19:53:47 +03:00
2010-12-14 00:43:24 +03:00
isReady( this );
2010-12-10 02:18:12 +03:00
2010-12-04 23:54:38 +03:00
return this;
}
};
// Extend constructor prototype to instance prototype
2011-03-18 18:33:05 +03:00
// Allows chaining methods to instances
2010-12-04 23:54:38 +03:00
Popcorn.p.init.prototype = Popcorn.p;
Popcorn.forEach = function( obj, fn, context ) {
if ( !obj || !fn ) {
return {};
}
context = context || this;
// Use native whenever possible
if ( forEach && obj.forEach === forEach ) {
return obj.forEach(fn, context);
2011-02-14 21:38:50 +03:00
}
2010-12-04 23:54:38 +03:00
for ( var key in obj ) {
if ( hasOwn.call(obj, key) ) {
fn.call(context, obj[key], key, obj);
2011-02-14 21:38:50 +03:00
}
}
2010-12-04 23:54:38 +03:00
return obj;
2011-02-14 21:38:50 +03:00
};
2010-12-04 23:54:38 +03:00
Popcorn.extend = function( obj ) {
var dest = obj, src = slice.call(arguments, 1);
Popcorn.forEach( src, function( copy ) {
for ( var prop in copy ) {
dest[prop] = copy[prop];
2010-12-04 23:54:38 +03:00
}
});
2011-02-14 21:38:50 +03:00
return dest;
2010-12-04 23:54:38 +03:00
};
2010-12-10 19:53:47 +03:00
2010-12-04 23:54:38 +03:00
// A Few reusable utils, memoized onto Popcorn
Popcorn.extend( Popcorn, {
error: function( msg ) {
throw new Error( msg );
},
guid: function( prefix ) {
Popcorn.guid.counter++;
2011-03-18 18:33:05 +03:00
return ( prefix ? prefix : "" ) + ( +new Date() + Popcorn.guid.counter );
2011-02-14 21:38:50 +03:00
},
2010-12-04 23:54:38 +03:00
sizeOf: function ( obj ) {
var size = 0;
for ( var prop in obj ) {
size++;
2010-12-04 23:54:38 +03:00
}
return size;
2011-02-14 21:38:50 +03:00
},
isArray: Array.isArray || function( array ) {
return toString.call( array ) === "[object Array]";
},
nop: function () {}
2011-02-14 21:38:50 +03:00
});
2011-03-18 18:33:05 +03:00
// Memoized GUID Counter
Popcorn.guid.counter = 1;
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
// Factory to implement getters, setters and controllers
// as Popcorn instance methods. The IIFE will create and return
// an object with defined methods
2010-12-04 23:54:38 +03:00
Popcorn.extend(Popcorn.p, (function () {
2011-02-14 21:38:50 +03:00
var methods = "load play pause currentTime playbackRate mute volume duration",
2010-12-04 23:54:38 +03:00
ret = {};
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
// Build methods, store in object that is returned and passed to extend
Popcorn.forEach( methods.split(/\s+/g), function( name ) {
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
ret[ name ] = function( arg ) {
2011-02-14 21:38:50 +03:00
2011-03-24 17:09:20 +03:00
if ( typeof this.media[name] === "function" ) {
this.media[ name ]();
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
return this;
}
2011-02-14 21:38:50 +03:00
if ( arg !== false && arg !== null && typeof arg !== "undefined" ) {
2011-02-14 21:38:50 +03:00
2011-03-24 17:09:20 +03:00
this.media[ name ] = arg;
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
return this;
}
2011-02-14 21:38:50 +03:00
2011-03-24 17:09:20 +03:00
return this.media[ name ];
2010-12-04 23:54:38 +03:00
};
});
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
return ret;
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
})()
);
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
Popcorn.extend(Popcorn.p, {
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
// Rounded currentTime
roundTime: function () {
2011-03-24 17:09:20 +03:00
return -~this.media.currentTime;
},
2011-03-18 18:33:05 +03:00
// Attach an event to a single point in time
2010-12-06 00:07:39 +03:00
exec: function ( time, fn ) {
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
// Creating a one second track event with an empty end
Popcorn.addTrackEvent( this, {
start: time,
end: time + 1,
_running: false,
_natives: {
2011-02-23 21:19:23 +03:00
start: fn || Popcorn.nop,
end: Popcorn.nop,
type: "exec"
}
});
2010-12-06 00:07:39 +03:00
return this;
},
// Popcorn Object Element Utils
position: function() {
var media = this.video,
clientRect = media.getBoundingClientRect(),
bounds = {},
doc = media.ownerDocument,
docElem = document.documentElement,
body = document.body,
clientTop, clientLeft, scrollTop, scrollLeft, top, left;
// Determine correct clientTop/Left
clientTop = docElem.clientTop || body.clientTop || 0;
clientLeft = docElem.clientLeft || body.clientLeft || 0;
// Determine correct scrollTop/Left
scrollTop = ( global.pageYOffset && docElem.scrollTop || body.scrollTop );
scrollLeft = ( global.pageXOffset && docElem.scrollLeft || body.scrollLeft );
// Temp top/left
top = Math.ceil( clientRect.top + scrollTop - clientTop );
left = Math.ceil( clientRect.left + scrollLeft - clientLeft );
for ( var p in clientRect ) {
bounds[ p ] = Math.round( clientRect[ p ] );
}
return Popcorn.extend({}, bounds, { top: top, left: left });
2010-12-04 23:54:38 +03:00
}
});
Popcorn.Events = {
2011-02-14 21:38:50 +03:00
UIEvents: "blur focus focusin focusout load resize scroll unload ",
MouseEvents: "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave click dblclick",
Events: "loadstart progress suspend emptied stalled play pause " +
"loadedmetadata loadeddata waiting playing canplay canplaythrough " +
"seeking seeked timeupdate ended ratechange durationchange volumechange"
};
2011-02-14 21:38:50 +03:00
Popcorn.Events.Natives = Popcorn.Events.UIEvents + " " +
Popcorn.Events.MouseEvents + " " +
2010-12-15 23:56:06 +03:00
Popcorn.Events.Events;
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
Popcorn.events = {
2011-02-14 21:38:50 +03:00
isNative: function( type ) {
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
var checks = Popcorn.Events.Natives.split( /\s+/g );
2011-02-14 21:38:50 +03:00
for ( var i = 0; i < checks.length; i++ ) {
if ( checks[i] === type ) {
return true;
}
}
2011-02-14 21:38:50 +03:00
return false;
2011-02-14 21:38:50 +03:00
},
getInterface: function( type ) {
2011-02-14 21:38:50 +03:00
if ( !Popcorn.events.isNative( type ) ) {
return false;
}
2011-02-14 21:38:50 +03:00
var natives = Popcorn.Events,
2011-03-18 18:33:05 +03:00
proto;
2011-02-14 21:38:50 +03:00
for ( var p in natives ) {
2011-03-18 18:33:05 +03:00
if ( p !== "Natives" && natives[ p ].indexOf( type ) > -1 ) {
proto = p;
}
}
2011-02-14 21:38:50 +03:00
return proto;
2011-02-14 21:38:50 +03:00
},
2011-03-18 18:33:05 +03:00
// Compile all native events to single array
2011-02-14 21:38:50 +03:00
all: Popcorn.Events.Natives.split(/\s+/g),
2011-03-18 18:33:05 +03:00
// Defines all Event handling static functions
2010-12-04 23:54:38 +03:00
fn: {
trigger: function ( type, data ) {
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
// setup checks for custom event system
2011-03-18 18:33:05 +03:00
if ( this.data.events[ type ] && Popcorn.sizeOf( this.data.events[ type ] ) ) {
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
var eventInterface = Popcorn.events.getInterface( type );
2011-02-14 21:38:50 +03:00
if ( eventInterface ) {
2011-02-14 21:38:50 +03:00
var evt = document.createEvent( eventInterface );
2011-02-14 21:38:50 +03:00
evt.initEvent(type, true, true, global, 1);
2011-03-24 17:09:20 +03:00
this.media.dispatchEvent(evt);
2011-02-14 21:38:50 +03:00
return this;
2011-02-14 21:38:50 +03:00
}
2011-02-14 21:38:50 +03:00
// Custom events
2011-03-18 18:33:05 +03:00
Popcorn.forEach(this.data.events[ type ], function ( obj, key ) {
2010-12-04 23:54:38 +03:00
obj.call( this, data );
2011-02-14 21:38:50 +03:00
}, this);
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
}
2011-02-14 21:38:50 +03:00
return this;
2011-02-14 21:38:50 +03:00
},
2010-12-04 23:54:38 +03:00
listen: function ( type, fn ) {
2011-02-14 21:38:50 +03:00
2010-12-20 18:59:32 +03:00
var self = this, hasEvents = true;
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
if ( !this.data.events[type] ) {
this.data.events[type] = {};
hasEvents = false;
}
2011-02-14 21:38:50 +03:00
// Register
2011-03-18 18:33:05 +03:00
this.data.events[ type ][ fn.name || ( fn.toString() + Popcorn.guid() ) ] = fn;
2011-02-14 21:38:50 +03:00
// only attach one event of any type
if ( !hasEvents && Popcorn.events.all.indexOf( type ) > -1 ) {
2010-12-04 23:54:38 +03:00
2011-03-24 17:09:20 +03:00
this.media.addEventListener( type, function( event ) {
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
Popcorn.forEach( self.data.events[type], function ( obj, key ) {
2010-12-06 00:07:39 +03:00
if ( typeof obj === "function" ) {
obj.call(self, event);
}
2010-12-04 23:54:38 +03:00
});
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
//fn.call( self, event );
2011-02-14 21:38:50 +03:00
}, false);
2010-12-04 23:54:38 +03:00
}
return this;
2011-02-14 21:38:50 +03:00
},
2010-12-06 00:07:39 +03:00
unlisten: function( type, fn ) {
2011-02-14 21:38:50 +03:00
2010-12-06 00:07:39 +03:00
if ( this.data.events[type] && this.data.events[type][fn] ) {
2011-02-14 21:38:50 +03:00
delete this.data.events[type][ fn ];
2011-02-14 21:38:50 +03:00
2010-12-06 00:07:39 +03:00
return this;
}
2011-02-14 21:38:50 +03:00
2010-12-04 23:54:38 +03:00
this.data.events[type] = null;
return this;
2010-12-04 23:54:38 +03:00
}
}
};
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
// Extend Popcorn.events.fns (listen, unlisten, trigger) to all Popcorn instances
2010-12-14 00:38:57 +03:00
Popcorn.forEach( ["trigger", "listen", "unlisten"], function ( key ) {
2011-03-18 18:33:05 +03:00
Popcorn.p[ key ] = Popcorn.events.fn[ key ];
2011-02-14 21:38:50 +03:00
});
// Protected API methods
Popcorn.protect = {
natives: "load play pause currentTime playbackRate mute volume duration removePlugin roundTime trigger listen unlisten".toLowerCase().split(/\s+/)
};
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
// Internal Only
2010-12-16 21:44:19 +03:00
Popcorn.addTrackEvent = function( obj, track ) {
2011-02-14 21:38:50 +03:00
if ( track._natives ) {
2011-03-18 18:33:05 +03:00
// Supports user defined track event id
track._id = !track.id ? Popcorn.guid( track._natives.type ) : track.id;
2010-12-16 21:44:19 +03:00
// Push track event ids into the history
2011-02-14 21:38:50 +03:00
obj.data.history.push( track._id );
track._natives.start = track._natives.start || Popcorn.nop;
track._natives.end = track._natives.end || Popcorn.nop;
2010-12-16 21:44:19 +03:00
}
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
// Store this definition in an array sorted by times
2010-12-16 21:44:19 +03:00
obj.data.trackEvents.byStart.push( track );
obj.data.trackEvents.byEnd.push( track );
obj.data.trackEvents.byStart.sort( function( a, b ){
return ( a.start - b.start );
});
obj.data.trackEvents.byEnd.sort( function( a, b ){
return ( a.end - b.end );
});
};
2011-03-18 18:33:05 +03:00
// removePlugin( type ) removes all tracks of that from all instances of popcorn
// removePlugin( obj, type ) removes all tracks of type from obj, where obj is a single instance of popcorn
2011-02-16 00:55:52 +03:00
Popcorn.removePlugin = function( obj, name ) {
2011-03-18 18:33:05 +03:00
// Check if we are removing plugin from an instance or from all of Popcorn
2011-02-16 00:55:52 +03:00
if ( !name ) {
2011-03-18 18:33:05 +03:00
// Fix the order
2011-02-16 00:55:52 +03:00
name = obj;
obj = Popcorn.p;
2011-03-18 18:33:05 +03:00
var registryLen = Popcorn.registry.length,
registryIdx;
2011-02-16 00:55:52 +03:00
// remove plugin reference from registry
2011-03-18 18:33:05 +03:00
for ( registryIdx = 0; registryIdx < registryLen; registryIdx++ ) {
if ( Popcorn.registry[ registryIdx ].type === name ) {
Popcorn.registry.splice( registryIdx, 1 );
2011-02-16 00:55:52 +03:00
// delete the plugin
delete obj[ name ];
// plugin found and removed, stop checking, we are done
return;
}
}
}
var byStart = obj.data.trackEvents.byStart,
byEnd = obj.data.trackEvents.byEnd,
2011-02-16 00:55:52 +03:00
idx, sl;
// remove all trackEvents
for ( idx = 0, sl = byStart.length; idx < sl; idx++ ) {
if ( ( byStart[ idx ] && byStart[ idx ]._natives && byStart[ idx ]._natives.type === name ) &&
2011-02-16 00:55:52 +03:00
( byEnd[ idx ] && byEnd[ idx ]._natives && byEnd[ idx ]._natives.type === name ) ) {
2011-02-16 00:55:52 +03:00
byStart.splice( idx, 1 );
byEnd.splice( idx, 1 );
2011-02-16 00:55:52 +03:00
// update for loop if something removed, but keep checking
idx--; sl--;
if ( obj.data.trackEvents.startIndex <= idx ) {
obj.data.trackEvents.startIndex--;
obj.data.trackEvents.endIndex--;
}
}
}
};
2010-12-16 21:44:19 +03:00
Popcorn.removeTrackEvent = function( obj, trackId ) {
2011-02-14 21:38:50 +03:00
var historyLen = obj.data.history.length,
indexWasAt = 0,
byStart = [],
byEnd = [],
history = [];
2011-03-18 18:33:05 +03:00
Popcorn.forEach( obj.data.trackEvents.byStart, function( o, i, context ) {
2010-12-16 21:44:19 +03:00
// Preserve the original start/end trackEvents
if ( !o._id ) {
byStart.push( obj.data.trackEvents.byStart[i] );
byEnd.push( obj.data.trackEvents.byEnd[i] );
2011-02-14 21:38:50 +03:00
}
// Filter for user track events (vs system track events)
if ( o._id ) {
2011-02-14 21:38:50 +03:00
// Filter for the trackevent to remove
if ( o._id !== trackId ) {
byStart.push( obj.data.trackEvents.byStart[i] );
byEnd.push( obj.data.trackEvents.byEnd[i] );
2011-02-14 21:38:50 +03:00
}
// Capture the position of the track being removed.
if ( o._id === trackId ) {
indexWasAt = i;
2011-02-14 21:38:50 +03:00
}
2010-12-16 21:44:19 +03:00
}
});
2011-02-14 21:38:50 +03:00
// Update
if ( indexWasAt <= obj.data.trackEvents.startIndex ) {
obj.data.trackEvents.startIndex--;
}
if ( indexWasAt <= obj.data.trackEvents.endIndex ) {
obj.data.trackEvents.endIndex--;
}
2011-02-14 21:38:50 +03:00
2010-12-16 21:44:19 +03:00
obj.data.trackEvents.byStart = byStart;
obj.data.trackEvents.byEnd = byEnd;
for ( var i = 0; i < historyLen; i++ ) {
if ( obj.data.history[i] !== trackId ) {
history.push( obj.data.history[i] );
}
2011-02-14 21:38:50 +03:00
}
2010-12-16 21:44:19 +03:00
obj.data.history = history;
};
2011-02-14 21:38:50 +03:00
2010-12-16 21:44:19 +03:00
Popcorn.getTrackEvents = function( obj ) {
2011-02-14 21:38:50 +03:00
2010-12-16 21:44:19 +03:00
var trackevents = [];
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
Popcorn.forEach( obj.data.trackEvents.byStart, function( o, i, context ) {
2010-12-16 21:44:19 +03:00
if ( o._id ) {
trackevents.push(o);
2011-02-14 21:38:50 +03:00
}
2010-12-16 21:44:19 +03:00
});
2011-02-14 21:38:50 +03:00
2010-12-16 21:44:19 +03:00
return trackevents;
};
2011-02-14 21:38:50 +03:00
2010-12-16 21:44:19 +03:00
Popcorn.getLastTrackEventId = function( obj ) {
return obj.data.history[ obj.data.history.length - 1 ];
};
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
// Map and Extend TrackEvent functions to all Popcorn instances
2010-12-16 21:44:19 +03:00
Popcorn.extend( Popcorn.p, {
2011-02-14 21:38:50 +03:00
2010-12-16 21:44:19 +03:00
getTrackEvents: function() {
return Popcorn.getTrackEvents.call( null, this );
},
2011-02-14 21:38:50 +03:00
2010-12-16 21:44:19 +03:00
getLastTrackEventId: function() {
return Popcorn.getLastTrackEventId.call( null, this );
2011-02-14 21:38:50 +03:00
},
2010-12-16 21:44:19 +03:00
removeTrackEvent: function( id ) {
Popcorn.removeTrackEvent.call( null, this, id );
return this;
},
2011-02-16 00:55:52 +03:00
removePlugin: function( name ) {
Popcorn.removePlugin.call( null, this, name );
return this;
2010-12-16 21:44:19 +03:00
}
2011-02-14 21:38:50 +03:00
2010-12-16 21:44:19 +03:00
});
2011-02-14 21:38:50 +03:00
// Plugin manifests
Popcorn.manifest = {};
2011-02-14 21:38:50 +03:00
// Plugins are registered
2010-12-04 23:54:38 +03:00
Popcorn.registry = [];
2011-02-14 21:38:50 +03:00
// An interface for extending Popcorn
2010-12-04 23:54:38 +03:00
// with plugin functionality
2011-02-14 21:38:50 +03:00
Popcorn.plugin = function( name, definition, manifest ) {
2010-12-04 23:54:38 +03:00
if ( Popcorn.protect.natives.indexOf( name.toLowerCase() ) >= 0 ) {
Popcorn.error("'" + name + "' is a protected function name");
return;
}
2010-12-04 23:54:38 +03:00
// Provides some sugar, but ultimately extends
2011-02-14 21:38:50 +03:00
// the definition into Popcorn.p
2011-02-23 07:30:20 +03:00
var reserved = [ "start", "end" ],
2011-01-19 22:10:06 +03:00
plugin = {},
2011-02-24 00:19:09 +03:00
setup,
isfn = typeof definition === "function";
2011-02-14 21:38:50 +03:00
2011-02-24 20:46:19 +03:00
// If `manifest` arg is undefined, check for manifest within the `definition` object
// If no `definition.manifest`, an empty object is a sufficient fallback
if ( !manifest ) {
manifest = definition.manifest || {};
}
2011-02-24 20:46:19 +03:00
var pluginFn = function( setup, options ) {
2011-02-14 21:38:50 +03:00
if ( !options ) {
return this;
2011-02-14 21:38:50 +03:00
}
2011-02-23 07:30:20 +03:00
// Storing the plugin natives
options._natives = setup;
options._natives.type = name;
options._running = false;
2011-02-23 07:30:20 +03:00
// Ensure a manifest object, an empty object is a sufficient fallback
options._natives.manifest = manifest;
// Checks for expected properties
if ( !( "start" in options ) ) {
options.start = 0;
}
if ( !( "end" in options ) ) {
options.end = this.duration();
}
2011-02-14 21:38:50 +03:00
// If a _setup was declared, then call it before
// the events commence
if ( "_setup" in setup && typeof setup._setup === "function" ) {
2011-02-14 21:38:50 +03:00
// Resolves 239, 241, 242
2011-02-23 07:16:29 +03:00
if ( !options.target ) {
2011-02-24 20:46:19 +03:00
// Sometimes the manifest may be missing entirely
2011-02-24 20:46:19 +03:00
// or it has an options object that doesn't have a `target` property
var manifestopts = "options" in manifest && manifest.options;
options.target = manifestopts && "target" in manifestopts && manifestopts.target;
2010-12-05 04:01:40 +03:00
}
setup._setup.call( this, options );
}
2010-12-10 19:53:47 +03:00
Popcorn.addTrackEvent( this, options );
2010-12-10 19:53:47 +03:00
2011-02-14 21:38:50 +03:00
// Future support for plugin event definitions
// for all of the native events
Popcorn.forEach( setup, function ( callback, type ) {
2011-02-14 21:38:50 +03:00
if ( type !== "type" ) {
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
if ( reserved.indexOf( type ) === -1 ) {
this.listen( type, callback );
}
}
2011-02-14 21:38:50 +03:00
}, this);
2011-02-14 21:38:50 +03:00
return this;
};
2011-02-14 21:38:50 +03:00
// Augment the manifest object
2011-02-23 07:16:29 +03:00
if ( manifest || ( "manifest" in definition ) ) {
2011-02-14 21:38:50 +03:00
Popcorn.manifest[ name ] = manifest || definition.manifest;
}
2011-02-14 21:38:50 +03:00
// Assign new named definition
2011-02-23 07:16:29 +03:00
plugin[ name ] = function( options ) {
return pluginFn.call( this, isfn ? definition.call( this, options ) : definition,
2011-03-18 18:33:05 +03:00
options );
2011-02-23 07:16:29 +03:00
};
2011-02-14 21:38:50 +03:00
// Extend Popcorn.p with new named definition
2010-12-04 23:54:38 +03:00
Popcorn.extend( Popcorn.p, plugin );
2011-02-14 21:38:50 +03:00
// Push into the registry
Popcorn.registry.push(
2011-03-18 18:33:05 +03:00
Popcorn.extend( plugin, {
type: name
})
2011-03-18 18:33:05 +03:00
);
2011-02-14 21:38:50 +03:00
return plugin;
2010-12-04 23:54:38 +03:00
};
2011-02-14 21:38:50 +03:00
// stores parsers keyed on filetype
Popcorn.parsers = {};
// An interface for extending Popcorn
// with parser functionality
Popcorn.parser = function( name, type, definition ) {
if ( Popcorn.protect.natives.indexOf( name.toLowerCase() ) >= 0 ) {
Popcorn.error("'" + name + "' is a protected function name");
return;
}
// fixes parameters for overloaded function call
if ( typeof type === "function" && !definition ) {
definition = type;
type = "";
}
if ( typeof definition !== "function" || typeof type !== "string" ) {
return;
}
// Provides some sugar, but ultimately extends
// the definition into Popcorn.p
2011-02-14 21:38:50 +03:00
var natives = Popcorn.events.all,
parseFn,
parser = {};
parseFn = function ( filename, callback ) {
if ( !filename ) {
return this;
}
var that = this;
Popcorn.xhr({
url: filename,
dataType: type,
success: function( data ) {
2011-02-14 21:38:50 +03:00
var tracksObject = definition( data ),
tracksData,
tracksDataLen,
tracksDef,
idx = 0;
2011-02-14 21:38:50 +03:00
tracksData = tracksObject.data || [];
tracksDataLen = tracksData.length;
tracksDef = null;
2011-02-14 21:38:50 +03:00
// If no tracks to process, return immediately
if ( !tracksDataLen ) {
return;
}
2011-02-14 21:38:50 +03:00
// Create tracks out of parsed object
for ( ; idx < tracksDataLen; idx++ ) {
2011-02-14 21:38:50 +03:00
tracksDef = tracksData[ idx ];
2011-02-14 21:38:50 +03:00
for ( var key in tracksDef ) {
if ( hasOwn.call( tracksDef, key ) && !!that[ key ] ) {
2011-02-14 21:38:50 +03:00
that[ key ]( tracksDef[ key ] );
}
}
}
if ( callback ) {
callback();
}
}
});
return this;
};
// Assign new named definition
parser[ name ] = parseFn;
2011-02-14 21:38:50 +03:00
// Extend Popcorn.p with new named definition
Popcorn.extend( Popcorn.p, parser );
2011-02-14 21:38:50 +03:00
// keys the function name by filetype extension
//Popcorn.parsers[ name ] = true;
return parser;
};
// Cache references to reused RegExps
var rparams = /\?/,
// XHR Setup object
setup = {
2010-12-15 22:32:48 +03:00
url: '',
data: '',
dataType: '',
success: Popcorn.nop,
type: 'GET',
2011-02-14 21:38:50 +03:00
async: true,
2010-12-15 22:32:48 +03:00
xhr: function() {
2010-12-20 18:59:32 +03:00
return new global.XMLHttpRequest();
2010-12-15 22:32:48 +03:00
}
2011-02-14 21:38:50 +03:00
};
2010-12-15 22:32:48 +03:00
Popcorn.xhr = function ( options ) {
options.dataType = options.dataType && options.dataType.toLowerCase() || null;
if ( options.dataType &&
( options.dataType === "jsonp" ||
options.dataType === "script" ) ) {
2011-01-20 20:20:06 +03:00
2011-02-14 21:38:50 +03:00
Popcorn.xhr.getJSONP(
options.url,
options.success,
options.dataType === "script"
);
return;
}
2011-02-14 21:38:50 +03:00
2010-12-15 22:32:48 +03:00
var settings = Popcorn.extend( {}, setup, options );
2011-02-14 21:38:50 +03:00
// Create new XMLHttpRequest object
2010-12-15 22:32:48 +03:00
settings.ajax = settings.xhr();
2011-02-14 21:38:50 +03:00
2010-12-15 22:32:48 +03:00
if ( settings.ajax ) {
2011-02-14 21:38:50 +03:00
if ( settings.type === "GET" && settings.data ) {
2011-02-14 21:38:50 +03:00
// append query string
2011-03-18 18:33:05 +03:00
settings.url += ( rparams.test( settings.url ) ? "&" : "?" ) + settings.data;
2011-02-14 21:38:50 +03:00
// Garbage collect and reset settings.data
settings.data = null;
2011-02-14 21:38:50 +03:00
}
2010-12-15 22:32:48 +03:00
2011-02-14 21:38:50 +03:00
settings.ajax.open( settings.type, settings.url, settings.async );
2011-03-01 23:33:12 +03:00
settings.ajax.send( settings.data || null );
2010-12-15 22:32:48 +03:00
return Popcorn.xhr.httpData( settings );
2011-02-14 21:38:50 +03:00
}
2010-12-15 22:32:48 +03:00
};
2011-02-14 21:38:50 +03:00
2010-12-15 22:32:48 +03:00
Popcorn.xhr.httpData = function ( settings ) {
2011-02-14 21:38:50 +03:00
var data, json = null;
2010-12-20 18:59:32 +03:00
settings.ajax.onreadystatechange = function() {
2010-12-15 22:32:48 +03:00
2011-02-14 21:38:50 +03:00
if ( settings.ajax.readyState === 4 ) {
2010-12-15 22:32:48 +03:00
try {
json = JSON.parse(settings.ajax.responseText);
} catch(e) {
//suppress
}
2010-12-15 22:32:48 +03:00
data = {
2011-02-14 21:38:50 +03:00
xml: settings.ajax.responseXML,
text: settings.ajax.responseText,
2010-12-15 22:32:48 +03:00
json: json
};
2011-02-14 21:38:50 +03:00
// If a dataType was specified, return that type of data
if ( settings.dataType ) {
data = data[ settings.dataType ];
}
2011-02-14 21:38:50 +03:00
2010-12-15 22:32:48 +03:00
settings.success.call( settings.ajax, data );
2011-02-14 21:38:50 +03:00
}
};
return data;
2010-12-15 22:32:48 +03:00
};
2011-02-16 01:54:51 +03:00
Popcorn.xhr.getJSONP = function ( url, success, isScript ) {
2011-02-16 01:54:51 +03:00
// If this is a script request, ensure that we do not call something that has already been loaded
if ( isScript ) {
2011-02-16 01:54:51 +03:00
var scripts = document.querySelectorAll('script[src="' + url + '"]');
2011-03-18 18:33:05 +03:00
// If there are scripts with this url loaded, early return
2011-02-16 01:54:51 +03:00
if ( scripts.length ) {
2011-02-16 01:54:51 +03:00
// Execute success callback and pass "exists" flag
success && success( true );
return;
}
}
2011-02-14 21:38:50 +03:00
2011-03-18 18:33:05 +03:00
var head = document.head || document.getElementsByTagName("head")[0] || document.documentElement,
script = document.createElement("script"),
paramStr = url.split("?")[1],
isFired = false,
params = [],
2011-02-17 00:47:47 +03:00
callback, parts, callparam;
2011-02-16 01:54:51 +03:00
if ( paramStr && !isScript ) {
params = paramStr.split("&");
}
2011-02-14 21:38:50 +03:00
2011-02-17 00:47:47 +03:00
if ( params.length ) {
parts = params[ params.length - 1 ].split("=");
}
2011-03-18 18:33:05 +03:00
callback = params.length ? ( parts[1] ? parts[1] : parts[0] ) : "jsonp";
2011-02-16 01:54:51 +03:00
if ( !paramStr && !isScript ) {
url += "?callback=" + callback;
}
2011-02-14 21:38:50 +03:00
2011-02-16 01:54:51 +03:00
if ( callback && !isScript ) {
2011-03-18 18:33:05 +03:00
// If a callback name already exists
2011-02-17 00:47:47 +03:00
if ( !!window[ callback ] ) {
2011-03-18 18:33:05 +03:00
// Create a new unique callback name
2011-02-17 00:47:47 +03:00
callback = Popcorn.guid( callback );
}
2011-03-18 18:33:05 +03:00
// Define the JSONP success callback globally
window[ callback ] = function ( data ) {
2011-02-16 01:54:51 +03:00
success && success( data );
isFired = true;
2011-02-16 01:54:51 +03:00
};
2011-03-18 18:33:05 +03:00
2011-02-17 00:47:47 +03:00
// Replace callback param and callback name
url = url.replace( parts.join("="), parts[0] + "=" + callback );
2011-03-18 18:33:05 +03:00
}
2011-03-18 18:33:05 +03:00
script.onload = script.onreadystatechange = function() {
if ( !script.readyState || /loaded|complete/.test( script.readyState ) ) {
2011-02-16 01:54:51 +03:00
// Handling remote script loading callbacks
if ( isScript ) {
2011-02-16 01:54:51 +03:00
// getScript
success && success();
}
2011-02-16 01:54:51 +03:00
// Executing for JSONP requests
if ( isFired ) {
// Garbage collect the callback
delete window[ callback ];
2011-03-18 18:33:05 +03:00
// Garbage collect the script resource
head.removeChild( script );
}
}
2011-03-18 18:33:05 +03:00
};
script.src = url;
head.insertBefore( script, head.firstChild );
2011-03-18 18:33:05 +03:00
2011-02-16 01:54:51 +03:00
return;
};
2011-03-18 18:33:05 +03:00
2011-02-16 01:54:51 +03:00
Popcorn.getJSONP = Popcorn.xhr.getJSONP;
2011-03-18 18:33:05 +03:00
2011-02-16 01:54:51 +03:00
Popcorn.getScript = Popcorn.xhr.getScript = function( url, success ) {
return Popcorn.xhr.getJSONP( url, success, true );
};
2011-01-20 20:20:06 +03:00
2011-02-16 01:54:51 +03:00
2010-12-20 18:59:32 +03:00
// Exposes Popcorn to global context
2010-12-04 23:54:38 +03:00
global.Popcorn = Popcorn;
2011-02-08 23:58:30 +03:00
2011-03-25 00:34:54 +03:00
document.addEventListener( "DOMContentLoaded", function() {
// Supports non-specific elements
2011-03-25 00:34:54 +03:00
var dataAttr = "data-timeline-sources",
medias = document.querySelectorAll( "[" + dataAttr + "]" );
2011-03-24 17:09:20 +03:00
Popcorn.forEach( medias, function( idx, key ) {
2011-01-05 20:22:54 +03:00
2011-03-24 17:09:20 +03:00
var media = medias[ key ],
2011-02-08 23:58:30 +03:00
hasDataSources = false,
2011-03-24 17:09:20 +03:00
dataSources, data, popcornMedia;
2011-02-08 23:58:30 +03:00
// Ensure that the DOM has an id
2011-03-24 17:09:20 +03:00
if ( !media.id ) {
2011-02-08 23:58:30 +03:00
2011-03-24 17:09:20 +03:00
media.id = Popcorn.guid( "__popcorn" );
2011-02-08 23:58:30 +03:00
}
2011-02-14 21:38:50 +03:00
2011-02-08 23:58:30 +03:00
// Ensure we're looking at a dom node
2011-03-24 17:09:20 +03:00
if ( media.nodeType && media.nodeType === 1 ) {
2011-02-14 21:38:50 +03:00
2011-03-24 17:09:20 +03:00
popcornMedia = Popcorn( "#" + media.id );
dataSources = ( media.getAttribute( dataAttr ) || "" ).split(",");
if ( dataSources[ 0 ] ) {
2011-03-24 17:09:20 +03:00
Popcorn.forEach( dataSources, function( source ) {
// split the parser and data as parser:file
data = source.split( ":" );
// if no parser is defined for the file, assume "parse" + file extension
if ( data.length === 1 ) {
2011-02-08 23:58:30 +03:00
data = source.split( "." );
data[ 0 ] = "parse" + data[ data.length - 1 ].toUpperCase();
data[ 1 ] = source;
2011-03-18 18:33:05 +03:00
2011-01-18 00:07:51 +03:00
}
2011-02-08 23:58:30 +03:00
2011-03-24 17:09:20 +03:00
// If the media has data sources and the correct parser is registered, continue to load
if ( dataSources[ 0 ] && popcornMedia[ data[ 0 ] ] ) {
2011-03-24 17:09:20 +03:00
// Set up the media and load in the datasources
popcornMedia[ data[ 0 ] ]( data[ 1 ] );
}
});
2011-02-14 21:38:50 +03:00
}
2011-03-24 17:09:20 +03:00
// Only play the media if it was specified to do so
if ( !!popcornMedia.autoplay ) {
popcornMedia.play();
2011-02-14 21:38:50 +03:00
}
}
});
}, false );
2011-01-05 20:22:54 +03:00
2011-02-16 00:55:52 +03:00
})(window, window.document);