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