Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 | 28x 28x 28x 28x 28x 28x 28x 28x 37x 37x 2x 35x 35x 35x 35x 35x 35x 35x 35x 2x 2x 33x 33x 33x 33x 33x 33x 33x 32x 32x 35x 1x 34x 3x 3x 1x 1x 1x 1x 1x 34x 34x 34x 34x 23x 23x 23x 11x 33x 33x 34x 34x 34x 34x 34x 34x 35x 24x 11x 11x 11x 64x 64x 64x 64x 64x 33x 1x 33x 1x 35x 35x 35x 35x 18x 2x 16x 1x 1x 4x 2x 2x 1x 1x 7x 54x 54x 54x 54x 28x 28x 28x 1x | /**
* 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) 2017, Dash Industry Forum.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
* * Neither the name of Dash Industry Forum nor the names of its
* contributors may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
import Constants from '../constants/Constants.js';
import FactoryMaker from '../../core/FactoryMaker.js';
import Debug from '../../core/Debug.js';
import {HTTPRequest} from '../vo/metrics/HTTPRequest.js';
import MediaPlayerEvents from '../MediaPlayerEvents.js';
import EventBus from '../../core/EventBus.js';
/**
* Throughput generally stored in kbit/s
* Latency generally stored in ms
* @param {object} config
* @ignore
* @constructor
*/
function ThroughputModel(config) {
config = config || {};
const context = this.context;
const debug = Debug(context).getInstance();
const settings = config.settings;
const eventBus = EventBus(context).getInstance();
let throughputDict,
latencyDict,
ewmaThroughputDict,
ewmaLatencyDict,
ewmaHalfLife,
logger;
function setup() {
logger = debug.getLogger(instance);
ewmaHalfLife = {
bandwidthHalfLife: {
fast: settings.get().streaming.abr.throughput.ewma.throughputFastHalfLifeSeconds,
slow: settings.get().streaming.abr.throughput.ewma.throughputSlowHalfLifeSeconds
},
latencyHalfLife: {
fast: settings.get().streaming.abr.throughput.ewma.latencyFastHalfLifeCount,
slow: settings.get().streaming.abr.throughput.ewma.latencySlowHalfLifeCount
}
};
reset();
}
/**
* Use the provided request to add new entries for throughput and latency. Update the EWMA state as well.
* @param {MediaType} mediaType
* @param {object} httpRequest
*/
function addEntry(mediaType, httpRequest) {
try {
if (!mediaType || !httpRequest || !httpRequest.trace || !httpRequest.trace.length) {
return;
}
_createSettingsForMediaType(mediaType);
const latencyInMs = (httpRequest.tresponse.getTime() - httpRequest.trequest.getTime()) || 1;
let throughputValues = _calculateThroughputValues(httpRequest, latencyInMs);
throughputValues.latencyInMs = latencyInMs;
Iif (isNaN(throughputValues.value) || !isFinite(throughputValues.value)) {
return;
}
// Get estimated throughput (etp, in kbits/s) from CMSD response headers
Iif (httpRequest.cmsd) {
const etp = httpRequest.cmsd.dynamic && httpRequest.cmsd.dynamic.etp ? httpRequest.cmsd.dynamic.etp : null;
if (etp) {
// Apply weight ratio on etp
const etpWeightRatio = settings.get().streaming.cmsd.abr.etpWeightRatio;
if (etpWeightRatio > 0 && etpWeightRatio <= 1) {
throughputValues.value = (throughputValues.value * (1 - etpWeightRatio)) + (etp * etpWeightRatio);
}
}
}
const cacheReferenceTime = (httpRequest._tfinish.getTime() - httpRequest.trequest.getTime());
if (_isCachedResponse(mediaType, cacheReferenceTime, httpRequest)) {
logger.debug(`${mediaType} Assuming segment ${httpRequest.url} came from cache, ignoring it for throughput calculation`);
return;
}
logger.debug(`Added throughput entry for ${mediaType}: ${throughputValues.value} kbit/s`)
throughputValues.serviceLocation = httpRequest._serviceLocation;
throughputDict[mediaType].push(throughputValues);
latencyDict[mediaType].push({ value: latencyInMs });
_cleanupDict(mediaType);
eventBus.trigger(MediaPlayerEvents.THROUGHPUT_MEASUREMENT_STORED, { throughputValues })
if (httpRequest.type !== HTTPRequest.MPD_TYPE) {
_updateEwmaValues(ewmaThroughputDict[mediaType], throughputValues.value, settings.get().streaming.abr.throughput.ewma.weightDownloadTimeMultiplicationFactor * throughputValues.downloadTimeInMs, ewmaHalfLife.bandwidthHalfLife);
_updateEwmaValues(ewmaLatencyDict[mediaType], latencyInMs, 1, ewmaHalfLife.latencyHalfLife);
}
} catch (e) {
logger.error(e);
}
}
/**
* Returns the throughput in kbit/s , the download time in ms and the downloaded bytes for an HTTP request
* @param {object} httpRequest
* @param {number} latencyInMs
* @return {object}
* @private
*/
function _calculateThroughputValues(httpRequest, latencyInMs) {
// Low latency is enabled, we used the fetch API and received chunks
if (httpRequest._fileLoaderType && httpRequest._fileLoaderType === Constants.FILE_LOADER_TYPES.FETCH) {
return _calculateThroughputValuesForFetch(httpRequest);
}
// Standard case, we used standard XHR requests
else {
return _calculateThroughputValuesForXhr(httpRequest, latencyInMs);
}
}
/**
* Calculates the throughput for requests using the Fetch API
* @param {object} httpRequest
* @param {number} latencyInMs
* @return {number}
* @private
*/
function _calculateThroughputValuesForFetch(httpRequest) {
const downloadedBytes = httpRequest.trace.reduce((prev, curr) => prev + curr.b[0], 0);
const downloadTimeInMs = httpRequest.trace.reduce((prev, curr) => prev + curr.d, 0);
let throughputInKbit = NaN;
Iif (settings.get().streaming.abr.throughput.useNetworkInformationApi.fetch) {
throughputInKbit = _deriveThroughputFromNetworkApi()
}
if (isNaN(throughputInKbit)) {
throughputInKbit = Math.round((8 * downloadedBytes) / downloadTimeInMs); // bits/ms = kbits/s
}
return {
downloadedBytes,
value: throughputInKbit,
downloadTimeInMs
};
}
/**
* Returns the throughput in kbit/s and the download time in ms for requests using XHR
* @param {object} httpRequest
* @param {number} latencyInMs
* @return {object}
* @private
*/
function _calculateThroughputValuesForXhr(httpRequest, latencyInMs) {
let downloadedBytes = NaN;
let downloadTimeInMs = NaN;
let deriveThroughputViaResourceTimingApi = false;
// Calculate the throughput using the ResourceTimingAPI if available
if (settings.get().streaming.abr.throughput.useResourceTimingApi && httpRequest._resourceTimingValues) {
downloadedBytes = httpRequest._resourceTimingValues.transferSize;
downloadTimeInMs = httpRequest._resourceTimingValues.responseEnd - httpRequest._resourceTimingValues.responseStart;
deriveThroughputViaResourceTimingApi = true;
}
// Use the standard throughput calculation if we can not use the Resource Timing API
else {
// We need at least two entries in the traces. The first entry includes the latency and the XHR progress event was thrown once bytes have already been received.
// The second progress event can be set in relation to the first progress event and therefor gives us more accurate values
Iif (httpRequest.trace.length <= 1) {
return { throughput: NaN, downloadTimeInMs: NaN }
}
downloadedBytes = httpRequest.trace.reduce((prev, curr) => prev + curr.b[0], 0) - httpRequest.trace[0].b[0];
downloadTimeInMs = Math.max(httpRequest.trace.reduce((prev, curr) => prev + curr.d, 0) - httpRequest.trace[0].d, 1);
}
// If available and enabled use the Network Information API
let throughputInKbit = NaN;
Iif (!deriveThroughputViaResourceTimingApi && settings.get().streaming.abr.throughput.useNetworkInformationApi.xhr) {
throughputInKbit = _deriveThroughputFromNetworkApi()
}
if (isNaN(throughputInKbit)) {
const referenceTimeInMs = settings.get().streaming.abr.throughput.useDeadTimeLatency ? downloadTimeInMs : downloadTimeInMs + latencyInMs;
throughputInKbit = Math.round((8 * downloadedBytes) / referenceTimeInMs) // bits/ms = kbits/s
}
return {
downloadedBytes,
value: throughputInKbit,
downloadTimeInMs
};
}
/**
* Return the current estimated bandwidth based on NetworkInformation.downlink if the API is available
* @returns {*|number}
* @private
*/
function _deriveThroughputFromNetworkApi() {
// NetworkInformation.downlink: Returns the effective bandwidth estimate in megabits per second, rounded to the nearest multiple of 25 kilobits per seconds.
if (navigator && navigator.connection && !isNaN(navigator.connection.downlink) && navigator.connection.downlink > 0) {
return navigator.connection.downlink * 1000
}
return NaN
}
/**
* Check if the response was cached.
* @param {MediaType} mediaType
* @param {number} cacheReferenceTime
* @param {object} httpRequest
* @return {boolean}
* @private
*/
function _isCachedResponse(mediaType, cacheReferenceTime, httpRequest) {
if (settings.get().streaming.abr.throughput.useResourceTimingApi && httpRequest._resourceTimingValues) {
return httpRequest._resourceTimingValues.transferSize === 0 && httpRequest._resourceTimingValues.decodedBodySize > 0
}
Iif (isNaN(cacheReferenceTime)) {
return false;
}
if (mediaType === Constants.VIDEO) {
return cacheReferenceTime < settings.get().streaming.cacheLoadThresholds[Constants.VIDEO];
} else Eif (mediaType === Constants.AUDIO) {
return cacheReferenceTime < settings.get().streaming.cacheLoadThresholds[Constants.AUDIO];
}
}
/**
*
* @param {object} ewmaObj
* @param {number} value
* @param {number} weight
* @param {object} halfLife
* @private
*/
function _updateEwmaValues(ewmaObj, value, weight, halfLife) {
// Note about startup:
// Estimates start at 0, so early values are underestimated.
// This effect is countered in getAverageEwma() by dividing the estimates by:
// 1 - Math.pow(0.5, ewmaObj.totalWeight / halfLife)
const fastAlpha = Math.pow(0.5, weight / halfLife.fast);
ewmaObj.fastEstimate = (1 - fastAlpha) * value + fastAlpha * ewmaObj.fastEstimate;
const slowAlpha = Math.pow(0.5, weight / halfLife.slow);
ewmaObj.slowEstimate = (1 - slowAlpha) * value + slowAlpha * ewmaObj.slowEstimate;
ewmaObj.totalWeight += weight;
}
/**
* Shift old entries once we reached the threshold
* @param {MediaType} mediaType
* @private
*/
function _cleanupDict(mediaType) {
if (throughputDict[mediaType].length > settings.get().streaming.abr.throughput.sampleSettings.maxMeasurementsToKeep) {
throughputDict[mediaType].shift();
}
if (latencyDict[mediaType].length > settings.get().streaming.abr.throughput.sampleSettings.maxMeasurementsToKeep) {
latencyDict[mediaType].shift();
}
}
/**
* Setup the dict objects for a specific media type
* @param mediaType
* @private
*/
function _createSettingsForMediaType(mediaType) {
throughputDict[mediaType] = throughputDict[mediaType] || [];
latencyDict[mediaType] = latencyDict[mediaType] || [];
ewmaThroughputDict[mediaType] = ewmaThroughputDict[mediaType] || {
fastEstimate: 0,
slowEstimate: 0,
totalWeight: 0
};
ewmaLatencyDict[mediaType] = ewmaLatencyDict[mediaType] || { fastEstimate: 0, slowEstimate: 0, totalWeight: 0 };
}
function getThroughputDict(mediaType) {
if (!mediaType) {
return throughputDict
}
return throughputDict[mediaType];
}
function getEwmaThroughputDict(mediaType) {
Iif (!mediaType) {
return ewmaThroughputDict
}
return ewmaThroughputDict[mediaType]
}
function getLatencyDict(mediaType) {
if (!mediaType) {
return latencyDict
}
return latencyDict[mediaType];
}
function getEwmaLatencyDict(mediaType) {
Iif (!mediaType) {
return ewmaLatencyDict
}
return ewmaLatencyDict[mediaType];
}
function getEwmaHalfLife() {
return ewmaHalfLife;
}
/**
* Reset all values
*/
function reset() {
throughputDict = {};
latencyDict = {};
ewmaThroughputDict = {};
ewmaLatencyDict = {};
}
const instance = {
addEntry,
getThroughputDict,
getEwmaThroughputDict,
getEwmaLatencyDict,
getEwmaHalfLife,
getLatencyDict,
reset
};
setup();
return instance;
}
ThroughputModel.__dashjs_factory_name = 'ThroughputModel';
export default FactoryMaker.getClassFactory(ThroughputModel);
|