dashjs
Version:
A reference client implementation for the playback of MPEG DASH via Javascript and compliant browsers.
756 lines (619 loc) • 37.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>dash.js Source: streaming/rules/abr/L2ARule.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: streaming/rules/abr/L2ARule.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) 2020, Unified Streaming.
* 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.
*/
// For a description of the Learn2Adapt-LowLatency (L2A-LL) bitrate adaptation algorithm, see https://github.com/unifiedstreaming/Learn2Adapt-LowLatency/blob/master/Online_learning_for_bitrate_adaptation_in_low_latency_live_streaming_CR.pdf
import MetricsConstants from '../../constants/MetricsConstants';
import SwitchRequest from '../SwitchRequest';
import FactoryMaker from '../../../core/FactoryMaker';
import {HTTPRequest} from '../../vo/metrics/HTTPRequest';
import EventBus from '../../../core/EventBus';
import Events from '../../../core/events/Events';
import Debug from '../../../core/Debug';
import Constants from '../../constants/Constants';
const L2A_STATE_ONE_BITRATE = 0; // If there is only one bitrate (or initialization failed), always return NO_CHANGE.
const L2A_STATE_STARTUP = 1; // Set placeholder buffer such that we download fragments at most recently measured throughput.
const L2A_STATE_STEADY = 2; // Buffer primed, we switch to steady operation.
function L2ARule(config) {
config = config || {};
const context = this.context;
const dashMetrics = config.dashMetrics;
const eventBus = EventBus(context).getInstance();
let instance,
l2AStateDict,
l2AParameterDict,
logger;
/**
* Setup function to initialize L2ARule
*/
function setup() {
logger = Debug(context).getInstance().getLogger(instance);
_resetInitialSettings();
eventBus.on(Events.PLAYBACK_SEEKING, _onPlaybackSeeking, instance);
eventBus.on(Events.MEDIA_FRAGMENT_LOADED, _onMediaFragmentLoaded, instance);
eventBus.on(Events.METRIC_ADDED, _onMetricAdded, instance);
eventBus.on(Events.QUALITY_CHANGE_REQUESTED, _onQualityChangeRequested, instance);
}
/**
* Sets the initial state of the algorithm. Calls the initialize function for the paramteters.
* @param {object} rulesContext
* @return {object} initialState
* @private
*/
function _getInitialL2AState(rulesContext) {
const initialState = {};
const mediaInfo = rulesContext.getMediaInfo();
const bitrates = mediaInfo.bitrateList.map((b) => {
return b.bandwidth / 1000;
});
initialState.state = L2A_STATE_STARTUP;
initialState.bitrates = bitrates;
initialState.lastQuality = 0;
_initializeL2AParameters(mediaInfo);
_clearL2AStateOnSeek(initialState);
return initialState;
}
/**
* Initializes the parameters of the algorithm. This will be done once for each media type.
* @param {object} mediaInfo
* @private
*/
function _initializeL2AParameters(mediaInfo) {
if (!mediaInfo || !mediaInfo.type) {
return;
}
l2AParameterDict[mediaInfo.type] = {};
l2AParameterDict[mediaInfo.type].w = []; //Vector of probabilities associated with bitrate decisions
l2AParameterDict[mediaInfo.type].prev_w = []; //Vector of probabilities associated with bitrate decisions calculated in the previous step
l2AParameterDict[mediaInfo.type].Q = 0; //Initialization of Lagrangian multiplier (This keeps track of the buffer displacement)
l2AParameterDict[mediaInfo.type].segment_request_start_s = 0;
l2AParameterDict[mediaInfo.type].segment_download_finish_s = 0;
l2AParameterDict[mediaInfo.type].B_target = 1.5; //Target buffer level
}
/**
* Clears the state object
* @param {object} l2AState
* @private
*/
function _clearL2AStateOnSeek(l2AState) {
l2AState.placeholderBuffer = 0;
l2AState.mostAdvancedSegmentStart = NaN;
l2AState.lastSegmentWasReplacement = false;
l2AState.lastSegmentStart = NaN;
l2AState.lastSegmentDurationS = NaN;
l2AState.lastSegmentRequestTimeMs = NaN;
l2AState.lastSegmentFinishTimeMs = NaN;
}
/**
* Returns the state object for a fiven media type. If the state object is not yet defined _getInitialL2AState is called
* @param {object} rulesContext
* @return {object} l2AState
* @private
*/
function _getL2AState(rulesContext) {
const mediaType = rulesContext.getMediaType();
let l2AState = l2AStateDict[mediaType];
if (!l2AState) {
l2AState = _getInitialL2AState(rulesContext);
l2AStateDict[mediaType] = l2AState;
}
return l2AState;
}
/**
* Event handler for the seeking event.
* @private
*/
function _onPlaybackSeeking() {
for (const mediaType in l2AStateDict) {
if (l2AStateDict.hasOwnProperty(mediaType)) {
const l2aState = l2AStateDict[mediaType];
if (l2aState.state !== L2A_STATE_ONE_BITRATE) {
l2aState.state = L2A_STATE_STARTUP;
_clearL2AStateOnSeek(l2aState);
}
}
}
}
/**
* Event handler for the mediaFragmentLoaded event
* @param {object} e
* @private
*/
function _onMediaFragmentLoaded(e) {
if (e && e.chunk && e.chunk.mediaInfo) {
const l2AState = l2AStateDict[e.chunk.mediaInfo.type];
const l2AParameters = l2AParameterDict[e.chunk.mediaInfo.type];
if (l2AState && l2AState.state !== L2A_STATE_ONE_BITRATE) {
const start = e.chunk.start;
if (isNaN(l2AState.mostAdvancedSegmentStart) || start > l2AState.mostAdvancedSegmentStart) {
l2AState.mostAdvancedSegmentStart = start;
l2AState.lastSegmentWasReplacement = false;
} else {
l2AState.lastSegmentWasReplacement = true;
}
l2AState.lastSegmentStart = start;
l2AState.lastSegmentDurationS = e.chunk.duration;
l2AState.lastQuality = e.chunk.quality;
_checkNewSegment(l2AState, l2AParameters);
}
}
}
/**
* Event handler for the metricAdded event
* @param {object} e
* @private
*/
function _onMetricAdded(e) {
if (e && e.metric === MetricsConstants.HTTP_REQUEST && e.value && e.value.type === HTTPRequest.MEDIA_SEGMENT_TYPE && e.value.trace && e.value.trace.length) {
const l2AState = l2AStateDict[e.mediaType];
const l2AParameters = l2AParameterDict[e.mediaType];
if (l2AState && l2AState.state !== L2A_STATE_ONE_BITRATE) {
l2AState.lastSegmentRequestTimeMs = e.value.trequest.getTime();
l2AState.lastSegmentFinishTimeMs = e.value._tfinish.getTime();
_checkNewSegment(l2AState, l2AParameters);
}
}
}
/**
* When a new metric has been added or a media fragment has been loaded the state is adjusted accordingly
* @param {object} L2AState
* @param {object} l2AParameters
* @private
*/
function _checkNewSegment(L2AState, l2AParameters) {
if (!isNaN(L2AState.lastSegmentStart) && !isNaN(L2AState.lastSegmentRequestTimeMs)) {
l2AParameters.segment_request_start_s = 0.001 * L2AState.lastSegmentRequestTimeMs;
l2AParameters.segment_download_finish_s = 0.001 * L2AState.lastSegmentFinishTimeMs;
L2AState.lastSegmentStart = NaN;
L2AState.lastSegmentRequestTimeMs = NaN;
}
}
/**
* Event handler for the qualityChangeRequested event
* @param {object} e
* @private
*/
function _onQualityChangeRequested(e) {
// Useful to store change requests when abandoning a download.
if (e && e.mediaType) {
const L2AState = l2AStateDict[e.mediaType];
if (L2AState && L2AState.state !== L2A_STATE_ONE_BITRATE) {
L2AState.abrQuality = e.newQuality;
}
}
}
/**
* Dot multiplication of two arrays
* @param {array} arr1
* @param {array} arr2
* @return {number} sumdot
* @private
*/
function _dotmultiplication(arr1, arr2) {
if (arr1.length !== arr2.length) {
return -1;
}
let sumdot = 0;
for (let i = 0; i < arr1.length; i++) {
sumdot = sumdot + arr1[i] * arr2[i];
}
return sumdot;
}
/**
* Project an n-dim vector y to the simplex Dn
* Dn = { x : x n-dim, 1 >= x >= 0, sum(x) = 1}
* Algorithm is explained at http://arxiv.org/abs/1101.6081
* @param {array} arr
* @return {array}
*/
function euclideanProjection(arr) {
const m = arr.length;
let bget = false;
let arr2 = [];
for (let ii = 0; ii < m; ++ii) {
arr2[ii] = arr[ii];
}
let s = arr.sort(function (a, b) {
return b - a;
});
let tmpsum = 0;
let tmax = 0;
let x = [];
for (let ii = 0; ii < m - 1; ++ii) {
tmpsum = tmpsum + s[ii];
tmax = (tmpsum - 1) / (ii + 1);
if (tmax >= s[ii + 1]) {
bget = true;
break;
}
}
if (!bget) {
tmax = (tmpsum + s[m - 1] - 1) / m;
}
for (let ii = 0; ii < m; ++ii) {
x[ii] = Math.max(arr2[ii] - tmax, 0);
}
return x;
}
/**
* Returns a switch request object indicating which quality is to be played
* @param {object} rulesContext
* @return {object}
*/
function getMaxIndex(rulesContext) {
const switchRequest = SwitchRequest(context).create();
const horizon = 4; // Optimization horizon (The amount of steps required to achieve convergence)
const vl = Math.pow(horizon, 0.99);// Cautiousness parameter, used to control aggressiveness of the bitrate decision process.
const alpha = Math.max(Math.pow(horizon, 1), vl * Math.sqrt(horizon));// Step size, used for gradient descent exploration granularity
const mediaInfo = rulesContext.getMediaInfo();
const mediaType = rulesContext.getMediaType();
const bitrates = mediaInfo.bitrateList.map(b => b.bandwidth);
const bitrateCount = bitrates.length;
const scheduleController = rulesContext.getScheduleController();
const streamInfo = rulesContext.getStreamInfo();
const abrController = rulesContext.getAbrController();
const throughputHistory = abrController.getThroughputHistory();
const isDynamic = streamInfo && streamInfo.manifestInfo && streamInfo.manifestInfo.isDynamic;
const useL2AABR = rulesContext.useL2AABR();
const bufferLevel = dashMetrics.getCurrentBufferLevel(mediaType, true);
const safeThroughput = throughputHistory.getSafeAverageThroughput(mediaType, isDynamic);
const throughput = throughputHistory.getAverageThroughput(mediaType, isDynamic); // In kbits/s
const react = 2; // Reactiveness to volatility (abrupt throughput drops), used to re-calibrate Lagrangian multiplier Q
const latency = throughputHistory.getAverageLatency(mediaType);
const videoModel = rulesContext.getVideoModel();
let quality;
let currentPlaybackRate = videoModel.getPlaybackRate();
if (!rulesContext || !rulesContext.hasOwnProperty('getMediaInfo') || !rulesContext.hasOwnProperty('getMediaType') ||
!rulesContext.hasOwnProperty('getScheduleController') || !rulesContext.hasOwnProperty('getStreamInfo') ||
!rulesContext.hasOwnProperty('getAbrController') || !rulesContext.hasOwnProperty('useL2AABR')) {
return switchRequest;
}
switchRequest.reason = switchRequest.reason || {};
if ((!useL2AABR) || (mediaType === Constants.AUDIO)) {// L2A decides bitrate only for video. Audio to be included in decision process in a later stage
return switchRequest;
}
scheduleController.setTimeToLoadDelay(0);
const l2AState = _getL2AState(rulesContext);
if (l2AState.state === L2A_STATE_ONE_BITRATE) {
// shouldn't even have been called
return switchRequest;
}
const l2AParameter = l2AParameterDict[mediaType];
if (!l2AParameter) {
return switchRequest;
}
switchRequest.reason.state = l2AState.state;
switchRequest.reason.throughput = throughput;
switchRequest.reason.latency = latency;
if (isNaN(throughput)) {
// still starting up - not enough information
return switchRequest;
}
switch (l2AState.state) {
case L2A_STATE_STARTUP:
quality = abrController.getQualityForBitrate(mediaInfo, safeThroughput, streamInfo.id, latency);//During strat-up phase abr.controller is responsible for bitrate decisions.
switchRequest.quality = quality;
switchRequest.reason.throughput = safeThroughput;
l2AState.lastQuality = quality;
if (!isNaN(l2AState.lastSegmentDurationS) && bufferLevel >= l2AParameter.B_target) {
l2AState.state = L2A_STATE_STEADY;
l2AParameter.Q = vl;// Initialization of Q langrangian multiplier
// Update of probability vector w, to be used in main adaptation logic of L2A below (steady state)
for (let i = 0; i < bitrateCount; ++i) {
if (i === l2AState.lastQuality) {
l2AParameter.prev_w[i] = 1;
} else {
l2AParameter.prev_w[i] = 0;
}
}
}
break; // L2A_STATE_STARTUP
case L2A_STATE_STEADY:
let diff1 = [];//Used to calculate the difference between consecutive decisions (w-w_prev)
// Manual calculation of latency and throughput during previous request
let throughputMeasureTime = dashMetrics.getCurrentHttpRequest(mediaType).trace.reduce((a, b) => a + b.d, 0);
const downloadBytes = dashMetrics.getCurrentHttpRequest(mediaType).trace.reduce((a, b) => a + b.b[0], 0);
let lastthroughput = Math.round((8 * downloadBytes) / throughputMeasureTime); // bits/ms = kbits/s
if (lastthroughput < 1) {
lastthroughput = 1;
}//To avoid division with 0 (avoid infinity) in case of an absolute network outage
let V = l2AState.lastSegmentDurationS;
let sign = 1;
//Main adaptation logic of L2A-LL
for (let i = 0; i < bitrateCount; ++i) {
bitrates[i] = bitrates[i] / 1000; // Originally in bps, now in Kbps
if (currentPlaybackRate * bitrates[i] > lastthroughput) {// In this case buffer would deplete, leading to a stall, which increases latency and thus the particular probability of selsection of bitrate[i] should be decreased.
sign = -1;
}
// The objective of L2A is to minimize the overall latency=request-response time + buffer length after download+ potential stalling (if buffer less than chunk downlad time)
l2AParameter.w[i] = l2AParameter.prev_w[i] + sign * (V / (2 * alpha)) * ((l2AParameter.Q + vl) * (currentPlaybackRate * bitrates[i] / lastthroughput));//Lagrangian descent
}
// Apply euclidean projection on w to ensure w expresses a probability distribution
l2AParameter.w = euclideanProjection(l2AParameter.w);
for (let i = 0; i < bitrateCount; ++i) {
diff1[i] = l2AParameter.w[i] - l2AParameter.prev_w[i];
l2AParameter.prev_w[i] = l2AParameter.w[i];
}
// Lagrangian multiplier Q calculation:
l2AParameter.Q = Math.max(0, l2AParameter.Q - V + V * currentPlaybackRate * ((_dotmultiplication(bitrates, l2AParameter.prev_w) + _dotmultiplication(bitrates, diff1)) / lastthroughput));
// Quality is calculated as argmin of the absolute difference between available bitrates (bitrates[i]) and bitrate estimation (dotmultiplication(w,bitrates)).
let temp = [];
for (let i = 0; i < bitrateCount; ++i) {
temp[i] = Math.abs(bitrates[i] - _dotmultiplication(l2AParameter.w, bitrates));
}
// Quality is calculated based on the probability distribution w (the output of L2A)
quality = temp.indexOf(Math.min(...temp));
// We employ a cautious -stepwise- ascent
if (quality > l2AState.lastQuality) {
if (bitrates[l2AState.lastQuality + 1] <= lastthroughput) {
quality = l2AState.lastQuality + 1;
}
}
// Provision against bitrate over-estimation, by re-calibrating the Lagrangian multiplier Q, to be taken into account for the next chunk
if (bitrates[quality] >= lastthroughput) {
l2AParameter.Q = react * Math.max(vl, l2AParameter.Q);
}
switchRequest.quality = quality;
switchRequest.reason.throughput = throughput;
switchRequest.reason.latency = latency;
switchRequest.reason.bufferLevel = bufferLevel;
l2AState.lastQuality = switchRequest.quality;
break;
default:
// should not arrive here, try to recover
logger.debug('L2A ABR rule invoked in bad state.');
switchRequest.quality = abrController.getQualityForBitrate(mediaInfo, safeThroughput, streamInfo.id, latency);
switchRequest.reason.state = l2AState.state;
switchRequest.reason.throughput = safeThroughput;
switchRequest.reason.latency = latency;
l2AState.state = L2A_STATE_STARTUP;
_clearL2AStateOnSeek(l2AState);
}
return switchRequest;
}
/**
* Reset objects to their initial state
* @private
*/
function _resetInitialSettings() {
l2AStateDict = {};
l2AParameterDict = {};
}
/**
* Reset the rule
*/
function reset() {
_resetInitialSettings();
eventBus.off(Events.PLAYBACK_SEEKING, _onPlaybackSeeking, instance);
eventBus.off(Events.MEDIA_FRAGMENT_LOADED, _onMediaFragmentLoaded, instance);
eventBus.off(Events.METRIC_ADDED, _onMetricAdded, instance);
eventBus.off(Events.QUALITY_CHANGE_REQUESTED, _onQualityChangeRequested, instance);
}
instance = {
getMaxIndex: getMaxIndex,
reset: reset
};
setup();
return instance;
}
L2ARule.__dashjs_factory_name = 'L2ARule';
export default FactoryMaker.getClassFactory(L2ARule);
</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>