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