client/src/assets/player/shared/webtorrent/webtorrent-plugin.ts

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