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