dashjs/build/es5/src/streaming/models/MetricsModel.js

A reference client implementation for the playback of MPEG DASH via Javascript and compliant browsers.

'use strict';Object.defineProperty(exports,"__esModule",{value:true});var _Constants=require('../constants/Constants');var _Constants2=_interopRequireDefault(_Constants);var _MetricsConstants=require('../constants/MetricsConstants');var _MetricsConstants2=_interopRequireDefault(_MetricsConstants);var _MetricsList=require('../vo/MetricsList');var _MetricsList2=_interopRequireDefault(_MetricsList);var _HTTPRequest=require('../vo/metrics/HTTPRequest');var _RepresentationSwitch=require('../vo/metrics/RepresentationSwitch');var _RepresentationSwitch2=_interopRequireDefault(_RepresentationSwitch);var _BufferLevel=require('../vo/metrics/BufferLevel');var _BufferLevel2=_interopRequireDefault(_BufferLevel);var _BufferState=require('../vo/metrics/BufferState');var _BufferState2=_interopRequireDefault(_BufferState);var _DVRInfo=require('../vo/metrics/DVRInfo');var _DVRInfo2=_interopRequireDefault(_DVRInfo);var _DroppedFrames=require('../vo/metrics/DroppedFrames');var _DroppedFrames2=_interopRequireDefault(_DroppedFrames);var _ManifestUpdate=require('../vo/metrics/ManifestUpdate');var _SchedulingInfo=require('../vo/metrics/SchedulingInfo');var _SchedulingInfo2=_interopRequireDefault(_SchedulingInfo);var _EventBus=require('../../core/EventBus');var _EventBus2=_interopRequireDefault(_EventBus);var _RequestsQueue=require('../vo/metrics/RequestsQueue');var _RequestsQueue2=_interopRequireDefault(_RequestsQueue);var _Events=require('../../core/events/Events');var _Events2=_interopRequireDefault(_Events);var _FactoryMaker=require('../../core/FactoryMaker');var _FactoryMaker2=_interopRequireDefault(_FactoryMaker);function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj};}function MetricsModel(config){config=config||{};var settings=config.settings;var context=this.context;var eventBus=(0,_EventBus2.default)(context).getInstance();var instance=void 0,streamMetrics=void 0;function setup(){streamMetrics={};}function metricsChanged(){eventBus.trigger(_Events2.default.METRICS_CHANGED);}function metricChanged(mediaType){eventBus.trigger(_Events2.default.METRIC_CHANGED,{mediaType:mediaType});metricsChanged();}function metricUpdated(mediaType,metricType,vo){eventBus.trigger(_Events2.default.METRIC_UPDATED,{mediaType:mediaType,metric:metricType,value:vo});metricChanged(mediaType);}function metricAdded(mediaType,metricType,vo){eventBus.trigger(_Events2.default.METRIC_ADDED,{mediaType:mediaType,metric:metricType,value:vo});metricChanged(mediaType);}function clearCurrentMetricsForType(type){delete streamMetrics[type];metricChanged(type);}function clearAllCurrentMetrics(){streamMetrics={};metricsChanged();}function getMetricsFor(type,readOnly){var metrics=null;if(!type){return metrics;}if(streamMetrics.hasOwnProperty(type)){metrics=streamMetrics[type];}else if(!readOnly){metrics=new _MetricsList2.default();streamMetrics[type]=metrics;}return metrics;}function pushMetrics(type,list,value){var metrics=getMetricsFor(type);metrics[list].push(value);if(metrics[list].length>settings.get().streaming.metricsMaxListDepth){metrics[list].shift();}}function appendHttpTrace(httpRequest,s,d,b){var vo=new _HTTPRequest.HTTPRequestTrace();vo.s=s;vo.d=d;vo.b=b;httpRequest.trace.push(vo);if(!httpRequest.interval){httpRequest.interval=0;}httpRequest.interval+=d;return vo;}function addHttpRequest(mediaType,tcpid,type,url,actualurl,serviceLocation,range,trequest,tresponse,tfinish,responsecode,mediaduration,responseHeaders,traces){var vo=new _HTTPRequest.HTTPRequest();// ISO 23009-1 D.4.3 NOTE 2:
// All entries for a given object will have the same URL and range
// and so can easily be correlated. If there were redirects or
// failures there will be one entry for each redirect/failure.
// The redirect-to URL or alternative url (where multiple have been
// provided in the MPD) will appear as the actualurl of the next
// entry with the same url value.
if(actualurl&&actualurl!==url){// given the above, add an entry for the original request
addHttpRequest(mediaType,null,type,url,null,null,range,trequest,null,// unknown
null,// unknown
null,// unknown, probably a 302
mediaduration,null,null);vo.actualurl=actualurl;}vo.tcpid=tcpid;vo.type=type;vo.url=url;vo.range=range;vo.trequest=trequest;vo.tresponse=tresponse;vo.responsecode=responsecode;vo._tfinish=tfinish;vo._stream=mediaType;vo._mediaduration=mediaduration;vo._responseHeaders=responseHeaders;vo._serviceLocation=serviceLocation;if(traces){traces.forEach(function(trace){appendHttpTrace(vo,trace.s,trace.d,trace.b);});}else{// The interval and trace shall be absent for redirect and failure records.
delete vo.interval;delete vo.trace;}pushAndNotify(mediaType,_MetricsConstants2.default.HTTP_REQUEST,vo);}function addRepresentationSwitch(mediaType,t,mt,to,lto){var vo=new _RepresentationSwitch2.default();vo.t=t;vo.mt=mt;vo.to=to;if(lto){vo.lto=lto;}else{delete vo.lto;}pushAndNotify(mediaType,_MetricsConstants2.default.TRACK_SWITCH,vo);}function pushAndNotify(mediaType,metricType,metricObject){pushMetrics(mediaType,metricType,metricObject);metricAdded(mediaType,metricType,metricObject);}function addBufferLevel(mediaType,t,level){var vo=new _BufferLevel2.default();vo.t=t;vo.level=level;pushAndNotify(mediaType,_MetricsConstants2.default.BUFFER_LEVEL,vo);}function addBufferState(mediaType,state,target){var vo=new _BufferState2.default();vo.target=target;vo.state=state;pushAndNotify(mediaType,_MetricsConstants2.default.BUFFER_STATE,vo);}function addDVRInfo(mediaType,currentTime,mpd,range){var vo=new _DVRInfo2.default();vo.time=currentTime;vo.range=range;vo.manifestInfo=mpd;pushAndNotify(mediaType,_MetricsConstants2.default.DVR_INFO,vo);}function addDroppedFrames(mediaType,quality){var vo=new _DroppedFrames2.default();var list=getMetricsFor(mediaType).DroppedFrames;vo.time=quality.creationTime;vo.droppedFrames=quality.droppedVideoFrames;if(list.length>0&&list[list.length-1]==vo){return;}pushAndNotify(mediaType,_MetricsConstants2.default.DROPPED_FRAMES,vo);}function addSchedulingInfo(mediaType,t,type,startTime,availabilityStartTime,duration,quality,range,state){var vo=new _SchedulingInfo2.default();vo.mediaType=mediaType;vo.t=t;vo.type=type;vo.startTime=startTime;vo.availabilityStartTime=availabilityStartTime;vo.duration=duration;vo.quality=quality;vo.range=range;vo.state=state;pushAndNotify(mediaType,_MetricsConstants2.default.SCHEDULING_INFO,vo);}function addRequestsQueue(mediaType,loadingRequests,executedRequests){var vo=new _RequestsQueue2.default();vo.loadingRequests=loadingRequests;vo.executedRequests=executedRequests;getMetricsFor(mediaType).RequestsQueue=vo;metricAdded(mediaType,_MetricsConstants2.default.REQUESTS_QUEUE,vo);}function addManifestUpdate(mediaType,type,requestTime,fetchTime,availabilityStartTime,presentationStartTime,clientTimeOffset,currentTime,buffered,latency){var vo=new _ManifestUpdate.ManifestUpdate();vo.mediaType=mediaType;vo.type=type;vo.requestTime=requestTime;// when this manifest update was requested
vo.fetchTime=fetchTime;// when this manifest update was received
vo.availabilityStartTime=availabilityStartTime;vo.presentationStartTime=presentationStartTime;// the seek point (liveEdge for dynamic, Stream[0].startTime for static)
vo.clientTimeOffset=clientTimeOffset;// the calculated difference between the server and client wall clock time
vo.currentTime=currentTime;// actual element.currentTime
vo.buffered=buffered;// actual element.ranges
vo.latency=latency;// (static is fixed value of zero. dynamic should be ((Now-@availabilityStartTime) - currentTime)
pushMetrics(_Constants2.default.STREAM,_MetricsConstants2.default.MANIFEST_UPDATE,vo);metricAdded(mediaType,_MetricsConstants2.default.MANIFEST_UPDATE,vo);}function updateManifestUpdateInfo(manifestUpdate,updatedFields){if(manifestUpdate){for(var field in updatedFields){manifestUpdate[field]=updatedFields[field];}metricUpdated(manifestUpdate.mediaType,_MetricsConstants2.default.MANIFEST_UPDATE,manifestUpdate);}}function addManifestUpdateStreamInfo(manifestUpdate,id,index,start,duration){if(manifestUpdate){var vo=new _ManifestUpdate.ManifestUpdateStreamInfo();vo.id=id;vo.index=index;vo.start=start;vo.duration=duration;manifestUpdate.streamInfo.push(vo);metricUpdated(manifestUpdate.mediaType,_MetricsConstants2.default.MANIFEST_UPDATE_STREAM_INFO,manifestUpdate);}}function addManifestUpdateRepresentationInfo(manifestUpdate,id,index,streamIndex,mediaType,presentationTimeOffset,startNumber,fragmentInfoType){if(manifestUpdate){var vo=new _ManifestUpdate.ManifestUpdateRepresentationInfo();vo.id=id;vo.index=index;vo.streamIndex=streamIndex;vo.mediaType=mediaType;vo.startNumber=startNumber;vo.fragmentInfoType=fragmentInfoType;vo.presentationTimeOffset=presentationTimeOffset;manifestUpdate.representationInfo.push(vo);metricUpdated(manifestUpdate.mediaType,_MetricsConstants2.default.MANIFEST_UPDATE_TRACK_INFO,manifestUpdate);}}function addPlayList(vo){if(vo.trace&&Array.isArray(vo.trace)){vo.trace.forEach(function(trace){if(trace.hasOwnProperty('subreplevel')&&!trace.subreplevel){delete trace.subreplevel;}});}else{delete vo.trace;}pushAndNotify(_Constants2.default.STREAM,_MetricsConstants2.default.PLAY_LIST,vo);}function addDVBErrors(vo){pushAndNotify(_Constants2.default.STREAM,_MetricsConstants2.default.DVB_ERRORS,vo);}instance={clearCurrentMetricsForType:clearCurrentMetricsForType,clearAllCurrentMetrics:clearAllCurrentMetrics,getMetricsFor:getMetricsFor,addHttpRequest:addHttpRequest,addRepresentationSwitch:addRepresentationSwitch,addBufferLevel:addBufferLevel,addBufferState:addBufferState,addDVRInfo:addDVRInfo,addDroppedFrames:addDroppedFrames,addSchedulingInfo:addSchedulingInfo,addRequestsQueue:addRequestsQueue,addManifestUpdate:addManifestUpdate,updateManifestUpdateInfo:updateManifestUpdateInfo,addManifestUpdateStreamInfo:addManifestUpdateStreamInfo,addManifestUpdateRepresentationInfo:addManifestUpdateRepresentationInfo,addPlayList:addPlayList,addDVBErrors:addDVBErrors};setup();return instance;}/**
 * The copyright in this software is being made available under the BSD License,
 * included below. This software may be subject to other third party and contributor
 * rights, including patent rights, and no such rights are granted under this license.
 *
 * Copyright (c) 2013, Dash Industry Forum.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *  * Redistributions of source code must retain the above copyright notice, this
 *  list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation and/or
 *  other materials provided with the distribution.
 *  * Neither the name of Dash Industry Forum nor the names of its
 *  contributors may be used to endorse or promote products derived from this software
 *  without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY
 *  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */MetricsModel.__dashjs_factory_name='MetricsModel';exports.default=_FactoryMaker2.default.getSingletonFactory(MetricsModel);
//# sourceMappingURL=MetricsModel.js.map