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 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 | 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 70x 3x 56x 56x 56x 56x 56x 56x 54x 54x 34x 34x 34x 34x 52x 52x 51x 51x 51x 34x 34x 1x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 28x 28x 17x 17x 17x 13x 4x 28x 28x 28x 14x 14x 7x 7x 6x 5x 6x 6x 7x 7x 7x 7x 7x 7x 5x 5x 2x 2x 1x 11x 11x 10x 9x 10x 14x 14x 14x 14x 14x 14x 12x 2x 12x 12x 2x 10x 1x 21x 21x 21x 21x 21x 15x 21x 6x 21x 17x 17x 17x 17x 4x 2x 2x 2x 2x 2x 21x 2x 2x 2x 2x 2x 2x 34x 34x 34x 68x 68x 68x 14x 14x 14x 14x 68x 96x 96x 96x 96x 25x 25x 25x 27x 27x 31x 31x 25x 25x 4x 4x 1x 3x 3x 30x 30x 30x 30x 17x 17x 17x 17x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 54x 54x 54x 54x 54x 54x 54x 54x 54x 54x 2x 2x 2x 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) 2013, Dash Industry Forum.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
* * Neither the name of Dash Industry Forum nor the names of its
* contributors may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
import FactoryMaker from '../../core/FactoryMaker.js';
import Debug from '../../core/Debug.js';
import EventBus from '../../core/EventBus.js';
import MediaPlayerEvents from '../../streaming/MediaPlayerEvents.js';
import XHRLoader from '../net/XHRLoader.js';
import Utils from '../../core/Utils.js';
import CommonMediaRequest from '../vo/CommonMediaRequest.js';
import CommonMediaResponse from '../vo/CommonMediaResponse.js';
function EventController() {
const MPD_RELOAD_SCHEME = 'urn:mpeg:dash:event:2012';
const MPD_RELOAD_VALUE = 1;
const MPD_CALLBACK_SCHEME = 'urn:mpeg:dash:event:callback:2015';
const MPD_CALLBACK_VALUE = 1;
const REMAINING_EVENTS_THRESHOLD = 300;
const EVENT_HANDLED_STATES = {
DISCARDED: 'discarded',
UPDATED: 'updated',
ADDED: 'added'
};
const context = this.context;
const eventBus = EventBus(context).getInstance();
let instance,
logger,
inlineEvents, // Holds all Inline Events not triggered yet
inbandEvents, // Holds all Inband Events not triggered yet
eventInterval, // variable holding the setInterval
lastEventTimerCall,
manifestUpdater,
playbackController,
settings,
eventHandlingInProgress,
isStarted;
/**
* Internal setup when class is instanced
*/
function _setup() {
logger = Debug(context).getInstance().getLogger(instance);
_resetInitialSettings();
}
/**
* Checks if the provded configuration is valid
*/
function checkConfig() {
if (!manifestUpdater || !playbackController) {
throw new Error('setConfig function has to be called previously');
}
}
/**
* Reset to initial settings
*/
function _resetInitialSettings() {
isStarted = false;
inlineEvents = {}; // Format inlineEvents[periodID][schemeIdUri]
inbandEvents = {}; // Format inbandEvents[periodID][schemeIdUri]
eventInterval = null;
eventHandlingInProgress = false;
lastEventTimerCall = Date.now() / 1000;
}
/**
* Stops the EventController by clearing the event interval
*/
function _stop() {
try {
if (eventInterval !== null && isStarted) {
clearInterval(eventInterval);
eventInterval = null;
isStarted = false;
_onStopEventController();
}
} catch (e) {
throw e;
}
}
/**
* Starts the interval function of the EventController
*/
function start() {
try {
checkConfig();
logger.debug('Start Event Controller');
const refreshDelay = settings.get().streaming.events.eventControllerRefreshDelay;
if (!isStarted && !isNaN(refreshDelay)) {
isStarted = true;
eventInterval = setInterval(_onEventTimer, refreshDelay);
}
} catch (e) {
throw e;
}
}
/**
* Iterate through the eventList and trigger the events
*/
function _onEventTimer() {
try {
if (!eventHandlingInProgress) {
eventHandlingInProgress = true;
const currentVideoTime = playbackController.getTime();
let presentationTimeThreshold = (currentVideoTime - lastEventTimerCall);
// For dynamic streams lastEventTimeCall will be large in the first iteration. Avoid firing all events at once.
presentationTimeThreshold = lastEventTimerCall > 0 ? Math.max(0, presentationTimeThreshold) : 0;
_triggerEvents(inbandEvents, presentationTimeThreshold, currentVideoTime);
_triggerEvents(inlineEvents, presentationTimeThreshold, currentVideoTime);
_removeOutdatedEventObjects(inbandEvents);
_removeOutdatedEventObjects(inlineEvents);
lastEventTimerCall = currentVideoTime;
eventHandlingInProgress = false;
}
} catch (e) {
eventHandlingInProgress = false;
logger.error(e);
}
}
/**
* Iterate over a list of events and trigger the ones for which the presentation time is within the current timing interval
* @param {object} events
* @param {number} presentationTimeThreshold
* @param {number} currentVideoTime
* @private
*/
function _triggerEvents(events, presentationTimeThreshold, currentVideoTime) {
try {
const callback = function (event) {
if (event !== undefined) {
const duration = !isNaN(event.duration) ? event.duration : 0;
// The event is either about to start or has already been started and we are within its duration
if ((event.calculatedPresentationTime <= currentVideoTime && event.calculatedPresentationTime + presentationTimeThreshold + duration >= currentVideoTime)) {
_startEvent(event, MediaPlayerEvents.EVENT_MODE_ON_START);
} else Iif (_eventHasExpired(currentVideoTime, duration + presentationTimeThreshold, event.calculatedPresentationTime) || _eventIsInvalid(event)) {
logger.debug(`Removing event ${event.id} from period ${event.eventStream.period.id} as it is expired or invalid`);
_removeEvent(events, event);
}
}
};
_iterateAndTriggerCallback(events, callback);
} catch (e) {
logger.error(e);
}
}
/**
* Iterates over the entries of the events object and deletes the entries for which no events are present
* @param {object} events
* @private
*/
function _removeOutdatedEventObjects(events) {
try {
for (const key in events) {
if (events.hasOwnProperty(key)) {
Iif (Object.keys(events[key]).length === 0) {
delete events[key];
}
}
}
} catch (e) {
logger.error(e);
}
}
/**
* Add MPD events to the list of events.
* Events that are not in the MPD anymore but not triggered yet will still be deleted.
* Existing events might get updated.
* @param {Array.<Object>} values
* @param {string} periodId
*/
function addInlineEvents(values, periodId) {
try {
checkConfig();
if (!inlineEvents[periodId]) {
inlineEvents[periodId] = {};
}
if (values) {
for (let i = 0; i < values.length; i++) {
let event = values[i];
const currentTime = playbackController.getTime();
const duration = !isNaN(event.duration) ? event.duration : 0;
if (!_eventHasExpired(currentTime, duration, event.calculatedPresentationTime)) {
let result = _addOrUpdateEvent(event, inlineEvents[periodId], true);
if (result === EVENT_HANDLED_STATES.ADDED) {
logger.debug(`Added inline event with id ${event.id} from period ${periodId}`);
// If we see the event for the first time we trigger it in onReceive mode
_startEvent(event, MediaPlayerEvents.EVENT_MODE_ON_RECEIVE);
} else if (result === EVENT_HANDLED_STATES.UPDATED) {
logger.debug(`Updated inline event with id ${event.id} from period ${periodId}`);
}
}
}
}
} catch (e) {
throw e;
}
}
/**
* Add EMSG events to the list of events
* Messages with the same id within the scope of the same scheme_id_uri and value pair are equivalent , i.e. processing of any one event message box with the same id is sufficient.
* @param {Array.<Object>} values
* @param {string} periodId
*/
function addInbandEvents(values, periodId) {
try {
checkConfig();
if (!inbandEvents[periodId]) {
inbandEvents[periodId] = {};
}
for (let i = 0; i < values.length; i++) {
let event = values[i];
const currentTime = playbackController.getTime();
const duration = !isNaN(event.duration) ? event.duration : 0;
if (!_eventHasExpired(currentTime, duration, event.calculatedPresentationTime)) {
let result = _addOrUpdateEvent(event, inbandEvents[periodId], false);
if (result === EVENT_HANDLED_STATES.ADDED) {
if (event.eventStream.schemeIdUri === MPD_RELOAD_SCHEME) {
_handleManifestReloadEvent(event);
}
logger.debug(`Added inband event with id ${event.id} from period ${periodId}`);
_startEvent(event, MediaPlayerEvents.EVENT_MODE_ON_RECEIVE);
} else {
logger.debug(`Inband event with scheme_id_uri ${event.eventStream.schemeIdUri}, value ${event.eventStream.value}, period id ${periodId} and event id ${event.id} was ignored because it has been added before.`);
}
}
}
_onEventTimer();
} catch (e) {
throw e;
}
}
/**
* Adds or updates an event to/in the list of events
* @param {object} event
* @param {object} events
* @param {boolean} shouldOverwriteExistingEvents
* @return {string}
* @private
*/
function _addOrUpdateEvent(event, events, shouldOverwriteExistingEvents = false) {
const schemeIdUri = event.eventStream.schemeIdUri;
const value = event.eventStream.value;
const id = event.id;
let eventState = EVENT_HANDLED_STATES.DISCARDED;
if (!events[schemeIdUri]) {
events[schemeIdUri] = [];
}
const indexOfExistingEvent = events[schemeIdUri].findIndex((e) => {
return ((!value || (e.eventStream.value && e.eventStream.value === value)) && (e.id === id));
});
// New event, we add it to our list of events
if (indexOfExistingEvent === -1) {
events[schemeIdUri].push(event);
event.triggeredReceivedEvent = false;
event.triggeredStartEvent = false;
eventState = EVENT_HANDLED_STATES.ADDED;
}
// We have a similar event for this period with the same schemeIdUri, value and id. Overwrite it or ignore it
else if (shouldOverwriteExistingEvents) {
const oldEvent = events[schemeIdUri][indexOfExistingEvent];
event.triggeredReceivedEvent = oldEvent.triggeredReceivedEvent;
event.triggeredStartEvent = oldEvent.triggeredStartEvent;
events[schemeIdUri][indexOfExistingEvent] = event;
eventState = EVENT_HANDLED_STATES.UPDATED;
}
return eventState;
}
/**
* Triggers an MPD reload
* @param {object} event
* @private
*/
function _handleManifestReloadEvent(event) {
try {
if (event.eventStream.value == MPD_RELOAD_VALUE) {
const validUntil = event.calculatedPresentationTime;
let newDuration;
Iif (event.calculatedPresentationTime == 0xFFFFFFFF) {//0xFF... means remaining duration unknown
newDuration = NaN;
} else {
newDuration = event.calculatedPresentationTime + event.duration;
}
//logger.info('Manifest validity changed: Valid until: ' + validUntil + '; remaining duration: ' + newDuration);
eventBus.trigger(MediaPlayerEvents.MANIFEST_VALIDITY_CHANGED, {
id: event.id,
validUntil: validUntil,
newDuration: newDuration,
newManifestValidAfter: NaN //event.message_data - this is an arraybuffer with a timestring in it, but not used yet
}, {
mode: MediaPlayerEvents.EVENT_MODE_ON_START
});
}
} catch (e) {
logger.error(e);
}
}
/**
* When the EventController is stopped this callback is triggered. Starts the remaining events.
* @private
*/
function _onStopEventController() {
try {
// EventController might be stopped before the period is over. Before we stop the event controller we check for events that needs to be triggered at the period boundary.
_triggerRemainingEvents(inbandEvents);
_triggerRemainingEvents(inlineEvents);
} catch (e) {
logger.error(e);
}
}
/**
* Triggers the remaining events after the EventController has been stopped
* @param {object} events
* @private
*/
function _triggerRemainingEvents(events) {
try {
const currentTime = playbackController.getTime();
const callback = function (event) {
const periodDuration = event.eventStream && event.eventStream.period && !isNaN(event.eventStream.period.duration) ? event.eventStream.period.duration : NaN;
const periodStart = event.eventStream && event.eventStream.period && !isNaN(event.eventStream.period.start) ? event.eventStream.period.start : NaN;
if (isNaN(periodDuration) || isNaN(periodStart)) {
return;
}
const calculatedPresentationTimeInSeconds = event.calculatedPresentationTime;
if (Math.abs(calculatedPresentationTimeInSeconds - currentTime) < REMAINING_EVENTS_THRESHOLD) {
_startEvent(event, MediaPlayerEvents.EVENT_MODE_ON_START);
}
};
_iterateAndTriggerCallback(events, callback);
} catch (e) {
logger.error(e);
}
}
/**
* Iterates over the inline/inband event object and triggers a callback for each event
* @param {object} events
* @param {function} callback
* @private
*/
function _iterateAndTriggerCallback(events, callback) {
try {
if (events) {
const periodIds = Object.keys(events);
for (let i = 0; i < periodIds.length; i++) {
const currentPeriod = events[periodIds[i]];
const schemeIdUris = Object.keys(currentPeriod);
for (let j = 0; j < schemeIdUris.length; j++) {
const schemeIdEvents = currentPeriod[schemeIdUris[j]];
schemeIdEvents.forEach((event) => {
if (event !== undefined) {
callback(event);
}
});
}
}
}
} catch (e) {
logger.error(e);
}
}
/**
* Checks if an event is expired. For instance if the presentationTime + the duration of an event are smaller than the current video time.
* @param {number} currentVideoTime
* @param {number} threshold
* @param {number} calculatedPresentationTimeInSeconds
* @return {boolean}
* @private
*/
function _eventHasExpired(currentVideoTime, threshold, calculatedPresentationTimeInSeconds) {
try {
return currentVideoTime - threshold > calculatedPresentationTimeInSeconds;
} catch (e) {
logger.error(e);
return false;
}
}
/**
* Checks if an event is invalid. This is the case if the end time of the parent period is smaller than the presentation time of the event.
* @param {object} event
* @return {boolean}
* @private
*/
function _eventIsInvalid(event) {
try {
const periodEndTime = event.eventStream.period.start + event.eventStream.period.duration;
return event.calculatedPresentationTime > periodEndTime;
} catch (e) {
logger.error(e);
return false;
}
}
/**
* Starts an event. Depending on the schemeIdUri we distinguish between
* - MPD Reload events
* - MPD Callback events
* - Events to be dispatched to the application
* @param {object} event
* @param {String} mode
* @private
*/
function _startEvent(event, mode) {
try {
const currentVideoTime = playbackController.getTime();
const eventId = event.id;
if (mode === MediaPlayerEvents.EVENT_MODE_ON_RECEIVE && !event.triggeredReceivedEvent) {
logger.debug(`Received event ${eventId}`);
event.triggeredReceivedEvent = true;
eventBus.trigger(event.eventStream.schemeIdUri, { event }, { mode });
return;
}
if (!event.triggeredStartEvent) {
Iif (event.eventStream.schemeIdUri === MPD_RELOAD_SCHEME && event.eventStream.value == MPD_RELOAD_VALUE) {
//If both are set to zero, it indicates the media is over at this point. Don't reload the manifest.
if (event.duration !== 0 || event.presentationTimeDelta !== 0) {
logger.debug(`Starting manifest refresh event ${eventId} at ${currentVideoTime}`);
_refreshManifest();
}
} else Iif (event.eventStream.schemeIdUri === MPD_CALLBACK_SCHEME && event.eventStream.value == MPD_CALLBACK_VALUE) {
logger.debug(`Starting callback event ${eventId} at ${currentVideoTime}`);
const url = event.messageData instanceof Uint8Array ? Utils.uint8ArrayToString(event.messageData) : event.messageData;
_sendCallbackRequest(url);
} else {
logger.debug(`Starting event ${eventId} from period ${event.eventStream.period.id} at ${currentVideoTime}`);
eventBus.trigger(event.eventStream.schemeIdUri, { event }, { mode });
if (settings.get().streaming.events.deleteEventMessageDataTimeout > -1) {
setTimeout(() => {
delete event.messageData;
delete event.parsedMessageData;
}, settings.get().streaming.events.deleteEventMessageDataTimeout);
}
}
event.triggeredStartEvent = true;
}
} catch (e) {
logger.error(e);
}
}
/**
* Removes an event from the list. If this is the last event of type "schemeIdUri" the corresponding schemeIdUri Object in the list of events is deleted.
* @param {object} events
* @param {object} event
* @private
*/
function _removeEvent(events, event) {
try {
const schemeIdUri = event.eventStream.schemeIdUri;
const periodId = event.eventStream.period.id;
const value = event.eventStream.value;
const id = event.id;
events[periodId][schemeIdUri] = events[periodId][schemeIdUri].filter((e) => {
return (value && e.eventStream.value && e.eventStream.value !== value) || e.id !== id;
});
if (events[periodId][schemeIdUri].length === 0) {
delete events[periodId][schemeIdUri];
}
} catch (e) {
logger.error(e);
}
}
/**
* Refresh the manifest
* @private
*/
function _refreshManifest() {
try {
checkConfig();
manifestUpdater.refreshManifest();
} catch (e) {
logger.error(e);
}
}
/**
* Send a callback request
* @param {String} url
* @private
*/
function _sendCallbackRequest(url) {
try {
let loader = XHRLoader(context).create({});
const commonMediaRequest = new CommonMediaRequest(
{
method: 'get',
url: url,
responseType: 'arraybuffer',
customData: {}
}
);
const commonMediaResponse = new CommonMediaResponse({ request: commonMediaRequest });
loader.load(commonMediaRequest, commonMediaResponse);
} catch (e) {
logger.error(e);
}
}
/**
* Set the config of the EventController
* @param {object} config
*/
function setConfig(config) {
try {
Iif (!config) {
return;
}
if (config.manifestUpdater) {
manifestUpdater = config.manifestUpdater;
}
if (config.playbackController) {
playbackController = config.playbackController;
}
if (config.settings) {
settings = config.settings;
}
} catch (e) {
throw e;
}
}
/**
* Returns all inline events that have not been triggered yet
* @return {object}
*/
function getInlineEvents() {
return inlineEvents;
}
/**
* Returns all inband events that have not been triggered yet
* @return {object}
*/
function getInbandEvents() {
return inbandEvents;
}
/**
* Stop the EventController and reset all initial settings
*/
function reset() {
_stop();
_resetInitialSettings();
}
instance = {
addInlineEvents,
addInbandEvents,
getInbandEvents,
getInlineEvents,
start,
setConfig,
reset
};
_setup();
return instance;
}
EventController.__dashjs_factory_name = 'EventController';
export default FactoryMaker.getSingletonFactory(EventController);
|