diff --git a/.esdoc.json b/.esdoc.json
index 08d78ceae26..9375e46b1a0 100644
--- a/.esdoc.json
+++ b/.esdoc.json
@@ -2,12 +2,13 @@
"source": "./src",
"destination": "./api-docs",
"plugins": [
- {"name": "esdoc-standard-plugin"},
- {"name": "esdoc-typescript-plugin", "option": {"enable": true}},
+ {"name": "@itsjamie/esdoc-standard-plugin"},
+ {"name": "@itsjamie/esdoc-typescript-plugin", "option": {"enable": true}},
{
- "name": "esdoc-ecmascript-proposal-plugin",
+ "name": "@itsjamie/esdoc-ecmascript-proposal-plugin",
"option": {
- "objectRestSpread": true
+ "objectRestSpread": true,
+ "optionalChaining": true
}
}
]
diff --git a/.eslintrc.js b/.eslintrc.js
index c5db9c6d820..3c4543dfb98 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -106,7 +106,6 @@ module.exports = {
'no-empty': 1,
'no-mixed-operators': 1,
'no-unused-vars': 2,
- '@typescript-eslint/no-unused-vars': 1,
'no-console': 1,
'no-fallthrough': 1,
'no-case-declarations': 2,
@@ -122,12 +121,22 @@ module.exports = {
'no-void': 0,
'no-useless-catch': 2,
'lines-between-class-members': 2,
- 'no-prototype-builtins': 0,
- '@typescript-eslint/consistent-type-assertions': [ 2,
- {
- 'assertionStyle': 'as',
- 'objectLiteralTypeAssertions': 'never'
+ 'no-prototype-builtins': 0
+ },
+ 'overrides': [
+ {
+ 'files': ['*.ts'],
+ 'rules': {
+ 'no-unused-vars': 0,
+ '@typescript-eslint/no-unused-vars': 1,
+ '@typescript-eslint/prefer-optional-chain': 2,
+ '@typescript-eslint/consistent-type-assertions': [ 2,
+ {
+ 'assertionStyle': 'as',
+ 'objectLiteralTypeAssertions': 'never'
+ }
+ ]
}
- ]
- }
+ }
+ ]
};
diff --git a/README.md b/README.md
index 80f2ef378db..c717cb11da3 100644
--- a/README.md
+++ b/README.md
@@ -69,13 +69,13 @@ Find the commit on [https://github.com/video-dev/hls.js/blob/deployments/README.
hls.attachMedia(video);
hls.on(Hls.Events.MANIFEST_PARSED,function() {
video.play();
- });
- }
- // hls.js is not supported on platforms that do not have Media Source Extensions (MSE) enabled.
- // When the browser has built-in HLS support (check using `canPlayType`), we can provide an HLS manifest (i.e. .m3u8 URL) directly to the video element through the `src` property.
- // This is using the built-in support of the plain video element, without using hls.js.
- // Note: it would be more normal to wait on the 'canplay' event below however on Safari (where you are most likely to find built-in HLS support) the video.src URL must be on the user-driven
- // white-list before a 'canplay' event will be emitted; the last video event that can be reliably listened-for when the URL is not on the white-list is 'loadedmetadata'.
+ });
+ }
+ // hls.js is not supported on platforms that do not have Media Source Extensions (MSE) enabled.
+ // When the browser has built-in HLS support (check using `canPlayType`), we can provide an HLS manifest (i.e. .m3u8 URL) directly to the video element through the `src` property.
+ // This is using the built-in support of the plain video element, without using hls.js.
+ // Note: it would be more normal to wait on the 'canplay' event below however on Safari (where you are most likely to find built-in HLS support) the video.src URL must be on the user-driven
+ // white-list before a 'canplay' event will be emitted; the last video event that can be reliably listened-for when the URL is not on the white-list is 'loadedmetadata'.
else if (video.canPlayType('application/vnd.apple.mpegurl')) {
video.src = 'https://video-dev.github.io/streams/x36xhzz/x36xhzz.m3u8';
video.addEventListener('loadedmetadata',function() {
@@ -216,9 +216,9 @@ All HLS resources must be delivered with [CORS headers](https://developer.mozill
- Adaptive streaming
- Manual & Auto Quality Switching
- 3 Quality Switching modes are available (controllable through API means)
- - Instant switching (immediate quality switch at current video position)
- - Smooth switching (quality switch for next loaded fragment)
- - Bandwidth conservative switching (quality switch change for next loaded fragment, without flushing the buffer)
+ - Instant switching (immediate quality switch at current video position)
+ - Smooth switching (quality switch for next loaded fragment)
+ - Bandwidth conservative switching (quality switch change for next loaded fragment, without flushing the buffer)
- In Auto-Quality mode, emergency switch down in case bandwidth is suddenly dropping to minimize buffering.
- Accurate Seeking on VoD & Live (not limited to fragment or keyframe boundary)
- Ability to seek in buffer and back buffer without redownloading segments
@@ -241,6 +241,7 @@ All HLS resources must be delivered with [CORS headers](https://developer.mozill
- `#EXT-X-ENDLIST` (Live playlist)
- `#EXT-X-MEDIA-SEQUENCE`
- `#EXT-X-TARGETDURATION`
+ - `#EXT-X-CONTINUITY`
- `#EXT-X-DISCONTINUITY`
- `#EXT-X-DISCONTINUITY-SEQUENCE`
- `#EXT-X-BYTERANGE`
@@ -248,6 +249,8 @@ All HLS resources must be delivered with [CORS headers](https://developer.mozill
- `#EXT-X-KEY` (https://tools.ietf.org/html/draft-pantos-http-live-streaming-08#section-3.4.4)
- `#EXT-X-PROGRAM-DATE-TIME` (https://tools.ietf.org/html/draft-pantos-http-live-streaming-18#section-4.3.2.6)
- `EXT-X-START:TIME-OFFSET=x` (https://tools.ietf.org/html/draft-pantos-http-live-streaming-18#section-4.3.5.2)
+ - `#EXT-X-PREFETCH`
+ - `#EXT-X-PREFETCH-DISCONTINUITY`
## License
diff --git a/demo/basic-usage.html b/demo/basic-usage.html
index 279bff8f857..c369bd3b50c 100644
--- a/demo/basic-usage.html
+++ b/demo/basic-usage.html
@@ -20,9 +20,9 @@ Hls.js demo - basic usage
});
hls.loadSource('https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8');
hls.attachMedia(video);
- hls.on(Hls.Events.MANIFEST_PARSED,function() {
+ hls.on(Hls.Events.MANIFEST_PARSED, function() {
video.play();
- });
+ });
}
// hls.js is not supported on platforms that do not have Media Source Extensions (MSE) enabled.
// When the browser has built-in HLS support (check using `canPlayType`), we can provide an HLS manifest (i.e. .m3u8 URL) directly to the video element throught the `src` property.
diff --git a/demo/main.js b/demo/main.js
index c00374dce40..90538fa9b5b 100644
--- a/demo/main.js
+++ b/demo/main.js
@@ -1,19 +1,19 @@
-import {sortObject, copyTextToClipboard} from './demo-utils'
+import { sortObject, copyTextToClipboard } from './demo-utils';
const STORAGE_KEYS = {
Editor_Persistence: 'hlsjs:config-editor-persist',
- Hls_Config : 'hlsjs:config'
+ Hls_Config: 'hlsjs:config'
};
const testStreams = require('../tests/test-streams');
-const defaultTestStreamUrl = testStreams['bbb'].url;
-const sourceURL = decodeURIComponent(getURLParam('src', defaultTestStreamUrl))
+const defaultTestStreamUrl = testStreams.bbb.url;
+const sourceURL = decodeURIComponent(getURLParam('src', defaultTestStreamUrl));
-let demoConfig = getURLParam('demoConfig', null)
+let demoConfig = getURLParam('demoConfig', null);
if (demoConfig) {
- demoConfig = JSON.parse(atob(demoConfig))
+ demoConfig = JSON.parse(atob(demoConfig));
} else {
- demoConfig = {}
+ demoConfig = {};
}
const hlsjsDefaults = {
@@ -30,8 +30,8 @@ let dumpfMP4 = getDemoConfigPropOrDefault('dumpfMP4', false);
let bufferingIdx = -1;
let selectedTestStream = null;
-let video = $('#video')[0];
-let startTime = Date.now()
+const video = $('#video')[0];
+const startTime = Date.now();
let lastSeekingIdx;
let lastStartPosition;
@@ -46,67 +46,67 @@ let fmp4Data;
let configPersistenceEnabled = false;
let configEditor = null;
-$(document).ready(function() {
+$(document).ready(function () {
setupConfigEditor();
Object.keys(testStreams).forEach((key) => {
const stream = testStreams[key];
const option = new Option(stream.description, key);
$('#streamSelect').append(option);
- })
+ });
- $('#streamSelect').change(function() {
+ $('#streamSelect').change(function () {
selectedTestStream = testStreams[$('#streamSelect').val()];
const streamUrl = selectedTestStream.url;
$('#streamURL').val(streamUrl);
loadSelectedStream();
});
- $('#streamURL').change(function() {
+ $('#streamURL').change(function () {
selectedTestStream = null;
loadSelectedStream();
});
- $('#videoSize').change(function() {
+ $('#videoSize').change(function () {
$('#video').width($('#videoSize').val());
$('#bufferedCanvas').width($('#videoSize').val());
});
- $('#enableStreaming').click(function() {
+ $('#enableStreaming').click(function () {
enableStreaming = this.checked;
loadSelectedStream();
});
- $('#autoRecoverError').click(function() {
+ $('#autoRecoverError').click(function () {
autoRecoverError = this.checked;
onDemoConfigChanged();
});
- $('#dumpfMP4').click(function() {
+ $('#dumpfMP4').click(function () {
dumpfMP4 = this.checked;
onDemoConfigChanged();
});
- $('#limitMetrics').change(function() {
+ $('#limitMetrics').change(function () {
limitMetrics = this.value;
onDemoConfigChanged();
- })
+ });
- $('#levelCapping').change(function() {
+ $('#levelCapping').change(function () {
levelCapping = this.value;
onDemoConfigChanged();
});
$('#limitMetrics').val(limitMetrics);
- $('#enableStreaming').prop('checked', enableStreaming );
- $('#autoRecoverError').prop('checked', autoRecoverError );
- $('#dumpfMP4').prop('checked', dumpfMP4 );
+ $('#enableStreaming').prop('checked', enableStreaming);
+ $('#autoRecoverError').prop('checked', autoRecoverError);
+ $('#dumpfMP4').prop('checked', dumpfMP4);
$('#levelCapping').val(levelCapping);
$('h2').append(' v' + Hls.version + ' ');
$('#currentVersion').html('Hls version:' + Hls.version);
- $('#streamURL').val(sourceURL)
+ $('#streamURL').val(sourceURL);
video.volume = 0.05;
@@ -116,11 +116,10 @@ $(document).ready(function() {
$('#metricsButtonFixed').toggle(!windowSliding);
loadSelectedStream();
-
});
-function setupGlobals() {
- window.events = events = {
+function setupGlobals () {
+ self.events = events = {
url : url,
t0 : performance.now(),
load : [],
@@ -131,39 +130,35 @@ function setupGlobals() {
};
// actual values, only on window
- window.recoverDecodingErrorDate = null;
- window.recoverSwapAudioCodecDate = null;
-
- window.fmp4Data = fmp4Data = {
- 'audio': [],
- 'video': []
+ self.recoverDecodingErrorDate = null;
+ self.recoverSwapAudioCodecDate = null;
+ self.fmp4Data = fmp4Data = {
+ audio: [],
+ video: []
};
-
- window.onClickBufferedRange = onClickBufferedRange;
-
- window.updateLevelInfo = updateLevelInfo;
- window.onDemoConfigChanged = onDemoConfigChanged;
- window.createfMP4 = createfMP4;
- window.goToMetricsPermaLink = goToMetricsPermaLink;
- window.toggleTab = toggleTab;
- window.applyConfigEditorValue = applyConfigEditorValue;
+ self.onClickBufferedRange = onClickBufferedRange;
+ self.updateLevelInfo = updateLevelInfo;
+ self.onDemoConfigChanged = onDemoConfigChanged;
+ self.createfMP4 = createfMP4;
+ self.goToMetricsPermaLink = goToMetricsPermaLink;
+ self.toggleTab = toggleTab;
+ self.applyConfigEditorValue = applyConfigEditorValue;
}
-function trimArray( target, limit ) {
- if( limit < 0 ) {
+function trimArray (target, limit) {
+ if (limit < 0) {
return;
}
- while(target.length > limit )
- {
+ while (target.length > limit) {
target.shift();
}
}
-function trimEventHistory() {
+function trimEventHistory () {
const x = limitMetrics;
- if(x < 0) {
+ if (x < 0) {
return;
}
@@ -174,35 +169,34 @@ function trimEventHistory() {
trimArray(events.bitrate, x);
}
-function loadSelectedStream() {
+function loadSelectedStream () {
if (!Hls.isSupported()) {
handleUnsupported();
return;
}
- url = $('#streamURL').val()
+ url = $('#streamURL').val();
setupGlobals();
hideCanvas();
- if(hls) {
+ if (hls) {
hls.destroy();
- if(hls.bufferTimer) {
+ if (hls.bufferTimer) {
clearInterval(hls.bufferTimer);
hls.bufferTimer = undefined;
}
hls = null;
}
- if(!enableStreaming) {
+ if (!enableStreaming) {
logStatus('Streaming disabled');
return;
}
logStatus('Loading ' + url);
-
// Extending both a demo-specific config and the user config which can override all
const hlsConfig = $.extend({}, hlsjsDefaults, getEditorValue({ parse: true }));
@@ -215,7 +209,7 @@ function loadSelectedStream() {
onDemoConfigChanged();
console.log('Using Hls.js config:', hlsConfig);
- window.hls = hls = new Hls(hlsConfig);
+ self.hls = hls = new Hls(hlsConfig);
logStatus('Loading manifest and attaching video element...');
@@ -223,7 +217,7 @@ function loadSelectedStream() {
hls.autoLevelCapping = levelCapping;
hls.attachMedia(video);
- hls.on(Hls.Events.MEDIA_ATTACHED, function() {
+ hls.on(Hls.Events.MEDIA_ATTACHED, function () {
logStatus('Media element attached');
bufferingIdx = -1;
events.video.push({
@@ -233,7 +227,7 @@ function loadSelectedStream() {
trimEventHistory();
});
- hls.on(Hls.Events.MEDIA_DETACHED, function() {
+ hls.on(Hls.Events.MEDIA_DETACHED, function () {
logStatus('Media element detached');
bufferingIdx = -1;
tracks = [];
@@ -244,9 +238,9 @@ function loadSelectedStream() {
trimEventHistory();
});
- hls.on(Hls.Events.FRAG_PARSING_INIT_SEGMENT, function(event, data) {
+ hls.on(Hls.Events.FRAG_PARSING_INIT_SEGMENT, function (eventName, data) {
showCanvas();
- var event = {
+ const event = {
time: performance.now() - events.t0,
type: data.id + ' init segment'
};
@@ -254,69 +248,69 @@ function loadSelectedStream() {
trimEventHistory();
});
- hls.on(Hls.Events.FRAG_PARSING_METADATA, function(event, data) {
- //console.log("Id3 samples ", data.samples);
+ hls.on(Hls.Events.FRAG_PARSING_METADATA, function (eventName, data) {
+ // console.log("Id3 samples ", data.samples);
});
- hls.on(Hls.Events.LEVEL_SWITCHING, function(event, data) {
+ hls.on(Hls.Events.LEVEL_SWITCHING, function (eventName, data) {
events.level.push({
- time : performance.now() - events.t0,
- id : data.level,
- bitrate: Math.round(hls.levels[data.level].bitrate/1000)
+ time: performance.now() - events.t0,
+ id: data.level,
+ bitrate: Math.round(hls.levels[data.level].bitrate / 1000)
});
trimEventHistory();
updateLevelInfo();
});
- hls.on(Hls.Events.MANIFEST_PARSED, function(event, data) {
- var event = {
- type : 'manifest',
- name : '',
- start : 0,
- end : data.levels.length,
- time : data.stats.trequest - events.t0,
- latency : data.stats.tfirst - data.stats.trequest,
- load : data.stats.tload - data.stats.tfirst,
- duration: data.stats.tload - data.stats.tfirst,
+ hls.on(Hls.Events.MANIFEST_PARSED, function (eventName, data) {
+ const event = {
+ type: 'manifest',
+ name: '',
+ start: 0,
+ end: data.levels.length,
+ time: data.stats.trequest - events.t0,
+ latency: data.stats.tfirst - data.stats.trequest,
+ load: data.stats.tload - data.stats.tfirst,
+ duration: data.stats.tload - data.stats.tfirst
};
events.load.push(event);
trimEventHistory();
refreshCanvas();
});
- hls.on(Hls.Events.MANIFEST_PARSED, function(event, data) {
+ hls.on(Hls.Events.MANIFEST_PARSED, function (event, data) {
logStatus('No of quality levels found: ' + hls.levels.length);
logStatus('Manifest successfully loaded');
stats = {
- levelNb : data.levels.length,
+ levelNb: data.levels.length,
levelParsed: 0
};
trimEventHistory();
updateLevelInfo();
});
- hls.on(Hls.Events.AUDIO_TRACKS_UPDATED, function(event, data) {
+ hls.on(Hls.Events.AUDIO_TRACKS_UPDATED, function (event, data) {
logStatus('No of audio tracks found: ' + data.audioTracks.length);
updateAudioTrackInfo();
});
- hls.on(Hls.Events.AUDIO_TRACK_SWITCHING, function(event, data) {
+ hls.on(Hls.Events.AUDIO_TRACK_SWITCHING, function (eventName, data) {
logStatus('Audio track switching...');
updateAudioTrackInfo();
- var event = {
+ const event = {
time: performance.now() - events.t0,
type: 'audio switching',
name: '@' + data.id
};
events.video.push(event);
trimEventHistory();
- lastAudioTrackSwitchingIdx = events.video.length-1;
+ lastAudioTrackSwitchingIdx = events.video.length - 1;
});
- hls.on(Hls.Events.AUDIO_TRACK_SWITCHED, function(event, data) {
+ hls.on(Hls.Events.AUDIO_TRACK_SWITCHED, function (eventName, data) {
logStatus('Audio track switched');
updateAudioTrackInfo();
- var event = {
+ const event = {
time: performance.now() - events.t0,
type: 'audio switched',
name: '@' + data.id
@@ -329,46 +323,48 @@ function loadSelectedStream() {
trimEventHistory();
});
- hls.on(Hls.Events.LEVEL_LOADED, function(event, data) {
+ hls.on(Hls.Events.LEVEL_LOADED, function (eventName, data) {
events.isLive = data.details.live;
- var event = {
- type : 'level',
- id : data.level,
- start : data.details.startSN,
- end : data.details.endSN,
- time : data.stats.trequest - events.t0,
- latency : data.stats.tfirst - data.stats.trequest,
- load : data.stats.tload - data.stats.tfirst,
- parsing : data.stats.tparsed - data.stats.tload,
+ const event = {
+ type: 'level',
+ id: data.level,
+ start: data.details.startSN,
+ end: data.details.endSN,
+ time: data.stats.trequest - events.t0,
+ latency: data.stats.tfirst - data.stats.trequest,
+ load: data.stats.tload - data.stats.tfirst,
+ parsing: data.stats.tparsed - data.stats.tload,
duration: data.stats.tload - data.stats.tfirst
};
+
const parsingDuration = data.stats.tparsed - data.stats.tload;
- if (stats.levelParsed)
- {this.sumLevelParsingMs += parsingDuration;}
- else
- {this.sumLevelParsingMs = parsingDuration;}
+ if (stats.levelParsed) {
+ this.sumLevelParsingMs += parsingDuration;
+ } else {
+ this.sumLevelParsingMs = parsingDuration;
+ }
stats.levelParsed++;
- stats.levelParsingUs = Math.round(1000*this.sumLevelParsingMs / stats.levelParsed);
+ stats.levelParsingUs = Math.round(1000 * this.sumLevelParsingMs / stats.levelParsed);
- //console.log('parsing level duration :' + stats.levelParsingUs + 'us,count:' + stats.levelParsed);
+ // console.log('parsing level duration :' + stats.levelParsingUs + 'us,count:' + stats.levelParsed);
events.load.push(event);
trimEventHistory();
refreshCanvas();
});
- hls.on(Hls.Events.AUDIO_TRACK_LOADED, function(event, data) {
+ hls.on(Hls.Events.AUDIO_TRACK_LOADED, function (eventName, data) {
events.isLive = data.details.live;
- var event = {
- type : 'audio track',
- id : data.id,
- start : data.details.startSN,
- end : data.details.endSN,
- time : data.stats.trequest - events.t0,
- latency : data.stats.tfirst - data.stats.trequest,
- load : data.stats.tload - data.stats.tfirst,
- parsing : data.stats.tparsed - data.stats.tload,
+ const event = {
+ type: 'audio track',
+ id: data.id,
+ start: data.details.startSN,
+ end: data.details.endSN,
+ time: data.stats.trequest - events.t0,
+ latency: data.stats.tfirst - data.stats.trequest,
+ load: data.stats.tload - data.stats.tfirst,
+ parsing: data.stats.tparsed - data.stats.tload,
duration: data.stats.tload - data.stats.tfirst
};
events.load.push(event);
@@ -376,43 +372,44 @@ function loadSelectedStream() {
refreshCanvas();
});
- hls.on(Hls.Events.FRAG_BUFFERED, function(event, data) {
- var event = {
- type : data.frag.type + ' fragment',
- id : data.frag.level,
- id2 : data.frag.sn,
- time : data.stats.trequest - events.t0,
- latency : data.stats.tfirst - data.stats.trequest,
- load : data.stats.tload - data.stats.tfirst,
- parsing : data.stats.tparsed - data.stats.tload,
- buffer : data.stats.tbuffered - data.stats.tparsed,
+ hls.on(Hls.Events.FRAG_BUFFERED, function (eventName, data) {
+ const event = {
+ type: data.frag.type + ' fragment',
+ id: data.frag.level,
+ id2: data.frag.sn,
+ time: data.stats.trequest - events.t0,
+ latency: data.stats.tfirst - data.stats.trequest,
+ load: data.stats.tload - data.stats.tfirst,
+ parsing: data.stats.tparsed - data.stats.tload,
+ buffer: data.stats.tbuffered - data.stats.tparsed,
duration: data.stats.tbuffered - data.stats.tfirst,
- bw : Math.round(8*data.stats.total/(data.stats.tbuffered - data.stats.trequest)),
- size : data.stats.total
+ bw: Math.round(8 * data.stats.total / (data.stats.tbuffered - data.stats.trequest)),
+ size: data.stats.total
};
events.load.push(event);
events.bitrate.push({
- time : performance.now() - events.t0,
- bitrate : event.bw,
+ time: performance.now() - events.t0,
+ bitrate: event.bw,
duration: data.frag.duration,
- level : event.id
+ level: event.id
});
- if(hls.bufferTimer === undefined) {
+ if (hls.bufferTimer === undefined) {
events.buffer.push({
- time : 0,
+ time: 0,
buffer: 0,
- pos : 0
+ pos: 0
});
- hls.bufferTimer = window.setInterval(checkBuffer, 100);
+ hls.bufferTimer = self.setInterval(checkBuffer, 100);
}
trimEventHistory();
refreshCanvas();
updateLevelInfo();
- let latency = data.stats.tfirst - data.stats.trequest,
- parsing = data.stats.tparsed - data.stats.tload,
- process = data.stats.tbuffered - data.stats.trequest,
- bitrate = Math.round(8 * data.stats.length / (data.stats.tbuffered - data.stats.tfirst));
+ const latency = data.stats.tfirst - data.stats.trequest;
+ const parsing = data.stats.tparsed - data.stats.tload;
+ const process = data.stats.tbuffered - data.stats.trequest;
+ const bitrate = Math.round(8 * data.stats.length / (data.stats.tbuffered - data.stats.tfirst));
+
if (stats.fragBuffered) {
stats.fragMinLatency = Math.min(stats.fragMinLatency, latency);
stats.fragMaxLatency = Math.max(stats.fragMaxLatency, latency);
@@ -451,8 +448,8 @@ function loadSelectedStream() {
stats.autoLevelCappingLast = hls.autoLevelCapping;
});
- hls.on(Hls.Events.LEVEL_SWITCHED, function(event, data) {
- var event = {
+ hls.on(Hls.Events.LEVEL_SWITCHED, function (eventName, data) {
+ const event = {
time: performance.now() - events.t0,
type: 'level switched',
name: data.level
@@ -463,8 +460,8 @@ function loadSelectedStream() {
updateLevelInfo();
});
- hls.on(Hls.Events.FRAG_CHANGED, function(event, data) {
- var event = {
+ hls.on(Hls.Events.FRAG_CHANGED, function (eventName, data) {
+ const event = {
time: performance.now() - events.t0,
type: 'frag changed',
name: data.frag.sn + ' @ ' + data.frag.level
@@ -475,18 +472,20 @@ function loadSelectedStream() {
updateLevelInfo();
stats.tagList = data.frag.tagList;
- let level = data.frag.level, autoLevel = data.frag.autoLevel;
- if (stats.levelStart === undefined)
- {stats.levelStart = level;}
+ let level = data.frag.level;
+ let autoLevel = data.frag.autoLevel;
+ if (stats.levelStart === undefined) {
+ stats.levelStart = level;
+ }
if (autoLevel) {
if (stats.fragChangedAuto) {
stats.autoLevelMin = Math.min(stats.autoLevelMin, level);
stats.autoLevelMax = Math.max(stats.autoLevelMax, level);
stats.fragChangedAuto++;
- if (this.levelLastAuto && level !== stats.autoLevelLast)
- {stats.autoLevelSwitch++;}
-
+ if (this.levelLastAuto && level !== stats.autoLevelLast) {
+ stats.autoLevelSwitch++;
+ }
} else {
stats.autoLevelMin = stats.autoLevelMax = level;
stats.autoLevelSwitch = 0;
@@ -501,9 +500,9 @@ function loadSelectedStream() {
stats.manualLevelMin = Math.min(stats.manualLevelMin, level);
stats.manualLevelMax = Math.max(stats.manualLevelMax, level);
stats.fragChangedManual++;
- if (!this.levelLastAuto && level !== stats.manualLevelLast)
- {stats.manualLevelSwitch++;}
-
+ if (!this.levelLastAuto && level !== stats.manualLevelLast) {
+ stats.manualLevelSwitch++;
+ }
} else {
stats.manualLevelMin = stats.manualLevelMax = level;
stats.manualLevelSwitch = 0;
@@ -514,17 +513,17 @@ function loadSelectedStream() {
this.levelLastAuto = autoLevel;
});
- hls.on(Hls.Events.FRAG_LOAD_EMERGENCY_ABORTED, function(event, data) {
+ hls.on(Hls.Events.FRAG_LOAD_EMERGENCY_ABORTED, function (eventName, data) {
if (stats) {
- if (stats.fragLoadEmergencyAborted === undefined)
- {stats.fragLoadEmergencyAborted = 1;}
- else
- {stats.fragLoadEmergencyAborted++;}
-
+ if (stats.fragLoadEmergencyAborted === undefined) {
+ stats.fragLoadEmergencyAborted = 1;
+ } else {
+ stats.fragLoadEmergencyAborted++;
+ }
}
});
- hls.on(Hls.Events.FRAG_DECRYPTED, function(event, data) {
+ hls.on(Hls.Events.FRAG_DECRYPTED, function (eventName, data) {
if (!stats.fragDecrypted) {
stats.fragDecrypted = 0;
this.totalDecryptTime = 0;
@@ -535,71 +534,72 @@ function loadSelectedStream() {
stats.fragAvgDecryptTime = this.totalDecryptTime / stats.fragDecrypted;
});
- hls.on(Hls.Events.ERROR, function(event, data) {
+ hls.on(Hls.Events.ERROR, function (eventName, data) {
console.warn('Error event:', data);
- switch(data.details) {
- case Hls.ErrorDetails.MANIFEST_LOAD_ERROR:
- try {
- $('#errorOut').html('Cannot load ' + url + ' Allow-Control-Allow-Origin Chrome Extension');
- }
- } catch(err) {
- $('#errorOut').html('Cannot load ' + url + ' ' + url + ' Allow-Control-Allow-Origin Chrome Extension');
}
- break;
- case Hls.ErrorDetails.MANIFEST_LOAD_TIMEOUT:
- logError('Timeout while loading manifest');
- break;
- case Hls.ErrorDetails.MANIFEST_PARSING_ERROR:
- logError('Error while parsing manifest:' + data.reason);
- break;
- case Hls.ErrorDetails.LEVEL_LOAD_ERROR:
- logError('Error while loading level playlist');
- break;
- case Hls.ErrorDetails.LEVEL_LOAD_TIMEOUT:
- logError('Timeout while loading level playlist');
- break;
- case Hls.ErrorDetails.LEVEL_SWITCH_ERROR:
- logError('Error while trying to switch to level ' + data.level);
- break;
- case Hls.ErrorDetails.FRAG_LOAD_ERROR:
- logError('Error while loading fragment ' + data.frag.url);
- break;
- case Hls.ErrorDetails.FRAG_LOAD_TIMEOUT:
- logError('Timeout while loading fragment ' + data.frag.url);
- break;
- case Hls.ErrorDetails.FRAG_LOOP_LOADING_ERROR:
- logError('Fragment-loop loading error');
- break;
- case Hls.ErrorDetails.FRAG_DECRYPT_ERROR:
- logError('Decrypting error:' + data.reason);
- break;
- case Hls.ErrorDetails.FRAG_PARSING_ERROR:
- logError('Parsing error:' + data.reason);
- break;
- case Hls.ErrorDetails.KEY_LOAD_ERROR:
- logError('Error while loading key ' + data.frag.decryptdata.uri);
- break;
- case Hls.ErrorDetails.KEY_LOAD_TIMEOUT:
- logError('Timeout while loading key ' + data.frag.decryptdata.uri);
- break;
- case Hls.ErrorDetails.BUFFER_APPEND_ERROR:
- logError('Buffer append error');
- break;
- case Hls.ErrorDetails.BUFFER_ADD_CODEC_ERROR:
- logError('Buffer add codec error for ' + data.mimeType + ':' + data.err.message);
- break;
- case Hls.ErrorDetails.BUFFER_APPENDING_ERROR:
- logError('Buffer appending error');
- break;
- case Hls.ErrorDetails.BUFFER_STALLED_ERROR:
- logError('Buffer stalled error');
- break;
- default:
- break;
+ } catch (err) {
+ $('#errorOut').html('Cannot load ' + url + ' about:config media.mediasource.whitelist=false ');
} else {
logStatus('Your Browser does not support MediaSourceExtension / MP4 mediasource');
}
}
-function handleVideoEvent(evt) {
+function handleVideoEvent (evt) {
let data = '';
- switch(evt.type) {
- case 'durationchange':
- if(evt.target.duration - lastDuration <= 0.5) {
- // some browsers report several duration change events with almost the same value ... avoid spamming video events
- return;
+ switch (evt.type) {
+ case 'durationchange':
+ if (evt.target.duration - lastDuration <= 0.5) {
+ // some browsers report several duration change events with almost the same value ... avoid spamming video events
+ return;
+ }
+ lastDuration = evt.target.duration;
+ data = Math.round(evt.target.duration * 1000);
+ break;
+ case 'resize':
+ data = evt.target.videoWidth + '/' + evt.target.videoHeight;
+ break;
+ case 'loadedmetadata':
+ case 'loadeddata':
+ case 'canplay':
+ case 'canplaythrough':
+ case 'ended':
+ case 'seeking':
+ case 'seeked':
+ case 'play':
+ case 'playing':
+ lastStartPosition = evt.target.currentTime;
+ case 'pause':
+ case 'waiting':
+ case 'stalled':
+ case 'error':
+ data = Math.round(evt.target.currentTime * 1000);
+ if (evt.type === 'error') {
+ let errorTxt;
+ const mediaError = evt.currentTarget.error;
+ switch (mediaError.code) {
+ case mediaError.MEDIA_ERR_ABORTED:
+ errorTxt = 'You aborted the video playback';
+ break;
+ case mediaError.MEDIA_ERR_DECODE:
+ errorTxt = 'The video playback was aborted due to a corruption problem or because the video used features your browser did not support';
+ handleMediaError();
+ break;
+ case mediaError.MEDIA_ERR_NETWORK:
+ errorTxt = 'A network error caused the video download to fail part-way';
+ break;
+ case mediaError.MEDIA_ERR_SRC_NOT_SUPPORTED:
+ errorTxt = 'The video could not be loaded, either because the server or network failed or because the format is not supported';
+ break;
}
- lastDuration = evt.target.duration;
- data = Math.round(evt.target.duration*1000);
- break;
- case 'resize':
- data = evt.target.videoWidth + '/' + evt.target.videoHeight;
- break;
- case 'loadedmetadata':
- case 'loadeddata':
- case 'canplay':
- case 'canplaythrough':
- case 'ended':
- case 'seeking':
- case 'seeked':
- case 'play':
- case 'playing':
- lastStartPosition = evt.target.currentTime;
- case 'pause':
- case 'waiting':
- case 'stalled':
- case 'error':
- data = Math.round(evt.target.currentTime*1000);
- if(evt.type === 'error') {
- let errorTxt, mediaError=evt.currentTarget.error;
- switch(mediaError.code) {
- case mediaError.MEDIA_ERR_ABORTED:
- errorTxt = 'You aborted the video playback';
- break;
- case mediaError.MEDIA_ERR_DECODE:
- errorTxt = 'The video playback was aborted due to a corruption problem or because the video used features your browser did not support';
- handleMediaError();
- break;
- case mediaError.MEDIA_ERR_NETWORK:
- errorTxt = 'A network error caused the video download to fail part-way';
- break;
- case mediaError.MEDIA_ERR_SRC_NOT_SUPPORTED:
- errorTxt = 'The video could not be loaded, either because the server or network failed or because the format is not supported';
- break;
- }
-
- if (mediaError.message) {
- errorTxt += ' - ' + mediaError.message;
- }
- logStatus(errorTxt);
- console.error(errorTxt);
+ if (mediaError.message) {
+ errorTxt += ' - ' + mediaError.message;
}
- break;
- default:
- break;
+
+ logStatus(errorTxt);
+ console.error(errorTxt);
+ }
+ break;
+ default:
+ break;
}
- let event = {
+ const event = {
time: performance.now() - events.t0,
type: evt.type,
name: data
};
events.video.push(event);
- if(evt.type === 'seeking') {
- lastSeekingIdx = events.video.length-1;
+ if (evt.type === 'seeking') {
+ lastSeekingIdx = events.video.length - 1;
}
- if(evt.type === 'seeked') {
+ if (evt.type === 'seeked') {
events.video[lastSeekingIdx].duration = event.time - events.video[lastSeekingIdx].time;
}
trimEventHistory();
}
-function handleMediaError() {
- if(autoRecoverError) {
+function handleMediaError () {
+ if (autoRecoverError) {
let now = performance.now();
- if(!recoverDecodingErrorDate || (now - recoverDecodingErrorDate) > 3000) {
+ if (!recoverDecodingErrorDate || (now - recoverDecodingErrorDate) > 3000) {
recoverDecodingErrorDate = performance.now();
$('#statusOut').append(', trying to recover media error.');
hls.recoverMediaError();
} else {
- if(!recoverSwapAudioCodecDate || (now - recoverSwapAudioCodecDate) > 3000) {
+ if (!recoverSwapAudioCodecDate || (now - recoverSwapAudioCodecDate) > 3000) {
recoverSwapAudioCodecDate = performance.now();
$('#statusOut').append(', trying to swap audio codec and recover media error.');
hls.swapAudioCodec();
@@ -782,45 +787,47 @@ function handleMediaError() {
}
}
-function timeRangesToString(r) {
+function timeRangesToString (r) {
let log = '';
- for (let i=0; i= r.start(i) && pos < r.end(i)) {
+ if (!canvas.width || canvas.width !== v.clientWidth) {
+ canvas.width = v.clientWidth;
+ }
+
+ const pos = v.currentTime;
+ let bufferLen = 0;
+ for (let i = 0; i < r.length; i++) {
+ const start = r.start(i) / v.duration * canvas.width;
+ const end = r.end(i) / v.duration * canvas.width;
+ ctx.fillRect(start, 3, Math.max(2, end - start), 10);
+ if (pos >= r.start(i) && pos < r.end(i)) {
// play position is inside this buffer TimeRange, retrieve end of buffer position and buffer length
bufferLen = r.end(i) - pos;
}
}
// check if we are in buffering / or playback ended state
- if(bufferLen <= 0.1 && v.paused === false && (pos-lastStartPosition) > 0.5) {
- // don't create buffering event if we are at the end of the playlist, don't report ended for live playlist
- if(lastDuration -pos <= 0.5 && events.isLive === false) {
+ if (bufferLen <= 0.1 && v.paused === false && (pos - lastStartPosition) > 0.5) {
+ if (lastDuration - pos <= 0.5 && events.isLive === false) {
+ // don't create buffering event if we are at the end of the playlist, don't report ended for live playlist
} else {
// we are not at the end of the playlist ... real buffering
- if(bufferingIdx !== -1) {
+ if (bufferingIdx !== -1) {
bufferingDuration = performance.now() - events.t0 - events.video[bufferingIdx].time;
events.video[bufferingIdx].duration = bufferingDuration;
events.video[bufferingIdx].name = bufferingDuration;
@@ -831,12 +838,12 @@ function checkBuffer() {
});
trimEventHistory();
// we are in buffering state
- bufferingIdx = events.video.length-1;
+ bufferingIdx = events.video.length - 1;
}
}
}
- if(bufferLen > 0.1 && bufferingIdx !=-1) {
+ if (bufferLen > 0.1 && bufferingIdx !== -1) {
bufferingDuration = performance.now() - events.t0 - events.video[bufferingIdx].time;
events.video[bufferingIdx].duration = bufferingDuration;
events.video[bufferingIdx].name = bufferingDuration;
@@ -845,238 +852,234 @@ function checkBuffer() {
}
// update buffer/position for current Time
- let event = {
- time : performance.now() - events.t0,
- buffer: Math.round(bufferLen*1000),
- pos : Math.round(pos*1000)
+ const event = {
+ time: performance.now() - events.t0,
+ buffer: Math.round(bufferLen * 1000),
+ pos: Math.round(pos * 1000)
};
- let bufEvents = events.buffer, bufEventLen = bufEvents.length;
- if(bufEventLen > 1) {
- let event0 = bufEvents[bufEventLen-2], event1 = bufEvents[bufEventLen-1];
- let slopeBuf0 = (event0.buffer - event1.buffer)/(event0.time-event1.time);
- let slopeBuf1 = (event1.buffer - event.buffer)/(event1.time-event.time);
-
- let slopePos0 = (event0.pos - event1.pos)/(event0.time-event1.time);
- let slopePos1 = (event1.pos - event.pos)/(event1.time-event.time);
+ const bufEvents = events.buffer;
+ const bufEventLen = bufEvents.length;
+ if (bufEventLen > 1) {
+ const event0 = bufEvents[bufEventLen - 2];
+ const event1 = bufEvents[bufEventLen - 1];
+ const slopeBuf0 = (event0.buffer - event1.buffer) / (event0.time - event1.time);
+ const slopeBuf1 = (event1.buffer - event.buffer) / (event1.time - event.time);
+
+ const slopePos0 = (event0.pos - event1.pos) / (event0.time - event1.time);
+ const slopePos1 = (event1.pos - event.pos) / (event1.time - event.time);
// compute slopes. if less than 30% difference, remove event1
- if((slopeBuf0 === slopeBuf1 || Math.abs(slopeBuf0/slopeBuf1 -1) <= 0.3) &&
- (slopePos0 === slopePos1 || Math.abs(slopePos0/slopePos1 -1) <= 0.3))
- {bufEvents.pop();}
-
+ if (
+ (slopeBuf0 === slopeBuf1 || Math.abs(slopeBuf0 / slopeBuf1 - 1) <= 0.3) &&
+ (slopePos0 === slopePos1 || Math.abs(slopePos0 / slopePos1 - 1) <= 0.3)
+ ) {
+ bufEvents.pop();
+ }
}
events.buffer.push(event);
trimEventHistory();
refreshCanvas();
- let log = 'Duration: '
- + v.duration + '\n'
- + 'Buffered: '
- + timeRangesToString(v.buffered) + '\n'
- + 'Seekable: '
- + timeRangesToString(v.seekable) + '\n'
- + 'Played: '
- + timeRangesToString(v.played) + '\n';
+ let log = `Duration: ${v.duration}\nBuffered: ${timeRangesToString(v.buffered)}\nSeekable: ${timeRangesToString(v.seekable)}\nPlayed: ${timeRangesToString(v.played)}\n`
if (hls.media) {
- for(let type in tracks) {
+ for (const type in tracks) {
log += 'Buffer for ' + type + ' contains: ' + timeRangesToString(tracks[type].buffer.buffered) + '\n';
}
const videoPlaybackQuality = v.getVideoPlaybackQuality;
- if(videoPlaybackQuality && typeof (videoPlaybackQuality) === typeof (Function)) {
- log += 'Dropped frames: '+ v.getVideoPlaybackQuality().droppedVideoFrames + '\n';
- log += 'Corrupted frames:'+ v.getVideoPlaybackQuality().corruptedVideoFrames + '\n';
- } else if(v.webkitDroppedFrameCount) {
- log+='Dropped frames:'+ v.webkitDroppedFrameCount + '\n';
+ if (videoPlaybackQuality && typeof (videoPlaybackQuality) === typeof (Function)) {
+ log += `Dropped frames: ${v.getVideoPlaybackQuality().droppedVideoFrames}\n`;
+ log += `Corrupted frames: ${v.getVideoPlaybackQuality().corruptedVideoFrames}\n`;
+ } else if (v.webkitDroppedFrameCount) {
+ log += `Dropped frames: ${v.webkitDroppedFrameCount}`;
}
}
- $('#bufferedOut').text(log);
+ $('#bufferedOut').text(log);
$('#statisticsOut').text(JSON.stringify(sortObject(stats), null, '\t'));
-
ctx.fillStyle = 'blue';
-
const x = v.currentTime / v.duration * canvas.width;
ctx.fillRect(x, 0, 2, 15);
}
}
-function showCanvas() {
+function showCanvas () {
showMetrics();
$('#bufferedOut').show();
$('#bufferedCanvas').show();
}
-function hideCanvas() {
+function hideCanvas () {
hideMetrics();
$('#bufferedOut').hide();
$('#bufferedCanvas').hide();
}
-function getMetrics() {
- let json = JSON.stringify(events);
- let jsonpacked = jsonpack.pack(json);
+function getMetrics () {
+ const json = JSON.stringify(events);
+ const jsonpacked = jsonpack.pack(json);
// console.log('packing JSON from ' + json.length + ' to ' + jsonpacked.length + ' bytes');
return btoa(jsonpacked);
}
-function copyMetricsToClipBoard() {
+function copyMetricsToClipBoard () {
copyTextToClipboard(getMetrics());
}
-function goToMetrics() {
+function goToMetrics () {
let url = document.URL;
url = url.substr(0, url.lastIndexOf('/')+1) + 'metrics.html';
- window.open(url, '_blank');
+ self.open(url, '_blank');
}
-function goToMetricsPermaLink() {
+function goToMetricsPermaLink () {
let url = document.URL;
- let b64 = getMetrics();
- url = url.substr(0, url.lastIndexOf('/')+1) + 'metrics.html#data=' + b64;
- window.open(url, '_blank');
+ const b64 = getMetrics();
+ url = url.substr(0, url.lastIndexOf('/') + 1) + 'metrics.html#data=' + b64;
+ self.open(url, '_blank');
}
-function minsecs(ts) {
- let m = Math.floor(Math.floor(ts % 3600) / 60);
- let s = Math.floor(ts % 60);
+function minsecs (ts) {
+ const m = Math.floor(Math.floor(ts % 3600) / 60);
+ const s = Math.floor(ts % 60);
return m + ':' + (s < 10 ? '0' : '') + s;
}
-function onClickBufferedRange(event) {
- let canvas = $('#bufferedCanvas')[0];
- let v = $('#video')[0];
- let target = (event.clientX - canvas.offsetLeft) / canvas.width * v.duration;
+function onClickBufferedRange (event) {
+ const canvas = $('#bufferedCanvas')[0];
+ const v = $('#video')[0];
+ const target = (event.clientX - canvas.offsetLeft) / canvas.width * v.duration;
v.currentTime = target;
}
-function updateLevelInfo() {
+function updateLevelInfo () {
if (!hls.levels) {
return;
}
- let button_template = '' + levelName + ' ';
- html2 += button_template;
- if(hls.loadLevel === i) {
- html2 += button_enabled;
+ html2 += buttonTemplate;
+ if (hls.loadLevel === i) {
+ html2 += buttonEnabled;
} else {
- html2 += button_disabled;
+ html2 += buttonDisabled;
}
html2 += 'onclick="hls.loadLevel=' + i + '">' + levelName + '';
- html3 += button_template;
- if(hls.autoLevelCapping === i) {
- html3 += button_enabled;
+ html3 += buttonTemplate;
+ if (hls.autoLevelCapping === i) {
+ html3 += buttonEnabled;
} else {
- html3 += button_disabled;
+ html3 += buttonDisabled;
}
html3 += 'onclick="levelCapping=hls.autoLevelCapping=' + i + ';updateLevelInfo();onDemoConfigChanged();">' + levelName + '';
- html4 += button_template;
- if(hls.nextLevel === i) {
- html4 += button_enabled;
+ html4 += buttonTemplate;
+ if (hls.nextLevel === i) {
+ html4 += buttonEnabled;
} else {
- html4 += button_disabled;
+ html4 += buttonDisabled;
}
html4 += 'onclick="hls.nextLevel=' + i + '">' + levelName + '';
}
- let v = $('#video')[0];
+ const v = $('#video')[0];
- if(v.videoWidth && v.videoHeight) {
+ if (v.videoWidth && v.videoHeight) {
$('#currentResolution').html(v.videoWidth + ' x ' + v.videoHeight);
}
- if($('#currentLevelControl').html() != html1) {
+ if ($('#currentLevelControl').html() != html1) {
$('#currentLevelControl').html(html1);
}
- if($('#loadLevelControl').html() != html2) {
+ if ($('#loadLevelControl').html() != html2) {
$('#loadLevelControl').html(html2);
}
- if($('#levelCappingControl').html() != html3) {
+ if ($('#levelCappingControl').html() != html3) {
$('#levelCappingControl').html(html3);
}
- if($('#nextLevelControl').html() != html4) {
+ if ($('#nextLevelControl').html() != html4) {
$('#nextLevelControl').html(html4);
}
}
-function updateAudioTrackInfo() {
- let button_template = '' + hls.audioTracks[i].name + ' ';
@@ -1084,17 +1087,17 @@ function updateAudioTrackInfo() {
$('#audioTrackControl').html(html1);
}
-function level2label(index) {
- if(hls && hls.levels.length-1 >= index) {
- let level = hls.levels[index];
+function level2label (index) {
+ if (hls && hls.levels.length - 1 >= index) {
+ const level = hls.levels[index];
if (level.name) {
return level.name;
} else {
if (level.height) {
- return(level.height + 'p / ' + Math.round(level.bitrate / 1024) + 'kb');
+ return (level.height + 'p / ' + Math.round(level.bitrate / 1024) + 'kb');
} else {
- if(level.bitrate) {
- return(Math.round(level.bitrate / 1024) + 'kb');
+ if (level.bitrate) {
+ return (Math.round(level.bitrate / 1024) + 'kb');
} else {
return null;
}
@@ -1103,29 +1106,30 @@ function level2label(index) {
}
}
-function getDemoConfigPropOrDefault(propName, defaultVal) {
+function getDemoConfigPropOrDefault (propName, defaultVal) {
return typeof demoConfig[propName] !== 'undefined' ? demoConfig[propName] : defaultVal;
}
-function getURLParam(sParam, defaultValue) {
- let sPageURL = window.location.search.substring(1);
- let sURLVariables = sPageURL.split('&');
+function getURLParam (sParam, defaultValue) {
+ const sPageURL = self.location.search.substring(1);
+ const sURLVariables = sPageURL.split('&');
for (let i = 0; i < sURLVariables.length; i++) {
- let sParameterName = sURLVariables[i].split('=');
- if (sParameterName[0] == sParam)
- {return 'undefined' == sParameterName[1] ? undefined : 'false' == sParameterName[1] ? false : sParameterName[1];}
+ const sParameterName = sURLVariables[i].split('=');
+ if (sParameterName[0] == sParam) {
+ return sParameterName[1] == 'undefined' ? undefined : sParameterName[1] == 'false' ? false : sParameterName[1];
+ }
}
return defaultValue;
}
-function onDemoConfigChanged() {
+function onDemoConfigChanged () {
demoConfig = {
enableStreaming,
autoRecoverError,
dumpfMP4,
levelCapping,
- limitMetrics,
+ limitMetrics
};
if (configPersistenceEnabled) {
@@ -1140,7 +1144,7 @@ function onDemoConfigChanged() {
$('#StreamPermalink').html(`${permalinkURL} `);
}
-function onConfigPersistenceChanged(event) {
+function onConfigPersistenceChanged (event) {
configPersistenceEnabled = event.target.checked;
localStorage.setItem(STORAGE_KEYS.Editor_Persistence, JSON.stringify(configPersistenceEnabled));
@@ -1151,7 +1155,7 @@ function onConfigPersistenceChanged(event) {
}
}
-function getEditorValue(options) {
+function getEditorValue (options) {
options = $.extend({ parse: false }, options || {});
let value = configEditor.session.getValue();
@@ -1167,9 +1171,8 @@ function getEditorValue(options) {
return value;
}
-function getPersistedHlsConfig() {
- var value = localStorage.getItem(STORAGE_KEYS.Hls_Config);
-
+function getPersistedHlsConfig () {
+ let value = localStorage.getItem(STORAGE_KEYS.Hls_Config);
if (value === null) {
return value;
}
@@ -1184,11 +1187,11 @@ function getPersistedHlsConfig() {
return value;
}
-function persistEditorValue() {
+function persistEditorValue () {
localStorage.setItem(STORAGE_KEYS.Hls_Config, getEditorValue());
}
-function setupConfigEditor() {
+function setupConfigEditor () {
configEditor = ace.edit('config-editor');
configEditor.setTheme('ace/theme/github');
configEditor.session.setMode('ace/mode/json');
@@ -1208,39 +1211,41 @@ function setupConfigEditor() {
updateConfigEditorValue(contents);
}
-function updateConfigEditorValue(obj) {
+function updateConfigEditorValue (obj) {
const json = JSON.stringify(obj, null, 2);
configEditor.session.setValue(json);
}
-function applyConfigEditorValue() {
+function applyConfigEditorValue () {
onDemoConfigChanged();
loadSelectedStream();
}
-function createfMP4(type) {
+function createfMP4 (type) {
if (fmp4Data[type].length) {
- let blob = new Blob([arrayConcat(fmp4Data[type])], {
+ const blob = new Blob([arrayConcat(fmp4Data[type])], {
type: 'application/octet-stream'
});
- let filename = type + '-' + new Date().toISOString() + '.mp4';
+ const filename = type + '-' + new Date().toISOString() + '.mp4';
saveAs(blob, filename);
//$('body').append('Download ' + filename + ' track ) {
const frag = data.frag;
const stats = frag.stats;
@@ -190,8 +207,8 @@ class AbrController extends EventHandler {
// rationale is that buffer appending only happens once media is attached. This can happen when config.startFragPrefetch
// is used. If we used buffering in that case, our BW estimate sample will be very large.
const fragLoadingProcessingMs = stats.parsing.end - stats.loading.start;
- this._bwEstimator.sample(fragLoadingProcessingMs, stats.loaded);
- stats.bwEstimate = this._bwEstimator.getEstimate();
+ this.bwEstimator.sample(fragLoadingProcessingMs, stats.loaded);
+ stats.bwEstimate = this.bwEstimator.getEstimate();
if (frag.bitrateTest) {
this.bitrateTestDelay = fragLoadingProcessingMs / 1000;
} else {
@@ -199,7 +216,7 @@ class AbrController extends EventHandler {
}
}
- protected onError (data) {
+ protected onError (event: Events.ERROR, data: ErrorData) {
// stop timer in case of frag loading error
switch (data.details) {
case ErrorDetails.FRAG_LOAD_ERROR:
@@ -219,7 +236,7 @@ class AbrController extends EventHandler {
// return next auto level
get nextAutoLevel () {
const forcedAutoLevel = this._nextAutoLevel;
- const bwEstimator = this._bwEstimator;
+ const bwEstimator = this.bwEstimator;
// in case next auto level has been forced, and bw not available or not reliable, return forced value
if (forcedAutoLevel !== -1 && (!bwEstimator || !bwEstimator.canEstimate())) {
return forcedAutoLevel;
@@ -244,7 +261,7 @@ class AbrController extends EventHandler {
// playbackRate is the absolute value of the playback rate; if media.playbackRate is 0, we use 1 to load as
// if we're playing back at the normal rate.
const playbackRate = ((media && (media.playbackRate !== 0)) ? Math.abs(media.playbackRate) : 1.0);
- const avgbw = this._bwEstimator ? this._bwEstimator.getEstimate() : config.abrEwmaDefaultEstimate;
+ const avgbw = this.bwEstimator ? this.bwEstimator.getEstimate() : config.abrEwmaDefaultEstimate;
// bufferStarvationDelay is the wall-clock time left until the playback buffer is exhausted.
const bufferStarvationDelay = (BufferHelper.bufferInfo(media as Bufferable, pos, config.maxBufferHole).end - pos) / playbackRate;
diff --git a/src/controller/audio-stream-controller.ts b/src/controller/audio-stream-controller.ts
index 426b8f3b72c..b82c3916d3f 100644
--- a/src/controller/audio-stream-controller.ts
+++ b/src/controller/audio-stream-controller.ts
@@ -1,29 +1,31 @@
import { BufferHelper } from '../utils/buffer-helper';
import TransmuxerInterface from '../demux/transmuxer-interface';
-import Event from '../events';
+import { Events } from '../events';
import TimeRanges from '../utils/time-ranges';
import { ErrorDetails } from '../errors';
import { logger } from '../utils/logger';
-import { FragmentState } from './fragment-tracker';
+import { FragmentState, FragmentTracker } from './fragment-tracker';
import Fragment, { ElementaryStreamTypes } from '../loader/fragment';
import BaseStreamController, { State } from './base-stream-controller';
import FragmentLoader from '../loader/fragment-loader';
import ChunkCache from '../demux/chunk-cache';
import LevelDetails from '../loader/level-details';
import { ChunkMetadata, TransmuxerResult } from '../types/transmuxer';
-import { BufferAppendingEventPayload, TrackLoadedData, AudioTracksUpdated } from '../types/events';
+import { BufferAppendingData, TrackLoadedData, AudioTracksUpdatedData, MediaAttachingData, FragBufferedData, BufferCreatedData, AudioTrackSwitchingData } from '../types/events';
import { TrackSet } from '../types/track';
import { Level } from '../types/level';
+import Hls from '../hls';
+import { ComponentAPI } from '../types/component-api';
const { performance } = self;
const TICK_INTERVAL = 100; // how often to tick in ms
-class AudioStreamController extends BaseStreamController {
+class AudioStreamController extends BaseStreamController implements ComponentAPI {
private retryDate: number = 0;
- private onvseeking: Function | null = null;
- private onvseeked: Function | null = null;
- private onvended: Function | null = null;
+ private onvseeking: EventListener | null = null;
+ private onvseeked: EventListener | null = null;
+ private onvended: EventListener | null = null;
private videoBuffer: any | null = null;
private initPTS: any = [];
private videoTrackCC: number = -1;
@@ -33,29 +35,53 @@ class AudioStreamController extends BaseStreamController {
protected readonly logPrefix = '[audio-stream-controller]';
- constructor (hls, fragmentTracker) {
- super(hls,
- Event.MEDIA_ATTACHED,
- Event.MEDIA_DETACHING,
- Event.AUDIO_TRACKS_UPDATED,
- Event.AUDIO_TRACK_SWITCHING,
- Event.AUDIO_TRACK_LOADED,
- Event.KEY_LOADED,
- Event.ERROR,
- Event.BUFFER_RESET,
- Event.BUFFER_CREATED,
- Event.BUFFER_FLUSHED,
- Event.INIT_PTS_FOUND,
- Event.FRAG_BUFFERED
- );
-
+ constructor (hls: Hls, fragmentTracker: FragmentTracker) {
+ super(hls);
this.config = hls.config;
this.fragmentTracker = fragmentTracker;
this.fragmentLoader = new FragmentLoader(hls.config);
+
+ this._registerListeners();
+ }
+
+ protected onHandlerDestroying () {
+ this._unregisterListeners();
+ }
+
+ private _registerListeners () {
+ const { hls } = this;
+ hls.on(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+ hls.on(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ hls.on(Events.AUDIO_TRACKS_UPDATED, this.onAudioTracksUpdated, this);
+ hls.on(Events.AUDIO_TRACK_SWITCHING, this.onAudioTrackSwitching, this);
+ hls.on(Events.AUDIO_TRACK_LOADED, this.onAudioTrackLoaded, this);
+ hls.on(Events.KEY_LOADED, this.onKeyLoaded, this);
+ hls.on(Events.ERROR, this.onError, this);
+ hls.on(Events.BUFFER_RESET, this.onBufferReset, this);
+ hls.on(Events.BUFFER_CREATED, this.onBufferCreated, this);
+ hls.on(Events.BUFFER_FLUSHED, this.onBufferFlushed, this);
+ hls.on(Events.INIT_PTS_FOUND, this.onInitPtsFound, this);
+ hls.on(Events.FRAG_BUFFERED, this.onFragBuffered, this);
+ }
+
+ private _unregisterListeners () {
+ const { hls } = this;
+ hls.off(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+ hls.off(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ hls.off(Events.AUDIO_TRACKS_UPDATED, this.onAudioTracksUpdated, this);
+ hls.off(Events.AUDIO_TRACK_SWITCHING, this.onAudioTrackSwitching, this);
+ hls.off(Events.AUDIO_TRACK_LOADED, this.onAudioTrackLoaded, this);
+ hls.off(Events.KEY_LOADED, this.onKeyLoaded, this);
+ hls.off(Events.ERROR, this.onError, this);
+ hls.off(Events.BUFFER_RESET, this.onBufferReset, this);
+ hls.off(Events.BUFFER_CREATED, this.onBufferCreated, this);
+ hls.off(Events.BUFFER_FLUSHED, this.onBufferFlushed, this);
+ hls.off(Events.INIT_PTS_FOUND, this.onInitPtsFound, this);
+ hls.off(Events.FRAG_BUFFERED, this.onFragBuffered, this);
}
// INIT_PTS_FOUND is triggered when the video track parsed in the stream-controller has a new PTS value
- onInitPtsFound ({ frag, initPTS }) {
+ onInitPtsFound (event: Events.INIT_PTS_FOUND, { frag, initPTS }) {
// Always update the new INIT PTS
// Can change due level switch
const cc = frag.cc;
@@ -106,7 +132,7 @@ class AudioStreamController extends BaseStreamController {
break;
case State.WAITING_TRACK: {
const { levels, trackId } = this;
- if (levels && levels[trackId] && levels[trackId].details) {
+ if (levels?.[trackId]?.details) {
// check if playlist is already loaded
this.state = State.WAITING_INIT_PTS;
}
@@ -115,9 +141,8 @@ class AudioStreamController extends BaseStreamController {
case State.FRAG_LOADING_WAITING_RETRY: {
const now = performance.now();
const retryDate = this.retryDate;
- const isSeeking = media && media.seeking;
// if current time is gt than retryDate, or if media seeking let's switch to IDLE state to retry loading
- if (!retryDate || (now >= retryDate) || isSeeking) {
+ if (!retryDate || (now >= retryDate) || media?.seeking) {
this.log('RetryDate reached, switch back to IDLE state');
this.state = State.IDLE;
}
@@ -217,7 +242,7 @@ class AudioStreamController extends BaseStreamController {
}
if (!audioSwitch && this._streamEnded(bufferInfo, trackDetails)) {
- hls.trigger(Event.BUFFER_EOS, { type: 'audio' });
+ hls.trigger(Events.BUFFER_EOS, { type: 'audio' });
this.state = State.ENDED;
return;
}
@@ -246,19 +271,19 @@ class AudioStreamController extends BaseStreamController {
if (frag.encrypted) {
this.log(`Loading key for ${frag.sn} of [${trackDetails.startSN} ,${trackDetails.endSN}],track ${trackId}`);
this.state = State.KEY_LOADING;
- hls.trigger(Event.KEY_LOADING, { frag: frag });
+ hls.trigger(Events.KEY_LOADING, { frag: frag });
} else {
this.log(`Loading ${frag.sn}, cc: ${frag.cc} of [${trackDetails.startSN} ,${trackDetails.endSN}],track ${trackId}, currentTime:${pos},bufferEnd:${bufferInfo.end.toFixed(3)}`);
this.loadFragment(frag);
}
}
- onMediaAttached (data) {
+ onMediaAttached (event: Events.MEDIA_ATTACHED, data: MediaAttachingData) {
const media = this.media = this.mediaBuffer = data.media;
this.onvseeking = this.onMediaSeeking.bind(this);
this.onvended = this.onMediaEnded.bind(this);
- media.addEventListener('seeking', this.onvseeking);
- media.addEventListener('ended', this.onvended);
+ media.addEventListener('seeking', this.onvseeking as EventListener);
+ media.addEventListener('ended', this.onvended as EventListener);
const config = this.config;
if (this.levels && config.autoStartLoad) {
this.startLoad(config.startPosition);
@@ -267,7 +292,7 @@ class AudioStreamController extends BaseStreamController {
onMediaDetaching () {
const media = this.media;
- if (media && media.ended) {
+ if (media?.ended) {
this.log('MSE detaching and video ended, reset startPosition');
this.startPosition = this.lastCurrentTime = 0;
}
@@ -284,18 +309,18 @@ class AudioStreamController extends BaseStreamController {
this.stopLoad();
}
- onAudioTracksUpdated ({ audioTracks }: AudioTracksUpdated) {
+ onAudioTracksUpdated (event: Events.AUDIO_TRACKS_UPDATED, { audioTracks }: AudioTracksUpdatedData) {
this.log('Audio tracks updated');
this.levels = audioTracks.map(mediaPlaylist => new Level(mediaPlaylist));
}
- onAudioTrackSwitching (data) {
+ onAudioTrackSwitching (event: Events.AUDIO_TRACK_SWITCHING, data: AudioTrackSwitchingData) {
// if any URL found on new audio track, it is an alternate audio track
const altAudio = !!data.url;
this.trackId = data.id;
const { fragCurrent, transmuxer } = this;
- if (fragCurrent && fragCurrent.loader) {
+ if (fragCurrent?.loader) {
fragCurrent.loader.abort();
}
this.fragCurrent = null;
@@ -322,7 +347,7 @@ class AudioStreamController extends BaseStreamController {
this.tick();
}
- onAudioTrackLoaded (data: TrackLoadedData) {
+ onAudioTrackLoaded (event: Events.AUDIO_TRACK_LOADED, data: TrackLoadedData) {
const { levels } = this;
const { details: newDetails, id: trackId } = data;
if (!levels) {
@@ -409,7 +434,7 @@ class AudioStreamController extends BaseStreamController {
this.loadedmetadata = false;
}
- onBufferCreated (data) {
+ onBufferCreated (event: Events.BUFFER_CREATED, data: BufferCreatedData) {
const audioTrack = data.tracks.audio;
if (audioTrack) {
this.mediaBuffer = audioTrack.buffer;
@@ -419,7 +444,7 @@ class AudioStreamController extends BaseStreamController {
}
}
- onFragBuffered (data: { frag: Fragment }) {
+ onFragBuffered (event: Events.FRAG_BUFFERED, data: FragBufferedData) {
const { frag } = data;
if (frag && frag.type !== 'audio') {
return;
@@ -435,7 +460,7 @@ class AudioStreamController extends BaseStreamController {
this.log(`Buffered fragment ${frag.sn} of level ${frag.level}. PTS:[${frag.startPTS},${frag.endPTS}],DTS:[${frag.startDTS}/${frag.endDTS}], Buffered: ${TimeRanges.toString(media.buffered)}`);
if (this.audioSwitch && frag.sn !== 'initSegment') {
this.audioSwitch = false;
- this.hls.trigger(Event.AUDIO_TRACK_SWITCHED, { id: this.trackId });
+ this.hls.trigger(Events.AUDIO_TRACK_SWITCHED, { id: this.trackId });
}
this.state = State.IDLE;
this.tick();
@@ -516,7 +541,7 @@ class AudioStreamController extends BaseStreamController {
this.warn('Buffer full error also media.currentTime is not buffered, flush audio buffer');
this.fragCurrent = null;
// flush everything
- this.hls.trigger(Event.BUFFER_FLUSHING, { startOffset: 0, endOffset: Number.POSITIVE_INFINITY, type: 'audio' });
+ this.hls.trigger(Events.BUFFER_FLUSHING, { startOffset: 0, endOffset: Number.POSITIVE_INFINITY, type: 'audio' });
}
}
break;
@@ -558,9 +583,9 @@ class AudioStreamController extends BaseStreamController {
this.completeAudioSwitch();
}
- if (initSegment && initSegment.tracks) {
+ if (initSegment?.tracks) {
this._bufferInitSegment(initSegment.tracks, frag, chunkMeta);
- hls.trigger(Event.FRAG_PARSING_INIT_SEGMENT, { frag, id, tracks: initSegment.tracks });
+ hls.trigger(Events.FRAG_PARSING_INIT_SEGMENT, { frag, id, tracks: initSegment.tracks });
// Only flush audio from old audio tracks when PTS is known on new audio track
}
if (audio) {
@@ -572,13 +597,13 @@ class AudioStreamController extends BaseStreamController {
const emittedID3: any = id3;
emittedID3.frag = frag;
emittedID3.id = id;
- hls.trigger(Event.FRAG_PARSING_METADATA, emittedID3);
+ hls.trigger(Events.FRAG_PARSING_METADATA, emittedID3);
}
if (text) {
const emittedText: any = text;
emittedText.frag = frag;
emittedText.id = id;
- hls.trigger(Event.FRAG_PARSING_USERDATA, emittedText);
+ hls.trigger(Events.FRAG_PARSING_USERDATA, emittedText);
}
}
@@ -599,12 +624,12 @@ class AudioStreamController extends BaseStreamController {
track.levelCodec = track.codec;
track.id = 'audio';
- this.hls.trigger(Event.BUFFER_CODECS, tracks);
+ this.hls.trigger(Events.BUFFER_CODECS, tracks);
this.log(`Audio, container:${track.container}, codecs[level/parsed]=[${track.levelCodec}/${track.codec}]`);
const initSegment = track.initSegment;
if (initSegment) {
- const segment: BufferAppendingEventPayload = { type: 'audio', data: initSegment, frag, chunkMeta };
- this.hls.trigger(Event.BUFFER_APPENDING, segment);
+ const segment: BufferAppendingData = { type: 'audio', data: initSegment, frag, chunkMeta };
+ this.hls.trigger(Events.BUFFER_APPENDING, segment);
}
// trigger handler right now
this.tick();
@@ -638,14 +663,14 @@ class AudioStreamController extends BaseStreamController {
const { hls, media, trackId } = this;
if (media) {
this.warn('Switching audio track : flushing all audio');
- hls.trigger(Event.BUFFER_FLUSHING, {
+ hls.trigger(Events.BUFFER_FLUSHING, {
startOffset: 0,
endOffset: Number.POSITIVE_INFINITY,
type: 'audio'
});
}
this.audioSwitch = false;
- hls.trigger(Event.AUDIO_TRACK_SWITCHED, { id: trackId });
+ hls.trigger(Events.AUDIO_TRACK_SWITCHED, { id: trackId });
}
}
export default AudioStreamController;
diff --git a/src/controller/audio-track-controller.ts b/src/controller/audio-track-controller.ts
index 6bd96d3baf0..3df523b49f6 100644
--- a/src/controller/audio-track-controller.ts
+++ b/src/controller/audio-track-controller.ts
@@ -1,17 +1,18 @@
-import Event from '../events';
+import { Events } from '../events';
import { logger } from '../utils/logger';
import { ErrorTypes, ErrorDetails } from '../errors';
import { computeReloadInterval } from './level-helper';
-import EventHandler from '../event-handler';
import { MediaPlaylist } from '../types/media-playlist';
import {
TrackSwitchedData,
- TrackLoadedData,
ManifestParsedData,
- LevelLoadedData,
- AudioTracksUpdated,
- ErrorData
+ AudioTracksUpdatedData,
+ ErrorData,
+ LevelLoadingData,
+ AudioTrackLoadedData
} from '../types/events';
+import { NetworkComponentAPI } from '../types/component-api';
+import Hls from '../hls';
/**
* @class AudioTrackController
@@ -34,14 +35,14 @@ import {
* @fires ERROR
*
*/
-class AudioTrackController extends EventHandler {
+class AudioTrackController implements NetworkComponentAPI {
/**
* @private
* If should select tracks according to default track attribute
* @member {boolean} _selectDefaultTrack
*/
private _selectDefaultTrack: boolean = true;
-
+ private hls: Hls;
private _trackId: number = -1;
private canLoad: boolean = false;
@@ -65,21 +66,35 @@ class AudioTrackController extends EventHandler {
*/
public audioGroupId: string | null = null;
- constructor (hls) {
- super(hls,
- Event.MANIFEST_LOADING,
- Event.MANIFEST_PARSED,
- Event.AUDIO_TRACK_LOADED,
- Event.AUDIO_TRACK_SWITCHED,
- Event.LEVEL_LOADING,
- Event.ERROR
- );
-
+ constructor (hls: Hls) {
+ this.hls = hls;
this.tracks = [];
this.trackIdBlacklist = Object.create(null);
+ this._registerListeners();
+ }
+
+ private _registerListeners () {
+ const { hls } = this;
+ hls.on(Events.MANIFEST_LOADING, this.onManifestLoading, this);
+ hls.on(Events.MANIFEST_PARSED, this.onManifestParsed, this);
+ hls.on(Events.AUDIO_TRACK_LOADED, this.onAudioTrackLoaded, this);
+ hls.on(Events.AUDIO_TRACK_SWITCHED, this.onAudioTrackSwitched, this);
+ hls.on(Events.LEVEL_LOADING, this.onLevelLoading, this);
+ hls.on(Events.ERROR, this.onError, this);
+ }
+
+ private _unregisterListeners () {
+ const { hls } = this;
+ hls.off(Events.MANIFEST_LOADING, this.onManifestLoading, this);
+ hls.off(Events.MANIFEST_PARSED, this.onManifestParsed, this);
+ hls.off(Events.AUDIO_TRACK_LOADED, this.onAudioTrackLoaded, this);
+ hls.off(Events.AUDIO_TRACK_SWITCHED, this.onAudioTrackSwitched, this);
+ hls.off(Events.LEVEL_LOADING, this.onLevelLoading, this);
+ hls.off(Events.ERROR, this.onError, this);
}
- protected onHandlerDestroying (): void {
+ public destroy () {
+ this._unregisterListeners();
this.clearTimer();
}
@@ -97,10 +112,10 @@ class AudioTrackController extends EventHandler {
*
* Trigger AUDIO_TRACKS_UPDATED event.
*/
- protected onManifestParsed (data: ManifestParsedData): void {
+ protected onManifestParsed (event: Events.MANIFEST_PARSED, data: ManifestParsedData): void {
const tracks = this.tracks = data.audioTracks || [];
- const audioTracksUpdated: AudioTracksUpdated = { audioTracks: tracks };
- this.hls.trigger(Event.AUDIO_TRACKS_UPDATED, audioTracksUpdated);
+ const audioTracksUpdated: AudioTracksUpdatedData = { audioTracks: tracks };
+ this.hls.trigger(Events.AUDIO_TRACKS_UPDATED, audioTracksUpdated);
}
/**
@@ -110,7 +125,7 @@ class AudioTrackController extends EventHandler {
*
* @param {*} data
*/
- protected onAudioTrackLoaded (data: TrackLoadedData): void {
+ protected onAudioTrackLoaded (event: Events.AUDIO_TRACK_LOADED, data: AudioTrackLoadedData): void {
const { id, details } = data;
const currentTrack = this.tracks[id];
const curDetails = currentTrack.details;
@@ -163,7 +178,7 @@ class AudioTrackController extends EventHandler {
*
* Quality-levels should update to that group ID in this case.
*/
- protected onAudioTrackSwitched (data: TrackSwitchedData): void {
+ protected onAudioTrackSwitched (event: Events.AUDIO_TRACK_SWITCHED, data: TrackSwitchedData): void {
const audioGroupId = this.tracks[data.id].groupId;
if (audioGroupId && (this.audioGroupId !== audioGroupId)) {
this.audioGroupId = audioGroupId;
@@ -177,7 +192,7 @@ class AudioTrackController extends EventHandler {
* If group-ID got update, we re-select the appropriate audio-track with this group-ID matching the currently
* selected one (based on NAME property).
*/
- protected onLevelLoading (data: LevelLoadedData): void {
+ protected onLevelLoading (event: Events.LEVEL_LOADING, data: LevelLoadingData): void {
const levelInfo = this.hls.levels[data.level];
if (!levelInfo.audioGroupIds) {
@@ -191,7 +206,7 @@ class AudioTrackController extends EventHandler {
}
}
- protected onError (data: ErrorData): void {
+ protected onError (event: Events.ERROR, data: ErrorData): void {
// Only handle network errors
if (data.type !== ErrorTypes.NETWORK_ERROR) {
return;
@@ -247,7 +262,7 @@ class AudioTrackController extends EventHandler {
this._trackId = newId;
const { url, type, id } = audioTrack;
- this.hls.trigger(Event.AUDIO_TRACK_SWITCHING, { id, type, url });
+ this.hls.trigger(Events.AUDIO_TRACK_SWITCHING, { id, type, url });
this._loadTrackDetailsIfNeeded(audioTrack);
}
@@ -300,7 +315,7 @@ class AudioTrackController extends EventHandler {
if (!trackFound) {
logger.error(`[audio-track-controller]: No track found for running audio group-ID: ${this.audioGroupId}`);
- this.hls.trigger(Event.ERROR, {
+ this.hls.trigger(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.AUDIO_TRACK_LOAD_ERROR,
fatal: true
@@ -319,7 +334,7 @@ class AudioTrackController extends EventHandler {
const { url, id } = audioTrack;
// track not retrieved yet, or live playlist we need to (re)load it
logger.log(`[audio-track-controller]: loading audio-track playlist for id: ${id}`);
- this.hls.trigger(Event.AUDIO_TRACK_LOADING, { url, id });
+ this.hls.trigger(Events.AUDIO_TRACK_LOADING, { url, id });
}
}
diff --git a/src/controller/base-stream-controller.ts b/src/controller/base-stream-controller.ts
index 3b01ccfe1fe..21c493d179d 100644
--- a/src/controller/base-stream-controller.ts
+++ b/src/controller/base-stream-controller.ts
@@ -2,7 +2,7 @@ import TaskLoop from '../task-loop';
import { FragmentState, FragmentTracker } from './fragment-tracker';
import { BufferHelper } from '../utils/buffer-helper';
import { logger } from '../utils/logger';
-import Event from '../events';
+import { Events } from '../events';
import { ErrorDetails } from '../errors';
import * as LevelHelper from './level-helper';
import { ChunkMetadata } from '../types/transmuxer';
@@ -13,9 +13,10 @@ import TransmuxerInterface from '../demux/transmuxer-interface';
import Fragment from '../loader/fragment';
import FragmentLoader, { FragLoadSuccessResult, FragmentLoadProgressCallback } from '../loader/fragment-loader';
import LevelDetails from '../loader/level-details';
-import { BufferAppendingEventPayload } from '../types/events';
+import { BufferAppendingData } from '../types/events';
import { Level } from '../types/level';
import { RemuxedTrack } from '../types/remuxer';
+import Hls from '../hls';
export const State = {
STOPPED: 'STOPPED',
@@ -34,6 +35,8 @@ export const State = {
};
export default class BaseStreamController extends TaskLoop {
+ protected hls: Hls;
+
protected fragPrevious: Fragment | null = null;
protected fragCurrent: Fragment | null = null;
protected fragmentTracker!: FragmentTracker;
@@ -55,12 +58,18 @@ export default class BaseStreamController extends TaskLoop {
protected readonly logPrefix: string = '';
+ constructor (hls: Hls) {
+ super();
+ this.hls = hls;
+ }
+
protected doTick () {
this.onTickEnd();
}
protected onTickEnd () {}
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
public startLoad (startPosition: number) : void {}
public stopLoad () {
@@ -179,7 +188,7 @@ export default class BaseStreamController extends TaskLoop {
// For compatibility, emit the FRAG_LOADED with the same signature
const compatibilityEventData: any = data;
compatibilityEventData.frag = frag;
- this.hls.trigger(Event.FRAG_LOADED, compatibilityEventData);
+ this.hls.trigger(Events.FRAG_LOADED, compatibilityEventData);
// Pass through the whole payload; controllers not implementing progressive loading receive data from this callback
this._handleFragmentLoadComplete(frag, data.payload);
});
@@ -204,7 +213,11 @@ export default class BaseStreamController extends TaskLoop {
stats.parsing.start = stats.buffering.start = self.performance.now();
stats.parsing.end = stats.buffering.end = self.performance.now();
// TODO: set id from calling class
- hls.trigger(Event.FRAG_BUFFERED, { stats, frag: fragCurrent, id: frag.type });
+
+ // Silence FRAG_BUFFERED event if fragCurrent is null
+ if (fragCurrent) {
+ hls.trigger(Events.FRAG_BUFFERED, { stats, frag: fragCurrent, id: frag.type });
+ }
this.tick();
});
}
@@ -217,6 +230,7 @@ export default class BaseStreamController extends TaskLoop {
return frag.level !== fragCurrent.level || frag.sn !== fragCurrent.sn;
}
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
protected _handleFragmentLoadComplete (frag: Fragment, payload: ArrayBuffer | Uint8Array) {
const { transmuxer } = this;
if (!transmuxer) {
@@ -227,11 +241,12 @@ export default class BaseStreamController extends TaskLoop {
transmuxer.flush(chunkMeta);
}
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
protected _handleFragmentLoadProgress (frag: Fragment, payload: ArrayBuffer | Uint8Array) {}
protected _doFragLoad (frag: Fragment, progressCallback?: FragmentLoadProgressCallback) {
this.state = State.FRAG_LOADING;
- this.hls.trigger(Event.FRAG_LOADING, { frag });
+ this.hls.trigger(Events.FRAG_LOADING, { frag });
const errorHandler = (e) => {
const errorData = e ? e.data : null;
@@ -239,7 +254,7 @@ export default class BaseStreamController extends TaskLoop {
this.handleFragLoadAborted(frag);
return;
}
- this.hls.trigger(Event.ERROR, errorData);
+ this.hls.trigger(Events.ERROR, errorData);
};
const level = (this.levels as Array)[frag.level];
@@ -280,10 +295,10 @@ export default class BaseStreamController extends TaskLoop {
this.updateLevelTiming(frag, level);
this.state = State.PARSED;
- this.hls.trigger(Event.FRAG_PARSED, { frag });
+ this.hls.trigger(Events.FRAG_PARSED, { frag });
}
- protected getCurrentContext (chunkMeta: ChunkMetadata) : { frag: Fragment, level: any } | null {
+ protected getCurrentContext (chunkMeta: ChunkMetadata) : { frag: Fragment, level: Level } | null {
const { fragCurrent, levels } = this;
const { level, sn } = chunkMeta;
if (!levels || !levels[level]) {
@@ -320,8 +335,8 @@ export default class BaseStreamController extends TaskLoop {
return;
}
- const segment: BufferAppendingEventPayload = { type: data.type, data: buffer, frag, chunkMeta };
- this.hls.trigger(Event.BUFFER_APPENDING, segment);
+ const segment: BufferAppendingData = { type: data.type, data: buffer, frag, chunkMeta };
+ this.hls.trigger(Events.BUFFER_APPENDING, segment);
this.tick();
}
@@ -455,7 +470,7 @@ export default class BaseStreamController extends TaskLoop {
}
} else if (frag.backtracked) {
// Only backtrack a max of 1 consecutive fragment to prevent sliding back too far when little or no frags start with keyframes
- if (nextFrag && nextFrag.backtracked) {
+ if (nextFrag?.backtracked) {
this.warn(`Already backtracked from fragment ${nextFrag.sn}, will not backtrack to fragment ${frag.sn}. Loading fragment ${nextFrag.sn}`);
frag = nextFrag;
} else {
@@ -486,7 +501,7 @@ export default class BaseStreamController extends TaskLoop {
const liveSyncPosition = this._liveSyncPosition = this.computeLivePosition(start, targetDuration, totalDuration);
this.log(`Buffer end: ${bufferEnd.toFixed(3)} is located too far from the end of live sliding playlist, reset currentTime to : ${liveSyncPosition.toFixed(3)}`);
this.nextLoadPosition = liveSyncPosition;
- if (media && media.readyState && media.duration > liveSyncPosition) {
+ if (media?.readyState && media.duration > liveSyncPosition) {
media.currentTime = liveSyncPosition;
}
return liveSyncPosition;
@@ -584,13 +599,13 @@ export default class BaseStreamController extends TaskLoop {
this.log(`Fragment ${frag.sn} of level ${frag.level} was aborted, flushing transmuxer & resetting nextLoadPosition to ${this.nextLoadPosition}`);
}
- private updateLevelTiming (frag: Fragment, currentLevel) {
+ private updateLevelTiming (frag: Fragment, currentLevel: Level) {
const { details } = currentLevel;
Object.keys(frag.elementaryStreams).forEach(type => {
const info = frag.elementaryStreams[type];
if (info) {
const drift = LevelHelper.updateFragPTSDTS(details, frag, info.startPTS, info.endPTS, info.startDTS, info.endDTS);
- this.hls.trigger(Event.LEVEL_PTS_UPDATED, {
+ this.hls.trigger(Events.LEVEL_PTS_UPDATED, {
details,
level: currentLevel,
drift,
diff --git a/src/controller/buffer-controller.ts b/src/controller/buffer-controller.ts
index 0f6464c6c20..5eaa43f44bf 100644
--- a/src/controller/buffer-controller.ts
+++ b/src/controller/buffer-controller.ts
@@ -2,12 +2,11 @@
* Buffer Controller
*/
-import Events from '../events';
-import EventHandler from '../event-handler';
+import { Events } from '../events';
import { logger } from '../utils/logger';
import { ErrorDetails, ErrorTypes } from '../errors';
import { getMediaSource } from '../utils/mediasource-helper';
-import Fragment, { ElementaryStreamTypes } from '../loader/fragment';
+import { ElementaryStreamTypes } from '../loader/fragment';
import { TrackSet } from '../types/track';
import BufferOperationQueue from './buffer-operation-queue';
import {
@@ -16,11 +15,13 @@ import {
SourceBufferName,
SourceBufferListeners
} from '../types/buffer';
-import { LevelUpdatedData, BufferAppendingEventPayload } from '../types/events';
+import { LevelUpdatedData, BufferAppendingData, MediaAttachingData, ManifestParsedData, BufferCodecsData, LevelPTSUpdatedData, BufferEOSData, BufferFlushingData, FragParsedData } from '../types/events';
+import { ComponentAPI } from '../types/component-api';
+import Hls from '../hls';
const MediaSource = getMediaSource();
-export default class BufferController extends EventHandler {
+export default class BufferController implements ComponentAPI {
// the value that we have set mediasource.duration to
// (the actual duration may be tweaked slighly by the browser)
private _msDuration: number | null = null;
@@ -35,6 +36,8 @@ export default class BufferController extends EventHandler {
// References to event listeners for each SourceBuffer, so that they can be referenced for event removal
private listeners!: SourceBufferListeners;
+ private hls: Hls;
+
// The number of BUFFER_CODEC events received before any sourceBuffers are created
public bufferCodecEventsExpected: number = 0;
@@ -54,22 +57,44 @@ export default class BufferController extends EventHandler {
public pendingTracks: TrackSet = {};
public sourceBuffer!: SourceBuffers;
- constructor (hls: any) {
- super(hls,
- Events.MEDIA_ATTACHING,
- Events.MEDIA_DETACHING,
- Events.MANIFEST_PARSED,
- Events.BUFFER_RESET,
- Events.BUFFER_APPENDING,
- Events.BUFFER_CODECS,
- Events.BUFFER_EOS,
- Events.BUFFER_FLUSHING,
- Events.LEVEL_PTS_UPDATED,
- Events.LEVEL_UPDATED,
- Events.FRAG_PARSED
- );
+ constructor (hls: Hls) {
this.hls = hls;
this._initSourceBuffer();
+ this.registerListeners();
+ }
+
+ public destroy () {
+ this.unregisterListeners();
+ }
+
+ protected registerListeners () {
+ const { hls } = this;
+ hls.on(Events.MEDIA_ATTACHING, this.onMediaAttaching, this);
+ hls.on(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ hls.on(Events.MANIFEST_PARSED, this.onManifestParsed, this);
+ hls.on(Events.BUFFER_RESET, this.onBufferReset, this);
+ hls.on(Events.BUFFER_APPENDING, this.onBufferAppending, this);
+ hls.on(Events.BUFFER_CODECS, this.onBufferCodecs, this);
+ hls.on(Events.BUFFER_EOS, this.onBufferEos, this);
+ hls.on(Events.BUFFER_FLUSHING, this.onBufferFlushing, this);
+ hls.on(Events.LEVEL_PTS_UPDATED, this.onLevelPtsUpdated, this);
+ hls.on(Events.LEVEL_UPDATED, this.onLevelUpdated, this);
+ hls.on(Events.FRAG_PARSED, this.onFragParsed, this);
+ }
+
+ protected unregisterListeners () {
+ const { hls } = this;
+ hls.off(Events.MEDIA_ATTACHING, this.onMediaAttaching, this);
+ hls.off(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ hls.off(Events.MANIFEST_PARSED, this.onManifestParsed, this);
+ hls.off(Events.BUFFER_RESET, this.onBufferReset, this);
+ hls.off(Events.BUFFER_APPENDING, this.onBufferAppending, this);
+ hls.off(Events.BUFFER_CODECS, this.onBufferCodecs, this);
+ hls.off(Events.BUFFER_EOS, this.onBufferEos, this);
+ hls.off(Events.BUFFER_FLUSHING, this.onBufferFlushing, this);
+ hls.off(Events.LEVEL_PTS_UPDATED, this.onLevelPtsUpdated, this);
+ hls.off(Events.LEVEL_UPDATED, this.onLevelUpdated, this);
+ hls.off(Events.FRAG_PARSED, this.onFragParsed, this);
}
private _initSourceBuffer () {
@@ -82,7 +107,7 @@ export default class BufferController extends EventHandler {
};
}
- onManifestParsed (data: { altAudio: boolean }) {
+ protected onManifestParsed (event: Events.MANIFEST_PARSED, data: ManifestParsedData) {
// in case of alt audio 2 BUFFER_CODECS events will be triggered, one per stream controller
// sourcebuffers will be created all at once when the expected nb of tracks will be reached
// in case alt audio is not used, only one BUFFER_CODEC event will be fired from main stream controller
@@ -91,7 +116,7 @@ export default class BufferController extends EventHandler {
logger.log(`${this.bufferCodecEventsExpected} bufferCodec event(s) expected`);
}
- onMediaAttaching (data: { media: HTMLMediaElement }) {
+ protected onMediaAttaching (event: Events.MEDIA_ATTACHING, data: MediaAttachingData) {
const media = this.media = data.media;
if (media && MediaSource) {
const ms = this.mediaSource = new MediaSource();
@@ -106,7 +131,7 @@ export default class BufferController extends EventHandler {
}
}
- onMediaDetaching () {
+ protected onMediaDetaching () {
logger.log('media source detaching');
const { media, mediaSource, _objectUrl } = this;
if (mediaSource) {
@@ -155,7 +180,7 @@ export default class BufferController extends EventHandler {
this.hls.trigger(Events.MEDIA_DETACHED);
}
- onBufferReset () {
+ protected onBufferReset () {
const sourceBuffer = this.sourceBuffer;
this.getSourceBufferTypes().forEach(type => {
const sb = sourceBuffer[type];
@@ -176,15 +201,15 @@ export default class BufferController extends EventHandler {
this._initSourceBuffer();
}
- onBufferCodecs (tracks: TrackSet) {
+ protected onBufferCodecs (event: Events.BUFFER_CODECS, data: BufferCodecsData) {
// if source buffer(s) not created yet, appended buffer tracks in this.pendingTracks
// if sourcebuffers already created, do nothing ...
if (Object.keys(this.sourceBuffer).length) {
return;
}
- Object.keys(tracks).forEach(trackName => {
- this.pendingTracks[trackName] = tracks[trackName];
+ Object.keys(data).forEach(trackName => {
+ this.pendingTracks[trackName] = data[trackName];
});
this.bufferCodecEventsExpected = Math.max(this.bufferCodecEventsExpected - 1, 0);
@@ -193,7 +218,7 @@ export default class BufferController extends EventHandler {
}
}
- onBufferAppending (eventData: BufferAppendingEventPayload) {
+ protected onBufferAppending (event: Events.BUFFER_APPENDING, eventData: BufferAppendingData) {
const { hls, operationQueue } = this;
const { data, type, frag, chunkMeta } = eventData;
const chunkStats = chunkMeta.buffering[type];
@@ -231,7 +256,7 @@ export default class BufferController extends EventHandler {
const event = {
type: ErrorTypes.MEDIA_ERROR,
parent: frag.type,
- details: '',
+ details: ErrorDetails.BUFFER_APPEND_ERROR,
err,
fatal: false
};
@@ -258,7 +283,7 @@ export default class BufferController extends EventHandler {
operationQueue.append(operation, type as SourceBufferName);
}
- onBufferFlushing (data: { startOffset: number, endOffset: number, type?: SourceBufferName }) {
+ protected onBufferFlushing (event: Events.BUFFER_FLUSHING, data: BufferFlushingData) {
const { operationQueue } = this;
const flushOperation = (type): BufferOperation => ({
execute: this.removeExecutor.bind(this, type, data.startOffset, data.endOffset),
@@ -278,7 +303,7 @@ export default class BufferController extends EventHandler {
}
}
- onFragParsed (data: { frag: Fragment }) {
+ protected onFragParsed (event: Events.FRAG_PARSED, data: FragParsedData) {
const { frag } = data;
const buffersAppendedTo: Array = [];
@@ -305,7 +330,7 @@ export default class BufferController extends EventHandler {
// on BUFFER_EOS mark matching sourcebuffer(s) as ended and trigger checkEos()
// an undefined data.type will mark all buffers as EOS.
- onBufferEos (data: { type?: SourceBufferName }) {
+ protected onBufferEos (event: Events.BUFFER_EOS, data: BufferEOSData) {
for (const type in this.sourceBuffer) {
if (!data.type || data.type === type) {
const sb = this.sourceBuffer[type as SourceBufferName];
@@ -330,7 +355,7 @@ export default class BufferController extends EventHandler {
this.blockBuffers(endStream);
}
- onLevelUpdated ({ details }: LevelUpdatedData) {
+ protected onLevelUpdated (event: Events.LEVEL_UPDATED, { details }: LevelUpdatedData) {
if (!details.fragments.length) {
return;
}
@@ -352,7 +377,7 @@ export default class BufferController extends EventHandler {
// `SourceBuffer.abort()` and adjusting `SourceBuffer.timestampOffset` if `SourceBuffer.updating` is false or awaiting `updateend`
// event if SB is in updating state.
// More info here: https://github.com/video-dev/hls.js/issues/332#issuecomment-257986486
- onLevelPtsUpdated (data: { type: SourceBufferName, start: number }) {
+ protected onLevelPtsUpdated (event: Events.LEVEL_PTS_UPDATED, data: LevelPTSUpdatedData) {
const { operationQueue, sourceBuffer, tracks } = this;
const type = data.type;
const audioTrack = tracks.audio;
@@ -409,7 +434,7 @@ export default class BufferController extends EventHandler {
// time will lead to playback freezing)
// credits for level target duration - https://github.com/videojs/http-streaming/blob/3132933b6aa99ddefab29c10447624efd6fd6e52/src/segment-loader.js#L91
logger.log(`[buffer-controller]: Enqueueing operation to flush ${type} back buffer`);
- this.onBufferFlushing({
+ this.onBufferFlushing(Events.BUFFER_FLUSHING, {
startOffset: 0,
endOffset: targetBackBufferPosition,
type
@@ -424,7 +449,7 @@ export default class BufferController extends EventHandler {
* 'liveDurationInfinity` is set to `true`
* More details: https://github.com/video-dev/hls.js/issues/355
*/
- updateMediaElementDuration (levelDuration: number) {
+ private updateMediaElementDuration (levelDuration: number) {
if (!this.media || !this.mediaSource || this.mediaSource.readyState !== 'open') {
return;
}
@@ -451,7 +476,7 @@ export default class BufferController extends EventHandler {
}
}
- private checkPendingTracks () {
+ protected checkPendingTracks () {
const { bufferCodecEventsExpected, operationQueue, pendingTracks } = this;
// Check if we've received all of the expected bufferCodec events. When none remain, create all the sourceBuffers at once.
@@ -470,7 +495,7 @@ export default class BufferController extends EventHandler {
}
}
- private createSourceBuffers (tracks: TrackSet) {
+ protected createSourceBuffers (tracks: TrackSet) {
const { sourceBuffer, mediaSource } = this;
if (!mediaSource) {
throw Error('createSourceBuffers called when mediaSource was null');
@@ -504,7 +529,7 @@ export default class BufferController extends EventHandler {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.BUFFER_ADD_CODEC_ERROR,
fatal: false,
- err,
+ error: err,
mimeType: mimeType
});
}
@@ -517,7 +542,12 @@ export default class BufferController extends EventHandler {
private _onMediaSourceOpen = () => {
const { hls, media, mediaSource } = this;
logger.log('media source opened');
- hls.trigger(Events.MEDIA_ATTACHED, { media });
+ if (media) {
+ hls.trigger(Events.MEDIA_ATTACHED, { media });
+ } else {
+ logger.log('[buffer-controller]: Media source opened, and no media was attached');
+ }
+
if (mediaSource) {
// once received, don't listen anymore to sourceopen event
mediaSource.removeEventListener('sourceopen', this._onMediaSourceOpen);
diff --git a/src/controller/cap-level-controller.ts b/src/controller/cap-level-controller.ts
index b7440e15403..791284ff6d7 100644
--- a/src/controller/cap-level-controller.ts
+++ b/src/controller/cap-level-controller.ts
@@ -2,13 +2,14 @@
* cap stream level to media size dimension controller
*/
-import Event from '../events';
-import EventHandler from '../event-handler';
+import { Events } from '../events';
import { Level } from '../types/level';
import { ManifestParsedData, BufferCodecsData, MediaAttachingData, FPSDropLevelCappingData, LevelsUpdatedData } from '../types/events';
import StreamController from './stream-controller';
+import { ComponentAPI } from '../types/component-api';
+import Hls from '../hls';
-class CapLevelController extends EventHandler {
+class CapLevelController implements ComponentAPI {
public autoLevelCapping: number;
public firstLevel: number;
public levels: Array;
@@ -16,48 +17,65 @@ class CapLevelController extends EventHandler {
public restrictedLevels: Array;
public timer: number | undefined;
+ private hls: Hls;
private streamController?: StreamController;
- constructor (hls) {
- super(hls,
- Event.FPS_DROP_LEVEL_CAPPING,
- Event.MEDIA_ATTACHING,
- Event.MANIFEST_PARSED,
- Event.LEVELS_UPDATED,
- Event.BUFFER_CODECS,
- Event.MEDIA_DETACHING);
-
+ constructor (hls: Hls) {
+ this.hls = hls;
this.autoLevelCapping = Number.POSITIVE_INFINITY;
this.levels = [];
this.firstLevel = -1;
this.media = null;
this.restrictedLevels = [];
this.timer = undefined;
+
+ this.registerListeners();
}
- setStreamController (streamController: StreamController) {
+ public setStreamController (streamController: StreamController) {
this.streamController = streamController;
}
- destroy () {
+ public destroy () {
+ this.unregisterListener();
if (this.hls.config.capLevelToPlayerSize) {
this.media = null;
this.stopCapping();
}
}
- onFpsDropLevelCapping (data: FPSDropLevelCappingData) {
+ protected registerListeners () {
+ const { hls } = this;
+ hls.on(Events.FPS_DROP_LEVEL_CAPPING, this.onFpsDropLevelCapping, this);
+ hls.on(Events.MEDIA_ATTACHING, this.onMediaAttaching, this);
+ hls.on(Events.MANIFEST_PARSED, this.onManifestParsed, this);
+ hls.on(Events.LEVELS_UPDATED, this.onLevelsUpdated, this);
+ hls.on(Events.BUFFER_CODECS, this.onBufferCodecs, this);
+ hls.on(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ }
+
+ protected unregisterListener () {
+ const { hls } = this;
+ hls.off(Events.FPS_DROP_LEVEL_CAPPING, this.onFpsDropLevelCapping, this);
+ hls.off(Events.MEDIA_ATTACHING, this.onMediaAttaching, this);
+ hls.off(Events.MANIFEST_PARSED, this.onManifestParsed, this);
+ hls.off(Events.LEVELS_UPDATED, this.onLevelsUpdated, this);
+ hls.off(Events.BUFFER_CODECS, this.onBufferCodecs, this);
+ hls.off(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ }
+
+ protected onFpsDropLevelCapping (event: Events.FPS_DROP_LEVEL_CAPPING, data: FPSDropLevelCappingData) {
// Don't add a restricted level more than once
if (CapLevelController.isLevelAllowed(data.droppedLevel, this.restrictedLevels)) {
this.restrictedLevels.push(data.droppedLevel);
}
}
- onMediaAttaching (data: MediaAttachingData) {
+ protected onMediaAttaching (event: Events.MEDIA_ATTACHING, data: MediaAttachingData) {
this.media = data.media instanceof HTMLVideoElement ? data.media : null;
}
- onManifestParsed (data: ManifestParsedData) {
+ protected onManifestParsed (event: Events.MANIFEST_PARSED, data: ManifestParsedData) {
const hls = this.hls;
this.restrictedLevels = [];
this.levels = data.levels;
@@ -70,7 +88,7 @@ class CapLevelController extends EventHandler {
// Only activate capping when playing a video stream; otherwise, multi-bitrate audio-only streams will be restricted
// to the first level
- onBufferCodecs (data: BufferCodecsData) {
+ protected onBufferCodecs (event: Events.BUFFER_CODECS, data: BufferCodecsData) {
const hls = this.hls;
if (hls.config.capLevelToPlayerSize && data.video) {
// If the manifest did not signal a video codec capping has been deferred until we're certain video is present
@@ -78,11 +96,11 @@ class CapLevelController extends EventHandler {
}
}
- onLevelsUpdated (data: LevelsUpdatedData) {
+ protected onLevelsUpdated (event: Events.LEVELS_UPDATED, data: LevelsUpdatedData) {
this.levels = data.levels;
}
- onMediaDetaching () {
+ protected onMediaDetaching () {
this.stopCapping();
}
diff --git a/src/controller/eme-controller.ts b/src/controller/eme-controller.ts
index 3ef8c86e4ce..551ec8b918e 100644
--- a/src/controller/eme-controller.ts
+++ b/src/controller/eme-controller.ts
@@ -3,14 +3,15 @@
*
* DRM support for Hls.js
*/
-
-import EventHandler from '../event-handler';
-import Event from '../events';
+import { Events } from '../events';
import { ErrorTypes, ErrorDetails } from '../errors';
import { logger } from '../utils/logger';
import { EMEControllerConfig } from '../config';
import { KeySystems, MediaKeyFunc } from '../utils/mediakeys-helper';
+import Hls from '../hls';
+import { ComponentAPI } from '../types/component-api';
+import { MediaAttachedData, ManifestParsedData } from '../types/events';
const MAX_LICENSE_REQUEST_FAILURES = 3;
@@ -79,7 +80,8 @@ interface MediaKeysListItem {
* @class
* @constructor
*/
-class EMEController extends EventHandler {
+class EMEController implements ComponentAPI {
+ private hls: Hls;
private _widevineLicenseUrl?: string;
private _licenseXhrSetup?: (xhr: XMLHttpRequest, url: string) => void;
private _emeEnabled: boolean;
@@ -95,18 +97,32 @@ class EMEController extends EventHandler {
* @constructs
* @param {Hls} hls Our Hls.js instance
*/
- constructor (hls) {
- super(hls,
- Event.MEDIA_ATTACHED,
- Event.MEDIA_DETACHED,
- Event.MANIFEST_PARSED
- );
+ constructor (hls: Hls) {
+ this.hls = hls;
this._config = hls.config;
this._widevineLicenseUrl = this._config.widevineLicenseUrl;
this._licenseXhrSetup = this._config.licenseXhrSetup;
this._emeEnabled = this._config.emeEnabled;
this._requestMediaKeySystemAccess = this._config.requestMediaKeySystemAccessFunc;
+
+ this._registerListeners();
+ }
+
+ public destroy () {
+ this._unregisterListeners();
+ }
+
+ private _registerListeners () {
+ this.hls.on(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+ this.hls.on(Events.MEDIA_DETACHED, this.onMediaDetached, this);
+ this.hls.on(Events.MANIFEST_PARSED, this.onManifestParsed, this);
+ }
+
+ private _unregisterListeners () {
+ this.hls.off(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+ this.hls.off(Events.MEDIA_DETACHED, this.onMediaDetached, this);
+ this.hls.off(Events.MANIFEST_PARSED, this.onManifestParsed, this);
}
/**
@@ -258,7 +274,7 @@ class EMEController extends EventHandler {
const keysListItem = this._mediaKeysList[0];
if (!keysListItem || !keysListItem.mediaKeys) {
logger.error('Fatal: Media is encrypted but no CDM access or no keys have been obtained yet');
- this.hls.trigger(Event.ERROR, {
+ this.hls.trigger(Events.ERROR, {
type: ErrorTypes.KEY_SYSTEM_ERROR,
details: ErrorDetails.KEY_SYSTEM_NO_KEYS,
fatal: true
@@ -281,7 +297,7 @@ class EMEController extends EventHandler {
const keysListItem = this._mediaKeysList[0];
if (!keysListItem) {
logger.error('Fatal: Media is encrypted but not any key-system access has been obtained yet');
- this.hls.trigger(Event.ERROR, {
+ this.hls.trigger(Events.ERROR, {
type: ErrorTypes.KEY_SYSTEM_ERROR,
details: ErrorDetails.KEY_SYSTEM_NO_ACCESS,
fatal: true
@@ -297,7 +313,7 @@ class EMEController extends EventHandler {
const keySession = keysListItem.mediaKeysSession;
if (!keySession) {
logger.error('Fatal: Media is encrypted but no key-session existing');
- this.hls.trigger(Event.ERROR, {
+ this.hls.trigger(Events.ERROR, {
type: ErrorTypes.KEY_SYSTEM_ERROR,
details: ErrorDetails.KEY_SYSTEM_NO_SESSION,
fatal: true
@@ -308,7 +324,7 @@ class EMEController extends EventHandler {
// initData is null if the media is not CORS-same-origin
if (!initData) {
logger.warn('Fatal: initData required for generating a key session is null');
- this.hls.trigger(Event.ERROR, {
+ this.hls.trigger(Events.ERROR, {
type: ErrorTypes.KEY_SYSTEM_ERROR,
details: ErrorDetails.KEY_SYSTEM_NO_INIT_DATA,
fatal: true
@@ -325,7 +341,7 @@ class EMEController extends EventHandler {
})
.catch((err) => {
logger.error('Error generating key-session request:', err);
- this.hls.trigger(Event.ERROR, {
+ this.hls.trigger(Events.ERROR, {
type: ErrorTypes.KEY_SYSTEM_ERROR,
details: ErrorDetails.KEY_SYSTEM_NO_SESSION,
fatal: false
@@ -393,7 +409,7 @@ class EMEController extends EventHandler {
logger.error(`License Request XHR failed (${url}). Status: ${xhr.status} (${xhr.statusText})`);
this._requestLicenseFailureCount++;
if (this._requestLicenseFailureCount > MAX_LICENSE_REQUEST_FAILURES) {
- this.hls.trigger(Event.ERROR, {
+ this.hls.trigger(Events.ERROR, {
type: ErrorTypes.KEY_SYSTEM_ERROR,
details: ErrorDetails.KEY_SYSTEM_LICENSE_REQUEST_FAILED,
fatal: true
@@ -459,7 +475,7 @@ class EMEController extends EventHandler {
const keysListItem = this._mediaKeysList[0];
if (!keysListItem) {
logger.error('Fatal error: Media is encrypted but no key-system access has been obtained yet');
- this.hls.trigger(Event.ERROR, {
+ this.hls.trigger(Events.ERROR, {
type: ErrorTypes.KEY_SYSTEM_ERROR,
details: ErrorDetails.KEY_SYSTEM_NO_ACCESS,
fatal: true
@@ -475,7 +491,7 @@ class EMEController extends EventHandler {
xhr.send(challenge);
} catch (e) {
logger.error(`Failure requesting DRM license: ${e}`);
- this.hls.trigger(Event.ERROR, {
+ this.hls.trigger(Events.ERROR, {
type: ErrorTypes.KEY_SYSTEM_ERROR,
details: ErrorDetails.KEY_SYSTEM_LICENSE_REQUEST_FAILED,
fatal: true
@@ -483,7 +499,7 @@ class EMEController extends EventHandler {
}
}
- onMediaAttached (data: { media: HTMLMediaElement; }) {
+ onMediaAttached (event: Events.MEDIA_ATTACHED, data: MediaAttachedData) {
if (!this._emeEnabled) {
return;
}
@@ -503,14 +519,17 @@ class EMEController extends EventHandler {
}
}
- // TODO: Use manifest types here when they are defined
- onManifestParsed (data: any) {
+ onManifestParsed (event: Events.MANIFEST_PARSED, data: ManifestParsedData) {
if (!this._emeEnabled) {
return;
}
- const audioCodecs = data.levels.map((level) => level.audioCodec);
- const videoCodecs = data.levels.map((level) => level.videoCodec);
+ const audioCodecs = data.levels.map((level) => level.audioCodec).filter(
+ (audioCodec: string | undefined): audioCodec is string => !!audioCodec
+ );
+ const videoCodecs = data.levels.map((level) => level.videoCodec).filter(
+ (videoCodec: string | undefined): videoCodec is string => !!videoCodec
+ );
this._attemptKeySystemAccess(KeySystems.WIDEVINE, audioCodecs, videoCodecs);
}
diff --git a/src/controller/fps-controller.js b/src/controller/fps-controller.ts
similarity index 50%
rename from src/controller/fps-controller.js
rename to src/controller/fps-controller.ts
index bf1827baa21..e815d28f7d3 100644
--- a/src/controller/fps-controller.js
+++ b/src/controller/fps-controller.ts
@@ -2,15 +2,42 @@
* FPS Controller
*/
-import Event from '../events';
-import EventHandler from '../event-handler';
+import { Events } from '../events';
import { logger } from '../utils/logger';
+import { ComponentAPI } from '../types/component-api';
+import Hls from '../hls';
+import { MediaAttachingData } from '../types/events';
+import StreamController from './stream-controller';
const { performance } = self;
-class FPSController extends EventHandler {
- constructor (hls) {
- super(hls, Event.MEDIA_ATTACHING);
+class FPSController implements ComponentAPI {
+ private hls: Hls;
+ private isVideoPlaybackQualityAvailable: boolean = false;
+ private timer?: number;
+ private video: HTMLVideoElement | null = null;
+ private lastTime: any;
+ private lastDroppedFrames: number = 0;
+ private lastDecodedFrames: number = 0;
+ // stream controller must be provided as a dependency!
+ private streamController!: StreamController;
+
+ constructor (hls: Hls) {
+ this.hls = hls;
+
+ this.registerListeners();
+ }
+
+ public setStreamController (streamController: StreamController) {
+ this.streamController = streamController;
+ }
+
+ protected registerListeners () {
+ this.hls.on(Events.MEDIA_ATTACHING, this.onMediaAttaching, this);
+ }
+
+ protected unregisterListeners () {
+ this.hls.off(Events.MEDIA_ATTACHING, this.onMediaAttaching);
}
destroy () {
@@ -18,23 +45,25 @@ class FPSController extends EventHandler {
clearInterval(this.timer);
}
+ this.unregisterListeners();
this.isVideoPlaybackQualityAvailable = false;
}
- onMediaAttaching (data) {
+ protected onMediaAttaching (event: Events.MEDIA_ATTACHING, data: MediaAttachingData) {
const config = this.hls.config;
if (config.capLevelOnFPSDrop) {
- const video = this.video = data.media instanceof self.HTMLVideoElement ? data.media : null;
- if (typeof video.getVideoPlaybackQuality === 'function') {
+ const video = data.media instanceof self.HTMLVideoElement ? data.media : null;
+ this.video = video;
+ if (video && typeof video.getVideoPlaybackQuality === 'function') {
this.isVideoPlaybackQualityAvailable = true;
}
- clearInterval(this.timer);
+ self.clearInterval(this.timer);
this.timer = self.setTimeout(this.checkFPSInterval.bind(this), config.fpsDroppedMonitoringPeriod);
}
}
- checkFPS (video, decodedFrames, droppedFrames) {
+ checkFPS (video: HTMLVideoElement, decodedFrames: number, droppedFrames: number) {
const currentTime = performance.now();
if (decodedFrames) {
if (this.lastTime) {
@@ -43,7 +72,7 @@ class FPSController extends EventHandler {
const currentDecoded = decodedFrames - this.lastDecodedFrames;
const droppedFPS = 1000 * currentDropped / currentPeriod;
const hls = this.hls;
- hls.trigger(Event.FPS_DROP, { currentDropped: currentDropped, currentDecoded: currentDecoded, totalDroppedFrames: droppedFrames });
+ hls.trigger(Events.FPS_DROP, { currentDropped: currentDropped, currentDecoded: currentDecoded, totalDroppedFrames: droppedFrames });
if (droppedFPS > 0) {
// logger.log('checkFPS : droppedFPS/decodedFPS:' + droppedFPS/(1000 * currentDecoded / currentPeriod));
if (currentDropped > hls.config.fpsDroppedMonitoringThreshold * currentDecoded) {
@@ -51,9 +80,9 @@ class FPSController extends EventHandler {
logger.warn('drop FPS ratio greater than max allowed value for currentLevel: ' + currentLevel);
if (currentLevel > 0 && (hls.autoLevelCapping === -1 || hls.autoLevelCapping >= currentLevel)) {
currentLevel = currentLevel - 1;
- hls.trigger(Event.FPS_DROP_LEVEL_CAPPING, { level: currentLevel, droppedLevel: hls.currentLevel });
+ hls.trigger(Events.FPS_DROP_LEVEL_CAPPING, { level: currentLevel, droppedLevel: hls.currentLevel });
hls.autoLevelCapping = currentLevel;
- hls.streamController.nextLevelSwitch();
+ this.streamController.nextLevelSwitch();
}
}
}
@@ -71,7 +100,8 @@ class FPSController extends EventHandler {
const videoPlaybackQuality = video.getVideoPlaybackQuality();
this.checkFPS(video, videoPlaybackQuality.totalVideoFrames, videoPlaybackQuality.droppedVideoFrames);
} else {
- this.checkFPS(video, video.webkitDecodedFrameCount, video.webkitDroppedFrameCount);
+ // HTMLVideoElement doesn't include the webkit types
+ this.checkFPS(video, (video as any).webkitDecodedFrameCount as number, (video as any).webkitDroppedFrameCount as number);
}
}
}
diff --git a/src/controller/fragment-tracker.ts b/src/controller/fragment-tracker.ts
index 9f507edab1d..c115f27b105 100644
--- a/src/controller/fragment-tracker.ts
+++ b/src/controller/fragment-tracker.ts
@@ -1,9 +1,11 @@
-import EventHandler from '../event-handler';
-import Event from '../events';
+import { Events } from '../events';
import Fragment from '../loader/fragment';
import { SourceBufferName } from '../types/buffer';
import { FragmentBufferedRange, FragmentEntity, FragmentTimeRange } from '../types/fragment-tracker';
import { PlaylistLevelType } from '../types/loader';
+import { ComponentAPI } from '../types/component-api';
+import Hls from '../hls';
+import { BufferAppendedData, FragBufferedData, FragLoadedData } from '../types/events';
export const FragmentState = {
NOT_LOADED: 'NOT_LOADED',
@@ -12,27 +14,40 @@ export const FragmentState = {
OK: 'OK'
};
-export class FragmentTracker extends EventHandler {
+export class FragmentTracker implements ComponentAPI {
private activeFragment: Fragment | null = null;
private fragments: Partial> = Object.create(null);
- private timeRanges: { [key in SourceBufferName]: TimeRanges } = Object.create(null);
+ private timeRanges: {
+ [key in SourceBufferName]?: TimeRanges
+ } | null = Object.create(null);
+
private bufferPadding: number = 0.2;
- private config: any;
-
- constructor (hls) {
- super(hls,
- Event.BUFFER_APPENDED,
- Event.FRAG_BUFFERED,
- Event.FRAG_LOADED
- );
- this.config = hls.config;
+ private hls: Hls;
+
+ constructor (hls: Hls) {
+ this.hls = hls;
+
+ this._registerListeners();
+ }
+
+ private _registerListeners () {
+ const { hls } = this;
+ hls.on(Events.BUFFER_APPENDED, this.onBufferAppended, this);
+ hls.on(Events.FRAG_BUFFERED, this.onFragBuffered, this);
+ hls.on(Events.FRAG_LOADED, this.onFragLoaded, this);
}
- destroy (): void {
+ private _unregisterListeners () {
+ const { hls } = this;
+ hls.off(Events.BUFFER_APPENDED, this.onBufferAppended, this);
+ hls.off(Events.FRAG_BUFFERED, this.onFragBuffered, this);
+ hls.off(Events.FRAG_LOADED, this.onFragLoaded, this);
+ }
+
+ public destroy (): void {
this.fragments = Object.create(null);
this.timeRanges = Object.create(null);
- this.config = null;
- super.destroy();
+ this._unregisterListeners();
}
/**
@@ -121,6 +136,10 @@ export class FragmentTracker extends EventHandler {
*/
detectPartialFragments (fragment: Fragment) : void {
const { timeRanges, fragments } = this;
+ if (!timeRanges) {
+ return;
+ }
+
const fragKey = getFragmentKey(fragment);
const fragmentEntity = fragments[fragKey];
if (!fragmentEntity) {
@@ -248,11 +267,11 @@ export class FragmentTracker extends EventHandler {
/**
* Fires when a fragment loading is completed
*/
- onFragLoaded (e): void {
- const fragment = e.frag;
+ onFragLoaded (event: Events.FRAG_LOADED, data: FragLoadedData): void {
+ const fragment = data.frag;
// don't track initsegment (for which sn is not a number)
// don't track frags used for bitrateTest, they're irrelevant.
- if (!Number.isFinite(fragment.sn) || fragment.bitrateTest) {
+ if (!Number.isFinite(fragment.sn as number) || fragment.bitrateTest) {
return;
}
@@ -266,8 +285,8 @@ export class FragmentTracker extends EventHandler {
/**
* Fires when the buffer is updated
*/
- onBufferAppended (e): void {
- const { frag, timeRanges } = e;
+ onBufferAppended (event: Events.BUFFER_APPENDED, data: BufferAppendedData): void {
+ const { frag, timeRanges } = data;
this.activeFragment = frag;
// Store the latest timeRanges loaded in the buffer
this.timeRanges = timeRanges;
@@ -283,8 +302,8 @@ export class FragmentTracker extends EventHandler {
/**
* Fires after a fragment has been loaded into the source buffer
*/
- onFragBuffered (e): void {
- this.detectPartialFragments(e.frag);
+ onFragBuffered (event: Events.FRAG_BUFFERED, data: FragBufferedData): void {
+ this.detectPartialFragments(data.frag);
}
/**
@@ -316,8 +335,8 @@ export class FragmentTracker extends EventHandler {
function isPartial (fragmentEntity: FragmentEntity): boolean {
return fragmentEntity.buffered &&
- ((fragmentEntity.range.video !== undefined && fragmentEntity.range.video.partial) ||
- (fragmentEntity.range.audio !== undefined && fragmentEntity.range.audio.partial));
+ (fragmentEntity.range.video?.partial ||
+ fragmentEntity.range.audio?.partial);
}
function getFragmentKey (fragment: Fragment): string {
diff --git a/src/controller/gap-controller.ts b/src/controller/gap-controller.ts
index fa953956178..8e6e041ebe9 100644
--- a/src/controller/gap-controller.ts
+++ b/src/controller/gap-controller.ts
@@ -1,6 +1,6 @@
import { BufferHelper, BufferInfo } from '../utils/buffer-helper';
import { ErrorTypes, ErrorDetails } from '../errors';
-import Event from '../events';
+import { Events } from '../events';
import { logger } from '../utils/logger';
import Hls from '../hls';
import { HlsConfig } from '../config';
@@ -168,7 +168,7 @@ export default class GapController {
// Report stalled error once
this.stallReported = true;
logger.warn(`Playback stalling at @${media.currentTime} due to low buffer`);
- hls.trigger(Event.ERROR, {
+ hls.trigger(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.BUFFER_STALLED_ERROR,
fatal: false,
@@ -182,7 +182,7 @@ export default class GapController {
* @param partial - The partial fragment found at the current time (where playback is stalling).
* @private
*/
- private _trySkipBufferHole (partial: Fragment | null) {
+ private _trySkipBufferHole (partial: Fragment | null): number {
const { config, hls, media } = this;
const currentTime = media.currentTime;
let lastEndTime = 0;
@@ -196,7 +196,7 @@ export default class GapController {
this.stalled = null;
media.currentTime = targetTime;
if (partial) {
- hls.trigger(Event.ERROR, {
+ hls.trigger(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.BUFFER_SEEK_OVER_HOLE,
fatal: false,
@@ -226,15 +226,14 @@ export default class GapController {
// playback stalled in buffered area ... let's nudge currentTime to try to overcome this
logger.warn(`Nudging 'currentTime' from ${currentTime} to ${targetTime}`);
media.currentTime = targetTime;
-
- hls.trigger(Event.ERROR, {
+ hls.trigger(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.BUFFER_NUDGE_ON_STALL,
fatal: false
});
} else {
logger.error(`Playhead still not moving while enough data buffered @${currentTime} after ${config.nudgeMaxRetry} nudges`);
- hls.trigger(Event.ERROR, {
+ hls.trigger(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.BUFFER_STALLED_ERROR,
fatal: true
diff --git a/src/controller/level-controller.ts b/src/controller/level-controller.ts
index 0ccce845dda..753898d453d 100644
--- a/src/controller/level-controller.ts
+++ b/src/controller/level-controller.ts
@@ -11,18 +11,19 @@ import {
ErrorData
} from '../types/events';
import { Level, LevelParsed } from '../types/level';
-import Event from '../events';
-import EventHandler from '../event-handler';
+import { Events } from '../events';
import { logger } from '../utils/logger';
import { ErrorTypes, ErrorDetails } from '../errors';
import { isCodecSupportedInMp4 } from '../utils/codecs';
import { addGroupId, computeReloadInterval } from './level-helper';
import Fragment from '../loader/fragment';
import { MediaPlaylist } from '../types/media-playlist';
+import { NetworkComponentAPI } from '../types/component-api';
+import Hls from '../hls';
-let chromeOrFirefox: boolean;
+const chromeOrFirefox: boolean = /chrome|firefox/.test(navigator.userAgent.toLowerCase());
-export default class LevelController extends EventHandler {
+export default class LevelController implements NetworkComponentAPI {
private _levels: Level[] | null = null;
private _firstLevel: number = -1;
private _startLevel?: number;
@@ -31,21 +32,36 @@ export default class LevelController extends EventHandler {
private levelRetryCount: number = 0;
private manualLevelIndex: number = -1;
private timer: number | null = null;
+ private hls: Hls;
+
public onParsedComplete!: Function;
- constructor (hls) {
- super(hls,
- Event.MANIFEST_LOADED,
- Event.LEVEL_LOADED,
- Event.AUDIO_TRACK_SWITCHED,
- Event.FRAG_LOADED,
- Event.ERROR);
+ constructor (hls: Hls) {
+ this.hls = hls;
+ this._registerListeners();
+ }
+
+ private _registerListeners () {
+ const { hls } = this;
+ hls.on(Events.MANIFEST_LOADED, this.onManifestLoaded, this);
+ hls.on(Events.LEVEL_LOADED, this.onLevelLoaded, this);
+ hls.on(Events.AUDIO_TRACK_SWITCHED, this.onAudioTrackSwitched, this);
+ hls.on(Events.FRAG_LOADED, this.onFragLoaded, this);
+ hls.on(Events.ERROR, this.onError, this);
+ }
- chromeOrFirefox = /chrome|firefox/.test(navigator.userAgent.toLowerCase());
+ private _unregisterListeners () {
+ const { hls } = this;
+ hls.off(Events.MANIFEST_LOADED, this.onManifestLoaded, this);
+ hls.off(Events.LEVEL_LOADED, this.onLevelLoaded, this);
+ hls.off(Events.AUDIO_TRACK_SWITCHED, this.onAudioTrackSwitched, this);
+ hls.off(Events.FRAG_LOADED, this.onFragLoaded, this);
+ hls.off(Events.ERROR, this.onError, this);
}
- protected onHandlerDestroying (): void {
+ public destroy () {
this.clearTimer();
+ this._unregisterListeners();
this.manualLevelIndex = -1;
}
@@ -67,7 +83,7 @@ export default class LevelController extends EventHandler {
levels.forEach(level => {
level.loadError = 0;
const levelDetails = level.details;
- if (levelDetails && levelDetails.live) {
+ if (levelDetails?.live) {
level.details = undefined;
}
});
@@ -83,7 +99,7 @@ export default class LevelController extends EventHandler {
this.clearTimer();
}
- protected onManifestLoaded (data: ManifestLoadedData): void {
+ protected onManifestLoaded (event: Events.MANIFEST_LOADED, data: ManifestLoadedData): void {
let levels: Level[] = [];
let audioTracks: MediaPlaylist[] = [];
let bitrateStart: number | undefined;
@@ -169,11 +185,11 @@ export default class LevelController extends EventHandler {
video: videoCodecFound,
altAudio: audioTracks.some(t => !!t.url)
};
- this.hls.trigger(Event.MANIFEST_PARSED, edata);
+ this.hls.trigger(Events.MANIFEST_PARSED, edata);
this.onParsedComplete();
} else {
- this.hls.trigger(Event.ERROR, {
+ this.hls.trigger(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.MANIFEST_INCOMPATIBLE_CODECS_ERROR,
fatal: true,
@@ -205,7 +221,7 @@ export default class LevelController extends EventHandler {
if (this.currentLevelIndex !== newLevel) {
logger.log(`[level-controller]: switching to level ${newLevel}`);
this.currentLevelIndex = newLevel;
- hls.trigger(Event.LEVEL_SWITCHING, Object.assign({}, levels[newLevel], {
+ hls.trigger(Events.LEVEL_SWITCHING, Object.assign({}, levels[newLevel], {
level: newLevel
}));
}
@@ -219,7 +235,7 @@ export default class LevelController extends EventHandler {
}
} else {
// invalid level id given, trigger error
- hls.trigger(Event.ERROR, {
+ hls.trigger(Events.ERROR, {
type: ErrorTypes.OTHER_ERROR,
details: ErrorDetails.LEVEL_SWITCH_ERROR,
level: newLevel,
@@ -273,7 +289,7 @@ export default class LevelController extends EventHandler {
this._startLevel = newLevel;
}
- protected onError (data: ErrorData) {
+ protected onError (event: Events.ERROR, data: ErrorData) {
if (data.fatal) {
if (data.type === ErrorTypes.NETWORK_ERROR) {
this.clearTimer();
@@ -382,7 +398,7 @@ export default class LevelController extends EventHandler {
}
// reset errors on the successful load of a fragment
- protected onFragLoaded ({ frag }: FragLoadedData) {
+ protected onFragLoaded (event: Events.FRAG_LOADED, { frag }: FragLoadedData) {
if (frag !== undefined && frag.type === 'main') {
if (!this._levels) {
throw new Error('Levels are not set');
@@ -396,7 +412,7 @@ export default class LevelController extends EventHandler {
}
}
- protected onLevelLoaded (data: LevelLoadedData) {
+ protected onLevelLoaded (event: Events.LEVEL_LOADED, data: LevelLoadedData) {
const { level, details } = data;
// only process level loaded events matching with expected level
if (level !== this.currentLevelIndex) {
@@ -423,7 +439,7 @@ export default class LevelController extends EventHandler {
}
}
- protected onAudioTrackSwitched (data: TrackSwitchedData) {
+ protected onAudioTrackSwitched (event: Events.AUDIO_TRACK_SWITCHED, data: TrackSwitchedData) {
const audioGroupId = this.hls.audioTracks[data.id].groupId;
const currentLevel = this.hls.levels[this.currentLevelIndex as number];
@@ -464,7 +480,7 @@ export default class LevelController extends EventHandler {
// console.log('Current audio track group ID:', this.hls.audioTracks[this.hls.audioTrack].groupId);
// console.log('New video quality level audio group id:', levelObject.attrs.AUDIO, level);
- this.hls.trigger(Event.LEVEL_LOADING, { url, level, id });
+ this.hls.trigger(Events.LEVEL_LOADING, { url, level, id });
}
}
}
@@ -501,7 +517,7 @@ export default class LevelController extends EventHandler {
return false;
}).map((level, index) => {
const { details } = level;
- if (details && details.fragments) {
+ if (details?.fragments) {
details.fragments.forEach((fragment) => {
fragment.level = index;
});
@@ -510,6 +526,6 @@ export default class LevelController extends EventHandler {
});
this._levels = levels;
- this.hls.trigger(Event.LEVELS_UPDATED, { levels });
+ this.hls.trigger(Events.LEVELS_UPDATED, { levels });
}
}
diff --git a/src/controller/level-helper.ts b/src/controller/level-helper.ts
index 0c412004125..bdd1bc80c6e 100644
--- a/src/controller/level-helper.ts
+++ b/src/controller/level-helper.ts
@@ -58,7 +58,7 @@ export function updatePTS (fragments: Fragment[], fromIdx: number, toIdx: number
}
}
-export function updateFragPTSDTS (details: LevelDetails, frag: Fragment, startPTS: number, endPTS: number, startDTS: number, endDTS: number): number {
+export function updateFragPTSDTS (details: LevelDetails | undefined, frag: Fragment, startPTS: number, endPTS: number, startDTS: number, endDTS: number): number {
let maxStartPTS = startPTS;
if (Number.isFinite(frag.startPTS)) {
// delta PTS between audio and video
diff --git a/src/controller/stream-controller.ts b/src/controller/stream-controller.ts
index 7e7d4523af6..2b331c401b4 100644
--- a/src/controller/stream-controller.ts
+++ b/src/controller/stream-controller.ts
@@ -1,7 +1,7 @@
import { BufferHelper } from '../utils/buffer-helper';
import TransmuxerInterface from '../demux/transmuxer-interface';
-import Event from '../events';
-import { FragmentState } from './fragment-tracker';
+import { Events } from '../events';
+import { FragmentState, FragmentTracker } from './fragment-tracker';
import Fragment, { ElementaryStreamTypes } from '../loader/fragment';
import PlaylistLoader from '../loader/playlist-loader';
import TimeRanges from '../utils/time-ranges';
@@ -15,11 +15,13 @@ import { Level } from '../types/level';
import LevelDetails from '../loader/level-details';
import { TrackSet } from '../types/track';
import { SourceBufferName } from '../types/buffer';
-import { LevelUpdatedData, BufferAppendingEventPayload } from '../types/events';
+import { LevelLoadedData, ManifestParsedData, MediaAttachedData, AudioTrackSwitchingData, LevelsUpdatedData, AudioTrackSwitchedData, BufferCreatedData, ErrorData } from '../types/events';
+import Hls from '../hls';
+import { NetworkComponentAPI } from '../types/component-api';
const TICK_INTERVAL = 100; // how often to tick in ms
-export default class StreamController extends BaseStreamController {
+export default class StreamController extends BaseStreamController implements NetworkComponentAPI {
private audioCodecSwap: boolean = false;
private bitrateTest: boolean = false;
private gapController: GapController | null = null;
@@ -30,10 +32,10 @@ export default class StreamController extends BaseStreamController {
private fragPlaying: Fragment | null = null;
private previouslyPaused: boolean = false;
private immediateSwitch: boolean = false;
- private onvplaying: Function | null = null;
- private onvseeking: Function | null = null;
- private onvseeked: Function | null = null;
- private onvended: Function | null = null;
+ private onvplaying: EventListener | null = null;
+ private onvseeking: EventListener | null = null;
+ private onvseeked: EventListener | null = null;
+ private onvended: EventListener | null = null;
private fragLastKbps: number = 0;
private stalled: boolean = false;
private audioCodecSwitch: boolean = false;
@@ -41,32 +43,58 @@ export default class StreamController extends BaseStreamController {
protected readonly logPrefix = '[stream-controller]';
- constructor (hls, fragmentTracker) {
- super(hls,
- Event.MEDIA_ATTACHED,
- Event.MEDIA_DETACHING,
- Event.MANIFEST_LOADING,
- Event.MANIFEST_PARSED,
- Event.LEVEL_LOADING,
- Event.LEVEL_LOADED,
- Event.KEY_LOADED,
- Event.FRAG_LOAD_EMERGENCY_ABORTED,
- Event.ERROR,
- Event.AUDIO_TRACK_SWITCHING,
- Event.AUDIO_TRACK_SWITCHED,
- Event.BUFFER_CREATED,
- Event.BUFFER_FLUSHED,
- Event.LEVELS_UPDATED,
- Event.FRAG_BUFFERED
- );
-
+ constructor (hls: Hls, fragmentTracker: FragmentTracker) {
+ super(hls);
this.fragmentLoader = new FragmentLoader(hls.config);
this.config = hls.config;
this.fragmentTracker = fragmentTracker;
this.state = State.STOPPED;
+
+ this._registerListeners();
}
- startLoad (startPosition): void {
+ private _registerListeners () {
+ const { hls } = this;
+ hls.on(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+ hls.on(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ hls.on(Events.MANIFEST_LOADING, this.onManifestLoading, this);
+ hls.on(Events.MANIFEST_PARSED, this.onManifestParsed, this);
+ hls.on(Events.LEVEL_LOADING, this.onLevelLoading, this);
+ hls.on(Events.LEVEL_LOADED, this.onLevelLoaded, this);
+ hls.on(Events.KEY_LOADED, this.onKeyLoaded, this);
+ hls.on(Events.FRAG_LOAD_EMERGENCY_ABORTED, this.onFragLoadEmergencyAborted, this);
+ hls.on(Events.ERROR, this.onError, this);
+ hls.on(Events.AUDIO_TRACK_SWITCHING, this.onAudioTrackSwitching, this);
+ hls.on(Events.AUDIO_TRACK_SWITCHED, this.onAudioTrackSwitched, this);
+ hls.on(Events.BUFFER_CREATED, this.onBufferCreated, this);
+ hls.on(Events.BUFFER_FLUSHED, this.onBufferFlushed, this);
+ hls.on(Events.LEVELS_UPDATED, this.onLevelsUpdated, this);
+ hls.on(Events.FRAG_BUFFERED, this.onFragBuffered, this);
+ }
+
+ protected _unregisterListeners () {
+ const { hls } = this;
+ hls.off(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+ hls.off(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ hls.off(Events.MANIFEST_LOADING, this.onManifestLoading, this);
+ hls.off(Events.MANIFEST_PARSED, this.onManifestParsed, this);
+ hls.off(Events.LEVEL_LOADED, this.onLevelLoaded, this);
+ hls.off(Events.KEY_LOADED, this.onKeyLoaded, this);
+ hls.off(Events.FRAG_LOAD_EMERGENCY_ABORTED, this.onFragLoadEmergencyAborted, this);
+ hls.off(Events.ERROR, this.onError, this);
+ hls.off(Events.AUDIO_TRACK_SWITCHING, this.onAudioTrackSwitching, this);
+ hls.off(Events.AUDIO_TRACK_SWITCHED, this.onAudioTrackSwitched, this);
+ hls.off(Events.BUFFER_CREATED, this.onBufferCreated, this);
+ hls.off(Events.BUFFER_FLUSHED, this.onBufferFlushed, this);
+ hls.off(Events.LEVELS_UPDATED, this.onLevelsUpdated, this);
+ hls.off(Events.FRAG_BUFFERED, this.onFragBuffered, this);
+ }
+
+ protected onHandlerDestroying () {
+ this._unregisterListeners();
+ }
+
+ startLoad (startPosition: number): void {
if (this.levels) {
const { lastCurrentTime, hls } = this;
this.stopLoad();
@@ -116,7 +144,7 @@ export default class StreamController extends BaseStreamController {
break;
case State.WAITING_LEVEL: {
const { levels, level } = this;
- if (levels && levels[level] && levels[level].details) {
+ if (levels?.[level]?.details) {
// Details is set after the playlist has been loaded
this.state = State.IDLE;
break;
@@ -206,7 +234,7 @@ export default class StreamController extends BaseStreamController {
data.type = 'video';
}
- this.hls.trigger(Event.BUFFER_EOS, data);
+ this.hls.trigger(Events.BUFFER_EOS, data);
this.state = State.ENDED;
return;
}
@@ -227,7 +255,7 @@ export default class StreamController extends BaseStreamController {
_loadKey (frag: Fragment) {
this.state = State.KEY_LOADING;
- this.hls.trigger(Event.KEY_LOADING, { frag });
+ this.hls.trigger(Events.KEY_LOADING, { frag });
}
_loadFragment (frag: Fragment) {
@@ -297,7 +325,7 @@ export default class StreamController extends BaseStreamController {
this.previouslyPaused = previouslyPaused;
}
const fragCurrent = this.fragCurrent;
- if (fragCurrent && fragCurrent.loader) {
+ if (fragCurrent?.loader) {
fragCurrent.loader.abort();
}
@@ -313,7 +341,7 @@ export default class StreamController extends BaseStreamController {
*/
immediateLevelSwitchEnd () {
const media = this.media;
- if (media && media.buffered.length) {
+ if (media?.buffered.length) {
this.immediateSwitch = false;
if (BufferHelper.isBuffered(media, media.currentTime)) {
// only nudge if currentTime is buffered
@@ -334,7 +362,7 @@ export default class StreamController extends BaseStreamController {
nextLevelSwitch () {
const { levels, media } = this;
// ensure that media is defined and that metadata are available (to retrieve currentTime)
- if (media && media.readyState) {
+ if (media?.readyState) {
let fetchdelay;
let nextBufferedFrag;
const fragPlayingCurrent = this.getAppendedFrag(media.currentTime);
@@ -365,7 +393,7 @@ export default class StreamController extends BaseStreamController {
if (nextBufferedFrag) {
// if we are here, we can also cancel any loading/demuxing in progress, as they are useless
const fragCurrent = this.fragCurrent;
- if (fragCurrent && fragCurrent.loader) {
+ if (fragCurrent?.loader) {
fragCurrent.loader.abort();
}
@@ -385,19 +413,19 @@ export default class StreamController extends BaseStreamController {
const flushScope: any = { startOffset: startOffset, endOffset: endOffset, type: this.altAudio ? 'video' : null };
// Reset load errors on flush
this.fragLoadError = 0;
- this.hls.trigger(Event.BUFFER_FLUSHING, flushScope);
+ this.hls.trigger(Events.BUFFER_FLUSHING, flushScope);
}
- onMediaAttached (data) {
+ onMediaAttached (event: Events.MEDIA_ATTACHED, data: MediaAttachedData) {
const media = this.media = this.mediaBuffer = data.media;
this.onvplaying = this.onMediaPlaying.bind(this);
this.onvseeking = this.onMediaSeeking.bind(this);
this.onvseeked = this.onMediaSeeked.bind(this);
this.onvended = this.onMediaEnded.bind(this);
- media.addEventListener('playing', this.onvplaying);
- media.addEventListener('seeking', this.onvseeking);
- media.addEventListener('seeked', this.onvseeked);
- media.addEventListener('ended', this.onvended);
+ media.addEventListener('playing', this.onvplaying as EventListener);
+ media.addEventListener('seeking', this.onvseeking as EventListener);
+ media.addEventListener('seeked', this.onvseeked as EventListener);
+ media.addEventListener('ended', this.onvended as EventListener);
const config = this.config;
if (this.levels && config.autoStartLoad) {
this.hls.startLoad(config.startPosition);
@@ -408,7 +436,7 @@ export default class StreamController extends BaseStreamController {
onMediaDetaching () {
const { levels, media } = this;
- if (media && media.ended) {
+ if (media?.ended) {
this.log('MSE detaching and video ended, reset startPosition');
this.startPosition = this.lastCurrentTime = 0;
}
@@ -455,14 +483,14 @@ export default class StreamController extends BaseStreamController {
onManifestLoading () {
// reset buffer on manifest loading
this.log('Trigger BUFFER_RESET');
- this.hls.trigger(Event.BUFFER_RESET);
+ this.hls.trigger(Events.BUFFER_RESET);
this.fragmentTracker.removeAllFragments();
this.stalled = false;
this.startPosition = this.lastCurrentTime = 0;
this.fragPlaying = null;
}
- onManifestParsed (data) {
+ onManifestParsed (event: Events.MANIFEST_PARSED, data: ManifestParsedData) {
let aac = false;
let heaac = false;
let codec;
@@ -492,7 +520,7 @@ export default class StreamController extends BaseStreamController {
this.state = State.WAITING_LEVEL;
}
- onLevelLoaded (data) {
+ onLevelLoaded (event: Events.LEVEL_LOADED, data: LevelLoadedData) {
const { levels } = this;
const newLevelId = data.level;
const newDetails = data.details;
@@ -517,8 +545,7 @@ export default class StreamController extends BaseStreamController {
// override level info
curLevel.details = newDetails;
this.levelLastLoaded = newLevelId;
- const levelUpdatedData: LevelUpdatedData = { details: newDetails, level: newLevelId };
- this.hls.trigger(Event.LEVEL_UPDATED, levelUpdatedData);
+ this.hls.trigger(Events.LEVEL_UPDATED, { details: newDetails, level: newLevelId });
if (!this.startFragRequested) {
this.setStartPosition(newDetails, sliding);
@@ -551,7 +578,7 @@ export default class StreamController extends BaseStreamController {
const videoCodec = currentLevel.videoCodec;
// time Offset is accurate if level PTS is known, or if playlist is not sliding (not live) and if media is not seeking (this is to overcome potential timestamp drifts between playlists and fragments)
- const accurateTimeOffset = !(media && media.seeking) && (details.PTSKnown || !details.live);
+ const accurateTimeOffset = !(media?.seeking) && (details.PTSKnown || !details.live);
const initSegmentData = details.initSegment ? details.initSegment.data : [];
const audioCodec = this._getAudioCodec(currentLevel);
@@ -575,7 +602,7 @@ export default class StreamController extends BaseStreamController {
);
}
- onAudioTrackSwitching (data) {
+ onAudioTrackSwitching (event: Events.AUDIO_TRACK_SWITCHING, data: AudioTrackSwitchingData) {
// if any URL found on new audio track, it is an alternate audio track
const altAudio = !!data.url;
const trackId = data.id;
@@ -588,7 +615,7 @@ export default class StreamController extends BaseStreamController {
this.mediaBuffer = this.media;
const fragCurrent = this.fragCurrent;
// we need to refill audio buffer from main: cancel any frag loading to speed up audio switch
- if (fragCurrent && fragCurrent.loader) {
+ if (fragCurrent?.loader) {
this.log('Switching to main audio track, cancel main fragment load');
fragCurrent.loader.abort();
}
@@ -604,13 +631,13 @@ export default class StreamController extends BaseStreamController {
}
const hls = this.hls;
// switching to main audio, flush all audio and trigger track switched
- hls.trigger(Event.BUFFER_FLUSHING, { startOffset: 0, endOffset: Number.POSITIVE_INFINITY, type: 'audio' });
- hls.trigger(Event.AUDIO_TRACK_SWITCHED, { id: trackId });
+ hls.trigger(Events.BUFFER_FLUSHING, { startOffset: 0, endOffset: Number.POSITIVE_INFINITY, type: 'audio' });
+ hls.trigger(Events.AUDIO_TRACK_SWITCHED, { id: trackId });
this.altAudio = false;
}
}
- onAudioTrackSwitched (data) {
+ onAudioTrackSwitched (event: Events.AUDIO_TRACK_SWITCHED, data: AudioTrackSwitchedData) {
const trackId = data.id;
const altAudio = !!this.hls.audioTracks[trackId].url;
if (altAudio) {
@@ -625,7 +652,7 @@ export default class StreamController extends BaseStreamController {
this.tick();
}
- onBufferCreated (data) {
+ onBufferCreated (event: Events.BUFFER_CREATED, data: BufferCreatedData) {
const tracks = data.tracks;
let mediaTrack;
let name;
@@ -637,7 +664,10 @@ export default class StreamController extends BaseStreamController {
mediaTrack = track;
// keep video source buffer reference
if (type === 'video') {
- this.videoBuffer = tracks[type].buffer;
+ const videoTrack = tracks[type];
+ if (videoTrack) {
+ this.videoBuffer = videoTrack.buffer;
+ }
}
} else {
alternate = true;
@@ -651,7 +681,7 @@ export default class StreamController extends BaseStreamController {
}
}
- onFragBuffered (data: { frag: Fragment }) {
+ onFragBuffered (event: Events.FRAG_BUFFERED, data: { frag: Fragment }) {
const { frag } = data;
if (frag && frag.type !== 'main') {
return;
@@ -672,7 +702,7 @@ export default class StreamController extends BaseStreamController {
this.tick();
}
- onError (data) {
+ onError (event: Events.ERROR, data: ErrorData) {
const frag = data.frag || this.fragCurrent;
// don't handle frag error not related to main fragment
if (frag && frag.type !== 'main') {
@@ -692,6 +722,7 @@ export default class StreamController extends BaseStreamController {
if ((this.fragLoadError + 1) <= this.config.fragLoadingMaxRetry) {
// exponential backoff capped to config.fragLoadingMaxRetryTimeout
const delay = Math.min(Math.pow(2, this.fragLoadError) * this.config.fragLoadingRetryDelay, this.config.fragLoadingMaxRetryTimeout);
+ // @ts-ignore - frag is potentially null according to TS here
this.warn(`Fragment ${frag.sn} of level ${frag.level} failed to load, retrying in ${delay}ms`);
this.retryDate = self.performance.now() + delay;
// retry loading state
@@ -728,7 +759,7 @@ export default class StreamController extends BaseStreamController {
break;
case ErrorDetails.BUFFER_FULL_ERROR:
// if in appending state
- if (data.parent === 'main' && (this.state === State.PARSING ||Â this.state === State.PARSED)) {
+ if (data.parent === 'main' && (this.state === State.PARSING || this.state === State.PARSED)) {
// reduce max buf len if current position is buffered
if (mediaBuffered) {
this._reduceMaxBufferLength(this.config.maxBufferLength);
@@ -810,7 +841,7 @@ export default class StreamController extends BaseStreamController {
this.fragPrevious = null;
}
- onLevelsUpdated (data) {
+ onLevelsUpdated (event: Events.LEVELS_UPDATED, data: LevelsUpdatedData) {
this.levels = data.levels;
}
@@ -867,7 +898,7 @@ export default class StreamController extends BaseStreamController {
const stats = frag.stats;
// Bitrate tests fragments are neither parsed nor buffered
stats.parsing.start = stats.parsing.end = stats.buffering.start = stats.buffering.end = self.performance.now();
- hls.trigger(Event.FRAG_BUFFERED, { stats, frag, id: 'main' });
+ hls.trigger(Events.FRAG_BUFFERED, { stats, frag, id: 'main' });
this.tick();
});
}
@@ -892,16 +923,18 @@ export default class StreamController extends BaseStreamController {
if (initSegment) {
if (initSegment.tracks) {
this._bufferInitSegment(level, initSegment.tracks, frag, chunkMeta);
- hls.trigger(Event.FRAG_PARSING_INIT_SEGMENT, { frag, id, tracks: initSegment.tracks });
+ hls.trigger(Events.FRAG_PARSING_INIT_SEGMENT, { frag, id, tracks: initSegment.tracks });
}
+
+ // This would be nice if Number.isFinite acted as a typeguard, but it doesn't. See: https://github.com/Microsoft/TypeScript/issues/10038
if (Number.isFinite(initSegment.initPTS as number)) {
- hls.trigger(Event.INIT_PTS_FOUND, { frag, id, initPTS: initSegment.initPTS });
+ hls.trigger(Events.INIT_PTS_FOUND, { frag, id, initPTS: initSegment.initPTS as number });
}
}
// Avoid buffering if backtracking this fragment
if (video) {
- if (_hasDroppedFrames(frag, video.dropped, level.details.startSN)) {
+ if (level.details && _hasDroppedFrames(frag, video.dropped, level.details.startSN)) {
this.backtrack(frag, video.startPTS);
return;
} else {
@@ -915,17 +948,17 @@ export default class StreamController extends BaseStreamController {
this.bufferFragmentData(audio, frag, chunkMeta);
}
- if (id3 && id3.samples && id3.samples.length) {
+ if (id3?.samples?.length) {
const emittedID3: any = id3;
emittedID3.frag = frag;
emittedID3.id = id;
- hls.trigger(Event.FRAG_PARSING_METADATA, emittedID3);
+ hls.trigger(Events.FRAG_PARSING_METADATA, emittedID3);
}
if (text) {
const emittedText: any = text;
emittedText.frag = frag;
emittedText.id = id;
- hls.trigger(Event.FRAG_PARSING_USERDATA, emittedText);
+ hls.trigger(Events.FRAG_PARSING_USERDATA, emittedText);
}
}
@@ -970,15 +1003,14 @@ export default class StreamController extends BaseStreamController {
video.levelCodec = currentLevel.videoCodec;
video.id = 'main';
}
- this.hls.trigger(Event.BUFFER_CODECS, tracks);
+ this.hls.trigger(Events.BUFFER_CODECS, tracks);
// loop through tracks that are going to be provided to bufferController
Object.keys(tracks).forEach(trackName => {
const track = tracks[trackName];
const initSegment = track.initSegment;
this.log(`Main track:${trackName},container:${track.container},codecs[level/parsed]=[${track.levelCodec}/${track.codec}]`);
if (initSegment) {
- const segment: BufferAppendingEventPayload = { type: trackName as SourceBufferName, data: initSegment, frag, chunkMeta };
- this.hls.trigger(Event.BUFFER_APPENDING, segment);
+ this.hls.trigger(Events.BUFFER_APPENDING, { type: trackName as SourceBufferName, data: initSegment, frag, chunkMeta });
}
});
// trigger handler right now
@@ -1022,10 +1054,10 @@ export default class StreamController extends BaseStreamController {
if (fragPlayingCurrent) {
const fragPlaying = fragPlayingCurrent;
if (fragPlaying !== this.fragPlaying) {
- this.hls.trigger(Event.FRAG_CHANGED, { frag: fragPlaying });
+ this.hls.trigger(Events.FRAG_CHANGED, { frag: fragPlaying });
const fragPlayingLevel = fragPlaying.level;
if (!this.fragPlaying || this.fragPlaying.level !== fragPlayingLevel) {
- this.hls.trigger(Event.LEVEL_SWITCHED, { level: fragPlayingLevel });
+ this.hls.trigger(Events.LEVEL_SWITCHED, { level: fragPlayingLevel });
}
this.fragPlaying = fragPlaying;
diff --git a/src/controller/subtitle-stream-controller.ts b/src/controller/subtitle-stream-controller.ts
index 86cf8a446d1..b1087f20809 100644
--- a/src/controller/subtitle-stream-controller.ts
+++ b/src/controller/subtitle-stream-controller.ts
@@ -2,12 +2,12 @@
* @class SubtitleStreamController
*/
-import Event from '../events';
+import { Events } from '../events';
import { logger } from '../utils/logger';
import Decrypter from '../crypt/decrypter';
import { BufferHelper } from '../utils/buffer-helper';
import { findFragmentByPDT, findFragmentByPTS } from './fragment-finders';
-import { FragmentState } from './fragment-tracker';
+import { FragmentState, FragmentTracker } from './fragment-tracker';
import BaseStreamController, { State } from './base-stream-controller';
import FragmentLoader from '../loader/fragment-loader';
import { mergeSubtitlePlaylists } from './level-helper';
@@ -16,13 +16,15 @@ import {
LevelUpdatedData,
MediaAttachedData,
SubtitleFragProcessed,
- SubtitleTracksUpdated,
+ SubtitleTracksUpdatedData,
TrackLoadedData,
TrackSwitchedData
} from '../types/events';
import { Level } from '../types/level';
import Fragment from '../loader/fragment';
import LevelDetails from '../loader/level-details';
+import { ComponentAPI } from '../types/component-api';
+import Hls from '../hls';
const { performance } = self;
@@ -33,8 +35,9 @@ interface TimeRange {
end: number
}
-export class SubtitleStreamController extends BaseStreamController {
+export class SubtitleStreamController extends BaseStreamController implements ComponentAPI {
protected levels: Array = [];
+
private currentTrackId: number = -1;
private decrypter: Decrypter;
private tracksBuffered: Array;
@@ -42,18 +45,8 @@ export class SubtitleStreamController extends BaseStreamController {
private lastAVStart: number = 0;
private readonly _onMediaSeeking: () => void;
- constructor (hls, fragmentTracker) {
- super(hls,
- Event.MEDIA_ATTACHED,
- Event.MEDIA_DETACHING,
- Event.ERROR,
- Event.KEY_LOADED,
- Event.SUBTITLE_TRACKS_UPDATED,
- Event.SUBTITLE_TRACK_SWITCH,
- Event.SUBTITLE_TRACK_LOADED,
- Event.SUBTITLE_FRAG_PROCESSED,
- Event.LEVEL_UPDATED);
-
+ constructor (hls: Hls, fragmentTracker: FragmentTracker) {
+ super(hls);
this.config = hls.config;
this.decrypter = new Decrypter(hls, hls.config);
this.fragCurrent = null;
@@ -64,15 +57,44 @@ export class SubtitleStreamController extends BaseStreamController {
this.tracksBuffered = [];
this.fragmentLoader = new FragmentLoader(hls.config);
this._onMediaSeeking = this.onMediaSeeking.bind(this);
+
+ this._registerListeners();
+ }
+
+ private _registerListeners () {
+ const { hls } = this;
+ hls.on(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+ hls.on(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ hls.on(Events.ERROR, this.onError, this);
+ hls.on(Events.KEY_LOADED, this.onKeyLoaded, this);
+ hls.on(Events.SUBTITLE_TRACKS_UPDATED, this.onSubtitleTracksUpdated, this);
+ hls.on(Events.SUBTITLE_TRACK_SWITCH, this.onSubtitleTrackSwitch, this);
+ hls.on(Events.SUBTITLE_TRACK_LOADED, this.onSubtitleTrackLoaded, this);
+ hls.on(Events.SUBTITLE_FRAG_PROCESSED, this.onSubtitleFragProcessed, this);
+ hls.on(Events.LEVEL_UPDATED, this.onLevelUpdated, this);
+ }
+
+ private _unregisterListeners () {
+ const { hls } = this;
+ hls.off(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+ hls.off(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ hls.off(Events.ERROR, this.onError, this);
+ hls.off(Events.KEY_LOADED, this.onKeyLoaded, this);
+ hls.off(Events.SUBTITLE_TRACKS_UPDATED, this.onSubtitleTracksUpdated, this);
+ hls.off(Events.SUBTITLE_TRACK_SWITCH, this.onSubtitleTrackSwitch, this);
+ hls.off(Events.SUBTITLE_TRACK_LOADED, this.onSubtitleTrackLoaded, this);
+ hls.off(Events.SUBTITLE_FRAG_PROCESSED, this.onSubtitleFragProcessed, this);
+ hls.off(Events.LEVEL_UPDATED, this.onLevelUpdated, this);
}
onHandlerDestroyed () {
delete this.fragmentTracker;
this.state = State.STOPPED;
+ this._unregisterListeners();
super.onHandlerDestroyed();
}
- onSubtitleFragProcessed (data: SubtitleFragProcessed) {
+ onSubtitleFragProcessed (event: Events.SUBTITLE_FRAG_PROCESSED, data: SubtitleFragProcessed) {
const { frag, success } = data;
this.fragPrevious = frag;
this.state = State.IDLE;
@@ -108,7 +130,7 @@ export class SubtitleStreamController extends BaseStreamController {
}
}
- onMediaAttached ({ media }: MediaAttachedData) {
+ onMediaAttached (event: Events.MEDIA_ATTACHED, { media }: MediaAttachedData) {
this.media = media;
media.addEventListener('seeking', this._onMediaSeeking);
this.state = State.IDLE;
@@ -129,7 +151,7 @@ export class SubtitleStreamController extends BaseStreamController {
}
// If something goes wrong, proceed to next frag, if we were processing one.
- onError (data: ErrorData) {
+ onError (event: Events.ERROR, data: ErrorData) {
const frag = data.frag;
// don't handle error not related to subtitle fragment
if (!frag || frag.type !== 'subtitle') {
@@ -139,7 +161,7 @@ export class SubtitleStreamController extends BaseStreamController {
}
// Got all new subtitle levels.
- onSubtitleTracksUpdated ({ subtitleTracks }: SubtitleTracksUpdated) {
+ onSubtitleTracksUpdated (event: Events.SUBTITLE_TRACKS_UPDATED, { subtitleTracks }: SubtitleTracksUpdatedData) {
logger.log('subtitle levels updated');
this.tracksBuffered = [];
this.levels = subtitleTracks.map(mediaPlaylist => new Level(mediaPlaylist));
@@ -148,7 +170,7 @@ export class SubtitleStreamController extends BaseStreamController {
});
}
- onSubtitleTrackSwitch (data: TrackSwitchedData) {
+ onSubtitleTrackSwitch (event: Events.SUBTITLE_TRACK_SWITCH, data: TrackSwitchedData) {
this.currentTrackId = data.id;
if (!this.levels.length || this.currentTrackId === -1) {
@@ -158,13 +180,13 @@ export class SubtitleStreamController extends BaseStreamController {
// Check if track has the necessary details to load fragments
const currentTrack = this.levels[this.currentTrackId];
- if (currentTrack && currentTrack.details) {
+ if (currentTrack?.details) {
this.setInterval(TICK_INTERVAL);
}
}
// Got a new set of subtitle fragments.
- onSubtitleTrackLoaded (data: TrackLoadedData) {
+ onSubtitleTrackLoaded (event: Events.SUBTITLE_TRACK_LOADED, data: TrackLoadedData) {
const { id, details } = data;
const { currentTrackId, levels } = this;
if (!levels.length || !details) {
@@ -201,7 +223,7 @@ export class SubtitleStreamController extends BaseStreamController {
// decrypt the subtitles
this.decrypter.webCryptoDecrypt(new Uint8Array(payload), decryptData.key.buffer, decryptData.iv.buffer).then((decryptedData) => {
const endTime = performance.now();
- hls.trigger(Event.FRAG_DECRYPTED, {
+ hls.trigger(Events.FRAG_DECRYPTED, {
frag,
payload: decryptedData,
stats: {
@@ -213,7 +235,7 @@ export class SubtitleStreamController extends BaseStreamController {
}
}
- onLevelUpdated ({ details }: LevelUpdatedData) {
+ onLevelUpdated (event: Events.LEVEL_UPDATED, { details }: LevelUpdatedData) {
const frags = details.fragments;
this.lastAVStart = frags.length ? frags[0].start : 0;
}
@@ -258,10 +280,10 @@ export class SubtitleStreamController extends BaseStreamController {
foundFrag = fragments[fragLen - 1];
}
- if (foundFrag && foundFrag.encrypted) {
+ if (foundFrag?.encrypted) {
logger.log(`Loading key for ${foundFrag.sn}`);
this.state = State.KEY_LOADING;
- this.hls.trigger(Event.KEY_LOADING, { frag: foundFrag });
+ this.hls.trigger(Events.KEY_LOADING, { frag: foundFrag });
} else if (foundFrag && fragmentTracker.getState(foundFrag) === FragmentState.NOT_LOADED) {
// only load if fragment is not loaded
this.fragCurrent = foundFrag;
diff --git a/src/controller/subtitle-track-controller.ts b/src/controller/subtitle-track-controller.ts
index 0e4209cdfff..4dedc39014c 100644
--- a/src/controller/subtitle-track-controller.ts
+++ b/src/controller/subtitle-track-controller.ts
@@ -1,34 +1,53 @@
-import Event from '../events';
-import EventHandler from '../event-handler';
+import { Events } from '../events';
import { logger } from '../utils/logger';
import { computeReloadInterval } from './level-helper';
import { clearCurrentCues } from '../utils/texttrack-utils';
import { MediaPlaylist } from '../types/media-playlist';
-import { TrackLoadedData, ManifestLoadedData, MediaAttachedData, SubtitleTracksUpdated } from '../types/events';
+import { TrackLoadedData, ManifestLoadedData, MediaAttachedData, SubtitleTracksUpdatedData } from '../types/events';
+import { ComponentAPI } from '../types/component-api';
+import Hls from '../hls';
-class SubtitleTrackController extends EventHandler {
+class SubtitleTrackController implements ComponentAPI {
+ private hls: Hls;
private tracks: MediaPlaylist[];
private trackId: number = -1;
- private media: HTMLVideoElement | null = null;
+ private media: HTMLMediaElement | null = null;
private stopped: boolean = true;
- private subtitleDisplay: boolean = true; // Enable/disable subtitle display rendering
private queuedDefaultTrack?: number;
private trackChangeListener: () => void = () => this._onTextTracksChanged();
private useTextTrackPolling: boolean = false;
private subtitlePollingInterval: number = -1;
private timer: number | null = null;
- constructor (hls) {
- super(hls,
- Event.MEDIA_ATTACHED,
- Event.MEDIA_DETACHING,
- Event.MANIFEST_LOADED,
- Event.SUBTITLE_TRACK_LOADED);
+ public subtitleDisplay: boolean = true; // Enable/disable subtitle display rendering
+
+ constructor (hls: Hls) {
+ this.hls = hls;
this.tracks = [];
+
+ this._registerListeners();
+ }
+
+ public destroy () {
+ this._unregisterListeners();
+ }
+
+ private _registerListeners () {
+ this.hls.on(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+ this.hls.on(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ this.hls.on(Events.MANIFEST_LOADED, this.onManifestLoaded, this);
+ this.hls.on(Events.SUBTITLE_TRACK_LOADED, this.onSubtitleTrackLoaded, this);
+ }
+
+ private _unregisterListeners () {
+ this.hls.off(Events.MEDIA_ATTACHED, this.onMediaAttached, this);
+ this.hls.off(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ this.hls.off(Events.MANIFEST_LOADED, this.onManifestLoaded, this);
+ this.hls.off(Events.SUBTITLE_TRACK_LOADED, this.onSubtitleTrackLoaded, this);
}
// Listen for subtitle track change, then extract the current track ID.
- protected onMediaAttached (data: MediaAttachedData): void {
+ protected onMediaAttached (event: Events.MEDIA_ATTACHED, data: MediaAttachedData): void {
this.media = data.media;
if (!this.media) {
return;
@@ -75,11 +94,11 @@ class SubtitleTrackController extends EventHandler {
}
// Fired whenever a new manifest is loaded.
- protected onManifestLoaded (data: ManifestLoadedData): void {
+ protected onManifestLoaded (event: Events.MANIFEST_LOADED, data: ManifestLoadedData): void {
const subtitleTracks = data.subtitles || [];
this.tracks = subtitleTracks;
- const subtitleTracksUpdated: SubtitleTracksUpdated = { subtitleTracks };
- this.hls.trigger(Event.SUBTITLE_TRACKS_UPDATED, subtitleTracksUpdated);
+ const subtitleTracksUpdated: SubtitleTracksUpdatedData = { subtitleTracks };
+ this.hls.trigger(Events.SUBTITLE_TRACKS_UPDATED, subtitleTracksUpdated);
// loop through available subtitle tracks and autoselect default if needed
// TODO: improve selection logic to handle forced, etc
@@ -98,7 +117,7 @@ class SubtitleTrackController extends EventHandler {
});
}
- protected onSubtitleTrackLoaded (data: TrackLoadedData): void {
+ protected onSubtitleTrackLoaded (event: Events.SUBTITLE_TRACK_LOADED, data: TrackLoadedData): void {
const { id, details } = data;
const { trackId, tracks } = this;
const currentTrack = tracks[trackId];
@@ -166,7 +185,7 @@ class SubtitleTrackController extends EventHandler {
return;
}
logger.log(`[subtitle-track-controller]: Loading subtitle track ${trackId}`);
- hls.trigger(Event.SUBTITLE_TRACK_LOADING, { url: currentTrack.url, id: trackId });
+ hls.trigger(Events.SUBTITLE_TRACK_LOADING, { url: currentTrack.url, id: trackId });
}
/**
@@ -210,7 +229,7 @@ class SubtitleTrackController extends EventHandler {
this.trackId = newId;
logger.log(`[subtitle-track-controller]: Switching to subtitle track ${newId}`);
- hls.trigger(Event.SUBTITLE_TRACK_SWITCH, { id: newId });
+ hls.trigger(Events.SUBTITLE_TRACK_SWITCH, { id: newId });
this._loadCurrentTrack();
}
diff --git a/src/controller/timeline-controller.ts b/src/controller/timeline-controller.ts
index 5ea7d1d9809..d7833ed9ba5 100644
--- a/src/controller/timeline-controller.ts
+++ b/src/controller/timeline-controller.ts
@@ -1,5 +1,4 @@
-import Event from '../events';
-import EventHandler from '../event-handler';
+import { Events } from '../events';
import Cea608Parser, { CaptionScreen } from '../utils/cea-608-parser';
import OutputFilter from '../utils/output-filter';
import WebVTTParser from '../utils/webvtt-parser';
@@ -8,8 +7,10 @@ import { sendAddTrackEvent, clearCurrentCues } from '../utils/texttrack-utils';
import Fragment from '../loader/fragment';
import { HlsConfig } from '../config';
import { parseIMSC1, IMSC1_CODEC } from '../utils/imsc1-ttml-parser';
-import { ManifestLoadedData } from '../types/events';
import { MediaPlaylist } from '../types/media-playlist';
+import Hls from '../hls';
+import { FragParsingUserdataData, FragLoadedData, FragDecryptedData, MediaAttachingData, ManifestLoadedData, InitPTSFoundData } from '../types/events';
+import { ComponentAPI } from '../types/component-api';
function canReuseVttTextTrack (inUseTrack, manifestTrack) {
return inUseTrack && inUseTrack.label === manifestTrack.name && !(inUseTrack.textTrack1 || inUseTrack.textTrack2);
@@ -19,7 +20,8 @@ function intersection (x1, x2, y1, y2) {
return Math.min(x2, y2) - Math.max(x1, y1);
}
-class TimelineController extends EventHandler {
+class TimelineController implements ComponentAPI {
+ private hls: Hls;
private media: HTMLMediaElement | null = null;
private config: HlsConfig;
private enabled: boolean = true;
@@ -27,7 +29,7 @@ class TimelineController extends EventHandler {
private textTracks: Array = [];
private tracks: Array = [];
private initPTS: Array = [];
- private unparsedVttFrags: Array<{frag: Fragment, payload: any}> = [];
+ private unparsedVttFrags: Array = [];
private cueRanges: { [trackName: string]: Array } = {};
private captionsTracks: { [trackName: string]: any } = {};
private captionsProperties: any;
@@ -36,19 +38,7 @@ class TimelineController extends EventHandler {
private prevCC: number = -1;
private vttCCs: any = null;
- constructor (hls) {
- super(hls, Event.MEDIA_ATTACHING,
- Event.MEDIA_DETACHING,
- Event.FRAG_PARSING_USERDATA,
- Event.FRAG_DECRYPTED,
- Event.MANIFEST_LOADING,
- Event.MANIFEST_LOADED,
- Event.FRAG_LOADED,
- Event.INIT_PTS_FOUND,
- Event.FRAG_PARSING_INIT_SEGMENT,
- Event.SUBTITLE_TRACKS_CLEARED
- );
-
+ constructor (hls: Hls) {
this.hls = hls;
this.config = hls.config;
this.Cues = hls.config.cueHandler;
@@ -79,6 +69,36 @@ class TimelineController extends EventHandler {
const channel4 = new OutputFilter(this, 'textTrack4');
this.cea608Parser = new Cea608Parser(channel1, channel2, channel3, channel4);
}
+
+ this._registerListeners();
+ }
+
+ private _registerListeners (): void {
+ const { hls } = this;
+ hls.on(Events.MEDIA_ATTACHING, this.onMediaAttaching, this);
+ hls.on(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ hls.on(Events.FRAG_PARSING_USERDATA, this.onFragParsingUserdata, this);
+ hls.on(Events.FRAG_DECRYPTED, this.onFragDecrypted, this);
+ hls.on(Events.MANIFEST_LOADING, this.onManifestLoading, this);
+ hls.on(Events.MANIFEST_LOADED, this.onManifestLoaded, this);
+ hls.on(Events.FRAG_LOADED, this.onFragLoaded, this);
+ hls.on(Events.INIT_PTS_FOUND, this.onInitPtsFound, this);
+ hls.on(Events.FRAG_PARSING_INIT_SEGMENT, this.onFragParsingInitSegment, this);
+ hls.on(Events.SUBTITLE_TRACKS_CLEARED, this.onSubtitleTracksCleared, this);
+ }
+
+ private _unregisterListeners (): void {
+ const { hls } = this;
+ hls.off(Events.MEDIA_ATTACHING, this.onMediaAttaching, this);
+ hls.off(Events.MEDIA_DETACHING, this.onMediaDetaching, this);
+ hls.off(Events.FRAG_PARSING_USERDATA, this.onFragParsingUserdata, this);
+ hls.off(Events.FRAG_DECRYPTED, this.onFragDecrypted, this);
+ hls.off(Events.MANIFEST_LOADING, this.onManifestLoading, this);
+ hls.off(Events.MANIFEST_LOADED, this.onManifestLoaded, this);
+ hls.off(Events.FRAG_LOADED, this.onFragLoaded, this);
+ hls.off(Events.INIT_PTS_FOUND, this.onInitPtsFound, this);
+ hls.off(Events.FRAG_PARSING_INIT_SEGMENT, this.onFragParsingInitSegment, this);
+ hls.off(Events.SUBTITLE_TRACKS_CLEARED, this.onSubtitleTracksCleared, this);
}
addCues (trackName: string, startTime: number, endTime: number, screen: CaptionScreen) {
@@ -110,12 +130,12 @@ class TimelineController extends EventHandler {
this.captionsTracks[trackName].addCue(cue);
});
} else {
- this.hls.trigger(Event.CUES_PARSED, { type: 'captions', cues: cues, track: trackName });
+ this.hls.trigger(Events.CUES_PARSED, { type: 'captions', cues: cues, track: trackName });
}
}
// Triggered when an initial PTS is found; used for synchronisation of WebVTT.
- onInitPtsFound (data: { id: string, frag: Fragment, initPTS: number}) {
+ onInitPtsFound (event: Events.INIT_PTS_FOUND, data: InitPTSFoundData) {
const { frag, id, initPTS } = data;
const { unparsedVttFrags } = this;
if (id === 'main') {
@@ -127,7 +147,8 @@ class TimelineController extends EventHandler {
if (unparsedVttFrags.length) {
this.unparsedVttFrags = [];
unparsedVttFrags.forEach(frag => {
- this.onFragLoaded(frag);
+ // TODO: This can be either FragLoadedData or FragDecryptedData
+ this.onFragLoaded(Events.FRAG_LOADED, frag as FragLoadedData);
});
}
}
@@ -184,13 +205,12 @@ class TimelineController extends EventHandler {
}
const label = props.label;
const track = {
- _id: trackName,
label,
kind: 'captions',
default: false
};
captionsTracks[trackName] = track;
- this.hls.trigger(Event.NON_NATIVE_TEXT_TRACKS_FOUND, { tracks: [track] });
+ this.hls.trigger(Events.NON_NATIVE_TEXT_TRACKS_FOUND, { tracks: [track] });
}
createTextTrack (kind: TextTrackKind, label?: string, lang?: string): TextTrack | undefined {
@@ -202,10 +222,10 @@ class TimelineController extends EventHandler {
}
destroy () {
- super.destroy();
+ this._unregisterListeners();
}
- onMediaAttaching (data: { media: HTMLMediaElement }) {
+ onMediaAttaching (event: Events.MEDIA_ATTACHING, data: MediaAttachingData) {
this.media = data.media;
this._cleanTracks();
}
@@ -252,7 +272,7 @@ class TimelineController extends EventHandler {
}
}
- onManifestLoaded (data: ManifestLoadedData) {
+ onManifestLoaded (event: Events.MANIFEST_LOADED, data: ManifestLoadedData) {
this.textTracks = [];
this.unparsedVttFrags = this.unparsedVttFrags || [];
this.initPTS = [];
@@ -303,7 +323,7 @@ class TimelineController extends EventHandler {
default: track.default
};
});
- this.hls.trigger(Event.NON_NATIVE_TEXT_TRACKS_FOUND, { tracks: tracksList });
+ this.hls.trigger(Events.NON_NATIVE_TEXT_TRACKS_FOUND, { tracks: tracksList });
}
}
@@ -325,28 +345,26 @@ class TimelineController extends EventHandler {
}
}
- onFragLoaded (data: { frag: Fragment, payload: any }) {
+ onFragLoaded (event: Events.FRAG_LOADED, data: FragLoadedData) {
const { frag, payload } = data;
- const { cea608Parser, initPTS, unparsedVttFrags } = this;
+ const { cea608Parser, initPTS, lastSn, unparsedVttFrags } = this;
if (frag.type === 'main') {
const sn = frag.sn;
// if this frag isn't contiguous, clear the parser so cues with bad start/end times aren't added to the textTrack
- if (sn !== this.lastSn + 1) {
+ if (sn !== lastSn + 1) {
if (cea608Parser) {
cea608Parser.reset();
}
}
this.lastSn = sn as number;
- } // eslint-disable-line brace-style
- // If fragment is subtitle type, parse as WebVTT.
- else if (frag.type === 'subtitle') {
+ } else if (frag.type === 'subtitle') { // If fragment is subtitle type, parse as WebVTT.
if (payload.byteLength) {
// We need an initial synchronisation PTS. Store fragments as long as none has arrived.
if (!Number.isFinite(initPTS[frag.cc])) {
unparsedVttFrags.push(data);
if (this.initPTS.length) {
// finish unsuccessfully, otherwise the subtitle-stream-controller could be blocked from loading new frags.
- this.hls.trigger(Event.SUBTITLE_FRAG_PROCESSED, { success: false, frag, error: new Error('Missing initial subtitle PTS') });
+ this.hls.trigger(Events.SUBTITLE_FRAG_PROCESSED, { success: false, frag, error: new Error('Missing initial subtitle PTS') });
}
return;
}
@@ -368,37 +386,37 @@ class TimelineController extends EventHandler {
}
} else {
// In case there is no payload, finish unsuccessfully.
- this.hls.trigger(Event.SUBTITLE_FRAG_PROCESSED, { success: false, frag, error: new Error('Empty subtitle payload') });
+ this.hls.trigger(Events.SUBTITLE_FRAG_PROCESSED, { success: false, frag, error: new Error('Empty subtitle payload') });
}
}
}
- _parseIMSC1 (frag, payload) {
+ private _parseIMSC1 (frag: Fragment, payload: ArrayBuffer) {
const hls = this.hls;
parseIMSC1(payload, this.initPTS[frag.cc], (cues) => {
this._appendCues(cues, frag.level);
- hls.trigger(Event.SUBTITLE_FRAG_PROCESSED, { success: true, frag: frag });
+ hls.trigger(Events.SUBTITLE_FRAG_PROCESSED, { success: true, frag: frag });
}, (error) => {
logger.log(`Failed to parse IMSC1: ${error}`);
- hls.trigger(Event.SUBTITLE_FRAG_PROCESSED, { success: false, frag: frag, error });
+ hls.trigger(Events.SUBTITLE_FRAG_PROCESSED, { success: false, frag: frag, error });
});
}
- _parseVTTs (frag, payload, vttCCs) {
+ private _parseVTTs (frag: Fragment, payload: ArrayBuffer, vttCCs: any) {
const hls = this.hls;
// Parse the WebVTT file contents.
WebVTTParser.parse(payload, this.initPTS[frag.cc], vttCCs, frag.cc, (cues) => {
this._appendCues(cues, frag.level);
- hls.trigger(Event.SUBTITLE_FRAG_PROCESSED, { success: true, frag: frag });
+ hls.trigger(Events.SUBTITLE_FRAG_PROCESSED, { success: true, frag: frag });
}, (error) => {
this._fallbackToIMSC1(frag, payload);
// Something went wrong while parsing. Trigger event with success false.
logger.log(`Failed to parse VTT cue: ${error}`);
- hls.trigger(Event.SUBTITLE_FRAG_PROCESSED, { success: false, frag: frag, error });
+ hls.trigger(Events.SUBTITLE_FRAG_PROCESSED, { success: false, frag: frag, error });
});
}
- _fallbackToIMSC1 (frag, payload) {
+ private _fallbackToIMSC1 (frag: Fragment, payload: ArrayBuffer) {
// If textCodec is unknown, try parsing as IMSC1. Set textCodec based on the result
const trackPlaylistMedia = this.tracks[frag.level];
if (!trackPlaylistMedia.textCodec) {
@@ -411,7 +429,7 @@ class TimelineController extends EventHandler {
}
}
- _appendCues (cues, fragLevel) {
+ private _appendCues (cues, fragLevel) {
const hls = this.hls;
if (this.config.renderNatively) {
const textTrack = this.textTracks[fragLevel];
@@ -421,19 +439,19 @@ class TimelineController extends EventHandler {
} else {
const currentTrack = this.tracks[fragLevel];
const track = currentTrack.default ? 'default' : 'subtitles' + fragLevel;
- hls.trigger(Event.CUES_PARSED, { type: 'subtitles', cues, track });
+ hls.trigger(Events.CUES_PARSED, { type: 'subtitles', cues, track });
}
}
- onFragDecrypted (data: { frag: Fragment, payload: any}) {
+ onFragDecrypted (event: Events.FRAG_DECRYPTED, data: FragDecryptedData) {
const { frag } = data;
if (frag.type === 'subtitle') {
if (!Number.isFinite(this.initPTS[frag.cc])) {
- this.unparsedVttFrags.push(data);
+ this.unparsedVttFrags.push(data as unknown as FragLoadedData);
return;
}
- this.onFragLoaded(data);
+ this.onFragLoaded(Events.FRAG_LOADED, data as unknown as FragLoadedData);
}
}
@@ -442,7 +460,7 @@ class TimelineController extends EventHandler {
this.captionsTracks = {};
}
- onFragParsingUserdata (data: { samples: Array }) {
+ onFragParsingUserdata (event: Events.FRAG_PARSING_USERDATA, data: FragParsingUserdataData) {
if (!this.enabled || !this.cea608Parser) {
return;
}
@@ -464,7 +482,7 @@ class TimelineController extends EventHandler {
// If we receive this event, we have not received an onInitPtsFound event. This happens when the video track has no samples (but has audio)
// In order to have captions display, which requires an initPTS, we assume one of 90000
if (typeof this.initPTS === 'undefined') {
- this.onInitPtsFound({ id: '', frag: new Fragment(), initPTS: 90000 });
+ this.onInitPtsFound(Events.INIT_PTS_FOUND, { id: '', frag: new Fragment(), initPTS: 90000 });
}
}
diff --git a/src/crypt/aes-crypto.ts b/src/crypt/aes-crypto.ts
index 80d6aba8ffa..30b409e40e0 100644
--- a/src/crypt/aes-crypto.ts
+++ b/src/crypt/aes-crypto.ts
@@ -1,13 +1,13 @@
export default class AESCrypto {
- private subtle: any;
+ private subtle: SubtleCrypto;
private aesIV: ArrayBuffer;
- constructor (subtle, iv) {
+ constructor (subtle: SubtleCrypto, iv: ArrayBuffer) {
this.subtle = subtle;
this.aesIV = iv;
}
- decrypt (data: ArrayBuffer, key) {
+ decrypt (data: ArrayBuffer, key: CryptoKey) {
return this.subtle.decrypt({ name: 'AES-CBC', iv: this.aesIV }, key, data);
}
}
diff --git a/src/crypt/decrypter.ts b/src/crypt/decrypter.ts
index 5bc81d045f1..0d855a958a6 100644
--- a/src/crypt/decrypter.ts
+++ b/src/crypt/decrypter.ts
@@ -113,6 +113,10 @@ export default class Decrypter {
return this.fastAesKey.expandKey()
.then((aesKey) => {
// decrypt using web crypto
+ if (!subtle) {
+ return Promise.reject(new Error('web crypto not initialized'));
+ }
+
const crypto = new AESCrypto(subtle, iv);
return crypto.decrypt(data.buffer, aesKey);
})
diff --git a/src/demux/adts.js b/src/demux/adts.js
index 34f9b4da897..11b674a2eff 100644
--- a/src/demux/adts.js
+++ b/src/demux/adts.js
@@ -5,7 +5,7 @@
import { logger } from '../utils/logger';
import { ErrorTypes, ErrorDetails } from '../errors';
-import Event from '../events';
+import { Events } from '../events';
export function getAudioConfig (observer, data, offset, audioCodec) {
let adtsObjectType; // :int
@@ -26,7 +26,7 @@ export function getAudioConfig (observer, data, offset, audioCodec) {
adtsObjectType = ((data[offset + 2] & 0xC0) >>> 6) + 1;
const adtsSampleingIndex = ((data[offset + 2] & 0x3C) >>> 2);
if (adtsSampleingIndex > adtsSampleingRates.length - 1) {
- observer.trigger(Event.ERROR, { type: ErrorTypes.MEDIA_ERROR, details: ErrorDetails.FRAG_PARSING_ERROR, fatal: true, reason: `invalid ADTS sampling index:${adtsSampleingIndex}` });
+ observer.trigger(Events.ERROR, { type: ErrorTypes.MEDIA_ERROR, details: ErrorDetails.FRAG_PARSING_ERROR, fatal: true, reason: `invalid ADTS sampling index:${adtsSampleingIndex}` });
return;
}
adtsChanelConfig = ((data[offset + 2] & 0x01) << 2);
diff --git a/src/demux/transmuxer-interface.ts b/src/demux/transmuxer-interface.ts
index bfd2e6950f3..deba91c2608 100644
--- a/src/demux/transmuxer-interface.ts
+++ b/src/demux/transmuxer-interface.ts
@@ -1,19 +1,27 @@
import * as work from 'webworkify-webpack';
-import Event from '../events';
+import { Events } from '../events';
import Transmuxer, { TransmuxConfig, TransmuxState, isPromise } from '../demux/transmuxer';
import { logger } from '../utils/logger';
import { ErrorTypes, ErrorDetails } from '../errors';
import { getMediaSource } from '../utils/mediasource-helper';
-import { Observer } from '../observer';
+import { EventEmitter } from 'eventemitter3';
import Fragment from '../loader/fragment';
import { ChunkMetadata, TransmuxerResult } from '../types/transmuxer';
+import Hls from '../hls';
const MediaSource = getMediaSource() || { isTypeSupported: () => false };
+// TOOD: Refactor this out
+class Observer extends EventEmitter {
+ trigger (event: any, ...args: any[]) {
+ this.emit(event, args);
+ }
+}
+
export default class TransmuxerInterface {
- private hls: any;
+ private hls: Hls;
private id: any;
- private observer: any;
+ private observer: Observer | null;
private frag?: Fragment;
private worker: any;
private onwmsg?: Function;
@@ -23,13 +31,12 @@ export default class TransmuxerInterface {
private currentTransmuxSession: ChunkMetadata | null = null;
- constructor (hls, id, onTransmuxComplete, onFlush) {
+ constructor (hls: Hls, id, onTransmuxComplete, onFlush) {
this.hls = hls;
this.id = id;
this.onTransmuxComplete = onTransmuxComplete;
this.onFlush = onFlush;
- const observer = this.observer = new Observer();
const config = hls.config;
const forwardMessage = (ev, data) => {
@@ -40,8 +47,9 @@ export default class TransmuxerInterface {
};
// forward events to main thread
- observer.on(Event.FRAG_DECRYPTED, forwardMessage);
- observer.on(Event.ERROR, forwardMessage);
+ this.observer = new Observer();
+ this.observer.on(Events.FRAG_DECRYPTED, forwardMessage);
+ this.observer.on(Events.ERROR, forwardMessage);
const typeSupported = {
mp4: MediaSource.isTypeSupported('video/mp4'),
@@ -59,7 +67,7 @@ export default class TransmuxerInterface {
this.onwmsg = this.onWorkerMessage.bind(this);
worker.addEventListener('message', this.onwmsg);
worker.onerror = (event) => {
- hls.trigger(Event.ERROR, { type: ErrorTypes.OTHER_ERROR, details: ErrorDetails.INTERNAL_EXCEPTION, fatal: true, event: 'demuxerWorker', err: { message: event.message + ' (' + event.filename + ':' + event.lineno + ')' } });
+ hls.trigger(Events.ERROR, { type: ErrorTypes.OTHER_ERROR, details: ErrorDetails.INTERNAL_EXCEPTION, fatal: true, event: 'demuxerWorker', err: { message: event.message + ' (' + event.filename + ':' + event.lineno + ')' } });
};
worker.postMessage({ cmd: 'init', typeSupported: typeSupported, vendor: vendor, id: id, config: JSON.stringify(config) });
} catch (err) {
@@ -69,11 +77,11 @@ export default class TransmuxerInterface {
// revoke the Object URL that was used to create transmuxer worker, so as not to leak it
self.URL.revokeObjectURL(worker.objectURL);
}
- this.transmuxer = new Transmuxer(observer, typeSupported, config, vendor);
+ this.transmuxer = new Transmuxer(this.observer, typeSupported, config, vendor);
this.worker = null;
}
} else {
- this.transmuxer = new Transmuxer(observer, typeSupported, config, vendor);
+ this.transmuxer = new Transmuxer(this.observer, typeSupported, config, vendor);
}
}
diff --git a/src/demux/transmuxer-worker.ts b/src/demux/transmuxer-worker.ts
index 1f8a4c7d046..de5ec1f29ee 100644
--- a/src/demux/transmuxer-worker.ts
+++ b/src/demux/transmuxer-worker.ts
@@ -1,27 +1,19 @@
import Transmuxer, { isPromise } from '../demux/transmuxer';
-import Event from '../events';
+import { Events } from '../events';
import { enableLogs } from '../utils/logger';
import { EventEmitter } from 'eventemitter3';
import { RemuxedTrack, RemuxerResult } from '../types/remuxer';
import { TransmuxerResult, ChunkMetadata } from '../types/transmuxer';
export default function TransmuxerWorker (self) {
- const observer = new EventEmitter() as any;
- observer.trigger = (event, data) => {
- observer.emit(event, event, ...data);
- };
-
- observer.off = (event, ...data) => {
- observer.removeListener(event, ...data);
- };
-
+ const observer = new EventEmitter();
const forwardMessage = (ev, data) => {
self.postMessage({ event: ev, data: data });
};
// forward events to main thread
- observer.on(Event.FRAG_DECRYPTED, forwardMessage);
- observer.on(Event.ERROR, forwardMessage);
+ observer.on(Events.FRAG_DECRYPTED, forwardMessage);
+ observer.on(Events.ERROR, forwardMessage);
self.addEventListener('message', (ev) => {
const data = ev.data;
diff --git a/src/demux/transmuxer.ts b/src/demux/transmuxer.ts
index 967d164e743..9b6f725edbf 100644
--- a/src/demux/transmuxer.ts
+++ b/src/demux/transmuxer.ts
@@ -1,4 +1,4 @@
-import Event from '../events';
+import { Events, HlsEventEmitter } from '../events';
import { ErrorTypes, ErrorDetails } from '../errors';
import Decrypter from '../crypt/decrypter';
import AACDemuxer from '../demux/aacdemuxer';
@@ -37,7 +37,7 @@ muxConfig.forEach(({ demux }) => {
});
export default class Transmuxer {
- private observer: any;
+ private observer: HlsEventEmitter;
private typeSupported: any;
private config: any;
private vendor: any;
@@ -50,7 +50,7 @@ export default class Transmuxer {
private currentTransmuxState!: TransmuxState;
private cache: ChunkCache = new ChunkCache();
- constructor (observer, typeSupported, config, vendor) {
+ constructor (observer: HlsEventEmitter, typeSupported, config, vendor) {
this.observer = observer;
this.typeSupported = typeSupported;
this.config = config;
@@ -176,7 +176,7 @@ export default class Transmuxer {
if (!demuxer || !remuxer) {
// If probing failed, and each demuxer saw enough bytes to be able to probe, then Hls.js has been given content its not able to handle
if (bytesSeen >= minProbeByteLength) {
- observer.trigger(Event.ERROR, { type: ErrorTypes.MEDIA_ERROR, details: ErrorDetails.FRAG_PARSING_ERROR, fatal: true, reason: 'no demux matching with content found' });
+ observer.emit(Events.ERROR, Events.ERROR, { type: ErrorTypes.MEDIA_ERROR, details: ErrorDetails.FRAG_PARSING_ERROR, fatal: true, reason: 'no demux matching with content found' });
}
stats.executeEnd = now();
return [emptyResult(chunkMeta)];
diff --git a/src/demux/tsdemuxer.ts b/src/demux/tsdemuxer.ts
index 2938a229e5b..4d4faa7a834 100644
--- a/src/demux/tsdemuxer.ts
+++ b/src/demux/tsdemuxer.ts
@@ -11,7 +11,7 @@
import * as ADTS from './adts';
import * as MpegAudio from './mpegaudio';
-import Event from '../events';
+import { Events } from '../events';
import ExpGolomb from './exp-golomb';
import SampleAesDecrypter from './sample-aes';
import { logger } from '../utils/logger';
@@ -327,7 +327,7 @@ class TSDemuxer implements Demuxer {
break;
}
} else {
- this.observer.trigger(Event.ERROR, { type: ErrorTypes.MEDIA_ERROR, details: ErrorDetails.FRAG_PARSING_ERROR, fatal: false, reason: 'TS packet did not start with 0x47' });
+ this.observer.trigger(Events.ERROR, { type: ErrorTypes.MEDIA_ERROR, details: ErrorDetails.FRAG_PARSING_ERROR, fatal: false, reason: 'TS packet did not start with 0x47' });
}
}
@@ -388,7 +388,7 @@ class TSDemuxer implements Demuxer {
audioTrack.pesData = null;
} else {
- if (audioData && audioData.size) {
+ if (audioData?.size) {
logger.log('last AAC PES packet truncated,might overlap between fragments');
}
@@ -732,7 +732,7 @@ class TSDemuxer implements Demuxer {
const samples = this._avcTrack.samples;
avcSample = samples[samples.length - 1];
}
- if (avcSample && avcSample.units) {
+ if (avcSample?.units) {
const units = avcSample.units;
lastUnit = units[units.length - 1];
}
@@ -923,7 +923,7 @@ class TSDemuxer implements Demuxer {
fatal = true;
}
logger.warn(`parsing error:${reason}`);
- this.observer.trigger(Event.ERROR, { type: ErrorTypes.MEDIA_ERROR, details: ErrorDetails.FRAG_PARSING_ERROR, fatal: fatal, reason: reason });
+ this.observer.trigger(Events.ERROR, { type: ErrorTypes.MEDIA_ERROR, details: ErrorDetails.FRAG_PARSING_ERROR, fatal: fatal, reason: reason });
if (fatal) {
return;
}
@@ -1037,10 +1037,8 @@ function parsePMT (data, offset, mpegSupported, isSampleAes) {
logger.log('unknown stream type:' + data[offset]);
break;
}
- /* falls through */
-
- // ISO/IEC 13818-7 ADTS AAC (MPEG-2 lower bit-rate audio)
- case 0x0f:
+ /* falls through */
+ case 0x0f: // ISO/IEC 13818-7 ADTS AAC (MPEG-2 lower bit-rate audio)
// logger.log('AAC PID:' + pid);
if (result.audio === -1) {
result.audio = pid;
@@ -1063,9 +1061,7 @@ function parsePMT (data, offset, mpegSupported, isSampleAes) {
break;
}
/* falls through */
-
- // ITU-T Rec. H.264 and ISO/IEC 14496-10 (lower bit-rate video)
- case 0x1b:
+ case 0x1b: // ITU-T Rec. H.264 and ISO/IEC 14496-10 (lower bit-rate video)
// logger.log('AVC PID:' + pid);
if (result.avc === -1) {
result.avc = pid;
diff --git a/src/event-handler.ts b/src/event-handler.ts
deleted file mode 100644
index 7d0db41eff4..00000000000
--- a/src/event-handler.ts
+++ /dev/null
@@ -1,90 +0,0 @@
-/*
-*
-* All objects in the event handling chain should inherit from this class
-*
-*/
-
-import { logger } from './utils/logger';
-import { ErrorTypes, ErrorDetails } from './errors';
-import Event from './events';
-import Hls from './hls';
-
-const FORBIDDEN_EVENT_NAMES = {
- hlsEventGeneric: true,
- hlsHandlerDestroying: true,
- hlsHandlerDestroyed: true
-};
-
-class EventHandler {
- protected hls: Hls;
- private handledEvents: any[];
- private useGenericHandler: boolean;
-
- constructor (hls: Hls, ...events: any[]) {
- this.hls = hls;
- this.onEvent = this.onEvent.bind(this);
- this.handledEvents = events;
- this.useGenericHandler = true;
-
- this.registerListeners();
- }
-
- protected destroy () {
- this.onHandlerDestroying();
- this.unregisterListeners();
- this.onHandlerDestroyed();
- }
-
- protected onHandlerDestroying () {}
- protected onHandlerDestroyed () {}
-
- private isEventHandler () {
- return typeof this.handledEvents === 'object' && this.handledEvents.length && typeof this.onEvent === 'function';
- }
-
- private registerListeners () {
- if (this.isEventHandler()) {
- this.handledEvents.forEach(function (event) {
- if (FORBIDDEN_EVENT_NAMES[event]) {
- throw new Error('Forbidden event-name: ' + event);
- }
-
- this.hls.on(event, this.onEvent);
- }, this);
- }
- }
-
- private unregisterListeners () {
- if (this.isEventHandler()) {
- this.handledEvents.forEach(function (event) {
- this.hls.off(event, this.onEvent);
- }, this);
- }
- }
-
- /**
- * arguments: event (string), data (any)
- */
- private onEvent (event: string, data: any) {
- this.onEventGeneric(event, data);
- }
-
- private onEventGeneric (event: string, data: any) {
- const eventToFunction = function (event: string, data: any) {
- const funcName = 'on' + event.replace('hls', '');
- if (typeof this[funcName] !== 'function') {
- throw new Error(`Event ${event} has no generic handler in this ${this.constructor.name} class (tried ${funcName})`);
- }
-
- return this[funcName].bind(this, data);
- };
- try {
- eventToFunction.call(this, event, data).call();
- } catch (err) {
- logger.error(`An internal error happened while handling event ${event}. Error message: "${err.message}". Here is a stacktrace:`, err);
- this.hls.trigger(Event.ERROR, { type: ErrorTypes.OTHER_ERROR, details: ErrorDetails.INTERNAL_EXCEPTION, fatal: false, event: event, err: err });
- }
- }
-}
-
-export default EventHandler;
diff --git a/src/events.ts b/src/events.ts
index 4c40063a438..5899d73a341 100644
--- a/src/events.ts
+++ b/src/events.ts
@@ -1,118 +1,188 @@
+import { ManifestLoadedData, ManifestLoadingData, MediaAttachedData, MediaAttachingData, LevelLoadingData, LevelLoadedData, ManifestParsedData, LevelUpdatedData, LevelsUpdatedData, FragParsingUserdataData, FragDecryptedData, FragLoadedData, InitPTSFoundData, CuesParsedData, SubtitleFragProcessedData, NonNativeTextTracksData, FragLoadingData, AudioTrackLoadingData, AudioTrackLoadedData, SubtitleTrackLoadedData, SubtitleTrackLoadingData, ErrorData, AudioTrackSwitchingData, AudioTrackSwitchedData, KeyLoadedData, KeyLoadingData, SubtitleTrackSwitchData, SubtitleTracksUpdatedData, LevelSwitchedData, FragChangedData, BufferAppendingData, BufferCodecsData, FragParsingMetadataData, FragParsingInitSegmentData, FragBufferedData, BufferFlushingData, BufferEOSData, LevelSwitchingData, FPSDropLevelCappingData, FPSDropData, BufferCreatedData, BufferAppendedData, LevelPTSUpdatedData, FragParsedData, AudioTracksUpdatedData, FragLoadEmergencyAbortedData, LiveBackBufferData } from './types/events';
+import { Tail } from './types/tuples';
+
/**
* @readonly
* @enum {string}
*/
-enum HlsEvents {
- // fired before MediaSource is attaching to media element - data = { media }
+export enum Events {
+ // Fired before MediaSource is attaching to media element
MEDIA_ATTACHING = 'hlsMediaAttaching',
- // fired when MediaSource has been succesfully attached to media element - data = { }
+ // Fired when MediaSource has been successfully attached to media element
MEDIA_ATTACHED = 'hlsMediaAttached',
- // fired before detaching MediaSource from media element - data = { }
+ // Fired before deatching MediaSource from media element
MEDIA_DETACHING = 'hlsMediaDetaching',
- // fired when MediaSource has been detached from media element - data = { }
+ // Fired when MediaSource has been detached from media element
MEDIA_DETACHED = 'hlsMediaDetached',
- // fired when we buffer is going to be reset - data = { }
+ // Fired when the buffer is going to be reset
BUFFER_RESET = 'hlsBufferReset',
- // fired when we know about the codecs that we need buffers for to push into - data = {tracks = { container, codec, levelCodec, initSegment, metadata }}
+ // Fired when we know about the codecs that we need buffers for to push into - data: {tracks : { container, codec, levelCodec, initSegment, metadata }}
BUFFER_CODECS = 'hlsBufferCodecs',
- // fired when sourcebuffers have been created - data = { tracks = tracks }
+ // fired when sourcebuffers have been created - data: { tracks : tracks }
BUFFER_CREATED = 'hlsBufferCreated',
- // fired when we append a segment to the buffer - data = { segment = segment object }
+ // fired when we append a segment to the buffer - data: { segment: segment object }
BUFFER_APPENDING = 'hlsBufferAppending',
- // fired when we are done with appending a media segment to the buffer - data = { parent = segment parent that triggered BUFFER_APPENDING, pending = nb of segments waiting for appending for this segment parent}
+ // fired when we are done with appending a media segment to the buffer - data : { parent : segment parent that triggered BUFFER_APPENDING, pending : nb of segments waiting for appending for this segment parent}
BUFFER_APPENDED = 'hlsBufferAppended',
- // fired when the stream is finished and we want to notify the media buffer that there will be no more data - data = { }
+ // fired when the stream is finished and we want to notify the media buffer that there will be no more data - data: { }
BUFFER_EOS = 'hlsBufferEos',
// fired when the media buffer should be flushed - data { startOffset, endOffset }
BUFFER_FLUSHING = 'hlsBufferFlushing',
- // fired when the media buffer has been flushed - data = { }
+ // fired when the media buffer has been flushed - data: { }
BUFFER_FLUSHED = 'hlsBufferFlushed',
- // fired to signal that a manifest loading starts - data = { url = manifestURL}
+ // fired to signal that a manifest loading starts - data: { url : manifestURL}
MANIFEST_LOADING = 'hlsManifestLoading',
- // fired after manifest has been loaded - data = { levels = [available quality levels], audioTracks = [ available audio tracks], url = manifestURL, stats = { trequest, tfirst, tload, mtime}}
+ // fired after manifest has been loaded - data: { levels : [available quality levels], audioTracks : [ available audio tracks], url : manifestURL, stats : { trequest, tfirst, tload, mtime}}
MANIFEST_LOADED = 'hlsManifestLoaded',
- // fired after manifest has been parsed - data = { levels = [available quality levels], firstLevel = index of first quality level appearing in Manifest}
+ // fired after manifest has been parsed - data: { levels : [available quality levels], firstLevel : index of first quality level appearing in Manifest}
MANIFEST_PARSED = 'hlsManifestParsed',
- // fired when a level switch is requested - data = { level = id of new level }
+ // fired when a level switch is requested - data: { level : id of new level }
LEVEL_SWITCHING = 'hlsLevelSwitching',
- // fired when a level switch is effective - data = { level = id of new level }
+ // fired when a level switch is effective - data: { level : id of new level }
LEVEL_SWITCHED = 'hlsLevelSwitched',
- // fired when a level playlist loading starts - data = { url = level URL, level = id of level being loaded}
+ // fired when a level playlist loading starts - data: { url : level URL, level : id of level being loaded}
LEVEL_LOADING = 'hlsLevelLoading',
- // fired when a level playlist loading finishes - data = { details = levelDetails object, level = id of loaded level, stats = { trequest, tfirst, tload, mtime} }
+ // fired when a level playlist loading finishes - data: { details : levelDetails object, level : id of loaded level, stats : { trequest, tfirst, tload, mtime} }
LEVEL_LOADED = 'hlsLevelLoaded',
- // fired when a level's details have been updated based on previous details, after it has been loaded - data = { details = levelDetails object, level = id of updated level }
+ // fired when a level's details have been updated based on previous details, after it has been loaded - data: { details : levelDetails object, level : id of updated level }
LEVEL_UPDATED = 'hlsLevelUpdated',
- // fired when a level's PTS information has been updated after parsing a fragment - data = { details = levelDetails object, level = id of updated level, drift = PTS drift observed when parsing last fragment }
+ // fired when a level's PTS information has been updated after parsing a fragment - data: { details : levelDetails object, level : id of updated level, drift: PTS drift observed when parsing last fragment }
LEVEL_PTS_UPDATED = 'hlsLevelPtsUpdated',
- // fired to notify that audio track lists has been updated - data = { audioTracks = audioTracks }
+ // fired to notify that audio track lists has been updated - data: { audioTracks : audioTracks }
LEVELS_UPDATED = 'hlsLevelsUpdated',
- // fired to notify that levels have changed outside of a manifest parsing event - data = { levels }
+ // fired to notify that audio track lists has been updated - data: { audioTracks : audioTracks }
AUDIO_TRACKS_UPDATED = 'hlsAudioTracksUpdated',
- // fired when an audio track switching is requested - data = { id = audio track id }
+ // fired when an audio track switching is requested - data: { id : audio track id }
AUDIO_TRACK_SWITCHING = 'hlsAudioTrackSwitching',
- // fired when an audio track switch actually occurs - data = { id = audio track id }
+ // fired when an audio track switch actually occurs - data: { id : audio track id }
AUDIO_TRACK_SWITCHED = 'hlsAudioTrackSwitched',
- // fired when an audio track loading starts - data = { url = audio track URL, id = audio track id }
+ // fired when an audio track loading starts - data: { url : audio track URL, id : audio track id }
AUDIO_TRACK_LOADING = 'hlsAudioTrackLoading',
- // fired when an audio track loading finishes - data = { details = levelDetails object, id = audio track id, stats = { trequest, tfirst, tload, mtime } }
+ // fired when an audio track loading finishes - data: { details : levelDetails object, id : audio track id, stats : { trequest, tfirst, tload, mtime } }
AUDIO_TRACK_LOADED = 'hlsAudioTrackLoaded',
- // fired to notify that subtitle track lists has been updated - data = { subtitleTracks = subtitleTracks }
+ // fired to notify that subtitle track lists has been updated - data: { subtitleTracks : subtitleTracks }
SUBTITLE_TRACKS_UPDATED = 'hlsSubtitleTracksUpdated',
// fired to notify that subtitle tracks were cleared as a result of stopping the media
SUBTITLE_TRACKS_CLEARED = 'hlsSubtitleTracksCleared',
- // fired when an subtitle track switch occurs - data = { id = subtitle track id }
+ // fired when an subtitle track switch occurs - data: { id : subtitle track id }
SUBTITLE_TRACK_SWITCH = 'hlsSubtitleTrackSwitch',
- // fired when a subtitle track loading starts - data = { url = subtitle track URL, id = subtitle track id }
+ // fired when a subtitle track loading starts - data: { url : subtitle track URL, id : subtitle track id }
SUBTITLE_TRACK_LOADING = 'hlsSubtitleTrackLoading',
- // fired when a subtitle track loading finishes - data = { details = levelDetails object, id = subtitle track id, stats = { trequest, tfirst, tload, mtime } }
+ // fired when a subtitle track loading finishes - data: { details : levelDetails object, id : subtitle track id, stats : { trequest, tfirst, tload, mtime } }
SUBTITLE_TRACK_LOADED = 'hlsSubtitleTrackLoaded',
- // fired when a subtitle fragment has been processed - data = { success = boolean, frag = the processed frag }
+ // fired when a subtitle fragment has been processed - data: { success : boolean, frag : the processed frag }
SUBTITLE_FRAG_PROCESSED = 'hlsSubtitleFragProcessed',
- // fired when a set of VTTCues to be managed externally has been parsed - data = { type = string, track = string, cues = [ VTTCue ] }
+ // fired when a set of VTTCues to be managed externally has been parsed - data: { type: string, track: string, cues: [ VTTCue ] }
CUES_PARSED = 'hlsCuesParsed',
- // fired when a text track to be managed externally is found - data = { tracks = [ { label = string, kind = string, default = boolean } ] }
+ // fired when a text track to be managed externally is found - data: { tracks: [ { label: string, kind: string, default: boolean } ] }
NON_NATIVE_TEXT_TRACKS_FOUND = 'hlsNonNativeTextTracksFound',
- // fired when the first timestamp is found - data = { id = demuxer id, initPTS = initPTS, frag = fragment object }
+ // fired when the first timestamp is found - data: { id : demuxer id, initPTS: initPTS, frag : fragment object }
INIT_PTS_FOUND = 'hlsInitPtsFound',
- // fired when a fragment loading starts - data = { frag = fragment object }
+ // fired when a fragment loading starts - data: { frag : fragment object }
FRAG_LOADING = 'hlsFragLoading',
- // fired when a fragment loading is progressing - data = { frag = fragment object, { trequest, tfirst, loaded } }
- FRAG_LOAD_PROGRESS = 'hlsFragLoadProgress',
- // Identifier for fragment load aborting for emergency switch down - data = { frag = fragment object }
+ // fired when a fragment loading is progressing - data: { frag : fragment object, { trequest, tfirst, loaded } }
+ // FRAG_LOAD_PROGRESS = 'hlsFragLoadProgress',
+ // Identifier for fragment load aborting for emergency switch down - data: { frag : fragment object }
FRAG_LOAD_EMERGENCY_ABORTED = 'hlsFragLoadEmergencyAborted',
- // fired when a fragment loading is completed - data = { frag = fragment object, payload = fragment payload, stats = { trequest, tfirst, tload, length } }
+ // fired when a fragment loading is completed - data: { frag : fragment object, payload : fragment payload, stats : { trequest, tfirst, tload, length } }
FRAG_LOADED = 'hlsFragLoaded',
- // fired when a fragment has finished decrypting - data = { id = demuxer id, frag = fragment object, payload = fragment payload, stats = { tstart, tdecrypt } }
+ // fired when a fragment has finished decrypting - data: { id : demuxer id, frag: fragment object, payload : fragment payload, stats : { tstart, tdecrypt } }
FRAG_DECRYPTED = 'hlsFragDecrypted',
- // fired when Init Segment has been extracted from fragment - data = { id = demuxer id, frag = fragment object, moov = moov MP4 box, codecs = codecs found while parsing fragment }
+ // fired when Init Segment has been extracted from fragment - data: { id : demuxer id, frag: fragment object, moov : moov MP4 box, codecs : codecs found while parsing fragment }
FRAG_PARSING_INIT_SEGMENT = 'hlsFragParsingInitSegment',
- // fired when parsing sei text is completed - data = { id = demuxer id, frag = fragment object, samples = [ sei samples pes ] }
+ // fired when parsing sei text is completed - data: { id : demuxer id, frag: fragment object, samples : [ sei samples pes ] }
FRAG_PARSING_USERDATA = 'hlsFragParsingUserdata',
- // fired when parsing id3 is completed - data = { id = demuxer id, frag = fragment object, samples = [ id3 samples pes ] }
+ // fired when parsing id3 is completed - data: { id : demuxer id, frag: fragment object, samples : [ id3 samples pes ] }
FRAG_PARSING_METADATA = 'hlsFragParsingMetadata',
- // fired when data have been extracted from fragment - data = { id = demuxer id, frag = fragment object, data1 = moof MP4 box or TS fragments, data2 = mdat MP4 box or null}
- FRAG_PARSING_DATA = 'hlsFragParsingData',
- // fired when fragment parsing is completed - data = { id = demuxer id, frag = fragment object }
+ // fired when data have been extracted from fragment - data: { id : demuxer id, frag: fragment object, data1 : moof MP4 box or TS fragments, data2 : mdat MP4 box or null}
+ // FRAG_PARSING_DATA = 'hlsFragParsingData',
+ // fired when fragment parsing is completed - data: { id : demuxer id, frag: fragment object }
FRAG_PARSED = 'hlsFragParsed',
- // fired when fragment remuxed MP4 boxes have all been appended into SourceBuffer - data = { id = demuxer id, frag = fragment object, stats = { trequest, tfirst, tload, tparsed, tbuffered, length, bwEstimate } }
+ // fired when fragment remuxed MP4 boxes have all been appended into SourceBuffer - data: { id : demuxer id, frag : fragment object, stats : { trequest, tfirst, tload, tparsed, tbuffered, length, bwEstimate } }
FRAG_BUFFERED = 'hlsFragBuffered',
- // fired when fragment matching with current media position is changing - data = { id = demuxer id, frag = fragment object }
+ // fired when fragment matching with current media position is changing - data : { id : demuxer id, frag : fragment object }
FRAG_CHANGED = 'hlsFragChanged',
- // Identifier for a FPS drop event - data = { curentDropped, currentDecoded, totalDroppedFrames }
+ // Identifier for a FPS drop event - data: { curentDropped, currentDecoded, totalDroppedFrames }
FPS_DROP = 'hlsFpsDrop',
- // triggered when FPS drop triggers auto level capping - data = { level, droppedlevel }
+ // triggered when FPS drop triggers auto level capping - data: { level, droppedlevel }
FPS_DROP_LEVEL_CAPPING = 'hlsFpsDropLevelCapping',
- // Identifier for an error event - data = { type = error type, details = error details, fatal = if true, hls.js cannot/will not try to recover, if false, hls.js will try to recover,other error specific data }
+ // Identifier for an error event - data: { type : error type, details : error details, fatal : if true, hls.js cannot/will not try to recover, if false, hls.js will try to recover,other error specific data }
ERROR = 'hlsError',
- // fired when hls.js instance starts destroying. Different from MEDIA_DETACHED as one could want to detach and reattach a media to the instance of hls.js to handle mid-rolls for example - data = { }
+ // fired when hls.js instance starts destroying. Different from MEDIA_DETACHED as one could want to detach and reattach a media to the instance of hls.js to handle mid-rolls for example - data: { }
DESTROYING = 'hlsDestroying',
- // fired when a decrypt key loading starts - data = { frag = fragment object }
+ // fired when a decrypt key loading starts - data: { frag : fragment object }
KEY_LOADING = 'hlsKeyLoading',
- // fired when a decrypt key loading is completed - data = { frag = fragment object, payload = key payload, stats = { trequest, tfirst, tload, length } }
+ // fired when a decrypt key loading is completed - data: { frag : fragment object, payload : key payload, stats : { trequest, tfirst, tload, length } }
KEY_LOADED = 'hlsKeyLoaded',
// fired when the live back buffer is reached defined by the liveBackBufferLength config option - data : { bufferEnd: number }
- LIVE_BACK_BUFFER_REACHED = 'hlsLiveBackBufferReached'
+ LIVE_BACK_BUFFER_REACHED = 'hlsLiveBackBufferReached',
+}
+
+export interface HlsListeners {
+ [Events.MEDIA_ATTACHING]: (event: Events.MEDIA_ATTACHING, data: MediaAttachingData) => void
+ [Events.MEDIA_ATTACHED]: (event: Events.MEDIA_ATTACHED, data: MediaAttachedData) => void
+ [Events.MEDIA_DETACHING]: (event: Events.MEDIA_DETACHING) => void
+ [Events.MEDIA_DETACHED]: (event: Events.MEDIA_DETACHED) => void
+ [Events.BUFFER_RESET]: (event: Events.BUFFER_RESET) => void
+ [Events.BUFFER_CODECS]: (event: Events.BUFFER_CODECS, data: BufferCodecsData) => void
+ [Events.BUFFER_CREATED]: (event: Events.BUFFER_CREATED, data: BufferCreatedData) => void
+ [Events.BUFFER_APPENDING]: (event: Events.BUFFER_APPENDING, data: BufferAppendingData) => void
+ [Events.BUFFER_APPENDED]: (event: Events.BUFFER_APPENDED, data: BufferAppendedData) => void
+ [Events.BUFFER_EOS]: (event: Events.BUFFER_EOS, data: BufferEOSData) => void
+ [Events.BUFFER_FLUSHING]: (event: Events.BUFFER_FLUSHING, data: BufferFlushingData) => void
+ [Events.BUFFER_FLUSHED]: (event: Events.BUFFER_FLUSHED) => void
+ [Events.MANIFEST_LOADING]: (event: Events.MANIFEST_LOADING, data: ManifestLoadingData) => void
+ [Events.MANIFEST_LOADED]: (event: Events.MANIFEST_LOADED, data: ManifestLoadedData) => void
+ [Events.MANIFEST_PARSED]: (event: Events.MANIFEST_PARSED, data: ManifestParsedData) => void
+ [Events.LEVEL_SWITCHING]: (event: Events.LEVEL_SWITCHING, data: LevelSwitchingData) => void
+ [Events.LEVEL_SWITCHED]: (event: Events.LEVEL_SWITCHED, data: LevelSwitchedData) => void
+ [Events.LEVEL_LOADING]: (event: Events.LEVEL_LOADING, data: LevelLoadingData) => void
+ [Events.LEVEL_LOADED]: (event: Events.LEVEL_LOADED, data: LevelLoadedData) => void
+ [Events.LEVEL_UPDATED]: (event: Events.LEVEL_UPDATED, data: LevelUpdatedData) => void
+ [Events.LEVEL_PTS_UPDATED]: (event: Events.LEVEL_PTS_UPDATED, data: LevelPTSUpdatedData) => void
+ [Events.LEVELS_UPDATED]: (event: Events.LEVELS_UPDATED, data: LevelsUpdatedData) => void
+ [Events.AUDIO_TRACKS_UPDATED]: (event: Events.AUDIO_TRACKS_UPDATED, data: AudioTracksUpdatedData) => void
+ [Events.AUDIO_TRACK_SWITCHING]: (event: Events.AUDIO_TRACK_SWITCHING, data: AudioTrackSwitchingData) => void
+ [Events.AUDIO_TRACK_SWITCHED]: (event: Events.AUDIO_TRACK_SWITCHED, data: AudioTrackSwitchedData) => void
+ [Events.AUDIO_TRACK_LOADING]: (event: Events.AUDIO_TRACK_LOADING, data: AudioTrackLoadingData) => void
+ [Events.AUDIO_TRACK_LOADED]: (event: Events.AUDIO_TRACK_LOADED, data: AudioTrackLoadedData) => void
+ [Events.SUBTITLE_TRACKS_UPDATED]: (event: Events.SUBTITLE_TRACKS_UPDATED, data: SubtitleTracksUpdatedData) => void
+ [Events.SUBTITLE_TRACKS_CLEARED]: (event: Events.SUBTITLE_TRACKS_CLEARED) => void
+ [Events.SUBTITLE_TRACK_SWITCH]: (event: Events.SUBTITLE_TRACK_SWITCH, data: SubtitleTrackSwitchData) => void
+ [Events.SUBTITLE_TRACK_LOADING]: (event: Events.SUBTITLE_TRACK_LOADING, data: SubtitleTrackLoadingData) => void
+ [Events.SUBTITLE_TRACK_LOADED]: (event: Events.SUBTITLE_TRACK_LOADED, data: SubtitleTrackLoadedData) => void
+ [Events.SUBTITLE_FRAG_PROCESSED]: (event: Events.SUBTITLE_FRAG_PROCESSED, data: SubtitleFragProcessedData) => void
+ [Events.CUES_PARSED]: (event: Events.CUES_PARSED, data: CuesParsedData) => void
+ [Events.NON_NATIVE_TEXT_TRACKS_FOUND]: (event: Events.NON_NATIVE_TEXT_TRACKS_FOUND, data: NonNativeTextTracksData) => void
+ [Events.INIT_PTS_FOUND]: (event: Events.INIT_PTS_FOUND, data: InitPTSFoundData) => void
+ [Events.FRAG_LOADING]: (event: Events.FRAG_LOADING, data: FragLoadingData) => void
+ // [Events.FRAG_LOAD_PROGRESS]: TodoEventType
+ [Events.FRAG_LOAD_EMERGENCY_ABORTED]: (event: Events.FRAG_LOAD_EMERGENCY_ABORTED, data: FragLoadEmergencyAbortedData) => void
+ [Events.FRAG_LOADED]: (event: Events.FRAG_LOADED, data: FragLoadedData) => void
+ [Events.FRAG_DECRYPTED]: (event: Events.FRAG_DECRYPTED, data: FragDecryptedData) => void
+ [Events.FRAG_PARSING_INIT_SEGMENT]: (event: Events.FRAG_PARSING_INIT_SEGMENT, data: FragParsingInitSegmentData) => void
+ [Events.FRAG_PARSING_USERDATA]: (event: Events.FRAG_PARSING_USERDATA, data: FragParsingUserdataData) => void
+ [Events.FRAG_PARSING_METADATA]: (event: Events.FRAG_PARSING_METADATA, data: FragParsingMetadataData) => void
+ // [Events.FRAG_PARSING_DATA]: TodoEventType
+ [Events.FRAG_PARSED]: (event: Events.FRAG_PARSED, data: FragParsedData) => void
+ [Events.FRAG_BUFFERED]: (event: Events.FRAG_BUFFERED, data: FragBufferedData) => void
+ [Events.FRAG_CHANGED]: (event: Events.FRAG_CHANGED, data: FragChangedData) => void
+ [Events.FPS_DROP]: (event: Events.FPS_DROP, data: FPSDropData) => void
+ [Events.FPS_DROP_LEVEL_CAPPING]: (event: Events.FPS_DROP_LEVEL_CAPPING, data: FPSDropLevelCappingData) => void
+ [Events.ERROR]: (event: Events.ERROR, data: ErrorData) => void
+ [Events.DESTROYING]: (event: Events.DESTROYING) => void
+ [Events.KEY_LOADING]: (event: Events.KEY_LOADING, data: KeyLoadingData) => void
+ [Events.KEY_LOADED]: (event: Events.KEY_LOADED, data: KeyLoadedData) => void
+ [Events.LIVE_BACK_BUFFER_REACHED]: (event: Events.LIVE_BACK_BUFFER_REACHED, data: LiveBackBufferData) => void
}
+export interface HlsEventEmitter {
+ on (event: E, listener: HlsListeners[E], context?: Context): void
+ once (event: E, listener: HlsListeners[E], context?: Context): void
-export default HlsEvents;
+ removeAllListeners (event?: E): void
+ off (event: E, listener?: HlsListeners[E], context?: Context, once?: boolean): void
+
+ listeners (event: E): HlsListeners[E][]
+ emit (event: E, name: E, ...args: Tail>): boolean
+ listenerCount (event: E): number
+}
diff --git a/src/hls.ts b/src/hls.ts
index ca83a1a9730..f0bc0a35e82 100644
--- a/src/hls.ts
+++ b/src/hls.ts
@@ -16,31 +16,40 @@ import { isSupported } from './is-supported';
import { logger, enableLogs } from './utils/logger';
import { HlsConfig, hlsDefaultConfig, mergeConfig, setStreamingMode } from './config';
-import HlsEvents from './events';
-
-import { Observer } from './observer';
+import { Events, HlsEventEmitter, HlsListeners } from './events';
+import { EventEmitter } from 'eventemitter3';
import { Level } from './types/level';
import { MediaPlaylist } from './types/media-playlist';
+import AudioTrackController from './controller/audio-track-controller';
+import SubtitleTrackController from './controller/subtitle-track-controller';
+import EMEController from './controller/eme-controller';
+import CapLevelController from './controller/cap-level-controller';
+import AbrController from './controller/abr-controller';
+import { ComponentAPI, NetworkComponentAPI } from './types/component-api';
+import { Tail } from './types/tuples';
/**
* @module Hls
* @class
* @constructor
*/
-export default class Hls extends Observer {
+export default class Hls {
public static defaultConfig?: HlsConfig;
public config: HlsConfig;
+ private coreComponents: ComponentAPI[];
+ private networkControllers: NetworkComponentAPI[];
+
+ private _emitter: HlsEventEmitter = new EventEmitter();
private _autoLevelCapping: number;
- private abrController: any;
- private capLevelController: any;
- private levelController: any;
- private streamController: any;
- private networkControllers: any[];
- private audioTrackController: any;
- private subtitleTrackController: any;
- private emeController: any;
- private coreComponents: any[];
+ private abrController: AbrController;
+ private capLevelController: CapLevelController;
+ private levelController: LevelController;
+ private streamController: StreamController;
+ private audioTrackController: AudioTrackController;
+ private subtitleTrackController: SubtitleTrackController;
+ private emeController: EMEController;
+
private _media: HTMLMediaElement | null = null;
private url: string | null = null;
@@ -53,7 +62,7 @@ export default class Hls extends Observer {
}
static get Events () {
- return HlsEvents;
+ return Events;
}
static get ErrorTypes () {
@@ -86,8 +95,6 @@ export default class Hls extends Observer {
* @param {HlsConfig} config
*/
constructor (userConfig: Partial = {}) {
- super();
-
const defaultConfig = Hls.DefaultConfig;
mergeConfig(defaultConfig, userConfig);
const config = this.config = userConfig as HlsConfig;
@@ -120,6 +127,8 @@ export default class Hls extends Observer {
// Cap level controller uses streamController to flush the buffer
capLevelController.setStreamController(streamController);
+ // fpsController uses streamController to switch when frames are being dropped
+ fpsController.setStreamController(streamController);
const networkControllers = [
levelController,
@@ -159,12 +168,75 @@ export default class Hls extends Observer {
return null;
}
+ // Delegate the EventEmitter through the public API of Hls.js
+ on (event: E, listener: HlsListeners[E], context: Context | this = this) {
+ this._emitter.on(event, (...args: unknown[]) => {
+ if (this.config.debug) {
+ listener.apply(context, args);
+ } else {
+ try {
+ listener.apply(context, args);
+ } catch (e) {
+ logger.error('An internal error happened while handling event ' + event + '. Error message: "' + e.message + '". Here is a stacktrace:', e);
+ this.trigger(Events.ERROR, {
+ type: ErrorTypes.OTHER_ERROR,
+ details: ErrorDetails.INTERNAL_EXCEPTION,
+ fatal: false,
+ event: event,
+ error: e
+ });
+ }
+ }
+ }, context);
+ }
+
+ once (event: E, listener: HlsListeners[E], context: Context | this = this) {
+ this._emitter.once(event, (...args: unknown[]) => {
+ if (this.config.debug) {
+ listener.apply(context, args);
+ } else {
+ try {
+ listener.apply(context, args);
+ } catch (e) {
+ logger.error('An internal error happened while handling event ' + event + '. Error message: "' + e.message + '". Here is a stacktrace:', e);
+ this.trigger(Events.ERROR, {
+ type: ErrorTypes.OTHER_ERROR,
+ details: ErrorDetails.INTERNAL_EXCEPTION,
+ fatal: false,
+ event: event,
+ error: e
+ });
+ }
+ }
+ }, context);
+ }
+
+ removeAllListeners (event?: E | undefined) {
+ this._emitter.removeAllListeners(event);
+ }
+
+ off (event: E, listener?: HlsListeners[E] | undefined, context?: Context, once?: boolean | undefined) {
+ this._emitter.off(event, listener, context, once);
+ }
+
+ listeners (event: E): HlsListeners[E][] {
+ return this._emitter.listeners(event);
+ }
+
+ trigger (event: E, ...args: Tail>): boolean {
+ return this._emitter.emit(event, event, ...args);
+ }
+
+ listenerCount (event: E): number {
+ return this._emitter.listenerCount(event);
+ }
+
/**
* Dispose of the instance
*/
destroy () {
logger.log('destroy');
- this.trigger(HlsEvents.DESTROYING);
+ this.trigger(Events.DESTROYING);
this.detachMedia();
this.coreComponents.concat(this.networkControllers).forEach(component => {
component.destroy();
@@ -181,7 +253,7 @@ export default class Hls extends Observer {
attachMedia (media: HTMLMediaElement) {
logger.log('attachMedia');
this._media = media;
- this.trigger(HlsEvents.MEDIA_ATTACHING, { media: media });
+ this.trigger(Events.MEDIA_ATTACHING, { media: media });
}
/**
@@ -189,7 +261,7 @@ export default class Hls extends Observer {
*/
detachMedia () {
logger.log('detachMedia');
- this.trigger(HlsEvents.MEDIA_DETACHING);
+ this.trigger(Events.MEDIA_DETACHING);
this._media = null;
}
@@ -202,7 +274,7 @@ export default class Hls extends Observer {
logger.log(`loadSource:${url}`);
this.url = url;
// when attaching to a source URL, trigger a playlist load
- this.trigger(HlsEvents.MANIFEST_LOADING, { url: url });
+ this.trigger(Events.MANIFEST_LOADING, { url: url });
}
/**
@@ -260,7 +332,7 @@ export default class Hls extends Observer {
* @type {Level[]}
*/
get levels (): Array {
- return this.levelController.levels;
+ return this.levelController.levels ? this.levelController.levels : [];
}
/**
@@ -419,7 +491,7 @@ export default class Hls extends Observer {
* @type {number}
*/
get bandwidthEstimate (): number {
- return this.abrController._bwEstimator.getEstimate();
+ return this.abrController.bwEstimator.getEstimate();
}
/**
@@ -455,8 +527,9 @@ export default class Hls extends Observer {
*/
get minAutoLevel (): number {
const { levels, config: { minAutoBitrate } } = this;
- const len = levels ? levels.length : 0;
+ if (!levels) return 0;
+ const len = levels.length;
for (let i = 0; i < len; i++) {
if (levels[i].maxBitrate > minAutoBitrate) {
return i;
@@ -535,7 +608,7 @@ export default class Hls extends Observer {
/**
* @type {Seconds}
*/
- get liveSyncPosition (): number {
+ get liveSyncPosition (): number | null {
return this.streamController.liveSyncPosition;
}
diff --git a/src/loader/fragment.ts b/src/loader/fragment.ts
index e062e685ebc..b975bf047da 100644
--- a/src/loader/fragment.ts
+++ b/src/loader/fragment.ts
@@ -206,7 +206,7 @@ export default class Fragment {
setDecryptDataFromLevelKey (levelkey: LevelKey, segmentNumber: number): LevelKey {
let decryptdata = levelkey;
- if (levelkey && levelkey.method && levelkey.uri && !levelkey.iv) {
+ if (levelkey?.method && levelkey.uri && !levelkey.iv) {
decryptdata = new LevelKey(levelkey.baseuri, levelkey.reluri);
decryptdata.method = levelkey.method;
decryptdata.iv = this.createInitializationVector(segmentNumber);
diff --git a/src/loader/key-loader.ts b/src/loader/key-loader.ts
index 963185bac8a..74dfadeb9be 100644
--- a/src/loader/key-loader.ts
+++ b/src/loader/key-loader.ts
@@ -1,33 +1,41 @@
/*
* Decrypt key Loader
*/
-
-import Event from '../events';
-import EventHandler from '../event-handler';
+import { Events } from '../events';
import { ErrorTypes, ErrorDetails } from '../errors';
import { logger } from '../utils/logger';
import Hls from '../hls';
import Fragment from './fragment';
import { LoaderStats, LoaderResponse, LoaderContext, LoaderConfiguration, LoaderCallbacks } from '../types/loader';
-
-interface OnKeyLoadingPayload {
- frag: Fragment
-}
+import { ComponentAPI } from '../types/component-api';
+import { KeyLoadingData } from '../types/events';
interface KeyLoaderContext extends LoaderContext {
frag: Fragment
}
-export default class KeyLoader extends EventHandler {
+export default class KeyLoader implements ComponentAPI {
+ private hls: Hls;
public loaders = {};
public decryptkey: Uint8Array | null = null;
public decrypturl: string | null = null;
constructor (hls: Hls) {
- super(hls, Event.KEY_LOADING);
+ this.hls = hls;
+
+ this._registerListeners();
+ }
+
+ private _registerListeners () {
+ this.hls.on(Events.KEY_LOADING, this.onKeyLoading, this);
+ }
+
+ private _unregisterListeners () {
+ this.hls.off(Events.KEY_LOADING, this.onKeyLoading);
}
destroy (): void {
+ this._unregisterListeners();
for (const loaderName in this.loaders) {
const loader = this.loaders[loaderName];
if (loader) {
@@ -35,11 +43,9 @@ export default class KeyLoader extends EventHandler {
}
}
this.loaders = {};
-
- super.destroy();
}
- onKeyLoading (data: OnKeyLoadingPayload) {
+ onKeyLoading (event: Events.KEY_LOADING, data: KeyLoadingData) {
const { frag } = data;
const type = frag.type;
const loader = this.loaders[type];
@@ -92,7 +98,7 @@ export default class KeyLoader extends EventHandler {
} else if (this.decryptkey) {
// Return the key if it's already been loaded
frag.decryptdata.key = this.decryptkey;
- this.hls.trigger(Event.KEY_LOADED, { frag: frag });
+ this.hls.trigger(Events.KEY_LOADED, { frag: frag });
}
}
@@ -107,7 +113,7 @@ export default class KeyLoader extends EventHandler {
// detach fragment loader on load success
frag.loader = undefined;
delete this.loaders[frag.type];
- this.hls.trigger(Event.KEY_LOADED, { frag: frag });
+ this.hls.trigger(Events.KEY_LOADED, { frag: frag });
}
loaderror (response: LoaderResponse, context: KeyLoaderContext) {
@@ -118,7 +124,7 @@ export default class KeyLoader extends EventHandler {
}
delete this.loaders[frag.type];
- this.hls.trigger(Event.ERROR, { type: ErrorTypes.NETWORK_ERROR, details: ErrorDetails.KEY_LOAD_ERROR, fatal: false, frag, response });
+ this.hls.trigger(Events.ERROR, { type: ErrorTypes.NETWORK_ERROR, details: ErrorDetails.KEY_LOAD_ERROR, fatal: false, frag, response });
}
loadtimeout (stats: LoaderStats, context: KeyLoaderContext) {
@@ -129,6 +135,6 @@ export default class KeyLoader extends EventHandler {
}
delete this.loaders[frag.type];
- this.hls.trigger(Event.ERROR, { type: ErrorTypes.NETWORK_ERROR, details: ErrorDetails.KEY_LOAD_TIMEOUT, fatal: false, frag });
+ this.hls.trigger(Events.ERROR, { type: ErrorTypes.NETWORK_ERROR, details: ErrorDetails.KEY_LOAD_TIMEOUT, fatal: false, frag });
}
}
diff --git a/src/loader/m3u8-parser.ts b/src/loader/m3u8-parser.ts
index 7aaaf3ee9d6..82f59a7eefc 100644
--- a/src/loader/m3u8-parser.ts
+++ b/src/loader/m3u8-parser.ts
@@ -394,7 +394,7 @@ function backfillProgramDateTimes (fragments, startIndex) {
function assignProgramDateTime (frag, prevFrag) {
if (frag.rawProgramDateTime) {
frag.programDateTime = Date.parse(frag.rawProgramDateTime);
- } else if (prevFrag && prevFrag.programDateTime) {
+ } else if (prevFrag?.programDateTime) {
frag.programDateTime = prevFrag.endProgramDateTime;
}
diff --git a/src/loader/playlist-loader.ts b/src/loader/playlist-loader.ts
index af3a3b79b42..0867fe443aa 100644
--- a/src/loader/playlist-loader.ts
+++ b/src/loader/playlist-loader.ts
@@ -9,8 +9,7 @@
*
*/
-import Event from '../events';
-import EventHandler from '../event-handler';
+import { Events } from '../events';
import { ErrorTypes, ErrorDetails } from '../errors';
import { logger } from '../utils/logger';
import { parseSegmentIndex } from '../utils/mp4-tools';
@@ -25,9 +24,10 @@ import {
PlaylistLevelType,
PlaylistLoaderContext
} from '../types/loader';
-import { ManifestLoadingData, LevelLoadingData, TrackLoadingData } from '../types/events';
+import { ManifestLoadingData, LevelLoadingData, AudioTrackLoadingData, SubtitleTrackLoadingData } from '../types/events';
import LevelDetails from './level-details';
import Fragment from './fragment';
+import Hls from '../hls';
const { performance } = self;
@@ -72,20 +72,35 @@ function getResponseUrl (response: LoaderResponse, context: PlaylistLoaderContex
/**
* @constructor
*/
-class PlaylistLoader extends EventHandler {
- private readonly loaders: { [key: string]: Loader };
+class PlaylistLoader {
+ private readonly hls: Hls;
+ private readonly loaders: {
+ [key: string]: Loader
+ } = Object.create(null)
+
/**
* @constructs
* @param {Hls} hls
*/
- constructor (hls) {
- super(hls,
- Event.MANIFEST_LOADING,
- Event.LEVEL_LOADING,
- Event.AUDIO_TRACK_LOADING,
- Event.SUBTITLE_TRACK_LOADING);
-
- this.loaders = Object.create(null);
+ constructor (hls: Hls) {
+ this.hls = hls;
+ this._registerListeners();
+ }
+
+ private _registerListeners () {
+ const { hls } = this;
+ hls.on(Events.MANIFEST_LOADING, this.onManifestLoading, this);
+ hls.on(Events.LEVEL_LOADING, this.onLevelLoading, this);
+ hls.on(Events.AUDIO_TRACK_LOADING, this.onAudioTrackLoading, this);
+ hls.on(Events.SUBTITLE_TRACK_LOADING, this.onSubtitleTrackLoading, this);
+ }
+
+ private _unregisterListeners () {
+ const { hls } = this;
+ hls.off(Events.MANIFEST_LOADING, this.onManifestLoading, this);
+ hls.off(Events.LEVEL_LOADING, this.onLevelLoading, this);
+ hls.off(Events.AUDIO_TRACK_LOADING, this.onAudioTrackLoading, this);
+ hls.off(Events.SUBTITLE_TRACK_LOADING, this.onSubtitleTrackLoading, this);
}
// TODO: export as enum once fragment-tracker and stream-controller typed
@@ -135,12 +150,11 @@ class PlaylistLoader extends EventHandler {
}
public destroy (): void {
+ this._unregisterListeners();
this.destroyInternalLoaders();
-
- super.destroy();
}
- protected onManifestLoading (data: ManifestLoadingData): void {
+ private onManifestLoading (event: Events.MANIFEST_LOADING, data: ManifestLoadingData) {
const { url } = data;
this.load({
id: null,
@@ -151,7 +165,7 @@ class PlaylistLoader extends EventHandler {
});
}
- protected onLevelLoading (data: LevelLoadingData): void {
+ private onLevelLoading (event: Events.LEVEL_LOADING, data: LevelLoadingData) {
const { id, level, url } = data;
this.load({
id,
@@ -162,7 +176,7 @@ class PlaylistLoader extends EventHandler {
});
}
- protected onAudioTrackLoading (data: TrackLoadingData): void {
+ private onAudioTrackLoading (event: Events.AUDIO_TRACK_LOADING, data: AudioTrackLoadingData) {
const { id, url } = data;
this.load({
id,
@@ -173,7 +187,7 @@ class PlaylistLoader extends EventHandler {
});
}
- protected onSubtitleTrackLoading (data: TrackLoadingData): void {
+ private onSubtitleTrackLoading (event: Events.SUBTITLE_TRACK_LOADING, data: SubtitleTrackLoadingData) {
const { id, url } = data;
this.load({
id,
@@ -335,7 +349,7 @@ class PlaylistLoader extends EventHandler {
}
}
- hls.trigger(Event.MANIFEST_LOADED, {
+ hls.trigger(Events.MANIFEST_LOADED, {
levels,
audioTracks,
subtitles,
@@ -368,13 +382,13 @@ class PlaylistLoader extends EventHandler {
levelDetails.lastModified = Math.max(+(mtime as Date), +(encoded as Date));
if (!levelDetails.fragments.length) {
- hls.trigger(Event.ERROR, {
+ hls.trigger(Events.ERROR, {
type: ErrorTypes.NETWORK_ERROR,
details: ErrorDetails.LEVEL_EMPTY_ERROR,
fatal: false,
url: url,
reason: 'no fragments found in level',
- level: context.level
+ level: typeof context.level === 'number' ? context.level : undefined
});
return;
}
@@ -392,7 +406,7 @@ class PlaylistLoader extends EventHandler {
url
};
- hls.trigger(Event.MANIFEST_LOADED, {
+ hls.trigger(Events.MANIFEST_LOADED, {
levels: [singleLevel],
audioTracks: [],
url,
@@ -449,7 +463,7 @@ class PlaylistLoader extends EventHandler {
}
private _handleManifestParsingError (response: LoaderResponse, context, reason, networkDetails): void {
- this.hls.trigger(Event.ERROR, {
+ this.hls.trigger(Events.ERROR, {
type: ErrorTypes.NETWORK_ERROR,
details: ErrorDetails.MANIFEST_PARSING_ERROR,
fatal: context.type === PlaylistContextType.MANIFEST,
@@ -505,7 +519,7 @@ class PlaylistLoader extends EventHandler {
errorData.response = response;
}
- this.hls.trigger(Event.ERROR, errorData);
+ this.hls.trigger(Events.ERROR, errorData);
}
private _handlePlaylistLoaded (response: LoaderResponse, stats: LoaderStats, context, networkDetails): void {
@@ -518,7 +532,7 @@ class PlaylistLoader extends EventHandler {
const canHaveLevels = canHaveQualityLevels(context.type);
if (canHaveLevels) {
- this.hls.trigger(Event.LEVEL_LOADED, {
+ this.hls.trigger(Events.LEVEL_LOADED, {
details: levelDetails,
level: level || 0,
id: id || 0,
@@ -528,7 +542,7 @@ class PlaylistLoader extends EventHandler {
} else {
switch (type) {
case PlaylistContextType.AUDIO_TRACK:
- this.hls.trigger(Event.AUDIO_TRACK_LOADED, {
+ this.hls.trigger(Events.AUDIO_TRACK_LOADED, {
details: levelDetails,
id,
stats,
@@ -536,7 +550,7 @@ class PlaylistLoader extends EventHandler {
});
break;
case PlaylistContextType.SUBTITLE_TRACK:
- this.hls.trigger(Event.SUBTITLE_TRACK_LOADED, {
+ this.hls.trigger(Events.SUBTITLE_TRACK_LOADED, {
details: levelDetails,
id,
stats,
diff --git a/src/observer.ts b/src/observer.ts
deleted file mode 100644
index 33d265eb752..00000000000
--- a/src/observer.ts
+++ /dev/null
@@ -1,15 +0,0 @@
-import { EventEmitter } from 'eventemitter3';
-
-/**
- * Simple adapter sub-class of Nodejs-like EventEmitter.
- */
-export class Observer extends EventEmitter {
- /**
- * We simply want to pass along the event-name itself
- * in every call to a handler, which is the purpose of our `trigger` method
- * extending the standard API.
- */
- trigger (event: string, ...data: Array): void {
- this.emit(event, event, ...data);
- }
-}
diff --git a/src/performance/performance-monitor.ts b/src/performance/performance-monitor.ts
index 507235c1d38..74d05fead95 100644
--- a/src/performance/performance-monitor.ts
+++ b/src/performance/performance-monitor.ts
@@ -7,20 +7,25 @@
* TODO: Add this to the demo page or a performance test page
*/
-import EventHandler from '../event-handler';
-import Events from '../events';
+import { Events } from '../events';
import Fragment from '../loader/fragment';
import { logger } from '../utils/logger';
+import Hls from '../hls';
+import { FragBufferedData } from '../types/events';
-export default class PerformanceMonitor extends EventHandler {
- constructor (hls) {
- super(hls,
- Events.FRAG_BUFFERED
- );
+export default class PerformanceMonitor {
+ private hls: Hls;
+
+ constructor (hls: Hls) {
this.hls = hls;
+ this.hls.on(Events.FRAG_BUFFERED, this.onFragBuffered);
+ }
+
+ destroy () {
+ this.hls.off(Events.FRAG_BUFFERED);
}
- onFragBuffered (data: { frag: Fragment }) {
+ onFragBuffered (event: Events.FRAG_BUFFERED, data: FragBufferedData) {
logFragStats(data.frag);
}
}
@@ -35,7 +40,7 @@ function logFragStats (frag: Fragment) {
logger.log(`[performance-monitor]: Stats for fragment ${frag.sn} of level ${frag.level}:
Size: ${((stats.total / 1024)).toFixed(3)} kB
Chunk Count: ${stats.chunkCount}
-
+
Request: ${stats.loading.start.toFixed(3)} ms
First Byte: ${stats.loading.first.toFixed(3)} ms
Parse Start ${stats.parsing.start.toFixed(3)} ms
diff --git a/src/polyfills/number-isFinite.js b/src/polyfills/number-isFinite.ts
similarity index 100%
rename from src/polyfills/number-isFinite.js
rename to src/polyfills/number-isFinite.ts
diff --git a/src/remux/mp4-generator.js b/src/remux/mp4-generator.ts
similarity index 96%
rename from src/remux/mp4-generator.js
rename to src/remux/mp4-generator.ts
index 70800f9857a..1858745a97e 100644
--- a/src/remux/mp4-generator.js
+++ b/src/remux/mp4-generator.ts
@@ -2,9 +2,26 @@
* Generate MP4 Box
*/
+type HdlrTypes = {
+ video: Uint8Array,
+ audio: Uint8Array
+}
+
const UINT32_MAX = Math.pow(2, 32) - 1;
class MP4 {
+ public static types: Record;
+ private static HDLR_TYPES: HdlrTypes;
+ private static STTS: Uint8Array;
+ private static STSC: Uint8Array;
+ private static STCO: Uint8Array;
+ private static STSZ: Uint8Array;
+ private static VMHD: Uint8Array;
+ private static SMHD: Uint8Array;
+ private static STSD: Uint8Array;
+ private static FTYP: Uint8Array;
+ private static DINF: Uint8Array;
+
static init () {
MP4.types = {
avc1: [], // codingname
@@ -45,7 +62,7 @@ class MP4 {
smhd: []
};
- let i;
+ let i: string;
for (i in MP4.types) {
if (MP4.types.hasOwnProperty(i)) {
MP4.types[i] = [
@@ -140,8 +157,7 @@ class MP4 {
MP4.DINF = MP4.box(MP4.types.dinf, MP4.box(MP4.types.dref, dref));
}
- static box (type) {
- const payload = Array.prototype.slice.call(arguments, 1);
+ static box (type, ...payload: Uint8Array[]) {
let size = 8;
let i = payload.length;
const len = i;
@@ -231,7 +247,7 @@ class MP4 {
*/
static moov (tracks) {
let i = tracks.length;
- const boxes = [];
+ const boxes: Uint8Array[] = [];
while (i--) {
boxes[i] = MP4.trak(tracks[i]);
@@ -242,13 +258,13 @@ class MP4 {
static mvex (tracks) {
let i = tracks.length;
- const boxes = [];
+ const boxes: Uint8Array[] = [];
while (i--) {
boxes[i] = MP4.trex(tracks[i]);
}
- return MP4.box.apply(null, [MP4.types.mvex].concat(boxes));
+ return MP4.box.apply(null, [MP4.types.mvex, ...boxes]);
}
static mvhd (timescale, duration) {
@@ -320,8 +336,8 @@ class MP4 {
}
static avc1 (track) {
- let sps = [];
- let pps = [];
+ let sps: number[] = [];
+ let pps: number[] = [];
let i;
let data;
let len;
diff --git a/src/remux/mp4-remuxer.ts b/src/remux/mp4-remuxer.ts
index 7c988074758..fe96f92c782 100644
--- a/src/remux/mp4-remuxer.ts
+++ b/src/remux/mp4-remuxer.ts
@@ -1,6 +1,6 @@
import AAC from './aac-helper';
import MP4 from './mp4-generator';
-import Event from '../events';
+import { Events } from '../events';
import { ErrorTypes, ErrorDetails } from '../errors';
import { logger } from '../utils/logger';
import { InitSegmentData, Remuxer, RemuxerResult, RemuxedMetadata, RemuxedTrack } from '../types/remuxer';
@@ -334,7 +334,7 @@ export default class MP4Remuxer implements Remuxer {
try {
mdat = new Uint8Array(mdatSize);
} catch (err) {
- this.observer.trigger(Event.ERROR, { type: ErrorTypes.MUX_ERROR, details: ErrorDetails.REMUX_ALLOC_ERROR, fatal: false, bytes: mdatSize, reason: `fail allocating video mdat ${mdatSize}` });
+ this.observer.trigger(Events.ERROR, { type: ErrorTypes.MUX_ERROR, details: ErrorDetails.REMUX_ALLOC_ERROR, fatal: false, bytes: mdatSize, reason: `fail allocating video mdat ${mdatSize}` });
return;
}
const view = new DataView(mdat.buffer);
@@ -593,7 +593,7 @@ export default class MP4Remuxer implements Remuxer {
try {
mdat = new Uint8Array(mdatSize);
} catch (err) {
- this.observer.trigger(Event.ERROR, {
+ this.observer.trigger(Events.ERROR, {
type: ErrorTypes.MUX_ERROR,
details: ErrorDetails.REMUX_ALLOC_ERROR,
fatal: false,
diff --git a/src/task-loop.ts b/src/task-loop.ts
index 8a64fc4e941..1848add0548 100644
--- a/src/task-loop.ts
+++ b/src/task-loop.ts
@@ -1,6 +1,3 @@
-import EventHandler from './event-handler';
-import Hls from './hls';
-
/**
* Sub-class specialization of EventHandler base class.
*
@@ -29,27 +26,29 @@ import Hls from './hls';
* we are limiting the task execution per call stack to exactly one, but scheduling/post-poning further
* task processing on the next main loop iteration (also known as "next tick" in the Node/JS runtime lingo).
*/
-
-export default class TaskLoop extends EventHandler {
+export default class TaskLoop {
private readonly _boundTick: () => void;
private _tickTimer: number | null = null;
private _tickInterval: number | null = null;
private _tickCallCount = 0;
- constructor (hls: Hls, ...events: string[]) {
- super(hls, ...events);
+ constructor () {
this._boundTick = this.tick.bind(this);
}
- /**
- * @override
- */
+ public destroy () {
+ this.onHandlerDestroying();
+ this.onHandlerDestroyed();
+ }
+
protected onHandlerDestroying () {
// clear all timers before unregistering from event bus
this.clearNextTick();
this.clearInterval();
}
+ protected onHandlerDestroyed () {}
+
/**
* @returns {boolean}
*/
diff --git a/src/types/component-api.ts b/src/types/component-api.ts
new file mode 100644
index 00000000000..046c0f29ef3
--- /dev/null
+++ b/src/types/component-api.ts
@@ -0,0 +1,8 @@
+export interface ComponentAPI {
+ destroy(): void;
+}
+
+export interface NetworkComponentAPI extends ComponentAPI {
+ startLoad(startPosition: number): void;
+ stopLoad(): void;
+}
diff --git a/src/types/events.ts b/src/types/events.ts
index 3c10c3af425..d8f3b6057c9 100644
--- a/src/types/events.ts
+++ b/src/types/events.ts
@@ -2,10 +2,57 @@ import Fragment from '../loader/fragment';
import LevelDetails from '../loader/level-details';
import { Level, LevelParsed } from './level';
import { MediaPlaylist } from './media-playlist';
-import { LoaderStats } from './loader';
-import { Track } from './track';
+import { LoaderStats, PlaylistLevelType } from './loader';
+import { Track, TrackSet } from './track';
import { SourceBufferName } from './buffer';
import { ChunkMetadata } from './transmuxer';
+import LoadStats from '../loader/load-stats';
+import { ErrorDetails, ErrorTypes } from '../errors';
+
+export interface MediaAttachingData {
+ media: HTMLMediaElement
+}
+
+export interface MediaAttachedData {
+ media: HTMLMediaElement;
+}
+
+export interface BufferCodecsData {
+ video?: Track
+ audio?: Track
+}
+
+export interface BufferCreatedData {
+ tracks: TrackSet
+}
+
+export interface BufferAppendingData {
+ type: SourceBufferName;
+ data: Uint8Array;
+ frag: Fragment;
+ chunkMeta: ChunkMetadata
+}
+
+export interface BufferAppendedData {
+ chunkMeta: ChunkMetadata
+ frag: Fragment
+ parent: PlaylistLevelType
+ timeRanges: {
+ audio?: TimeRanges
+ video?: TimeRanges
+ audiovideo?: TimeRanges
+ }
+}
+
+export interface BufferEOSData {
+ type: SourceBufferName
+}
+
+export interface BufferFlushingData {
+ startOffset: number
+ endOffset: number
+ type: SourceBufferName
+}
export interface ManifestLoadingData {
url: string
@@ -31,6 +78,14 @@ export interface ManifestParsedData {
altAudio: boolean
}
+export interface LevelSwitchingData extends Level {
+ level: number;
+}
+
+export interface LevelSwitchedData {
+ level: any
+}
+
export interface TrackLoadingData {
id: number
url: string
@@ -56,23 +111,63 @@ export interface LevelUpdatedData {
level: number
}
-export interface AudioTracksUpdated {
+export interface LevelPTSUpdatedData {
+ details: any,
+ level: Level,
+ drift: number,
+ type: string,
+ start: any,
+ end: any
+}
+
+export interface AudioTrackSwitchingData {
+ url: any
+ type: any
+ id: any
+}
+
+export interface AudioTrackSwitchedData {
+ id: any
+}
+
+export interface AudioTrackLoadingData {
+ url: string;
+ id: number | null;
+}
+
+export interface AudioTrackLoadedData {
+ details: any; // LevelDetails type?
+ id: number;
+ stats: LoaderStats;
+ networkDetails: unknown;
+}
+
+export interface AudioTracksUpdatedData {
audioTracks: MediaPlaylist[]
}
-export interface SubtitleTracksUpdated {
+export interface SubtitleTracksUpdatedData {
subtitleTracks: MediaPlaylist[]
}
-export interface TrackSwitchedData {
+export interface SubtitleTrackSwitchData {
id: number
}
-export interface FragLoadedData {
- frag: Fragment
- networkDetails: any
- payload: ArrayBuffer
- stats: LoaderStats
+export interface SubtitleTrackLoadingData {
+ url: string;
+ id: number | null;
+}
+
+export interface SubtitleTrackLoadedData {
+ details: any; // LevelDetails type?
+ id: number | null;
+ stats: LoaderStats;
+ networkDetails: unknown;
+}
+
+export interface TrackSwitchedData {
+ id: number
}
export interface SubtitleFragProcessed {
@@ -80,20 +175,24 @@ export interface SubtitleFragProcessed {
frag: Fragment
}
-export interface MediaAttachedData {
- media: HTMLVideoElement;
+export interface FragChangedData {
+ frag: any;
}
-export interface BufferAppendingEventPayload {
- type: SourceBufferName;
- data: Uint8Array;
- frag: Fragment;
- chunkMeta: ChunkMetadata
+export interface FPSDropData {
+ currentDropped: number
+ currentDecoded: number
+ totalDroppedFrames: number
+}
+
+export interface FPSDropLevelCappingData {
+ droppedLevel: number
+ level: number
}
export interface ErrorData {
- type: string // TODO: string enum of ErrorTypes values
- details: string // TODO: string enum of ErrorDetails values
+ type: ErrorTypes
+ details: ErrorDetails
fatal: boolean
buffer?: number
bytes?: number
@@ -104,23 +203,104 @@ export interface ErrorData {
level?: number
levelRetry?: boolean
networkDetails?: any
+ mimeType?: string
reason?: string
response?: any
url?: string
+ parent?: PlaylistLevelType
+ err?: { // comes from transmuxer interface
+ message: string;
+ }
}
-export interface MediaAttachingData {
- media: HTMLVideoElement
+export interface SubtitleFragProcessedData {
+ success: boolean
+ frag: Fragment
+ error?: Error
}
-export interface BufferCodecsData {
- video: Track
+export interface CuesParsedData {
+ type: 'captions' | 'subtitles',
+ cues: any,
+ track: string
}
-export interface FPSDropLevelCappingData {
- droppedLevel: number
+interface NonNativeTextTrack {
+ label: any
+ kind: string
+ default: boolean
+}
+
+export interface NonNativeTextTracksData {
+ tracks: Array
+}
+
+export interface InitPTSFoundData {
+ id: string
+ frag: Fragment
+ initPTS: number
+}
+
+export interface FragLoadingData {
+ frag: Fragment
+}
+
+export interface FragLoadEmergencyAbortedData {
+ frag: Fragment
+ stats: LoaderStats
+}
+
+export interface FragLoadedData {
+ frag: Fragment
+ networkDetails: any
+ payload: ArrayBuffer
+ stats: LoaderStats
+}
+
+export interface FragDecryptedData {
+ frag: Fragment
+ payload: ArrayBuffer
+ stats: {
+ tstart: number
+ tdecrypt: number
+ }
+}
+
+export interface FragParsingInitSegmentData {
+
+}
+
+// TODO: What are samples type?
+export interface FragParsingUserdataData {
+ samples: Array
+}
+
+export interface FragParsingMetadataData {
+ frag: Fragment
+}
+
+export interface FragParsedData {
+ frag: Fragment
+}
+
+export interface FragBufferedData {
+ stats: LoadStats
+ frag: Fragment
+ id: string
}
export interface LevelsUpdatedData {
levels: Array
}
+
+export interface KeyLoadingData {
+ frag: Fragment
+}
+
+export interface KeyLoadedData {
+ frag: Fragment
+}
+
+export interface LiveBackBufferData {
+ bufferEnd: number
+}
diff --git a/src/types/tuples.ts b/src/types/tuples.ts
new file mode 100644
index 00000000000..7b11d867ce7
--- /dev/null
+++ b/src/types/tuples.ts
@@ -0,0 +1,4 @@
+export type Tail =
+ ((...t: T) => any) extends ((_: any, ...tail: infer U) => any)
+ ? U
+ : [];
diff --git a/src/utils/buffer-helper.ts b/src/utils/buffer-helper.ts
index 0bde46e34dd..a34fde1126c 100644
--- a/src/utils/buffer-helper.ts
+++ b/src/utils/buffer-helper.ts
@@ -50,7 +50,7 @@ export class BufferHelper {
}
static bufferInfo (
- media: Bufferable,
+ media: Bufferable | null,
pos: number,
maxHoleDuration: number
): BufferInfo {
diff --git a/src/utils/chunker.ts b/src/utils/chunker.ts
index e05a85ab361..adfb876cbf4 100644
--- a/src/utils/chunker.ts
+++ b/src/utils/chunker.ts
@@ -13,7 +13,7 @@ export default class Chunker {
const result: Array = [];
let temp: Uint8Array | null = null;
- if (cache && cache.length) {
+ if (cache?.length) {
temp = appendUint8Array(cache, data);
this.cache = null;
} else {
diff --git a/src/utils/logger.ts b/src/utils/logger.ts
index 282d6909898..dffab0fe327 100644
--- a/src/utils/logger.ts
+++ b/src/utils/logger.ts
@@ -11,7 +11,7 @@ interface ILogger {
error: ILogFunction
}
-const noop: ILogFunction = function (...args: any[]): void { };
+const noop: ILogFunction = function () {};
const fakeLogger: ILogger = {
trace: noop,
diff --git a/src/utils/mp4-tools.ts b/src/utils/mp4-tools.ts
index 1f6453729a6..8148e6841c6 100644
--- a/src/utils/mp4-tools.ts
+++ b/src/utils/mp4-tools.ts
@@ -358,7 +358,7 @@ export function getDuration (data, initData) {
if (totalDuration === 0) {
// If duration samples are not available in the traf use sidx subsegment_duration
const sidx = parseSegmentIndex(data);
- if (sidx && sidx.references) {
+ if (sidx?.references) {
return sidx.references.reduce((dur, ref) => dur + ref.info.duration || 0, 0);
}
}
diff --git a/src/utils/timescale-conversion.ts b/src/utils/timescale-conversion.ts
index 7591545ec6a..e03927946e3 100644
--- a/src/utils/timescale-conversion.ts
+++ b/src/utils/timescale-conversion.ts
@@ -1,7 +1,7 @@
const MPEG_TS_CLOCK_FREQ_HZ = 90000;
export function toTimescaleFromScale (value, destScale: number, srcScale: number = 1, round: boolean = false): number {
- return toTimescaleFromBase(value, destScale, 1 / srcScale);
+ return toTimescaleFromBase(value, destScale, 1 / srcScale, round);
}
export function toTimescaleFromBase (value, destScale: number, srcBase: number = 1, round: boolean = false): number {
diff --git a/tests/functional/issues/617.html b/tests/functional/issues/617.html
index a1590663b5f..0a789909213 100644
--- a/tests/functional/issues/617.html
+++ b/tests/functional/issues/617.html
@@ -23,7 +23,7 @@
enableCEA708Captions: true
});
- hls.on(Hls.Events.ERROR, function(event, data) {
+ hls.on(Hls.Events.ERROR, function(data) {
console.warn('ERROR', data);
});
diff --git a/tests/unit/controller/audio-stream-controller.js b/tests/unit/controller/audio-stream-controller.js
index fb715abddc3..016bb56ff3d 100644
--- a/tests/unit/controller/audio-stream-controller.js
+++ b/tests/unit/controller/audio-stream-controller.js
@@ -1,5 +1,6 @@
import AudioStreamController from '../../../src/controller/audio-stream-controller';
import Hls from '../../../src/hls';
+import { Events } from '../../../src/events';
describe('AudioStreamController', function () {
const tracks = [{
@@ -55,7 +56,7 @@ describe('AudioStreamController', function () {
audioStreamController.levels = tracks;
audioStreamController.tick = () => {};
- audioStreamController.onAudioTrackLoaded({
+ audioStreamController.onAudioTrackLoaded(Events.AUDIO_TRACK_LOADED, {
id: 0,
details
});
diff --git a/tests/unit/controller/audio-track-controller.js b/tests/unit/controller/audio-track-controller.js
index 9aac23019d8..0f3082bb94f 100644
--- a/tests/unit/controller/audio-track-controller.js
+++ b/tests/unit/controller/audio-track-controller.js
@@ -1,5 +1,6 @@
import AudioTrackController from '../../../src/controller/audio-track-controller';
import Hls from '../../../src/hls';
+import { Events } from '../../../src/events';
const sinon = require('sinon');
@@ -62,7 +63,7 @@ describe('AudioTrackController', function () {
done();
});
- audioTrackController.onManifestParsed({
+ audioTrackController.onManifestParsed(Events.MANIFEST_PARSED, {
audioTracks: tracks
});
});
@@ -74,7 +75,7 @@ describe('AudioTrackController', function () {
done();
});
- audioTrackController.onManifestParsed({
+ audioTrackController.onManifestParsed(Events.MANIFEST_PARSED, {
audioTracks: null
});
});
@@ -96,7 +97,7 @@ describe('AudioTrackController', function () {
it('should update the current audioGroupId', function () {
audioTrackController.tracks = tracks;
audioTrackController.audioGroupId = '2';
- audioTrackController.onAudioTrackSwitched({
+ audioTrackController.onAudioTrackSwitched(Events.AUDIO_TRACK_SWITCHED, {
id: 1
});
@@ -135,7 +136,7 @@ describe('AudioTrackController', function () {
// current track name
const audioTrackName = tracks[audioTrackController.audioTrack].name;
- audioTrackController.onLevelLoading(levelLoadedEvent);
+ audioTrackController.onLevelLoading(Events.LEVEL_LOADING, levelLoadedEvent);
// group has switched
expect(audioTrackController.audioGroupId).to.equal(newGroupId);
@@ -165,7 +166,7 @@ describe('AudioTrackController', function () {
audioTrackController.tracks = [trackWithUrl];
- audioTrackController.onLevelLoading({
+ audioTrackController.onLevelLoading(Events.LEVEL_LOADING, {
level: 0
});
@@ -192,7 +193,7 @@ describe('AudioTrackController', function () {
audioTrackController.tracks = tracks;
- audioTrackController.onLevelLoading({
+ audioTrackController.onLevelLoading(Events.LEVEL_LOADING, {
level: 0
});
@@ -207,24 +208,24 @@ describe('AudioTrackController', function () {
it('should clear interval (only) on fatal network errors', function () {
audioTrackController.timer = 1000;
- audioTrackController.onError({
+ audioTrackController.onError(Events.ERROR, {
type: Hls.ErrorTypes.MEDIA_ERROR
});
expect(audioTrackController.timer).to.equal(1000);
- audioTrackController.onError({
+ audioTrackController.onError(Events.ERROR, {
type: Hls.ErrorTypes.MEDIA_ERROR,
fatal: true
});
expect(audioTrackController.timer).to.equal(1000);
- audioTrackController.onError({
+ audioTrackController.onError(Events.ERROR, {
type: Hls.ErrorTypes.NETWORK_ERROR,
fatal: false
});
expect(audioTrackController.timer).to.equal(1000);
- audioTrackController.onError({
+ audioTrackController.onError(Events.ERROR, {
type: Hls.ErrorTypes.NETWORK_ERROR,
fatal: true
});
@@ -237,19 +238,19 @@ describe('AudioTrackController', function () {
const currentTrackId = 4;
audioTrackController._trackId = currentTrackId;
audioTrackController.tracks = tracks;
- audioTrackController.onError({
+ audioTrackController.onError(Events.ERROR, {
type: Hls.ErrorTypes.MEDIA_ERROR,
fatal: true
});
expect(!!audioTrackController.trackIdBlacklist[currentTrackId]).to.be.false;
- audioTrackController.onError({
+ audioTrackController.onError(Events.ERROR, {
type: Hls.ErrorTypes.NETWORK_ERROR,
fatal: true
});
expect(!!audioTrackController.trackIdBlacklist[currentTrackId]).to.be.false;
- audioTrackController.onError({
+ audioTrackController.onError(Events.ERROR, {
type: Hls.ErrorTypes.NETWORK_ERROR,
details: Hls.ErrorDetails.AUDIO_TRACK_LOAD_ERROR,
fatal: true,
diff --git a/tests/unit/controller/buffer-controller-operations.ts b/tests/unit/controller/buffer-controller-operations.ts
index f483b7b341c..bc04bf68303 100644
--- a/tests/unit/controller/buffer-controller-operations.ts
+++ b/tests/unit/controller/buffer-controller-operations.ts
@@ -6,8 +6,8 @@ import Hls from '../../../src/hls';
import BufferOperationQueue from '../../../src/controller/buffer-operation-queue';
import BufferController from '../../../src/controller/buffer-controller';
import { BufferOperation, SourceBufferName } from '../../../src/types/buffer';
-import { BufferAppendingEventPayload } from '../../../src/types/events';
-import Events from '../../../src/events';
+import { BufferAppendingData } from '../../../src/types/events';
+import { Events } from '../../../src/events';
import { ErrorDetails, ErrorTypes } from '../../../src/errors';
import Fragment, { ElementaryStreamTypes } from '../../../src/loader/fragment';
import { PlaylistLevelType } from '../../../src/types/loader';
@@ -143,14 +143,14 @@ describe('BufferController SourceBuffer operation queueing', function () {
const frag = new Fragment();
frag.type = PlaylistLevelType.MAIN;
const chunkMeta = new ChunkMetadata(0, 0, 0, 0);
- const data: BufferAppendingEventPayload = {
+ const data: BufferAppendingData = {
type: name,
data: segmentData,
frag,
chunkMeta
};
- bufferController.onBufferAppending(data);
+ bufferController.onBufferAppending(Events.BUFFER_APPENDING, data);
expect(queueAppendSpy, 'The append operation should have been enqueued').to.have.callCount(i + 1);
buffer.dispatchEvent(new Event('updateend'));
@@ -173,7 +173,7 @@ describe('BufferController SourceBuffer operation queueing', function () {
const queueAppendSpy = sandbox.spy(operationQueue, 'append');
queueNames.forEach((name, i) => {
bufferController.sourceBuffer = {};
- bufferController.onBufferAppending({
+ bufferController.onBufferAppending(Events.BUFFER_APPENDING, {
type: name,
data: new Uint8Array(),
frag: new Fragment(),
@@ -194,7 +194,7 @@ describe('BufferController SourceBuffer operation queueing', function () {
frag.setElementaryStreamInfo(ElementaryStreamTypes.AUDIO, 0, 0, 0, 0);
frag.setElementaryStreamInfo(ElementaryStreamTypes.VIDEO, 0, 0, 0, 0);
- bufferController.onFragParsed({ frag });
+ bufferController.onFragParsed(Events.FRAG_PARSED, { frag });
expect(queueAppendBlockerSpy).to.have.been.calledTwice;
expect(flushLiveBackBufferSpy).to.have.been.calledOnce;
return new Promise((resolve, reject) => {
@@ -227,7 +227,7 @@ describe('BufferController SourceBuffer operation queueing', function () {
});
it('flushes audio and video buffers if no type arg is specified', function () {
- bufferController.onBufferFlushing({
+ bufferController.onBufferFlushing(Events.BUFFER_FLUSHING, {
startOffset: 0,
endOffset: 10
});
@@ -247,7 +247,7 @@ describe('BufferController SourceBuffer operation queueing', function () {
it('dequeues the remove operation if the SourceBuffer does not exist during the operation', function () {
bufferController.sourceBuffer = {};
- bufferController.onBufferFlushing({
+ bufferController.onBufferFlushing(Events.BUFFER_FLUSHING, {
startOffset: 0,
endOffset: Infinity
});
@@ -258,7 +258,7 @@ describe('BufferController SourceBuffer operation queueing', function () {
it('dequeues the remove operation if the requested remove range is not valid', function () {
// Does not flush if start greater than end
- bufferController.onBufferFlushing({
+ bufferController.onBufferFlushing(Events.BUFFER_FLUSHING, {
startOffset: 9001,
endOffset: 9000
});
@@ -314,7 +314,7 @@ describe('BufferController SourceBuffer operation queueing', function () {
bufferController.flushLiveBackBuffer();
expect(bufferFlushingSpy).to.have.been.calledTwice;
queueNames.forEach(name => {
- expect(bufferFlushingSpy, `onBufferFlushing should have been called for the ${name} SourceBuffer`).to.have.been.calledWith({ startOffset: 0, endOffset: 20, type: name });
+ expect(bufferFlushingSpy, `onBufferFlushing should have been called for the ${name} SourceBuffer`).to.have.been.calledWith(Events.BUFFER_FLUSHING, { startOffset: 0, endOffset: 20, type: name });
});
});
@@ -323,7 +323,7 @@ describe('BufferController SourceBuffer operation queueing', function () {
hls.config.liveBackBufferLength = 5;
bufferController.flushLiveBackBuffer();
queueNames.forEach(name => {
- expect(bufferFlushingSpy, `onBufferFlushing should have been called for the ${name} SourceBuffer`).to.have.been.calledWith({ startOffset: 0, endOffset: 15, type: name });
+ expect(bufferFlushingSpy, `onBufferFlushing should have been called for the ${name} SourceBuffer`).to.have.been.calledWith(Events.BUFFER_FLUSHING, { startOffset: 0, endOffset: 15, type: name });
});
});
@@ -366,13 +366,13 @@ describe('BufferController SourceBuffer operation queueing', function () {
it('exits early if the fragments array is empty', function () {
data.details.fragments = [];
- bufferController.onLevelUpdated(data);
+ bufferController.onLevelUpdated(Events.LEVEL_UPDATED, data);
expect(bufferController._levelTargetDuration, '_levelTargetDuration').to.be.null;
expect(bufferController._live, '_live').to.be.false;
});
it('updates class properties based on level data', function () {
- bufferController.onLevelUpdated(data);
+ bufferController.onLevelUpdated(Events.LEVEL_UPDATED, data);
expect(bufferController._levelTargetDuration, '_levelTargetDuration').to.equal(6);
expect(bufferController._live, '_live').to.be.true;
@@ -380,25 +380,25 @@ describe('BufferController SourceBuffer operation queueing', function () {
delete data.details.averagetargetduration;
data.details.targetduration = 7;
data.details.live = false;
- bufferController.onLevelUpdated(data);
+ bufferController.onLevelUpdated(Events.LEVEL_UPDATED, data);
expect(bufferController._levelTargetDuration, '_levelTargetDuration').to.equal(7);
expect(bufferController._live, '_live').to.be.false;
// Defaults to 10 if no duration is provided
delete data.details.targetduration;
- bufferController.onLevelUpdated(data);
+ bufferController.onLevelUpdated(Events.LEVEL_UPDATED, data);
expect(bufferController._levelTargetDuration, '_levelTargetDuration').to.equal(10);
});
it('enqueues a blocking operation which updates the MediaSource duration', function () {
- bufferController.onLevelUpdated(data);
+ bufferController.onLevelUpdated(Events.LEVEL_UPDATED, data);
expect(queueAppendBlockerSpy).to.have.been.calledTwice;
// Updating the duration is aync and has no event to signal completion, so we are unable to test for it directly
});
it('synchronously updates the duration if no SourceBuffers exist', function () {
bufferController.sourceBuffer = {};
- bufferController.onLevelUpdated(data);
+ bufferController.onLevelUpdated(Events.LEVEL_UPDATED, data);
expect(queueAppendBlockerSpy).to.have.not.been.called;
expect(mockMediaSource.duration, 'mediaSource.duration').to.equal(10);
expect(bufferController._msDuration, '_msDuration').to.equal(10);
@@ -408,7 +408,7 @@ describe('BufferController SourceBuffer operation queueing', function () {
describe('onBufferEos', function () {
it('marks the ExtendedSourceBuffer as ended', function () {
// No type arg ends both SourceBuffers
- bufferController.onBufferEos({ });
+ bufferController.onBufferEos(Events.BUFFER_EOS, {});
expect(queueAppendBlockerSpy).to.have.been.calledTwice;
queueNames.forEach(type => {
const buffer = bufferController.sourceBuffer[type];
diff --git a/tests/unit/controller/buffer-controller.js b/tests/unit/controller/buffer-controller.js
index 0df3d0d7cf4..4572a08f31c 100644
--- a/tests/unit/controller/buffer-controller.js
+++ b/tests/unit/controller/buffer-controller.js
@@ -1,6 +1,7 @@
import sinon from 'sinon';
import Hls from '../../../src/hls';
import BufferController from '../../../src/controller/buffer-controller';
+import { Events } from '../../../src/events';
describe('BufferController tests', function () {
let hls;
@@ -24,13 +25,13 @@ describe('BufferController tests', function () {
it('flushes a specific type when provided a type', function () {
const spy = sandbox.spy(bufferController.operationQueue, 'append');
- bufferController.onBufferFlushing({ startOffset: 0, endOffset: 10, type: 'video' });
+ bufferController.onBufferFlushing(Events.BUFFER_FLUSHING, { startOffset: 0, endOffset: 10, type: 'video' });
expect(spy).to.have.been.calledOnce;
});
it('flushes all source buffers when buffer flush event type is undefined', function () {
const spy = sandbox.spy(bufferController.operationQueue, 'append');
- bufferController.onBufferFlushing({ startOffset: 0, endOffset: 10 });
+ bufferController.onBufferFlushing(Events.BUFFER_FLUSHING, { startOffset: 0, endOffset: 10 });
expect(spy).to.have.been.calledTwice;
});
});
@@ -155,9 +156,9 @@ describe('BufferController tests', function () {
bufferController.createSourceBuffers.restore();
let video = document.createElement('video');
- bufferController.onMediaAttaching({ media: video });
+ bufferController.onMediaAttaching(Events.MEDIA_ATTACHING, { media: video });
- hls.on(Hls.Events.BUFFER_CREATED, (_, data) => {
+ hls.on(Hls.Events.BUFFER_CREATED, (event, data) => {
const tracks = data.tracks;
expect(bufferController.pendingTracks).to.not.equal(tracks);
expect(bufferController.tracks).to.equal(tracks);
@@ -171,12 +172,12 @@ describe('BufferController tests', function () {
});
it('expects one bufferCodec event by default', function () {
- bufferController.onManifestParsed({});
+ bufferController.onManifestParsed(Events.MANIFEST_PARSED, {});
expect(bufferController.bufferCodecEventsExpected).to.equal(1);
});
it('expects two bufferCodec events if altAudio is signaled', function () {
- bufferController.onManifestParsed({ altAudio: true });
+ bufferController.onManifestParsed(Events.MANIFEST_PARSED, { altAudio: true });
expect(bufferController.bufferCodecEventsExpected).to.equal(2);
});
@@ -214,11 +215,11 @@ describe('BufferController tests', function () {
bufferController.mediaSource = { readyState: 'open' };
bufferController.bufferCodecEventsExpected = 2;
- bufferController.onBufferCodecs({});
+ bufferController.onBufferCodecs(Events.BUFFER_CODECS, {});
expect(checkPendingTracksSpy).to.have.been.calledOnce;
expect(bufferController.bufferCodecEventsExpected).to.equal(1);
- bufferController.onBufferCodecs({});
+ bufferController.onBufferCodecs(Events.BUFFER_CODECS, {});
expect(checkPendingTracksSpy).to.have.been.calledTwice;
expect(bufferController.bufferCodecEventsExpected).to.equal(0);
});
@@ -227,10 +228,10 @@ describe('BufferController tests', function () {
bufferController.sourceBuffer = {};
bufferController.mediaSource = { readyState: 'open', removeEventListener: sandbox.stub() };
- bufferController.onManifestParsed({ altAudio: true });
+ bufferController.onManifestParsed(Events.MANIFEST_PARSED, { altAudio: true });
bufferController._onMediaSourceOpen();
- bufferController.onBufferCodecs({ audio: {} });
- bufferController.onBufferCodecs({ video: {} });
+ bufferController.onBufferCodecs(Events.BUFFER_CODECS, { audio: {} });
+ bufferController.onBufferCodecs(Events.BUFFER_CODECS, { video: {} });
expect(createSbStub).to.have.been.calledOnce;
expect(createSbStub).to.have.been.calledWith({ audio: {}, video: {} });
diff --git a/tests/unit/controller/cap-level-controller.js b/tests/unit/controller/cap-level-controller.js
index 227e603ed89..44041b220dc 100644
--- a/tests/unit/controller/cap-level-controller.js
+++ b/tests/unit/controller/cap-level-controller.js
@@ -1,6 +1,7 @@
import sinon from 'sinon';
import Hls from '../../../src/hls';
import CapLevelController from '../../../src/controller/cap-level-controller';
+import { Events } from '../../../src/events';
const levels = [
{
@@ -104,20 +105,20 @@ describe('CapLevelController', function () {
});
it('starts capping on BUFFER_CODECS only if video is found', function () {
- capLevelController.onBufferCodecs({ video: {} });
+ capLevelController.onBufferCodecs(Events.BUFFER_CODECS, { video: {} });
expect(startCappingSpy.calledOnce).to.be.true;
});
it('does not start capping on BUFFER_CODECS if video is not found', function () {
- capLevelController.onBufferCodecs({ audio: {} });
+ capLevelController.onBufferCodecs(Events.BUFFER_CODECS, { audio: {} });
expect(startCappingSpy.notCalled).to.be.true;
});
it('starts capping if the video codec was found after the audio codec', function () {
- capLevelController.onBufferCodecs({ audio: {} });
+ capLevelController.onBufferCodecs(Events.BUFFER_CODECS, { audio: {} });
expect(startCappingSpy.notCalled).to.be.true;
- capLevelController.onBufferCodecs({ video: {} });
+ capLevelController.onBufferCodecs(Events.BUFFER_CODECS, { video: {} });
expect(startCappingSpy.calledOnce).to.be.true;
});
@@ -128,19 +129,19 @@ describe('CapLevelController', function () {
firstLevel: 0
};
- capLevelController.onManifestParsed(data);
+ capLevelController.onManifestParsed(Events.MANIFEST_PARSED, data);
expect(capLevelController.levels).to.equal(data.levels);
expect(capLevelController.firstLevel).to.equal(data.firstLevel);
expect(capLevelController.restrictedLevels).to.be.empty;
});
it('should start capping in MANIFEST_PARSED if a video codec was signaled in the manifest', function () {
- capLevelController.onManifestParsed({ video: {} });
+ capLevelController.onManifestParsed(Events.MANIFEST_PARSED, { video: {} });
expect(startCappingSpy.calledOnce).to.be.true;
});
it('does not start capping on MANIFEST_PARSED if no video codec was signaled in the manifest', function () {
- capLevelController.onManifestParsed({ levels: [{}], altAudio: true });
+ capLevelController.onManifestParsed(Events.MANIFEST_PARSED, { levels: [{}], altAudio: true });
expect(startCappingSpy.notCalled).to.be.true;
});
@@ -154,7 +155,7 @@ describe('CapLevelController', function () {
streamController = hls.streamController;
nextLevelSwitchSpy = sinon.spy(streamController, 'nextLevelSwitch');
- capLevelController.onManifestParsed({ levels, video: {} });
+ capLevelController.onManifestParsed(Events.MANIFEST_PARSED, { levels, video: {} });
});
it('continues capping without second timer', function () {
diff --git a/tests/unit/controller/eme-controller.js b/tests/unit/controller/eme-controller.js
index 0ac56526dd4..b6de95790b0 100644
--- a/tests/unit/controller/eme-controller.js
+++ b/tests/unit/controller/eme-controller.js
@@ -2,6 +2,7 @@ import EMEController from '../../../src/controller/eme-controller';
import HlsMock from '../../mocks/hls.mock';
import { EventEmitter } from 'eventemitter3';
import { ErrorDetails } from '../../../src/errors';
+import { Events } from '../../../src/events';
const sinon = require('sinon');
@@ -42,8 +43,8 @@ describe('EMEController', function () {
requestMediaKeySystemAccessFunc: reqMediaKsAccessSpy
});
- emeController.onMediaAttached({ media });
- emeController.onManifestParsed({ media });
+ emeController.onMediaAttached(Events.MEDIA_ATTACHED, { media });
+ emeController.onManifestParsed(Events.MANIFEST_PARSED, { media });
expect(media.setMediaKeys.callCount).to.equal(0);
expect(reqMediaKsAccessSpy.callCount).to.equal(0);
@@ -61,12 +62,12 @@ describe('EMEController', function () {
requestMediaKeySystemAccessFunc: reqMediaKsAccessSpy
});
- emeController.onMediaAttached({ media });
+ emeController.onMediaAttached(Events.MEDIA_ATTACHED, { media });
expect(media.setMediaKeys.callCount).to.equal(0);
expect(reqMediaKsAccessSpy.callCount).to.equal(0);
- emeController.onManifestParsed({ levels: fakeLevels });
+ emeController.onManifestParsed(Events.MANIFEST_PARSED, { levels: fakeLevels });
self.setTimeout(function () {
expect(media.setMediaKeys.callCount).to.equal(0);
@@ -75,7 +76,7 @@ describe('EMEController', function () {
}, 0);
});
- it('should trigger key system error when bad encrypted data is received', function (done) {
+ it('should emit key system error when bad encrypted data is received', function (done) {
const reqMediaKsAccessSpy = sinon.spy(function () {
return Promise.resolve({
// Media-keys mock
@@ -92,8 +93,8 @@ describe('EMEController', function () {
initData: 'bad data'
};
- emeController.onMediaAttached({ media });
- emeController.onManifestParsed({ levels: fakeLevels });
+ emeController.onMediaAttached(Events.MEDIA_ATTACHED, { media });
+ emeController.onManifestParsed(Events.MANIFEST_PARSED, { levels: fakeLevels });
media.emit('encrypted', badData);
diff --git a/tests/unit/controller/fragment-tracker.js b/tests/unit/controller/fragment-tracker.js
index 6b92e44109f..4807144bb39 100644
--- a/tests/unit/controller/fragment-tracker.js
+++ b/tests/unit/controller/fragment-tracker.js
@@ -1,5 +1,5 @@
import Hls from '../../../src/hls';
-import Event from '../../../src/events';
+import { Events } from '../../../src/events';
import { FragmentTracker, FragmentState } from '../../../src/controller/fragment-tracker';
import { PlaylistLevelType } from '../../../src/types/loader';
@@ -25,7 +25,7 @@ function createMockFragment (data, types) {
* @param {Fragment} fragment
*/
function loadFragment (hls, fragment) {
- hls.trigger(Event.FRAG_LOADED, { frag: fragment });
+ hls.trigger(Events.FRAG_LOADED, { frag: fragment });
}
/**
@@ -35,8 +35,9 @@ function loadFragment (hls, fragment) {
*/
function loadFragmentAndBuffered (hls, fragment) {
loadFragment(hls, fragment);
- hls.trigger(Event.FRAG_BUFFERED, { frag: fragment });
+ hls.trigger(Events.FRAG_BUFFERED, { frag: fragment });
}
+
describe('FragmentTracker', function () {
describe('getPartialFragment', function () {
let partialFragment;
@@ -52,7 +53,7 @@ describe('FragmentTracker', function () {
type: 'main'
}, ['audio', 'video']);
- hls.trigger(Event.FRAG_LOADED, { frag: fragment });
+ hls.trigger(Events.FRAG_LOADED, { frag: fragment });
const buffered = createMockBuffer([
{
@@ -64,9 +65,9 @@ describe('FragmentTracker', function () {
const timeRanges = {};
timeRanges.video = buffered;
timeRanges.audio = buffered;
- hls.trigger(Event.BUFFER_APPENDED, { timeRanges });
+ hls.trigger(Events.BUFFER_APPENDED, { timeRanges });
- hls.trigger(Event.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
+ hls.trigger(Events.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
it('detects fragments that partially loaded', function () {
// Get the partial fragment at a time
@@ -77,6 +78,7 @@ describe('FragmentTracker', function () {
partialFragment = fragmentTracker.getPartialFragment(1);
expect(partialFragment).to.equal(fragment);
});
+
it('returns null when time is not inside partial fragment', function () {
partialFragment = fragmentTracker.getPartialFragment(1.5);
expect(partialFragment).to.not.exist;
@@ -99,7 +101,7 @@ describe('FragmentTracker', function () {
level: 0,
type: 'main'
}, ['audio', 'video']);
- hls.trigger(Event.FRAG_LOADED, { frag: fragment });
+ hls.trigger(Events.FRAG_LOADED, { frag: fragment });
};
it('detects fragments that never loaded', function () {
@@ -119,9 +121,9 @@ describe('FragmentTracker', function () {
timeRanges = {};
timeRanges.video = buffered;
timeRanges.audio = buffered;
- hls.trigger(Event.BUFFER_APPENDED, { timeRanges });
+ hls.trigger(Events.BUFFER_APPENDED, { timeRanges });
- hls.trigger(Event.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
+ hls.trigger(Events.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
expect(fragmentTracker.getState(fragment)).to.equal(FragmentState.OK);
});
@@ -137,9 +139,9 @@ describe('FragmentTracker', function () {
timeRanges = {};
timeRanges.video = buffered;
timeRanges.audio = buffered;
- hls.trigger(Event.BUFFER_APPENDED, { timeRanges });
+ hls.trigger(Events.BUFFER_APPENDED, { timeRanges });
- hls.trigger(Event.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
+ hls.trigger(Events.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
expect(fragmentTracker.getState(fragment)).to.equal(FragmentState.PARTIAL);
});
@@ -155,9 +157,9 @@ describe('FragmentTracker', function () {
timeRanges = {};
timeRanges.video = buffered;
timeRanges.audio = buffered;
- hls.trigger(Event.BUFFER_APPENDED, { timeRanges });
+ hls.trigger(Events.BUFFER_APPENDED, { timeRanges });
- hls.trigger(Event.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
+ hls.trigger(Events.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
expect(fragmentTracker.getState(fragment)).to.equal(FragmentState.PARTIAL);
@@ -171,7 +173,7 @@ describe('FragmentTracker', function () {
timeRanges = {};
timeRanges.video = buffered;
timeRanges.audio = buffered;
- hls.trigger(Event.BUFFER_APPENDED, { timeRanges });
+ hls.trigger(Events.BUFFER_APPENDED, { timeRanges });
expect(fragmentTracker.getState(fragment)).to.equal(FragmentState.NOT_LOADED);
});
@@ -303,7 +305,7 @@ describe('FragmentTracker', function () {
level: 1,
type: 'main'
}, ['audio', 'video']);
- hls.trigger(Event.FRAG_LOADED, { frag: fragment });
+ hls.trigger(Events.FRAG_LOADED, { frag: fragment });
timeRanges = {};
timeRanges.video = createMockBuffer([
@@ -318,9 +320,9 @@ describe('FragmentTracker', function () {
endPTS: 2
}
]);
- hls.trigger(Event.BUFFER_APPENDED, { timeRanges });
+ hls.trigger(Events.BUFFER_APPENDED, { timeRanges });
- hls.trigger(Event.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
+ hls.trigger(Events.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
expect(fragmentTracker.getState(fragment)).to.equal(FragmentState.PARTIAL);
});
@@ -333,7 +335,7 @@ describe('FragmentTracker', function () {
level: 1,
type: 'main'
}, ['audio', 'video']);
- hls.trigger(Event.FRAG_LOADED, { frag: fragment });
+ hls.trigger(Events.FRAG_LOADED, { frag: fragment });
timeRanges = {};
timeRanges.video = createMockBuffer([
@@ -348,9 +350,9 @@ describe('FragmentTracker', function () {
endPTS: 2
}
]);
- hls.trigger(Event.BUFFER_APPENDED, { timeRanges });
+ hls.trigger(Events.BUFFER_APPENDED, { timeRanges });
- hls.trigger(Event.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
+ hls.trigger(Events.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
expect(fragmentTracker.getState(fragment)).to.equal(FragmentState.PARTIAL);
});
@@ -363,7 +365,7 @@ describe('FragmentTracker', function () {
level: 1,
type: 'audio'
}, ['audio']);
- hls.trigger(Event.FRAG_LOADED, { frag: fragment });
+ hls.trigger(Events.FRAG_LOADED, { frag: fragment });
timeRanges = {};
timeRanges.video = createMockBuffer([
@@ -378,9 +380,9 @@ describe('FragmentTracker', function () {
endPTS: 2
}
]);
- hls.trigger(Event.BUFFER_APPENDED, { timeRanges });
+ hls.trigger(Events.BUFFER_APPENDED, { timeRanges });
- hls.trigger(Event.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
+ hls.trigger(Events.FRAG_BUFFERED, { stats: { aborted: true }, id: 'main', frag: fragment });
expect(fragmentTracker.getState(fragment)).to.equal(FragmentState.OK);
});
diff --git a/tests/unit/controller/gap-controller.js b/tests/unit/controller/gap-controller.js
index ebb6e7e24d7..94de5494e33 100644
--- a/tests/unit/controller/gap-controller.js
+++ b/tests/unit/controller/gap-controller.js
@@ -1,7 +1,7 @@
import Hls from '../../../src/hls';
import GapController, { SKIP_BUFFER_RANGE_START } from '../../../src/controller/gap-controller';
import { FragmentTracker } from '../../../src/controller/fragment-tracker';
-import Event from '../../../src/events';
+import { Events } from '../../../src/events';
import { ErrorTypes, ErrorDetails } from '../../../src/errors';
describe('GapController', function () {
@@ -33,7 +33,7 @@ describe('GapController', function () {
expect(media.currentTime).to.equal(expected);
}
- expect(triggerSpy).to.have.been.calledWith(Event.ERROR, {
+ expect(triggerSpy).to.have.been.calledWith(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.BUFFER_NUDGE_ON_STALL,
fatal: false
@@ -44,7 +44,7 @@ describe('GapController', function () {
config.nudgeMaxRetry = 0;
gapController._tryNudgeBuffer();
expect(media.currentTime).to.equal(0);
- expect(triggerSpy).to.have.been.calledWith(Event.ERROR, {
+ expect(triggerSpy).to.have.been.calledWith(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.BUFFER_STALLED_ERROR,
fatal: true
@@ -55,7 +55,7 @@ describe('GapController', function () {
describe('_reportStall', function () {
it('should report a stall with the current buffer length if it has not already been reported', function () {
gapController._reportStall(42);
- expect(triggerSpy).to.have.been.calledWith(Event.ERROR, {
+ expect(triggerSpy).to.have.been.calledWith(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.BUFFER_STALLED_ERROR,
fatal: false,
diff --git a/tests/unit/controller/level-controller.js b/tests/unit/controller/level-controller.js
index ce382b5b221..d65eee0f4c7 100644
--- a/tests/unit/controller/level-controller.js
+++ b/tests/unit/controller/level-controller.js
@@ -1,6 +1,6 @@
import LevelController from '../../../src/controller/level-controller';
import HlsMock from '../../mocks/hls.mock';
-import Event from '../../../src/events';
+import { Events } from '../../../src/events';
import { ErrorDetails, ErrorTypes } from '../../../src/errors';
import { Level } from '../../../src/types/level';
@@ -41,11 +41,11 @@ describe('LevelController', function () {
const nextLevel = 1;
- levelController.onManifestLoaded(data);
+ levelController.onManifestLoaded(Events.MANIFEST_LOADED, data);
// First triggers "hlsManifestParsed"
levelController.level = nextLevel;
// Then triggers "levelSwitching"
- expect(triggerSpy).to.have.been.calledWith(Event.LEVEL_SWITCHING, {
+ expect(triggerSpy).to.have.been.calledWith(Events.LEVEL_SWITCHING, {
attrs: undefined,
audioCodec: undefined,
audioGroupIds: undefined,
@@ -70,7 +70,7 @@ describe('LevelController', function () {
describe('onManifestLoaded handler', function () {
it('should trigger an error when no levels are found in the manifest', function () {
- levelController.onManifestLoaded({
+ levelController.onManifestLoaded(Events.MANIFEST_LOADED, {
audioTracks: [],
levels: [],
networkDetails: '',
@@ -78,7 +78,7 @@ describe('LevelController', function () {
url: 'https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8'
});
- expect(triggerSpy).to.have.been.calledWith(Event.ERROR, {
+ expect(triggerSpy).to.have.been.calledWith(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.MANIFEST_INCOMPATIBLE_CODECS_ERROR,
fatal: true,
@@ -104,9 +104,9 @@ describe('LevelController', function () {
url: 'https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8'
};
- levelController.onManifestLoaded(data);
+ levelController.onManifestLoaded(Events.MANIFEST_LOADED, data);
- expect(triggerSpy).to.have.been.calledWith(Event.MANIFEST_PARSED, {
+ expect(triggerSpy).to.have.been.calledWith(Events.MANIFEST_PARSED, {
altAudio: false,
audio: false,
audioTracks: [],
@@ -131,8 +131,8 @@ describe('LevelController', function () {
url: 'https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8'
};
- levelController.onManifestLoaded(data);
- expect(triggerSpy).to.have.been.calledWith(Event.MANIFEST_PARSED, {
+ levelController.onManifestLoaded(Events.MANIFEST_LOADED, data);
+ expect(triggerSpy).to.have.been.calledWith(Events.MANIFEST_PARSED, {
altAudio: true,
audio: false,
audioTracks: [],
@@ -158,10 +158,10 @@ describe('LevelController', function () {
it('signals video if there is a videoCodec signaled', function () {
data.levels[0].videoCodec = 'avc1.42e01e';
- levelController.onManifestLoaded(data);
+ levelController.onManifestLoaded(Events.MANIFEST_LOADED, data);
const { name, payload } = hls.getEventData(0);
- expect(name).to.equal(Event.MANIFEST_PARSED);
+ expect(name).to.equal(Events.MANIFEST_PARSED);
expect(payload.video).to.equal(true);
expect(payload.audio).to.equal(false);
expect(payload.altAudio).to.equal(false);
@@ -169,10 +169,10 @@ describe('LevelController', function () {
it('signals audio if there is an audioCodec signaled', function () {
data.levels[0].audioCodec = 'mp4a.40.5';
- levelController.onManifestLoaded(data);
+ levelController.onManifestLoaded(Events.MANIFEST_LOADED, data);
const { name, payload } = hls.getEventData(0);
- expect(name).to.equal(Event.MANIFEST_PARSED);
+ expect(name).to.equal(Events.MANIFEST_PARSED);
expect(payload.video).to.equal(false);
expect(payload.audio).to.equal(true);
expect(payload.altAudio).to.equal(false);
@@ -184,10 +184,10 @@ describe('LevelController', function () {
AUDIO: true
}
}];
- levelController.onManifestLoaded(data);
+ levelController.onManifestLoaded(Events.MANIFEST_LOADED, data);
const { name, payload } = hls.getEventData(0);
- expect(name).to.equal(Event.MANIFEST_PARSED);
+ expect(name).to.equal(Events.MANIFEST_PARSED);
expect(payload.video).to.equal(false);
expect(payload.audio).to.equal(true);
expect(payload.altAudio).to.equal(false);
@@ -217,10 +217,10 @@ describe('LevelController', function () {
}
];
- levelController.onManifestLoaded(data);
+ levelController.onManifestLoaded(Events.MANIFEST_LOADED, data);
const { name, payload } = hls.getEventData(0);
- expect(name).to.equal(Event.MANIFEST_PARSED);
+ expect(name).to.equal(Events.MANIFEST_PARSED);
expect(payload.video).to.equal(true);
expect(payload.audio).to.equal(false);
expect(payload.altAudio).to.equal(true);
@@ -249,10 +249,10 @@ describe('LevelController', function () {
}
];
- levelController.onManifestLoaded(data);
+ levelController.onManifestLoaded(Events.MANIFEST_LOADED, data);
const { name, payload } = hls.getEventData(0);
- expect(name).to.equal(Event.MANIFEST_PARSED);
+ expect(name).to.equal(Events.MANIFEST_PARSED);
expect(payload.video).to.equal(true);
expect(payload.audio).to.equal(false);
expect(payload.altAudio).to.equal(false);
diff --git a/tests/unit/controller/stream-controller.js b/tests/unit/controller/stream-controller.js
index 10091a98111..424dcb76c2f 100644
--- a/tests/unit/controller/stream-controller.js
+++ b/tests/unit/controller/stream-controller.js
@@ -1,5 +1,5 @@
import Hls from '../../../src/hls';
-import Event from '../../../src/events';
+import { Events } from '../../../src/events';
import { FragmentTracker, FragmentState } from '../../../src/controller/fragment-tracker';
import StreamController from '../../../src/controller/stream-controller';
import { State } from '../../../src/controller/base-stream-controller';
@@ -54,7 +54,7 @@ describe('StreamController', function () {
http://proxy-62.dailymotion.com/sec(3ae40f708f79ca9471f52b86da76a3a8)/video/107/282/158282701_mp4_h264_aac_hq.m3u8#cell=core`;
const levels = M3U8Parser.parseMasterPlaylist(manifest, 'http://www.dailymotion.com');
// load levels data
- streamController.onManifestParsed({
+ streamController.onManifestParsed(Events.MANIFEST_PARSED, {
levels
});
streamController.startLoad(1);
@@ -141,7 +141,7 @@ describe('StreamController', function () {
});
function assertLoadingState (frag) {
- expect(triggerSpy).to.have.been.calledWith(Event.FRAG_LOADING, { frag });
+ expect(triggerSpy).to.have.been.calledWith(Events.FRAG_LOADING, { frag });
expect(streamController.state).to.equal(State.FRAG_LOADING);
}
diff --git a/tests/unit/controller/subtitle-stream-controller.js b/tests/unit/controller/subtitle-stream-controller.js
index 898af2e0c38..1f117e95f6d 100644
--- a/tests/unit/controller/subtitle-stream-controller.js
+++ b/tests/unit/controller/subtitle-stream-controller.js
@@ -1,7 +1,7 @@
import sinon from 'sinon';
import Hls from '../../../src/hls';
-import Event from '../../../src/events';
+import { Events } from '../../../src/events';
import { FragmentTracker } from '../../../src/controller/fragment-tracker';
import { SubtitleStreamController } from '../../../src/controller/subtitle-stream-controller';
@@ -26,16 +26,16 @@ describe('SubtitleStreamController', function () {
fragmentTracker = new FragmentTracker(hls);
subtitleStreamController = new SubtitleStreamController(hls, fragmentTracker);
- subtitleStreamController.onMediaAttached({ media: mediaMock });
+ subtitleStreamController.onMediaAttached(Events.MEDIA_ATTACHED, { media: mediaMock });
});
afterEach(function () {
- subtitleStreamController.onMediaDetaching({ media: mediaMock });
+ subtitleStreamController.onMediaDetaching(Events.MEDIA_DETACHING, { media: mediaMock });
});
describe('onSubtitleTracksUpdate', function () {
beforeEach(function () {
- hls.trigger(Event.SUBTITLE_TRACKS_UPDATED, {
+ hls.trigger(Events.SUBTITLE_TRACKS_UPDATED, {
subtitleTracks: tracksMock
});
});
@@ -53,7 +53,7 @@ describe('SubtitleStreamController', function () {
subtitleStreamController.clearInterval = sinon.spy();
subtitleStreamController.setInterval = sinon.spy();
- hls.trigger(Event.SUBTITLE_TRACK_SWITCH, {
+ hls.trigger(Events.SUBTITLE_TRACK_SWITCH, {
id: 0
});
});
@@ -64,14 +64,14 @@ describe('SubtitleStreamController', function () {
it('should call clearInterval if no tracks present', function () {
subtitleStreamController.levels = [];
- hls.trigger(Event.SUBTITLE_TRACK_SWITCH, {
+ hls.trigger(Events.SUBTITLE_TRACK_SWITCH, {
id: 0
});
expect(subtitleStreamController.clearInterval).to.have.been.calledOnce;
});
it('should call clearInterval if new track id === -1', function () {
- hls.trigger(Event.SUBTITLE_TRACK_SWITCH, {
+ hls.trigger(Events.SUBTITLE_TRACK_SWITCH, {
id: -1
});
expect(subtitleStreamController.clearInterval).to.have.been.calledOnce;
@@ -88,8 +88,9 @@ describe('SubtitleStreamController', function () {
it('should handle the event if the data matches the current track', function () {
const details = { foo: 'bar' };
subtitleStreamController.currentTrackId = 1;
- hls.trigger(Event.SUBTITLE_TRACK_LOADED, {
- id: 1, details
+ hls.trigger(Events.SUBTITLE_TRACK_LOADED, {
+ id: 1,
+ details: details
});
expect(subtitleStreamController.levels[1].details).to.equal(details);
expect(subtitleStreamController.setInterval).to.have.been.calledOnce;
@@ -98,7 +99,7 @@ describe('SubtitleStreamController', function () {
it('should ignore the event if the data does not match the current track', function () {
const details = { foo: 'bar' };
subtitleStreamController.currentTrackId = 0;
- hls.trigger(Event.SUBTITLE_TRACK_LOADED, {
+ hls.trigger(Events.SUBTITLE_TRACK_LOADED, {
id: 1, details
});
expect(subtitleStreamController.levels[0].details).to.not.equal(details);
@@ -109,7 +110,7 @@ describe('SubtitleStreamController', function () {
subtitleStreamController.levels = [];
subtitleStreamController.trackId = 0;
const details = { foo: 'bar' };
- hls.trigger(Event.SUBTITLE_TRACK_LOADED, {
+ hls.trigger(Events.SUBTITLE_TRACK_LOADED, {
id: 0, details
});
expect(subtitleStreamController.levels[0]).to.not.exist;
@@ -119,12 +120,12 @@ describe('SubtitleStreamController', function () {
describe('onLevelLoaded', function () {
it('records the start time of the last known A/V track', function () {
- hls.trigger(Event.LEVEL_UPDATED, {
+ hls.trigger(Events.LEVEL_UPDATED, {
details: { fragments: [{ start: 5 }] }
});
expect(subtitleStreamController.lastAVStart).to.equal(5);
- hls.trigger(Event.LEVEL_UPDATED, {
+ hls.trigger(Events.LEVEL_UPDATED, {
details: { fragments: [] }
});
expect(subtitleStreamController.lastAVStart).to.equal(0);
diff --git a/tests/unit/controller/subtitle-track-controller.js b/tests/unit/controller/subtitle-track-controller.js
index 12efd8fe92b..9080019c4b4 100644
--- a/tests/unit/controller/subtitle-track-controller.js
+++ b/tests/unit/controller/subtitle-track-controller.js
@@ -3,6 +3,7 @@ import Hls from '../../../src/hls';
import sinon from 'sinon';
import LoadStats from '../../../src/loader/load-stats';
import LevelDetails from '../../../src/loader/level-details';
+import { Events } from '../../../src/events';
describe('SubtitleTrackController', function () {
let subtitleTrackController;
@@ -180,17 +181,17 @@ describe('SubtitleTrackController', function () {
subtitleTrackController.trackId = 1;
const mockLoadedEvent = { id: 999, details: { foo: 'bar' } };
- subtitleTrackController.onSubtitleTrackLoaded(mockLoadedEvent);
+ subtitleTrackController.onSubtitleTrackLoaded(Events.SUBTITLE_TRACK_LOADED, mockLoadedEvent);
expect(subtitleTrackController.timer).to.not.exist;
expect(clearReloadSpy).to.have.been.calledOnce;
mockLoadedEvent.id = 0;
- subtitleTrackController.onSubtitleTrackLoaded(mockLoadedEvent);
+ subtitleTrackController.onSubtitleTrackLoaded(Events.SUBTITLE_TRACK_LOADED, mockLoadedEvent);
expect(subtitleTrackController.timer).to.not.exist;
expect(clearReloadSpy).to.have.been.calledTwice;
mockLoadedEvent.id = 1;
- subtitleTrackController.onSubtitleTrackLoaded(mockLoadedEvent);
+ subtitleTrackController.onSubtitleTrackLoaded(Events.SUBTITLE_TRACK_LOADED, mockLoadedEvent);
tracks[1] = null;
expect(subtitleTrackController.timer).to.not.exist;
expect(clearReloadSpy).to.have.been.calledThrice;
@@ -200,7 +201,7 @@ describe('SubtitleTrackController', function () {
const details = new LevelDetails('');
subtitleTrackController.stopped = true;
subtitleTrackController.trackId = 1;
- subtitleTrackController.onSubtitleTrackLoaded({ id: 1, details, stats: new LoadStats() });
+ subtitleTrackController.onSubtitleTrackLoaded(Events.SUBTITLE_TRACK_LOADED, { id: 1, details, stats: new LoadStats() });
expect(subtitleTrackController.timer).to.not.exist;
});
@@ -208,7 +209,7 @@ describe('SubtitleTrackController', function () {
const details = new LevelDetails('');
subtitleTrackController.stopped = false;
subtitleTrackController.trackId = 1;
- subtitleTrackController.onSubtitleTrackLoaded({ id: 1, details, stats: new LoadStats() });
+ subtitleTrackController.onSubtitleTrackLoaded(Events.SUBTITLE_TRACK_LOADED, { id: 1, details, stats: new LoadStats() });
expect(subtitleTrackController.timer).to.exist;
});
@@ -217,7 +218,7 @@ describe('SubtitleTrackController', function () {
details.live = false;
subtitleTrackController.trackId = 1;
subtitleTrackController.timer = self.setTimeout(() => {}, 0);
- subtitleTrackController.onSubtitleTrackLoaded({ id: 1, details, stats: new LoadStats() });
+ subtitleTrackController.onSubtitleTrackLoaded(Events.SUBTITLE_TRACK_LOADED, { id: 1, details, stats: new LoadStats() });
expect(subtitleTrackController.timer).to.not.exist;
});
});
diff --git a/tests/unit/controller/timeline-controller-nonnative.js b/tests/unit/controller/timeline-controller-nonnative.js
index c44f6f3b48b..2e4295d1f55 100644
--- a/tests/unit/controller/timeline-controller-nonnative.js
+++ b/tests/unit/controller/timeline-controller-nonnative.js
@@ -33,7 +33,6 @@ describe('Non-Native TimelineController functions', function () {
it('fires the NON_NATIVE_TEXT_TRACKS_FOUND event', function (done) {
hls.on(Hls.Events.NON_NATIVE_TEXT_TRACKS_FOUND, (event, data) => {
const track = data.tracks[0];
- expect(track._id).to.equal('textTrack1');
expect(track.kind).to.equal('captions');
expect(track.default).to.equal(false);
expect(track.label).to.equal(timelineController.captionsProperties.textTrack1.label);
diff --git a/tests/unit/controller/timeline-controller.js b/tests/unit/controller/timeline-controller.js
index 9bd78cc2951..e00fefb9f85 100644
--- a/tests/unit/controller/timeline-controller.js
+++ b/tests/unit/controller/timeline-controller.js
@@ -1,5 +1,6 @@
import TimelineController from '../../../src/controller/timeline-controller';
import Hls from '../../../src/hls';
+import { Events } from '../../../src/events';
describe('TimelineController', function () {
let timelineController;
@@ -16,7 +17,7 @@ describe('TimelineController', function () {
it('should set default track to showing when displaySubtitles is true', function () {
hls.subtitleTrackController = { subtitleDisplay: true };
- timelineController.onManifestLoaded({
+ timelineController.onManifestLoaded(Events.MANIFEST_LOADED, {
subtitles: [{ id: 0 }, { id: 1, default: true }]
});
@@ -27,7 +28,7 @@ describe('TimelineController', function () {
it('should set default track to hidden when displaySubtitles is false', function () {
hls.subtitleTrackController = { subtitleDisplay: false };
- timelineController.onManifestLoaded({
+ timelineController.onManifestLoaded(Events.MANIFEST_LOADED, {
subtitles: [{ id: 0 }, { id: 1, default: true }]
});
@@ -39,7 +40,7 @@ describe('TimelineController', function () {
it('should reuse text track when track order is same between manifests', function () {
hls.subtitleTrackController = { subtitleDisplay: false };
- timelineController.onManifestLoaded({
+ timelineController.onManifestLoaded(Events.MANIFEST_LOADED, {
subtitles: [{ id: 0, name: 'en' }, { id: 1, name: 'ru' }]
});
@@ -52,7 +53,7 @@ describe('TimelineController', function () {
expect(timelineController.media.textTracks[1].label).to.equal('ru');
expect(timelineController.media.textTracks.length).to.equal(2);
- timelineController.onManifestLoaded({
+ timelineController.onManifestLoaded(Events.MANIFEST_LOADED, {
subtitles: [{ id: 0, name: 'en' }, { id: 1, name: 'ru' }]
});
@@ -69,7 +70,7 @@ describe('TimelineController', function () {
it('should reuse text track when track order is not same between manifests', function () {
hls.subtitleTrackController = { subtitleDisplay: false };
- timelineController.onManifestLoaded({
+ timelineController.onManifestLoaded(Events.MANIFEST_LOADED, {
subtitles: [{ id: 0, name: 'en' }, { id: 1, name: 'ru' }]
});
@@ -82,7 +83,7 @@ describe('TimelineController', function () {
expect(timelineController.media.textTracks[1].label).to.equal('ru');
expect(timelineController.media.textTracks.length).to.equal(2);
- timelineController.onManifestLoaded({
+ timelineController.onManifestLoaded(Events.MANIFEST_LOADED, {
subtitles: [{ id: 0, name: 'ru' }, { id: 1, name: 'en' }]
});
diff --git a/tests/unit/demuxer/transmuxer.js b/tests/unit/demuxer/transmuxer.js
index bd2b1e74c78..c7c37e8aaf1 100644
--- a/tests/unit/demuxer/transmuxer.js
+++ b/tests/unit/demuxer/transmuxer.js
@@ -17,7 +17,7 @@ describe('TransmuxerInterface tests', function () {
expect(transmuxerInterface.hls).to.equal(hls, 'Hls object created');
expect(transmuxerInterface.id).to.equal(id, 'Id has been set up');
- expect(transmuxerInterface.observer.trigger).to.exist;
+ expect(transmuxerInterface.observer.emit).to.exist;
expect(transmuxerInterface.observer.off).to.exist;
expect(transmuxerInterface.transmuxer).to.exist;
});
@@ -34,7 +34,7 @@ describe('TransmuxerInterface tests', function () {
expect(transmuxerInterface.hls).to.equal(hls, 'Hls object created');
expect(transmuxerInterface.id).to.equal(id, 'Id has been set up');
- expect(transmuxerInterface.observer.trigger, 'trigger exists').to.exist;
+ expect(transmuxerInterface.observer.emit, 'emit exists').to.exist;
expect(transmuxerInterface.observer.off, 'off exists').to.exist;
expect(transmuxerInterface.worker, 'worker exists').to.exist;
});
diff --git a/tests/unit/events.js b/tests/unit/events.js
index 211c0103e41..d2dc8d44b2f 100644
--- a/tests/unit/events.js
+++ b/tests/unit/events.js
@@ -1,4 +1,4 @@
-import Events from '../../src/events';
+import { Events } from '../../src/events';
function getAllCapsSnakeCaseToCamelCase (eventType) {
let eventValue = '';
diff --git a/tests/unit/hls.js b/tests/unit/hls.js
index d67e73b984c..96cb22d0dac 100644
--- a/tests/unit/hls.js
+++ b/tests/unit/hls.js
@@ -7,7 +7,7 @@ describe('Hls', function () {
const MOCKED_ESTIMATE = 2000;
const hls = new Hls();
hls.abrController = {
- _bwEstimator: {
+ bwEstimator: {
getEstimate: () => MOCKED_ESTIMATE
}
};
diff --git a/webpack.config.js b/webpack.config.js
index 1bce9c7ac66..9e92d88e7c9 100644
--- a/webpack.config.js
+++ b/webpack.config.js
@@ -81,7 +81,8 @@ const baseConfig = {
}
}
},
- ['@babel/plugin-transform-object-assign']
+ ['@babel/plugin-transform-object-assign'],
+ ['@babel/plugin-proposal-optional-chaining']
]
}
}