dashjs
Version:
A reference client implementation for the playback of MPEG DASH via Javascript and compliant browsers.
935 lines (790 loc) • 38.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>dash.js Source: offline/OfflineDownload.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.spacelab.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">dash.js</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="module-DashAdapter.html">DashAdapter</a></li><li><a href="module-DashMetrics.html">DashMetrics</a></li><li><a href="module-MediaPlayer.html">MediaPlayer</a></li><li><a href="module-OfflineController.html">OfflineController</a></li><li><a href="module-ProtectionController.html">ProtectionController</a></li><li><a href="module-Settings.html">Settings</a></li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="Errors.html">Errors</a></li><li><a href="MediaPlayerEvents.html">MediaPlayerEvents</a></li><li><a href="MediaPlayerModel.html">MediaPlayerModel</a></li><li><a href="MetricsReportingEvents.html">MetricsReportingEvents</a></li><li><a href="MssErrors.html">MssErrors</a></li><li><a href="OfflineErrors.html">OfflineErrors</a></li><li><a href="OfflineEvents.html">OfflineEvents</a></li><li><a href="ProtectionErrors.html">ProtectionErrors</a></li><li><a href="ProtectionEvents.html">ProtectionEvents</a></li>
</ul>
</li>
<li class="dropdown">
<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="MediaPlayerEvents.html#event:ADAPTATION_SET_REMOVED_NO_CAPABILITIES">MediaPlayerEvents#event:ADAPTATION_SET_REMOVED_NO_CAPABILITIES</a></li><li><a href="MediaPlayerEvents.html#event:AST_IN_FUTURE">MediaPlayerEvents#event:AST_IN_FUTURE</a></li><li><a href="MediaPlayerEvents.html#event:BUFFER_EMPTY">MediaPlayerEvents#event:BUFFER_EMPTY</a></li><li><a href="MediaPlayerEvents.html#event:BUFFER_LEVEL_STATE_CHANGED">MediaPlayerEvents#event:BUFFER_LEVEL_STATE_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:BUFFER_LEVEL_UPDATED">MediaPlayerEvents#event:BUFFER_LEVEL_UPDATED</a></li><li><a href="MediaPlayerEvents.html#event:BUFFER_LOADED">MediaPlayerEvents#event:BUFFER_LOADED</a></li><li><a href="MediaPlayerEvents.html#event:CAN_PLAY">MediaPlayerEvents#event:CAN_PLAY</a></li><li><a href="MediaPlayerEvents.html#event:CAN_PLAY_THROUGH">MediaPlayerEvents#event:CAN_PLAY_THROUGH</a></li><li><a href="MediaPlayerEvents.html#event:CAPTION_CONTAINER_RESIZE">MediaPlayerEvents#event:CAPTION_CONTAINER_RESIZE</a></li><li><a href="MediaPlayerEvents.html#event:CAPTION_RENDERED">MediaPlayerEvents#event:CAPTION_RENDERED</a></li><li><a href="MediaPlayerEvents.html#event:CONFORMANCE_VIOLATION">MediaPlayerEvents#event:CONFORMANCE_VIOLATION</a></li><li><a href="MediaPlayerEvents.html#event:CONTENT_STEERING_REQUEST_COMPLETED">MediaPlayerEvents#event:CONTENT_STEERING_REQUEST_COMPLETED</a></li><li><a href="MediaPlayerEvents.html#event:DYNAMIC_TO_STATIC">MediaPlayerEvents#event:DYNAMIC_TO_STATIC</a></li><li><a href="MediaPlayerEvents.html#event:ERROR">MediaPlayerEvents#event:ERROR</a></li><li><a href="MediaPlayerEvents.html#event:EVENT_MODE_ON_RECEIVE">MediaPlayerEvents#event:EVENT_MODE_ON_RECEIVE</a></li><li><a href="MediaPlayerEvents.html#event:EVENT_MODE_ON_START">MediaPlayerEvents#event:EVENT_MODE_ON_START</a></li><li><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_ABANDONED">MediaPlayerEvents#event:FRAGMENT_LOADING_ABANDONED</a></li><li><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_COMPLETED">MediaPlayerEvents#event:FRAGMENT_LOADING_COMPLETED</a></li><li><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_PROGRESS">MediaPlayerEvents#event:FRAGMENT_LOADING_PROGRESS</a></li><li><a href="MediaPlayerEvents.html#event:FRAGMENT_LOADING_STARTED">MediaPlayerEvents#event:FRAGMENT_LOADING_STARTED</a></li><li><a href="MediaPlayerEvents.html#event:LOG">MediaPlayerEvents#event:LOG</a></li><li><a href="MediaPlayerEvents.html#event:MANIFEST_LOADED">MediaPlayerEvents#event:MANIFEST_LOADED</a></li><li><a href="MediaPlayerEvents.html#event:MANIFEST_VALIDITY_CHANGED">MediaPlayerEvents#event:MANIFEST_VALIDITY_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:METRIC_ADDED">MediaPlayerEvents#event:METRIC_ADDED</a></li><li><a href="MediaPlayerEvents.html#event:METRIC_CHANGED">MediaPlayerEvents#event:METRIC_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:METRIC_UPDATED">MediaPlayerEvents#event:METRIC_UPDATED</a></li><li><a href="MediaPlayerEvents.html#event:METRICS_CHANGED">MediaPlayerEvents#event:METRICS_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:PERIOD_SWITCH_COMPLETED">MediaPlayerEvents#event:PERIOD_SWITCH_COMPLETED</a></li><li><a href="MediaPlayerEvents.html#event:PERIOD_SWITCH_STARTED">MediaPlayerEvents#event:PERIOD_SWITCH_STARTED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_ENDED">MediaPlayerEvents#event:PLAYBACK_ENDED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_ERROR">MediaPlayerEvents#event:PLAYBACK_ERROR</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_LOADED_DATA">MediaPlayerEvents#event:PLAYBACK_LOADED_DATA</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_METADATA_LOADED">MediaPlayerEvents#event:PLAYBACK_METADATA_LOADED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_NOT_ALLOWED">MediaPlayerEvents#event:PLAYBACK_NOT_ALLOWED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_PAUSED">MediaPlayerEvents#event:PLAYBACK_PAUSED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_PLAYING">MediaPlayerEvents#event:PLAYBACK_PLAYING</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_PROGRESS">MediaPlayerEvents#event:PLAYBACK_PROGRESS</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_RATE_CHANGED">MediaPlayerEvents#event:PLAYBACK_RATE_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_SEEKED">MediaPlayerEvents#event:PLAYBACK_SEEKED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_SEEKING">MediaPlayerEvents#event:PLAYBACK_SEEKING</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_STALLED">MediaPlayerEvents#event:PLAYBACK_STALLED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_STARTED">MediaPlayerEvents#event:PLAYBACK_STARTED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_TIME_UPDATED">MediaPlayerEvents#event:PLAYBACK_TIME_UPDATED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_VOLUME_CHANGED">MediaPlayerEvents#event:PLAYBACK_VOLUME_CHANGED</a></li><li><a href="MediaPlayerEvents.html#event:PLAYBACK_WAITING">MediaPlayerEvents#event:PLAYBACK_WAITING</a></li><li><a href="MediaPlayerEvents.html#event:QUALITY_CHANGE_RENDERED">MediaPlayerEvents#event:QUALITY_CHANGE_RENDERED</a></li><li><a href="MediaPlayerEvents.html#event:QUALITY_CHANGE_REQUESTED">MediaPlayerEvents#event:QUALITY_CHANGE_REQUESTED</a></li><li><a href="MediaPlayerEvents.html#event:REPRESENTATION_SWITCH">MediaPlayerEvents#event:REPRESENTATION_SWITCH</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_ACTIVATED">MediaPlayerEvents#event:STREAM_ACTIVATED</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_DEACTIVATED">MediaPlayerEvents#event:STREAM_DEACTIVATED</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_INITIALIZED">MediaPlayerEvents#event:STREAM_INITIALIZED</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_INITIALIZING">MediaPlayerEvents#event:STREAM_INITIALIZING</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_TEARDOWN_COMPLETE">MediaPlayerEvents#event:STREAM_TEARDOWN_COMPLETE</a></li><li><a href="MediaPlayerEvents.html#event:STREAM_UPDATED">MediaPlayerEvents#event:STREAM_UPDATED</a></li><li><a href="MediaPlayerEvents.html#event:TEXT_TRACK_ADDED">MediaPlayerEvents#event:TEXT_TRACK_ADDED</a></li><li><a href="MediaPlayerEvents.html#event:TEXT_TRACKS_ADDED">MediaPlayerEvents#event:TEXT_TRACKS_ADDED</a></li><li><a href="MediaPlayerEvents.html#event:TRACK_CHANGE_RENDERED">MediaPlayerEvents#event:TRACK_CHANGE_RENDERED</a></li><li><a href="MediaPlayerEvents.html#event:TTML_PARSED">MediaPlayerEvents#event:TTML_PARSED</a></li><li><a href="MediaPlayerEvents.html#event:TTML_TO_PARSE">MediaPlayerEvents#event:TTML_TO_PARSE</a></li><li><a href="MetricsReportingEvents.html#event:CMCD_DATA_GENERATED">MetricsReportingEvents#event:CMCD_DATA_GENERATED</a></li><li><a href="OfflineEvents.html#event:OFFLINE_RECORD_FINISHED">OfflineEvents#event:OFFLINE_RECORD_FINISHED</a></li><li><a href="OfflineEvents.html#event:OFFLINE_RECORD_LOADEDMETADATA">OfflineEvents#event:OFFLINE_RECORD_LOADEDMETADATA</a></li><li><a href="OfflineEvents.html#event:OFFLINE_RECORD_STARTED">OfflineEvents#event:OFFLINE_RECORD_STARTED</a></li><li><a href="OfflineEvents.html#event:OFFLINE_RECORD_STOPPED">OfflineEvents#event:OFFLINE_RECORD_STOPPED</a></li><li><a href="ProtectionEvents.html#event:KEY_ADDED">ProtectionEvents#event:KEY_ADDED</a></li><li><a href="ProtectionEvents.html#event:KEY_ERROR">ProtectionEvents#event:KEY_ERROR</a></li><li><a href="ProtectionEvents.html#event:KEY_MESSAGE">ProtectionEvents#event:KEY_MESSAGE</a></li><li><a href="ProtectionEvents.html#event:KEY_SESSION_CLOSED">ProtectionEvents#event:KEY_SESSION_CLOSED</a></li><li><a href="ProtectionEvents.html#event:KEY_SESSION_CREATED">ProtectionEvents#event:KEY_SESSION_CREATED</a></li><li><a href="ProtectionEvents.html#event:KEY_SESSION_REMOVED">ProtectionEvents#event:KEY_SESSION_REMOVED</a></li><li><a href="ProtectionEvents.html#event:KEY_STATUSES_CHANGED">ProtectionEvents#event:KEY_STATUSES_CHANGED</a></li><li><a href="ProtectionEvents.html#event:KEY_SYSTEM_SELECTED">ProtectionEvents#event:KEY_SYSTEM_SELECTED</a></li><li><a href="ProtectionEvents.html#event:LICENSE_REQUEST_COMPLETE">ProtectionEvents#event:LICENSE_REQUEST_COMPLETE</a></li><li><a href="ProtectionEvents.html#event:LICENSE_REQUEST_SENDING">ProtectionEvents#event:LICENSE_REQUEST_SENDING</a></li><li><a href="ProtectionEvents.html#event:PROTECTION_CREATED">ProtectionEvents#event:PROTECTION_CREATED</a></li><li><a href="ProtectionEvents.html#event:PROTECTION_DESTROYED">ProtectionEvents#event:PROTECTION_DESTROYED</a></li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="global.html#LICENSE_SERVER_MANIFEST_CONFIGURATIONS">LICENSE_SERVER_MANIFEST_CONFIGURATIONS</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-12">
<div id="main">
<h1 class="page-title">Source: offline/OfflineDownload.js</h1>
<section>
<article>
<pre
class="sunlight-highlight-javascript linenums">/**
* The copyright in this software is being made available under the BSD License,
* included below. This software may be subject to other third party and contributor
* rights, including patent rights, and no such rights are granted under this license.
*
* Copyright (c) 2013, Dash Industry Forum.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
* * Neither the name of Dash Industry Forum nor the names of its
* contributors may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
import OfflineConstants from './constants/OfflineConstants';
import OfflineStream from './OfflineStream';
import OfflineIndexDBManifestParser from './utils/OfflineIndexDBManifestParser';
import OfflineErrors from './errors/OfflineErrors';
import DashParser from '../dash/parser/DashParser';
function OfflineDownload(config) {
config = config || {};
const context = this.context;
const manifestLoader = config.manifestLoader;
const mediaPlayerModel = config.mediaPlayerModel;
const abrController = config.abrController;
const playbackController = config.playbackController;
const adapter = config.adapter;
const dashMetrics = config.dashMetrics;
const timelineConverter = config.timelineConverter;
const offlineStoreController = config.offlineStoreController;
const manifestId = config.id;
const eventBus = config.eventBus;
const errHandler = config.errHandler;
const events = config.events;
const errors = config.errors;
const settings = config.settings;
const debug = config.debug;
const manifestUpdater = config.manifestUpdater;
const baseURLController = config.baseURLController;
const segmentBaseController = config.segmentBaseController;
const constants = config.constants;
const dashConstants = config.dashConstants;
const urlUtils = config.urlUtils;
let instance,
logger,
_manifestURL,
_offlineURL,
_xmlManifest,
_streams,
_manifest,
_isDownloadingStatus,
_isComposed,
_representationsToUpdate,
_indexDBManifestParser,
_progressionById,
_progression,
_status;
function setup() {
logger = debug.getLogger(instance);
manifestUpdater.initialize();
_streams = [];
_isDownloadingStatus = false;
_isComposed = false;
_progressionById = {};
_progression = 0;
_status = undefined;
}
function getId() {
return manifestId;
}
function getOfflineUrl() {
return _offlineURL;
}
function getManifestUrl() {
return _manifestURL;
}
function getStatus() {
return _status;
}
function setInitialState(state) {
_offlineURL = state.url;
_progression = state.progress;
_manifestURL = state.originalUrl;
_status = state.status;
}
/**
* Download a stream, from url of manifest
* @param {string} url
* @instance
*/
function downloadFromUrl(url) {
_manifestURL = url;
_offlineURL = `${OfflineConstants.OFFLINE_SCHEME}://${manifestId}`;
_status = OfflineConstants.OFFLINE_STATUS_CREATED;
setupOfflineEvents();
let offlineManifest = {
'fragmentStore': manifestId,
'status': _status,
'manifestId': manifestId,
'url': _offlineURL,
'originalURL': url
};
return createOfflineManifest(offlineManifest);
}
function initDownload() {
manifestLoader.load(_manifestURL);
_isDownloadingStatus = true;
}
function setupOfflineEvents() {
eventBus.on(events.MANIFEST_UPDATED, onManifestUpdated, instance);
eventBus.on(events.ORIGINAL_MANIFEST_LOADED, onOriginalManifestLoaded, instance);
setupIndexedDBEvents();
}
function setupIndexedDBEvents() {
eventBus.on(events.ERROR, onError, instance);
}
function isDownloading() {
return _isDownloadingStatus;
}
function onManifestUpdated(e) {
if (_isComposed) {
return;
}
if (!e.error) {
try {
_manifest = e.manifest;
} catch (err) {
_status = OfflineConstants.OFFLINE_STATUS_ERROR;
errHandler.error({
code: OfflineErrors.OFFLINE_ERROR,
message: err.message,
data: {
id: manifestId,
status: _status
}
});
}
}
}
function onDownloadingStarted(e) {
if (e.id !== manifestId) {
return;
}
if (!e.error && manifestId !== null) {
_status = OfflineConstants.OFFLINE_STATUS_STARTED;
offlineStoreController.setDownloadingStatus(manifestId, _status).then(function () {
eventBus.trigger(events.OFFLINE_RECORD_STARTED, {
id: manifestId,
message: 'Downloading started for this stream !'
});
});
} else {
_status = OfflineConstants.OFFLINE_STATUS_ERROR;
errHandler.error({
code: OfflineErrors.OFFLINE_ERROR,
message: 'Cannot start download ',
data: {
id: manifestId,
status: _status,
error: e.error
}
});
}
}
function OnStreamProgression(stream, downloaded, available) {
_progressionById[stream.getStreamInfo().id] = {
downloaded,
available
};
let segments = 0;
let allSegments = 0;
let waitForAllProgress;
for (var property in _progressionById) {
if (_progressionById.hasOwnProperty(property)) {
if (_progressionById[property] === null) {
waitForAllProgress = true;
} else {
segments += _progressionById[property].downloaded;
allSegments += _progressionById[property].available;
}
}
}
if (!waitForAllProgress) {
// all progression have been started, we can compute global progression
_progression = segments / allSegments;
// store progression
offlineStoreController.getManifestById(manifestId)
.then((item) => {
item.progress = _progression;
return updateOfflineManifest(item);
});
}
}
function onDownloadingFinished(e) {
if (e.id !== manifestId) {
return;
}
if (!e.error && manifestId !== null) {
_status = OfflineConstants.OFFLINE_STATUS_FINISHED;
offlineStoreController.setDownloadingStatus(manifestId, _status)
.then(function () {
eventBus.trigger(events.OFFLINE_RECORD_FINISHED, {
id: manifestId,
message: 'Downloading has been successfully completed for this stream !'
});
resetDownload();
});
} else {
_status = OfflineConstants.OFFLINE_STATUS_ERROR;
errHandler.error({
code: OfflineErrors.OFFLINE_ERROR,
message: 'Error finishing download ',
data: {
id: manifestId,
status: _status,
error: e.error
}
});
}
}
function onManifestUpdateNeeded(e) {
if (e.id !== manifestId) {
return;
}
_representationsToUpdate = e.representations;
if (_representationsToUpdate.length > 0) {
_indexDBManifestParser.parse(_xmlManifest, _representationsToUpdate).then(function (parsedManifest) {
if (parsedManifest !== null && manifestId !== null) {
offlineStoreController.getManifestById(manifestId)
.then((item) => {
item.manifest = parsedManifest;
return updateOfflineManifest(item);
})
.then(function () {
for (let i = 0, ln = _streams.length; i < ln; i++) {
_streams[i].startOfflineStreamProcessors();
}
});
} else {
throw 'falling parsing offline manifest';
}
}).catch(function (err) {
throw err;
});
}
}
function composeStreams() {
try {
adapter.updatePeriods(_manifest);
baseURLController.initialize(_manifest);
const streamsInfo = adapter.getStreamsInfo();
if (streamsInfo.length === 0) {
_status = OfflineConstants.OFFLINE_STATUS_ERROR;
errHandler.error({
code: OfflineErrors.OFFLINE_ERROR,
message: 'Cannot download - no streams',
data: {
id: manifestId,
status: _status
}
});
}
for (let i = 0, ln = streamsInfo.length; i < ln; i++) {
const streamInfo = streamsInfo[i];
let stream = OfflineStream(context).create({
id: manifestId,
callbacks: {
started: onDownloadingStarted,
progression: OnStreamProgression,
finished: onDownloadingFinished,
updateManifestNeeded: onManifestUpdateNeeded
},
constants: constants,
dashConstants: dashConstants,
eventBus: eventBus,
events: events,
errors: errors,
settings: settings,
debug: debug,
errHandler: errHandler,
mediaPlayerModel: mediaPlayerModel,
abrController: abrController,
playbackController: playbackController,
dashMetrics: dashMetrics,
baseURLController: baseURLController,
timelineConverter: timelineConverter,
adapter: adapter,
segmentBaseController: segmentBaseController,
offlineStoreController: offlineStoreController
});
_streams.push(stream);
// initialise stream and get downloadable representations
stream.initialize(streamInfo);
_progressionById[streamInfo.id] = null;
}
_isComposed = true;
} catch (e) {
logger.info(e);
_status = OfflineConstants.OFFLINE_STATUS_ERROR;
errHandler.error({
code: OfflineErrors.OFFLINE_ERROR,
message: e.message,
data: {
id: manifestId,
status: _status,
error: e.error
}
});
}
}
function getMediaInfos() {
_streams.forEach(stream => {
stream.getMediaInfos();
});
}
/**
* Init databsse to store fragments
* @param {number} manifestId
* @instance
*/
function createFragmentStore(manifestId) {
return offlineStoreController.createFragmentStore(manifestId);
}
/**
* Store in database the string representation of offline manifest (with only downloaded representations)
* @param {object} offlineManifest
* @instance
*/
function createOfflineManifest(offlineManifest) {
return offlineStoreController.createOfflineManifest(offlineManifest);
}
/**
* Store in database the string representation of offline manifest (with only downloaded representations)
* @param {object} offlineManifest
* @instance
*/
function updateOfflineManifest(offlineManifest) {
return offlineStoreController.updateOfflineManifest(offlineManifest);
}
/**
* Triggered when manifest is loaded from internet.
* @param {Object[]} e
*/
function onOriginalManifestLoaded(e) {
// unregister form event
eventBus.off(events.ORIGINAL_MANIFEST_LOADED, onOriginalManifestLoaded, instance);
_xmlManifest = e.originalManifest;
if (_manifest.type === dashConstants.DYNAMIC) {
_status = OfflineConstants.OFFLINE_STATUS_ERROR;
errHandler.error({
code: OfflineErrors.OFFLINE_ERROR,
message: 'Cannot handle DYNAMIC manifest',
data: {
id: manifestId,
status: _status
}
});
logger.error('Cannot handle DYNAMIC manifest');
return;
}
if (_manifest.Period_asArray.length > 1) {
_status = OfflineConstants.OFFLINE_STATUS_ERROR;
errHandler.error({
code: OfflineErrors.OFFLINE_ERROR,
message: 'MultiPeriod manifest are not yet supported',
data: {
id: manifestId,
status: _status
}
});
logger.error('MultiPeriod manifest are not yet supported');
return;
}
// save original manifest (for resume)
// initialise offline streams
composeStreams(_manifest);
// get MediaInfos
getMediaInfos();
eventBus.trigger(events.STREAMS_COMPOSED);
}
function initializeAllMediasInfoList(selectedRepresentations) {
for (let i = 0; i < _streams.length; i++) {
_streams[i].initializeAllMediasInfoList(selectedRepresentations);
}
}
function getSelectedRepresentations(mediaInfos) {
let rep = {};
rep[constants.VIDEO] = [];
rep[constants.AUDIO] = [];
rep[constants.TEXT] = [];
// selectedRepresentations.video.forEach(item => {
// ret[constants.VIDEO].push(item.id);
// });
// selectedRepresentations.audio.forEach(item => {
// ret[constants.AUDIO].push(item.id);
// });
// selectedRepresentations.text.forEach(item => {
// ret[item.type].push(item.id);
// });
mediaInfos.forEach(mediaInfo => {
mediaInfo.bitrateList.forEach(bitrate => {
rep[mediaInfo.type].push(bitrate.id);
});
});
return rep;
}
function startDownload(mediaInfos) {
try {
let rep = getSelectedRepresentations(mediaInfos);
offlineStoreController.saveSelectedRepresentations(manifestId, rep)
.then(() => {
return createFragmentStore(manifestId);
})
.then(() => {
return generateOfflineManifest(rep);
})
.then(function () {
initializeAllMediasInfoList(rep);
});
} catch (err) {
_status = OfflineConstants.OFFLINE_STATUS_ERROR;
errHandler.error({
code: OfflineErrors.OFFLINE_ERROR,
message: err.message,
data: {
id: manifestId,
status: _status
}
});
}
}
/**
* Create the parser used to convert original manifest in offline manifest
* Creates a JSON object that will be stored in database
* @param {Object[]} selectedRepresentations
* @instance
*/
function generateOfflineManifest(selectedRepresentations) {
_indexDBManifestParser = OfflineIndexDBManifestParser(context).create({
manifestId: manifestId,
allMediaInfos: selectedRepresentations,
debug: debug,
dashConstants: dashConstants,
constants: constants,
urlUtils: urlUtils
});
return _indexDBManifestParser.parse(_xmlManifest).then(function (parsedManifest) {
if (parsedManifest !== null) {
return offlineStoreController.getManifestById(manifestId)
.then((item) => {
item.originalURL = _manifest.url;
item.originalManifest = _xmlManifest;
item.manifest = parsedManifest;
return updateOfflineManifest(item);
});
} else {
return Promise.reject('falling parsing offline manifest');
}
}).catch(function (err) {
return Promise.reject(err);
});
}
/**
* Stops downloading of fragments
* @instance
*/
function stopDownload() {
if (manifestId !== null && isDownloading()) {
for (let i = 0, ln = _streams.length; i < ln; i++) {
_streams[i].stopOfflineStreamProcessors();
}
// remove streams
_streams = [];
_isComposed = false;
_status = OfflineConstants.OFFLINE_STATUS_STOPPED;
// update status
offlineStoreController.setDownloadingStatus(manifestId, _status).then(function () {
eventBus.trigger(events.OFFLINE_RECORD_STOPPED, {
sender: this,
id: manifestId,
status: _status,
message: 'Downloading has been stopped for this stream !'
});
_isDownloadingStatus = false;
});
}
}
/**
* Delete an offline manifest (and all of its data)
* @instance
*/
function deleteDownload() {
stopDownload();
}
/**
* Resume download of a stream
* @instance
*/
function resumeDownload() {
if (isDownloading()) {
return;
}
_isDownloadingStatus = true;
let selectedRepresentations;
offlineStoreController.getManifestById(manifestId)
.then((item) => {
let parser = DashParser(context).create({ debug: debug });
_manifest = parser.parse(item.originalManifest);
composeStreams(_manifest);
selectedRepresentations = item.selected;
eventBus.trigger(events.STREAMS_COMPOSED);
return createFragmentStore(manifestId);
})
.then(() => {
initializeAllMediasInfoList(selectedRepresentations);
});
}
/**
* Compute the progression of download
* @instance
*/
function getDownloadProgression() {
return Math.round(_progression * 100);
}
/**
* Reset events listeners
* @instance
*/
function resetDownload() {
for (let i = 0, ln = _streams.length; i < ln; i++) {
_streams[i].reset();
}
_indexDBManifestParser = null;
_isDownloadingStatus = false;
_streams = [];
eventBus.off(events.MANIFEST_UPDATED, onManifestUpdated, instance);
eventBus.off(events.ORIGINAL_MANIFEST_LOADED, onOriginalManifestLoaded, instance);
resetIndexedDBEvents();
}
function onError(e) {
if (e.error.code === OfflineErrors.INDEXEDDB_QUOTA_EXCEED_ERROR ||
e.error.code === OfflineErrors.INDEXEDDB_INVALID_STATE_ERROR) {
stopDownload();
}
}
function resetIndexedDBEvents() {
eventBus.on(events.ERROR, onError, instance);
}
/**
* Reset
* @instance
*/
function reset() {
if (isDownloading()) {
resetDownload();
}
baseURLController.reset();
manifestUpdater.reset();
}
instance = {
reset: reset,
getId: getId,
getOfflineUrl: getOfflineUrl,
getManifestUrl: getManifestUrl,
getStatus: getStatus,
setInitialState: setInitialState,
initDownload: initDownload,
downloadFromUrl: downloadFromUrl,
startDownload: startDownload,
stopDownload: stopDownload,
resumeDownload: resumeDownload,
deleteDownload: deleteDownload,
getDownloadProgression: getDownloadProgression,
isDownloading: isDownloading,
resetDownload: resetDownload
};
setup();
return instance;
}
OfflineDownload.__dashjs_factory_name = 'OfflineDownload';
export default dashjs.FactoryMaker.getClassFactory(OfflineDownload); /* jshint ignore:line */
</pre>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="copyright">
<h3>DASH Industry Forum</h3>
</span>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
on Wed Sep 28th 2022
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<script>
$( function () {
$( '#main' ).localScroll( {
offset : { top : 60 } //offset by the height of your header (give or take a few px, see what works for you)
} );
$( "dt.name" ).each( function () {
var $this = $( this ).find("h4");
var icon = $( "<i/>" ).addClass( "icon-plus-sign" ).addClass( "pull-right" ).addClass( "icon-white" );
var dt = $(this);
var children = dt.next( "dd" );
dt.prepend( icon ).css( {cursor : "pointer"} );
dt.addClass( "member-collapsed" ).addClass( "member" );
children.hide();
dt.children().on( "click", function () {
children = dt.next( "dd" );
children.slideToggle( "fast", function () {
if ( children.is( ":visible" ) ) {
icon.addClass( "icon-minus-sign" ).removeClass( "icon-plus-sign" ).removeClass( "icon-white" );
dt.addClass( "member-open" ).animate( "member-collapsed" );
} else {
icon.addClass( "icon-plus-sign" ).removeClass( "icon-minus-sign" ).addClass( "icon-white" );
dt.addClass( "member-collapsed" ).removeClass( "member-open" );
}
} );
} );
} );
} );
</script>
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>