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