client/src/assets/player/peertube-videojs-plugin.ts

   1 import * as videojs from 'video.js'
   2 import * as WebTorrent from 'webtorrent'
   3 import { VideoFile } from '../../../../shared/models/videos/video.model'
   4 import { renderVideo } from './video-renderer'
   5 import './settings-menu-button'
   6 import { PeertubePluginOptions, VideoJSComponentInterface, videojsUntyped } from './peertube-videojs-typings'
   7 import {
   8   getAverageBandwidth,
   9   getStoredMute,
  10   getStoredVolume,
  11   saveAverageBandwidth,
  12   saveMuteInStore,
  13   saveVolumeInStore
  14 } from './utils'
  15 import minBy from 'lodash-es/minBy'
  16 import maxBy from 'lodash-es/maxBy'
  17
  18 const webtorrent = new WebTorrent({
  19   tracker: {
  20     rtcConfig: {
  21       iceServers: [
  22         {
  23           urls: 'stun:stun.stunprotocol.org'
  24         },
  25         {
  26           urls: 'stun:stun.framasoft.org'
  27         }
  28       ]
  29     }
  30   },
  31   dht: false
  32 })
  33
  34 const Plugin: VideoJSComponentInterface = videojsUntyped.getPlugin('plugin')
  35 class PeerTubePlugin extends Plugin {
  36   private readonly playerElement: HTMLVideoElement
  37
  38   private readonly autoplay: boolean = false
  39   private readonly startTime: number = 0
  40   private readonly savePlayerSrcFunction: Function
  41   private readonly videoFiles: VideoFile[]
  42   private readonly videoViewUrl: string
  43   private readonly videoDuration: number
  44   private readonly CONSTANTS = {
  45     INFO_SCHEDULER: 1000, // Don't change this
  46     AUTO_QUALITY_SCHEDULER: 3000, // Check quality every 3 seconds
  47     AUTO_QUALITY_THRESHOLD_PERCENT: 30, // Bandwidth should be 30% more important than a resolution bitrate to change to it
  48     AUTO_QUALITY_OBSERVATION_TIME: 10000, // Wait 10 seconds after having change the resolution before another check
  49     AUTO_QUALITY_HIGHER_RESOLUTION_DELAY: 5000, // Buffering higher resolution during 5 seconds
  50     BANDWIDTH_AVERAGE_NUMBER_OF_VALUES: 5 // Last 5 seconds to build average bandwidth
  51   }
  52
  53   private player: any
  54   private currentVideoFile: VideoFile
  55   private torrent: WebTorrent.Torrent
  56   private autoResolution = true
  57   private isAutoResolutionObservation = false
  58
  59   private videoViewInterval
  60   private torrentInfoInterval
  61   private autoQualityInterval
  62   private addTorrentDelay
  63   private qualityObservationTimer
  64   private runAutoQualitySchedulerTimer
  65
  66   private downloadSpeeds: number[] = []
  67
  68   constructor (player: videojs.Player, options: PeertubePluginOptions) {
  69     super(player, options)
  70
  71     this.autoplay = options.autoplay
  72
  73     this.startTime = options.startTime
  74     this.videoFiles = options.videoFiles
  75     this.videoViewUrl = options.videoViewUrl
  76     this.videoDuration = options.videoDuration
  77
  78     this.savePlayerSrcFunction = this.player.src
  79     // Hack to "simulate" src link in video.js >= 6
  80     // Without this, we can't play the video after pausing it
  81     // https://github.com/videojs/video.js/blob/master/src/js/player.js#L1633
  82     this.player.src = () => true
  83
  84     this.playerElement = options.playerElement
  85
  86     if (this.autoplay === true) this.player.addClass('vjs-has-autoplay')
  87
  88     this.player.ready(() => {
  89       const volume = getStoredVolume()
  90       if (volume !== undefined) this.player.volume(volume)
  91       const muted = getStoredMute()
  92       if (muted !== undefined) this.player.muted(muted)
  93
  94       this.initializePlayer()
  95       this.runTorrentInfoScheduler()
  96       this.runViewAdd()
  97
  98       this.player.one('play', () => {
  99         // Don't run immediately scheduler, wait some seconds the TCP connections are made
 100         this.runAutoQualitySchedulerTimer = setTimeout(() => {
 101           this.runAutoQualityScheduler()
 102         }, this.CONSTANTS.AUTO_QUALITY_SCHEDULER)
 103       })
 104     })
 105
 106     this.player.on('volumechange', () => {
 107       saveVolumeInStore(this.player.volume())
 108       saveMuteInStore(this.player.muted())
 109     })
 110   }
 111
 112   dispose () {
 113     clearTimeout(this.addTorrentDelay)
 114     clearTimeout(this.qualityObservationTimer)
 115     clearTimeout(this.runAutoQualitySchedulerTimer)
 116
 117     clearInterval(this.videoViewInterval)
 118     clearInterval(this.torrentInfoInterval)
 119     clearInterval(this.autoQualityInterval)
 120
 121     // Don't need to destroy renderer, video player will be destroyed
 122     this.flushVideoFile(this.currentVideoFile, false)
 123   }
 124
 125   getCurrentResolutionId () {
 126     return this.currentVideoFile ? this.currentVideoFile.resolution.id : -1
 127   }
 128
 129   getCurrentResolutionLabel () {
 130     return this.currentVideoFile ? this.currentVideoFile.resolution.label : ''
 131   }
 132
 133   updateVideoFile (videoFile?: VideoFile, delay = 0, done?: () => void) {
 134     if (done === undefined) {
 135       done = () => { /* empty */ }
 136     }
 137
 138     // Automatically choose the adapted video file
 139     if (videoFile === undefined) {
 140       const savedAverageBandwidth = getAverageBandwidth()
 141       videoFile = savedAverageBandwidth
 142         ? this.getAppropriateFile(savedAverageBandwidth)
 143         : this.videoFiles[0]
 144     }
 145
 146     // Don't add the same video file once again
 147     if (this.currentVideoFile !== undefined && this.currentVideoFile.magnetUri === videoFile.magnetUri) {
 148       return
 149     }
 150
 151     // Do not display error to user because we will have multiple fallback
 152     this.disableErrorDisplay()
 153
 154     this.player.src = () => true
 155     const oldPlaybackRate = this.player.playbackRate()
 156
 157     const previousVideoFile = this.currentVideoFile
 158     this.currentVideoFile = videoFile
 159
 160     this.addTorrent(this.currentVideoFile.magnetUri, previousVideoFile, delay, () => {
 161       this.player.playbackRate(oldPlaybackRate)
 162       return done()
 163     })
 164
 165     this.trigger('videoFileUpdate')
 166   }
 167
 168   addTorrent (magnetOrTorrentUrl: string, previousVideoFile: VideoFile, delay = 0, done: Function) {
 169     console.log('Adding ' + magnetOrTorrentUrl + '.')
 170
 171     const oldTorrent = this.torrent
 172     this.torrent = webtorrent.add(magnetOrTorrentUrl, torrent => {
 173       console.log('Added ' + magnetOrTorrentUrl + '.')
 174
 175       // Pause the old torrent
 176       if (oldTorrent) {
 177         oldTorrent.pause()
 178         // Pause does not remove actual peers (in particular the webseed peer)
 179         oldTorrent.removePeer(oldTorrent['ws'])
 180       }
 181
 182       this.addTorrentDelay = setTimeout(() => {
 183         this.flushVideoFile(previousVideoFile)
 184
 185         const options = { autoplay: true, controls: true }
 186         renderVideo(torrent.files[0], this.playerElement, options,(err, renderer) => {
 187           this.renderer = renderer
 188
 189           if (err) return this.fallbackToHttp(done)
 190
 191           if (!this.player.paused()) return this.tryToPlay(done)
 192
 193           return done()
 194         })
 195       }, delay)
 196     })
 197
 198     this.torrent.on('error', err => this.handleError(err))
 199
 200     this.torrent.on('warning', (err: any) => {
 201       // We don't support HTTP tracker but we don't care -> we use the web socket tracker
 202       if (err.message.indexOf('Unsupported tracker protocol') !== -1) return
 203
 204       // Users don't care about issues with WebRTC, but developers do so log it in the console
 205       if (err.message.indexOf('Ice connection failed') !== -1) {
 206         console.error(err)
 207         return
 208       }
 209
 210       // Magnet hash is not up to date with the torrent file, add directly the torrent file
 211       if (err.message.indexOf('incorrect info hash') !== -1) {
 212         console.error('Incorrect info hash detected, falling back to torrent file.')
 213         return this.addTorrent(this.torrent['xs'], previousVideoFile, 0, done)
 214       }
 215
 216       return this.handleError(err)
 217     })
 218   }
 219
 220   updateResolution (resolutionId: number, delay = 0) {
 221     // Remember player state
 222     const currentTime = this.player.currentTime()
 223     const isPaused = this.player.paused()
 224
 225     // Remove poster to have black background
 226     this.playerElement.poster = ''
 227
 228     // Hide bigPlayButton
 229     if (!isPaused) {
 230       this.player.bigPlayButton.hide()
 231     }
 232
 233     const newVideoFile = this.videoFiles.find(f => f.resolution.id === resolutionId)
 234     this.updateVideoFile(newVideoFile, delay, () => this.seek(currentTime))
 235   }
 236
 237   flushVideoFile (videoFile: VideoFile, destroyRenderer = true) {
 238     if (videoFile !== undefined && webtorrent.get(videoFile.magnetUri)) {
 239       if (destroyRenderer === true && this.renderer && this.renderer.destroy) this.renderer.destroy()
 240
 241       webtorrent.remove(videoFile.magnetUri)
 242       console.log('Removed ' + videoFile.magnetUri)
 243     }
 244   }
 245
 246   isAutoResolutionOn () {
 247     return this.autoResolution
 248   }
 249
 250   enableAutoResolution () {
 251     this.autoResolution = true
 252     this.trigger('autoResolutionUpdate')
 253   }
 254
 255   disableAutoResolution () {
 256     this.autoResolution = false
 257     this.trigger('autoResolutionUpdate')
 258   }
 259
 260   private tryToPlay (done?: Function) {
 261     if (!done) done = function () { /* empty */ }
 262
 263     const playPromise = this.player.play()
 264     if (playPromise !== undefined) {
 265       return playPromise.then(done)
 266                         .catch(err => {
 267                           console.error(err)
 268                           this.player.pause()
 269                           this.player.posterImage.show()
 270                           this.player.removeClass('vjs-has-autoplay')
 271
 272                           return done()
 273                         })
 274     }
 275
 276     return done()
 277   }
 278
 279   private seek (time: number) {
 280     this.player.currentTime(time)
 281     this.player.handleTechSeeked_()
 282   }
 283
 284   private getAppropriateFile (averageDownloadSpeed?: number): VideoFile {
 285     if (this.videoFiles === undefined || this.videoFiles.length === 0) return undefined
 286     if (this.videoFiles.length === 1) return this.videoFiles[0]
 287
 288     // Don't change the torrent is the play was ended
 289     if (this.torrent && this.torrent.progress === 1 && this.player.ended()) return this.currentVideoFile
 290
 291     if (!averageDownloadSpeed) averageDownloadSpeed = this.getAndSaveActualDownloadSpeed()
 292
 293     // Filter videos we can play according to our bandwidth
 294     const filteredFiles = this.videoFiles.filter(f => {
 295       const fileBitrate = (f.size / this.videoDuration)
 296       let threshold = fileBitrate
 297
 298       // If this is for a higher resolution or an initial load: add a margin
 299       if (!this.currentVideoFile || f.resolution.id > this.currentVideoFile.resolution.id) {
 300         threshold += ((fileBitrate * this.CONSTANTS.AUTO_QUALITY_THRESHOLD_PERCENT) / 100)
 301       }
 302
 303       return averageDownloadSpeed > threshold
 304     })
 305
 306     // If the download speed is too bad, return the lowest resolution we have
 307     if (filteredFiles.length === 0) return minBy(this.videoFiles, 'resolution.id')
 308
 309     return maxBy(filteredFiles, 'resolution.id')
 310   }
 311
 312   private getAndSaveActualDownloadSpeed () {
 313     const start = Math.max(this.downloadSpeeds.length - this.CONSTANTS.BANDWIDTH_AVERAGE_NUMBER_OF_VALUES, 0)
 314     const lastDownloadSpeeds = this.downloadSpeeds.slice(start, this.downloadSpeeds.length)
 315     if (lastDownloadSpeeds.length === 0) return -1
 316
 317     const sum = lastDownloadSpeeds.reduce((a, b) => a + b)
 318     const averageBandwidth = Math.round(sum / lastDownloadSpeeds.length)
 319
 320     // Save the average bandwidth for future use
 321     saveAverageBandwidth(averageBandwidth)
 322
 323     return averageBandwidth
 324   }
 325
 326   private initializePlayer () {
 327     this.initSmoothProgressBar()
 328
 329     this.alterInactivity()
 330
 331     if (this.autoplay === true) {
 332       this.player.posterImage.hide()
 333
 334       this.updateVideoFile(undefined, 0, () => {
 335         this.seek(this.startTime)
 336         this.tryToPlay()
 337       })
 338     } else {
 339       // Proxy first play
 340       const oldPlay = this.player.play.bind(this.player)
 341       this.player.play = () => {
 342         this.player.addClass('vjs-has-big-play-button-clicked')
 343         this.player.play = oldPlay
 344
 345         this.updateVideoFile(undefined, 0, () => this.seek(this.startTime))
 346       }
 347     }
 348   }
 349
 350   private runAutoQualityScheduler () {
 351     this.autoQualityInterval = setInterval(() => {
 352
 353       // Not initialized or in HTTP fallback
 354       if (this.torrent === undefined || this.torrent === null) return
 355       if (this.isAutoResolutionOn() === false) return
 356       if (this.isAutoResolutionObservation === true) return
 357
 358       const file = this.getAppropriateFile()
 359       let changeResolution = false
 360       let changeResolutionDelay = 0
 361
 362       // Lower resolution
 363       if (this.isPlayerWaiting() && file.resolution.id < this.currentVideoFile.resolution.id) {
 364         console.log('Downgrading automatically the resolution to: %s', file.resolution.label)
 365         changeResolution = true
 366       } else if (file.resolution.id > this.currentVideoFile.resolution.id) { // Higher resolution
 367         console.log('Upgrading automatically the resolution to: %s', file.resolution.label)
 368         changeResolution = true
 369         changeResolutionDelay = this.CONSTANTS.AUTO_QUALITY_HIGHER_RESOLUTION_DELAY
 370       }
 371
 372       if (changeResolution === true) {
 373         this.updateResolution(file.resolution.id, changeResolutionDelay)
 374
 375         // Wait some seconds in observation of our new resolution
 376         this.isAutoResolutionObservation = true
 377
 378         this.qualityObservationTimer = setTimeout(() => {
 379           this.isAutoResolutionObservation = false
 380         }, this.CONSTANTS.AUTO_QUALITY_OBSERVATION_TIME)
 381       }
 382     }, this.CONSTANTS.AUTO_QUALITY_SCHEDULER)
 383   }
 384
 385   private isPlayerWaiting () {
 386     return this.player && this.player.hasClass('vjs-waiting')
 387   }
 388
 389   private runTorrentInfoScheduler () {
 390     this.torrentInfoInterval = setInterval(() => {
 391       // Not initialized yet
 392       if (this.torrent === undefined) return
 393
 394       // Http fallback
 395       if (this.torrent === null) return this.trigger('torrentInfo', false)
 396
 397       // webtorrent.downloadSpeed because we need to take into account the potential old torrent too
 398       if (webtorrent.downloadSpeed !== 0) this.downloadSpeeds.push(webtorrent.downloadSpeed)
 399
 400       return this.trigger('torrentInfo', {
 401         downloadSpeed: this.torrent.downloadSpeed,
 402         numPeers: this.torrent.numPeers,
 403         uploadSpeed: this.torrent.uploadSpeed
 404       })
 405     }, this.CONSTANTS.INFO_SCHEDULER)
 406   }
 407
 408   private runViewAdd () {
 409     this.clearVideoViewInterval()
 410
 411     // After 30 seconds (or 3/4 of the video), add a view to the video
 412     let minSecondsToView = 30
 413
 414     if (this.videoDuration < minSecondsToView) minSecondsToView = (this.videoDuration * 3) / 4
 415
 416     let secondsViewed = 0
 417     this.videoViewInterval = setInterval(() => {
 418       if (this.player && !this.player.paused()) {
 419         secondsViewed += 1
 420
 421         if (secondsViewed > minSecondsToView) {
 422           this.clearVideoViewInterval()
 423
 424           this.addViewToVideo().catch(err => console.error(err))
 425         }
 426       }
 427     }, 1000)
 428   }
 429
 430   private clearVideoViewInterval () {
 431     if (this.videoViewInterval !== undefined) {
 432       clearInterval(this.videoViewInterval)
 433       this.videoViewInterval = undefined
 434     }
 435   }
 436
 437   private addViewToVideo () {
 438     return fetch(this.videoViewUrl, { method: 'POST' })
 439   }
 440
 441   private fallbackToHttp (done: Function) {
 442     this.flushVideoFile(this.currentVideoFile, true)
 443     this.torrent = null
 444
 445     // Enable error display now this is our last fallback
 446     this.player.one('error', () => this.enableErrorDisplay())
 447
 448     const httpUrl = this.currentVideoFile.fileUrl
 449     this.player.src = this.savePlayerSrcFunction
 450     this.player.src(httpUrl)
 451     this.player.play()
 452
 453     return done()
 454   }
 455
 456   private handleError (err: Error | string) {
 457     return this.player.trigger('customError', { err })
 458   }
 459
 460   private enableErrorDisplay () {
 461     this.player.addClass('vjs-error-display-enabled')
 462   }
 463
 464   private disableErrorDisplay () {
 465     this.player.removeClass('vjs-error-display-enabled')
 466   }
 467
 468   private alterInactivity () {
 469     let saveInactivityTimeout: number
 470
 471     const disableInactivity = () => {
 472       saveInactivityTimeout = this.player.options_.inactivityTimeout
 473       this.player.options_.inactivityTimeout = 0
 474     }
 475     const enableInactivity = () => {
 476       this.player.options_.inactivityTimeout = saveInactivityTimeout
 477     }
 478
 479     const settingsDialog = this.player.children_.find(c => c.name_ === 'SettingsDialog')
 480
 481     this.player.controlBar.on('mouseenter', () => disableInactivity())
 482     settingsDialog.on('mouseenter', () => disableInactivity())
 483     this.player.controlBar.on('mouseleave', () => enableInactivity())
 484     settingsDialog.on('mouseleave', () => enableInactivity())
 485   }
 486
 487   // Thanks: https://github.com/videojs/video.js/issues/4460#issuecomment-312861657
 488   private initSmoothProgressBar () {
 489     const SeekBar = videojsUntyped.getComponent('SeekBar')
 490     SeekBar.prototype.getPercent = function getPercent () {
 491       // Allows for smooth scrubbing, when player can't keep up.
 492       // const time = (this.player_.scrubbing()) ?
 493       //   this.player_.getCache().currentTime :
 494       //   this.player_.currentTime()
 495       const time = this.player_.currentTime()
 496       const percent = time / this.player_.duration()
 497       return percent >= 1 ? 1 : percent
 498     }
 499     SeekBar.prototype.handleMouseMove = function handleMouseMove (event) {
 500       let newTime = this.calculateDistance(event) * this.player_.duration()
 501       if (newTime === this.player_.duration()) {
 502         newTime = newTime - 0.1
 503       }
 504       this.player_.currentTime(newTime)
 505       this.update()
 506     }
 507   }
 508 }
 509
 510 videojsUntyped.registerPlugin('peertube', PeerTubePlugin)
 511 export { PeerTubePlugin }