]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - client/src/assets/player/peertube-videojs-plugin.ts
Improve player
[github/Chocobozzz/PeerTube.git] / client / src / assets / player / peertube-videojs-plugin.ts
index 30ef7c49c635f6e190e6ccf09e8ca8a0b6e9690f..c35ce12cb038262790fa056785e760facf26d67a 100644 (file)
-// Big thanks to: https://github.com/kmoskwiak/videojs-resolution-switcher
-
-import videojs, { Player } from 'video.js'
+import * as videojs from 'video.js'
 import * as WebTorrent from 'webtorrent'
-
+import { VideoFile } from '../../../../shared/models/videos/video.model'
 import { renderVideo } from './video-renderer'
-import { VideoFile } from '../../../../shared'
-
-// videojs typings don't have some method we need
-const videojsUntyped = videojs as any
-const webtorrent = new WebTorrent({ dht: false })
-
-const MenuItem = videojsUntyped.getComponent('MenuItem')
-const ResolutionMenuItem = videojsUntyped.extend(MenuItem, {
-  constructor: function (player: Player, options) {
-    options.selectable = true
-    MenuItem.call(this, player, options)
-
-    const currentResolution = this.player_.getCurrentResolution()
-    this.selected(this.options_.id === currentResolution)
-  },
-
-  handleClick: function (event) {
-    MenuItem.prototype.handleClick.call(this, event)
-    this.player_.updateResolution(this.options_.id)
-  }
-})
-MenuItem.registerComponent('ResolutionMenuItem', ResolutionMenuItem)
-
-const MenuButton = videojsUntyped.getComponent('MenuButton')
-const ResolutionMenuButton = videojsUntyped.extend(MenuButton, {
-  constructor: function (player, options) {
-    this.label = document.createElement('span')
-    options.label = 'Quality'
-
-    MenuButton.call(this, player, options)
-    this.el().setAttribute('aria-label', 'Quality')
-    this.controlText('Quality')
-
-    videojsUntyped.dom.addClass(this.label, 'vjs-resolution-button-label')
-    this.el().appendChild(this.label)
-
-    player.on('videoFileUpdate', videojs.bind(this, this.update))
-  },
-
-  createItems: function () {
-    const menuItems = []
-    for (const videoFile of this.player_.videoFiles) {
-      menuItems.push(new ResolutionMenuItem(
-        this.player_,
+import './settings-menu-button'
+import { PeertubePluginOptions, VideoJSComponentInterface, videojsUntyped } from './peertube-videojs-typings'
+import { getStoredMute, getStoredVolume, saveMuteInStore, saveVolumeInStore } from './utils'
+
+const webtorrent = new WebTorrent({
+  tracker: {
+    rtcConfig: {
+      iceServers: [
         {
-          id: videoFile.resolution,
-          label: videoFile.resolutionLabel,
-          src: videoFile.magnetUri,
-          selected: videoFile.resolution === this.currentSelection
-        })
-      )
+          urls: 'stun:stun.stunprotocol.org'
+        },
+        {
+          urls: 'stun:stun.framasoft.org'
+        }
+      ]
     }
-
-    return menuItems
   },
-
-  update: function () {
-    this.label.innerHTML = this.player_.getCurrentResolutionLabel()
-    return MenuButton.prototype.update.call(this)
-  },
-
-  buildCSSClass: function () {
-    return MenuButton.prototype.buildCSSClass.call(this) + ' vjs-resolution-button'
-  }
+  dht: false
 })
-MenuButton.registerComponent('ResolutionMenuButton', ResolutionMenuButton)
-
-const Button = videojsUntyped.getComponent('Button')
-const PeertubeLinkButton = videojsUntyped.extend(Button, {
-  constructor: function (player) {
-    Button.apply(this, arguments)
-    this.player = player
-  },
 
-  createEl: function () {
-    const link = document.createElement('a')
-    link.href = window.location.href.replace('embed', 'watch')
-    link.innerHTML = 'PeerTube'
-    link.title = 'Go to the video page'
-    link.className = 'vjs-peertube-link'
-    link.target = '_blank'
-
-    return link
-  },
+const Plugin: VideoJSComponentInterface = videojsUntyped.getPlugin('plugin')
+class PeerTubePlugin extends Plugin {
+  private readonly playerElement: HTMLVideoElement
+  private readonly autoplay: boolean = false
+  private readonly savePlayerSrcFunction: Function
+  private player: any
+  private currentVideoFile: VideoFile
+  private videoFiles: VideoFile[]
+  private torrent: WebTorrent.Torrent
+  private videoViewUrl: string
+  private videoDuration: number
+  private videoViewInterval
+  private torrentInfoInterval
+
+  constructor (player: videojs.Player, options: PeertubePluginOptions) {
+    super(player, options)
+
+    // Fix canplay event on google chrome by disabling default videojs autoplay
+    this.autoplay = this.player.options_.autoplay
+    this.player.options_.autoplay = false
+
+    this.videoFiles = options.videoFiles
+    this.videoViewUrl = options.videoViewUrl
+    this.videoDuration = options.videoDuration
+
+    this.savePlayerSrcFunction = this.player.src
+    // Hack to "simulate" src link in video.js >= 6
+    // Without this, we can't play the video after pausing it
+    // https://github.com/videojs/video.js/blob/master/src/js/player.js#L1633
+    this.player.src = () => true
+
+    this.playerElement = options.playerElement
+
+    this.player.ready(() => {
+      const volume = getStoredVolume()
+      if (volume !== undefined) this.player.volume(volume)
+      const muted = getStoredMute()
+      if (muted !== undefined) this.player.muted(muted)
+
+      this.initializePlayer()
+      this.runTorrentInfoScheduler()
+      this.runViewAdd()
+    })
 
-  handleClick: function () {
-    this.player.pause()
+    this.player.on('volumechange', () => {
+      saveVolumeInStore(this.player.volume())
+      saveMuteInStore(this.player.muted())
+    })
   }
-})
-Button.registerComponent('PeerTubeLinkButton', PeertubeLinkButton)
 
-type PeertubePluginOptions = {
-  videoFiles: VideoFile[]
-  playerElement: HTMLVideoElement
-  autoplay: boolean
-  peerTubeLink: boolean
-}
-const peertubePlugin = function (options: PeertubePluginOptions) {
-  const player = this
-  let currentVideoFile: VideoFile = undefined
-  const playerElement = options.playerElement
-  player.videoFiles = options.videoFiles
+  dispose () {
+    clearInterval(this.videoViewInterval)
+    clearInterval(this.torrentInfoInterval)
 
-  // Hack to "simulate" src link in video.js >= 6
-  // Without this, we can't play the video after pausing it
-  // https://github.com/videojs/video.js/blob/master/src/js/player.js#L1633
-  player.src = function () {
-    return true
+    // Don't need to destroy renderer, video player will be destroyed
+    this.flushVideoFile(this.currentVideoFile, false)
   }
 
-  player.getCurrentResolution = function () {
-    return currentVideoFile ? currentVideoFile.resolution : -1
+  getCurrentResolutionId () {
+    return this.currentVideoFile ? this.currentVideoFile.resolution.id : -1
   }
 
-  player.getCurrentResolutionLabel = function () {
-    return currentVideoFile ? currentVideoFile.resolutionLabel : ''
+  getCurrentResolutionLabel () {
+    return this.currentVideoFile ? this.currentVideoFile.resolution.label : ''
   }
 
-  player.updateVideoFile = function (videoFile: VideoFile, done: () => void) {
+  updateVideoFile (videoFile?: VideoFile, done?: () => void) {
     if (done === undefined) {
       done = () => { /* empty */ }
     }
 
     // Pick the first one
     if (videoFile === undefined) {
-      videoFile = player.videoFiles[0]
+      videoFile = this.videoFiles[0]
     }
 
     // Don't add the same video file once again
-    if (currentVideoFile !== undefined && currentVideoFile.magnetUri === videoFile.magnetUri) {
+    if (this.currentVideoFile !== undefined && this.currentVideoFile.magnetUri === videoFile.magnetUri) {
       return
     }
 
-    const previousVideoFile = currentVideoFile
-    currentVideoFile = videoFile
+    // Do not display error to user because we will have multiple fallback
+    this.disableErrorDisplay()
+
+    this.player.src = () => true
+    const oldPlaybackRate = this.player.playbackRate()
+
+    const previousVideoFile = this.currentVideoFile
+    this.currentVideoFile = videoFile
+
+    this.addTorrent(this.currentVideoFile.magnetUri, previousVideoFile, () => {
+      this.player.playbackRate(oldPlaybackRate)
+      return done()
+    })
+
+    this.trigger('videoFileUpdate')
+  }
+
+  addTorrent (magnetOrTorrentUrl: string, previousVideoFile: VideoFile, done: Function) {
+    console.log('Adding ' + magnetOrTorrentUrl + '.')
 
-    console.log('Adding ' + videoFile.magnetUri + '.')
-    player.torrent = webtorrent.add(videoFile.magnetUri, torrent => {
-      console.log('Added ' + videoFile.magnetUri + '.')
+    this.torrent = webtorrent.add(magnetOrTorrentUrl, torrent => {
+      console.log('Added ' + magnetOrTorrentUrl + '.')
 
       this.flushVideoFile(previousVideoFile)
 
       const options = { autoplay: true, controls: true }
-      renderVideo(torrent.files[0], playerElement, options,(err, renderer) => {
-        if (err) return handleError(err)
-
+      renderVideo(torrent.files[0], this.playerElement, options,(err, renderer) => {
         this.renderer = renderer
-        player.play()
+
+        if (err) return this.fallbackToHttp(done)
+
+        if (!this.player.paused()) {
+          const playPromise = this.player.play()
+          if (playPromise !== undefined) return playPromise.then(done)
+
+          return done()
+        }
 
         return done()
       })
     })
 
-    player.torrent.on('error', err => handleError(err))
-    player.torrent.on('warning', err => {
+    this.torrent.on('error', err => this.handleError(err))
+
+    this.torrent.on('warning', (err: any) => {
       // We don't support HTTP tracker but we don't care -> we use the web socket tracker
-      if (err.message.indexOf('Unsupported tracker protocol: http') !== -1) return
+      if (err.message.indexOf('Unsupported tracker protocol') !== -1) return
 
-      return handleError(err)
-    })
+      // Users don't care about issues with WebRTC, but developers do so log it in the console
+      if (err.message.indexOf('Ice connection failed') !== -1) {
+        console.error(err)
+        return
+      }
 
-    player.trigger('videoFileUpdate')
+      // Magnet hash is not up to date with the torrent file, add directly the torrent file
+      if (err.message.indexOf('incorrect info hash') !== -1) {
+        console.error('Incorrect info hash detected, falling back to torrent file.')
+        return this.addTorrent(this.torrent['xs'], previousVideoFile, done)
+      }
 
-    return player
+      return this.handleError(err)
+    })
   }
 
-  player.updateResolution = function (resolution) {
+  updateResolution (resolutionId: number) {
     // Remember player state
-    const currentTime = player.currentTime()
-    const isPaused = player.paused()
+    const currentTime = this.player.currentTime()
+    const isPaused = this.player.paused()
+
+    // Remove poster to have black background
+    this.playerElement.poster = ''
 
     // Hide bigPlayButton
-    if (!isPaused && this.player_.options_.bigPlayButton) {
-      this.player_.bigPlayButton.hide()
+    if (!isPaused) {
+      this.player.bigPlayButton.hide()
     }
 
-    const newVideoFile = player.videoFiles.find(f => f.resolution === resolution)
-    player.updateVideoFile(newVideoFile, () => {
-      player.currentTime(currentTime)
-      player.handleTechSeeked_()
+    const newVideoFile = this.videoFiles.find(f => f.resolution.id === resolutionId)
+    this.updateVideoFile(newVideoFile, () => {
+      this.player.currentTime(currentTime)
+      this.player.handleTechSeeked_()
     })
   }
 
-  player.flushVideoFile = function (videoFile: VideoFile, destroyRenderer = true) {
+  flushVideoFile (videoFile: VideoFile, destroyRenderer = true) {
     if (videoFile !== undefined && webtorrent.get(videoFile.magnetUri)) {
-      if (destroyRenderer === true) this.renderer.destroy()
+      if (destroyRenderer === true && this.renderer && this.renderer.destroy) this.renderer.destroy()
+
       webtorrent.remove(videoFile.magnetUri)
+      console.log('Removed ' + videoFile.magnetUri)
     }
   }
 
-  player.ready(function () {
-    const controlBar = player.controlBar
+  setVideoFiles (files: VideoFile[], videoViewUrl: string, videoDuration: number) {
+    this.videoViewUrl = videoViewUrl
+    this.videoDuration = videoDuration
+    this.videoFiles = files
 
-    const menuButton = new ResolutionMenuButton(player, options)
-    const fullscreenElement = controlBar.fullscreenToggle.el()
-    controlBar.resolutionSwitcher = controlBar.el().insertBefore(menuButton.el(), fullscreenElement)
-    controlBar.resolutionSwitcher.dispose = function () {
-      this.parentNode.removeChild(this)
-    }
+    // Re run view add for the new video
+    this.runViewAdd()
+    this.updateVideoFile(undefined, () => this.player.play())
+  }
 
-    player.dispose = function () {
-      // Don't need to destroy renderer, video player will be destroyed
-      player.flushVideoFile(currentVideoFile, false)
-    }
+  private initializePlayer () {
+    this.initSmoothProgressBar()
 
-    if (options.peerTubeLink === true) {
-      const peerTubeLinkButton = new PeertubeLinkButton(player)
-      controlBar.peerTubeLink = controlBar.el().insertBefore(peerTubeLinkButton.el(), fullscreenElement)
+    this.alterInactivity()
 
-      controlBar.peerTubeLink.dispose = function () {
-        this.parentNode.removeChild(this)
+    if (this.autoplay === true) {
+      this.updateVideoFile(undefined, () => this.player.play())
+    } else {
+      // Proxify first play
+      const oldPlay = this.player.play.bind(this.player)
+      this.player.play = () => {
+        this.updateVideoFile(undefined, () => oldPlay)
+        this.player.play = oldPlay
       }
     }
+  }
 
-    if (options.autoplay === true) {
-      player.updateVideoFile()
-    } else {
-      player.one('play', () => {
-        // Pause, we wait the video to load before
-        player.pause()
+  private runTorrentInfoScheduler () {
+    this.torrentInfoInterval = setInterval(() => {
+      // Not initialized yet
+      if (this.torrent === undefined) return
+
+      // Http fallback
+      if (this.torrent === null) return this.trigger('torrentInfo', false)
 
-        player.updateVideoFile(undefined, () => player.play())
+      return this.trigger('torrentInfo', {
+        downloadSpeed: this.torrent.downloadSpeed,
+        numPeers: this.torrent.numPeers,
+        uploadSpeed: this.torrent.uploadSpeed
       })
-    }
+    }, 1000)
+  }
+
+  private runViewAdd () {
+    this.clearVideoViewInterval()
+
+    // After 30 seconds (or 3/4 of the video), add a view to the video
+    let minSecondsToView = 30
+
+    if (this.videoDuration < minSecondsToView) minSecondsToView = (this.videoDuration * 3) / 4
+
+    let secondsViewed = 0
+    this.videoViewInterval = setInterval(() => {
+      if (this.player && !this.player.paused()) {
+        secondsViewed += 1
+
+        if (secondsViewed > minSecondsToView) {
+          this.clearVideoViewInterval()
 
-    setInterval(() => {
-      if (player.torrent !== undefined) {
-        player.trigger('torrentInfo', {
-          downloadSpeed: player.torrent.downloadSpeed,
-          numPeers: player.torrent.numPeers,
-          uploadSpeed: player.torrent.uploadSpeed
-        })
+          this.addViewToVideo().catch(err => console.error(err))
+        }
       }
     }, 1000)
-  })
+  }
+
+  private clearVideoViewInterval () {
+    if (this.videoViewInterval !== undefined) {
+      clearInterval(this.videoViewInterval)
+      this.videoViewInterval = undefined
+    }
+  }
+
+  private addViewToVideo () {
+    return fetch(this.videoViewUrl, { method: 'POST' })
+  }
+
+  private fallbackToHttp (done: Function) {
+    this.flushVideoFile(this.currentVideoFile, true)
+    this.torrent = null
+
+    // Enable error display now this is our last fallback
+    this.player.one('error', () => this.enableErrorDisplay())
+
+    const httpUrl = this.currentVideoFile.fileUrl
+    this.player.src = this.savePlayerSrcFunction
+    this.player.src(httpUrl)
+    this.player.play()
+
+    return done()
+  }
+
+  private handleError (err: Error | string) {
+    return this.player.trigger('customError', { err })
+  }
+
+  private enableErrorDisplay () {
+    this.player.addClass('vjs-error-display-enabled')
+  }
+
+  private disableErrorDisplay () {
+    this.player.removeClass('vjs-error-display-enabled')
+  }
+
+  private alterInactivity () {
+    let saveInactivityTimeout: number
+
+    const disableInactivity = () => {
+      saveInactivityTimeout = this.player.options_.inactivityTimeout
+      this.player.options_.inactivityTimeout = 0
+    }
+    const enableInactivity = () => {
+      // this.player.options_.inactivityTimeout = saveInactivityTimeout
+    }
+
+    const settingsDialog = this.player.children_.find(c => c.name_ === 'SettingsDialog')
 
-  function handleError (err: Error|string) {
-    return player.trigger('customError', { err })
+    this.player.controlBar.on('mouseenter', () => disableInactivity())
+    settingsDialog.on('mouseenter', () => disableInactivity())
+    this.player.controlBar.on('mouseleave', () => enableInactivity())
+    settingsDialog.on('mouseleave', () => enableInactivity())
+  }
+
+  // Thanks: https://github.com/videojs/video.js/issues/4460#issuecomment-312861657
+  private initSmoothProgressBar () {
+    const SeekBar = videojsUntyped.getComponent('SeekBar')
+    SeekBar.prototype.getPercent = function getPercent () {
+      // Allows for smooth scrubbing, when player can't keep up.
+      // const time = (this.player_.scrubbing()) ?
+      //   this.player_.getCache().currentTime :
+      //   this.player_.currentTime()
+      const time = this.player_.currentTime()
+      const percent = time / this.player_.duration()
+      return percent >= 1 ? 1 : percent
+    }
+    SeekBar.prototype.handleMouseMove = function handleMouseMove (event) {
+      let newTime = this.calculateDistance(event) * this.player_.duration()
+      if (newTime === this.player_.duration()) {
+        newTime = newTime - 0.1
+      }
+      this.player_.currentTime(newTime)
+      this.update()
+    }
   }
 }
 
-videojsUntyped.registerPlugin('peertube', peertubePlugin)
+videojsUntyped.registerPlugin('peertube', PeerTubePlugin)
+export { PeerTubePlugin }