/**
* @license
* Copyright 2016 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
goog.provide('shaka.Player');
goog.require('goog.asserts');
goog.require('shaka.abr.SimpleAbrManager');
goog.require('shaka.log');
goog.require('shaka.media.DrmEngine');
goog.require('shaka.media.ManifestParser');
goog.require('shaka.media.MediaSourceEngine');
goog.require('shaka.media.Playhead');
goog.require('shaka.media.PlayheadObserver');
goog.require('shaka.media.SegmentReference');
goog.require('shaka.media.StreamingEngine');
goog.require('shaka.net.NetworkingEngine');
goog.require('shaka.text.SimpleTextDisplayer');
goog.require('shaka.util.ArrayUtils');
goog.require('shaka.util.ConfigUtils');
goog.require('shaka.util.Error');
goog.require('shaka.util.EventManager');
goog.require('shaka.util.FakeEvent');
goog.require('shaka.util.FakeEventTarget');
goog.require('shaka.util.Functional');
goog.require('shaka.util.IDestroyable');
goog.require('shaka.util.ManifestParserUtils');
goog.require('shaka.util.MapUtils');
goog.require('shaka.util.PublicPromise');
goog.require('shaka.util.StreamUtils');
/**
* Construct a Player.
*
* @param {HTMLMediaElement=} mediaElem If provided, this is equivalent to
* calling attach(mediaElem, true) immediately after construction.
* @param {function(shaka.Player)=} opt_dependencyInjector Optional callback
* which is called to inject mocks into the Player. Used for testing.
*
* @constructor
* @struct
* @implements {shaka.util.IDestroyable}
* @extends {shaka.util.FakeEventTarget}
* @export
*/
shaka.Player = function(mediaElem, opt_dependencyInjector) {
shaka.util.FakeEventTarget.call(this);
/** @private {boolean} */
this.destroyed_ = false;
/** @private {HTMLMediaElement} */
this.video_ = null;
/**
* Only holds the visibility setting until a textDisplayer_ is created.
* @private {boolean}
*/
this.textVisibility_ = false;
/** @private {shakaExtern.TextDisplayer} */
this.textDisplayer_ = null;
/** @private {shaka.util.EventManager} */
this.eventManager_ = new shaka.util.EventManager();
/** @private {shaka.net.NetworkingEngine} */
this.networkingEngine_ = null;
/** @private {shaka.media.DrmEngine} */
this.drmEngine_ = null;
/** @private {shaka.media.MediaSourceEngine} */
this.mediaSourceEngine_ = null;
/** @private {shaka.media.Playhead} */
this.playhead_ = null;
/** @private {shaka.media.PlayheadObserver} */
this.playheadObserver_ = null;
/** @private {shaka.media.StreamingEngine} */
this.streamingEngine_ = null;
/** @private {shakaExtern.ManifestParser} */
this.parser_ = null;
/** @private {?shakaExtern.Manifest} */
this.manifest_ = null;
/** @private {?string} */
this.manifestUri_ = null;
/** @private {shakaExtern.AbrManager} */
this.abrManager_ = null;
/**
* The factory that was used to create the abrManager_ instance.
* @private {?shakaExtern.AbrManager.Factory}
*/
this.abrManagerFactory_ = null;
/**
* Contains an ID for use with creating streams. The manifest parser should
* start with small IDs, so this starts with a large one.
* @private {number}
*/
this.nextExternalStreamId_ = 1e9;
/** @private {!Array.<number>} */
this.loadingTextStreamIds_ = [];
/** @private {boolean} */
this.buffering_ = false;
/** @private {boolean} */
this.switchingPeriods_ = true;
/** @private {?function()} */
this.onCancelLoad_ = null;
/** @private {Promise} */
this.unloadChain_ = null;
/** @private {?shakaExtern.Variant} */
this.deferredVariant_ = null;
/** @private {boolean} */
this.deferredVariantClearBuffer_ = false;
/** @private {?shakaExtern.Stream} */
this.deferredTextStream_ = null;
/** @private {!Array.<shakaExtern.TimelineRegionInfo>} */
this.pendingTimelineRegions_ = [];
/**
* A map of Period number to a map of content type to stream id.
* @private {!Object.<number, !Object.<string, number>>}
*/
this.activeStreamsByPeriod_ = {};
/** @private {?shakaExtern.PlayerConfiguration} */
this.config_ = this.defaultConfig_();
/** @private {{width: number, height: number}} */
this.maxHwRes_ = {width: Infinity, height: Infinity};
/** @private {shakaExtern.Stats} */
this.stats_ = this.getCleanStats_();
/** @private {number} */
this.lastTimeStatsUpdateTimestamp_ = 0;
/** @private {string} */
this.currentAudioLanguage_ = this.config_.preferredAudioLanguage;
/** @private {string} */
this.currentTextLanguage_ = this.config_.preferredTextLanguage;
/** @private {string} */
this.currentVariantRole_ = this.config_.preferredVariantRole;
/** @private {string} */
this.currentTextRole_ = this.config_.preferredTextRole;
/** @private {number} */
this.currentAudioChannelCount_ = this.config_.preferredAudioChannelCount;
if (opt_dependencyInjector) {
opt_dependencyInjector(this);
}
this.networkingEngine_ = this.createNetworkingEngine();
if (mediaElem) {
this.attach(mediaElem, true /* initializeMediaSource */);
}
// If the browser comes back online after being offline, then try to play
// again.
this.eventManager_.listen(window, 'online', () => {
this.retryStreaming();
});
};
goog.inherits(shaka.Player, shaka.util.FakeEventTarget);
/**
* @return {!Promise}
* @private
*/
shaka.Player.prototype.cancelLoad_ = function() {
if (!this.onCancelLoad_) {
return Promise.resolve();
}
let stopParser = Promise.resolve();
if (this.parser_) {
// Stop the parser manually, to ensure that any network calls it may be
// making are stopped in a timely fashion.
// This happens in parallel with cancelling the load chain.
// Otherwise, destroying will wait for any failing network calls to run
// out of retries.
stopParser = this.parser_.stop();
this.parser_ = null;
}
return Promise.all([stopParser, this.onCancelLoad_()]);
};
/**
* After destruction, a Player object cannot be used again.
*
* @override
* @export
*/
shaka.Player.prototype.destroy = async function() {
// First, detach from the media element. This implies unloading content
// and canceling pending loads.
await this.detach();
// Then, destroy other components and clear fields.
this.destroyed_ = true;
let p = Promise.all([
this.eventManager_ ? this.eventManager_.destroy() : null,
this.networkingEngine_ ? this.networkingEngine_.destroy() : null
]);
this.textVisibility_ = false;
this.eventManager_ = null;
this.abrManager_ = null;
this.abrManagerFactory_ = null;
this.networkingEngine_ = null;
this.config_ = null;
await p;
};
/**
* @define {string} A version number taken from git at compile time.
* @export
*/
shaka.Player.version = 'v2.4.7-uncompiled';
/**
* @event shaka.Player.ErrorEvent
* @description Fired when a playback error occurs.
* @property {string} type
* 'error'
* @property {!shaka.util.Error} detail
* An object which contains details on the error. The error's 'category' and
* 'code' properties will identify the specific error that occurred. In an
* uncompiled build, you can also use the 'message' and 'stack' properties
* to debug.
* @exportDoc
*/
/**
* @event shaka.Player.EmsgEvent
* @description Fired when a non-typical emsg is found in a segment.
* @property {string} type
* 'emsg'
* @property {shakaExtern.EmsgInfo} detail
* An object which contains the content of the emsg box.
* @exportDoc
*/
/**
* @event shaka.Player.DrmSessionUpdateEvent
* @description Fired when the CDM has accepted the license response.
* @property {string} type
* 'drmsessionupdate'
* @exportDoc
*/
/**
* @event shaka.Player.TimelineRegionAddedEvent
* @description Fired when a media timeline region is added.
* @property {string} type
* 'timelineregionadded'
* @property {shakaExtern.TimelineRegionInfo} detail
* An object which contains a description of the region.
* @exportDoc
*/
/**
* @event shaka.Player.TimelineRegionEnterEvent
* @description Fired when the playhead enters a timeline region.
* @property {string} type
* 'timelineregionenter'
* @property {shakaExtern.TimelineRegionInfo} detail
* An object which contains a description of the region.
* @exportDoc
*/
/**
* @event shaka.Player.TimelineRegionExitEvent
* @description Fired when the playhead exits a timeline region.
* @property {string} type
* 'timelineregionexit'
* @property {shakaExtern.TimelineRegionInfo} detail
* An object which contains a description of the region.
* @exportDoc
*/
/**
* @event shaka.Player.BufferingEvent
* @description Fired when the player's buffering state changes.
* @property {string} type
* 'buffering'
* @property {boolean} buffering
* True when the Player enters the buffering state.
* False when the Player leaves the buffering state.
* @exportDoc
*/
/**
* @event shaka.Player.LoadingEvent
* @description Fired when the player begins loading.
* Used by the Cast receiver to determine idle state.
* @property {string} type
* 'loading'
* @exportDoc
*/
/**
* @event shaka.Player.UnloadingEvent
* @description Fired when the player unloads or fails to load.
* Used by the Cast receiver to determine idle state.
* @property {string} type
* 'unloading'
* @exportDoc
*/
/**
* @event shaka.Player.TextTrackVisibilityEvent
* @description Fired when text track visibility changes.
* @property {string} type
* 'texttrackvisibility'
* @exportDoc
*/
/**
* @event shaka.Player.TracksChangedEvent
* @description Fired when the list of tracks changes. For example, this will
* happen when changing periods or when track restrictions change.
* @property {string} type
* 'trackschanged'
* @exportDoc
*/
/**
* @event shaka.Player.AdaptationEvent
* @description Fired when an automatic adaptation causes the active tracks
* to change. Does not fire when the application calls selectVariantTrack()
* selectTextTrack(), selectAudioLanguage() or selectTextLanguage().
* @property {string} type
* 'adaptation'
* @exportDoc
*/
/**
* @event shaka.Player.ExpirationUpdatedEvent
* @description Fired when there is a change in the expiration times of an
* EME session.
* @property {string} type
* 'expirationupdated'
* @exportDoc
*/
/**
* @event shaka.Player.LargeGapEvent
* @description Fired when the playhead enters a large gap. If
* |config.streaming.jumpLargeGaps| is set, the default action of this event
* is to jump the gap; this can be prevented by calling preventDefault() on
* the event object.
* @property {string} type
* 'largegap'
* @property {number} currentTime
* The current time of the playhead.
* @property {number} gapSize
* The size of the gap, in seconds.
* @exportDoc
*/
/**
* @event shaka.Player.StreamingEvent
* @description Fired after the manifest has been parsed and track information
* is available, but before streams have been chosen and before any segments
* have been fetched. You may use this event to configure the player based on
* information found in the manifest.
* @property {string} type
* 'streaming'
* @exportDoc
*/
/** @private {!Object.<string, function():*>} */
shaka.Player.supportPlugins_ = {};
/**
* Registers a plugin callback that will be called with support(). The
* callback will return the value that will be stored in the return value from
* support().
*
* @param {string} name
* @param {function():*} callback
* @export
*/
shaka.Player.registerSupportPlugin = function(name, callback) {
shaka.Player.supportPlugins_[name] = callback;
};
/**
* Return whether the browser provides basic support. If this returns false,
* Shaka Player cannot be used at all. In this case, do not construct a Player
* instance and do not use the library.
*
* @return {boolean}
* @export
*/
shaka.Player.isBrowserSupported = function() {
// Basic features needed for the library to be usable.
let basic = !!window.Promise && !!window.Uint8Array &&
!!Array.prototype.forEach;
return basic &&
shaka.media.MediaSourceEngine.isBrowserSupported() &&
shaka.media.DrmEngine.isBrowserSupported();
};
/**
* Probes the browser to determine what features are supported. This makes a
* number of requests to EME/MSE/etc which may result in user prompts. This
* should only be used for diagnostics.
*
* NOTE: This may show a request to the user for permission.
*
* @see https://goo.gl/ovYLvl
* @return {!Promise.<shakaExtern.SupportType>}
* @export
*/
shaka.Player.probeSupport = function() {
goog.asserts.assert(shaka.Player.isBrowserSupported(),
'Must have basic support');
return shaka.media.DrmEngine.probeSupport().then(function(drm) {
let manifest = shaka.media.ManifestParser.probeSupport();
let media = shaka.media.MediaSourceEngine.probeSupport();
let ret = {
manifest: manifest,
media: media,
drm: drm
};
let plugins = shaka.Player.supportPlugins_;
for (let name in plugins) {
ret[name] = plugins[name]();
}
return ret;
});
};
/**
* Attach the Player to a media element (audio or video tag).
*
* If the Player is already attached to a media element, the previous element
* will first be detached.
*
* After calling attach, the media element is owned by the Player and should not
* be used for other purposes until detach or destroy() are called.
*
* @param {!HTMLMediaElement} mediaElem
* @param {boolean=} initializeMediaSource If true, start initializing
* MediaSource right away. This can improve load() latency for
* MediaSource-based playbacks. Defaults to true.
*
* @return {!Promise} If initializeMediaSource is false, the Promise is resolved
* as soon as the Player has released any previous media element and taken
* ownership of the new one. If initializeMediaSource is true, the Promise
* resolves after MediaSource has been subsequently initialized on the new
* media element.
* @export
*/
shaka.Player.prototype.attach =
async function(mediaElem, initializeMediaSource) {
if (initializeMediaSource === undefined) {
initializeMediaSource = true;
}
if (this.video_) {
await this.detach();
}
this.video_ = mediaElem;
goog.asserts.assert(mediaElem, 'Cannot attach to a null media element!');
// Listen for video errors.
this.eventManager_.listen(this.video_, 'error',
this.onVideoError_.bind(this));
if (initializeMediaSource) {
// Start the (potentially slow) process of opening MediaSource now.
this.mediaSourceEngine_ = this.createMediaSourceEngine();
await this.mediaSourceEngine_.open();
}
};
/**
* Detaches the Player from the media element (audio or video tag).
*
* After calling detach and waiting for the Promise to be resolved, the media
* element is no longer owned by the Player and may be used for other purposes.
*
* @return {!Promise} Resolved when the Player has released any previous media
* element.
* @export
*/
shaka.Player.prototype.detach = async function() {
if (!this.video_) {
return;
}
// Unload any loaded content.
await this.unload(false);
// Stop listening for video errors.
this.eventManager_.unlisten(this.video_, 'error');
this.video_ = null;
};
/**
* Creates a manifest parser and loads the given manifest.
*
* @param {string} manifestUri
* @param {shakaExtern.ManifestParser.Factory=} opt_manifestParserFactory
* Optional manifest parser factory to override auto-detection or use an
* unregistered parser.
* @return {!Promise.<shakaExtern.Manifest>} Resolves with the manifest.
* @private
*/
shaka.Player.prototype.loadManifest_ = async function(
manifestUri, opt_manifestParserFactory) {
goog.asserts.assert(this.networkingEngine_, 'Must not be destroyed');
const factory = await shaka.media.ManifestParser.getFactory(
manifestUri,
this.networkingEngine_,
this.config_.manifest.retryParameters,
opt_manifestParserFactory);
this.parser_ = new factory();
this.parser_.configure(this.config_.manifest);
goog.asserts.assert(this.networkingEngine_, 'Must not be destroyed');
let playerInterface = {
networkingEngine: this.networkingEngine_,
filterNewPeriod: this.filterNewPeriod_.bind(this),
filterAllPeriods: this.filterAllPeriods_.bind(this),
onTimelineRegionAdded: this.onTimelineRegionAdded_.bind(this),
onEvent: this.onEvent_.bind(this),
onError: this.onError_.bind(this)
};
return this.parser_.start(manifestUri, playerInterface);
};
/**
* When there is a variant with video and audio, filter out all variants which
* lack one or the other.
* This is to avoid problems where we choose audio-only variants because they
* have lower bandwidth, when there are variants with video available.
*
* @private
*/
shaka.Player.prototype.filterManifestForAVVariants_ = function() {
const isAVVariant = (variant) => {
// Audio-video variants may include both streams separately or may be single
// multiplexed streams with multiple codecs.
return (variant.video && variant.audio) ||
(variant.video && variant.video.codecs.includes(','));
};
const hasAVVariant = this.manifest_.periods.some((period) => {
return period.variants.some(isAVVariant);
});
if (hasAVVariant) {
shaka.log.debug('Found variant with audio and video content, ' +
'so filtering out audio-only content in all periods.');
this.manifest_.periods.forEach((period) => {
period.variants = period.variants.filter(isAVVariant);
});
}
if (this.manifest_.periods.length == 0) {
throw new shaka.util.Error(
shaka.util.Error.Severity.CRITICAL,
shaka.util.Error.Category.MANIFEST,
shaka.util.Error.Code.NO_PERIODS);
}
};
/**
* Applys playRangeStart and playRangeEnd to this.manifest_.
*
* @private
*/
shaka.Player.prototype.applyPlayRange_ = function() {
let fullDuration = this.manifest_.presentationTimeline.getDuration();
let playRangeEnd = this.config_.playRangeEnd;
let playRangeStart = this.config_.playRangeStart;
if (playRangeStart > 0) {
if (this.isLive()) {
shaka.log.warning('PlayerConfiguration.playRangeStart has been ' +
'configured for live content. Ignoring the setting.');
} else {
this.manifest_.presentationTimeline.setUserSeekStart(playRangeStart);
}
}
// If the playback has been configured to end before the end of the
// presentation, update the duration unless it's live content.
if (playRangeEnd < fullDuration) {
if (this.isLive()) {
shaka.log.warning('PlayerConfiguration.playRangeEnd has been ' +
'configured for live content. Ignoring the setting.');
} else {
this.manifest_.presentationTimeline.setDuration(playRangeEnd);
}
}
};
/**
* Load a manifest.
*
* @param {string} manifestUri
* @param {number=} opt_startTime Optional start time, in seconds, to begin
* playback.
* Defaults to 0 for VOD and to the live edge for live.
* Set a positive number to start with a certain offset the beginning.
* Set a negative number to start with a certain offset from the end. This is
* intended for use with live streams, to start at a fixed offset from the
* live edge.
* @param {shakaExtern.ManifestParser.Factory=} opt_manifestParserFactory
* Optional manifest parser factory to override auto-detection or use an
* unregistered parser.
* @return {!Promise} Resolved when the manifest has been loaded and playback
* has begun; rejected when an error occurs or the call was interrupted by
* destroy(), unload() or another call to load().
* @export
*/
shaka.Player.prototype.load = async function(manifestUri, opt_startTime,
opt_manifestParserFactory) {
if (!this.video_) {
throw new shaka.util.Error(
shaka.util.Error.Severity.CRITICAL,
shaka.util.Error.Category.PLAYER,
shaka.util.Error.Code.NO_VIDEO_ELEMENT);
}
let cancelValue;
/** @type {!shaka.util.PublicPromise} */
const cancelPromise = new shaka.util.PublicPromise();
const cancelCallback = function() {
cancelValue = new shaka.util.Error(
shaka.util.Error.Severity.CRITICAL,
shaka.util.Error.Category.PLAYER,
shaka.util.Error.Code.LOAD_INTERRUPTED);
return cancelPromise;
};
this.dispatchEvent(new shaka.util.FakeEvent('loading'));
let startTime = Date.now();
try {
const unloadPromise = this.unload();
this.onCancelLoad_ = cancelCallback;
await unloadPromise;
// Not tracked in stats because it should be insignificant.
// Logged in case it is not.
shaka.log.debug('Unload latency:', (Date.now() - startTime) / 1000);
this.stats_ = this.getCleanStats_();
this.eventManager_.listen(this.video_, 'playing',
this.updateState_.bind(this));
this.eventManager_.listen(this.video_, 'pause',
this.updateState_.bind(this));
this.eventManager_.listen(this.video_, 'ended',
this.updateState_.bind(this));
const AbrManagerFactory = this.config_.abrFactory;
if (!this.abrManager_ || this.abrManagerFactory_ != AbrManagerFactory) {
this.abrManagerFactory_ = AbrManagerFactory;
this.abrManager_ = new AbrManagerFactory();
this.abrManager_.configure(this.config_.abr);
}
this.textDisplayer_ = new this.config_.textDisplayFactory();
this.textDisplayer_.setTextVisibility(this.textVisibility_);
if (cancelValue) throw cancelValue;
this.manifest_ = await this.loadManifest_(
manifestUri, opt_manifestParserFactory);
this.manifestUri_ = manifestUri;
if (cancelValue) throw cancelValue;
this.filterManifestForAVVariants_();
this.drmEngine_ = this.createDrmEngine();
this.drmEngine_.configure(this.config_.drm);
await this.drmEngine_.init(
/** @type{shakaExtern.Manifest} */ (this.manifest_),
/* isOffline */ false);
if (cancelValue) throw cancelValue;
// Re-filter the manifest after DRM has been initialized.
this.filterAllPeriods_(this.manifest_.periods);
this.lastTimeStatsUpdateTimestamp_ = Date.now() / 1000;
// Copy preferred languages from the config again, in case the config was
// changed between construction and playback.
this.currentAudioLanguage_ = this.config_.preferredAudioLanguage;
this.currentTextLanguage_ = this.config_.preferredTextLanguage;
this.currentAudioChannelCount_ = this.config_.preferredAudioChannelCount;
this.applyPlayRange_();
await this.drmEngine_.attach(this.video_);
if (cancelValue) throw cancelValue;
this.abrManager_.init(this.switch_.bind(this));
if (!this.mediaSourceEngine_) {
this.mediaSourceEngine_ = this.createMediaSourceEngine();
}
this.mediaSourceEngine_.setTextDisplayer(this.textDisplayer_);
this.playhead_ = this.createPlayhead(opt_startTime);
this.playheadObserver_ = this.createPlayheadObserver();
this.streamingEngine_ = this.createStreamingEngine();
this.streamingEngine_.configure(this.config_.streaming);
// If the content is multi-codec and the browser can play more than one of
// them, choose codecs now before we initialize streaming.
this.chooseCodecsAndFilterManifest_();
this.dispatchEvent(new shaka.util.FakeEvent('streaming'));
await this.streamingEngine_.init();
if (cancelValue) throw cancelValue;
if (this.config_.streaming.startAtSegmentBoundary) {
let time = this.adjustStartTime_(this.playhead_.getTime());
this.playhead_.setStartTime(time);
}
// Re-filter the manifest after streams have been chosen.
this.manifest_.periods.forEach(this.filterNewPeriod_.bind(this));
// Dispatch a 'trackschanged' event now that all initial filtering is done.
this.onTracksChanged_();
// Since the first streams just became active, send an adaptation event.
this.onAdaptation_();
// Now that we've filtered out variants that aren't compatible with the
// active one, update abr manager with filtered variants for the current
// period.
let currentPeriod = this.streamingEngine_.getCurrentPeriod();
let variants = shaka.util.StreamUtils.filterVariantsByConfig(
currentPeriod.variants, this.currentAudioLanguage_,
this.currentVariantRole_, this.currentAudioChannelCount_);
this.abrManager_.setVariants(variants);
let hasPrimary = currentPeriod.variants.some(function(variant) {
return variant.primary;
});
if (!this.currentAudioLanguage_ && !hasPrimary) {
shaka.log.warning('No preferred audio language set. We will choose an ' +
'arbitrary language initially');
}
this.pendingTimelineRegions_.forEach(
this.playheadObserver_.addTimelineRegion.bind(this.playheadObserver_));
this.pendingTimelineRegions_ = [];
// Wait for the 'loadeddata' event to measure load() latency.
this.eventManager_.listenOnce(this.video_, 'loadeddata', function() {
// Compute latency in seconds (Date.now() gives ms):
let latency = (Date.now() - startTime) / 1000;
this.stats_.loadLatency = latency;
shaka.log.debug('Load latency:', latency);
}.bind(this));
if (cancelValue) throw cancelValue;
this.onCancelLoad_ = null;
} catch (error) {
goog.asserts.assert(error instanceof shaka.util.Error,
'Wrong error type!');
shaka.log.debug('load() failed:', error,
error ? error.message : null, error ? error.stack : null);
// If we haven't started another load, clear the onCancelLoad_.
cancelPromise.resolve();
if (this.onCancelLoad_ == cancelCallback) {
this.onCancelLoad_ = null;
this.dispatchEvent(new shaka.util.FakeEvent('unloading'));
}
// If part of the load chain was aborted, that async call may have thrown.
// In those cases, we want the cancelation error, not the thrown error.
if (cancelValue) {
return Promise.reject(cancelValue);
}
return Promise.reject(error);
}
};
/**
* In case of multiple usable codecs, choose one based on lowest average
* bandwidth and filter out the rest.
* @private
*/
shaka.Player.prototype.chooseCodecsAndFilterManifest_ = function() {
// Collect a list of variants for all periods.
/** @type {!Array.<shakaExtern.Variant>} */
let variants = this.manifest_.periods.reduce(
(variants, period) => variants.concat(period.variants), []);
// To start, consider a subset of variants based on audio channel preferences.
// For some content (#1013), surround-sound variants will use a different
// codec than stereo variants, so it is important to choose codecs **after**
// considering the audio channel config.
variants = shaka.util.StreamUtils.filterVariantsByAudioChannelCount(
variants, this.config_.preferredAudioChannelCount);
function variantCodecs(variant) {
// Only consider the base of the codec string. For example, these should
// both be considered the same codec: avc1.42c01e, avc1.4d401f
let baseVideoCodec =
variant.video ? variant.video.codecs.split('.')[0] : '';
let baseAudioCodec =
variant.audio ? variant.audio.codecs.split('.')[0] : '';
return baseVideoCodec + '-' + baseAudioCodec;
}
// Now organize variants into buckets by codecs.
/** @type {!Object.<string, !Array.<shakaExtern.Variant>>} */
let variantsByCodecs = {};
variants.forEach(function(variant) {
let codecs = variantCodecs(variant);
if (!(codecs in variantsByCodecs)) {
variantsByCodecs[codecs] = [];
}
variantsByCodecs[codecs].push(variant);
});
// Compute the average bandwidth for each group of variants.
// Choose the lowest-bandwidth codecs.
let bestCodecs = null;
let lowestAverageBandwidth = Infinity;
shaka.util.MapUtils.forEach(variantsByCodecs, function(codecs, variants) {
let sum = 0;
let num = 0;
variants.forEach(function(variant) {
sum += variant.bandwidth || 0;
++num;
});
let averageBandwidth = sum / num;
shaka.log.debug('codecs', codecs, 'avg bandwidth', averageBandwidth);
if (averageBandwidth < lowestAverageBandwidth) {
bestCodecs = codecs;
lowestAverageBandwidth = averageBandwidth;
}
});
goog.asserts.assert(bestCodecs != null, 'Should have chosen codecs!');
goog.asserts.assert(!isNaN(lowestAverageBandwidth),
'Bandwidth should be a number!');
// Filter out any variants that don't match, forcing AbrManager to choose from
// the most efficient variants possible.
this.manifest_.periods.forEach(function(period) {
period.variants = period.variants.filter(function(variant) {
let codecs = variantCodecs(variant);
if (codecs == bestCodecs) return true;
shaka.log.debug('Dropping Variant (better codec available)', variant);
return false;
});
});
};
/**
* Creates a new instance of DrmEngine. This can be replaced by tests to
* create fake instances instead.
*
* @return {!shaka.media.DrmEngine}
*/
shaka.Player.prototype.createDrmEngine = function() {
goog.asserts.assert(this.networkingEngine_, 'Must not be destroyed');
let playerInterface = {
netEngine: this.networkingEngine_,
onError: this.onError_.bind(this),
onKeyStatus: this.onKeyStatus_.bind(this),
onExpirationUpdated: this.onExpirationUpdated_.bind(this),
onEvent: this.onEvent_.bind(this)
};
return new shaka.media.DrmEngine(playerInterface);
};
/**
* Creates a new instance of NetworkingEngine. This can be replaced by tests
* to create fake instances instead.
*
* @return {!shaka.net.NetworkingEngine}
*/
shaka.Player.prototype.createNetworkingEngine = function() {
return new shaka.net.NetworkingEngine(this.onSegmentDownloaded_.bind(this));
};
/**
* Creates a new instance of Playhead. This can be replaced by tests to create
* fake instances instead.
*
* @param {number=} opt_startTime
* @return {!shaka.media.Playhead}
*/
shaka.Player.prototype.createPlayhead = function(opt_startTime) {
goog.asserts.assert(this.manifest_, 'Must have manifest');
goog.asserts.assert(this.video_, 'Must have video');
let startTime = opt_startTime == undefined ? null : opt_startTime;
return new shaka.media.Playhead(
this.video_, this.manifest_, this.config_.streaming,
startTime, this.onSeek_.bind(this), this.onEvent_.bind(this));
};
/**
* Creates a new instance of PlayheadOvserver. This can be replaced by tests to
* create fake instances instead.
*
* @return {!shaka.media.PlayheadObserver}
*/
shaka.Player.prototype.createPlayheadObserver = function() {
goog.asserts.assert(this.manifest_, 'Must have manifest');
return new shaka.media.PlayheadObserver(
this.video_, this.mediaSourceEngine_, this.manifest_,
this.config_.streaming, this.onBuffering_.bind(this),
this.onEvent_.bind(this), this.onChangePeriod_.bind(this));
};
/**
* Creates a new instance of MediaSourceEngine. This can be replaced by tests
* to create fake instances instead.
*
* @return {!shaka.media.MediaSourceEngine}
*/
shaka.Player.prototype.createMediaSourceEngine = function() {
return new shaka.media.MediaSourceEngine(this.video_);
};
/**
* Creates a new instance of StreamingEngine. This can be replaced by tests
* to create fake instances instead.
*
* @return {!shaka.media.StreamingEngine}
*/
shaka.Player.prototype.createStreamingEngine = function() {
goog.asserts.assert(
this.playhead_ && this.playheadObserver_ && this.mediaSourceEngine_ &&
this.manifest_,
'Must not be destroyed');
let playerInterface = {
playhead: this.playhead_,
mediaSourceEngine: this.mediaSourceEngine_,
netEngine: this.networkingEngine_,
onChooseStreams: this.onChooseStreams_.bind(this),
onCanSwitch: this.canSwitch_.bind(this),
onError: this.onError_.bind(this),
onEvent: this.onEvent_.bind(this),
onManifestUpdate: this.onManifestUpdate_.bind(this),
onSegmentAppended: this.onSegmentAppended_.bind(this),
filterNewPeriod: this.filterNewPeriod_.bind(this),
filterAllPeriods: this.filterAllPeriods_.bind(this)
};
return new shaka.media.StreamingEngine(this.manifest_, playerInterface);
};
/**
* Configure the Player instance.
*
* The config object passed in need not be complete. It will be merged with
* the existing Player configuration.
*
* Config keys and types will be checked. If any problems with the config
* object are found, errors will be reported through logs and this returns
* false. If there are errors, valid config objects are still set.
*
* @param {string|!Object} config This should either be a field name or an
* object following the form of {@link shakaExtern.PlayerConfiguration},
* where you may omit any field you do not wish to change.
* @param {*=} value This should be provided if the previous parameter
* was a string field name.
* @return {boolean} True if the passed config object was valid, false if there
* were invalid entries.
* @export
*/
shaka.Player.prototype.configure = function(config, value) {
goog.asserts.assert(this.config_, 'Config must not be null!');
goog.asserts.assert(typeof(config) == 'object' || arguments.length == 2,
'String configs should have values!');
// ('fieldName', value) format
if (arguments.length == 2 && typeof(config) == 'string') {
config = this.convertToConfigObject_(config, value);
}
goog.asserts.assert(typeof(config) == 'object', 'Should be an object!');
let ret = shaka.util.ConfigUtils.mergeConfigObjects(
this.config_, config, this.defaultConfig_(), this.configOverrides_(), '');
this.applyConfig_();
return ret;
};
/**
* Convert config from ('fieldName', value) format to a partial
* shakaExtern.PlayerConfiguration object.
* E. g. from ('manifest.retryParameters.maxAttempts', 1) to
* { manifest: { retryParameters: { maxAttempts: 1 }}}.
*
* @param {string} fieldName
* @param {*} value
* @return {!Object}
* @private
*/
shaka.Player.prototype.convertToConfigObject_ = function(fieldName, value) {
let configObject = {};
let last = configObject;
let searchIndex = 0;
let nameStart = 0;
while (true) { // eslint-disable-line no-constant-condition
let idx = fieldName.indexOf('.', searchIndex);
if (idx < 0) {
break;
}
if (idx == 0 || fieldName[idx - 1] != '\\') {
let part = fieldName.substring(nameStart, idx).replace(/\\\./g, '.');
last[part] = {};
last = last[part];
nameStart = idx + 1;
}
searchIndex = idx + 1;
}
last[fieldName.substring(nameStart).replace(/\\\./g, '.')] = value;
return configObject;
};
/**
* Apply config changes.
* @private
*/
shaka.Player.prototype.applyConfig_ = function() {
if (this.parser_) {
this.parser_.configure(this.config_.manifest);
}
if (this.drmEngine_) {
this.drmEngine_.configure(this.config_.drm);
}
if (this.streamingEngine_) {
this.streamingEngine_.configure(this.config_.streaming);
// Need to apply the restrictions to every period.
try {
// this.filterNewPeriod_() may throw.
this.manifest_.periods.forEach(this.filterNewPeriod_.bind(this));
} catch (error) {
this.onError_(error);
}
// If the stream we are playing is restricted, we need to switch.
let activeAudio = this.streamingEngine_.getActiveAudio();
let activeVideo = this.streamingEngine_.getActiveVideo();
let period = this.streamingEngine_.getCurrentPeriod();
let activeVariant = shaka.util.StreamUtils.getVariantByStreams(
activeAudio, activeVideo, period.variants);
if (!activeVariant || !activeVariant.allowedByApplication ||
!activeVariant.allowedByKeySystem) {
shaka.log.debug('Choosing new streams after changing configuration');
this.chooseStreamsAndSwitch_(period);
}
}
if (this.abrManager_) {
this.abrManager_.configure(this.config_.abr);
// Simply enable/disable ABR with each call, since multiple calls to these
// methods have no effect.
if (this.config_.abr.enabled && !this.switchingPeriods_) {
this.abrManager_.enable();
} else {
this.abrManager_.disable();
}
}
};
/**
* Return a copy of the current configuration. Modifications of the returned
* value will not affect the Player's active configuration. You must call
* player.configure() to make changes.
*
* @return {shakaExtern.PlayerConfiguration}
* @export
*/
shaka.Player.prototype.getConfiguration = function() {
goog.asserts.assert(this.config_, 'Config must not be null!');
let ret = this.defaultConfig_();
shaka.util.ConfigUtils.mergeConfigObjects(
ret, this.config_, this.defaultConfig_(), this.configOverrides_(), '');
return ret;
};
/**
* Reset configuration to default.
* @export
*/
shaka.Player.prototype.resetConfiguration = function() {
// Don't call mergeConfigObjects_(), since that would not reset open-ended
// dictionaries like drm.servers.
this.config_ = this.defaultConfig_();
this.applyConfig_();
};
/**
* @return {HTMLMediaElement} A reference to the HTML Media Element passed
* to the constructor or to attach().
* @export
*/
shaka.Player.prototype.getMediaElement = function() {
return this.video_;
};
/**
* @return {shaka.net.NetworkingEngine} A reference to the Player's networking
* engine. Applications may use this to make requests through Shaka's
* networking plugins.
* @export
*/
shaka.Player.prototype.getNetworkingEngine = function() {
return this.networkingEngine_;
};
/**
* @return {?string} If a manifest is loaded, returns the manifest URI given in
* the last call to load(). Otherwise, returns null.
* @export
*/
shaka.Player.prototype.getManifestUri = function() {
return this.manifestUri_;
};
/**
* @return {boolean} True if the current stream is live. False otherwise.
* @export
*/
shaka.Player.prototype.isLive = function() {
return this.manifest_ ?
this.manifest_.presentationTimeline.isLive() :
false;
};
/**
* @return {boolean} True if the current stream is in-progress VOD.
* False otherwise.
* @export
*/
shaka.Player.prototype.isInProgress = function() {
return this.manifest_ ?
this.manifest_.presentationTimeline.isInProgress() :
false;
};
/**
* @return {boolean} True for audio-only content. False otherwise.
* @export
*/
shaka.Player.prototype.isAudioOnly = function() {
if (!this.manifest_ || !this.manifest_.periods.length) {
return false;
}
let variants = this.manifest_.periods[0].variants;
if (!variants.length) {
return false;
}
// Note that if there are some audio-only variants and some audio-video
// variants, the audio-only variants are removed during filtering.
// Therefore if the first variant has no video, that's sufficient to say it
// is audio-only content.
return !variants[0].video;
};
/**
* Get the seekable range for the current stream.
* @return {{start: number, end: number}}
* @export
*/
shaka.Player.prototype.seekRange = function() {
let start = 0;
let end = 0;
if (this.manifest_) {
let timeline = this.manifest_.presentationTimeline;
start = timeline.getSeekRangeStart();
end = timeline.getSeekRangeEnd();
}
return {'start': start, 'end': end};
};
/**
* Get the key system currently being used by EME. This returns the empty
* string if not using EME.
*
* @return {string}
* @export
*/
shaka.Player.prototype.keySystem = function() {
return this.drmEngine_ ? this.drmEngine_.keySystem() : '';
};
/**
* Get the DrmInfo used to initialize EME. This returns null when not using
* EME.
*
* @return {?shakaExtern.DrmInfo}
* @export
*/
shaka.Player.prototype.drmInfo = function() {
return this.drmEngine_ ? this.drmEngine_.getDrmInfo() : null;
};
/**
* The next known expiration time for any EME session. If the sessions never
* expire, or there are no EME sessions, this returns Infinity.
*
* @return {number}
* @export
*/
shaka.Player.prototype.getExpiration = function() {
return this.drmEngine_ ? this.drmEngine_.getExpiration() : Infinity;
};
/**
* @return {boolean} True if the Player is in a buffering state.
* @export
*/
shaka.Player.prototype.isBuffering = function() {
return this.buffering_;
};
/**
* Unload the current manifest and make the Player available for re-use.
*
* @param {boolean=} reinitializeMediaSource If true, start reinitializing
* MediaSource right away. This can improve load() latency for
* MediaSource-based playbacks. Defaults to true.
* @return {!Promise} If reinitializeMediaSource is false, the Promise is
* resolved as soon as streaming has stopped and the previous content, if any,
* has been unloaded. If reinitializeMediaSource is true or undefined, the
* Promise resolves after MediaSource has been subsequently reinitialized.
* @export
*/
shaka.Player.prototype.unload = async function(reinitializeMediaSource) {
if (this.destroyed_) {
return;
}
if (reinitializeMediaSource === undefined) {
reinitializeMediaSource = true;
}
this.dispatchEvent(new shaka.util.FakeEvent('unloading'));
await this.cancelLoad_();
// If there is an existing unload operation, use that.
if (!this.unloadChain_) {
this.unloadChain_ = this.destroyStreaming_().then(() => {
// Force an exit from the buffering state.
this.onBuffering_(false);
this.unloadChain_ = null;
});
}
await this.unloadChain_;
if (reinitializeMediaSource) {
// Start the (potentially slow) process of opening MediaSource now.
this.mediaSourceEngine_ = this.createMediaSourceEngine();
await this.mediaSourceEngine_.open();
}
};
/**
* Gets the current effective playback rate. If using trick play, it will
* return the current trick play rate; otherwise, it will return the video
* playback rate.
* @return {number}
* @export
*/
shaka.Player.prototype.getPlaybackRate = function() {
return this.playhead_ ? this.playhead_.getPlaybackRate() : 0;
};
/**
* Skip through the content without playing. Simulated using repeated seeks.
*
* Trick play will be canceled automatically if the playhead hits the beginning
* or end of the seekable range for the content.
*
* @param {number} rate The playback rate to simulate. For example, a rate of
* 2.5 would result in 2.5 seconds of content being skipped every second.
* To trick-play backward, use a negative rate.
* @export
*/
shaka.Player.prototype.trickPlay = function(rate) {
shaka.log.debug('Trick play rate', rate);
if (this.playhead_) {
this.playhead_.setPlaybackRate(rate);
}
if (this.streamingEngine_) {
this.streamingEngine_.setTrickPlay(rate != 1);
}
};
/**
* Cancel trick-play.
* @export
*/
shaka.Player.prototype.cancelTrickPlay = function() {
shaka.log.debug('Trick play canceled');
if (this.playhead_) {
this.playhead_.setPlaybackRate(1);
}
if (this.streamingEngine_) {
this.streamingEngine_.setTrickPlay(false);
}
};
/**
* Return a list of variant tracks available for the current
* Period. If there are multiple Periods, then you must seek to the Period
* before being able to switch.
*
* @return {!Array.<shakaExtern.Track>}
* @export
*/
shaka.Player.prototype.getVariantTracks = function() {
if (!this.manifest_ || !this.playhead_) {
return [];
}
this.assertCorrectActiveStreams_();
const ContentType = shaka.util.ManifestParserUtils.ContentType;
let currentPeriod = shaka.util.StreamUtils.findPeriodContainingTime(
this.manifest_, this.playhead_.getTime());
let activeStreams = this.activeStreamsByPeriod_[currentPeriod] || {};
return shaka.util.StreamUtils.getVariantTracks(
this.manifest_.periods[currentPeriod],
activeStreams[ContentType.AUDIO],
activeStreams[ContentType.VIDEO]);
};
/**
* Return a list of text tracks available for the current
* Period. If there are multiple Periods, then you must seek to the Period
* before being able to switch.
*
* @return {!Array.<shakaExtern.Track>}
* @export
*/
shaka.Player.prototype.getTextTracks = function() {
if (!this.manifest_ || !this.playhead_) {
return [];
}
this.assertCorrectActiveStreams_();
const ContentType = shaka.util.ManifestParserUtils.ContentType;
let currentPeriod = shaka.util.StreamUtils.findPeriodContainingTime(
this.manifest_, this.playhead_.getTime());
let activeStreams = this.activeStreamsByPeriod_[currentPeriod] || {};
if (!activeStreams[ContentType.TEXT]) {
// This is a workaround for the demo page to be able to display the
// list of text tracks. If no text track is currently active, pick
// the one that's going to be streamed when captions are enabled
// and mark it as active.
let textStreams = shaka.util.StreamUtils.filterStreamsByLanguageAndRole(
this.manifest_.periods[currentPeriod].textStreams,
this.currentTextLanguage_,
this.currentTextRole_);
if (textStreams.length) {
activeStreams[ContentType.TEXT] = textStreams[0].id;
}
}
return shaka.util.StreamUtils
.getTextTracks(
this.manifest_.periods[currentPeriod],
activeStreams[ContentType.TEXT])
.filter(function(track) {
// Don't show any tracks that are being loaded still.
return this.loadingTextStreamIds_.indexOf(track.id) < 0;
}.bind(this));
};
/**
* Select a specific text track. Note that AdaptationEvents are not
* fired for manual track selections.
*
* @param {shakaExtern.Track} track
* @export
*/
shaka.Player.prototype.selectTextTrack = function(track) {
if (!this.streamingEngine_) {
return;
}
const StreamUtils = shaka.util.StreamUtils;
let period = this.streamingEngine_.getCurrentPeriod();
let stream = StreamUtils.findTextStreamForTrack(period, track);
if (!stream) {
shaka.log.error('Unable to find the track with id "' + track.id +
'"; did we change Periods?');
return;
}
this.mediaSourceEngine_.setUseEmbeddedText(false);
// Add entries to the history.
this.addTextStreamToSwitchHistory_(stream, /* fromAdaptation */ false);
this.switchTextStream_(stream);
// Workaround for https://github.com/google/shaka-player/issues/1299
// When track is selected, back-propogate the language to
// currentTextLanguage_.
this.currentTextLanguage_ = stream.language;
};
/**
* Use the embedded text for the current stream, if present.
*
* CEA 608/708 captions data is embedded inside the video stream.
*
* @export
*/
shaka.Player.prototype.selectEmbeddedTextTrack = function() {
this.mediaSourceEngine_.setUseEmbeddedText(true);
this.streamingEngine_.unloadTextStream();
};
/**
* @return {boolean} True if we are using any embedded text tracks present.
* @export
*/
shaka.Player.prototype.usingEmbeddedTextTrack = function() {
return this.mediaSourceEngine_ ?
this.mediaSourceEngine_.getUseEmbeddedText() : false;
};
/**
* Select a specific track. Note that AdaptationEvents are not fired for manual
* track selections.
*
* @param {shakaExtern.Track} track
* @param {boolean=} opt_clearBuffer
* @export
*/
shaka.Player.prototype.selectVariantTrack = function(track, opt_clearBuffer) {
if (!this.streamingEngine_) {
return;
}
if (this.config_.abr.enabled) {
shaka.log.alwaysWarn('Changing tracks while abr manager is enabled will ' +
'likely result in the selected track being ' +
'overriden. Consider disabling abr before calling ' +
'selectVariantTrack().');
}
const StreamUtils = shaka.util.StreamUtils;
let period = this.streamingEngine_.getCurrentPeriod();
let variant = StreamUtils.findVariantForTrack(period, track);
if (!variant) {
shaka.log.error('Unable to locate track with id "' + track.id + '".');
return;
}
// Double check that the track is allowed to be played.
// The track list should only contain playable variants,
// but if restrictions change and selectVariantTrack()
// is called before the track list is updated, we could
// get a now-restricted variant.
let variantIsPlayable = StreamUtils.isPlayable(variant);
if (!variantIsPlayable) {
shaka.log.error('Unable to switch to track with id "' + track.id +
'" because it is restricted.');
return;
}
// Add entries to the history.
this.addVariantToSwitchHistory_(variant, /* fromAdaptation */ false);
this.switchVariant_(variant, opt_clearBuffer);
// Workaround for https://github.com/google/shaka-player/issues/1299
// When track is selected, back-propogate the language to
// currentAudioLanguage_.
this.currentAudioLanguage_ = variant.language;
if (variant.audio && variant.audio.channelsCount) {
this.currentAudioChannelCount_ = variant.audio.channelsCount;
}
// Update AbrManager variants to match these new settings.
let variants = shaka.util.StreamUtils.filterVariantsByConfig(
period.variants, this.currentAudioLanguage_, this.currentVariantRole_,
this.currentAudioChannelCount_);
this.abrManager_.setVariants(variants);
};
/**
* Return a list of audio language-role combinations available for the current
* Period.
*
* @return {!Array.<shakaExtern.LanguageRole>}
* @export
*/
shaka.Player.prototype.getAudioLanguagesAndRoles = function() {
if (!this.streamingEngine_) {
return [];
}
const StreamUtils = shaka.util.StreamUtils;
let period = this.streamingEngine_.getCurrentPeriod();
let variants = StreamUtils.getPlayableVariants(period.variants);
let audioStreams = variants.map(function(variant) {
return variant.audio;
}).filter(shaka.util.Functional.isNotDuplicate);
return this.getLanguagesAndRoles_(audioStreams);
};
/**
* Return a list of text language-role combinations available for the current
* Period.
*
* @return {!Array.<shakaExtern.LanguageRole>}
* @export
*/
shaka.Player.prototype.getTextLanguagesAndRoles = function() {
if (!this.streamingEngine_) {
return [];
}
let period = this.streamingEngine_.getCurrentPeriod();
return this.getLanguagesAndRoles_(period.textStreams);
};
/**
* Return a list of audio languages available for the current Period.
*
* @return {!Array.<string>}
* @export
*/
shaka.Player.prototype.getAudioLanguages = function() {
if (!this.streamingEngine_) {
return [];
}
const StreamUtils = shaka.util.StreamUtils;
let period = this.streamingEngine_.getCurrentPeriod();
let variants = StreamUtils.getPlayableVariants(period.variants);
return variants.map(function(variant) {
return variant.language;
}).filter(shaka.util.Functional.isNotDuplicate);
};
/**
* Return a list of text languages available for the current Period.
*
* @return {!Array.<string>}
* @export
*/
shaka.Player.prototype.getTextLanguages = function() {
if (!this.streamingEngine_) {
return [];
}
let period = this.streamingEngine_.getCurrentPeriod();
return period.textStreams.map(function(stream) {
return stream.language;
}).filter(shaka.util.Functional.isNotDuplicate);
};
/**
* Given a list of streams, return a list of language-role combinations
* available for them.
*
* @param {!Array.<?shakaExtern.Stream>} streams
* @return {!Array.<shakaExtern.LanguageRole>}
* @private
*/
shaka.Player.prototype.getLanguagesAndRoles_ = function(streams) {
/** @const {string} */
const noLanguage = 'und';
/** @const {string} */
const noRole = '';
/** @type {!Array.<shakaExtern.LanguageRole>} */
let roleLangCombinations = [];
streams.forEach(function(stream) {
if (!stream) {
// Video-only variant
roleLangCombinations.push({language: noLanguage, role: noRole});
} else {
let language = stream.language;
if (stream.roles.length) {
stream.roles.forEach(function(role) {
roleLangCombinations.push({language: language, role: role});
});
} else {
// No roles, just add language by itself
roleLangCombinations.push({language: language, role: noRole});
}
}
});
return shaka.util.ArrayUtils.removeDuplicates(
roleLangCombinations,
function(a, b) {
return a.language == b.language && a.role == b.role;
});
};
/**
* Sets currentAudioLanguage and currentVariantRole to the selected
* language and role, and chooses a new variant if need be.
*
* @param {string} language
* @param {string=} opt_role
* @export
*/
shaka.Player.prototype.selectAudioLanguage =
function(language, opt_role) {
if (!this.streamingEngine_) return;
let period = this.streamingEngine_.getCurrentPeriod();
this.currentAudioLanguage_ = language;
this.currentVariantRole_ = opt_role || '';
// TODO: Refactor to only change audio and not affect text.
this.chooseStreamsAndSwitch_(period);
};
/**
* Sets currentTextLanguage and currentTextRole to the selected
* language and role, and chooses a new text stream if need be.
*
* @param {string} language
* @param {string=} opt_role
* @export
*/
shaka.Player.prototype.selectTextLanguage =
function(language, opt_role) {
if (!this.streamingEngine_) return;
let period = this.streamingEngine_.getCurrentPeriod();
this.currentTextLanguage_ = language;
this.currentTextRole_ = opt_role || '';
// TODO: Refactor to only change text and not affect audio.
this.chooseStreamsAndSwitch_(period);
};
/**
* @return {boolean} True if the current text track is visible.
* @export
*/
shaka.Player.prototype.isTextTrackVisible = function() {
if (this.textDisplayer_) {
return this.textDisplayer_.isTextVisible();
} else {
return this.textVisibility_;
}
};
/**
* Set the visibility of the current text track, if any.
*
* @param {boolean} on
* @export
*/
shaka.Player.prototype.setTextTrackVisibility = function(on) {
if (this.textDisplayer_) {
this.textDisplayer_.setTextVisibility(on);
}
this.textVisibility_ = on;
this.onTextTrackVisibility_();
// If we always stream text, don't do anything special to StreamingEngine.
if (this.config_.streaming.alwaysStreamText) return;
// Load text stream when the user chooses to show the caption, and pause
// loading text stream when the user chooses to hide the caption.
if (!this.streamingEngine_) return;
const StreamUtils = shaka.util.StreamUtils;
if (on) {
let period = this.streamingEngine_.getCurrentPeriod();
let textStreams = StreamUtils.filterStreamsByLanguageAndRole(
period.textStreams,
this.currentTextLanguage_,
this.currentTextRole_);
let stream = textStreams[0];
if (stream) {
this.streamingEngine_.loadNewTextStream(stream);
}
} else {
this.streamingEngine_.unloadTextStream();
}
};
/**
* Returns current playhead time as a Date.
*
* @return {Date}
* @export
*/
shaka.Player.prototype.getPlayheadTimeAsDate = function() {
if (!this.manifest_) return null;
goog.asserts.assert(this.isLive(),
'getPlayheadTimeAsDate should be called on a live stream!');
let time =
this.manifest_.presentationTimeline.getPresentationStartTime() * 1000 +
this.video_.currentTime * 1000;
return new Date(time);
};
/**
* Returns the presentation start time as a Date.
*
* @return {Date}
* @export
*/
shaka.Player.prototype.getPresentationStartTimeAsDate = function() {
if (!this.manifest_) return null;
goog.asserts.assert(this.isLive(),
'getPresentationStartTimeAsDate should be called on a live stream!');
let time =
this.manifest_.presentationTimeline.getPresentationStartTime() * 1000;
return new Date(time);
};
/**
* Return the information about the current buffered ranges.
*
* @return {shakaExtern.BufferedInfo}
* @export
*/
shaka.Player.prototype.getBufferedInfo = function() {
if (!this.mediaSourceEngine_) {
return {
total: [],
audio: [],
video: [],
text: []
};
}
return this.mediaSourceEngine_.getBufferedInfo();
};
/**
* Return playback and adaptation stats.
*
* @return {shakaExtern.Stats}
* @export
*/
shaka.Player.prototype.getStats = function() {
const ContentType = shaka.util.ManifestParserUtils.ContentType;
this.updateTimeStats_();
this.updateState_();
let video = null;
let variant = null;
let videoElem = /** @type {!HTMLVideoElement} */ (this.video_);
let videoInfo = videoElem && videoElem.getVideoPlaybackQuality ?
videoElem.getVideoPlaybackQuality() : {};
if (this.playhead_ && this.manifest_) {
let periodIdx = shaka.util.StreamUtils.findPeriodContainingTime(
this.manifest_, this.playhead_.getTime());
let period = this.manifest_.periods[periodIdx];
let activeStreams = this.activeStreamsByPeriod_[periodIdx];
if (activeStreams) {
variant = shaka.util.StreamUtils.getVariantByStreamIds(
activeStreams[ContentType.AUDIO],
activeStreams[ContentType.VIDEO],
period.variants);
// |variant| can possibly be null, if the period contains a text stream
// but no video or audio streams.
video = variant ? variant.video : null;
}
}
if (!video) video = {};
if (!variant) variant = {};
// Clone the internal object so our state cannot be tampered with.
const cloneObject = shaka.util.ConfigUtils.cloneObject;
return {
// Not tracked in this.stats_:
width: video.width || 0,
height: video.height || 0,
streamBandwidth: variant.bandwidth || 0,
decodedFrames: Number(videoInfo.totalVideoFrames),
droppedFrames: Number(videoInfo.droppedVideoFrames),
estimatedBandwidth: this.abrManager_ ?
this.abrManager_.getBandwidthEstimate() : NaN,
loadLatency: this.stats_.loadLatency,
playTime: this.stats_.playTime,
bufferingTime: this.stats_.bufferingTime,
// Deep-clone the objects as well as the arrays that contain them:
switchHistory: cloneObject(this.stats_.switchHistory),
stateHistory: cloneObject(this.stats_.stateHistory)
};
};
/**
* Adds the given text track to the current Period. load() must resolve before
* calling. The current Period or the presentation must have a duration. This
* returns a Promise that will resolve with the track that was created, when
* that track can be switched to.
*
* @param {string} uri
* @param {string} language
* @param {string} kind
* @param {string} mime
* @param {string=} opt_codec
* @param {string=} opt_label
* @return {!Promise.<shakaExtern.Track>}
* @export
*/
shaka.Player.prototype.addTextTrack = function(
uri, language, kind, mime, opt_codec, opt_label) {
if (!this.streamingEngine_) {
shaka.log.error(
'Must call load() and wait for it to resolve before adding text ' +
'tracks.');
return Promise.reject();
}
const ContentType = shaka.util.ManifestParserUtils.ContentType;
// Get the Period duration.
let period = this.streamingEngine_.getCurrentPeriod();
/** @type {number} */
const periodIndex = this.manifest_.periods.indexOf(period);
/** @type {number} */
const nextPeriodIndex = periodIndex + 1;
/** @type {number} */
const nextPeriodStart = nextPeriodIndex >= this.manifest_.periods.length ?
this.manifest_.presentationTimeline.getDuration() :
this.manifest_.periods[nextPeriodIndex].startTime;
/** @type {number} */
const periodDuration = nextPeriodStart - period.startTime;
if (periodDuration == Infinity) {
return Promise.reject(new shaka.util.Error(
shaka.util.Error.Severity.RECOVERABLE,
shaka.util.Error.Category.MANIFEST,
shaka.util.Error.Code.CANNOT_ADD_EXTERNAL_TEXT_TO_LIVE_STREAM));
}
/** @type {shakaExtern.Stream} */
let stream = {
id: this.nextExternalStreamId_++,
createSegmentIndex: Promise.resolve.bind(Promise),
findSegmentPosition: function(time) { return 1; },
getSegmentReference: function(ref) {
if (ref != 1) return null;
return new shaka.media.SegmentReference(
1, 0, periodDuration, function() { return [uri]; }, 0, null);
},
initSegmentReference: null,
presentationTimeOffset: 0,
mimeType: mime,
codecs: opt_codec || '',
kind: kind,
encrypted: false,
keyId: null,
language: language,
label: opt_label || null,
type: ContentType.TEXT,
primary: false,
trickModeVideo: null,
containsEmsgBoxes: false,
roles: [],
channelsCount: null
};
// Add the stream to the loading list to ensure it isn't switched to while it
// is initializing.
this.loadingTextStreamIds_.push(stream.id);
period.textStreams.push(stream);
// Don't create the media state until subtitles are actually enabled
return this.streamingEngine_.loadNewTextStream(stream).then(function() {
if (this.destroyed_) return;
let curPeriodIdx = this.manifest_.periods.indexOf(period);
let activeText = this.streamingEngine_.getActiveText();
if (activeText) {
// If this was the first text stream, StreamingEngine will start streaming
// it in loadNewTextStream. To reflect this, update the active stream.
this.activeStreamsByPeriod_[curPeriodIdx][ContentType.TEXT] =
activeText.id;
}
// Remove the stream from the loading list.
this.loadingTextStreamIds_.splice(
this.loadingTextStreamIds_.indexOf(stream.id), 1);
shaka.log.debug('Choosing new streams after adding a text stream');
this.chooseStreamsAndSwitch_(period);
this.onTracksChanged_();
return {
id: stream.id,
active: false,
type: ContentType.TEXT,
bandwidth: 0,
language: language,
label: opt_label || null,
kind: kind,
width: null,
height: null
};
}.bind(this));
};
/**
* Set the maximum resolution that the platform's hardware can handle.
* This will be called automatically by shaka.cast.CastReceiver to enforce
* limitations of the Chromecast hardware.
*
* @param {number} width
* @param {number} height
* @export
*/
shaka.Player.prototype.setMaxHardwareResolution = function(width, height) {
this.maxHwRes_.width = width;
this.maxHwRes_.height = height;
};
/**
* Retry streaming after a failure. Does nothing if not in a failure state.
* @return {boolean} False if unable to retry.
* @export
*/
shaka.Player.prototype.retryStreaming = function() {
return this.streamingEngine_ ? this.streamingEngine_.retry() : false;
};
/**
* Return the manifest information if it's loaded. Otherwise, return null.
* @return {?shakaExtern.Manifest}
* @export
*/
shaka.Player.prototype.getManifest = function() {
return this.manifest_;
};
/**
* @param {shakaExtern.Variant} variant
* @param {boolean} fromAdaptation
* @private
*/
shaka.Player.prototype.addVariantToSwitchHistory_ = function(
variant, fromAdaptation) {
if (variant.video) {
this.updateActiveStreams_(variant.video);
}
if (variant.audio) {
this.updateActiveStreams_(variant.audio);
}
// TODO: Get StreamingEngine to track variants and create getActiveVariant()
let activePeriod = this.streamingEngine_.getActivePeriod();
let activeVariant = shaka.util.StreamUtils.getVariantByStreams(
this.streamingEngine_.getActiveAudio(),
this.streamingEngine_.getActiveVideo(),
activePeriod ? activePeriod.variants : []);
// Only log the switch if the variant changes. For the initial decision,
// activeVariant is null and variant != activeVariant.
// This allows us to avoid onAdaptation_() when nothing has changed.
if (variant != activeVariant) {
this.stats_.switchHistory.push({
timestamp: Date.now() / 1000,
id: variant.id,
type: 'variant',
fromAdaptation: fromAdaptation,
bandwidth: variant.bandwidth
});
}
};
/**
* @param {shakaExtern.Stream} textStream
* @param {boolean} fromAdaptation
* @private
*/
shaka.Player.prototype.addTextStreamToSwitchHistory_ =
function(textStream, fromAdaptation) {
this.updateActiveStreams_(textStream);
this.stats_.switchHistory.push({
timestamp: Date.now() / 1000,
id: textStream.id,
type: 'text',
fromAdaptation: fromAdaptation,
bandwidth: null
});
};
/**
* @param {!shakaExtern.Stream} stream
* @private
*/
shaka.Player.prototype.updateActiveStreams_ = function(stream) {
goog.asserts.assert(this.manifest_, 'Must not be destroyed');
let periodIndex =
shaka.util.StreamUtils.findPeriodContainingStream(this.manifest_, stream);
if (!this.activeStreamsByPeriod_[periodIndex]) {
this.activeStreamsByPeriod_[periodIndex] = {};
}
this.activeStreamsByPeriod_[periodIndex][stream.type] = stream.id;
};
/**
* Destroy members responsible for streaming.
*
* @return {!Promise}
* @private
*/
shaka.Player.prototype.destroyStreaming_ = function() {
if (this.eventManager_) {
this.eventManager_.unlisten(this.video_, 'loadeddata');
this.eventManager_.unlisten(this.video_, 'playing');
this.eventManager_.unlisten(this.video_, 'pause');
this.eventManager_.unlisten(this.video_, 'ended');
}
const drmEngine = this.drmEngine_;
let p = Promise.all([
this.abrManager_ ? this.abrManager_.stop() : null,
this.mediaSourceEngine_ ? this.mediaSourceEngine_.destroy() : null,
this.playhead_ ? this.playhead_.destroy() : null,
this.playheadObserver_ ? this.playheadObserver_.destroy() : null,
this.streamingEngine_ ? this.streamingEngine_.destroy() : null,
this.parser_ ? this.parser_.stop() : null,
this.textDisplayer_ ? this.textDisplayer_.destroy() : null,
]).then(() => {
// MediaSourceEngine must be destroyed before DrmEngine, so that DrmEngine
// can detach MediaKeys from the media element.
return drmEngine ? drmEngine.destroy() : null;
});
this.switchingPeriods_ = true;
this.drmEngine_ = null;
this.mediaSourceEngine_ = null;
this.playhead_ = null;
this.playheadObserver_ = null;
this.streamingEngine_ = null;
this.parser_ = null;
this.textDisplayer_ = null;
this.manifest_ = null;
this.manifestUri_ = null;
this.pendingTimelineRegions_ = [];
this.activeStreamsByPeriod_ = {};
this.stats_ = this.getCleanStats_();
return p;
};
/**
* @return {!Object}
* @private
*/
shaka.Player.prototype.configOverrides_ = function() {
return {
'.drm.servers': '',
'.drm.clearKeys': '',
'.drm.advanced': {
distinctiveIdentifierRequired: false,
persistentStateRequired: false,
videoRobustness: '',
audioRobustness: '',
serverCertificate: new Uint8Array(0)
}
};
};
/**
* @return {shakaExtern.PlayerConfiguration}
* @private
*/
shaka.Player.prototype.defaultConfig_ = function() {
// This is a relatively safe default, since 3G cell connections
// are faster than this. For slower connections, such as 2G,
// the default estimate may be too high.
let bandwidthEstimate = 500e3; // 500kbps
let abrMaxHeight = Infinity;
// Some browsers implement the Network Information API, which allows
// retrieving information about a user's network connection.
//
// We are excluding connection.type == undefined to avoid getting bogus data
// on platforms where the implementation is incomplete. Currently, desktop
// Chrome 64 returns connection type undefined and a bogus downlink value.
if (navigator.connection && navigator.connection.type) {
// If it's available, get the bandwidth estimate from the browser (in
// megabits per second) and use it as defaultBandwidthEstimate.
bandwidthEstimate = navigator.connection.downlink * 1e6;
// TODO: Move this into AbrManager, where changes to the estimate can be
// observed and absorbed.
// If the user has checked a box in the browser to ask it to use less data,
// the browser will expose this intent via connection.saveData. When that
// is true, we will default the max ABR height to 360p. Apps can override
// this if they wish.
//
// The decision to use 360p was somewhat arbitrary. We needed a default
// limit, and rather than restrict to a certain bandwidth, we decided to
// restrict resolution. This will implicitly restrict bandwidth and
// therefore save data. We (Shaka+Chrome) judged that:
// - HD would be inappropriate
// - If a user is asking their browser to save data, 360p it reasonable
// - 360p would not look terrible on small mobile device screen
// We also found that:
// - YouTube's website on mobile defaults to 360p (as of 2018)
// - iPhone 6, in portrait mode, has a physical resolution big enough
// for 360p widescreen, but a little smaller than 480p widescreen
// (https://goo.gl/5trzW5)
// If the content's lowest resolution is above 360p, AbrManager will use
// the lowest resolution.
if (navigator.connection.saveData) {
abrMaxHeight = 360;
}
}
// Because this.video_ may not be set when the config is built, the default
// TextDisplay factory must capture a reference to "this" as "self" to use at
// the time we call the factory. Bind can't be used here because we call the
// factory with "new", effectively removing any binding to "this".
const self = this;
const defaultTextDisplayFactory = function() {
return new shaka.text.SimpleTextDisplayer(self.video_);
};
return {
drm: {
retryParameters: shaka.net.NetworkingEngine.defaultRetryParameters(),
// These will all be verified by special cases in mergeConfigObjects_():
servers: {}, // key is arbitrary key system ID, value must be string
clearKeys: {}, // key is arbitrary key system ID, value must be string
advanced: {}, // key is arbitrary key system ID, value is a record type
delayLicenseRequestUntilPlayed: false
},
manifest: {
retryParameters: shaka.net.NetworkingEngine.defaultRetryParameters(),
availabilityWindowOverride: NaN,
dash: {
customScheme: function(node) {
// Reference node to keep closure from removing it.
// If the argument is removed, it breaks our function length check
// in mergeConfigObjects_().
// TODO: Find a better solution if possible.
// NOTE: Chrome App Content Security Policy prohibits usage of new
// Function()
if (node) return null;
},
clockSyncUri: '',
ignoreDrmInfo: false,
xlinkFailGracefully: false,
defaultPresentationDelay: 10
}
},
streaming: {
retryParameters: shaka.net.NetworkingEngine.defaultRetryParameters(),
failureCallback:
this.defaultStreamingFailureCallback_.bind(this),
rebufferingGoal: 2,
bufferingGoal: 10,
bufferBehind: 30,
ignoreTextStreamFailures: false,
alwaysStreamText: false,
startAtSegmentBoundary: false,
smallGapLimit: 0.5,
jumpLargeGaps: false,
durationBackoff: 1,
forceTransmuxTS: false
},
abrFactory: shaka.abr.SimpleAbrManager,
textDisplayFactory: defaultTextDisplayFactory,
abr: {
enabled: true,
defaultBandwidthEstimate: bandwidthEstimate,
switchInterval: 8,
bandwidthUpgradeTarget: 0.85,
bandwidthDowngradeTarget: 0.95,
restrictions: {
minWidth: 0,
maxWidth: Infinity,
minHeight: 0,
maxHeight: abrMaxHeight,
minPixels: 0,
maxPixels: Infinity,
minBandwidth: 0,
maxBandwidth: Infinity
}
},
preferredAudioLanguage: '',
preferredTextLanguage: '',
preferredVariantRole: '',
preferredTextRole: '',
preferredAudioChannelCount: 2,
restrictions: {
minWidth: 0,
maxWidth: Infinity,
minHeight: 0,
maxHeight: Infinity,
minPixels: 0,
maxPixels: Infinity,
minBandwidth: 0,
maxBandwidth: Infinity
},
playRangeStart: 0,
playRangeEnd: Infinity
};
};
/**
* @param {!shaka.util.Error} error
* @private
*/
shaka.Player.prototype.defaultStreamingFailureCallback_ = function(error) {
let retryErrorCodes = [
shaka.util.Error.Code.BAD_HTTP_STATUS,
shaka.util.Error.Code.HTTP_ERROR,
shaka.util.Error.Code.TIMEOUT
];
if (this.isLive() && retryErrorCodes.indexOf(error.code) >= 0) {
error.severity = shaka.util.Error.Severity.RECOVERABLE;
shaka.log.warning('Live streaming error. Retrying automatically...');
this.retryStreaming();
}
};
/**
* @return {shakaExtern.Stats}
* @private
*/
shaka.Player.prototype.getCleanStats_ = function() {
return {
// These are not tracked in the private stats structure and are only here to
// satisfy the compiler.
width: NaN,
height: NaN,
streamBandwidth: NaN,
decodedFrames: NaN,
droppedFrames: NaN,
estimatedBandwidth: NaN,
// These are tracked in the private stats structure to avoid the need for
// many private member variables.
loadLatency: NaN,
playTime: 0,
bufferingTime: 0,
switchHistory: [],
stateHistory: []
};
};
/**
* Filters a list of periods.
* @param {!Array.<!shakaExtern.Period>} periods
* @private
*/
shaka.Player.prototype.filterAllPeriods_ = function(periods) {
goog.asserts.assert(this.video_, 'Must not be destroyed');
const ArrayUtils = shaka.util.ArrayUtils;
const StreamUtils = shaka.util.StreamUtils;
/** @type {?shakaExtern.Stream} */
let activeAudio =
this.streamingEngine_ ? this.streamingEngine_.getActiveAudio() : null;
/** @type {?shakaExtern.Stream} */
let activeVideo =
this.streamingEngine_ ? this.streamingEngine_.getActiveVideo() : null;
let filterPeriod = StreamUtils.filterNewPeriod.bind(
null, this.drmEngine_, activeAudio, activeVideo);
periods.forEach(filterPeriod);
let validPeriodsCount = ArrayUtils.count(periods, function(period) {
return period.variants.some(StreamUtils.isPlayable);
});
// If none of the periods are playable, throw CONTENT_UNSUPPORTED_BY_BROWSER.
if (validPeriodsCount == 0) {
throw new shaka.util.Error(
shaka.util.Error.Severity.CRITICAL,
shaka.util.Error.Category.MANIFEST,
shaka.util.Error.Code.CONTENT_UNSUPPORTED_BY_BROWSER);
}
// If only some of the periods are playable, throw UNPLAYABLE_PERIOD.
if (validPeriodsCount < periods.length) {
throw new shaka.util.Error(
shaka.util.Error.Severity.CRITICAL,
shaka.util.Error.Category.MANIFEST,
shaka.util.Error.Code.UNPLAYABLE_PERIOD);
}
periods.forEach(function(period) {
let tracksChanged = shaka.util.StreamUtils.applyRestrictions(
period, this.config_.restrictions, this.maxHwRes_);
if (tracksChanged && this.streamingEngine_ &&
this.streamingEngine_.getCurrentPeriod() == period) {
this.onTracksChanged_();
}
let hasValidVariant = period.variants.some(StreamUtils.isPlayable);
if (!hasValidVariant) {
throw new shaka.util.Error(
shaka.util.Error.Severity.CRITICAL,
shaka.util.Error.Category.MANIFEST,
shaka.util.Error.Code.RESTRICTIONS_CANNOT_BE_MET);
}
}.bind(this));
};
/**
* Filters a new period.
* @param {shakaExtern.Period} period
* @private
*/
shaka.Player.prototype.filterNewPeriod_ = function(period) {
goog.asserts.assert(this.video_, 'Must not be destroyed');
const StreamUtils = shaka.util.StreamUtils;
/** @type {?shakaExtern.Stream} */
let activeAudio =
this.streamingEngine_ ? this.streamingEngine_.getActiveAudio() : null;
/** @type {?shakaExtern.Stream} */
let activeVideo =
this.streamingEngine_ ? this.streamingEngine_.getActiveVideo() : null;
StreamUtils.filterNewPeriod(
this.drmEngine_, activeAudio, activeVideo, period);
/** @type {!Array.<shakaExtern.Variant>} */
let variants = period.variants;
// Check for playable variants before restrictions, so that we can give a
// special error when there were tracks but they were all filtered.
let hasPlayableVariant = variants.some(StreamUtils.isPlayable);
let tracksChanged = shaka.util.StreamUtils.applyRestrictions(
period, this.config_.restrictions, this.maxHwRes_);
if (tracksChanged && this.streamingEngine_ &&
this.streamingEngine_.getCurrentPeriod() == period) {
this.onTracksChanged_();
}
// Check for playable variants again. If the first check found variants, but
// not the second, then all variants are restricted.
let hasAvailableVariant = variants.some(StreamUtils.isPlayable);
if (!hasPlayableVariant) {
throw new shaka.util.Error(
shaka.util.Error.Severity.CRITICAL,
shaka.util.Error.Category.MANIFEST,
shaka.util.Error.Code.UNPLAYABLE_PERIOD);
}
if (!hasAvailableVariant) {
throw new shaka.util.Error(
shaka.util.Error.Severity.CRITICAL,
shaka.util.Error.Category.MANIFEST,
shaka.util.Error.Code.RESTRICTIONS_CANNOT_BE_MET);
}
// For new Periods, we may need to create new sessions for any new init data.
const curDrmInfo = this.drmEngine_ ? this.drmEngine_.getDrmInfo() : null;
if (curDrmInfo) {
for (const variant of variants) {
for (const drmInfo of variant.drmInfos) {
// Ignore any data for different key systems.
if (drmInfo.keySystem == curDrmInfo.keySystem) {
for (const initData of (drmInfo.initData || [])) {
this.drmEngine_.newInitData(
initData.initDataType, initData.initData);
}
}
}
}
}
};
/**
* Switches to the given variant, deferring if needed.
* @param {shakaExtern.Variant} variant
* @param {boolean=} opt_clearBuffer
* @private
*/
shaka.Player.prototype.switchVariant_ =
function(variant, opt_clearBuffer) {
if (this.switchingPeriods_) {
// Store this action for later.
this.deferredVariant_ = variant;
this.deferredVariantClearBuffer_ = opt_clearBuffer || false;
} else {
// Act now.
this.streamingEngine_.switchVariant(variant, opt_clearBuffer || false);
}
};
/**
* Switches to the given text stream, deferring if needed.
* @param {shakaExtern.Stream} textStream
* @private
*/
shaka.Player.prototype.switchTextStream_ = function(textStream) {
if (this.switchingPeriods_) {
// Store this action for later.
this.deferredTextStream_ = textStream;
} else {
// Act now.
this.streamingEngine_.switchTextStream(textStream);
}
};
/**
* Verifies that the active streams according to the player match those in
* StreamingEngine.
* @private
*/
shaka.Player.prototype.assertCorrectActiveStreams_ = function() {
if (!this.streamingEngine_ || !this.manifest_ || !goog.DEBUG) return;
const StreamUtils = shaka.util.StreamUtils;
const ContentType = shaka.util.ManifestParserUtils.ContentType;
let activeAudio = this.streamingEngine_.getActiveAudio();
let activeVideo = this.streamingEngine_.getActiveVideo();
let activeText = this.streamingEngine_.getActiveText();
/** @type {?shakaExtern.Stream} */
let mainStream = activeVideo || activeAudio;
if (!mainStream) {
return;
}
let streamingPeriodIndex =
StreamUtils.findPeriodContainingStream(this.manifest_, mainStream);
let currentPeriodIndex =
this.manifest_.periods.indexOf(this.streamingEngine_.getCurrentPeriod());
if (streamingPeriodIndex < 0 || streamingPeriodIndex != currentPeriodIndex) {
return;
}
let playerActive = this.activeStreamsByPeriod_[currentPeriodIndex] || {};
let activeStreams = [activeAudio, activeVideo, activeText];
activeStreams.forEach(function(stream) {
if (stream) {
let id = stream.id;
let type = stream.type;
if (type == ContentType.TEXT && this.deferredTextStream_) {
id = this.deferredTextStream_.id;
}
if (type == ContentType.AUDIO && this.deferredVariant_) {
id = this.deferredVariant_.audio.id;
}
if (type == ContentType.VIDEO && this.deferredVariant_) {
id = this.deferredVariant_.video.id;
}
goog.asserts.assert(
id == playerActive[type], 'Inconsistent active stream');
}
}.bind(this));
};
/** @private */
shaka.Player.prototype.updateTimeStats_ = function() {
// Only count while we're loaded.
if (!this.manifest_) {
return;
}
let now = Date.now() / 1000;
if (this.buffering_) {
this.stats_.bufferingTime += (now - this.lastTimeStatsUpdateTimestamp_);
} else {
this.stats_.playTime += (now - this.lastTimeStatsUpdateTimestamp_);
}
this.lastTimeStatsUpdateTimestamp_ = now;
};
/**
* @param {number} time
* @return {number}
* @private
*/
shaka.Player.prototype.adjustStartTime_ = function(time) {
/** @type {?shakaExtern.Stream} */
let activeAudio = this.streamingEngine_.getActiveAudio();
/** @type {?shakaExtern.Stream} */
let activeVideo = this.streamingEngine_.getActiveVideo();
/** @type {shakaExtern.Period} */
let period = this.streamingEngine_.getCurrentPeriod();
// This method is called after StreamingEngine.init resolves, which means that
// all the active streams have had createSegmentIndex called.
function getAdjustedTime(stream, time) {
if (!stream) return null;
let idx = stream.findSegmentPosition(time - period.startTime);
if (idx == null) return null;
let ref = stream.getSegmentReference(idx);
if (!ref) return null;
let refTime = ref.startTime + period.startTime;
goog.asserts.assert(refTime <= time, 'Segment should start before time');
return refTime;
}
let audioStartTime = getAdjustedTime(activeAudio, time);
let videoStartTime = getAdjustedTime(activeVideo, time);
// If we have both video and audio times, pick the larger one. If we picked
// the smaller one, that one will download an entire segment to buffer the
// difference.
if (videoStartTime != null && audioStartTime != null) {
return Math.max(videoStartTime, audioStartTime);
} else if (videoStartTime != null) {
return videoStartTime;
} else if (audioStartTime != null) {
return audioStartTime;
} else {
return time;
}
};
/**
* Callback from NetworkingEngine.
*
* @param {number} deltaTimeMs
* @param {number} numBytes
* @private
*/
shaka.Player.prototype.onSegmentDownloaded_ = function(deltaTimeMs, numBytes) {
if (this.abrManager_) {
// Abr manager might not exist during offline storage.
this.abrManager_.segmentDownloaded(deltaTimeMs, numBytes);
}
};
/**
* Callback from PlayheadObserver.
*
* @param {boolean} buffering
* @private
*/
shaka.Player.prototype.onBuffering_ = function(buffering) {
// Before setting |buffering_|, update the time spent in the previous state.
this.updateTimeStats_();
this.buffering_ = buffering;
this.updateState_();
if (this.playhead_) {
this.playhead_.setBuffering(buffering);
}
let event = new shaka.util.FakeEvent('buffering', {'buffering': buffering});
this.dispatchEvent(event);
};
/**
* Callback from PlayheadObserver.
* @private
*/
shaka.Player.prototype.onChangePeriod_ = function() {
this.onTracksChanged_();
};
/**
* Called from potential initiators of state changes, or before returning stats
* to the user.
*
* This method decides if state has actually changed, updates the last entry,
* and adds a new one if needed.
*
* @private
*/
shaka.Player.prototype.updateState_ = function() {
if (this.destroyed_) return;
let newState;
if (this.buffering_) {
newState = 'buffering';
} else if (this.video_.ended) {
newState = 'ended';
} else if (this.video_.paused) {
newState = 'paused';
} else {
newState = 'playing';
}
let now = Date.now() / 1000;
if (this.stats_.stateHistory.length) {
let lastIndex = this.stats_.stateHistory.length - 1;
let lastEntry = this.stats_.stateHistory[lastIndex];
lastEntry.duration = now - lastEntry.timestamp;
if (newState == lastEntry.state) {
// The state has not changed, so do not add anything to the history.
return;
}
}
this.stats_.stateHistory.push({
timestamp: now,
state: newState,
duration: 0
});
};
/**
* Callback from Playhead.
*
* @private
*/
shaka.Player.prototype.onSeek_ = function() {
if (this.playheadObserver_) {
this.playheadObserver_.seeked();
}
if (this.streamingEngine_) {
this.streamingEngine_.seeked();
}
};
/**
* Chooses a variant through the ABR manager.
* On error, this dispatches an error event and returns null.
*
* @param {!Array.<shakaExtern.Variant>} variants
* @return {?shakaExtern.Variant}
* @private
*/
shaka.Player.prototype.chooseVariant_ = function(variants) {
goog.asserts.assert(this.config_, 'Must not be destroyed');
if (!variants || !variants.length) {
this.onError_(new shaka.util.Error(
shaka.util.Error.Severity.CRITICAL,
shaka.util.Error.Category.MANIFEST,
shaka.util.Error.Code.RESTRICTIONS_CANNOT_BE_MET));
return null;
}
// Update the abr manager with newly filtered variants.
this.abrManager_.setVariants(variants);
return this.abrManager_.chooseVariant();
};
/**
* Chooses streams from the given Period and switches to them.
* Called after a config change, a new text stream, a key status event, or an
* explicit language change.
*
* @param {!shakaExtern.Period} period
* @private
*/
shaka.Player.prototype.chooseStreamsAndSwitch_ = function(period) {
goog.asserts.assert(this.config_, 'Must not be destroyed');
let variants = shaka.util.StreamUtils.filterVariantsByConfig(
period.variants, this.currentAudioLanguage_, this.currentVariantRole_,
this.currentAudioChannelCount_);
let textStreams = shaka.util.StreamUtils.filterStreamsByLanguageAndRole(
period.textStreams, this.currentTextLanguage_, this.currentTextRole_);
// Because we're running this after a config change (manual language change),
// a new text stream, or a key status event, and because switching to an
// active stream is a no-op, it is always okay to clear the buffer here.
let chosenVariant = this.chooseVariant_(variants);
if (chosenVariant) {
this.addVariantToSwitchHistory_(chosenVariant, /* fromAdaptation */ true);
this.switchVariant_(chosenVariant, true);
}
// Only switch text if we should be streaming text right now.
let chosenText = textStreams[0];
if (chosenText && this.streamText_()) {
this.addTextStreamToSwitchHistory_(chosenText, /* fromAdaptation */ true);
this.switchTextStream_(chosenText);
}
// Send an adaptation event so that the UI can show the new language/tracks.
this.onAdaptation_();
};
/**
* Callback from StreamingEngine, invoked when a period starts.
*
* @param {!shakaExtern.Period} period
* @return {shaka.media.StreamingEngine.ChosenStreams} An object containing the
* chosen variant and text stream.
* @private
*/
shaka.Player.prototype.onChooseStreams_ = function(period) {
shaka.log.debug('onChooseStreams_', period);
goog.asserts.assert(this.config_, 'Must not be destroyed');
const ContentType = shaka.util.ManifestParserUtils.ContentType;
const StreamUtils = shaka.util.StreamUtils;
// We are switching Periods, so the AbrManager will be disabled. But if we
// want to abr.enabled, we do not want to call AbrManager.enable before
// canSwitch_ is called.
this.switchingPeriods_ = true;
this.abrManager_.disable();
shaka.log.debug('Choosing new streams after period changed');
// Create empty object first and initialize the fields through
// [] to allow field names to be expressions.
// TODO: This feedback system for language matches could be cleaned up.
let languageMatches = {};
languageMatches[ContentType.AUDIO] = false;
languageMatches[ContentType.TEXT] = false;
let variants = StreamUtils.filterVariantsByConfig(
period.variants,
this.currentAudioLanguage_,
this.currentVariantRole_,
this.currentAudioChannelCount_,
languageMatches);
let textStreams = StreamUtils.filterStreamsByLanguageAndRole(
period.textStreams, this.currentTextLanguage_, this.currentTextRole_,
languageMatches);
shaka.log.v2('onChooseStreams_, variants and text streams: ',
variants, textStreams);
let chosenVariant = this.chooseVariant_(variants);
let chosenTextStream = textStreams[0] || null;
shaka.log.v2('onChooseStreams_, chosen=', chosenVariant, chosenTextStream);
// This assertion satisfies a compiler nullability check below.
goog.asserts.assert(this.manifest_, 'Manifest should exist!');
// Ignore deferred variant or text streams only if we are starting a new
// period. In this case, any deferred switches were from an older period, so
// they do not apply. We can still have deferred switches from the current
// period in the case of an early call to select*Track while we are setting up
// the first period. This can happen with the 'streaming' event.
if (this.deferredVariant_) {
const deferredPeriodIndex = StreamUtils.findPeriodContainingVariant(
this.manifest_, this.deferredVariant_);
const deferredPeriod = this.manifest_.periods[deferredPeriodIndex];
if (deferredPeriod == period) {
chosenVariant = this.deferredVariant_;
}
this.deferredVariant_ = null;
}
if (this.deferredTextStream_) {
const deferredPeriodIndex = StreamUtils.findPeriodContainingStream(
this.manifest_, this.deferredTextStream_);
const deferredPeriod = this.manifest_.periods[deferredPeriodIndex];
if (deferredPeriod == period) {
chosenTextStream = this.deferredTextStream_;
}
this.deferredTextStream_ = null;
}
if (chosenVariant) {
this.addVariantToSwitchHistory_(chosenVariant, /* fromAdaptation */ true);
}
if (chosenTextStream) {
this.addTextStreamToSwitchHistory_(
chosenTextStream, /* fromAdaptation */ true);
// If audio and text tracks have different languages, and the text track
// matches the user's preference, then show the captions. Only do this
// when we are choosing the initial tracks during startup.
let startingUp = !this.streamingEngine_.getActivePeriod();
if (startingUp) {
if (chosenVariant && chosenVariant.audio &&
languageMatches[ContentType.TEXT] &&
chosenTextStream.language != chosenVariant.audio.language) {
this.textDisplayer_.setTextVisibility(true);
this.onTextTrackVisibility_();
}
}
}
// Don't fire a tracks-changed event since we aren't inside the new Period
// yet.
// Don't initialize with a text stream unless we should be streaming text.
if (this.streamText_()) {
return {variant: chosenVariant, text: chosenTextStream};
} else {
return {variant: chosenVariant, text: null};
}
};
/**
* Callback from StreamingEngine, invoked when the period is set up.
*
* @private
*/
shaka.Player.prototype.canSwitch_ = function() {
shaka.log.debug('canSwitch_');
goog.asserts.assert(this.config_, 'Must not be destroyed');
this.switchingPeriods_ = false;
if (this.config_.abr.enabled) {
this.abrManager_.enable();
}
// If we still have deferred switches, switch now.
if (this.deferredVariant_) {
this.streamingEngine_.switchVariant(
this.deferredVariant_, this.deferredVariantClearBuffer_);
this.deferredVariant_ = null;
}
if (this.deferredTextStream_) {
this.streamingEngine_.switchTextStream(this.deferredTextStream_);
this.deferredTextStream_ = null;
}
};
/**
* Callback from StreamingEngine.
*
* @private
*/
shaka.Player.prototype.onManifestUpdate_ = function() {
if (this.parser_ && this.parser_.update) {
this.parser_.update();
}
};
/**
* Callback from StreamingEngine.
*
* @private
*/
shaka.Player.prototype.onSegmentAppended_ = function() {
if (this.playhead_) {
this.playhead_.onSegmentAppended();
}
};
/**
* Callback from AbrManager.
*
* @param {shakaExtern.Variant} variant
* @param {boolean=} opt_clearBuffer
* @private
*/
shaka.Player.prototype.switch_ = function(variant, opt_clearBuffer) {
shaka.log.debug('switch_');
goog.asserts.assert(this.config_.abr.enabled,
'AbrManager should not call switch while disabled!');
goog.asserts.assert(!this.switchingPeriods_,
'AbrManager should not call switch while transitioning between Periods!');
this.addVariantToSwitchHistory_(variant, /* fromAdaptation */ true);
if (!this.streamingEngine_) {
// There's no way to change it.
return;
}
this.streamingEngine_.switchVariant(variant, opt_clearBuffer || false);
this.onAdaptation_();
};
/**
* Dispatches an 'adaptation' event.
* @private
*/
shaka.Player.prototype.onAdaptation_ = function() {
// In the next frame, dispatch an 'adaptation' event.
// This gives StreamingEngine time to absorb the changes before the user
// tries to query them.
Promise.resolve().then(function() {
if (this.destroyed_) return;
let event = new shaka.util.FakeEvent('adaptation');
this.dispatchEvent(event);
}.bind(this));
};
/**
* Dispatches a 'trackschanged' event.
* @private
*/
shaka.Player.prototype.onTracksChanged_ = function() {
// In the next frame, dispatch a 'trackschanged' event.
// This gives StreamingEngine time to absorb the changes before the user
// tries to query them.
Promise.resolve().then(function() {
if (this.destroyed_) return;
let event = new shaka.util.FakeEvent('trackschanged');
this.dispatchEvent(event);
}.bind(this));
};
/** @private */
shaka.Player.prototype.onTextTrackVisibility_ = function() {
let event = new shaka.util.FakeEvent('texttrackvisibility');
this.dispatchEvent(event);
};
/**
* @param {!shaka.util.Error} error
* @private
*/
shaka.Player.prototype.onError_ = function(error) {
// Errors dispatched after destroy is called are irrelevant.
if (this.destroyed_) return;
goog.asserts.assert(error instanceof shaka.util.Error, 'Wrong error type!');
let event = new shaka.util.FakeEvent('error', {'detail': error});
this.dispatchEvent(event);
if (event.defaultPrevented) {
error.handled = true;
}
};
/**
* @param {shakaExtern.TimelineRegionInfo} region
* @private
*/
shaka.Player.prototype.onTimelineRegionAdded_ = function(region) {
if (this.playheadObserver_) {
this.playheadObserver_.addTimelineRegion(region);
} else {
this.pendingTimelineRegions_.push(region);
}
};
/**
* @param {!Event} event
* @private
*/
shaka.Player.prototype.onEvent_ = function(event) {
this.dispatchEvent(event);
};
/**
* @param {!Event} event
* @private
*/
shaka.Player.prototype.onVideoError_ = function(event) {
if (!this.video_.error) return;
let code = this.video_.error.code;
if (code == 1 /* MEDIA_ERR_ABORTED */) {
// Ignore this error code, which should only occur when navigating away or
// deliberately stopping playback of HTTP content.
return;
}
// Extra error information from MS Edge and IE11:
let extended = this.video_.error.msExtendedCode;
if (extended) {
// Convert to unsigned:
if (extended < 0) {
extended += Math.pow(2, 32);
}
// Format as hex:
extended = extended.toString(16);
}
// Extra error information from Chrome:
let message = this.video_.error.message;
this.onError_(new shaka.util.Error(
shaka.util.Error.Severity.CRITICAL,
shaka.util.Error.Category.MEDIA,
shaka.util.Error.Code.VIDEO_ERROR,
code, extended, message));
};
/**
* @param {!Object.<string, string>} keyStatusMap A map of hex key IDs to
* statuses.
* @private
*/
shaka.Player.prototype.onKeyStatus_ = function(keyStatusMap) {
goog.asserts.assert(this.streamingEngine_, 'Should have been initialized.');
// 'usable', 'released', 'output-downscaled', 'status-pending' are statuses
// of the usable keys.
// 'expired' status is being handled separately in DrmEngine.
let restrictedStatuses = ['output-restricted', 'internal-error'];
let period = this.streamingEngine_.getCurrentPeriod();
let tracksChanged = false;
let keyIds = Object.keys(keyStatusMap);
if (keyIds.length == 0) {
shaka.log.warning(
'Got a key status event without any key statuses, so we don\'t know ' +
'the real key statuses. If we don\'t have all the keys, you\'ll need ' +
'to set restrictions so we don\'t select those tracks.');
}
// If EME is using a synthetic key ID, the only key ID is '00' (a single 0
// byte). In this case, it is only used to report global success/failure.
// See note about old platforms in: https://goo.gl/KtQMja
let isGlobalStatus = keyIds.length == 1 && keyIds[0] == '00';
if (isGlobalStatus) {
shaka.log.warning(
'Got a synthetic key status event, so we don\'t know the real key ' +
'statuses. If we don\'t have all the keys, you\'ll need to set ' +
'restrictions so we don\'t select those tracks.');
}
// Only filter tracks for keys if we have some key statuses to look at.
if (keyIds.length) {
period.variants.forEach(function(variant) {
let streams = [];
if (variant.audio) streams.push(variant.audio);
if (variant.video) streams.push(variant.video);
streams.forEach(function(stream) {
let originalAllowed = variant.allowedByKeySystem;
// Only update if we have a key ID for the stream.
// If the key isn't present, then we don't have that key and the track
// should be restricted.
if (stream.keyId) {
let keyStatus = keyStatusMap[isGlobalStatus ? '00' : stream.keyId];
variant.allowedByKeySystem =
!!keyStatus && restrictedStatuses.indexOf(keyStatus) < 0;
}
if (originalAllowed != variant.allowedByKeySystem) {
tracksChanged = true;
}
}); // streams.forEach
}); // period.variants.forEach
} // if (keyIds.length)
// TODO: Get StreamingEngine to track variants and create getActiveVariant()
let activeAudio = this.streamingEngine_.getActiveAudio();
let activeVideo = this.streamingEngine_.getActiveVideo();
let activeVariant = shaka.util.StreamUtils.getVariantByStreams(
activeAudio, activeVideo, period.variants);
if (activeVariant && !activeVariant.allowedByKeySystem) {
shaka.log.debug('Choosing new streams after key status changed');
this.chooseStreamsAndSwitch_(period);
}
if (tracksChanged) {
this.onTracksChanged_();
// Update AbrManager about any restricted/un-restricted variants.
let variants = shaka.util.StreamUtils.filterVariantsByConfig(
period.variants,
this.currentAudioLanguage_,
this.currentVariantRole_,
this.currentAudioChannelCount_);
this.abrManager_.setVariants(variants);
}
};
/**
* Callback from DrmEngine
* @param {string} keyId
* @param {number} expiration
* @private
*/
shaka.Player.prototype.onExpirationUpdated_ = function(keyId, expiration) {
if (this.parser_ && this.parser_.onExpirationUpdated) {
this.parser_.onExpirationUpdated(keyId, expiration);
}
let event = new shaka.util.FakeEvent('expirationupdated');
this.dispatchEvent(event);
};
/**
* @return {boolean} true if we should stream text right now.
* @private
*/
shaka.Player.prototype.streamText_ = function() {
return this.config_.streaming.alwaysStreamText || this.isTextTrackVisible();
};