1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
|
// Thanks https://github.com/streamroot/videojs-hlsjs-plugin
// We duplicated this plugin to choose the hls.js version we want, because streamroot only provide a bundled file
import * as Hlsjs from 'hls.js/dist/hls.light.js'
import videojs from 'video.js'
import { HlsjsConfigHandlerOptions, QualityLevelRepresentation, QualityLevels, VideoJSTechHLS } from '../peertube-videojs-typings'
type ErrorCounts = {
[ type: string ]: number
}
type Metadata = {
levels: Hlsjs.Level[]
}
type CustomAudioTrack = Hlsjs.HlsAudioTrack & { name?: string, lang?: string }
const registerSourceHandler = function (vjs: typeof videojs) {
if (!Hlsjs.isSupported()) {
console.warn('Hls.js is not supported in this browser!')
return
}
const html5 = vjs.getTech('Html5')
if (!html5) {
console.error('Not supported version if video.js')
return
}
// FIXME: typings
(html5 as any).registerSourceHandler({
canHandleSource: function (source: videojs.Tech.SourceObject) {
const hlsTypeRE = /^application\/x-mpegURL|application\/vnd\.apple\.mpegurl$/i
const hlsExtRE = /\.m3u8/i
if (hlsTypeRE.test(source.type)) return 'probably'
if (hlsExtRE.test(source.src)) return 'maybe'
return ''
},
handleSource: function (source: videojs.Tech.SourceObject, tech: VideoJSTechHLS) {
if (tech.hlsProvider) {
tech.hlsProvider.dispose()
}
tech.hlsProvider = new Html5Hlsjs(vjs, source, tech)
return tech.hlsProvider
}
}, 0);
// FIXME: typings
(vjs as any).Html5Hlsjs = Html5Hlsjs
}
function hlsjsConfigHandler (this: videojs.Player, options: HlsjsConfigHandlerOptions) {
const player = this
if (!options) return
if (!player.srOptions_) {
player.srOptions_ = {}
}
if (!player.srOptions_.hlsjsConfig) {
player.srOptions_.hlsjsConfig = options.hlsjsConfig
}
if (!player.srOptions_.captionConfig) {
player.srOptions_.captionConfig = options.captionConfig
}
if (options.levelLabelHandler && !player.srOptions_.levelLabelHandler) {
player.srOptions_.levelLabelHandler = options.levelLabelHandler
}
}
const registerConfigPlugin = function (vjs: typeof videojs) {
// Used in Brightcove since we don't pass options directly there
const registerVjsPlugin = vjs.registerPlugin || vjs.plugin
registerVjsPlugin('hlsjs', hlsjsConfigHandler)
}
class Html5Hlsjs {
private static readonly hooks: { [id: string]: Function[] } = {}
private readonly videoElement: HTMLVideoElement
private readonly errorCounts: ErrorCounts = {}
private readonly player: videojs.Player
private readonly tech: videojs.Tech
private readonly source: videojs.Tech.SourceObject
private readonly vjs: typeof videojs
private hls: Hlsjs & { manualLevel?: number, audioTrack?: any, audioTracks?: CustomAudioTrack[] } // FIXME: typings
private hlsjsConfig: Partial<Hlsjs.Config & { cueHandler: any }> = null
private _duration: number = null
private metadata: Metadata = null
private isLive: boolean = null
private dvrDuration: number = null
private edgeMargin: number = null
private handlers: { [ id in 'play' | 'addtrack' | 'playing' | 'textTracksChange' | 'audioTracksChange' ]: EventListener } = {
play: null,
addtrack: null,
playing: null,
textTracksChange: null,
audioTracksChange: null
}
private uiTextTrackHandled = false
constructor (vjs: typeof videojs, source: videojs.Tech.SourceObject, tech: videojs.Tech) {
this.vjs = vjs
this.source = source
this.tech = tech;
(this.tech as any).name_ = 'Hlsjs'
this.videoElement = tech.el() as HTMLVideoElement
this.player = vjs((tech.options_ as any).playerId)
this.videoElement.addEventListener('error', event => {
let errorTxt: string
const mediaError = ((event.currentTarget || event.target) as HTMLVideoElement).error
if (!mediaError) return
console.log(mediaError)
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'
this._handleMediaError(mediaError)
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
default:
errorTxt = mediaError.message
}
console.error('MEDIA_ERROR: ', errorTxt)
})
this.initialize()
}
duration () {
return this._duration || this.videoElement.duration || 0
}
seekable () {
if (this.hls.media) {
if (!this.isLive) {
return this.vjs.createTimeRanges(0, this.hls.media.duration)
}
// Video.js doesn't seem to like floating point timeranges
const startTime = Math.round(this.hls.media.duration - this.dvrDuration)
const endTime = Math.round(this.hls.media.duration - this.edgeMargin)
return this.vjs.createTimeRanges(startTime, endTime)
}
return this.vjs.createTimeRanges()
}
// See comment for `initialize` method.
dispose () {
this.videoElement.removeEventListener('play', this.handlers.play)
this.videoElement.textTracks.removeEventListener('addtrack', this.handlers.addtrack)
this.videoElement.removeEventListener('playing', this.handlers.playing)
this.player.textTracks().removeEventListener('change', this.handlers.textTracksChange)
this.uiTextTrackHandled = false
this.hls.destroy()
}
static addHook (type: string, callback: Function) {
Html5Hlsjs.hooks[ type ] = this.hooks[ type ] || []
Html5Hlsjs.hooks[ type ].push(callback)
}
static removeHook (type: string, callback: Function) {
if (Html5Hlsjs.hooks[ type ] === undefined) return false
const index = Html5Hlsjs.hooks[ type ].indexOf(callback)
if (index === -1) return false
Html5Hlsjs.hooks[ type ].splice(index, 1)
return true
}
private _executeHooksFor (type: string) {
if (Html5Hlsjs.hooks[ type ] === undefined) {
return
}
// ES3 and IE < 9
for (let i = 0; i < Html5Hlsjs.hooks[ type ].length; i++) {
Html5Hlsjs.hooks[ type ][ i ](this.player, this.hls)
}
}
private _handleMediaError (error: any) {
if (this.errorCounts[ Hlsjs.ErrorTypes.MEDIA_ERROR ] === 1) {
console.info('trying to recover media error')
this.hls.recoverMediaError()
return
}
if (this.errorCounts[ Hlsjs.ErrorTypes.MEDIA_ERROR ] === 2) {
console.info('2nd try to recover media error (by swapping audio codec')
this.hls.swapAudioCodec()
this.hls.recoverMediaError()
return
}
if (this.errorCounts[ Hlsjs.ErrorTypes.MEDIA_ERROR ] > 2) {
console.info('bubbling media error up to VIDEOJS')
this.hls.destroy()
this.tech.error = () => error
this.tech.trigger('error')
return
}
}
private _handleNetworkError (error: any) {
if (this.errorCounts[ Hlsjs.ErrorTypes.NETWORK_ERROR] <= 5) {
console.info('trying to recover network error')
// Wait 1 second and retry
setTimeout(() => this.hls.startLoad(), 1000)
// Reset error count on success
this.hls.once(Hlsjs.Events.FRAG_LOADED, () => {
this.errorCounts[ Hlsjs.ErrorTypes.NETWORK_ERROR] = 0
})
return
}
console.info('bubbling network error up to VIDEOJS')
this.hls.destroy()
this.tech.error = () => error
this.tech.trigger('error')
}
private _onError (_event: any, data: Hlsjs.errorData) {
const error: { message: string, code?: number } = {
message: `HLS.js error: ${data.type} - fatal: ${data.fatal} - ${data.details}`
}
console.error(error.message)
// increment/set error count
if (this.errorCounts[ data.type ]) this.errorCounts[ data.type ] += 1
else this.errorCounts[ data.type ] = 1
if (!data.fatal) return
if (data.type === Hlsjs.ErrorTypes.NETWORK_ERROR) {
error.code = 2
this._handleNetworkError(error)
} else if (data.type === Hlsjs.ErrorTypes.MEDIA_ERROR && data.details !== 'manifestIncompatibleCodecsError') {
error.code = 3
this._handleMediaError(error)
} else {
this.hls.destroy()
console.info('bubbling error up to VIDEOJS')
this.tech.error = () => error as any
this.tech.trigger('error')
}
}
private switchQuality (qualityId: number) {
this.hls.nextLevel = qualityId
}
private _levelLabel (level: Hlsjs.Level) {
if (this.player.srOptions_.levelLabelHandler) {
return this.player.srOptions_.levelLabelHandler(level)
}
if (level.height) return level.height + 'p'
if (level.width) return Math.round(level.width * 9 / 16) + 'p'
if (level.bitrate) return (level.bitrate / 1000) + 'kbps'
return 0
}
private _relayQualityChange (qualityLevels: QualityLevels) {
// Determine if it is "Auto" (all tracks enabled)
let isAuto = true
for (let i = 0; i < qualityLevels.length; i++) {
if (!qualityLevels[ i ]._enabled) {
isAuto = false
break
}
}
// Interact with ME
if (isAuto) {
this.hls.currentLevel = -1
return
}
// Find ID of highest enabled track
let selectedTrack: number
for (selectedTrack = qualityLevels.length - 1; selectedTrack >= 0; selectedTrack--) {
if (qualityLevels[ selectedTrack ]._enabled) {
break
}
}
this.hls.currentLevel = selectedTrack
}
private _handleQualityLevels () {
if (!this.metadata) return
const qualityLevels = this.player.qualityLevels && this.player.qualityLevels()
if (!qualityLevels) return
for (let i = 0; i < this.metadata.levels.length; i++) {
const details = this.metadata.levels[ i ]
const representation: QualityLevelRepresentation = {
id: i,
width: details.width,
height: details.height,
bandwidth: details.bitrate,
bitrate: details.bitrate,
_enabled: true
}
const self = this
representation.enabled = function (this: QualityLevels, level: number, toggle?: boolean) {
// Brightcove switcher works TextTracks-style (enable tracks that it wants to ABR on)
if (typeof toggle === 'boolean') {
this[ level ]._enabled = toggle
self._relayQualityChange(this)
}
return this[ level ]._enabled
}
qualityLevels.addQualityLevel(representation)
}
}
private _notifyVideoQualities () {
if (!this.metadata) return
const cleanTracklist = []
if (this.metadata.levels.length > 1) {
const autoLevel = {
id: -1,
label: 'auto',
selected: this.hls.manualLevel === -1
}
cleanTracklist.push(autoLevel)
}
this.metadata.levels.forEach((level, index) => {
// Don't write in level (shared reference with Hls.js)
const quality = {
id: index,
selected: index === this.hls.manualLevel,
label: this._levelLabel(level)
}
cleanTracklist.push(quality)
})
const payload = {
qualityData: { video: cleanTracklist },
qualitySwitchCallback: this.switchQuality.bind(this)
}
this.tech.trigger('loadedqualitydata', payload)
// Self-de-register so we don't raise the payload multiple times
this.videoElement.removeEventListener('playing', this.handlers.playing)
}
private _updateSelectedAudioTrack () {
const playerAudioTracks = this.tech.audioTracks()
for (let j = 0; j < playerAudioTracks.length; j++) {
// FIXME: typings
if ((playerAudioTracks[ j ] as any).enabled) {
this.hls.audioTrack = j
break
}
}
}
private _onAudioTracks () {
const hlsAudioTracks = this.hls.audioTracks
const playerAudioTracks = this.tech.audioTracks()
if (hlsAudioTracks.length > 1 && playerAudioTracks.length === 0) {
// Add Hls.js audio tracks if not added yet
for (let i = 0; i < hlsAudioTracks.length; i++) {
playerAudioTracks.addTrack(new this.vjs.AudioTrack({
id: i.toString(),
kind: 'alternative',
label: hlsAudioTracks[ i ].name || hlsAudioTracks[ i ].lang,
language: hlsAudioTracks[ i ].lang,
enabled: i === this.hls.audioTrack
}))
}
// Handle audio track change event
this.handlers.audioTracksChange = this._updateSelectedAudioTrack.bind(this)
playerAudioTracks.addEventListener('change', this.handlers.audioTracksChange)
}
}
private _getTextTrackLabel (textTrack: TextTrack) {
// Label here is readable label and is optional (used in the UI so if it is there it should be different)
return textTrack.label ? textTrack.label : textTrack.language
}
private _isSameTextTrack (track1: TextTrack, track2: TextTrack) {
return this._getTextTrackLabel(track1) === this._getTextTrackLabel(track2)
&& track1.kind === track2.kind
}
private _updateSelectedTextTrack () {
const playerTextTracks = this.player.textTracks()
let activeTrack: TextTrack = null
for (let j = 0; j < playerTextTracks.length; j++) {
if (playerTextTracks[ j ].mode === 'showing') {
activeTrack = playerTextTracks[ j ]
break
}
}
const hlsjsTracks = this.videoElement.textTracks
for (let k = 0; k < hlsjsTracks.length; k++) {
if (hlsjsTracks[ k ].kind === 'subtitles' || hlsjsTracks[ k ].kind === 'captions') {
hlsjsTracks[ k ].mode = activeTrack && this._isSameTextTrack(hlsjsTracks[ k ], activeTrack)
? 'showing'
: 'disabled'
}
}
}
private _startLoad () {
this.hls.startLoad(-1)
this.videoElement.removeEventListener('play', this.handlers.play)
}
private _oneLevelObjClone (obj: object) {
const result = {}
const objKeys = Object.keys(obj)
for (let i = 0; i < objKeys.length; i++) {
result[ objKeys[ i ] ] = obj[ objKeys[ i ] ]
}
return result
}
private _filterDisplayableTextTracks (textTracks: TextTrackList) {
const displayableTracks = []
// Filter out tracks that is displayable (captions or subtitles)
for (let idx = 0; idx < textTracks.length; idx++) {
if (textTracks[ idx ].kind === 'subtitles' || textTracks[ idx ].kind === 'captions') {
displayableTracks.push(textTracks[ idx ])
}
}
return displayableTracks
}
private _updateTextTrackList () {
const displayableTracks = this._filterDisplayableTextTracks(this.videoElement.textTracks)
const playerTextTracks = this.player.textTracks()
// Add stubs to make the caption switcher shows up
// Adding the Hls.js text track in will make us have double captions
for (let idx = 0; idx < displayableTracks.length; idx++) {
let isAdded = false
for (let jdx = 0; jdx < playerTextTracks.length; jdx++) {
if (this._isSameTextTrack(displayableTracks[ idx ], playerTextTracks[ jdx ])) {
isAdded = true
break
}
}
if (!isAdded) {
const hlsjsTextTrack = displayableTracks[ idx ]
this.player.addRemoteTextTrack({
kind: hlsjsTextTrack.kind as videojs.TextTrack.Kind,
label: this._getTextTrackLabel(hlsjsTextTrack),
language: hlsjsTextTrack.language,
srclang: hlsjsTextTrack.language
}, false)
}
}
// Handle UI switching
this._updateSelectedTextTrack()
if (!this.uiTextTrackHandled) {
this.handlers.textTracksChange = this._updateSelectedTextTrack.bind(this)
playerTextTracks.addEventListener('change', this.handlers.textTracksChange)
this.uiTextTrackHandled = true
}
}
private _onMetaData (_event: any, data: Hlsjs.manifestLoadedData) {
// This could arrive before 'loadedqualitydata' handlers is registered, remember it so we can raise it later
this.metadata = data as any
this._handleQualityLevels()
}
private _createCueHandler (captionConfig: any) {
return {
newCue: (track: any, startTime: number, endTime: number, captionScreen: { rows: any[] }) => {
let row: any
let cue: VTTCue
let text: string
const VTTCue = (window as any).VTTCue || (window as any).TextTrackCue
for (let r = 0; r < captionScreen.rows.length; r++) {
row = captionScreen.rows[ r ]
text = ''
if (!row.isEmpty()) {
for (let c = 0; c < row.chars.length; c++) {
text += row.chars[ c ].ucharj
}
cue = new VTTCue(startTime, endTime, text.trim())
// typeof null === 'object'
if (captionConfig != null && typeof captionConfig === 'object') {
// Copy client overridden property into the cue object
const configKeys = Object.keys(captionConfig)
for (let k = 0; k < configKeys.length; k++) {
cue[ configKeys[ k ] ] = captionConfig[ configKeys[ k ] ]
}
}
track.addCue(cue)
if (endTime === startTime) track.addCue(new VTTCue(endTime + 5, ''))
}
}
}
}
}
private _initHlsjs () {
const techOptions = this.tech.options_ as HlsjsConfigHandlerOptions
const srOptions_ = this.player.srOptions_
const hlsjsConfigRef = srOptions_ && srOptions_.hlsjsConfig || techOptions.hlsjsConfig
// Hls.js will write to the reference thus change the object for later streams
this.hlsjsConfig = hlsjsConfigRef ? this._oneLevelObjClone(hlsjsConfigRef) : {}
if ([ '', 'auto' ].includes(this.videoElement.preload) && !this.videoElement.autoplay && this.hlsjsConfig.autoStartLoad === undefined) {
this.hlsjsConfig.autoStartLoad = false
}
const captionConfig = srOptions_ && srOptions_.captionConfig || techOptions.captionConfig
if (captionConfig) {
this.hlsjsConfig.cueHandler = this._createCueHandler(captionConfig)
}
// If the user explicitly sets autoStartLoad to false, we're not going to enter the if block above
// That's why we have a separate if block here to set the 'play' listener
if (this.hlsjsConfig.autoStartLoad === false) {
this.handlers.play = this._startLoad.bind(this)
this.videoElement.addEventListener('play', this.handlers.play)
}
// _notifyVideoQualities sometimes runs before the quality picker event handler is registered -> no video switcher
this.handlers.playing = this._notifyVideoQualities.bind(this)
this.videoElement.addEventListener('playing', this.handlers.playing)
this.hls = new Hlsjs(this.hlsjsConfig)
this._executeHooksFor('beforeinitialize')
this.hls.on(Hlsjs.Events.ERROR, (event, data) => this._onError(event, data))
this.hls.on(Hlsjs.Events.AUDIO_TRACKS_UPDATED, () => this._onAudioTracks())
this.hls.on(Hlsjs.Events.MANIFEST_PARSED, (event, data) => this._onMetaData(event, data as any)) // FIXME: typings
this.hls.on(Hlsjs.Events.LEVEL_LOADED, (event, data) => {
// The DVR plugin will auto seek to "live edge" on start up
if (this.hlsjsConfig.liveSyncDuration) {
this.edgeMargin = this.hlsjsConfig.liveSyncDuration
} else if (this.hlsjsConfig.liveSyncDurationCount) {
this.edgeMargin = this.hlsjsConfig.liveSyncDurationCount * data.details.targetduration
}
this.isLive = data.details.live
this.dvrDuration = data.details.totalduration
this._duration = this.isLive ? Infinity : data.details.totalduration
})
this.hls.once(Hlsjs.Events.FRAG_LOADED, () => {
// Emit custom 'loadedmetadata' event for parity with `videojs-contrib-hls`
// Ref: https://github.com/videojs/videojs-contrib-hls#loadedmetadata
this.tech.trigger('loadedmetadata')
})
this.hls.attachMedia(this.videoElement)
this.handlers.addtrack = this._updateTextTrackList.bind(this)
this.videoElement.textTracks.addEventListener('addtrack', this.handlers.addtrack)
this.hls.loadSource(this.source.src)
}
private initialize () {
this._initHlsjs()
}
}
export {
Html5Hlsjs,
registerSourceHandler,
registerConfigPlugin
}
|